{"commit":"ec288cbba4266625ef896bcf3f999c6b39f7a1cb","subject":"Disable auto-etaging","message":"Disable auto-etaging\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.disable('etag')\n    app.set 'port', process.env.APP_PORT or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.user.tilbyder}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.set 'port', process.env.APP_PORT or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.user.tilbyder}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f26a367636c5e1d0e76b5c10bec849e0f7ce4e3f","subject":"Only print 5xx errors to console","message":"Only print 5xx errors to console\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.status >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"67cb9df3dd983929201d2178c1ac2fff218f644e","subject":"Literate CofeeScript underway","message":"Literate CofeeScript underway\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\n\n\n  disjunction = (l, r) ->\n    (x) -> _.cat(l(x), r(x))\n  conjunction = (l, r) ->\n    (x) -> _.mapcat(l(x), r)\n\n  F.disj = () ->\n    return F.fail if _.isEmpty(arguments)\n    disjunction(_.first(arguments), F.disj.apply(this, _.rest(arguments)))\n\n  F.conj = () ->\n    clauses = _.toArray(arguments)\n    return F.succeed if _.isEmpty(clauses)\n    return _.first(clauses) if _.size(clauses) is 1\n    conjunction(_.first(clauses),\n                (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\n  # Knowledge representation\n  # ------------------------\n\n  class LVar\n    constructor: (@name) ->\n\n  F.lvar = (name) -> new LVar(name)\n  F.isLVar = (v) -> (v instanceof LVar)\n\n  find = (v, bindings) ->\n    lvar = bindings.lookup(v)\n    return lvar if F.isLVar(v)\n    if _.isArray(lvar)\n      if _.isEmpty(lvar)\n        return lvar\n      else\n        return _.cons(find(_.first(lvar), bindings), find(_.rest(lvar), bindings))\n    lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\n  F.succeed = (result) -> [result]\n  F.fail = _.always []\n\n  disjunction = (l, r) ->\n    (x) -> _.cat(l(x), r(x))\n  conjunction = (l, r) ->\n    (x) -> _.mapcat(l(x), r)\n\n  F.disj = () ->\n    return F.fail if _.isEmpty(arguments)\n    disjunction(_.first(arguments), F.disj.apply(this, _.rest(arguments)))\n\n  F.conj = () ->\n    clauses = _.toArray(arguments)\n    return F.succeed if _.isEmpty(clauses)\n    return _.first(clauses) if _.size(clauses) is 1\n    conjunction(_.first(clauses),\n                (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\n  # Knowledge representation\n  # ------------------------\n\n  class LVar\n    constructor: (@name) ->\n\n  F.lvar = (name) -> new LVar(name)\n  F.isLVar = (v) -> (v instanceof LVar)\n\n  find = (v, bindings) ->\n    lvar = bindings.lookup(v)\n    return lvar if F.isLVar(v)\n    if _.isArray(lvar)\n      if _.isEmpty(lvar)\n        return lvar\n      else\n        return _.cons(find(_.first(lvar), bindings), find(_.rest(lvar), bindings))\n    lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f9aa4a07598792bd32c61d2b0266151b43536f67","subject":"log.time leaks support","message":"log.time leaks support\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/log\/index.litcoffee","new_file":"src\/log\/index.litcoffee","new_contents":"# Log\n\nAccess it with:\n```javascript\nconst { log } = Neft;\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n\n    {bind} = Function\n    {isArray} = Array\n    {unshift} = Array::\n\n    linesPrefix = ''\n\n    fromArgs = (args) ->\n        str = ''\n        str += \"#{arg} \u2192 \" for arg in args\n        str = str.substring 0, str.length - 3\n\n        lines = str.split '\\n'\n        str = ''\n        for line in lines\n            str += \"#{linesPrefix}#{line}\\n\"\n        str = str.slice 0, -1\n\n        str\n\n    callOnce = do ->\n        usedMessages = Object.create null\n        ->\n            msg = fromArgs arguments\n            if usedMessages[msg]\n                return -1\n            usedMessages[msg] = true\n            @ arguments...\n\n## **Class** Log\n\n    class Log\n        @LOGS_METHODS = ['log', 'info', 'warn', 'error', 'time', 'ok']\n\n        @MARKERS =\n            white: (str) -> \"LOG: #{str}\"\n            green: (str) -> \"OK: #{str}\"\n            gray: (str) -> \"#{str}\"\n            blue: (str) -> \"INFO: #{str}\"\n            yellow: (str) -> \"WARN: #{str}\"\n            red: (str) -> \"ERROR: #{str}\"\n\n        @setGlobalLinesPrefix = (prefix) ->\n            linesPrefix = prefix\n\n        @time = Date.now\n        @timeDiff = (since) -> Log.time() - since\n\n        constructor: (prefixes = [], @parentScope) ->\n            @prefixes = prefixes\n            assert.isArray prefixes\n\n            # bind all logs methods\n            args = utils.clone(prefixes)\n            args.unshift @\n\n            for name in @constructor.LOGS_METHODS\n                @[name] = bind.apply @[name], args\n                @[name].once = callOnce\n\n            @[key] = value for key, value of @\n            if typeof @['lo' + 'g'] is 'function'\n                func = =>\n                    @log.apply func, arguments\n                func.once = callOnce\n                func.constructor = @constructor\n                return utils.merge func, @\n\n        _write: console?['lo' + 'g'].bind(console) or (->)\n        _writeError: console?['erro' + 'r'].bind(console) or (->)\n\n### *Integer* log.LOG\n\n### *Integer* log.INFO\n\n### *Integer* log.OK\n\n### *Integer* log.WARN\n\n### *Integer* log.ERROR\n\n### *Integer* log.TIME\n\n### *Integer* log.ALL\n\n        i = 0\n        LOG: 1<<i++\n        INFO: 1<<i++\n        OK: 1<<i++\n        WARN: 1<<i++\n        ERROR: 1<<i++\n        TIME: 1<<i++\n        ALL: (1<<i++) - 1\n\n### *Integer* enabled = log.ALL\n\nBitmask of the `log.LOG`, `INFO`, `OK`, `WARN`, `ERROR` and `TIME`.\n\n        enabled: @::ALL\n\n        isEnabled = (log, type) ->\n            unless log.enabled & type\n                false\n            else if log.parentScope\n                isEnabled log.parentScope, type\n            else\n                true\n\n### log([*Any* messages...])\n\nPrints the given messages into the console.\n\n```javascript\nlog(\"Log me now!\");\n\nlog(\"setName()\", \"db time\");\n\/\/ will be logged as \"setName() \u2192 db time\"\n```\n\n        @::['log'] = ->\n            if isEnabled(@, @LOG)\n                @_write @constructor.MARKERS.white fromArgs arguments\n            return\n\n### log.info([*Any* messages...])\n\nPrints the given messages into the console with a blue color.\n\n        info: ->\n            if isEnabled(@, @INFO)\n                @_write @constructor.MARKERS.blue fromArgs arguments\n            return\n\n### log.ok([*Any* messages...])\n\nPrints the given messages into the console with a green color.\n\n```javascript\nlog.ok(\"Data has been successfully sent!\");\n```\n\n        ok: ->\n            if isEnabled(@, @OK)\n                @_write @constructor.MARKERS.green fromArgs arguments\n            return\n\n### log.warn([*Any* messages...])\n\nPrints the given messages into the console with a yellow color.\n\n```javascript\nlog.warn(\"Example warning with some recommendations\");\n```\n\n        warn: ->\n            if isEnabled(@, @WARN)\n                @_write @constructor.MARKERS.yellow fromArgs arguments\n            return\n\n### log.error([*Any* messages...])\n\nPrints the given messages into the console with a red color.\n\n```javascript\nlog.error(\"Error occurs, ... in file ...\");\n```\n\n        error: ->\n            if isEnabled(@, @ERROR)\n                @_writeError @constructor.MARKERS.red fromArgs arguments\n            return\n\n### *Array* log.time()\n\nReturns an id used to measure execution time by the `log.end()` function.\n\n```javascript\nfunction findPath(){\n  var logtime = log.time('findPath()');\n\n  \/\/ ... some complex algorithm ...\n\n  log.end(logtime);\n}\n\nfindPath();\n```\n\n        time: ->\n            unless isEnabled(@, @TIME)\n                return -1\n\n            [@constructor.time(), fromArgs(arguments)]\n\n### log.end(*Array* logTime)\n\nPrints an information about the execution time for the given timer id.\n\n        end: (logTime) ->\n            diff = @constructor.timeDiff logTime[0]\n            diff = diff.toFixed 2\n\n            str = \"#{logTime[1]}: #{diff} ms\"\n            @_write @constructor.MARKERS.gray str\n\n            logTime[0] = 0\n            return\n\n### log.scope([*Any* names...])\n\nReturns a new `log` function.\n\nAll prints will be prefixed by the given names.\n\n```javascript\nvar log = log.scope(\"Example file\");\n\nlog(\"hello\");\n\/\/ \"Example file \u2192 hello\"\n```\n\n        scope: (args...) ->\n            if @prefixes\n                unshift.apply args, @prefixes\n\n            new @constructor args, @\n\n    # implementation\n    impl = switch true\n        when utils.isNode\n            require '.\/impls\/node\/index.coffee'\n        when utils.isBrowser\n            require '.\/impls\/browser\/index.coffee'\n\n    LogImpl = if typeof impl is 'function' then impl Log else Log\n    exports = module.exports = new LogImpl\n    exports.Log = Log\n","old_contents":"# Log\n\nAccess it with:\n```javascript\nconst { log } = Neft;\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n\n    {bind} = Function\n    {isArray} = Array\n    {unshift} = Array::\n\n    linesPrefix = ''\n\n    fromArgs = (args) ->\n        str = ''\n        str += \"#{arg} \u2192 \" for arg in args\n        str = str.substring 0, str.length - 3\n\n        lines = str.split '\\n'\n        str = ''\n        for line in lines\n            str += \"#{linesPrefix}#{line}\\n\"\n        str = str.slice 0, -1\n\n        str\n\n    callOnce = do ->\n        usedMessages = Object.create null\n        ->\n            msg = fromArgs arguments\n            if usedMessages[msg]\n                return -1\n            usedMessages[msg] = true\n            @ arguments...\n\n## **Class** Log\n\n    class Log\n        @LOGS_METHODS = ['log', 'info', 'warn', 'error', 'time', 'ok']\n\n        @TIMES_LEN = 50\n\n        @MARKERS =\n            white: (str) -> \"LOG: #{str}\"\n            green: (str) -> \"OK: #{str}\"\n            gray: (str) -> \"#{str}\"\n            blue: (str) -> \"INFO: #{str}\"\n            yellow: (str) -> \"WARN: #{str}\"\n            red: (str) -> \"ERROR: #{str}\"\n\n        @setGlobalLinesPrefix = (prefix) ->\n            linesPrefix = prefix\n\n        @time = Date.now\n        @timeDiff = (since) -> Log.time() - since\n        @times = new Array Log.TIMES_LEN\n\n        for _, i in @times\n            @times[i] = [0, '']\n\n        constructor: (prefixes = [], @parentScope) ->\n            @prefixes = prefixes\n            assert.isArray prefixes\n\n            # bind all logs methods\n            args = utils.clone(prefixes)\n            args.unshift @\n\n            for name in @constructor.LOGS_METHODS\n                @[name] = bind.apply @[name], args\n                @[name].once = callOnce\n\n            @[key] = value for key, value of @\n            if typeof @['lo' + 'g'] is 'function'\n                func = =>\n                    @log.apply func, arguments\n                func.once = callOnce\n                func.constructor = @constructor\n                return utils.merge func, @\n\n        _write: console?['lo' + 'g'].bind(console) or (->)\n        _writeError: console?['erro' + 'r'].bind(console) or (->)\n\n### *Integer* log.LOG\n\n### *Integer* log.INFO\n\n### *Integer* log.OK\n\n### *Integer* log.WARN\n\n### *Integer* log.ERROR\n\n### *Integer* log.TIME\n\n### *Integer* log.ALL\n\n        i = 0\n        LOG: 1<<i++\n        INFO: 1<<i++\n        OK: 1<<i++\n        WARN: 1<<i++\n        ERROR: 1<<i++\n        TIME: 1<<i++\n        ALL: (1<<i++) - 1\n\n### *Integer* enabled = log.ALL\n\nBitmask of the `log.LOG`, `INFO`, `OK`, `WARN`, `ERROR` and `TIME`.\n\n        enabled: @::ALL\n\n        isEnabled = (log, type) ->\n            unless log.enabled & type\n                false\n            else if log.parentScope\n                isEnabled log.parentScope, type\n            else\n                true\n\n### log([*Any* messages...])\n\nPrints the given messages into the console.\n\n```javascript\nlog(\"Log me now!\");\n\nlog(\"setName()\", \"db time\");\n\/\/ will be logged as \"setName() \u2192 db time\"\n```\n\n        @::['log'] = ->\n            if isEnabled(@, @LOG)\n                @_write @constructor.MARKERS.white fromArgs arguments\n            return\n\n### log.info([*Any* messages...])\n\nPrints the given messages into the console with a blue color.\n\n        info: ->\n            if isEnabled(@, @INFO)\n                @_write @constructor.MARKERS.blue fromArgs arguments\n            return\n\n### log.ok([*Any* messages...])\n\nPrints the given messages into the console with a green color.\n\n```javascript\nlog.ok(\"Data has been successfully sent!\");\n```\n\n        ok: ->\n            if isEnabled(@, @OK)\n                @_write @constructor.MARKERS.green fromArgs arguments\n            return\n\n### log.warn([*Any* messages...])\n\nPrints the given messages into the console with a yellow color.\n\n```javascript\nlog.warn(\"Example warning with some recommendations\");\n```\n\n        warn: ->\n            if isEnabled(@, @WARN)\n                @_write @constructor.MARKERS.yellow fromArgs arguments\n            return\n\n### log.error([*Any* messages...])\n\nPrints the given messages into the console with a red color.\n\n```javascript\nlog.error(\"Error occurs, ... in file ...\");\n```\n\n        error: ->\n            if isEnabled(@, @ERROR)\n                @_writeError @constructor.MARKERS.red fromArgs arguments\n            return\n\n### *Integer* log.time()\n\nReturns an id used to measure execution time by the `log.end()` function.\n\n```javascript\nfunction findPath(){\n  var logtime = log.time('findPath()');\n\n  \/\/ ... some complex algorithm ...\n\n  log.end(logtime);\n}\n\nfindPath();\n```\n\n        time: ->\n            unless isEnabled(@, @TIME)\n                return -1\n\n            {times} = @constructor\n\n            # get time id and set current time\n            for v, i in times when not v[0]\n                id = i\n                times[i][0] = @constructor.time()\n                times[i][1] = fromArgs arguments\n                break\n\n            assert id?, 'Log times out of range'\n\n            id\n\n### log.end(*Integer* id)\n\nPrints an information about the execution time for the given timer id.\n\n        end: (id) ->\n            if id is -1\n                return\n\n            time = @constructor.times[id]\n            diff = @constructor.timeDiff time[0]\n            diff = diff.toFixed 2\n\n            str = \"#{time[1]}: #{diff} ms\"\n            @_write @constructor.MARKERS.gray str\n\n            time[0] = 0\n            return\n\n### log.scope([*Any* names...])\n\nReturns a new `log` function.\n\nAll prints will be prefixed by the given names.\n\n```javascript\nvar log = log.scope(\"Example file\");\n\nlog(\"hello\");\n\/\/ \"Example file \u2192 hello\"\n```\n\n        scope: (args...) ->\n            if @prefixes\n                unshift.apply args, @prefixes\n\n            new @constructor args, @\n\n    # implementation\n    impl = switch true\n        when utils.isNode\n            require '.\/impls\/node\/index.coffee'\n        when utils.isBrowser\n            require '.\/impls\/browser\/index.coffee'\n\n    LogImpl = if typeof impl is 'function' then impl Log else Log\n    exports = module.exports = new LogImpl\n    exports.Log = Log\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"7016a2dcc7aff98c3a8231ce986e67b8ebeb58c5","subject":"progress helper","message":"progress helper\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onerror: (msg, options) ->\n      console.log msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      @_send @_createCall method, data, callbacks, options\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       throw new Error \"Unknown method: #{data.method}\"\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      @callsCache[data.id].handle data.data, data\n\n     _handlePoll: (data, options) ->\n      throw new Error \"Poll not implemented\"\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n     _onError: (e) -> console.log e\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText?) or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onerror 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onerror 'xhr error'\n\n     _respond: (data, options) ->\n      throw new Error 'AJAX cannot respond'\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       console.log 'error', e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e, data\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       throw new Error \"Poll without response: #{data.id}\"\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onerror: (msg, options) ->\n      console.log msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      @_send @_createCall method, data, callbacks, options\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       throw new Error \"Unknown method: #{data.method}\"\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      @callsCache[data.id].handle data.data, data\n\n     _handlePoll: (data, options) ->\n      throw new Error \"Poll not implemented\"\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n     _onError: (e) -> console.log e\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText?) or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onerror 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onerror 'xhr error'\n\n     _respond: (data, options) ->\n      throw new Error 'AJAX cannot respond'\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       console.log 'error', e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e, data\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       throw new Error \"Poll without response: #{data.id}\"\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"24ae68555da0589135eccf7d59955786d5aa9c4f","subject":"zones were still lurking","message":"zones were still lurking\n","repos":"nhz-io\/cnl","old_file":"source\/shape.litcoffee","new_file":"source\/shape.litcoffee","new_contents":"# CLASS: Shape\n* Extends: [Element][Element]\n* Parent: [Index][Parent]\n\nA drawable shape. Manages **regions**.\n\n---\n\n    module.exports = class Shape extends require '.\/element'\n\n## CONSTRUCTOR\n\n### new Shape(args)\n\nCreates Shape instance.\n\n      constructor: ->\n        super\n\nCopy the element regions if they were set from named arguments\n\n        if regions = @regions\n          @regions = {}\n          @regions[name] = region for name, region of regions\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n### #regions\n* Type: [Object][Object] - region name\/value pairs\n* **{REGION NAME}**\n    * Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## METHODS\n### #draw(context, args)\n* Returns: [Shape][Shape]\n\nA draw method stub\n\n      draw: -> this\n\n---\n\n### #getEventRegions(event)\n* Returns: [Object][Object] - named set of matching regions\n\nHelper method, to get element regions that match the event.\n\n      getEventRegions: (event) ->\n        result = null\n\nProceed only if event coordinates are localized\n\n        if event and (x = event.localX)? and (y = event.localY)?\n\nWalk through the element regions\n\n          for name, $ of @regions\n\nand add the region to the result if event localized coordinates are within\nthe region rectangle.\n\n            if $[0] <= x <= ($[0] + $[2]) and $[1] <= y <= ($[1] + $[3])\n\nInitialize result only if at least one region matches\n\n              result or= {}\n              result[name] = $\n\n        return result\n\n---\n\n## LISTENERS\n\n### #mousemoveCaptureListener(event)\n* Returns: [Shape][Shape]\n\nCapture **mousemove** events passing through this shape\n\n      mousemoveCaptureListener: (event) ->\n        super\n\n        if regions = @getEventRegions event\n\nGet shape regions that match the event and store them in the event.\n\n          event.regions = regions\n\nSet the shape state to the first matching region name in order.\n\n          for name in ['active', 'hover', 'normal'] when regions[name]\n            state = name\n            break\n\nIf any state was set then make this shape a target of the event.\nReset the state if no region was found.\n\n          if (@state = state or null) then event.target = this\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Shape][Shape]\n\nCapture **mousedown** events passing through this shape\n\n      mousedownCaptureListener: (event) ->\n        super\n\n        if regions = @getEventRegions event\n\nGet shape regions that match the event and store them in the event.\n\n          event.regions = regions\n\nSet the shape state to the first matching region name in order\n\n          for name in ['active', 'hover', 'normal'] when regions[name]\n            state = name\n            break\n\nIf any state was set then make this shape a target of the event.\nReset the state if no region was found.\n\n          if (@state = state or null) then event.target = this\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Event][Event]\n\nCapture **mouseup** events passing through this shape\n\n      mouseupCaptureListener: (event) ->\n        super\n\n        if regions = @getEventRegions event\n\nGet shape regions that match the event and store them in the event.\n\n          event.regions = regions\n\nSet the shape state to the first matching region name in order\n\n          for name in ['active', 'hover', 'normal'] when regions[name]\n            state = name\n            break\n\n\nIf any state was set then make this shape a target of the event.\nReset the state if no region was found.\n\n          if (@state = state or null) then event.target = this\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n[Shape]: .\/shape.litcoffee\n[Element]: .\/element.litcoffee\n[Event]: .\/event.litcoffee\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n","old_contents":"# CLASS: Shape\n* Extends: [Element][Element]\n* Parent: [Index][Parent]\n\nA drawable shape. Manages **regions**.\n\n---\n\n    module.exports = class Shape extends require '.\/element'\n\n## CONSTRUCTOR\n\n### new Shape(args)\n\nCreates Shape instance.\n\n      constructor: ->\n        super\n\nCopy the element regions if they were set from named arguments\n\n        if regions = @regions\n          @regions = {}\n          @regions[name] = region for name, region of regions\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n### #regions\n* Type: [Object][Object] - region name\/value pairs\n* **{REGION NAME}**\n    * Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## METHODS\n### #draw(context, args)\n* Returns: [Shape][Shape]\n\nA draw method stub\n\n      draw: -> this\n\n---\n\n### #getEventRegions(event)\n* Returns: [Object][Object] - named set of matching regions\n\nHelper method, to get element regions that match the event.\n\n      getEventRegions: (event) ->\n        result = null\n\nProceed only if event coordinates are localized\n\n        if event and (x = event.localX)? and (y = event.localY)?\n\nWalk through the element regions\n\n          for name, $ of @regions\n\nand add the region to the result if event localized coordinates are within\nthe region rectangle.\n\n            if $[0] <= x <= ($[0] + $[2]) and $[1] <= y <= ($[1] + $[3])\n\nInitialize result only if at least one region matches\n\n              result or= {}\n              result[name] = $\n\n        return result\n\n---\n\n## LISTENERS\n\n### #mousemoveCaptureListener(event)\n* Returns: [Shape][Shape]\n\nCapture **mousemove** events passing through this shape\n\n      mousemoveCaptureListener: (event) ->\n        super\n\n        if regions = @getEventRegions event\n\nGet shape regions that match the event and store them in the event.\n\n          event.regions = regions\n\nSet the shape state to the first matching region name in order.\n\n          for name in ['active', 'hover', 'normal'] when regions[name]\n            state = name\n            break\n\nIf any state was set then make this shape a target of the event.\nReset the state if no region was found.\n\n          if (@state = state or null) then event.target = this\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Shape][Shape]\n\nCapture **mousedown** events passing through this shape\n\n      mousedownCaptureListener: (event) ->\n        super\n\n        if regions = @getEventRegions event\n\nGet shape regions that match the event and store them in the event.\n\n          event.regions = regions\n\nSet the shape state to the first matching region name in order\n\n          for name in ['active', 'hover', 'normal'] when zones[name]\n            state = name\n            break\n\nIf any state was set then make this shape a target of the event.\nReset the state if no region was found.\n\n          if (@state = state or null) then event.target = this\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Event][Event]\n\nCapture **mouseup** events passing through this shape\n\n      mouseupCaptureListener: (event) ->\n        super\n\n        if regions = @getEventRegions event\n\nGet shape regions that match the event and store them in the event.\n\n          event.regions = regions\n\nSet the shape state to the first matching region name in order\n\n          for name in ['active', 'hover', 'normal'] when zones[name]\n            state = name\n            break\n\n\nIf any state was set then make this shape a target of the event.\nReset the state if no region was found.\n\n          if (@state = state or null) then event.target = this\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n[Shape]: .\/shape.litcoffee\n[Element]: .\/element.litcoffee\n[Event]: .\/event.litcoffee\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a281391a520662c175fac479e688bb30ee8a0350","subject":"improve property.inspect","message":"improve property.inspect\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: undefined\n          parent: null\n          container: null\n          private: false\n          mutable: @schema.config?.valueOf() isnt false\n          attached: false\n          changed: false\n          \n        @schema.kind ?= 'anydata'\n          \n        # soft freeze this instance\n        Object.preventExtensions this\n\n      debug: -> debug @uri, arguments...\n      \n      delegate @prototype, 'state'\n        .access 'container'\n        .access 'parent'\n        .access 'strict'\n        .getter 'mutable'\n        .getter 'private'\n        .getter 'prev'\n        .getter 'value'\n        .getter 'changed'\n        .getter 'attached'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'content',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> @value\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @content\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor @name, @schema\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      emit: -> @parent?.emit? arguments...\n\n      clean: -> @state.changed = false\n\n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (key) -> switch\n        when key? \n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].get()\n            when match.length > 1  then match.map (x) -> x.get()\n            else undefined\n        when @binding?\n          try @binding.call @context\n          catch e\n            throw @error e, 'getter'\n        else @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        @state.changed = false\n        # @debug \"[set] enter...\"\n\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n          \n        if @binding?.length is 1 and not opts.force\n          try value = @binding.call @context, value \n          catch e\n            throw @error e, 'setter'\n\n        return this if value? and @equals value, @value\n        \n        @state.prev = @value\n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        # @debug \"[set] applying schema...\"\n        value = switch\n          when @schema.apply? and not bypass\n            @schema.apply value, this, Object.assign {}, opts, suppress: true\n          else value\n        # @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error or @equals value, @prev\n        \n        @state.value = value\n        @state.changed = true\n        \n        # update enumerable state on every set operation\n        try Object.defineProperty @container, @name, configurable: true, enumerable: true if @attached\n\n        @commit opts\n        # @debug \"[set] completed\"\n        return this\n\n### delete\n\n      delete: (opts={}) ->\n        if @binding?.length is 1 and not opts.force\n          try @binding.call @context, null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @state.prev = @value\n        @state.value = null\n\n        @parent?.remove? this, opts # remove from parent\n        \n        # update enumerable state on every set operation\n        try Object.defineProperty @container, @name, enumerable: false if @attached\n\n        @state.changed = true\n        @commit opts\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts) ->\n        return @delete opts if value is null\n        @set value, Object.assign {}, opts, merge: true\n\n### commit (opts)\n\nCommits the changes to the data to the data model\n\n      commit: (opts={}) ->\n        return unless @changed\n        if @attached and @parent?\n          @parent.changes.add this\n          @parent.commit suppress: true\n          \n        { suppress = false, inner = false, actor } = opts\n        return if suppress\n        unless inner\n          try @emit 'update', this, actor\n          catch error\n            # console.warn('commit error, rolling back!');\n            @rollback()\n            throw error\n        @emit 'change', this, actor if @attached\n\n      rollback: ->\n        @state.value = @prev\n        @clean()\n        return this\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n\n        detached = true unless @container?\n        @container = obj\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        if detached and opts.replace isnt true\n          # @debug \"[join] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n          @set obj[name], Object.assign {}, opts, suppress: true\n\n        @parent?.add? this, opts # add to parent\n\n        try Object.defineProperty obj, @name,\n            configurable: true\n            enumerable: @enumerable\n            get: => @get arguments...\n            set: => @set arguments...\n            \n        @state.attached = true\n        # @debug \"[join] attached into #{obj.constructor.name} container\"\n        @emit 'attach', this\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @content = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx=this) ->\n        err = new Error err unless err instanceof Error\n        err.uri = @uri \n        err.src = this\n        err.ctx = ctx\n        return err\n\n### throw (msg)\n\n      throw: (err) -> throw @error(err)\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @value\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @tag ? @name\n          kind:   @kind\n          path:   @path.toString()\n          schema: switch\n            when @schema.uri?\n              uri:      @schema.uri\n              summary:  @schema.description?.tag\n              datakey:  @schema.datakey\n              datapath: @schema.datapath\n              external: @schema.external\n              children: @schema.children\n            else false\n          active:  @active\n          changed: @changed\n          mutable: @mutable\n          content: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: undefined\n          parent: null\n          container: null\n          private: false\n          mutable: @schema.config?.valueOf() isnt false\n          attached: false\n          changed: false\n          \n        @schema.kind ?= 'anydata'\n          \n        # soft freeze this instance\n        Object.preventExtensions this\n\n      debug: -> debug @uri, arguments...\n      \n      delegate @prototype, 'state'\n        .access 'container'\n        .access 'parent'\n        .access 'strict'\n        .getter 'mutable'\n        .getter 'private'\n        .getter 'prev'\n        .getter 'value'\n        .getter 'changed'\n        .getter 'attached'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'content',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> @value\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @content\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor @name, @schema\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      emit: -> @parent?.emit? arguments...\n\n      clean: -> @state.changed = false\n\n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (key) -> switch\n        when key? \n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].get()\n            when match.length > 1  then match.map (x) -> x.get()\n            else undefined\n        when @binding?\n          try @binding.call @context\n          catch e\n            throw @error e, 'getter'\n        else @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        @state.changed = false\n        # @debug \"[set] enter...\"\n\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n          \n        if @binding?.length is 1 and not opts.force\n          try value = @binding.call @context, value \n          catch e\n            throw @error e, 'setter'\n\n        return this if value? and @equals value, @value\n        \n        @state.prev = @value\n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        # @debug \"[set] applying schema...\"\n        value = switch\n          when @schema.apply? and not bypass\n            @schema.apply value, this, Object.assign {}, opts, suppress: true\n          else value\n        # @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error or @equals value, @prev\n        \n        @state.value = value\n        @state.changed = true\n        \n        # update enumerable state on every set operation\n        try Object.defineProperty @container, @name, configurable: true, enumerable: true if @attached\n\n        @commit opts\n        # @debug \"[set] completed\"\n        return this\n\n### delete\n\n      delete: (opts={}) ->\n        if @binding?.length is 1 and not opts.force\n          try @binding.call @context, null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @state.prev = @value\n        @state.value = null\n\n        @parent?.remove? this, opts # remove from parent\n        \n        # update enumerable state on every set operation\n        try Object.defineProperty @container, @name, enumerable: false if @attached\n\n        @state.changed = true\n        @commit opts\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts) ->\n        return @delete opts if value is null\n        @set value, Object.assign {}, opts, merge: true\n\n### commit (opts)\n\nCommits the changes to the data to the data model\n\n      commit: (opts={}) ->\n        return unless @changed\n        if @attached and @parent?\n          @parent.changes.add this\n          @parent.commit suppress: true\n          \n        { suppress = false, inner = false, actor } = opts\n        return if suppress\n        unless inner\n          try @emit 'update', this, actor\n          catch error\n            # console.warn('commit error, rolling back!');\n            @rollback()\n            throw error\n        @emit 'change', this, actor if @attached\n\n      rollback: ->\n        @state.value = @prev\n        @clean()\n        return this\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n\n        detached = true unless @container?\n        @container = obj\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        if detached and opts.replace isnt true\n          # @debug \"[join] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n          @set obj[name], Object.assign {}, opts, suppress: true\n\n        @parent?.add? this, opts # add to parent\n\n        try Object.defineProperty obj, @name,\n            configurable: true\n            enumerable: @enumerable\n            get: => @get arguments...\n            set: => @set arguments...\n            \n        @state.attached = true\n        # @debug \"[join] attached into #{obj.constructor.name} container\"\n        @emit 'attach', this\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @content = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx=this) ->\n        err = new Error err unless err instanceof Error\n        err.uri = @uri \n        err.src = this\n        err.ctx = ctx\n        return err\n\n### throw (msg)\n\n      throw: (err) -> throw @error(err)\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @value\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:    @tag ? @name\n          kind:    @kind\n          path:    @path.toString()\n          schema:  @schema.toJSON? tag: false, extended: true\n          active:  @active\n          changed: @changed\n          mutable: @mutable\n          content: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"1fe12bfcb95281d2b06e43693a77f6531bd0b59d","subject":"Use to path data structure (no row\/col - now it's x\/y)","message":"Use to path data structure (no row\/col - now it's x\/y)\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_blocks.litcoffee","new_file":"lib\/render-pipelines\/png\/png_blocks.litcoffee","new_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngBlocks extends PngRenderer\n\n      do_render: (ctx, path) =>\n        width  = @config.width\n        height = @config.height\n\n        for step in path\n          ctx.fillStyle = @config.block.fill_color\n\n          ctx.beginPath()\n          ctx.rect width * step.x, height * step.y, width, height\n          ctx.fill()\n\n    module.exports = PngBlocks\n","old_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngBlocks extends PngRenderer\n\n      do_render: (ctx, path) =>\n        width  = @config.width\n        height = @config.height\n\n        for step in path\n          ctx.fillStyle = @config.block.fill_color\n\n          ctx.beginPath()\n          ctx.rect width * step.col, height * step.row, width, height\n          ctx.fill()\n\n    module.exports = PngBlocks\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"dd865a8d7c1264d228765eebe6a211eda6ba62ba","subject":"Formatting fix","message":"Formatting fix\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"client\/modules\/middleware.litcoffee","new_file":"client\/modules\/middleware.litcoffee","new_contents":"# Abstract middleware stacks\n\n    {EventEmitter} = require 'events'\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    exports.Middleware = class Middleware extends EventEmitter\n\nImplements a middleware stack. Middleware functions can be added to the stack\nwith `use`. Calling `dispatch` invokes the middleware functions serially.\n\nEach middleware accepts an arbitrary parameters and finally a `next` function.\nWhen a middleware finishes, it must call the `next` function. If there was an\nerror, it must be thrown or passed as the first argument to `next`. If no error\noccurred, `next` must be invoked without arguments.\n\nError-handling middleware can also be defined. These middleware take an\nadditional parameter at the beginning of the function signature: `error`.\nError-handling middleware are only called if a previous middleware threw or\npassed an error. Conversely, non-error-handling middleware are skipped if a\nprevious error occurred.\n\n## *constructor*\n\n*Create a middleware stack.*\n\n      constructor: -> @_middleware = []\n\n## Middlware#use\n\n* (function) `fn` - A middleware function.\n\n*Add a middleware function to the stack.*\n\n      use: (fn) -> @_middleware.push fn\n\n## Middleware#dispatch\n\n* (mixed) `...` - One or more values to pass to the middleware.\n* (function) `fn` - A function invoked when the middleware stack has\n  finished. If an error occurred, it will be passed as the first\n  argument.\n\n*Invoke the middleware functions serially.*\n\n      dispatch: (args..., fn) ->\n        self = this\n\n        index = 0\n\n        invoke = (error) ->\n\n          self.emit 'invoked', self._middleware[index - 1] if index > 0\n\nCall `fn` with any error if we're done.\n\n          return fn error if index is self._middleware.length\n\n          current = self._middleware[index++]\n\nError-handling middleware.\n\n          if current.length is args.length + 2\n\nAn error occurred previously.\n\n            if error?\n\nTry to invoke the middleware, if it throws, just catch the error and pass it\nalong.\n\n              try\n                localArgs = args.concat()\n                localArgs.unshift error\n                localArgs.push invoke\n                self.emit 'invoking', current\n                current localArgs...\n              catch error\n                invoke error\n\nNo previous error; skip this middleware.\n\n            else\n\n              invoke error\n\nNon-error-handling middleware.\n\n          else\n\nAn error occurred previously, skip this middleware.\n\n            if error?\n\n              invoke error\n\nNo previous error.\n\n            else\n\nTry to invoke the middleware, if it throws, just catch the error and pass it along.\n\n              try\n                localArgs = args.concat()\n                localArgs.push invoke\n                self.emit 'invoking', current\n                current localArgs...\n              catch error\n                invoke error\n\nKick things off.\n\n        invoke()\n\n    debug = require('debug') 'shrub:middleware'\n    debugSilly = require('debug') 'shrub-silly:middleware'\n\n## middleware.fromHook\n\n*Create a middleware stack from the results of a hook and path configuration.*\n\n    exports.fromHook = (hook, paths, args...) ->\n\n      middleware = new Middleware()\n\nInvoke the hook and `use` the middleware in the paths configuration order.\n\n      args.unshift hook\n      hookResults = pkgman.invoke args...\n      for path in paths ? []\n        continue unless (spec = hookResults[path])?\n\n        debugSilly \"- - #{spec.label}\"\n\n        for fn in spec.middleware ? []\n          fn.label = spec.label\n          middleware.use fn, spec.label\n\n      middleware.on 'invoking', (fn) -> debugSilly \"Invoking #{fn.label}\"\n      middleware.on 'invoked', (fn) -> debugSilly \"Invoked #{fn.label}\"\n\n      middleware\n\n## middleware.fromShortName\n\n*Create a middleware stack from a short name. e.g. \"example thing hook\".*\n\nThe short name is converted into log messages, a hook name, and configuration\nkey. In the case where we passed in \"user before login\", this would look\nlike:\n\n```coffeescript\ndebug \"Loading user before login middleware...\"\n\nmiddleware = exports.fromHook(\n\t\"userBeforeLoginMiddleware\"\n\tconfig.get \"packageSettings:user:beforeLoginMiddleware\"\n)\n\ndebug \"User before login middleware loaded.\"\n```\n\n###### TODO: This is bad and it should go away.\n\n    exports.fromShortName = (shortName, packageName) ->\n\n      i8n = require 'inflection'\n\n      debugSilly \"- Loading #{shortName} middleware...\"\n\n      [firstPart, keyParts...] = shortName.split ' '\n      packageName ?= firstPart\n      key = keyParts.join '_'\n\n###### TODO: this really should be unified, making this unnecessary.\n\n      configKey = if global? then 'packageSettings' else 'packageConfig'\n\n      middleware = exports.fromHook(\n        \"#{firstPart}#{i8n.camelize key}Middleware\"\n\n        config.get \"#{configKey}:#{packageName}:#{\n          i8n.camelize key, true\n        }Middleware\"\n      )\n\n      debugSilly \"- #{i8n.capitalize shortName} middleware loaded.\"\n\n      middleware\n","old_contents":"# Abstract middleware stacks\n\n    {EventEmitter} = require 'events'\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    exports.Middleware = class Middleware extends EventEmitter\n\nImplements a middleware stack. Middleware functions can be added to the stack\nwith `use`. Calling `dispatch` invokes the middleware functions serially.\n\nEach middleware accepts an arbitrary parameters and finally a `next` function.\nWhen a middleware finishes, it must call the `next` function. If there was an\nerror, it must be thrown or passed as the first argument to `next`. If no error\noccurred, `next` must be invoked without arguments.\n\nError-handling middleware can also be defined. These middleware take an\nadditional parameter at the beginning of the function signature: `error`.\nError-handling middleware are only called if a previous middleware threw or\npassed an error. Conversely, non-error-handling middleware are skipped if a\nprevious error occurred.\n\n## *constructor*\n\n*Create a middleware stack.*\n\n      constructor: -> @_middleware = []\n\n## Middlware#use\n\n* (function) `fn` - A middleware function.\n\n*Add a middleware function to the stack.*\n\n      use: (fn) -> @_middleware.push fn\n\n## Middleware#dispatch\n\n* (mixed) `...` - One or more values to pass to the middleware.\n* (function) `fn` - A function invoked when the middleware stack has\n  finished. If an error occurred, it will be passed as the first\n  argument.\n\n*Invoke the middleware functions serially.*\n\n      dispatch: (args..., fn) ->\n        self = this\n\n        index = 0\n\n        invoke = (error) ->\n\n          self.emit 'invoked', self._middleware[index - 1] if index > 0\n\nCall `fn` with any error if we're done.\n\n          return fn error if index is self._middleware.length\n\n          current = self._middleware[index++]\n\nError-handling middleware.\n\n          if current.length is args.length + 2\n\nAn error occurred previously.\n\n            if error?\n\nTry to invoke the middleware, if it throws, just catch the error and pass it\nalong.\n\n              try\n                localArgs = args.concat()\n                localArgs.unshift error\n                localArgs.push invoke\n                self.emit 'invoking', current\n                current localArgs...\n              catch error\n                invoke error\n\nNo previous error; skip this middleware.\n\n            else\n\n              invoke error\n\nNon-error-handling middleware.\n\n          else\n\nAn error occurred previously, skip this middleware.\n\n            if error?\n\n              invoke error\n\nNo previous error.\n\n            else\n\nTry to invoke the middleware, if it throws, just catch the error and pass it along.\n              try\n                localArgs = args.concat()\n                localArgs.push invoke\n                self.emit 'invoking', current\n                current localArgs...\n              catch error\n                invoke error\n\nKick things off.\n\n        invoke()\n\n    debug = require('debug') 'shrub:middleware'\n    debugSilly = require('debug') 'shrub-silly:middleware'\n\n## middleware.fromHook\n\n*Create a middleware stack from the results of a hook and path configuration.*\n\n    exports.fromHook = (hook, paths, args...) ->\n\n      middleware = new Middleware()\n\nInvoke the hook and `use` the middleware in the paths configuration order.\n\n      args.unshift hook\n      hookResults = pkgman.invoke args...\n      for path in paths ? []\n        continue unless (spec = hookResults[path])?\n\n        debugSilly \"- - #{spec.label}\"\n\n        for fn in spec.middleware ? []\n          fn.label = spec.label\n          middleware.use fn, spec.label\n\n      middleware.on 'invoking', (fn) -> debugSilly \"Invoking #{fn.label}\"\n      middleware.on 'invoked', (fn) -> debugSilly \"Invoked #{fn.label}\"\n\n      middleware\n\n## middleware.fromShortName\n\n*Create a middleware stack from a short name. e.g. \"example thing hook\".*\n\nThe short name is converted into log messages, a hook name, and configuration\nkey. In the case where we passed in \"user before login\", this would look\nlike:\n\n```coffeescript\ndebug \"Loading user before login middleware...\"\n\nmiddleware = exports.fromHook(\n\t\"userBeforeLoginMiddleware\"\n\tconfig.get \"packageSettings:user:beforeLoginMiddleware\"\n)\n\ndebug \"User before login middleware loaded.\"\n```\n\n###### TODO: This is bad and it should go away.\n\n    exports.fromShortName = (shortName, packageName) ->\n\n      i8n = require 'inflection'\n\n      debugSilly \"- Loading #{shortName} middleware...\"\n\n      [firstPart, keyParts...] = shortName.split ' '\n      packageName ?= firstPart\n      key = keyParts.join '_'\n\n###### TODO: this really should be unified, making this unnecessary.\n\n      configKey = if global? then 'packageSettings' else 'packageConfig'\n\n      middleware = exports.fromHook(\n        \"#{firstPart}#{i8n.camelize key}Middleware\"\n\n        config.get \"#{configKey}:#{packageName}:#{\n          i8n.camelize key, true\n        }Middleware\"\n      )\n\n      debugSilly \"- #{i8n.capitalize shortName} middleware loaded.\"\n\n      middleware\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ebe0c83ab16b07e2a17196a6227ca10350c0b41a","subject":"Remove unused import","message":"Remove unused import\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    ObjectID    = require('mongodb').ObjectID\n    stringify   = require('JSONStream').stringify\n\n    Document    = require '.\/model\/Document'\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col]\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n      query = {}\n\n### ?tag=`String`\n\n      if typeof req.query.tag is 'string' and req.query.tag isnt ''\n        if req.query.tag.charAt(0) is '!' and req.query.tag.length > 1\n          query['tags.0'] = $ne: req.query.tag.substr(1)\n        else\n          query['tags.0'] = req.query.tag\n\n### ?grupper=`String`\n\n      if typeof req.query.gruppe is 'string' and req.query.gruppe isnt ''\n        query['grupper'] = req.query.gruppe\n\n### ?after=`Mixed`\n\n      if typeof req.query.after is 'string' and req.query.after isnt ''\n        time = req.query.after\n\n        if not isNaN time\n          # Make unix timestamp into milliseconds\n          time = time + '000' if (time + '').length is 10\n          time = parseInt time\n\n        time = new Date time\n\n        if time.toString() isnt 'Invalid Date'\n          query.endret = $gte: time.toISOString()\n\n### ?bbox=`min_lng`,`min_lat`,`max_lng`,`max_lat`\n\n      if typeof req.query.bbox is 'string' and req.query.bbox.split(',').length is 4\n        bbox = req.query.bbox.split(',')\n        bbox[i] = parseFloat(val) for val, i in bbox\n\n        query.geojson =\n          '$geoWithin':\n            '$geometry':\n              type: 'Polygon'\n              coordinates: [[\n                [bbox[0], bbox[1]]\n                [bbox[2], bbox[1]]\n                [bbox[2], bbox[3]]\n                [bbox[0], bbox[3]]\n                [bbox[0], bbox[1]]\n              ]]\n\n### ?privat.`String`=`String`\n\nThis allows the user to filter documents based on private document properties.\nThis will autumaticly limit returned documents to those owned by the current\nuser.\n\n#### ToDo\n\n * Limit number of private fields?\n * Limit depth of private fields?\n\n`NB` This section is looping through all of the url query parameters and hence\nshould take the queries from above sections into concideration so we don't need\nto do double amount of work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true, tags: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    ObjectID    = require('mongodb').ObjectID\n    stringify   = require('JSONStream').stringify\n    createHash  = require('crypto').createHash\n\n    Document    = require '.\/model\/Document'\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col]\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n      query = {}\n\n### ?tag=`String`\n\n      if typeof req.query.tag is 'string' and req.query.tag isnt ''\n        if req.query.tag.charAt(0) is '!' and req.query.tag.length > 1\n          query['tags.0'] = $ne: req.query.tag.substr(1)\n        else\n          query['tags.0'] = req.query.tag\n\n### ?grupper=`String`\n\n      if typeof req.query.gruppe is 'string' and req.query.gruppe isnt ''\n        query['grupper'] = req.query.gruppe\n\n### ?after=`Mixed`\n\n      if typeof req.query.after is 'string' and req.query.after isnt ''\n        time = req.query.after\n\n        if not isNaN time\n          # Make unix timestamp into milliseconds\n          time = time + '000' if (time + '').length is 10\n          time = parseInt time\n\n        time = new Date time\n\n        if time.toString() isnt 'Invalid Date'\n          query.endret = $gte: time.toISOString()\n\n### ?bbox=`min_lng`,`min_lat`,`max_lng`,`max_lat`\n\n      if typeof req.query.bbox is 'string' and req.query.bbox.split(',').length is 4\n        bbox = req.query.bbox.split(',')\n        bbox[i] = parseFloat(val) for val, i in bbox\n\n        query.geojson =\n          '$geoWithin':\n            '$geometry':\n              type: 'Polygon'\n              coordinates: [[\n                [bbox[0], bbox[1]]\n                [bbox[2], bbox[1]]\n                [bbox[2], bbox[3]]\n                [bbox[0], bbox[3]]\n                [bbox[0], bbox[1]]\n              ]]\n\n### ?privat.`String`=`String`\n\nThis allows the user to filter documents based on private document properties.\nThis will autumaticly limit returned documents to those owned by the current\nuser.\n\n#### ToDo\n\n * Limit number of private fields?\n * Limit depth of private fields?\n\n`NB` This section is looping through all of the url query parameters and hence\nshould take the queries from above sections into concideration so we don't need\nto do double amount of work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true, tags: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"65689c02bd0e8062bd11513e2b63db7cf38adec8","subject":"support fenced code blocks with syntax highlight in markdown","message":"support fenced code blocks with syntax highlight in markdown\n","repos":"romanpitak\/pitak.net,romanpitak\/pitak.net","old_file":"src\/jade\/build.litcoffee","new_file":"src\/jade\/build.litcoffee","new_contents":"# The build script\n\nThis is a very simple build script that puts together the YAML + JADE page files\nand the pure JADE template files. It also builds the blog index.\n\nLoad modules\n\n    fs = require 'fs'\n    mkdirp = require('mkdirp').sync;\n    jade = require 'jade'\n    yaml = require 'js-yaml'\n    config = require '.\/config'\n\n### Markdown\n\nAdd custom markdown parser\nwith custom code parsing function\nthat highlights with Pygments\n\n**note**: We are overriding `renderer.code`\ninstead of `renderer.options.highlight`\nbecause it wraps the highlihter result in unnecessary `<pre><code>`.\n\n**note**: Since Jade doesn't support async filters,\nwe have to use `child_process.execSync`.\nThis requires Node >= 0.11.12\n\nFurther reading:\n- [Marked overriding-renderer-methods](https:\/\/www.npmjs.com\/package\/marked#overriding-renderer-methods)\n- [Node child_process.execSync](http:\/\/nodejs.org\/docs\/v0.12.0\/api\/child_process.html#child_process_child_process_execsync_command_options)\n- [Jade How to define\/install custom filter?](https:\/\/github.com\/jadejs\/jade\/issues\/1055)\n- [Pygments lexers](http:\/\/pygments.org\/docs\/lexers\/)\n\n    execSync = (require 'child_process').execSync\n    marked = require 'marked'\n\n    renderer = new marked.Renderer\n    renderer.code = (code, lexer = 'text') ->\n        result = execSync \"pygmentize -l #{lexer} -f html\",\n            input: code\n        return result.toString()\n\n    marked.setOptions\n        renderer: renderer\n\n    jade.filters.markdown = marked\n\n### Template loader\n\nTemplates are different from pages in that they don't have a YAML front matter.\nThey are written in clean jade and can extend and include other templates.\n\n    class Template\n        constructor: (@name = 'page', @location = config.templatesPath) ->\n        getHtml: (options) ->\n            cwd = process.cwd()\n            options.pretty = config.pretty\n            options.filename = @name\n            try\n                process.chdir @location\n                content = fs.readFileSync \"#{@name}.jade\", 'utf8'\n                @html = jade.render content, options\n            catch error\n                console.log error\n            finally\n                process.chdir cwd\n            return @html\n\n## Page loader\n\n    class Page\n\nA nice \/regexp?\/ from the\n[dworthen\/js-yaml-front-matter](https:\/\/github.com\/dworthen\/js-yaml-front-matter\/blob\/master\/lib\/js-yaml-front.js)\nrepo to separate the YAML front matter from the JADE page content.\n\n        re: \/^(-{3}(?:\\n|\\r)([\\w\\W]+?)(?:\\n|\\r)-{3})?([\\w\\W]*)*\/\n\nSet the file name and location\n\n        constructor: (@pageFile, @location = config.pagesPath) ->\n\nRender the HTML\n\n        render: ->\n\nMake sure we have content\n\n            if not @content?\n                if not @pageFile?\n                    throw new Error 'pageFile not set'\n                location = \"#{@location}\/#{@pageFile}\"\n                @content = fs.readFileSync location, 'utf8'\n\nParse the content\n\n            parts = @re.exec @content\n            if ! @frontMatter?\n                @frontMatter = if parts[2]? then yaml.safeLoad parts[2] else {}\n            this[key] = value for key, value of @frontMatter\n            if ! @containerContent?\n                @containerContent = jade.render parts[3] or '',\n                    filename: @pageFile\n                    pretty: config.pretty\n\nParse the template\n\n            template = new Template @template or null\n            @html = template.getHtml this\n\nWrite the page into the output directory. I might move this to a separate\nfunction (class) later on maybe?\n\n        write: ->\n            folder = \"#{config.htmlPath}#{@url}\"\n            mkdirp folder unless fs.existsSync folder\n            fs.writeFileSync \"#{folder}\/index.html\", @html\n\n#### Blog\n\nIt's the blog index page.\n\n    class Blog extends Page\n        posts: []\n        content: ''\n        template: 'blog'\n        title: 'Blog'\n        url: '\/blog'\n\n#### Pages\n\nIterate through a given directory and process the given pages.\n\nEach page is pushed into a list of pages that will later be used for blog building\nand sitemap.xml\n\n    class Pages\n        constructor: (@location) ->\n            @pages = []\n        render: ->\n            for pageFile in (fs.readdirSync @location).reverse()\n                page = new Page pageFile, @location\n                page.render()\n                page.write()\n                @pages.push page\n\n#### Blogs\n\nDo the Pages thing and build a blog index on top.\n\n    class Blogs extends Pages\n        render: ->\n            super()\n            blog = new Blog\n            blog.posts = @pages\n            do blog.render\n            do blog.write\n\n# Render\n\n    pages = new Pages config.pagesPath\n    pages.render()\n    blogs = new Blogs config.blogPath\n    blogs.render()\n","old_contents":"# The build script\n\nThis is a very simple build script that puts together the YAML + JADE page files\nand the pure JADE template files. It also builds the blog index.\n\nLoad modules\n\n    fs = require 'fs'\n    mkdirp = require('mkdirp').sync;\n    jade = require 'jade'\n    yaml = require 'js-yaml'\n    config = require '.\/config'\n    execSync = (require 'child_process').execSync\n\nAdd custom Pygments filters to Jade\n\n    jade.filters.bashcode = (text) ->\n        result = execSync 'pygmentize -l bash -f html',\n            input: text\n        return result.toString()\n\n### Template loader\n\nTemplates are different from pages in that they don't have a YAML front matter.\nThey are written in clean jade and can extend and include other templates.\n\n    class Template\n        constructor: (@name = 'page', @location = config.templatesPath) ->\n        getHtml: (options) ->\n            cwd = process.cwd()\n            options.pretty = config.pretty\n            options.filename = @name\n            try\n                process.chdir @location\n                content = fs.readFileSync \"#{@name}.jade\", 'utf8'\n                @html = jade.render content, options\n            catch error\n                console.log error\n            finally\n                process.chdir cwd\n            return @html\n\n## Page loader\n\n    class Page\n\nA nice \/regexp?\/ from the\n[dworthen\/js-yaml-front-matter](https:\/\/github.com\/dworthen\/js-yaml-front-matter\/blob\/master\/lib\/js-yaml-front.js)\nrepo to separate the YAML front matter from the JADE page content.\n\n        re: \/^(-{3}(?:\\n|\\r)([\\w\\W]+?)(?:\\n|\\r)-{3})?([\\w\\W]*)*\/\n\nSet the file name and location\n\n        constructor: (@pageFile, @location = config.pagesPath) ->\n\nRender the HTML\n\n        render: ->\n\nMake sure we have content\n\n            if not @content?\n                if not @pageFile?\n                    throw new Error 'pageFile not set'\n                location = \"#{@location}\/#{@pageFile}\"\n                @content = fs.readFileSync location, 'utf8'\n\nParse the content\n\n            parts = @re.exec @content\n            if ! @frontMatter?\n                @frontMatter = if parts[2]? then yaml.safeLoad parts[2] else {}\n            this[key] = value for key, value of @frontMatter\n            if ! @containerContent?\n                @containerContent = jade.render parts[3] or '',\n                    filename: @pageFile\n                    pretty: config.pretty\n\nParse the template\n\n            template = new Template @template or null\n            @html = template.getHtml this\n\nWrite the page into the output directory. I might move this to a separate\nfunction (class) later on maybe?\n\n        write: ->\n            folder = \"#{config.htmlPath}#{@url}\"\n            mkdirp folder unless fs.existsSync folder\n            fs.writeFileSync \"#{folder}\/index.html\", @html\n\n#### Blog\n\nIt's the blog index page.\n\n    class Blog extends Page\n        posts: []\n        content: ''\n        template: 'blog'\n        title: 'Blog'\n        url: '\/blog'\n\n#### Pages\n\nIterate through a given directory and process the given pages.\n\nEach page is pushed into a list of pages that will later be used for blog building\nand sitemap.xml\n\n    class Pages\n        constructor: (@location) ->\n            @pages = []\n        render: ->\n            for pageFile in (fs.readdirSync @location).reverse()\n                page = new Page pageFile, @location\n                page.render()\n                page.write()\n                @pages.push page\n\n#### Blogs\n\nDo the Pages thing and build a blog index on top.\n\n    class Blogs extends Pages\n        render: ->\n            super()\n            blog = new Blog\n            blog.posts = @pages\n            do blog.render\n            do blog.write\n\n# Render\n\n    pages = new Pages config.pagesPath\n    pages.render()\n    blogs = new Blogs config.blogPath\n    blogs.render()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"352a498c9eae5b2f170fa6989fbdc5daa3d0db26","subject":"Item::pointer::pressed and hover props are initialized when possible","message":"Item::pointer::pressed and hover props are initialized when possible\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/renderer\/types\/basics\/item\/pointer.litcoffee","new_file":"src\/renderer\/types\/basics\/item\/pointer.litcoffee","new_contents":"# Pointer\n\n```javascript\nRectangle {\n    width: 100\n    height: 100\n    color: 'green'\n    if (this.pointer.hover) {\n        color: 'red'\n    }\n}\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    signal = require 'src\/signal'\n    assert = require 'src\/assert'\n\n    NOP = ->\n\n    module.exports = (Renderer, Impl, itemUtils, Item) -> (ctor) -> class Pointer extends itemUtils.DeepObject\n        @__name__ = 'Pointer'\n\n        itemUtils.defineProperty\n            constructor: ctor\n            name: 'pointer'\n            valueConstructor: Pointer\n\nEnables mouse and touch handling.\n\n        constructor: (ref) ->\n            super ref\n            @_enabled = true\n            @_draggable = false\n            @_dragActive = false\n            @_pressed = false\n            @_hover = false\n            @_pressedInitialized = false\n            @_hoverInitialized = false\n\n            Object.preventExtensions @\n\n## *Boolean* Pointer::enabled = `true`\n\n## *Signal* Pointer::onEnabledChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: Pointer\n            name: 'enabled'\n            defaultValue: true\n            namespace: 'pointer'\n            parentConstructor: ctor\n            implementation: Impl.setItemPointerEnabled\n            developmentSetter: (val) ->\n                assert.isBoolean val\n\n## Hidden *Boolean* Pointer::draggable = `false`\n\n## Hidden *Signal* Pointer::onDraggableChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: Pointer\n            name: 'draggable'\n            defaultValue: false\n            namespace: 'pointer'\n            parentConstructor: ctor\n            implementation: Impl.setItemPointerDraggable\n            developmentSetter: (val) ->\n                assert.isBoolean val\n\n## Hidden *Boolean* Pointer::dragActive = `false`\n\n## Hidden *Signal* Pointer::onDragActiveChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: Pointer\n            name: 'dragActive'\n            defaultValue: false\n            namespace: 'pointer'\n            parentConstructor: ctor\n            implementation: Impl.setItemPointerDragActive\n            developmentSetter: (val) ->\n                assert.isBoolean val\n\n## *Signal* Pointer::onClick(*Item.Pointer.Event* event)\n\n## *Signal* Pointer::onPress(*Item.Pointer.Event* event)\n\n## *Signal* Pointer::onRelease(*Item.Pointer.Event* event)\n\n## *Signal* Pointer::onEnter(*Item.Pointer.Event* event)\n\n## *Signal* Pointer::onExit(*Item.Pointer.Event* event)\n\n## *Signal* Pointer::onWheel(*Item.Pointer.Event* event)\n\n## *Signal* Pointer::onMove(*Item.Pointer.Event* event)\n\n        PRESS_SIGNALS =\n            onClick: true\n            onPress: true\n            onRelease: true\n\n        MOVE_SIGNALS =\n            onEnter: true\n            onExit: true\n            onMove: true\n\n        onLazySignalInitialized = (pointer, name) ->\n            # automatically initialize pressed and hover properties\n            # if required events will be listened\n            if PRESS_SIGNALS[name] or MOVE_SIGNALS[name]\n                initializePressed pointer\n                if MOVE_SIGNALS[name]\n                    initializeHover pointer\n            Impl.attachItemSignal.call pointer, 'pointer', name # TODO: send here an item\n            return\n\n        @SIGNALS = Object.keys(PRESS_SIGNALS).concat(Object.keys(MOVE_SIGNALS)).concat [\n            'onWheel'\n            # 'onDragStart', 'onDragEnd',\n            # 'onDragEnter', 'onDragExit', 'onDrop'\n        ]\n\n        for signalName in @SIGNALS\n            signal.Emitter.createSignal @, signalName, onLazySignalInitialized\n\n## *Boolean* Pointer::pressed = `false`\n\nWhether the pointer is currently pressed.\n\n## *Signal* Pointer::onPressedChange(*Boolean* oldValue)\n\n        initializePressed = do ->\n            onPress = (event) ->\n                event.stopPropagation = false\n                @pressed = true\n            onRelease = ->\n                @pressed = false\n\n            (pointer) ->\n                unless pointer._pressedInitialized\n                    pointer._pressedInitialized = true\n                    pointer.onPress onPress\n                    pointer.onRelease onRelease\n                return\n\n        itemUtils.defineProperty\n            constructor: Pointer\n            name: 'pressed'\n            defaultValue: false\n            namespace: 'pointer'\n            parentConstructor: ctor\n            signalInitializer: initializePressed\n            getter: (_super) -> ->\n                initializePressed @\n                _super.call @\n\n## *Boolean* Pointer::hover = `false`\n\nWhether the pointer is currently under the item.\n\n## *Signal* Pointer::onHoverChange(*Boolean* oldValue)\n\n        initializeHover = do ->\n            onEnter = ->\n                @hover = true\n            onExit = ->\n                @hover = false\n\n            (pointer) ->\n                unless pointer._hoverInitialized\n                    pointer._hoverInitialized = true\n                    pointer.onEnter onEnter\n                    pointer.onExit onExit\n                return\n\n        itemUtils.defineProperty\n            constructor: Pointer\n            name: 'hover'\n            defaultValue: false\n            namespace: 'pointer'\n            parentConstructor: ctor\n            signalInitializer: initializeHover\n            getter: (_super) -> ->\n                initializeHover @\n                _super.call @\n\n## **Class** Pointer.Event : *Device.PointerEvent*\n\nEvents order:\n 1. Press\n 2. Enter\n 3. Move\n 4. Move (not captured ensured items)\n 5. Exit\n 6. Release\n 7. Click\n 8. Release (not captured ensured items)\n\nStopped 'Enter' event will emit 'Move' event on this item.\n\nStopped 'Exit' event will emit 'Release' event on this item.\n\n        @Event = class PointerEvent\n            constructor: ->\n                @_stopPropagation = true\n                @_checkSiblings = false\n                @_ensureRelease = true\n                @_ensureMove = true\n                Object.preventExtensions @\n\n            @:: = Object.create Renderer.Device.pointer\n            @::constructor = PointerEvent\n\n### *Boolean* PointerEvent::stopPropagation = `false`\n\nEnable this property to stop further event propagation.\n\n            utils.defineProperty @::, 'stopPropagation', null, ->\n                @_stopPropagation\n            , (val) ->\n                assert.isBoolean val\n                @_stopPropagation = val\n\n### *Boolean* PointerEvent::checkSiblings = `false`\n\nBy default first deepest captured item will propagate this event only by his parents.\n\nChange this value to test previous siblings as well.\n\n            utils.defineProperty @::, 'checkSiblings', null, ->\n                @_checkSiblings\n            , (val) ->\n                assert.isBoolean val\n                @_checkSiblings = val\n\n### *Boolean* PointerEvent::ensureRelease = `true`\n\nDefine whether pressed item should get 'onRelease' signal even\nif the pointer has been released outside of this item.\n\nCan be changed only in the 'onPress' signal.\n\n            utils.defineProperty @::, 'ensureRelease', null, ->\n                @_ensureRelease\n            , (val) ->\n                assert.isBoolean val\n                @_ensureRelease = val\n\n### *Boolean* PointerEvent::ensureMove = `true`\n\nDefine whether the pressed item should get 'onMove' signals even\nif the pointer is outside of this item.\n\nCan be changed only in the 'onPress' signal.\n\n            utils.defineProperty @::, 'ensureMove', null, ->\n                @_ensureMove\n            , (val) ->\n                assert.isBoolean val\n                @_ensureMove = val\n\n## *Item.Pointer.Event* Pointer.event\n\n        @event = new PointerEvent\n","old_contents":"# Pointer\n\n```javascript\nRectangle {\n    width: 100\n    height: 100\n    color: 'green'\n    if (this.pointer.hover) {\n        color: 'red'\n    }\n}\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    signal = require 'src\/signal'\n    assert = require 'src\/assert'\n\n    NOP = ->\n\n    module.exports = (Renderer, Impl, itemUtils, Item) -> (ctor) -> class Pointer extends itemUtils.DeepObject\n        @__name__ = 'Pointer'\n\n        itemUtils.defineProperty\n            constructor: ctor\n            name: 'pointer'\n            valueConstructor: Pointer\n\nEnables mouse and touch handling.\n\n        constructor: (ref) ->\n            super ref\n            @_enabled = true\n            @_draggable = false\n            @_dragActive = false\n            @_pressed = false\n            @_hover = false\n            @_pressedInitialized = false\n            @_hoverInitialized = false\n\n            Object.preventExtensions @\n\n## *Boolean* Pointer::enabled = `true`\n\n## *Signal* Pointer::onEnabledChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: Pointer\n            name: 'enabled'\n            defaultValue: true\n            namespace: 'pointer'\n            parentConstructor: ctor\n            implementation: Impl.setItemPointerEnabled\n            developmentSetter: (val) ->\n                assert.isBoolean val\n\n## Hidden *Boolean* Pointer::draggable = `false`\n\n## Hidden *Signal* Pointer::onDraggableChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: Pointer\n            name: 'draggable'\n            defaultValue: false\n            namespace: 'pointer'\n            parentConstructor: ctor\n            implementation: Impl.setItemPointerDraggable\n            developmentSetter: (val) ->\n                assert.isBoolean val\n\n## Hidden *Boolean* Pointer::dragActive = `false`\n\n## Hidden *Signal* Pointer::onDragActiveChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: Pointer\n            name: 'dragActive'\n            defaultValue: false\n            namespace: 'pointer'\n            parentConstructor: ctor\n            implementation: Impl.setItemPointerDragActive\n            developmentSetter: (val) ->\n                assert.isBoolean val\n\n## *Signal* Pointer::onClick(*Item.Pointer.Event* event)\n\n## *Signal* Pointer::onPress(*Item.Pointer.Event* event)\n\n## *Signal* Pointer::onRelease(*Item.Pointer.Event* event)\n\n## *Signal* Pointer::onEnter(*Item.Pointer.Event* event)\n\n## *Signal* Pointer::onExit(*Item.Pointer.Event* event)\n\n## *Signal* Pointer::onWheel(*Item.Pointer.Event* event)\n\n## *Signal* Pointer::onMove(*Item.Pointer.Event* event)\n\n## Hidden *Signal* Pointer::onDragStart()\n\n## Hidden *Signal* Pointer::onDragEnd()\n\n## Hidden *Signal* Pointer::onDragEnter()\n\n## Hidden *Signal* Pointer::onDragExit()\n\n## Hidden *Signal* Pointer::onDrop()\n\n        onLazySignalInitialized = (pointer, name) ->\n            Impl.attachItemSignal.call pointer, 'pointer', name # TODO: send here an item\n            return\n\n        @SIGNALS = ['onClick', 'onPress', 'onRelease',\n                    'onEnter', 'onExit', 'onWheel', 'onMove',\n                    'onDragStart', 'onDragEnd',\n                    'onDragEnter', 'onDragExit', 'onDrop']\n\n        for signalName in @SIGNALS\n            signal.Emitter.createSignal @, signalName, onLazySignalInitialized\n\n## *Boolean* Pointer::pressed = `false`\n\nWhether the pointer is currently pressed.\n\n## *Signal* Pointer::onPressedChange(*Boolean* oldValue)\n\n        intitializePressed = do ->\n            onPress = (event) ->\n                event.stopPropagation = false\n                @pressed = true\n            onRelease = ->\n                @pressed = false\n\n            (pointer) ->\n                unless pointer._pressedInitialized\n                    pointer._pressedInitialized = true\n                    pointer.onPress onPress\n                    pointer.onRelease onRelease\n                return\n\n        itemUtils.defineProperty\n            constructor: Pointer\n            name: 'pressed'\n            defaultValue: false\n            namespace: 'pointer'\n            parentConstructor: ctor\n            signalInitializer: intitializePressed\n            getter: (_super) -> ->\n                intitializePressed @\n                _super.call @\n\n## *Boolean* Pointer::hover = `false`\n\nWhether the pointer is currently under the item.\n\n## *Signal* Pointer::onHoverChange(*Boolean* oldValue)\n\n        initializeHover = do ->\n            onEnter = ->\n                @hover = true\n            onExit = ->\n                @hover = false\n\n            (pointer) ->\n                unless pointer._hoverInitialized\n                    pointer._hoverInitialized = true\n                    pointer.onEnter onEnter\n                    pointer.onExit onExit\n                return\n\n        itemUtils.defineProperty\n            constructor: Pointer\n            name: 'hover'\n            defaultValue: false\n            namespace: 'pointer'\n            parentConstructor: ctor\n            signalInitializer: initializeHover\n            getter: (_super) -> ->\n                initializeHover @\n                _super.call @\n\n## **Class** Pointer.Event : *Device.PointerEvent*\n\nEvents order:\n 1. Press\n 2. Enter\n 3. Move\n 4. Move (not captured ensured items)\n 5. Exit\n 6. Release\n 7. Click\n 8. Release (not captured ensured items)\n\nStopped 'Enter' event will emit 'Move' event on this item.\n\nStopped 'Exit' event will emit 'Release' event on this item.\n\n        @Event = class PointerEvent\n            constructor: ->\n                @_stopPropagation = true\n                @_checkSiblings = false\n                @_ensureRelease = true\n                @_ensureMove = true\n                Object.preventExtensions @\n\n            @:: = Object.create Renderer.Device.pointer\n            @::constructor = PointerEvent\n\n### *Boolean* PointerEvent::stopPropagation = `false`\n\nEnable this property to stop further event propagation.\n\n            utils.defineProperty @::, 'stopPropagation', null, ->\n                @_stopPropagation\n            , (val) ->\n                assert.isBoolean val\n                @_stopPropagation = val\n\n### *Boolean* PointerEvent::checkSiblings = `false`\n\nBy default first deepest captured item will propagate this event only by his parents.\n\nChange this value to test previous siblings as well.\n\n            utils.defineProperty @::, 'checkSiblings', null, ->\n                @_checkSiblings\n            , (val) ->\n                assert.isBoolean val\n                @_checkSiblings = val\n\n### *Boolean* PointerEvent::ensureRelease = `true`\n\nDefine whether pressed item should get 'onRelease' signal even\nif the pointer has been released outside of this item.\n\nCan be changed only in the 'onPress' signal.\n\n            utils.defineProperty @::, 'ensureRelease', null, ->\n                @_ensureRelease\n            , (val) ->\n                assert.isBoolean val\n                @_ensureRelease = val\n\n### *Boolean* PointerEvent::ensureMove = `true`\n\nDefine whether the pressed item should get 'onMove' signals even\nif the pointer is outside of this item.\n\nCan be changed only in the 'onPress' signal.\n\n            utils.defineProperty @::, 'ensureMove', null, ->\n                @_ensureMove\n            , (val) ->\n                assert.isBoolean val\n                @_ensureMove = val\n\n## *Item.Pointer.Event* Pointer.event\n\n        @event = new PointerEvent\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"756845f026fac83fb1c00faba269527beb3a7923","subject":"change port for heroku tests","message":"change port for heroku tests\n","repos":"pirati-cz\/gapi-sparql","old_file":"src\/gapi_sparql.litcoffee","new_file":"src\/gapi_sparql.litcoffee","new_contents":"\nGapiSparql - Main class for GAPI SPARQL component\n\n    restify = require('restify')\n    self = null\n\n    class GapiSparql\n\n        constructor: (options) ->\n            console.log('GapiSparql construct...')\n            self = @\n            @options = options or {}\n            \n            @options.name = 'gapi-sparql'\n            @options.version = '0.0.1'\n            @options.accept = \n            #@options.formatters = {}\n            #@options.formatters['application\/sparql-query'] = @sparqlQuery\n            @options.listenPort ?= 80\n            # @options.accept \n            \n            server = restify.createServer(@options)\n            #server.pre( (req, res, next) ->\n            #    req.headers.accept = 'application\/sparql-query'\n            #    return next()\n            #)\n            server.listen(@options.listenPort, () ->\n                console.log('%s listening at %s', server.name, server.url)\n            )\n            server.get('\/.*\/', (req, res, next) -> \n                # console.log(res)\n                d = \"ahoj svete\"\n                res.writeHead(200, {\n                    'Content-Length': Buffer.byteLength(d),\n                    'Content-Type': 'text\/plain'\n                })\n                res.write(d)\n                res.end()\n                next()\n            )\n            @server = server\n\n        @run: (argv, exit) ->\n            console.log('GapiSparql @run()')\n            gapisparql = new GapiSparql()\n            \n        sparqlQuery: (req, res, body) ->\n            console.log('GapiSparql @sparqlQuery()')\n            body = \"ahok\"\n            #console.log(body)\n            #console.log('----- GapiSparql @sparqlQuery() -----');\n            ###\n            if body instanceof Error\n                res.statusCode = body.statusCode || 500\n                if body.body\n                    #console.log('dada');\n                    #body = body.body.message\n                    body = \"ttt\"\n                else\n                    #body = message: body.message\n                    body = \"fifif\"\n                data = \"err\"\n            else\n                body = \"body pyco\"\n                data = \"aaa\"\n            console.log(body)\n            #console.log(req)\n            #console.log(res)\n            #console.log(body)\n            res.setHeader('Content-Length', Buffer.byteLength(body))\n            return body\n            ###\n            return body\n        \n        use: (pluginName) ->\n            \n      \n    module.exports = GapiSparql","old_contents":"\nGapiSparql - Main class for GAPI SPARQL component\n\n    restify = require('restify')\n    self = null\n\n    class GapiSparql\n\n        constructor: (options) ->\n            console.log('GapiSparql construct...')\n            self = @\n            @options = options or {}\n            \n            @options.name = 'gapi-sparql'\n            @options.version = '0.0.1'\n            @options.accept = \n            #@options.formatters = {}\n            #@options.formatters['application\/sparql-query'] = @sparqlQuery\n            @options.listenPort ?= 8008\n            # @options.accept \n            \n            server = restify.createServer(@options)\n            #server.pre( (req, res, next) ->\n            #    req.headers.accept = 'application\/sparql-query'\n            #    return next()\n            #)\n            server.listen(@options.listenPort, () ->\n                console.log('%s listening at %s', server.name, server.url)\n            )\n            server.get('\/.*\/', (req, res, next) -> \n                # console.log(res)\n                d = \"ahoj svete\"\n                res.writeHead(200, {\n                    'Content-Length': Buffer.byteLength(d),\n                    'Content-Type': 'text\/plain'\n                })\n                res.write(d)\n                res.end()\n                next()\n            )\n            @server = server\n\n        @run: (argv, exit) ->\n            console.log('GapiSparql @run()')\n            gapisparql = new GapiSparql()\n            \n        sparqlQuery: (req, res, body) ->\n            console.log('GapiSparql @sparqlQuery()')\n            body = \"ahok\"\n            #console.log(body)\n            #console.log('----- GapiSparql @sparqlQuery() -----');\n            ###\n            if body instanceof Error\n                res.statusCode = body.statusCode || 500\n                if body.body\n                    #console.log('dada');\n                    #body = body.body.message\n                    body = \"ttt\"\n                else\n                    #body = message: body.message\n                    body = \"fifif\"\n                data = \"err\"\n            else\n                body = \"body pyco\"\n                data = \"aaa\"\n            console.log(body)\n            #console.log(req)\n            #console.log(res)\n            #console.log(body)\n            res.setHeader('Content-Length', Buffer.byteLength(body))\n            return body\n            ###\n            return body\n        \n        use: (pluginName) ->\n            \n      \n    module.exports = GapiSparql","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"d50697bb597c63e0186164f059040b624b55f9ba","subject":"typo fix","message":"typo fix\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @port.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        if self.port.onerror?\n         self.port.onerror e\n        else\n         throw e\n      , 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      dd = data.data\n      if dd? and dd._transferList?\n       transferList = dd._transferList\n       delete dd._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n\n     _respond: (data, options, callback) ->\n      dd = data.data\n      if dd? and dd._transferList?\n       transferList = dd._transferList\n       delete dd._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) =>\n       try\n        callbacks.fail? e\n       catch err\n        @onerror? err\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        if self.port.onerror?\n         self.port.onerror e\n        else\n         throw e\n      , 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      dd = data.data\n      if dd? and dd._transferList?\n       transferList = dd._transferList\n       delete dd._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n\n     _respond: (data, options, callback) ->\n      dd = data.data\n      if dd? and dd._transferList?\n       transferList = dd._transferList\n       delete dd._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) =>\n       try\n        callbacks.fail? e\n       catch err\n        @onerror? err\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"abde9d573debd3a17dbcfe6b9fca825a83c560af","subject":"move how-to into guides, add listing, document data-track and data-debug","message":"move how-to into guides, add listing, document data-track and data-debug\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# \/api\/App Components\/Batman.View\/Batman.View Bindings\n\nSee the [guide](\/docs\/bindings.html) for an overview of view bindings. All bindings take a keypath as an attribute value unless otherwise specified.\n\nBinding | Description | Example\n-----|----|----\n`data-bind`| Binds `innerHTML` or input value. Great for all kinds of inputs. | `<input type=\"checkbox\" data-bind=\"user.isAuthorized\" \/>`\n`data-bind-#{attr}`| Binds node's `attr` to the keypath | `data-bind-id='post.id'`\n`data-source`| `innerHTML` or value will get value from the keypath, but not set it | `<p data-source=\"post.content\"><\/p>`\n`data-source-#{attr}`| Node's `attr` will get its value from the keypath | `<h1 data-source-id='post.id'><\/h1>`\n`data-target`| Changes to the node will set the keypath, but not get from the keypath |`<input data-target='user.name' \/>`\n`data-context-#{name}`| Makes keypath value accessible as `name` inside node | `data-context-lastcomment='mostRecentPost.comments.last'`\n`data-context`| Makes attributes of keypath directly accessible inside node|\n`data-showif`| Shows node if keypath returns truthy | `data-showif='user.isAuthorized'`\n`data-hideif`| Hides node if keypath returns truthy | `data-hideif='post.alreadyPublished'`\n`data-insertif`| The node will be present in the DOM if the keypath returns truthy | `data-insertif='post.isPublished'`\n`data-removeif`| The node will be removed from the DOM if the keypath returns truthy | `data-removeif='comment.isNotAppropriate'`\n`data-renderif`| Node's contents will only be rendered if the keypath returns truthy |\n`data-deferif`| Node's contents will only be rendered if the keypath returns falsey|\n`data-route`| Takes a `Batman.NamedRouteQuery`. Clicking this node will route to the keypath. | `data-route='routes.posts[post].edit'`\n`data-route-params` | Appends the keypath the route generated by a `data-route` on the node | `data-route-params='myParamString'\n`data-view`| Wraps the node in the view specified | `data-view='NavigatorView'`\n`data-view-#{optionName}`| Passes keypath value to `data-view` as `optionName` (see `View.option`) | `data-view-user='currentUser'`\n`data-partial`| Takes a __string__, renders the template with that path | `data-partial='posts\/_form'`\n`data-defineview`| Wraps HTML which should be stored by `Batman.View` | `data-defineview='posts\/index'`\n`data-yield`| Creates a named yield for the application | `data-yield='modal'`\n`data-contentfor`| Wraps content for a non-default yield | `data-contentfor='modal'`\n`data-debug`| Calls `debugger` when instantiating the binding | `data-debug=\"true\"`\n`data-event-#{eventName}`| Binds keypath value to `eventName` on this node | `data-event-click='notifyAllUsers'`\n`data-addclass-#{className}`| Adds class `className` if keypath returns truthy | `data-addclass-selected='item.selected'`\n`data-removeclass-#{className}`| Removes class `className` if keypath returns truthy | `data-removeclass-highlight='item.isPast'`\n`data-foreach-#{itemName}`| Make a copy of this node for each member in keypath; children accessible as `itemName` | `data-foreach-item='myCollection'`\n`data-formfor-#{name}`| Inputs for keypath value will observe errors; keypath value aliased as `name`| `data-formfor-comment='newComment'`\n`data-style-#{styleAttrName}`| Bind the node's style attribute `styleAttrName` to the keypath value| `data-style-float='leftOrRight'`\n`data-track-#{clickOrView}`| Track clicks or views on this node. | `data-track-view='logView'`\n\n\n#### Available Keypath Filters\n\nThe following is a list of available keypaths that can be used with bindings. For a more complete description with accompanying examples see `Batman.View Filters`\n + `lt` : Checks if left content is _less than_ the right content.\n + `gt` : Checks if left content is _greater than_ the right content.\n + `lteq` : Checks if left content is _less than or equal to_ the right content.\n + `gteq` : Checks if left content is _greater than or equal to_ the right content.\n + `equal` or `eq` : Checks if left content is _is equal to_ the right content.\n + `neq` : Checks if left content is _is NOT equal to_ the right content.\n + `ceil` : Runs `Math.ceil` on input value.\n + `floor` : Runs `Math.floor` on input value.\n + `round` : Runs `Math.round` on input value.\n + `precision` : Runs `toPrecision()` on input value.\n + `fixed` : Runs `toFixed()` on input value.\n + `delimitNumber` : Adds comma delimiters to a number\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n__Automatic Validation Display__\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-route-params\n\nAdds the provided keypath or literal value to the route provided to `data-route`. For example:\n\n```html\n<a data-route='routes.villians.new' data-route-params='\"mastermind=true\"'>Mastermind<\/a>\n```\n\nwill route to `\/villians\/new?mastermind=true` and\n\n```\n<a data-route='routes.villians.new' data-route-params='otherRouteParams'>Other<\/a>\n```\n\nwill look up `otherRouteParams` and append it to `\/villains\/new`, adding a `?` if necessary.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n## data-track\n\n`data-track-#{viewOrClick}` fires events on an internal instance of a user-defined `MyApp.EventTracker` class. An `EventTracker` must respond to `track(viewOrClick, keypathValue, node)`, where:\n\n- `viewOrClick` is the binding attribute argument\n- `keypathValue` is the value of the keypath passed to the binding\n- `node` is the bound node.\n\nThe node is considered _viewed_ when the binding is initialized.\n\nUnder the hood, batman.js will instantiate `MyApp.EventTracker` once, storing it at `Batman.Tracking.tracker`.\n\n## data-debug\n\nCalls `debugger` when instantiating the binding. `DebuggerBinding` is removed from production builds of batman.js.\n\n# \/api\/App Components\/Batman.View\/Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## equals(left, right) _or_ eq(left, right): Boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n<span data-showif=\"value | eq 10\"><\/span>\n<span data-showif=\"value | eq true\"><\/span>\n```\n\n__Note__: there is actually _one_ difference between `eq` and `equals`: `equals` rejects undefined values, but `eq` allows them.\n\n## lt(left, right) : Boolean\n\nChecks if left content is `less than` the right content.\n\n```html\n<span data-showif=\"posts.length | lt 10\"><\/span>\n```\n\n## gt(left, right) : Boolean\n\nChecks if left content is `greater than` the right content.\n\n```html\n<span data-showif=\"posts.length | gt 10\"><\/span>\n```\n\n## lteq(left, right) : Boolean\n\nChecks if left content is `less than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | lteq 10\"><\/span>\n```\n\n## gteq(left, right) : Boolean\n\nChecks if left content is `greater than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | gteq 10\"><\/span>\n```\n\n## neq(left, right) : Boolean\n\nChecks if left content is `is NOT equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | neq 10\"><\/span>\n```\n\n## ceil(value) : string\n\nThe `ceil` filter will run `Math.ceil` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | ceil\"><\/span>\n```\n\n## floor(value) : string\n\nThe `floor` filter will run `Math.floor` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | floor\"><\/span>\n```\n\n## round(value) : string\n\nThe `round` filter will run `Math.round` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | round\"><\/span>\n```\n\n## percision(value, toPlace) : string\n\nThe `precision` filter will run `toPrecision()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | precision\"><\/span>\n<span data-bind=\"someValue | precision 3\"><\/span>\n```\n\n## fixed(value, toPlace) : string\n\nThe `fixed` filter will run `toFixed()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | fixed\"><\/span>\n<span data-bind=\"someValue | fixed 3\"><\/span>\n```\n\n## delimitNumber(value) : string\n\nThe `delimitNumber` filter will comma delimit a 'number'. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | delimitNumber\"><\/span>\n```\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","old_contents":"# \/api\/App Components\/Batman.View\/Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n#### Available Keypath Filters\n\nThe following is a list of available keypaths that can be used with bindings. For a more complete description with accompanying examples see `Batman.View Filters`\n + `lt` : Checks if left content is _less than_ the right content.\n + `gt` : Checks if left content is _greater than_ the right content.\n + `lteq` : Checks if left content is _less than or equal to_ the right content.\n + `gteq` : Checks if left content is _greater than or equal to_ the right content.\n + `equal` or `eq` : Checks if left content is _is equal to_ the right content.\n + `neq` : Checks if left content is _is NOT equal to_ the right content.\n + `ceil` : Runs `Math.ceil` on input value.\n + `floor` : Runs `Math.floor` on input value.\n + `round` : Runs `Math.round` on input value.\n + `precision` : Runs `toPrecision()` on input value.\n + `fixed` : Runs `toFixed()` on input value.\n + `delimitNumber` : Adds comma delimiters to a number\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n__Automatic Validation Display__\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-route-params\n\nAdds the provided keypath or literal value to the route provided to `data-route`. For example:\n\n```html\n<a data-route='routes.villians.new' data-route-params='\"mastermind=true\"'>Mastermind<\/a>\n```\n\nwill route to `\/villians\/new?mastermind=true` and\n\n```\n<a data-route='routes.villians.new' data-route-params='otherRouteParams'>Other<\/a>\n```\n\nwill look up `otherRouteParams` and append it to `\/villains\/new`, adding a `?` if necessary.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# \/api\/App Components\/Batman.View\/Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## equals(left, right) _or_ eq(left, right): Boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n<span data-showif=\"value | eq 10\"><\/span>\n<span data-showif=\"value | eq true\"><\/span>\n```\n\n__Note__: there is actually _one_ difference between `eq` and `equals`: `equals` rejects undefined values, but `eq` allows them.\n\n## lt(left, right) : Boolean\n\nChecks if left content is `less than` the right content.\n\n```html\n<span data-showif=\"posts.length | lt 10\"><\/span>\n```\n\n## gt(left, right) : Boolean\n\nChecks if left content is `greater than` the right content.\n\n```html\n<span data-showif=\"posts.length | gt 10\"><\/span>\n```\n\n## lteq(left, right) : Boolean\n\nChecks if left content is `less than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | lteq 10\"><\/span>\n```\n\n## gteq(left, right) : Boolean\n\nChecks if left content is `greater than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | gteq 10\"><\/span>\n```\n\n## neq(left, right) : Boolean\n\nChecks if left content is `is NOT equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | neq 10\"><\/span>\n```\n\n## ceil(value) : string\n\nThe `ceil` filter will run `Math.ceil` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | ceil\"><\/span>\n```\n\n## floor(value) : string\n\nThe `floor` filter will run `Math.floor` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | floor\"><\/span>\n```\n\n## round(value) : string\n\nThe `round` filter will run `Math.round` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | round\"><\/span>\n```\n\n## percision(value, toPlace) : string\n\nThe `precision` filter will run `toPrecision()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | precision\"><\/span>\n<span data-bind=\"someValue | precision 3\"><\/span>\n```\n\n## fixed(value, toPlace) : string\n\nThe `fixed` filter will run `toFixed()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | fixed\"><\/span>\n<span data-bind=\"someValue | fixed 3\"><\/span>\n```\n\n## delimitNumber(value) : string\n\nThe `delimitNumber` filter will comma delimit a 'number'. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | delimitNumber\"><\/span>\n```\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8013b4fa6e524615ff13d86cb99ae28243c415b0","subject":"Why does that keep out-denting!?","message":"Why does that keep out-denting!?\n","repos":"nswarr\/epiquery2-client","old_file":"src\/epi-client.litcoffee","new_file":"src\/epi-client.litcoffee","new_contents":"    EventEmitter      = require('events').EventEmitter\n    _                 = require 'underscore'\n    log               = require 'simplog'\n    AwesomeWebSocket  = require('awesome-websocket').AwesomeWebSocket\n\nEpiClient\n=========\nThis is the base client for communicating with epiquery2.\n\n    class EpiClient extends EventEmitter\n\nThe @url constructor argument can be either a singular string or an array of strings that represent the\nepiquery2 endpoint(s).\n\n      constructor: (@url) ->\n        @connect()\n\nUnder the hood, we're using the [AwesomeWebSocket](https:\/\/github.com\/glg\/awesome-websocket) to ensure auto-reconnect\non interruptions and endpoint hunting to find the fastest connection.\n\n      connect: =>\n        @ws = new AwesomeWebSocket(@url)\n        @queryId = 0\n        @ws.onmessage = @onMessage\n        @ws.onclose = @onClose\n        @ws.onopen = () ->\n          log.debug \"Epiclient connection opened\"\n        @ws.onerror = (err) ->\n          log.error \"EpiClient socket error: \", err\n\nThe **query** function kicks off the processing of a query which triggers a handful of events in the lifecycle of a query.  See the events section below for more details.\n\n**connectionName** - The string key that maps to an epiquery2 named connection e.g. 'mysql', 'mssql', 'file'.  See more [here](https:\/\/github.com\/igroff\/epiquery2#configuration).\n\n**template** - The path to the template you're querying.  The path is relative to the root of the template directory defined in epiquery2.\n\n**data** - This is a just javascript object you can pass that contains any data you want to use in your epiquery template.\n\n**queryId** - A unique identifier used to refer to the query throughout it's Active period. It will be included with all messages generated during it's processing. It is the caller's responsibility to generate a unique id for each query requested.\n\n      query: (connectionName, template, data, queryId=null) =>\n        req =\n          templateName: template\n          connectionName: connectionName\n          data: data\n        req.queryId = null || queryId\n        req.closeOnEnd = data.closeOnEnd if data\n        # if someone has asked us to close on end, we want our fancy\n        # underlying reconnectint sockets to not reconnect\n        @ws.forceClose = req.closeOnEnd\n\n        log.debug \"executing query: #{template} data:#{JSON.stringify(data)}\"\n        @ws.send JSON.stringify(req)\n\nEchoes events returned from epiquery.\n\n      onMessage: (message) =>\n        # if the browser has wrapped this for use, we'll be interested in its\n        # 'data' element\n        message = message.data if message.type? and message.type = 'message'\n        message = JSON.parse(message) if typeof message is 'string'\n        handler = @['on' + message.message]\n        if handler\n          handler(message)\n\n      onClose: () =>\n        @emit 'close'\n\n## Events\nThey're all pretty self explanatory.  The messages provided to the events have the optional field **queryId** that corresponds to the  queryId that was provided to the **query** function.  Use that to track a particular request in the query's lifecycle.\n\nInvoked at the start of the query's lifecycle.  Important to note, this is the beginning of the whole epiquery request, not individual statements in the request.\n\n      onbeginquery: (msg) => @emit 'beginquery', msg\n\nInvoked when a new row set is began.  Row sets are the result of executing an individual statement.  For example, if you executed two SQL statements, each would be its own row set.\n\n      onbeginrowset: (msg) => @emit 'beginrowset', msg\n\nInvoked every time a row of data is returned from a row set.\n\n      onrow: (msg) => @emit 'row', msg\n\nInvoked at the end of a row set.\n\n      onendrowset: (msg) => @emit 'endrowset', msg\n\nInvoked at the end of the query's overall lifecycle.\n\n      onendquery: (msg) => @emit 'endquery', msg\n\nInvoked if an error is encountered while processing the query.\n\n      onerror: (msg) => @emit 'error', msg\n\n\n\n    module.exports = EpiClient","old_contents":"  EventEmitter      = require('events').EventEmitter\n    _                 = require 'underscore'\n    log               = require 'simplog'\n    AwesomeWebSocket  = require('awesome-websocket').AwesomeWebSocket\n\nEpiClient\n=========\nThis is the base client for communicating with epiquery2.\n\n    class EpiClient extends EventEmitter\n\nThe @url constructor argument can be either a singular string or an array of strings that represent the\nepiquery2 endpoint(s).\n\n      constructor: (@url) ->\n        @connect()\n\nUnder the hood, we're using the [AwesomeWebSocket](https:\/\/github.com\/glg\/awesome-websocket) to ensure auto-reconnect\non interruptions and endpoint hunting to find the fastest connection.\n\n      connect: =>\n        @ws = new AwesomeWebSocket(@url)\n        @queryId = 0\n        @ws.onmessage = @onMessage\n        @ws.onclose = @onClose\n        @ws.onopen = () ->\n          log.debug \"Epiclient connection opened\"\n        @ws.onerror = (err) ->\n          log.error \"EpiClient socket error: \", err\n\nThe **query** function kicks off the processing of a query which triggers a handful of events in the lifecycle of a query.  See the events section below for more details.\n\n**connectionName** - The string key that maps to an epiquery2 named connection e.g. 'mysql', 'mssql', 'file'.  See more [here](https:\/\/github.com\/igroff\/epiquery2#configuration).\n\n**template** - The path to the template you're querying.  The path is relative to the root of the template directory defined in epiquery2.\n\n**data** - This is a just javascript object you can pass that contains any data you want to use in your epiquery template.\n\n**queryId** - A unique identifier used to refer to the query throughout it's Active period. It will be included with all messages generated during it's processing. It is the caller's responsibility to generate a unique id for each query requested.\n\n      query: (connectionName, template, data, queryId=null) =>\n        req =\n          templateName: template\n          connectionName: connectionName\n          data: data\n        req.queryId = null || queryId\n        req.closeOnEnd = data.closeOnEnd if data\n        # if someone has asked us to close on end, we want our fancy\n        # underlying reconnectint sockets to not reconnect\n        @ws.forceClose = req.closeOnEnd\n\n        log.debug \"executing query: #{template} data:#{JSON.stringify(data)}\"\n        @ws.send JSON.stringify(req)\n\nEchoes events returned from epiquery.\n\n      onMessage: (message) =>\n        # if the browser has wrapped this for use, we'll be interested in its\n        # 'data' element\n        message = message.data if message.type? and message.type = 'message'\n        message = JSON.parse(message) if typeof message is 'string'\n        handler = @['on' + message.message]\n        if handler\n          handler(message)\n\n      onClose: () =>\n        @emit 'close'\n\n## Events\nThey're all pretty self explanatory.  The messages provided to the events have the optional field **queryId** that corresponds to the  queryId that was provided to the **query** function.  Use that to track a particular request in the query's lifecycle.\n\nInvoked at the start of the query's lifecycle.  Important to note, this is the beginning of the whole epiquery request, not individual statements in the request.\n\n      onbeginquery: (msg) => @emit 'beginquery', msg\n\nInvoked when a new row set is began.  Row sets are the result of executing an individual statement.  For example, if you executed two SQL statements, each would be its own row set.\n\n      onbeginrowset: (msg) => @emit 'beginrowset', msg\n\nInvoked every time a row of data is returned from a row set.\n\n      onrow: (msg) => @emit 'row', msg\n\nInvoked at the end of a row set.\n\n      onendrowset: (msg) => @emit 'endrowset', msg\n\nInvoked at the end of the query's overall lifecycle.\n\n      onendquery: (msg) => @emit 'endquery', msg\n\nInvoked if an error is encountered while processing the query.\n\n      onerror: (msg) => @emit 'error', msg\n\n\n\n    module.exports = EpiClient","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1a1d5cc1fbc0596bf5bd0426c5c6984c36f6e196","subject":"Make it 2nd level heading so I can link to it","message":"Make it 2nd level heading so I can link to it\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/07_request.litcoffee","new_file":"docs\/07_request.litcoffee","new_contents":"# Batman.Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented in the platform layer files.\n\n## Platform Request Implmentation Libraries\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\nBatman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\nIn other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n\n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n\nThere are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n1. `loading()`: fired before `send()` has been called.\n\n        test \"Demonstrate the loading event\", 1, ->\n           new Batman.Request\n             url: \"http::\/\/batmanjs.org\"\n             loading: ->\n               ok true, \"After send but before the request is made\"\n\n1. `loaded()`: fired after the request is complete\n\n         test \"Demo the loaded event\", 1, ->\n           Batman.Request.setupMockedResponse()\n           Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n           new Batman.Request\n             url: \"http:\/\/batmanjs.org\"\n             loaded: ->\n               ok true, \"Loaded\"\n\n1. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n        test \"Demo the error event\", 1, ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            error: (xhr) ->\n              ok true, \"Error\"\n\n1. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n        test \"Demonstrate the success event\", 1,  ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            success: (response) ->\n              equal \"foo\", response\n\n## .status\nThe response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\nThe response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : object\nAn key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request(options : object)\n\nConstructs a new `Batman.Request` with the supplied options\n\n### `options` description\n\n1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n\n1. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`.\n\n        test \"method test\", ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            method: \"POST\"\n            data: { some: \"data\" }\n            success: (response) ->\n              ok true\n\n1. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n\n1. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n        test \"contentType default\", ->\n           req = new Batman.Request\n           equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n1. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n        test \"autosend test\", ->\n          response_sent = false\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n          req = new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            autosend: false\n            success: (response) ->\n              response_sent = true\n          ok !response_sent\n          req.send()\n          ok response_sent\n\n1. `username`: username for authentication\n\n1. `password`: password for authentication\n\n1. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send([data])\nIf `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","old_contents":"# Batman.Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented in the platform layer files.\n\n### Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\nBatman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\nIn other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n\n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n\nThere are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n1. `loading()`: fired before `send()` has been called.\n\n        test \"Demonstrate the loading event\", 1, ->\n           new Batman.Request\n             url: \"http::\/\/batmanjs.org\"\n             loading: ->\n               ok true, \"After send but before the request is made\"\n\n1. `loaded()`: fired after the request is complete\n\n         test \"Demo the loaded event\", 1, ->\n           Batman.Request.setupMockedResponse()\n           Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n           new Batman.Request\n             url: \"http:\/\/batmanjs.org\"\n             loaded: ->\n               ok true, \"Loaded\"\n\n1. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n        test \"Demo the error event\", 1, ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            error: (xhr) ->\n              ok true, \"Error\"\n\n1. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n        test \"Demonstrate the success event\", 1,  ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            success: (response) ->\n              equal \"foo\", response\n\n## .status\nThe response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\nThe response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : object\nAn key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request(options : object)\n\nConstructs a new `Batman.Request` with the supplied options\n\n### `options` description\n\n1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n\n1. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`.\n\n        test \"method test\", ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            method: \"POST\"\n            data: { some: \"data\" }\n            success: (response) ->\n              ok true\n\n1. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n\n1. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n        test \"contentType default\", ->\n           req = new Batman.Request\n           equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n1. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n        test \"autosend test\", ->\n          response_sent = false\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n          req = new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            autosend: false\n            success: (response) ->\n              response_sent = true\n          ok !response_sent\n          req.send()\n          ok response_sent\n\n1. `username`: username for authentication\n\n1. `password`: password for authentication\n\n1. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send([data])\nIf `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3e13b86d33b66aa1e2e42c95fd2399dada2f9358","subject":"No line logger on CI","message":"No line logger on CI\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/log\/index.litcoffee","new_file":"src\/log\/index.litcoffee","new_contents":"# Log\n\n    'use strict'\n\n    parser = require '.\/parser'\n    marker = require '.\/marker'\n    printer = require '.\/printer'\n    lineLogger = try require '.\/line-logger'\n    repeatLogger = require '.\/repeat-logger'\n    timerLogger = require '.\/timer-logger'\n    prefixLogger = require '.\/prefix-logger'\n\n    DEFAULT_SCOPE = 'debug'\n    LOADING_MSG = 'Loading...'\n    LOADING_FRAMES = ['\u28fe', '\u28fd', '\u28fb', '\u28bf', '\u287f', '\u28df', '\u28ef', '\u28f7']\n\n    # https:\/\/github.com\/darkskyapp\/string-hash\n    getStringHash = (str) ->\n        hash = 5381\n        i = str.length\n        while(i)\n            hash = (hash * 33) ^ str.charCodeAt(--i)\n        hash >>> 0\n\n    getStringColor = (str) ->\n        hash = getStringHash str\n        hex = hash.toString 16\n        validHex = \"000000#{hex}\".slice(-6)\n        \"##{validHex}\"\n\n    class Logger\n        constructor: (@scopeName = DEFAULT_SCOPE) ->\n            @scopeColor = getStringColor @scopeName\n            @_loadingFrame = 0\n\n        stop: ->\n\n        print: (msgBuilder) ->\n            ctx = printer.createContext()\n            printer.stdout msgBuilder(ctx), ctx\n            @\n\n        println: (msgBuilder) ->\n            ctx = printer.createContext()\n            msg = msgBuilder(ctx)\n            if printer.allowsNoLine\n                msg += '\\n'\n            printer.stdout msg, ctx\n            @\n\n        line: ->\n            if process.env.CI\n                @\n            else\n                lineLogger?.createLogger(@) or @\n\n        repeat: (opts) ->\n            if process.env.CI\n                @\n            else\n                repeatLogger.createLogger @, opts\n\n        timer: ->\n            timerLogger.createLogger @\n\n        prefix: (prefix) ->\n            prefixLogger.createLogger @, prefix\n\n        scope: (name) ->\n            childScope = if @scopeName is DEFAULT_SCOPE then '' else \"#{@scopeName}:\"\n            childScope += name\n            new Logger childScope\n\n        log: (msg) ->\n            @println (ctx) -> parser.parse(msg, ctx)\n\n        debug: (msg) ->\n            @println (ctx) =>\n                marker.hex(@scopeName, @scopeColor, ctx) + '  ' + parser.parse(msg, ctx)\n\n        info: (msg) ->\n            @println (ctx) ->\n                marker.blue(marker.bold('INFO', ctx), ctx) + '  ' + parser.parse(msg, ctx)\n\n        ok: (msg) ->\n            @println (ctx) ->\n                marker.green(marker.bold('OK', ctx), ctx) + '  ' + parser.parse(msg, ctx)\n\n        warn: (msg) ->\n            @println (ctx) ->\n                marker.yellow(marker.bold('WARN', ctx), ctx) + '  ' + parser.parse(msg, ctx)\n\n        error: (msg, error) ->\n            @println (ctx) ->\n                marker.red(marker.bold('ERROR', ctx), ctx) + '  ' + parser.parse(msg, ctx)\n            if error?.stack\n                @println (ctx) -> error.stack\n\n        progress: (title, value, max) ->\n            if typeof title is 'number'\n                max = value\n                value = title\n                title = ''\n            width = process.stdout.columns \/ 3 - parser.clear(title).length\n            if max is undefined\n                value = Math.floor value * 100\n                max = 100\n                label = \"#{value}%\"\n            else\n                label = \"#{value}\/#{max}\"\n            left = '\u2588'.repeat(Math.min(width, Math.floor(value \/ max * width)))\n            right = '\u2591'.repeat(Math.max(0, width - left.length))\n            @println (ctx) ->\n                titleMsg = if title then \"#{parser.parse(title, ctx)}  \" else ''\n                \"#{titleMsg}#{left}#{marker.gray right, ctx} #{label}\"\n\n        loading: (msg = LOADING_MSG, frames = LOADING_FRAMES) ->\n            @println (ctx) =>\n                frame = frames[@_loadingFrame++ % frames.length]\n                marker.cyan(frame, ctx) + ' ' + parser.parse(msg, ctx)\n\n    module.exports = new Logger\n","old_contents":"# Log\n\n    'use strict'\n\n    parser = require '.\/parser'\n    marker = require '.\/marker'\n    printer = require '.\/printer'\n    lineLogger = try require '.\/line-logger'\n    repeatLogger = require '.\/repeat-logger'\n    timerLogger = require '.\/timer-logger'\n    prefixLogger = require '.\/prefix-logger'\n\n    DEFAULT_SCOPE = 'debug'\n    LOADING_MSG = 'Loading...'\n    LOADING_FRAMES = ['\u28fe', '\u28fd', '\u28fb', '\u28bf', '\u287f', '\u28df', '\u28ef', '\u28f7']\n\n    # https:\/\/github.com\/darkskyapp\/string-hash\n    getStringHash = (str) ->\n        hash = 5381\n        i = str.length\n        while(i)\n            hash = (hash * 33) ^ str.charCodeAt(--i)\n        hash >>> 0\n\n    getStringColor = (str) ->\n        hash = getStringHash str\n        hex = hash.toString 16\n        validHex = \"000000#{hex}\".slice(-6)\n        \"##{validHex}\"\n\n    class Logger\n        constructor: (@scopeName = DEFAULT_SCOPE) ->\n            @scopeColor = getStringColor @scopeName\n            @_loadingFrame = 0\n\n        stop: ->\n\n        print: (msgBuilder) ->\n            ctx = printer.createContext()\n            printer.stdout msgBuilder(ctx), ctx\n            @\n\n        println: (msgBuilder) ->\n            ctx = printer.createContext()\n            msg = msgBuilder(ctx)\n            if printer.allowsNoLine\n                msg += '\\n'\n            printer.stdout msg, ctx\n            @\n\n        line: ->\n            lineLogger?.createLogger(@) or @\n\n        repeat: (opts) ->\n            if process.env.CI\n                @\n            else\n                repeatLogger.createLogger @, opts\n\n        timer: ->\n            timerLogger.createLogger @\n\n        prefix: (prefix) ->\n            prefixLogger.createLogger @, prefix\n\n        scope: (name) ->\n            childScope = if @scopeName is DEFAULT_SCOPE then '' else \"#{@scopeName}:\"\n            childScope += name\n            new Logger childScope\n\n        log: (msg) ->\n            @println (ctx) -> parser.parse(msg, ctx)\n\n        debug: (msg) ->\n            @println (ctx) =>\n                marker.hex(@scopeName, @scopeColor, ctx) + '  ' + parser.parse(msg, ctx)\n\n        info: (msg) ->\n            @println (ctx) ->\n                marker.blue(marker.bold('INFO', ctx), ctx) + '  ' + parser.parse(msg, ctx)\n\n        ok: (msg) ->\n            @println (ctx) ->\n                marker.green(marker.bold('OK', ctx), ctx) + '  ' + parser.parse(msg, ctx)\n\n        warn: (msg) ->\n            @println (ctx) ->\n                marker.yellow(marker.bold('WARN', ctx), ctx) + '  ' + parser.parse(msg, ctx)\n\n        error: (msg, error) ->\n            @println (ctx) ->\n                marker.red(marker.bold('ERROR', ctx), ctx) + '  ' + parser.parse(msg, ctx)\n            if error?.stack\n                @println (ctx) -> error.stack\n\n        progress: (title, value, max) ->\n            if typeof title is 'number'\n                max = value\n                value = title\n                title = ''\n            width = process.stdout.columns \/ 3 - parser.clear(title).length\n            if max is undefined\n                value = Math.floor value * 100\n                max = 100\n                label = \"#{value}%\"\n            else\n                label = \"#{value}\/#{max}\"\n            left = '\u2588'.repeat(Math.min(width, Math.floor(value \/ max * width)))\n            right = '\u2591'.repeat(Math.max(0, width - left.length))\n            @println (ctx) ->\n                titleMsg = if title then \"#{parser.parse(title, ctx)}  \" else ''\n                \"#{titleMsg}#{left}#{marker.gray right, ctx} #{label}\"\n\n        loading: (msg = LOADING_MSG, frames = LOADING_FRAMES) ->\n            @println (ctx) =>\n                frame = frames[@_loadingFrame++ % frames.length]\n                marker.cyan(frame, ctx) + ' ' + parser.parse(msg, ctx)\n\n    module.exports = new Logger\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"5faad9aae48e204a6ed81d4d8dad9b855ae44b14","subject":"Remove styling from the league entries","message":"Remove styling from the league entries\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/managers\/league.litcoffee","new_file":"src\/coffee\/managers\/league.litcoffee","new_contents":"League Table Manager\n====================\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe are interested in two key pieces of input information: the\nleaderboard and the team roster.\n\n        inputStream = Bacon.combineTemplate\n            teams: Data.teams\n            leaderboard: League.leaderboard\n\nTable Management\n----------------\n\nWe use D3 to set the data within the table.\n\n        inputStream.onValue (state) ->\n            nodeHTML = (entry) ->\n                \"<td>#{entry.position}<\/td>\n                 <td>#{state.teams[entry.team].name}<\/td>\"\n\n            updateTable = (element, entries) ->\n                tableNodes = d3.select(\"##{element}\")\n                               .selectAll('tr')\n                               .data(entries)\n                               .html(nodeHTML)\n\n                tableNodes.enter()\n                          .append('tr')\n                          .html(nodeHTML)\n\n                tableNodes.exit()\n                          .remove()\n\n            ENTRIES_PER_SIDE = 14\n            updateTable 'league-table-left',\n                        state.leaderboard[0...ENTRIES_PER_SIDE]\n            updateTable 'league-table-right',\n                        state.leaderboard[ENTRIES_PER_SIDE...ENTRIES_PER_SIDE*2]\n\n","old_contents":"League Table Manager\n====================\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe are interested in two key pieces of input information: the\nleaderboard and the team roster.\n\n        inputStream = Bacon.combineTemplate\n            teams: Data.teams\n            leaderboard: League.leaderboard\n\nTable Management\n----------------\n\nWe use D3 to set the data within the table.\n\n        inputStream.onValue (state) ->\n            nodeHTML = (entry) ->\n                \"<td>#{entry.position}<\/td>\n                 <td>#{state.teams[entry.team].name}<\/td>\"\n\n            updateTable = (element, entries) ->\n                tableNodes = d3.select(\"##{element}\")\n                               .selectAll('tr')\n                               .data(entries)\n                               .html(nodeHTML)\n\n                tableNodes.enter()\n                          .append('tr')\n                          .html(nodeHTML)\n                          .classed 'info', (entry) ->\n                              entry.key == state.current?.key\n\n                tableNodes.exit()\n                          .remove()\n\n            ENTRIES_PER_SIDE = 14\n            updateTable 'league-table-left',\n                        state.leaderboard[0...ENTRIES_PER_SIDE]\n            updateTable 'league-table-right',\n                        state.leaderboard[ENTRIES_PER_SIDE...ENTRIES_PER_SIDE*2]\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0ce5185744700d99fe24ec16b762adbffe7f59b4","subject":"fix typo","message":"fix typo\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/01_data_structures\/04_enumerable.litcoffee","new_file":"docs\/01_data_structures\/04_enumerable.litcoffee","new_contents":"# \/api\/Data Structures\/Batman.Enumerable\n\n`Batman.Enumerable` is a mixin that defines methods available for every\nenumerable type (`Batman.Set` and `Batman.Hash` being the main two).\n\nNote that where the signature of the callback functions is defined, `element`\nis the value of the current element being iterated over, and `value` is\n`null`\u2014except in the case of `Batman.Hash` where `element` is the key and\n`value` is the value.\n\n## Implementing your own `Batman.Enumerable`\n\nTo make these methods available for a new type, all you need to do is define\n`forEach()` and `length`. Then, in your type, you can just `Batman.extend\n@prototype, Batman.Enumerable` to copy the `Enumerable` methods onto your\nprototype.\n\n## ::.length : number\n\nThe number of elements.\n\n## ::forEach(func)\n\nCalls `func` once for each element.\n`func` receives the arguments `(element, value, this)`\n\n    test \"forEach runs n times\", ->\n      set = new Batman.Set(['a', 'b'])\n      count = 0\n      set.forEach -> count++\n      equal count, 2\n\n## ::map(func[, context = Batman.container]) : Array\n\nCalls `func` once for each element, and returns an array composed of the return\nvalue at each iteration.  `func` receives the arguments `(element, value,\nthis)`\n\n    test \"forEach runs n times\", ->\n      set = new Batman.Set([1, 2])\n      deepEqual [2, 3], set.map (x) -> x + 1\n\n## ::mapToProperty(key : string) : Array\n\nReturns an array composed of the property specified of each item.\n`func` receives the arguments `(element, value, this)`\n\n    test \"mapToProperty pulls out the property specified\", ->\n      set = new Batman.Set([{key: 'a'}, {key: 'b'}])\n      deepEqual ['a', 'b'], set.mapToProperty('key')\n\n## ::every(func[, context = Batman.container]) : boolean\n\nCalls `func` once for each element, and returns true if `func` returns true for\nevery iteration.  `func` receives the arguments `(element, value, this)`\n\n    test \"every is false when any element doesn't satisfy the selector function\", ->\n      set = new Batman.Set([true, false, true])\n      equal false, set.every (x) -> x\n\n## ::some(func[, context = Batman.container]) : boolean\n\nCalls `func` once for each element, and returns true if `func` returns true for\nany iteration.  `func` receives the arguments `(element, value, this)`\n\n    test \"some is true when any element satisfies the selector function\", ->\n      set = new Batman.Set([true, false, true])\n      equal true, set.some (x) -> x\n\n\n## ::reduce(func[, accumulator]) : Array\n\nCalls `func` once for each element, accumulating the result as it goes along.\nIf you pass your own `accumulator` it will retain its initial value, otherwise\nthe first element will become the initial accumulator value.  `func` receives\nthe arguments `(accumulator, element, value, index, this)`\n\n    test \"reduce can implement a sum\", ->\n      set = new Batman.Set([1, 2, 3])\n      equal 6, set.reduce (accumulator, x) -> accumulator + x\n\n\n## ::filter(func) : Object\n\nCreates a new instance of the current type, and adds every element for which\n`func` returns true.  `func` receives the arguments `(element, value, this)`\n\n    test \"filter strips out the crud\", ->\n      set = new Batman.Set(['wheat', 'crud', 'grain'])\n      deepEqual ['wheat', 'grain'], (set.filter (x) -> x != 'crud').toArray()\n\n## ::find(func, ctx[=Batman.container])\n\nReturns the first element of the `Enumerable` where `func` is true. `func` is called on `ctx` with `(element, value, this)`.\n\n    test \"find gets the first match\", ->\n      hash = new Batman.Hash(wheat: true, crud: false, grain: false)\n      foundKey = hash.find (key, value) -> !value\n      equal foundKey, \"crud\", \"the found item is returned\"\n\n## ::count(func) : number\n\nReturns the number of elements for which `func` returns true, or the total\nnumber of elements if you don't pass a `func`.  `func` receives the arguments\n`(element, value, this)`\n\n    test \"count counts\", ->\n      set = new Batman.Set([1, 2, 3])\n      equal 3, set.count()\n      equal 2, set.count (x) -> x > 1\n\n## ::inGroupsOf(groupSize: number) : Array\n\nSplits the enumerable into groups of up to `groupSize` and returns the items in an array of arrays.\n\n  test \"inGroupsOf returns an array of arrays\", ->\n    set = new Batman.Set(1,2,3,4,5,6,7,8)\n    groups = set.inGroupsOf(3)\n    equal 3, groups[0].length\n    equal 3, groups[1].length\n    equal 2, groups[2].length, \"The last group might be smaller\"\n","old_contents":"# \/api\/Data Structures\/Batman.Enumerable\n\n`Batman.Enumerable` is a mixin that defines methods available for every\nenumerable type (`Batman.Set` and `Batman.Hash` being the main two).\n\nNote that where the signature of the callback functions is defined, `element`\nis the value of the current element being iterated over, and `value` is\n`null`\u2014except in the case of `Batman.Hash` where `element` is the key and\n`value` is the value.\n\n## Implementing your own `Batman.Enumerable`\n\nTo make these methods available for a new type, all you need to do is define\n`forEach()` and `length`. Then, in your type, you can just `Batman.extend\n@prototype, Batman.Enumerable` to copy the `Enumerable` methods onto your\nprototype.\n\n## ::.length : number\n\nThe number of elements.\n\n## ::forEach(func)\n\nCalls `func` once for each element.\n`func` receives the arguments `(element, value, this)`\n\n    test \"forEach runs n times\", ->\n      set = new Batman.Set(['a', 'b'])\n      count = 0\n      set.forEach -> count++\n      equal count, 2\n\n## ::map(func[, context = Batman.container]) : Array\n\nCalls `func` once for each element, and returns an array composed of the return\nvalue at each iteration.  `func` receives the arguments `(element, value,\nthis)`\n\n    test \"forEach runs n times\", ->\n      set = new Batman.Set([1, 2])\n      deepEqual [2, 3], set.map (x) -> x + 1\n\n## ::mapToProperty(key : string) : Array\n\nReturns an array composed of the property specified of each item.\n`func` receives the arguments `(element, value, this)`\n\n    test \"mapToProperty pulls out the property specified\", ->\n      set = new Batman.Set([{key: 'a'}, {key: 'b'}])\n      deepEqual ['a', 'b'], set.mapToProperty('key')\n\n## ::every(func[, context = Batman.container]) : boolean\n\nCalls `func` once for each element, and returns true if `func` returns true for\nevery iteration.  `func` receives the arguments `(element, value, this)`\n\n    test \"every is false when any element doesn't satisfy the selector function\", ->\n      set = new Batman.Set([true, false, true])\n      equal false, set.every (x) -> x\n\n## ::some(func[, context = Batman.container]) : boolean\n\nCalls `func` once for each element, and returns true if `func` returns true for\nany iteration.  `func` receives the arguments `(element, value, this)`\n\n    test \"some is true when any element satisfies the selector function\", ->\n      set = new Batman.Set([true, false, true])\n      equal true, set.some (x) -> x\n\n\n## ::reduce(func[, accumulator]) : Array\n\nCalls `func` once for each element, accumulating the result as it goes along.\nIf you pass your own `accumulator` it will retain its initial value, otherwise\nthe first element will become the initial accumulator value.  `func` receives\nthe arguments `(accumulator, element, value, index, this)`\n\n    test \"reduce can implement a sum\", ->\n      set = new Batman.Set([1, 2, 3])\n      equal 6, set.reduce (accumulator, x) -> accumulator + x\n\n\n## ::filter(func) : Object\n\nCreates a new instance of the current type, and adds every element for which\n`func` returns true.  `func` receives the arguments `(element, value, this)`\n\n    test \"filter strips out the crud\", ->\n      set = new Batman.Set(['wheat', 'crud', 'grain'])\n      deepEqual ['wheat', 'grain'], (set.filter (x) -> x != 'crud').toArray()\n\n## ::find(func, ctx[=Batman.container])\n\nReturns the first element of the `Enumberable` where `func` is true. `func` is called on `ctx` with `(element, value, this)`.\n\n    test \"find gets the first match\", ->\n      hash = new Batman.Hash(wheat: true, crud: false, grain: false)\n      foundKey = hash.find (key, value) -> !value\n      equal foundKey, \"crud\", \"the found item is returned\"\n\n## ::count(func) : number\n\nReturns the number of elements for which `func` returns true, or the total\nnumber of elements if you don't pass a `func`.  `func` receives the arguments\n`(element, value, this)`\n\n    test \"count counts\", ->\n      set = new Batman.Set([1, 2, 3])\n      equal 3, set.count()\n      equal 2, set.count (x) -> x > 1\n\n## ::inGroupsOf(groupSize: number) : Array\n\nSplits the enumerable into groups of up to `groupSize` and returns the items in an array of arrays.\n\n  test \"inGroupsOf returns an array of arrays\", ->\n    set = new Batman.Set(1,2,3,4,5,6,7,8)\n    groups = set.inGroupsOf(3)\n    equal 3, groups[0].length\n    equal 3, groups[1].length\n    equal 2, groups[2].length, \"The last group might be smaller\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3244149617aa1c53616ee857ec630e1d9d353058","subject":"webpack","message":"webpack\n","repos":"glebm\/gulp-webpack-react-bootstrap-sass-template,duereg\/tile-thinger,glebm\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,duereg\/tile-thinger","old_file":"webpack.config.litcoffee","new_file":"webpack.config.litcoffee","new_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc),\nand processes JS `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    path    = require('path')\n    webpack = require('webpack')\n    _       = require('lodash')\n\n## CSS configuration\n\nList of loader names for CSS files:\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?last 2 versions']\n\nStyle module loaders (used later):\n\n    styleLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\"sass?precision=10&outputStyle=expanded&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/, loaders: cssLoaders }\n    ]\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not `.js` files. Create plugin instance (used later):\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\nOverride style loaders to use `ExtractTextPlugin`:\n\n    styleLoaders = styleLoaders.map (e) ->\n      test: e.test\n      loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!'))\n\n## Configuration\n\n    module.exports =\n\nList of bundle entry points, i.e. packages to compile in the distribution. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n      entry:\n        main             : \".\/src\/scripts\/main.litcoffee\"\n        \"styles\"         : \".\/src\/styles\/styles.scss\"\n        \"vendor\/es5-shim\": \".\/bower_components\/es5-shim\/es5-shim.js\"\n        \"vendor\/es5-sham\": \".\/bower_components\/es5-shim\/es5-sham.js\"\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n\nOutput options:\n\n      output:\n        path         : path.join(__dirname, \"dist\", \"assets\")\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: ['bower_components', 'node_modules']\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleLoaders.concat [\n          { test: \/\\.gif$\/, loader: \"url?limit=10000&minetype=image\/gif\" }\n          { test: \/\\.jpg$\/, loader: \"url?limit=10000&minetype=image\/jpg\" }\n          { test: \/\\.png$\/, loader: \"url?limit=10000&minetype=image\/png\" }\n          { test: \/\\.js$\/, loader: \"jsx\" }\n          { test: \/\\.coffee$\/, loader: \"jsx!coffee\" }\n          { test: \/\\.litcoffee$\/, loader: \"jsx!coffee?literate\"}\n          # url-loader embeds DataUrls.\n          { test: \/\\.woff$\/, loader: \"url?limit=10000&minetype=application\/font-woff\" }\n          # file-loader emits files.\n          { test: \/\\.ttf$\/, loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n          { test: \/\\.eot$\/, loader: \"file?mimetype=application\/x-font-ttf\" }\n          { test: \/\\.svg$\/, loader: \"file?mimetype=image\/svg+xml\" }\n        ]\n        noParse: \/\\.min\\.js$\/\n\nDefine the plugins:\n\n      plugins: [\n\n`DefinePlugin` defines a variable that will be substituted in the assets (a la macro):\n\n        new webpack.DefinePlugin(__PRODUCTION__: JSON.stringify(false))\n\n`extractTextPlugin` (defined above) will compile CSS to a .css file, as opposed to inlining it as a string in a .js file.\n\n        extractTextPlugin\n      ]\n\n\n## Production\n\nExport a method that applies production settings (used in gulpfile):\n\n      useProductionSettings: ->\n\nProduction plugins:\n\n        plugins = @plugins.concat [\n\nMinify JavaScript with UglifyJS:\n\n          new webpack.optimize.UglifyJsPlugin()\n        ]\n\nSet `__PRODUCTION__` to true in DefinePlugin:\n\n        for plugin in plugins when plugin.definitions?.__PRODUCTION__\n          plugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\nTell `ExtractTextPlugin` to append hashes (BROKEN, see [plugin issue #9](https:\/\/github.com\/webpack\/extract-text-webpack-plugin\/issues\/9)):\n\n        for plugin in plugins when plugin.filename == '[name].css'\n          plugin.filename = '[name]-[hash].css'\n\nMerge in production config (deep merge):\n\n        _.merge @,\n\nDisable development settings:\n\n          debug: false\n          watch: false\n          devtool: null\n\nAdd content hashes to the output filenames:\n\n          output:\n            filename: \"[name]-[hash].js\"\n\nProduction-only plugins:\n\n          plugins: plugins\n","old_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc),\nand processes JS `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    path    = require('path')\n    webpack = require('webpack')\n    _       = require('lodash')\n\n## CSS configuration\n\nList of loader names for CSS files:\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?last 2 versions']\n\nStyle module loaders (used later):\n\n    styleLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\"sass?precision=10&outputStyle=expanded&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/, loaders: cssLoaders }\n    ]\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not `.js` files. Create plugin instance (used later):\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\nOverride style loaders to use `ExtractTextPlugin`:\n\n    styleLoaders = styleLoaders.map (e) ->\n      test: e.test\n      loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!'))\n\n## Configuration\n\n    module.exports =\n\nList of bundle entry points, i.e. packages to compile in the distribution. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n      entry:\n        main             : \".\/src\/scripts\/main.litcoffee\"\n        \"styles\"         : \".\/src\/styles\/styles.scss\"\n        \"vendor\/es5-shim\": \".\/bower_components\/es5-shim\/es5-shim.js\"\n        \"vendor\/es5-sham\": \".\/bower_components\/es5-shim\/es5-sham.js\"\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n\nOutput options:\n\n      output:\n        path         : path.join(__dirname, \"dist\", \"assets\")\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: ['bower_components', 'node_modules']\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleLoaders.concat [\n          { test: \/\\.gif$\/, loader: \"url?limit=10000&minetype=image\/gif\" }\n          { test: \/\\.jpg$\/, loader: \"url?limit=10000&minetype=image\/jpg\" }\n          { test: \/\\.png$\/, loader: \"url?limit=10000&minetype=image\/png\" }\n          { test: \/\\.js$\/, loader: \"jsx\" }\n          { test: \/\\.coffee$\/, loader: \"jsx!coffee\" }\n          { test: \/\\.litcoffee$\/, loader: \"jsx!coffee?literate\"}\n          # url-loader embeds DataUrls.\n          { test: \/\\.woff$\/, loader: \"url?limit=10000&minetype=application\/font-woff\" }\n          # file-loader emits files.\n          { test: \/\\.ttf$\/, loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n          { test: \/\\.eot$\/, loader: \"file?mimetype=application\/x-font-ttf\" }\n          { test: \/\\.svg$\/, loader: \"file?mimetype=image\/svg+xml\" }\n        ]\n        noParse: \/\\.min\\.js$\/\n\nDefine the plugins:\n\n      plugins: [\n\n`DefinePlugin` defines a variable that will be substituted in the assets (a la macro):\n\n        new webpack.DefinePlugin(__PRODUCTION__: JSON.stringify(false))\n\n`extractTextPlugin` (defined above) will compile CSS to a .css file, as opposed to inlining it as a string in a .js file.\n\n        extractTextPlugin\n      ]\n\n\n## Production\n\nExport a method that applies production settings (used in gulpfile):\n\n      useProductionSettings: ->\n\nProduction plugins:\n\n        plugins = @plugins.concat [\n\nMinify JavaScript with UglifyJS:\n\n          new webpack.optimize.UglifyJsPlugin()\n        ]\n\nSet `__PRODUCTION__` to true in DefinePlugin:\n\n        for plugin in plugins when plugin.definitions?.__PRODUCTION__\n          plugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\nTell `ExtractTextPlugin` to append hashes:\n\n        for plugin in plugins when plugin.filename == '[name].css'\n          plugin.filename = '[name]-[hash].css'\n\nMerge in production config (deep merge):\n\n        _.merge @,\n\nDisable development settings:\n\n          debug: false\n          watch: false\n          devtool: null\n\nAdd content hashes to the output filenames:\n\n          output:\n            filename: \"[name]-[hash].js\"\n\nProduction-only plugins:\n\n          plugins: plugins\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"acf3c705d26ffa975ebe933b29f638391d1b9a88","subject":"Added warning about unknown resource in Rectangle","message":"Added warning about unknown resource in Rectangle\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/renderer\/types\/shapes\/rectangle.litcoffee","new_file":"src\/renderer\/types\/shapes\/rectangle.litcoffee","new_contents":"# Rectangle\n\n```javascript\nRectangle {\n    width: 150\n    height: 100\n    color: 'blue'\n    border.color: 'black'\n    border.width: 5\n    radius: 10\n}\n```\n\n    'use strict'\n\n    assert = require 'src\/assert'\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    Resources = require 'src\/resources'\n\n    log = log.scope 'Renderer', 'Rectangle'\n\n    module.exports = (Renderer, Impl, itemUtils) ->\n\n        DEFAULT_COLOR = 'transparent'\n\n        getColor = do ->\n            RESOURCE_REQUEST =\n                property: 'color'\n            (val) ->\n                if Resources.testUri(val)\n                    if rscVal = Impl.resources?.resolve(val, RESOURCE_REQUEST)\n                        return rscVal\n                    else\n                        log.warn \"Unknown resource given '#{val}'\"\n                        return DEFAULT_COLOR\n                val\n\n        class Rectangle extends Renderer.Item\n            @__name__ = 'Rectangle'\n            @__path__ = 'Renderer.Rectangle'\n\n## *Rectangle* Rectangle.New([*Object* options])\n\n            @New = (opts) ->\n                item = new Rectangle\n                itemUtils.Object.initialize item, opts\n                item\n\n## *Rectangle* Rectangle::constructor() : *Item*\n\n            constructor: ->\n                super()\n                @_color = DEFAULT_COLOR\n                @_radius = 0\n                @_border = null\n\n## *String* Rectangle::color = `'transparent'`\n\n## *Signal* Rectangle::onColorChange(*String* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'color'\n                defaultValue: DEFAULT_COLOR\n                implementation: Impl.setRectangleColor\n                implementationValue: getColor\n                developmentSetter: (val) ->\n                    assert.isString val, \"Rectangle.color needs to be a string, but #{val} given\"\n\n## *Float* Rectangle::radius = `0`\n\n## *Signal* Rectangle::onRadiusChange(*Float* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'radius'\n                defaultValue: 0\n                implementation: Impl.setRectangleRadius\n                developmentSetter: (val) ->\n                    assert.isFloat val, \"Rectangle.radius needs to be a float, but #{val} given\"\n\n## *Object* Rectangle::border\n\n## *Signal* Rectangle::onBorderChange(*String* property, *Any* oldValue)\n\n        class Border extends itemUtils.DeepObject\n            @__name__ = 'Border'\n\n            itemUtils.defineProperty\n                constructor: Rectangle\n                name: 'border'\n                valueConstructor: Border\n                developmentSetter: (val) ->\n                    assert.isObject val\n                setter: (_super) -> (val) ->\n                    {border} = @\n                    border.width = val.width if val.width?\n                    border.color = val.color if val.color?\n                    _super.call @, val\n                    return\n\n            constructor: (ref) ->\n                @_width = 0\n                @_color = DEFAULT_COLOR\n                super ref\n\n## *Float* Rectangle::border.width = `0`\n\n## *Signal* Rectangle::border.onWidthChange(*Float* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'width'\n                defaultValue: 0\n                namespace: 'border'\n                parentConstructor: Rectangle\n                implementation: Impl.setRectangleBorderWidth\n                developmentSetter: (val) ->\n                    assert.isFloat val, \"\"\"\n                        Rectangle.border.width needs to be a float, but #{val} given\n                    \"\"\"\n\n## *String* Rectangle::border.color = `'transparent'`\n\n## *Signal* Rectangle::border.onColorChange(*String* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'color'\n                defaultValue: DEFAULT_COLOR\n                namespace: 'border'\n                parentConstructor: Rectangle\n                implementation: Impl.setRectangleBorderColor\n                implementationValue: getColor\n                developmentSetter: (val) ->\n                    assert.isString val, \"\"\"\n                        Rectangle.border.color needs to be a string, but #{val} given\n                    \"\"\"\n\n            toJSON: ->\n                width: @width\n                color: @color\n\n        Rectangle\n","old_contents":"# Rectangle\n\n```javascript\nRectangle {\n    width: 150\n    height: 100\n    color: 'blue'\n    border.color: 'black'\n    border.width: 5\n    radius: 10\n}\n```\n\n    'use strict'\n\n    assert = require 'src\/assert'\n    utils = require 'src\/utils'\n\n    module.exports = (Renderer, Impl, itemUtils) ->\n\n        class Rectangle extends Renderer.Item\n            @__name__ = 'Rectangle'\n            @__path__ = 'Renderer.Rectangle'\n\n## *Rectangle* Rectangle.New([*Object* options])\n\n            @New = (opts) ->\n                item = new Rectangle\n                itemUtils.Object.initialize item, opts\n                item\n\n## *Rectangle* Rectangle::constructor() : *Item*\n\n            constructor: ->\n                super()\n                @_color = 'transparent'\n                @_radius = 0\n                @_border = null\n\n## *String* Rectangle::color = `'transparent'`\n\n## *Signal* Rectangle::onColorChange(*String* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'color'\n                defaultValue: 'transparent'\n                implementation: Impl.setRectangleColor\n                implementationValue: do ->\n                    RESOURCE_REQUEST =\n                        property: 'color'\n                    (val) ->\n                        Impl.resources?.resolve(val, RESOURCE_REQUEST) or val\n                developmentSetter: (val) ->\n                    assert.isString val, \"Rectangle.color needs to be a string, but #{val} given\"\n\n## *Float* Rectangle::radius = `0`\n\n## *Signal* Rectangle::onRadiusChange(*Float* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'radius'\n                defaultValue: 0\n                implementation: Impl.setRectangleRadius\n                developmentSetter: (val) ->\n                    assert.isFloat val, \"Rectangle.radius needs to be a float, but #{val} given\"\n\n## *Object* Rectangle::border\n\n## *Signal* Rectangle::onBorderChange(*String* property, *Any* oldValue)\n\n        class Border extends itemUtils.DeepObject\n            @__name__ = 'Border'\n\n            itemUtils.defineProperty\n                constructor: Rectangle\n                name: 'border'\n                valueConstructor: Border\n                developmentSetter: (val) ->\n                    assert.isObject val\n                setter: (_super) -> (val) ->\n                    {border} = @\n                    border.width = val.width if val.width?\n                    border.color = val.color if val.color?\n                    _super.call @, val\n                    return\n\n            constructor: (ref) ->\n                @_width = 0\n                @_color = 'transparent'\n                super ref\n\n## *Float* Rectangle::border.width = `0`\n\n## *Signal* Rectangle::border.onWidthChange(*Float* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'width'\n                defaultValue: 0\n                namespace: 'border'\n                parentConstructor: Rectangle\n                implementation: Impl.setRectangleBorderWidth\n                developmentSetter: (val) ->\n                    assert.isFloat val, \"\"\"\n                        Rectangle.border.width needs to be a float, but #{val} given\n                    \"\"\"\n\n## *String* Rectangle::border.color = `'transparent'`\n\n## *Signal* Rectangle::border.onColorChange(*String* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'color'\n                defaultValue: 'transparent'\n                namespace: 'border'\n                parentConstructor: Rectangle\n                implementation: Impl.setRectangleBorderColor\n                implementationValue: do ->\n                    RESOURCE_REQUEST =\n                        property: 'color'\n                    (val) ->\n                        Impl.resources?.resolve(val, RESOURCE_REQUEST) or val\n                developmentSetter: (val) ->\n                    assert.isString val, \"\"\"\n                        Rectangle.border.color needs to be a string, but #{val} given\n                    \"\"\"\n\n            toJSON: ->\n                width: @width\n                color: @color\n\n        Rectangle\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"cf7ab25bbba12d21d4891c362a462e2f72769239","subject":"Add interactive shell functions","message":"Add interactive shell functions\n","repos":"mnmtanish\/vosco-cli","old_file":"shell.litcoffee","new_file":"shell.litcoffee","new_contents":"Dependencies\n============\n\n    _        = require \"underscore\"\n    inquirer = require \"inquirer\"\n    colors   = require \"cli-color\"\n\nShell\n=====\n\n    shell = {}\n\n    shell.init = () ->\n      log \"looking for VOSCO repository at (#{@vosco.path})\"\n      await @vosco.isInstalled defer(error, isInstalled)\n      if isInstalled\n        log \"found VOSCO repository\"\n        @welcome()\n      else\n        log \"could not find VOSCO repository\"\n        @install()\n\n    shell.welcome = () ->\n      message = \"Choose a Category\"\n      choices = [\"repository\", \"snapshots\", \"branches\"]\n      await choose message, choices, defer(category)\n      shell[category]()\n\n    shell.install = () ->\n      message = \"Do you want to install VOSCO\"\n      await confirm message, defer(doInstall)\n      unless doInstall then process.exit 1\n      await @vosco.isInstalled defer(error, isInstalled)\n      if isInstalled then process.exit 1\n      await @vosco.install defer(error)\n      @welcome()\n\n    shell.repository = () ->\n      message = \"Choose a Task\"\n      choices = [\"status\", \"history\", \"content history\", \"uninstall\"]\n      await choose message, choices, defer(task)\n      switch task\n        when \"status\"\n          await @vosco.isInstalled defer(error, isInstalled)\n          unless isInstalled then process.exit 1\n          await @vosco.getStatus defer(error, status)\n          getType = (file) -> file.type\n          getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n          groups  = _.groupBy status, getType\n          for group, paths of groups\n            console.log \"\"\"\n            #{group}\n            #{paths.map(getPath).join(\"\\n\")}\n            \"\"\"\n        when \"history\"\n          await @vosco.isInstalled defer(error, isInstalled)\n          unless isInstalled then process.exit 1\n          await @vosco.getHistory defer(error, history)\n          for commit in history\n            hash = commit.hash.substr(0, 7)\n            date = new Date(commit.date).toDateString()\n            msg  = commit.message\n            console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n        when \"content history\"\n          await @vosco.isInstalled defer(error, isInstalled)\n          unless isInstalled then process.exit 1\n          # show warning if file doesn\"t exist\n          console.log \"content history\"\n        when \"uninstall\"\n          await @vosco.isInstalled defer(error, isInstalled)\n          unless isInstalled then process.exit 1\n          await @vosco.uninstall defer(error)\n          process.exit 0\n      @welcome()\n\n    shell.snapshots = () ->\n      message = \"Choose a Task\"\n      choices = [\"preview\", \"create\", \"rollback\"]\n      await choose message, choices, defer(task)\n      switch task\n        when \"preview\"\n          await @vosco.isInstalled defer(error, isInstalled)\n          unless isInstalled then process.exit 1\n          hash = hash or 'HEAD'\n          await @vosco.previewSnapshot hash, defer(error, diff)\n          console.log diff\n        when \"create\"\n          await @vosco.isInstalled defer(error, isInstalled)\n          unless isInstalled then process.exit 1\n          message = message or 'Untitled Snapshot'\n          await @vosco.createSnapshot message, defer(error)\n        when \"rollback\"\n          await @vosco.isInstalled defer(error, isInstalled)\n          unless isInstalled then process.exit 1\n          await @vosco.rollbackToSnapshot hash, defer(error)\n      @welcome()\n\n    shell.branches = () ->\n      message = \"Choose a Task\"\n      choices = [\"list\", \"create\", \"select\", \"delete\"]\n      await choose message, choices, defer(task)\n      switch task\n        when \"list\"\n          await @vosco.isInstalled defer(error, isInstalled)\n          unless isInstalled then process.exit 1\n          await @vosco.getBranches defer(error, branches, current)\n          for branch in branches\n            branch = if branch is current then \"* #{branch}\" else\n              colors.xterm(240)(\"  #{branch}\")\n            console.log \"#{branch}\"\n        when \"create\"\n          await @vosco.isInstalled defer(error, isInstalled)\n          unless isInstalled then process.exit 1\n          await @vosco.createBranch branch, defer(error)\n        when \"select\"\n          await @vosco.isInstalled defer(error, isInstalled)\n          unless isInstalled then process.exit 1\n          await @vosco.selectBranch branch, defer(error)\n        when \"delete\"\n          await @vosco.isInstalled defer(error, isInstalled)\n          unless isInstalled then process.exit 1\n          await @vosco.deleteBranch branch, defer(error)\n      @welcome()\n\nHelpers\n-------\n\n    choose = (msg, choices, callback) ->\n      choices.push new inquirer.Separator()\n      choices.push \"exit\"\n      question = {type: \"list\", name: \"answer\", message: msg, choices: choices}\n      await inquirer.prompt question, defer(data)\n      if data.answer is \"exit\" then process.exit 0\n      callback data.answer\n\n    confirm = (msg, callback) ->\n      question = {type: \"confirm\", name: \"answer\", message: msg}\n      await inquirer.prompt question, defer(data)\n      callback data.answer\n\n    echo = (message) ->\n      console.log \"#{message}\"\n\n    log = (message) ->\n      console.log colors.xterm(238)(\"- #{message}\")\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      shell.vosco = vosco\n      return shell\n","old_contents":"Dependencies\n============\n\n    inquirer = require \"inquirer\"\n    colors   = require \"cli-color\"\n\nShell\n=====\n\n    shell = {}\n\n    shell.exit = (status) ->\n      log \"bye\"\n      process.exit status || 0\n\n    shell.init = () ->\n      log \"looking for VOSCO repository at (#{@vosco.path})\"\n      await @vosco.isInstalled defer(error, isInstalled)\n      if isInstalled\n        log \"found VOSCO repository\"\n        @welcome()\n      else\n        log \"could not find VOSCO repository\"\n        @install()\n\n    shell.welcome = () ->\n      log \"WELCOME\"\n\n    shell.install = () ->\n      message = \"Do you want to install VOSCO\"\n      await confirm message, defer(doInstall)\n      unless doInstall then @exit()\n      await @vosco.install defer(error)\n      @welcome()\n\nHelpers\n-------\n\n    confirm = (msg, callback) ->\n      question = {type: \"confirm\", name: \"answer\", message: msg}\n      await inquirer.prompt question, defer(data)\n      callback data.answer\n\n    log = (message) ->\n      console.log colors.xterm(238)(\"- #{message}\")\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      shell.vosco = vosco\n      return shell\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2af048de33d4993a1ff3c0a7f3bf2f7c947ff431","subject":"fixed async getValue behavior","message":"fixed async getValue behavior\n","repos":"lacona\/lacona,laconalabs\/elliptical","old_file":"src\/placeholder.litcoffee","new_file":"src\/placeholder.litcoffee","new_contents":"#Includes\n\n\t_ = require 'lodash'\n\tasync = require 'async'\n\t\n\tElement = require '.\/element'\n\tInputOption = require '.\/input-option'\n\n#Placeholder\n\n\tclass Placeholder extends Element\n\t\tconstructor: (options, scope, @phraseAccessor) ->\n\t\t\tsuper options\n\t\t\t{@type} = options\n\t\t\t@options = _.omit(options, 'type')\n\t\t\t@options.$call = (func, args...) =>\n\t\t\t\tscope[func].apply(@options, args)\n\n\t\thandleParse: (input, lang, context, data, done) ->\n\t\t\toldResult = _.cloneDeep(input.result)\n\n\t\t\tphrases = @phraseAccessor(@type)\n\n\t\t\tasync.each phrases, (phrase, done) =>\n\t\t\t\tcurrentlyInData = 0\n\t\t\t\tdoneCalled = false\n\t\t\t\tphrase.parse input, lang, @options, (option) =>\n\t\t\t\t\tcurrentlyInData++\n\t\t\t\t\tphrase.getValue @options, option.result, (err, value) =>\n\t\t\t\t\t\tnewOption = option.replaceResult(oldResult)\n\t\t\t\t\t\tnewOption = newOption.handleValue(@id, value)\n\n\t\t\t\t\t\tdata(newOption)\n\t\t\t\t\t\tcurrentlyInData--\n\t\t\t\t\t\tif currentlyInData is 0 and doneCalled\n\t\t\t\t\t\t\tdone()\n\n\t\t\t\t, (err) ->\n\t\t\t\t\tif err?\n\t\t\t\t\t\tdone(err)\n\t\t\t\t\telse if currentlyInData is 0\n\t\t\t\t\t\tdone()\n\t\t\t\t\telse\n\t\t\t\t\t\tdoneCalled = true\n\t\t\t, done\n\n\tmodule.exports = Placeholder","old_contents":"#Includes\n\n\t_ = require 'lodash'\n\tasync = require 'async'\n\t\n\tElement = require '.\/element'\n\tInputOption = require '.\/input-option'\n\n#Placeholder\n\n\tclass Placeholder extends Element\n\t\tconstructor: (options, scope, @phraseAccessor) ->\n\t\t\tsuper options\n\t\t\t{@type} = options\n\t\t\t@options = _.omit(options, 'type')\n\t\t\t@options.$call = (func, args...) =>\n\t\t\t\tscope[func].apply(@options, args)\n\n\t\thandleParse: (input, lang, context, data, done) ->\n\t\t\toldResult = _.cloneDeep(input.result)\n\n\t\t\tphrases = @phraseAccessor(@type)\n\n\t\t\tasync.each phrases, (phrase, done) =>\n\t\t\t\tphrase.parse input, lang, @options, (option) =>\n\t\t\t\t\tphrase.getValue @options, option.result, (err, value) =>\n\t\t\t\t\t\tnewOption = option.replaceResult(oldResult)\n\t\t\t\t\t\tnewOption = newOption.handleValue(@id, value)\n\n\t\t\t\t\t\tdata(newOption)\n\t\t\t\t, done\n\t\t\t, done\n\n\tmodule.exports = Placeholder","returncode":0,"stderr":"","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"009589eea734ed3dc732733a5375db9d4d16efc1","subject":"Add comment to top of file","message":"Add comment to top of file\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/cache.litcoffee","new_file":"coffee\/cache.litcoffee","new_contents":"We only use strict JavaScript in this shop.\n\n    \"use strict\"\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### ToDo\n\n* Handle undefined values.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      ObjectID = require('mongodb').ObjectID\n      require('.\/db\/mongo')[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      require('.\/db\/redis').hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      require('.\/db\/redis').hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      set       : set\n      get       : get\n      getDoc    : getDoc\n      setForType: setForType\n      getFilter : getFilter\n      filterData: filterData\n      getForType: getForType\n\n","old_contents":"    \"use strict\"\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### ToDo\n\n* Handle undefined values.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      ObjectID = require('mongodb').ObjectID\n      require('.\/db\/mongo')[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      require('.\/db\/redis').hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      require('.\/db\/redis').hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      set       : set\n      get       : get\n      getDoc    : getDoc\n      setForType: setForType\n      getFilter : getFilter\n      filterData: filterData\n      getForType: getForType\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5b04f6aa3c7cc564515b3b0859f9ddefed6f2edf","subject":"specify joins params","message":"specify joins params\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-route-params\n\nAdds the provided keypath or literal value to the route provided to `data-route`. For example:\n\n```html\n<a data-route='routes.villians.new' data-route-params='\"mastermind=true\"'>Mastermind<\/a>\n```\n\nwill route to `\/villians\/new?mastermind=true` and\n\n```\n<a data-route='routes.villians.new' data-route-params='otherRouteParams'>Other<\/a>\n```\n\nwill look up `otherRouteParams` and append it to `\/villains\/new`, adding a `?` if necessary.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","old_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-route-params\n\nAdds the provided keypath or literal value to the route provided to `data-route`. For example:\n\n```html\n<a data-route='routes.villians.new' data-route-params='\"mastermind=true\"'>Mastermind<\/a>\n```\n\nwill route to `\/villians\/new?mastermind=true` and\n\n```\n<a data-route='routes.villians.new' data-route-params='otherRouteParams'>Other<\/a>\n```\n\nwill look up `otherRouteParams` and append it to `\/villains\/new`.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"06d509a4fd0d022234fec6e4db47f48f9e404f5e","subject":"update @option example to use a keypath and a literal","message":"update @option example to use a keypath and a literal\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/13_view.litcoffee","new_file":"docs\/13_view.litcoffee","new_contents":"# \/api\/App Components\/Batman.View\n\n`Batman.View`s connect a batman.js app to the DOM. This includes rendering HTML, handling DOM events, and maintaining view bindings. `Batman.View` extends `Batman.Object`. When subclassing `Batman.View`, you can create reusable UI components by defining attributes of the new view:\n\n- [`::source`](\/docs\/api\/batman.view.html#prototype_accessor_source) or [`::html`](\/docs\/api\/batman.view.html#prototype_accessor_html) define the view's HTML.\n- [`@option`](\/docs\/api\/batman.view.html#class_function_option) adds context-based initialization options.\n- [`@filter`](\/docs\/api\/batman.view.html#class_function_filter) adds custom view filters.\n- [Lifecycle hooks](\/docs\/views.html) fire when the view is loaded, rendered, or destroyed.\n\nFor more information about views, see [the guide](\/docs\/views.html).\n\n## Accessors and Event Handlers\n\n[View bindings](\/docs\/api\/batman.view_bindings.html) have access to the views they're rendered by, so custom views are a great place to define view-specific accessors and event handlers. Then, you can connect them to your HTML with view bindings. For example, define a view:\n\n```coffeescript\nclass CoffeeView extends Batman.View\n  @accessor 'coffeeOfTheDay', -> \"Guatemalan\"\n  drinkCoffee: -> alert(\"Yum!!\")\n```\n\nthen apply it to some HTML:\n\n```html\n<div data-view='CoffeeView'>\n  <span data-bind='coffeeOfTheDay'><\/span>\n  <button data-event-click='drinkCoffee'> Take a sip! <\/button>\n<div>\n```\n\nData bindings look for keys on their closest views first, so these bindings will be handled by `CoffeeView`.\n\n## ::constructor(options = {}) : Batman.View\n\nReturns a new `Batman.View`. Since `Batman.View` extends `Batman.Object`, all `options` are mixed in to the new instance. Use this to override `html`, `node`, `superview`, `parentNode`, and\/or your custom data.\n\n## ::lookupKeypath(keypath : String)\n\nTraverses up the view tree searching for `keypath` and returns the first\nresult or `undefined` if no match is found. The path it takes is:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\n    test 'lookupKeypath returns the value if defined on the view or on an ancestor', ->\n      superview = new Batman.View(cat: 'Meowie')\n      subview = new Batman.View(superview: superview, dog: 'Fido')\n      equal 'Fido', subview.lookupKeypath('dog'), \"finds an accessor on itself\"\n      equal 'Meowie', subview.lookupKeypath('cat'), \"finds an accessor on its superview\"\n      equal undefined, subview.lookupKeypath('bogusKeypath'), \"returns undefined if the keypath isn't defined\"\n\nIf used in an accessor, `keypath` is registered as source and will be correctly bound. `lookupKeypath` is used by [view bindings](\/docs\/api\/batman.view_bindings.html) to get data.\n\n## ::setKeypath(keypath, value)\n\nTraverses the view tree searching for the specified keypath and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is used by [view bindings](\/docs\/api\/batman.view_bindings.html) to set data.\n\n    test 'setKeypath sets the value if defined on the view or on an ancestor', ->\n      superview = new Batman.View(cat: 'Meowie')\n      subview = new Batman.View(superview: superview, dog: 'Fido')\n      subview.setKeypath('cat', 'Mittens')\n      equal 'Mittens', superview.get('cat'), \"updates an accessor on its superview\"\n      subview.setKeypath('dog', 'Lassie')\n      equal 'Lassie', subview.get('dog'), \"updates an accessor on itself\"\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n## ::%node : Node\n\nReturns the DOM node that this view encapsulates.\n\nAccessing `node` will load and parse the template if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\nYou can also access a view's `node` in its methods, for example, activating jQuery plugins:\n\n```\nclass App.SearchBarView extends Batman.View\n  viewDidAppear: ->\n    $node = $(@get('node'))\n    $node.typeahead() # <= whatever jQuery plugin you want!\n```\n## ::%source : String\n\nThis string will be used to fetch a view's HTML, relative to [`Batman.config.pathToHTML`](\/docs\/configuration.html).\nYou don't need to add `.html` to this string -- it will be added automatically.\n\nInside a controller action, batman.js provides a default source based on the\ncontoller's [`routingKey`](\/docs\/api\/batman.controller.html#routingkey_and_minification) and the [controller action](\/docs\/api\/batman.controller.html#actions).\n\nYou can set `source` in the class definition:\n\n```\nclass App.HeaderNavigationView extends Batman.View\n  source: 'layout\/_header'\n```\n\nOr when calling `@render()` inside a controller action:\n\n```\nclass App.PostsController extends Batman.Controller\n  show: ->\n    @set('post', new App.Post)\n    if @get('post.isAlternative')\n      @render(source: \"posts\/alternative_new\")\n    else\n      @render() # defaults to 'posts\/new'\n```\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview. You can specify a view's HTML when you define the class:\n\n```\nclass App.SearchBarView extends Batman.View\n  html: \"<input type='text' placeholder='Enter a search term' \/>\"\n```\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n    test 'setting a source loads the correct template', ->\n      Batman.View.store.set('\/animals', '<div>cat<\/div>')\n      view = new Batman.View(source: '\/animals')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n## @filter(label : string, filter : function)\n\nDefines a custom [view filter](\/docs\/api\/batman.view_filters.html) for use within the `View`.\n\n`filter` will be invoked with the pre-filter `value` and any arguments passed to the view filter. For example:\n\n```coffeescript\nclass App.MultiplierView extends Batman.View\n  @filter 'multiplyBy', (value, multiplier) -> value * multiplier\n```\n\nwould handle:\n\n```html\n<div data-view='MultiplierView' data-context-amount='100'>\n  <span data-bind='amount | multiplyBy 6'>\n    <!-- would render to \"600\" -->\n  <\/span>\n<\/div>\n```\n\n_Note_: If the `View`'s HTML is loaded before the view is instantiated, this filter won't have been defined yet and batman.js will throw an error. Avoid this by defining your custom filter at app-level or by defining the `View`'s HTML with [`::source`](\/docs\/api\/batman.view.html#prototype_accessor_source) or [`::html`](\/docs\/api\/batman.view.html#prototype_accessor_html).\n\n## @option(keys...)\n\nDefines a custom option for the `View`. `@option` allows you to initialize your view with data from its context. For example, you can define some options:\n\n```coffeescript\nclass App.MultiplierView extends Batman.View\n  @option 'amount', 'multiplier'\n  @accessor 'finalAmount', -> @get('amount') * @get('multiplier')\n```\n\nthen pass in keypaths or [keypath literals](\/docs\/api\/batman.view_bindings.html#keypath_literals):\n\n```html\n<div data-context-ten='10'> <!-- sets 10 on keypath \"ten\" -->\n  <div data-view='MultiplierView' data-view-amount='ten' data-view-multiplier='8'>\n    <span data-bind='finalAmount'>\n      <!-- would render to 80 !-->\n    <\/span>\n  <\/div>\n<\/div>\n```\n\n## ::.superview : Batman.View\n\nReturns the view's superview. Every view except an app's `LayoutView` has a superview.\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of this `View`. Since it's a [`Batman.Set`](\/docs\/api\/batman.set.html), you can operate directly on this set and batman.js will automatically keep the DOM in sync.\n\nAdding to a view's subviews will automatically update the tree and parse\nthe template and bindings. If the superview is in the DOM, this will\ninsert the current view's node into the DOM.\n\n    test 'adding to a superview parses bindings', ->\n      superview = new Batman.View()\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      superview.subviews.add(view)\n      equal 'cat', view.get('node').firstChild.innerHTML\n\nRemoving from a view's subviews will automatically remove the subview from\nthe DOM.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View(html: '', parentNode: document.body)\n      superview.get('node')\n      view = new Batman.View(html: '', superview: superview)\n\n      ok Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n      superview.subviews.remove(view)\n      ok not Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent (and from the DOM), without killing it.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.removeFromSuperview()\n      ok not superview.subviews.has(view)\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n      test 'die kills the view', ->\n        superview = new Batman.View()\n        view = new Batman.View(superview: superview)\n\n        view.die()\n        equal true, view.isDead\n        equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n    test 'destroySubviews kills all subviews', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: superview)\n\n      superview.destroySubviews()\n      ok one.isDead\n      ok two.isDead\n\n\n## ::propagateToSubviews(eventOrKey : string, value : Object)\n\nIf `value` is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n    test 'propagateToSubviews propagates events', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.on 'eventName', superSpy = createSpy()\n      one.on 'eventName', oneSpy = createSpy()\n      two.on 'eventName', twoSpy = createSpy()\n\n      superview.propagateToSubviews('eventName')\n\n      equal 1, superSpy.callCount\n      equal 1, oneSpy.callCount\n      equal 1, twoSpy.callCount\n\n    test 'propagateToSubviews propagates keys', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.propagateToSubviews('key', 'value')\n\n      equal superview.get('key'), 'value'\n      equal one.get('key'), 'value'\n      equal two.get('key'), 'value'\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n","old_contents":"# \/api\/App Components\/Batman.View\n\n`Batman.View`s connect a batman.js app to the DOM. This includes rendering HTML, handling DOM events, and maintaining view bindings. `Batman.View` extends `Batman.Object`. When subclassing `Batman.View`, you can create reusable UI components by defining attributes of the new view:\n\n- [`::source`](\/docs\/api\/batman.view.html#prototype_accessor_source) or [`::html`](\/docs\/api\/batman.view.html#prototype_accessor_html) define the view's HTML.\n- [`@option`](\/docs\/api\/batman.view.html#class_function_option) adds context-based initialization options.\n- [`@filter`](\/docs\/api\/batman.view.html#class_function_filter) adds custom view filters.\n- [Lifecycle hooks](\/docs\/views.html) fire when the view is loaded, rendered, or destroyed.\n\nFor more information about views, see [the guide](\/docs\/views.html).\n\n## Accessors and Event Handlers\n\n[View bindings](\/docs\/api\/batman.view_bindings.html) have access to the views they're rendered by, so custom views are a great place to define view-specific accessors and event handlers. Then, you can connect them to your HTML with view bindings. For example, define a view:\n\n```coffeescript\nclass CoffeeView extends Batman.View\n  @accessor 'coffeeOfTheDay', -> \"Guatemalan\"\n  drinkCoffee: -> alert(\"Yum!!\")\n```\n\nthen apply it to some HTML:\n\n```html\n<div data-view='CoffeeView'>\n  <span data-bind='coffeeOfTheDay'><\/span>\n  <button data-event-click='drinkCoffee'> Take a sip! <\/button>\n<div>\n```\n\nData bindings look for keys on their closest views first, so these bindings will be handled by `CoffeeView`.\n\n## ::constructor(options = {}) : Batman.View\n\nReturns a new `Batman.View`. Since `Batman.View` extends `Batman.Object`, all `options` are mixed in to the new instance. Use this to override `html`, `node`, `superview`, `parentNode`, and\/or your custom data.\n\n## ::lookupKeypath(keypath : String)\n\nTraverses up the view tree searching for `keypath` and returns the first\nresult or `undefined` if no match is found. The path it takes is:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\n    test 'lookupKeypath returns the value if defined on the view or on an ancestor', ->\n      superview = new Batman.View(cat: 'Meowie')\n      subview = new Batman.View(superview: superview, dog: 'Fido')\n      equal 'Fido', subview.lookupKeypath('dog'), \"finds an accessor on itself\"\n      equal 'Meowie', subview.lookupKeypath('cat'), \"finds an accessor on its superview\"\n      equal undefined, subview.lookupKeypath('bogusKeypath'), \"returns undefined if the keypath isn't defined\"\n\nIf used in an accessor, `keypath` is registered as source and will be correctly bound. `lookupKeypath` is used by [view bindings](\/docs\/api\/batman.view_bindings.html) to get data.\n\n## ::setKeypath(keypath, value)\n\nTraverses the view tree searching for the specified keypath and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is used by [view bindings](\/docs\/api\/batman.view_bindings.html) to set data.\n\n    test 'setKeypath sets the value if defined on the view or on an ancestor', ->\n      superview = new Batman.View(cat: 'Meowie')\n      subview = new Batman.View(superview: superview, dog: 'Fido')\n      subview.setKeypath('cat', 'Mittens')\n      equal 'Mittens', superview.get('cat'), \"updates an accessor on its superview\"\n      subview.setKeypath('dog', 'Lassie')\n      equal 'Lassie', subview.get('dog'), \"updates an accessor on itself\"\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n## ::%node : Node\n\nReturns the DOM node that this view encapsulates.\n\nAccessing `node` will load and parse the template if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\nYou can also access a view's `node` in its methods, for example, activating jQuery plugins:\n\n```\nclass App.SearchBarView extends Batman.View\n  viewDidAppear: ->\n    $node = $(@get('node'))\n    $node.typeahead() # <= whatever jQuery plugin you want!\n```\n## ::%source : String\n\nThis string will be used to fetch a view's HTML, relative to [`Batman.config.pathToHTML`](\/docs\/configuration.html).\nYou don't need to add `.html` to this string -- it will be added automatically.\n\nInside a controller action, batman.js provides a default source based on the\ncontoller's [`routingKey`](\/docs\/api\/batman.controller.html#routingkey_and_minification) and the [controller action](\/docs\/api\/batman.controller.html#actions).\n\nYou can set `source` in the class definition:\n\n```\nclass App.HeaderNavigationView extends Batman.View\n  source: 'layout\/_header'\n```\n\nOr when calling `@render()` inside a controller action:\n\n```\nclass App.PostsController extends Batman.Controller\n  show: ->\n    @set('post', new App.Post)\n    if @get('post.isAlternative')\n      @render(source: \"posts\/alternative_new\")\n    else\n      @render() # defaults to 'posts\/new'\n```\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview. You can specify a view's HTML when you define the class:\n\n```\nclass App.SearchBarView extends Batman.View\n  html: \"<input type='text' placeholder='Enter a search term' \/>\"\n```\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n    test 'setting a source loads the correct template', ->\n      Batman.View.store.set('\/animals', '<div>cat<\/div>')\n      view = new Batman.View(source: '\/animals')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n## @filter(label : string, filter : function)\n\nDefines a custom [view filter](\/docs\/api\/batman.view_filters.html) for use within the `View`.\n\n`filter` will be invoked with the pre-filter `value` and any arguments passed to the view filter. For example:\n\n```coffeescript\nclass App.MultiplierView extends Batman.View\n  @filter 'multiplyBy', (value, multiplier) -> value * multiplier\n```\n\nwould handle:\n\n```html\n<div data-view='MultiplierView' data-context-amount='100'>\n  <span data-bind='amount | multiplyBy 6'>\n    <!-- would render to \"600\" -->\n  <\/span>\n<\/div>\n```\n\n_Note_: If the `View`'s HTML is loaded before the view is instantiated, this filter won't have been defined yet and batman.js will throw an error. Avoid this by defining your custom filter at app-level or by defining the `View`'s HTML with [`::source`](\/docs\/api\/batman.view.html#prototype_accessor_source) or [`::html`](\/docs\/api\/batman.view.html#prototype_accessor_html).\n\n## @option(keys...)\n\nDefines a custom option for the `View`. `@option` allows you to initialize your view with data from its context. For example:\n\n```coffeescript\nclass App.MultiplierView extends Batman.View\n  @option 'amount', 'multiplier'\n  @accessor 'finalAmount', -> @get('amount') * @get('multiplier')\n```\n\n```html\n<div data-view='MultiplierView' data-view-amount='10' data-view-multiplier='8'>\n  <span data-bind='finalAmount'>\n    <!-- would render to \"80\" !-->\n  <\/span>\n<\/div>\n```\n\nOptions passed with `data-view-#{option}` may also be keypaths. Keypath changes will be tracked by the view.\n\n## ::.superview : Batman.View\n\nReturns the view's superview. Every view except an app's `LayoutView` has a superview.\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of this `View`. Since it's a [`Batman.Set`](\/docs\/api\/batman.set.html), you can operate directly on this set and batman.js will automatically keep the DOM in sync.\n\nAdding to a view's subviews will automatically update the tree and parse\nthe template and bindings. If the superview is in the DOM, this will\ninsert the current view's node into the DOM.\n\n    test 'adding to a superview parses bindings', ->\n      superview = new Batman.View()\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      superview.subviews.add(view)\n      equal 'cat', view.get('node').firstChild.innerHTML\n\nRemoving from a view's subviews will automatically remove the subview from\nthe DOM.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View(html: '', parentNode: document.body)\n      superview.get('node')\n      view = new Batman.View(html: '', superview: superview)\n\n      ok Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n      superview.subviews.remove(view)\n      ok not Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent (and from the DOM), without killing it.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.removeFromSuperview()\n      ok not superview.subviews.has(view)\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n      test 'die kills the view', ->\n        superview = new Batman.View()\n        view = new Batman.View(superview: superview)\n\n        view.die()\n        equal true, view.isDead\n        equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n    test 'destroySubviews kills all subviews', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: superview)\n\n      superview.destroySubviews()\n      ok one.isDead\n      ok two.isDead\n\n\n## ::propagateToSubviews(eventOrKey : string, value : Object)\n\nIf `value` is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n    test 'propagateToSubviews propagates events', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.on 'eventName', superSpy = createSpy()\n      one.on 'eventName', oneSpy = createSpy()\n      two.on 'eventName', twoSpy = createSpy()\n\n      superview.propagateToSubviews('eventName')\n\n      equal 1, superSpy.callCount\n      equal 1, oneSpy.callCount\n      equal 1, twoSpy.callCount\n\n    test 'propagateToSubviews propagates keys', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.propagateToSubviews('key', 'value')\n\n      equal superview.get('key'), 'value'\n      equal one.get('key'), 'value'\n      equal two.get('key'), 'value'\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d01716f44350dbb4320f8f691250ac84d11075ad","subject":"proper superclass","message":"proper superclass\n","repos":"nhz-io\/cnl","old_file":"source\/component.litcoffee","new_file":"source\/component.litcoffee","new_contents":"# CLASS: Component\n* Extends: [Element][Element]\n* Parent: [Index][Parent]\n\n---\n\n    module.exports = class Component extends require '.\/element'\n\n## CONSTRUCTOR\n\n### new Component()\n\nCreates Component instance.\n\n      constructor: -> super\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## METHODS\n\n[Parent]: .\/index.litcoffee\n[Element]: .\/element.litcoffee\n\n","old_contents":"# CLASS: Component\n* Extends: [Element][Element]\n* Parent: [Index][Parent]\n\n---\n\n    module.exports = class Component extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Component()\n\nCreates Component instance.\n\n      constructor: (args) ->\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## METHODS\n\n[Parent]: .\/index.litcoffee\n[Element]: .\/element.litcoffee\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"45f96b1845f6e6ecb13e3575985b11371753a0a9","subject":"fixed indentation","message":"fixed indentation\n","repos":"nhz-io\/cnl","old_file":"source\/lib\/event.litcoffee","new_file":"source\/lib\/event.litcoffee","new_contents":"# CLASS: Event\n* Extends: [Base][Base]\n* Parent: [lib][lib]\n\nThis class provides a data transport between instances of [Evented][Evented].\nAny instance of this class must have at least the **type** property set\nso that [Evented][Evented] methods will not drop it. This class does not provide\nany functionality and mostly saves as the envelope for data.\n\n      module.exports = class Event extends require '.\/base'\n\n## CONSTRUCTOR\n\n### new Event(type)\n### new Event(callback)\n### new Event(args, callback)\n### new Event(type, callback)\n\n* Returns: [Event][Event]\n\nCreate the event. All the key-value pairs from **args** will be copied\nto the event instance. If **callback** is provided in the **args**, it\nwill override the **callback** provided as the second argument.\n\nUpon instance creation, the event will log it's creation timestamp. This\ncan be disabled by passing `timestamp:null` to constructor.\n\nAny Event instance at its minimum will have **timestamp** property. This\nis the only mandatory property.\n\nCreate Event instance, accepting arguments in multiple forms.\n\n        constructor: (args = {}, callback) ->\n\nSet the event type to the value of the first argument if it is a [String][String]\n\n          if typeof args is 'string' then args = type:args\n\nOtherwise, set the `args` to empty [Object][Object] and `callback` to the value of the\nfirst argument if it is a [Function][Function].\n\n          else if (arguments.length < 2) and typeof args is 'function'\n            callback = args\n            args = {}\n\nCopy contents of args into this instance\n\n          this[key] = value for key, value of args\n\nOverwrite the **#callback** only if it is not set.\n\n          @callback = callback if callback and not @callback\n\nCalculate and set the event creation timestamp if it was not disabled or set from **args**\n\n          if (args.timestamp is true) or not args.hasOwnProperty 'timestamp'\n            date = Date.now()\n            perf = performance?.now() or 0\n            @timestamp = 1000 * date + Math.floor 1000 * (perf - Math.floor perf)\n\n### PARAMETERS\n**args**\n* Type: [Object][Object] - event data\n\n**args.type**\n* Type: [String][String] - event type\n\n**args.callback**\n* Type: [Function][Function] - event completion callback\n* Optional\n* Overrides the **callback** parameter\n\n**args.timestamp**\n* Type: [Boolean][Boolean] - set to `false` to disable the timestamp calculation\n* Type: [Number][Number] - event timestamp\n\n**type**\n* Type: [String][String] - event type\n\n**callback**\n* Type: [Function][Function] - event completion callback\n* Optional\n\n---\n\n## PROPERTIES\n\n### #type\n* Type: [String][String] - event type\n\n### #phase\n* Type: [Number][Number] - event phase (1..3)\n\n### #timestamp\n* Type: [Number][Number] - event creation timestamp\n\n### #callback\n* Type: [Function][Function] - event completion callback\n\n---\n\n## FLAGS\n\n### #started\n* Type: [Boolean][Boolean] - event **started** flag\n\n### #stopped\n* Type: [Boolean][Boolean] - event **stopped** flag\n\n### #canceled\n* Type: [Boolean][Boolean] - event **canceled** flag\n\n### #aborted\n* Type: [Boolean][Boolean] - event **aborted** flag\n\n### #done\n* Type: [Boolean][Boolean] - event **done** flag\n\n---\n\n## METHODS\n\n### #start()\n* Returns: [Event][Event]\n\n**started** flag setter\n\n        start: -> (@started = yes) and this\n\n---\n\n### #stop()\n* Returns: [Event][Event]\n\n**stopped** flag setter\n\n        stop: -> (@stopped = yes) and this\n\n---\n\n### #cancel()\n* Returns: [Event][Event]\n\n**canceled** flag setter\n\n        cancel: -> (@canceled = yes) and this\n\n---\n\n### #abort()\n* Returns: [Event][Event]\n\n**aborted** flag setter\n\n        abort: -> (@aborted = yes) and this\n\n---\n\n### #finish()\n* Returns: [Event][Event]\n\n**done** flag setter\n\n        finish: -> (@done = yes) and this\n\n[lib]: .\/index.litcoffee\n[Evented]: .\/evented.litcoffee\n[Base]: .\/base.litcoffee\n[Event]: .\/event.litcoffee\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[String]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/String\n[Function]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Function\n[Boolean]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Boolean\n[Number]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Number\n","old_contents":"# CLASS: Event\n* Extends: [Base][Base]\n* Parent: [lib][lib]\n\nThis class provides a data transport between instances of [Evented][Evented].\nAny instance of this class must have at least the **type** property set\nso that [Evented][Evented] methods will not drop it. This class does not provide\nany functionality and mostly saves as the envelope for data.\n\n      module.exports = class Event extends require '.\/base'\n\n## CONSTRUCTOR\n\n### new Event(type)\n### new Event(callback)\n### new Event(args, callback)\n### new Event(type, callback)\n\n* Returns: [Event][Event]\n\nCreate the event. All the key-value pairs from **args** will be copied\nto the event instance. If **callback** is provided in the **args**, it\nwill override the **callback** provided as the second argument.\n\nUpon instance creation, the event will log it's creation timestamp. This\ncan be disabled by passing `timestamp:null` to constructor.\n\nAny Event instance at its minimum will have **timestamp** property. This\nis the only mandatory property.\n\nCreate Event instance, accepting arguments in multiple forms.\n\n      constructor: (args = {}, callback) ->\n\nSet the event type to the value of the first argument if it is a [String][String]\n\n        if typeof args is 'string' then args = type:args \n\nOtherwise, set the `args` to empty [Object][Object] and `callback` to the value of the\nfirst argument if it is a [Function][Function].\n\n        else if (arguments.length < 2) and typeof args is 'function'\n            callback = args\n            args = {}\n\nCopy contents of args into this instance\n\n        this[key] = value for key, value of args\n\nOverwrite the **#callback** only if it is not set.\n\n        @callback = callback if callback and not @callback\n\nCalculate and set the event creation timestamp if it was not disabled or set from **args**\n\n        if (args.timestamp is true) or not args.hasOwnProperty 'timestamp'\n          date = Date.now()\n          perf = performance?.now() or 0\n          @timestamp = 1000 * date + Math.floor 1000 * (perf - Math.floor perf)\n\n### PARAMETERS\n**args**\n* Type: [Object][Object] - event data\n\n**args.type**\n* Type: [String][String] - event type\n\n**args.callback**\n* Type: [Function][Function] - event completion callback\n* Optional\n* Overrides the **callback** parameter\n\n**args.timestamp**\n* Type: [Boolean][Boolean] - set to `false` to disable the timestamp calculation\n* Type: [Number][Number] - event timestamp\n\n**type**\n* Type: [String][String] - event type\n\n**callback**\n* Type: [Function][Function] - event completion callback\n* Optional\n\n---\n\n## PROPERTIES\n\n### #type\n* Type: [String][String] - event type\n\n### #phase\n* Type: [Number][Number] - event phase (1..3)\n\n### #timestamp\n* Type: [Number][Number] - event creation timestamp\n\n### #callback\n* Type: [Function][Function] - event completion callback\n\n---\n\n## FLAGS\n\n### #started\n* Type: [Boolean][Boolean] - event **started** flag\n\n### #stopped\n* Type: [Boolean][Boolean] - event **stopped** flag\n\n### #canceled\n* Type: [Boolean][Boolean] - event **canceled** flag\n\n### #aborted\n* Type: [Boolean][Boolean] - event **aborted** flag\n\n### #done\n* Type: [Boolean][Boolean] - event **done** flag\n\n---\n\n## METHODS\n\n### #start()\n* Returns [Event][Event]\n\n**started** flag setter\n\n      start: -> (@started = yes) and this\n\n---\n\n### #stop()\n* Returns [Event][Event]\n\n**stopped** flag setter\n\n      stop: -> (@stopped = yes) and this\n\n---\n\n### #cancel()\n* Returns [Event][Event]\n\n**canceled** flag setter\n\n      cancel: -> (@canceled = yes) and this\n\n---\n\n### #abort()\n* Returns [Event][Event]\n\n**aborted** flag setter\n\n      abort: -> (@aborted = yes) and this\n\n---\n\n### finish()\n* Returns [Event][Event]\n\n**done** flag setter\n\n      finish: -> (@done = yes) and this\n\n[lib]: .\/index.litcoffee\n[Evented]: .\/evented.litcoffee\n[Base]: .\/base.litcoffee\n[Event]: .\/event.litcoffee\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[String]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/String\n[Function]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Function\n[Boolean]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Boolean\n[Number]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Number\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"10cbef5aa4cc7e21f0113d51fb74e5abee8700fa","subject":"Preliminary date functionality - just so it exists","message":"Preliminary date functionality - just so it exists\n","repos":"lacona\/lacona,laconalabs\/elliptical","old_file":"src\/plugins\/date.litcoffee","new_file":"src\/plugins\/date.litcoffee","new_contents":"#Includes\n\n\tmoment = require 'moment'\n\n#Date\n\n\tmodule.exports =\n\t\tscope:\n\t\t\tgetDate: (result) ->\n\t\t\t\tif result.relativeDay?\n\t\t\t\t\treturn moment({hour: 0}).add(result.relativeDay, 'd').toDate()\n\t\t\t\telse\n\t\t\t\t\treturn moment().toDate()\n\t\tschema: [\n\t\t\tname: 'dayOfTheWeek'\n\t\t\troot:\n\t\t\t\ttype: 'choice'\n\t\t\t\tid: '@value'\n\t\t\t\tchildren: [\n\t\t\t\t\ttype: 'Sunday'\n\t\t\t\t\tvalue: 0\n\t\t\t\t,\n\t\t\t\t\ttype: 'Monday'\n\t\t\t\t\tvalue: 1\n\t\t\t\t,\n\t\t\t\t\ttype: 'Tuesday'\n\t\t\t\t\tvalue: 2\n\t\t\t\t,\n\t\t\t\t\ttype: 'Wednesday'\n\t\t\t\t\tvalue: 3\n\t\t\t\t,\n\t\t\t\t\ttype: 'Thursday'\n\t\t\t\t\tvalue: 4\n\t\t\t\t,\n\t\t\t\t\ttype: 'Friday'\n\t\t\t\t\tvalue: 5\n\t\t\t\t,\n\t\t\t\t\ttype: 'Saturday'\n\t\t\t\t\tvalue: 6\n\t\t\t\t]\n\t\t,\n\t\t\tname: 'date'\n\t\t\tevaluate: 'getDate'\n\t\t\troot:\n\t\t\t\ttype: 'choice'\n\t\t\t\tchildren: [\n\t\t\t\t\ttype: 'literal'\n\t\t\t\t\tid: 'relativeDay'\n\t\t\t\t\tdisplay: 'today'\n\t\t\t\t\tvalue: 0\n\t\t\t\t,\n\t\t\t\t\ttype: 'literal'\n\t\t\t\t\tid: 'relativeDay'\n\t\t\t\t\tdisplay: 'tomorrow'\n\t\t\t\t\tvalue: 1\n\t\t\t\t,\n\t\t\t\t\ttype: 'literal'\n\t\t\t\t\tid: 'relativeDay'\n\t\t\t\t\tdisplay: 'the day after tomorrow'\n\t\t\t\t\tvalue: 2\n\t\t\t\t,\n\t\t\t\t\ttype: 'sequence'\n\t\t\t\t\tchildren: [\n\t\t\t\t\t\t'in'\n\t\t\t\t\t,\n\t\t\t\t\t\ttype: 'integer'\n\t\t\t\t\t\tid: 'relativeDay'\n\t\t\t\t\t\tmin: 1\n\t\t\t\t\t,\n\t\t\t\t\t\t'days'\n\t\t\t\t\t]\n\t\t\t\t]\n\t\t]","old_contents":"#Includes\n\n\tmoment = require 'moment'\n\n#Date\n\n\tmodule.exports =\n\t\tscope:\n\t\t\tgetDate: (result) ->\n\t\t\t\tif result.relativeDate?\n\t\t\t\t\treturn moment({hour: 0}).add(result.relativeDate, 'd').toDate()\n\t\t\t\telse\n\t\t\t\t\treturn moment().toDate()\n\t\tschema: [\n\t\t\tname: 'dayOfTheWeek'\n\t\t\troot:\n\t\t\t\ttype: 'choice'\n\t\t\t\tid: '@value'\n\t\t\t\tchildren: [\n\t\t\t\t\ttype: 'Sunday'\n\t\t\t\t\tvalue: 0\n\t\t\t\t,\n\t\t\t\t\ttype: 'Monday'\n\t\t\t\t\tvalue: 1\n\t\t\t\t,\n\t\t\t\t\ttype: 'Tuesday'\n\t\t\t\t\tvalue: 2\n\t\t\t\t,\n\t\t\t\t\ttype: 'Wednesday'\n\t\t\t\t\tvalue: 3\n\t\t\t\t,\n\t\t\t\t\ttype: 'Thursday'\n\t\t\t\t\tvalue: 4\n\t\t\t\t,\n\t\t\t\t\ttype: 'Friday'\n\t\t\t\t\tvalue: 5\n\t\t\t\t,\n\t\t\t\t\ttype: 'Saturday'\n\t\t\t\t\tvalue: 6\n\t\t\t\t]\n\t\t,\n\t\t\tname: 'date'\n\t\t\tevaluate: 'getDate'\n\t\t\troot:\n\t\t\t\ttype: 'choice'\n\t\t\t\tchildren: [\n\t\t\t\t\ttype: 'literal'\n\t\t\t\t\tid: 'relativeDate'\n\t\t\t\t\tdisplay: 'today'\n\t\t\t\t\tvalue: 0\n\t\t\t\t,\n\t\t\t\t\ttype: 'literal'\n\t\t\t\t\tid: 'relativeDate'\n\t\t\t\t\tdisplay: 'tomorrow'\n\t\t\t\t\tvalue: 1\n\t\t\t\t,\n\t\t\t\t\ttype: 'literal'\n\t\t\t\t\tid: 'relativeDate'\n\t\t\t\t\tdisplay: 'the day after tomorrow'\n\t\t\t\t\tvalue: 2\n\t\t\t\t,\n\t\t\t\t\ttype: 'sequence'\n\t\t\t\t\tchildren: [\n\t\t\t\t\t\t'in'\n\t\t\t\t\t,\n\t\t\t\t\t\ttype: 'integer'\n\t\t\t\t\t\tid: 'relativeDate'\n\t\t\t\t\t,\n\t\t\t\t\t\t'days'\n\t\t\t\t\t]\n\t\t\t\t]\n\t\t]","returncode":0,"stderr":"","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"bf825b61c108fcddb1b7a0606448c772ec751def","subject":"Fix heading for ComponentQuery","message":"Fix heading for ComponentQuery\n","repos":"ygt-mikekchar\/react-maybe-matchers,ygt-mikekchar\/react-maybe-matchers","old_file":"src\/ComponentQuery.litcoffee","new_file":"src\/ComponentQuery.litcoffee","new_contents":"# ComponentQuery\n\nWhen we first start out, we are likely to have only a single\ncomponent.  This monad is used for querying that component\nand getting a list of nodes that we will filter later.\n \n## Example\n\n```\ncomponentQuery.contains\n              .tags(\"div\")\n              .result()\n```\n\nThis will take a component in the componentFilter\nand generate a ComponentFilter with the DOM nodes\nthat have the tag \"div\".  In this particular example,\nit will return a matching result if there are any\nsuch nodes.\n\n## Requirements\n\nIn order to make sure that the user can use whatever version of React\nthey want, we assume that the variable `React` already points to\nthe React package (FIXME: I wonder if there is a better way).  Just\nto save typing, we will use the following alias:\n\n    Utils = React.addons.TestUtils\n\nThe [JasmineMonad](.\/JasmineMonad.litcoffee)is a \"maybe\" monad that\nallows us to chain our matcher functions in a fluent way.\n\n    JasmineMonad = require(\".\/JasmineMonad.litcoffee\")\n\nThe [ComponentFilter](.\/ComponentFilter.litcoffee) is a JasmineMonad\nthat allows you to filter and match collections of React components.\n\n    ComponentFilter = require(\".\/ComponentFilter.litcoffee\")\n\n## A monad for making queries of single Components\n\n    class ComponentQuery extends JasmineMonad\n\n      constructor: (@value, @util, @testers, @messages) ->\n        super(@value, @util, @testers, @messages)\n        @contains = this\n\nMost of the methods on `ComponentQuery` will actually want to\nreturn a ComponentFilter so the user can filter the collection of returned \nnodes.  If we were using a language with strong typing the compiler\nwould be able to construct the correct the correct Monad based\non the types.  However, we are using Coffeescript, so we have to\ngive it a helping hand by making a different `return` method.\n\n      returnMany: (nodes, messages) ->\n        new ComponentFilter(nodes, @util, @testers, messages)\n\n#### Testing for DOM tags\n\nOne of the most common kinds of tests is to determine whether or not\na component contains a DOM \"tag\" (eg \"h1\", \"div\", etc). This matcher\npasses if there is at least one.\n\n\n      tags: (tag) ->\n        @bind (component) =>\n          nodes = Utils.scryRenderedDOMComponentsWithTag(component, tag)\n          messages = [\n            \"Expected to find DOM tag #{tag}, but it was not there.\"\n            \"Expected not to find DOM tag #{tag}, but there #{@was(nodes.length)}.\"\n          ]\n          if nodes.length > 0\n            @returnMany(nodes, messages)\n          else\n            @return(null, messages)\n\nExport our matchers from this file.\n\n    module.exports = ComponentQuery\n","old_contents":"# Component Query\n\nWhen we first start out, we are likely to have only a single\ncomponent.  This monad is used for querying that component\nand getting a list of nodes that we will filter later.\n \n## Example\n\n```\ncomponentQuery.contains\n              .tags(\"div\")\n              .result()\n```\n\nThis will take a component in the componentFilter\nand generate a ComponentFilter with the DOM nodes\nthat have the tag \"div\".  In this particular example,\nit will return a matching result if there are any\nsuch nodes.\n\n## Requirements\n\nIn order to make sure that the user can use whatever version of React\nthey want, we assume that the variable `React` already points to\nthe React package (FIXME: I wonder if there is a better way).  Just\nto save typing, we will use the following alias:\n\n    Utils = React.addons.TestUtils\n\nThe [JasmineMonad](.\/JasmineMonad.litcoffee)is a \"maybe\" monad that\nallows us to chain our matcher functions in a fluent way.\n\n    JasmineMonad = require(\".\/JasmineMonad.litcoffee\")\n\nThe [ComponentFilter](.\/ComponentFilter.litcoffee) is a JasmineMonad\nthat allows you to filter and match collections of React components.\n\n    ComponentFilter = require(\".\/ComponentFilter.litcoffee\")\n\n## A monad for making queries of single Components\n\n    class ComponentQuery extends JasmineMonad\n\n      constructor: (@value, @util, @testers, @messages) ->\n        super(@value, @util, @testers, @messages)\n        @contains = this\n\nMost of the methods on `ComponentQuery` will actually want to\nreturn a ComponentFilter so the user can filter the collection of returned \nnodes.  If we were using a language with strong typing the compiler\nwould be able to construct the correct the correct Monad based\non the types.  However, we are using Coffeescript, so we have to\ngive it a helping hand by making a different `return` method.\n\n      returnMany: (nodes, messages) ->\n        new ComponentFilter(nodes, @util, @testers, messages)\n\n#### Testing for DOM tags\n\nOne of the most common kinds of tests is to determine whether or not\na component contains a DOM \"tag\" (eg \"h1\", \"div\", etc). This matcher\npasses if there is at least one.\n\n\n      tags: (tag) ->\n        @bind (component) =>\n          nodes = Utils.scryRenderedDOMComponentsWithTag(component, tag)\n          messages = [\n            \"Expected to find DOM tag #{tag}, but it was not there.\"\n            \"Expected not to find DOM tag #{tag}, but there #{@was(nodes.length)}.\"\n          ]\n          if nodes.length > 0\n            @returnMany(nodes, messages)\n          else\n            @return(null, messages)\n\nExport our matchers from this file.\n\n    module.exports = ComponentQuery\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"dec7af5c4f315ac338e700dcf9d90c34b91430c5","subject":"weya example lint","message":"weya example lint\n","repos":"vpj\/weya,vpj\/weya","old_file":"example.litcoffee","new_file":"example.litcoffee","new_contents":"Create a sample div\n\n    class Student\n     constructor: (name, age) ->\n      @name = name\n      @age = age\n\n     template: ->\n      @div \"#name.col-md-6\", ->\n       @span \"Name\"\n       @span @$.name\n      @div \"#age.col-md-6\", style: {background: \"red\"}, ->\n       @span \"Age\"\n       @span \"#{@$.age}\"\n       @input \"#ageInput\", type: \"text\", null\n\n     render: ->\n      console.log Weya.markup context: this, @template\n      Weya elem: document.body, context: this, @template\n\n\n    student = new Student \"Varuna\", 26\n    student.render()\n","old_contents":"Create a sample div\n\n    class Student\n     constructor: (name, age) ->\n      @name = name\n      @age = age\n\n     template: ->\n      @div \"#name.col-md-6\", ->\n       @span \"Name\"\n       @span @$.name\n      @div \"#age.col-md-6\", style: {background: \"red\"}, ->\n       @span \"Age\"\n       @span \"#{@$.age}\"\n       @input \"#ageInput\", type: \"text\", null\n\n     render: ->\n      console.log Weya.markup context: @, @template\n      Weya elem: document.body, context: @, @template\n\n\n    student = new Student \"Varuna\", 26\n    student.render()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b6fc78dcf7444d86e5598a1680628f1a90882fc9","subject":"gzip over deflate","message":"gzip over deflate\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        @_handleResponse data, options, last\n       when 'call'\n        @_handleCall data, options, last\n       when 'poll'\n        @_handlePoll data, options, last\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        @_handleResponse data, options, last\n       when 'call'\n        @_handleCall data, options, last\n       when 'poll'\n        @_handlePoll data, options, last\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8a65a41a38bd9ebda3dd95b7e5189f730abbb1f0","subject":"undebug","message":"undebug\n","repos":"ckxng\/google_gift_exchange,ckxng\/google_gift_exchange,ckxng\/google_gift_exchange","old_file":"src\/lib\/routes\/index.litcoffee","new_file":"src\/lib\/routes\/index.litcoffee","new_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\n    module.exports = (app) ->\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        res.render 'index', {\n          title: 'Welcome'\n        }\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/game', (req, res) ->\n        title = 'Gift Exchange'\n        request = require '..\/..\/node_modules\/request'\n        request {\n          url: 'https:\/\/docs.google.com\/spreadsheet\/pub?key=0ArrqhUPPrcPCdG5iV1hkRHdsVjJnTm84NW1RVnQ4WlE&single=true&gid=0&output=csv',\n        }, (err, rres, body) ->\n          if err\n            res.render 'page', {\n              title: title,\n              body: 'Error #1: '+err\n            }\n          else\n            presents = []\n            gravatar = require '..\/..\/node_modules\/gravatar'\n            csv = require '..\/..\/node_modules\/csv'\n            csv().from.string(body).on('record', (row, index) ->\n              return if index == 0\n              presents.push {\n                id: row[0],\n                img: if row[4] then row[3] else row[2],\n                detail: if row[4] then \"#{row[1]} - #{row[5]}\",\n                ownerurl:\n                  if row[6]\n                    gravatar.url(\"#{row[6]}@zerolag.com\",{s: '256', d: 'monsterid'})\n                  else\n                    \"http:\/\/placehold.it\/256x256&text=available\"\n                ,\n                owner: if row[6] then \"#{row[6]}@zerolag.com\" else \"nobody@zerolag.com\"\n              })\n            res.render 'game', {\n              title: title,\n              presents: presents,\n              debug: if 0 then JSON.stringify presents\n            }\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        res.render 'page\/'+req.params.name\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\n    module.exports = (app) ->\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        res.render 'index', {\n          title: 'Welcome'\n        }\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/game', (req, res) ->\n        title = 'Gift Exchange'\n        request = require '..\/..\/node_modules\/request'\n        request {\n          url: 'https:\/\/docs.google.com\/spreadsheet\/pub?key=0ArrqhUPPrcPCdG5iV1hkRHdsVjJnTm84NW1RVnQ4WlE&single=true&gid=0&output=csv',\n        }, (err, rres, body) ->\n          if err\n            res.render 'page', {\n              title: title,\n              body: 'Error #1: '+err\n            }\n          else\n            presents = []\n            gravatar = require '..\/..\/node_modules\/gravatar'\n            csv = require '..\/..\/node_modules\/csv'\n            csv().from.string(body).on('record', (row, index) ->\n              return if index == 0\n              presents.push {\n                id: row[0],\n                img: if row[4] then row[3] else row[2],\n                detail: if row[4] then \"#{row[1]} - #{row[5]}\",\n                ownerurl:\n                  if row[6]\n                    gravatar.url(\"#{row[6]}@zerolag.com\",{s: '256', d: 'monsterid'})\n                  else\n                    \"http:\/\/placehold.it\/256x256&text=available\"\n                ,\n                owner: if row[6] then \"#{row[6]}@zerolag.com\" else \"nobody@zerolag.com\"\n              })\n            res.render 'game', {\n              title: title,\n              presents: presents,\n              debug: if 1 then JSON.stringify presents\n            }\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        res.render 'page\/'+req.params.name\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"6564cd319b65bdebea788a836a9d84fbb7af82a4","subject":"modify README","message":"modify README\n","repos":"CureApp\/loopback-with-admin","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\n\n# install\n\n```\nnpm install loopback-with-domain\n```\n\n\n# run\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    config =\n        admin:\n            accessToken: 'Your Secret Value Here'\n        server:\n            port: 4000\n\n    lbWithDomain.runWithDomain(domain, config).then ->\n        # loopback started\n\n\n# configs\n\n## server\n\n config name | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n## admin\n\n config name | meaning               | default\n-------------|-----------------------|----------------------------\n accessToken | accessToken for admin | (you must set access token)\n\n\n","old_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\n\n# install\n\n```\nnpm install loopback-with-domain\n```\n\n\n# run\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    config =\n        server:\n            port: 4000\n\n    lbWithDomain.runWithDomain(domain, config).then ->\n        # loopback started\n\n\n# configs\n\n## server\n\n config name | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n## admin\n\n config name | meaning               | default\n-------------|-----------------------|----------------------------\n accessToken | accessToken for admin | (you must set access token)\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e5705dae4c9faa638e77610a64860bccbebf11ff","subject":"comments","message":"comments\n","repos":"vpj\/weya,vpj\/weya","old_file":"weya.litcoffee","new_file":"weya.litcoffee","new_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor animateMotion\n      animateTransform circle clipPath color-profile cursor defs desc ellipse\n      feBlend feColorMatrix feComponentTransfer feComposite feConvolveMatrix\n      feDiffuseLighting feDisplacementMap feDistantLight feFlood feFuncA feFuncB\n      feFuncG feFuncR feGaussianBlur feImage feMerge feMergeNode feMorphology\n      feOffset fePointLight feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line linearGradient\n      marker mask metadata missing-glyph mpath path pattern polygon polyline\n      radialGradient rect script set stop style svg symbol text textPath\n      title tref tspan use view vkern'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt em\n      fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header hgroup\n      html i iframe ins kbd label legend li main map mark menu meter nav noscript object\n      ol optgroup option output p pre progress q rp rt ruby s samp script section\n      select small span strong style sub summary sup table tbody td textarea tfoot\n      th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta param\n      source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: null\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = c\n        else\n         res.class += \" #{c}\"\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        elem.id = idClass.id\n       if idClass.class?\n        elem.className = idClass.class\n\n      if attrs?\n       setAttributes elem, attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if contentFunction?\n       contentFunction.call @\n      else if contentText?\n       elem.textContent = contentText\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call @, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: null\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = c\n        else\n         res.class += \" #{c}\"\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        buf.push \" id=\\\"#{idClass.id}\\\"\"\n       if idClass.class?\n        buf.push \" class=\\\"#{idClass.class}\\\"\"\n\n      if attrs?\n       setAttributes buf, attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if contentFunction?\n       contentFunction.call @\n      else if contentText?\n       setIndent buf, @_indent\n       buf.push contentText\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call @, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be accessed via `@$`.\nIf `options.elem` is `null`, the element is created but not appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n     return buf.join ''\n\n","old_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor animateMotion\n      animateTransform circle clipPath color-profile cursor defs desc ellipse\n      feBlend feColorMatrix feComponentTransfer feComposite feConvolveMatrix\n      feDiffuseLighting feDisplacementMap feDistantLight feFlood feFuncA feFuncB\n      feFuncG feFuncR feGaussianBlur feImage feMerge feMergeNode feMorphology\n      feOffset fePointLight feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line linearGradient\n      marker mask metadata missing-glyph mpath path pattern polygon polyline\n      radialGradient rect script set stop style svg symbol text textPath\n      title tref tspan use view vkern'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt em\n      fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header hgroup\n      html i iframe ins kbd label legend li main map mark menu meter nav noscript object\n      ol optgroup option output p pre progress q rp rt ruby s samp script section\n      select small span strong style sub summary sup table tbody td textarea tfoot\n      th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta param\n      source track wbr'\n\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nWrapper for browser API\n\n     Api =\n      document: @document\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: null\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = c\n        else\n         res.class += \" #{c}\"\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        elem.id = idClass.id\n       if idClass.class?\n        elem.className = idClass.class\n\n      if attrs?\n       setAttributes elem, attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if contentFunction?\n       contentFunction.call @\n      else if contentText?\n       elem.textContent = contentText\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call @, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: null\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = c\n        else\n         res.class += \" #{c}\"\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        buf.push \" id=\\\"#{idClass.id}\\\"\"\n       if idClass.class?\n        buf.push \" class=\\\"#{idClass.class}\\\"\"\n\n      if attrs?\n       setAttributes buf, attrs\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if contentFunction?\n       contentFunction.call @\n      else if contentText?\n       setIndent buf, @_indent\n       buf.push contentText\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call @, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n\n\n#Weya\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be accessed via `@$`.\n\nIf `options.elem` is `null`, the element is created but not appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n     return buf.join ''\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"803c955d3f928eb5901a5a88ba3a14fb004e0467","subject":"Adding assert and validate methods to reduce error handling code","message":"Adding assert and validate methods to reduce error handling code\n","repos":"ojjs\/oj","old_file":"src\/oj.litcoffee","new_file":"src\/oj.litcoffee","new_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\noj function\n-------------------------------------------------------------------------------\n\n  oj function acts like a tag method that doesn't emit\n  Using inline js so the function can be named\n\n    `function oj(){return oj.tag.apply(this, ['oj'].concat([].slice.call(arguments)).concat([{__quiet__:1}]));}`\n\n  Define oj version\n\n    oj.version = '0.2.0'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Store jQuery reference as either the global reference or as required through `jquery2`.\n  This allows this reference to be included as a script tag, included through npm, or overriden.\n\n    if typeof $ != 'undefined'\n      oj.$ = $\n    else if typeof require != 'undefined'\n      try\n        oj.$ = require 'jquery'\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      oj.$ ->\n        oj.$.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrP = Array.prototype\n    FunP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrP.slice\n    unshift = ArrP.unshift\n    concat = ArrP.concat\n\nType helper for oj types\n\n    oj.isOJ = `function(obj){return !!(obj != null ? obj.isOJ : void 0);}`\n\n    oj.isOJType = `function(obj){return oj.isOJ(obj) && obj.type === obj;}`\n\n    oj.isOJInstance = `function(obj){return oj.isOJ(obj) && !oj.isOJType(obj);}`\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isPlainObject = oj.$.isPlainObject\n    oj.isFunction = oj.$.isFunction\n    oj.isArray = oj.$.isArray\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = `function(c){return !!(c.match(\/[A-Z]\/));}`\n    _identity = `function(v){return v;}`\n    _has = `function(obj, key){return ObjP.hasOwnProperty.call(obj, key);}`\n    _keys = Object.keys\n    _values = `function(obj){var keys = _.keys(obj);var length = keys.length; var values = new Array(length); for (var i = 0; i < length; i++) {values[i] = obj[keys[i]]; } return values;}`\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      return obj unless (oj.isArray obj) or ((oj.typeOf obj) == 'object')\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n\n  _extend\n\n    _extend = oj.$.extend\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\nError Handling Helpers\n-----------------------------------------------------------------------------\n  Assert cond is true or throw message\n\n    _a = (cond, msg, fn) ->\n      if !cond\n        if fn\n          msg = \"oj.#{fn}: #{msg}\"\n        throw new Error msg\n      return\n\n  Validate fn argument at position n matches type\n\n    _v = (fn, n, v, type) ->\n      n = {1:'first', 2:'second',3:'third',4:'fourth',5:'fifth'}[n]\n      _a (!type or (typeof v == type)), \"#{type} expected for #{n} argument\", fn\n      return\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      r.map (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n      _v 'addMethod', 2, methodName, 'string'\n      _v 'addMethod', 3, method, 'function'\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n      _v 'removeMethod', 2, methodName, 'string'\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n      _v 'addProperty', 2, propName, 'string'\n      _v 'addProperty', 3, propInfo, 'object'\n\nDefault properties to enumerable and configurable\n\n      propInfo = _extend {}, {\n        enumerable: true\n        configurable: true},\n        propInfo\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n      _v 'removeProperty', 2, propName, 'string'\n      delete obj[propName]\n      return\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      _v 'isProperty', 2, propName, 'string'\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, rest...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      _v 'tag', 1, name, 'string'\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from rest by unioning all objects\n\n      {args, options:attributes} = oj.unionArguments rest\n\n      if isQuiet = attributes.__quiet__\n        delete attributes.__quiet__\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isPlainObject arg\n          continue\n\n        else if oj.isFunction arg\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to.\n  Do not emit when quiet is set,\n\n      oj._argsAppend(ojml) unless isQuiet\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      oj.tag.elements.open.indexOf(tag) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Get quiet tag name\n\n    _getQuietTagName = (tag) ->\n      '_' + tag\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n\n  Tag functions emit by default\n\n        oj[t] = -> oj.tag t, arguments...\n\n  Underscore tag functions do not emit\n\n        qt = _getQuietTagName t\n        oj[qt] = -> oj.tag t, {__quiet__:1}, arguments...\n\n  Record the tag name so the OJML syntax can use the function instead of a string\n\n        _setTagName oj[t], t\n        _setTagName oj[qt], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extendInto (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.useGlobally = oj.extendInto = (context = root) ->\n\n      o = {}\n      for k,v of oj\n        if k[0] != '_' and k != 'extendInto' and k != 'useGlobally'\n          o[k] = v\n\n  Export _tag and _Type methods\n\n          qn = _getQuietTagName k\n          if oj[qn]\n            o[qn] = oj[qn]\n\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* minify - Minify js and css\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _extend\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        minify: false\n        ignore: {}\n        options\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, minify: options.minify, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      options = _extend\n        inline: true\n        indent: ''\n        options\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isPlainObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = mediaParts.map (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.minify then '' else '\\n'\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if (!minify) and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if (!minify) then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\nminify:false will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (any, options) ->\n\n      if oj.isArray any\n        _compileTag any, options\n\n      else if oj.isString any\n        options.html?.push any\n        if any.length > 0 and any[0] == '<'\n          root = document.createElement 'div'\n          root.innerHTML = any\n          els = root.childNodes\n          options.dom?.appendChild root\n          # for el in els\n          #   options.dom?.appendChild el\n        else\n          options.dom?.appendChild document.createTextNode any\n\n      else if oj.isBoolean(any) or oj.isNumber(any)\n        options.html?.push \"#{any}\"\n        options.dom?.appendChild document.createTextNode \"#{any}\"\n\n      else if oj.isFunction any\n        # Wrap function call to allow full oj generation within any\n        _compileAny (oj any), options\n\n      else if oj.isDate any\n        options.html?.push \"#{any.toLocaleString()}\"\n        options.dom?.appendChild document.createTextNode \"#{any.toLocaleString()}\"\n\n      else if oj.isOJ any\n        options.types?.push any\n        options.html?.push any.toHTML(options)\n        options.dom?.appendChild any.toDOM(options)\n        if options.css?\n          _extend options.css, any.toCSSMap(options)\n\n      # Do nothing for: null, undefined, object\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isPlainObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        _v 'compile', 1, ojml[1], 'string'\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isPlainObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip indention if there is only one child\n          if !options.minify and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if (!options.minify) and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n      jqEvents = `{bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mouseleave:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1}`\n\n      # Allow attributes to alias c to class and use arrays instead of space seperated strings\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n\n      # Allow attributes to take style as an object\n      if oj.isPlainObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n\n      # Omit attributes with values of false, null, or undefined\n      if oj.isPlainObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n      # Filter out jquery events\n      events = {}\n      if oj.isPlainObject attr\n        # Filter out attributes that are jquery events\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqEvents[k]?\n            events[k] = v\n            delete attr[k]\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        _a oj.$?, \"oj: jquery is missing when binding a '#{ek}' event\"\n        if oj.isArray ev\n          oj.$(el)[ek].apply @, ev\n        else\n          oj.$(el)[ek](ev)\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isPlainObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isPlain options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n_inherit\n------------------------------------------------------------------------------\nBased on, but sadly incompatable with, coffeescript inheritance\n\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n_construct(Type, arg1, arg2, ...)\n------------------------------------------------------------------------------\nConstruct with specified arguments. This is only necessary because new doesn't support apply\/call directly.\n\n    _construct = (Type) ->\n      new (FunP.bind.apply(Type, arguments));\n\noj.argumentShift\n------------------------------------------------------------------------------\nHelper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isPlainObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      _v 'createType', 1, name, 'string'\n      _v 'createType', 2, args, 'object'\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSort Out::properties.concat propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSort Out::methods.concat methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isPlainObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        has: (k) ->\n          @properties.some (v) -> v == k\n\n        # can: Determine if method exists\n        can: (k) ->\n          @methods.some (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isPlainObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\n_createQuietType\n-------------------------------------------------------------------------------\n\n    _createQuietType = (typeName) ->\n      oj[_getQuietTagName typeName] = ->\n        _construct oj[typeName], arguments..., __quiet__:1\n\noj.createEnum\n------------------------------------------------------------------------\n\n    oj.createEnum = (name, args) ->\n      _a 0, 'NYI', 'createEnum'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: ->\n        _a oj.isDOM(@el), 'constructor failed to set this.el', @typeName\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        {options,args} = oj.unionArguments arguments\n\n        # Emit as a tag if new wasn't called or quiet is not set\n        if @.__autonew__ and not options.__quiet__\n          @emit()\n\n        # Remove quiet flag\n        if options.__quiet__?\n          delete options.__quiet__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _clone options\n        @properties.forEach (v) -> delete options[v]\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = oj.$ @el)\n\n        # Get and set id attribute of view\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # # Get and set class attribute of view\n        # class:\n        #   get: -> @$el.attr 'class'\n        #   set: (v) ->\n        #     # Join arrays with spaces\n        #     if oj.isArray v\n        #       v = v.join ' '\n        #     @$el.attr 'class', v\n        #     return\n\n        # Alias for classes\n        # c:\n        #   get: -> @class\n        #   set: (v) -> @class = v; return\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          slice.call(@el.attributes).forEach (attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all classes as an array (readwrite)\n        classes:\n          get: ->\n            @$el.attr('class').split(\/\\s+\/)\n          set: (v) ->\n            @$el.attr('class', v.join(' '))\n            return\n\n        # Get \/ set all currently set themes (readwrite)\n        themes:\n          get: ->\n            thms = []\n            prefix = 'theme-'\n            for cls in @classes\n              if cls.indexOf(prefix) == 0\n                thms.push cls.slice prefix.length\n            thms\n\n          set: (v) ->\n            v = [v] unless oj.isArray v\n            @clearThemes()\n            for theme in v\n              @addTheme theme\n            return\n\n        theme:\n          get: -> @themes\n          set: (v) -> @themes = v; return\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isPlainObject attr\n            for k,v of attr\n              if k == 'class'\n                @addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single class\n        addClass: (name) ->\n          @$el.addClass name\n          return\n\n        # Remove a single class\n        removeClass: (name) ->\n          @$el.removeClass name\n          return\n\n        # Determine if class is applied\n        hasClass: (name) ->\n          @$el.hasClass name\n\n        # Add a single theme\n        addTheme: (name) ->\n          @addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @removeClass \"theme-#{name}\"\n          return\n\n        # Determine if theme is applied\n        hasTheme: (name) ->\n          @hasClass \"theme-#{name}\"\n\n        # Clear all themes\n        clearThemes: ->\n          for theme in @themes\n            @removeTheme theme\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.minify then '' else '\\n')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (options) -> _cssFromPluginObject (_flattenCSSMap @cssMap), _extend({}, minify:options.minify, tags:0)\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      _a oj.isString(css) or oj.isPlainObject(css), 'object or string expected for first argument', @typeName\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      _v @typeName, 1, name, 'string'\n      _v @typeName, 2, css, 'object'\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      @themes = _uniqueSort @themes\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> _a 0, '`make` method not implemented by custom view', @typeName\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> _a 0, '`make` method not implemented by custom view', @typeName\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> _a 0, 'value getter not implemented', @typeName\n          set: (v) -> _a 0, 'value setter not implemented', @typeName\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.Text\n------------------------------------------------------------------------------\nText control\n\n    oj.Text = oj.createType 'Text',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Get tag name if provided\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @el = oj =>\n          oj[@tagName]()\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.Text.base.constructor.call @, options\n\n      properties:\n\nvalue: text value of this object (readwrite)\n\n        value:\n          get: -> @$el.ojValue()\n          set: (v) -> @$el.oj(v); return\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = oj.argumentShift(options, 'value') || args.join('\\n');\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\n\n\n\noj.Image\n------------------------------------------------------------------------------\noj.Image creates an `<img>` tag\n\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          ixNew = if ix < 0 then ix + count else ix\n          unless 0 <= ixNew and ixNew < count\n            throw new Error(\"oj.#{@typeName}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n          ixNew\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n          # ix defaults to -1 and is optional\n          if not ojml?\n            ojml = ix\n            ix = -1\n          ix = @_bound ix, @count+1, \".add: index\"\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix = -1) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = @$tdsRow(rx).toArray().map (el) -> $(el).ojValue()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          if not listOJML?\n            listOJML = rx\n            rx = -1\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          throw new Error('oj.addRow: expected array for row content') unless oj.isArray listOJML\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx = -1) ->\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> @$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          ixNew = if ix < 0 then ix + count else ix\n          unless 0 <= ixNew and ixNew < count\n            throw new Error(\"oj.#{@typeName}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n          ixNew\n\nCreate _Types\n------------------------------------------------------------------------------\n\n  Type with captital first letter that doesn't end in \"View\"\n\n    for typeName of oj\n      if _isCapitalLetter(typeName[0]) and typeName.slice(typeName.length - 4) != 'View'\n        oj[_getQuietTagName typeName] = _createQuietType typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if (key.length > 0 and key[0] != '_') or (key.length > 0 and key[0] == '_' and (oj[key.slice(1)])?)\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      _v 'use', 1, plugin, 'function'\n      _v 'use', 2, settings, 'object'\n\n      # Call plugin to gather extension map\n      pluginResult = plugin oj, settings\n\n      # Add _Type quiet types\n      pluginMap = _clone pluginResult\n      for name,value of pluginResult\n        if oj.isOJType value\n          pluginMap[_getQuietTagName name] = _createQuietType value.typeName\n\n      # Extend all properties\n      for name,value of pluginMap\n        # Add to oj\n        oj[name] = value\n\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqExtend(fn)\n-----------------------------------------------------------------------------\njQuery Extend\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqExtend = (options = {}) ->\n      options =  _extend get:_identity, set:_identity, first: false, options\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get oj.$(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set oj.$(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if oj.$('.' + _styleClassFromPlugin plugin).length == 0\n          oj.$('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    oj.$.fn.oj = _jqExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    oj.$.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:'deep', meta:1, title:'deep', link:'deep', script:'deep'\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj.compile: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      oj.$('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      if oj.isDOMText child\n      # Parse the text to turn it into bool, number, or string\n        text = oj.parse child.nodeValue\n\n      # Get elements as oj instances or elements\n      else if oj.isDOMElement child\n        if (inst = _getInstanceOnElement child)?\n          inst\n        else\n          child\n\n    oj.$.fn.ojValue = _jqExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    oj.$.fn.ojValues = _jqExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        oj.$.fn[ojName] = _jqExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","old_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\noj function\n-------------------------------------------------------------------------------\n\n  oj function acts like a tag method that doesn't emit\n  Using inline js so the function can be named\n\n    `function oj(){return oj.tag.apply(this, ['oj'].concat([].slice.call(arguments)).concat([{__quiet__:1}]));}`\n\n  Define oj version\n\n    oj.version = '0.2.0'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Store jQuery reference as either the global reference or as required through `jquery2`.\n  This allows this reference to be included as a script tag, included through npm, or overriden.\n\n    if typeof $ != 'undefined'\n      oj.$ = $\n    else if typeof require != 'undefined'\n      try\n        oj.$ = require 'jquery'\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      oj.$ ->\n        oj.$.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrP = Array.prototype\n    FunP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrP.slice\n    unshift = ArrP.unshift\n    concat = ArrP.concat\n\nType helper for oj types\n\n    oj.isOJ = `function(obj){return !!(obj != null ? obj.isOJ : void 0);}`\n\n    oj.isOJType = `function(obj){return oj.isOJ(obj) && obj.type === obj;}`\n\n    oj.isOJInstance = `function(obj){return oj.isOJ(obj) && !oj.isOJType(obj);}`\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isPlainObject = oj.$.isPlainObject\n    oj.isFunction = oj.$.isFunction\n    oj.isArray = oj.$.isArray\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = `function(c){return !!(c.match(\/[A-Z]\/));}`\n    _identity = `function(v){return v;}`\n    _has = `function(obj, key){return ObjP.hasOwnProperty.call(obj, key);}`\n    _keys = Object.keys\n    _values = `function(obj){var keys = _.keys(obj);var length = keys.length; var values = new Array(length); for (var i = 0; i < length; i++) {values[i] = obj[keys[i]]; } return values;}`\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      return obj unless (oj.isArray obj) or ((oj.typeOf obj) == 'object')\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n\n  _extend\n\n    _extend = oj.$.extend\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      r.map (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      throw new Error('oj.addMethod: string expected for second argument') unless oj.isString methodName\n      throw new Error('oj.addMethod: function expected for thrid argument') unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw new Error('oj.removeMethod: string expected for second argument') unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isPlainObject propInfo\n\nDefault properties to enumerable and configurable\n\n      propInfo = _extend {}, {\n        enumerable: true\n        configurable: true},\n        propInfo\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw new Error('oj.isProperty: string expected for second argument') unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, rest...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from rest by unioning all objects\n\n      {args, options:attributes} = oj.unionArguments rest\n\n      if isQuiet = attributes.__quiet__\n        delete attributes.__quiet__\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isPlainObject arg\n          continue\n\n        else if oj.isFunction arg\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to.\n  Do not emit when quiet is set,\n\n      oj._argsAppend(ojml) unless isQuiet\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      oj.tag.elements.open.indexOf(tag) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Get quiet tag name\n\n    _getQuietTagName = (tag) ->\n      '_' + tag\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n\n  Tag functions emit by default\n\n        oj[t] = -> oj.tag t, arguments...\n\n  Underscore tag functions do not emit\n\n        qt = _getQuietTagName t\n        oj[qt] = -> oj.tag t, {__quiet__:1}, arguments...\n\n  Record the tag name so the OJML syntax can use the function instead of a string\n\n        _setTagName oj[t], t\n        _setTagName oj[qt], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extendInto (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.useGlobally = oj.extendInto = (context = root) ->\n\n      o = {}\n      for k,v of oj\n        if k[0] != '_' and k != 'extendInto' and k != 'useGlobally'\n          o[k] = v\n\n  Export _tag and _Type methods\n\n          qn = _getQuietTagName k\n          if oj[qn]\n            o[qn] = oj[qn]\n\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* minify - Minify js and css\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _extend\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        minify: false\n        ignore: {}\n        options\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, minify: options.minify, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      options = _extend\n        inline: true\n        indent: ''\n        options\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isPlainObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = mediaParts.map (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.minify then '' else '\\n'\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if (!minify) and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if (!minify) then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\nminify:false will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        # when 'jquery'\n        #   options.html?.push ojml.html()\n        #   options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML(options)\n            options.dom?.appendChild ojml.toDOM(options)\n            if options.css?\n              _extend options.css, ojml.toCSSMap(options)\n\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isPlainObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        throw new Error('oj.compile: doctype expects string as first argument') unless oj.isString ojml[1]\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isPlainObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip indention if there is only one child\n          if !options.minify and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if (!options.minify) and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isPlainObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isPlainObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Supported events from jquery\n    jqueryEvents = `{bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mouseleave:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1}`\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isPlainObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if oj.$?\n          if oj.isArray ev\n            oj.$(el)[ek].apply @, ev\n          else\n            oj.$(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isPlainObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isPlain options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n_inherit\n------------------------------------------------------------------------------\nBased on, but sadly incompatable with, coffeescript inheritance\n\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n_construct(Type, arg1, arg2, ...)\n------------------------------------------------------------------------------\nConstruct with specified arguments. This is only necessary because new doesn't support apply\/call directly.\n\n    _construct = (Type) ->\n      new (FunP.bind.apply(Type, arguments));\n\noj.argumentShift\n------------------------------------------------------------------------------\nHelper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isPlainObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isPlainObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSort Out::properties.concat propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSort Out::methods.concat methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isPlainObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        has: (k) ->\n          @properties.some (v) -> v == k\n\n        # can: Determine if method exists\n        can: (k) ->\n          @methods.some (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isPlainObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\n_createQuietType\n-------------------------------------------------------------------------------\n\n    _createQuietType = (typeName) ->\n      oj[_getQuietTagName typeName] = ->\n        _construct oj[typeName], arguments..., __quiet__:1\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw new Error 'oj.enum: NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: ->\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        {options,args} = oj.unionArguments arguments\n\n        # Emit as a tag if new wasn't called or quiet is not set\n        if @.__autonew__ and not options.__quiet__\n          @emit()\n\n        # Remove quiet flag\n        if options.__quiet__?\n          delete options.__quiet__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _clone options\n        @properties.forEach (v) -> delete options[v]\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = oj.$ @el)\n\n        # Get and set id attribute of view\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # # Get and set class attribute of view\n        # class:\n        #   get: -> @$el.attr 'class'\n        #   set: (v) ->\n        #     # Join arrays with spaces\n        #     if oj.isArray v\n        #       v = v.join ' '\n        #     @$el.attr 'class', v\n        #     return\n\n        # Alias for classes\n        # c:\n        #   get: -> @class\n        #   set: (v) -> @class = v; return\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          slice.call(@el.attributes).forEach (attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all classes as an array (readwrite)\n        classes:\n          get: ->\n            @$el.attr('class').split(\/\\s+\/)\n          set: (v) ->\n            @$el.attr('class', v.join(' '))\n            return\n\n        # Get \/ set all currently set themes (readwrite)\n        themes:\n          get: ->\n            thms = []\n            prefix = 'theme-'\n            for cls in @classes\n              if cls.indexOf(prefix) == 0\n                thms.push cls.slice prefix.length\n            thms\n\n          set: (v) ->\n            v = [v] unless oj.isArray v\n            @clearThemes()\n            for theme in v\n              @addTheme theme\n            return\n\n        theme:\n          get: -> @themes\n          set: (v) -> @themes = v; return\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isPlainObject attr\n            for k,v of attr\n              if k == 'class'\n                @addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single class\n        addClass: (name) ->\n          @$el.addClass name\n          return\n\n        # Remove a single class\n        removeClass: (name) ->\n          @$el.removeClass name\n          return\n\n        # Determine if class is applied\n        hasClass: (name) ->\n          @$el.hasClass name\n\n        # Add a single theme\n        addTheme: (name) ->\n          @addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @removeClass \"theme-#{name}\"\n          return\n\n        # Determine if theme is applied\n        hasTheme: (name) ->\n          @hasClass \"theme-#{name}\"\n\n        # Clear all themes\n        clearThemes: ->\n          for theme in @themes\n            @removeTheme theme\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.minify then '' else '\\n')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (options) -> _cssFromPluginObject (_flattenCSSMap @cssMap), _extend({}, minify:options.minify, tags:0)\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      throw new Error(\"oj.#{@typeName}.css: object or string expected for first argument\") unless oj.isString(css) or oj.isPlainObject(css)\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      throw new Error(\"oj.#{@typeName}.theme: string expected for first argument (theme name)\") unless oj.isString name\n      throw new Error(\"oj.#{@typeName}.css: object expected for second argument\") unless oj.isPlainObject(css)\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      @themes = _uniqueSort @themes\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.Text\n------------------------------------------------------------------------------\nText control\n\n    oj.Text = oj.createType 'Text',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Get tag name if provided\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @el = oj =>\n          oj[@tagName]()\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.Text.base.constructor.call @, options\n\n      properties:\n\nvalue: text value of this object (readwrite)\n\n        value:\n          get: -> @$el.ojValue()\n          set: (v) -> @$el.oj(v); return\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = oj.argumentShift(options, 'value') || args.join('\\n');\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\n\n\n\noj.Image\n------------------------------------------------------------------------------\noj.Image creates an `<img>` tag\n\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          ixNew = if ix < 0 then ix + count else ix\n          unless 0 <= ixNew and ixNew < count\n            throw new Error(\"oj.#{@typeName}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n          ixNew\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n          # ix defaults to -1 and is optional\n          if not ojml?\n            ojml = ix\n            ix = -1\n          ix = @_bound ix, @count+1, \".add: index\"\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix = -1) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = @$tdsRow(rx).toArray().map (el) -> $(el).ojValue()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          if not listOJML?\n            listOJML = rx\n            rx = -1\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          throw new Error('oj.addRow: expected array for row content') unless oj.isArray listOJML\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx = -1) ->\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> @$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          ixNew = if ix < 0 then ix + count else ix\n          unless 0 <= ixNew and ixNew < count\n            throw new Error(\"oj.#{@typeName}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n          ixNew\n\nCreate _Types\n------------------------------------------------------------------------------\n\n  Type with captital first letter that doesn't end in \"View\"\n\n    for typeName of oj\n      if _isCapitalLetter(typeName[0]) and typeName.slice(typeName.length - 4) != 'View'\n        oj[_getQuietTagName typeName] = _createQuietType typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if (key.length > 0 and key[0] != '_') or (key.length > 0 and key[0] == '_' and (oj[key.slice(1)])?)\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isPlain settings\n\n      # Call plugin to gather extension map\n      pluginResult = plugin oj, settings\n\n      # Add _Type quiet types\n      pluginMap = _clone pluginResult\n      for name,value of pluginResult\n        if oj.isOJType value\n          pluginMap[_getQuietTagName name] = _createQuietType value.typeName\n\n      # Extend all properties\n      for name,value of pluginMap\n        # Add to oj\n        oj[name] = value\n\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      options =  _extend get:_identity, set:_identity, first: false, options\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get oj.$(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set oj.$(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if oj.$('.' + _styleClassFromPlugin plugin).length == 0\n          oj.$('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    oj.$.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    oj.$.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:'deep', meta:1, title:'deep', link:'deep', script:'deep'\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj.compile: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      oj.$('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    oj.$.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    oj.$.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        oj.$.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"39e0b03aa8825f0de8a871dcf9bf6911ed09db64","subject":"Remove debug console.log message","message":"Remove debug console.log message\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/routes\/api_v1.litcoffee","new_file":"src\/routes\/api_v1.litcoffee","new_contents":"    express = require 'express'\n    multer  = require 'multer'\n    async   = require 'async'\n    dms2dec = require 'dms2dec'\n\n    sentry  = require '..\/sentry'\n    librato = require '..\/librato'\n    s3      = require '..\/upload'\n\nMake a new Express router object for this part of the application.\n\n    api = express.Router()\n\n## Metrics\n\nAgregate metrics for all requests and wheter they succeded (`finish`) or closed\nbefore the request succeeded (`close`).\n\n    api.use (req, res, next) ->\n      librato.logRequest req.method\n\n      res.once 'close', ->\n        librato.logResponse 'closed'\n        sentry.captureResClose res\n\n      res.once 'finish', ->\n        librato.logResponse res.statusCode\n\n      next()\n\n## GET \/\n\n    api.get '\/', (req, res, next) ->\n      res.status(204).end()\n\n## POST \/upload\n\nConfigure [multer](https:\/\/github.com\/expressjs\/multer) to store files in the\nOS's temorary directory `tempdir()`. This way we should not need to clean up the\nuploaded files since that should be the job of the OS.\n\n    multer = require('multer')\n      putSingleFilesInArray: true\n      dest: require('os').tmpdir()\n\nConfigure the `\/upload` route handler.\n\n    api.post '\/upload', multer, (req, res, next) ->\n      librato.logImagesUploaded Object.keys req.files\n\n      files = []\n      for key, f of req.files\n        files.push file for file in f\n\n      async.mapSeries files, (file, cb) ->\n        if file.extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif']\n          error = new Error \"Invalid Image #{file.extension}\"\n          error.status = 422\n          return cb error\n\n        t1 = new Date().getTime()\n        s3.upload file.path, {}, (err, images, meta) ->\n          return cb err if err\n\n          librato.logImageProcessingTime t1, new Date().getTime()\n\nFormat image GeoJSON correctly if the image has GPS properties.\n\n          if meta.exif?.GPSLatitude and meta.exif?.GPSLongitude\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif.GPSLatitude, \\\n                meta.exif.GPSLatitudeRef, \\\n                meta.exif.GPSLongitude, \\\n                meta.exif.GPSLongitudeRef\n              .reverse()\n\nWe need to remove the original image (index i - 1) since it is not publicly\naccessible. It gets uploaded to AWS as backup of the original image.\n\n          images = images.splice 0, images.length - 1\n\nLoop over all the generated images and apply `width` and `height` properties\nsince that is currently not set correctly. We also remove some image information\nsuch as AWS key and local path which are not in use.\n\n          for image in images\n            # Since we\n            if not image.width\n              image.height = image.maxHeight\n              image.width = image.maxWidth\n\n              if image.aspect\n                image.height = Math.floor image.maxHeight * 2 \/ 3\n              else\n                if meta.height > meta.width\n                  image.width = Math.floor image.height * meta.width \/ meta.height\n                else\n                  image.height = Math.floor image.width * meta.height \/ meta.width\n\n            image.key       = undefined\n            image.maxHeight = undefined\n            image.maxWidth  = undefined\n            image.path      = undefined\n            image.suffix    = undefined\n\n          return cb null, versions: images, meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    module.exports = api\n\n","old_contents":"    express = require 'express'\n    multer  = require 'multer'\n    async   = require 'async'\n    dms2dec = require 'dms2dec'\n\n    sentry  = require '..\/sentry'\n    librato = require '..\/librato'\n    s3      = require '..\/upload'\n\nMake a new Express router object for this part of the application.\n\n    api = express.Router()\n\n## Metrics\n\nAgregate metrics for all requests and wheter they succeded (`finish`) or closed\nbefore the request succeeded (`close`).\n\n    api.use (req, res, next) ->\n      librato.logRequest req.method\n\n      res.once 'close', ->\n        librato.logResponse 'closed'\n        sentry.captureResClose res\n\n      res.once 'finish', ->\n        librato.logResponse res.statusCode\n\n      next()\n\n## GET \/\n\n    api.get '\/', (req, res, next) ->\n      res.status(204).end()\n\n## POST \/upload\n\nConfigure [multer](https:\/\/github.com\/expressjs\/multer) to store files in the\nOS's temorary directory `tempdir()`. This way we should not need to clean up the\nuploaded files since that should be the job of the OS.\n\n    multer = require('multer')\n      putSingleFilesInArray: true\n      dest: require('os').tmpdir()\n\nConfigure the `\/upload` route handler.\n\n    api.post '\/upload', multer, (req, res, next) ->\n      librato.logImagesUploaded Object.keys req.files\n\n      files = []\n      for key, f of req.files\n        files.push file for file in f\n\n      async.mapSeries files, (file, cb) ->\n        if file.extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif']\n          error = new Error \"Invalid Image #{file.extension}\"\n          error.status = 422\n          return cb error\n\n        t1 = new Date().getTime()\n        s3.upload file.path, {}, (err, images, meta) ->\n          return cb err if err\n\n          librato.logImageProcessingTime t1, new Date().getTime()\n\nFormat image GeoJSON correctly if the image has GPS properties.\n\n          if meta.exif?.GPSLatitude and meta.exif?.GPSLongitude\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif.GPSLatitude, \\\n                meta.exif.GPSLatitudeRef, \\\n                meta.exif.GPSLongitude, \\\n                meta.exif.GPSLongitudeRef\n              .reverse()\n\nWe need to remove the original image (index i - 1) since it is not publicly\naccessible. It gets uploaded to AWS as backup of the original image.\n\n          images = images.splice 0, images.length - 1\n\nLoop over all the generated images and apply `width` and `height` properties\nsince that is currently not set correctly. We also remove some image information\nsuch as AWS key and local path which are not in use.\n\n          for image in images\n            # Since we\n            if not image.width\n              image.height = image.maxHeight\n              image.width = image.maxWidth\n\n              if image.aspect\n                image.height = Math.floor image.maxHeight * 2 \/ 3\n              else\n                if meta.height > meta.width\n                  image.width = Math.floor image.height * meta.width \/ meta.height\n                else\n                  image.height = Math.floor image.width * meta.height \/ meta.width\n\n            image.key       = undefined\n            image.maxHeight = undefined\n            image.maxWidth  = undefined\n            image.path      = undefined\n            image.suffix    = undefined\n\n            console.log image\n\n          return cb null, versions: images, meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    module.exports = api\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"44c5a8a340721137157448a896d807468233eb6c","subject":"Improved descripton","message":"Improved descripton\n","repos":"erikdiessel\/plidoc,erikdiessel\/plidoc","old_file":"docco.litcoffee","new_file":"docco.litcoffee","new_contents":"pliDoc - literate programming at its best\n=========================================\n\nTL;DR\n-----\npliDoc is a node tool which generates literate-programming documents in \n*every* programming language.\n\n> What does this name mean ?\n\n'Pli' is the [Esperanto] (http:\/\/en.wikipedia.org\/wiki\/Esperanto) word for 'more'\nand 'Doc' stands for Documentation.\n\n> Does this mean that I have to learn Esperanto to use pliDoc ?\n\nNo, this Esperanto word just shows, that pliDoc can be used to do literate \nprogramming in *any* programming language from 'A' like 'Ada' to 'Y' like 'YAML'\nand makes it easy to write *more* and *better* documentation.\n\n> So what does pliDoc for me ?\n\npliDoc generates documentation from markdown comments in a source file. The source\nis highlighted and the nicely rendered documentation is placed in between.\npliDoc is based on [Docco] (http:\/\/github.com\/jashkenas\/docco).\n\nWhat makes pliDoc better than Docco ?\n-----------------------------------\nWhile Docco does what it does in a quick and dirty way, there are some things\nmissing in its feature set:\n- Seperate code *comments* from literate programming style *descriptions* by\n  using different tags to denote them.\n- Use multiline comments for the documentation.\n- Include Mathjax to directly support mathematics with Latex-equations \n  and make it markdown compatible.\n- Pack documentation in *one* single html-document, including all css-assets,\n  fonts, etc. This is helpful e.g. for code reviews, since you then only have\n  to send one single file instead of a whole zip file.\n        \n\nDocumentation of the original\n============================\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* For all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\nWe need a way to search for arbitrary strings, so we need a function which creates\na regex to search this substring in a string . For this, we need to escape the string,\nsee [this stackoverflow question](http:\/\/stackoverflow.com\/questions\/3561493). \n\n    parse = (source, code, config = {languages: {}}) ->\n      sections = []\n      lang     = getLanguage source, config\n\n      string_regex = (s) ->\n        return new RegExp(s.replace(\/[-\\\/\\\\^$*+?.()|[\\]{}]\/g, '\\\\$&'))\n\n      get_description_end = (i) ->\n        end = code.substring(i).search(string_regex(lang.descriptionEndTag))\n        return if end == -1 then -1 else i + end\n          \n      get_code_end = (i) ->\n        end = code.substring(i).search(string_regex(lang.descriptionStartTag))\n        return if end == -1 then -1 else i + end\n\n      index = get_code_end(0)\n      # Save eventual trailing code\n      sections.push({docsText: \"\", codeText: code.substring(0, index)})\n      \n      while index != -1\n        description_end = get_description_end(index)\n        # offset index to exclude the tag from the output\n        description_chunk = code.substring(index + lang.descriptionEndTag.length, description_end)\n        code_end = get_code_end(description_end)\n        if code_end == -1 \n          code_end = undefined # => code ends when file ends \n          index = -1 # => finished, exit loop\n        else\n          # Set the next index to the end of the code\n          index = code_end\n          \n        code_chunk = code.substring(description_end + lang.descriptionEndTag.length, code_end)\n          .replace(\/^(\\s*\\n)+\/, '')\n          .replace(\/(\\s*\\n*)+$\/, '')   # exclude trailing newlines (also with included spaces)\n          \n        # Save description and code together in one section\n        sections.push({docsText: description_chunk, codeText: code_chunk})\n          \n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n\nTell Marked how to highlight code blocks within comments, treating that code\nas either the language specified in the code block or the language of the file\nif not specified.\n\n      marked.setOptions {\n        highlight: (code, lang) ->\n          lang or= language.name\n\n          if highlightjs.getLanguage(lang)\n            highlightjs.highlight(lang, code).value\n          else\n            console.warn \"docco: couldn't highlight code block with unknown language '#{lang}' in #{source}\"\n            code\n      }\n\n      for section, i in sections\n        code = highlightjs.highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      config.languages = buildMatchers config.languages\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    highlightjs = require 'highlight.js'\n\nEnable nicer typography with marked.\n\n    marked.setOptions smartypants: yes\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [file]', 'use a custom languages.json', _.compose JSON.parse, fs.readFileSync)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","old_contents":"pliDoc\n=======\n\n> What does this name mean ?\n\n'Pli' is the [Esperanto] (http:\/\/en.wikipedia.org\/wiki\/Esperanto) word for 'more'\nand 'Doc' stands for Documentation.\n\n> Does this mean that I have to learn Esperanto to use pliDoc ?\n\nNo, this Esperanto word just shows, that pliDoc can be used to do literate \nprogramming in *any* programming language from 'A' like 'Ada' to 'Y' like 'YAML'\nand makes it easy to write *more* and *better* documentation.\n\n> So what does pliDoc for me ?\n\npliDoc generates documentation from markdown comments in a source file. The source\nis highlighted and the nicely rendered documentation is placed in between.\npliDoc is based on [Docco] (http:\/\/github.com\/jashkenas\/docco).\n\nWhat makes pliDoc better than Docco ?\n-----------------------------------\nWhile Docco does what it does in a quick and dirty way, there are some things\nmissing in its feature set:\n- Seperate code *comments* from literate programming style *descriptions* by\n  using different tags to denote them.\n- Use multiline comments for the documentation.\n- Include Mathjax to directly support mathematics with Latex-equations \n  and make it markdown compatible.\n- Pack documentation in *one* single html-document, including all css-assets,\n  fonts, etc. This is helpful e.g. for code reviews, since you then only have\n  to send one single file instead of a whole zip file.\n        \n\nDocumentation of the original\n============================\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* For all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\nWe need a way to search for arbitrary strings, so we need a function which creates\na regex to search this substring in a string . For this, we need to escape the string,\nsee [this stackoverflow question](http:\/\/stackoverflow.com\/questions\/3561493). \n\n    parse = (source, code, config = {languages: {}}) ->\n      sections = []\n      lang     = getLanguage source, config\n\n      string_regex = (s) ->\n        return new RegExp(s.replace(\/[-\\\/\\\\^$*+?.()|[\\]{}]\/g, '\\\\$&'))\n\n      get_description_end = (i) ->\n        end = code.substring(i).search(string_regex(lang.descriptionEndTag))\n        return if end == -1 then -1 else i + end\n          \n      get_code_end = (i) ->\n        end = code.substring(i).search(string_regex(lang.descriptionStartTag))\n        return if end == -1 then -1 else i + end\n\n      index = get_code_end(0)\n      # Save eventual trailing code\n      sections.push({docsText: \"\", codeText: code.substring(0, index)})\n      \n      while index != -1\n        description_end = get_description_end(index)\n        # offset index to exclude the tag from the output\n        description_chunk = code.substring(index + lang.descriptionEndTag.length, description_end)\n        code_end = get_code_end(description_end)\n        if code_end == -1 \n          code_end = undefined # => code ends when file ends \n          index = -1 # => finished, exit loop\n        else\n          # Set the next index to the end of the code\n          index = code_end\n          \n        code_chunk = code.substring(description_end + lang.descriptionEndTag.length, code_end)\n          .replace(\/^(\\s*\\n)+\/, '')\n          .replace(\/(\\s*\\n*)+$\/, '')   # exclude trailing newlines (also with included spaces)\n          \n        # Save description and code together in one section\n        sections.push({docsText: description_chunk, codeText: code_chunk})\n          \n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n\nTell Marked how to highlight code blocks within comments, treating that code\nas either the language specified in the code block or the language of the file\nif not specified.\n\n      marked.setOptions {\n        highlight: (code, lang) ->\n          lang or= language.name\n\n          if highlightjs.getLanguage(lang)\n            highlightjs.highlight(lang, code).value\n          else\n            console.warn \"docco: couldn't highlight code block with unknown language '#{lang}' in #{source}\"\n            code\n      }\n\n      for section, i in sections\n        code = highlightjs.highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      config.languages = buildMatchers config.languages\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    highlightjs = require 'highlight.js'\n\nEnable nicer typography with marked.\n\n    marked.setOptions smartypants: yes\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [file]', 'use a custom languages.json', _.compose JSON.parse, fs.readFileSync)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"aba2f45468fa4e110faea38f54afa2e4b9d2249e","subject":"oneof","message":"oneof\n","repos":"vpj\/models","old_file":"js\/properties\/oneof.litcoffee","new_file":"js\/properties\/oneof.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#OneOf\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Models.Models'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, MODELS, WeyaBase, Weya) ->\n\n\nClass\n\n      class OneOf extends Base\n       @extend()\n\n       propertyType: 'oneof'\n\n       @default 'oneof', ['Null']\n       @default 'default', ->\n        return null if @schema.oneof.length is 0\n        model = new (MODELS.get @schema.oneof[0])\n        r = model.parse @schema.defaultValues.call this\n        return r.value\n\n       @default 'defaultValues', -> {}\n\n       @default 'isDefault', (value) ->\n        return true if @schema.oneof.length is 0\n        model = new (MODELS.get @schema.oneof[0])\n        model.parse value\n        model.isDefault()\n\n       @isValidSchema: (schema) ->\n        return false if not super schema\n        return false if not schema.oneof?\n        return true\n\n       parse: (data, stack) ->\n        r = super data, stack\n        return r unless r is true\n\n        res = @error 'invalid'\n        for type in @schema.oneof\n         m = new (MODELS.get type)\n         r = m.parse data, stack\n         if res.score < r.score\n          res = r\n\n        return res\n\n       toJSON: (value, stack) -> value.toJSON stack\n       toJSONFull: (value, stack) -> value.toJSONFull stack\n\n       edit: (elem, value, onChanged, stack) ->\n        new Edit this, elem, value, onChanged, stack\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, onChanged, stack) ->\n        @property = property\n        @elems =\n         parent: elem\n        @model = value\n        @onChanged = onChanged\n        @stack = stack\n        @render()\n\n       render: ->\n        Weya elem: @elems.parent, context: this, ->\n         @$.elems.controls = @div \".oneof-controls\", ->\n          @$.elems.type = @select on: {change: @$.on.typeChange}, ->\n           for type in @$.property.schema.oneof\n            @option value: type, type\n\n         @$.elems.model = @div \".model\", null\n\n        if @property.schema.oneof.length <= 1\n         @elems.controls.style.display = 'none'\n\n        @renderModel()\n\n       @listen 'typeChange', (e) ->\n        type = @elems.type.value\n        return if type is @model.type\n        json = @model.toJSON stack\n        @model = new (MODELS.get type)\n        r = @model.parse json, stack\n        @onChanged @model, true\n        @renderModel()\n\n       renderModel: ->\n        @elems.model.innerHTML = ''\n        @elems.type.value = @model.type\n        @model.edit @elems.model,\n         @modelChanged.bind this\n         @stack\n\n       modelChanged: (value) ->\n        @onChanged value, false\n\n\n\n\n\n      PROPERTIES.register 'oneof', OneOf\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#OneOf\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Models.Models'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, MODELS, WeyaBase, Weya) ->\n\n\nClass\n\n      class OneOf extends Base\n       @extend()\n\n       propertyType: 'oneof'\n\n       @default 'oneof', ['Null']\n       @default 'default', ->\n        return null if @schema.oneof.length is 0\n        model = new (MODELS.get @schema.oneof[0])\n        r = model.parse @schema.defaultValues.call this\n        return r.value\n\n       @default 'defaultValues', -> {}\n\n       @default 'isDefault', (value) ->\n        return true if @schema.oneof.length is 0\n        model = new (MODELS.get @schema.oneof[0])\n        model.parse value\n        model.isDefault()\n\n       @isValidSchema: (schema) ->\n        return false if not super schema\n        return false if not schema.oneof?\n        return true\n\n       parse: (data) ->\n        r = super data\n        return r unless r is true\n\n        res =\n         score: 0\n         errors: ['invalid']\n         value: @schema.default.call this\n        for type in @schema.oneof\n         m = new (MODELS.get type)\n         r = m.parse data\n         if res.score < r.score\n          res = r\n\n        return res\n\n       toJSON: (value) -> value.toJSON()\n       toJSONFull: (value) -> value.toJSONFull()\n\n       edit: (elem, value, changed) ->\n        new Edit this, elem, value, changed\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, changed) ->\n        @property = property\n        @elems =\n         parent: elem\n        @model = value\n        @onChanged = changed\n        @render()\n\n       render: ->\n        Weya elem: @elems.parent, context: this, ->\n         @$.elems.controls = @div \".oneof-controls\", ->\n          @$.elems.type = @select on: {change: @$.on.typeChange}, ->\n           for type in @$.property.schema.oneof\n            @option value: type, type\n\n         @$.elems.model = @div \".model\", null\n\n        if @property.schema.oneof.length <= 1\n         @elems.controls.style.display = 'none'\n\n        @renderModel()\n\n       @listen 'typeChange', (e) ->\n        type = @elems.type.value\n        return if type is @model.type\n        json = @model.toJSON()\n        @model = new (MODELS.get type)\n        r = @model.parse json\n        @onChanged @model, true\n        @renderModel()\n\n       renderModel: ->\n        @elems.model.innerHTML = ''\n        @elems.type.value = @model.type\n        @model.edit @elems.model, @modelChanged.bind this\n\n       modelChanged: (value) ->\n        @onChanged value, false\n\n\n\n\n\n      PROPERTIES.register 'oneof', OneOf\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"80dee3e592ad80482adeb39843d1fff51bc5289e","subject":"Switch up defineview wording a bit","message":"Switch up defineview wording a bit\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif\n\n`data-renderif` defers parsing of a node's child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","old_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the innerHTML of an element should be used for rendering the given view.\nThis is especially useful for defining multiple views in one HTML file.\n\nThe value follows Rails-style \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif\n\n`data-renderif` defers parsing of a node's child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0bae317ee32f49e65dfe41cfa0a549d428af2823","subject":"Formatting","message":"Formatting\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"dox.litcoffee","new_file":"dox.litcoffee","new_contents":"\n    fs = require 'fs'\n    path = require 'path'\n    {Transform} = require 'stream'\n\n    _ = require 'lodash'\n    {LineStream} = require 'byline'\n    glob = require 'grunt\/node_modules\/glob'\n    Promise = require 'bluebird'\n\n    class HookInvocations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Invoke hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\n    class HookImplementations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Implements hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\n    class Todos extends Transform\n\n      @context = 4\n\n      constructor: ->\n        super\n\n        @lines = []\n        @todos = []\n\n      _transform: (chunk, encoding, done) ->\n        @lines.push line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\#\\#\\# TODO\/\n          @todos.push @lines.length - 1\n\n        done()\n\n      withContext: ->\n\n        for todo in @todos\n\n          start = Math.max 0, todo - Todos.context\n          end = Math.min @lines.length - 1, todo + Todos.context\n\n          index: todo\n          lines: @lines.slice start, end\n\n    _getFiles = (spec) ->\n      new Promise (resolve, reject) ->\n        glob(\n          '{{client,custom,packages,server}\/**\/*.litcoffee,*.litcoffee}'\n          (error, files) ->\n            return reject error if error?\n            resolve files\n        )\n\n    _getFilesByType = (spec) -> _getFiles(spec).then (files) ->\n\n      client = []\n      server = []\n\n      for file in files\n        parts = file.split '\/'\n\n        if parts[0] is 'client'\n          client.push file\n        else if parts[0] is 'custom' and parts[2] is 'client'\n          client.push file\n        else if parts[0] is 'packages' and parts[2] is 'client'\n          client.push file\n        else\n          server.push file\n\n      client: client, server: server\n\n    _hookToId = (hook) -> hook.replace(\n      \/[^0-9A-Za-z-]+\/g, '-'\n    ).toLowerCase()\n\n    _removeExtension = (filename) ->\n\n        dirname = path.dirname filename\n        if dirname is '.' then dirname = '' else dirname += '\/'\n        extname = path.extname filename\n        filename = \"#{dirname}#{path.basename filename, extname}\"\n\n        parts = filename.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'index'\n        return parts.join '\/'\n\n    fileStatsListPromise = _getFilesByType().then (allFiles) ->\n\n      allFilesPromises = for type, files of allFiles\n\n        typePromises = for file in files\n\n          do (type, file) -> new Promise (resolve, reject) ->\n\n            fstream = fs.createReadStream file\n            fstream.pipe lineStream = new LineStream keepEmptyLines: true\n\n            lineStream.pipe hookImplementations = new HookImplementations()\n            lineStream.pipe hookInvocations = new HookInvocations()\n            lineStream.pipe todos = new Todos()\n\n            fstream.on 'error', reject\n\n            fstream.on 'end', ->\n              resolve(\n                type: type\n                file: file\n                implementations: hookImplementations.list\n                invocations: hookInvocations.list\n                todos: todos.withContext()\n              )\n\n        Promise.all typePromises\n\n      Promise.all(allFilesPromises).then (fileStatsLists) ->\n        _.flatten fileStatsLists\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      hooksIndex = {}\n      implementations = {}\n      invocations = {}\n\n      for fileStats in fileStatsList\n\n        for implementation in fileStats.implementations\n          impl = implementations[implementation] ?= {}\n          (impl[fileStats.file] ?= []).push fileStats.type\n\n          hooksIndex[implementation] = true\n\n        for invocation in fileStats.invocations\n          invo = invocations[invocation] ?= {}\n          (invo[fileStats.file] ?= []).push fileStats.type\n\n          hooksIndex[invocation] = true\n\n      for hook, stats of implementations\n        for file of stats\n          stats[file] = _.unique stats[file] ? []\n\n      for hook, stats of invocations\n        for file of stats\n          stats[file] = _.unique stats[file] ? []\n\n      hooks = (hook for hook of hooksIndex).sort()\n\n      hookFiles = {}\n      for hook in hooks\n        hookFiles[hook] = try\n          fs.readFileSync \"docs\/hook\/#{hook}.md\", 'utf8'\n        catch error\n          ''\n\n      hookFiles: hookFiles\n      hooks: hooks\n      implementations: implementations\n      invocations: invocations\n\n    ).then(({hookFiles, hooks, implementations, invocations}) ->\n\n      render = '''\n    # Hook system\n\n    Hooks are how Shrub allows packages to implement (or invoke) dynamic\n    behavior. Hooks can also serve as a form of message passing between\n    packages.\n\n    To implement a hook, export a `pkgmanRegister` method which takes a\n    `registrar` argument, and use the registrar to register your hook:\n\n    ```javascript\n\n    exports.pkgmanRegister = function(registrar) {\n\n      registrar.registerHook('someHook', function() {\n        doStuff();\n      }\n\n      registrar.registerHook('someOtherHook', function(arg) {\n        doOtherStuffWith(arg);\n      }\n    }\n\n    ```\n\n    To invoke a hook, require `pkgman` and use the `invoke` method:\n\n    ```javascript\n\n    var pkgman = require('pkgman');\n\n    var results = pkgman.invoke('someOtherHook', arg);\n\n    ```\n\n    Any arguments following the hook name will be passed along to the\n    implementations. Hooks are invoked synchronously. For more information\n    about `pkgman`, see\n\n    ###### TODO: Link to `pkgman` documentation when complete.\n\n    '''\n\n      for hook in hooks\n\n        render += \"## #{hook}\\n\\n\"\n        render += hookFiles[hook] + '\\n\\n' if hookFiles[hook]\n\n        if implementations[hook]?\n\n          implementationCount = Object.keys(implementations[hook]).length\n          render += \"### #{implementationCount} implementation(s)\\n\\n\"\n\n          for file, types of implementations[hook]\n\n            file = _removeExtension file\n\n            types = types.map (type) -> \"[#{type}](source\/#{file}#implements-hook-#{hook.toLowerCase()})\"\n\n            render += \"* #{file} (#{types.join ','})\\n\"\n\n          render += '\\n'\n\n        if invocations[hook]?\n\n          invocationCount = Object.keys(invocations[hook]).length\n          render += \"### #{invocationCount} invocation(s)\\n\\n\"\n\n          for file, types of invocations[hook]\n\n            file = _removeExtension file\n\n            types = types.map (type) -> \"[#{type}](source\/#{file}#invoke-hook-#{hook.toLowerCase()})\"\n\n            render += \"* #{file} (#{types.join ','})\\n\"\n\n          render += '\\n'\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/hooks.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      render = '''\n      # TODO list\n\n      Shrub &mdash; like any project &mdash; always presents a path for improvement. This\n      is a dynamically generated list of TODO items, each with context.\n\n      '''\n\n      for fileStats in fileStatsList\n\n        idMap = {}\n\n        for todo in fileStats.todos\n\n          render += '\\n'\n\n          id = ''\n          for line, index in todo.lines\n            render += '>'\n\n            if index is Todos.context\n              id = _hookToId(line).slice 1, -1\n\n              render += line.slice 4\n            else\n              render += \" #{line}\"\n            render += '\\n'\n\n          render += '\\n'\n\n          filename = _removeExtension fileStats.file\n\n          if idMap[id]?\n            idMap[id] += 1\n            id += \"_#{idMap[id]}\"\n          else\n            idMap[id] = 0\n\n          render += \"###### the above found in [#{fileStats.file}:#{todo.index}](source\/#{filename}##{id})\\n\"\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/todos.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\n    _getFiles().then (files) ->\n\n      yml = fs.readFileSync 'docs\/mkdocs.yml.template', 'utf8'\n\n      for file in files\n        parts = file.split '\/'\n\n        for i in [0...parts.length]\n          try\n            fs.mkdirSync \"docs\/source\/#{parts.slice(0, i).join '\/'}\"\n          catch error\n\n        fs.createReadStream(file).pipe(\n          fs.createWriteStream(\"docs\/source\/#{file}\")\n        )\n\n        yml += \"- [source\/#{file}, 'Source code', '#{file}']\\n\"\n\n      fs.writeFileSync 'mkdocs.yml', yml\n\n      return\n","old_contents":"\n    fs = require 'fs'\n    path = require 'path'\n    {Transform} = require 'stream'\n\n    _ = require 'lodash'\n    {LineStream} = require 'byline'\n    glob = require 'grunt\/node_modules\/glob'\n    Promise = require 'bluebird'\n\n    class HookInvocations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Invoke hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\n    class HookImplementations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Implements hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\n    class Todos extends Transform\n\n      @context = 4\n\n      constructor: ->\n        super\n\n        @lines = []\n        @todos = []\n\n      _transform: (chunk, encoding, done) ->\n        @lines.push line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\#\\#\\# TODO\/\n          @todos.push @lines.length - 1\n\n        done()\n\n      withContext: ->\n\n        for todo in @todos\n\n          start = Math.max 0, todo - Todos.context\n          end = Math.min @lines.length - 1, todo + Todos.context\n\n          index: todo\n          lines: @lines.slice start, end\n\n    _getFiles = (spec) ->\n      new Promise (resolve, reject) ->\n        glob(\n          '{{client,custom,packages,server}\/**\/*.litcoffee,*.litcoffee}'\n          (error, files) ->\n            return reject error if error?\n            resolve files\n        )\n\n    _getFilesByType = (spec) -> _getFiles(spec).then (files) ->\n\n      client = []\n      server = []\n\n      for file in files\n        parts = file.split '\/'\n\n        if parts[0] is 'client'\n          client.push file\n        else if parts[0] is 'custom' and parts[2] is 'client'\n          client.push file\n        else if parts[0] is 'packages' and parts[2] is 'client'\n          client.push file\n        else\n          server.push file\n\n      client: client, server: server\n\n    _hookToId = (hook) -> hook.replace(\n      \/[^0-9A-Za-z-]+\/g, '-'\n    ).toLowerCase()\n\n    _removeExtension = (filename) ->\n\n        dirname = path.dirname filename\n        if dirname is '.' then dirname = '' else dirname += '\/'\n        extname = path.extname filename\n        filename = \"#{dirname}#{path.basename filename, extname}\"\n\n        parts = filename.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'index'\n        return parts.join '\/'\n\n    fileStatsListPromise = _getFilesByType().then (allFiles) ->\n\n      allFilesPromises = for type, files of allFiles\n\n        typePromises = for file in files\n\n          do (type, file) -> new Promise (resolve, reject) ->\n\n            fstream = fs.createReadStream file\n            fstream.pipe lineStream = new LineStream keepEmptyLines: true\n\n            lineStream.pipe hookImplementations = new HookImplementations()\n            lineStream.pipe hookInvocations = new HookInvocations()\n            lineStream.pipe todos = new Todos()\n\n            fstream.on 'error', reject\n\n            fstream.on 'end', ->\n              resolve(\n                type: type\n                file: file\n                implementations: hookImplementations.list\n                invocations: hookInvocations.list\n                todos: todos.withContext()\n              )\n\n        Promise.all typePromises\n\n      Promise.all(allFilesPromises).then (fileStatsLists) ->\n        _.flatten fileStatsLists\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      hooksIndex = {}\n      implementations = {}\n      invocations = {}\n\n      for fileStats in fileStatsList\n\n        for implementation in fileStats.implementations\n          impl = implementations[implementation] ?= {}\n          (impl[fileStats.file] ?= []).push fileStats.type\n\n          hooksIndex[implementation] = true\n\n        for invocation in fileStats.invocations\n          invo = invocations[invocation] ?= {}\n          (invo[fileStats.file] ?= []).push fileStats.type\n\n          hooksIndex[invocation] = true\n\n      for hook, stats of implementations\n        for file of stats\n          stats[file] = _.unique stats[file] ? []\n\n      for hook, stats of invocations\n        for file of stats\n          stats[file] = _.unique stats[file] ? []\n\n      hooks = (hook for hook of hooksIndex).sort()\n\n      hookFiles = {}\n      for hook in hooks\n        hookFiles[hook] = try\n          fs.readFileSync \"docs\/hook\/#{hook}.md\", 'utf8'\n        catch error\n          ''\n\n      hookFiles: hookFiles\n      hooks: hooks\n      implementations: implementations\n      invocations: invocations\n\n    ).then(({hookFiles, hooks, implementations, invocations}) ->\n\n      render = '''\n    # Hook system\n\n    Hooks are how Shrub allows packages to implement (or invoke) dynamic\n    behavior. Hooks can also serve as a form of message passing between\n    packages.\n\n    To implement a hook, export a `pkgmanRegister` method which takes a\n    `registrar` argument, and use the registrar to register your hook:\n\n    ```javascript\n\n    exports.pkgmanRegister = function(registrar) {\n\n      registrar.registerHook('someHook', function() {\n        doStuff();\n      }\n\n      registrar.registerHook('someOtherHook', function(arg) {\n        doOtherStuffWith(arg);\n      }\n    }\n\n    ```\n\n    To invoke a hook, require `pkgman` and use the `invoke` method:\n\n    ```javascript\n\n    var pkgman = require('pkgman');\n\n    var results = pkgman.invoke('someOtherHook', arg);\n\n    ```\n\n    Any arguments following the hook name will be passed along to the\n    implementations. Hooks are invoked synchronously. For more information\n    about `pkgman`, see\n\n    ###### TODO: Link to `pkgman` documentation when complete.\n\n    '''\n\n      for hook in hooks\n\n        render += \"## #{hook}\\n\\n\"\n        render += hookFiles[hook] + '\\n\\n' if hookFiles[hook]\n\n        if implementations[hook]?\n\n          implementationCount = Object.keys(implementations[hook]).length\n          render += \"### #{implementationCount} implementation(s)\\n\\n\"\n\n          for file, types of implementations[hook]\n\n            file = _removeExtension file\n\n            types = types.map (type) -> \"[#{type}](source\/#{file}#implements-hook-#{hook.toLowerCase()})\"\n\n            render += \"* #{file} (#{types.join ','})\\n\"\n\n          render += '\\n'\n\n        if invocations[hook]?\n\n          invocationCount = Object.keys(invocations[hook]).length\n          render += \"### #{invocationCount} invocation(s)\\n\\n\"\n\n          for file, types of invocations[hook]\n\n            file = _removeExtension file\n\n            types = types.map (type) -> \"[#{type}](source\/#{file}#invoke-hook-#{hook.toLowerCase()})\"\n\n            render += \"* #{file} (#{types.join ','})\\n\"\n\n          render += '\\n'\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/hooks.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      render = '''\n      # TODO list\n\n      Shrub -- like any project -- always presents a path for improvement. This\n      is a dynamically generated list of TODO items, each with context.\n\n      '''\n\n      for fileStats in fileStatsList\n\n        idMap = {}\n\n        for todo in fileStats.todos\n\n          render += '\\n'\n\n          id = ''\n          for line, index in todo.lines\n            render += '>'\n\n            if index is Todos.context\n              id = _hookToId(line).slice 1, -1\n\n              render += line.slice 4\n            else\n              render += \" #{line}\"\n            render += '\\n'\n\n          render += '\\n'\n\n          filename = _removeExtension fileStats.file\n\n          if idMap[id]?\n            idMap[id] += 1\n            id += \"_#{idMap[id]}\"\n          else\n            idMap[id] = 0\n\n          render += \"###### the above found in [#{fileStats.file}:#{todo.index}](source\/#{filename}##{id})\\n\"\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/todos.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\n    _getFiles().then (files) ->\n\n      yml = fs.readFileSync 'docs\/mkdocs.yml.template', 'utf8'\n\n      for file in files\n        parts = file.split '\/'\n\n        for i in [0...parts.length]\n          try\n            fs.mkdirSync \"docs\/source\/#{parts.slice(0, i).join '\/'}\"\n          catch error\n\n        fs.createReadStream(file).pipe(\n          fs.createWriteStream(\"docs\/source\/#{file}\")\n        )\n\n        yml += \"- [source\/#{file}, 'Source code', '#{file}']\\n\"\n\n      fs.writeFileSync 'mkdocs.yml', yml\n\n      return\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"736593e29c4ff9b5db19ac68a22f605cf03baf74","subject":"Removed unnecessary code snippet","message":"Removed unnecessary code snippet\n","repos":"WillemDeGroef\/nodesentry","old_file":"src\/sandbox.litcoffee","new_file":"src\/sandbox.litcoffee","new_contents":"Sandbox\n=======\n\n    vm = require \"vm\"\n    path = require \"path\"\n    _ = require \"underscore\"\n    Membrane = require \".\/membrane\"\n\n    class Sandbox\n        constructor: (@fileName, @policyObj) ->\n\n            @origRequire = require\n            @glob =\n                __filename: @fileName\n                __dirname: path.dirname(@fileName)\n                console: console\n                module:\n                    exports: {}\n                Buffer: Buffer\n                require: undefined\n                process: process\n\n            @glob.global = @glob\n            @glob.GLOBAL = @glob\n            @glob.exports = @glob.module.exports\n\n        buildContext: () ->\n            ctxt = vm.createContext @glob\n            customRequire = @buildMembranedRequire()\n            ctxt.require = (libName) -> customRequire libName\n            return ctxt\n\n        buildMembranedRequire: ->\n            (libName) =>\n                try\n                    # first try to load library as a global library or add cwd if local file\n                    libName = path.join(@glob.__dirname, libName) if @glob.__dirname? and libName.indexOf(\".js\") > -1\n                    libexports = @origRequire libName\n                catch e\n                    # otherwise try to look in cwd node_modules directory\n                    libName = path.join(path.join(@glob.__dirname, \"node_modules\"), libName)\n                    libexports = @origRequire libName\n\n\nIf the library is only used within the (outer) membrane, i.e., it is not\nreferenced in the policy, we return immediately.\n\n                try\n                    return libexports unless @policyObj.mustWrap(libName)\n                catch e\n                    return libexports\n\nThe last step is to create a wrapper function that will carefully wrap each\nexported API call within a membrane.\n\n                f =  @buildMembraneWrapper libName\n                return _.object(_.map libexports, f)\n\n        buildMembraneWrapper: (libName) =>\n            (propObj, propName) => [propName, new Membrane(propObj, @policyObj)]\n\n        context: => @sandboxedContext ?= @buildContext()\n        global: => @glob\n\n\n    module.exports = Sandbox\n","old_contents":"Sandbox\n=======\n\n    vm = require \"vm\"\n    path = require \"path\"\n    _ = require \"underscore\"\n    Membrane = require \".\/membrane\"\n\n    class Sandbox\n        constructor: (@fileName, @policyObj) ->\n\n            @origRequire = require\n            @glob =\n                __filename: @fileName\n                __dirname: path.dirname(@fileName)\n                console: console\n                module:\n                    exports: {}\n                Buffer: Buffer\n                require: undefined\n                process: process\n\n            @glob.global = @glob\n            @glob.GLOBAL = @glob\n            @glob.exports = @glob.module.exports\n\n        buildContext: () ->\n            ctxt = vm.createContext @glob\n            customRequire = @buildMembranedRequire()\n            ctxt.require = (libName) -> customRequire libName\n            return ctxt\n\n        buildMembranedRequire: ->\n            (libName) =>\n                try\n                    # first try to load library as a global library or add cwd if local file\n                    libName = path.join(@glob.__dirname, libName) if @glob.__dirname? and libName.indexOf(\".js\") > -1\n                    libexports = @origRequire libName\n                catch e\n                    # otherwise try to look in cwd node_modules directory\n                    libName = path.join(path.join(@glob.__dirname, \"node_modules\"), libName)\n                    libexports = @origRequire libName\n\n\nIf the library is only used within the (outer) membrane, i.e., it is not\nreferenced in the policy, we return immediately.\n\n                try\n                    return libexports unless @policyObj.mustWrap(libName)\n                catch e\n                    return libexports\n\nThe last step is to create a wrapper function that will carefully wrap each\nexported API call within a membrane.\n\n                f =  @buildMembraneWrapper libName\n                return _.object(_.map libexports, f)\n\n        buildMembraneWrapper: (libName) =>\n            (propObj, propName) =>\n                name = \"#{libName}.#{propName}\"\n                [propName, new Membrane(propObj, @policyObj)]\n\n        context: => @sandboxedContext ?= @buildContext()\n        global: => @glob\n\n\n    module.exports = Sandbox\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"950b4e47c84bfbdff0829b7657da24fc829174aa","subject":"fix sort...","message":"fix sort...\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"server\/queueMethods.litcoffee","new_file":"server\/queueMethods.litcoffee","new_contents":"# Super secret queue methods\n\n    @QueueMethods =\n      popAndServeNextTicket: ->\n\nMove the current connection to the processed queue\n\nTODO: get postID\n\n        queueMeta = QueueMeta.findOne()\n\nUpdate object, extended at various point for updating the QueueMeta in one swoop\n\n        update =\n          $set: {}\n\nIf `theOnlyConnectionAllowedIn` is set to something, check if the connection\nhas expired and process the connection if it has.\n\n        if queueMeta.theOnlyConnectionAllowedIn isnt undefined\n\n          previousConnection = queueMeta.theOnlyConnectionAllowedIn\n          previousConnectionDidntPosted = not queueMeta.hasCurrentConnectionPosted\n\nReturn if timeCurrentTicketExpires is in the future (hasn't expired)\n\n          hasntExpired = queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n          return if hasntExpired\n\nOkay then, the current connection has expired, time to get bumped.\nInsert the processed connection into the ProcessedQueue\n\n          try\n\nCalculate how long the connection had to wait in line.\n\n            waitTimeSeconds = moment.utc().diff (moment.utc queueMeta.theOnlyConnectionAllowedIn.timeEnqueued), 'seconds'\n\nMake the processed object.\n\n            processed =\n              connection: queueMeta.theOnlyConnectionAllowedIn\n              waitTimeSeconds: waitTimeSeconds\n\nInsert the processed connection to `QueueProcessed`\n\n            QueueProcessed.insert processed\n          catch err\n            console.log err\n\nRemove the connection from the `Queue`\n\n          criteria = connectionId: queueMeta.theOnlyConnectionAllowedIn.connectionId\n          Queue.remove criteria\n\nUpdate `QueueMeta` stats and ticket number.\n\n          try\n            totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n            currentlyServingTicketNumber = queueMeta.currentlyServingTicketNumber + 1\n            _.extend update.$set,\n              currentlyServingTicketNumber: currentlyServingTicketNumber\n              hasCurrentConnectionPosted: no\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          catch err\n            console.log err\n\nLookup the lowest ticket # waiting in the `Queue`\n\n        nextConnection = Queue.findOne {}, { sort: { 'ticketNumber': 1 } }\n\nSet the allowed connection and expireTime if one exists\n\nIf there is a nextConnection (i.e. someone waiting in line), then serve them.\nOtherwise clear out theOnlyConnectionAllowedIn.\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          _.extend update.$set,\n            theOnlyConnectionAllowedIn: nextConnection\n            timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n            currentlyServingTicketNumber: nextConnection.ticketNumber\n\nIf there is no nextConnection, unset theOnlyConnectionAllowedIn.\nNote, fake data is filled in to pass schema, even though we're $unset'ing\n\n        else\n          update.$unset = theOnlyConnectionAllowedIn: \"\"\n\n        criteria = _id: queueMeta._id\n\nDelete `update.$set` if it's empty\n\n        if _.isEmpty update.$set\n          delete update.$set\n\nIf `update` isn't empty, update!\n\n        if not _.isEmpty update\n          QueueMeta.update criteria, update\n\n\nTODO: keep it DRY; logic isn't exactly shared and want to keep update atomic to\navoid extraneous DDP messages.\n\n## Disconnect, remove from queue\n\n    Meteor.onConnection (connection) ->\n      connection.onClose ->\n\nRemove the connection from the `Queue`\n\n        criteria = connectionId: connection.id\n        Queue.remove criteria\n","old_contents":"# Super secret queue methods\n\n    @QueueMethods =\n      popAndServeNextTicket: ->\n\nMove the current connection to the processed queue\n\nTODO: get postID\n\n        queueMeta = QueueMeta.findOne()\n\nUpdate object, extended at various point for updating the QueueMeta in one swoop\n\n        update =\n          $set: {}\n\nIf `theOnlyConnectionAllowedIn` is set to something, check if the connection\nhas expired and process the connection if it has.\n\n        if queueMeta.theOnlyConnectionAllowedIn isnt undefined\n\n          previousConnection = queueMeta.theOnlyConnectionAllowedIn\n          previousConnectionDidntPosted = not queueMeta.hasCurrentConnectionPosted\n\nReturn if timeCurrentTicketExpires is in the future (hasn't expired)\n\n          hasntExpired = queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n          return if hasntExpired\n\nOkay then, the current connection has expired, time to get bumped.\nInsert the processed connection into the ProcessedQueue\n\n          try\n\nCalculate how long the connection had to wait in line.\n\n            waitTimeSeconds = moment.utc().diff (moment.utc queueMeta.theOnlyConnectionAllowedIn.timeEnqueued), 'seconds'\n\nMake the processed object.\n\n            processed =\n              connection: queueMeta.theOnlyConnectionAllowedIn\n              waitTimeSeconds: waitTimeSeconds\n\nInsert the processed connection to `QueueProcessed`\n\n            QueueProcessed.insert processed\n          catch err\n            console.log err\n\nRemove the connection from the `Queue`\n\n          criteria = connectionId: queueMeta.theOnlyConnectionAllowedIn.connectionId\n          Queue.remove criteria\n\nUpdate `QueueMeta` stats and ticket number.\n\n          try\n            totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n            currentlyServingTicketNumber = queueMeta.currentlyServingTicketNumber + 1\n            _.extend update.$set,\n              currentlyServingTicketNumber: currentlyServingTicketNumber\n              hasCurrentConnectionPosted: no\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          catch err\n            console.log err\n\nLookup the lowest ticket # waiting in the `Queue`\n\n        nextConnection = Queue.findOne {}, { $sort: { 'ticketNumber': 1 } }\n\nSet the allowed connection and expireTime if one exists\n\nIf there is a nextConnection (i.e. someone waiting in line), then serve them.\nOtherwise clear out theOnlyConnectionAllowedIn.\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          _.extend update.$set,\n            theOnlyConnectionAllowedIn: nextConnection\n            timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n            currentlyServingTicketNumber: nextConnection.ticketNumber\n\nIf there is no nextConnection, unset theOnlyConnectionAllowedIn.\nNote, fake data is filled in to pass schema, even though we're $unset'ing\n\n        else\n          update.$unset = theOnlyConnectionAllowedIn: \"\"\n\n        criteria = _id: queueMeta._id\n\nDelete `update.$set` if it's empty\n\n        if _.isEmpty update.$set\n          delete update.$set\n\nIf `update` isn't empty, update!\n\n        if not _.isEmpty update\n          QueueMeta.update criteria, update\n\n\nTODO: keep it DRY; logic isn't exactly shared and want to keep update atomic to\navoid extraneous DDP messages.\n\n## Disconnect, remove from queue\n\n    Meteor.onConnection (connection) ->\n      connection.onClose ->\n\nRemove the connection from the `Queue`\n\n        criteria = connectionId: connection.id\n        Queue.remove criteria\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f5d5a9f96caa572fb695d2ab5f5921788c5234ae","subject":"fix indention for caching","message":"fix indention for caching\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/lib\/routes\/index.litcoffee","new_file":"src\/lib\/routes\/index.litcoffee","new_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n      \n## Function cache(res, seconds)\n\nSet cache headers on this response.\n\nUsage: `cache(res,86400)`\n\n      cache = (res,seconds) ->\n        res.header 'Cache-control', 'Cache-Control:public, max-age='+seconds\n        \n## Function nocache(res)\n\nSet uncacheable headers on this response\n\nUsage: `nocache(res)`\n\n      nocache = (res) ->\n        res.header 'Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0'\n\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        cache res, 2592000\n        res.redirect '\/page\/index'\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        app.models.page.get req.params.name, (err, page) ->\n          if err\n            console.error 'page '+req.params.name+' not found in db, showing 500'\n            nocache res\n            res.render 'error\/500'\n          else\n            cache res, 86400\n            res.render 'page\/dynamic', page\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n<!-- ' -->\n\n      app.post '\/page\/_post', (req, res) ->\n        nocache res\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          content: 'Hello world, from inside the DB'\n        app.models.page sample, (err, page) ->\n          if err\n            page = \n              name: 'error'\n              title: 'Error'\n              content: 'There was an error posting your page, please try again.'\n          res.render 'page\/dynamic', page\n          \n## GET \/login\n\nRender static pages at \/view\/login\/index.html\n\nAnd never cache the login page, it breaks csrf\n\n      app.get '\/login', (req, res) ->\n        nocache res\n        res.render 'login'\n\n          \n## POST \/login\/_post\n\nDo Login action, and redirect as appropriate.\n\n      app.post '\/login\/_post', (req, res) ->\n        nocache res\n        require('..\/login').checkUser req.body.username, req.body.password, (user, securityLevel) ->\n          console.info 'login callback = '+user+', '+securityLevel\n          req.session.user = user\n          req.session.securityLevel = securityLevel\n          res.cookie 'nocache', '1'\n          if securityLevel\n            res.redirect '\/'\n          else\n            res.redirect '\/login'\n\n## GET \/login\/clear\n\nLogout from the website by clearing the session\n\n      app.get '\/login\/clear', (req, res) ->\n        nocache res\n        req.session.destroy (err) ->\n          res.clearCookie 'nocache'\n          res.redirect '\/login'\n\n## GET \/directory\n \nDownload PDF to browser\n\n      app.get '\/directory', (req, res) ->\n        nocache res\n        if req.session.securityLevel\n          request = require 'request'\n          request app.directory_url, (err, cbres, data) ->\n            if err or cbres.statusCode != 200\n              res.render 500, 'Error retrieving full directory'\n            else\n              dir = JSON.parse data\n              page = \n                name: 'Full Directory'\n                title: 'Full Directory'\n                directory: dir.data\n                helpers:\n                  month: (num) ->\n                    return [null, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'][num]\n              res.render 'directory', page\n        else\n          res.redirect '\/login'\n\n\n## GET \/directory\/directory.pdf\n \nDownload PDF to browser\n\n      app.get '\/directory\/directory.pdf', (req, res) ->\n        nocache res\n        if req.session.securityLevel\n          res.download 'protected\/directory.pdf'\n        else\n          res.redirect '\/login'\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n      \n## Function cache(res, seconds)\n\nSet cache headers on this response.\n\nUsage: `cache(res,86400)`\n\n    cache = (res,seconds) ->\n      res.header 'Cache-control', 'Cache-Control:public, max-age='+seconds\n      \n## Function nocache(res)\n\nSet uncacheable headers on this response\n\nUsage: `nocache(res)`\n\n    nocache = (res) ->\n      res.header 'Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0'\n\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        cache res, 2592000\n        res.redirect '\/page\/index'\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        app.models.page.get req.params.name, (err, page) ->\n          if err\n            console.error 'page '+req.params.name+' not found in db, showing 500'\n            nocache res\n            res.render 'error\/500'\n          else\n            cache res, 86400\n            res.render 'page\/dynamic', page\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n<!-- ' -->\n\n      app.post '\/page\/_post', (req, res) ->\n        nocache res\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          content: 'Hello world, from inside the DB'\n        app.models.page sample, (err, page) ->\n          if err\n            page = \n              name: 'error'\n              title: 'Error'\n              content: 'There was an error posting your page, please try again.'\n          res.render 'page\/dynamic', page\n          \n## GET \/login\n\nRender static pages at \/view\/login\/index.html\n\nAnd never cache the login page, it breaks csrf\n\n      app.get '\/login', (req, res) ->\n        nocache res\n        res.render 'login'\n\n          \n## POST \/login\/_post\n\nDo Login action, and redirect as appropriate.\n\n      app.post '\/login\/_post', (req, res) ->\n        nocache res\n        require('..\/login').checkUser req.body.username, req.body.password, (user, securityLevel) ->\n          console.info 'login callback = '+user+', '+securityLevel\n          req.session.user = user\n          req.session.securityLevel = securityLevel\n          res.cookie 'nocache', '1'\n          if securityLevel\n            res.redirect '\/'\n          else\n            res.redirect '\/login'\n\n## GET \/login\/clear\n\nLogout from the website by clearing the session\n\n      app.get '\/login\/clear', (req, res) ->\n        nocache res\n        req.session.destroy (err) ->\n          res.clearCookie 'nocache'\n          res.redirect '\/login'\n\n## GET \/directory\n \nDownload PDF to browser\n\n      app.get '\/directory', (req, res) ->\n        nocache res\n        if req.session.securityLevel\n          request = require 'request'\n          request app.directory_url, (err, cbres, data) ->\n            if err or cbres.statusCode != 200\n              res.render 500, 'Error retrieving full directory'\n            else\n              dir = JSON.parse data\n              page = \n                name: 'Full Directory'\n                title: 'Full Directory'\n                directory: dir.data\n                helpers:\n                  month: (num) ->\n                    return [null, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'][num]\n              res.render 'directory', page\n        else\n          res.redirect '\/login'\n\n\n## GET \/directory\/directory.pdf\n \nDownload PDF to browser\n\n      app.get '\/directory\/directory.pdf', (req, res) ->\n        nocache res\n        if req.session.securityLevel\n          res.download 'protected\/directory.pdf'\n        else\n          res.redirect '\/login'\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"07b64bb35d913bb98f38f90bba37abb591aee8fc","subject":"router window.onpopstate","message":"router window.onpopstate\n","repos":"vpj\/weya,vpj\/weya","old_file":"router.litcoffee","new_file":"router.litcoffee","new_contents":"#Weya.Router.litcoffee\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n    if exports?\n     Weya = require '.\/weya'\n     Weya.Base = require '.\/weya_base'\n\n    if not Weya.Base?\n     throw new Error 'Weya.Base not found'\n\n##Weya.Router\n\nRouting with hash tags or pushState\n\n    class Router extends Weya.Base\n     optionalParam: \/\\((.*?)\\)\/g\n     namedParam: \/(\\(\\?)?:\\w+\/g\n     splatParam: \/\\*\\w+\/g\n     escapeRegExp: \/[\\-{}\\[\\]+?.,\\\\\\^$|#\\s]\/g\n\n     @extend()\n\n     @initialize ->\n      @_bindRoutes()\n      @_event = null\n      @_history = []\n\n     _routes: {}\n\n####Register router\n\n`'analyse\/:analysis': 'onAnalyse'`\n\n`dashboard': ['auth', 'dashboard']`\n\nThis will match urls of the form `analyse\/\\*` and call method @onAnalyse\nwith the parameter. Second route will first call @auth if it returns\n`true` @dashboard will be called.\n\nThe most specific route should be at bottom. Routers can added or overridden\nin subclasses\n\n     @routes: (routes) ->\n      temp = @::_routes\n      @::_routes = {}\n      @::_routes[k] = v for k, v of temp\n      @::_routes[k] = v for k, v of routes\n\n####Starts routing\nOption silent will not trigger an event for the current url\n\n     start: (options) ->\n      Weya.history.start options\n      fragment = Weya.history.getFragment()\n\n      if options?.silent is on\n       @_history.push fragment: fragment, title: document.title\n\n####Goes to previous page if exists\n\n     back: ->\n      if @_history.length > 1\n       Weya.history.back()\n\n####Whether it is possible to go to previous page\n\n     canBack: ->\n      if @_history.length > 1 and Weya.history.canBack()\n       return true\n      else\n       return false\n\n####Registers a route\n\n     route: (route, name) ->\n      if (Object.prototype.toString.call route) isnt '[object RegExp]'\n       route = @_routeToRegExp route\n\nRegisters the route with Weya.history\n\n      Weya.history.route route, (fragment, event) =>\n       args = @_extractParameters route, fragment\n       @_event = event\n\nHandle state\n\n       if @_event?.type is \"popstate\"\n        @_history.pop()\n        if @_history.length is 0\n         @_history.push\n          fragment: fragment\n          title: document.title\n          state: @getState()\n       else\n        @_history.push\n         fragment: fragment\n         title: document.title\n         state: @getState()\n\nCalls callbacks in order\n\n       callbacks = name\n       callbacks = [callbacks] if not Array.isArray callbacks\n\n       for callback in callbacks\n        if (typeof callback) is 'string'\n         callback = @[callback]\n        break unless callback.apply this, args\n\n####Gets the current HTML5 History state\n\n     getState: ->\n      if @_event?.originalEvent?.state?\n       return @_event.originalEvent.state\n      else\n       return null\n\n####Navigate to a new URL, while setting HTML5 History state\n\n     navigate: (fragment, options) ->\n      options = {} unless options\n      if options.replace\n       @_history.pop()\n      if not options.trigger\n       @_history.push\n        fragment: fragment\n        title: options.title\n        state: options.state\n\n      Weya.history.navigate fragment, options\n\nBind routes\n\n     _bindRoutes: ->\n      for route, name of @_routes\n       @route route, name\n\nConvert a route string into a regular expression, suitable for matching\n\n     _routeToRegExp: (route) ->\n      route = route.replace @escapeRegExp, '\\\\$&'\n                   .replace @noptionalParam, '(?:$1)?'\n                   .replace @namedParam, (match, optional) ->\n                    if optional then match else '([^\\\/]+)'\n                   .replace @splatParam, '(.*?)'\n\n       return new RegExp \"^#{route}$\"\n\nExtract parameters from a route regex and URL\n\n     _extractParameters: (route, fragment) ->\n      params = route.exec(fragment).slice(1)\n      for p, i in params when p?\n       params[i] = decodeURIComponent p\n\n## History class\n\n    class History extends Weya.Base\n     @extend()\n\nStrip leading hash\/slash and trailing space\n\n     routeStripper: \/^[#\\\/]|\\s+$\/g\n\nStrip leading and trailing slashes\n\n     rootStripper: \/^\\\/+|\\\/+$\/g\n\nRemove trailing slash\n\n     trailingSlash: \/\\\/$\/\n\nStrip urls of hash and query\n\n     pathStripper: \/[?#].*$\/\n\n     @initialize ->\n      @handlers = []\n      @checkUrl = @checkUrl.bind this\n      @history = window.history\n      @location = window.location\n      @stateList = []\n\nHash check interval\n\n     interval: 50\n\nGet hash value\n\n     getHash: ->\n      match = @location.href.match \/#(.*)$\/\n      return (if match? then match[1] else '')\n\nGet emulated state\n\n     getEmulateState: ->\n      if @stateList.length > 0\n       return @stateList[@stateList.length - 1]\n      else\n       return {fragment: \"\"}\n\n     popEmulateState: -> @stateList.pop()\n\n     pushEmulateState: (state, title, fragment) ->\n      @stateList.push\n       state: state\n       title: title\n       fragment: fragment\n\nGet the URL fragment\n\n     getFragment: (fragment, forcePushState) ->\n      if not fragment?\n       if @_emulateState\n        fragment = @getEmulateState().fragment\n       else if @_hasPushState or not @_wantsHashChange or forcePushState\n        fragment = @location.pathname\n        root = @root.replace @trailingSlash, ''\n        if (fragment.indexOf root) is 0\n         fragment = fragment.slice root.length\n       else\n        fragment = @getHash()\n\n      return fragment.replace @routeStripper, ''\n\n####Goto the previous page\n\n     back: ->\n      if @_emulateState is on\n       @popEmulateState()\n       @loadUrl null, null\n      else\n       @history?.back?()\n\n####Can back?\n\n     canBack: ->\n      if @_emulateState is on\n       return @stateList.length > 1\n      else\n       return @history?.back?\n\n####Start listening to events\n\n     start: (options) ->\n      History.started = true\n\n      opt = {root: '\/'}\n      opt[k] = v for k, v of @options\n      opt[k] = v for k, v of options\n      @options = opt\n      @root = @options.root\n      @_emulateState = @options.emulateState is on\n      @_wantsHashChange = @_emulateState is off and @options.hashChange isnt off\n      @_wantsPushState = @_emulateState is off and @options.pushState is on\n      @_hasPushState = @_wantsPushState is on and @history?.pushState?\n      if @_emulateState and @options.start?\n       @pushEmulateState @options.start.state,\n        @options.start.title\n        @options.start.fragment\n\n      @fragment = @getFragment()\n\nNormalize root to always include a leading and trailing slash.\n\n      @root = \"\/#{@root}\/\".replace @rootStripper, '\/'\n\nDepending on whether we're using pushState or hashes, and whether\n'onhashchange' is supported, determine how we check the URL state.\n\n      if @_hasPushState\n       window.onpopstate = @checkUrl\n      else if @_wantsHashChange and window.onhashchange?\n       window.onhashchange = @checkUrl\n      else if @_wantsHashChange\n       @_checkUrlInterval = setInterval @checkUrl, @interval\n\n      if not @options.silent\n       @loadUrl null, null\n\n####Add a listener to a router\n\n     route: (route, callback) ->\n      @handlers.unshift route: route, callback: callback\n\nCheck current url for changes\n\n     checkUrl: (e) ->\n      fragment = @getFragment()\n      return if fragment is @fragment\n      @loadUrl fragment, e\n\nCall callbacks of matching route\n\n     loadUrl: (fragment, e) ->\n      fragment = @fragment = @getFragment fragment\n      for handler in @handlers\n       if handler.route.test fragment\n        return handler.callback fragment, e\n\n      return\n\n####Navigate to a URL\nTriggers a route is option trigger is on\nReplaces the url is option replace is on\nSets state and title\n\n     navigate: (fragment, options) ->\n      return false if not History.started\n\n      fragment = @getFragment(fragment or '')\n      url = @root + fragment\n\nStrip the fragment of the query and hash for matching.\n\n      fragment = fragment.replace @pathStripper, ''\n\n      return if @fragment is fragment\n      @fragment = fragment\n\nDon't include a trailing slash on the root.\n\n      if fragment is '' and url isnt '\/'\n       url = url.slice 0, -1\n\nIf pushState is available, we use it to set the fragment as a real URL.\n\n      if @_emulateState\n       if options.replace is on\n        @popEmulateState()\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @pushEmulateState state, title, fragment\n      else if @_hasPushState\n       method = if options.replace then 'replaceState' else 'pushState'\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @history[method] state, title, url\n\nIf hash changes haven't been explicitly disabled, update the hash\nfragment to store history.\n\n      else if @_wantsHashChange\n       @_updateHash @location, fragment, options.replace\n\nIf you've told us that you explicitly don't want fallback hashchange-\nbased history, then `navigate` becomes a page refresh.\n\n      else\n       return @location.assign url\n      if options.trigger\n       return @loadUrl fragment, null\n\nUpdate the hash\n\n     _updateHash: (location, fragment, replace) ->\n      if replace\n       href = location.href.replace \/(javascript:|#).*$\/, ''\n       location.replace \"#{href}##{fragment}\"\n      else\n       location.hash = \"##{fragment}\"\n\n    Weya.Router = Router\n    Weya.history = new History\n\n    if module?\n     module.exports = Weya.Router\n\n","old_contents":"#Weya.Router.litcoffee\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n    if exports?\n     Weya = require '.\/weya'\n     Weya.Base = require '.\/weya_base'\n\n    if not Weya.Base?\n     throw new Error 'Weya.Base not found'\n\n##Weya.Router\n\nRouting with hash tags or pushState\n\n    class Router extends Weya.Base\n     optionalParam: \/\\((.*?)\\)\/g\n     namedParam: \/(\\(\\?)?:\\w+\/g\n     splatParam: \/\\*\\w+\/g\n     escapeRegExp: \/[\\-{}\\[\\]+?.,\\\\\\^$|#\\s]\/g\n\n     @extend()\n\n     @initialize ->\n      @_bindRoutes()\n      @_event = null\n      @_history = []\n\n     _routes: {}\n\n####Register router\n\n`'analyse\/:analysis': 'onAnalyse'`\n\n`dashboard': ['auth', 'dashboard']`\n\nThis will match urls of the form `analyse\/\\*` and call method @onAnalyse\nwith the parameter. Second route will first call @auth if it returns\n`true` @dashboard will be called.\n\nThe most specific route should be at bottom. Routers can added or overridden\nin subclasses\n\n     @routes: (routes) ->\n      temp = @::_routes\n      @::_routes = {}\n      @::_routes[k] = v for k, v of temp\n      @::_routes[k] = v for k, v of routes\n\n####Starts routing\nOption silent will not trigger an event for the current url\n\n     start: (options) ->\n      Weya.history.start options\n      fragment = Weya.history.getFragment()\n\n      if options?.silent is on\n       @_history.push fragment: fragment, title: document.title\n\n####Goes to previous page if exists\n\n     back: ->\n      if @_history.length > 1\n       Weya.history.back()\n\n####Whether it is possible to go to previous page\n\n     canBack: ->\n      if @_history.length > 1 and Weya.history.canBack()\n       return true\n      else\n       return false\n\n####Registers a route\n\n     route: (route, name) ->\n      if (Object.prototype.toString.call route) isnt '[object RegExp]'\n       route = @_routeToRegExp route\n\nRegisters the route with Weya.history\n\n      Weya.history.route route, (fragment, event) =>\n       args = @_extractParameters route, fragment\n       @_event = event\n\nHandle state\n\n       if @_event?.type is \"popstate\"\n        @_history.pop()\n        if @_history.length is 0\n         @_history.push\n          fragment: fragment\n          title: document.title\n          state: @getState()\n       else\n        @_history.push\n         fragment: fragment\n         title: document.title\n         state: @getState()\n\nCalls callbacks in order\n\n       callbacks = name\n       callbacks = [callbacks] if not Array.isArray callbacks\n\n       for callback in callbacks\n        if (typeof callback) is 'string'\n         callback = @[callback]\n        break unless callback.apply this, args\n\n####Gets the current HTML5 History state\n\n     getState: ->\n      if @_event?.originalEvent?.state?\n       return @_event.originalEvent.state\n      else\n       return null\n\n####Navigate to a new URL, while setting HTML5 History state\n\n     navigate: (fragment, options) ->\n      options = {} unless options\n      if options.replace\n       @_history.pop()\n      if not options.trigger\n       @_history.push\n        fragment: fragment\n        title: options.title\n        state: options.state\n\n      Weya.history.navigate fragment, options\n\nBind routes\n\n     _bindRoutes: ->\n      for route, name of @_routes\n       @route route, name\n\nConvert a route string into a regular expression, suitable for matching\n\n     _routeToRegExp: (route) ->\n      route = route.replace @escapeRegExp, '\\\\$&'\n                   .replace @noptionalParam, '(?:$1)?'\n                   .replace @namedParam, (match, optional) ->\n                    if optional then match else '([^\\\/]+)'\n                   .replace @splatParam, '(.*?)'\n\n       return new RegExp \"^#{route}$\"\n\nExtract parameters from a route regex and URL\n\n     _extractParameters: (route, fragment) ->\n      params = route.exec(fragment).slice(1)\n      for p, i in params when p?\n       params[i] = decodeURIComponent p\n\n## History class\n\n    class History extends Weya.Base\n     @extend()\n\nStrip leading hash\/slash and trailing space\n\n     routeStripper: \/^[#\\\/]|\\s+$\/g\n\nStrip leading and trailing slashes\n\n     rootStripper: \/^\\\/+|\\\/+$\/g\n\nRemove trailing slash\n\n     trailingSlash: \/\\\/$\/\n\nStrip urls of hash and query\n\n     pathStripper: \/[?#].*$\/\n\n     @initialize ->\n      @handlers = []\n      @checkUrl = @checkUrl.bind this\n      @history = window.history\n      @location = window.location\n      @stateList = []\n\nHash check interval\n\n     interval: 50\n\nGet hash value\n\n     getHash: ->\n      match = @location.href.match \/#(.*)$\/\n      return (if match? then match[1] else '')\n\nGet emulated state\n\n     getEmulateState: ->\n      if @stateList.length > 0\n       return @stateList[@stateList.length - 1]\n      else\n       return {fragment: \"\"}\n\n     popEmulateState: -> @stateList.pop()\n\n     pushEmulateState: (state, title, fragment) ->\n      @stateList.push\n       state: state\n       title: title\n       fragment: fragment\n\nGet the URL fragment\n\n     getFragment: (fragment, forcePushState) ->\n      if not fragment?\n       if @_emulateState\n        fragment = @getEmulateState().fragment\n       else if @_hasPushState or not @_wantsHashChange or forcePushState\n        fragment = @location.pathname\n        root = @root.replace @trailingSlash, ''\n        if (fragment.indexOf root) is 0\n         fragment = fragment.slice root.length\n       else\n        fragment = @getHash()\n\n      return fragment.replace @routeStripper, ''\n\n####Goto the previous page\n\n     back: ->\n      if @_emulateState is on\n       @popEmulateState()\n       @loadUrl null, null\n      else\n       @history?.back?()\n\n####Can back?\n\n     canBack: ->\n      if @_emulateState is on\n       return @stateList.length > 1\n      else\n       return @history?.back?\n\n####Start listening to events\n\n     start: (options) ->\n      History.started = true\n\n      opt = {root: '\/'}\n      opt[k] = v for k, v of @options\n      opt[k] = v for k, v of options\n      @options = opt\n      @root = @options.root\n      @_emulateState = @options.emulateState is on\n      @_wantsHashChange = @_emulateState is off and @options.hashChange isnt off\n      @_wantsPushState = @_emulateState is off and @options.pushState is on\n      @_hasPushState = @_wantsPushState is on and @history?.pushState?\n      if @_emulateState and @options.start?\n       @pushEmulateState @options.start.state,\n        @options.start.title\n        @options.start.fragment\n\n      @fragment = @getFragment()\n\nNormalize root to always include a leading and trailing slash.\n\n      @root = \"\/#{@root}\/\".replace @rootStripper, '\/'\n\nDepending on whether we're using pushState or hashes, and whether\n'onhashchange' is supported, determine how we check the URL state.\n\n      if @_hasPushState\n       $(window).on 'popstate', @checkUrl\n      else if @_wantsHashChange and window.onhashchange?\n       $(window).on 'hashchange', @checkUrl\n      else if @_wantsHashChange\n       @_checkUrlInterval = setInterval @checkUrl, @interval\n\n      if not @options.silent\n       @loadUrl null, null\n\n####Add a listener to a router\n\n     route: (route, callback) ->\n      @handlers.unshift route: route, callback: callback\n\nCheck current url for changes\n\n     checkUrl: (e) ->\n      fragment = @getFragment()\n      return if fragment is @fragment\n      @loadUrl fragment, e\n\nCall callbacks of matching route\n\n     loadUrl: (fragment, e) ->\n      fragment = @fragment = @getFragment fragment\n      for handler in @handlers\n       if handler.route.test fragment\n        return handler.callback fragment, e\n\n      return\n\n####Navigate to a URL\nTriggers a route is option trigger is on\nReplaces the url is option replace is on\nSets state and title\n\n     navigate: (fragment, options) ->\n      return false if not History.started\n\n      fragment = @getFragment(fragment or '')\n      url = @root + fragment\n\nStrip the fragment of the query and hash for matching.\n\n      fragment = fragment.replace @pathStripper, ''\n\n      return if @fragment is fragment\n      @fragment = fragment\n\nDon't include a trailing slash on the root.\n\n      if fragment is '' and url isnt '\/'\n       url = url.slice 0, -1\n\nIf pushState is available, we use it to set the fragment as a real URL.\n\n      if @_emulateState\n       if options.replace is on\n        @popEmulateState()\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @pushEmulateState state, title, fragment\n      else if @_hasPushState\n       method = if options.replace then 'replaceState' else 'pushState'\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @history[method] state, title, url\n\nIf hash changes haven't been explicitly disabled, update the hash\nfragment to store history.\n\n      else if @_wantsHashChange\n       @_updateHash @location, fragment, options.replace\n\nIf you've told us that you explicitly don't want fallback hashchange-\nbased history, then `navigate` becomes a page refresh.\n\n      else\n       return @location.assign url\n      if options.trigger\n       return @loadUrl fragment, null\n\nUpdate the hash\n\n     _updateHash: (location, fragment, replace) ->\n      if replace\n       href = location.href.replace \/(javascript:|#).*$\/, ''\n       location.replace \"#{href}##{fragment}\"\n      else\n       location.hash = \"##{fragment}\"\n\n    Weya.Router = Router\n    Weya.history = new History\n\n    if module?\n     module.exports = Weya.Router\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"823557349b5b0131867d62c459e76d3ec66b7583","subject":"weya elem fix","message":"weya elem fix\n","repos":"vpj\/weya,vpj\/weya","old_file":"weya.litcoffee","new_file":"weya.litcoffee","new_contents":"Gist of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\n##Manipulating dom objects\n\nSet styles\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\nSet events\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\nSet data\n\n     setData = (elem, data) ->\n      for k, v of data\n       elem[k] = v\n\nSet attributes\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        when 'data' then setData elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\nSet ID and Class with `classList`\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       for c in idClass.class\n        elem.classList.add c\n\nSet ID and Class with setAttributes\n\n     setIdClassFallback = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       className = idClass.class.join ' '\n       elem.setAttribute 'class', className\n\nCheck whether classList is available and switch to fallback otherwise\n\n     switchIdClass = ->\n      elem = Api.document.createElementNS \"http:\/\/www.w3.org\/2000\/svg\", 'g'\n      if not elem.classList\n       setIdClass = setIdClassFallback\n\nSwitch to fall back if no classList\n\n     switchIdClass() if Api.document?\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setData = (buf, data) ->\n      for k, v of data\n       buf.push \" data-#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        when 'data' then setData buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, isVoid, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        className = params.idClass.class.join ' '\n        buf.push \" class=\\\"#{className}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      if isVoid\n       buf.push \"\/>\\n\"\n       if params.func? or params.text?\n        throw new Error 'Void tags cannot have content'\n\n      else\n       buf.push \">\\n\"\n       @_indent++\n\n       if params.func?\n        params.func.call this\n       else if params.text?\n        setIndent buf, @_indent\n        buf.push params.text\n        buf.push \"\\n\"\n\n       @_indent--\n       setIndent buf, @_indent\n       buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name, isVoid) ->\n      ->\n       append.call this, ns, name, isVoid, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name, false\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name, false\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name, true\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n     weyaDom = weyaDomCreate()\n     weyaMarkup = weyaMarkupCreate()\n\n    if module?\n     module.exports = Weya\n","old_contents":"Gist of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setData = (elem, data) ->\n      for k, v of data\n       elem[k] = v\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        when 'data' then setData elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       for c in idClass.class\n        elem.classList.add c\n\n     setIdClassFallback = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       className = idClass.class.join ' '\n       elem.setAttribute 'class', className\n\n     if Api.document?\n      elem = Api.document.createElementNS \"http:\/\/www.w3.org\/2000\/svg\", 'g'\n      if not elem.classList\n       setIdClass = setIdClassFallback\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setData = (buf, data) ->\n      for k, v of data\n       buf.push \" data-#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        when 'data' then setData buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, isVoid, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        className = params.idClass.class.join ' '\n        buf.push \" class=\\\"#{className}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      if isVoid\n       buf.push \"\/>\\n\"\n       if params.func? or params.text?\n        throw new Error 'Void tags cannot have content'\n\n      else\n       buf.push \">\\n\"\n       @_indent++\n\n       if params.func?\n        params.func.call this\n       else if params.text?\n        setIndent buf, @_indent\n        buf.push params.text\n        buf.push \"\\n\"\n\n       @_indent--\n       setIndent buf, @_indent\n       buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name, isVoid) ->\n      ->\n       append.call this, ns, name, isVoid, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name, false\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name, false\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name, true\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n     weyaDom = weyaDomCreate()\n     weyaMarkup = weyaMarkupCreate()\n\n    if module?\n     module.exports = Weya\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9d1e4515f161d88fa2134869c2d194ce56adc302","subject":"fix memory leak with action\/rpc. method should be a property and ignore update() propagation from input\/output schema evaluations","message":"fix memory leak with action\/rpc. method should be a property and ignore update() propagation from input\/output schema evaluations\n","repos":"corenova\/yang-js","old_file":"src\/method.litcoffee","new_file":"src\/method.litcoffee","new_contents":"# Method - controller of functions\n\n## Class Method\n\n    debug = require('debug')('yang:method')\n    Property = require('.\/property')\n\n    class Method extends Property\n      debug: -> debug @uri, arguments...\n\n      @property 'value',\n        get: -> @state.value ? @do.bind this\n\n      get: (pattern) -> switch\n        when pattern? then super arguments...\n        when @binding? then @do.bind this\n        else @data\n\n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      do: (input={}, opts={}) ->\n        unless (@binding instanceof Function) or (@data instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        @debug \"[do] executing method: #{@name}\"\n        @debug input\n        ctx = @parent?.context ? @context\n        ctx = ctx.with opts, path: @path\n        try\n          # calling context is the parent node of the method\n          input = @schema.input.apply input, this, force: true\n          \n          # first apply schema bound function (if availble), otherwise\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\"\n            @debug @binding.toString()\n            output = @binding? ctx, input\n          else\n            @debug \"[do] calling assigned function: #{@data.name}\"\n            @debug @value\n            @debug @data\n            output = @data.call @parent.data, input, ctx\n\n          output = await output\n          { output } = @schema.output.eval { output }, this, force: true\n          return output\n        catch e\n          @debug e\n          return e\n\n      update: (value, opts) ->\n        super value, opts unless value instanceof Property\n\n### toJSON\n\nThis call always returns undefined for the Method node.\n\n      toJSON: (key) ->\n        value = undefined\n        value = \"#{@name}\": value if key is true\n        return value\n\n    module.exports = Method\n","old_contents":"# Method - controller of functions\n\n## Class Method\n\n    debug = require('debug')('yang:method')\n    Container = require('.\/container')\n\n    class Method extends Container\n      debug: -> debug @uri, arguments...\n\n      @property 'value',\n        get: -> @state.value ? @do.bind this\n\n      get: (pattern) -> switch\n        when pattern? then super arguments...\n        when @binding? then @do.bind this\n        else @data\n\n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      do: (input={}, opts={}) ->\n        unless (@binding instanceof Function) or (@data instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        @debug \"[do] executing method: #{@name}\"\n        @debug input\n        ctx = @parent?.context ? @context\n        ctx = ctx.with opts, path: @path\n        try\n          # calling context is the parent node of the method\n          input = @schema.input.apply input, this, force: true\n          \n          # first apply schema bound function (if availble), otherwise\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\"\n            @debug @binding.toString()\n            output = @binding? ctx, input\n          else\n            @debug \"[do] calling assigned function: #{@data.name}\"\n            output = @data.call @parent.data, input, ctx\n\n          output = await Promise.resolve output\n          { output } = @schema.output.eval { output }, this, force: true\n          return output\n        catch e\n          @debug e\n          return Promise.reject e\n\n### toJSON\n\nThis call always returns undefined for the Method node.\n\n      toJSON: (key) ->\n        value = undefined\n        value = \"#{@name}\": value if key is true\n        return value\n\n    module.exports = Method\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"ecb72b314091fd91e69bb3e2baf5a22ca7014208","subject":"Remove TIFF from supported images","message":"Remove TIFF from supported images\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/server.litcoffee","new_file":"src\/server.litcoffee","new_contents":"    url          = require 'url'\n\n    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n    librato      = require '.\/librato'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      origin = url.parse req.get('Origin') or ''\n\n      if origin.hostname not in origins\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status = 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      librato.measure 'image.upload', Object.keys(req.files).length, {}\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","old_contents":"    url          = require 'url'\n\n    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n    librato      = require '.\/librato'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      origin = url.parse req.get('Origin') or ''\n\n      if origin.hostname not in origins\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status = 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      librato.measure 'image.upload', Object.keys(req.files).length, {}\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6ef89b7d183e0a0d9d1e9d075697db30c2fb623a","subject":"pass @pending queue with 'commit' event, see #37","message":"pass @pending queue with 'commit' event, see #37\n","repos":"corenova\/yang-js","old_file":"src\/model.litcoffee","new_file":"src\/model.litcoffee","new_contents":"# Model - instance of schema-driven data\n\nThe `Model` class aggregates [Property](.\/property.litcoffee)\nattachments to provide the *adaptive* and *event-driven* data\ninteractions.\n\nIt is typically not instantiated directly, but is generated as a\nresult of [Yang::eval](.\/yang.litcoffee#eval-data-opts) for a YANG\n`module` schema.\n\n```javascript\nvar schema = Yang.parse('module foo { container bar { leaf a { type uint8; } } }');\nvar model = schema.eval({ 'foo:bar': { a: 7 } });\n\/\/ model is { 'foo:bar': [Getter\/Setter] }\n```\n\nThe generated `Model` is a hierarchical composition of\n[Property](.\/property.litcoffee) instances. The instance itself uses\n`Object.preventExtensions` to ensure no additional properties that are\nnot known to itself can be added.\n\nIt is designed to provide *stand-alone* interactions on a per-module\nbasis. For flexible management of multiple modules (such as hotplug\nmodules) and data persistence, please take a look at the\n[yang-store](http:\/\/github.com\/corenova\/yang-store) project.\n\n## Class Model\n\n    Stack    = require 'stacktrace-parser'\n    Yang     = require '.\/yang'\n    Property = require '.\/property'\n    XPath    = require '.\/core\/xpath'\n\n    class Model extends Property\n      \n      @Store = {}\n      @MaxTransactions = 100\n      \n      constructor: (schema, data={}) ->\n        unless schema?.kind is 'module'\n          throw new Error \"cannot create Model without YANG 'module' schema\"\n        data = expr.apply data for expr in schema.exprs\n        super schema.tag, data, schema: schema\n\n        if schema.import?\n          new Model dep.module for dep in schema.import when dep.tag not of Model.Store\n\n        @transactable = false\n        @on 'update', (prop, prev) =>\n          return unless @transactable\n          if @pending.length > Model.MaxTransactions\n            throw @error \"exceeded max transactions of #{Model.MaxTransactions}, forgot to save()?\"\n          @pending.push prev\n        Object.defineProperty this, 'pending', value: []\n        Object.preventExtensions this\n        # register this instance in the Model class singleton instance\n        @join Model.Store\n\n      valueOf: -> super false\n\n### save\n\nThis routine triggers a 'commit' event for listeners to handle any\npersistence operations. It also clears the `@pending` transaction\nqueue so that future [rollback](#rollback) will reset back to this state.\n\n      save: ->\n        @emit 'commit', @pending\n        @pending.splice(0, @pending.length) # clear\n        this\n\n### rollback\n\nThis routine will replay tracked updates in reverse order when\n`@transactable` is set to `true`. It will restore any `@pending`\nchanges to the Model instance back to the last [save](#save-opts)\nstate.\n\n      rollback: ->\n        while prop = @pending.pop()\n          prop.join prop.parent, suppress: true\n        this\n\n### set (path..., value)\n\nThis routine allows `set` operation to reference an optional XPATH\nlocation to update with the passed in `value`. Also, it restricts the\ndirect `set` operation on a Model to always peform a `merge: true`.\n\n      set: (path..., value) ->\n        if path.length\n          @in(path[0])?.set? value\n        else\n          value ?= {}\n          super value, merge: true\n\n### find (pattern)\n\nThis routine enables *cross-model* property search when the `Model` is\njoined to another object (such as a datastore). The schema-bound model\nrestricts *cross-model* property access to only those modules that are\n`import` dependencies of the current model instance.\n\n      find: (pattern='.', opts={}) ->\n        return super unless @parent?\n        \n        console.debug? \"[Model:#{@name}] find #{pattern}\"\n        match = super pattern, root: true\n        return match if match?.length or opts.root\n        \n        # here we have a @parent that likely has a collectin of Models\n        opts.root = true\n        for k, model of @parent.__props__ when k isnt @name\n          console.debug? \"[Model:#{@name}] looking at #{k}.find\"\n          try match = model.find pattern, opts\n          catch then continue\n          return match if match?.length\n        return []\n\n### invoke (path, input)\n\nExecutes a `Property` holding a function found at the `path` using the\n`input` data.\n\n      invoke: (path, input) -> @in(path)?.invoke? input\n\n### on (event)\n\nThe `Model` instance is an `EventEmitter` and you can attach various\nevent listeners to handle events generated by the `Model`:\n\nevent | arguments | description\n--- | --- | ---\nupdate | (prop, prev) | fired when an update takes place within the data tree\nchange | (elems...) | fired when the schema is modified\ncreate | (items...) | fired when one or more `list` element is added\ndelete | (items...) | fired when one or more `list` element is deleted\n\nIt also accepts optional XPATH\/YPATH expressions which will *filter*\nfor granular event subscription to specified events from only the\nelements of interest.\n\nThe event listeners to the `Model` can handle any customized behavior\nsuch as saving to database, updating read-only state, scheduling\nbackground tasks, etc.\n\nThis operation is protected from recursion, where operations by the\n`callback` may result in the same `callback` being executed multiple\ntimes due to subsequent events triggered due to changes to the\n`Model`. Currently, it will allow the same `callback` to be executed\nat most two times.\n\n      on: (event, filters..., callback) ->\n        unless callback instanceof Function\n          throw new Error \"must supply callback function to listen for events\"\n          \n        recursive = (name) ->\n          seen = {}\n          frames = Stack.parse(new Error().stack)\n          for frame, i in frames when ~frame.methodName.indexOf(name)\n            { file, lineNumber, column } = frames[i-1]\n            callee = \"#{file}:#{lineNumber}:#{column}\"\n            seen[callee] ?= 0\n            if ++seen[callee] > 1\n              console.warn \"detected recursion for '#{callee}'\"\n              return true \n          return false\n\n        $$$ = (prop, args...) ->\n          console.debug? \"$$$: check if '#{prop.path}' in '#{filters}'\"\n          if not filters.length or prop.path.contains filters...\n            unless recursive('$$$')\n              callback.apply this, [prop].concat args\n\n        super event, $$$\n\nPlease refer to [Model Events](..\/TUTORIAL.md#model-events) section of\nthe [Getting Started Guide](..\/TUTORIAL.md) for usage examples.\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n## Export Model Class\n\n    module.exports = Model\n","old_contents":"# Model - instance of schema-driven data\n\nThe `Model` class aggregates [Property](.\/property.litcoffee)\nattachments to provide the *adaptive* and *event-driven* data\ninteractions.\n\nIt is typically not instantiated directly, but is generated as a\nresult of [Yang::eval](.\/yang.litcoffee#eval-data-opts) for a YANG\n`module` schema.\n\n```javascript\nvar schema = Yang.parse('module foo { container bar { leaf a { type uint8; } } }');\nvar model = schema.eval({ 'foo:bar': { a: 7 } });\n\/\/ model is { 'foo:bar': [Getter\/Setter] }\n```\n\nThe generated `Model` is a hierarchical composition of\n[Property](.\/property.litcoffee) instances. The instance itself uses\n`Object.preventExtensions` to ensure no additional properties that are\nnot known to itself can be added.\n\nIt is designed to provide *stand-alone* interactions on a per-module\nbasis. For flexible management of multiple modules (such as hotplug\nmodules) and data persistence, please take a look at the\n[yang-store](http:\/\/github.com\/corenova\/yang-store) project.\n\n## Class Model\n\n    Stack    = require 'stacktrace-parser'\n    Yang     = require '.\/yang'\n    Property = require '.\/property'\n    XPath    = require '.\/core\/xpath'\n\n    class Model extends Property\n      \n      @Store = {}\n      @MaxTransactions = 100\n      \n      constructor: (schema, data={}) ->\n        unless schema?.kind is 'module'\n          throw new Error \"cannot create Model without YANG 'module' schema\"\n        data = expr.apply data for expr in schema.exprs\n        super schema.tag, data, schema: schema\n\n        if schema.import?\n          new Model dep.module for dep in schema.import when dep.tag not of Model.Store\n\n        @transactable = false\n        @on 'update', (prop, prev) =>\n          return unless @transactable\n          if @pending.length > Model.MaxTransactions\n            throw @error \"exceeded max transactions of #{Model.MaxTransactions}, forgot to save()?\"\n          @pending.push prev\n        Object.defineProperty this, 'pending', value: []\n        Object.preventExtensions this\n        # register this instance in the Model class singleton instance\n        @join Model.Store\n\n      valueOf: -> super false\n\n### save\n\nThis routine triggers a 'commit' event for listeners to handle any\npersistence operations. It also clears the `@pending` transaction\nqueue so that future [rollback](#rollback) will reset back to this state.\n\n      save: ->\n        @emit 'commit'\n        @pending.splice(0, @pending.length) # clear\n        this\n\n### rollback\n\nThis routine will replay tracked updates in reverse order when\n`@transactable` is set to `true`. It will restore any `@pending`\nchanges to the Model instance back to the last [save](#save-opts)\nstate.\n\n      rollback: ->\n        while prop = @pending.pop()\n          prop.join prop.parent, suppress: true\n        this\n\n### set (path..., value)\n\nThis routine allows `set` operation to reference an optional XPATH\nlocation to update with the passed in `value`. Also, it restricts the\ndirect `set` operation on a Model to always peform a `merge: true`.\n\n      set: (path..., value) ->\n        if path.length\n          @in(path[0])?.set? value\n        else\n          value ?= {}\n          super value, merge: true\n\n### find (pattern)\n\nThis routine enables *cross-model* property search when the `Model` is\njoined to another object (such as a datastore). The schema-bound model\nrestricts *cross-model* property access to only those modules that are\n`import` dependencies of the current model instance.\n\n      find: (pattern='.', opts={}) ->\n        return super unless @parent?\n        \n        console.debug? \"[Model:#{@name}] find #{pattern}\"\n        match = super pattern, root: true\n        return match if match?.length or opts.root\n        \n        # here we have a @parent that likely has a collectin of Models\n        opts.root = true\n        for k, model of @parent.__props__ when k isnt @name\n          console.debug? \"[Model:#{@name}] looking at #{k}.find\"\n          try match = model.find pattern, opts\n          catch then continue\n          return match if match?.length\n        return []\n\n### invoke (path, input)\n\nExecutes a `Property` holding a function found at the `path` using the\n`input` data.\n\n      invoke: (path, input) -> @in(path)?.invoke? input\n\n### on (event)\n\nThe `Model` instance is an `EventEmitter` and you can attach various\nevent listeners to handle events generated by the `Model`:\n\nevent | arguments | description\n--- | --- | ---\nupdate | (prop, prev) | fired when an update takes place within the data tree\nchange | (elems...) | fired when the schema is modified\ncreate | (items...) | fired when one or more `list` element is added\ndelete | (items...) | fired when one or more `list` element is deleted\n\nIt also accepts optional XPATH\/YPATH expressions which will *filter*\nfor granular event subscription to specified events from only the\nelements of interest.\n\nThe event listeners to the `Model` can handle any customized behavior\nsuch as saving to database, updating read-only state, scheduling\nbackground tasks, etc.\n\nThis operation is protected from recursion, where operations by the\n`callback` may result in the same `callback` being executed multiple\ntimes due to subsequent events triggered due to changes to the\n`Model`. Currently, it will allow the same `callback` to be executed\nat most two times.\n\n      on: (event, filters..., callback) ->\n        unless callback instanceof Function\n          throw new Error \"must supply callback function to listen for events\"\n          \n        recursive = (name) ->\n          seen = {}\n          frames = Stack.parse(new Error().stack)\n          for frame, i in frames when ~frame.methodName.indexOf(name)\n            { file, lineNumber, column } = frames[i-1]\n            callee = \"#{file}:#{lineNumber}:#{column}\"\n            seen[callee] ?= 0\n            if ++seen[callee] > 1\n              console.warn \"detected recursion for '#{callee}'\"\n              return true \n          return false\n\n        $$$ = (prop, args...) ->\n          console.debug? \"$$$: check if '#{prop.path}' in '#{filters}'\"\n          if not filters.length or prop.path.contains filters...\n            unless recursive('$$$')\n              callback.apply this, [prop].concat args\n\n        super event, $$$\n\nPlease refer to [Model Events](..\/TUTORIAL.md#model-events) section of\nthe [Getting Started Guide](..\/TUTORIAL.md) for usage examples.\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n## Export Model Class\n\n    module.exports = Model\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"761c670cb9871d2a519b9730094b30bdb3d97782","subject":"Log uncaught exceptions to Sentry","message":"Log uncaught exceptions to Sentry\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n    if process.env.SENTRY_DNS\n      app.use raven.middleware.express process.env.SENTRY_DNS\n      raven.patchGlobal process.env.SENTRY_DNS\n\n### Error handling\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n### API keys\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'DNT'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone about the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        when 'PUT'  then collection.put req, res, next\n        when 'PATCH' then collection.patch req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then document.options req, res, next\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n    app.use(raven.middleware.express(process.env.SENTRY_DNS)) if process.env.SENTRY_DNS\n\n### Error handling\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n### API keys\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'DNT'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone about the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        when 'PUT'  then collection.put req, res, next\n        when 'PATCH' then collection.patch req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then document.options req, res, next\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d9421e4b62cd18a7ef3adf6020020c7a9ec33ee8","subject":"add said nothing post","message":"add said nothing post\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"server\/queueMethods.litcoffee","new_file":"server\/queueMethods.litcoffee","new_contents":"# Super secret queue methods\n\n    @QueueMethods =\n      popAndServeNextTicket: ->\n\nMove the current connection to the processed queue\n\nTODO: get postID\n\n        queueMeta = QueueMeta.findOne()\n\nUpdate object, extended at various point for updating the QueueMeta in one swoop\n\n        update =\n          $set: {}\n\nIf `theOnlyConnectionAllowedIn` is set to something, check if the connection\nhas expired and process the connection if it has.\n\n        if queueMeta.theOnlyConnectionAllowedIn isnt undefined\n\n          previousConnection = queueMeta.theOnlyConnectionAllowedIn\n          previousConnectionDidntPosted = not queueMeta.hasCurrentConnectionPosted\n\nReturn if timeCurrentTicketExpires is in the future (hasn't expired)\n\n          hasntExpired = queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n          return if hasntExpired\n\nOkay then, the current connection has expired, time to get bumped.\nInsert the processed connection into the ProcessedQueue\n\n          try\n\nCalculate how long the connection had to wait in line.\n\n            waitTimeSeconds = moment.utc().diff (moment.utc queueMeta.theOnlyConnectionAllowedIn.timeEnqueued), 'seconds'\n\nMake the processed object.\n\n            processed =\n              connection: queueMeta.theOnlyConnectionAllowedIn\n              waitTimeSeconds: waitTimeSeconds\n\nInsert the processed connection to `QueueProcessed`\n\n            QueueProcessed.insert processed\n          catch err\n            console.log err\n\nRemove the connection from the `Queue`\n\n          criteria = connectionId: queueMeta.theOnlyConnectionAllowedIn.connectionId\n          Queue.remove criteria\n\nUpdate `QueueMeta` stats and ticket number.\n\n          try\n            totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n            currentlyServingTicketNumber = queueMeta.currentlyServingTicketNumber + 1\n            _.extend update.$set,\n              currentlyServingTicketNumber: currentlyServingTicketNumber\n              hasCurrentConnectionPosted: no\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          catch err\n            console.log err\n\nLookup the lowest ticket # waiting in the `Queue`\n\n        nextConnection = Queue.findOne {}, $sort: [ 'ticketNumber': 'asc' ]\n\nSet the allowed connection and expireTime if one exists\n\nIf there is a nextConnection (i.e. someone waiting in line), then serve them.\nOtherwise clear out theOnlyConnectionAllowedIn.\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          _.extend update.$set,\n            theOnlyConnectionAllowedIn: nextConnection\n            timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n            currentlyServingTicketNumber: nextConnection.ticketNumber\n\nIf there is no nextConnection, unset theOnlyConnectionAllowedIn.\nNote, fake data is filled in to pass schema, even though we're $unset'ing\n\n        else\n          update.$unset = theOnlyConnectionAllowedIn: \"\"\n\n        criteria = _id: queueMeta._id\n\nDelete `update.$set` if it's empty\n\n        if _.isEmpty update.$set\n          delete update.$set\n\nIf `update` isn't empty, update!\n\n        if not _.isEmpty update\n          QueueMeta.update criteria, update\n\nIf previousConnection connection didn't post, post for her\n\n        if previousConnectionDidntPosted\n          post =\n            name: previousConnection.name\n            message: 'Had nothing to say...'\n            connectionId: previousConnection.connectionId\n            ticketNumber: previousConnection.ticketNumber\n\n          Posts.insert post\n\n\nTODO: keep it DRY; logic isn't exactly shared and want to keep update atomic to\navoid extraneous DDP messages.\n\n## Disconnect, remove from queue\n\n    Meteor.onConnection (connection) ->\n      connection.onClose ->\n\nRemove the connection from the `Queue`\n\n          criteria = connectionId: connection.id\n          Queue.remove criteria\n","old_contents":"# Super secret queue methods\n\n    @QueueMethods =\n      popAndServeNextTicket: ->\n\nMove the current connection to the processed queue\n\nTODO: get postID\n\n        queueMeta = QueueMeta.findOne()\n\nUpdate object, extended at various point for updating the QueueMeta in one swoop\n\n        update =\n          $set: {}\n\nIf `theOnlyConnectionAllowedIn` is set to something, check if the connection\nhas expired and process the connection if it has.\n\n        if queueMeta.theOnlyConnectionAllowedIn isnt undefined\n\nReturn if timeCurrentTicketExpires is in the future (hasn't expired)\n\n          hasntExpired = queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n          return if hasntExpired\n\nOkay then, the current connection has expired, time to get bumped.\nInsert the processed connection into the ProcessedQueue\n\n          try\n\nCalculate how long the connection had to wait in line.\n\n            waitTimeSeconds = moment.utc().diff (moment.utc queueMeta.theOnlyConnectionAllowedIn.timeEnqueued), 'seconds'\n\nMake the processed object.\n\n            processed =\n              connection: queueMeta.theOnlyConnectionAllowedIn\n              waitTimeSeconds: waitTimeSeconds\n\nInsert the processed connection to `QueueProcessed`\n\n            QueueProcessed.insert processed\n          catch err\n            console.log err\n\nRemove the connection from the `Queue`\n\n          criteria = connectionId: queueMeta.theOnlyConnectionAllowedIn.connectionId\n          Queue.remove criteria\n\nUpdate `QueueMeta` stats and ticket number.\n\n          try\n            totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n            currentlyServingTicketNumber = queueMeta.currentlyServingTicketNumber + 1\n            _.extend update.$set,\n              currentlyServingTicketNumber: currentlyServingTicketNumber\n              hasCurrentConnectionPosted: no\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          catch err\n            console.log err\n\nLookup the lowest ticket # waiting in the `Queue`\n\n        nextConnection = Queue.findOne {}, $sort: [ 'ticketNumber': 'asc' ]\n\nSet the allowed connection and expireTime if one exists\n\nIf there is a nextConnection (i.e. someone waiting in line), then serve them.\nOtherwise clear out theOnlyConnectionAllowedIn.\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          _.extend update.$set,\n            theOnlyConnectionAllowedIn: nextConnection\n            timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n            currentlyServingTicketNumber: nextConnection.ticketNumber\n\nIf there is no nextConnection, unset theOnlyConnectionAllowedIn.\nNote, fake data is filled in to pass schema, even though we're $unset'ing\n\n        else\n          update.$unset = theOnlyConnectionAllowedIn: \"\"\n\n        criteria = _id: queueMeta._id\n\nDelete `update.$set` if it's empty\n\n        if _.isEmpty update.$set\n          delete update.$set\n\nIf `update` isn't empty, update!\n\n        if not _.isEmpty update\n          QueueMeta.update criteria, update\n\nTODO: keep it DRY; logic isn't exactly shared and want to keep update atomic to\navoid extraneous DDP messages.\n\n## Disconnect, remove from queue\n\n    Meteor.onConnection (connection) ->\n      connection.onClose ->\n\nRemove the connection from the `Queue`\n\n          criteria = connectionId: connection.id\n          Queue.remove criteria\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4571e75768f566ef83c9bad6afd030de59d3f2a7","subject":"add docs for Enumerable::inGroupsOf","message":"add docs for Enumerable::inGroupsOf\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/04_enumerable.litcoffee","new_file":"docs\/04_enumerable.litcoffee","new_contents":"# \/api\/Data Structures\/Batman.Enumerable\n\n`Batman.Enumerable` is a mixin that defines methods available for every\nenumerable type (`Batman.Set` and `Batman.Hash` being the main two).\n\nNote that where the signature of the callback functions is defined, `element`\nis the value of the current element being iterated over, and `value` is\n`null`\u2014except in the case of `Batman.Hash` where `element` is the key and\n`value` is the value.\n\n## Implementing your own `Batman.Enumerable`\n\nTo make these methods available for a new type, all you need to do is define\n`forEach()` and `length`. Then, in your type, you can just `Batman.extend\n@prototype, Batman.Enumerable` to copy the `Enumerable` methods onto your\nprototype.\n\n## ::.length : number\n\nThe number of elements.\n\n## ::forEach(func)\n\nCalls `func` once for each element.\n`func` receives the arguments `(element, value, this)`\n\n    test \"forEach runs n times\", ->\n      set = new Batman.Set('a', 'b')\n      count = 0\n      set.forEach -> count++\n      equal count, 2\n\n## ::map(func[, context = Batman.container]) : Array\n\nCalls `func` once for each element, and returns an array composed of the return\nvalue at each iteration.  `func` receives the arguments `(element, value,\nthis)`\n\n    test \"forEach runs n times\", ->\n      set = new Batman.Set(1, 2)\n      deepEqual [2, 3], set.map (x) -> x + 1\n\n## ::mapToProperty(key : string) : Array\n\nReturns an array composed of the property specified of each item.\n`func` receives the arguments `(element, value, this)`\n\n    test \"mapToProperty pulls out the property specified\", ->\n      set = new Batman.Set({key: 'a'}, {key: 'b'})\n      deepEqual ['a', 'b'], set.mapToProperty('key')\n\n## ::every(func[, context = Batman.container]) : boolean\n\nCalls `func` once for each element, and returns true if `func` returns true for\nevery iteration.  `func` receives the arguments `(element, value, this)`\n\n    test \"every is false when any element doesn't satisfy the selector function\", ->\n      set = new Batman.Set(true, false, true)\n      equal false, set.every (x) -> x\n\n## ::some(func[, context = Batman.container]) : boolean\n\nCalls `func` once for each element, and returns true if `func` returns true for\nany iteration.  `func` receives the arguments `(element, value, this)`\n\n    test \"some is true when any element satisfies the selector function\", ->\n      set = new Batman.Set(true, false, true)\n      equal true, set.some (x) -> x\n\n\n## ::reduce(func[, accumulator]) : Array\n\nCalls `func` once for each element, accumulating the result as it goes along.\nIf you pass your own `accumulator` it will retain its initial value, otherwise\nthe first element will become the initial accumulator value.  `func` receives\nthe arguments `(accumulator, element, value, index, this)`\n\n    test \"reduce can implement a sum\", ->\n      set = new Batman.Set(1, 2, 3)\n      equal 6, set.reduce (accumulator, x) -> accumulator + x\n\n\n## ::filter(func) : Object\n\nCreates a new instance of the current type, and adds every element for which\n`func` returns true.  `func` receives the arguments `(element, value, this)`\n\n    test \"filter strips out the crud\", ->\n      set = new Batman.Set('wheat', 'crud', 'grain')\n      deepEqual ['wheat', 'grain'], (set.filter (x) -> x != 'crud').toArray()\n\n## ::count(func) : number\n\nReturns the number of elements for which `func` returns true, or the total\nnumber of elements if you don't pass a `func`.  `func` receives the arguments\n`(element, value, this)`\n\n    test \"count counts\", ->\n      set = new Batman.Set(1, 2, 3)\n      equal 3, set.count()\n      equal 2, set.count (x) -> x > 1\n\n## ::inGroupsOf(groupSize: number) : Array\n\nSplits the enumerable into groups of up to `groupSize` and returns the items in an array of arrays.\n\n  test \"inGroupsOf returns an array of arrays\", ->\n    set = new Batman.Set(1,2,3,4,5,6,7,8)\n    groups = set.inGroupsOf(3)\n    equal 3, groups[0].length\n    equal 3, groups[1].length\n    equal 2, groups[2].length, \"The last group might be smaller\"\n","old_contents":"# \/api\/Data Structures\/Batman.Enumerable\n\n`Batman.Enumerable` is a mixin that defines methods available for every\nenumerable type (`Batman.Set` and `Batman.Hash` being the main two).\n\nNote that where the signature of the callback functions is defined, `element`\nis the value of the current element being iterated over, and `value` is\n`null`\u2014except in the case of `Batman.Hash` where `element` is the key and\n`value` is the value.\n\n## ::.length : number\n\nThe number of elements.\n\n\n## ::forEach(func)\n\nCalls `func` once for each element.\n`func` receives the arguments `(element, value, this)`\n\n    test \"forEach runs n times\", ->\n      set = new Batman.Set('a', 'b')\n      count = 0\n      set.forEach -> count++\n      equal count, 2\n\n\n## ::map(func[, context = Batman.container]) : Array\n\nCalls `func` once for each element, and returns an array composed of the return\nvalue at each iteration.  `func` receives the arguments `(element, value,\nthis)`\n\n    test \"forEach runs n times\", ->\n      set = new Batman.Set(1, 2)\n      deepEqual [2, 3], set.map (x) -> x + 1\n\n## ::mapToProperty(key : string) : Array\n\nReturns an array composed of the property specified of each item.\n`func` receives the arguments `(element, value, this)`\n\n    test \"mapToProperty pulls out the property specified\", ->\n      set = new Batman.Set({key: 'a'}, {key: 'b'})\n      deepEqual ['a', 'b'], set.mapToProperty('key')\n\n\n## ::every(func[, context = Batman.container]) : boolean\n\nCalls `func` once for each element, and returns true if `func` returns true for\nevery iteration.  `func` receives the arguments `(element, value, this)`\n\n    test \"every is false when any element doesn't satisfy the selector function\", ->\n      set = new Batman.Set(true, false, true)\n      equal false, set.every (x) -> x\n\n\n## ::some(func[, context = Batman.container]) : boolean\n\nCalls `func` once for each element, and returns true if `func` returns true for\nany iteration.  `func` receives the arguments `(element, value, this)`\n\n    test \"some is true when any element satisfies the selector function\", ->\n      set = new Batman.Set(true, false, true)\n      equal true, set.some (x) -> x\n\n\n## ::reduce(func[, accumulator]) : Array\n\nCalls `func` once for each element, accumulating the result as it goes along.\nIf you pass your own `accumulator` it will retain its initial value, otherwise\nthe first element will become the initial accumulator value.  `func` receives\nthe arguments `(accumulator, element, value, index, this)`\n\n    test \"reduce can implement a sum\", ->\n      set = new Batman.Set(1, 2, 3)\n      equal 6, set.reduce (accumulator, x) -> accumulator + x\n\n\n## ::filter(func) : Object\n\nCreates a new instance of the current type, and adds every element for which\n`func` returns true.  `func` receives the arguments `(element, value, this)`\n\n    test \"filter strips out the crud\", ->\n      set = new Batman.Set('wheat', 'crud', 'grain')\n      deepEqual ['wheat', 'grain'], (set.filter (x) -> x != 'crud').toArray()\n\n## ::count(func) : number\n\nReturns the number of elements for which `func` returns true, or the total\nnumber of elements if you don't pass a `func`.  `func` receives the arguments\n`(element, value, this)`\n\n    test \"count counts\", ->\n      set = new Batman.Set(1, 2, 3)\n      equal 3, set.count()\n      equal 2, set.count (x) -> x > 1\n\n## Implementing your own `Batman.Enumerable`\n\nTo make these methods available for a new type, all you need to do is define\n`forEach()` and `length`. Then, in your type, you can just `Batman.extend\n@prototype, Batman.Enumerable` to copy the `Enumerable` methods onto your\nprototype.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"34f345e7df87fe9eaee47f55994a40398d700465","subject":"Adding with to jQuery plugins","message":"Adding with to jQuery plugins\n","repos":"ojjs\/oj","old_file":"src\/oj.litcoffee","new_file":"src\/oj.litcoffee","new_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = ->\n\n  oj function acts like a tag method that doesn't emit\n\n      oj._argsPush()\n      ojml = oj.emit.apply @, arguments\n      oj._argsPop()\n      ojml\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.0.14'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\nTODO: Static server side support for loading any generated pages dynamically.\nTODO: Support Backbone routes to trigger page changes.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      jQuery ->\n\n        $.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      # TODO: support cloning OJ instances\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n\nIndexing Helpers\n-----------------------------------------------------------------------------\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = ArrayP.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name) ->\n      obj = if oj.isClient then window[name] else global[name]\n      throw new Error(\"oj: #{name} dependency is missing\") unless oj.isDefined obj\n\nDepend on jQuery\n\n    oj.dependency 'jQuery'\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw new Error('oj.isProperty: string expected for second argument') unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, args...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from args by unioning all objects\n\n      attributes = {}\n      for arg in args\n\n  TODO: evaluate argument if necessary\n\n        if oj.isObject arg\n          _extend attributes, arg\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n        else if oj.isFunction arg\n\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to\n\n      oj._argsAppend ojml\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n        oj[t] = -> oj.tag t, arguments...\n        # Remember the tag name\n        _setTagName oj[t], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extend (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.extend = (context = root) ->\n      o = {}\n      for k,v of oj\n        if k[0] != '_'\n          o[k] = v\n      delete o.extend\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* debug - Keep all source including comments\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        debug: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, debug: options.debug, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n  TODO: Refactor to use the same code as media queries\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.debug then '\\n' else ''\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      debug = options.debug ? 0\n      tags = options.tags ? 0\n      minify = options.minify ? 0\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if debug and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if debug then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\ndebug:true will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      debug = options.debug ? 0\n      tags = options.tags ? 0\n      minify = options.minify ? 0\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        when 'jquery'\n          # TODO: Missing unit tests for the jquery case\n          options.html?.push ojml.html()\n          options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML()\n            options.dom?.appendChild ojml.toDOM()\n            if options.css?\n              _extend options.css, ojml.toCSSMap()\n\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        throw new Error('oj.compile: doctype expects string as first argument') unless oj.isString ojml[1]\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip intention if there is only one child\n          if options.debug and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if options.debug and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mouseleave:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # TODO: Consider jsoning anything that isn't a string\n      # any keys that aren't strings are jsoned\n      # _attributesJSONAllKeys attributes\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if $?\n          if oj.isArray ev\n            $(el)[ek].apply @, ev\n          else\n            $(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        # TODO: Make this O(1)\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        # TODO: Make this O(1)\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = $ @el)\n\n        # Get and set id attribute of view\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # # Get and set class attribute of view\n        # class:\n        #   get: -> @$el.attr 'class'\n        #   set: (v) ->\n        #     # Join arrays with spaces\n        #     if oj.isArray v\n        #       v = v.join ' '\n        #     @$el.attr 'class', v\n        #     return\n\n        # # Alias for class\n        # c:\n        #   get: -> @class\n        #   set: (v) -> @class = v; return\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all currently set themes (readwrite)\n        themes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n              if k == 'class'\n                @addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single class\n        addClass: (name) ->\n          @$el.addClass name\n          return\n\n        # Remove a single class\n        removeClass: (name) ->\n          @$el.removeClass name\n          return\n\n        # Add a single theme\n        addTheme: (name) ->\n          @addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @removeClass \"theme-#{name}\"\n          return\n\n        # Clear all themes\n        clearThemes: (name) ->\n          @$el.removeClass \"theme-#{name}\"\n          classes = @$el.attr('class').split(' ')\n          _each classes, (v) ->\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.debug then '\\n' else '')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (debug) -> _cssFromPluginObject (_flattenCSSMap @cssMap), debug:debug,tags:0\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      throw new Error(\"oj.#{@typeName}.css: object or string expected for first argument\") unless oj.isString(css) or oj.isObject(css)\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      throw new Error(\"oj.#{@typeName}.theme: string expected for first argument (theme name)\") unless oj.isString name\n      throw new Error(\"oj.#{@typeName}.css: object expected for second argument\") unless oj.isObject(css)\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> console.log \"clearing body: oj.litcoffee:2930\";@$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get $(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set $(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if $('.' + _styleClassFromPlugin plugin).length == 0\n          $('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    jQuery.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        `with (oj) {`\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n        `}`\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    jQuery.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:1, meta:1, title:'deep', link:1, script:1\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj: dom compile error: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      $('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    jQuery.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    jQuery.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        jQuery.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","old_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = ->\n\n  oj function acts like a tag method that doesn't emit\n\n      oj._argsPush()\n      ojml = oj.emit.apply @, arguments\n      oj._argsPop()\n      ojml\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.0.14'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\nTODO: Static server side support for loading any generated pages dynamically.\nTODO: Support Backbone routes to trigger page changes.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      jQuery ->\n\n        $.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      # TODO: support cloning OJ instances\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n\nIndexing Helpers\n-----------------------------------------------------------------------------\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = ArrayP.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name) ->\n      obj = if oj.isClient then window[name] else global[name]\n      throw new Error(\"oj: #{name} dependency is missing\") unless oj.isDefined obj\n\nDepend on jQuery\n\n    oj.dependency 'jQuery'\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw new Error('oj.isProperty: string expected for second argument') unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, args...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from args by unioning all objects\n\n      attributes = {}\n      for arg in args\n\n  TODO: evaluate argument if necessary\n\n        if oj.isObject arg\n          _extend attributes, arg\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n        else if oj.isFunction arg\n\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to\n\n      oj._argsAppend ojml\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n        oj[t] = -> oj.tag t, arguments...\n        # Remember the tag name\n        _setTagName oj[t], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extend (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.extend = (context = root) ->\n      o = {}\n      for k,v of oj\n        if k[0] != '_'\n          o[k] = v\n      delete o.extend\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* debug - Keep all source including comments\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        debug: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, debug: options.debug, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n  TODO: Refactor to use the same code as media queries\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.debug then '\\n' else ''\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      debug = options.debug ? 0\n      tags = options.tags ? 0\n      minify = options.minify ? 0\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if debug and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if debug then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\ndebug:true will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      debug = options.debug ? 0\n      tags = options.tags ? 0\n      minify = options.minify ? 0\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        when 'jquery'\n          # TODO: Missing unit tests for the jquery case\n          options.html?.push ojml.html()\n          options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML()\n            options.dom?.appendChild ojml.toDOM()\n            if options.css?\n              _extend options.css, ojml.toCSSMap()\n\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        throw new Error('oj.compile: doctype expects string as first argument') unless oj.isString ojml[1]\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip intention if there is only one child\n          if options.debug and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if options.debug and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # TODO: Consider jsoning anything that isn't a string\n      # any keys that aren't strings are jsoned\n      # _attributesJSONAllKeys attributes\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if $?\n          if oj.isArray ev\n            $(el)[ek].apply @, ev\n          else\n            $(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        # TODO: Make this O(1)\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        # TODO: Make this O(1)\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = $ @el)\n\n        # Get and set id of view from attribute\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all currently set themes (readwrite)\n        themes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n\n              # Wrap k in quotes if it has whitespace\n              if k == 'class'\n                @$el.addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single theme\n        addTheme: (name) ->\n          @$el.addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @$el.removeClass \"theme-#{name}\"\n          return\n\n        # Clear all themes\n        clearThemes: (name) ->\n          @$el.removeClass \"theme-#{name}\"\n          classes = @$el.attr('class').split(' ')\n          _each classes, (v) ->\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.debug then '\\n' else '')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (debug) -> _cssFromPluginObject (_flattenCSSMap @cssMap), debug:debug,tags:0\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      throw new Error(\"oj.#{@typeName}.css: object or string expected for first argument\") unless oj.isString(css) or oj.isObject(css)\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      throw new Error(\"oj.#{@typeName}.theme: string expected for first argument (theme name)\") unless oj.isString name\n      throw new Error(\"oj.#{@typeName}.css: object expected for second argument\") unless oj.isObject(css)\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> console.log \"clearing body: oj.litcoffee:2930\";@$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get $(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set $(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if $('.' + _styleClassFromPlugin plugin).length == 0\n          $('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    jQuery.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    jQuery.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:1, meta:1, title:'deep', link:1, script:1\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj: dom failed to compile with error: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      $('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    jQuery.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    jQuery.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        jQuery.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a933795a64f904288837ade2b77adfb9e4fc7b92","subject":"isData in valid","message":"isData in valid\n","repos":"vpj\/models","old_file":"js\/properties\/value.litcoffee","new_file":"js\/properties\/value.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#Value\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       propertyType: 'value'\n\n       @default 'value', (str, stack) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value, stack) -> \"#{value}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str, stack, isData = false) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str, stack) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value, stack) ->\n        value is @schema.default()\n\n       parse: (data, stack) ->\n        r = super data, stack\n        return r unless r is true\n        if not @schema.valid data, stack, true\n         return @error 'invalid'\n\n        return {\n         score: 1\n         errors: []\n         value: @schema.value data, stack\n        }\n\n       toJSON: (value, stack) -> value\n       toJSONFull: (value, stack) -> value\n\n       edit: (elem, value, onChanged, stack) ->\n        new Edit this, elem, value, onChanged, stack\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, onChanged, stack) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = onChanged\n        @stack = stack\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           placeholder: @$.property._name\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = schema.string @value, @stack\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n        @change()\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value, @stack\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r, i in results\n          break if i > 10\n          e = @div r\n          e._result = r\n\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @elems.search.style.display = 'none'\n        @change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 400\n\n       @listen 'change', (e) ->\n        @search()\n        @change()\n\n       change: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value, @stack\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value, @stack\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#Value\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       propertyType: 'value'\n\n       @default 'value', (str, stack) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value, stack) -> \"#{value}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str, stack) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str, stack) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value, stack) ->\n        value is @schema.default()\n\n       parse: (data, stack) ->\n        r = super data, stack\n        return r unless r is true\n        if not @schema.valid data, stack\n         return @error 'invalid'\n\n        return {\n         score: 1\n         errors: []\n         value: @schema.value data, stack\n        }\n\n       toJSON: (value, stack) -> value\n       toJSONFull: (value, stack) -> value\n\n       edit: (elem, value, onChanged, stack) ->\n        new Edit this, elem, value, onChanged, stack\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, onChanged, stack) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = onChanged\n        @stack = stack\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           placeholder: @$.property._name\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = schema.string @value, @stack\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n        @change()\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value, @stack\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r, i in results\n          break if i > 10\n          e = @div r\n          e._result = r\n\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @elems.search.style.display = 'none'\n        @change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 400\n\n       @listen 'change', (e) ->\n        @search()\n        @change()\n\n       change: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value, @stack\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value, @stack\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ff790dd3f52d6eed3c5923b7c04668c59c72ee5e","subject":"added some more standard JS global objects","message":"added some more standard JS global objects\n","repos":"arximboldi\/heterarchy","old_file":"heterarchy.litcoffee","new_file":"heterarchy.litcoffee","new_contents":"heterarchy\n==========\n\n> This file is part of [Heterarchy](http:\/\/sinusoid.es\/heterarchy).\n> - **View me [on a static web](http:\/\/sinusoid.es\/heterarchy\/heterarchy.html)**\n> - **View me [on GitHub](https:\/\/github.com\/arximboldi\/heterarchy\/blob\/master\/heterarchy.litcoffee)**\n\nAdds multiple inheritance support to CoffeeScript (and JavaScript).\nIt uses the C3 linearization algorithm as described in the [famous\nDylan paper](http:\/\/192.220.96.201\/dylan\/linearization-oopsla96.html).\n\n    {head, tail, map, find, some, without, isEmpty, every, memoize, reject,\n     partial, isEqual} =\n        require 'underscore'\n\n    assert = (value, error) ->\n        if not value\n           throw new Error(if error? then error else \"Assertion failed\")\n\nMultiple inheritance\n--------------------\n\nThe **multi** function takes a list of classes and returns a *special*\nclass object that merges the class hierarchies, as linearized by the\nC3 algorithm. Limitations of the approach are:\n\n- `instanceof` does not always work as expected. For example:\n\n  > ```coffee\n  > class A\n  > class B extends A\n  > class C extends A\n  > class D extends multi B, C\n  > assert new D not instanceof B\n  > ```\n\n  Instead, one should use the provided `isinstance` function.\n\n- Some of the bases of a multi-inherited hierarchy are *frozen* when\n  the sub-class is defined -- i.e. later modifications to the\n  superclass are not visible to the subclass or its instances.  For\n  example, in the previous heterarchy:\n\n  > ```coffee\n  > B::newProperty = 42\n  > assert D::newProperty == undefined\n  > ```\n\nThe `multi` function memoizes its results such that identity is\nmaintained, implying `multi X, Y is multi X, Y`.\n\n    exports.multi = (bases...) ->\n        generate merge map(bases, mro).concat [bases]\n\nThis takes a list of classes representing a hierarchy (from most to\nleast derived) and generates a single-inheritance hierarchy that\nbehaves like a class that would be have such a hierarchy.\n\n    generate = memoize (linearization) ->\n        next = head linearization\n        if isEqual linearization, hierarchy next\n            next\n        else\n            class Result extends generate tail linearization\n                __mro__: linearization\n                constructor: reparent next, @, next::constructor\n                copyOwn next, @\n                copyOwn next::, @::, partial reparent, next, @\n\nThis utility lets us copy own properties of a *from* object that are\nnot own properties of a *to* object into the *to* object, optionally\ntransformed via a projection function.\n\n    copyOwn = (from, to, project = (x) -> x) ->\n        for own key, value of from\n            if not to.hasOwnProperty key\n                to[key] = project value\n        to\n\nMethods in CoffeeScript call super directly, so we have to change the\n`__super__` attribute of the original class during the scope of the\nmethod so it calls the right super of the linearization.  Also,\nprogrammers don't call super in constructor of root classes --indeed\ndoing so would rise an error-- so we have to inject such a call when\nthere are classes after these in the linearization.  The **reparent**\nfunction takes care of all these and given an original class, and the\nnew class that is replacing it a linearized heterarchy, returns a\nwrapped copy of a value of the former that is suitable for replacing\nit in the later.\n\n    reparent = (oldklass, newklass, value) ->\n        if value not instanceof Function\n            value\n        else if value is oldklass::constructor and inherited(oldklass) is Object\n            superctor = inherited(newklass)::constructor\n            ->\n                superctor.apply @, arguments\n                value.apply @, arguments\n        else\n            newsuper = inherited(newklass)::\n            oldsuper = oldklass.__super__\n            ->\n                oldklass.__super__ = newsuper\n                try\n                    value.apply @, arguments\n                finally\n                    oldklass.__super__ = oldsuper\n\nThis is the C3 linearization algorithm, as translated from the\noriginal paper.\n\n    merge = (inputs) ->\n        while not isEmpty inputs\n            next = find (map inputs, head), (candidate) ->\n                every inputs, (input) -> candidate not in tail input\n            assert next?, \"Inconsistent multiple inheritance\"\n            inputs = reject map(inputs, (lst) -> without lst, next), isEmpty\n            next\n\nIntrospection\n-------------\n\nThe **mro** function returns the method resolution order\n(linearization) of a given class:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends B\n> assert mro(C).equals [C, B, A]\n> ```\n\nIt returns the original classes that were mixed in when used with\nmult-inherited classes:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert mro(D).equals [D, B, C, A, Object]\n> ```\n\n    isJavaScriptClass = (cls) ->\n        standardClasses = [\n            Array\n            Boolean\n            Date\n            Error\n            Function\n            Number\n            RegExp\n            String\n            Object\n            EvalError\n            RangeError\n            ReferenceError\n            SyntaxError\n            TypeError\n            URIError\n        ]\n\n        if cls in standardClasses\n            true\n        else\n            # according to https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\n            nonStandardClasses = [\n                \"Symbol\"\n                # typed arrays\n                \"Int8Array\"\n                \"Uint8Array\"\n                \"Uint8ClampedArray\"\n                \"Int16Array\"\n                \"Uint16Array\"\n                \"Int32Array\"\n                \"Uint32Array\"\n                \"Float32Array\"\n                \"Float64Array\"\n                # keyed Keyed collections\n                \"Map\"\n                \"Set\"\n                \"WeakMap\"\n                \"WeakSet\"\n                # Structured data\n                \"ArrayBuffer\"\n                \"DataView\"\n                # Control abstraction objects\n                \"Promise\"\n                \"Generator\"\n                \"GeneratorFunction\"\n                # Reflection\n                \"Reflect\"\n                \"Proxy\"\n            ]\n            for nonStandardClass in nonStandardClasses when cls is window[nonStandardClass]\n                return true\n            false\n\n    exports.mro = mro = (cls) ->\n        if not cls? or not cls::?\n            []\n        else if not cls::hasOwnProperty '__mro__'\n            result = [cls].concat mro inherited(cls)\n            cls::__mro__ = result unless isJavaScriptClass cls\n            result\n        else\n            cls::__mro__\n\nThe **inherited** function returns the CoffeeScript superclass of an\nobject, for example:\n\n> ```coffee\n> class A\n> class B extends A\n> assert inherited(B) == A\n> ```\n\nNote that for multiple inherited classes, this returns the mixed\nobject, not the next class in the MRO, as in:\n\n> ```coffee\n> class C extends multi A, B\n> assert inherited(C) == multi(A, B)\n> ```\n\n    exports.inherited = inherited = (cls) ->\n        Object.getPrototypeOf(cls.prototype)?.constructor\n\nThe **hierarchy** returns the CoffeeScript hierarchy of classes of a\ngiven class, including the class itself.  For multiple inherited\nclasses, it may return speciall classes that were generated to produce\nthe flattening, as in:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert not mro(D).equals hierarchy(D)\n> assert hierarchy(D).equals\n>     [ D, multi(B, C), inherited(multi B, C), A, Object ]\n> ```\n\n    exports.hierarchy = hierarchy = (cls) ->\n        if not cls?\n            []\n        else\n            [cls].concat hierarchy inherited cls\n\nThe **isinstance** function takes an object and a class or classes and\nreturns whether the object is an instance of any of those classes. It\nis compatible with multi-inherited classes.\n\n    exports.isinstance = (obj, classes...) ->\n        exports.issubclass obj?.constructor, classes...\n\nThe **issubclass** tells whether a class is a subtype of another type.\n\n    exports.issubclass = (klass, classes...) ->\n        linearization = mro klass\n        some classes, (cls) -> cls in linearization\n\nLicense\n-------\n\n> Copyright (c) 2013, 2015 Juan Pedro Bolivar Puente <raskolnikov@gnu.org>\n>\n> Permission is hereby granted, free of charge, to any person obtaining a copy\n> of this software and associated documentation files (the \"Software\"), to deal\n> in the Software without restriction, including without limitation the rights\n> to use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\n> copies of the Software, and to permit persons to whom the Software is\n> furnished to do so, subject to the following conditions:\n>\n> The above copyright notice and this permission notice shall be included in\n> all copies or substantial portions of the Software.\n>\n> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n> THE SOFTWARE.\n","old_contents":"heterarchy\n==========\n\n> This file is part of [Heterarchy](http:\/\/sinusoid.es\/heterarchy).\n> - **View me [on a static web](http:\/\/sinusoid.es\/heterarchy\/heterarchy.html)**\n> - **View me [on GitHub](https:\/\/github.com\/arximboldi\/heterarchy\/blob\/master\/heterarchy.litcoffee)**\n\nAdds multiple inheritance support to CoffeeScript (and JavaScript).\nIt uses the C3 linearization algorithm as described in the [famous\nDylan paper](http:\/\/192.220.96.201\/dylan\/linearization-oopsla96.html).\n\n    {head, tail, map, find, some, without, isEmpty, every, memoize, reject,\n     partial, isEqual} =\n        require 'underscore'\n\n    assert = (value, error=undefined) ->\n        if not value\n           throw new Error(if error? then error else \"Assertion failed\")\n\nMultiple inheritance\n--------------------\n\nThe **multi** function takes a list of classes and returns a *special*\nclass object that merges the class hierarchies, as linearized by the\nC3 algorithm. Limitations of the approach are:\n\n- `instanceof` does not always work as expected. For example:\n\n  > ```coffee\n  > class A\n  > class B extends A\n  > class C extends A\n  > class D extends multi B, C\n  > assert new D not instanceof B\n  > ```\n\n  Instead, one should use the provided `isinstance` function.\n\n- Some of the bases of a multi-inherited hierarchy are *frozen* when\n  the sub-class is defined -- i.e. later modifications to the\n  superclass are not visible to the subclass or its instances.  For\n  example, in the previous heterarchy:\n\n  > ```coffee\n  > B::newProperty = 42\n  > assert D::newProperty == undefined\n  > ```\n\nThe `multi` function memoizes its results such that identity is\nmaintained, implying `multi X, Y is multi X, Y`.\n\n    exports.multi = (bases...) ->\n        generate merge map(bases, mro).concat [bases]\n\nThis takes a list of classes representing a hierarchy (from most to\nleast derived) and generates a single-inheritance hierarchy that\nbehaves like a class that would be have such a hierarchy.\n\n    generate = memoize (linearization) ->\n        next = head linearization\n        if isEqual linearization, hierarchy next\n            next\n        else\n            class result extends generate tail linearization\n                __mro__: linearization\n                constructor: reparent next, @, next::constructor\n                copyOwn next, @\n                copyOwn next::, @::, partial reparent, next, @\n\nThis utility lets us copy own properties of a *from* object that are\nnot own properties of a *to* object into the *to* object, optionally\ntransformed via a projection function.\n\n    copyOwn = (from, to, project = (x) -> x) ->\n        for own key, value of from\n            if not to.hasOwnProperty key\n                to[key] = project value\n        to\n\nMethods in CoffeeScript call super directly, so we have to change the\n`__super__` attribute of the original class during the scope of the\nmethod so it calls the right super of the linearization.  Also,\nprogrammers don't call super in constructor of root classes --indeed\ndoing so would rise an error-- so we have to inject such a call when\nthere are classes after these in the linearization.  The **reparent**\nfunction takes care of all these and given an original class, and the\nnew class that is replacing it a linearized heterarchy, returns a\nwrapped copy of a value of the former that is suitable for replacing\nit in the later.\n\n    reparent = (oldklass, newklass, value) ->\n        if value not instanceof Function\n            value\n        else if value == oldklass::constructor and inherited(oldklass) == Object\n            superctor = inherited(newklass)::constructor\n            ->\n                superctor.apply @, arguments\n                value.apply @, arguments\n        else\n            newsuper = inherited(newklass)::\n            oldsuper = oldklass.__super__\n            ->\n                oldklass.__super__ = newsuper\n                try\n                    value.apply @, arguments\n                finally\n                    oldklass.__super__ = oldsuper\n\nThis is the C3 linearization algorithm, as translated from the\noriginal paper.\n\n    merge = (inputs) ->\n        while not isEmpty inputs\n            next = find (map inputs, head), (candidate) ->\n                every inputs, (input) -> candidate not in tail input\n            assert next?, \"Inconsistent multiple inheritance\"\n            inputs = reject map(inputs, (lst) -> without lst, next), isEmpty\n            next\n\nIntrospection\n-------------\n\nThe **mro** function returns the method resolution order\n(linearization) of a given class:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends B\n> assert mro(C).equals [C, B, A]\n> ```\n\nIt returns the original classes that were mixed in when used with\nmult-inherited classes:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert mro(D).equals [D, B, C, A, Object]\n> ```\n\n    isJavaScriptClass = (cls) ->\n        return cls in [\n            Array\n            Boolean\n            Date\n            Error\n            Function\n            Number\n            RegExp\n            String\n            Object\n        ]\n\n    exports.mro = mro = (cls) ->\n        if not cls? or not cls::?\n            []\n        else if not cls::hasOwnProperty '__mro__'\n            result = [cls].concat mro inherited(cls)\n            cls::__mro__ = result unless isJavaScriptClass cls\n            result\n        else\n            cls::__mro__\n\nThe **inherited** function returns the CoffeeScript superclass of an\nobject, for example:\n\n> ```coffee\n> class A\n> class B extends A\n> assert inherited(B) == A\n> ```\n\nNote that for multiple inherited classes, this returns the mixed\nobject, not the next class in the MRO, as in:\n\n> ```coffee\n> class C extends multi A, B\n> assert inherited(C) == multi(A, B)\n> ```\n\n    exports.inherited = inherited = (cls) ->\n        Object.getPrototypeOf(cls.prototype)?.constructor\n\nThe **hierarchy** returns the CoffeeScript hierarchy of classes of a\ngiven class, including the class itself.  For multiple inherited\nclasses, it may return speciall classes that were generated to produce\nthe flattening, as in:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert not mro(D).equals hierarchy(D)\n> assert hierarchy(D).equals\n>     [ D, multi(B, C), inherited(multi B, C), A, Object ]\n> ```\n\n    exports.hierarchy = hierarchy = (cls) ->\n        if not cls?\n            []\n        else\n            [cls].concat hierarchy inherited cls\n\nThe **isinstance** function takes an object and a class or classes and\nreturns whether the object is an instance of any of those classes. It\nis compatible with multi-inherited classes.\n\n    exports.isinstance = (obj, classes...) ->\n        exports.issubclass obj?.constructor, classes...\n\nThe **issubclass** tells whether a class is a subtype of another type.\n\n    exports.issubclass = (klass, classes...) ->\n        linearization = mro klass\n        some classes, (cls) -> cls in linearization\n\nLicense\n-------\n\n> Copyright (c) 2013, 2015 Juan Pedro Bolivar Puente <raskolnikov@gnu.org>\n>\n> Permission is hereby granted, free of charge, to any person obtaining a copy\n> of this software and associated documentation files (the \"Software\"), to deal\n> in the Software without restriction, including without limitation the rights\n> to use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\n> copies of the Software, and to permit persons to whom the Software is\n> furnished to do so, subject to the following conditions:\n>\n> The above copyright notice and this permission notice shall be included in\n> all copies or substantial portions of the Software.\n>\n> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n> THE SOFTWARE.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4141eb9283b72ad27290009a39b6d82dab3a2e08","subject":"redirect index to page\/index","message":"redirect index to page\/index\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/lib\/routes\/index.litcoffee","new_file":"src\/lib\/routes\/index.litcoffee","new_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        fs = require('fs')\n        res.redirect '\/page\/index'\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        app.models.page.get req.params.name, (err, page) ->\n          if err\n            console.error 'page '+req.params.name+' not found in db, showing static'\n            res.render 'page\/'+req.params.name\n          else\n            res.render 'page\/dynamic', page\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n<!-- ' -->\n\n      app.post '\/page\/_post', (req, res) ->\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          content: 'Hello world, from inside the DB'\n        app.models.page sample, (err, page) ->\n          if err\n            page = \n              name: 'error'\n              title: 'Error'\n              content: 'There was an error posting your page, please try again.'\n          res.render 'page\/dynamic', page\n          \n## GET \/login\n\nRender static pages at \/view\/login\/index.html\n\nAnd never cache the login page, it breaks csrf\n\n      app.get '\/login', (req, res) ->\n        res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0')\n        res.render 'login'\n\n          \n## POST \/login\/_post\n\nDo Login action, and redirect as appropriate.\n\n      app.post '\/login\/_post', (req, res) ->\n        require('..\/login').checkUser req.body.username, req.body.password, (user, securityLevel) ->\n          console.info 'login callback = '+user+', '+securityLevel\n          req.session.user = user\n          req.session.securityLevel = securityLevel\n          res.cookie 'nocache', '1'\n          if securityLevel\n            res.redirect '\/'\n          else\n            res.redirect '\/login'\n\n## GET \/login\/clear\n\nLogout from the website by clearing the session\n\n      app.get '\/login\/clear', (req, res) ->\n        req.session.destroy (err) ->\n          res.clearCookie 'nocache'\n          res.redirect '\/login'\n\n## GET \/directory\n \nDownload PDF to browser\n\n      app.get '\/directory', (req, res) ->\n        if req.session.securityLevel\n          request = require 'request'\n          request app.directory_url, (err, cbres, data) ->\n            if err or cbres.statusCode != 200\n              res.render 500, 'Error retrieving full directory'\n            else\n              dir = JSON.parse data\n              page = \n                name: 'Full Directory'\n                title: 'Full Directory'\n                directory: dir.data\n                helpers:\n                  month: (num) ->\n                    return [null, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'][num]\n              res.render 'directory', page\n        else\n          res.redirect '\/login'\n\n\n## GET \/directory\/directory.pdf\n \nDownload PDF to browser\n\n      app.get '\/directory\/directory.pdf', (req, res) ->\n        if req.session.securityLevel\n          res.download 'protected\/directory.pdf'\n        else\n          res.redirect '\/login'\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        fs = require('fs')\n        res.render 'index', {\n          title: 'Welcome',\n          extra_head_css: fs.readFileSync('views\/extra\/nivo.css'),\n          extra_foot_js: fs.readFileSync('views\/extra\/nivo.js')\n        }\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        app.models.page.get req.params.name, (err, page) ->\n          if err\n            console.error 'page '+req.params.name+' not found in db, showing static'\n            res.render 'page\/'+req.params.name\n          else\n            res.render 'page\/dynamic', page\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n<!-- ' -->\n\n      app.post '\/page\/_post', (req, res) ->\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          content: 'Hello world, from inside the DB'\n        app.models.page sample, (err, page) ->\n          if err\n            page = \n              name: 'error'\n              title: 'Error'\n              content: 'There was an error posting your page, please try again.'\n          res.render 'page\/dynamic', page\n          \n## GET \/login\n\nRender static pages at \/view\/login\/index.html\n\nAnd never cache the login page, it breaks csrf\n\n      app.get '\/login', (req, res) ->\n        res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0')\n        res.render 'login'\n\n          \n## POST \/login\/_post\n\nDo Login action, and redirect as appropriate.\n\n      app.post '\/login\/_post', (req, res) ->\n        require('..\/login').checkUser req.body.username, req.body.password, (user, securityLevel) ->\n          console.info 'login callback = '+user+', '+securityLevel\n          req.session.user = user\n          req.session.securityLevel = securityLevel\n          res.cookie 'nocache', '1'\n          if securityLevel\n            res.redirect '\/'\n          else\n            res.redirect '\/login'\n\n## GET \/login\/clear\n\nLogout from the website by clearing the session\n\n      app.get '\/login\/clear', (req, res) ->\n        req.session.destroy (err) ->\n          res.clearCookie 'nocache'\n          res.redirect '\/login'\n\n## GET \/directory\n \nDownload PDF to browser\n\n      app.get '\/directory', (req, res) ->\n        if req.session.securityLevel\n          request = require 'request'\n          request app.directory_url, (err, cbres, data) ->\n            if err or cbres.statusCode != 200\n              res.render 500, 'Error retrieving full directory'\n            else\n              dir = JSON.parse data\n              page = \n                name: 'Full Directory'\n                title: 'Full Directory'\n                directory: dir.data\n                helpers:\n                  month: (num) ->\n                    return [null, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'][num]\n              res.render 'directory', page\n        else\n          res.redirect '\/login'\n\n\n## GET \/directory\/directory.pdf\n \nDownload PDF to browser\n\n      app.get '\/directory\/directory.pdf', (req, res) ->\n        if req.session.securityLevel\n          res.download 'protected\/directory.pdf'\n        else\n          res.redirect '\/login'\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"0b264a30cdc65a7daa63eb6d2e8de2d0dc06544a","subject":"its listeners, not methods","message":"its listeners, not methods\n","repos":"nhz-io\/cnl","old_file":"source\/component.litcoffee","new_file":"source\/component.litcoffee","new_contents":"# CLASS: Component\n* Extends: [Shape][Shape]\n* Parent: [Index][Parent]\n\nAn interactive component\n\n---\n\n    Event = require 'ecl\/dist\/event'\n    module.exports = class Component extends require '.\/shape'\n\n## CONSTRUCTOR\n### new Component()\n* Returns: [Component][Component]\n\nCreates Component instance.\n\n      constructor: ->\n        super\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['grab', 'release', 'drag']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['grab', 'release', 'drag']\n\nAdd capturing extendable listener\n          \n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n          \n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **mousemove** event passing throught this component\n\n      mousemoveCaptureListener: (event) ->\n        super\n\nProceed only for valid event\n\n        if event\n          $ = @___runtime\n\nReset component state.\n\n          @state = null\n\nIf component is grabbed then set the state to **active**.\n\n          if $.grab\n            @state = 'active'\n\nCreate **drag** Event and broadcast it to this component if drag event is enabled,\n\n            if @events?.drag\n              @broadcastEvent new Event\n                type:'drag', x:event.x, y:event.y\n\nsetting the drag offset.\n\n                offsetX: event.x - ($.dragEvent?.x or $.grabEvent?.x or 0)\n                offsetY: event.y - ($.dragEvent?.y or $.grabEvent?.y or 0)\n\nOtherwise, set the state to the name of the first matching region in order.\n\n          else if regions = event.regions\n            @state = (if regions.hover then 'hover' else if regions.normal then 'normal')\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #mousedownListener(event)\n* Returns: [Component][Component]\n\nReceive **mousedown** event.\n\n      mousedownListener: (event) ->\n        super\n\nProceed only for valid event\n\n        if event\n\nIf component is in active state and **grab** event is enabled then grab this component.\n\n          if (@state is 'active') and @events?.grab\n            ($ = @___runtime).grab = true\n\nCreate **grab** event and deliver it to this component.\n          \n            $.dragEvent = null\n            @broadcastEvent new Event\n              type:'grab', x:event.x, y:event.y\n          \n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #dragCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **drag** events passing through this component\n\n      dragCaptureListener: (event) ->\n\nProceed only for valid event\n\n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.dragEvent = event\n          localizeEventCoordinates event, @origin\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #grabCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **grab** events passing through this component.\n\n      grabCaptureListener: (event) ->\n\nProceed only for valid event\n        \n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.grabEvent = event\n          localizeEventCoordinates event, @origin\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n* Returns: [Component][Component]\n\nCapture **release** events passing through this component.\n\n      releaseCaptureListener: (event) ->\n\nProceed only for valid event\n        \n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.releaseEvent = event\n          localizeEventCoordinates event, @origin\n          \n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n* Returns: [Component][Component]\n\n#### #dragListener(event)\n* Returns: [Component][Component]\n\n**drag** event receiver stub.\n\n      dragListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #grabListener(event)\n* Returns: [Component][Component]\n\n**grab** event receiver stub.\n\n      grabListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n### #releaseListener(event)\n* Returns: [Component][Component]\n\n**release** event receiver stub.\n\n      releaseListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n\n[Parent]: .\/index.litcoffee\n[Shape]: .\/shape.litcoffee\n[Component]: .\/component.litcoffee\n\n","old_contents":"# CLASS: Component\n* Extends: [Shape][Shape]\n* Parent: [Index][Parent]\n\nAn interactive component\n\n---\n\n    Event = require 'ecl\/dist\/event'\n    module.exports = class Component extends require '.\/shape'\n\n## CONSTRUCTOR\n### new Component()\n* Returns: [Component][Component]\n\nCreates Component instance.\n\n      constructor: ->\n        super\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['grab', 'release', 'drag']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['grab', 'release', 'drag']\n\nAdd capturing extendable listener\n          \n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n          \n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## METHODS\n### #mousemoveCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **mousemove** event passing throught this component\n\n      mousemoveCaptureListener: (event) ->\n        super\n\nProceed only for valid event\n\n        if event\n          $ = @___runtime\n\nReset component state.\n\n          @state = null\n\nIf component is grabbed then set the state to **active**.\n\n          if $.grab\n            @state = 'active'\n\nCreate **drag** Event and broadcast it to this component if drag event is enabled,\n\n            if @events?.drag\n              @broadcastEvent new Event\n                type:'drag', x:event.x, y:event.y\n\nsetting the drag offset.\n\n                offsetX: event.x - ($.dragEvent?.x or $.grabEvent?.x or 0)\n                offsetY: event.y - ($.dragEvent?.y or $.grabEvent?.y or 0)\n\nOtherwise, set the state to the name of the first matching region in order.\n\n          else if regions = event.regions\n            @state = (if regions.hover then 'hover' else if regions.normal then 'normal')\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #mousedownListener(event)\n* Returns: [Component][Component]\n\nReceive **mousedown** event.\n\n      mousedownListener: (event) ->\n        super\n\nProceed only for valid event\n\n        if event\n\nIf component is in active state and **grab** event is enabled then grab this component.\n\n          if (@state is 'active') and @events?.grab\n            ($ = @___runtime).grab = true\n\nCreate **grab** event and deliver it to this component.\n          \n            $.dragEvent = null\n            @broadcastEvent new Event\n              type:'grab', x:event.x, y:event.y\n          \n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #dragCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **drag** events passing through this component\n\n      dragCaptureListener: (event) ->\n\nProceed only for valid event\n\n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.dragEvent = event\n          localizeEventCoordinates event, @origin\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #grabCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **grab** events passing through this component.\n\n      grabCaptureListener: (event) ->\n\nProceed only for valid event\n        \n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.grabEvent = event\n          localizeEventCoordinates event, @origin\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n* Returns: [Component][Component]\n\nCapture **release** events passing through this component.\n\n      releaseCaptureListener: (event) ->\n\nProceed only for valid event\n        \n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.releaseEvent = event\n          localizeEventCoordinates event, @origin\n          \n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n* Returns: [Component][Component]\n\n#### #dragListener(event)\n* Returns: [Component][Component]\n\n**drag** event receiver stub.\n\n      dragListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #grabListener(event)\n* Returns: [Component][Component]\n\n**grab** event receiver stub.\n\n      grabListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n### #releaseListener(event)\n* Returns: [Component][Component]\n\n**release** event receiver stub.\n\n      releaseListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n\n[Parent]: .\/index.litcoffee\n[Shape]: .\/shape.litcoffee\n[Component]: .\/component.litcoffee\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"45e9c8505e7e8700e61a975f3aec287c41fccfec","subject":"Inserted target features in documentation","message":"Inserted target features in documentation\n","repos":"erikdiessel\/plidoc,erikdiessel\/plidoc","old_file":"docco.litcoffee","new_file":"docco.litcoffee","new_contents":"Docco++\n=======\n\nWhat makes Docco++ better than Docco ?\n-----------------------------------\nWhile Docco does what it does in a quick and dirty way, there are some things\nmissing in its feature set:\n- Seperate code *comments* from literate programming style *descriptions* by\n  using different tags to denote them.\n- Use multiline comments for the documentation.\n- Include Mathjax to directly support mathematics with Latex-equations \n  and make it markdown compatible.\n- Pack documentation in *one* single html-document, including all css-assets,\n  fonts, etc. This is helpful e.g. for code reviews, since you then only have\n  to send one single file instead of a whole zip file.\n        \n\nDocumentation of the original\n============================\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* For all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        isText = maybeCode = yes\n        for line, i in lines\n          lines[i] = if maybeCode and match = \/^([ ]{4}|[ ]{0,3}\\t)\/.exec line\n            isText = no\n            line[match[0].length..]\n          else if maybeCode = \/^\\s*$\/.test line\n            if isText then lang.symbol else ''\n          else\n            isText = yes\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n\nTell Marked how to highlight code blocks within comments, treating that code\nas either the language specified in the code block or the language of the file\nif not specified.\n\n      marked.setOptions {\n        highlight: (code, lang) ->\n          lang or= language.name\n\n          if highlightjs.getLanguage(lang)\n            highlightjs.highlight(lang, code).value\n          else\n            console.warn \"docco: couldn't highlight code block with unknown language '#{lang}' in #{source}\"\n            code\n      }\n\n      for section, i in sections\n        code = highlightjs.highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      config.languages = buildMatchers config.languages\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    highlightjs = require 'highlight.js'\n\nEnable nicer typography with marked.\n\n    marked.setOptions smartypants: yes\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [file]', 'use a custom languages.json', _.compose JSON.parse, fs.readFileSync)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","old_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* For all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        isText = maybeCode = yes\n        for line, i in lines\n          lines[i] = if maybeCode and match = \/^([ ]{4}|[ ]{0,3}\\t)\/.exec line\n            isText = no\n            line[match[0].length..]\n          else if maybeCode = \/^\\s*$\/.test line\n            if isText then lang.symbol else ''\n          else\n            isText = yes\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n\nTell Marked how to highlight code blocks within comments, treating that code\nas either the language specified in the code block or the language of the file\nif not specified.\n\n      marked.setOptions {\n        highlight: (code, lang) ->\n          lang or= language.name\n\n          if highlightjs.getLanguage(lang)\n            highlightjs.highlight(lang, code).value\n          else\n            console.warn \"docco: couldn't highlight code block with unknown language '#{lang}' in #{source}\"\n            code\n      }\n\n      for section, i in sections\n        code = highlightjs.highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      config.languages = buildMatchers config.languages\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    highlightjs = require 'highlight.js'\n\nEnable nicer typography with marked.\n\n    marked.setOptions smartypants: yes\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [file]', 'use a custom languages.json', _.compose JSON.parse, fs.readFileSync)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8b93e14e16e12e4c8b46bc6c5f37ec97dba4ed11","subject":"We don't need the starting_row param in Skyll anymore","message":"We don't need the starting_row param in Skyll anymore\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/skyll.litcoffee","new_file":"lib\/skyll.litcoffee","new_contents":"    Module = require '.\/module'\n    q      = require 'q'\n\n    class Skyll extends Module\n      deps: [ 'q', 'config', 'carver', 'async' ]\n      pub:  [ 'craft' ]\n\n      render_pipeline: [ ]\n      renderers:       [ ]\n\n      initialize: (params) =>\n        deferred = q.defer()\n\n        super().then =>\n          for p in @config.pipeline\n            if Array.isArray p\n              for q in p\n                @deps.push q unless @deps.includes q\n            else\n              @deps.push p unless @deps.includes p\n\n          @hydrate_dependencies().then =>\n            for p in @config.pipeline\n              if Array.isArray p\n                @renderers.push @[p[0]]\n\n                new_pipeline = for q in p\n                  @[q]\n\n                @render_pipeline.push new_pipeline\n              else\n                @renderers.push @[p]\n                @render_pipeline.push @[p]\n\n            @carver.starting_row = params.starting_row\n\n            deferred.resolve @\n\n        deferred.promise\n\n      craft: (level_name) =>\n        @carver.clear_state()\n\n        path = @carver.carve_path()\n\n        @async.mapSeries @render_pipeline, (step, next) =>\n          i = @render_pipeline.indexOf step\n\n          if Array.isArray step\n            @q.all step.map (pipeline) => pipeline.render path, level_name\n              .then => @renderers[i].flush level_name\n              .then => next()\n          else\n            step.render path, level_name\n              .then => @renderers[i].flush level_name\n              .then => next()\n        , => @done()\n\n    module.exports = Skyll\n","old_contents":"    Module = require '.\/module'\n    q      = require 'q'\n\n    class Skyll extends Module\n      deps: [ 'q', 'config', 'carver', 'async' ]\n      pub:  [ 'craft' ]\n\n      render_pipeline: [ ]\n      renderers:       [ ]\n\n      initialize: (params) =>\n        deferred      = q.defer()\n        @starting_row = params.starting_row\n\n        super().then =>\n          for p in @config.pipeline\n            if Array.isArray p\n              for q in p\n                @deps.push q unless @deps.includes q\n            else\n              @deps.push p unless @deps.includes p\n\n          @hydrate_dependencies().then =>\n            for p in @config.pipeline\n              if Array.isArray p\n                @renderers.push @[p[0]]\n\n                new_pipeline = for q in p\n                  @[q]\n\n                @render_pipeline.push new_pipeline\n              else\n                @renderers.push @[p]\n                @render_pipeline.push @[p]\n\n            @carver.starting_row = params.starting_row\n\n            deferred.resolve @\n\n        deferred.promise\n\n      craft: (level_name) =>\n        @carver.clear_state()\n\n        path = @carver.carve_path()\n\n        @async.mapSeries @render_pipeline, (step, next) =>\n          i = @render_pipeline.indexOf step\n\n          if Array.isArray step\n            @q.all step.map (pipeline) => pipeline.render path, level_name\n              .then => @renderers[i].flush level_name\n              .then => next()\n          else\n            step.render path, level_name\n              .then => @renderers[i].flush level_name\n              .then => next()\n        , => @done()\n\n    module.exports = Skyll\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5a1ff6059db6c19f1bb7bee321ee25a634dc75dc","subject":"fix k,v bug in for-of","message":"fix k,v bug in for-of\n","repos":"nickfargo\/restate","old_file":"src\/state.litcoffee","new_file":"src\/state.litcoffee","new_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\n      { memoizeProtostates, useDispatchTables } = state.options\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        do substate.destroy for own name, substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneCategory   _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method for this state. Providing an optional `out` object\nallows the appropriate `context` for a state-bound method to be delivered as a\nproperty of `out`; if included, `context` is confined to the local state tree.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out, boxed ) ->\n        realized = ~@attributes & VIRTUAL\n\n> During the pseudo-loop block, the `context` reference should be considered\n  provisional, because its potential value is in part a product of the manner\n  in which its accompanying `method` was retrieved. After `break`ing out of the\n  block, `method` can be type-checked and `context` may be kept or discarded as\n  appropriate.\n\n        loop # once\n\nFirst seek the named method locally.\n\n          if realized\n            method = @_?.methods?[ methodName ]\n            if method is rootNoop then method = null\n            if method? then context = this\n            else if record = @_?.__dispatch_table__?[ methodName ]\n              [ method, context ] = record\n            break if method?\n\nIf no method is held locally, start traversing, first up the protostate chain.\nIf this succeeds, the provisional `context` *must be the epistate* inheriting\nthe method (constrast with the `VIA_SUPER` case).\n\n          if ( viaProto = via & VIA_PROTO ) and\n              method = @protostate()?.method methodName, VIA_PROTO, out, yes\n            context = this\n            inherited = yes; break\n\nIf no method is found yet, continue traversing up the superstate chain. If this\nsucceeds, the provisional `context` *must be the superstate* from which the\nmethod is inherited.\n\n          if via & VIA_SUPER and method = @superstate?.method \\\n              methodName, VIA_SUPER | viaProto, out, yes\n            { context } = out if out?\n            inherited = yes; break\n\nThe method cannot be found.\n\n          context = null\n          break # always\n\n        if method?\n\nIf `method` is a function, it is not state-bound, so `context` is unnecessary.\n\n          if typeof method is 'function'\n            context = null\n\nIff `this` is a realized `State`, inherited lookup results can be memoized in\nthe local dispatch table.\n\n          if realized and inherited and useDispatchTables\n            table = @_?.__dispatch_table__ or = {}\n            table[ methodName ] = [ method, context ]\n\nUnbox a state-bound function unless directed otherwise.\n\n          if not boxed and method.type is 'state-bound-function'\n            method = method.fn\n\nExport `method` and `context` together if the `out` reference was provided.\n\n> Callers who know that `method` will be unbound need not provide an `out`.\n\n        if out?\n          out.method = method\n          out.context = context\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state. The provided `fn` may be any of:\n\n  1.  A proper function, which will be called in the context of `@owner`;\n  2.  A boxing of a *bound* function as prepared by `state.bind`, which will\n      cause the boxed function to be called in the context of either `this`\n      `State` or the *epistate* inheriting the method;\n  3.  A boxing of a *fixed* function as prepared by `state.fix`, whose boxed\n      function will be closed over hard references to `this` as `autostate`,\n      and to the *protostate* of `this`, as `protostate`.\n\n> See also: `state.bind`, `state.fix`\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` boxes a *state-fixed* function, then partially apply that function to\nextract the actual method, closed over references to the locality of `this`.\n\n        if typeof fn is 'object' and fn.type is 'state-fixed-function'\n          fn = fn.fn this, @protostate()\n\n        throw TypeError unless typeof fn is 'function' or\n          fn?.type is 'state-bound-function'\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root._?.methods?[ methodName ]\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n            root.addMethod methodName, ownerMethod\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context.\n\nIf the named method does not exist locally and cannot be inherited, then\n`noSuchMethod` events are emitted, and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n\nFirst try to resolve the method quickly from the local dispatch table.\n\n        if record = @_?.__dispatch_table__?[ methodName ]\n          [ method, context ] = record\n          method = method.fn if method?.type is 'state-bound-function'\n\nResort to a proper lookup if the fast way turns up nothing.\n\n        unless method?\n          if method = @method methodName, VIA_ALL, out = {}\n            { context } = out\n\nBail out gracefully if the method definitively cannot be resolved.\n\n          else\n            @emit 'noSuchMethod', [ methodName, args ]\n            @emit 'noSuchMethod:' + methodName, args\n            return\n\nIf at this point a `context` is provided, this means that `method` is a\nstate-bound function, and `context` will be the appropriately bound `State`. If\nno `context` exists, this means that `method` is a typical non-state-bound\nfunction, which is meant to be invoked in the usual fashion, just as if it were\ncalled directly as a method of `this` state\u2019s `owner`.\n\n        method.apply context or @owner, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","old_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\n      { memoizeProtostates, useDispatchTables } = state.options\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneCategory   _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method for this state. Providing an optional `out` object\nallows the appropriate `context` for a state-bound method to be delivered as a\nproperty of `out`; if included, `context` is confined to the local state tree.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out, boxed ) ->\n        realized = ~@attributes & VIRTUAL\n\n> During the pseudo-loop block, the `context` reference should be considered\n  provisional, because its potential value is in part a product of the manner\n  in which its accompanying `method` was retrieved. After `break`ing out of the\n  block, `method` can be type-checked and `context` may be kept or discarded as\n  appropriate.\n\n        loop # once\n\nFirst seek the named method locally.\n\n          if realized\n            method = @_?.methods?[ methodName ]\n            if method is rootNoop then method = null\n            if method? then context = this\n            else if record = @_?.__dispatch_table__?[ methodName ]\n              [ method, context ] = record\n            break if method?\n\nIf no method is held locally, start traversing, first up the protostate chain.\nIf this succeeds, the provisional `context` *must be the epistate* inheriting\nthe method (constrast with the `VIA_SUPER` case).\n\n          if ( viaProto = via & VIA_PROTO ) and\n              method = @protostate()?.method methodName, VIA_PROTO, out, yes\n            context = this\n            inherited = yes; break\n\nIf no method is found yet, continue traversing up the superstate chain. If this\nsucceeds, the provisional `context` *must be the superstate* from which the\nmethod is inherited.\n\n          if via & VIA_SUPER and method = @superstate?.method \\\n              methodName, VIA_SUPER | viaProto, out, yes\n            { context } = out if out?\n            inherited = yes; break\n\nThe method cannot be found.\n\n          context = null\n          break # always\n\n        if method?\n\nIf `method` is a function, it is not state-bound, so `context` is unnecessary.\n\n          if typeof method is 'function'\n            context = null\n\nIff `this` is a realized `State`, inherited lookup results can be memoized in\nthe local dispatch table.\n\n          if realized and inherited and useDispatchTables\n            table = @_?.__dispatch_table__ or = {}\n            table[ methodName ] = [ method, context ]\n\nUnbox a state-bound function unless directed otherwise.\n\n          if not boxed and method.type is 'state-bound-function'\n            method = method.fn\n\nExport `method` and `context` together if the `out` reference was provided.\n\n> Callers who know that `method` will be unbound need not provide an `out`.\n\n        if out?\n          out.method = method\n          out.context = context\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state. The provided `fn` may be any of:\n\n  1.  A proper function, which will be called in the context of `@owner`;\n  2.  A boxing of a *bound* function as prepared by `state.bind`, which will\n      cause the boxed function to be called in the context of either `this`\n      `State` or the *epistate* inheriting the method;\n  3.  A boxing of a *fixed* function as prepared by `state.fix`, whose boxed\n      function will be closed over hard references to `this` as `autostate`,\n      and to the *protostate* of `this`, as `protostate`.\n\n> See also: `state.bind`, `state.fix`\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` boxes a *state-fixed* function, then partially apply that function to\nextract the actual method, closed over references to the locality of `this`.\n\n        if typeof fn is 'object' and fn.type is 'state-fixed-function'\n          fn = fn.fn this, @protostate()\n\n        throw TypeError unless typeof fn is 'function' or\n          fn?.type is 'state-bound-function'\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root._?.methods?[ methodName ]\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n            root.addMethod methodName, ownerMethod\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context.\n\nIf the named method does not exist locally and cannot be inherited, then\n`noSuchMethod` events are emitted, and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n\nFirst try to resolve the method quickly from the local dispatch table.\n\n        if record = @_?.__dispatch_table__?[ methodName ]\n          [ method, context ] = record\n          method = method.fn if method?.type is 'state-bound-function'\n\nResort to a proper lookup if the fast way turns up nothing.\n\n        unless method?\n          if method = @method methodName, VIA_ALL, out = {}\n            { context } = out\n\nBail out gracefully if the method definitively cannot be resolved.\n\n          else\n            @emit 'noSuchMethod', [ methodName, args ]\n            @emit 'noSuchMethod:' + methodName, args\n            return\n\nIf at this point a `context` is provided, this means that `method` is a\nstate-bound function, and `context` will be the appropriately bound `State`. If\nno `context` exists, this means that `method` is a typical non-state-bound\nfunction, which is meant to be invoked in the usual fashion, just as if it were\ncalled directly as a method of `this` state\u2019s `owner`.\n\n        method.apply context or @owner, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"26c92d052f6765d517b49d5619e2e710dded9bc3","subject":"fix broken link","message":"fix broken link\n","repos":"corenova\/yang-js","old_file":"src\/yang.litcoffee","new_file":"src\/yang.litcoffee","new_contents":"# Yang - evaluable schema expression\n\nThis module provides support for basic set of YANG schema modeling\nlanguage by using the built-in *extension* syntax to define additional\nschema language constructs. The actual YANG language [RFC\n6020](http:\/\/tools.ietf.org\/html\/rfc6020) specifications are loaded\ninside the [main module](.\/main.coffee).\n\nThis module is the **primary interface** for consumers of this\nlibrary.\n\n## Dependencies\n \n    debug  = require('debug')('yang:schema') if process.env.DEBUG?\n    fs     = require 'fs'\n    path   = require 'path'\n    parser = require 'yang-parser'\n    indent = require 'indent-string'\n\n    Expression = require '.\/expression'\n\n## Class Yang\n\n    class Yang extends Expression\n      @scope:\n        extension: '0..n'\n        typedef:   '0..n'\n        module:    '0..n'\n        submodule: '0..n'\n\n## Class-level methods\n\n      @clear: ->\n        @module.splice(0,@module.length) if @module?\n        @submodule.splice(0,@submodule.length) if @submodule?\n\n### parse (schema)\n\nThis class-level routine performs recursive parsing of passed in\nstatement and sub-statements. It provides syntactic, semantic and\ncontextual validations on the provided schema and returns the final JS\nobject tree structure as hierarchical Yang expression instances.\n\nIf any validation errors are encountered, it will throw the\nappropriate error along with the context information regarding the\nerror.\n\n      @parse: (schema, opts={}) ->\n        opts.compile ?= true\n        try\n          schema = parser.parse schema if typeof schema is 'string'\n        catch e\n          e.offset = 50 unless e.offset > 50\n          offender = schema.slice e.offset-50, e.offset+50\n          offender = offender.replace \/\\s\\s+\/g, ' '\n          throw @error \"invalid YANG syntax detected around: '#{offender}'\", offender\n\n        unless schema instanceof Object\n          throw @error \"must pass in valid YANG schema\", schema\n\n        kind = switch\n          when !!schema.prf then \"#{schema.prf}:#{schema.kw}\"\n          else schema.kw\n        tag = schema.arg if !!schema.arg\n\t\t\n        schema = (new this kind, tag).extends schema.substmts.map (x) => @parse x, false\n        # perform final scoped constraint validation\n        for kind, constraint of schema.scope when constraint in [ '1', '1..n' ]\n          unless schema.hasOwnProperty kind\n            throw schema.error \"constraint violation for required '#{kind}' = #{constraint}\"\n        schema.compile() if opts.compile\n        return schema\n\nFor comprehensive overview on currently supported YANG statements,\nplease refer to\n[Compliance Report](..\/test\/yang-compliance-coverage.md) for the latest\n[RFC 6020](http:\/\/tools.ietf.org\/html\/rfc6020) YANG specification\ncompliance.\n\n### compose (data [, opts={}])\n\nThis call *accepts* any arbitrary JS object and it will attempt to\nconvert it into a structural `Yang` expression instance. It will\nanalyze the passed in JS data and perform best match mapping to an\nappropriate YANG schema representation to describe the input\ndata. This method will not be able to determine conditionals or any\nmeta-data to further constrain the data, but it should provide a good\nstarting point with the resulting `Yang` expression instance.\n\n      @compose: (data, opts={}) ->\n        unless data?\n          throw @error \"must supply input 'data' to compose\"\n\n        # explict compose\n        if opts.kind?\n          ext = Yang::lookup.call this, 'extension', opts.kind\n          unless ext instanceof Expression\n            throw @error \"unable to find requested '#{opts.kind}' extension\"\n          return ext.compose? data, opts\n\n        # implicit compose (dynamic discovery)\n        for ext in @extension when ext.compose instanceof Function\n          debug? \"checking data if #{ext.tag}\"\n          res = ext.compose data, opts\n          return res if res instanceof Yang\n\nThis facility is a powerful construct to dynamically generate `Yang`\nschema from ordinary JS objects. For additional usage examples, please\nrefer to [Dynamic Composition](..\/TUTORIAL.md#dynamic-composition)\nsection in the [Getting Started Guide](..\/TUTORIAL.md).\n\n### resolve (from..., name)\n\nThis call is internally used by [import](#import-name-opts) to\nperform a search within the local filesystem to locate a given YANG\nschema module by `name`. It will first check the calling code's local\n[package.json](..\/package.json) to look for a `models: {}`\nconfiguration section to identify where the target module can be\nfound. If there is an entry defined, it will then follow that\nreference - which may be a JS file, YANG schema text file, or another\nNPM module. If it is not found within the `models: {}` configuration\nblock or it fails to load the referenced dependency, it will then\nfallback to attempt to locate a YANG schema text file in the same\nfolder that the `resolve` request was made: `#{name}.yang`.\n\n      @resolve: (from..., name) ->\n        return null unless typeof name is 'string'\n        dir = from = switch\n          when from.length then from[0]\n          else path.resolve()\n        while not found? and dir not in [ '\/', '.' ]\n          target = \"#{dir}\/package.json\"\n          debug? \"[resolve] #{name} in #{target}\"\n          try\n            pkginfo = require(target)\n            found = pkginfo.models[name]\n          if found?\n            dir = path.dirname require.resolve(target)\n            debug? \"[resolve] #{name} check #{found} in #{dir}\"\n            unless !!path.extname found\n              from = switch\n                when found of pkginfo.dependencies\n                  path.resolve dir, 'node_modules', found\n                else path.resolve dir, found\n              if fs.existsSync from\n                return @resolve from, name\n              else\n                found = @resolve found, name\n          if not found? and pkginfo?.name is name\n            found = path.dirname require.resolve(target)\n          dir = path.dirname dir unless found?\n        file = switch\n          when not found? then path.resolve from, \"#{name}.yang\"\n          else path.resolve dir, found\n        debug? \"[resolve] checking if #{file} exists\"\n        return if fs.existsSync file then file else null\n\n### import (name [, opts={}])\n\nThis call provides a convenience mechanism for dealing with YANG\nschema module dependencies. It performs parsing of the YANG schema\ncontent from the specified `name` and saves the generated `Yang`\nexpression inside the internal registry. The `name` can be a YANG\nmodule name or a *filename* to the actual schema content (JS or YANG).\n\nOnce a given YANG module has been saved inside the registry,\nsubsequent [parse](#parse-schema) of YANG schema that *import* the\nsaved module will successfully resolve.\n\nTypical usage scenario for this pattern is to internally define common\nmodules such as `ietf-yang-types` which can then be *imported* by\nother schemas.\n\nIt will also return the new `Yang` expression instance (to do with as\nyou please).\n\n      @require: ->\n        console.warn \"DEPRECATION: please use .import() instead\"\n        @import arguments...\n\n      @import: (name, opts={}) ->\n        return unless name?\n        opts.basedir ?= ''\n        extname  = path.extname name\n        filename = path.resolve opts.basedir, name\n        basedir  = path.dirname filename\n\n        unless !!extname\n          return (Yang::match.call this, 'module', name) ? @import (@resolve name), opts\n\n        unless extname is '.yang'\n          res = require filename\n          unless res instanceof Yang\n            throw @error \"unable to import '#{name}' from '#{filename}' (not Yang expression)\", res\n          return res \n\n        try return @use (@parse (fs.readFileSync filename, 'utf-8'), opts)\n        catch e\n          unless opts.compile and e.name is 'ExpressionError' and e.context.kind in [ 'include', 'import' ]\n            console.error \"unable to import '#{name}' YANG module from '#{filename}'\"\n            throw e\n          opts.compile = false if e.context.kind is 'include'\n\n          # try to find the dependency module for import\n          dependency = @import (@resolve basedir, e.context.tag), opts\n          unless dependency?\n            e.message = \"unable to auto-resolve '#{e.context.tag}' dependency module\"\n            throw e\n\n          # retry the original request\n          debug? \"retrying import(#{name})\"\n          return @import arguments...\n\nPlease note that this method will look for the `name` in current\nworking directory of the script execution if the `name` is a relative\npath. It utilizes the [resolve](#resolve-from-name) method and will\nattempt to **recursively** resolve any failed `import` dependencies.\n\nWhile this is a convenient abstraction, it is **recommended** to\ndirectly use the Node.js built-in `require` mechanism (if\navailable). Using native `require` instead of `Yang.import` will\nallow package bundlers such as `browserify` to capture the\ndependencies as part of the produced bundle.  It also allows you to\ndirectly load YANG schema files from other NPM modules.\n\nBy default, loading the [yang-js](.\/main.coffee) module will attempt\nto associate `.yang` extension inside `require` facility. If\navailable, it will allow you to `require('.\/some-dependency.yang')`\nand get back a parsed `Yang expression` instance.\n\n## Main constructor\n\nThis method can be called directly without the use of `new` keyword\nand will internally parse the provided schema and return a `bound\nfunction` which will invoke [eval](#eval-data-opts) when called.\n\n      constructor: (kind, tag, extension) ->\n        unless this instanceof Yang\n          [ schema, bindings ] = arguments\n          schema = Yang.parse schema unless schema instanceof Yang\n          return schema.bind bindings\n\n        extension ?= (@lookup 'extension', kind)\n        self = super kind, tag, extension\n        unless extension instanceof Expression\n          @debug \"defer processing of custom extension #{kind}\"\n          @once 'compile:before', (->\n            @debug \"processing deferred extension #{kind}\"\n            extension = (@lookup 'extension', kind)\n            unless extension instanceof Yang\n              throw @error \"encountered unknown extension '#{kind}'\"\n            { @source, @argument } = extension\n          ).bind self\n        return self\n\n      @property 'datakey',\n        get: -> switch\n          when @parent instanceof Yang and @parent.kind is 'module' then \"#{@parent.tag}:#{@tag}\"\n          when @parent instanceof Yang and @parent.kind is 'submodule'\n            \"#{@parent['belongs-to'].tag}:#{@tag}\"\n          else @tag ? @kind\n\n      @property 'datapath',\n        get: -> switch\n          when @parent not instanceof Yang then ''\n          when @node then @parent.datapath + \"\/#{@datakey}\"\n          else @parent.datapath\n          \n      error: (msg, context) -> super \"[#{@trail}] #{msg}\", context\n      \n      emit: (event, args...) ->\n        @emitter.emit arguments...\n        @root.emit event, this if event is 'change' and this isnt @root\n\n## Instance-level methods\n\n### bind (obj)\n\nEvery instance of `Yang` expression can be *bound* with control logic\nwhich will be used during [eval](#eval-data-opts) to produce schema\ninfused **adaptive data object**. This routine is *inherited* from\n[Class Expression](.\/expression.coffee).\n\nThis facility can be used to associate default behaviors for any\nelement in the configuration tree, as well as handler logic for\nvarious YANG statements such as *rpc*, *feature*, etc.\n\nThis call will return the original `Yang` expression instance with the\nnew bindings registered within the `Yang` expression hierarchy.\n\n      # bind() is inherited from Expression\n\nPlease refer to [Schema Binding](..\/TUTORIAL.md#schema-binding)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n### eval (data, opts={})\n\nEvery instance of `Yang` expression can be [eval](#eval-data-opts)\nwith arbitrary JS data input which will apply the schema against the\nprovided data and return a schema infused **adaptive** data object.\n\nThis is an extremely useful construct which brings out the true power\nof YANG for defining and governing arbitrary JS data structures.\n\nBasically, the input `data` will be YANG schema validated and\nconverted to a schema infused *adaptive data model* that dynamically\ndefines properties according to the schema expressions.\n\nIt currently supports the `opts.adaptive` parameter (default `false`)\nwhich establishes a persistent binding relationship with the governing\n`Yang` expression instance. This allows the generated model to\ndynamically **adapt** to any changes to the governing `Yang`\nexpression instance. Refer to below [extends](#extends-schema) section\nfor additional info on how the schema can be programmatically\nmodified.\n\n      eval: (data, opts={}) ->\n        if opts.adaptive is true\n          # TODO: this will break for 'module' which will return Model?\n          @once 'change', arguments.callee.bind(this, data, opts)\n        super\n\nPlease refer to [Working with Models](..\/TUTORIAL.md#working-with-models)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for special\nusage examples for `module` schemas.\n\n### extends (schema...)\n\nEvery instance of `Yang` expression can be `extends` with additional\nYANG schema string(s) and it will automatically perform\n[parse](#parse-schema) of the provided schema text and update itself\naccordingly.\n\nThis action also triggers an event emitter which will *retroactively*\nadapt any previously [eval](#eval-data-opts) produced adaptive data\nmodel instances to react accordingly to the newly changed underlying\nschema expression(s).\n\n      # extends() is inherited from Element\n\n      merge: (elem) ->\n        unless elem instanceof Yang\n          throw @error \"cannot merge invalid element into Yang\", elem\n\n        switch elem.kind\n          when 'type'     then super elem, append: true\n          when 'argument' then super elem, replace: true\n          else super\n\nPlease refer to [Schema Extension](..\/TUTORIAL.md#schema-extension)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n      normalizePath: (ypath) ->\n        lastPrefix = null\n        prefix2module = (root, prefix) ->\n          return unless root.kind is 'module'\n          switch\n            when root.tag is prefix then prefix\n            when root.prefix.tag is prefix then root.tag\n            else\n              for m in root.import ? [] when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              modules = root.lookup 'module'\n              for m in modules when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              return prefix # return as-is...\n              \n        normalizeEntry = (x) =>\n          return x unless x? and !!x\n          match = x.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n          unless match?\n            throw @error \"invalid path expression '#{x}' found in #{ypath}\"\n          [ prefix, target ] = [ match[1], match[2] ]\n          return switch\n            when not prefix? then target\n            when prefix is lastPrefix then target\n            else\n              lastPrefix = prefix\n              mname = prefix2module @root, prefix\n              \"#{mname}:#{target}\"\n        ypath = ypath.replace \/\\s\/g, ''\n        ypath\n          .split('\/')\n          .map normalizeEntry\n          .join('\/')\n\n### locate (ypath)\n\nThis is an internal helper facility used to locate a given schema node\nwithin the `Yang` schema expression tree hierarchy. It supports a\nlimited version of XPATH-like expression to locate an explicit\nelement.\n\n      locate: (ypath) ->\n        # TODO: figure out how to eliminate duplicate code-block section\n        # shared with Element\n        return unless ypath?\n        \n        @debug \"locate enter for '#{ypath}'\"\n        if typeof ypath is 'string'\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = @normalizePath(ypath).split('\/').filter (e) -> !!e\n        else\n          [ key, rest... ] = ypath\n        return this unless key? and key isnt '.'\n\n        if key is '..'\n          return @parent?.locate rest\n\n        match = key.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n        [ prefix, target ] = [ match[1], match[2] ]\n        if prefix? and this is @root\n          search = [target].concat(rest)\n          if (@tag is prefix) or (@lookup 'prefix', prefix)\n            @debug \"locate (local) '\/#{prefix}:#{search.join('\/')}'\"\n            return super search\n          for m in @import ? [] when m.tag is prefix or m.prefix.tag is prefix\n            @debug \"locate (external) '\/#{prefix}:#{search.join('\/')}'\"\n            return m.module.locate search\n          m = @lookup 'module', prefix\n          return m?.locate search\n\n        switch\n          when \/^{.+}$\/.test(target)\n            kind = 'grouping'\n            tag  = target.replace \/^{(.+)}$\/, '$1'\n          when \/^\\[.+\\]$\/.test(target)\n            kind = 'feature'\n            tag  = target.replace \/^\\[(.+)\\]$\/, '$1'\n          when \/^[^(]+\\([^)]*\\)$\/.test(target)\n            target = target.match \/^([^(]+)\\((.*)\\)$\/\n            [ kind, tag ] = [ target[1], target[2] ]\n            tag = undefined unless !!tag\n          when \/^\\<.+\\>$\/.test(target)\n            target = target.replace \/^\\<(.+)\\>$\/, '$1'\n            [ kind..., tag ]  = target.split ':'\n            [ tag, selector ] = tag.split '='\n            kind = kind[0] if kind?.length\n          else return super [key].concat rest\n            \n        match = @match kind, tag\n        return switch\n          when rest.length is 0 then match\n          else match?.locate rest\n\n### match (kind, tag)\n\nThis is an internal helper facility used by [locate](#locate-ypath) and\n[lookup](.\/element.litcoffee#lookup-kind-tag) to test whether a given\nentity exists in the local schema tree.\n\n      # Yang Expression can support 'tag' with prefix to another module\n      # (or itself).\n      match: (kind, tag) ->\n        return super unless kind? and tag? and typeof tag is 'string'\n        res = super\n        return res if res?\n        \n        [ prefix..., arg ] = tag.split ':'\n        return unless prefix.length\n\n        debug? \"[match] with #{kind} #{tag}\"\n\n        prefix = prefix[0]\n        debug? \"[match] check if current module's prefix\"\n        if @root.tag is prefix or @root.prefix?.tag is prefix\n          return @root.match kind, arg\n\n        debug? \"[match] checking if submodule's parent\"\n        ctx = @lookup 'belongs-to'\n        if ctx?.prefix.tag is prefix\n          return ctx.module.match kind, arg \n\n        debug? \"[match] check if one of current module's imports\"\n        imports = @root?.import ? []\n        for m in imports when m.prefix.tag is prefix\n          debug? m.module\n          return m.module.match kind, arg\n\n### toString (opts={})\n\nThe current `Yang` expression will covert back to the equivalent YANG\nschema text format.\n\nAt first glance, this may not seem like a useful facility since YANG\nschema text is *generally known* before [parse](#parse-schema) but it\nbecomes highly relevant when you consider a given `Yang` expression\nprogramatically changing via [extends](#extends-schema).\n\nCurrently it supports `space` parameter which can be used to specify\nnumber of spaces to use for indenting YANG statement blocks.  It\ndefaults to **2** but when set to **0**, the generated output will\nomit newlines and other spacing for a more compact YANG output.\n\n      toString: (opts={ space: 2 }) ->\n        s = @kind\n        if @source.argument?\n          s += ' ' + switch @source.argument\n            when 'value' then \"'#{@tag}'\"\n            when 'text'\n              \"\\n\" + (indent '\"'+@tag+'\"', ' ', opts.space)\n            else @tag\n        sub =\n          @elements\n            .filter (x) => x.parent is this\n            .map (x) -> x.toString opts\n            .join \"\\n\"\n        if !!sub\n          s += \" {\\n\" + (indent sub, ' ', opts.space) + \"\\n}\"\n        else\n          s += ';'\n        return s\n\n### toJSON\n\nThe current `Yang` expression will convert into a simple JS object\nformat.\n\n      # toJSON() is inherited from Element\n\n### valueOf\n\nThe current 'Yang' expression will convert into a primitive form for\ncomparision purposes.\n\n      valueOf: ->\n        switch @source.argument\n          when 'value','text' then @tag.valueOf()\n          else this\n\nPlease refer to [Schema Conversion](..\/TUTORIAL.md#schema-conversion)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n## Export Yang Class\n\n    module.exports = Yang\n","old_contents":"# Yang - evaluable schema expression\n\nThis module provides support for basic set of YANG schema modeling\nlanguage by using the built-in *extension* syntax to define additional\nschema language constructs. The actual YANG language [RFC\n6020](http:\/\/tools.ietf.org\/html\/rfc6020) specifications are loaded\ninside the [main module](.\/main.coffee).\n\nThis module is the **primary interface** for consumers of this\nlibrary.\n\n## Dependencies\n \n    debug  = require('debug')('yang:schema') if process.env.DEBUG?\n    fs     = require 'fs'\n    path   = require 'path'\n    parser = require 'yang-parser'\n    indent = require 'indent-string'\n\n    Expression = require '.\/expression'\n\n## Class Yang\n\n    class Yang extends Expression\n      @scope:\n        extension: '0..n'\n        typedef:   '0..n'\n        module:    '0..n'\n        submodule: '0..n'\n\n## Class-level methods\n\n      @clear: ->\n        @module.splice(0,@module.length) if @module?\n        @submodule.splice(0,@submodule.length) if @submodule?\n\n### parse (schema)\n\nThis class-level routine performs recursive parsing of passed in\nstatement and sub-statements. It provides syntactic, semantic and\ncontextual validations on the provided schema and returns the final JS\nobject tree structure as hierarchical Yang expression instances.\n\nIf any validation errors are encountered, it will throw the\nappropriate error along with the context information regarding the\nerror.\n\n      @parse: (schema, opts={}) ->\n        opts.compile ?= true\n        try\n          schema = parser.parse schema if typeof schema is 'string'\n        catch e\n          e.offset = 50 unless e.offset > 50\n          offender = schema.slice e.offset-50, e.offset+50\n          offender = offender.replace \/\\s\\s+\/g, ' '\n          throw @error \"invalid YANG syntax detected around: '#{offender}'\", offender\n\n        unless schema instanceof Object\n          throw @error \"must pass in valid YANG schema\", schema\n\n        kind = switch\n          when !!schema.prf then \"#{schema.prf}:#{schema.kw}\"\n          else schema.kw\n        tag = schema.arg if !!schema.arg\n\t\t\n        schema = (new this kind, tag).extends schema.substmts.map (x) => @parse x, false\n        # perform final scoped constraint validation\n        for kind, constraint of schema.scope when constraint in [ '1', '1..n' ]\n          unless schema.hasOwnProperty kind\n            throw schema.error \"constraint violation for required '#{kind}' = #{constraint}\"\n        schema.compile() if opts.compile\n        return schema\n\nFor comprehensive overview on currently supported YANG statements,\nplease refer to\n[Compliance Report](..\/test\/yang-compliance-coverage.md) for the latest\n[RFC 6020](http:\/\/tools.ietf.org\/html\/rfc6020) YANG specification\ncompliance.\n\n### compose (data [, opts={}])\n\nThis call *accepts* any arbitrary JS object and it will attempt to\nconvert it into a structural `Yang` expression instance. It will\nanalyze the passed in JS data and perform best match mapping to an\nappropriate YANG schema representation to describe the input\ndata. This method will not be able to determine conditionals or any\nmeta-data to further constrain the data, but it should provide a good\nstarting point with the resulting `Yang` expression instance.\n\n      @compose: (data, opts={}) ->\n        unless data?\n          throw @error \"must supply input 'data' to compose\"\n\n        # explict compose\n        if opts.kind?\n          ext = Yang::lookup.call this, 'extension', opts.kind\n          unless ext instanceof Expression\n            throw @error \"unable to find requested '#{opts.kind}' extension\"\n          return ext.compose? data, opts\n\n        # implicit compose (dynamic discovery)\n        for ext in @extension when ext.compose instanceof Function\n          debug? \"checking data if #{ext.tag}\"\n          res = ext.compose data, opts\n          return res if res instanceof Yang\n\nThis facility is a powerful construct to dynamically generate `Yang`\nschema from ordinary JS objects. For additional usage examples, please\nrefer to [Dynamic Composition](..\/TUTORIAL.md#dynamic-composition)\nsection in the [Getting Started Guide](..\/TUTORIAL.md).\n\n### resolve (from..., name)\n\nThis call is internally used by [import](#import-name-opts) to\nperform a search within the local filesystem to locate a given YANG\nschema module by `name`. It will first check the calling code's local\n[package.json](..\/package.json) to look for a `models: {}`\nconfiguration section to identify where the target module can be\nfound. If there is an entry defined, it will then follow that\nreference - which may be a JS file, YANG schema text file, or another\nNPM module. If it is not found within the `models: {}` configuration\nblock or it fails to load the referenced dependency, it will then\nfallback to attempt to locate a YANG schema text file in the same\nfolder that the `resolve` request was made: `#{name}.yang`.\n\n      @resolve: (from..., name) ->\n        return null unless typeof name is 'string'\n        dir = from = switch\n          when from.length then from[0]\n          else path.resolve()\n        while not found? and dir not in [ '\/', '.' ]\n          target = \"#{dir}\/package.json\"\n          debug? \"[resolve] #{name} in #{target}\"\n          try\n            pkginfo = require(target)\n            found = pkginfo.models[name]\n          if found?\n            dir = path.dirname require.resolve(target)\n            debug? \"[resolve] #{name} check #{found} in #{dir}\"\n            unless !!path.extname found\n              from = switch\n                when found of pkginfo.dependencies\n                  path.resolve dir, 'node_modules', found\n                else path.resolve dir, found\n              if fs.existsSync from\n                return @resolve from, name\n              else\n                found = @resolve found, name\n          if not found? and pkginfo?.name is name\n            found = path.dirname require.resolve(target)\n          dir = path.dirname dir unless found?\n        file = switch\n          when not found? then path.resolve from, \"#{name}.yang\"\n          else path.resolve dir, found\n        debug? \"[resolve] checking if #{file} exists\"\n        return if fs.existsSync file then file else null\n\n### import (name [, opts={}])\n\nThis call provides a convenience mechanism for dealing with YANG\nschema module dependencies. It performs parsing of the YANG schema\ncontent from the specified `name` and saves the generated `Yang`\nexpression inside the internal registry. The `name` can be a YANG\nmodule name or a *filename* to the actual schema content (JS or YANG).\n\nOnce a given YANG module has been saved inside the registry,\nsubsequent [parse](#parse-schema) of YANG schema that *import* the\nsaved module will successfully resolve.\n\nTypical usage scenario for this pattern is to internally define common\nmodules such as `ietf-yang-types` which can then be *imported* by\nother schemas.\n\nIt will also return the new `Yang` expression instance (to do with as\nyou please).\n\n      @require: ->\n        console.warn \"DEPRECATION: please use .import() instead\"\n        @import arguments...\n\n      @import: (name, opts={}) ->\n        return unless name?\n        opts.basedir ?= ''\n        extname  = path.extname name\n        filename = path.resolve opts.basedir, name\n        basedir  = path.dirname filename\n\n        unless !!extname\n          return (Yang::match.call this, 'module', name) ? @import (@resolve name), opts\n\n        unless extname is '.yang'\n          res = require filename\n          unless res instanceof Yang\n            throw @error \"unable to import '#{name}' from '#{filename}' (not Yang expression)\", res\n          return res \n\n        try return @use (@parse (fs.readFileSync filename, 'utf-8'), opts)\n        catch e\n          unless opts.compile and e.name is 'ExpressionError' and e.context.kind in [ 'include', 'import' ]\n            console.error \"unable to import '#{name}' YANG module from '#{filename}'\"\n            throw e\n          opts.compile = false if e.context.kind is 'include'\n\n          # try to find the dependency module for import\n          dependency = @import (@resolve basedir, e.context.tag), opts\n          unless dependency?\n            e.message = \"unable to auto-resolve '#{e.context.tag}' dependency module\"\n            throw e\n\n          # retry the original request\n          debug? \"retrying import(#{name})\"\n          return @import arguments...\n\nPlease note that this method will look for the `name` in current\nworking directory of the script execution if the `name` is a relative\npath. It utilizes the [resolve](#resolve-from-name) method and will\nattempt to **recursively** resolve any failed `import` dependencies.\n\nWhile this is a convenient abstraction, it is **recommended** to\ndirectly use the Node.js built-in `require` mechanism (if\navailable). Using native `require` instead of `Yang.import` will\nallow package bundlers such as `browserify` to capture the\ndependencies as part of the produced bundle.  It also allows you to\ndirectly load YANG schema files from other NPM modules.\n\nBy default, loading the [yang-js](.\/main.coffee) module will attempt\nto associate `.yang` extension inside `require` facility. If\navailable, it will allow you to `require('.\/some-dependency.yang')`\nand get back a parsed `Yang expression` instance.\n\n## Main constructor\n\nThis method can be called directly without the use of `new` keyword\nand will internally parse the provided schema and return a `bound\nfunction` which will invoke [eval](#eval-data-opts) when called.\n\n      constructor: (kind, tag, extension) ->\n        unless this instanceof Yang\n          [ schema, bindings ] = arguments\n          schema = Yang.parse schema unless schema instanceof Yang\n          return schema.bind bindings\n\n        extension ?= (@lookup 'extension', kind)\n        self = super kind, tag, extension\n        unless extension instanceof Expression\n          @debug \"defer processing of custom extension #{kind}\"\n          @once 'compile:before', (->\n            @debug \"processing deferred extension #{kind}\"\n            extension = (@lookup 'extension', kind)\n            unless extension instanceof Yang\n              throw @error \"encountered unknown extension '#{kind}'\"\n            { @source, @argument } = extension\n          ).bind self\n        return self\n\n      @property 'datakey',\n        get: -> switch\n          when @parent instanceof Yang and @parent.kind is 'module' then \"#{@parent.tag}:#{@tag}\"\n          when @parent instanceof Yang and @parent.kind is 'submodule'\n            \"#{@parent['belongs-to'].tag}:#{@tag}\"\n          else @tag ? @kind\n\n      @property 'datapath',\n        get: -> switch\n          when @parent not instanceof Yang then ''\n          when @node then @parent.datapath + \"\/#{@datakey}\"\n          else @parent.datapath\n          \n      error: (msg, context) -> super \"[#{@trail}] #{msg}\", context\n      \n      emit: (event, args...) ->\n        @emitter.emit arguments...\n        @root.emit event, this if event is 'change' and this isnt @root\n\n## Instance-level methods\n\n### bind (obj)\n\nEvery instance of `Yang` expression can be *bound* with control logic\nwhich will be used during [eval](#eval-data-opts) to produce schema\ninfused **adaptive data object**. This routine is *inherited* from\n[Class Expression](.\/core\/expression.coffee).\n\nThis facility can be used to associate default behaviors for any\nelement in the configuration tree, as well as handler logic for\nvarious YANG statements such as *rpc*, *feature*, etc.\n\nThis call will return the original `Yang` expression instance with the\nnew bindings registered within the `Yang` expression hierarchy.\n\n      # bind() is inherited from Expression\n\nPlease refer to [Schema Binding](..\/TUTORIAL.md#schema-binding)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n### eval (data, opts={})\n\nEvery instance of `Yang` expression can be [eval](#eval-data-opts)\nwith arbitrary JS data input which will apply the schema against the\nprovided data and return a schema infused **adaptive** data object.\n\nThis is an extremely useful construct which brings out the true power\nof YANG for defining and governing arbitrary JS data structures.\n\nBasically, the input `data` will be YANG schema validated and\nconverted to a schema infused *adaptive data model* that dynamically\ndefines properties according to the schema expressions.\n\nIt currently supports the `opts.adaptive` parameter (default `false`)\nwhich establishes a persistent binding relationship with the governing\n`Yang` expression instance. This allows the generated model to\ndynamically **adapt** to any changes to the governing `Yang`\nexpression instance. Refer to below [extends](#extends-schema) section\nfor additional info on how the schema can be programmatically\nmodified.\n\n      eval: (data, opts={}) ->\n        if opts.adaptive is true\n          # TODO: this will break for 'module' which will return Model?\n          @once 'change', arguments.callee.bind(this, data, opts)\n        super\n\nPlease refer to [Working with Models](..\/TUTORIAL.md#working-with-models)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for special\nusage examples for `module` schemas.\n\n### extends (schema...)\n\nEvery instance of `Yang` expression can be `extends` with additional\nYANG schema string(s) and it will automatically perform\n[parse](#parse-schema) of the provided schema text and update itself\naccordingly.\n\nThis action also triggers an event emitter which will *retroactively*\nadapt any previously [eval](#eval-data-opts) produced adaptive data\nmodel instances to react accordingly to the newly changed underlying\nschema expression(s).\n\n      # extends() is inherited from Element\n\n      merge: (elem) ->\n        unless elem instanceof Yang\n          throw @error \"cannot merge invalid element into Yang\", elem\n\n        switch elem.kind\n          when 'type'     then super elem, append: true\n          when 'argument' then super elem, replace: true\n          else super\n\nPlease refer to [Schema Extension](..\/TUTORIAL.md#schema-extension)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n      normalizePath: (ypath) ->\n        lastPrefix = null\n        prefix2module = (root, prefix) ->\n          return unless root.kind is 'module'\n          switch\n            when root.tag is prefix then prefix\n            when root.prefix.tag is prefix then root.tag\n            else\n              for m in root.import ? [] when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              modules = root.lookup 'module'\n              for m in modules when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              return prefix # return as-is...\n              \n        normalizeEntry = (x) =>\n          return x unless x? and !!x\n          match = x.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n          unless match?\n            throw @error \"invalid path expression '#{x}' found in #{ypath}\"\n          [ prefix, target ] = [ match[1], match[2] ]\n          return switch\n            when not prefix? then target\n            when prefix is lastPrefix then target\n            else\n              lastPrefix = prefix\n              mname = prefix2module @root, prefix\n              \"#{mname}:#{target}\"\n        ypath = ypath.replace \/\\s\/g, ''\n        ypath\n          .split('\/')\n          .map normalizeEntry\n          .join('\/')\n\n### locate (ypath)\n\nThis is an internal helper facility used to locate a given schema node\nwithin the `Yang` schema expression tree hierarchy. It supports a\nlimited version of XPATH-like expression to locate an explicit\nelement.\n\n      locate: (ypath) ->\n        # TODO: figure out how to eliminate duplicate code-block section\n        # shared with Element\n        return unless ypath?\n        \n        @debug \"locate enter for '#{ypath}'\"\n        if typeof ypath is 'string'\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = @normalizePath(ypath).split('\/').filter (e) -> !!e\n        else\n          [ key, rest... ] = ypath\n        return this unless key? and key isnt '.'\n\n        if key is '..'\n          return @parent?.locate rest\n\n        match = key.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n        [ prefix, target ] = [ match[1], match[2] ]\n        if prefix? and this is @root\n          search = [target].concat(rest)\n          if (@tag is prefix) or (@lookup 'prefix', prefix)\n            @debug \"locate (local) '\/#{prefix}:#{search.join('\/')}'\"\n            return super search\n          for m in @import ? [] when m.tag is prefix or m.prefix.tag is prefix\n            @debug \"locate (external) '\/#{prefix}:#{search.join('\/')}'\"\n            return m.module.locate search\n          m = @lookup 'module', prefix\n          return m?.locate search\n\n        switch\n          when \/^{.+}$\/.test(target)\n            kind = 'grouping'\n            tag  = target.replace \/^{(.+)}$\/, '$1'\n          when \/^\\[.+\\]$\/.test(target)\n            kind = 'feature'\n            tag  = target.replace \/^\\[(.+)\\]$\/, '$1'\n          when \/^[^(]+\\([^)]*\\)$\/.test(target)\n            target = target.match \/^([^(]+)\\((.*)\\)$\/\n            [ kind, tag ] = [ target[1], target[2] ]\n            tag = undefined unless !!tag\n          when \/^\\<.+\\>$\/.test(target)\n            target = target.replace \/^\\<(.+)\\>$\/, '$1'\n            [ kind..., tag ]  = target.split ':'\n            [ tag, selector ] = tag.split '='\n            kind = kind[0] if kind?.length\n          else return super [key].concat rest\n            \n        match = @match kind, tag\n        return switch\n          when rest.length is 0 then match\n          else match?.locate rest\n\n### match (kind, tag)\n\nThis is an internal helper facility used by [locate](#locate-ypath) and\n[lookup](.\/element.litcoffee#lookup-kind-tag) to test whether a given\nentity exists in the local schema tree.\n\n      # Yang Expression can support 'tag' with prefix to another module\n      # (or itself).\n      match: (kind, tag) ->\n        return super unless kind? and tag? and typeof tag is 'string'\n        res = super\n        return res if res?\n        \n        [ prefix..., arg ] = tag.split ':'\n        return unless prefix.length\n\n        debug? \"[match] with #{kind} #{tag}\"\n\n        prefix = prefix[0]\n        debug? \"[match] check if current module's prefix\"\n        if @root.tag is prefix or @root.prefix?.tag is prefix\n          return @root.match kind, arg\n\n        debug? \"[match] checking if submodule's parent\"\n        ctx = @lookup 'belongs-to'\n        if ctx?.prefix.tag is prefix\n          return ctx.module.match kind, arg \n\n        debug? \"[match] check if one of current module's imports\"\n        imports = @root?.import ? []\n        for m in imports when m.prefix.tag is prefix\n          debug? m.module\n          return m.module.match kind, arg\n\n### toString (opts={})\n\nThe current `Yang` expression will covert back to the equivalent YANG\nschema text format.\n\nAt first glance, this may not seem like a useful facility since YANG\nschema text is *generally known* before [parse](#parse-schema) but it\nbecomes highly relevant when you consider a given `Yang` expression\nprogramatically changing via [extends](#extends-schema).\n\nCurrently it supports `space` parameter which can be used to specify\nnumber of spaces to use for indenting YANG statement blocks.  It\ndefaults to **2** but when set to **0**, the generated output will\nomit newlines and other spacing for a more compact YANG output.\n\n      toString: (opts={ space: 2 }) ->\n        s = @kind\n        if @source.argument?\n          s += ' ' + switch @source.argument\n            when 'value' then \"'#{@tag}'\"\n            when 'text'\n              \"\\n\" + (indent '\"'+@tag+'\"', ' ', opts.space)\n            else @tag\n        sub =\n          @elements\n            .filter (x) => x.parent is this\n            .map (x) -> x.toString opts\n            .join \"\\n\"\n        if !!sub\n          s += \" {\\n\" + (indent sub, ' ', opts.space) + \"\\n}\"\n        else\n          s += ';'\n        return s\n\n### toJSON\n\nThe current `Yang` expression will convert into a simple JS object\nformat.\n\n      # toJSON() is inherited from Element\n\n### valueOf\n\nThe current 'Yang' expression will convert into a primitive form for\ncomparision purposes.\n\n      valueOf: ->\n        switch @source.argument\n          when 'value','text' then @tag.valueOf()\n          else this\n\nPlease refer to [Schema Conversion](..\/TUTORIAL.md#schema-conversion)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n## Export Yang Class\n\n    module.exports = Yang\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"b92eb4eefc863ba35ddbd2e481d55bdc28ee529e","subject":"some code formatting fixes","message":"some code formatting fixes\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/02_helpers.litcoffee","new_file":"docs\/02_helpers.litcoffee","new_contents":"# Batman Helpers\n\nBatman includes a number of useful, general purpose helper functions and references. They can all be found attached to the `Batman` object and can optionally be exported into the global namespace with a `$` prefix.\n\n## container\n\n`Batman.container` points to either the `window` object if running in the browser, or the `global` object if running in node. This is useful if you want to add something to the global scope in all environments.\n\n## @typeOf(object) : string\n\n`typeOf` determines a more specific type of an `object` than the native `typeof` operator in JavaScript. This is useful for a number of situations like dealing with `Object` promoted strings and numbers, or arrays which look like `object`s to `typeof`. Use `typeOf` when you need more than `\"object\"` from `typeof`.\n\n_Note_: `typeOf` is substantially slower than `typeof`. `typeOf` works in a somewhat hackish manner by getting the `Object::toString` representation of the object and slicing it to retrieve the name of the constructor.\n\n    test 'typeOf returns \"String\" for both strings and Object strings', ->\n      primitive = \"test\"\n      objectified = new String(\"test\")\n      equal typeof primitive, \"string\"\n      equal typeof objectified, \"object\"\n      equal Batman.typeOf(primitive), \"String\"\n      equal Batman.typeOf(objectified), \"String\"\n\n    test 'typeOf returns Array for arrays', ->\n      array = [];\n      equal typeof array, \"object\"\n      equal Batman.typeOf(array), \"Array\"\n\n## @mixin(subject, objects...) : subject\n\n`mixin`, occasionally known elsewhere as `extend` or `merge`, flattens a series of objects onto the subject. Key\/value pairs on objects passed as later arguments (arguments with a higher index) take precedence over earlier arguments. Returns the `subject` passed in with the new values.\n\n`mixin` also has special properties that make it different than the canonical `extend` functions:\n\n 1. If the `subject` has a `set` function, `subject.set(key, value)` will be used to apply keys instead of `subject[key] = value`. This means that if the subject is a `Batman.Object`, observers and thus bindings on the object will be notified when other (Batmanified or not) objects are mixed into it.\n 2. If a mixed-in `object` has an `initialize` function defined, that function will be called and passed the `subject`. This is useful for custom extension logic, similar to `self.included` in Ruby. For this reason, the keys `initialize` and `uninitialize` are skipped by `mixin`.\n 3. `mixin` only iterates over keys for which the `hasOwnProperty` test passes.\n\n_Note_: `mixin` is destructive to (only) the first argument. If you need a non-destructive version of `mixin`, just pass an empty object as the first object, and all keys from the successive arguments will be applied to the empty object.\n\n    test 'mixin merges argument objects', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {fit: true}, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual subject, {fit: true, fly: true, funky: true}, \"the subject is modified destructively\"\n\n    test 'mixin merges argument objects', ->\n      unmodified = {fit: true}\n      deepEqual Batman.mixin({}, unmodified, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual unmodified, {fit: true}, \"argument objects are untouched allowing non-destructive merge\"\n\n    test 'mixed in objects passed as higher indexed arguments take precedence', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {x: 1, y: 1}, {x: 2}), {x: 2, y: 1}\n\n## @unmixin(subject, objects...) : subject\n\n`unmixin` \"unmerges\" the passed objects from the `subject`. If a key exists on any of the `objects` it will be `delete`d from the `subject`. Returns the `subject`.\n\n`unmixin`, similar to `mixin`, supports calling an `uninitialize` function for each of the `objects` being unmixed in. If an `uninitialize` function exists on each\n\n    test 'unmixin removes keys found on the unmixined objects on the subject', ->\n      subject = {fit: true, fly: true, funky: true}\n      deepEqual Batman.unmixin(subject, {fit: true}, {fly: true}), {funky: true}, \"unmixin returns the subject\"\n      deepEqual subject, {funky: true}, \"the subject is destructively modified.\"\n\n## @functionName(function) : string\n\n`functionName` returns the name of a given function, if any. Works with Internet Explorer 7\/8\/9, FireFox, Chrome, and Safari.\n\n    test 'functionName returns the name of a given function', ->\n      equal Batman.functionName(\"\".toString), 'toString'\n\n## @isChildOf(parent : HTMLElement, child : HTMLElement) : boolean\n\n`isChildOf` is a simple DOM helper which returns a boolean describing if the passed `child` node can be found in the descendants of the passed `parent` node.\n\n## @setImmediate(callback : Function) : object\n\n`setImmediate` (and its sister `clearImmediate`) are a more efficient version of `setTimeout(callback, 0)`. Due to timer resolution issues, setTimeout passed a timeout of 0 doesn't actually execute the function as soon as the JS execution stack has been emptied, but at minimum 4ms and maxmium 25ms after. For this reason Batman provides a cross browser implementation of `setImmediate` which does its best to call the callback immediately after the stack empties. Batman's `setImmediate` polyfill uses the native version if available, `window.postmessage` trickery if supported, and falls back on `setTimeout(->, 0)`.\n\n`setImmediate` returns a handle which can be passed to `clearImmediate` to cancel the future calling of the callback.\n\n## @clearImmediate(handle)\n\n`clearImmediate` stops the calling of a callback in the future when passed its `handle` (which is returned from the `setImmediate` call used to enqueue it).\n\n## @forEach(iterable : object, iterator : Function[, context : Object])\n\nThe `forEach` Batman helper is a universal iteration helper. When passed an `iterable` object, the helper will call the `iterator` (optionally in the `context`) for each item in the `iterable`. The `iterable` can be:\n\n 1. something which has its own `forEach`, in which case the `iterator` will just be passed to `iterable.forEach`.\n 2. an array like object, in which case a JavaScript `for(;;)` loop will be used to iterate over each entry\n 3. or an object, in which case a JavaScript `for-in` loop will be used to iterate over each entry.\n\nThe `forEach` helper is useful for iterating over objects when the type of those objects isn't guaranteed.\n\n    test 'forEach iterates over objects with forEach defined', ->\n      results = []\n      set = new Batman.SimpleSet('a')\n      Batman.forEach(set, (x) -> results.push(x))\n      deepEqual results, ['a']\n\n    test 'forEach iterates over array like objects', ->\n      results = []\n      ArrayLike = ->\n      ArrayLike:: = []\n      imitation = new ArrayLike\n      Array::push.call(imitation, \"a\")\n      Array::push.call(imitation, \"b\")\n      Batman.forEach(imitation, (x) -> results.push(x))\n      deepEqual results, ['a', 'b']\n\n    test 'forEach iterates over objects', ->\n      result = {}\n      object = {x: true}\n      Batman.forEach(object, (key, val) -> result[key] = val)\n      deepEqual result, object\n\n## @objectHasKey(object, key) : boolean\n\n`objectHasKey` returns a boolean describing the presence of the `key` in the passed `object`. `objectHasKey` delegates to the `object`'s `hasKey` function if present, and otherwise just does a check using the JavaScript `in` operator.\n\n    test 'objectHasKey verifies if a key is present in an object', ->\n      subject = {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n    test 'objectHasKey verifies if a key is present in an object with `hasKey` defined', ->\n      subject = new Batman.SimpleHash {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n## @contains(object, item) : boolean\n\n`contains` returns a boolean describing if the given `object` has member `item`. Membership in this context is defined as:\n\n + the result of `object.has(item)` if the `object` has a `has` function defined\n + the result of `item in object` if the `object` is arraylike\n + the result of the Batman.objectHasKey otherwise\n\n_Note_: When passed an object without a `has` function, `contains` will return `true` if the `object` has `item` as a *`key`*, not as a value at any key.\n\n`contains` is useful for checking item membership when the type of the object can't be relied on.\n\n## @get(object, key) : value\n\n`get` is a general purpose function for retrieving the value from a `key` on an `object` of an indeterminate type. This is useful if code needs to work with both `Batman.Object`s and Plain Old JavaScript Objects. `get` has the following semantics:\n\n + if the `object` has a `get` function defined, return the result of `object.get(key)`\n + if the object does not have a `get` function defined, use an ephemeral `Batman.Property` to retrieve the key. This is equivalent to `object[key]` for single segment `key`s, but if the `key` is multi-segment (example: 'product.customer.name'), `get` will do nested gets until the either `undefined` or the end of the keypath is reached.\n\n    test 'get returns the value at a key on a POJO', ->\n      subject = {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a key on a Batman.Object', ->\n      subject = Batman {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a deep key on a POJO', ->\n      subject = {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n    test 'get returns the value at a deep key on a Batman.Object', ->\n      subject = Batman {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n## @getPath(base, segments) : string\n\n`getPath` returns the hash value denoted by the specified path, which consists of an array of nested hash keys. See examples below for more detail.\n\n    test \"takes a base and an array of keys and returns the corresponding nested value\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo', 'bar']), 'nested value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo.bar']), 'flat value'\n      strictEqual Batman.getPath(@complexObject, ['hash', 'not-foo', 'bar']), undefined\n\n    test \"returns just the base if the key array is empty\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(@complexObject, []), @complexObject\n      strictEqual Batman.getPath(null, []), null\n\n    test \"returns undefined if the base is null-ish\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(null, ['foo']), undefined\n      strictEqual Batman.getPath(undefined, ['foo']), undefined\n\n    test \"returns falsy values\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(num: 0, ['num']), 0\n      strictEqual Batman.getPath(thing: null, ['thing']), null\n\n## @escapeHTML(string) : string\n\n`escapeHTML` takes a string of unknown origin and makes it safe for display on a web page by encoding control characters in HTML into their HTML entities.\n\n*Warning*: Do not rely on `escapeHTML` to purge unsafe data from user submitted content. While `escapeHTML` is applied to every binding's contents by default, it should not be your only line of defence against script injection attacks.\n\n    test 'escapeHTML encodes special characters into HTML entities', ->\n      equal Batman.escapeHTML(\"& < > \\\" '\"), \"&amp; &lt; &gt; &#34; &#39;\"\n\n# Batman.helpers\n\n`Batman.helpers` is a namespace for Batman's helpful string manipulation helpers.\n\n_Note_: Batman's pluralization functions mirror those of Rails' exactly.\n\n## @ordinalize(value : [number|string]) : string\n\n`ordinalize` converts a given integer into an ordinal string for describing position in a list, like 1st, 2nd, or 20th.\n\n    test 'ordinalize converts numbers to their ordinal form', ->\n      equal Batman.helpers.ordinalize(1), \"1st\"\n      equal Batman.helpers.ordinalize(\"2\"), \"2nd\"\n      equal Batman.helpers.ordinalize(1002), \"1002nd\"\n      equal Batman.helpers.ordinalize(\"1003\"), \"1003rd\"\n      equal Batman.helpers.ordinalize(-11), \"-11th\"\n      equal Batman.helpers.ordinalize(-1021), \"-1021st\"\n\n## @singularize(pluralString : string) : string\n\n`singularize` converts the plural form of a word to a singular form.\n\n    test 'singularize converts plural words to singular words', ->\n      equal Batman.helpers.singularize(\"posts\"), \"post\"\n      equal Batman.helpers.singularize(\"octopi\"), \"octopus\"\n      equal Batman.helpers.singularize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.singularize(\"word\"), \"word\"\n      equal Batman.helpers.singularize(\"CamelOctopi\"), \"CamelOctopus\"\n\n## @pluralize(singularString : string) : string\n\n`pluralize` converts the singular form of a word to the plural form.\n\n    test 'pluralize converts plural words to singular words', ->\n      equal Batman.helpers.pluralize(\"post\"), \"posts\"\n      equal Batman.helpers.pluralize(\"octopus\"), \"octopi\"\n      equal Batman.helpers.pluralize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.pluralize(\"words\"), \"words\"\n      equal Batman.helpers.pluralize(\"CamelOctopus\"), \"CamelOctopi\"\n\n## @camelize(string [, lowercaseFirstLetter = false]) : string\n\n`camelize` converts the passed `string` to UpperCamelCase. If the second argument is passed as `true`, then lowerCamelCase is returned.\n\n    test 'camelize returns the CamelCase version of an under_scored word', ->\n      equal Batman.helpers.camelize(\"batman_object\"), \"BatmanObject\"\n      equal Batman.helpers.camelize(\"batman_object\", true), \"batmanObject\"\n\n## @underscore(string) : string\n\n`underscore` returns the underscored version of a CamelCase word.\n\n    test 'underscore converts CamelCase to under_scores', ->\n      equal Batman.helpers.underscore(\"BatmanObject\"), \"batman_object\"\n\n## @capitalize(string) : string\n\n`capitalize` does a word-wise capitalization of a phrase or word.\n\n    test 'capitalize makes the first letter of each word in the string uppercase', ->\n      equal Batman.helpers.capitalize(\"batmanObject\"), \"BatmanObject\"\n      equal Batman.helpers.capitalize(\"batman object\"), \"Batman Object\"\n      equal Batman.helpers.capitalize(\"AlreadyCapitalized\"), \"AlreadyCapitalized\"\n\n## @trim(string) : string\n\n`trim` trims a string getting rid of extra white space around the string or returning an empty string if it is null.\n\n    test 'trim gets rid of space around a string', ->\n      equal Batman.helpers.trim(\"TrimRight \"), \"TrimRight\"\n      equal Batman.helpers.trim(\" TrimLeft\"), \"TrimLeft\"\n      equal Batman.helpers.trim(\" TrimBothSides \"), \"TrimBothSides\"\n      equal Batman.helpers.trim(\"AlreadyTrimmed\"), \"AlreadyTrimmed\"\n\n    test 'trim turns a null or undefined string into an empty string', ->\n      equal Batman.helpers.trim(null), \"\"\n      equal Batman.helpers.trim(undefined), \"\"\n\n## @interpolate(stringOrObject, keys) : string\n\n`interpolate` interpolates a string, filling it in with values matching interpolation keys, similar to printf variants.\n\n    test 'interpolate fills in key values globally in a string', ->\n      equal Batman.helpers.interpolate(\"%{field} must be at least %{count} characters in order for %{field} to be valid\", count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string', ->\n      equal Batman.helpers.interpolate({'other': \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string, embedded by key count', ->\n      equal Batman.helpers.interpolate({3: \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n## @humanize(string) : string\n\n`humanize` reformats a string that has a programmatic meaning (camelcased, underscored, \"_id\" suffixed) to make human-readable by separating concatenated words and\/or getting rid of the \"_id\" suffix.\n\n    test 'humanize replaces underscores and dashes with empty space', ->\n      equal Batman.helpers.humanize('underscored_string'), 'Underscored string'\n      equal Batman.helpers.humanize('dash-separated-string'), 'Dash separated string'\n\n    test 'humanize splits camel cased words by empty space', ->\n      equal Batman.helpers.humanize('CamelCasedString'), 'Camel cased string'\n\n    test 'humanize title-cases the first word', ->\n      equal Batman.helpers.humanize('lower case sentence'), 'Lower case sentence'\n\n    test 'humanize lower-cases all words after the first one', ->\n      equal Batman.helpers.humanize('Mixed Case SENTENCE'), 'Mixed case sentence'\n\n    test 'humanize gets rid of _id suffix', ->\n      equal Batman.helpers.humanize('identifying_string_id'), 'Identifying string'\n","old_contents":"# Batman Helpers\n\nBatman includes a number of useful, general purpose helper functions and references. They can all be found attached to the `Batman` object and can optionally be exported into the global namespace with a `$` prefix.\n\n## container\n\n`Batman.container` points to either the `window` object if running in the browser, or the `global` object if running in node. This is useful if you want to add something to the global scope in all environments.\n\n## @typeOf(object) : string\n\n`typeOf` determines a more specific type of an `object` than the native `typeof` operator in JavaScript. This is useful for a number of situations like dealing with `Object` promoted strings and numbers, or arrays which look like `object`s to `typeof`. Use `typeOf` when you need more than `\"object\"` from `typeof`.\n\n_Note_: `typeOf` is substantially slower than `typeof`. `typeOf` works in a somewhat hackish manner by getting the `Object::toString` representation of the object and slicing it to retrieve the name of the constructor.\n\n    test 'typeOf returns \"String\" for both strings and Object strings', ->\n      primitive = \"test\"\n      objectified = new String(\"test\")\n      equal typeof primitive, \"string\"\n      equal typeof objectified, \"object\"\n      equal Batman.typeOf(primitive), \"String\"\n      equal Batman.typeOf(objectified), \"String\"\n\n    test 'typeOf returns Array for arrays', ->\n      array = [];\n      equal typeof array, \"object\"\n      equal Batman.typeOf(array), \"Array\"\n\n## @mixin(subject, objects...) : subject\n\n`mixin`, occasionally known elsewhere as `extend` or `merge`, flattens a series of objects onto the subject. Key\/value pairs on objects passed as later arguments (arguments with a higher index) take precedence over earlier arguments. Returns the `subject` passed in with the new values.\n\n`mixin` also has special properties that make it different than the canonical `extend` functions:\n\n 1. If the `subject` has a `set` function, `subject.set(key, value)` will be used to apply keys instead of `subject[key] = value`. This means that if the subject is a `Batman.Object`, observers and thus bindings on the object will be notified when other (Batmanified or not) objects are mixed into it.\n 2. If a mixed-in `object` has an `initialize` function defined, that function will be called and passed the `subject`. This is useful for custom extension logic, similar to `self.included` in Ruby. For this reason, the keys `initialize` and `uninitialize` are skipped by `mixin`.\n 3. `mixin` only iterates over keys for which the `hasOwnProperty` test passes.\n\n_Note_: `mixin` is destructive to (only) the first argument. If you need a non-destructive version of `mixin`, just pass an empty object as the first object, and all keys from the successive arguments will be applied to the empty object.\n\n    test 'mixin merges argument objects', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {fit: true}, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual subject, {fit: true, fly: true, funky: true}, \"the subject is modified destructively\"\n\n    test 'mixin merges argument objects', ->\n      unmodified = {fit: true}\n      deepEqual Batman.mixin({}, unmodified, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual unmodified, {fit: true}, \"argument objects are untouched allowing non-destructive merge\"\n\n    test 'mixed in objects passed as higher indexed arguments take precedence', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {x: 1, y: 1}, {x: 2}), {x: 2, y: 1}\n\n## @unmixin(subject, objects...) : subject\n\n`unmixin` \"unmerges\" the passed objects from the `subject`. If a key exists on any of the `objects` it will be `delete`d from the `subject`. Returns the `subject`.\n\n`unmixin`, similar to `mixin`, supports calling an `uninitialize` function for each of the `objects` being unmixed in. If an `uninitialize` function exists on each\n\n    test 'unmixin removes keys found on the unmixined objects on the subject', ->\n      subject = {fit: true, fly: true, funky: true}\n      deepEqual Batman.unmixin(subject, {fit: true}, {fly: true}), {funky: true}, \"unmixin returns the subject\"\n      deepEqual subject, {funky: true}, \"the subject is destructively modified.\"\n\n## @functionName(function) : string\n\n`functionName` returns the name of a given function, if any. Works with Internet Explorer 7\/8\/9, FireFox, Chrome, and Safari.\n\n    test 'functionName returns the name of a given function', ->\n      equal Batman.functionName(\"\".toString), 'toString'\n\n## @isChildOf(parent : HTMLElement, child : HTMLElement) : boolean\n\n`isChildOf` is a simple DOM helper which returns a boolean describing if the passed `child` node can be found in the descendants of the passed `parent` node.\n\n## @setImmediate(callback : Function) : object\n\n`setImmediate` (and its sister `clearImmediate`) are a more efficient version of `setTimeout(callback, 0)`. Due to timer resolution issues, setTimeout passed a timeout of 0 doesn't actually execute the function as soon as the JS execution stack has been emptied, but at minimum 4ms and maxmium 25ms after. For this reason Batman provides a cross browser implementation of `setImmediate` which does its best to call the callback immediately after the stack empties. Batman's `setImmediate` polyfill uses the native version if available, `window.postmessage` trickery if supported, and falls back on `setTimeout(->, 0)`.\n\n`setImmediate` returns a handle which can be passed to `clearImmediate` to cancel the future calling of the callback.\n\n## @clearImmediate(handle)\n\n`clearImmediate` stops the calling of a callback in the future when passed its `handle` (which is returned from the `setImmediate` call used to enqueue it).\n\n## @forEach(iterable : object, iterator : Function[, context : Object])\n\nThe `forEach` Batman helper is a universal iteration helper. When passed an `iterable` object, the helper will call the `iterator` (optionally in the `context`) for each item in the `iterable`. The `iterable` can be:\n\n 1. something which has its own `forEach`, in which case the `iterator` will just be passed to `iterable.forEach`.\n 2. an array like object, in which case a JavaScript `for(;;)` loop will be used to iterate over each entry\n 3. or an object, in which case a JavaScript `for-in` loop will be used to iterate over each entry.\n\nThe `forEach` helper is useful for iterating over objects when the type of those objects isn't guaranteed.\n\n    test 'forEach iterates over objects with forEach defined', ->\n      results = []\n      set = new Batman.SimpleSet('a')\n      Batman.forEach(set, (x) -> results.push(x))\n      deepEqual results, ['a']\n\n    test 'forEach iterates over array like objects', ->\n      results = []\n      ArrayLike = ->\n      ArrayLike:: = []\n      imitation = new ArrayLike\n      Array::push.call(imitation, \"a\")\n      Array::push.call(imitation, \"b\")\n      Batman.forEach(imitation, (x) -> results.push(x))\n      deepEqual results, ['a', 'b']\n\n    test 'forEach iterates over objects', ->\n      result = {}\n      object = {x: true}\n      Batman.forEach(object, (key, val) -> result[key] = val)\n      deepEqual result, object\n\n## @objectHasKey(object, key) : boolean\n\n`objectHasKey` returns a boolean describing the presence of the `key` in the passed `object`. `objectHasKey` delegates to the `object`'s `hasKey` function if present, and otherwise just does a check using the JavaScript `in` operator.\n\n    test 'objectHasKey verifies if a key is present in an object', ->\n      subject = {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n    test 'objectHasKey verifies if a key is present in an object with `hasKey` defined', ->\n      subject = new Batman.SimpleHash {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n## @contains(object, item) : boolean\n\n`contains` returns a boolean describing if the given `object` has member `item`. Membership in this context is defined as:\n\n + the result of `object.has(item)` if the `object` has a `has` function defined\n + the result of `item in object` if the `object` is arraylike\n + the result of the Batman.objectHasKey otherwise\n\n_Note_: When passed an object without a `has` function, `contains` will return `true` if the `object` has `item` as a *`key`*, not as a value at any key.\n\n`contains` is useful for checking item membership when the type of the object can't be relied on.\n\n## @get(object, key) : value\n\n`get` is a general purpose function for retrieving the value from a `key` on an `object` of an indeterminate type. This is useful if code needs to work with both `Batman.Object`s and Plain Old JavaScript Objects. `get` has the following semantics:\n\n + if the `object` has a `get` function defined, return the result of `object.get(key)`\n + if the object does not have a `get` function defined, use an ephemeral `Batman.Property` to retrieve the key. This is equivalent to `object[key]` for single segment `key`s, but if the `key` is multi-segment (example: 'product.customer.name'), `get` will do nested gets until the either `undefined` or the end of the keypath is reached.\n\n    test 'get returns the value at a key on a POJO', ->\n      subject = {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a key on a Batman.Object', ->\n      subject = Batman {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a deep key on a POJO', ->\n      subject = {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n    test 'get returns the value at a deep key on a Batman.Object', ->\n      subject = Batman {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n## @getPath(base, segments) : string\n\n`getPath` returns the hash value denoted by the specified path, which consists of an array of nested hash keys. See examples below for more detail.\n\n    test \"takes a base and an array of keys and returns the corresponding nested value\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo', 'bar']), 'nested value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo.bar']), 'flat value'\n      strictEqual Batman.getPath(@complexObject, ['hash', 'not-foo', 'bar']), undefined\n\n    test \"returns just the base if the key array is empty\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(@complexObject, []), @complexObject\n      strictEqual Batman.getPath(null, []), null\n\n    test \"returns undefined if the base is null-ish\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(null, ['foo']), undefined\n      strictEqual Batman.getPath(undefined, ['foo']), undefined\n\n    test \"returns falsy values\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(num: 0, ['num']), 0\n      strictEqual Batman.getPath(thing: null, ['thing']), null\n\n## @escapeHTML(string) : string\n\n`escapeHTML` takes a string of unknown origin and makes it safe for display on a web page by encoding control characters in HTML into their HTML entities.\n\n*Warning*: Do not rely on `escapeHTML` to purge unsafe data from user submitted content. While `escapeHTML` is applied to every binding's contents by default, it should not be your only line of defence against script injection attacks.\n\n    test 'escapeHTML encodes special characters into HTML entities', ->\n      equal Batman.escapeHTML(\"& < > \\\" '\"), \"&amp; &lt; &gt; &#34; &#39;\"\n\n# Batman.helpers\n\n`Batman.helpers` is a namespace for Batman's helpful string manipulation helpers.\n\n_Note_: Batman's pluralization functions mirror those of Rails' exactly.\n\n## @ordinalize(value : [number|string]) : string\n\n`ordinalize` converts a given integer into an ordinal string for describing position in a list, like 1st, 2nd, or 20th.\n\n    test 'ordinalize converts numbers to their ordinal form', ->\n      equal Batman.helpers.ordinalize(1)     , \"1st\"\n      equal Batman.helpers.ordinalize(\"2\")     , \"2nd\"\n      equal Batman.helpers.ordinalize(1002)  , \"1002nd\"\n      equal Batman.helpers.ordinalize(\"1003\")  , \"1003rd\"\n      equal Batman.helpers.ordinalize(-11)   , \"-11th\"\n      equal Batman.helpers.ordinalize(-1021) , \"-1021st\"\n\n## @singularize(pluralString : string) : string\n\n`singularize` converts the plural form of a word to a singular form.\n\n    test 'singularize converts plural words to singular words', ->\n      equal Batman.helpers.singularize(\"posts\"), \"post\"\n      equal Batman.helpers.singularize(\"octopi\"), \"octopus\"\n      equal Batman.helpers.singularize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.singularize(\"word\"), \"word\"\n      equal Batman.helpers.singularize(\"CamelOctopi\"), \"CamelOctopus\"\n\n## @pluralize(singularString : string) : string\n\n`pluralize` converts the singular form of a word to the plural form.\n\n    test 'pluralize converts plural words to singular words', ->\n      equal Batman.helpers.pluralize(\"post\"), \"posts\"\n      equal Batman.helpers.pluralize(\"octopus\"), \"octopi\"\n      equal Batman.helpers.pluralize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.pluralize(\"words\"), \"words\"\n      equal Batman.helpers.pluralize(\"CamelOctopus\"), \"CamelOctopi\"\n\n## @camelize(string, [lowercaseFirstLetter = false]) : string\n\n`camelize` converts the passed `string` to UpperCamelCase. If the second argument is passed as `true`, then lowerCamelCase is returned.\n\n    test 'camelize returns the CamelCase version of an under_scored word', ->\n      equal Batman.helpers.camelize(\"batman_object\"), \"BatmanObject\"\n      equal Batman.helpers.camelize(\"batman_object\", true), \"batmanObject\"\n\n## @underscore(string) : string\n\n`underscore` returns the underscored version of a CamelCase word.\n\n    test 'underscore converts CamelCase to under_scores', ->\n      equal Batman.helpers.underscore(\"BatmanObject\"), \"batman_object\"\n\n## @capitalize(string) : string\n\n`capitalize` does a word-wise capitalization of a phrase or word.\n\n    test 'capitalize makes the first letter of each word in the string uppercase', ->\n      equal Batman.helpers.capitalize(\"batmanObject\"), \"BatmanObject\"\n      equal Batman.helpers.capitalize(\"batman object\"), \"Batman Object\"\n      equal Batman.helpers.capitalize(\"AlreadyCapitalized\"), \"AlreadyCapitalized\"\n\n## @trim(string) : string\n\n`trim` trims a string getting rid of extra white space around the string or returning an empty string if it is null.\n\n    test 'trim gets rid of space around a string', ->\n      equal Batman.helpers.trim(\"TrimRight \"), \"TrimRight\"\n      equal Batman.helpers.trim(\" TrimLeft\"), \"TrimLeft\"\n      equal Batman.helpers.trim(\" TrimBothSides \"), \"TrimBothSides\"\n      equal Batman.helpers.trim(\"AlreadyTrimmed\"), \"AlreadyTrimmed\"\n\n    test 'trim turns a null or undefined string into an empty string', ->\n      equal Batman.helpers.trim(null), \"\"\n      equal Batman.helpers.trim(undefined), \"\"\n\n## @interpolate(stringOrObject, keys) : string\n\n`interpolate` interpolates a string, filling it in with values matching interpolation keys, similar to printf variants.\n\n    test 'interpolate fills in key values globally in a string', ->\n      equal Batman.helpers.interpolate(\"%{field} must be at least %{count} characters in order for %{field} to be valid\", count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string', ->\n      equal Batman.helpers.interpolate({'other': \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string, embedded by key count', ->\n      equal Batman.helpers.interpolate({3: \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n## @humanize(string) : string\n\n`humanize` reformats a string that has a programmatic meaning (camelcased, underscored, \"_id\" suffixed) to make human-readable by separating concatenated words and\/or getting rid of the \"_id\" suffix.\n\n    test 'humanize replaces underscores and dashes with empty space', ->\n      equal Batman.helpers.humanize('underscored_string'), 'Underscored string'\n      equal Batman.helpers.humanize('dash-separated-string'), 'Dash separated string'\n\n    test 'humanize splits camel cased words by empty space', ->\n      equal Batman.helpers.humanize('CamelCasedString'), 'Camel cased string'\n\n    test 'humanize title-cases the first word', ->\n      equal Batman.helpers.humanize('lower case sentence'), 'Lower case sentence'\n\n    test 'humanize lower-cases all words after the first one', ->\n      equal Batman.helpers.humanize('Mixed Case SENTENCE'), 'Mixed case sentence'\n\n    test 'humanize gets rid of _id suffix', ->\n      equal Batman.helpers.humanize('identifying_string_id'), 'Identifying string'\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a28c5d6b9e19c692da9548550b50e7d571c5f83e","subject":"clean up requests markdown","message":"clean up requests markdown\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/07_request.litcoffee","new_file":"docs\/07_request.litcoffee","new_contents":"# Batman.Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented in the platform layer files.\n\n### Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\nBatman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\nIn other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n\n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n\nThere are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n1) `loading()`: fired before `send()` has been called.\n\n    test \"Demonstrate the loading event\", 1, ->\n       new Batman.Request\n         url: \"http::\/\/batmanjs.org\"\n         loading: ->\n           ok true, \"After send but before the request is made\"\n\n2) `loaded()`: fired after the request is complete\n\n     test \"Demo the loaded event\", 1, ->\n       Batman.Request.setupMockedResponse()\n       Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n       new Batman.Request\n         url: \"http:\/\/batmanjs.org\"\n         loaded: ->\n           ok true, \"Loaded\"\n\n3) `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n    test \"Demo the error event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        error: (xhr) ->\n          ok true, \"Error\"\n\n4) `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n    test \"Demonstrate the success event\", 1,  ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", response\n\n## .status\nThe response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\nThe response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : object\nAn key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request(options : object)\n\nConstructs a new `Batman.Request` with the supplied options\n\n### `options`\n\n1) `url : String`: A string containing the URL to which the request is sent.  Mandatory\n\n2) `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`\n\n    test \"method test\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"POST\"\n        data: { some: \"data\" }\n        success: (response) ->\n          ok true\n\n3) `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n\n4) `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n    test \"contentType default\", ->\n       req = new Batman.Request\n       equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n5) `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n    test \"autosend test\", ->\n      response_sent = false\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        success: (response) ->\n          response_sent = true\n      ok !response_sent\n      req.send()\n      ok response_sent\n\n6) `username`: username for authentication\n\n7) `password`: password for authentication\n\n8) `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send([data])\nIf `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","old_contents":"# Batman.Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented in the platform layer files.\n\n### Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\n  Batman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\n  In other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n    \n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n There are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n 1. `loading()`: fired before `send()` has been called.\n\n    test \"Demonstrate the loading event\", 1, ->\n       new Batman.Request\n         url: \"http::\/\/batmanjs.org\"\n         loading: ->\n           ok true, \"After send but before the request is made\"\n\n 2. `loaded()`: fired after the request is complete\n\n     test \"Demo the loaded event\", 1, ->\n       Batman.Request.setupMockedResponse()\n       Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n       new Batman.Request\n         url: \"http:\/\/batmanjs.org\"\n         loaded: ->\n           ok true, \"Loaded\"\n\n 3. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n    test \"Demo the error event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        error: (xhr) ->\n          ok true, \"Error\"\n\n 4. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n    test \"Demonstrate the success event\", 1,  ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", response\n\n## .status\n  The response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\n  The response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : object\n  An key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request(options : object)\n\n  Constructs a new `Batman.Request` with the supplied options\n\n  `options` description\n  1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n  2. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`\n\n    test \"method test\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"POST\"\n        data: { some: \"data\" }\n        success: (response) ->\n          ok true\n\n  3. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n  4. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n    test \"contentType default\", ->\n       req = new Batman.Request\n       equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n  5. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n    test \"autosend test\", ->\n      response_sent = false\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        success: (response) ->\n          response_sent = true\n      ok !response_sent\n      req.send()\n      ok response_sent\n\n  6. `username`: username for authentication\n  7. `password`: password for authentication\n  8. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send([data])\n  If `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bb2021d73a293df2eec10695074f26078d9c85fc","subject":"added purge, getCreateTime, and getLastUpdateTime","message":"added purge, getCreateTime, and getLastUpdateTime\n","repos":"Custom-Elements\/glg-hummingbird","old_file":"src\/glg-hummingbird.litcoffee","new_file":"src\/glg-hummingbird.litcoffee","new_contents":"# glg-hummingbird\nPolymer element to maintain hummingbird typeahead lists in browsers' localStorage\n\n    hummingbird = require 'hummingbird'\n    # shim for chrome file system access\n    window.requestFileSystem = window.requestFileSystem ? window.webkitRequestFileSystem\n\n    Polymer 'glg-hummingbird',\n\n## Events\n### HB_RESULTS\nThis event is emitted when there are new hummingbird results returned where the payload is the results array.\n\n### NO_HB_INDEX\nThis event is emitted when attempting to load a non-existent hummingbird index from persistence.\n\n### FS_ERROR\nThis event is emitted when there is an error interacting with the file system where the payload is the error object.\n\n## Methods\n### search\nMethod for retrieving results from a humminbird index\n* query (required) - a string to be tokenized and searched\n\n      search: (query) ->\n        hbOptions =\n          scoreThreshold: @scoreThreshold ? 0\n          secondarySortField: @secondarySortField\n          secondarySortOrder: @secondarySortOrder\n          howMany: @howMany ? 10\n          startPos: @startPos ? 0\n\n        #lookup by fuzzy name match\n        @idx.search query, (results) =>\n          @fire 'HB_RESULTS', results\n        , hbOptions\n\n### jump\nMethod for retrieving a single result from a hummingbird index by ID\n* id (required) - the ID of the document to be returned\n\n      jump: (id) ->\n        #lookup by ID\n        @idx.jump id, (results) =>\n          @fire 'HB_RESULTS', results\n\n### upsert\nMethod to insert new entries into the index or update existing entries\n\n      upsert: (doc) ->\n        unless doc?.name? and doc?.id?\n          console.error \"glg-hb: every hummingbird document must have a minimum of 'name' and 'id' properties\"\n        else\n          @idx.add doc\n\n### persist\nMethod to persist hummingbird index to localStorage\n\n      persist: () ->\n        window.requestFileSystem window.TEMPORARY, null\n        , (fs) =>\n          # success handler\n          fs.root.getFile @indexName, {create: true}, (fileEntry) =>\n            fileEntry.createWriter (fileWriter) =>\n              fileWriter.onerror = @__fileErrorHandler()\n              fileWriter.onwriteend = (evt) ->\n                # Do we care to share success?\n                return\n              try\n                fileWriter.write new Blob([JSON.stringify(@idx.toJSON())], {type: 'text\/plain'})\n              catch err\n                console.error \"glg-hb: unable to persist #{@indexName} index: #{JSON.stringify err}\"\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n\n### purge\nMethod to delete persisted file from disk\n\n      purge: () ->\n        window.requestFileSystem window.TEMPORARY, null, (fs) =>\n          fs.root.getFile @indexName, { create: false }, (fileEntry) =>\n            fileEntry.remove =>\n              console.log \"glg-hb: purged persisted #{@indexName} index.\"\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n### getLastUpdateTime\nMethod that returns the timestamp for the last time the index was updated (including create, add, or remove, but not persist or load)\n\n      getLastUpdateTime: () ->\n        @idx.lastUpdate\n\n### getCreateTime\nMethod that returns the timestamp for the index creation (not persist or load)\n\n      getCreateTime: () ->\n        @idx.createTime\n\n### __fileErrorHandler\nInternal method to handle various filesystem errors\n\n      __fileErrorHandler: () ->\n        #closure to maintain reference to Polymer object in scope\n        (err) =>\n          switch err.code\n            when FileError.QUOTA_EXCEEDED_ERR\n              console.error 'glg-hb: QUOTA_EXCEEDED_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.NOT_FOUND_ERR\n              console.debug \"glg-hb: no persisted index: #{JSON.stringify err}\"\n              @fire 'NO_HB_INDEX'\n            when FileError.SECURITY_ERR\n              console.error 'glg-hb: SECURITY_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.INVALID_MODIFICATION_ERR\n              console.error 'glg-hb: INVALID_MODIFICATION_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.INVALID_STATE_ERR\n              console.error 'glg-hb: INVALID_STATE_ERR'\n              @fire 'FS_ERROR', err\n            else\n              console.error 'glg-hb: unknown file system error'\n              @fire 'FS_ERROR', err\n\n## Polymer Lifecycle\n\n      created: ->\n        # create an empty index\n        @idx = new hummingbird()\n        window.requestFileSystem window.TEMPORARY, null\n        , (fs) =>\n          # success handler\n          fs.root.getFile @indexName, {}, (fileEntry) =>\n            fileEntry.file (file) =>\n              reader = new FileReader()\n              reader.onerror = @__fileErrorHandler()\n              reader.onloadend = (evt) ->\n                # @result is the text of the file read\n                if @result? and @result isnt ''\n                  try\n                    # if we found a persisted index, replace our empty index with it\n                    _this.idx = hummingbird.Index.load JSON.parse(@result)\n                  catch err\n                    console.error \"glg-hb: unable to load persisted #{_this.indexName} index: #{JSON.stringify err}\"\n                else\n                  console.warn \"glg-hb: found an empty file when trying to load persisted #{_this.indexName} index.\"\n                  _this.__fileErrorHandler() {code:FileError.NOT_FOUND_ERR}\n              reader.readAsText file\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n      ready: ->\n\n      attached: ->\n\n      domReady: ->\n\n      detached: ->\n","old_contents":"# glg-hummingbird\nPolymer element to maintain hummingbird typeahead lists in browsers' localStorage\n\n    hummingbird = require 'hummingbird'\n    # shim for chrome file system access\n    window.requestFileSystem = window.requestFileSystem ? window.webkitRequestFileSystem\n\n    Polymer 'glg-hummingbird',\n\n## Events\n### HB_RESULTS\nThis event is emitted when there are new hummingbird results returned where the payload is the results array.\n\n### NO_HB_INDEX\nThis event is emitted when attempting to load a non-existent hummingbird index from persistence.\n\n### FS_ERROR\nThis event is emitted when there is an error interacting with the file system where the payload is the error object.\n\n## Methods\n### search\nMethod for retrieving results from a humminbird index\n* query (required) - a string to be tokenized and searched\n\n      search: (query) ->\n        hbOptions =\n          scoreThreshold: @scoreThreshold ? 0\n          secondarySortField: @secondarySortField\n          secondarySortOrder: @secondarySortOrder\n          howMany: @howMany ? 10\n          startPos: @startPos ? 0\n\n        #lookup by fuzzy name match\n        @idx.search query, (results) =>\n          @fire 'HB_RESULTS', results\n        , hbOptions\n\n### jump\nMethod for retrieving a single result from a hummingbird index by ID\n* id (required) - the ID of the document to be returned\n\n      jump: (id) ->\n        #lookup by ID\n        @idx.jump id, (results) =>\n          @fire 'HB_RESULTS', results\n\n### upsert\nMethod to insert new entries into the index or update existing entries\n\n      upsert: (doc) ->\n        unless doc?.name? and doc?.id?\n          console.error \"glg-hb: every hummingbird document must have a minimum of 'name' and 'id' properties\"\n        else\n          @idx.add doc\n\n### persist\nMethod to persist hummingbird index to localStorage\n\n      persist: () ->\n        window.requestFileSystem window.TEMPORARY, null\n        , (fs) =>\n          # success handler\n          fs.root.getFile @indexName, {create: true}, (fileEntry) =>\n            fileEntry.createWriter (fileWriter) =>\n              fileWriter.onerror = @__fileErrorHandler()\n              fileWriter.onwriteend = (evt) ->\n                # Do we care to share success?\n                return\n              try\n                fileWriter.write new Blob([JSON.stringify(@idx.toJSON())], {type: 'text\/plain'})\n              catch err\n                console.error \"glg-hb: unable to persist #{@indexName} index: #{JSON.stringify err}\"\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n### __fileErrorHandler\nInternal method to handle various filesystem errors\n\n      __fileErrorHandler: () ->\n        #closure to maintain reference to Polymer object in scope\n        (err) =>\n          switch err.code\n            when FileError.QUOTA_EXCEEDED_ERR\n              console.error 'glg-hb: QUOTA_EXCEEDED_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.NOT_FOUND_ERR\n              console.debug \"glg-hb: no persisted index: #{JSON.stringify err}\"\n              @fire 'NO_HB_INDEX'\n            when FileError.SECURITY_ERR\n              console.error 'glg-hb: SECURITY_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.INVALID_MODIFICATION_ERR\n              console.error 'glg-hb: INVALID_MODIFICATION_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.INVALID_STATE_ERR\n              console.error 'glg-hb: INVALID_STATE_ERR'\n              @fire 'FS_ERROR', err\n            else\n              console.error 'glg-hb: unknown file system error'\n              @fire 'FS_ERROR', err\n\n## Polymer Lifecycle\n\n      created: ->\n        # create an empty index\n        @idx = new hummingbird()\n        window.requestFileSystem window.TEMPORARY, null\n        , (fs) =>\n          # success handler\n          fs.root.getFile @indexName, {}, (fileEntry) =>\n            fileEntry.file (file) =>\n              reader = new FileReader()\n              reader.onerror = @__fileErrorHandler()\n              reader.onloadend = (evt) ->\n                # @result is the text of the file read\n                if @result? and @result isnt ''\n                  try\n                    # if we found a persisted index, replace our empty index with it\n                    _this.idx = hummingbird.Index.load JSON.parse(@result)\n                  catch err\n                    console.error \"glg-hb: unable to load persisted #{_this.indexName} index: #{JSON.stringify err}\"\n                else\n                  console.warn \"glg-hb: found an empty file when trying to load persisted #{_this.indexName} index.\"\n                  _this.__fileErrorHandler() {code:FileError.NOT_FOUND_ERR}\n              reader.readAsText file\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n      ready: ->\n\n      attached: ->\n\n      domReady: ->\n\n      detached: ->\n","returncode":0,"stderr":"","license":"isc","lang":"Literate CoffeeScript"}
{"commit":"b87e2d2e4f9f65b28ef8c97d89b45a205179e632","subject":"Fast detection of normally closed windows.","message":"Fast detection of normally closed windows.\n\nWindows when closed normally receive a window \"unload\" event.  A\nwindow isn't able to write to the database at this point (it will\nreceive no more events in the event loop), but it is able to write to\nlocal storage and\/or send a message to the shared web worker.\n\nThis isn't 100% reliable (windows can crash without having a chance to\nprocess the unload event), but it does provide for a fast path for\ndetecting dead windows when they've been closed normally.  Pings are\nstill used to detect crashed windows.\n","repos":"awwx\/meteor-offline-common","old_file":"windows.litcoffee","new_file":"windows.litcoffee","new_contents":"    @Offline or= {}\n    {Fanout, Result} = awwx\n    broadcast = Offline._broadcast\n    {defer} = awwx.Error\n    {withContext} = awwx.Context\n    db = Offline._database\n\n\n    Offline._windows = {}\n    Offline._windows.windowsAreDead = windowsAreDead = new Fanout()\n\n\n    now = -> +(new Date())\n\n\n## Running in a shared web worker\n\n    if Agent?\n\nTODO once we get going we don't need to report that no windows are\ndead (we could call `windowsAreDead` only when the `windowIds` array\nwasn't empty). But do we need to the first time in order to know that\nit's safe to clear out old subscriptions?  For now always call\n`windowsAreDead`, even with an empty array.\n\n      deadWindows = (windowIds) ->\n        Agent.windowIsDead(windowId) for windowId in windowIds\n        windowsAreDead(windowIds)\n        return\n\n\n      checking = false\n      lastPing = null\n      testingWindows = {}\n\n\n      Agent.addMessageHandler 'goodbye', (port, data) ->\n        deadWindows([data.windowId])\n        return\n\n\n      Agent.addMessageHandler 'pong', (port, data) ->\n        delete testingWindows?[data.windowId]\n        return\n\n\n      checkPongs = ->\n        deadWindows(_.keys(testingWindows))\n        checking = false\n        testingWindows = null\n\n\n      check = ->\n        withContext \"window check\", ->\n          return if checking or lastPing? and now() - lastPing < 9000\n          checking = true\n\n          db.transaction((tx) ->\n            db.readAllWindowIds(tx)\n          )\n          .then((windowIds) ->\n            testingWindows = {}\n            testingWindows[windowId] = true for windowId in Agent.windowIds\n            testingWindows[windowId] = true for windowId in windowIds\n            lastPing = now()\n            for port in Agent.ports\n              port.postMessage({msg: 'ping'})\n            Meteor.setTimeout checkPongs, 4000\n            return\n          )\n          return\n\n\n      Meteor.startup ->\n        check()\n        Meteor.setInterval check, 10000\n\n\n## Running in a browser window\n\n    else\n\n      Offline._windows.thisWindowId = thisWindowId = Random.id()\n\n      Offline._windows.nowAgent = nowAgent = new Fanout()\n      # nowAgent.listen -> Meteor._debug \"now the agent\"\n\n\n      testingWindows = null\n      lastPing = null\n      checking = false\n\n\n      deadWindows = (deadWindowIds) ->\n        withContext \"deadWindows\", ->\n          db.transaction((tx) ->\n            db.readAgentWindow(tx)\n            .then((agentWindowId) ->\n              if not agentWindowId? or _.contains(deadWindowIds, agentWindowId)\n                becomeTheAgentWindow(tx)\n              else\n                Result.completed()\n            )\n          )\n          .then(->\n            windowsAreDead(deadWindowIds)\n          )\n\n\n      currentlyTheAgent = false\n\n      Offline._windows.currentlyTheAgent = -> currentlyTheAgent\n\n\n      becomeTheAgentWindow = (tx) ->\n        withContext \"becomeTheAgentWindow\", ->\n          currentlyTheAgent = true\n          defer -> nowAgent()\n          db.writeAgentWindow(tx, thisWindowId)\n\n\nOn startup, if there isn't an agentWindow in the database or if the\nagent window is marked as closed in local storage, we can become the\nagent window right away.\n\n      startupCheck = ->\n        withContext \"startupCheck\", ->\n          db.transaction((tx) ->\n            db.readAgentWindow(tx)\n            .then((agentWindowId) ->\n              if not agentWindowId?\n                becomeTheAgentWindow(tx)\n              else\n                closedAgentWindow = localStorage.getItem(\n                  '\/awwx\/offline-data\/agentWindowClosed'\n                )\n                if closedAgentWindow is agentWindowId\n                  becomeTheAgentWindow(tx)\n            )\n            .then(->\n              localStorage.removeItem(\n                '\/awwx\/offline-data\/agentWindowClosed'\n              )\n              return\n            )\n          )\n\n\n      check = ->\n        withContext \"window check\", ->\n          return if checking\n          checking = true\n          db.transaction((tx) ->\n            db.readAllWindowIds(tx)\n          )\n          .then((windowIds) ->\n            if lastPing? and now() - lastPing < 9000\n              return\n\n            testingWindows = {}\n            for windowId in windowIds\n              unless windowId is thisWindowId\n                testingWindows[windowId] = true\n            broadcast 'ping'\n            Result.delay(4000).then(-> windowIds)\n          )\n          .then((windowIds) ->\n            deadWindows(_.keys(testingWindows))\n          )\n          .then(->\n            checking = false\n          )\n\n\n      Meteor.startup ->\n        withContext \"windows startup\", ->\n\n          return if Offline._disableStartupForTesting\n\n          if Offline._usingSharedWebWorker\n\n            db.transaction((tx) ->\n              db.ensureWindow(tx, thisWindowId)\n            )\n\n          else\n\n            broadcast.listen 'ping', ->\n              withContext \"listen ping\", ->\n                broadcast 'pong', thisWindowId\n                return\n\n            broadcast.listen 'pong', (windowId) ->\n              withContext \"listen pong\", ->\n                if testingWindows?\n                  delete testingWindows[windowId]\n                return\n\n            broadcast.listen 'goodbye', (windowId) ->\n              deadWindows([windowId])\n\n            db.transaction((tx) ->\n              db.ensureWindow(tx, thisWindowId)\n            )\n            .then(->\n              startupCheck()\n            )\n            .then(->\n              check()\n              Meteor.setInterval check, 10000\n            )\n            return\n\n\nWhen a window is closing and gets an unload event, it doesn't survive\nlong enough to write anything to the database (it gets no more ticks\nof the event loop).  But we are able to write to local storage.\n\n      unload = ->\n        withContext \"unload\", ->\n          if Offline._usingSharedWebWorker\n            Offline._sharedWebWorker.post {\n              msg: 'goodbye',\n              windowId: thisWindowId\n            }\n          else\n            if currentlyTheAgent\n              localStorage.setItem(\n                '\/awwx\/offline-data\/agentWindowClosed',\n                thisWindowId\n              )\n            broadcast 'goodbye', thisWindowId\n          return\n\n\n      if window.addEventListener?\n        window.addEventListener('unload', unload, false)\n","old_contents":"    @Offline or= {}\n    {Fanout, Result} = awwx\n    broadcast = Offline._broadcast\n    {defer} = awwx.Error\n    {withContext} = awwx.Context\n    db = Offline._database\n\n\n    Offline._windows = {}\n    Offline._windows.windowsAreDead = windowsAreDead = new Fanout()\n\n\n    now = -> +(new Date())\n\n\n## Running in a shared web worker\n\n    if Agent?\n\nTODO once we get going we don't need to report that no windows are\ndead (we could call `windowsAreDead` only when the `windowIds` array\nwasn't empty). But do we need to the first time in order to know that\nit's safe to clear out old subscriptions?  For now always call\n`windowsAreDead`, even with an empty array.\n\n      deadWindows = (windowIds) ->\n        Agent.windowIsDead(windowId) for windowId in windowIds\n        windowsAreDead(windowIds)\n        return\n\n\n      checking = false\n      lastPing = null\n      testingWindows = {}\n\n\n      Agent.addMessageHandler 'pong', (port, data) ->\n        delete testingWindows?[data.windowId]\n        return\n\n\n      checkPongs = ->\n        deadWindows(_.keys(testingWindows))\n        checking = false\n        testingWindows = null\n\n\n      check = ->\n        withContext \"window check\", ->\n          return if checking or lastPing? and now() - lastPing < 9000\n          checking = true\n\n          db.transaction((tx) ->\n            db.readAllWindowIds(tx)\n          )\n          .then((windowIds) ->\n            testingWindows = {}\n            testingWindows[windowId] = true for windowId in Agent.windowIds\n            testingWindows[windowId] = true for windowId in windowIds\n            lastPing = now()\n            for port in Agent.ports\n              port.postMessage({msg: 'ping'})\n            Meteor.setTimeout checkPongs, 4000\n            return\n          )\n          return\n\n\n      Meteor.startup ->\n        check()\n        Meteor.setInterval check, 10000\n\n\n## Running in a browser window\n\n    else\n\n      Offline._windows.thisWindowId = thisWindowId = Random.id()\n\n      Offline._windows.nowAgent = nowAgent = new Fanout()\n      Offline._windows.noLongerAgent = noLongerAgent = new Fanout()\n\n      # nowAgent.listen -> Meteor._debug \"now the agent\"\n      # noLongerAgent.listen -> Meteor._debug \"no longer the agent\"\n\nTODO not used yet\n\n      unload = ->\n        withContext \"unload\", ->\n          broadcast 'goodbye', thisWindowId\n          return\n\n\nTODO old IE?  But will we even be loading this code in a browser that\ndoesn't have a supported database...?\n\n      window.addEventListener('unload', unload, false)\n\n\n      testingWindows = null\n      lastPing = null\n      checking = false\n\n\n      deadWindows = (deadWindowIds) ->\n        withContext \"deadWindows\", ->\n          db.transaction((tx) ->\n            db.readAgentWindow(tx)\n            .then((agentWindowId) ->\n              if not agentWindowId? or _.contains(deadWindowIds, agentWindowId)\n                becomeTheAgentWindow(tx)\n              else\n                Result.completed()\n            )\n          )\n          .then(->\n            windowsAreDead(deadWindowIds)\n          )\n\n\n      currentlyTheAgent = false\n\n      Offline._windows.currentlyTheAgent = -> currentlyTheAgent\n\n\n      becomeTheAgentWindow = (tx) ->\n        withContext \"becomeTheAgentWindow\", ->\n          currentlyTheAgent = true\n          defer -> nowAgent()\n          db.writeAgentWindow(tx, thisWindowId)\n          .then(->\n            broadcast 'newAgent', thisWindowId\n            return\n          )\n\n\n      notTheAgent = ->\n        withContext \"notTheAgent\", ->\n          return unless currentlyTheAgent\n          currentlyTheAgent = false\n          noLongerAgent()\n          return\n\n\nTODO if no one is the agent tab, we could become the agent\ntab immediately.\n\n      check = ->\n        withContext \"window check\", ->\n          return if checking\n          checking = true\n          db.transaction((tx) ->\n            db.readAllWindowIds(tx)\n          )\n          .then((windowIds) ->\n            if lastPing? and now() - lastPing < 9000\n              return\n\n            testingWindows = {}\n            for windowId in windowIds\n              unless windowId is thisWindowId\n                testingWindows[windowId] = true\n            broadcast 'ping'\n            Result.delay(4000).then(-> windowIds)\n          )\n          .then((windowIds) ->\n            deadWindows(_.keys(testingWindows))\n          )\n          .then(->\n            checking = false\n          )\n\n\n      Meteor.startup ->\n        withContext \"windows startup\", ->\n\n          return if Offline._disableStartupForTesting\n\n          if Offline._usingSharedWebWorker\n\n            db.transaction((tx) ->\n              db.ensureWindow(tx, thisWindowId)\n            )\n\n          else\n\n            broadcast.listen 'ping', ->\n              withContext \"listen ping\", ->\n                broadcast 'pong', thisWindowId\n                return\n\n            broadcast.listen 'pong', (windowId) ->\n              withContext \"listen pong\", ->\n                if testingWindows?\n                  delete testingWindows[windowId]\n                return\n\n            broadcast.listen 'newAgent', (windowId) ->\n              withContext \"listen newAgent\", ->\n                if windowId isnt thisWindowId\n                  notTheAgent()\n                return\n\n            db.transaction((tx) ->\n              db.ensureWindow(tx, thisWindowId)\n            )\n            .then(->\n              check()\n              Meteor.setInterval check, 10000\n            )\n            return\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b5c281db3bbb18457d3b2708e521324231387b72","subject":"Fixed evaulate value functionality","message":"Fixed evaulate value functionality\n","repos":"lacona\/lacona,laconalabs\/elliptical","old_file":"src\/phrase.litcoffee","new_file":"src\/phrase.litcoffee","new_contents":"#Includes\n\n\t{EventEmitter} = require 'events'\n\trequire '.\/stringshims'\n\n#Phrase\n\n\tclass Phrase\n\t\tconstructor: (options, @scope, elementFactory) ->\n\t\t\t{@name, @sentence, @evaluate} = options\n\t\t\t@root = elementFactory.create(options.root)\n\n\t\tparse: (input, context, data, done) ->\n\t\t\t@root.parse input, context, (result) ->\n\t\t\t\tdelete result.result[id] for id of result.result when id.startsWith '@temp'\n\t\t\t\tdata(result)\n\t\t\t, done\n\n\t\tgetValue: (options, result) ->\n\t\t\tif @evaluate?\n\t\t\t\treturn @scope[@evaluate].call(options, result)\n\t\t\telse\n\t\t\t\treturn result['@value']\n\n\t\t\t\n\n\tmodule.exports = Phrase","old_contents":"#Includes\n\n\t{EventEmitter} = require 'events'\n\trequire '.\/stringshims'\n\n#Phrase\n\n\tclass Phrase\n\t\tconstructor: (options, @scope, elementFactory) ->\n\t\t\t{@name, @sentence} = options\n\t\t\t@root = elementFactory.create(options.root)\n\n\t\tparse: (input, context, data, done) ->\n\t\t\t@root.parse input, context, (result) ->\n\t\t\t\tdelete result.result[id] for id of result.result when id.startsWith '@temp'\n\t\t\t\tdata(result)\n\t\t\t, done\n\n\t\tgetValue: (options, result) ->\n\t\t\tif options.evaluate?\n\t\t\t\treturn @scope[options.evaluate].call(options, result)\n\t\t\telse\n\t\t\t\treturn result['@value']\n\n\t\t\t\n\n\tmodule.exports = Phrase","returncode":0,"stderr":"","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"5d2f2ee7f8798e6327a145812c629f230cdd72df","subject":"throw meaningful error during Model.access if model not found","message":"throw meaningful error during Model.access if model not found\n","repos":"corenova\/yang-js","old_file":"src\/model.litcoffee","new_file":"src\/model.litcoffee","new_contents":"# Model - instance of schema-driven data\n\nThe `Model` class aggregates [Property](.\/property.litcoffee)\nattachments to provide the *adaptive* and *event-driven* data\ninteractions.\n\nIt is typically not instantiated directly, but is generated as a\nresult of [Yang::eval](..\/yang.litcoffee#eval-data-opts) for a YANG\n`module` schema.\n\n```javascript\nvar schema = Yang.parse('module foo { container bar { leaf a { type uint8; } } }');\nvar model = schema.eval({ 'foo:bar': { a: 7 } });\n\/\/ model is { 'foo:bar': [Getter\/Setter] }\n```\n\nThe generated `Model` is a hierarchical composition of\n[Property](.\/property.litcoffee) instances. The instance itself uses\n`Object.preventExtensions` to ensure no additional properties that are\nnot known to itself can be added.\n\nIt is designed to provide *stand-alone* interactions on a per-module\nbasis. For flexible management of multiple modules (such as hotplug\nmodules) and data persistence, please take a look at the\n[yang-store](http:\/\/github.com\/corenova\/yang-store) project.\n\nBelow are list of properties available to every instance of `Model`\n(it also inherits properties from [Property](.\/property.litcoffee)):\n\nproperty | type | mapping | description\n--- | --- | --- | ---\ntransactable | boolean | computed | getter\/setter for `state.transactable`\nengine | Emitter | access(state) | holds runtime features\n\n## Dependencies\n \n    debug    = require('debug')('yang:model')\n    delegate = require 'delegates'\n    clone    = require 'clone'\n    Stack    = require 'stacktrace-parser'\n    Emitter  = require('events').EventEmitter\n    Property = require '.\/property'\n\n## Class Model\n\n    class Model extends Property\n      \n      @Store   = {}\n      @Property = Property\n      \n      constructor: ->\n        unless this instanceof Model then return new Model arguments...\n        super\n        \n        @state.transactable = false\n        @state.maxTransactions = 100\n        @state.queue = []\n        @state.engine = new Emitter # <-- should eventually be a singleton instance\n        @state.engine.__ = this\n        Object.setPrototypeOf @state, Emitter.prototype\n            \n        #@on 'update', -> @save() unless @transactable\n        \n        # register this instance in the Model class singleton instance\n        @join Model.Store, replace: true\n\n      delegate @prototype, 'state'\n        .method 'emit'\n        .method 'once'\n        .access 'engine'\n\n### Computed Properties\n\n      enqueue = (prop) ->\n        if @queue.length > @maxTransactions\n          throw @error \"exceeded max transaction queue of #{@maxTransactions}, forgot to save()?\"\n        @queue.push { target: prop, value: prop.state.prev }\n\n      @property 'transactable',\n        enumerable: true\n        get: -> @state.transactable\n        set: (toggle) ->\n          return if toggle is @state.transactable\n          if toggle is true\n            @state.on 'update', enqueue\n          else\n            @state.removeListener 'update', enqueue\n            @state.queue.splice(0, @state.queue.length)\n          @state.transactable = toggle\n\n### access (model)\n\nThis is a unique capability for a Model to be able to access any\nother arbitrary model present inside the Model.Store.\n\n      access: (model) ->\n        try Model.Store[model].__\n        catch e then throw @error \"unable to locate '#{model}' instance in the Store\"\n\n### enable (feature)\n\nThis routine will enable a given `feature` \n\n      enable: (feature, controller) ->\n        @engine[feature] = controller if controller?\n        unless @engine.hasOwnProperty feature\n          throw @error \"unable to enable unknown feature '#{feature}'\"\n        @engine.emit \"enable:#{feature}\", @engine[feature]\n        return this\n\n### save\n\nThis routine triggers a 'commit' event for listeners to handle any\npersistence operations. It also clears the `@state.queue` transaction\nqueue so that future [rollback](#rollback) will reset back to this\nstate.\n\n      save: ->\n        @emit 'commit', @state.queue.slice();\n        @state.queue.splice(0, @state.queue.length)\n\n### rollback\n\nThis routine will replay tracked `@state.queue` in reverse chronological\norder (most recent -> oldest) when `@transactable` is set to\n`true`. It will restore the Property instance back to the last known\n[save](#save-opts) state.\n\n      rollback: ->\n        while change = @state.queue.pop()\n          change.target.set change.value, suppress: true\n        this\n\n### on (event)\n\nThe `Model` instance registers `@state` as an `EventEmitter` and you\ncan attach various event listeners to handle events generated by the\n`Model`:\n\nevent | arguments | description\n--- | --- | ---\nupdate | (prop, prev) | fired when an update takes place within the data tree\nchange | (elems...) | fired when the schema is modified\ncreate | (items...) | fired when one or more `list` element is added\ndelete | (items...) | fired when one or more `list` element is deleted\n\nIt also accepts optional XPATH\/YPATH expressions which will *filter*\nfor granular event subscription to specified events from only the\nelements of interest.\n\nThe event listeners to the `Model` can handle any customized behavior\nsuch as saving to database, updating read-only state, scheduling\nbackground tasks, etc.\n\nThis operation is protected from recursion, where operations by the\n`callback` may result in the same `callback` being executed multiple\ntimes due to subsequent events triggered due to changes to the\n`Model`. Currently, it will allow the same `callback` to be executed\nat most two times within the same execution stack.\n\n      on: (event, filters..., callback) ->\n        unless callback instanceof Function\n          throw new Error \"must supply callback function to listen for events\"\n          \n        recursive = (name) ->\n          seen = {}\n          frames = Stack.parse(new Error().stack)\n          for frame, i in frames when ~frame.methodName.indexOf(name)\n            { file, lineNumber, column } = frames[i-1]\n            callee = \"#{file}:#{lineNumber}:#{column}\"\n            seen[callee] ?= 0\n            if ++seen[callee] > 1\n              console.warn \"detected recursion for '#{callee}'\"\n              return true \n          return false\n\n        ctx = @context\n        $$$ = (prop, args...) ->\n          debug \"$$$: check if '#{prop.path}' in '#{filters}'\"\n          if not filters.length or prop.path.contains filters...\n            unless recursive('$$$')\n              callback.apply ctx, [prop].concat args\n\n        @state.on event, $$$\n\nPlease refer to [Model Events](..\/TUTORIAL.md#model-events) section of\nthe [Getting Started Guide](..\/TUTORIAL.md) for usage examples.\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n## Prototype Overrides\n\n### toJSON\n\nCalls `Property.toJSON` with `tag = false`.\n\n      toJSON: -> super false\n\n### set\n\nCalls `Property.set` with a *clone* of the data being passed\nin. Should look for a way to eliminate this override.\n\n      set: (value, opts) -> super clone(value), opts\n\n### find (pattern)\n\nThis routine enables *cross-model* property search when the `Model` is\njoined to another object (such as a datastore). The schema-bound model\nrestricts *cross-model* property access to only those modules that are\n`import` dependencies of the current model instance.\n\n      find: (pattern='.', opts={}) ->\n        return super unless @parent?\n        \n        debug \"[#{@name}] find #{pattern}\"\n        try match = super pattern, root: true\n        catch err then debug err\n        return match if match?.length or opts.root\n        \n        # here we have a @parent that likely has a collection of Models\n        debug \"[#{@name}] search parent with collection of Models\"\n        opts.root = true\n        for k, model of @parent.__props__ when k isnt @name\n          debug \"[#{@name}] searching into '#{k}'\"\n          try match = model.find pattern, opts\n          catch then continue\n          return match if match?.length\n        return []\n\n### invoke (path, input)\n\nExecutes a [Property](.\/property.litcoffee) holding a function found\nat the `path` using the `input` data.\n\n      invoke: (path, args...) ->\n        target = @in(path)\n        unless target?\n          throw @error \"cannot invoke on '#{path}', not found\"\n        target.invoke args...\n            \n## Export Model Class\n\n    module.exports = Model\n","old_contents":"# Model - instance of schema-driven data\n\nThe `Model` class aggregates [Property](.\/property.litcoffee)\nattachments to provide the *adaptive* and *event-driven* data\ninteractions.\n\nIt is typically not instantiated directly, but is generated as a\nresult of [Yang::eval](..\/yang.litcoffee#eval-data-opts) for a YANG\n`module` schema.\n\n```javascript\nvar schema = Yang.parse('module foo { container bar { leaf a { type uint8; } } }');\nvar model = schema.eval({ 'foo:bar': { a: 7 } });\n\/\/ model is { 'foo:bar': [Getter\/Setter] }\n```\n\nThe generated `Model` is a hierarchical composition of\n[Property](.\/property.litcoffee) instances. The instance itself uses\n`Object.preventExtensions` to ensure no additional properties that are\nnot known to itself can be added.\n\nIt is designed to provide *stand-alone* interactions on a per-module\nbasis. For flexible management of multiple modules (such as hotplug\nmodules) and data persistence, please take a look at the\n[yang-store](http:\/\/github.com\/corenova\/yang-store) project.\n\nBelow are list of properties available to every instance of `Model`\n(it also inherits properties from [Property](.\/property.litcoffee)):\n\nproperty | type | mapping | description\n--- | --- | --- | ---\ntransactable | boolean | computed | getter\/setter for `state.transactable`\nengine | Emitter | access(state) | holds runtime features\n\n## Dependencies\n \n    debug    = require('debug')('yang:model')\n    delegate = require 'delegates'\n    clone    = require 'clone'\n    Stack    = require 'stacktrace-parser'\n    Emitter  = require('events').EventEmitter\n    Property = require '.\/property'\n\n## Class Model\n\n    class Model extends Property\n      \n      @Store   = {}\n      @Property = Property\n      \n      constructor: ->\n        unless this instanceof Model then return new Model arguments...\n        super\n        \n        @state.transactable = false\n        @state.maxTransactions = 100\n        @state.queue = []\n        @state.engine = new Emitter # <-- should eventually be a singleton instance\n        @state.engine.__ = this\n        Object.setPrototypeOf @state, Emitter.prototype\n            \n        #@on 'update', -> @save() unless @transactable\n        \n        # register this instance in the Model class singleton instance\n        @join Model.Store, replace: true\n\n      delegate @prototype, 'state'\n        .method 'emit'\n        .method 'once'\n        .access 'engine'\n\n### Computed Properties\n\n      enqueue = (prop) ->\n        if @queue.length > @maxTransactions\n          throw @error \"exceeded max transaction queue of #{@maxTransactions}, forgot to save()?\"\n        @queue.push { target: prop, value: prop.state.prev }\n\n      @property 'transactable',\n        enumerable: true\n        get: -> @state.transactable\n        set: (toggle) ->\n          return if toggle is @state.transactable\n          if toggle is true\n            @state.on 'update', enqueue\n          else\n            @state.removeListener 'update', enqueue\n            @state.queue.splice(0, @state.queue.length)\n          @state.transactable = toggle\n\n### access (model)\n\nThis is a unique capability for a Model to be able to access any\nother arbitrary model present inside the Model.Store.\n\n      access: (model) -> Model.Store[model]?.__\n\n### enable (feature)\n\nThis routine will enable a given `feature` \n\n      enable: (feature, controller) ->\n        @engine[feature] = controller if controller?\n        unless @engine.hasOwnProperty feature\n          throw @error \"unable to enable unknown feature '#{feature}'\"\n        @engine.emit \"enable:#{feature}\", @engine[feature]\n        return this\n\n### save\n\nThis routine triggers a 'commit' event for listeners to handle any\npersistence operations. It also clears the `@state.queue` transaction\nqueue so that future [rollback](#rollback) will reset back to this\nstate.\n\n      save: ->\n        @emit 'commit', @state.queue.slice();\n        @state.queue.splice(0, @state.queue.length)\n\n### rollback\n\nThis routine will replay tracked `@state.queue` in reverse chronological\norder (most recent -> oldest) when `@transactable` is set to\n`true`. It will restore the Property instance back to the last known\n[save](#save-opts) state.\n\n      rollback: ->\n        while change = @state.queue.pop()\n          change.target.set change.value, suppress: true\n        this\n\n### on (event)\n\nThe `Model` instance registers `@state` as an `EventEmitter` and you\ncan attach various event listeners to handle events generated by the\n`Model`:\n\nevent | arguments | description\n--- | --- | ---\nupdate | (prop, prev) | fired when an update takes place within the data tree\nchange | (elems...) | fired when the schema is modified\ncreate | (items...) | fired when one or more `list` element is added\ndelete | (items...) | fired when one or more `list` element is deleted\n\nIt also accepts optional XPATH\/YPATH expressions which will *filter*\nfor granular event subscription to specified events from only the\nelements of interest.\n\nThe event listeners to the `Model` can handle any customized behavior\nsuch as saving to database, updating read-only state, scheduling\nbackground tasks, etc.\n\nThis operation is protected from recursion, where operations by the\n`callback` may result in the same `callback` being executed multiple\ntimes due to subsequent events triggered due to changes to the\n`Model`. Currently, it will allow the same `callback` to be executed\nat most two times within the same execution stack.\n\n      on: (event, filters..., callback) ->\n        unless callback instanceof Function\n          throw new Error \"must supply callback function to listen for events\"\n          \n        recursive = (name) ->\n          seen = {}\n          frames = Stack.parse(new Error().stack)\n          for frame, i in frames when ~frame.methodName.indexOf(name)\n            { file, lineNumber, column } = frames[i-1]\n            callee = \"#{file}:#{lineNumber}:#{column}\"\n            seen[callee] ?= 0\n            if ++seen[callee] > 1\n              console.warn \"detected recursion for '#{callee}'\"\n              return true \n          return false\n\n        ctx = @context\n        $$$ = (prop, args...) ->\n          debug \"$$$: check if '#{prop.path}' in '#{filters}'\"\n          if not filters.length or prop.path.contains filters...\n            unless recursive('$$$')\n              callback.apply ctx, [prop].concat args\n\n        @state.on event, $$$\n\nPlease refer to [Model Events](..\/TUTORIAL.md#model-events) section of\nthe [Getting Started Guide](..\/TUTORIAL.md) for usage examples.\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n## Prototype Overrides\n\n### toJSON\n\nCalls `Property.toJSON` with `tag = false`.\n\n      toJSON: -> super false\n\n### set\n\nCalls `Property.set` with a *clone* of the data being passed\nin. Should look for a way to eliminate this override.\n\n      set: (value, opts) -> super clone(value), opts\n\n### find (pattern)\n\nThis routine enables *cross-model* property search when the `Model` is\njoined to another object (such as a datastore). The schema-bound model\nrestricts *cross-model* property access to only those modules that are\n`import` dependencies of the current model instance.\n\n      find: (pattern='.', opts={}) ->\n        return super unless @parent?\n        \n        debug \"[#{@name}] find #{pattern}\"\n        try match = super pattern, root: true\n        catch err then debug err\n        return match if match?.length or opts.root\n        \n        # here we have a @parent that likely has a collection of Models\n        debug \"[#{@name}] search parent with collection of Models\"\n        opts.root = true\n        for k, model of @parent.__props__ when k isnt @name\n          debug \"[#{@name}] searching into '#{k}'\"\n          try match = model.find pattern, opts\n          catch then continue\n          return match if match?.length\n        return []\n\n### invoke (path, input)\n\nExecutes a [Property](.\/property.litcoffee) holding a function found\nat the `path` using the `input` data.\n\n      invoke: (path, args...) ->\n        target = @in(path)\n        unless target?\n          throw @error \"cannot invoke on '#{path}', not found\"\n        target.invoke args...\n            \n## Export Model Class\n\n    module.exports = Model\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"7fd58e7a020e9f5bc7033e2ddc437ce6c5f0cb43","subject":"added parameter to broadcast annotation","message":"added parameter to broadcast annotation\n","repos":"nhz-io\/cnl","old_file":"source\/lib\/evented.litcoffee","new_file":"source\/lib\/evented.litcoffee","new_contents":"# CLASS: Evented\n* Extends: [Node][Node]\n\nEvent delivery Subsystem.\n\n    Event = require '.\/event'\n    module.exports = class Evented extends require '.\/node'\n\n---\n\n## CONSTRUCTOR\n\n### new Evented(args)\n\nCreates **Evented** instance. Initializes **#listeners** and **#events**\n\n      constructor: (args) ->\n        super\n        (@events ||= {}) and @events[key] = value for key, value of args?.events\n        @listeners = [{}, {}]\n\n#### PARAMETERS\n\n**args**\n* Type: [Object][Object] - optional constructor argument.\n\n**args.events**\n* Type: [Object][Object] - enabled events. (event-name: true\/false)\n\n---\n\n## METHODS\n\n### #addListener(args)\n### #addListener(type, listener, capture)\n* Returns: [Evented][Evented]\n\nAdd a listener (per capturing\/non-capturing group) for the event type.\nWill not add duplicates. Will not add listeners if event is not enabled.\n\n      addListener: (type, listener, capture = false) ->\n        if type instanceof Object then {type, listener, capture} = type\n        if @events[type] and typeof listener is 'function'\n          listeners = (@listeners[if capture is true then 1 else 0][type] ||= [])\n          listeners.push listener if -1 is listeners.indexOf listener\n        return this\n\n#### PARAMETERS\n**args**\n* Type: [Object][Object] - type, listener and capture parameters\n\nOnly if the first argument to addListener is an [Object][Object]\n\n**type**\n* Type: [String][String] - event type\n\n**listener**\n* Type: [Function][Function] - event listener\n\n**capture**\n* Type: [Boolean][Boolean] - capturing\/non-capturing flag\n* Default: `false`\n\n---\n\n### #removeListener(args)\n### #removeListener(type, listener, capture)\n* Returns: [Evented][Evented]\n\nRemove the listener (per capturing\/non-capturing group) for the event type.\n\n      removeListener: (type, listener, capture = false) ->\n        if type instanceof Object then {type, listener, capture} = type\n        if type and typeof listener is 'function'\n          if listeners = @listeners[if capture is true then 1 else 0][type]\n            listeners.splice idx, 1 if -1 isnt idx = listeners.indexOf listener\n        return this\n\n#### PARAMETERS\n**args**\n* Type: [Object][Object] - type, listener and capture parameters\n\nOnly if the first argument to removeListener is an [Object][Object]\n\n**type**\n* Type: [String][String] - event type\n\n**listener**\n* Type: [Function][Function] - event listener\n\n**capture**\n* Type: [Boolean][Boolean] - capturing\/non-capturing flag\n* Default: `false`\n\n---\n\n### #dispatchEvent(event)\n* Returns: [Evented][Evented]\n\nEvent dispatcher. Dispatches the event to appropriate listener\n\n      dispatchEvent: (event) ->\n        if (type = event?.type) and @event[type] and not event.aborted\n          phase = event.phase\n          if phase > 0 and phase < 3 and listeners = @listeners[2-phase][type]\n            event.start()\n            for listener in listeners\n              break if event.stopped or event.aborted\n              listener.call this, event\n        return this\n\n#### PARAMETERS\n\n**event**\n* Type: [Event][Event] - event to dispatch\n\n---\n\n### #broadcastEvent(event)\n* Returns: [Evented][Evented]\n\nProcess the event, dispatch it to listeners and broadcast to children.\n\n      broadcastEvent: (event) ->\n\nNo action will be taken if event has no type. This method\nwill initialize fresh events. \nOnly broadcast events that have a type. Event source will be\nset to this instance if event has no source. Event target\ncan be changed by providing it as second argument to broadcast.\n\n        if type = event?.type\n          unless event.aborted or event.done or event.phase is 3\n            event.start()\n            event.source ||= this\n            phase = (event.phase ||= 1)\n\nIf event target is this instance, it means event has reached it's\ndestination. Event phase is set to 2 (AT_TARGET)\n\n            if event.target is this then event.phase = 2\n\nIf event phase is 1 (CAPTURING), the event will be dispatched to\nthis instance. After that, the event will be dispatched to every\nwhile the phase remains CAPTURING and event was not aborted.\n\n            if event.phase is 1\n              @dispatchEvent event\n\n              if @children then for child in @children\n                if event.phase is 1 and not event.aborted\n                  child.broadcastEvent event\n                else break\n\nAfter dispatching was finished, it may be possible that the event\ntarget was changed. If the event target is this instance, the\nevent phase will be set to AT_TARGET and the event will be dispatched\nagain.\n\n            if event.target is this then event.phase = 2\n\n            if event.phase is 2 then @dispatchEvent event\n\nAt this point the event has finished it's lifecycle. If event.source\nis this instance, so the event callback will be called if the\nevent was not aborted or finished or canceled.\n\n            if event.source is this\n              unless event.canceled or event.aborted or event.done or event.phase is 3\n                event.callback?.call? this, event\n              event.phase = 3\n              event.finish()\n        return this\n\n#### PARAMETERS\n\n**event**\n* Type: [Event][Event] - event to broadcast\n\n[Node]: .\/node.litcoffee\n[Event]: .\/event.litcoffee\n[Evented]: .\/evented.litcoffee\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[String]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/String\n[Function]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Function\n[Boolean]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Boolean\n","old_contents":"# CLASS: Evented\n* Extends: [Node][Node]\n\nEvent delivery Subsystem.\n\n    Event = require '.\/event'\n    module.exports = class Evented extends require '.\/node'\n\n---\n\n## CONSTRUCTOR\n\n### new Evented(args)\n\nCreates **Evented** instance. Initializes **#listeners** and **#events**\n\n      constructor: (args) ->\n        super\n        (@events ||= {}) and @events[key] = value for key, value of args?.events\n        @listeners = [{}, {}]\n\n#### PARAMETERS\n\n**args**\n* Type: [Object][Object] - optional constructor argument.\n\n**args.events**\n* Type: [Object][Object] - enabled events. (event-name: true\/false)\n\n---\n\n## METHODS\n\n### #addListener(args)\n### #addListener(type, listener, capture)\n* Returns: [Evented][Evented]\n\nAdd a listener (per capturing\/non-capturing group) for the event type.\nWill not add duplicates. Will not add listeners if event is not enabled.\n\n      addListener: (type, listener, capture = false) ->\n        if type instanceof Object then {type, listener, capture} = type\n        if @events[type] and typeof listener is 'function'\n          listeners = (@listeners[if capture is true then 1 else 0][type] ||= [])\n          listeners.push listener if -1 is listeners.indexOf listener\n        return this\n\n#### PARAMETERS\n**args**\n* Type: [Object][Object] - type, listener and capture parameters\n\nOnly if the first argument to addListener is an [Object][Object]\n\n**type**\n* Type: [String][String] - event type\n\n**listener**\n* Type: [Function][Function] - event listener\n\n**capture**\n* Type: [Boolean][Boolean] - capturing\/non-capturing flag\n* Default: `false`\n\n---\n\n### #removeListener(args)\n### #removeListener(type, listener, capture)\n* Returns: [Evented][Evented]\n\nRemove the listener (per capturing\/non-capturing group) for the event type.\n\n      removeListener: (type, listener, capture = false) ->\n        if type instanceof Object then {type, listener, capture} = type\n        if type and typeof listener is 'function'\n          if listeners = @listeners[if capture is true then 1 else 0][type]\n            listeners.splice idx, 1 if -1 isnt idx = listeners.indexOf listener\n        return this\n\n#### PARAMETERS\n**args**\n* Type: [Object][Object] - type, listener and capture parameters\n\nOnly if the first argument to removeListener is an [Object][Object]\n\n**type**\n* Type: [String][String] - event type\n\n**listener**\n* Type: [Function][Function] - event listener\n\n**capture**\n* Type: [Boolean][Boolean] - capturing\/non-capturing flag\n* Default: `false`\n\n---\n\n### #dispatchEvent(event)\n* Returns: [Evented][Evented]\n\nEvent dispatcher. Dispatches the event to appropriate listener\n\n      dispatchEvent: (event) ->\n        if (type = event?.type) and @event[type] and not event.aborted\n          phase = event.phase\n          if phase > 0 and phase < 3 and listeners = @listeners[2-phase][type]\n            event.start()\n            for listener in listeners\n              break if event.stopped or event.aborted\n              listener.call this, event\n        return this\n\n#### PARAMETERS\n\n**event**\n* Type: [Event][Event] - event to dispatch\n\n---\n\n### #broadcastEvent(event)\n* Returns: [Evented][Evented]\n\n      broadcastEvent: (event) ->\n\nNo action will be taken if event has no type. This method\nwill initialize fresh events. \nOnly broadcast events that have a type. Event source will be\nset to this instance if event has no source. Event target\ncan be changed by providing it as second argument to broadcast.\n\n        if type = event?.type\n          unless event.aborted or event.done or event.phase is 3\n            event.start()\n            event.source ||= this\n            phase = (event.phase ||= 1)\n\nIf event target is this instance, it means event has reached it's\ndestination. Event phase is set to 2 (AT_TARGET)\n\n            if event.target is this then event.phase = 2\n\nIf event phase is 1 (CAPTURING), the event will be dispatched to\nthis instance. After that, the event will be dispatched to every\nwhile the phase remains CAPTURING and event was not aborted.\n\n            if event.phase is 1\n              @dispatchEvent event\n\n              if @children then for child in @children\n                if event.phase is 1 and not event.aborted\n                  child.broadcastEvent event\n                else break\n\nAfter dispatching was finished, it may be possible that the event\ntarget was changed. If the event target is this instance, the\nevent phase will be set to AT_TARGET and the event will be dispatched\nagain.\n\n            if event.target is this then event.phase = 2\n\n            if event.phase is 2 then @dispatchEvent event\n\nAt this point the event has finished it's lifecycle if event.source\nis this instance, so the event callback will be called if the\nevent was not aborted or finished or canceled.\n\n            if event.source is this\n              unless event.canceled or event.aborted or event.done or event.phase is 3\n                event.callback?.call? this, event\n              event.phase = 3\n              event.finish()\n        return this\n\n#### PARAMETERS\n\n[Node]: .\/node.litcoffee\n[Event]: .\/event.litcoffee\n[Evented]: .\/evented.litcoffee\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[String]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/String\n[Function]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Function\n[Boolean]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Boolean\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6af5e735ac10ac1a81c41224304f85c14a8bd292","subject":"fixed date removal","message":"fixed date removal\n","repos":"laconalabs\/elliptical,lacona\/lacona","old_file":"src\/lacona.litcoffee","new_file":"src\/lacona.litcoffee","new_contents":"#Includes\n\n\t_ = require 'lodash'\n\tasync = require 'async'\n\t{EventEmitter} = require 'events'\n\tutil = require 'util'\n\n\tElementFactory = require '.\/element-factory'\n\tPhrase = require '.\/phrase'\n\tInputOption = require '.\/input-option'\n\n#Lacona\n\n\tclass Parser extends EventEmitter\n\t\tconstructor: (options) ->\n\n\t\t\t@optionsForInput = _.pick(options, 'fuzzy')\n\t\t\t@options = _.omit(options, 'fuzzy')\n\n\t\t\t@phrases = []\n\n\t\t\t@middleware = []\n\n\t\t\t@understand require('.\/plugins\/literal')\n\t\t\t@understand require('.\/plugins\/freetext')\n\t\t\t@understand require('.\/plugins\/integer')\n\t\t\t@understand require('.\/plugins\/validator')\n\t\t\t@understand require('.\/plugins\/suggester')\n\t\t\t@understand require('.\/plugins\/list')\n\n\t\t\t@currentParseNumber = 0\n\n\t\t_phraseAccessor: (name) =>\n\t\t\t_.filter @phrases, (phrase) ->\n\t\t\t\tphrase.name is name or name in phrase.extends\n\n###`understand`\n\n`understand` takes a schema and scope, and defines a set of words for Lacona to understand\n\n\t\tunderstand: (options) ->\n\t\t\tscope = options.scope\n\t\t\tschema = options.schema ? options\n\t\t\tif not util.isArray(schema)\n\t\t\t\tschema = [schema]\n\t\t\tfor phrase in schema\n\t\t\t\telementFactory = new ElementFactory(scope, @)\n\t\t\t\t@phrases.push new Phrase(phrase, scope, elementFactory)\n\t\t\treturn @\n\n###`use`\n\n`use` defines middleware. It must be passed a function that accepts 2 arguments, an inputOption,\nand a callback that should be passed an error (or null) and a modulated inputOption. This will be passed\nto the `data` event (or the next middleware) rather than the inputOption itself.\n\n\t\tuse: (next) ->\n\t\t\t@middleware.push next\n\t\t\treturn @\n\n###`parse`\n\n\t\tparse: (inputText, lang) ->\n\t\t\tlang = lang ? window?.navigator?.language?.replace?('-', '_') ? process?.env?.LANG?.split?('.')?[0] ? 'default' #ALL THE QUESTION MARKS\n\t\t\t@currentParseNumber++\n\t\t\tthisParseNumber = @currentParseNumber\n\n\t\t\tphraseIsSentence = (item) ->\n\t\t\t\titem.run?\n\n\t\t\tgotData = (phrase, done) =>\n\t\t\t\tinput = new InputOption(@optionsForInput, phrase, inputText)\n\t\t\t\tphrase.parse input, lang, null, (option) =>\n\t\t\t\t\tif option.text is '' and thisParseNumber is @currentParseNumber\n\t\t\t\t\t\tasync.eachSeries @middleware, (call, done) =>\n\t\t\t\t\t\t\tcall option, done\n\t\t\t\t\t\t, (err) =>\n\t\t\t\t\t\t\treturn done(err) if err?\n\t\t\t\t\t\t\t@emit 'data', option\n\t\t\t\t, done\n\n\t\t\tallPhrasesDone = (err) =>\n\t\t\t\tif err?\n\t\t\t\t\t@emit 'error', err\n\t\t\t\telse if thisParseNumber is @currentParseNumber\n\t\t\t\t\t@emit 'end'\n\n\t\t\tasync.each _.filter(@phrases, phraseIsSentence), gotData, allPhrasesDone\n\n\t\t\treturn @\n\n\trun = (inputOption, done) ->\n\t\tinputOption.sentence.scope[inputOption.sentence.run](inputOption.result, done)\n\n\tnextText = (inputOption, done) ->\n\t\tmatch = _.reduce inputOption.match, (string, match) ->\n\t\t\treturn string + match.string\n\t\t, ''\n\n\t\tmatchAndSuggestion = _.reduce inputOption.suggestion.words, (string, suggestion) ->\n\t\t\treturn string + suggestion.string\n\t\t, match\n\n\t\tdone(null, matchAndSuggestion)\n\n\n\n\tmodule.exports =\n\t\tParser: Parser\n\t\trun: run\n\t\tnextText: nextText\n","old_contents":"#Includes\n\n\t_ = require 'lodash'\n\tasync = require 'async'\n\t{EventEmitter} = require 'events'\n\tutil = require 'util'\n\n\tElementFactory = require '.\/element-factory'\n\tPhrase = require '.\/phrase'\n\tInputOption = require '.\/input-option'\n\n#Lacona\n\n\tclass Parser extends EventEmitter\n\t\tconstructor: (options) ->\n\n\t\t\t@optionsForInput = _.pick(options, 'fuzzy')\n\t\t\t@options = _.omit(options, 'fuzzy')\n\n\t\t\t@phrases = []\n\n\t\t\t@middleware = []\n\n\t\t\t@understand require('.\/plugins\/literal')\n\t\t\t@understand require('.\/plugins\/freetext')\n\t\t\t@understand require('.\/plugins\/integer')\n\t\t\t@understand require('.\/plugins\/date')\n\t\t\t@understand require('.\/plugins\/validator')\n\t\t\t@understand require('.\/plugins\/suggester')\n\t\t\t@understand require('.\/plugins\/list')\n\n\t\t\t@currentParseNumber = 0\n\n\t\t_phraseAccessor: (name) =>\n\t\t\t_.filter @phrases, (phrase) ->\n\t\t\t\tphrase.name is name or name in phrase.extends\n\n###`understand`\n\n`understand` takes a schema and scope, and defines a set of words for Lacona to understand\n\n\t\tunderstand: (options) ->\n\t\t\tscope = options.scope\n\t\t\tschema = options.schema ? options\n\t\t\tif not util.isArray(schema)\n\t\t\t\tschema = [schema]\n\t\t\tfor phrase in schema\n\t\t\t\telementFactory = new ElementFactory(scope, @)\n\t\t\t\t@phrases.push new Phrase(phrase, scope, elementFactory)\n\t\t\treturn @\n\n###`use`\n\n`use` defines middleware. It must be passed a function that accepts 2 arguments, an inputOption,\nand a callback that should be passed an error (or null) and a modulated inputOption. This will be passed\nto the `data` event (or the next middleware) rather than the inputOption itself.\n\n\t\tuse: (next) ->\n\t\t\t@middleware.push next\n\t\t\treturn @\n\n###`parse`\n\n\t\tparse: (inputText, lang) ->\n\t\t\tlang = lang ? window?.navigator?.language?.replace?('-', '_') ? process?.env?.LANG?.split?('.')?[0] ? 'default' #ALL THE QUESTION MARKS\n\t\t\t@currentParseNumber++\n\t\t\tthisParseNumber = @currentParseNumber\n\n\t\t\tphraseIsSentence = (item) ->\n\t\t\t\titem.run?\n\n\t\t\tgotData = (phrase, done) =>\n\t\t\t\tinput = new InputOption(@optionsForInput, phrase, inputText)\n\t\t\t\tphrase.parse input, lang, null, (option) =>\n\t\t\t\t\tif option.text is '' and thisParseNumber is @currentParseNumber\n\t\t\t\t\t\tasync.eachSeries @middleware, (call, done) =>\n\t\t\t\t\t\t\tcall option, done\n\t\t\t\t\t\t, (err) =>\n\t\t\t\t\t\t\treturn done(err) if err?\n\t\t\t\t\t\t\t@emit 'data', option\n\t\t\t\t, done\n\n\t\t\tallPhrasesDone = (err) =>\n\t\t\t\tif err?\n\t\t\t\t\t@emit 'error', err\n\t\t\t\telse if thisParseNumber is @currentParseNumber\n\t\t\t\t\t@emit 'end'\n\n\t\t\tasync.each _.filter(@phrases, phraseIsSentence), gotData, allPhrasesDone\n\n\t\t\treturn @\n\n\trun = (inputOption, done) ->\n\t\tinputOption.sentence.scope[inputOption.sentence.run](inputOption.result, done)\n\n\tnextText = (inputOption, done) ->\n\t\tmatch = _.reduce inputOption.match, (string, match) ->\n\t\t\treturn string + match.string\n\t\t, ''\n\n\t\tmatchAndSuggestion = _.reduce inputOption.suggestion.words, (string, suggestion) ->\n\t\t\treturn string + suggestion.string\n\t\t, match\n\n\t\tdone(null, matchAndSuggestion)\n\n\n\n\tmodule.exports =\n\t\tParser: Parser\n\t\trun: run\n\t\tnextText: nextText\n","returncode":0,"stderr":"","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"3018f45cb55aba718d354b3ab897c056d60a2bad","subject":"docs(collection): explain `false` parameter on `cursor.cound()`","message":"docs(collection): explain `false` parameter on `cursor.cound()`\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    collections = require('.\/helper\/schema').types\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '@turbasen\/db-mongo'\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      blacklist:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.status(404).json message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.status(404).json message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.provider}]\n\n      next()\n\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = req.user.query qs.parse req.query\n\n### Fields\n\nAlways return `endret`, `lisens`, `navn`, `status`, `tilbyder`, and `tags` in\naddition to `\\_id` ObjectID which is always returned by MongoDB.\n\n      fields =\n        endret: true\n        lisens: true\n        navn: true\n        status: true\n        tags: true\n        tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ','\n          fields[field] = true\n\nIf any private fields are to be returned we need to limit the query to documents\nowner by the API user to prevent exposing private data publicly.\n\n          req.db.query.tilbyder = req.user.provider if field.substr(0,6) is 'privat'\n\n### Sort\n\nLimit sort to ascending or descending on `\\_id`, `endret`, and `navn` since they\nare indexed. Non-indexed fields will be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when '_id' then [['_id', 1]]\n          when '-_id' then [['_id', -1]]\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nMake new cursor object with the correct query, fields, and other options (limit,\nskip, and sort).\n\n      cursor = req.db.col.find req.db.query, fields,\n        limit: Math.min (parseInt(req.query.limit, 10) or 20), 50\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nCount number of matching documents in MongoDB database. Ignore limit and skip\nsettings by passing `false` as the first argument to `cursor.count()`.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min cursor.cmd.limit, Math.max total - cursor.cmd.skip, 0\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.sendStatus 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(422).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.provider\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.status(422).json\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.status(201).json\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    collections = require('.\/helper\/schema').types\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '@turbasen\/db-mongo'\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      blacklist:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.status(404).json message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.status(404).json message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.provider}]\n\n      next()\n\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = req.user.query qs.parse req.query\n\n### Fields\n\nAlways return `endret`, `lisens`, `navn`, `status`, `tilbyder`, and `tags` in\naddition to `\\_id` ObjectID which is always returned by MongoDB.\n\n      fields =\n        endret: true\n        lisens: true\n        navn: true\n        status: true\n        tags: true\n        tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ','\n          fields[field] = true\n\nIf any private fields are to be returned we need to limit the query to documents\nowner by the API user to prevent exposing private data publicly.\n\n          req.db.query.tilbyder = req.user.provider if field.substr(0,6) is 'privat'\n\n### Sort\n\nLimit sort to ascending or descending on `\\_id`, `endret`, and `navn` since they\nare indexed. Non-indexed fields will be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when '_id' then [['_id', 1]]\n          when '-_id' then [['_id', -1]]\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nMake new cursor object with the correct query, fields, and other options (limit,\nskip, and sort).\n\n      cursor = req.db.col.find req.db.query, fields,\n        limit: Math.min (parseInt(req.query.limit, 10) or 20), 50\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min cursor.cmd.limit, Math.max total - cursor.cmd.skip, 0\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.sendStatus 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(422).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.provider\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.status(422).json\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.status(201).json\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"31993e7f37780743db4f1f60a71623fdd27c8d84","subject":"fix(collection): blacklist `?expand` query keyword","message":"fix(collection): blacklist `?expand` query keyword\n\nThis is reserved for future use for expanding releated documents for\ncollections.\n\nClose: #97\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    collections = require('.\/helper\/schema').types\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '@turbasen\/db-mongo'\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n        order: 'sort'\n      blacklist:\n        api_key     : true # other use\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        expand      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.status(404).json message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.status(404).json message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.provider}]\n\n      next()\n\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = req.user.query qs.parse req.query\n\n### Fields\n\nAlways return `endret`, `lisens`, `navn`, `status`, `tilbyder`, and `tags` in\naddition to `\\_id` ObjectID which is always returned by MongoDB.\n\n      fields =\n        endret: true\n        lisens: true\n        navn: true\n        status: true\n        tags: true\n        tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ','\n          fields[field] = true\n\nIf any private fields are to be returned we need to limit the query to documents\nowner by the API user to prevent exposing private data publicly.\n\n          req.db.query.tilbyder = req.user.provider if field.substr(0,6) is 'privat'\n\n### Sort\n\nLimit sort to ascending or descending on `\\_id`, `endret`, and `navn` since they\nare indexed. Non-indexed fields will be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when '_id' then [['_id', 1]]\n          when '-_id' then [['_id', -1]]\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nMake new cursor object with the correct query, fields, and other options (limit,\nskip, and sort).\n\n      cursor = req.db.col.find req.db.query, fields,\n        limit: Math.min (parseInt(req.query.limit, 10) or 20), 50\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nCount number of matching documents in MongoDB database. Ignore limit and skip\nsettings by passing `false` as the first argument to `cursor.count()`.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min cursor.cmd.limit, Math.max total - cursor.cmd.skip, 0\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.sendStatus 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(422).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.provider\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.status(422).json\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.status(201).json\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    collections = require('.\/helper\/schema').types\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '@turbasen\/db-mongo'\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n        order: 'sort'\n      blacklist:\n        api_key     : true # other use\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.status(404).json message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.status(404).json message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.provider}]\n\n      next()\n\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = req.user.query qs.parse req.query\n\n### Fields\n\nAlways return `endret`, `lisens`, `navn`, `status`, `tilbyder`, and `tags` in\naddition to `\\_id` ObjectID which is always returned by MongoDB.\n\n      fields =\n        endret: true\n        lisens: true\n        navn: true\n        status: true\n        tags: true\n        tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ','\n          fields[field] = true\n\nIf any private fields are to be returned we need to limit the query to documents\nowner by the API user to prevent exposing private data publicly.\n\n          req.db.query.tilbyder = req.user.provider if field.substr(0,6) is 'privat'\n\n### Sort\n\nLimit sort to ascending or descending on `\\_id`, `endret`, and `navn` since they\nare indexed. Non-indexed fields will be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when '_id' then [['_id', 1]]\n          when '-_id' then [['_id', -1]]\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nMake new cursor object with the correct query, fields, and other options (limit,\nskip, and sort).\n\n      cursor = req.db.col.find req.db.query, fields,\n        limit: Math.min (parseInt(req.query.limit, 10) or 20), 50\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nCount number of matching documents in MongoDB database. Ignore limit and skip\nsettings by passing `false` as the first argument to `cursor.count()`.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min cursor.cmd.limit, Math.max total - cursor.cmd.skip, 0\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.sendStatus 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(422).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.provider\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.status(422).json\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.status(201).json\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"508eedd1d7523c00d936fce4b150901aea20b7cb","subject":"Use the correct data source for the current match","message":"Use the correct data source for the current match\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/match-sched.litcoffee","new_file":"src\/coffee\/match-sched.litcoffee","new_contents":"Match Schedule\n==============\n\nThe match schedule, as with the day schedule, is mainly managed within the basic\ndata module - this module defines only useful utilities.\n\nConstants\n---------\n\nWe define two constants within this module -- *MATCH_PREROLL*, and\n*MATCH_LENGTH*.\n\n*MATCH_PREROLL* is the amount of time, in seconds, before the start\ntime of a match during which it should be considered active. Its\ncurrent value is 180 seconds, which is 30 seconds of swap time and\n60 seconds boot period.\n\n    MATCH_PREROLL = 30 + 60\n\n*MATCH_LENGTH* is simply the length of a match in seconds, including\nsetup and tear-down time - presently 5 minutes.\n\n    MATCH_LENGTH = 60*5\n\n*MATCH_POSTROLL* is the amount of time, in seconds, between the\nstart time of a match and when it is considered to have ended. It\nis defined in terms of *MATCH_PREROLL* and *MATCH_LENGTH*.\n\n    MATCH_POSTROLL = MATCH_LENGTH - MATCH_PREROLL\n\nMatch Tracking\n--------------\n\nThe *firstMatchAfter* function takes as its argument a match schedule,\nand a *reference point*, being a JavaScript *Date* object. It finds\nthe first match in the schedule whose consideration period begins\nat or after the reference point. It may also take an optional\n*feasibility condition*, to further filter the matches considered.\n\n    firstMatchAfter = (schedule, referencePoint, feasilibilty) ->\n\nIf the feasibility condition is unspecified, we use a default\ncondition which simply accepts all matches.\n\n        unless feasibility?\n            feasibility = (match) -> yes\n\nWe convert the reference point into a UNIX timestamp for our use.\n\n        referenceUNIX = referencePoint.valueOf() * 0.001\n\nWe then use Underscore's *find* function to find the first satisfying\nmatch.\n\n        _.find schedule, (match) ->\n            return no unless feasibility(match, referencePoint)\n            match.start - MATCH_PREROLL <= referenceUNIX\n\nCurrent Match\n-------------\n\nWe provide the current match (nullable) via the *CurrentMatch*\nproperty. It is a map on the *Data.matchSchedule* property, and the\nclock.\n\nFirst, we define the data source.\n\n    currentMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n\nWe then define the stream itself, as a map over the input source.\n\n    currentMatch = currentMatchSource.map (data) ->\n\nWe find the first match active now, using *firstMatchAfter*. A\nfeasibility condition is passed to constrain matches to only those\nwhich have not ended.\n\n        firstMatchAfter data.schedule, data.clock, (match, ref) ->\n            not (match.start + MAX_POSTROLL > ref)\n\nThe public property simply removes the duplicates from that stream.\n\n    window.CurrentMatch = currentMatch.skipDuplicates()\n\nNext Match\n----------\n\nWe also provide the next match (nullable) via the *NextMatch*\nproperty. It is defined similarly to *CurrentMatch*, except with\nthe additional feasibility condition of not being the current match.\n\nWe first define the data source.\n\n    nextMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n            currentMatch: CurrentMatch\n\nWe then define the stream itself, again as a map over the source.\n\n    nextMatch = nextMatchSource.map (data) ->\n\nAs with the current match, we use *firstMatchAfter*, with a feasibility\ncondition this time specifying that the match is not the current\nmatch.\n\n        firstMatchAfter data.schedule, data.clock, (match) ->\n            match.key isnt data.currentMatch?.key\n\nWe then publish it by removing duplicates.\n\n    window.NextMatch = nextMatch.skipDuplicates()\n\n","old_contents":"Match Schedule\n==============\n\nThe match schedule, as with the day schedule, is mainly managed within the basic\ndata module - this module defines only useful utilities.\n\nConstants\n---------\n\nWe define two constants within this module -- *MATCH_PREROLL*, and\n*MATCH_LENGTH*.\n\n*MATCH_PREROLL* is the amount of time, in seconds, before the start\ntime of a match during which it should be considered active. Its\ncurrent value is 180 seconds, which is 30 seconds of swap time and\n60 seconds boot period.\n\n    MATCH_PREROLL = 30 + 60\n\n*MATCH_LENGTH* is simply the length of a match in seconds, including\nsetup and tear-down time - presently 5 minutes.\n\n    MATCH_LENGTH = 60*5\n\n*MATCH_POSTROLL* is the amount of time, in seconds, between the\nstart time of a match and when it is considered to have ended. It\nis defined in terms of *MATCH_PREROLL* and *MATCH_LENGTH*.\n\n    MATCH_POSTROLL = MATCH_LENGTH - MATCH_PREROLL\n\nMatch Tracking\n--------------\n\nThe *firstMatchAfter* function takes as its argument a match schedule,\nand a *reference point*, being a JavaScript *Date* object. It finds\nthe first match in the schedule whose consideration period begins\nat or after the reference point. It may also take an optional\n*feasibility condition*, to further filter the matches considered.\n\n    firstMatchAfter = (schedule, referencePoint, feasilibilty) ->\n\nIf the feasibility condition is unspecified, we use a default\ncondition which simply accepts all matches.\n\n        unless feasibility?\n            feasibility = (match) -> yes\n\nWe convert the reference point into a UNIX timestamp for our use.\n\n        referenceUNIX = referencePoint.valueOf() * 0.001\n\nWe then use Underscore's *find* function to find the first satisfying\nmatch.\n\n        _.find schedule, (match) ->\n            return no unless feasibility(match, referencePoint)\n            match.start - MATCH_PREROLL <= referenceUNIX\n\nCurrent Match\n-------------\n\nWe provide the current match (nullable) via the *CurrentMatch*\nproperty. It is a map on the *Data.matchSchedule* property, and the\nclock.\n\nFirst, we define the data source.\n\n    currentMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n\nWe then define the stream itself, as a map over the input source.\n\n    currentMatch = Data.matchSchedule.map (data) ->\n\nWe find the first match active now, using *firstMatchAfter*. A\nfeasibility condition is passed to constrain matches to only those\nwhich have not ended.\n\n        firstMatchAfter data.schedule, data.clock, (match, ref) ->\n            not (match.start + MAX_POSTROLL > ref)\n\nThe public property simply removes the duplicates from that stream.\n\n    window.CurrentMatch = currentMatch.skipDuplicates()\n\nNext Match\n----------\n\nWe also provide the next match (nullable) via the *NextMatch*\nproperty. It is defined similarly to *CurrentMatch*, except with\nthe additional feasibility condition of not being the current match.\n\nWe first define the data source.\n\n    nextMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n            currentMatch: CurrentMatch\n\nWe then define the stream itself, again as a map over the source.\n\n    nextMatch = nextMatchSource.map (data) ->\n\nAs with the current match, we use *firstMatchAfter*, with a feasibility\ncondition this time specifying that the match is not the current\nmatch.\n\n        firstMatchAfter data.schedule, data.clock, (match) ->\n            match.key isnt data.currentMatch?.key\n\nWe then publish it by removing duplicates.\n\n    window.NextMatch = nextMatch.skipDuplicates()\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bacc9eda6980c6fffd498897b7deb48e4d56a0cf","subject":"Document ModelMixin and RecordMixin","message":"Document ModelMixin and RecordMixin\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/12_storage_adapters.litcoffee","new_file":"docs\/12_storage_adapters.litcoffee","new_contents":"# \/api\/App Components\/Batman.StorageAdapter\n\n`Batman.StorageAdapter`s handle persistence of [`Batman.Model`s](\/docs\/api\/batman.model.html). Any `Batman.Model` which will be created, read, updated or deleted must have a storage adapter, which is declared with [`Batman.Model@persist`](\/docs\/api\/batman.model.html#class_function_persist):\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @persist Batman.RestStorage # a StorageAdapter subclass\n```\n\n__Note:__ `@persist` instantiates a StorageAdapter instance during model definition, so it will use `@storageKey` and `@resourceName` from the model where it was instantiated, but it won't play well with inheritance. For example:\n\n```coffeescript\nclass App.Model extends Batman.Model\n  @storageKey: 'model'\n  @persist Batman.LocalStorage\n\nclass App.Superhero extends App.Model\n  # have to do it again here, or else it will use @storageKey of 'model'\n  @storageKey: 'superhero'\n  @persist Batman.LocalStorage\n```\n\n### Batman's Included StorageAdapters\n\nBatman ships with a few storage adapters to get you up and coding quickly:\n\n- `Batman.LocalStorage` uses [`window.localStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#localStorage) to persist records.\n- `Batman.SessionStorage` extends `Batman.LocalStorage` and uses [`window.sessionStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#sessionStorage) to persist records.\n- `Batman.RestStorage` uses [HTTP REST](http:\/\/en.wikipedia.org\/wiki\/REST) to persist records, mapping HTTP verbs to storage operations and handling HTTP response codes appropriately. _Note: Because `Batman.RestStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\n### Batman.RailsStorage\nAlso, `Batman.RailsStorage` (available in separate file: [Coffee](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.rails.coffee), JS) extends `Batman.RestStorage` and provides some helpful Rails integrations:\n\n- If the response's status code is 422 (`Unprocessable Entity`), Any `errors` defined in the JSON response will be added to the `Batman.Model`'s [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n- By default, Batman will get the Rails CSRF token from the `<head>`and send it as a request header. (This can be prevented by setting `Batman.config.protectFromCSRF = false`.)\n- If a record's URL doesn't end in `.json` and doesn't include a query string, `.json` is automatically appended to the URL.\n\n\n_Note: Like `Batman.RestStorage`, `Batman.RailsStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), so you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\nIf you're using Batman and Rails, be sure to check out the [batman-rails](https:\/\/github.com\/batmanjs\/batman-rails) gem.\n\n## Storage Errors\n\n`Batman.StorageAdapter` throws [storage errors](\/docs\/api\/batman.storageadapter_errors.html) when its operations fail. You can catch these errors with [`Batman.Controller.catchError`](\/docs\/api\/batman.controller.html#class_function_catcherror).\n\n## Subclassing Batman.StorageAdapter\n\nYou may want to customize Batman's storage operations for your own app, for example:\n\n- Adding before- and after-operation callbacks\n- Overriding default storage operations\n\nTo do this, extend `Batman.StorageAdapter` (or one of the provided subclasses), then use your storage adapter to persist your models.\n```\nclass App.HeroicStorageAdapter extends Batman.LocalStorage\n  # filters, overrides\n\nclass App.Superhero extends Batman.Model\n  @persist App.HeroicStorageAdapter\n```\n\n## ModelMixin and RecordMixin\n\nA storage adapter may also have a class property called `ModelMixin`. If that property exists, in will be mixed into model classes that are persisted with that adapter. `RecordMixin` works the same way: it will be mixed into the prototype of models that are persisted with this adapter.\n\nFor example, this is how `Batman.RestStorage` provides URL-related functions to models that use it for persistence.\n\n### `env` and `next`\n\nStorage operations and callbacks each take two arguments: `env` and `next`.\n\n`env` is a vanilla JS object which is passed to each function in the chain. `Batman.StorageAdapter` sets these attributes on `env`:\n\n- `env.subject` is the `Batman.Model` record which had the storage operation called on it.\n- `env.options` contains the options passed to the operation on the subject.\n- `env.action` is the storage operation that will be executed by the storage adapter.\n- `env.error` stores any errors that occur during the chain. It becomes the first argument to the operation callback.\n- `env.result` contains the record(s) returned by the operation and should be set by the storage adapter implementation. It becomes the second argument to the operation's callback.\n\nStorage adapters may use `env` to collect any extra information needed by their operations. For example, `Batman.RestStorage` adds some attributes to `env` and `env.options`:\n\n- `env.request` is the `Batman.Request` which implements the storage operation.\n- `env.options.method` is the HTTP method used by `Batman.Request` to implement the storage operation.\n- `env.options.url` is the URL used by `Batman.Request` to implement the storage operation.\n\n`next` is a reference to the next function in the call chain for the current storage operation. `Batman.StorageAdapter` uses this to execute before-filters, storage operations and after-filters in the correct sequence.\n\n\n`next` should be called (`next()`) when the current function has completed. This indicates that the operation should proceed with the next function in its call chain. To ensure the completion of the call chain, consider wrapping your function in [`@skipIfError`](\/docs\/api\/batman.storageadapter.html#class_function_skipiferror).\n\n\n### Adding Callbacks\n\nCallbacks can be registered with [`before`](\/docs\/api\/batman.storageadapter.html#prototype_function_before) and [`after`](\/docs\/api\/batman.storageadapter.html#prototype_function_after) on any storage operation (listed below) or `'all'` (which runs the callback before or after any operation). Callbacks accept two arguments, `env` and `next`, discussed below.\n\n```coffeescript\nclass App.SpecificHeaderStorageAdapter extends Batman.RestStorage\n  # include a specific header in all requests:\n  @::before 'all', (env, next) ->\n    headers = env.options.headers ||= {}\n    headers[\"App-Specific-Header\"] = App.getSpecificHeader()\n    next()\n\n  @::after 'create', (env, next) ->\n    console.log \"A #{env.subject.constructor.name} was created!\"\n    next()\n```\n\n## Storage Operations\n\nAny `StorageAdapter` must implement these operations as instance methods, for example:\n\n\n```\nclass App.ModifiedStorageAdapter extends Batman.RestStorage\n  destroy: (env, next) ->\n    # your custom destroy operation\n    next()\n```\n\nWhen a record is saved, destroyed or loaded, `Batman.StorageAdapter` invokes these methods. Although you may reimplement them, you probably don't need to call them in your application code.\n\n## ::create(env : Object, next : Function)\nCalled to save a new record. When `save` is called on a record and `isNew` returns `true`, the storage adapter's `create` method is called.\n\n## ::read(env : Object, next : Function)\nCalled to load a record from storage.\n\n## ::update(env : Object, next : Function)\nCalled to update an existing record. When `save` is called on a record and `isNew` returns `false`, the storage adapter's `update` method is called.\n\n## ::destroy(env : Object, next : Function)\nCalled to destroy an existing record.\n\n## ::readAll(env : Object, next : Function)\nCalled to load all records of a particular type from storage.\n\n## Other Useful Methods\n\n## @skipIfError(wrappedFunction : Function )\n\nWraps a function, bypassing the function body and calling next() if an error has already occurred.\n\n    test \"StorageAdapter@skipIfError doesn't call the function if env.error?\", ->\n      insideFunction = createSpy()\n      nextFunction = createSpy()\n\n      functionWithWrapper = Batman.LocalStorage.skipIfError (env, next) ->\n        insideFunction()\n\n      dummyEnv = {error: true}\n\n      functionWithWrapper(dummyEnv, nextFunction)\n\n      equal dummyEnv.error?, true, 'an error is present'\n      equal insideFunction.called, false, 'insideFunction was skipped'\n      equal nextFunction.called, true, 'nextFunction was called'\n\nInside a storage adapter definition, this function is referenced as `@skipIfError`, for example:\n\n```\nclass App.SpecialStorageAdapter extends Batman.RestStorage\n  @::before 'create', @skipIfError (env, next) ->\n    console.log(\"This will be skipped if env.error? is true!\")\n    next()\n```\n## ::constructor(model: Function) : StorageAdapter\n\nReturns a `StorageAdapter` attached to `model`, which should be a subclass of `Batman.Model`.\n\n## ::.model : Function\n\nReturns the `Batman.Model` passed to the constructor.\n\n## ::before (keys... : Strings, filter : Function)\nRegisters `filter` as a before-operation callback for the storage operations named by `keys...`.\n\n## ::after (keys... : Strings, filter : Function)\nRegisters `filter` as a after-operation callback for the storage operations named by `keys...`.\n\n## ::getRecordFromData(attributes: Object, constructor[=@model] : Function) : Model\n\nFinds or creates an instance of `constructor` with `attributes` and returns it. Delegated to `Model.createFromJSON`.\n\n## ::getRecordsFromData(attributesArray: Array, constructor[=@model] : Function) : Array\n\nFinds or creates instances of `constructor` for each item in `attributesArray` and returns the resulting records. Delegated to `Model.createMultipleFromJSON`.\n","old_contents":"# \/api\/App Components\/Batman.StorageAdapter\n\n`Batman.StorageAdapter`s handle persistence of [`Batman.Model`s](\/docs\/api\/batman.model.html). Any `Batman.Model` which will be created, read, updated or deleted must have a storage adapter, which is declared with [`Batman.Model@persist`](\/docs\/api\/batman.model.html#class_function_persist):\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @persist Batman.RestStorage # a StorageAdapter subclass\n```\n\n__Note:__ `@persist` instantiates a StorageAdapter instance during model definition, so it will use `@storageKey` and `@resourceName` from the model where it was instantiated, but it won't play well with inheritance. For example:\n\n```coffeescript\nclass App.Model extends Batman.Model\n  @storageKey: 'model'\n  @persist Batman.LocalStorage\n\nclass App.Superhero extends App.Model\n  # have to do it again here, or else it will use @storageKey of 'model'\n  @storageKey: 'superhero'\n  @persist Batman.LocalStorage\n```\n\n### Batman's Included StorageAdapters\n\nBatman ships with a few storage adapters to get you up and coding quickly:\n\n- `Batman.LocalStorage` uses [`window.localStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#localStorage) to persist records.\n- `Batman.SessionStorage` extends `Batman.LocalStorage` and uses [`window.sessionStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#sessionStorage) to persist records.\n- `Batman.RestStorage` uses [HTTP REST](http:\/\/en.wikipedia.org\/wiki\/REST) to persist records, mapping HTTP verbs to storage operations and handling HTTP response codes appropriately. _Note: Because `Batman.RestStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\n### Batman.RailsStorage\nAlso, `Batman.RailsStorage` (available in separate file: [Coffee](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.rails.coffee), JS) extends `Batman.RestStorage` and provides some helpful Rails integrations:\n\n- If the response's status code is 422 (`Unprocessable Entity`), Any `errors` defined in the JSON response will be added to the `Batman.Model`'s [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n- By default, Batman will get the Rails CSRF token from the `<head>`and send it as a request header. (This can be prevented by setting `Batman.config.protectFromCSRF = false`.)\n- If a record's URL doesn't end in `.json` and doesn't include a query string, `.json` is automatically appended to the URL.\n\n\n_Note: Like `Batman.RestStorage`, `Batman.RailsStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), so you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\nIf you're using Batman and Rails, be sure to check out the [batman-rails](https:\/\/github.com\/batmanjs\/batman-rails) gem.\n\n## Storage Errors\n\n`Batman.StorageAdapter` throws [storage errors](\/docs\/api\/batman.storageadapter_errors.html) when its operations fail. You can catch these errors with [`Batman.Controller.catchError`](\/docs\/api\/batman.controller.html#class_function_catcherror).\n\n## Subclassing Batman.StorageAdapter\n\nYou may want to customize Batman's storage operations for your own app, for example:\n\n- Adding before- and after-operation callbacks\n- Overriding default storage operations\n\nTo do this, extend `Batman.StorageAdapter` (or one of the provided subclasses), then use your storage adapter to persist your models.\n```\nclass App.HeroicStorageAdapter extends Batman.LocalStorage\n  # filters, overrides\n\nclass App.Superhero extends Batman.Model\n  @persist App.HeroicStorageAdapter\n```\n### `env` and `next`\n\nStorage operations and callbacks each take two arguments: `env` and `next`.\n\n`env` is a vanilla JS object which is passed to each function in the chain. `Batman.StorageAdapter` sets these attributes on `env`:\n\n- `env.subject` is the `Batman.Model` record which had the storage operation called on it.\n- `env.options` contains the options passed to the operation on the subject.\n- `env.action` is the storage operation that will be executed by the storage adapter.\n- `env.error` stores any errors that occur during the chain. It becomes the first argument to the operation callback.\n- `env.result` contains the record(s) returned by the operation and should be set by the storage adapter implementation. It becomes the second argument to the operation's callback.\n\nStorage adapters may use `env` to collect any extra information needed by their operations. For example, `Batman.RestStorage` adds some attributes to `env` and `env.options`:\n\n- `env.request` is the `Batman.Request` which implements the storage operation.\n- `env.options.method` is the HTTP method used by `Batman.Request` to implement the storage operation.\n- `env.options.url` is the URL used by `Batman.Request` to implement the storage operation.\n\n`next` is a reference to the next function in the call chain for the current storage operation. `Batman.StorageAdapter` uses this to execute before-filters, storage operations and after-filters in the correct sequence.\n\n\n`next` should be called (`next()`) when the current function has completed. This indicates that the operation should proceed with the next function in its call chain. To ensure the completion of the call chain, consider wrapping your function in [`@skipIfError`](\/docs\/api\/batman.storageadapter.html#class_function_skipiferror).\n\n\n### Adding Callbacks\n\nCallbacks can be registered with [`before`](\/docs\/api\/batman.storageadapter.html#prototype_function_before) and [`after`](\/docs\/api\/batman.storageadapter.html#prototype_function_after) on any storage operation (listed below) or `'all'` (which runs the callback before or after any operation). Callbacks accept two arguments, `env` and `next`, discussed below.\n\n```coffeescript\nclass App.SpecificHeaderStorageAdapter extends Batman.RestStorage\n  # include a specific header in all requests:\n  @::before 'all', (env, next) ->\n    headers = env.options.headers ||= {}\n    headers[\"App-Specific-Header\"] = App.getSpecificHeader()\n    next()\n\n  @::after 'create', (env, next) ->\n    console.log \"A #{env.subject.constructor.name} was created!\"\n    next()\n```\n\n## Storage Operations\n\nAny `StorageAdapter` must implement these operations as instance methods, for example:\n\n\n```\nclass App.ModifiedStorageAdapter extends Batman.RestStorage\n  destroy: (env, next) ->\n    # your custom destroy operation\n    next()\n```\n\nWhen a record is saved, destroyed or loaded, `Batman.StorageAdapter` invokes these methods. Although you may reimplement them, you probably don't need to call them in your application code.\n\n## ::create(env : Object, next : Function)\nCalled to save a new record. When `save` is called on a record and `isNew` returns `true`, the storage adapter's `create` method is called.\n\n## ::read(env : Object, next : Function)\nCalled to load a record from storage.\n\n## ::update(env : Object, next : Function)\nCalled to update an existing record. When `save` is called on a record and `isNew` returns `false`, the storage adapter's `update` method is called.\n\n## ::destroy(env : Object, next : Function)\nCalled to destroy an existing record.\n\n## ::readAll(env : Object, next : Function)\nCalled to load all records of a particular type from storage.\n\n## Other Useful Methods\n\n## @skipIfError(wrappedFunction : Function )\n\nWraps a function, bypassing the function body and calling next() if an error has already occurred.\n\n    test \"StorageAdapter@skipIfError doesn't call the function if env.error?\", ->\n      insideFunction = createSpy()\n      nextFunction = createSpy()\n\n      functionWithWrapper = Batman.LocalStorage.skipIfError (env, next) ->\n        insideFunction()\n\n      dummyEnv = {error: true}\n\n      functionWithWrapper(dummyEnv, nextFunction)\n\n      equal dummyEnv.error?, true, 'an error is present'\n      equal insideFunction.called, false, 'insideFunction was skipped'\n      equal nextFunction.called, true, 'nextFunction was called'\n\nInside a storage adapter definition, this function is referenced as `@skipIfError`, for example:\n\n```\nclass App.SpecialStorageAdapter extends Batman.RestStorage\n  @::before 'create', @skipIfError (env, next) ->\n    console.log(\"This will be skipped if env.error? is true!\")\n    next()\n```\n## ::constructor(model: Function) : StorageAdapter\n\nReturns a `StorageAdapter` attached to `model`, which should be a subclass of `Batman.Model`.\n\n## ::.model : Function\n\nReturns the `Batman.Model` passed to the constructor.\n\n## ::before (keys... : Strings, filter : Function)\nRegisters `filter` as a before-operation callback for the storage operations named by `keys...`.\n\n## ::after (keys... : Strings, filter : Function)\nRegisters `filter` as a after-operation callback for the storage operations named by `keys...`.\n\n## ::getRecordFromData(attributes: Object, constructor[=@model] : Function) : Model\n\nFinds or creates an instance of `constructor` with `attributes` and returns it. Delegated to `Model.createFromJSON`.\n\n## ::getRecordsFromData(attributesArray: Array, constructor[=@model] : Function) : Array\n\nFinds or creates instances of `constructor` for each item in `attributesArray` and returns the resulting records. Delegated to `Model.createMultipleFromJSON`.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1f4de48b73cb2ffb4bc3d9e62ec168d5700057ba","subject":"Link to existing doc content instead of repeating it","message":"Link to existing doc content instead of repeating it\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08_app.litcoffee","new_file":"docs\/08_app.litcoffee","new_contents":"# Batman.App\n\n`Batman.App` is the central object in any Batman application. It manages the routing table and the current URL parameters, as well as the initial start of the application. It should also be used as a namespace for models and views so that other objects can find them. Batman assumes that there will only ever be one `Batman.App` in use at once.\n\n## Batman.currentApp\n\nA Batman-wide reference to the currently running `Batman.App`.\n\n## @run() : App\n\n`App.run` is the central entry point for a Batman application. `@run` takes these steps to initialize a Batman application:\n\n 1. Instantiate a `Dispatcher`, an internal object for mananging action dispatch to controllers.\n 2. Instantiate a `Navigator`, an internal object for managing the URL via pushState or hashbangs.\n 3. Instantiate the `layout` view according to the `layout` property on the `App`.\n 4. Wait for the layout view to fire it's `ready` event.\n 5. Start the first action dispatch by telling the `Navigator` to begin monitoring the URL.\n\n_Note_: `@run` emits the `run` class event on the `App`, but not necessarily as soon as `@run` is called. Because the `layout` View renders asynchronously and may need to fetch other components, the `run` event can and often does fire long after `@run` is called. If you need to execute code as soon as the `App` has started running, add a listener to the `run` event on the `App` class. If you need to execute code as soon as the layout has rendered, you can use the `ready` event on the `App` class.\n\n`@run` can be called before or on the `load` DOMEvent of the window. `@run` will return the App if the commencement was successful and complete, or `false` if the App must wait for the `layout` to render or if the `App` has already run.\n\n#### starting an application with DOMEvents\n```coffeescript\nwindow.addEventListener 'load', ->\n  MyApp.run()\n```\n\n#### starting an application with jQuery\n```coffeescript\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\n`@stop` stops the `App` it's called upon. The URL will stop being monitored and no more actions will be dispatched. In usual Batman development you shouldn't have to call this.\n\n## @routes\n\n`@routes` is a class level property referencing the root level `NamedRouteQuery` which allows for binding to routes on objects. See the [`data-route` binding](batman.view_bindings.html#data-route) for more information.\n\n## @controllers\n\n`@controllers` is a class level property containing the singleton `Batman.Controller` instances for each subclass in the application. This `controllers` directory puts these instances at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`. `@controllers` ideally should never be bound to, but it is very useful for debugging in the console and other such workarounds.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n    test \"Multi-word controller names have a lowercase first letter\", ->\n      class Alfred extends Batman.App\n      class Alfred.ReminderEmailsController extends Batman.Controller\n      controller = Alfred.get('controllers.reminderEmails')\n      equal Batman._functionName(controller.constructor), \"ReminderEmailsController\"\n\n## @layout\n\n`@layout` is the base view of the entire view hierarchy. By default, it will parse any data-* attributes in the entire document, excluding any `data-yield`'s, when `App.run()` is called. Use `MyApp.layout = null` to disable the creation of this default view.\n\n## @currentParams\n\n`@currentParams` contains the URL parameters for the current request, including the path relative to the app's base path (`Batman.config.pathToApp`). Some interesting parts to look at: `@currentParams.controller`, `@currentParams.action`.\n\n## @paramsManager\n## @paramsPusher\n\n## 'run' class event\n\nThe `run` class event is fired once the app has run. This indeterminately but often happens before the app's layout has finished rendering.\n\n## 'ready' class event\n\nThe `ready` class event is fired once the app's layout is rendered.\n\n# Batman.App Routing\n\nThe `Batman` routing DSL is similar to Rails 3's routing DSL. It is oriented around the notion of a resource:\n\n## @route\n\n`@route` defines a custom route and can be pointed to a controller action directly. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @route 'comments', 'pages#comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/comments` being added to the routing map, pointed to `PagesController#comments`.\n\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n`@resources` is modeled after the Rails routing `resources` method. It automatically defines some routes and matches them to controller actions. For example,\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages'\n\nclass App.PagesController extends Batman.Controller\n  index: ->\n    # ...\n  new: ->\n    # ...\n  show: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n  edit: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n```\n\nWill set up these routes:\n\nPath | Controller Action\n-- | -- |\n\/pages | App.PagesController#index\n\/pages\/new | App.PagesController#new\n\/pages\/:id | App.PagesController#show\n\/pages\/:id\/edit | App.PagesController#edit\n\nNote that unlike Rails, `destroy`, `update`, and `create` are not performed by controller actions in batman.js. Instead, call `save` or `destroy` on your records directly.\nTo access a generated route from within a view, use the [`data-route` binding](batman.view_bindings.html#data-route).\n\n### Nested Resources\n\nYou may also nest resources, as in Rails:\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages', ->\n    @resources 'comments'\n```\n\nWill set up these routes for `App.Comment`:\n\nPath | Controller Action\n-- | -- |\n\/pages\/:page_id\/comments | App.CommentsController#index\n\/pages\/:page_id\/comments\/new | App.CommentsController#new\n\/pages\/:page_id\/comments\/:id | App.CommentsController#show\n\/pages\/:page_id\/comments\/:id\/edit | App.CommentsController#edit\n\n\n## @member\n\n`@member` defines a routable action you can call on a specific instance of a member of a collection resource. For example, if you have a collection of `Page` resources, and a user can post a comment on a specific page:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @member 'comment'\n\nclass Example.PagesController extends Batman.Controller\n  comment: (params) ->\n```\n\nWould result in `\/pages\/:id\/comment` being added to the routing map, pointed to `PagesController#comment`.\n\n## @collection\n\n`@collection` is similar to `@member` in that it adds routable actions to a `@resources` set of routes. In this case the action would apply to the entire collection. For example, if you have a list of spam comments made across _all_ your `Page` resources:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @collection 'spam_comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/pages\/spam_comments` being added to the routing map, pointed to `PagesController#spam_comments`.\n\n## @root\n\n`@root` defines the root controller and action to be used when visiting the base application URL. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @root 'pages#index'\n\nclass Example.PagesController extends Batman.Controller\n  index: ->\n```\n\nWould result in `\/` being pointed to `PagesController#index`.\n\n","old_contents":"# Batman.App\n\n`Batman.App` is the central object in any Batman application. It manages the routing table and the current URL parameters, as well as the initial start of the application. It should also be used as a namespace for models and views so that other objects can find them. Batman assumes that there will only ever be one `Batman.App` in use at once.\n\n## Batman.currentApp\n\nA Batman-wide reference to the currently running `Batman.App`.\n\n## @run() : App\n\n`App.run` is the central entry point for a Batman application. `@run` takes these steps to initialize a Batman application:\n\n 1. Instantiate a `Dispatcher`, an internal object for mananging action dispatch to controllers.\n 2. Instantiate a `Navigator`, an internal object for managing the URL via pushState or hashbangs.\n 3. Instantiate the `layout` view according to the `layout` property on the `App`.\n 4. Wait for the layout view to fire it's `ready` event.\n 5. Start the first action dispatch by telling the `Navigator` to begin monitoring the URL.\n\n_Note_: `@run` emits the `run` class event on the `App`, but not necessarily as soon as `@run` is called. Because the `layout` View renders asynchronously and may need to fetch other components, the `run` event can and often does fire long after `@run` is called. If you need to execute code as soon as the `App` has started running, add a listener to the `run` event on the `App` class. If you need to execute code as soon as the layout has rendered, you can use the `ready` event on the `App` class.\n\n`@run` can be called before or on the `load` DOMEvent of the window. `@run` will return the App if the commencement was successful and complete, or `false` if the App must wait for the `layout` to render or if the `App` has already run.\n\n#### starting an application with DOMEvents\n```coffeescript\nwindow.addEventListener 'load', ->\n  MyApp.run()\n```\n\n#### starting an application with jQuery\n```coffeescript\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\n`@stop` stops the `App` it's called upon. The URL will stop being monitored and no more actions will be dispatched. In usual Batman development you shouldn't have to call this.\n\n## @routes\n\n`@routes` is a class level property referencing the root level `NamedRouteQuery` which allows for binding to routes on objects. See `data-route` bindings for more information.\n\n## @controllers\n\n`@controllers` is a class level property containing the singleton `Batman.Controller` instances for each subclass in the application. This `controllers` directory puts these instances at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`. `@controllers` ideally should never be bound to, but it is very useful for debugging in the console and other such workarounds.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n    test \"Multi-word controller names have a lowercase first letter\", ->\n      class Alfred extends Batman.App\n      class Alfred.ReminderEmailsController extends Batman.Controller\n      controller = Alfred.get('controllers.reminderEmails')\n      equal Batman._functionName(controller.constructor), \"ReminderEmailsController\"\n\n## @layout\n\n`@layout` is the base view of the entire view hierarchy. By default, it will parse any data-* attributes in the entire document, excluding any `data-yield`'s, when `App.run()` is called. Use `MyApp.layout = null` to disable the creation of this default view.\n\n## @currentParams\n\n`@currentParams` contains the URL parameters for the current request, including the path relative to the app's base path (`Batman.config.pathToApp`). Some interesting parts to look at: `@currentParams.controller`, `@currentParams.action`.\n\n## @paramsManager\n## @paramsPusher\n\n## 'run' class event\n\nThe `run` class event is fired once the app has run. This indeterminately but often happens before the app's layout has finished rendering.\n\n## 'ready' class event\n\nThe `ready` class event is fired once the app's layout is rendered.\n\n# Batman.App Routing\n\nThe `Batman` routing DSL is similar to Rails 3's routing DSL. It is oriented around the notion of a resource:\n\n## @route\n\n`@route` defines a custom route and can be pointed to a controller action directly. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @route 'comments', 'pages#comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/comments` being added to the routing map, pointed to `PagesController#comments`.\n\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n`@resources` is modeled after the Rails routing `resources` method. It automatically defines some routes and matches them to controller actions. For example,\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages'\n\nclass App.PagesController extends Batman.Controller\n  index: ->\n    # ...\n  new: ->\n    # ...\n  show: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n  edit: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n```\n\nWill set up these routes:\n\nPath | Controller Action | View binding\n-- | -- | -- |\n\/pages | App.PagesController#index | `data-route=\"routes.pages\"`\n\/pages\/new | App.PagesController#new | `data-route=\"routes.pages.new\"`\n\/pages\/:id | App.PagesController#show | `data-route=\"routes.pages[currentPage]\"`\n\/pages\/:id\/edit | App.PagesController#edit | `data-route=\"routes.pages[currentPage].edit\"`\n\nOf course, `destroy`, `update`, and `create` are not performed by controller actions in Batman. Instead, call `save` or `destroy` on your records.\n\n### Nested Resources\n\nYou may also nest resources, as in Rails:\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages', ->\n    @resources 'comments'\n```\n\nWill set up these routes for `App.Comment`:\n\nPath | Controller Action | View binding\n-- | -- | -- |\n\/pages\/:page_id\/comments | App.CommentsController#index | `data-route=\"routes.pages[currentPage].comments\"`\n\/pages\/:page_id\/comments\/new | App.CommentsController#new | `data-route=\"routes.pages[currentPage].comments.new\"`\n\/pages\/:page_id\/comments\/:id | App.CommentsController#show | `data-route=\"routes.pages[currentPage].comments[currentComment]\"`\n\/pages\/:page_id\/comments\/:id\/edit | App.CommentsController#edit | `data-route=\"routes.pages[currentPage].comments[currentComment].edit\"`\n\n\n## @member\n\n`@member` defines a routable action you can call on a specific instance of a member of a collection resource. For example, if you have a collection of `Page` resources, and a user can post a comment on a specific page:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @member 'comment'\n\nclass Example.PagesController extends Batman.Controller\n  comment: (params) ->\n```\n\nWould result in `\/pages\/:id\/comment` being added to the routing map, pointed to `PagesController#comment`.\n\n## @collection\n\n`@collection` is similar to `@member` in that it adds routable actions to a `@resources` set of routes. In this case the action would apply to the entire collection. For example, if you have a list of spam comments made across _all_ your `Page` resources:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @collection 'spam_comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/pages\/spam_comments` being added to the routing map, pointed to `PagesController#spam_comments`.\n\n## @root\n\n`@root` defines the root controller and action to be used when visiting the base application URL. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @root 'pages#index'\n\nclass Example.PagesController extends Batman.Controller\n  index: ->\n```\n\nWould result in `\/` being pointed to `PagesController#index`.","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"62098901324cc9829b188797507ccfc931bda282","subject":"fix minor issue with method debug output assuming input as an object","message":"fix minor issue with method debug output assuming input as an object\n","repos":"corenova\/yang-js","old_file":"src\/method.litcoffee","new_file":"src\/method.litcoffee","new_contents":"# Method - controller of functions\n\n## Class Method\n\n    debug = require('debug')('yang:method')\n    co = require('co') # TODO: should deprecate soon...\n    Property = require('.\/property')\n\n    class Method extends Property\n      constructor: ->\n        super\n        @state.enumerable = false\n      \n      debug: -> debug @uri, arguments...\n      \n      get: (pattern) -> switch\n        when pattern? then super\n        when @binding? then @do.bind this\n        else @content\n\n      set: (value, opts={ suppress: false }) ->\n        { suppress, actor } = opts\n        @state.prev = @state.value\n        @state.value = switch\n          when @schema.apply? then @schema.apply value, @context.with(opts)\n          else value\n        @emit 'update', this, actor unless suppress\n        return this\n\n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      do: (input={}) ->\n        unless (@binding instanceof Function) or (@content instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        transaction = true if @root.kind is 'module' and @root.transactable isnt true\n        @debug \"[do] executing method: #{@name}\"\n        @debug input\n        @root.transactable = true if transaction\n        try\n          ctx = @context\n          if @schema.input?\n            @debug \"[do] evaluating input schema\"\n            res = @schema.input.eval { input }, @context.with suppress: true\n            input = res.input || {}\n          # first apply schema bound function (if availble), otherwise\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\"\n            @debug @binding.toString()\n            output = @binding.call ctx, input\n          else\n            @debug \"[do] calling assigned function: #{@content.name}\"\n            output = @content.call @container, input, ctx\n            \n          return co =>\n            output = yield Promise.resolve output\n            if @schema.output?\n              @debug \"[do] evaluating output schema\"\n              res = @schema.output.eval { output }, @context.with suppress: true\n              output = res.output\n            if transaction\n              @root.save()\n              @root.transactable = false\n            return output\n        catch e\n          @debug e\n          if transaction\n            @root.rollback()\n            @root.transactable = false\n          return Promise.reject e\n\n### toJSON\n\nThis call always returns undefined for the Method node.\n\n      toJSON: (tag=false) ->\n        value = undefined\n        value = \"#{@name}\": value if tag\n        return value\n\n    module.exports = Method\n","old_contents":"# Method - controller of functions\n\n## Class Method\n\n    debug = require('debug')('yang:method')\n    co = require('co') # TODO: should deprecate soon...\n    Property = require('.\/property')\n\n    class Method extends Property\n      constructor: ->\n        super\n        @state.enumerable = false\n      \n      debug: -> debug @uri, arguments...\n      \n      get: (pattern) -> switch\n        when pattern? then super\n        when @binding? then @do.bind this\n        else @content\n\n      set: (value, opts={ suppress: false }) ->\n        { suppress, actor } = opts\n        @state.prev = @state.value\n        @state.value = switch\n          when @schema.apply? then @schema.apply value, @context.with(opts)\n          else value\n        @emit 'update', this, actor unless suppress\n        return this\n\n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      do: (input={}) ->\n        unless (@binding instanceof Function) or (@content instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        transaction = true if @root.kind is 'module' and @root.transactable isnt true\n        @debug \"[do] executing method: #{@name}\"\n        @debug input\n        @root.transactable = true if transaction\n        try\n          ctx = @context\n          if @schema.input?\n            @debug \"[do] evaluating input schema\"\n            res = @schema.input.eval { input }, @context.with suppress: true\n            input = res.input\n          # first apply schema bound function (if availble), otherwise\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\"\n            @debug @binding.toString()\n            output = @binding.call ctx, input\n          else\n            @debug \"[do] calling assigned function: #{@content.name}\"\n            output = @content.call @container, input, ctx\n            \n          return co =>\n            output = yield Promise.resolve output\n            if @schema.output?\n              @debug \"[do] evaluating output schema\"\n              res = @schema.output.eval { output }, @context.with suppress: true\n              output = res.output\n            if transaction\n              @root.save()\n              @root.transactable = false\n            return output\n        catch e\n          @debug e\n          if transaction\n            @root.rollback()\n            @root.transactable = false\n          return Promise.reject e\n\n### toJSON\n\nThis call always returns undefined for the Method node.\n\n      toJSON: (tag=false) ->\n        value = undefined\n        value = \"#{@name}\": value if tag\n        return value\n\n    module.exports = Method\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"e46a4dd2890a2686ae22bfa4b86560edd989df64","subject":"Changed the constrain method of the navmesh module to impose less structure on its callers.","message":"Changed the constrain method of the navmesh module to impose less\nstructure on its callers.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/navmesh.litcoffee","new_file":"src\/navmesh.litcoffee","new_contents":"# navmesh\n\nNavmeshes are stored as \"MSN\" (MasSplat Navmesh) and are used to define where \nentities (including the player) can travel.  By default, they are unable to \nleave the surface, \"crawling\" over it.  Each tile is a 3D triangle.  A light \nAny two triangles sharing two vertices are joined and the edge formed may be \ncrossed from one to the other, otherwise, the edge is treated as a form of wall.\n\nMSN is a binary format.  It is comprised of:\n\n| Type    | Num.              | Description                                                |\n| ------- | ----------------- | ---------------------------------------------------------- |\n| uint16  | 1                 | The number of vertices defined.                            |\n| uint16  | 1                 | The number of triangles defined.                           |\n| float32 | 3x num. vertices  | The X, Y and Z of each vertex.                             |\n| uint16  | 3x num. triangles | The first, second and third vertex index of each triangle. |\n\n    file = require \".\/file.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n\n## load\n\n- filename: The \"real\" location of the MSN file to load.  (i.e. already \n            \"require\"-d)\n- callback: A callback to execute with the array of objects representing the\n            loaded objects on success, containing:\n            \n+ plane: A plane object for the surface of the triangle itself.\n+ vertices: An array of vectors specifying the locations of the vertices which\n            make up the triangle.\n+ edges: An array of three objects representing the edges of the triangle,\n       containing:\n  \n* neighbor: When null, there is no other triangle over this edge.  Otherwise\n            a reference to the triangle object which can be found over it.\n* plane: A plane facing inwards from the edge.  If this edge borders another\n         triangle, this will be aligned to both this triangle and the \n         neighbor.\n    \n    load = (path, callback) ->\n        file.arrayBuffer path, (response) ->\n            header = new Uint16Array response, 0, 2\n            vertexData = new Float32Array response, 4, header[0] * 3\n            indices = new Uint16Array response, 4 + header[0] * 4 * 3, header[1] * 3\n        \n            vertices = for i in [0...vertexData.length] by 3\n                [\n                    vertexData[i]\n                    vertexData[i + 1]\n                    vertexData[i + 2]\n                ]\n        \n            triangles = for i in [0...indices.length] by 3\n                plane: plane.fromTriangle vertices[indices[i]], vertices[indices[i + 1]], vertices[indices[i + 2]]\n                indices: [\n                    indices[i]\n                    indices[i + 1]\n                    indices[i + 2]\n                ]\n                vertices: [\n                    vertices[indices[i]]\n                    vertices[indices[i + 1]]\n                    vertices[indices[i + 2]]\n                ]\n        \n            for triangle in triangles\n                triangle.edges = for edge in [0...3]\n                    vertexA = triangle.indices[edge]\n                    vertexB = triangle.indices[(edge + 1) % 3]\n                    vertexC = []\n                    vector.add.vector vertices[vertexA], triangle.plane.normal, vertexC\n                    neighbor = null\n                    for other in triangles\n                        if triangle is other then continue\n                        if vertexA not in other.indices then continue\n                        if vertexB not in other.indices then continue\n                        neighbor = other\n                        vector.add.vector vertexC, other.plane.normal, vertexC\n                        break\n                    neighbor: neighbor\n                    plane: plane.fromTriangle vertices[vertexA], vertexC, vertices[vertexB]\n\n            callback triangles\n            return\n        return\n            \n## constrain\n\n- A vector specifying the location moved to.\n- A reference to the navmesh triangle which contained the location moved from.\n\nUpdates the location vector to take into account collision with navmesh triangle \nwalls and returns the new containing navmesh triangle.\n            \n    constrain = (location, triangle) ->\n        \n        for iterations in [0...25]\n            distanceA = plane.distance triangle.edges[0].plane, location\n            distanceB = plane.distance triangle.edges[1].plane, location\n            distanceC = plane.distance triangle.edges[2].plane, location\n            if distanceA >= 0 and distanceB >= 0 and distanceC >= 0 \n                break\n\n            if distanceA < 0 and triangle.edges[0].neighbor\n                triangle = triangle.edges[0].neighbor\n                continue\n                \n            if distanceB < 0 and triangle.edges[1].neighbor\n                triangle = triangle.edges[1].neighbor\n                continue\n                \n            if distanceC < 0 and triangle.edges[2].neighbor\n                triangle = triangle.edges[2].neighbor\n                continue\n            \n            if distanceA < 0 and distanceB < 0\n                vector.copy triangle.vertices[1], location\n                continue\n                \n            if distanceB < 0 and distanceC < 0\n                vector.copy triangle.vertices[2], location\n                continue\n                \n            if distanceC < 0 and distanceA < 0\n                vector.copy triangle.vertices[0], location\n                continue\n\n            if distanceA < 0\n                plane.project triangle.edges[0].plane, location, location\n                continue\n                \n            if distanceB < 0\n                plane.project triangle.edges[1].plane, location, location\n                continue\n                    \n            if distanceC < 0\n                plane.project triangle.edges[2].plane, location, location\n                continue\n                \n        plane.project triangle.plane, location, location\n        triangle\n        \n    module.exports = { load, constrain }","old_contents":"# navmesh\n\nNavmeshes are stored as \"MSN\" (MasSplat Navmesh) and are used to define where \nentities (including the player) can travel.  By default, they are unable to \nleave the surface, \"crawling\" over it.  Each tile is a 3D triangle.  A light \nAny two triangles sharing two vertices are joined and the edge formed may be \ncrossed from one to the other, otherwise, the edge is treated as a form of wall.\n\nMSN is a binary format.  It is comprised of:\n\n| Type    | Num.              | Description                                                |\n| ------- | ----------------- | ---------------------------------------------------------- |\n| uint16  | 1                 | The number of vertices defined.                            |\n| uint16  | 1                 | The number of triangles defined.                           |\n| float32 | 3x num. vertices  | The X, Y and Z of each vertex.                             |\n| uint16  | 3x num. triangles | The first, second and third vertex index of each triangle. |\n\n    file = require \".\/file.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n\n## load\n\n- filename: The \"real\" location of the MSN file to load.  (i.e. already \n            \"require\"-d)\n- callback: A callback to execute with the array of objects representing the\n            loaded objects on success, containing:\n            \n+ plane: A plane object for the surface of the triangle itself.\n+ vertices: An array of vectors specifying the locations of the vertices which\n            make up the triangle.\n+ edges: An array of three objects representing the edges of the triangle,\n       containing:\n  \n* neighbor: When null, there is no other triangle over this edge.  Otherwise\n            a reference to the triangle object which can be found over it.\n* plane: A plane facing inwards from the edge.  If this edge borders another\n         triangle, this will be aligned to both this triangle and the \n         neighbor.\n    \n    load = (path, callback) ->\n        file.arrayBuffer path, (response) ->\n            header = new Uint16Array response, 0, 2\n            vertexData = new Float32Array response, 4, header[0] * 3\n            indices = new Uint16Array response, 4 + header[0] * 4 * 3, header[1] * 3\n        \n            vertices = for i in [0...vertexData.length] by 3\n                [\n                    vertexData[i]\n                    vertexData[i + 1]\n                    vertexData[i + 2]\n                ]\n        \n            triangles = for i in [0...indices.length] by 3\n                plane: plane.fromTriangle vertices[indices[i]], vertices[indices[i + 1]], vertices[indices[i + 2]]\n                indices: [\n                    indices[i]\n                    indices[i + 1]\n                    indices[i + 2]\n                ]\n                vertices: [\n                    vertices[indices[i]]\n                    vertices[indices[i + 1]]\n                    vertices[indices[i + 2]]\n                ]\n        \n            for triangle in triangles\n                triangle.edges = for edge in [0...3]\n                    vertexA = triangle.indices[edge]\n                    vertexB = triangle.indices[(edge + 1) % 3]\n                    vertexC = []\n                    vector.add.vector vertices[vertexA], triangle.plane.normal, vertexC\n                    neighbor = null\n                    for other in triangles\n                        if triangle is other then continue\n                        if vertexA not in other.indices then continue\n                        if vertexB not in other.indices then continue\n                        neighbor = other\n                        vector.add.vector vertexC, other.plane.normal, vertexC\n                        break\n                    neighbor: neighbor\n                    plane: plane.fromTriangle vertices[vertexA], vertexC, vertices[vertexB]\n\n            callback triangles\n            return\n        return\n            \n## constrain\n\nCall with an object containing:\n\n- location: An array of three numbers specifying the X, Y and Z moved to.\n- triangle: A reference to the triangle the entity is currently in.\n    \nThis will modify these properties to constrain the entity to the surface of the \nnavmesh.\n            \n    constrain = (obj) ->\n        \n        for iterations in [0...25]\n            distanceA = plane.distance obj.triangle.edges[0].plane, obj.location\n            distanceB = plane.distance obj.triangle.edges[1].plane, obj.location\n            distanceC = plane.distance obj.triangle.edges[2].plane, obj.location\n            if distanceA >= 0 and distanceB >= 0 and distanceC >= 0 \n                break\n\n            if distanceA < 0 and obj.triangle.edges[0].neighbor\n                obj.triangle = obj.triangle.edges[0].neighbor\n                continue\n                \n            if distanceB < 0 and obj.triangle.edges[1].neighbor\n                obj.triangle = obj.triangle.edges[1].neighbor\n                continue\n                \n            if distanceC < 0 and obj.triangle.edges[2].neighbor\n                obj.triangle = obj.triangle.edges[2].neighbor\n                continue\n            \n            if distanceA < 0 and distanceB < 0\n                vector.copy obj.triangle.vertices[1], obj.location\n                continue\n                \n            if distanceB < 0 and distanceC < 0\n                vector.copy obj.triangle.vertices[2], obj.location\n                continue\n                \n            if distanceC < 0 and distanceA < 0\n                vector.copy obj.triangle.vertices[0], obj.location\n                continue\n\n            if distanceA < 0\n                plane.project obj.triangle.edges[0].plane, obj.location, obj.location\n                continue\n                \n            if distanceB < 0\n                plane.project obj.triangle.edges[1].plane, obj.location, obj.location\n                continue\n                    \n            if distanceC < 0\n                plane.project obj.triangle.edges[2].plane, obj.location, obj.location\n                continue\n                \n        plane.project obj.triangle.plane, obj.location, obj.location\n        return        \n        \n    module.exports = { load, constrain }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e7e72a24ac44b9e5b0f2c32c40b0b1c4dd96c925","subject":"Fix bug with seconds (wrong tick values).","message":"Fix bug with seconds (wrong tick values).\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.  The main classes are exported as a Node module.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n    3. [Node module exports](#node-module-exports)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.  Only desired label\/tick tightness is supplied as an option.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width, tightness = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval.  Depending on `intervalType` we choose interval or point label placement.\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        switch @options.intervalType\n          when 'year', 'month', 'week', 'day'\n            @options.labelPlacement = 'interval'\n          else\n            @options.labelPlacement = 'point'\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: @formatLabel timePoint, @options\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        if @options.labelPlacement is 'interval'\n          for textLabel, i in textLabels when i isnt (textLabels.length-1)\n            textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n          textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n\nHere it can happen that `start` is actually earlier than Epoch.  Then we decrease `leftTime` first:\n\n            if start < leftTime\n              delta = 1\n              while start <= leftTime\n                leftTime = new Date leftTime.getFullYear(),\n                  leftTime.getMonth()\n                  leftTime.getDate() - delta*intervalMultiplier\n                  leftTime.getHours()\n                  leftTime.getMinutes()\n                  leftTime.getSeconds()\n                  leftTime.getMilliseconds()\n                delta *= 2\n\nNow we move forwart until we find the right point:\n\n            delta = 1048576\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `formatLabel` function ####\n\nThis function returns text representation of date.\n\n      formatLabel: (timePoint, options) ->\n        switch options.intervalType\n          when 'year'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setFullYear(nextTimePoint.getFullYear() - 1)\n              timePoint.getFullYear().toString() +\n                '\u2013' + nextTimePoint.getFullYear()\n            else\n              timePoint.getFullYear().toString()\n          when 'month'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMonth(nextTimePoint.getMonth() - 1)\n              timePoint.getMonth().toString() +\n                '\u2013' + nextTimePoint.getMonth().toString()\n            else\n              timePoint.getMonth().toString()\n          when 'week'\n            if options.labelPlacement is 'interval'\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'day'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'hour'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setHours(nextTimePoint.getHours())\n              timePoint.getHours().toString() +\n                '\u2013' + nextTimePoint.getHours().toString()\n            else\n              timePoint.getHours().toString()\n          when 'minute'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMinutes(nextTimePoint.getMinutes())\n              timePoint.getMinutes().toString() +\n                '\u2013' + nextTimePoint.getMinutes().toString()\n            else\n              timePoint.getMinutes().toString()\n          when 'second'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setSeconds(nextTimePoint.getSeconds())\n              timePoint.getSeconds().toString() +\n                '\u2013' + nextTimePoint.getSeconds().toString()\n            else\n              timePoint.getSeconds().toString()\n          when 'millisecond'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMilliseconds(nextTimePoint.getMilliseconds())\n              \".#{ timePoint.getMilliseconds() }\u2013.#{ nextTimePoint.getMilliseconds() }\"\n            else\n              \".#{ timePoint.getMilliseconds() }\"\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\n### Node module exports\n\nBoth `TimeAxisMaker` and `TimeAxisRenderer` are exported.\n\nWe temporarily disable it.\n\n    #module.exports =\n      #TimeAxisMaker: TimeAxisMaker\n      #TimeAxisRenderer: TimeAxisRenderer\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n        labelOffset: 29\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      timeAxisRedrerer = new TimeAxisRenderer()\n\nCode that draws builds and draws axis is also moved in a function:\n\n      makeAxis = ->\n        axisData = timeAxisMaker.formatAutomatic {start, end}, canvas.width, 15\n        timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nInitial drawing:\n\n      do makeAxis\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          do makeAxis\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          do makeAxis\n\nWe run the `makeDemo` function when page loads.\n\n__TODO__:  we need to put example in another file.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.  The main classes are exported as a Node module.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n    3. [Node module exports](#node-module-exports)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.  Only desired label\/tick tightness is supplied as an option.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width, tightness = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval.  Depending on `intervalType` we choose interval or point label placement.\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        switch @options.intervalType\n          when 'year', 'month', 'week', 'day'\n            @options.labelPlacement = 'interval'\n          else\n            @options.labelPlacement = 'point'\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: @formatLabel timePoint, @options\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        if @options.labelPlacement is 'interval'\n          for textLabel, i in textLabels when i isnt (textLabels.length-1)\n            textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n          textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n\nHere it can happen that `start` is actually earlier than Epoch.  Then we decrease `leftTime` first:\n\n            if start < leftTime\n              delta = 1\n              while start <= leftTime\n                leftTime = new Date leftTime.getFullYear(),\n                  leftTime.getMonth()\n                  leftTime.getDate() - delta*intervalMultiplier\n                  leftTime.getHours()\n                  leftTime.getMinutes()\n                  leftTime.getSeconds()\n                  leftTime.getMilliseconds()\n                delta *= 2\n\nNow we move forwart until we find the right point:\n\n            delta = 1048576\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `formatLabel` function ####\n\nThis function returns text representation of date.\n\n      formatLabel: (timePoint, options) ->\n        switch options.intervalType\n          when 'year'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setFullYear(nextTimePoint.getFullYear() - 1)\n              timePoint.getFullYear().toString() +\n                '\u2013' + nextTimePoint.getFullYear()\n            else\n              timePoint.getFullYear().toString()\n          when 'month'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMonth(nextTimePoint.getMonth() - 1)\n              timePoint.getMonth().toString() +\n                '\u2013' + nextTimePoint.getMonth().toString()\n            else\n              timePoint.getMonth().toString()\n          when 'week'\n            if options.labelPlacement is 'interval'\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'day'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'hour'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setHours(nextTimePoint.getHours())\n              timePoint.getHours().toString() +\n                '\u2013' + nextTimePoint.getHours().toString()\n            else\n              timePoint.getHours().toString()\n          when 'minute'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMinutes(nextTimePoint.getMinutes())\n              timePoint.getMinutes().toString() +\n                '\u2013' + nextTimePoint.getMinutes().toString()\n            else\n              timePoint.getMinutes().toString()\n          when 'second'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setSeconds(nextTimePoint.getSeconds())\n              timePoint.getSeconds().toString() +\n                '\u2013' + nextTimePoint.getSeconds().toString()\n            else\n              timePoint.getSeconds().toString()\n          when 'millisecond'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMilliseconds(nextTimePoint.getMilliseconds())\n              \".#{ timePoint.getMilliseconds() }\u2013.#{ nextTimePoint.getMilliseconds() }\"\n            else\n              \".#{ timePoint.getMilliseconds() }\"\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\n### Node module exports\n\nBoth `TimeAxisMaker` and `TimeAxisRenderer` are exported.\n\nWe temporarily disable it.\n\n    #module.exports =\n      #TimeAxisMaker: TimeAxisMaker\n      #TimeAxisRenderer: TimeAxisRenderer\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n        labelOffset: 29\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      timeAxisRedrerer = new TimeAxisRenderer()\n\nCode that draws builds and draws axis is also moved in a function:\n\n      makeAxis = ->\n        axisData = timeAxisMaker.formatAutomatic {start, end}, canvas.width, 15\n        timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nInitial drawing:\n\n      do makeAxis\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          do makeAxis\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          do makeAxis\n\nWe run the `makeDemo` function when page loads.\n\n__TODO__:  we need to put example in another file.\n\n    #window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"53121d7510716d279332a29327cecec74332d7e6","subject":"Add dragging functionality to testing demo.","message":"Add dragging functionality to testing demo.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The __TimelineMaker__ class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the __TimelineMaker__ class.  The __options__ parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are __formatTimeAxis()__, which formats time axis into a dictionary that describes the look of axis, and one of the __renderTo...__ functions that render that data dictionary to a desired context.\n\n#### The __formatTimeAxis()__ function\n\nA function that formats time axis into an intermediate format.  It has two parameters, __interval__ (a dictionary with __start__ and __end__ values, each of Date type) and corresponding to that interval __width__ of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be __options.intervalMultiplier__.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, __findPointList()__.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical element properties.  To transform time value into a coordinate we use the __timeToCoord()__ function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe should probably change ticks dictionary to lines dictionary instead, so we can add other types of lines, like baseline.  It could be better also to move all constants to options and make ticks drawing more flexible.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we add text labels too.\n\nHere we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {\n          lines: ticks.concat axisLine\n          textLabels\n        }\n\n#### The __findPointList()__ function\n\nThis function returns a list of points that are needed to be calculated for a (__start__, __end__) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the __start__ of the interval.  We move code that does that to the __findLeftTime()__.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using __findNextPoint()__ function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The __findLeftTime()__ function\n\nThe __findLeftTime()__ function calculates the rightmost point of time for current __options.intervalType__ such that it is not inside the given __interval__ (excluding beginning).  The __options.intervalType__ could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\nAnother option, __options.intervalMultiplier__, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the __options.intervalMultiplier__ should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the __findNextPoint()__ function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In __findNextPoint()__ we make sure that edge points are consistent while using different values of __start__.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The __findNextPoint()__ function\n\nThis function calculates next edge time point for a current options assuming __timePoint__ argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The __timeToCoord()__ function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The __renderToCanvas()__ function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.clearRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      timeInterval = end - start\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        oldX = event.clientX\n        oldY = event.clientY\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The __TimelineMaker__ class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the __TimelineMaker__ class.  The __options__ parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are __formatTimeAxis()__, which formats time axis into a dictionary that describes the look of axis, and one of the __renderTo...__ functions that render that data dictionary to a desired context.\n\n#### The __formatTimeAxis()__ function\n\nA function that formats time axis into an intermediate format.  It has two parameters, __interval__ (a dictionary with __start__ and __end__ values, each of Date type) and corresponding to that interval __width__ of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be __options.intervalMultiplier__.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, __findPointList()__.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical element properties.  To transform time value into a coordinate we use the __timeToCoord()__ function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe should probably change ticks dictionary to lines dictionary instead, so we can add other types of lines, like baseline.  It could be better also to move all constants to options and make ticks drawing more flexible.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we add text labels too.\n\nHere we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {\n          lines: ticks.concat axisLine\n          textLabels\n        }\n\n#### The __findPointList()__ function\n\nThis function returns a list of points that are needed to be calculated for a (__start__, __end__) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the __start__ of the interval.  We move code that does that to the __findLeftTime()__.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using __findNextPoint()__ function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The __findLeftTime()__ function\n\nThe __findLeftTime()__ function calculates the rightmost point of time for current __options.intervalType__ such that it is not inside the given __interval__ (excluding beginning).  The __options.intervalType__ could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\nAnother option, __options.intervalMultiplier__, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the __options.intervalMultiplier__ should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the __findNextPoint()__ function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In __findNextPoint()__ we make sure that edge points are consistent while using different values of __start__.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The __findNextPoint()__ function\n\nThis function calculates next edge time point for a current options assuming __timePoint__ argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The __timeToCoord()__ function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The __renderToCanvas()__ function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n      context.stroke()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\n    window.onload = makeDemo\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c1cd4bbdb1a6f25ec2236a296937ecbed22cd7cd","subject":"Improve zooming: now point under mouse pointer stays the same after zooming.","message":"Improve zooming: now point under mouse pointer stays the same after zooming.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.  The `options` parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters, `interval` (a dictionary with `start` and `end` values, each of Date type) and corresponding to that interval `width` of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {\n          lines: ticks.concat axisLine\n          textLabels\n        }\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for a (`start`, `end`) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not inside the given `interval` (excluding beginning).  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.  The `options` parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters, `interval` (a dictionary with `start` and `end` values, each of Date type) and corresponding to that interval `width` of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {\n          lines: ticks.concat axisLine\n          textLabels\n        }\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for a (`start`, `end`) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not inside the given `interval` (excluding beginning).  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        oldX = event.clientX\n        oldY = event.clientY\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          multiplier = Math.pow(base, event.deltaY)\n          interval = end-start\n          midPoint = start.getTime() + interval \/ 2\n          interval *= multiplier\n          start = new Date(midPoint - interval\/2)\n          end = new Date(midPoint + interval\/2)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"be42c1853920e38baf849e02b48beaf7be93bf1a","subject":"Implement multi-lane formatter.","message":"Implement multi-lane formatter.\n\nBasic multi-lane axis formatter was implemented.\nImplements partially #4.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.  The main classes are exported as a Node module.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n    3. [Node module exports](#node-module-exports)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatMultiLaneAxis()`:  builds ticks and labels in several lanes, so that it is possible to see exactly which interval is displayed;  each lane shows ticks and labels for different interval types (time (up to hours), days, months, years).  Up to four lanes are displayed then.\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.  Only desired label\/tick tightness is supplied as an option.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.tickLaneMultiplier`:  how much tick length is multiplied while on next lane from current lane.\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n * `options.laneOffset`: absolute offset between lanes.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          tickLaneMultiplier: options.tickLaneMultiplier ? 1.5\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n          laneOffset: options.laneOffset ? 30\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatMultiLaneAxis()` function ####\n\nThis function makes axis look like several axes stacked together, from smaller time intervals to larger, until years are shown.  That makes it complete, providing full information about the corresponding time interval.  It's arguments and return value are the same as for `formatAutomatic()`.\n\n      formatMultiLaneAxis: (interval, width, tightness = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\n__TODO__:  fix saving options.\n\n        oldAxisLineOffset = @options.axisLineOffset\n\nIn the beginning we format the first lane using `formatAutomatic()`:\n\n        features = @formatAutomatic interval, width, tightness\n\nThen, we need to format lanes one by one, increasing interval type, until we it is equal to 'years'.  `intervalMultiplier` will be equal to one always on these lanes.\n\n__Note__:  switch could be changed to some array progression, should it be done?\n\n        @options.intervalMultiplier = 1\n        @options.labelPlacement = 'interval'\n        while @options.intervalType isnt 'year'\n\nWe increase interval to the next interval type interval.\n\n          switch @options.intervalType\n            when 'millisecond', 'second', 'minute', 'hour'\n              @options.intervalType = 'day'\n            when 'day', 'week'\n              @options.intervalType = 'month'\n            when 'month'\n              @options.intervalType = 'year'\n\nNow we format a lane using the new interval type and multiplier, and after changing placement options.  New data is merged with previous data.\n\n__Note__:  merging code should be done in some other function. Refactor.\n\n          @options.axisLineOffset += @options.laneOffset\n          newLane = @formatFixed interval, width\n          features =\n            lines: features.lines.concat newLane.lines\n            textLabels: features.textLabels.concat newLane.textLabels\n\n__TODO__:  these horrible options restoration shoud be rewritten with the whole otpions and argument system.\n\n        @options.axisLineOffset = oldAxisLineOffset\n        features\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width, tightness = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval.  Depending on `intervalType` we choose interval or point label placement.\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        switch @options.intervalType\n          when 'year', 'month', 'week', 'day'\n            @options.labelPlacement = 'interval'\n          else\n            @options.labelPlacement = 'point'\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: @options.axisLineOffset + -@options.tickLength * @options.tickTailRatio\n            y2: @options.axisLineOffset + @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.axisLineOffset + @options.labelOffset\n            text: @formatLabel timePoint, @options\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        if @options.labelPlacement is 'interval'\n          for textLabel, i in textLabels when i isnt (textLabels.length-1)\n            textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n          textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n\nHere it can happen that `start` is actually earlier than Epoch.  Then we decrease `leftTime` first:\n\n            if start < leftTime\n              delta = 1\n              while start <= leftTime\n                leftTime = new Date leftTime.getFullYear(),\n                  leftTime.getMonth()\n                  leftTime.getDate() - delta*intervalMultiplier\n                  leftTime.getHours()\n                  leftTime.getMinutes()\n                  leftTime.getSeconds()\n                  leftTime.getMilliseconds()\n                delta *= 2\n\nNow we move forwart until we find the right point:\n\n            delta = 1048576\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `formatLabel` function ####\n\nThis function returns text representation of date.\n\n      formatLabel: (timePoint, options) ->\n        switch options.intervalType\n          when 'year'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setFullYear(nextTimePoint.getFullYear() - 1)\n              timePoint.getFullYear().toString() +\n                '\u2013' + nextTimePoint.getFullYear()\n            else\n              timePoint.getFullYear().toString()\n          when 'month'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMonth(nextTimePoint.getMonth() - 1)\n              timePoint.getMonth().toString() +\n                '\u2013' + nextTimePoint.getMonth().toString()\n            else\n              timePoint.getMonth().toString()\n          when 'week'\n            if options.labelPlacement is 'interval'\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'day'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'hour'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setHours(nextTimePoint.getHours())\n              timePoint.getHours().toString() +\n                '\u2013' + nextTimePoint.getHours().toString()\n            else\n              timePoint.getHours().toString()\n          when 'minute'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMinutes(nextTimePoint.getMinutes())\n              timePoint.getMinutes().toString() +\n                '\u2013' + nextTimePoint.getMinutes().toString()\n            else\n              timePoint.getMinutes().toString()\n          when 'second'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setSeconds(nextTimePoint.getSeconds())\n              timePoint.getSeconds().toString() +\n                '\u2013' + nextTimePoint.getSeconds().toString()\n            else\n              timePoint.getSeconds().toString()\n          when 'millisecond'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMilliseconds(nextTimePoint.getMilliseconds())\n              \".#{ timePoint.getMilliseconds() }\u2013.#{ nextTimePoint.getMilliseconds() }\"\n            else\n              \".#{ timePoint.getMilliseconds() }\"\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\n### Node module exports\n\nBoth `TimeAxisMaker` and `TimeAxisRenderer` are exported.\n\nWe temporarily disable it.\n\n    #module.exports =\n      #TimeAxisMaker: TimeAxisMaker\n      #TimeAxisRenderer: TimeAxisRenderer\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker({})\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      timeAxisRedrerer = new TimeAxisRenderer()\n\nCode that draws builds and draws axis is also moved in a function:\n\n      makeAxis = ->\n        axisData = timeAxisMaker.formatMultiLaneAxis {start, end}, canvas.width, 15\n        timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nInitial drawing:\n\n      do makeAxis\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          do makeAxis\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          do makeAxis\n\nWe run the `makeDemo` function when page loads.\n\n__TODO__:  we need to put example in another file.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.  The main classes are exported as a Node module.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n    3. [Node module exports](#node-module-exports)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.  Only desired label\/tick tightness is supplied as an option.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width, tightness = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval.  Depending on `intervalType` we choose interval or point label placement.\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        switch @options.intervalType\n          when 'year', 'month', 'week', 'day'\n            @options.labelPlacement = 'interval'\n          else\n            @options.labelPlacement = 'point'\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: @formatLabel timePoint, @options\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        if @options.labelPlacement is 'interval'\n          for textLabel, i in textLabels when i isnt (textLabels.length-1)\n            textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n          textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n\nHere it can happen that `start` is actually earlier than Epoch.  Then we decrease `leftTime` first:\n\n            if start < leftTime\n              delta = 1\n              while start <= leftTime\n                leftTime = new Date leftTime.getFullYear(),\n                  leftTime.getMonth()\n                  leftTime.getDate() - delta*intervalMultiplier\n                  leftTime.getHours()\n                  leftTime.getMinutes()\n                  leftTime.getSeconds()\n                  leftTime.getMilliseconds()\n                delta *= 2\n\nNow we move forwart until we find the right point:\n\n            delta = 1048576\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `formatLabel` function ####\n\nThis function returns text representation of date.\n\n      formatLabel: (timePoint, options) ->\n        switch options.intervalType\n          when 'year'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setFullYear(nextTimePoint.getFullYear() - 1)\n              timePoint.getFullYear().toString() +\n                '\u2013' + nextTimePoint.getFullYear()\n            else\n              timePoint.getFullYear().toString()\n          when 'month'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMonth(nextTimePoint.getMonth() - 1)\n              timePoint.getMonth().toString() +\n                '\u2013' + nextTimePoint.getMonth().toString()\n            else\n              timePoint.getMonth().toString()\n          when 'week'\n            if options.labelPlacement is 'interval'\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'day'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'hour'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setHours(nextTimePoint.getHours())\n              timePoint.getHours().toString() +\n                '\u2013' + nextTimePoint.getHours().toString()\n            else\n              timePoint.getHours().toString()\n          when 'minute'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMinutes(nextTimePoint.getMinutes())\n              timePoint.getMinutes().toString() +\n                '\u2013' + nextTimePoint.getMinutes().toString()\n            else\n              timePoint.getMinutes().toString()\n          when 'second'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setSeconds(nextTimePoint.getSeconds())\n              timePoint.getSeconds().toString() +\n                '\u2013' + nextTimePoint.getSeconds().toString()\n            else\n              timePoint.getSeconds().toString()\n          when 'millisecond'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMilliseconds(nextTimePoint.getMilliseconds())\n              \".#{ timePoint.getMilliseconds() }\u2013.#{ nextTimePoint.getMilliseconds() }\"\n            else\n              \".#{ timePoint.getMilliseconds() }\"\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\n### Node module exports\n\nBoth `TimeAxisMaker` and `TimeAxisRenderer` are exported.\n\nWe temporarily disable it.\n\n    #module.exports =\n      #TimeAxisMaker: TimeAxisMaker\n      #TimeAxisRenderer: TimeAxisRenderer\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n        labelOffset: 29\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      timeAxisRedrerer = new TimeAxisRenderer()\n\nCode that draws builds and draws axis is also moved in a function:\n\n      makeAxis = ->\n        axisData = timeAxisMaker.formatAutomatic {start, end}, canvas.width, 15\n        timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nInitial drawing:\n\n      do makeAxis\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          do makeAxis\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          do makeAxis\n\nWe run the `makeDemo` function when page loads.\n\n__TODO__:  we need to put example in another file.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"edead15c64ebc836f54f550cfbe60b7314e594cd","subject":"Move mongo require to code","message":"Move mongo require to code\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/cache.litcoffee","new_file":"coffee\/cache.litcoffee","new_contents":"    \"use strict\"\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### ToDo\n\n* Handle undefined values.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      ObjectID = require('mongodb').ObjectID\n      require('.\/db\/mongo')[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      require('.\/db\/redis').hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      require('.\/db\/redis').hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      set       : set\n      get       : get\n      getDoc    : getDoc\n      setForType: setForType\n      getFilter : getFilter\n      filterData: filterData\n      getForType: getForType\n\n","old_contents":"    \"use strict\"\n\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### ToDo\n\n* Handle undefined values.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      require('.\/db\/mongo')[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      require('.\/db\/redis').hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      require('.\/db\/redis').hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      set       : set\n      get       : get\n      getDoc    : getDoc\n      setForType: setForType\n      getFilter : getFilter\n      filterData: filterData\n      getForType: getForType\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0f5f092ec51b9c684f581531a7226b6f81054d07","subject":"Make a comment a bit more descriptive.","message":"Make a comment a bit more descriptive.\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/routing.litcoffee","new_file":"guts\/routing.litcoffee","new_contents":"Routing\n=======\nThis file serves as the \"glue\" between the express router and sanity. Basically, we want a rails-esque routing system with all the routes declared in one location.  One advantage over rails, though, is that we're going to allow some degree of function composition in that we can declare multiple, reusable actions per-route, then let them pass the return value from one to the next.\n\nThis is done via unapologetic use of Promises. \n\n##Libraries\n\n    Promise = require 'bluebird'\n    fs = Promise.promisifyAll require 'fs'\n    _ = require 'lodash'\n\nAs a note, the `Promise.promisifyAll` function simply adds `Async` to the end of the methods in `fs` and subsequently allows Promises to be used instead of callbacks. \n\n##Local Modules\n\n    getControllers = require '.\/getControllers'\n    policies = require '.\/policies'\n    bodyParser = require '.\/bodyParser'\n\n\nLet's kickstart this router.\n\n    module.exports = (app) ->\n        \n-----------\n        \nThis grabs the controllers and returns back a promise'd object of them. It made more sense to put this in a separate file, since it'sarguably useful in its own right.\n\n        getControllers()\n\nOnce we've gotten all the controllers, we'll move on\n\n        .then (controllerObject) ->\n\nLet's load in the routes file\n\n            configuredRoutes = require '..\/config\/routes'\n\nLet's loop through the routes file and do the appropriate mapping.[1]\n\n            _.each configuredRoutes, (totalString, route) ->\n\n                \nRoutes are stored like METHOD \/route, so we'll split on spaces. To make this a bit more dev-friendly, let's get rid of redundant spaces and newlines so that we're not punishing devs for using extra whitespace. \n\n                [method, endpoint] = route\n                             .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                             .replace \/\\s\\s+\/g, ' '\n                             .trim()\n                             .split ' '\n\n-----------\n\nThis bigass thing here is for dev-friendliness.  I don't want to punish people for separating controller calls to multiple lines if they want, and I don't want punish them for adding multiple spaces.  Subsequently, I replace newlines with a  space, then replace extra spaces down to one space, trim it, and split on the @ sign so I can make the dichotomy between application logic and error-handling logic. Utilizing Coffee's \"multi-return\" thing, I can set the values pretty cleanly, but not before I make sure the values are trimmed.\n\n                [actionString, catchString] = totalString\n                                  .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                                  .replace \/\\s\\s+\/g, ' '\n                                  .trim()\n                                  .split '@'\n                                  .map (i) -> do i.trim\n-----------\n\n\nAgain, just make it cleaner, we'll utilize the \"multi-return\" thing coffeescript does. Since I don't want a hard requirement for a catch to exist, I will put a conditional to see if the catch is defined.\n\n                [catchController,catchFunction] = catchString.split '.' if catchString?\n\nIf we have a catch defined, awesome, else we'll just feed in an empty function.\n               \n                catcher = controllerObject[catchController]?[catchFunction] || ->\n\nSplit the routes on a space so as to separate individual action handlers.\n\n                allRoutes = actionString.split ' '\n\n-------\n\nLoop through all the actions that are provided for that route, look them up, return back the handles on the function. So as to save a \"push\" command we'll use a map\n\n                actionHandles = _.map allRoutes, (a) ->\n\nFirst we need to separate out the error handling stuff from the actual program, so let's split that out, and utilize the multi-return value feature of coffeescript.\n\n                    [actionStuff, errorStuff] = a.split '!'\n\nSince I don't want to make a hard requirement to provide an error-handler, let's put a put quick \"if\" at the end of this to make sure we have errorstuff to assign.\n\n                    [errorController, errorAction] = errorStuff.split '.' if errorStuff?\n\nLet's parse out the controller and action.\n\n                    [myController, myAction] = actionStuff.split '.'\n\n\nNow let's grab the appropriate stuff out of the controllers.\n\n                    finalAction =  controllerObject[myController][myAction]\n                    finalError = controllerObject[errorController]?[errorAction]\n                    \nSince everything is parsed out, let's just wrap this in an object so as to easily pipe into the promises.\n\n                    finalObject =\n                        action: finalAction\n                        error: finalError\n                        controllerName: myController\n                        actionName: myAction\n\nOnce everything is done, let's just return out of the map and move on. \n\n                    return finalObject\n\n\nThe `wrapper` function.\n-----------------------\n\nThis here is the glue that does the joining of the actual functions.  In a nutshell, when the request it made, it should run `wrapper`, which will loop through the functions that were returned by the previous map, and run them sequentially as part of the promise chain.  I would like to eventually add a mechanism in which to do this in parallel (instead of just sequentially) eventually. \n\n                wrapper = (req, res) ->\n\nWe need to make sure the user is allowed to use everything that this route has to offer.  Due to the beauty of Bluebird, if this this trips up, it'll just kill the promise chain and make it so that we don't go any farther than we're allowed to.\n\n                        bodyParser req\n                        .then (updatedReq) ->\n                            policies actionHandles, updatedReq, res\n\nOnce we've gotten all the handles on the functions we need to call, we can concat it to all previous promises. Afterwards we want these to run sequentially, so we use the reduce function to run them, then converge into a single, final promise.\n\n                            finalPromise =\n                                _.chain [authPromise]\n                                .flatten()\n                                .concat actionHandles\n                                .reduce (cur, next) ->\n                                    cur.then next.action, next.error\n                                .value()\n                                \nEverything should be done.  We can finally render a template or return back JSON depending on what they did on that last function\n\n                            finalPromise.then (endData) ->\n\n\nWhat happens now is pretty simple.  A requirement for frameworkey is that you return an object with your data and the `renderType` property. From there it's pretty straightforward.\n\n                                if endData.renderType.toLowerCase() == 'html'\n                                    # We used \"toLowerCase\" to make it more dev-friendly. \n                                    res.render endData.page\n                                else if endData.renderType.toLowerCase() == 'json'\n                                    res.send endData.data\n                                \nWe'll use the global catch defined at the end of the actions to handle residual errors.  If there's an issue, we go here. We can default to an empty function if there's an issue.\n\n                            finalPromise.catch catcher\n\n                            \nAs stated above, wrapper will return a new function based on what we send in for \"allRoutes\".  We're adding the \"toLowerCase()\" to make this a bit more dev-friendly.\n\n                app[do method.toLowerCase] endpoint, wrapper\n\n\n[1]: I *really* hate how the value comes before the key in Lodash\n","old_contents":"Routing\n=======\nThis file serves as the \"glue\" between the express router and sanity. Basically, we want a rails-esque routing system with all the routes declared in one location.  One advantage over rails, though, is that we're going to allow some degree of function composition in that we can declare multiple, reusable actions per-route, then let them pass the return value from one to the next.\n\nThis is done via unapologetic use of Promises. \n\n##Libraries\n\n    Promise = require 'bluebird'\n    fs = Promise.promisifyAll require 'fs'\n    _ = require 'lodash'\n\nAs a note, the `Promise.promisifyAll` function simply adds `Async` to the end of the methods in `fs` and subsequently allows Promises to be used instead of callbacks. \n\n##Local Modules\n\n    getControllers = require '.\/getControllers'\n    policies = require '.\/policies'\n    bodyParser = require '.\/bodyParser'\n\n\nLet's kickstart this router.\n\n    module.exports = (app) ->\n        \n-----------\n        \nThis grabs the controllers and returns back a promise'd object of them. It made more sense to put this in a separate file, since it'sarguably useful in its own right.\n\n        getControllers()\n\nOnce we've gotten all the controllers, we'll move on\n\n        .then (controllerObject) ->\n\nLet's load in the routes file\n\n            configuredRoutes = require '..\/config\/routes'\n\nLet's loop through the routes file and do the appropriate mapping.[1]\n\n            _.each configuredRoutes, (totalString, route) ->\n\n                \nRoutes are stored like METHOD \/route, so we'll split on spaces. To make this a bit more dev-friendly, let's get rid of redundant spaces and newlines.\n\n                [method, endpoint] = route\n                             .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                             .replace \/\\s\\s+\/g, ' '\n                             .trim()\n                             .split ' '\n\n-----------\n\nThis bigass thing here is for dev-friendliness.  I don't want to punish people for separating controller calls to multiple lines if they want, and I don't want punish them for adding multiple spaces.  Subsequently, I replace newlines with a  space, then replace extra spaces down to one space, trim it, and split on the @ sign so I can make the dichotomy between application logic and error-handling logic. Utilizing Coffee's \"multi-return\" thing, I can set the values pretty cleanly, but not before I make sure the values are trimmed.\n\n                [actionString, catchString] = totalString\n                                  .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                                  .replace \/\\s\\s+\/g, ' '\n                                  .trim()\n                                  .split '@'\n                                  .map (i) -> do i.trim\n-----------\n\n\nAgain, just make it cleaner, we'll utilize the \"multi-return\" thing coffeescript does. Since I don't want a hard requirement for a catch to exist, I will put a conditional to see if the catch is defined.\n\n                [catchController,catchFunction] = catchString.split '.' if catchString?\n\nIf we have a catch defined, awesome, else we'll just feed in an empty function.\n               \n                catcher = controllerObject[catchController]?[catchFunction] || ->\n\nSplit the routes on a space so as to separate individual action handlers.\n\n                allRoutes = actionString.split ' '\n\n-------\n\nLoop through all the actions that are provided for that route, look them up, return back the handles on the function. So as to save a \"push\" command we'll use a map\n\n                actionHandles = _.map allRoutes, (a) ->\n\nFirst we need to separate out the error handling stuff from the actual program, so let's split that out, and utilize the multi-return value feature of coffeescript.\n\n                    [actionStuff, errorStuff] = a.split '!'\n\nSince I don't want to make a hard requirement to provide an error-handler, let's put a put quick \"if\" at the end of this to make sure we have errorstuff to assign.\n\n                    [errorController, errorAction] = errorStuff.split '.' if errorStuff?\n\nLet's parse out the controller and action.\n\n                    [myController, myAction] = actionStuff.split '.'\n\n\nNow let's grab the appropriate stuff out of the controllers.\n\n                    finalAction =  controllerObject[myController][myAction]\n                    finalError = controllerObject[errorController]?[errorAction]\n                    \nSince everything is parsed out, let's just wrap this in an object so as to easily pipe into the promises.\n\n                    finalObject =\n                        action: finalAction\n                        error: finalError\n                        controllerName: myController\n                        actionName: myAction\n\nOnce everything is done, let's just return out of the map and move on. \n\n                    return finalObject\n\n\nThe `wrapper` function.\n-----------------------\n\nThis here is the glue that does the joining of the actual functions.  In a nutshell, when the request it made, it should run `wrapper`, which will loop through the functions that were returned by the previous map, and run them sequentially as part of the promise chain.  I would like to eventually add a mechanism in which to do this in parallel (instead of just sequentially) eventually. \n\n                wrapper = (req, res) ->\n\nWe need to make sure the user is allowed to use everything that this route has to offer.  Due to the beauty of Bluebird, if this this trips up, it'll just kill the promise chain and make it so that we don't go any farther than we're allowed to.\n\n                        bodyParser req\n                        .then (updatedReq) ->\n                            policies actionHandles, updatedReq, res\n\nOnce we've gotten all the handles on the functions we need to call, we can concat it to all previous promises. Afterwards we want these to run sequentially, so we use the reduce function to run them, then converge into a single, final promise.\n\n                            finalPromise =\n                                _.chain [authPromise]\n                                .flatten()\n                                .concat actionHandles\n                                .reduce (cur, next) ->\n                                    cur.then next.action, next.error\n                                .value()\n                                \nEverything should be done.  We can finally render a template or return back JSON depending on what they did on that last function\n\n                            finalPromise.then (endData) ->\n\n\nWhat happens now is pretty simple.  A requirement for frameworkey is that you return an object with your data and the `renderType` property. From there it's pretty straightforward.\n\n                                if endData.renderType.toLowerCase() == 'html'\n                                    # We used \"toLowerCase\" to make it more dev-friendly. \n                                    res.render endData.page\n                                else if endData.renderType.toLowerCase() == 'json'\n                                    res.send endData.data\n                                \nWe'll use the global catch defined at the end of the actions to handle residual errors.  If there's an issue, we go here. We can default to an empty function if there's an issue.\n\n                            finalPromise.catch catcher\n\n                            \nAs stated above, wrapper will return a new function based on what we send in for \"allRoutes\".  We're adding the \"toLowerCase()\" to make this a bit more dev-friendly.\n\n                app[do method.toLowerCase] endpoint, wrapper\n\n\n[1]: I *really* hate how the value comes before the key in Lodash\n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"dfb71570b1c1ce3297d3e76e75af272974c88930","subject":"Stop performing unnecessary test when calling initialize_drawing_context","message":"Stop performing unnecessary test when calling initialize_drawing_context\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_renderer.litcoffee","new_file":"lib\/render-pipelines\/png\/png_renderer.litcoffee","new_contents":"    Module = require '..\/..\/module'\n    q      = require 'q'\n\n    class PngRenderer extends Module\n      deps: [ 'fs', 'canvas', 'path', 'config' ]\n      pub:  [ 'render', 'flush' ]\n\n      @draw_to: undefined\n      @ctx:     undefined\n\n      initialize: (params) =>\n        deferred = q.defer()\n\n        super()\n          .then =>\n            @initialize_drawing_context()\n\n            deferred.resolve @\n\n        deferred.promise\n\n      initialize_drawing_context: =>\n        width  = @config.width  * @config.grid[0].length\n        height = @config.height * @config.grid.length\n\n        PngRenderer.draw_to = new @canvas width, height\n        PngRenderer.ctx     = PngRenderer.draw_to.getContext '2d'\n\n      render: (path) => @done @do_render path\n\n      flush: (level) =>\n        stream = @fs.createWriteStream @path.join __dirname, '..', '..', '..', 'output', \"#{level}.png\"\n\n        for row, r in @config.grid\n          for cell, c in @config.grid[r]\n            @config.grid[r][c] = false\n\n        stream.on 'finish', => @done 'Persisted', location: level\n\n        PngRenderer.draw_to.createPNGStream().pipe stream\n\n    module.exports = PngRenderer\n","old_contents":"    Module = require '..\/..\/module'\n    q      = require 'q'\n\n    class PngRenderer extends Module\n      deps: [ 'fs', 'canvas', 'path', 'config' ]\n      pub:  [ 'render', 'flush' ]\n\n      @draw_to: undefined\n      @ctx:     undefined\n\n      initialize: (params) =>\n        deferred = q.defer()\n\n        super()\n          .then =>\n            @initialize_drawing_context() unless PngRenderer.draw_to?\n\n            deferred.resolve @\n\n        deferred.promise\n\n      initialize_drawing_context: =>\n        width  = @config.width  * @config.grid[0].length\n        height = @config.height * @config.grid.length\n\n        PngRenderer.draw_to = new @canvas width, height\n        PngRenderer.ctx     = PngRenderer.draw_to.getContext '2d'\n\n      render: (path) => @done @do_render path\n\n      flush: (level) =>\n        stream = @fs.createWriteStream @path.join __dirname, '..', '..', '..', 'output', \"#{level}.png\"\n\n        for row, r in @config.grid\n          for cell, c in @config.grid[r]\n            @config.grid[r][c] = false\n\n        stream.on 'finish', => @done 'Persisted', location: level\n\n        PngRenderer.draw_to.createPNGStream().pipe stream\n\n    module.exports = PngRenderer\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"86ffe177f7b5e277cdaff3f5d99c31c44a517846","subject":"Refactored statuses into a var to elminate a bit of duplication","message":"Refactored statuses into a var to elminate a bit of duplication\n","repos":"bsgbryan\/jyn","old_file":"lib\/server.litcoffee","new_file":"lib\/server.litcoffee","new_contents":"    Madul = require 'madul'\n\n    STATUSES =\n      COMPLETE: 'COMPLETE'\n      ERROR:    'ERROR'\n      PROGRESS: 'PROGRESS'\n\n    EXCLUDE = [\n      'MODULE'\n      'ACTION'\n      'EXECUTE'\n    ]\n\n    class Server extends Madul\n\n      deps: [ 'ws' ]\n\n      boot: (args, done) ->\n        wss = new @ws.Server port: args.ws.port\n\n        wss.on 'connection', (ws) =>\n          ws.on 'message', (mess) =>\n            try\n              input = JSON.parse mess\n            catch e\n              return @_notify ws, STATUSES.ERROR, \"Could not parse as JSON: #{mess}\"\n\n            @handle input\n              .then (output) => @_notify ws, STATUSES.COMPLETE, output\n              .catch   (err) => @_notify ws, STATUSES.ERROR,    err.args? || err\n              .progress (up) => @_notify ws, STATUSES.PROGRESS, up\n\n        done()\n\n      _notify: (socket, status, data) =>\n        if status == STATUSES.ERROR\n          out = { status, message: data }\n        else\n          out = { status, data }\n\n        socket.send JSON.stringify out\n\n      handle:\n        validate:\n          KEY:    [ '.is_present', '.hasnt_expired' ]\n          MODULE: '.is_present'\n          ACTION: '.is_present'\n        before:   '.init_execution_context'\n        behavior: (input) ->\n          args = { }\n\n          for own key, val of input\n            if key != 'MODULE' && key != 'ACTION' && key != 'EXECUTE'\n              args[key] = val\n\n          input.EXECUTE args\n            .then     (output) => input.done   output\n            .catch    (err)    => input.fail   err\n            .progress (delta)  => input.update delta\n\n    module.exports = Server\n","old_contents":"    Madul = require 'madul'\n\n    class Server extends Madul\n\n      deps: [ 'ws' ]\n\n      boot: (args, done) ->\n        wss = new @ws.Server port: args.ws.port\n\n        wss.on 'connection', (ws) =>\n          ws.on 'message', (mess) =>\n            try\n              input = JSON.parse mess\n            catch e\n              return @_notify ws, 'ERROR', \"Could not parse as JSON: #{mess}\"\n\n            @handle input\n              .then (output) => @_notify ws, 'COMPLETE', output\n              .catch   (err) => @_notify ws, 'ERROR',    err.message? || err\n              .progress (up) => @_notify ws, 'PROGRESS', up\n\n        done()\n\n      _notify: (socket, status, data) =>\n        if status == 'ERROR'\n          out = { status, message: data }\n        else\n          out = { status, data }\n\n        socket.send JSON.stringify out\n\n      handle:\n        validate:\n          KEY:    [ '.is_present', '.hasnt_expired' ]\n          MODULE: '.is_present'\n          ACTION: '.is_present'\n        before:   '.init_execution_context'\n        behavior: (input) ->\n          args = { }\n\n          for own key, val of input\n            if key != 'MODULE' && key != 'ACTION' && key != 'EXECUTE'\n              args[key] = val\n\n          input.EXECUTE args\n            .then     (output) => input.done   output\n            .catch    (err)    => input.fail   err\n            .progress (delta)  => input.update delta\n\n    module.exports = Server\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"01552f9d917c3dfd3b6f49c88f27ac51343cd232","subject":"Refactored dep loading logic to use new helper method","message":"Refactored dep loading logic to use new helper method\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"792032c9f82a8858f32b0b9dee0cadf819569b26","subject":"Fix build path","message":"Fix build path\n","repos":"linas\/link-grammar,linas\/link-grammar,opencog\/link-grammar,opencog\/link-grammar,opencog\/link-grammar,opencog\/link-grammar,ampli\/link-grammar,opencog\/link-grammar,linas\/link-grammar,linas\/link-grammar,linas\/link-grammar,linas\/link-grammar,ampli\/link-grammar,opencog\/link-grammar,linas\/link-grammar,opencog\/link-grammar,ampli\/link-grammar,linas\/link-grammar,opencog\/link-grammar,linas\/link-grammar,ampli\/link-grammar,ampli\/link-grammar,ampli\/link-grammar,ampli\/link-grammar,ampli\/link-grammar,opencog\/link-grammar,ampli\/link-grammar","old_file":"bindings\/node.js\/src\/index.litcoffee","new_file":"bindings\/node.js\/src\/index.litcoffee","new_contents":"# Node.js Bindings for Link Grammar\n\nThe parser is built using the awesome ffi library which allows\nus to communicate with a native library under the covers.\nAlong with ffi, we also use ref library to reference the native\nobjects used by the library.\n\n    ffi = require 'ffi'\n    ref = require 'ref'\n    Struct = require 'ref-struct'\n    _ = require 'underscore'\n\nEasier references to base types of data.\n\n    pointerType = 'pointer'\n    string = ref.types.CString\n    int = ref.types.int\n\nThese are just references to different native structs, which are\nall just pointers because we never use their actual referenced object.\n\n    ParseOptions = pointerType\n    Dictionary = pointerType\n    Sentence = pointerType\n    Linkage = pointerType\n\nHere are the templates for the native functions we will use.\n\n    apiTemplate =\n        parse_options_create: [ ParseOptions, [ ] ]\n        parse_options_set_null_block: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_islands_ok: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_verbosity: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_allow_null: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_max_null_count: [ ref.types.void, [ ParseOptions, int ] ]\n        dictionary_create: [ Dictionary, [ string, string, string, string ] ]\n        sentence_create: [ Sentence, [ string, Dictionary ] ]\n        sentence_parse: [ int, [ Sentence, ParseOptions ] ]\n        sentence_length: [ int, [ Sentence ] ]\n        sentence_get_word: [ string, [ Sentence, int ] ]\n        linkage_create: [ Linkage, [ int, Sentence, ParseOptions ] ]\n        linkage_print_diagram: [ string, [ Linkage ] ]\n        linkage_get_num_links: [ int, [ Linkage ] ]\n        linkage_get_link_label: [ string, [ Linkage, int ] ]\n        linkage_get_link_llabel: [ string, [ Linkage, int ] ]\n        linkage_get_link_rlabel: [ string, [ Linkage, int ] ]\n        linkage_get_word: [ string, [ Linkage, int ] ]\n        linkage_get_link_lword: [ int, [ Linkage, int ] ]\n        linkage_get_link_rword: [ int, [ Linkage, int ] ]\n\nLoad the library.\n\n    libPath = __dirname + '\/..\/..\/..\/build\/link-grammar\/.libs\/liblink-grammar.so'\n    lib = ffi.Library libPath, apiTemplate\n    defaultDataPath = __dirname + '\/..\/..\/..\/data\/en\/'\n\nDefault configuration for data paths.\n\n    defaultConfig =\n        lang: 'en'\n        verbose: false\n\nMain parser class which interfaces the native library to make\nit very simple to get Link Grammar data from an input string.\n\n    class LinkGrammar\n\nA few utility methods for the parser.\n\n        constructor: (config) ->\n            @config = _.extend config or {}, defaultConfig\n            @options = lib.parse_options_create()\n            lib.parse_options_set_verbosity @options, (if @config.verbose then 1  else 0)\n            lib.parse_options_set_allow_null @options, 1\n            lib.parse_options_set_max_null_count @options, 3\n            @dictionary = lib.dictionary_create @config.lang\n\nParse input, and return linkage, if it exists.\n\n        parse: (input, index) ->\n            sentence = lib.sentence_create input, @dictionary\n            numLinkages = lib.sentence_parse sentence, @options\n            if numLinkages > 0\n              new Linkage lib.linkage_create index or 0, sentence, @options\n            else\n              throw new Error('No linkages found')\n\nLinkage class which allows for more specific parsing of grammar.\n\n    class Linkage\n\n        constructor: (@linkage) ->\n            @links = @getLinks()\n            @words = @getWords()\n\nGet array of grammar links based on linkage.\n\n        getLinks: ->\n            _(lib.linkage_get_num_links @linkage).times ((index) ->\n                leftIndex = lib.linkage_get_link_lword @linkage, index\n                rightIndex = lib.linkage_get_link_rword @linkage, index\n                link =\n                    label: lib.linkage_get_link_label @linkage, index\n                    left:\n                        label: lib.linkage_get_link_llabel @linkage, index\n                        word: lib.linkage_get_word @linkage, leftIndex\n                        index: leftIndex\n                    right:\n                        label: lib.linkage_get_link_rlabel @linkage, index\n                        word: lib.linkage_get_word @linkage, rightIndex\n                        index: rightIndex\n                if link.left.word.indexOf '.' isnt -1\n                    temp = link.left.word.split '.'\n                    link.left.word = temp[0]\n                    link.left.type = temp[1]\n                if link.right.word.indexOf '.' isnt -1\n                    temp = link.right.word.split '.'\n                    link.right.word = temp[0]\n                    link.right.type = temp[1]\n                link\n            ), @\n\nGet parsed words with their grammar type and index\n\n        getWords: ->\n            _.chain(@links)\n                .map (link) -> [link.left, link.right]\n                .flatten()\n                .uniq (link) -> link.word\n                .value()\n\nGet list of links by specific label type\n\n        linksByLabel: (labelPattern) ->\n            labelPattern = new RegExp labelPattern if typeof labelPattern is 'string'\n            @links.filter (link) ->\n                labelPattern.test link.left.label or labelPattern.test link.right.label\n\nGet list of connector links for a specific word\n\n        getConnectorWords: (common) ->\n            words = []\n            @links.forEach (link) ->\n                if link.left.word is common\n                    words.push\n                        source: link.left\n                        target: link.right\n                if link.right.word is common\n                    words.push\n                        source: link.right\n                        target: link.left\n            words\n\n    module.exports = LinkGrammar\n","old_contents":"# Node.js Bindings for Link Grammar\n\nThe parser is built using the awesome ffi library which allows\nus to communicate with a native library under the covers.\nAlong with ffi, we also use ref library to reference the native\nobjects used by the library.\n\n    ffi = require 'ffi'\n    ref = require 'ref'\n    Struct = require 'ref-struct'\n    _ = require 'underscore'\n\nEasier references to base types of data.\n\n    pointerType = 'pointer'\n    string = ref.types.CString\n    int = ref.types.int\n\nThese are just references to different native structs, which are\nall just pointers because we never use their actual referenced object.\n\n    ParseOptions = pointerType\n    Dictionary = pointerType\n    Sentence = pointerType\n    Linkage = pointerType\n\nHere are the templates for the native functions we will use.\n\n    apiTemplate =\n        parse_options_create: [ ParseOptions, [ ] ]\n        parse_options_set_null_block: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_islands_ok: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_verbosity: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_allow_null: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_max_null_count: [ ref.types.void, [ ParseOptions, int ] ]\n        dictionary_create: [ Dictionary, [ string, string, string, string ] ]\n        sentence_create: [ Sentence, [ string, Dictionary ] ]\n        sentence_parse: [ int, [ Sentence, ParseOptions ] ]\n        sentence_length: [ int, [ Sentence ] ]\n        sentence_get_word: [ string, [ Sentence, int ] ]\n        linkage_create: [ Linkage, [ int, Sentence, ParseOptions ] ]\n        linkage_print_diagram: [ string, [ Linkage ] ]\n        linkage_get_num_links: [ int, [ Linkage ] ]\n        linkage_get_link_label: [ string, [ Linkage, int ] ]\n        linkage_get_link_llabel: [ string, [ Linkage, int ] ]\n        linkage_get_link_rlabel: [ string, [ Linkage, int ] ]\n        linkage_get_word: [ string, [ Linkage, int ] ]\n        linkage_get_link_lword: [ int, [ Linkage, int ] ]\n        linkage_get_link_rword: [ int, [ Linkage, int ] ]\n\nLoad the library.\n\n    libPath = __dirname + '\/..\/build\/libparser'\n    lib = ffi.Library libPath, apiTemplate\n    defaultDataPath = __dirname + '\/..\/..\/data\/en\/'\n\nDefault configuration for data paths.\n\n    defaultConfig =\n        lang: 'en'\n        verbose: false\n\nMain parser class which interfaces the native library to make\nit very simple to get Link Grammar data from an input string.\n\n    class LinkGrammar\n\nA few utility methods for the parser.\n\n        constructor: (config) ->\n            @config = _.extend config or {}, defaultConfig\n            @options = lib.parse_options_create()\n            lib.parse_options_set_verbosity @options, (if @config.verbose then 1  else 0)\n            lib.parse_options_set_allow_null @options, 1\n            lib.parse_options_set_max_null_count @options, 3\n            @dictionary = lib.dictionary_create @config.lang\n\nParse input, and return linkage, if it exists.\n\n        parse: (input, index) ->\n            sentence = lib.sentence_create input, @dictionary\n            numLinkages = lib.sentence_parse sentence, @options\n            if numLinkages > 0\n              new Linkage lib.linkage_create index or 0, sentence, @options\n            else\n              throw new Error('No linkages found')\n\nLinkage class which allows for more specific parsing of grammar.\n\n    class Linkage\n\n        constructor: (@linkage) ->\n            @links = @getLinks()\n            @words = @getWords()\n\nGet array of grammar links based on linkage.\n\n        getLinks: ->\n            _(lib.linkage_get_num_links @linkage).times ((index) ->\n                leftIndex = lib.linkage_get_link_lword @linkage, index\n                rightIndex = lib.linkage_get_link_rword @linkage, index\n                link =\n                    label: lib.linkage_get_link_label @linkage, index\n                    left:\n                        label: lib.linkage_get_link_llabel @linkage, index\n                        word: lib.linkage_get_word @linkage, leftIndex\n                        index: leftIndex\n                    right:\n                        label: lib.linkage_get_link_rlabel @linkage, index\n                        word: lib.linkage_get_word @linkage, rightIndex\n                        index: rightIndex\n                if link.left.word.indexOf '.' isnt -1\n                    temp = link.left.word.split '.'\n                    link.left.word = temp[0]\n                    link.left.type = temp[1]\n                if link.right.word.indexOf '.' isnt -1\n                    temp = link.right.word.split '.'\n                    link.right.word = temp[0]\n                    link.right.type = temp[1]\n                link\n            ), @\n\nGet parsed words with their grammar type and index\n\n        getWords: ->\n            _.chain(@links)\n                .map (link) -> [link.left, link.right]\n                .flatten()\n                .uniq (link) -> link.word\n                .value()\n\nGet list of links by specific label type\n\n        linksByLabel: (labelPattern) ->\n            labelPattern = new RegExp labelPattern if typeof labelPattern is 'string'\n            @links.filter (link) ->\n                labelPattern.test link.left.label or labelPattern.test link.right.label\n\nGet list of connector links for a specific word\n\n        getConnectorWords: (common) ->\n            words = []\n            @links.forEach (link) ->\n                if link.left.word is common\n                    words.push\n                        source: link.left\n                        target: link.right\n                if link.right.word is common\n                    words.push\n                        source: link.right\n                        target: link.left\n            words\n\n    module.exports = LinkGrammar\n","returncode":0,"stderr":"","license":"lgpl-2.1","lang":"Literate CoffeeScript"}
{"commit":"65eee71017b698c2d290975621f8f8d52ad745d6","subject":"Removed unneeded Config instance","message":"Removed unneeded Config instance\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/cli.litcoffee","new_file":"lib\/cli.litcoffee","new_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    Skyll = require '.\/skyll'\n    next  = 0\n\n    new Skyll()\n      .initialize()\n      .then (mod) ->\n        levels = mod.config.levels\n\n        render = (level) ->\n          mod.craft level\n            .then ->\n              console.log 'finished rendering level', next\n              render levels[next] if ++next < levels.length\n\n        render levels[next]\n","old_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    Config = require '.\/config'\n\n    new Config()\n      .initialize()\n      .then (config) ->\n        Skyll = require '.\/skyll'\n        next  = 0\n\n        new Skyll()\n          .initialize starting_row: Math.floor config.grid.length \/ 2\n          .then (mod) ->\n            render = (level) ->\n              mod.craft level\n                .then ->\n                  console.log 'finished rendering level', next\n                  render config.levels[next] if ++next < config.levels.length\n\n            render config.levels[next]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c5ec717a659215ddc197294623dcbfa7152089cf","subject":"Logging.","message":"Logging.\n","repos":"mxipartners\/checksome,fniessink\/checksome","old_file":"server\/sonar.litcoffee","new_file":"server\/sonar.litcoffee","new_contents":"This job collects data from Sonar for the Sonar keys in the `SubjectSourceIds`\ncollection.\n\n    class @SonarJob extends Job\n      @setupCron: (parser) ->\n        parser.recur().every(1).minute()\n\n      handleJob: ->\n        for source in Sources.find({type: 'sonar'}).fetch()\n          @update_project_keys source\n        for subject_source_id in SubjectSourceIds.find().fetch()\n          source = Sources.findOne({_id: subject_source_id.source})\n          if source.type != 'sonar'\n            continue\n          @measure_ncloc subject_source_id, source\n          @measure_duplication subject_source_id, source\n\n      update_project_keys: (source) ->\n        result = @get_project_keys_json source.url\n        if result.json\n          project_keys = ({_id: project.key, title: project.key} for project in result.json)\n          Sources.update source._id, {$set: {ids: project_keys}}\n        else\n          console.log result.error_message\n\n      get_project_keys_json: (sonar_url) ->\n        try\n          result = HTTP.get sonar_url + 'api\/resources?format=json'\n          return {json: result.data, error_message: ''}\n        catch e\n          return {json: null, error_message: e.message}\n\n      measure_ncloc: (subject_source_id, source) ->\n        metric = Metrics.findOne {title: \"NCLOC\"}\n        subject = Subjects.findOne {_id: subject_source_id.subject}\n        subject_metric = SubjectMetrics.findOne {subject: subject._id, metric: metric._id}\n        target = subject_metric.target or metric.target\n        sonar_key = subject_source_id.id\n        result = @get_json source.url, sonar_key\n        if result.json\n          for sonar_metric in result.json[0]['msr']\n            if sonar_metric['key'] == 'ncloc'\n              value = sonar_metric['val']\n              target_met = ncloc_meets_target(value, target)\n          error_message = null\n        else\n          value = null\n          target_met = null\n          error_message = result.error_message\n        insertOrUpdateMeasurement\n          projectId: source.projectId\n          subject_metric_id: subject_metric._id\n          metric_title: metric.title\n          subject_title: subject.title\n          value: value\n          unit: metric.unit\n          target: target\n          target_met: target_met\n          error_message: result.error_message\n\n      measure_duplication: (subject_source_id, source) ->\n        metric = Metrics.findOne {title: \"Duplication\"}\n        subject = Subjects.findOne {_id: subject_source_id.subject}\n        subject_metric = SubjectMetrics.findOne {subject: subject._id, metric: metric._id}\n        target = subject_metric.target or metric.target\n        sonar_key = subject_source_id.id\n        result = @get_json source.url, sonar_key\n        if result.json\n          for sonar_metric in result.json[0]['msr']\n            if sonar_metric['key'] == 'duplicated_lines_density'\n              value = sonar_metric['val']\n              target_met = duplication_meets_target(value, target)\n          error_message = null\n        else\n          value = null\n          target_met = null\n          error_message = result.error_message\n        insertOrUpdateMeasurement\n          projectId: source.projectId\n          subject_metric_id: subject_metric._id\n          metric_title: metric.title\n          subject_title: subject.title\n          value: value\n          unit: metric.unit\n          target: target\n          target_met: target_met\n          error_message: result.error_message\n\n      get_json: (sonar_url, sonar_key) ->\n        try\n          result = HTTP.get sonar_url + 'api\/resources?resource=' + sonar_key + '&metrics=true'\n          return {json: result.data, error_message: ''}\n        catch e\n          return {json: null, error_message: e.message}\n\n    Job.push new SonarJob\n","old_contents":"This job collects data from Sonar for the Sonar keys in the `SubjectSourceIds`\ncollection.\n\n    class @SonarJob extends Job\n      @setupCron: (parser) ->\n        parser.recur().every(1).minute()\n\n      handleJob: ->\n        for source in Sources.find({type: 'sonar'}).fetch()\n          @update_project_keys source\n        for subject_source_id in SubjectSourceIds.find().fetch()\n          source = Sources.findOne({_id: subject_source_id.source})\n          if source.type != 'sonar'\n            continue\n          @measure_ncloc subject_source_id, source\n          @measure_duplication subject_source_id, source\n\n      update_project_keys: (source) ->\n        result = @get_project_keys_json source.url\n        if result.json\n          project_keys = ({_id: project.key, title: project.key} for project in result.json)\n          Sources.update source._id, {$set: {ids: project_keys}}\n\n      get_project_keys_json: (sonar_url) ->\n        try\n          result = HTTP.get sonar_url + 'api\/resources?format=json'\n          return {json: result.data, error_message: ''}\n        catch e\n          return {json: null, error_message: e.message}\n\n      measure_ncloc: (subject_source_id, source) ->\n        metric = Metrics.findOne {title: \"NCLOC\"}\n        subject = Subjects.findOne {_id: subject_source_id.subject}\n        subject_metric = SubjectMetrics.findOne {subject: subject._id, metric: metric._id}\n        target = subject_metric.target or metric.target\n        sonar_key = subject_source_id.id\n        result = @get_json source.url, sonar_key\n        if result.json\n          for sonar_metric in result.json[0]['msr']\n            if sonar_metric['key'] == 'ncloc'\n              value = sonar_metric['val']\n              target_met = ncloc_meets_target(value, target)\n          error_message = null\n        else\n          value = null\n          target_met = null\n          error_message = result.error_message\n        insertOrUpdateMeasurement\n          projectId: source.projectId\n          subject_metric_id: subject_metric._id\n          metric_title: metric.title\n          subject_title: subject.title\n          value: value\n          unit: metric.unit\n          target: target\n          target_met: target_met\n          error_message: result.error_message\n\n      measure_duplication: (subject_source_id, source) ->\n        metric = Metrics.findOne {title: \"Duplication\"}\n        subject = Subjects.findOne {_id: subject_source_id.subject}\n        subject_metric = SubjectMetrics.findOne {subject: subject._id, metric: metric._id}\n        target = subject_metric.target or metric.target\n        sonar_key = subject_source_id.id\n        result = @get_json source.url, sonar_key\n        if result.json\n          for sonar_metric in result.json[0]['msr']\n            if sonar_metric['key'] == 'duplicated_lines_density'\n              value = sonar_metric['val']\n              target_met = duplication_meets_target(value, target)\n          error_message = null\n        else\n          value = null\n          target_met = null\n          error_message = result.error_message\n        insertOrUpdateMeasurement\n          projectId: source.projectId\n          subject_metric_id: subject_metric._id\n          metric_title: metric.title\n          subject_title: subject.title\n          value: value\n          unit: metric.unit\n          target: target\n          target_met: target_met\n          error_message: result.error_message\n\n      get_json: (sonar_url, sonar_key) ->\n        try\n          result = HTTP.get sonar_url + 'api\/resources?resource=' + sonar_key + '&metrics=true'\n          return {json: result.data, error_message: ''}\n        catch e\n          return {json: null, error_message: e.message}\n\n    Job.push new SonarJob\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bc37ffe7f2eeb2bcec83456236c1ea1929455596","subject":"fix navbar collapse","message":"fix navbar collapse\n","repos":"modweb\/pinki,jfols\/liftoff,jfols\/liftoff","old_file":"client\/views\/layout\/header.litcoffee","new_file":"client\/views\/layout\/header.litcoffee","new_contents":"# Header helpers\n\n    Template.header.events\n      'click #at-nav-link': (event) ->\n        if Meteor.user() then AccountsTemplates.logout()\n      'click .logout': (event) ->\n        AccountsTemplates.logout()\n      'click a': (event) ->\n        $('.navbar-collapse').collapse 'hide'\n","old_contents":"# Header helpers\n\n    Template.header.events\n      'click #at-nav-link': (event) ->\n        if Meteor.user() then AccountsTemplates.logout()\n      'click .logout': (event) ->\n        AccountsTemplates.logout()\n      'click a': (event) ->\n        $('.navbar-toggle').click()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3941595a755adcf474365563a22702ad3170ad3b","subject":"Add create snapshot","message":"Add create snapshot\n","repos":"mnmtanish\/vosco-cli","old_file":"script.litcoffee","new_file":"script.litcoffee","new_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    fs     = require \"fs\"\n    path   = require \"path\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    script =\n\nSetup\n-----\n\n      'install': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        if isInstalled then process.exit 1\n        await @vosco.install defer(error)\n\n      'uninstall': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.uninstall defer(error)\n\nRepository\n----------\n\n      'get-status': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getStatus defer(error, status)\n        getType = (file) -> file.type\n        getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n        groups  = _.groupBy status, getType\n        for group, paths of groups\n          console.log \"\"\"\n          #{group}\n          #{paths.map(getPath).join(\"\\n\")}\n          \"\"\"\n\n      'get-history': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getHistory defer(error, history)\n        for commit in history\n          hash = commit.hash.substr(0, 7)\n          date = new Date(commit.date).toDateString()\n          msg  = commit.message\n          console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n\n      'get-content-history': (path) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        # show warning if file doesn\"t exist\n        console.log \"content history\"\n\nSnapshots\n---------\n\n      'preview-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        hash = hash or 'HEAD'\n        await @vosco.previewSnapshot hash, defer(error, diff)\n        console.log diff\n\n      'create-snapshot': (message) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        message = message or 'Untitled Snapshot'\n        await @vosco.createSnapshot message, defer(error)\n\n      'rollback-to-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"rollback to snapshot\"\n\nBranches\n--------\n\n      'list-branches': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"branches list\"\n\n      'select-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"select branch\"\n\n      'create-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"create new branch\"\n\n      'delete-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"delete branch\"\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      script.vosco = vosco\n      return script\n","old_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    fs     = require \"fs\"\n    path   = require \"path\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    script =\n\nSetup\n-----\n\n      'install': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        if isInstalled then process.exit 1\n        await @vosco.install defer(error)\n\n      'uninstall': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.uninstall defer(error)\n\nRepository\n----------\n\n      'get-status': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getStatus defer(error, status)\n        getType = (file) -> file.type\n        getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n        groups  = _.groupBy status, getType\n        for group, paths of groups\n          console.log \"\"\"\n          #{group}\n          #{paths.map(getPath).join(\"\\n\")}\n          \"\"\"\n\n      'get-history': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getHistory defer(error, history)\n        for commit in history\n          hash = commit.hash.substr(0, 7)\n          date = new Date(commit.date).toDateString()\n          msg  = commit.message\n          console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n\n      'get-content-history': (path) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        # show warning if file doesn\"t exist\n        console.log \"content history\"\n\nSnapshots\n---------\n\n      'preview-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        hash = hash or 'HEAD'\n        await @vosco.previewSnapshot hash, defer(error, diff)\n        console.log diff\n\n      'create-snapshot': (message) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"creating snapshot\"\n\n      'rollback-to-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"rollback to snapshot\"\n\nBranches\n--------\n\n      'list-branches': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"branches list\"\n\n      'select-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"select branch\"\n\n      'create-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"create new branch\"\n\n      'delete-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"delete branch\"\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      script.vosco = vosco\n      return script\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"58064486b22f040ea413b51bee0390e738dccc6c","subject":"Fixed bug with used utils.isServer in testing","message":"Fixed bug with used utils.isServer in testing\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"lib\/testing\/index.litcoffee","new_file":"lib\/testing\/index.litcoffee","new_contents":"# Testing\n\n    'use strict'\n\n    {utils, log, assert} = Neft\n    stack = require '.\/stack'\n    logger = require '.\/logger'\n    screenshot = require '.\/screenshot\/client'\n\n    {isArray} = Array\n    {push} = Array::\n    {Scope, Test, Listener} = require '.\/structure'\n\n    scopes = [new Scope]\n    currentScope = scopes[0]\n\n    ONLY_OPT = 1 << 1\n\n    raportOnlyUsed = ->\n        if process.env.CI\n            throw new Error \"Cannot use describe.only and it.only on CI\"\n        else\n            log.warn \"describe.only or it.only is used\"\n\n# describe(*String* message, *Function* tests)\n\n    exports.describe = (msg, func, opts = 0) ->\n        beforeEach = utils.NOP\n\n        # new scope\n        scope = new Scope\n        scope.message = msg\n        if scope.isOnly = (opts & ONLY_OPT) > 0\n            stack.onlyScopes += 1\n        scopes.push scope\n\n        # before\/after functions\n        push.apply scope.beforeFunctions, currentScope.beforeFunctions\n        push.apply scope.afterFunctions, currentScope.afterFunctions\n\n        # save scope to parent\n        currentScope.children.push scope\n        scope.parent = currentScope\n\n        # save as last\n        currentScope = scope\n\n        # children tests\n        func()\n\n        # set parent as last\n        scopes.pop()\n        currentScope = utils.last scopes\n        return\n\n# describe.only(*String* message, *Function* tests)\n\n    exports.describe.only = (msg, func) ->\n        raportOnlyUsed()\n        exports.describe msg, func, ONLY_OPT\n\n# it(*String* message, *Function* test)\n\nThe given test function can contains optional *callback* argument.\n\n    exports.it = (msg, func, opts = 0) ->\n        testScope = currentScope\n\n        # new test\n        test = new Test\n        test.message = msg\n        test.testFunction = func\n        if test.isOnly = (opts & ONLY_OPT) > 0\n            stack.onlyTests += 1\n\n        # add test into scope\n        scope = utils.last scopes\n        scope.children.push test\n        test.parent = scope\n\n        return\n\n# it.only(*String* message, *Function* test)\n\n    exports.it.only = (msg, func) ->\n        raportOnlyUsed()\n        exports.it msg, func, ONLY_OPT\n\n# beforeEach(*Function* code)\n\n    exports.beforeEach = (func) ->\n        currentScope.beforeFunctions.push func\n        return\n\n# afterEach(*Function* code)\n\n    exports.afterEach = (func) ->\n        currentScope.afterFunctions.push func\n        return\n\n# whenChange(*Object* watchObject, *Function* callback, [*Integer* maxDelay = `1000`])\n\n    exports.whenChange = do ->\n        listeners = []\n\n        checkListeners = ->\n            i = 0\n            while i < listeners.length\n                listener = listeners[i]\n\n                if listener.test()\n                    listeners.splice i, 1\n                else\n                    i++\n\n            if listeners.length > 0\n                setImmediate checkListeners\n            return\n\n        (obj, callback, maxDelay = 1000) ->\n            listener = new Listener\n            listener.object = obj\n            listener.objectCopy = utils.clone(obj)\n            listener.callback = callback\n            listener.maxDelay = maxDelay\n\n            if listeners.length is 0\n                setImmediate checkListeners\n\n            listeners.push listener\n            return\n\n# takeScreenshot(*String|Object* options, [*Function* callback])\n\n    screenshotInitialized = false\n    exports.takeScreenshot = (opts, callback) ->\n        if typeof opts is 'string'\n            opts = expected: opts\n\n        unless opts?.expected\n            throw new Error \"'expected' path not set in takeScreenshot\"\n\n        {currentTest} = Test\n        assert.notOk currentTest.callbackCalled, \"\"\"\n            takeScreenshot called but current test '#{currentTest.getFullMessage()}' \\\n            is not pending\n        \"\"\"\n\n        currentTest.preventEnding = true\n\n        endCurrentTest = (err) ->\n            callback? err\n            currentTest.preventEnding = false\n            currentTest.onEnd err\n\n        unless screenshotInitialized\n            screenshotInitialized = true\n            screenshot.initialize (err) ->\n                if err\n                    endCurrentTest err\n                else\n                    exports.takeScreenshot opts, callback\n            return\n\n        screenshot.take opts, endCurrentTest\n        return\n\n    runTests = ->\n        [mainScope] = scopes\n        logger.onTestsStart()\n        mainScope.run ->\n            logger.onTestsEnd()\n            onTestsEnd\n                status: if stack.errors.length is 0 then 'success' else 'error'\n                testsAmount: stack.testsAmount\n                errors: stack.errors\n\n    onTestsEnd = (result) ->\n        code = if result.status is 'success' then 0 else 1\n        if process.env.NEFT_NODE\n            # give logs some time to be printed int stdout\n            setTimeout ->\n                process.exit code\n            , 100\n\n    runAutomatically = do ->\n        val = process?.env.RUN_TESTS\n        if typeof val is 'string'\n            val = try JSON.parse val\n        val ?= true\n        val\n\n    setImmediate ->\n        if runAutomatically\n            runTests()\n","old_contents":"# Testing\n\n    'use strict'\n\n    {utils, log, assert} = Neft\n    stack = require '.\/stack'\n    logger = require '.\/logger'\n    screenshot = require '.\/screenshot\/client'\n\n    {isArray} = Array\n    {push} = Array::\n    {Scope, Test, Listener} = require '.\/structure'\n\n    scopes = [new Scope]\n    currentScope = scopes[0]\n\n    ONLY_OPT = 1 << 1\n\n    raportOnlyUsed = ->\n        if process.env.CI\n            throw new Error \"Cannot use describe.only and it.only on CI\"\n        else\n            log.warn \"describe.only or it.only is used\"\n\n# describe(*String* message, *Function* tests)\n\n    exports.describe = (msg, func, opts = 0) ->\n        beforeEach = utils.NOP\n\n        # new scope\n        scope = new Scope\n        scope.message = msg\n        if scope.isOnly = (opts & ONLY_OPT) > 0\n            stack.onlyScopes += 1\n        scopes.push scope\n\n        # before\/after functions\n        push.apply scope.beforeFunctions, currentScope.beforeFunctions\n        push.apply scope.afterFunctions, currentScope.afterFunctions\n\n        # save scope to parent\n        currentScope.children.push scope\n        scope.parent = currentScope\n\n        # save as last\n        currentScope = scope\n\n        # children tests\n        func()\n\n        # set parent as last\n        scopes.pop()\n        currentScope = utils.last scopes\n        return\n\n# describe.only(*String* message, *Function* tests)\n\n    exports.describe.only = (msg, func) ->\n        raportOnlyUsed()\n        exports.describe msg, func, ONLY_OPT\n\n# it(*String* message, *Function* test)\n\nThe given test function can contains optional *callback* argument.\n\n    exports.it = (msg, func, opts = 0) ->\n        testScope = currentScope\n\n        # new test\n        test = new Test\n        test.message = msg\n        test.testFunction = func\n        if test.isOnly = (opts & ONLY_OPT) > 0\n            stack.onlyTests += 1\n\n        # add test into scope\n        scope = utils.last scopes\n        scope.children.push test\n        test.parent = scope\n\n        return\n\n# it.only(*String* message, *Function* test)\n\n    exports.it.only = (msg, func) ->\n        raportOnlyUsed()\n        exports.it msg, func, ONLY_OPT\n\n# beforeEach(*Function* code)\n\n    exports.beforeEach = (func) ->\n        currentScope.beforeFunctions.push func\n        return\n\n# afterEach(*Function* code)\n\n    exports.afterEach = (func) ->\n        currentScope.afterFunctions.push func\n        return\n\n# whenChange(*Object* watchObject, *Function* callback, [*Integer* maxDelay = `1000`])\n\n    exports.whenChange = do ->\n        listeners = []\n\n        checkListeners = ->\n            i = 0\n            while i < listeners.length\n                listener = listeners[i]\n\n                if listener.test()\n                    listeners.splice i, 1\n                else\n                    i++\n\n            if listeners.length > 0\n                setImmediate checkListeners\n            return\n\n        (obj, callback, maxDelay = 1000) ->\n            listener = new Listener\n            listener.object = obj\n            listener.objectCopy = utils.clone(obj)\n            listener.callback = callback\n            listener.maxDelay = maxDelay\n\n            if listeners.length is 0\n                setImmediate checkListeners\n\n            listeners.push listener\n            return\n\n# takeScreenshot(*String|Object* options, [*Function* callback])\n\n    screenshotInitialized = false\n    exports.takeScreenshot = (opts, callback) ->\n        if typeof opts is 'string'\n            opts = expected: opts\n\n        unless opts?.expected\n            throw new Error \"'expected' path not set in takeScreenshot\"\n\n        {currentTest} = Test\n        assert.notOk currentTest.callbackCalled, \"\"\"\n            takeScreenshot called but current test '#{currentTest.getFullMessage()}' \\\n            is not pending\n        \"\"\"\n\n        currentTest.preventEnding = true\n\n        endCurrentTest = (err) ->\n            callback? err\n            currentTest.preventEnding = false\n            currentTest.onEnd err\n\n        unless screenshotInitialized\n            screenshotInitialized = true\n            screenshot.initialize (err) ->\n                if err\n                    endCurrentTest err\n                else\n                    exports.takeScreenshot opts, callback\n            return\n\n        screenshot.take opts, endCurrentTest\n        return\n\n    runTests = ->\n        [mainScope] = scopes\n        logger.onTestsStart()\n        mainScope.run ->\n            logger.onTestsEnd()\n            onTestsEnd\n                status: if stack.errors.length is 0 then 'success' else 'error'\n                testsAmount: stack.testsAmount\n                errors: stack.errors\n\n    onTestsEnd = (result) ->\n        code = if result.status is 'success' then 0 else 1\n        if utils.isServer\n            # give logs some time to be printed int stdout\n            setTimeout ->\n                process.exit code\n            , 100\n\n    runAutomatically = do ->\n        val = process?.env.RUN_TESTS\n        if typeof val is 'string'\n            val = try JSON.parse val\n        val ?= true\n        val\n\n    setImmediate ->\n        if runAutomatically\n            runTests()\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"9b38ebee0ee2a8b78a7938f7d061bcd790815d51","subject":"Refactor:  change field assignemnts to locals and arguments in methods.","message":"Refactor:  change field assignemnts to locals and arguments in methods.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/timeline-scale-library.litcoffee","new_file":"src\/timeline-scale-library.litcoffee","new_contents":"Timeline Scale Library -- library implementation\n================================================\n\nAbstract\n--------\n\nThis file contains an implementation of timeline scale visualization in literate CoffeeScript.  Description is followed by source code with explanations.  The library is exported both as a Node module and client-side library.  For more information about this library, have a look at the [readme file](..\/README.md).\n\nThe project is hosted [here](https:\/\/github.com\/nasedil\/timeline-scale).  This project is licensed under the terms of the MIT license.\n\nThis file is written in Literate [CoffeeScript](http:\/\/coffeescript.org\/#literate), using [Github Flavored Markdown](https:\/\/help.github.com\/articles\/github-flavored-markdown\/).\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n    3. [Exports](#exports)\n    4. [Helper code](#helper-code)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/).\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming).\n * Implement beautiful, informative and concise timeline axis\/scale and try new visual and technical ideas.\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatMultiLaneAxis()`:  builds ticks and labels in several lanes, so that it is possible to see exactly which interval is displayed;  each lane shows ticks and labels for different interval types (time (up to hours), days, months, years).  Up to four lanes are displayed then.\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.\n\n  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.tickLaneMultiplier`:  how much tick length is multiplied while on next lane from current lane.\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n * `options.laneOffset`: absolute offset between lanes.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tightness: options.tightness ? 5\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          tickLaneMultiplier: options.tickLaneMultiplier ? 1.5\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n          laneOffset: options.laneOffset ? 30\n\n_Note_:  I wonder if the code above that assigns default values could be improved.  Maybe use [underscore extend](http:\/\/underscorejs.org\/#extend).\n\n#### The `formatMultiLaneAxis()` function ####\n\nThis function makes axis look like several axes stacked together, from smaller time intervals to larger, until years are shown.  That makes it complete, providing full information about the corresponding time interval.  It's arguments and return value are the same as for `formatAutomatic()`.\n\n      formatMultiLaneAxis: (interval, width = 5) ->\n        {startTimestamp, endTimestamp} = interval\n        intervalLength = endTimestamp - startTimestamp\n        width = width\n\n__TODO__:  fix saving options.\n\n        oldAxisLineOffset = @options.axisLineOffset\n\nIn the beginning we format the first lane using `formatAutomatic()`:\n\n        features = @formatAutomatic interval, width\n\nThen, we need to format lanes one by one, increasing interval type, until we it is equal to 'years'.  `intervalMultiplier` will be equal to one always on these lanes.\n\n__Note__:  switch could be changed to some array progression, should it be done?\n\n        @options.intervalMultiplier = 1\n        @options.labelPlacement = 'interval'\n        while @options.intervalType isnt 'year'\n\nWe increase interval to the next interval type interval.\n\n          switch @options.intervalType\n            when 'millisecond', 'second', 'minute', 'hour'\n              @options.intervalType = 'day'\n            when 'day', 'week'\n              @options.intervalType = 'month'\n            when 'month'\n              @options.intervalType = 'year'\n\nNow we format a lane using the new interval type and multiplier, and after changing placement options.  New data is merged with previous data.\n\n__Note__:  merging code should be done in some other function. Refactor.\n\n          @options.axisLineOffset += @options.laneOffset\n          newLane = @formatFixed interval, width\n          features =\n            lines: features.lines.concat newLane.lines\n            textLabels: features.textLabels.concat newLane.textLabels\n\n__TODO__:  these horrible options restoration shoud be rewritten with the whole otpions and argument system.\n\n        @options.axisLineOffset = oldAxisLineOffset\n        features\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has the following arguments:\n * `interval`:  a dictionary with `start` and `end` values, each are _milliseconds from Epoch_.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width) ->\n        {startTimestamp, endTimestamp} = interval\n        intervalLength = endTimestamp - startTimestamp\n        width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `@options.tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * @options.tightness < intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval.  Depending on `intervalType` we choose interval or point label placement.\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        switch @options.intervalType\n          when 'year', 'month', 'week', 'day'\n            @options.labelPlacement = 'interval'\n          else\n            @options.labelPlacement = 'point'\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each are _milliseconds from Epoch_.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {startTimestamp, endTimestamp} = interval\n        intervalLength = endTimestamp - startTimestamp\n        width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList startTimestamp, endTimestamp\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint, startTimestamp, intervalLength, width\n            x2: @timeToCoord timePoint, startTimestamp, intervalLength, width\n            y1: @options.axisLineOffset + -@options.tickLength * @options.tickTailRatio\n            y2: @options.axisLineOffset + @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timestamp in pointList\n          {\n            x: @timeToCoord timestamp, startTimestamp, intervalLength, width\n            y: @options.axisLineOffset + @options.labelOffset\n            text: @formatLabel timestamp\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        if @options.labelPlacement is 'interval'\n          for textLabel, i in textLabels when i isnt (textLabels.length-1)\n            textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n          textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, _milliseconds from Epoch_ number.\n * `end`:  when the interval ends, _milliseconds from Epoch_ number.\n\nIt returns a list of _milliseconds from Epoch_ numbers.\n\n      findPointList: (startTimestamp, endTimestamp) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timestamp = @findLeftTime startTimestamp\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timestamp]\n        until timestamp > endTimestamp\n          timestamp = @findNextPoint timestamp\n          pointList.push timestamp\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `startTimestamp`:  a point of time, _milliseconds from Epoch_ number.\n\nIt returns a `Date` object.\n\n      findLeftTime: (startTimestamp) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (week is just 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\nA special consideration is negative dates and dates before Epoch.  We need to treat them correctly too.  Arithmetic remainder function in JavaScript return negative remainder if dividend is negative.  Because of that we add divisor to such remainder in case of negative years.\n\nBut if dates are outside of allowed by JavaScript ranges (\u00b11000000000 dates from Epoch) then the behaviour is not defined.\n\n        leftTime = new Date(startTimestamp)\n        start = new Date(startTimestamp)\n        switch @options.intervalType\n          when 'year'\n            yearReminder = start.getFullYear() % @options.intervalMultiplier\n            if yearReminder < 0\n              yearReminder += @options.intervalMultiplier\n            newYear = start.getFullYear() - yearReminder\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n\nHere it can happen that `start` is actually earlier than Epoch.  Then we decrease `leftTime` first:\n\n            if start < leftTime\n              delta = 1\n              while start <= leftTime\n                leftTime = new Date leftTime.getFullYear(),\n                  leftTime.getMonth()\n                  leftTime.getDate() - delta*intervalMultiplier\n                  leftTime.getHours()\n                  leftTime.getMinutes()\n                  leftTime.getSeconds()\n                  leftTime.getMilliseconds()\n                delta *= 2\n\nNow we move forwart until we find the right point:\n\n            delta = 1048576\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime.getTime()\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime.getTime()\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\nAnd return leftTime:\n\n        leftTime.getTime()\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timestamp`:  current edge time point, _milliseconds from Epoch_ number.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timestamp) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date(timestamp)\n        timePoint = new Date(timestamp)\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `timestamp`:  time point, _milliseconds from Epoch_ number.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (timestamp, startTimestamp, intervalLength, width) ->\n        timeFromStart = timestamp - startTimestamp\n        coordinate = timeFromStart * width \/ intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `formatLabel()` function ####\n\nThis function returns text representation of date.\n\n`timestamp` is a _milliseconds from Epoch_ number.\n\nReturns a string.\n\n      formatLabel: (timestamp) ->\n        timePoint = new Date(timestamp)\n        switch @options.intervalType\n          when 'year'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setFullYear(nextTimePoint.getFullYear() - 1)\n              timePoint.getFullYear().toString() +\n                '\u2013' + nextTimePoint.getFullYear()\n            else\n              timePoint.getFullYear().toString()\n          when 'month'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setMonth(nextTimePoint.getMonth() - 1)\n              timePoint.getMonth().toString() +\n                '\u2013' + nextTimePoint.getMonth().toString()\n            else\n              timePoint.getMonth().toString()\n          when 'week'\n            if @options.labelPlacement is 'interval'\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'day'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'hour'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setHours(nextTimePoint.getHours())\n              timePoint.getHours().toString() +\n                '\u2013' + nextTimePoint.getHours().toString()\n            else\n              timePoint.getHours().toString()\n          when 'minute'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setMinutes(nextTimePoint.getMinutes())\n              timePoint.getMinutes().toString() +\n                '\u2013' + nextTimePoint.getMinutes().toString()\n            else\n              timePoint.getMinutes().toString()\n          when 'second'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setSeconds(nextTimePoint.getSeconds())\n              timePoint.getSeconds().toString() +\n                '\u2013' + nextTimePoint.getSeconds().toString()\n            else\n              timePoint.getSeconds().toString()\n          when 'millisecond'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setMilliseconds(nextTimePoint.getMilliseconds())\n              \".#{ timePoint.getMilliseconds() }\u2013.#{ nextTimePoint.getMilliseconds() }\"\n            else\n              \".#{ timePoint.getMilliseconds() }\"\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\n### Exports\n\nBoth `TimeAxisMaker` and `TimeAxisRenderer` are exported.\n\n    library =\n      TimeAxisMaker: TimeAxisMaker\n      TimeAxisRenderer: TimeAxisRenderer\n\nWe export both as a Node package and as a window property in client, depending on current environment.\n\n    if typeof module isnt \"undefined\" and module.exports\n      module.exports = library\n    else\n      window.TimelineScale = library\n\n### Helper code\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\nYou can have a look at an example in [demo.jade](src\/demo.jade) (needs to be compiled with Jade) and [timeline-library-example.litcoffee](src\/timeline-scale-example.litcoffee).\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nThis code is licensed under the terms of the MIT license.\n\n### Technical information ###\nThis file is written in Literate [CoffeeScript](http:\/\/coffeescript.org\/#literate), using [Github Flavored Markdown](https:\/\/help.github.com\/articles\/github-flavored-markdown\/).  You need to compile to get javascript code, and it is best highlighted when viewed in Github.\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline Scale Library -- library implementation\n================================================\n\nAbstract\n--------\n\nThis file contains an implementation of timeline scale visualization in literate CoffeeScript.  Description is followed by source code with explanations.  The library is exported both as a Node module and client-side library.  For more information about this library, have a look at the [readme file](..\/README.md).\n\nThe project is hosted [here](https:\/\/github.com\/nasedil\/timeline-scale).  This project is licensed under the terms of the MIT license.\n\nThis file is written in Literate [CoffeeScript](http:\/\/coffeescript.org\/#literate), using [Github Flavored Markdown](https:\/\/help.github.com\/articles\/github-flavored-markdown\/).\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n    3. [Exports](#exports)\n    4. [Helper code](#helper-code)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/).\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming).\n * Implement beautiful, informative and concise timeline axis\/scale and try new visual and technical ideas.\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatMultiLaneAxis()`:  builds ticks and labels in several lanes, so that it is possible to see exactly which interval is displayed;  each lane shows ticks and labels for different interval types (time (up to hours), days, months, years).  Up to four lanes are displayed then.\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.\n\n  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.tickLaneMultiplier`:  how much tick length is multiplied while on next lane from current lane.\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n * `options.laneOffset`: absolute offset between lanes.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tightness: options.tightness ? 5\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          tickLaneMultiplier: options.tickLaneMultiplier ? 1.5\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n          laneOffset: options.laneOffset ? 30\n\n_Note_:  I wonder if the code above that assigns default values could be improved.  Maybe use [underscore extend](http:\/\/underscorejs.org\/#extend).\n\n#### The `formatMultiLaneAxis()` function ####\n\nThis function makes axis look like several axes stacked together, from smaller time intervals to larger, until years are shown.  That makes it complete, providing full information about the corresponding time interval.  It's arguments and return value are the same as for `formatAutomatic()`.\n\n      formatMultiLaneAxis: (interval, width = 5) ->\n        {@startTimestamp, endTimestamp} = interval\n        @intervalLength = endTimestamp - @startTimestamp\n        @width = width\n\n__TODO__:  fix saving options.\n\n        oldAxisLineOffset = @options.axisLineOffset\n\nIn the beginning we format the first lane using `formatAutomatic()`:\n\n        features = @formatAutomatic interval, width\n\nThen, we need to format lanes one by one, increasing interval type, until we it is equal to 'years'.  `intervalMultiplier` will be equal to one always on these lanes.\n\n__Note__:  switch could be changed to some array progression, should it be done?\n\n        @options.intervalMultiplier = 1\n        @options.labelPlacement = 'interval'\n        while @options.intervalType isnt 'year'\n\nWe increase interval to the next interval type interval.\n\n          switch @options.intervalType\n            when 'millisecond', 'second', 'minute', 'hour'\n              @options.intervalType = 'day'\n            when 'day', 'week'\n              @options.intervalType = 'month'\n            when 'month'\n              @options.intervalType = 'year'\n\nNow we format a lane using the new interval type and multiplier, and after changing placement options.  New data is merged with previous data.\n\n__Note__:  merging code should be done in some other function. Refactor.\n\n          @options.axisLineOffset += @options.laneOffset\n          newLane = @formatFixed interval, width\n          features =\n            lines: features.lines.concat newLane.lines\n            textLabels: features.textLabels.concat newLane.textLabels\n\n__TODO__:  these horrible options restoration shoud be rewritten with the whole otpions and argument system.\n\n        @options.axisLineOffset = oldAxisLineOffset\n        features\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has the following arguments:\n * `interval`:  a dictionary with `start` and `end` values, each are _milliseconds from Epoch_.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width) ->\n        {@startTimestamp, endTimestamp} = interval\n        @intervalLength = endTimestamp - @startTimestamp\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `@options.tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * @options.tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval.  Depending on `intervalType` we choose interval or point label placement.\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        switch @options.intervalType\n          when 'year', 'month', 'week', 'day'\n            @options.labelPlacement = 'interval'\n          else\n            @options.labelPlacement = 'point'\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each are _milliseconds from Epoch_.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@startTimestamp, endTimestamp} = interval\n        @intervalLength = endTimestamp - @startTimestamp\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @startTimestamp, endTimestamp\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: @options.axisLineOffset + -@options.tickLength * @options.tickTailRatio\n            y2: @options.axisLineOffset + @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timestamp in pointList\n          {\n            x: @timeToCoord timestamp\n            y: @options.axisLineOffset + @options.labelOffset\n            text: @formatLabel timestamp\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        if @options.labelPlacement is 'interval'\n          for textLabel, i in textLabels when i isnt (textLabels.length-1)\n            textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n          textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, _milliseconds from Epoch_ number.\n * `end`:  when the interval ends, _milliseconds from Epoch_ number.\n\nIt returns a list of _milliseconds from Epoch_ numbers.\n\n      findPointList: (startTimestamp, endTimestamp) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timestamp = @findLeftTime startTimestamp\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timestamp]\n        until timestamp > endTimestamp\n          timestamp = @findNextPoint timestamp\n          pointList.push timestamp\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `startTimestamp`:  a point of time, _milliseconds from Epoch_ number.\n\nIt returns a `Date` object.\n\n      findLeftTime: (startTimestamp) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (week is just 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\nA special consideration is negative dates and dates before Epoch.  We need to treat them correctly too.  Arithmetic remainder function in JavaScript return negative remainder if dividend is negative.  Because of that we add divisor to such remainder in case of negative years.\n\nBut if dates are outside of allowed by JavaScript ranges (\u00b11000000000 dates from Epoch) then the behaviour is not defined.\n\n        leftTime = new Date(startTimestamp)\n        start = new Date(startTimestamp)\n        switch @options.intervalType\n          when 'year'\n            yearReminder = start.getFullYear() % @options.intervalMultiplier\n            if yearReminder < 0\n              yearReminder += @options.intervalMultiplier\n            newYear = start.getFullYear() - yearReminder\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n\nHere it can happen that `start` is actually earlier than Epoch.  Then we decrease `leftTime` first:\n\n            if start < leftTime\n              delta = 1\n              while start <= leftTime\n                leftTime = new Date leftTime.getFullYear(),\n                  leftTime.getMonth()\n                  leftTime.getDate() - delta*intervalMultiplier\n                  leftTime.getHours()\n                  leftTime.getMinutes()\n                  leftTime.getSeconds()\n                  leftTime.getMilliseconds()\n                delta *= 2\n\nNow we move forwart until we find the right point:\n\n            delta = 1048576\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime.getTime()\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime.getTime()\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\nAnd return leftTime:\n\n        leftTime.getTime()\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timestamp`:  current edge time point, _milliseconds from Epoch_ number.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timestamp) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date(timestamp)\n        timePoint = new Date(timestamp)\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `timestamp`:  time point, _milliseconds from Epoch_ number.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (timestamp) ->\n        timeFromStart = timestamp - @startTimestamp\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `formatLabel()` function ####\n\nThis function returns text representation of date.\n\n`timestamp` is a _milliseconds from Epoch_ number.\n\nReturns a string.\n\n      formatLabel: (timestamp) ->\n        timePoint = new Date(timestamp)\n        switch @options.intervalType\n          when 'year'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setFullYear(nextTimePoint.getFullYear() - 1)\n              timePoint.getFullYear().toString() +\n                '\u2013' + nextTimePoint.getFullYear()\n            else\n              timePoint.getFullYear().toString()\n          when 'month'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setMonth(nextTimePoint.getMonth() - 1)\n              timePoint.getMonth().toString() +\n                '\u2013' + nextTimePoint.getMonth().toString()\n            else\n              timePoint.getMonth().toString()\n          when 'week'\n            if @options.labelPlacement is 'interval'\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'day'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'hour'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setHours(nextTimePoint.getHours())\n              timePoint.getHours().toString() +\n                '\u2013' + nextTimePoint.getHours().toString()\n            else\n              timePoint.getHours().toString()\n          when 'minute'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setMinutes(nextTimePoint.getMinutes())\n              timePoint.getMinutes().toString() +\n                '\u2013' + nextTimePoint.getMinutes().toString()\n            else\n              timePoint.getMinutes().toString()\n          when 'second'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setSeconds(nextTimePoint.getSeconds())\n              timePoint.getSeconds().toString() +\n                '\u2013' + nextTimePoint.getSeconds().toString()\n            else\n              timePoint.getSeconds().toString()\n          when 'millisecond'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint.getTime()\n              nextTimePoint.setMilliseconds(nextTimePoint.getMilliseconds())\n              \".#{ timePoint.getMilliseconds() }\u2013.#{ nextTimePoint.getMilliseconds() }\"\n            else\n              \".#{ timePoint.getMilliseconds() }\"\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\n### Exports\n\nBoth `TimeAxisMaker` and `TimeAxisRenderer` are exported.\n\n    library =\n      TimeAxisMaker: TimeAxisMaker\n      TimeAxisRenderer: TimeAxisRenderer\n\nWe export both as a Node package and as a window property in client, depending on current environment.\n\n    if typeof module isnt \"undefined\" and module.exports\n      module.exports = library\n    else\n      window.TimelineScale = library\n\n### Helper code\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\nYou can have a look at an example in [demo.jade](src\/demo.jade) (needs to be compiled with Jade) and [timeline-library-example.litcoffee](src\/timeline-scale-example.litcoffee).\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nThis code is licensed under the terms of the MIT license.\n\n### Technical information ###\nThis file is written in Literate [CoffeeScript](http:\/\/coffeescript.org\/#literate), using [Github Flavored Markdown](https:\/\/help.github.com\/articles\/github-flavored-markdown\/).  You need to compile to get javascript code, and it is best highlighted when viewed in Github.\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"59c6e7c4b3e477348096b3e4bfdafc5de7dfc7dc","subject":"Accept HEAD request to \/CloudHealthCheck","message":"Accept HEAD request to \/CloudHealthCheck\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.status >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.status >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ff67bf458163833a31ad50682aba15aa75764311","subject":"fix(server): ensure http status code is valid","message":"fix(server): ensure http status code is valid\n","repos":"Turbasen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    require 'newrelic' if process.env.NODE_ENV is 'production'\n\n    raven         = require 'raven'\n    sentry        = require '.\/db\/sentry'\n    mongo         = require '@turbasen\/db-mongo'\n    redis         = require '@turbasen\/db-redis'\n    express       = require 'express'\n\n    compression   = require 'compression'\n    bodyParser    = require 'body-parser'\n    responseTime  = require 'response-time'\n\n    auth          = require '@turbasen\/auth'\n    stats         = require '@turbasen\/stats'\n    collections   = require('.\/helper\/schema').types\n\n    system        = require '.\/system'\n    collection    = require '.\/collection'\n    document      = require '.\/document'\n\n## Init\n\n    app = module.exports = express()\n\n### Configuration\n\n    app.disable 'x-powered-by'\n    app.disable 'etag'\n\n    app.use compression()\n    app.use responseTime()\n\n    app.use bodyParser.json extended: true, limit: '10mb'\n\n## GET \/favicon.ico\n\n    app.get '\/favicon.ico', (req, res) ->\n      res.set 'Content-Type': 'image\/x-icon'\n      res.status(200).end()\n\n## GET \/CloudHealthCheck\n\n    app.all '\/CloudHealthCheck', system.check\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use auth.middleware\n\n### Stats\n\nLog the request to Google Analytics using @turbasen\/stats middleware.\n\n    app.use stats.middleware\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json collections\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.status(405).json\n          message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.status(405).json\n          message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## 404 handling\n\nThis the famous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.status(404).json message: 'Ressurs ikke funnet'\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.code or err.status or 500\n\n      if res.statusCode >= 600\n        res.status 500\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.user.provider}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        # coffeelint: disable=no_debugger\n        console.error err.message\n        console.error err.stack\n        # coffeelint: enable=no_debugger\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\n## Start\n\nStart the server listening on the port defined in the `VIRTUAL_PORT` environment\nvariable or the default port `8080` if the server is running in stand alone\nmode.\n\n    if not module.parent\n\nWait for Redis and MongoDB to become aviable before accepting connections on the\nserver port.\n\n      mongo.once 'ready', ->\n        # coffeelint: disable=no_debugger\n        console.log 'Database is open...'\n\n        port = process.env.VIRTUAL_PORT || 8080\n\n        app.listen port, ->\n          console.log \"Server is listening on port #{port}\"\n        # coffeelint: enable=no_debugger\n","old_contents":"    require 'newrelic' if process.env.NODE_ENV is 'production'\n\n    raven         = require 'raven'\n    sentry        = require '.\/db\/sentry'\n    mongo         = require '@turbasen\/db-mongo'\n    redis         = require '@turbasen\/db-redis'\n    express       = require 'express'\n\n    compression   = require 'compression'\n    bodyParser    = require 'body-parser'\n    responseTime  = require 'response-time'\n\n    auth          = require '@turbasen\/auth'\n    stats         = require '@turbasen\/stats'\n    collections   = require('.\/helper\/schema').types\n\n    system        = require '.\/system'\n    collection    = require '.\/collection'\n    document      = require '.\/document'\n\n## Init\n\n    app = module.exports = express()\n\n### Configuration\n\n    app.disable 'x-powered-by'\n    app.disable 'etag'\n\n    app.use compression()\n    app.use responseTime()\n\n    app.use bodyParser.json extended: true, limit: '10mb'\n\n## GET \/favicon.ico\n\n    app.get '\/favicon.ico', (req, res) ->\n      res.set 'Content-Type': 'image\/x-icon'\n      res.status(200).end()\n\n## GET \/CloudHealthCheck\n\n    app.all '\/CloudHealthCheck', system.check\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use auth.middleware\n\n### Stats\n\nLog the request to Google Analytics using @turbasen\/stats middleware.\n\n    app.use stats.middleware\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json collections\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.status(405).json\n          message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.status(405).json\n          message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## 404 handling\n\nThis the famous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.status(404).json message: 'Ressurs ikke funnet'\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.code or err.status or 500\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.user.provider}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        # coffeelint: disable=no_debugger\n        console.error err.message\n        console.error err.stack\n        # coffeelint: enable=no_debugger\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\n## Start\n\nStart the server listening on the port defined in the `VIRTUAL_PORT` environment\nvariable or the default port `8080` if the server is running in stand alone\nmode.\n\n    if not module.parent\n\nWait for Redis and MongoDB to become aviable before accepting connections on the\nserver port.\n\n      mongo.once 'ready', ->\n        # coffeelint: disable=no_debugger\n        console.log 'Database is open...'\n\n        port = process.env.VIRTUAL_PORT || 8080\n\n        app.listen port, ->\n          console.log \"Server is listening on port #{port}\"\n        # coffeelint: enable=no_debugger\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6903fecf47e7fb0ed2db2b433e6087efaecb0270","subject":"Document Model.resourceName","message":"Document Model.resourceName\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @.primaryKey[= \"id\"] : String\n\nDefines the `Model`'s primary key. This attribute will be used for determining:\n\n- record identity (ie, records with the same `primaryKey` are assumed to be the same record)\n- whether a record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew)\n- whether records are related (see [`Batman.Model` Associations](\/docs\/api\/batman.model_associations.html))\n- URL parameters via [`toParam`](\/docs\/api\/batman.model.html#prototype_function_toparam)\n\nChange the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n      equal Shop.get('primaryKey'), 'shop_id'\n\n## @.resourceName[= null] : String\n\n`resourceName` is a minification-safe identifier for the `Model`. It is usually an underscore-cased version of the `Model`'s class name (for example, `App.BlogPost => \"blog_post\"`) . It is used by:\n\n- Model assocations (for providing default `primaryKey`s and `foreignKey`s and for `urlNestsUnder`)\n- Storage adapters (unless overriden by `storageKey`)\n- `data-route` bindings (eg, `routes.items[item]`)\n\n## @.storageKey : String\n\n`storageKey` is used as a namespace by the model's storage adapter. `Batman.LocalStorage` and `Batman.SessionStorage` use it as a JSON namespace and `Batman.RestStorage` uses it as a URL segment. If `storageKey` isn't set, `resourceName` may be used.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n\n        @validate 'title', 'body', {presence: true} # title and body must be present (not undefined nor '')\n        @validate 'body', {minLength: 10}           # body must be 10 characters long at least\n        @validate 'title', {pattern: \/^[A-Z]\/}      # Title must start with an uppercase letter\n        @validate 'author', {email: true}           # the author field must contain a valid email address\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n + `regexp : \/regexp\/` : Assert that the value is matching the provided regular expression.\n + `email : true` : Assert that the value is an email address, per the [W3C HTML5 definition](http:\/\/www.w3.org\/TR\/html5\/forms.html#valid-e-mail-address).\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\nValidations can be skipped by including a conditional check:\n\n    test '@validate accepts an if or unless option to determine whether the validation should be performed or not', ->\n      QUnit.expect(0)\n      class Invoice extends Batman.Model\n        @resourceName: 'invoice'\n        @validate 'tax_1_rate', {presence: true, if: (errors, record, key) -> record.get('tax_1_enabled')} # tax 1 rate must be present if tax 1 is enabled\n        @validate 'tax_2_rate', {presence: true, if: 'tax_2_rate'} # passing a string will look for an attribute or accessor with that name on the record\n        @validate 'discount_rate', {presence: true, unless: 'discount_disabled'} # discount rate must be present unless discount is disabled\n\n + `if`: Specifies a function or string to determine whether the validation should occur. Should return either true or false.\n + `unless`: Specifies a function or string to determine whether the validation should not occur. Should return either true or false.\n\nIf you specify the if or unless option as a string, it will do a `@get(string)` on the record being validated. Functions should have the signature `(errors, record, key)`. The arguments are as follows:\n\n + `errors`: the ErrorsSet instance\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n\n## @%loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @%all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## @createMultipleFromJSON(attributesArray: Array) : Array\n\nLoads data from JSON like `Model.createFromJSON`, but `attributesArray` is an array of objects and returns an array of records. `createMultipleFromJSON` loads new records all at once, so `Model.loaded.itemsWereAdded` is only fired once.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::isDirty() : Boolean\n\nReturns `true` if any keys have been changed since the record was initialized or saved.\n\n## ::%isDirty : Boolean\n\nA bindable accessor on [`isDirty`](\/docs\/api\/batman.model.html#prototype_function_isdirty).\n\n## ::%dirtyKeys : Set\n\nThe [`Batman.Set`](\/docs\/api\/batman.set.html) of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::constructor(idOrAttributes = {}) : Model\n\nIf `idOrAttributes` is an object, the values are mixed into the new record. Otherwise, `idOrAttrubutes` is set to the new record's [`id`](\/docs\/api\/batman.model.html#prototype_accessor_id).\n\n## ::isNew() : boolean\n\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## ::%isNew : Boolean\n\nA bindable accessor on [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew).\n\n## updateAttributes(attributes) : Model\n\nMixes in `attributes` into the record (using `set`). Doesn't save the record.\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# \/api\/App Components\/Batman.Model\/Batman.Validator\n\nbatman.js ships with a plethora of [built-in validators](\/docs\/api\/batman.model.html#class_function_validate), but when they don't meet your needs, you can create custom validators by subclassing `Batman.Validator`, implementing `Batman.Validator::validateEach`, and adding the new validator to `Batman.Validators`. For example:\n\n```coffeescript\nclass App.LessThanPropertyValidator extends Batman.Validator\n  @triggers 'lessThanProperty'\n  @options 'allowBlank'\n\n  validateEach: (errors, record, key, callback) ->\n      value = record.get(key)\n      compareKey = @options.lessThanProperty\n      otherValue = record.get(compareKey)\n      else !@handleBlank(value) && value >= otherValue\n        errors.add(key, 'must be less than #{compareKey}')\n      callback()\n\nBatman.Validators.push App.LessThanPropertyValidator\n```\n\n## ::constructor(options : Object[, mixins...])\n\nThe first argument becomes the validator's `@options`. Subsequent arguments are mixed in to the validator with `Batman.Object::mixin`. You can override this method to alter the options object before it's assigned to `@options`. (Make sure to call `super` afterwards!)\n\n## @triggers(triggers...)\n\nWhen any of the strings in `triggers` is passed to `Model@validate`:\n\n- this validator will be instantiated and its `validateEach` will be invoked\n- the key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUse this method when one validator will handle many kinds of validations. For example, a simplified length validator:\n\n```coffeescript\nclass App.SimpleLengthValidator extends Batman.Validator\n  @triggers 'minLength', 'maxLength', 'length'\n\n  constructor: (options) ->\n    # has access to options.minLength, options.maxLength, options.length\n    super\n\n  validateEach: (errors, record, key, callback) ->\n    # has access to @options.minLength, @options.maxLength, @options.length\n```\n\nAll three of these validations will be handled by `App.SimpleLengthValidator::validateEach`:\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @validate 'name', minLength: 3\n  @validate 'bio', maxLength: 250\n  @validate 'phone_number', length: 10\n```\n\n## @options(options...)\n\nThe key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUnlike `@triggers`, the presence of a key in `options` will not cause this validator to be instantiated.\n\n## ::validateEach(errors: Batman.ErrorsSet, record: Batman.Model, key: String, callback: Function)\n\nThis method is invoked to validate `key` on `record`. If this method determins that the key is invalid, it should add a validation error to `errors`.\n\n`errors` is a `Batman.ErrorsSet`, which is a [`Batman.Set`](\/docs\/api\/batman.set.html) with `::add(key, message)` as a convenience method for adding [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s. So, to easily add a new validation error:\n\n```coffeescript\nerrors.add(\"phone_number\", \"isn't 10 characters long\")\n```\n\nWhen the validator is finished, it must call `callback` to continue the validation chain.\n\n## @handleBlank(value)\n\nReturns `true` if `options.allowBlank` is `true` _and_ `value` is `null`, `undefined` or `\"\"`\n\n# \/api\/App Components\/Batman.Model\/Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey[= \"id\"] : string\n\nDefines the `Model`'s primary key. This attribute will be used for determining:\n\n- record identity (ie, records with the same `primaryKey` are assumed to be the same record)\n- whether a record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew)\n- whether records are related (see [`Batman.Model` Associations](\/docs\/api\/batman.model_associations.html))\n- URL parameters via [`toParam`](\/docs\/api\/batman.model.html#prototype_function_toparam)\n\nChange the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n      equal Shop.get('primaryKey'), 'shop_id'\n\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n\n        @validate 'title', 'body', {presence: true} # title and body must be present (not undefined nor '')\n        @validate 'body', {minLength: 10}           # body must be 10 characters long at least\n        @validate 'title', {pattern: \/^[A-Z]\/}      # Title must start with an uppercase letter\n        @validate 'author', {email: true}           # the author field must contain a valid email address\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n + `regexp : \/regexp\/` : Assert that the value is matching the provided regular expression.\n + `email : true` : Assert that the value is an email address, per the [W3C HTML5 definition](http:\/\/www.w3.org\/TR\/html5\/forms.html#valid-e-mail-address).\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\nValidations can be skipped by including a conditional check:\n\n    test '@validate accepts an if or unless option to determine whether the validation should be performed or not', ->\n      QUnit.expect(0)\n      class Invoice extends Batman.Model\n        @resourceName: 'invoice'\n        @validate 'tax_1_rate', {presence: true, if: (errors, record, key) -> record.get('tax_1_enabled')} # tax 1 rate must be present if tax 1 is enabled\n        @validate 'tax_2_rate', {presence: true, if: 'tax_2_rate'} # passing a string will look for an attribute or accessor with that name on the record\n        @validate 'discount_rate', {presence: true, unless: 'discount_disabled'} # discount rate must be present unless discount is disabled\n\n + `if`: Specifies a function or string to determine whether the validation should occur. Should return either true or false.\n + `unless`: Specifies a function or string to determine whether the validation should not occur. Should return either true or false.\n\nIf you specify the if or unless option as a string, it will do a `@get(string)` on the record being validated. Functions should have the signature `(errors, record, key)`. The arguments are as follows:\n\n + `errors`: the ErrorsSet instance\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## @createMultipleFromJSON(attributesArray: Array) : Array\n\nLoads data from JSON like `Model.createFromJSON`, but `attributesArray` is an array of objects and returns an array of records. `createMultipleFromJSON` loads new records all at once, so `Model.loaded.itemsWereAdded` is only fired once.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::isDirty() : Boolean\n\nReturns `true` if any keys have been changed since the record was initialized or saved.\n\n## ::%isDirty : Boolean\n\nA bindable accessor on [`isDirty`](\/docs\/api\/batman.model.html#prototype_function_isdirty).\n\n## ::%dirtyKeys : Set\n\nThe [`Batman.Set`](\/docs\/api\/batman.set.html) of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::constructor(idOrAttributes = {}) : Model\n\nIf `idOrAttributes` is an object, the values are mixed into the new record. Otherwise, `idOrAttrubutes` is set to the new record's [`id`](\/docs\/api\/batman.model.html#prototype_accessor_id).\n\n## ::isNew() : boolean\n\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## ::%isNew : Boolean\n\nA bindable accessor on [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew).\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# \/api\/App Components\/Batman.Model\/Batman.Validator\n\nbatman.js ships with a plethora of [built-in validators](\/docs\/api\/batman.model.html#class_function_validate), but when they don't meet your needs, you can create custom validators by subclassing `Batman.Validator`, implementing `Batman.Validator::validateEach`, and adding the new validator to `Batman.Validators`. For example:\n\n```coffeescript\nclass App.LessThanPropertyValidator extends Batman.Validator\n  @triggers 'lessThanProperty'\n  @options 'allowBlank'\n\n  validateEach: (errors, record, key, callback) ->\n      value = record.get(key)\n      compareKey = @options.lessThanProperty\n      otherValue = record.get(compareKey)\n      else !@handleBlank(value) && value >= otherValue\n        errors.add(key, 'must be less than #{compareKey}')\n      callback()\n\nBatman.Validators.push App.LessThanPropertyValidator\n```\n\n## ::constructor(options : Object[, mixins...])\n\nThe first argument becomes the validator's `@options`. Subsequent arguments are mixed in to the validator with `Batman.Object::mixin`. You can override this method to alter the options object before it's assigned to `@options`. (Make sure to call `super` afterwards!)\n\n## @triggers(triggers...)\n\nWhen any of the strings in `triggers` is passed to `Model@validate`:\n\n- this validator will be instantiated and its `validateEach` will be invoked\n- the key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUse this method when one validator will handle many kinds of validations. For example, a simplified length validator:\n\n```coffeescript\nclass App.SimpleLengthValidator extends Batman.Validator\n  @triggers 'minLength', 'maxLength', 'length'\n\n  constructor: (options) ->\n    # has access to options.minLength, options.maxLength, options.length\n    super\n\n  validateEach: (errors, record, key, callback) ->\n    # has access to @options.minLength, @options.maxLength, @options.length\n```\n\nAll three of these validations will be handled by `App.SimpleLengthValidator::validateEach`:\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @validate 'name', minLength: 3\n  @validate 'bio', maxLength: 250\n  @validate 'phone_number', length: 10\n```\n\n## @options(options...)\n\nThe key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUnlike `@triggers`, the presence of a key in `options` will not cause this validator to be instantiated.\n\n## ::validateEach(errors: Batman.ErrorsSet, record: Batman.Model, key: String, callback: Function)\n\nThis method is invoked to validate `key` on `record`. If this method determins that the key is invalid, it should add a validation error to `errors`.\n\n`errors` is a `Batman.ErrorsSet`, which is a [`Batman.Set`](\/docs\/api\/batman.set.html) with `::add(key, message)` as a convenience method for adding [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s. So, to easily add a new validation error:\n\n```coffeescript\nerrors.add(\"phone_number\", \"isn't 10 characters long\")\n```\n\nWhen the validator is finished, it must call `callback` to continue the validation chain.\n\n## @handleBlank(value)\n\nReturns `true` if `options.allowBlank` is `true` _and_ `value` is `null`, `undefined` or `\"\"`\n\n# \/api\/App Components\/Batman.Model\/Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"12b9fe98ece5120f8036b990256b97aaa22755cd","subject":"review changes","message":"review changes\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/02_helpers.litcoffee","new_file":"docs\/02_helpers.litcoffee","new_contents":"# Batman Helpers\n\nBatman includes a number of useful, general purpose helper functions and references. They can all be found attached to the `Batman` object and can optionally be exported into the global namespace with a `$` prefix.\n\n## container\n\n`Batman.container` points to either the `window` object if running in the browser, or the `global` object if running in node. This is useful if you want to add something to the global scope in all environments.\n\n## @typeOf(object) : string\n\n`typeOf` determines a more specific type of an `object` than the native `typeof` operator in JavaScript. This is useful for a number of situations like dealing with `Object` promoted strings and numbers, or arrays which look like `object`s to `typeof`. Use `typeOf` when you need more than `\"object\"` from `typeof`.\n\n_Note_: `typeOf` is substantially slower than `typeof`. `typeOf` works in a somewhat hackish manner by getting the `Object::toString` representation of the object and slicing it to retrieve the name of the constructor.\n\n    test 'typeOf returns \"String\" for both strings and Object strings', ->\n      primitive = \"test\"\n      objectified = new String(\"test\")\n      equal typeof primitive, \"string\"\n      equal typeof objectified, \"object\"\n      equal Batman.typeOf(primitive), \"String\"\n      equal Batman.typeOf(objectified), \"String\"\n\n    test 'typeOf returns Array for arrays', ->\n      array = [];\n      equal typeof array, \"object\"\n      equal Batman.typeOf(array), \"Array\"\n\n## @mixin(subject, objects...) : subject\n\n`mixin`, occasionally known elsewhere as `extend` or `merge`, flattens a series of objects onto the subject. Key\/value pairs on objects passed as later arguments (arguments with a higher index) take precedence over earlier arguments. Returns the `subject` passed in with the new values.\n\n`mixin` also has special properties that make it different than the canonical `extend` functions:\n\n 1. If the `subject` has a `set` function, `subject.set(key, value)` will be used to apply keys instead of `subject[key] = value`. This means that if the subject is a `Batman.Object`, observers and thus bindings on the object will be notified when other (Batmanified or not) objects are mixed into it.\n 2. If a mixed-in `object` has an `initialize` function defined, that function will be called and passed the `subject`. This is useful for custom extension logic, similar to `self.included` in Ruby. For this reason, the keys `initialize` and `uninitialize` are skipped by `mixin`.\n 3. `mixin` only iterates over keys for which the `hasOwnProperty` test passes.\n\n_Note_: `mixin` is destructive to (only) the first argument. If you need a non-destructive version of `mixin`, just pass an empty object as the first object, and all keys from the successive arguments will be applied to the empty object.\n\n    test 'mixin merges argument objects', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {fit: true}, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual subject, {fit: true, fly: true, funky: true}, \"the subject is modified destructively\"\n\n    test 'mixin merges argument objects', ->\n      unmodified = {fit: true}\n      deepEqual Batman.mixin({}, unmodified, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual unmodified, {fit: true}, \"argument objects are untouched allowing non-destructive merge\"\n\n    test 'mixed in objects passed as higher indexed arguments take precedence', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {x: 1, y: 1}, {x: 2}), {x: 2, y: 1}\n\n## @unmixin(subject, objects...) : subject\n\n`unmixin` \"unmerges\" the passed objects from the `subject`. If a key exists on any of the `objects` it will be `delete`d from the `subject`. Returns the `subject`.\n\n`unmixin`, similar to `mixin`, supports calling an `uninitialize` function for each of the `objects` being unmixed in. If an `uninitialize` function exists on each\n\n    test 'unmixin removes keys found on the unmixined objects on the subject', ->\n      subject = {fit: true, fly: true, funky: true}\n      deepEqual Batman.unmixin(subject, {fit: true}, {fly: true}), {funky: true}, \"unmixin returns the subject\"\n      deepEqual subject, {funky: true}, \"the subject is destructively modified.\"\n\n## @functionName(function) : string\n\n`functionName` returns the name of a given function, if any. Works with Internet Explorer 7\/8\/9, FireFox, Chrome, and Safari.\n\n    test 'functionName returns the name of a given function', ->\n      equal Batman.functionName(\"\".toString), 'toString'\n\n## @isChildOf(parent : HTMLElement, child : HTMLElement) : boolean\n\n`isChildOf` is a simple DOM helper which returns a boolean describing if the passed `child` node can be found in the descendants of the passed `parent` node.\n\n## @setImmediate(callback : Function) : object\n\n`setImmediate` (and its sister `clearImmediate`) are a more efficient version of `setTimeout(callback, 0)`. Due to timer resolution issues, setTimeout passed a timeout of 0 doesn't actually execute the function as soon as the JS execution stack has been emptied, but at minimum 4ms and maxmium 25ms after. For this reason Batman provides a cross browser implementation of `setImmediate` which does its best to call the callback immediately after the stack empties. Batman's `setImmediate` polyfill uses the native version if available, `window.postmessage` trickery if supported, and falls back on `setTimeout(->, 0)`.\n\n`setImmediate` returns a handle which can be passed to `clearImmediate` to cancel the future calling of the callback.\n\n## @clearImmediate(handle)\n\n`clearImmediate` stops the calling of a callback in the future when passed its `handle` (which is returned from the `setImmediate` call used to enqueue it).\n\n## @forEach(iterable : object, iterator : Function[, context : Object])\n\nThe `forEach` Batman helper is a universal iteration helper. When passed an `iterable` object, the helper will call the `iterator` (optionally in the `context`) for each item in the `iterable`. The `iterable` can be:\n\n 1. something which has its own `forEach`, in which case the `iterator` will just be passed to `iterable.forEach`.\n 2. an array like object, in which case a JavaScript `for(;;)` loop will be used to iterate over each entry\n 3. or an object, in which case a JavaScript `for-in` loop will be used to iterate over each entry.\n\nThe `forEach` helper is useful for iterating over objects when the type of those objects isn't guaranteed.\n\n    test 'forEach iterates over objects with forEach defined', ->\n      results = []\n      set = new Batman.SimpleSet('a')\n      Batman.forEach(set, (x) -> results.push(x))\n      deepEqual results, ['a']\n\n    test 'forEach iterates over array like objects', ->\n      results = []\n      ArrayLike = ->\n      ArrayLike:: = []\n      imitation = new ArrayLike\n      Array::push.call(imitation, \"a\")\n      Array::push.call(imitation, \"b\")\n      Batman.forEach(imitation, (x) -> results.push(x))\n      deepEqual results, ['a', 'b']\n\n    test 'forEach iterates over objects', ->\n      result = {}\n      object = {x: true}\n      Batman.forEach(object, (key, val) -> result[key] = val)\n      deepEqual result, object\n\n## @objectHasKey(object, key) : boolean\n\n`objectHasKey` returns a boolean describing the presence of the `key` in the passed `object`. `objectHasKey` delegates to the `object`'s `hasKey` function if present, and otherwise just does a check using the JavaScript `in` operator.\n\n    test 'objectHasKey verifies if a key is present in an object', ->\n      subject = {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n    test 'objectHasKey verifies if a key is present in an object with `hasKey` defined', ->\n      subject = new Batman.SimpleHash {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n## @contains(object, item) : boolean\n\n`contains` returns a boolean describing if the given `object` has member `item`. Membership in this context is defined as:\n\n + the result of `object.has(item)` if the `object` has a `has` function defined\n + the result of `item in object` if the `object` is arraylike\n + the result of the Batman.objectHasKey otherwise\n\n_Note_: When passed an object without a `has` function, `contains` will return `true` if the `object` has `item` as a *`key`*, not as a value at any key.\n\n`contains` is useful for checking item membership when the type of the object can't be relied on.\n\n## @get(object, key) : value\n\n`get` is a general purpose function for retrieving the value from a `key` on an `object` of an indeterminate type. This is useful if code needs to work with both `Batman.Object`s and Plain Old JavaScript Objects. `get` has the following semantics:\n\n + if the `object` has a `get` function defined, return the result of `object.get(key)`\n + if the object does not have a `get` function defined, use an ephemeral `Batman.Property` to retrieve the key. This is equivalent to `object[key]` for single segment `key`s, but if the `key` is multi-segment (example: 'product.customer.name'), `get` will do nested gets until the either `undefined` or the end of the keypath is reached.\n\n    test 'get returns the value at a key on a POJO', ->\n      subject = {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a key on a Batman.Object', ->\n      subject = Batman {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a deep key on a POJO', ->\n      subject = {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n    test 'get returns the value at a deep key on a Batman.Object', ->\n      subject = Batman {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n## @getPath(base, segments) : string\n\n`getPath` returns the hash value denoted by the specified path, which consists of an array of nested hash keys. See examples below for more detail.\n\n    test \"takes a base and an array of keys and returns the corresponding nested value\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo', 'bar']), 'nested value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo.bar']), 'flat value'\n      strictEqual Batman.getPath(@complexObject, ['hash', 'not-foo', 'bar']), undefined\n\n    test \"returns just the base if the key array is empty\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(@complexObject, []), @complexObject\n      strictEqual Batman.getPath(null, []), null\n\n    test \"returns undefined if the base is null-ish\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(null, ['foo']), undefined\n      strictEqual Batman.getPath(undefined, ['foo']), undefined\n\n    test \"returns falsy values\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(num: 0, ['num']), 0\n      strictEqual Batman.getPath(thing: null, ['thing']), null\n\n## @escapeHTML(input) : string\n\n`escapeHTML` takes a string of unknown origin and makes it safe for display on a web page by encoding control characters in HTML into their HTML entities.\n\n*Warning*: Do not rely on `escapeHTML` to purge unsafe data from user submitted content. While `escapeHTML` is applied to every binding's contents by default, it should not be your only line of defence against script injection attacks.\n\n    test 'escapeHTML encodes special characters into HTML entities', ->\n      equal Batman.escapeHTML(\"& < > \\\" '\"), \"&amp; &lt; &gt; &#34; &#39;\"\n\n# Batman.helpers\n\n`Batman.helpers` is a namespace for Batman's helpful string manipulation helpers.\n\n_Note_: Batman's pluralization functions mirror those of Rails' exactly.\n\n## @ordinalize(value : [number|string]) : string\n\n`ordinalize` converts a given integer into an ordinal string for describing position in a list, like 1st, 2nd, or 20th.\n\n    test 'ordinalize converts numbers to their ordinal form', ->\n      equal Batman.helpers.ordinalize(1), \"1st\"\n      equal Batman.helpers.ordinalize(\"2\"), \"2nd\"\n      equal Batman.helpers.ordinalize(1002), \"1002nd\"\n      equal Batman.helpers.ordinalize(\"1003\"), \"1003rd\"\n      equal Batman.helpers.ordinalize(-11), \"-11th\"\n      equal Batman.helpers.ordinalize(-1021), \"-1021st\"\n\n## @singularize(pluralString : string) : string\n\n`singularize` converts the plural form of a word to a singular form.\n\n    test 'singularize converts plural words to singular words', ->\n      equal Batman.helpers.singularize(\"posts\"), \"post\"\n      equal Batman.helpers.singularize(\"octopi\"), \"octopus\"\n      equal Batman.helpers.singularize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.singularize(\"word\"), \"word\"\n      equal Batman.helpers.singularize(\"CamelOctopi\"), \"CamelOctopus\"\n\n## @pluralize(singularString : string) : string\n\n`pluralize` converts the singular form of a word to the plural form.\n\n    test 'pluralize converts plural words to singular words', ->\n      equal Batman.helpers.pluralize(\"post\"), \"posts\"\n      equal Batman.helpers.pluralize(\"octopus\"), \"octopi\"\n      equal Batman.helpers.pluralize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.pluralize(\"words\"), \"words\"\n      equal Batman.helpers.pluralize(\"CamelOctopus\"), \"CamelOctopi\"\n\n## @camelize(name [, lowercaseFirstLetter = false]) : string\n\n`camelize` converts the passed `name` to UpperCamelCase. If the second argument is passed as `true`, then lowerCamelCase is returned.\n\n    test 'camelize returns the CamelCase version of an under_scored word', ->\n      equal Batman.helpers.camelize(\"batman_object\"), \"BatmanObject\"\n      equal Batman.helpers.camelize(\"batman_object\", true), \"batmanObject\"\n\n## @underscore(string) : string\n\n`underscore` returns the underscored version of a CamelCase word.\n\n    test 'underscore converts CamelCase to under_scores', ->\n      equal Batman.helpers.underscore(\"BatmanObject\"), \"batman_object\"\n\n## @capitalize(string) : string\n\n`capitalize` does a word-wise capitalization of a phrase or word.\n\n    test 'capitalize makes the first letter of each word in the string uppercase', ->\n      equal Batman.helpers.capitalize(\"batmanObject\"), \"BatmanObject\"\n      equal Batman.helpers.capitalize(\"batman object\"), \"Batman Object\"\n      equal Batman.helpers.capitalize(\"AlreadyCapitalized\"), \"AlreadyCapitalized\"\n\n## @trim(string) : string\n\n`trim` trims a string getting rid of extra white space around the string or returning an empty string if it is null.\n\n    test 'trim gets rid of space around a string', ->\n      equal Batman.helpers.trim(\"TrimRight \"), \"TrimRight\"\n      equal Batman.helpers.trim(\" TrimLeft\"), \"TrimLeft\"\n      equal Batman.helpers.trim(\" TrimBothSides \"), \"TrimBothSides\"\n      equal Batman.helpers.trim(\"AlreadyTrimmed\"), \"AlreadyTrimmed\"\n\n    test 'trim turns a null or undefined string into an empty string', ->\n      equal Batman.helpers.trim(null), \"\"\n      equal Batman.helpers.trim(undefined), \"\"\n\n## @interpolate(stringOrObject, keys) : string\n\n`interpolate` interpolates a string, filling it in with values matching interpolation keys, similar to printf variants.\n\n    test 'interpolate fills in key values globally in a string', ->\n      equal Batman.helpers.interpolate(\"%{field} must be at least %{count} characters in order for %{field} to be valid\", count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string', ->\n      equal Batman.helpers.interpolate({'other': \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string, embedded by key count', ->\n      equal Batman.helpers.interpolate({3: \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n## @humanize(string) : string\n\n`humanize` reformats a string that has a programmatic meaning (camelcased, underscored, \"_id\" suffixed) to make human-readable by separating concatenated words and\/or getting rid of the \"_id\" suffix.\n\n    test 'humanize replaces underscores and dashes with empty space', ->\n      equal Batman.helpers.humanize('underscored_string'), 'Underscored string'\n      equal Batman.helpers.humanize('dash-separated-string'), 'Dash separated string'\n\n    test 'humanize splits camel cased words by empty space', ->\n      equal Batman.helpers.humanize('CamelCasedString'), 'Camel cased string'\n\n    test 'humanize title-cases the first word', ->\n      equal Batman.helpers.humanize('lower case sentence'), 'Lower case sentence'\n\n    test 'humanize lower-cases all words after the first one', ->\n      equal Batman.helpers.humanize('Mixed Case SENTENCE'), 'Mixed case sentence'\n\n    test 'humanize gets rid of _id suffix', ->\n      equal Batman.helpers.humanize('identifying_string_id'), 'Identifying string'\n","old_contents":"# Batman Helpers\n\nBatman includes a number of useful, general purpose helper functions and references. They can all be found attached to the `Batman` object and can optionally be exported into the global namespace with a `$` prefix.\n\n## container\n\n`Batman.container` points to either the `window` object if running in the browser, or the `global` object if running in node. This is useful if you want to add something to the global scope in all environments.\n\n## @typeOf(object) : string\n\n`typeOf` determines a more specific type of an `object` than the native `typeof` operator in JavaScript. This is useful for a number of situations like dealing with `Object` promoted strings and numbers, or arrays which look like `object`s to `typeof`. Use `typeOf` when you need more than `\"object\"` from `typeof`.\n\n_Note_: `typeOf` is substantially slower than `typeof`. `typeOf` works in a somewhat hackish manner by getting the `Object::toString` representation of the object and slicing it to retrieve the name of the constructor.\n\n    test 'typeOf returns \"String\" for both strings and Object strings', ->\n      primitive = \"test\"\n      objectified = new String(\"test\")\n      equal typeof primitive, \"string\"\n      equal typeof objectified, \"object\"\n      equal Batman.typeOf(primitive), \"String\"\n      equal Batman.typeOf(objectified), \"String\"\n\n    test 'typeOf returns Array for arrays', ->\n      array = [];\n      equal typeof array, \"object\"\n      equal Batman.typeOf(array), \"Array\"\n\n## @mixin(subject, objects...) : subject\n\n`mixin`, occasionally known elsewhere as `extend` or `merge`, flattens a series of objects onto the subject. Key\/value pairs on objects passed as later arguments (arguments with a higher index) take precedence over earlier arguments. Returns the `subject` passed in with the new values.\n\n`mixin` also has special properties that make it different than the canonical `extend` functions:\n\n 1. If the `subject` has a `set` function, `subject.set(key, value)` will be used to apply keys instead of `subject[key] = value`. This means that if the subject is a `Batman.Object`, observers and thus bindings on the object will be notified when other (Batmanified or not) objects are mixed into it.\n 2. If a mixed-in `object` has an `initialize` function defined, that function will be called and passed the `subject`. This is useful for custom extension logic, similar to `self.included` in Ruby. For this reason, the keys `initialize` and `uninitialize` are skipped by `mixin`.\n 3. `mixin` only iterates over keys for which the `hasOwnProperty` test passes.\n\n_Note_: `mixin` is destructive to (only) the first argument. If you need a non-destructive version of `mixin`, just pass an empty object as the first object, and all keys from the successive arguments will be applied to the empty object.\n\n    test 'mixin merges argument objects', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {fit: true}, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual subject, {fit: true, fly: true, funky: true}, \"the subject is modified destructively\"\n\n    test 'mixin merges argument objects', ->\n      unmodified = {fit: true}\n      deepEqual Batman.mixin({}, unmodified, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual unmodified, {fit: true}, \"argument objects are untouched allowing non-destructive merge\"\n\n    test 'mixed in objects passed as higher indexed arguments take precedence', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {x: 1, y: 1}, {x: 2}), {x: 2, y: 1}\n\n## @unmixin(subject, objects...) : subject\n\n`unmixin` \"unmerges\" the passed objects from the `subject`. If a key exists on any of the `objects` it will be `delete`d from the `subject`. Returns the `subject`.\n\n`unmixin`, similar to `mixin`, supports calling an `uninitialize` function for each of the `objects` being unmixed in. If an `uninitialize` function exists on each\n\n    test 'unmixin removes keys found on the unmixined objects on the subject', ->\n      subject = {fit: true, fly: true, funky: true}\n      deepEqual Batman.unmixin(subject, {fit: true}, {fly: true}), {funky: true}, \"unmixin returns the subject\"\n      deepEqual subject, {funky: true}, \"the subject is destructively modified.\"\n\n## @functionName(function) : string\n\n`functionName` returns the name of a given function, if any. Works with Internet Explorer 7\/8\/9, FireFox, Chrome, and Safari.\n\n    test 'functionName returns the name of a given function', ->\n      equal Batman.functionName(\"\".toString), 'toString'\n\n## @isChildOf(parent : HTMLElement, child : HTMLElement) : boolean\n\n`isChildOf` is a simple DOM helper which returns a boolean describing if the passed `child` node can be found in the descendants of the passed `parent` node.\n\n## @setImmediate(callback : Function) : object\n\n`setImmediate` (and its sister `clearImmediate`) are a more efficient version of `setTimeout(callback, 0)`. Due to timer resolution issues, setTimeout passed a timeout of 0 doesn't actually execute the function as soon as the JS execution stack has been emptied, but at minimum 4ms and maxmium 25ms after. For this reason Batman provides a cross browser implementation of `setImmediate` which does its best to call the callback immediately after the stack empties. Batman's `setImmediate` polyfill uses the native version if available, `window.postmessage` trickery if supported, and falls back on `setTimeout(->, 0)`.\n\n`setImmediate` returns a handle which can be passed to `clearImmediate` to cancel the future calling of the callback.\n\n## @clearImmediate(handle)\n\n`clearImmediate` stops the calling of a callback in the future when passed its `handle` (which is returned from the `setImmediate` call used to enqueue it).\n\n## @forEach(iterable : object, iterator : Function[, context : Object])\n\nThe `forEach` Batman helper is a universal iteration helper. When passed an `iterable` object, the helper will call the `iterator` (optionally in the `context`) for each item in the `iterable`. The `iterable` can be:\n\n 1. something which has its own `forEach`, in which case the `iterator` will just be passed to `iterable.forEach`.\n 2. an array like object, in which case a JavaScript `for(;;)` loop will be used to iterate over each entry\n 3. or an object, in which case a JavaScript `for-in` loop will be used to iterate over each entry.\n\nThe `forEach` helper is useful for iterating over objects when the type of those objects isn't guaranteed.\n\n    test 'forEach iterates over objects with forEach defined', ->\n      results = []\n      set = new Batman.SimpleSet('a')\n      Batman.forEach(set, (x) -> results.push(x))\n      deepEqual results, ['a']\n\n    test 'forEach iterates over array like objects', ->\n      results = []\n      ArrayLike = ->\n      ArrayLike:: = []\n      imitation = new ArrayLike\n      Array::push.call(imitation, \"a\")\n      Array::push.call(imitation, \"b\")\n      Batman.forEach(imitation, (x) -> results.push(x))\n      deepEqual results, ['a', 'b']\n\n    test 'forEach iterates over objects', ->\n      result = {}\n      object = {x: true}\n      Batman.forEach(object, (key, val) -> result[key] = val)\n      deepEqual result, object\n\n## @objectHasKey(object, key) : boolean\n\n`objectHasKey` returns a boolean describing the presence of the `key` in the passed `object`. `objectHasKey` delegates to the `object`'s `hasKey` function if present, and otherwise just does a check using the JavaScript `in` operator.\n\n    test 'objectHasKey verifies if a key is present in an object', ->\n      subject = {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n    test 'objectHasKey verifies if a key is present in an object with `hasKey` defined', ->\n      subject = new Batman.SimpleHash {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n## @contains(object, item) : boolean\n\n`contains` returns a boolean describing if the given `object` has member `item`. Membership in this context is defined as:\n\n + the result of `object.has(item)` if the `object` has a `has` function defined\n + the result of `item in object` if the `object` is arraylike\n + the result of the Batman.objectHasKey otherwise\n\n_Note_: When passed an object without a `has` function, `contains` will return `true` if the `object` has `item` as a *`key`*, not as a value at any key.\n\n`contains` is useful for checking item membership when the type of the object can't be relied on.\n\n## @get(object, key) : value\n\n`get` is a general purpose function for retrieving the value from a `key` on an `object` of an indeterminate type. This is useful if code needs to work with both `Batman.Object`s and Plain Old JavaScript Objects. `get` has the following semantics:\n\n + if the `object` has a `get` function defined, return the result of `object.get(key)`\n + if the object does not have a `get` function defined, use an ephemeral `Batman.Property` to retrieve the key. This is equivalent to `object[key]` for single segment `key`s, but if the `key` is multi-segment (example: 'product.customer.name'), `get` will do nested gets until the either `undefined` or the end of the keypath is reached.\n\n    test 'get returns the value at a key on a POJO', ->\n      subject = {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a key on a Batman.Object', ->\n      subject = Batman {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a deep key on a POJO', ->\n      subject = {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n    test 'get returns the value at a deep key on a Batman.Object', ->\n      subject = Batman {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n## @getPath(base, segments) : string\n\n`getPath` returns the hash value denoted by the specified path, which consists of an array of nested hash keys. See examples below for more detail.\n\n    test \"takes a base and an array of keys and returns the corresponding nested value\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo', 'bar']), 'nested value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo.bar']), 'flat value'\n      strictEqual Batman.getPath(@complexObject, ['hash', 'not-foo', 'bar']), undefined\n\n    test \"returns just the base if the key array is empty\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(@complexObject, []), @complexObject\n      strictEqual Batman.getPath(null, []), null\n\n    test \"returns undefined if the base is null-ish\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(null, ['foo']), undefined\n      strictEqual Batman.getPath(undefined, ['foo']), undefined\n\n    test \"returns falsy values\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(num: 0, ['num']), 0\n      strictEqual Batman.getPath(thing: null, ['thing']), null\n\n## @escapeHTML(string) : string\n\n`escapeHTML` takes a string of unknown origin and makes it safe for display on a web page by encoding control characters in HTML into their HTML entities.\n\n*Warning*: Do not rely on `escapeHTML` to purge unsafe data from user submitted content. While `escapeHTML` is applied to every binding's contents by default, it should not be your only line of defence against script injection attacks.\n\n    test 'escapeHTML encodes special characters into HTML entities', ->\n      equal Batman.escapeHTML(\"& < > \\\" '\"), \"&amp; &lt; &gt; &#34; &#39;\"\n\n# Batman.helpers\n\n`Batman.helpers` is a namespace for Batman's helpful string manipulation helpers.\n\n_Note_: Batman's pluralization functions mirror those of Rails' exactly.\n\n## @ordinalize(value : [number|string]) : string\n\n`ordinalize` converts a given integer into an ordinal string for describing position in a list, like 1st, 2nd, or 20th.\n\n    test 'ordinalize converts numbers to their ordinal form', ->\n      equal Batman.helpers.ordinalize(1), \"1st\"\n      equal Batman.helpers.ordinalize(\"2\"), \"2nd\"\n      equal Batman.helpers.ordinalize(1002), \"1002nd\"\n      equal Batman.helpers.ordinalize(\"1003\"), \"1003rd\"\n      equal Batman.helpers.ordinalize(-11), \"-11th\"\n      equal Batman.helpers.ordinalize(-1021), \"-1021st\"\n\n## @singularize(pluralString : string) : string\n\n`singularize` converts the plural form of a word to a singular form.\n\n    test 'singularize converts plural words to singular words', ->\n      equal Batman.helpers.singularize(\"posts\"), \"post\"\n      equal Batman.helpers.singularize(\"octopi\"), \"octopus\"\n      equal Batman.helpers.singularize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.singularize(\"word\"), \"word\"\n      equal Batman.helpers.singularize(\"CamelOctopi\"), \"CamelOctopus\"\n\n## @pluralize(singularString : string) : string\n\n`pluralize` converts the singular form of a word to the plural form.\n\n    test 'pluralize converts plural words to singular words', ->\n      equal Batman.helpers.pluralize(\"post\"), \"posts\"\n      equal Batman.helpers.pluralize(\"octopus\"), \"octopi\"\n      equal Batman.helpers.pluralize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.pluralize(\"words\"), \"words\"\n      equal Batman.helpers.pluralize(\"CamelOctopus\"), \"CamelOctopi\"\n\n## @camelize(string [, lowercaseFirstLetter = false]) : string\n\n`camelize` converts the passed `string` to UpperCamelCase. If the second argument is passed as `true`, then lowerCamelCase is returned.\n\n    test 'camelize returns the CamelCase version of an under_scored word', ->\n      equal Batman.helpers.camelize(\"batman_object\"), \"BatmanObject\"\n      equal Batman.helpers.camelize(\"batman_object\", true), \"batmanObject\"\n\n## @underscore(string) : string\n\n`underscore` returns the underscored version of a CamelCase word.\n\n    test 'underscore converts CamelCase to under_scores', ->\n      equal Batman.helpers.underscore(\"BatmanObject\"), \"batman_object\"\n\n## @capitalize(string) : string\n\n`capitalize` does a word-wise capitalization of a phrase or word.\n\n    test 'capitalize makes the first letter of each word in the string uppercase', ->\n      equal Batman.helpers.capitalize(\"batmanObject\"), \"BatmanObject\"\n      equal Batman.helpers.capitalize(\"batman object\"), \"Batman Object\"\n      equal Batman.helpers.capitalize(\"AlreadyCapitalized\"), \"AlreadyCapitalized\"\n\n## @trim(string) : string\n\n`trim` trims a string getting rid of extra white space around the string or returning an empty string if it is null.\n\n    test 'trim gets rid of space around a string', ->\n      equal Batman.helpers.trim(\"TrimRight \"), \"TrimRight\"\n      equal Batman.helpers.trim(\" TrimLeft\"), \"TrimLeft\"\n      equal Batman.helpers.trim(\" TrimBothSides \"), \"TrimBothSides\"\n      equal Batman.helpers.trim(\"AlreadyTrimmed\"), \"AlreadyTrimmed\"\n\n    test 'trim turns a null or undefined string into an empty string', ->\n      equal Batman.helpers.trim(null), \"\"\n      equal Batman.helpers.trim(undefined), \"\"\n\n## @interpolate(stringOrObject, keys) : string\n\n`interpolate` interpolates a string, filling it in with values matching interpolation keys, similar to printf variants.\n\n    test 'interpolate fills in key values globally in a string', ->\n      equal Batman.helpers.interpolate(\"%{field} must be at least %{count} characters in order for %{field} to be valid\", count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string', ->\n      equal Batman.helpers.interpolate({'other': \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string, embedded by key count', ->\n      equal Batman.helpers.interpolate({3: \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n## @humanize(string) : string\n\n`humanize` reformats a string that has a programmatic meaning (camelcased, underscored, \"_id\" suffixed) to make human-readable by separating concatenated words and\/or getting rid of the \"_id\" suffix.\n\n    test 'humanize replaces underscores and dashes with empty space', ->\n      equal Batman.helpers.humanize('underscored_string'), 'Underscored string'\n      equal Batman.helpers.humanize('dash-separated-string'), 'Dash separated string'\n\n    test 'humanize splits camel cased words by empty space', ->\n      equal Batman.helpers.humanize('CamelCasedString'), 'Camel cased string'\n\n    test 'humanize title-cases the first word', ->\n      equal Batman.helpers.humanize('lower case sentence'), 'Lower case sentence'\n\n    test 'humanize lower-cases all words after the first one', ->\n      equal Batman.helpers.humanize('Mixed Case SENTENCE'), 'Mixed case sentence'\n\n    test 'humanize gets rid of _id suffix', ->\n      equal Batman.helpers.humanize('identifying_string_id'), 'Identifying string'\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"357c8594cf3b4ed848de4920e7178aa00150eb9a","subject":"Revise\\!","message":"Revise\\!\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/09_controller.litcoffee","new_file":"docs\/09_controller.litcoffee","new_contents":"# \/api\/App Components\/Batman.Controller\n\nAll controllers in a batman.js app extend `Batman.Controller`. `Batman.Controller`s are responsible for executing _actions_ which fire off requests for model data, render views, or redirect to other actions in response to navigation state changes. `Batman.Controller` is inspired by [ActionController](http:\/\/guides.rubyonrails.org\/action_controller_overview.html), a key component of Ruby on Rails.\n\n## Controller Directory\n\n`Batman.Controller`s are singletons and each controller's instance is available at `@sharedController`. Controller instances are also available at `MyApp.get('controllers')`. You can get the controller instance by the part of its name before \"Controller\", downcased. For example:\n\n```\nAlfred.TodosController.get('sharedController') # => TodosController instance\nAlfred.get('controllers.todos')                # => TodosController instance\n```\n\n## Actions\n\nEach `Batman.Controller` declares functions which represent actions to be run on a particular page. Typically, these functions will fetch data or render views:\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n  index: (params) ->\n    @set('todos', Alfred.Todo.get('all'))\n    # will automatically render Alfred.TodosIndexView with source `todos\/index`\n\n  show: (params) ->\n    Alfred.Todo.find params.id, (err, record) ->\n      throw err if err\n      @set('todo', record)\n    # will automatically render Alfred.TodosShowView with source `todos\/show`\n```\n\nActions are passed a `params` argument, which is an object containing URL parameters. Named route parameters (eg, `todos\/:id`) and query string parameters (`?key=value`) are accessible in `params`.\n\n## routingKey and Minification\n\nEach `Batman.Controller` must have a `routingKey`, which is used by the batman.js router. It also makes the app minification-safe. You can set it inside the controller definition:\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n```\n\nAn app will fail to run if a controller's `routingKey` is not defined. To disable this requirement, set `Batman.config.minificationErrors` to false.\n\n## Error Handling\n\n`Batman.Controller` has a built-in structure for handling errors that occur during controller actions. Inside a controller definition, you can map errors to handlers using `@catchError`. Then, you can wrap a storage operation callback with `@errorHandler` to have any errors caught by the defined handlers. If you use `@errorHandler`, errors without declared handlers will be thrown (since they aren't passed to the callback).\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n  # declare a handler with `@catchError`:\n  @catchError Batman.StorageAdapter.NotFoundError, with: 'render404'\n\n  show: (params) ->\n    # wrap your storage operation in `@errorHandler`\n    App.Todo.find params.id, @errorHandler (record, env) =>\n      @set('todo', record)\n\n  # error is passed to the handler\n  render404: (error) -> @render(source: \"errors\/404\")\n```\n\nUsually, you want to declare error handlers in `MyApp.ApplicationController`, then extend `MyApp.ApplicationController` in your other controllers:\n\n```coffeescript\nclass Alfred.ApplicationController extends Batman.Controller\n  @catchError Batman.StorageAdapter.NotFoundError, with: 'render404'\n  # etc...\n\nclass Alfred.TodosController extends Alfred.ApplicationController\n  # will use ApplicationController's handlers for @errorHandler\n```\n\nFor a full list of storage errors, see [`Batman.StorageAdapter` Errors](\/docs\/api\/batman.storageadapter_errors.html).\n\n## ::render([options : [Object|boolean]])\n\n`render` is used to control the rendering of the current action. Unless specified otherwise, `Batman.Controller` actions render automatically.\n\nPassing `false` will prevent the current action from rendering the view.\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  actionWithNoRender: ->\n    @render(false) # no view will be rendered\n\n  actionWithDelayedRender: ->\n    setTimeout (-> @render()), 1000 # view rendered after 1 second\n    @render(false)\n```\n\nBy passing an `options` object, you may override the default `view`, `source`, `viewClass` or `yield` block.\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  actionWithCustomSource: ->\n    @render(source: 'errors\/404')\n\n  actionWithCustomYield: ->\n    @render(into: 'not-main')\n```\n\nFor more information on yield blocks, see [`Controller::.defaultRenderYield`](\/docs\/api\/batman.controller.html#prototype_property_defaultrenderyield).\n\n## @beforeAction([options : [string|Object],] filter : [string|Function])\n\nDeclares that a function should be executed should be executed before this controller's actions. If any `beforeAction` filter returns `false` or calls [`@redirect`](\/docs\/api\/batman.controller.html#prototype_function_redirect), the controller action won't be executed. `@beforeAction` accepts:\n\n-  `options` representing which action(s) to execute the filter before (optional)\n-  `filter`, either a string naming a function _or_ a function to execute.\n\nThe `options` argument can take three forms:\n\n 1. `undefined`: this filter should be executed before all actions.\n 2. `String`: this filter should be executed before the action named by the string.\n 3. `Object`: this filter should be executed before the actions named by an Array at the `only` key in the options object, or before all actions excluding those named by an Array at the `except` key in the options object.\n\n    test \"@beforeAction allows declaration of filters to execute before an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n    test \"@beforeAction allows declaration of named filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"show\", \"fetchTodo\"\n        fetchTodo: -> @set(\"todo\", {isDone: true})\n        show: ->\n          @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n\n    test \"@beforeAction allows whitelisting or blacklisting filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: [\"show\", \"edit\"], \"fetchTodo\"\n        @beforeAction except: [\"index\"], \"prepareNewTodo\"\n        fetchTodo: -> @set \"todo\", {isDone: true}\n        prepareNewTodo: -> @set \"newTodo\", {isDone: false}\n        index: -> @render false\n        show: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n      deepEqual controller.get(\"newTodo\"), {isDone: false}\n\n    test \"@beforeAction allows declaration of filters to execute before all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n## @afterAction([options : [string|Object],] filter : [string|Function])\n\nDeclares that a function should be executed after this controller's actions (and after any `render` or `redirect`s). `@afterAction` accepts `options` and `filter` (see [`@beforeAction`](\/docs\/api\/batman.controller.html#class_function_beforeaction)).\n\n    test \"@afterAction allows declaration of filters to execute after an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n    test \"@afterAction allows declaration of named filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"create\", \"notify\"\n        notify: -> result = \"Todo created successfully.\"\n        create: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows whitelisting or blacklisting filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: [\"create\", \"update\"], \"notify\"\n        index: -> @render false\n        create: -> @render false\n        notify: -> result = \"Todo created successfully.\"\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal result, null\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows declaration of filters to execute after all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n## ::executeAction(action: string[, params: Object])\n\nRuns the `action` specified, including all applicable `@beforeAction`s and `@afterAction`s. Optionally, `params` can be passed into the new action for processing. If no params are passed, it will default to the params of the current action.\n\n    test \"executeAction will run the action and all @beforeAction and @afterAction filters\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n        other: ->\n          @executeAction(\"index\")\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      deepEqual results, [\"before!\", \"action!\", \"after!\"]\n\n## ::redirect(options: [string|Object])\n\nProperly handles the controller filter chain and loads a new page with [`Batman.redirect`](\/docs\/api\/batman.html#class_function_redirect). See [`Batman.redirect`](\/docs\/api\/batman.html#class_function_redirect) for allowed `options`. If `options` is an object, the current controller will be added as the object's `controller` attribute (if it isn't already present), so calling `@redirect({action: \"show\", id: itemId})` is equivalent to calling `@redirect({action: 'show', id: itemId, controller: 'items'})`.\n\n## ::scrollToHash([hash: string])\n\n`scrollToHash` emulates the native scrolling behaviour of the browser by allowing the URL to link to a specific ID on the page. The code will look for an element with a matching ID to `hash` if it is provided otherwise using the `#` parameter in the URL. If an element is found, the page will scroll to the matching element.\n\n## ::.autoScrollToHash[= true] : boolean\n\nSpecifies if the controller should automatically scroll to the element with ID equal to the `hash` parameter. This behaviour emulates the native behaviour of the same nature, but is implemented in Batman so the functionality works after each dispatch (instead of each page refresh) and when Batman is using hash bang routing.\n\n## ::.defaultRenderYield[= 'main'] : string\n\n`defaultRenderYield` specifies which yield (see [`data-yield`](\/docs\/api\/batman.view_bindings.html#data-yield)) a controller should automatically render into if no yield is declared.\n\n## @catchError(errorClasses..., {with : [String|Array]})\n\nDeclares that errors which are `instanceof` any of `errorClasses` should be handled by `with` when using [`@errorHandler`](\/docs\/api\/batman.controller.html#class_function_errorhandler). `with` is the name of a prototype function (or an array of names) which will be invoked with the error. See [\"Error Handling\"](\/docs\/api\/batman.controller.html#error_handling).\n\n## @errorHandler(callback)\n\nWraps a storage action, passing the first argument (`error`) to error handlers declared with [`@catchError`](\/docs\/api\/batman.controller.html#class_function_catcherror). Callback should take arguments `result, env` (`error` is not present because it was passed to error handlers). See [\"Error Handling\"](\/docs\/api\/batman.controller.html#error_handling).\n","old_contents":"# \/api\/App Components\/Batman.Controller\n\nAll controllers in a batman.js app extend `Batman.Controller`. `Batman.Controller`s are responsible for executing _actions_ which fire off requests for model data, render views, or redirect to other actions in response to navigation state changes. `Batman.Controller` is inspired by [ActionController](http:\/\/guides.rubyonrails.org\/action_controller_overview.html), a key component of Ruby on Rails.\n\n## Controller Directory\n\n`Batman.Controller`s are singletons and each controller's instance is available at `@%sharedController`. Controller instances are also available at `App.get('controllers')`. You can get the controller instance by the part of its name before \"Controller\", downcased. For example:\n\n```\nAlfred.TodosController.get('sharedController') # => TodosController instance\nAlfred.get('controllers.todos')                # => TodosController instance\n```\n\n## Actions\n\nEach `Batman.Controller` should have instance functions which can fetchdata and often render a view (or views):\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n  index: (params) ->\n    @set('todos', Alfred.Todo.get('all'))\n    # will automatically render Alfred.TodosIndexView with source `todos\/index`\n\n  show: (params) ->\n    Alfred.Todo.find params.id, (err, record) ->\n      throw err if err\n      @set('todo', record)\n    # will automatically render Alfred.TodosShowView with source `todos\/show`\n```\n\nActions take a `params` argument, which is a JavaScript object containing URL parameters. Named route parameters (eg, `todos\/:id`) and query string parameters (`?key=value`) are accessible in `params`.\n\n## routingKey and Minification\n\nAll `Batman.Controller` prototypes must have a `routingKey`. It is a string which serves as the controller's name and is used by the batman.js router. It also makes the app minification-safe. You can set it inside the controller definition:\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n```\n\nAn app will fail to run if a controller's `routingKey` is not defined on the prototype. To disable this requirement, set `Batman.config.minificationErrors` to false.\n\n## Error Handling\n\n`Batman.Controller` has a built-in structure for handling errors that occur during controller actions. Inside a controller definition, you can map errors to handlers using `@catchError`. Then, when you make a storage operation (such as reading, saving, or destroying), you can wrap your callback in `@errorHandler` so that, if an error is present, it will be handled by the assigned handler. Errors without declared handlers will be thrown.\n\n```coffeescript\nclass App.TodosController extends Batman.Controller\n  routingKey: 'todos'\n  # declare a handler with `@catchError`:\n  @catchError Batman.StorageAdapter.NotFoundError, with: 'render404'\n\n  show: (params) ->\n    # wrap your storage operation in `@errorHandler`\n    App.Todo.find params.id, @errorHandler (record, env) =>\n      @set('todo', record)\n\n  # error is passed to the handler\n  render404: (error) -> @render(source: \"errors\/404\")\n```\n\nFor a full list of storage errors, see [`Batman.StorageAdapter` Errors](\/docs\/api\/batman.storageadapter_errors.html).\n\n## ::render([options : [Object|boolean]])\n\n`render` is used to control the rendering of the current action. Unless specified otherwise, `Batman.Controller` actions render automatically.\n\nPassing `false` will prevent the current action from rendering the view.\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  nonVisibleAction: ->\n    @render(false) # no view will be rendered\n\n  delayedRender: ->\n    setTimeout (-> @render()), 1000 # view rendered after 1 second\n    @render(false)\n```\n\nBy passing an `options` object, you may override the default `view`, `source`, `viewClass` or `yield` block.\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  customSource: ->\n    @render(source: 'errors\/404')\n\n  customYield: ->\n    @render(into: 'not-main')\n```\n\nFor more information on yield blocks, see [`Controller::.defaultRenderYield`](\/docs\/api\/batman.controller.html#prototype_property_defaultrenderyield).\n\n## @beforeAction([options : [string|Object],] filter : [string|Function])\n\nDeclares that a function should be executed before the body of a controller action. If any `beforeAction` filter returns `false` or calls [`@redirect`](\/docs\/api\/batman.controller.html#prototype_function_redirect), the controller action won't be executed. `@beforeAction` accepts:\n\n-  `options` representing which action(s) to execute the filter before (optional)\n-  `filter`, either a string naming a function _or_ a function to execute.\n\nThe `options` argument can take three forms:\n\n 1. `undefined`: this filter should be executed before all actions.\n 2. `String`: this filter should be executed before the action named by the string.\n 3. `Object`: this filter should be executed before the actions named by an Array at the `only` key in the options object, or before all actions excluding those named by an Array at the `except` key in the options object.\n\n    test \"@beforeAction allows declaration of filters to execute before an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n    test \"@beforeAction allows declaration of named filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"show\", \"fetchTodo\"\n        fetchTodo: -> @set(\"todo\", {isDone: true})\n        show: ->\n          @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n\n    test \"@beforeAction allows whitelisting or blacklisting filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: [\"show\", \"edit\"], \"fetchTodo\"\n        @beforeAction except: [\"index\"], \"prepareNewTodo\"\n        fetchTodo: -> @set \"todo\", {isDone: true}\n        prepareNewTodo: -> @set \"newTodo\", {isDone: false}\n        index: -> @render false\n        show: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n      deepEqual controller.get(\"newTodo\"), {isDone: false}\n\n    test \"@beforeAction allows declaration of filters to execute before all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n## @afterAction([options : [string|Object],] filter : [string|Function])\n\nDeclares that a function should be executed after the body of a controller action (and therefore after any `render` or `redirect`s). `@afterAction` accepts `options` and `filter` (see [`@beforeAction`](\/docs\/api\/batman.controller.html#class_function_beforeaction)).\n\n    test \"@afterAction allows declaration of filters to execute after an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n    test \"@afterAction allows declaration of named filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"create\", \"notify\"\n        notify: -> result = \"Todo created successfully.\"\n        create: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows whitelisting or blacklisting filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: [\"create\", \"update\"], \"notify\"\n        index: -> @render false\n        create: -> @render false\n        notify: -> result = \"Todo created successfully.\"\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal result, null\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows declaration of filters to execute after all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n## ::executeAction(action: string[, params: Object])\n\nRuns the `action` specified, including all applicable `@beforeAction`s and `@afterAction`s. Optionally, `params` can be passed into the new action for processing. If no params are passed, it will default to the params of the current action.\n\n    test \"executeAction will run the action and all @beforeAction and @afterAction filters\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n        other: ->\n          @executeAction(\"index\")\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      deepEqual results, [\"before!\", \"action!\", \"after!\"]\n\n## ::redirect(options: [string|Object])\n\nProperly handles the controller filter chain and loads a new page with [`Batman.redirect`](\/docs\/api\/batman.html#class_function_redirect). See [`Batman.redirect`](\/docs\/api\/batman.html#class_function_redirect) for allowed `options`. If `options` is an object, the current controller will be added as the object's `controller` attribute (if it isn't already present), so calling `@redirect({action: \"show\", id: itemId})` is equivalent to calling `@redirect({action: 'show', id: itemId, controller: 'items'})`.\n\n## ::scrollToHash([hash: string])\n\n`scrollToHash` emulates the native scrolling behaviour of the browser by allowing the URL to link to a specific ID on the page. The code will look for an element with a matching ID to `hash` if it is provided otherwise using the `#` parameter in the URL. If an element is found, the page will scroll to the matching element.\n\n## ::.autoScrollToHash[= true] : boolean\n\nSpecifies if the controller should automatically scroll to the element with ID equal to the `hash` parameter. This behaviour emulates the native behaviour of the same nature, but is implemented in Batman so the functionality works after each dispatch (instead of each page refresh) and when Batman is using hash bang routing.\n\n## ::.defaultRenderYield[= 'main'] : string\n\n`defaultRenderYield` specifies which yield (see [`data-yield`](\/docs\/api\/batman.view_bindings.html#data-yield)) a controller should automatically render into if no yield is declared.\n\n## @catchError(errorClasses..., {with : [String|Array]})\n\nDeclares that errors which are `instanceof` any of `errorClasses` should be handled by `with` when using [`@errorHandler`](\/docs\/api\/batman.controller.html#class_function_errorhandler). `with` is the name of a prototype function (or an array of names) which will be invoked with the error. See [\"Error Handling\"](\/docs\/api\/batman.controller.html#error_handling).\n\n## @errorHandler(callback)\n\nWraps a storage action, passing the first argument (`error`) to error handlers declared with [`@catchError`](\/docs\/api\/batman.controller.html#class_function_catcherror). Callback should take arguments `result, env` (`error` is not present because it was passed to error handlers). See [\"Error Handling\"](\/docs\/api\/batman.controller.html#error_handling).\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fa965e5ff52e93c5bbe9fd0b96c975c9a0298fc6","subject":"added links","message":"added links\n","repos":"nhz-io\/cnl","old_file":"source\/test\/index.litcoffee","new_file":"source\/test\/index.litcoffee","new_contents":"# cnl tests\n* Parent: [Index][Parent]\n\n## [Engine Test][EngineTest]\n\n    test = require '.\/engine'\n    test (require '..\/engine'), 'Engine'\n\n## [Element Test][ElementTest]\n  \n    test = require '.\/element'\n    test (require '..\/element'), 'Element'\n    test (require '..\/component'), 'Component'\n\n## [Shape Test][ShapeTest]\n    \n    test = require '.\/shape'\n    test (require '..\/shape'), 'Shape'\n\n## [Pen Test][PenTest]\n  \n    test = require '.\/pen'\n    test (require '..\/pen'), 'Pen'\n\n## [Style Test][StyleTest]\n    \n    test = require '.\/style'\n    test (require '..\/style'), 'Style'\n\n[Parent]: ..\/index.litcoffee\n\n[Engine]: ..\/engine.litcoffee\n[Element]: ..\/element.litcoffee\n[Shape]: ..\/shape.litcoffee\n[Pen]: ..\/pen.litcoffee\n[Style]: ..\/style.litcoffee\n\n[EngineTest]: .\/engine.litcoffee\n[ElementTest]: .\/element.litcoffee\n[ShapeTest]: .\/shape.litcoffee\n[PenTest]: .\/pen.litcoffee\n[StyleTest]: .\/style.litcoffee\n","old_contents":"# ecl tests\n* Parent: [Index][Parent]\n\n## [Engine Test][EngineTest]\n\n    test = require '.\/engine'\n    test (require '..\/engine'), 'Engine'\n\n## [Element Test][ElementTest]\n  \n    test = require '.\/element'\n    test (require '..\/element'), 'Element'\n    test (require '..\/component'), 'Component'\n\n## [Shape Test][ShapeTest]\n    \n    test = require '.\/shape'\n    test (require '..\/shape'), 'Shape'\n\n## [Pen Test][PenTest]\n  \n    test = require '.\/pen'\n    test (require '..\/pen'), 'Pen'\n\n## [Style Test][StyleTest]\n    \n    test = require '.\/style'\n    test (require '..\/style'), 'Style'\n\n[Engine]: ..\/evented.litcoffee\n[EngineTest]: .\/evented.litcoffee\n[Parent]: ..\/index.litcoffee\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"de8c3d00bc38798faa7b237076237f47b308238c","subject":"sucessful login redirects to directory","message":"sucessful login redirects to directory\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/lib\/routes\/index.litcoffee","new_file":"src\/lib\/routes\/index.litcoffee","new_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n      \n## Function cache(res, seconds)\n\nSet cache headers on this response.\n\nUsage: `cache(res,86400)`\n\n      cache = (res,seconds) ->\n        res.header 'Cache-control', 'Cache-Control:public, max-age='+seconds\n        \n## Function nocache(res)\n\nSet uncacheable headers on this response\n\nUsage: `nocache(res)`\n\n      nocache = (res) ->\n        res.header 'Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0'\n\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        cache res, 2592000\n        res.redirect '\/page\/index'\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        app.models.page.get req.params.name, (err, page) ->\n          if err\n            console.error 'page '+req.params.name+' not found in db, showing 500'\n            nocache res\n            res.render 'error\/500'\n          else\n            cache res, 86400\n            res.render 'page\/dynamic', page\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n<!-- ' -->\n\n      app.post '\/page\/_post', (req, res) ->\n        nocache res\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          content: 'Hello world, from inside the DB'\n        app.models.page sample, (err, page) ->\n          if err\n            page = \n              name: 'error'\n              title: 'Error'\n              content: 'There was an error posting your page, please try again.'\n          res.render 'page\/dynamic', page\n          \n## GET \/login\n\nRender static pages at \/view\/login\/index.html\n\nAnd never cache the login page, it breaks csrf\n\n      app.get '\/login', (req, res) ->\n        nocache res\n        res.render 'login'\n\n          \n## POST \/login\/_post\n\nDo Login action, and redirect as appropriate.\n\n      app.post '\/login\/_post', (req, res) ->\n        nocache res\n        require('..\/login').checkUser req.body.username, req.body.password, (user, securityLevel) ->\n          console.info 'login callback = '+user+', '+securityLevel\n          req.session.user = user\n          req.session.securityLevel = securityLevel\n          res.cookie 'nocache', '1'\n          if securityLevel\n            res.redirect '\/directory'\n          else\n            res.redirect '\/login'\n\n## GET \/login\/clear\n\nLogout from the website by clearing the session\n\n      app.get '\/login\/clear', (req, res) ->\n        nocache res\n        req.session.destroy (err) ->\n          res.clearCookie 'nocache'\n          res.redirect '\/login'\n\n## GET \/directory\n \nDownload PDF to browser\n\n      app.get '\/directory', (req, res) ->\n        nocache res\n        if req.session.securityLevel\n          request = require 'request'\n          request app.directory_url, (err, cbres, data) ->\n            if err or cbres.statusCode != 200\n              res.render 500, 'Error retrieving full directory'\n            else\n              dir = JSON.parse data\n              page = \n                name: 'Full Directory'\n                title: 'Full Directory'\n                directory: dir.data\n                helpers:\n                  month: (num) ->\n                    return [null, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'][num]\n              res.render 'directory', page\n        else\n          res.redirect '\/login'\n\n\n## GET \/directory\/directory.pdf\n \nDownload PDF to browser\n\n      app.get '\/directory\/directory.pdf', (req, res) ->\n        nocache res\n        if req.session.securityLevel\n          res.download 'protected\/directory.pdf'\n        else\n          res.redirect '\/login'\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n      \n## Function cache(res, seconds)\n\nSet cache headers on this response.\n\nUsage: `cache(res,86400)`\n\n      cache = (res,seconds) ->\n        res.header 'Cache-control', 'Cache-Control:public, max-age='+seconds\n        \n## Function nocache(res)\n\nSet uncacheable headers on this response\n\nUsage: `nocache(res)`\n\n      nocache = (res) ->\n        res.header 'Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0'\n\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        cache res, 2592000\n        res.redirect '\/page\/index'\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        app.models.page.get req.params.name, (err, page) ->\n          if err\n            console.error 'page '+req.params.name+' not found in db, showing 500'\n            nocache res\n            res.render 'error\/500'\n          else\n            cache res, 86400\n            res.render 'page\/dynamic', page\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n<!-- ' -->\n\n      app.post '\/page\/_post', (req, res) ->\n        nocache res\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          content: 'Hello world, from inside the DB'\n        app.models.page sample, (err, page) ->\n          if err\n            page = \n              name: 'error'\n              title: 'Error'\n              content: 'There was an error posting your page, please try again.'\n          res.render 'page\/dynamic', page\n          \n## GET \/login\n\nRender static pages at \/view\/login\/index.html\n\nAnd never cache the login page, it breaks csrf\n\n      app.get '\/login', (req, res) ->\n        nocache res\n        res.render 'login'\n\n          \n## POST \/login\/_post\n\nDo Login action, and redirect as appropriate.\n\n      app.post '\/login\/_post', (req, res) ->\n        nocache res\n        require('..\/login').checkUser req.body.username, req.body.password, (user, securityLevel) ->\n          console.info 'login callback = '+user+', '+securityLevel\n          req.session.user = user\n          req.session.securityLevel = securityLevel\n          res.cookie 'nocache', '1'\n          if securityLevel\n            res.redirect '\/'\n          else\n            res.redirect '\/login'\n\n## GET \/login\/clear\n\nLogout from the website by clearing the session\n\n      app.get '\/login\/clear', (req, res) ->\n        nocache res\n        req.session.destroy (err) ->\n          res.clearCookie 'nocache'\n          res.redirect '\/login'\n\n## GET \/directory\n \nDownload PDF to browser\n\n      app.get '\/directory', (req, res) ->\n        nocache res\n        if req.session.securityLevel\n          request = require 'request'\n          request app.directory_url, (err, cbres, data) ->\n            if err or cbres.statusCode != 200\n              res.render 500, 'Error retrieving full directory'\n            else\n              dir = JSON.parse data\n              page = \n                name: 'Full Directory'\n                title: 'Full Directory'\n                directory: dir.data\n                helpers:\n                  month: (num) ->\n                    return [null, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'][num]\n              res.render 'directory', page\n        else\n          res.redirect '\/login'\n\n\n## GET \/directory\/directory.pdf\n \nDownload PDF to browser\n\n      app.get '\/directory\/directory.pdf', (req, res) ->\n        nocache res\n        if req.session.securityLevel\n          res.download 'protected\/directory.pdf'\n        else\n          res.redirect '\/login'\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"48547a5c7368e34f82c25830335cbea2aa45d7b9","subject":"Add the zone selection output","message":"Add the zone selection output\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/managers\/container.litcoffee","new_file":"src\/coffee\/managers\/container.litcoffee","new_contents":"Container Manager\n=================\n\nThis manager defines the visibility of the individual display\ncontainers. It is driven chiefly by the display selector.\n\nLike all managers, it is run on a jQuery callback so that it executes\nafter the DOM has already been loaded.\n\n    $ ->\n\nWe bind the selected display's equivalence to the string 'default'\nfor the visibility of the default container.\n\n        SelectedDisplay.map( (x) -> x is 'default' )\n                       .assign $('#default'), 'toggle'\n\nIt is left as an exercise to the reader to guess how the rest of these go...\n\n        SelectedDisplay.map( (x) -> x is 'no-entry' )\n                       .assign $('#no-entry'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'kill-origin' )\n                       .assign $('#kill-origin'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'match-display' )\n                       .assign $('#match-display'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'match-sched' )\n                       .assign $('#match-sched'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'league-state' )\n                       .assign $('#league-state'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'knockout-state' )\n                       .assign $('#knockout-state'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'next-match' )\n                       .assign $('#next-match'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'day-sched' )\n                       .assign $('#day-sched'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'layout' )\n                       .assign $('#layout'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'arena-entrance' )\n                       .assign $('#arena-entrance'), 'toggle'\n        SelectedDisplay.map( (x) -> \/zone-\/.match x )\n                       .assign $('#zone'), 'toggle'\n\nSelected Zone\n-------------\n\nWe get the selected zone from the selected display.\n\n        window.SelectedZone =\n            SelectedDisplay.map( (x) -> \/zone-([0-3])\/.exec x )\n                           .filter( (x) -> x? )\n                           .map( (x) -> parseInt(x[1]) )\n                           .toProperty(0)\n                           .skipDuplicates()\n\n","old_contents":"Container Manager\n=================\n\nThis manager defines the visibility of the individual display\ncontainers. It is driven chiefly by the display selector.\n\nLike all managers, it is run on a jQuery callback so that it executes\nafter the DOM has already been loaded.\n\n    $ ->\n\nWe bind the selected display's equivalence to the string 'default'\nfor the visibility of the default container.\n\n        SelectedDisplay.map( (x) -> x is 'default' )\n                       .assign $('#default'), 'toggle'\n\nIt is left as an exercise to the reader to guess how the rest of these go...\n\n        SelectedDisplay.map( (x) -> x is 'no-entry' )\n                       .assign $('#no-entry'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'kill-origin' )\n                       .assign $('#kill-origin'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'match-display' )\n                       .assign $('#match-display'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'match-sched' )\n                       .assign $('#match-sched'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'league-state' )\n                       .assign $('#league-state'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'knockout-state' )\n                       .assign $('#knockout-state'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'next-match' )\n                       .assign $('#next-match'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'day-sched' )\n                       .assign $('#day-sched'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'zone' )\n                       .assign $('#zone'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'layout' )\n                       .assign $('#layout'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'arena-entrance' )\n                       .assign $('#arena-entrance'), 'toggle'\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cab804fbd2d675faa9a7598b27c03a9833ed2ffb","subject":"<script> with absolute src fixed on win","message":"<script> with absolute src fixed on win\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/document\/file\/parse\/scripts.litcoffee","new_file":"src\/document\/file\/parse\/scripts.litcoffee","new_contents":"# script\n\n    'use strict'\n\n    fs = require 'fs-extra'\n    os = require 'os'\n    utils = require 'src\/utils'\n    pathUtils = require 'path'\n    {getFilePath} = require '.\/links'\n\n    OUT_DIR = 'build\/scripts\/'\n    DEFAULT_FILE_EXT = '.js'\n\n    isCoffee = (path) -> \/\\.(?:coffee|litcoffee|coffee\\.md)$\/.test(path)\n\n    module.exports = (File) -> (file) ->\n        if file instanceof File.Iterator\n            return\n\n        scripts = []\n\n        for tag, i in file.node.queryAll('script')\n            omit = false\n            for attr of tag.attrs\n                if attr not in ['src', 'href', 'filename']\n                    omit = true\n                    break\n            if omit\n                continue\n\n            tag.parent = null\n\n            {src} = tag.attrs\n            src ||= tag.attrs.href\n\n            if src\n                # file\n                filename = getFilePath File, file, src\n                script = fs.readFileSync filename, 'utf-8'\n            else\n                # tag\n                script = tag.stringifyChildren()\n                {filename} = tag.attrs\n                if isCoffee(filename)\n                    script = \"`module.exports = function(){`\\n\\n#{script}\\n\\n`};`\"\n                else\n                    script = \"module.exports = function(){\\n\\n#{script}\\n\\n};\"\n\n            filePath = file.path\n\n            # support win absolute paths\n            if pathUtils.isAbsolute(filePath)\n                filePath = encodeURIComponent filePath\n\n            name = \"#{filePath}##{i}\"\n            extname = (filename and pathUtils.extname(filename)) or DEFAULT_FILE_EXT\n            path = pathUtils.join OUT_DIR, name + extname\n            fs.outputFileSync path, script\n            File.Scripts.scripts[name] = require path\n            scripts.push name\n\n        file.scripts = new File.Scripts file, scripts\n\n        return\n\n# Glossary\n\n- [script](#neftscript)\n","old_contents":"# script\n\n    'use strict'\n\n    fs = require 'fs-extra'\n    os = require 'os'\n    utils = require 'src\/utils'\n    pathUtils = require 'path'\n    {getFilePath} = require '.\/links'\n\n    OUT_DIR = 'build\/scripts\/'\n    DEFAULT_FILE_EXT = '.js'\n\n    isCoffee = (path) -> \/\\.(?:coffee|litcoffee|coffee\\.md)$\/.test(path)\n\n    module.exports = (File) -> (file) ->\n        if file instanceof File.Iterator\n            return\n\n        scripts = []\n\n        for tag, i in file.node.queryAll('script')\n            omit = false\n            for attr of tag.attrs\n                if attr not in ['src', 'href', 'filename']\n                    omit = true\n                    break\n            if omit\n                continue\n\n            tag.parent = null\n\n            {src} = tag.attrs\n            src ||= tag.attrs.href\n\n            if src\n                # file\n                filename = getFilePath File, file, src\n                script = fs.readFileSync filename, 'utf-8'\n            else\n                # tag\n                script = tag.stringifyChildren()\n                {filename} = tag.attrs\n                if isCoffee(filename)\n                    script = \"`module.exports = function(){`\\n\\n#{script}\\n\\n`};`\"\n                else\n                    script = \"module.exports = function(){\\n\\n#{script}\\n\\n};\"\n\n            name = \"#{file.path}##{i}\"\n            extname = (filename and pathUtils.extname(filename)) or DEFAULT_FILE_EXT\n            path = pathUtils.join OUT_DIR, name + extname\n            fs.outputFileSync path, script\n            File.Scripts.scripts[name] = require path\n            scripts.push name\n\n        file.scripts = new File.Scripts file, scripts\n\n        return\n\n# Glossary\n\n- [script](#neftscript)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"9dc3613259004b0688f60257256b1cd2d054bc88","subject":"server socket","message":"server socket\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    class Response\n     constructor: (data, port) ->\n      @id = data.id\n      @port = port\n\n     progress: (progress, data) ->\n      @port.respond this, 'progress', data, progress: progress\n     success: (data) ->\n      @port.respond this, 'success', data\n     fail: (data) ->\n      @port.respond this, 'fail', data\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks) -> null\n\n     handle: (data) ->\n      if not @callbacks[data.status]?\n       throw new Error \"No callback registered #{@method} #{data.status}\"\n      @callback[data.status] data\n\n    class Port\n     constructor: (options = {}) ->\n      @handlers = options.handlers ? {}\n      @callsCache = {}\n      @callsCounter = 0\n\n     send: (method, data, callbacks, options = {}) ->\n      @_send @_createCall method, data, callbacks, options\n\n     respond: (response, status, data, options = {}) ->\n      @_respond @_createRespose response, status, data, options\n\n\n     _createCall: (method, data, callbacks, options) ->\n      #TODO other params via options\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      call = new Call @callsCounter, method, data, callbacks\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       mehtod: call.method\n       data: call.data\n\n      return params\n\n     _createRespose: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n     addHandler: (method, callback) ->\n      @handlers[method] = callback\n\n     handleMessage: (data) ->\n      if data.type is 'response'\n       return unless @callsCache[data.id]?\n       @callsCache[data.id].handle data\n      else if data.type is 'call'\n       return unless @handlers[data.method]?\n       @handlers[data.method] data.data, new Response data, this\n\n    class WorkerPort extends Port\n     constructor: (options, worker) ->\n      super options\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @handleMessage data\n\n     _onError: (e) -> console.log e\n\n    class SocketPort extends Port\n     constructor: (options, socket) ->\n      super options\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @handleMessage data\n\n    class ServerSocketPort extends Port\n     constructor: (options, server) ->\n      super options\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      ServerSocketPort: ServerSocketPort\n\n     setup: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    class Response\n     constructor: (data, port) ->\n      @id = data.id\n      @port = port\n\n     progress: (progress, data) ->\n      @port.respond this, 'progress', data, progress: progress\n     success: (data) ->\n      @port.respond this, 'success', data\n     fail: (data) ->\n      @port.respond this, 'fail', data\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks) -> null\n\n     handle: (data) ->\n      if not @callbacks[data.status]?\n       throw new Error \"No callback registered #{@method} #{data.status}\"\n      @callback[data.status] data\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n\n     send: (method, data, callbacks, options = {}) -> null\n      @_send @_createCall method, data, callbacks, options\n\n     respond: (response, status, data, options = {}) ->\n      @_respond @_createRespose response, status, data, options\n\n\n     _createCall: (method, data, callbacks, options) ->\n      #TODO other params via options\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      call = new Call @callsCounter, method, data, callbacks\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       mehtod: call.method\n       data: call.data\n\n      return params\n\n     _createRespose: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n     addHandler: (method, callback) ->\n      @handlers[method] = callback\n\n     handleMessage: (data) ->\n      if data.type is 'response'\n       return unless @callsCache[data.id]?\n       @callsCache[data.id].handle data\n      else if data.type is 'call'\n       return unless @handlers[data.method]?\n       @handlers[data.method] data.data, new Response data, this\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n      super()\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @handleMessage data\n\n     _onError: (e) -> console.log e\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n      super()\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @handleMessage data\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n\n     setup: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a570ffa337dc0c85019d1b8472a3a7e7bc30a6fe","subject":"remove autoplay on noembeds","message":"remove autoplay on noembeds\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"lib\/collections\/posts.litcoffee","new_file":"lib\/collections\/posts.litcoffee","new_contents":"# Exclusive posts\n\n`PostFormSchema` is used to generate autoforms, we'll submit to methods and fill\nin the reset of the data.\n\n    @PostFormSchema = new SimpleSchema\n      message:\n        type: String\n        max: 200\n        autoform:\n          rows: 3\n      link:\n        type: String\n        regEx: SimpleSchema.RegEx.Url\n        optional: yes\n\n    PostSchema = new SimpleSchema\n      name:\n        type: String\n      message:\n        type: String\n        max: 200\n      link:\n        type: String\n        regEx: SimpleSchema.RegEx.Url\n        optional: yes\n      html:\n        type: String\n        optional: yes\n      timeCreated:\n        type: Date\n        autoValue: ->\n          if this.isInsert\n            return moment.utc().toDate()\n          else\n            this.unset()\n      connectionId:\n        type: String\n        max: 20\n      ticketNumber:\n        type: Number\n        index: 1\n\n    @Posts = new Meteor.Collection 'posts'\n    Posts.attachSchema PostSchema\n\n\n## Posts Meteor Methods\n\n    Meteor.methods\n      postMessage: (doc) ->\n\n        check doc, PostFormSchema\n\nReturn on the client\n\n        return if Meteor.isClient\n\nGet the queueMeta\n\n        queueMeta = QueueMeta.findOne()\n        throw new Meteor.Error 'queueMeta', 'Could not find queueMeta.' if not queueMeta?\n\nCheck that the connection is theOnlyConnectionAllowedIn\n\n        isAllowedIn = this.connection.id is queueMeta.theOnlyConnectionAllowedIn?.connectionId\n        throw new Meteor.Error 'no-access', \"You're not allowed to do that until you're in.\" if not isAllowedIn\n\nCheck that the connection hasn't already posted a message\n\n        throw new Meteor.Error 'dup-post', \"You're only allowed to post once.\" if queueMeta.hasCurrentConnectionPosted\n\nCheck that the connection hasn't expired\n\n        throw new Meteor.Error 'expired', \"You're time expired, post faster.\" if queueMeta.timeCurrentTicketExpires < moment.utc().toDate()\n\nMark queueMeta as hasCurrentConnectionPosted\n\n        criteria = _id: queueMeta._id\n        update = $set: hasCurrentConnectionPosted: yes\n\nTry to get noembed content\n\n        callback = (error, result) ->\n          console.log error if error?\n          if not error? and result?.data?.html? then html = result.data.html\n\nPost message\n\n          post =\n            name: queueMeta.theOnlyConnectionAllowedIn.name\n            message: doc.message\n            link: doc.link\n            connectionId: queueMeta.theOnlyConnectionAllowedIn.connectionId\n            ticketNumber: queueMeta.theOnlyConnectionAllowedIn.ticketNumber\n\n          if html?\n            _.extend post, html: html\n            _.extend update.$set, html: html\n          else\n            _.extend update, $unset: html: 'unset'\n\n          QueueMeta.update criteria, update\n          Posts.insert post\n\n        if doc.link?\n          getUrl = \"http:\/\/noembed.com\/embed?url=#{doc.link}\"\n          HTTP.get getUrl, callback\n        else\n          callback()\n","old_contents":"# Exclusive posts\n\n`PostFormSchema` is used to generate autoforms, we'll submit to methods and fill\nin the reset of the data.\n\n    @PostFormSchema = new SimpleSchema\n      message:\n        type: String\n        max: 200\n        autoform:\n          rows: 3\n      link:\n        type: String\n        regEx: SimpleSchema.RegEx.Url\n        optional: yes\n\n    PostSchema = new SimpleSchema\n      name:\n        type: String\n      message:\n        type: String\n        max: 200\n      link:\n        type: String\n        regEx: SimpleSchema.RegEx.Url\n        optional: yes\n      html:\n        type: String\n        optional: yes\n      timeCreated:\n        type: Date\n        autoValue: ->\n          if this.isInsert\n            return moment.utc().toDate()\n          else\n            this.unset()\n      connectionId:\n        type: String\n        max: 20\n      ticketNumber:\n        type: Number\n        index: 1\n\n    @Posts = new Meteor.Collection 'posts'\n    Posts.attachSchema PostSchema\n\n\n## Posts Meteor Methods\n\n    Meteor.methods\n      postMessage: (doc) ->\n\n        check doc, PostFormSchema\n\nReturn on the client\n\n        return if Meteor.isClient\n\nGet the queueMeta\n\n        queueMeta = QueueMeta.findOne()\n        throw new Meteor.Error 'queueMeta', 'Could not find queueMeta.' if not queueMeta?\n\nCheck that the connection is theOnlyConnectionAllowedIn\n\n        isAllowedIn = this.connection.id is queueMeta.theOnlyConnectionAllowedIn?.connectionId\n        throw new Meteor.Error 'no-access', \"You're not allowed to do that until you're in.\" if not isAllowedIn\n\nCheck that the connection hasn't already posted a message\n\n        throw new Meteor.Error 'dup-post', \"You're only allowed to post once.\" if queueMeta.hasCurrentConnectionPosted\n\nCheck that the connection hasn't expired\n\n        throw new Meteor.Error 'expired', \"You're time expired, post faster.\" if queueMeta.timeCurrentTicketExpires < moment.utc().toDate()\n\nMark queueMeta as hasCurrentConnectionPosted\n\n        criteria = _id: queueMeta._id\n        update = $set: hasCurrentConnectionPosted: yes\n\nTry to get noembed content\n\n        callback = (error, result) ->\n          console.log error if error?\n          if not error? and result?.data?.html? then html = result.data.html\n\nPost message\n\n          post =\n            name: queueMeta.theOnlyConnectionAllowedIn.name\n            message: doc.message\n            link: doc.link\n            connectionId: queueMeta.theOnlyConnectionAllowedIn.connectionId\n            ticketNumber: queueMeta.theOnlyConnectionAllowedIn.ticketNumber\n\n          if html?\n            _.extend post, html: html\n            _.extend update.$set, html: html\n          else\n            _.extend update, $unset: html: 'unset'\n\n          QueueMeta.update criteria, update\n          Posts.insert post\n\n        if doc.link?\n          getUrl = \"http:\/\/noembed.com\/embed?url=#{doc.link}&autoplay=1&auto_play=1\"\n          HTTP.get getUrl, callback\n        else\n          callback()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"54835f00bdb860d0ac520a59489da8d7336933e4","subject":"Target is optional.","message":"Target is optional.\n","repos":"fniessink\/checksome,mxipartners\/checksome","old_file":"lib\/validation\/subject_metric.litcoffee","new_file":"lib\/validation\/subject_metric.litcoffee","new_contents":"A `subject_metric` is valid if it has a valid target.\n\n    @validateSubjectMetric = (subjectMetric) ->\n\nFirst, check that the subject metric has the right structure and is a valid\nitem.\n\n      check subjectMetric, Match.ObjectIncluding\n        target: Match.Optional(Number)\n\nNext, check that the target is zero or greater.\n\n      errors = {}\n      if subjectMetric.target < 0\n        errors.target = TAPi18n.__ \"Please provide a positive target value\"\n      return errors\n","old_contents":"A `subject_metric` is valid if it has a valid target.\n\n    @validateSubjectMetric = (subjectMetric) ->\n\nFirst, check that the subject metric has the right structure and is a valid\nitem.\n\n      check subjectMetric, Match.ObjectIncluding\n        target: Number\n\nNext, check that the target is zero or greater.\n\n      errors = {}\n      if subjectMetric.target < 0\n        errors.target = TAPi18n.__ \"Please provide a positive target value\"\n      return errors\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b167ab1a3dba3426f32ebc1e20a3a84738894a31","subject":"Fixed issue when counting impl\/invo","message":"Fixed issue when counting impl\/invo\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-grunt\/dox\/dynamic.litcoffee","new_file":"packages\/shrub-grunt\/dox\/dynamic.litcoffee","new_contents":"# Grunt build process - Dynamic documentation\n\n    {exec} = require 'child_process'\n    fs = require 'fs'\n    path = require 'path'\n    {Transform} = require 'stream'\n\n    _ = require 'lodash'\n    {LineStream} = require 'byline'\n    glob = require 'grunt\/node_modules\/glob'\n    Promise = require 'bluebird'\n\nImplement a Transform stream to accumulate hook invocations from a source file.\n\n    class HookInvocations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Invoke hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream to accumulate hook implementations from a source\nfile.\n\n    class HookImplementations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Implements hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream fo accumulate TODOs from a source file. Also\ncaches lines to be able to build context around each TODO item.\n\n    class Todos extends Transform\n\n      @context = 4\n\n      constructor: ->\n        super\n\n        @lines = []\n        @todos = []\n\n      _transform: (chunk, encoding, done) ->\n        @lines.push line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\#\\#\\# TODO\/\n          @todos.push @lines.length - 1\n\n        done()\n\n      withContext: ->\n\n        for todo in @todos\n\n          start = Math.max 0, todo - Todos.context\n          end = Math.min @lines.length - 1, todo + Todos.context\n\n          index: todo\n          lines: @lines.slice start, end\n\nGather all source files.\n\n    _allSourceFiles = ->\n      new Promise (resolve, reject) ->\n        glob(\n          '{{client,custom,packages,server}\/**\/*.litcoffee,*.litcoffee}'\n          (error, files) ->\n            return reject error if error?\n            resolve files\n        )\n\nGenerate an HTML ID from a string.\n\n    _idFromString = (string) -> string.replace(\n      \/\\\/\/g, ''\n    ).replace(\n      \/[^0-9A-Za-z-]+\/g, '-'\n    ).replace(\n      \/\\-+\/g, '-'\n    ).toLowerCase()\n\nGet the source path from a filename. This removes the extension and any \/index\nportion from the end of the filename.\n\n    _sourcePath = (filename) ->\n\n        dirname = path.dirname filename\n        if dirname is '.' then dirname = '' else dirname += '\/'\n        extname = path.extname filename\n        filename = \"#{dirname}#{path.basename filename, extname}\"\n\n        parts = filename.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'index'\n        return parts.join '\/'\n\nCollate a list of files by type (client or server).\n\n    _collateFilesByType = (files) ->\n\n      client = []\n      server = []\n\n      for file in files\n        parts = file.split '\/'\n\n        if parts[0] is 'client'\n          client.push file\n        else if parts[0] is 'custom' and parts[2] is 'client'\n          client.push file\n        else if parts[0] is 'packages' and parts[2] is 'client'\n          client.push file\n        else\n          server.push file\n\n      client: client, server: server\n\nGather statistics for all files.\n\n    fileStatsListPromise = _allSourceFiles().then (allFiles) ->\n\n      allFilesPromises = for type, files of _collateFilesByType allFiles\n\n        typePromises = for file in files\n\n          do (type, file) -> new Promise (resolve, reject) ->\n\n            fstream = fs.createReadStream file\n            fstream.pipe lineStream = new LineStream keepEmptyLines: true\n\nPass all files through the Transform list to parse out relevant information.\n\n            lineStream.pipe hookImplementations = new HookImplementations()\n            lineStream.pipe hookInvocations = new HookInvocations()\n            lineStream.pipe todos = new Todos()\n\n            fstream.on 'error', reject\n\n            fstream.on 'end', ->\n\nInclude all information from Transform streams in the statistics.\n\n              resolve(\n                type: type\n                file: file\n                implementations: hookImplementations.list\n                invocations: hookInvocations.list\n                todos: todos.withContext()\n              )\n\n        Promise.all typePromises\n\n      Promise.all(allFilesPromises).then (fileStatsLists) ->\n        _.flatten fileStatsLists\n\nMassage the statistics to help rendering the hooks page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      hooksIndex = {}\n\n      indexes = {}\n      keys = ['implementations', 'invocations']\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        for remove in ['client', 'packages']\n          if ~(index = parts.indexOf remove)\n            parts.splice index, 1\n        mergeFile = parts.join '\/'\n\n        for key in keys\n          indexes[key] ?= {}\n\n          for hook in fileStats[key]\n            indexes[key][hook] ?= {}\n\n            indexes[key][hook][mergeFile] ?= fullName: fileStats.file\n            (indexes[key][hook][mergeFile].types ?= []).push fileStats.type\n\n            hooksIndex[hook] = true\n\n      for key in keys\n        for hook, stats of indexes[key]\n          for file of stats\n            stats[file].types = _.unique stats[file].types ? []\n\n      hooks = (hook for hook of hooksIndex).sort()\n\n      hookFiles = {}\n      for hook in hooks\n        hookFiles[hook] = try\n          fs.readFileSync \"docs\/hook\/#{hook}.md\", 'utf8'\n        catch error\n          ''\n\n      O =\n        hookFiles: hookFiles\n        hooks: hooks\n\n      O[key] = indexes[key] for key in keys\n\n      return O\n\nRender the hooks page.\n\n    ).then((O) ->\n\n      {hookFiles, hooks} = O\n\n      keys = ['implementation', 'invocation']\n\n      wordingFor =\n        implementation: 'implements'\n        invocation: 'invoke'\n\n      render = fs.readFileSync 'docs\/hooks.template.md', 'utf8'\n\n      for hook in hooks\n\n        render += \"## #{hook}\\n\\n\"\n        render += hookFiles[hook] + '\\n\\n' if hookFiles[hook]\n\n        for key in keys\n          pluralKey = \"#{key}s\"\n\n          if O[pluralKey][hook]?\n\n            count = 0\n            for file, {types} of O[pluralKey][hook]\n              count += types.length\n\n            render += \"!!! note \\\"#{count} #{key}\"\n            render += 's' if count > 1\n            render += '\"\\n'\n\n            instances = for file, {fullName, types} of O[pluralKey][hook]\n\nRemove packages and file part.\n\n              parts = fullName.split '\/'\n              parts.shift()\n              parts.pop()\n              packageName = parts.join '\/'\n\n              types = types.map (type) ->\n                packageNameParts = packageName.split '\/'\n                packageNameParts.pop() if packageNameParts[packageNameParts.length - 1] isnt type\n                \"    * [#{_sourcePath file} (#{type})](packages\/##{_idFromString packageNameParts.join '\/'}) &mdash; [#{key}](source\/#{_sourcePath fullName}##{wordingFor[key]}-hook-#{_idFromString hook}) \\n\"\n              types.join ''\n\n            render += instances.join ''\n\n            render += '\\n\\n'\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/hooks.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nRender the TODOs page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/todos.template.md', 'utf8'\n\n      for fileStats in fileStatsList\n\nKeep track of used IDs, it will be necessary to link to the correct location\nhash in the case of multiple TODO items with the same wording.\n\n        idMap = {}\n\n        for todo in fileStats.todos\n\n          render += '\\n'\n\n          id = ''\n          for line, index in todo.lines\n            render += '>'\n\nIf this is the line with the TODO, parse the ID from the TODO item text, and\nrender it as h2 (TODO are h6) to increase visibility.\n\n            if index is Todos.context\n              id = _idFromString(line).slice 1, -1\n\n              render += line.slice 4\n            else\n              render += \" #{line}\"\n            render += '\\n'\n\n          render += '\\n'\n\n          filename = _sourcePath fileStats.file\n\nKeep track of ID usage and modify the location hash for subsequent uses.\n\n          if idMap[id]?\n            idMap[id] += 1\n            id += \"_#{idMap[id]}\"\n          else\n            idMap[id] = 0\n\n          render += \"###### the above found in [#{fileStats.file}:#{todo.index}](source\/#{filename}##{id})\\n\"\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/todos.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nAdd all the source files to a generated mkdocs.yml\n\n    _allSourceFiles().then (files) ->\n\n      yml = fs.readFileSync 'docs\/mkdocs.template.yml', 'utf8'\n\n      for file in files\n        parts = file.split '\/'\n\n        for i in [0...parts.length]\n          try\n            fs.mkdirSync \"docs\/source\/#{parts.slice(0, i).join '\/'}\"\n          catch error\n\n        fs.createReadStream(file).pipe(\n          fs.createWriteStream(\"docs\/source\/#{file}\")\n        )\n\nAdd them under the 'Source code' path.\n\n        yml += \"- [source\/#{file}, 'Source code', '#{file}']\\n\"\n\n      fs.writeFileSync 'mkdocs.yml', yml\n\n      return\n\nRender the packages page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\nSort by package name first.\n\n      newList = []\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        continue unless ~['custom', 'packages'].indexOf parts[0]\n\n        sourcePath = _sourcePath fileStats.file\n\n        parts = sourcePath.split '\/'\n        pkg = parts.join '\/'\n        fileStats.pkg = pkg.split('\/').slice(1).join '\/'\n\n        newList.push fileStats\n\n      newList.sort (l, r) ->\n        return -1 if l.type is 'client' and r.type is 'server'\n        return 1 if l.type is 'server' and r.type is 'client'\n        if l.pkg < r.pkg then -1 else if l.pkg > r.pkg then 1 else 0\n\n    ).then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/packages.template.md', 'utf8'\n      render += '\\n'\n\n      type = null\n\n      for fileStats in fileStatsList\n\n        if fileStats.type isnt type\n          type = fileStats.type\n\n          render += if type is 'client'\n            '## Client-side'\n          else\n            '## Server-side'\n\n          render += '\\n\\n'\n\n        pkgParts = fileStats.pkg.split '\/'\n        isSubpackage = pkgParts.length isnt 1 and pkgParts.pop() isnt 'client'\n\nLink to the package.\n\n        sourcePath = _sourcePath fileStats.file\n\n        if isSubpackage\n          render += '> '\n          parts = fileStats.pkg.split '\/'\n          parentPkg = parts.shift()\n          subPkg = parts.join '\/'\n          render += \"## [<small>#{parentPkg}\/<\/small>#{subPkg}](source\/#{sourcePath})\"\n        else\n          render += \"## [#{fileStats.pkg}](source\/#{sourcePath})\"\n\nNaively parse out the file description. It must be wrapped in asterisks, i.e.\nitalicized in markdown.\n\n###### TODO: This 'chunk' parsing should be done with a Transform like the others.\n\n        data = fs.readFileSync fileStats.file, 'utf8'\n        chunks = data.split '\\n\\n'\n\n        title = chunks[0]\n        if 35 is title.charCodeAt 0\n          render += '\\n\\n'\n          render += '> ' if isSubpackage\n          render += \"<span class=\\\"package-title\\\">#{title.substr 2}<\/span>\"\n\n        render += '\\n\\n'\n\n        description = chunks[1]\n        if 42 is description.charCodeAt 0 and 42 is description.charCodeAt description.length - 1\n          render += '> ' if isSubpackage\n          render += \"#{description}\\n\\n\"\n\n        if fileStats.implementations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Implements hooks\"\\n'\n          render += fileStats.implementations.map((hook) ->\n            \"    * [#{hook}](hooks\/##{_idFromString hook}) &mdash; [implementation](source\/#{sourcePath}#implements-hook-#{hook.toLowerCase()})\\n\"\n          ).join ''\n          render += '\\n\\n'\n\n        if fileStats.invocations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Invokes hooks\"\\n'\n          render += fileStats.invocations.map((hook) ->\n            \"    * [#{hook}](hooks\/##{_idFromString hook}) &mdash; [invocation](source\/#{sourcePath}#invoke-hook-#{hook.toLowerCase()})\\n\"\n          ).join ''\n          render += '\\n\\n'\n\n###### TODO: We should do some preprocessing hre with a transform, namely linking the hook headers to their respective documentation.\n\n      fs.writeFileSync 'docs\/packages.md', render\n\n    )\n","old_contents":"# Grunt build process - Dynamic documentation\n\n    {exec} = require 'child_process'\n    fs = require 'fs'\n    path = require 'path'\n    {Transform} = require 'stream'\n\n    _ = require 'lodash'\n    {LineStream} = require 'byline'\n    glob = require 'grunt\/node_modules\/glob'\n    Promise = require 'bluebird'\n\nImplement a Transform stream to accumulate hook invocations from a source file.\n\n    class HookInvocations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Invoke hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream to accumulate hook implementations from a source\nfile.\n\n    class HookImplementations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Implements hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream fo accumulate TODOs from a source file. Also\ncaches lines to be able to build context around each TODO item.\n\n    class Todos extends Transform\n\n      @context = 4\n\n      constructor: ->\n        super\n\n        @lines = []\n        @todos = []\n\n      _transform: (chunk, encoding, done) ->\n        @lines.push line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\#\\#\\# TODO\/\n          @todos.push @lines.length - 1\n\n        done()\n\n      withContext: ->\n\n        for todo in @todos\n\n          start = Math.max 0, todo - Todos.context\n          end = Math.min @lines.length - 1, todo + Todos.context\n\n          index: todo\n          lines: @lines.slice start, end\n\nGather all source files.\n\n    _allSourceFiles = ->\n      new Promise (resolve, reject) ->\n        glob(\n          '{{client,custom,packages,server}\/**\/*.litcoffee,*.litcoffee}'\n          (error, files) ->\n            return reject error if error?\n            resolve files\n        )\n\nGenerate an HTML ID from a string.\n\n    _idFromString = (string) -> string.replace(\n      \/\\\/\/g, ''\n    ).replace(\n      \/[^0-9A-Za-z-]+\/g, '-'\n    ).replace(\n      \/\\-+\/g, '-'\n    ).toLowerCase()\n\nGet the source path from a filename. This removes the extension and any \/index\nportion from the end of the filename.\n\n    _sourcePath = (filename) ->\n\n        dirname = path.dirname filename\n        if dirname is '.' then dirname = '' else dirname += '\/'\n        extname = path.extname filename\n        filename = \"#{dirname}#{path.basename filename, extname}\"\n\n        parts = filename.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'index'\n        return parts.join '\/'\n\nCollate a list of files by type (client or server).\n\n    _collateFilesByType = (files) ->\n\n      client = []\n      server = []\n\n      for file in files\n        parts = file.split '\/'\n\n        if parts[0] is 'client'\n          client.push file\n        else if parts[0] is 'custom' and parts[2] is 'client'\n          client.push file\n        else if parts[0] is 'packages' and parts[2] is 'client'\n          client.push file\n        else\n          server.push file\n\n      client: client, server: server\n\nGather statistics for all files.\n\n    fileStatsListPromise = _allSourceFiles().then (allFiles) ->\n\n      allFilesPromises = for type, files of _collateFilesByType allFiles\n\n        typePromises = for file in files\n\n          do (type, file) -> new Promise (resolve, reject) ->\n\n            fstream = fs.createReadStream file\n            fstream.pipe lineStream = new LineStream keepEmptyLines: true\n\nPass all files through the Transform list to parse out relevant information.\n\n            lineStream.pipe hookImplementations = new HookImplementations()\n            lineStream.pipe hookInvocations = new HookInvocations()\n            lineStream.pipe todos = new Todos()\n\n            fstream.on 'error', reject\n\n            fstream.on 'end', ->\n\nInclude all information from Transform streams in the statistics.\n\n              resolve(\n                type: type\n                file: file\n                implementations: hookImplementations.list\n                invocations: hookInvocations.list\n                todos: todos.withContext()\n              )\n\n        Promise.all typePromises\n\n      Promise.all(allFilesPromises).then (fileStatsLists) ->\n        _.flatten fileStatsLists\n\nMassage the statistics to help rendering the hooks page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      hooksIndex = {}\n\n      indexes = {}\n      keys = ['implementations', 'invocations']\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        for remove in ['client', 'packages']\n          if ~(index = parts.indexOf remove)\n            parts.splice index, 1\n        mergeFile = parts.join '\/'\n\n        for key in keys\n          indexes[key] ?= {}\n\n          for hook in fileStats[key]\n            indexes[key][hook] ?= {}\n\n            indexes[key][hook][mergeFile] ?= fullName: fileStats.file\n            (indexes[key][hook][mergeFile].types ?= []).push fileStats.type\n\n            hooksIndex[hook] = true\n\n      for key in keys\n        for hook, stats of indexes[key]\n          for file of stats\n            stats[file].types = _.unique stats[file].types ? []\n\n      hooks = (hook for hook of hooksIndex).sort()\n\n      hookFiles = {}\n      for hook in hooks\n        hookFiles[hook] = try\n          fs.readFileSync \"docs\/hook\/#{hook}.md\", 'utf8'\n        catch error\n          ''\n\n      O =\n        hookFiles: hookFiles\n        hooks: hooks\n\n      O[key] = indexes[key] for key in keys\n\n      return O\n\nRender the hooks page.\n\n    ).then((O) ->\n\n      {hookFiles, hooks} = O\n\n      keys = ['implementation', 'invocation']\n\n      wordingFor =\n        implementation: 'implements'\n        invocation: 'invoke'\n\n      render = fs.readFileSync 'docs\/hooks.template.md', 'utf8'\n\n      for hook in hooks\n\n        render += \"## #{hook}\\n\\n\"\n        render += hookFiles[hook] + '\\n\\n' if hookFiles[hook]\n\n        for key in keys\n          pluralKey = \"#{key}s\"\n\n          if O[pluralKey][hook]?\n\n            count = Object.keys(O[pluralKey][hook]).length\n\n            render += \"!!! note \\\"#{count} #{key}\"\n            render += 's' if count > 1\n            render += '\"\\n'\n\n            instances = for file, {fullName, types} of O[pluralKey][hook]\n\nRemove packages and file part.\n\n              parts = fullName.split '\/'\n              parts.shift()\n              parts.pop()\n              packageName = parts.join '\/'\n\n              types = types.map (type) ->\n                packageNameParts = packageName.split '\/'\n                packageNameParts.pop() if packageNameParts[packageNameParts.length - 1] isnt type\n                \"    * [#{_sourcePath file} (#{type})](packages\/##{_idFromString packageNameParts.join '\/'}) &mdash; [#{key}](source\/#{_sourcePath fullName}##{wordingFor[key]}-hook-#{_idFromString hook}) \\n\"\n              types.join ''\n\n            render += instances.join ''\n\n            render += '\\n\\n'\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/hooks.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nRender the TODOs page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/todos.template.md', 'utf8'\n\n      for fileStats in fileStatsList\n\nKeep track of used IDs, it will be necessary to link to the correct location\nhash in the case of multiple TODO items with the same wording.\n\n        idMap = {}\n\n        for todo in fileStats.todos\n\n          render += '\\n'\n\n          id = ''\n          for line, index in todo.lines\n            render += '>'\n\nIf this is the line with the TODO, parse the ID from the TODO item text, and\nrender it as h2 (TODO are h6) to increase visibility.\n\n            if index is Todos.context\n              id = _idFromString(line).slice 1, -1\n\n              render += line.slice 4\n            else\n              render += \" #{line}\"\n            render += '\\n'\n\n          render += '\\n'\n\n          filename = _sourcePath fileStats.file\n\nKeep track of ID usage and modify the location hash for subsequent uses.\n\n          if idMap[id]?\n            idMap[id] += 1\n            id += \"_#{idMap[id]}\"\n          else\n            idMap[id] = 0\n\n          render += \"###### the above found in [#{fileStats.file}:#{todo.index}](source\/#{filename}##{id})\\n\"\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/todos.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nAdd all the source files to a generated mkdocs.yml\n\n    _allSourceFiles().then (files) ->\n\n      yml = fs.readFileSync 'docs\/mkdocs.template.yml', 'utf8'\n\n      for file in files\n        parts = file.split '\/'\n\n        for i in [0...parts.length]\n          try\n            fs.mkdirSync \"docs\/source\/#{parts.slice(0, i).join '\/'}\"\n          catch error\n\n        fs.createReadStream(file).pipe(\n          fs.createWriteStream(\"docs\/source\/#{file}\")\n        )\n\nAdd them under the 'Source code' path.\n\n        yml += \"- [source\/#{file}, 'Source code', '#{file}']\\n\"\n\n      fs.writeFileSync 'mkdocs.yml', yml\n\n      return\n\nRender the packages page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\nSort by package name first.\n\n      newList = []\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        continue unless ~['custom', 'packages'].indexOf parts[0]\n\n        sourcePath = _sourcePath fileStats.file\n\n        parts = sourcePath.split '\/'\n        # parts.pop() if parts[parts.length - 1] is 'client'\n        pkg = parts.join '\/'\n        fileStats.pkg = pkg.split('\/').slice(1).join '\/'\n\n        newList.push fileStats\n\n      newList.sort (l, r) ->\n        return -1 if l.type is 'client' and r.type is 'server'\n        return 1 if l.type is 'server' and r.type is 'client'\n        if l.pkg < r.pkg then -1 else if l.pkg > r.pkg then 1 else 0\n\n    ).then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/packages.template.md', 'utf8'\n      render += '\\n'\n\n      type = null\n\n      for fileStats in fileStatsList\n\n        if fileStats.type isnt type\n          type = fileStats.type\n\n          render += if type is 'client'\n            '## Client-side'\n          else\n            '## Server-side'\n\n          render += '\\n\\n'\n\n        pkgParts = fileStats.pkg.split '\/'\n        isSubpackage = pkgParts.length isnt 1 and pkgParts.pop() isnt 'client'\n\nLink to the package.\n\n        sourcePath = _sourcePath fileStats.file\n\n        if isSubpackage\n          render += '> '\n          parts = fileStats.pkg.split '\/'\n          parentPkg = parts.shift()\n          subPkg = parts.join '\/'\n          render += \"## [<small>#{parentPkg}\/<\/small>#{subPkg}](source\/#{sourcePath})\"\n        else\n          render += \"## [#{fileStats.pkg}](source\/#{sourcePath})\"\n\nNaively parse out the file description. It must be wrapped in asterisks, i.e.\nitalicized in markdown.\n\n###### TODO: This 'chunk' parsing should be done with a Transform like the others.\n\n        data = fs.readFileSync fileStats.file, 'utf8'\n        chunks = data.split '\\n\\n'\n\n        title = chunks[0]\n        if 35 is title.charCodeAt 0\n          render += '\\n\\n'\n          render += '> ' if isSubpackage\n          render += \"<span class=\\\"package-title\\\">#{title.substr 2}<\/span>\"\n\n        render += '\\n\\n'\n\n        description = chunks[1]\n        if 42 is description.charCodeAt 0 and 42 is description.charCodeAt description.length - 1\n          render += '> ' if isSubpackage\n          render += \"#{description}\\n\\n\"\n\n        if fileStats.implementations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Implements hooks\"\\n'\n          render += fileStats.implementations.map((hook) ->\n            \"    * [#{hook}](hooks\/##{_idFromString hook}) &mdash; [implementation](source\/#{sourcePath}#implements-hook-#{hook.toLowerCase()})\\n\"\n          ).join ''\n          render += '\\n\\n'\n\n        if fileStats.invocations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Invokes hooks\"\\n'\n          render += fileStats.invocations.map((hook) ->\n            \"    * [#{hook}](hooks\/##{_idFromString hook}) &mdash; [invocation](source\/#{sourcePath}#invoke-hook-#{hook.toLowerCase()})\\n\"\n          ).join ''\n          render += '\\n\\n'\n\n###### TODO: We should do some preprocessing hre with a transform, namely linking the hook headers to their respective documentation.\n\n      fs.writeFileSync 'docs\/packages.md', render\n\n    )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fd4ab5f8e0961ffbe91131455428e51026b03e75","subject":"listen","message":"listen\n","repos":"vpj\/weya,vpj\/weya","old_file":"base.litcoffee","new_file":"base.litcoffee","new_contents":"#Weya.Base.js\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n##Weya.Base\nIntroduces class level function initialize and include.\n\n    class Base\n     _initialize: []\n     on: {}\n\nExtend Events\n\n     @extend: ->\n      events = @::on\n      @::on = {}\n      @::on[k] = v for k, v of events\n\nAdd event listeners\n\n     @listen: (name, func) ->\n      @::on[name] = func\n\nGetter\n\n     @get: (name, func) ->\n      @::__defineGetter__ name, func\n\nSetter\n\n     @set: (name, func) ->\n      @::__defineSetter__ name, func\n\n     constructor: ->\n      @_init.apply @, arguments\n\n####Register initialize functions.\nAll initializer funcitons in subclasses will be called with the constructor\narguments.\n\n     @initialize: (func) ->\n      @::_initialize = @::_initialize.slice()\n      @::_initialize.push func\n\n     _init: ->\n      for init in @_initialize\n       init.apply @, arguments\n\n      return\n\n####Include objects.\nYou can include objects by registering them with @include. This tries to\nsolve the problem of single inheritence.\n\n     @include: (obj) ->\n      for k, v of obj\n       switch k\n        when 'initialize'\n         @::_initialize.push v\n        when 'on'\n         for event, listener of v\n          @::on[event] = listener\n        else\n         @::[k] = v\n\n     @initialize ->\n      events = @on\n      @on = {}\n      for k, v of events\n       @on[k] = v.bind this\n\n    Weya.Base = Base\n\n    if module?\n     module.exports = Weya.Base\n\n","old_contents":"#Weya.Base.js\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n##Weya.Base\nIntroduces class level function initialize and include.\n\n    class Base\n     _initialize: []\n     on: {}\n\n     @extend: ->\n      @::_initialize = @::_initialize.slice()\n      events = @::on\n      @::on = {}\n      @::on[k] = v for k, v of events\n\n     @get: (name, func) ->\n      @::__defineGetter__ name, func\n\n     @set: (name, func) ->\n      @::__defineSetter__ name, func\n\n     constructor: ->\n      @_init.apply @, arguments\n\n####Register initialize functions.\nAll initializer funcitons in subclasses will be called with the constructor\narguments.\n\n     @initialize: (func) ->\n      inits = @::_initialize\n      @::_initialize = []\n      for v in inits\n       @::_initialize.push v\n      @::_initialize.push func\n\n     _init: ->\n      for init in @_initialize\n       init.apply @, arguments\n\n      return\n\n####Include objects.\nYou can include objects by registering them with @include. This tries to\nsolve the problem of single inheritence.\n\n     @include: (obj) ->\n      for k, v of obj\n       switch k\n        when 'initialize'\n         @::_initialize.push v\n        when 'on'\n         for event, listener of v\n          @::on[event] = listener\n        else\n         @::[k] = v\n\n     @initialize ->\n      events = @on\n      @on = {}\n      for k, v of events\n       @on[k] = v.bind this\n\n    Weya.Base = Base\n\n    if module?\n     module.exports = Weya.Base\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2ba9a00a4586b0c80ccd1027ff201533741372b3","subject":"spotfix","message":"spotfix\n","repos":"nickfargo\/restate","old_file":"src\/root-state.litcoffee","new_file":"src\/root-state.litcoffee","new_contents":"## [RootState](#root-state)\n\n    class RootState extends State\n\n      { VIRTUAL, ABSTRACT, CONCLUSIVE, FINAL } = this\n      { VIA_NONE, VIA_PROTO } = this\n\n      DEFAULT_OPTIONS = {}\n\n\n### [Constructor](#root-state--constructor)\n\n      constructor: ( owner, expression, options ) ->\n        @owner = owner or = {}\n        unless expression instanceof StateExpression\n          expression = new StateExpression expression\n        if options?\n        then if typeof options is 'string' then options = initialState: options\n        else options = DEFAULT_OPTIONS\n\nAssign to `owner` an **accessor** to its state implementation.\n\n        @accessorName = accessorName = options.name or 'state'\n        owner[ accessorName ] = createAccessor owner, accessorName, this\n\nA root state\u2019s `name` is by definition the empty-string.\n\n        super owner, @name = '', expression\n\nDetermine the initial state, and set the `current` state to that.\n\n        current = if options.initialState?\n        then this.query options.initialState\n        else this.initialSubstate() or this\n\nThe initial state may be `abstract`, in which case currency must be forwarded\nto its default `concrete` substate.\n\n        if current.attributes & ABSTRACT\n          current = current.defaultSubstate() or current\n\nThe previous redirections may have left `current` pointing to a protostate, in\nwhich case a virtual state must be created in `this` root\u2019s tree.\n\n        if current.root isnt this then current = current.virtualize this\n\nThe authoritative property reference to the owner\u2019s `current` state.\n\n        @_current = current\n\nWhile a `Transition` is underway, `_current` will be a reference to that\ntransition. To further distinguish this condition, an identical reference is\nalso held at `_transition`.\n\n        @_transition = null\n\n\n\n### [Private functions](#root-state--private)\n\n\n#### [createAccessor](#root-state--private--create-accessor)\n\nReturns the `accessor` function that will serve as an owner object\u2019s interface\nto its state implementation.\n\n      createAccessor = ( owner, name, root ) ->\n\n        accessor = ( input, args... ) ->\n          current = root._current\n\n          if this is owner\n            return current unless input?\n            return current.change input.call this if typeof input is 'function'\n            if typeof input is 'string' and\n                ( match = input.match rxTransitionArrow ) and\n                  method = transitionArrowMethods[ match[1] ]\n              return if args.length\n              then current[ method ].apply current, [ match[2] ].concat args\n              else current[ method ] match[2]\n            return current.query.apply current, arguments\n\nCalling the accessor of a prototype means that `this` requires its own accessor\nand root state. Creating a new `RootState` will have the desired side-effect of\nalso creating the object\u2019s new accessor, to which the call is then forwarded.\n\n          else if owner.isPrototypeOf(this) and not O.hasOwn.call this, name\n            new RootState this, null, { name, initialState: current.path() }\n            return @[ name ].apply this, arguments\n\n        accessor.isAccessor = true\n\n        if O.env.debug\n          accessor.toString = ->\n            \"[accessor] -> #{ root._current.path() }\"\n\n        accessor\n\n\n#### [evaluateGuard](#root-state--private--evaluate-guard)\n\nReturns the boolean result of a `guard` function in the `context` of a `State`,\nas evaluated `against` another `State`. Defaults to `true` if no guard exists.\n\n      evaluateGuard = ( context, guard, against ) ->\n        guard = context.guard guard if typeof guard is 'string'\n        return true unless guard\n\n        args = O.slice.call arguments, 1\n        for own key, value of guard\n          valueIsFn = typeof value is 'function'\n          selectors = O.trim( key ).split \/\\s*,+\\s*\/\n          for selector in selectors when context.query selector, against\n            result = if valueIsFn then value.apply context, args else value\n            break\n          break unless result\n        !!result\n\n\n#### [getTransitionExpression](#root-state--private--get-transition-expression)\n\nFinds the appropriate transition expression for the given `target` and `origin`\nstates. If no matching transitions are defined in either state or any of their\nancestors, a generic actionless transition expression for the pair is returned.\n\n      getTransitionExpression: do ->\n\n        search = ( target, origin, subject, ceiling ) ->\n          while subject and subject isnt ceiling\n            for own key, expr of subject.transitions()\n              return expr if (\n                not ( guards = expr.guards ) or (\n                  not ( admit = guards.admit ) or\n                  O.isEmpty( admit ) or\n                  evaluateGuard.call origin, admit, target, origin\n                ) and (\n                  not ( release = guards.release ) or\n                  O.isEmpty( release ) or\n                  evaluateGuard.call target, release, origin, target\n                )\n              ) and (\n                if expr.target then subject.query expr.target, target\n                else subject is target\n              ) and ( not expr.origin or subject.query expr.origin, origin )\n            break unless ceiling?\n            subject = subject.superstate\n\n        ( target, origin = @_current ) ->\n          ( search target, origin, target ) or\n          ( search target, origin, origin unless origin is target ) or\n          ( search target, origin, target.superstate, @root ) or\n          ( search target, origin, @root ) or\n          ( unless target.isIn origin\n            search target, origin, origin.superstate, origin.common target ) or\n          new TransitionExpression\n\n\n\n### [Prototype methods](#root-state--prototype-methods)\n\n\n#### [change](#root-state--prototype--change)\n\nAttempts to execute a state transition. Handles asynchronous transitions,\ngeneration of appropriate events, and construction of any necessary temporary\nvirtual states. Respects guards supplied in both the origin and `target`\nstates.\n\nThe `target` parameter may be either a `State` object within the tree of this\n`RootState`, or a string that resolves to a likewise targetable `State` when\nevaluated from the context of the most recently current state.\n\nThe `options` parameter is an optional map that may include:\n\n  * `args` : `Array` \u2014\u00a0arguments to be passed to a transition\u2019s `action`.\n  * `success` : `Function` \u2014\u00a0callback to be executed upon successful completion\n    of the transition.\n  * `failure` : `Function` \u2014\u00a0callback to be executed if the transition\n    attempt is blocked by a guard.\n\n      change: ( target, options ) ->\n        { root, owner } = this\n        current = @_current\n        transition = @_transition\n\nThe `origin` is defined as the controller\u2019s most recently current state that is\nnot a [`Transition`][].\n\n        origin = transition?.origin or current\n\nDepartures are not allowed from a state that is `final`.\n\n        return null if origin.attributes & FINAL\n\nEnsure that `target` is a valid `State`.\n\n        unless target instanceof State\n          target = if target then origin.query target else root\n        return null unless target\n        targetOwner = target.owner\n        return null if owner isnt targetOwner and\n          not targetOwner.isPrototypeOf owner\n\nResolve `options` to an object if necessary.\n\n        unless options then options = DEFAULT_OPTIONS\n        else if O.isArray options then options = args: options\n\nA transition cannot target an abstract state directly, so `target` must be\nreassigned to the appropriate concrete substate.\n\n        while target.attributes & ABSTRACT\n          return null unless target = target.defaultSubstate()\n\nIf any guards are in place for the given `origin` and `target`, both of those\nstates must consent to the transition.\n\n        unless options.forced\n          released = evaluateGuard origin, 'release', target\n          admitted = evaluateGuard target, 'admit', origin\n          unless released and admitted\n            options.failure?.call? this\n            return null\n\nIf `target` is a protostate, then the protostate must be virtualized locally\nand `target` must be reassigned to the new virtual state.\n\n        target = target.virtualize this unless target?.root is root\n\nA reference is held to the previously current state, or abortive transition.\n\n        source = current\n\nThe upcoming transition will start from its `source` and proceed within the\n`domain` of the least common ancestor between `source` and `target`.\n\n        domain = source.common target\n\nConclusivity is enforced by checking each state that will be exited against the\n`conclusive` attributes.\n\n        s = source; until s is domain\n          return null if s.attributes & CONCLUSIVE\n          s = s.superstate\n\nIf a previously initiated transition is still underway, it needs to be notified\nthat it will not finish.\n\n        transition?.abort()\n\nRetrieve the appropriate transition expression for this origin\/target pairing.\nIf none is defined, then an actionless default transition will be created and\napplied, causing the callback to return immediately.\n\n        @_transition = transition = new Transition target, source,\n          @getTransitionExpression target, origin\n\nPreparation for the transition begins by emitting a `depart` event on the\n`source` state.\n\n        source.emit 'depart', transition, VIA_PROTO\n        @_transition = transition = null if transition.aborted\n\nEnter into the transition state.\n\n        if transition\n          @_current = transition\n          transition.emit 'enter', VIA_NONE\n          @_transition = transition = null if transition.aborted\n\nWalk up to the top of the domain, emitting `exit` events for each state along\nthe way.\n\n        s = source; while transition and s isnt domain\n          s.emit 'exit', transition, VIA_PROTO\n          transition.superstate = s = s.superstate\n          @_transition = transition = null if transition.aborted\n\nA callback will be invoked from `transition.end()` to conclude the transition.\n\n        transition?.callback = ->\n          transition = null if transition.aborted\n\nTrace a path from `target` up to `domain`, then walk down it, emitting `enter`\nevents for each state along the way.\n\n          if transition\n            s = target; pathToState = []; while s isnt domain\n              pathToState.push s\n              s = s.superstate\n          s = domain; while transition and substate = pathToState.pop()\n            transition.superstate = substate\n            substate.emit 'enter', transition, VIA_PROTO\n            transition = null if transition.aborted\n            s = substate\n\nExit from the transition state.\n\n          if transition\n            transition.emit 'exit', VIA_NONE\n            transition = null if transition.aborted\n\nTerminate the transition with an `arrive` event on the targeted state.\n\n          if transition\n            @_current = target\n            target.emit 'arrive', transition, VIA_PROTO\n\nAny virtual states that were previously active may now be discarded.\n\n            s = origin; while s.attributes & VIRTUAL\n              ss = s.superstate\n              do s.destroy\n              s = ss\n\nNow complete, the `Transition` instance can be discarded.\n\n            do transition.destroy\n            @_transition = transition = null\n\n            options.success?.call? this\n\n            return target\n\n          return null\n\nAt this point the transition is attached to the `domain` state and is ready to\nproceed.\n\n        return transition?.start.apply( transition, options.args ) or @_current\n","old_contents":"## [RootState](#root-state)\n\n    class RootState extends State\n\n      { VIRTUAL, ABSTRACT, CONCLUSIVE, FINAL } = this\n      { VIA_NONE, VIA_PROTO } = this\n\n      DEFAULT_OPTIONS = {}\n\n\n### [Constructor](#root-state--constructor)\n\n      constructor: ( owner, expression, options ) ->\n        @owner = owner or = {}\n        unless expression instanceof StateExpression\n          expression = new StateExpression expression\n        if options?\n        then if typeof options is 'string' then options = initialState: options\n        else options = DEFAULT_OPTIONS\n\nAssign to `owner` an **accessor** to its state implementation.\n\n        @accessorName = accessorName = options.name or 'state'\n        owner[ accessorName ] = createAccessor owner, accessorName, this\n\nA root state\u2019s `name` is by definition the empty-string.\n\n        super owner, @name = '', expression\n\nDetermine the initial state, and set the `current` state to that.\n\n        current = if options.initialState?\n        then this.query options.initialState\n        else this.initialSubstate() or this\n\nThe initial state may be `abstract`, in which case currency must be forwarded\nto its default `concrete` substate.\n\n        if current.attributes & ABSTRACT\n          current = current.defaultSubstate() or current\n\nThe previous redirections may have left `current` pointing to a protostate, in\nwhich case a virtual state must be created in `this` root\u2019s tree.\n\n        if current.root isnt this then current = current.virtualize this\n\nThe authoritative property reference to the owner\u2019s `current` state.\n\n        @_current = current\n\nWhile a `Transition` is underway, `_current` will be a reference to that\ntransition. To further distinguish this condition, an identical reference is\nalso held at `_transition`.\n\n        @_transition = null\n\n\n\n### [Private functions](#root-state--private)\n\n\n#### [createAccessor](#root-state--private--create-accessor)\n\nReturns the `accessor` function that will serve as an owner object\u2019s interface\nto its state implementation.\n\n      createAccessor = ( owner, name, root ) ->\n\n        accessor = ( input, args... ) ->\n          current = root._current\n\n          if this is owner\n            return current unless input?\n            return current.change input.call this if typeof input is 'function'\n            if typeof input is 'string' and\n                ( match = input.match rxTransitionArrow ) and\n                  method = transitionArrowMethods[ match[1] ]\n              return if args.length\n              then current[ method ].apply current, [ match[2] ].concat args\n              else current[ method ] match[2]\n            return current.query.apply current, arguments\n\nCalling the accessor of a prototype means that `this` requires its own accessor\nand root state. Creating a new `RootState` will have the desired side-effect of\nalso creating the object\u2019s new accessor, to which the call is then forwarded.\n\n          else if owner.isPrototypeOf(this) and not O.hasOwn.call this, name\n            new RootState this, null, { name, initialState: current.path() }\n            return @[ name ].apply this, arguments\n\n        accessor.isAccessor = true\n\n        if O.env.debug\n          accessor.toString = ->\n            \"[accessor] -> #{ root._current.path() }\"\n\n        accessor\n\n\n#### [evaluateGuard](#root-state--private--evaluate-guard)\n\nReturns the boolean result of a `guard` function in the `context` of a `State`,\nas evaluated `against` another `State`. Defaults to `true` if no guard exists.\n\n      evaluateGuard = ( context, guard, against ) ->\n        guard = context.guard guard if typeof guard is 'string'\n        return true unless guard\n\n        args = O.slice.call arguments, 1\n        for own key, value of guard\n          valueIsFn = typeof value is 'function'\n          selectors = O.trim( key ).split \/\\s*,+\\s*\/\n          for selector in selectors when context.query selector, against\n            result = if valueIsFn then value.apply context, args else value\n            break\n          break unless result\n        !!result\n\n\n#### [getTransitionExpression](#root-state--private--get-transition-expression)\n\nFinds the appropriate transition expression for the given `target` and `origin`\nstates. If no matching transitions are defined in either state or any of their\nancestors, a generic actionless transition expression for the pair is returned.\n\n      getTransitionExpression: do ->\n\n        search = ( target, origin, subject, ceiling ) ->\n          while subject and subject isnt ceiling\n            for own key, expr of subject.transitions()\n              return expr if (\n                not ( guards = expr.guards ) or (\n                  not ( admit = guards.admit ) or\n                  O.isEmpty( admit ) or\n                  evaluateGuard.call origin, admit, target, origin\n                ) and (\n                  not ( release = guards.release ) or\n                  O.isEmpty( release ) or\n                  evaluateGuard.call target, release, origin, target\n                )\n              ) and (\n                if expr.target then subject.query expr.target, target\n                else subject is target\n              ) and ( not expr.origin or subject.query expr.origin, origin )\n            break unless ceiling?\n            subject = subject.superstate\n\n        ( target, origin = @_current ) ->\n          ( search target, origin, target ) or\n          ( search target, origin, origin unless origin is target ) or\n          ( search target, origin, target.superstate, @root ) or\n          ( search target, origin, @root ) or\n          ( unless target.isIn origin\n            search target, origin, origin.superstate, origin.common target ) or\n          new TransitionExpression\n\n\n\n### [Prototype methods](#root-state--prototype-methods)\n\n\n#### [change](#root-state--prototype--change)\n\nAttempts to execute a state transition. Handles asynchronous transitions,\ngeneration of appropriate events, and construction of any necessary temporary\nvirtual states. Respects guards supplied in both the origin and `target`\nstates.\n\nThe `target` parameter may be either a `State` object within the tree of this\n`RootState`, or a string that resolves to a likewise targetable `State` when\nevaluated from the context of the most recently current state.\n\nThe `options` parameter is an optional map that may include:\n\n  * `args` : `Array` \u2014\u00a0arguments to be passed to a transition\u2019s `action`.\n  * `success` : `Function` \u2014\u00a0callback to be executed upon successful completion\n    of the transition.\n  * `failure` : `Function` \u2014\u00a0callback to be executed if the transition\n    attempt is blocked by a guard.\n\n      change: ( target, options ) ->\n        { root, owner } = this\n        current = @_current\n        transition = @_transition\n\nThe `origin` is defined as the controller\u2019s most recently current state that is\nnot a [`Transition`][].\n\n        origin = transition?.origin or current\n\nDepartures are not allowed from a state that is `final`.\n\n        return null if origin.attributes & FINAL\n\nEnsure that `target` is a valid [`State`][].\n\n        unless target instanceof State\n          target = if target then origin.query target else root\n        return null unless target\n        targetOwner = target.owner\n        return null if owner isnt targetOwner and\n          not targetOwner.isPrototypeOf owner\n\nResolve `options` to an object if necessary.\n\n        unless options then options = DEFAULT_OPTIONS\n        else if O.isArray options then options = args: options\n\nA transition cannot target an abstract state directly, so `target` must be\nreassigned to the appropriate concrete substate.\n\n        while target.attributes & ABSTRACT\n          return null unless target = target.defaultSubstate()\n\nIf any guards are in place for the given `origin` and `target`, both of those\nstates must consent to the transition.\n\n        unless options.forced\n          released = evaluateGuard origin, 'release', target\n          admitted = evaluateGuard target, 'admit', origin\n          unless released and admitted\n            options.failure?.call? this\n            return null\n\nIf `target` is a protostate, then the protostate must be virtualized locally\nand `target` must be reassigned to the new virtual state.\n\n        target = target.virtualize this unless target?.root is root\n\nA reference is held to the previously current state, or abortive transition.\n\n        source = current\n\nThe upcoming transition will start from its `source` and proceed within the\n`domain` of the least common ancestor between `source` and `target`.\n\n        domain = source.common target\n\nConclusivity is enforced by checking each state that will be exited against the\n`conclusive` attributes.\n\n        s = source; until s is domain\n          return null if s.attributes & CONCLUSIVE\n          s = s.superstate\n\nIf a previously initiated transition is still underway, it needs to be notified\nthat it will not finish.\n\n        transition?.abort()\n\nRetrieve the appropriate transition expression for this origin\/target pairing.\nIf none is defined, then an actionless default transition will be created and\napplied, causing the callback to return immediately.\n\n        @_transition = transition = new Transition target, source,\n          @getTransitionExpression target, origin\n\nPreparation for the transition begins by emitting a `depart` event on the\n`source` state.\n\n        source.emit 'depart', transition, VIA_PROTO\n        @_transition = transition = null if transition.aborted\n\nEnter into the transition state.\n\n        if transition\n          @_current = transition\n          transition.emit 'enter', VIA_NONE\n          @_transition = transition = null if transition.aborted\n\nWalk up to the top of the domain, emitting `exit` events for each state along\nthe way.\n\n        s = source; while transition and s isnt domain\n          s.emit 'exit', transition, VIA_PROTO\n          transition.superstate = s = s.superstate\n          @_transition = transition = null if transition.aborted\n\nA callback will be invoked from `transition.end()` to conclude the transition.\n\n        transition?.callback = ->\n          transition = null if transition.aborted\n\nTrace a path from `target` up to `domain`, then walk down it, emitting `enter`\nevents for each state along the way.\n\n          if transition\n            s = target; pathToState = []; while s isnt domain\n              pathToState.push s\n              s = s.superstate\n          s = domain; while transition and substate = pathToState.pop()\n            transition.superstate = substate\n            substate.emit 'enter', transition, VIA_PROTO\n            transition = null if transition.aborted\n            s = substate\n\nExit from the transition state.\n\n          if transition\n            transition.emit 'exit', VIA_NONE\n            transition = null if transition.aborted\n\nTerminate the transition with an `arrive` event on the targeted state.\n\n          if transition\n            @_current = target\n            target.emit 'arrive', transition, VIA_PROTO\n\nAny virtual states that were previously active may now be discarded.\n\n            s = origin; while s.attributes & VIRTUAL\n              ss = s.superstate\n              do s.destroy\n              s = ss\n\nNow complete, the `Transition` instance can be discarded.\n\n            do transition.destroy\n            @_transition = transition = null\n\n            options.success?.call? this\n\n            return target\n\n          return null\n\nAt this point the transition is attached to the `domain` state and is ready to\nproceed.\n\n        return transition?.start.apply( transition, options.args ) or @_current\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7e434ccb8ebc8344ab5943b667a330ea654b6da9","subject":"move loading of global libraries into celestrium","message":"move loading of global libraries into celestrium\n","repos":"tmad4000\/celestrium","old_file":"core-coffee\/celestrium.litcoffee","new_file":"core-coffee\/celestrium.litcoffee","new_contents":"## API\n\nthis is used to populate the listed singleton plugins with their single instance\n\nother plugins may access this instance through requiring the module.\n\n### Example\n\n```coffeescript\nrequire [\"pluginPath\"], (plugin) -> plugin.getInstance().foo()`\n```\n\n### Example Usage\n\nNow in your `main` coffeescript file, you can do something like this.\n\n```coffeescript\nrequirejs [\"celestrium\"], (Celestrium) ->\n  Celestrium.init\n    \"core\/workspace\":\n      \"el\": document.querySelector \"#workspace\"\n```\n\nonly plugins which instantiate the `singleton` class should be used with `init`\n\n## Code\n\nLoad the global libraries contained within celestrium here.\nThis offloads this responsibility from the user.\n\n    globalLibs = [\n      'lib\/jquery',\n      'lib\/jquery.typeahead',\n      'lib\/underscore',\n      'lib\/backbone',\n      'lib\/d3',\n    ]\n\nThe actual module returns only an object with an init method.\n\n    define [], () -> init: (singletonPlugins, callback) ->\n\nInclude this nested require call so as to load the above libraries.\nNow, these libraries are available globally per the norm.\n\nThis is probably bad practice and less modular, but is practical.\n\n      require globalLibs, () ->\n\nNow actually require the different plugins.\nNote that, they should all be required at once and the callback called within the require callback so as to ensure the callback is only call onced these plugin instances have been initialized.\n\n        pluginPaths = _.keys(singletonPlugins)\n        require pluginPaths, (plugins...) ->\n          i = 0\n          for plugin in plugins\n            args = singletonPlugins[pluginPaths[i]]\n            plugin.init args\n            i += 1\n          callback()\n","old_contents":"## API\n\nthis is used to populate the listed singleton plugins with their single instance\n\nother plugins may access this instance through requiring the module.\n\n### Example\n\n```coffeescript\nrequire [\"pluginPath\"], (plugin) -> plugin.getInstance().foo()`\n```\n\n### Example Usage\n\nNow in your `main` coffeescript file, you can do something like this.\n\n```coffeescript\nrequirejs [\"celestrium\"], (Celestrium) ->\n  Celestrium.init\n    \"core\/workspace\":\n      \"el\": document.querySelector \"#workspace\"\n```\n\nonly plugins which instantiate the `singleton` class should be used with `init`\n\n## Code\n\n    define [], () -> init: (singletonPlugins, callback) ->\n      pluginPaths = _.keys(singletonPlugins)\n      require pluginPaths, (plugins...) ->\n        i = 0\n        for plugin in plugins\n          args = singletonPlugins[pluginPaths[i]]\n          plugin.init args\n          i += 1\n        callback()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6db119caf401b9b18e16331243ff4c8acbeee3e9","subject":"polling","message":"polling\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onerror: (msg, options) ->\n      console.log msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      @_send @_createCall method, data, callbacks, options\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       throw new Error \"Unknown method: #{data.method}\"\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      @callsCache[data.id].handle data.data, data\n\n     _handlePoll: (data, options) ->\n      throw new Error \"Poll not implemented\"\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n     _onError: (e) -> console.log e\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       console.log 'error', e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       throw new Error \"Poll without response: #{data.id}\"\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n\n     progress: (progress, data) ->\n      @port.respond this, 'progress', data, progress: progress, @options\n\n     success: (data) ->\n      @port.respond this, 'success', data, {}, @options\n\n     fail: (data) ->\n      @port.respond this, 'fail', data, {}, @options\n\n\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     onerror: (msg, options) ->\n      console.log msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      @_send @_createCall method, data, callbacks, options\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call @callsCounter, method, data, callbacks\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       throw new Error \"Unknown method: #{data.method}\"\n      @handlers[data.method] data.data, data, new Response data, this, options\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      @callsCache[data.id].handle data.data, data\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n     _onError: (e) -> console.log e\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n\n     _send: (data) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       console.log 'error', e\n\n      req.write data\n      req.end()\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     setup: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e838c7545f9161833df39bc0e3018ee7b3ee4359","subject":"change the property prefixes","message":"change the property prefixes\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08_request.litcoffee","new_file":"docs\/08_request.litcoffee","new_contents":"# Batman Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented the platform layer files.\n\n### Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.node.js`: \"querystring\" and \"url\"\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\n  Batman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\n  In other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n    \n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n There are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n 1. `loading()`: fired before `send()` has been called.\n\n    test \"Demonstrate the loading event\", 1, ->\n       new Batman.Request\n         url: \"http::\/\/batmanjs.org\"\n         loading: ->\n           ok true, \"After send but before the request is made\"\n\n 2. `loaded()`: fired after the request is complete\n\n     test \"Demo the loaded event\", 1, ->\n       Batman.Request.setupMockedResponse()\n       Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n       new Batman.Request\n         url: \"http:\/\/batmanjs.org\"\n         loaded: ->\n           ok true, \"Loaded\"\n\n 3. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n    test \"Demo the error event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        error: (xhr) ->\n          ok true, \"Error\"\n\n 4. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n    test \"Demonstrate the success event\", 1,  ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", response\n\n## .status\n  The response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\n  The response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : PlainObject\n  An key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request( options : PlainObject )\n\n  Constructs a new `Batman.Request` with the supplied options\n\n  `options` description\n  1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n  2. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`\n\n    test \"method test\", ->\n      Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"POST\"\n        data: { some: \"data\" }\n        success: (response) ->\n          ok true\n\n  3. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n  4. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n    test \"contentType default\", ->\n       req = new Batman.Request\n       equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n  5. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n    test \"autosend test\", ->\n      response_sent = false\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        success: (response) ->\n          response_sent = true\n      ok !response_sent\n      req.send()\n      ok response_sent\n\n  6. `username`: username for authentication\n  7. `password`: password for authentication\n  8. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send( [data] )\n  If `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","old_contents":"# Batman Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented the platform layer files.\n\n## Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.node.js`: \"querystring\" and \"url\"\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n## How to use Batman Request\n\n  Batman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\n  In other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n    \n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n## Lifecycle events\n There are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n 1. `loading()`: fired before `send()` has been called.\n\n    test \"Demonstrate the loading event\", 1, ->\n       new Batman.Request\n         url: \"http::\/\/batmanjs.org\"\n         loading: ->\n           ok true, \"After send but before the request is made\"\n\n 2. `loaded()`: fired after the request is complete\n\n     test \"Demo the loaded event\", 1, ->\n       Batman.Request.setupMockedResponse()\n       Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n       new Batman.Request\n         url: \"http:\/\/batmanjs.org\"\n         loaded: ->\n           ok true, \"Loaded\"\n\n 3. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n    test \"Demo the error event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        error: (xhr) ->\n          ok true, \"Error\"\n\n 4. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n    test \"Demonstrate the success event\", 1,  ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", response\n\n## Request::status\n  The response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## Request::response\n  The response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## Request::responseHeaders : PlainObject\n  An key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## Request( options : PlainObject )\n\n  Constructs a new `Batman.Request` with the supplied options\n\n  `options` description\n  1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n  2. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`\n\n    test \"method test\", ->\n      Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"POST\"\n        data: { some: \"data\" }\n        success: (response) ->\n          ok true\n\n  3. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n  4. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n    test \"contentType default\", ->\n       req = new Batman.Request\n       equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n  5. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n    test \"autosend test\", ->\n      response_sent = false\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        success: (response) ->\n          response_sent = true\n      ok !response_sent\n      req.send()\n      ok response_sent\n\n  6. `username`: username for authentication\n  7. `password`: password for authentication\n  8. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## Request::send( [data] )\n  If `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ad58431c0554293748768074e8435e918a93ab7c","subject":"Fix a <","message":"Fix a <\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/match-sched.litcoffee","new_file":"src\/coffee\/match-sched.litcoffee","new_contents":"Match Schedule\n==============\n\nThe match schedule, as with the day schedule, is mainly managed within the basic\ndata module - this module defines only useful utilities.\n\nConstants\n---------\n\nWe define two constants within this module -- *MATCH_PREROLL*, and\n*MATCH_LENGTH*.\n\n*MATCH_PREROLL* is the amount of time, in seconds, before the start\ntime of a match during which it should be considered active. Its\ncurrent value is 180 seconds, which is 30 seconds of swap time and\n60 seconds boot period.\n\n    MATCH_PREROLL = 30 + 60\n\n*MATCH_LENGTH* is simply the length of a match in seconds, including\nsetup and tear-down time - presently 5 minutes.\n\n    MATCH_LENGTH = 60*5\n\n*MATCH_POSTROLL* is the amount of time, in seconds, between the\nstart time of a match and when it is considered to have ended. It\nis defined in terms of *MATCH_PREROLL* and *MATCH_LENGTH*.\n\n    MATCH_POSTROLL = MATCH_LENGTH - MATCH_PREROLL\n\nMatch Tracking\n--------------\n\nThe *firstMatchAfter* function takes as its argument a match schedule,\nand a *reference point*, being a JavaScript *Date* object. It finds\nthe first match in the schedule whose consideration period begins\nat or after the reference point. It may also take an optional\n*feasibility condition*, to further filter the matches considered.\n\n    firstMatchAfter = (schedule, referencePoint, feasilibilty) ->\n\nIf the feasibility condition is unspecified, we use a default\ncondition which simply accepts all matches.\n\n        unless feasibility?\n            feasibility = (match) -> yes\n\nWe convert the reference point into a UNIX timestamp for our use.\n\n        referenceUNIX = referencePoint.valueOf() * 0.001\n\nWe then use Underscore's *find* function to find the first satisfying\nmatch.\n\n        _.find schedule, (match) ->\n            return no unless feasibility(match, referencePoint)\n            match.start - MATCH_PREROLL >= referenceUNIX\n\nCurrent Match\n-------------\n\nWe provide the current match (nullable) via the *CurrentMatch*\nproperty. It is a map on the *Data.matchSchedule* property, and the\nclock.\n\nFirst, we define the data source.\n\n    currentMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n\nWe then define the stream itself, as a map over the input source.\n\n    currentMatch = currentMatchSource.map (data) ->\n\nWe find the first match active now, using *firstMatchAfter*. A\nfeasibility condition is passed to constrain matches to only those\nwhich have not ended.\n\n        firstMatchAfter data.schedule, data.clock, (match, ref) ->\n            not (match.start + MAX_POSTROLL > ref)\n\nThe public property simply removes the duplicates from that stream.\n\n    window.CurrentMatch = currentMatch.skipDuplicates()\n\nNext Match\n----------\n\nWe also provide the next match (nullable) via the *NextMatch*\nproperty. It is defined similarly to *CurrentMatch*, except with\nthe additional feasibility condition of not being the current match.\n\nWe first define the data source.\n\n    nextMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n            currentMatch: CurrentMatch\n\nWe then define the stream itself, again as a map over the source.\n\n    nextMatch = nextMatchSource.map (data) ->\n\nAs with the current match, we use *firstMatchAfter*, with a feasibility\ncondition this time specifying that the match is not the current\nmatch.\n\n        firstMatchAfter data.schedule, data.clock, (match) ->\n            match.key isnt data.currentMatch?.key\n\nWe then publish it by removing duplicates.\n\n    window.NextMatch = nextMatch.skipDuplicates()\n\n","old_contents":"Match Schedule\n==============\n\nThe match schedule, as with the day schedule, is mainly managed within the basic\ndata module - this module defines only useful utilities.\n\nConstants\n---------\n\nWe define two constants within this module -- *MATCH_PREROLL*, and\n*MATCH_LENGTH*.\n\n*MATCH_PREROLL* is the amount of time, in seconds, before the start\ntime of a match during which it should be considered active. Its\ncurrent value is 180 seconds, which is 30 seconds of swap time and\n60 seconds boot period.\n\n    MATCH_PREROLL = 30 + 60\n\n*MATCH_LENGTH* is simply the length of a match in seconds, including\nsetup and tear-down time - presently 5 minutes.\n\n    MATCH_LENGTH = 60*5\n\n*MATCH_POSTROLL* is the amount of time, in seconds, between the\nstart time of a match and when it is considered to have ended. It\nis defined in terms of *MATCH_PREROLL* and *MATCH_LENGTH*.\n\n    MATCH_POSTROLL = MATCH_LENGTH - MATCH_PREROLL\n\nMatch Tracking\n--------------\n\nThe *firstMatchAfter* function takes as its argument a match schedule,\nand a *reference point*, being a JavaScript *Date* object. It finds\nthe first match in the schedule whose consideration period begins\nat or after the reference point. It may also take an optional\n*feasibility condition*, to further filter the matches considered.\n\n    firstMatchAfter = (schedule, referencePoint, feasilibilty) ->\n\nIf the feasibility condition is unspecified, we use a default\ncondition which simply accepts all matches.\n\n        unless feasibility?\n            feasibility = (match) -> yes\n\nWe convert the reference point into a UNIX timestamp for our use.\n\n        referenceUNIX = referencePoint.valueOf() * 0.001\n\nWe then use Underscore's *find* function to find the first satisfying\nmatch.\n\n        _.find schedule, (match) ->\n            return no unless feasibility(match, referencePoint)\n            match.start - MATCH_PREROLL <= referenceUNIX\n\nCurrent Match\n-------------\n\nWe provide the current match (nullable) via the *CurrentMatch*\nproperty. It is a map on the *Data.matchSchedule* property, and the\nclock.\n\nFirst, we define the data source.\n\n    currentMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n\nWe then define the stream itself, as a map over the input source.\n\n    currentMatch = currentMatchSource.map (data) ->\n\nWe find the first match active now, using *firstMatchAfter*. A\nfeasibility condition is passed to constrain matches to only those\nwhich have not ended.\n\n        firstMatchAfter data.schedule, data.clock, (match, ref) ->\n            not (match.start + MAX_POSTROLL > ref)\n\nThe public property simply removes the duplicates from that stream.\n\n    window.CurrentMatch = currentMatch.skipDuplicates()\n\nNext Match\n----------\n\nWe also provide the next match (nullable) via the *NextMatch*\nproperty. It is defined similarly to *CurrentMatch*, except with\nthe additional feasibility condition of not being the current match.\n\nWe first define the data source.\n\n    nextMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n            currentMatch: CurrentMatch\n\nWe then define the stream itself, again as a map over the source.\n\n    nextMatch = nextMatchSource.map (data) ->\n\nAs with the current match, we use *firstMatchAfter*, with a feasibility\ncondition this time specifying that the match is not the current\nmatch.\n\n        firstMatchAfter data.schedule, data.clock, (match) ->\n            match.key isnt data.currentMatch?.key\n\nWe then publish it by removing duplicates.\n\n    window.NextMatch = nextMatch.skipDuplicates()\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2df7de1861ebfb154b118c597b13bc9a9b09fa31","subject":"Pass proto to ensure consistency","message":"Pass proto to ensure consistency\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (done) =>\n        proto  = @.__proto__\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"37bc139c75f941906fe8c5dd317230cf1964f3de","subject":"Ensure we don't add the same dependencies twice","message":"Ensure we don't add the same dependencies twice\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/skyll.litcoffee","new_file":"lib\/skyll.litcoffee","new_contents":"    Module = require '.\/module'\n    Carver = require '.\/carver'\n    q      = require 'q'\n\n    class Skyll extends Module\n      deps: [ 'q' ]\n      pub:  [ 'craft' ]\n\n      render_pipeline: [ ]\n      starting_row:    0\n\n      grid: undefined\n\n      cell:\n        width:  0\n        height: 0\n\n      pathfinder: (neighbors) ->\n        o = [ ]\n\n        for n in [1..(neighbors.length \/ 1)]\n          c = 1 \/ neighbors.length\n\n          if neighbors[n - 1] == 'RIGHT'\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * ((2 \/ c) * 0.5)) * c\n          else\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * (0.5 \/ c)) * c\n\n        chance = Math.random()\n\n        for option in o\n          neighbor = Object.keys(option)[0]\n\n          return neighbor if option[neighbor] > chance\n\n      initialize: (params) =>\n        deferred = q.defer()\n\n        @grid = params.grid\n        @cell = params.cell\n\n        @ctor_params = { }\n\n        @starting_row = params.starting_row\n\n        for p in params.pipeline\n          @ctor_params[p] =\n            width:  params.cell.width  * params.grid[0].length\n            height: params.cell.height * params.grid.length\n            cell:   params.cell\n\n          @deps.push p unless @deps.includes p\n\n        super().then =>\n          for p in params.pipeline\n            render_pipeline.push @[p]\n\n          deferred.resolve @\n\n        deferred.promise\n\n      craft: (level) =>\n        new Carver()\n          .initialize @grid, @starting_row, @pathfinder\n          .then (mod)  => mod.carve_path()\n          .then (path) => @q.all @render_pipeline.map (p) => p.render level, path\n          .then        => @done()\n\n    module.exports = Skyll\n","old_contents":"    Module = require '.\/module'\n    Carver = require '.\/carver'\n    q      = require 'q'\n\n    class Skyll extends Module\n      deps: [ 'q' ]\n      pub:  [ 'craft' ]\n\n      render_pipeline: [ ]\n      starting_row:    0\n\n      grid: undefined\n\n      cell:\n        width:  0\n        height: 0\n\n      pathfinder: (neighbors) ->\n        o = [ ]\n\n        for n in [1..(neighbors.length \/ 1)]\n          c = 1 \/ neighbors.length\n\n          if neighbors[n - 1] == 'RIGHT'\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * ((2 \/ c) * 0.5)) * c\n          else\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * (0.5 \/ c)) * c\n\n        chance = Math.random()\n\n        for option in o\n          neighbor = Object.keys(option)[0]\n\n          return neighbor if option[neighbor] > chance\n\n      initialize: (params) =>\n        deferred = q.defer()\n\n        @grid = params.grid\n        @cell = params.cell\n\n        @ctor_params = { }\n\n        @starting_row = params.starting_row\n\n        for p in params.pipeline\n          @ctor_params[p] =\n            width:  params.cell.width  * params.grid[0].length\n            height: params.cell.height * params.grid.length\n            cell:   params.cell\n\n          @deps.push p\n\n        super().then =>\n          for p in params.pipeline\n            render_pipeline.push @[p]\n\n          deferred.resolve @\n\n        deferred.promise\n\n      craft: (level) =>\n        new Carver()\n          .initialize @grid, @starting_row, @pathfinder\n          .then (mod)  => mod.carve_path()\n          .then (path) => @q.all @render_pipeline.map (p) => p.render level, path\n          .then        => @done()\n\n    module.exports = Skyll\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b3b838d941cd15d5c02cffb8ea3c365132cda096","subject":"Elegance","message":"Elegance\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"client\/packages.litcoffee","new_file":"client\/packages.litcoffee","new_contents":"\nThis is where shrub's package system meets Angular's module system. Packages'\nimplementations of controllers, services, filters, providers, and directives\nare gathered and registered into Angular.\n\n    angular.module('shrub.packages', [\n      'shrub.require'\n      'shrub.pkgman'\n    ])\n\n      .config([\n        '$compileProvider', '$controllerProvider', '$filterProvider'\n        '$injector', '$provide', 'shrub-pkgmanProvider'\n        'shrub-requireProvider'\n        (\n          $compileProvider, $controllerProvider, $filterProvider\n          $injector, $provide, pkgman, {require}\n        ) ->\n\n          config = require 'config'\n          debug = require('debug') 'shrub:angular'\n\nSet an injector so that Angular injection can occur out of band.\n\n          angular_ = require 'angular'\n          angular_.setInjector $injector\n\nInvoke hook `controller`.\nAllows packages to define Angular controllers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          debug 'Registering controllers...'\n\n          for path, injected of pkgman.invoke 'controller'\n            controllerName = pkgman.normalizePath path\n            debug controllerName\n            $controllerProvider.register controllerName, injected\n\n          debug 'Controllers registered.'\n\n          debug 'Registering directives...'\n\nNormalize, augment, and register a directive.\n\n          prepareDirective = (name, path, injected) -> ($injector) ->\n\nNormalize the directive to object form.\n\n            directive = $injector.invoke injected\n            directive = link: directive if angular.isFunction directive\n\nEnsure a compilation function exists for the directive which by default\nreturns the `link` function.\n\n            directive.compile ?= -> directive.link\n\nProxy any defined link function, firing any attached any controllers' `link`\nmethod, as well as passing execution on to the original `link` function.\n\n            link = directive.link\n            directive.link = (scope, element, attrs, controllers) ->\n              if controllers?\n                controllers = [controllers] unless angular.isArray controllers\n                controller.link? arguments... for controller in controllers\n\n              link? arguments...\n\nEnsure the directive has a name. Defaults to the normalized path of the\nimplementing package.\n\n            directive.name ?= name\n\nIf controller binding is specified, the controller defaults to the directive\nname. In other words, if you define a directive and a controller in the same\npackage, and specify `directive.bindToController = true`, your directive will\ninclude the controller automatically.\n\n            if directive.bindToController\n              directive.controller ?= directive.name\n\nHandle a bunch of internal Angular normalization.\n\n            directive.require ?= directive.controller and directive.name\n            directive.priority ?= 0\n            directive.restrict ?= 'EA'\n\n            if angular.isObject directive.scope\n              directive.$$isolateBindings = isolateBindingsFor directive\n\nInvoke hook `augmentDirective`.\nAllows packages to augment the directives defined by packages. One example is\nthe automatic relinking functionality implemented by\n[shrub-skin](..\/packages\/shrub-skin\/client\/index.coffee#L12).\n\n            for injectedDirective in pkgman.invokeFlat(\n              'augmentDirective', directive, path\n            )\n              $injector.invoke injectedDirective\n\nHaven't gone deep enough into Angular to understand why this has to be, but it\ndoes.\n\n            directive.index = 0\n            return [directive]\n\nInternal Angular state that we have to reset.\n\n          isolateBindingsFor = (directive) ->\n\n            LOCAL_REGEXP = \/^\\s*([@&]|=(\\*?))(\\??)\\s*(\\w*)\\s*$\/\n\n            bindings = {}\n\n            for scopeName, definition of directive.scope\n              match = definition.match LOCAL_REGEXP\n\n              throw angular.$$minErr('$compile')(\n                'iscp'\n                \"\n                  Invalid isolate scope definition for directive '{0}'.\n                  Definition: {... {1}: '{2}' ...}\n                \"\n                directive.name, scopeName, definition\n              ) unless match\n\n              bindings[scopeName] =\n                mode: match[1][0]\n                collection: match[2] is '*'\n                optional: match[3] is '?'\n                attrName: match[4] or scopeName\n\n            return bindings\n\nInvoke hook `directive`.\nAllows packages to define Angular directives. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          for path, injected of pkgman.invoke 'directive'\n            do (path, injected) ->\n              directiveName = pkgman.normalizePath path\n              debug directiveName\n\nFirst, register it through Angular's normal registration mechanism. This sets\na bunch of internal state we don't have access to.\n\n              $compileProvider.directive directiveName, injected\n\nFollow that by normalizing, augmenting, and registering the directive again.\nIt will run over the previous definition, ensuring everything works nicely.\n\n              $provide.factory \"#{directiveName}Directive\", [\n                '$injector', prepareDirective directiveName, path, injected\n              ]\n\n          debug 'Directives registered.'\n\n          debug 'Registering filters...'\n\nInvoke hook `filter`.\nAllows packages to define Angular filters. Implementations should return a\nfunction.\n\n          for path, injected of pkgman.invoke 'filter'\n            filterName = pkgman.normalizePath path\n            debug filterName\n            $filterProvider.register filterName, injected\n\n          debug 'Filters registered.'\n\nInvoke hook `provider`.\nAllows packages to define Angular providers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          debug 'Registering providers...'\n\n          for path, provider of pkgman.invoke 'provider'\n            debug path\n            $provide.provider path, provider\n\n          debug 'Providers registered.'\n\nInvoke hook `service`.\nAllows packages to define Angular services. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          debug 'Registering services...'\n\n          for path, injected of pkgman.invoke 'service'\n            debug path\n            $provide.service path, injected\n\n          debug 'Services registered.'\n\n      ])\n\nThe module that provides Angular with access to Shrub's package manager.\n\n    angular.module('shrub.pkgman', [\n      'shrub.require'\n    ])\n\n      .provider 'shrub-pkgman', [\n        '$provide', 'shrub-requireProvider'\n        ($provide, {require}) ->\n\n          config = require 'config'\n          debug = require('debug') 'shrub:pkgman'\n          pkgman = require 'pkgman'\n\n          debug 'Loading packages...'\n\nLoad the package list from configuration.\n\n          pkgman.registerPackageList config.get 'packageList'\n\n          debug 'Packages loaded.'\n\nSimply pass along pkgman as the 'service'.\n\n          pkgman.$get = -> pkgman\n\n          return pkgman\n      ]\n","old_contents":"\nThis is where shrub's package system meets Angular's module system. Packages'\nimplementations of controllers, services, filters, providers, and directives\nare gathered and registered into Angular.\n\n    angular.module('shrub.packages', [\n      'shrub.require'\n      'shrub.pkgman'\n    ])\n\n      .config([\n        '$compileProvider', '$controllerProvider', '$filterProvider'\n        '$injector', '$provide', 'shrub-pkgmanProvider'\n        'shrub-requireProvider'\n        (\n          $compileProvider, $controllerProvider, $filterProvider\n          $injector, $provide, pkgman, {require}\n        ) ->\n\n          config = require 'config'\n          debug = require('debug') 'shrub:angular'\n\nSet an injector so that Angular injection can occur out of band.\n\n          angular_ = require 'angular'\n          angular_.setInjector $injector\n\nInvoke hook `controller`.\nAllows packages to define Angular controllers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          debug 'Registering controllers...'\n\n          for path, injected of pkgman.invoke 'controller'\n            controllerName = pkgman.normalizePath path\n            debug controllerName\n            $controllerProvider.register controllerName, injected\n\n          debug 'Controllers registered.'\n\n          debug 'Registering directives...'\n\nNormalize, augment, and register a directive.\n\n          prepareDirective = (name, path, injected) -> ($injector) ->\n            directive = $injector.invoke injected\n\nEnsure a compilation function exists for the directive, and ensure that by\ndefault it returns the `link` function.\n\n            if angular.isFunction directive\n              directive = link: directive\n              directive.compile = -> directive.link\n            else if not directive.compile\n              directive.compile = -> directive.link\n\nProxy any defined link function, firing any attached any controllers' `link`\nmethod, as well as passing execution on to the original `link` function.\n\n            link = directive.link\n            directive.link = (scope, element, attrs, controllers) ->\n              if controllers?\n                controllers = [controllers] unless angular.isArray controllers\n                controller.link? arguments... for controller in controllers\n\n              link? arguments...\n\nEnsure the directive has a name. Defaults to the normalized path of the\nimplementing package.\n\n            directive.name ?= name\n\nIf controller binding is specified, the controller defaults to the directive\nname. In other words, if you define a directive and a controller in the same\npackage, and specify `directive.bindToController = true`, your directive will\ninclude the controller automatically.\n\n            if directive.bindToController\n              directive.controller ?= directive.name\n\nHandle a bunch of internal Angular normalization.\n\n            directive.require ?= directive.controller and directive.name\n            directive.priority ?= 0\n            directive.restrict ?= 'EA'\n\n            if angular.isObject directive.scope\n              directive.$$isolateBindings = isolateBindingsFor directive\n\nInvoke hook `augmentDirective`.\nAllows packages to augment the directives defined by packages. One example is\nthe automatic relinking functionality implemented by\n[shrub-skin](..\/packages\/shrub-skin\/client\/index.coffee#L12).\n\n            for injectedDirective in pkgman.invokeFlat(\n              'augmentDirective', directive, path\n            )\n              $injector.invoke injectedDirective\n\nHaven't gone deep enough into Angular to understand why this has to be, but it\ndoes.\n\n            directive.index = 0\n            return [directive]\n\nInternal Angular state that we have to reset.\n\n          isolateBindingsFor = (directive) ->\n\n            LOCAL_REGEXP = \/^\\s*([@&]|=(\\*?))(\\??)\\s*(\\w*)\\s*$\/\n\n            bindings = {}\n\n            for scopeName, definition of directive.scope\n              match = definition.match LOCAL_REGEXP\n\n              throw angular.$$minErr('$compile')(\n                'iscp'\n                \"\n                  Invalid isolate scope definition for directive '{0}'.\n                  Definition: {... {1}: '{2}' ...}\n                \"\n                directive.name, scopeName, definition\n              ) unless match\n\n              bindings[scopeName] =\n                mode: match[1][0]\n                collection: match[2] is '*'\n                optional: match[3] is '?'\n                attrName: match[4] or scopeName\n\n            return bindings\n\nInvoke hook `directive`.\nAllows packages to define Angular directives. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          for path, injected of pkgman.invoke 'directive'\n            do (path, injected) ->\n              directiveName = pkgman.normalizePath path\n              debug directiveName\n\nFirst, register it through Angular's normal registration mechanism. This sets\na bunch of internal state we don't have access to.\n\n              $compileProvider.directive directiveName, injected\n\nFollow that by normalizing, augmenting, and registering the directive again.\nIt will run over the previous definition, ensuring everything works nicely.\n\n              $provide.factory \"#{directiveName}Directive\", [\n                '$injector', prepareDirective directiveName, path, injected\n              ]\n\n          debug 'Directives registered.'\n\n          debug 'Registering filters...'\n\nInvoke hook `filter`.\nAllows packages to define Angular filters. Implementations should return a\nfunction.\n\n          for path, injected of pkgman.invoke 'filter'\n            filterName = pkgman.normalizePath path\n            debug filterName\n            $filterProvider.register filterName, injected\n\n          debug 'Filters registered.'\n\nInvoke hook `provider`.\nAllows packages to define Angular providers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          debug 'Registering providers...'\n\n          for path, provider of pkgman.invoke 'provider'\n            debug path\n            $provide.provider path, provider\n\n          debug 'Providers registered.'\n\nInvoke hook `service`.\nAllows packages to define Angular services. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          debug 'Registering services...'\n\n          for path, injected of pkgman.invoke 'service'\n            debug path\n            $provide.service path, injected\n\n          debug 'Services registered.'\n\n      ])\n\nThe module that provides Angular with access to Shrub's package manager.\n\n    angular.module('shrub.pkgman', [\n      'shrub.require'\n    ])\n\n      .provider 'shrub-pkgman', [\n        '$provide', 'shrub-requireProvider'\n        ($provide, {require}) ->\n\n          config = require 'config'\n          debug = require('debug') 'shrub:pkgman'\n          pkgman = require 'pkgman'\n\n          debug 'Loading packages...'\n\nLoad the package list from configuration.\n\n          pkgman.registerPackageList config.get 'packageList'\n\n          debug 'Packages loaded.'\n\nSimply pass along pkgman as the 'service'.\n\n          pkgman.$get = -> pkgman\n\n          return pkgman\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cf20b21997ebd936af87d2ec2f28047c9061591a","subject":"add docs for View#source","message":"add docs for View#source\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/13_view.litcoffee","new_file":"docs\/13_view.litcoffee","new_contents":"# Batman.View\n\nFor a general explanation of `Batman.View` and how it works, see [the guide](\/docs\/views.html).\n\n\n## ::constructor(options = {})\n\nA `View` is a `Batman.Object`, so any options you pass are mixed in. Use this\nto set `html`, `node`, `superview`, `parentNode` and\/or your custom data.\n\n    test 'constructor mixes in options', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'constructor automatically adds to the superview if supplied', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      equal 1, superview.subviews.length\n\n\n## ::lookupKeypath(keypath) : Object\n\nTraverses up the view tree searching for the specified keypath, and returns the\nresult. This is equivalent to performing a `Batman.get` for each view above\n`this` in the tree, until a defined result is returned. The path it takes is as\nfollows:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\nIf there is no match, `undefined` is returned. However, if used in an accessor\nor binding, the entire path to the root will be registered as a potential\nsource of data. Consequently, if the keypath is later set on any part of the\nchain, the data will be correctly bound.\n\n`lookupKeypath` is the function invoked to locate data when evaluating a\nbinding.\n\n    test 'lookupKeypath returns the value if defined on the view', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.lookupKeypath('animal')\n\n    test 'lookupKeypath returns the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'cat')\n      subview = new Batman.View(superview: superview)\n      equal 'cat', subview.lookupKeypath('animal')\n\n\n## ::setKeypath(keypath, value) : Object\n\nTraverses the View tree searching for the specified keypath, and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is the function invoked to set data when using an input binding.\n\n    test 'setKeypath sets the value if defined on the view', ->\n      view = new Batman.View(animal: 'dog')\n\n      view.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'setKeypath sets the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'dog')\n      subview = new Batman.View(superview: superview)\n\n      subview.setKeypath('animal', 'cat')\n      equal 'cat', superview.get('animal')\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n\n## ::%node : Node\n\nA reference to the DOM node that this view encapsulates. The entire tree\nbeneath this node is also the responsibility of this view and\/or its subviews.\n\nAccessing `node` will load and parse the template on demand if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\nYou can also access a view's `node` in its methods, for example, activating jQuery plugins:\n\n```\nclass App.SearchBarView extends Batman.View\n  viewDidAppear: ->\n    $node = $(@get('node'))\n    $node.typeahead() # <= whatever jQuery plugin you want!\n```\n## ::%source : String\n\nThis string will be used to fetch a view's HTML, relative to [`Batman.config.pathToHTML`](\/docs\/configuration.html).\nYou don't need to add `.html` to this string -- it will be added automatically.\n\nInside a controller action, batman.js provides a default source based on the\ncontoller's [`routingKey`](\/docs\/api\/batman.controller.html#routingkey_and_minification) and the [controller action](\/docs\/api\/batman.controller.html#actions).\n\nYou can set `source` in the class definition:\n\n```\nclass App.HeaderNavigationView extends Batman.View\n  source: 'layout\/_header'\n```\n\nOr when calling `@render()` inside a controller action:\n\n```\nclass App.PostsController extends Batman.Controller\n  show: ->\n    @set('post', new App.Post)\n    if @get('post.isAlternative')\n      @render(source: \"posts\/alternative_new\")\n    else\n      @render() # defaults to 'posts\/new'\n```\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview. You can specify a view's HTML when you define the class:\n\n```\nclass App.SearchBarView extends Batman.View\n  html: \"<input type='text' placeholder='Enter a search term' \/>\"\n```\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n    test 'setting a source loads the correct template', ->\n      Batman.View.store.set('\/animals', '<div>cat<\/div>')\n      view = new Batman.View(source: '\/animals')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n## ::.superview : Batman.View\n\nA reference to the current superview (the direct ancestor in the tree). This is\nused for traversing the tree when searching for data, as in\n`View::lookupKeypath`.\n\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of a `View`. To manipulate the view tree, you should\noperate directly on this set \u2014 batman.js will automatically keep the DOM in\nsync with the logical tree.\n\n\n## ::subviews.add(view)\n\nAdding to a view's subview set will automatically update the tree, and parse\nthe template and bindings. If the superview is already in the DOM, this will\ninsert the current view's node into the DOM.\n\n    test 'adding to a superview parses bindings', ->\n      superview = new Batman.View()\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      superview.subviews.add(view)\n      equal 'cat', view.get('node').firstChild.innerHTML\n\n\n## ::subviews.remove(view)\n\nRemoving from a view's subview set will automatically remove the subview from\nthe DOM.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View(html: '', parentNode: document.body)\n      superview.get('node')\n      view = new Batman.View(html: '', superview: superview)\n\n      ok Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n      superview.subviews.remove(view)\n      ok not Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent, without killing it.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.removeFromSuperview()\n      ok not superview.subviews.has(view)\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n    test 'die kills the view', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.die()\n      equal true, view.isDead\n      equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n    test 'destroySubviews kills all subviews', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: superview)\n\n      superview.destroySubviews()\n      ok one.isDead\n      ok two.isDead\n\n\n## ::propagateToSubviews(eventOrKey : string, value : Object)\n\nIf `value` is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n    test 'propagateToSubviews propagates events', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.on 'eventName', superSpy = createSpy()\n      one.on 'eventName', oneSpy = createSpy()\n      two.on 'eventName', twoSpy = createSpy()\n\n      superview.propagateToSubviews('eventName')\n\n      equal 1, superSpy.callCount\n      equal 1, oneSpy.callCount\n      equal 1, twoSpy.callCount\n\n    test 'propagateToSubviews propagates keys', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.propagateToSubviews('key', 'value')\n\n      equal superview.get('key'), 'value'\n      equal one.get('key'), 'value'\n      equal two.get('key'), 'value'\n\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n\n\n## ::filter(label : string, filter : function)\n\nDefines a filter on the `View` class for use within the `View` during rendering.\n","old_contents":"# Batman.View\n\nFor a general explanation of `Batman.View` and how it works, see [the guide](\/docs\/views.html).\n\n\n## ::constructor(options = {})\n\nA `View` is a `Batman.Object`, so any options you pass are mixed in. Use this\nto set `html`, `node`, `superview`, `parentNode` and\/or your custom data.\n\n    test 'constructor mixes in options', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'constructor automatically adds to the superview if supplied', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      equal 1, superview.subviews.length\n\n\n## ::lookupKeypath(keypath) : Object\n\nTraverses up the view tree searching for the specified keypath, and returns the\nresult. This is equivalent to performing a `Batman.get` for each view above\n`this` in the tree, until a defined result is returned. The path it takes is as\nfollows:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\nIf there is no match, `undefined` is returned. However, if used in an accessor\nor binding, the entire path to the root will be registered as a potential\nsource of data. Consequently, if the keypath is later set on any part of the\nchain, the data will be correctly bound.\n\n`lookupKeypath` is the function invoked to locate data when evaluating a\nbinding.\n\n    test 'lookupKeypath returns the value if defined on the view', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.lookupKeypath('animal')\n\n    test 'lookupKeypath returns the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'cat')\n      subview = new Batman.View(superview: superview)\n      equal 'cat', subview.lookupKeypath('animal')\n\n\n## ::setKeypath(keypath, value) : Object\n\nTraverses the View tree searching for the specified keypath, and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is the function invoked to set data when using an input binding.\n\n    test 'setKeypath sets the value if defined on the view', ->\n      view = new Batman.View(animal: 'dog')\n\n      view.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'setKeypath sets the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'dog')\n      subview = new Batman.View(superview: superview)\n\n      subview.setKeypath('animal', 'cat')\n      equal 'cat', superview.get('animal')\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n\n## ::%node : Node\n\nA reference to the DOM node that this view encapsulates. The entire tree\nbeneath this node is also the responsibility of this view and\/or its subviews.\n\nAccessing `node` will load and parse the template on demand if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\nYou can also access a view's `node` in its methods, for example, activating jQuery plugins:\n\n```\nclass App.SearchBarView extends Batman.View\n  viewDidAppear: ->\n    $node = $(@get('node'))\n    $node.typeahead() # <= whatever jQuery plugin you want!\n```\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview. You can specify a view's HTML when you define the class:\n\n```\nclass App.SearchBarView extends Batman.View\n  html: \"<input type='text' placeholder='Enter a search term' \/>\"\n```\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n    test 'setting a source loads the correct template', ->\n      Batman.View.store.set('\/animals', '<div>cat<\/div>')\n      view = new Batman.View(source: '\/animals')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n## ::.superview : Batman.View\n\nA reference to the current superview (the direct ancestor in the tree). This is\nused for traversing the tree when searching for data, as in\n`View::lookupKeypath`.\n\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of a `View`. To manipulate the view tree, you should\noperate directly on this set \u2014 batman.js will automatically keep the DOM in\nsync with the logical tree.\n\n\n## ::subviews.add(view)\n\nAdding to a view's subview set will automatically update the tree, and parse\nthe template and bindings. If the superview is already in the DOM, this will\ninsert the current view's node into the DOM.\n\n    test 'adding to a superview parses bindings', ->\n      superview = new Batman.View()\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      superview.subviews.add(view)\n      equal 'cat', view.get('node').firstChild.innerHTML\n\n\n## ::subviews.remove(view)\n\nRemoving from a view's subview set will automatically remove the subview from\nthe DOM.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View(html: '', parentNode: document.body)\n      superview.get('node')\n      view = new Batman.View(html: '', superview: superview)\n\n      ok Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n      superview.subviews.remove(view)\n      ok not Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent, without killing it.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.removeFromSuperview()\n      ok not superview.subviews.has(view)\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n    test 'die kills the view', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.die()\n      equal true, view.isDead\n      equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n    test 'destroySubviews kills all subviews', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: superview)\n\n      superview.destroySubviews()\n      ok one.isDead\n      ok two.isDead\n\n\n## ::propagateToSubviews(eventOrKey : string, value : Object)\n\nIf `value` is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n    test 'propagateToSubviews propagates events', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.on 'eventName', superSpy = createSpy()\n      one.on 'eventName', oneSpy = createSpy()\n      two.on 'eventName', twoSpy = createSpy()\n\n      superview.propagateToSubviews('eventName')\n\n      equal 1, superSpy.callCount\n      equal 1, oneSpy.callCount\n      equal 1, twoSpy.callCount\n\n    test 'propagateToSubviews propagates keys', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.propagateToSubviews('key', 'value')\n\n      equal superview.get('key'), 'value'\n      equal one.get('key'), 'value'\n      equal two.get('key'), 'value'\n\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n\n\n## ::filter(label : string, filter : function)\n\nDefines a filter on the `View` class for use within the `View` during rendering.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7f195bd09bf3a533ac30c5db35c3af0e6d40a146","subject":"Correctly handle function attributes and Date objects during client-side model instantiation","message":"Correctly handle function attributes and Date objects during client-side model instantiation\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-orm\/client\/index.litcoffee","new_file":"packages\/shrub-orm\/client\/index.litcoffee","new_contents":"# Object-relational mapping\n\n*This is mostly stubbed for the browser. I can't justify sending a 400k ORM\nlibrary to the client, even though it would be awesome.*\n\n    Promise = require 'bluebird'\n\n    pkgman = require 'pkgman'\n\n    collections = {}\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularService`.\n\n      registrar.registerHook 'shrubAngularService', -> [\n        '$http'\n        ($http) ->\n\n          service = {}\n\n          exports.initialize()\n\n## orm.collection\n\n* (String) `identity` - Collection identity. e.g. `'shrub-user'`\n\n*Get a collection by identity.*\n\n          service.collection = (identity) -> collections[identity]\n\n## orm.collections\n\n*Get all collections.*\n\n          service.collections = -> collections\n\n          service\n\n      ]\n\n    exports.initialize = ->\n\n#### Invoke hook `shrubOrmCollections`.\n\n      collections_ = {}\n      for collectionList in pkgman.invokeFlat 'shrubOrmCollections'\n        for identity, collection of collectionList\n\nCollection defaults.\n\n          collection.identity ?= identity\n          collections_[collection.identity] = collection\n\nInstantiate a model with defaults supplied.\n\n          collection.instantiate = (values = {}) ->\n            model = JSON.parse JSON.stringify values\n\n            for key, value of @attributes\n\nSet functions.\n\n              model[key] = value if 'function' is typeof value\n\nSet any model defaults.\n\n              if value.defaultsTo?\n\n                model[key] ?= if 'function' is typeof value.defaultsTo\n                  value.defaultsTo.call model\n                else\n                  JSON.parse JSON.stringify value.defaultsTo\n\nHandle dates.\n\n              if model[key]? and 'date' is value or 'date' is value.type\n                model[key] = new Date model[key]\n\n            model\n\n#### Invoke hook `shrubOrmCollectionsAlter`.\n\n      pkgman.invoke 'shrubOrmCollectionsAlter', collections_\n\n      collections = collections_\n","old_contents":"# Object-relational mapping\n\n*This is mostly stubbed for the browser. I can't justify sending a 400k ORM\nlibrary to the client, even though it would be awesome.*\n\n    Promise = require 'bluebird'\n\n    pkgman = require 'pkgman'\n\n    collections = {}\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularService`.\n\n      registrar.registerHook 'shrubAngularService', -> [\n        '$http'\n        ($http) ->\n\n          service = {}\n\n          exports.initialize()\n\n## orm.collection\n\n* (String) `identity` - Collection identity. e.g. `'shrub-user'`\n\n*Get a collection by identity.*\n\n          service.collection = (identity) -> collections[identity]\n\n## orm.collections\n\n*Get all collections.*\n\n          service.collections = -> collections\n\n          service\n\n      ]\n\n    exports.initialize = ->\n\n#### Invoke hook `shrubOrmCollections`.\n\n      collections_ = {}\n      for collectionList in pkgman.invokeFlat 'shrubOrmCollections'\n        for identity, collection of collectionList\n\nCollection defaults.\n\n          collection.identity ?= identity\n          collections_[collection.identity] = collection\n\nInstantiate a model with defaults supplied.\n\n          collection.instantiate = (values = {}) ->\n            model = JSON.parse JSON.stringify values\n\n            for key, value of @attributes\n              continue unless value.defaultsTo?\n\nSet any model defaults.\n\n              model[key] ?= if 'function' is typeof value.defaultsTo\n                value.defaultsTo.call model\n              else\n                JSON.parse JSON.stringify value.defaultsTo\n\n            model\n\n#### Invoke hook `shrubOrmCollectionsAlter`.\n\n      pkgman.invoke 'shrubOrmCollectionsAlter', collections_\n\n      collections = collections_\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5471a039cc9258376f5033881563e9d210e8c118","subject":"Allow restarting by sending a special message.","message":"Allow restarting by sending a special message.\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_contents":"nodePush Pushserver\n===================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nFirst we import the required packages and make them available in a global variable.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nNext we try to load the configuration file \"config.js\".\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nIn case not every configuration property is set we initialize it with a default property.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nWe continue with creating some helper functions.\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\t\n\tfs.open \"#{__dirname}\/..\/tmp\/nodePush.child.pid\", \"w\", 0o600, (err, fd) ->\n\t\tfs.writeSync fd, process.pid\n\t\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.wcf ?= {}\n\nbe.bastelstu.wcf.nodePush\n=========================\n\n\tclass be.bastelstu.wcf.nodePush\n\t\nAttributes\n----------\n\n`app` will become an instance of `express`.\n\n\t\tapp: null\n\n`server` willbecome an instance of `http`.\n\n\t\tserver: null\n\n`io` will become an instance of `socket.io`.\n\n\t\tio: null\n\n`stats` is an object with the different statistics recorded. Statistics will be shown on the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**  \nThe constructor is executed when the class is initialized. It prints some helpful information,\nsuch as the PID and the used sockets and continues with initializing everything.\n\n\t\tconstructor: ->\n\t\t\tlog \"nodePush running (pid:#{process.pid})\"\n\nFirst we display the used inbound and outbound sockets.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\nAfterwards we initialize the inbound and outbound connection.\n\n\t\t\t@initInbound()\n\t\t\t@initOutbound()\n\nIn order to do a proper cleanup on shutdown we bind the `shutdown` method to the needed events and signals.\n\n\t\t\tprocess.on 'exit', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'uncaughtException', (message) =>\n\t\t\t\t@shutdown message, 1\n\t\t\tprocess.on 'SIGINT', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGTERM', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGHUP', =>\n\t\t\t\t@shutdown null, 2\n\nAt the end we set a nice title for `ps`.\n\n\t\t\tprocess.title = 'nodePush'\n\n**initOutbound()**  \n`initOutbound` initializes the connection to the browser. That includes starting the HTTP server and preparing\nsocket.io.\n\n\t\tinitOutbound: ->\n\t\t\tlog 'Initializing outbound socket'\n\nFirst we start the express based HTTP server.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\nAfterwards we set socket.io configuration for the default environment. Files will be minified and logging reduced to a minimum.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nIn case `env` is set to development we show some more debug output.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nNext we listen on the socket.io `connection` event to record statistics.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++ if @app.get('env') is 'development'\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nWe continue with creating a callback for the `listen` call.\n\n\t\t\tlistenCallback = =>\n\nIn case we are running as root we try to shed root privilegies. If this is not possible we exit, as a service\nrunning as root is dangerous.\n\n\t\t\t\tif process.getuid? and (process.getuid() is 0 or process.getgid() is 0)\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nAfter the the HTTP server is listening and we are no longer running as root we start some intervals for the builtin tick events.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\nStart listening on the configured outbound socket.\n\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\nShow detailed information when environment is `development`.\n\n\t\t\t\tif @app.get('env') is 'development'\n\t\t\t\t\t@stats.status++\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\t\tMessages:\n\t\t\t\t\t\"\"\"\n\t\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\telse\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now\n\t\t\t\t\t\"\"\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\treturn unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test name\n\t\t\t\n\t\t\tif name is 'be.bastelstu.wcf.nodePush._restart'\n\t\t\t\tprocess.kill process.pid, 'SIGHUP'\n\t\t\t\n\t\t\tif @app.get('env') is 'development'\n\t\t\t\t@stats.messages[name] ?= 0\n\t\t\t\t@stats.messages[name]++\n\t\t\t\t\n\t\t\t@io.sockets.send name\n\n**initInbound()**  \n`initInbound` initializes the PHP side socket.\n\n\t\tinitInbound: ->\n\t\t\tlog 'Initializing inbound socket'\n\nWe start by creating a server.\n\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++ if @app.get('env') is 'development'\n\nIn case data is written to the server we pass it to the connected browsers and close the connection afterwards.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nIn case nothing happens within 5 seconds we close the connection in order to save resources.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\nAfter all callbacks are bound we start listening.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \n`shutdown` performs a clean shutdown of nodePush. It cleans up the unix socket files.\n\n\t\tshutdown: (message = null, code = 0) ->\n\t\t\tif message?\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\telse\n\t\t\t\tlog 'Shutting down'\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket if not config.inbound.useTCP and fs.existsSync config.inbound.socket\n\t\t\tfs.unlinkSync config.outbound.socket if not config.outbound.useTCP and fs.existsSync config.outbound.socket\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit code\n\nIn the end we finally initialize the class with starts all the services.\n\n\tnew be.bastelstu.wcf.nodePush()","old_contents":"nodePush Pushserver\n===================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nFirst we import the required packages and make them available in a global variable.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nNext we try to load the configuration file \"config.js\".\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nIn case not every configuration property is set we initialize it with a default property.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nWe continue with creating some helper functions.\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\t\n\tfs.open \"#{__dirname}\/..\/tmp\/nodePush.child.pid\", \"w\", 0o600, (err, fd) ->\n\t\tfs.writeSync fd, process.pid\n\t\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.wcf ?= {}\n\nbe.bastelstu.wcf.nodePush\n=========================\n\n\tclass be.bastelstu.wcf.nodePush\n\t\nAttributes\n----------\n\n`app` will become an instance of `express`.\n\n\t\tapp: null\n\n`server` willbecome an instance of `http`.\n\n\t\tserver: null\n\n`io` will become an instance of `socket.io`.\n\n\t\tio: null\n\n`stats` is an object with the different statistics recorded. Statistics will be shown on the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**  \nThe constructor is executed when the class is initialized. It prints some helpful information,\nsuch as the PID and the used sockets and continues with initializing everything.\n\n\t\tconstructor: ->\n\t\t\tlog \"nodePush running (pid:#{process.pid})\"\n\nFirst we display the used inbound and outbound sockets.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\nAfterwards we initialize the inbound and outbound connection.\n\n\t\t\t@initInbound()\n\t\t\t@initOutbound()\n\nIn order to do a proper cleanup on shutdown we bind the `shutdown` method to the needed events and signals.\n\n\t\t\tprocess.on 'exit', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'uncaughtException', (message) =>\n\t\t\t\t@shutdown message, 1\n\t\t\tprocess.on 'SIGINT', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGTERM', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGHUP', =>\n\t\t\t\t@shutdown null, 2\n\nAt the end we set a nice title for `ps`.\n\n\t\t\tprocess.title = 'nodePush'\n\n**initOutbound()**  \n`initOutbound` initializes the connection to the browser. That includes starting the HTTP server and preparing\nsocket.io.\n\n\t\tinitOutbound: ->\n\t\t\tlog 'Initializing outbound socket'\n\nFirst we start the express based HTTP server.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\nAfterwards we set socket.io configuration for the default environment. Files will be minified and logging reduced to a minimum.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nIn case `env` is set to development we show some more debug output.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nNext we listen on the socket.io `connection` event to record statistics.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++ if @app.get('env') is 'development'\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nWe continue with creating a callback for the `listen` call.\n\n\t\t\tlistenCallback = =>\n\nIn case we are running as root we try to shed root privilegies. If this is not possible we exit, as a service\nrunning as root is dangerous.\n\n\t\t\t\tif process.getuid? and (process.getuid() is 0 or process.getgid() is 0)\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nAfter the the HTTP server is listening and we are no longer running as root we start some intervals for the builtin tick events.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\nStart listening on the configured outbound socket.\n\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\nShow detailed information when environment is `development`.\n\n\t\t\t\tif @app.get('env') is 'development'\n\t\t\t\t\t@stats.status++\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\t\tMessages:\n\t\t\t\t\t\"\"\"\n\t\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\telse\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now\n\t\t\t\t\t\"\"\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\treturn unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test name\n\t\t\t\n\t\t\tif @app.get('env') is 'development'\n\t\t\t\t@stats.messages[name] ?= 0\n\t\t\t\t@stats.messages[name]++\n\t\t\t\t\n\t\t\t@io.sockets.send name\n\n**initInbound()**  \n`initInbound` initializes the PHP side socket.\n\n\t\tinitInbound: ->\n\t\t\tlog 'Initializing inbound socket'\n\nWe start by creating a server.\n\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++ if @app.get('env') is 'development'\n\nIn case data is written to the server we pass it to the connected browsers and close the connection afterwards.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nIn case nothing happens within 5 seconds we close the connection in order to save resources.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\nAfter all callbacks are bound we start listening.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \n`shutdown` performs a clean shutdown of nodePush. It cleans up the unix socket files.\n\n\t\tshutdown: (message = null, code = 0) ->\n\t\t\tif message?\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\telse\n\t\t\t\tlog 'Shutting down'\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket if not config.inbound.useTCP and fs.existsSync config.inbound.socket\n\t\t\tfs.unlinkSync config.outbound.socket if not config.outbound.useTCP and fs.existsSync config.outbound.socket\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit code\n\nIn the end we finally initialize the class with starts all the services.\n\n\tnew be.bastelstu.wcf.nodePush()","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"b840d6d1a08c4a3d1a54db040c0c9267590996c3","subject":"Added Item::scaleInPoint","message":"Added Item::scaleInPoint\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/renderer\/types\/basics\/item.litcoffee","new_file":"src\/renderer\/types\/basics\/item.litcoffee","new_contents":"# Item\n\n    'use strict'\n\n    assert = require 'src\/assert'\n    utils = require 'src\/utils'\n    signal = require 'src\/signal'\n    List = require 'src\/list'\n\n    {isArray} = Array\n    {emitSignal} = signal.Emitter\n\n    assert = assert.scope 'Renderer.Item'\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Item extends itemUtils.Object\n        @__name__ = 'Item'\n        @__path__ = 'Renderer.Item'\n\n        Document = require 'src\/document'\n        DocElement = Document.Element\n\n## *Item* Item.New([*Object* options])\n\n        @New = (opts) ->\n            item = new Item\n            itemUtils.Object.initialize item, opts\n            item\n\n## *Item* Item::constructor()\n\nThis is a base class for everything which is visible.\n\n        constructor: ->\n            assert.instanceOf @, Item\n\n            super()\n            @_parent = null\n            @_children = null\n            @_previousSibling = null\n            @_nextSibling = null\n            @_belowSibling = null\n            @_aboveSibling = null\n            @_width = 0\n            @_height = 0\n            @_x = 0\n            @_y = 0\n            @_z = 0\n            @_visible = true\n            @_clip = false\n            @_scale = 1\n            @_rotation = 0\n            @_opacity = 1\n            @_linkUri = ''\n            @_anchors = null\n            @_layout = null\n            @_keys = null\n            @_pointer = null\n            @_margin = null\n            @_classes = null\n            @_query = ''\n            @_node = null\n\n### Custom properties\n\n```nml\nItem {\n    id: main\n    property currentLife: 0.8\n    Text {\n        text: \"Life: \" + main.currentLife\n    }\n}\n```\n\n### Custom signals\n\n```nml\nItem {\n    signal onPlayerCollision\n    onPlayerCollision(){\n        \/\/ boom!\n    }\n}\n```\n\n## ReadOnly *String* Item::query\n\n        utils.defineProperty @::, 'query', null, ->\n            @_query\n        , (val) ->\n            if @_query is ''\n                @_query = val\n            return\n\n## ReadOnly *Document.Element* Item::node\n\n## *Signal* Item::onNodeChange(*Document.Element* oldValue)\n\n```javascript\nText {\n    text: this.node.props.value\n}\n```\n\n```javascript\nText {\n    onNodeChange: function(){\n        var inputs = this.node.queryAll('input[type=string]');\n    }\n}\n```\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'node'\n            defaultValue: null\n            developmentSetter: (val) ->\n                if val?\n                    assert.instanceOf val, DocElement\n\n## *Signal* Item::ready()\n\nCalled when the Item is ready, that is, all\nproperties have been set and it's ready to use.\n\n```nml\nRectangle {\n    width: 200\n    height: 50\n    color: 'green'\n    Rectangle {\n        width: parent.width \/ 2\n        height: parent.height \/ 2\n        color: 'yellow'\n        onReady: function(){\n            console.log(this.width, this.height);\n            \/\/ 100, 25\n        }\n    }\n}\n```\n\n        signal.Emitter.createSignal @, 'onReady'\n\n## *Signal* Item::onAnimationFrame(*Integer* miliseconds)\n\n        signal.Emitter.createSignal @, 'onAnimationFrame', do ->\n            now = Date.now()\n            items = []\n\n            frame = ->\n                oldNow = now\n                now = Date.now()\n                ms = now - oldNow\n\n                for item in items\n                    emitSignal item, 'onAnimationFrame', ms\n                requestAnimationFrame frame\n\n            requestAnimationFrame? frame\n\n            (item) ->\n                items.push item\n\n## ReadOnly *String* Item::id\n\n## *Object* Item::children\n\n        utils.defineProperty @::, 'children', null, ->\n            @_children ||= new ChildrenObject(@)\n        , (val) ->\n            assert.isArray val, \"Item.children needs to be an array, but #{val} given\"\n            @clear()\n            for item in val\n                val.parent = @\n            return\n\n## *Signal* Item::onChildrenChange(*Item* added, *Item* removed)\n\n        signal.Emitter.createSignal @, 'onChildrenChange'\n\n        class ChildrenObject extends itemUtils.MutableDeepObject\n            constructor: (ref) ->\n                @_layout = null\n                @_target = null\n                @_firstChild = null\n                @_lastChild = null\n                @_bottomChild = null\n                @_topChild = null\n                @_length = 0\n                super ref\n\n### ReadOnly *Item* Item::children.firstChild\n\n            utils.defineProperty @::, 'firstChild', null, ->\n                @_firstChild\n            , null\n\n### ReadOnly *Item* Item::children.lastChild\n\n            utils.defineProperty @::, 'lastChild', null, ->\n                @_lastChild\n            , null\n\n### ReadOnly *Item* Item::children.bottomChild\n\n            utils.defineProperty @::, 'bottomChild', null, ->\n                @_bottomChild\n            , null\n\n### ReadOnly *Item* Item::children.topChild\n\n            utils.defineProperty @::, 'topChild', null, ->\n                @_topChild\n            , null\n\n### ReadOnly *Integer* Item::children.length\n\n            utils.defineProperty @::, 'length', null, ->\n                @_length\n            , null\n\n### *Item* Item::children.layout\n\nItem used to position children items.\nCan be e.g. *Flow*, *Grid* etc.\n\n### *Signal* Item::children.onLayoutChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'layout'\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Item, \"\"\"\n                            Item.children.layout needs to be an Item, but #{val} given\n                        \"\"\"\n                setter: (_super) -> (val) ->\n                    if @_layout?.effectItem\n                        @_layout.parent = null\n                        @_layout.effectItem = @_layout\n\n                    _super.call @, val\n\n                    if '_effectItem' of @_ref\n                        @_ref.effectItem = if val then null else @_ref\n\n                    if val?\n                        ref = @_ref\n                        setFakeParent val, ref, 0\n                        if val.effectItem\n                            val.effectItem = ref\n\n                    return\n\n### *Item* Item::children.target\n\nA new child trying to be added into the item with the `children.target` defined\nwill be added into the `target` item.\n\n### *Signal* Item::children.onTargetChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'target'\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Item, \"\"\"\n                            Item.children.target needs to be an Item, but #{val} given\n                        \"\"\"\n\n### *Item* Item::children.get(*Integer* index)\n\nReturns an item with the given index.\n\n            get: (val) ->\n                assert.operator val, '>=', 0, \"\"\"\n                    Item.children.get index cannot be lower than zero, #{val} given\n                \"\"\"\n                assert.operator val, '<', @length, \"\"\"\n                    Item.children.get index must be lower than children.length, \\\n                    #{val} given\n                \"\"\"\n\n                if val < @length \/ 2\n                    sibling = @firstChild\n                    while val > 0\n                        sibling = sibling.nextSibling\n                        val--\n                else\n                    sibling = @lastChild\n                    while val > 0\n                        sibling = sibling.previousSibling\n                        val--\n\n                sibling\n\n### *Integer* Item::children.index(*Item* value)\n\nReturns an index of the given child in the children array.\n\n            index: (val) ->\n                if @has(val)\n                    val.index\n                else\n                    -1\n\n### *Boolean* Item::children.has(*Item* value)\n\nReturns `true` if the given item is an item child.\n\n            has: (val) ->\n                @_ref is val._parent\n\n### Item::children.clear()\n\nRemoves all children from the item.\n\n            clear: ->\n                while last = @last\n                    last.parent = null\n                return\n\n## *Item* Item::parent = `null`\n\n## *Signal* Item::onParentChange(*Item* oldParent)\n\n        setFakeParent = (child, parent, index=-1) ->\n            child.parent = null\n\n            if index >= 0 and parent.children._length < index\n                Impl.insertItemBefore.call child, parent.children[index]\n            else\n                Impl.setItemParent.call child, parent\n\n            child._parent = parent\n            emitSignal child, 'onParentChange', null\n            return\n\n        updateZSiblingsForAppendedItem = (item, z, newChildren) ->\n            child = newChildren._topChild\n            while child\n                if child._z <= z\n                    if item._aboveSibling = child._aboveSibling\n                        item._aboveSibling._belowSibling = item\n                    item._belowSibling = child\n                    child._aboveSibling = item\n                    return\n                unless nextChild = child._belowSibling\n                    item._aboveSibling = child\n                    child._belowSibling = item\n                    item._belowSibling = null\n                    return\n                child = nextChild\n            return\n\n        insertItemInImpl = (item) ->\n            if aboveSibling = item._aboveSibling\n                Impl.insertItemBefore.call item, aboveSibling\n            else\n                Impl.setItemParent.call item, item._parent\n            return\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'parent'\n            defaultValue: null\n            setter: (_super) -> (val = null) ->\n                old = @_parent\n                oldChildren = old?.children\n                valChildren = val?.children\n\n                if valChildren?._target\n                    # detect whether target is a child of this item\n                    containsItem = false\n                    tmpItem = valChildren._target\n                    while tmpItem\n                        if tmpItem is @\n                            containsItem = true\n                            break\n                        tmpItem = tmpItem._parent\n\n                    unless containsItem\n                        val = valChildren._target\n                        valChildren = val.children\n\n                if old is val\n                    return\n\n                assert.isNot @, val, \"Item.parent cannot be set with context item, #{val} given\"\n\n                if pointer = @_pointer\n                    pointer.hover = pointer.pressed = false\n\n                if val isnt null\n                    assert.instanceOf val, Item, \"\"\"\n                        Item.parent needs to be an Item or null, but #{val} given\n                    \"\"\"\n\n                # old siblings\n                oldPreviousSibling = @_previousSibling\n                oldNextSibling = @_nextSibling\n                if oldPreviousSibling isnt null\n                    oldPreviousSibling._nextSibling = oldNextSibling\n                if oldNextSibling isnt null\n                    oldNextSibling._previousSibling = oldPreviousSibling\n\n                # new siblings\n                if val isnt null\n                    if previousSibling = @_previousSibling = valChildren.lastChild\n                        previousSibling._nextSibling = @\n                else\n                    @_previousSibling = null\n                if oldNextSibling isnt null\n                    @_nextSibling = null\n\n                # children\n                if oldChildren\n                    oldChildren._length -= 1\n                    if oldChildren.firstChild is @\n                        oldChildren._firstChild = oldNextSibling\n                    if oldChildren.lastChild is @\n                        oldChildren._lastChild = oldPreviousSibling\n                if valChildren\n                    if ++valChildren._length is 1\n                        valChildren._firstChild = @\n                    valChildren._lastChild = @\n\n                # old z-index siblings\n                oldBelowSibling = @_belowSibling\n                oldAboveSibling = @_aboveSibling\n                if oldBelowSibling isnt null\n                    oldBelowSibling._aboveSibling = oldAboveSibling\n                if oldAboveSibling isnt null\n                    oldAboveSibling._belowSibling = oldBelowSibling\n\n                # new z-index siblings\n                @_belowSibling = @_aboveSibling = null\n                if valChildren\n                    updateZSiblingsForAppendedItem @, @_z, valChildren\n\n                # z-index children\n                if oldChildren\n                    unless oldAboveSibling\n                        oldChildren._topChild = oldBelowSibling\n                    unless oldBelowSibling\n                        oldChildren._bottomChild = oldAboveSibling\n                if valChildren\n                    unless @_aboveSibling\n                        valChildren._topChild = @\n                    unless @_belowSibling\n                        valChildren._bottomChild = @\n\n                # parent\n                @_parent = val\n                insertItemInImpl @\n\n                `\/\/<development>`\n                assert.is @nextSibling, null\n                if val\n                    assert.is val.children.lastChild, @\n                    assert.isDefined val.children.firstChild\n                    assert.isDefined val.children.lastChild\n                    assert.isDefined val.children.topChild\n                    assert.isDefined val.children.bottomChild\n                if old and old.children.length is 0\n                    assert.isNotDefined old.children.firstChild\n                    assert.isNotDefined old.children.lastChild\n                    assert.isNotDefined old.children.topChild\n                    assert.isNotDefined old.children.bottomChild\n                `\/\/<\/development>`\n\n                # signals\n                if old isnt null\n                    emitSignal old, 'onChildrenChange', null, @\n                if val isnt null\n                    emitSignal val, 'onChildrenChange', @, null\n\n                emitSignal @, 'onParentChange', old\n\n                if oldPreviousSibling isnt null\n                    emitSignal oldPreviousSibling, 'onNextSiblingChange', @\n                if oldNextSibling isnt null\n                    emitSignal oldNextSibling, 'onPreviousSiblingChange', @\n\n                if val isnt null or oldPreviousSibling isnt null\n                    if previousSibling\n                        emitSignal previousSibling, 'onNextSiblingChange', null\n                    emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling\n                if oldNextSibling isnt null\n                    emitSignal @, 'onNextSiblingChange', oldNextSibling\n\n                return\n\n## *Item* Item::previousSibling\n\n        utils.defineProperty @::, 'previousSibling', null, ->\n            @_previousSibling\n        , (val = null) ->\n            assert.isNot @, val, \"\"\"\n                Item.previousSibling cannot be set with context Item, #{val} given\n            \"\"\"\n\n            if val is @_previousSibling\n                return\n\n            if val\n                assert.instanceOf val, Item, \"\"\"\n                    Item.previousSibling must be an Item or null, but #{val} given\n                \"\"\"\n                nextSibling = val._nextSibling\n                if not nextSibling and val._parent isnt @_parent\n                    @parent = val._parent\n                else\n                    @nextSibling = nextSibling\n            else\n                assert.isDefined @_parent, \"\"\"\n                    Cannot null Item.previousSibling when Item has no parent\n                \"\"\"\n                @nextSibling = @_parent.children.firstChild\n\n            assert.is @_previousSibling, val\n            return\n\n## *Signal* Item::onPreviousSiblingChange(*Item* oldValue)\n\n        signal.Emitter.createSignal @, 'onPreviousSiblingChange'\n\n## *Item* Item::nextSibling\n\n        isNextSibling = (item, sibling) ->\n            while item\n                nextItem = item._nextSibling\n                if nextItem is sibling\n                    return true\n                item = nextItem\n            return false\n\n        isPreviousSibling = (item, sibling) ->\n            while item\n                prevItem = item._previousSibling\n                if prevItem is sibling\n                    return true\n                item = prevItem\n            return false\n\n        updateZSiblingsForInsertedItem = (item, nextSibling, z, newChildren) ->\n            if nextSibling._z is z\n                # simple case - the same z-index as in nextSibling\n                if item._belowSibling = nextSibling._belowSibling\n                    item._belowSibling._aboveSibling = item\n                item._aboveSibling = nextSibling\n                nextSibling._belowSibling = item\n            else\n                # hard case - different z-indexes\n                nextChild = newChildren._bottomChild\n                while child = nextChild\n                    nextChild = child._aboveSibling\n                    if child._z > z or (child._z is z and isNextSibling(item, child))\n                        item._aboveSibling = child\n                        if item._belowSibling = child._belowSibling\n                            item._belowSibling._aboveSibling = item\n                        child._belowSibling = item\n                        break\n                    unless nextChild\n                        item._aboveSibling = null\n                        item._belowSibling = child\n                        child._aboveSibling = item\n            return\n\n        utils.defineProperty @::, 'nextSibling', null, ->\n            @_nextSibling\n        , (val = null) ->\n            assert.isNot @, val, \"\"\"\n                Item.nextSibling cannot be set with context Item, #{val} given\n            \"\"\"\n            if val\n                assert.instanceOf val, Item, \"\"\"\n                    Item.nextSibling needs to be an Item or null, but #{val} given\n                \"\"\"\n                assert.isDefined val._parent, \"\"\"\n                    Item.nextSibling value needs to have a parent, given #{val} has no parent\n                \"\"\"\n            else\n                assert.isDefined @_parent, \"\"\"\n                    Cannot null Item.nextSibling when Item has no parent\n                \"\"\"\n\n            if val is @_nextSibling\n                return\n\n            oldParent = @_parent\n            oldChildren = oldParent?._children\n            oldPreviousSibling = @_previousSibling\n            oldNextSibling = @_nextSibling\n\n            if val\n                newParent = val._parent\n                newChildren = newParent._children\n            else\n                newParent = oldParent\n                newChildren = oldChildren\n\n            # new parent\n            @_parent = newParent\n\n            # current siblings\n            oldPreviousSibling?._nextSibling = oldNextSibling\n            oldNextSibling?._previousSibling = oldPreviousSibling\n\n            # new siblings\n            previousSibling = previousSiblingOldNextSibling = null\n            nextSibling = nextSiblingOldPreviousSibling = null\n            if val\n                if previousSibling = val._previousSibling\n                    previousSiblingOldNextSibling = previousSibling._nextSibling\n                    previousSibling._nextSibling = @\n\n                nextSibling = val\n                nextSiblingOldPreviousSibling = nextSibling._previousSibling\n                nextSibling._previousSibling = @\n            else\n                if previousSibling = newChildren.lastChild\n                    previousSibling._nextSibling = @\n\n            @_previousSibling = previousSibling\n            @_nextSibling = nextSibling\n\n            # children\n            if oldChildren\n                oldChildren._length -= 1\n                unless oldPreviousSibling\n                    oldChildren._firstChild = oldNextSibling\n                unless oldNextSibling\n                    oldChildren._lastChild = oldPreviousSibling\n            newChildren._length += 1\n            if newChildren.firstChild is val\n                newChildren._firstChild = @\n            unless val\n                newChildren._lastChild = @\n\n            # old z-index siblings\n            oldBelowSibling = @_belowSibling\n            oldAboveSibling = @_aboveSibling\n            if oldBelowSibling isnt null\n                oldBelowSibling._aboveSibling = oldAboveSibling\n            if oldAboveSibling isnt null\n                oldAboveSibling._belowSibling = oldBelowSibling\n\n            # new z-index siblings\n            @_belowSibling = @_aboveSibling = null\n            if nextSibling\n                updateZSiblingsForInsertedItem @, nextSibling, @_z, newChildren\n            else\n                updateZSiblingsForAppendedItem @, @_z, newChildren\n\n            # z-index children\n            if oldChildren\n                unless oldAboveSibling\n                    oldChildren._topChild = oldBelowSibling\n                unless oldBelowSibling\n                    oldChildren._bottomChild = oldAboveSibling\n            unless @_aboveSibling\n                newChildren._topChild = @\n            unless @_belowSibling\n                newChildren._bottomChild = @\n\n            # implementation\n            insertItemInImpl @\n\n            `\/\/<development>`\n            assert.is @_nextSibling, val\n            assert.is @_parent, newParent\n            if val\n                assert.is @_parent, val._parent\n            if @_previousSibling\n                assert.is @_previousSibling._nextSibling, @\n            if @_nextSibling\n                assert.is @_nextSibling._previousSibling, @\n            if oldPreviousSibling\n                assert.is oldPreviousSibling._nextSibling, oldNextSibling\n            if oldNextSibling\n                assert.is oldNextSibling._previousSibling, oldPreviousSibling\n            `\/\/<\/development>`\n\n            # children signal\n            if oldParent isnt newParent\n                if oldParent\n                    emitSignal oldParent, 'onChildrenChange', null, @\n                emitSignal newParent, 'onChildrenChange', @, null\n                emitSignal @, 'onParentChange', oldParent\n            else\n                emitSignal newParent, 'onChildrenChange', null, null\n\n            # current siblings signals\n            if oldPreviousSibling\n                emitSignal oldPreviousSibling, 'onNextSiblingChange', @\n            if oldNextSibling\n                emitSignal oldNextSibling, 'onPreviousSiblingChange', @\n\n            # new siblings signals\n            emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling\n            if previousSibling\n                emitSignal previousSibling, 'onNextSiblingChange', previousSiblingOldNextSibling\n            emitSignal @, 'onNextSiblingChange', oldNextSibling\n            if nextSibling\n                emitSignal nextSibling, 'onPreviousSiblingChange', nextSiblingOldPreviousSibling\n\n            return\n\n## *Signal* Item::onNextSiblingChange(*Item* oldValue)\n\n        signal.Emitter.createSignal @, 'onNextSiblingChange'\n\n## ReadOnly *Item* Item::belowSibling\n\n        utils.defineProperty @::, 'belowSibling', null, ->\n            @_belowSibling\n        , null\n\n## ReadOnly *Item* Item::aboveSibling\n\n        utils.defineProperty @::, 'aboveSibling', null, ->\n            @_aboveSibling\n        , null\n\n## *Integer* Item::index\n\n        utils.defineProperty @::, 'index', null, ->\n            index = 0\n            sibling = @\n            while sibling = sibling.previousSibling\n                index++\n            index\n        , (val) ->\n            assert.isInteger val, \"Item.index needs to be a integer, but #{val} given\"\n            assert.isDefined @_parent, \"\"\"\n                When setting Item.index, item needs to have a parent, #{@} has no parent\n            \"\"\"\n            assert.operator val, '>=', 0, \"Item.index needs to greater than zero, #{val} given\"\n            assert.operator val, '<=', @_parent._children.length, \"\"\"\n                Item.index needs to be lower than parent.children.length, #{val} given\n            \"\"\"\n\n            {children} = @parent\n            if val >= children.length\n                @nextSibling = null\n            else if (valItem = children.get(val)) isnt @\n                @nextSibling = valItem\n\n            return\n\n## *Boolean* Item::visible = `true`\n\nDetermines whether an item is visible or not.\n\n```nml\nItem {\n    width: 100\n    height: 100\n    pointer.onClick: function(){\n        rect.visible = !rect.visible;\n        text.text = rect.visible ? \"Click to hide\" : \"Click to show\";\n    }\n    Rectangle {\n        id: rect\n        anchors.fill: parent\n        color: 'blue'\n    }\n    Text {\n        id: text\n        text: \"Click to hide\"\n        anchors.centerIn: parent\n    }\n}\n```\n\n## *Signal* Item::onVisibleChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'visible'\n            defaultValue: true\n            implementation: Impl.setItemVisible\n            developmentSetter: (val) ->\n                assert.isBoolean val, \"Item.visible needs to be a boolean, but #{val} given\"\n\n## *Boolean* Item::clip = `false`\n\n## *Signal* Item::onClipChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'clip'\n            defaultValue: false\n            implementation: Impl.setItemClip\n            developmentSetter: (val) ->\n                assert.isBoolean val, \"Item.clip needs to be a boolean, but #{val} given\"\n\n## *Float* Item::width = `0`\n\n## *Signal* Item::onWidthChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'width'\n            defaultValue: 0\n            implementation: Impl.setItemWidth\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.width needs to be a float, but #{val} given\"\n\n## *Float* Item::height = `0`\n\n## *Signal* Item::onHeightChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'height'\n            defaultValue: 0\n            implementation: Impl.setItemHeight\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.height needs to be a float, but #{val} given\"\n\n## *Float* Item::x = `0`\n\n## *Signal* Item::onXChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'x'\n            defaultValue: 0\n            implementation: Impl.setItemX\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.x needs to be a float, but #{val} given\"\n\n## *Float* Item::y = `0`\n\n## *Signal* Item::onYChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'y'\n            defaultValue: 0\n            implementation: Impl.setItemY\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.y needs to be a float, but #{val} given\"\n\n## *Float* Item::z = `0`\n\n## *Signal* Item::onZChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'z'\n            defaultValue: 0\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.z needs to be a float, but #{val} given\"\n            setter: (_super) -> (val) ->\n                oldVal = @_z\n                if oldVal is val\n                    return\n\n                _super.call @, val\n\n                unless parent = @_parent\n                    return\n                children = parent._children\n                oldAboveSibling = @_aboveSibling\n                oldBelowSibling = @_belowSibling\n\n                # new siblings\n                if val > oldVal\n                    nextChild = @_aboveSibling\n                    while child = nextChild\n                        nextChild = child._aboveSibling\n                        if child._z > val or (child._z is val and isNextSibling(@, child))\n                            if oldAboveSibling is child\n                                break\n                            @_aboveSibling = child\n                            if @_belowSibling = child._belowSibling\n                                @_belowSibling._aboveSibling = @\n                            child._belowSibling = @\n                            break\n                        unless nextChild\n                            @_aboveSibling = null\n                            @_belowSibling = child\n                            child._aboveSibling = @\n\n                if val < oldVal\n                    prevChild = @_belowSibling\n                    while child = prevChild\n                        prevChild = child._belowSibling\n                        if child._z < val or (child._z is val and isPreviousSibling(@, child))\n                            if oldBelowSibling is child\n                                break\n                            @_belowSibling = child\n                            aboveSibling = child._aboveSibling\n                            if @_aboveSibling = child._aboveSibling\n                                @_aboveSibling._belowSibling = @\n                            child._aboveSibling = @\n                            break\n                        unless prevChild\n                            @_belowSibling = null\n                            @_aboveSibling = child\n                            child._belowSibling = @\n\n                # clean old siblings\n                if oldBelowSibling and oldBelowSibling isnt @_belowSibling\n                    oldBelowSibling._aboveSibling = oldAboveSibling\n                if oldAboveSibling and oldAboveSibling isnt @_aboveSibling\n                    oldAboveSibling._belowSibling = oldBelowSibling\n\n                # new children\n                if @_belowSibling\n                    if children._bottomChild is @\n                        children._bottomChild = oldAboveSibling\n                else\n                    children._bottomChild = @\n                if @_aboveSibling\n                    if children._topChild is @\n                        children._topChild = oldBelowSibling\n                else\n                    children._topChild = @\n\n                # implementation\n                if oldAboveSibling isnt @_aboveSibling\n                    insertItemInImpl @\n\n                `\/\/<development>`\n                assert.isNot @_belowSibling, @\n                assert.isNot @_belowSibling?._belowSibling, @\n                assert.isNot @_aboveSibling, @\n                assert.isNot @_aboveSibling?._aboveSibling, @\n                if @_belowSibling\n                    assert.is @_belowSibling._aboveSibling, @\n                if @_aboveSibling\n                    assert.is @_aboveSibling._belowSibling, @\n                `\/\/<\/development>`\n                return\n\n## *Float* Item::scale = `1`\n\n## *Signal* Item::onScaleChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'scale'\n            defaultValue: 1\n            implementation: Impl.setItemScale\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.scale needs to be a float, but #{val} given\"\n\n## *Float* Item::rotation = `0`\n\n```nml\nRectangle {\n    width: 100\n    height: 100\n    color: 'red'\n    rotation: Math.PI \/ 4\n}\n```\n\n## *Signal* Item::onRotationChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'rotation'\n            defaultValue: 0\n            implementation: Impl.setItemRotation\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.rotation needs to be a float, but #{val} given\"\n\n## *Float* Item::opacity = `1`\n\n## *Signal* Item::onOpacityChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'opacity'\n            defaultValue: 1\n            implementation: Impl.setItemOpacity\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.opacity needs to be a float, but #{val} given\"\n\n## *String* Item::linkUri = `''`\n\nPoints to the URI which will be used when user clicks on this item.\n\n## *Signal* Item::onLinkUriChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'linkUri'\n            defaultValue: ''\n            implementation: Impl.setItemLinkUri\n            developmentSetter: (val) ->\n                assert.isString val, \"Item.linkUri needs to be a string, but #{val} given\"\n\n## Item::scaleInPoint(*Float* scale, *Float* pointX, *Float* pointY)\n\n        scaleInPoint: (scale, pointX, pointY) ->\n            oldScale = @scale\n\n            # scale\n            @scale *= scale\n\n            # move to point horizontal\n            {width} = @\n            widthChange = (width * @scale - width * oldScale) \/ 2\n            xOriginToChange = -2 * (pointX \/ width) + 1\n            @x += xOriginToChange * widthChange\n\n            # move to point vertical\n            {height} = @\n            heightChange = (height * @scale - height * oldScale) \/ 2\n            yOriginToChange = -2 * (pointY \/ height) + 1\n            @y += yOriginToChange * heightChange\n\n            return\n\n        @createSpacing = require('.\/item\/spacing') Renderer, Impl, itemUtils, Item\n        @createAlignment = require('.\/item\/alignment') Renderer, Impl, itemUtils, Item\n        @createAnchors = require('.\/item\/anchors') Renderer, Impl, itemUtils, Item\n        @createLayout = require('.\/item\/layout') Renderer, Impl, itemUtils, Item\n        @createMargin = require('.\/item\/margin') Renderer, Impl, itemUtils, Item\n        @createPointer = require('.\/item\/pointer') Renderer, Impl, itemUtils, Item\n        @createKeys = require('.\/item\/keys') Renderer, Impl, itemUtils, Item\n\n## *Item.Anchors* Item::anchors\n\n## *Signal* Item::onAnchorsChange(*String* property, *Array* oldValue)\n\n        @createAnchors @\n\n## *Item.Layout* Item::layout\n\n## *Signal* Item::onLayoutChange(*String* property, *Any* oldValue)\n\n        @createLayout @\n\n## *Item.Pointer* Item::pointer\n\n        @Pointer = @createPointer @\n\n## *Item.Margin* Item::margin\n\n## *Signal* Item::onMarginChange(*String* property, *Any* oldValue)\n\n        @createMargin @\n\n## *Item.Keys* Item::keys\n\n        @Keys = @createKeys @\n\n        Item\n","old_contents":"# Item\n\n    'use strict'\n\n    assert = require 'src\/assert'\n    utils = require 'src\/utils'\n    signal = require 'src\/signal'\n    List = require 'src\/list'\n\n    {isArray} = Array\n    {emitSignal} = signal.Emitter\n\n    assert = assert.scope 'Renderer.Item'\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Item extends itemUtils.Object\n        @__name__ = 'Item'\n        @__path__ = 'Renderer.Item'\n\n        Document = require 'src\/document'\n        DocElement = Document.Element\n\n## *Item* Item.New([*Object* options])\n\n        @New = (opts) ->\n            item = new Item\n            itemUtils.Object.initialize item, opts\n            item\n\n## *Item* Item::constructor()\n\nThis is a base class for everything which is visible.\n\n        constructor: ->\n            assert.instanceOf @, Item\n\n            super()\n            @_parent = null\n            @_children = null\n            @_previousSibling = null\n            @_nextSibling = null\n            @_belowSibling = null\n            @_aboveSibling = null\n            @_width = 0\n            @_height = 0\n            @_x = 0\n            @_y = 0\n            @_z = 0\n            @_visible = true\n            @_clip = false\n            @_scale = 1\n            @_rotation = 0\n            @_opacity = 1\n            @_linkUri = ''\n            @_anchors = null\n            @_layout = null\n            @_keys = null\n            @_pointer = null\n            @_margin = null\n            @_classes = null\n            @_query = ''\n            @_node = null\n\n### Custom properties\n\n```nml\nItem {\n    id: main\n    property currentLife: 0.8\n    Text {\n        text: \"Life: \" + main.currentLife\n    }\n}\n```\n\n### Custom signals\n\n```nml\nItem {\n    signal onPlayerCollision\n    onPlayerCollision(){\n        \/\/ boom!\n    }\n}\n```\n\n## ReadOnly *String* Item::query\n\n        utils.defineProperty @::, 'query', null, ->\n            @_query\n        , (val) ->\n            if @_query is ''\n                @_query = val\n            return\n\n## ReadOnly *Document.Element* Item::node\n\n## *Signal* Item::onNodeChange(*Document.Element* oldValue)\n\n```javascript\nText {\n    text: this.node.props.value\n}\n```\n\n```javascript\nText {\n    onNodeChange: function(){\n        var inputs = this.node.queryAll('input[type=string]');\n    }\n}\n```\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'node'\n            defaultValue: null\n            developmentSetter: (val) ->\n                if val?\n                    assert.instanceOf val, DocElement\n\n## *Signal* Item::ready()\n\nCalled when the Item is ready, that is, all\nproperties have been set and it's ready to use.\n\n```nml\nRectangle {\n    width: 200\n    height: 50\n    color: 'green'\n    Rectangle {\n        width: parent.width \/ 2\n        height: parent.height \/ 2\n        color: 'yellow'\n        onReady: function(){\n            console.log(this.width, this.height);\n            \/\/ 100, 25\n        }\n    }\n}\n```\n\n        signal.Emitter.createSignal @, 'onReady'\n\n## *Signal* Item::onAnimationFrame(*Integer* miliseconds)\n\n        signal.Emitter.createSignal @, 'onAnimationFrame', do ->\n            now = Date.now()\n            items = []\n\n            frame = ->\n                oldNow = now\n                now = Date.now()\n                ms = now - oldNow\n\n                for item in items\n                    emitSignal item, 'onAnimationFrame', ms\n                requestAnimationFrame frame\n\n            requestAnimationFrame? frame\n\n            (item) ->\n                items.push item\n\n## ReadOnly *String* Item::id\n\n## *Object* Item::children\n\n        utils.defineProperty @::, 'children', null, ->\n            @_children ||= new ChildrenObject(@)\n        , (val) ->\n            assert.isArray val, \"Item.children needs to be an array, but #{val} given\"\n            @clear()\n            for item in val\n                val.parent = @\n            return\n\n## *Signal* Item::onChildrenChange(*Item* added, *Item* removed)\n\n        signal.Emitter.createSignal @, 'onChildrenChange'\n\n        class ChildrenObject extends itemUtils.MutableDeepObject\n            constructor: (ref) ->\n                @_layout = null\n                @_target = null\n                @_firstChild = null\n                @_lastChild = null\n                @_bottomChild = null\n                @_topChild = null\n                @_length = 0\n                super ref\n\n### ReadOnly *Item* Item::children.firstChild\n\n            utils.defineProperty @::, 'firstChild', null, ->\n                @_firstChild\n            , null\n\n### ReadOnly *Item* Item::children.lastChild\n\n            utils.defineProperty @::, 'lastChild', null, ->\n                @_lastChild\n            , null\n\n### ReadOnly *Item* Item::children.bottomChild\n\n            utils.defineProperty @::, 'bottomChild', null, ->\n                @_bottomChild\n            , null\n\n### ReadOnly *Item* Item::children.topChild\n\n            utils.defineProperty @::, 'topChild', null, ->\n                @_topChild\n            , null\n\n### ReadOnly *Integer* Item::children.length\n\n            utils.defineProperty @::, 'length', null, ->\n                @_length\n            , null\n\n### *Item* Item::children.layout\n\nItem used to position children items.\nCan be e.g. *Flow*, *Grid* etc.\n\n### *Signal* Item::children.onLayoutChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'layout'\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Item, \"\"\"\n                            Item.children.layout needs to be an Item, but #{val} given\n                        \"\"\"\n                setter: (_super) -> (val) ->\n                    if @_layout?.effectItem\n                        @_layout.parent = null\n                        @_layout.effectItem = @_layout\n\n                    _super.call @, val\n\n                    if '_effectItem' of @_ref\n                        @_ref.effectItem = if val then null else @_ref\n\n                    if val?\n                        ref = @_ref\n                        setFakeParent val, ref, 0\n                        if val.effectItem\n                            val.effectItem = ref\n\n                    return\n\n### *Item* Item::children.target\n\nA new child trying to be added into the item with the `children.target` defined\nwill be added into the `target` item.\n\n### *Signal* Item::children.onTargetChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'target'\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Item, \"\"\"\n                            Item.children.target needs to be an Item, but #{val} given\n                        \"\"\"\n\n### *Item* Item::children.get(*Integer* index)\n\nReturns an item with the given index.\n\n            get: (val) ->\n                assert.operator val, '>=', 0, \"\"\"\n                    Item.children.get index cannot be lower than zero, #{val} given\n                \"\"\"\n                assert.operator val, '<', @length, \"\"\"\n                    Item.children.get index must be lower than children.length, \\\n                    #{val} given\n                \"\"\"\n\n                if val < @length \/ 2\n                    sibling = @firstChild\n                    while val > 0\n                        sibling = sibling.nextSibling\n                        val--\n                else\n                    sibling = @lastChild\n                    while val > 0\n                        sibling = sibling.previousSibling\n                        val--\n\n                sibling\n\n### *Integer* Item::children.index(*Item* value)\n\nReturns an index of the given child in the children array.\n\n            index: (val) ->\n                if @has(val)\n                    val.index\n                else\n                    -1\n\n### *Boolean* Item::children.has(*Item* value)\n\nReturns `true` if the given item is an item child.\n\n            has: (val) ->\n                @_ref is val._parent\n\n### Item::children.clear()\n\nRemoves all children from the item.\n\n            clear: ->\n                while last = @last\n                    last.parent = null\n                return\n\n## *Item* Item::parent = `null`\n\n## *Signal* Item::onParentChange(*Item* oldParent)\n\n        setFakeParent = (child, parent, index=-1) ->\n            child.parent = null\n\n            if index >= 0 and parent.children._length < index\n                Impl.insertItemBefore.call child, parent.children[index]\n            else\n                Impl.setItemParent.call child, parent\n\n            child._parent = parent\n            emitSignal child, 'onParentChange', null\n            return\n\n        updateZSiblingsForAppendedItem = (item, z, newChildren) ->\n            child = newChildren._topChild\n            while child\n                if child._z <= z\n                    if item._aboveSibling = child._aboveSibling\n                        item._aboveSibling._belowSibling = item\n                    item._belowSibling = child\n                    child._aboveSibling = item\n                    return\n                unless nextChild = child._belowSibling\n                    item._aboveSibling = child\n                    child._belowSibling = item\n                    item._belowSibling = null\n                    return\n                child = nextChild\n            return\n\n        insertItemInImpl = (item) ->\n            if aboveSibling = item._aboveSibling\n                Impl.insertItemBefore.call item, aboveSibling\n            else\n                Impl.setItemParent.call item, item._parent\n            return\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'parent'\n            defaultValue: null\n            setter: (_super) -> (val = null) ->\n                old = @_parent\n                oldChildren = old?.children\n                valChildren = val?.children\n\n                if valChildren?._target\n                    # detect whether target is a child of this item\n                    containsItem = false\n                    tmpItem = valChildren._target\n                    while tmpItem\n                        if tmpItem is @\n                            containsItem = true\n                            break\n                        tmpItem = tmpItem._parent\n\n                    unless containsItem\n                        val = valChildren._target\n                        valChildren = val.children\n\n                if old is val\n                    return\n\n                assert.isNot @, val, \"Item.parent cannot be set with context item, #{val} given\"\n\n                if pointer = @_pointer\n                    pointer.hover = pointer.pressed = false\n\n                if val isnt null\n                    assert.instanceOf val, Item, \"\"\"\n                        Item.parent needs to be an Item or null, but #{val} given\n                    \"\"\"\n\n                # old siblings\n                oldPreviousSibling = @_previousSibling\n                oldNextSibling = @_nextSibling\n                if oldPreviousSibling isnt null\n                    oldPreviousSibling._nextSibling = oldNextSibling\n                if oldNextSibling isnt null\n                    oldNextSibling._previousSibling = oldPreviousSibling\n\n                # new siblings\n                if val isnt null\n                    if previousSibling = @_previousSibling = valChildren.lastChild\n                        previousSibling._nextSibling = @\n                else\n                    @_previousSibling = null\n                if oldNextSibling isnt null\n                    @_nextSibling = null\n\n                # children\n                if oldChildren\n                    oldChildren._length -= 1\n                    if oldChildren.firstChild is @\n                        oldChildren._firstChild = oldNextSibling\n                    if oldChildren.lastChild is @\n                        oldChildren._lastChild = oldPreviousSibling\n                if valChildren\n                    if ++valChildren._length is 1\n                        valChildren._firstChild = @\n                    valChildren._lastChild = @\n\n                # old z-index siblings\n                oldBelowSibling = @_belowSibling\n                oldAboveSibling = @_aboveSibling\n                if oldBelowSibling isnt null\n                    oldBelowSibling._aboveSibling = oldAboveSibling\n                if oldAboveSibling isnt null\n                    oldAboveSibling._belowSibling = oldBelowSibling\n\n                # new z-index siblings\n                @_belowSibling = @_aboveSibling = null\n                if valChildren\n                    updateZSiblingsForAppendedItem @, @_z, valChildren\n\n                # z-index children\n                if oldChildren\n                    unless oldAboveSibling\n                        oldChildren._topChild = oldBelowSibling\n                    unless oldBelowSibling\n                        oldChildren._bottomChild = oldAboveSibling\n                if valChildren\n                    unless @_aboveSibling\n                        valChildren._topChild = @\n                    unless @_belowSibling\n                        valChildren._bottomChild = @\n\n                # parent\n                @_parent = val\n                insertItemInImpl @\n\n                `\/\/<development>`\n                assert.is @nextSibling, null\n                if val\n                    assert.is val.children.lastChild, @\n                    assert.isDefined val.children.firstChild\n                    assert.isDefined val.children.lastChild\n                    assert.isDefined val.children.topChild\n                    assert.isDefined val.children.bottomChild\n                if old and old.children.length is 0\n                    assert.isNotDefined old.children.firstChild\n                    assert.isNotDefined old.children.lastChild\n                    assert.isNotDefined old.children.topChild\n                    assert.isNotDefined old.children.bottomChild\n                `\/\/<\/development>`\n\n                # signals\n                if old isnt null\n                    emitSignal old, 'onChildrenChange', null, @\n                if val isnt null\n                    emitSignal val, 'onChildrenChange', @, null\n\n                emitSignal @, 'onParentChange', old\n\n                if oldPreviousSibling isnt null\n                    emitSignal oldPreviousSibling, 'onNextSiblingChange', @\n                if oldNextSibling isnt null\n                    emitSignal oldNextSibling, 'onPreviousSiblingChange', @\n\n                if val isnt null or oldPreviousSibling isnt null\n                    if previousSibling\n                        emitSignal previousSibling, 'onNextSiblingChange', null\n                    emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling\n                if oldNextSibling isnt null\n                    emitSignal @, 'onNextSiblingChange', oldNextSibling\n\n                return\n\n## *Item* Item::previousSibling\n\n        utils.defineProperty @::, 'previousSibling', null, ->\n            @_previousSibling\n        , (val = null) ->\n            assert.isNot @, val, \"\"\"\n                Item.previousSibling cannot be set with context Item, #{val} given\n            \"\"\"\n\n            if val is @_previousSibling\n                return\n\n            if val\n                assert.instanceOf val, Item, \"\"\"\n                    Item.previousSibling must be an Item or null, but #{val} given\n                \"\"\"\n                nextSibling = val._nextSibling\n                if not nextSibling and val._parent isnt @_parent\n                    @parent = val._parent\n                else\n                    @nextSibling = nextSibling\n            else\n                assert.isDefined @_parent, \"\"\"\n                    Cannot null Item.previousSibling when Item has no parent\n                \"\"\"\n                @nextSibling = @_parent.children.firstChild\n\n            assert.is @_previousSibling, val\n            return\n\n## *Signal* Item::onPreviousSiblingChange(*Item* oldValue)\n\n        signal.Emitter.createSignal @, 'onPreviousSiblingChange'\n\n## *Item* Item::nextSibling\n\n        isNextSibling = (item, sibling) ->\n            while item\n                nextItem = item._nextSibling\n                if nextItem is sibling\n                    return true\n                item = nextItem\n            return false\n\n        isPreviousSibling = (item, sibling) ->\n            while item\n                prevItem = item._previousSibling\n                if prevItem is sibling\n                    return true\n                item = prevItem\n            return false\n\n        updateZSiblingsForInsertedItem = (item, nextSibling, z, newChildren) ->\n            if nextSibling._z is z\n                # simple case - the same z-index as in nextSibling\n                if item._belowSibling = nextSibling._belowSibling\n                    item._belowSibling._aboveSibling = item\n                item._aboveSibling = nextSibling\n                nextSibling._belowSibling = item\n            else\n                # hard case - different z-indexes\n                nextChild = newChildren._bottomChild\n                while child = nextChild\n                    nextChild = child._aboveSibling\n                    if child._z > z or (child._z is z and isNextSibling(item, child))\n                        item._aboveSibling = child\n                        if item._belowSibling = child._belowSibling\n                            item._belowSibling._aboveSibling = item\n                        child._belowSibling = item\n                        break\n                    unless nextChild\n                        item._aboveSibling = null\n                        item._belowSibling = child\n                        child._aboveSibling = item\n            return\n\n        utils.defineProperty @::, 'nextSibling', null, ->\n            @_nextSibling\n        , (val = null) ->\n            assert.isNot @, val, \"\"\"\n                Item.nextSibling cannot be set with context Item, #{val} given\n            \"\"\"\n            if val\n                assert.instanceOf val, Item, \"\"\"\n                    Item.nextSibling needs to be an Item or null, but #{val} given\n                \"\"\"\n                assert.isDefined val._parent, \"\"\"\n                    Item.nextSibling value needs to have a parent, given #{val} has no parent\n                \"\"\"\n            else\n                assert.isDefined @_parent, \"\"\"\n                    Cannot null Item.nextSibling when Item has no parent\n                \"\"\"\n\n            if val is @_nextSibling\n                return\n\n            oldParent = @_parent\n            oldChildren = oldParent?._children\n            oldPreviousSibling = @_previousSibling\n            oldNextSibling = @_nextSibling\n\n            if val\n                newParent = val._parent\n                newChildren = newParent._children\n            else\n                newParent = oldParent\n                newChildren = oldChildren\n\n            # new parent\n            @_parent = newParent\n\n            # current siblings\n            oldPreviousSibling?._nextSibling = oldNextSibling\n            oldNextSibling?._previousSibling = oldPreviousSibling\n\n            # new siblings\n            previousSibling = previousSiblingOldNextSibling = null\n            nextSibling = nextSiblingOldPreviousSibling = null\n            if val\n                if previousSibling = val._previousSibling\n                    previousSiblingOldNextSibling = previousSibling._nextSibling\n                    previousSibling._nextSibling = @\n\n                nextSibling = val\n                nextSiblingOldPreviousSibling = nextSibling._previousSibling\n                nextSibling._previousSibling = @\n            else\n                if previousSibling = newChildren.lastChild\n                    previousSibling._nextSibling = @\n\n            @_previousSibling = previousSibling\n            @_nextSibling = nextSibling\n\n            # children\n            if oldChildren\n                oldChildren._length -= 1\n                unless oldPreviousSibling\n                    oldChildren._firstChild = oldNextSibling\n                unless oldNextSibling\n                    oldChildren._lastChild = oldPreviousSibling\n            newChildren._length += 1\n            if newChildren.firstChild is val\n                newChildren._firstChild = @\n            unless val\n                newChildren._lastChild = @\n\n            # old z-index siblings\n            oldBelowSibling = @_belowSibling\n            oldAboveSibling = @_aboveSibling\n            if oldBelowSibling isnt null\n                oldBelowSibling._aboveSibling = oldAboveSibling\n            if oldAboveSibling isnt null\n                oldAboveSibling._belowSibling = oldBelowSibling\n\n            # new z-index siblings\n            @_belowSibling = @_aboveSibling = null\n            if nextSibling\n                updateZSiblingsForInsertedItem @, nextSibling, @_z, newChildren\n            else\n                updateZSiblingsForAppendedItem @, @_z, newChildren\n\n            # z-index children\n            if oldChildren\n                unless oldAboveSibling\n                    oldChildren._topChild = oldBelowSibling\n                unless oldBelowSibling\n                    oldChildren._bottomChild = oldAboveSibling\n            unless @_aboveSibling\n                newChildren._topChild = @\n            unless @_belowSibling\n                newChildren._bottomChild = @\n\n            # implementation\n            insertItemInImpl @\n\n            `\/\/<development>`\n            assert.is @_nextSibling, val\n            assert.is @_parent, newParent\n            if val\n                assert.is @_parent, val._parent\n            if @_previousSibling\n                assert.is @_previousSibling._nextSibling, @\n            if @_nextSibling\n                assert.is @_nextSibling._previousSibling, @\n            if oldPreviousSibling\n                assert.is oldPreviousSibling._nextSibling, oldNextSibling\n            if oldNextSibling\n                assert.is oldNextSibling._previousSibling, oldPreviousSibling\n            `\/\/<\/development>`\n\n            # children signal\n            if oldParent isnt newParent\n                if oldParent\n                    emitSignal oldParent, 'onChildrenChange', null, @\n                emitSignal newParent, 'onChildrenChange', @, null\n                emitSignal @, 'onParentChange', oldParent\n            else\n                emitSignal newParent, 'onChildrenChange', null, null\n\n            # current siblings signals\n            if oldPreviousSibling\n                emitSignal oldPreviousSibling, 'onNextSiblingChange', @\n            if oldNextSibling\n                emitSignal oldNextSibling, 'onPreviousSiblingChange', @\n\n            # new siblings signals\n            emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling\n            if previousSibling\n                emitSignal previousSibling, 'onNextSiblingChange', previousSiblingOldNextSibling\n            emitSignal @, 'onNextSiblingChange', oldNextSibling\n            if nextSibling\n                emitSignal nextSibling, 'onPreviousSiblingChange', nextSiblingOldPreviousSibling\n\n            return\n\n## *Signal* Item::onNextSiblingChange(*Item* oldValue)\n\n        signal.Emitter.createSignal @, 'onNextSiblingChange'\n\n## ReadOnly *Item* Item::belowSibling\n\n        utils.defineProperty @::, 'belowSibling', null, ->\n            @_belowSibling\n        , null\n\n## ReadOnly *Item* Item::aboveSibling\n\n        utils.defineProperty @::, 'aboveSibling', null, ->\n            @_aboveSibling\n        , null\n\n## *Integer* Item::index\n\n        utils.defineProperty @::, 'index', null, ->\n            index = 0\n            sibling = @\n            while sibling = sibling.previousSibling\n                index++\n            index\n        , (val) ->\n            assert.isInteger val, \"Item.index needs to be a integer, but #{val} given\"\n            assert.isDefined @_parent, \"\"\"\n                When setting Item.index, item needs to have a parent, #{@} has no parent\n            \"\"\"\n            assert.operator val, '>=', 0, \"Item.index needs to greater than zero, #{val} given\"\n            assert.operator val, '<=', @_parent._children.length, \"\"\"\n                Item.index needs to be lower than parent.children.length, #{val} given\n            \"\"\"\n\n            {children} = @parent\n            if val >= children.length\n                @nextSibling = null\n            else if (valItem = children.get(val)) isnt @\n                @nextSibling = valItem\n\n            return\n\n## *Boolean* Item::visible = `true`\n\nDetermines whether an item is visible or not.\n\n```nml\nItem {\n    width: 100\n    height: 100\n    pointer.onClick: function(){\n        rect.visible = !rect.visible;\n        text.text = rect.visible ? \"Click to hide\" : \"Click to show\";\n    }\n    Rectangle {\n        id: rect\n        anchors.fill: parent\n        color: 'blue'\n    }\n    Text {\n        id: text\n        text: \"Click to hide\"\n        anchors.centerIn: parent\n    }\n}\n```\n\n## *Signal* Item::onVisibleChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'visible'\n            defaultValue: true\n            implementation: Impl.setItemVisible\n            developmentSetter: (val) ->\n                assert.isBoolean val, \"Item.visible needs to be a boolean, but #{val} given\"\n\n## *Boolean* Item::clip = `false`\n\n## *Signal* Item::onClipChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'clip'\n            defaultValue: false\n            implementation: Impl.setItemClip\n            developmentSetter: (val) ->\n                assert.isBoolean val, \"Item.clip needs to be a boolean, but #{val} given\"\n\n## *Float* Item::width = `0`\n\n## *Signal* Item::onWidthChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'width'\n            defaultValue: 0\n            implementation: Impl.setItemWidth\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.width needs to be a float, but #{val} given\"\n\n## *Float* Item::height = `0`\n\n## *Signal* Item::onHeightChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'height'\n            defaultValue: 0\n            implementation: Impl.setItemHeight\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.height needs to be a float, but #{val} given\"\n\n## *Float* Item::x = `0`\n\n## *Signal* Item::onXChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'x'\n            defaultValue: 0\n            implementation: Impl.setItemX\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.x needs to be a float, but #{val} given\"\n\n## *Float* Item::y = `0`\n\n## *Signal* Item::onYChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'y'\n            defaultValue: 0\n            implementation: Impl.setItemY\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.y needs to be a float, but #{val} given\"\n\n## *Float* Item::z = `0`\n\n## *Signal* Item::onZChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'z'\n            defaultValue: 0\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.z needs to be a float, but #{val} given\"\n            setter: (_super) -> (val) ->\n                oldVal = @_z\n                if oldVal is val\n                    return\n\n                _super.call @, val\n\n                unless parent = @_parent\n                    return\n                children = parent._children\n                oldAboveSibling = @_aboveSibling\n                oldBelowSibling = @_belowSibling\n\n                # new siblings\n                if val > oldVal\n                    nextChild = @_aboveSibling\n                    while child = nextChild\n                        nextChild = child._aboveSibling\n                        if child._z > val or (child._z is val and isNextSibling(@, child))\n                            if oldAboveSibling is child\n                                break\n                            @_aboveSibling = child\n                            if @_belowSibling = child._belowSibling\n                                @_belowSibling._aboveSibling = @\n                            child._belowSibling = @\n                            break\n                        unless nextChild\n                            @_aboveSibling = null\n                            @_belowSibling = child\n                            child._aboveSibling = @\n\n                if val < oldVal\n                    prevChild = @_belowSibling\n                    while child = prevChild\n                        prevChild = child._belowSibling\n                        if child._z < val or (child._z is val and isPreviousSibling(@, child))\n                            if oldBelowSibling is child\n                                break\n                            @_belowSibling = child\n                            aboveSibling = child._aboveSibling\n                            if @_aboveSibling = child._aboveSibling\n                                @_aboveSibling._belowSibling = @\n                            child._aboveSibling = @\n                            break\n                        unless prevChild\n                            @_belowSibling = null\n                            @_aboveSibling = child\n                            child._belowSibling = @\n\n                # clean old siblings\n                if oldBelowSibling and oldBelowSibling isnt @_belowSibling\n                    oldBelowSibling._aboveSibling = oldAboveSibling\n                if oldAboveSibling and oldAboveSibling isnt @_aboveSibling\n                    oldAboveSibling._belowSibling = oldBelowSibling\n\n                # new children\n                if @_belowSibling\n                    if children._bottomChild is @\n                        children._bottomChild = oldAboveSibling\n                else\n                    children._bottomChild = @\n                if @_aboveSibling\n                    if children._topChild is @\n                        children._topChild = oldBelowSibling\n                else\n                    children._topChild = @\n\n                # implementation\n                if oldAboveSibling isnt @_aboveSibling\n                    insertItemInImpl @\n\n                `\/\/<development>`\n                assert.isNot @_belowSibling, @\n                assert.isNot @_belowSibling?._belowSibling, @\n                assert.isNot @_aboveSibling, @\n                assert.isNot @_aboveSibling?._aboveSibling, @\n                if @_belowSibling\n                    assert.is @_belowSibling._aboveSibling, @\n                if @_aboveSibling\n                    assert.is @_aboveSibling._belowSibling, @\n                `\/\/<\/development>`\n                return\n\n## *Float* Item::scale = `1`\n\n## *Signal* Item::onScaleChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'scale'\n            defaultValue: 1\n            implementation: Impl.setItemScale\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.scale needs to be a float, but #{val} given\"\n\n## *Float* Item::rotation = `0`\n\n```nml\nRectangle {\n    width: 100\n    height: 100\n    color: 'red'\n    rotation: Math.PI \/ 4\n}\n```\n\n## *Signal* Item::onRotationChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'rotation'\n            defaultValue: 0\n            implementation: Impl.setItemRotation\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.rotation needs to be a float, but #{val} given\"\n\n## *Float* Item::opacity = `1`\n\n## *Signal* Item::onOpacityChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'opacity'\n            defaultValue: 1\n            implementation: Impl.setItemOpacity\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.opacity needs to be a float, but #{val} given\"\n\n## *String* Item::linkUri = `''`\n\nPoints to the URI which will be used when user clicks on this item.\n\n## *Signal* Item::onLinkUriChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'linkUri'\n            defaultValue: ''\n            implementation: Impl.setItemLinkUri\n            developmentSetter: (val) ->\n                assert.isString val, \"Item.linkUri needs to be a string, but #{val} given\"\n\n        @createSpacing = require('.\/item\/spacing') Renderer, Impl, itemUtils, Item\n        @createAlignment = require('.\/item\/alignment') Renderer, Impl, itemUtils, Item\n        @createAnchors = require('.\/item\/anchors') Renderer, Impl, itemUtils, Item\n        @createLayout = require('.\/item\/layout') Renderer, Impl, itemUtils, Item\n        @createMargin = require('.\/item\/margin') Renderer, Impl, itemUtils, Item\n        @createPointer = require('.\/item\/pointer') Renderer, Impl, itemUtils, Item\n        @createKeys = require('.\/item\/keys') Renderer, Impl, itemUtils, Item\n\n## *Item.Anchors* Item::anchors\n\n## *Signal* Item::onAnchorsChange(*String* property, *Array* oldValue)\n\n        @createAnchors @\n\n## *Item.Layout* Item::layout\n\n## *Signal* Item::onLayoutChange(*String* property, *Any* oldValue)\n\n        @createLayout @\n\n## *Item.Pointer* Item::pointer\n\n        @Pointer = @createPointer @\n\n## *Item.Margin* Item::margin\n\n## *Signal* Item::onMarginChange(*String* property, *Any* oldValue)\n\n        @createMargin @\n\n## *Item.Keys* Item::keys\n\n        @Keys = @createKeys @\n\n        Item\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"6b6e9d5192def9dd26fb3f0ab883bad3609f9eb1","subject":"Add rpc.on, which proxies to socket.on","message":"Add rpc.on, which proxies to socket.on\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-rpc\/client\/index.litcoffee","new_file":"packages\/shrub-rpc\/client\/index.litcoffee","new_contents":"# RPC\n\nDefine an Angular service to issue\n[remote procedure calls](http:\/\/en.wikipedia.org\/wiki\/Remote_procedure_call#Message_passing).\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularService`.\n\n      registrar.registerHook 'shrubAngularService', -> [\n        '$injector', '$q', 'shrub-pkgman', 'shrub-socket'\n        ({invoke}, {defer}, pkgman, socket) ->\n\n          errors = require 'errors'\n\n          service = {}\n\n## rpc.call\n\n* (String) `path` - The RPC route path, e.g. `shrub-user\/login`.\n* (Object) `data` - The data to send to the server.\n\n*Call the server with some data.*\n\nReturns a promise, either resolved with the result of the response\nfrom the server, or rejected with the error from the server.\n\n          service.call = (path, data) ->\n\n            deferred = defer()\n\n            socket.emit(\n              'shrub-rpc'\n              path: path, data: data\n              ({error, result}) ->\n                return deferred.reject errors.unserialize error if error?\n                deferred.resolve result\n            )\n\n#### Invoke hook `shrubRpcCall`.\n\n            invoke(\n              injectable, null\n\n              route: path\n              data: data\n              result: deferred.promise\n\n            ) for injectable in pkgman.invokeFlat 'shrubRpcCall'\n\n            deferred.promise\n\n## rpc.on\n\n* (String) `eventName` - The name of the event to listen for.\n* (optional Function) `fn` - Callback called with the event data.\n\n*Listen for an event.*\n\nProxies directly to `socket.on`.\n\n          service.on = (eventName, fn) -> socket.on eventName, fn\n\n## rpc.formSubmitHandler\n\n* (String) `path` - The RPC route path, e.g. `shrub-user\/login`.\n* (Function) `fn` - Nodeback called with the RPC response.\n\n*Helper function to call an RPC route with the result of a form submission.*\n\n          service.formSubmitHandler = (path, fn) ->\n\n            unless fn?\n              fn = path\n              path = null\n\n            (values, form) ->\n\n              service.call(path ? form.key, values).then(\n                (result) -> fn null, result\n              ).catch (error) -> fn error\n\n          service\n\n      ]\n","old_contents":"# RPC\n\nDefine an Angular service to issue\n[remote procedure calls](http:\/\/en.wikipedia.org\/wiki\/Remote_procedure_call#Message_passing).\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularService`.\n\n      registrar.registerHook 'shrubAngularService', -> [\n        '$injector', '$q', 'shrub-pkgman', 'shrub-socket'\n        ({invoke}, {defer}, pkgman, socket) ->\n\n          errors = require 'errors'\n\n          service = {}\n\n## rpc.call\n\n* (String) `path` - The RPC route path, e.g. `shrub-user\/login`.\n* (Object) `data` - The data to send to the server.\n\n*Call the server with some data.*\n\nReturns a promise, either resolved with the result of the response\nfrom the server, or rejected with the error from the server.\n\n          service.call = (path, data) ->\n\n            deferred = defer()\n\n            socket.emit(\n              'shrub-rpc'\n              path: path, data: data\n              ({error, result}) ->\n                return deferred.reject errors.unserialize error if error?\n                deferred.resolve result\n            )\n\n#### Invoke hook `shrubRpcCall`.\n\n            invoke(\n              injectable, null\n\n              route: path\n              data: data\n              result: deferred.promise\n\n            ) for injectable in pkgman.invokeFlat 'shrubRpcCall'\n\n            deferred.promise\n\n## rpc.formSubmitHandler\n\n* (String) `path` - The RPC route path, e.g. `shrub-user\/login`.\n* (Function) `fn` - Nodeback called with the RPC response.\n\n*Helper function to call an RPC route with the result of a form submission.*\n\n          service.formSubmitHandler = (path, fn) ->\n\n            unless fn?\n              fn = path\n              path = null\n\n            (values, form) ->\n\n              service.call(path ? form.key, values).then(\n                (result) -> fn null, result\n              ).catch (error) -> fn error\n\n          service\n\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d1150361bcbfead4675a286389be417fb618e82c","subject":"ascii art","message":"ascii art\n","repos":"glamp\/leech,glamp\/leech","old_file":"src\/leech.litcoffee","new_file":"src\/leech.litcoffee","new_contents":"    fs = require 'fs'\n    path = require 'path'\n    handlebars = require 'handlebars'\n    aws = require 'aws-sdk'\n    shortid = require 'shortid'\n    Hashids = require 'hashids'\n    hashids = new Hashids(process.env[\"AWS_ACCESS_KEY\"])\n\n\nGrab our environment variables...\n\n    DOMAIN = process.env[\"DOMAIN\"] || \"thelee.ch\"\n    BUCKET = process.env[\"BUCKET\"] || DOMAIN\n    GA_ID = process.env[\"GA_ID\"]\n    PARTITION = process.env[\"PARTITION\"] || false\n\nSetup the connection to s3\n\n    aws.config.update {\n        accessKeyId: process.env[\"AWS_ACCESS_KEY\"],\n        secretAccessKey: process.env[\"AWS_SECRET_KEY\"]\n    }\n    aws.config.region = 'us-east-1'\n    s3 = new aws.S3()\n\nMake sure the S3 bucket is setup as a website. We'll just do this each time we \nstart the app. This means that it will frequently fail, but it's the simplest\nway to make sure that we've setup the bucket correctly.\n\n    s3.createBucket { Bucket: DOMAIN, ACL: \"public-read\" }, (err, data) ->\n      if err\n        console.log \"[ERROR]: #{err}\"\n      else\n        welcome = fs.readFileSync path.join(__dirname, \"welcome-ascii.txt\")\n        welcome = \"<pre>#{welcome}<\/pre>\"\n        params = {\n          Bucket: BUCKET\n          Key: \"index.html\",\n          ACL: \"public-read\",\n          Body: welcome,\n          ContentType: \"text\/html\"\n        }\n        s3.putObject params, (err, data) ->\n          if err\n            console.log \"[ERROR]: error creating index.html #{err}\"\n            return\n          params = {\n            Bucket: BUCKET,\n            WebsiteConfiguration: {\n              IndexDocument: {\n                Suffix: 'index.html'\n              }\n            }\n          }\n          s3.putBucketWebsite params, (err, data) ->\n            if err\n              console.log \"[ERROR]: #{err}\"\n\n--------\nWe're going to make `leech` (this module) exportable so that we can use it in\nthe app, as a command line tool, and as it's own funciton. It takes 1 argument\n(the url) which makes it easy to plug-n-play in other stuff.\n\n    module.exports = (url, fn) ->\n\nThis is our basic HTML template that we'll use for doing the redirect. It's just\ngoing to send the user to another page as soon as it's loaded. There's no server\nsince it's just a static file, but everything will be tracked by GA.\n\n      source = \"\"\"\n      <html>\n          <title>{{url}}<\/title>\n          <body>\n          <script>\n            <!-- Google Analytics -->\n              (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){\n              (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),\n              m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)\n              })(window,document,'script','\/\/www.google-analytics.com\/analytics.js','ga');\n\n              ga('create', '{{ga_id}}', 'auto');\n              ga('send', 'pageview');\n              \/\/ redirect\n              window.location.replace('{{url}}');\n            <\/script>\n          <\/body>\n      <\/html>\n      \"\"\"\n\n      template = handlebars.compile(source)\n\nData should just be the user's Google Analytics Id and the URL that they want to\nminify.\n\n      data = { url: url, ga_id: GA_ID }\n      html = template(data)\n\nWe're going to generate a shortlink for the URL. [`shortid`](https:\/\/github.com\/dylang\/shortid)\ndoes a pretty good job at balancing between being short, and also being unique! \nWe'll take that `_id` and turn it into the key for an S3 object. If you want \nthis to be really \"scalable\", you can \"hash\" your S3 keys. All this means is \nthat you split the key into 2 parts like so: (\"abcd123\" --> \"abc\/d123\"). S3 will\nautomatically partition you keys across more servers and will dramatically \nincrease preformance.\n\n      shortid.characters \"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ()\"\n      _id = shortid.generate()\n      if PARTITION\n        _id = _id.slice(0, 3) + \"\/\" + _id.slice(3)\n      params = {\n        Bucket: BUCKET,\n        Key: _id\n        ACL: \"public-read\",\n        Body: html,\n        ContentType: \"text\/html\",\n        Metadata: {\n          url: url\n        }\n      }\n      s3.putObject params, (err, data) ->\n          if err\n            console.log err\n          fn err, path.join(DOMAIN, _id)\n\n","old_contents":"    path = require 'path'\n    handlebars = require 'handlebars'\n    aws = require 'aws-sdk'\n    shortid = require 'shortid'\n    Hashids = require 'hashids'\n    hashids = new Hashids(process.env[\"AWS_ACCESS_KEY\"])\n\n\nGrab our environment variables...\n\n    DOMAIN = process.env[\"DOMAIN\"] || \"thelee.ch\"\n    BUCKET = process.env[\"BUCKET\"] || DOMAIN\n    GA_ID = process.env[\"GA_ID\"]\n    PARTITION = process.env[\"PARTITION\"] || false\n\nSetup the connection to s3\n\n    aws.config.update {\n        accessKeyId: process.env[\"AWS_ACCESS_KEY\"],\n        secretAccessKey: process.env[\"AWS_SECRET_KEY\"]\n    }\n    aws.config.region = 'us-east-1'\n    s3 = new aws.S3()\n\nMake sure the S3 bucket is setup as a website. We'll just do this each time we \nstart the app. This means that it will frequently fail, but it's the simplest\nway to make sure that we've setup the bucket correctly.\n    \n    s3.createBucket { Bucket: DOMAIN }, (err, data) ->\n      if err\n        console.log \"[ERROR]: #{err}\"\n      else\n        console.log \"Bucket was created for your domain. URL is #{data.url}\"\n        welcome = fs.readFileSync path.join(__dirname, \"welcome-leech.txt\")\n        params = {\n          Bucket: BUCKET,\n          Key: \"index.html\",\n          ACL: \"public-read\",\n          Body: welcome,\n          ContentType: \"text\/html\"\n        }\n        s3.putObject params, (err, data) ->\n            if err\n              console.log \"[ERROR]: #{err}\"\n\n--------\nWe're going to make `leech` (this module) exportable so that we can use it in\nthe app, as a command line tool, and as it's own funciton. It takes 1 argument\n(the url) which makes it easy to plug-n-play in other stuff.\n\n    module.exports = (url, fn) ->\n\nThis is our basic HTML template that we'll use for doing the redirect. It's just\ngoing to send the user to another page as soon as it's loaded. There's no server\nsince it's just a static file, but everything will be tracked by GA.\n\n      source = \"\"\"\n      <html>\n          <title>{{url}}<\/title>\n          <body>\n          <script>\n            <!-- Google Analytics -->\n              (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){\n              (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),\n              m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)\n              })(window,document,'script','\/\/www.google-analytics.com\/analytics.js','ga');\n\n              ga('create', '{{ga_id}}', 'auto');\n              ga('send', 'pageview');\n              \/\/ redirect\n              window.location.replace('{{url}}');\n            <\/script>\n          <\/body>\n      <\/html>\n      \"\"\"\n\n      template = handlebars.compile(source)\n\nData should just be the user's Google Analytics Id and the URL that they want to\nminify.\n\n      data = { url: url, ga_id: GA_ID }\n      html = template(data)\n\nWe're going to generate a shortlink for the URL. [`shortid`](https:\/\/github.com\/dylang\/shortid)\ndoes a pretty good job at balancing between being short, and also being unique! \nWe'll take that `_id` and turn it into the key for an S3 object. If you want \nthis to be really \"scalable\", you can \"hash\" your S3 keys. All this means is \nthat you split the key into 2 parts like so: (\"abcd123\" --> \"abc\/d123\"). S3 will\nautomatically partition you keys across more servers and will dramatically \nincrease preformance.\n\n      shortid.characters \"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ()\"\n      _id = shortid.generate()\n      if PARTITION\n        _id = _id.slice(0, 3) + \"\/\" + _id.slice(3)\n      params = {\n        Bucket: BUCKET,\n        Key: _id\n        ACL: \"public-read\",\n        Body: html,\n        ContentType: \"text\/html\",\n        Metadata: {\n          url: url\n        }\n      }\n      s3.putObject params, (err, data) ->\n          if err\n            console.log err\n          fn err, path.join(DOMAIN, _id)\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"aea72e16ea281e4d63f5fffe8d5d8cc98e0323e4","subject":"Proper array\/object Promise.all differentiation, with correct error handling semantics","message":"Proper array\/object Promise.all differentiation, with correct error handling semantics\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-angular\/client\/index.litcoffee","new_file":"packages\/shrub-angular\/client\/index.litcoffee","new_contents":"# Angular\n\n*Coordinate various core functionality.*\n\n    _ = require 'lodash'\n    Promise = require 'bluebird'\n\n    config = require 'config'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularAHrefSanitizationWhitelist`.\n\n      registrar.registerHook 'shrubAngularAHrefSanitizationWhitelist', -> [\n\nAllow more protocols.\n\n        '(?:https?|ftp|mailto|tel|file):'\n\nAllow javascript:void(0).\n\n        'javascript:void\\\\(0\\\\)'\n      ]\n\n#### Implements hook `shrubAngularAppConfig`.\n\n      registrar.registerHook 'shrubAngularAppConfig', -> [\n        '$compileProvider', '$injector', '$provide', '$routeProvider', '$locationProvider', 'shrub-pkgmanProvider'\n        ($compileProvider, $injector, $provide, $routeProvider, $locationProvider, pkgmanProvider) ->\n\n#### Invoke hook `shrubAngularAHrefSanitizationWhitelist`.\n\n          regexes = []\n          for regexes_ in pkgmanProvider.invokeFlat(\n            'shrubAngularAHrefSanitizationWhitelist'\n          )\n            regexes.push regex for regex in regexes_\n\n          $compileProvider.aHrefSanitizationWhitelist new RegExp(\n            \"^\\s*(?:#{regexes.join '|'})\"\n          )\n\n          unless config.get 'packageConfig:shrub-core:testMode'\n            $compileProvider.debugInfoEnabled false\n\nCompletely override $q with Bluebird, because it's awesome.\n\n###### TODO: Angular also implements a private service called $$q used for animation. We should override that one, too.\n\n          $provide.decorator '$q', [\n            '$rootScope', '$exceptionHandler'\n            ($rootScope, $exceptionHandler) ->\n\n              Promise.onPossiblyUnhandledRejection (error) ->\n\n$timeout and $interval will throw this for cancellation. It's non-notable.\n\n                return if 'canceled' is error.message\n\n                $exceptionHandler error\n\nHook Bluebird's schedule up to Angular.\n\n              Promise.setScheduler (fn) -> $rootScope.$evalAsync fn\n\n## Promise.defer\n\nSee: https:\/\/docs.angularjs.org\/api\/ng\/service\/$q#the-deferred-api\n\n              Promise.defer = ->\n                resolve = null\n                reject = null\n\n                promise = new Promise ->\n                  resolve = arguments[0]\n                  reject = arguments[1]\n\nAngular depends on notify, which is a crap API. We'll hack support for it in.\n\n                __notifications = []\n                proxyThen = promise.then\n                promise.then = ->\n                  args = (arg for arg in arguments)\n                  __notifications.push args[2] if args[2]?\n                  proxyThen.apply promise, args\n                notify: (args...) -> fn args... for fn in __notifications\n\n                promise: promise\n                resolve: resolve\n                reject: reject\n\n## Promise.when\n\nSee: https:\/\/docs.angularjs.org\/api\/ng\/service\/$q#when\n\n              Promise.when = (value, handlers...) ->\n                Promise.cast(value).then handlers...\n\nProxy Promise.all because Angular supports passing in an object where the\nvalues are promises, and the result is an object keyed with the resolved\nvalues from the promise.\n\n              originalAll = Promise.all\n              Promise.all = (promises) ->\n\nCast it to a promise to be able to determine whether it's an array.\n\n                Promise.cast(promises).then ->\n\nDefer to Bluebird if it's an array.\n\n                  return originalAll promises if angular.isArray promises\n\nIf it's not an object, defer to Bluebird (it'll throw).\n\n                  return originalAll promises unless angular.isObject promises\n\nTrack the keys so we can map the values.\n\n                  promiseKeys = []\n                  promiseArray = for key, promise of promises\n                    promiseKeys.push key\n                    promise\n\n                  originalAll(promiseArray).then (results) ->\n                    objectResult = {}\n\n                    for result, index in results\n                      objectResult[promiseKeys[index]] = result\n\n                    objectResult\n\n              Promise\n\n          ]\n\n#### Invoke hook `shrubAngularRoutes`.\n\nAllow packages to define routes in the Angular application.\n\n          routes = {}\n          for route in _.flatten pkgmanProvider.invokeFlat 'shrubAngularRoutes'\n            routes[route.path ? path] = route\n\nInvoke hook `shrubAngularRoutesAlter`.\n\nAllow packages to alter defined routes.\n\n          $injector.invoke(\n            injectable, null\n            routes: routes\n          ) for injectable in pkgmanProvider.invokeFlat 'shrubAngularRoutesAlter'\n\n          for path, route of routes\n            do (path, route) ->\n\nWrap the controller so we can provide some automatic behavior.\n\n              routeController = route.controller\n              route.controller = [\n                '$controller', '$injector', '$q', '$scope'\n                ($controller, $injector, $q, $scope) ->\n\n                  unless routeController?\n                    return $scope.$emit 'shrub.core.routeRendered'\n\nControllers may return a promise, so wait until any returned value fulfills.\nIf it's not a promise, this will be in the next tick.\n\n                  $q.when($injector.invoke(\n                    routeController, null\n                    $scope: $scope\n                    route: route\n                  )).then(-> $scope.$emit 'shrub.core.routeRendered').done()\n\n              ]\n\n              route.template ?= ' '\n\nRegister the path into Angular.\n\n              $routeProvider.when \"\/#{route.path ? path}\", route\n\nCreate a unique entry point.\n\n          $routeProvider.when '\/shrub-angular-entry-point', {}\n\nTurn on HTML5 mode: \"Real\" URLs.\n\n          $locationProvider.html5Mode true\n      ]\n","old_contents":"# Angular\n\n*Coordinate various core functionality.*\n\n    _ = require 'lodash'\n    Promise = require 'bluebird'\n\n    config = require 'config'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularAHrefSanitizationWhitelist`.\n\n      registrar.registerHook 'shrubAngularAHrefSanitizationWhitelist', -> [\n\nAllow more protocols.\n\n        '(?:https?|ftp|mailto|tel|file):'\n\nAllow javascript:void(0).\n\n        'javascript:void\\\\(0\\\\)'\n      ]\n\n#### Implements hook `shrubAngularAppConfig`.\n\n      registrar.registerHook 'shrubAngularAppConfig', -> [\n        '$compileProvider', '$injector', '$provide', '$routeProvider', '$locationProvider', 'shrub-pkgmanProvider'\n        ($compileProvider, $injector, $provide, $routeProvider, $locationProvider, pkgmanProvider) ->\n\n#### Invoke hook `shrubAngularAHrefSanitizationWhitelist`.\n\n          regexes = []\n          for regexes_ in pkgmanProvider.invokeFlat(\n            'shrubAngularAHrefSanitizationWhitelist'\n          )\n            regexes.push regex for regex in regexes_\n\n          $compileProvider.aHrefSanitizationWhitelist new RegExp(\n            \"^\\s*(?:#{regexes.join '|'})\"\n          )\n\n          unless config.get 'packageConfig:shrub-core:testMode'\n            $compileProvider.debugInfoEnabled false\n\nCompletely override $q with Bluebird, because it's awesome.\n\n###### TODO: Angular also implements a private service called $$q used for animation. We should override that one, too.\n\n          $provide.decorator '$q', [\n            '$rootScope', '$exceptionHandler'\n            ($rootScope, $exceptionHandler) ->\n\n              Promise.onPossiblyUnhandledRejection (error) ->\n\n$timeout and $interval will throw this for cancellation. It's non-notable.\n\n                return if 'canceled' is error.message\n\n                $exceptionHandler error\n\nHook Bluebird's schedule up to Angular.\n\n              Promise.setScheduler (fn) -> $rootScope.$evalAsync fn\n\n## Promise.defer\n\nSee: https:\/\/docs.angularjs.org\/api\/ng\/service\/$q#the-deferred-api\n\n              Promise.defer = ->\n                resolve = null\n                reject = null\n\n                promise = new Promise ->\n                  resolve = arguments[0]\n                  reject = arguments[1]\n\nAngular depends on notify, which is a crap API. We'll hack support for it in.\n\n                __notifications = []\n                proxyThen = promise.then\n                promise.then = ->\n                  args = (arg for arg in arguments)\n                  __notifications.push args[2] if args[2]?\n                  proxyThen.apply promise, args\n                notify: (args...) -> fn args... for fn in __notifications\n\n                promise: promise\n                resolve: resolve\n                reject: reject\n\n## Promise.when\n\nSee: https:\/\/docs.angularjs.org\/api\/ng\/service\/$q#when\n\n              Promise.when = (value, handlers...) ->\n                Promise.cast(value).then handlers...\n\nProxy Promise.all because Angular supports passing in an object where the\nvalues are promises, and the result is an object keyed with the resolved\nvalues from the promise.\n\n              originalAll = Promise.all\n              Promise.all = (promises) ->\n\nDefer to Bluebird unless it's an object.\n\n                return originalAll promises unless angular.isObject(\n                  promises\n                )\n\nTrack the keys so we can map the values.\n\n                promiseKeys = []\n                promiseArray = for key, promise of promises\n                  promiseKeys.push key\n                  promise\n\n                originalAll(promiseArray).then (results) ->\n                  objectResult = {}\n\n                  for result, index in results\n                    objectResult[promiseKeys[index]] = result\n\n                  objectResult\n\n              Promise\n\n          ]\n\n#### Invoke hook `shrubAngularRoutes`.\n\nAllow packages to define routes in the Angular application.\n\n          routes = {}\n          for route in _.flatten pkgmanProvider.invokeFlat 'shrubAngularRoutes'\n            routes[route.path ? path] = route\n\nInvoke hook `shrubAngularRoutesAlter`.\n\nAllow packages to alter defined routes.\n\n          $injector.invoke(\n            injectable, null\n            routes: routes\n          ) for injectable in pkgmanProvider.invokeFlat 'shrubAngularRoutesAlter'\n\n          for path, route of routes\n            do (path, route) ->\n\nWrap the controller so we can provide some automatic behavior.\n\n              routeController = route.controller\n              route.controller = [\n                '$controller', '$injector', '$q', '$scope'\n                ($controller, $injector, $q, $scope) ->\n\n                  unless routeController?\n                    return $scope.$emit 'shrub.core.routeRendered'\n\nControllers may return a promise, so wait until any returned value fulfills.\nIf it's not a promise, this will be in the next tick.\n\n                  $q.when($injector.invoke(\n                    routeController, null\n                    $scope: $scope\n                    route: route\n                  )).then(-> $scope.$emit 'shrub.core.routeRendered').done()\n\n              ]\n\n              route.template ?= ' '\n\nRegister the path into Angular.\n\n              $routeProvider.when \"\/#{route.path ? path}\", route\n\nCreate a unique entry point.\n\n          $routeProvider.when '\/shrub-angular-entry-point', {}\n\nTurn on HTML5 mode: \"Real\" URLs.\n\n          $locationProvider.html5Mode true\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f8d5c5245cde4ff15e472158f81d6af02a71469d","subject":"ancestor tests pass on component","message":"ancestor tests pass on component\n","repos":"nhz-io\/cnl","old_file":"source\/component.litcoffee","new_file":"source\/component.litcoffee","new_contents":"# CLASS: Component\n* Extends: [Shape][Shape]\n* Parent: [Index][Parent]\n\nAn interactive component\n\n---\n\n    Event = require 'ecl\/dist\/event'\n    module.exports = class Component extends require '.\/shape'\n\n## CONSTRUCTOR\n### new Component()\n* Returns: [Component][Component]\n\nCreates Component instance.\n\n      constructor: ->\n        super\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['grab', 'release', 'drag']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['grab', 'release', 'drag']\n\nAdd capturing extendable listener\n          \n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n          \n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## METHODS\n### #mousemoveCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **mousemove** event passing throught this component\n\n      mousemoveCaptureListener: (event) ->\n        super\n\nProceed only for valid event\n\n        if event\n          $ = @___runtime\n\nReset component state.\n\n          @state = null\n\nIf component is grabbed then set the state to **active**.\n\n          if $.grab\n            @state = 'active'\n\nCreate **drag** Event and broadcast it to this component if drag event is enabled,\n\n            if @events?.drag\n              @broadcastEvent new Event\n                type:'drag', x:event.x, y:event.y\n\nsetting the drag offset.\n\n                offsetX: event.x - ($.dragEvent?.x or $.grabEvent?.x or 0)\n                offsetY: event.y - ($.dragEvent?.y or $.grabEvent?.y or 0)\n\nOtherwise, set the state to the name of the first matching region in order.\n\n          else if regions = event.regions\n            @state = (if regions.hover then 'hover' else if regions.normal then 'normal')\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #mousedownListener(event)\n* Returns: [Component][Component]\n\nReceive **mousedown** event.\n\n      mousedownListener: (event) ->\n        super\n\nProceed only for valid event\n\n        if event\n\nIf component is in active state and **grab** event is enabled then grab this component.\n\n          if (@state is 'active') and @events?.grab\n            ($ = @___runtime).grab = true\n\nCreate **grab** event and deliver it to this component.\n          \n            $.dragEvent = null\n            @broadcastEvent new Event\n              type:'grab', x:event.x, y:event.y\n          \n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #dragCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **drag** events passing through this component\n\n      dragCaptureListener: (event) ->\n\nProceed only for valid event\n\n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.dragEvent = event\n          localizeEventCoordinates event, @origin\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #grabCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **grab** events passing through this component.\n\n      grabCaptureListener: (event) ->\n\nProceed only for valid event\n        \n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.grabEvent = event\n          localizeEventCoordinates event, @origin\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n* Returns: [Component][Component]\n\nCapture **release** events passing through this component.\n\n      releaseCaptureListener: (event) ->\n\nProceed only for valid event\n        \n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.releaseEvent = event\n          localizeEventCoordinates event, @origin\n          \n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n* Returns: [Component][Component]\n\n#### #dragListener(event)\n* Returns: [Component][Component]\n\n**drag** event receiver stub.\n\n      dragListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #grabListener(event)\n* Returns: [Component][Component]\n\n**grab** event receiver stub.\n\n      grabListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n### #releaseListener(event)\n* Returns: [Component][Component]\n\n**release** event receiver stub.\n\n      releaseListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n\n[Parent]: .\/index.litcoffee\n[Element]: .\/element.litcoffee\n[Component]: .\/component.litcoffee\n\n","old_contents":"# CLASS: Component\n* Extends: [Element][Element]\n* Parent: [Index][Parent]\n\n---\n\n    module.exports = class Component extends require '.\/element'\n\n## CONSTRUCTOR\n\n### new Component()\n\nCreates Component instance.\n\n      constructor: -> super\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## METHODS\n\n[Parent]: .\/index.litcoffee\n[Element]: .\/element.litcoffee\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b14e8079606d1669f60cb2cece0f0f15ead12687","subject":"0.0.16 Tidy tetracoords.litcoffee (2)","message":"0.0.16 Tidy tetracoords.litcoffee (2)\n","repos":"loopdotcoop\/magnubbin,loopdotcoop\/magnubbin","old_file":"supplemental\/tetracoords\/tetracoords.litcoffee","new_file":"supplemental\/tetracoords\/tetracoords.litcoffee","new_contents":"tetraCoords()\n=============\n\n#### Calculates the coordinates of a tetrahedron\u2019s vertices from 6 edge lengths\n\n- __G__ The point on the tabletop furthest away from you\n- __H__ The leftmost point touching the tabletop\n- __I__ The rightmost point touching the tabletop\n- __J__ The point in the middle, not touching the table\n\n\nTo watch and compile automatically: \n```bash\ncoffee --watch --compile supplemental\/tetracoords\/tetracoords.litcoffee\n```\n\n\n#### `tetraCoords()`\n- `a <number>`  the edge joining __G \u2014 H__\n- `b <number>`  the edge joining __H \u2014 I__\n- `c <number>`  the edge joining __I \u2014 G__\n- `d <number>`  the edge joining __G \u2014 J__\n- `e <number>`  the edge joining __J \u2014 H__\n- `f <number>`  the edge joining __J \u2014 I__\n- `<array>`     twelve numbers, representing (x,y,z) coords of __G, H, I and J__  \n\n    window.tetraCoords = (a, b, c, d, e, f) ->\n      M = 'tetraCoords()\\n  '\n\nRun basic validation of the six arguments. \n\n      for name,arg of { a:a,b:b,c:c,d:d,e:e,f:f }\n        if 'number' != typeof arg then throw TypeError \"\n          #{M}Argument `#{name}` is #{typeof arg} not number\"\n        if 9007199254740991 < arg or 0 > arg then throw RangeError \"\n          #{M}Argument `#{name}` is #{arg} not 0 or a +ve number < 2^53\"\n\nInitialize the output array, and place __G,__ (the point on the tabletop \nfurthest away from you) at the origin. \n\n      out = [\n        0 # [0] = Gx\n        0 # [1] = Gy\n        0 # [2] = Gz\n      ]\n\nUse the [law of cosines](https:\/\/goo.gl\/8djIju) to find the angle (in radians) \nof the corner opposite `b` on the tabletop. `cos B = (a\u00b2 + c\u00b2 \u2212 b\u00b2) \/ 2ac`  \n\n      oppB = Math.acos( (a*a + c*c - b*b) \/ (2*a*c) )\n\nCalculate __H,__ the leftmost point touching the tabletop. \n\n      out.push(\n        Math.sin(oppB\/2) * -a, # [3] = Hx\n        0,                     # [4] = Hy\n        Math.cos(oppB\/2) * -a  # [5] = Hz\n      )\n\nCalculate __I,__ the rightmost point touching the tabletop. \n\n      out.push(\n        Math.sin(oppB\/2) * c,  # [6] = Ix\n        0,                     # [7] = Iy\n        Math.cos(oppB\/2) * -c  # [8] = Iz\n      )\n\nUse `trilaterate()` to calculate __J,__ the raised point in the middle. \n\n      result = trilaterate(\n        { x:0     , y:0, z:0     , r:d }, # p1\n        { x:out[3], y:0, z:out[5], r:e }, # p2\n        { x:out[6], y:0, z:out[8], r:f }  # p3\n      )\n\nDeal with an impossible tetrahedron. \n\n      if null == result then throw RangeError \"\n        #{M}`#{a},#{b},#{c},#{d},#{e},#{f}` cannot be tetrahedron edges\"\n\n`trilaterate()` usually returns coords for __J__ above _and_ below the tabletop. \n\n      if 2 == result.length\n        out.push(\n          result[1].x, #  [9] = Jx\n          result[1].y, # [10] = Jy (`result[1]` is always +ve)\n          result[1].z  # [11] = Jz\n        )\n\nIf `trilaterate()` returns an object, we have a \u2018flat\u2019 tetrahedron\n\n      else\n        out.push(\n          result.x,    #  [9] = Jx\n          result.y,    # [10] = Jy (always 0)\n          result.z     # [11] = Jz\n        )\n\nMove the tetrahedron coords so that the origin is roughly in the center. \n\n      dy = -out[10] \/ 3 # third of height, `-Jy \/ 3`\n      out[y] += dy for y in [1,4,7,10]\n      dz = -(out[5] + out[8]) \/ 4 # half of average depth, `(Hz + Iz) \/ 2 \/ 2`\n      out[z] += dz for z in [2,5,8,11]\n\nRound results to 3 decimal places. \n\n      out = (Math.round(coord * 1000) \/ 1000 for coord in out)\n\nConvert to a neat string. @todo pass tetraCoords()` an argument to enable this\n\n      out = (for coord in out\n        coord  = (if 0 <= coord then ' ' else '') + coord\n        pos = coord.indexOf '.'\n        coord += (if -1 == pos then '.000' else '00')\n        pos = coord.indexOf '.'\n        coord = coord.slice 0, pos + 4\n      )\n\nReturn the output array. \n\n      out\n\n\n\n","old_contents":"tetraCoords()\n=============\n\n#### Calculates the coordinates of a tetrahedron\u2019s vertices from 6 edge lengths\n\n- __G__ The point on the tabletop furthest away from you\n- __H__ The leftmost point touching the tabletop\n- __I__ The rightmost point touching the tabletop\n- __J__ The point in the middle, not touching the table\n\n\nTo watch and compile automatically: \n```bash\ncoffee --watch --compile supplemental\/tetracoords\/tetracoords.litcoffee\n```\n\n\n#### `tetraCoords()`\n- `a <number>`  the edge joining __G \u2014 H__\n- `b <number>`  the edge joining __H \u2014 I__\n- `c <number>`  the edge joining __I \u2014 G__\n- `d <number>`  the edge joining __G \u2014 J__\n- `e <number>`  the edge joining __J \u2014 H__\n- `f <number>`  the edge joining __J \u2014 I__\n- `<array>`     twelve numbers, representing (x,y,z) coords of __G, H, I and J__\n\n\n    window.tetraCoords = (a, b, c, d, e, f) ->\n      M = 'tetraCoords()\\n  '\n\nRun basic validation of the six arguments. \n\n      for name,arg of { a:a,b:b,c:c,d:d,e:e,f:f }\n        if 'number' != typeof arg then throw TypeError \"\n          #{M}Argument `#{name}` is #{typeof arg} not number\"\n        if 9007199254740991 < arg or 0 > arg then throw RangeError \"\n          #{M}Argument `#{name}` is #{arg} not 0 or a +ve number < 2^53\"\n\nInitialize the output array, and place __G,__ (the point on the tabletop \nfurthest away from you) at the origin. \n\n      out = [\n        0 # [0] = Gx\n        0 # [1] = Gy\n        0 # [2] = Gz\n      ]\n\nUse the [law of cosines](https:\/\/goo.gl\/8djIju) to find the angle (in radians) \nof the corner opposite `b` on the tabletop. `cos B = (a\u00b2 + c\u00b2 \u2212 b\u00b2) \/ 2ac`  \n\n      oppB = Math.acos( (a*a + c*c - b*b) \/ (2*a*c) )\n\nCalculate __H,__ the leftmost point touching the tabletop. \n\n      out.push(\n        Math.sin(oppB\/2) * -a, # [3] = Hx\n        0,                     # [4] = Hy\n        Math.cos(oppB\/2) * -a  # [5] = Hz\n      )\n\nCalculate __I,__ the rightmost point touching the tabletop. \n\n      out.push(\n        Math.sin(oppB\/2) * c,  # [6] = Ix\n        0,                     # [7] = Iy\n        Math.cos(oppB\/2) * -c  # [8] = Iz\n      )\n\nUse `trilaterate()` to calculate __J,__ the raised point in the middle. \n\n      result = trilaterate(\n        { x:0     , y:0, z:0     , r:d }, # p1\n        { x:out[3], y:0, z:out[5], r:e }, # p2\n        { x:out[6], y:0, z:out[8], r:f }  # p3\n      )\n\nDeal with an impossible tetrahedron. \n\n      if null == result then throw RangeError \"\n        #{M}`#{a},#{b},#{c},#{d},#{e},#{f}` cannot be tetrahedron edges\"\n\n`trilaterate()` usually returns coords for __J__ above _and_ below the tabletop. \n\n      if 2 == result.length\n        out.push(\n          result[1].x, #  [9] = Jx\n          result[1].y, # [10] = Jy (`result[1]` is always +ve)\n          result[1].z  # [11] = Jz\n        )\n\nIf `trilaterate()` returns an object, we have a \u2018flat\u2019 tetrahedron\n\n      else\n        out.push(\n          result.x,    #  [9] = Jx\n          result.y,    # [10] = Jy (always 0)\n          result.z     # [11] = Jz\n        )\n\nMove the tetrahedron coords so that the origin is roughly in the center. \n\n      dy = -out[10] \/ 3 # third of height, `-Jy \/ 3`\n      out[y] += dy for y in [1,4,7,10]\n      dz = -(out[5] + out[8]) \/ 4 # half of average depth, `(Hz + Iz) \/ 2 \/ 2`\n      out[z] += dz for z in [2,5,8,11]\n\nRound results to 3 decimal places. \n\n      out = (Math.round(coord * 1000) \/ 1000 for coord in out)\n\nConvert to a neat string. @todo pass tetraCoords()` an argument to enable this\n\n      out = (for coord in out\n        coord  = (if 0 <= coord then ' ' else '') + coord\n        pos = coord.indexOf '.'\n        coord += (if -1 == pos then '.000' else '00')\n        pos = coord.indexOf '.'\n        coord = coord.slice 0, pos + 4\n      )\n\nReturn the output array. \n\n      out\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3a36462ead0eda5c6f04d002116cf94cd5ec76ae","subject":"Strengthen URI component decode","message":"Strengthen URI component decode\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower.\n\n      if typeof req.query.sort is 'string' and req.query.sort\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\nOnly apply default sort if there are no geospatial queries.\n\n      else\n        sort = 'endret' if not req.db.query.geojson\n\n### Execute\n\nSet limit, skip and, sort options for documents to be returned.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\n      cursor = req.db.col.find(req.db.query, fields, options)\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = decodeURIComponent col\n      req.db   = col: mongo[req.type], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower.\n\n      if typeof req.query.sort is 'string' and req.query.sort\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\nOnly apply default sort if there are no geospatial queries.\n\n      else\n        sort = 'endret' if not req.db.query.geojson\n\n### Execute\n\nSet limit, skip and, sort options for documents to be returned.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\n      cursor = req.db.col.find(req.db.query, fields, options)\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"86088710c1e5aa135daeb9c126dc45c34934d8c2","subject":"Refactor be.bastelstu.wcf.nodePush a bit","message":"Refactor be.bastelstu.wcf.nodePush a bit\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/js\/be.bastelstu.wcf.nodePush.litcoffee","new_file":"file\/js\/be.bastelstu.wcf.nodePush.litcoffee","new_contents":"nodePush - Frontend\n===================\n\nThis is the frontend JavaScript for [**nodePush**](https:\/\/github.com\/wbbaddons\/nodePush). It transparently handles\neverything that has to be done in order to connect to **nodePush** and provides a nice API for 3rd party developers.\n\n\t### Copyright Information\n\t# @author\tTim D\u00fcsterhus\n\t# @copyright\t2012-2013 Tim D\u00fcsterhus\n\t# @license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\n\t# @package\tbe.bastelstu.wcf.nodePush\n\t###\n\n## Code\nWe start by setting up our environment by ensuring some sane values for both `$` and `window`,\nenabling EMCAScript 5 strict mode and overwriting console to prepend the name of the class.\n\n\t(($, window) ->\n\t\t\"use strict\";\n\t\t\n\t\tconsole =\n\t\t\tlog: (message) ->\n\t\t\t\twindow.console.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\twarn: (message) ->\n\t\t\t\twindow.console.warn \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\terror: (message) ->\n\t\t\t\twindow.console.error \"[be.bastelstu.wcf.nodePush] #{message}\"\n\nContinue with defining the needed variables. All variables are local to our closure and will be\nexposed by a function if necessary.\n\n\t\tsocket = null\n\t\tconnected = false\n\t\tinitialized = false\n\t\tevents =\n\t\t\tconnect: $.Callbacks()\n\t\t\tdisconnect: $.Callbacks()\n\t\t\tmessage: { }\n\nInitialize socket.io to enable nodePush.\n\n\t\tinit = (host) ->\n\t\t\treturn if initialized\n\t\t\tinitialized = true\n\t\t\tconsole.log 'Initializing nodePush'\n\t\t\t\n\t\t\tunless window.io?\n\t\t\t\tconsole.error 'nodePush not available, aborting'\n\t\t\t\treturn\n\t\t\t\t\n\t\t\tsocket = window.io.connect host\n\t\t\t\n\t\t\tsocket.on 'connect', ->\n\t\t\t\tconsole.log 'Connected to nodePush'\n\t\t\t\tsocket.emit 'userID', WCF.User.userID\n\t\t\t\n\t\t\tsocket.on 'authenticated', ->\n\t\t\t\tconsole.log 'Exchanged userID with nodePush'\n\t\t\t\tconnected = true\n\t\t\t\tevents.connect.fire()\n\t\t\t\n\t\t\tsocket.on 'disconnect', ->\n\t\t\t\tconnected = false\n\t\t\t\tconsole.warn 'Lost connection to nodePush'\n\t\t\t\tevents.disconnect.fire()\n\t\t\t\n\t\t\tsocket.on 'message', (message) ->\n\t\t\t\treturn unless events.message[message]?\n\t\t\t\t\n\t\t\t\tevents.message[message].fire()\n\nAdd a new `callback` that will be called when a connection to nodePush is established and the\nuserID was exchanged. The given `callback` will be called once if a connection is established at\ntime of calling. Return `true` on success and `false` otherwise.\n\n\t\tonConnect = (callback) ->\n\t\t\treturn false unless $.isFunction callback\n\t\t\t\n\t\t\tevents.connect.add callback\n\t\t\t\n\t\t\tcallback() if connected\n\t\t\ttrue\n\nAdd a new `callback` that will be called when the connection to nodePush is lost. Return `true`\non success and `false` otherwise.\n\n\t\tonDisconnect = (callback) ->\n\t\t\treturn false unless $.isFunction callback\n\t\t\t\n\t\t\tevents.disconnect.add callback\n\t\t\ttrue\n\nAdd a new `callback` that will be called when the specified `message` is received. Return `true`\non success and `false` otherwise.\n\n\t\tonMessage = (message, callback) ->\n\t\t\treturn false unless $.isFunction callback\n\t\t\treturn false unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test message\n\t\t\t\n\t\t\tevents.message[message] ?= $.Callbacks()\n\t\t\tevents.message[message].add callback\n\t\t\ttrue\n\nAnd finally export the public methods and variables.\n\n\t\twindow.be ?= {}\n\t\tbe.bastelstu ?= {}\n\t\tbe.bastelstu.wcf ?= {}\n\t\tbe.bastelstu.wcf.nodePush = \n\t\t\tinit: init\n\t\t\tonConnect: onConnect\n\t\t\tonDisconnect: onDisconnect\n\t\t\tonMessage: onMessage\n\n\t)(jQuery, @)\n","old_contents":"Frontend JavaScript for nodePush\n================================\n\n\t### Copyright Information\n\t# @author\tTim D\u00fcsterhus\n\t# @copyright\t2012-2013 Tim D\u00fcsterhus\n\t# @license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\n\t# @package\tbe.bastelstu.wcf.nodePush\n\t###\n\nSetup\n-----\nEnsure sane values for `$` and `window`\n\n\t(($, window) ->\n\t\t# Enable strict mode\n\t\t\"use strict\";\n\t\t\n\t\t# Ensure our namespace is present\n\t\twindow.be ?= {}\n\t\tbe.bastelstu ?= {}\n\t\tbe.bastelstu.wcf ?= {}\n\nOverwrite `console` to add the origin in front of the message\n\n\t\tconsole =\n\t\t\tlog: (message) ->\n\t\t\t\twindow.console.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\twarn: (message) ->\n\t\t\t\twindow.console.warn \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\terror: (message) ->\n\t\t\t\twindow.console.error \"[be.bastelstu.wcf.nodePush] #{message}\"\n\nbe.bastelstu.wcf.nodePush\n=========================\n\nPrivate Attributes\n------------------\n\n\t\tsocket = null\n\t\tconnected = false\n\t\tinitialized = false\n\t\tevents =\n\t\t\tconnect: $.Callbacks()\n\t\t\tdisconnect: $.Callbacks()\n\t\t\tmessage: { }\n\t\t\n\t\tbe.bastelstu.wcf.nodePush = \n\nMethods\n-------\n\n**init(string host)**  \nInitialize socket.io to enable nodePush.\n\n\t\t\tinit: (host) ->\n\t\t\t\treturn if initialized\n\t\t\t\tinitialized = true\n\t\t\t\tconsole.log 'Initializing nodePush'\n\t\t\t\t\n\t\t\t\tunless window.io?\n\t\t\t\t\tconsole.error 'nodePush not available, aborting'\n\t\t\t\t\treturn\n\t\t\t\t\t\n\t\t\t\tsocket = window.io.connect host\n\t\t\t\t\n\t\t\t\tsocket.on 'connect', ->\n\t\t\t\t\tconsole.log 'Connected to nodePush'\n\t\t\t\t\tsocket.emit 'userID', WCF.User.userID\n\t\t\t\t\n\t\t\t\tsocket.on 'authenticated', ->\n\t\t\t\t\tconsole.log 'Exchanged userID with nodePush'\n\t\t\t\t\tconnected = true\n\t\t\t\t\tevents.connect.fire()\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', ->\n\t\t\t\t\tconnected = false\n\t\t\t\t\tconsole.warn 'Lost connection to nodePush'\n\t\t\t\t\tevents.disconnect.fire()\n\t\t\t\t\n\t\t\t\tsocket.on 'message', (message) ->\n\t\t\t\t\treturn unless events.message[message]?\n\t\t\t\t\t\n\t\t\t\t\tevents.message[message].fire()\n\n**boolean onConnect(Function callback)**  \nAdds a new `callback` that will be called when a connection to nodePush is established and the\nuserID was exchanged. The given `callback` will be called once if a connection is established at\ntime of calling. Returns `true` on success and `false` otherwise.\n\n\t\t\tonConnect: (callback) ->\n\t\t\t\treturn false unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.connect.add callback\n\t\t\t\t\n\t\t\t\tcallback() if connected\n\t\t\t\ttrue\n\n**boolean onDisconnect(Function callback)**  \nAdds a new `callback` that will be called when the connection to nodePush is lost. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonDisconnect: (callback) ->\n\t\t\t\treturn false unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.disconnect.add callback\n\t\t\t\ttrue\n\n**boolean onMessage(string message, Function callback)**  \nAdds a new `callback` that will be called when the specified `message` is received. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonMessage: (message, callback) ->\n\t\t\t\treturn false unless $.isFunction callback\n\t\t\t\treturn false unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test message\n\t\t\t\t\n\t\t\t\tevents.message[message] ?= $.Callbacks()\n\t\t\t\tevents.message[message].add callback\n\t\t\t\ttrue\n\t\t\t\n\t)(jQuery, @)\n","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"e29979e52af64770ef37591bcd5f53c56dc5bdd7","subject":"reindented lists","message":"reindented lists\n","repos":"nhz-io\/cnl","old_file":"source\/element.litcoffee","new_file":"source\/element.litcoffee","new_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\nA visual element. Manages **mousemove**, **mousedown** and **mouseup** events.\nManages **regions** and **local event coordinates**.\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element(args)\n\nCreates an Element instance.\n\n      constructor: ->\n        super\n\nCopy the element origin if it was set from named arguments\n\n        if @origin then @origin = x:(@origin.x or 0), y:(@origin.y or 0)\n\nCopy the element regions if they were set from named arguments\n\n        if regions = @regions\n          @regions = {}\n          @regions[name] = region for name, region of regions\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nAdd capturing extendable listener\n\n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n\n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args**\n    * Type: [Object][Object] - named arguments\n\n* **args.origin**\n    * Type: [Object][Object] - origin coordinates\n\n* **args.origin.x**\n    * Type: [Number][Number] - x coordinate\n\n* **args.origin.y**\n    * Type: [Number][Number] - y coordinate\n\n* **args.regions** - named regions\n    * Type: [Object][Object]\n\n* **args.regions.{NAME}**\n    * Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## PROPERTIES\n\n### #origin\n* Type: [Object][Object] - origin coordinates\n* **x**\n  * Type: [Number][Number] - x coordinate\n* **y**\n  * Type: [Number][Number] - y coordinate\n\n### #regions\n* Type: [Object][Object] - region name\/value pairs\n* **{REGION NAME}**\n    * Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## METHODS\n### #localizeEventCoordinates(event) ->\n* Returns: [Element][Element]\n\nHelper method, to localize event coordinates.\n\n      localizeEventCoordinates: (event) ->\n        if event\n\nIf event already has localized **x**, use it instead of absolute **x**\n\n          x = (if event.localX? then event.localX else event.x)\n          event.localX = x - (@origin?.x or 0)\n\nIf event already has localized **y**, use it instead of absolute **y**\n\n          y = (if event.localY? then event.localY else event.y)\n          event.localY = y - (@origin?.y or 0)\n\n        return this\n---\n\n### #getEventRegions(event)\n* Returns: [Object][Object] - named set of matching regions\n\nHelper method, to get element regions that match the event.\n\n      getEventRegions: (event) ->\n        result = null\n\nProceed only if event coordinates are localized\n\n        if event and (x = event.localX)? and (y = event.localY)?\n\nWalk through the element regions\n\n          for name, $ of @regions\n\nand add the region to the result if event localized coordinates are within\nthe region rectangle.\n\n            if $[0] <= x <= ($[0] + $[2]) and $[1] <= y <= ($[1] + $[3])\n\nInitialize result only if at least one region matches\n\n              result or= {}\n              result[name] = $\n\n        return result\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousemove** listener\n\n      mousemoveCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousemoveEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousedown** listener\n\n      mousedownCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousedownEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mouseup** listener\n\n      mouseupCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mouseupEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousemoveListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousemoveListener: -> this\n\n---\n\n### #mousedownListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousedownListener: -> this\n\n---\n\n### #mouseupListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mouseupListener: -> this\n\n[Element]: .\/element\n\n[Parent]: .\/index.litcoffee\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n[Number]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Number\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[Array]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Array\n","old_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\nA visual element. Manages **mousemove**, **mousedown** and **mouseup** events.\nManages **regions** and **local event coordinates**.\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element(args)\n\nCreates an Element instance.\n\n      constructor: ->\n        super\n\nCopy the element origin if it was set from named arguments\n\n        if @origin then @origin = x:(@origin.x or 0), y:(@origin.y or 0)\n\nCopy the element regions if they were set from named arguments\n\n        if regions = @regions\n          @regions = {}\n          @regions[name] = region for name, region of regions\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nAdd capturing extendable listener\n\n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n\n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args**\n* Type: [Object][Object] - named arguments\n\n* **args.origin**\n* Type: [Object][Object] - origin coordinates\n\n* **args.origin.x**\n* Type: [Number][Number] - x coordinate\n\n* **args.origin.y**\n* Type: [Number][Number] - y coordinate\n\n* **args.regions** - named regions\n* Type: [Object][Object]\n\n* **args.regions.{NAME}**\n* Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## PROPERTIES\n\n### #origin\n* Type: [Object][Object] - origin coordinates\n    * **x**\n      * Type: [Number][Number] - x coordinate\n    * **y**\n      * Type: [Number][Number] - y coordinate\n\n### #regions\n* Type: [Object][Object]\n    * **{NAME}**\n    * Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## METHODS\n### #localizeEventCoordinates(event) ->\n* Returns: [Element][Element]\n\nHelper method, to localize event coordinates.\n\n      localizeEventCoordinates: (event) ->\n        if event\n\nIf event already has localized **x**, use it instead of absolute **x**\n\n          x = (if event.localX? then event.localX else event.x)\n          event.localX = x - (@origin?.x or 0)\n\nIf event already has localized **y**, use it instead of absolute **y**\n\n          y = (if event.localY? then event.localY else event.y)\n          event.localY = y - (@origin?.y or 0)\n\n        return this\n---\n\n### #getEventRegions(event)\n* Returns: [Object][Object] - named set of matching regions\n\nHelper method, to get element regions that match the event.\n\n      getEventRegions: (event) ->\n        result = null\n\nProceed only if event coordinates are localized\n\n        if event and (x = event.localX)? and (y = event.localY)?\n\nWalk through the element regions\n\n          for name, $ of @regions\n\nand add the region to the result if event localized coordinates are within\nthe region rectangle.\n\n            if $[0] <= x <= ($[0] + $[2]) and $[1] <= y <= ($[1] + $[3])\n\nInitialize result only if at least one region matches\n\n              result or= {}\n              result[name] = $\n\n        return result\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousemove** listener\n\n      mousemoveCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousemoveEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousedown** listener\n\n      mousedownCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousedownEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mouseup** listener\n\n      mouseupCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mouseupEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousemoveListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousemoveListener: -> this\n\n---\n\n### #mousedownListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousedownListener: -> this\n\n---\n\n### #mouseupListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mouseupListener: -> this\n\n[Element]: .\/element\n\n[Parent]: .\/index.litcoffee\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n[Number]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Number\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[Array]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Array\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ddf7bf2d5f911878db004bb0a6759114e92ea8d5","subject":"Optimize code","message":"Optimize code\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/js\/be.bastelstu.wcf.nodePush.litcoffee","new_file":"file\/js\/be.bastelstu.wcf.nodePush.litcoffee","new_contents":"Frontend JavaScript for nodePush\n================================\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\nEnsure sane values for `$` and `window`\n\n\t(($, window) ->\n\t\t# Enable strict mode\n\t\t\"use strict\";\n\t\t\n\t\t# Ensure our namespace is present\n\t\twindow.be ?= {}\n\t\tbe.bastelstu ?= {}\n\t\tbe.bastelstu.wcf ?= {}\n\nOverwrite `console` to add the origin in front of the message\n\n\t\tconsole =\n\t\t\tlog: (message) ->\n\t\t\t\twindow.console.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\twarn: (message) ->\n\t\t\t\twindow.console.warn \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\terror: (message) ->\n\t\t\t\twindow.console.error \"[be.bastelstu.wcf.nodePush] #{message}\"\n\nbe.bastelstu.Chat\n=================\n\nPrivate Attributes\n------------------\n\n\t\tsocket = null\n\t\tconnected = false\n\t\tinitialized = false\n\t\tevents =\n\t\t\tconnect: $.Callbacks()\n\t\t\tdisconnect: $.Callbacks()\n\t\t\tmessage: { }\n\t\t\n\t\tbe.bastelstu.wcf.nodePush = \n\nMethods\n-------\n\n**init(host)**  \nInitialize socket.io to enable nodePush.\n\n\t\t\tinit: (host) ->\n\t\t\t\treturn if initialized\n\t\t\t\tinitialized = true\n\t\t\t\tconsole.log 'Initializing nodePush'\n\t\t\t\t\n\t\t\t\tunless window.io?\n\t\t\t\t\tconsole.error 'nodePush not available, aborting'\n\t\t\t\t\treturn\n\t\t\t\t\t\n\t\t\t\tsocket = window.io.connect host\n\t\t\t\t\n\t\t\t\tsocket.on 'connect', ->\n\t\t\t\t\tconnected = true\n\t\t\t\t\tconsole.log 'Connected to nodePush'\n\t\t\t\t\tevents.connect.fire()\n\t\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', ->\n\t\t\t\t\tconnected = false\n\t\t\t\t\tconsole.warn 'Lost connection to nodePush'\n\t\t\t\t\tevents.disconnect.fire()\n\t\t\t\t\n\t\t\t\tsocket.on 'message', (message) ->\n\t\t\t\t\treturn unless events.message[message]?\n\t\t\t\t\t\n\t\t\t\t\tevents.message[message].fire()\n\n**onConnect(callback)**  \nAdds a new `callback` that will be called when a connection to nodePush is established. The given \n`callback` will be called once if a connection is established at time of calling. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonConnect: (callback) ->\n\t\t\t\treturn false unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.connect.add callback\n\t\t\t\t\n\t\t\t\tcallback() if connected\n\t\t\t\ttrue\n\n**onDisconnect(callback)**  \nAdds a new `callback` that will be called when the connection to nodePush is lost. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonDisconnect: (callback) ->\n\t\t\t\treturn false unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.disconnect.add callback\n\t\t\t\ttrue\n\n**onMessage(message, callback)**  \nAdds a new `callback` that will be called when the specified `message` is received. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonMessage: (message, callback) ->\n\t\t\t\tfalse unless $.isFunction callback\n\t\t\t\tfalse unless \/[a-zA-Z0-9-_.]+$\/.test message\n\t\t\t\t\n\t\t\t\tevents.message[message] ?= $.Callbacks()\n\t\t\t\tevents.message[message].add callback\n\t\t\t\ttrue\n\t\t\t\n\t)(jQuery, @)\n","old_contents":"Frontend JavaScript for nodePush\n================================\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\nEnsure sane values for `$` and `window`\n\n\t(($, window) ->\n\t\t# Enable strict mode\n\t\t\"use strict\";\n\t\t\n\t\t# Ensure our namespace is present\n\t\twindow.be ?= {}\n\t\tbe.bastelstu ?= {}\n\t\tbe.bastelstu.wcf ?= {}\n\nOverwrite `console` to add the origin in front of the message\n\n\t\tconsole =\n\t\t\tlog: (message) ->\n\t\t\t\twindow.console.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\twarn: (message) ->\n\t\t\t\twindow.console.warn \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\terror: (message) ->\n\t\t\t\twindow.console.error \"[be.bastelstu.wcf.nodePush] #{message}\"\n\nbe.bastelstu.Chat\n=================\n\nPrivate Attributes\n------------------\n\n\t\tsocket = null\n\t\tconnected = false\n\t\tinitialized = false\n\t\tevents =\n\t\t\tconnect: $.Callbacks()\n\t\t\tdisconnect: $.Callbacks()\n\t\t\tmessage: { }\n\t\t\n\t\tbe.bastelstu.wcf.nodePush = \n\nMethods\n-------\n\n**init(host)**  \nInitialize socket.io to enable nodePush.\n\n\t\t\tinit: (host) ->\n\t\t\t\treturn if initialized\n\t\t\t\tinitialized = true\n\t\t\t\tconsole.log 'Initializing nodePush'\n\t\t\t\t\n\t\t\t\tunless window.io?\n\t\t\t\t\tconsole.error 'nodePush not available, aborting'\n\t\t\t\t\treturn\n\t\t\t\t\t\n\t\t\t\tsocket = window.io.connect host\n\t\t\t\t\n\t\t\t\tsocket.on 'connect', =>\n\t\t\t\t\tconnected = true\n\t\t\t\t\tconsole.log 'Connected to nodePush'\n\t\t\t\t\tevents.connect.fire()\n\t\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\tconnected = false\n\t\t\t\t\tconsole.warn 'Lost connection to nodePush'\n\t\t\t\t\tevents.disconnect.fire()\n\t\t\t\t\n\t\t\t\tsocket.on 'message', (message) =>\n\t\t\t\t\treturn unless events.message[message]?\n\t\t\t\t\t\n\t\t\t\t\tevents.message[message].fire()\n\n**onConnect(callback)**  \nAdds a new `callback` that will be called when a connection to nodePush is established. The given \n`callback` will be called once if a connection is established at time of calling. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonConnect: (callback) ->\n\t\t\t\treturn false unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.connect.add callback\n\t\t\t\t\n\t\t\t\tcallback() if connected\n\t\t\t\ttrue\n\n**onDisconnect(callback)**  \nAdds a new `callback` that will be called when the connection to nodePush is lost. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonDisconnect: (callback) ->\n\t\t\t\treturn false unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.disconnect.add callback\n\t\t\t\ttrue\n\n**onMessage(message, callback)**  \nAdds a new `callback` that will be called when the specified `message` is received. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonMessage: (message, callback) ->\n\t\t\t\tfalse unless $.isFunction callback\n\t\t\t\tfalse unless \/[a-zA-Z0-9-_.]+$\/.test message\n\t\t\t\t\n\t\t\t\tevents.message[message] ?= $.Callbacks()\n\t\t\t\tevents.message[message].add callback\n\t\t\t\ttrue\n\t\t\t\n\t)(jQuery, @)\n","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"7596e4638f7efa02efbc85ddf0f1708dd2e4be2d","subject":"controller document 'false' and '@render' in beforeAction","message":"controller document 'false' and '@render' in beforeAction\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/09_controller.litcoffee","new_file":"docs\/09_controller.litcoffee","new_contents":"# Batman.Controller\n\n`Batman.Controller` is the base class from which all an application's controllers should descend from. `Batman.Controller`s are responsible for executing _actions_ which fire off requests for model data, render views, or redirect to other actions in response to navigation state changes.\n\n## Controller Directory\n\n`Batman.Controller`s are singletons which means each controller in your application is instantiated exactly once. The instance of each controller is available on the class at the `@sharedController` property, or within a `ControllerDirectory` on the `Application` class. See `Batman.Application.controllers`.\n\n## Actions\n\nEach `Batman.Controller` should have a number of instance level functions which can fetch the data needed and often render a view (or views) to display that data. These functions can be declared in typical CoffeeScript fashion like so:\n\n```example\n  class Alfred extends Batman.App\n    @root \"todos#index\"\n\n  class Alfred.TodosController extends Batman.Controller\n    index: (params) ->\n    show: (params) ->\n```\n\nEach action function receives the parameters from the dispatcher which are pulled out of the navigated-to URL. This includes both named route parameters (`\/:foo` style) as well as arbitrary query parameters (`?foo=bar` style).\n\n## routingKey and Minification\n\nFor functionality like contextual redirects and automatic view source and class inference, Batman needs to know the name of all your `Controller` subclasses. The usual way to do this is by using `Function::name` which Batman will use in development, but this is often mangled in minified production environments. For this reason, Batman will error out on boot if a `Controller` subclass' `routingKey` is not defined on the prototype. The `routingKey` is a `String` which remains unmangled after minification and thus allows Batman to continue using the aforementioned features. To disable this requirement (if you know your code won't ever be minified), set `Batman.config.minificationErrors` to false.\n\n## ::render([options : [Object|boolean]])\n\n`render` is used to control the rendering of the currently executed action. Passing `false` will prevent the current action from implicitly rendering the view. Passing an `options` object allows the default `view`, `source`, `viewClass` or `yield` block to be overridden, all of which are optional. If no parameters are passed to options, it will manually trigger the render function, rather than waiting for it to be implicitly called at the end of the action.\n\n_Note_: For more information on yield blocks, see Controller::.defaultRenderYield\n\n    class TestController extends Batman.Controller\n      routingKey: 'test'\n\n      nonVisibleAction: ->\n        @render(false)\n\n      customSource: ->\n        @render(source: 'errors\/404')\n\n      customYield: ->\n        @render(into: 'not-main')\n\n      delayedRender: ->\n        setTimeout (-> @render()), 1000\n        @render(false)\n\n## @beforeAction([options : [string|Object],] filter : [string|Function])\n\n`@beforeAction` allows controllers to declare that a function should be executed before the body of an action during action execution. `@beforeAction` optionally accepts some options representing which action(s) to execute the filter before, and then a string naming a function or function proper to execute.\n\nThe `options` argument can take three forms to imply different things:\n\n 1. `undefined`: implies that this filter function should be executed before all actions.\n 2. a String: implies that this filter function should be executed before the action named by the string.\n 3. an Object: implies that this filter function should be executed before the actions named by an Array at the `only` key in the options object, or before all actions excluding those named by an Array at the `except` key in the options object.\n\nIf any `beforeAction` filter returns `false` or calls [`@redirect`](\/docs\/api\/batman.controller.html#prototype_function_redirect), the controller action won't be executed.\n\n    test \"@beforeAction allows declaration of filters to execute before an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n    test \"@beforeAction allows declaration of named filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"show\", \"fetchTodo\"\n        fetchTodo: -> @set(\"todo\", {isDone: true})\n        show: ->\n          @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n\n    test \"@beforeAction allows whitelisting or blacklisting filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: [\"show\", \"edit\"], \"fetchTodo\"\n        @beforeAction except: [\"index\"], \"prepareNewTodo\"\n        fetchTodo: -> @set \"todo\", {isDone: true}\n        prepareNewTodo: -> @set \"newTodo\", {isDone: false}\n        index: -> @render false\n        show: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n      deepEqual controller.get(\"newTodo\"), {isDone: false}\n\n    test \"@beforeAction allows declaration of filters to execute before all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n## @afterAction([options : [string|Object],] filter : [string|Function])\n\n`@afterAction` allows controllers to declare that a function should be run after the action body and all operations have completed during action execution. Functions declared by `@afterAction` will thus be run after the code of the action body and also after any redirects or renders have taken place and completed. `@afterAction` optionally accepts some options representing which action(s) to execute the filter after, and then a string naming a function or function proper to execute. See `Batman.Controller.beforeAction` for documentation on the structure of the options.\n\n    test \"@afterAction allows declaration of filters to execute after an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n    test \"@afterAction allows declaration of named filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"create\", \"notify\"\n        notify: -> result = \"Todo created successfully.\"\n        create: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows whitelisting or blacklisting filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: [\"create\", \"update\"], \"notify\"\n        index: -> @render false\n        create: -> @render false\n        notify: -> result = \"Todo created successfully.\"\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal result, null\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows declaration of filters to execute after all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n## ::executeAction(action: string[, params: Object])\n\n`executeAction` will run the `action` specified, running all `@beforeAction` and `@afterAction` filters that match that endpoint. Optionally, `params` can be passed into the new action for processing. If no params are passed, it will default to the params of the current action.\n\n    test \"executeAction will run the called action\", ->\n      result = null\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        show: (params) ->\n          result = params.id\n          @render false\n        other: ->\n          @executeAction(\"show\", {id: 4})\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      equal result, 4\n\n    test \"executeAction will run all @beforeAction and @afterAction filters\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n        other: ->\n          @executeAction(\"index\")\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      deepEqual results, [\"before!\", \"action!\", \"after!\"]\n\n## ::redirect(url: string)\n\n`redirect` will forward the user to a new route defined by `url` without hard-refreshing the page. This modifies the current page URL using pushState if supported, otherwise falling back to hash-bang fragment identifiers. The url can be obtained dynamically using `MyApp.get('routes').myResourceName().path()` or by manually passing a string, such as `@redirect('\/test')`.\n\n## ::scrollToHash([hash: string])\n\n`scrollToHash` emulates the native scrolling behaviour of the browser by allowing the URL to link to a specific ID on the page. The code will look for an element with a matching ID to `hash` if it is provided otherwise using the `#` parameter in the URL. If an element is found, the page will scroll to the matching element.\n\n## ::.autoScrollToHash[= true] : boolean\n\n`autoScrollToHash` is a boolean property on the instance level of a controller describing whether or not the controller should automatically scroll the browser window to the element with ID equal to the `hash` parameter. This behaviour emulates the native behaviour of the same nature, but is implemented in Batman so the functionality works after each dispatch (instead of each page refresh) and when Batman is using hash bang routing. `autoScrollToHash` is true by default.\n\n## ::.defaultRenderYield[= 'main'] : string\n\n`defaultRenderYield` is a `string` representing which yield a controller should automatically render into if no yield is mentioned explicitly. `defaultRenderYield` is `'main'` normally, which means calls to `@render()` or actions which rely on the implicit rendering render their views into the `main` yield (and end up wherever `data-yield=\"main\"` is found in your HTML).\n","old_contents":"# Batman.Controller\n\n`Batman.Controller` is the base class from which all an application's controllers should descend from. `Batman.Controller`s are responsible for executing _actions_ which fire off requests for model data, render views, or redirect to other actions in response to navigation state changes.\n\n## Controller Directory\n\n`Batman.Controller`s are singletons which means each controller in your application is instantiated exactly once. The instance of each controller is available on the class at the `@sharedController` property, or within a `ControllerDirectory` on the `Application` class. See `Batman.Application.controllers`.\n\n## Actions\n\nEach `Batman.Controller` should have a number of instance level functions which can fetch the data needed and often render a view (or views) to display that data. These functions can be declared in typical CoffeeScript fashion like so:\n\n```example\n  class Alfred extends Batman.App\n    @root \"todos#index\"\n\n  class Alfred.TodosController extends Batman.Controller\n    index: (params) ->\n    show: (params) ->\n```\n\nEach action function receives the parameters from the dispatcher which are pulled out of the navigated-to URL. This includes both named route parameters (`\/:foo` style) as well as arbitrary query parameters (`?foo=bar` style).\n\n## routingKey and Minification\n\nFor functionality like contextual redirects and automatic view source and class inference, Batman needs to know the name of all your `Controller` subclasses. The usual way to do this is by using `Function::name` which Batman will use in development, but this is often mangled in minified production environments. For this reason, Batman will error out on boot if a `Controller` subclass' `routingKey` is not defined on the prototype. The `routingKey` is a `String` which remains unmangled after minification and thus allows Batman to continue using the aforementioned features. To disable this requirement (if you know your code won't ever be minified), set `Batman.config.minificationErrors` to false.\n\n## ::render([options : [Object|boolean]])\n\n`render` is used to control the rendering of the currently executed action. Passing `false` will prevent the current action from implicitly rendering the view. Passing an `options` object allows the default `view`, `source`, `viewClass` or `yield` block to be overridden, all of which are optional. If no parameters are passed to options, it will manually trigger the render function, rather than waiting for it to be implicitly called at the end of the action.\n\n_Note_: For more information on yield blocks, see Controller::.defaultRenderYield\n\n    class TestController extends Batman.Controller\n      routingKey: 'test'\n\n      nonVisibleAction: ->\n        @render(false)\n\n      customSource: ->\n        @render(source: 'errors\/404')\n\n      customYield: ->\n        @render(into: 'not-main')\n\n      delayedRender: ->\n        setTimeout (-> @render()), 1000\n        @render(false)\n\n## @beforeAction([options : [string|Object],] filter : [string|Function])\n\n`@beforeAction` allows controllers to declare that a function should be executed before the body of an action during action execution. `@beforeAction` optionally accepts some options representing which action(s) to execute the filter before, and then a string naming a function or function proper to execute.\n\nThe `options` argument can take three forms to imply different things:\n\n 1. `undefined`: implies that this filter function should be executed before all actions.\n 2. a String: implies that this filter function should be executed before the action named by the string.\n 3. an Object: implies that this filter function should be executed before the actions named by an Array at the `only` key in the options object, or before all actions excluding those named by an Array at the `except` key in the options object.\n\n  \n\n    test \"@beforeAction allows declaration of filters to execute before an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n    test \"@beforeAction allows declaration of named filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"show\", \"fetchTodo\"\n        fetchTodo: -> @set(\"todo\", {isDone: true})\n        show: ->\n          @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n\n    test \"@beforeAction allows whitelisting or blacklisting filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: [\"show\", \"edit\"], \"fetchTodo\"\n        @beforeAction except: [\"index\"], \"prepareNewTodo\"\n        fetchTodo: -> @set \"todo\", {isDone: true}\n        prepareNewTodo: -> @set \"newTodo\", {isDone: false}\n        index: -> @render false\n        show: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n      deepEqual controller.get(\"newTodo\"), {isDone: false}\n\n    test \"@beforeAction allows declaration of filters to execute before all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n## @afterAction([options : [string|Object],] filter : [string|Function])\n\n`@afterAction` allows controllers to declare that a function should be run after the action body and all operations have completed during action execution. Functions declared by `@afterAction` will thus be run after the code of the action body and also after any redirects or renders have taken place and completed. `@afterAction` optionally accepts some options representing which action(s) to execute the filter after, and then a string naming a function or function proper to execute. See `Batman.Controller.beforeAction` for documentation on the structure of the options.\n\n    test \"@afterAction allows declaration of filters to execute after an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n    test \"@afterAction allows declaration of named filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"create\", \"notify\"\n        notify: -> result = \"Todo created successfully.\"\n        create: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows whitelisting or blacklisting filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: [\"create\", \"update\"], \"notify\"\n        index: -> @render false\n        create: -> @render false\n        notify: -> result = \"Todo created successfully.\"\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal result, null\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows declaration of filters to execute after all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n## ::executeAction(action: string[, params: Object])\n\n`executeAction` will run the `action` specified, running all `@beforeAction` and `@afterAction` filters that match that endpoint. Optionally, `params` can be passed into the new action for processing. If no params are passed, it will default to the params of the current action.\n\n    test \"executeAction will run the called action\", ->\n      result = null\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        show: (params) ->\n          result = params.id\n          @render false\n        other: ->\n          @executeAction(\"show\", {id: 4})\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      equal result, 4\n\n    test \"executeAction will run all @beforeAction and @afterAction filters\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n        other: ->\n          @executeAction(\"index\")\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      deepEqual results, [\"before!\", \"action!\", \"after!\"]\n\n## ::redirect(url: string)\n\n`redirect` will forward the user to a new route defined by `url` without hard-refreshing the page. This modifies the current page URL using pushState if supported, otherwise falling back to hash-bang fragment identifiers. The url can be obtained dynamically using `MyApp.get('routes').myResourceName().path()` or by manually passing a string, such as `@redirect('\/test')`.\n\n## ::scrollToHash([hash: string])\n\n`scrollToHash` emulates the native scrolling behaviour of the browser by allowing the URL to link to a specific ID on the page. The code will look for an element with a matching ID to `hash` if it is provided otherwise using the `#` parameter in the URL. If an element is found, the page will scroll to the matching element.\n\n## ::.autoScrollToHash[= true] : boolean\n\n`autoScrollToHash` is a boolean property on the instance level of a controller describing whether or not the controller should automatically scroll the browser window to the element with ID equal to the `hash` parameter. This behaviour emulates the native behaviour of the same nature, but is implemented in Batman so the functionality works after each dispatch (instead of each page refresh) and when Batman is using hash bang routing. `autoScrollToHash` is true by default.\n\n## ::.defaultRenderYield[= 'main'] : string\n\n`defaultRenderYield` is a `string` representing which yield a controller should automatically render into if no yield is mentioned explicitly. `defaultRenderYield` is `'main'` normally, which means calls to `@render()` or actions which rely on the implicit rendering render their views into the `main` yield (and end up wherever `data-yield=\"main\"` is found in your HTML).\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a65b098c8aeb52c6568be8d005efa86fc7c05666","subject":"classList for svg","message":"classList for svg\n","repos":"vpj\/weya,vpj\/weya","old_file":"weya.litcoffee","new_file":"weya.litcoffee","new_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: []\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = [c]\n        else\n         res.class.push c\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        elem.id = idClass.id\n       if idClass.class?\n        if elem.classList?\n         for c in idClass.class\n          elem.classList.add c\n        else #For older browsers; does not work with svgs\n         className = ''\n         for c in idClass.class\n          className += ' ' if className isnt ''\n          className += \"#{c}\"\n         elem.className = className\n\n      if attrs?\n       setAttributes elem, attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if contentFunction?\n       contentFunction.call @\n      else if contentText?\n       elem.textContent = contentText\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call @, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: null\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = c\n        else\n         res.class += \" #{c}\"\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        buf.push \" id=\\\"#{idClass.id}\\\"\"\n       if idClass.class?\n        buf.push \" class=\\\"#{idClass.class}\\\"\"\n\n      if attrs?\n       setAttributes buf, attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if contentFunction?\n       contentFunction.call @\n      else if contentText?\n       setIndent buf, @_indent\n       buf.push contentText\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call @, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","old_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: []\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = [c]\n        else\n         res.class.push c\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        elem.id = idClass.id\n       if idClass.class?\n        className = ''\n        for c in idClass.class\n         className += ' ' if className isnt ''\n         className += \"#{c}\"\n        elem.className = className\n\n      if attrs?\n       setAttributes elem, attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if contentFunction?\n       contentFunction.call @\n      else if contentText?\n       elem.textContent = contentText\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call @, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: null\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = c\n        else\n         res.class += \" #{c}\"\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        buf.push \" id=\\\"#{idClass.id}\\\"\"\n       if idClass.class?\n        buf.push \" class=\\\"#{idClass.class}\\\"\"\n\n      if attrs?\n       setAttributes buf, attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if contentFunction?\n       contentFunction.call @\n      else if contentText?\n       setIndent buf, @_indent\n       buf.push contentText\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call @, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"13e872ad25ad8bfa8409da95110493dca1c91189","subject":"Live reload","message":"Live reload\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-skin-strapped\/index.litcoffee","new_file":"packages\/shrub-skin-strapped\/index.litcoffee","new_contents":"# Strapped\n\n*Shrub's default skin.*\n\n    path = require 'path'\n\n    shrubSkin = require 'shrub-skin'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubNodemailerHtml`.\n\n      registrar.registerHook 'shrubNodemailerHtml', ($body, html, $) ->\n\n        $('.container > .main', $body).html html\n\n        $body.find('.navbar-toggle, .navbar-collapse').remove()\n        $body.find('[data-shrub-ui-messages]').remove()\n\n        $body.find('script').remove()\n\n        $('noscript', $body).remove()\n\n#### Implements hook `shrubSkinAssets`.\n\n      registrar.registerHook 'shrubSkinAssets', (assets) ->\n\nAdd our future-compiled LESS style sheets.\n\n        assets.styleSheets.default.push '\/css\/style.css'\n        assets.styleSheets.production.push '\/css\/style.css'\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig) ->\n\n        gruntConfig.less ?= {}\n\n        shrubSkin.gruntSkin gruntConfig, 'shrub-skin-strapped'\n\n        gruntConfig.configureTask 'less', 'shrub-skin-strapped', files: [\n          src: [\n            \"#{__dirname}\/app\/less\/style.less\"\n          ]\n          dest: 'app\/skin\/shrub-skin-strapped\/css\/style.css'\n        ]\n\n        gruntConfig.configureTask(\n          'watch', 'shrub-skin-strappedLess'\n\n          files: [\n            \"#{__dirname}\/app\/less\/style.less\"\n          ]\n          tasks: [\n            'newer:less:shrub-skin-strapped'\n          ]\n          options: livereload: true\n        )\n\n        gruntConfig.registerTask 'build:shrub-skin-strapped', [\n          'clean:shrub-skin-strapped'\n          'newer:copy:shrub-skin-strapped'\n          'less:shrub-skin-strapped'\n        ]\n\n        gruntConfig.registerTask 'build', ['build:shrub-skin-strapped']\n\n        gruntConfig.loadNpmTasks ['grunt-contrib-less']\n","old_contents":"# Strapped\n\n*Shrub's default skin.*\n\n    path = require 'path'\n\n    shrubSkin = require 'shrub-skin'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubNodemailerHtml`.\n\n      registrar.registerHook 'shrubNodemailerHtml', ($body, html, $) ->\n\n        $('.container > .main', $body).html html\n\n        $body.find('.navbar-toggle, .navbar-collapse').remove()\n        $body.find('[data-shrub-ui-messages]').remove()\n\n        $body.find('script').remove()\n\n        $('noscript', $body).remove()\n\n#### Implements hook `shrubSkinAssets`.\n\n      registrar.registerHook 'shrubSkinAssets', (assets) ->\n\nAdd our future-compiled LESS style sheets.\n\n        assets.styleSheets.default.push '\/css\/style.css'\n        assets.styleSheets.production.push '\/css\/style.css'\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig) ->\n\n        gruntConfig.less ?= {}\n\n        shrubSkin.gruntSkin gruntConfig, 'shrub-skin-strapped'\n\n        gruntConfig.configureTask 'less', 'shrub-skin-strapped', files: [\n          src: [\n            \"#{__dirname}\/app\/less\/style.less\"\n          ]\n          dest: 'app\/skin\/shrub-skin-strapped\/css\/style.css'\n        ]\n\n        gruntConfig.configureTask(\n          'watch', 'shrub-skin-strappedLess'\n\n          files: [\n            \"#{__dirname}\/app\/less\/style.less\"\n          ]\n          tasks: [\n            'newer:less:shrub-skin-strapped'\n          ]\n        )\n\n        gruntConfig.registerTask 'build:shrub-skin-strapped', [\n          'clean:shrub-skin-strapped'\n          'newer:copy:shrub-skin-strapped'\n          'less:shrub-skin-strapped'\n        ]\n\n        gruntConfig.registerTask 'build', ['build:shrub-skin-strapped']\n\n        gruntConfig.loadNpmTasks ['grunt-contrib-less']\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ff150acfc66b4555710474e95886c6e285262c33","subject":"Set up MongoDB query","message":"Set up MongoDB query\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.usr}]\n\n### Fields\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        fields = {}\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\n      else\n        fields =\n          tilbyder: true\n          endret: true\n          status: true\n          lisens: true\n          navn: true\n          tags: true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower.\n\n      if typeof req.query.sort is 'string' and req.query.sort\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\nOnly apply default sort if there are no geospatial queries.\n\n      else\n        sort = 'endret' if not req.db.query.geojson\n\n### Execute\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(req.db.query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.usr}]\n\n### Fields\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        fields = {}\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\n      else\n        fields =\n          tilbyder: true\n          endret: true\n          status: true\n          lisens: true\n          navn: true\n          tags: true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower.\n\n      if typeof req.query.sort is 'string' and req.query.sort\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\nOnly apply default sort if there are no geospatial queries.\n\n      else\n        sort = 'endret' if not req.db.query.geojson\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9a731deb207e6fecc5a25480817f741e6b952826","subject":"Fix skin watching, and watch templates","message":"Fix skin watching, and watch templates\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-skin\/index.litcoffee","new_file":"packages\/shrub-skin\/index.litcoffee","new_contents":"# Skin\n\n*Allows the visual aspects of the site to be controlled by skin packages.*\n\n    fs = require 'fs'\n    path = require 'path'\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubConfigClient`.\n\n      registrar.registerHook 'shrubConfigClient', ->\n\n        skinAssets = {}\n        for packagePath in pkgman.packagesImplementing 'shrubSkinAssets'\n          skinAssets[packagePath] = exports.assets packagePath\n\n        default: config.get 'packageSettings:shrub-skin:default'\n        assets: skinAssets\n\n#### Implements hook `shrubHttpMiddleware`.\n\n      registrar.registerHook 'path', 'shrubHttpMiddleware', (http) ->\n\n        label: 'Skin path handling'\n        middleware: [\n\n          (req, res, next) ->\n\nIf we get here and it's a skin URL, it must be a 404 otherwise, express\/static\nwould have picked it up already.\n\n            return res.send 404 if req.path.match \/^\\\/skin\\\/\/\n\n            next()\n        ]\n\n#### Implements hook `shrubHttpMiddleware`.\n\n      registrar.registerHook 'render', 'shrubHttpMiddleware', (http) ->\n\n        label: 'Render skinned page HTML'\n        middleware: [\n\n          (req, res, next) ->\n\n            return exports.renderAppHtml().then((html) ->\n              req.delivery = html\n              next()\n            ).catch (error) -> next error\n\n      ]\n\n#### Implements hook `shrubConfigServer`.\n\n      registrar.registerHook 'shrubConfigServer', ->\n\nDefault skin.\n\n        default: 'shrub-skin-strapped'\n\n## activeKey\n\n*Get the active skin's key*\n\n    exports.activeKey = -> config.get 'packageSettings:shrub-skin:default'\n\n## gruntSkin\n\n*Helper function to copy skin assets. Configures a grunt task, e.g. if your\nskin is named `my-special-skin`, the configured task is named\n`my-special-skinCopy`. This is not automatically added to the build\ndependencies, you do it manually so you can control exactly when it happens.*\n\n    exports.gruntSkin = (gruntConfig, key) ->\n\n      skinPath = path.dirname require.resolve key\n\n      gruntConfig.clean ?= {}\n      gruntConfig.copy ?= {}\n      gruntConfig.watch ?= {}\n\n      gruntConfig.configureTask 'clean', key, [\n        \"app\/skin\/#{key}\"\n      ]\n\n      copyFiles = []\n\n      copyFiles.push(\n        expand: true\n        cwd: \"#{skinPath}\/app\"\n        src: [\"#{verbatim}\/**\/*\"]\n        dest: \"app\/skin\/#{key}\"\n      ) for verbatim in ['css', 'fonts', 'img', 'js', 'lib']\n\n      gruntConfig.configureTask 'copy', key, files: copyFiles\n\n      gruntConfig.configureTask(\n        'watch', \"#{key}Copy\"\n\n        files: copyFiles.concat(\n          src: \"template\/**\/*\"\n        ).map(\n          (copyFile) -> \"#{skinPath}\/app\/#{copyFile.src}\"\n        )\n        tasks: [\n          \"newer:copy:#{key}\"\n        ]\n        options: livereload: true\n      )\n\n## renderAppHtml\n\n*Render the application HTML.*\n\n    exports.renderAppHtml = ->\n\n      Promise = require 'bluebird'\n\n      cheerio = require 'cheerio'\n\n      assets = require 'shrub-assets'\n\n      skinKey = exports.activeKey()\n      skinDirectory = exports.skinDirectory skinKey\n\n      environmentKey = if 'production' is process.env.NODE_ENV\n        'production'\n      else\n        'default'\n\nRead the app HTML.\n\n      readFile = Promise.promisify fs.readFile, fs\n      readFile(\n        \"#{skinDirectory}\/app\/template\/app.html\", encoding: 'utf8'\n      ).then (html) ->\n\n        $ = cheerio.load html\n\n        pkgman.invoke 'skinRenderAppHtml', $\n\n        $head = $('head')\n        $body = $('body')\n\nInject the application-level assets first.\n\n        appAssets = assets.assets()\n\n        $head.append $('<link \/>').attr(\n          type: 'text\/css'\n          rel: 'styleSheet'\n          href: styleSheet\n        ) for styleSheet in appAssets.styleSheets\n\n        $body.append $('<script \/>').attr(\n          src: script\n        ) for script in appAssets.scripts\n\nInject the skin-level assets.\n\n        skinAssets = exports.assets skinKey\n\n        $head.append $('<link \/>').attr(\n          class: 'skin'\n          type: 'text\/css'\n          rel: 'stylesheet'\n          href: \"\/skin\/#{skinKey}\/#{styleSheet}\"\n        ) for styleSheet in skinAssets.styleSheets[environmentKey] ? []\n\n        $body.append $('<script \/>').attr(\n          class: 'skin'\n          src: \"\/skin\/#{skinKey}\/#{script}\"\n        ) for script in skinAssets.scripts[environmentKey] ? []\n\n        $.html()\n\n## skinDirectory\n\n* (String) `key` - The skin key.\n\n*Get the directory a skin lives within.*\n\n    exports.skinDirectory = (key) -> path.dirname require.resolve key\n\n## assets\n\n* (String) `key` - The skin key.\n\n*Get the assets for a skin.*\n\n###### TODO: This needs caching.\n\n    exports.assets = (skinKey) ->\n\n      glob = require 'simple-glob'\n      pkgman = require 'pkgman'\n\n      skinPath = path.dirname require.resolve skinKey\n      skinModule = require skinKey\n\nRead in all the templates.\n\n      templates = {}\n      for templatePath in glob cwd: \"#{skinPath}\/app\/template\", [\n        '**\/*.html', '!app.html'\n      ]\n\nStrip out most of the unnecessary whitespace.\n\n        templates[templatePath] = fs.readFileSync(\n          \"#{skinPath}\/app\/template\/#{templatePath}\"\n        ).toString('utf8').replace \/\\s+\/g, ' '\n\nAssets currently default to .js\/.css for default and .min.js and .min.css for\nproduction.\n\n      skinAssets =\n\n        templates: templates\n\n        scripts:\n\n          default: glob cwd: \"#{skinPath}\/app\", [\n            'js\/**\/*.js', '!js\/**\/*.min.js'\n          ]\n\n          production: glob cwd: \"#{skinPath}\/app\", [\n            'js\/**\/*.min.js'\n          ]\n\n        styleSheets:\n\n          default: glob cwd: \"#{skinPath}\/app\", [\n            'css\/**\/*.css', '!css\/**\/*.min.css'\n          ]\n\n          production: glob cwd: \"#{skinPath}\/app\", [\n            'css\/**\/*.min.css'\n          ]\n\n#### Invoke hook `shrubSkinAssets`.\n\n      pkgman.invokePackage skinKey, 'shrubSkinAssets', skinAssets\n\n      skinAssets\n","old_contents":"# Skin\n\n*Allows the visual aspects of the site to be controlled by skin packages.*\n\n    fs = require 'fs'\n    path = require 'path'\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubConfigClient`.\n\n      registrar.registerHook 'shrubConfigClient', ->\n\n        skinAssets = {}\n        for packagePath in pkgman.packagesImplementing 'shrubSkinAssets'\n          skinAssets[packagePath] = exports.assets packagePath\n\n        default: config.get 'packageSettings:shrub-skin:default'\n        assets: skinAssets\n\n#### Implements hook `shrubHttpMiddleware`.\n\n      registrar.registerHook 'path', 'shrubHttpMiddleware', (http) ->\n\n        label: 'Skin path handling'\n        middleware: [\n\n          (req, res, next) ->\n\nIf we get here and it's a skin URL, it must be a 404 otherwise, express\/static\nwould have picked it up already.\n\n            return res.send 404 if req.path.match \/^\\\/skin\\\/\/\n\n            next()\n        ]\n\n#### Implements hook `shrubHttpMiddleware`.\n\n      registrar.registerHook 'render', 'shrubHttpMiddleware', (http) ->\n\n        label: 'Render skinned page HTML'\n        middleware: [\n\n          (req, res, next) ->\n\n            return exports.renderAppHtml().then((html) ->\n              req.delivery = html\n              next()\n            ).catch (error) -> next error\n\n      ]\n\n#### Implements hook `shrubConfigServer`.\n\n      registrar.registerHook 'shrubConfigServer', ->\n\nDefault skin.\n\n        default: 'shrub-skin-strapped'\n\n## activeKey\n\n*Get the active skin's key*\n\n    exports.activeKey = -> config.get 'packageSettings:shrub-skin:default'\n\n## gruntSkin\n\n*Helper function to copy skin assets. Configures a grunt task, e.g. if your\nskin is named `my-special-skin`, the configured task is named\n`my-special-skinCopy`. This is not automatically added to the build\ndependencies, you do it manually so you can control exactly when it happens.*\n\n    exports.gruntSkin = (gruntConfig, key) ->\n\n      skinPath = path.dirname require.resolve key\n\n      gruntConfig.clean ?= {}\n      gruntConfig.copy ?= {}\n      gruntConfig.watch ?= {}\n\n      gruntConfig.configureTask 'clean', key, [\n        \"app\/skin\/#{key}\"\n      ]\n\n      copyFiles = []\n\n      copyFiles.push(\n        expand: true\n        cwd: \"#{skinPath}\/app\"\n        src: [\"#{verbatim}\/**\/*\"]\n        dest: \"app\/skin\/#{key}\"\n      ) for verbatim in ['css', 'fonts', 'img', 'js', 'lib']\n\n      gruntConfig.configureTask 'copy', key, files: copyFiles\n\n      gruntConfig.configureTask(\n        'watch', \"#{key}Copy\"\n\n        files: copyFiles.map((copyFile) -> copyFile.src).reduce(\n          ((l, r) -> l.concat r), []\n        )\n        tasks: [\n          \"newer:copy:#{key}\"\n        ]\n      )\n\n## renderAppHtml\n\n*Render the application HTML.*\n\n    exports.renderAppHtml = ->\n\n      Promise = require 'bluebird'\n\n      cheerio = require 'cheerio'\n\n      assets = require 'shrub-assets'\n\n      skinKey = exports.activeKey()\n      skinDirectory = exports.skinDirectory skinKey\n\n      environmentKey = if 'production' is process.env.NODE_ENV\n        'production'\n      else\n        'default'\n\nRead the app HTML.\n\n      readFile = Promise.promisify fs.readFile, fs\n      readFile(\n        \"#{skinDirectory}\/app\/template\/app.html\", encoding: 'utf8'\n      ).then (html) ->\n\n        $ = cheerio.load html\n\n        pkgman.invoke 'skinRenderAppHtml', $\n\n        $head = $('head')\n        $body = $('body')\n\nInject the application-level assets first.\n\n        appAssets = assets.assets()\n\n        $head.append $('<link \/>').attr(\n          type: 'text\/css'\n          rel: 'styleSheet'\n          href: styleSheet\n        ) for styleSheet in appAssets.styleSheets\n\n        $body.append $('<script \/>').attr(\n          src: script\n        ) for script in appAssets.scripts\n\nInject the skin-level assets.\n\n        skinAssets = exports.assets skinKey\n\n        $head.append $('<link \/>').attr(\n          class: 'skin'\n          type: 'text\/css'\n          rel: 'stylesheet'\n          href: \"\/skin\/#{skinKey}\/#{styleSheet}\"\n        ) for styleSheet in skinAssets.styleSheets[environmentKey] ? []\n\n        $body.append $('<script \/>').attr(\n          class: 'skin'\n          src: \"\/skin\/#{skinKey}\/#{script}\"\n        ) for script in skinAssets.scripts[environmentKey] ? []\n\n        $.html()\n\n## skinDirectory\n\n* (String) `key` - The skin key.\n\n*Get the directory a skin lives within.*\n\n    exports.skinDirectory = (key) -> path.dirname require.resolve key\n\n## assets\n\n* (String) `key` - The skin key.\n\n*Get the assets for a skin.*\n\n###### TODO: This needs caching.\n\n    exports.assets = (skinKey) ->\n\n      glob = require 'simple-glob'\n      pkgman = require 'pkgman'\n\n      skinPath = path.dirname require.resolve skinKey\n      skinModule = require skinKey\n\nRead in all the templates.\n\n      templates = {}\n      for templatePath in glob cwd: \"#{skinPath}\/app\/template\", [\n        '**\/*.html', '!app.html'\n      ]\n\nStrip out most of the unnecessary whitespace.\n\n        templates[templatePath] = fs.readFileSync(\n          \"#{skinPath}\/app\/template\/#{templatePath}\"\n        ).toString('utf8').replace \/\\s+\/g, ' '\n\nAssets currently default to .js\/.css for default and .min.js and .min.css for\nproduction.\n\n      skinAssets =\n\n        templates: templates\n\n        scripts:\n\n          default: glob cwd: \"#{skinPath}\/app\", [\n            'js\/**\/*.js', '!js\/**\/*.min.js'\n          ]\n\n          production: glob cwd: \"#{skinPath}\/app\", [\n            'js\/**\/*.min.js'\n          ]\n\n        styleSheets:\n\n          default: glob cwd: \"#{skinPath}\/app\", [\n            'css\/**\/*.css', '!css\/**\/*.min.css'\n          ]\n\n          production: glob cwd: \"#{skinPath}\/app\", [\n            'css\/**\/*.min.css'\n          ]\n\n#### Invoke hook `shrubSkinAssets`.\n\n      pkgman.invokePackage skinKey, 'shrubSkinAssets', skinAssets\n\n      skinAssets\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"df14af239eb34e3fa3351994d9084242190d82bb","subject":"Add note about handling unknown routes","message":"Add note about handling unknown routes\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08a_app_routing.litcoffee","new_file":"docs\/08a_app_routing.litcoffee","new_contents":"# \/api\/App Components\/Batman.App\/Batman.App Routing\n\nThe batman.js routing DSL is similar to the [Rails routing DSL](http:\/\/guides.rubyonrails.org\/routing.html). It is oriented around the notion of a resource.\n\n## Handling unknown routes\n\nWhen batman.js doesn't have a way to handle a route, it:\n\n- fires `\"error\"` on the running app, passing an object like:\n  ```javascript\n  {\n    type: \"404\"\n    isPrevented: false\n    preventDefault: -> @isPrevented = true\n  }\n  ```\n- if `error.isPrevented` isn't set to `true` by a handler, redirects to `\/404`\n\nSo, you can handle these in your App routing:\n\n```coffeescript\nclass MyApp extends Batman.App\n  # handle the event:\n  @on 'error', ->\n    if error.type is \"404\"\n      alert('Not Found!')\n      error.preventDefault()\n```\n\n__or:__\n\n```coffeescript\nclass MyApp extends Batman.App\n  # handle the redirect:\n  @route '\/404', (params) -> alert(\"Not found!\")\n```\n\n## @route\n\n`@route` defines a custom route and can be pointed to a controller action directly. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @route 'comments', 'pages#comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/comments` being added to the routing map, pointed to `PagesController#comments`.\n\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n`@resources` is modeled after the Rails routing `resources` method. It automatically defines some routes and matches them to controller actions. For example,\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages'\n\nclass App.PagesController extends Batman.Controller\n  index: ->\n    # ...\n  new: ->\n    # ...\n  show: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n  edit: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n```\n\nWill set up these routes:\n\nPath | Controller Action\n-- | -- |\n\/pages | App.PagesController#index\n\/pages\/new | App.PagesController#new\n\/pages\/:id | App.PagesController#show\n\/pages\/:id\/edit | App.PagesController#edit\n\nNote that unlike Rails, `destroy`, `update`, and `create` are not performed by controller actions in batman.js. Instead, call `save` or `destroy` on your records directly.\nTo access a generated route from within a view, use the [`data-route` binding](batman.view_bindings.html#data-route).\n\n### Nested Resources\n\nYou may also nest resources, as in Rails:\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages', ->\n    @resources 'comments'\n```\n\nWill set up these routes for `App.Comment`:\n\nPath | Controller Action\n-- | -- |\n\/pages\/:page_id\/comments | App.CommentsController#index\n\/pages\/:page_id\/comments\/new | App.CommentsController#new\n\/pages\/:page_id\/comments\/:id | App.CommentsController#show\n\/pages\/:page_id\/comments\/:id\/edit | App.CommentsController#edit\n\n\n## @member\n\n`@member` defines a routable action you can call on a specific instance of a member of a collection resource. For example, if you have a collection of `Page` resources, and a user can post a comment on a specific page:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @member 'comment'\n\nclass Example.PagesController extends Batman.Controller\n  comment: (params) ->\n```\n\nWould result in `\/pages\/:id\/comment` being added to the routing map, pointed to `PagesController#comment`.\n\n## @collection\n\n`@collection` is similar to `@member` in that it adds routable actions to a `@resources` set of routes. In this case the action would apply to the entire collection. For example, if you have a list of spam comments made across _all_ your `Page` resources:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @collection 'spam_comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/pages\/spam_comments` being added to the routing map, pointed to `PagesController#spam_comments`.\n\n## @root\n\n`@root` defines the root controller and action to be used when visiting the base application URL. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @root 'pages#index'\n\nclass Example.PagesController extends Batman.Controller\n  index: ->\n```\n\nWould result in `\/` being pointed to `PagesController#index`.\n","old_contents":"# \/api\/App Components\/Batman.App\/Batman.App Routing\n\nThe batman.js routing DSL is similar to the [Rails routing DSL](http:\/\/guides.rubyonrails.org\/routing.html). It is oriented around the notion of a resource:\n\n## @route\n\n`@route` defines a custom route and can be pointed to a controller action directly. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @route 'comments', 'pages#comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/comments` being added to the routing map, pointed to `PagesController#comments`.\n\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n`@resources` is modeled after the Rails routing `resources` method. It automatically defines some routes and matches them to controller actions. For example,\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages'\n\nclass App.PagesController extends Batman.Controller\n  index: ->\n    # ...\n  new: ->\n    # ...\n  show: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n  edit: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n```\n\nWill set up these routes:\n\nPath | Controller Action\n-- | -- |\n\/pages | App.PagesController#index\n\/pages\/new | App.PagesController#new\n\/pages\/:id | App.PagesController#show\n\/pages\/:id\/edit | App.PagesController#edit\n\nNote that unlike Rails, `destroy`, `update`, and `create` are not performed by controller actions in batman.js. Instead, call `save` or `destroy` on your records directly.\nTo access a generated route from within a view, use the [`data-route` binding](batman.view_bindings.html#data-route).\n\n### Nested Resources\n\nYou may also nest resources, as in Rails:\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages', ->\n    @resources 'comments'\n```\n\nWill set up these routes for `App.Comment`:\n\nPath | Controller Action\n-- | -- |\n\/pages\/:page_id\/comments | App.CommentsController#index\n\/pages\/:page_id\/comments\/new | App.CommentsController#new\n\/pages\/:page_id\/comments\/:id | App.CommentsController#show\n\/pages\/:page_id\/comments\/:id\/edit | App.CommentsController#edit\n\n\n## @member\n\n`@member` defines a routable action you can call on a specific instance of a member of a collection resource. For example, if you have a collection of `Page` resources, and a user can post a comment on a specific page:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @member 'comment'\n\nclass Example.PagesController extends Batman.Controller\n  comment: (params) ->\n```\n\nWould result in `\/pages\/:id\/comment` being added to the routing map, pointed to `PagesController#comment`.\n\n## @collection\n\n`@collection` is similar to `@member` in that it adds routable actions to a `@resources` set of routes. In this case the action would apply to the entire collection. For example, if you have a list of spam comments made across _all_ your `Page` resources:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @collection 'spam_comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/pages\/spam_comments` being added to the routing map, pointed to `PagesController#spam_comments`.\n\n## @root\n\n`@root` defines the root controller and action to be used when visiting the base application URL. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @root 'pages#index'\n\nclass Example.PagesController extends Batman.Controller\n  index: ->\n```\n\nWould result in `\/` being pointed to `PagesController#index`.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c782b23a0f837737c482d904947ad78fd2d5876b","subject":"weya base lint","message":"weya base lint\n","repos":"vpj\/weya,vpj\/weya","old_file":"base.litcoffee","new_file":"base.litcoffee","new_contents":"#Weya.Base.js\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n##Weya.Base\nIntroduces class level function initialize and include.\n\n    class Base\n     _initialize: []\n     on: {}\n\nExtend Events\n\n     @extend: ->\n      events = @::on\n      @::on = {}\n      @::on[k] = v for k, v of events\n\nAdd event listeners\n\n     @listen: (name, func) ->\n      @::on[name] = func\n\nGetter\n\n     @get: (name, func) ->\n      @::__defineGetter__ name, func\n\nSetter\n\n     @set: (name, func) ->\n      @::__defineSetter__ name, func\n\n     constructor: ->\n      @_init.apply this, arguments\n\n####Register initialize functions.\nAll initializer funcitons in subclasses will be called with the constructor\narguments.\n\n     @initialize: (func) ->\n      @::_initialize = @::_initialize.slice()\n      @::_initialize.push func\n\n     _init: ->\n      for init in @_initialize\n       init.apply this, arguments\n\n      return\n\n####Include objects.\nYou can include objects by registering them with @include. This tries to\nsolve the problem of single inheritence.\n\n     @include: (obj) ->\n      for k, v of obj\n       switch k\n        when 'initialize'\n         @::_initialize.push v\n        when 'on'\n         for event, listener of v\n          @::on[event] = listener\n        else\n         @::[k] = v\n\n     @initialize ->\n      events = @on\n      @on = {}\n      for k, v of events\n       @on[k] = v.bind this\n\n    Weya.Base = Base\n\n    if module?\n     module.exports = Weya.Base\n\n","old_contents":"#Weya.Base.js\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n##Weya.Base\nIntroduces class level function initialize and include.\n\n    class Base\n     _initialize: []\n     on: {}\n\nExtend Events\n\n     @extend: ->\n      events = @::on\n      @::on = {}\n      @::on[k] = v for k, v of events\n\nAdd event listeners\n\n     @listen: (name, func) ->\n      @::on[name] = func\n\nGetter\n\n     @get: (name, func) ->\n      @::__defineGetter__ name, func\n\nSetter\n\n     @set: (name, func) ->\n      @::__defineSetter__ name, func\n\n     constructor: ->\n      @_init.apply @, arguments\n\n####Register initialize functions.\nAll initializer funcitons in subclasses will be called with the constructor\narguments.\n\n     @initialize: (func) ->\n      @::_initialize = @::_initialize.slice()\n      @::_initialize.push func\n\n     _init: ->\n      for init in @_initialize\n       init.apply @, arguments\n\n      return\n\n####Include objects.\nYou can include objects by registering them with @include. This tries to\nsolve the problem of single inheritence.\n\n     @include: (obj) ->\n      for k, v of obj\n       switch k\n        when 'initialize'\n         @::_initialize.push v\n        when 'on'\n         for event, listener of v\n          @::on[event] = listener\n        else\n         @::[k] = v\n\n     @initialize ->\n      events = @on\n      @on = {}\n      for k, v of events\n       @on[k] = v.bind this\n\n    Weya.Base = Base\n\n    if module?\n     module.exports = Weya.Base\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2b2feba44bc732df14d861edcf14cf28a5538719","subject":"Fixed creating not run transition","message":"Fixed creating not run transition\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/renderer\/types\/extensions\/transition.litcoffee","new_file":"src\/renderer\/types\/extensions\/transition.litcoffee","new_contents":"# Transition\n\n```javascript\nRectangle {\n    width: 100; height: 100;\n    color: 'red'\n    pointer.onClick: function () {\n        this.x = Math.random() * 300;\n    }\n    Transition {\n        property: 'x'\n        animation: NumberAnimation {\n            duration: 1500\n        }\n    }\n}\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n    signal = require 'src\/signal'\n    log = require 'src\/log'\n\n    log = log.scope 'Renderer', 'Transition'\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Transition extends Renderer.Extension\n        @__name__ = 'Transition'\n\n## *Transition* Transition.New([*Object* options])\n\n        @New = (opts) ->\n            item = new Transition\n            itemUtils.Object.initialize item, opts\n            item\n\n## *Transition* Transition::constructor() : *Renderer.Extension*\n\n        constructor: ->\n            super()\n            @_running = true\n            @_ready = false\n            @_animation = null\n            @_property = ''\n            @_animationClass = Renderer.Class.New\n                priority: -2\n                changes:\n                    updateProperty: Renderer.PropertyAnimation.NEVER\n\n        listener = (oldVal) ->\n            {animation} = @\n            to = @_target[@property]\n            shouldRun = animation and @running and @_ready and not animation.updatePending\n            shouldRun and= utils.isFloat(oldVal) and utils.isFloat(to)\n            unless shouldRun\n                return\n\n            animation.stop()\n            animation.from = oldVal\n            animation.to = to\n            animation.start()\n            return\n\n        onTargetReady = ->\n            @_ready = true\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'target'\n            defaultValue: null\n            setter: (_super) -> (val) ->\n                oldVal = @target\n                if oldVal is val\n                    return\n\n                {animation, property} = @\n\n                if animation\n                    animation.stop()\n                    animation.target = val\n\n                _super.call @, val\n\n                if oldVal\n                    utils.remove oldVal._extensions, @\n\n                @_ready = false\n                if val instanceof itemUtils.Object\n                    item = val\n                else if val instanceof itemUtils.MutableDeepObject\n                    item = val._ref\n                else\n                    setImmediate onTargetReady.bind(@)\n\n                if item\n                    item._extensions.push @\n                    @_ready = true\n\n                if property\n                    handlerName = itemUtils.getPropHandlerName property\n                    if oldVal\n                        oldVal[handlerName]?.disconnect listener, @\n\n                    if val\n                        if handlerName of val\n                            val[handlerName] listener, @\n                        else\n                            log.error \"'#{property}' property signal not found\"\n                return\n\n## *PropertyAnimation* Transition::animation\n\n## *Signal* Transition::onAnimationChange(*PropertyAnimation* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'animation'\n            defaultValue: null\n            developmentSetter: (val) ->\n                assert.instanceOf val, Renderer.PropertyAnimation if val?\n            setter: (_super) -> (val) ->\n                oldVal = @animation\n                if oldVal is val\n                    return\n\n                _super.call @, val\n\n                if oldVal\n                    @_animationClass.disable()\n                    oldVal.target = null\n                    oldVal.stop()\n\n                if val\n                    @_animationClass.target = val\n                    @_animationClass.running = true\n                    val.target = @target\n                    val.property = @property\n                return\n\n## *String* Transition::property\n\n## *Signal* Transition::onPropertyChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'property'\n            defaultValue: ''\n            setter: (_super) -> (val) ->\n                oldVal = @property\n                if oldVal is val\n                    return\n\n                {animation, target} = @\n\n                if target and val.indexOf('.') isnt -1\n                    chains = val.split '.'\n                    n = chains.length\n                    for chain, i in chains when i < n - 1\n                        target = target[chain]\n                        unless target\n                            log.error \"No object found for the '#{val}' property\"\n                            break\n                    val = chains[n - 1]\n                    @target = target\n\n                if animation\n                    animation.stop()\n                    animation.property = val\n\n                _super.call @, val\n\n                if target\n                    if oldVal\n                        handlerName = itemUtils.getPropHandlerName oldVal\n                        target[handlerName].disconnect listener, @\n\n                    if val\n                        handlerName = itemUtils.getPropHandlerName val\n                        target[handlerName] listener, @\n                return\n","old_contents":"# Transition\n\n```javascript\nRectangle {\n    width: 100; height: 100;\n    color: 'red'\n    pointer.onClick: function () {\n        this.x = Math.random() * 300;\n    }\n    Transition {\n        property: 'x'\n        animation: NumberAnimation {\n            duration: 1500\n        }\n    }\n}\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n    signal = require 'src\/signal'\n    log = require 'src\/log'\n\n    log = log.scope 'Renderer', 'Transition'\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Transition extends Renderer.Extension\n        @__name__ = 'Transition'\n\n## *Transition* Transition.New([*Object* options])\n\n        @New = (opts) ->\n            item = new Transition\n            itemUtils.Object.initialize item, opts\n            item\n\n## *Transition* Transition::constructor() : *Renderer.Extension*\n\n        constructor: ->\n            super()\n            @_animation = null\n            @_property = ''\n            @_animationClass = Renderer.Class.New\n                priority: -2\n                changes:\n                    updateProperty: Renderer.PropertyAnimation.NEVER\n\n        listener = (oldVal) ->\n            {animation} = @\n            to = @_target[@property]\n            shouldRun = animation and @running and not animation.updatePending\n            shouldRun and= utils.isFloat(oldVal) and utils.isFloat(to)\n            unless shouldRun\n                return\n\n            animation.stop()\n            animation.from = oldVal\n            animation.to = to\n            animation.start()\n            return\n\n        onTargetReady = ->\n            @_running = true\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'target'\n            defaultValue: null\n            setter: (_super) -> (val) ->\n                oldVal = @target\n                if oldVal is val\n                    return\n\n                {animation, property} = @\n\n                if animation\n                    animation.stop()\n                    animation.target = val\n\n                _super.call @, val\n\n                if oldVal\n                    utils.remove oldVal._extensions, @\n\n                @_running = false\n                if val instanceof itemUtils.Object\n                    item = val\n                else if val instanceof itemUtils.MutableDeepObject\n                    item = val._ref\n                else\n                    setImmediate onTargetReady.bind(@)\n\n                if item\n                    item._extensions.push @\n                    @_running = true\n\n                if property\n                    handlerName = itemUtils.getPropHandlerName property\n                    if oldVal\n                        oldVal[handlerName]?.disconnect listener, @\n\n                    if val\n                        if handlerName of val\n                            val[handlerName] listener, @\n                        else\n                            log.error \"'#{property}' property signal not found\"\n                return\n\n## *PropertyAnimation* Transition::animation\n\n## *Signal* Transition::onAnimationChange(*PropertyAnimation* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'animation'\n            defaultValue: null\n            developmentSetter: (val) ->\n                assert.instanceOf val, Renderer.PropertyAnimation if val?\n            setter: (_super) -> (val) ->\n                oldVal = @animation\n                if oldVal is val\n                    return\n\n                _super.call @, val\n\n                if oldVal\n                    @_animationClass.disable()\n                    oldVal.target = null\n                    oldVal.stop()\n\n                if val\n                    @_animationClass.target = val\n                    @_animationClass.running = true\n                    val.target = @target\n                    val.property = @property\n                return\n\n## *String* Transition::property\n\n## *Signal* Transition::onPropertyChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'property'\n            defaultValue: ''\n            setter: (_super) -> (val) ->\n                oldVal = @property\n                if oldVal is val\n                    return\n\n                {animation, target} = @\n\n                if target and val.indexOf('.') isnt -1\n                    chains = val.split '.'\n                    n = chains.length\n                    for chain, i in chains when i < n - 1\n                        target = target[chain]\n                        unless target\n                            log.error \"No object found for the '#{val}' property\"\n                            break\n                    val = chains[n - 1]\n                    @target = target\n\n                if animation\n                    animation.stop()\n                    animation.property = val\n\n                _super.call @, val\n\n                if target\n                    if oldVal\n                        handlerName = itemUtils.getPropHandlerName oldVal\n                        target[handlerName].disconnect listener, @\n\n                    if val\n                        handlerName = itemUtils.getPropHandlerName val\n                        target[handlerName] listener, @\n                return\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"80d379881a718fb8ddf1d9182e7661ce65011c69","subject":"correct documentation mistake, model required page","message":"correct documentation mistake, model required page\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/lib\/page\/index.litcoffee","new_file":"src\/lib\/page\/index.litcoffee","new_contents":"\n# Page Controller\n\nTo access this module, use the following code: \n`page = require('..\/page')`.  Methods can be called as:\n`page.getPage(model, name, (page) -> { ... })`.\n\n    module.exports = {}\n\n## getPage\n\nRequires:\n\n- **model** - the Page model\n- **name** - the name of the page to fetch\n- **callback** - (page) -> {...}\n    - **page** - a dict containing:\n        - **page.name** - a string of the page name\n        - **page.title** - a string of the page title\n        - **page.body** - a string of the page body\n\nCode:\n\n    \n    getPage = (model, name, callback) ->\n      model.findOne {name: name}, (err, doc) ->\n        if err\n          console.error err.stack\n        if !doc\n          callback null\n        else\n          callback {\n            name: doc.get 'name'\n            title: doc.get 'title'\n            body: doc.get 'body'\n          }\n    module.exports.getPage = getPage\n\n## setPage\n\nRequires:\n\n- **model** - the Page model\n- **page** - a dict of the page to set containing:\n    - **page.name** - a string of the page name\n    - **page.title** - a string of the page title\n    - **page.body** - a string of the page body\n- **callback** - (page) -> {...}\n    - **page** - a dict of the page written to the db (uses getPage):\n        - **page.name** - a string of the page name\n        - **page.title** - a string of the page title\n        - **page.body** - a string of the page body\n\nCode:\n\n    setPage = (model, page, callback) ->\n      if !page || !page.name || !page.title || !page.body\n        console.error 'setPage called with invalid page'\n        callback null\n      model.create [page], (err) ->\n        if err\n          console.error err.stack\n          callback null\n        else\n          getPage model, page.name, callback\n    module.exports.setPage = setPage\n          \n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Page Controller\n\nThe Page controller requires access to models.  In this application, models can\nbe found at `app.models`.  To access this module, use the following code: \n`page = require('..\/page')(app.models)`.\n\nAlso note, `models` contians:\n\n- **models.db** - Mongoose MongoDB connection\n- **models.MODELNAME** - model objects\n\nCode:\n\n    module.exports = {}\n\n## getPage\n\nRequires:\n\n- **model** - the Page model\n- **name** - the name of the page to fetch\n- **callback** - (page) -> {...}\n    - **page** - a dict containing:\n        - **page.name** - a string of the page name\n        - **page.title** - a string of the page title\n        - **page.body** - a string of the page body\n\nCode:\n\n    \n    getPage = (model, name, callback) ->\n      model.findOne {name: name}, (err, doc) ->\n        if err\n          console.error err.stack\n        if !doc\n          callback null\n        else\n          callback {\n            name: doc.get 'name'\n            title: doc.get 'title'\n            body: doc.get 'body'\n          }\n    module.exports.getPage = getPage\n\n## setPage\n\nRequires:\n\n- **model** - the Page model\n- **page** - a dict of the page to set containing:\n    - **page.name** - a string of the page name\n    - **page.title** - a string of the page title\n    - **page.body** - a string of the page body\n- **callback** - (page) -> {...}\n    - **page** - a dict of the page written to the db (uses getPage):\n        - **page.name** - a string of the page name\n        - **page.title** - a string of the page title\n        - **page.body** - a string of the page body\n\nCode:\n\n    setPage = (model, page, callback) ->\n      if !page || !page.name || !page.title || !page.body\n        console.error 'setPage called with invalid page'\n        callback null\n      model.create [page], (err) ->\n        if err\n          console.error err.stack\n          callback null\n        else\n          getPage model, page.name, callback\n    module.exports.setPage = setPage\n          \n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"226b2c9dd4f7b44d22cdeeda44a323ec87f8375f","subject":"more api friendly","message":"more api friendly","repos":"glamp\/leech,glamp\/leech","old_file":"src\/app.litcoffee","new_file":"src\/app.litcoffee","new_contents":"Setup dependencies\n\n    bodyParser = require \"body-parser\"\n    express = require \"express\"\n    exphbs = require \"express-handlebars\"\n    fs = require \"fs\"\n    http = require \"http\"\n    async = require \"async\"\n    lessMiddleware = require \"less-middleware\"\n    methodOverride = require \"method-override\"\n    path = require \"path\"\n    AWS = require \"aws-sdk\"\n    leech = require \".\/leech\"\n\n    DOMAIN = process.env[\"DOMAIN\"]\n    AWS.config.update {\n        accessKeyId: process.env[\"AWS_ACCESS_KEY\"],\n        secretAccessKey: process.env[\"AWS_SECRET_KEY\"]\n    }\n    AWS.config.region = 'us-east-1'\n\n    s3 = new AWS.S3()\n    app = express()\n    app.set \"port\", process.env.PORT || 3000\n\nSet up views\n\n    app.set \"views\", path.join(__dirname, \"..\", \"views\")\n    app.set \"view engine\", \"html\"\n    app.engine \"html\", exphbs(\n      defaultLayout: \"main\"\n      extname: \".html\"\n    )\n    #helpers: helpers\n    app.enable \"view cache\"\n\nSet up static assests\n\n    app.use lessMiddleware(path.join(__dirname, \"..\", \"public\"), {}, {},\n      compress: true\n      sourceMap: true\n    )\n    app.use express.static(path.join(__dirname, \"..\", \"public\"))\n\n\nAdd methods PUT & DELETE\n\n    app.use methodOverride()\n\nBody parsing middleware\n\n    app.use bodyParser.urlencoded(extended: true)\n    app.use bodyParser.json()\n\nZe routes...\n\n    app.get \"\/\", (req, res) ->\n      res.render \"index\", { isHome: true }\n\nSimple route to look at all the URLs we've shortened.\n\n    app.get \"\/history\", (req, res) ->\n      params = { Bucket: DOMAIN }\n      s3.listObjects params, (err, objs) ->\n        if err\n            console.log \"[ERROR]: could not list objects: \" + err\n            return res.redirect \"\/\"\n\n        urls = []\n        async.each objs.Contents, (obj, callback) ->\n          s3.headObject { Bucket: DOMAIN, Key: obj.Key }, (err, data) ->\n            if err\n              console.log \"error\", data\n            url = { key: \"http:\/\/#{DOMAIN}\/#{obj.Key}\", url: data.Metadata.url }\n            if url.url\n              urls.push url\n            callback()\n        , (err) ->\n          res.render \"history\", { isHistory: true, urls: urls }\n\n    app.get \"\/about\", (req, res) ->\n      res.render \"about\", { isAbout: true }\n\n    app.get \"\/setup\", (req, res) ->\n      res.render \"setup\", { isSetup: true }\n\n    app.post \"\/\", (req, res) ->\n      if req.body.url\n        leech req.body.url, (err, url) ->\n          if err\n            res.render \"index\", { isHome: true, url: \"ERROR\" }\n          else\n            if req.query.format==\"json\"\n              res.json { status: \"OK\", short_url: url, original_url: req.body.url }\n            else\n              res.render \"index\", { isHome: true, url: url }\n      else\n        res.json { status: \"ERROR\", error: \"No URL Provided\" }\n\n    app.get \"*\", (req, res) ->\n      res.render \"404\"\n\n    http.createServer(app).listen app.get(\"port\"), ->\n        console.log \"Express server listening on port \" + app.get(\"port\")\n","old_contents":"Setup dependencies\n\n    bodyParser = require \"body-parser\"\n    express = require \"express\"\n    exphbs = require \"express-handlebars\"\n    fs = require \"fs\"\n    http = require \"http\"\n    async = require \"async\"\n    lessMiddleware = require \"less-middleware\"\n    methodOverride = require \"method-override\"\n    path = require \"path\"\n    AWS = require \"aws-sdk\"\n    leech = require \".\/leech\"\n\n    DOMAIN = process.env[\"DOMAIN\"]\n    AWS.config.update {\n        accessKeyId: process.env[\"AWS_ACCESS_KEY\"],\n        secretAccessKey: process.env[\"AWS_SECRET_KEY\"]\n    }\n    AWS.config.region = 'us-east-1'\n\n    s3 = new AWS.S3()\n    app = express()\n    app.set \"port\", process.env.PORT || 3000\n\nSet up views\n\n    app.set \"views\", path.join(__dirname, \"..\", \"views\")\n    app.set \"view engine\", \"html\"\n    app.engine \"html\", exphbs(\n      defaultLayout: \"main\"\n      extname: \".html\"\n    )\n    #helpers: helpers\n    app.enable \"view cache\"\n\nSet up static assests\n\n    app.use lessMiddleware(path.join(__dirname, \"..\", \"public\"), {}, {},\n      compress: true\n      sourceMap: true\n    )\n    app.use express.static(path.join(__dirname, \"..\", \"public\"))\n\n\nAdd methods PUT & DELETE\n\n    app.use methodOverride()\n\nBody parsing middleware\n\n    app.use bodyParser.urlencoded(extended: true)\n    app.use bodyParser.json()\n\nZe routes...\n\n    app.get \"\/\", (req, res) ->\n      res.render \"index\", { isHome: true }\n\nSimple route to look at all the URLs we've shortened.\n\n    app.get \"\/history\", (req, res) ->\n      params = { Bucket: DOMAIN }\n      s3.listObjects params, (err, objs) ->\n        if err\n            console.log \"[ERROR]: could not list objects: \" + err\n            return res.redirect \"\/\"\n\n        urls = []\n        async.each objs.Contents, (obj, callback) ->\n          s3.headObject { Bucket: DOMAIN, Key: obj.Key }, (err, data) ->\n            if err\n              console.log \"error\", data\n            url = { key: \"http:\/\/#{DOMAIN}\/#{obj.Key}\", url: data.Metadata.url }\n            if url.url\n              urls.push url\n            callback()\n        , (err) ->\n          res.render \"history\", { isHistory: true, urls: urls }\n\n    app.get \"\/about\", (req, res) ->\n      res.render \"about\", { isAbout: true }\n\n    app.get \"\/setup\", (req, res) ->\n      res.render \"setup\", { isSetup: true }\n\n    app.post \"\/\", (req, res) ->\n      if req.body.url\n        leech req.body.url, (err, url) ->\n          if err\n            res.render \"index\", { isHome: true, url: \"ERROR\" }\n          else\n            res.render \"index\", { isHome: true, url: url }\n      else\n        res.json { \"error\": \"No URL Provided\" }\n\n    app.get \"*\", (req, res) ->\n      res.render \"404\"\n\n    http.createServer(app).listen app.get(\"port\"), ->\n        console.log \"Express server listening on port \" + app.get(\"port\")\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"01b592e029536726523e6751b098b5296bea2801","subject":"weya data attribute","message":"weya data attribute\n","repos":"vpj\/weya,vpj\/weya","old_file":"weya.litcoffee","new_file":"weya.litcoffee","new_contents":"Gist of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setData = (elem, data) ->\n      for k, v of data\n       elem[k] = v\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        when 'data' then setData elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       if elem.classList?\n        for c in idClass.class\n         elem.classList.add c\n       else #For older browsers; does not work with svgs\n        className = ''\n        for c in idClass.class\n         className += ' ' if className isnt ''\n         className += \"#{c}\"\n        elem.className = className\n\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setData = (buf, data) ->\n      for k, v of data\n       buf.push \" data-#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        when 'data' then setData buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        buf.push \" class=\\\"#{params.idClass.class}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       setIndent buf, @_indent\n       buf.push params.text\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","old_contents":"Gist of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       if elem.classList?\n        for c in idClass.class\n         elem.classList.add c\n       else #For older browsers; does not work with svgs\n        className = ''\n        for c in idClass.class\n         className += ' ' if className isnt ''\n         className += \"#{c}\"\n        elem.className = className\n\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        buf.push \" class=\\\"#{params.idClass.class}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       setIndent buf, @_indent\n       buf.push params.text\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bdf283ffd9bf4ab48614e08d94bfd47149d39b54","subject":"Change  to","message":"Change  to\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/12_associations.litcoffee","new_file":"docs\/12_associations.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c640fda9b0b1d09d2b7236f655b3663dc06c63d6","subject":"fixing spacing","message":"fixing spacing\n","repos":"osharim\/docco,guigrpa\/docco-extended,Hellyna\/docco,erikdiessel\/plidoc,jrvidal\/docco,lobrien\/docco,guigrpa\/docco,STRd6\/docco,jrvidal\/docco,jalleyne\/docco,oponder\/docco,whitetrefoil\/docco,Hellyna\/docco,MaxwellRebo\/docco,mhkeller\/docco,robertmackenzie\/docco,guigrpa\/docco,lbn\/docco,lobrien\/docco,DoomHammer\/docco,actano\/docco,oponder\/docco,tbremer\/docco,ShawnHuang\/docco-multidir,gvithellyna\/docco,tbremer\/docco,whitetrefoil\/docco,lbn\/docco,HubSpot\/docco,guigrpa\/docco-extended,ShawnHuang\/docco-multidir,gvithellyna\/docco,mhkeller\/docco,MaxwellRebo\/docco,jalleyne\/docco,JonathanMatthey\/codeconv,robertmackenzie\/docco,osharim\/docco,DoomHammer\/docco,erikdiessel\/plidoc","old_file":"docco.litcoffee","new_file":"docco.litcoffee","new_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty, hundred-line-long, literate-programming-style\ndocumentation generator. It produces HTML\nthat displays your comments alongside your code. Comments are passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Pygments](http:\/\/pygments.org\/) syntax highlighting, if it\nis present on the system.\nThis page is the result of running Docco against its own source file.\n\nIf you install Docco, you can run it from the command-line: `docco src\/*.coffee`\n\n...will generate an HTML documentation page for each of the named source files,\nwith a menu linking to the other pages, saving it into a `docs` folder.\n\nThe [source for Docco](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand released under the MIT license.\n\nTo install Docco, first make sure you have [Node.js](http:\/\/nodejs.org\/),\n[Pygments](http:\/\/pygments.org\/) (install the latest dev version of Pygments\nfrom [its Mercurial repo](https:\/\/bitbucket.org\/birkenfeld\/pygments-main)), and\n[CoffeeScript](http:\/\/coffeescript.org\/).\n\nThen, with NPM: `sudo npm install -g docco`\n\nDocco can be used to process CoffeeScript, JavaScript, Ruby, Python, or TeX files.\nOnly single-line comments are processed -- block comments are ignored.\n\n\nPartners in Crime:\n------------------\n\n* If **Node.js** doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.com\/rocco\/rocco.html), the Ruby port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.com\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If Python's more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.com\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.com\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.com\/nocco\/).\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for a source file by reading it in, splitting it\nup into comment\/code sections, highlighting them for the appropriate language,\nand merging them into an HTML template.\n\n    generateDocumentation = (source, config, callback) ->\n      fs.readFile source, (error, buffer) ->\n        throw error if error\n        code = buffer.toString()\n        sections = parse source, code, config\n        highlight source, sections, config, ->\n          generateHtml source, sections, config\n          callback()\n\n    document = (sources, options = {}, callback = null) ->\n      config = {}\n      config[key] = defaults[key] for key,value of defaults\n      config[key] = value for key,value of options if key of defaults\n\n      config.sources = sources.filter((source) -> getLanguage source, config).sort()\n      console.log \"docco: skipped unknown type (#{m})\" for m in sources when m not in config.sources\n\n      config.doccoTemplate = _.template fs.readFileSync(config.template).toString()\n      doccoStyles = fs.readFileSync(config.css).toString()\n\n      ensureDirectory config.output, ->\n        fs.writeFileSync path.join(config.output,path.basename(config.css)), doccoStyles\n        files = config.sources.slice()\n        nextFile = ->\n          callback() if callback? and not files.length\n          generateDocumentation files.shift(), config, nextFile if files.length\n        nextFile()\n\nGiven a string of source code, parse out each comment and the code that\nfollows it, and create an individual **section** for it.\n\n    parse = (source, code, config) ->\n      lines    = code.split '\\n'\n      sections = []\n      language = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\n      if language.literate\n        for line, i in lines\n          lines[i] = if \/^\\s*$\/.test line\n            ''\n          else if match = (\/^([ ]{4}|\\t)\/).exec line\n            line[match[0].length..]\n          else\n            '# ' + line\n\n      for line in lines\n        if (not line and prev is 'text') or (line.match(language.commentMatcher) and not line.match(language.commentFilter))\n          save() if hasCode\n          docsText += (line = line.replace(language.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n          prev = 'text'\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n          prev = 'code'\n      save()\n\n      sections\n\nHighlights parsed sections of code, using **Pygments** over stdio,\nand runs the text of their corresponding comments through **Markdown**, using\n[Marked](https:\/\/github.com\/chjj\/marked).  If Pygments is not present\non the system, output the code in plain text.\n\nWe process all sections with single calls to Pygments and Marked, by\ninserting marker comments between them, and then splitting the result\nstring wherever the marker occurs.\n\n    highlight = (source, sections, config, callback) ->\n      language = getLanguage source, config\n      pygments = spawn 'pygmentize', [\n        '-l', language.name,\n        '-f', 'html',\n        '-O', 'encoding=utf-8,tabsize=2'\n      ]\n      output = ''\n      code = (section.codeText for section in sections).join language.codeSplitText\n      docs = (section.docsText for section in sections).join language.docsSplitText\n\n      pygments.stderr.on 'data', ->\n      pygments.stdin.on 'error', ->\n      pygments.stdout.on 'data', (result) ->\n        output += result if result\n\n      pygments.on 'exit', ->\n        output = output.replace(highlightStart, '').replace(highlightEnd, '')\n        if output is ''\n          codeFragments = (htmlEscape section.codeText for section in sections)\n        else\n          codeFragments = output.split language.codeSplitHtml\n        docsFragments = marked(docs).split language.docsSplitHtml\n\n        for section, i in sections\n          section.codeHtml = highlightStart + codeFragments[i] + highlightEnd\n          section.docsHtml = docsFragments[i]\n        callback()\n\n      if pygments.stdin.writable\n        pygments.stdin.write code\n        pygments.stdin.end()\n\nEscape an html string, to produce valid non-highlighted output when pygments\nis not present on the system.\n\n    htmlEscape = (string) ->\n      string.replace(\/&\/g, '&amp;')\n        .replace(\/<\/g, '&lt;')\n        .replace(\/>\/g, '&gt;')\n        .replace(\/\"\/g, '&quot;')\n        .replace(\/'\/g, '&#x27;')\n        .replace(\/\\\/\/g,'&#x2F;')\n\nOnce all of the code is finished highlighting, we can generate the HTML file by\npassing the completed sections into the template, and then writing the file to\nthe specified output path.\n\n    generateHtml = (source, sections, config) ->\n      destination = (filepath) ->\n        path.join(config.output, path.basename(filepath, path.extname(filepath)) + '.html')\n      hasTitle = marked.lexer(sections[0].docsText)[0].type is 'heading'\n      title = if hasTitle then null else path.basename(source)\n      dest  = destination source\n      html  = config.doccoTemplate {\n        title      : title,\n        sections   : sections,\n        sources    : config.sources,\n        path       : path,\n        destination: destination\n        css        : path.basename(config.css)\n      }\n      console.log \"docco: #{source} -> #{dest}\"\n      fs.writeFileSync dest, html\n\n\nHelpers & Setup\n---------------\n\nRequire our external dependencies.\n\n    _             = require 'underscore'\n    fs            = require 'fs'\n    path          = require 'path'\n    marked        = require 'marked'\n    commander     = require 'commander'\n    {spawn, exec} = require 'child_process'\n\nRead resource file and return its content.\n\n    getResource = (name) ->\n      fullPath = path.join __dirname, 'resources', name\n      fs.readFileSync(fullPath).toString()\n\nLanguages are stored in JSON format in the file `resources\/languages.json`\nEach item maps the file extension to the name of the Pygments lexer and the\nsymbol that indicates a comment. To add a new language, modify the file.\n\n    languages = JSON.parse getResource 'languages.json'\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    for ext, l of languages\n\n      # Does the line begin with a comment?\n      l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\n      # Ignore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_(Unix\\))\n      # and interpolations...\n      l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n\n      # The dividing token we feed into Pygments, to delimit the boundaries between\n      # sections.\n      l.codeSplitText = \"\\n#{l.symbol}DIVIDER\\n\"\n\n      # The mirror of `codeSplitText` that we expect Pygments to return. We can split\n      # on this to recover the original sections.\n      # Note: the class is \"c\" for Python and \"c1\" for the other languages\n      l.codeSplitHtml = \/\/\/\\n*<span\\sclass=\"c1?\">#{l.symbol}DIVIDER<\\\/span>\\n*\/\/\/\n\n      # The dividing token we feed into markdown, to delimit the boundaries between\n      # sections.\n      l.docsSplitText = \"\\n##{l.name}DOCDIVIDER\\n\"\n\n      # The mirror of `docsSplitText` that we expect markdown to return. We can split\n      # on this to recover the original sections.\n      l.docsSplitHtml = \/\/\/<h1>#{l.name}DOCDIVIDER<\/h1>\/\/\/\n\nGet the current language we're documenting, based on the extension.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source)\n      lang = languages[ext]\n      if lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nEnsure that the destination directory exists.\n\n    ensureDirectory = (dir, cb, made=null) ->\n      mode = parseInt '0777', 8\n      fs.mkdir dir, mode, (er) ->\n        return cb null, made || dir if not er\n        if er.code == 'ENOENT'\n          return ensureDirectory path.dirname(dir), (er, made) ->\n            if er then cb er, made else ensureDirectory dir, cb, made\n        cb er, made\n\nThe start of each Pygments highlight block.\n\n    highlightStart = '<div class=\"highlight\"><pre>'\n\nThe end of each Pygments highlight block.\n\n    highlightEnd   = '<\/pre><\/div>'\n\nExtract the docco version from `package.json`\n\n    version = JSON.parse(fs.readFileSync(\"#{__dirname}\/package.json\")).version\n\nDefault configuration options.\n\n    defaults =\n      template : \"#{__dirname}\/resources\/docco.jst\"\n      css      : \"#{__dirname}\/resources\/docco.css\"\n      output   : \"docs\/\"\n      extension: null\n\n\nRun from Commandline\n--------------------\n\nRun Docco from a set of command line arguments.\nParse command line using [Commander JS](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args=process.argv) ->\n      commander.version(version)\n        .usage(\"[options] <filePattern ...>\")\n        .option(\"-c, --css [file]\",\"use a custom css file\", defaults.css)\n        .option(\"-o, --output [path]\",\"use a custom output path\", defaults.output)\n        .option(\"-t, --template [file]\",\"use a custom .jst template\", defaults.template)\n        .option(\"-e, --extension <ext>\",\"use the given file extension for all inputs\", defaults.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document(commander.args.slice(), commander)\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, version}\n","old_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty, hundred-line-long, literate-programming-style\ndocumentation generator. It produces HTML\nthat displays your comments alongside your code. Comments are passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Pygments](http:\/\/pygments.org\/) syntax highlighting, if it\nis present on the system.\nThis page is the result of running Docco against its own source file.\n\nIf you install Docco, you can run it from the command-line: `docco src\/*.coffee`\n\n...will generate an HTML documentation page for each of the named source files,\nwith a menu linking to the other pages, saving it into a `docs` folder.\n\nThe [source for Docco](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand released under the MIT license.\n\nTo install Docco, first make sure you have [Node.js](http:\/\/nodejs.org\/),\n[Pygments](http:\/\/pygments.org\/) (install the latest dev version of Pygments\nfrom [its Mercurial repo](https:\/\/bitbucket.org\/birkenfeld\/pygments-main)), and\n[CoffeeScript](http:\/\/coffeescript.org\/).\n\nThen, with NPM: `sudo npm install -g docco`\n\nDocco can be used to process CoffeeScript, JavaScript, Ruby, Python, or TeX files.\nOnly single-line comments are processed -- block comments are ignored.\n\n\nPartners in Crime:\n------------------\n\n* If **Node.js** doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.com\/rocco\/rocco.html), the Ruby port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.com\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If Python's more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.com\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.com\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.com\/nocco\/).\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for a source file by reading it in, splitting it\nup into comment\/code sections, highlighting them for the appropriate language,\nand merging them into an HTML template.\n\n    generateDocumentation = (source, config, callback) ->\n      fs.readFile source, (error, buffer) ->\n        throw error if error\n        code = buffer.toString()\n        sections = parse source, code, config\n        highlight source, sections, config, ->\n          generateHtml source, sections, config\n          callback()\n\n    document = (sources, options = {}, callback = null) ->\n      config = {}\n      config[key] = defaults[key] for key,value of defaults\n      config[key] = value for key,value of options if key of defaults\n\n      config.sources = sources.filter((source) -> getLanguage source, config).sort()\n      console.log \"docco: skipped unknown type (#{m})\" for m in sources when m not in config.sources\n\n      config.doccoTemplate = _.template fs.readFileSync(config.template).toString()\n      doccoStyles = fs.readFileSync(config.css).toString()\n\n      ensureDirectory config.output, ->\n        fs.writeFileSync path.join(config.output,path.basename(config.css)), doccoStyles\n        files = config.sources.slice()\n        nextFile = ->\n          callback() if callback? and not files.length\n          generateDocumentation files.shift(), config, nextFile if files.length\n        nextFile()\n\nGiven a string of source code, parse out each comment and the code that\nfollows it, and create an individual **section** for it.\n\n    parse = (source, code, config) ->\n      lines    = code.split '\\n'\n      sections = []\n      language = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\n      if language.literate\n        for line, i in lines\n          lines[i] = if \/^\\s*$\/.test line\n            ''\n          else if match = (\/^([ ]{4}|\\t)\/).exec line\n            line[match[0].length..]\n          else\n            '# ' + line\n\n      for line in lines\n        if (not line and prev is 'text') or (line.match(language.commentMatcher) and not line.match(language.commentFilter))\n          save() if hasCode\n          docsText += (line = line.replace(language.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n          prev = 'text'\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n          prev = 'code'\n      save()\n\n      sections\n\nHighlights parsed sections of code, using **Pygments** over stdio,\nand runs the text of their corresponding comments through **Markdown**, using\n[Marked](https:\/\/github.com\/chjj\/marked).  If Pygments is not present\non the system, output the code in plain text.\n\nWe process all sections with single calls to Pygments and Marked, by\ninserting marker comments between them, and then splitting the result\nstring wherever the marker occurs.\n\n    highlight = (source, sections, config, callback) ->\n      language = getLanguage source, config\n      pygments = spawn 'pygmentize', [\n        '-l', language.name,\n        '-f', 'html',\n        '-O', 'encoding=utf-8,tabsize=2'\n      ]\n      output = ''\n      code = (section.codeText for section in sections).join language.codeSplitText\n      docs = (section.docsText for section in sections).join language.docsSplitText\n\n      pygments.stderr.on 'data', ->\n      pygments.stdin.on 'error', ->\n      pygments.stdout.on 'data', (result) ->\n        output += result if result\n\n      pygments.on 'exit', ->\n        output = output.replace(highlightStart, '').replace(highlightEnd, '')\n        if output is ''\n          codeFragments = (htmlEscape section.codeText for section in sections)\n        else\n          codeFragments = output.split language.codeSplitHtml\n        docsFragments = marked(docs).split language.docsSplitHtml\n\n        for section, i in sections\n          section.codeHtml = highlightStart + codeFragments[i] + highlightEnd\n          section.docsHtml = docsFragments[i]\n        callback()\n\n      if pygments.stdin.writable\n        pygments.stdin.write code\n        pygments.stdin.end()\n\nEscape an html string, to produce valid non-highlighted output when pygments\nis not present on the system.\n\n    htmlEscape = (string) ->\n      string.replace(\/&\/g, '&amp;')\n        .replace(\/<\/g, '&lt;')\n        .replace(\/>\/g, '&gt;')\n        .replace(\/\"\/g, '&quot;')\n        .replace(\/'\/g, '&#x27;')\n        .replace(\/\\\/\/g,'&#x2F;')\n\nOnce all of the code is finished highlighting, we can generate the HTML file by\npassing the completed sections into the template, and then writing the file to\nthe specified output path.\n\n    generateHtml = (source, sections, config) ->\n      destination = (filepath) ->\n        path.join(config.output, path.basename(filepath, path.extname(filepath)) + '.html')\n      hasTitle = marked.lexer(sections[0].docsText)[0].type is 'heading'\n      title = if hasTitle then null else path.basename(source)\n      dest  = destination source\n      html  = config.doccoTemplate {\n        title      : title,\n        sections   : sections,\n        sources    : config.sources,\n        path       : path,\n        destination: destination\n        css        : path.basename(config.css)\n      }\n      console.log \"docco: #{source} -> #{dest}\"\n      fs.writeFileSync dest, html\n\n\nHelpers & Setup\n---------------\n\nRequire our external dependencies.\n\n    _             = require 'underscore'\n    fs            = require 'fs'\n    path          = require 'path'\n    marked        = require 'marked'\n    commander     = require 'commander'\n    {spawn, exec} = require 'child_process'\n\nRead resource file and return its content.\n\n    getResource = (name) ->\n      fullPath = path.join __dirname, 'resources', name\n      fs.readFileSync(fullPath).toString()\n\nLanguages are stored in JSON format in the file `resources\/languages.json`\nEach item maps the file extension to the name of the Pygments lexer and the\nsymbol that indicates a comment. To add a new language, modify the file.\n\n    languages = JSON.parse getResource 'languages.json'\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    for ext, l of languages\n\n      # Does the line begin with a comment?\n      l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\n      # Ignore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_(Unix\\))\n      # and interpolations...\n      l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n\n      # The dividing token we feed into Pygments, to delimit the boundaries between\n      # sections.\n      l.codeSplitText = \"\\n#{l.symbol}DIVIDER\\n\"\n\n      # The mirror of `codeSplitText` that we expect Pygments to return. We can split\n      # on this to recover the original sections.\n      # Note: the class is \"c\" for Python and \"c1\" for the other languages\n      l.codeSplitHtml = \/\/\/\\n*<span\\sclass=\"c1?\">#{l.symbol}DIVIDER<\\\/span>\\n*\/\/\/\n\n      # The dividing token we feed into markdown, to delimit the boundaries between\n      # sections.\n      l.docsSplitText = \"\\n##{l.name}DOCDIVIDER\\n\"\n\n      # The mirror of `docsSplitText` that we expect markdown to return. We can split\n      # on this to recover the original sections.\n      l.docsSplitHtml = \/\/\/<h1>#{l.name}DOCDIVIDER<\/h1>\/\/\/\n\nGet the current language we're documenting, based on the extension.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source)\n      lang = languages[ext]\n      if lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nEnsure that the destination directory exists.\n\n    ensureDirectory = (dir, cb, made=null) ->\n      mode = parseInt '0777', 8\n      fs.mkdir dir, mode, (er) ->\n        return cb null, made || dir if not er\n        if er.code == 'ENOENT'\n          return ensureDirectory path.dirname(dir), (er, made) ->\n            if er then cb er, made else ensureDirectory dir, cb, made\n        cb er, made\n\nThe start of each Pygments highlight block.\n\n    highlightStart = '<div class=\"highlight\"><pre>'\n\nThe end of each Pygments highlight block.\n\n    highlightEnd   = '<\/pre><\/div>'\n\nExtract the docco version from `package.json`\n\n    version = JSON.parse(fs.readFileSync(\"#{__dirname}\/package.json\")).version\n\nDefault configuration options.\n\n    defaults =\n      template : \"#{__dirname}\/resources\/docco.jst\"\n      css      : \"#{__dirname}\/resources\/docco.css\"\n      output   : \"docs\/\"\n      extension: null\n\n\nRun from Commandline\n--------------------\n\nRun Docco from a set of command line arguments.\nParse command line using [Commander JS](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args=process.argv) ->\n      commander.version(version)\n        .usage(\"[options] <filePattern ...>\")\n        .option(\"-c, --css [file]\",\"use a custom css file\",defaults.css)\n        .option(\"-o, --output [path]\",\"use a custom output path\",defaults.output)\n        .option(\"-t, --template [file]\",\"use a custom .jst template\",defaults.template)\n        .option(\"-e, --extension <ext>\",\"use the given file extension for all inputs\",defaults.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document(commander.args.slice(),commander)\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, version}\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1a138d514e8aa748e23707b4d4ac6d93db9cc372","subject":"Added bounce function to Ball","message":"Added bounce function to Ball\n\nSigned-off-by: Diwank Singh <a78369447041e6bcf2913d083e4ed301785fc609@gmail.com>\n","repos":"creatorrr\/browser-bricks","old_file":"bricks.litcoffee","new_file":"bricks.litcoffee","new_contents":"Re: [Letter to a Source-Code-Reader](http:\/\/stewd.io\/pong\/lib\/pong.js)\n\nDear Stewart\n\nThanks for inspiring me and many like me with the wonders of js.\nWith all it's warts and issues, JS is still one of my favorite languages.\nI think simply by it's virtue of being the language of the web, it surpasses most others\nin it's ability to champion the spirit of openness.\n\nI have tried to keep this as simple as possible for the many awesome source code lovers\nto read, reuse and critique.\n\nThanks again for caring to write that letter in 2009. It made a kid smile.\n\nDiwank Singh\nJuly 2013\n\n*****\n\nBrowser Bricks\n==============\n\nAlright, let's get on with it.\n\nHelper Functions\n----------------\n\nFirst, let's define some helper functions for the application.\n\n    _ =   # _ namespace\n      # Extend objects\n      extend: (dest, src) ->\n        dest[k] = v for own k, v of src\n        dest\n\n      # Pick properties\n      pick: (obj, props) ->\n        result = {}\n        result[k] = obj[k] for k in props when obj[k]?\n\n        result\n\n      # UUID function (Copied shamelessly from https:\/\/gist.github.com\/bmc\/1893440)\n      uuid: ->\n        'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(\/[xy]\/g, (c) ->\n          r = Math.random() * 16 | 0\n          v = if c is 'x' then r else (r & 0x3|0x8)\n          v.toString(16)\n        )\n\n      # Simple serializer for flat objects\n      serialize: (obj, {sep, eq}, cb) ->\n        # Exec callback on all values of obj\n        obj[k] = cb v for own k, v of obj if cb?\n\n        # Return serialized obj\n        (\"#{ k }#{ eq }#{ v }\" for own k, v of obj).join sep\n\n      # Defer execution of function\n      defer: (fn, args...) -> window.setTimeout fn, 1, args...\n\n      # Clone object\n      clone: (obj) ->\n        # If object extend\n        if obj is Object obj\n          _.extend {}, obj\n\n        else  # Assume it's array otherwise\n          obj.splice 0\n\nInit Function\n-------------\n\nLet's write a global init function that can be used to register callbacks which are\nexecuted 'onload'.\n\n    # Callback register\n    init = do ->\n      # Store registered callbacks\n      callbacks = []\n\n      # Run callbacks in order registered\n      exec = -> fn?() for fn in callbacks\n\n      # Onload callback\n      onLoad = (fn) ->\n        window.removeEventListener 'load', init, false\n        fn?()\n\n      (cb) ->\n        if cb?\n          # Register callback\n          callbacks.push cb\n        else\n          # Defer execution until stack cleared\n          onLoad -> _.defer exec\n\n        false\n\n    # Attach DOM load listener\n    window.addEventListener 'load', init, false\n\nClass: Box\n----------\n\nNow, let's define a box that will be the basic building block for the game.\nAll the objects will inherit from this class.\n\n    class Box\n      # -- Private --\n\n      _settings:\n        # Default settings\n        height: 100\n        width:  200\n        top:    0\n        left:   0\n\n      _props:\n        # Fixed window props\n        toolbar:     false\n        directories: false\n        fullscreen:  false\n        location:    false\n        menubar:     false\n        resizable:   false\n        scrollbars:  false\n        status:      false\n\n      _window: null  # Empty window object\n      _url: '\/index.html' # Fixed to current page, renders based on context\n\n      _EDITABLE: -> Object.keys @constructor::_settings   # Editable settings\n\n      _update: (settings) ->\n        # Update settings\n        _.extend @_settings, (_.pick settings, @_EDITABLE())\n\n        # Adjust window props\n        @_window?.moveTo?   (@_get 'left'), (@_get 'top')\n        @_window?.resizeTo? (@_get 'width'), (@_get 'height')\n\n        # Return a copy of settings\n        @_getAll()\n\n      _get: (prop) -> @_settings[prop] if prop in @_EDITABLE()\n      _getAll: -> _.extend (_.clone @_settings), @_fixed\n\n      _getDefault: -> @constructor::_settings\n\n      # -- Public --\n\n      constructor: (namespace='', settings) ->\n        # Make a copy of default settings\n        @_settings = _.clone @_settings\n\n        # Override settings.\n        @_update settings\n\n        # Set random name with namespace\n        @id = \"#{ namespace }#{ if namespace then '-' else '' }#{ _.uuid() }\"\n        this\n\n      # Show window with settings.\n      show: ->\n        # Serialize options\n        opts = _.serialize @_getAll(), {sep: ',', eq: '='}, (v) ->\n          switch v\n            when false then 'no'\n            when true then 'yes'\n            else v+''\n\n        @_window = window.open @_url, @id, opts\n        this\n\n      # Hide the window.\n      hide: ->\n        @_window.close()\n        @_window = null\n        this\n\n      # Check if window is visible.\n      isVisible: -> @_window?.location?\n\n      # Reset window settings.\n      reset: ->\n        @_update @_getDefault()\n        this\n\n      # Return or update window position coords.\n      position: (coords...) ->\n        # Set new coords\n        if coords.length then @_update\n          left: coords[0] ? @_getDefault().left  # x\n          top:  coords[1] ? @_getDefault().top   # y\n\n        # Return coords\n        _.pick @_getAll(), ['top', 'left']\n\n      # Return or update window dimensions.\n      size: (dimensions...) ->\n        # Set new dimensions\n        if dimensions.length then @_update\n          width:  dimensions[0] ? @_getDefault().width\n          height: dimensions[1] ? @_getDefault().height\n\n        # Return dimensions\n        _.pick @_getAll(), ['width', 'height']\n\nClass: Brick (Box)\n------------------\n\nNow let's use the class `Box` to design the `Brick` class which\nwill be used to render the bricks.\n\nIt's pretty much a useless box.\n\n    class Brick extends Box\n      constructor: (args...) -> super @type(), args...\n      type: -> 'brick'\n\nClass: Ball (Box)\n-----------------\n\nAlright, so the ball is a little tricky. It has to move two-\ndimensionally and bounce off of objects.\n\nSo, we need an instance that also stores it's velocity at any\ninstant and the methods to manipulate it.\n\n    class Ball extends Box\n      # -- Private --\n      _velocity: [0, 0]\n\n      # Override getDefault to get default velocity\n      _getDefault: -> _.extend super(), velocity: _.clone @_velocity\n\n      # -- Public --\n      constructor: (args...) ->\n        @_velocity = _.clone @_velocity\n        super @type(), args...\n\n      type: -> 'ball'\n\n      # Set or retrieve velocity\n      velocity: (vel...) ->\n        # Set new velocity\n        if vel.length then @_velocity = [\n          vel[0] ? @_getDefault().velocity[0]         # vx\n\n          # y velocity affects distance from top so inverted to preserve\n          # upward positive velocity direction.\n          (vel[1] ? @_getDefault().velocity[1]) * -1  # vy\n        ]\n\n        # Return velocity\n        _.clone @_velocity\n\n      # Invert velocity\n      bounce: -> @velocity (@_velocity[0] * -1), (@_velocity[1] * -1)\n\nClass: Paddle (Ball)\n--------------------\n\nA paddle is basically an enlarged ball that's constrained to move in a\nstraight line.\n\n    class Paddle extends Ball\n      type: -> 'paddle'\n\n      # Override velocity to constrain 1D motion\n      velocity: (vx) ->\n        if vx?\n          super vx, @_velocity[1]\n        else\n          super()\n\nExports\n-------\n\nList of vars exported to global namespace.\n\n    _.extend window ? module.exports ? this,\n      _: _\n      init: init\n      Box: Box\n      Brick: Brick\n      Ball: Ball\n      Paddle: Paddle\n","old_contents":"Re: [Letter to a Source-Code-Reader](http:\/\/stewd.io\/pong\/lib\/pong.js)\n\nDear Stewart\n\nThanks for inspiring me and many like me with the wonders of js.\nWith all it's warts and issues, JS is still one of my favorite languages.\nI think simply by it's virtue of being the language of the web, it surpasses most others\nin it's ability to champion the spirit of openness.\n\nI have tried to keep this as simple as possible for the many awesome source code lovers\nto read, reuse and critique.\n\nThanks again for caring to write that letter in 2009. It made a kid smile.\n\nDiwank Singh\nJuly 2013\n\n*****\n\nBrowser Bricks\n==============\n\nAlright, let's get on with it.\n\nHelper Functions\n----------------\n\nFirst, let's define some helper functions for the application.\n\n    _ =   # _ namespace\n      # Extend objects\n      extend: (dest, src) ->\n        dest[k] = v for own k, v of src\n        dest\n\n      # Pick properties\n      pick: (obj, props) ->\n        result = {}\n        result[k] = obj[k] for k in props when obj[k]?\n\n        result\n\n      # UUID function (Copied shamelessly from https:\/\/gist.github.com\/bmc\/1893440)\n      uuid: ->\n        'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(\/[xy]\/g, (c) ->\n          r = Math.random() * 16 | 0\n          v = if c is 'x' then r else (r & 0x3|0x8)\n          v.toString(16)\n        )\n\n      # Simple serializer for flat objects\n      serialize: (obj, {sep, eq}, cb) ->\n        # Exec callback on all values of obj\n        obj[k] = cb v for own k, v of obj if cb?\n\n        # Return serialized obj\n        (\"#{ k }#{ eq }#{ v }\" for own k, v of obj).join sep\n\n      # Defer execution of function\n      defer: (fn, args...) -> window.setTimeout fn, 1, args...\n\n      # Clone object\n      clone: (obj) ->\n        # If object extend\n        if obj is Object obj\n          _.extend {}, obj\n\n        else  # Assume it's array otherwise\n          obj.splice 0\n\nInit Function\n-------------\n\nLet's write a global init function that can be used to register callbacks which are\nexecuted 'onload'.\n\n    # Callback register\n    init = do ->\n      # Store registered callbacks\n      callbacks = []\n\n      # Run callbacks in order registered\n      exec = -> fn?() for fn in callbacks\n\n      # Onload callback\n      onLoad = (fn) ->\n        window.removeEventListener 'load', init, false\n        fn?()\n\n      (cb) ->\n        if cb?\n          # Register callback\n          callbacks.push cb\n        else\n          # Defer execution until stack cleared\n          onLoad -> _.defer exec\n\n        false\n\n    # Attach DOM load listener\n    window.addEventListener 'load', init, false\n\nClass: Box\n----------\n\nNow, let's define a box that will be the basic building block for the game.\nAll the objects will inherit from this class.\n\n    class Box\n      # -- Private --\n\n      _settings:\n        # Default settings\n        height: 100\n        width:  200\n        top:    0\n        left:   0\n\n      _props:\n        # Fixed window props\n        toolbar:     false\n        directories: false\n        fullscreen:  false\n        location:    false\n        menubar:     false\n        resizable:   false\n        scrollbars:  false\n        status:      false\n\n      _window: null  # Empty window object\n      _url: '\/index.html' # Fixed to current page, renders based on context\n\n      _EDITABLE: -> Object.keys @constructor::_settings   # Editable settings\n\n      _update: (settings) ->\n        # Update settings\n        _.extend @_settings, (_.pick settings, @_EDITABLE())\n\n        # Adjust window props\n        @_window?.moveTo?   (@_get 'left'), (@_get 'top')\n        @_window?.resizeTo? (@_get 'width'), (@_get 'height')\n\n        # Return a copy of settings\n        @_getAll()\n\n      _get: (prop) -> @_settings[prop] if prop in @_EDITABLE()\n      _getAll: -> _.extend (_.clone @_settings), @_fixed\n\n      _getDefault: -> @constructor::_settings\n\n      # -- Public --\n\n      constructor: (namespace='', settings) ->\n        # Make a copy of default settings\n        @_settings = _.clone @_settings\n\n        # Override settings.\n        @_update settings\n\n        # Set random name with namespace\n        @id = \"#{ namespace }#{ if namespace then '-' else '' }#{ _.uuid() }\"\n        this\n\n      # Show window with settings.\n      show: ->\n        # Serialize options\n        opts = _.serialize @_getAll(), {sep: ',', eq: '='}, (v) ->\n          switch v\n            when false then 'no'\n            when true then 'yes'\n            else v+''\n\n        @_window = window.open @_url, @id, opts\n        this\n\n      # Hide the window.\n      hide: ->\n        @_window.close()\n        @_window = null\n        this\n\n      # Check if window is visible.\n      isVisible: -> @_window?.location?\n\n      # Reset window settings.\n      reset: ->\n        @_update @_getDefault()\n        this\n\n      # Return or update window position coords.\n      position: (coords...) ->\n        # Set new coords\n        if coords.length then @_update\n          left: coords[0] ? @_getDefault().left  # x\n          top:  coords[1] ? @_getDefault().top   # y\n\n        # Return coords\n        _.pick @_getAll(), ['top', 'left']\n\n      # Return or update window dimensions.\n      size: (dimensions...) ->\n        # Set new dimensions\n        if dimensions.length then @_update\n          width:  dimensions[0] ? @_getDefault().width\n          height: dimensions[1] ? @_getDefault().height\n\n        # Return dimensions\n        _.pick @_getAll(), ['width', 'height']\n\nClass: Brick (Box)\n------------------\n\nNow let's use the class `Box` to design the `Brick` class which\nwill be used to render the bricks.\n\nIt's pretty much a useless box.\n\n    class Brick extends Box\n      constructor: (args...) -> super @type(), args...\n      type: -> 'brick'\n\nClass: Ball (Box)\n-----------------\n\nAlright, so the ball is a little tricky. It has to move two-\ndimensionally and bounce off of objects.\n\nSo, we need an instance that also stores it's velocity at any\ninstant and the methods to manipulate it.\n\n    class Ball extends Box\n      # -- Private --\n      _velocity: [0, 0]\n\n      # Override getDefault to get default velocity\n      _getDefault: -> _.extend super(), velocity: _.clone @_velocity\n\n      # -- Public --\n      constructor: (args...) ->\n        @_velocity = _.clone @_velocity\n        super @type(), args...\n\n      type: -> 'ball'\n\n      # Set or retrieve velocity\n      velocity: (vel...) ->\n        # Set new velocity\n        if vel.length then @_velocity = [\n          vel[0] ? @_getDefault().velocity[0]         # vx\n\n          # y velocity affects distance from top so inverted to preserve\n          # upward positive velocity direction.\n          (vel[1] ? @_getDefault().velocity[1]) * -1  # vy\n        ]\n\n        # Return velocity\n        _.clone @_velocity\n\nClass: Paddle (Ball)\n--------------------\n\nA paddle is basically an enlarged ball that's constrained to move in a\nstraight line.\n\n    class Paddle extends Ball\n      type: -> 'paddle'\n\n      # Override velocity to constrain 1D motion\n      velocity: (vx) ->\n        if vx?\n          super vx, @_velocity[1]\n        else\n          super()\n\nExports\n-------\n\nList of vars exported to global namespace.\n\n    _.extend window ? module.exports ? this,\n      _: _\n      init: init\n      Box: Box\n      Brick: Brick\n      Ball: Ball\n      Paddle: Paddle\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6ae2363ba1676a1d8bae961750ed0ea69ecf81bc","subject":"value to string","message":"value to string\n","repos":"vpj\/models","old_file":"js\/properties\/value.litcoffee","new_file":"js\/properties\/value.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#Value\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       propertyType: 'value'\n\n       @default 'value', (str, stack) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value, stack) -> \"#{str}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str, stack) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str, stack) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value, stack) ->\n        value is @schema.default()\n\n       parse: (data, stack) ->\n        r = super data, stack\n        return r unless r is true\n        if not @schema.valid data, stack\n         return @error 'invalid'\n\n        return {\n         score: 1\n         errors: []\n         value: @schema.value data, stack\n        }\n\n       toJSON: (value, stack) -> value\n       toJSONFull: (value, stack) -> value\n\n       edit: (elem, value, onChanged, stack) ->\n        new Edit this, elem, value, onChanged, stack\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, onChanged, stack) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = onChanged\n        @stack = stack\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           placeholder: @$.property._name\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = schema.string @value, @stack\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n        @change()\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value, @stack\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r, i in results\n          break if i > 10\n          e = @div r\n          e._result = r\n\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @elems.search.style.display = 'none'\n        @change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 400\n\n       @listen 'change', (e) ->\n        @search()\n        @change()\n\n       change: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value, @stack\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value, @stack\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#Value\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       propertyType: 'value'\n\n       @default 'value', (str, stack) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value, stack) -> \"#{str}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str, stack) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str, stack) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value, stack) ->\n        value is @schema.default()\n\n       parse: (data, stack) ->\n        r = super data, stack\n        return r unless r is true\n        if not @schema.valid data, stack\n         return @error 'invalid'\n\n        return {\n         score: 1\n         errors: []\n         value: @schema.value data, stack\n        }\n\n       toJSON: (value, stack) -> value\n       toJSONFull: (value, stack) -> value\n\n       edit: (elem, value, onChanged, stack) ->\n        new Edit this, elem, value, onChanged, stack\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, onChanged, stack) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = onChanged\n        @stack = stack\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           placeholder: @$.property._name\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = @value\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n        @change()\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value, @stack\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r, i in results\n          break if i > 10\n          e = @div r\n          e._result = r\n\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @elems.search.style.display = 'none'\n        @change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 400\n\n       @listen 'change', (e) ->\n        @search()\n        @change()\n\n       change: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value, @stack\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value, @stack\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f2ea639f83ed89aa05e065e9a007dd1f5de5b054","subject":"documenting custom templates and the need for stylesheets","message":"documenting custom templates and the need for stylesheets\n","repos":"lbn\/docco,oponder\/docco,guigrpa\/docco-extended,DoomHammer\/docco,whitetrefoil\/docco,ShawnHuang\/docco-multidir,MaxwellRebo\/docco,oponder\/docco,guigrpa\/docco,Hellyna\/docco,jalleyne\/docco,gvithellyna\/docco,lobrien\/docco,jrvidal\/docco,guigrpa\/docco-extended,jrvidal\/docco,robertmackenzie\/docco,DoomHammer\/docco,tbremer\/docco,osharim\/docco,robertmackenzie\/docco,MaxwellRebo\/docco,guigrpa\/docco,mhkeller\/docco,gvithellyna\/docco,whitetrefoil\/docco,osharim\/docco,lbn\/docco,tbremer\/docco,Hellyna\/docco,jalleyne\/docco,ShawnHuang\/docco-multidir,lobrien\/docco,mhkeller\/docco","old_file":"docco.litcoffee","new_file":"docco.litcoffee","new_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* For all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        isText = maybeCode = yes\n        for line, i in lines\n          lines[i] = if maybeCode and match = \/^([ ]{4}|[ ]{0,3}\\t)\/.exec line\n            isText = no\n            line[match[0].length..]\n          else if maybeCode = \/^\\s*$\/.test line\n            if isText then lang.symbol else ''\n          else\n            isText = yes\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n\nPass any user defined options to Marked if specified via command line option\n\n      markedOptions =\n        smartypants: true\n\n      if config.marked\n        markedOptions = config.marked\n\n      marked.setOptions markedOptions\n\nTell Marked how to highlight code blocks within comments, treating that code\nas either the language specified in the code block or the language of the file\nif not specified.\n\n      marked.setOptions {\n        highlight: (code, lang) ->\n          lang or= language.name\n\n          if highlightjs.getLanguage(lang)\n            highlightjs.highlight(lang, code).value\n          else\n            console.warn \"docco: couldn't highlight code block with unknown language '#{lang}' in #{source}\"\n            code\n      }\n\n      for section, i in sections\n        code = highlightjs.highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, file + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      firstSection = _.find sections, (section) ->\n        section.docsText.length > 0\n      first = marked.lexer(firstSection.docsText)[0] if firstSection\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n      marked:     null\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      config.languages = buildMatchers config.languages\n\nThe user is able to override the layout file used with the `--template` parameter.\nIn this case, it is also neccessary to explicitly specify a stylesheet file.\nThese custom templates are compiled exactly like the predefined ones, but the `public` folder\nis only copied for the latter.\n\n      if options.template\n        unless options.css\n          console.warn \"docco: no stylesheet file specified\"\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      if options.marked\n        config.marked = JSON.parse fs.readFileSync(options.marked)\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    highlightjs = require 'highlight.js'\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages?[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [file]', 'use a custom languages.json', _.compose JSON.parse, fs.readFileSync)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .option('-m, --marked [file]',    'use custom marked options', c.marked)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","old_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* For all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        isText = maybeCode = yes\n        for line, i in lines\n          lines[i] = if maybeCode and match = \/^([ ]{4}|[ ]{0,3}\\t)\/.exec line\n            isText = no\n            line[match[0].length..]\n          else if maybeCode = \/^\\s*$\/.test line\n            if isText then lang.symbol else ''\n          else\n            isText = yes\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n\nPass any user defined options to Marked if specified via command line option\n\n      markedOptions =\n        smartypants: true\n\n      if config.marked\n        markedOptions = config.marked\n\n      marked.setOptions markedOptions\n\nTell Marked how to highlight code blocks within comments, treating that code\nas either the language specified in the code block or the language of the file\nif not specified.\n\n      marked.setOptions {\n        highlight: (code, lang) ->\n          lang or= language.name\n\n          if highlightjs.getLanguage(lang)\n            highlightjs.highlight(lang, code).value\n          else\n            console.warn \"docco: couldn't highlight code block with unknown language '#{lang}' in #{source}\"\n            code\n      }\n\n      for section, i in sections\n        code = highlightjs.highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, file + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      firstSection = _.find sections, (section) ->\n        section.docsText.length > 0\n      first = marked.lexer(firstSection.docsText)[0] if firstSection\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n      marked:     null\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      config.languages = buildMatchers config.languages\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      if options.marked\n        config.marked = JSON.parse fs.readFileSync(options.marked)\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    highlightjs = require 'highlight.js'\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages?[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [file]', 'use a custom languages.json', _.compose JSON.parse, fs.readFileSync)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .option('-m, --marked [file]',    'use custom marked options', c.marked)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"18b2530a720ba8fc2879c58d34358469e9e711b1","subject":"Use post-for","message":"Use post-for","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_contents":"nodePush Pushserver\n===================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nFirst we import the required packages and make them available in a global variable.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nNext we try to load the configuration file \"config.js\".\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nIn case not every configuration property is set we initialize it with a default property.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nWe continue with creating some helper functions.\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\t\n\tfs.open \"#{__dirname}\/..\/tmp\/nodePush.child.pid\", \"w\", 0o600, (err, fd) ->\n\t\tfs.writeSync fd, process.pid\n\t\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.wcf ?= {}\n\nbe.bastelstu.wcf.nodePush\n=========================\n\n\tclass be.bastelstu.wcf.nodePush\n\t\nAttributes\n----------\n\n`app` will become an instance of `express`.\n\n\t\tapp: null\n\n`server` willbecome an instance of `http`.\n\n\t\tserver: null\n\n`io` will become an instance of `socket.io`.\n\n\t\tio: null\n\n`stats` is an object with the different statistics recorded. Statistics will be shown on the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**  \nThe constructor is executed when the class is initialized. It prints some helpful information,\nsuch as the PID and the used sockets and continues with initializing everything.\n\n\t\tconstructor: ->\n\t\t\tlog \"nodePush running (pid:#{process.pid})\"\n\nFirst we display the used inbound and outbound sockets.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\nAfterwards we initialize the inbound and outbound connection.\n\n\t\t\t@initInbound()\n\t\t\t@initOutbound()\n\nIn order to do a proper cleanup on shutdown we bind the `shutdown` method to the needed events and signals.\n\n\t\t\tprocess.on 'exit', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'uncaughtException', (message) =>\n\t\t\t\t@shutdown message, 1\n\t\t\tprocess.on 'SIGINT', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGTERM', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGHUP', =>\n\t\t\t\t@shutdown null, 2\n\nAt the end we set a nice title for `ps`.\n\n\t\t\tprocess.title = 'nodePush'\n\n**initOutbound()**  \n`initOutbound` initializes the connection to the browser. That includes starting the HTTP server and preparing\nsocket.io.\n\n\t\tinitOutbound: ->\n\t\t\tlog 'Initializing outbound socket'\n\nFirst we start the express based HTTP server.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\nAfterwards we set socket.io configuration for the default environment. Files will be minified and logging reduced to a minimum.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nIn case `env` is set to development we show some more debug output.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nNext we listen on the socket.io `connection` event to record statistics.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++ if @app.get('env') is 'development'\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'userID', (userID) =>\n\t\t\t\t\tsocket.get 'userID', (_, currentUserID) =>\n\nIn case a client misbehaves, by sending the `userID` twice, we `disconnect` it.\n\n\t\t\t\t\t\tif currentUserID?\n\t\t\t\t\t\t\tsocket.disconnect()\n\t\t\t\t\t\t\treturn\n\nMark user as *authenticated* by joining **user**. If a client does not send a `userID` it will not receive any messages.\n\n\t\t\t\t\t\tsocket.set 'userID', userID\n\t\t\t\t\t\tsocket.join 'authenticated'\n\t\t\t\t\t\tsocket.join \"user#{userID}\"\n\t\t\t\t\t\tsocket.emit 'authenticated'\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\t\t\t\t\t\t\t\nWe continue with creating a callback for the `listen` call.\n\n\t\t\tlistenCallback = =>\n\nIn case we are running as root we try to shed root privilegies. If this is not possible we exit, as a service\nrunning as root is dangerous.\n\n\t\t\t\tif process.getuid? and (process.getuid() is 0 or process.getgid() is 0)\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nAfter the the HTTP server is listening and we are no longer running as root we start some intervals for the builtin tick events.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\nStart listening on the configured outbound socket.\n\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\nShow detailed information when environment is `development`.\n\n\t\t\t\tif @app.get('env') is 'development'\n\t\t\t\t\t@stats.status++\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\t\tMessages:\n\t\t\t\t\t\"\"\"\n\t\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\telse\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now\n\t\t\t\t\t\"\"\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name, userIDs = [ ]) ->\n\t\t\treturn unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test name\n\t\t\t\n\t\t\tif name is 'be.bastelstu.wcf.nodePush._restart'\n\t\t\t\tprocess.kill process.pid, 'SIGHUP'\n\t\t\t\n\t\t\tif @app.get('env') is 'development'\n\t\t\t\t@stats.messages[name] ?= 0\n\t\t\t\t@stats.messages[name]++\n\t\t\t\n\t\t\tif userIDs.length\n\t\t\t\t@io.sockets.in(\"user#{userID}\").send name for userID in userIDs\n\t\t\telse\n\t\t\t\t@io.sockets.in('authenticated').send name\n\n**initInbound()**  \n`initInbound` initializes the PHP side socket.\n\n\t\tinitInbound: ->\n\t\t\tlog 'Initializing inbound socket'\n\nWe start by creating a server.\n\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++ if @app.get('env') is 'development'\n\nIn case data is written to the server we pass it to the connected browsers and close the connection afterwards.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\t[ message, userIDs ] = data.toString().trim().split \/:\/\n\t\t\t\t\tif userIDs? and userIDs.length\n\t\t\t\t\t\tuserIDs = userIDs.split \/,\/\n\t\t\t\t\t\tuserIDs = (parseInt userID for userID in userIDs when not isNaN parseInt userID)\n\t\t\t\t\telse\n\t\t\t\t\t\tuserIDs = [ ]\n\t\t\t\t\t\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage message, userIDs\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nIn case nothing happens within 5 seconds we close the connection in order to save resources.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\nAfter all callbacks are bound we start listening.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \n`shutdown` performs a clean shutdown of nodePush. It cleans up the unix socket files.\n\n\t\tshutdown: (message = null, code = 0) ->\n\t\t\tif message?\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\telse\n\t\t\t\tlog 'Shutting down'\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket if not config.inbound.useTCP and fs.existsSync config.inbound.socket\n\t\t\tfs.unlinkSync config.outbound.socket if not config.outbound.useTCP and fs.existsSync config.outbound.socket\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit code\n\nIn the end we finally initialize the class with starts all the services.\n\n\tnew be.bastelstu.wcf.nodePush()\n","old_contents":"nodePush Pushserver\n===================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nFirst we import the required packages and make them available in a global variable.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nNext we try to load the configuration file \"config.js\".\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nIn case not every configuration property is set we initialize it with a default property.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nWe continue with creating some helper functions.\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\t\n\tfs.open \"#{__dirname}\/..\/tmp\/nodePush.child.pid\", \"w\", 0o600, (err, fd) ->\n\t\tfs.writeSync fd, process.pid\n\t\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.wcf ?= {}\n\nbe.bastelstu.wcf.nodePush\n=========================\n\n\tclass be.bastelstu.wcf.nodePush\n\t\nAttributes\n----------\n\n`app` will become an instance of `express`.\n\n\t\tapp: null\n\n`server` willbecome an instance of `http`.\n\n\t\tserver: null\n\n`io` will become an instance of `socket.io`.\n\n\t\tio: null\n\n`stats` is an object with the different statistics recorded. Statistics will be shown on the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**  \nThe constructor is executed when the class is initialized. It prints some helpful information,\nsuch as the PID and the used sockets and continues with initializing everything.\n\n\t\tconstructor: ->\n\t\t\tlog \"nodePush running (pid:#{process.pid})\"\n\nFirst we display the used inbound and outbound sockets.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\nAfterwards we initialize the inbound and outbound connection.\n\n\t\t\t@initInbound()\n\t\t\t@initOutbound()\n\nIn order to do a proper cleanup on shutdown we bind the `shutdown` method to the needed events and signals.\n\n\t\t\tprocess.on 'exit', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'uncaughtException', (message) =>\n\t\t\t\t@shutdown message, 1\n\t\t\tprocess.on 'SIGINT', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGTERM', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGHUP', =>\n\t\t\t\t@shutdown null, 2\n\nAt the end we set a nice title for `ps`.\n\n\t\t\tprocess.title = 'nodePush'\n\n**initOutbound()**  \n`initOutbound` initializes the connection to the browser. That includes starting the HTTP server and preparing\nsocket.io.\n\n\t\tinitOutbound: ->\n\t\t\tlog 'Initializing outbound socket'\n\nFirst we start the express based HTTP server.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\nAfterwards we set socket.io configuration for the default environment. Files will be minified and logging reduced to a minimum.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nIn case `env` is set to development we show some more debug output.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nNext we listen on the socket.io `connection` event to record statistics.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++ if @app.get('env') is 'development'\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'userID', (userID) =>\n\t\t\t\t\tsocket.get 'userID', (_, currentUserID) =>\n\nIn case a client misbehaves, by sending the `userID` twice, we `disconnect` it.\n\n\t\t\t\t\t\tif currentUserID?\n\t\t\t\t\t\t\tsocket.disconnect()\n\t\t\t\t\t\t\treturn\n\nMark user as *authenticated* by joining **user**. If a client does not send a `userID` it will not receive any messages.\n\n\t\t\t\t\t\tsocket.set 'userID', userID\n\t\t\t\t\t\tsocket.join 'authenticated'\n\t\t\t\t\t\tsocket.join \"user#{userID}\"\n\t\t\t\t\t\tsocket.emit 'authenticated'\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\t\t\t\t\t\t\t\nWe continue with creating a callback for the `listen` call.\n\n\t\t\tlistenCallback = =>\n\nIn case we are running as root we try to shed root privilegies. If this is not possible we exit, as a service\nrunning as root is dangerous.\n\n\t\t\t\tif process.getuid? and (process.getuid() is 0 or process.getgid() is 0)\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nAfter the the HTTP server is listening and we are no longer running as root we start some intervals for the builtin tick events.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\nStart listening on the configured outbound socket.\n\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\nShow detailed information when environment is `development`.\n\n\t\t\t\tif @app.get('env') is 'development'\n\t\t\t\t\t@stats.status++\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\t\tMessages:\n\t\t\t\t\t\"\"\"\n\t\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\telse\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now\n\t\t\t\t\t\"\"\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name, userIDs = [ ]) ->\n\t\t\treturn unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test name\n\t\t\t\n\t\t\tif name is 'be.bastelstu.wcf.nodePush._restart'\n\t\t\t\tprocess.kill process.pid, 'SIGHUP'\n\t\t\t\n\t\t\tif @app.get('env') is 'development'\n\t\t\t\t@stats.messages[name] ?= 0\n\t\t\t\t@stats.messages[name]++\n\t\t\t\n\t\t\tif userIDs.length\n\t\t\t\tfor userID in userIDs\n\t\t\t\t\t@io.sockets.in(\"user#{userID}\").send name\n\t\t\telse\n\t\t\t\t@io.sockets.in('authenticated').send name\n\n**initInbound()**  \n`initInbound` initializes the PHP side socket.\n\n\t\tinitInbound: ->\n\t\t\tlog 'Initializing inbound socket'\n\nWe start by creating a server.\n\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++ if @app.get('env') is 'development'\n\nIn case data is written to the server we pass it to the connected browsers and close the connection afterwards.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\t[ message, userIDs ] = data.toString().trim().split \/:\/\n\t\t\t\t\tif userIDs? and userIDs.length\n\t\t\t\t\t\tuserIDs = userIDs.split \/,\/\n\t\t\t\t\t\tuserIDs = (parseInt userID for userID in userIDs when not isNaN parseInt userID)\n\t\t\t\t\telse\n\t\t\t\t\t\tuserIDs = [ ]\n\t\t\t\t\t\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage message, userIDs\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nIn case nothing happens within 5 seconds we close the connection in order to save resources.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\nAfter all callbacks are bound we start listening.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \n`shutdown` performs a clean shutdown of nodePush. It cleans up the unix socket files.\n\n\t\tshutdown: (message = null, code = 0) ->\n\t\t\tif message?\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\telse\n\t\t\t\tlog 'Shutting down'\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket if not config.inbound.useTCP and fs.existsSync config.inbound.socket\n\t\t\tfs.unlinkSync config.outbound.socket if not config.outbound.useTCP and fs.existsSync config.outbound.socket\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit code\n\nIn the end we finally initialize the class with starts all the services.\n\n\tnew be.bastelstu.wcf.nodePush()","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"7b2b8af99459d252aba6131c8590439c7e344a69","subject":"fixed copy\/paste created typos","message":"fixed copy\/paste created typos\n","repos":"nhz-io\/cnl","old_file":"source\/test\/element.litcoffee","new_file":"source\/test\/element.litcoffee","new_contents":"# TEST CLASS: Element\n* Parent: [Index][Parent]\n\n---\n\n    should = require 'should'\n    module.exports = (Element, name='Element') ->\n\n      describe name, ->\n        it 'should be a class', -> Element.should.be.a.class\n\n---\n\n## CONSTRUCTOR\n\n        describe '#constructor(args)', ->\n          it 'should return an instance of Element', ->\n            (new Element).should.be.an.instanceof Element\n\nConstructor should copy the **origin** passed as named arguments into the instance\n\n          it 'should copy the origin to the instance', ->\n            element = new Element origin: (origin = x:10, y:20)\n            element.origin.x.should.be.equal 10\n            element.origin.y.should.be.equal 20\n            element.origin.should.not.be.equal origin\n\n---\n\n## METHODS\n\n        describe '#localizeEventCoordinates(event)', ->\n          it 'should localize event coordinates', ->\n            element = new Element origin: x:5, y:10\n            event = x:10, y:20\n            element.localizeEventCoordinates event\n            event.localX.should.be.equal 5\n            event.localY.should.be.equal 10\n\n---\n\n## LISTENERS\n\nMousemove capturing listener should store the event in the runtime\nand localize the event coordinates.\n\n        describe '#mousemoveCaptureListener', ->\n          it 'should return the element', ->\n            (element = new Element)\n              .mousemoveCaptureListener()\n              .should.be.equal element\n\n          it 'should store the event in #___runtime', ->\n            (new Element)\n              .mousemoveCaptureListener('test')\n              .___runtime.mousemoveEvent.should.be.equal 'test'\n\n          it 'should localize the event coordinates', ->\n            (new Element origin: x:10, y:20)\n              .mousemoveCaptureListener (event = x:15, y:30)\n            event.localX.should.be.equal 5\n            event.localY.should.be.equal 10\n\n---\n\nMousedown capturing listener should store the event in the runtime\nand localize the event coordinates.\n\n        describe '#mousedownCaptureListener', ->\n          it 'should return the element', ->\n            (element = new Element)\n              .mousedownCaptureListener()\n              .should.be.equal element\n\n          it 'should store the event in #___runtime', ->\n            (new Element)\n              .mousedownCaptureListener('test')\n              .___runtime.mousedownEvent.should.be.equal 'test'\n\n          it 'should localize the event coordinates', ->\n            (new Element origin: x:10, y:20)\n              .mousedownCaptureListener (event = x:15, y:30)\n            event.localX.should.be.equal 5\n            event.localY.should.be.equal 10\n\n---\n\nMouseup capturing listener should store the event in the runtime\nand localize the event coordinates.\n\n        describe '#mouseupCaptureListener', ->\n          it 'should return the element', ->\n            (element = new Element)\n              .mouseupCaptureListener()\n              .should.be.equal element\n\n          it 'should store the event in #___runtime', ->\n            (new Element)\n              .mouseupCaptureListener('test')\n              .___runtime.mouseupEvent.should.be.equal 'test'\n\n          it 'should localize the event coordinates', ->\n            (new Element origin: x:10, y:20)\n              .mouseupCaptureListener (event = x:15, y:30)\n            event.localX.should.be.equal 5\n            event.localY.should.be.equal 10\n\n---\n\nMousemove listener. A stub for descendants to call `super` on.\n\n        describe '#mousemoveListener', ->\n          it 'should return the element', ->\n            (element = new Element)\n              .mousemoveListener()\n              .should.be.equal element\n\n---\n\nMousedown listener. A stub for descendants to call `super` on.\n\n        describe '#mousedownListener', ->\n          it 'should return the element', ->\n            (element = new Element)\n              .mousedownListener()\n              .should.be.equal element\n\n---\n\nMouseup listener. A stub for descendants to call `super` on.\n\n        describe '#mouseupListener', ->\n          it 'should return the element', ->\n            (element = new Element)\n              .mouseupListener()\n              .should.be.equal element\n\n[Element#constructor]: ..\/element.litcoffee#constructor\n[Parent]: .\/index.litcoffee\n","old_contents":"# TEST CLASS: Element\n* Parent: [Index][Parent]\n\n---\n\n    should = require 'should'\n    module.exports = (Element, name='Element') ->\n\n      describe name, ->\n        it 'should be a class', -> Element.should.be.a.class\n\n---\n\n## CONSTRUCTOR\n\n        describe '#constructor(args)', ->\n          it 'should return an instance of Element', ->\n            (new Element).should.be.an.instanceof Element\n\nConstructor should copy the **origin** passed as named arguments into the instance\n\n          it 'should copy the origin to the instance', ->\n            element = new Element origin: (origin = x:10, y:20)\n            element.origin.x.should.be.equal 10\n            element.origin.y.should.be.equal 20\n            element.origin.should.not.be.equal origin\n\n---\n\n## METHODS\n\n        describe '#localizeEventCoordinates(event)', ->\n          it 'should localize event coordinates', ->\n            element = new Element origin: x:5, y:10\n            event = x:10, y:20\n            element.localizeEventCoordinates event\n            event.localX.should.be.equal 5\n            event.localY.should.be.equal 10\n\n---\n\n## LISTENERS\n\nMousemove capturing listener should store the event in the runtime\nand localize the event coordinates.\n\n        describe '#mousemoveCaptureListener', ->\n          it 'should return the element', ->\n            (element = new Element)\n              .mousemoveCaptureListener()\n              .should.be.equal element\n\n          it 'should store the event in #___runtime', ->\n            (new Element)\n              .mousemoveCaptureListener('test')\n              .___runtime.mousemoveEvent.should.be.equal 'test'\n\n          it 'should localize the event coordinates', ->\n            (new Element origin: x:10, y:20)\n              .mousemoveCaptureListener (event = x:15, y:30)\n            event.localX.should.be.equal 5\n            event.localY.should.be.equal 10\n\n---\n\nMousedown capturing listener should store the event in the runtime\nand localize the event coordinates.\n\n        describe '#mousedownCaptureListener', ->\n          it 'should return the element', ->\n            (element = new Element)\n              .mousedownCaptureListener()\n              .should.be.equal element\n\n          it 'should store the event in #___runtime', ->\n            (new Element)\n              .mousedownCaptureListener('test')\n              .___runtime.mousedownEvent.should.be.equal 'test'\n\n          it 'should localize the event coordinates', ->\n            (new Element origin: x:10, y:20)\n              .mousedownCaptureListener (event = x:15, y:30)\n            event.localX.should.be.equal 5\n            event.localY.should.be.equal 10\n\n---\n\nMouseup capturing listener should store the event in the runtime\nand localize the event coordinates.\n\n        describe '#mouseupCaptureListener', ->\n          it 'should return the element', ->\n            (element = new Element)\n              .mouseupCaptureListener()\n              .should.be.equal element\n\n          it 'should store the event in #___runtime', ->\n            (new Element)\n              .mouseupCaptureListener('test')\n              .___runtime.mouseupEvent.should.be.equal 'test'\n\n          it 'should localize the event coordinates', ->\n            (new Element origin: x:10, y:20)\n              .mouseupCaptureListener (event = x:15, y:30)\n            event.localX.should.be.equal 5\n            event.localY.should.be.equal 10\n\n---\n\nMousemove listener. A stub for descendants to call `super` on.\n\n        describe '#mousemoveListener', ->\n          it 'should return the element', ->\n            (element = new Element)\n              .mousemoveCaptureListener()\n              .should.be.equal element\n\n---\n\nMousedown listener. A stub for descendants to call `super` on.\n\n        describe '#mousedownListener', ->\n          it 'should return the element', ->\n            (element = new Element)\n              .mousedownCaptureListener()\n              .should.be.equal element\n\n---\n\nMouseup listener. A stub for descendants to call `super` on.\n\n        describe '#mouseupListener', ->\n          it 'should return the element', ->\n            (element = new Element)\n              .mouseupCaptureListener()\n              .should.be.equal element\n\n[Element#constructor]: ..\/element.litcoffee#constructor\n[Parent]: .\/index.litcoffee\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f67bf76e0aeb040ac47c0afd6d87cf7bcec2c583","subject":"NativeItem doc XXX -> XYZ","message":"NativeItem doc XXX -> XYZ\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/renderer\/types\/basics\/item\/types\/native.litcoffee","new_file":"src\/renderer\/types\/basics\/item\/types\/native.litcoffee","new_contents":"# Native\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    assert = require 'src\/assert'\n    colorUtils = require 'src\/renderer\/utils\/color'\n\n    IS_NATIVE = not utils.isServer and not utils.isBrowser\n\n    if IS_NATIVE\n        nativeBridge = require 'src\/native'\n\n# **Class** Native : *Item*\n\n    module.exports = (Renderer, Impl, itemUtils) ->\n\n        class Native extends Renderer.Item\n            @__name__ = 'Native'\n            @__path__ = 'Renderer.Native'\n\n            @New = (component, opts) ->\n                item = new @\n                itemUtils.Object.initialize item, component, opts\n                unless IS_NATIVE\n                    item.onParentChange Impl.updateNativeSize\n                @Initialize? item\n                item\n\n## Native.defineProperty(*Object* config)\n\nDefines new property with the given name.\n\nFor each property, signal `onXYZChange` is created,\nwhere `XYZ` is the given name.\n\n`config` parameter must be an object with specified keys:\n- `enabled` - whether it's supported on current platform,\n- `name` - name of the property,\n- `type` - type of predefined condifuration described below,\n- `defaultValue`,\n- `setter`,\n- `getter`,\n- `developmentSetter`\n- `implementationValue` - function returning value passed to the implementation.\n\n### Predefined types\n\n            PROPERTY_TYPES = Object.create null\n\n#### text\n\n            PROPERTY_TYPES.text = ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n\n#### number\n\n            PROPERTY_TYPES.number = ->\n                defaultValue: 0\n                developmentSetter: (val) ->\n                    assert.isFloat val\n\n#### boolean\n\n            PROPERTY_TYPES.boolean = ->\n                defaultValue: false\n                developmentSetter: (val) ->\n                    assert.isBoolean val\n\n#### color\n\n            PROPERTY_TYPES.color = (config) ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n                implementationValue: (val) ->\n                    if IS_NATIVE\n                        colorUtils.toRGBAHex val, config.defaultValue\n                    else\n                        val\n\n            @defineProperty = (config) ->\n                itemName = @__name__\n                properties = @_properties ||= []\n                config = utils.clone config\n\n                assert.isString itemName, '''\n                    NativeItem.__name__ unique name must be specified\n                '''\n                assert.isObject config, '''\n                    NativeItem.defineProperty config parameter must be an object\n                '''\n                assert.isString config.name, '''\n                    NativeItem property name must be a string\n                '''\n                assert.isNotDefined properties[config.name], \"\"\"\n                    Property #{config.name} is already defined\n                \"\"\"\n                assert.isDefined PROPERTY_TYPES[config.type], \"\"\"\n                    Unknown property type #{config.type}\n                \"\"\" if config.type\n\n                # type\n                if typeConfigFunc = PROPERTY_TYPES[config.type]\n                    typeConfig = typeConfigFunc(config)\n                    for key, val of typeConfig\n                        if key not of config\n                            config[key] = val\n\n                # constructor\n                config.constructor = @\n\n                # internalName\n                config.internalName = itemUtils.getPropInternalName config.name\n\n                # implementation\n                config.implementation = do ->\n                    if config.enabled is false\n                        return utils.NOP\n\n                    ctorName = utils.capitalize itemName\n                    name = utils.capitalize config.name\n                    if IS_NATIVE\n                        funcName = \"rendererSet#{ctorName}#{name}\"\n                        (val) ->\n                            nativeBridge.callFunction funcName, @_impl.id, val\n                    else\n                        funcName = \"set#{ctorName}#{name}\"\n                        (val) ->\n                            Impl[funcName].call @, val\n\n                # save\n                properties.push config\n\n                # create\n                itemUtils.defineProperty config\n\n            constructor: ->\n                super()\n\n                unless IS_NATIVE\n                    @_autoWidth = true\n                    @_autoHeight = true\n                    @_width = -1\n                    @_height = -1\n\n                # save properties with default values\n                if properties = @constructor._properties\n                    for property in properties\n                        @[property.internalName] = property.defaultValue\n\n            unless IS_NATIVE\n                _width: -1\n                getter = utils.lookupGetter @::, 'width'\n                itemWidthSetter = utils.lookupSetter @::, 'width'\n                utils.defineProperty @::, 'width', null, getter,\n                    do (_super = itemWidthSetter) -> (val) ->\n                        if @_autoWidth = val is -1\n                            _super.call @, @_contentWidth\n                            Impl.updateNativeSize.call @\n                        else\n                            _super.call @, val\n                        return\n\n                _height: -1\n                getter = utils.lookupGetter @::, 'height'\n                itemHeightSetter = utils.lookupSetter @::, 'height'\n                utils.defineProperty @::, 'height', null, getter,\n                    do (_super = itemHeightSetter) -> (val) ->\n                        if @_autoHeight = val is -1\n                            _super.call @, @_contentHeight\n                            Impl.updateNativeSize.call @\n                        else\n                            _super.call @, val\n                        return\n\n## Native::set(*String* propName, *Any* val)\n\n            set: (name, val) ->\n                assert.isString name\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    funcName = \"rendererSet#{ctorName}#{name}\"\n                    nativeBridge.callFunction funcName, id, val\n                else\n                    funcName = \"set#{ctorName}#{name}\"\n                    Impl[funcName].call @, val\n                return\n\n## Native::call(*String* funcName, *Any* args...)\n\n            call: (name, args...) ->\n                assert.isString name\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    funcName = \"rendererCall#{ctorName}#{name}\"\n                    callArgs = [funcName, id, args...]\n                    nativeBridge.callFunction.apply nativeBridge, callArgs\n                else\n                    funcName = \"call#{ctorName}#{name}\"\n                    Impl[funcName].apply @, args\n                return\n\n## Native::on(*String* eventName, *Function* listener)\n\n            # nativeEventName -> item id -> [item, listeners...]\n            eventListeners = Object.create null\n\n            createNativeEventListener = (listeners, eventName) -> (id) ->\n                unless itemListeners = listeners[id]\n                    log.warn \"Got a native event '#{eventName}' for an item which \" +\n                        \"didn't register a listener on this event; check if you \" +\n                        \"properly call 'on()' method with a signal listener\"\n                    return\n\n                length = arguments.length\n                args = new Array length - 1\n                for i in [0...length-1] by 1\n                    args[i] = arguments[i + 1]\n\n                item = itemListeners[0]\n                for i in [1...itemListeners.length] by 1\n                    itemListeners[i].apply item, args\n\n                return\n\n            on: (name, func) ->\n                assert.isString name\n                assert.isFunction func\n\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    ctorName = utils.capitalize @constructor.__name__\n                    eventName = \"rendererOn#{ctorName}#{name}\"\n\n                    unless listeners = eventListeners[eventName]\n                        listeners = eventListeners[eventName] = Object.create(null)\n                        nativeBridge.on eventName, createNativeEventListener(listeners, eventName)\n\n                    itemListeners = listeners[@_impl.id] ?= [@]\n                    itemListeners.push func\n                else\n                    eventName = \"on#{name}\"\n                    @_impl[eventName].connect func\n                return\n\n        Native\n\n# Glossary\n\n- [Native](#class-native)\n","old_contents":"# Native\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    assert = require 'src\/assert'\n    colorUtils = require 'src\/renderer\/utils\/color'\n\n    IS_NATIVE = not utils.isServer and not utils.isBrowser\n\n    if IS_NATIVE\n        nativeBridge = require 'src\/native'\n\n# **Class** Native : *Item*\n\n    module.exports = (Renderer, Impl, itemUtils) ->\n\n        class Native extends Renderer.Item\n            @__name__ = 'Native'\n            @__path__ = 'Renderer.Native'\n\n            @New = (component, opts) ->\n                item = new @\n                itemUtils.Object.initialize item, component, opts\n                unless IS_NATIVE\n                    item.onParentChange Impl.updateNativeSize\n                @Initialize? item\n                item\n\n## Native.defineProperty(*Object* config)\n\nDefines new property with the given name.\n\nFor each property, signal `onXXXChange` is created,\nwhere `XXX` is the given name.\n\n`config` parameter must be an object with specified keys:\n- `enabled` - whether it's supported on current platform,\n- `name` - name of the property,\n- `type` - type of predefined condifuration described below,\n- `defaultValue`,\n- `setter`,\n- `getter`,\n- `developmentSetter`\n- `implementationValue` - function returning value passed to the implementation.\n\n### Predefined types\n\n            PROPERTY_TYPES = Object.create null\n\n#### text\n\n            PROPERTY_TYPES.text = ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n\n#### number\n\n            PROPERTY_TYPES.number = ->\n                defaultValue: 0\n                developmentSetter: (val) ->\n                    assert.isFloat val\n\n#### boolean\n\n            PROPERTY_TYPES.boolean = ->\n                defaultValue: false\n                developmentSetter: (val) ->\n                    assert.isBoolean val\n\n#### color\n\n            PROPERTY_TYPES.color = (config) ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n                implementationValue: (val) ->\n                    if IS_NATIVE\n                        colorUtils.toRGBAHex val, config.defaultValue\n                    else\n                        val\n\n            @defineProperty = (config) ->\n                itemName = @__name__\n                properties = @_properties ||= []\n                config = utils.clone config\n\n                assert.isString itemName, '''\n                    NativeItem.__name__ unique name must be specified\n                '''\n                assert.isObject config, '''\n                    NativeItem.defineProperty config parameter must be an object\n                '''\n                assert.isString config.name, '''\n                    NativeItem property name must be a string\n                '''\n                assert.isNotDefined properties[config.name], \"\"\"\n                    Property #{config.name} is already defined\n                \"\"\"\n                assert.isDefined PROPERTY_TYPES[config.type], \"\"\"\n                    Unknown property type #{config.type}\n                \"\"\" if config.type\n\n                # type\n                if typeConfigFunc = PROPERTY_TYPES[config.type]\n                    typeConfig = typeConfigFunc(config)\n                    for key, val of typeConfig\n                        if key not of config\n                            config[key] = val\n\n                # constructor\n                config.constructor = @\n\n                # internalName\n                config.internalName = itemUtils.getPropInternalName config.name\n\n                # implementation\n                config.implementation = do ->\n                    if config.enabled is false\n                        return utils.NOP\n\n                    ctorName = utils.capitalize itemName\n                    name = utils.capitalize config.name\n                    if IS_NATIVE\n                        funcName = \"rendererSet#{ctorName}#{name}\"\n                        (val) ->\n                            nativeBridge.callFunction funcName, @_impl.id, val\n                    else\n                        funcName = \"set#{ctorName}#{name}\"\n                        (val) ->\n                            Impl[funcName].call @, val\n\n                # save\n                properties.push config\n\n                # create\n                itemUtils.defineProperty config\n\n            constructor: ->\n                super()\n\n                unless IS_NATIVE\n                    @_autoWidth = true\n                    @_autoHeight = true\n                    @_width = -1\n                    @_height = -1\n\n                # save properties with default values\n                if properties = @constructor._properties\n                    for property in properties\n                        @[property.internalName] = property.defaultValue\n\n            unless IS_NATIVE\n                _width: -1\n                getter = utils.lookupGetter @::, 'width'\n                itemWidthSetter = utils.lookupSetter @::, 'width'\n                utils.defineProperty @::, 'width', null, getter,\n                    do (_super = itemWidthSetter) -> (val) ->\n                        if @_autoWidth = val is -1\n                            _super.call @, @_contentWidth\n                            Impl.updateNativeSize.call @\n                        else\n                            _super.call @, val\n                        return\n\n                _height: -1\n                getter = utils.lookupGetter @::, 'height'\n                itemHeightSetter = utils.lookupSetter @::, 'height'\n                utils.defineProperty @::, 'height', null, getter,\n                    do (_super = itemHeightSetter) -> (val) ->\n                        if @_autoHeight = val is -1\n                            _super.call @, @_contentHeight\n                            Impl.updateNativeSize.call @\n                        else\n                            _super.call @, val\n                        return\n\n## Native::set(*String* propName, *Any* val)\n\n            set: (name, val) ->\n                assert.isString name\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    funcName = \"rendererSet#{ctorName}#{name}\"\n                    nativeBridge.callFunction funcName, id, val\n                else\n                    funcName = \"set#{ctorName}#{name}\"\n                    Impl[funcName].call @, val\n                return\n\n## Native::call(*String* funcName, *Any* args...)\n\n            call: (name, args...) ->\n                assert.isString name\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    funcName = \"rendererCall#{ctorName}#{name}\"\n                    callArgs = [funcName, id, args...]\n                    nativeBridge.callFunction.apply nativeBridge, callArgs\n                else\n                    funcName = \"call#{ctorName}#{name}\"\n                    Impl[funcName].apply @, args\n                return\n\n## Native::on(*String* eventName, *Function* listener)\n\n            # nativeEventName -> item id -> [item, listeners...]\n            eventListeners = Object.create null\n\n            createNativeEventListener = (listeners, eventName) -> (id) ->\n                unless itemListeners = listeners[id]\n                    log.warn \"Got a native event '#{eventName}' for an item which \" +\n                        \"didn't register a listener on this event; check if you \" +\n                        \"properly call 'on()' method with a signal listener\"\n                    return\n\n                length = arguments.length\n                args = new Array length - 1\n                for i in [0...length-1] by 1\n                    args[i] = arguments[i + 1]\n\n                item = itemListeners[0]\n                for i in [1...itemListeners.length] by 1\n                    itemListeners[i].apply item, args\n\n                return\n\n            on: (name, func) ->\n                assert.isString name\n                assert.isFunction func\n\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    ctorName = utils.capitalize @constructor.__name__\n                    eventName = \"rendererOn#{ctorName}#{name}\"\n\n                    unless listeners = eventListeners[eventName]\n                        listeners = eventListeners[eventName] = Object.create(null)\n                        nativeBridge.on eventName, createNativeEventListener(listeners, eventName)\n\n                    itemListeners = listeners[@_impl.id] ?= [@]\n                    itemListeners.push func\n                else\n                    eventName = \"on#{name}\"\n                    @_impl[eventName].connect func\n                return\n\n        Native\n\n# Glossary\n\n- [Native](#class-native)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"6df1e6949a0ea3464c97ec2743fe993624485acf","subject":"fix 'Path must be a string.' bug","message":"fix 'Path must be a string.' bug","repos":"o2platform\/fluentnode,o2platform\/fluentnode","old_file":"src\/node-native\/path.litcoffee","new_file":"src\/node-native\/path.litcoffee","new_contents":"    path = require('path')\n\n@.**path_Combine**\n\n    String::path_Combine = (pathToAppend) ->\n      if pathToAppend then path.join(@.toString(), pathToAppend) else @.toString()\n\n@.**file_Dir_Name**\n\ntwin methods: file_Parent_Folder, parent_Folder\n\n    String::file_Dir_Name  = () ->\n      path.dirname @.toString()\n\n    String::file_Parent_Folder = String::file_Dir_Name\n    String::parent_Folder      = String::file_Dir_Name\n\n\n@.**file_Extension**\n\n    String::file_Extension = () ->\n      path.extname(@.toString())\n\n@.**file_Name**\n\n    String::file_Name = () ->\n      path.basename @.toString()\n\n@.**file_Names**\n\n    Array::file_Names = () ->\n      file.file_Name() for file in @\n\n@.**append_To_Process_Cwd_Path**\n\n    String::append_To_Process_Cwd_Path  = () ->\n      process.cwd().path_Combine(@.toString())\n\n@.**file_Name_Without_Extension**\n\n    String::file_Name_Without_Extension  = () ->\n      path.basename @.toString()\n                     .replace(@.toString().file_Extension(), \"\")\n\n@.**file_Names_Without_Extension**\n\n    Array:: file_Names_Without_Extension  = () ->\n      file.file_Name_Without_Extension() for file in @\n\n@.**folder_Name**\n\nReturns the name of the current folder (which is the right-most segment of a path)\n\nIf you want the full path, use the **parent_Folder** method\n\n    String::folder_Name = ()->\n      @.valueOf().file_Name()\n\n@.**folder_Names**\n      \n    Array::folder_Names = Array::file_Names      \n\n---\nback to [index](index.html)\n","old_contents":"    path = require('path')\n\n@.**path_Combine**\n\n    String::path_Combine = (pathToAppend) ->\n      if pathToAppend then path.join(@.toString(), pathToAppend) else @.toString()\n\n@.**file_Dir_Name**\n\ntwin methods: file_Parent_Folder, parent_Folder\n\n    String::file_Dir_Name  = () ->\n      path.dirname @\n\n    String::file_Parent_Folder = String::file_Dir_Name\n    String::parent_Folder      = String::file_Dir_Name\n\n\n@.**file_Extension**\n\n    String::file_Extension = () ->\n      path.extname(@.toString())\n\n@.**file_Name**\n\n    String::file_Name = () ->\n      path.basename @.toString()\n\n@.**file_Names**\n\n    Array::file_Names = () ->\n      file.file_Name() for file in @\n\n@.**append_To_Process_Cwd_Path**\n\n    String::append_To_Process_Cwd_Path  = () ->\n      process.cwd().path_Combine(@.toString())\n\n@.**file_Name_Without_Extension**\n\n    String::file_Name_Without_Extension  = () ->\n      path.basename @.toString()\n                     .replace(@.toString().file_Extension(), \"\")\n\n@.**file_Names_Without_Extension**\n\n    Array:: file_Names_Without_Extension  = () ->\n      file.file_Name_Without_Extension() for file in @\n\n@.**folder_Name**\n\nReturns the name of the current folder (which is the right-most segment of a path)\n\nIf you want the full path, use the **parent_Folder** method\n\n    String::folder_Name = ()->\n      @.valueOf().file_Name()\n\n@.**folder_Names**\n      \n    Array::folder_Names = Array::file_Names      \n\n---\nback to [index](index.html)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"c7237c366d4581ecae68e1d6f7ceab3aba7635d6","subject":"Improved character altitude variation.","message":"Improved character altitude variation.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/game.litcoffee","new_file":"src\/game.litcoffee","new_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    pose = require \".\/pose.litcoffee\"\n    ik = require \".\/ik.litcoffee\"\n       \n    triangle = undefined\n    \n    character = testMap = testNavmesh = undefined\n    characterData = require \".\/characters\/test\/cloud.coffee\"\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load characterData, (character_) ->\n            character = character_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n    \n    playerPoseOld = pose.create characterData\n    playerPoseNew = pose.create characterData\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n    \n    torsoAltitude = 0\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    start = []\n    leftFoot = []\n    rightFoot = []\n    walked = 0\n    shuffleTicks = 0\n    foot = \"left\"\n    offset = []\n    \n    yaw = 0\n    pitch = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->        \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            \n        matrix.translate velocity, entityTransform  \n        speed = vector.magnitude velocity\n        walked += speed\n        moving = speed > 2\n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # A \"bump\" when you land.\n            matrix.getY entityTransform, yAxis\n            impact = Math.abs (vector.dot triangle.plane.normal, velocity) * (vector.dot triangle.plane.normal, yAxis)\n            impact -= 1\n            if impact < 0 then impact = 0\n            impact *= 2\n            torsoAltitude -= impact\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        torsoAltitude = misc.interpolate torsoAltitude, (12 - Math.min 2, (speed + if inDeadzone then 0 else 1.5)), 0.4\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, torsoAltitude, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.2, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.2\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n        \n        if walked < 5\n            shuffleTicks--\n        while walked > 5 or shuffleTicks < 0\n            shuffleTicks = 5\n            walked -= 5\n            if (not inDeadzone) or moving\n                vector.normalize velocity, offset\n                vector.multiply.byScalar offset, 5, offset\n            else\n                offset[0] = offset[1] = offset[2] = 0\n            foot = switch foot\n                when \"left\"\n                    matrix.applyToVector playerPoseNew.torso, [-2, -10, 0], leftFoot\n                    vector.add.vector offset, leftFoot, leftFoot\n                    plane.project triangle.plane, leftFoot, leftFoot\n                    \"right\"\n                when \"right\"\n                    matrix.applyToVector playerPoseNew.torso, [2, -10, 0], rightFoot\n                    vector.add.vector offset, rightFoot, rightFoot\n                    plane.project triangle.plane, rightFoot, rightFoot\n                    \"left\"\n    \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            firstTick = false\n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n    \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, playerPoseNew.torso\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, -2.5, 0], start\n        matrix.getX playerPoseNew.torso, xAxis\n        ik.computeLimb start, leftFoot, 10, xAxis, playerPoseNew.legLeftUpper, playerPoseNew.legLeftLower\n        \n        matrix.applyToVector playerPoseNew.torso, [1.5, -2.5, 0], start\n        ik.computeLimb start, rightFoot, 10, xAxis, playerPoseNew.legRightUpper, playerPoseNew.legRightLower\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw character, playerPoseOld, playerPoseNew\n        \n        return\n        \n    module.exports = { load, tick, draw }","old_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    pose = require \".\/pose.litcoffee\"\n    ik = require \".\/ik.litcoffee\"\n       \n    triangle = undefined\n    \n    character = testMap = testNavmesh = undefined\n    characterData = require \".\/characters\/test\/cloud.coffee\"\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load characterData, (character_) ->\n            character = character_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n    \n    playerPoseOld = pose.create characterData\n    playerPoseNew = pose.create characterData\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n    \n    torsoAltitude = 0\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    start = []\n    leftFoot = []\n    rightFoot = []\n    walked = 0\n    shuffleTicks = 0\n    foot = \"left\"\n    offset = []\n    \n    yaw = 0\n    pitch = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->        \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            \n        matrix.translate velocity, entityTransform  \n        walked += vector.magnitude velocity\n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # A \"bump\" when you land.\n            matrix.getY entityTransform, yAxis\n            impact = Math.abs (vector.dot triangle.plane.normal, velocity) * (vector.dot triangle.plane.normal, yAxis)\n            impact -= 1\n            if impact < 0 then impact = 0\n            impact *= 2\n            torsoAltitude -= impact\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        torsoAltitude = misc.interpolate torsoAltitude, (if not inDeadzone then 10 else 12), 0.4\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, torsoAltitude, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.2, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.2\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n        \n        if walked < 5\n            shuffleTicks--\n        while walked > 5 or shuffleTicks < 0\n            shuffleTicks = 5\n            walked -= 5\n            if (not inDeadzone) or ((vector.magnitudeSquared velocity) > 0.1)\n                vector.normalize velocity, offset\n                vector.multiply.byScalar offset, 5, offset\n            else\n                offset[0] = offset[1] = offset[2] = 0\n            foot = switch foot\n                when \"left\"\n                    matrix.applyToVector playerPoseNew.torso, [-2, -10, 0], leftFoot\n                    vector.add.vector offset, leftFoot, leftFoot\n                    plane.project triangle.plane, leftFoot, leftFoot\n                    \"right\"\n                when \"right\"\n                    matrix.applyToVector playerPoseNew.torso, [2, -10, 0], rightFoot\n                    vector.add.vector offset, rightFoot, rightFoot\n                    plane.project triangle.plane, rightFoot, rightFoot\n                    \"left\"\n    \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            firstTick = false\n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n    \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, playerPoseNew.torso\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, -2.5, 0], start\n        matrix.getX playerPoseNew.torso, xAxis\n        ik.computeLimb start, leftFoot, 10, xAxis, playerPoseNew.legLeftUpper, playerPoseNew.legLeftLower\n        \n        matrix.applyToVector playerPoseNew.torso, [1.5, -2.5, 0], start\n        ik.computeLimb start, rightFoot, 10, xAxis, playerPoseNew.legRightUpper, playerPoseNew.legRightLower\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw character, playerPoseOld, playerPoseNew\n        \n        return\n        \n    module.exports = { load, tick, draw }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1ce6f045d4548f522f789c0c96a5ee2876a39cde","subject":"Fresh docs for Model.encode","message":"Fresh docs for Model.encode\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @.primaryKey[= \"id\"] : String\n\nDefines the `Model`'s primary key. This attribute will be used for determining:\n\n- record identity (ie, records with the same `primaryKey` are assumed to be the same record)\n- whether a record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew)\n- whether records are related (see [`Batman.Model` Associations](\/docs\/api\/batman.model_associations.html))\n- URL parameters via [`toParam`](\/docs\/api\/batman.model.html#prototype_function_toparam)\n\nChange the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n      equal Shop.get('primaryKey'), 'shop_id'\n\n## @.resourceName[= null] : String\n\n`resourceName` is a minification-safe identifier for the `Model`. It is usually an underscore-cased version of the `Model`'s class name (for example, `App.BlogPost => \"blog_post\"`) . It is used by:\n\n- Model assocations (for providing default `primaryKey`s and `foreignKey`s and for `urlNestsUnder`)\n- Storage adapters (unless overriden by `storageKey`)\n- `data-route` bindings (eg, `routes.items[item]`)\n\n## @.storageKey[= null] : String\n\n`storageKey` is used as a namespace by the model's storage adapter. `Batman.LocalStorage` and `Batman.SessionStorage` use it as a JSON namespace and `Batman.RestStorage` uses it as a URL segment. If `storageKey` isn't set, `resourceName` may be used.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\nSpecifies that `keys` will be persisted with the `Batman.StorageAdapter` passed to `@persist`. Use it to white-list fields that should be loaded from JSON and sent back as JSON.\n\nIf no `encoderObject` is provided, the identity function (`(x) -> x`) will be used to encode and decode values.\n\nIf `encoderObject` is provided, it may have `encode`, `decode` and `as` properties, for example:\n\n```coffeescript\n@encode 'myProperty',\n  decode: (value, key, incomingJSON, outgoingObject, record) -> # returns a value to set on the record\n  encode: (value, key, builtJSON, record) ->                    # returns a value to put into the JSON\n  as: \"my_property\"                                             # overrides \"myProperty\" as the JSON key\n```\n\n__`decode`__ is applied to _incoming JSON values_ before they're set on the record. It may be `false` to prevent receiving data from the storage adapter.\n\nThe `decode` function's arguments are:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\n__`encode`__ is applied to _outgoing record values_ before they're added to the JSON. It may be set to `false` to prevent sending data to the storage adapter.\n\nThe `encode` function's arguments are:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\n__`as`__ will override the `encode` key when getting and setting values from JSON. It may be a string or a function.\n\nIf `as` is a function, it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for the model's `primaryKey`.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nAssigns validators to `keys` based on `options`. All instances of the defined model will be validated according to these keys.\n\nSee [Model Validations](\/docs\/api\/batman.model_validations.html) for a detailed description of validation options.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @%loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @%all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## @createMultipleFromJSON(attributesArray: Array) : Array\n\nLoads data from JSON like `Model.createFromJSON`, but `attributesArray` is an array of objects and returns an array of records. `createMultipleFromJSON` loads new records all at once, so `Model.loaded.itemsWereAdded` is only fired once.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::isDirty() : Boolean\n\nReturns `true` if any keys have been changed since the record was initialized or saved.\n\n## ::%isDirty : Boolean\n\nA bindable accessor on [`isDirty`](\/docs\/api\/batman.model.html#prototype_function_isdirty).\n\n## ::%dirtyKeys : Set\n\nThe [`Batman.Set`](\/docs\/api\/batman.set.html) of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::constructor(idOrAttributes = {}) : Model\n\nIf `idOrAttributes` is an object, the values are mixed into the new record. Otherwise, `idOrAttrubutes` is set to the new record's [`id`](\/docs\/api\/batman.model.html#prototype_accessor_id).\n\n## ::isNew() : boolean\n\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## ::%isNew : Boolean\n\nA bindable accessor on [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew).\n\n## updateAttributes(attributes) : Model\n\nMixes in `attributes` into the record (using `set`). Doesn't save the record.\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::%attributes : Hash\n\n`attributes` is a `Batman.Hash` where a record's attributes are stored. `Batman.Model`'s default accessor stores values in `attributes`, so it includes:\n\n- attributes defined with `@encode`\n- keys assigned with `set`, unless the key has a specifically defined accessor\n\nBut it doesn't include:\n\n- keys that have specifically defined accessors (eg, `errors`, `lifecycle`, `isNew`)\n\nA record's attributes are used by `Model::transaction` to create a deep copy of the record.\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n## ::transaction() : Model\n\nCreates a deep copy of the record instance based on its `\"attributes\"`, allowing it to be modified without affecting the original. Also mixes in `Batman.Transaction`.\nUseful for implementing actions that can be cancelled.\n\nTo apply the changes made to a transaction, call `applyChanges`.\nTo apply changes and save the record after running validations, call `save`.\n\n    test \"transaction creates an independent clone of a record\", ->\n      record = new Batman.Model(name: 'Felix')\n\n      transaction = record.transaction()\n      transaction.set('name', 'Camouflage')\n      equal transaction.get('name'), 'Camouflage'\n      equal record.get('name'), 'Felix'\n\n      transaction.applyChanges()\n      equal record.get('name'), 'Camouflage'\n\n\n## ::reflectOnAssociation(label : String)\n\nReturns the `Batman.Association` for the record's association named by `label`.\nReturns `null` if the association does not exist.\n\n## ::reflectOnAllAssociations([type: String])\n\nIf `type` is passed (eg, `hasMany`), returns a `Batman.SimpleSet` of all associations of that type on the record.\nIf no type is passed, all associations are returned.\nIf the record has no associations, returns `null`.\n\n","old_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @.primaryKey[= \"id\"] : String\n\nDefines the `Model`'s primary key. This attribute will be used for determining:\n\n- record identity (ie, records with the same `primaryKey` are assumed to be the same record)\n- whether a record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew)\n- whether records are related (see [`Batman.Model` Associations](\/docs\/api\/batman.model_associations.html))\n- URL parameters via [`toParam`](\/docs\/api\/batman.model.html#prototype_function_toparam)\n\nChange the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n      equal Shop.get('primaryKey'), 'shop_id'\n\n## @.resourceName[= null] : String\n\n`resourceName` is a minification-safe identifier for the `Model`. It is usually an underscore-cased version of the `Model`'s class name (for example, `App.BlogPost => \"blog_post\"`) . It is used by:\n\n- Model assocations (for providing default `primaryKey`s and `foreignKey`s and for `urlNestsUnder`)\n- Storage adapters (unless overriden by `storageKey`)\n- `data-route` bindings (eg, `routes.items[item]`)\n\n## @.storageKey[= null] : String\n\n`storageKey` is used as a namespace by the model's storage adapter. `Batman.LocalStorage` and `Batman.SessionStorage` use it as a JSON namespace and `Batman.RestStorage` uses it as a URL segment. If `storageKey` isn't set, `resourceName` may be used.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nAssigns validators to `keys` based on `options`. All instances of the defined model will be validated according to these keys.\n\nSee [Model Validations](\/docs\/api\/batman.model_validations.html) for a detailed description of validation options.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @%loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @%all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## @createMultipleFromJSON(attributesArray: Array) : Array\n\nLoads data from JSON like `Model.createFromJSON`, but `attributesArray` is an array of objects and returns an array of records. `createMultipleFromJSON` loads new records all at once, so `Model.loaded.itemsWereAdded` is only fired once.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::isDirty() : Boolean\n\nReturns `true` if any keys have been changed since the record was initialized or saved.\n\n## ::%isDirty : Boolean\n\nA bindable accessor on [`isDirty`](\/docs\/api\/batman.model.html#prototype_function_isdirty).\n\n## ::%dirtyKeys : Set\n\nThe [`Batman.Set`](\/docs\/api\/batman.set.html) of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::constructor(idOrAttributes = {}) : Model\n\nIf `idOrAttributes` is an object, the values are mixed into the new record. Otherwise, `idOrAttrubutes` is set to the new record's [`id`](\/docs\/api\/batman.model.html#prototype_accessor_id).\n\n## ::isNew() : boolean\n\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## ::%isNew : Boolean\n\nA bindable accessor on [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew).\n\n## updateAttributes(attributes) : Model\n\nMixes in `attributes` into the record (using `set`). Doesn't save the record.\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::%attributes : Hash\n\n`attributes` is a `Batman.Hash` where a record's attributes are stored. `Batman.Model`'s default accessor stores values in `attributes`, so it includes:\n\n- attributes defined with `@encode`\n- keys assigned with `set`, unless the key has a specifically defined accessor\n\nBut it doesn't include:\n\n- keys that have specifically defined accessors (eg, `errors`, `lifecycle`, `isNew`)\n\nA record's attributes are used by `Model::transaction` to create a deep copy of the record.\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n## ::transaction() : Model\n\nCreates a deep copy of the record instance based on its `\"attributes\"`, allowing it to be modified without affecting the original. Also mixes in `Batman.Transaction`.\nUseful for implementing actions that can be cancelled.\n\nTo apply the changes made to a transaction, call `applyChanges`.\nTo apply changes and save the record after running validations, call `save`.\n\n    test \"transaction creates an independent clone of a record\", ->\n      record = new Batman.Model(name: 'Felix')\n\n      transaction = record.transaction()\n      transaction.set('name', 'Camouflage')\n      equal transaction.get('name'), 'Camouflage'\n      equal record.get('name'), 'Felix'\n\n      transaction.applyChanges()\n      equal record.get('name'), 'Camouflage'\n\n\n## ::reflectOnAssociation(label : String)\n\nReturns the `Batman.Association` for the record's association named by `label`.\nReturns `null` if the association does not exist.\n\n## ::reflectOnAllAssociations([type: String])\n\nIf `type` is passed (eg, `hasMany`), returns a `Batman.SimpleSet` of all associations of that type on the record.\nIf no type is passed, all associations are returned.\nIf the record has no associations, returns `null`.\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1e1ed4372ab08c6ade7120e6fc34f984a7329995","subject":"Improve formatting","message":"Improve formatting\n","repos":"mdesantis\/jquery-textfade,mdesantis\/jquery-textfade","old_file":"src\/jquery-textfade.litcoffee","new_file":"src\/jquery-textfade.litcoffee","new_contents":"    ###!\n    jQuery.TextFade v1.0.0\n    https:\/\/github.com\/mdesantis\/jquery-textfade\n\n    Copyright 2014-2018 Maurizio De Santis\n    Released under the MIT license\n    https:\/\/github.com\/mdesantis\/jquery-textfade\/LICENSE\n    ###\n\n# jQuery.TextFade\n\n## Description\n\n**jQuery.TextFade** is a jQuery plugin which provides some nice fading effects to the contents of\nthe selected elements.\n\nThe fading effect is obtained replacing every character of the text with a blank character in the\ncase of a fade-out effect, and conversely replacing the text with blank characters and replacing\nevery blank character with the corresponding character in the text in the case of a fade-in effect.\n\nIf more elements are selected, their contents will be animated simultaneously.\n\n## API\n\n* **jQuery.textFade(action, options)**: main function\n* **jQuery.textFadeIn(options)**: alias for `jQuery.textFade('in', options)`\n* **jQuery.textFadeOut(options)**: alias for `jQuery.textFade('out', options)`\n\n### Arguments\n\n**jQuery.textFade** takes two arguments:\n- **action**: the fading action; can be `'in'`, which causes the text to appear, or `'out'`, which\n  causes the text to disappear. *Default value:* none\n- **options**: the available options, which are:\n  - **text**: if this option is specified, its value will replace the content of the selected\n    element, so as to be used for the fading effect; otherwise the fading text is the content of the\n    selected element. *Default value:* `null`\n  - **sequence**: an array of characters indexes, which determine the order of the text fading.\n    *Default value:* `'random'`. The value can be any of these types:\n    - *array*: it will be iterated in sequence using each value as the index of the character to be\n      replaced\n    - *string*: it selects one between the preset sequences (more on this [below](#sequences))\n    - *function*: it takes the fading text as argument and returns an array containing the\n      characters indexes\n  - **steps**: a step is the action of the character replacement. These are the available\n    options:\n    - **duration**: the duration of each character replacement in milliseconds. *Default value:\n      `10`*\n    - **threads**: the amount of character replacements for each step. *Default value:* `1`\n\n**jQuery.textFadeIn** and **jQuery.textFadeOut** take the **options** argument only.\n\n\n### Events\n\njQuery.textFade triggers two events, **start** and **stop**. In order to listen for them you can use\nthe following event identifiers:\n- **start.textFadeIn**: start of a fade-in\n- **stop.textFadeIn**: stop of a fade-in\n- **start.textFadeOut**: start of a fade-out\n- **stop.textFadeOut**: stop of a fade-out\n- **start.textFade**: start of a fade of any action\n- **stop.textFade**: stop of a fade of any action\n\nIn any case the action is passed as value of the `'action'` key of the first extra parameter, which\nhappens to be an object.\n\n### Examples\n\n- Fade out the text `HEY THERE!` one character every second:\n\n```coffeescript\n$('#text').textFadeIn({\n  'text': 'HEY THERE!',\n  'steps': { 'duration': 1000, 'threads': 1 }\n})\n```\n\n- Fade out the text `SEE YA!` three characters every two seconds, in a\n*left to right - top to bottom* order:\n\n```coffeescript\n$('#text').textFadeOut({\n  'text': 'SEE YA!',\n  'sequence': 'ltr_ttb',\n  'steps': { 'duration': 2000, threads: 3 }\n})\n```\n\n## Source\n\n**TextFade** is the core function: in addition to the arguments described [above](#arguments), it\ntakes the `@$element` argument, that is the jQuery element\/s whose text is going to be animated\n\n    TextFade = (@$element, @action, options) ->\n\n### Constants\n\n      $                  = jQuery\n      BLANK_TEXT_REGEXP  = \/[^\\n]\/g\n      LINES_SPLIT_REGEXP = \/.+\\n?|\\n\/g\n\n#### Sequences\n\n      SEQUENCES          =\n\n`SEQUENCES` includes some preset sequences, selectable passing the corresponding identifier to\njQuery.textFade. The available identifiers are:\n\n- **random**: the characters fading sequence is random\n\n        'random'  : (text) -> shuffle times text.length\n\n- **ltr_ttb** *(left-to-right character, top-to-bottom line)*: the text fading starts at the first\ncharacter of the first line, up to the end of line; then it moves to the next line\n\n        'ltr_ttb' : (text) -> times text.length\n\n- **ltr_btt** *(left-to-right character, bottom-to-top line)*: the text fading starts at the first\ncharacter of the last line, up to the end of line; then it moves to the previous line\n\n        'ltr_btt' : (text) -> flatten (textToSequences text).reverse()\n\n- **rtl_ttb** *(right-to-left character, top-to-bottom line)*: the text fading starts at the last\ncharacter of the first line, up to the start of line; then it moves to the next line\n\n        'rtl_ttb' : (text) -> flatten textToSequences(text).map((v) -> v.reverse())\n\n- **rtl_btt** *(right-to-left character, bottom-to-top line)*: the text fading starts at the last\ncharacter of the last line, up to the start of line; then it moves to the previous line\n\n        'rtl_btt' : (text) -> flatten textToSequences(text).map((v) -> v.reverse()).reverse()\n\n- **ttb_ltr** *(top-to-bottom character, left-to-right line)*: the text fading starts at the first\ncharacter of the first line, up to the first character of the last line; then it moves to the next\ncharacter of the first line\n\n        'ttb_ltr' : (text) -> flatten zip textToSequences text\n\n- **ttb_rtl** *(top-to-bottom character, right-to-left line)*: the text fading starts at the last\ncharacter of the first line, up to the last character of the last line; then it moves to the\nprevious character of the first line\n\n        'ttb_rtl' : (text) -> flatten (zip textToSequences(text).reverse()).reverse()\n\n- **btt_ltr** *(bottom-to-top character, left-to-right line)*: the text fading starts at the first\ncharacter of the last line, up to the first character of the first line; then it moves to the next\ncharacter of the last line\n\n        'btt_ltr' : (text) -> flatten zip textToSequences(text).reverse()\n\n- **btt_rtl** *(bottom-to-top character, right-to-left line)*: the text fading starts at the last\ncharacter of the last line, up to the first character of the last line; then it moves to the next\ncharacter of the last line\n\n        'btt_rtl' : (text) -> flatten (zip textToSequences text).reverse()\n\n### Utility functions\n\n      capitalize = (s) -> \"#{s.charAt(0).toUpperCase()}#{s.slice(1)}\"\n\n      flatten = (a) -> a.reduce (p, c) -> p.concat c\n\n      max = (a) -> a.reduce ((p, c) -> Math.max p, c), -Infinity\n\n      shuffle = (a) ->\n        i = a.length\n\n        while i\n          j = Math.floor Math.random()*i\n          x = a[--i]\n          a[i] = a[j]\n          a[j] = x\n\n        a\n\n      times = (n, fn) ->\n        i   = 0\n        fn ?= (i) -> i\n\n        fn i++ while i < n\n\n      zip = (a) ->\n        result = []\n\n        times (max a.map (v) -> v.length), (i) ->\n          for v in a\n            (result[i] ?= []).push v[i] if v[i]?\n\n        result\n\nTake a text and return an array of arrays, each containing the text index of each\ncharacter of the corresponding line\n\n      textToSequences = (text) ->\n        sequences = []\n        charIndex = 0\n        lines     = text.match LINES_SPLIT_REGEXP\n\n        for line, lineIndex in lines\n          sequences[lineIndex] = []\n          times line.length, () -> sequences[lineIndex].push charIndex++\n\n        sequences\n\n### Default options\n\n      defaultOptions = ->\n        'text'     : null\n        'sequence' : 'random'\n        'steps'    :\n          'duration' : 10\n          'threads'  : 1\n\n### Private instance methods\n\nTrigger both of the supported event namespaces\n\n      @_trigger = (eventName) ->\n        extraParameters = [{ 'action' : @action }]\n        @$element.trigger \"#{eventName}.textFade#{capitalize(@action)}\", extraParameters\n        @$element.trigger \"#{eventName}.textFade\", extraParameters\n\nReplace the character at the given index\n\n      @_replace = (index) ->\n        text     = @$element.text()\n        prevChar = @begText.charAt index\n        nextChar = @endText.charAt index\n\nThe replacement is skipped if the character is the same\n\n        return if prevChar is nextChar\n\n        @$element.text \"#{text.substr 0, index}#{nextChar}#{text.substr index+nextChar.length}\"\n\nThe function executed for each character replacement, until the sequence gets empty\n\n      @_step = (sequence) ->\n        times @options.steps.threads, () =>\n          return if sequence.length is 0\n\n          @_replace sequence.shift()\n\n        if sequence.length is 0\n          clearInterval @_interval\n          @_trigger 'stop'\n\n### Constructor\n\n      @options = $.extend true, defaultOptions(), options\n\n      text = @options.text ? @$element.text()\n\n      if $.type(@options.sequence) is 'string'\n        @options.sequence = SEQUENCES[@options.sequence] text\n      else if $.isFunction @options.sequence\n        @options.sequence = @options.sequence text\n      # else assert @options.sequence to be an array; leave it unchanged\n\nUse an `@options.sequence` clone in order to keep it unchanged\n\n      sequenceClone = @options.sequence[0..]\n\nNewlines are preserved in order to preserve the text structure\n\n      blankText = text.replace BLANK_TEXT_REGEXP, ' '\n\nThe only difference between fade-in and fade-out is that on fade-in we start with a blank text and\nfinish with the submitted text, while on fade-out we start with the submitted text and finish with\na blank text\n\n      switch @action\n        when 'in'\n          @begText = blankText\n          @endText = text\n        when 'out'\n          @begText = text\n          @endText = blankText\n\n      @$element.text @begText\n\n      @_trigger 'start'\n\n      @_interval = setInterval =>\n        @_step sequenceClone\n      , @options.steps.duration\n\n      @\n\n### jQuery bindings\n\n    $.fn.textFade = (action, options) ->\n      @.each -> new TextFade $(@), action, options\n\n    $.fn.textFadeIn = (options) ->\n      @.textFade 'in', options\n\n    $.fn.textFadeOut = (options) ->\n      @.textFade 'out', options\n","old_contents":"    ###!\n    jQuery.TextFade v1.0.0\n    https:\/\/github.com\/mdesantis\/jquery-textfade\n\n    Copyright 2014-2018 Maurizio De Santis\n    Released under the MIT license\n    https:\/\/github.com\/mdesantis\/jquery-textfade\/LICENSE\n    ###\n\n# jQuery.TextFade\n\n## Description\n\n**jQuery.TextFade** is a jQuery plugin which provides some nice fading effects to the contents of\nthe selected elements.\n\nThe fading effect is obtained replacing every character of the text with a blank character in the\ncase of a fade-out effect, and conversely replacing the text with blank characters and replacing\nevery blank character with the corresponding character in the text in the case of a fade-in effect.\n\nIf more elements are selected, their contents will be animated simultaneously.\n\n## API\n\n* **jQuery.textFade(action, options)**: main function\n* **jQuery.textFadeIn(options)**: alias for `jQuery.textFade('in', options)`\n* **jQuery.textFadeOut(options)**: alias for `jQuery.textFade('out', options)`\n\n### Arguments\n\n**jQuery.textFade** takes two arguments:\n- **action**: the fading action; can be `'in'`, which causes the text to appear, or `'out'`, which\n  causes the text to disappear. *Default value:* none\n- **options**: the available options, which are:\n  - **text**: if this option is specified, its value will replace the content of the selected\n    element, so as to be used for the fading effect; otherwise the fading text is the content of the\n    selected element. *Default value:* `null`\n  - **sequence**: an array of characters indexes, which determine the order of the text fading.\n    *Default value:* `'random'`. The value can be any of these types:\n    - *array*: it will be iterated in sequence using each value as the index of the character to be\n      replaced\n    - *string*: it selects one between the preset sequences (more on this [below](#sequences))\n    - *function*: it takes the fading text as argument and returns an array containing the\n      characters indexes\n  - **steps**: a step is the action of the character replacement. These are the available\n    options:\n    - **duration**: the duration of each character replacement in milliseconds. *Default value:\n      `10`*\n    - **threads**: the amount of character replacements for each step. *Default value:* `1`\n\n**jQuery.textFadeIn** and **jQuery.textFadeOut** take the **options** argument only.\n\n\n### Events\n\njQuery.textFade triggers two events, **start** and **stop**. In order to listen for them you can use\nthe following event identifiers:\n- **start.textFadeIn**: start of a fade-in\n- **stop.textFadeIn**: stop of a fade-in\n- **start.textFadeOut**: start of a fade-out\n- **stop.textFadeOut**: stop of a fade-out\n- **start.textFade**: start of a fade of any action\n- **stop.textFade**: stop of a fade of any action\n\nIn any case the action is passed as value of the `'action'` key of the first extra parameter, which\nhappens to be an object.\n\n### Examples\n\n- Fade out the text \"HEY THERE!\" one character every second:\n\n```coffeescript\n$('#text').textFadeIn({\n  'text': 'HEY THERE!',\n  'steps': { 'duration': 1000, 'threads': 1 }\n})\n```\n\n- Fade out the text \"SEE YA!\" three characters every two seconds, in a\n*left to right - top to bottom* order:\n\n```coffeescript\n$('#text').textFadeOut({\n  'text': 'SEE YA!',\n  'sequence': 'ltr_ttb',\n  'steps': { 'duration': 2000, threads: 3 }\n})\n```\n\n## Source\n\n**TextFade** is the core function: in addition to the arguments described [above](#arguments), it\ntakes the `@$element` argument, that is the jQuery element\/s whose text is going to be animated\n\n    TextFade = (@$element, @action, options) ->\n\n### Constants\n\n      $                  = jQuery\n      BLANK_TEXT_REGEXP  = \/[^\\n]\/g\n      LINES_SPLIT_REGEXP = \/.+\\n?|\\n\/g\n\n#### Sequences\n\n      SEQUENCES          =\n\n`SEQUENCES` includes some preset sequences, selectable passing the corresponding identifier to\njQuery.textFade. The available identifiers are:\n\n- **random**: the characters fading sequence is random\n\n        'random'  : (text) -> shuffle times text.length\n\n- **ltr_ttb** *(left-to-right character, top-to-bottom line)*: the text fading starts at the first\ncharacter of the first line, up to the end of line; then it moves to the next line\n\n        'ltr_ttb' : (text) -> times text.length\n\n- **ltr_btt** *(left-to-right character, bottom-to-top line)*: the text fading starts at the first\ncharacter of the last line, up to the end of line; then it moves to the previous line\n\n        'ltr_btt' : (text) -> flatten (textToSequences text).reverse()\n\n- **rtl_ttb** *(right-to-left character, top-to-bottom line)*: the text fading starts at the last\ncharacter of the first line, up to the start of line; then it moves to the next line\n\n        'rtl_ttb' : (text) -> flatten textToSequences(text).map((v) -> v.reverse())\n\n- **rtl_btt** *(right-to-left character, bottom-to-top line)*: the text fading starts at the last\ncharacter of the last line, up to the start of line; then it moves to the previous line\n\n        'rtl_btt' : (text) -> flatten textToSequences(text).map((v) -> v.reverse()).reverse()\n\n- **ttb_ltr** *(top-to-bottom character, left-to-right line)*: the text fading starts at the first\ncharacter of the first line, up to the first character of the last line; then it moves to the next\ncharacter of the first line\n\n        'ttb_ltr' : (text) -> flatten zip textToSequences text\n\n- **ttb_rtl** *(top-to-bottom character, right-to-left line)*: the text fading starts at the last\ncharacter of the first line, up to the last character of the last line; then it moves to the\nprevious character of the first line\n\n        'ttb_rtl' : (text) -> flatten (zip textToSequences(text).reverse()).reverse()\n\n- **btt_ltr** *(bottom-to-top character, left-to-right line)*: the text fading starts at the first\ncharacter of the last line, up to the first character of the first line; then it moves to the next\ncharacter of the last line\n\n        'btt_ltr' : (text) -> flatten zip textToSequences(text).reverse()\n\n- **btt_rtl** *(bottom-to-top character, right-to-left line)*: the text fading starts at the last\ncharacter of the last line, up to the first character of the last line; then it moves to the next\ncharacter of the last line\n\n        'btt_rtl' : (text) -> flatten (zip textToSequences text).reverse()\n\n### Utility functions\n\n      capitalize = (s) -> \"#{s.charAt(0).toUpperCase()}#{s.slice(1)}\"\n\n      flatten = (a) -> a.reduce (p, c) -> p.concat c\n\n      max = (a) -> a.reduce ((p, c) -> Math.max p, c), -Infinity\n\n      shuffle = (a) ->\n        i = a.length\n\n        while i\n          j = Math.floor Math.random()*i\n          x = a[--i]\n          a[i] = a[j]\n          a[j] = x\n\n        a\n\n      times = (n, fn) ->\n        i   = 0\n        fn ?= (i) -> i\n\n        fn i++ while i < n\n\n      zip = (a) ->\n        result = []\n\n        times (max a.map (v) -> v.length), (i) ->\n          for v in a\n            (result[i] ?= []).push v[i] if v[i]?\n\n        result\n\nTake a text and return an array of arrays, each containing the text index of each\ncharacter of the corresponding line\n\n      textToSequences = (text) ->\n        sequences = []\n        charIndex = 0\n        lines     = text.match LINES_SPLIT_REGEXP\n\n        for line, lineIndex in lines\n          sequences[lineIndex] = []\n          times line.length, () -> sequences[lineIndex].push charIndex++\n\n        sequences\n\n### Default options\n\n      defaultOptions = ->\n        'text'     : null\n        'sequence' : 'random'\n        'steps'    :\n          'duration' : 10\n          'threads'  : 1\n\n### Private instance methods\n\nTrigger both of the supported event namespaces\n\n      @_trigger = (eventName) ->\n        extraParameters = [{ 'action' : @action }]\n        @$element.trigger \"#{eventName}.textFade#{capitalize(@action)}\", extraParameters\n        @$element.trigger \"#{eventName}.textFade\", extraParameters\n\nReplace the character at the given index\n\n      @_replace = (index) ->\n        text     = @$element.text()\n        prevChar = @begText.charAt index\n        nextChar = @endText.charAt index\n\nThe replacement is skipped if the character is the same\n\n        return if prevChar is nextChar\n\n        @$element.text \"#{text.substr 0, index}#{nextChar}#{text.substr index+nextChar.length}\"\n\nThe function executed for each character replacement, until the sequence gets empty\n\n      @_step = (sequence) ->\n        times @options.steps.threads, () =>\n          return if sequence.length is 0\n\n          @_replace sequence.shift()\n\n        if sequence.length is 0\n          clearInterval @_interval\n          @_trigger 'stop'\n\n### Constructor\n\n      @options = $.extend true, defaultOptions(), options\n\n      text = @options.text ? @$element.text()\n\n      if $.type(@options.sequence) is 'string'\n        @options.sequence = SEQUENCES[@options.sequence] text\n      else if $.isFunction @options.sequence\n        @options.sequence = @options.sequence text\n      # else assert @options.sequence to be an array; leave it unchanged\n\nUse an `@options.sequence` clone in order to keep it unchanged\n\n      sequenceClone = @options.sequence[0..]\n\nNewlines are preserved in order to preserve the text structure\n\n      blankText = text.replace BLANK_TEXT_REGEXP, ' '\n\nThe only difference between fade-in and fade-out is that on fade-in we start with a blank text and\nfinish with the submitted text, while on fade-out we start with the submitted text and finish with\na blank text\n\n      switch @action\n        when 'in'\n          @begText = blankText\n          @endText = text\n        when 'out'\n          @begText = text\n          @endText = blankText\n\n      @$element.text @begText\n\n      @_trigger 'start'\n\n      @_interval = setInterval =>\n        @_step sequenceClone\n      , @options.steps.duration\n\n      @\n\n### jQuery bindings\n\n    $.fn.textFade = (action, options) ->\n      @.each -> new TextFade $(@), action, options\n\n    $.fn.textFadeIn = (options) ->\n      @.textFade 'in', options\n\n    $.fn.textFadeOut = (options) ->\n      @.textFade 'out', options\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"35f9db3879b0076d49c4826d6947444da27c1698","subject":"ensure concurrent commit events are not suppressed","message":"ensure concurrent commit events are not suppressed\n","repos":"corenova\/yang-js","old_file":"src\/container.litcoffee","new_file":"src\/container.litcoffee","new_contents":"# Container - controller of object properties\n\n## Class Container\n\n    delegate = require 'delegates'\n    Emitter  = require('events').EventEmitter\n    Property = require('.\/property')\n    kProp = Symbol.for('property')\n\n    class Container extends Property\n      logger: require('debug')('yang:container')\n\n      constructor: ->\n        super arguments...\n        @state.children = new Map # committed props\n        @state.pending = new Map # uncommitted changed props\n        @state.delta = undefined\n        @state.proxy =\n          has: (obj, key) => @children.has(key) or key of obj\n          get: (obj, key) => switch\n            when key is kProp then this\n            when key is 'toJSON' then @toJSON.bind(this)\n            when @has(key) then @get(key)\n            when key of obj then obj[key]\n            when key is 'inspect' then @toJSON.bind(this)\n            when key of this and typeof @[key] is 'function' then @[key].bind(this)\n          set: (obj, key, value) => switch\n            when @has(key) then @_get(key).set(value)\n            else obj[key] = value\n          deleteProperty: (obj, key) => switch\n            when @has(key) then @_get(key).delete()\n            when key of obj then delete obj[key]\n        Object.setPrototypeOf @state, Emitter.prototype\n        \n      delegate @prototype, 'state'\n        .getter 'children'\n        .getter 'pending'\n        .getter 'delta'\n        .method 'once'\n        .method 'on'\n        .method 'off'\n        .method 'emit'\n\n      @property 'props',\n        get: -> Array.from(@children.values())\n\n      @property 'changed',\n        get: -> @pending.size > 0 or @state.changed\n\n      @property 'changes',\n        get: -> @pending.values()\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed and @pending.size\n            obj = {}\n            obj[prop.key] = prop.change for prop from @changes\n            obj\n          when @changed then @data\n\n      @property 'data',\n        set: (value) -> @set value, { force: true }\n        get: ->\n          value = switch\n            when @binding?.get? then @binding.get @context\n            else @value\n          return value unless value instanceof Object\n          new Proxy value, @state.proxy\n      \n      clone: ->\n        copy = super children: new Map, pending: new Map\n        copy.add prop.clone(parent: copy) for prop in @props\n        return copy\n\n### add (child)\n\nThis call is used to add a child property to map of children.\n\n      add: (child) ->\n        @children.set child.key, child\n        if @value?\n          Object.defineProperty @value, child.key,\n            configurable: true\n            enumerable: child.active\n\n### remove (child)\n\nThis call is used to remove a child property from map of children.\n\n      remove: (child) ->\n        @children.delete child.key\n        if @value?\n          delete @value[child.key]\n\n### has (key)\n\n      has: (key) -> @children.has(key)\n\n### get (key)\n\n      _get: (key) -> @children.get(key)\n      \n      get: (key) -> switch\n        when key? and @has(key) then @_get(key).data\n        else super arguments...\n\n### set (obj, opts)\n\n      set: (obj, opts={}) ->\n        # TODO: should we preserve prior changes and restore if super fails?\n        @pending.clear()\n        # TODO: should we also clear Object.defineProperties?\n        try obj = Object.assign {}, obj if kProp of obj\n        super obj, opts\n        # remove all props not part of pending changes\n        subopts = Object.assign {}, opts\n        #prop.delete(subopts) for prop in @props when not @pending.has(prop.key)\n        @props.forEach (prop) => prop.delete(subopts) unless @pending.has(prop.key) \n        return this\n\n### merge (obj, opts)\n\nEnumerate key\/value of the passed in `obj` and merge into known child\nproperties.\n\n      merge: (obj, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if obj is null\n        return @set obj, opts if opts.replace or not @value?\n        \n        # TODO: protect this as a transaction?\n        { deep = true } = opts\n\n        subopts = Object.assign {}, opts, inner: true, replace: not deep\n        for own k, v of obj\n          @debug => \"[merge] looking for #{k} inside #{@children.size} children\"\n          prop = @children.get(k) ? @in(k)\n          continue unless prop? and not Array.isArray(prop)\n          @debug => \"[merge] applying value to child prop #{prop.key}\"\n          prop.merge(v, subopts)\n        # TODO: we should consider evaluating schema.attrs here before update\n        @update @value, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      _update: (value, opts) ->\n        @debug => \"[update] handle #{@pending.size} changed props\"\n        \n        for prop from @changes\n          @debug => \"[update] child #{prop.uri} changed? #{prop.changed}\"\n          @add prop, opts\n          @pending.delete prop.key unless prop.changed\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n\n        if value instanceof Property\n          @debug => \"[update] pending.set #{value.key}\"\n          @pending.set value.key, value if value.parent is this\n          if opts.inner or opts.origin is this\n            return this\n          # higher up from change origin\n          value = @value\n\n        @_update value, opts # internal update handler\n\n        # we must clear children here if being deleted before calling super (which calls parent.update)\n        @children.clear() if value is null\n        super value, opts\n            \n        @emit 'update', this, opts\n        return this\n\n### commit (opts)\n\nCommits the changes to the data model. Async transaction.\nEvents: commit, change\n\n      commit: (opts={}) ->\n        return true unless @changed\n        if @locked\n          return new Promise (resolve, reject) => @once 'commit', (ok) =>\n            @emit 'change', opts.origin, opts.actor if ok and not opts.suppress\n            resolve ok\n        \n        @debug => \"[commit] #{@pending.size} changes\"\n        @state.locked = true\n        @state.delta = @change\n        # @state.setMaxListeners(30 + (@pending.size * 2))\n        subopts = Object.assign {}, opts, inner: true\n\n        try \n          # 1. traverse down the children and commit them\n          await prop.commit subopts for prop from @changes when not prop.locked\n          \n          # 2. perform the bound commit transaction\n          (@debug => \"[commit] execute commit binding (if any)...\") unless opts.sync\n          await @binding?.commit? @context.with(opts) unless opts.sync\n\n          # TODO: enable this later after kos stops using a '.' dummy\n          # container between module and nodes opts.origin = this if\n          # @pending.size > 1 or not @active\n          opts.origin ?= this\n\n          # 3. wait for the parent to commit unless called by parent\n          ok = await @parent?.commit? opts unless opts.inner\n          ok ?= true\n\n          unless ok\n            throw new Error \"parent commit failure\"\n\n          # 4. generate change event\n          @emit 'change', opts.origin, opts.actor if ok and not opts.suppress\n\n          @emit 'commit', true, opts\n\n          # 5. initiate clean only if no parent\n          @clean opts if not @parent?\n\n        catch err\n          @debug => \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          @emit 'commit', false, opts\n          throw @error err, 'commit'\n          \n        finally\n          @state.locked = false\n\n        return true\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @debug => \"[revert] #{@pending.size} changes\"\n        # below is hackish but works to make a copy of current value\n        # to be used as ctx.prior during revert commit binding call\n        @state.value = @toJSON()\n        await prop.revert opts for prop from @changes\n        @debug => \"[revert] re-add changed props\"\n        @add prop for prop from @changes\n        await super opts\n\n      clean: (opts={}) ->\n        # traverse down the children and clean their state\n        prop.clean opts for prop from @changes\n        @pending.clear()\n        super()\n        \n        \n\n### toJSON\n\nThis call creates a new copy of the current `Property.data`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        props = @props\n        value = switch\n          when props.length\n            obj = {}\n            for prop in props when prop.enumerable and (state or prop.mutable)\n              value = prop.toJSON false, state\n              obj[prop.key] = value if value?\n            obj\n          else @value\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        output = super arguments...\n        return Object.assign output, children: @children.size\n        \n    module.exports = Container\n","old_contents":"# Container - controller of object properties\n\n## Class Container\n\n    delegate = require 'delegates'\n    Emitter  = require('events').EventEmitter\n    Property = require('.\/property')\n    kProp = Symbol.for('property')\n\n    class Container extends Property\n      logger: require('debug')('yang:container')\n\n      constructor: ->\n        super arguments...\n        @state.children = new Map # committed props\n        @state.pending = new Map # uncommitted changed props\n        @state.delta = undefined\n        @state.proxy =\n          has: (obj, key) => @children.has(key) or key of obj\n          get: (obj, key) => switch\n            when key is kProp then this\n            when key is 'toJSON' then @toJSON.bind(this)\n            when @has(key) then @get(key)\n            when key of obj then obj[key]\n            when key is 'inspect' then @toJSON.bind(this)\n            when key of this and typeof @[key] is 'function' then @[key].bind(this)\n          set: (obj, key, value) => switch\n            when @has(key) then @_get(key).set(value)\n            else obj[key] = value\n          deleteProperty: (obj, key) => switch\n            when @has(key) then @_get(key).delete()\n            when key of obj then delete obj[key]\n        Object.setPrototypeOf @state, Emitter.prototype\n        \n      delegate @prototype, 'state'\n        .getter 'children'\n        .getter 'pending'\n        .getter 'delta'\n        .method 'once'\n        .method 'on'\n        .method 'off'\n        .method 'emit'\n\n      @property 'props',\n        get: -> Array.from(@children.values())\n\n      @property 'changed',\n        get: -> @pending.size > 0 or @state.changed\n\n      @property 'changes',\n        get: -> @pending.values()\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed and @pending.size\n            obj = {}\n            obj[prop.key] = prop.change for prop from @changes\n            obj\n          when @changed then @data\n\n      @property 'data',\n        set: (value) -> @set value, { force: true }\n        get: ->\n          value = switch\n            when @binding?.get? then @binding.get @context\n            else @value\n          return value unless value instanceof Object\n          new Proxy value, @state.proxy\n      \n      clone: ->\n        copy = super children: new Map, pending: new Map\n        copy.add prop.clone(parent: copy) for prop in @props\n        return copy\n\n### add (child)\n\nThis call is used to add a child property to map of children.\n\n      add: (child) ->\n        @children.set child.key, child\n        if @value?\n          Object.defineProperty @value, child.key,\n            configurable: true\n            enumerable: child.active\n\n### remove (child)\n\nThis call is used to remove a child property from map of children.\n\n      remove: (child) ->\n        @children.delete child.key\n        if @value?\n          delete @value[child.key]\n\n### has (key)\n\n      has: (key) -> @children.has(key)\n\n### get (key)\n\n      _get: (key) -> @children.get(key)\n      \n      get: (key) -> switch\n        when key? and @has(key) then @_get(key).data\n        else super arguments...\n\n### set (obj, opts)\n\n      set: (obj, opts={}) ->\n        # TODO: should we preserve prior changes and restore if super fails?\n        @pending.clear()\n        # TODO: should we also clear Object.defineProperties?\n        try obj = Object.assign {}, obj if kProp of obj\n        super obj, opts\n        # remove all props not part of pending changes\n        subopts = Object.assign {}, opts\n        #prop.delete(subopts) for prop in @props when not @pending.has(prop.key)\n        @props.forEach (prop) => prop.delete(subopts) unless @pending.has(prop.key) \n        return this\n\n### merge (obj, opts)\n\nEnumerate key\/value of the passed in `obj` and merge into known child\nproperties.\n\n      merge: (obj, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if obj is null\n        return @set obj, opts if opts.replace or not @value?\n        \n        # TODO: protect this as a transaction?\n        { deep = true } = opts\n\n        subopts = Object.assign {}, opts, inner: true, replace: not deep\n        for own k, v of obj\n          @debug => \"[merge] looking for #{k} inside #{@children.size} children\"\n          prop = @children.get(k) ? @in(k)\n          continue unless prop? and not Array.isArray(prop)\n          @debug => \"[merge] applying value to child prop #{prop.key}\"\n          prop.merge(v, subopts)\n        # TODO: we should consider evaluating schema.attrs here before update\n        @update @value, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      _update: (value, opts) ->\n        @debug => \"[update] handle #{@pending.size} changed props\"\n        \n        for prop from @changes\n          @debug => \"[update] child #{prop.uri} changed? #{prop.changed}\"\n          @add prop, opts\n          @pending.delete prop.key unless prop.changed\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n\n        if value instanceof Property\n          @debug => \"[update] pending.set #{value.key}\"\n          @pending.set value.key, value if value.parent is this\n          if opts.inner or opts.origin is this\n            return this\n          # higher up from change origin\n          value = @value\n\n        @_update value, opts # internal update handler\n\n        # we must clear children here if being deleted before calling super (which calls parent.update)\n        @children.clear() if value is null\n        super value, opts\n            \n        @emit 'update', this, opts\n        return this\n\n### commit (opts)\n\nCommits the changes to the data model. Async transaction.\nEvents: commit, change\n\n      commit: (opts={}) ->\n        return true unless @changed\n        if @locked\n          return new Promise (resolve, reject) => @once 'commit', (res) => resolve res\n          \n        # return false if @locked\n        \n        @debug => \"[commit] #{@pending.size} changes\"\n        @state.locked = true\n        @state.delta = @change\n        # @state.setMaxListeners(30 + (@pending.size * 2))\n        subopts = Object.assign {}, opts, inner: true\n\n        try \n          # 1. traverse down the children and commit them\n          await prop.commit subopts for prop from @changes when not prop.locked\n          \n          # 2. perform the bound commit transaction\n          (@debug => \"[commit] execute commit binding (if any)...\") unless opts.sync\n          await @binding?.commit? @context.with(opts) unless opts.sync\n\n          # TODO: enable this later after kos stops using a '.' dummy\n          # container between module and nodes opts.origin = this if\n          # @pending.size > 1 or not @active\n          opts.origin ?= this\n\n          # 3. wait for the parent to commit unless called by parent\n          ok = await @parent?.commit? opts unless opts.inner\n          ok ?= true\n\n          unless ok\n            throw new Error \"parent commit failure\"\n\n          # 4. generate change event\n          @emit 'change', opts.origin, opts.actor if ok and not opts.suppress\n\n          @emit 'commit', true, opts\n\n          # 5. initiate clean only if no parent\n          @clean opts if not @parent?\n\n        catch err\n          @debug => \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          @emit 'commit', false, opts\n          throw @error err, 'commit'\n          \n        finally\n          @state.locked = false\n\n        return true\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @debug => \"[revert] #{@pending.size} changes\"\n        # below is hackish but works to make a copy of current value\n        # to be used as ctx.prior during revert commit binding call\n        @state.value = @toJSON()\n        await prop.revert opts for prop from @changes\n        @debug => \"[revert] re-add changed props\"\n        @add prop for prop from @changes\n        await super opts\n\n      clean: (opts={}) ->\n        # traverse down the children and clean their state\n        prop.clean opts for prop from @changes\n        @pending.clear()\n        super()\n        \n        \n\n### toJSON\n\nThis call creates a new copy of the current `Property.data`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        props = @props\n        value = switch\n          when props.length\n            obj = {}\n            for prop in props when prop.enumerable and (state or prop.mutable)\n              value = prop.toJSON false, state\n              obj[prop.key] = value if value?\n            obj\n          else @value\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        output = super arguments...\n        return Object.assign output, children: @children.size\n        \n    module.exports = Container\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"512099484576fabfd011d665edfa2149eb81fb05","subject":"Extracted a helper function to eliminate duplicate logic in _find_* methods","message":"Extracted a helper function to eliminate duplicate logic in _find_* methods\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                if Array.isArray val\n                  \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else\n                  \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = [ ]\n\n                for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  if Array.isArray validator\n                    for v in validator\n                      Madul.FIRE '$.Madul.validator.execute', \"#{v}\": args[arg]\n\n                      validators.push proto[v].EXECUTE.call proto[v], arg, args[arg]\n                  else\n                    Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                    validators.push proto[validator].EXECUTE.call proto[validator], arg, args[arg]\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, available[strip spec.ref], spec.ref, next\n            else\n              if spec.parent?\n                Madul.FIRE '$.Madul.search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                if Array.isArray val\n                  \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else\n                  \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = [ ]\n\n                for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  if Array.isArray validator\n                    for v in validator\n                      Madul.FIRE '$.Madul.validator.execute', \"#{v}\": args[arg]\n\n                      validators.push proto[v].EXECUTE.call proto[v], arg, args[arg]\n                  else\n                    Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                    validators.push proto[validator].EXECUTE.call proto[validator], arg, args[arg]\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, available[strip spec.ref], spec.ref, next\n            else\n              if spec.parent?\n                Madul.FIRE '$.Madul.search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"228266a313b4cfbb9a43c26c39ca325375b36780","subject":"Extracted helper method for loading deps from package.json","message":"Extracted helper method for loading deps from package.json\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                if Array.isArray val\n                  \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else\n                  \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = [ ]\n\n                for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  if Array.isArray validator\n                    for v in validator\n                      Madul.FIRE '$.Madul.validator.execute', \"#{v}\": args[arg]\n\n                      validators.push proto[v].EXECUTE.call proto[v], arg, args[arg]\n                  else\n                    Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                    validators.push proto[validator].EXECUTE.call proto[validator], arg, args[arg]\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, available[strip spec.ref], spec.ref, next\n            else\n              if spec.parent?\n                Madul.FIRE '$.Madul.search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                if Array.isArray val\n                  \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else\n                  \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = [ ]\n\n                for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  if Array.isArray validator\n                    for v in validator\n                      Madul.FIRE '$.Madul.validator.execute', \"#{v}\": args[arg]\n\n                      validators.push proto[v].EXECUTE.call proto[v], arg, args[arg]\n                  else\n                    Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                    validators.push proto[validator].EXECUTE.call proto[validator], arg, args[arg]\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, available[strip spec.ref], spec.ref, next\n            else\n              if spec.parent?\n                Madul.FIRE '$.Madul.search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b1d6665715bbd26b999b76df4b8752960bb9f7ae","subject":"Fix removal of sockets on shutdown","message":"Fix removal of sockets on shutdown\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nInitialize sane values.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\nInstance of express.\n\n\t\tapp: null\n\nInstance of http\n\n\t\tserver: null\n\nInstance of socket.io\n\n\t\tio: null\n\nStatistics for the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting nodePush'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing outbound socket'\n\nStart HTTP service.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\tlistenCallback = =>\n\nShed root privilegies.\n\n\t\t\t\tif process.getuid() is 0 or process.getgid() is 0\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\t\t\t\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\t\t\t\t\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\treturn unless \/[a-zA-Z0-9-_.]+$\/.test name\n\t\t\t\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\nPass data to the browsers and close connection.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nKill connection after 5 seconds.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket if not config.inbound.useTCP and fs.existsSync config.inbound.socket\n\t\t\tfs.unlinkSync config.outbound.socket if not config.outbound.useTCP and fs.existsSync config.outbound.socket\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","old_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nInitialize sane values.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\nInstance of express.\n\n\t\tapp: null\n\nInstance of http\n\n\t\tserver: null\n\nInstance of socket.io\n\n\t\tio: null\n\nStatistics for the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting nodePush'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing outbound socket'\n\nStart HTTP service.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\tlistenCallback = =>\n\nShed root privilegies.\n\n\t\t\t\tif process.getuid() is 0 or process.getgid() is 0\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\t\t\t\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\t\t\t\t\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\treturn unless \/[a-zA-Z0-9-_.]+$\/.test name\n\t\t\t\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\nPass data to the browsers and close connection.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nKill connection after 5 seconds.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket unless config.inbound.useTCP\n\t\t\tfs.unlinkSync config.outbound.socket unless config.outbound.useTCP\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"19e287aeaed9f2ccd72b5634bfe961cfb54036db","subject":"missed the dog","message":"missed the dog\n","repos":"nhz-io\/cnl","old_file":"source\/element.litcoffee","new_file":"source\/element.litcoffee","new_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\nA visual element.\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element(args)\n\nCreates an Element instance.\n\n      constructor: ->\n        super\n\nCopy the element origin if it was set from named arguments\n\n        if @origin then @origin = x:(@origin.x or 0), y:(@origin.y or 0)\n\nCopy the element regions if they were set from named arguments\n\n        if regions = @regions\n          @regions = {}\n          @regions[name] = region for name, region of regions\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nAdd capturing extendable listener\n\n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n\n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args**\n* Type: [Object][Object] - named arguments\n\n* **args.origin**\n* Type: [Object][Object] - origin coordinates\n\n* **args.origin.x**\n* Type: [Number][Number] - x coordinate\n\n* **args.origin.y**\n* Type: [Number][Number] - y coordinate\n\n* **args.regions** - named regions\n* Type: [Object][Object]\n\n* **args.regions.{NAME}**\n* Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## PROPERTIES\n\n### #origin\n* Type: [Object][Object] - origin coordinates\n    * **x**\n      * Type: [Number][Number] - x coordinate\n    * **y**\n      * Type: [Number][Number] - y coordinate\n\n### #regions\n* Type: [Object][Object]\n    * **{NAME}**\n    * Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## METHODS\n### #localizeEventCoordinates(event) ->\n* Returns: [Element][Element]\n\nHelper method, to localize event coordinates.\n\n      localizeEventCoordinates: (event) ->\n        if event\n\nIf event already has localized **x**, use it instead of absolute **x**\n\n          x = (if event.localX? then event.localX else event.x)\n          event.localX = x - (@origin?.x or 0)\n\nIf event already has localized **y**, use it instead of absolute **y**\n\n          y = (if event.localY? then event.localY else event.y)\n          event.localY = y - (@origin?.y or 0)\n\n        return this\n---\n\n### #getEventRegions(event)\n* Returns: [Object][Object] - named set of matching regions\n\nHelper method, to get element regions that match the event.\n\n      getEventRegions: (event) ->\n\nProceed only if event coordinates are localized\n\n        if event and (x = event.localX)? and (y = event.localY)?\n          result = {}\n\nWalk through the element regions\n\n          for name, $ of @regions\n\nand add the region to the result if event localized coordinates are within\nthe region rectangle.\n\n            if $[0] <= x <= ($[0] + $[2]) and $[1] <= y <= ($[1] + $[3])\n              result[name] = $\n\n        return result\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousemove** listener\n\n      mousemoveCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousemoveEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousedown** listener\n\n      mousedownCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousedownEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mouseup** listener\n\n      mouseupCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mouseupEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousemoveListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousemoveListener: -> this\n\n---\n\n### #mousedownListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousedownListener: -> this\n\n---\n\n### #mouseupListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mouseupListener: -> this\n\n[Element]: .\/element\n\n[Parent]: .\/index.litcoffee\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n[Number]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Number\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[Array]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Array\n","old_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\nA visual element.\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element(args)\n\nCreates an Element instance.\n\n      constructor: ->\n        super\n\nCopy the element origin if it was set from named arguments\n\n        if @origin then @origin = x:(@origin.x or 0), y:(@origin.y or 0)\n\nCopy the element regions if they were set from named arguments\n\n        if regions = @regions\n          @regions = {}\n          @regions[name] = region for name, region of regions\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nAdd capturing extendable listener\n\n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n\n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args**\n* Type: [Object][Object] - named arguments\n\n* **args.origin**\n* Type: [Object][Object] - origin coordinates\n\n* **args.origin.x**\n* Type: [Number][Number] - x coordinate\n\n* **args.origin.y**\n* Type: [Number][Number] - y coordinate\n\n* **args.regions** - named regions\n* Type: [Object][Object]\n\n* **args.regions.{NAME}**\n* Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## PROPERTIES\n\n### #origin\n* Type: [Object][Object] - origin coordinates\n    * **x**\n      * Type: [Number][Number] - x coordinate\n    * **y**\n      * Type: [Number][Number] - y coordinate\n\n### #regions\n* Type: [Object][Object]\n    * **{NAME}**\n    * Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## METHODS\n### #localizeEventCoordinates(event) ->\n* Returns: [Element][Element]\n\nHelper method, to localize event coordinates.\n\n      localizeEventCoordinates: (event) ->\n        if event\n\nIf event already has localized **x**, use it instead of absolute **x**\n\n          x = (if event.localX? then event.localX else event.x)\n          event.localX = x - (@origin?.x or 0)\n\nIf event already has localized **y**, use it instead of absolute **y**\n\n          y = (if event.localY? then event.localY else event.y)\n          event.localY = y - (origin?.y or 0)\n\n        return this\n---\n\n### #getEventRegions(event)\n* Returns: [Object][Object] - named set of matching regions\n\nHelper method, to get element regions that match the event.\n\n      getEventRegions: (event) ->\n\nProceed only if event coordinates are localized\n\n        if event and (x = event.localX)? and (y = event.localY)?\n          result = {}\n\nWalk through the element regions\n\n          for name, $ of @regions\n\nand add the region to the result if event localized coordinates are within\nthe region rectangle.\n\n            if $[0] <= x <= ($[0] + $[2]) and $[1] <= y <= ($[1] + $[3])\n              result[name] = $\n\n        return result\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousemove** listener\n\n      mousemoveCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousemoveEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousedown** listener\n\n      mousedownCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousedownEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mouseup** listener\n\n      mouseupCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mouseupEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousemoveListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousemoveListener: -> this\n\n---\n\n### #mousedownListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousedownListener: -> this\n\n---\n\n### #mouseupListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mouseupListener: -> this\n\n[Element]: .\/element\n\n[Parent]: .\/index.litcoffee\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n[Number]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Number\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[Array]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Array\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"07a557d0b804a0d8477d3e4e455f854ae046f3f0","subject":"Document stencil factory.","message":"Document stencil factory.","repos":"louismrose\/eugenia-live,louismrose\/eugenia-live","old_file":"app\/scripts\/viewmodels\/drawings\/stencils\/stencil_factory.litcoffee","new_file":"app\/scripts\/viewmodels\/drawings\/stencils\/stencil_factory.litcoffee","new_contents":"## StencilFactory\nThe following class is responsible for instantiating Stencils from Shapes.\nStencils are used to render the elements of a drawing. Stencils are \nconstructed from Shapes, which are defined by users. Shapes specify both \nthe abstract and concrete syntax of drawing elements.\n\n    define [\n      'viewmodels\/drawings\/stencils\/composite_stencil'\n      'viewmodels\/drawings\/stencils\/rectangle_stencil'\n      'viewmodels\/drawings\/stencils\/rounded_rectangle_stencil'\n      'viewmodels\/drawings\/stencils\/ellipse_stencil'\n      'viewmodels\/drawings\/stencils\/regular_polygon_stencil'\n      'viewmodels\/drawings\/stencils\/label_stencil'\n    ], (CompositeStencil, RectangleStencil, RoundedRectangleStencil, EllipseStencil, RegularPolygonStencil, LabelStencil) ->\n\nA shape will contain an array of elements and possibly a label. We add the \nlabel stencil last, as it acts as a sort of \"overlay\" for the other stencil(s).\n\n      class StencilFactory\n        convert: (shape) =>\n          @_addLabel(shape, @_convertElements(shape))\n\nWhen a shape contains a label, we pass along the label's parameters and the stencil\nto be wrapped by the label stencil. Otherwise, we simply return the original,\nunlabelled stencil.\n\n        _addLabel: (shape, stencil) =>\n          if shape.label\n            new LabelStencil(shape.label, stencil)\n          else\n            stencil\n            \nThe shape will comprise one or more elements, and we convert each element into a\nstencil in turn. We keep track of the number of stencils that were created, returning\na composite stencil only when necessary.\n            \n        _convertElements: (shape) =>\n          stencils = (@_elementToStencil(element) for element in shape.elements)\n      \n          if stencils.length == 1\n            stencils[0]\n          else\n            new CompositeStencil(stencils)\n        \nThe figure property of an element object indicates which type of stencil must be \ninstantiated (e.g., `rectangle` or `ellipse`). We first convert the figure.name \nproperty to the name of a Coffeescript class, and then instantiate it.\n        \n        _elementToStencil: (element) =>\n          type = @_figureToStencilType(element.figure)\n          new type(element)\n\nWe store a map (object) that allows us to lookup the Coffeescript class to be\ninstantiated for each type of figure. This could have been implemented using a \nswitch statement.\n        \n        _figureToStencilType: (figure) =>\n          type = @_figures[figure]\n          throw new Error(\"#{stencilSpecification.figure} is not a valid type of stencil\") unless type\n          type\n\n        _figures:\n          rectangle: RectangleStencil\n          rounded: RoundedRectangleStencil\n          ellipse: EllipseStencil\n          polygon: RegularPolygonStencil","old_contents":"# Rendering\nThe following class is responsible for instantiating Stencils from Shapes.\nStencils are used to render the elements of a drawing. Stencils are \nconstructed from Shapes, which are defined by users. Shapes specify both \nthe abstract and concrete syntax of drawing elements.\n\n    define [\n      'viewmodels\/drawings\/stencils\/composite_stencil'\n      'viewmodels\/drawings\/stencils\/rectangle_stencil'\n      'viewmodels\/drawings\/stencils\/rounded_rectangle_stencil'\n      'viewmodels\/drawings\/stencils\/ellipse_stencil'\n      'viewmodels\/drawings\/stencils\/regular_polygon_stencil'\n      'viewmodels\/drawings\/stencils\/label_stencil'\n    ], (CompositeStencil, RectangleStencil, RoundedRectangleStencil, EllipseStencil, RegularPolygonStencil, LabelStencil) ->\n\n      class StencilFactory\n        convert: (shape) =>\n          @_addLabel(shape, @_convertElements(shape))\n\n        _addLabel: (shape, stencil) =>\n          if shape.label\n            new LabelStencil(shape.label, stencil)\n          else\n            stencil\n            \n        _convertElements: (shape) =>\n          stencils = (@_elementToStencil(element) for element in shape.elements)\n      \n          if stencils.length == 1\n            stencils[0]\n          else\n            new CompositeStencil(stencils)\n        \n        _elementToStencil: (element) =>\n          type = @_figureToStencilType(element.figure)\n          new type(element)\n        \n        _figureToStencilType: (figure) =>\n          type = @_figures[figure]\n          throw new Error(\"#{stencilSpecification.figure} is not a valid type of stencil\") unless type\n          type\n\n        _figures:\n          rectangle: RectangleStencil\n          rounded: RoundedRectangleStencil\n          ellipse: EllipseStencil\n          polygon: RegularPolygonStencil","returncode":0,"stderr":"","license":"epl-1.0","lang":"Literate CoffeeScript"}
{"commit":"79c4f9813ed3f098d5b9b07f17b6b0342764e67e","subject":"Changed validator docstring","message":"Changed validator docstring\n","repos":"laconalabs\/elliptical,lacona\/lacona","old_file":"src\/plugins\/validator.litcoffee","new_file":"src\/plugins\/validator.litcoffee","new_contents":"#Validator\n\n\tmodule.exports =\n\t\tscope:\n\t\t\t_validate: (inputString, data, done) ->\n\t\t\t\tif @$call(@validate, inputString)\n\t\t\t\t\tdata\n\t\t\t\t\t\tdisplay: inputString\n\t\t\t\t\t\tvalue: inputString\n\t\t\t\tdone()\n\n\t\tschema:\n\t\t\tname: 'validator'\n\t\t\troot:\n\t\t\t\ttype: 'value'\n\t\t\t\tcompute: '_validate'\n\t\t\t\tid: '@value'\n","old_contents":"#Literal\n\n\tmodule.exports =\n\t\tscope:\n\t\t\t_validate: (inputString, data, done) ->\n\t\t\t\tif @$call(@validate, inputString)\n\t\t\t\t\tdata\n\t\t\t\t\t\tdisplay: inputString\n\t\t\t\t\t\tvalue: inputString\n\t\t\t\tdone()\n\n\t\tschema:\n\t\t\tname: 'validator'\n\t\t\troot:\n\t\t\t\ttype: 'value'\n\t\t\t\tcompute: '_validate'\n\t\t\t\tid: '@value'\n","returncode":0,"stderr":"","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"e5e8203c3df30fc77f5aef140d1cea9389a6d396","subject":"added regions, origin, parameters and properties","message":"added regions, origin, parameters and properties\n","repos":"nhz-io\/cnl","old_file":"source\/element.litcoffee","new_file":"source\/element.litcoffee","new_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\nA visual element.\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element(args)\n\nCreates an Element instance.\n\n      constructor: ->\n        super\n\nCopy the element origin if it was set from named arguments\n\n        if @origin then @origin = x:(@origin.x or 0), y:(@origin.y or 0)\n\nCopy the element regions if they were set from named arguments\n\n        if regions = @regions\n          @regions = {}\n          @regions[name] = region for name, region of regions\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nAdd capturing extendable listener\n\n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n\n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args**\n* Type: [Object][Object] - named arguments\n\n* **args.origin**\n* Type: [Object][Object] - origin coordinates\n\n* **args.origin.x**\n* Type: [Number][Number] - x coordinate\n\n* **args.origin.y**\n* Type: [Number][Number] - y coordinate\n\n* **args.regions** - named regions\n* Type: [Object][Object]\n\n* **args.regions.{NAME}**\n* Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## PROPERTIES\n\n### #origin\n* Type: [Object][Object] - origin coordinates\n    * **x**\n      * Type: [Number][Number] - x coordinate\n    * **y**\n      * Type: [Number][Number] - y coordinate\n\n### #regions\n* Type: [Object][Object]\n    * **{NAME}**\n    * Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## METHODS\n### #localizeEventCoordinates(event) ->\n* Returns: [Element][Element]\n\nHelper method, to localize event coordinates.\n\n      localizeEventCoordinates: (event) ->\n        if event\n\nIf event already has localized **x**, use it instead of absolute **x**\n\n          x = (if event.localX? then event.localX else event.x)\n          event.localX = x - (@origin?.x or 0)\n\nIf event already has localized **y**, use it instead of absolute **y**\n\n          y = (if event.localY? then event.localY else event.y)\n          event.localY = y - (origin?.y or 0)\n\n        return this\n---\n\n### #getEventRegions(event)\n* Returns: [Object][Object] - named set of matching regions\n\nHelper method, to get element regions that match the event.\n\n      getEventRegions: (event) ->\n\nProceed only if event coordinates are localized\n\n        if event and (x = event.localX)? and (y = event.localY)?\n          result = {}\n\nWalk through the element regions\n\n          for name, $ of @regions\n\nand add the region to the result if event localized coordinates are within\nthe region rectangle.\n\n            if $[0] <= x <= ($[0] + $[2]) and $[1] <= y <= ($[1] + $[3])\n              result[name] = $\n\n        return result\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousemove** listener\n\n      mousemoveCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousemoveEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousedown** listener\n\n      mousedownCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousedownEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mouseup** listener\n\n      mouseupCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mouseupEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousemoveListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousemoveListener: -> this\n\n---\n\n### #mousedownListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousedownListener: -> this\n\n---\n\n### #mouseupListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mouseupListener: -> this\n\n[Element]: .\/element\n\n[Parent]: .\/index.litcoffee\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n[Number]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Number\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[Array]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Array\n","old_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\nA visual element.\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element()\n\nCreates an Element instance.\n\n      constructor: ->\n        super\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nAdd capturing extendable listener\n          \n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n          \n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## METHODS\n### #localizeEventCoordinates(event) ->\n* Returns: [Element][Element]\n\nHelper method, to localize event coordinates.\n    \n      localizeEventCoordinates: (event) ->\n        if event\n\nIf event already has localized **x**, use it instead of absolute **x**\n\n          x = (if event.localX? then event.localX else event.x)                  \n          event.localX = x - (@origin?.x or 0)\n\nIf event already has localized **y**, use it instead of absolute **y**\n          \n          y = (if event.localY? then event.localY else event.y)\n          event.localY = y - (origin?.y or 0)\n\n        return this\n---\n\n### #getEventRegions(event)\n* Returns: [Object][Object] - named set of matching regions\n\nHelper method, to get element regions that match the event.\n      \n      getEventRegions: (event) ->\n\nProceed only if event coordinates are localized\n\n        if event and (x = event.localX)? and (y = event.localY)?          \n          result = {}\n\nWalk through the element regions\n\n          for name, $ of @regions\n\nand add the region to the result if event localized coordinates are within\nthe region rectangle.\n\n            if $[0] <= x <= ($[0] + $[2]) and $[1] <= y <= ($[1] + $[3])\n              result[name] = $\n\n        return result\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousemove** listener\n    \n      mousemoveCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousemoveEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousedown** listener\n\n      mousedownCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousedownEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mouseup** listener\n      \n      mouseupCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n        \n        @___runtime.mouseupEvent = event\n        @localizeEventCoordinates event\n        \n        return this\n\n---\n\n### #mousemoveListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mousemoveListener: -> this\n\n---\n\n### #mousedownListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mousedownListener: -> this\n\n---\n\n### #mouseupListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mouseupListener: -> this\n\n\n[Element]: .\/element\n\n[Parent]: .\/index.litcoffee\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5bd119869632906c1721a1e9554923409d490c19","subject":"Use delegates file written in coffeescript","message":"Use delegates file written in coffeescript\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/cli.litcoffee","new_file":"lib\/cli.litcoffee","new_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    Madul = require 'madul'\n\n    if process.env.SKYLL_MADUL_LOGGING == 'true'\n      require 'magnus'\n\n    Skyll = require '.\/index'\n    args  = require '.\/arguments'\n    uuid  = require 'node-uuid'\n    fs    = require 'fs'\n    path  = require 'path'\n\n    EXTRACT = [\n      'rows'\n      'columns'\n      'width'\n      'height'\n      'multiplier'\n      'pipeline'\n      'block'\n      'ground'\n      'step_count'\n      'wall'\n    ]\n\n    new Skyll()\n      .initialize args\n      .then (mod) ->\n        levels = [ ]\n\n        if args._?.length > 0\n          levels = levels.concat argv._\n        else if args.l?\n          for level in [0...argv.l]\n            levels.push uuid.v4()\n        else if Array.isArray args.levels\n          for level in args.levels\n            levels.push level\n        else if args.levels? == false\n          levels.push new Date().toString()\n\n        if args.delegates?\n          location = args.delegates\n        else\n          location = path.join __dirname, 'delegates.js'\n\n        fs.stat location, (err) ->\n          if err?\n            mod.warn 'file-not-found', location\n          else\n            delegates = require location\n            next      = 0\n            input     = { }\n            pipe      = [ ]\n\n            for own key, val of args\n              input[key] = val if EXTRACT.includes key\n\n\n            Madul.DUMMY pipe, (dum) ->\n              dum.render_pipeline = [ ]\n\n              for p in input.pipeline\n                if Array.isArray p\n                  new_pipeline = for q in p\n                    dum[Madul.PARSE_SPEC(q).ref]\n\n                  dum.render_pipeline.push new_pipeline\n                else\n                  dum.render_pipeline.push dum[Madul.PARSE_SPEC(p).ref]\n\n              args = { }\n              name = new Date().toString()\n\n              for own key, val of input\n                args[key] = val if EXTRACT.includes key\n\n              render = (level) ->\n                mod.craft level, input, dum.render_pipeline, delegates\n                  .then -> render levels[next] if ++next < levels.length\n\n              render levels[next]\n","old_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    Madul = require 'madul'\n\n    if process.env.SKYLL_MADUL_LOGGING == 'true'\n      require 'magnus'\n\n    Skyll = require '.\/index'\n    args  = require '.\/arguments'\n    uuid  = require 'node-uuid'\n    fs    = require 'fs'\n    path  = require 'path'\n\n    EXTRACT = [\n      'rows'\n      'columns'\n      'width'\n      'height'\n      'multiplier'\n      'pipeline'\n      'block'\n      'ground'\n      'step_count'\n      'wall'\n    ]\n\n    new Skyll()\n      .initialize args\n      .then (mod) ->\n        levels = [ ]\n\n        if args._?.length > 0\n          levels = levels.concat argv._\n        else if args.l?\n          for level in [0...argv.l]\n            levels.push uuid.v4()\n        else if Array.isArray args.levels\n          for level in args.levels\n            levels.push level\n        else if args.levels? == false\n          levels.push new Date().toString()\n\n        if args.delegates?\n          location = args.delegates\n        else\n          location = path.join process.cwd(), 'skyll.delegates.js'\n\n        fs.stat location, (err) ->\n          if err?\n            mod.warn 'file-not-found', location\n          else\n            delegates = require location\n            next      = 0\n            input     = { }\n            pipe      = [ ]\n\n            for own key, val of args\n              input[key] = val if EXTRACT.includes key\n\n\n            Madul.DUMMY pipe, (dum) ->\n              dum.render_pipeline = [ ]\n\n              for p in input.pipeline\n                if Array.isArray p\n                  new_pipeline = for q in p\n                    dum[Madul.PARSE_SPEC(q).ref]\n\n                  dum.render_pipeline.push new_pipeline\n                else\n                  dum.render_pipeline.push dum[Madul.PARSE_SPEC(p).ref]\n\n              args = { }\n              name = new Date().toString()\n\n              for own key, val of input\n                args[key] = val if EXTRACT.includes key\n\n              render = (level) ->\n                mod.craft level, input, dum.render_pipeline, delegates\n                  .then -> render levels[next] if ++next < levels.length\n\n              render levels[next]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"44b0678b107e27406a2637e595aee534acade365","subject":"webpack","message":"webpack\n","repos":"glebm\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,duereg\/tile-thinger,vmlinz\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template,duereg\/tile-thinger,glebm\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template","old_file":"webpack.config.litcoffee","new_file":"webpack.config.litcoffee","new_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc),\nand processes JS `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    path    = require('path')\n    webpack = require('webpack')\n    _       = require('lodash')\n\n## CSS configuration\n\nList of loader names for CSS files:\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?last 2 versions']\n\nStyle module loaders (used later):\n\n    styleLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\"sass?precision=10&outputStyle=expanded&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/, loaders: cssLoaders }\n    ]\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not `.js` files. Create plugin instance (used later):\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\nOverride style loaders to use `ExtractTextPlugin`:\n\n    styleLoaders = styleLoaders.map (e) ->\n      test: e.test\n      loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!'))\n\n## Configuration\n\n    module.exports =\n\nList of bundle entry points, i.e. packages to compile in the distribution. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n      entry:\n        main             : \".\/src\/scripts\/main.litcoffee\"\n        \"styles\"         : \".\/src\/styles\/styles.scss\"\n        \"vendor\/es5-shim\": \".\/bower_components\/es5-shim\/es5-shim.js\"\n        \"vendor\/es5-sham\": \".\/bower_components\/es5-shim\/es5-sham.js\"\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n\nOutput options:\n\n      output:\n        path         : path.join(__dirname, \"dist\", \"assets\")\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: ['bower_components', 'node_modules']\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleLoaders.concat [\n          { test: \/\\.gif$\/, loader: \"url?limit=10000&minetype=image\/gif\" }\n          { test: \/\\.jpg$\/, loader: \"url?limit=10000&minetype=image\/jpg\" }\n          { test: \/\\.png$\/, loader: \"url?limit=10000&minetype=image\/png\" }\n          { test: \/\\.js$\/, loader: \"jsx\" }\n          { test: \/\\.coffee$\/, loader: \"jsx!coffee\" }\n          { test: \/\\.litcoffee$\/, loader: \"jsx!coffee?literate\"}\n          # url-loader embeds DataUrls.\n          { test: \/\\.woff$\/, loader: \"url?limit=10000&minetype=application\/font-woff\" }\n          # file-loader emits files.\n          { test: \/\\.ttf$\/, loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n          { test: \/\\.eot$\/, loader: \"file?mimetype=application\/x-font-ttf\" }\n          { test: \/\\.svg$\/, loader: \"file?mimetype=image\/svg+xml\" }\n        ]\n        noParse: \/\\.min\\.js$\/\n\nDefine the plugins:\n\n      plugins: [\n\n`DefinePlugin` defines a variable that will be substituted in the assets (a la macro):\n\n        new webpack.DefinePlugin(__PRODUCTION__: JSON.stringify(false))\n\n`extractTextPlugin` (defined above) will compile CSS to a .css file, as opposed to inlining it as a string in a .js file.\n\n        extractTextPlugin\n      ]\n\n\n## Production\n\nExport a method that applies production settings (used in gulpfile):\n\n      useProductionSettings: ->\n\nProduction plugins:\n\n        plugins = @plugins.concat [\n\nMinify JavaScript with UglifyJS:\n\n          new webpack.optimize.UglifyJsPlugin()\n        ]\n\nSet `__PRODUCTION__` to true in DefinePlugin:\n\n        for plugin in plugins when plugin.definitions?.__PRODUCTION__\n          plugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\nTell `ExtractTextPlugin` to append hashes:\n\n        for plugin in plugins when plugin.filename == '[name].css'\n          plugin.filename = '[name]-[hash].css'\n\nMerge in production config (deep merge):\n\n        _.merge @,\n\nDisable development settings:\n\n          debug: false\n          watch: false\n          devtool: null\n\nAdd content hashes to the output filenames:\n\n          output:\n            filename: \"[name]-[hash].js\"\n\nProduction-only plugins:\n\n          plugins: plugins\n","old_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc),\nand processes JS `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    path    = require('path')\n    webpack = require('webpack')\n    _       = require('lodash')\n\n## CSS configuration\n\nList of loader names for CSS files:\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?last 2 versions']\n\nStyle module loaders (used later):\n\n    styleLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\"sass?precision=10&outputStyle=expanded&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/, loaders: cssLoaders }\n    ]\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not `.js` files. Create plugin instance (used later):\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\nOverride style loaders to use `ExtractTextPlugin`:\n\n    styleLoaders = styleLoaders.map (e) ->\n      test: e.test\n      loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!'))\n\n## Configuration\n\n    module.exports =\n\nList of bundle entry points, i.e. packages to compile in the distribution. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n      entry:\n        main             : \".\/src\/scripts\/main.litcoffee\"\n        \"styles\"         : \".\/src\/styles\/styles.scss\"\n        \"vendor\/es5-shim\": \".\/bower_components\/es5-shim\/es5-shim.js\"\n        \"vendor\/es5-sham\": \".\/bower_components\/es5-shim\/es5-sham.js\"\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n\nOutput options:\n\n      output:\n        path         : path.join(__dirname, \"dist\", \"assets\")\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: ['bower_components', 'node_modules']\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleLoaders.concat [\n          { test: \/\\.gif$\/, loader: \"url?limit=10000&minetype=image\/gif\" }\n          { test: \/\\.jpg$\/, loader: \"url?limit=10000&minetype=image\/jpg\" }\n          { test: \/\\.png$\/, loader: \"url?limit=10000&minetype=image\/png\" }\n          { test: \/\\.js$\/, loader: \"jsx\" }\n          { test: \/\\.coffee$\/, loader: \"jsx!coffee\" }\n          { test: \/\\.litcoffee$\/, loader: \"jsx!coffee?literate\"}\n          # url-loader embeds DataUrls.\n          { test: \/\\.woff$\/, loader: \"url?limit=10000&minetype=application\/font-woff\" }\n          # file-loader emits files.\n          { test: \/\\.ttf$\/, loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n          { test: \/\\.eot$\/, loader: \"file?mimetype=application\/x-font-ttf\" }\n          { test: \/\\.svg$\/, loader: \"file?mimetype=image\/svg+xml\" }\n        ]\n        noParse: \/\\.min\\.js$\/\n\nDefine the plugins:\n\n      plugins: [\n\n`DefinePlugin` defines a variable that will be substituted in the assets (a la macro):\n\n        new webpack.DefinePlugin(__PRODUCTION__: JSON.stringify(false))\n\n`extractTextPlugin` (defined above) will compile CSS to a .css file, as opposed to inlining it as a string in a .js file.\n\n        extractTextPlugin\n      ]\n\n\n## Production\n\nExport a method that applies production settings (used in gulpfile):\n\n      useProductionSettings: ->\n\nProduction plugins:\n\n        plugins = @plugins.concat([\n\nMinify JavaScript with UglifyJS:\n\n          new webpack.optimize.UglifyJsPlugin()\n        ])\n\nSet `__PRODUCTION__` to true in DefinePlugin.\n\n        for plugin in plugins when plugin.definitions?.__PRODUCTION__\n          plugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\n        for plugin in plugins when plugin.filename == '[name].css'\n          plugin.filename = '[name]-[hash].css'\n\nMerge in production config (deep merge):\n\n        _.merge @,\n\nDisable development settings:\n\n          debug: false\n          watch: false\n          devtool: null\n\nAdd content hashes to the output filenames:\n\n          output:\n            filename: \"[name]-[hash].js\"\n\nProduction-only plugins:\n\n          plugins: plugins\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3ca7d0975cc3830d01ce37caec2511c65d401fb5","subject":"changed validator function name","message":"changed validator function name\n","repos":"lacona\/lacona,laconalabs\/elliptical","old_file":"src\/plugins\/validator.litcoffee","new_file":"src\/plugins\/validator.litcoffee","new_contents":"#Validator\n\n\tmodule.exports =\n\t\tscope:\n\t\t\tvalidate: (inputString, data, done) ->\n\t\t\t\t@$call @validate, inputString, (err, isValid) ->\n\t\t\t\t\treturn done(err) if err?\n\t\t\t\t\tif isValid\n\t\t\t\t\t\tdata\n\t\t\t\t\t\t\tdisplay: inputString\n\t\t\t\t\t\t\tvalue: inputString\n\t\t\t\tdone()\n\n\t\tschema:\n\t\t\tname: 'validator'\n\t\t\troot:\n\t\t\t\ttype: 'value'\n\t\t\t\tcompute: 'validate'\n\t\t\t\tid: '@value'\n","old_contents":"#Validator\n\n\tmodule.exports =\n\t\tscope:\n\t\t\t_validate: (inputString, data, done) ->\n\t\t\t\t@$call @validate, inputString, (err, isValid) ->\n\t\t\t\t\treturn done(err) if err?\n\t\t\t\t\tif isValid\n\t\t\t\t\t\tdata\n\t\t\t\t\t\t\tdisplay: inputString\n\t\t\t\t\t\t\tvalue: inputString\n\t\t\t\tdone()\n\n\t\tschema:\n\t\t\tname: 'validator'\n\t\t\troot:\n\t\t\t\ttype: 'value'\n\t\t\t\tcompute: '_validate'\n\t\t\t\tid: '@value'\n","returncode":0,"stderr":"","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"68b0ebae0c3c6c114d1f075d64dd0f2137b670d6","subject":"docs(document): remove Params and Return headings to make docs more coherent","message":"docs(document): remove Params and Return headings to make docs more coherent\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/model\/Document.litcoffee","new_file":"coffee\/model\/Document.litcoffee","new_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n    collections = require('..\/helper\/schema').types\n\n---\n\n## Class: Doc\n\n### new Doc(type, id)\n\n* **string** `type` - document type (collection name)\n* **string** `id` - document id\n\n---\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n### doc.db\n\nMongoDB collection instance where the document is stored.\n\n      @db   = mongo[type]\n\n### doc.id\n\nUnique `ObjectID` for the document. Access through `doc.getId()`.\n\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n\n### doc.type\n\nDocument collection name (object type).\n\n      @type = type\n\n### doc.data\n\nCached document data from Redis. This gets poppulated automaticly when the\na new document is instanciated.\n\n      @data = {}\n\n### doc.chit\n\nCache hit indicator. Accessed through `doc.wasCacheHit()`.\n\n      @chit = false\n\n---\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if Object.keys(data).length\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n### doc.exists()\n\nCheck if document exists. Returns `true` if document exists; otherwise `false`.\n\n---\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n### doc.getId()\n\nGet the unique id for current document. Returns an `ObjectID` if the document\nexists; otherwise `null`.\n\n---\n\n    Doc.prototype.getId = ->\n      @id\n\n\n### doc.wasCacheHit()\n\nCheck if document request was a cache hit. Returns `true` if document request\nwas a cache hit; otherwise `false`.\n\n---\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n### doc.isNotModifiedSince(time)\n\n* **string** `time` - timestamp to check against.\n\nCheck if document has not been modified since a given timestamp. Returns `true`\nif document has not been modified since given timestamp; otherwise `false`.\n\n---\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make UNIX timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n### doc.isMatch(checksum)\n\n* **string** `checksum` - checksum to check against.\n\nCheck if checksum, or Etag, matches current document checksum. Returns `true`\nif checksum matches the current checksum; otherwise `false`.\n\n---\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n### doc.isNoneMatch(checksum)\n\n* **string** `checksum` - checksum to check against.\n\nCheck if checksum, or Etag, doesn't match current document checksum. Return\n`true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n### doc.get([key])\n\n* **string** `key` - get specific object property\n\nGet cached data for the current document. Returns an `object` if `key` is\n`undefined`; otherwise `string`. Will return `undefined` if the given key does\nnot exist.\n\n---\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n### doc.getFull(filter[, cb])\n\n* **object** `filter` - control which object properties are returned\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\nGet the full document data from the database asynchronously. Returns a cursor\nstream if `cb` is undefined.\n\n---\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n### doc.getExpanded(filter, expand, query, cb)\n\n* **object** `filter` - control which object properties are returned\n* **array** `expand` - sub-document property names to expand\n* **object** `query` - query for expanded sub-documents\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\nGet the full document with expanded sub-documents from the database\nasynchronously. To expand a given collection jsut pass the collection name to\nthe `expand` parameter and it will be merged with the document data.\n\n---\n\n    Doc.prototype.getExpanded = (filter, expand, query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      count = 0\n      mapped = {}\n\nSince `expand` might be a user supplied input parameter we need to limit it to\nproperties which are expandable (`collections`). We also remove properties which\nholds no value for this document.\n\n      expand = expand\n        .filter (v) => @data[v] and v in collections\n\nNext we map the string array into an object array on the following format:\n`{ type: String, ids: Array }` where `ids` are ObjectIDs to an document of the\ncollection `type`.\n\n        .map (v) => type: v, ids: @data[v].map (d) -> new ObjectID d\n\nSet up a `final` function which is called when expanded data is ready to be\nmapped to the original document.\n\n      final = () =>\n        @db.findOne _id: @id, filter, (err, doc) ->\n          cb err, Object.assign doc or {}, mapped\n\nIf there are no fields to expand, we just call the `final` function instantly\nand no fields will get expanded.\n\n      return final() if expand.length is 0\n\nSet up a `next` function which is called for each expanded data returned from\nthe database. Expanded data is stored in the `mapped` object which is merged\nwith the main document in `final`. When all expanded fields are mapped `final`\nis called.\n\n      next = (type, _, docs) ->\n        mapped[type] = docs or []\n        return final() if Object.keys(mapped).length == expand.length\n\nGet the expanded sub-documents from the database.\n\n      expand.forEach (x) ->\n        mongo[x.type]\n\nWe find the sub-documents using the ObjectIDs in the expanded fields, that is\nthe easy part. The tricky part is to prevent information leakage of private\ndocuments. This the second part is a `query` limiting the results to public\ndocuments or those owned by the current API user.\n\n          .find Object.assign {_id: $in: x.ids}, query\n\nWe reuse the projection filter from the original document, but since we do not\nknow in advanced who owns a given sub-document we remove the `private` property\nto prevent information leakage.\n\n          .project Object.assign filter, privat: false\n\nBundle all the sub-documents in one array and pass it to the `next` function.\n\n          .toArray next.bind null, x.type\n\n\n### doc.insert(data, cb)\n\n* **object** `data` - data to insert for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\nInserts a new document into database.\n\n---\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n### doc.replace(data, cb)\n\n* **object** `data` - replacement data for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\nReplaces all document data in database.\n\n\n---\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          data._id = @id\n          cb err, warn, data\n\n\n### doc.update(data, cb)\n\n* **object** `data` - replacement object for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\nPartially update the document-data in database. This is some times referred to as\nPATCH in a HTTP \/ REST context.\n\n---\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n### doc.delete(cb)\n\n* **function** `cb` - callback function (**Error** `err`).\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n---\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet', endret: new Date()\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n","old_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n    collections = require('..\/helper\/schema').types\n\n---\n\n## Class: Doc\n\n### Params\n\n* **string** `type` - document type\n* **string** `id` - document id\n\n### Return\n\nNew `Doc`.\n\n---\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n      @db   = mongo[type]\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n      @type = type\n      @data = {}\n      @chit = false\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if Object.keys(data).length\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n## doc.exists()\n\nCheck if document exists.\n\n### Return\n\nReturns `true` if document exists; otherwise `false`.\n\n---\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n## doc.getId()\n\nGet document id (ObjectID) for current document.\n\n### Return\n\nReturns an `ObjectID` if the document has an id; otherwise `null`.\n\n---\n\n    Doc.prototype.getId = ->\n      @id\n\n\n## doc.wasCacheHit()\n\nCheck if document request was a cache hit.\n\n### Return\n\nReturns `true` if document request was a cache hit; otherwise `false`.\n\n---\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n## doc.isNotModifiedSince()\n\nCheck if document has not been modified since a given timestamp.\n\n### Params\n\n* **string** `time` - timestamp to check against.\n\n### Return\n\nReturns `true` if document has not been modified since given timestamp; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make UNIX timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n## doc.isMatch\n\nCheck if checksum, or Etag, matches current document checksum.\n\n### Params\n\n* **string** `checksum` - checksum to check against.\n\n### Return\n\nReturns `true` if checksum matches the current checksum; otherwise `false`.\n\n---\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n## doc.isNoneMatch\n\nCheck if checksum, or Etag, doesn't match current document checksum.\n\n### Params\n\n* **string** `checksum` - checksum to check against.\n\n### Return\n\nReturn `true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n## doc.get()\n\nGet cached data for current document.\n\n### Params\n\n* **string** `key` - get specific object property\n\n### Return\n\nReturns an `object` if `key` is `undefined`; otherwise `string`. Will return\n`undefined` if the given key does not exist.\n\n---\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n## doc.getFull\n\n### Params\n\n* **object** `filter` - control which object properties are returned\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n### doc.getExpanded(filter, expand, query, cb)\n\n* **object** `filter` - control which object properties are returned\n* **array** `expand` - sub-document property names to expand\n* **object** `query` - query for expanded sub-documents\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getExpanded = (filter, expand, query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      count = 0\n      mapped = {}\n\nSince `expand` might be a user supplied input parameter we need to limit it to\nproperties which are expandable (`collections`). We also remove properties which\nholds no value for this document.\n\n      expand = expand\n        .filter (v) => @data[v] and v in collections\n\nNext we map the string array into an object array on the following format:\n`{ type: String, ids: Array }` where `ids` are ObjectIDs to an document of the\ncollection `type`.\n\n        .map (v) => type: v, ids: @data[v].map (d) -> new ObjectID d\n\nSet up a `final` function which is called when expanded data is ready to be\nmapped to the original document.\n\n      final = () =>\n        @db.findOne _id: @id, filter, (err, doc) ->\n          cb err, Object.assign doc or {}, mapped\n\nIf there are no fields to expand, we just call the `final` function instantly\nand no fields will get expanded.\n\n      return final() if expand.length is 0\n\nSet up a `next` function which is called for each expanded data returned from\nthe database. Expanded data is stored in the `mapped` object which is merged\nwith the main document in `final`. When all expanded fields are mapped `final`\nis called.\n\n      next = (type, _, docs) ->\n        mapped[type] = docs or []\n        return final() if Object.keys(mapped).length == expand.length\n\nGet the expanded sub-documents from the database.\n\n      expand.forEach (x) ->\n        mongo[x.type]\n\nWe find the sub-documents using the ObjectIDs in the expanded fields, that is\nthe easy part. The tricky part is to prevent information leakage of private\ndocuments. This the second part is a `query` limiting the results to public\ndocuments or those owned by the current API user.\n\n          .find Object.assign {_id: $in: x.ids}, query\n\nWe reuse the projection filter from the original document, but since we do not\nknow in advanced who owns a given sub-document we remove the `private` property\nto prevent information leakage.\n\n          .project Object.assign filter, privat: false\n\nBundle all the sub-documents in one array and pass it to the `next` function.\n\n          .toArray next.bind null, x.type\n\n\n## doc.insert()\n\nInserts a document into database.\n\n### Params\n\n* **object** `data` - data to insert for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## doc.replace()\n\nReplaces all document data in database.\n\n### Params\n\n* **object** `data` - replacement data for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          data._id = @id\n          cb err, warn, data\n\n\n## doc.update()\n\nPartially update the document-data in database. This is some times referred to as\nPATCH in a HTTP \/ REST context.\n\n### Params\n\n* **object** `data` - replacement object for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n## doc.delete()\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n### Params\n\n* **function** `cb` - callback function (**Error** `err`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet', endret: new Date()\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f8c662d1d249da2a04356f386a95082b0324a824","subject":"More robust path normzalization","message":"More robust path normzalization\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"client\/modules\/pkgman.litcoffee","new_file":"client\/modules\/pkgman.litcoffee","new_contents":"\n# Package manager\n\n*Registers packages and handles hook registration and invocation as well as\nintrospection.*\n\n    debug = require('debug') 'shrub:pkgman'\n    debugSilly = require('debug') 'shrub-silly:pkgman'\n\nIndex by hook and path for faster invocation and introspection.\n\n    hookIndex = {}\n    pathIndex = {}\n\nA list of registered packages.\n\n    _packages = []\n\n    class PkgmanRegistrar\n\nRegistrar function passed to packages to allow them to register hooks and\/or\nrecur into their own subpackages to allow them to.\n\n## *constructor*\n\n*Instantiate the registrar with the current (sub)package path.*\n\n      constructor: (@_path) ->\n\n## PkgmanRegistrar#path\n\n*Get the current (sub) package path.*\n\n      path: -> @_path\n\n## PkgmanRegistrar#recur\n\n* (string array) `paths` - The list of submodule paths to register.\n\n*Recur into subpackages to register them and allow them to register hooks\nand\/or recur further.*\n\n      recur: (paths) ->\n\n        for path in paths\n\n          subpath = \"#{@_path}\/#{path}\"\n\n          debugSilly \"Requiring #{subpath}\"\n          submodule = require subpath\n          debugSilly \"Required #{subpath}\"\n\n          debugSilly \"Registering hooks for #{subpath}\"\n          submodule.pkgmanRegister? new PkgmanRegistrar subpath\n          debugSilly \"Registered hooks for #{subpath}\"\n\n        return\n\n## PkgmanRegistrar#registerHook\n\n* (optional string) `submodule` - Register this hook under a submodule. This is\n  a convenience for when you might need to register more than one\n  implementation of a hook, bur prefer to keep both implementations in the same\n  physical file.\n\n* (string) `hook` - The name of the hook to register.\n\n* (function) `impl` - The hook implementation function. This is invoked when\n  the hook is invoked. The signature of the implementation function may vary,\n  consult the documentation for the specific hook to learn more.\n\n###### TODO: Link to an instance of using the `submodule` arg in core if one exists.\n\n      registerHook: (submodule, hook, impl) ->\n\nIf `submodule` was passed in, modify the path this hook is registered against.\n\n        if impl?\n\n          path = \"#{@_path}\/#{submodule}\"\n\nOtherwise, fix up the args.\n\n        else\n\n          path = @_path\n          impl = hook\n          hook = submodule\n\nPopulate the indexes with the registered hook.\n\n        debugSilly \"Registering hook #{hook}\"\n\n        (hookIndex[hook] ?= []).push path\n        (pathIndex[path] ?= {})[hook] = impl\n\n        debugSilly \"Registered hook #{hook}\"\n\n## pkgman.rebuildPackageCache\n\n*Rebuild the package cache.* **Do not invoke this unless you are absolutely\nsure you know what you're doing.**\n\n    exports.rebuildPackageCache = ->\n      modules = {}\n      hookIndex = {}\n      pathIndex = {}\n\n      for name in _packages\n\nTry to require the package module.\n\n        try\n\n          debugSilly \"Requiring package #{name}\"\n\n          module_ = require name\n\n        catch error\n\nSuppress missing package errors.\n\n          if error.toString() is \"Error: Cannot find module '#{name}'\"\n            debug \"Missing package #{name}.\"\n            continue\n\n          throw error\n\n        debugSilly \"Required package #{name}\"\n\n        modules[name] = module_\n\nRegister hooks.\n\n      for path, module_ of modules\n\n        debugSilly \"Registering hooks for #{path}\"\n        module_.pkgmanRegister? new PkgmanRegistrar path\n        debugSilly \"Registered hooks for #{path}\"\n\n      return\n\n## pkgman.registerPackageList\n\n* (string array) `packages` - The list of packages to register.\n\n*Register a list of packages.*\n\n    exports.registerPackageList = (packages) ->\n      _packages.push.apply _packages, packages\n      exports.rebuildPackageCache()\n\n## pkgman.invoke\n\n* (string) `hook` - The name of the hook to invoke.\n* (args...) `args` - Arguments to pass along to implementations of the hook.\n\n*Invoke a hook with arguments. Return the result as an object, keyed by package\npath.*\n\n    exports.invoke = (hook, args...) ->\n\n      results = {}\n\n      for path in exports.packagesImplementing hook\n        results[path] = exports.invokePackage path, hook, args...\n\n      return results\n\n## pkgman.invokeFlat\n\n* (string) `hook` - The name of the hook to invoke.\n* (args...) `args` - Arguments to pass along to implementations of the hook.\n\n*Invoke a hook with arguments. Return the result as an array.*\n\n    exports.invokeFlat = (hook, args...) ->\n\n      for path in exports.packagesImplementing hook\n        exports.invokePackage path, hook, args...\n\n## pkgman.invokePackage\n\n* (string) `path` - The path of the package whose implementation we're\n  invoking.\n* (string) `hook` - The name of the hook to invoke.\n* (args...) `args` - Arguments to pass along to the hook implementation.\n\n*Invoke a package's implementation of a hook with arguments. Return the\nresult.*\n\n    exports.invokePackage = (path, hook, args...) ->\n      pathIndex?[path]?[hook]? args...\n\n## pkgman.packageExists\n\n* (string) `name` - The name of the package to check.\n\n*Check whether a package exists.*\n\n    exports.packageExists = (name) -> -1 isnt _packages.indexOf name\n\n## pkgman.packagesImplementing\n\n* (string) `hook` - The hook to check.\n\n*Return a list of packages implementing the hook.*\n\n    exports.packagesImplementing = (hook) -> hookIndex?[hook] ? []\n\n## pkgman.normalizePath\n\n* (string) `path` - The path to normalize.\n* (Boolean) `capitalize` - Whether to capitalize the first letter.\n\n*Converts a package path (e.g. `shrub-user\/login`) to a normalized path (e.g.\n`shrubUserLogin`).*\n\n    exports.normalizePath = (path, capitalize = false) ->\n\n      i8n = require 'inflection'\n\n      parts = for part, i in path.split '\/'\n        i8n.camelize i8n.underscore(\n          part.replace \/[^\\w]\/g, '_'\n          0 is i\n        )\n\n      i8n.camelize (i8n.underscore parts.join ''), not capitalize\n","old_contents":"\n# Package manager\n\n*Registers packages and handles hook registration and invocation as well as\nintrospection.*\n\n    debug = require('debug') 'shrub:pkgman'\n    debugSilly = require('debug') 'shrub-silly:pkgman'\n\nIndex by hook and path for faster invocation and introspection.\n\n    hookIndex = {}\n    pathIndex = {}\n\nA list of registered packages.\n\n    _packages = []\n\n    class PkgmanRegistrar\n\nRegistrar function passed to packages to allow them to register hooks and\/or\nrecur into their own subpackages to allow them to.\n\n## *constructor*\n\n*Instantiate the registrar with the current (sub)package path.*\n\n      constructor: (@_path) ->\n\n## PkgmanRegistrar#path\n\n*Get the current (sub) package path.*\n\n      path: -> @_path\n\n## PkgmanRegistrar#recur\n\n* (string array) `paths` - The list of submodule paths to register.\n\n*Recur into subpackages to register them and allow them to register hooks\nand\/or recur further.*\n\n      recur: (paths) ->\n\n        for path in paths\n\n          subpath = \"#{@_path}\/#{path}\"\n\n          debugSilly \"Requiring #{subpath}\"\n          submodule = require subpath\n          debugSilly \"Required #{subpath}\"\n\n          debugSilly \"Registering hooks for #{subpath}\"\n          submodule.pkgmanRegister? new PkgmanRegistrar subpath\n          debugSilly \"Registered hooks for #{subpath}\"\n\n        return\n\n## PkgmanRegistrar#registerHook\n\n* (optional string) `submodule` - Register this hook under a submodule. This is\n  a convenience for when you might need to register more than one\n  implementation of a hook, bur prefer to keep both implementations in the same\n  physical file.\n\n* (string) `hook` - The name of the hook to register.\n\n* (function) `impl` - The hook implementation function. This is invoked when\n  the hook is invoked. The signature of the implementation function may vary,\n  consult the documentation for the specific hook to learn more.\n\n###### TODO: Link to an instance of using the `submodule` arg in core if one exists.\n\n      registerHook: (submodule, hook, impl) ->\n\nIf `submodule` was passed in, modify the path this hook is registered against.\n\n        if impl?\n\n          path = \"#{@_path}\/#{submodule}\"\n\nOtherwise, fix up the args.\n\n        else\n\n          path = @_path\n          impl = hook\n          hook = submodule\n\nPopulate the indexes with the registered hook.\n\n        debugSilly \"Registering hook #{hook}\"\n\n        (hookIndex[hook] ?= []).push path\n        (pathIndex[path] ?= {})[hook] = impl\n\n        debugSilly \"Registered hook #{hook}\"\n\n## pkgman.rebuildPackageCache\n\n*Rebuild the package cache.* **Do not invoke this unless you are absolutely\nsure you know what you're doing.**\n\n    exports.rebuildPackageCache = ->\n      modules = {}\n      hookIndex = {}\n      pathIndex = {}\n\n      for name in _packages\n\nTry to require the package module.\n\n        try\n\n          debugSilly \"Requiring package #{name}\"\n\n          module_ = require name\n\n        catch error\n\nSuppress missing package errors.\n\n          if error.toString() is \"Error: Cannot find module '#{name}'\"\n            debug \"Missing package #{name}.\"\n            continue\n\n          throw error\n\n        debugSilly \"Required package #{name}\"\n\n        modules[name] = module_\n\nRegister hooks.\n\n      for path, module_ of modules\n\n        debugSilly \"Registering hooks for #{path}\"\n        module_.pkgmanRegister? new PkgmanRegistrar path\n        debugSilly \"Registered hooks for #{path}\"\n\n      return\n\n## pkgman.registerPackageList\n\n* (string array) `packages` - The list of packages to register.\n\n*Register a list of packages.*\n\n    exports.registerPackageList = (packages) ->\n      _packages.push.apply _packages, packages\n      exports.rebuildPackageCache()\n\n## pkgman.invoke\n\n* (string) `hook` - The name of the hook to invoke.\n* (args...) `args` - Arguments to pass along to implementations of the hook.\n\n*Invoke a hook with arguments. Return the result as an object, keyed by package\npath.*\n\n    exports.invoke = (hook, args...) ->\n\n      results = {}\n\n      for path in exports.packagesImplementing hook\n        results[path] = exports.invokePackage path, hook, args...\n\n      return results\n\n## pkgman.invokeFlat\n\n* (string) `hook` - The name of the hook to invoke.\n* (args...) `args` - Arguments to pass along to implementations of the hook.\n\n*Invoke a hook with arguments. Return the result as an array.*\n\n    exports.invokeFlat = (hook, args...) ->\n\n      for path in exports.packagesImplementing hook\n        exports.invokePackage path, hook, args...\n\n## pkgman.invokePackage\n\n* (string) `path` - The path of the package whose implementation we're\n  invoking.\n* (string) `hook` - The name of the hook to invoke.\n* (args...) `args` - Arguments to pass along to the hook implementation.\n\n*Invoke a package's implementation of a hook with arguments. Return the\nresult.*\n\n    exports.invokePackage = (path, hook, args...) ->\n      pathIndex?[path]?[hook]? args...\n\n## pkgman.packageExists\n\n* (string) `name` - The name of the package to check.\n\n*Check whether a package exists.*\n\n    exports.packageExists = (name) -> -1 isnt _packages.indexOf name\n\n## pkgman.packagesImplementing\n\n* (string) `hook` - The hook to check.\n\n*Return a list of packages implementing the hook.*\n\n    exports.packagesImplementing = (hook) -> hookIndex?[hook] ? []\n\n## pkgman.normalizePath\n\n* (string) `path` - The path to normalize.\n* (Boolean) `capitalize` - Whether to capitalize the first letter.\n\n*Converts a package path (e.g. `shrub-user\/login`) to a normalized path (e.g.\n`shrubUserLogin`).*\n\n    exports.normalizePath = (path, capitalize = false) ->\n\n      i8n = require 'inflection'\n\n      parts = for part, i in path.split '\/'\n        i8n.camelize(\n          part.replace \/[^\\w]\/g, '_'\n          0 is i\n        )\n\n      i8n.camelize (i8n.underscore parts.join ''), not capitalize\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5496e5a06c35ed0bf2aa56de852ff7ac9a54c86b","subject":"cleanup","message":"cleanup\n","repos":"ldegen\/geometry,ldegen\/geometry","old_file":"src\/cut.litcoffee","new_file":"src\/cut.litcoffee","new_contents":"# The cut - Tool\n\nThis creates a function that cuts a simple polygon ring along\nan infinite line through `s1` and `s2`.\n\nThe ring does not need to be convex, but it must be simple, i.e.\nnot contain self-intersections or zero-length edges.\n\n    module.exports = ([s1,s2])->(ring)->\n\nMost of our lower-level utility functions are already defined\n\n      {coefficients, vInterpolate, vProject, vSubst, vAlmostZero, almostZero\n       coefficient, ringEdges, ringArea} = require '.\/common'\n      ccw = require '.\/ccw'\n      group = require '.\/group'\n      flatMap = (arr, transform) -> [].concat((arr.map(transform))...)\n      mu = coefficient([s1,s2])\n      interpolate = vInterpolate(s1,s2)\n\nWe calculate the oriented area of the ring.\nA positive sign means vertices are labled in counter-clock-wise order\n(assuming positive y points \"up\")\nWe need this info later.\n\n      area = ringArea ring\n      ringIsCCW = (area > 0)\n\nThe algorithem comprises two phases:\n\n- in the first phase, the input ring is\n  cut down into fragments such that each fragment completly lies on either the\n  left or the right side of the cutting line\n\n- in the second phase, the fragments are connected to rings.\n\n## Phase I: cutting the ring into fragments\n\nWe start by transforming our ring into a list of edges that are either on the left or the right side\nof the cutting line.\n\n      edges = flatMap ringEdges(ring), ([a,b])->\n        sideA = - ccw s1, s2, a, true\n        sideB = - ccw s1, s2, b, true\n\nWe have to handle four (five, actually) different cases:\n- when the edge intersects the cutting line we output *two* edges, one on each side.\n- when the edge is a subset of the cutting line, we can still associate it with one side:\n  If it is in the same direction as the cutting line, and the vertices are labeld counter-clock-wise,\n  then we associate it with the left side since the inside of the ring is left. Otherwise we label it right.\n- If one of the two edges is on the cutting line, we need to calculate the associated coefficient\n  so we can later connect the fragments correctly. (see below)\n- the remaining two cases are edges that are entirely on one side.\n\n        switch\n          when sideA * sideB < 0\n            [lambda] = coefficients [s1,s2],[a,b]\n            x = interpolate lambda\n            [\n              start:a\n              end: x\n              endAt: lambda\n              side: Math.sign sideA\n            ,\n              start: x\n              end: b\n              startAt: lambda\n              side: Math.sign sideB\n            ]\n          when sideA is 0 and sideB is 0 # edge is subset of cutting line\n            lambdaA = mu a\n            lambdaB = mu b\n            [\n              start: a\n              startAt: lambdaA\n              end: b\n              endAt: lambdaB\n              side: if ringIsCCW and lambdaA < lambdaB then -1 else 1\n            ]\n          when sideA is 0\n            [\n              start: a\n              startAt: mu a\n              end: b\n              side: Math.sign sideB\n            ]\n          when sideB is 0\n            [\n              start: a\n              end: b\n              endAt: mu b\n              side: Math.sign sideA\n            ]\n          else # same side, none zero\n            [\n              start: a\n              end: b\n              side: Math.sign sideA #or sideB, doesn't matter.\n            ]\n\nNext we collect consecutive edges that are on the same side into groups. We then transform the\nedge groups into fragments.\n\n      fragments = group edges, (edge)->edge.side\n        .map ({value, elements})->\n          [firstEdge,..., lastEdge] = elements\n          firstVertex = firstEdge.start\n          otherVertices = elements.map (edge)->edge.end\n\n          startAt: firstEdge.startAt # maybe undefined for the very first fragment\n          endAt: lastEdge.endAt # maybe undefined for the very last fragment\n          vertices: [firstVertex, otherVertices...]\n          side: value\n\n## Phase II: Connecting the fragments\n\nAll but the first fragment start at the cutting line.\nAll but the last fragment end at the cutting line.\n(Actually, also the first and the last fragment may start\/end at the cutting line, but we don't care.)\nThese points, where fragments touch the cutting line each have an associated coefficient (I tend to call \"lambda\").\nThese lambdas are stored in the `startAt`, `endAt` properties of the fragments and describe the position said start or end\npoint with respect to the cutting line, i.e. `x = s1 + lambda * (s2 - s1)`.\n\nLet's extract these lambdas and sort them along the cutting line.\n\n      lambdas = flatMap fragments, ({startAt,endAt})->[startAt, endAt]\n        .sort()\n        .filter (lambda,i,arr)-> lambda? and lambda isnt arr[i-1]\n\n\nNow that our lambdas are nicely aligned, we observe that when connecting the fragments back together, we always have to connect endpoints\nthat are lying next to each other on the cutting line. Assuming counter-clock-wise labeling, when we are looking at a fragment on the left\nside that ends at `lambda_i`, we need to find the fragment that starts at `lambda_(i+1)` and connect it. For fragments on the right side,\nit would be `lambda_(i-1)` instead. If vertices are labeled clock-wise, it's the other way arround.\nSo let's build a lookup table where we can lookup fragments by their `startAt` property\n\n      fragmentsStartingAt = {}\n      fragmentsStartingAt[fragment.startAt] = fragment for fragment in fragments when fragment.startAt?\n\nNext, we create a data structure that will lookup the \"peer\" of each intersection lambda.\n\n      peerLambdas = {}\n      for i in [0...Math.floor(lambdas.length\/2)]\n        a = lambdas[2*i]\n        b = lambdas[2*i+1]\n        peerLambdas[a] = b\n        peerLambdas[b] = a\n\nWe combin both lookups to create a function that can look at the `endAt`-Property of one\nfragment and find another fragment to continue the ring with.\n\n      findContinuation = (fragment)-> fragmentsStartingAt[peerLambdas[fragment.endAt]]\n\nNow everything is prepared for connecting the fragments to rings. We take one fragment from our list and try to connect\nother fragments to using our lookup table and the rule defined above. All connected fragments are marked \"done\"; we do not\nwant to start a ring on a fragment that is already contained in a ring. When we cannot conect any more fragments, we\nstart the next ring with the next unmarked fragment. We cary on until all fragments are marked done.\n\n      leftRings = []\n      rightRings = []\n\n      for startFragment in fragments when not startFragment.done\n        ring = startFragment.vertices.slice()\n        side = startFragment.side\n        fragment = findContinuation startFragment\n        while fragment? and fragment isnt startFragment\n          ring.push fragment.vertices...\n          fragment.done = true\n          fragment = findContinuation fragment\n\n        # if the ring did not start at a pseudo vertex,\n        # the first and the last vertex will be identical.\n        # Fix it.\n        ring.pop() if ring[0] is ring[ring.length-1]\n\n        switch\n          when side < 0\n            leftRings.push ring\n          when side > 0\n            rightRings.push ring\n          else\n            throw new Error(\"Srsly, wtf?!\")\n\n      [leftRings, rightRings]\n\n","old_contents":"# The cut - Tool\n\nThis creates a function that cuts a simple polygon ring along\nan infinite line through `s1` and `s2`.\n\nThe ring does not need to be convex, but it must be simple, i.e.\nnot contain self-intersections or zero-length edges.\n\n    module.exports = ([s1,s2])->(ring)->\n\n\nMost of our lower-level utility functions are already defined\n\n      {coefficients, vInterpolate, vProject, vSubst, vAlmostZero, almostZero\n       coefficient, ringEdges, ringArea} = require '.\/common'\n      ccw = require '.\/ccw'\n\n      group = require '.\/group'\n      flatMap = (arr, transform) -> [].concat((arr.map(transform))...)\n\nWe define a special intersection test. Any segment intersects our cutting line\nif its end points are not on the same side of the line.\nIn particular we assume a segment to be \"intersecting\" if it is actually a subset of the cutting line\ni.e. both end points reside *on* the cutting line.\nWe will, however, need to do some special treatment of these \"intersections\" later on.\n\n      intersects = (a,b)-> ccw(s1,s2,a,true) * ccw(s1,s2,b,true) <= 0\n\nEach intersection point x lies on the cutting line, so we can describe them\nusing a coefficient lambda such that x = s1 + lambda (s2-s1).\nWe will later use this to sort the pseudo-vertices resulting from intersections along\nthe cutting line.\n\n      mu = coefficient([s1,s2])\n      lambda = (a,b)->\n        l=coefficients([s1,s2],[a,b])?[0]\n        l\n      interpolate = vInterpolate(s1,s2)\n\n\n\nWe calculate the oriented area of the ring.\nA positive sign means vertices are labled in counter-clock-wise order\n(assuming positive y points \"up\")\nWe need this info later.\n\n      area = ringArea ring\n      ringIsCCW = (area > 0)\n\n\nThe algorithem comprises two phases:\n\n- in the first phase, the input ring is\n  cut down into fragments such that each fragment completly lies on either the\n  left or the right side of the cutting line\n\n- int the second phase, the fragments are connected to rings.\n\n## Phase I: cutting the ring into fragments\n\nWe start by transforming our ring into a list of edges that are either on the left or the right side\nof the cutting line.\n\n      edges = flatMap ringEdges(ring), ([a,b])->\n        sideA = - ccw s1, s2, a, true\n        sideB = - ccw s1, s2, b, true\n\nWe have to handle four (five, actually) different cases:\n- when the edge intersects the cutting line we output *two* edges, one on each side.\n- when the edge is a subset of the cutting line, we can still associate it with one side:\n  If it is in the same direction as the cutting line, and the vertices are labeld counter-clock-wise,\n  then we associate it with the left side since the inside of the ring is left. Otherwise we label it right.\n- If one of the two edges is on the cutting line, we need to calculate the associated coefficient\n  so we can later connect the fragments correctly. (see below)\n- the remaining two cases are edges that are entirely on one side.\n\n        switch\n\n          when sideA * sideB < 0\n            [lambda] = coefficients [s1,s2],[a,b]\n            x = interpolate lambda\n            [\n              start:a\n              end: x\n              endAt: lambda\n              side: Math.sign sideA\n            ,\n              start: x\n              end: b\n              startAt: lambda\n              side: Math.sign sideB\n            ]\n\n          when sideA is 0 and sideB is 0 # edge is subset of cutting line\n            lambdaA = mu a\n            lambdaB = mu b\n            [\n              start: a\n              startAt: lambdaA\n              end: b\n              endAt: lambdaB\n              side: if ringIsCCW and lambdaA < lambdaB then -1 else 1\n            ]\n\n          when sideA is 0\n            [\n              start: a\n              startAt: mu a\n              end: b\n              side: Math.sign sideB\n            ]\n          when sideB is 0\n            [\n              start: a\n              end: b\n              endAt: mu b\n              side: Math.sign sideA\n            ]\n          else # same side, none zero\n            [\n              start: a\n              end: b\n              side: Math.sign sideA #or sideB, doesn't matter.\n            ]\n\n\nNext we collect consecutive edges that are on the same side into groups. We then transform the\nedge groups into fragments.\n\n      fragments = group edges, (edge)->edge.side\n        .map ({value, elements})->\n          [firstEdge,..., lastEdge] = elements\n          firstVertex = firstEdge.start\n          otherVertices = elements.map (edge)->edge.end\n\n          startAt: firstEdge.startAt # maybe undefined for the very first fragment\n          endAt: lastEdge.endAt # maybe undefined for the very last fragment\n          vertices: [firstVertex, otherVertices...]\n          side: value\n\n## Phase II: Connecting the fragments\n\nAll but the first fragment start at the cutting line.\nAll but the last fragment end at the cutting line.\n(Actually, also the first and the last fragment may start\/end at the cutting line, but we don't care.)\nThese points, where fragments touch the cutting line each have an associated coefficient (I tend to call \"lambda\").\nThese lambdas are stored in the `startAt`, `endAt` properties of the fragments and describe the position said start or end\npoint with respect to the cutting line, i.e. `x = s1 + lambda * (s2 - s1)`.\n\nLet's extract these lambdas and sort them along the cutting line.\n\n      lambdas = flatMap fragments, ({startAt,endAt})->[startAt, endAt]\n        .sort()\n        .filter (lambda,i,arr)-> lambda? and lambda isnt arr[i-1]\n\n\nNow that our lambdas are nicely aligned, we observe that when connecting the fragments back together, we always have to connect endpoints\nthat are lying next to each other on the cutting line. Assuming counter-clock-wise labeling, when we are looking at a fragment on the left\nside that ends at `lambda_i`, we need to find the fragment that starts at `lambda_(i+1)` and connect it. For fragments on the right side,\nit would be `lambda_(i-1)` instead. If vertices are labeled clock-wise, it's the other way arround.\nSo let's build a lookup table where we can lookup fragments by their `startAt` property\n\n      fragmentsStartingAt = {}\n      fragmentsStartingAt[fragment.startAt] = fragment for fragment in fragments when fragment.startAt?\n\n      peerLambdas = {}\n      for i in [0...Math.floor(lambdas.length\/2)]\n        a = lambdas[2*i]\n        b = lambdas[2*i+1]\n        peerLambdas[a] = b\n        peerLambdas[b] = a\n\n      findContinuation = (fragment)-> fragmentsStartingAt[peerLambdas[fragment.endAt]]\n\n\n\nNow everything is prepared for connecting the fragments to rings. We take one fragment from our list and try to connect\nother fragments to using our lookup table and the rule defined above. All connected fragments are marked \"done\"; we do not\nwant to start a ring on a fragment that is already contained in a ring. When we cannot conect any more fragments, we\nstart the next ring with the next unmarked fragment. We cary on until all fragments are marked done.\n\n      leftRings = []\n      rightRings = []\n\n      for startFragment in fragments when not startFragment.done\n        ring = startFragment.vertices.slice()\n        side = startFragment.side\n        fragment = findContinuation startFragment\n        while fragment? and fragment isnt startFragment\n          ring.push fragment.vertices...\n          fragment.done = true\n          fragment = findContinuation fragment\n\n        # if the ring did not start at a pseudo vertex,\n        # the first and the last vertex will be identical.\n        # Fix it.\n        ring.pop() if ring[0] is ring[ring.length-1]\n\n        switch\n          when side < 0\n            leftRings.push ring\n          when side > 0\n            rightRings.push ring\n          else\n            throw new Error(\"Srsly, wtf?!\")\n\n      [leftRings, rightRings]\n\n\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"d0d8ea41d26341b7d699448404999985fe06c940","subject":"Only pass items not in the EXCLUDE list to EXECUTE call","message":"Only pass items not in the EXCLUDE list to EXECUTE call\n","repos":"bsgbryan\/jyn","old_file":"lib\/server.litcoffee","new_file":"lib\/server.litcoffee","new_contents":"    Madul = require 'madul'\n\n    STATUSES =\n      COMPLETE: 'COMPLETE'\n      ERROR:    'ERROR'\n      PROGRESS: 'PROGRESS'\n\n    EXCLUDE = [\n      'MODULE'\n      'ACTION'\n      'EXECUTE'\n    ]\n\n    class Server extends Madul\n\n      deps: [ 'ws' ]\n\n      boot: (args, done) ->\n        wss = new @ws.Server port: args.ws.port\n\n        wss.on 'connection', (ws) =>\n          ws.on 'message', (mess) =>\n            try\n              input = JSON.parse mess\n            catch e\n              return @_notify ws, STATUSES.ERROR, \"Could not parse as JSON: #{mess}\"\n\n            @handle input\n              .then (output) => @_notify ws, STATUSES.COMPLETE, output\n              .catch   (err) => @_notify ws, STATUSES.ERROR,    err.args? || err\n              .progress (up) => @_notify ws, STATUSES.PROGRESS, up\n\n        done()\n\n      _notify: (socket, status, data) =>\n        if status == STATUSES.ERROR\n          out = { status, message: data }\n        else\n          out = { status, data }\n\n        socket.send JSON.stringify out\n\n      handle:\n        validate:\n          KEY:    [ '.is_present', '.hasnt_expired' ]\n          MODULE: '.is_present'\n          ACTION: '.is_present'\n        before:   '.init_execution_context'\n        behavior: (input) ->\n          args = { }\n\n          for own key, val of input\n            args[key] = val unless EXCLUDE.includes key\n\n          input.EXECUTE args\n            .then     (output) => input.done   output\n            .catch    (err)    => input.fail   err\n            .progress (delta)  => input.update delta\n\n    module.exports = Server\n","old_contents":"    Madul = require 'madul'\n\n    STATUSES =\n      COMPLETE: 'COMPLETE'\n      ERROR:    'ERROR'\n      PROGRESS: 'PROGRESS'\n\n    EXCLUDE = [\n      'MODULE'\n      'ACTION'\n      'EXECUTE'\n    ]\n\n    class Server extends Madul\n\n      deps: [ 'ws' ]\n\n      boot: (args, done) ->\n        wss = new @ws.Server port: args.ws.port\n\n        wss.on 'connection', (ws) =>\n          ws.on 'message', (mess) =>\n            try\n              input = JSON.parse mess\n            catch e\n              return @_notify ws, STATUSES.ERROR, \"Could not parse as JSON: #{mess}\"\n\n            @handle input\n              .then (output) => @_notify ws, STATUSES.COMPLETE, output\n              .catch   (err) => @_notify ws, STATUSES.ERROR,    err.args? || err\n              .progress (up) => @_notify ws, STATUSES.PROGRESS, up\n\n        done()\n\n      _notify: (socket, status, data) =>\n        if status == STATUSES.ERROR\n          out = { status, message: data }\n        else\n          out = { status, data }\n\n        socket.send JSON.stringify out\n\n      handle:\n        validate:\n          KEY:    [ '.is_present', '.hasnt_expired' ]\n          MODULE: '.is_present'\n          ACTION: '.is_present'\n        before:   '.init_execution_context'\n        behavior: (input) ->\n          args = { }\n\n          for own key, val of input\n            if key != 'MODULE' && key != 'ACTION' && key != 'EXECUTE'\n              args[key] = val\n\n          input.EXECUTE args\n            .then     (output) => input.done   output\n            .catch    (err)    => input.fail   err\n            .progress (delta)  => input.update delta\n\n    module.exports = Server\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c3ef85d66787d20cbea1525d4d4a60ca8ed8bdc5","subject":"Fixed a misreferenced variable in matrix.applyToVector.","message":"Fixed a misreferenced variable in matrix.applyToVector.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat","old_file":"src\/matrix.litcoffee","new_file":"src\/matrix.litcoffee","new_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    tempVector = []\n    tempVectorFrom = []\n    tempVectorTo = []\n    fromTemp = []\n    toTemp = []\n    tempVectorX = []\n    tempVectorY = []\n    tempVectorZ = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            module.exports.multiply output, temp3, output\n            return\n\n    vector = require \".\/vector.litcoffee\"\n            \n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\nGiven a vector specifying a translation and a matrix to translate, calling the \n\"translate\" property applies that translation to that matrix.\n            \n        translate: (vector, output) ->\n            output[3] += vector[0]\n            output[7] += vector[1]\n            output[11] += vector[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \nGiven a matrix, input vector and output vector, calling the \"applyToVector\"\nproperty writes the input vector transformed by the matrix to the output vector.\n        \n        applyToVector: (matrix, input, output) ->\n            vector.copy input, tempVector\n            output[0] = tempVector[0] * matrix[0] + tempVector[1] * matrix[1] + tempVector[2] * matrix[2] + matrix[3]\n            output[1] = tempVector[0] * matrix[4] + tempVector[1] * matrix[5] + tempVector[2] * matrix[6] + matrix[7]\n            output[2] = tempVector[0] * matrix[8] + tempVector[1] * matrix[9] + tempVector[2] * matrix[10] + matrix[11]\n            return\n            \nGiven a matrix and output vector, calling the \"getTranslation\" property writes\nthe translation applied by the matrix to the output vector.\n\n        getTranslation: (matrix, output) ->\n            output[0] = matrix[3]\n            output[1] = matrix[7]\n            output[2] = matrix[11]\n\nGiven a matrix and output vector, calling the \"getX\" property writes the vector\nof the matrix's X axis (a scaled normal) to the output vector.\n\n        getX: (matrix, output) ->\n            output[0] = matrix[0]\n            output[1] = matrix[4]\n            output[2] = matrix[8]\n\nGiven a matrix and output vector, calling the \"getY\" property writes the vector\nof the matrix's Y axis (a scaled normal) to the output vector.\n\n        getY: (matrix, output) ->\n            output[0] = matrix[1]\n            output[1] = matrix[5]\n            output[2] = matrix[9]\n            \nGiven a matrix and output vector, calling the \"getZ\" property writes the vector\nof the matrix's Z axis (a scaled normal) to the output vector.\n\n        getZ: (matrix, output) ->\n            output[0] = matrix[2]\n            output[1] = matrix[6]\n            output[2] = matrix[10]\n            \n# setTranslation\n\n- A vector specifying the translation to set.\n- A matrix to set the translation of.\n\nOverwrites the translation of the matrix with the content of the given vector.\n\n        setTranslation: (output, matrix) ->\n            matrix[3] = output[0]\n            matrix[7] = output[1]\n            matrix[11] = output[2]\n\n# setX\n\n- A vector specifying the X axis vector to set.\n- A matrix to set the X axis vector of.\n\nOverwrites the X axis of the matrix with the content of the given vector.\n\n        setX: (output, matrix) ->\n            matrix[0] = output[0]\n            matrix[4] = output[1]\n            matrix[8] = output[2]\n\n# setY\n\n- A vector specifying the Y axis vector to set.\n- A matrix to set the Y axis vector of.\n\nOverwrites the Y axis of the matrix with the content of the given vector.\n\n        setY: (output, matrix) ->\n            matrix[1] = output[0]\n            matrix[5] = output[1]\n            matrix[9] = output[2]\n\n# setZ\n\n- A vector specifying the Z axis vector to set.\n- A matrix to set the Z axis vector of.\n\nOverwrites the Z axis of the matrix with the content of the given vector.\n\n        setZ: (output, matrix) ->\n            matrix[2] = output[0]\n            matrix[6] = output[1]\n            matrix[10] = output[2]\n            \n# interpolate\n\n- An input matrix to interpolate from.\n- An input matrix to interpolate to.\n- A number specifying how far along to interpolate; \"0\" is \"from\" and \"1\" is \n  \"to\".\n- An output matrix.\n\nAttempts to perform a somewhat crude interpolation between the two matrices\nwhich is not very linear.  Good enough for smoothing over small changes.\nPrioritizes the Z and Y axes over the X axis when ensuring orthogonal.\n\n        interpolate: (from, to, alpha, output) ->       \n            module.exports.copy from, fromTemp\n            module.exports.copy to, toTemp\n            module.exports.identity output\n            module.exports.getTranslation fromTemp, tempVectorFrom\n            module.exports.getTranslation toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            module.exports.setTranslation tempVector, output\n            \n            module.exports.getX fromTemp, tempVectorFrom\n            module.exports.getX toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            vector.normalize tempVector, tempVectorX, true  \n            \n            module.exports.getY fromTemp, tempVectorFrom\n            module.exports.getY toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVectorY\n            \n            vector.cross tempVectorX, tempVectorY, tempVectorZ\n            vector.normalize tempVectorZ, tempVectorZ\n            vector.cross tempVectorZ, tempVectorX, tempVectorY\n            vector.normalize tempVectorY, tempVectorY\n            \n            module.exports.setX tempVectorX, output\n            module.exports.setY tempVectorY, output\n            module.exports.setZ tempVectorZ, output\n            return\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","old_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    tempVector = []\n    tempVectorFrom = []\n    tempVectorTo = []\n    fromTemp = []\n    toTemp = []\n    tempVectorX = []\n    tempVectorY = []\n    tempVectorZ = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            module.exports.multiply output, temp3, output\n            return\n\n    vector = require \".\/vector.litcoffee\"\n            \n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\nGiven a vector specifying a translation and a matrix to translate, calling the \n\"translate\" property applies that translation to that matrix.\n            \n        translate: (vector, output) ->\n            output[3] += vector[0]\n            output[7] += vector[1]\n            output[11] += vector[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \nGiven a matrix, input vector and output vector, calling the \"applyToVector\"\nproperty writes the input vector transformed by the matrix to the output vector.\n        \n        applyToVector: (matrix, input, output) ->\n            vector.copy input, vectorTemp\n            output[0] = vectorTemp[0] * matrix[0] + vectorTemp[1] * matrix[1] + vectorTemp[2] * matrix[2] + matrix[3]\n            output[1] = vectorTemp[0] * matrix[4] + vectorTemp[1] * matrix[5] + vectorTemp[2] * matrix[6] + matrix[7]\n            output[2] = vectorTemp[0] * matrix[8] + vectorTemp[1] * matrix[9] + vectorTemp[2] * matrix[10] + matrix[11]\n            return\n            \nGiven a matrix and output vector, calling the \"getTranslation\" property writes\nthe translation applied by the matrix to the output vector.\n\n        getTranslation: (matrix, output) ->\n            output[0] = matrix[3]\n            output[1] = matrix[7]\n            output[2] = matrix[11]\n\nGiven a matrix and output vector, calling the \"getX\" property writes the vector\nof the matrix's X axis (a scaled normal) to the output vector.\n\n        getX: (matrix, output) ->\n            output[0] = matrix[0]\n            output[1] = matrix[4]\n            output[2] = matrix[8]\n\nGiven a matrix and output vector, calling the \"getY\" property writes the vector\nof the matrix's Y axis (a scaled normal) to the output vector.\n\n        getY: (matrix, output) ->\n            output[0] = matrix[1]\n            output[1] = matrix[5]\n            output[2] = matrix[9]\n            \nGiven a matrix and output vector, calling the \"getZ\" property writes the vector\nof the matrix's Z axis (a scaled normal) to the output vector.\n\n        getZ: (matrix, output) ->\n            output[0] = matrix[2]\n            output[1] = matrix[6]\n            output[2] = matrix[10]\n            \n# setTranslation\n\n- A vector specifying the translation to set.\n- A matrix to set the translation of.\n\nOverwrites the translation of the matrix with the content of the given vector.\n\n        setTranslation: (output, matrix) ->\n            matrix[3] = output[0]\n            matrix[7] = output[1]\n            matrix[11] = output[2]\n\n# setX\n\n- A vector specifying the X axis vector to set.\n- A matrix to set the X axis vector of.\n\nOverwrites the X axis of the matrix with the content of the given vector.\n\n        setX: (output, matrix) ->\n            matrix[0] = output[0]\n            matrix[4] = output[1]\n            matrix[8] = output[2]\n\n# setY\n\n- A vector specifying the Y axis vector to set.\n- A matrix to set the Y axis vector of.\n\nOverwrites the Y axis of the matrix with the content of the given vector.\n\n        setY: (output, matrix) ->\n            matrix[1] = output[0]\n            matrix[5] = output[1]\n            matrix[9] = output[2]\n\n# setZ\n\n- A vector specifying the Z axis vector to set.\n- A matrix to set the Z axis vector of.\n\nOverwrites the Z axis of the matrix with the content of the given vector.\n\n        setZ: (output, matrix) ->\n            matrix[2] = output[0]\n            matrix[6] = output[1]\n            matrix[10] = output[2]\n            \n# interpolate\n\n- An input matrix to interpolate from.\n- An input matrix to interpolate to.\n- A number specifying how far along to interpolate; \"0\" is \"from\" and \"1\" is \n  \"to\".\n- An output matrix.\n\nAttempts to perform a somewhat crude interpolation between the two matrices\nwhich is not very linear.  Good enough for smoothing over small changes.\nPrioritizes the Z and Y axes over the X axis when ensuring orthogonal.\n\n        interpolate: (from, to, alpha, output) ->       \n            module.exports.copy from, fromTemp\n            module.exports.copy to, toTemp\n            module.exports.identity output\n            module.exports.getTranslation fromTemp, tempVectorFrom\n            module.exports.getTranslation toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            module.exports.setTranslation tempVector, output\n            \n            module.exports.getX fromTemp, tempVectorFrom\n            module.exports.getX toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            vector.normalize tempVector, tempVectorX, true  \n            \n            module.exports.getY fromTemp, tempVectorFrom\n            module.exports.getY toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVectorY\n            \n            vector.cross tempVectorX, tempVectorY, tempVectorZ\n            vector.normalize tempVectorZ, tempVectorZ\n            vector.cross tempVectorZ, tempVectorX, tempVectorY\n            vector.normalize tempVectorY, tempVectorY\n            \n            module.exports.setX tempVectorX, output\n            module.exports.setY tempVectorY, output\n            module.exports.setZ tempVectorZ, output\n            return\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"63bc42d1cfb310f4805ea42698bdfeeaabb30e13","subject":"Initial commit:100:","message":"Initial commit:100:\n\nOur thoughts inspired - by Albert Einstein.","repos":"BioQL\/BioQL,BioQL\/BioQL","old_file":"src\/readme.litcoffee","new_file":"src\/readme.litcoffee","new_contents":"BioQL<sup>\u00ae<\/sup> [![Apache License](https:\/\/img.shields.io\/badge\/license-Apache-blue.svg)](https:\/\/github.com\/BioQL\/BioQL\/blob\/master\/LICENSE)\n------\n> An efficient Query Language for interpreting genome and proteome.\n\n<i>There are only two ways to live your life. One is as though nothing is a miracle. The other is as though everything is a miracle<\/i> - <b>Albert Einstein<\/b>.\n","old_contents":"BioQL<sup>\u00ae<\/sup> [![Apache License](https:\/\/img.shields.io\/badge\/license-Apache-blue.svg)](https:\/\/github.com\/BioQL\/BioQL\/blob\/master\/LICENSE)\n------\n> An efficient Query Language for interpreting genome and proteome.\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"7251929b080d1952a021a5bc4bb6a597f993658d","subject":"Commenting oj.View.css and theme","message":"Commenting oj.View.css and theme\n","repos":"ojjs\/oj","old_file":"src\/oj.litcoffee","new_file":"src\/oj.litcoffee","new_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = ->\n\n   Prevent oj function from emitting\n\n      oj._argumentsPush()\n\n  oj function acts like a tag method that doesn't emit\n\n      ojml = oj.emit.apply @, arguments\n      oj._argumentsPop()\n      ojml\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.0.14'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\nTODO: Static server side support for loading any generated pages dynamically.\nTODO: Support Backbone routes to trigger page changes.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      jQuery ->\n\n  Compile only the body and below\n\n        bodyOnly = html:1, doctype:1, head:1, link:1, script:1\n        {dom,types} = oj.compile dom:1, html:0, css:0, styles:1, ignore:bodyOnly, (require page)\n\n        if not dom?\n          throw new Error 'oj: dom failed to compile'\n          return\n\n  Find body element\n\n        body = document.getElementsByTagName 'body'\n        if body.length == 0\n          throw new Error('oj: <body> was not found')\n        body = body[0]\n\n  Clear body and insert dom elements\n\n        body.innerHTML = ''\n        if not oj.isArray dom\n          dom = [dom]\n        for d in dom\n          body.appendChild d\n\n  Trigger inserted event for types\n\n        for t in types\n          t.inserted()\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      # TODO: support cloning OJ instances\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n\nIndexing Helpers\n-----------------------------------------------------------------------------\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = ArrayP.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name) ->\n      obj = if oj.isClient then window[name] else global[name]\n      throw new Error(\"oj: #{name} dependency is missing\") unless oj.isDefined obj\n\nDepend on jQuery\n\n    oj.dependency 'jQuery'\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw new Error('oj.isProperty: string expected for second argument') unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argumentsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argumentsStack = []\n\n  Result is top of the stack\n\n    oj._argumentsTop = ->\n      if _argumentsStack.length\n        _argumentsStack[_argumentsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argumentsPush = (args = []) ->\n      _argumentsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argumentsPop = ->\n      if _argumentsStack.length\n        return _argumentsStack.pop()\n      null\n\n  Append argument\n\n    oj._argumentsAppend = (arg) ->\n      top = oj._argumentsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, args...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from args by unioning all objects\n\n      attributes = {}\n      for arg in args\n\n  TODO: evaluate argument if necessary\n\n        if oj.isObject arg\n          _extend attributes, arg\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argumentsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n        else if oj.isFunction arg\n\n          len = oj._argumentsTop().length\n\n  Call the argument it will auto append to oj._argumentsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argumentsTop() weren't changed\n\n          if len == oj._argumentsTop().length and r?\n            oj._argumentsAppend r\n\n        else\n          oj._argumentsAppend arg\n\n  Pop to restore previous context\n\n      oj._argumentsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to\n\n      oj._argumentsAppend ojml\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n        oj[t] = -> oj.tag t, arguments...\n        # Remember the tag name\n        _setTagName oj[t], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = '<!DOCTYPE HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = '<!DOCTYPE html>'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\">'\n\n  Define possible arguments\n\n    doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\">'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\">'\n\n  Define the method\n\n    oj.doctype = (type = 5) ->\n      ojml = doctypes[type]\n\n  Emit as a tag would\n\n      oj._argumentsAppend ojml\n      ojml\n\noj.extend (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.extend = (context = root) ->\n      o = {}\n      for k,v of oj\n        if k[0] != '_'\n          o[k] = v\n      delete o.extend\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* debug - Keep all source including comments\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        styles: false\n        debug: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap or options.styles then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, debug: options.debug, tags:0\n\n      # Generate style tags if necessary\n      if options.styles\n        styles = _cssFromPluginObject pluginCSSMap, debug: options.debug, tags:1\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, styles:styles, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n  TODO: Refactor to use the same code as media queries\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      debug = options.debug ? 0\n      tags = options.tags ? 0\n      minify = options.minify ? 0\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if debug and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if debug then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\ndebug:true will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      debug = options.debug ? 0\n      tags = options.tags ? 0\n      minify = options.minify ? 0\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        when 'jquery'\n          # TODO: Missing unit tests for the jquery case\n          options.html?.push ojml.html()\n          options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML()\n            options.dom?.appendChild ojml.toDOM()\n            if options.css?\n              _extend options.css, ojml.toCSSMap()\n\n      return\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Compile ojml tag (an array)\n    _compileTag = (ojml, options) ->\n\n      # Empty list compiles to nothing\n      return if ojml.length == 0\n\n      # Get tag\n      tag = ojml[0]\n      tagType = typeof tag\n\n      # Allow ojml's tag parameter to be 'table' or table or Table\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n\n      # Fail if we couldn't find a string by now\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n      # Create oj object if tag is capitalized\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n      # Record tag\n      options.tags[tag] = true\n\n      # Get attributes (optional)\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n      # Remaining arguments are children of this tag\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n      # Compile to css if requested\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n      # Compile to html if requested\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n\n      # Compile your children if necessary\n      for child in children\n        # Skip intention if there is only one child\n        if options.debug && children.length > 1\n          options.html?.push \"\\n\\t#{options.indent}\"\n        _compileDeeper _compileAny, child, options\n\n      # Skip intention if there is only one child\n      if options.debug && children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n      # End html tag if you have children or your tag closes\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Allow attributes to take class as an array of strings\n    _attributeClassAllowsArrays = (attr) ->\n      if oj.isArray attr?.class\n        attr.class = attr.join ' '\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # TODO: Consider jsoning anything that isn't a string\n      # any keys that aren't strings are jsoned\n      # _attributesJSONAllKeys attributes\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if $?\n          if oj.isArray ev\n            $(el)[ek].apply @, ev\n          else\n            $(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\n    # oj.toHTML\n    # ------------------------------------------------------------------------------\n    # Make oj directly to HTML. It will ignore all event bindings\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\n    # oj.toCSS\n    # ------------------------------------------------------------------------------\n    # Make oj directly to css. It will ignore all event bindings and html\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        # TODO: Make this O(1)\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        # TODO: Make this O(1)\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # argumentsUnion:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.argumentsUnion = (argList) ->\n      obj = {}\n      list = []\n      for v in argList\n        if oj.isObject v\n          obj = _extend obj, v\n        else\n          list.push v\n      options: obj, args: list\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = $ @el)\n\n        # Get and set id of view from attribute\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all currently set themes (readwrite)\n        themes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n\n              # Wrap k in quotes if it has whitespace\n              if k == 'class'\n                @$el.addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single theme\n        addTheme: (name) ->\n          @$el.addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @$el.removeClass \"theme-#{name}\"\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argumentsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.debug then '\\n' else '')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (debug) -> _cssFromPluginObject (_flattenCSSMap @cssMap), debug:debug,tags:0\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      throw new Error(\"oj.#{@typeName}.css: object or string expected for first argument\") unless oj.isString(css) or oj.isObject(css)\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      throw new Error(\"oj.#{@typeName}.theme: string expected for first argument (theme name)\") unless oj.isString name\n      throw new Error(\"oj.#{@typeName}.css: object expected for second argument\") unless oj.isObject(css)\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.textarea\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: (args) ->\n        {options, args} = oj.argumentsUnion arguments\n\n        # Label is first argument\n        options.label ?= if args.length > 0 then args[0] else ''\n\n        @el = oj =>\n          oj.button options.label\n\n        oj.Button.base.constructor.apply @, [options]\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> console.log \"clearing body: oj.litcoffee:2930\";@$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get $(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set $(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\njquery.oj\n-----------------------------------------------------------------------------\n\n    jQuery.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types} = oj.compile {dom:1,html:0,css:0}, args...\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        for d in dom\n          $el.append d\n\n        # Call inserted event on all types\n        for t in types\n          t.inserted()\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njquery.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    jQuery.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njquery.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    jQuery.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njquery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        jQuery.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types} = oj.compile {dom:1,html:0,css:0}, args...\n\n            # Append to the dom\n            $el[jqName] dom\n\n            for t in types\n              t.inserted()\n\n            return\n\n          get:null\n","old_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = ->\n\n   Prevent oj function from emitting\n\n      oj._argumentsPush()\n\n  oj function acts like a tag method that doesn't emit\n\n      ojml = oj.emit.apply @, arguments\n      oj._argumentsPop()\n      ojml\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.0.14'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\nTODO: Static server side support for loading any generated pages dynamically.\nTODO: Support Backbone routes to trigger page changes.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      jQuery ->\n\n  Compile only the body and below\n\n        bodyOnly = html:1, doctype:1, head:1, link:1, script:1\n        {dom,types} = oj.compile dom:1, html:0, css:0, styles:1, ignore:bodyOnly, (require page)\n\n        if not dom?\n          throw new Error 'oj: dom failed to compile'\n          return\n\n  Find body element\n\n        body = document.getElementsByTagName 'body'\n        if body.length == 0\n          throw new Error('oj: <body> was not found')\n        body = body[0]\n\n  Clear body and insert dom elements\n\n        body.innerHTML = ''\n        if not oj.isArray dom\n          dom = [dom]\n        for d in dom\n          body.appendChild d\n\n  Trigger inserted event for types\n\n        for t in types\n          t.inserted()\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      # TODO: support cloning OJ instances\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n\nIndexing Helpers\n-----------------------------------------------------------------------------\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = ArrayP.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name) ->\n      obj = if oj.isClient then window[name] else global[name]\n      throw new Error(\"oj: #{name} dependency is missing\") unless oj.isDefined obj\n\nDepend on jQuery\n\n    oj.dependency 'jQuery'\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw 'oj.addProperty: string expected for second argument' unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw 'oj.isProperty: string expected for second argument' unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argumentsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argumentsStack = []\n\n  Result is top of the stack\n\n    oj._argumentsTop = ->\n      if _argumentsStack.length\n        _argumentsStack[_argumentsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argumentsPush = (args = []) ->\n      _argumentsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argumentsPop = ->\n      if _argumentsStack.length\n        return _argumentsStack.pop()\n      null\n\n  Append argument\n\n    oj._argumentsAppend = (arg) ->\n      top = oj._argumentsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, args...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from args by unioning all objects\n\n      attributes = {}\n      for arg in args\n\n  TODO: evaluate argument if necessary\n\n        if oj.isObject arg\n          _extend attributes, arg\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argumentsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n        else if oj.isFunction arg\n\n          len = oj._argumentsTop().length\n\n          # Call the argument it will auto append to oj._argumentsTop() which is ojml\n          r = arg()\n\n          # Use return value if oj._argumentsTop() weren't changed\n          if len == oj._argumentsTop().length and r?\n            oj._argumentsAppend r\n\n        else\n          oj._argumentsAppend arg\n\n  Pop to restore previous context\n\n      oj._argumentsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to\n\n      oj._argumentsAppend ojml\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n        oj[t] = -> oj.tag t, arguments...\n        # Remember the tag name\n        _setTagName oj[t], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = '<!DOCTYPE HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = '<!DOCTYPE html>'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\">'\n\n  Define possible arguments\n\n    doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\">'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\">'\n\n  Define the method\n\n    oj.doctype = (type = 5) ->\n      ojml = doctypes[type]\n\n  Emit as a tag would\n\n      oj._argumentsAppend ojml\n      ojml\n\noj.extend (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.extend = (context = root) ->\n      o = {}\n      for k,v of oj\n        if k[0] != '_'\n          o[k] = v\n      delete o.extend\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* debug - Keep all source including comments\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        styles: false\n        debug: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap or options.styles then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, debug: options.debug, tags:0\n\n      # Generate style tags if necessary\n      if options.styles\n        styles = _cssFromPluginObject pluginCSSMap, debug: options.debug, tags:1\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, styles:styles, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n  TODO: Refactor to use the same code as media queries\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      debug = options.debug ? 0\n      tags = options.tags ? 0\n      minify = options.minify ? 0\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if debug and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if debug then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\ndebug:true will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      debug = options.debug ? 0\n      tags = options.tags ? 0\n      minify = options.minify ? 0\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        when 'jquery'\n          # TODO: Missing unit tests for the jquery case\n          options.html?.push ojml.html()\n          options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML()\n            options.dom?.appendChild ojml.toDOM()\n            if options.css?\n              _extend options.css, ojml.toCSSMap()\n\n      return\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Compile ojml tag (an array)\n    _compileTag = (ojml, options) ->\n\n      # Empty list compiles to nothing\n      return if ojml.length == 0\n\n      # Get tag\n      tag = ojml[0]\n      tagType = typeof tag\n\n      # Allow ojml's tag parameter to be 'table' or table or Table\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n\n      # Fail if we couldn't find a string by now\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n      # Create oj object if tag is capitalized\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n      # Record tag\n      options.tags[tag] = true\n\n      # Get attributes (optional)\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n      # Remaining arguments are children of this tag\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n      # Compile to css if requested\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n      # Compile to html if requested\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n\n      # Compile your children if necessary\n      for child in children\n        # Skip intention if there is only one child\n        if options.debug && children.length > 1\n          options.html?.push \"\\n\\t#{options.indent}\"\n        _compileDeeper _compileAny, child, options\n\n      # Skip intention if there is only one child\n      if options.debug && children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n      # End html tag if you have children or your tag closes\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Allow attributes to take class as an array of strings\n    _attributeClassAllowsArrays = (attr) ->\n      if oj.isArray attr?.class\n        attr.class = attr.join ' '\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # TODO: Consider jsoning anything that isn't a string\n      # any keys that aren't strings are jsoned\n      # _attributesJSONAllKeys attributes\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if $?\n          if oj.isArray ev\n            $(el)[ek].apply @, ev\n          else\n            $(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\n    # oj.toHTML\n    # ------------------------------------------------------------------------------\n    # Make oj directly to HTML. It will ignore all event bindings\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\n    # oj.toCSS\n    # ------------------------------------------------------------------------------\n    # Make oj directly to css. It will ignore all event bindings and html\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        # TODO: Make this O(1)\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        # TODO: Make this O(1)\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # argumentsUnion:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.argumentsUnion = (argList) ->\n      obj = {}\n      list = []\n      for v in argList\n        if oj.isObject v\n          obj = _extend obj, v\n        else\n          list.push v\n      options: obj, args: list\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = $ @el)\n\n        # Get and set id of view from attribute\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all currently set themes (readwrite)\n        themes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n\n              # Wrap k in quotes if it has whitespace\n              if k == 'class'\n                @$el.addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single theme\n        addTheme: (name) ->\n          @$el.addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @$el.removeClass \"theme-#{name}\"\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argumentsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.debug then '\\n' else '')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (debug) -> _cssFromPluginObject (_flattenCSSMap @cssMap), debug:debug,tags:0\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n    oj.View.css = (def) ->\n      # TODO: Support def being a raw css string\n      cssMap = _setObject {}, \".oj-#{@typeName}\", def\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n    oj.View.theme = (name, def) ->\n      throw new Error(\"oj.#{@typeName}.theme: string expected for first argument (theme name)\") unless oj.isString name\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", def\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.textarea\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: (args) ->\n        {options, args} = oj.argumentsUnion arguments\n\n        # Label is first argument\n        options.label ?= if args.length > 0 then args[0] else ''\n\n        @el = oj =>\n          oj.button options.label\n\n        oj.Button.base.constructor.apply @, [options]\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> console.log \"clearing body: oj.litcoffee:2930\";@$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get $(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set $(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\njquery.oj\n-----------------------------------------------------------------------------\n\n    jQuery.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types} = oj.compile {dom:1,html:0,css:0}, args...\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        for d in dom\n          $el.append d\n\n        # Call inserted event on all types\n        for t in types\n          t.inserted()\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njquery.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    jQuery.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njquery.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    jQuery.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njquery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        jQuery.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types} = oj.compile {dom:1,html:0,css:0}, args...\n\n            # Append to the dom\n            $el[jqName] dom\n\n            for t in types\n              t.inserted()\n\n            return\n\n          get:null\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d433c25032426d103e2ffdffdde4d27cf518718a","subject":"Grammar'd","message":"Grammar'd\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/12_associations.litcoffee","new_file":"docs\/12_associations.litcoffee","new_contents":"# Batman.Model Associations\n\nThere are 3 types of assocations available on `Batman.Model`: `hasMany`, `belongsTo`, and `hasOne`.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.Set`. Generally they will return a `Batman.AssocationProxy` named after the association type,\nsuch as `Batman.BelongsToAssociationProxy` or `Batman.HasManyAssociationProxy`.\n\n`Batman.AssociationProxy` defines useful methods such as `@load`, `@toJSON`, `@loadFromLocal`. It also defines accessors such as `%loaded` and `%target`.\n\n## Shared Options\nAll assocations have a common set of options, as well as specific options for each type of relationship.\n\n##### `saveInline[= true] : boolean`\nWhether we should save the child objects as part of the parent object's JSON\n\n##### `autoload[= true] : boolean`\n Whether we should load the child objects when loading the parent object.\n\n##### `nestUrl[= false] : boolean`\nWhether the child models are persisted beneath the parent model's url structure.\n\n##### `name : string`\nThe name of the child model for the association. (eg. App.Product)\n\n##### `inverseOf : string`\nThe foreign association to set on load.\n\n##### `encoderKey : string`\nThe key to encode and decode the assocation into\/from JSON.\n\n##### `namespace[= Batman.currentApp] : string`\nThe location of the model definition for the association.\n\n##### `polymorphic[= false] : boolean`\nWhether the association is polymorphic.\n\n## @hasMany(label[, options])\n`hasMany` assocations are used for expressing one-to-many relationships on a `Batman.Model`.\n\n- `label : string`\n- `options : Object`\n  - `primaryKey : string`\n  - `foreignKey : string`\n  - `as : string`\n    - the parent association name on child objects in a polymorphic association\n\n## @hasOne(label[, options])\n`hasOne` associations are used for expressing one-to-one relationships on a `Batman.Model`.\n\n- `label : string`\n- `options : Object`\n  - `primaryKey : string`\n  - `foreignKey : string`\n  - `as : string`\n    - the parent association name on child objects in a polymorphic association\n\n## @belongsTo(label[, options])\n`belongsTo` associatons are used for expressing one-to-one child relationships on a `Batman.Model`.\n\n- `label : string`\n- `options : Object`\n  - `primaryKey : string`\n  - `foreignKey : string`\n  - `encodeForeignKey[= true] boolean`\n    - whether to encode the foreignKey value when persisting the model","old_contents":"# Batman.Model Associations\n\nThere are 3 types of assocations available on `Batman.Model`: `hasMany`, `belongsTo`, and `hasOne`.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.Set`. Generally they will return a `Batman.AssocationProxy` named after the association type,\nsuch as `Batman.BelongsToAssociationProxy` or `Batman.HasManyAssociationProxy`.\n\n`Batman.AssociationProxy` defines useful methods such as `@load`, `@toJSON`, `@loadFromLocal`. It also defines accessors such as `%loaded` and `%target`.\n\n## Shared Options\nAll assocations have a common set of options, as well as specific options for each type of relationship.\n\n##### `saveInline[= true] : boolean`\nWhether we should save the child objects as part of the parent object's JSON\n\n##### `autoload[= true] : boolean`\n Whether we should load the child objects when loading the parent object.\n\n##### `nestUrl[= false] : boolean`\nWhether the child models are persisted beneath the parent models url structure.\n\n##### `name : string`\nThe name of the child model for the association. (eg. App.Product)\n\n##### `inverseOf : string`\nThe foreign association to set on load.\n\n##### `encoderKey : string`\nThe key to encode and decode the assocation into\/from JSON.\n\n##### `namespace[= Batman.currentApp] : string`\nThe location of the model definition for the association.\n\n##### `polymorphic[= false] : boolean`\nWhether the association is polymorphic.\n\n## @hasMany(label[, options])\n`hasMany` assocations are used for expressing one-to-many relationships on a `Batman.Model`.\n\n- `label : string`\n- `options : Object`\n  - `primaryKey : string`\n  - `foreignKey : string`\n  - `as : string`\n    - the parent association name on child objects in a polymorphic association\n\n## @hasOne(label[, options])\n`hasOne` associations are used for expressing one-to-one relationships on a `Batman.Model`.\n\n- `label : string`\n- `options : Object`\n  - `primaryKey : string`\n  - `foreignKey : string`\n  - `as : string`\n    - the parent association name on child objects in a polymorphic association\n\n## @belongsTo(label[, options])\n`belongsTo` associatons are used fro expressing one-to-one child relationships on a `Batman.Model`.\n\n- `label : string`\n- `options : Object`\n  - `primaryKey : string`\n  - `foreignKey : string`\n  - `encodeForeignKey[= true] boolean`\n    - whether to encode the foreignKey value when persisting the model","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9431e6988133bffd4ca03748b1e3ec56a33ae03e","subject":"doc deploy-gh-pages","message":"doc deploy-gh-pages\n","repos":"glebm\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,duereg\/tile-thinger,vmlinz\/gulp-webpack-react-bootstrap-sass-template,duereg\/tile-thinger,vmlinz\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"# Gulp Asset Pipeline Configuration\n\nThis [Gulp](https:\/\/github.com\/gulpjs\/gulp\/) configuration file defines tasks to compile the assets.\nIt also defines a development asset web server task.\n\n## Require packages\n\nGulp to handle the pipeline flow:\n\n    g = require('gulp')\n    gutil = require('gulp-util')\n    clean = require('gulp-clean')\n    watch = require('gulp-watch')\n    gzip = require('gulp-gzip')\n    notify = require('gulp-notify')\n    runSequence = require('run-sequence')\n    deployToGithubPages = require('gulp-gh-pages')\n    _ = require('lodash')\n\nWebpack to compile the assets:\n\n    webpack = require('webpack')\n\nExpress and LiveReload for a development server:\n\n    express = require('express')\n    tiny_lr = require('tiny-lr')\n\nA number of low-level utilities:\n\n    util = require('util')\n    tty = require('tty')\n    path = require('path')\n    through2 = require('through2')\n\n\nA helper for requiring files uncached (useful for config files)\n\n    requireUncached = (path) ->\n      delete require.cache[require.resolve(path)]\n      require(path)\n\n## Configuration\n\n\nAll file system paths used in the tasks will be from the `paths` object.\n\n    paths = {}\n\nCompilation source root:\n\n    paths.src = 'src'\n    paths.srcFiles = \"#{paths.src}\/**\/*\"\n\nDistribution destination root:\n\n    paths.dist = 'dist'\n    paths.distFiles = \"#{paths.dist}\/**\/*\"\n\nPaths handled with Webpack:\n\n    paths.webpackPaths = [\n      'src\/scripts', 'src\/scripts\/**\/*',\n      'src\/styles', 'src\/styles\/**\/*',\n      'src\/images', 'src\/images\/**\/*'\n    ]\n\nFiles not handled with Webpack that reference Webpack assets:\n\n    paths.replaceAssetRefs = [\n      \"#{paths.src}\/index.html\"\n    ]\n\nWebpack configuration:\n\n    paths.webpackConfig = '.\/webpack.config.litcoffee'\n    loadWebpackConfig = -> requireUncached(paths.webpackConfig)\n    webpackConfig = loadWebpackConfig()\n\n## Tasks\n\nShow help when invoked with no arguments\n\n    g.task 'default', ->\n      help = \"\"\"\n        Usage: bin\/gulp [command]\n\n        Available commands:\n          bin\/gulp                 # display this help message\n          bin\/gulp dev             # build and run dev server\n          bin\/gulp prod            # production build, hash and gzip\n          bin\/gulp clean           # rm \/dist\n          bin\/gulp build           # development build\n          bin\/gulp deploy-gh-pages # deploy to Github Pages\n      \"\"\"\n      setTimeout (-> console.log help), 200\n\n### `dev`\n\nRun a development server:\n\n    g.task 'dev', ['build'], ->\n      servers = createServers(4000, 35729)\n      logChange = (evt) -> gutil.log(gutil.colors.cyan(evt.path), 'changed')\n      # Run webpack on config changes\n      g.watch [paths.webpackConfig], (evt) ->\n        logChange evt\n        webpackConfig = loadWebpackConfig()\n        g.start 'webpack'\n      # Run build on app source changes\n      g.watch [paths.srcFiles], (evt) ->\n        logChange evt\n        g.start 'build'\n      # Notify browser on distribution changes\n      g.watch [paths.distFiles], (evt) ->\n        logChange evt\n        servers.liveReload.changed body: {files: [evt.path]}\n\n\n### `prod`\n\nProduction build:\n\n    g.task 'prod', (cb) ->\n      # Apply production config, pass true to append hashes to file names\n      setWebpackConfig loadWebpackConfig().mergeProductionConfig(true)\n      runSequence 'clean', 'build', 'gzip', cb\n\n### `clean`\n\nClean (remove) the distribution folder:\n\n    g.task 'clean', ->\n      g.src(paths.dist, read: false).pipe(clean())\n\n### `build`\n\nBuild all assets (development build):\n\n    g.task 'build', (cb) ->\n      runSequence 'webpack', 'copy', 'build-replace-asset-refs', cb\n\n### `webpack`\n\nRun webpack to process CoffeeScript, JSX, Sass, inline small resources into the CSS, etc:\n\n    g.task 'webpack', (cb) ->\n      gutil.log(\"[webpack]\", 'Compiling...')\n      webpack webpackConfig, (err, stats) ->\n        if (err) then throw new gutil.PluginError(\"webpack\", err)\n        gutil.log(\"[webpack]\", stats.toString(colors: tty.isatty(process.stdout.fd)))\n        cb()\n\n### `copy`\n\nCopy non-webpack assets to the distribution:\n\n    g.task 'copy', ->\n      g.src([paths.srcFiles].concat(paths.webpackPaths.map (path) -> \"!#{path}\")).pipe(g.dest paths.dist)\n\n### `gzip`\n\nGZip assets:\n\n    g.task 'gzip', ->\n      g.src(paths.distFiles)\n      .on('error', handleErrors)\n      .pipe(gzip())\n      .pipe(g.dest paths.dist)\n\n### `build-replace-asset-refs`\n\nAdd fingerprinting hashes to asset references:\n\n    g.task 'build-replace-asset-refs', (cb) ->\n      stats = requireUncached(\".\/#{paths.dist}\/assets\/asset-stats.json\")\n      for p in paths.replaceAssetRefs\n        replaceWebpackAssetUrlsInFile p, stats, webpackConfig.output.publicPath\n      cb()\n\n### `deploy-gh-pages`\n\nBuild for gh-pages-branch. Same as production but do not append hashes:\n\n    g.task 'build-gh-pages', (cb) ->\n      webpackConfig = _.merge loadWebpackConfig().mergeProductionConfig(false),\n        output:\n         publicPath: \"\/gulp-webpack-react-bootstrap-sass-template\/assets\/\"\n      runSequence 'clean', 'build', cb\n\nDeploy to gh-pages branch:\n\n    g.task 'deploy-gh-pages', ['build-gh-pages'], ->\n      g.src(paths.distFiles).pipe(deployToGithubPages())\n\n## Helpers\n\nSet the \"global\" `webpackConfig` to argument.\n\n    setWebpackConfig = (conf) ->\n      webpackConfig = conf\n\n### `createServers`\n\nCreate development assets server and a live reload server\n\n    createServers = (port, lrport) ->\n      liveReload = tiny_lr()\n      liveReload.listen lrport, ->\n        gutil.log 'LiveReload listening on', lrport\n      app = express()\n      app.use express.static(path.resolve paths.dist)\n      app.listen port, ->\n        gutil.log 'HTTP server listening on', port\n      {liveReload, app}\n\n### `replaceWebpackAssetUrlsInFile`\n\nReplace asset URLs with the ones from Webpack in a file:\n\n    replaceWebpackAssetUrlsInFile = (filename, stats, publicPath) ->\n\nUse a `through2` pipe to replace file contents in the vinyl virtual file system:\n\n      g.src(filename)\n      .on('error', handleErrors)\n      .pipe(\n        through2.obj (vinylFile, enc, tCb) ->\n          vinylFile.contents = new Buffer(replaceWebpackAssetUrls(String(vinylFile.contents), stats, publicPath))\n          @push vinylFile\n          tCb()\n      )\n      .pipe(g.dest(paths.dist))\n\n### `replaceWebpackAssetUrls`\n\nReplace asset URLs with the ones from Webpack:\n\n    replaceWebpackAssetUrls = (text, stats, publicPath) ->\n\nFor each entry in Webpack stats (such as `{'main': 'assets\/main-abcde.js'}`):\n\n      for entryName, targetPath of stats\n\nIf source-maps are on, then targetPath is an array such as `['file.js', 'file.js.map'`]`. Get the right file:\n\n        if util.isArray(targetPath)\n          targetPath = _.find targetPath, (p) -> path.extname(p).toLowerCase() != '.map'\n\nReplace logical path with the target path:\n\n        ref = \"assets\/#{entryName}#{path.extname(targetPath)}\"\n        text = text.replace ref, publicPath + targetPath\n\nAll done:\n\n      text\n\n### `handleErrors`\n\nRoute non-gulp errors through gulp-notify:\n\n    handleErrors = (args...) ->\n      notify.onError(title: 'Error', message: '<%= error.message %>').apply(@, args)\n      @emit 'end'\n","old_contents":"# Gulp Asset Pipeline Configuration\n\nThis [Gulp](https:\/\/github.com\/gulpjs\/gulp\/) configuration file defines tasks to compile the assets.\nIt also defines a development asset web server task.\n\n## Require packages\n\nGulp to handle the pipeline flow:\n\n    g = require('gulp')\n    gutil = require('gulp-util')\n    clean = require('gulp-clean')\n    watch = require('gulp-watch')\n    gzip = require('gulp-gzip')\n    notify = require('gulp-notify')\n    runSequence = require('run-sequence')\n    deployToGithubPages = require('gulp-gh-pages')\n    _ = require('lodash')\n\nWebpack to compile the assets:\n\n    webpack = require('webpack')\n\nExpress and LiveReload for a development server:\n\n    express = require('express')\n    tiny_lr = require('tiny-lr')\n\nA number of low-level utilities:\n\n    util = require('util')\n    tty = require('tty')\n    path = require('path')\n    through2 = require('through2')\n\n\nA helper for requiring files uncached (useful for config files)\n\n    requireUncached = (path) ->\n      delete require.cache[require.resolve(path)]\n      require(path)\n\n## Configuration\n\n\nAll file system paths used in the tasks will be from the `paths` object.\n\n    paths = {}\n\nCompilation source root:\n\n    paths.src = 'src'\n    paths.srcFiles = \"#{paths.src}\/**\/*\"\n\nDistribution destination root:\n\n    paths.dist = 'dist'\n    paths.distFiles = \"#{paths.dist}\/**\/*\"\n\nPaths handled with Webpack:\n\n    paths.webpackPaths = [\n      'src\/scripts', 'src\/scripts\/**\/*',\n      'src\/styles', 'src\/styles\/**\/*',\n      'src\/images', 'src\/images\/**\/*'\n    ]\n\nFiles not handled with Webpack that reference Webpack assets:\n\n    paths.replaceAssetRefs = [\n      \"#{paths.src}\/index.html\"\n    ]\n\nWebpack configuration:\n\n    paths.webpackConfig = '.\/webpack.config.litcoffee'\n    loadWebpackConfig = -> requireUncached(paths.webpackConfig)\n    webpackConfig = loadWebpackConfig()\n\n## Tasks\n\nShow help when invoked with no arguments\n\n    g.task 'default', ->\n      help = \"\"\"\n        Usage: bin\/gulp [command]\n\n        Available commands:\n          bin\/gulp              # display this help message\n          bin\/gulp dev          # build and run dev server\n          bin\/gulp prod         # production build, hash and gzip\n          bin\/gulp clean        # rm \/dist\n          bin\/gulp build        # development build\n      \"\"\"\n      setTimeout (-> console.log help), 200\n\n### `dev`\n\nRun a development server:\n\n    g.task 'dev', ['build'], ->\n      servers = createServers(4000, 35729)\n      logChange = (evt) -> gutil.log(gutil.colors.cyan(evt.path), 'changed')\n      # Run webpack on config changes\n      g.watch [paths.webpackConfig], (evt) ->\n        logChange evt\n        webpackConfig = loadWebpackConfig()\n        g.start 'webpack'\n      # Run build on app source changes\n      g.watch [paths.srcFiles], (evt) ->\n        logChange evt\n        g.start 'build'\n      # Notify browser on distribution changes\n      g.watch [paths.distFiles], (evt) ->\n        logChange evt\n        servers.liveReload.changed body: {files: [evt.path]}\n\n\n### `prod`\n\nProduction build:\n\n    g.task 'prod', (cb) ->\n      # Apply production config, pass true to append hashes to file names\n      setWebpackConfig loadWebpackConfig().mergeProductionConfig(true)\n      runSequence 'clean', 'build', 'gzip', cb\n\n### `clean`\n\nClean (remove) the distribution folder:\n\n    g.task 'clean', ->\n      g.src(paths.dist, read: false).pipe(clean())\n\n### `build`\n\nBuild all assets (development build):\n\n    g.task 'build', (cb) ->\n      runSequence 'webpack', 'copy', 'build-replace-asset-refs', cb\n\n### `webpack`\n\nRun webpack to process CoffeeScript, JSX, Sass, inline small resources into the CSS, etc:\n\n    g.task 'webpack', (cb) ->\n      gutil.log(\"[webpack]\", 'Compiling...')\n      webpack webpackConfig, (err, stats) ->\n        if (err) then throw new gutil.PluginError(\"webpack\", err)\n        gutil.log(\"[webpack]\", stats.toString(colors: tty.isatty(process.stdout.fd)))\n        cb()\n\n### `copy`\n\nCopy non-webpack assets to the distribution:\n\n    g.task 'copy', ->\n      g.src([paths.srcFiles].concat(paths.webpackPaths.map (path) -> \"!#{path}\")).pipe(g.dest paths.dist)\n\n### `gzip`\n\nGZip assets:\n\n    g.task 'gzip', ->\n      g.src(paths.distFiles)\n      .on('error', handleErrors)\n      .pipe(gzip())\n      .pipe(g.dest paths.dist)\n\n### `build-replace-asset-refs`\n\nAdd fingerprinting hashes to asset references:\n\n    g.task 'build-replace-asset-refs', (cb) ->\n      stats = requireUncached(\".\/#{paths.dist}\/assets\/asset-stats.json\")\n      for p in paths.replaceAssetRefs\n        replaceWebpackAssetUrlsInFile p, stats, webpackConfig.output.publicPath\n      cb()\n\n### `deploy-gh-pages`\n\nBuild for gh-pages-branch. Same as production but do not append hashes:\n\n    g.task 'build-gh-pages', (cb) ->\n      webpackConfig = _.merge loadWebpackConfig().mergeProductionConfig(false),\n        output:\n         publicPath: \"\/gulp-webpack-react-bootstrap-sass-template\/assets\/\"\n      runSequence 'clean', 'build', cb\n\nDeploy to gh-pages branch:\n\n    g.task 'deploy-gh-pages', ['build-gh-pages'], ->\n      g.src(paths.distFiles).pipe(deployToGithubPages())\n\n## Helpers\n\nSet the \"global\" `webpackConfig` to argument.\n\n    setWebpackConfig = (conf) ->\n      webpackConfig = conf\n\n### `createServers`\n\nCreate development assets server and a live reload server\n\n    createServers = (port, lrport) ->\n      liveReload = tiny_lr()\n      liveReload.listen lrport, ->\n        gutil.log 'LiveReload listening on', lrport\n      app = express()\n      app.use express.static(path.resolve paths.dist)\n      app.listen port, ->\n        gutil.log 'HTTP server listening on', port\n      {liveReload, app}\n\n### `replaceWebpackAssetUrlsInFile`\n\nReplace asset URLs with the ones from Webpack in a file:\n\n    replaceWebpackAssetUrlsInFile = (filename, stats, publicPath) ->\n\nUse a `through2` pipe to replace file contents in the vinyl virtual file system:\n\n      g.src(filename)\n      .on('error', handleErrors)\n      .pipe(\n        through2.obj (vinylFile, enc, tCb) ->\n          vinylFile.contents = new Buffer(replaceWebpackAssetUrls(String(vinylFile.contents), stats, publicPath))\n          @push vinylFile\n          tCb()\n      )\n      .pipe(g.dest(paths.dist))\n\n### `replaceWebpackAssetUrls`\n\nReplace asset URLs with the ones from Webpack:\n\n    replaceWebpackAssetUrls = (text, stats, publicPath) ->\n\nFor each entry in Webpack stats (such as `{'main': 'assets\/main-abcde.js'}`):\n\n      for entryName, targetPath of stats\n\nIf source-maps are on, then targetPath is an array such as `['file.js', 'file.js.map'`]`. Get the right file:\n\n        if util.isArray(targetPath)\n          targetPath = _.find targetPath, (p) -> path.extname(p).toLowerCase() != '.map'\n\nReplace logical path with the target path:\n\n        ref = \"assets\/#{entryName}#{path.extname(targetPath)}\"\n        text = text.replace ref, publicPath + targetPath\n\nAll done:\n\n      text\n\n### `handleErrors`\n\nRoute non-gulp errors through gulp-notify:\n\n    handleErrors = (args...) ->\n      notify.onError(title: 'Error', message: '<%= error.message %>').apply(@, args)\n      @emit 'end'\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"883d4be78a84a03be5b3fc6271820fee3c0e2437","subject":"Fixed missed import in Easing file","message":"Fixed missed import in Easing file\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/renderer\/types\/extensions\/animation\/types\/property\/easing.litcoffee","new_file":"src\/renderer\/types\/extensions\/animation\/types\/property\/easing.litcoffee","new_contents":"# Easing\n\n    'use strict'\n\n    assert = require 'src\/assert'\n    log = require 'src\/log'\n\n    log = log.scope 'Renderer', 'PropertyAnimation', 'Easing'\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Easing extends itemUtils.DeepObject\n\n## *Easing* Easing::constructor()\n\n        constructor: (ref) ->\n            @_type = 'Linear'\n            @_steps = 1\n            super ref\n\n## *String* Easing::type = `'Linear'`\n\nSupported easing functions:\nLinear, InQuad, OutQuad, InOutQuad, InCubic, OutCubic,\nInOutCubic, InQuart, OutQuart, InOutQuart, InQuint, OutQuint,\nInOutQuint, InSine, OutSine, InOutSine, InExpo, OutExpo,\nInOutExpo, InCirc, OutCirc, InOutCirc, InElastic, OutElastic,\nInOutElastic, InBack, OutBack, InOutBack, InBounce, OutBounce,\nInOutBounce, Steps.\n\n        EASINGS = ['Linear', 'InQuad', 'OutQuad', 'InOutQuad', 'InCubic', 'OutCubic',\n            'InOutCubic', 'InQuart', 'OutQuart', 'InOutQuart', 'InQuint', 'OutQuint',\n            'InOutQuint', 'InSine', 'OutSine', 'InOutSine', 'InExpo', 'OutExpo',\n            'InOutExpo', 'InCirc', 'OutCirc', 'InOutCirc', 'InElastic', 'OutElastic',\n            'InOutElastic', 'InBack', 'OutBack', 'InOutBack', 'InBounce', 'OutBounce',\n            'InOutBounce', 'Steps']\n\n        EASING_ALIASES = Object.create(null)\n        for easing in EASINGS\n            EASING_ALIASES[easing] = easing\n            EASING_ALIASES[easing.toLowerCase()] = easing\n\n## *Signal* Easing::onTypeChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'type'\n            defaultValue: 'Linear'\n            namespace: 'easing'\n            implementation: Impl.setPropertyAnimationEasingType\n            developmentSetter: (val) ->\n                if val\n                    assert.isString val\n            setter: (_super) -> (val) ->\n                unless val\n                    val = 'Linear'\n\n                type = EASING_ALIASES[val]\n                type ||= EASING_ALIASES[val.toLowerCase()]\n                unless type\n                    log.warn \"Easing type '#{val}' not recognized\"\n                    type = 'Linear'\n                _super.call @, type\n                return\n\n## *Integer* Easing::steps = `1`\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'steps'\n            defaultValue: 1\n            namespace: 'easing'\n            implementation: Impl.setPropertyAnimationEasingSteps\n            developmentSetter: (val) ->\n                if val\n                    assert.isInteger val\n                    assert.operator val, '>', 0\n","old_contents":"# Easing\n\n    'use strict'\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Easing extends itemUtils.DeepObject\n\n## *Easing* Easing::constructor()\n\n        constructor: (ref) ->\n            @_type = 'Linear'\n            @_steps = 1\n            super ref\n\n## *String* Easing::type = `'Linear'`\n\nSupported easing functions:\nLinear, InQuad, OutQuad, InOutQuad, InCubic, OutCubic,\nInOutCubic, InQuart, OutQuart, InOutQuart, InQuint, OutQuint,\nInOutQuint, InSine, OutSine, InOutSine, InExpo, OutExpo,\nInOutExpo, InCirc, OutCirc, InOutCirc, InElastic, OutElastic,\nInOutElastic, InBack, OutBack, InOutBack, InBounce, OutBounce,\nInOutBounce, Steps.\n\n        EASINGS = ['Linear', 'InQuad', 'OutQuad', 'InOutQuad', 'InCubic', 'OutCubic',\n            'InOutCubic', 'InQuart', 'OutQuart', 'InOutQuart', 'InQuint', 'OutQuint',\n            'InOutQuint', 'InSine', 'OutSine', 'InOutSine', 'InExpo', 'OutExpo',\n            'InOutExpo', 'InCirc', 'OutCirc', 'InOutCirc', 'InElastic', 'OutElastic',\n            'InOutElastic', 'InBack', 'OutBack', 'InOutBack', 'InBounce', 'OutBounce',\n            'InOutBounce', 'Steps']\n\n        EASING_ALIASES = Object.create(null)\n        for easing in EASINGS\n            EASING_ALIASES[easing] = easing\n            EASING_ALIASES[easing.toLowerCase()] = easing\n\n## *Signal* Easing::onTypeChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'type'\n            defaultValue: 'Linear'\n            namespace: 'easing'\n            implementation: Impl.setPropertyAnimationEasingType\n            developmentSetter: (val) ->\n                if val\n                    assert.isString val\n            setter: (_super) -> (val) ->\n                unless val\n                    val = 'Linear'\n\n                type = EASING_ALIASES[val]\n                type ||= EASING_ALIASES[val.toLowerCase()]\n                unless type\n                    log.warn \"Easing type '#{val}' not recognized\"\n                    type = 'Linear'\n                _super.call @, type\n                return\n\n## *Integer* Easing::steps = `1`\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'steps'\n            defaultValue: 1\n            namespace: 'easing'\n            implementation: Impl.setPropertyAnimationEasingSteps\n            developmentSetter: (val) ->\n                if val\n                    assert.isInteger val\n                    assert.operator val, '>', 0\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"53b345fdf3daa7d24c77c0826a9226c1522965d8","subject":"Add notes section and horisontal lines.","message":"Add notes section and horisontal lines.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimelineMaker` class](#the-timelinemaker-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Notes](#notes)\n\n----\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\n----\n\nLibrary implementation\n----------------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.\n\n#### The `TimelineMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n----\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n----\n\nNotes\n-----\n\nThis is just a first test note, to not forget about this section.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimelineMaker` class](#the-timelinemaker-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary implementation\n----------------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.\n\n#### The `TimelineMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7ef8f8f1cd9dde8633a0090e45775daa70720bcf","subject":"in. jokes","message":"in. jokes\n","repos":"nomilous\/in.","old_file":"in.jokes\/spandex.litcoffee","new_file":"in.jokes\/spandex.litcoffee","new_contents":"#! \/usr\/bin\/env coffee\n\nThe expander supports multiple asyncronous functions.\n\nTo achieve that it needed to do some peculiar things.\n\n__Very peculiar!__\n\nThings that [some](https:\/\/www.google.co.za\/search?q=uptight+people&espv=2&biw=1063&bih=1058&source=lnms&tbm=isch&sa=X&ei=q6CJVYTyIpPB7Ab95YLQBA&ved=0CAYQ_AUoAQ#tbm=isch&q=uptight) may disaprove of.\n\nLike wearing [spandex in public](https:\/\/www.google.co.za\/search?q=spandex+in+public+nuts&espv=2&biw=1063&bih=1058&tbm=isch&source=lnms&sa=X&ei=5Z-JVez6KeWY7gbl_oCYAg&ved=0CAYQ_AUoAQ#tbm=isch&q=spandex+in+public).\n\nIt broke the [expan](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/expander.js)sion (to be [eval](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/compiler.js#L57)'d) [into pieces and substituted](https:\/\/www.google.co.za\/search?q=into+pieces+and+substituted+an+array&es_sm=91&source=lnms&tbm=isch&sa=X&ei=laOJVbKFOqKM7Abs4Y_ACw&ved=0CAkQ_AUoAw&biw=1063&bih=1058#tbm=isch&q=into+pieces+and+substituted) an array ($e[n]) for each function's results.\n\nThen pipelined the fuctions to produce ($e) so that the final eval\n\n`{{ i for an.i in ( an = $e[0] ) }}`\n\nWhere `$e[0]` was originally `async(fn1)`\n\n`{{ i for an.i in ( an = async(fn1) ) }}`\n\nThe results of the division are loaded into a variable called `spandex`...\n\nWhich happens to be in scope at eval.\n\n    require('..\/')\n\n    $$in (arg) ->\n\n        ### in(arg).as {{1}}###\n\n        console.log arg\n\n\n#### Return and finish later - few bits still to wire together\n","old_contents":"#! \/usr\/bin\/env coffee\n\nThe expander supports multiple asyncronous functions.\n\nTo achieve that it needed to do some peculiar things.\n\n__Very peculiar!__\n\nThings that [some](https:\/\/www.google.co.za\/search?q=uptight+people&espv=2&biw=1063&bih=1058&source=lnms&tbm=isch&sa=X&ei=q6CJVYTyIpPB7Ab95YLQBA&ved=0CAYQ_AUoAQ#tbm=isch&q=uptight) may disaprove of.\n\nLike wearing [spandex in public](https:\/\/www.google.co.za\/search?q=spandex+in+public+nuts&espv=2&biw=1063&bih=1058&tbm=isch&source=lnms&sa=X&ei=5Z-JVez6KeWY7gbl_oCYAg&ved=0CAYQ_AUoAQ#tbm=isch&q=spandex+in+public).\n\nIt broke the [expan](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/expander.js)sion (to be [eval](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/compiler.js#L57)'d) [into pieces and substituted](https:\/\/www.google.co.za\/search?q=into+pieces+and+substituted+an+array&es_sm=91&source=lnms&tbm=isch&sa=X&ei=laOJVbKFOqKM7Abs4Y_ACw&ved=0CAkQ_AUoAw&biw=1063&bih=1058#tbm=isch&q=into+pieces+and+substituted) an array ($e) for each function\n\nThe results of the division are loaded into a variable called `spandex`... \n\nWhich happens to be in scope at eval.\n\n    require('..\/')\n\n    $$in (arg) ->\n\n        ### in(arg).as {{1}}###\n\n        console.log arg\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f7eb50a359d3d23585049b613ac7355863f3838c","subject":"Add axis line.","message":"Add axis line.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The __TimelineMaker__ class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the __TimelineMaker__ class.  The __options__ parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are __formatTimeAxis()__, which formats time axis into a dictionary that describes the look of axis, and one of the __renderTo...__ functions that render that data dictionary to a desired context.\n\n#### The __formatTimeAxis()__ function\n\nA function that formats time axis into an intermediate format.  It has two parameters, __interval__ (a dictionary with __start__ and __end__ values, each of Date type) and corresponding to that interval __width__ of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be __options.intervalMultiplier__.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, __findPointList()__.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical element properties.  To transform time value into a coordinate we use the __timeToCoord()__ function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe should probably change ticks dictionary to lines dictionary instead, so we can add other types of lines, like baseline.  It could be better also to move all constants to options and make ticks drawing more flexible.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we add text labels too.\n\nHere we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {\n          lines: ticks.concat axisLine\n          textLabels\n        }\n\n#### The __findPointList()__ function\n\nThis function returns a list of points that are needed to be calculated for a (__start__, __end__) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the __start__ of the interval.  We move code that does that to the __findLeftTime()__.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using __findNextPoint()__ function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The __findLeftTime()__ function\n\nThe __findLeftTime()__ function calculates the rightmost point of time for current __options.intervalType__ such that it is not inside the given __interval__ (excluding beginning).  The __options.intervalType__ could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\nAnother option, __options.intervalMultiplier__, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the __options.intervalMultiplier__ should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the __findNextPoint()__ function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In __findNextPoint()__ we make sure that edge points are consistent while using different values of __start__.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The __findNextPoint()__ function\n\nThis function calculates next edge time point for a current options assuming __timePoint__ argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The __timeToCoord()__ function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The __renderToCanvas()__ function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n      context.stroke()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\n    window.onload = makeDemo\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The __TimelineMaker__ class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the __TimelineMaker__ class.  The __options__ parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are __formatTimeAxis()__, which formats time axis into a dictionary that describes the look of axis, and one of the __renderTo...__ functions that render that data dictionary to a desired context.\n\n#### The __formatTimeAxis()__ function\n\nA function that formats time axis into an intermediate format.  It has two parameters, __interval__ (a dictionary with __start__ and __end__ values, each of Date type) and corresponding to that interval __width__ of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be __options.intervalMultiplier__.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, __findPointList()__.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical element properties.  To transform time value into a coordinate we use the __timeToCoord()__ function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe should probably change ticks dictionary to lines dictionary instead, so we can add other types of lines, like baseline.  It could be better also to move all constants to options and make ticks drawing more flexible.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nNow we add text labels too.\n\nHere we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {lines: ticks, textLabels}\n\n#### The __findPointList()__ function\n\nThis function returns a list of points that are needed to be calculated for a (__start__, __end__) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the __start__ of the interval.  We move code that does that to the __findLeftTime()__.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using __findNextPoint()__ function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The __findLeftTime()__ function\n\nThe __findLeftTime()__ function calculates the rightmost point of time for current __options.intervalType__ such that it is not inside the given __interval__ (excluding beginning).  The __options.intervalType__ could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\nAnother option, __options.intervalMultiplier__, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the __options.intervalMultiplier__ should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the __findNextPoint()__ function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In __findNextPoint()__ we make sure that edge points are consistent while using different values of __start__.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The __findNextPoint()__ function\n\nThis function calculates next edge time point for a current options assuming __timePoint__ argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The __timeToCoord()__ function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The __renderToCanvas()__ function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n      context.stroke()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\n    window.onload = makeDemo\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f8aa515f08cc45eb76bdb01855b6072127f193bf","subject":"Some refactoring, and a whole lot more error handling\/reporting","message":"Some refactoring, and a whole lot more error handling\/reporting\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            WRAPPED[proto.constructor.name].push method\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, (errors) =>\n              if errors?\n                wrapped errors\n              else\n                proto[\"_#{method}\"] = proto[method]\n\n                proto[method] = =>\n                  def = q.defer()\n                  me  = proto[\"_#{method}\"]\n\n                  if args_format == 'ARRAY'\n                    args = Array.prototype.slice.call arguments\n                  else if args_format == 'OBJECT'\n                    args = arguments[0]\n                  else\n                    proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                    return def.reject 'No arg format specified'\n\n                  before = @_process_decorators me, 'before'\n                  after  = @_process_decorators me, 'after'\n\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries me.validators, (v, next) =>\n                      arg       = Object.keys(v)[0]\n                      validator = v[arg]\n                      input     = arg\n                      prop      = args\n\n                      for a in arg.split '.'\n                        prop  = prop[a]\n                        input = a\n\n                      if Array.isArray validator\n                        async.eachSeries validator, (v, nxt) =>\n                          proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                          proto[v].EXECUTE.call proto[v], input, prop\n                            .then nxt\n                            .catch handle_err v, { \"#{input}\": prop }, nxt, (err) =>\n                              reject err\n                              def.reject err\n                        , next\n                      else\n                        proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                        proto[validator].EXECUTE.call proto[validator], input, prop\n                          .then next\n                          .catch handle_err v, { \"#{input}\": prop }, next, (err) =>\n                            reject err\n                            def.reject err\n                    , resolve\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      async.eachSeries before, (b, next) =>\n                        proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                        proto[b].before.call proto[b], args\n                          .then next\n                          .catch handle_err b, args, next, (err) =>\n                            reject err\n                            def.reject err\n                      , resolve\n                  .then =>\n                    input = proto._prep_invocation proto, method, args, def\n\n                    try\n                      me.behavior.apply me, input\n                    catch e\n                      failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                      me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                      failed e.message\n                  .then (result) =>\n                    q.Promise (resolve, reject) =>\n                      if after.length > 0\n                        async.eachSeries after, (a, next) =>\n                          proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                          proto[a].after.call proto[a], result\n                            .then next\n                            .catch handle_err b, args, next, (err) =>\n                              reject err\n                              def.reject err\n                        , => resolve result\n                      else\n                        process.nextTick => resolve result\n                  .then  (out) => def.resolve out\n                  .catch (err) => def.reject  err\n\n                  def.promise\n\n                INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n                WRAPPED[proto.constructor.name].push method\n\n                wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, (errors) =>\n              if errors?\n                stop = new Error()\n                stop.break = true\n\n                next stop\n              else\n                next()\n          , (errors) =>\n            if errors?\n              stop = new Error()\n              stop.break = true\n\n              completed stop\n            else\n              @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, (errors) =>\n                if errors?\n                  stop = new Error()\n                  stop.break = true\n\n                  next stop\n                else\n                  HYDRATED[name] = true\n\n                  for listener in HYRDATION_LISTENERS[name]\n                    listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, done, fail) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then  done\n            .catch fail\n        else\n          done mod\n\n      _load: (me, name, path, loaded, fail) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n        , fail\n\n      _check: (me, path, dep, ref, finished) =>\n        error = true\n\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) =>\n                    error = undefined\n                    me._do_add me, ref, next\n                  , (err) =>\n                    stop = new Error()\n                    stop.break = true\n\n                    next stop\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n        , (err) =>\n          stop = new Error()\n          stop.break = true\n\n          next stop\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n        errors  = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], (errors) =>\n                  if errors?\n                    stop = new Error()\n                    stop.break = true\n\n                    next stop\n                  else\n                    if SEARCH_ROOTS[spec.parent] == undefined\n                      SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                    proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, nxt, =>\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next()\n                    nxt stop\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, (err) =>\n                  if err?\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next stop\n                  else\n                    next()\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , (err) =>\n          if err?\n            proto.warn.call proto, 'hydration.halt', errors\n\n            hydration_complete errors\n          else\n            async.eachSeries initers, (initer, next) =>\n              proto[initer.execute].apply(@).then next\n            , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, (errors) =>\n            if errors?\n              deferred.reject errors\n            else\n              @_wrap_methods proto, (err) =>\n                if err?\n                  deferred.reject err\n                else\n                  @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err.message\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.Promise (resolve, reject) =>\n                  async.eachSeries me.validators, (v, next) =>\n                    arg       = Object.keys(v)[0]\n                    validator = v[arg]\n                    input     = arg\n                    prop      = args\n\n                    for a in arg.split '.'\n                      prop  = prop[a]\n                      input = a\n\n                    if Array.isArray validator\n                      async.eachSeries validator, (v, nxt) =>\n                        proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                        proto[v].EXECUTE.call proto[v], input, prop\n                          .then nxt\n                          .catch handle_err v, { \"#{input}\": prop }, nxt, reject\n                      , next\n                    else\n                      proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                      proto[validator].EXECUTE.call proto[validator], input, prop\n                        .then next\n                        .catch handle_err v, { \"#{input}\": prop }, next, reject\n                  , resolve\n                .then =>\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries before, (b, next) =>\n                      proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                      proto[b].before.call proto[b], args\n                        .then next\n                        .catch handle_err b, args, next, reject\n                    , resolve\n                .then =>\n                  input = proto._prep_invocation proto, method, args, def\n\n                  try\n                    me.behavior.apply me, input\n                  catch e\n                    failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                    me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                    failed e.message\n                .then (result) =>\n                  q.Promise (resolve, reject) =>\n                    if after.length > 0\n                      async.eachSeries after, (a, next) =>\n                        proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                        proto[a].after.call proto[a], result\n                          .then next\n                          .catch handle_err b, args, next, reject\n                      , => resolve result\n                    else\n                      process.nextTick => resolve result\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n\n              INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n              wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, next\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        error = true\n\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) =>\n                    error = undefined\n                    me._do_add me, ref, next\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, nxt, =>\n                    stop = new Error()\n                    stop.break = true\n\n                    next()\n                    nxt stop\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"aa6436c081e1b6076182d9b1041d0ff648dc7f88","subject":"add experimental `__dispatch_table__` object to realized states","message":"add experimental `__dispatch_table__` object to realized states\n\nConsumers of this table (`method`, `apply`) will check for its\nexistence first, so this should be safe to null or comment out without\nany breakage....\n","repos":"nickfargo\/restate","old_file":"src\/state.litcoffee","new_file":"src\/state.litcoffee","new_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n\n        @_ or = new @Content\n        @__dispatch_table__ = {}\n\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneCategory   _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method held on this state. If no method is found, move up\nthis state\u2019s protostate chain to find one. If no method is found there, move up\nthe superstate chain and repeat the search.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out ) ->\n        if ( method = @_?.methods?[ methodName ] ) and method isnt rootNoop\n          if out? then out.context = this; out.method = method\n          return method\n\n        if viaProto = via & VIA_PROTO and\n            method = @protostate()?.method methodName, VIA_PROTO, out\n          out?.context = this\n          return method\n\n        if via & VIA_SUPER and\n            method = @superstate?.method methodName, VIA_SUPER | viaProto, out\n          return method\n\n        if out? then out.context = null; out.method = method\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state, which will be callable directly from the owner,\nbut with its context bound to the state.\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn, raw ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` holds a lexical state method, then extract the wrapped method, unless\nexplicitly ordered to regard the function in its `raw` form.\n\n        fn = fn this if not raw and fn.isLexicalStateMethodFactory\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root.method methodName, VIA_NONE\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n\nThe owner method must be added to the root state in its \u201craw\u201d form, i.e., not\nlexically transformed by `state.method`.\n\n            root.addMethod methodName, ownerMethod, yes\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context. If the method\nwas originally defined in the owner, the context will be the owner. Otherwise,\nthe context will either be the state in which the method is defined, or if the\nimplementation resides in a protostate, the corresponding state belonging to\nthe inheriting owner. If the named method does not exist locally and cannot be\ninherited, a `noSuchMethod` event is emitted and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n        out = method: undefined, context: undefined\n        unless method = @method methodName, null, out\n          @emit 'noSuchMethod', [ methodName, args ]\n          @emit 'noSuchMethod:' + methodName, args\n          return\n        { context } = out\n        { owner } = this\n        ownerMethod = owner[ methodName ]\n        context = owner if ownerMethod?.original and context is @root\n        method.apply context, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","old_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneCategory   _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method held on this state. If no method is found, move up\nthis state\u2019s protostate chain to find one. If no method is found there, move up\nthe superstate chain and repeat the search.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out ) ->\n        if ( method = @_?.methods?[ methodName ] ) and method isnt rootNoop\n          if out? then out.context = this; out.method = method\n          return method\n\n        if viaProto = via & VIA_PROTO and\n            method = @protostate()?.method methodName, VIA_PROTO, out\n          out?.context = this\n          return method\n\n        if via & VIA_SUPER and\n            method = @superstate?.method methodName, VIA_SUPER | viaProto, out\n          return method\n\n        if out? then out.context = null; out.method = method\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state, which will be callable directly from the owner,\nbut with its context bound to the state.\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn, raw ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` holds a lexical state method, then extract the wrapped method, unless\nexplicitly ordered to regard the function in its `raw` form.\n\n        fn = fn this if not raw and fn.isLexicalStateMethodFactory\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root.method methodName, VIA_NONE\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n\nThe owner method must be added to the root state in its \u201craw\u201d form, i.e., not\nlexically transformed by `state.method`.\n\n            root.addMethod methodName, ownerMethod, yes\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context. If the method\nwas originally defined in the owner, the context will be the owner. Otherwise,\nthe context will either be the state in which the method is defined, or if the\nimplementation resides in a protostate, the corresponding state belonging to\nthe inheriting owner. If the named method does not exist locally and cannot be\ninherited, a `noSuchMethod` event is emitted and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n        out = method: undefined, context: undefined\n        unless method = @method methodName, null, out\n          @emit 'noSuchMethod', [ methodName, args ]\n          @emit 'noSuchMethod:' + methodName, args\n          return\n        { context } = out\n        { owner } = this\n        ownerMethod = owner[ methodName ]\n        context = owner if ownerMethod?.original and context is @root\n        method.apply context, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a6725a430c59865f127aea017b009946c53b2d4c","subject":"Rewrite collection in Literate CoffeeScript","message":"Rewrite collection in Literate CoffeeScript\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    \"use strict\"\n\n    ObjectID    = require('mongodb').ObjectID\n    stringify   = require('JSONStream').stringify\n    createHash  = require('crypto').createHash\n\n    mongo       = require '.\/db\/mongo'\n    cache       = require '.\/cache'\n\n## PARAM collection\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col]\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST, PATCH, PUT'\n      res.send()\n\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n      query = {}\n\n### ?tag=`String`\n\n      if typeof req.query.tag is 'string' and req.query.tag isnt ''\n        if req.query.tag.charAt(0) is '!' and req.query.tag.length > 1\n          query['tags.0'] = $ne: req.query.tag.substr(1)\n        else\n          query['tags.0'] = req.query.tag\n\n### ?grupper=`String`\n\n      if typeof req.query.gruppe is 'string' and req.query.gruppe isnt ''\n        query['grupper'] = req.query.gruppe\n\n### ?after=`Mixed`\n\n      if typeof req.query.after is 'string' and req.query.after isnt ''\n        if not isNaN(req.query.after)\n          req.query.after = new Date(parseInt(req.query.after, 10)).toISOString()\n        query.endret = {$gte:req.query.after}\n\n### ?bbox=`min_lng`,`min_lat`,`max_lng`,`max_lat`\n\n      if typeof req.query.bbox is 'string' and req.query.bbox.split(',').length is 4\n        bbox = req.query.bbox.split(',')\n        bbox[i] = parseFloat(val) for val, i in bbox\n\n        query.geojson =\n          '$geoWithin':\n            '$geometry':\n              type: 'Polygon'\n              coordinates: [[\n                [bbox[0], bbox[1]]\n                [bbox[2], bbox[1]]\n                [bbox[2], bbox[3]]\n                [bbox[0], bbox[3]]\n                [bbox[0], bbox[1]]\n              ]]\n\n### ?privat.`String`=`String`\n\n * @TODO(starefossen) limit number of private fields\n * @TODO(starefossen) limit depth of private field\n\n`NB` This secution is itterating over all the url queries and hence should\ntake the queries above into concideration so we don't need to do double work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. status = 'Offentlig'\nif not tilbyder query is not set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.end() if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + Math.min(options.limit, total) + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      #\n      # @TODO move update to :\/collection\/:document\n      # @TODO add access control\n      #\n\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      warnings = []\n      errors   = []\n      message  = ''\n\n      req.body._id = new ObjectID(req.body._id) # @TODO restrict this\n      req.body.tilbyder = req.usr\n      req.body.endret = new Date().toISOString()\n\n      if not req.body.lisens\n        req.body.lisens = 'CC BY-ND-NC 3.0 NO'\n        warnings.push\n          resource: req.type\n          field: 'lisens'\n          value: req.body.lisens\n          code: 'missing_field'\n\n      if not req.body.status\n        req.body.status = 'Kladd'\n        warnings.push\n          resource: req.type\n          field: 'status'\n          value: req.body.status\n          code: 'missing_field'\n\n      req.body.checksum = createHash('md5').update(JSON.stringify(req.body)).digest(\"hex\")\n\n      req.db.col.save req.body, {safe: true, w: 1}, (err) ->\n        return next(err) if err\n        cache.setForType req.type, req.body._id, req.body, (err, data) ->\n          return next(err) if err\n          return res.json 201,\n            document:\n              _id: req.body._id\n            count: 1\n            message: message if message\n            warnings: warnings if warnings.length > 0\n            errors: errors if errors.length > 0\n\n## PATCH \/{collection}\n\n    exports.patch = (req, res, next) ->\n      res.json 501, message: 'HTTP method not implmented'\n\n## PUT \/{collection}\n\n    exports.put = (req, res, next) ->\n      res.json 501, message: 'HTTP method not implmented'\n\n","old_contents":"\"use strict\"\n\nObjectID    = require('mongodb').ObjectID\nstringify   = require('JSONStream').stringify\ncreateHash  = require('crypto').createHash\n\nmongo       = require '.\/db\/mongo'\ncache       = require '.\/cache'\n\nexports.param = (req, res, next, col) ->\n  if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n    return res.json 404, message: 'Objekttype ikke funnet'\n\n  req.type = col\n  req.db   = col: mongo[col]\n\n  next()\n\nexports.options = (req, res, next) ->\n  res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST, PATCH, PUT'\n  res.send()\n\nexports.get = (req, res, next) ->\n  query = {}\n  if typeof req.query.tag is 'string' and req.query.tag isnt ''\n    if req.query.tag.charAt(0) is '!' and req.query.tag.length > 1\n      query['tags.0'] = $ne: req.query.tag.substr(1)\n    else\n      query['tags.0'] = req.query.tag\n\n  if typeof req.query.gruppe is 'string' and req.query.gruppe isnt ''\n    query['grupper'] = req.query.gruppe\n\n  if typeof req.query.after is 'string' and req.query.after isnt ''\n    if not isNaN(req.query.after)\n      req.query.after = new Date(parseInt(req.query.after, 10)).toISOString()\n    query.endret = {$gte:req.query.after}\n\n  if typeof req.query.bbox is 'string' and req.query.bbox.split(',').length is 4\n    bbox = req.query.bbox.split(',')\n    bbox[i] = parseFloat(val) for val, i in bbox\n\n    query.geojson =\n      '$geoWithin':\n        '$geometry':\n          type: 'Polygon'\n          coordinates: [[\n            [bbox[0], bbox[1]]\n            [bbox[2], bbox[1]]\n            [bbox[2], bbox[3]]\n            [bbox[0], bbox[3]]\n            [bbox[0], bbox[1]]\n          ]]\n\n  # @TODO(starefossen) limit number of private fields\n  # @TODO(starefossen) limit depth of private field\n  for key, val of req.query when key.substr(0,7) is 'privat.'\n    if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n      val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n      query.tilbyder = req.usr\n      query[key] = val\n\n  # Limit queries to own documents or public documents ie. status = 'Offentlig'\n  query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\n  fields = tilbyder: true, endret: true, status: true, navn: true\n\n  options =\n    limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n    skip: parseInt(req.query.skip, 10) or 0\n    sort: 'endret'\n\n  cursor = req.db.col.find(query, fields, options)\n  cursor.count (err, total) ->\n    return next err if err\n    res.set 'Count-Return', Math.min(options.limit, total)\n    res.set 'Count-Total', total\n    return res.end() if req.method is 'HEAD'\n    return res.json documents: [], count: 0, total: 0 if total is 0\n    res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n    op = '{\"documents\":['\n    cl = '],\"count\":' + Math.min(options.limit, total) + ',\"total\":' + total + '}'\n\n    cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\nexports.post = (req, res, next) ->\n  #\n  # @TODO move update to :\/collection\/:document\n  # @TODO add access control\n  #\n\n  return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n  return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n  warnings = []\n  errors   = []\n  message  = ''\n\n  req.body._id = new ObjectID(req.body._id) # @TODO restrict this\n  req.body.tilbyder = req.usr\n  req.body.endret = new Date().toISOString()\n\n  if not req.body.lisens\n    req.body.lisens = 'CC BY-ND-NC 3.0 NO'\n    warnings.push\n      resource: req.type\n      field: 'lisens'\n      value: req.body.lisens\n      code: 'missing_field'\n\n  if not req.body.status\n    req.body.status = 'Kladd'\n    warnings.push\n      resource: req.type\n      field: 'status'\n      value: req.body.status\n      code: 'missing_field'\n\n  req.body.checksum = createHash('md5').update(JSON.stringify(req.body)).digest(\"hex\")\n\n  req.db.col.save req.body, {safe: true, w: 1}, (err) ->\n    return next(err) if err\n    cache.setForType req.type, req.body._id, req.body, (err, data) ->\n      return next(err) if err\n      return res.json 201,\n        document:\n          _id: req.body._id\n        count: 1\n        message: message if message\n        warnings: warnings if warnings.length > 0\n        errors: errors if errors.length > 0\n\nexports.patch = (req, res, next) ->\n  res.json 501, message: 'HTTP method not implmented'\n\nexports.put = (req, res, next) ->\n  res.json 501, message: 'HTTP method not implmented'\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cc3d703cc098766cfbb7d5f936675d23af5b96cd","subject":"Fix bug:  leftmost point is not added to the list of points.","message":"Fix bug:  leftmost point is not added to the list of points.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The __TimelineMaker__ class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the __TimelineMaker__ class.  The __options__ parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are __formatTimeAxis()__, which formats time axis into a dictionary that describes the look of axis, and one of the __renderTo...__ functions that render that data dictionary to a desired context.\n\n#### The __formatTimeAxis()__ function\n\nA function that formats time axis into an intermediate format.  It has two parameters, __interval__ (a dictionary with __start__ and __end__ values, each of Date type) and corresponding to that interval __width__ of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be __options.intervalMultiplier__.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, __findPointList()__.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical element properties.  To transform time value into a coordinate we use the __timeToCoord()__ function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe should probably change ticks dictionary to lines dictionary instead, so we can add other types of lines, like baseline.  It could be better also to move all constants to options and make ticks drawing more flexible.\n\n        ticks = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            yTop: -@options.tickLength \/ 5\n            yBottom: @options.tickLength\n          }\n\nNow we add text labels too.\n\nHere we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {ticks, textLabels}\n\n#### The __findPointList()__ function\n\nThis function returns a list of points that are needed to be calculated for a (__start__, __end__) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the __start__ of the interval.  We move code that does that to the __findLeftTime()__.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using __findNextPoint()__ function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The __findLeftTime()__ function\n\nThe __findLeftTime()__ function calculates the rightmost point of time for current __options.intervalType__ such that it is not inside the given __interval__ (excluding beginning).  The __options.intervalType__ could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\nAnother option, __options.intervalMultiplier__, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the __options.intervalMultiplier__ should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the __findNextPoint()__ function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In __findNextPoint()__ we make sure that edge points are consistent while using different values of __start__.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The __findNextPoint()__ function\n\nThis function calculates next edge time point for a current options assuming __timePoint__ argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The __timeToCoord()__ function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The __renderToCanvas()__ function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 2\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that the resulting graphics is more sharp (especially horizontal and vertical lines and text).\n\n        for tick in axisData.ticks\n          x = left + tick.x\n          yTop = top + tick.yTop\n          yBottom = top + tick.yBottom\n          context.moveTo @roundForCanvas(x), @roundForCanvas(yTop)\n          context.lineTo @roundForCanvas(x), @roundForCanvas(yBottom)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n      context.stroke()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\n    window.onload = makeDemo\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The __TimelineMaker__ class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the __TimelineMaker__ class.  The __options__ parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are __formatTimeAxis()__, which formats time axis into a dictionary that describes the look of axis, and one of the __renderTo...__ functions that render that data dictionary to a desired context.\n\n#### The __formatTimeAxis()__ function\n\nA function that formats time axis into an intermediate format.  It has two parameters, __interval__ (a dictionary with __start__ and __end__ values, each of Date type) and corresponding to that interval __width__ of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be __options.intervalMultiplier__.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, __findPointList()__.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical element properties.  To transform time value into a coordinate we use the __timeToCoord()__ function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe should probably change ticks dictionary to lines dictionary instead, so we can add other types of lines, like baseline.  It could be better also to move all constants to options and make ticks drawing more flexible.\n\n        ticks = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            yTop: -@options.tickLength \/ 5\n            yBottom: @options.tickLength\n          }\n\nNow we add text labels too.\n\nHere we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {ticks, textLabels}\n\n#### The __findPointList()__ function\n\nThis function returns a list of points that are needed to be calculated for a (__start__, __end__) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the __start__ of the interval.  We move code that does that to the __findLeftTime()__.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using __findNextPoint()__ function.\n\n        pointList = until timePoint > end\n          timePoint = @findNextPoint timePoint\n\n#### The __findLeftTime()__ function\n\nThe __findLeftTime()__ function calculates the rightmost point of time for current __options.intervalType__ such that it is not inside the given __interval__ (excluding beginning).  The __options.intervalType__ could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\nAnother option, __options.intervalMultiplier__, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the __options.intervalMultiplier__ should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the __findNextPoint()__ function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In __findNextPoint()__ we make sure that edge points are consistent while using different values of __start__.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The __findNextPoint()__ function\n\nThis function calculates next edge time point for a current options assuming __timePoint__ argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The __timeToCoord()__ function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The __renderToCanvas()__ function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 2\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that the resulting graphics is more sharp (especially horizontal and vertical lines and text).\n\n        for tick in axisData.ticks\n          x = left + tick.x\n          yTop = top + tick.yTop\n          yBottom = top + tick.yBottom\n          context.moveTo @roundForCanvas(x), @roundForCanvas(yTop)\n          context.lineTo @roundForCanvas(x), @roundForCanvas(yBottom)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n      context.stroke()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-14T23:59:59')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\n    window.onload = makeDemo\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6ef7448e5d7280644bc7dd4839b366b1326452e1","subject":"Removed references to deleted test assets and began working on a walking animation.","message":"Removed references to deleted test assets and began working on a walking\nanimation.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator","old_file":"src\/game.litcoffee","new_file":"src\/game.litcoffee","new_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    pose = require \".\/pose.litcoffee\"\n    computeLimb = require \".\/computeLimb.litcoffee\"\n       \n    triangle = undefined\n    \n    character = testMap = testNavmesh = undefined\n    characterData = require \".\/characters\/test\/cloud.coffee\"\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load characterData, (character_) ->\n            character = character_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n    \n    playerPoseOld = pose.create characterData\n    playerPoseNew = pose.create characterData\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    start = []\n    leftFoot = []\n    rightFoot = []\n    walked = 0\n    shuffleTicks = 0\n    foot = \"left\"\n    offset = []\n    \n    yaw = 0\n    pitch = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->        \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            \n        matrix.translate velocity, entityTransform  \n        walked += vector.magnitude velocity\n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, 10, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.2, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.2\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n        \n        if walked < 5\n            shuffleTicks--\n        while walked > 5 or shuffleTicks < 0\n            shuffleTicks = 5\n            walked -= 5\n            if (not inDeadzone) or ((vector.magnitudeSquared velocity) > 0.1)\n                vector.normalize velocity, offset\n                vector.multiply.byScalar offset, 5, offset\n            else\n                offset[0] = offset[1] = offset[2] = 0\n            foot = switch foot\n                when \"left\"\n                    matrix.applyToVector playerPoseNew.torso, [-2, -10, 0], leftFoot\n                    vector.add.vector offset, leftFoot, leftFoot\n                    \"right\"\n                when \"right\"\n                    matrix.applyToVector playerPoseNew.torso, [2, -10, 0], rightFoot\n                    vector.add.vector offset, rightFoot, rightFoot\n                    \"left\"\n    \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            firstTick = false\n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n    \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, playerPoseNew.torso\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, -2.5, 0], start\n        matrix.getX playerPoseNew.torso, xAxis\n        computeLimb start, leftFoot, 10, xAxis, playerPoseNew.legLeftUpper, playerPoseNew.legLeftLower\n        \n        matrix.applyToVector playerPoseNew.torso, [1.5, -2.5, 0], start\n        computeLimb start, rightFoot, 10, xAxis, playerPoseNew.legRightUpper, playerPoseNew.legRightLower\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw character, playerPoseOld, playerPoseNew\n        \n        return\n        \n    module.exports = { load, tick, draw }","old_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n       \n    triangle = undefined\n    \n    testEntity = testMap = testNavmesh = undefined\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load (require \".\/testEntity.msc\"), (testEntity_) ->\n            testEntity = testEntity_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    yaw = 0\n    pitch = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->    \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            \n        matrix.translate velocity, entityTransform        \n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, 10, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.2, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.2\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n    \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            firstTick = false\n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n\n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, torsoTransformToDraw\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw testEntity, torsoTransformPreviousDraw, torsoTransformToDraw\n        \n        return\n        \n    module.exports = { load, tick, draw }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c043ccaf6002c2c0a60e2f48ad1c98234f702faf","subject":"Quick explanatory comment","message":"Quick explanatory comment\n","repos":"gaccettola\/anno.js,iamdanfox\/anno.js,gaccettola\/anno.js","old_file":"src\/anno.litcoffee","new_file":"src\/anno.litcoffee","new_contents":"\nAnno.js\n=======\nInteractive step-by-step guides for web apps.\n\nAnno.js is built to be absurdly extensible, but still works great out of the box (and looks damn fine doing it). \n\n\nThe MIT License (MIT)\n---------------------\n\nCopyright (c) 2013 Dan Fox\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and\/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n\n\n    class Anno\n\nCreating an Anno object\n-----------------------\n\nAn Anno object represents a single annotation on your page.  Each Anno has a `target` jQuery selector\nand a `content` string as well as many other properties. For example:\n```\n  pizzaAnno = new Anno({\n    target: '#pizza-list',\n    content: 'Choose your pizza from the list below.'\n  })\n  pizzaAnno.show()\n```\nThis constructor lets you override these properties and uses defaults for anything you don't specify.\n\n      constructor: (options) ->\n        if options instanceof Anno\n          console.warn 'Anno constructor parameter is already an Anno object.'\n        if not options?\n          console.warn \"new Anno() created with no options.  It's recommended to supply at least target and content.\" \n        for key,val of options when key in ['chainTo', 'start', 'show', 'hide', 'hideAnno', 'chainSize', 'chainIndex', 'version']\n          console.warn \"Anno: Overriding '#{key}' is not recommended.  Can you override a delegated function instead?\"\n        \n        for key,val of options\n          this[key]=val\n\nIn practise, I usually like to specify `buttons` and `position`. You may also want to override `onShow` \nand `onHide` callbacks, `className` and even `overlayElem()` for complete control.\n\nIf you find yourself setting the same property on every Anno object you create, you can\nset default values at the top of your script that will apply to every Anno object from then onwards. \n\n      @setDefaults: (options) ->\n        for key,val of options\n          Anno::[key] = val\n\nMaking a step-by-step tour\n--------------------------\n\nAnno objects can be chained together to make a sequential tour.\n\n      chainTo: (obj) -> \n        if obj?\n          if not @_chainNext? # this is the end of the chain, add obj to the end.  \n            @_chainNext = if obj instanceof Anno then obj else new Anno(obj)\n            @_chainNext._chainPrev = this\n          else # pass the obj further along\n            @_chainNext.chainTo(obj)\n        else\n          console.error \"Can't chainTo a null object.\"\n        return this\n\n      _chainNext: null \n      _chainPrev: null\n\nLong Anno chains can also be made using the `Anno.chain()` shorthand. \n```\n var annoTour = Anno.chain([\n   {\n     target: '.pizza-list',\n     content: 'Choose your pizza from the list below.'\n   }, {\n     target: '#address-form',\n     content: \"Enter your address and we'll deliver your pizza\",\n     position: 'left'\n   }\n ])\n```\nNote, the `annoTour` variable still only points to the single Anno object (for `.pizza-list`), \nwe've just chained another one onto it anonymously.\n\n      @chain: (array) ->\n        head = new Anno( array.shift() )\n        if array.length >= 1 # array is now the tail.\n          head.chainTo( Anno.chain(array) ) \n        return head\n      \n      chainSize: () -> \n        if @_chainNext? then @_chainNext.chainSize() else 1+@chainIndex()\n\n      # `anno.chainIndex(x)` gets the xth object in the chain, `anno.chainIndex()` gets the current index; \n      chainIndex: (index) ->\n        if index?\n          (find = (curr, i, u) ->\n            if curr?\n              ci = curr.chainIndex()\n              if      0 <= ci < i  then find(curr._chainNext, i, u)\n              else if i <  ci <= u then find(curr._chainPrev, i, u)\n              else if   ci is i    then curr\n            else console.error \"Couldn't switch to index '#{i}'. Chain size is '#{u}'\"\n          )(this, index, @chainSize())\n        else\n          if @_chainPrev? then 1+@_chainPrev.chainIndex() else 0\n      \n\nHiding and showing annotations\n------------------------------\n\n`anno.show()` displays your annotation on top of a nice overlay and executes a callback.\nAll methods used here can be overridden in the same way we changed the `content` property.\n\nAnimations are all done with 300ms CSS transitions, so you can change your UI without touching any javascript.\n\n      show: () -> # TODO warn if this Anno has already been shown.\n        $target = @targetFn()\n        if @_annoElem? then console.warn \"Anno elem for '#{@target}' has already been generated.  Did you call show() twice?\"\n        @_annoElem = @annoElem()\n\n        @showOverlay()\n        @emphasiseTarget()\n        \n        $target.after(@_annoElem) # insert into DOM\n        \n        @_annoElem.addClass('anno-target-'+@arrowPositionFn())\n        @positionAnnoElem()\n\n        setTimeout (() => @_annoElem.removeClass('anno-hidden')), 10 # hack to make Chrome render the opacity:0 state.\n          \n        $target.scrollintoview()\n        setTimeout (() => @_annoElem.scrollintoview()) , 300 #TODO fix jumpiness\n\n        lastButton = @_annoElem.find('button').last()\n        if @rightArrowClicksLastButton \n          lastButton.keydown( (evt) -> if evt.keyCode is 39 then $(this).click()  ) # right arrow    \n        if @autoFocusLastButton\n          lastButton.focus() if $target.find(':focus').length is 0 # don't steal focus from inside target element\n\n        @_returnFromOnShow = @onShow(this, $target, @_annoElem)\n        return this\n\n      start: () -> @show() # alias because `tour.start()` sounds nicer than `tour.show()`\n\n      rightArrowClicksLastButton: true\n      autoFocusLastButton: true\n\nThe `onShow` callback does nothing by default, but can be very useful when overridden (e.g. to register a click \nlistener on the target element.)  Whatever value you return from the `onShow` function will get passed to the \n`onHide` callback.  This can be used to unbind event listeners.\n\n      onShow: (anno, $target, $annoElem) -> \n\n      _returnFromOnShow = null\n\nHiding is done in two stages so that you can re-use one overlay element for a long chain of Anno's.\n\n      hide: () ->\n        @hideAnno()\n        @hideOverlay()\n        return this\n\n      hideAnno: () ->\n        @deemphasiseTarget()\n\n        if @_annoElem? \n          @_annoElem.addClass('anno-hidden')\n          setTimeout () => \n            @_annoElem?.remove() # this method causes hideAnno to get called twice sometimes -> bad.\n            @_annoElem = null\n          , 300\n\n          @onHide(this, @targetFn(), @_annoElem, @_returnFromOnShow)\n        else\n          console.warn \"Can't hideAnno() for '#{@target}' when @_annoElem is null.  Did you call hideAnno() twice?\"\n\n        return this\n\n      onHide: (anno, $target, $annoElem, returnFromOnShow) ->\n\n`switchTo` displays another Anno and reuses the old overlay.\n\n      switchTo: (otherAnno) -> \n        if otherAnno?\n          @hideAnno() # TODO: prevent this call to `hideAnno()` if the current Anno isn't shown\n          otherAnno.show()\n        else \n          console.warn \"Can't switchTo a null object. Hiding completely instead. \"\n          @hide() # this recovers from a programmer mistake by removing the overlay too\n\n      switchToChainNext: () -> @switchTo @_chainNext\n\n      switchToChainPrev: () -> @switchTo @_chainPrev\n\n\nCustomizing target\n------------------\n\nSpecify a `target` jQuery selector to link your annotation to the DOM.\n\n      target: 'h1'\n\n`targetFn()` is used internally to return the first element matching your `target` selector (wrapped as a jQuery object). \n\n      targetFn: () ->\n        if typeof @target is 'string'\n          r = $(@target).filter(':not(.anno-placeholder)') # .anno-placeholder is a clone to prevent text wrapping\n          if r.length is 0 then console.error \"Couldn't find Anno.target '#{@target}'.\"\n          if r.length > 1 then console.warn \"Anno target '#{@target}' matched #{r.length} elements. Targeting the first one.\"\n          r.first()\n        else if @target instanceof jQuery\n          if @target.length > 1 then console.warn \"Anno jQuery target matched #{@target.length} elements. Targeting the first one.\"\n          return @target.first()\n        else if @target instanceof HTMLElement\n          $(@target)\n        else if typeof @target is 'function'\n          @target()\n        else \n          console.error \"Unrecognised Anno.target. Please supply a jQuery selector string, a jQuery \"+\n              \"object, a raw DOM element or a function returning a jQuery element. target:\"\n          console.error @target\n\n`annoElem()` generates the jQuery object that will be inserted into the DOM.\n\n      annoElem: () -> # TODO: should `annoElem()` encapsulate the re-use of one object?\n        @_annoElem = $(\"\"\"<div class='anno anno-hidden #{@className}'>\n                    <div class='anno-inner'>  <div class='anno-arrow'><\/div>  <\/div>\n                  <\/div>\"\"\")\n        @_annoElem.find('.anno-inner').\n          append( @contentElem() ).\n          append( @buttonsElem() ) # these a jquery elements, not HTML strings.\n        return @_annoElem # NB: returning the original pointer each time breaks button click events...\n\n      _annoElem: null\n\nCSS classes can be included, e.g. .anno-width-150, 175, 200, 250 (default 300)\n\n      className: ''\n\nContent\n-------\n\n      content: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'\n\n      # Override this instead of `content` if you don't know the content in advance\n      contentFn: () -> @content \n\n      contentElem: () -> $(\"<div class='anno-content'>\"+@contentFn()+\"<\/div>\") # TODO: evaluate how easy it would be to change Anno content while its displayed.\n\n\n\n\nSemi-transparent overlay and other effects\n------------------------------------------\n\n      showOverlay: () ->\n        if $('.anno-overlay').length is 0\n          $('body').append(e = @overlayElem().addClass 'anno-hidden') # TODO: write about pointer-events: none\n          setTimeout (() -> e.removeClass 'anno-hidden'), 10\n        else\n          $('.anno-overlay').replaceWith @overlayElem() \n\n      overlayElem: () -> \n        $(\"<div class='anno-overlay #{@overlayClassName}'><\/div>\").\n          click( (evt) => @overlayClick.call(this, this, evt) )\n\n      overlayClassName: '' # TODO talk about .anno-hidden\n      overlayClick: (anno, evt) -> anno.hide()\n\n      hideOverlay: () ->\n        $('.anno-overlay').addClass 'anno-hidden'\n        setTimeout (() -> $('.anno-overlay').remove()), 300\n\n      emphasiseTarget: ($target = @targetFn()) ->\n        $target.closest(':scrollable').on 'mousewheel', (evt) ->  # TODO: register & remove a specific listener ... would this ruin existing jQuery scroll functions?\n          evt.preventDefault()\n          evt.stopPropagation()\n        @_undoEmphasise.push ($t) -> $t.closest(':scrollable').off('mousewheel')\n\n        if $target.css('position')  is 'static'\n          $target.after(@_placeholder = $target.clone().addClass('anno-placeholder')) # ensures that the jquery :first selector in targetFn works.\n          @_undoEmphasise.push ($t) => @_placeholder?.remove()\n          ((a) => @_undoEmphasise.push ($t) -> $t.css position:a )($target.prop('style').position)\n          $target.css( position:'absolute' )\n\n          # if switching to position absolute has caused a dimension collapse, manually set H\/W.\n          if $target.outerWidth() isnt @_placeholder.outerWidth() \n            # Find the current inline style on $target and make an undo function using that value\n            ((a) => @_undoEmphasise.push ($t) -> $t.css width:a )($target.prop('style').width)\n            $target.css('width', @_placeholder.outerWidth())\n          if $target.outerHeight() isnt @_placeholder.outerHeight() \n            ((a) => @_undoEmphasise.push ($t) -> $t.css height:a )($target.prop('style').height)\n            $target.css('height', @_placeholder.outerHeight())\n\n          # if switching to position absolute has caused a position change, manually set it too\n          ppos = @_placeholder.position()\n          tpos = $target.position()\n          if tpos.top  isnt ppos.top \n            ((a) => @_undoEmphasise.push ($t) -> $t.css top:a )($target.prop('style').top)\n            $target.css('top', ppos.top)   \n          if tpos.left isnt ppos.left\n            ((a) => @_undoEmphasise.push ($t) -> $t.css left:a )($target.prop('style').left)\n            $target.css('left', ppos.left) \n\n        if $target.css('background') is 'rgba(0, 0, 0, 0) none repeat scroll 0% 0% \/ auto padding-box border-box'\n          ((a) => @_undoEmphasise.push ($t) -> $t.css background:a )($target.prop('style').background)\n          $target.css( background: 'white')\n\n        ((a) => @_undoEmphasise.push ($t) -> $t.css zIndex:a )($target.prop('style').zIndex)\n        $target.css( zIndex:'1001' ) \n\n        return $target\n\n      _undoEmphasise: [] # a list of functions to undo the effects of emphasiseTarget()\n      _placeholder: null\n\n      deemphasiseTarget: () ->\n        $target = @targetFn()\n        fn($target) for fn in @_undoEmphasise\n        return $target\n\n\nPositioning\n-----------\n\nThe `position` property decides where your annotation will be displayed.\n\nAlternatively, you can supply a hash of CSS attributes:\n```\n  position = { \n    top: '10px', \n    left: '57px' \n  }\n```\nIf you omit the `position` attribute entirely, Anno will use its best guess.\n\n      position: null # any of `top`, `left`, `bottom`, `right`, `center-top`, `center-left`, `center-bottom` or `center-right`.\n\n`positionAnnoElem()` sets the CSS of the Anno element so that it appears next to your target in a sensible way.\n\n      positionAnnoElem: (annoEl = @_annoElem) -> # Must be called after DOM insertion.\n        pos = @positionFn()\n\n        $targetEl = @targetFn()\n\n        offset = $targetEl.position() \n        switch pos \n          when 'top', 'bottom'\n            annoEl.css(left: offset.left+'px')\n          when 'center-top', 'center-bottom'\n            annoEl.css(left: offset.left+($targetEl.outerWidth()\/2 - annoEl.outerWidth()\/2)+'px')\n          when 'left', 'right'\n            annoEl.css(top: offset.top+'px')\n          when 'center-left', 'center-right'\n            annoEl.css(top: offset.top+($targetEl.outerHeight()\/2 - annoEl.outerHeight()\/2)+'px')\n\n        switch pos \n          when 'top', 'center-top'\n            annoEl.css( top: offset.top-annoEl.outerHeight()+'px')\n          when 'bottom', 'center-bottom'\n            annoEl.css( top: offset.top+$targetEl.outerHeight()+'px')\n          when 'left', 'center-left'\n            annoEl.css(left: offset.left-annoEl.outerWidth()+'px')\n          when 'right', 'center-right'\n            annoEl.css(left: offset.left+$targetEl.outerWidth()+'px')\n          else \n            if pos.left? or pos.right? or pos.top? or pos.bottom?\n             annoEl.css(pos)\n            else \n              console.error \"Unrecognised position: '#{pos}'\"\n\n        return annoEl\n\n\n`positionFn()` returns the `position` property or tries to guess one if you left it blank. \n\n      positionFn: () -> # Must be called after DOM insertion.\n        if @position? \n          return @position\n        else if @_annoElem?\n          $target = @targetFn()\n\n          $container = $target.closest(':scrollable')\n          $container = $('body') if $container.length is 0\n\n          targetOffset = $target.offset()         # both relative to document\n          containerOffset = $container.offset() \n          targetBounds = \n            left: targetOffset.left - containerOffset.left\n            top:  targetOffset.top - containerOffset.top\n          targetBounds.right = targetBounds.left + $target.outerWidth() # dist from left edge of $container to right of elem\n          targetBounds.bottom = targetBounds.top + $target.outerHeight()\n\n          viewBounds = \n            w: $container.width() or $container.width() # TODO: what is this???\n            h: $container.height() or $container.height()\n\n          annoBounds = \n            w: @_annoElem.outerWidth()\n            h: @_annoElem.outerHeight()\n\n          bad = []\n\n          if annoBounds.w > targetBounds.left then bad = bad.concat ['left', 'center-left']\n          if annoBounds.h > targetBounds.top  then bad = bad.concat ['top', 'center-top']\n          if annoBounds.w + targetBounds.right  > viewBounds.w  then bad = bad.concat ['right', 'center-right']\n          if annoBounds.h + targetBounds.bottom > viewBounds.h then bad = bad.concat ['bottom', 'center-bottom']\n\n          allowed = Anno.preferredPositions.filter (p) -> p not in bad \n          if allowed.length is 0\n            console.error \"Anno couldn't guess a position for '#{@target}'. Please supply one in the constructor.\"\n          else\n            console.warn \"Anno: guessing position:'#{allowed[0]}' for '#{@target}'. \"+\n              \"Possible Anno.preferredPositions: [#{allowed}].\"\n          return @position = allowed[0] # store this value for later - saves recomputing.\n\nWhen there are several different positions that the Anno element could by displayed, `positionFn()` chooses\nthe first one available in `Anno.preferredPositions`.  \n\n      @preferredPositions = ['bottom', 'right', 'left', 'top',  # TODO: would it ever guess center-*?\n              'center-bottom', 'center-right', 'center-left', 'center-top'] # TODO order these based on research.\n\n\n`arrowPositionFn()` returns which way the arrow should point. (Normally just the opposite of the anno position.)\n\n      arrowPositionFn: () -> \n        if @arrowPosition? \n          return @arrowPosition\n        else if typeof @positionFn() is 'string'\n          return {\n            'top': 'bottom'\n            'center-top': 'center-bottom'\n            'left': 'right'\n            'center-left' : 'center-right'\n            'right' : 'left'\n            'center-right' : 'center-left'\n            'bottom': 'top'\n            'center-bottom' : 'center-top'\n          }[@positionFn()]\n        else\n          pos = l : parseInt(@positionFn().left, 10) ,  t : parseInt(@positionFn().top, 10) \n          if Math.abs(pos.l) > Math.abs(pos.t)\n            r = if pos.l < 0 then 'center-right' else 'center-left'\n          else\n            r = if pos.t < 0 then 'center-bottom' else 'center-top'\n          console.warn \"Guessing arrowPosition:'#{r}' for #{@target}. Include this in your constructor for consistency.\"\n          return r\n\nOverride this if you've supplied a CSS hash as the `position` property. Can be any of `top`, `left`, etc.\n\n      arrowPosition: null # TODO replace 'arrowPosition' with 'arrowDirection'\n\n\nCustomizing Buttons\n-------------------\n\nBy default, Annotations have a single button, filled with default values from the `AnnoButton` class.\n\n      buttons:  [ {} ] \n\n      # returns a list of `AnnoButton` objects\n      buttonsFn: () -> \n        if @buttons instanceof Array\n          @buttons.map (b) -> new AnnoButton(b)\n        else \n          [new AnnoButton(@buttons)] # in the else branch `@buttons` is a single hash\n\n`buttonsElem()` produces the HTML for all those buttons (as a jQuery object).  \n\n      buttonsElem: () ->\n        return $(\"<div class='anno-btn-container'><\/div>\").\n          append (b.buttonElem(this) for b in @buttonsFn())\n\n\nAnnoButton\n==========\n\n    class AnnoButton\n\n      constructor: (options) ->\n        for key,val of options\n          this[key]=val\n\n      buttonElem: (anno) ->\n        return $(\"<button class='anno-btn'><\/button>\").\n          html( @textFn(anno) ).\n          addClass( @className ).\n          click( (evt) => @click.call(anno, anno, evt) )\n\n      textFn: (anno) -> \n        if @text? then @text\n        else if anno._chainNext? then 'Next' else 'Done'\n\n      text: null\n\n      className: ''\n\n`click` is called when your button is clicked.  Note, the `this` keyword is bound to the parent\nAnno object. \n\n      click: (anno, evt) -> \n        if anno._chainNext?\n          anno.switchToChainNext()\n        else\n          anno.hide()\n\nThese are some handy presets that you can use by adding `AnnoButton.NextButton` to your Anno object's \n`buttons` list.\n\n      @NextButton: new AnnoButton({ text: 'Next' , click: () -> @switchToChainNext()  })\n\n      @DoneButton: new AnnoButton({ text: 'Done' , click: () -> @hide()  })\n\n      @BackButton: new AnnoButton(\n          text: 'Back'\n          className: 'anno-btn-low-importance'\n          click: () -> @switchToChainPrev()\n        )\n","old_contents":"\nAnno.js\n=======\nInteractive step-by-step guides for web apps.\n\nAnno.js is built to be absurdly extensible, but still works great out of the box (and looks damn fine doing it). \n\n\nThe MIT License (MIT)\n---------------------\n\nCopyright (c) 2013 Dan Fox\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and\/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n\n\n    class Anno\n\nCreating an Anno object\n-----------------------\n\nAn Anno object represents a single annotation on your page.  Each Anno has a `target` jQuery selector\nand a `content` string as well as many other properties. For example:\n```\n  pizzaAnno = new Anno({\n    target: '#pizza-list',\n    content: 'Choose your pizza from the list below.'\n  })\n  pizzaAnno.show()\n```\nThis constructor lets you override these properties and uses defaults for anything you don't specify.\n\n      constructor: (options) ->\n        if options instanceof Anno\n          console.warn 'Anno constructor parameter is already an Anno object.'\n        if not options?\n          console.warn \"new Anno() created with no options.  It's recommended to supply at least target and content.\" \n        for key,val of options when key in ['chainTo', 'start', 'show', 'hide', 'hideAnno', 'chainSize', 'chainIndex', 'version']\n          console.warn \"Anno: Overriding '#{key}' is not recommended.  Can you override a delegated function instead?\"\n        \n        for key,val of options\n          this[key]=val\n\nIn practise, I usually like to specify `buttons` and `position`. You may also want to override `onShow` \nand `onHide` callbacks, `className` and even `overlayElem()` for complete control.\n\nIf you find yourself setting the same property on every Anno object you create, you can\nset default values at the top of your script that will apply to every Anno object from then onwards. \n\n      @setDefaults: (options) ->\n        for key,val of options\n          Anno::[key] = val\n\nMaking a step-by-step tour\n--------------------------\n\nAnno objects can be chained together to make a sequential tour.\n\n      chainTo: (obj) -> \n        if obj?\n          if not @_chainNext? # this is the end of the chain, add obj to the end.  \n            @_chainNext = if obj instanceof Anno then obj else new Anno(obj)\n            @_chainNext._chainPrev = this\n          else # pass the obj further along\n            @_chainNext.chainTo(obj)\n        else\n          console.error \"Can't chainTo a null object.\"\n        return this\n\n      _chainNext: null \n      _chainPrev: null\n\nLong Anno chains can also be made using the `Anno.chain()` shorthand. \n```\n var annoTour = Anno.chain([\n   {\n     target: '.pizza-list',\n     content: 'Choose your pizza from the list below.'\n   }, {\n     target: '#address-form',\n     content: \"Enter your address and we'll deliver your pizza\",\n     position: 'left'\n   }\n ])\n```\nNote, the `annoTour` variable still only points to the single Anno object (for `.pizza-list`), \nwe've just chained another one onto it anonymously.\n\n      @chain: (array) ->\n        head = new Anno( array.shift() )\n        if array.length >= 1 # array is now the tail.\n          head.chainTo( Anno.chain(array) ) \n        return head\n      \n      chainSize: () -> \n        if @_chainNext? then @_chainNext.chainSize() else 1+@chainIndex()\n\n      # `anno.chainIndex(x)` gets the xth object in the chain, `anno.chainIndex()` gets the current index; \n      chainIndex: (index) ->\n        if index?\n          (find = (curr, i, u) ->\n            if curr?\n              ci = curr.chainIndex()\n              if      0 <= ci < i  then find(curr._chainNext, i, u)\n              else if i <  ci <= u then find(curr._chainPrev, i, u)\n              else if   ci is i    then curr\n            else console.error \"Couldn't switch to index '#{i}'. Chain size is '#{u}'\"\n          )(this, index, @chainSize())\n        else\n          if @_chainPrev? then 1+@_chainPrev.chainIndex() else 0\n      \n\nHiding and showing annotations\n------------------------------\n\n`anno.show()` displays your annotation on top of a nice overlay and executes a callback.\nAll methods used here can be overridden in the same way we changed the `content` property.\n\nAnimations are all done with 300ms CSS transitions, so you can change your UI without touching any javascript.\n\n      show: () -> # TODO warn if this Anno has already been shown.\n        $target = @targetFn()\n        if @_annoElem? then console.warn \"Anno elem for '#{@target}' has already been generated.  Did you call show() twice?\"\n        @_annoElem = @annoElem()\n\n        @showOverlay()\n        @emphasiseTarget()\n        \n        $target.after(@_annoElem) # insert into DOM\n        \n        @_annoElem.addClass('anno-target-'+@arrowPositionFn())\n        @positionAnnoElem()\n\n        setTimeout (() => @_annoElem.removeClass('anno-hidden')), 10 # hack to make Chrome render the opacity:0 state.\n          \n        $target.scrollintoview()\n        setTimeout (() => @_annoElem.scrollintoview()) , 300 #TODO fix jumpiness\n\n        lastButton = @_annoElem.find('button').last()\n        if @rightArrowClicksLastButton \n          lastButton.keydown( (evt) -> if evt.keyCode is 39 then $(this).click()  ) # right arrow    \n        if @autoFocusLastButton\n          lastButton.focus() if $target.find(':focus').length is 0 # don't steal focus from inside target element\n\n        @_returnFromOnShow = @onShow(this, $target, @_annoElem)\n        return this\n\n      start: () -> @show() # alias because `tour.start()` sounds nicer than `tour.show()`\n\n      rightArrowClicksLastButton: true\n      autoFocusLastButton: true\n\nThe `onShow` callback does nothing by default, but can be very useful when overridden (e.g. to register a click \nlistener on the target element.)  Whatever value you return from the `onShow` function will get passed to the \n`onHide` callback.  This can be used to unbind event listeners.\n\n      onShow: (anno, $target, $annoElem) -> \n\n      _returnFromOnShow = null\n\nHiding is done in two stages so that you can re-use one overlay element for a long chain of Anno's.\n\n      hide: () ->\n        @hideAnno()\n        @hideOverlay()\n        return this\n\n      hideAnno: () ->\n        @deemphasiseTarget()\n\n        if @_annoElem? \n          @_annoElem.addClass('anno-hidden')\n          setTimeout () => \n            @_annoElem?.remove() # this method causes hideAnno to get called twice sometimes -> bad.\n            @_annoElem = null\n          , 300\n\n          @onHide(this, @targetFn(), @_annoElem, @_returnFromOnShow)\n        else\n          console.warn \"Can't hideAnno() for '#{@target}' when @_annoElem is null.  Did you call hideAnno() twice?\"\n\n        return this\n\n      onHide: (anno, $target, $annoElem, returnFromOnShow) ->\n\n`switchTo` displays another Anno and reuses the old overlay.\n\n      switchTo: (otherAnno) -> \n        if otherAnno?\n          @hideAnno() # TODO: prevent this call to `hideAnno()` if the current Anno isn't shown\n          otherAnno.show()\n        else \n          console.warn \"Can't switchTo a null object. Hiding completely instead. \"\n          @hide() # this recovers from a programmer mistake by removing the overlay too\n\n      switchToChainNext: () -> @switchTo @_chainNext\n\n      switchToChainPrev: () -> @switchTo @_chainPrev\n\n\nCustomizing target\n------------------\n\nSpecify a `target` jQuery selector to link your annotation to the DOM.\n\n      target: 'h1'\n\n`targetFn()` is used internally to return the first element matching your `target` selector (wrapped as a jQuery object). \n\n      targetFn: () ->\n        if typeof @target is 'string'\n          r = $(@target).filter(':not(.anno-placeholder)') # .anno-placeholder is a clone to prevent text wrapping\n          if r.length is 0 then console.error \"Couldn't find Anno.target '#{@target}'.\"\n          if r.length > 1 then console.warn \"Anno target '#{@target}' matched #{r.length} elements. Targeting the first one.\"\n          r.first()\n        else if @target instanceof jQuery\n          if @target.length > 1 then console.warn \"Anno jQuery target matched #{@target.length} elements. Targeting the first one.\"\n          return @target.first()\n        else if @target instanceof HTMLElement\n          $(@target)\n        else if typeof @target is 'function'\n          @target()\n        else \n          console.error \"Unrecognised Anno.target. Please supply a jQuery selector string, a jQuery \"+\n              \"object, a raw DOM element or a function returning a jQuery element. target:\"\n          console.error @target\n\n`annoElem()` generates the jQuery object that will be inserted into the DOM.\n\n      annoElem: () -> # TODO: should `annoElem()` encapsulate the re-use of one object?\n        @_annoElem = $(\"\"\"<div class='anno anno-hidden #{@className}'>\n                    <div class='anno-inner'>  <div class='anno-arrow'><\/div>  <\/div>\n                  <\/div>\"\"\")\n        @_annoElem.find('.anno-inner').\n          append( @contentElem() ).\n          append( @buttonsElem() ) # these a jquery elements, not HTML strings.\n        return @_annoElem # NB: returning the original pointer each time breaks button click events...\n\n      _annoElem: null\n\nCSS classes can be included, e.g. .anno-width-150, 175, 200, 250 (default 300)\n\n      className: ''\n\nContent\n-------\n\n      content: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'\n\n      # Override this instead of `content` if you don't know the content in advance\n      contentFn: () -> @content \n\n      contentElem: () -> $(\"<div class='anno-content'>\"+@contentFn()+\"<\/div>\") # TODO: evaluate how easy it would be to change Anno content while its displayed.\n\n\n\n\nSemi-transparent overlay and other effects\n------------------------------------------\n\n      showOverlay: () ->\n        if $('.anno-overlay').length is 0\n          $('body').append(e = @overlayElem().addClass 'anno-hidden') # TODO: write about pointer-events: none\n          setTimeout (() -> e.removeClass 'anno-hidden'), 10\n        else\n          $('.anno-overlay').replaceWith @overlayElem() \n\n      overlayElem: () -> \n        $(\"<div class='anno-overlay #{@overlayClassName}'><\/div>\").\n          click( (evt) => @overlayClick.call(this, this, evt) )\n\n      overlayClassName: '' # TODO talk about .anno-hidden\n      overlayClick: (anno, evt) -> anno.hide()\n\n      hideOverlay: () ->\n        $('.anno-overlay').addClass 'anno-hidden'\n        setTimeout (() -> $('.anno-overlay').remove()), 300\n\n      emphasiseTarget: ($target = @targetFn()) ->\n        $target.closest(':scrollable').on 'mousewheel', (evt) ->  # TODO: register & remove a specific listener ... would this ruin existing jQuery scroll functions?\n          evt.preventDefault()\n          evt.stopPropagation()\n        @_undoEmphasise.push ($t) -> $t.closest(':scrollable').off('mousewheel')\n\n        if $target.css('position')  is 'static'\n          $target.after(@_placeholder = $target.clone().addClass('anno-placeholder')) # ensures that the jquery :first selector in targetFn works.\n          @_undoEmphasise.push ($t) => @_placeholder?.remove()\n          ((a) => @_undoEmphasise.push ($t) -> $t.css position:a )($target.prop('style').position)\n          $target.css( position:'absolute' )\n\n          # if switching to position absolute has caused a dimension collapse, manually set H\/W.\n          if $target.outerWidth() isnt @_placeholder.outerWidth() \n            ((a) => @_undoEmphasise.push ($t) -> $t.css width:a )($target.prop('style').width)\n            $target.css('width', @_placeholder.outerWidth())\n          if $target.outerHeight() isnt @_placeholder.outerHeight() \n            ((a) => @_undoEmphasise.push ($t) -> $t.css height:a )($target.prop('style').height)\n            $target.css('height', @_placeholder.outerHeight())\n\n          # if switching to position absolute has caused a position change, manually set it too\n          ppos = @_placeholder.position()\n          tpos = $target.position()\n          if tpos.top  isnt ppos.top \n            ((a) => @_undoEmphasise.push ($t) -> $t.css top:a )($target.prop('style').top)\n            $target.css('top', ppos.top)   \n          if tpos.left isnt ppos.left\n            ((a) => @_undoEmphasise.push ($t) -> $t.css left:a )($target.prop('style').left)\n            $target.css('left', ppos.left) \n\n        if $target.css('background') is 'rgba(0, 0, 0, 0) none repeat scroll 0% 0% \/ auto padding-box border-box'\n          ((a) => @_undoEmphasise.push ($t) -> $t.css background:a )($target.prop('style').background)\n          $target.css( background: 'white')\n\n        ((a) => @_undoEmphasise.push ($t) -> $t.css zIndex:a )($target.prop('style').zIndex)\n        $target.css( zIndex:'1001' ) \n\n        return $target\n\n      _undoEmphasise: [] # a list of functions to undo the effects of emphasiseTarget()\n      _placeholder: null\n\n      deemphasiseTarget: () ->\n        $target = @targetFn()\n        fn($target) for fn in @_undoEmphasise\n        return $target\n\n\nPositioning\n-----------\n\nThe `position` property decides where your annotation will be displayed.\n\nAlternatively, you can supply a hash of CSS attributes:\n```\n  position = { \n    top: '10px', \n    left: '57px' \n  }\n```\nIf you omit the `position` attribute entirely, Anno will use its best guess.\n\n      position: null # any of `top`, `left`, `bottom`, `right`, `center-top`, `center-left`, `center-bottom` or `center-right`.\n\n`positionAnnoElem()` sets the CSS of the Anno element so that it appears next to your target in a sensible way.\n\n      positionAnnoElem: (annoEl = @_annoElem) -> # Must be called after DOM insertion.\n        pos = @positionFn()\n\n        $targetEl = @targetFn()\n\n        offset = $targetEl.position() \n        switch pos \n          when 'top', 'bottom'\n            annoEl.css(left: offset.left+'px')\n          when 'center-top', 'center-bottom'\n            annoEl.css(left: offset.left+($targetEl.outerWidth()\/2 - annoEl.outerWidth()\/2)+'px')\n          when 'left', 'right'\n            annoEl.css(top: offset.top+'px')\n          when 'center-left', 'center-right'\n            annoEl.css(top: offset.top+($targetEl.outerHeight()\/2 - annoEl.outerHeight()\/2)+'px')\n\n        switch pos \n          when 'top', 'center-top'\n            annoEl.css( top: offset.top-annoEl.outerHeight()+'px')\n          when 'bottom', 'center-bottom'\n            annoEl.css( top: offset.top+$targetEl.outerHeight()+'px')\n          when 'left', 'center-left'\n            annoEl.css(left: offset.left-annoEl.outerWidth()+'px')\n          when 'right', 'center-right'\n            annoEl.css(left: offset.left+$targetEl.outerWidth()+'px')\n          else \n            if pos.left? or pos.right? or pos.top? or pos.bottom?\n             annoEl.css(pos)\n            else \n              console.error \"Unrecognised position: '#{pos}'\"\n\n        return annoEl\n\n\n`positionFn()` returns the `position` property or tries to guess one if you left it blank. \n\n      positionFn: () -> # Must be called after DOM insertion.\n        if @position? \n          return @position\n        else if @_annoElem?\n          $target = @targetFn()\n\n          $container = $target.closest(':scrollable')\n          $container = $('body') if $container.length is 0\n\n          targetOffset = $target.offset()         # both relative to document\n          containerOffset = $container.offset() \n          targetBounds = \n            left: targetOffset.left - containerOffset.left\n            top:  targetOffset.top - containerOffset.top\n          targetBounds.right = targetBounds.left + $target.outerWidth() # dist from left edge of $container to right of elem\n          targetBounds.bottom = targetBounds.top + $target.outerHeight()\n\n          viewBounds = \n            w: $container.width() or $container.width() # TODO: what is this???\n            h: $container.height() or $container.height()\n\n          annoBounds = \n            w: @_annoElem.outerWidth()\n            h: @_annoElem.outerHeight()\n\n          bad = []\n\n          if annoBounds.w > targetBounds.left then bad = bad.concat ['left', 'center-left']\n          if annoBounds.h > targetBounds.top  then bad = bad.concat ['top', 'center-top']\n          if annoBounds.w + targetBounds.right  > viewBounds.w  then bad = bad.concat ['right', 'center-right']\n          if annoBounds.h + targetBounds.bottom > viewBounds.h then bad = bad.concat ['bottom', 'center-bottom']\n\n          allowed = Anno.preferredPositions.filter (p) -> p not in bad \n          if allowed.length is 0\n            console.error \"Anno couldn't guess a position for '#{@target}'. Please supply one in the constructor.\"\n          else\n            console.warn \"Anno: guessing position:'#{allowed[0]}' for '#{@target}'. \"+\n              \"Possible Anno.preferredPositions: [#{allowed}].\"\n          return @position = allowed[0] # store this value for later - saves recomputing.\n\nWhen there are several different positions that the Anno element could by displayed, `positionFn()` chooses\nthe first one available in `Anno.preferredPositions`.  \n\n      @preferredPositions = ['bottom', 'right', 'left', 'top',  # TODO: would it ever guess center-*?\n              'center-bottom', 'center-right', 'center-left', 'center-top'] # TODO order these based on research.\n\n\n`arrowPositionFn()` returns which way the arrow should point. (Normally just the opposite of the anno position.)\n\n      arrowPositionFn: () -> \n        if @arrowPosition? \n          return @arrowPosition\n        else if typeof @positionFn() is 'string'\n          return {\n            'top': 'bottom'\n            'center-top': 'center-bottom'\n            'left': 'right'\n            'center-left' : 'center-right'\n            'right' : 'left'\n            'center-right' : 'center-left'\n            'bottom': 'top'\n            'center-bottom' : 'center-top'\n          }[@positionFn()]\n        else\n          pos = l : parseInt(@positionFn().left, 10) ,  t : parseInt(@positionFn().top, 10) \n          if Math.abs(pos.l) > Math.abs(pos.t)\n            r = if pos.l < 0 then 'center-right' else 'center-left'\n          else\n            r = if pos.t < 0 then 'center-bottom' else 'center-top'\n          console.warn \"Guessing arrowPosition:'#{r}' for #{@target}. Include this in your constructor for consistency.\"\n          return r\n\nOverride this if you've supplied a CSS hash as the `position` property. Can be any of `top`, `left`, etc.\n\n      arrowPosition: null # TODO replace 'arrowPosition' with 'arrowDirection'\n\n\nCustomizing Buttons\n-------------------\n\nBy default, Annotations have a single button, filled with default values from the `AnnoButton` class.\n\n      buttons:  [ {} ] \n\n      # returns a list of `AnnoButton` objects\n      buttonsFn: () -> \n        if @buttons instanceof Array\n          @buttons.map (b) -> new AnnoButton(b)\n        else \n          [new AnnoButton(@buttons)] # in the else branch `@buttons` is a single hash\n\n`buttonsElem()` produces the HTML for all those buttons (as a jQuery object).  \n\n      buttonsElem: () ->\n        return $(\"<div class='anno-btn-container'><\/div>\").\n          append (b.buttonElem(this) for b in @buttonsFn())\n\n\nAnnoButton\n==========\n\n    class AnnoButton\n\n      constructor: (options) ->\n        for key,val of options\n          this[key]=val\n\n      buttonElem: (anno) ->\n        return $(\"<button class='anno-btn'><\/button>\").\n          html( @textFn(anno) ).\n          addClass( @className ).\n          click( (evt) => @click.call(anno, anno, evt) )\n\n      textFn: (anno) -> \n        if @text? then @text\n        else if anno._chainNext? then 'Next' else 'Done'\n\n      text: null\n\n      className: ''\n\n`click` is called when your button is clicked.  Note, the `this` keyword is bound to the parent\nAnno object. \n\n      click: (anno, evt) -> \n        if anno._chainNext?\n          anno.switchToChainNext()\n        else\n          anno.hide()\n\nThese are some handy presets that you can use by adding `AnnoButton.NextButton` to your Anno object's \n`buttons` list.\n\n      @NextButton: new AnnoButton({ text: 'Next' , click: () -> @switchToChainNext()  })\n\n      @DoneButton: new AnnoButton({ text: 'Done' , click: () -> @hide()  })\n\n      @BackButton: new AnnoButton(\n          text: 'Back'\n          className: 'anno-btn-low-importance'\n          click: () -> @switchToChainPrev()\n        )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e85359549f14304ed2067bbad4c0c5357da299f9","subject":"Add some links, fix doc format","message":"Add some links, fix doc format\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee `Model::validate` for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt takes a callback with two arguments: error and the array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : ErrorsSet\n\nA record's errors are accessible with `get('errors')`, which returns a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## isNew() : boolean\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## toJSON() : Object\n\n## fromJSON() : Model\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## load(options = {}, callback)\n\n## save(options = {}, callback)\n\n## destroy(options = {}, callback)\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method takes a callback with two arguments: any JavaScript error that occurs and the [`Batman.ErrorsSet`](\/docs\/api\/batman.errorsset.html) resulting from the validation tests.\nFor example:\n\n    asyncTest \"validate(callback) will call the callback only after all keys have been validated\", 4, ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      new_product = new Product\n      new_product.validate (js_error, validation_errors) ->\n        throw js_error if js_error\n        equal validation_errors.length, 2\n        equal new_product.get('errors.length'), 2\n        equal new_product.get('errors.name.length'), 1\n        equal new_product.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\nA `Batman.ValidationError` is a [`Batman.Object`](\/docs\/api\/batman.object.html). It is initialized with an `attribute` and a `message`.  It also responds to `fullMessage`:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n## ::constructor(attribute_name, message)\n\nCreates a new `Batman.ValidationError`, as in:\n\n```coffeescript\nnew_error = new Batman.ValidationError(\"password\", \"must include letters and numbers\")\n```\n\n## ::%fullMessage\n\nReturns the attribute name and the validation message.\n```coffeescript\nnew_error.get('fullMessage') # \"password must include letters and numbers\"\n```\n\n\n# Batman.ErrorsSet\n\nA `Batman.ErrorsSet` is a [`Batman.Set`](\/docs\/api\/batman.set.html) populated with [`Batman.ValidationErrors`](\/docs\/api\/batman.validationerror.html).\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::add(attribute_name, message)\n\n`Batman.ErrorsSet::add` is overridden for convenience. It takes an attribute_name and a message, which it uses to\ncreate a new `Batman.ValidationError` then it adds that error to the `Batman.ErrorsSet`.\n\n    test \"ErrorsSet::add passes its arguments to the ValidationError constructor\", ->\n      error_set = new Batman.ErrorsSet()\n      error_set.add(\"Foo bar baz\", \"isn't valid\")\n      error = error_set.at(0)\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee `Model::validate` for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt takes a callback with two arguments: error and the array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## errors : ErrorsSet\n\nA record's errors are accessible with `get('errors')`, which returns a `Batman.Set` of `Batman.ValidationError`s.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## isNew() : boolean\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## toJSON() : Object\n\n## fromJSON() : Model\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## load(options = {}, callback)\n\n## save(options = {}, callback)\n\n## destroy(options = {}, callback)\n\n## validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (see `Model@validate` above). This method takes a callback with two arguments: any JavaScript error that occurs, then the `Batman.ErrorsSet` corresponding to the validation action.\nFor example:\n\n    asyncTest \"validate(callback) will call the callback only after all keys have been validated\", 4, ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      p = new Product\n      p.validate (js_error, validation_errors) ->\n        throw js_error if js_error\n        equal validation_errors.length, 2\n        equal p.get('errors.length'), 2\n        equal p.get('errors.name.length'), 1\n        equal p.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\nA `Batman.ValidationError` is a `Batman.Object`. It is initialized with an `attribute` and a `message`.  It also responds to `fullMessage`:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n\n# Batman.ErrorsSet\n\nA `Batman.ErrorsSet` is a `Batman.Set` populated with `Batman.ValidationErrors`.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n`Batman.ErrorsSet::add` is overridden for convenience. It takes an attribute name and a message, which it uses to\ncreate a new `Batman.ValidationError` then it adds that error to the `Batman.ErrorsSet`.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8d8ff8f3091aced8a66669a78683815052f8bb4b","subject":"Reworked the camera to move more independently from the player, also adding basic navmesh collision.","message":"Reworked the camera to move more independently from the player, also\nadding basic navmesh collision.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator","old_file":"src\/game.litcoffee","new_file":"src\/game.litcoffee","new_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    pose = require \".\/pose.litcoffee\"\n    ik = require \".\/ik.litcoffee\"\n       \n    triangle = undefined\n    \n    character = testMap = testNavmesh = undefined\n    characterData = require \".\/characters\/test\/cloud.coffee\"\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load characterData, (character_) ->\n            character = character_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n    \n    playerPoseOld = pose.create characterData\n    playerPoseNew = pose.create characterData\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    cameraLocation = []\n    cameraLocationPreviousDraw = []\n    cameraTarget = []\n    cameraTargetPreviousDraw = []\n    cameraSide = []\n    cameraSidePreviousDraw = [0, 0, 1]\n    matrix.identity cameraTransform\n    \n    torsoAltitude = 0\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    start = []\n    leftFoot = []\n    rightFoot = []\n    leftHand = []\n    leftHandPreviousTick = []\n    leftHandToDraw = []\n    rightHand = []\n    rightHandPreviousTick = []\n    rightHandToDraw = []\n    walked = 0\n    shuffleTicks = 0\n    foot = \"left\"\n    ticksSinceLeft = 0\n    ticksSinceRight = 0\n    offset = []\n    \n    yaw = 0\n    pitch = 0\n    headYawPreviousTick = headYaw = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->        \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            vector.copy leftHand, leftHandPreviousTick\n            vector.copy rightHand, rightHandPreviousTick\n            \n        matrix.translate velocity, entityTransform  \n        speed = vector.magnitude velocity\n        walked += speed\n        moving = speed > 2\n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # A \"bump\" when you land.\n            matrix.getY entityTransform, yAxis\n            impact = Math.abs (vector.dot triangle.plane.normal, velocity) * (vector.dot triangle.plane.normal, yAxis)\n            impact -= 1\n            if impact < 0 then impact = 0\n            impact *= 2\n            torsoAltitude -= impact\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        torsoAltitude = misc.interpolate torsoAltitude, (12 - Math.min 2, (speed + if inDeadzone then 0 else 1.5)), 0.4\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, torsoAltitude, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.1, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        # Calculating the head angle relative to the torso is complicated by the\n        # stick angle being wrapped to 0...2PI, so we have to shift it out of\n        # that range to clamp it.\n        headYawPreviousTick = headYaw\n        headYaw = Math.max Math.PI - 1, Math.min Math.PI + 1, misc.wrapAngle Math.PI + stickAngle - yaw\n        headYaw -= Math.PI\n        headYaw = misc.interpolateAngle headYawPreviousTick, headYaw, 0.4, headYaw\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.4\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n        \n        shuffleTicks--\n        ticksSinceLeft++\n        ticksSinceRight++\n        while walked > 5 or shuffleTicks < 0\n            shuffleTicks = 5\n            walked -= 5\n            if (not inDeadzone) or moving\n                vector.normalize velocity, offset\n                vector.multiply.byScalar offset, 5, offset\n            else\n                offset[0] = offset[1] = offset[2] = 0\n            foot = switch foot\n                when \"left\"\n                    matrix.applyToVector playerPoseNew.torso, [-2, -10, 0], leftFoot\n                    vector.add.vector offset, leftFoot, leftFoot\n                    plane.project triangle.plane, leftFoot, leftFoot\n                    ticksSinceLeft = 0\n                    \"right\"\n                when \"right\"\n                    matrix.applyToVector playerPoseNew.torso, [2, -10, 0], rightFoot\n                    vector.add.vector offset, rightFoot, rightFoot\n                    plane.project triangle.plane, rightFoot, rightFoot\n                    ticksSinceRight = 0\n                    \"left\"\n        \n        if inDeadzone\n            leftHand[0] = -6\n            rightHand[0] = 6\n            leftHand[1] = rightHand[1] = -4\n            leftHand[2] = rightHand[2] = 0\n        else\n            yScale = 7 \/ (1 + speed)\n            rightHand[0] = 2 + (Math.min 4, speed)\n            leftHand[0] = -rightHand[0]\n            \n            leftHand[1] = rightHand[1] = 3\n            motion = Math.pow (Math.cos ticksSinceLeft * 0.25) * 0.5 + 0.5, 4\n            leftHand[1] += yScale * motion\n            leftHand[2] = 1.5 + 6 * stickLength * motion\n            motion = Math.pow (Math.cos ticksSinceRight * 0.25) * 0.5 + 0.5, 4\n            rightHand[1] += yScale * motion\n            rightHand[2] = 1.5 + 6 * stickLength * motion\n            \n        matrix.applyToVector torsoTransform, leftHand, leftHand                \n        matrix.applyToVector torsoTransform, rightHand, rightHand\n        \n        leftHand[1] -= 2\n        rightHand[1] -= 2\n        \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            vector.copy leftHand, leftHandPreviousTick\n            vector.copy rightHand, rightHandPreviousTick\n            firstTick = false\n            \n        lag = 0.15 + 0.4 \/ (1 + speed \/ 3)\n        if inDeadzone then lag = 0.2\n        vector.interpolate leftHandPreviousTick, leftHand, lag, leftHand\n        vector.interpolate rightHandPreviousTick, rightHand, lag, rightHand\n            \n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n    \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            vector.copy cameraTarget, cameraTargetPreviousDraw\n            vector.copy cameraLocation, cameraLocationPreviousDraw\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, playerPoseNew.torso\n        \n        matrix.getY entityTransformToDraw, yAxis\n        matrix.getZ entityTransformToDraw, zAxis\n        matrix.getTranslation entityTransformToDraw, cameraTarget\n        vector.multiply.byScalar yAxis, 18, offset\n        vector.add.vector cameraTarget, offset, cameraTarget\n        vector.multiply.byScalar zAxis, -20, offset\n        vector.add.vector cameraTarget, offset, cameraLocation\n        \n        vector.interpolate cameraTargetPreviousDraw, cameraTarget, 0.1, cameraTarget\n        vector.interpolate cameraLocationPreviousDraw, cameraLocation, 0.1, cameraLocation\n        \n        matrix.getX entityTransformToDraw, cameraSide\n        vector.interpolate cameraSidePreviousDraw, cameraSide, 0.1, cameraSide\n        vector.copy cameraSide, cameraSidePreviousDraw\n        \n        cameraTriangle = triangle\n        cameraTriangle = navmesh.constrain cameraLocation, cameraTriangle\n        cameraAltitude = (plane.distance cameraTriangle.plane, cameraLocation) - 4\n        if cameraAltitude < 0\n            vector.multiply.byScalar cameraTriangle.plane.normal, -cameraAltitude, offset\n            vector.add.vector offset, cameraLocation, cameraLocation\n        \n        ik.lookAt cameraLocation, cameraTarget, cameraSide, cameraTransform\n        matrix.invert cameraTransform, cameraTransform\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, -2.5, 0], start\n        matrix.getX playerPoseNew.torso, xAxis\n        ik.computeLimb start, leftFoot, 10, xAxis, playerPoseNew.legLeftUpper, playerPoseNew.legLeftLower\n        \n        matrix.applyToVector playerPoseNew.torso, [1.5, -2.5, 0], start\n        ik.computeLimb start, rightFoot, 10, xAxis, playerPoseNew.legRightUpper, playerPoseNew.legRightLower\n\n        matrix.getY playerPoseNew.torso, yAxis\n        vector.negate xAxis, xAxis\n        vector.interpolate xAxis, yAxis, 0.05, offset\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, 4, 0], start\n        vector.interpolate leftHandPreviousTick, leftHand, progress, leftHandToDraw\n        ik.computeLimb start, leftHandToDraw, 10, offset, playerPoseNew.armLeftUpper, playerPoseNew.armLeftLower\n        \n        vector.negate yAxis, yAxis\n        vector.interpolate xAxis, yAxis, 0.05, offset\n\n        matrix.applyToVector playerPoseNew.torso, [1.5, 4, 0], start\n        vector.interpolate rightHandPreviousTick, rightHand, progress, rightHandToDraw\n        ik.computeLimb start, rightHandToDraw, 10, offset, playerPoseNew.armRightUpper, playerPoseNew.armRightLower\n        \n        matrix.copy playerPoseNew.torso, playerPoseNew.head\n        matrix.translate [0, 6, 0], playerPoseNew.head, true\n        matrix.rotateY (misc.interpolate headYawPreviousTick, headYaw, progress), playerPoseNew.head, true\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            vector.copy cameraTarget, cameraTargetPreviousDraw\n            vector.copy cameraLocation, cameraLocationPreviousDraw\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw character, playerPoseOld, playerPoseNew\n        \n        return\n        \n    module.exports = { load, tick, draw }","old_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    pose = require \".\/pose.litcoffee\"\n    ik = require \".\/ik.litcoffee\"\n       \n    triangle = undefined\n    \n    character = testMap = testNavmesh = undefined\n    characterData = require \".\/characters\/test\/cloud.coffee\"\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load characterData, (character_) ->\n            character = character_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n    \n    playerPoseOld = pose.create characterData\n    playerPoseNew = pose.create characterData\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n    \n    torsoAltitude = 0\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    start = []\n    leftFoot = []\n    rightFoot = []\n    leftHand = []\n    leftHandPreviousTick = []\n    leftHandToDraw = []\n    rightHand = []\n    rightHandPreviousTick = []\n    rightHandToDraw = []\n    walked = 0\n    shuffleTicks = 0\n    foot = \"left\"\n    ticksSinceLeft = 0\n    ticksSinceRight = 0\n    offset = []\n    \n    yaw = 0\n    pitch = 0\n    headYawPreviousTick = headYaw = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->        \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            vector.copy leftHand, leftHandPreviousTick\n            vector.copy rightHand, rightHandPreviousTick\n            \n        matrix.translate velocity, entityTransform  \n        speed = vector.magnitude velocity\n        walked += speed\n        moving = speed > 2\n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # A \"bump\" when you land.\n            matrix.getY entityTransform, yAxis\n            impact = Math.abs (vector.dot triangle.plane.normal, velocity) * (vector.dot triangle.plane.normal, yAxis)\n            impact -= 1\n            if impact < 0 then impact = 0\n            impact *= 2\n            torsoAltitude -= impact\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        torsoAltitude = misc.interpolate torsoAltitude, (12 - Math.min 2, (speed + if inDeadzone then 0 else 1.5)), 0.4\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, torsoAltitude, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.1, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        # Calculating the head angle relative to the torso is complicated by the\n        # stick angle being wrapped to 0...2PI, so we have to shift it out of\n        # that range to clamp it.\n        headYawPreviousTick = headYaw\n        headYaw = Math.max Math.PI - 1, Math.min Math.PI + 1, misc.wrapAngle Math.PI + stickAngle - yaw\n        headYaw -= Math.PI\n        headYaw = misc.interpolateAngle headYawPreviousTick, headYaw, 0.4, headYaw\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.4\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n        \n        shuffleTicks--\n        ticksSinceLeft++\n        ticksSinceRight++\n        while walked > 5 or shuffleTicks < 0\n            shuffleTicks = 5\n            walked -= 5\n            if (not inDeadzone) or moving\n                vector.normalize velocity, offset\n                vector.multiply.byScalar offset, 5, offset\n            else\n                offset[0] = offset[1] = offset[2] = 0\n            foot = switch foot\n                when \"left\"\n                    matrix.applyToVector playerPoseNew.torso, [-2, -10, 0], leftFoot\n                    vector.add.vector offset, leftFoot, leftFoot\n                    plane.project triangle.plane, leftFoot, leftFoot\n                    ticksSinceLeft = 0\n                    \"right\"\n                when \"right\"\n                    matrix.applyToVector playerPoseNew.torso, [2, -10, 0], rightFoot\n                    vector.add.vector offset, rightFoot, rightFoot\n                    plane.project triangle.plane, rightFoot, rightFoot\n                    ticksSinceRight = 0\n                    \"left\"\n        \n        if inDeadzone\n            leftHand[0] = -6\n            rightHand[0] = 6\n            leftHand[1] = rightHand[1] = -4\n            leftHand[2] = rightHand[2] = 0\n        else\n            yScale = 7 \/ (1 + speed)\n            rightHand[0] = 2 + (Math.min 4, speed)\n            leftHand[0] = -rightHand[0]\n            \n            leftHand[1] = rightHand[1] = 3\n            motion = Math.pow (Math.cos ticksSinceLeft * 0.25) * 0.5 + 0.5, 4\n            leftHand[1] += yScale * motion\n            leftHand[2] = 1.5 + 6 * stickLength * motion\n            motion = Math.pow (Math.cos ticksSinceRight * 0.25) * 0.5 + 0.5, 4\n            rightHand[1] += yScale * motion\n            rightHand[2] = 1.5 + 6 * stickLength * motion\n            \n        matrix.applyToVector torsoTransform, leftHand, leftHand                \n        matrix.applyToVector torsoTransform, rightHand, rightHand\n        \n        leftHand[1] -= 2\n        rightHand[1] -= 2\n        \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            vector.copy leftHand, leftHandPreviousTick\n            vector.copy rightHand, rightHandPreviousTick\n            firstTick = false\n            \n        lag = 0.15 + 0.4 \/ (1 + speed \/ 3)\n        if inDeadzone then lag = 0.2\n        vector.interpolate leftHandPreviousTick, leftHand, lag, leftHand\n        vector.interpolate rightHandPreviousTick, rightHand, lag, rightHand\n            \n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n    \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, playerPoseNew.torso\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, -2.5, 0], start\n        matrix.getX playerPoseNew.torso, xAxis\n        ik.computeLimb start, leftFoot, 10, xAxis, playerPoseNew.legLeftUpper, playerPoseNew.legLeftLower\n        \n        matrix.applyToVector playerPoseNew.torso, [1.5, -2.5, 0], start\n        ik.computeLimb start, rightFoot, 10, xAxis, playerPoseNew.legRightUpper, playerPoseNew.legRightLower\n\n        matrix.getY playerPoseNew.torso, yAxis\n        vector.negate xAxis, xAxis\n        vector.interpolate xAxis, yAxis, 0.05, offset\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, 4, 0], start\n        vector.interpolate leftHandPreviousTick, leftHand, progress, leftHandToDraw\n        ik.computeLimb start, leftHandToDraw, 10, offset, playerPoseNew.armLeftUpper, playerPoseNew.armLeftLower\n        \n        vector.negate yAxis, yAxis\n        vector.interpolate xAxis, yAxis, 0.05, offset\n\n        matrix.applyToVector playerPoseNew.torso, [1.5, 4, 0], start\n        vector.interpolate rightHandPreviousTick, rightHand, progress, rightHandToDraw\n        ik.computeLimb start, rightHandToDraw, 10, offset, playerPoseNew.armRightUpper, playerPoseNew.armRightLower\n        \n        matrix.copy playerPoseNew.torso, playerPoseNew.head\n        matrix.translate [0, 6, 0], playerPoseNew.head, true\n        matrix.rotateY (misc.interpolate headYawPreviousTick, headYaw, progress), playerPoseNew.head, true\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw character, playerPoseOld, playerPoseNew\n        \n        return\n        \n    module.exports = { load, tick, draw }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d3a31a5dcf8666424b0edca2a8b0d9b0f0b05ebd","subject":"cross origin","message":"cross origin\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0d3de96794a122b0b073e581d0f1381c4ca90ec8","subject":"slimming SourceMap slightly further","message":"slimming SourceMap slightly further\n","repos":"sterpe\/coffee-fmt","old_file":"sourcemap.litcoffee","new_file":"sourcemap.litcoffee","new_contents":"Source maps allow JavaScript runtimes to match running JavaScript back to\nthe original CoffeeScript source code that corresponds to it. In order to\nproduce maps, we must keep track of positions (line number, column number)\nfor every construct in the syntax tree, and be able to generate a map file\n-- which is a compact, VLQ-encoded representation of the JSON serialization\nof this information -- to write out alongside the generated JavaScript.\n\n    {merge} = require '.\/helpers'\n\n\nLineMap\n-------\n\nKeeps track of information about column positions within a single line of\noutput JavaScript code. **SourceMap**s are implemented in terms of **LineMap**s.\n\n    class LineMap\n      constructor: (@line) ->\n        @columns = []\n\n      add: (column, [sourceLine, sourceColumn], options={}) ->\n        return if @columns[column] and options.noReplace\n        @columns[column] = {line: @line, column, sourceLine, sourceColumn}\n\n      sourceLocation: (column) ->\n        column-- until (mapping = @columns[column]) or (column <= 0)\n        mapping and [mapping.sourceLine, mapping.sourceColumn]\n\n\nSourceMap\n---------\n\nMaps locations in for a single generated JavaScript file back to locations in\nthe original CoffeeScript source file.\n\nThis is intentionally agnostic towards how a source map might be represented on\ndisk. Once the compiler is ready to produce a \"v3\"-style source map, we can walk\nthrough the arrays of line and column buffer to produce it.\n\n    class SourceMap\n      constructor: ->\n        @lines = []\n\nAdds a mapping to this SourceMap. `sourceLocation` and `generatedLocation`\nare both `[line, column]` arrays. If `options.noReplace` is true, then if there\nis already a mapping for the specified `line` and `column`, this will have no\neffect.\n\n      add: (sourceLocation, generatedLocation, options = {}) ->\n        [line, column] = generatedLocation\n        lineMap = (@lines[line] or= new LineMap(line))\n        lineMap.add column, sourceLocation, options\n\nLook up the original position of a given `line` and `column` in the generated\ncode.\n\n      sourceLocation: ([line, column]) ->\n        line-- until (lineMap = @lines[line]) or (line <= 0)\n        lineMap and lineMap.sourceLocation column\n\n\nV3 SourceMap Generation\n-----------------------\n\nBuilds up a V3 source map, returning the generated JSON as a string.\n`options.sourceRoot` may be used to specify the sourceRoot written to the source\nmap.  Also, `options.sourceFiles` and `options.generatedFile` may be passed to\nset \"sources\" and \"file\", respectively.\n\n      generate: (options = {}, code = null) ->\n        writingline       = 0\n        lastColumn        = 0\n        lastSourceLine    = 0\n        lastSourceColumn  = 0\n        needComma         = no\n        buffer            = \"\"\n\n        for lineMap, lineNumber in @lines when lineMap\n          for mapping in lineMap.columns when mapping\n            while writingline < mapping.line\n              lastColumn = 0\n              needComma = no\n              buffer += \";\"\n              writingline++\n\nWrite a comma if we've already written a segment on this line.\n\n            if needComma\n              buffer += \",\"\n              needComma = no\n\nWrite the next segment. Segments can be 1, 4, or 5 values.  If just one, then it\nis a generated column which doesn't match anything in the source code.\n\nThe starting column in the generated source, relative to any previous recorded\ncolumn for the current line:\n\n            buffer += @encodeVlq mapping.column - lastColumn\n            lastColumn = mapping.column\n\nThe index into the list of sources:\n\n            buffer += @encodeVlq 0\n\nThe starting line in the original source, relative to the previous source line.\n\n            buffer += @encodeVlq mapping.sourceLine - lastSourceLine\n            if lastSourceLine isnt mapping.sourceLine\n              lastSourceLine = mapping.sourceLine\n              lastSourceColumn = 0\n\nThe starting column in the original source, relative to the previous column.\n\n            buffer += @encodeVlq mapping.sourceColumn - lastSourceColumn\n            lastSourceColumn = mapping.sourceColumn\n            needComma = yes\n\nProduce the canonical JSON object format for a \"v3\" source map.\n\n        v3 =\n          version:    3\n          file:       options.generatedFile or ''\n          sourceRoot: options.sourceRoot or ''\n          sources:    options.sourceFiles or ['']\n          names:      []\n          mappings:   buffer\n\n        v3.sourcesContent = [code] if options.inline\n\n        JSON.stringify v3, null, 2\n\n\nBase64 VLQ Encoding\n-------------------\n\nNote that SourceMap VLQ encoding is \"backwards\".  MIDI-style VLQ encoding puts\nthe most-significant-bit (MSB) from the original value into the MSB of the VLQ\nencoded value (see [Wikipedia](http:\/\/en.wikipedia.org\/wiki\/File:Uintvar_coding.svg)).\nSourceMap VLQ does things the other way around, with the least significat four\nbits of the original value encoded into the first byte of the VLQ encoded value.\n\n      VLQ_SHIFT            = 5\n      VLQ_CONTINUATION_BIT = 1 << VLQ_SHIFT             # 0010 0000\n      VLQ_VALUE_MASK       = VLQ_CONTINUATION_BIT - 1   # 0001 1111\n\n      encodeVlq: (value) ->\n        answer = ''\n\n        # Least significant bit represents the sign.\n        signBit = if value < 0 then 1 else 0\n\n        # The next bits are the actual value.\n        valueToEncode = (Math.abs(value) << 1) + signBit\n\n        # Make sure we encode at least one character, even if valueToEncode is 0.\n        while valueToEncode or not answer\n          nextChunk = valueToEncode & VLQ_VALUE_MASK\n          valueToEncode = valueToEncode >> VLQ_SHIFT\n          nextChunk |= VLQ_CONTINUATION_BIT if valueToEncode\n          answer += @encodeBase64 nextChunk\n\n        answer\n\n\nRegular Base64 Encoding\n-----------------------\n\n      BASE64_CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+\/'\n\n      encodeBase64: (value) ->\n        BASE64_CHARS[value] or throw new Error \"Cannot Base64 encode value: #{value}\"\n\n\nOur API for source maps is just the `SourceMap` class.\n\n    module.exports = SourceMap\n\n\n\n","old_contents":"Source maps allow JavaScript runtimes to match running JavaScript back to\nthe original CoffeeScript source code that corresponds to it. In order to\nproduce maps, we must keep track of positions (line number, column number)\nfor every construct in the syntax tree, and be able to generate a map file\n-- which is a compact, VLQ-encoded representation of the JSON serialization\nof this information -- to write out alongside the generated JavaScript.\n\n    {merge} = require '.\/helpers'\n\n\nLineMap\n-------\n\nKeeps track of information about column positions within a single line of\noutput JavaScript code. **SourceMap**s are implemented in terms of **LineMap**s.\n\n    class LineMap\n      constructor: (@line) ->\n        @columns = []\n\n      add: (column, [sourceLine, sourceColumn], options={}) ->\n        return if @columns[column] and options.noReplace\n        @columns[column] = {line: @line, column, sourceLine, sourceColumn}\n\n      sourceLocation: (column) ->\n        column-- until (mapping = @columns[column]) or (column <= 0)\n        mapping and [mapping.sourceLine, mapping.sourceColumn]\n\n\nSourceMap\n---------\n\nMaps locations in for a single generated JavaScript file back to locations in\nthe original CoffeeScript source file.\n\nThis is intentionally agnostic towards how a source map might be represented on\ndisk. Once the compiler is ready to produce a \"v3\"-style source map, we can walk\nthrough the arrays of line and column buffer to produce it.\n\n    class SourceMap\n      constructor: ->\n        @lines = []\n\nAdds a mapping to this SourceMap. `sourceLocation` and `generatedLocation`\nare both `[line, column]` arrays. If `options.noReplace` is true, then if there\nis already a mapping for the specified `line` and `column`, this will have no\neffect.\n\n      add: (sourceLocation, generatedLocation, options = {}) ->\n        [line, column] = generatedLocation\n        lineMap = (@lines[line] or= new LineMap(line))\n        lineMap.add column, sourceLocation, options\n\nLook up the original position of a given `line` and `column` in the generated\ncode.\n\n      sourceLocation: ([line, column]) ->\n        line-- until (lineMap = @lines[line]) or (line <= 0)\n        lineMap and lineMap.sourceLocation column\n\n`func` will be called once for every recorded mapping, in the order in\nwhich they occur in the generated source.  `fn` will be passed an object\nwith four properties: sourceLine, sourceColumn, line, and\ncolumn.\n\n      each: (iterator) ->\n        for lineMap, lineNumber in @lines when lineMap\n          for mapping in lineMap.columns when mapping\n            iterator mapping\n\n\nV3 SourceMap Generation\n-----------------------\n\nBuilds up a V3 source map, returning the generated JSON as a string.\n`options.sourceRoot` may be used to specify the sourceRoot written to the source\nmap.  Also, `options.sourceFiles` and `options.generatedFile` may be passed to\nset \"sources\" and \"file\", respectively.\n\n      generate: (options = {}, code = null) ->\n        writingline       = 0\n        lastColumn        = 0\n        lastSourceLine    = 0\n        lastSourceColumn  = 0\n        needComma         = no\n        buffer            = \"\"\n\n        @each (mapping) =>\n          while writingline < mapping.line\n            lastColumn = 0\n            needComma = no\n            buffer += \";\"\n            writingline++\n\nWrite a comma if we've already written a segment on this line.\n\n          if needComma\n            buffer += \",\"\n            needComma = no\n\nWrite the next segment. Segments can be 1, 4, or 5 values.  If just one, then it\nis a generated column which doesn't match anything in the source code.\n\nThe starting column in the generated source, relative to any previous recorded\ncolumn for the current line:\n\n          buffer += @encodeVlq mapping.column - lastColumn\n          lastColumn = mapping.column\n\nThe index into the list of sources:\n\n          buffer += @encodeVlq 0\n\nThe starting line in the original source, relative to the previous source line.\n\n          buffer += @encodeVlq mapping.sourceLine - lastSourceLine\n          if lastSourceLine isnt mapping.sourceLine\n            lastSourceLine = mapping.sourceLine\n            lastSourceColumn = 0\n\nThe starting column in the original source, relative to the previous column.\n\n          buffer += @encodeVlq mapping.sourceColumn - lastSourceColumn\n          lastSourceColumn = mapping.sourceColumn\n          needComma = yes\n\nProduce the canonical JSON object format for a \"v3\" source map.\n\n        v3 =\n          version:    3\n          file:       options.generatedFile or ''\n          sourceRoot: options.sourceRoot or ''\n          sources:    options.sourceFiles or ['']\n          names:      []\n          mappings:   buffer\n\n        v3.sourcesContent = [code] if options.inline\n\n        return JSON.stringify v3, null, 2\n\n\nBase64 VLQ Encoding\n-------------------\n\nNote that SourceMap VLQ encoding is \"backwards\".  MIDI-style VLQ encoding puts\nthe most-significant-bit (MSB) from the original value into the MSB of the VLQ\nencoded value (see [Wikipedia](http:\/\/en.wikipedia.org\/wiki\/File:Uintvar_coding.svg)).\nSourceMap VLQ does things the other way around, with the least significat four\nbits of the original value encoded into the first byte of the VLQ encoded value.\n\n      VLQ_SHIFT            = 5\n      VLQ_CONTINUATION_BIT = 1 << VLQ_SHIFT             # 0010 0000\n      VLQ_VALUE_MASK       = VLQ_CONTINUATION_BIT - 1   # 0001 1111\n\n      encodeVlq: (value) ->\n        answer = ''\n\n        # Least significant bit represents the sign.\n        signBit = if value < 0 then 1 else 0\n\n        # The next bits are the actual value.\n        valueToEncode = (Math.abs(value) << 1) + signBit\n\n        # Make sure we encode at least one character, even if valueToEncode is 0.\n        while valueToEncode or not answer\n          nextChunk = valueToEncode & VLQ_VALUE_MASK\n          valueToEncode = valueToEncode >> VLQ_SHIFT\n          nextChunk |= VLQ_CONTINUATION_BIT if valueToEncode\n          answer += @encodeBase64 nextChunk\n\n        return answer\n\n\nRegular Base64 Encoding\n-----------------------\n\n      BASE64_CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+\/'\n\n      encodeBase64: (value) ->\n        BASE64_CHARS[value] or throw new Error \"Cannot Base64 encode value: #{value}\"\n\n\nOur API for source maps is just the `SourceMap` class.\n\n    module.exports = SourceMap\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"029d8ceb5d627e035687b1abedb4cbe8743c0bd1","subject":"Change \"its\" to \"the\"","message":"Change \"its\" to \"the\"\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will have the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with its raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will have the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ea7cc92aa49673020d2410b76a1ed7d8aa5075a1","subject":"Fix spacing a bit.","message":"Fix spacing a bit.\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/policies.litcoffee","new_file":"guts\/policies.litcoffee","new_contents":"Policies\n--------\nThis is the glue-file that manages how user-policies (e.g. who's allowed to do what) get defined.  This file is responsible for grabbing the \n\nLoad in the required libraries\n\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n\nLoad up the user-defined policies. \n\n    policies = require '..\/config\/policies'\n\n\nStart the function.  We're expecting an array of objects with the fields `actionName` and `controllerName`, and the node `req` and `res` objects just in case the policies need them.\n\n    module.exports = (routeActions, req, res) ->\n\nWe want to reject or resolve the promise based on whether or not someone is allowed to do something.  Therefore, it'd be smart to wrap this in a promise.\n\n        new Promise (resolve, reject) ->\n\nLet's load up the helper function that grabs all the policy files.  This function was arguably useful in its own right, so it made sense to make it its own separate module. \n\n            require('.\/getPolicies')()\n\nOnce the policies are done loading, we can move on. \n\n            .then (actualPolicies) ->\n\nSince there is an array routeActions (purposefully), we need to loop through them, and since we need the result afterwards, we can use a map.  Also, since there is a small risk of a couple nested arrays (due to the way that the policies have been implemented, lets flatten it after we're done. \n                \n                policyResults = _.flatten _.map routeActions, (action) ->\n\n\n\n                    \n---------------------------------------\n\n\n                    \nWhat I'm doing here is looking for the policies file.\nIf there is a policy defined for that action, use that, else use the `*` catch all.\n\nThe flatten is necessary simply because I don't want to punish people for only listing one policy outside of an array.  Subsequently, we'll wrap everything in an array and then flatten it. \n\n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\nThis is pretty straightforward; we'll loop up the policy in the hash\ntable and then return back their result (which can just be a true or false\n\nWe want to make sure this is properly wrapped in promisey stuff, so we can init\nan empty promise then run our stuff in the \"then\". Since our empty promise only\nresolves, it won't hit the catch. \n\n                        _.map tempPolicies, (policy) ->\n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n\nOnce all the policy promises have resolved, let's return out response.\n                \n                Promise.all policyResults\n                .then (results) ->\n                    # Not entirely sure I like this logic, but it's pretty straightforward:\n                    # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                    # either allow the policy to reject if not permitted or to simply return false. \n                    unless false in results\n                      resolve true\n                    else\n                      reject \"Not Authorized\"\n                \n","old_contents":"Policies\n--------\nThis is the glue-file that manages how user-policies (e.g. who's allowed to do what) get defined.  This file is responsible for grabbing the \n\nLoad in the required libraries\n\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n\nLoad up the user-defined policies. \n\n    policies = require '..\/config\/policies'\n\n\nStart the function.  We're expecting an array of objects with the fields `actionName` and `controllerName`, and the node `req` and `res` objects just in case the policies need them.\n\n    module.exports = (routeActions, req, res) ->\n\nWe want to reject or resolve the promise based on whether or not someone is allowed to do something.  Therefore, it'd be smart to wrap this in a promise.\n\n        new Promise (resolve, reject) ->\n\nLet's load up the helper function that grabs all the policy files.  This function was arguably useful in its own right, so it made sense to make it its own separate module. \n\n            require('.\/getPolicies')()\n\nOnce the policies are done loading, we can move on. \n\n            .then (actualPolicies) ->\n\nSince there is an array routeActions (purposefully), we need to loop through them, and since we need the result afterwards, we can use a map.  Also, since there is a small risk of a couple nested arrays (due to the way that the policies have been implemented, lets flatten it after we're done. \n                \n                policyResults = _.flatten _.map routeActions, (action) ->\n\n---------------------------------------\n                    \nWhat I'm doing here is looking for the policies file.\nIf there is a policy defined for that action, use that, else use the * catch all.\n\nThe flatten is necessary simply because I don't want to punish people for only listing one policy outside of an array.  Subsequently, we'll wrap everything in an array and then flatten it. \n\n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\nThis is pretty straightforward; we'll loop up the policy in the hash\ntable and then return back their result (which can just be a true or false\n\nWe want to make sure this is properly wrapped in promisey stuff, so we can init\nan empty promise then run our stuff in the \"then\". Since our empty promise only\nresolves, it won't hit the catch. \n\n                        _.map tempPolicies, (policy) ->\n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n\nOnce all the policy promises have resolved, let's return out response.\n                \n                Promise.all policyResults\n                .then (results) ->\n                    # Not entirely sure I like this logic, but it's pretty straightforward:\n                    # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                    # either allow the policy to reject if not permitted or to simply return false. \n                    unless false in results\n                      resolve true\n                    else\n                      reject \"Not Authorized\"\n                \n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"838ddeeef40cd084a38eb245a5664cecaab4e5a2","subject":"io ajax error fix","message":"io ajax error fix\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"479f9a22170cabcd4d451817a2887db41dd312bc","subject":"Remove unneeded catch handlers, change how resolve is called","message":"Remove unneeded catch handlers, change how resolve is called\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = underscore tokens[1].trim()\n      else if tokens.length == 1\n        alias = underscore name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @DUMMY: (deps, cb) ->\n        class __DUMMY__ extends Madul\n          deps: deps\n\n        new __DUMMY__()\n          .initialize()\n          .then cb\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || underscore(name), alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            WRAPPED[proto.constructor.name].push method\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, (errors) =>\n              if errors?\n                wrapped errors\n              else\n                proto[\"_#{method}\"] = proto[method]\n\n                proto[method] = =>\n                  def = q.defer()\n                  me  = proto[\"_#{method}\"]\n\n                  if args_format == 'ARRAY'\n                    args = Array.prototype.slice.call arguments\n                  else if args_format == 'OBJECT'\n                    args = arguments[0]\n                  else\n                    proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                    return def.reject 'No arg format specified'\n\n                  before = @_process_decorators me, 'before'\n                  after  = @_process_decorators me, 'after'\n\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries me.validators, (v, next) =>\n                      arg       = Object.keys(v)[0]\n                      validator = v[arg]\n                      input     = arg\n                      prop      = args\n\n                      for a in arg.split '.'\n                        prop  = prop[a]\n                        input = a\n\n                      if Array.isArray validator\n                        async.eachSeries validator, (v, nxt) =>\n                          proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                          proto[v].EXECUTE.call proto[v], input, prop\n                            .then nxt\n                            .catch handle_err v, { \"#{input}\": prop }, nxt, (err) =>\n                              reject err\n                              def.reject err\n                        , next\n                      else\n                        proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                        proto[validator].EXECUTE.call proto[validator], input, prop\n                          .then next\n                          .catch handle_err v, { \"#{input}\": prop }, next, (err) =>\n                            reject err\n                            def.reject err\n                    , => resolve()\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      async.eachSeries before, (b, next) =>\n                        proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                        proto[b].before.call proto[b], args\n                          .then next\n                          .catch handle_err b, args, next, (err) =>\n                            reject err\n                            def.reject err\n                      , => resolve()\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      input = proto._prep_invocation proto, method, args, { resolve, reject }\n\n                      try\n                        me.behavior.apply proto, input\n                      catch e\n                        me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                        reject e\n                  .then (result) =>\n                    q.Promise (resolve, reject) =>\n                      if after.length > 0\n                        async.eachSeries after, (a, next) =>\n                          proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                          proto[a].after.call proto[a], result\n                            .then next\n                            .catch handle_err b, args, next, (err) =>\n                              reject err\n                              def.reject err\n                        , => resolve result\n                      else\n                        process.nextTick => resolve result\n                  .then  (out) => def.resolve out\n                  .catch (err) => def.reject  err\n\n                  def.promise\n\n                INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n                WRAPPED[proto.constructor.name].push method\n\n                wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if proto.deps?\n                filtered = proto.deps.filter (d) => Madul.PARSE_SPEC(d).name == prop.replace \/_\/g, '-'\n\n                continue if filtered.length > 0\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, (errors) =>\n              if errors?\n                stop = new Error()\n                stop.break = true\n\n                next stop\n              else\n                next()\n          , (errors) =>\n            if errors?\n              stop = new Error()\n              stop.break = true\n\n              completed stop\n            else\n              @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{strip name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, (errors) =>\n                if errors?\n                  stop = new Error()\n                  stop.break = true\n\n                  next stop\n                else\n                  HYDRATED[name] = true\n\n                  for listener in HYRDATION_LISTENERS[name]\n                    listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, done, fail) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then  (m)   => done m\n            .catch (err) => fail err\n        else\n          done mod\n\n      _load: (me, name, path, loaded, fail) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded()\n        , fail\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.eachSeries files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.' && f != 'node_modules'\n                  me._check me, depth, dep, ref, => next()\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  stop  = new Error()\n                  stop.break = true\n\n                  me._load me, ref, depth, =>\n                    me._do_add me, ref, => next stop\n                  , (err) => next stop\n                else\n                  next()\n            , => finished()\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next() if typeof next == 'function'\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n        , (err) =>\n          stop = new Error()\n          stop.break = true\n\n          next stop\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n        errors  = [ ]\n\n        async.eachSeries deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                if proto[spec.parent]?\n                  deep = SEARCH_ROOTS[spec.parent]\n\n                  proto._check proto, deep, spec.name, spec.ref, (err) =>\n                    if err == 'NOT_FOUND'\n                      proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                        if err?\n                          stop = new Error()\n                          stop.break = true\n\n                          proto.warn.call proto, 'not-found', dep: d\n\n                          next stop\n                        else\n                          next()\n                    else\n                      next()\n                else\n                  proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                  @_do_hydrate proto, [ spec.parent ], (errors) =>\n                    if errors?\n                      stop = new Error()\n                      stop.break = true\n\n                      next stop\n                    else\n                      if SEARCH_ROOTS[spec.parent] == undefined\n                        SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                      deep = SEARCH_ROOTS[spec.parent]\n\n                      proto._check proto, deep, spec.name, spec.ref, (err) =>\n                        if err == 'NOT_FOUND'\n                          proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                            if err?\n                              stop = new Error()\n                              stop.break = true\n\n                              proto.warn.call proto, 'not-found', dep: d\n\n                              next stop\n                            else\n                              next()\n                        else\n                          next()\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    nxt()\n                  , =>\n                    nxt()\n                , =>\n                  next()\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, (err) =>\n                  if err?\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next stop\n                  else\n                    next()\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , (err) =>\n          if err?.length > 0\n            proto.warn.call proto, 'hydration.halt', errors\n\n            hydration_complete errors\n          else\n            async.eachSeries initers, (initer, next) =>\n              proto[initer.execute].apply(@).then next\n            , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, next) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n        fs.stat pkg, (err, stat) =>\n          if err?\n            next()\n          else if stat.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            next()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        filtered = found.filter (f) => f?\n\n        if filtered.length > 0\n          filtered.sort((a, b) => a.length - b.length)[0]\n        else\n          [ ]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            if name == '__DUMMY__'\n              LOCALS[name] = \"#{process.cwd()}\/dist\"\n            else\n              LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, (errors) =>\n            if errors?\n              deferred.reject errors\n            else\n              @_wrap_methods proto, (err) =>\n                if err?\n                  deferred.reject err\n                else\n                  @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = underscore tokens[1].trim()\n      else if tokens.length == 1\n        alias = underscore name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @DUMMY: (deps, cb) ->\n        class __DUMMY__ extends Madul\n          deps: deps\n\n        new __DUMMY__()\n          .initialize()\n          .then cb\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || underscore(name), alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            WRAPPED[proto.constructor.name].push method\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, (errors) =>\n              if errors?\n                wrapped errors\n              else\n                proto[\"_#{method}\"] = proto[method]\n\n                proto[method] = =>\n                  def = q.defer()\n                  me  = proto[\"_#{method}\"]\n\n                  if args_format == 'ARRAY'\n                    args = Array.prototype.slice.call arguments\n                  else if args_format == 'OBJECT'\n                    args = arguments[0]\n                  else\n                    proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                    return def.reject 'No arg format specified'\n\n                  before = @_process_decorators me, 'before'\n                  after  = @_process_decorators me, 'after'\n\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries me.validators, (v, next) =>\n                      arg       = Object.keys(v)[0]\n                      validator = v[arg]\n                      input     = arg\n                      prop      = args\n\n                      for a in arg.split '.'\n                        prop  = prop[a]\n                        input = a\n\n                      if Array.isArray validator\n                        async.eachSeries validator, (v, nxt) =>\n                          proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                          proto[v].EXECUTE.call proto[v], input, prop\n                            .then nxt\n                            .catch handle_err v, { \"#{input}\": prop }, nxt, (err) =>\n                              reject err\n                              def.reject err\n                        , next\n                      else\n                        proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                        proto[validator].EXECUTE.call proto[validator], input, prop\n                          .then next\n                          .catch handle_err v, { \"#{input}\": prop }, next, (err) =>\n                            reject err\n                            def.reject err\n                    , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      async.eachSeries before, (b, next) =>\n                        proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                        proto[b].before.call proto[b], args\n                          .then next\n                          .catch handle_err b, args, next, (err) =>\n                            reject err\n                            def.reject err\n                      , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      input = proto._prep_invocation proto, method, args, { resolve, reject }\n\n                      try\n                        me.behavior.apply proto, input\n                      catch e\n                        me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                        reject e\n                  .catch (err) => def.reject err\n                  .then (result) =>\n                    q.Promise (resolve, reject) =>\n                      if after.length > 0\n                        async.eachSeries after, (a, next) =>\n                          proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                          proto[a].after.call proto[a], result\n                            .then next\n                            .catch handle_err b, args, next, (err) =>\n                              reject err\n                              def.reject err\n                        , => resolve result\n                      else\n                        process.nextTick => resolve result\n                  .then  (out) => def.resolve out\n                  .catch (err) => def.reject  err\n\n                  def.promise\n\n                INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n                WRAPPED[proto.constructor.name].push method\n\n                wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if proto.deps?\n                filtered = proto.deps.filter (d) => Madul.PARSE_SPEC(d).name == prop.replace \/_\/g, '-'\n\n                continue if filtered.length > 0\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, (errors) =>\n              if errors?\n                stop = new Error()\n                stop.break = true\n\n                next stop\n              else\n                next()\n          , (errors) =>\n            if errors?\n              stop = new Error()\n              stop.break = true\n\n              completed stop\n            else\n              @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{strip name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, (errors) =>\n                if errors?\n                  stop = new Error()\n                  stop.break = true\n\n                  next stop\n                else\n                  HYDRATED[name] = true\n\n                  for listener in HYRDATION_LISTENERS[name]\n                    listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, done, fail) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then  (m)   => done m\n            .catch (err) => fail err\n        else\n          done mod\n\n      _load: (me, name, path, loaded, fail) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded()\n        , fail\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.eachSeries files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.' && f != 'node_modules'\n                  me._check me, depth, dep, ref, => next()\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  stop  = new Error()\n                  stop.break = true\n\n                  me._load me, ref, depth, =>\n                    me._do_add me, ref, => next stop\n                  , (err) => next stop\n                else\n                  next()\n            , => finished()\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next() if typeof next == 'function'\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n        , (err) =>\n          stop = new Error()\n          stop.break = true\n\n          next stop\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n        errors  = [ ]\n\n        async.eachSeries deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                if proto[spec.parent]?\n                  deep = SEARCH_ROOTS[spec.parent]\n\n                  proto._check proto, deep, spec.name, spec.ref, (err) =>\n                    if err == 'NOT_FOUND'\n                      proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                        if err?\n                          stop = new Error()\n                          stop.break = true\n\n                          proto.warn.call proto, 'not-found', dep: d\n\n                          next stop\n                        else\n                          next()\n                    else\n                      next()\n                else\n                  proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                  @_do_hydrate proto, [ spec.parent ], (errors) =>\n                    if errors?\n                      stop = new Error()\n                      stop.break = true\n\n                      next stop\n                    else\n                      if SEARCH_ROOTS[spec.parent] == undefined\n                        SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                      deep = SEARCH_ROOTS[spec.parent]\n\n                      proto._check proto, deep, spec.name, spec.ref, (err) =>\n                        if err == 'NOT_FOUND'\n                          proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                            if err?\n                              stop = new Error()\n                              stop.break = true\n\n                              proto.warn.call proto, 'not-found', dep: d\n\n                              next stop\n                            else\n                              next()\n                        else\n                          next()\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    nxt()\n                  , =>\n                    nxt()\n                , =>\n                  next()\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, (err) =>\n                  if err?\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next stop\n                  else\n                    next()\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , (err) =>\n          if err?.length > 0\n            proto.warn.call proto, 'hydration.halt', errors\n\n            hydration_complete errors\n          else\n            async.eachSeries initers, (initer, next) =>\n              proto[initer.execute].apply(@).then next\n            , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, next) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n        fs.stat pkg, (err, stat) =>\n          if err?\n            next()\n          else if stat.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            next()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        filtered = found.filter (f) => f?\n\n        if filtered.length > 0\n          filtered.sort((a, b) => a.length - b.length)[0]\n        else\n          [ ]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            if name == '__DUMMY__'\n              LOCALS[name] = \"#{process.cwd()}\/dist\"\n            else\n              LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, (errors) =>\n            if errors?\n              deferred.reject errors\n            else\n              @_wrap_methods proto, (err) =>\n                if err?\n                  deferred.reject err\n                else\n                  @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d2183e9549c7513752c5e03b95c8c62d6d7fd2f2","subject":"Use fire to identify which madul is firing these events","message":"Use fire to identify which madul is firing these events\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push e\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = e\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        proto._report method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.Promise (resolve, reject) =>\n                  async.eachSeries me.validators, (v, next) =>\n                    arg       = Object.keys(v)[0]\n                    validator = v[arg]\n                    input     = arg\n                    prop      = args\n\n                    for a in arg.split '.'\n                      prop  = prop[a]\n                      input = a\n\n                    if Array.isArray validator\n                      async.eachSeries validator, (v, nxt) =>\n                        proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                        proto[v].EXECUTE.call proto[v], input, prop\n                          .then nxt\n                          .catch handle_err v, { \"#{input}\": prop }, nxt, reject\n                      , next\n                    else\n                      proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                      proto[validator].EXECUTE.call proto[validator], input, prop\n                        .then next\n                        .catch handle_err v, { \"#{input}\": prop }, next, reject\n                  , resolve\n                .then =>\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries before, (b, next) =>\n                      proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                      proto[b].before.call proto[b], args\n                        .then next\n                        .catch handle_err b, args, next, reject\n                    , resolve\n                .then =>\n                  input = proto._prep_invocation proto, method, args, def\n\n                  try\n                    me.behavior.apply me, input\n                  catch e\n                    failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                    me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                    failed e.message\n                .then (result) =>\n                  q.Promise (resolve, reject) =>\n                    if after.length > 0\n                      async.eachSeries after, (a, next) =>\n                        proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                        proto[a].after.call proto[a], result\n                          .then next\n                          .catch handle_err b, args, next, reject\n                      , => resolve result\n                    else\n                      process.nextTick => resolve result\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n\n              INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n              wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, next\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        error = true\n\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) =>\n                    me._do_add me, ref, next\n                    error = undefined\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    stop = new Error()\n                    stop.break = true\n\n                    next()\n                    nxt stop\n                  , nxt\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push e\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = e\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        proto._report method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            Madul.FIRE '$.Madul.decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.Promise (resolve, reject) =>\n                  async.eachSeries me.validators, (v, next) =>\n                    arg       = Object.keys(v)[0]\n                    validator = v[arg]\n                    input     = arg\n                    prop      = args\n\n                    for a in arg.split '.'\n                      prop  = prop[a]\n                      input = a\n\n                    if Array.isArray validator\n                      async.eachSeries validator, (v, nxt) =>\n                        proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                        proto[v].EXECUTE.call proto[v], input, prop\n                          .then nxt\n                          .catch handle_err v, { \"#{input}\": prop }, nxt, reject\n                      , next\n                    else\n                      proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                      proto[validator].EXECUTE.call proto[validator], input, prop\n                        .then next\n                        .catch handle_err v, { \"#{input}\": prop }, next, reject\n                  , resolve\n                .then =>\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries before, (b, next) =>\n                      proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                      proto[b].before.call proto[b], args\n                        .then next\n                        .catch handle_err b, args, next, reject\n                    , resolve\n                .then =>\n                  input = proto._prep_invocation proto, method, args, def\n\n                  try\n                    me.behavior.apply me, input\n                  catch e\n                    failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                    me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                    failed e.message\n                .then (result) =>\n                  q.Promise (resolve, reject) =>\n                    if after.length > 0\n                      async.eachSeries after, (a, next) =>\n                        proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                        proto[a].after.call proto[a], result\n                          .then next\n                          .catch handle_err b, args, next, reject\n                      , => resolve result\n                    else\n                      process.nextTick => resolve result\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n\n              INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n              wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, next\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        error = true\n\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) =>\n                    me._do_add me, ref, next\n                    error = undefined\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                Madul.FIRE '$.Madul.search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    stop = new Error()\n                    stop.break = true\n\n                    next()\n                    nxt stop\n                  , nxt\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0969c095a6dbac4697d537e42412383216aa0bb1","subject":"Attach exit signals ASAP","message":"Attach exit signals ASAP\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"server.litcoffee","new_file":"server.litcoffee","new_contents":"# Server application entry point\n\n*Load the configuration, invoke the bootstrap hooks, and listen for signals\nand process exit.*\n\nThe core bootstrap phase injects environment into a forked copy of the\napplication including require paths to allow core and custom packages to be\nincluded without qualification.\n\n    {fork} = require \".\/server\/bootstrap\"\n    unless fork()\n\n      Promise = require 'bluebird'\n\n      debug = require('debug') 'shrub:server'\n      debugSilly = require('debug') 'shrub-silly:server'\n\n      errors = require 'errors'\n      middleware = require 'middleware'\n      pkgman = require 'pkgman'\n\nSet up exit hooks.\n\n#### Invoke hook `shrubCoreProcessExit`.\n\n      process.on 'exit', -> pkgman.invoke 'shrubCoreProcessExit'\n\n      process.on 'SIGINT', -> process.exit()\n      process.on 'SIGTERM', -> process.exit()\n      process.on 'unhandledException', -> process.exit()\n\nLoad the configuration.\n\n      debug 'Loading config...'\n\n      config = require 'config'\n      config.load()\n      config.loadPackageSettings()\n\n      debug 'Config loaded.'\n\n#### Invoke hook `shrubCorePreBootstrap`.\n\n      debugSilly 'Pre bootstrap phase...'\n      pkgman.invoke 'shrubCorePreBootstrap'\n      debugSilly 'Pre bootstrap phase completed.'\n\n#### Invoke hook `shrubCoreBootstrapMiddleware`.\n\n      debugSilly 'Loading bootstrap middleware...'\n\n      bootstrapMiddleware = middleware.fromConfig(\n        'shrub-core:bootstrapMiddleware'\n      )\n\n      middleware.fromHook(\n        'shrubCoreBootstrapMiddleware'\n        config.get 'packageSettings:shrub-core:shrubCoreBootstrapMiddleware'\n      )\n\n      debugSilly 'Bootstrap middleware loaded.'\n\nDispatch the bootstrap middleware stack and log if everything is okay.\n\n      bootstrapMiddleware.dispatch (error) ->\n        return debug 'Bootstrap complete.' unless error?\n\nLog and throw any error. This will be caught by the unhandledException\nlistener below.\n\n        console.error errors.stack error\n        throw error\n","old_contents":"# Server application entry point\n\n*Load the configuration, invoke the bootstrap hooks, and listen for signals\nand process exit.*\n\nThe core bootstrap phase injects environment into a forked copy of the\napplication including require paths to allow core and custom packages to be\nincluded without qualification.\n\n    {fork} = require \".\/server\/bootstrap\"\n    unless fork()\n\n      Promise = require 'bluebird'\n\n      debug = require('debug') 'shrub:server'\n      debugSilly = require('debug') 'shrub-silly:server'\n\n      errors = require 'errors'\n      middleware = require 'middleware'\n      pkgman = require 'pkgman'\n\nLoad the configuration.\n\n      debug 'Loading config...'\n\n      config = require 'config'\n      config.load()\n      config.loadPackageSettings()\n\n      debug 'Config loaded.'\n\n#### Invoke hook `shrubCorePreBootstrap`.\n\n      debugSilly 'Pre bootstrap phase...'\n      pkgman.invoke 'shrubCorePreBootstrap'\n      debugSilly 'Pre bootstrap phase completed.'\n\n#### Invoke hook `shrubCoreBootstrapMiddleware`.\n\n      debugSilly 'Loading bootstrap middleware...'\n\n      bootstrapMiddleware = middleware.fromConfig(\n        'shrub-core:bootstrapMiddleware'\n      )\n\n      middleware.fromHook(\n        'shrubCoreBootstrapMiddleware'\n        config.get 'packageSettings:shrub-core:shrubCoreBootstrapMiddleware'\n      )\n\n      debugSilly 'Bootstrap middleware loaded.'\n\nDispatch the bootstrap middleware stack and log if everything is okay.\n\n      bootstrapMiddleware.dispatch (error) ->\n        return debug 'Bootstrap complete.' unless error?\n\nLog and throw any error. This will be caught by the unhandledException\nlistener below.\n\n        console.error errors.stack error\n        throw error\n\n#### Invoke hook `shrubCoreProcessExit`.\n\n      process.on 'exit', -> pkgman.invoke 'shrubCoreProcessExit'\n\n      process.on 'SIGINT', -> process.exit()\n      process.on 'SIGTERM', -> process.exit()\n      process.on 'unhandledException', -> process.exit()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"966fe12ed005f76924c7e0ba131a568b30f7769b","subject":"only show oneof selection when there are options","message":"only show oneof selection when there are options\n","repos":"vpj\/models","old_file":"js\/properties\/oneof.litcoffee","new_file":"js\/properties\/oneof.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#OneOf\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Models.Models'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, MODELS, WeyaBase, Weya) ->\n\n\nClass\n\n      class OneOf extends Base\n       @extend()\n\n       propertyType: 'oneof'\n\n       @default 'oneof', ['Null']\n       @default 'default', ->\n        return null if @schema.oneof.length is 0\n        model = new (MODELS.get @schema.oneof[0])\n        r = model.parse @schema.defaultValues.call this\n        return r.value\n\n       @default 'defaultValues', -> {}\n\n       @default 'isDefault', (value) ->\n        return true if @schema.oneof.length is 0\n        model = new (MODELS.get @schema.oneof[0])\n        model.parse value\n        model.isDefault()\n\n       @isValidSchema: (schema) ->\n        return false if not super schema\n        return false if not schema.oneof?\n        return true\n\n       parse: (data) ->\n        r = super data\n        return r unless r is true\n\n        res =\n         score: 0\n         errors: ['invalid']\n         value: @schema.default.call this\n        for type in @schema.oneof\n         m = new (MODELS.get type)\n         r = m.parse data\n         if res.score < r.score\n          res = r\n\n        return res\n\n       toJSON: (value) -> value.toJSON()\n       toJSONFull: (value) -> value.toJSONFull()\n\n       edit: (elem, value, changed) ->\n        new Edit this, elem, value, changed\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, changed) ->\n        @property = property\n        @elems =\n         parent: elem\n        @model = value\n        @onChanged = changed\n        @render()\n\n       render: ->\n        Weya elem: @elems.parent, context: this, ->\n         @$.elems.controls = @div \".oneof-controls\", ->\n          @$.elems.type = @select on: {change: @$.on.typeChange}, ->\n           for type in @$.property.schema.oneof\n            @option value: type, type\n\n         @$.elems.model = @div \".model\", null\n\n        if @property.schema.oneof.length <= 1\n         @elems.controls.style.display = 'none'\n\n        @renderModel()\n\n       @listen 'typeChange', (e) ->\n        type = @elems.type.value\n        return if type is @model.type\n        json = @model.toJSON()\n        @model = new (MODELS.get type)\n        r = @model.parse json\n        @onChanged @model, true\n        @renderModel()\n\n       renderModel: ->\n        @elems.model.innerHTML = ''\n        @elems.type.value = @model.type\n        @model.edit @elems.model, @modelChanged.bind this\n\n       modelChanged: (value) ->\n        @onChanged value, false\n\n\n\n\n\n      PROPERTIES.register 'oneof', OneOf\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#OneOf\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Models.Models'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, MODELS, WeyaBase, Weya) ->\n\n\nClass\n\n      class OneOf extends Base\n       @extend()\n\n       propertyType: 'oneof'\n\n       @default 'oneof', ['Null']\n       @default 'default', ->\n        return null if @schema.oneof.length is 0\n        model = new (MODELS.get @schema.oneof[0])\n        r = model.parse @schema.defaultValues.call this\n        return r.value\n\n       @default 'defaultValues', -> {}\n\n       @default 'isDefault', (value) ->\n        return true if @schema.oneof.length is 0\n        model = new (MODELS.get @schema.oneof[0])\n        model.parse value\n        model.isDefault()\n\n       @isValidSchema: (schema) ->\n        return false if not super schema\n        return false if not schema.oneof?\n        return true\n\n       parse: (data) ->\n        r = super data\n        return r unless r is true\n\n        res =\n         score: 0\n         errors: ['invalid']\n         value: @schema.default.call this\n        for type in @schema.oneof\n         m = new (MODELS.get type)\n         r = m.parse data\n         if res.score < r.score\n          res = r\n\n        return res\n\n       toJSON: (value) -> value.toJSON()\n       toJSONFull: (value) -> value.toJSONFull()\n\n       edit: (elem, value, changed) ->\n        new Edit this, elem, value, changed\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, changed) ->\n        @property = property\n        @elems =\n         parent: elem\n        @model = value\n        @onChanged = changed\n        @render()\n\n       render: ->\n        Weya elem: @elems.parent, context: this, ->\n         @div \".oneof-controls\", ->\n          @$.elems.type = @select on: {change: @$.on.typeChange}, ->\n           for type in @$.property.schema.oneof\n            @option value: type, type\n\n         @$.elems.model = @div \".model\", null\n\n        #@elems.add.addEventListener 'click', @addClicked.bind this\n\n        @renderModel()\n\n       @listen 'typeChange', (e) ->\n        type = @elems.type.value\n        return if type is @model.type\n        json = @model.toJSON()\n        @model = new (MODELS.get type)\n        r = @model.parse json\n        @onChanged @model, true\n        @renderModel()\n\n       renderModel: ->\n        @elems.model.innerHTML = ''\n        @elems.type.value = @model.type\n        @model.edit @elems.model, @modelChanged.bind this\n\n       modelChanged: (value) ->\n        @onChanged value, false\n\n\n\n\n\n      PROPERTIES.register 'oneof', OneOf\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0e2d5dd6513736f692ab85cfa03d36402140354a","subject":"update constructor docs","message":"update constructor docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5fc164b95d702c1e2b4642282ee57edee6960e17","subject":"'routes\/' now is optional","message":"'routes\/' now is optional\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/app\/index.litcoffee","new_file":"src\/app\/index.litcoffee","new_contents":"# App\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    signal = require 'src\/signal'\n    db = require 'src\/db'\n    assert = require 'src\/assert'\n    Schema = require 'src\/schema'\n    Networking = require 'src\/networking'\n    Document = require 'src\/document'\n    Renderer = require 'src\/renderer'\n    Styles = require 'src\/styles'\n    Resources = require 'src\/resources'\n    Dict = require 'src\/dict'\n\n    AppRoute = require '.\/route'\n\n    if utils.isNode\n        bootstrapRoute = require '.\/bootstrap\/route.node'\n\n    `\/\/<development>`\n    pkg = require 'package.json'\n    `\/\/<\/development>`\n\n    BASE_FILE_NAME_RE = \/(.+)\\.(?:node|server|client|browser|ios|android|native)\/\n    DEFAULT_CONFIG =\n        title: 'Neft.io Application'\n        protocol: 'http'\n        port: 3000\n        host: 'localhost'\n        language: 'en'\n        type: 'app'\n\n    exports = module.exports = (opts = {}, extraOpts = {}) ->\n        # Welcome log also for release mode\n        log.ok \"Welcome! Neft.io v#{pkg.version}; Feedback appreciated\"\n\n        `\/\/<development>`\n        log.warn \"Use this bundle only in development; type --release when it's ready\"\n        `\/\/<\/development>`\n\n        config = utils.merge utils.clone(DEFAULT_CONFIG), opts.config\n\n        if extraOpts?\n            utils.merge config, extraOpts\n\n# *Dict* app\n\n        app = new Dict\n\n## *Object* app.config = `{}`\n\nConfig object from the *package.json* file.\n\nCan be overriden in the *init.js* file.\n\n### type\n\nThe `app` type (the default one) uses renderer on the client side.\n\nThe `game` type uses special renderer (if exists) focused on more performance goals.\n\nThe `text` type always return HTML document with no renderer on the client side.\nIt's used for the crawlers (e.g. GoogleBot) or browsers with no javascript support.\n\n```javascript\n\/\/ package.json\n{\n    \"name\": \"neft.io app\",\n    \"version\": \"0.1.0\",\n    \"config\": {\n        \"title\": \"My first application!\",\n        \"protocol\": \"http\",\n        \"port\": 3000,\n        \"host\": \"localhost\",\n        \"language\": \"en\",\n        \"type\": \"app\"\n    }\n}\n\/\/ init.js\nmodule.exports = function(NeftApp) {\n    var app = NeftApp({ title: \"Overridden title\" });\n    console.log(app.config);\n    \/\/ {title: \"My first application!\", protocol: \"http\", port: ....}\n};\n```\n\n        app.config = config\n\n## *Networking* app.networking\n\nStandard Networking instance used to communicate\nwith the server and to create local requests.\n\nAll routes created by the *App.Route* uses this networking.\n\nHTTP protocol is used by default with the data specified in the *package.json*.\n\n        app.networking = new Networking\n            type: Networking.HTTP\n            protocol: config.protocol\n            port: parseInt(config.port, 10)\n            host: config.host\n            url: config.url\n            language: config.language\n\n## *Object* app.models = `{}`\n\nFiles from the *models* folder with objects returned by their exported functions.\n\n```javascript\n\/\/ models\/user\/permission.js\nmodule.exports = function(app) {\n    return {\n        getPermission: function(id){}\n    };\n};\n\/\/ controllers\/user.js\nmodule.exports = function(app) {\n    return {\n        get: function(req, res, callback) {\n            var data = app.models['user\/permission'].getPermission(req.params.userId);\n            callback(null, data);\n        }\n    }\n};\n```\n\n        app.models = {}\n\n## *Object* app.routes = `{}`\n\nFiles from the *routes* folder with objects returned by their exported functions.\n\n        app.routes = {}\n\n## *Object* app.styles = `{}`\n\nFiles from the *styles* folder as *Function*s\nready to create new *Item*s.\n\n        app.styles = {}\n\n## *Object* app.views = `{}`\n\nFiles from the *views* folder as the *Document* instances.\n\n        app.views = {}\n\n## *Resources* app.resources\n\n        app.resources = do ->\n            if opts.resources\n                Resources.fromJSON(opts.resources)\n            else\n                new Resources\n\n## *Signal* app.onReady()\n\nCalled when all modules, views, styled etc. have been loaded.\n\n        signal.create app, 'onReady'\n\n        # config.type\n        config.type ?= 'app'\n        assert.ok utils.has(['app', 'game', 'text'], config.type), \"Unexpected app.config.type value. Accepted app\/game\/text, but '#{config.type}' got.\"\n\n        app.Route = AppRoute app\n\n## *Dict* app.cookies\n\nOn the client side, this object refers to the last received cookies\nfrom the networking request.\n\nOn the server side, this cookies object are added into the each networking response.\n\nBy default, client has *clientId* and *sessionId* hashes.\n\n```javascript\napp.cookies.onChange(function(key){\n    console.log('cookie changed', key, this[key]);\n});\n```\n\n```xml\n<h1>Your clientId<\/h1>\n<em>${root.app.cookies.clientId}<\/em>\n```\n\n        # cookies\n        COOKIES_KEY = '__neft_cookies'\n        app.cookies = null\n        onCookiesReady = (dict) ->\n            app.cookies = dict\n            if utils.isClient\n                dict.set 'sessionId', utils.uid(16)\n        db.get COOKIES_KEY, db.OBSERVABLE, (err, dict) ->\n            if dict\n                onCookiesReady dict\n            else\n                if utils.isClient\n                    cookies = {clientId: utils.uid(16)}\n                else\n                    cookies = {}\n                db.set COOKIES_KEY, cookies, (err) ->\n                    db.get COOKIES_KEY, db.OBSERVABLE, (err, dict) ->\n                        onCookiesReady dict\n        app.networking.onRequest (req, res) ->\n            if utils.isClient\n                utils.merge req.cookies, app.cookies\n            else\n                utils.merge res.cookies, app.cookies\n            req.onLoadEnd.listeners.unshift ->\n                if utils.isClient\n                    for key, val of res.cookies\n                        unless utils.isEqual(app.cookies[key], val)\n                            app.cookies.set key, val\n                return\n            , null\n            return\n\n        # propagate data\n        Renderer.resources = app.resources\n        Renderer.serverUrl = app.networking.url\n        Document.Scripts.scripts = utils.arrayToObject opts.scripts,\n            (index, elem) -> elem.name,\n            (index, elem) -> elem.file\n\n        # set styles window item\n        if opts.styles?\n            for style in opts.styles\n                if style.name in ['view', '__view__']\n                    style.file._init app: app, view: null\n                    windowStyle = style.file._main.getComponent()\n                    break\n\n        windowStyleItem = windowStyle?.item or new Renderer.Item\n        Renderer.window = windowStyleItem\n\n        if opts.styles?\n            stylesInitObject =\n                app: app\n                view: windowStyleItem\n\n            # initialize styles\n            for style in opts.styles when style.name?\n                if style.name isnt 'view'\n                    style.file._init stylesInitObject\n                app.styles[style.name] = style.file\n\n        # load styles\n        Styles\n            windowStyle: windowStyle\n            styles: app.styles\n            queries: opts.styleQueries\n            resources: app.resources\n\n        # load bootstrap\n        if utils.isNode\n            bootstrapRoute app\n\n        # loading files helper\n        init = (files, target) ->\n            for file in files when file.name?\n                if typeof file.file isnt 'function'\n                    continue\n\n                fileObj = file.file app\n                target[file.name] = fileObj\n\n                if baseNameMatch = BASE_FILE_NAME_RE.exec(file.name)\n                    [_, baseName] = baseNameMatch\n                    if target[baseName]?\n                        if utils.isPlainObject(target[baseName]) and utils.isPlainObject(fileObj)\n                            fileObj = utils.merge Object.create(target[baseName]), fileObj\n                    target[baseName] = fileObj\n\n            return\n\n        # load document extensions\n        if utils.isObject(opts.extensions)\n            for ext in opts.extensions\n                ext app: app\n\n        # exports app classes\n        exports.app =\n            Route: app.Route\n\n        # load views\n        for view in opts.views when view.name?\n            app.views[view.name] = Document.fromJSON view.file\n\n        # load files\n        init opts.models, app.models\n        init opts.routes, app.routes\n\n        for path, obj of app.routes\n            r = {}\n            if utils.isObject(obj) and not (obj instanceof app.Route)\n                for method, opts of obj\n                    if utils.isObject(opts)\n                        route = new app.Route method, opts\n                        r[route.name] = route\n                    else\n                        r[method] = opts\n            app.routes[path] = r\n\n        # provide default index route\n        unless app.routes.index\n            app.routes.index = new app.Route 'get \/', {}\n\n        # emit ready signal\n        app.onReady.emit()\n\n        app\n","old_contents":"# App\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    signal = require 'src\/signal'\n    db = require 'src\/db'\n    assert = require 'src\/assert'\n    Schema = require 'src\/schema'\n    Networking = require 'src\/networking'\n    Document = require 'src\/document'\n    Renderer = require 'src\/renderer'\n    Styles = require 'src\/styles'\n    Resources = require 'src\/resources'\n    Dict = require 'src\/dict'\n\n    AppRoute = require '.\/route'\n\n    if utils.isNode\n        bootstrapRoute = require '.\/bootstrap\/route.node'\n\n    `\/\/<development>`\n    pkg = require 'package.json'\n    `\/\/<\/development>`\n\n    BASE_FILE_NAME_RE = \/(.+)\\.(?:node|server|client|browser|ios|android|native)\/\n    DEFAULT_CONFIG =\n        title: 'Neft.io Application'\n        protocol: 'http'\n        port: 3000\n        host: 'localhost'\n        language: 'en'\n        type: 'app'\n\n    exports = module.exports = (opts = {}, extraOpts = {}) ->\n        # Welcome log also for release mode\n        log.ok \"Welcome! Neft.io v#{pkg.version}; Feedback appreciated\"\n\n        `\/\/<development>`\n        log.warn \"Use this bundle only in development; type --release when it's ready\"\n        `\/\/<\/development>`\n\n        config = utils.merge utils.clone(DEFAULT_CONFIG), opts.config\n\n        if extraOpts?\n            utils.merge config, extraOpts\n\n# *Dict* app\n\n        app = new Dict\n\n## *Object* app.config = `{}`\n\nConfig object from the *package.json* file.\n\nCan be overriden in the *init.js* file.\n\n### type\n\nThe `app` type (the default one) uses renderer on the client side.\n\nThe `game` type uses special renderer (if exists) focused on more performance goals.\n\nThe `text` type always return HTML document with no renderer on the client side.\nIt's used for the crawlers (e.g. GoogleBot) or browsers with no javascript support.\n\n```javascript\n\/\/ package.json\n{\n    \"name\": \"neft.io app\",\n    \"version\": \"0.1.0\",\n    \"config\": {\n        \"title\": \"My first application!\",\n        \"protocol\": \"http\",\n        \"port\": 3000,\n        \"host\": \"localhost\",\n        \"language\": \"en\",\n        \"type\": \"app\"\n    }\n}\n\/\/ init.js\nmodule.exports = function(NeftApp) {\n    var app = NeftApp({ title: \"Overridden title\" });\n    console.log(app.config);\n    \/\/ {title: \"My first application!\", protocol: \"http\", port: ....}\n};\n```\n\n        app.config = config\n\n## *Networking* app.networking\n\nStandard Networking instance used to communicate\nwith the server and to create local requests.\n\nAll routes created by the *App.Route* uses this networking.\n\nHTTP protocol is used by default with the data specified in the *package.json*.\n\n        app.networking = new Networking\n            type: Networking.HTTP\n            protocol: config.protocol\n            port: parseInt(config.port, 10)\n            host: config.host\n            url: config.url\n            language: config.language\n\n## *Object* app.models = `{}`\n\nFiles from the *models* folder with objects returned by their exported functions.\n\n```javascript\n\/\/ models\/user\/permission.js\nmodule.exports = function(app) {\n    return {\n        getPermission: function(id){}\n    };\n};\n\/\/ controllers\/user.js\nmodule.exports = function(app) {\n    return {\n        get: function(req, res, callback) {\n            var data = app.models['user\/permission'].getPermission(req.params.userId);\n            callback(null, data);\n        }\n    }\n};\n```\n\n        app.models = {}\n\n## *Object* app.routes = `{}`\n\nFiles from the *routes* folder with objects returned by their exported functions.\n\n        app.routes = {}\n\n## *Object* app.styles = `{}`\n\nFiles from the *styles* folder as *Function*s\nready to create new *Item*s.\n\n        app.styles = {}\n\n## *Object* app.views = `{}`\n\nFiles from the *views* folder as the *Document* instances.\n\n        app.views = {}\n\n## *Resources* app.resources\n\n        app.resources = do ->\n            if opts.resources\n                Resources.fromJSON(opts.resources)\n            else\n                new Resources\n\n## *Signal* app.onReady()\n\nCalled when all modules, views, styled etc. have been loaded.\n\n        signal.create app, 'onReady'\n\n        # config.type\n        config.type ?= 'app'\n        assert.ok utils.has(['app', 'game', 'text'], config.type), \"Unexpected app.config.type value. Accepted app\/game\/text, but '#{config.type}' got.\"\n\n        app.Route = AppRoute app\n\n## *Dict* app.cookies\n\nOn the client side, this object refers to the last received cookies\nfrom the networking request.\n\nOn the server side, this cookies object are added into the each networking response.\n\nBy default, client has *clientId* and *sessionId* hashes.\n\n```javascript\napp.cookies.onChange(function(key){\n    console.log('cookie changed', key, this[key]);\n});\n```\n\n```xml\n<h1>Your clientId<\/h1>\n<em>${root.app.cookies.clientId}<\/em>\n```\n\n        # cookies\n        COOKIES_KEY = '__neft_cookies'\n        app.cookies = null\n        onCookiesReady = (dict) ->\n            app.cookies = dict\n            if utils.isClient\n                dict.set 'sessionId', utils.uid(16)\n        db.get COOKIES_KEY, db.OBSERVABLE, (err, dict) ->\n            if dict\n                onCookiesReady dict\n            else\n                if utils.isClient\n                    cookies = {clientId: utils.uid(16)}\n                else\n                    cookies = {}\n                db.set COOKIES_KEY, cookies, (err) ->\n                    db.get COOKIES_KEY, db.OBSERVABLE, (err, dict) ->\n                        onCookiesReady dict\n        app.networking.onRequest (req, res) ->\n            if utils.isClient\n                utils.merge req.cookies, app.cookies\n            else\n                utils.merge res.cookies, app.cookies\n            req.onLoadEnd.listeners.unshift ->\n                if utils.isClient\n                    for key, val of res.cookies\n                        unless utils.isEqual(app.cookies[key], val)\n                            app.cookies.set key, val\n                return\n            , null\n            return\n\n        # propagate data\n        Renderer.resources = app.resources\n        Renderer.serverUrl = app.networking.url\n        Document.Scripts.scripts = utils.arrayToObject opts.scripts,\n            (index, elem) -> elem.name,\n            (index, elem) -> elem.file\n\n        # set styles window item\n        if opts.styles?\n            for style in opts.styles\n                if style.name in ['view', '__view__']\n                    style.file._init app: app, view: null\n                    windowStyle = style.file._main.getComponent()\n                    break\n\n        windowStyleItem = windowStyle?.item or new Renderer.Item\n        Renderer.window = windowStyleItem\n\n        if opts.styles?\n            stylesInitObject =\n                app: app\n                view: windowStyleItem\n\n            # initialize styles\n            for style in opts.styles when style.name?\n                if style.name isnt 'view'\n                    style.file._init stylesInitObject\n                app.styles[style.name] = style.file\n\n        # load styles\n        Styles\n            windowStyle: windowStyle\n            styles: app.styles\n            queries: opts.styleQueries\n            resources: app.resources\n\n        # load bootstrap\n        if utils.isNode\n            bootstrapRoute app\n\n        # loading files helper\n        init = (files, target) ->\n            for file in files when file.name?\n                if typeof file.file isnt 'function'\n                    continue\n\n                fileObj = file.file app\n                target[file.name] = fileObj\n\n                if baseNameMatch = BASE_FILE_NAME_RE.exec(file.name)\n                    [_, baseName] = baseNameMatch\n                    if target[baseName]?\n                        if utils.isPlainObject(target[baseName]) and utils.isPlainObject(fileObj)\n                            fileObj = utils.merge Object.create(target[baseName]), fileObj\n                    target[baseName] = fileObj\n\n            return\n\n        # load document extensions\n        if utils.isObject(opts.extensions)\n            for ext in opts.extensions\n                ext app: app\n\n        # exports app classes\n        exports.app =\n            Route: app.Route\n\n        # load views\n        for view in opts.views when view.name?\n            app.views[view.name] = Document.fromJSON view.file\n\n        # load files\n        init opts.models, app.models\n        init opts.routes, app.routes\n\n        for path, obj of app.routes\n            r = {}\n            if utils.isObject(obj) and not (obj instanceof app.Route)\n                for method, opts of obj\n                    if utils.isObject(opts)\n                        route = new app.Route method, opts\n                        r[route.name] = route\n                    else\n                        r[method] = opts\n            app.routes[path] = r\n\n        # emit ready signal\n        app.onReady.emit()\n\n        app\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"6b15da02d7363385a59c175fa24c78e4306fdc70","subject":"Use @warn instead of Madul.FIRE directly","message":"Use @warn instead of Madul.FIRE directly\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    Array.prototype.last = -> this[this.length - 1]\n\n    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n\n    code_root = process.env.MADUL_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n\n    WRAPPED = { }\n\n    _INITIALIZERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push method\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'listen'\n          'fire'\n          'warn'\n          'report'\n          'do_wrap'\n          'wrap_methods'\n          'strip'\n          'make_available'\n          'hydrate'\n          'finish_up'\n          'initialize'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      listen: (event, callback) => Madul.LISTEN \"*.#{@clazz}.#{event}\", callback\n\n      fire: (event, args) => Madul.FIRE \"@.#{@clazz}.#{event}\", args\n\n      warn: (event, details) => Madul.FIRE \"!.#{@clazz}.#{event}\", details\n\n      report: (method, state, id, args) =>\n        @fire \"#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      do_wrap: (method) =>\n        callMe = @[method]\n\n        Madul.FIRE \"$.#{@clazz}.#{method}.wrap\"\n\n        @[\"_#{method}\"] = @[method]\n\n        respond = (id, deferred) =>\n          (state, data) =>\n            process.nextTick =>\n              deferred[state] data\n\n              @report method, state, id, data\n\n        WRAPPED[@clazz].push method\n\n        @[method] = =>\n          id   = uuid.v4fast()\n          def  = q.defer()\n          args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n          res  = respond id, def\n\n          args.push (out) => res 'resolve', out\n          args.push (err) => res 'reject',  err\n          args.push (out) => res 'notify',  out\n\n          @report method, 'invoke', id, args\n\n          @[\"_#{method}\"].apply @, args\n\n          def.promise\n\n      wrap_methods: =>\n        props = Object.keys @constructor.prototype\n\n        for prop in props\n          if prop[0] != '_'                      &&\n             typeof @[prop] == 'function'        &&\n             typeof @[\"_#{prop}\"] == 'undefined' &&\n             WRAP(@clazz, prop) == true\n\n            @do_wrap prop\n\n            INITIALIZERS @clazz, prop if prop[0] == '$'\n\n      strip: (name) => name.toLowerCase().replace \/\\W+\/g, ''\n\n      make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[@strip name] = mod\n\n      hydrate: (deps, done) =>\n        load = (name, path, loaded) =>\n          mod = require path\n\n          if typeof mod == 'function'\n            new mod name\n              .initialize @ctor_params?[name]\n              .then (mod) =>\n                @make_available name, mod\n                loaded()\n          else\n            @make_available name, mod\n            loaded()\n\n        check = (path, dep, finished) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              @warn 'file-not-found', err\n\n              done type: 'ERROR', info: err\n            else\n              async.each files, (f, next) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.stat depth, (e, s) =>\n                  if s.isDirectory() && f[0] != '.'\n                    check depth, dep, next\n                  else if s.isFile() && f.substring(0, f.length - 3) == dep\n                    load f.substring(0, f.length - 3), depth, => do_add dep, next\n                  else\n                    next()\n              , finished\n\n        add_dependency = (name, mod) =>\n          Madul.FIRE \"$.#{@clazz}.dependency.register\", name\n          @[underscore name] = mod\n\n        do_add = (name, next) =>\n          add_dependency name, available[@strip name]\n          next()\n\n        add = (name, resource, next) =>\n          @make_available name, require resource\n          do_add name, next\n\n        async.each deps, (d, next) =>\n          if @[underscore d]? == false\n            if available[@strip d]? == true\n              do_add d, next\n            else\n              try\n                add d, d, next\n              catch e\n                cwd = process.cwd()\n                pkg = \"#{cwd}\/node_modules\/#{d}\/package.json\"\n\n                fs.stat pkg, (err, stat) =>\n                  if stat?.isFile()\n                    fs.readFile pkg, 'utf8', (err, data) =>\n                      json = JSON.parse data\n                      main = json.main || json._main || 'index.js'\n\n                      add d, \"#{cwd}\/node_modules\/#{d}\/#{main}\", next\n                  else\n                    check \"#{cwd}\/#{code_root}\", d, next\n          else\n            next()\n        , done\n\n      finish_up: (resolve, args) =>\n        async.each _INITIALIZERS[@clazz], (initializer, next) =>\n          @[initializer] args\n            .then next\n        , =>\n          @make_available @clazz, @\n          resolve @\n          Madul.FIRE \"$.#{@clazz}.initialized\"\n\n      initialize: =>\n        deferred = q.defer()\n        args     = if arguments[0]? then Array.prototype.slice.call arguments else undefined\n\n        @clazz = @constructor.name unless @clazz?\n\n        Madul.FIRE \"$.#{@clazz}.request_instance\", args\n\n        if initialized[@clazz] != true\n          Madul.FIRE \"$.#{@clazz}.initialize\", args\n\n          initialized[@clazz] = true\n\n          @wrap_methods()\n\n          if @deps?\n            @hydrate @deps, => @finish_up deferred.resolve, args\n          else\n            @finish_up deferred.resolve, args\n        else\n          process.nextTick => deferred.resolve available[@strip @clazz]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    Array.prototype.last = -> this[this.length - 1]\n\n    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n\n    code_root = process.env.MADUL_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n\n    WRAPPED = { }\n\n    _INITIALIZERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push method\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'listen'\n          'fire'\n          'warn'\n          'report'\n          'do_wrap'\n          'wrap_methods'\n          'strip'\n          'make_available'\n          'hydrate'\n          'finish_up'\n          'initialize'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      listen: (event, callback) => Madul.LISTEN \"*.#{@clazz}.#{event}\", callback\n\n      fire: (event, args) => Madul.FIRE \"@.#{@clazz}.#{event}\", args\n\n      warn: (event, details) => Madul.FIRE \"!.#{@clazz}.#{event}\", details\n\n      report: (method, state, id, args) =>\n        @fire \"#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      do_wrap: (method) =>\n        callMe = @[method]\n\n        Madul.FIRE \"$.#{@clazz}.#{method}.wrap\"\n\n        @[\"_#{method}\"] = @[method]\n\n        respond = (id, deferred) =>\n          (state, data) =>\n            process.nextTick =>\n              deferred[state] data\n\n              @report method, state, id, data\n\n        WRAPPED[@clazz].push method\n\n        @[method] = =>\n          id   = uuid.v4fast()\n          def  = q.defer()\n          args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n          res  = respond id, def\n\n          args.push (out) => res 'resolve', out\n          args.push (err) => res 'reject',  err\n          args.push (out) => res 'notify',  out\n\n          @report method, 'invoke', id, args\n\n          @[\"_#{method}\"].apply @, args\n\n          def.promise\n\n      wrap_methods: =>\n        props = Object.keys @constructor.prototype\n\n        for prop in props\n          if prop[0] != '_'                      &&\n             typeof @[prop] == 'function'        &&\n             typeof @[\"_#{prop}\"] == 'undefined' &&\n             WRAP(@clazz, prop) == true\n\n            @do_wrap prop\n\n            INITIALIZERS @clazz, prop if prop[0] == '$'\n\n      strip: (name) => name.toLowerCase().replace \/\\W+\/g, ''\n\n      make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[@strip name] = mod\n\n      hydrate: (deps, done) =>\n        load = (name, path, loaded) =>\n          mod = require path\n\n          if typeof mod == 'function'\n            new mod name\n              .initialize @ctor_params?[name]\n              .then (mod) =>\n                @make_available name, mod\n                loaded()\n          else\n            @make_available name, mod\n            loaded()\n\n        check = (path, dep, finished) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              Madul.FIRE '$.error', err\n\n              done type: 'ERROR', info: err\n            else\n              async.each files, (f, next) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.stat depth, (e, s) =>\n                  if s.isDirectory() && f[0] != '.'\n                    check depth, dep, next\n                  else if s.isFile() && f.substring(0, f.length - 3) == dep\n                    load f.substring(0, f.length - 3), depth, => do_add dep, next\n                  else\n                    next()\n              , finished\n\n        add_dependency = (name, mod) =>\n          Madul.FIRE \"$.#{@clazz}.dependency.register\", name\n          @[underscore name] = mod\n\n        do_add = (name, next) =>\n          add_dependency name, available[@strip name]\n          next()\n\n        add = (name, resource, next) =>\n          @make_available name, require resource\n          do_add name, next\n\n        async.each deps, (d, next) =>\n          if @[underscore d]? == false\n            if available[@strip d]? == true\n              do_add d, next\n            else\n              try\n                add d, d, next\n              catch e\n                cwd = process.cwd()\n                pkg = \"#{cwd}\/node_modules\/#{d}\/package.json\"\n\n                fs.stat pkg, (err, stat) =>\n                  if stat?.isFile()\n                    fs.readFile pkg, 'utf8', (err, data) =>\n                      json = JSON.parse data\n                      main = json.main || json._main || 'index.js'\n\n                      add d, \"#{cwd}\/node_modules\/#{d}\/#{main}\", next\n                  else\n                    check \"#{cwd}\/#{code_root}\", d, next\n          else\n            next()\n        , done\n\n      finish_up: (resolve, args) =>\n        async.each _INITIALIZERS[@clazz], (initializer, next) =>\n          @[initializer] args\n            .then next\n        , =>\n          @make_available @clazz, @\n          resolve @\n          Madul.FIRE \"$.#{@clazz}.initialized\"\n\n      initialize: =>\n        deferred = q.defer()\n        args     = if arguments[0]? then Array.prototype.slice.call arguments else undefined\n\n        @clazz = @constructor.name unless @clazz?\n\n        Madul.FIRE \"$.#{@clazz}.request_instance\", args\n\n        if initialized[@clazz] != true\n          Madul.FIRE \"$.#{@clazz}.initialize\", args\n\n          initialized[@clazz] = true\n\n          @wrap_methods()\n\n          if @deps?\n            @hydrate @deps, => @finish_up deferred.resolve, args\n          else\n            @finish_up deferred.resolve, args\n        else\n          process.nextTick => deferred.resolve available[@strip @clazz]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5b2ec5791652edb3e16dbd7aa19dda8cf1f2e257","subject":"add docs for App.resources","message":"add docs for App.resources\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08_app.litcoffee","new_file":"docs\/08_app.litcoffee","new_contents":"# Batman.App\n\n`Batman.App` is the central object in any Batman application. It manages the routing table and the current URL parameters, as well as the initial start of the application. It should also be used as a namespace for models and views so that other objects can find them. Batman assumes that there will only ever be one `Batman.App` in use at once.\n\n## Batman.currentApp\n\nA Batman-wide reference to the currently running `Batman.App`.\n\n## @run() : App\n\n`App.run` is the central entry point for a Batman application. `@run` takes these steps to initialize a Batman application:\n\n 1. Instantiate a `Dispatcher`, an internal object for mananging action dispatch to controllers.\n 2. Instantiate a `Navigator`, an internal object for managing the URL via pushState or hashbangs.\n 3. Instantiate the `layout` view according to the `layout` property on the `App`.\n 4. Wait for the layout view to fire it's `ready` event.\n 5. Start the first action dispatch by telling the `Navigator` to begin monitoring the URL.\n\n_Note_: `@run` emits the `run` class event on the `App`, but not necessarily as soon as `@run` is called. Because the `layout` View renders asynchronously and may need to fetch other components, the `run` event can and often does fire long after `@run` is called. If you need to execute code as soon as the `App` has started running, add a listener to the `run` event on the `App` class. If you need to execute code as soon as the layout has rendered, you can use the `ready` event on the `App` class.\n\n`@run` can be called before or on the `load` DOMEvent of the window. `@run` will return the App if the commencement was successful and complete, or `false` if the App must wait for the `layout` to render or if the `App` has already run.\n\n#### starting an application with DOMEvents\n```coffeescript\nwindow.addEventListener 'load', ->\n  MyApp.run()\n```\n\n#### starting an application with jQuery\n```coffeescript\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\n`@stop` stops the `App` it's called upon. The URL will stop being monitored and no more actions will be dispatched. In usual Batman development you shouldn't have to call this.\n\n## @routes\n\n`@routes` is a class level property referencing the root level `NamedRouteQuery` which allows for binding to routes on objects. See `data-route` bindings for more information.\n\n## @controllers\n\n`@controllers` is a class level property containing the singleton `Batman.Controller` instances for each subclass in the application. This `controllers` directory puts these instances at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`. `@controllers` ideally should never be bound to, but it is very useful for debugging in the console and other such workarounds.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n    test \"Multi-word controller names have a lowercase first letter\", ->\n      class Alfred extends Batman.App\n      class Alfred.ReminderEmailsController extends Batman.Controller\n      controller = Alfred.get('controllers.reminderEmails')\n      equal Batman._functionName(controller.constructor), \"ReminderEmailsController\"\n\n## @layout\n\n`@layout` is the base view of the entire view hierarchy. By default, it will parse any data-* attributes in the entire document, excluding any `data-yield`'s, when `App.run()` is called. Use `MyApp.layout = null` to disable the creation of this default view.\n\n## @currentParams\n\n`@currentParams` contains the URL parameters for the current request, including the path relative to the app's base path (`Batman.config.pathToApp`). Some interesting parts to look at: `@currentParams.controller`, `@currentParams.action`.\n\n## @paramsManager\n## @paramsPusher\n\n## 'run' class event\n\nThe `run` class event is fired once the app has run. This indeterminately but often happens before the app's layout has finished rendering.\n\n## 'ready' class event\n\nThe `ready` class event is fired once the app's layout is rendered.\n\n# Batman.App Routing\n\nThe `Batman` routing DSL is similar to Rails 3's routing DSL. It is oriented around the notion of a resource:\n\n## @route\n\n`@route` defines a custom route and can be pointed to a controller action directly. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @route 'comments', 'pages#comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/comments` being added to the routing map, pointed to `PagesController#comments`.\n\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n`@resources` is modeled after the Rails routing `resources` method. It automatically defines some routes (and matches them to controller actions) for you. For example,\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages'\n\nclass App.PagesController extends Batman.Controller\n  index: ->\n    # ...\n  new: ->\n    # ...\n  show: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n  edit: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n```\n\nWill set up these routes:\n\nPath | Controller Action | View binding\n-- | -- | -- |\n\/pages | App.PagesController#index | `data-route=\"routes.pages\"`\n\/pages\/new | App.PagesController#new | `data-route=\"routes.pages.new\"`\n\/pages\/:id | App.PagesController#show | `data-route=\"routes.pages[currentPage]\"`\n\/pages\/:id\/edit | App.PagesController#edit | `data-route=\"routes.pages[currentPage].edit\"`\n\nOf course, `destroy`, `update`, and `create` are not performed by controller actions in Batman. Instead, call `save` or `destroy` on your records.\n\n### Nested Resources\n\nYou may also nest resources, as in Rails:\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages', ->\n    @resources 'comments'\n```\n\nWill set up these routes for `App.Comment`:\n\nPath | Controller Action | View binding\n-- | -- | -- |\n\/pages\/:page_id\/comments | App.CommentsController#index | `data-route=\"routes.pages[currentPage].comments\"`\n\/pages\/:page_id\/comments\/new | App.CommentsController#new | `data-route=\"routes.pages[currentPage].comments.new\"`\n\/pages\/:page_id\/comments\/:id | App.CommentsController#show | `data-route=\"routes.pages[currentPage].comments[currentComment]\"`\n\/pages\/:page_id\/comments\/:id\/edit | App.CommentsController#edit | `data-route=\"routes.pages[currentPage].comments[currentComment].edit\"`\n\n\n## @member\n\n`@member` defines a routable action you can call on a specific instance of a member of a collection resource. For example, if you have a collection of `Page` resources, and a user can post a comment on a specific page:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @member 'comment'\n\nclass Example.PagesController extends Batman.Controller\n  comment: (params) ->\n```\n\nWould result in `\/pages\/:id\/comment` being added to the routing map, pointed to `PagesController#comment`.\n\n## @collection\n\n`@collection` is similar to `@member` in that it adds routable actions to a `@resources` set of routes. In this case the action would apply to the entire collection. For example, if you have a list of spam comments made across _all_ your `Page` resources:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @collection 'spam_comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/pages\/spam_comments` being added to the routing map, pointed to `PagesController#spam_comments`.\n\n## @root\n\n`@root` defines the root controller and action to be used when visiting the base application URL. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @root 'pages#index'\n\nclass Example.PagesController extends Batman.Controller\n  index: ->\n```\n\nWould result in `\/` being pointed to `PagesController#index`.","old_contents":"# Batman.App\n\n`Batman.App` is the central object in any Batman application. It manages the routing table and the current URL parameters, as well as the initial start of the application. It should also be used as a namespace for models and views so that other objects can find them. Batman assumes that there will only ever be one `Batman.App` in use at once.\n\n## Batman.currentApp\n\nA Batman-wide reference to the currently running `Batman.App`.\n\n## @run() : App\n\n`App.run` is the central entry point for a Batman application. `@run` takes these steps to initialize a Batman application:\n\n 1. Instantiate a `Dispatcher`, an internal object for mananging action dispatch to controllers.\n 2. Instantiate a `Navigator`, an internal object for managing the URL via pushState or hashbangs.\n 3. Instantiate the `layout` view according to the `layout` property on the `App`.\n 4. Wait for the layout view to fire it's `ready` event.\n 5. Start the first action dispatch by telling the `Navigator` to begin monitoring the URL.\n\n_Note_: `@run` emits the `run` class event on the `App`, but not necessarily as soon as `@run` is called. Because the `layout` View renders asynchronously and may need to fetch other components, the `run` event can and often does fire long after `@run` is called. If you need to execute code as soon as the `App` has started running, add a listener to the `run` event on the `App` class. If you need to execute code as soon as the layout has rendered, you can use the `ready` event on the `App` class.\n\n`@run` can be called before or on the `load` DOMEvent of the window. `@run` will return the App if the commencement was successful and complete, or `false` if the App must wait for the `layout` to render or if the `App` has already run.\n\n#### starting an application with DOMEvents\n```coffeescript\nwindow.addEventListener 'load', ->\n  MyApp.run()\n```\n\n#### starting an application with jQuery\n```coffeescript\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\n`@stop` stops the `App` it's called upon. The URL will stop being monitored and no more actions will be dispatched. In usual Batman development you shouldn't have to call this.\n\n## @routes\n\n`@routes` is a class level property referencing the root level `NamedRouteQuery` which allows for binding to routes on objects. See `data-route` bindings for more information.\n\n## @controllers\n\n`@controllers` is a class level property containing the singleton `Batman.Controller` instances for each subclass in the application. This `controllers` directory puts these instances at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`. `@controllers` ideally should never be bound to, but it is very useful for debugging in the console and other such workarounds.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n    test \"Multi-word controller names have a lowercase first letter\", ->\n      class Alfred extends Batman.App\n      class Alfred.ReminderEmailsController extends Batman.Controller\n      controller = Alfred.get('controllers.reminderEmails')\n      equal Batman._functionName(controller.constructor), \"ReminderEmailsController\"\n\n## @layout\n\n`@layout` is the base view of the entire view hierarchy. By default, it will parse any data-* attributes in the entire document, excluding any `data-yield`'s, when `App.run()` is called. Use `MyApp.layout = null` to disable the creation of this default view.\n\n## @currentParams\n\n`@currentParams` contains the URL parameters for the current request, including the path relative to the app's base path (`Batman.config.pathToApp`). Some interesting parts to look at: `@currentParams.controller`, `@currentParams.action`.\n\n## @paramsManager\n## @paramsPusher\n\n## 'run' class event\n\nThe `run` class event is fired once the app has run. This indeterminately but often happens before the app's layout has finished rendering.\n\n## 'ready' class event\n\nThe `ready` class event is fired once the app's layout is rendered.\n\n# Batman.App Routing\n\nThe `Batman` routing DSL is similar to Rails 3's routing DSL. It is oriented around the notion of a resource:\n\n## @route\n\n`@route` defines a custom route and can be pointed to a controller action directly. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @route 'comments', 'pages#comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/comments` being added to the routing map, pointed to `PagesController#comments`.\n\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n## @member\n\n`@member` defines a routable action you can call on a specific instance of a member of a collection resource. For example, if you have a collection of `Page` resources, and a user can post a comment on a specific page:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @member 'comment'\n\nclass Example.PagesController extends Batman.Controller\n  comment: (params) ->\n```\n\nWould result in `\/pages\/:id\/comment` being added to the routing map, pointed to `PagesController#comment`.\n\n## @collection\n\n`@collection` is similar to `@member` in that it adds routable actions to a `@resources` set of routes. In this case the action would apply to the entire collection. For example, if you have a list of spam comments made across _all_ your `Page` resources:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @collection 'spam_comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/pages\/spam_comments` being added to the routing map, pointed to `PagesController#spam_comments`.\n\n## @root\n\n`@root` defines the root controller and action to be used when visiting the base application URL. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @root 'pages#index'\n\nclass Example.PagesController extends Batman.Controller\n  index: ->\n```\n\nWould result in `\/` being pointed to `PagesController#index`.","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b84c3eadc808d23d93099eab6bdfc4d78eb53de0","subject":"proceed only for valid event","message":"proceed only for valid event\n","repos":"nhz-io\/cnl","old_file":"source\/element.litcoffee","new_file":"source\/element.litcoffee","new_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\nA visual element. Manages **mousemove**, **mousedown** and **mouseup** events.\nManages **regions** and **local event coordinates**.\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element(args)\n\nCreates an Element instance.\n\n      constructor: ->\n        super\n\nCopy the element origin if it was set from named arguments\n\n        if @origin then @origin = x:(@origin.x or 0), y:(@origin.y or 0)\n\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nAdd capturing extendable listener\n\n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n\n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args**\n    * Type: [Object][Object] - named arguments\n\n* **args.origin**\n    * Type: [Object][Object] - origin coordinates\n\n* **args.origin.x**\n    * Type: [Number][Number] - x coordinate\n\n* **args.origin.y**\n    * Type: [Number][Number] - y coordinate\n\n* **args.regions** - named regions\n    * Type: [Object][Object]\n\n* **args.regions.{NAME}**\n    * Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## PROPERTIES\n\n### #origin\n* Type: [Object][Object] - origin coordinates\n* **x**\n  * Type: [Number][Number] - x coordinate\n* **y**\n  * Type: [Number][Number] - y coordinate\n\n---\n\n## METHODS\n### #localizeEventCoordinates(event) ->\n* Returns: [Element][Element]\n\nHelper method, to localize event coordinates.\n\n      localizeEventCoordinates: (event) ->\n\nProceed only for valid event\n\n        if event\n\nIf event already has localized **x**, use it instead of absolute **x**\n\n          x = (if event.localX? then event.localX else event.x)\n          event.localX = x - (@origin?.x or 0)\n\nIf event already has localized **y**, use it instead of absolute **y**\n\n          y = (if event.localY? then event.localY else event.y)\n          event.localY = y - (@origin?.y or 0)\n\n        return this\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousemove** listener\n\n      mousemoveCaptureListener: (event) ->\n\nProceed only for valid event\n\n        if event\n\nStore the event in the runtime for later and localize event coordinates\n\n          @___runtime.mousemoveEvent = event\n          @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousedown** listener\n\n      mousedownCaptureListener: (event) ->\n\nProceed only for valid event\n\n        if event\n\nStore the event in the runtime for later and localize event coordinates\n\n          @___runtime.mousedownEvent = event\n          @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mouseup** listener\n\n      mouseupCaptureListener: (event) ->\n\nProceed only for valid event\n\n        if event\n\nStore the event in the runtime for later and localize event coordinates\n\n          @___runtime.mouseupEvent = event\n          @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousemoveListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousemoveListener: -> this\n\n---\n\n### #mousedownListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousedownListener: -> this\n\n---\n\n### #mouseupListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mouseupListener: -> this\n\n[Element]: .\/element\n\n[Parent]: .\/index.litcoffee\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n[Number]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Number\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[Array]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Array\n","old_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\nA visual element. Manages **mousemove**, **mousedown** and **mouseup** events.\nManages **regions** and **local event coordinates**.\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element(args)\n\nCreates an Element instance.\n\n      constructor: ->\n        super\n\nCopy the element origin if it was set from named arguments\n\n        if @origin then @origin = x:(@origin.x or 0), y:(@origin.y or 0)\n\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nAdd capturing extendable listener\n\n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n\n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args**\n    * Type: [Object][Object] - named arguments\n\n* **args.origin**\n    * Type: [Object][Object] - origin coordinates\n\n* **args.origin.x**\n    * Type: [Number][Number] - x coordinate\n\n* **args.origin.y**\n    * Type: [Number][Number] - y coordinate\n\n* **args.regions** - named regions\n    * Type: [Object][Object]\n\n* **args.regions.{NAME}**\n    * Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## PROPERTIES\n\n### #origin\n* Type: [Object][Object] - origin coordinates\n* **x**\n  * Type: [Number][Number] - x coordinate\n* **y**\n  * Type: [Number][Number] - y coordinate\n\n---\n\n## METHODS\n### #localizeEventCoordinates(event) ->\n* Returns: [Element][Element]\n\nHelper method, to localize event coordinates.\n\n      localizeEventCoordinates: (event) ->\n        if event\n\nIf event already has localized **x**, use it instead of absolute **x**\n\n          x = (if event.localX? then event.localX else event.x)\n          event.localX = x - (@origin?.x or 0)\n\nIf event already has localized **y**, use it instead of absolute **y**\n\n          y = (if event.localY? then event.localY else event.y)\n          event.localY = y - (@origin?.y or 0)\n\n        return this\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousemove** listener\n\n      mousemoveCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousemoveEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousedown** listener\n\n      mousedownCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousedownEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mouseup** listener\n\n      mouseupCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mouseupEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousemoveListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousemoveListener: -> this\n\n---\n\n### #mousedownListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mousedownListener: -> this\n\n---\n\n### #mouseupListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n\n      mouseupListener: -> this\n\n[Element]: .\/element\n\n[Parent]: .\/index.litcoffee\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n[Number]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Number\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[Array]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Array\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6584c69a90c5dfbfe3ec7897630d7ba738583f99","subject":"more tweaks for correctness and documentedness","message":"more tweaks for correctness and documentedness\n","repos":"bchociej\/platform-ng","old_file":"config-defaults.litcoffee","new_file":"config-defaults.litcoffee","new_contents":"*This is [Literate Coffeescript](http:\/\/coffeescript.org\/#literate): code interleaved with Markdown\ncomments. The Coffeescript compiler will strip the Markdown and compile it like any other file.*\n\n## platform-ng config defaults\n\nThis file defines the default configuration options for platform-ng and explains\nhow can modify the configuration to suit your needs.\n\nWhen you call `Platform#config()` with your configuration object, this configuration is deep-extended with\nyours to produce the working configuration.\n\n### General application configuration\n\nWhat's the app called (`name`), and what environment is it running in (`env`)? For `env`, anything other\nthan the string `'production'` is automatically considered `'development'` for debuggability.\n\n\tmodule.exports =\n\t\tapp:\n\t\t\tname: 'unnamed-app'\n\t\t\tenv: 'development'\n\n#### Sessions\n\nFor sessions, you can choose to entirely disable them by setting `enabled` to `false`. Otherwise, your\nchoices for `type` are currently `cookie` or `vanilla`.\n\nThe `cookie` type stores all session data in a garbled (not encrypted) client-side cookie, signed using\nthe `secret`.\n\nThe `vanilla` type stores the session in a server-side session store and only transmits a signed session\nID to the client.\n\n`cookie` is default for now, but `vanilla` will replace it in the next major version. The `secure` option\ndetermines whether the cookies are HTTPS-only or not.\n\n\t\t\tsession:\n\t\t\t\tenabled: true\n\t\t\t\ttype: 'cookie'\n\t\t\t\tsecret: 'change-me'\n\t\t\t\tsecure: false\n\n#### Cookie parser\n\nThe cookie parser transforms the `cookie` header into `request.cookies`, `request.signedCookies`, and\n`request.secureCookies` objects. You still have to use `response.cookie(...)` and\/or \n`response.clearCookie(...)` to actually manipulate cookies. The `secret` defined here will be used to\nverify signed cookies, and, if you set `{signed: true}` in the third argument to `response.cookie(...)`,\nthis `secret` will be used to sign the outbound cookies too.\n\n\t\t\tcookies:\n\t\t\t\tenabled: true\n\t\t\t\tsecret: 'change-me'\n\n### HTTP server configuration\n\nThe `server` sections deals with how platform-ng handles the exchange, parsing, and encoding of HTTP\nrequests and responses.\n\n\t\tserver:\n\t\t\t# Use automatic gzip compression for responses?\n\t\t\tcompress: true\n\n\t\t\t# TCP port to listen on (overriden by PORT environment variable)\n\t\t\tport: 8001\n\n\t\t\t# Is the app behind a proxy? If so, replace request.ip with X-Forwarded-For, and trust\n\t\t\t# all cookies for HTTPS-only mode.\n\t\t\tbehind_proxy: false\n\n\t\t\t# Enable\/disable various body parsers, for performance and security reasons\n\t\t\tparsers:\n\t\t\t\turlencoded: true\n\t\t\t\tjson: true\n\t\t\t\tmultipart: false # potential security problem; read http:\/\/goo.gl\/N4Bci1\n\n\t\t\t# Allow requests to change HTTP verb using 'X-HTTP-Method-Override' header?\n\t\t\tmethod_override: false\n\n### Language configuration\n\nThis section controls which protolanguages platform-ng will compile, as well as language-specific options\nfor some of the languages. (The NPM dependencies for these languages are listed in `package.json` as\n`optionalDependencies` and can be skipped entirely by calling `npm install --no-optional`.)\n\n\t\tlanguages:\n\t\t\tcoffeescript:\n\t\t\t\tenabled: true\n\n\t\t\tstylus:\n\t\t\t\tenabled: true\n\t\t\t\tinclude_css: true\t# Whether to inline @include()'d CSS files\n\t\t\t\tnib: true\t\t\t# Whether to automatically load the nib library\n\n### Compilation\n\n`compile` controls generic compilation options for all language compilers. The `minify` option will\ncause the compiler to munge the output in order to produce the smallest possible code. The `expose_sources`\noption will cause the server to serve the original files (e.g. .coffee, .styl, etc) if requested, AND it\nwill ask the compiler to generate source maps, if supported.\n\nCompilation results are stored in and served from the `.serve\/` directory, created and updated at runtime.\n\n\t\tcompile:\n\t\t\tminify: true\n\t\t\texpose_sources: true \n\n### Express configuration\n\nplatform-ng is powered by Express. You can directly configure Express settings here. The settings are\ndocumented on [this page](http:\/\/expressjs.com\/3x\/api.html#app-settings).\n\n\t\texpress:\n\t\t\t'view engine': 'jade'","old_contents":"*This is [Literate Coffeescript](http:\/\/coffeescript.org\/#literate): code interleaved with Markdown\ncomments. The Coffeescript compiler will strip the Markdown and compile it like any other file.*\n\n## platform-ng config defaults\n\nThis file defines the default configuration options for platform-ng and explains\nhow can modify the configuration to suit your needs.\n\nWhen you call `Platform#config()` with your configuration object, this configuration is deep-extended with\nyours to produce the working configuration.\n\n### General application configuration\n\nWhat's the app called (`name`), and what environment is it running in (`env`)? For `env`, anything other\nthan the string `'production'` is automatically considered `'development'` for debuggability.\n\n\tmodule.exports =\n\t\tapp:\n\t\t\tname: 'unnamed-app'\n\t\t\tenv: 'development'\n\n#### Sessions\n\nFor sessions, you can choose to entirely disable them by setting `enabled` to `false`. Otherwise, your\nchoices for `type` are currently `cookie` or `vanilla`.\n\nThe `cookie` type stores all session data in a garbled (not encrypted) client-side cookie, signed using\nthe `secret`.\n\nThe `vanilla` type stores the session in a server-side session store and only transmits a signed session\nID to the client.\n\n`cookie` is default for now, but `vanilla` will replace it in the next major version. The `secure` option\ndetermines whether the cookies are HTTPS-only or not.\n\n\t\t\tsession:\n\t\t\t\tenabled: true\n\t\t\t\ttype: 'cookie'\n\t\t\t\tsecret: 'change-me'\n\t\t\t\tsecure: false\n\n#### Cookie parser\n\nThe cookie parser transforms the `cookie` header into `request.cookies`, `request.signedCookies`, and\n`request.secureCookies` objects. You still have to use `response.cookie(...)` and\/or \n`response.clearCookie(...)` to actually manipulate cookies. The `secret` defined here will be used to\nverify signed cookies, and, if you set `{signed: true}` in the third argument to `response.cookie(...)`,\nthis `secret` will be used to sign the outbound cookies too.\n\n\t\t\tcookies:\n\t\t\t\tenabled: true\n\t\t\t\tsecret: 'change-me'\n\n### HTTP server configuration\n\nThe `server` sections deals with how platform-ng handles the exchange, parsing, and encoding of HTTP\nrequests and responses.\n\n\t\tserver:\n\t\t\t# Use automatic gzip compression for responses?\n\t\t\tcompress: true\n\n\t\t\t# TCP port to listen on (overriden by PORT environment variable)\n\t\t\tport: 8001\n\n\t\t\t# Is the app behind a proxy? If so, replace request.ip with X-Forwarded-For, and trust\n\t\t\t# all cookies for HTTPS-only mode.\n\t\t\tbehind_proxy: false\n\n\t\t\t# Enable\/disable various body parsers, for performance and security reasons\n\t\t\tparsers:\n\t\t\t\turlencoded: true\n\t\t\t\tjson: true\n\t\t\t\tmultipart: false # potential security problem; read http:\/\/goo.gl\/N4Bci1\n\n\t\t\t# Allow requests to change HTTP verb using 'X-HTTP-Method-Override' header?\n\t\t\tmethod_override: false\n\n### Language configuration\n\nThis section controls which protolanguages platform-ng will compile, as well as language-specific options\nfor some of the languages. (The NPM dependencies for these languages are listed in `package.json` as\n`optionalDependencies` and can be skipped entirely by calling `npm install --no-optional`.)\n\n\t\tlanguages:\n\t\t\tcoffeescript:\n\t\t\t\tenabled: true\n\n\t\t\tstylus:\n\t\t\t\tenabled: true\n\t\t\t\tinclude_css: true\t# Whether to inline @include()'d CSS files\n\t\t\t\tnib: true\t\t\t# Whether to automatically load the nib library\n\n`compile` controls generic compilation options for all language compilers. The `minify` option will\ncause the compiler to munge the output in order to produce the smallest possible code. The `expose_sources`\noption will cause the server to serve the original files (e.g. .coffee, .styl, etc) if requested, AND it\nwill ask the compiler to generate source maps, if supported.\n\n\t\tcompile:\n\t\t\tminify: true\n\t\t\texpose_sources: true \n\nplatform-ng is powered by Express. You can directly configure Express settings here. The settings are\ndocumented on [this page](http:\/\/expressjs.com\/3x\/api.html#app-settings).\n\n\t\texpress:\n\t\t\t'view engine': 'jade'","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b9f08cad0145da6864bdb2400c83d0b42321b7b5","subject":"Added a function to find the navmesh triangle closest to a point.","message":"Added a function to find the navmesh triangle closest to a point.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/navmesh.litcoffee","new_file":"src\/navmesh.litcoffee","new_contents":"# navmesh\n\nNavmeshes are stored as \"MSN\" (MasSplat Navmesh) and are used to define where \nentities (including the player) can travel.  By default, they are unable to \nleave the surface, \"crawling\" over it.  Each tile is a 3D triangle.  A light \nAny two triangles sharing two vertices are joined and the edge formed may be \ncrossed from one to the other, otherwise, the edge is treated as a form of wall.\n\nMSN is a binary format.  It is comprised of:\n\n| Type    | Num.              | Description                                                |\n| ------- | ----------------- | ---------------------------------------------------------- |\n| uint16  | 1                 | The number of vertices defined.                            |\n| uint16  | 1                 | The number of triangles defined.                           |\n| float32 | 3x num. vertices  | The X, Y and Z of each vertex.                             |\n| uint16  | 3x num. triangles | The first, second and third vertex index of each triangle. |\n\n    file = require \".\/file.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n\n## load\n\n- filename: The \"real\" location of the MSN file to load.  (i.e. already \n            \"require\"-d)\n- callback: A callback to execute with the array of objects representing the\n            loaded objects on success, containing:\n            \n+ plane: A plane object for the surface of the triangle itself.\n+ vertices: An array of vectors specifying the locations of the vertices which\n            make up the triangle.\n+ edges: An array of three objects representing the edges of the triangle,\n       containing:\n  \n* neighbor: When null, there is no other triangle over this edge.  Otherwise\n            a reference to the triangle object which can be found over it.\n* plane: A plane facing inwards from the edge.  If this edge borders another\n         triangle, this will be aligned to both this triangle and the \n         neighbor.\n    \n    load = (path, callback) ->\n        file.arrayBuffer path, (response) ->\n            header = new Uint16Array response, 0, 2\n            vertexData = new Float32Array response, 4, header[0] * 3\n            indices = new Uint16Array response, 4 + header[0] * 4 * 3, header[1] * 3\n        \n            vertices = for i in [0...vertexData.length] by 3\n                [\n                    vertexData[i]\n                    vertexData[i + 1]\n                    vertexData[i + 2]\n                ]\n        \n            triangles = for i in [0...indices.length] by 3\n                plane: plane.fromTriangle vertices[indices[i]], vertices[indices[i + 1]], vertices[indices[i + 2]]\n                indices: [\n                    indices[i]\n                    indices[i + 1]\n                    indices[i + 2]\n                ]\n                vertices: [\n                    vertices[indices[i]]\n                    vertices[indices[i + 1]]\n                    vertices[indices[i + 2]]\n                ]\n        \n            for triangle in triangles\n                triangle.edges = for edge in [0...3]\n                    vertexA = triangle.indices[edge]\n                    vertexB = triangle.indices[(edge + 1) % 3]\n                    vertexC = []\n                    vector.add.vector vertices[vertexA], triangle.plane.normal, vertexC\n                    neighbor = null\n                    for other in triangles\n                        if triangle is other then continue\n                        if vertexA not in other.indices then continue\n                        if vertexB not in other.indices then continue\n                        neighbor = other\n                        vector.add.vector vertexC, other.plane.normal, vertexC\n                        break\n                    neighbor: neighbor\n                    plane: plane.fromTriangle vertices[vertexA], vertexC, vertices[vertexB]\n\n            callback triangles\n            return\n        return\n            \n## constrain\n\n- A vector specifying the location moved to.\n- A reference to the navmesh triangle which contained the location moved from.\n- An optional callback executed when a wall is hit, with arguments:\n\n+ The edge collided with.\n\nUpdates the location vector to take into account collision with navmesh triangle \nwalls and returns the new containing navmesh triangle.\n            \n    constrain = (location, triangle, edgeCallback) ->\n        \n        for iterations in [0...25]\n            distanceA = plane.distance triangle.edges[0].plane, location\n            distanceB = plane.distance triangle.edges[1].plane, location\n            distanceC = plane.distance triangle.edges[2].plane, location\n            if distanceA >= 0 and distanceB >= 0 and distanceC >= 0 \n                break\n\n            if distanceA < 0 and triangle.edges[0].neighbor\n                triangle = triangle.edges[0].neighbor\n                continue\n                \n            if distanceB < 0 and triangle.edges[1].neighbor\n                triangle = triangle.edges[1].neighbor\n                continue\n                \n            if distanceC < 0 and triangle.edges[2].neighbor\n                triangle = triangle.edges[2].neighbor\n                continue\n            \n            if distanceA < 0 and distanceB < 0\n                vector.copy triangle.vertices[1], location\n                if edgeCallback\n                    edgeCallback triangle.edges[0]\n                    edgeCallback triangle.edges[1]\n                continue\n                \n            if distanceB < 0 and distanceC < 0\n                vector.copy triangle.vertices[2], location\n                if edgeCallback\n                    edgeCallback triangle.edges[1]\n                    edgeCallback triangle.edges[2]\n                continue\n                \n            if distanceC < 0 and distanceA < 0\n                vector.copy triangle.vertices[0], location\n                if edgeCallback\n                    edgeCallback triangle.edges[2]\n                    edgeCallback triangle.edges[0]\n                continue\n\n            if distanceA < 0\n                plane.project triangle.edges[0].plane, location, location\n                if edgeCallback then edgeCallback triangle.edges[0]\n                continue\n                \n            if distanceB < 0\n                plane.project triangle.edges[1].plane, location, location\n                if edgeCallback then edgeCallback triangle.edges[1]\n                continue\n                    \n            if distanceC < 0\n                plane.project triangle.edges[2].plane, location, location\n                if edgeCallback then edgeCallback triangle.edges[2]\n                continue\n                \n        triangle\n        \n## findNearest\n\n- A navmesh instance.\n- A vector specifying a point in 3D space.\n\nReturns the navmesh triangle which is \"best\" to start in for that location.\n\n    findNearest = (navmesh, location) ->\n        best = null\n        bestDistance = -Infinity\n        for triangle in navmesh\n            distance = plane.distance triangle.plane, location\n            if bestDistance >= 0 and distance <= 0 then continue\n            bestWallDistance = Infinity\n            for edge in triangle.edges\n                wallDistance = Math.max 0, plane.distance edge.plane, location\n                if wallDistance > bestWallDistance then continue\n                bestWallDistance = wallDistance\n            behind = distance < 0\n            distance = distance * distance + bestWallDistance * bestWallDistance\n            if distance >= Math.abs bestDistance then continue\n            if behind then distance = -distance\n            bestDistance = distance\n            best = triangle\n        best\n        \n    module.exports = { load, constrain, findNearest }","old_contents":"# navmesh\n\nNavmeshes are stored as \"MSN\" (MasSplat Navmesh) and are used to define where \nentities (including the player) can travel.  By default, they are unable to \nleave the surface, \"crawling\" over it.  Each tile is a 3D triangle.  A light \nAny two triangles sharing two vertices are joined and the edge formed may be \ncrossed from one to the other, otherwise, the edge is treated as a form of wall.\n\nMSN is a binary format.  It is comprised of:\n\n| Type    | Num.              | Description                                                |\n| ------- | ----------------- | ---------------------------------------------------------- |\n| uint16  | 1                 | The number of vertices defined.                            |\n| uint16  | 1                 | The number of triangles defined.                           |\n| float32 | 3x num. vertices  | The X, Y and Z of each vertex.                             |\n| uint16  | 3x num. triangles | The first, second and third vertex index of each triangle. |\n\n    file = require \".\/file.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n\n## load\n\n- filename: The \"real\" location of the MSN file to load.  (i.e. already \n            \"require\"-d)\n- callback: A callback to execute with the array of objects representing the\n            loaded objects on success, containing:\n            \n+ plane: A plane object for the surface of the triangle itself.\n+ vertices: An array of vectors specifying the locations of the vertices which\n            make up the triangle.\n+ edges: An array of three objects representing the edges of the triangle,\n       containing:\n  \n* neighbor: When null, there is no other triangle over this edge.  Otherwise\n            a reference to the triangle object which can be found over it.\n* plane: A plane facing inwards from the edge.  If this edge borders another\n         triangle, this will be aligned to both this triangle and the \n         neighbor.\n    \n    load = (path, callback) ->\n        file.arrayBuffer path, (response) ->\n            header = new Uint16Array response, 0, 2\n            vertexData = new Float32Array response, 4, header[0] * 3\n            indices = new Uint16Array response, 4 + header[0] * 4 * 3, header[1] * 3\n        \n            vertices = for i in [0...vertexData.length] by 3\n                [\n                    vertexData[i]\n                    vertexData[i + 1]\n                    vertexData[i + 2]\n                ]\n        \n            triangles = for i in [0...indices.length] by 3\n                plane: plane.fromTriangle vertices[indices[i]], vertices[indices[i + 1]], vertices[indices[i + 2]]\n                indices: [\n                    indices[i]\n                    indices[i + 1]\n                    indices[i + 2]\n                ]\n                vertices: [\n                    vertices[indices[i]]\n                    vertices[indices[i + 1]]\n                    vertices[indices[i + 2]]\n                ]\n        \n            for triangle in triangles\n                triangle.edges = for edge in [0...3]\n                    vertexA = triangle.indices[edge]\n                    vertexB = triangle.indices[(edge + 1) % 3]\n                    vertexC = []\n                    vector.add.vector vertices[vertexA], triangle.plane.normal, vertexC\n                    neighbor = null\n                    for other in triangles\n                        if triangle is other then continue\n                        if vertexA not in other.indices then continue\n                        if vertexB not in other.indices then continue\n                        neighbor = other\n                        vector.add.vector vertexC, other.plane.normal, vertexC\n                        break\n                    neighbor: neighbor\n                    plane: plane.fromTriangle vertices[vertexA], vertexC, vertices[vertexB]\n\n            callback triangles\n            return\n        return\n            \n## constrain\n\n- A vector specifying the location moved to.\n- A reference to the navmesh triangle which contained the location moved from.\n- An optional callback executed when a wall is hit, with arguments:\n\n+ The edge collided with.\n\nUpdates the location vector to take into account collision with navmesh triangle \nwalls and returns the new containing navmesh triangle.\n            \n    constrain = (location, triangle, edgeCallback) ->\n        \n        for iterations in [0...25]\n            distanceA = plane.distance triangle.edges[0].plane, location\n            distanceB = plane.distance triangle.edges[1].plane, location\n            distanceC = plane.distance triangle.edges[2].plane, location\n            if distanceA >= 0 and distanceB >= 0 and distanceC >= 0 \n                break\n\n            if distanceA < 0 and triangle.edges[0].neighbor\n                triangle = triangle.edges[0].neighbor\n                continue\n                \n            if distanceB < 0 and triangle.edges[1].neighbor\n                triangle = triangle.edges[1].neighbor\n                continue\n                \n            if distanceC < 0 and triangle.edges[2].neighbor\n                triangle = triangle.edges[2].neighbor\n                continue\n            \n            if distanceA < 0 and distanceB < 0\n                vector.copy triangle.vertices[1], location\n                if edgeCallback\n                    edgeCallback triangle.edges[0]\n                    edgeCallback triangle.edges[1]\n                continue\n                \n            if distanceB < 0 and distanceC < 0\n                vector.copy triangle.vertices[2], location\n                if edgeCallback\n                    edgeCallback triangle.edges[1]\n                    edgeCallback triangle.edges[2]\n                continue\n                \n            if distanceC < 0 and distanceA < 0\n                vector.copy triangle.vertices[0], location\n                if edgeCallback\n                    edgeCallback triangle.edges[2]\n                    edgeCallback triangle.edges[0]\n                continue\n\n            if distanceA < 0\n                plane.project triangle.edges[0].plane, location, location\n                if edgeCallback then edgeCallback triangle.edges[0]\n                continue\n                \n            if distanceB < 0\n                plane.project triangle.edges[1].plane, location, location\n                if edgeCallback then edgeCallback triangle.edges[1]\n                continue\n                    \n            if distanceC < 0\n                plane.project triangle.edges[2].plane, location, location\n                if edgeCallback then edgeCallback triangle.edges[2]\n                continue\n                \n        triangle\n        \n    module.exports = { load, constrain }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b54f45937904d0ed76fe8568c4d75044c4a233f5","subject":"Move logging method initialization to constructor","message":"Move logging method initialization to constructor\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/module.litcoffee","new_file":"lib\/module.litcoffee","new_contents":"    q  = require 'q'\n    fs = require 'fs'\n\n    microtime = require 'microtime'\n\n    logger = require '.\/logger'\n\n    available = { }\n    loaded    = { }\n    processed = { }\n\n    class Module\n\n      constructor: ->\n        @debug = (msg, data) -> logger.debug msg, data\n        @info  = (msg, data) -> logger.info  msg, data\n        @warn  = (msg, data) -> logger.warn  msg, data\n        @error = (msg, data) -> logger.error msg, data\n\n        if arguments.length == 0 || arguments[0] == ''\n          @clazz = arguments.callee.caller.name\n        else\n          @clazz = arguments[0]\n\n        logger.trace \"Instantiating #{@clazz}\"\n\n      wrap_methods: =>\n        @pub?.forEach (method) =>\n          callMe   = @[method]\n          deferred = q.defer()\n\n          @[\"_#{method}\"] = @[method]\n\n          @[method] = =>\n            start    = microtime.now()\n            update   = start\n\n            respond = (state, data) =>\n              process.nextTick =>\n                deferred[state] data\n\n                if state == 'reject'\n                  logger.rejected @clazz, method, microtime.now() - start, data\n\n                if process.env.CGAPI_LOG_LEVEL > 4\n                  if state == 'resolve'\n                    logger.resolved @clazz, method, microtime.now() - start, data\n                  else if state == 'notify'\n                    logger.notify @clazz, method, microtime.now() - update, data\n                    update = microtime.now()\n\n            @done   = (out) => respond 'resolve', out\n            @fail   = (err) => respond 'reject',  err\n            @update = (out) => respond 'notify',  out\n\n            args = Array.prototype.slice.call arguments\n\n            logger.trace \"Invoking #{@clazz}.#{method}()\", args\n\n            @[\"_#{method}\"].apply null, args\n\n            deferred.promise\n\n      hydrate_dependencies: =>\n        def = q.defer()\n        good_to_go = false\n\n        load = (name, path, cb) =>\n          if available[name]? == false\n            mod = require path\n\n            if typeof mod == 'function'\n              new mod()\n                .initialize @ctor_params?[name]\n                .then (mod) =>\n                  available[name] = mod\n                  cb()\n            else\n              available[name] = mod\n              cb()\n          else\n            cb()\n\n        check_directory = (path, dep, cb) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              def.reject type: 'ERROR', info: err\n            else\n              to_check = files.length\n              checked = 0\n\n              files.forEach (f) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.lstat depth, (e, s) =>\n                  if s.isDirectory()\n                    check_directory depth, dep, =>\n                      cb() if ++checked == to_check\n                  else if s.isFile()\n                    if f == 'index.js' || f.includes '.spec.'\n                      cb() if ++checked == to_check\n                    else\n                      name = f.substring 0, f.length - 3\n\n                      if name == dep\n                        load name, depth, => cb() if ++checked == to_check\n                      else\n                        cb() if ++checked == to_check\n\n        register_dependency = (name, mod) =>\n          n = name.replace \/\\W+\/g, '_'\n          @[n] = mod\n\n          def.notify type: 'NOTICE', loaded: n\n\n          unless loaded[@clazz]?\n            loaded[@clazz] = [ ]\n\n          unless processed[@clazz]?\n            processed[@clazz] = 0\n\n          unless loaded[@clazz].indexOf(name) > -1\n            loaded[@clazz].push name\n            ++processed[@clazz]\n\n          logger.trace 'Registered dependency', \"#{@clazz}\": \"#{n}(file: #{name})\"\n\n          if processed[@clazz] >= @deps.length\n            if loaded[@clazz].length >= @deps.length\n              logger.trace \"Loaded all dependencies: #{@clazz}\", loaded[@clazz]\n              def.resolve @\n            else\n              not_loaded = [ ]\n\n              @deps.forEach (d) -> not_loaded.push(d) unless loaded[@clazz].indexOf(d) > -1\n\n              logger.error \"Failed loading dependencies for: #{@clazz}\", not_loaded\n\n              def.reject type: 'ERROR', not_loaded: not_loaded\n\n        @deps?.forEach (d) =>\n          if @[d]?\n            good_to_go = true\n          else\n            if available[d]? == true\n              register_dependency d, available[d]\n            else\n              try\n                available[d] = require d\n                register_dependency d, available[d]\n              catch\n                check_directory __dirname, d, =>\n                  register_dependency d, available[d]\n\n        if good_to_go && loaded[@clazz].length >= @deps.length\n          process.nextTick => def.resolve @\n\n        def.promise\n\n      initialize: (wrap = true) =>\n        deferred = q.defer()\n\n        if @deps?\n          @hydrate_dependencies()\n            .then =>\n              @wrap_methods() if wrap\n              deferred.resolve @\n            .fail (reason) => deferred.reject reason\n        else\n          process.nextTick =>\n            @wrap_methods() if wrap\n            deferred.resolve @\n\n        deferred.promise\n\n    module.exports = Module\n","old_contents":"    q  = require 'q'\n    fs = require 'fs'\n\n    microtime = require 'microtime'\n\n    logger = require '.\/logger'\n\n    available = { }\n    loaded    = { }\n    processed = { }\n\n    class Module\n\n      constructor: ->\n        if arguments.length == 0 || arguments[0] == ''\n          @clazz = arguments.callee.caller.name\n        else\n          @clazz = arguments[0]\n\n        logger.trace \"Instantiating #{@clazz}\"\n\n      wrap_methods: =>\n        @pub?.forEach (method) =>\n          callMe   = @[method]\n          deferred = q.defer()\n\n          @[\"_#{method}\"] = @[method]\n\n          @[method] = =>\n            start    = microtime.now()\n            update   = start\n\n            respond = (state, data) =>\n              process.nextTick =>\n                deferred[state] data\n\n                if state == 'reject'\n                  logger.rejected @clazz, method, microtime.now() - start, data\n\n                if process.env.CGAPI_LOG_LEVEL > 4\n                  if state == 'resolve'\n                    logger.resolved @clazz, method, microtime.now() - start, data\n                  else if state == 'notify'\n                    logger.notify @clazz, method, microtime.now() - update, data\n                    update = microtime.now()\n\n            @done   = (out) => respond 'resolve', out\n            @fail   = (err) => respond 'reject',  err\n            @update = (out) => respond 'notify',  out\n\n            args = Array.prototype.slice.call arguments\n\n            logger.trace \"Invoking #{@clazz}.#{method}()\", args\n\n            @[\"_#{method}\"].apply null, args\n\n            deferred.promise\n\n      hydrate_dependencies: =>\n        def = q.defer()\n        good_to_go = false\n\n        load = (name, path, cb) =>\n          if available[name]? == false\n            mod = require path\n\n            if typeof mod == 'function'\n              new mod()\n                .initialize @ctor_params?[name]\n                .then (mod) =>\n                  available[name] = mod\n                  cb()\n            else\n              available[name] = mod\n              cb()\n          else\n            cb()\n\n        check_directory = (path, dep, cb) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              def.reject type: 'ERROR', info: err\n            else\n              to_check = files.length\n              checked = 0\n\n              files.forEach (f) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.lstat depth, (e, s) =>\n                  if s.isDirectory()\n                    check_directory depth, dep, =>\n                      cb() if ++checked == to_check\n                  else if s.isFile()\n                    if f == 'index.js' || f.includes '.spec.'\n                      cb() if ++checked == to_check\n                    else\n                      name = f.substring 0, f.length - 3\n\n                      if name == dep\n                        load name, depth, => cb() if ++checked == to_check\n                      else\n                        cb() if ++checked == to_check\n\n        register_dependency = (name, mod) =>\n          n = name.replace \/\\W+\/g, '_'\n          @[n] = mod\n\n          def.notify type: 'NOTICE', loaded: n\n\n          unless loaded[@clazz]?\n            loaded[@clazz] = [ ]\n\n          unless processed[@clazz]?\n            processed[@clazz] = 0\n\n          unless loaded[@clazz].indexOf(name) > -1\n            loaded[@clazz].push name\n            ++processed[@clazz]\n\n          logger.trace 'Registered dependency', \"#{@clazz}\": \"#{n}(file: #{name})\"\n\n          if processed[@clazz] >= @deps.length\n            if loaded[@clazz].length >= @deps.length\n              logger.trace \"Loaded all dependencies: #{@clazz}\", loaded[@clazz]\n              def.resolve @\n            else\n              not_loaded = [ ]\n\n              @deps.forEach (d) -> not_loaded.push(d) unless loaded[@clazz].indexOf(d) > -1\n\n              logger.error \"Failed loading dependencies for: #{@clazz}\", not_loaded\n\n              def.reject type: 'ERROR', not_loaded: not_loaded\n\n        @deps?.forEach (d) =>\n          if @[d]?\n            good_to_go = true\n          else\n            if available[d]? == true\n              register_dependency d, available[d]\n            else\n              try\n                available[d] = require d\n                register_dependency d, available[d]\n              catch\n                check_directory __dirname, d, =>\n                  register_dependency d, available[d]\n\n        if good_to_go && loaded[@clazz].length >= @deps.length\n          process.nextTick => def.resolve @\n\n        def.promise\n\n      initialize: (wrap = true) =>\n        deferred = q.defer()\n\n        if @deps?\n          @hydrate_dependencies()\n            .then =>\n              @wrap_methods() if wrap\n              deferred.resolve @\n            .fail (reason) => deferred.reject reason\n        else\n          process.nextTick =>\n            @wrap_methods() if wrap\n            deferred.resolve @\n\n        @debug = (msg, data) -> logger.debug msg, data\n        @info  = (msg, data) -> logger.info  msg, data\n        @warn  = (msg, data) -> logger.warn  msg, data\n        @error = (msg, data) -> logger.error msg, data\n\n        deferred.promise\n\n    module.exports = Module\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"97e9418b00c28c0f130b2669be85540387a1dc8b","subject":"Parse origin header and extract hostname","message":"Parse origin header and extract hostname\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/server.litcoffee","new_file":"src\/server.litcoffee","new_contents":"    url          = require 'url'\n\n    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      origin = url.parse req.get('Origin') or ''\n\n      if origin.hostname not in origins\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status = 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","old_contents":"    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      if not req.get('Origin') or not (req.get('Origin') in origins)\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status = 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b2fcb2964a1efe19af40fa5168a8c7193bd5d4f3","subject":"fix(document): prevent mixed include\/exclude projection error","message":"fix(document): prevent mixed include\/exclude projection error\n\nMongo.DB does not handle including and excluding fields\nsimultaneously.\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/document.litcoffee","new_file":"coffee\/document.litcoffee","new_contents":"    schema   = require '.\/helper\/schema'\n    sentry   = require '.\/db\/sentry'\n    Document = require '.\/model\/Document'\n\n    JSONStream = require 'JSONStream'\n\n## param()\n\n    exports.param = (req, res, next, id) ->\n      return res.status(400).json message: 'Invalid ObjectId' if not \/^[a-f0-9]{24}$\/.test id\n\n      req.doc = new Document(req.type, id).once('error', next).once 'ready', ->\n        req.isOwner = @exists() and req.user.tilbyder is @get 'tilbyder'\n\n        if not @exists() or (@get('status') isnt 'Offentlig' and not req.isOwner)\n          return res.status(404).json message: 'Not Found' if req.method isnt 'HEAD'\n          return res.status(404).end()\n\n        next()\n\n\n## all()\n\n    exports.all = (req, res, next) ->\n      res.set 'X-Cache-Hit', req.doc.wasCacheHit()\n      res.set 'ETag', \"\\\"#{req.doc.get 'checksum'}\\\"\"\n      res.set 'Last-Modified', new Date(req.doc.get 'endret').toUTCString()\n\n      if req.method not in ['GET', 'HEAD'] and not req.isOwner\n        return res.status(403).json message: 'Request Denied'\n\n      if req.get 'If-Match'\n        return res.status(412).end() if req.doc.isNoneMatch req.get 'If-Match'\n\n      else if req.get 'If-None-Match'\n        return res.status(304).end() if req.doc.isMatch req.get 'If-None-Match'\n\n      else\n        if req.doc.isNotModifiedSince req.get 'If-Modified-Since'\n          return res.status(304).end()\n\n        if req.doc.isModifiedSince req.get 'If-Unmodified-Since'\n          return res.status(412).end()\n\n      next()\n\n\n## HEAD and GET\n\n```http\nHEAD \/{type}\/{id}\nGET \/{type}\/{id}\n```\n\n    exports.head = exports.get = (req, res, next) ->\n      return res.sendStatus 200 if req.method is 'HEAD'\n\n      opts =\n        query: $or: [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n        fields: {}\n\n### Fields Projection\n\n```none\n&fields=field1[,field2[,..]]\n```\n\nPrivate (`privat.`) fields are hidden unless the current API user is the owner\nof the document. This is to prevent unauthorized information disclosure.\n\n      opts.fields.privat = false if not req.isOwner\n\nIf you only want some of the document properties returned you can use the\n`fields` query parameter to control the projection of document properties.\nMultiple fields must be comma separated without any additional spacing.\n\nThis projection also applies to expanded sub-documents when using the `&expand=`\nquery parameter below.\n\n      if req.query?.fields\n        opts.fields[field] = true for field in req.query.fields.split ','\n        delete opts.fields.privat if not req.isOwner\n\nThe list of default fields below will always be returned for compliance reasons.\n\n        opts.fields = Object.assign opts.fields,\n          endret: true\n          lisens: true\n          status: true\n          navn  : true\n          tilbyder  : true\n          navngiving: true\n\n### Sub-document Expansion\n\n```none\n&expand=field1[,field2[..]]\n```\n\nSub-document expansion is an easy and convenient way to get connected documents\nsuch as `grupper`, `bilder`, and `omr\u00e5der` as their full objects instead of a\nlist of `ObjectIDs`. It works by setting the `expand` query parameter to the\nfields to expand.\n\n**Rate limit**\n\nSub-document expansion will decrease your remaining API rate limit with `1` per\ncollection expanded in addition to the request itself. Thus, if you request a\ndocument (1) with two collection expanded (2) your remaining API rate limit will\nbe decremented with 3. This is to encurrage resonable expansion of relevant\ncollections only.\n\n**Order and limit**\n\nSub-document expansion will return at most 10 first sub-documents for each\ncollection expanded and out of order. Only sub-documents avaiable to the current\nAPI user will be return as sub-documents my not be published or may have been\ndeleted.\n\n      if req.query?.expand\n        opts.expand = req.query.expand.split ','\n\n### Sub-document Limit\n\n```none\n&limit={n}\n```\n\nIf you wisth to return less sub-documents in order to increase response time and\nbody size you may do so by using the `limit` query parameter. This will affect\nall sub-documents expanded by the `expand` query parameter.\n\n      if req.query?.limit and parseInt req.query.limit, 10\n        opts.limit = parseInt req.query.limit, 10\n\n---\n\n      req.doc.getExpanded opts, (err, doc) ->\n        return next err if err\n        res.json doc\n\n\n## PUT and PATCH\n\n```http\nPUT \/{type}\/{id}\nPATCH \/{type}\/{id}\n```\n\n    exports.patch = exports.put = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(400).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      method = (if req.method is 'PUT' then 'replace' else 'update')\n      req.doc[method] req.body, (err, warn, data) ->\n        if err\n          return next(err) if err.name isnt 'ValidationError'\n\n          sentry.captureDocumentError req, err\n\n          return res.status(422).json\n            document: req.body\n            message: 'Validation Failed'\n            errors: err.details #TODO(starefossen) document this\n\n        res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n        res.set 'Last-Modified', new Date(data.endret).toUTCString()\n\n        return res.status(200).json\n          document: data\n          message: 'Validation Warnings' if warn.length > 0\n          warnings: warn if warn.length > 0\n\n\n## DELETE\n\n```http\nDELETE \/{type}\/{id}\n```\n\n    exports.delete = (req, res, next) ->\n      req.doc.delete (err) ->\n        return next err if err\n        return res.sendStatus 204\n\n","old_contents":"    schema   = require '.\/helper\/schema'\n    sentry   = require '.\/db\/sentry'\n    Document = require '.\/model\/Document'\n\n    JSONStream = require 'JSONStream'\n\n## param()\n\n    exports.param = (req, res, next, id) ->\n      return res.status(400).json message: 'Invalid ObjectId' if not \/^[a-f0-9]{24}$\/.test id\n\n      req.doc = new Document(req.type, id).once('error', next).once 'ready', ->\n        req.isOwner = @exists() and req.user.tilbyder is @get 'tilbyder'\n\n        if not @exists() or (@get('status') isnt 'Offentlig' and not req.isOwner)\n          return res.status(404).json message: 'Not Found' if req.method isnt 'HEAD'\n          return res.status(404).end()\n\n        next()\n\n\n## all()\n\n    exports.all = (req, res, next) ->\n      res.set 'X-Cache-Hit', req.doc.wasCacheHit()\n      res.set 'ETag', \"\\\"#{req.doc.get 'checksum'}\\\"\"\n      res.set 'Last-Modified', new Date(req.doc.get 'endret').toUTCString()\n\n      if req.method not in ['GET', 'HEAD'] and not req.isOwner\n        return res.status(403).json message: 'Request Denied'\n\n      if req.get 'If-Match'\n        return res.status(412).end() if req.doc.isNoneMatch req.get 'If-Match'\n\n      else if req.get 'If-None-Match'\n        return res.status(304).end() if req.doc.isMatch req.get 'If-None-Match'\n\n      else\n        if req.doc.isNotModifiedSince req.get 'If-Modified-Since'\n          return res.status(304).end()\n\n        if req.doc.isModifiedSince req.get 'If-Unmodified-Since'\n          return res.status(412).end()\n\n      next()\n\n\n## HEAD and GET\n\n```http\nHEAD \/{type}\/{id}\nGET \/{type}\/{id}\n```\n\n    exports.head = exports.get = (req, res, next) ->\n      return res.sendStatus 200 if req.method is 'HEAD'\n\n      opts =\n        query: $or: [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n        fields: {}\n\n### Fields Projection\n\n```none\n&fields=field1[,field2[,..]]\n```\n\nPrivate (`privat.`) fields are hidden unless the current API user is the owner\nof the document. This is to prevent unauthorized information disclosure.\n\n      opts.fields.privat = false if not req.isOwner\n\nIf you only want some of the document properties returned you can use the\n`fields` query parameter to control the projection of document properties.\nMultiple fields must be comma separated without any additional spacing.\n\nThis projection also applies to expanded sub-documents when using the `&expand=`\nquery parameter below.\n\n      if req.query?.fields\n        opts.fields[field] = true for field in req.query.fields.split ','\n        opts.fields.privat = false if not req.isOwner\n\nThe list of default fields below will always be returned for compliance reasons.\n\n        opts.fields = Object.assign opts.fields,\n          endret: true\n          lisens: true\n          status: true\n          navn  : true\n          tilbyder  : true\n          navngiving: true\n\n### Sub-document Expansion\n\n```none\n&expand=field1[,field2[..]]\n```\n\nSub-document expansion is an easy and convenient way to get connected documents\nsuch as `grupper`, `bilder`, and `omr\u00e5der` as their full objects instead of a\nlist of `ObjectIDs`. It works by setting the `expand` query parameter to the\nfields to expand.\n\n**Rate limit**\n\nSub-document expansion will decrease your remaining API rate limit with `1` per\ncollection expanded in addition to the request itself. Thus, if you request a\ndocument (1) with two collection expanded (2) your remaining API rate limit will\nbe decremented with 3. This is to encurrage resonable expansion of relevant\ncollections only.\n\n**Order and limit**\n\nSub-document expansion will return at most 10 first sub-documents for each\ncollection expanded and out of order. Only sub-documents avaiable to the current\nAPI user will be return as sub-documents my not be published or may have been\ndeleted.\n\n      if req.query?.expand\n        opts.expand = req.query.expand.split ','\n\n### Sub-document Limit\n\n```none\n&limit={n}\n```\n\nIf you wisth to return less sub-documents in order to increase response time and\nbody size you may do so by using the `limit` query parameter. This will affect\nall sub-documents expanded by the `expand` query parameter.\n\n      if req.query?.limit and parseInt req.query.limit, 10\n        opts.limit = parseInt req.query.limit, 10\n\n---\n\n      req.doc.getExpanded opts, (err, doc) ->\n        return next err if err\n        res.json doc\n\n\n## PUT and PATCH\n\n```http\nPUT \/{type}\/{id}\nPATCH \/{type}\/{id}\n```\n\n    exports.patch = exports.put = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(400).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      method = (if req.method is 'PUT' then 'replace' else 'update')\n      req.doc[method] req.body, (err, warn, data) ->\n        if err\n          return next(err) if err.name isnt 'ValidationError'\n\n          sentry.captureDocumentError req, err\n\n          return res.status(422).json\n            document: req.body\n            message: 'Validation Failed'\n            errors: err.details #TODO(starefossen) document this\n\n        res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n        res.set 'Last-Modified', new Date(data.endret).toUTCString()\n\n        return res.status(200).json\n          document: data\n          message: 'Validation Warnings' if warn.length > 0\n          warnings: warn if warn.length > 0\n\n\n## DELETE\n\n```http\nDELETE \/{type}\/{id}\n```\n\n    exports.delete = (req, res, next) ->\n      req.doc.delete (err) ->\n        return next err if err\n        return res.sendStatus 204\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"80bd1410cf29c7136c44166912b8dc57c2d14d81","subject":"io send error","message":"io send error\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        self.port.onerror? e\n      0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) =>\n       try\n        callbacks.fail? e\n       catch err\n        @onerror? err\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        self.port.onerror? e\n      0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8d18ef5e8a37d16d79ba392c2fe695331f9c21a8","subject":"Velocity is now \"flattened\" against a wall on impact.","message":"Velocity is now \"flattened\" against a wall on impact.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/game.litcoffee","new_file":"src\/game.litcoffee","new_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n       \n    triangle = undefined\n    \n    testEntity = testMap = testNavmesh = undefined\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load (require \".\/testEntity.msc\"), (testEntity_) ->\n            testEntity = testEntity_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    translation = []\n    acceleration = []\n    forwardVelocity = []\n    sidewardVelocity = []\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->    \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            \n        matrix.translate velocity, entityTransform        \n        \n        # Left\/right rotation.\n        matrix.rotateY ((gamepad.left - gamepad.right) * 0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            vector.multiply.byScalar zAxis, ((gamepad.forward - gamepad.backward) * 0.2), acceleration\n            vector.add.vector velocity, acceleration, velocity\n        \n            # Apply friction.  There is more sidewards than backwards\/forwards.\n            vector.flatten velocity, zAxis, sidewardVelocity\n            vector.straighten velocity, zAxis, forwardVelocity\n            vector.multiply.byScalar sidewardVelocity, 0.9, sidewardVelocity\n            vector.multiply.byScalar forwardVelocity, 0.99, forwardVelocity\n            vector.add.vector sidewardVelocity, forwardVelocity, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n    \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            firstTick = false\n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw testEntity, entityTransformPreviousDraw, entityTransformToDraw\n        \n        return\n        \n    module.exports = { load, tick, draw }","old_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n       \n    triangle = undefined\n    \n    testEntity = testMap = testNavmesh = undefined\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load (require \".\/testEntity.msc\"), (testEntity_) ->\n            testEntity = testEntity_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    translation = []\n    acceleration = []\n    forwardVelocity = []\n    sidewardVelocity = []\n    \n    tick = ->    \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            \n        matrix.translate velocity, entityTransform        \n        \n        # Left\/right rotation.\n        matrix.rotateY ((gamepad.left - gamepad.right) * 0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            vector.multiply.byScalar zAxis, ((gamepad.forward - gamepad.backward) * 0.2), acceleration\n            vector.add.vector velocity, acceleration, velocity\n        \n            # Apply friction.  There is more sidewards than backwards\/forwards.\n            vector.flatten velocity, zAxis, sidewardVelocity\n            vector.straighten velocity, zAxis, forwardVelocity\n            vector.multiply.byScalar sidewardVelocity, 0.9, sidewardVelocity\n            vector.multiply.byScalar forwardVelocity, 0.99, forwardVelocity\n            vector.add.vector sidewardVelocity, forwardVelocity, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n    \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            firstTick = false\n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw testEntity, entityTransformPreviousDraw, entityTransformToDraw\n        \n        return\n        \n    module.exports = { load, tick, draw }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3fc4e20ae58f45fc4d205c6c51192842a84bbe6e","subject":"npm in readme","message":"npm in readme\n","repos":"johannhof\/typed-bacon","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# typed-bacon [![](https:\/\/travis-ci.org\/johannhof\/typed-bacon.svg)](https:\/\/travis-ci.org\/johannhof\/typed-bacon) [![](https:\/\/img.shields.io\/npm\/v\/typed-bacon.svg)](https:\/\/www.npmjs.com\/package\/typed-bacon)\nType checks in your Bacon stream!\n\n```\nnpm install typed-bacon\n```\n\n> This document is an executable source file that contains tests to stay up to date.\n\n    assert = require('assert')\n\n## Usage\n\nRequiring Bacon before typed-bacon ensures that the custom methods can hook into Bacon correctly.\nYou need to require `typed-bacon` to add the custom type methods to Bacon observables.\nYou will also want to get access to the Types object.\n\n    Bacon = require('baconjs')\n    {Types} = require('typed-bacon')\n\n## API\n\n### Observable.typeCheck\n\nTransforms a value to an error if the input is not of the specified type.\n\n    Bacon.fromArray([1, 2, \"three\"])\n         .typeCheck(Types.Number)\n         .onError (e) ->\n           assert(e instanceof Error)\n           assert.equal(e.message, \"Expected three to be a number\")\n\n### Observable.typeFilter\n\nFilters out all stream values that are not of the specified type.\n\n    Bacon.fromArray([1, \"two\", 3, true, 4])\n         .typeFilter(Types.Number)\n         .slidingWindow(3,3)\n         .onValue (arr) ->\n           assert.deepEqual(arr, [1, 3, 4])\n\n### Observable.typeWarn\n\nWill warn about type mismatches but will not interfere with the stream\n\n    # logs \"Expected true to be a number\"\n    Bacon.fromArray([5, true, \"test\", null])\n         .typeWarn(Types.Number().or(Types.Null).or(Types.String))\n         .slidingWindow(4,4)\n         .onValue (arr) ->\n           assert.deepEqual(arr, [5, true, \"test\", null])\n\n### Chaining types\n\nTypes can be chained using the `or` method.\n\n    Bacon.fromArray([5, true, \"test\", null])\n         .typeCheck(Types.Number().or(Types.Null).or(Types.String))\n         .slidingWindow(3,3)\n         .onValue (arr) ->\n           assert.deepEqual(arr, [5, \"test\", null])\n\n### Types.Object\n\nTypes.Object can be passed a JS object containing child types with infinite deepness(as long as the call stack holds).\n\n    person = {\n      name: \"Johann\",\n      languages: 5\n    }\n\n    Bacon.once(person)\n         .typeCheck(Types.Object({\n           name: Types.String,\n           languages: Types.Array\n         }))\n         .onError (e) ->\n           assert(e instanceof Error)\n           assert.equal(e.message, \"Expected 5 to be an array\")\n\n### Types.Array\n\nTypes.Array can receive an object with a length parameter, specifying the exact length of the array.\n\n    Bacon.once([1,2,3,4])\n         .typeCheck(Types.Array(length: 5))\n         .onError (e) ->\n           assert(e instanceof Error)\n           assert.equal(e.message, \"Expected [1,2,3,4] to have a length of 5\")\n\n","old_contents":"# typed-bacon [![](https:\/\/travis-ci.org\/johannhof\/typed-bacon.svg)](https:\/\/travis-ci.org\/johannhof\/typed-bacon) [![](https:\/\/img.shields.io\/npm\/v\/typed-bacon.svg)]()\nType checks in your Bacon stream!\n\n> This document is an executable source file that contains tests to stay up to date.\n\n    assert = require('assert')\n\n## Usage\n\nRequiring Bacon before typed-bacon ensures that the custom methods can hook into Bacon correctly.\nYou need to require `typed-bacon` to add the custom type methods to Bacon observables.\nYou will also want to get access to the Types object.\n\n    Bacon = require('baconjs')\n    {Types} = require('typed-bacon')\n\n## API\n\n### Observable.typeCheck\n\nTransforms a value to an error if the input is not of the specified type.\n\n    Bacon.fromArray([1, 2, \"three\"])\n         .typeCheck(Types.Number)\n         .onError (e) ->\n           assert(e instanceof Error)\n           assert.equal(e.message, \"Expected three to be a number\")\n\n### Observable.typeFilter\n\nFilters out all stream values that are not of the specified type.\n\n    Bacon.fromArray([1, \"two\", 3, true, 4])\n         .typeFilter(Types.Number)\n         .slidingWindow(3,3)\n         .onValue (arr) ->\n           assert.deepEqual(arr, [1, 3, 4])\n\n### Observable.typeWarn\n\nWill warn about type mismatches but will not interfere with the stream\n\n    # logs \"Expected true to be a number\"\n    Bacon.fromArray([5, true, \"test\", null])\n         .typeWarn(Types.Number().or(Types.Null).or(Types.String))\n         .slidingWindow(4,4)\n         .onValue (arr) ->\n           assert.deepEqual(arr, [5, true, \"test\", null])\n\n### Chaining types\n\nTypes can be chained using the `or` method.\n\n    Bacon.fromArray([5, true, \"test\", null])\n         .typeCheck(Types.Number().or(Types.Null).or(Types.String))\n         .slidingWindow(3,3)\n         .onValue (arr) ->\n           assert.deepEqual(arr, [5, \"test\", null])\n\n### Types.Object\n\nTypes.Object can be passed a JS object containing child types with infinite deepness(as long as the call stack holds).\n\n    person = {\n      name: \"Johann\",\n      languages: 5\n    }\n\n    Bacon.once(person)\n         .typeCheck(Types.Object({\n           name: Types.String,\n           languages: Types.Array\n         }))\n         .onError (e) ->\n           assert(e instanceof Error)\n           assert.equal(e.message, \"Expected 5 to be an array\")\n\n### Types.Array\n\nTypes.Array can receive an object with a length parameter, specifying the exact length of the array.\n\n    Bacon.once([1,2,3,4])\n         .typeCheck(Types.Array(length: 5))\n         .onError (e) ->\n           assert(e instanceof Error)\n           assert.equal(e.message, \"Expected [1,2,3,4] to have a length of 5\")\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8aa40721e5af6a4519df3eebeaa3331c34522a66","subject":"Bugfix.","message":"Bugfix.\n","repos":"mxipartners\/checksome,fniessink\/checksome","old_file":"server\/sonar.litcoffee","new_file":"server\/sonar.litcoffee","new_contents":"This job collects data from Sonar for the Sonar keys in the `SubjectSourceIds`\ncollection.\n\n    class @SonarJob extends Job\n      @setupCron: (parser) ->\n        parser.recur().every(1).minute()\n\n      handleJob: ->\n        for subject_source_id in SubjectSourceIds.find().fetch()\n          source = Sources.findOne({_id: subject_source_id.source})\n          if source.type != 'sonar'\n            continue\n          @measure_ncloc subject_source_id, source\n\n      measure_ncloc: (subject_source_id, source) ->\n        metric = new NCLOC()\n        subject = Subjects.findOne {_id: subject_source_id.subject}\n        title = metric.title() + \" \" + subject.title\n        sonar_key = subject_source_id.id\n        result = @get_json source.url, sonar_key\n        if result.json\n          for sonar_metric in result.json[0]['msr']\n            if sonar_metric['key'] == 'ncloc'\n              ncloc = sonar_metric['val']\n        if result.error_message\n          description = result.error_message\n        else\n          target_met = metric.meets_target(ncloc)\n          description = ncloc + ' LOC'\n        insertOrUpdateMeasurement\n          projectId: source.projectId\n          title: title\n          description: description\n          value: ncloc\n          target: metric.target\n          target_met: target_met\n        console.log(title, description, sonar_key, source.type, source.url, ncloc)\n\n      get_json: (sonar_url, sonar_key) ->\n        try\n          result = HTTP.get sonar_url + 'api\/resources?resource=' + sonar_key + '&metrics=true'\n          return {json: result.data, error_message: ''}\n        catch e\n          return {json: null, error_message: e.message}\n\n    Job.push new SonarJob\n","old_contents":"This job collects data from Sonar for the Sonar keys in the `SubjectSourceIds`\ncollection.\n\n    class @SonarJob extends Job\n      @setupCron: (parser) ->\n        parser.recur().every(1).minute()\n\n      handleJob: ->\n        for subject_source_id in SubjectSourceIds.find().fetch()\n          source = Sources.findOne({_id: subject_source_id.source})\n          if source.type != 'sonar'\n            continue\n          @measure_ncloc subject_source_id, source\n\n      measure_ncloc: (subject_source_id, source) ->\n        metric = new NCLOC()\n        subject = Subjects.findOne {_id: subject_source_id.subject}\n        title = metric.title() + \" \" + subject.title\n        sonar_key = subject_source_id.title\n        result = @get_json source.url, sonar_key\n        if result.json\n          for sonar_metric in result.json[0]['msr']\n            if sonar_metric['key'] == 'ncloc'\n              ncloc = sonar_metric['val']\n        if result.error_message\n          description = result.error_message\n        else\n          target_met = metric.meets_target(ncloc)\n          description = ncloc + ' LOC'\n        insertOrUpdateMeasurement\n          projectId: source.projectId\n          title: title\n          description: description\n          value: ncloc\n          target: metric.target\n          target_met: target_met\n        console.log(title, description, sonar_key, source.type, source.url, ncloc)\n\n      get_json: (sonar_url, sonar_key) ->\n        try\n          result = HTTP.get sonar_url + 'api\/resources?resource=' + sonar_key + '&metrics=true'\n          return {json: result.data, error_message: ''}\n        catch e\n          return {json: null, error_message: e.message}\n\n    Job.push new SonarJob\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"54b01e9708abaa5aff5ab15d2cc9a37aa4fd45b3","subject":"middleware.fromConfig, this is what I have been waiting for","message":"middleware.fromConfig, this is what I have been waiting for\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"client\/modules\/middleware.litcoffee","new_file":"client\/modules\/middleware.litcoffee","new_contents":"# Abstract middleware stacks\n\n    {EventEmitter} = require 'events'\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    exports.Middleware = class Middleware extends EventEmitter\n\nImplements a middleware stack. Middleware functions can be added to the stack\nwith `use`. Calling `dispatch` invokes the middleware functions serially.\n\nEach middleware accepts an arbitrary parameters and finally a `next` function.\nWhen a middleware finishes, it must call the `next` function. If there was an\nerror, it must be thrown or passed as the first argument to `next`. If no error\noccurred, `next` must be invoked without arguments.\n\nError-handling middleware can also be defined. These middleware take an\nadditional parameter at the beginning of the function signature: `error`.\nError-handling middleware are only called if a previous middleware threw or\npassed an error. Conversely, non-error-handling middleware are skipped if a\nprevious error occurred.\n\n## *constructor*\n\n*Create a middleware stack.*\n\n      constructor: -> @_middleware = []\n\n## Middlware#use\n\n* (function) `fn` - A middleware function.\n\n*Add a middleware function to the stack.*\n\n      use: (fn) -> @_middleware.push fn\n\n## Middleware#dispatch\n\n* (mixed) `...` - One or more values to pass to the middleware.\n* (function) `fn` - A function invoked when the middleware stack has\n  finished. If an error occurred, it will be passed as the first\n  argument.\n\n*Invoke the middleware functions serially.*\n\n      dispatch: (args..., fn) ->\n        self = this\n\n        index = 0\n\n        invoke = (error) ->\n\n          self.emit 'invoked', self._middleware[index - 1] if index > 0\n\nCall `fn` with any error if we're done.\n\n          return fn error if index is self._middleware.length\n\n          current = self._middleware[index++]\n\nError-handling middleware.\n\n          if current.length is args.length + 2\n\nAn error occurred previously.\n\n            if error?\n\nTry to invoke the middleware, if it throws, just catch the error and pass it\nalong.\n\n              try\n                localArgs = args.concat()\n                localArgs.unshift error\n                localArgs.push invoke\n                self.emit 'invoking', current\n                current localArgs...\n              catch error\n                invoke error\n\nNo previous error; skip this middleware.\n\n            else\n\n              invoke error\n\nNon-error-handling middleware.\n\n          else\n\nAn error occurred previously, skip this middleware.\n\n            if error?\n\n              invoke error\n\nNo previous error.\n\n            else\n\nTry to invoke the middleware, if it throws, just catch the error and pass it along.\n\n              try\n                localArgs = args.concat()\n                localArgs.push invoke\n                self.emit 'invoking', current\n                current localArgs...\n              catch error\n                invoke error\n\nKick things off.\n\n        invoke()\n\n    debug = require('debug') 'shrub:middleware'\n    debugSilly = require('debug') 'shrub-silly:middleware'\n\n## middleware.fromHook\n\n*Create a middleware stack from the results of a hook and path configuration.*\n\n    exports.fromHook = (hook, paths, args...) ->\n\n      middleware = new Middleware()\n\nInvoke the hook and `use` the middleware in the paths configuration order.\n\n      args.unshift hook\n      hookResults = pkgman.invoke args...\n      for path in paths ? []\n        continue unless (spec = hookResults[path])?\n\n        debugSilly \"- - #{spec.label}\"\n\n        for fn in spec.middleware ? []\n          fn.label = spec.label\n          middleware.use fn, spec.label\n\n      middleware.on 'invoking', (fn) -> debugSilly \"Invoking #{fn.label}\"\n      middleware.on 'invoked', (fn) -> debugSilly \"Invoked #{fn.label}\"\n\n      middleware\n\n## middleware.fromConfig\n\n*Create a middleware stack from a configuration path.*\n\n    exports.fromConfig = (path, args...) ->\n\n      configKey = if global? then 'packageSettings' else 'packageConfig'\n\n      exports.fromHook(\n        pkgman.normalizePath path\n        config.get \"#{configKey}:#{path}\"\n      )\n\n## middleware.fromShortName\n\n*Create a middleware stack from a short name. e.g. \"example thing hook\".*\n\nThe short name is converted into log messages, a hook name, and configuration\nkey. In the case where we passed in \"user before login\", this would look\nlike:\n\n```coffeescript\ndebug \"Loading user before login middleware...\"\n\nmiddleware = exports.fromHook(\n\t\"userBeforeLoginMiddleware\"\n\tconfig.get \"packageSettings:user:beforeLoginMiddleware\"\n)\n\ndebug \"User before login middleware loaded.\"\n```\n\n###### TODO: This is bad and it should go away.\n\n    exports.fromShortName = (shortName, packageName) ->\n\n      i8n = require 'inflection'\n\n      debugSilly \"- Loading #{shortName} middleware...\"\n\n      [firstPart, keyParts...] = shortName.split ' '\n      packageName ?= firstPart\n      key = keyParts.join '_'\n\n###### TODO: this really should be unified, making this unnecessary.\n\n      configKey = if global? then 'packageSettings' else 'packageConfig'\n\n      middleware = exports.fromHook(\n        \"#{firstPart}#{i8n.camelize key}Middleware\"\n\n###### TODO: Multiline\n\n        config.get \"#{configKey}:#{packageName}:#{i8n.camelize key, true}Middleware\"\n      )\n\n      debugSilly \"- #{i8n.capitalize shortName} middleware loaded.\"\n\n      middleware\n","old_contents":"# Abstract middleware stacks\n\n    {EventEmitter} = require 'events'\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    exports.Middleware = class Middleware extends EventEmitter\n\nImplements a middleware stack. Middleware functions can be added to the stack\nwith `use`. Calling `dispatch` invokes the middleware functions serially.\n\nEach middleware accepts an arbitrary parameters and finally a `next` function.\nWhen a middleware finishes, it must call the `next` function. If there was an\nerror, it must be thrown or passed as the first argument to `next`. If no error\noccurred, `next` must be invoked without arguments.\n\nError-handling middleware can also be defined. These middleware take an\nadditional parameter at the beginning of the function signature: `error`.\nError-handling middleware are only called if a previous middleware threw or\npassed an error. Conversely, non-error-handling middleware are skipped if a\nprevious error occurred.\n\n## *constructor*\n\n*Create a middleware stack.*\n\n      constructor: -> @_middleware = []\n\n## Middlware#use\n\n* (function) `fn` - A middleware function.\n\n*Add a middleware function to the stack.*\n\n      use: (fn) -> @_middleware.push fn\n\n## Middleware#dispatch\n\n* (mixed) `...` - One or more values to pass to the middleware.\n* (function) `fn` - A function invoked when the middleware stack has\n  finished. If an error occurred, it will be passed as the first\n  argument.\n\n*Invoke the middleware functions serially.*\n\n      dispatch: (args..., fn) ->\n        self = this\n\n        index = 0\n\n        invoke = (error) ->\n\n          self.emit 'invoked', self._middleware[index - 1] if index > 0\n\nCall `fn` with any error if we're done.\n\n          return fn error if index is self._middleware.length\n\n          current = self._middleware[index++]\n\nError-handling middleware.\n\n          if current.length is args.length + 2\n\nAn error occurred previously.\n\n            if error?\n\nTry to invoke the middleware, if it throws, just catch the error and pass it\nalong.\n\n              try\n                localArgs = args.concat()\n                localArgs.unshift error\n                localArgs.push invoke\n                self.emit 'invoking', current\n                current localArgs...\n              catch error\n                invoke error\n\nNo previous error; skip this middleware.\n\n            else\n\n              invoke error\n\nNon-error-handling middleware.\n\n          else\n\nAn error occurred previously, skip this middleware.\n\n            if error?\n\n              invoke error\n\nNo previous error.\n\n            else\n\nTry to invoke the middleware, if it throws, just catch the error and pass it along.\n\n              try\n                localArgs = args.concat()\n                localArgs.push invoke\n                self.emit 'invoking', current\n                current localArgs...\n              catch error\n                invoke error\n\nKick things off.\n\n        invoke()\n\n    debug = require('debug') 'shrub:middleware'\n    debugSilly = require('debug') 'shrub-silly:middleware'\n\n## middleware.fromHook\n\n*Create a middleware stack from the results of a hook and path configuration.*\n\n    exports.fromHook = (hook, paths, args...) ->\n\n      middleware = new Middleware()\n\nInvoke the hook and `use` the middleware in the paths configuration order.\n\n      args.unshift hook\n      hookResults = pkgman.invoke args...\n      for path in paths ? []\n        continue unless (spec = hookResults[path])?\n\n        debugSilly \"- - #{spec.label}\"\n\n        for fn in spec.middleware ? []\n          fn.label = spec.label\n          middleware.use fn, spec.label\n\n      middleware.on 'invoking', (fn) -> debugSilly \"Invoking #{fn.label}\"\n      middleware.on 'invoked', (fn) -> debugSilly \"Invoked #{fn.label}\"\n\n      middleware\n\n## middleware.fromShortName\n\n*Create a middleware stack from a short name. e.g. \"example thing hook\".*\n\nThe short name is converted into log messages, a hook name, and configuration\nkey. In the case where we passed in \"user before login\", this would look\nlike:\n\n```coffeescript\ndebug \"Loading user before login middleware...\"\n\nmiddleware = exports.fromHook(\n\t\"userBeforeLoginMiddleware\"\n\tconfig.get \"packageSettings:user:beforeLoginMiddleware\"\n)\n\ndebug \"User before login middleware loaded.\"\n```\n\n###### TODO: This is bad and it should go away.\n\n    exports.fromShortName = (shortName, packageName) ->\n\n      i8n = require 'inflection'\n\n      debugSilly \"- Loading #{shortName} middleware...\"\n\n      [firstPart, keyParts...] = shortName.split ' '\n      packageName ?= firstPart\n      key = keyParts.join '_'\n\n###### TODO: this really should be unified, making this unnecessary.\n\n      configKey = if global? then 'packageSettings' else 'packageConfig'\n\n      middleware = exports.fromHook(\n        \"#{firstPart}#{i8n.camelize key}Middleware\"\n\n        config.get \"#{configKey}:#{packageName}:#{\n          i8n.camelize key, true\n        }Middleware\"\n      )\n\n      debugSilly \"- #{i8n.capitalize shortName} middleware loaded.\"\n\n      middleware\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b75f5c74eed501c8cfb5369fb3d6b863afdfb672","subject":"Fix test using the old constructor","message":"Fix test using the old constructor\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/01_batman.litcoffee","new_file":"docs\/01_batman.litcoffee","new_contents":"# Batman\n\nBatman includes a number of useful, general purpose helper functions and references. They can all be found attached to the `Batman` object and can optionally be exported into the global namespace with a `$` prefix.\n\n## container\n\n`Batman.container` points to either the `window` object if running in the browser, or the `global` object if running in node. This is useful if you want to add something to the global scope in all environments.\n\n## @typeOf(object) : string\n\n`typeOf` determines a more specific type of an `object` than the native `typeof` operator in JavaScript. This is useful for a number of situations like dealing with `Object` promoted strings and numbers, or arrays which look like `object`s to `typeof`. Use `typeOf` when you need more than `\"object\"` from `typeof`.\n\n_Note_: `typeOf` is substantially slower than `typeof`. `typeOf` works in a somewhat hackish manner by getting the `Object::toString` representation of the object and slicing it to retrieve the name of the constructor.\n\n    test 'typeOf returns \"String\" for both strings and Object strings', ->\n      primitive = \"test\"\n      objectified = new String(\"test\")\n      equal typeof primitive, \"string\"\n      equal typeof objectified, \"object\"\n      equal Batman.typeOf(primitive), \"String\"\n      equal Batman.typeOf(objectified), \"String\"\n\n    test 'typeOf returns Array for arrays', ->\n      array = [];\n      equal typeof array, \"object\"\n      equal Batman.typeOf(array), \"Array\"\n\n## @mixin(subject, objects...) : subject\n\n`mixin`, occasionally known elsewhere as `extend` or `merge`, flattens a series of objects onto the subject. Key\/value pairs on objects passed as later arguments (arguments with a higher index) take precedence over earlier arguments. Returns the `subject` passed in with the new values.\n\n`mixin` also has special properties that make it different than the canonical `extend` functions:\n\n 1. If the `subject` has a `set` function, `subject.set(key, value)` will be used to apply keys instead of `subject[key] = value`. This means that if the subject is a `Batman.Object`, observers and thus bindings on the object will be notified when other (Batmanified or not) objects are mixed into it.\n 2. If a mixed-in `object` has an `initialize` function defined, that function will be called and passed the `subject`. This is useful for custom extension logic, similar to `self.included` in Ruby. For this reason, the keys `initialize` and `uninitialize` are skipped by `mixin`.\n 3. `mixin` only iterates over keys for which the `hasOwnProperty` test passes.\n\n_Note_: `mixin` is destructive to (only) the first argument. If you need a non-destructive version of `mixin`, just pass an empty object as the first object, and all keys from the successive arguments will be applied to the empty object.\n\n    test 'mixin merges argument objects', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {fit: true}, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual subject, {fit: true, fly: true, funky: true}, \"the subject is modified destructively\"\n\n    test 'mixin merges argument objects', ->\n      unmodified = {fit: true}\n      deepEqual Batman.mixin({}, unmodified, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual unmodified, {fit: true}, \"argument objects are untouched allowing non-destructive merge\"\n\n    test 'mixed in objects passed as higher indexed arguments take precedence', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {x: 1, y: 1}, {x: 2}), {x: 2, y: 1}\n\n## @unmixin(subject, objects...) : subject\n\n`unmixin` \"unmerges\" the passed objects from the `subject`. If a key exists on any of the `objects` it will be `delete`d from the `subject`. Returns the `subject`.\n\n`unmixin`, similar to `mixin`, supports calling an `uninitialize` function for each of the `objects` being unmixed in. If an `uninitialize` function exists on each\n\n    test 'unmixin removes keys found on the unmixined objects on the subject', ->\n      subject = {fit: true, fly: true, funky: true}\n      deepEqual Batman.unmixin(subject, {fit: true}, {fly: true}), {funky: true}, \"unmixin returns the subject\"\n      deepEqual subject, {funky: true}, \"the subject is destructively modified.\"\n\n## @functionName(function) : string\n\n`functionName` returns the name of a given function, if any. Works with Internet Explorer 7\/8\/9, FireFox, Chrome, and Safari.\n\n    test 'functionName returns the name of a given function', ->\n      equal Batman.functionName(\"\".toString), 'toString'\n\n## @isChildOf(parent : HTMLElement, child : HTMLElement) : boolean\n\n`isChildOf` is a simple DOM helper which returns a boolean describing if the passed `child` node can be found in the descendants of the passed `parent` node.\n\n## @setImmediate(callback : Function) : object\n\n`setImmediate` (and its sister `clearImmediate`) are a more efficient version of `setTimeout(callback, 0)`. Due to timer resolution issues, setTimeout passed a timeout of 0 doesn't actually execute the function as soon as the JS execution stack has been emptied, but at minimum 4ms and maxmium 25ms after. For this reason Batman provides a cross browser implementation of `setImmediate` which does its best to call the callback immediately after the stack empties. Batman's `setImmediate` polyfill uses the native version if available, `window.postmessage` trickery if supported, and falls back on `setTimeout(->, 0)`.\n\n`setImmediate` returns a handle which can be passed to `clearImmediate` to cancel the future calling of the callback.\n\n## @clearImmediate(handle)\n\n`clearImmediate` stops the calling of a callback in the future when passed its `handle` (which is returned from the `setImmediate` call used to enqueue it).\n\n## @forEach(iterable : object, iterator : Function[, context : Object])\n\nThe `forEach` Batman helper is a universal iteration helper. When passed an `iterable` object, the helper will call the `iterator` (optionally in the `context`) for each item in the `iterable`. The `iterable` can be:\n\n 1. something which has its own `forEach`, in which case the `iterator` will just be passed to `iterable.forEach`.\n 2. an array like object, in which case a JavaScript `for(;;)` loop will be used to iterate over each entry\n 3. or an object, in which case a JavaScript `for-in` loop will be used to iterate over each entry.\n\nThe `forEach` helper is useful for iterating over objects when the type of those objects isn't guaranteed.\n\n    test 'forEach iterates over objects with forEach defined', ->\n      results = []\n      set = new Batman.SimpleSet ['a']\n      Batman.forEach(set, (x) -> results.push(x))\n      deepEqual results, ['a']\n\n    test 'forEach iterates over array like objects', ->\n      results = []\n      ArrayLike = ->\n      ArrayLike:: = []\n      imitation = new ArrayLike\n      Array::push.call(imitation, \"a\")\n      Array::push.call(imitation, \"b\")\n      Batman.forEach(imitation, (x) -> results.push(x))\n      deepEqual results, ['a', 'b']\n\n    test 'forEach iterates over objects', ->\n      result = {}\n      object = {x: true}\n      Batman.forEach(object, (key, val) -> result[key] = val)\n      deepEqual result, object\n\n## @objectHasKey(object, key) : boolean\n\n`objectHasKey` returns a boolean describing the presence of the `key` in the passed `object`. `objectHasKey` delegates to the `object`'s `hasKey` function if present, and otherwise just does a check using the JavaScript `in` operator.\n\n    test 'objectHasKey verifies if a key is present in an object', ->\n      subject = {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n    test 'objectHasKey verifies if a key is present in an object with `hasKey` defined', ->\n      subject = new Batman.SimpleHash {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n## @contains(object, item) : boolean\n\n`contains` returns a boolean describing if the given `object` has member `item`. Membership in this context is defined as:\n\n + the result of `object.has(item)` if the `object` has a `has` function defined\n + the result of `item in object` if the `object` is arraylike\n + the result of the Batman.objectHasKey otherwise\n\n_Note_: When passed an object without a `has` function, `contains` will return `true` if the `object` has `item` as a *`key`*, not as a value at any key.\n\n`contains` is useful for checking item membership when the type of the object can't be relied on.\n\n## @get(object, key) : value\n\n`get` is a general purpose function for retrieving the value from a `key` on an `object` of an indeterminate type. This is useful if code needs to work with both `Batman.Object`s and Plain Old JavaScript Objects. `get` has the following semantics:\n\n- if the `object` has a `get` function defined, return the result of `object.get(key)`\n- if the object does not have a `get` function defined, use an ephemeral `Batman.Property` to retrieve the key. This is equivalent to `object[key]` for single segment `key`s, but if the `key` is multi-segment (example: 'product.customer.name'), `get` will do nested gets until the either `undefined` or the end of the keypath is reached.\n\n<!-- tests -->\n\n    test 'get returns the value at a key on a POJO', ->\n      subject = {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a key on a Batman.Object', ->\n      subject = Batman {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a deep key on a POJO', ->\n      subject = {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n    test 'get returns the value at a deep key on a Batman.Object', ->\n      subject = Batman {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n## @getPath(base, segments) : string\n\n`getPath` returns the hash value denoted by the specified path, which consists of an array of nested hash keys. See examples below for more detail.\n\n    test \"takes a base and an array of keys and returns the corresponding nested value\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo', 'bar']), 'nested value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo.bar']), 'flat value'\n      strictEqual Batman.getPath(@complexObject, ['hash', 'not-foo', 'bar']), undefined\n\n    test \"returns just the base if the key array is empty\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(@complexObject, []), @complexObject\n      strictEqual Batman.getPath(null, []), null\n\n    test \"returns undefined if the base is null-ish\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(null, ['foo']), undefined\n      strictEqual Batman.getPath(undefined, ['foo']), undefined\n\n    test \"returns falsy values\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(num: 0, ['num']), 0\n      strictEqual Batman.getPath(thing: null, ['thing']), null\n\n## @escapeHTML(input) : string\n\n`escapeHTML` takes a string of unknown origin and makes it safe for display on a web page by encoding control characters in HTML into their HTML entities.\n\n*Warning*: Do not rely on `escapeHTML` to purge unsafe data from user submitted content. While `escapeHTML` is applied to every binding's contents by default, it should not be your only line of defence against script injection attacks.\n\n    test 'escapeHTML encodes special characters into HTML entities', ->\n      equal Batman.escapeHTML(\"& < > \\\" '\"), \"&amp; &lt; &gt; &#34; &#39;\"\n\n## @redirect(options: [string|Object])\n\nRedirects to a new path with either pushState or hashbang navigation, depending on your [configuration](\/docs\/configuration.html). `options` may be:\n\n- a string, which is treated as the target path (eg, `\"\/posts\"`)\n- a `Batman.Model` class, which redirects to \"index\" (eg, `Batman.redirect(MyApp.Post)` redirects to `\"\/posts\"`)\n- a `Batman.Model` instance, which redirects to \"show\" (eg, `Batman.redirect(thisPost)` redirects to `\"\/posts\/#{thisPost.toParam()}\"`)\n- an object containing params:\n  - `Batman.redirect({controller: \"posts\", action: \"index\"})` redirects to  `\"\/posts\"`\n  - `Batman.redirect({controller: \"posts\", action: \"edit\", id: 6})` redirects to `\"\/posts\/6\/edit\"`\n","old_contents":"# Batman\n\nBatman includes a number of useful, general purpose helper functions and references. They can all be found attached to the `Batman` object and can optionally be exported into the global namespace with a `$` prefix.\n\n## container\n\n`Batman.container` points to either the `window` object if running in the browser, or the `global` object if running in node. This is useful if you want to add something to the global scope in all environments.\n\n## @typeOf(object) : string\n\n`typeOf` determines a more specific type of an `object` than the native `typeof` operator in JavaScript. This is useful for a number of situations like dealing with `Object` promoted strings and numbers, or arrays which look like `object`s to `typeof`. Use `typeOf` when you need more than `\"object\"` from `typeof`.\n\n_Note_: `typeOf` is substantially slower than `typeof`. `typeOf` works in a somewhat hackish manner by getting the `Object::toString` representation of the object and slicing it to retrieve the name of the constructor.\n\n    test 'typeOf returns \"String\" for both strings and Object strings', ->\n      primitive = \"test\"\n      objectified = new String(\"test\")\n      equal typeof primitive, \"string\"\n      equal typeof objectified, \"object\"\n      equal Batman.typeOf(primitive), \"String\"\n      equal Batman.typeOf(objectified), \"String\"\n\n    test 'typeOf returns Array for arrays', ->\n      array = [];\n      equal typeof array, \"object\"\n      equal Batman.typeOf(array), \"Array\"\n\n## @mixin(subject, objects...) : subject\n\n`mixin`, occasionally known elsewhere as `extend` or `merge`, flattens a series of objects onto the subject. Key\/value pairs on objects passed as later arguments (arguments with a higher index) take precedence over earlier arguments. Returns the `subject` passed in with the new values.\n\n`mixin` also has special properties that make it different than the canonical `extend` functions:\n\n 1. If the `subject` has a `set` function, `subject.set(key, value)` will be used to apply keys instead of `subject[key] = value`. This means that if the subject is a `Batman.Object`, observers and thus bindings on the object will be notified when other (Batmanified or not) objects are mixed into it.\n 2. If a mixed-in `object` has an `initialize` function defined, that function will be called and passed the `subject`. This is useful for custom extension logic, similar to `self.included` in Ruby. For this reason, the keys `initialize` and `uninitialize` are skipped by `mixin`.\n 3. `mixin` only iterates over keys for which the `hasOwnProperty` test passes.\n\n_Note_: `mixin` is destructive to (only) the first argument. If you need a non-destructive version of `mixin`, just pass an empty object as the first object, and all keys from the successive arguments will be applied to the empty object.\n\n    test 'mixin merges argument objects', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {fit: true}, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual subject, {fit: true, fly: true, funky: true}, \"the subject is modified destructively\"\n\n    test 'mixin merges argument objects', ->\n      unmodified = {fit: true}\n      deepEqual Batman.mixin({}, unmodified, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual unmodified, {fit: true}, \"argument objects are untouched allowing non-destructive merge\"\n\n    test 'mixed in objects passed as higher indexed arguments take precedence', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {x: 1, y: 1}, {x: 2}), {x: 2, y: 1}\n\n## @unmixin(subject, objects...) : subject\n\n`unmixin` \"unmerges\" the passed objects from the `subject`. If a key exists on any of the `objects` it will be `delete`d from the `subject`. Returns the `subject`.\n\n`unmixin`, similar to `mixin`, supports calling an `uninitialize` function for each of the `objects` being unmixed in. If an `uninitialize` function exists on each\n\n    test 'unmixin removes keys found on the unmixined objects on the subject', ->\n      subject = {fit: true, fly: true, funky: true}\n      deepEqual Batman.unmixin(subject, {fit: true}, {fly: true}), {funky: true}, \"unmixin returns the subject\"\n      deepEqual subject, {funky: true}, \"the subject is destructively modified.\"\n\n## @functionName(function) : string\n\n`functionName` returns the name of a given function, if any. Works with Internet Explorer 7\/8\/9, FireFox, Chrome, and Safari.\n\n    test 'functionName returns the name of a given function', ->\n      equal Batman.functionName(\"\".toString), 'toString'\n\n## @isChildOf(parent : HTMLElement, child : HTMLElement) : boolean\n\n`isChildOf` is a simple DOM helper which returns a boolean describing if the passed `child` node can be found in the descendants of the passed `parent` node.\n\n## @setImmediate(callback : Function) : object\n\n`setImmediate` (and its sister `clearImmediate`) are a more efficient version of `setTimeout(callback, 0)`. Due to timer resolution issues, setTimeout passed a timeout of 0 doesn't actually execute the function as soon as the JS execution stack has been emptied, but at minimum 4ms and maxmium 25ms after. For this reason Batman provides a cross browser implementation of `setImmediate` which does its best to call the callback immediately after the stack empties. Batman's `setImmediate` polyfill uses the native version if available, `window.postmessage` trickery if supported, and falls back on `setTimeout(->, 0)`.\n\n`setImmediate` returns a handle which can be passed to `clearImmediate` to cancel the future calling of the callback.\n\n## @clearImmediate(handle)\n\n`clearImmediate` stops the calling of a callback in the future when passed its `handle` (which is returned from the `setImmediate` call used to enqueue it).\n\n## @forEach(iterable : object, iterator : Function[, context : Object])\n\nThe `forEach` Batman helper is a universal iteration helper. When passed an `iterable` object, the helper will call the `iterator` (optionally in the `context`) for each item in the `iterable`. The `iterable` can be:\n\n 1. something which has its own `forEach`, in which case the `iterator` will just be passed to `iterable.forEach`.\n 2. an array like object, in which case a JavaScript `for(;;)` loop will be used to iterate over each entry\n 3. or an object, in which case a JavaScript `for-in` loop will be used to iterate over each entry.\n\nThe `forEach` helper is useful for iterating over objects when the type of those objects isn't guaranteed.\n\n    test 'forEach iterates over objects with forEach defined', ->\n      results = []\n      set = new Batman.SimpleSet('a')\n      Batman.forEach(set, (x) -> results.push(x))\n      deepEqual results, ['a']\n\n    test 'forEach iterates over array like objects', ->\n      results = []\n      ArrayLike = ->\n      ArrayLike:: = []\n      imitation = new ArrayLike\n      Array::push.call(imitation, \"a\")\n      Array::push.call(imitation, \"b\")\n      Batman.forEach(imitation, (x) -> results.push(x))\n      deepEqual results, ['a', 'b']\n\n    test 'forEach iterates over objects', ->\n      result = {}\n      object = {x: true}\n      Batman.forEach(object, (key, val) -> result[key] = val)\n      deepEqual result, object\n\n## @objectHasKey(object, key) : boolean\n\n`objectHasKey` returns a boolean describing the presence of the `key` in the passed `object`. `objectHasKey` delegates to the `object`'s `hasKey` function if present, and otherwise just does a check using the JavaScript `in` operator.\n\n    test 'objectHasKey verifies if a key is present in an object', ->\n      subject = {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n    test 'objectHasKey verifies if a key is present in an object with `hasKey` defined', ->\n      subject = new Batman.SimpleHash {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n## @contains(object, item) : boolean\n\n`contains` returns a boolean describing if the given `object` has member `item`. Membership in this context is defined as:\n\n + the result of `object.has(item)` if the `object` has a `has` function defined\n + the result of `item in object` if the `object` is arraylike\n + the result of the Batman.objectHasKey otherwise\n\n_Note_: When passed an object without a `has` function, `contains` will return `true` if the `object` has `item` as a *`key`*, not as a value at any key.\n\n`contains` is useful for checking item membership when the type of the object can't be relied on.\n\n## @get(object, key) : value\n\n`get` is a general purpose function for retrieving the value from a `key` on an `object` of an indeterminate type. This is useful if code needs to work with both `Batman.Object`s and Plain Old JavaScript Objects. `get` has the following semantics:\n\n- if the `object` has a `get` function defined, return the result of `object.get(key)`\n- if the object does not have a `get` function defined, use an ephemeral `Batman.Property` to retrieve the key. This is equivalent to `object[key]` for single segment `key`s, but if the `key` is multi-segment (example: 'product.customer.name'), `get` will do nested gets until the either `undefined` or the end of the keypath is reached.\n\n<!-- tests -->\n\n    test 'get returns the value at a key on a POJO', ->\n      subject = {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a key on a Batman.Object', ->\n      subject = Batman {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a deep key on a POJO', ->\n      subject = {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n    test 'get returns the value at a deep key on a Batman.Object', ->\n      subject = Batman {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n## @getPath(base, segments) : string\n\n`getPath` returns the hash value denoted by the specified path, which consists of an array of nested hash keys. See examples below for more detail.\n\n    test \"takes a base and an array of keys and returns the corresponding nested value\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo', 'bar']), 'nested value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo.bar']), 'flat value'\n      strictEqual Batman.getPath(@complexObject, ['hash', 'not-foo', 'bar']), undefined\n\n    test \"returns just the base if the key array is empty\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(@complexObject, []), @complexObject\n      strictEqual Batman.getPath(null, []), null\n\n    test \"returns undefined if the base is null-ish\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(null, ['foo']), undefined\n      strictEqual Batman.getPath(undefined, ['foo']), undefined\n\n    test \"returns falsy values\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(num: 0, ['num']), 0\n      strictEqual Batman.getPath(thing: null, ['thing']), null\n\n## @escapeHTML(input) : string\n\n`escapeHTML` takes a string of unknown origin and makes it safe for display on a web page by encoding control characters in HTML into their HTML entities.\n\n*Warning*: Do not rely on `escapeHTML` to purge unsafe data from user submitted content. While `escapeHTML` is applied to every binding's contents by default, it should not be your only line of defence against script injection attacks.\n\n    test 'escapeHTML encodes special characters into HTML entities', ->\n      equal Batman.escapeHTML(\"& < > \\\" '\"), \"&amp; &lt; &gt; &#34; &#39;\"\n\n## @redirect(options: [string|Object])\n\nRedirects to a new path with either pushState or hashbang navigation, depending on your [configuration](\/docs\/configuration.html). `options` may be:\n\n- a string, which is treated as the target path (eg, `\"\/posts\"`)\n- a `Batman.Model` class, which redirects to \"index\" (eg, `Batman.redirect(MyApp.Post)` redirects to `\"\/posts\"`)\n- a `Batman.Model` instance, which redirects to \"show\" (eg, `Batman.redirect(thisPost)` redirects to `\"\/posts\/#{thisPost.toParam()}\"`)\n- an object containing params:\n  - `Batman.redirect({controller: \"posts\", action: \"index\"})` redirects to  `\"\/posts\"`\n  - `Batman.redirect({controller: \"posts\", action: \"edit\", id: 6})` redirects to `\"\/posts\/6\/edit\"`\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"16998fd93bf747bba8e0c4dfbdbdbd44e779ae7d","subject":"Use prototypes instead of this directly","message":"Use prototypes instead of this directly\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                val\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = Madul.PARSE_SPEC val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE.call proto[ref], args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = Madul.PARSE_SPEC val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE.call proto[ref], args[key]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                if Array.isArray me.before\n                  before = me.before.map (b) => Madul.PARSE_SPEC(b).ref\n                else if typeof me.before == 'string'\n                  before = [ Madul.PARSE_SPEC(me.before).ref ]\n                else\n                  before = [ ]\n\n                if Array.isArray me.after\n                  after = me.after.map (a) => Madul.PARSE_SPEC(a).ref\n                else if typeof me.after == 'string'\n                  after = [ Madul.PARSE_SPEC(me.after).ref ]\n                else\n                  after = [ ]\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                val\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = Madul.PARSE_SPEC val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE.call proto[ref], args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = Madul.PARSE_SPEC val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE.call proto[ref], args[key]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                if Array.isArray me.before\n                  before = me.before.map (b) => Madul.PARSE_SPEC(b).ref\n                else if typeof me.before == 'string'\n                  before = [ Madul.PARSE_SPEC(me.before).ref ]\n                else\n                  before = [ ]\n\n                if Array.isArray me.after\n                  after = me.after.map (a) => Madul.PARSE_SPEC(a).ref\n                else if typeof me.after == 'string'\n                  after = [ Madul.PARSE_SPEC(me.after).ref ]\n                else\n                  after = [ ]\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"245903b7a68858c51cf37dabb52ddafc942bb372","subject":"fix issue during list item removal. properly handle rpc\/action execution context binding to 'kProp'. skip trying to chain binding with function\/action content for now","message":"fix issue during list item removal. properly handle rpc\/action execution context binding to 'kProp'. skip trying to chain binding with function\/action content for now\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object[Symbol.for('property')]` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property') # if process.env.DEBUG?\n    co       = require 'co'\n    delegate = require 'delegates'\n    clone    = require 'clone'\n    Emitter  = require('events').EventEmitter\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n    kProp    = Symbol.for('property')\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n        Object.setPrototypeOf @state, Emitter.prototype\n\n        @schema.kind ?= 'anydata'\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n        # expose the BoundThis for the set\/get\n        @set.bound = @get.bound = this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .method 'once'\n        .method 'on'\n        .access 'container'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, force: true\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'parent', get: -> @container?[kProp]\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n      \n      @property 'children',\n        get: ->\n          return [] unless @content instanceof Object\n          children = []\n          for own k of Object.keys(@content)\n            desc = Object.getOwnPropertyDescriptor(@content, k)\n            children.push desc.get.bound if desc?.get?.bound instanceof Property\n          return children\n      \n      @property 'key',\n        get: ->\n          return unless @schema is @parent?.schema\n          switch\n            when @content not instanceof Object  then @name + 1\n            when @content.hasOwnProperty('@key') then @content['@key']\n            when Array.isArray @container\n              for idx, item of @container when item is @content\n                idx = Number(idx) unless (Number.isNaN (Number idx))\n                return idx+1\n              return undefined\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          key = @key\n          return @state.path if @state.path? and not key?\n          @debug \"[path] #{@kind}(#{@name}) has #{key} #{typeof key}\"\n          entity = switch typeof key\n            when 'number' then \".[#{key}]\"\n            when 'string' then \".[key('#{key}')]\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          @debug \"[path] #{@parent.name} + #{entity}\"\n          return @state.path = @parent.path.clone().append entity\n\n## Instance-level methods\n\n      clone: ->\n        @debug \"[clone] cloning with #{@children.length} properties\"\n        copy = (new @constructor @name, @schema)\n        copy.state[k] = v for k, v of @state\n        return copy\n        \n      emit: (event) ->\n        @state.emit arguments...\n        unless this is @root\n          @debug \"[emit] '#{event}' to '#{@root.name}'\"\n          @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false, force: false }) ->\n        return obj unless obj instanceof Object\n\n        detached = true unless @container?\n        @container = obj\n\n        if Array.isArray(obj) and Array.isArray(@content)\n          @debug @content\n          throw @error \"cannot join array property into list container\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n\n        # if joining for the first time, apply existing data unless explicit replace\n        exists = obj[@name] \n        if detached and opts.replace isnt true\n          @debug \"[join] applying existing data for #{@name} to:\"\n          @debug obj\n          opts.suppress = true\n          @set exists, opts\n\n        # TODO: should produce meaningful warning?\n        try Object.defineProperty obj, @name, this\n        @debug \"[join] attached into #{obj.constructor.name} container\"\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern, prop=false) -> switch\n        when pattern? and prop then @in pattern\n        when pattern?\n          match = @find pattern\n          switch\n            when match.length is 1 then match[0].content\n            when match.length > 1  then match.map (x) -> x.content\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then switch\n          when @binding? then @do.bind this\n          else @content\n        else\n          if @binding? and not (@kind is 'list' and @key?)\n            try return @binding.call @context\n            catch e\n              throw @error \"issue executing registered function binding during get(): #{e.message}\", e\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        @debug \"[set] enter with:\"\n        @debug value\n        #@debug opts\n        return this if value is @content and not opts.force\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only element\"\n\n        try\n          unless value instanceof Function\n            if value[kProp] instanceof Property and value[kProp] isnt this\n              @debug \"[set] cloning existing property for assignment\"\n              value = clone(value)\n            value = Object.create(value) unless Object.isExtensible(value)\n          Object.defineProperty value, kProp, configurable: true, value: this\n\n        value = switch\n          when @schema.apply?\n            @schema.apply value, @context.with(opts)\n          else value\n        return this if value instanceof Error\n        try\n          Object.defineProperty value, kProp, value: this\n          Object.defineProperty value, '$', value: @get.bind(this)\n          if @schema.nodes.length and @kind isnt 'module'\n            for own k of value\n              desc = Object.getOwnPropertyDescriptor value, k\n              if desc.writable is true and not @schema.locate(k)?\n                @debug \"[set] hiding non-schema defined property: #{k}\"\n                Object.defineProperty value, k, enumerable: false\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        \n        if @binding?.length is 1 and not opts.force and @kind not in [ 'action', 'rpc' ]\n          try @binding.call @context, value \n          catch e\n            throw @error \"issue executing registered function binding during set(): #{e.message}\", e\n        else\n          @state.value = value\n\n        try Object.defineProperty @container, @name,\n          configurable: true\n          enumerable: @state.enumerable\n\n        @emit 'update', this if this is @root or not opts.suppress\n        @debug \"[set] completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        opts.replace ?= true\n        unless @content instanceof Object\n          opts.replace = false\n          return @set value, opts\n\n        value = value[@name] if value? and value.hasOwnProperty @name\n        return this unless value instanceof Object\n        \n        if Array.isArray @content\n          length = @content.length\n          @debug \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          @debug value\n          # here we clone this Property and update with only the newly merged values\n          # XXX - this logic needs refinement, it doesn't handle min-elements condition properly\n          value = [ value ] unless Array.isArray value\n          copy = @clone()\n          copy.set value, force: opts.force, suppress: true\n          @debug \"[merge] combining and applying schema\"\n          if @schema.key? and opts.replace\n            exists = {}\n            @content.forEach (item) ->\n              key = item['@key']\n              exists[key] = item\n            @debug \"[merge] reducing existing keys\"\n            conflicts = 0\n            newitems = copy.content.reduce ((a, item) ->\n              key = item['@key']\n              item[kProp].name -= conflicts\n              if key of exists\n                conflicts++\n                exists[key][kProp].merge item\n              else\n                a.push item\n              return a\n            ), []\n            combine = @content.concat newitems\n          else\n            newitems = copy.content\n            combine = @content.concat newitems\n          attr.apply combine for attr in @schema.attrs\n          newitems.forEach (item) =>\n            item[kProp].name += length\n            item[kProp].join @content, opts\n          @emit 'update', this unless opts.suppress\n          return copy\n        else\n          @debug \"[merge] merging into existing Object(#{Object.keys(@content).length}) for #{@name}\"\n          # TODO: protect this as a transaction?\n          @content[k] = v for own k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n          return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        if not @content? and @kind is 'list' and not Array.isArray value\n          value = [ value ] \n        res = @merge value, replace: false\n        @emit 'create', res\n        return res\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@container` parent object.\n      \n      remove: ->\n        return this unless @container?\n        if @key?\n          #@container.splice @name, 1\n          delete @container[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          Object.defineProperty @container, @name, enumerable: false\n        @emit 'update', @parent if @parent?\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        unless pattern instanceof XPath\n          if \/^\\.\\.\\\/\/.test(pattern) and @parent?\n            return @parent.find pattern.replace(\/^\\.\\.\\\/\/, ''), opts\n          if \/^\\\/\/.test(pattern) and this isnt @root\n            return @root.find pattern, opts\n          pattern = XPath.parse pattern, @schema\n          \n        @debug \"[find] using #{pattern}\"\n        if opts.root or not @container? or pattern.tag not in [ '\/', '..' ]\n          @debug \"[find] apply #{pattern}\"\n          @debug @content\n          pattern.apply(@content).props ? []\n        else switch\n          when pattern.tag is '\/'  and @parent? then @parent.find pattern, opts\n          when pattern.tag is '..' and @parent? then @parent.find pattern.xpath, opts\n          else []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n            \n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      invoke: ->\n        console.warn \"DEPRECATION: please use .do() instead\"\n        @do arguments...\n        \n      do: ->\n        unless (@binding instanceof Function) or (@content instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        try\n          @debug \"[do] executing method: #{@name}\"\n          ctx = @context\n          ctx.state[kProp] = this\n          @schema.input?.eval  ctx.state, {}\n          @schema.output?.eval ctx.state, {}\n          ctx.input = arguments\n          # first apply schema bound function (if availble), then\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function\"\n            @debug @binding.toString()\n            res = @binding.apply ctx, arguments\n            ctx.output ?= res\n          else\n            @debug \"[do] calling assigned function: #{@content.name}\"\n            @debug @content.toString()\n            ctx.output = @content.apply @container, arguments\n          return co =>\n            @debug \"[do] evaluating output schema\"\n            ctx.output = yield Promise.resolve ctx.output\n            @debug \"[do] finish setting output\"\n            @emit 'done', ctx\n            return ctx.output\n        catch e\n          @debug e\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        res = new Error \"[#{at}] #{msg}\"\n        res.name = 'PropertyError'\n        res.context = ctx\n        return res\n\n      debug: (msg) ->\n        if debug? then switch typeof msg\n          when 'object' then debug msg\n          else\n            node = this\n            prefix = [ @name ]\n            prefix.unshift node.name while (node = node.parent)\n            debug \"[#{prefix.join('\/')}] #{msg}\"\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          key:    @key\n          xpath:  @path.toString()\n          schema: @schema.toJSON tag: false, extended: true\n          active: @enumerable\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\ncurrent property's `@name`.\n\n      toJSON: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            for own k, v of src when typeof v isnt 'function'\n              res[k] = copy v\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object[Symbol.for('property')]` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property') # if process.env.DEBUG?\n    co       = require 'co'\n    delegate = require 'delegates'\n    clone    = require 'clone'\n    Emitter  = require('events').EventEmitter\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n    kProp    = Symbol.for('property')\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n        Object.setPrototypeOf @state, Emitter.prototype\n\n        @schema.kind ?= 'anydata'\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n        # expose the BoundThis for the set\/get\n        @set.bound = @get.bound = this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .method 'once'\n        .method 'on'\n        .access 'container'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, force: true\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'parent', get: -> @container?[kProp]\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n      \n      @property 'children',\n        get: ->\n          return [] unless @content instanceof Object\n          children = []\n          for own k of Object.keys(@content)\n            desc = Object.getOwnPropertyDescriptor(@content, k)\n            children.push desc.get.bound if desc?.get?.bound instanceof Property\n          return children\n      \n      @property 'key',\n        get: ->\n          return unless @schema is @parent?.schema\n          switch\n            when @content not instanceof Object  then @name + 1\n            when @content.hasOwnProperty('@key') then @content['@key']\n            when Array.isArray @container\n              for idx, item of @container when item is @content\n                idx = Number(idx) unless (Number.isNaN (Number idx))\n                return idx+1\n              return undefined\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          key = @key\n          return @state.path if @state.path? and not key?\n          @debug \"[path] #{@kind}(#{@name}) has #{key} #{typeof key}\"\n          entity = switch typeof key\n            when 'number' then \".[#{key}]\"\n            when 'string' then \".[key('#{key}')]\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          @debug \"[path] #{@parent.name} + #{entity}\"\n          return @state.path = @parent.path.clone().append entity\n\n## Instance-level methods\n\n      clone: ->\n        @debug \"[clone] cloning with #{@children.length} properties\"\n        copy = (new @constructor @name, @schema)\n        copy.state[k] = v for k, v of @state\n        return copy\n        \n      emit: (event) ->\n        @state.emit arguments...\n        unless this is @root\n          @debug \"[emit] '#{event}' to '#{@root.name}'\"\n          @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false, force: false }) ->\n        return obj unless obj instanceof Object\n\n        detached = true unless @container?\n        @container = obj\n\n        if Array.isArray(obj) and Array.isArray(@content)\n          @debug @content\n          throw @error \"cannot join array property into list container\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n\n        # if joining for the first time, apply existing data unless explicit replace\n        exists = obj[@name] \n        if detached and opts.replace isnt true\n          @debug \"[join] applying existing data for #{@name} to:\"\n          @debug obj\n          opts.suppress = true\n          @set exists, opts\n\n        # TODO: should produce meaningful warning?\n        try Object.defineProperty obj, @name, this\n        @debug \"[join] attached into #{obj.constructor.name} container\"\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern, prop=false) -> switch\n        when pattern? and prop then @in pattern\n        when pattern?\n          match = @find pattern\n          switch\n            when match.length is 1 then match[0].content\n            when match.length > 1  then match.map (x) -> x.content\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then switch\n          when @binding? then @do.bind this\n          else @content\n        else\n          if @binding? and not (@kind is 'list' and @key?)\n            try return @binding.call @context\n            catch e\n              throw @error \"issue executing registered function binding during get(): #{e.message}\", e\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        @debug \"[set] enter with:\"\n        @debug value\n        #@debug opts\n        return this if value is @content and not opts.force\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only element\"\n\n        try\n          unless value instanceof Function\n            if value[kProp] instanceof Property and value[kProp] isnt this\n              @debug \"[set] cloning existing property for assignment\"\n              value = clone(value)\n            value = Object.create(value) unless Object.isExtensible(value)\n          Object.defineProperty value, kProp, configurable: true, value: this\n\n        value = switch\n          when @schema.apply?\n            @schema.apply value, @context.with(opts)\n          else value\n        return this if value instanceof Error\n        try\n          Object.defineProperty value, kProp, value: this\n          Object.defineProperty value, '$', value: @get.bind(this)\n          if @schema.nodes.length and @kind isnt 'module'\n            for own k of value\n              desc = Object.getOwnPropertyDescriptor value, k\n              if desc.writable is true and not @schema.locate(k)?\n                @debug \"[set] hiding non-schema defined property: #{k}\"\n                Object.defineProperty value, k, enumerable: false\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        \n        if @binding?.length is 1 and not opts.force and @kind not in [ 'action', 'rpc' ]\n          try @binding.call @context, value \n          catch e\n            throw @error \"issue executing registered function binding during set(): #{e.message}\", e\n        else\n          @state.value = value\n\n        try Object.defineProperty @container, @name,\n          configurable: true\n          enumerable: @state.enumerable\n\n        @emit 'update', this if this is @root or not opts.suppress\n        @debug \"[set] completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        opts.replace ?= true\n        unless @content instanceof Object\n          opts.replace = false\n          return @set value, opts\n\n        value = value[@name] if value? and value.hasOwnProperty @name\n        return this unless value instanceof Object\n        \n        if Array.isArray @content\n          length = @content.length\n          @debug \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          @debug value\n          # here we clone this Property and update with only the newly merged values\n          # XXX - this logic needs refinement, it doesn't handle min-elements condition properly\n          value = [ value ] unless Array.isArray value\n          copy = @clone()\n          copy.set value, force: opts.force, suppress: true\n          @debug \"[merge] combining and applying schema\"\n          if @schema.key? and opts.replace\n            exists = {}\n            @content.forEach (item) ->\n              key = item['@key']\n              exists[key] = item\n            @debug \"[merge] reducing existing keys\"\n            conflicts = 0\n            newitems = copy.content.reduce ((a, item) ->\n              key = item['@key']\n              item[kProp].name -= conflicts\n              if key of exists\n                conflicts++\n                exists[key][kProp].merge item\n              else\n                a.push item\n              return a\n            ), []\n            combine = @content.concat newitems\n          else\n            newitems = copy.content\n            combine = @content.concat newitems\n          attr.apply combine for attr in @schema.attrs\n          newitems.forEach (item) =>\n            item[kProp].name += length\n            item[kProp].join @content, opts\n          @emit 'update', this unless opts.suppress\n          return copy\n        else\n          @debug \"[merge] merging into existing Object(#{Object.keys(@content).length}) for #{@name}\"\n          # TODO: protect this as a transaction?\n          @content[k] = v for own k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n          return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        if not @content? and @kind is 'list' and not Array.isArray value\n          value = [ value ] \n        res = @merge value, replace: false\n        @emit 'create', res\n        return res\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@container` parent object.\n      \n      remove: ->\n        return this unless @container?\n        if @key?\n          @container.splice @name, 1\n          #delete @parent[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          Object.defineProperty @container, @name, enumerable: false\n        @emit 'update', @parent if @parent?\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        unless pattern instanceof XPath\n          if \/^\\.\\.\\\/\/.test(pattern) and @parent?\n            return @parent.find pattern.replace(\/^\\.\\.\\\/\/, ''), opts\n          if \/^\\\/\/.test(pattern) and this isnt @root\n            return @root.find pattern, opts\n          pattern = XPath.parse pattern, @schema\n          \n        @debug \"[find] using #{pattern}\"\n        if opts.root or not @container? or pattern.tag not in [ '\/', '..' ]\n          @debug \"[find] apply #{pattern}\"\n          @debug @content\n          pattern.apply(@content).props ? []\n        else switch\n          when pattern.tag is '\/'  and @parent? then @parent.find pattern, opts\n          when pattern.tag is '..' and @parent? then @parent.find pattern.xpath, opts\n          else []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n            \n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      invoke: ->\n        console.warn \"DEPRECATION: please use .do() instead\"\n        @do arguments...\n        \n      do: ->\n        unless (@binding instanceof Function) or (@content instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        try\n          @debug \"[do] executing method: #{@name}\"\n          obj = {}\n          obj[kProp] = this\n          ctx = @context.with(obj)\n          @schema.input?.eval  ctx.state, {}\n          @schema.output?.eval ctx.state, {}\n          ctx.input = arguments\n          # first apply schema bound function (if availble), then\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function\"\n            @debug @binding.toString()\n            res = @binding.apply ctx, arguments\n            ctx.output ?= res\n          if @content? and @content isnt @binding\n            if (not @binding?) or @content.name isnt 'missing'\n              @debug \"[do] calling assigned function: #{@content.name}\"\n              @debug @content.toString()\n              ctx.output = @content.apply @container, arguments\n          return co =>\n            @debug \"[do] evaluating output schema\"\n            ctx.output = yield Promise.resolve ctx.output\n            @debug \"[do] finish setting output\"\n            @emit 'done', ctx\n            return ctx.output\n        catch e\n          @debug e\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        res = new Error \"[#{at}] #{msg}\"\n        res.name = 'PropertyError'\n        res.context = ctx\n        return res\n\n      debug: (msg) ->\n        if debug? then switch typeof msg\n          when 'object' then debug msg\n          else\n            node = this\n            prefix = [ @name ]\n            prefix.unshift node.name while (node = node.parent)\n            debug \"[#{prefix.join('\/')}] #{msg}\"\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          key:    @key\n          xpath:  @path.toString()\n          schema: @schema.toJSON tag: false, extended: true\n          active: @enumerable\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\ncurrent property's `@name`.\n\n      toJSON: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            for own k, v of src when typeof v isnt 'function'\n              res[k] = copy v\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"3cbb04331c33e8e804b64ddd6caaf378193f93f0","subject":"Refactor status return handling","message":"Refactor status return handling\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/system.litcoffee","new_file":"coffee\/system.litcoffee","new_contents":"    redis = require '.\/db\/redis'\n    mongo = require '.\/db\/mongo'\n\n## check()\n\nThis is the system check. It retrives the current status from Redis and MongoDB\nand perfoms a simple error checking on the returned data before returning to the\nuser.\n\nSince this is publicly available endpoint, no data is returned, only a `System\nOK` message if everything is fine. Errors are logged.\n\n    exports.check = (req, res, next) ->\n      cnt = 0\n      ret = (err, info) ->\n        return if cnt > 2\n\n        if err\n          cnt = Math.Infinity\n          next err\n\n        else if ++cnt is 2\n          res.status 200\n          return res.end() if req.method is 'HEAD'\n          return res.json message: 'System OK'\n\n      mongo.db.command dbStats: true, ret\n      redis.info ret\n\n","old_contents":"    redis = require '.\/db\/redis'\n    mongo = require '.\/db\/mongo'\n\n## check()\n\nThis is the system check. It retrives the current status from Redis and MongoDB\nand perfoms a simple error checking on the returned data before returning to the\nuser.\n\nSince this is publicly available endpoint, no data is returned, only a `System\nOK` message if everything is fine. Errors are logged.\n\n    exports.check = (req, res, next) ->\n      cnt = 0\n      ret = (err, info) ->\n        return if cnt > 2\n\n        if err\n          cnt = Math.Infinity\n          next err\n\n        else if ++cnt is 2\n          res.send 200 if req.method is 'HEAD'\n          res.json 200, message: 'System OK'\n\n      mongo.db.command dbStats: true, ret\n      redis.info ret\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8ce11e0cbf283185f31e321428a66c5412d3f0e9","subject":"Update supported HTTP methods and error messages","message":"Update supported HTTP methods and error messages\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n    if process.env.SENTRY_DNS\n      app.use raven.middleware.express process.env.SENTRY_DNS\n      raven.patchGlobal process.env.SENTRY_DNS\n\n### Error handling\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n### API keys\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'NRK'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone about the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n    if process.env.SENTRY_DNS\n      app.use raven.middleware.express process.env.SENTRY_DNS\n      raven.patchGlobal process.env.SENTRY_DNS\n\n### Error handling\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n### API keys\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'NRK'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone about the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        when 'PUT'  then collection.put req, res, next\n        when 'PATCH' then collection.patch req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then document.options req, res, next\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9cacaa3e7e8d7ac1a24266b6efcb9641c5dae199","subject":"Adds documentation for EmailValidator and RegexpValidator","message":"Adds documentation for EmailValidator and RegexpValidator\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true} # title and body must be present (not undefined nor '')\n        @validate 'body', {minLength: 10}           # body must be 10 characters long at least\n        @validate 'title', {pattern: \/^[A-Z]\/}      # Title must start with an uppercase letter\n        @validate 'author', {email: true}           # the author field must contain a valid email address\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n + `regexp : \/regexp\/` : Assert that the value is matching the provided regular expression.\n + `email: true` : Assert that the value is an email address. (using Webkit's html5 regexp)\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::%dirtyKeys : Set\n\nThe set of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## @constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::%dirtyKeys : Set\n\nThe set of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## @constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3d5d13eb145f42153836b6481ad5778e4651a967","subject":"Adds documentation for Model.create()","message":"Adds documentation for Model.create()\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n  `Model.create` is a convenience method that is basically equivalent to\n\n    model = new Model(attributes)\n    model.save(callback)\n\n  _Note_ : Pay attention to the fact that attributes is an empty object `{}` by\n  default. This means Model.create({my_attribute: 'value'}) doesn't work like in\n  Rails.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8ef263f6d67e7bac4136b0ab95fd5e7f06b771af","subject":"setTimeout fix","message":"setTimeout fix\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        self.port.onerror? e\n      , 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) =>\n       try\n        callbacks.fail? e\n       catch err\n        @onerror? err\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        self.port.onerror? e\n      0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) =>\n       try\n        callbacks.fail? e\n       catch err\n        @onerror? err\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"257bc5c86721954e1abf188aab41402974489c31","subject":"Edit Model.create documentation","message":"Edit Model.create documentation\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : Attributes is an empty object `{}` by default. This means the single-argument version accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is basically equivalent to\ncalling `new App.Model` and 'record.save()' :\n\n    asyncTest \"@create is an convience method around new and #save\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # New and save\n      record = new Post(name: 'aName')\n      record.save()\n\n      # @create convenience method\n      other_record = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), other_record.get('name')\n        equal record.isNew(), false\n        equal other_record.isNew(), false\n\n  _Note_ : Pay attention to the fact that attributes is an empty object `{}` by\n  default. This means `Model.create({my_attribute: 'value'})` does _not_ work like\n  in Rails and does nothing. If you want to skip the callback, use\n  `Model.create(attributes, (->))`\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9e952139e9844126b4d7036817a784259a05f414","subject":"Update remora.litcoffee","message":"Update remora.litcoffee","repos":"glamp\/leech,glamp\/leech","old_file":"src\/remora.litcoffee","new_file":"src\/remora.litcoffee","new_contents":"    handlebars = require 'handlebars'\n    aws = require 'aws-sdk'\n    shortid = require 'shortid'\n\nSetup the connection to s3\n\n    aws.config.update {\n        accessKeyId: process.env[\"AWS_ACCESS_KEY\"],\n        secretAccessKey: process.env[\"AWS_SECRET_KEY\"]\n    }\n    aws.config.region = 'us-east-1'\n    s3 = new aws.S3()\n\n--------\nWe're going to make `remora` (this module) exportable so that we can use it in\nthe app, as a command line tool, and as it's own funciton. It takes 1 argument\n(the url) which makes it easy to plug-n-play in other stuff.\n\n    module.exports = (url) ->\n      DOMAIN = process.env[\"DOMAIN\"] || \"remora.link\"\n      BUCKET = process.env[\"BUCKET\"] || DOMAIN\n      GA_ID = process.env[\"GA_ID\"]\n      shortid.characters \"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ()\"\n\nThis is our basic HTML template that we'll use for doing the redirect. It's just\ngoing to send the user to another page as soon as it's loaded. There's no server\nsince it's just a static file, but everything will be tracked by GA.\n\n      source = \"\"\"\n      <html>\n          <title>{{url}}<\/title>\n          <body>\n            <!-- Google Analytics -->\n            <script type=\"text\/javascript\">\n              (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){\n              (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),\n              m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)\n              })(window,document,'script','\/\/www.google-analytics.com\/analytics.js','ga');\n\n              ga('create', '{{ga_id}}', 'auto');\n              ga('send', 'pageview');\n\n            <\/script>\n            <!-- redirect -->\n            <script type=\"text\/javascript\">\n              window.location.replace('{{url}}');\n            <\/script>\n          <\/body>\n      <\/html>\n      \"\"\"\n\n      template = handlebars.compile(source)\n\nData should just be the user's Google Analytics Id and the URL that they want to\nminify.\n\n      data = { url: url, ga_id: GA_ID }\n      html = template(data)\n\nWe're going to generate a shortlink for the URL. [`shortid`](https:\/\/github.com\/dylang\/shortid) does a pretty good job at balancing between being short, and also\nbeing unique! We'll take that `_id` and turn it into the key for an S3 object.\n\n      _id = shortid.generate()\n      params = {\n          Bucket: BUCKET,\n          Key: _id\n          ACL: \"public-read\",\n          Body: html\n      }\n      s3.putObject params, (err, data) ->\n          if err\n              console.log err\n\n*The remainder is a nice to have*. We'll keep a running record of all links\nwe've shortened and throw it into a basic HTML page just to make it easy to do\nlookups.\n\n      source = \"\"\"\n      <html>\n          <title>Shortened Links<\/title>\n          <body>\n              <h1>Shortened Links<\/h1>\n              <ul>\n              {{#objs}}\n                  <li><a href='{{ Key }}'>{{ Key }}<\/a><\/li>\n              {{\/objs}}\n              <\/ul>\n          <\/body>\n      <\/html>\n      \"\"\"\n      params = { Bucket: BUCKET }\n      s3.listObjects params, (err, objs) ->\n        if err\n            console.log \"[ERROR]: could not list objects: \" + err\n        objs = objs.Contents.filter (obj) ->\n          ! \/index.html$\/.test obj.Key\n        html = handlebars.compile(source)({ objs: objs })\n        params = {\n            Bucket: BUCKET,\n            Key: \"index.html\",\n            ACL: \"public-read\",\n            Body: html\n        }\n        s3.putObject params, (err, data) ->\n            if err\n                console.log \"[ERROR]: \" + err\n        console.error \"Visit: https:\/\/s3.amazonaws.com\/#{BUCKET}\/index.html\"\n","old_contents":"    handlebars = require 'handlebars'\n    aws = require 'aws-sdk'\n    shortid = require 'shortid'\n\nSetup the connection to s3\n\n    aws.config.update {\n        accessKeyId: process.env[\"AWS_ACCESS_KEY\"],\n        secretAccessKey: process.env[\"AWS_SECRET_KEY\"]\n    }\n    aws.config.region = 'us-east-1'\n    s3 = new aws.S3()\n\nWe're going to make `remora` (this module) exportable so that we can use it in\nthe app, as a command line tool, and as it's own funciton. It takes 1 argument\n(the url) which makes it easy to plug-n-play in other stuff.\n\n    module.exports = (url) ->\n      DOMAIN = process.env[\"DOMAIN\"] || \"remora.link\"\n      BUCKET = process.env[\"BUCKET\"] || DOMAIN\n      GA_ID = process.env[\"GA_ID\"]\n      shortid.characters \"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ()\"\n\nThis is our basic HTML template that we'll use for doing the redirect. It's just\ngoing to send the user to another page as soon as it's loaded. There's no server\nsince it's just a static file, but everything will be tracked by GA.\n\n      source = \"\"\"\n      <html>\n          <title>{{url}}<\/title>\n          <body>\n            <!-- Google Analytics -->\n            <script type=\"text\/javascript\">\n              (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){\n              (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),\n              m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)\n              })(window,document,'script','\/\/www.google-analytics.com\/analytics.js','ga');\n\n              ga('create', '{{ga_id}}', 'auto');\n              ga('send', 'pageview');\n\n            <\/script>\n            <!-- redirect -->\n            <script type=\"text\/javascript\">\n              window.location.replace('{{url}}');\n            <\/script>\n          <\/body>\n      <\/html>\n      \"\"\"\n\n      template = handlebars.compile(source)\n\nData should just be the user's Google Analytics Id and the URL that they want to\nminify.\n\n      data = { url: url, ga_id: GA_ID }\n      html = template(data)\n\nWe're going to generate a shortlink for the URL. [`shortid`](https:\/\/github.com\/dylang\/shortid) does a pretty good job at balancing between being short, and also\nbeing unique! We'll take that `_id` and turn it into the key for an S3 object.\n\n      _id = shortid.generate()\n      params = {\n          Bucket: BUCKET,\n          Key: _id\n          ACL: \"public-read\",\n          Body: html\n      }\n      s3.putObject params, (err, data) ->\n          if err\n              console.log err\n\n*The remainder is a nice to have*. We'll keep a running record of all links\nwe've shortened and throw it into a basic HTML page just to make it easy to do\nlookups.\n\n      source = \"\"\"\n      <html>\n          <title>Shortened Links<\/title>\n          <body>\n              <h1>Shortened Links<\/h1>\n              <ul>\n              {{#objs}}\n                  <li><a href='{{ Key }}'>{{ Key }}<\/a><\/li>\n              {{\/objs}}\n              <\/ul>\n          <\/body>\n      <\/html>\n      \"\"\"\n      params = { Bucket: BUCKET }\n      s3.listObjects params, (err, objs) ->\n        if err\n            console.log \"[ERROR]: could not list objects: \" + err\n        objs = objs.Contents.filter (obj) ->\n          ! \/index.html$\/.test obj.Key\n        html = handlebars.compile(source)({ objs: objs })\n        params = {\n            Bucket: BUCKET,\n            Key: \"index.html\",\n            ACL: \"public-read\",\n            Body: html\n        }\n        s3.putObject params, (err, data) ->\n            if err\n                console.log \"[ERROR]: \" + err\n        console.error \"Visit: https:\/\/s3.amazonaws.com\/#{BUCKET}\/index.html\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ab3e1868ec6f0941effc11c2d6ffb427211b4833","subject":"Extracted the update datapoint AJAX call into separate function","message":"Extracted the update datapoint AJAX call into separate function\n","repos":"allyjweir\/lackawanna,allyjweir\/lackawanna,allyjweir\/lackawanna,allyjweir\/lackawanna","old_file":"lackawanna\/static\/coffee\/datapoint.litcoffee","new_file":"lackawanna\/static\/coffee\/datapoint.litcoffee","new_contents":"Datapoint Viewer\n======\nAll of this code supports a user's interaction with the datapoint viewer. The core interactions it supports are:\n1. Modifying the datapoint's metadata\n2. Viewing the datapoint itself\n3. Annotating the datapoint\n\n\n\t$(document).ready ->\n\t\t$('#dataoint-tabs a:first').tab('show')\n\t\tconsole.log(\"Page loaded\")\n\n\nCollection Update Modal\n-----\n#### Collections Button clicked\nThis is called when a user wants to modify what collection's that their datapoint is in\/not in.\n\n\t$('#collections-button').click ->\n\t\tconsole.log(\"Collection Button clicked!\")\n\nClear any previous data added to the collections-table div and make sure that the loading spinner is showing.\n\n\t\t$(\"div > #loading-spinner\").show()\n\t\t$(\"#collections-list\").empty()\n\t\t$(\"#collections-save-button\").button(\"reset\")\n\nNow fill the modal with the latest information retrieved from the database\n\n\t\tpopulateCollections()\n\n#### Collection Save\/Update Button clicked\n\n\t$(\"#collections-save-button\").click ->\n\t\t$(\"#collections-save-button\").button(\"loading\")\n\t\tconsole.log(\"Save button Clicked\")\n\nExtract all the selected collection's values (their pk) from the checkbox inputs.\n\n\t\tselected = []\n\t\tfor collection in $(\"#collections-list input:checkbox:checked\")\n\t\t\tselected.push($(collection).prop('value'))\n\nTaking these we make a PATCH request to update a Datapoint's collections through the API.\n\n\n\t\tdatapoint_pk = $(\"#pk\").text()\n\t\tupdated_data = {\"collections\": selected}\n\n\t\tupdateDatapoint(datapoint_pk, updated_data)\n\n\t\t$(\"#collections-save-button\").button(\"reset\")\n\t\t$(\"#collection-Modal\").hide()\n\nThis function retrieves the collections of a specific datapoint.\n\n\tpopulateCollections = () ->\n\t\t$.ajax \"http:\/\/localhost:8080\/apiv1\/collections\",\n\t\t\ttype: \"GET\"\n\t\t\tdataType: \"json\"\n\t\t\tdata: {project: $(\"#project-pk\").text()}\n\t\t\terror: (jqXHR, textStatus, errorThrown) ->\n\t\t\t\tconsole.log(\"Couldn't retrieve the datapoint's project's collections (mouthful): #{textStatus}\")\n\nOn _success_ insert HTML list into the model dialog for each collection\n\n\t\t\tsuccess: (data, textStatus, jqXHR) ->\n\t\t\t\tfor collection in data\n\t\t\t\t\t$(\"#collections-list\").append(\n\t\t\t\t\t\t\"<input type='checkbox' class='collection-checkbox' id='checkbox-#{collection.pk}' value='#{collection.pk}' \/> #{collection.name}<br \/>\n\t\t\t\t\t\t\")\n\nThen mark the ones that the datapoint is already a member of\n\n\t\t\t\tmarkCurrentCollections()\n\nPizza Land is okay!!\n\n\tupdateDatapoint = (datapoint_pk, updated_data) ->\n\n\t\t$.ajax \"http:\/\/localhost:8080\/apiv1\/datapoints\/#{datapoint_pk}\",\n\t\t\theaders:{'X-CSRFToken':$.cookie('csrftoken')}\n\t\t\ttype: \"patch\"\n\t\t\tdataType: \"json\"\n\t\t\ttraditional:true\n\t\t\tdata: updated_data\n\t\t\terror: (jqXHR, textStatus, errorThrown) ->\n\t\t\t\tconsole.log(\"failed to save updated datapoint: #{textStatus}\")\n\t\t\t\t#Show a failure message and ask them to try again.\n\t\t\tsuccess: (data, textStatus, jqXHR) ->\n\t\t\t\tconsole.log(\"successfully updated datapoint\")\n\t\t\t\t#Show success message using bootstrap success bit.\n\n\n\tmarkCurrentCollections = () ->\n\nRetrieve the current datapoint's collections to mark them\n\n\t\t$.ajax \"http:\/\/localhost:8080\/apiv1\/datapoints\/#{$(\"#pk\").text()}\",\n\t\t\ttype: \"GET\"\n\t\t\tdataType: \"json\"\n\nIf it fails, show an error button to offer retry.\n\n\t\t\terror: (jqXHR, textStatus, errorThrown) ->\n\t\t\t\tconsole.log(\"Couldn't retrieve datapoint's info: #{textStatus}\")\n\t\t\t\treturn null\n\nFor each collection (their value is in an array in `data.collections`) mark the checkbox as ticked.\n\n\t\t\tsuccess: (data, textStatus, jqXHR) ->\n\t\t\t\tconsole.log(\"into success of dp: #{data.collections}\")\n\t\t\t\tfor collection in data.collections\n\t\t\t\t\t$(\"#collections-list > #checkbox-#{collection}\").prop('checked', 'true')\n\t\t\t\t$(\"div #loading-spinner\").hide()\n\t\t\t\t$(\"div #collections-table\").show()\n","old_contents":"Datapoint Viewer\n======\nAll of this code supports a user's interaction with the datapoint viewer. The core interactions it supports are:\n1. Modifying the datapoint's metadata\n2. Viewing the datapoint itself\n3. Annotating the datapoint\n\n\n\t$(document).ready ->\n\t\t$('#dataoint-tabs a:first').tab('show')\n\t\tconsole.log(\"Page loaded\")\n\n\nCollection Update Modal\n-----\n#### Collections Button clicked\nThis is called when a user wants to modify what collection's that their datapoint is in\/not in.\n\n\t$('#collections-button').click ->\n\t\tconsole.log(\"Collection Button clicked!\")\n\nClear any previous data added to the collections-table div and make sure that the loading spinner is showing.\n\n\t\t$(\"div > #loading-spinner\").show()\n\t\t$(\"#collections-list\").empty()\n\nNow fill the modal with the latest information retrieved from the database\n\n\t\tpopulateCollections()\n\n#### Collection Save\/Update Button clicked\n\n\t$(\"#collections-save-button\").click ->\n\t\t$(\"#collections-save-button\").button(\"loading\")\n\t\tconsole.log(\"Save button Clicked\")\n\nExtract all the selected collection's values (their pk) from the checkbox inputs.\n\n\t\tselected = []\n\t\tfor collection in $(\"#collections-list input:checkbox:checked\")\n\t\t\tselected.push($(collection).prop('value'))\n\nTaking these we make a PATCH request to update a Datapoint's collections through the API.\n\n\n\t\tdatapoint_pk = $(\"#pk\").text()\n\n\t\t$.ajax \"http:\/\/localhost:8080\/apiv1\/datapoints\/#{datapoint_pk}\",\n\t\t\theaders:{'X-CSRFToken':$.cookie('csrftoken')}\n\t\t\ttype: \"patch\"\n\t\t\tdataType: \"json\"\n\t\t\ttraditional:true\n\t\t\tdata: {\"collections\": selected}  #\"csrftoken\": $.cookie('csrftoken'),\n\t\t\terror: (jqXHR, textStatus, errorThrown) ->\n\t\t\t\tconsole.log(\"failed to save updated collections: #{textStatus}\")\n\t\t\t\t#Show a failure message and ask them to try again.\n\t\t\tsuccess: (data, textStatus, jqXHR) ->\n\n\t\t\t\tconsole.log(\"update collections success\")\n\t\t\t\t#Show success message using bootstrap success bit.\n\t\t\t\t$(\"#collections-save-button\").button(\"reset\")\n\t\t\t\t$(\"#collection-Modal\").hide()\n\n\n\n\tpopulateCollections = () ->\n\t\t$.ajax \"http:\/\/localhost:8080\/apiv1\/collections\",\n\t\t\ttype: \"GET\"\n\t\t\tdataType: \"json\"\n\t\t\tdata: {project: $(\"#project-pk\").text()}\n\t\t\terror: (jqXHR, textStatus, errorThrown) ->\n\t\t\t\tconsole.log(\"Couldn't retrieve the datapoint's project's collections (mouthful): #{textStatus}\")\n\nOn _success_ insert HTML list into the model dialog for each collection\n\n\t\t\tsuccess: (data, textStatus, jqXHR) ->\n\t\t\t\tfor collection in data\n\t\t\t\t\t$(\"#collections-list\").append(\n\t\t\t\t\t\t\"<input type='checkbox' class='collection-checkbox' id='checkbox-#{collection.pk}' value='#{collection.pk}' \/> #{collection.name}<br \/>\n\t\t\t\t\t\t\")\n\nThen mark the ones that the datapoint is already a member of\n\n\t\t\t\tmarkCurrentCollections()\n\n\tmarkCurrentCollections = () ->\n\nRetrieve the current datapoint's collections to mark them\n\n\t\t$.ajax \"http:\/\/localhost:8080\/apiv1\/datapoints\/#{$(\"#pk\").text()}\",\n\t\t\ttype: \"GET\"\n\t\t\tdataType: \"json\"\n\nIf it fails, show an error button to offer retry.\n\n\t\t\terror: (jqXHR, textStatus, errorThrown) ->\n\t\t\t\tconsole.log(\"Couldn't retrieve datapoint's info: #{textStatus}\")\n\t\t\t\treturn null\n\nFor each collection (their value is in an array in `data.collections`) mark the checkbox as ticked.\n\n\t\t\tsuccess: (data, textStatus, jqXHR) ->\n\t\t\t\tconsole.log(\"into success of dp: #{data.collections}\")\n\t\t\t\tfor collection in data.collections\n\n\t\t\t\t\t$(\"#collections-list > #checkbox-#{collection}\").prop('checked', 'true')\n\t\t\t\t# Find the div\n\t\t\t\t# Mark it as checked\n\nFinally, show the entire div and hide the loading spinner\n\n\t\t\t\t$(\"div #loading-spinner\").hide()\n\t\t\t\t$(\"div #collections-table\").show()\n","returncode":0,"stderr":"","license":"bsd-3-clause","lang":"Literate CoffeeScript"}
{"commit":"9449a7dbfada35e7d6fa8bfff01f3c470ae319c9","subject":"Prettified docs","message":"Prettified docs\n","repos":"erikdiessel\/plidoc,erikdiessel\/plidoc","old_file":"docco.litcoffee","new_file":"docco.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"769c7ee740e70d9b50fe03e0faf0049fdbd498c4","subject":"Deal with missing test reports.","message":"Deal with missing test reports.\n","repos":"mxipartners\/checksome,fniessink\/checksome","old_file":"server\/jenkins.litcoffee","new_file":"server\/jenkins.litcoffee","new_contents":"This job collects data from Jenkins for the job names in the\n`SubjectSourceIds` collection.\n\n    class @JenkinsJob extends Job\n      @setupCron: (parser) ->\n        parser.recur().every(1).minute()\n\n      handleJob: ->\n        for source in Sources.find({type: 'jenkins'}).fetch()\n          @update_job_names source\n        for subject_source_id in SubjectSourceIds.find().fetch()\n          source = Sources.findOne({_id: subject_source_id.source})\n          if source.type != 'jenkins'\n            continue\n          @measure_test_results subject_source_id, source\n\n      update_job_names: (source) ->\n        result = @get_job_names_json source.url\n        if result.json\n          job_names = ({_id: job.name, title: job.name} for job in result.json.jobs)\n          Sources.update source._id, {$set: {ids: job_names}}\n\n      get_job_names_json: (jenkins_url) ->\n        try\n          result = HTTP.get jenkins_url + 'api\/json?tree=jobs[name]'\n          return {json: result.data, error_message: ''}\n        catch e\n          return {json: null, error_message: e.message}\n\n      measure_test_results: (subject_source_id, source) ->\n        metric = Metrics.findOne {title: \"Test result\"}\n        subject = Subjects.findOne {_id: subject_source_id.subject}\n        subject_metric = SubjectMetrics.findOne {subject: subject._id, metric: metric._id}\n        target = subject_metric.target or metric.target\n        jenkins_job = subject_source_id.id\n        result = @get_json source.url, jenkins_job\n        test_results_found = false\n        if result.json\n          for action in result.json['actions']\n            if 'failCount' of action\n              fail_count = action.failCount\n              skip_count = action.skipCount\n              total_count = action.totalCount\n              test_results_found = true\n              break\n          if test_results_found\n            value = fail_count + skip_count\n            target_met = test_result_meets_target(value, target)\n            error_message = null\n          else\n            value = null\n            target_met = null\n            error_message = \"Jenkins job #{jenkins_job} doesn't contain test results.\"\n        else\n          value = null\n          target_met = null\n          error_message = result.error_message\n        insertOrUpdateMeasurement\n          projectId: source.projectId\n          subject_metric_id: subject_metric._id\n          metric_title: metric.title\n          subject_title: subject.title\n          value: value\n          unit: metric.unit\n          target: target\n          target_met: target_met\n          error_message: error_message\n\n      get_json: (jenkins_url, jenkins_job) ->\n        try\n          result = HTTP.get jenkins_url + 'job\/' + jenkins_job + '\/lastBuild\/api\/json?tree=actions[failCount,skipCount,totalCount]'\n          {json: result.data, error_message: ''}\n        catch e\n          {json: null, error_message: e.message}\n\n    Job.push new JenkinsJob\n","old_contents":"This job collects data from Jenkins for the job names in the\n`SubjectSourceIds` collection.\n\n    class @JenkinsJob extends Job\n      @setupCron: (parser) ->\n        parser.recur().every(1).minute()\n\n      handleJob: ->\n        for source in Sources.find({type: 'jenkins'}).fetch()\n          @update_job_names source\n        for subject_source_id in SubjectSourceIds.find().fetch()\n          source = Sources.findOne({_id: subject_source_id.source})\n          if source.type != 'jenkins'\n            continue\n          @measure_test_results subject_source_id, source\n\n      update_job_names: (source) ->\n        result = @get_job_names_json source.url\n        if result.json\n          job_names = ({_id: job.name, title: job.name} for job in result.json.jobs)\n          Sources.update source._id, {$set: {ids: job_names}}\n\n      get_job_names_json: (jenkins_url) ->\n        try\n          result = HTTP.get jenkins_url + 'api\/json?tree=jobs[name]'\n          return {json: result.data, error_message: ''}\n        catch e\n          return {json: null, error_message: e.message}\n\n      measure_test_results: (subject_source_id, source) ->\n        metric = Metrics.findOne {title: \"Test result\"}\n        subject = Subjects.findOne {_id: subject_source_id.subject}\n        subject_metric = SubjectMetrics.findOne {subject: subject._id, metric: metric._id}\n        target = subject_metric.target or metric.target\n        jenkins_job = subject_source_id.id\n        result = @get_json source.url, jenkins_job\n        if result.json\n          for action in result.json['actions']\n            if 'failCount' of action\n              fail_count = action.failCount\n              skip_count = action.skipCount\n              total_count = action.totalCount\n          value = fail_count + skip_count\n          target_met = test_result_meets_target(value, target)\n          error_message = null\n        else\n          value = null\n          target_met = null\n          error_message = result.error_message\n        insertOrUpdateMeasurement\n          projectId: source.projectId\n          subject_metric_id: subject_metric._id\n          metric_title: metric.title\n          subject_title: subject.title\n          value: value\n          unit: metric.unit\n          target: target\n          target_met: target_met\n          error_message: error_message\n\n      get_json: (jenkins_url, jenkins_job) ->\n        try\n          result = HTTP.get jenkins_url + 'job\/' + jenkins_job + '\/lastBuild\/api\/json?tree=actions[failCount,skipCount,totalCount]'\n          return {json: result.data, error_message: ''}\n        catch e\n          return {json: null, error_message: e.message}\n\n    Job.push new JenkinsJob\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f3abc22ec8d70b34bde154c4964562a0ac8af546","subject":"testing lib file documentation cleaning","message":"testing lib file documentation cleaning\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"lib\/testing\/index.litcoffee","new_file":"lib\/testing\/index.litcoffee","new_contents":"# Testing\n\n    'use strict'\n\n    {utils, log} = Neft\n    stack = require '.\/stack'\n    logger = require '.\/logger'\n    modifiers = require '.\/modifiers'\n\n    {isArray} = Array\n    {push} = Array::\n    {Scope, Test, Listener} = require '.\/structure'\n\n    scopes = [new Scope]\n    currentScope = scopes[0]\n\n# describe(*String* message, *Function* tests)\n\n    exports.describe = (msg, func) ->\n        beforeEach = utils.NOP\n\n        # new scope\n        scope = new Scope\n        scope.message = msg\n        scopes.push scope\n\n        # before\/after functions\n        push.apply scope.beforeFunctions, currentScope.beforeFunctions\n        push.apply scope.afterFunctions, currentScope.afterFunctions\n\n        # save scope to parent\n        currentScope.children.push scope\n        scope.parent = currentScope\n\n        # save as last\n        currentScope = scope\n\n        # filter children tests\n        try\n            func()\n        catch err\n            console.error err\n\n        # set parent as last\n        scopes.pop()\n        currentScope = utils.last scopes\n        return\n\n    modifiers.applyAll exports.describe\n\n# it(*String* message, *Function* test)\n\nThe given test function can contains optional *callback* argument.\n\n    exports.it = (msg, func) ->\n        testScope = currentScope\n\n        # new test\n        test = new Test\n        test.message = msg\n        test.testFunction = func\n\n        # add test into scope\n        scope = utils.last scopes\n        scope.children.push test\n        test.parent = scope\n\n        return\n\n    modifiers.applyAll exports.it\n\n# beforeEach(*Function* code)\n\n    exports.beforeEach = (func) ->\n        currentScope.beforeFunctions.push func\n        return\n\n    modifiers.applyAll exports.beforeEach\n\n# afterEach(*Function* code)\n\n    exports.afterEach = (func) ->\n        currentScope.afterFunctions.push func\n        return\n\n    modifiers.applyAll exports.afterEach\n\n# whenChange(*Object* watchObject, *Function* callback, [*Integer* maxDelay = `1000`])\n\n    exports.whenChange = do ->\n        listeners = []\n\n        checkListeners = ->\n            i = 0\n            while i < listeners.length\n                listener = listeners[i]\n\n                if listener.test()\n                    listeners.splice i, 1\n                else\n                    i++\n\n            if listeners.length > 0\n                setImmediate checkListeners\n            return\n\n        (obj, callback, maxDelay = 1000) ->\n            listener = new Listener\n            listener.object = obj\n            listener.objectCopy = utils.clone(obj)\n            listener.callback = callback\n            listener.maxDelay = maxDelay\n\n            if listeners.length is 0\n                setImmediate checkListeners\n\n            listeners.push listener\n            return\n\n    runTests = ->\n        [mainScope] = scopes\n        logger.onTestsStart()\n        mainScope.run ->\n            logger.onTestsEnd()\n            onTestsEnd\n                status: if stack.errors.length is 0 then 'success' else 'error'\n                testsAmount: stack.testsAmount\n                errors: stack.errors\n\n    onTestsEnd = (result) ->\n        code = if result.status is 'success' then 0 else 1\n        if utils.isServer\n            process.exit code\n\n    runAutomatically = do ->\n        val = process?.env.RUN_TESTS\n        if typeof val is 'string'\n            val = try JSON.parse val\n        val ?= true\n        val\n\n    setImmediate ->\n        if runAutomatically\n            runTests()\n","old_contents":"# Unit tests\n\nAccess it with:\n```javascript\nconst unit = require('src\/unit');\n```\n\n    'use strict'\n\n    {utils, log} = Neft\n    stack = require '.\/stack'\n    logger = require '.\/logger'\n    modifiers = require '.\/modifiers'\n\n    {isArray} = Array\n    {push} = Array::\n    {Scope, Test, Listener} = require '.\/structure'\n\n    scopes = [new Scope]\n    currentScope = scopes[0]\n\n# unit.describe(*String* message, *Function* tests)\n\n    exports.describe = (msg, func) ->\n        beforeEach = utils.NOP\n\n        # new scope\n        scope = new Scope\n        scope.message = msg\n        scopes.push scope\n\n        # before\/after functions\n        push.apply scope.beforeFunctions, currentScope.beforeFunctions\n        push.apply scope.afterFunctions, currentScope.afterFunctions\n\n        # save scope to parent\n        currentScope.children.push scope\n        scope.parent = currentScope\n\n        # save as last\n        currentScope = scope\n\n        # filter children tests\n        try\n            func()\n        catch err\n            console.error err\n\n        # set parent as last\n        scopes.pop()\n        currentScope = utils.last scopes\n        return\n\n    modifiers.applyAll exports.describe\n\n# unit.it(*String* message, *Function* test)\n\nThe given test function can contains optional *callback* argument.\n\n    exports.it = (msg, func) ->\n        testScope = currentScope\n\n        # new test\n        test = new Test\n        test.message = msg\n        test.testFunction = func\n\n        # add test into scope\n        scope = utils.last scopes\n        scope.children.push test\n        test.parent = scope\n\n        return\n\n    modifiers.applyAll exports.it\n\n# unit.beforeEach(*Function* code)\n\n    exports.beforeEach = (func) ->\n        currentScope.beforeFunctions.push func\n        return\n\n    modifiers.applyAll exports.beforeEach\n\n# unit.afterEach(*Function* code)\n\n    exports.afterEach = (func) ->\n        currentScope.afterFunctions.push func\n        return\n\n    modifiers.applyAll exports.afterEach\n\n# unit.whenChange(*Object* watchObject, *Function* callback, [*Integer* maxDelay = `1000`])\n\n    exports.whenChange = do ->\n        listeners = []\n\n        checkListeners = ->\n            i = 0\n            while i < listeners.length\n                listener = listeners[i]\n\n                if listener.test()\n                    listeners.splice i, 1\n                else\n                    i++\n\n            if listeners.length > 0\n                setImmediate checkListeners\n            return\n\n        (obj, callback, maxDelay = 1000) ->\n            listener = new Listener\n            listener.object = obj\n            listener.objectCopy = utils.clone(obj)\n            listener.callback = callback\n            listener.maxDelay = maxDelay\n\n            if listeners.length is 0\n                setImmediate checkListeners\n\n            listeners.push listener\n            return\n\n# unit.runTests()\n\n    exports.runTests = ->\n        [mainScope] = scopes\n        logger.onTestsStart()\n        mainScope.run ->\n            logger.onTestsEnd()\n            exports.onTestsEnd\n                status: if stack.errors.length is 0 then 'success' else 'error'\n                testsAmount: stack.testsAmount\n                errors: stack.errors\n\n# *Function* unit.onTestsEnd\n\n    exports.onTestsEnd = (result) ->\n        code = if result.status is 'success' then 0 else 1\n        if utils.isServer\n            process.exit code\n\n# *Boolean* unit.runAutomatically = true\n\n    exports.runAutomatically = do ->\n        val = process?.env.RUN_TESTS\n        if typeof val is 'string'\n            val = try JSON.parse val\n        val ?= true\n        val\n\n    setImmediate ->\n        if exports.runAutomatically\n            exports.runTests()\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"1ff6e9387b4ce4c7aaf681ed618f053d4de6648a","subject":"Update docs for deferif binding","message":"Update docs for deferif binding\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","old_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif\n\n`data-renderif` defers parsing of a node's child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"03a8b6ba6af59f15efdf3596a3604822aa04debb","subject":"Refactoring and making it more literate","message":"Refactoring and making it more literate\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"client\/packages.litcoffee","new_file":"client\/packages.litcoffee","new_contents":"\nThis is where shrub's package system meets Angular's module system. Packages'\nimplementations of controllers, services, filters, providers, and directives\nare gathered and registered into Angular.\n\n\tangular.module('shrub.packages', [\n\t\t'shrub.require'\n\t\t'shrub.pkgman'\n\t])\n\n\t\t.config([\n\t\t\t'$compileProvider', '$controllerProvider', '$filterProvider'\n\t\t\t'$injector', '$provide', 'shrub-pkgmanProvider'\n\t\t\t'shrub-requireProvider'\n\t\t\t(\n\t\t\t\t$compileProvider, $controllerProvider, $filterProvider\n\t\t\t\t$injector, $provide, pkgman, {require}\n\t\t\t) ->\n\n\t\t\t\tconfig = require 'config'\n\t\t\t\tdebug = require('debug') 'shrub:angular'\n\nSet an injector so that Angular injection can occur out of band.\n\n\t\t\t\tangular_ = require 'angular'\n\t\t\t\tangular_.setInjector $injector\n\nInvoke hook `controller`.\nAllows packages to define Angular controllers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tdebug 'Registering controllers...'\n\n\t\t\t\tfor path, injected of pkgman.invoke 'controller'\n\t\t\t\t\tcontrollerName = pkgman.normalizePath path\n\t\t\t\t\tdebug controllerName\n\t\t\t\t\t$controllerProvider.register controllerName, injected\n\n\t\t\t\tdebug 'Controllers registered.'\n\n\t\t\t\tdebug 'Registering directives...'\n\nNormalize, augment, and register a directive.\n\n\t\t\t\tregisterDirective = (name, path, injected) -> ($injector) ->\n\t\t\t\t\tdirective = $injector.invoke injected\n\nEnsure a compilation function exists for the directive, and ensure that by\ndefault it returns the `link` function.\n\n\t\t\t\t\tif angular.isFunction directive\n\t\t\t\t\t\tdirective = link: directive\n\t\t\t\t\t\tdirective.compile = -> directive.link\n\t\t\t\t\telse if not directive.compile\n\t\t\t\t\t\tdirective.compile = -> directive.link\n\nProxy any defined link function, firing any attached any controllers' `link`\nmethod, as well as passing execution on to the original `link` function.\n\n\t\t\t\t\tlink = directive.link\n\t\t\t\t\tdirective.link = (scope, element, attrs, controllers) ->\n\t\t\t\t\t\tif controllers?\n\t\t\t\t\t\t\tunless angular.isArray controllers\n\t\t\t\t\t\t\t\tcontrollers = [controllers]\n\n\t\t\t\t\t\t\tfor controller in controllers\n\t\t\t\t\t\t\t\tcontroller.link? arguments...\n\n\t\t\t\t\t\tlink? arguments...\n\nEnsure the directive has a name. Defaults to the normalized path of the\nimplementing package.\n\n\t\t\t\t\tdirective.name ?= name\n\nIf controller binding is specified, the controller defaults to the directive\nname. In other words, if you define a directive and a controller in the same\npackage, and specify `directive.bindToController = true`, your directive will\ninclude the controller automatically.\n\n\t\t\t\t\tif directive.bindToController\n\t\t\t\t\t\tdirective.controller ?= directive.name\n\nHandle a bunch of internal Angular normalization.\n\n\t\t\t\t\tdirective.require ?= directive.controller and directive.name\n\t\t\t\t\tdirective.priority ?= 0\n\t\t\t\t\tdirective.restrict ?= 'EA'\n\n\t\t\t\t\tif angular.isObject directive.scope\n\t\t\t\t\t\tdirectiveIsolateBindings directive\n\nInvoke hook `augmentDirective`.\nAllows packages to augment the directives defined by packages. One example is\nthe automatic relinking functionality implemented by [shrub-skin](..\/packages\/shrub-skin\/client\/index.html#implementshookaugmentdirective).\n\n\t\t\t\t\tfor injectedDirective in pkgman.invokeFlat(\n\t\t\t\t\t\t'augmentDirective', directive, path\n\t\t\t\t\t)\n\t\t\t\t\t\t$injector.invoke injectedDirective\n\nHaven't gone deep enough into Angular to understand why this has to be, but it\ndoes.\n\n\t\t\t\t\tdirective.index = 0\n\t\t\t\t\treturn [directive]\n\nInternal Angular state that we have to reset.\n\n\t\t\t\tdirectiveIsolateBindings = (directive) ->\n\n\t\t\t\t\tLOCAL_REGEXP = \/^\\s*([@&]|=(\\*?))(\\??)\\s*(\\w*)\\s*$\/\n\n\t\t\t\t\tbindings = {}\n\n\t\t\t\t\tfor scopeName, definition of directive.scope\n\t\t\t\t\t\tmatch = definition.match LOCAL_REGEXP\n\n\t\t\t\t\t\tunless match\n\t\t\t\t\t\t\tthrow angular.$$minErr('$compile')(\n\t\t\t\t\t\t\t\t'iscp'\n\t\t\t\t\t\t\t\t\"Invalid isolate scope definition for directive\n\t\t\t\t\t\t\t\t'{0}'. Definition: {... {1}: '{2}' ...}\"\n\t\t\t\t\t\t\t\tdirective.name, scopeName, definition\n\t\t\t\t\t\t\t)\n\n\t\t\t\t\t\tbindings[scopeName] =\n\t\t\t\t\t\t\tmode: match[1][0]\n\t\t\t\t\t\t\tcollection: match[2] is '*'\n\t\t\t\t\t\t\toptional: match[3] is '?'\n\t\t\t\t\t\t\tattrName: match[4] or scopeName\n\n\t\t\t\t\tdirective.$$isolateBindings = bindings\n\nInvoke hook `directive`.\nAllows packages to define Angular directives. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tfor path, injected of pkgman.invoke 'directive'\n\t\t\t\t\tdo (path, injected) ->\n\t\t\t\t\t\tdirectiveName = pkgman.normalizePath path\n\n\t\t\t\t\t\tdebug directiveName\n\nFirst, register it through Angular's normal registration mechanism. This sets\na bunch of internal state we don't have access to.\n\n\t\t\t\t\t\t$compileProvider.directive directiveName, injected\n\nFollow that by normalizing, augmenting, and registering the directive again.\nIt will run over the previous definition, ensuring everything works nicely.\n\n\t\t\t\t\t\t$provide.factory \"#{directiveName}Directive\", [\n\t\t\t\t\t\t\t'$injector'\n\t\t\t\t\t\t\tregisterDirective directiveName, path, injected\n\t\t\t\t\t\t]\n\n\t\t\t\tdebug 'Directives registered.'\n\n\t\t\t\tdebug 'Registering filters...'\n\nInvoke hook `filter`.\nAllows packages to define Angular filters. Implementations should return a\nfunction.\n\n\t\t\t\tfor path, injected of pkgman.invoke 'filter'\n\t\t\t\t\tfilterName = pkgman.normalizePath path\n\n\t\t\t\t\tdebug filterName\n\n\t\t\t\t\t$filterProvider.register filterName, injected\n\n\t\t\t\tdebug 'Filters registered.'\n\nInvoke hook `provider`.\nAllows packages to define Angular providers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tdebug 'Registering providers...'\n\n\t\t\t\tfor path, provider of pkgman.invoke 'provider'\n\t\t\t\t\tdebug path\n\n\t\t\t\t\t$provide.provider path, provider\n\n\t\t\t\tdebug 'Providers registered.'\n\nInvoke hook `service`.\nAllows packages to define Angular services. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tdebug 'Registering services...'\n\n\t\t\t\tfor path, injected of pkgman.invoke 'service'\n\t\t\t\t\tdebug path\n\n\t\t\t\t\t$provide.service path, injected\n\n\t\t\t\tdebug 'Services registered.'\n\n\t\t])\n\nThe module that provides Angular with access to Shrub's package manager.\n\n\tangular.module('shrub.pkgman', [\n\t\t'shrub.require'\n\t])\n\n\t\t.provider 'shrub-pkgman', [\n\t\t\t'$provide', 'shrub-requireProvider'\n\t\t\t($provide, {require}) ->\n\n\t\t\t\tconfig = require 'config'\n\t\t\t\tdebug = require('debug') 'shrub:pkgman'\n\t\t\t\tpkgman = require 'pkgman'\n\n\t\t\t\tdebug 'Loading packages...'\n\nLoad the package list from configuration.\n\n\t\t\t\tpkgman.registerPackageList config.get 'packageList'\n\n\t\t\t\tdebug 'Packages loaded.'\n\nSimply pass along pkgman as the 'service'.\n\n\t\t\t\tpkgman.$get = -> pkgman\n\n\t\t\t\treturn pkgman\n\t\t]\n","old_contents":"\nThis is where shrub's package system meets Angular's module system. Packages'\nimplementations of controllers, services, filters, providers, and directives\nare gathered and registered into Angular.\n\n\tangular.module('shrub.packages', [\n\t\t'shrub.require'\n\t\t'shrub.pkgman'\n\t])\n\n\t\t.config([\n\t\t\t'$compileProvider', '$controllerProvider', '$filterProvider', '$injector', '$provide', 'shrub-pkgmanProvider', 'shrub-requireProvider'\n\t\t\t($compileProvider, $controllerProvider, $filterProvider, $injector, $provide, pkgman, {require}) ->\n\n\t\t\t\t_ = require 'lodash'\n\n\t\t\t\tconfig = require 'config'\n\t\t\t\tdebug = require('debug') 'shrub:angular'\n\nSet an injector so that Angular injection can occur out of band.\n\n\t\t\t\tangular_ = require 'angular'\n\t\t\t\tangular_.setInjector $injector\n\nInvoke hook `controller`.\nAllows packages to define Angular controllers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tdebug 'Registering controllers...'\n\n\t\t\t\tfor path, injected of pkgman.invoke 'controller'\n\t\t\t\t\tcontrollerName = pkgman.normalizePath path\n\n\t\t\t\t\tdebug controllerName\n\n\t\t\t\t\t$controllerProvider.register controllerName, injected\n\n\t\t\t\tdebug 'Controllers registered.'\n\nInvoke hook `directive`.\nAllows packages to define Angular directives. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tdebug 'Registering directives...'\n\n\t\t\t\tfor path, injected of pkgman.invoke 'directive'\n\t\t\t\t\tdo (path, injected) ->\n\t\t\t\t\t\tdirectiveName = pkgman.normalizePath path\n\n\t\t\t\t\t\tdebug directiveName\n\n\t\t\t\t\t\t$compileProvider.directive directiveName, injected\n\t\t\t\t\t\t$provide.factory \"#{directiveName}Directive\", [\n\t\t\t\t\t\t\t'$controller', '$injector'\n\t\t\t\t\t\t\t($controller, $injector) ->\n\n\t\t\t\t\t\t\t\t# Normalize directive.\n\t\t\t\t\t\t\t\tdirective = $injector.invoke injected\n\n\t\t\t\t\t\t\t\t# Ensure compile exists.\n\t\t\t\t\t\t\t\tif angular.isFunction directive\n\t\t\t\t\t\t\t\t\tdirective = link: directive\n\t\t\t\t\t\t\t\t\tdirective.compile = -> directive.link\n\t\t\t\t\t\t\t\telse if not directive.compile\n\t\t\t\t\t\t\t\t\tdirective.compile = -> directive.link\n\n\t\t\t\t\t\t\t\t# Automatic link function attachment to controller.\n\t\t\t\t\t\t\t\tlink = directive.link\n\t\t\t\t\t\t\t\tdirective.link = (scope, element, attrs, controllers) ->\n\t\t\t\t\t\t\t\t\tif controllers?\n\t\t\t\t\t\t\t\t\t\tunless angular.isArray controllers\n\t\t\t\t\t\t\t\t\t\t\tcontrollers = [controllers]\n\n\t\t\t\t\t\t\t\t\t\tfor controller in controllers\n\t\t\t\t\t\t\t\t\t\t\tcontroller.link? arguments...\n\n\t\t\t\t\t\t\t\t\tlink? arguments...\n\n\t\t\t\t\t\t\t\tdirective.name ?= directiveName\n\n\t\t\t\t\t\t\t\t# Automatic directive controller discovery.\n\t\t\t\t\t\t\t\tif directive.bindToController\n\t\t\t\t\t\t\t\t\tdirective.controller ?= directive.name\n\n\t\t\t\t\t\t\t\tdirective.require ?= directive.controller and directive.name\n\t\t\t\t\t\t\t\tdirective.priority ?= 0\n\t\t\t\t\t\t\t\tdirective.index = 0\n\t\t\t\t\t\t\t\tdirective.restrict ?= 'EA'\n\n\t\t\t\t\t\t\t\tif angular.isObject directive.scope\n\n\t\t\t\t\t\t\t\t\tdirective.$$isolateBindings = do ->\n\t\t\t\t\t\t\t\t\t\tLOCAL_REGEXP = \/^\\s*([@&]|=(\\*?))(\\??)\\s*(\\w*)\\s*$\/\n\n\t\t\t\t\t\t\t\t\t\tbindings = {}\n\n\t\t\t\t\t\t\t\t\t\tfor scopeName, definition of directive.scope\n\t\t\t\t\t\t\t\t\t\t\tmatch = definition.match LOCAL_REGEXP\n\n\t\t\t\t\t\t\t\t\t\t\tunless match\n\t\t\t\t\t\t\t\t\t\t\t\tthrow angular.$$minErr('$compile')('iscp',\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"Invalid isolate scope definition for directive '{0}'.\" +\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\" Definition: {... {1}: '{2}' ...}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tdirective.name, scopeName, definition);\n\n\t\t\t\t\t\t\t\t\t\t\tbindings[scopeName] =\n\t\t\t\t\t\t\t\t\t\t\t\tmode: match[1][0]\n\t\t\t\t\t\t\t\t\t\t\t\tcollection: match[2] is '*'\n\t\t\t\t\t\t\t\t\t\t\t\toptional: match[3] is '?'\n\t\t\t\t\t\t\t\t\t\t\t\tattrName: match[4] or scopeName\n\n\t\t\t\t\t\t\t\t\t\tbindings\n\n\t\t\t\t\t\t\t\t# Invoke hook `augmentDirective`.\n\t\t\t\t\t\t\t\t# Allows packages to augment the directives\n\t\t\t\t\t\t\t\t# defined by packages. One example is the automatic\n\t\t\t\t\t\t\t\t# relinking functionality implemented by [shrub-skin](\/packages\/shrub-skin\/client\/index.html#implementshookaugmentdirective).\n\t\t\t\t\t\t\t\tfor injectedDirective in pkgman.invokeFlat(\n\t\t\t\t\t\t\t\t\t'augmentDirective', directive, path\n\t\t\t\t\t\t\t\t)\n\t\t\t\t\t\t\t\t\t$injector.invoke injectedDirective\n\n\t\t\t\t\t\t\t\t[directive]\n\n\t\t\t\t\t\t]\n\n\t\t\t\tdebug 'Directives registered.'\n\n\t\t\t\t# Invoke hook `filter`.\n\t\t\t\t# Allows packages to define Angular filters. Implementations\n\t\t\t\t# should return a function.\n\t\t\t\tdebug 'Registering filters...'\n\n\t\t\t\tfor path, injected of pkgman.invoke 'filter'\n\t\t\t\t\tfilterName = pkgman.normalizePath path\n\n\t\t\t\t\tdebug filterName\n\n\t\t\t\t\t$filterProvider.register filterName, injected\n\n\t\t\t\tdebug 'Filters registered.'\n\n\t\t\t\t# Invoke hook `provider`.\n\t\t\t\t# Allows packages to define Angular providers. Implementations\n\t\t\t\t# should return an [annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\t\t\t\tdebug 'Registering providers...'\n\n\t\t\t\tfor path, provider of pkgman.invoke 'provider'\n\t\t\t\t\tdebug path\n\n\t\t\t\t\t$provide.provider path, provider\n\n\t\t\t\tdebug 'Providers registered.'\n\n\t\t\t\t# Invoke hook `service`.\n\t\t\t\t# Allows packages to define Angular services. Implementations\n\t\t\t\t# should return an [annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\t\t\t\tdebug 'Registering services...'\n\n\t\t\t\tfor path, injected of pkgman.invoke 'service'\n\t\t\t\t\tdebug path\n\n\t\t\t\t\t$provide.service path, injected\n\n\t\t\t\tdebug 'Services registered.'\n\n\t\t\t\t# If we are testing, decorate the services with their mock\n\t\t\t\t# versions.\n\t\t\t\tif config.get 'packageConfig:shrub-core:testMode'\n\n\t\t\t\t\t# Invoke hook `serviceMock`.\n\t\t\t\t\t# Allows packages to decorate mock Angular services.\n\t\t\t\t\t# Implementations should return an\n\t\t\t\t\t# [annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\t\t\t\t\tdebug 'Registering mock services...'\n\n\t\t\t\t\tfor path, injected of pkgman.invoke 'serviceMock'\n\t\t\t\t\t\tdebug path\n\n\t\t\t\t\t\t$provide.decorator path, injected\n\n\t\t\t\t\tdebug 'Mock services registered.'\n\n\t\t])\n\n\t# A module that implements a package manager provider\/service.\n\tangular.module('shrub.pkgman', [\n\t\t'shrub.require'\n\t])\n\n\t\t.provider 'shrub-pkgman', [\n\t\t\t'$provide', 'shrub-requireProvider'\n\t\t\t($provide, {require}) ->\n\n\t\t\t\t_ = require 'lodash'\n\t\t\t\tconfig = require 'config'\n\t\t\t\tdebug = require('debug') 'shrub:pkgman'\n\t\t\t\tpkgman = require 'pkgman'\n\n\t\t\t\t# Load the package list from configuration.\n\t\t\t\tdebug 'Loading packages...'\n\n\t\t\t\tpkgman.registerPackageList config.get 'packageList'\n\n\t\t\t\tdebug 'Packages loaded.'\n\n\t\t\t\tservice = {}\n\n\t\t\t\tservice.invoke = pkgman.invoke\n\t\t\t\tservice.invokeFlat = pkgman.invokeFlat\n\t\t\t\tservice.normalizePath = pkgman.normalizePath\n\n\t\t\t\tservice.$get = -> service\n\n\t\t\t\tservice\n\t\t]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"365eb07efd55260a77cb4ad1dca4998aa0969a13","subject":"Update docs to indicate capitalize is deprecated","message":"Update docs to indicate capitalize is deprecated\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/02_helpers.litcoffee","new_file":"docs\/02_helpers.litcoffee","new_contents":"# Batman.helpers\n\n`Batman.helpers` is a namespace for Batman's helpful string manipulation helpers.\n\n_Note_: Batman's pluralization functions mirror those of Rails' exactly.\n\n## @ordinalize(value : [number|string]) : string\n\n`ordinalize` converts a given integer into an ordinal string for describing position in a list, like 1st, 2nd, or 20th.\n\n    test 'ordinalize converts numbers to their ordinal form', ->\n      equal Batman.helpers.ordinalize(1), \"1st\"\n      equal Batman.helpers.ordinalize(\"2\"), \"2nd\"\n      equal Batman.helpers.ordinalize(1002), \"1002nd\"\n      equal Batman.helpers.ordinalize(\"1003\"), \"1003rd\"\n      equal Batman.helpers.ordinalize(-11), \"-11th\"\n      equal Batman.helpers.ordinalize(-1021), \"-1021st\"\n\n## @singularize(pluralString : string) : string\n\n`singularize` converts the plural form of a word to a singular form.\n\n    test 'singularize converts plural words to singular words', ->\n      equal Batman.helpers.singularize(\"posts\"), \"post\"\n      equal Batman.helpers.singularize(\"octopi\"), \"octopus\"\n      equal Batman.helpers.singularize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.singularize(\"word\"), \"word\"\n      equal Batman.helpers.singularize(\"CamelOctopi\"), \"CamelOctopus\"\n\n## @pluralize(singularString : string) : string\n\n`pluralize` converts the singular form of a word to the plural form.\n\n    test 'pluralize converts plural words to singular words', ->\n      equal Batman.helpers.pluralize(\"post\"), \"posts\"\n      equal Batman.helpers.pluralize(\"octopus\"), \"octopi\"\n      equal Batman.helpers.pluralize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.pluralize(\"words\"), \"words\"\n      equal Batman.helpers.pluralize(\"CamelOctopus\"), \"CamelOctopi\"\n\n## @camelize(name [, lowercaseFirstLetter = false]) : string\n\n`camelize` converts the passed `name` to UpperCamelCase. If the second argument is passed as `true`, then lowerCamelCase is returned.\n\n    test 'camelize returns the CamelCase version of an under_scored word', ->\n      equal Batman.helpers.camelize(\"batman_object\"), \"BatmanObject\"\n      equal Batman.helpers.camelize(\"batman_object\", true), \"batmanObject\"\n\n## @underscore(string) : string\n\n`underscore` returns the underscored version of a CamelCase word.\n\n    test 'underscore converts CamelCase to under_scores', ->\n      equal Batman.helpers.underscore(\"BatmanObject\"), \"batman_object\"\n\n## @titleize(string) : string\n\n`titleize` does a word-wise capitalization of a phrase or word.\n\n    test 'titleize makes the first letter of each word in the string uppercase', ->\n      equal Batman.helpers.titleize(\"batmanObject\"), \"BatmanObject\"\n      equal Batman.helpers.titleize(\"batman object\"), \"Batman Object\"\n      equal Batman.helpers.titleize(\"AlreadyCapitalized\"), \"AlreadyCapitalized\"\n\n## @capitalize(string) : string\n\nDeprecated alias of `titleize`.\n\n## @trim(string) : string\n\n`trim` trims a string getting rid of extra white space around the string or returning an empty string if it is null.\n\n    test 'trim gets rid of space around a string', ->\n      equal Batman.helpers.trim(\"TrimRight \"), \"TrimRight\"\n      equal Batman.helpers.trim(\" TrimLeft\"), \"TrimLeft\"\n      equal Batman.helpers.trim(\" TrimBothSides \"), \"TrimBothSides\"\n      equal Batman.helpers.trim(\"AlreadyTrimmed\"), \"AlreadyTrimmed\"\n\n    test 'trim turns a null or undefined string into an empty string', ->\n      equal Batman.helpers.trim(null), \"\"\n      equal Batman.helpers.trim(undefined), \"\"\n\n## @interpolate(stringOrObject, keys) : string\n\n`interpolate` interpolates a string, filling it in with values matching interpolation keys, similar to printf variants.\n\n    test 'interpolate fills in key values globally in a string', ->\n      equal Batman.helpers.interpolate(\"%{field} must be at least %{count} characters in order for %{field} to be valid\", count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string', ->\n      equal Batman.helpers.interpolate({'other': \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string, embedded by key count', ->\n      equal Batman.helpers.interpolate({3: \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n## @humanize(string) : string\n\n`humanize` reformats a string that has a programmatic meaning (camelcased, underscored, \"_id\" suffixed) to make human-readable by separating concatenated words and\/or getting rid of the \"_id\" suffix.\n\n    test 'humanize replaces underscores and dashes with empty space', ->\n      equal Batman.helpers.humanize('underscored_string'), 'Underscored string'\n      equal Batman.helpers.humanize('dash-separated-string'), 'Dash separated string'\n\n    test 'humanize splits camel cased words by empty space', ->\n      equal Batman.helpers.humanize('CamelCasedString'), 'Camel cased string'\n\n    test 'humanize title-cases the first word', ->\n      equal Batman.helpers.humanize('lower case sentence'), 'Lower case sentence'\n\n    test 'humanize lower-cases all words after the first one', ->\n      equal Batman.helpers.humanize('Mixed Case SENTENCE'), 'Mixed case sentence'\n\n    test 'humanize gets rid of _id suffix', ->\n      equal Batman.helpers.humanize('identifying_string_id'), 'Identifying string'\n\n## @toSentence(array) : string\n\n`toSentence` joins the items in the array with commas or \"and\", as appropriate:\n\n    test 'toSentence joins array items with commas or \"and\"', ->\n      equal Batman.helpers.toSentence([\"The Joker\"]), \"The Joker\"\n      equal Batman.helpers.toSentence([\"The Joker\", \"Scarecrow\"]), \"The Joker and Scarecrow\"\n      equal Batman.helpers.toSentence([\"The Joker\", \"Scarecrow\", \"Poison Ivy\"]), \"The Joker, Scarecrow, and Poison Ivy\"\n      equal Batman.helpers.toSentence([\"The Joker\", \"Scarecrow\", \"Poison Ivy\", \"Penguin\"]), \"The Joker, Scarecrow, Poison Ivy, and Penguin\"\n","old_contents":"# Batman.helpers\n\n`Batman.helpers` is a namespace for Batman's helpful string manipulation helpers.\n\n_Note_: Batman's pluralization functions mirror those of Rails' exactly.\n\n## @ordinalize(value : [number|string]) : string\n\n`ordinalize` converts a given integer into an ordinal string for describing position in a list, like 1st, 2nd, or 20th.\n\n    test 'ordinalize converts numbers to their ordinal form', ->\n      equal Batman.helpers.ordinalize(1), \"1st\"\n      equal Batman.helpers.ordinalize(\"2\"), \"2nd\"\n      equal Batman.helpers.ordinalize(1002), \"1002nd\"\n      equal Batman.helpers.ordinalize(\"1003\"), \"1003rd\"\n      equal Batman.helpers.ordinalize(-11), \"-11th\"\n      equal Batman.helpers.ordinalize(-1021), \"-1021st\"\n\n## @singularize(pluralString : string) : string\n\n`singularize` converts the plural form of a word to a singular form.\n\n    test 'singularize converts plural words to singular words', ->\n      equal Batman.helpers.singularize(\"posts\"), \"post\"\n      equal Batman.helpers.singularize(\"octopi\"), \"octopus\"\n      equal Batman.helpers.singularize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.singularize(\"word\"), \"word\"\n      equal Batman.helpers.singularize(\"CamelOctopi\"), \"CamelOctopus\"\n\n## @pluralize(singularString : string) : string\n\n`pluralize` converts the singular form of a word to the plural form.\n\n    test 'pluralize converts plural words to singular words', ->\n      equal Batman.helpers.pluralize(\"post\"), \"posts\"\n      equal Batman.helpers.pluralize(\"octopus\"), \"octopi\"\n      equal Batman.helpers.pluralize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.pluralize(\"words\"), \"words\"\n      equal Batman.helpers.pluralize(\"CamelOctopus\"), \"CamelOctopi\"\n\n## @camelize(name [, lowercaseFirstLetter = false]) : string\n\n`camelize` converts the passed `name` to UpperCamelCase. If the second argument is passed as `true`, then lowerCamelCase is returned.\n\n    test 'camelize returns the CamelCase version of an under_scored word', ->\n      equal Batman.helpers.camelize(\"batman_object\"), \"BatmanObject\"\n      equal Batman.helpers.camelize(\"batman_object\", true), \"batmanObject\"\n\n## @underscore(string) : string\n\n`underscore` returns the underscored version of a CamelCase word.\n\n    test 'underscore converts CamelCase to under_scores', ->\n      equal Batman.helpers.underscore(\"BatmanObject\"), \"batman_object\"\n\n## @titleize(string) : string\n\n`titleize` does a word-wise capitalization of a phrase or word.\n\n    test 'titleize makes the first letter of each word in the string uppercase', ->\n      equal Batman.helpers.titleize(\"batmanObject\"), \"BatmanObject\"\n      equal Batman.helpers.titleize(\"batman object\"), \"Batman Object\"\n      equal Batman.helpers.titleize(\"AlreadyCapitalized\"), \"AlreadyCapitalized\"\n\n## @capitalize(string) : string\n\n`capitalize` capitalizes the first letter of the string.\n\n    test 'capitalize makes the first letter in the string uppercase', ->\n      equal Batman.helpers.capitalize(\"batmanObject\"), \"BatmanObject\"\n      equal Batman.helpers.capitalize(\"batman object\"), \"Batman object\"\n      equal Batman.helpers.capitalize(\"AlreadyCapitalized\"), \"AlreadyCapitalized\"\n\n## @trim(string) : string\n\n`trim` trims a string getting rid of extra white space around the string or returning an empty string if it is null.\n\n    test 'trim gets rid of space around a string', ->\n      equal Batman.helpers.trim(\"TrimRight \"), \"TrimRight\"\n      equal Batman.helpers.trim(\" TrimLeft\"), \"TrimLeft\"\n      equal Batman.helpers.trim(\" TrimBothSides \"), \"TrimBothSides\"\n      equal Batman.helpers.trim(\"AlreadyTrimmed\"), \"AlreadyTrimmed\"\n\n    test 'trim turns a null or undefined string into an empty string', ->\n      equal Batman.helpers.trim(null), \"\"\n      equal Batman.helpers.trim(undefined), \"\"\n\n## @interpolate(stringOrObject, keys) : string\n\n`interpolate` interpolates a string, filling it in with values matching interpolation keys, similar to printf variants.\n\n    test 'interpolate fills in key values globally in a string', ->\n      equal Batman.helpers.interpolate(\"%{field} must be at least %{count} characters in order for %{field} to be valid\", count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string', ->\n      equal Batman.helpers.interpolate({'other': \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string, embedded by key count', ->\n      equal Batman.helpers.interpolate({3: \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n## @humanize(string) : string\n\n`humanize` reformats a string that has a programmatic meaning (camelcased, underscored, \"_id\" suffixed) to make human-readable by separating concatenated words and\/or getting rid of the \"_id\" suffix.\n\n    test 'humanize replaces underscores and dashes with empty space', ->\n      equal Batman.helpers.humanize('underscored_string'), 'Underscored string'\n      equal Batman.helpers.humanize('dash-separated-string'), 'Dash separated string'\n\n    test 'humanize splits camel cased words by empty space', ->\n      equal Batman.helpers.humanize('CamelCasedString'), 'Camel cased string'\n\n    test 'humanize title-cases the first word', ->\n      equal Batman.helpers.humanize('lower case sentence'), 'Lower case sentence'\n\n    test 'humanize lower-cases all words after the first one', ->\n      equal Batman.helpers.humanize('Mixed Case SENTENCE'), 'Mixed case sentence'\n\n    test 'humanize gets rid of _id suffix', ->\n      equal Batman.helpers.humanize('identifying_string_id'), 'Identifying string'\n\n## @toSentence(array) : string\n\n`toSentence` joins the items in the array with commas or \"and\", as appropriate:\n\n    test 'toSentence joins array items with commas or \"and\"', ->\n      equal Batman.helpers.toSentence([\"The Joker\"]), \"The Joker\"\n      equal Batman.helpers.toSentence([\"The Joker\", \"Scarecrow\"]), \"The Joker and Scarecrow\"\n      equal Batman.helpers.toSentence([\"The Joker\", \"Scarecrow\", \"Poison Ivy\"]), \"The Joker, Scarecrow, and Poison Ivy\"\n      equal Batman.helpers.toSentence([\"The Joker\", \"Scarecrow\", \"Poison Ivy\", \"Penguin\"]), \"The Joker, Scarecrow, Poison Ivy, and Penguin\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cf2177d78083aa8064721daf0d0cad965f833424","subject":"changed the methd prefixs","message":"changed the methd prefixs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/02_helpers.litcoffee","new_file":"docs\/02_helpers.litcoffee","new_contents":"# Batman Helpers\n\nBatman includes a number of useful, general purpose helper functions and references. They can all be found attached to the `Batman` object and can optionally be exported into the global namespace with a `$` prefix.\n\n## container\n\n`Batman.container` points to either the `window` object if running in the browser, or the `global` object if running in node. This is useful if you want to add something to the global scope in all environments.\n\n## @typeOf(object) : string\n\n`typeOf` determines a more specific type of an `object` than the native `typeof` operator in JavaScript. This is useful for a number of situations like dealing with `Object` promoted strings and numbers, or arrays which look like `object`s to `typeof`. Use `typeOf` when you need more than `\"object\"` from `typeof`.\n\n_Note_: `typeOf` is substantially slower than `typeof`. `typeOf` works in a somewhat hackish manner by getting the `Object::toString` representation of the object and slicing it to retrieve the name of the constructor.\n\n    test 'typeOf returns \"String\" for both strings and Object strings', ->\n      primitive = \"test\"\n      objectified = new String(\"test\")\n      equal typeof primitive, \"string\"\n      equal typeof objectified, \"object\"\n      equal Batman.typeOf(primitive), \"String\"\n      equal Batman.typeOf(objectified), \"String\"\n\n    test 'typeOf returns Array for arrays', ->\n      array = [];\n      equal typeof array, \"object\"\n      equal Batman.typeOf(array), \"Array\"\n\n## @mixin(subject, objects...) : subject\n\n`mixin`, occasionally known elsewhere as `extend` or `merge`, flattens a series of objects onto the subject. Key\/value pairs on objects passed as later arguments (arguments with a higher index) take precedence over earlier arguments. Returns the `subject` passed in with the new values.\n\n`mixin` also has special properties that make it different than the canonical `extend` functions:\n\n 1. If the `subject` has a `set` function, `subject.set(key, value)` will be used to apply keys instead of `subject[key] = value`. This means that if the subject is a `Batman.Object`, observers and thus bindings on the object will be notified when other (Batmanified or not) objects are mixed into it.\n 2. If a mixed-in `object` has an `initialize` function defined, that function will be called and passed the `subject`. This is useful for custom extension logic, similar to `self.included` in Ruby. For this reason, the keys `initialize` and `uninitialize` are skipped by `mixin`.\n 3. `mixin` only iterates over keys for which the `hasOwnProperty` test passes.\n\n_Note_: `mixin` is destructive to (only) the first argument. If you need a non-destructive version of `mixin`, just pass an empty object as the first object, and all keys from the successive arguments will be applied to the empty object.\n\n    test 'mixin merges argument objects', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {fit: true}, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual subject, {fit: true, fly: true, funky: true}, \"the subject is modified destructively\"\n\n    test 'mixin merges argument objects', ->\n      unmodified = {fit: true}\n      deepEqual Batman.mixin({}, unmodified, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual unmodified, {fit: true}, \"argument objects are untouched allowing non-destructive merge\"\n\n    test 'mixed in objects passed as higher indexed arguments take precedence', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {x: 1, y: 1}, {x: 2}), {x: 2, y: 1}\n\n## @unmixin(subject, objects...) : subject\n\n`unmixin` \"unmerges\" the passed objects from the `subject`. If a key exists on any of the `objects` it will be `delete`d from the `subject`. Returns the `subject`.\n\n`unmixin`, similar to `mixin`, supports calling an `uninitialize` function for each of the `objects` being unmixed in. If an `uninitialize` function exists on each\n\n    test 'unmixin removes keys found on the unmixined objects on the subject', ->\n      subject = {fit: true, fly: true, funky: true}\n      deepEqual Batman.unmixin(subject, {fit: true}, {fly: true}), {funky: true}, \"unmixin returns the subject\"\n      deepEqual subject, {funky: true}, \"the subject is destructively modified.\"\n\n## @functionName(function) : string\n\n`functionName` returns the name of a given function, if any. Works with Internet Explorer 7\/8\/9, FireFox, Chrome, and Safari.\n\n    test 'functionName returns the name of a given function', ->\n      equal Batman.functionName(\"\".toString), 'toString'\n\n## @isChildOf(parent : HTMLElement, child : HTMLElement) : boolean\n\n`isChildOf` is a simple DOM helper which returns a boolean describing if the passed `child` node can be found in the descendants of the passed `parent` node.\n\n## @setImmediate(callback : Function) : object\n\n`setImmediate` (and its sister `clearImmediate`) are a more efficient version of `setTimeout(callback, 0)`. Due to timer resolution issues, setTimeout passed a timeout of 0 doesn't actually execute the function as soon as the JS execution stack has been emptied, but at minimum 4ms and maxmium 25ms after. For this reason Batman provides a cross browser implementation of `setImmediate` which does its best to call the callback immediately after the stack empties. Batman's `setImmediate` polyfill uses the native version if available, `window.postmessage` trickery if supported, and falls back on `setTimeout(->, 0)`.\n\n`setImmediate` returns a handle which can be passed to `clearImmediate` to cancel the future calling of the callback.\n\n## @clearImmediate(handle)\n\n`clearImmediate` stops the calling of a callback in the future when passed its `handle` (which is returned from the `setImmediate` call used to enqueue it).\n\n## @forEach(iterable : object, iterator : Function[, context : Object])\n\nThe `forEach` Batman helper is a universal iteration helper. When passed an `iterable` object, the helper will call the `iterator` (optionally in the `context`) for each item in the `iterable`. The `iterable` can be:\n\n 1. something which has its own `forEach`, in which case the `iterator` will just be passed to `iterable.forEach`.\n 2. an array like object, in which case a JavaScript `for(;;)` loop will be used to iterate over each entry\n 3. or an object, in which case a JavaScript `for-in` loop will be used to iterate over each entry.\n\nThe `forEach` helper is useful for iterating over objects when the type of those objects isn't guaranteed.\n\n    test 'forEach iterates over objects with forEach defined', ->\n      results = []\n      set = new Batman.SimpleSet('a')\n      Batman.forEach(set, (x) -> results.push(x))\n      deepEqual results, ['a']\n\n    test 'forEach iterates over array like objects', ->\n      results = []\n      ArrayLike = ->\n      ArrayLike:: = []\n      imitation = new ArrayLike\n      Array::push.call(imitation, \"a\")\n      Array::push.call(imitation, \"b\")\n      Batman.forEach(imitation, (x) -> results.push(x))\n      deepEqual results, ['a', 'b']\n\n    test 'forEach iterates over objects', ->\n      result = {}\n      object = {x: true}\n      Batman.forEach(object, (key, val) -> result[key] = val)\n      deepEqual result, object\n\n## @objectHasKey(object, key) : boolean\n\n`objectHasKey` returns a boolean describing the presence of the `key` in the passed `object`. `objectHasKey` delegates to the `object`'s `hasKey` function if present, and otherwise just does a check using the JavaScript `in` operator.\n\n    test 'objectHasKey verifies if a key is present in an object', ->\n      subject = {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n    test 'objectHasKey verifies if a key is present in an object with `hasKey` defined', ->\n      subject = new Batman.SimpleHash {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n## @contains(object, item) : boolean\n\n`contains` returns a boolean describing if the given `object` has member `item`. Membership in this context is defined as:\n\n + the result of `object.has(item)` if the `object` has a `has` function defined\n + the result of `item in object` if the `object` is arraylike\n + the result of the Batman.objectHasKey otherwise\n\n_Note_: When passed an object without a `has` function, `contains` will return `true` if the `object` has `item` as a *`key`*, not as a value at any key.\n\n`contains` is useful for checking item membership when the type of the object can't be relied on.\n\n## @get(object, key) : value\n\n`get` is a general purpose function for retrieving the value from a `key` on an `object` of an indeterminate type. This is useful if code needs to work with both `Batman.Object`s and Plain Old JavaScript Objects. `get` has the following semantics:\n\n + if the `object` has a `get` function defined, return the result of `object.get(key)`\n + if the object does not have a `get` function defined, use an ephemeral `Batman.Property` to retrieve the key. This is equivalent to `object[key]` for single segment `key`s, but if the `key` is multi-segment (example: 'product.customer.name'), `get` will do nested gets until the either `undefined` or the end of the keypath is reached.\n\n    test 'get returns the value at a key on a POJO', ->\n      subject = {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a key on a Batman.Object', ->\n      subject = Batman {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a deep key on a POJO', ->\n      subject = {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n    test 'get returns the value at a deep key on a Batman.Object', ->\n      subject = Batman {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n## @getPath(base, segments) : string\n\n`getPath` returns the hash value denoted by the specified path, which consists of an array of nested hash keys. See examples below for more detail.\n\n    test \"takes a base and an array of keys and returns the corresponding nested value\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo', 'bar']), 'nested value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo.bar']), 'flat value'\n      strictEqual Batman.getPath(@complexObject, ['hash', 'not-foo', 'bar']), undefined\n\n    test \"returns just the base if the key array is empty\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(@complexObject, []), @complexObject\n      strictEqual Batman.getPath(null, []), null\n\n    test \"returns undefined if the base is null-ish\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(null, ['foo']), undefined\n      strictEqual Batman.getPath(undefined, ['foo']), undefined\n\n    test \"returns falsy values\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(num: 0, ['num']), 0\n      strictEqual Batman.getPath(thing: null, ['thing']), null\n\n## @escapeHTML(string) : string\n\n`escapeHTML` takes a string of unknown origin and makes it safe for display on a web page by encoding control characters in HTML into their HTML entities.\n\n*Warning*: Do not rely on `escapeHTML` to purge unsafe data from user submitted content. While `escapeHTML` is applied to every binding's contents by default, it should not be your only line of defence against script injection attacks.\n\n    test 'escapeHTML encodes special characters into HTML entities', ->\n      equal Batman.escapeHTML(\"& < > \\\" '\"), \"&amp; &lt; &gt; &#34; &#39;\"\n\n# Batman.helpers\n\n`Batman.helpers` is a namespace for Batman's helpful string manipulation helpers.\n\n_Note_: Batman's pluralization functions mirror those of Rails' exactly.\n\n## @ordinalize(value : [number|string]) : string\n\n`ordinalize` converts a given integer into an ordinal string for describing position in a list, like 1st, 2nd, or 20th.\n\n    test 'ordinalize converts numbers to their ordinal form', ->\n      equal Batman.helpers.ordinalize(1)     , \"1st\"\n      equal Batman.helpers.ordinalize(\"2\")     , \"2nd\"\n      equal Batman.helpers.ordinalize(1002)  , \"1002nd\"\n      equal Batman.helpers.ordinalize(\"1003\")  , \"1003rd\"\n      equal Batman.helpers.ordinalize(-11)   , \"-11th\"\n      equal Batman.helpers.ordinalize(-1021) , \"-1021st\"\n\n## @singularize(pluralString : string) : string\n\n`singularize` converts the plural form of a word to a singular form.\n\n    test 'singularize converts plural words to singular words', ->\n      equal Batman.helpers.singularize(\"posts\"), \"post\"\n      equal Batman.helpers.singularize(\"octopi\"), \"octopus\"\n      equal Batman.helpers.singularize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.singularize(\"word\"), \"word\"\n      equal Batman.helpers.singularize(\"CamelOctopi\"), \"CamelOctopus\"\n\n## @pluralize(singularString : string) : string\n\n`pluralize` converts the singular form of a word to the plural form.\n\n    test 'pluralize converts plural words to singular words', ->\n      equal Batman.helpers.pluralize(\"post\"), \"posts\"\n      equal Batman.helpers.pluralize(\"octopus\"), \"octopi\"\n      equal Batman.helpers.pluralize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.pluralize(\"words\"), \"words\"\n      equal Batman.helpers.pluralize(\"CamelOctopus\"), \"CamelOctopi\"\n\n## @camelize(string, [lowercaseFirstLetter = false]) : string\n\n`camelize` converts the passed `string` to UpperCamelCase. If the second argument is passed as `true`, then lowerCamelCase is returned.\n\n    test 'camelize returns the CamelCase version of an under_scored word', ->\n      equal Batman.helpers.camelize(\"batman_object\"), \"BatmanObject\"\n      equal Batman.helpers.camelize(\"batman_object\", true), \"batmanObject\"\n\n## @underscore(string) : string\n\n`underscore` returns the underscored version of a CamelCase word.\n\n    test 'underscore converts CamelCase to under_scores', ->\n      equal Batman.helpers.underscore(\"BatmanObject\"), \"batman_object\"\n\n## @capitalize(string) : string\n\n`capitalize` does a word-wise capitalization of a phrase or word.\n\n    test 'capitalize makes the first letter of each word in the string uppercase', ->\n      equal Batman.helpers.capitalize(\"batmanObject\"), \"BatmanObject\"\n      equal Batman.helpers.capitalize(\"batman object\"), \"Batman Object\"\n      equal Batman.helpers.capitalize(\"AlreadyCapitalized\"), \"AlreadyCapitalized\"\n\n## @trim(string) : string\n\n`trim` trims a string getting rid of extra white space around the string or returning an empty string if it is null.\n\n    test 'trim gets rid of space around a string', ->\n      equal Batman.helpers.trim(\"TrimRight \"), \"TrimRight\"\n      equal Batman.helpers.trim(\" TrimLeft\"), \"TrimLeft\"\n      equal Batman.helpers.trim(\" TrimBothSides \"), \"TrimBothSides\"\n      equal Batman.helpers.trim(\"AlreadyTrimmed\"), \"AlreadyTrimmed\"\n\n    test 'trim turns a null or undefined string into an empty string', ->\n      equal Batman.helpers.trim(null), \"\"\n      equal Batman.helpers.trim(undefined), \"\"\n\n## @interpolate(stringOrObject, keys) : string\n\n`interpolate` interpolates a string, filling it in with values matching interpolation keys, similar to printf variants.\n\n    test 'interpolate fills in key values globally in a string', ->\n      equal Batman.helpers.interpolate(\"%{field} must be at least %{count} characters in order for %{field} to be valid\", count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string', ->\n      equal Batman.helpers.interpolate({'other': \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string, embedded by key count', ->\n      equal Batman.helpers.interpolate({3: \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n## @humanize(string) : string\n\n`humanize` reformats a string that has a programmatic meaning (camelcased, underscored, \"_id\" suffixed) to make human-readable by separating concatenated words and\/or getting rid of the \"_id\" suffix.\n\n    test 'humanize replaces underscores and dashes with empty space', ->\n      equal Batman.helpers.humanize('underscored_string'), 'Underscored string'\n      equal Batman.helpers.humanize('dash-separated-string'), 'Dash separated string'\n\n    test 'humanize splits camel cased words by empty space', ->\n      equal Batman.helpers.humanize('CamelCasedString'), 'Camel cased string'\n\n    test 'humanize title-cases the first word', ->\n      equal Batman.helpers.humanize('lower case sentence'), 'Lower case sentence'\n\n    test 'humanize lower-cases all words after the first one', ->\n      equal Batman.helpers.humanize('Mixed Case SENTENCE'), 'Mixed case sentence'\n\n    test 'humanize gets rid of _id suffix', ->\n      equal Batman.helpers.humanize('identifying_string_id'), 'Identifying string'\n","old_contents":"# Batman Helpers\n\nBatman includes a number of useful, general purpose helper functions and references. They can all be found attached to the `Batman` object and can optionally be exported into the global namespace with a `$` prefix.\n\n## container\n\n`Batman.container` points to either the `window` object if running in the browser, or the `global` object if running in node. This is useful if you want to add something to the global scope in all environments.\n\n## typeOf(object) : string\n\n`typeOf` determines a more specific type of an `object` than the native `typeof` operator in JavaScript. This is useful for a number of situations like dealing with `Object` promoted strings and numbers, or arrays which look like `object`s to `typeof`. Use `typeOf` when you need more than `\"object\"` from `typeof`.\n\n_Note_: `typeOf` is substantially slower than `typeof`. `typeOf` works in a somewhat hackish manner by getting the `Object::toString` representation of the object and slicing it to retrieve the name of the constructor.\n\n    test 'typeOf returns \"String\" for both strings and Object strings', ->\n      primitive = \"test\"\n      objectified = new String(\"test\")\n      equal typeof primitive, \"string\"\n      equal typeof objectified, \"object\"\n      equal Batman.typeOf(primitive), \"String\"\n      equal Batman.typeOf(objectified), \"String\"\n\n    test 'typeOf returns Array for arrays', ->\n      array = [];\n      equal typeof array, \"object\"\n      equal Batman.typeOf(array), \"Array\"\n\n## mixin(subject, objects...) : subject\n\n`mixin`, occasionally known elsewhere as `extend` or `merge`, flattens a series of objects onto the subject. Key\/value pairs on objects passed as later arguments (arguments with a higher index) take precedence over earlier arguments. Returns the `subject` passed in with the new values.\n\n`mixin` also has special properties that make it different than the canonical `extend` functions:\n\n 1. If the `subject` has a `set` function, `subject.set(key, value)` will be used to apply keys instead of `subject[key] = value`. This means that if the subject is a `Batman.Object`, observers and thus bindings on the object will be notified when other (Batmanified or not) objects are mixed into it.\n 2. If a mixed-in `object` has an `initialize` function defined, that function will be called and passed the `subject`. This is useful for custom extension logic, similar to `self.included` in Ruby. For this reason, the keys `initialize` and `uninitialize` are skipped by `mixin`.\n 3. `mixin` only iterates over keys for which the `hasOwnProperty` test passes.\n\n_Note_: `mixin` is destructive to (only) the first argument. If you need a non-destructive version of `mixin`, just pass an empty object as the first object, and all keys from the successive arguments will be applied to the empty object.\n\n    test 'mixin merges argument objects', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {fit: true}, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual subject, {fit: true, fly: true, funky: true}, \"the subject is modified destructively\"\n\n    test 'mixin merges argument objects', ->\n      unmodified = {fit: true}\n      deepEqual Batman.mixin({}, unmodified, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual unmodified, {fit: true}, \"argument objects are untouched allowing non-destructive merge\"\n\n    test 'mixed in objects passed as higher indexed arguments take precedence', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {x: 1, y: 1}, {x: 2}), {x: 2, y: 1}\n\n## unmixin(subject, objects...) : subject\n\n`unmixin` \"unmerges\" the passed objects from the `subject`. If a key exists on any of the `objects` it will be `delete`d from the `subject`. Returns the `subject`.\n\n`unmixin`, similar to `mixin`, supports calling an `uninitialize` function for each of the `objects` being unmixed in. If an `uninitialize` function exists on each\n\n    test 'unmixin removes keys found on the unmixined objects on the subject', ->\n      subject = {fit: true, fly: true, funky: true}\n      deepEqual Batman.unmixin(subject, {fit: true}, {fly: true}), {funky: true}, \"unmixin returns the subject\"\n      deepEqual subject, {funky: true}, \"the subject is destructively modified.\"\n\n## functionName(function) : string\n\n`functionName` returns the name of a given function, if any. Works with Internet Explorer 7\/8\/9, FireFox, Chrome, and Safari.\n\n    test 'functionName returns the name of a given function', ->\n      equal Batman.functionName(\"\".toString), 'toString'\n\n## isChildOf(parent : HTMLElement, child : HTMLElement) : boolean\n\n`isChildOf` is a simple DOM helper which returns a boolean describing if the passed `child` node can be found in the descendants of the passed `parent` node.\n\n## setImmediate(callback : Function) : object\n\n`setImmediate` (and its sister `clearImmediate`) are a more efficient version of `setTimeout(callback, 0)`. Due to timer resolution issues, setTimeout passed a timeout of 0 doesn't actually execute the function as soon as the JS execution stack has been emptied, but at minimum 4ms and maxmium 25ms after. For this reason Batman provides a cross browser implementation of `setImmediate` which does its best to call the callback immediately after the stack empties. Batman's `setImmediate` polyfill uses the native version if available, `window.postmessage` trickery if supported, and falls back on `setTimeout(->, 0)`.\n\n`setImmediate` returns a handle which can be passed to `clearImmediate` to cancel the future calling of the callback.\n\n## clearImmediate(handle)\n\n`clearImmediate` stops the calling of a callback in the future when passed its `handle` (which is returned from the `setImmediate` call used to enqueue it).\n\n## forEach(iterable : object, iterator : Function[, context : Object])\n\nThe `forEach` Batman helper is a universal iteration helper. When passed an `iterable` object, the helper will call the `iterator` (optionally in the `context`) for each item in the `iterable`. The `iterable` can be:\n\n 1. something which has its own `forEach`, in which case the `iterator` will just be passed to `iterable.forEach`.\n 2. an array like object, in which case a JavaScript `for(;;)` loop will be used to iterate over each entry\n 3. or an object, in which case a JavaScript `for-in` loop will be used to iterate over each entry.\n\nThe `forEach` helper is useful for iterating over objects when the type of those objects isn't guaranteed.\n\n    test 'forEach iterates over objects with forEach defined', ->\n      results = []\n      set = new Batman.SimpleSet('a')\n      Batman.forEach(set, (x) -> results.push(x))\n      deepEqual results, ['a']\n\n    test 'forEach iterates over array like objects', ->\n      results = []\n      ArrayLike = ->\n      ArrayLike:: = []\n      imitation = new ArrayLike\n      Array::push.call(imitation, \"a\")\n      Array::push.call(imitation, \"b\")\n      Batman.forEach(imitation, (x) -> results.push(x))\n      deepEqual results, ['a', 'b']\n\n    test 'forEach iterates over objects', ->\n      result = {}\n      object = {x: true}\n      Batman.forEach(object, (key, val) -> result[key] = val)\n      deepEqual result, object\n\n## objectHasKey(object, key) : boolean\n\n`objectHasKey` returns a boolean describing the presence of the `key` in the passed `object`. `objectHasKey` delegates to the `object`'s `hasKey` function if present, and otherwise just does a check using the JavaScript `in` operator.\n\n    test 'objectHasKey verifies if a key is present in an object', ->\n      subject = {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n    test 'objectHasKey verifies if a key is present in an object with `hasKey` defined', ->\n      subject = new Batman.SimpleHash {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n## contains(object, item) : boolean\n\n`contains` returns a boolean describing if the given `object` has member `item`. Membership in this context is defined as:\n\n + the result of `object.has(item)` if the `object` has a `has` function defined\n + the result of `item in object` if the `object` is arraylike\n + the result of the Batman.objectHasKey otherwise\n\n_Note_: When passed an object without a `has` function, `contains` will return `true` if the `object` has `item` as a *`key`*, not as a value at any key.\n\n`contains` is useful for checking item membership when the type of the object can't be relied on.\n\n## get(object, key) : value\n\n`get` is a general purpose function for retrieving the value from a `key` on an `object` of an indeterminate type. This is useful if code needs to work with both `Batman.Object`s and Plain Old JavaScript Objects. `get` has the following semantics:\n\n + if the `object` has a `get` function defined, return the result of `object.get(key)`\n + if the object does not have a `get` function defined, use an ephemeral `Batman.Property` to retrieve the key. This is equivalent to `object[key]` for single segment `key`s, but if the `key` is multi-segment (example: 'product.customer.name'), `get` will do nested gets until the either `undefined` or the end of the keypath is reached.\n\n    test 'get returns the value at a key on a POJO', ->\n      subject = {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a key on a Batman.Object', ->\n      subject = Batman {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a deep key on a POJO', ->\n      subject = {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n    test 'get returns the value at a deep key on a Batman.Object', ->\n      subject = Batman {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n## getPath(base, segments) : string\n\n`getPath` returns the hash value denoted by the specified path, which consists of an array of nested hash keys. See examples below for more detail.\n\n    test \"takes a base and an array of keys and returns the corresponding nested value\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo', 'bar']), 'nested value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo.bar']), 'flat value'\n      strictEqual Batman.getPath(@complexObject, ['hash', 'not-foo', 'bar']), undefined\n\n    test \"returns just the base if the key array is empty\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(@complexObject, []), @complexObject\n      strictEqual Batman.getPath(null, []), null\n\n    test \"returns undefined if the base is null-ish\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(null, ['foo']), undefined\n      strictEqual Batman.getPath(undefined, ['foo']), undefined\n\n    test \"returns falsy values\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(num: 0, ['num']), 0\n      strictEqual Batman.getPath(thing: null, ['thing']), null\n\n## escapeHTML(string) : string\n\n`escapeHTML` takes a string of unknown origin and makes it safe for display on a web page by encoding control characters in HTML into their HTML entities.\n\n*Warning*: Do not rely on `escapeHTML` to purge unsafe data from user submitted content. While `escapeHTML` is applied to every binding's contents by default, it should not be your only line of defence against script injection attacks.\n\n    test 'escapeHTML encodes special characters into HTML entities', ->\n      equal Batman.escapeHTML(\"& < > \\\" '\"), \"&amp; &lt; &gt; &#34; &#39;\"\n\n# Batman.helpers\n\n`Batman.helpers` is a namespace for Batman's helpful string manipulation helpers.\n\n_Note_: Batman's pluralization functions mirror those of Rails' exactly.\n\n## ordinalize(value : [number|string]) : string\n\n`ordinalize` converts a given integer into an ordinal string for describing position in a list, like 1st, 2nd, or 20th.\n\n    test 'ordinalize converts numbers to their ordinal form', ->\n      equal Batman.helpers.ordinalize(1)     , \"1st\"\n      equal Batman.helpers.ordinalize(\"2\")     , \"2nd\"\n      equal Batman.helpers.ordinalize(1002)  , \"1002nd\"\n      equal Batman.helpers.ordinalize(\"1003\")  , \"1003rd\"\n      equal Batman.helpers.ordinalize(-11)   , \"-11th\"\n      equal Batman.helpers.ordinalize(-1021) , \"-1021st\"\n\n## singularize(pluralString : string) : string\n\n`singularize` converts the plural form of a word to a singular form.\n\n    test 'singularize converts plural words to singular words', ->\n      equal Batman.helpers.singularize(\"posts\"), \"post\"\n      equal Batman.helpers.singularize(\"octopi\"), \"octopus\"\n      equal Batman.helpers.singularize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.singularize(\"word\"), \"word\"\n      equal Batman.helpers.singularize(\"CamelOctopi\"), \"CamelOctopus\"\n\n## pluralize(singularString : string) : string\n\n`pluralize` converts the singular form of a word to the plural form.\n\n    test 'pluralize converts plural words to singular words', ->\n      equal Batman.helpers.pluralize(\"post\"), \"posts\"\n      equal Batman.helpers.pluralize(\"octopus\"), \"octopi\"\n      equal Batman.helpers.pluralize(\"sheep\"), \"sheep\"\n      equal Batman.helpers.pluralize(\"words\"), \"words\"\n      equal Batman.helpers.pluralize(\"CamelOctopus\"), \"CamelOctopi\"\n\n## camelize(string, [lowercaseFirstLetter = false]) : string\n\n`camelize` converts the passed `string` to UpperCamelCase. If the second argument is passed as `true`, then lowerCamelCase is returned.\n\n    test 'camelize returns the CamelCase version of an under_scored word', ->\n      equal Batman.helpers.camelize(\"batman_object\"), \"BatmanObject\"\n      equal Batman.helpers.camelize(\"batman_object\", true), \"batmanObject\"\n\n## underscore(string) : string\n\n`underscore` returns the underscored version of a CamelCase word.\n\n    test 'underscore converts CamelCase to under_scores', ->\n      equal Batman.helpers.underscore(\"BatmanObject\"), \"batman_object\"\n\n## capitalize(string) : string\n\n`capitalize` does a word-wise capitalization of a phrase or word.\n\n    test 'capitalize makes the first letter of each word in the string uppercase', ->\n      equal Batman.helpers.capitalize(\"batmanObject\"), \"BatmanObject\"\n      equal Batman.helpers.capitalize(\"batman object\"), \"Batman Object\"\n      equal Batman.helpers.capitalize(\"AlreadyCapitalized\"), \"AlreadyCapitalized\"\n\n## trim(string) : string\n\n`trim` trims a string getting rid of extra white space around the string or returning an empty string if it is null.\n\n    test 'trim gets rid of space around a string', ->\n      equal Batman.helpers.trim(\"TrimRight \"), \"TrimRight\"\n      equal Batman.helpers.trim(\" TrimLeft\"), \"TrimLeft\"\n      equal Batman.helpers.trim(\" TrimBothSides \"), \"TrimBothSides\"\n      equal Batman.helpers.trim(\"AlreadyTrimmed\"), \"AlreadyTrimmed\"\n\n    test 'trim turns a null or undefined string into an empty string', ->\n      equal Batman.helpers.trim(null), \"\"\n      equal Batman.helpers.trim(undefined), \"\"\n\n## interpolate(stringOrObject, keys) : string\n\n`interpolate` interpolates a string, filling it in with values matching interpolation keys, similar to printf variants.\n\n    test 'interpolate fills in key values globally in a string', ->\n      equal Batman.helpers.interpolate(\"%{field} must be at least %{count} characters in order for %{field} to be valid\", count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string', ->\n      equal Batman.helpers.interpolate({'other': \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n    test 'interpolate fills in key values globally in an object-embedded string, embedded by key count', ->\n      equal Batman.helpers.interpolate({3: \"%{field} must be at least %{count} characters in order for %{field} to be valid\"}, count: \"3\", field: \"name\"), \"name must be at least 3 characters in order for name to be valid\"\n\n## humanize(string) : string\n\n`humanize` reformats a string that has a programmatic meaning (camelcased, underscored, \"_id\" suffixed) to make human-readable by separating concatenated words and\/or getting rid of the \"_id\" suffix.\n\n    test 'humanize replaces underscores and dashes with empty space', ->\n      equal Batman.helpers.humanize('underscored_string'), 'Underscored string'\n      equal Batman.helpers.humanize('dash-separated-string'), 'Dash separated string'\n\n    test 'humanize splits camel cased words by empty space', ->\n      equal Batman.helpers.humanize('CamelCasedString'), 'Camel cased string'\n\n    test 'humanize title-cases the first word', ->\n      equal Batman.helpers.humanize('lower case sentence'), 'Lower case sentence'\n\n    test 'humanize lower-cases all words after the first one', ->\n      equal Batman.helpers.humanize('Mixed Case SENTENCE'), 'Mixed case sentence'\n\n    test 'humanize gets rid of _id suffix', ->\n      equal Batman.helpers.humanize('identifying_string_id'), 'Identifying string'\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cdd4617af0ad55886ded27c77e5f80971fce3fb9","subject":"Update functions.litcoffee","message":"Update functions.litcoffee","repos":"andychase\/date_machine,andychase\/date_machine,andychase\/date_machine,andychase\/date_machine","old_file":"date_machine\/javascript\/functions.litcoffee","new_file":"date_machine\/javascript\/functions.litcoffee","new_contents":"### This file\n\nThe logic in this file builds the date object.\n\nIf you compare this file to the ```python\/functions.py``` file\nyou'll notice they are very similiar. That's intentional,\nthis file was ported over and kept such that it would be somewhat\neasy to port changes back and forth.\n\n### Terminology\n\nBecause it's so confusing here is a list of the different levels to refer to:\n\n- Groups \n  -- This is the capture groups. The lowest level. ```([0-9])``` etc.\n  \"Day\", \"Month\", etc.\n- Expressions \n  -- This is an expression with multiple capture groups. They're usually named\n  after the person that wrote them. \"Greg Burns\", etc.\n  \n  In Python, Expressions functions have nice named arguments, def expr(Day, Month, Year),\n  but Javascript doesn't support this.\n- Type\n  -- This is a collection of expressions with a common goal.\n  Months (Jan, 0-12, January, etc.). \n- Patterns\n  -- This is a collection of types ```<Month>\/<Day>\/<Year>```\n\n### Warning\n\nA note about the above list. Types and Groups are commonly mixed up.\nI think groups SHOULD be the lowest \n(because they are the actual capture *groups* in regular expressions)\nbut a group of expressions also makes sense.\n\nIt's so confusing that there are at least a couple places here that I've\nalso mixed myself up and probably in the documentation for RE|PARSE as well.\n\n---\n\nI use named tuples in python, and ```_replace``` mirrors the functionality of \n```date._replace```.. that is that it returns a copy of the date with only\ncertain things changed and leaves the old well enough alone.\n\n        _replace = (_old, _new) ->\n            year:   if _new.year? then _new.year else _old.year\n            month:  if _new.month? then _new.month else _old.month\n            day:    if _new.day? then _new.day  else _old.day\n            hour:   if _new.hour? then _new.hour else _old.hour\n            minute: if _new.minute? then _new.minute else _old.minute\n            second: if _new.second? then _new.second else _old.second\n            am_pm:  if _new.am_pm? then _new.am_pm else _old.am_pm\n\nI represent lengths of dates (i.e. Thursday, 1-2pm) with a timedelta that goes right\nafter the date hash in the result array.\n\nIn Javascript, I'm just going to represent a timedelta with a hash.\nI make a pretty dumb assumption that timedelta will only cross hour\/minutes\/second boundaries.\n\n        timedelta_from_Date = (start_time, end_time) ->\n            seconds_difference = 0\n            if start_time.hour? and end_time.hour?\n              seconds_difference += 60*60*(end_time.hour - start_time.hour)\n\n              if start_time.minute? and end_time.minute?\n                seconds_difference += 60*(end_time.minute - start_time.minute)\n\n                if start_time.second? and end_time.second?\n                  seconds_difference += end_time.second - start_time.second\n\n            hours = Math.floor(seconds_difference\/60\/60)\n            minutes = Math.floor(seconds_difference\/60) - (hours * 60)\n            seconds = seconds_difference - (minutes * 60) - (hours * 60 * 60)\n\n            return {\n               timedelta: true\n               hours: hours\n               minutes: minutes\n               seconds: seconds\n            }\n\n\nThis is just a helper function\n\n        in_array = (arr, _) -> arr.indexOf(_) != -1\n\n```progressive_match``` is useful for matching abbreviations\nand full spellings. Functions like this could be useful\nto help parse fuzzy matches in the future (i.e. misspellings of months).\n\n        progressive_match = (string, possibilities) ->\n            part = \"\"\n            if not string? then return\n            for character in string.toLowerCase()\n                part += character\n                matches = []\n                for month, value of possibilities\n                    if month.indexOf(part) > -1\n                        matches.push(month)\n                if matches.length == 1\n                    return possibilities[matches[0]]\n### Types\n\nThe heading above is the heading in the python source.\nI actually don't know if it's referring to collections of expressions\nor capture groups.\n\n        month_to_number = (month_string) ->\n          months =\n              \"january\": 1\n              \"february\": 2\n              \"march\": 3\n              \"april\": 4\n              \"may\": 5\n              \"june\": 6\n              \"july\": 7\n              \"august\": 8\n              \"september\": 9\n              \"october\": 10\n              \"november\": 11\n              \"december\": 12\n           return progressive_match(month_string, months)\n\n        weekday_to_number = (WeekdayString ) ->\n            weekday_list = {\n                \"monday\": 0,\n                \"tuesday\": 1,\n                \"wednesday\": 2,\n                \"thursday\": 3,\n                \"friday\": 4,\n                \"saturday\": 5,\n                \"sunday\": 6,\n            }\n            return progressive_match(WeekdayString, weekday_list)\n\nI serialize am_pm by converting the hours to milliary\/24-hour time format.\nI also include ```am_pm: 'pm'``` in the date format to show that that transformation\nwas done. Making that clear helpful because if you get a time like 1, with no ```am_pm```\ndesignation you might want to assume pm and add 12. This is not done in the libary because\ndate_machine strives for honesty, not guesswork.\n\n        am_pm = (input) ->\n            if not input?\n              return\n            if input.toLowerCase() == \"am\" then 0\n            else if input.toLowerCase() == \"pm\" then 12\n\nYou can see in this function that I try not to repeat logic and use other\nfunctions. In this case I might have been able to simply put time_expression\nin the functions hash\/object, but in python it makes a difference due to named arguments.\nI'm going to leave it as-is for clarity.\n\n        military_time = (MilHour, MilMinute, MilSecond ) ->\n            return time_expression(MilHour, MilMinute, MilSecond, undefined)\n\nHere is the ampm conversion. I omit returns when the expressions are simple,\nbut later on I want to use them as much as possible to make my intentions clear.\n\n        noon = (hour, AMPM) -> hour == 12 and AMPM == 12\n        midnight = (hour, AMPM) -> hour == 12 and AMPM == 0\n\n        time_expression = (Hour, Minute, Second, AMPM, SpecialTimeText ) ->\n            if not Hour? and not Minute? and not Second? and not AMPM? and not SpecialTimeText?\n                return\n            if SpecialTimeText\n                if SpecialTimeText.toLowerCase() == \"noon\"\n                    return {hour: 12}\n                if SpecialTimeText.toLowerCase() == \"midnight\"\n                    return {hour: 0}\n            d = {}\n            if Hour\n                d.hour = Number(Hour)\n            if Minute\n                d.minute = Number(Minute)\n            if Second\n                d.second = Number(Second)\n            if AMPM?\n                if d.hour\n                    if noon(d.hour, AMPM)\n                        d.hour = 12\n                    else if midnight(d.hour, AMPM)\n                        d.hour = 0\n                    else\n                        d.hour = d.hour + AMPM\n                d.am_pm = AMPM\n            if [d.hour, d.minute, d.second] == [undefined, undefined, undefined]\n                return undefined\n            return d\n\n\n        time_and_time = (Hour, Minute, AMPM1, Hour2, Minute2, AMPM2) ->\n            if AMPM2?\n                AMPM2 = am_pm(AMPM2)\n            if not AMPM1? and not AMPM2?\n                return [time_expression(Hour, Minute), time_expression(Hour2, Minute2)]\n            else if not AMPM1?\n                return [time_expression(Hour, Minute, undefined, AMPM2),\n                        time_expression(Hour2, Minute2, undefined, AMPM2)]\n            else if not AMPM2?\n                return [time_expression(Hour, Minute, undefined, AMPM1),\n                        time_expression(Hour2, Minute2, undefined, AMPM1)]\n\n\n        month_type = (input...) ->\n            for value in input\n                if value?\n                    return Number(value)\n\n\n        date_number = (Day, Abbr) -> if Day? then Number(Day)\n\n        month_number = (MonthNum) -> Number(MonthNum)\n\n        month_num_type = (input) -> Number(input)\n\n        year = (Year) -> if Year? then Number(Year)\n\nSometimes the value is [undefined, undefined, <value>],\nso I need to search for it and find it.\n\n        get_first_defined = (_) ->\n          for item in _\n            if item?\n              return item\n\n### Patterns\n\nThere's a some unwrapping values out of arrays here.\nBecause of the namedarguments issue functions receive a lot more\narrays then in Python and so they need to be unwrapped.\n\n        weekday_range_with_time = (time1, time2, [weekday1], [weekday2], MonthRange) ->\n            output = []\n\n            # Get first undefined value\n            # Since only one value in list will be defined (if any)\n            time1 = get_first_defined(time1)\n            time2 = get_first_defined(time2)\n\n            if time1?\n                for date in MonthRange\n                    output.push(_replace(date, time1))\n                    if time2?\n                        output.push(_replace(date, time2))\n            return output\n\n\n        weekday_range_with_extra = ( time, and_time, weekday_start, weekday_end, extra_time, extra_weekday, MonthRange) ->\n            output = []\n            if time?\n                for date in MonthRange\n                    if date.weekday?\n                        if date.weekday in [weekday_start .. weekday_end]\n                            output.push(_replace(date, time))\n                            if and_time?\n                                output.push(_replace(date, and_time))\n                        if date.weekday == extra_weekday\n                            output.push(_replace(date, extra_time))\n            return output\n\n\n        weekday_range_with_extra_backwards = (extra_time, extra_weekday, time, weekday_start, weekday_end, MonthRange ) ->\n            return weekday_range_with_extra(time[0], time[1], weekday_start, weekday_end, extra_time, extra_weekday, MonthRange )\n\n\n        reverse_basic_text = (time, day, month, year) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        basic_text = (time, first_second, weekday, month, day, year) ->\n            if not day?\n                day = 1\n            if (day instanceof Array) and day.length == 1\n              day = day[0]\n            if (year instanceof Array) and year.length == 1\n              year = year[0]\n            if not time?\n                return {year: year, month: month, day: day}\n            else\n                year: year\n                month: month\n                day: day\n                hour: time.hour\n                minute: time.minute\n                second: time.second\n                am_pm: time.am_pm\n\n\n        slash = (month, day, year, time) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        month_range = (month, date_a, date_b) ->\n            output = []\n            for day in [date_a .. date_b]\n                output.push(basic_text(undefined, undefined, undefined, month, day, undefined))\n            return output\n\n\n        multi_time = (time1, BasicText) ->\n            output = []\n            if time1? and BasicText?\n                output.push(_replace(BasicText, time1))\n                output.push(BasicText)\n                return output\n\n\n        large_repeat_words = ->\n            return undefined\n\n\n        weekday_range_with_time_range = (time1, weekday_range) ->\n            output = []\n            if time1? and weekday_range?\n                range = timedelta_from_Date(_replace(weekday_range[0], time1), weekday_range[0])\n                for weekday in weekday_range\n                    output.push(_replace(weekday, {hour:time1.hour, minute:time1.minute, am_pm:time1.am_pm}))\n                    output.push(range)\n                return output\n\n\n        time_range = (unstrict_time, strict_time, date, reverse) ->\n            endtime = date\n            starttime = endtime\n            if unstrict_time\n                starttime = _replace(starttime, {hour:Number(unstrict_time[0])})\n                if date.am_pm\n                    starttime = _replace(starttime, {hour: starttime.hour + date.am_pm, am_pm:date.am_pm})\n            else\n                starttime = _replace(starttime, {hour: strict_time.hour, minute: strict_time.minute})\n\n            time_range = timedelta_from_Date(starttime, endtime)\n            if reverse\n                time_range = timedelta_from_Date(endtime, starttime)\n            return [starttime, time_range]\n\n\n        alt_time_range = (first_second, weekday, month, day, year, time, unstrict_time, strict_time) ->\n            return time_range(unstrict_time, strict_time, basic_text(time, first_second, weekday, month, day, year), reverse)\n\n\n        until_range = (date1, date2) ->\n            if date1 and date2\n                return [date1, timedelta_from_Date(date1, date2)]\n\n\n        through_range = (time, weekday1, weekday2, month, date, beginning) ->\n            output = []\n            if month and date and beginning and weekday1\n                ending =\n                    month: month\n                    day: date\n                for day in [beginning.day .. ending.day]\n                    temp =\n                        month: month\n                        day: date\n                    if temp.weekday and in_array([weekday1 .. weekday2], temp.weekday)\n                        if time\n                            output.push(_replace(temp, time))\n                        else\n                            output.push(temp)\n                return output\n\n\n### The function list\n\nThis hash\/object matches all the functions with a\nstring that represents it in the parse tree.\n\n        functions =\n            # Groups\n            \"MonthString\": month_to_number,\n            \"AMPM\": am_pm,\n            # Expressions\n            \"Chase Year\": year,\n            \"Chase Date\": date_number,\n            \"Chase Month\": month_number,\n            \"Steve Valaitis\": time_expression,\n            \"Greg Burns\": (hour, am_pm) -> time_expression(hour, null, null, am_pm, null),\n            \"Greg Burns UnstrictTime:\": time_expression,\n            \"Steve Valaitis2\": military_time,\n            \"Steve Valaitis And Time\": time_and_time,\n            \"Text Parts\": time_expression,\n            \"Michael Ash10\": weekday_to_number,\n            # Types\n            \"Month\": month_type,\n            \"MonthNum\": month_num_type,\n            # Patterns\n            \"LargeRepeatWords\": large_repeat_words,\n            \"BasicText\": basic_text,\n            \"ReverseBasicText\": reverse_basic_text,\n            \"Slash\": slash,\n            \"MonthRange\": month_range,\n            \"MultiTime\": multi_time,\n            \"WeekdayRangeWithTime\": weekday_range_with_time,\n            \"WeekdayRangeWithExtra\": weekday_range_with_extra,\n            \"WeekdayRangeWithExtraBackwards\": weekday_range_with_extra_backwards,\n            \"WeekdayRangeWithTimeRange\": weekday_range_with_time_range,\n            \"UntilRange\": until_range,\n            \"ThroughRange\": through_range,\n            \"TimeRange\": time_range,\n            \"AltTimeRange\": alt_time_range,\n\nThis is default expression or pattern. ```any``` means\nif value is defined, and there is array with even a single defined value then return true.\n\n            \"_default\": (_) ->\n                if any(_) then _ else undefined\n\n```Type``` there is used to mean collection of expressions.\nI know that because only one will match, so you just have to find\nit and return it.\n\n            \"_default_type\": (_...) ->\n                if _?\n                    for item in _\n                         if item?\n                             return item\n\n            \"_default_group\": (_...) -> if _[0]? then _[0]\n","old_contents":"### This file\n\nThe logic in this file builds the date object.\n\nIf you compare this file to the ```python\/functions.py``` file\nyou'll notice they are very similiar. That's intentional,\nthis file was ported over and kept such that it would be somewhat\neasy to port changes back and forth.\n\n### Terminology\n\nBecause it's so confusing here is a list of the different levels to refer to:\n\n- Groups \n  -- This is the capture groups. The lowest level. ```([0-9])``` etc.\n  \"Day\", \"Month\", etc.\n- Expressions \n  -- This is an expression with multiple capture groups. They're usually named\n  after the person that wrote them. \"Greg Burns\", etc.\n  \n  In Python, Expressions functions have nice named arguments, def expr(Day, Month, Year),\n  but Javascript doesn't support this.\n- Type\n  -- This is a collection of expressions with a common goal.\n  Months (Jan, 0-12, January, etc.). \n- Patterns\n  -- This is a collection of types ```<Month>\/<Day>\/<Year>```\n\n### Warning\n\nA note about the above list. Types and Groups are commonly mixed up.\nI think groups SHOULD be the lowest \n(because they are the actual capture *groups* in regular expressions)\nbut a group of expressions also makes sense.\n\nIt's so confusing that there are at least a couple places here that I've\nalso mixed myself up and probably in the documentation for RE|PARSE as well.\n\n---\n\nI use named tuples in python, and _replace mirrors the functionality of \ndate._replace.. that is that it returns a copy of the date with only\ncertain things changed and leaves the old well enough alone.\n\n        _replace = (_old, _new) ->\n            year:   if _new.year? then _new.year else _old.year\n            month:  if _new.month? then _new.month else _old.month\n            day:    if _new.day? then _new.day  else _old.day\n            hour:   if _new.hour? then _new.hour else _old.hour\n            minute: if _new.minute? then _new.minute else _old.minute\n            second: if _new.second? then _new.second else _old.second\n            am_pm:  if _new.am_pm? then _new.am_pm else _old.am_pm\n\nI represent lengths of dates (i.e. Thursday, 1-2pm) with a timedelta that goes right\nafter the date hash in the result array.\n\nIn Javascript, I'm just going to represent a timedelta with a hash.\nI make a pretty dumb assumption that timedelta will only cross hour\/minutes\/second boundaries.\n\n        timedelta_from_Date = (start_time, end_time) ->\n            seconds_difference = 0\n            if start_time.hour? and end_time.hour?\n              seconds_difference += 60*60*(end_time.hour - start_time.hour)\n\n              if start_time.minute? and end_time.minute?\n                seconds_difference += 60*(end_time.minute - start_time.minute)\n\n                if start_time.second? and end_time.second?\n                  seconds_difference += end_time.second - start_time.second\n\n            hours = Math.floor(seconds_difference\/60\/60)\n            minutes = Math.floor(seconds_difference\/60) - (hours * 60)\n            seconds = seconds_difference - (minutes * 60) - (hours * 60 * 60)\n\n            return {\n               timedelta: true\n               hours: hours\n               minutes: minutes\n               seconds: seconds\n            }\n\n\nThis is just a helper function\n\n        in_array = (arr, _) -> arr.indexOf(_) != -1\n\n```progressive_match``` is useful for matching abbreviations\nand full spellings. Functions like this could be useful\nto help parse fuzzy matches in the future (i.e. misspellings of months).\n\n        progressive_match = (string, possibilities) ->\n            part = \"\"\n            if not string? then return\n            for character in string.toLowerCase()\n                part += character\n                matches = []\n                for month, value of possibilities\n                    if month.indexOf(part) > -1\n                        matches.push(month)\n                if matches.length == 1\n                    return possibilities[matches[0]]\n### Types\n\nThe heading above is the heading in the python source.\nI actually don't know if it's referring to collections of expressions\nor capture groups.\n\n        month_to_number = (month_string) ->\n          months =\n              \"january\": 1\n              \"february\": 2\n              \"march\": 3\n              \"april\": 4\n              \"may\": 5\n              \"june\": 6\n              \"july\": 7\n              \"august\": 8\n              \"september\": 9\n              \"october\": 10\n              \"november\": 11\n              \"december\": 12\n           return progressive_match(month_string, months)\n\n        weekday_to_number = (WeekdayString ) ->\n            weekday_list = {\n                \"monday\": 0,\n                \"tuesday\": 1,\n                \"wednesday\": 2,\n                \"thursday\": 3,\n                \"friday\": 4,\n                \"saturday\": 5,\n                \"sunday\": 6,\n            }\n            return progressive_match(WeekdayString, weekday_list)\n\nI serialize am_pm by converting the hours to milliary\/24-hour time format.\nI also include ```am_pm: 'pm'``` in the date format to show that that transformation\nwas done. Making that clear helpful because if you get a time like 1, with no ```am_pm```\ndesignation you might want to assume pm and add 12. This is not done in the libary because\ndate_machine strives for honesty, not guesswork.\n\n        am_pm = (input) ->\n            if not input?\n              return\n            if input.toLowerCase() == \"am\" then 0\n            else if input.toLowerCase() == \"pm\" then 12\n\nYou can see in this function that I try not to repeat logic and use other\nfunctions. In this case I might have been able to simply put time_expression\nin the functions hash\/object, but in python it makes a difference due to named arguments.\nI'm going to leave it as-is for clarity.\n\n        military_time = (MilHour, MilMinute, MilSecond ) ->\n            return time_expression(MilHour, MilMinute, MilSecond, undefined)\n\nHere is the ampm conversion. I omit returns when the expressions are simple,\nbut later on I want to use them as much as possible to make my intentions clear.\n\n        noon = (hour, AMPM) -> hour == 12 and AMPM == 12\n        midnight = (hour, AMPM) -> hour == 12 and AMPM == 0\n\n        time_expression = (Hour, Minute, Second, AMPM, SpecialTimeText ) ->\n            if not Hour? and not Minute? and not Second? and not AMPM? and not SpecialTimeText?\n                return\n            if SpecialTimeText\n                if SpecialTimeText.toLowerCase() == \"noon\"\n                    return {hour: 12}\n                if SpecialTimeText.toLowerCase() == \"midnight\"\n                    return {hour: 0}\n            d = {}\n            if Hour\n                d.hour = Number(Hour)\n            if Minute\n                d.minute = Number(Minute)\n            if Second\n                d.second = Number(Second)\n            if AMPM?\n                if d.hour\n                    if noon(d.hour, AMPM)\n                        d.hour = 12\n                    else if midnight(d.hour, AMPM)\n                        d.hour = 0\n                    else\n                        d.hour = d.hour + AMPM\n                d.am_pm = AMPM\n            if [d.hour, d.minute, d.second] == [undefined, undefined, undefined]\n                return undefined\n            return d\n\n\n        time_and_time = (Hour, Minute, AMPM1, Hour2, Minute2, AMPM2) ->\n            if AMPM2?\n                AMPM2 = am_pm(AMPM2)\n            if not AMPM1? and not AMPM2?\n                return [time_expression(Hour, Minute), time_expression(Hour2, Minute2)]\n            else if not AMPM1?\n                return [time_expression(Hour, Minute, undefined, AMPM2),\n                        time_expression(Hour2, Minute2, undefined, AMPM2)]\n            else if not AMPM2?\n                return [time_expression(Hour, Minute, undefined, AMPM1),\n                        time_expression(Hour2, Minute2, undefined, AMPM1)]\n\n\n        month_type = (input...) ->\n            for value in input\n                if value?\n                    return Number(value)\n\n\n        date_number = (Day, Abbr) -> if Day? then Number(Day)\n\n        month_number = (MonthNum) -> Number(MonthNum)\n\n        month_num_type = (input) -> Number(input)\n\n        year = (Year) -> if Year? then Number(Year)\n\nSometimes the value is [undefined, undefined, <value>],\nso I need to search for it and find it.\n\n        get_first_defined = (_) ->\n          for item in _\n            if item?\n              return item\n\n### Patterns\n\nThere's a some unwrapping values out of arrays here.\nBecause of the namedarguments issue functions receive a lot more\narrays then in Python and so they need to be unwrapped.\n\n        weekday_range_with_time = (time1, time2, [weekday1], [weekday2], MonthRange) ->\n            output = []\n\n            # Get first undefined value\n            # Since only one value in list will be defined (if any)\n            time1 = get_first_defined(time1)\n            time2 = get_first_defined(time2)\n\n            if time1?\n                for date in MonthRange\n                    output.push(_replace(date, time1))\n                    if time2?\n                        output.push(_replace(date, time2))\n            return output\n\n\n        weekday_range_with_extra = ( time, and_time, weekday_start, weekday_end, extra_time, extra_weekday, MonthRange) ->\n            output = []\n            if time?\n                for date in MonthRange\n                    if date.weekday?\n                        if date.weekday in [weekday_start .. weekday_end]\n                            output.push(_replace(date, time))\n                            if and_time?\n                                output.push(_replace(date, and_time))\n                        if date.weekday == extra_weekday\n                            output.push(_replace(date, extra_time))\n            return output\n\n\n        weekday_range_with_extra_backwards = (extra_time, extra_weekday, time, weekday_start, weekday_end, MonthRange ) ->\n            return weekday_range_with_extra(time[0], time[1], weekday_start, weekday_end, extra_time, extra_weekday, MonthRange )\n\n\n        reverse_basic_text = (time, day, month, year) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        basic_text = (time, first_second, weekday, month, day, year) ->\n            if not day?\n                day = 1\n            if (day instanceof Array) and day.length == 1\n              day = day[0]\n            if (year instanceof Array) and year.length == 1\n              year = year[0]\n            if not time?\n                return {year: year, month: month, day: day}\n            else\n                year: year\n                month: month\n                day: day\n                hour: time.hour\n                minute: time.minute\n                second: time.second\n                am_pm: time.am_pm\n\n\n        slash = (month, day, year, time) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        month_range = (month, date_a, date_b) ->\n            output = []\n            for day in [date_a .. date_b]\n                output.push(basic_text(undefined, undefined, undefined, month, day, undefined))\n            return output\n\n\n        multi_time = (time1, BasicText) ->\n            output = []\n            if time1? and BasicText?\n                output.push(_replace(BasicText, time1))\n                output.push(BasicText)\n                return output\n\n\n        large_repeat_words = ->\n            return undefined\n\n\n        weekday_range_with_time_range = (time1, weekday_range) ->\n            output = []\n            if time1? and weekday_range?\n                range = timedelta_from_Date(_replace(weekday_range[0], time1), weekday_range[0])\n                for weekday in weekday_range\n                    output.push(_replace(weekday, {hour:time1.hour, minute:time1.minute, am_pm:time1.am_pm}))\n                    output.push(range)\n                return output\n\n\n        time_range = (unstrict_time, strict_time, date, reverse) ->\n            endtime = date\n            starttime = endtime\n            if unstrict_time\n                starttime = _replace(starttime, {hour:Number(unstrict_time[0])})\n                if date.am_pm\n                    starttime = _replace(starttime, {hour: starttime.hour + date.am_pm, am_pm:date.am_pm})\n            else\n                starttime = _replace(starttime, {hour: strict_time.hour, minute: strict_time.minute})\n\n            time_range = timedelta_from_Date(starttime, endtime)\n            if reverse\n                time_range = timedelta_from_Date(endtime, starttime)\n            return [starttime, time_range]\n\n\n        alt_time_range = (first_second, weekday, month, day, year, time, unstrict_time, strict_time) ->\n            return time_range(unstrict_time, strict_time, basic_text(time, first_second, weekday, month, day, year), reverse)\n\n\n        until_range = (date1, date2) ->\n            if date1 and date2\n                return [date1, timedelta_from_Date(date1, date2)]\n\n\n        through_range = (time, weekday1, weekday2, month, date, beginning) ->\n            output = []\n            if month and date and beginning and weekday1\n                ending =\n                    month: month\n                    day: date\n                for day in [beginning.day .. ending.day]\n                    temp =\n                        month: month\n                        day: date\n                    if temp.weekday and in_array([weekday1 .. weekday2], temp.weekday)\n                        if time\n                            output.push(_replace(temp, time))\n                        else\n                            output.push(temp)\n                return output\n\n\n### The function list\n\nThis hash\/object matches all the functions with a\nstring that represents it in the parse tree.\n\n        functions =\n            # Groups\n            \"MonthString\": month_to_number,\n            \"AMPM\": am_pm,\n            # Expressions\n            \"Chase Year\": year,\n            \"Chase Date\": date_number,\n            \"Chase Month\": month_number,\n            \"Steve Valaitis\": time_expression,\n            \"Greg Burns\": (hour, am_pm) -> time_expression(hour, null, null, am_pm, null),\n            \"Greg Burns UnstrictTime:\": time_expression,\n            \"Steve Valaitis2\": military_time,\n            \"Steve Valaitis And Time\": time_and_time,\n            \"Text Parts\": time_expression,\n            \"Michael Ash10\": weekday_to_number,\n            # Types\n            \"Month\": month_type,\n            \"MonthNum\": month_num_type,\n            # Patterns\n            \"LargeRepeatWords\": large_repeat_words,\n            \"BasicText\": basic_text,\n            \"ReverseBasicText\": reverse_basic_text,\n            \"Slash\": slash,\n            \"MonthRange\": month_range,\n            \"MultiTime\": multi_time,\n            \"WeekdayRangeWithTime\": weekday_range_with_time,\n            \"WeekdayRangeWithExtra\": weekday_range_with_extra,\n            \"WeekdayRangeWithExtraBackwards\": weekday_range_with_extra_backwards,\n            \"WeekdayRangeWithTimeRange\": weekday_range_with_time_range,\n            \"UntilRange\": until_range,\n            \"ThroughRange\": through_range,\n            \"TimeRange\": time_range,\n            \"AltTimeRange\": alt_time_range,\n\nThis is default expression or pattern. ```any``` means\nif value is defined, and there is array with even a single defined value then return true.\n\n            \"_default\": (_) ->\n                if any(_) then _ else undefined\n\n```Type``` there is used to mean collection of expressions.\nI know that because only one will match, so you just have to find\nit and return it.\n\n            \"_default_type\": (_...) ->\n                if _?\n                    for item in _\n                         if item?\n                             return item\n\n            \"_default_group\": (_...) -> if _[0]? then _[0]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"87d3f4be548b7f85a80e3134ad887666f3c88297","subject":"Add docs for Batman model associations","message":"Add docs for Batman model associations\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/12_associations.litcoffee","new_file":"docs\/12_associations.litcoffee","new_contents":"# Batman.Model Associations\n\nThere are 3 types of assocations available on `Batman.Model`: `hasMany`, `belongsTo`, and `hasOne`.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.Set`. Generally they will return a `Batman.AssocationProxy` named after the association type,\nsuch as `Batman.BelongsToAssociationProxy` or `Batman.HasManyAssociationProxy`.\n\n`Batman.AssociationProxy` defines useful methods such as `@load`, `@toJSON`, `@loadFromLocal`. It also defines accessors such as `%loaded` and `%target`.\n\n## Shared Options\nAll assocations have a common set of options, as well as specific options for each type of relationship.\n\n##### `saveInline[= true] : boolean`\nWhether we should save the child objects as part of the parent object's JSON\n\n##### `autoload[= true] : boolean`\n Whether we should load the child objects when loading the parent object.\n\n##### `nestUrl[= false] : boolean`\nWhether the child models are persisted beneath the parent models url structure.\n\n##### `name : String`\nThe name of the child model for the association. (eg. App.Product)\n\n##### `inverseOf : String`\nThe foreign association to set on load.\n\n##### `encoderKey : String`\nThe key to encode and decode the assocation into\/from JSON.\n\n##### `namespace[= Batman.currentApp] : String`\nThe location of the model definition for the association.\n\n##### `polymorphic[= false] : boolean`\nWhether the association is polymorphic.\n\n## @hasMany(label[, options])\n`hasMany` assocations are used for expressing one-to-many relationships on a `Batman.Model`.\n\n- `label : String`\n- `options : Object`\n  - `primaryKey : String`\n  - `foreignKey : String`\n  - `as : String`\n    - the parent association name on child objects in a polymorphic association\n\n## @hasOne(label[, options])\n`hasOne` associations are used for expressing one-to-one relationships on a `Batman.Model`.\n\n- `label : String`\n- `options : Object`\n  - `primaryKey : String`\n  - `foreignKey : String`\n  - `as : String`\n    - the parent association name on child objects in a polymorphic association\n\n## @belongsTo(label[, options])\n`belongsTo` associatons are used fro expressing one-to-one child relationships on a `Batman.Model`.\n\n- `label : String`\n- `options : Object`\n  - `primaryKey : String`\n  - `foreignKey : String`\n  - `encodeForeignKey[= true] boolean`\n    - whether to encode the foreignKey value when persisting the model","old_contents":"","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"def2c734f2b98fc7f70fe0cde5b6a64ac2ea06d5","subject":"Refactor:  change markdown style for inline code.","message":"Refactor:  change markdown style for inline code.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.  The `options` parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters, `interval` (a dictionary with `start` and `end` values, each of Date type) and corresponding to that interval `width` of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {\n          lines: ticks.concat axisLine\n          textLabels\n        }\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for a (`start`, `end`) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not inside the given `interval` (excluding beginning).  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        oldX = event.clientX\n        oldY = event.clientY\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          multiplier = Math.pow(base, event.deltaY)\n          interval = end-start\n          midPoint = start.getTime() + interval \/ 2\n          interval *= multiplier\n          start = new Date(midPoint - interval\/2)\n          end = new Date(midPoint + interval\/2)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The __TimelineMaker__ class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the __TimelineMaker__ class.  The __options__ parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are __formatTimeAxis()__, which formats time axis into a dictionary that describes the look of axis, and one of the __renderTo...__ functions that render that data dictionary to a desired context.\n\n#### The __formatTimeAxis()__ function\n\nA function that formats time axis into an intermediate format.  It has two parameters, __interval__ (a dictionary with __start__ and __end__ values, each of Date type) and corresponding to that interval __width__ of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be __options.intervalMultiplier__.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, __findPointList()__.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical element properties.  To transform time value into a coordinate we use the __timeToCoord()__ function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe should probably change ticks dictionary to lines dictionary instead, so we can add other types of lines, like baseline.  It could be better also to move all constants to options and make ticks drawing more flexible.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we add text labels too.\n\nHere we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {\n          lines: ticks.concat axisLine\n          textLabels\n        }\n\n#### The __findPointList()__ function\n\nThis function returns a list of points that are needed to be calculated for a (__start__, __end__) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the __start__ of the interval.  We move code that does that to the __findLeftTime()__.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using __findNextPoint()__ function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The __findLeftTime()__ function\n\nThe __findLeftTime()__ function calculates the rightmost point of time for current __options.intervalType__ such that it is not inside the given __interval__ (excluding beginning).  The __options.intervalType__ could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, __options.intervalMultiplier__, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the __options.intervalMultiplier__ should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the __findNextPoint()__ function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In __findNextPoint()__ we make sure that edge points are consistent while using different values of __start__.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The __findNextPoint()__ function\n\nThis function calculates next edge time point for a current options assuming __timePoint__ argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The __timeToCoord()__ function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The __renderToCanvas()__ function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        oldX = event.clientX\n        oldY = event.clientY\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          multiplier = Math.pow(base, event.deltaY)\n          interval = end-start\n          midPoint = start.getTime() + interval \/ 2\n          interval *= multiplier\n          start = new Date(midPoint - interval\/2)\n          end = new Date(midPoint + interval\/2)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d94ecb3929840dca26843ab69d300308a36c0255","subject":"document encodeWithIndexes option","message":"document encodeWithIndexes option\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/11_associations.litcoffee","new_file":"docs\/11_associations.litcoffee","new_contents":"# \/api\/App Components\/Batman.Model\/Batman.Model Associations\nbatman.js associations are modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). There are 3 types of assocations available on `Batman.Model`: [`hasMany`](\/docs\/api\/batman.model_associations.html#class_function_hasmany), [`belongsTo`](\/docs\/api\/batman.model_associations.html#class_function_belongsto), and [`hasOne`](\/docs\/api\/batman.model_associations.html#class_function_hasone). batman.js also supports polymorphic associations through the use of [polymorphic-specific options](\/docs\/api\/batman.model_associations.html#polymorphic_association_options).\n\nTo add associations to your models, declare them in your model definition. Association functions take a label (string) and options (Object). The label names the association and is used to provide smart defaults for several options. All available options are [detailed below](\/docs\/api\/batman.model_associations.html#association_options).\n\nFor example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', inverseOf: 'parentItem', encoderKey: 'children'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItem'\n```\n\nThen, associated records will be available via accessors:\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n\n  child.set('parentItem', parent)\n  child.get('parentItem') # => parent\n```\n\nor,\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n  secondChild = new App.ChildItem\n  parent.get('childItems').add(child)\n  parent.get('childItems').add(secondChild)\n  parent.get('childItems') # => Batman.AssociationSet\n  parent.get('childItems.length') # => 2\n```\n\n## @hasMany(label : string [, options : Object])\n`hasMany` expresses a one-to-many relationship on a `Batman.Model`.\n\n## @hasOne(label : string [, options : Object])\n`hasOne` expresses a one-to-one relationship on a `Batman.Model` when this model contains the primary key (eg, `id`) and does not contain the foreign key. If this model contains the foreign key, use `belongsTo` instead.\n\n## @belongsTo(label : string [, options : Object])\n`belongsTo` expresses a one-to-one relationship on a `Batman.Model` when this model contains the foreign key (eg, `parent_id`). If the other model contains the foreign key, use `hasOne` instead. It often expresses inverse of a `hasMany` or `hasOne` association. You can declare this with the `inverseOf` option (see [options](\/docs\/api\/batman.model_associations.html#association_options) below) so that both sides of the association are loaded from JSON.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.AssociationSet` or `Batman.Model`. Generally they will return a `Batman.AssocationProxy` named after the association type, such as `Batman.BelongsToAssociationProxy` or `Batman.HasOneAssociationProxy`.\n\n\n## ::load(callback : Function)\nCalled to load the associated record from storage, setting it as  [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target). If a callback is passed, it is called with two arguments: any error and the loaded record. Also, when this function finishes, it sets [`loaded`](\/docs\/api\/batman.model_associations.html#prototype_accessor_loaded) to `true` and fires `loaded` on the record.\n\n## ::toJSON() : Object\nReturns a [stringifiable JavaScript object](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/JSON\/stringify#toJSON_behavior) for the target record, if the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) is present.\n\n## ::%target\nThe associated record. Getting `target` does not implicitly call `load` on the association.\n\n## ::%loaded\n`true` or `false`, whether or not the record has been loaded from storage.\n\n## ::fetchFromLocal()\nThis method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). If this method returns a falsy value, then [`fetchFromRemote`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromremote) is called.  `Batman.AssocationProxy` subclasses must implement this method.\n\n## ::fetchFromRemote([callback : Function])\nIf [`fetchFromLocal`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromlocal) returns a falsy value, this method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). The `callback` is called with two arguments: any error and the fetched record(s). `Batman.AssocationProxy` subclasses must implement this method.\n\n## Association Options\n\n##### `primaryKey[= \"id\"] : string`\nThe primary key for the association.\n\n##### `foreignKey[= \"#{label}_id\"] : string`\nThe foreign key for the association.\n\n##### `saveInline[= false] : boolean`\nIf true, this model's attributes will be included in the associated model's JSON. This means that when an associated record is saved, this record's attributes will be included in the JSON.  (An alternative might be to include the associations' primary keys in the model's JSON with an [encoder](\/docs\/api\/batman.model.html#class_function_encode).)\n\n##### `autoload[= true] : boolean`\nIf `true`, batman.js will automatically call `load` when the associated records are accessed. This is useful in view bindings, where binding to the associated records will automatically cause them to be loaded.\n\n##### `nestUrl[= false] : boolean`\nIf `true`, this model's URL will be nested under the associated model:\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', nestUrl: true\n\n# ...\n\nchild = new ChildItem(parent_id: 1, id: 5)\nchild.url() # => 'parent_items\/1\/child_items\/5'\n```\n\n`nestUrl` only applies if the model is persisted with `Batman.RestStorage` (or a subclass).\n\n##### `name : string`\nBy default, batman.js checks for a model with the singular, camel-case name of association's `label` attached to `Batman.currentApp`. If the associated model's name is different from that, use `name` to specify it.\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem' # automatically finds App.ParentItem\n  @belongsTo 'alternativeParentItem', name: 'ParentItem' # also finds App.ParentItem\n```\n\n##### `inverseOf : string`\nThe foreign association to set on load. If the associated model has an association with the same name as the `inverseOf` value, it will be populated when data is loaded from storage. For example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true, inverseOf: 'parentItem'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItems'\n```\n\nwould allow:\n\n```coffeescript\nApp.ParentItem.find 1, (err, parent) ->\n  children = parent.get('childItems')\n  children.get('first.parentItem') == parent # => true\n\nApp.ChildItem.find 5, (err, childItem) ->\n  childItem.get('parentItem').load (err, parent) ->\n    parent.get('childItems').has(childItem) # => true\n```\n\n##### `encoderKey[= label] : string`\nKey that represents this association's records when in serialized form. For example,\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', encoderKey: 'children'\n```\n\nwill correctly decode this JSON:\n\n```javascript\n{id: 1, children: [{ id: 5, parent_id: 1 }, {id: 6, parent_id: 1}]}\n```\n\nIt will also encode the `childItems` as `children` (unless `saveInline` is set to `false`).\n\n##### `encodeWithIndexes[= false] : boolean`\n\nIf `true`, `@hasMany` associations will be encoded as a JSON object with index keys instead of arrays. For example: \n\n```javascript \n{ id: 1,\n  name: \"As Seen on TV Warehouse\",\n  products: {\n    \"0\": {id: 1, name: \"Orange Glo\"},\n    \"1\": {name: \"Oxyclean\"}\n  }\n}\n```\n\n##### `namespace[= Batman.currentApp] : string`\nbatman.js expects to find a model with the given `name` on `Batman.currentApp`. If your model is defined elsewhere, use `namespace` to specify where the model is defined.\n\n```coffeescript\nclass App.Admin.Person extends Batman.Model\n  @belongsTo 'organization', namespace: App.Admin # finds App.Admin.Organization instead of App.Organization\n```\n\n## Polymorphic Association Options\nbatman.js also supports [polymorphic associations](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations). For example:\n\n```coffeescript\nclass App.Superpower extends Batman.Model\n  @encode 'name'\n  @belongsTo 'superpowerable', polymorphic: true\n\nclass App.Hero extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n\nclass App.Villain extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n```\nBy default, attributes of the polymorphic association will be encoded according to the label. So, `hero.toJSON()` might return:\n\n```javascript\n{ id: 1,\n  name: 'Superman',\n  superpowers: [\n    {id: 15, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Super Strength'},\n    {id: 16, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Invincibility'},\n  ]\n}\n```\n\n##### `polymorphic[= false] : boolean`\nSet to `true` when the association is [polymorphic](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations).\n\n##### `as : string`\nSpecifies the name of the polymorphic interface.\n\n##### `foreignTypeKey[= \"#{label}_type\"] : string`\nSpecifies the field which contains the `type` for a polymorphic record.\n\n##### `encodeForeignTypeKey[=true] : boolean`\nSet to `true` when the `foreignTypeKey` should be included in the JSON of the record.\n","old_contents":"# \/api\/App Components\/Batman.Model\/Batman.Model Associations\nbatman.js associations are modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). There are 3 types of assocations available on `Batman.Model`: [`hasMany`](\/docs\/api\/batman.model_associations.html#class_function_hasmany), [`belongsTo`](\/docs\/api\/batman.model_associations.html#class_function_belongsto), and [`hasOne`](\/docs\/api\/batman.model_associations.html#class_function_hasone). batman.js also supports polymorphic associations through the use of [polymorphic-specific options](\/docs\/api\/batman.model_associations.html#polymorphic_association_options).\n\nTo add associations to your models, declare them in your model definition. Association functions take a label (string) and options (Object). The label names the association and is used to provide smart defaults for several options. All available options are [detailed below](\/docs\/api\/batman.model_associations.html#association_options).\n\nFor example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', inverseOf: 'parentItem', encoderKey: 'children'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItem'\n```\n\nThen, associated records will be available via accessors:\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n\n  child.set('parentItem', parent)\n  child.get('parentItem') # => parent\n```\n\nor,\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n  secondChild = new App.ChildItem\n  parent.get('childItems').add(child)\n  parent.get('childItems').add(secondChild)\n  parent.get('childItems') # => Batman.AssociationSet\n  parent.get('childItems.length') # => 2\n```\n\n## @hasMany(label : string [, options : Object])\n`hasMany` expresses a one-to-many relationship on a `Batman.Model`.\n\n## @hasOne(label : string [, options : Object])\n`hasOne` expresses a one-to-one relationship on a `Batman.Model` when this model contains the primary key (eg, `id`) and does not contain the foreign key. If this model contains the foreign key, use `belongsTo` instead.\n\n## @belongsTo(label : string [, options : Object])\n`belongsTo` expresses a one-to-one relationship on a `Batman.Model` when this model contains the foreign key (eg, `parent_id`). If the other model contains the foreign key, use `hasOne` instead. It often expresses inverse of a `hasMany` or `hasOne` association. You can declare this with the `inverseOf` option (see [options](\/docs\/api\/batman.model_associations.html#association_options) below) so that both sides of the association are loaded from JSON.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.AssociationSet` or `Batman.Model`. Generally they will return a `Batman.AssocationProxy` named after the association type, such as `Batman.BelongsToAssociationProxy` or `Batman.HasOneAssociationProxy`.\n\n\n## ::load(callback : Function)\nCalled to load the associated record from storage, setting it as  [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target). If a callback is passed, it is called with two arguments: any error and the loaded record. Also, when this function finishes, it sets [`loaded`](\/docs\/api\/batman.model_associations.html#prototype_accessor_loaded) to `true` and fires `loaded` on the record.\n\n## ::toJSON() : Object\nReturns a [stringifiable JavaScript object](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/JSON\/stringify#toJSON_behavior) for the target record, if the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) is present.\n\n## ::%target\nThe associated record. Getting `target` does not implicitly call `load` on the association.\n\n## ::%loaded\n`true` or `false`, whether or not the record has been loaded from storage.\n\n## ::fetchFromLocal()\nThis method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). If this method returns a falsy value, then [`fetchFromRemote`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromremote) is called.  `Batman.AssocationProxy` subclasses must implement this method.\n\n## ::fetchFromRemote([callback : Function])\nIf [`fetchFromLocal`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromlocal) returns a falsy value, this method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). The `callback` is called with two arguments: any error and the fetched record(s). `Batman.AssocationProxy` subclasses must implement this method.\n\n## Association Options\n\n##### `primaryKey[= \"id\"] : string`\nThe primary key for the association.\n\n##### `foreignKey[= \"#{label}_id\"] : string`\nThe foreign key for the association.\n\n##### `saveInline[= false] : boolean`\nIf true, this model's attributes will be included in the associated model's JSON. This means that when an associated record is saved, this record's attributes will be included in the JSON.  (An alternative might be to include the associations' primary keys in the model's JSON with an [encoder](\/docs\/api\/batman.model.html#class_function_encode).)\n\n##### `autoload[= true] : boolean`\nIf `true`, batman.js will automatically call `load` when the associated records are accessed. This is useful in view bindings, where binding to the associated records will automatically cause them to be loaded.\n\n##### `nestUrl[= false] : boolean`\nIf `true`, this model's URL will be nested under the associated model:\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', nestUrl: true\n\n# ...\n\nchild = new ChildItem(parent_id: 1, id: 5)\nchild.url() # => 'parent_items\/1\/child_items\/5'\n```\n\n`nestUrl` only applies if the model is persisted with `Batman.RestStorage` (or a subclass).\n\n##### `name : string`\nBy default, batman.js checks for a model with the singular, camel-case name of association's `label` attached to `Batman.currentApp`. If the associated model's name is different from that, use `name` to specify it.\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem' # automatically finds App.ParentItem\n  @belongsTo 'alternativeParentItem', name: 'ParentItem' # also finds App.ParentItem\n```\n\n##### `inverseOf : string`\nThe foreign association to set on load. If the associated model has an association with the same name as the `inverseOf` value, it will be populated when data is loaded from storage. For example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true, inverseOf: 'parentItem'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItems'\n```\n\nwould allow:\n\n```coffeescript\nApp.ParentItem.find 1, (err, parent) ->\n  children = parent.get('childItems')\n  children.get('first.parentItem') == parent # => true\n\nApp.ChildItem.find 5, (err, childItem) ->\n  childItem.get('parentItem').load (err, parent) ->\n    parent.get('childItems').has(childItem) # => true\n```\n\n##### `encoderKey[= label] : string`\nKey that represents this association's records when in serialized form. For example,\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', encoderKey: 'children'\n```\n\nwill correctly decode this JSON:\n\n```javascript\n{id: 1, children: [{ id: 5, parent_id: 1 }, {id: 6, parent_id: 1}]}\n```\n\nIt will also encode the `childItems` as `children` (unless `saveInline` is set to `false`).\n\n##### `namespace[= Batman.currentApp] : string`\nbatman.js expects to find a model with the given `name` on `Batman.currentApp`. If your model is defined elsewhere, use `namespace` to specify where the model is defined.\n\n```coffeescript\nclass App.Admin.Person extends Batman.Model\n  @belongsTo 'organization', namespace: App.Admin # finds App.Admin.Organization instead of App.Organization\n```\n\n## Polymorphic Association Options\nbatman.js also supports [polymorphic associations](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations). For example:\n\n```coffeescript\nclass App.Superpower extends Batman.Model\n  @encode 'name'\n  @belongsTo 'superpowerable', polymorphic: true\n\nclass App.Hero extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n\nclass App.Villain extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n```\nBy default, attributes of the polymorphic association will be encoded according to the label. So, `hero.toJSON()` might return:\n\n```javascript\n{ id: 1,\n  name: 'Superman',\n  superpowers: [\n    {id: 15, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Super Strength'},\n    {id: 16, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Invincibility'},\n  ]\n}\n```\n\n##### `polymorphic[= false] : boolean`\nSet to `true` when the association is [polymorphic](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations).\n\n##### `as : string`\nSpecifies the name of the polymorphic interface.\n\n##### `foreignTypeKey[= \"#{label}_type\"] : string`\nSpecifies the field which contains the `type` for a polymorphic record.\n\n##### `encodeForeignTypeKey[=true] : boolean`\nSet to `true` when the `foreignTypeKey` should be included in the JSON of the record.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6345bc53d304a42f8b8f9a479c30389863cf53f8","subject":"Update do_render signature to accept ctx bing passed","message":"Update do_render signature to accept ctx bing passed\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_blocks.litcoffee","new_file":"lib\/render-pipelines\/png\/png_blocks.litcoffee","new_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngBlocks extends PngRenderer\n\n      do_render: (ctx, path) =>\n        width  = @config.width\n        height = @config.height\n\n        for step in path\n          ctx.fillStyle = @config.block.fill_color\n\n          ctx.beginPath()\n          ctx.rect width * step.col, height * step.row, width, height\n          ctx.fill()\n\n    module.exports = PngBlocks\n","old_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngBlocks extends PngRenderer\n\n      do_render: (path) =>\n        ctx    = PngRenderer.ctx\n        width  = @config.width\n        height = @config.height\n\n        for step in path\n          ctx.fillStyle = @config.block.fill_color\n\n          ctx.beginPath()\n          ctx.rect width * step.col, height * step.row, width, height\n          ctx.fill()\n\n    module.exports = PngBlocks\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7058396bedcf5b094f4c7c2c1db1d17bde34fc7c","subject":"formatting","message":"formatting\n","repos":"stephenhutchings\/written,stephenhutchings\/written","old_file":"underscore.strings.litcoffee","new_file":"underscore.strings.litcoffee","new_contents":"### Underscore Strings\n\nUseful Underscore string methods for more readable, human language\n\nDo nothing without the presence of Underscore.\n\n    return unless _?\n\nThis regular expression includes words we won't capitalize.\n\n    noncapsWords = \/^(a|an|and|as|be|of|the|to)$\/\n\n...and this helps to split \"cased\" words into their constituent parts...\n\n    caseSplitter = \/[-_\\s]|(!?[A-Z][a-z]*)\/g\n\n...so we can join them together with some glue.\n\n    cleanJoin    = (arr, glue) -> _.compact(arr).join(glue)\n\nAssuming we are using the English language, we'll declare some numbers\n\n    numbers =\n      \"EN\": [\"one\", \"two\", \"three\", \"four\", \"five\", \"six\", \"seven\",\"eight\", \"nine\", \"ten\", \"eleven\", \"twelve\"]\n      \"FR\": [{m: \"un\", f: \"une\"}, \"deux\", \"trois\", \"quatre\", \"cinq\", \"six\", \"sept\", \"huit\", \"neuf\", \"dix\", \"onze\", \"douze\"]\n      \"DE\": [\"eins\", \"zwei\", \"drei\", \"vier\", \"f\u00fcnf\", \"sechs\", \"sieben\", \"acht\", \"neun\", \"zehn\", \"elf\", \"zw\u00f6lf\"]\n      \"IT\": [{m: \"uno\", f: \"una\"}, \"due\", \"tre\", \"quattro\", \"cinque\", \"sei\", \"sette\", \"otto\", \"nove\", \"dieci\", \"undici\", \"dodic\"]\n      \"ES\": [{m: \"uno\", f: \"una\"}, \"dos\", \"tres\", \"cuatro\", \"cinco\", \"seis\", \"siete\", \"ocho\", \"nueve\", \"diez\", \"once\", \"doce\"]\n\nDeclare the mixins we're adding...\n\n    mixins =\n\n#### Capitalization\nCapitalize the first letter of a string.\n\n      capitalize: (str) ->\n        str.charAt(0).toUpperCase() + str.slice(1)\n\nCapitalize all words in a string apart from some common lower case words.\n\n```coffee\n# Examples\n_.capitalizeAll(\"this and that\") # \"This and That\"\n```\n\n      capitalizeAll: (str, regEx = noncapsWords) ->\n        _.map(str.split(\" \"), (s, i) ->\n          if i > 0 and regEx.test(s) then s else _.capitalize(s)\n        ).join(\" \")\n\n\n#### Cases\nTransform strings between common code cases:\n\n```coffee\n# Examples\n_.camelCase(\"some-thing\")  # \"someThing\"\n_.hyphenCase(\"some_thing\") # \"some-thing\"\n_.snakeCase(\"someThing\")   # \"some_thing\"\n_.humanCase(\"fromA_to-Z\")  # \"from A to Z\"\n```\n\n      camelCase: (str) ->\n        str.replace(\/[\\s_-](\\w)\/g, (a, w) -> w.toUpperCase())\n\n      hyphenCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \"-\").toLowerCase()\n\n      snakeCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \"_\").toLowerCase()\n\n      humanCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \" \")\n\n\n#### Tags\nEnclose a string inside an HTML tag.\n\n```coffee\n# Examples\n_.wrapInTag(\"Hello world!\", \"strong\") # \"<strong>Hello world!<\/strong>\"\n```\n\n      wrapInTag: (str, tag = \"span\") ->\n        \"<#{tag}>#{str}<\/#{tag}>\"\n\n#### Lists\nGroup strings into a grammatically correct list with an arbitrary limit.\n\n```coffee\n# Examples\n_.prettyList([\"Ben\", \"Bob\"])                      # \"Ben and Bob\"\n_.prettyList([\"Ben\", \"Bob\", \"Bill\"])              # \"Ben, Bob and Bill\"\n_.prettyList([\"Ben\", \"Bob\", \"Bill\", \"Max\"], 2)    # \"Ben, Bob and 2 more\"\n_.prettyList([\"Ben\", \"Bob\"], 1, {more: \"other\"})  # \"Ben and 1 other\"\n```\n\n      prettyList: (arr, max, opts = {}) ->\n        more   = opts.more or \"more\"\n        amp    = opts.amp or \"and\"\n\n        if opts.wrap\n          arr = _.map(arr, (s) -> _.wrapInTag(s, opts.wrap))\n\n        if max < (len = arr.length)\n          diff = len - max\n          more = _.quantify(more, diff, false) if opts.quantify\n          diff = _.writtenNumber(diff, opts.numbers) if opts.written\n          arr  = arr.slice(0, max)\n          arr  = arr.concat(\"#{diff} #{more}\")\n\n        arr\n          .slice(0, -1)\n          .join(\", \")\n          .concat((if arr.length is 1 then \"\" else \" #{amp} \"), arr.slice(-1))\n\n\n#### Hyphenation\nAdd soft hyphens every `n` characters so that the CSS attribute\n`hyphens: manual` will allow for nice breaks in long strings of text.\n\n```coffee\n# Examples\n_.hyphenate(\"antidisestablishmentarianism\") # \"antidisest%C2%ADablishment%C2%ADarianism\"\n```\n\n      hyphenate: (str = \"\", n = 10, softHyphen = \"\\u00AD\") ->\n        str.replace new RegExp(\"\\\\w{#{n}}\", \"g\"), (w) -> w + softHyphen\n\n\nAdd an \"s\" to a string when an amount is non-singular, disregarding the\norder of the arguments passsed.\n\n```coffee\n# Examples\n_.prettyList(\"monkey\", 1)                   # \"1 monkey\"\n_.prettyList(1, \"monkey\")                   # \"1 monkey\"\n_.prettyList(\"monkey\", 9, written: true)    # \"nine monkeys\"\n```\n\n      quantify: (str, n, {numberless, written, lang}) ->\n        { n, str } = str: n, n: str unless _.isString(str)\n\n        _n = _.writtenNumber(n, lang) if written?\n\n        (if numberless? then \"\" else _n + \" \") +\n        str +\n        (if n is 1 then \"\" else \"s\")\n\n#### Written Numbers\nConvert numbers between one and twelve into their written counter-parts.\n\n```coffee\n# Examples\n_.writtenNumber(1)                          # \"one\"\n_.writtenNumber(2, \"DE\")                    # \"zwei\"\n```\n\n      writtenNumber: (n, lang = \"EN\", gender = \"m\") ->\n        if n < 13\n          num = numbers[lang][n - 1]\n          num[gender] and num[gender] or num\n        else\n          n\n\n      setNumbers: (arr, lang) ->\n        numbers[lang] = arr\n\nAdd the mixin object to Underscore.\n\n    _.mixin(mixins)\n","old_contents":"Do nothing without the presence of Underscore.\n\n    return unless _?\n\nThis regular expression includes words we won't capitalize.\n\n    noncapsWords = \/^(a|an|and|as|be|of|the|to)$\/\n\n...and this helps to split \"cased\" words into their constituent parts...\n\n    caseSplitter = \/[-_\\s]|(!?[A-Z][a-z]*)\/g\n\n...so we can join them together with some glue.\n\n    cleanJoin    = (arr, glue) -> _.compact(arr).join(glue)\n\nAssuming we are using the English language, we'll declare some numbers\n\n    numbers =\n      \"EN\": [\"one\", \"two\", \"three\", \"four\", \"five\", \"six\", \"seven\",\"eight\", \"nine\", \"ten\", \"eleven\", \"twelve\"]\n      \"FR\": [{m: \"un\", f: \"une\"}, \"deux\", \"trois\", \"quatre\", \"cinq\", \"six\", \"sept\", \"huit\", \"neuf\", \"dix\", \"onze\", \"douze\"]\n      \"DE\": [\"eins\", \"zwei\", \"drei\", \"vier\", \"f\u00fcnf\", \"sechs\", \"sieben\", \"acht\", \"neun\", \"zehn\", \"elf\", \"zw\u00f6lf\"]\n      \"IT\": [{m: \"uno\", f: \"una\"}, \"due\", \"tre\", \"quattro\", \"cinque\", \"sei\", \"sette\", \"otto\", \"nove\", \"dieci\", \"undici\", \"dodic\"]\n\nDeclare the mixins we're adding...\n\n    mixins =\n\nCapitalize the first letter of a string.\n\n      capitalize: (str) ->\n        str.charAt(0).toUpperCase() + str.slice(1)\n\nCapitalize all words in a string apart from some common lower case words.\n\n```coffee\n_.capitalizeAll(\"this and that\") # \"This and That\"\n```\n\n      capitalizeAll: (str, regEx = noncapsWords) ->\n        _.map(str.split(\" \"), (s, i) ->\n          if i > 0 and regEx.test(s) then s else _.capitalize(s)\n        ).join(\" \")\n\n\nTransform strings between common code cases:\n\n```coffee\n_.camelCase(\"some-thing\")  # \"someThing\"\n_.hyphenCase(\"some_thing\") # \"some-thing\"\n_.snakeCase(\"someThing\")   # \"some_thing\"\n_.humanCase(\"fromA_to-Z\")  # \"from A to Z\"\n```\n\n      camelCase: (str) ->\n        str.replace(\/[\\s_-](\\w)\/g, (a, w) -> w.toUpperCase())\n\n      hyphenCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \"-\").toLowerCase()\n\n      snakeCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \"_\").toLowerCase()\n\n      humanCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \" \")\n\n\nEnclose a string inside an HTML tag.\n\n```coffee\n_.wrapInTag(\"Hello world!\", \"strong\") # \"<strong>Hello world!<\/strong>\"\n```\n\n      wrapInTag: (str, tag = \"span\") ->\n        \"<#{tag}>#{str}<\/#{tag}>\"\n\nGroup strings into a grammatically correct list with an arbitrary limit.\n\n```coffee\n_.prettyList([\"Ben\", \"Bob\"])                    # \"Ben and Bob\"\n_.prettyList([\"Ben\", \"Bob\", \"Bill\"])            # \"Ben, Bob and Bill\"\n_.prettyList([\"Ben\", \"Bob\", \"Bill\", \"Max\"], 2)  # \"Ben, Bob and 2 more\"\n_.prettyList([\"Ben\", \"Bob\"], 1, \"other\")        # \"Ben and 1 other\"\n```\n\n      prettyList: (arr, max, opts = {}) ->\n        more   = opts.more or \"more\"\n        amp    = opts.amp or \"and\"\n\n        if opts.wrap\n          arr = _.map(arr, (s) -> _.wrapInTag(s, opts.wrap))\n\n        if max < (len = arr.length)\n          diff = len - max\n          more = _.quantify(more, diff, false) if opts.quantify\n          diff = _.writtenNumber(diff, opts.numbers) if opts.written\n          arr  = arr.slice(0, max)\n          arr  = arr.concat(\"#{diff} #{more}\")\n\n        arr\n          .slice(0, -1)\n          .join(\", \")\n          .concat((if arr.length is 1 then \"\" else \" #{amp} \"), arr.slice(-1))\n\n\nAdd soft hyphens every `n` characters so that the CSS attribute\n`hyphens: manual` will allow for nice breaks in long strings of text.\n\n```coffee\n_.hyphenate(\"antidisestablishmentarianism\") # \"antidisest%C2%ADablishment%C2%ADarianism\"\n```\n\n      hyphenate: (str = \"\", n = 10, softHyphen = \"\\u00AD\") ->\n        str.replace new RegExp(\"\\\\w{#{n}}\", \"g\"), (w) -> w + softHyphen\n\n\nAdd an \"s\" to a string when an amount is non-singular, disregarding the\norder of the arguments passsed.\n\n```coffee\n_.prettyList(\"monkey\", 1)                   # \"1 monkey\"\n_.prettyList(1, \"monkey\")                   # \"1 monkey\"\n_.prettyList(\"monkey\", 9, written: true)    # \"nine monkeys\"\n```\n\n      quantify: (str, n, {numberless, written, lang}) ->\n        { n, str } = str: n, n: str unless _.isString(str)\n\n        _n = _.writtenNumber(n, lang) if written?\n\n        (if numberless? then \"\" else _n + \" \") +\n        str +\n        (if n is 1 then \"\" else \"s\")\n\nConvert numbers between one and twelve into their written counter-parts.\n\n```coffee\n_.writtenNumber(1)                          # \"one\"\n_.writtenNumber(2, [\"ein\", \"zwei\", \"drei\"]) # \"zwei\"\n```\n\n      writtenNumber: (n, lang = \"EN\", gender ?= \"m\") ->\n        if n < 13\n          num = numbers[lang][n - 1]\n          num[gender] and num[gender] or num\n        else\n          n\n\n      setNumbers: (arr, lang) ->\n        numbers[lang] = arr\n\nAdd the mixin object to Underscore.\n\n    _.mixin(mixins)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bfdcbecefda50eb1c2d599e3954483adcb59fc3f","subject":"Cleaned up the available data model - which simplified a lot","message":"Cleaned up the available data model - which simplified a lot\n\n_Also did some refactoring_\n\nThe `constructor: -> super` garbage is no longer necessary.\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    Array.prototype.last = -> this[this.length - 1]\n\n    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n\n    microtime = require 'microtime'\n\n    logger = require '.\/logger'\n\n    available   = { }\n    initialized = { }\n\n    class Madul\n\n      do_wrap: (method) =>\n        callMe = @[method]\n\n        @[\"_#{method}\"] = @[method]\n\n        @[method] = =>\n          deferred = q.defer()\n          start    = microtime.now()\n          update   = start\n\n          respond = (state, data) =>\n            deferred[state] data\n\n            if state == 'reject'\n              logger.rejected @clazz, method, microtime.now() - start, data\n\n            if process.env.MADUL_LOG_LEVEL > 4\n              if state == 'resolve'\n                logger.resolved @clazz, method, microtime.now() - start, data\n              else if state == 'notify'\n                logger.notify @clazz, method, microtime.now() - update, data\n                update = microtime.now()\n\n          @done   = (out) => respond 'resolve', out\n          @fail   = (err) => respond 'reject',  err\n          @update = (out) => respond 'notify',  out\n\n          args = Array.prototype.slice.call arguments\n\n          logger.trace \"Invoking #{@clazz}.#{method}()\", args\n\n          @[\"_#{method}\"].apply null, args\n\n          deferred.promise\n\n      wrap_methods: => @pub?.forEach (method) => @do_wrap method\n\n      strip: (name) => name.toLowerCase().replace \/\\W+\/g, ''\n\n      make_available: (name, mod) => available[@strip name] = mod\n\n      hydrate: (deps, done) =>\n        load = (name, path, loaded) =>\n          mod = require path\n\n          if typeof mod == 'function'\n            new mod name\n              .initialize @ctor_params?[name]\n              .then (mod) =>\n                @make_available name, mod\n                loaded true\n          else\n            @make_available name, mod\n            loaded true\n\n        check = (path, dep, loaded) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              done type: 'ERROR', info: err\n            else\n              async.each files, (f, next) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.stat depth, (e, s) =>\n                  if s.isDirectory() && f[0] != '.'\n                    check depth, dep, => next()\n                  else if s.isFile() && f.substring(0, f.length - 3) == dep\n                    load f.substring(0, f.length - 3), depth, => loaded true\n                  else\n                    next()\n              , => loaded true\n\n        add_dependency = (name, mod) =>\n          n = name.replace \/\\W+\/g, '_'\n          @[n] = mod\n\n        do_add = (name, next) =>\n          add_dependency name, available[@strip name]\n          next()\n\n        add = (name, resource, next) =>\n          @make_available name, require resource\n          do_add name, next\n\n        async.eachSeries deps, (d, next) =>\n          if @[d]? == false\n            if available[@strip d]? == true\n              do_add d, next\n            else\n              try\n                add d, d, next\n              catch e\n                cwd = process.cwd()\n                pkg = \"#{cwd}\/node_modules\/#{d}\/package.json\"\n\n                fs.stat pkg, (err, stat) =>\n                  if stat?.isFile()\n                    fs.readFile pkg, 'utf8', (err, data) =>\n                      json = JSON.parse data\n                      main = json.main || json._main\n\n                      add d, \"#{cwd}\/node_modules\/#{d}\/#{main}\", next\n                  else\n                    check \"#{cwd}\/dist\", d, (loaded) => do_add d, next if loaded\n          else\n            next()\n        , done\n\n      finish_up: (resolve, args) =>\n        if typeof @post_initialize == 'function'\n          @do_wrap 'post_initialize'\n          @post_initialize args\n            .then =>\n              @make_available @clazz, @\n              resolve @\n        else\n          @make_available @clazz, @\n          resolve @\n\n      initialize: (args = { }) =>\n        deferred = q.defer()\n\n        @clazz = @constructor.name unless @clazz?\n\n        if initialized[@clazz] != true\n          initialized[@clazz] = true\n\n          @wrap_methods()\n\n          if @deps?\n            @hydrate @deps, => @finish_up deferred.resolve, args\n          else\n            @finish_up deferred.resolve, args\n        else\n          process.nextTick => deferred.resolve available[@strip @clazz]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    Array.prototype.last = -> this[this.length - 1]\n\n    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n\n    microtime = require 'microtime'\n\n    logger = require '.\/logger'\n\n    classes     = { }\n    available   = { }\n    initialized = { }\n\n    class Madul\n\n      constructor: (madul_name, class_name) ->\n        @debug = (msg, data) -> logger.debug msg, data\n        @info  = (msg, data) -> logger.info  msg, data\n        @warn  = (msg, data) -> logger.warn  msg, data\n        @error = (msg, data) -> logger.error msg, data\n\n        @clazz       = class_name || arguments.callee.caller.name\n        @madul_name  = madul_name\n\n        classes[@clazz] = madul_name\n\n        initialized[@clazz] = false unless initialized[@clazz] == true\n\n        logger.trace \"Instantiating #{@clazz}\"\n\n      do_wrap: (method) =>\n        callMe = @[method]\n\n        @[\"_#{method}\"] = @[method]\n\n        @[method] = =>\n          deferred = q.defer()\n          start    = microtime.now()\n          update   = start\n\n          respond = (state, data) =>\n            deferred[state] data\n\n            if state == 'reject'\n              logger.rejected @clazz, method, microtime.now() - start, data\n\n            if process.env.MADUL_LOG_LEVEL > 4\n              if state == 'resolve'\n                logger.resolved @clazz, method, microtime.now() - start, data\n              else if state == 'notify'\n                logger.notify @clazz, method, microtime.now() - update, data\n                update = microtime.now()\n\n          @done   = (out) => respond 'resolve', out\n          @fail   = (err) => respond 'reject',  err\n          @update = (out) => respond 'notify',  out\n\n          args = Array.prototype.slice.call arguments\n\n          logger.trace \"Invoking #{@clazz}.#{method}()\", args\n\n          @[\"_#{method}\"].apply null, args\n\n          deferred.promise\n\n      wrap_methods: => @pub?.forEach (method) => @do_wrap method\n\n      hydrate: (deps, done) =>\n        load = (name, path, loaded) =>\n          mod = require path\n\n          if typeof mod == 'function'\n            new mod name\n              .initialize @ctor_params?[name]\n              .then (mod) =>\n                available[name] = mod\n                loaded true\n          else\n            available[name] = mod\n            loaded true\n\n        check_directory = (path, dep, loaded) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              done type: 'ERROR', info: err\n            else\n              async.each files, (f, next) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.stat depth, (e, s) =>\n                  if s.isDirectory() && f[0] != '.'\n                    check_directory depth, dep, => next()\n                  else if s.isFile() && f.substring(0, f.length - 3) == dep\n                    load f.substring(0, f.length - 3), depth, => loaded true\n                  else\n                    next()\n              , => loaded true\n\n        add_dependency = (name, mod) =>\n          n = name.replace \/\\W+\/g, '_'\n          @[n] = mod\n\n        async.eachSeries deps, (d, next) =>\n          if @[d]? == false\n            if available[d]? == true\n              add_dependency d, available[d]\n              next()\n            else\n              try\n                available[d] = require d\n                add_dependency d, available[d]\n                next()\n              catch e\n                pkg = \"#{process.cwd()}\/node_modules\/#{d}\/package.json\"\n\n                fs.stat pkg, (err, stat) =>\n                  if stat?.isFile()\n                    fs.readFile pkg, 'utf8', (err, data) =>\n                      json = JSON.parse data\n                      main = json.main || json._main\n\n                      available[d] = require \"#{process.cwd()}\/node_modules\/#{d}\/#{main}\"\n\n                      add_dependency d, available[d]\n                      next()\n                  else\n                    check_directory \"#{process.cwd()}\/dist\", d, (loaded) =>\n                      if loaded\n                        add_dependency d, available[d]\n                        next()\n          else\n            next()\n        , done\n\n      finish_up: (resolve, args) =>\n        if typeof @post_initialize == 'function'\n          @do_wrap 'post_initialize'\n          @post_initialize(args)\n            .then =>\n              available[classes[@clazz]] = @\n              resolve @\n        else\n          available[classes[@clazz]] = @\n          resolve @\n\n      initialize: (args = { }, wrap = true) =>\n        deferred = q.defer()\n\n        if initialized[@clazz] == false\n          initialized[@clazz] = true\n\n          @wrap_methods() if wrap\n\n          if @deps?\n            @hydrate @deps, => @finish_up deferred.resolve, args\n          else\n            @finish_up deferred.resolve, args\n        else\n          process.nextTick => deferred.resolve available[classes[@clazz]]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3882b1b90b0ec1ab3c0c69e044fb6f629c169e06","subject":"document Model::Validate, ErrorsSet and ValidationError","message":"document Model::Validate, ErrorsSet and ValidationError\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee `Model::validate` for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt takes a callback with two arguments: error and the array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## errors : ErrorsSet\n\nA record's errors are accessible with `get('errors')`, which returns a `Batman.Set` of `Batman.ValidationError`s.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## isNew() : boolean\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## toJSON() : Object\n\n## fromJSON() : Model\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## load(options = {}, callback)\n\n## save(options = {}, callback)\n\n## destroy(options = {}, callback)\n\n## validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (see `Model@validate` above). Its callback takes two arguments:\n\n- Any JavaScript errors\n- A `Batman.ErrorsSet`\n\nThis method takes a callback with two arguments: any JavaScript error that occurs, then the `Batman.ErrorsSet` corresponding to the validation action.\nFor example:\n\n    asyncTest \"validate(callback) will call the callback only after all keys have been validated\", 4, ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      p = new Product\n      p.validate (js_error, validation_errors) ->\n        throw js_error if js_error\n        equal validation_errors.length, 2\n        equal p.get('errors.length'), 2\n        equal p.get('errors.name.length'), 1\n        equal p.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\nA `Batman.ValidationError` is a `Batman.Object`. It is initialized with an `attribute` and a `message`.  It also responds to `fullMessage`:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n\n# Batman.ErrorsSet\n\nA `Batman.ErrorsSet` is a `Batman.Set` populated with `Batman.ValidationErrors`.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n`Batman.ErrorsSet::add` is overridden for convenience. It takes an attribute name and a message, which it uses to\ncreate a new `Batman.ValidationError` then it adds that error to the `Batman.ErrorsSet`.\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee `Model::validate` for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt takes a callback with two arguments: error and the array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## errors : ErrorsSet\n\n## constructor(idOrAttributes = {}) : Model\n\n## isNew() : boolean\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## toJSON() : Object\n\n## fromJSON() : Model\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## load(options = {}, callback)\n\n## save(options = {}, callback)\n\n## destroy(options = {}, callback)\n\n## validate(callback)\n\n# Batman.ValidationError\n\n# Batman.ErrorsSet\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b39ac35e89d53060808691dacfb8e593c1d60bb6","subject":"in. jokes","message":"in. jokes\n","repos":"nomilous\/in.","old_file":"in.jokes\/spandex.litcoffee","new_file":"in.jokes\/spandex.litcoffee","new_contents":"#! \/usr\/bin\/env coffee\n\nThe expander supports multiple asyncronous functions.\n\nTo achieve that it needed to do some peculiar things.\n\nThings that [some](https:\/\/www.google.co.za\/search?q=uptight+people&espv=2&biw=1063&bih=1058&source=lnms&tbm=isch&sa=X&ei=q6CJVYTyIpPB7Ab95YLQBA&ved=0CAYQ_AUoAQ#tbm=isch&q=uptight) may disaprove of.\n\nLike wearing [spandex in public](https:\/\/www.google.co.za\/search?q=spandex+in+public+nuts&espv=2&biw=1063&bih=1058&tbm=isch&source=lnms&sa=X&ei=5Z-JVez6KeWY7gbl_oCYAg&ved=0CAYQ_AUoAQ#tbm=isch&q=spandex+in+public).\n\nIt broke the expansion (to be eval'd) into pieces and substituted a array ($e) for each function\n\nThe results of the division are loaded into a variable called `spandex`... \n\nWhich happens to be in scope at eval.\n\n    require('..\/')\n\n    $$in (arg) ->\n\n        ### in(arg).as {{1}}###\n\n        console.log arg\n\n\n","old_contents":"#! \/usr\/bin\/env coffee\n\nThe expander supports multiple asyncronous functions, to achieve that needed it needed to do some strange things.\n\nThings that some may disaprove of.\n\nLike wearing [spandex in public](https:\/\/www.google.co.za\/search?q=spandex+in+public+nuts&espv=2&biw=1063&bih=1058&tbm=isch&source=lnms&sa=X&ei=5Z-JVez6KeWY7gbl_oCYAg&ved=0CAYQ_AUoAQ#tbm=isch&q=spandex+in+public).\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"29daf64d6508b1b7e4baf3d2f483b6df628eaf4c","subject":"Add stub match data to the debug dataset","message":"Add stub match data to the debug dataset\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/debug.litcoffee","new_file":"src\/coffee\/debug.litcoffee","new_contents":"Debug Routines\n==============\n\nOccasionally, software has bugs. It's also often quite convenient\nto be able to fix those bugs.\n\n    window.DEBUG = {}\n\nDebug Data Collections\n----------------------\n\nThis is a collection of debug data, for great debugging, and debug.\n\n    window.DEBUG.loadDebugData = ->\n        dateBase = do DayBase\n        WS.message.push\n            type: 'mode'\n            mode: 'judge'\n        WS.message.push\n            type: 'override'\n            override: null\n        WS.message.push\n            type: 'teams'\n            teams:\n                aaa:\n                    college: 'College A'\n                    name: 'Team A'\n                    notes: 'Bees'\n                    present: yes\n                bbb:\n                    college: 'College B'\n                    name: 'Team B'\n                    notes: ''\n                    present: yes\n                ccc:\n                    college: 'College C'\n                    name: 'Team C Alpha'\n                    notes: ''\n                    present: no\n                ccc2:\n                    college: 'College C'\n                    name: 'Team C Beta'\n                    notes: ''\n                    present: yes\n                ddd:\n                    college: 'College D'\n                    name: 'Team D'\n                    notes: 'eyes'\n                    present: yes\n        WS.message.push\n            type: 'day'\n            schedule: [\n                {key: 'w', start: dateBase + 3600*9, displayName: 'Doors Open', association: 0}\n                {key: 'x', start: dateBase + 3600*9 + 1800, displayName: 'Tinker Time', association: 0}\n                {key: 'y', start: dateBase + 3600*11, displayName: 'Briefing', association: 3}\n                {key: 'z', start: dateBase + 3600*12, displayName: 'League', association: 1}\n            ]\n\n        WS.message.push\n            type: 'match'\n            schedule: [\n                {key: 'w', start: dateBase + 3600*12 + 3*60, teams: ['aaa', 'bbb', 'ccc', 'ddd'], scores: [4, 2.5, 2.5, 0], knockout_stage: null}\n                {key: 'x', start: dateBase + 3600*12 + 8*60, teams: ['bbb', 'aaa', 'ddd', 'ccc2'], scores: null, knockout_stage: null}\n                {key: 'y', start: dateBase + 3600*12 + 13*60, teams: ['ccc2', 'aaa', 'ddd', 'bbb'], scores: null, knockout_stage: null}\n                {key: 'z', start: dateBase + 3600*12 + 18*60, teams: ['aaa', 'bbb', 'ccc2', 'ddd'], scores: null, knockout_stage: null}\n            ]\n\n","old_contents":"Debug Routines\n==============\n\nOccasionally, software has bugs. It's also often quite convenient\nto be able to fix those bugs.\n\n    window.DEBUG = {}\n\nDebug Data Collections\n----------------------\n\nThis is a collection of debug data, for great debugging, and debug.\n\n    window.DEBUG.loadDebugData = ->\n        dateBase = do DayBase\n        WS.message.push\n            type: 'mode'\n            mode: 'judge'\n        WS.message.push\n            type: 'override'\n            override: null\n        WS.message.push\n            type: 'teams'\n            teams:\n                aaa:\n                    college: 'College A'\n                    name: 'Team A'\n                    notes: 'Bees'\n                    present: yes\n                bbb:\n                    college: 'College B'\n                    name: 'Team B'\n                    notes: ''\n                    present: yes\n                ccc:\n                    college: 'College C'\n                    name: 'Team C Alpha'\n                    notes: ''\n                    present: no\n                ccc2:\n                    college: 'College C'\n                    name: 'Team C Beta'\n                    notes: ''\n                    present: yes\n                ddd:\n                    college: 'College D'\n                    name: 'Team D'\n                    notes: 'eyes'\n                    present: yes\n        WS.message.push\n            type: 'day'\n            schedule: [\n                {key: 'w', start: dateBase + 3600*9, displayName: 'Doors Open', association: 0}\n                {key: 'x', start: dateBase + 3600*9 + 1800, displayName: 'Tinker Time', association: 0}\n                {key: 'y', start: dateBase + 3600*11, displayName: 'Briefing', association: 3}\n                {key: 'z', start: dateBase + 3600*12, displayName: 'League', association: 1}\n            ]\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"814aaa5591283db752196702b5b72e0bd5e3636f","subject":"docs(document): disable syntax highlighting for query parameters","message":"docs(document): disable syntax highlighting for query parameters\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/document.litcoffee","new_file":"coffee\/document.litcoffee","new_contents":"    schema   = require '.\/helper\/schema'\n    sentry   = require '.\/db\/sentry'\n    Document = require '.\/model\/Document'\n\n    JSONStream = require 'JSONStream'\n\n## param()\n\n    exports.param = (req, res, next, id) ->\n      return res.status(400).json message: 'Invalid ObjectId' if not \/^[a-f0-9]{24}$\/.test id\n      return next() if req.method is 'OPTIONS'\n\n      req.doc = new Document(req.type, id).once('error', next).once 'ready', ->\n        req.isOwner = @exists() and req.user.tilbyder is @get 'tilbyder'\n\n        if not @exists() or (@get('status') isnt 'Offentlig' and not req.isOwner)\n          return res.status(404).json message: 'Not Found' if req.method isnt 'HEAD'\n          return res.status(404).end()\n\n        next()\n\n\n## all()\n\n    exports.all = (req, res, next) ->\n      res.set 'X-Cache-Hit', req.doc.wasCacheHit()\n      res.set 'ETag', \"\\\"#{req.doc.get 'checksum'}\\\"\"\n      res.set 'Last-Modified', new Date(req.doc.get 'endret').toUTCString()\n\n      if req.method not in ['GET', 'HEAD'] and not req.isOwner\n        return res.status(403).json message: 'Request Denied'\n\n      if req.get 'If-Match'\n        return res.status(412).end() if req.doc.isNoneMatch req.get 'If-Match'\n\n      else if req.get 'If-None-Match'\n        return res.status(304).end() if req.doc.isMatch req.get 'If-None-Match'\n\n      else\n        if req.doc.isNotModifiedSince req.get 'If-Modified-Since'\n          return res.status(304).end()\n\n        if req.doc.isModifiedSince req.get 'If-Unmodified-Since'\n          return res.status(412).end()\n\n      next()\n\n\n## OPTIONS\n\n```http\nOPTIONS \/{type}\/{id}\n```\n\n    exports.options = (req, res, next) ->\n      res.set 'Access-Control-Allow-Methods', [\n        'HEAD', 'GET', 'PUT', 'PATCH', 'DELETE'\n      ].join ', '\n      res.set 'Access-Control-Allow-Headers', [\n        'Content-Type'\n        'If-Match'\n        'If-Modified-Since'\n        'If-None-Match'\n        'If-Unmodified-Since'\n      ].join ', '\n      res.sendStatus 204\n\n\n## HEAD and GET\n\n```http\nHEAD \/{type}\/{id}\nGET \/{type}\/{id}\n```\n\n    exports.head = exports.get = (req, res, next) ->\n      return res.sendStatus 200 if req.method is 'HEAD'\n\n      opts =\n        query: $or: [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n        fields: {}\n\n### Fields Projection\n\n```none\n&fields=field1[,field2[,..]]\n```\n\nPrivate (`privat.`) fields are hidden unless the current API user is the owner\nof the document. This is to prevent unauthorized information disclosure.\n\n      opts.fields.privat = false if not req.isOwner\n\nIf you only want some of the document properties returned you can use the\n`fields` query parameter to control the projection of document properties.\nMultiple fields must be comma separated without any additional spacing.\n\nThis projection also applies to expanded sub-documents when using the `&expand=`\nquery parameter below.\n\n      if req.query?.fields\n        opts.fields[field] = true for field in req.query.fields.split ','\n        opts.fields.privat = false if not req.isOwner\n\nThe list of default fields below will always be returned for compliance reasons.\n\n        opts.fields = Object.assign opts.fields,\n          endret: true\n          lisens: true\n          status: true\n          navn  : true\n          tilbyder  : true\n          navngiving: true\n\n### Sub-document Expansion\n\n```none\n&expand=field1[,field2[..]]\n```\n\nSub-document expansion is an easy and convenient way to get connected documents\nsuch as `grupper`, `bilder`, and `omr\u00e5der` as their full objects instead of a\nlist of `ObjectIDs`. It works by setting the `expand` query parameter to the\nfields to expand.\n\n**Rate limit**\n\nSub-document expansion will decrease your remaining API rate limit with `1` per\ncollection expanded in addition to the request itself. Thus, if you request a\ndocument (1) with two collection expanded (2) your remaining API rate limit will\nbe decremented with 3. This is to encurrage resonable expansion of relevant\ncollections only.\n\n**Order and limit**\n\nSub-document expansion will return at most 10 first sub-documents for each\ncollection expanded and out of order. Only sub-documents avaiable to the current\nAPI user will be return as sub-documents my not be published or may have been\ndeleted.\n\n      if req.query?.expand\n        opts.expand = req.query.expand.split ','\n\n### Sub-document Limit\n\n```none\n&limit={n}\n```\n\nIf you wisth to return less sub-documents in order to increase response time and\nbody size you may do so by using the `limit` query parameter. This will affect\nall sub-documents expanded by the `expand` query parameter.\n\n      if req.query?.limit and parseInt req.query.limit, 10\n        opts.limit = parseInt req.query.limit, 10\n\n---\n\n      req.doc.getExpanded opts, (err, doc) ->\n        return next err if err\n        res.json doc\n\n\n## PUT and PATCH\n\n```http\nPUT \/{type}\/{id}\nPATCH \/{type}\/{id}\n```\n\n    exports.patch = exports.put = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(400).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      method = (if req.method is 'PUT' then 'replace' else 'update')\n      req.doc[method] req.body, (err, warn, data) ->\n        if err\n          return next(err) if err.name isnt 'ValidationError'\n\n          sentry.captureDocumentError req, err\n\n          return res.status(422).json\n            document: req.body\n            message: 'Validation Failed'\n            errors: err.details #TODO(starefossen) document this\n\n        res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n        res.set 'Last-Modified', new Date(data.endret).toUTCString()\n\n        return res.status(200).json\n          document: data\n          message: 'Validation Warnings' if warn.length > 0\n          warnings: warn if warn.length > 0\n\n\n## DELETE\n\n```http\nDELETE \/{type}\/{id}\n```\n\n    exports.delete = (req, res, next) ->\n      req.doc.delete (err) ->\n        return next err if err\n        return res.sendStatus 204\n\n","old_contents":"    schema   = require '.\/helper\/schema'\n    sentry   = require '.\/db\/sentry'\n    Document = require '.\/model\/Document'\n\n    JSONStream = require 'JSONStream'\n\n## param()\n\n    exports.param = (req, res, next, id) ->\n      return res.status(400).json message: 'Invalid ObjectId' if not \/^[a-f0-9]{24}$\/.test id\n      return next() if req.method is 'OPTIONS'\n\n      req.doc = new Document(req.type, id).once('error', next).once 'ready', ->\n        req.isOwner = @exists() and req.user.tilbyder is @get 'tilbyder'\n\n        if not @exists() or (@get('status') isnt 'Offentlig' and not req.isOwner)\n          return res.status(404).json message: 'Not Found' if req.method isnt 'HEAD'\n          return res.status(404).end()\n\n        next()\n\n\n## all()\n\n    exports.all = (req, res, next) ->\n      res.set 'X-Cache-Hit', req.doc.wasCacheHit()\n      res.set 'ETag', \"\\\"#{req.doc.get 'checksum'}\\\"\"\n      res.set 'Last-Modified', new Date(req.doc.get 'endret').toUTCString()\n\n      if req.method not in ['GET', 'HEAD'] and not req.isOwner\n        return res.status(403).json message: 'Request Denied'\n\n      if req.get 'If-Match'\n        return res.status(412).end() if req.doc.isNoneMatch req.get 'If-Match'\n\n      else if req.get 'If-None-Match'\n        return res.status(304).end() if req.doc.isMatch req.get 'If-None-Match'\n\n      else\n        if req.doc.isNotModifiedSince req.get 'If-Modified-Since'\n          return res.status(304).end()\n\n        if req.doc.isModifiedSince req.get 'If-Unmodified-Since'\n          return res.status(412).end()\n\n      next()\n\n\n## OPTIONS\n\n```http\nOPTIONS \/{type}\/{id}\n```\n\n    exports.options = (req, res, next) ->\n      res.set 'Access-Control-Allow-Methods', [\n        'HEAD', 'GET', 'PUT', 'PATCH', 'DELETE'\n      ].join ', '\n      res.set 'Access-Control-Allow-Headers', [\n        'Content-Type'\n        'If-Match'\n        'If-Modified-Since'\n        'If-None-Match'\n        'If-Unmodified-Since'\n      ].join ', '\n      res.sendStatus 204\n\n\n## HEAD and GET\n\n```http\nHEAD \/{type}\/{id}\nGET \/{type}\/{id}\n```\n\n    exports.head = exports.get = (req, res, next) ->\n      return res.sendStatus 200 if req.method is 'HEAD'\n\n      opts =\n        query: $or: [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n        fields: {}\n\n### Fields Projection\n\n```\n&fields=field1[,field2[,..]]\n```\n\nPrivate (`privat.`) fields are hidden unless the current API user is the owner\nof the document. This is to prevent unauthorized information disclosure.\n\n      opts.fields.privat = false if not req.isOwner\n\nIf you only want some of the document properties returned you can use the\n`fields` query parameter to control the projection of document properties.\nMultiple fields must be comma separated without any additional spacing.\n\nThis projection also applies to expanded sub-documents when using the `&expand=`\nquery parameter below.\n\n      if req.query?.fields\n        opts.fields[field] = true for field in req.query.fields.split ','\n        opts.fields.privat = false if not req.isOwner\n\nThe list of default fields below will always be returned for compliance reasons.\n\n        opts.fields = Object.assign opts.fields,\n          endret: true\n          lisens: true\n          status: true\n          navn  : true\n          tilbyder  : true\n          navngiving: true\n\n### Sub-document Expansion\n\n```\n&expand=field1[,field2[..]]\n```\n\nSub-document expansion is an easy and convenient way to get connected documents\nsuch as `grupper`, `bilder`, and `omr\u00e5der` as their full objects instead of a\nlist of `ObjectIDs`. It works by setting the `expand` query parameter to the\nfields to expand.\n\n**Rate limit**\n\nSub-document expansion will decrease your remaining API rate limit with `1` per\ncollection expanded in addition to the request itself. Thus, if you request a\ndocument (1) with two collection expanded (2) your remaining API rate limit will\nbe decremented with 3. This is to encurrage resonable expansion of relevant\ncollections only.\n\n**Order and limit**\n\nSub-document expansion will return at most 10 first sub-documents for each\ncollection expanded and out of order. Only sub-documents avaiable to the current\nAPI user will be return as sub-documents my not be published or may have been\ndeleted.\n\n      if req.query?.expand\n        opts.expand = req.query.expand.split ','\n\n### Sub-document Limit\n\n```\n&limit={n}\n```\n\nIf you wisth to return less sub-documents in order to increase response time and\nbody size you may do so by using the `limit` query parameter. This will affect\nall sub-documents expanded by the `expand` query parameter.\n\n      if req.query?.limit and parseInt req.query.limit, 10\n        opts.limit = parseInt req.query.limit, 10\n\n---\n\n      req.doc.getExpanded opts, (err, doc) ->\n        return next err if err\n        res.json doc\n\n\n## PUT and PATCH\n\n```http\nPUT \/{type}\/{id}\nPATCH \/{type}\/{id}\n```\n\n    exports.patch = exports.put = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(400).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      method = (if req.method is 'PUT' then 'replace' else 'update')\n      req.doc[method] req.body, (err, warn, data) ->\n        if err\n          return next(err) if err.name isnt 'ValidationError'\n\n          sentry.captureDocumentError req, err\n\n          return res.status(422).json\n            document: req.body\n            message: 'Validation Failed'\n            errors: err.details #TODO(starefossen) document this\n\n        res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n        res.set 'Last-Modified', new Date(data.endret).toUTCString()\n\n        return res.status(200).json\n          document: data\n          message: 'Validation Warnings' if warn.length > 0\n          warnings: warn if warn.length > 0\n\n\n## DELETE\n\n```http\nDELETE \/{type}\/{id}\n```\n\n    exports.delete = (req, res, next) ->\n      req.doc.delete (err) ->\n        return next err if err\n        return res.sendStatus 204\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"14d9f115f19fc4f5e4ec237b04ec565805960cf7","subject":"Explicit hash digest","message":"Explicit hash digest\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"server\/crypto.litcoffee","new_file":"server\/crypto.litcoffee","new_contents":"# Crypto\n\n*Cryptographic helper functions.*\n\n    crypto = require 'crypto'\n    config = require 'config'\n    Promise = require 'bluebird'\n\n## crypto.encrypt\n\n* (string) `message` - The message to encrypt.\n* (optional string) `password` - The password to use to encrypt the message.\n  Defaults to the site's global crypto key.\n\n*AES encrypt a message with a password.*\n\n    exports.encrypt = (message, password) ->\n\n      new Promise (resolve, reject) ->\n\n        cipher = crypto.createCipher(\n          'aes256'\n          password ? config.get 'packageSettings:shrub-core:cryptoKey'\n        )\n\n        cipherText = []\n        cipherText.push cipher.update message, 'binary', 'hex'\n        cipherText.push cipher.final 'hex'\n        resolve cipherText.join ''\n\n## crypto.decrypt\n\n* (string) `message` - The message to decrypt.\n* (optional string) `password` - The password to use to decrypt the message.\n  Defaults to the site's global crypto key.\n\n*AES decrypt a message with a password.*\n\n    exports.decrypt = (message, password) ->\n\n      new Promise (resolve, reject) ->\n\n        decipher = crypto.createDecipher(\n          'aes256'\n          password ? config.get 'packageSettings:shrub-core:cryptoKey'\n        )\n        decipher.setAutoPadding false\n\n        decipherText = []\n        decipherText.push decipher.update message, 'hex', 'binary'\n        decipherText.push decipher.final 'binary'\n        decipherText = decipherText.join ''\n\n        # Slice off any padding.\n        if 16 >= code = decipherText.charCodeAt decipherText.length - 1\n          decipherText = decipherText.slice 0, -code\n\n        resolve decipherText\n\n## crypto.hasher\n\nCREDIT:\n[https:\/\/gist.github.com\/boronine\/3548196](https:\/\/gist.github.com\/boronine\/3548196)\ncha0s promisify'd it and made it work with Buffer objects.\n\n* (object) `options` - The options to use. The options object may include the\n  following values:\n    * `plaintext`: The plaintext password to hash and return as `key`. If none\n      is provided, an 8-character random plaintext password will be generated.\n    * `salt`: The salt to hash the password with. If none is provided, a\n      512-bit salt will be generated.\n    * `iterations`: The number of iterations to use for the PBKDF. Defaults to\n      10000\\. **NOTE:** This ***must*** be the same number when generating and\n      verifying hashes, otherwise verification will fail.\n\n*Cryptographic authentication functionality.*\n\n    exports.hasher = (options = {}) ->\n\nGenerate random 8-character base64 password if none provided\n\n      unless options.plaintext?\n\n        return exports.randomBytes(6).then((buffer) ->\n          options.plaintext = buffer.toString 'base64'\n          exports.hasher options\n        )\n\nGenerate random 512-bit salt if no salt provided\n\n      unless options.salt?\n\n        return exports.randomBytes(64).then((buffer) ->\n          options.salt = buffer\n          exports.hasher options\n        )\n\n      options.digest ?= 'sha1'\n      options.iterations ?= 10000\n\n      exports.pbkdf2(\n        options.plaintext, options.salt, options.iterations, 64, options.digest\n\n      ).then (key) ->\n        options.key = new Buffer key\n        options\n\nPromisify some useful node.js crypto functions.\n\n    exports.pbkdf2 = Promise.promisify crypto.pbkdf2, crypto\n    exports.randomBytes = Promise.promisify crypto.randomBytes, crypto\n","old_contents":"# Crypto\n\n*Cryptographic helper functions.*\n\n    crypto = require 'crypto'\n    config = require 'config'\n    Promise = require 'bluebird'\n\n## crypto.encrypt\n\n* (string) `message` - The message to encrypt.\n* (optional string) `password` - The password to use to encrypt the message.\n  Defaults to the site's global crypto key.\n\n*AES encrypt a message with a password.*\n\n    exports.encrypt = (message, password) ->\n\n      new Promise (resolve, reject) ->\n\n        cipher = crypto.createCipher(\n          'aes256'\n          password ? config.get 'packageSettings:shrub-core:cryptoKey'\n        )\n\n        cipherText = []\n        cipherText.push cipher.update message, 'binary', 'hex'\n        cipherText.push cipher.final 'hex'\n        resolve cipherText.join ''\n\n## crypto.decrypt\n\n* (string) `message` - The message to decrypt.\n* (optional string) `password` - The password to use to decrypt the message.\n  Defaults to the site's global crypto key.\n\n*AES decrypt a message with a password.*\n\n    exports.decrypt = (message, password) ->\n\n      new Promise (resolve, reject) ->\n\n        decipher = crypto.createDecipher(\n          'aes256'\n          password ? config.get 'packageSettings:shrub-core:cryptoKey'\n        )\n        decipher.setAutoPadding false\n\n        decipherText = []\n        decipherText.push decipher.update message, 'hex', 'binary'\n        decipherText.push decipher.final 'binary'\n        decipherText = decipherText.join ''\n\n        # Slice off any padding.\n        if 16 >= code = decipherText.charCodeAt decipherText.length - 1\n          decipherText = decipherText.slice 0, -code\n\n        resolve decipherText\n\n## crypto.hasher\n\nCREDIT:\n[https:\/\/gist.github.com\/boronine\/3548196](https:\/\/gist.github.com\/boronine\/3548196)\ncha0s promisify'd it and made it work with Buffer objects.\n\n* (object) `options` - The options to use. The options object may include the\n  following values:\n    * `plaintext`: The plaintext password to hash and return as `key`. If none\n      is provided, an 8-character random plaintext password will be generated.\n    * `salt`: The salt to hash the password with. If none is provided, a\n      512-bit salt will be generated.\n    * `iterations`: The number of iterations to use for the PBKDF. Defaults to\n      10000\\. **NOTE:** This ***must*** be the same number when generating and\n      verifying hashes, otherwise verification will fail.\n\n*Cryptographic authentication functionality.*\n\n    exports.hasher = (options = {}) ->\n\nGenerate random 8-character base64 password if none provided\n\n      unless options.plaintext?\n\n        return exports.randomBytes(6).then((buffer) ->\n          options.plaintext = buffer.toString 'base64'\n          exports.hasher options\n        )\n\nGenerate random 512-bit salt if no salt provided\n\n      unless options.salt?\n\n        return exports.randomBytes(64).then((buffer) ->\n          options.salt = buffer\n          exports.hasher options\n        )\n\n      # Node.js PBKDF2 forces sha1\n      options.hash = 'sha1'\n      options.iterations = options.iterations ? 10000\n\n      exports.pbkdf2(\n        options.plaintext, options.salt, options.iterations, 64\n\n      ).then (key) ->\n        options.key = new Buffer key\n        options\n\nPromisify some useful node.js crypto functions.\n\n    exports.pbkdf2 = Promise.promisify crypto.pbkdf2, crypto\n    exports.randomBytes = Promise.promisify crypto.randomBytes, crypto\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"04fd23dedcfaf723e53225c10af80553df418d5e","subject":"Clean up cache documentation","message":"Clean up cache documentation\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/cache.litcoffee","new_file":"coffee\/cache.litcoffee","new_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n### Todo\n\n* [ ] Handle undefined values.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if lookup failed; otherwise `null`.\n* `Object` doc - filtered document if found; otherwise `null`.\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis write failed; otherwise `null`.\n* `Object` data - the original data as it was stored in Redis.\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function\n\n### Callback\n\n#### Params\n\n* `Error` err -  error object if Redis lookup failed, otherwise `null`.\n* `Object` data - data retrieved from Redis if found; otherwise `null`.\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the filtered data object as it was stored in Redis.\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the data object returned from Redis or Mongodb.\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n    module.exports =\n      getFilter : getFilter\n      filterData: filterData\n      getDoc    : getDoc\n      set       : set\n      get       : get\n      setForType: setForType\n      getForType: getForType\n\n","old_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` (`{}`) if the `preventDefault` parameter is set to\n`true` and no filter was found for the given `type`.\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n### Todo\n\n* [] Handle undefined values.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if lookup failed; otherwise `null`.\n* `Object` doc - filtered document if found; otherwise `null`.\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis write failed; otherwise `null`.\n* `Object` data - the original data as it was stored in Redis.\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function\n\n### Callback\n\n#### Params\n\n* `Error` err -  error object if Redis lookup failed, otherwise `null`.\n* `Object` data - data retrieved from Redis if found; otherwise `null`.\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the filtered data object as it was stored in Redis.\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the data object returned from Redis or Mongodb.\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n    module.exports =\n      getFilter : getFilter\n      filterData: filterData\n      getDoc    : getDoc\n      set       : set\n      get       : get\n      setForType: setForType\n      getForType: getForType\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cb0fae5874d75d55a982d0c8791991092b9ee0c4","subject":"Restoring justice","message":"Restoring justice\n\nPeople can not wait for so much time and get the prize \u2013 image((. Cats have to move !","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"client\/views\/pages\/home\/waiting.litcoffee","new_file":"client\/views\/pages\/home\/waiting.litcoffee","new_contents":"Autoform callback hooks\n\n    AutoForm.hooks\n      getInLine:\n        after:\n          method: (error, result) ->\n            if error?\n              console.log err\n            else\n              Session.set 'queueEntry', result\n\n    Template.waiting.helpers\n      nameSchema: -> NameSchema\n      lineLength: ->\n\nHacks, should probably be using Tracker for this\n\n        lineLength = this.queueMeta.nextTicketNumber - this.queueMeta.currentlyServingTicketNumber - 1\n        lineLength = 0 if lineLength < 0\n        return lineLength\n      queueEntry: ->\n        Session.get 'queueEntry'\n      html: -> this.queueMeta.html\n      isBeingServed: ->\n        queueEntry = Session.get 'queueEntry'\n        return if not queueEntry?\n\nGet new gifUrl\n\n        Session.set 'gifUrl',\"http:\/\/thecatapi.com\/api\/images\/get?format=src&type=gif&size=med&time=#{new Date().getTime()}\"\n\nClear queueEntry if queueMeta.currentlyServingTicketNumber is > queueEntry.ticketNumber\n\n        if this.queueMeta.currentlyServingTicketNumber > queueEntry.ticketNumber\n          Session.set 'queueEntry', null\n\n        this.queueMeta.currentlyServingTicketNumber is queueEntry.ticketNumber and\n          this.queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n\n    Template.waiting.events\n      'click .queueInLine': (event) ->\n\nReturn immediatly if the user is already queued. More logic on the server, but\nthis will help.\n\n        return if (Session.get 'queueEntry')?\n\nCall the meteor method to get queued.\n\n        Meteor.call 'getInQueue', 'fakeName', (error, result) ->\n          if error?\n            console.log err\n          else\n            Session.set 'queueEntry', result\n\n      Template.waiting.rendered = ->\n        $('body').css 'background-color', '#eee'\n","old_contents":"Autoform callback hooks\n\n    AutoForm.hooks\n      getInLine:\n        after:\n          method: (error, result) ->\n            if error?\n              console.log err\n            else\n              Session.set 'queueEntry', result\n\n    Template.waiting.helpers\n      nameSchema: -> NameSchema\n      lineLength: ->\n\nHacks, should probably be using Tracker for this\n\n        lineLength = this.queueMeta.nextTicketNumber - this.queueMeta.currentlyServingTicketNumber - 1\n        lineLength = 0 if lineLength < 0\n        return lineLength\n      queueEntry: ->\n        Session.get 'queueEntry'\n      html: -> this.queueMeta.html\n      isBeingServed: ->\n        queueEntry = Session.get 'queueEntry'\n        return if not queueEntry?\n\nGet new gifUrl\n\n        Session.set 'gifUrl',\"http:\/\/thecatapi.com\/api\/images\/get?format=src&type=jpg&size=med&time=#{new Date().getTime()}\"\n\nClear queueEntry if queueMeta.currentlyServingTicketNumber is > queueEntry.ticketNumber\n\n        if this.queueMeta.currentlyServingTicketNumber > queueEntry.ticketNumber\n          Session.set 'queueEntry', null\n\n        this.queueMeta.currentlyServingTicketNumber is queueEntry.ticketNumber and\n          this.queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n\n    Template.waiting.events\n      'click .queueInLine': (event) ->\n\nReturn immediatly if the user is already queued. More logic on the server, but\nthis will help.\n\n        return if (Session.get 'queueEntry')?\n\nCall the meteor method to get queued.\n\n        Meteor.call 'getInQueue', 'fakeName', (error, result) ->\n          if error?\n            console.log err\n          else\n            Session.set 'queueEntry', result\n\n      Template.waiting.rendered = ->\n        $('body').css 'background-color', '#eee'\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b89c4f2559219c019c3c6b0f3b517be78541878e","subject":"Hard code font size to a sensible value","message":"Hard code font size to a sensible value\n\nDynamically determining the font size was more trouble that it was worth\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_step_count.litcoffee","new_file":"lib\/render-pipelines\/png\/png_step_count.litcoffee","new_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngStepCount extends PngRenderer\n\n      do_render: (ctx, path) =>\n        width  = @config.width\n        height = @config.height\n\n        for step, i in path\n          ctx.font      = '12pt Arial'\n          ctx.textAlign = @config.step_count.text.align\n          ctx.fillStyle = @config.step_count.text.color\n\n          x = (width  * 0.5) + (width  * step.x)\n          y = (height * 0.5) + (height * step.y)\n\n          ctx.beginPath()\n          ctx.fillText i, x, y\n\n    module.exports = PngStepCount\n","old_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngStepCount extends PngRenderer\n\n      do_render: (ctx, path) =>\n        width  = @config.width\n        height = @config.height\n\n        for step, i in path\n          ctx.font      = \"#{Math.floor height * 0.25}pt Arial\"\n          ctx.textAlign = @config.step_count.text.align\n          ctx.fillStyle = @config.step_count.text.color\n\n          x = (width  * 0.5) + (width  * step.x)\n          y = (height * 0.5) + (height * step.y)\n\n          ctx.beginPath()\n          ctx.fillText i, x, y\n\n    module.exports = PngStepCount\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8894cfafa0451af399126fb68f295038ea6e69b6","subject":"Update markdown","message":"Update markdown","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n## Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @port.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n## Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        if self.port.onerror?\n         self.port.onerror e\n        else\n         throw e\n      , 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n## Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n### Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n### Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n### Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n### Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n### Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n### Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n## WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      dd = data.data\n      if dd? and dd._transferList?\n       transferList = dd._transferList\n       delete dd._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n\n     _respond: (data, options, callback) ->\n      dd = data.data\n      if dd? and dd._transferList?\n       transferList = dd._transferList\n       delete dd._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n## FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n## SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n## ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n## AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n## NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) =>\n       try\n        callbacks.fail? e\n       catch err\n        @onerror? err\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n## NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n## NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n# IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @port.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        if self.port.onerror?\n         self.port.onerror e\n        else\n         throw e\n      , 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      dd = data.data\n      if dd? and dd._transferList?\n       transferList = dd._transferList\n       delete dd._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n\n     _respond: (data, options, callback) ->\n      dd = data.data\n      if dd? and dd._transferList?\n       transferList = dd._transferList\n       delete dd._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) =>\n       try\n        callbacks.fail? e\n       catch err\n        @onerror? err\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"834129ade191fa45cd30dcc2c6742026d7f01156","subject":"add page.post to routes with sample input","message":"add page.post to routes with sample input\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/lib\/routes\/index.litcoffee","new_file":"src\/lib\/routes\/index.litcoffee","new_contents":"\n# Application Routes\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n\n## \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        fs = require('fs')\n        res.render 'index', {\n          title: 'Welcome',\n          extra_head_css: fs.readFileSync('views\/extra\/nivo.css'),\n          extra_foot_js: fs.readFileSync('views\/extra\/nivo.js')\n        }\n\n## \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        require('..\/page').getPage(app.models.page, req.params.name, (page) ->\n          if page\n            res.render 'page', page\n          else\n            console.error 'page '+req.params.name+' not found in db, showing static'\n            res.render 'page\/'+req.params.name\n        )\n\n      app.post '\/page\/_post', (req, res) ->\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          body: 'Hello world, from inside the DB'\n        require('..\/page').setPage(app.models.page, sample, (page) ->\n          if page\n            res.render 'page', page\n          else\n            page =\n              name: 'error'\n              title: 'Error'\n              body: 'There was an error posting your page, please try again.'\n            res.render 'page', page\n        )\n          \n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Routes\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n\n## \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        fs = require('fs')\n        res.render 'index', {\n          title: 'Welcome',\n          extra_head_css: fs.readFileSync('views\/extra\/nivo.css'),\n          extra_foot_js: fs.readFileSync('views\/extra\/nivo.js')\n        }\n\n## \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        require('..\/page').getPage(app.models.page, req.params.name, (page) ->\n          if page\n            res.render 'page', page\n          else\n            console.error 'page '+req.params.name+' not found in db, showing static'\n            res.render 'page\/'+req.params.name\n        )\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"d91e6de1b7980e8b98084b5fb780975933ffb020","subject":"docs(document): refactor documentation of some class methods","message":"docs(document): refactor documentation of some class methods\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/model\/Document.litcoffee","new_file":"coffee\/model\/Document.litcoffee","new_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n    collections = require('..\/helper\/schema').types\n\n---\n\n## Class: Doc\n\n### Params\n\n* **string** `type` - document type\n* **string** `id` - document id\n\n### Return\n\nNew `Doc`.\n\n---\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n      @db   = mongo[type]\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n      @type = type\n      @data = {}\n      @chit = false\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if Object.keys(data).length\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n## Doc.exists\n\nCheck if document exists.\n\n### Return\n\nReturns `true` if document exists; otherwise `false`.\n\n---\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n## Doc.getId\n\nGet document id (ObjectID) for current document.\n\n### Return\n\nReturns an `ObjectID` if the document has an id; otherwise `null`.\n\n---\n\n    Doc.prototype.getId = ->\n      @id\n\n\n## Doc.wasCacheHit\n\nCheck if document request was a cache hit.\n\n### Return\n\nReturns `true` if document request was a cache hit; otherwise `false`.\n\n---\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n## Doc.isNotModifiedSince\n\nCheck if document has not been modified since a given timestamp.\n\n### Params\n\n* **string** `time` - timestamp to check against.\n\n### Return\n\nReturns `true` if document has not been modified since given timestamp; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make UNIX timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n## doc.isMatch\n\nCheck if checksum, or Etag, matches current document checksum.\n\n### Params\n\n* **string** `checksum` - checksum to check against.\n\n### Return\n\nReturns `true` if checksum matches the current checksum; otherwise `false`.\n\n---\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n## doc.isNoneMatch\n\nCheck if checksum, or Etag, doesn't match current document checksum.\n\n### Params\n\n* **string** `checksum` - checksum to check against.\n\n### Return\n\nReturn `true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n## Doc.get\n\nGet cached data for current document.\n\n### Params\n\n* **string** `key` - get specific object property\n\n### Return\n\nReturns an `object` if `key` is `undefined`; otherwise `string`. Will return\n`undefined` if the given key does not exist.\n\n---\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n## doc.getFull\n\n### Params\n\n* **object** `filter` - control which object properties are returned\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n## doc.getFuller\n\n### Params\n\n* **object** `filter` - control which object properties are returned\n* **array** `expand` - sub-document property names to expand\n* **object** `query` - query for expanded sub-documents\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFuller = (filter, expand, query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      count = 0\n      mapped = {}\n\nSince `expand` might be a user supplied input parameter we need to limit it to\nproperties which are expandable (`collections`). We also remove properties which\nholds no value for this document.\n\n      expand = expand\n        .filter (v) => @data[v] and v in collections\n\nNext we map the string array into an object array on the following format:\n`{ type: String, ids: Array }` where `ids` are ObjectIDs to an document of the\ncollection `type`.\n\n        .map (v) => type: v, ids: @data[v].map (d) -> new ObjectID d\n\nSet up a `final` function which is called when expanded data is ready to be\nmapped to the original document.\n\n      final = () =>\n        @db.findOne _id: @id, filter, (err, doc) ->\n          cb err, Object.assign doc or {}, mapped\n\nIf there are no fields to expand, we just call the `final` function instantly\nand no fields will get expanded.\n\n      return final() if expand.length is 0\n\nSet up a `next` function which is called for each expanded data returned from\nthe database. Expanded data is stored in the `mapped` object which is merged\nwith the main document in `final`. When all expanded fields are mapped `final`\nis called.\n\n      next = (type, _, docs) ->\n        mapped[type] = docs or []\n        return final() if Object.keys(mapped).length == expand.length\n\nGet the expanded sub-documents from the database.\n\n      expand.forEach (x) ->\n        mongo[x.type]\n\nWe find the sub-documents using the ObjectIDs in the expanded fields, that is\nthe easy part. The tricky part is to prevent information leakage of private\ndocuments. This the second part is a `query` limiting the results to public\ndocuments or those owned by the current API user.\n\n          .find Object.assign {_id: $in: x.ids}, query\n\nWe reuse the projection filter from the original document, but since we do not\nknow in advanced who owns a given sub-document we remove the `private` property\nto prevent information leakage.\n\n          .project Object.assign filter, privat: false\n\nBundle all the sub-documents in one array and pass it to the `next` function.\n\n          .toArray next.bind null, x.type\n\n\n## Doc.insert\n\nInserts a document into database.\n\n### Params\n\n* **object** `data` - data to insert for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.replace\n\nReplaces all document data in database.\n\n### Params\n\n* **object** `data` - replacement data for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          data._id = @id\n          cb err, warn, data\n\n\n## Doc.update\n\nPartially update the document-data in database. This is some times referred to as\nPATCH in a HTTP \/ REST context.\n\n### Params\n\n* **object** `data` - replacement object for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n## Doc.delete\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n### Params\n\n* **function** `cb` - callback function (**Error** `err`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet', endret: new Date()\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n\n","old_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n    collections = require('..\/helper\/schema').types\n\n---\n\n## Class: Doc\n\n### Params\n\n* **string** `type` - document type\n* **string** `id` - document id\n\n### Return\n\nNew `Doc`.\n\n---\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n      @db   = mongo[type]\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n      @type = type\n      @data = {}\n      @chit = false\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if Object.keys(data).length\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n## Doc.exists\n\nCheck if document exists.\n\n### Return\n\nReturns `true` if document exists; otherwise `false`.\n\n---\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n## Doc.getId\n\nGet document id (ObjectID) for current document.\n\n### Return\n\nReturns an `ObjectID` if the document has an id; otherwise `null`.\n\n---\n\n    Doc.prototype.getId = ->\n      @id\n\n\n## Doc.wasCacheHit\n\nCheck if document request was a cache hit.\n\n### Return\n\nReturns `true` if document request was a cache hit; otherwise `false`.\n\n---\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n## Doc.isNotModifiedSince\n\nCheck if document has not been modified since a given timestamp.\n\n### Params\n\n* **string** `time` - timestamp to check against.\n\n### Return\n\nReturns `true` if document has not been modified since given tmestamp; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make unix timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n## doc.isMatch\n\nCheck if checksum, or Etag, matche current document checksum.\n\n### Params\n\n* **string** `checksum` - checksum to check against.\n\n### Return\n\nReturns `true` if checksum matches the current checksum; otherwise `false`.\n\n---\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n## doc.isNoneMatch\n\nCheck if checksum, or Etag, doesnt match current document checksum.\n\n### Params\n\n* **string** `checksum` - checksum to check against.\n\n### Return\n\nReturn `true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n## Doc.get\n\nGet cached data for current document.\n\n### Params\n\n* **string** `key` - get specific object property\n\n### Return\n\nReturns an `object` if `key` is `undefined`; otherwise `string`. Will retur\n`undefined` if the given key does not exist.\n\n---\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n## doc.getFull\n\n### Params\n\n* **object** `filter` - control which object properties are returned\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n## doc.getFuller\n\n### Params\n\n* **object** `filter` - control which object properties are returned\n* **array** `expand` - sub-document property names to expand\n* **object** `query` - query for expanded sub-documents\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFuller = (filter, expand, query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      count = 0\n      mapped = {}\n\nSince `expand` might be a user supplied input parameter we need to limit it to\nproperties which are expandable (eg. `collections`). We also remove properties\nwhich holds no value for this document.\n\n      expand = expand\n        .filter (v) => @data[v] and v in collections\n\nNext we map the string array into an object array on the following format:\n`{ type: String, ids: Array }` where `ids` are ObjectIDs to an document of the\ncollection `type`.\n\n        .map (v) => type: v, ids: @data[v].map (d) -> new ObjectID d\n\nSet up a `final` function which is called when expanded data is ready to be\nmapped to the original document.\n\n      final = () =>\n        @db.findOne _id: @id, filter, (err, doc) ->\n          cb err, Object.assign doc or {}, mapped\n\nIf there are no fields to expand, we just call the `final` function instantly\nand no fields will get expanded.\n\n      return final() if expand.length is 0\n\nSet up a `next` function which is called for each expanded data returned from\nthe database. Expanded data is stored in the `mapped` object which is merged\nwith the main document in `final`. When all expanded fields are mapped `final`\nis called.\n\n      next = (type, _, docs) ->\n        mapped[type] = docs or []\n        return final() if Object.keys(mapped).length == expand.length\n\nGet the expanded sub-documents from the database.\n\n      expand.forEach (x) ->\n        mongo[x.type]\n\nWe find the sub-documents using the ObjectIDs in the expanded fields, that is\nthe easy part. The tricky part is to prevent information leackage of private\ndocuments. This the second part is a `query` limiting the results to public\ndocuments or those owned by the current API user.\n\n          .find Object.assign {_id: $in: x.ids}, query\n\nWe reuse the projection filter from the original document, but since we do not\nknow in advanced who owns a given sub-document we remove the `private` property\nto prevent information leakage.\n\n          .project Object.assign filter, privat: false\n\nBundle all the sub-documents in one array and pass it to the `next` function.\n\n          .toArray next.bind null, x.type\n\n\n## Doc.insert\n\nInserts a document into databse.\n\n### Params\n\n* **object** `data` - data to insert for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.replace\n\nReplaces all document data in database.\n\n### Params\n\n* **object** `data` - replacement data for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          data._id = @id\n          cb err, warn, data\n\n\n## Doc.update\n\nPartially update the document-data in database. This is some times referred to as\nPATCH in a HTTP \/ REST context.\n\n### Params\n\n* **object** `data` - replacement object for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n## Doc.delete\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n### Params\n\n* **function** `cb` - callback function (**Error** `err`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet', endret: new Date()\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cd106988b1016c2b852ce37bc8a322057082bbbd","subject":"Clean up config order of precidence","message":"Clean up config order of precidence\n\nThe order of precidence is:\n\n1. Command line params (these are passed via arguments.litcoffee - so they're\n   present always, even when Skyll isn't called from the command line)\n2. Params from config file\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/config.litcoffee","new_file":"lib\/config.litcoffee","new_contents":"    Module = require '.\/module'\n    q      = require 'q'\n    argv   = require '.\/arguments'\n    path   = require 'path'\n    fs     = require 'fs'\n\n    process.env.CGAPI_LOG_LEVEL = if argv?.verbosity? then argv.verbosity else 3\n\n    class Config extends Module\n\n      initialize: (params) =>\n        deferred = q.defer()\n        levels   = [ ]\n\n        if params?.location?\n          config = params.location\n        else if argv.conf?\n          config = argv.conf\n        else\n          config = path.join __dirname, '..', '.skyll.conf.js'\n\n\n        if argv?._?.length > 0\n          levels = levels.concat argv._\n        else if argv?.l?\n          for level in [0...argv.l]\n            levels.push new Date(Date.now() - (((argv.l - 1) - level) * 1000)).toString()\n        else if argv?.levels? == false\n          levels.push new Date().toString()\n\n        for key, val of argv\n          if key.length > 2 && typeof val != 'undefined'\n            if key == 'levels'\n              levels = levels.concat val\n            else\n              @[key] = val\n\n        fs.stat config, (err) =>\n          if err?\n            return deferred.reject @error 'DOES NOT EXIST', file: config\n          else\n            for key, val of require config\n              if typeof val == 'object' && val != null && val.length? == false\n                @[key] = { } unless @[key]?\n\n                @[key][k] = v for k, v of val\n              else\n                unless @[key]?\n                  if key == 'levels'\n                    for level in [0...val]\n                      levels.push new Date(Date.now() - (((val - 1) - level) * 1000)).toString()\n                  else\n                    @[key] = val\n\n          levels.push new Date().toString() if levels.length == 0\n\n          @levels = levels\n          @grid   = ((false for j in [0..@columns]) for i in [0..@rows])\n          @width  = @width  * @multiplier\n          @height = @height * @multiplier\n\n          super().then => deferred.resolve @\n\n        deferred.promise\n\n    module.exports = Config\n","old_contents":"    Module = require '.\/module'\n    q      = require 'q'\n    argv   = require '.\/arguments'\n    path   = require 'path'\n    fs     = require 'fs'\n\n    process.env.CGAPI_LOG_LEVEL = if argv?.verbosity? then argv.verbosity else 3\n\n    class Config extends Module\n\n      pathfinder: (neighbors) ->\n        o = [ ]\n\n        for n in [1..(neighbors.length \/ 1)]\n          c = 1 \/ neighbors.length\n\n          if neighbors[n - 1] == 'RIGHT'\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * ((2 \/ c) * 0.5)) * c\n          else\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * (0.5 \/ c)) * c\n\n        chance = Math.random()\n\n        for option in o\n          neighbor = Object.keys(option)[0]\n\n          return neighbor if option[neighbor] > chance\n\n      initialize: (params) =>\n        deferred = q.defer()\n        levels   = [ ]\n        base     = if params?.location? then params.location else path.join __dirname, '..'\n        config   = path.join base, '.skyll.conf.js'\n\n        fs.stat config, (err) =>\n          if err? || params?.cli?\n            if argv?._?.length > 0\n              levels = levels.concat argv._\n            else if argv?.l?\n              for level in [0...argv.l]\n                levels.push new Date(Date.now() - (((argv.l - 1) - level) * 1000)).toString()\n            else if argv?.levels? == false\n              levels.push new Date().toString()\n            for key, val of argv\n              if key.length > 2 && typeof val != 'undefined'\n                if key == 'levels'\n                  levels = levels.concat val\n                else\n                  @[key] = val\n          else\n            for key, val of require config\n              unless @[key]?\n                if key == 'levels'\n                  for level in [0...val]\n                    levels.push new Date(Date.now() - (((val - 1) - level) * 1000)).toString()\n                else\n                  @[key] = val\n\n          levels.push new Date().toString() if levels.length == 0\n\n          @levels = levels\n          @grid   = ((false for j in [0..@columns]) for i in [0..@rows])\n          @width  = @width  * @multiplier\n          @height = @height * @multiplier\n\n          super().then => deferred.resolve @\n\n        deferred.promise\n\n    module.exports = Config\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d1822acdea4f646388be610c26824cadfbad0582","subject":"Give renderif some documentation","message":"Give renderif some documentation\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a nodes child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it being visible until ready.\n\n## data-yield\n\n## data-contentfor\n\n## data-replace\n\n# Batman.View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","old_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n## data-yield\n\n## data-contentfor\n\n## data-replace\n\n# Batman.View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bd9b330078e53cf02c830c644ae9a9fb3025ebcc","subject":"chore(server): allow up to 10mb request body","message":"chore(server): allow up to 10mb request body\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    require 'newrelic' if process.env.NODE_ENV is 'production'\n\n    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n    compression = require 'compression'\n    bodyParser  = require 'body-parser'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(compression())\n    app.use bodyParser.json extended: true, limit: '10mb'\n    app.disable('x-powered-by')\n    app.disable('etag')\n    app.set 'port', process.env.APP_PORT or 8080\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/favicon\n\n    app.get '\/favicon.ico', (req, res) ->\n      res.set 'Content-Type': 'image\/x-icon'\n      res.status(200).end()\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.status(405).json message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.status(405).json message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## 404 handling\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.status(404).json message: \"Resurs ikke funnet\"\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.user.tilbyder}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n","old_contents":"    require 'newrelic' if process.env.NODE_ENV is 'production'\n\n    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n    compression = require 'compression'\n    bodyParser  = require 'body-parser'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(compression())\n    app.use(bodyParser.json())\n    app.disable('x-powered-by')\n    app.disable('etag')\n    app.set 'port', process.env.APP_PORT or 8080\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/favicon\n\n    app.get '\/favicon.ico', (req, res) ->\n      res.set 'Content-Type': 'image\/x-icon'\n      res.status(200).end()\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.status(405).json message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.status(405).json message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## 404 handling\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.status(404).json message: \"Resurs ikke funnet\"\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.user.tilbyder}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fef36f1297e8ad54668d4cb7ab790c3d6a2cda69","subject":"Reverted the transposition of get\/set\/X\/Y\/Z as it has been found they were originally correct.","message":"Reverted the transposition of get\/set\/X\/Y\/Z as it has been found they were\noriginally correct.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat","old_file":"src\/matrix.litcoffee","new_file":"src\/matrix.litcoffee","new_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    tempVector = []\n    tempVectorFrom = []\n    tempVectorTo = []\n    fromTemp = []\n    toTemp = []\n    tempVectorX = []\n    tempVectorY = []\n    tempVectorZ = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            module.exports.multiply output, temp3, output\n            return\n\n    vector = require \".\/vector.litcoffee\"\n            \n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\nGiven a vector specifying a translation and a matrix to translate, calling the \n\"translate\" property applies that translation to that matrix.\n            \n        translate: (vector, output) ->\n            output[3] += vector[0]\n            output[7] += vector[1]\n            output[11] += vector[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \nGiven a matrix, input vector and output vector, calling the \"applyToVector\"\nproperty writes the input vector transformed by the matrix to the output vector.\n        \n        applyToVector: (matrix, input, output) ->\n            vector.copy input, vectorTemp\n            output[0] = vectorTemp[0] * matrix[0] + vectorTemp[1] * matrix[1] + vectorTemp[2] * matrix[2] + matrix[3]\n            output[1] = vectorTemp[0] * matrix[4] + vectorTemp[1] * matrix[5] + vectorTemp[2] * matrix[6] + matrix[7]\n            output[2] = vectorTemp[0] * matrix[8] + vectorTemp[1] * matrix[9] + vectorTemp[2] * matrix[10] + matrix[11]\n            return\n            \nGiven a matrix and output vector, calling the \"getTranslation\" property writes\nthe translation applied by the matrix to the output vector.\n\n        getTranslation: (matrix, output) ->\n            output[0] = matrix[3]\n            output[1] = matrix[7]\n            output[2] = matrix[11]\n\nGiven a matrix and output vector, calling the \"getX\" property writes the vector\nof the matrix's X axis (a scaled normal) to the output vector.\n\n        getX: (matrix, output) ->\n            output[0] = matrix[0]\n            output[1] = matrix[4]\n            output[2] = matrix[8]\n\nGiven a matrix and output vector, calling the \"getY\" property writes the vector\nof the matrix's Y axis (a scaled normal) to the output vector.\n\n        getY: (matrix, output) ->\n            output[0] = matrix[1]\n            output[1] = matrix[5]\n            output[2] = matrix[9]\n            \nGiven a matrix and output vector, calling the \"getZ\" property writes the vector\nof the matrix's Z axis (a scaled normal) to the output vector.\n\n        getZ: (matrix, output) ->\n            output[0] = matrix[2]\n            output[1] = matrix[6]\n            output[2] = matrix[10]\n            \n# setTranslation\n\n- A vector specifying the translation to set.\n- A matrix to set the translation of.\n\nOverwrites the translation of the matrix with the content of the given vector.\n\n        setTranslation: (output, matrix) ->\n            matrix[3] = output[0]\n            matrix[7] = output[1]\n            matrix[11] = output[2]\n\n# setX\n\n- A vector specifying the X axis vector to set.\n- A matrix to set the X axis vector of.\n\nOverwrites the X axis of the matrix with the content of the given vector.\n\n        setX: (output, matrix) ->\n            matrix[0] = output[0]\n            matrix[4] = output[1]\n            matrix[8] = output[2]\n\n# setY\n\n- A vector specifying the Y axis vector to set.\n- A matrix to set the Y axis vector of.\n\nOverwrites the Y axis of the matrix with the content of the given vector.\n\n        setY: (output, matrix) ->\n            matrix[1] = output[0]\n            matrix[5] = output[1]\n            matrix[9] = output[2]\n\n# setZ\n\n- A vector specifying the Z axis vector to set.\n- A matrix to set the Z axis vector of.\n\nOverwrites the Z axis of the matrix with the content of the given vector.\n\n        setZ: (output, matrix) ->\n            matrix[2] = output[0]\n            matrix[6] = output[1]\n            matrix[10] = output[2]\n            \n# interpolate\n\n- An input matrix to interpolate from.\n- An input matrix to interpolate to.\n- A number specifying how far along to interpolate; \"0\" is \"from\" and \"1\" is \n  \"to\".\n- An output matrix.\n\nAttempts to perform a somewhat crude interpolation between the two matrices\nwhich is not very linear.  Good enough for smoothing over small changes.\nPrioritizes the Z and Y axes over the X axis when ensuring orthogonal.\n\n        interpolate: (from, to, alpha, output) ->       \n            module.exports.copy from, fromTemp\n            module.exports.copy to, toTemp\n            module.exports.identity output\n            module.exports.getTranslation fromTemp, tempVectorFrom\n            module.exports.getTranslation toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            module.exports.setTranslation tempVector, output\n            \n            module.exports.getX fromTemp, tempVectorFrom\n            module.exports.getX toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            vector.normalize tempVector, tempVectorX, true  \n            \n            module.exports.getY fromTemp, tempVectorFrom\n            module.exports.getY toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVectorY\n            \n            vector.cross tempVectorX, tempVectorY, tempVectorZ\n            vector.normalize tempVectorZ, tempVectorZ\n            vector.cross tempVectorZ, tempVectorX, tempVectorY\n            vector.normalize tempVectorY, tempVectorY\n            \n            module.exports.setX tempVectorX, output\n            module.exports.setY tempVectorY, output\n            module.exports.setZ tempVectorZ, output\n            return\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","old_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    tempVector = []\n    tempVectorFrom = []\n    tempVectorTo = []\n    fromTemp = []\n    toTemp = []\n    tempVectorX = []\n    tempVectorY = []\n    tempVectorZ = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            module.exports.multiply output, temp3, output\n            return\n\n    vector = require \".\/vector.litcoffee\"\n            \n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\nGiven a vector specifying a translation and a matrix to translate, calling the \n\"translate\" property applies that translation to that matrix.\n            \n        translate: (vector, output) ->\n            output[3] += vector[0]\n            output[7] += vector[1]\n            output[11] += vector[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \nGiven a matrix, input vector and output vector, calling the \"applyToVector\"\nproperty writes the input vector transformed by the matrix to the output vector.\n        \n        applyToVector: (matrix, input, output) ->\n            vector.copy input, vectorTemp\n            output[0] = vectorTemp[0] * matrix[0] + vectorTemp[1] * matrix[1] + vectorTemp[2] * matrix[2] + matrix[3]\n            output[1] = vectorTemp[0] * matrix[4] + vectorTemp[1] * matrix[5] + vectorTemp[2] * matrix[6] + matrix[7]\n            output[2] = vectorTemp[0] * matrix[8] + vectorTemp[1] * matrix[9] + vectorTemp[2] * matrix[10] + matrix[11]\n            return\n            \nGiven a matrix and output vector, calling the \"getTranslation\" property writes\nthe translation applied by the matrix to the output vector.\n\n        getTranslation: (matrix, output) ->\n            output[0] = matrix[3]\n            output[1] = matrix[7]\n            output[2] = matrix[11]\n\nGiven a matrix and output vector, calling the \"getX\" property writes the vector\nof the matrix's X axis (a scaled normal) to the output vector.\n\n        getX: (matrix, output) ->\n            output[0] = matrix[0]\n            output[1] = matrix[1]\n            output[2] = matrix[2]\n\nGiven a matrix and output vector, calling the \"getY\" property writes the vector\nof the matrix's Y axis (a scaled normal) to the output vector.\n\n        getY: (matrix, output) ->\n            output[0] = matrix[4]\n            output[1] = matrix[5]\n            output[2] = matrix[6]\n            \nGiven a matrix and output vector, calling the \"getZ\" property writes the vector\nof the matrix's Z axis (a scaled normal) to the output vector.\n\n        getZ: (matrix, output) ->\n            output[0] = matrix[8]\n            output[1] = matrix[9]\n            output[2] = matrix[10]\n            \n# setTranslation\n\n- A vector specifying the translation to set.\n- A matrix to set the translation of.\n\nOverwrites the translation of the matrix with the content of the given vector.\n\n        setTranslation: (output, matrix) ->\n            matrix[3] = output[0]\n            matrix[7] = output[1]\n            matrix[11] = output[2]\n\n# setX\n\n- A vector specifying the X axis vector to set.\n- A matrix to set the X axis vector of.\n\nOverwrites the X axis of the matrix with the content of the given vector.\n\n        setX: (output, matrix) ->\n            matrix[0] = output[0]\n            matrix[1] = output[1]\n            matrix[2] = output[2]\n\n# setY\n\n- A vector specifying the Y axis vector to set.\n- A matrix to set the Y axis vector of.\n\nOverwrites the Y axis of the matrix with the content of the given vector.\n\n        setY: (output, matrix) ->\n            matrix[4] = output[0]\n            matrix[5] = output[1]\n            matrix[6] = output[2]\n\n# setZ\n\n- A vector specifying the Z axis vector to set.\n- A matrix to set the Z axis vector of.\n\nOverwrites the Z axis of the matrix with the content of the given vector.\n\n        setZ: (output, matrix) ->\n            matrix[8] = output[0]\n            matrix[9] = output[1]\n            matrix[10] = output[2]\n            \n# interpolate\n\n- An input matrix to interpolate from.\n- An input matrix to interpolate to.\n- A number specifying how far along to interpolate; \"0\" is \"from\" and \"1\" is \n  \"to\".\n- An output matrix.\n\nAttempts to perform a somewhat crude interpolation between the two matrices\nwhich is not very linear.  Good enough for smoothing over small changes.\nPrioritizes the Z and Y axes over the X axis when ensuring orthogonal.\n\n        interpolate: (from, to, alpha, output) ->       \n            module.exports.copy from, fromTemp\n            module.exports.copy to, toTemp\n            module.exports.identity output\n            module.exports.getTranslation fromTemp, tempVectorFrom\n            module.exports.getTranslation toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            module.exports.setTranslation tempVector, output\n            \n            module.exports.getX fromTemp, tempVectorFrom\n            module.exports.getX toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            vector.normalize tempVector, tempVectorX, true  \n            \n            module.exports.getY fromTemp, tempVectorFrom\n            module.exports.getY toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVectorY\n            \n            vector.cross tempVectorX, tempVectorY, tempVectorZ\n            vector.normalize tempVectorZ, tempVectorZ\n            vector.cross tempVectorZ, tempVectorX, tempVectorY\n            vector.normalize tempVectorY, tempVectorY\n            \n            module.exports.setX tempVectorX, output\n            module.exports.setY tempVectorY, output\n            module.exports.setZ tempVectorZ, output\n            return\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"65d46b0793a4c682906e2bd4d6a255d56c099b14","subject":"Validate message name in server as well","message":"Validate message name in server as well\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\tconfig = require '..\/config.js'\n\nInitialize sane values.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\nInstance of express.\n\n\t\tapp: null\n\nInstance of http\n\n\t\tserver: null\n\nInstance of socket.io\n\n\t\tio: null\n\nStatistics for the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting nodePush'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing outbound socket'\n\nStart HTTP service.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\tlistenCallback = =>\n\nShed root privilegies.\n\n\t\t\t\tif process.getuid() is 0 or process.getgid() is 0\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\t\t\t\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.type 'text\/plain'\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\treturn unless \/[a-zA-Z0-9-_.]+$\/.test name\n\t\t\t\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\nPass data to the browsers and close connection.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nKill connection after 5 seconds.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket unless config.inbound.useTCP\n\t\t\tfs.unlinkSync config.outbound.socket unless config.outbound.useTCP\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","old_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\tconfig = require '..\/config.js'\n\nInitialize sane values.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\nInstance of express.\n\n\t\tapp: null\n\nInstance of http\n\n\t\tserver: null\n\nInstance of socket.io\n\n\t\tio: null\n\nStatistics for the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting nodePush'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing outbound socket'\n\nStart HTTP service.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\tlistenCallback = =>\n\nShed root privilegies.\n\n\t\t\t\tif process.getuid() is 0 or process.getgid() is 0\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\t\t\t\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.type 'text\/plain'\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\nPass data to the browsers and close connection.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nKill connection after 5 seconds.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket unless config.inbound.useTCP\n\t\t\tfs.unlinkSync config.outbound.socket unless config.outbound.useTCP\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"5098ebf4535f1e12fe875126c6883ebeb9e9a62d","subject":"fixed typo in documentation","message":"fixed typo in documentation\n","repos":"versionone\/V1.Backbone","old_file":"V1.Backbone.litcoffee","new_file":"V1.Backbone.litcoffee","new_contents":"V1.Backbone\n===========\n\nA simple backbone adapter for V1 queries.\n\nBase Setup\n----------\n\nEstablish and import some required global objects.\n\n    V1 = if exports? then exports else this.V1 or (this.V1 = {})\n    _ = if !this?._? then (if require? then require('underscore') else throw \"Unable to load\/find underscore\") else this._\n    Backbone = if !this?.Backbone? then (if require? then require('backbone') else throw \"Unable to load\/find backbone\") else this.Backbone\n    \nCreate a `property` helper bound to a specified property.\n\nThis returns a function which can be invoked with one or more objects. \nIt will loop through though arguments and return value from the first object\nwhich has the desired property. A `defaultValue` can be specified if no matching \nproperty can not be found.\n\nThe returned function also provides a `safe()` getter which will throw an \nexception if value cannot be found -- rather than returning `defaultValue`.\n\nThe returned function also provides a `set()` function for setting the\nunderlying default value.\n\n    createProperty = (property, defaultValue) ->\n      getter = () ->\n        for arg in arguments\n          return arg[property] if arg?[property]?\n        defaultValue\n    \n      _(getter).tap (getter) ->\n        getter.safe = () ->\n          val = getter.apply(this, arguments)\n          throw \"A \"+property+\" is required\" unless val?\n          val\n    \n        getter.set = (val) -> defaultValue = val\n    \nCreate property getters for the `retriever` and the `persister`.\n    \n    defaultRetriever = createProperty(\"retriever\")\n    defaultPersister = createProperty(\"persister\")\n    \nThis is the default `sync` method for all `V1.Backbone` objects. This\nmethod proxies most of its work into the configured `retriever` and\n`persister`. Which are usually instances of `V1.Backbone.JsonRetiever` and\n`V1.Backbone.RestPersister` respectively.\n    \n    sync = do ->\n      methods = do ->\n        syncToPersisterMethod = (method) ->\n          (ctx, options) ->\n            persister = defaultPersister.safe(this.queryOptions, options)\n    \n            xhr = persister[method](ctx, options)\n              .fail(options.error)\n              .done(options.success)\n    \n            ctx.trigger('request', ctx, xhr, options);\n            xhr\n    \n        readFromRetriever = (model, options) ->\n          retriever = defaultRetriever.safe(this.queryOptions, options)\n    \n          xhr = retriever.into(model, options)\n            .done(options.success).fail(options.error)\n    \n          model.trigger('request', model, xhr, options);\n          xhr\n    \n        read: readFromRetriever\n        create: syncToPersisterMethod(\"send\")\n        update: syncToPersisterMethod(\"send\")\n        delete: syncToPersisterMethod(\"delete\")\n    \n      \n      (method, model, options) ->\n        throw \"Unsupported sync method: \\\"#{method}\\\"\" unless methods[method]\n        methods[method].call(this, model, options)\n        \nHelpers\n-------\n\nThese are helper methods for determining types.\n\n    isModel = (type) ->\n      type::isV1 and (type is Backbone.Model or type.prototype instanceof Backbone.Model)\n    \n    isCollection = (type) ->\n      type::isV1 and (type is Backbone.Collection or type.prototype instanceof Backbone.Collection)\n    \n    isAcceptable = (type) ->\n      isModel(type) or isCollection(type)\n\nA utility function to mix `V1.Backbone` functionality into an existing `Backbone.Model` or\n`Backbone.Collection`. This can be useful for enviroments where the `V1.Backbone` dependancy\nis not available at object construction time, you can use this to mix in the `V1.Backbone`\nextensions at a later time.\n\n    mixInTo = (cls) ->\n      _(cls).tap (cls) ->\n        cls::sync = sync\n        cls::isV1 = true\n        cls::idAttribute = \"_oid\" if cls::idAttribute?\n    \nMain\n----\n\nThis is the main `V1.Backbone` namespace. \n\n    V1.Backbone =\n    \nSet the *global* default retriever options.\n\n      setDefaultRetriever: (options) ->\n        defaultRetriever.set(new V1.Backbone.JsonRetriever(options))\n    \nClear the *global* default retriever -- useful for test contexts.\n\n      clearDefaultRetriever: -> defaultRetriever.set(undefined)\n\nSet the *global* default persister options.\n\n      setDefaultPersister: (options) ->\n        defaultPersister.set(new V1.Backbone.RestPersister(options))\n    \nClear the *global* default persister -- useful for test contexts.    \n    \n      clearDefaultPersister: -> defaultPersister.set(undefined)\n\nBegin a batch transaction. You can queue up multiple queries during one HTTP request\nwith this method.\n\n\n\n> Note: Be sure to remember to wait for the deferred object to be\nresolved before attempting to use the data.\n\n      begin: (options) ->\n        options = _.extend({}, defaultRetriever()?.options, options, {batch: true})\n        new V1.Backbone.JsonRetriever(options)\n    \nExport the `mixInTo` helper.    \n    \n      mixInTo: mixInTo\n      \n      Model: mixInTo Backbone.Model.extend()\n      Collection: mixInTo Backbone.Collection.extend()\n    \nRetrieval\n--------\n\n    class V1.Backbone.JsonRetriever\n      defaultOptions =\n        fetch: () -> $.post.apply($, arguments)\n        defer: () -> $.Deferred.apply($, arguments)\n    \n      validQueryOptions = [\"find\", \"filter\", \"where\", \"with\"]\n    \n      getQueryFor = (type, attribute) ->\n        throw \"Unsupported type\" unless isAcceptable(type)\n    \n        protoModel = type.prototype if isModel(type)\n        protoModel = type::model.prototype if isCollection(type)\n    \n        queryOptions = protoModel.queryOptions\n    \n        assetType = queryOptions.assetType or attribute\n    \n        query = from: if attribute then \"#{attribute} as #{assetType}\" else assetType\n        addSelectTokens(queryOptions.schema, query)\n        addFilterTokens(type, query)\n        addFindInTokens(type, query)\n    \n        type.prototype.queryMucker?(query) if isCollection(type)\n    \n        query\n    \n      addRelation = (relation) ->\n        subQuery = getQueryFor(relation.type, relation.attribute)\n        _.extend(subQuery, _.pick(relation, validQueryOptions))\n    \n      safeConcat = (set, newArray) ->\n          newArray = if _.isString(newArray) then [newArray] else newArray\n          set = set.concat(newArray) if _.isArray(newArray) and newArray.length > 0\n          set\n    \n      addFilterTokens = (type, query) ->\n        filter = []\n        filter = safeConcat(filter, type::queryOptions?.filter)\n        filter = safeConcat(filter, type::model::queryOptions?.filter) if isCollection(type)\n    \n        query.filter = filter if filter.length > 0\n    \n      addFindInTokens = (type, query) ->\n        findIn = []\n        findIn = safeConcat(findIn, type::queryOptions?.findIn)\n    \n        query.findIn = findIn if findIn.length > 0\n    \n      addSelectTokens = (schema, query) ->\n        return query.select = [schema] if _.isString(schema)\n        return unless schema? and schema.length > 0\n        query.select = _(schema).map (item) ->\n          return addRelation(item) if item instanceof Relation\n          return item.attribute if item instanceof Alias\n          return item if _.isString(item)\n    \n      constructor: (options) ->\n        throw \"url required\" unless options?.url?\n    \n        @options = _.extend({}, defaultOptions, options)\n    \n        @clear()\n    \n      for: (type) ->\n        @batchInto(type, getQueryFor(type), @queries.length)\n          .pipe (aliasedRows) -> new type(aliasedRows)\n    \n      fetch: (instance, options) ->\n        options = _.extend({}, options, { retriever: this })\n        instance.fetch(options)\n    \n      into: (instance, options) ->\n        type = instance.constructor\n        query = getQueryFor(type)\n    \n        _.extend(query, _.pick(options, validQueryOptions))\n    \n        instance.queryMucker?(query) if instance.queryMucker? and instance.queryMucker != type.prototype.queryMucker\n    \n        if isModel(type)\n          throw \"`id` is required\" unless instance.id\n          query.where = _.extend(query.where or {}, ID: instance.id)\n    \n        return @batchInto(type, query, @queries.length) if @options.batch\n    \n        data = JSON.stringify(query)\n    \n        xhr = @options.fetch(@options.url, data)\n    \n        deferred = xhr.pipe (data) -> prepareResultFor(data[0], type)\n        deferred.abort = _.bind(xhr.abort, xhr) if xhr.abort? and !deferred.abort?\n    \n        deferred\n    \n    \n      findOrCreateBatch: ->\n        @currentBatch = @options.defer() unless @currentBatch?\n        @currentBatch\n    \n      batchInto: (type, query, index) ->\n        @queries[index] = query\n    \n        @findOrCreateBatch()\n          .pipe((results) -> prepareResultFor(results[index], type))\n    \n      exec: ->\n        return unless @currentBatch\n    \n        data = _(this.queries)\n          .map((q) -> JSON.stringify(q))\n          .join(\"\\n---\\n\");\n    \n        @options.fetch(@options.url, data)\n          .done(@resolveBatch)\n    \n      resolveBatch: (data) =>\n        @currentBatch.resolve(data)\n        @clear()\n    \n      clear: =>\n        @queries = []\n        @currentBatch = undefined\n    \n      prepareResultFor = (data, type) ->\n        rows = aliasRows(data, type)\n        return rows if isCollection(type)\n        return rows[0] if isModel(type)\n    \n      aliasRows = (rows, type) ->\n        schema = if isModel(type)\n        then type::queryOptions?.schema\n        else type::model::queryOptions?.schema\n    \n        schema = [schema] if _.isString(schema)\n    \n        _(rows).map (row) ->\n          transformedRow = { \"_oid\": row[\"_oid\"] }\n          _(schema).each (item) ->\n            if(_.isString(item))\n              transformedRow[item] = row[item]\n            else if(item instanceof Alias)\n              if(item instanceof Relation)\n                children = aliasRows(row[item.attribute], item.type)\n                transformedRow[item.alias] = new item.type(children[0]) if item.isSingle() && children[0]?\n                transformedRow[item.alias] = new item.type(children) if item.isMulti()\n              else\n                transformedRow[item.alias] = row[item.attribute]\n    \n          transformedRow\n\nPersistance\n-----------\n \n    class V1.Backbone.RestPersister\n      urlTmpl = _.template(\"<%= baseUrl %>\/<%= assetType %><% if(typeof(id) != \\\"undefined\\\") { %>\/<%= id %><% } %>\")\n    \n      toAttribute = (attribute, value) ->\n        \"<Attribute name=\\\"#{_.escape(attribute)}\\\" act=\\\"set\\\">#{_.escape(value)}<\/Attribute>\"\n    \n      toSingleRelation = (attribute, oid) ->\n        \"<Relation name=\\\"#{_.escape(attribute)}\\\" act=\\\"set\\\"><Asset idref=\\\"#{_.escape(oid)}\\\" \/><\/Relation>\"\n    \n      defaultOptions =\n        post: (url, data) ->\n          $.ajax\n            type: \"POST\"\n            url: url,\n            data: data,\n            dataType: \"text\"\n    \n        defer: () -> $.Deferred.apply($, arguments)\n    \n      url: (assetType, oid) =>\n        oidParts = if oid? then oid.split(\":\") else []\n        urlTmpl({baseUrl: @options.url, assetType: oidParts[0] or assetType, id: oidParts[1]})\n    \n      constructor: (options) ->\n        throw \"url required\" unless options?.url?\n        @options = _.extend({}, defaultOptions, options)\n    \n      delete: (ctx, options) ->\n        throw \"Unsupported context\" unless isModel(ctx.constructor)\n        options = options || {}\n        attr = options.attrs || ctx.toJSON(options)\n        @options.post(@url(ctx.queryOptions.assetType, ctx.id)+\"?op=Delete\")\n    \n      send: (ctx, options) ->\n        send = if options.patch is yes then @sendPatch else @sendAll\n        send.apply(this, arguments)\n    \n      sendPatch: (ctx, options) ->\n        schema = _.indexBy ctx.queryOptions.schema, (val) ->\n          if (val instanceof Alias) then val.alias else val\n    \n        toXml = (val, key) ->\n          item = schema[key] || key\n          return toSingleRelation(item.attribute, attr[item.alias].id) if item instanceof Relation and item.isSingle() and attr[item.alias]?\n          return if item instanceof Relation\n          return toAttribute(item.attribute, val) if item instanceof Alias\n          return toAttribute(item, val) if _.isString(item)\n    \n        attrXml = _.map(ctx.changedAttributes(), toXml).join(\"\")\n        asset = \"<Asset>#{attrXml}<\/Asset>\"\n        url = @url(ctx.queryOptions.assetType, ctx.id)\n        @options.post(url, asset)\n    \n      sendAll: (ctx, options) ->\n        throw \"Unsupported context\" unless isModel(ctx.constructor)\n        options = options || {}\n        attr = options.attrs || ctx.toJSON(options)\n    \n        toXml = (item) ->\n          return toSingleRelation(item.attribute, attr[item.alias].id) if item instanceof Relation and item.isSingle() and attr[item.alias]?\n          return if item instanceof Relation\n          return toAttribute(item.attribute, attr[item.alias]) if item instanceof Alias\n          return toAttribute(item, attr[item]) if _.isString(item)\n    \n        attrXml = _.map(ctx.queryOptions.schema, toXml).join(\"\")\n    \n        asset = \"<Asset>#{attrXml}<\/Asset>\"\n        url = @url(ctx.queryOptions.assetType, ctx.id)\n        @options.post(url, asset)\n          .done((data) -> ctx.id = result[1] if result = \/id=\"(\\w+:\\d+):\\d+\"\/.exec(data))\n    \nRelation Helpers\n----------------\n\n    aug = do ->\n      fn = (target, action) ->\n        Dup = ->\n        Dup.prototype = target\n        _(new Dup()).tap(action || ->)\n    \n      _(fn).tap (fn) ->\n        fn.extend = (target, props) ->\n          aug target, (augmentedResult) -> _.extend(augmentedResult, props)\n    \n        fn.add = (target, property, values) ->\n          aug target, (augmentedResult) ->\n            augmentedResult[property] = if _.isArray(target[property]) then target[property].concat(values) else values\n    \n        fn.merge = (target, props) ->\n          aug target, (augmentedResult) ->\n            _(props).each (val, key) -> target[key] = _.extend(val, target[key])\n    \nAlias Helper\n------------\n    \n    class Alias\n      constructor: (@attribute) ->\n        @alias = @attribute\n    \n      as: (alias) ->\n        aug.extend(this, {alias})\n    \nExport a simple constructor as `V1.Backbone.alias`\n\n    V1.Backbone.alias = (attribute) -> new Alias(attribute)\n    \nRelation Helper\n---------------\n    \n    class Relation extends Alias\n      constructor: (@attribute) ->\n        super(@attribute)\n        @type = V1.Backbone.Collection\n    \n      isMulti: ->\n        isCollection(@type)\n    \n      isSingle: ->\n        isModel(@type)\n    \n      of: (type) ->\n        throw \"Unsupported type must be a V1.Backbone.Model or a V1.Backbone.Collection\" unless isAcceptable(type)\n        aug.extend(this, {type})\n    \n      addFilter: (filters...) ->\n        aug.add(this, \"filter\", filters)\n    \n      addWhere: (where) ->\n        aug.merge(this, {where})\n    \n      addWith: (newWith) ->\n        aug.merge(this, {newWith})\n    \nExport a simple constructor as `V1.Backbone.relation`    \n    \n    V1.Backbone.relation = (attribute) -> new Relation(attribute)\n","old_contents":"V1.Backbone\n===========\n\nA simple backbone adapter for V1 queries.\n\nBase Setup\n----------\n\nEstablish and import some required global objects.\n\n    V1 = if exports? then exports else this.V1 or (this.V1 = {})\n    _ = if !this?._? then (if require? then require('underscore') else throw \"Unable to load\/find underscore\") else this._\n    Backbone = if !this?.Backbone? then (if require? then require('backbone') else throw \"Unable to load\/find backbone\") else this.Backbone\n    \nCreate a `property` helper bound to a specified property.\n\nThis returns a function which can be invoked with one or more objects. \nIt will loop through though arguments and return value from the first object\nwhich has the desired property. A `defaultValue` can be specified if no matching \nproperty can not be found.\n\nThe returned function also provides a `safe()` getter which will throw an \nexception if value cannot be found -- rather than returning `defaultValue`.\n\nThe returned function also provides a `set()` function for setting the\nunderlying default value.\n\n    createProperty = (property, defaultValue) ->\n      getter = () ->\n        for arg in arguments\n          return arg[property] if arg?[property]?\n        defaultValue\n    \n      _(getter).tap (getter) ->\n        getter.safe = () ->\n          val = getter.apply(this, arguments)\n          throw \"A \"+property+\" is required\" unless val?\n          val\n    \n        getter.set = (val) -> defaultValue = val\n    \nCreate property getters for the `retriever` and the `persister`.\n    \n    defaultRetriever = createProperty(\"retriever\")\n    defaultPersister = createProperty(\"persister\")\n    \nThis is the default `sync` method for all `V1.Backbone` objects. This\nmethod proxies most of its work into the configured `retriever` and\n`persister`. Which are usually instances of `V1.Backbone.JsonRetiever` and\n`V1.Backbone.RestPersister` respectively.\n    \n    sync = do ->\n      methods = do ->\n        syncToPersisterMethod = (method) ->\n          (ctx, options) ->\n            persister = defaultPersister.safe(this.queryOptions, options)\n    \n            xhr = persister[method](ctx, options)\n              .fail(options.error)\n              .done(options.success)\n    \n            ctx.trigger('request', ctx, xhr, options);\n            xhr\n    \n        readFromRetriever = (model, options) ->\n          retriever = defaultRetriever.safe(this.queryOptions, options)\n    \n          xhr = retriever.into(model, options)\n            .done(options.success).fail(options.error)\n    \n          model.trigger('request', model, xhr, options);\n          xhr\n    \n        read: readFromRetriever\n        create: syncToPersisterMethod(\"send\")\n        update: syncToPersisterMethod(\"send\")\n        delete: syncToPersisterMethod(\"delete\")\n    \n      \n      (method, model, options) ->\n        throw \"Unsupported sync method: \\\"#{method}\\\"\" unless methods[method]\n        methods[method].call(this, model, options)\n        \nHelpers\n-------\n\nThese are helper methods for determining types.\n\n    isModel = (type) ->\n      type::isV1 and (type is Backbone.Model or type.prototype instanceof Backbone.Model)\n    \n    isCollection = (type) ->\n      type::isV1 and (type is Backbone.Collection or type.prototype instanceof Backbone.Collection)\n    \n    isAcceptable = (type) ->\n      isModel(type) or isCollection(type)\n\nA utility function to mix `V1.Backbone` functionality into an existing `Backbone.Model` or\n`Backbone.Collection`. This can be useful for enviroments where the `V1.Backbone` dependancy\nis not available at object construction time, you can use this to mix in the `V1.Backbone`\nextensions at a later time.\n\n    mixInTo = (cls) ->\n      _(cls).tap (cls) ->\n        cls::sync = sync\n        cls::isV1 = true\n        cls::idAttribute = \"_oid\" if cls::idAttribute?\n    \nMain\n----\n\nThis is the main `V1.Backbone` namespace. \n\n    V1.Backbone =\n    \nSet the *global* default retriever options.\n\n      setDefaultRetriever: (options) ->\n        defaultRetriever.set(new V1.Backbone.JsonRetriever(options))\n    \nClear the *global* default retriever -- useful for test contexts.\n\n      clearDefaultRetriever: -> defaultRetriever.set(undefined)\n\nSet the *global* default persister options.\n\n      setDefaultPersister: (options) ->\n        defaultPersister.set(new V1.Backbone.RestPersister(options))\n    \nClear the *global* default persister -- useful for test contexts.    \n    \n      clearDefaultPersister: -> defaultPersister.set(undefined)\n\nBegin a batch transaction. You can queue up multiple queries during one HTTP request\nwith this method.\n\n\n\n> Note: Be sure to remember to wait for the deferred object to be\nresolved before attempting to use the data.\n\n      begin: (options) ->\n        options = _.extend({}, defaultRetriever()?.options, options, {batch: true})\n        new V1.Backbone.JsonRetriever(options)\n    \nExport the `mixInTo` helper.    \n    \n      mixInTo: mixInTo\n      \n      Model: mixInTo Backbone.Model.extend()\n      Collection: mixInTo Backbone.Collection.extend()\n    \nRetrival\n--------\n\n    class V1.Backbone.JsonRetriever\n      defaultOptions =\n        fetch: () -> $.post.apply($, arguments)\n        defer: () -> $.Deferred.apply($, arguments)\n    \n      validQueryOptions = [\"find\", \"filter\", \"where\", \"with\"]\n    \n      getQueryFor = (type, attribute) ->\n        throw \"Unsupported type\" unless isAcceptable(type)\n    \n        protoModel = type.prototype if isModel(type)\n        protoModel = type::model.prototype if isCollection(type)\n    \n        queryOptions = protoModel.queryOptions\n    \n        assetType = queryOptions.assetType or attribute\n    \n        query = from: if attribute then \"#{attribute} as #{assetType}\" else assetType\n        addSelectTokens(queryOptions.schema, query)\n        addFilterTokens(type, query)\n        addFindInTokens(type, query)\n    \n        type.prototype.queryMucker?(query) if isCollection(type)\n    \n        query\n    \n      addRelation = (relation) ->\n        subQuery = getQueryFor(relation.type, relation.attribute)\n        _.extend(subQuery, _.pick(relation, validQueryOptions))\n    \n      safeConcat = (set, newArray) ->\n          newArray = if _.isString(newArray) then [newArray] else newArray\n          set = set.concat(newArray) if _.isArray(newArray) and newArray.length > 0\n          set\n    \n      addFilterTokens = (type, query) ->\n        filter = []\n        filter = safeConcat(filter, type::queryOptions?.filter)\n        filter = safeConcat(filter, type::model::queryOptions?.filter) if isCollection(type)\n    \n        query.filter = filter if filter.length > 0\n    \n      addFindInTokens = (type, query) ->\n        findIn = []\n        findIn = safeConcat(findIn, type::queryOptions?.findIn)\n    \n        query.findIn = findIn if findIn.length > 0\n    \n      addSelectTokens = (schema, query) ->\n        return query.select = [schema] if _.isString(schema)\n        return unless schema? and schema.length > 0\n        query.select = _(schema).map (item) ->\n          return addRelation(item) if item instanceof Relation\n          return item.attribute if item instanceof Alias\n          return item if _.isString(item)\n    \n      constructor: (options) ->\n        throw \"url required\" unless options?.url?\n    \n        @options = _.extend({}, defaultOptions, options)\n    \n        @clear()\n    \n      for: (type) ->\n        @batchInto(type, getQueryFor(type), @queries.length)\n          .pipe (aliasedRows) -> new type(aliasedRows)\n    \n      fetch: (instance, options) ->\n        options = _.extend({}, options, { retriever: this })\n        instance.fetch(options)\n    \n      into: (instance, options) ->\n        type = instance.constructor\n        query = getQueryFor(type)\n    \n        _.extend(query, _.pick(options, validQueryOptions))\n    \n        instance.queryMucker?(query) if instance.queryMucker? and instance.queryMucker != type.prototype.queryMucker\n    \n        if isModel(type)\n          throw \"`id` is required\" unless instance.id\n          query.where = _.extend(query.where or {}, ID: instance.id)\n    \n        return @batchInto(type, query, @queries.length) if @options.batch\n    \n        data = JSON.stringify(query)\n    \n        xhr = @options.fetch(@options.url, data)\n    \n        deferred = xhr.pipe (data) -> prepareResultFor(data[0], type)\n        deferred.abort = _.bind(xhr.abort, xhr) if xhr.abort? and !deferred.abort?\n    \n        deferred\n    \n    \n      findOrCreateBatch: ->\n        @currentBatch = @options.defer() unless @currentBatch?\n        @currentBatch\n    \n      batchInto: (type, query, index) ->\n        @queries[index] = query\n    \n        @findOrCreateBatch()\n          .pipe((results) -> prepareResultFor(results[index], type))\n    \n      exec: ->\n        return unless @currentBatch\n    \n        data = _(this.queries)\n          .map((q) -> JSON.stringify(q))\n          .join(\"\\n---\\n\");\n    \n        @options.fetch(@options.url, data)\n          .done(@resolveBatch)\n    \n      resolveBatch: (data) =>\n        @currentBatch.resolve(data)\n        @clear()\n    \n      clear: =>\n        @queries = []\n        @currentBatch = undefined\n    \n      prepareResultFor = (data, type) ->\n        rows = aliasRows(data, type)\n        return rows if isCollection(type)\n        return rows[0] if isModel(type)\n    \n      aliasRows = (rows, type) ->\n        schema = if isModel(type)\n        then type::queryOptions?.schema\n        else type::model::queryOptions?.schema\n    \n        schema = [schema] if _.isString(schema)\n    \n        _(rows).map (row) ->\n          transformedRow = { \"_oid\": row[\"_oid\"] }\n          _(schema).each (item) ->\n            if(_.isString(item))\n              transformedRow[item] = row[item]\n            else if(item instanceof Alias)\n              if(item instanceof Relation)\n                children = aliasRows(row[item.attribute], item.type)\n                transformedRow[item.alias] = new item.type(children[0]) if item.isSingle() && children[0]?\n                transformedRow[item.alias] = new item.type(children) if item.isMulti()\n              else\n                transformedRow[item.alias] = row[item.attribute]\n    \n          transformedRow\n\nPersistance\n-----------\n \n    class V1.Backbone.RestPersister\n      urlTmpl = _.template(\"<%= baseUrl %>\/<%= assetType %><% if(typeof(id) != \\\"undefined\\\") { %>\/<%= id %><% } %>\")\n    \n      toAttribute = (attribute, value) ->\n        \"<Attribute name=\\\"#{_.escape(attribute)}\\\" act=\\\"set\\\">#{_.escape(value)}<\/Attribute>\"\n    \n      toSingleRelation = (attribute, oid) ->\n        \"<Relation name=\\\"#{_.escape(attribute)}\\\" act=\\\"set\\\"><Asset idref=\\\"#{_.escape(oid)}\\\" \/><\/Relation>\"\n    \n      defaultOptions =\n        post: (url, data) ->\n          $.ajax\n            type: \"POST\"\n            url: url,\n            data: data,\n            dataType: \"text\"\n    \n        defer: () -> $.Deferred.apply($, arguments)\n    \n      url: (assetType, oid) =>\n        oidParts = if oid? then oid.split(\":\") else []\n        urlTmpl({baseUrl: @options.url, assetType: oidParts[0] or assetType, id: oidParts[1]})\n    \n      constructor: (options) ->\n        throw \"url required\" unless options?.url?\n        @options = _.extend({}, defaultOptions, options)\n    \n      delete: (ctx, options) ->\n        throw \"Unsupported context\" unless isModel(ctx.constructor)\n        options = options || {}\n        attr = options.attrs || ctx.toJSON(options)\n        @options.post(@url(ctx.queryOptions.assetType, ctx.id)+\"?op=Delete\")\n    \n      send: (ctx, options) ->\n        send = if options.patch is yes then @sendPatch else @sendAll\n        send.apply(this, arguments)\n    \n      sendPatch: (ctx, options) ->\n        schema = _.indexBy ctx.queryOptions.schema, (val) ->\n          if (val instanceof Alias) then val.alias else val\n    \n        toXml = (val, key) ->\n          item = schema[key] || key\n          return toSingleRelation(item.attribute, attr[item.alias].id) if item instanceof Relation and item.isSingle() and attr[item.alias]?\n          return if item instanceof Relation\n          return toAttribute(item.attribute, val) if item instanceof Alias\n          return toAttribute(item, val) if _.isString(item)\n    \n        attrXml = _.map(ctx.changedAttributes(), toXml).join(\"\")\n        asset = \"<Asset>#{attrXml}<\/Asset>\"\n        url = @url(ctx.queryOptions.assetType, ctx.id)\n        @options.post(url, asset)\n    \n      sendAll: (ctx, options) ->\n        throw \"Unsupported context\" unless isModel(ctx.constructor)\n        options = options || {}\n        attr = options.attrs || ctx.toJSON(options)\n    \n        toXml = (item) ->\n          return toSingleRelation(item.attribute, attr[item.alias].id) if item instanceof Relation and item.isSingle() and attr[item.alias]?\n          return if item instanceof Relation\n          return toAttribute(item.attribute, attr[item.alias]) if item instanceof Alias\n          return toAttribute(item, attr[item]) if _.isString(item)\n    \n        attrXml = _.map(ctx.queryOptions.schema, toXml).join(\"\")\n    \n        asset = \"<Asset>#{attrXml}<\/Asset>\"\n        url = @url(ctx.queryOptions.assetType, ctx.id)\n        @options.post(url, asset)\n          .done((data) -> ctx.id = result[1] if result = \/id=\"(\\w+:\\d+):\\d+\"\/.exec(data))\n    \nRelation Helpers\n----------------\n\n    aug = do ->\n      fn = (target, action) ->\n        Dup = ->\n        Dup.prototype = target\n        _(new Dup()).tap(action || ->)\n    \n      _(fn).tap (fn) ->\n        fn.extend = (target, props) ->\n          aug target, (augmentedResult) -> _.extend(augmentedResult, props)\n    \n        fn.add = (target, property, values) ->\n          aug target, (augmentedResult) ->\n            augmentedResult[property] = if _.isArray(target[property]) then target[property].concat(values) else values\n    \n        fn.merge = (target, props) ->\n          aug target, (augmentedResult) ->\n            _(props).each (val, key) -> target[key] = _.extend(val, target[key])\n    \nAlias Helper\n------------\n    \n    class Alias\n      constructor: (@attribute) ->\n        @alias = @attribute\n    \n      as: (alias) ->\n        aug.extend(this, {alias})\n    \nExport a simple constructor as `V1.Backbone.alias`\n\n    V1.Backbone.alias = (attribute) -> new Alias(attribute)\n    \nRelation Helper\n---------------\n    \n    class Relation extends Alias\n      constructor: (@attribute) ->\n        super(@attribute)\n        @type = V1.Backbone.Collection\n    \n      isMulti: ->\n        isCollection(@type)\n    \n      isSingle: ->\n        isModel(@type)\n    \n      of: (type) ->\n        throw \"Unsupported type must be a V1.Backbone.Model or a V1.Backbone.Collection\" unless isAcceptable(type)\n        aug.extend(this, {type})\n    \n      addFilter: (filters...) ->\n        aug.add(this, \"filter\", filters)\n    \n      addWhere: (where) ->\n        aug.merge(this, {where})\n    \n      addWith: (newWith) ->\n        aug.merge(this, {newWith})\n    \nExport a simple constructor as `V1.Backbone.relation`    \n    \n    V1.Backbone.relation = (attribute) -> new Relation(attribute)\n","returncode":0,"stderr":"","license":"bsd-3-clause","lang":"Literate CoffeeScript"}
{"commit":"acfe33c35df354945dac248f650337466d7a0c97","subject":"fix issue with method (rpc\/action) binding called as an object property, see yang-swagger issue #5","message":"fix issue with method (rpc\/action) binding called as an object property, see yang-swagger issue #5\n","repos":"corenova\/yang-js","old_file":"src\/method.litcoffee","new_file":"src\/method.litcoffee","new_contents":"# Method - controller of functions\n\n## Class Method\n\n    Property = require('.\/property')\n\n    class Method extends Property\n      logger: require('debug')('yang:method')\n\n      @property 'data',\n        set: (value) -> @set value, { force: true }\n        get: -> switch\n          when @binding? then @do.bind this\n          else @value\n\n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      do: (input={}, opts={}) ->\n        unless (@binding instanceof Function) or (@data instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        @debug \"[do] executing method: #{@name}\"\n        @debug input\n        ctx = @parent?.context ? @context\n        ctx = ctx.with opts, path: @path\n        try\n          # calling context is the parent node of the method\n          input = @schema.input.apply input, this, force: true\n          \n          # first apply schema bound function (if availble), otherwise\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\" if typeof input is 'object'\n            @debug @binding.toString()\n            output = @binding? ctx, input\n          else\n            @debug \"[do] calling assigned function: #{@data.name}\"\n            @debug => @value\n            @debug => @data\n            output = @data.call @parent.data, input, ctx\n\n          output = await output\n          { output } = @schema.output.eval { output }, this, force: true\n          return output\n        catch e\n          @debug e\n          return Promise.reject(e)\n\n      update: (value, opts) ->\n        super value, opts unless value instanceof Property\n\n### toJSON\n\nThis call always returns undefined for the Method node.\n\n      toJSON: (key) ->\n        value = undefined\n        value = \"#{@name}\": value if key is true\n        return value\n\n    module.exports = Method\n","old_contents":"# Method - controller of functions\n\n## Class Method\n\n    Property = require('.\/property')\n\n    class Method extends Property\n      logger: require('debug')('yang:method')\n\n      get: (pattern) -> switch\n        when pattern? then super arguments...\n        when @binding? then @do.bind this\n        else @data\n\n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      do: (input={}, opts={}) ->\n        unless (@binding instanceof Function) or (@data instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        @debug \"[do] executing method: #{@name}\"\n        @debug input\n        ctx = @parent?.context ? @context\n        ctx = ctx.with opts, path: @path\n        try\n          # calling context is the parent node of the method\n          input = @schema.input.apply input, this, force: true\n          \n          # first apply schema bound function (if availble), otherwise\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\" if typeof input is 'object'\n            @debug @binding.toString()\n            output = @binding? ctx, input\n          else\n            @debug \"[do] calling assigned function: #{@data.name}\"\n            @debug => @value\n            @debug => @data\n            output = @data.call @parent.data, input, ctx\n\n          output = await output\n          { output } = @schema.output.eval { output }, this, force: true\n          return output\n        catch e\n          @debug e\n          return Promise.reject(e)\n\n      update: (value, opts) ->\n        super value, opts unless value instanceof Property\n\n### toJSON\n\nThis call always returns undefined for the Method node.\n\n      toJSON: (key) ->\n        value = undefined\n        value = \"#{@name}\": value if key is true\n        return value\n\n    module.exports = Method\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"32e70403f68be2f20521cceb7fd9e9f1259077c6","subject":"Fix for unexpected errors with app.cookies","message":"Fix for unexpected errors with app.cookies\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/app\/index.litcoffee","new_file":"src\/app\/index.litcoffee","new_contents":"# App\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    signal = require 'src\/signal'\n    db = require 'src\/db'\n    assert = require 'src\/assert'\n    Schema = require 'src\/schema'\n    Networking = require 'src\/networking'\n    Document = require 'src\/document'\n    Renderer = require 'src\/renderer'\n    Styles = require 'src\/styles'\n    Resources = require 'src\/resources'\n    Dict = require 'src\/dict'\n\n    AppRoute = require '.\/route'\n\n    if utils.isNode\n        bootstrapRoute = require '.\/bootstrap\/route.node'\n\n    `\/\/<development>`\n    pkg = require 'package.json'\n    `\/\/<\/development>`\n\n    BASE_FILE_NAME_RE = \/(.+)\\.(?:node|server|client|browser|ios|android|native)\/\n    DEFAULT_CONFIG =\n        title: 'Neft.io Application'\n        protocol: 'http'\n        port: 3000\n        host: 'localhost'\n        language: 'en'\n        type: 'app'\n\n    exports = module.exports = (opts = {}, extraOpts = {}) ->\n        # Welcome log also for release mode\n        log.ok \"Welcome! Neft.io v#{pkg.version}; Feedback appreciated\"\n\n        `\/\/<development>`\n        log.warn \"Use this bundle only in development; type --release when it's ready\"\n        `\/\/<\/development>`\n\n        config = utils.clone DEFAULT_CONFIG\n        config = utils.mergeAll config, opts.config, extraOpts\n\n        app = new Dict\n\n## *Object* app.config = `{}`\n\nConfig object from the *package.json* file.\n\nCan be overriden in the *init.js* file.\n\n### type\n\nThe `app` type (the default one) uses renderer on the client side.\n\nThe `game` type uses special renderer (if exists) focused on more performance goals.\n\nThe `text` type always return HTML document with no renderer on the client side.\nIt's used for the crawlers (e.g. GoogleBot) or browsers with no javascript support.\n\n```javascript\n\/\/ package.json\n{\n    \"name\": \"neft.io app\",\n    \"version\": \"0.1.0\",\n    \"config\": {\n        \"title\": \"My first application!\",\n        \"protocol\": \"http\",\n        \"port\": 3000,\n        \"host\": \"localhost\",\n        \"language\": \"en\",\n        \"type\": \"app\"\n    }\n}\n\/\/ init.js\nmodule.exports = function(NeftApp) {\n    var app = NeftApp({ title: \"Overridden title\" });\n    console.log(app.config);\n    \/\/ {title: \"My first application!\", protocol: \"http\", port: ....}\n};\n```\n\n        app.config = config\n\n## *Networking* app.networking\n\nStandard Networking instance used to communicate\nwith the server and to create local requests.\n\nAll routes created by the *App.Route* uses this networking.\n\nHTTP protocol is used by default with the data specified in the *package.json*.\n\n        app.networking = new Networking\n            type: Networking.HTTP\n            protocol: config.protocol\n            port: parseInt(config.port, 10)\n            host: config.host\n            url: config.url\n            language: config.language\n\n## *Object* app.models = `{}`\n\nFiles from the *models* folder with objects returned by their exported functions.\n\n```javascript\n\/\/ models\/user\/permission.js\nmodule.exports = function(app) {\n    return {\n        getPermission: function(id){}\n    };\n};\n\/\/ controllers\/user.js\nmodule.exports = function(app) {\n    return {\n        get: function(req, res, callback) {\n            var data = app.models['user\/permission'].getPermission(req.params.userId);\n            callback(null, data);\n        }\n    }\n};\n```\n\n        app.models = {}\n\n## *Object* app.routes = `{}`\n\nFiles from the *routes* folder with objects returned by their exported functions.\n\n        app.routes = {}\n\n## *Object* app.styles = `{}`\n\nFiles from the *styles* folder as *Function*s\nready to create new *Item*s.\n\n        app.styles = {}\n\n## *Object* app.views = `{}`\n\nFiles from the *views* folder as the *Document* instances.\n\n        app.views = {}\n\n## *Resources* app.resources\n\n        app.resources = do ->\n            if opts.resources\n                Resources.fromJSON(opts.resources)\n            else\n                new Resources\n\n## *Signal* app.onReady()\n\nCalled when all modules, views, styled etc. have been loaded.\n\n        signal.create app, 'onReady'\n\n        # config.type\n        config.type ?= 'app'\n        assert.ok utils.has(['app', 'game', 'text'], config.type), \"Unexpected app.config.type value. Accepted app\/game\/text, but '#{config.type}' got.\"\n\n        app.Route = AppRoute app\n\n## *Dict* app.cookies\n\nOn the client side, this object refers to the last received cookies\nfrom the networking request.\n\nOn the server side, this cookies object are added into the each networking response.\n\nBy default, client has *clientId* and *sessionId* hashes.\n\n```javascript\napp.cookies.onChange(function(key){\n    console.log('cookie changed', key, this[key]);\n});\n```\n\n```xml\n<h1>Your clientId<\/h1>\n<em>${context.app.cookies.clientId}<\/em>\n```\n\n        # cookies\n        COOKIES_KEY = '__neft_cookies'\n        app.cookies = Dict()\n        onCookiesReady = (dict) ->\n            app.cookies = dict\n            if utils.isClient\n                dict.set 'sessionId', utils.uid(16)\n        db.get COOKIES_KEY, db.OBSERVABLE, (err, dict) ->\n            if dict\n                onCookiesReady dict\n            else\n                if utils.isClient\n                    cookies = {clientId: utils.uid(16)}\n                else\n                    cookies = {}\n                db.set COOKIES_KEY, cookies, (err) ->\n                    db.get COOKIES_KEY, db.OBSERVABLE, (err, dict) ->\n                        if dict\n                            onCookiesReady dict\n        app.networking.onRequest (req, res) ->\n            if utils.isClient\n                utils.merge req.cookies, app.cookies\n            else\n                utils.merge res.cookies, app.cookies\n            req.onLoadEnd.listeners.unshift ->\n                if utils.isClient\n                    for key, val of res.cookies\n                        unless utils.isEqual(app.cookies[key], val)\n                            app.cookies.set key, val\n                return\n            , null\n            return\n\n        # propagate data\n        Renderer.resources = app.resources\n        Renderer.serverUrl = app.networking.url\n        Renderer.onLinkUri (uri) ->\n            app.networking.createLocalRequest\n                method: Networking.Request.GET\n                type: Networking.Request.HTML_TYPE\n                uri: uri\n        Document.Scripts.scripts = utils.arrayToObject opts.scripts,\n            (index, elem) -> elem.name,\n            (index, elem) -> elem.file\n\n        # set styles window item\n        if opts.styles?\n            for style in opts.styles\n                if style.name in ['view', '__view__']\n                    style.file._init app: app, view: null\n                    windowStyle = style.file._main.getComponent()\n                    break\n\n        windowStyleItem = windowStyle?.item\n        assert.ok windowStyleItem, '__view__ style must be defined'\n        Renderer.window = windowStyleItem\n\n        if opts.styles?\n            stylesInitObject =\n                app: app\n                view: windowStyleItem\n\n            # initialize styles\n            for style in opts.styles when style.name?\n                if style.name isnt 'view'\n                    style.file._init stylesInitObject\n                app.styles[style.name] = style.file\n\n        # load styles\n        Styles\n            windowStyle: windowStyle\n            styles: app.styles\n            queries: opts.styleQueries\n            resources: app.resources\n\n        # load bootstrap\n        if utils.isNode\n            bootstrapRoute app\n\n        # loading files helper\n        init = (files, target) ->\n            for file in files when file.name?\n                if typeof file.file isnt 'function'\n                    continue\n\n                fileObj = file.file app\n                target[file.name] = fileObj\n\n                if baseNameMatch = BASE_FILE_NAME_RE.exec(file.name)\n                    [_, baseName] = baseNameMatch\n                    if target[baseName]?\n                        if utils.isPlainObject(target[baseName]) and utils.isPlainObject(fileObj)\n                            fileObj = utils.merge Object.create(target[baseName]), fileObj\n                    target[baseName] = fileObj\n\n            return\n\n        # load app extensions\n        if utils.isObject(opts.extensions)\n            for ext in opts.extensions\n                ext app\n\n        # exports app classes\n        exports.app =\n            Route: app.Route\n\n        # load views\n        for view in opts.views when view.name?\n            app.views[view.name] = Document.fromJSON view.file\n\n        # load files\n        init opts.models, app.models\n        init opts.routes, app.routes\n\n        for path, obj of app.routes\n            r = {}\n            if utils.isObject(obj) and not (obj instanceof app.Route)\n                for method, opts of obj\n                    if utils.isObject(opts)\n                        route = new app.Route method, opts\n                        r[route.name] = route\n                    else\n                        r[method] = opts\n            app.routes[path] = r\n\n        # provide default index route\n        unless app.routes.index\n            app.routes.index = new app.Route 'get \/', {}\n\n        # emit ready signal\n        app.onReady.emit()\n\n        app\n","old_contents":"# App\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    signal = require 'src\/signal'\n    db = require 'src\/db'\n    assert = require 'src\/assert'\n    Schema = require 'src\/schema'\n    Networking = require 'src\/networking'\n    Document = require 'src\/document'\n    Renderer = require 'src\/renderer'\n    Styles = require 'src\/styles'\n    Resources = require 'src\/resources'\n    Dict = require 'src\/dict'\n\n    AppRoute = require '.\/route'\n\n    if utils.isNode\n        bootstrapRoute = require '.\/bootstrap\/route.node'\n\n    `\/\/<development>`\n    pkg = require 'package.json'\n    `\/\/<\/development>`\n\n    BASE_FILE_NAME_RE = \/(.+)\\.(?:node|server|client|browser|ios|android|native)\/\n    DEFAULT_CONFIG =\n        title: 'Neft.io Application'\n        protocol: 'http'\n        port: 3000\n        host: 'localhost'\n        language: 'en'\n        type: 'app'\n\n    exports = module.exports = (opts = {}, extraOpts = {}) ->\n        # Welcome log also for release mode\n        log.ok \"Welcome! Neft.io v#{pkg.version}; Feedback appreciated\"\n\n        `\/\/<development>`\n        log.warn \"Use this bundle only in development; type --release when it's ready\"\n        `\/\/<\/development>`\n\n        config = utils.clone DEFAULT_CONFIG\n        config = utils.mergeAll config, opts.config, extraOpts\n\n        app = new Dict\n\n## *Object* app.config = `{}`\n\nConfig object from the *package.json* file.\n\nCan be overriden in the *init.js* file.\n\n### type\n\nThe `app` type (the default one) uses renderer on the client side.\n\nThe `game` type uses special renderer (if exists) focused on more performance goals.\n\nThe `text` type always return HTML document with no renderer on the client side.\nIt's used for the crawlers (e.g. GoogleBot) or browsers with no javascript support.\n\n```javascript\n\/\/ package.json\n{\n    \"name\": \"neft.io app\",\n    \"version\": \"0.1.0\",\n    \"config\": {\n        \"title\": \"My first application!\",\n        \"protocol\": \"http\",\n        \"port\": 3000,\n        \"host\": \"localhost\",\n        \"language\": \"en\",\n        \"type\": \"app\"\n    }\n}\n\/\/ init.js\nmodule.exports = function(NeftApp) {\n    var app = NeftApp({ title: \"Overridden title\" });\n    console.log(app.config);\n    \/\/ {title: \"My first application!\", protocol: \"http\", port: ....}\n};\n```\n\n        app.config = config\n\n## *Networking* app.networking\n\nStandard Networking instance used to communicate\nwith the server and to create local requests.\n\nAll routes created by the *App.Route* uses this networking.\n\nHTTP protocol is used by default with the data specified in the *package.json*.\n\n        app.networking = new Networking\n            type: Networking.HTTP\n            protocol: config.protocol\n            port: parseInt(config.port, 10)\n            host: config.host\n            url: config.url\n            language: config.language\n\n## *Object* app.models = `{}`\n\nFiles from the *models* folder with objects returned by their exported functions.\n\n```javascript\n\/\/ models\/user\/permission.js\nmodule.exports = function(app) {\n    return {\n        getPermission: function(id){}\n    };\n};\n\/\/ controllers\/user.js\nmodule.exports = function(app) {\n    return {\n        get: function(req, res, callback) {\n            var data = app.models['user\/permission'].getPermission(req.params.userId);\n            callback(null, data);\n        }\n    }\n};\n```\n\n        app.models = {}\n\n## *Object* app.routes = `{}`\n\nFiles from the *routes* folder with objects returned by their exported functions.\n\n        app.routes = {}\n\n## *Object* app.styles = `{}`\n\nFiles from the *styles* folder as *Function*s\nready to create new *Item*s.\n\n        app.styles = {}\n\n## *Object* app.views = `{}`\n\nFiles from the *views* folder as the *Document* instances.\n\n        app.views = {}\n\n## *Resources* app.resources\n\n        app.resources = do ->\n            if opts.resources\n                Resources.fromJSON(opts.resources)\n            else\n                new Resources\n\n## *Signal* app.onReady()\n\nCalled when all modules, views, styled etc. have been loaded.\n\n        signal.create app, 'onReady'\n\n        # config.type\n        config.type ?= 'app'\n        assert.ok utils.has(['app', 'game', 'text'], config.type), \"Unexpected app.config.type value. Accepted app\/game\/text, but '#{config.type}' got.\"\n\n        app.Route = AppRoute app\n\n## *Dict* app.cookies\n\nOn the client side, this object refers to the last received cookies\nfrom the networking request.\n\nOn the server side, this cookies object are added into the each networking response.\n\nBy default, client has *clientId* and *sessionId* hashes.\n\n```javascript\napp.cookies.onChange(function(key){\n    console.log('cookie changed', key, this[key]);\n});\n```\n\n```xml\n<h1>Your clientId<\/h1>\n<em>${context.app.cookies.clientId}<\/em>\n```\n\n        # cookies\n        COOKIES_KEY = '__neft_cookies'\n        app.cookies = {}\n        onCookiesReady = (dict) ->\n            app.cookies = dict\n            if utils.isClient\n                dict.set 'sessionId', utils.uid(16)\n        db.get COOKIES_KEY, db.OBSERVABLE, (err, dict) ->\n            if dict\n                onCookiesReady dict\n            else\n                if utils.isClient\n                    cookies = {clientId: utils.uid(16)}\n                else\n                    cookies = {}\n                db.set COOKIES_KEY, cookies, (err) ->\n                    db.get COOKIES_KEY, db.OBSERVABLE, (err, dict) ->\n                        if dict\n                            onCookiesReady dict\n        app.networking.onRequest (req, res) ->\n            if utils.isClient\n                utils.merge req.cookies, app.cookies\n            else\n                utils.merge res.cookies, app.cookies\n            req.onLoadEnd.listeners.unshift ->\n                if utils.isClient\n                    for key, val of res.cookies\n                        unless utils.isEqual(app.cookies[key], val)\n                            app.cookies.set key, val\n                return\n            , null\n            return\n\n        # propagate data\n        Renderer.resources = app.resources\n        Renderer.serverUrl = app.networking.url\n        Renderer.onLinkUri (uri) ->\n            app.networking.createLocalRequest\n                method: Networking.Request.GET\n                type: Networking.Request.HTML_TYPE\n                uri: uri\n        Document.Scripts.scripts = utils.arrayToObject opts.scripts,\n            (index, elem) -> elem.name,\n            (index, elem) -> elem.file\n\n        # set styles window item\n        if opts.styles?\n            for style in opts.styles\n                if style.name in ['view', '__view__']\n                    style.file._init app: app, view: null\n                    windowStyle = style.file._main.getComponent()\n                    break\n\n        windowStyleItem = windowStyle?.item\n        assert.ok windowStyleItem, '__view__ style must be defined'\n        Renderer.window = windowStyleItem\n\n        if opts.styles?\n            stylesInitObject =\n                app: app\n                view: windowStyleItem\n\n            # initialize styles\n            for style in opts.styles when style.name?\n                if style.name isnt 'view'\n                    style.file._init stylesInitObject\n                app.styles[style.name] = style.file\n\n        # load styles\n        Styles\n            windowStyle: windowStyle\n            styles: app.styles\n            queries: opts.styleQueries\n            resources: app.resources\n\n        # load bootstrap\n        if utils.isNode\n            bootstrapRoute app\n\n        # loading files helper\n        init = (files, target) ->\n            for file in files when file.name?\n                if typeof file.file isnt 'function'\n                    continue\n\n                fileObj = file.file app\n                target[file.name] = fileObj\n\n                if baseNameMatch = BASE_FILE_NAME_RE.exec(file.name)\n                    [_, baseName] = baseNameMatch\n                    if target[baseName]?\n                        if utils.isPlainObject(target[baseName]) and utils.isPlainObject(fileObj)\n                            fileObj = utils.merge Object.create(target[baseName]), fileObj\n                    target[baseName] = fileObj\n\n            return\n\n        # load app extensions\n        if utils.isObject(opts.extensions)\n            for ext in opts.extensions\n                ext app\n\n        # exports app classes\n        exports.app =\n            Route: app.Route\n\n        # load views\n        for view in opts.views when view.name?\n            app.views[view.name] = Document.fromJSON view.file\n\n        # load files\n        init opts.models, app.models\n        init opts.routes, app.routes\n\n        for path, obj of app.routes\n            r = {}\n            if utils.isObject(obj) and not (obj instanceof app.Route)\n                for method, opts of obj\n                    if utils.isObject(opts)\n                        route = new app.Route method, opts\n                        r[route.name] = route\n                    else\n                        r[method] = opts\n            app.routes[path] = r\n\n        # provide default index route\n        unless app.routes.index\n            app.routes.index = new app.Route 'get \/', {}\n\n        # emit ready signal\n        app.onReady.emit()\n\n        app\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"f4a3a16c1b2914041992b57871470e13262fd01f","subject":"Improve the documentation in ReactMaybeMatchers","message":"Improve the documentation in ReactMaybeMatchers\n","repos":"ygt-mikekchar\/react-maybe-matchers,ygt-mikekchar\/react-maybe-matchers","old_file":"src\/ReactMaybeMatchers.litcoffee","new_file":"src\/ReactMaybeMatchers.litcoffee","new_contents":"# React Maybe Matchers for Jasmine\n\nTests using the React test utilities directly are both difficult to read\nand inconvenient to type. These matchers are intended to to make it\neasier to write tests and to understand what they are doing later.\n\nOne of the biggest problems with writing Jasmine matchers for React is that\nyou often have to search through Reacts tree to find the things you want\nto test.  In Rspec (in Ruby) you can often chain matchers together to create\ncomplex and readable tests.  Alas, this is not possible for Jasmine.\n\nTo compensate for this we will make a [Maybe monad](monad.md#what-is-a-monad)\nwhich will allow us to chain a series of filters.  People often get flustered\nabout monads, but their use is very straight forward.\n\n## DSL for React tests\n\nThese matchers will allow us to write tests like:\n\n```coffee\n  expect(component).toBeAComponent (which) ->\n    which.contains.tags(\"div\")\n         .with.cssClass(\"my-class\")\n         .and.text(\"contents\")\n         .exactly(2).times\n         .result()\n```\n\nIn the example above, `toBeAComponent` accepts a callback, which it will call,\nfunishing a monad called `which`.  We can then chain a series of tests.\n\nThe chain in this example means that I am expecting my component to contain a DOM `div`\nwith the class `my-css-class`.  This `div` should contain the text, `contents`.\nThere should be exactly 2 such `divs` in my tree.  The `result()` at the\nend simply means, \"I'm done with my testing, please calculate the results\".\n\nThe Maybe monad is a special kind of monad that only processes when\nthe data is valid.  In this case, if there are no `div` elements, then it\nwont bother trying to figure out the cssClass, etc.  It will ignore\neverything until it gets to the `result`.  Its a useful technique when\nyou dont want to constantly check return values for errors.\n\n### Requirements\n\nThe main matcher interface will return a\n[ComponentQuery](.\/ComponentQuery.litcoffee).  This is a\n[JasmineMonad](.\/JasmineMonad.litcoffee)\nthat allows you to take a single React component and make queries\nof it, often generating a [ComponentFilter](.\/ComponentFilter.litcoffee) \nor [DomComponentFilter](.\/DomComponentFilter.litcoffee)\n\n    ComponentQuery = require(\".\/ComponentQuery.litcoffee\")\n\n### Using ReactMaybeMatchers\n\nThe matchers need to use the React test utils in order to\ninspect the React\/DOM tree for components.  `@reactUtils`\nhere is the result of `require(\"react-addons-test-utils\")`\n\n    class ReactMaybeMatchers\n      constructor: (@reactUtils) ->\n\nIn order to use ReactMaybeMatchers, you have to add\nthe matchers to the jasmine instance.\n\n      addTo: (jasmine) ->\n        jasmine.addMatchers(this)\n\nHere is the typical way to set up the matchers in a spec:\n\n```coffee\nReact = require(\"react\")\nReactTestUtils = require('react-addons-test-utils')\nReactMaybeMatchers = require(\"..\/src\/ReactMaybeMatchers.litcoffee\")\n\ndescribe \"some wonderful thing\", ->\n  beforeEach ->\n    new ReactMaybeMatchers(ReactTestUtils).addTo(jasmine)\n```\n\n### Main Matcher Interface\n\nWe actually only require one main method in our matchers interface because\nall of our matchers are actually implemented as methods on our monads.\n\n      # The matcher gets called with a different `this` pointer,\n      # so we need to use a fat arrow here.\n      toBeAComponent: (util, testers) =>\n        compare: (component, func) =>\n          filter = new ComponentQuery(@reactUtils, component, util, testers)\n          func(filter)\n\n### Exported Classes\n\n    module.exports = ReactMaybeMatchers\n","old_contents":"# React Maybe Matchers for Jasmine\n\nTests using the React test utilities directly are both difficult to read\nand inconvenient to type. These matchers are intended to to make it\neasier to write tests and to understand what they are doing later.\n\nOne of the biggest problems with writing Jasmine matchers for React is that\nyou often have to search through Reacts tree to find the things you want\nto test.  In Rspec (in Ruby) you can often chain matchers together to create\ncomplex and readable tests.  Alas, this is not possible for Jasmine.\n\nTo compensate for this we will make a [Maybe monad](monad.md#what-is-a-monad)\nwhich will allow us to chain a series of filters.  People often get flustered\nabout monads, but their use is very straight forward.\n\n## DSL for React tests\n\nThese matchers will allow us to write tests like:\n\n```coffee\n  expect(component).toBeAComponent (which) ->\n    which.contains.tags(\"div\")\n         .with.cssClass(\"my-class\")\n         .and.text(\"contents\")\n         .exactly(2).times\n         .result()\n```\n\nIn the example above, `toBeAComponent` accepts a callback, which it will call,\nfunishing a monad called `which`.  We can then chain a series of tests.\n\nThe chain in this example means that I am expecting my component to contain a DOM `div`\nwith the class `my-css-class`.  This `div` should contain the text, `contents`.\nThere should be exactly 2 such `divs` in my tree.  The `result()` at the\nend simply means, \"I'm done with my testing, please calculate the results\".\n\nThe Maybe monad is a special kind of monad that only processes when\nthe data is valid.  In this case, if there are no `div` elements, then it\nwont bother trying to figure out the cssClass, etc.  It will ignore\neverything until it gets to the `result`.  Its a useful technique when\nyou dont want to constantly check return values for errors.\n\n## Requirements\n\nThe [ComponentQuery](.\/ComponentQuery.litcoffee) is a\n[JasmineMonad](.\/JasmineMonad.litcoffee)\nthat allows you to take a single React component and make queries\nof it, often generating a [ComponentFilter](.\/ComponentFilter.litcoffee). \n\n    ComponentQuery = require(\".\/ComponentQuery.litcoffee\")\n\n### Main matcher interface\n\nWe actually only require one main method in our matchers interface because\nall of our matchers are actually implemented as methods on our monads.\n\n    class ReactMaybeMatchers\n      constructor: (@reactUtils) ->\n\n      addTo: (jasmine) ->\n        jasmine.addMatchers(this)\n\nThe matcher gets called with a different `this` pointer, so we need to use\na fat arrow here.\n\n      toBeAComponent: (util, testers) =>\n        compare: (component, func) =>\n          filter = new ComponentQuery(@reactUtils, component, util, testers)\n          func(filter)\n\nExport our matchers from this file.\n\n    module.exports = ReactMaybeMatchers\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0b791a94139e2fc0b4f684464f4bffd2208f1302","subject":"interpret boxed bound- and fixed-function objects as methods","message":"interpret boxed bound- and fixed-function objects as methods\n","repos":"nickfargo\/restate","old_file":"src\/state-expression.litcoffee","new_file":"src\/state-expression.litcoffee","new_contents":"## [StateExpression](#state-expression)\n\nA **state expression** is a data structure that formalizes a definition of\na state\u2019s contents.\n\nStates are declared by calling the module\u2019s exported `state()` function and\npassing it a descriptive plain object map. This input may be expressed in a\nshorthand format, in which case it is rewritten into an unambiguous long form\nthat is used internally to create `State` instances.\n\n    State::Expression = class StateExpression\n\n      { isNumber, isPlainObject, assign, edit, clone, invert } = O\n      { NORMAL } = STATE_ATTRIBUTES\n\n      attributeMap = do ->\n        for key, value of object = assign STATE_ATTRIBUTE_MODIFIERS\n          object[ key ] = key.toUpperCase()\n        object\n\n      attributeFlags = do ->\n        for key, value of object = invert STATE_ATTRIBUTES\n          object[ key ] = value.toLowerCase()\n        object\n\n      categoryMap  = assign STATE_EXPRESSION_CATEGORIES\n      eventTypes   = assign STATE_EVENT_TYPES\n      guardActions = assign GUARD_ACTIONS\n\n\n### [Constructor](#state-expression--constructor)\n\n      constructor: ( attributes, map ) ->\n        if typeof attributes is 'string' then map or = {}\n        else unless map\n          map = attributes; attributes = undefined\n\n        map = interpret map unless map instanceof StateExpression\n        edit 'deep all', this, map\n\n        if attributes?\n          attributes = encodeAttributes attributes unless isNumber attributes\n        else { attributes } = map if map\n\n        @attributes = attributes or NORMAL\n\n\n\n### [Private functions](#state-expression--private)\n\n\n#### [interpret](#state-expression--private--interpret)\n\nTransforms a plain object map into a well-formed `StateExpression`, making the\nappropriate type inferences for any shorthand notation encountered.\n\n      interpret = ( map ) ->\n\nStart with a null-valued map keyed with the category names.\n\n        result = assign STATE_EXPRESSION_CATEGORIES, null\n\n        for own key, value of map\n\nIf `value` is just a reference to the exported `state` function, interpret that\nas an empty state expression.\n\n          value = new StateExpression if value is state\n\n###### Categorization\n\n**Priority 1:** Do a nominative type match for explicit expression instances.\n\n          category =\n            if value instanceof StateExpression then 'states'\n            else if value instanceof TransitionExpression then 'transitions'\n          if category\n            item = result[ category ] or = {}\n            item[ key ] = value\n\n**Priority 2:** Recognize an explicitly named category object.\n\n          else if key of result and value\n            result[ key ] = clone result[ key ], value\n\n**Priority 3:** Use keys and value types to infer implicit categorization.\n\n          else\n            category =\n              if key of eventTypes or typeof value is 'string'\n                'events'\n              else if key of guardActions\n                'guards'\n              else if typeof value is 'function' or ( type = value?.type ) and\n                  ( type is 'state-bound-function' or\n                    type is 'state-fixed-function' )\n                'methods'\n              else if value is NIL or isPlainObject value\n                'states'\n            if category\n              item = result[ category ] or = {}\n              item[ key ] = value\n\n###### Coersion\n\nEvent values are coerced into an array.\n\n        for own key, value of object = result.events\n          if typeof value is 'function' or typeof value is 'string'\n            object[ key ] = [ value ]\n\nGuards are represented as an object keyed by selector, so non-object values are\ncoerced into a single-element object with the value keyed to the wildcard\nselector `*`.\n\n        for own key, value of object = result.guards\n          object[ key ] = '*': value unless isPlainObject value\n\nTransition values must be a `TransitionExpression`.\n\n        for own key, value of object = result.transitions\n          unless value is NIL or value instanceof TransitionExpression\n            object[ key ] = new TransitionExpression value\n\nState values must resolve to a `StateExpression`. They may be supplied as a\nplain object, or as a live `State` instance, which is automatically `express`ed\nto a formal `StateExpression`.\n\n        for own key, value of object = result.states\n          if value instanceof State\n            object[ key ] = value.express true\n          else unless value is NIL or value instanceof StateExpression\n            object[ key ] = new StateExpression value\n\n        result\n\n\n\n### [Class methods](#state-expression--class-methods)\n\n\n#### [encodeAttributes](#state-expression--class--encode-attributes)\n\nReturns the bit-field integer represented by the provided set of `attributes`.\n\n      @encodeAttributes = encodeAttributes = ( attributes ) ->\n        attributes = assign attributes if typeof attributes is 'string'\n        result = NORMAL\n        for own key, value of attributes when key of attributeMap\n          result |= STATE_ATTRIBUTES[ attributeMap[ key ] ]\n        result\n\n\n#### [decodeAttributes](#state-expression--class--decode-attributes)\n\nReturns the space-delimited set of attribute names represented by the provided\nbit-field integer `number`.\n\n      @decodeAttributes = decodeAttributes = ( number ) ->\n        ( value for key, value of attributeFlags when number & key ).join ' '\n\n\n#### [untype](#state-expression--class-methods--untype)\n\nReturns the `StateExpression` provided by `expr` as a plain-`Object`.\n\n      @untype = untype = ( expr ) ->\n        result = {}\n        result[ key ] = value for own key, value of expr\n        s[ name ] = untype subexpr for name, subexpr of s = result.states\n        result\n\n","old_contents":"## [StateExpression](#state-expression)\n\nA **state expression** is a data structure that formalizes a definition of\na state\u2019s contents.\n\nStates are declared by calling the module\u2019s exported `state()` function and\npassing it a descriptive plain object map. This input may be expressed in a\nshorthand format, in which case it is rewritten into an unambiguous long form\nthat is used internally to create `State` instances.\n\n    State::Expression = class StateExpression\n\n      { isNumber, isPlainObject, assign, edit, clone, invert } = O\n      { NORMAL } = STATE_ATTRIBUTES\n\n      attributeMap = do ->\n        for key, value of object = assign STATE_ATTRIBUTE_MODIFIERS\n          object[ key ] = key.toUpperCase()\n        object\n\n      attributeFlags = do ->\n        for key, value of object = invert STATE_ATTRIBUTES\n          object[ key ] = value.toLowerCase()\n        object\n\n      categoryMap  = assign STATE_EXPRESSION_CATEGORIES\n      eventTypes   = assign STATE_EVENT_TYPES\n      guardActions = assign GUARD_ACTIONS\n\n\n### [Constructor](#state-expression--constructor)\n\n      constructor: ( attributes, map ) ->\n        if typeof attributes is 'string' then map or = {}\n        else unless map\n          map = attributes; attributes = undefined\n\n        map = interpret map unless map instanceof StateExpression\n        edit 'deep all', this, map\n\n        if attributes?\n          attributes = encodeAttributes attributes unless isNumber attributes\n        else { attributes } = map if map\n\n        @attributes = attributes or NORMAL\n\n\n\n### [Private functions](#state-expression--private)\n\n\n#### [interpret](#state-expression--private--interpret)\n\nTransforms a plain object map into a well-formed `StateExpression`, making the\nappropriate type inferences for any shorthand notation encountered.\n\n      interpret = ( map ) ->\n\nStart with a null-valued map keyed with the category names.\n\n        result = assign STATE_EXPRESSION_CATEGORIES, null\n\n        for own key, value of map\n\nIf `value` is just a reference to the exported `state` function, interpret that\nas an empty state expression.\n\n          value = new StateExpression if value is state\n\n###### Categorization\n\n**Priority 1:** Do a nominative type match for explicit expression instances.\n\n          category =\n            if value instanceof StateExpression then 'states'\n            else if value instanceof TransitionExpression then 'transitions'\n          if category\n            item = result[ category ] or = {}\n            item[ key ] = value\n\n**Priority 2:** Recognize an explicitly named category object.\n\n          else if key of result and value\n            result[ key ] = clone result[ key ], value\n\n**Priority 3:** Use keys and value types to infer implicit categorization.\n\n          else\n            category =\n              if key of eventTypes or typeof value is 'string'\n                'events'\n              else if key of guardActions\n                'guards'\n              else if value is NIL or isPlainObject value\n                'states'\n              else if typeof value is 'function'\n                'methods'\n            if category\n              item = result[ category ] or = {}\n              item[ key ] = value\n\n###### Coersion\n\nEvent values are coerced into an array.\n\n        for own key, value of object = result.events\n          if typeof value is 'function' or typeof value is 'string'\n            object[ key ] = [ value ]\n\nGuards are represented as an object keyed by selector, so non-object values are\ncoerced into a single-element object with the value keyed to the wildcard\nselector `*`.\n\n        for own key, value of object = result.guards\n          object[ key ] = '*': value unless isPlainObject value\n\nTransition values must be a `TransitionExpression`.\n\n        for own key, value of object = result.transitions\n          unless value is NIL or value instanceof TransitionExpression\n            object[ key ] = new TransitionExpression value\n\nState values must resolve to a `StateExpression`. They may be supplied as a\nplain object, or as a live `State` instance, which is automatically `express`ed\nto a formal `StateExpression`.\n\n        for own key, value of object = result.states\n          if value instanceof State\n            object[ key ] = value.express true\n          else unless value is NIL or value instanceof StateExpression\n            object[ key ] = new StateExpression value\n\n        result\n\n\n\n### [Class methods](#state-expression--class-methods)\n\n\n#### [encodeAttributes](#state-expression--class--encode-attributes)\n\nReturns the bit-field integer represented by the provided set of `attributes`.\n\n      @encodeAttributes = encodeAttributes = ( attributes ) ->\n        attributes = assign attributes if typeof attributes is 'string'\n        result = NORMAL\n        for own key, value of attributes when key of attributeMap\n          result |= STATE_ATTRIBUTES[ attributeMap[ key ] ]\n        result\n\n\n#### [decodeAttributes](#state-expression--class--decode-attributes)\n\nReturns the space-delimited set of attribute names represented by the provided\nbit-field integer `number`.\n\n      @decodeAttributes = decodeAttributes = ( number ) ->\n        ( value for key, value of attributeFlags when number & key ).join ' '\n\n\n#### [untype](#state-expression--class-methods--untype)\n\nReturns the `StateExpression` provided by `expr` as a plain-`Object`.\n\n      @untype = untype = ( expr ) ->\n        result = {}\n        result[ key ] = value for own key, value of expr\n        s[ name ] = untype subexpr for name, subexpr of s = result.states\n        result\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a1fd05da12b78ff977c96ca6215b4cd2923d8d67","subject":"Fix server on non Posix OS","message":"Fix server on non Posix OS\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nInitialize sane values.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\nInstance of express.\n\n\t\tapp: null\n\nInstance of http\n\n\t\tserver: null\n\nInstance of socket.io\n\n\t\tio: null\n\nStatistics for the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting nodePush'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing outbound socket'\n\nStart HTTP service.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\tlistenCallback = =>\n\nShed root privilegies.\n\n\t\t\t\tif process.getuid? and (process.getuid() is 0 or process.getgid() is 0)\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\t\t\t\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\t\t\t\t\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\treturn unless \/[a-zA-Z0-9-_.]+$\/.test name\n\t\t\t\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\nPass data to the browsers and close connection.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nKill connection after 5 seconds.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket if not config.inbound.useTCP and fs.existsSync config.inbound.socket\n\t\t\tfs.unlinkSync config.outbound.socket if not config.outbound.useTCP and fs.existsSync config.outbound.socket\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","old_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nInitialize sane values.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\nInstance of express.\n\n\t\tapp: null\n\nInstance of http\n\n\t\tserver: null\n\nInstance of socket.io\n\n\t\tio: null\n\nStatistics for the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting nodePush'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing outbound socket'\n\nStart HTTP service.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\tlistenCallback = =>\n\nShed root privilegies.\n\n\t\t\t\tif process.getuid() is 0 or process.getgid() is 0\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\t\t\t\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\t\t\t\t\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\treturn unless \/[a-zA-Z0-9-_.]+$\/.test name\n\t\t\t\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\nPass data to the browsers and close connection.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nKill connection after 5 seconds.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket if not config.inbound.useTCP and fs.existsSync config.inbound.socket\n\t\t\tfs.unlinkSync config.outbound.socket if not config.outbound.useTCP and fs.existsSync config.outbound.socket\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"69c8a93a6271a36088bebd23aea05790568aef0b","subject":"worker port transferList fix","message":"worker port transferList fix\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        if self.port.onerror?\n         self.port.onerror e\n        else\n         throw e\n      , 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      dd = data.data\n      if dd? and dd._transferList?\n       transferList = dd._transferList\n       delete dd._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n\n     _respond: (data, options, callback) ->\n      dd = data.data\n      if dd? and dd._transferList?\n       transferList = dd._transferList\n       delete dd._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) =>\n       try\n        callbacks.fail? e\n       catch err\n        @onerror? err\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        if self.port.onerror?\n         self.port.onerror e\n        else\n         throw e\n      , 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      if data._transferList?\n       transferList = data._transferList\n       delete data._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n\n     _respond: (data, options, callback) ->\n      if data._transferList?\n       transferList = data._transferList\n       delete data._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) =>\n       try\n        callbacks.fail? e\n       catch err\n        @onerror? err\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7f94fc21fd25c5f772233903503f0b8d903b31c4","subject":"Dissable geospatial query sort","message":"Dissable geospatial query sort\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nSet limit, skip and, sort options for documents to be returned.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\n      cursor = req.db.col.find(req.db.query, fields, options)\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower.\n\n      if typeof req.query.sort is 'string' and req.query.sort\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\nOnly apply default sort if there are no geospatial queries.\n\n      else\n        sort = 'endret' if not req.db.query.geojson\n\n### Execute\n\nSet limit, skip and, sort options for documents to be returned.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\n      cursor = req.db.col.find(req.db.query, fields, options)\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5f0df622fd70bfd66a4ab3dc40c4209033da7c22","subject":"simplify in logic","message":"simplify in logic\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"client\/views\/pages\/home.litcoffee","new_file":"client\/views\/pages\/home.litcoffee","new_contents":"Autoform callback hooks\n\n    updateClock = (timeCurrentTicketExpires) ->\n      clock = ($ '.countdown-clock').FlipClock\n        autoStart: yes\n        countdown: yes\n        clockFace: 'MinuteCounter'\n      time = Math.round (timeCurrentTicketExpires - new Date()) \/ 1000\n      time = 0 if time < 0\n      clock.setTime time\n      clock.start() if time > 0\n\n    Template.home.helpers\n      lineLength: ->\n        lineLength = this.queueMeta.nextTicketNumber - this.queueMeta.currentlyServingTicketNumber - 1\n        lineLength = 0 if lineLength < 0\n        return lineLength\n      queueEntry: ->\n        Session.get 'queueEntry'\n      totalWaitTime: ->\n        minutes = (this.queueMeta.totalWaitTimeSeconds \/ 60).toFixed 2\n        \"#{minutes} minutes\"\n      nameAllowedIn: ->\n        return this.queueMeta?.theOnlyConnectionAllowedIn?.name\n      isBeingServed: ->\n        queueEntry = Session.get 'queueEntry'\n        return if not queueEntry?\n\nGet new gifUrl\n\n        Session.set 'gifUrl',\"http:\/\/thecatapi.com\/api\/images\/get?format=src&type=jpg&size=med&time=#{new Date().getTime()}\"\n\nClear queueEntry if queueMeta.currentlyServingTicketNumber is > queueEntry.ticketNumber\n\n        if this.queueMeta.currentlyServingTicketNumber > queueEntry.ticketNumber\n          Session.set 'queueEntry', null\n\n        result = this.queueMeta.currentlyServingTicketNumber is queueEntry.ticketNumber\n\n    Template.home.events\n      'click .queueInLine': (event) ->\n\nReturn immediatly if the user is already queued. More logic on the server, but\nthis will help.\n\n        return if (Session.get 'queueEntry')?\n\nCall the meteor method to get queued.\n\n        Meteor.call 'getInQueue', 'fakeName', (error, result) ->\n          if error?\n            console.log err\n          else\n            Session.set 'queueEntry', result\n\n      'click .submit-feedback': (event) ->\n        console.log 'clicked!'\n        $('#feedbackModal').modal 'hide'\n\n    Template.home.rendered = ->\n      Tracker.autorun ->\n        updateClock QueueMeta.findOne()?.timeCurrentTicketExpires\n","old_contents":"Autoform callback hooks\n\n    updateClock = (timeCurrentTicketExpires) ->\n      clock = ($ '.countdown-clock').FlipClock\n        autoStart: yes\n        countdown: yes\n        clockFace: 'MinuteCounter'\n      time = Math.round (timeCurrentTicketExpires - new Date()) \/ 1000\n      time = 0 if time < 0\n      clock.setTime time\n      clock.start() if time > 0\n\n    Template.home.helpers\n      lineLength: ->\n        lineLength = this.queueMeta.nextTicketNumber - this.queueMeta.currentlyServingTicketNumber - 1\n        lineLength = 0 if lineLength < 0\n        return lineLength\n      queueEntry: ->\n        Session.get 'queueEntry'\n      totalWaitTime: ->\n        minutes = (this.queueMeta.totalWaitTimeSeconds \/ 60).toFixed 2\n        \"#{minutes} minutes\"\n      nameAllowedIn: ->\n        return this.queueMeta?.theOnlyConnectionAllowedIn?.name\n      isBeingServed: ->\n        queueEntry = Session.get 'queueEntry'\n        return if not queueEntry?\n\nGet new gifUrl\n\n        Session.set 'gifUrl',\"http:\/\/thecatapi.com\/api\/images\/get?format=src&type=jpg&size=med&time=#{new Date().getTime()}\"\n\nClear queueEntry if queueMeta.currentlyServingTicketNumber is > queueEntry.ticketNumber\n\n        if this.queueMeta.currentlyServingTicketNumber > queueEntry.ticketNumber\n          Session.set 'queueEntry', null\n\n        this.queueMeta.currentlyServingTicketNumber is queueEntry.ticketNumber and\n          this.queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n\n    Template.home.events\n      'click .queueInLine': (event) ->\n\nReturn immediatly if the user is already queued. More logic on the server, but\nthis will help.\n\n        return if (Session.get 'queueEntry')?\n\nCall the meteor method to get queued.\n\n        Meteor.call 'getInQueue', 'fakeName', (error, result) ->\n          if error?\n            console.log err\n          else\n            Session.set 'queueEntry', result\n\n      'click .submit-feedback': (event) ->\n        console.log 'clicked!'\n        $('#feedbackModal').modal 'hide'\n\n    Template.home.rendered = ->\n      Tracker.autorun ->\n        updateClock QueueMeta.findOne()?.timeCurrentTicketExpires\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1b84a21b9b2d8082460dff60d41449634708b4ca","subject":"Remove redundant variable assignment","message":"Remove redundant variable assignment\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nMake new cursor object with the correct query, fields, and other options (limit,\nskip, and sort).\n\n      cursor = req.db.col.find req.db.query, fields,\n        limit: Math.min (parseInt(req.query.limit, 10) or 20), 50\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min(cursor.cmd.limit, Math.max(total - cursor.cmd.skip, 0))\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nSet limit, skip and, sort options for documents to be returned.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\n      cursor = req.db.col.find(req.db.query, fields, options)\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2e107724f6833cc6b104a7aa8cd9ff16775a7fd8","subject":"Rearrange exports","message":"Rearrange exports\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/cache.litcoffee","new_file":"coffee\/cache.litcoffee","new_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### Todo\n\n* [ ] Handle undefined values (@starefossen)\n\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      set       : set\n      get       : get\n      getDoc    : getDoc\n      setForType: setForType\n      getFilter : getFilter\n      filterData: filterData\n      getForType: getForType\n\n","old_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### Todo\n\n* [ ] Handle undefined values (@starefossen)\n\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      getFilter : getFilter\n      filterData: filterData\n      getDoc    : getDoc\n      set       : set\n      get       : get\n      setForType: setForType\n      getForType: getForType\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9daada3777c2becc191772313b7ab1492b51a175","subject":"style and typos, mostly","message":"style and typos, mostly\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/12_storage_adapters.litcoffee","new_file":"docs\/12_storage_adapters.litcoffee","new_contents":"# Batman.StorageAdapter\n\n`Batman.StorageAdapter`s handle persistence of [`Batman.Model`s](\/docs\/api\/batman.model.html). Any `Batman.Model` which will be created, read, updated or deleted must have a storage adapter, which is declared with [`Batman.Model@persist`](\/docs\/api\/batman.model.html#class_function_persist):\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @persist Batman.RestStorage # a StorageAdapter subclass\n```\n\n__Protip:__ Consider setting the storage adapter in one `Batman.Model` subclass, then extending that subclass in the rest of your app. Then, you won't have to call `@persist` every time:\n\n```coffeescript\nclass App.Model extends Batman.Model\n  @persist Batman.LocalStorage\n\nclass App.Superhero extends App.Model\n  # no need to call @persist here!\n\nclass App.Sidekick extends App.Model\n  # or here!\n```\n\n### Batman's Included StorageAdapters\n\nBatman ships with a few storage adapters to get you up and coding quickly:\n\n- `Batman.LocalStorage` uses [`window.localStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#localStorage) to persist records.\n- `Batman.SessionStorage` extends `Batman.LocalStorage` and uses [`window.sessionStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#sessionStorage) to persist records.\n- `Batman.RestStorage` uses [HTTP REST](http:\/\/en.wikipedia.org\/wiki\/REST) to persist records, mapping HTTP verbs to storage operations and handling HTTP response codes appropriately. _Note: Because `Batman.RestStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\n### Batman.RailsStorage\nAlso, `Batman.RailsStorage` (available in separate file: [Coffee](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.rails.coffee), JS) extends `Batman.RestStorage` and provides some helpful Rails integrations:\n\n- If the response's status code is 422 (`Unprocessable Entity`), Any `errors` defined in the JSON response will be added to the `Batman.Model`'s [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n- By default, Batman will get the Rails CSRF token from the `<head>`and send it as a request header. (This can be prevented by setting `Batman.config.protectFromCSRF = false`.)\n- If a record's URL doesn't end in `.json` and doesn't include a query string, `.json` is automatically appended to the URL.\n\n\n_Note: Like `Batman.RestStorage`, `Batman.RailsStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), so you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\nIf you're using Batman and Rails, be sure to check out the [batman-rails](https:\/\/github.com\/batmanjs\/batman-rails) gem.\n\n## Subclassing Batman.StorageAdapter\n\nYou may want to customize Batman's storage operations for your own app, for example:\n\n- Adding before- and after-operation callbacks\n- Overriding default storage operations\n\nTo do this, extend `Batman.StorageAdapter` (or one of the provided subclasses), then use your storage adapter to persist your models.\n```\nclass App.HeroicStorageAdapter extends Batman.LocalStorage\n  # filters, overrides\n\nclass App.Superhero extends Batman.Model\n  @persist App.HeroicStorageAdapter\n```\n### `env` and `next`\n\nStorage operations and callbacks each take two arguments: `env` and `next`.\n\n`env` is a vanilla JS object which is passed to each function in the chain. `Batman.StorageAdapter` sets these attributes on `env`:\n\n- `env.subject` is the `Batman.Model` record which had the storage operation called on it.\n- `env.options` contains the options passed to the operation on the subject.\n- `env.action` is the storage operation that will be executed by the storage adapter.\n- `env.error` stores any errors that occur during the chain. It becomes the first argument to the operation callback.\n- `env.result` contains the record(s) returned by the operation and should be set by the storage adapter implementation. It becomes the second argument to the operation's callback.\n\nStorage adapters may use `env` to collect any extra information needed by their operations. For example, `Batman.RestStorage` adds some attributes to `env` and `env.options`:\n\n- `env.request` is the `Batman.Request` which implements the storage operation.\n- `env.options.method` is the HTTP method used by `Batman.Request` to implement the storage operation.\n- `env.options.url` is the URL used by `Batman.Request` to implement the storage operation.\n\n`next` is a reference to the next function in the call chain for the current storage operation. `Batman.StorageAdapter` uses this to execute before-filters, storage operations and after-filters in the correct sequence.\n\n\n`next` should be called (`next()`) when the current function has completed. This indicates that the operation should proceed with the next function in its call chain. To ensure the completion of the call chain, consider wrapping your function in [`@nextIfError`](\/docs\/api\/batman.storageadapter.html#class_function_nextiferror).\n\n\n### Adding Callbacks\n\nCallbacks can be registered with [`before`](\/docs\/api\/batman.storageadapter.html#prototype_function_before) and [`after`](\/docs\/api\/batman.storageadapter.html#prototype_function_after) on any storage operation (listed below) or `'all'` (which runs the callback before or after any operation). Callbacks accept two arguments, `env` and `next`, discussed below.\n\n```coffeescript\nclass App.SpecificHeaderStorageAdapter extends Batman.RestStorage\n  # include a specific header in all requests:\n  @::before 'all', (env, next) ->\n    headers = env.options.headers || {}\n    headers[\"App-Specific-Header\"] = App.getSpecificHeader()\n    next()\n\n  @::after 'create', (env, next) ->\n    console.log \"A #{env.subject.constructor.name} was created!\"\n    next()\n```\n\n## Storage Operations\n\nAny `StorageAdapter` must implement these operations as instance methods, for example:\n\n\n```\nclass App.ModifiedStorageAdapter extends Batman.RestStorage\n  destroy: (env, next) ->\n    # your custom destroy operation\n    next()\n```\n\nWhen a record is saved, destroyed or loaded, `Batman.StorageAdapter` invokes these methods. Although you may reimplement them, you probably don't need to call them in your application code.\n\n## ::create(env : Object, next : Function)\nCalled to save a new record. When `save` is called on a record and `isNew` returns `true`, the storage adapter's `create` method is called.\n\n## ::read(env : Object, next : Function)\nCalled to load a record from storage.\n\n## ::update(env : Object, next : Function)\nCalled to update an existing record. When `save` is called on a record and `isNew` returns `false`, the storage adapter's `update` method is called.\n\n## ::destroy(env : Object, next : Function)\nCalled to destroy an existing record.\n\n## ::readAll(env : Object, next : Function)\nCalled to load all records of a particular type from storage.\n\n## Other Useful Methods\n\n## @nextIfError(wrappedFunction : Function )\n\nWraps a function, bypassing the function body and calling next() if an error has already occurred.\n\n    test \"StorageAdapter@skipIfError doesn't call the function if env.error?\", ->\n      insideFunction = createSpy()\n      nextFunction = createSpy()\n\n      functionWithWrapper = Batman.LocalStorage.skipIfError (env, next) ->\n        insideFunction()\n\n      dummyEnv = {error: true}\n\n      functionWithWrapper(dummyEnv, nextFunction)\n\n      equal dummyEnv.error?, true, 'an error is present'\n      equal insideFunction.called, false, 'insideFunction was skipped'\n      equal nextFunction.called, true, 'nextFunction was called'\n\nInside a storage adapter definition, this function is referenced as `@skipIfError`, for example:\n\n```\nclass App.SpecialStorageAdapter extends Batman.RestStorage\n  @::before 'create', @skipIfError (env, next) ->\n    console.log(\"This will be skipped if env.error? is true!\")\n    next()\n```\n\n## ::before (keys... : Strings, filter : Function)\nRegisters `filter` as a before-operation callback for the storage operations named by `keys...`.\n\n## ::after (keys... : Strings, filter : Function)\nRegisters `filter` as a after-operation callback for the storage operations named by `keys...`.\n","old_contents":"# Batman.StorageAdapter\n\n`Batman.StorageAdapter`s handle persistence of [`Batman.Model`s](\/docs\/api\/batman.model.html). Any `Batman.Model` which will be created, read, updated or deleted must have a storage adapter, which is declared with [`Batman.Model@persist`](\/docs\/api\/batman.model.html#class_function_persist):\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @persist Batman.RestStorage # a StorageAdapter subclass\n```\n\n__Protip:__ Consider setting the storage adapter in one `Batman.Model` subclass, then extending that subclass in the rest of your app. Then, you won't have to call `@persist` every time:\n\n```coffeescript\nclass App.Model extends Batman.Model\n  @persist Batman.LocalStorage\n\nclass App.Superhero extends App.Model\n  # no need to call @persist here!\n\nclass App.Sidekick extends App.Model\n  # or here!\n```\n\n### Batman's Included StorageAdapters\n\nBatman ships with a few storage adapters to get you up and coding quickly:\n\n- `Batman.LocalStorage` uses [`window.localStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#localStorage) to persist records.\n- `Batman.SessionStorage` extends `Batman.LocalStorage` and uses [`window.sessionStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#sessionStorage) to persist records.\n- `Batman.RestStorage` uses [HTTP REST](http:\/\/en.wikipedia.org\/wiki\/REST) to persist records, mapping HTTP verbs to storage operations and handling HTTP response codes appropriately. _Note: Because `Batman.RestStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implmentation_libraries) to implement `Batman.Request`._\n\n### Batman.RailsStorage\nAlso, `Batman.RailsStorage` (available in separate file: [Coffee](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.rails.coffee), JS) extends `Batman.RestStorage` and provides some helpful Rails integrations:\n\n- If the response's status code is 422 (`Unprocessable Entity`), Any `errors` defined in the JSON response will be added to the `Batman.Model`'s [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n- By default, Batman will get the Rails CSRF token from the `<head>`and send it as a request header. (This can be prevented by setting `Batman.config.protectFromCSRF = false`.)\n- If a record's URL doesn't end in `.json` and doesn't include a query string, `.json` is automatically appended to the URL.\n\n\n_Note: Like `Batman.RestStorage`, `Batman.RailsStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), so you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implmentation_libraries) to implement `Batman.Request`._\n\nIf you're using Batman and Rails, be sure to check out the [batman-rails](https:\/\/github.com\/batmanjs\/batman-rails) gem.\n\n## Subclassing Batman.StorageAdapter\n\nYou may want to customize Batman's storage operations for your own app, for example:\n\n- Adding before- and after-operation callbacks\n- Overriding default storage operations\n\nTo do this, extend `Batman.StorageAdapter` (or one of the provided subclasses), then use your storage adapter to persist your models.\n```\nclass App.HeroicStorageAdapter extends Batman.LocalStorage\n  # filters, overrides\n\nclass App.Superhero extends Batman.Model\n  @persist App.HeroicStorageAdapter\n```\n### `env` and `next`\n\nStorage operations and callbacks each take two arguments: `env` and `next`.\n\n`env` is a vanilla JS object which is passed to each function in the chain. `Batman.StorageAdapter` sets these attributes on `env`:\n\n- `env.subject` is the `Batman.Model` record which had the storage operation called on it.\n- `env.options` is an object containing the options passed when the operations was called on the subject.\n- `env.action` is the storage operation that will be executed by the storage adapter.\n- `env.error` stores any errors that occur during the chain. It becomes the first argument to them model's callback.\n- `env.result` must be set by the `Batman.StorageAdapter` subclass after the operation is complete. It is a copy of the record and it becomes the second argument to the model's callback.\n\nStorage adapters may use `env` to gather information and use it in its operations. For example, `Batman.RestStorage` adds some attributes to `env` and `env.options`:\n\n- `env.request` is the `Batman.Request` which implements the storage operation.\n- `env.options.method` is the HTTP method used by `Batman.Request` to implement the storage operation.\n- `env.options.url` is the URL used by `Batman.Request` to implement the storage operation.\n\n`next` is a reference to the next operation in the call chain. Any operation must call `next()`, otherwise the call chain will not continue. To ensure the completion of the call chain, consider wrapping your function in [`@nextIfError`](\/docs\/api\/batman.storageadapter.html#class_function_nextiferror).\n\n\n### Adding Callbacks\n\nCallbacks can be registered with [`before`](\/docs\/api\/batman.storageadapter.html#prototype_function_before) and [`after`](\/docs\/api\/batman.storageadapter.html#prototype_function_after) on any storage operation (listed below) or `'all'` (which runs the callback before or after any operation). Callbacks accept two arguments, `env` and `next`, discussed below.\n\n```coffeescript\nclass App.SpecificHeaderStorageAdapter extends Batman.RestStorage\n  # include a specific header in all requests:\n  @::before 'all', (env, next) ->\n    headers = env.options.headers || {}\n    headers[\"App-Specific-Header\"] = App.getSpecificHeader()\n    next()\n\n  @::after 'create', (env, next) ->\n    console.log \"A #{env.subject.constructor.name} was created!\"\n    next()\n```\n\n### Storage Operations\n\nAny `StorageAdapter` must implement these operations as instance methods, for example:\n```\nclass App.ModifiedStorageAdapter extends Batman.RestStorage\n  destroy: (env, next) ->\n    # your custom destroy operation\n    next()\n```\n\n## ::create(env : Object, next : Function)\n\nSaves a new record. When `save` is called on a record and `isNew` returns `true`, the storage adapter's `create` method is called.\n\n## ::read(env : Object, next : Function)\n\nLoads a record from storage into a Batman app.\n\n## ::update(env : Object, next : Function)\n\nUpdates an existing record. When `save` is called on a record and `isNew` returns `false`, the storage adapter's `save` method is called.\n\n## ::destroy(env : Object, next : Function)\n\nDestroys an existing record.\n\n## ::readAll(env : Object, next : Function)\n\nLoads all instances of a `Batman.Model` from storage into memory.\n\n### Other Useful Methods\n\n## @nextIfError(wrappedFunction : Function )\n\nWraps functions in the call chain, bypassing the function body and calling `next()` if `env.error?`\nOtherwise, calls the wrapped function with `env` and `next`.\n\n    test \"StorageAdapter@skipIfError doesn't call the function if env.error?\", ->\n      insideFunction = createSpy()\n      nextFunction = createSpy()\n\n      functionWithWrapper = Batman.LocalStorage.skipIfError (env, next) ->\n        insideFunction()\n\n      dummyEnv = {error: true}\n\n      functionWithWrapper(dummyEnv, nextFunction)\n\n      equal dummyEnv.error?, true, 'an error is present'\n      equal insideFunction.called, false, 'insideFunction was skipped'\n      equal nextFunction.called, true, 'nextFunction was called'\n\nInside a storage adapter definition, this function is referenced as `@skipIfError`, for example:\n\n```\nclass App.SpecialStorageAdapter extends Batman.RestStorage\n  @::before 'create', @skipIfError (env, next) ->\n    console.log(\"This will be skipped if env.error? is true!\")\n    next()\n```\n\n## ::before (keys... : Strings, filter : Function)\n\nRegisters `filter` as a before-operation callback for the storage operations named by `keys...`.\n\n## ::after (keys... : Strings, filter : Function)\n\nRegisters `filter` as a after-operation callback for the storage operations named by `keys...`.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"80106ef8ef4e5e827fb45df1f4a8e7aa976e0963","subject":"properly clear element cache","message":"properly clear element cache\n","repos":"corenova\/yang-js","old_file":"src\/element.litcoffee","new_file":"src\/element.litcoffee","new_contents":"# Element - cascading element tree\n\n## Class Element\n\n    debug = require('debug')('yang:element')\n    delegate = require 'delegates'\n    Emitter = require('events').EventEmitter\n    Emitter.defaultMaxListeners = 100\n\n    kIndex = Symbol.for('element:index');\n    kCache = Symbol.for('element:cache');\n    \n    class Element\n      \n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n        \n      @use: ->\n        res = [].concat(arguments...)\n          .filter (x) -> x?\n          .map (elem) =>\n            exists = Element::match.call this, elem.kind, elem.tag\n            if exists?\n              debug \"use: using previously loaded '#{elem.kind}:#{elem.tag}'\"\n              return exists\n            try Element::merge.call this, elem\n            catch e\n              throw @error \"use: unable to merge '#{elem.kind}:#{elem.tag}'\", e\n        return switch \n          when res.length > 1  then res\n          when res.length is 1 then res[0]\n          else undefined\n            \n      @debug: -> debug @uri, arguments...\n      \n      @error: (err, ctx=this) ->\n        err = new Error err unless err instanceof Error\n        err.uri = @uri\n        err.src = this\n        err.ctx = ctx\n        return err\n\n      constructor: (@kind, @tag, scope) ->\n        unless @kind?\n          throw @error \"must supply 'kind' to create a new Element\"\n\n        @scope = scope if scope?\n          \n        Object.defineProperties this,\n          parent: value: null, writable: true\n          origin: value: null, writable: true\n          state:  value: {}, writable: true\n          [kIndex]: value: 0, writable: true\n          emitter: value: new Emitter\n\n      error: @error\n      debug: @debug\n\n      delegate @prototype, 'emitter'\n        .method 'emit'\n        .method 'once'\n        .method 'on'\n        .method 'off'\n\n### Computed Properties\n\n      @property 'datakey',\n        get: -> @tag ? @kind\n\n      @property 'uri',\n        get: -> switch\n          when @parent instanceof Element\n            mark = @kind\n            mark += \"(#{@tag})\" if @tag? and @parent.scope?[@kind] in [ '0..n', '1..n', '*' ]\n            \"#{@parent.uri}\/#{mark}\"\n          when @tag?\n            \"#{@kind}(#{@tag})\"\n          else\n            @kind\n\n      @property 'root',\n        get: -> switch\n          when @parent instanceof Element then @parent.root\n          when @origin instanceof Element then @origin.root\n          else this\n\n      @property 'children',\n        get: ->\n          unless this[kCache]?\n            elements = (v for own k, v of this when k not in [ 'parent', 'origin', 'tag', kCache, 'source' ])\n              .reduce ((a,b) -> switch\n                when b instanceof Element then a.concat b\n                when b instanceof Array\n                  a.concat b.filter (x) -> x instanceof Element\n                else a\n              ), []\n            this[kCache] = elements.sort (a,b) -> a[kIndex] - b[kIndex]\n          return this[kCache];\n            \n      @property '*',  get: -> @children\n      @property '..', get: -> @parent\n\n## Instance-level methods\n\n### clone\n\n      clone: (opts={}) ->\n        { origin = @origin, relative = true } = opts\n        @debug \"cloning #{@kind}:#{@tag} with #{@children.length} elements\"\n        copy = (new @constructor @kind, @tag, @source).extends @children.map (x) -> x.clone opts\n        copy.state = Object.create(@state)\n        copy.state.relative = relative\n        copy.origin = origin ? this\n        return copy\n\n### extends (elements...)\n\nThis is the primary mechanism for defining sub-elements to become part\nof the element tree\n\n      extends: ->\n        elems = ([].concat arguments...).filter (x) -> x? and !!x\n        return this unless elems.length > 0\n        elems.forEach (expr) => @merge expr\n        @emit 'change', elems...\n        return this\n\n### merge (element)\n\nThis helper method merges a specific Element into current Element\nwhile performing `@scope` validations.\n\n      merge: (elem, opts={}) ->\n        unless elem instanceof Element\n          throw @error \"cannot merge invalid element into Element\", elem\n          \n        elem.parent = this\n        elem[kIndex] = @children.length if @children?\n        this[kCache] = null \n\n        _merge = (item) ->\n          if not item.node or opts.append or item.datakey not in (@keys ? [])\n            @push item\n            true\n          else if opts.replace is true\n            for x, i in this when x.datakey is item.datakey\n              @splice i, 1, item\n              break\n            true\n          else false\n\n        unless @scope?\n          unless @hasOwnProperty elem.kind\n            @[elem.kind] = elem\n            return elem\n\n          unless Array.isArray @[elem.kind]\n            exists = @[elem.kind]\n            @[elem.kind] = [ exists ]\n            Object.defineProperty @[elem.kind], 'keys',\n              get: (-> @map (x) -> x.datakey ).bind @[elem.kind]\n              \n          unless _merge.call @[elem.kind], elem\n            throw @error \"constraint violation for '#{elem.kind} #{elem.datakey}' - cannot define more than once\"\n\n          return elem\n\n        unless elem.kind of @scope\n          if elem.scope? and (not elem.source.state.unbound and not @source.state.unbound)\n            @debug @scope\n            throw @error \"scope violation - invalid '#{elem.kind}' extension found\"\n          else\n            @scope[elem.kind] = '*' # this is hackish...\n\n        switch @scope[elem.kind]\n          when '0..n', '1..n', '*'\n            unless @hasOwnProperty elem.kind\n              @[elem.kind] = []\n              Object.defineProperty @[elem.kind], 'keys',\n                get: (-> @map (x) -> x.datakey ).bind @[elem.kind]\n            unless _merge.call @[elem.kind], elem\n              throw @error \"constraint violation for '#{elem.kind} #{elem.datakey}' - already defined\"\n          when '0..1', '1'\n            unless @hasOwnProperty elem.kind\n              @[elem.kind] = elem\n            else if opts.replace is true\n              @debug \"replacing pre-existing #{elem.kind}\"\n              @[elem.kind] = elem\n            else\n              throw @error \"constraint violation for '#{elem.kind}' - cannot define more than once\"\n          else\n            throw @error \"unrecognized scope constraint defined for '#{elem.kind}' with #{@scope[elem.kind]}\"\n\n        return elem\n\n      removes: ->\n        elems = ([].concat arguments...).filter (x) -> x? and !!x\n        return this unless elems.length > 0\n        elems.forEach (expr) => @remove expr\n        @emit 'change', elems...\n        return this\n\n      remove: (elem) ->\n        unless elem instanceof Element\n          throw @error \"cannot remove a non-Element from an Element\", elem\n\n        exists = Element::match.call this, elem.kind, elem.datakey\n        return this unless exists?\n\n        if Array.isArray @[elem.kind]\n          @[elem.kind] = @[elem.kind].filter (x) -> x.datakey isnt elem.datakey\n          delete @[elem.kind] unless @[elem.kind].length\n        else\n          delete @[elem.kind]\n\n        this[kCache] = null\n        return this\n\n### update (element)\n\nThis alternative form of [merge](#merge-element) performs conditional\nmerge based on existence check. It is considered *safer* alternative\nto direct [merge](#merge-element) call.\n\n      # performs conditional merge based on existence\n      update: (elem) ->\n        unless elem instanceof Element\n          throw @error \"cannot update a non-Element into an Element\", elem\n\n        #@debug \"update with #{elem.kind}\/#{elem.tag}\"\n        exists = switch\n          when elem.tag? then Element::match.call this, elem.kind, elem.datakey\n          else Element::match.call this, elem.kind\n        return @merge elem unless exists?\n\n        #@debug \"update #{exists.kind} in-place for #{elem.children.length} elements\"\n        exists.update target for target in elem.children\n        return exists\n\n      # Looks for matching Elements using kind and tag\n      # Direction: up the hierarchy (towards root)\n      lookup: (kind, tag) ->\n        #@debug \"lookup: #{kind}(#{tag})...\"\n        res = switch\n          when this not instanceof Object then undefined\n          when this instanceof Element then @match kind, tag\n          else Element::match.call this, kind, tag\n        res ?= switch\n          when @origin? then Element::lookup.apply @origin, arguments\n          when @parent? then Element::lookup.apply @parent, arguments\n          else Element::match.call @constructor, kind, tag\n        #@debug \"lookup: #{kind}(#{tag}) got result: #{res?}\"\n        return res\n\n      # Looks for matching Elements using YPATH notation\n      # Direction: down the hierarchy (away from root)\n      at: -> @locate arguments...\n      locate: (ypath) ->\n        return unless ypath?\n        if typeof ypath is 'string'\n          @debug \"locate: #{ypath}\"\n          ypath = ypath.replace \/\\s\/g, ''\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = ypath.split('\/').filter (e) -> !!e\n        else\n          @debug \"locate: #{ypath.join('\/')}\"\n          [ key, rest... ] = ypath\n        return this unless key?\n\n        match = switch\n          when key is '..' then @match key\n          else @match '*', key\n            \n        match ?= @match key if @scope[key] in ['0..1', '1']\n\n        return switch\n          when rest.length > 0 then match?.locate rest\n          else match\n\n      # Looks for a matching Element(s) in immediate sub-elements\n      match: (kind, tag) ->\n        return unless kind? and @[kind]?\n        return @[kind] unless tag?\n\n        match = @[kind]\n        match = [ match ] unless match instanceof Array\n        return match if tag is '*'\n\n        for elem in match when elem instanceof Element\n          return elem if tag is elem.datakey or tag is elem.tag\n        return undefined\n\n### toJSON\n\nConverts the Element into a JS object\n\n      toJSON: (opts={ tag: true, extended: false }) ->\n        #@debug \"converting #{@kind} toJSON with #{@children.length}\"\n        sub =\n          @children\n            .filter (x) => opts.extended or x.parent is this\n            .reduce ((a,b) ->\n              for k, v of b.toJSON()\n                if a[k] instanceof Object\n                  a[k][kk] = vv for kk, vv of v if v instanceof Object\n                else\n                  a[k] = v\n              return a\n            ), {}\n        if opts.tag\n          \"#{@kind}\": switch\n            when Object.keys(sub).length > 0\n              if @tag? then \"#{@tag}\": sub else sub\n            when @tag instanceof Object then \"#{@tag}\"\n            else @tag\n        else sub\n\n## Export Element Class\n\n    module.exports = Element\n","old_contents":"# Element - cascading element tree\n\n## Class Element\n\n    debug = require('debug')('yang:element')\n    delegate = require 'delegates'\n    Emitter = require('events').EventEmitter\n    Emitter.defaultMaxListeners = 100\n\n    kIndex = Symbol.for('element:index');\n    kCache = Symbol.for('element:cache');\n    \n    class Element\n      \n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n        \n      @use: ->\n        res = [].concat(arguments...)\n          .filter (x) -> x?\n          .map (elem) =>\n            exists = Element::match.call this, elem.kind, elem.tag\n            if exists?\n              debug \"use: using previously loaded '#{elem.kind}:#{elem.tag}'\"\n              return exists\n            try Element::merge.call this, elem\n            catch e\n              throw @error \"use: unable to merge '#{elem.kind}:#{elem.tag}'\", e\n        return switch \n          when res.length > 1  then res\n          when res.length is 1 then res[0]\n          else undefined\n            \n      @debug: -> debug @uri, arguments...\n      \n      @error: (err, ctx=this) ->\n        err = new Error err unless err instanceof Error\n        err.uri = @uri\n        err.src = this\n        err.ctx = ctx\n        return err\n\n      constructor: (@kind, @tag, scope) ->\n        unless @kind?\n          throw @error \"must supply 'kind' to create a new Element\"\n\n        @scope = scope if scope?\n          \n        Object.defineProperties this,\n          parent: value: null, writable: true\n          origin: value: null, writable: true\n          state:  value: {}, writable: true\n          [kIndex]: value: 0, writable: true\n          emitter: value: new Emitter\n\n      error: @error\n      debug: @debug\n\n      delegate @prototype, 'emitter'\n        .method 'emit'\n        .method 'once'\n        .method 'on'\n        .method 'off'\n\n### Computed Properties\n\n      @property 'datakey',\n        get: -> @tag ? @kind\n\n      @property 'uri',\n        get: -> switch\n          when @parent instanceof Element\n            mark = @kind\n            mark += \"(#{@tag})\" if @tag? and @parent.scope?[@kind] in [ '0..n', '1..n', '*' ]\n            \"#{@parent.uri}\/#{mark}\"\n          when @tag?\n            \"#{@kind}(#{@tag})\"\n          else\n            @kind\n\n      @property 'root',\n        get: -> switch\n          when @parent instanceof Element then @parent.root\n          when @origin instanceof Element then @origin.root\n          else this\n\n      @property 'children',\n        get: ->\n          unless this[kCache]?\n            elements = (v for own k, v of this when k not in [ 'parent', 'origin', 'tag', kCache, 'source' ])\n              .reduce ((a,b) -> switch\n                when b instanceof Element then a.concat b\n                when b instanceof Array\n                  a.concat b.filter (x) -> x instanceof Element\n                else a\n              ), []\n            this[kCache] = elements.sort (a,b) -> a[kIndex] - b[kIndex]\n          return this[kCache];\n            \n      @property '*',  get: -> @children\n      @property '..', get: -> @parent\n\n## Instance-level methods\n\n### clone\n\n      clone: (opts={}) ->\n        { origin = @origin, relative = true } = opts\n        @debug \"cloning #{@kind}:#{@tag} with #{@children.length} elements\"\n        copy = (new @constructor @kind, @tag, @source).extends @children.map (x) -> x.clone opts\n        copy.state = Object.create(@state)\n        copy.state.relative = relative\n        copy.origin = origin ? this\n        return copy\n\n### extends (elements...)\n\nThis is the primary mechanism for defining sub-elements to become part\nof the element tree\n\n      extends: ->\n        elems = ([].concat arguments...).filter (x) -> x? and !!x\n        return this unless elems.length > 0\n        elems.forEach (expr) => @merge expr\n        @emit 'change', elems...\n        return this\n\n### merge (element)\n\nThis helper method merges a specific Element into current Element\nwhile performing `@scope` validations.\n\n      merge: (elem, opts={}) ->\n        unless elem instanceof Element\n          throw @error \"cannot merge invalid element into Element\", elem\n          \n        elem.parent = this\n        elem[kIndex] = @children.length if @children?\n        this[kCache] = null \n\n        _merge = (item) ->\n          if not item.node or opts.append or item.datakey not in (@keys ? [])\n            @push item\n            true\n          else if opts.replace is true\n            for x, i in this when x.datakey is item.datakey\n              @splice i, 1, item\n              break\n            true\n          else false\n\n        unless @scope?\n          unless @hasOwnProperty elem.kind\n            @[elem.kind] = elem\n            return elem\n\n          unless Array.isArray @[elem.kind]\n            exists = @[elem.kind]\n            @[elem.kind] = [ exists ]\n            Object.defineProperty @[elem.kind], 'keys',\n              get: (-> @map (x) -> x.datakey ).bind @[elem.kind]\n              \n          unless _merge.call @[elem.kind], elem\n            throw @error \"constraint violation for '#{elem.kind} #{elem.datakey}' - cannot define more than once\"\n\n          return elem\n\n        unless elem.kind of @scope\n          if elem.scope? and (not elem.source.state.unbound and not @source.state.unbound)\n            @debug @scope\n            throw @error \"scope violation - invalid '#{elem.kind}' extension found\"\n          else\n            @scope[elem.kind] = '*' # this is hackish...\n\n        switch @scope[elem.kind]\n          when '0..n', '1..n', '*'\n            unless @hasOwnProperty elem.kind\n              @[elem.kind] = []\n              Object.defineProperty @[elem.kind], 'keys',\n                get: (-> @map (x) -> x.datakey ).bind @[elem.kind]\n            unless _merge.call @[elem.kind], elem\n              throw @error \"constraint violation for '#{elem.kind} #{elem.datakey}' - already defined\"\n          when '0..1', '1'\n            unless @hasOwnProperty elem.kind\n              @[elem.kind] = elem\n            else if opts.replace is true\n              @debug \"replacing pre-existing #{elem.kind}\"\n              @[elem.kind] = elem\n            else\n              throw @error \"constraint violation for '#{elem.kind}' - cannot define more than once\"\n          else\n            throw @error \"unrecognized scope constraint defined for '#{elem.kind}' with #{@scope[elem.kind]}\"\n\n        return elem\n\n      removes: ->\n        elems = ([].concat arguments...).filter (x) -> x? and !!x\n        return this unless elems.length > 0\n        elems.forEach (expr) => @remove expr\n        @emit 'change', elems...\n        return this\n\n      remove: (elem) ->\n        unless elem instanceof Element\n          throw @error \"cannot remove a non-Element from an Element\", elem\n\n        exists = Element::match.call this, elem.kind, elem.datakey\n        return this unless exists?\n\n        if Array.isArray @[elem.kind]\n          @[elem.kind] = @[elem.kind].filter (x) -> x.datakey isnt elem.datakey\n          delete @[elem.kind] unless @[elem.kind].length\n        else\n          delete @[elem.kind]\n\n        this._cache = null\n        return this\n\n### update (element)\n\nThis alternative form of [merge](#merge-element) performs conditional\nmerge based on existence check. It is considered *safer* alternative\nto direct [merge](#merge-element) call.\n\n      # performs conditional merge based on existence\n      update: (elem) ->\n        unless elem instanceof Element\n          throw @error \"cannot update a non-Element into an Element\", elem\n\n        #@debug \"update with #{elem.kind}\/#{elem.tag}\"\n        exists = switch\n          when elem.tag? then Element::match.call this, elem.kind, elem.datakey\n          else Element::match.call this, elem.kind\n        return @merge elem unless exists?\n\n        #@debug \"update #{exists.kind} in-place for #{elem.children.length} elements\"\n        exists.update target for target in elem.children\n        return exists\n\n      # Looks for matching Elements using kind and tag\n      # Direction: up the hierarchy (towards root)\n      lookup: (kind, tag) ->\n        #@debug \"lookup: #{kind}(#{tag})...\"\n        res = switch\n          when this not instanceof Object then undefined\n          when this instanceof Element then @match kind, tag\n          else Element::match.call this, kind, tag\n        res ?= switch\n          when @origin? then Element::lookup.apply @origin, arguments\n          when @parent? then Element::lookup.apply @parent, arguments\n          else Element::match.call @constructor, kind, tag\n        #@debug \"lookup: #{kind}(#{tag}) got result: #{res?}\"\n        return res\n\n      # Looks for matching Elements using YPATH notation\n      # Direction: down the hierarchy (away from root)\n      at: -> @locate arguments...\n      locate: (ypath) ->\n        return unless ypath?\n        if typeof ypath is 'string'\n          @debug \"locate: #{ypath}\"\n          ypath = ypath.replace \/\\s\/g, ''\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = ypath.split('\/').filter (e) -> !!e\n        else\n          @debug \"locate: #{ypath.join('\/')}\"\n          [ key, rest... ] = ypath\n        return this unless key?\n\n        match = switch\n          when key is '..' then @match key\n          else @match '*', key\n            \n        match ?= @match key if @scope[key] in ['0..1', '1']\n\n        return switch\n          when rest.length > 0 then match?.locate rest\n          else match\n\n      # Looks for a matching Element(s) in immediate sub-elements\n      match: (kind, tag) ->\n        return unless kind? and @[kind]?\n        return @[kind] unless tag?\n\n        match = @[kind]\n        match = [ match ] unless match instanceof Array\n        return match if tag is '*'\n\n        for elem in match when elem instanceof Element\n          return elem if tag is elem.datakey or tag is elem.tag\n        return undefined\n\n### toJSON\n\nConverts the Element into a JS object\n\n      toJSON: (opts={ tag: true, extended: false }) ->\n        #@debug \"converting #{@kind} toJSON with #{@children.length}\"\n        sub =\n          @children\n            .filter (x) => opts.extended or x.parent is this\n            .reduce ((a,b) ->\n              for k, v of b.toJSON()\n                if a[k] instanceof Object\n                  a[k][kk] = vv for kk, vv of v if v instanceof Object\n                else\n                  a[k] = v\n              return a\n            ), {}\n        if opts.tag\n          \"#{@kind}\": switch\n            when Object.keys(sub).length > 0\n              if @tag? then \"#{@tag}\": sub else sub\n            when @tag instanceof Object then \"#{@tag}\"\n            else @tag\n        else sub\n\n## Export Element Class\n\n    module.exports = Element\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"eb72e8260dd1aa5b3ffe1cf444ca24ae72399262","subject":"models base","message":"models base\n","repos":"vpj\/models","old_file":"js\/models\/base.litcoffee","new_file":"js\/models\/base.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#List\n\n    Mod.require 'Weya',\n     'Models.Properties'\n     'Models.Util'\n     (Weya, PROPERTIES, UTIL) ->\n\n\nClass\n\n      class Model\n       _initialize: []\n       _properties: {}\n       _requiredFunctions: {}\n       on: {}\n\n       @extend: ->\n        @::_initialize = @::_initialize.slice()\n        @::_properties = UTIL.extend {}, @::_properties\n        @::_requiredFunctions = UTIL.extend {}, @::_requiredFunctions\n        @::on = UTIL.extend {}, @::on\n\n       @include: (obj) ->\n        if not obj?\n         throw new Error 'Cannot include a null object'\n        for k, v of obj\n         switch k\n          when 'initialize'\n           @::_initialize.push v\n          when 'property'\n           for name, obj of v\n            @_addProperty name, obj\n          when 'requireFunction'\n           for name, desc of v\n            @::_requiredFunctions[name] = desc\n          when 'on'\n           for event, listener of v\n            if not @::on[event]?\n             @::on[event] = listener\n          else\n           @prototype[k] = v\n\n        return null\n\n Initialize variables.\n\n       @initialize: (func) ->\n        @::_initialize.push func\n\nAdd listener\n\n       @listen: (name, func) ->\n        @::on[name] = func\n\nRegister a property\n\n       @property: (name, obj) ->\n        if (typeof name) is 'string'\n         @_addProperty name, obj\n        else\n         objs = name\n         for name, obj of objs\n          @_addProperty name, obj\n\n       @_addProperty: (name, obj) ->\n        if (typeof name) isnt 'string'\n         throw new Error \"Property name not a string: #{name}\"\n        if (typeof obj) isnt 'object'\n         throw new Error \"Property not an object: #{name}\"\n\n        @::_properties[name] = PROPERTIES.create obj\n\n       @requireFunction: (name, desc) ->\n        if (typeof name) is 'string'\n         @::_requiredFunctions[name] = desc\n        else\n         obj = name\n         for name, desc of obj\n          @::_requiredFunctions[name] = desc\n\n\nCheck properties\n\n       @check: ->\n        if not @::type?\n         throw new Error \"Object type not defined\"\n        type = @::type\n\n        mentioned =\n         type: true\n        for func, desc of @::_requiredFunctions\n         mentioned[func] = true\n         if not @::[func]?\n          throw new Error \"#{type}: Function not defined: #{func} - #{desc}\"\n         if (typeof @::[func]) isnt 'function'\n          throw new Error \"#{type}: Not a function: #{func} - #{desc}\"\n\n        extra = []\n        for k of this.prototype\n         continue if k is 'on'\n         if not mentioned[k]?\n          if k[0] isnt '_'\n           extra.push k\n\n        if extra.length > 0\n         console.error type, extra\n\n        @::_checked = true\n\n\n       constructor: ->\n        @initialize.apply this, arguments\n\n##Override\n\n##Initialize\n\n       initialize: (options) ->\n        if @_checked isnt on\n         throw new Error \"Object #{@type} wasnt checked\"\n\n        @_bindEvents()\n\n        for init in @_initialize\n         init.call this\n\n\n       @requireFunction\n        'initialize': 'Initialize'\n        'parse': 'Parse'\n        'render': 'Render element'\n        'weya': 'Render weya template'\n        'html': 'Render html'\n        'template': 'Render template'\n        'toJSON': 'To JSON'\n        'toJSONFull': 'To JSON Full'\n        'isDefault': 'Is default value'\n        'edit': 'Render editor'\n        'valueChanged': 'A property value change event'\n\n##Public functions\n\n       parse: (data) ->\n        excess = 0\n        @_errors = []\n        fields = 0\n        @_score = 0\n        @_values = {}\n\n        for name of data when not @_properties[name]?\n         @_errors.push \": #{name} excess\"\n         excess++\n\n\n        for name, prop of @_properties\n         fields++\n         r = prop.parse data[name]\n         @_values[name] = r.value\n         if not prop.isDefault r.value\n          @_score += r.score\n         for e in r.errors\n          @_errors.push \"#{name}(#{@type})\/#{e}\"\n\n        if fields is 0\n         @_score = (if excess > 0 then 0 else 1)\n        else\n         @_score = (@_score - excess) \/ fields\n        @_score = 0 if @_score < 0\n        if @_score > 1\n         throw new Error \"Score greater than 1: #{score}\"\n\n        return {\n         score: @_score,\n         value: this\n         errors: @_errors\n        }\n\n       weya: (weya) ->\n        @template.call weya, this\n\n       render: (elem) ->\n        self = this\n        Weya elem: elem, ->\n         self.weya this\n\n       html: ->\n        self = this\n        Weya.markup {}, ->\n         self.weya this\n\n       toJSON: ->\n        data = {}\n        for name, prop of @_properties\n         v = prop.toJSON @_values[name]\n         if not prop.isDefault v\n          data[name] = v\n\n\n        return data\n\n       toJSONFull: ->\n        data = {}\n        for name, prop of @_properties\n         data[name] = prop.toJSONFull @_values[name]\n\n        return data\n\n\n       isDefault: ->\n        for name, prop of @_properties\n         v = prop.toJSON @_values[name]\n         if not prop.isDefault v\n          return false\n\n        return true\n\n       edit: (elem, changed) ->\n        @onChanged = changed\n        @_editElems = {}\n        Weya elem: elem, context: this, ->\n         for name, prop of @$._properties\n          @div \".property\", ->\n           @span \".property-name\", name\n           @$._editElems[name] = @div \".property-value\", \"\"\n\n        for name, prop of @_properties\n         prop.edit @_editElems[name], @_values[name],\n          @valueChanged.bind self: this, name: name\n\n       valueChanged: (value, changed) ->\n        @self._values[@name] = value\n        @self.onChanged @self, false\n\n\n##Private functions\n\nBind\n\n       _bindEvents: ->\n        events = @on\n        @on = {}\n        for k, v of events\n         @on[k] = v.bind this\n\n\n\n\n      Mod.set 'Models.Model.Base', Model\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#List\n\n    Mod.require 'Weya',\n     'Models.Properties'\n     'Models.Util'\n     (Weya, PROPERTIES, UTIL) ->\n\n\nClass\n\n      class Model\n       _initialize: []\n       _properties: {}\n       _requiredFunctions: {}\n       on: {}\n\n       @extend: ->\n        @::_initialize = @::_initialize.slice()\n        @::_properties = UTIL.extend {}, @::_properties\n        @::_requiredFunctions = UTIL.extend {}, @::_requiredFunctions\n        @::on = UTIL.extend {}, @::on\n\n       @include: (obj) ->\n        if not obj?\n         throw new Error 'Cannot include a null object'\n        for k, v of obj\n         switch k\n          when 'initialize'\n           @::_initialize.push v\n          when 'property'\n           for name, obj of v\n            @_addProperty name, obj\n          when 'requireFunction'\n           for name, desc of v\n            @::_requiredFunctions[name] = desc\n          when 'on'\n           for event, listener of v\n            if not @::on[event]?\n             @::on[event] = listener\n          else\n           @prototype[k] = v\n\n        return null\n\n Initialize variables.\n\n       @initialize: (func) ->\n        @::_initialize.push func\n\nAdd listener\n\n       @listen: (name, func) ->\n        @::on[name] = func\n\nRegister a property\n\n       @property: (name, obj) ->\n        if (typeof name) is 'string'\n         @_addProperty name, obj\n        else\n         objs = name\n         for name, obj of objs\n          @_addProperty name, obj\n\n       @_addProperty: (name, obj) ->\n        if (typeof name) isnt 'string'\n         throw new Error \"Property name not a string: #{name}\"\n        if (typeof obj) isnt 'object'\n         throw new Error \"Property not an object: #{name}\"\n\n        @::_properties[name] = PROPERTIES.create obj\n\n       @requireFunction: (name, desc) ->\n        if (typeof name) is 'string'\n         @::_requiredFunctions[name] = desc\n        else\n         obj = name\n         for name, desc of obj\n          @::_requiredFunctions[name] = desc\n\n\nCheck properties\n\n       @check: ->\n        if not @::type?\n         throw new Error \"Object type not defined\"\n        type = @::type\n\n        mentioned =\n         type: true\n        for func, desc of @::_requiredFunctions\n         mentioned[func] = true\n         if not @::[func]?\n          throw new Error \"#{type}: Function not defined: #{func} - #{desc}\"\n         if (typeof @::[func]) isnt 'function'\n          throw new Error \"#{type}: Not a function: #{func} - #{desc}\"\n\n        extra = []\n        for k of this.prototype\n         continue if k is 'on'\n         if not mentioned[k]?\n          if k[0] isnt '_'\n           extra.push k\n\n        if extra.length > 0\n         console.error type, extra\n\n        @::_checked = true\n\n\n       constructor: ->\n        @initialize.apply this, arguments\n\n##Override\n\n##Initialize\n\n       initialize: (options) ->\n        if @_checked isnt on\n         throw new Error \"Object #{@type} wasnt checked\"\n\n        @_bindEvents()\n\n        for init in @_initialize\n         init.call this\n\n\n       @requireFunction\n        'initialize': 'Initialize'\n        'parse': 'Parse'\n        'render': 'Render element'\n        'weya': 'Render weya template'\n        'html': 'Render html'\n        'template': 'Render template'\n        'toJSON': 'To JSON'\n        'edit': 'Render editor'\n        'valueChanged': 'A property value change event'\n\n##Public functions\n\n       parse: (data) ->\n        excess = 0\n        @_errors = []\n        fields = 0\n        @_score = 0\n        @_values = {}\n\n        for name of data when not @_properties[name]?\n         @_errors.push \": #{name} excess\"\n         excess++\n\n\n        for name, prop of @_properties\n         fields++\n         r = prop.parse data[name]\n         @_values[name] = r.value\n         if not prop.isDefault r.value\n          @_score += r.score\n         for e in r.errors\n          @_errors.push \"#{name}(#{@type})\/#{e}\"\n\n        if fields is 0\n         @_score = (if excess > 0 then 0 else 1)\n        else\n         @_score = (@_score - excess) \/ fields\n        @_score = 0 if @_score < 0\n        if @_score > 1\n         throw new Error \"Score greater than 1: #{score}\"\n\n        return {\n         score: @_score,\n         value: this\n         errors: @_errors\n        }\n\n       weya: (weya) ->\n        @template.call weya, this\n\n       render: (elem) ->\n        self = this\n        Weya elem: elem, ->\n         self.weya this\n\n       html: ->\n        self = this\n        Weya.markup {}, ->\n         self.weya this\n\n       toJSON: ->\n        data = {}\n        for name, prop of @_properties\n         v = prop.toJSON @_values[name]\n         if not prop.isDefault v\n          data[name] = v\n\n\n        return data\n\n       toJSONFull: ->\n        data = {}\n        for name, prop of @_properties\n         data[name] = prop.toJSONFull @_values[name]\n\n        return data\n\n\n       isDefault: ->\n        for name, prop of @_properties\n         v = prop.toJSON @_values[name]\n         if not prop.isDefault v\n          return false\n\n        return true\n\n       edit: (elem, changed) ->\n        @onChanged = changed\n        @_editElems = {}\n        Weya elem: elem, context: this, ->\n         for name, prop of @$._properties\n          @div \".property\", ->\n           @span \".property-name\", name\n           @$._editElems[name] = @div \".property-value\", \"\"\n\n        for name, prop of @_properties\n         prop.edit @_editElems[name], @_values[name],\n          @valueChanged.bind self: this, name: name\n\n       valueChanged: (value, changed) ->\n        @self._values[@name] = value\n        @self.onChanged @self, false\n\n\n##Private functions\n\nBind\n\n       _bindEvents: ->\n        events = @on\n        @on = {}\n        for k, v of events\n         @on[k] = v.bind this\n\n\n\n\n      Mod.set 'Models.Model.Base', Model\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f78659e46ee0b9acb178ff63961f19fbef0c0998","subject":"Tweak wording in PathStencil.","message":"Tweak wording in PathStencil.","repos":"louismrose\/eugenia-live,louismrose\/eugenia-live","old_file":"app\/scripts\/viewmodels\/drawings\/stencils\/path_stencil.litcoffee","new_file":"app\/scripts\/viewmodels\/drawings\/stencils\/path_stencil.litcoffee","new_contents":"### PathStencil\nThis class is responsible for rendering Links, currently by drawing a \nPaper.js Path.\n\n    define [\n      'paper'\n      'viewmodels\/drawings\/stencils\/stencil'\n      'viewmodels\/drawings\/stencils\/stencil_specification'\n    ], (paper, Stencil, StencilSpecification) ->\n  \n      class PathStencil extends Stencil\n      \nThe `color` and `style` properties are used when rendering a Path.\nWe first set some sensible defaults in case the LinkShape omits values\nfor any of these properties.\n\n        defaultSpecification: =>\n          new StencilSpecification(color: 'black', style: 'solid')\n      \nWhen a PathStencil is used to render a Link, we create a Paper.js Path\nthat comprises the segments stored in the Link. The segments property \nwill be an array of Paper.js segments. We then set the stroke color \nand dash array of the Path, according to the `color` and `style` properties.\n      \n        draw: (link) =>\n          path = new paper.Path(link.segments)\n          path.strokeColor = @resolve(link, 'color')\n          path.dashArray = [4, 4] if @resolve(link, 'style') is 'dash'\n          path\n","old_contents":"### PathStencil\nThis class is responsible for rendering Links, currently by drawing a \nPaper.js Path.\n\n    define [\n      'paper'\n      'viewmodels\/drawings\/stencils\/stencil'\n      'viewmodels\/drawings\/stencils\/stencil_specification'\n    ], (paper, Stencil, StencilSpecification) ->\n\nThe `color` and `style` properties are used when rendering a Path.\nWe first set some sensible defaults in case the LinkShape omits values\nfor any of these properties.\n  \n      class PathStencil extends Stencil\n        defaultSpecification: =>\n          new StencilSpecification(color: 'black', style: 'solid')\n      \nWhen a PathStencil is used to render a Link, we create a Paper.js Path\nthat comprises the segments stored in the Link. The segments property \nwill be an array of Paper.js segments. We then set the stroke color \nand dash array of the Path, according to the `color` and `style` properties.\n      \n        draw: (link) =>\n          path = new paper.Path(link.segments)\n          path.strokeColor = @resolve(link, 'color')\n          path.dashArray = [4, 4] if @resolve(link, 'style') is 'dash'\n          path\n","returncode":0,"stderr":"","license":"epl-1.0","lang":"Literate CoffeeScript"}
{"commit":"e7beeb4e269165359a206cdea9d4cdae22551c1a","subject":"'unit' modifiers (onServer etc.) fixed","message":"'unit' modifiers (onServer etc.) fixed\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/unit\/modifiers.litcoffee","new_file":"src\/unit\/modifiers.litcoffee","new_contents":"    'use strict'\n\n    utils = require 'src\/utils'\n\n    NOP = ->\n\n    PLATFORMS =\n        onNode: 'isNode'\n        onServer: 'isServer'\n        onClient: 'isClient'\n        onBrowser: 'isBrowser'\n        onAndroid: 'isAndroid'\n        onIOS: 'isIOS'\n\n    exports.applyAll = (func) ->\n\nisNode\n--\n\nisServer\n--\n\nisClient\n--\n\nisBrowser\n--\n\nisAndroid\n--\n\nisIOS\n--\n\n        for funcName, utilsProp of PLATFORMS\n            getter = if utils[utilsProp] then -> this else NOP\n            utils.defineProperty func, funcName, 0, getter, null\n        return\n","old_contents":"    'use strict'\n\n    utils = require 'src\/utils'\n\n    NOP = ->\n\n    PLATFORMS =\n        onNode: 'isNode'\n        onServer: 'isServer'\n        onClient: 'isClient'\n        onBrowser: 'isBrowser'\n        onAndroid: 'isAndroid'\n        onIOS: 'isIOS'\n\n    exports.applyAll = (func) ->\n\nisNode\n--\n\nisServer\n--\n\nisClient\n--\n\nisBrowser\n--\n\nisAndroid\n--\n\nisIOS\n--\n\n        for funcName, utilsProp of PLATFORMS\n            func[funcName] = if utils[utilsProp] then -> this else NOP\n        return\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"5db384fd37be90e742e2c24d4692018aac51b372","subject":"Clean up documentation and links in ComponentQuery","message":"Clean up documentation and links in ComponentQuery\n","repos":"ygt-mikekchar\/react-maybe-matchers,ygt-mikekchar\/react-maybe-matchers","old_file":"src\/ComponentQuery.litcoffee","new_file":"src\/ComponentQuery.litcoffee","new_contents":"# ComponentQuery\n\nWhen we first start out, we will want to query only a single\ncomponent.  This monad is used for querying that component\nand getting a list of nodes that we will filter later.\n \n## Example\n\n```\ncomponentQuery.contains\n              .tags(\"div\")\n              .result()\n```\n\nThis will take the React component used in the constructor\nof the ComponentQuery and generate a ComponentFilter with the DOM nodes\nthat have the tag \"div\".  In this particular example,\nit will return a matching result if there are any such nodes.\n\n### Requirements\n\nThe [JasmineMonad](.\/JasmineMonad.litcoffee#a-monad-for-jasmine-tests) is a \"maybe\" monad that\nallows us to chain our matcher functions in a fluent way.\n\n    JasmineMonad = require(\".\/JasmineMonad.litcoffee\")\n\nThe [ComponentFilter](.\/ComponentFilter.litcoffee#componentfilter) is a JasmineMonad\nthat allows you to filter and match collections of React components.\n\n    ComponentFilter = require(\".\/ComponentFilter.litcoffee\")\n\nThe [DomComponentFilter](.\/DomComponentFilter.litcoffee#domcomponentfilter)\nis a JasmineMonad that allows you to filter and match collections of DOM\ncomponents.\n\n    DomComponentFilter = require(\".\/DomComponentFilter.litcoffee\")\n\n## A monad for making queries of single Components\n\n    class ComponentQuery extends JasmineMonad\n\n      constructor: (@reactUtils, @value, @util, @testers, @messages) ->\n        # FIXME: pass reactutils along so that we have a consistent api\n        super(@value, @util, @testers, @messages)\n\n### English Helpers\n\nIt is nice to have use this word to make the expectation read more easily.\n\n        @contains = this\n\n### Unit method for ComponentQuery\n\nMost of the methods on `ComponentQuery` will actually want to\nreturn a ComponentFilter so the user can filter the collection of returned \nnodes.  If we were using a language with strong typing the compiler\nwould be able to construct the correct the correct Monad based\non the types.  However, we are using Coffeescript, so we have to\ngive it a helping hand by making a different `return` method.\n\n      return: (nodes, messages) ->\n        new ComponentFilter(nodes, @util, @testers, messages)\n\nIn the past DOM nodes in the React tree were treated similarly to\nReact components.  This will change in 0.15, so we need to make\nsure to create the correct filter object.\n\n      returnDom: (nodes, messages) ->\n        new DomComponentFilter(nodes, @util, @testers, messages)\n\n### Testing for DOM tags\n\nOne of the most common kinds of tests is to determine whether or not\na component contains a DOM \"tag\" (eg \"h1\", \"div\", etc). This matcher\npasses if there is at least one.\n\n      tags: (tag) ->\n        @bind (component) =>\n          nodes = @reactUtils.scryRenderedDOMComponentsWithTag(component, tag)\n          messages = [\n            \"Expected to find DOM tag #{tag}, but it was not there.\"\n            \"Expected not to find DOM tag #{tag}, but there #{@was(nodes.length)}.\"\n          ]\n          if nodes.length > 0\n            @returnDom(nodes, messages)\n          else\n            @returnDom(null, messages)\n\n### Testing directly for DOM with class\n\nSometimes you don't care what kind of tag the DOM nodes have.  You just\nwant ensure that there is *something* with the required class.\n\n      cssClass: (cssClass) ->\n        @bind (component) =>\n          nodes = @reactUtils.scryRenderedDOMComponentsWithClass(component, cssClass)\n          messages = [\n            \"Expected to find DOM node with class #{cssClass}, but it was not there.\"\n            \"Expected not to find DOM node with class #{cssClass}, but there #{@was(nodes.length)}.\"\n          ]\n          if nodes.length > 0\n            @returnDom(nodes, messages)\n          else\n            @returnDom(null, messages)\n\n### Testing for React component types\n\nAnother common kind of test is to determine whether or not\na component contains a React component of a certain type. This matcher\npasses if there is at least one.\n\nFIXME: It would be nice to print the name of the component that\nyou want to find in the error messages, but it doesn't appear\nto be available.\n\n      type: (type) ->\n        @bind (component) =>\n          nodes = @reactUtils.scryRenderedComponentsWithType(component, type)\n          messages = [\n            \"Expected to find a React component, but it was not there.\"\n            \"Expected not to find a React component, but there #{@was(nodes.length)}.\"\n          ]\n          if nodes.length > 0\n            @return(nodes, messages)\n          else\n            @return(null, messages)\n\n### Exported Classes\n\n    module.exports = ComponentQuery\n","old_contents":"# ComponentQuery\n\nWhen we first start out, we are likely to have only a single\ncomponent.  This monad is used for querying that component\nand getting a list of nodes that we will filter later.\n \n## Example\n\n```\ncomponentQuery.contains\n              .tags(\"div\")\n              .result()\n```\n\nThis will take a component in the componentFilter\nand generate a ComponentFilter with the DOM nodes\nthat have the tag \"div\".  In this particular example,\nit will return a matching result if there are any\nsuch nodes.\n\n## Requirements\n\nThe [JasmineMonad](.\/JasmineMonad.litcoffee) is a \"maybe\" monad that\nallows us to chain our matcher functions in a fluent way.\n\n    JasmineMonad = require(\".\/JasmineMonad.litcoffee\")\n\nThe [ComponentFilter](.\/ComponentFilter.litcoffee) is a JasmineMonad\nthat allows you to filter and match collections of React components.\n\n    ComponentFilter = require(\".\/ComponentFilter.litcoffee\")\n\nThe [DomComponentFilter](.\/DomComponentFilter.litcoffee) is a JasmineMonad\nthat allows you to filter and match collections of DOM components.\n\n    DomComponentFilter = require(\".\/DomComponentFilter.litcoffee\")\n\n## A monad for making queries of single Components\n\n    class ComponentQuery extends JasmineMonad\n\n      constructor: (@reactUtils, @value, @util, @testers, @messages) ->\n        super(@value, @util, @testers, @messages)\n\n#### English Helpers\n\nIt is nice to have use this word to make the expectation read more easily.\n\n        @contains = this\n\n#### Unit method for ComponentQuery\n\nMost of the methods on `ComponentQuery` will actually want to\nreturn a ComponentFilter so the user can filter the collection of returned \nnodes.  If we were using a language with strong typing the compiler\nwould be able to construct the correct the correct Monad based\non the types.  However, we are using Coffeescript, so we have to\ngive it a helping hand by making a different `return` method.\n\n      return: (nodes, messages) ->\n        new ComponentFilter(nodes, @util, @testers, messages)\n\nIn the past DOM nodes in the React tree were treated similarly to\nReact components.  This will change in 0.15, so we need to make\nsure to create the correct filter object.\n\n      returnDom: (nodes, messages) ->\n        new DomComponentFilter(nodes, @util, @testers, messages)\n\n#### Testing for DOM tags\n\nOne of the most common kinds of tests is to determine whether or not\na component contains a DOM \"tag\" (eg \"h1\", \"div\", etc). This matcher\npasses if there is at least one.\n\n      tags: (tag) ->\n        @bind (component) =>\n          nodes = @reactUtils.scryRenderedDOMComponentsWithTag(component, tag)\n          messages = [\n            \"Expected to find DOM tag #{tag}, but it was not there.\"\n            \"Expected not to find DOM tag #{tag}, but there #{@was(nodes.length)}.\"\n          ]\n          if nodes.length > 0\n            @returnDom(nodes, messages)\n          else\n            @returnDom(null, messages)\n\n#### Testing directly for DOM with class\n\nSometimes you don't care what kind of tag the DOM nodes have.  You just\nwant ensure that there is *something* with the required class.\n\n      cssClass: (cssClass) ->\n        @bind (component) =>\n          nodes = @reactUtils.scryRenderedDOMComponentsWithClass(component, cssClass)\n          messages = [\n            \"Expected to find DOM node with class #{cssClass}, but it was not there.\"\n            \"Expected not to find DOM node with class #{cssClass}, but there #{@was(nodes.length)}.\"\n          ]\n          if nodes.length > 0\n            @returnDom(nodes, messages)\n          else\n            @returnDom(null, messages)\n\n#### Testing for React component types\n\nAnother common kind of test is to determine whether or not\na component contains a React component of a certain type. This matcher\npasses if there is at least one.\n\nFIXME: It would be nice to print the name of the component that\nyou want to find in the error messages, but it doesn't appear\nto be available.\n\n      type: (type) ->\n        @bind (component) =>\n          nodes = @reactUtils.scryRenderedComponentsWithType(component, type)\n          messages = [\n            \"Expected to find a React component, but it was not there.\"\n            \"Expected not to find a React component, but there #{@was(nodes.length)}.\"\n          ]\n          if nodes.length > 0\n            @return(nodes, messages)\n          else\n            @return(null, messages)\n\nExport our matchers from this file.\n\n    module.exports = ComponentQuery\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c830e36fac3ca1ca99e2c4c4215602f3749a8df9","subject":"default value invalid fix","message":"default value invalid fix\n","repos":"vpj\/models","old_file":"js\/properties\/value.litcoffee","new_file":"js\/properties\/value.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#List\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       @default 'value', (str) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value) -> \"#{str}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value) -> (value is @schema.default())\n\n       parse: (data) ->\n        r = super data\n        return r unless r is true\n        if not @schema.valid data\n         return @error 'invalid'\n\n        res =\n         score: 1\n         errors: []\n         value: @schema.value data\n\n        return res\n\n       toJSON: (value) -> value\n       toJSONFull: (value) -> value\n\n       edit: (elem, value, changed) ->\n        new Edit this, elem, value, changed\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, changed) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = changed\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = @value\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n        @change()\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r in results\n          e = @div r\n          e._result = r\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @elems.search.style.display = 'none'\n        @change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 100\n\n       @listen 'change', (e) ->\n        @search()\n        @change()\n\n       change: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#List\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       @default 'value', (str) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value) -> \"#{str}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value) -> (value is @schema.default())\n\n       parse: (data) ->\n        r = super data\n        return r unless r is true\n        if not @schema.valid data\n         return @error 'invalid'\n\n        res =\n         score: 1\n         errors: []\n         value: @schema.value data\n\n        return res\n\n       toJSON: (value) -> value\n       toJSONFull: (value) -> value\n\n       edit: (elem, value, changed) ->\n        new Edit this, elem, value, changed\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, changed) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = changed\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = @value\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r in results\n          e = @div r\n          e._result = r\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @on.change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 100\n\n       @listen 'change', (e) ->\n        @search()\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9dc0e95697f841be6610167851146139294b8386","subject":"link to Set, add constructor and isDirty","message":"link to Set, add constructor and isDirty\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n\n        @validate 'title', 'body', {presence: true} # title and body must be present (not undefined nor '')\n        @validate 'body', {minLength: 10}           # body must be 10 characters long at least\n        @validate 'title', {pattern: \/^[A-Z]\/}      # Title must start with an uppercase letter\n        @validate 'author', {email: true}           # the author field must contain a valid email address\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n + `regexp : \/regexp\/` : Assert that the value is matching the provided regular expression.\n + `email : true` : Assert that the value is an email address, per the [W3C HTML5 definition](http:\/\/www.w3.org\/TR\/html5\/forms.html#valid-e-mail-address).\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::%isDirty : Boolean\n\nReturns `true` if any keys have been changed since the record was initialized or saved.\n\n## ::%dirtyKeys : Set\n\nThe [`Batman.Set`](\/docs\/api\/batman.set.html) of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::constructor(idOrAttributes = {}) : Model\n\nReturns a new `Batman.Model`. If `idOrAttributes` is an object, the values are mixed into the new record. Otherwise, `idOrAttrubutes` is set to the new record's [`id`](\/docs\/api\/batman.model.html#prototype_accessor_id).\n\n## ::isNew() : boolean\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# \/api\/App Components\/Batman.Model\/Batman.Validator\n\nbatman.js ships with a plethora of [built-in validators](\/docs\/api\/batman.model.html#class_function_validate), but when they don't meet your needs, you can create custom validators by subclassing `Batman.Validator`, implementing `Batman.Validator::validateEach`, and adding the new validator to `Batman.Validators`. For example:\n\n```coffeescript\nclass App.LessThanPropertyValidator extends Batman.Validator\n  @triggers 'lessThanProperty'\n  @options 'allowBlank'\n\n  validateEach: (errors, record, key, callback) ->\n      value = record.get(key)\n      compareKey = @options.lessThanProperty\n      otherValue = record.get(compareKey)\n      else !@handleBlank(value) && value >= otherValue\n        errors.add(key, 'must be less than #{compareKey}')\n      callback()\n\nBatman.Validators.push App.LessThanPropertyValidator\n```\n\n## ::constructor(options : Object[, mixins...])\n\nThe first argument becomes the validator's `@options`. Subsequent arguments are mixed in to the validator with `Batman.Object::mixin`. You can override this method to alter the options object before it's assigned to `@options`. (Make sure to call `super` afterwards!)\n\n## @triggers(triggers...)\n\nWhen any of the strings in `triggers` is passed to `Model@validate`:\n\n- this validator will be instantiated and its `validateEach` will be invoked\n- the key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUse this method when one validator will handle many kinds of validations. For example, a simplified length validator:\n\n```coffeescript\nclass App.SimpleLengthValidator extends Batman.Validator\n  @triggers 'minLength', 'maxLength', 'length'\n\n  constructor: (options) ->\n    # has access to options.minLength, options.maxLength, options.length\n    super\n\n  validateEach: (errors, record, key, callback) ->\n    # has access to @options.minLength, @options.maxLength, @options.length\n```\n\nAll three of these validations will be handled by `App.SimpleLengthValidator::validateEach`:\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @validate 'name', minLength: 3\n  @validate 'bio', maxLength: 250\n  @validate 'phone_number', length: 10\n```\n\n## @options(options...)\n\nThe key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUnlike `@triggers`, the presence of a key in `options` will not cause this validator to be instantiated.\n\n## ::validateEach(errors: Batman.ErrorsSet, record: Batman.Model, key: String, callback: Function)\n\nThis method is invoked to validate `key` on `record`. If this method determins that the key is invalid, it should add a validation error to `errors`.\n\n`errors` is a `Batman.ErrorsSet`, which is a [`Batman.Set`](\/docs\/api\/batman.set.html) with `::add(key, message)` as a convenience method for adding [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s. So, to easily add a new validation error:\n\n```coffeescript\nerrors.add(\"phone_number\", \"isn't 10 characters long\")\n```\n\nWhen the validator is finished, it must call `callback` to continue the validation chain.\n\n## @handleBlank(value)\n\nReturns `true` if `options.allowBlank` is `true` _and_ `value` is `null`, `undefined` or `\"\"`\n\n# \/api\/App Components\/Batman.Model\/Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n\n        @validate 'title', 'body', {presence: true} # title and body must be present (not undefined nor '')\n        @validate 'body', {minLength: 10}           # body must be 10 characters long at least\n        @validate 'title', {pattern: \/^[A-Z]\/}      # Title must start with an uppercase letter\n        @validate 'author', {email: true}           # the author field must contain a valid email address\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n + `regexp : \/regexp\/` : Assert that the value is matching the provided regular expression.\n + `email : true` : Assert that the value is an email address, per the [W3C HTML5 definition](http:\/\/www.w3.org\/TR\/html5\/forms.html#valid-e-mail-address).\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::%dirtyKeys : Set\n\nThe set of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## @constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# \/api\/App Components\/Batman.Model\/Batman.Validator\n\nbatman.js ships with a plethora of [built-in validators](\/docs\/api\/batman.model.html#class_function_validate), but when they don't meet your needs, you can create custom validators by subclassing `Batman.Validator`, implementing `Batman.Validator::validateEach`, and adding the new validator to `Batman.Validators`. For example:\n\n```coffeescript\nclass App.LessThanPropertyValidator extends Batman.Validator\n  @triggers 'lessThanProperty'\n  @options 'allowBlank'\n\n  validateEach: (errors, record, key, callback) ->\n      value = record.get(key)\n      compareKey = @options.lessThanProperty\n      otherValue = record.get(compareKey)\n      else !@handleBlank(value) && value >= otherValue\n        errors.add(key, 'must be less than #{compareKey}')\n      callback()\n\nBatman.Validators.push App.LessThanPropertyValidator\n```\n\n## ::constructor(options : Object[, mixins...])\n\nThe first argument becomes the validator's `@options`. Subsequent arguments are mixed in to the validator with `Batman.Object::mixin`. You can override this method to alter the options object before it's assigned to `@options`. (Make sure to call `super` afterwards!)\n\n## @triggers(triggers...)\n\nWhen any of the strings in `triggers` is passed to `Model@validate`:\n\n- this validator will be instantiated and its `validateEach` will be invoked\n- the key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUse this method when one validator will handle many kinds of validations. For example, a simplified length validator:\n\n```coffeescript\nclass App.SimpleLengthValidator extends Batman.Validator\n  @triggers 'minLength', 'maxLength', 'length'\n\n  constructor: (options) ->\n    # has access to options.minLength, options.maxLength, options.length\n    super\n\n  validateEach: (errors, record, key, callback) ->\n    # has access to @options.minLength, @options.maxLength, @options.length\n```\n\nAll three of these validations will be handled by `App.SimpleLengthValidator::validateEach`:\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @validate 'name', minLength: 3\n  @validate 'bio', maxLength: 250\n  @validate 'phone_number', length: 10\n```\n\n## @options(options...)\n\nThe key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUnlike `@triggers`, the presence of a key in `options` will not cause this validator to be instantiated.\n\n## ::validateEach(errors: Batman.ErrorsSet, record: Batman.Model, key: String, callback: Function)\n\nThis method is invoked to validate `key` on `record`. If this method determins that the key is invalid, it should add a validation error to `errors`.\n\n`errors` is a `Batman.ErrorsSet`, which is a [`Batman.Set`](\/docs\/api\/batman.set.html) with `::add(key, message)` as a convenience method for adding [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s. So, to easily add a new validation error:\n\n```coffeescript\nerrors.add(\"phone_number\", \"isn't 10 characters long\")\n```\n\nWhen the validator is finished, it must call `callback` to continue the validation chain.\n\n## @handleBlank(value)\n\nReturns `true` if `options.allowBlank` is `true` _and_ `value` is `null`, `undefined` or `\"\"`\n\n# \/api\/App Components\/Batman.Model\/Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5b75398f72d397076ece1d3641043d4b2ad94289","subject":"Let's go a bit more crazy with literate coffeescript.","message":"Let's go a bit more crazy with literate coffeescript.\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/policies.litcoffee","new_file":"guts\/policies.litcoffee","new_contents":"Policies\n--------\nThis is the glue-file that manages how user-policies (e.g. who's allowed to do what) get defined.  This file is responsible for grabbing the \n\nLoad in the required libraries\n\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n\nLoad up the user-defined policies. \n\n    policies = require '..\/config\/policies'\n\n\nStart the function.  We're expecting an array of objects with the fields `actionName` and `controllerName`, and the node `req` and `res` objects just in case the policies need them.\n\n    module.exports = (routeActions, req, res) ->\n\nWe want to reject or resolve the promise based on whether or not someone is allowed to do something.  Therefore, it'd be smart to wrap this in a promise.\n\n        new Promise (resolve, reject) ->\n\nLet's load up the helper function that grabs all the policy files.  This function was arguably useful in its own right, so it made sense to make it its own separate module. \n\n            require('.\/getPolicies')()\n\nOnce the policies are done loading, we can move on. \n\n            .then (actualPolicies) ->\n\nSince there is an array routeActions (purposefully), we need to loop through them, and since we need the result afterwards, we can use a map.  Also, since there is a small risk of a couple nested arrays (due to the way that the policies have been implemented, lets flatten it after we're done. \n                \n                policyResults = _.flatten _.map routeActions, (action) ->\n\n                    \nWhat I'm doing here is looking for the policies file.\nIf there is a policy defined for that action, use that, else use the * catch all.\n\nThe flatten is necessary simply because I don't want to punish people for only listing one policy outside of an array.  Subsequently, we'll wrap everything in an array and then flatten it. \n\n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\nThis is pretty straightforward; we'll loop up the policy in the hash\ntable and then return back their result (which can just be a true or false\n\nWe want to make sure this is properly wrapped in promisey stuff, so we can init\nan empty promise then run our stuff in the \"then\". Since our empty promise only\nresolves, it won't hit the catch. \n\n                        _.map tempPolicies, (policy) ->\n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n\nOnce all the policy promises have resolved, let's return out response.\n                \n                Promise.all policyResults\n                .then (results) ->\n                    # Not entirely sure I like this logic, but it's pretty straightforward:\n                    # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                    # either allow the policy to reject if not permitted or to simply return false. \n                    unless false in results\n                      resolve true\n                    else\n                      reject \"Not Authorized\"\n                \n","old_contents":"Policies\n--------\nThis is the glue-file that manages how user-policies (e.g. who's allowed to do what) get defined.  This file is responsible for grabbing the \n\nLoad in the required libraries\n\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n\nLoad up the user-defined policies. \n\n    policies = require '..\/config\/policies'\n\n\n\n    module.exports = (routeActions, req, res) ->\n        new Promise (resolve, reject) ->\n            require('.\/getPolicies')()\n            .then (actualPolicies) ->\n                policyResults = _.flatten _.map routeActions, (action) ->\n\nWhat I'm doing here is looking for the policies file.\nIf there is a policy defined for that action, use that, else use the * catch all. \n\n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\n                        _.map tempPolicies, (policy) ->\n                            # This is pretty straightforward; we'll loop up the policy in the hash\n                            # table and then return back their result (which can just be a true or false\n                            #\n                            # We want to make sure this is properly wrapped in promisey stuff, so we can init\n                            # an empty promise then run our stuff in the \"then\". Since our empty promise only\n                            # resolves, it won't hit the catch. \n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n                \n                Promise.all policyResults\n            .then (results) ->\n                # Not entirely sure I like this logic, but it's pretty straightforward:\n                # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                # either allow the policy to reject if not permitted or to simply return false. \n                unless false in results\n                  resolve true\n                else\n                  reject \"Not Authorized\"\n                \n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"f4e8861f3f3dc8d20dcd43d68b42da86ffc72b62","subject":"fix limit to 10 posts; close #9","message":"fix limit to 10 posts; close #9\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"server\/publications.litcoffee","new_file":"server\/publications.litcoffee","new_contents":"# Publications\n\n    Meteor.publish 'queueMeta', ->\n      QueueMeta.find()\n    Meteor.publish 'top10Posts', ->\n      Posts.find {}, {sort: {ticketNumber: -1}, limit: 10 }\n","old_contents":"# Publications\n\n    Meteor.publish 'queueMeta', ->\n      QueueMeta.find()\n    Meteor.publish 'top10Posts', ->\n      Posts.find {}, {sort: ticketNumber: -1}, limit: 10\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"085e0cd5bec2fd69bdb038acbbf65155a2b5f6bd","subject":"modify readme","message":"modify readme\n","repos":"babascript\/babaspec","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"=======\nbabaspec: Test framework for human and real-world.\n========\n\n\ntest framework using babascript\n\n- \u4eba\u306e\u6319\u52d5\u3092\u8a18\u8ff0\u3059\u308bDSL Babascript\u3092\u5229\u7528\u3057\u305f\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af\n- \u4eba\u306e\u30b9\u30da\u30c3\u30af\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3057\u3001\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306b\u306a\u308b\n\n## Background\n\n\u30d7\u30ed\u30b0\u30e9\u30e0\u306f\u3001\u305d\u306e\u30d7\u30ed\u30b0\u30e9\u30e0\u304c\u3069\u306e\u3088\u3046\u306b\u52d5\u4f5c\u3059\u308b\u3079\u304d\u304b\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3057\u3001\u30c6\u30b9\u30c8\u3059\u308b\u3002\n\u30d7\u30ed\u30b0\u30e9\u30e0\u304c\u30c6\u30b9\u30c8\u3067\u304d\u308b\u5bfe\u8c61\u306f\u30d7\u30ed\u30b0\u30e9\u30e0\u306e\u307f\u3067\u3042\u308b\u304c\u3001\u4eba\u3084\u5b9f\u4e16\u754c\u3068\u3044\u3046\u8981\u7d20\u3092\u3082\u30c6\u30b9\u30c8\u3057\u305f\u3044\u306f\u305a\u3060\u3002\n\u3057\u304b\u3057\u3001\u4eba\u306e\u30b9\u30da\u30c3\u30af\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u5b9a\u7fa9\u3057\u3001\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306a\u4ed5\u7d44\u307f\u306f\u306a\u3044\u3002\n\u305d\u3053\u3067\u3001\u672c\u7814\u7a76\u3067\u306f\u3001\u4eba\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u5b9a\u7fa9\u3057\u3066\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306a\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af Babaspec \u3092\u63d0\u6848\u3059\u308b\u3002\n\n## Babaspec\n\nBabaspec\u306f\u3001\u4eba\u3078\u306e\u884c\u52d5\u547d\u4ee4\u3092\u30d7\u30ed\u30b0\u30e9\u30e0\u4e0a\u3067\u8a18\u8ff0\u53ef\u80fd\u306b\u3059\u308b Babascript \u3068 node.js\u4e0a\u3067\u5229\u7528\u53ef\u80fd\u306a\n\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af mocha \u3092\u7d44\u307f\u5408\u308f\u305b\u308b\u3002\n\n    describe \"baba spec test\", ->\n\n      it \"should return true\", ->\n\n        # \u4eba\u9593\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3059\u308b\n        baba = new Babaspec \"baba\"\n\n        baba.equal \"\u30d7\u30ed\u30b0\u30e9\u30e0\u304c\u66f8\u3051\u307e\u3059\u304b\", true # format is boolean\n        baba.notEqual \"hoge\", 'are' # format is string\n        baba.lt \"\u4f55\u6b73\u3067\u3059\u304b\", 20 # format is number\n        # fomat List \u306e\u5834\u5408\u3092\u3069\u3046\u3059\u308b\u304b\n        baba.equal baba.\u9078\u3093\u3067\u304f\u3060\u3055\u3044({formatL list, list: [1,2,3]}), [1,2] # format is list?\n\n        # \u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3059\u308b\n        world = new Babaspec \"real-world\", \"name\"\n        world.equal \"SFC\u306e\u3059\u3050\u8fd1\u304f\", true\n\n\n## \u8b70\u8ad6\n\n## \u95a2\u9023\u7814\u7a76\n\n- \u4eba\u3068\u304b\u5b9f\u4e16\u754c\u3092\u30c6\u30b9\u30c8\u3059\u308b\u3088\u3046\u306a\u4ed5\u7d44\u307f\u3042\u308b\uff1f\n\n## \u304a\u308f\u308a\u306b","old_contents":"=======\nbabaspec: Test framework for human and real-world.\n========\n\n\ntest framework using babascript\n\n- \u4eba\u306e\u6319\u52d5\u3092\u8a18\u8ff0\u3059\u308bDSL Babascript\u3092\u5229\u7528\u3057\u305f\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af\n- \u4eba\u306e\u30b9\u30da\u30c3\u30af\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3057\u3001\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306b\u306a\u308b\n\n## Background\n\n\u30d7\u30ed\u30b0\u30e9\u30e0\u306f\u3001\u305d\u306e\u30d7\u30ed\u30b0\u30e9\u30e0\u304c\u3069\u306e\u3088\u3046\u306b\u52d5\u4f5c\u3059\u308b\u3079\u304d\u304b\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3057\u3001\u30c6\u30b9\u30c8\u3059\u308b\u3002\n\u30d7\u30ed\u30b0\u30e9\u30e0\u304c\u30c6\u30b9\u30c8\u3067\u304d\u308b\u5bfe\u8c61\u306f\u30d7\u30ed\u30b0\u30e9\u30e0\u306e\u307f\u3067\u3042\u308b\u304c\u3001\u4eba\u3084\u5b9f\u4e16\u754c\u3068\u3044\u3046\u8981\u7d20\u3092\u3082\u30c6\u30b9\u30c8\u3057\u305f\u3044\u306f\u305a\u3060\u3002\n\u3057\u304b\u3057\u3001\u4eba\u306e\u30b9\u30da\u30c3\u30af\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u5b9a\u7fa9\u3057\u3001\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306a\u4ed5\u7d44\u307f\u306f\u306a\u3044\u3002\n\u305d\u3053\u3067\u3001\u672c\u7814\u7a76\u3067\u306f\u3001\u4eba\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u5b9a\u7fa9\u3057\u3066\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306a\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af Babaspec \u3092\u63d0\u6848\u3059\u308b\u3002\n\n## Babaspec\n\nBabaspec\u306f\u3001\u4eba\u3078\u306e\u884c\u52d5\u547d\u4ee4\u3092\u30d7\u30ed\u30b0\u30e9\u30e0\u4e0a\u3067\u8a18\u8ff0\u53ef\u80fd\u306b\u3059\u308b Babascript \u3068 node.js\u4e0a\u3067\u5229\u7528\u53ef\u80fd\u306a\n\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af mocha \u3092\u7d44\u307f\u5408\u308f\u305b\u308b\u3002\n\n    describe \"baba spec test\", ->\n\n      it \"should return true\", ->\n\n        baba = new Babaspec \"baba\"\n\n        baba.boolean.equal '\u3053\u3093\u3070\u3093\u308f', true\n        baba.string '\u304a\u306f\u3088\u3046', '\u304a\u306f\u3088\u3046'\n        baba.number.notEqual '\u307b\u3052\u3075\u304c', 10\n        baba.list [1,2,3,4], '\u3048\u3089\u3093\u3067', 1\n\n        baba.equal {format: 'boolean', key: 'hoge'}, true\n        baba.notEqual {format: 'string', key: 'are'}, 'kore'\n\n        world = new Babaspec \"real-world\", \"name\"\n\n        world.equal \"SFC\u306e\u3059\u3050\u8fd1\u304f\", true\n\n        assert.equal baba.hogefuga({format: 'list'}, \"hoge\"), \"fuga\"\n\n## \u8b70\u8ad6\n\n## \u95a2\u9023\u7814\u7a76\n\n- \u4eba\u3068\u304b\u5b9f\u4e16\u754c\u3092\u30c6\u30b9\u30c8\u3059\u308b\u3088\u3046\u306a\u4ed5\u7d44\u307f\u3042\u308b\uff1f\n\n## \u304a\u308f\u308a\u306b","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6ab24b4f7bbf4e099ca1dce1c641586d99024938","subject":"Fix link again","message":"Fix link again\n","repos":"ygt-mikekchar\/react-maybe-matchers,ygt-mikekchar\/react-maybe-matchers","old_file":"src\/pluralize.litcoffee","new_file":"src\/pluralize.litcoffee","new_contents":"# String#pluralize method\n\nMany of the tests need to output plural versions of\nobjects.  This is just a handy utility to help with that.\n\n## Examples\n\n```\n\"one #{'bucket'.pluralize(1)}\"            # == \"one bucket\"\n\"five #{'bucket'.pluralize(5)}\"           # == \"five buckets\"\n\"two #{'mommy'.pluralize(2, 'mommies')}\"  # == \"two mommies\"\n\"there #{'was'.pluralize(1, 'were')} one\" # == \"there was one\"\n```\n\n[specs](..\/spec\/pluralize_spec.litcoffee)\n\n    String.prototype.pluralize = (num, plural) ->\n      return this if num == 1\n      if plural? then plural else \"#{this}s\"\n","old_contents":"# String#pluralize method\n\nMany of the tests need to output plural versions of\nobjects.  This is just a handy utility to help with that.\n\n## Examples\n\n```\n\"one #{'bucket'.pluralize(1)}\"            # == \"one bucket\"\n\"five #{'bucket'.pluralize(5)}\"           # == \"five buckets\"\n\"two #{'mommy'.pluralize(2, 'mommies')}\"  # == \"two mommies\"\n\"there #{'was'.pluralize(1, 'were')} one\" # == \"there was one\"\n```\n\n[specs](.\/spec\/pluralize_spec.litcoffee)\n\n    String.prototype.pluralize = (num, plural) ->\n      return this if num == 1\n      if plural? then plural else \"#{this}s\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d12910352788a7003d083b62bfd9221826a49b10","subject":"respond callback","message":"respond callback\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end callback\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end callback\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options) ->\n      @errorCallback 'AJAX cannot respond', data\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"52268192f2cf0711db514f3b35521c0c8fd6584c","subject":"style","message":"style\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/11_associations.litcoffee","new_file":"docs\/11_associations.litcoffee","new_contents":"# Batman.Model Associations\nBatman associations are modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). There are 3 types of assocations available on `Batman.Model`: [`hasMany`](\/docs\/api\/batman.model_associations.html#class_function_hasmany), [`belongsTo`](\/docs\/api\/batman.model_associations.html#class_function_belongsto), and [`hasOne`](\/docs\/api\/batman.model_associations.html#class_function_hasone). Batman also supports polymorphic associations through the use of [polymorphic-specific options](\/docs\/api\/batman.model_associations.html#polymorphic_association_options).\n\nTo add associations to your models, declare them in your model definition. Association functions take a label (string) and options (Object). The label names the association and is used to provide smart defaults for several options. All available options are [detailed below](\/docs\/api\/batman.model_associations.html#association_options).\n\nFor example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', inverseOf: 'parentItem', encoderKey: 'children'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItem'\n```\n\nThen, associated records will be available via accessors:\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n\n  child.set('parentItem', parent)\n  child.get('parentItem') # => parent\n```\n\nor,\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n  secondChild = new App.ChildItem\n  parent.get('childItems').add(child)\n  parent.get('childItems').add(secondChild)\n  parent.get('childItems') # => Batman.AssociationSet\n  parent.get('childItems.length') # => 2\n```\n\n## @hasMany(label : string [, options : Object])\n`hasMany` expresses a one-to-many relationship on a `Batman.Model`.\n\n## @hasOne(label : string [, options : Object])\n`hasOne` expresses a one-to-one relationship on a `Batman.Model` when this model contains the primary key (eg, `id`) and does not contain the foreign key. If this model contains the foreign key, use `belongsTo` instead.\n\n## @belongsTo(label : string [, options : Object])\n`belongsTo` expresses a one-to-one relationship on a `Batman.Model` when this model contains the foreign key (eg, `parent_id`). If the other model contains the foreign key, use `hasOne` instead.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.AssociationSet` or `Batman.Model`. Generally they will return a `Batman.AssocationProxy` named after the association type, such as `Batman.BelongsToAssociationProxy` or `Batman.HasOneAssociationProxy`.\n\n\n## ::load(callback : Function)\nCalled to load the associated record from storage, setting it as  [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target). If a callback is passed, it is called with two arguments: any error and the loaded record. Also, when this function finishes, it sets [`loaded`](\/docs\/api\/batman.model_associations.html#prototype_accessor_loaded) to `true` and fires `loaded` on the record.\n\n## ::toJSON() : Object\nReturns JSON for the target record, if the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) is present.\n\n## ::%target\nThe associated record. Getting `target` does not implicitly call `load` on the association.\n\n## ::%loaded\n`true` or `false`, whether or not the record has been loaded from storage.\n\n## ::fetchFromLocal()\nThis method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). If this method returns a falsy value, then [`fetchFromRemote`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromremote) is called.  `Batman.AssocationProxy` subclasses must implement this method.\n\n## ::fetchFromRemote([callback : Function])\nIf [`fetchFromLocal`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromlocal) returns a falsy value, this method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). The `callback` is called with two arguments: any error and the fetched record(s). `Batman.AssocationProxy` subclasses must implement this method.\n\n## Association Options\n\n##### `primaryKey[= \"id\"] : string`\nThe primary key for the association.\n\n##### `foreignKey[= \"#{label}_id\"] : string`\nThe foreign key for the association.\n\n##### `saveInline[= true] : boolean`\nIf true, this model's attributes will be included in the associated model's JSON. This means that when an associated record is saved, this record's attributes will be included in the JSON.\n\n##### `autoload[= true] : boolean`\nIf `true`, Batman will automatically call `load` when the associated records are accessed. This is useful in view bindings, where binding to the associated records will automatically cause them to be loaded.\n\n##### `nestUrl[= false] : boolean`\nIf `true`, this model's URL will be nested under the associated model:\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', nestUrl: true\n\n# ...\n\nchild = new ChildItem(parent_id: 1, id: 5)\nchild.url() # => 'parent_items\/1\/child_items\/5'\n```\n\n`nestUrl` only applies if the model is persisted with `Batman.RestStorage` (or a subclass).\n\n##### `name : string`\nBy default, Batman checks for a model with the singular, camel-case name of association's `label` attached to `Batman.currentApp`. If the associated model's name is different from that, use `name` to specify it.\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem' # automatically finds App.ParentItem\n  @belongsTo 'alternativeParentItem', name: 'ParentItem' # also finds App.ParentItem\n```\n\n##### `inverseOf : string`\nThe foreign association to set on load. If the associated model has an association with the same name as the `inverseOf` value, it will be populated when data is loaded from storage. For example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true, inverseOf: 'parentItem'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItems'\n```\n\nwould allow:\n\n```coffeescript\nApp.ParentItem.find 1, (err, parent) ->\n  children = parent.get('childItems')\n  children.get('first.parentItem') == parent # => true\n\nApp.ChildItem.find 5, (err, childItem) ->\n  childItem.get('parentItem').load (err, parent) ->\n    parent.get('childItems').has(childItem) # => true\n```\n\n##### `encoderKey[= label] : string`\nKey where attributes for associated records will be found.\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', encoderKey: 'children'\n```\n\nwill correctly decode this JSON:\n\n```javascript\n{id: 1, children: [{ id: 5, parent_id: 1 }, {id: 6, parent_id: 1}]}\n```\n\nIt will also encode the `childItems` as `children` (unless `saveInline` is set to `false`).\n\n##### `namespace[= Batman.currentApp] : string`\nBatman expects to find a model with the given `name` on `Batman.currentApp`. If your model is defined elsewhere, use `namespace` to specify where the model is defined.\n\n```coffeescript\nclass App.Admin.Person extends Batman.Model\n  @belongsTo 'organization', namespace: App.Admin # finds App.Admin.Organization instead of App.Organization\n```\n\n## Polymorphic Association Options\nBatman also supports [polymorphic associations](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations). For example:\n\n```coffeescript\nclass App.Superpower extends Batman.Model\n  @encode 'name'\n  @belongsTo 'superpowerable', polymorphic: true\n\nclass App.Hero extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n\nclass App.Villain extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n```\nBy default, attributes of the polymorphic association will be encoded according to the label. So, `hero.toJSON()` might return:\n\n```javascript\n{ id: 1,\n  name: 'Superman',\n  superpowers: [\n    {id: 15, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Super Strength'},\n    {id: 16, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Invincibility'},\n  ]\n}\n```\n\n##### `polymorphic[= false] : boolean`\nWhether the association is [polymorphic](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations).\n\n##### `as : string`\nSpecifies the name of the polymorphic interface.\n\n##### `foreignTypeKey[= \"#{label}_type\"] : string`\nSpecifies the field which contains the `type` for a polymorphic record.\n\n##### `encodeForeignTypeKey[=true] : boolean`\nSpecifies whether the `foreignTypeKey` should be included in the JSON of the record.\n","old_contents":"# Batman.Model Associations\n\nThere are 3 types of assocations available on `Batman.Model`: [`hasMany`](\/docs\/api\/batman.model_associations.html#class_function_hasmany), [`belongsTo`](\/docs\/api\/batman.model_associations.html#class_function_belongsto), and [`hasOne`](\/docs\/api\/batman.model_associations.html#class_function_hasone). They're modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). Batman also supports polymorphic associations through the use of [polymorphic-specific options](\/docs\/api\/batman.model_associations.html#polymorphic_association_options).\n\nTo add associations to your models, declare them in your model definition. Association functions take a label (string) and options (Object). The label names the association and is used to provide smart defaults for several options. All available options are [detailed below](\/docs\/api\/batman.model_associations.html#association_options).\n\nFor example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', inverseOf: 'parentItem', encoderKey: 'children'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItem'\n```\n\nThen, associated records will be available via accessors:\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n\n  child.set('parentItem', parent)\n  child.get('parentItem') # => parent\n```\n\nor,\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n  secondChild = new App.ChildItem\n  parent.get('childItems').add(child)\n  parent.get('childItems').add(secondChild)\n  parent.get('childItems') # => Batman.AssociationSet\n  parent.get('childItems.length') # => 2\n```\n\n## @hasMany(label : string [, options : Object])\n`hasMany` expresses a one-to-many relationship on a `Batman.Model`.\n\n## @hasOne(label : string [, options : Object])\n`hasOne` expresses a one-to-one relationship on a `Batman.Model` when this model contains the primary key (eg, `id`) and does not contain the foreign key. If this model contains the foreign key, use `belongsTo` instead.\n\n## @belongsTo(label : string [, options : Object])\n`belongsTo` expresses a one-to-one relationship on a `Batman.Model` when this model contains the foreign key (eg, `parent_id`). If the other model contains the foreign key, use `hasOne` instead.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.AssociationSet` or `Batman.Model`. Generally they will return a `Batman.AssocationProxy` named after the association type, such as `Batman.BelongsToAssociationProxy` or `Batman.HasOneAssociationProxy`.\n\n\n## ::load(callback : Function)\nCalled to load the associated record from storage, setting it as  [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target). If a callback is passed, it is called with two arguments: any error and the loaded record. Also, when this function finishes, it sets [`loaded`](\/docs\/api\/batman.model_associations.html#prototype_accessor_loaded) to `true` and fires `loaded` on the record.\n\n## ::toJSON() : Object\nReturns JSON for the target record, if the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) is present.\n\n## ::%target\nThe associated record. Getting `target` does not implicitly call `load` on the association.\n\n## ::%loaded\n`true` or `false`, whether or not the record has been loaded from storage.\n\n## ::fetchFromLocal()\nThis method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). If this method returns a falsy value, then [`fetchFromRemote`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromremote) is called.  `Batman.AssocationProxy` subclasses must implement this method.\n\n## ::fetchFromRemote([callback : Function])\nIf [`fetchFromLocal`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromlocal) returns a falsy value, this method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). The `callback` is called with two arguments: any error and the fetched record(s). `Batman.AssocationProxy` subclasses must implement this method.\n\n## Association Options\n\n##### `primaryKey[= \"id\"] : string`\nThe primary key for the association.\n\n##### `foreignKey[= \"#{label}_id\"] : string`\nThe foreign key for the association.\n\n##### `saveInline[= true] : boolean`\nIf true, this model's attributes will be included in the associated model's JSON. This means that when an associated record is saved, this record's attributes will be included in the JSON.\n\n##### `autoload[= true] : boolean`\nIf `true`, Batman will automatically call `load` when the associated records are accessed. This is useful in view bindings, where binding to the associated records will automatically cause them to be loaded.\n\n##### `nestUrl[= false] : boolean`\nIf `true`, this model's URL will be nested under the associated model:\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', nestUrl: true\n\n# ...\n\nchild = new ChildItem(parent_id: 1, id: 5)\nchild.url() # => 'parent_items\/1\/child_items\/5'\n```\n\n`nestUrl` only applies if the model is persisted with `Batman.RestStorage` (or a subclass).\n\n##### `name : string`\nBy default, Batman checks for a model with the singular, camel-case name of association's `label` attached to `Batman.currentApp`. If the associated model's name is different from that, use `name` to specify it.\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem' # automatically finds App.ParentItem\n  @belongsTo 'alternativeParentItem', name: 'ParentItem' # also finds App.ParentItem\n```\n\n##### `inverseOf : string`\nThe foreign association to set on load. If the associated model has an association with the same name as the `inverseOf` value, it will be populated when data is loaded from storage. For example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true, inverseOf: 'parentItem'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItems'\n```\n\nwould allow:\n\n```coffeescript\nApp.ParentItem.find 1, (err, parent) ->\n  children = parent.get('childItems')\n  children.get('first.parentItem') == parent # => true\n\nApp.ChildItem.find 5, (err, childItem) ->\n  childItem.get('parentItem').load (err, parent) ->\n    parent.get('childItems').has(childItem) # => true\n```\n\n##### `encoderKey[= label] : string`\nKey where attributes for associated records will be found.\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', encoderKey: 'children'\n```\n\nwill correctly decode this JSON:\n\n```javascript\n{id: 1, children: [{ id: 5, parent_id: 1 }, {id: 6, parent_id: 1}]}\n```\n\nIt will also encode the `childItems` as `children` (unless `saveInline` is set to `false`).\n\n##### `namespace[= Batman.currentApp] : string`\nBatman expects to find a model with the given `name` on `Batman.currentApp`. If your model is defined elsewhere, use `namespace` to specify where the model is defined.\n\n```coffeescript\nclass App.Admin.Person extends Batman.Model\n  @belongsTo 'organization', namespace: App.Admin # finds App.Admin.Organization instead of App.Organization\n```\n\n## Polymorphic Association Options\nBatman also supports [polymorphic associations](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations). For example:\n\n```coffeescript\nclass App.Superpower extends Batman.Model\n  @encode 'name'\n  @belongsTo 'superpowerable', polymorphic: true\n\nclass App.Hero extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n\nclass App.Villain extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n```\nBy default, attributes of the polymorphic association will be encoded according to the label. So, `hero.toJSON()` might return:\n\n```javascript\n{ id: 1,\n  name: 'Superman',\n  superpowers: [\n    {id: 15, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Super Strength'},\n    {id: 16, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Invincibility'},\n  ]\n}\n```\n\n##### `polymorphic[= false] : boolean`\nWhether the association is [polymorphic](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations).\n\n##### `as : string`\nSpecifies the name of the polymorphic interface.\n\n##### `foreignTypeKey[= \"#{label}_type\"] : string`\nSpecifies the field which contains the `type` for a polymorphic record.\n\n##### `encodeForeignTypeKey[=true] : boolean`\nSpecifies whether the `foreignTypeKey` should be included in the JSON of the record.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d98a38fae42f9741448062ea98824b540eab32c6","subject":"\tmodified:   repeat.litcoffee","message":"\tmodified:   repeat.litcoffee\n","repos":"ai10\/repeat-component","old_file":"repeat.litcoffee","new_file":"repeat.litcoffee","new_contents":"Repeat helper\n===\n\n     Template.repeat.__items = (parent)->\n         $first = this[0]\n         index = 0\n         end = this.length-1\n         $last = this[end]\n         items = _.map this, (i)->\n             obj = {}\n             if i is null\n                 obj.$value = null\n             else if typeof i is 'object'\n                 obj = i\n             else\n                 obj.$value = i\n             unless parent is null\n                 obj.__proto__ = parent\n             if 0 < index < end\n                 obj.$middle = true\n             else\n                 obj.$middle = false\n             obj.$first = $first\n             obj.$last = $last\n             if (index%2 is 0) \n                 obj.$even = true \n                 obj.$odd = false\n             else\n                 obj.$odd = true\n                 obj.$even = false\n             obj.$index = index++\n             obj\n\n         items\n\n     Template.for = Template.repeat\n\n","old_contents":"Repeat helper\n===\n\n     Template.repeat.__items = (parent)->\n         $first = this[0]\n         index = 0\n         end = this.length-1\n         $last = this[end]\n         items = _.map this, (i)->\n             obj = {}\n             if i is null\n                 obj.$value = null\n             else if typeof i is 'object'\n                 obj = i\n             else\n                 obj.$value = i\n             \n             unless parent is null\n                 obj.__proto__ = parent\n             \n             if 0 < index < end\n                 obj.$middle = true\n             else\n                 obj.$middle = false\n\n             obj.$index = index++\n             obj.$first = $first\n             obj.$last = $last\n             if (index%2 is 0) \n                 obj.$even = true \n                 obj.$odd = false\n             else\n                 obj.$odd = true\n                 obj.$even = false\n             \n             obj\n\n         items\n\n     Template.for = Template.repeat\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"523895e4df3840e934bc5e389f1f8c64459af2e7","subject":"Update String.litcoffee","message":"Update String.litcoffee","repos":"modulexcite\/fluentnode,o2platform\/fluentnode,o2platform\/fluentnode,modulexcite\/fluentnode","old_file":"src\/String.litcoffee","new_file":"src\/String.litcoffee","new_contents":"Methods that extend the native Javascript String class\n\ndependencies\n\n    crypto = require('crypto')\n\nmethods\n\n@.**append** value\n\n    String::append = (value)->\n        @ + if value then value else ''\n\n@.**add_Random_Chars** size\n\n    String::add_Random_Chars     = (size )-> @ + crypto.randomBytes(size || 10)\n\n@.**add_Random_String** size\n    \n    String::add_Random_String    = (size )-> @ + crypto.randomBytes(size || 10).toString('hex').slice(0,size|| 10)\n\n@.**add_Random_Letters** size    \n    \n    String::add_Random_Letters   = (size )->\n                                             charSet = 'abcdefghijklmnopqrstuvwxyz'\n                                             @ + (charSet[Math.floor(Math.random() * charSet.length)]  for i in [1..size]).join('')\n\n@.**add_5_Random_Letters** \n                                             \n    String::add_5_Random_Letters = (     )-> @.add_Random_Letters(5)\n\n@.**add_Random_Numbers** size     \n    \n    String::add_Random_Numbers   = (size )->\n                                             charSet = '0123456789'\n                                             @ + (charSet[Math.floor(Math.random() * charSet.length)]  for i in [1..size]).join('')\n\n@.**after** value\n                                             \n    String::after                = (value)-> if ((index = @.indexOf(    value)) == -1 ) then '' else @.substr(index + value.size())\n    \n@.**after_Last** value  \n    \n    String::after_Last           = (value)-> if ((index = @.lastIndexOf(value)) == -1 ) then '' else @.substr(index + value.size())\n    \n@.**before** value\n    \n    String::before               = (value)-> @.substring(0,@.indexOf(value))\n\n@.**before_Last** value\n\n    String::before_Last          = (value)-> @.substring(0,@.lastIndexOf(value))\n\n@.**contains** value\n\nChecks that ```value``` is inside @.\n\nIf ```value``` is an Array, then all elements are expected to be found inside @\n\nIf ```value``` is an RegExp then checks if it matches @\n\n\n    String::contains = (value)->\n        if value instanceof RegExp\n            regex = new RegExp(value)\n            return regex.exec(@) isnt null\n        if value instanceof Array\n            for item in value\n                if @.indexOf(item) == -1\n                    return false\n            return true\n        @.indexOf(value) > -1\n\n\n    String::ends_With            = (value)-> if not value then false else @.toString().slice(-value.length)==value\n    String::lower                = (     )-> @.toLowerCase()\n    String::not_Contains         = (value)-> @.indexOf(value) == -1\n    String::size                 = (     )-> @.length\n    String::starts_With          = (value)-> if not value then false else @.toString().slice(0,value.length)==value\n    String::trim                 = (     )-> @.replace(\/^\\s+|\\s+$\/g, '')\n    String::upper                = (     )-> @.toUpperCase()\n\n---\nback to [index](index.html)\n","old_contents":"Methods that extend the native Javascript String class\n\ndependencies\n\n    crypto = require('crypto')\n\nmethods\n\n@.**append** value\n\n    String::append = (value)->\n        @ + if value then value else ''\n\n@.**add_Random_Chars** size\n\n    String::add_Random_Chars     = (size )-> @ + crypto.randomBytes(size || 10)\n    String::add_Random_String    = (size )-> @ + crypto.randomBytes(size || 10).toString('hex').slice(0,size|| 10)\n    String::add_Random_Letters   = (size )->\n                                             charSet = 'abcdefghijklmnopqrstuvwxyz'\n                                             @ + (charSet[Math.floor(Math.random() * charSet.length)]  for i in [1..size]).join('')\n    String::add_5_Random_Letters = (     )-> @.add_Random_Letters(5)\n    String::add_Random_Numbers   = (size )->\n                                             charSet = '0123456789'\n                                             @ + (charSet[Math.floor(Math.random() * charSet.length)]  for i in [1..size]).join('')\n    String::after                = (value)-> if ((index = @.indexOf(    value)) == -1 ) then '' else @.substr(index + value.size())\n    String::after_Last           = (value)-> if ((index = @.lastIndexOf(value)) == -1 ) then '' else @.substr(index + value.size())\n    String::before               = (value)-> @.substring(0,@.indexOf(value))\n    String::before_Last          = (value)-> @.substring(0,@.lastIndexOf(value))\n\n@.**contains** value\n\nChecks that ```value``` is inside @.\n\nIf ```value``` is an Array, then all elements are expected to be found inside @\n\nIf ```value``` is an RegExp then checks if it matches @\n\n\n    String::contains = (value)->\n        if value instanceof RegExp\n            regex = new RegExp(value)\n            return regex.exec(@) isnt null\n        if value instanceof Array\n            for item in value\n                if @.indexOf(item) == -1\n                    return false\n            return true\n        @.indexOf(value) > -1\n\n\n    String::ends_With            = (value)-> if not value then false else @.toString().slice(-value.length)==value\n    String::lower                = (     )-> @.toLowerCase()\n    String::not_Contains         = (value)-> @.indexOf(value) == -1\n    String::size                 = (     )-> @.length\n    String::starts_With          = (value)-> if not value then false else @.toString().slice(0,value.length)==value\n    String::trim                 = (     )-> @.replace(\/^\\s+|\\s+$\/g, '')\n    String::upper                = (     )-> @.toUpperCase()\n\n---\nback to [index](index.html)","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"35cc1b039c613e785e6665cbce15b4d4d7706b46","subject":"docs(document): reformat variable names and data type annotation","message":"docs(document): reformat variable names and data type annotation\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/model\/Document.litcoffee","new_file":"coffee\/model\/Document.litcoffee","new_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n    collections = require('..\/helper\/schema').types\n\n---\n\n## Class: Doc\n\n### Params\n\n* **string** `type` - document type\n* **string** `id` - document id\n\n### Return\n\nNew `Doc`.\n\n---\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n      @db   = mongo[type]\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n      @type = type\n      @data = {}\n      @chit = false\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if Object.keys(data).length\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n## Doc.exists\n\nCheck if document exists.\n\n### Return\n\nReturns `true` if document exists; otherwise `false`.\n\n---\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n## Doc.getId\n\nGet document id (ObjectID) for current document.\n\n### Return\n\nReturns an `ObjectID` if the document has an id; otherwise `null`.\n\n---\n\n    Doc.prototype.getId = ->\n      @id\n\n\n## Doc.wasCacheHit\n\nCheck if document request was a cache hit.\n\n### Return\n\nReturns `true` if document request was a cache hit; otherwise `false`.\n\n---\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n## Doc.isNotModifiedSince\n\nCheck if document has not been modified since a given timestamp.\n\n### Params\n\n* **string** `time` - timestamp to check against.\n\n### Return\n\nReturns `true` if document has not been modified since given tmestamp; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make unix timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n## doc.isMatch\n\nCheck if checksum, or Etag, matche current document checksum.\n\n### Params\n\n* **string** `checksum` - checksum to check against.\n\n### Return\n\nReturns `true` if checksum matches the current checksum; otherwise `false`.\n\n---\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n## doc.isNoneMatch\n\nCheck if checksum, or Etag, doesnt match current document checksum.\n\n### Params\n\n* **string** `checksum` - checksum to check against.\n\n### Return\n\nReturn `true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n## Doc.get\n\nGet cached data for current document.\n\n### Params\n\n* **string** `key` - get specific object property\n\n### Return\n\nReturns an `object` if `key` is `undefined`; otherwise `string`. Will retur\n`undefined` if the given key does not exist.\n\n---\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n## doc.getFull\n\n### Params\n\n* **object** `filter` - control which object properties are returned\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n## doc.getFuller\n\n### Params\n\n* **object** `filter` - control which object properties are returned\n* **array** `expand` - sub-document property names to expand\n* **object** `query` - query for expanded sub-documents\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFuller = (filter, expand, query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      count = 0\n      mapped = {}\n\nSince `expand` might be a user supplied input parameter we need to limit it to\nproperties which are expandable (eg. `collections`). We also remove properties\nwhich holds no value for this document.\n\n      expand = expand\n        .filter (v) => @data[v] and v in collections\n\nNext we map the string array into an object array on the following format:\n`{ type: String, ids: Array }` where `ids` are ObjectIDs to an document of the\ncollection `type`.\n\n        .map (v) => type: v, ids: @data[v].map (d) -> new ObjectID d\n\nSet up a `final` function which is called when expanded data is ready to be\nmapped to the original document.\n\n      final = () =>\n        @db.findOne _id: @id, filter, (err, doc) ->\n          cb err, Object.assign doc or {}, mapped\n\nIf there are no fields to expand, we just call the `final` function instantly\nand no fields will get expanded.\n\n      return final() if expand.length is 0\n\nSet up a `next` function which is called for each expanded data returned from\nthe database. Expanded data is stored in the `mapped` object which is merged\nwith the main document in `final`. When all expanded fields are mapped `final`\nis called.\n\n      next = (type, _, docs) ->\n        mapped[type] = docs or []\n        return final() if Object.keys(mapped).length == expand.length\n\nGet the expanded sub-documents from the database.\n\n      expand.forEach (x) ->\n        mongo[x.type]\n\nWe find the sub-documents using the ObjectIDs in the expanded fields, that is\nthe easy part. The tricky part is to prevent information leackage of private\ndocuments. This the second part is a `query` limiting the results to public\ndocuments or those owned by the current API user.\n\n          .find Object.assign {_id: $in: x.ids}, query\n\nWe reuse the projection filter from the original document, but since we do not\nknow in advanced who owns a given sub-document we remove the `private` property\nto prevent information leakage.\n\n          .project Object.assign filter, privat: false\n\nBundle all the sub-documents in one array and pass it to the `next` function.\n\n          .toArray next.bind null, x.type\n\n\n## Doc.insert\n\nInserts a document into databse.\n\n### Params\n\n* **object** `data` - data to insert for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.replace\n\nReplaces all document data in database.\n\n### Params\n\n* **object** `data` - replacement data for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          data._id = @id\n          cb err, warn, data\n\n\n## Doc.update\n\nPartially update the document-data in database. This is some times referred to as\nPATCH in a HTTP \/ REST context.\n\n### Params\n\n* **object** `data` - replacement object for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n## Doc.delete\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n### Params\n\n* **function** `cb` - callback function (**Error** `err`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet', endret: new Date()\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n\n","old_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n    collections = require('..\/helper\/schema').types\n\n---\n\n## Class: Doc\n\n### Params\n\n* `string` type - document type\n* `string` id - document id\n\n### Return\n\nNew `Doc`.\n\n---\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n      @db   = mongo[type]\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n      @type = type\n      @data = {}\n      @chit = false\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if Object.keys(data).length\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n## Doc.exists\n\nCheck if document exists.\n\n### Return\n\nReturns `true` if document exists; otherwise `false`.\n\n---\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n## Doc.getId\n\nGet document id (ObjectID) for current document.\n\n### Return\n\nReturns an `ObjectID` if the document has an id; otherwise `null`.\n\n---\n\n    Doc.prototype.getId = ->\n      @id\n\n\n## Doc.wasCacheHit\n\nCheck if document request was a cache hit.\n\n### Return\n\nReturns `true` if document request was a cache hit; otherwise `false`.\n\n---\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n## Doc.isNotModifiedSince\n\nCheck if document has not been modified since a given timestamp.\n\n### Params\n\n* `string` time - timestamp to check against.\n\n### Return\n\nReturns `true` if document has not been modified since given tmestamp; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make unix timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n## doc.isMatch\n\nCheck if checksum, or Etag, matche current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturns `true` if checksum matches the current checksum; otherwise `false`.\n\n---\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n## doc.isNoneMatch\n\nCheck if checksum, or Etag, doesnt match current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturn `true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n## Doc.get\n\nGet cached data for current document.\n\n### Params\n\n* `string` key - get specific object property\n\n### Return\n\nReturns an `object` if `key` is `undefined`; otherwise `string`. Will retur\n`undefined` if the given key does not exist.\n\n---\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n## doc.getFull\n\n### Params\n\n* `object` filter - control which object properties are returned\n* `function` cb - callback function (`Error` err, `object` data)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n## doc.getFuller\n\n### Params\n\n* `object` filter - control which object properties are returned\n* `array` expand -\n* `object` query -\n* `function` cb - callback function (`Error` err, `object` data)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFuller = (filter, expand, query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      count = 0\n      mapped = {}\n\nSince `expand` might be a user supplied input parameter we need to limit it to\nproperties which are expandable (eg. `collections`). We also remove properties\nwhich holds no value for this document.\n\n      expand = expand\n        .filter (v) => @data[v] and v in collections\n\nNext we map the string array into an object array on the following format:\n`{ type: String, ids: Array }` where `ids` are ObjectIDs to an document of the\ncollection `type`.\n\n        .map (v) => type: v, ids: @data[v].map (d) -> new ObjectID d\n\nSet up a `final` function which is called when expanded data is ready to be\nmapped to the original document.\n\n      final = () =>\n        @db.findOne _id: @id, filter, (err, doc) ->\n          cb err, Object.assign doc or {}, mapped\n\nIf there are no fields to expand, we just call the `final` function instantly\nand no fields will get expanded.\n\n      return final() if expand.length is 0\n\nSet up a `next` function which is called for each expanded data returned from\nthe database. Expanded data is stored in the `mapped` object which is merged\nwith the main document in `final`. When all expanded fields are mapped `final`\nis called.\n\n      next = (type, _, docs) ->\n        mapped[type] = docs or []\n        return final() if Object.keys(mapped).length == expand.length\n\nGet the expanded sub-documents from the database.\n\n      expand.forEach (x) ->\n        mongo[x.type]\n\nWe find the sub-documents using the ObjectIDs in the expanded fields, that is\nthe easy part. The tricky part is to prevent information leackage of private\ndocuments. This the second part is a `query` limiting the results to public\ndocuments or those owned by the current API user.\n\n          .find Object.assign {_id: $in: x.ids}, query\n\nWe reuse the projection filter from the original document, but since we do not\nknow in advanced who owns a given sub-document we remove the `private` property\nto prevent information leakage.\n\n          .project Object.assign filter, privat: false\n\nBundle all the sub-documents in one array and pass it to the `next` function.\n\n          .toArray next.bind null, x.type\n\n\n## Doc.insert\n\nInserts a document into databse.\n\n### Params\n\n* `object` data - data to insert for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.replace\n\nReplaces all document data in database.\n\n### Params\n\n* `object` data - replacement data for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          data._id = @id\n          cb err, warn, data\n\n\n## Doc.update\n\nPartially update the document-data in database. This is some times refered to as\nPATCH in a HTTP \/ REST context.\n\n### Params\n\n* `object` data - replacement object for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n## Doc.delete\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n### Params\n\n* `function`  cb - callback function (`Error` err).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet', endret: new Date()\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ae737775635504bbd54003597219c25533cbcf13","subject":"Initial commit:100:","message":"Initial commit:100:\n\nOur thoughts inspired - by Albert Einstein.","repos":"BioQL\/BioQL,BioQL\/BioQL","old_file":"src\/pql\/readme.litcoffee","new_file":"src\/pql\/readme.litcoffee","new_contents":"pQL\u00ae: An efficient Proteome Query Language.\n-------------------------------------------\n[![Apache License](https:\/\/img.shields.io\/badge\/license-Apache-blue.svg)](https:\/\/github.com\/BioQL\/BioQL\/blob\/master\/LICENSE)\n\n<i>Great spirits have always encountered violent opposition from mediocre minds<\/i> - <b>Albert Einstein<\/b>.\n","old_contents":"pQL\u00ae: An efficient Proteome Query Language.\n-------------------------------------------\n[![Apache License](https:\/\/img.shields.io\/badge\/license-Apache-blue.svg)](https:\/\/github.com\/BioQL\/BioQL\/blob\/master\/LICENSE)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"570fcc5834cd1304066a7a748907d7724860cb1b","subject":"Fix for screwed up Config","message":"Fix for screwed up Config\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"client\/modules\/config.litcoffee","new_file":"client\/modules\/config.litcoffee","new_contents":"# Configuration system.\n\n*Handle getting, setting, and checking configuration state.*\n\n    module.exports = new class Config\n\nThis class allows us to wrap and subsequently get, set, and check the\nexistence of values in a configuration tree. The configuration tree may be\ntraversed with colons, e.g. `parent:child:grandchild`.\n\nSupposing we have a configuration structure:\n\n```coffeescript\nconfiguration =\n  visible: true\n  child: id: 200, tag: null\n```\n\nWe may wrap and interact with it as follows:\n\n```coffeescript\nwrapped = new Config configuration\nwrapped.get 'visible'\n```\n\nReturns: `true`\n\n```coffeescript\nwrapped.set 'child:name', 'Billy'\nwrapped.get 'child'\n```\n\nReturns: `{ id: 200, name: 'Billy' }`\n\n```coffeescript\nwrapped.has 'child:id'\n```\n\nReturns: `true`\n\n```coffeescript\nwrapped.has 'child:thing'\n```\n\nReturns: `false`\n\n`has` works with null values:\n\n```coffeescript\nwrapped.has 'child:tag'\n```\n\nReturns: `true`\n\n###### TODO: Is this necessary? If not, remove it.\n\n      Config: Config\n\n## *constructor*\n\n* (object) `config` - The configuration tree.\n\n*Create a configuration wrapper.*\n\n      constructor: (config = {}) -> @from config\n\n## Config#from\n\n* (object) `config` - The configuration object.\n\n*Set configuration from an object.*\n\n      from: (@config) ->\n\n## Config#get\n\n* (string) `key` - The key to look up, e.g. parent:child:grandchild\n\n*Get a value by key.*\n\n      get: (key) ->\n\n        current = @config\n        for part in key.split ':'\n          current = current?[part]\n        current\n\n## Config#has\n\n* (string) `key` - The key to look up, e.g. `'parent:child:grandchild'`\n\n*Check whether a key exists.*\n\n      has: (key) ->\n\n        current = @config\n        for part in key.split ':'\n          return false unless part of current\n          current = current[part]\n\n        return true\n\n## Config#set\n\n* (string) `key` - The key to look up, e.g. parent:child:grandchild\n* (any) `value` - The value to store at the key location.\n\n*Set a value by key.*\n\n      set: (key, value) ->\n\n        [parts..., last] = key.split ':'\n        current = @config\n        for part in parts\n          current = (current[part] ?= {})\n\n        current[last] = value\n\n## Config#toJSON\n\n*Return config object for serialization.*\n\n      toJSON: -> @config\n","old_contents":"# Configuration system.\n\n*Handle getting, setting, and checking configuration state.*\n\n    module.exports = new class Config\n\nThis class allows us to wrap and subsequently get, set, and check the\nexistence of values in a configuration tree. The configuration tree may be\ntraversed with colons, e.g. `parent:child:grandchild`.\n\nSupposing we have a configuration structure:\n\n```coffeescript\nconfiguration =\n  visible: true\n  child: id: 200, tag: null\n```\n\nWe may wrap and interact with it as follows:\n\n```coffeescript\nwrapped = new Config configuration\nwrapped.get 'visible'\n```\n\nReturns: `true`\n\n```coffeescript\nwrapped.set 'child:name', 'Billy'\nwrapped.get 'child'\n```\n\nReturns: `{ id: 200, name: 'Billy' }`\n\n```coffeescript\nwrapped.has 'child:id'\n```\n\nReturns: `true`\n\n```coffeescript\nwrapped.has 'child:thing'\n```\n\nReturns: `false`\n\n`has` works with null values:\n\n```coffeescript\nwrapped.has 'child:tag'\n```\n\nReturns: `true`\n\n###### TODO: Is this necessary? If not, remove it.\n\n    @Config = Config\n\n## *constructor*\n\n* (object) `config` - The configuration tree.\n\n*Create a configuration wrapper.*\n\n      constructor: (config = {}) -> @from config\n\n## Config#from\n\n* (object) `config` - The configuration object.\n\n*Set configuration from an object.*\n\n      from: (@config) ->\n\n## Config#get\n\n* (string) `key` - The key to look up, e.g. parent:child:grandchild\n\n*Get a value by key.*\n\n      get: (key) ->\n\n        current = @config\n        for part in key.split ':'\n          current = current?[part]\n        current\n\n## Config#has\n\n* (string) `key` - The key to look up, e.g. `'parent:child:grandchild'`\n\n*Check whether a key exists.*\n\n      has: (key) ->\n\n        current = @config\n        for part in key.split ':'\n          return false unless part of current\n          current = current[part]\n\n        return true\n\n## Config#set\n\n* (string) `key` - The key to look up, e.g. parent:child:grandchild\n* (any) `value` - The value to store at the key location.\n\n*Set a value by key.*\n\n      set: (key, value) ->\n\n        [parts..., last] = key.split ':'\n        current = @config\n        for part in parts\n          current = (current[part] ?= {})\n\n        current[last] = value\n\n## Config#toJSON\n\n*Return config object for serialization.*\n\n      toJSON: -> @config\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b1caad927e5b4580e576185a038b19318c04f972","subject":"call onerror","message":"call onerror\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        self.port.onerror? e\n      0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"44719fa731efd1ebf41369f37128969646647ec2","subject":"user.save() doesn't return a user object now? Oh well.","message":"user.save() doesn't return a user object now? Oh well.\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-user\/index.litcoffee","new_file":"packages\/shrub-user\/index.litcoffee","new_contents":"# User\n\n*User operations.*\n\n    passport = null\n    Promise = null\n\n    {Middleware} = require 'middleware'\n\n    {monkeyPatchLogin} = require '.\/login'\n\n    orm = null\n\n    clientModule = require '.\/client'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCorePreBootstrap`.\n\n      registrar.registerHook 'shrubCorePreBootstrap', ->\n\n        passport = require 'passport'\n        Promise = require 'bluebird'\n\n        orm = require 'shrub-orm'\n\n#### Implements hook `shrubConfigClient`.\n\n      registrar.registerHook 'shrubConfigClient', (req) ->\n\nSend a redacted version of the request user.\n\n        req.user.redactFor req.user if req.user?\n\n#### Implements hook `shrubAuditFingerprint`.\n\n      registrar.registerHook 'shrubAuditFingerprint', (req) ->\n\nUser (ID).\n\n        user: if req?.user?.id? then req.user.id\n\n#### Implements hook `shrubHttpMiddleware`.\n\n      registrar.registerHook 'shrubHttpMiddleware', ->\n\n        label: 'Load user using passport'\n        middleware: userMiddleware()\n\n#### Implements hook `shrubOrmCollections`.\n\n      registrar.registerHook 'shrubOrmCollections', ->\n\n        crypto = require 'server\/crypto'\n\n        autoIname = (values, cb) ->\n          values.iname = values.name.toLowerCase()\n          cb()\n\nInvoke the client hook implementation.\n\n        collections = clientModule.shrubOrmCollections()\n\n        {\n          'shrub-group': Group\n          'shrub-group-permission': GroupPermission\n          'shrub-user': User\n          'shrub-user-group': UserGroup\n          'shrub-user-permission': UserPermission\n        } = collections\n\n###### TODO: Finish collections doc.\n\nCase-insensitivized name.\n\n        Group.attributes.iname =\n          type: 'string'\n          size: 24\n          index: true\n\n        Group.autoCreatedAt = false\n        Group.autoUpdatedAt = false\n\n        Group.beforeCreate = autoIname\n        Group.beforeUpdate = autoIname\n\n        GroupPermission.autoCreatedAt = false\n        GroupPermission.autoUpdatedAt = false\n\n        User.beforeCreate = autoIname\n        User.beforeUpdate = autoIname\n\nCase-insensitivized name.\n\n        User.attributes.iname =\n          type: 'string'\n          size: 24\n          index: true\n\nHash of the plaintext password.\n\n        User.attributes.passwordHash =\n          type: 'string'\n\nA token which can be used to reset the user's password (once).\n\n        User.attributes.resetPasswordToken =\n          type: 'string'\n          size: 48\n          index: true\n\nA 512-bit salt used to cryptographically hash the user's password.\n\n        User.attributes.salt =\n          type: 'string'\n          size: 128\n\nUpdate a user's last accessed time. Return the user for chaining.\n\n        User.attributes.touch = ->\n          @lastAccessed = (new Date()).toISOString()\n          this\n\n        User.attributes.populateAll = ->\n          self = this\n\n          Group_ = orm.collection 'shrub-group'\n\n          @permissions = @permissions.map ({permission}) -> permission\n\n          promises = for {group}, index in @groups\n            do (group, index) ->\n              Group_.findOne(id: group).populateAll().then (group_) ->\n                self.groups[index] = group_\n\n          Promise.all(promises).then -> self\n\n        User.attributes.toJSON = ->\n          O = @toObject()\n          O.groups = @groups\n          O.permissions = @permission\n          O\n\n## User#register\n\n* (string) `name` - Name of the new user.\n* (string) `email` - Email address of the new user.\n* (string) `password` - The new user's password.\n\n*Register a user in the system.*\n\n        User.register = (name, email, password) ->\n\n          @create(name: name).then((user) ->\n\nEncrypt the email.\n\n            crypto.encrypt(email.toLowerCase()).then((encryptedEmail) ->\n\n              user.email = encryptedEmail\n\nSet the password encryption details.\n\n              crypto.hasher plaintext: password\n\n            ).then((hashed) ->\n\n              user.plaintext = hashed.plaintext\n              user.salt = hashed.salt.toString 'hex'\n              user.passwordHash = hashed.key.toString 'hex'\n\nGenerate a one-time login token.\n\n              crypto.randomBytes 24\n\n            ).then((token) ->\n\n              user.resetPasswordToken = token.toString 'hex'\n              user.save()\n\n            ).then -> return user\n          )\n\n        User.redactors = [(redactFor) ->\n          self = this\n\n          delete self.iname\n          delete self.plaintext if self.plaintext?\n          delete self.salt\n          delete self.passwordHash\n          delete self.resetPasswordToken\n\n          for group in self.groups\n\n            for permission in group.permissions ? []\n\n              delete permission.group\n              delete permission.id\n\n            delete group.iname\n            delete group.id\n\n          Promise.resolve().then ->\n            return unless self.email?\n\nDifferent redacted means full email redaction.\n\n            if redactFor.id isnt self.id\n              delete self.email\n              return\n\nDecrypt the e-mail if redacting for the same user.\n\n            crypto.decrypt(self.email).then (email) ->\n              self.email = email\n\n        ]\n\n        UserGroup.autoCreatedAt = false\n        UserGroup.autoUpdatedAt = false\n\n        UserGroup.attributes.populateAll = ->\n          self = this\n\n          Group_ = orm.collection 'shrub-group'\n          Group_.findOne(id: self.group).populateAll().then (group_) ->\n            self.group = group_\n\n            return self\n\n        UserGroup.attributes.depopulateAll = ->\n          @group = @group.id\n\n          return this\n\n        UserPermission.autoCreatedAt = false\n        UserPermission.autoUpdatedAt = false\n\n        collections\n\n#### Implements hook `shrubOrmCollectionsAlter`.\n\n      registrar.registerHook 'shrubOrmCollectionsAlter', (collections) ->\n        clientModule.shrubOrmCollectionsAlter collections\n\n        for identity, collection of collections\n          do (identity, collection) ->\n\n            collection.redactors ?= []\n            collection.attributes.redactFor = (user) ->\n              redacted = @toJSON()\n              redacted.toJSON = undefined\n\n              Promise.all(\n                for redactor in collection.redactors\n                  redactor.call redacted, user\n              ).then -> redacted\n\n#### Implements hook `shrubConfigServer`.\n\n      registrar.registerHook 'shrubConfigServer', ->\n\n        beforeLoginMiddleware: []\n\n        afterLoginMiddleware: []\n\n        beforeLogoutMiddleware: [\n          'shrub-user'\n        ]\n\n        afterLogoutMiddleware: [\n          'shrub-user'\n        ]\n\n#### Implements hook `shrubRpcRoutesAlter`.\n\n      registrar.registerHook 'shrubRpcRoutesAlter', (routes) ->\n\n        {spliceRouteMiddleware} = require 'shrub-rpc'\n\n        loadUserMiddleware = (req, res, next) ->\n\n          req.loadUser = (done) -> req.loadSession ->\n\n            userMiddleware_ = new Middleware()\n            for fn in userMiddleware()\n              userMiddleware_.use fn\n\n            userMiddleware_.dispatch req, res, (error) ->\n              return next error if error?\n              done()\n\n          next()\n\n        loadUserMiddleware.weight = -4999\n\n        for path, route of routes\n          route.middleware.unshift loadUserMiddleware\n          spliceRouteMiddleware route, 'shrub-user', userMiddleware()\n\n        return\n\n#### Implements hook `shrubSocketConnectionMiddleware`.\n\n      registrar.registerHook 'shrubSocketConnectionMiddleware', ->\n\n        label: 'Load user using passport'\n\nJoin a channel for the username.\n\n        middleware: userMiddleware().concat (req, res, next) ->\n\n          return req.socket.join req.user.name, next if req.user.id?\n\n          next()\n\n#### Implements hook `shrubUserBeforeLogoutMiddleware`.\n\n      registrar.registerHook 'shrubUserBeforeLogoutMiddleware', ->\n\n        label: 'Tell client to log out, and leave the user channel'\n        middleware: [\n\n          (req, next) ->\n\n            return next() unless req.socket?\n\nTell client to log out.\n\n            req.socket.emit 'shrub-user\/logout'\n\nLeave the user channel.\n\n            if req.user.id?\n              req.socket.leave req.user.name, next\n            else\n              next()\n\n        ]\n\n#### Implements hook `shrubUserAfterLogoutMiddleware`.\n\n      registrar.registerHook 'shrubUserAfterLogoutMiddleware', ->\n\n        label: 'Instantiate anonymous user'\n        middleware: [\n\n          (req, next) ->\n            req.instantiateAnonymous().then(-> next()).catch next\n\n        ]\n\n      registrar.recur [\n        'forgot', 'login', 'logout', 'register', 'reset'\n      ]\n\n## loadByName\n\n(string) `name` - The name of the user to load.\n\n*Load a user by name.*\n\n    exports.loadByName = (name) ->\n\n      User = orm.collection 'shrub-user'\n      User.findOne(iname: name.toLowerCase()).populateAll()\n\n    userMiddleware = -> [\n\n      (req, res, next) ->\n\n        req.instantiateAnonymous = ->\n\n          @user = orm.collection('shrub-user').instantiate()\n\nAdd to anonymous group.\n\n          @user.groups = [\n            orm.collection('shrub-user-group').instantiate group: 2\n          ]\n\n          @user.populateAll()\n\n        next()\n\nPassport middleware.\n\n      passport.initialize()\n      passport.session()\n\nMonkey patch.\n\n      monkeyPatchLogin\n\nSet the user into the request.\n\n      (req, res, next) ->\n        promise = if req.user?\n          Promise.resolve()\n        else\n          req.instantiateAnonymous()\n\n        promise.then(-> next()).catch next\n\nSave the user at the end of the request.\n\n      (req, res, next) ->\n\n        end = res.end\n        res.end = (data, encoding) ->\n          res.end = end\n\n          return res.end data, encoding unless req.user.id\n\n          req.user.save().finally -> res.end data, encoding\n\n        next()\n\n    ]\n","old_contents":"# User\n\n*User operations.*\n\n    passport = null\n    Promise = null\n\n    {Middleware} = require 'middleware'\n\n    {monkeyPatchLogin} = require '.\/login'\n\n    orm = null\n\n    clientModule = require '.\/client'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCorePreBootstrap`.\n\n      registrar.registerHook 'shrubCorePreBootstrap', ->\n\n        passport = require 'passport'\n        Promise = require 'bluebird'\n\n        orm = require 'shrub-orm'\n\n#### Implements hook `shrubConfigClient`.\n\n      registrar.registerHook 'shrubConfigClient', (req) ->\n\nSend a redacted version of the request user.\n\n        req.user.redactFor req.user if req.user?\n\n#### Implements hook `shrubAuditFingerprint`.\n\n      registrar.registerHook 'shrubAuditFingerprint', (req) ->\n\nUser (ID).\n\n        user: if req?.user?.id? then req.user.id\n\n#### Implements hook `shrubHttpMiddleware`.\n\n      registrar.registerHook 'shrubHttpMiddleware', ->\n\n        label: 'Load user using passport'\n        middleware: userMiddleware()\n\n#### Implements hook `shrubOrmCollections`.\n\n      registrar.registerHook 'shrubOrmCollections', ->\n\n        crypto = require 'server\/crypto'\n\n        autoIname = (values, cb) ->\n          values.iname = values.name.toLowerCase()\n          cb()\n\nInvoke the client hook implementation.\n\n        collections = clientModule.shrubOrmCollections()\n\n        {\n          'shrub-group': Group\n          'shrub-group-permission': GroupPermission\n          'shrub-user': User\n          'shrub-user-group': UserGroup\n          'shrub-user-permission': UserPermission\n        } = collections\n\n###### TODO: Finish collections doc.\n\nCase-insensitivized name.\n\n        Group.attributes.iname =\n          type: 'string'\n          size: 24\n          index: true\n\n        Group.autoCreatedAt = false\n        Group.autoUpdatedAt = false\n\n        Group.beforeCreate = autoIname\n        Group.beforeUpdate = autoIname\n\n        GroupPermission.autoCreatedAt = false\n        GroupPermission.autoUpdatedAt = false\n\n        User.beforeCreate = autoIname\n        User.beforeUpdate = autoIname\n\nCase-insensitivized name.\n\n        User.attributes.iname =\n          type: 'string'\n          size: 24\n          index: true\n\nHash of the plaintext password.\n\n        User.attributes.passwordHash =\n          type: 'string'\n\nA token which can be used to reset the user's password (once).\n\n        User.attributes.resetPasswordToken =\n          type: 'string'\n          size: 48\n          index: true\n\nA 512-bit salt used to cryptographically hash the user's password.\n\n        User.attributes.salt =\n          type: 'string'\n          size: 128\n\nUpdate a user's last accessed time. Return the user for chaining.\n\n        User.attributes.touch = ->\n          @lastAccessed = (new Date()).toISOString()\n          this\n\n        User.attributes.populateAll = ->\n          self = this\n\n          Group_ = orm.collection 'shrub-group'\n\n          @permissions = @permissions.map ({permission}) -> permission\n\n          promises = for {group}, index in @groups\n            do (group, index) ->\n              Group_.findOne(id: group).populateAll().then (group_) ->\n                self.groups[index] = group_\n\n          Promise.all(promises).then -> self\n\n        User.attributes.toJSON = ->\n          O = @toObject()\n          O.groups = @groups\n          O.permissions = @permission\n          O\n\n## User#register\n\n* (string) `name` - Name of the new user.\n* (string) `email` - Email address of the new user.\n* (string) `password` - The new user's password.\n\n*Register a user in the system.*\n\n        User.register = (name, email, password) ->\n\n          @create(name: name).then((user) ->\n\nEncrypt the email.\n\n            crypto.encrypt(email.toLowerCase()).then((encryptedEmail) ->\n\n              user.email = encryptedEmail\n\nSet the password encryption details.\n\n              crypto.hasher plaintext: password\n\n            ).then((hashed) ->\n\n              user.plaintext = hashed.plaintext\n              user.salt = hashed.salt.toString 'hex'\n              user.passwordHash = hashed.key.toString 'hex'\n\nGenerate a one-time login token.\n\n              crypto.randomBytes 24\n\n            ).then (token) ->\n\n              user.resetPasswordToken = token.toString 'hex'\n\n              user.save()\n          )\n\n        User.redactors = [(redactFor) ->\n          self = this\n\n          delete self.iname\n          delete self.plaintext if self.plaintext?\n          delete self.salt\n          delete self.passwordHash\n          delete self.resetPasswordToken\n\n          for group in self.groups\n\n            for permission in group.permissions ? []\n\n              delete permission.group\n              delete permission.id\n\n            delete group.iname\n            delete group.id\n\n          Promise.resolve().then ->\n            return unless self.email?\n\nDifferent redacted means full email redaction.\n\n            if redactFor.id isnt self.id\n              delete self.email\n              return\n\nDecrypt the e-mail if redacting for the same user.\n\n            crypto.decrypt(self.email).then (email) ->\n              self.email = email\n\n        ]\n\n        UserGroup.autoCreatedAt = false\n        UserGroup.autoUpdatedAt = false\n\n        UserGroup.attributes.populateAll = ->\n          self = this\n\n          Group_ = orm.collection 'shrub-group'\n          Group_.findOne(id: self.group).populateAll().then (group_) ->\n            self.group = group_\n\n            return self\n\n        UserGroup.attributes.depopulateAll = ->\n          @group = @group.id\n\n          return this\n\n        UserPermission.autoCreatedAt = false\n        UserPermission.autoUpdatedAt = false\n\n        collections\n\n#### Implements hook `shrubOrmCollectionsAlter`.\n\n      registrar.registerHook 'shrubOrmCollectionsAlter', (collections) ->\n        clientModule.shrubOrmCollectionsAlter collections\n\n        for identity, collection of collections\n          do (identity, collection) ->\n\n            collection.redactors ?= []\n            collection.attributes.redactFor = (user) ->\n              redacted = @toJSON()\n              redacted.toJSON = undefined\n\n              Promise.all(\n                for redactor in collection.redactors\n                  redactor.call redacted, user\n              ).then -> redacted\n\n#### Implements hook `shrubConfigServer`.\n\n      registrar.registerHook 'shrubConfigServer', ->\n\n        beforeLoginMiddleware: []\n\n        afterLoginMiddleware: []\n\n        beforeLogoutMiddleware: [\n          'shrub-user'\n        ]\n\n        afterLogoutMiddleware: [\n          'shrub-user'\n        ]\n\n#### Implements hook `shrubRpcRoutesAlter`.\n\n      registrar.registerHook 'shrubRpcRoutesAlter', (routes) ->\n\n        {spliceRouteMiddleware} = require 'shrub-rpc'\n\n        loadUserMiddleware = (req, res, next) ->\n\n          req.loadUser = (done) -> req.loadSession ->\n\n            userMiddleware_ = new Middleware()\n            for fn in userMiddleware()\n              userMiddleware_.use fn\n\n            userMiddleware_.dispatch req, res, (error) ->\n              return next error if error?\n              done()\n\n          next()\n\n        loadUserMiddleware.weight = -4999\n\n        for path, route of routes\n          route.middleware.unshift loadUserMiddleware\n          spliceRouteMiddleware route, 'shrub-user', userMiddleware()\n\n        return\n\n#### Implements hook `shrubSocketConnectionMiddleware`.\n\n      registrar.registerHook 'shrubSocketConnectionMiddleware', ->\n\n        label: 'Load user using passport'\n\nJoin a channel for the username.\n\n        middleware: userMiddleware().concat (req, res, next) ->\n\n          return req.socket.join req.user.name, next if req.user.id?\n\n          next()\n\n#### Implements hook `shrubUserBeforeLogoutMiddleware`.\n\n      registrar.registerHook 'shrubUserBeforeLogoutMiddleware', ->\n\n        label: 'Tell client to log out, and leave the user channel'\n        middleware: [\n\n          (req, next) ->\n\n            return next() unless req.socket?\n\nTell client to log out.\n\n            req.socket.emit 'shrub-user\/logout'\n\nLeave the user channel.\n\n            if req.user.id?\n              req.socket.leave req.user.name, next\n            else\n              next()\n\n        ]\n\n#### Implements hook `shrubUserAfterLogoutMiddleware`.\n\n      registrar.registerHook 'shrubUserAfterLogoutMiddleware', ->\n\n        label: 'Instantiate anonymous user'\n        middleware: [\n\n          (req, next) ->\n            req.instantiateAnonymous().then(-> next()).catch next\n\n        ]\n\n      registrar.recur [\n        'forgot', 'login', 'logout', 'register', 'reset'\n      ]\n\n## loadByName\n\n(string) `name` - The name of the user to load.\n\n*Load a user by name.*\n\n    exports.loadByName = (name) ->\n\n      User = orm.collection 'shrub-user'\n      User.findOne(iname: name.toLowerCase()).populateAll()\n\n    userMiddleware = -> [\n\n      (req, res, next) ->\n\n        req.instantiateAnonymous = ->\n\n          @user = orm.collection('shrub-user').instantiate()\n\nAdd to anonymous group.\n\n          @user.groups = [\n            orm.collection('shrub-user-group').instantiate group: 2\n          ]\n\n          @user.populateAll()\n\n        next()\n\nPassport middleware.\n\n      passport.initialize()\n      passport.session()\n\nMonkey patch.\n\n      monkeyPatchLogin\n\nSet the user into the request.\n\n      (req, res, next) ->\n        promise = if req.user?\n          Promise.resolve()\n        else\n          req.instantiateAnonymous()\n\n        promise.then(-> next()).catch next\n\nSave the user at the end of the request.\n\n      (req, res, next) ->\n\n        end = res.end\n        res.end = (data, encoding) ->\n          res.end = end\n\n          return res.end data, encoding unless req.user.id\n\n          req.user.save().finally -> res.end data, encoding\n\n        next()\n\n    ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d49eb0c4979c7e8725edc5bdacf680a344d5df8a","subject":"remove router underscore dependency","message":"remove router underscore dependency\n","repos":"vpj\/weya,vpj\/weya","old_file":"router.litcoffee","new_file":"router.litcoffee","new_contents":"#Weya.Router.litcoffee\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n    if exports?\n     Weya = require '.\/weya'\n     Weya.Base = require '.\/weya_base'\n\n    if not Weya.Base?\n     throw new Error 'Weya.Base not found'\n\n##Weya.Router\n\nRouting with hash tags or pushState\n\n    class Router extends Weya.Base\n     optionalParam: \/\\((.*?)\\)\/g\n     namedParam: \/(\\(\\?)?:\\w+\/g\n     splatParam: \/\\*\\w+\/g\n     escapeRegExp: \/[\\-{}\\[\\]+?.,\\\\\\^$|#\\s]\/g\n\n     @extend()\n\n     @initialize ->\n      @_bindRoutes()\n      @_event = null\n      @_history = []\n\n     _routes: {}\n\n####Register router\n\n`'analyse\/:analysis': 'onAnalyse'`\n\n`dashboard': ['auth', 'dashboard']`\n\nThis will match urls of the form `analyse\/\\*` and call method @onAnalyse\nwith the parameter. Second route will first call @auth if it returns\n`true` @dashboard will be called.\n\nThe most specific route should be at bottom. Routers can added or overridden\nin subclasses\n\n     @routes: (routes) ->\n      temp = @::_routes\n      @::_routes = {}\n      @::_routes[k] = v for k, v of temp\n      @::_routes[k] = v for k, v of routes\n\n####Starts routing\nOption silent will not trigger an event for the current url\n\n     start: (options) ->\n      Weya.history.start options\n      fragment = Weya.history.getFragment()\n\n      if options?.silent is on\n       @_history.push fragment: fragment, title: document.title\n\n####Goes to previous page if exists\n\n     back: ->\n      if @_history.length > 1\n       Weya.history.back()\n\n####Whether it is possible to go to previous page\n\n     canBack: ->\n      if @_history.length > 1 and Weya.history.canBack()\n       return true\n      else\n       return false\n\n####Registers a route\n\n     route: (route, name) ->\n      if (Object.prototype.toString.call route) isnt '[object RegExp]'\n       route = @_routeToRegExp route\n\nRegisters the route with Weya.history\n\n      Weya.history.route route, (fragment, event) =>\n       args = @_extractParameters route, fragment\n       @_event = event\n\nHandle state\n\n       if @_event?.type is \"popstate\"\n        @_history.pop()\n        if @_history.length is 0\n         @_history.push\n          fragment: fragment\n          title: document.title\n          state: @getState()\n       else\n        @_history.push\n         fragment: fragment\n         title: document.title\n         state: @getState()\n\nCalls callbacks in order\n\n       callbacks = name\n       callbacks = [callbacks] if not Array.isArray callbacks\n\n       for callback in callbacks\n        if (typeof callback) is 'string'\n         callback = @[callback]\n        break unless callback.apply this, args\n\n####Gets the current HTML5 History state\n\n     getState: ->\n      if @_event?.originalEvent?.state?\n       return @_event.originalEvent.state\n      else\n       return null\n\n####Navigate to a new URL, while setting HTML5 History state\n\n     navigate: (fragment, options) ->\n      options = {} unless options\n      if options.replace\n       @_history.pop()\n      if not options.trigger\n       @_history.push\n        fragment: fragment\n        title: options.title\n        state: options.state\n\n      Weya.history.navigate fragment, options\n\nBind routes\n\n     _bindRoutes: ->\n      for route, name of @_routes\n       @route route, name\n\nConvert a route string into a regular expression, suitable for matching\n\n     _routeToRegExp: (route) ->\n      route = route.replace @escapeRegExp, '\\\\$&'\n                   .replace @noptionalParam, '(?:$1)?'\n                   .replace @namedParam, (match, optional) ->\n                    if optional then match else '([^\\\/]+)'\n                   .replace @splatParam, '(.*?)'\n\n       return new RegExp \"^#{route}$\"\n\nExtract parameters from a route regex and URL\n\n     _extractParameters: (route, fragment) ->\n      params = route.exec(fragment).slice(1)\n      for p, i in params when p?\n       params[i] = decodeURIComponent p\n\n## History class\n\n    class History extends Weya.Base\n     @extend()\n\nStrip leading hash\/slash and trailing space\n\n     routeStripper: \/^[#\\\/]|\\s+$\/g\n\nStrip leading and trailing slashes\n\n     rootStripper: \/^\\\/+|\\\/+$\/g\n\nRemove trailing slash\n\n     trailingSlash: \/\\\/$\/\n\nStrip urls of hash and query\n\n     pathStripper: \/[?#].*$\/\n\n     @initialize ->\n      @handlers = []\n      @checkUrl = @checkUrl.bind this\n      @history = window.history\n      @location = window.location\n      @stateList = []\n\nHash check interval\n\n     interval: 50\n\nGet hash value\n\n     getHash: ->\n      match = @location.href.match \/#(.*)$\/\n      return (if match? then match[1] else '')\n\nGet emulated state\n\n     getEmulateState: ->\n      if @stateList.length > 0\n       return @stateList[@stateList.length - 1]\n      else\n       return {fragment: \"\"}\n\n     popEmulateState: -> @stateList.pop()\n\n     pushEmulateState: (state, title, fragment) ->\n      @stateList.push\n       state: state\n       title: title\n       fragment: fragment\n\nGet the URL fragment\n\n     getFragment: (fragment, forcePushState) ->\n      if not fragment?\n       if @_emulateState\n        fragment = @getEmulateState().fragment\n       else if @_hasPushState or not @_wantsHashChange or forcePushState\n        fragment = @location.pathname\n        root = @root.replace @trailingSlash, ''\n        if (fragment.indexOf root) is 0\n         fragment = fragment.slice root.length\n       else\n        fragment = @getHash()\n\n      return fragment.replace @routeStripper, ''\n\n####Goto the previous page\n\n     back: ->\n      if @_emulateState is on\n       @popEmulateState()\n       @loadUrl null, null\n      else\n       @history?.back?()\n\n####Can back?\n\n     canBack: ->\n      if @_emulateState is on\n       return @stateList.length > 1\n      else\n       return @history?.back?\n\n####Start listening to events\n\n     start: (options) ->\n      History.started = true\n\n      opt = {root: '\/'}\n      opt[k] = v for k, v of @options\n      opt[k] = v for k, v of options\n      @options = opt\n      @root = @options.root\n      @_emulateState = @options.emulateState is on\n      @_wantsHashChange = @_emulateState is off and @options.hashChange isnt off\n      @_wantsPushState = @_emulateState is off and @options.pushState is on\n      @_hasPushState = @_wantsPushState is on and @history?.pushState?\n      if @_emulateState and @options.start?\n       @pushEmulateState @options.start.state,\n        @options.start.title\n        @options.start.fragment\n\n      @fragment = @getFragment()\n\nNormalize root to always include a leading and trailing slash.\n\n      @root = \"\/#{@root}\/\".replace @rootStripper, '\/'\n\nDepending on whether we're using pushState or hashes, and whether\n'onhashchange' is supported, determine how we check the URL state.\n\n      if @_hasPushState\n       $(window).on 'popstate', @checkUrl\n      else if @_wantsHashChange and window.onhashchange?\n       $(window).on 'hashchange', @checkUrl\n      else if @_wantsHashChange\n       @_checkUrlInterval = setInterval @checkUrl, @interval\n\n      if not @options.silent\n       @loadUrl null, null\n\n####Add a listener to a router\n\n     route: (route, callback) ->\n      @handlers.unshift route: route, callback: callback\n\nCheck current url for changes\n\n     checkUrl: (e) ->\n      fragment = @getFragment()\n      return if fragment is @fragment\n      @loadUrl fragment, e\n\nCall callbacks of matching route\n\n     loadUrl: (fragment, e) ->\n      fragment = @fragment = @getFragment fragment\n      for handler in @handlers\n       if handler.route.test fragment\n        return handler.callback fragment, e\n\n      return\n\n####Navigate to a URL\nTriggers a route is option trigger is on\nReplaces the url is option replace is on\nSets state and title\n\n     navigate: (fragment, options) ->\n      return false if not History.started\n\n      fragment = @getFragment(fragment or '')\n      url = @root + fragment\n\nStrip the fragment of the query and hash for matching.\n\n      fragment = fragment.replace @pathStripper, ''\n\n      return if @fragment is fragment\n      @fragment = fragment\n\nDon't include a trailing slash on the root.\n\n      if fragment is '' and url isnt '\/'\n       url = url.slice 0, -1\n\nIf pushState is available, we use it to set the fragment as a real URL.\n\n      if @_emulateState\n       if options.replace is on\n        @popEmulateState()\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @pushEmulateState state, title, fragment\n      else if @_hasPushState\n       method = if options.replace then 'replaceState' else 'pushState'\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @history[method] state, title, url\n\nIf hash changes haven't been explicitly disabled, update the hash\nfragment to store history.\n\n      else if @_wantsHashChange\n       @_updateHash @location, fragment, options.replace\n\nIf you've told us that you explicitly don't want fallback hashchange-\nbased history, then `navigate` becomes a page refresh.\n\n      else\n       return @location.assign url\n      if options.trigger\n       return @loadUrl fragment, null\n\nUpdate the hash\n\n     _updateHash: (location, fragment, replace) ->\n      if replace\n       href = location.href.replace \/(javascript:|#).*$\/, ''\n       location.replace \"#{href}##{fragment}\"\n      else\n       location.hash = \"##{fragment}\"\n\n    Weya.Router = Router\n    Weya.history = new History\n\n    if module?\n     module.exports = Weya.Router\n\n","old_contents":"#Weya.Router.litcoffee\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n    if exports?\n     Weya = require '.\/weya'\n     Weya.Base = require '.\/weya_base'\n\n    if not Weya.Base?\n     throw new Error 'Weya.Base not found'\n\n##Weya.Router\n\nRouting with hash tags or pushState\n\n    class Router extends Weya.Base\n     optionalParam: \/\\((.*?)\\)\/g\n     namedParam: \/(\\(\\?)?:\\w+\/g\n     splatParam: \/\\*\\w+\/g\n     escapeRegExp: \/[\\-{}\\[\\]+?.,\\\\\\^$|#\\s]\/g\n\n     @extend()\n\n     @initialize ->\n      @_bindRoutes()\n      @_event = null\n      @_history = []\n\n     _routes: {}\n\n####Register router\n\n`'analyse\/:analysis': 'onAnalyse'`\n\n`dashboard': ['auth', 'dashboard']`\n\nThis will match urls of the form `analyse\/\\*` and call method @onAnalyse\nwith the parameter. Second route will first call @auth if it returns\n`true` @dashboard will be called.\n\nThe most specific route should be at bottom. Routers can added or overridden\nin subclasses\n\n     @routes: (routes) ->\n      @::_routes = _.clone @::_routes\n      for k, v of routes\n       @::_routes[k] = v\n\n####Starts routing\nOption silent will not trigger an event for the current url\n\n     start: (options) ->\n      Weya.history.start options\n      fragment = Weya.history.getFragment()\n\n      if options?.silent is on\n       @_history.push fragment: fragment, title: document.title\n\n####Goes to previous page if exists\n\n     back: ->\n      if @_history.length > 1\n       Weya.history.back()\n\n####Whether it is possible to go to previous page\n\n     canBack: ->\n      if @_history.length > 1 and Weya.history.canBack()\n       return true\n      else\n       return false\n\n####Registers a route\n\n     route: (route, name) ->\n      (route = @_routeToRegExp route) if not _.isRegExp route\n\nRegisters the route with Weya.history\n\n      Weya.history.route route, (fragment, event) =>\n       args = @_extractParameters route, fragment\n       @_event = event\n\nHandle state\n\n       if @_event?.type is \"popstate\"\n        @_history.pop()\n        if @_history.length is 0\n         @_history.push\n          fragment: fragment\n          title: document.title\n          state: @getState()\n       else\n        @_history.push\n         fragment: fragment\n         title: document.title\n         state: @getState()\n\nCalls callbacks in order\n\n       callbacks = name\n       callbacks = [callbacks] if not Array.isArray callbacks\n\n       for callback in callbacks\n        if (typeof callback) is 'string'\n         callback = @[callback]\n        break unless callback.apply this, args\n\n####Gets the current HTML5 History state\n\n     getState: ->\n      if @_event?.originalEvent?.state?\n       return @_event.originalEvent.state\n      else\n       return null\n\n####Navigate to a new URL, while setting HTML5 History state\n\n     navigate: (fragment, options) ->\n      options = {} unless options\n      if options.replace\n       @_history.pop()\n      if not options.trigger\n       @_history.push\n        fragment: fragment\n        title: options.title\n        state: options.state\n\n      Weya.history.navigate fragment, options\n\nBind routes\n\n     _bindRoutes: ->\n      for route, name of @_routes\n       @route route, name\n\nConvert a route string into a regular expression, suitable for matching\n\n     _routeToRegExp: (route) ->\n      route = route.replace @escapeRegExp, '\\\\$&'\n                   .replace @noptionalParam, '(?:$1)?'\n                   .replace @namedParam, (match, optional) ->\n                    if optional then match else '([^\\\/]+)'\n                   .replace @splatParam, '(.*?)'\n\n       return new RegExp \"^#{route}$\"\n\nExtract parameters from a route regex and URL\n\n     _extractParameters: (route, fragment) ->\n      params = route.exec(fragment).slice(1)\n      return _.map params, (param) ->\n       if param then decodeURIComponent(param) else null\n\n## History class\n\n    class History extends Weya.Base\n     @extend()\n\nStrip leading hash\/slash and trailing space\n\n     routeStripper: \/^[#\\\/]|\\s+$\/g\n\nStrip leading and trailing slashes\n\n     rootStripper: \/^\\\/+|\\\/+$\/g\n\nRemove trailing slash\n\n     trailingSlash: \/\\\/$\/\n\nStrip urls of hash and query\n\n     pathStripper: \/[?#].*$\/\n\n     @initialize ->\n      @handlers = []\n      _.bindAll this, 'checkUrl'\n      @history = window.history\n      @location = window.location\n      @stateList = []\n\nHash check interval\n\n     interval: 50\n\nGet hash value\n\n     getHash: ->\n      match = @location.href.match \/#(.*)$\/\n      return (if match? then match[1] else '')\n\nGet emulated state\n\n     getEmulateState: ->\n      if @stateList.length > 0\n       return @stateList[@stateList.length - 1]\n      else\n       return {fragment: \"\"}\n\n     popEmulateState: -> @stateList.pop()\n\n     pushEmulateState: (state, title, fragment) ->\n      @stateList.push\n       state: state\n       title: title\n       fragment: fragment\n\nGet the URL fragment\n\n     getFragment: (fragment, forcePushState) ->\n      if not fragment?\n       if @_emulateState\n        fragment = @getEmulateState().fragment\n       else if @_hasPushState or not @_wantsHashChange or forcePushState\n        fragment = @location.pathname\n        root = @root.replace @trailingSlash, ''\n        if (fragment.indexOf root) is 0\n         fragment = fragment.slice root.length\n       else\n        fragment = @getHash()\n\n      return fragment.replace @routeStripper, ''\n\n####Goto the previous page\n\n     back: ->\n      if @_emulateState is on\n       @popEmulateState()\n       @loadUrl null, null\n      else\n       @history?.back?()\n\n####Can back?\n\n     canBack: ->\n      if @_emulateState is on\n       return @stateList.length > 1\n      else\n       return @history?.back?\n\n####Start listening to events\n\n     start: (options) ->\n      History.started = true\n\n      @options = _.extend {root: '\/'}, @options, options\n      @root = @options.root\n      @_emulateState = @options.emulateState is on\n      @_wantsHashChange = @_emulateState is off and @options.hashChange isnt off\n      @_wantsPushState = @_emulateState is off and @options.pushState is on\n      @_hasPushState = @_wantsPushState is on and @history?.pushState?\n      if @_emulateState and @options.start?\n       @pushEmulateState @options.start.state,\n        @options.start.title\n        @options.start.fragment\n\n      @fragment = @getFragment()\n\nNormalize root to always include a leading and trailing slash.\n\n      @root = \"\/#{@root}\/\".replace @rootStripper, '\/'\n\nDepending on whether we're using pushState or hashes, and whether\n'onhashchange' is supported, determine how we check the URL state.\n\n      if @_hasPushState\n       $(window).on 'popstate', @checkUrl\n      else if @_wantsHashChange and window.onhashchange?\n       $(window).on 'hashchange', @checkUrl\n      else if @_wantsHashChange\n       @_checkUrlInterval = setInterval @checkUrl, @interval\n\n      if not @options.silent\n       @loadUrl null, null\n\n####Add a listener to a router\n\n     route: (route, callback) ->\n      @handlers.unshift route: route, callback: callback\n\nCheck current url for changes\n\n     checkUrl: (e) ->\n      fragment = @getFragment()\n      return if fragment is @fragment\n      @loadUrl fragment, e\n\nCall callbacks of matching route\n\n     loadUrl: (fragment, e) ->\n      fragment = @fragment = @getFragment fragment\n      return _.any this.handlers, (handler) ->\n       if handler.route.test fragment\n        handler.callback fragment, e\n        return true\n       else\n        return false\n\n####Navigate to a URL\nTriggers a route is option trigger is on\nReplaces the url is option replace is on\nSets state and title\n\n     navigate: (fragment, options) ->\n      return false if not History.started\n\n      fragment = @getFragment(fragment or '')\n      url = @root + fragment\n\nStrip the fragment of the query and hash for matching.\n\n      fragment = fragment.replace @pathStripper, ''\n\n      return if @fragment is fragment\n      @fragment = fragment\n\nDon't include a trailing slash on the root.\n\n      if fragment is '' and url isnt '\/'\n       url = url.slice 0, -1\n\nIf pushState is available, we use it to set the fragment as a real URL.\n\n      if @_emulateState\n       if options.replace is on\n        @popEmulateState()\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @pushEmulateState state, title, fragment\n      else if @_hasPushState\n       method = if options.replace then 'replaceState' else 'pushState'\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @history[method] state, title, url\n\nIf hash changes haven't been explicitly disabled, update the hash\nfragment to store history.\n\n      else if @_wantsHashChange\n       @_updateHash @location, fragment, options.replace\n\nIf you've told us that you explicitly don't want fallback hashchange-\nbased history, then `navigate` becomes a page refresh.\n\n      else\n       return @location.assign url\n      if options.trigger\n       return @loadUrl fragment, null\n\nUpdate the hash\n\n     _updateHash: (location, fragment, replace) ->\n      if replace\n       href = location.href.replace \/(javascript:|#).*$\/, ''\n       location.replace \"#{href}##{fragment}\"\n      else\n       location.hash = \"##{fragment}\"\n\n    Weya.Router = Router\n    Weya.history = new History\n\n    if module?\n     module.exports = Weya.Router\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"33d888caddfec71ec432f68c562a7816879b87ff","subject":"Fix undefined varaible \"error\"","message":"Fix undefined varaible \"error\"\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/server.litcoffee","new_file":"src\/server.litcoffee","new_contents":"    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      if not req.get('Origin') or not (req.get('Origin') in origins)\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","old_contents":"    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      if not req.get('Origin') or not (req.get('Origin') in origins)\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError error\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a4a28480de7d49d3c49f84503b598bb2b7315776","subject":"removed some unneeded variable assignments","message":"removed some unneeded variable assignments\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08_request.litcoffee","new_file":"docs\/08_request.litcoffee","new_contents":"# Batman Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented the platform layer files.\n\n## Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.node.js`: \"querystring\" and \"url\"\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n## How to use Batman Request\n\n  Batman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\n  In other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n    \n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n## Lifecycle events\n There are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n 1. `loading()`: fired before `send()` has been called.\n\n    test \"Demonstrate the loading event\", 1, ->\n       new Batman.Request\n         url: \"http::\/\/batmanjs.org\"\n         loading: ->\n           ok true, \"After send but before the request is made\"\n\n 2. `loaded()`: fired after the request is complete\n\n     test \"Demo the loaded event\", 1, ->\n       Batman.Request.setupMockedResponse()\n       Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n       new Batman.Request\n         url: \"http:\/\/batmanjs.org\"\n         loaded: ->\n           ok true, \"Loaded\"\n\n 3. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n    test \"Demo the error event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        error: (xhr) ->\n          ok true, \"Error\"\n\n 4. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n    test \"Demonstrate the success event\", 1,  ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", response\n\n## Request::status\n  The response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## Request::response\n  The response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## Request::responseHeaders : PlainObject\n  An key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## Request( options : PlainObject )\n\n  Constructs a new `Batman.Request` with the supplied options\n\n  `options` description\n  1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n  2. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`\n\n    test \"method test\", ->\n      Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"POST\"\n        data: { some: \"data\" }\n        success: (response) ->\n          ok true\n\n  3. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n  4. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n    test \"contentType default\", ->\n       req = new Batman.Request\n       equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n  5. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n    test \"autosend test\", ->\n      response_sent = false\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        success: (response) ->\n          response_sent = true\n      ok !response_sent\n      req.send()\n      ok response_sent\n\n  6. `username`: username for authentication\n  7. `password`: password for authentication\n  8. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## Request::send( [data] )\n  If `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","old_contents":"# Batman Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented the platform layer files.\n\n## Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.node.js`: \"querystring\" and \"url\"\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n## How to use Batman Request\n\n  Batman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\n  In other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n    \n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n## Lifecycle events\n There are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n 1. `loading()`: fired before `send()` has been called.  Anaglous to the jQuery `beforeSend`\n\n    test \"Demonstrate the loading event\", 1, ->\n       req = new Batman.Request\n         url: \"http::\/\/batmanjs.org\"\n         loading: ->\n           ok true, \"After send but before the request is made\"\n\n 2. `loaded()`: fired after the request is complete, Anaglous to the jQuery `complete`\n\n     test \"Demo the loaded event\", 1, ->\n       Batman.Request.setupMockedResponse()\n       Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n       req = new Batman.Request\n         url: \"http:\/\/batmanjs.org\"\n         loaded: ->\n           ok true, \"Loaded\"\n\n 3. `error( xhr )`: fired when an error is detected,  `xhr` is the `XMLHttpRequest` object with `request` being the `Batman.Request` object.\n\n    test \"Demo the error event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        error: (xhr) ->\n          ok true, \"Error\"\n\n 4. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n    test \"Demonstrate the loading event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", response\n\n## Request::status\n  The response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     req = new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## Request::response\n  The response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## Request::responseHeaders : PlainObject\n  An key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## Request( options : PlainObject )\n\n  Constructs a new `Batman.Request` with the supplied options\n\n  `options` description\n  1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n  2. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`\n\n    test \"method test\", ->\n      Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"POST\"\n        data: { some: \"data\" }\n        success: (response) ->\n          ok true\n\n  3. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n  4. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n    test \"contentType default\", ->\n       req = new Batman.Request\n       equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n  5. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n    test \"autosend test\", ->\n      response_sent = false\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        success: (response) ->\n          response_sent = true\n      ok !response_sent\n      req.send()\n      ok response_sent\n\n  6. `username`: username for authentication\n  7. `password`: password for authentication\n  8. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## Request::send( [data] )\n  If `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5a07e9024ce16e6484ccbdcd5dd2479190f6e799","subject":"document encodesNestedAttributesFor","message":"document encodesNestedAttributesFor\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/26_batman_rails.litcoffee","new_file":"docs\/26_batman_rails.litcoffee","new_contents":"# \/api\/Extras\/Batman.Rails\n\nThe `batman.rails` extra provides helpers for using batman.js with [Ruby on Rails](http:\/\/rubyonrails.org). It is packaged with batman.js builds on the [downloads page](\/download.html).\n\nSee the [`batman-rails` gem](https:\/\/github.com\/batmanjs\/batman-rails) for more information about batman.js-Rails integration.\n\n## Configuration\n\n`batman.rails` provides the following default configurations:\n\n```coffeescript\nBatman.config.pathToHTML = '\/assets\/batman\/html'\nBatman.config.protectFromCSRF = true\nBatman.config.metaNameForCSRFToken = 'csrf-token'\n```\n\n# \/api\/Extras\/Batman.Rails\/Batman.RailsStorage\n\n`Batman.RailsStorage` extends `Batman.RestStorage`. It adds some features for integration with [Ruby on Rails](http:\/\/rubyonrails.org). You can use it to persist your `Batman.Model` subclasses:\n\n```coffeescript\nclass MyApp.MyModel extends Batman.Model\n  @persist Batman.RailsStorage\n```\n\n## \".json\" Request Suffix\n\nWhen performing storage operations, `Batman.RailsStorage` will add `.json` to URLs if it isn't already present. This way, Rails will always recognize it as `format: :json`.\n\n## Cross-Site Request Forgery Protection\n\nBy default, `batman.rails` participates in the Ruby on Rails cross-site request forgery (CSRF) protection scheme. Batman.js will:\n\n- extract the CSRF token from meta-tags (using `Batman.config.metaNameForCSRFToken`)\n- `Batman.RailsStorage` will send the CSRF token as a request header, `X-CSRF-Token`, when performing storage operations.\n\nYou can disable CSRF protection by setting the configuration to `false`:\n\n```coffeescript\nBatman.config.protectFromCSRF = false\n```\n\n## Server-Side Errors\n\nAfter update and create operations, `Batman.RailsStorage` checks for validation errors returned from the server.  The response must have status code `422` (Rails' default for validation errors).\n\nThe response JSON may have an `errors` key:\n\n```javascript\n{ \"errors\" : {\n    \"user\" : {\n      \"email\": [\"must be unique\"],\n      \"first_name\": [\"must be present\", \"must be longer than 3 characters\"]\n    }\n  }\n}\n```\n\nOr, the errors may be at the top level:\n\n```javascript\n{ \"user\" : {\n    \"email\": [\"must be unique\"],\n    \"first_name\": [\"must be present\", \"must be longer than 3 characters\"]\n    }\n  }\n}\n```\n\nAny errors will be added to client-side record according to its key in the JSON.\n\n## Date Encoder\n\n`Batman.Encoders.railsDate` may be used to send and receive dates with the Rails default date serialization:\n\n```coffeescript\n  @encode 'last_retrieved_at', Batman.Encoders.railsDate\n```\n\n\n\n\n# \/api\/Extras\/Batman.Rails\/Batman.RailsStorage ModelMixin\n\nThe following functions are mixed into models persisted with `Batman.RailsStorage`.\n\n## @encodeTimestamps(attrs... =['created_at', 'updated_at'])\n\nPulls `attrs` from JSON, but doesn't send them back to the server. It uses `Batman.Encoders.railsDate`, which is provided by `batman.rails`.\n\n## @encodesNestedAttributesFor(keys...)\n\nAssociations named by `keys` will be encoded in the parent model's JSON so that they work with Rails' `accepts_nested_attributes_for`. These associations must have the `saveInline: true` option.\n\nThis means:\n\n- data will be sent to the server with an `_attributes` suffix\n- after an update, any associated records where `record.get(\"_destroy\")` is truthy will be counted as destroyed. (This assumes that Rails destroyed them on the backend, too.)\n","old_contents":"# \/api\/Extras\/Batman.Rails\n\nThe `batman.rails` extra provides helpers for using batman.js with [Ruby on Rails](http:\/\/rubyonrails.org). It is packaged with batman.js builds on the [downloads page](\/download.html).\n\nSee the [`batman-rails` gem](https:\/\/github.com\/batmanjs\/batman-rails) for more information about batman.js-Rails integration.\n\n## Configuration\n\n`batman.rails` provides the following default configurations:\n\n```coffeescript\nBatman.config.pathToHTML = '\/assets\/batman\/html'\nBatman.config.protectFromCSRF = true\nBatman.config.metaNameForCSRFToken = 'csrf-token'\n```\n\n# \/api\/Extras\/Batman.Rails\/Batman.RailsStorage\n\n`Batman.RailsStorage` extends `Batman.RestStorage`. It adds some features for integration with [Ruby on Rails](http:\/\/rubyonrails.org). You can use it to persist your `Batman.Model` subclasses:\n\n```coffeescript\nclass MyApp.MyModel extends Batman.Model\n  @persist Batman.RailsStorage\n```\n\n## \".json\" Request Suffix\n\nWhen performing storage operations, `Batman.RailsStorage` will add `.json` to URLs if it isn't already present. This way, Rails will always recognize it as `format: :json`.\n\n## Cross-Site Request Forgery Protection\n\nBy default, `batman.rails` participates in the Ruby on Rails cross-site request forgery (CSRF) protection scheme. Batman.js will:\n\n- extract the CSRF token from meta-tags (using `Batman.config.metaNameForCSRFToken`)\n- `Batman.RailsStorage` will send the CSRF token as a request header, `X-CSRF-Token`, when performing storage operations.\n\nYou can disable CSRF protection by setting the configuration to `false`:\n\n```coffeescript\nBatman.config.protectFromCSRF = false\n```\n\n## Server-Side Errors\n\nAfter update and create operations, `Batman.RailsStorage` checks for validation errors returned from the server.  The response must have status code `422` (Rails' default for validation errors).\n\nThe response JSON may have an `errors` key:\n\n```javascript\n{ \"errors\" : {\n    \"user\" : {\n      \"email\": [\"must be unique\"],\n      \"first_name\": [\"must be present\", \"must be longer than 3 characters\"]\n    }\n  }\n}\n```\n\nOr, the errors may be at the top level:\n\n```javascript\n{ \"user\" : {\n    \"email\": [\"must be unique\"],\n    \"first_name\": [\"must be present\", \"must be longer than 3 characters\"]\n    }\n  }\n}\n```\n\nAny errors will be added to client-side record according to its key in the JSON.\n\n## Date Encoder\n\n`Batman.Encoders.railsDate` may be used to send and receive dates with the Rails default date serialization:\n\n```coffeescript\n  @encode 'last_retrieved_at', Batman.Encoders.railsDate\n```\n\n\n\n\n# \/api\/Extras\/Batman.Rails\/Batman.RailsStorage ModelMixin\n\nThe following functions are mixed into models persisted with `Batman.RailsStorage`.\n\n## @encodeTimestamps(attrs... =['created_at', 'updated_at'])\n\nPulls `attrs` from JSON, but doesn't send them back to the server. It uses `Batman.Encoders.railsDate`, which is provided by `batman.rails`.\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"18740f41b03bc46f6ebb44a8c84eab2b93f4307b","subject":"Add table of contents to source.","message":"Add table of contents to source.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary implementation\n----------------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.\n\n#### The `TimelineMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.\n\n#### The `TimelineMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"81ef925da8304299e442ed611ebb70ef29e503b3","subject":"Allow early binds of callbacks","message":"Allow early binds of callbacks\n","repos":"wbbaddons\/Push,wbbaddons\/Push","old_file":"file\/js\/be.bastelstu.wcf.push.litcoffee","new_file":"file\/js\/be.bastelstu.wcf.push.litcoffee","new_contents":"Push - Frontend\n===============\n\nThis is the frontend JavaScript for [**Push**](https:\/\/github.com\/wbbaddons\/Push). It transparently handles\neverything that has to be done in order to connect to the push service and provides a nice API for 3rd party developers.\n\n\t### Copyright Information\n\t# @author\tTim D\u00fcsterhus\n\t# @copyright\t2012-2015 Tim D\u00fcsterhus\n\t# @license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\n\t# @package\tbe.bastelstu.wcf.push\n\t###\n\n## Code\nWe start by setting up our environment by ensuring some sane values for both `$` and `window`,\nenabling EMCAScript 5 strict mode and overwriting console to prepend the name of the class.\n\n\t(($, window) ->\n\t\t\"use strict\";\n\t\t\n\t\tconsole =\n\t\t\tlog: (message) ->\n\t\t\t\twindow.console.log \"[be.bastelstu.wcf.push] #{message}\" unless production?\n\t\t\twarn: (message) ->\n\t\t\t\twindow.console.warn \"[be.bastelstu.wcf.push] #{message}\" unless production?\n\t\t\terror: (message) ->\n\t\t\t\twindow.console.error \"[be.bastelstu.wcf.push] #{message}\" unless production?\n\nContinue with defining the needed variables. All variables are local to our closure and will be\nexposed by a function if necessary.\n\n\t\tinitialized = no\n\t\tservice = null\n\t\tconnected = no\n\t\tevents =\n\t\t\tmessage: { }\n\t\tqueues =\n\t\t\tconnect: [ ]\n\t\t\tdisconnect: [ ]\n\t\t\tmessage: [ ]\n\nInitializes Push with the given service\n\n\t\tinit = (_service) ->\n\t\t\treturn if initialized\n\t\t\tinitialized = yes\n\t\t\tservice = _service\n\t\t\t\n\t\t\tservice.onConnect -> connected = yes\n\t\t\tservice.onDisconnect -> connected = no\n\n\t\t\tservice.onConnect callback for callback in queues.connect\n\t\t\tservice.onDisconnect callback for callback in queues.disconnect\n\t\t\tservice.onMessage message, callback for { message, callback } in queues.message\n\t\t\t\n\t\t\tfor intervalLength in [ 15, 30, 60, 90, 120 ]\n\t\t\t\tdo (intervalLength) ->\n\t\t\t\t\tsetInterval ->\n\t\t\t\t\t\treturn unless connected\n\t\t\t\t\t\t\n\t\t\t\t\t\tmessage = \"be.bastelstu.wcf.push.tick#{intervalLength}\"\n\t\t\t\t\t\treturn unless events.message[message]?\n\t\t\t\t\n\t\t\t\t\t\tdo events.message[message].fire\n\t\t\t\t\t, intervalLength * 1e3\n\t\t\t\n\nAdd a new `callback` that will be called when a connection to the push service is established and the\nThe given `callback` will be called once if a connection is established at time of calling.\nReturn `true` on success and `false` otherwise.\n\n\t\tonConnect = (callback) ->\n\t\t\treturn false unless $.isFunction callback\n\t\t\t\n\t\t\tif initialized\n\t\t\t\treturn service.onConnect callback\n\t\t\telse\n\t\t\t\tqueues.connect.push callback\n\t\t\t\tfalse\n\nAdd a new `callback` that will be called when the connection to the push service is lost. Return `true`\non success and `false` otherwise.\n\n\t\tonDisconnect = (callback) ->\n\t\t\treturn false unless $.isFunction callback\n\t\t\t\n\t\t\tif initialized\n\t\t\t\tservice.onDisconnect callback\n\t\t\telse\n\t\t\t\tqueues.disconnect.push callback\n\t\t\t\tfalse\n\nAdd a new `callback` that will be called when the specified `message` is received. Return `true`\non success and `false` otherwise.\n\n\t\tonMessage = (message, callback) ->\n\t\t\treturn false unless $.isFunction callback\n\t\t\treturn false unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test message\n\t\t\t\n\t\t\tif initialized\n\t\t\t\tif \/be\\.bastelstu\\.wcf\\.push.tick(15|(3|6|9|12)0)\/.test message\n\t\t\t\t\tevents.message[message] ?= $.Callbacks()\n\t\t\t\t\tevents.message[message].add callback\n\t\t\t\t\ttrue\n\t\t\t\telse\n\t\t\t\t\tservice.onMessage message, callback\n\t\t\telse\n\t\t\t\tqueues.message.push { message: message, callback: callback }\n\t\t\t\tfalse\n\nAnd finally export the public methods and variables.\n\n\t\twindow.be ?= {}\n\t\tbe.bastelstu ?= {}\n\t\tbe.bastelstu.wcf ?= {}\n\t\tbe.bastelstu.wcf.push = \n\t\t\tinit: init\n\t\t\tonConnect: onConnect\n\t\t\tonDisconnect: onDisconnect\n\t\t\tonMessage: onMessage\n\n\t)(jQuery, @)\n","old_contents":"Push - Frontend\n===============\n\nThis is the frontend JavaScript for [**Push**](https:\/\/github.com\/wbbaddons\/Push). It transparently handles\neverything that has to be done in order to connect to the push service and provides a nice API for 3rd party developers.\n\n\t### Copyright Information\n\t# @author\tTim D\u00fcsterhus\n\t# @copyright\t2012-2015 Tim D\u00fcsterhus\n\t# @license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\n\t# @package\tbe.bastelstu.wcf.push\n\t###\n\n## Code\nWe start by setting up our environment by ensuring some sane values for both `$` and `window`,\nenabling EMCAScript 5 strict mode and overwriting console to prepend the name of the class.\n\n\t(($, window) ->\n\t\t\"use strict\";\n\t\t\n\t\tconsole =\n\t\t\tlog: (message) ->\n\t\t\t\twindow.console.log \"[be.bastelstu.wcf.push] #{message}\" unless production?\n\t\t\twarn: (message) ->\n\t\t\t\twindow.console.warn \"[be.bastelstu.wcf.push] #{message}\" unless production?\n\t\t\terror: (message) ->\n\t\t\t\twindow.console.error \"[be.bastelstu.wcf.push] #{message}\" unless production?\n\nContinue with defining the needed variables. All variables are local to our closure and will be\nexposed by a function if necessary.\n\n\t\tinitialized = no\n\t\tservice = null\n\t\tconnected = no\n\t\tevents =\n\t\t\tmessage: { }\n\nInitializes Push with the given service\n\n\t\tinit = (_service) ->\n\t\t\treturn if initialized\n\t\t\tinitialized = yes\n\t\t\tservice = _service\n\t\t\t\n\t\t\tservice.onConnect -> connected = yes\n\t\t\tservice.onDisconnect -> connected = no\n\t\t\t\n\t\t\tfor intervalLength in [ 15, 30, 60, 90, 120 ]\n\t\t\t\tdo (intervalLength) ->\n\t\t\t\t\tsetInterval ->\n\t\t\t\t\t\treturn unless connected\n\t\t\t\t\t\t\n\t\t\t\t\t\tmessage = \"be.bastelstu.wcf.push.tick#{intervalLength}\"\n\t\t\t\t\t\treturn unless events.message[message]?\n\t\t\t\t\n\t\t\t\t\t\tdo events.message[message].fire\n\t\t\t\t\t, intervalLength * 1e3\n\t\t\t\n\nAdd a new `callback` that will be called when a connection to the push service is established and the\nThe given `callback` will be called once if a connection is established at time of calling.\nReturn `true` on success and `false` otherwise.\n\n\t\tonConnect = (callback) ->\n\t\t\treturn false unless $.isFunction callback\n\t\t\t\n\t\t\tif initialized\n\t\t\t\treturn service.onConnect callback\n\t\t\telse\n\t\t\t\tconsole.warn \"Someone tried to bind an onConnect callback before initialization of a service\"\n\t\t\t\tfalse\n\nAdd a new `callback` that will be called when the connection to the push service is lost. Return `true`\non success and `false` otherwise.\n\n\t\tonDisconnect = (callback) ->\n\t\t\treturn false unless $.isFunction callback\n\t\t\t\n\t\t\tif initialized\n\t\t\t\tservice.onDisconnect callback\n\t\t\telse\n\t\t\t\tconsole.warn \"Someone tried to bind an onDisonnect callback before initialization of a service\"\n\t\t\t\tfalse\n\nAdd a new `callback` that will be called when the specified `message` is received. Return `true`\non success and `false` otherwise.\n\n\t\tonMessage = (message, callback) ->\n\t\t\treturn false unless $.isFunction callback\n\t\t\treturn false unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test message\n\t\t\t\n\t\t\tif initialized\n\t\t\t\tif \/be\\.bastelstu\\.wcf\\.push.tick(15|(3|6|9|12)0)\/.test message\n\t\t\t\t\tevents.message[message] ?= $.Callbacks()\n\t\t\t\t\tevents.message[message].add callback\n\t\t\t\t\ttrue\n\t\t\t\telse\n\t\t\t\t\tservice.onMessage message, callback\n\t\t\telse\n\t\t\t\tconsole.warn \"Someone tried to bind an onMessage(#{message}) callback before initialization of a service\"\n\t\t\t\tfalse\n\nAnd finally export the public methods and variables.\n\n\t\twindow.be ?= {}\n\t\tbe.bastelstu ?= {}\n\t\tbe.bastelstu.wcf ?= {}\n\t\tbe.bastelstu.wcf.push = \n\t\t\tinit: init\n\t\t\tonConnect: onConnect\n\t\t\tonDisconnect: onDisconnect\n\t\t\tonMessage: onMessage\n\n\t)(jQuery, @)\n","returncode":0,"stderr":"","license":"bsd-3-clause","lang":"Literate CoffeeScript"}
{"commit":"35a594e3ad2a837f7a1614533c568f81ad6e3ada","subject":"ensure global library dependencies are respected","message":"ensure global library dependencies are respected\n","repos":"tmad4000\/celestrium","old_file":"core-coffee\/celestrium.litcoffee","new_file":"core-coffee\/celestrium.litcoffee","new_contents":"## API\n\nthis is used to populate the listed singleton plugins with their single instance\n\nother plugins may access this instance through requiring the module.\n\n### Example\n\n```coffeescript\nrequire [\"pluginPath\"], (plugin) -> plugin.getInstance().foo()`\n```\n\n### Example Usage\n\nNow in your `main` coffeescript file, you can do something like this.\n\n```coffeescript\nrequirejs [\"celestrium\"], (Celestrium) ->\n  Celestrium.init\n    \"core\/workspace\":\n      \"el\": document.querySelector \"#workspace\"\n```\n\nonly plugins which instantiate the `singleton` class should be used with `init`\n\n## Code\n\nLoad the global libraries contained within celestrium here.\nThis offloads this responsibility from the user.\n\nEnsure global variable dependencies are respected\n\n    requirejs.config\n      shim:\n        \"lib\/jquery.typeahead\": [\"lib\/jquery\"]\n        \"lib\/backbone\": [\"lib\/underscore\"]\n\n    globalLibs = [\n      'lib\/jquery',\n      'lib\/jquery.typeahead',\n      'lib\/underscore',\n      'lib\/backbone',\n      'lib\/d3',\n    ]\n\nThe actual module returns only an object with an init method.\n\nLoad the above libraries so they are now available globally.\n\nThis is probably bad practice and less modular, but is practical.\n\n    define globalLibs, () -> init: (singletonPlugins, callback) ->\n\nNow actually require the different plugins.\nNote that, they should all be required at once and the callback called within the require callback so as to ensure the callback is only call onced these plugin instances have been initialized.\n\n        pluginPaths = _.keys(singletonPlugins)\n        require pluginPaths, (plugins...) ->\n          i = 0\n          for plugin in plugins\n            args = singletonPlugins[pluginPaths[i]]\n            plugin.init args\n            i += 1\n          callback()\n","old_contents":"## API\n\nthis is used to populate the listed singleton plugins with their single instance\n\nother plugins may access this instance through requiring the module.\n\n### Example\n\n```coffeescript\nrequire [\"pluginPath\"], (plugin) -> plugin.getInstance().foo()`\n```\n\n### Example Usage\n\nNow in your `main` coffeescript file, you can do something like this.\n\n```coffeescript\nrequirejs [\"celestrium\"], (Celestrium) ->\n  Celestrium.init\n    \"core\/workspace\":\n      \"el\": document.querySelector \"#workspace\"\n```\n\nonly plugins which instantiate the `singleton` class should be used with `init`\n\n## Code\n\nLoad the global libraries contained within celestrium here.\nThis offloads this responsibility from the user.\n\n    globalLibs = [\n      'lib\/jquery',\n      'lib\/jquery.typeahead',\n      'lib\/underscore',\n      'lib\/backbone',\n      'lib\/d3',\n    ]\n\nThe actual module returns only an object with an init method.\n\nLoad the above libraries so they are now available globally.\n\nThis is probably bad practice and less modular, but is practical.\n\n    define globalLibs, () -> init: (singletonPlugins, callback) ->\n\nNow actually require the different plugins.\nNote that, they should all be required at once and the callback called within the require callback so as to ensure the callback is only call onced these plugin instances have been initialized.\n\n        pluginPaths = _.keys(singletonPlugins)\n        require pluginPaths, (plugins...) ->\n          i = 0\n          for plugin in plugins\n            args = singletonPlugins[pluginPaths[i]]\n            plugin.init args\n            i += 1\n          callback()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c6ec17728d0b4919e909f1d4f158dd2cff7daef2","subject":"gzip and deflate responses","message":"gzip and deflate responses\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response\n      else\n       @_sendBuffer buffer, options.response\n\n     _sendBuffer: (buf, res) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8d616eb5257711a3d55a09343f5cf9d1590fba93","subject":"help function call bug fix","message":"help function call bug fix\n","repos":"vpj\/weya,vpj\/weya","old_file":"weya.litcoffee","new_file":"weya.litcoffee","new_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       if elem.classList?\n        for c in idClass.class\n         elem.classList.add c\n       else #For older browsers; does not work with svgs\n        className = ''\n        for c in idClass.class\n         className += ' ' if className isnt ''\n         className += \"#{c}\"\n        elem.className = className\n\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        buf.push \" class=\\\"#{params.idClass.class}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       setIndent buf, @_indent\n       buf.push params.text\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     added = []\n     setFunc = (name, f) ->\n      weya[name] = ->\n       f.apply weya, arguments\n     if options.helpers?\n      for name, f of options.helpers\n       if not weya[name]?\n        added.push name\n        setFunc name, f\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n     for name in added\n      weya[name] = null\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","old_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       if elem.classList?\n        for c in idClass.class\n         elem.classList.add c\n       else #For older browsers; does not work with svgs\n        className = ''\n        for c in idClass.class\n         className += ' ' if className isnt ''\n         className += \"#{c}\"\n        elem.className = className\n\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        buf.push \" class=\\\"#{params.idClass.class}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       setIndent buf, @_indent\n       buf.push params.text\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     added = []\n     if options.helpers?\n      for name, f of options.helpers\n       if not weya[name]?\n        added.push name\n        weya[name] = ->\n         f.apply weya, arguments\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n     for name in added\n      weya[name] = null\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"93bd23a6f561b24159af80f5230e902660276772","subject":"Update crypto.litcoffee","message":"Update crypto.litcoffee","repos":"modulexcite\/fluentnode,o2platform\/fluentnode,modulexcite\/fluentnode,o2platform\/fluentnode","old_file":"src\/node-native\/crypto.litcoffee","new_file":"src\/node-native\/crypto.litcoffee","new_contents":"Methods that use the node crypto API\n\ndependencies\n\n    crypto = require('crypto')\n\n@.**add_Random_Chars** size\n\n    String::add_Random_Chars = (size )->\n      @ + crypto.randomBytes(size || 10)\n\n@.**add_Random_String** size\n\n    String::add_Random_String = (size )->\n      @ + crypto.randomBytes(size || 10).toString('hex').slice(0,size|| 10)\n\n@.**add_Random_Letters** size\n\n    String::add_Random_Letters   = (size )->\n      charSet = 'abcdefghijklmnopqrstuvwxyz'\n      @ + (charSet[Math.floor(Math.random() * charSet.length)]  for i in [1..size]).join('')\n\n@.**add_5_Random_Letters**\n\nAdds 5 random letters to ```@```\n\ntwin methods: add_5_Letters\n\n    String::add_5_Random_Letters = ()->\n      @.add_Random_Letters(5)\n\n\n    String::add_5_Letters = String::add_5_Random_Letters\n\n@.**add_Random_Numbers** size\n\n    String::add_Random_Numbers = (size)->\n      charSet = '0123456789'\n      @ + (charSet[Math.floor(Math.random() * charSet.length)]  for i in [1..size]).join('')\n\n@.**checksum** [algorithm], [encoding]\n\nReturns a checksum for @ \n\nDefaults to ```md5``` algorithm and ```hex``` encoding\n\n    String::checksum = (algorithm, encoding)->\n      crypto.createHash(algorithm || 'md5')\n            .update(@.toString(), 'utf8')\n            .digest(encoding || 'hex')\n\n@.**random_String** ()\n\nReturns a random string of size @ made of ascii chars\n\n    Number::random_String = ->\n      \"\".add_Random_String(@ + 0)\n\n\n@.**random_Letters** ()\n\nReturns a random string of size @ made of only letters\n\n    Number::random_Letters = ->\n      \"\".add_Random_Letters(@ + 0)\n\n","old_contents":"Methods that use the node crypto API\n\ndependencies\n\n    crypto = require('crypto')\n\n@.**add_Random_Chars** size\n\n    String::add_Random_Chars = (size )->\n      @ + crypto.randomBytes(size || 10)\n\n@.**add_Random_String** size\n\n    String::add_Random_String = (size )->\n      @ + crypto.randomBytes(size || 10).toString('hex').slice(0,size|| 10)\n\n@.**add_Random_Letters** size\n\n    String::add_Random_Letters   = (size )->\n      charSet = 'abcdefghijklmnopqrstuvwxyz'\n      @ + (charSet[Math.floor(Math.random() * charSet.length)]  for i in [1..size]).join('')\n\n@.**add_5_Random_Letters**\n\nAdds 5 random letters to ```@```\n\ntwin methods: add_5_Letters\n\n    String::add_5_Random_Letters = ()->\n      @.add_Random_Letters(5)\n\n\n    String::add_5_Letters = String::add_5_Random_Letters\n\n@.**add_Random_Numbers** size\n\n    String::add_Random_Numbers = (size)->\n      charSet = '0123456789'\n      @ + (charSet[Math.floor(Math.random() * charSet.length)]  for i in [1..size]).join('')\n\n@.**random_String** ()\n\nReturns a random string of size @ made of ascii chars\n\n    Number::random_String = ->\n      \"\".add_Random_String(@ + 0)\n\n\n@.**random_Letters** ()\n\nReturns a random string of size @ made of only letters\n\n    Number::random_Letters = ->\n      \"\".add_Random_Letters(@ + 0)\n\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"dba7d3de7efea72b53152a1192f20565cfa653fb","subject":"Fixed typos","message":"Fixed typos\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"client\/modules\/angular.litcoffee","new_file":"client\/modules\/angular.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f398533e1f7fe8243c2c6c7c2e7a193509c0dd3f","subject":"feat(document): increase limit for expand","message":"feat(document): increase limit for expand\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/model\/Document.litcoffee","new_file":"coffee\/model\/Document.litcoffee","new_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '@turbasen\/db-mongo'\n    redis   = require '@turbasen\/db-redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n    collections = require('..\/helper\/schema').types\n\n---\n\n## Class: Doc\n\n### new Doc(type, id)\n\n* **string** `type` - document type (collection name)\n* **string** `id` - document id\n\n---\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n\n      if typeof id isnt 'string' and id isnt null\n        throw new Error('Missing or invalid ID param')\n\n      EventEmitter.call this\n\n### doc.db\n\nMongoDB collection instance where the document is stored.\n\n      @db   = mongo[type]\n\n### doc.id\n\nUnique `ObjectID` for the document. Access through `doc.getId()`.\n\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n\n### doc.type\n\nDocument collection name (object type).\n\n      @type = type\n\n### doc.data\n\nCached document data from Redis. This gets poppulated automaticly when the\na new document is instanciated.\n\n      @data = {}\n\n### doc.chit\n\nCache hit indicator. Accessed through `doc.wasCacheHit()`.\n\n      @chit = false\n\n---\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if Object.keys(data).length\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return this\n\n    inherits Doc, EventEmitter\n\n### doc.exists()\n\nCheck if document exists. Returns `true` if document exists; otherwise `false`.\n\n---\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n### doc.getId()\n\nGet the unique id for current document. Returns an `ObjectID` if the document\nexists; otherwise `null`.\n\n---\n\n    Doc.prototype.getId = ->\n      @id\n\n\n### doc.wasCacheHit()\n\nCheck if document request was a cache hit. Returns `true` if document request\nwas a cache hit; otherwise `false`.\n\n---\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n### doc.isNotModifiedSince(time)\n\n* **string** `time` - timestamp to check against.\n\nCheck if document has not been modified since a given timestamp. Returns `true`\nif document has not been modified since given timestamp; otherwise `false`.\n\n---\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make UNIX timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n### doc.isMatch(checksum)\n\n* **string** `checksum` - checksum to check against.\n\nCheck if checksum, or Etag, matches current document checksum. Returns `true`\nif checksum matches the current checksum; otherwise `false`.\n\n---\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n### doc.isNoneMatch(checksum)\n\n* **string** `checksum` - checksum to check against.\n\nCheck if checksum, or Etag, doesn't match current document checksum. Return\n`true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n### doc.get([key])\n\n* **string** `key` - get specific object property\n\nGet cached data for the current document. Returns an `object` if `key` is\n`undefined`; otherwise `string`. Will return `undefined` if the given key does\nnot exist.\n\n---\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n### doc.getFull(filter[, cb])\n\n* **object** `filter` - control which object properties are returned\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\nGet the full document data from the database asynchronously. Returns a cursor\nstream if `cb` is undefined.\n\n---\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n### doc.getExpanded(opts, cb)\n\n* **object** `opts`\n  * **object** `filter` - document & sub-document projection (**default** `{}`)\n  * **number** `limit` - sub-document max expanded (**default** `10`)\n  * **array** `expand` - sub-document collections to expand (**default** `[]`)\n  * **object** `query` - sub-document select query (**default** `{}`)\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\nGet the full document with expanded sub-documents from the database\nasynchronously. To expand a given collection jsut pass the collection name to\nthe `expand` parameter and it will be merged with the document data.\n\n---\n\n    Doc.prototype.getExpanded = (opts, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      docFields = opts.fields or {}\n      subFields = Object.assign {}, docFields\n\nPrevent private fields from being included in sub-documents to prevent\nunauthorized information disclosure.\n\n      if Object.keys(subFields).length > 0\n        delete subFields.privat\n\n      if Object.keys(subFields).length is 0\n        subFields.privat = false\n\n      limit = Math.min opts.limit or 20, 50\n      query = opts.query or {}\n\n      count = 0\n      mapped = {}\n\nSince `expand` might be a user supplied input parameter we need to limit it to\nproperties which are expandable (`collections`). We also remove properties which\nholds no value for this document.\n\n      expand = (opts.expand or [])\n        .filter (v) => @data[v] and v in collections\n\nNext we map the string array into an object array on the following format:\n`{ type: String, ids: Array }` where `ids` are ObjectIDs to an document of the\ncollection `type`.\n\n        .map (v) => type: v, ids: @data[v].slice(0, limit).map (d) -> new ObjectID d\n\nSet up a `final` function which is called when expanded data is ready to be\nmapped to the original document.\n\n      final = () =>\n        @db.findOne _id: @id, docFields, (err, doc) ->\n          cb err, Object.assign doc or {}, mapped\n\nIf there are no fields to expand, we just call the `final` function instantly\nand no fields will get expanded.\n\n      return final() if expand.length is 0\n\nSet up a `next` function which is called for each expanded data returned from\nthe database. Expanded data is stored in the `mapped` object which is merged\nwith the main document in `final`. When all expanded fields are mapped `final`\nis called.\n\n      next = (type, _, docs) ->\n        mapped[type] = docs or []\n        return final() if Object.keys(mapped).length == expand.length\n\nGet the expanded sub-documents from the database.\n\n      expand.forEach (x) ->\n        mongo[x.type]\n\nWe find the sub-documents using the ObjectIDs in the expanded fields, that is\nthe easy part. The tricky part is to prevent information leakage of private\ndocuments. This the second part is a `query` limiting the results to public\ndocuments or those owned by the current API user.\n\n          .find Object.assign { _id: $in: x.ids }, query\n\nWe reuse the projection fields from the original document, but since we do not\nknow in advanced who owns a given sub-document we remove the `private` property\nto prevent information leakage.\n\n          .project subFields\n\nBundle all the sub-documents in one array and pass it to the `next` function.\n\n          .toArray next.bind null, x.type\n\n\n### doc.insert(data, cb)\n\n* **object** `data` - data to insert for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`,\n**object** `data`).\n\nInserts a new document into database.\n\n---\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n### doc.replace(data, cb)\n\n* **object** `data` - replacement data for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`,\n**object** `data`).\n\nReplaces all document data in database.\n\n\n---\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          data._id = @id\n          cb err, warn, data\n\n\n### doc.update(data, cb)\n\n* **object** `data` - replacement object for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`,\n**object** `data`).\n\nPartially update the document-data in database. This is some times referred to\nas PATCH in a HTTP \/ REST context.\n\n---\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n### doc.delete(cb)\n\n* **function** `cb` - callback function (**Error** `err`).\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n---\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet', endret: new Date()\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n","old_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '@turbasen\/db-mongo'\n    redis   = require '@turbasen\/db-redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n    collections = require('..\/helper\/schema').types\n\n---\n\n## Class: Doc\n\n### new Doc(type, id)\n\n* **string** `type` - document type (collection name)\n* **string** `id` - document id\n\n---\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n\n      if typeof id isnt 'string' and id isnt null\n        throw new Error('Missing or invalid ID param')\n\n      EventEmitter.call this\n\n### doc.db\n\nMongoDB collection instance where the document is stored.\n\n      @db   = mongo[type]\n\n### doc.id\n\nUnique `ObjectID` for the document. Access through `doc.getId()`.\n\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n\n### doc.type\n\nDocument collection name (object type).\n\n      @type = type\n\n### doc.data\n\nCached document data from Redis. This gets poppulated automaticly when the\na new document is instanciated.\n\n      @data = {}\n\n### doc.chit\n\nCache hit indicator. Accessed through `doc.wasCacheHit()`.\n\n      @chit = false\n\n---\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if Object.keys(data).length\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return this\n\n    inherits Doc, EventEmitter\n\n### doc.exists()\n\nCheck if document exists. Returns `true` if document exists; otherwise `false`.\n\n---\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n### doc.getId()\n\nGet the unique id for current document. Returns an `ObjectID` if the document\nexists; otherwise `null`.\n\n---\n\n    Doc.prototype.getId = ->\n      @id\n\n\n### doc.wasCacheHit()\n\nCheck if document request was a cache hit. Returns `true` if document request\nwas a cache hit; otherwise `false`.\n\n---\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n### doc.isNotModifiedSince(time)\n\n* **string** `time` - timestamp to check against.\n\nCheck if document has not been modified since a given timestamp. Returns `true`\nif document has not been modified since given timestamp; otherwise `false`.\n\n---\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make UNIX timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n### doc.isMatch(checksum)\n\n* **string** `checksum` - checksum to check against.\n\nCheck if checksum, or Etag, matches current document checksum. Returns `true`\nif checksum matches the current checksum; otherwise `false`.\n\n---\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n### doc.isNoneMatch(checksum)\n\n* **string** `checksum` - checksum to check against.\n\nCheck if checksum, or Etag, doesn't match current document checksum. Return\n`true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n### doc.get([key])\n\n* **string** `key` - get specific object property\n\nGet cached data for the current document. Returns an `object` if `key` is\n`undefined`; otherwise `string`. Will return `undefined` if the given key does\nnot exist.\n\n---\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n### doc.getFull(filter[, cb])\n\n* **object** `filter` - control which object properties are returned\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\nGet the full document data from the database asynchronously. Returns a cursor\nstream if `cb` is undefined.\n\n---\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n### doc.getExpanded(opts, cb)\n\n* **object** `opts`\n  * **object** `filter` - document & sub-document projection (**default** `{}`)\n  * **number** `limit` - sub-document max expanded (**default** `10`)\n  * **array** `expand` - sub-document collections to expand (**default** `[]`)\n  * **object** `query` - sub-document select query (**default** `{}`)\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\nGet the full document with expanded sub-documents from the database\nasynchronously. To expand a given collection jsut pass the collection name to\nthe `expand` parameter and it will be merged with the document data.\n\n---\n\n    Doc.prototype.getExpanded = (opts, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      docFields = opts.fields or {}\n      subFields = Object.assign {}, docFields\n\nPrevent private fields from being included in sub-documents to prevent\nunauthorized information disclosure.\n\n      if Object.keys(subFields).length > 0\n        delete subFields.privat\n\n      if Object.keys(subFields).length is 0\n        subFields.privat = false\n\n      limit = Math.min opts.limit or 10, 10\n      query = opts.query or {}\n\n      count = 0\n      mapped = {}\n\nSince `expand` might be a user supplied input parameter we need to limit it to\nproperties which are expandable (`collections`). We also remove properties which\nholds no value for this document.\n\n      expand = (opts.expand or [])\n        .filter (v) => @data[v] and v in collections\n\nNext we map the string array into an object array on the following format:\n`{ type: String, ids: Array }` where `ids` are ObjectIDs to an document of the\ncollection `type`.\n\n        .map (v) => type: v, ids: @data[v].slice(0, limit).map (d) -> new ObjectID d\n\nSet up a `final` function which is called when expanded data is ready to be\nmapped to the original document.\n\n      final = () =>\n        @db.findOne _id: @id, docFields, (err, doc) ->\n          cb err, Object.assign doc or {}, mapped\n\nIf there are no fields to expand, we just call the `final` function instantly\nand no fields will get expanded.\n\n      return final() if expand.length is 0\n\nSet up a `next` function which is called for each expanded data returned from\nthe database. Expanded data is stored in the `mapped` object which is merged\nwith the main document in `final`. When all expanded fields are mapped `final`\nis called.\n\n      next = (type, _, docs) ->\n        mapped[type] = docs or []\n        return final() if Object.keys(mapped).length == expand.length\n\nGet the expanded sub-documents from the database.\n\n      expand.forEach (x) ->\n        mongo[x.type]\n\nWe find the sub-documents using the ObjectIDs in the expanded fields, that is\nthe easy part. The tricky part is to prevent information leakage of private\ndocuments. This the second part is a `query` limiting the results to public\ndocuments or those owned by the current API user.\n\n          .find Object.assign { _id: $in: x.ids }, query\n\nWe reuse the projection fields from the original document, but since we do not\nknow in advanced who owns a given sub-document we remove the `private` property\nto prevent information leakage.\n\n          .project subFields\n\nBundle all the sub-documents in one array and pass it to the `next` function.\n\n          .toArray next.bind null, x.type\n\n\n### doc.insert(data, cb)\n\n* **object** `data` - data to insert for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`,\n**object** `data`).\n\nInserts a new document into database.\n\n---\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n### doc.replace(data, cb)\n\n* **object** `data` - replacement data for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`,\n**object** `data`).\n\nReplaces all document data in database.\n\n\n---\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          data._id = @id\n          cb err, warn, data\n\n\n### doc.update(data, cb)\n\n* **object** `data` - replacement object for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`,\n**object** `data`).\n\nPartially update the document-data in database. This is some times referred to\nas PATCH in a HTTP \/ REST context.\n\n---\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n### doc.delete(cb)\n\n* **function** `cb` - callback function (**Error** `err`).\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n---\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet', endret: new Date()\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"838a3c86ecb01c7461367f0d3c12ca49ef8e0874","subject":"Fix the match sched selection","message":"Fix the match sched selection\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/match-sched.litcoffee","new_file":"src\/coffee\/match-sched.litcoffee","new_contents":"Match Schedule\n==============\n\nThe match schedule, as with the day schedule, is mainly managed within the basic\ndata module - this module defines only useful utilities.\n\nConstants\n---------\n\nWe define two constants within this module -- *MATCH_PREROLL*, and\n*MATCH_LENGTH*.\n\n*MATCH_PREROLL* is the amount of time, in seconds, before the start\ntime of a match during which it should be considered active. Its\ncurrent value is 180 seconds, which is 30 seconds of swap time and\n60 seconds boot period.\n\n    MATCH_PREROLL = 30 + 60\n\n*MATCH_LENGTH* is simply the length of a match in seconds, including\nsetup and tear-down time - presently 5 minutes.\n\n    MATCH_LENGTH = 60*5\n\n*MATCH_POSTROLL* is the amount of time, in seconds, between the\nstart time of a match and when it is considered to have ended. It\nis defined in terms of *MATCH_PREROLL* and *MATCH_LENGTH*.\n\n    MATCH_POSTROLL = MATCH_LENGTH - MATCH_PREROLL\n\nMatch Tracking\n--------------\n\nThe *firstMatchAfter* function takes as its argument a match schedule,\nand a *reference point*, being a JavaScript *Date* object. It finds\nthe first match in the schedule whose consideration period begins\nat or after the reference point. It may also take an optional\n*feasibility condition*, to further filter the matches considered.\n\n    firstMatchAfter = (schedule, referencePoint, feasilibilty) ->\n\nIf the feasibility condition is unspecified, we use a default\ncondition which simply accepts all matches.\n\n        unless feasibility?\n            feasibility = (match) -> yes\n\nWe convert the reference point into a UNIX timestamp for our use.\n\n        referenceUNIX = referencePoint.valueOf() * 0.001\n\nWe then use Underscore's *find* function to find the first satisfying\nmatch.\n\n        _.find schedule, (match) ->\n            return no unless feasibility(match, referencePoint)\n            match.start + MATCH_POSTROLL >= referenceUNIX\n\nCurrent Match\n-------------\n\nWe provide the current match (nullable) via the *CurrentMatch*\nproperty. It is a map on the *Data.matchSchedule* property, and the\nclock.\n\nFirst, we define the data source.\n\n    currentMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n\nWe then define the stream itself, as a map over the input source.\n\n    currentMatch = currentMatchSource.map (data) ->\n\nWe find the first match active now, using *firstMatchAfter*. A\nfeasibility condition is passed to constrain matches to only those\nwhich have not ended.\n\n        firstMatchAfter data.schedule, data.clock, (match, ref) ->\n            not (match.start + MAX_POSTROLL > ref)\n\nThe public property simply removes the duplicates from that stream.\n\n    window.CurrentMatch = currentMatch.skipDuplicates()\n\nNext Match\n----------\n\nWe also provide the next match (nullable) via the *NextMatch*\nproperty. It is defined similarly to *CurrentMatch*, except with\nthe additional feasibility condition of not being the current match.\n\nWe first define the data source.\n\n    nextMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n            currentMatch: CurrentMatch\n\nWe then define the stream itself, again as a map over the source.\n\n    nextMatch = nextMatchSource.map (data) ->\n\nAs with the current match, we use *firstMatchAfter*, with a feasibility\ncondition this time specifying that the match is not the current\nmatch.\n\n        firstMatchAfter data.schedule, data.clock, (match) ->\n            match.key isnt data.currentMatch?.key\n\nWe then publish it by removing duplicates.\n\n    window.NextMatch = nextMatch.skipDuplicates()\n\n","old_contents":"Match Schedule\n==============\n\nThe match schedule, as with the day schedule, is mainly managed within the basic\ndata module - this module defines only useful utilities.\n\nConstants\n---------\n\nWe define two constants within this module -- *MATCH_PREROLL*, and\n*MATCH_LENGTH*.\n\n*MATCH_PREROLL* is the amount of time, in seconds, before the start\ntime of a match during which it should be considered active. Its\ncurrent value is 180 seconds, which is 30 seconds of swap time and\n60 seconds boot period.\n\n    MATCH_PREROLL = 30 + 60\n\n*MATCH_LENGTH* is simply the length of a match in seconds, including\nsetup and tear-down time - presently 5 minutes.\n\n    MATCH_LENGTH = 60*5\n\n*MATCH_POSTROLL* is the amount of time, in seconds, between the\nstart time of a match and when it is considered to have ended. It\nis defined in terms of *MATCH_PREROLL* and *MATCH_LENGTH*.\n\n    MATCH_POSTROLL = MATCH_LENGTH - MATCH_PREROLL\n\nMatch Tracking\n--------------\n\nThe *firstMatchAfter* function takes as its argument a match schedule,\nand a *reference point*, being a JavaScript *Date* object. It finds\nthe first match in the schedule whose consideration period begins\nat or after the reference point. It may also take an optional\n*feasibility condition*, to further filter the matches considered.\n\n    firstMatchAfter = (schedule, referencePoint, feasilibilty) ->\n\nIf the feasibility condition is unspecified, we use a default\ncondition which simply accepts all matches.\n\n        unless feasibility?\n            feasibility = (match) -> yes\n\nWe convert the reference point into a UNIX timestamp for our use.\n\n        referenceUNIX = referencePoint.valueOf() * 0.001\n\nWe then use Underscore's *find* function to find the first satisfying\nmatch.\n\n        _.find schedule, (match) ->\n            return no unless feasibility(match, referencePoint)\n            match.start - MATCH_PREROLL >= referenceUNIX\n\nCurrent Match\n-------------\n\nWe provide the current match (nullable) via the *CurrentMatch*\nproperty. It is a map on the *Data.matchSchedule* property, and the\nclock.\n\nFirst, we define the data source.\n\n    currentMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n\nWe then define the stream itself, as a map over the input source.\n\n    currentMatch = currentMatchSource.map (data) ->\n\nWe find the first match active now, using *firstMatchAfter*. A\nfeasibility condition is passed to constrain matches to only those\nwhich have not ended.\n\n        firstMatchAfter data.schedule, data.clock, (match, ref) ->\n            not (match.start + MAX_POSTROLL > ref)\n\nThe public property simply removes the duplicates from that stream.\n\n    window.CurrentMatch = currentMatch.skipDuplicates()\n\nNext Match\n----------\n\nWe also provide the next match (nullable) via the *NextMatch*\nproperty. It is defined similarly to *CurrentMatch*, except with\nthe additional feasibility condition of not being the current match.\n\nWe first define the data source.\n\n    nextMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n            currentMatch: CurrentMatch\n\nWe then define the stream itself, again as a map over the source.\n\n    nextMatch = nextMatchSource.map (data) ->\n\nAs with the current match, we use *firstMatchAfter*, with a feasibility\ncondition this time specifying that the match is not the current\nmatch.\n\n        firstMatchAfter data.schedule, data.clock, (match) ->\n            match.key isnt data.currentMatch?.key\n\nWe then publish it by removing duplicates.\n\n    window.NextMatch = nextMatch.skipDuplicates()\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"810d632b749dd90b1cb627d0dade7eb96524f959","subject":"Fixed utils.stringify on objects with no Object prototype","message":"Fixed utils.stringify on objects with no Object prototype\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/utils\/stringifying.litcoffee","new_file":"src\/utils\/stringifying.litcoffee","new_contents":"# Stringifying\n\n    'use strict'\n\n    {isArray} = Array\n    hasOwnProp = Object.hasOwnProperty\n\n    module.exports = (utils) ->\n\n## utils.simplify(*Object* object, [*Object* options])\n\nConvert the given object into the most simplified format with no cyclic references and more.\n\nSuch object can be easily stringified later using standard *JSON.stringify()*.\n\nUse utils.assemble() function to restore the object into the initial structure.\n\nSecond parameter is an config object (all 'false' by default):\n  - *properties* - save properties descriptors (getters, config etc.),\n  - *protos* - save protos as objects,\n  - *constructors* - include constructor functions.\n\n```javascript\nvar obj = {};\nobj.self = obj;\nconsole.log(JSON.stringify(utils.simplify(obj)));\n```\n\nIf *protos* is *false* and *constructors* is *true*,\nobject will be recognized as an instance.\n\n```javascript\nfunction Sample(){\n  this.fromInstance = 1;\n}\nSample.prototype.fromPrototype = 1;\n\nvar sample = new Sample;\nvar parts = utils.simplify(sample, {constructors: true});\nvar clone = utils.assemble(json);\n\nconsole.log(clone instanceof Sample)\n\/\/ it's true because 'protos' option is false and 'constructors' is true\n\/\/ won't work for json, because functions are not stringified ...\n```\n\n        utils.simplify = do ->\n            nativeProtos = [Array::, Object::]\n            nativeCtors = [Array, Object]\n\n            (obj, opts = {}) ->\n                null\n                `\/\/<development>`\n                unless utils.isObject(obj)\n                    throw new Error 'utils.simplify object must be an object'\n                unless utils.isPlainObject(opts)\n                    throw new Error 'utils.simplify options must be a plain object'\n                `\/\/<\/development>`\n\n                optsProps = opts.properties ?= false\n                optsProtos = opts.protos ?= false\n                optsCtors = opts.constructors ?= false\n                optsInsts = opts.instances = not optsProtos and optsCtors\n\n                # list of objects\n                objs = []\n\n                # list of lists of ids per object\n                ids = []\n\n                # lists of keys to references per object\n                references = {}\n\n                # objects constructors\n                if optsCtors then ctors = {}\n\n                # proto destination to proto object\n                if optsProtos then protos = {}\n\n                # get cyclic references in the object\n                cyclic = (obj) ->\n\n                    len = objs.push obj\n                    ids.push objIds = []\n\n                    for key, value of obj when hasOwnProp.call(obj, key)\n\n                        unless value and typeof value is 'object'\n                            continue\n\n                        # don't check getters values\n                        if optsProps and exports.lookupGetter obj, key\n                            objIds.push null\n                            continue\n\n                        # check whether obj already exists\n                        unless ~(i = objs.indexOf value)\n                            i = cyclic value\n\n                        objIds.push i\n\n                    # cycle proto\n                    if optsProtos and proto = getPrototypeOf obj\n\n                        # don't save protos for native ones (Array, Object, etc..)\n                        if ~(nativeProtos.indexOf proto)\n                            i = null\n\n                        # find recursively if it's for first time\n                        else unless ~(i = objs.indexOf proto)\n                            i = cyclic proto\n\n                        objIds.push i\n\n                    len - 1\n\n                # parse object\n                parse = (obj, index) ->\n\n                    r = if isArray obj then [] else {}\n                    objIds = ids[index]\n\n                    # Create `references` for each object with keys which are a references to others\n                    # Value of each property will be changed to referenced object id\n                    obji = 0\n                    objReferences = null\n                    for key, value of obj when hasOwnProp.call(obj, key)\n\n                        r[key] = value\n\n                        isReference = false\n\n                        # save as reference\n                        if value and typeof value is 'object'\n                            objReferences ?= []\n\n                            objId = value = objIds[obji++]\n\n                            # with `optsProps` id can be a null when value is an object\n                            if value isnt null\n                                isReference = true\n                                objReferences.push key\n\n                        # save as property description\n                        if optsProps\n                            desc = getObjOwnPropDesc obj, key\n                            desc.value = value if isReference\n                            value = desc\n\n                        # override prop value as referenced object id\n                        r[key] = value\n\n                    # save reference to proto\n                    if optsProtos and getPrototypeOf obj\n                        protoObjId = objIds[obji++]\n                        if protoObjId isnt null\n                            protos[index] = protoObjId\n\n                    # save ctor if needed\n                    if optsCtors and ctor = obj.constructor\n\n                        # save for instance or for prototype depend on the flag\n                        if optsInsts or hasOwnProp.call(obj, 'constructor')\n\n                            # omits native constructors (Array, Object etc.)\n                            unless ~(nativeCtors.indexOf ctor)\n                                ctors[index] = ctor\n\n                    # save object references\n                    if objReferences then references[index] = objReferences\n\n                    r\n\n                # find cycles\n                cyclic obj\n\n                # parse all found objects\n                for value, i in objs\n                    objs[i] = parse value, i\n\n                # return\n                opts: opts\n                objects: objs\n                references: references\n                protos: protos\n                constructors: ctors\n\n## utils.assemble(*PlainObject* object)\n\nBackward utils.simplify() operation.\n\n        utils.assemble = do ->\n            ctorPropConfig = value: null\n\n            (obj) ->\n                null\n                `\/\/<development>`\n                unless utils.isPlainObject(obj)\n                    throw new Error 'utils.assemble object must be a plain object'\n                `\/\/<\/development>`\n\n                {opts, objects, references, protos, constructors} = obj\n\n                optsProps = opts.properties\n                optsProtos = opts.protos\n                optsCtors = opts.constructors\n                optsInsts = opts.instances\n\n                # list of all referenced objects ids\n                refsIds = []\n\n                # set references\n                if optsProps\n                    for objI, refs of references\n                        obj = objects[objI]\n\n                        for ref in refs\n                            refsIds.push obj[ref].value\n                            obj[ref].value = objects[obj[ref].value]\n                else\n                    for objI, refs of references\n                        obj = objects[objI]\n\n                        for ref in refs\n                            refsIds.push obj[ref]\n                            obj[ref] = objects[obj[ref]]\n\n                # set properties\n                if optsProps\n                    for obj in objects\n                        for key, value of obj when hasOwnProp.call(obj, key)\n                            defObjProp obj, key, value\n\n                # set protos\n                for objI, refI of protos\n                    objects[objI] = utils.setPrototypeOf objects[objI], objects[refI]\n\n                # set objects as instances\n                if optsInsts\n                    for objI, func of constructors\n                        object = objects[objI] = utils.setPrototypeOf objects[objI], func::\n\n                        # call `fromAssebled` if exists\n                        func.fromAssembled? object\n\n                # .. or set ctors as properties\n                else if optsCtors\n                    for objI, func of constructors\n                        ctorPropConfig.value = func\n                        defObjProp objects[objI], 'constructor', ctorPropConfig\n\n                # update references, because same of them could changed by `setPrototypeOf`\n                refId = 0\n                for objI, refs of references\n                    obj = objects[objI]\n\n                    for ref in refs\n                        obj[ref] = objects[refsIds[refId++]]\n\n                objects[0]\n","old_contents":"# Stringifying\n\n    'use strict'\n\n    {isArray} = Array\n\n    module.exports = (utils) ->\n\n## utils.simplify(*Object* object, [*Object* options])\n\nConvert the given object into the most simplified format with no cyclic references and more.\n\nSuch object can be easily stringified later using standard *JSON.stringify()*.\n\nUse utils.assemble() function to restore the object into the initial structure.\n\nSecond parameter is an config object (all 'false' by default):\n  - *properties* - save properties descriptors (getters, config etc.),\n  - *protos* - save protos as objects,\n  - *constructors* - include constructor functions.\n\n```javascript\nvar obj = {};\nobj.self = obj;\nconsole.log(JSON.stringify(utils.simplify(obj)));\n```\n\nIf *protos* is *false* and *constructors* is *true*,\nobject will be recognized as an instance.\n\n```javascript\nfunction Sample(){\n  this.fromInstance = 1;\n}\nSample.prototype.fromPrototype = 1;\n\nvar sample = new Sample;\nvar parts = utils.simplify(sample, {constructors: true});\nvar clone = utils.assemble(json);\n\nconsole.log(clone instanceof Sample)\n\/\/ it's true because 'protos' option is false and 'constructors' is true\n\/\/ won't work for json, because functions are not stringified ...\n```\n\n        utils.simplify = do ->\n            nativeProtos = [Array::, Object::]\n            nativeCtors = [Array, Object]\n\n            (obj, opts = {}) ->\n                null\n                `\/\/<development>`\n                unless utils.isObject(obj)\n                    throw new Error 'utils.simplify object must be an object'\n                unless utils.isPlainObject(opts)\n                    throw new Error 'utils.simplify options must be a plain object'\n                `\/\/<\/development>`\n\n                optsProps = opts.properties ?= false\n                optsProtos = opts.protos ?= false\n                optsCtors = opts.constructors ?= false\n                optsInsts = opts.instances = not optsProtos and optsCtors\n\n                # list of objects\n                objs = []\n\n                # list of lists of ids per object\n                ids = []\n\n                # lists of keys to references per object\n                references = {}\n\n                # objects constructors\n                if optsCtors then ctors = {}\n\n                # proto destination to proto object\n                if optsProtos then protos = {}\n\n                # get cyclic references in the object\n                cyclic = (obj) ->\n\n                    len = objs.push obj\n                    ids.push objIds = []\n\n                    for key, value of obj when obj.hasOwnProperty key\n\n                        unless value and typeof value is 'object'\n                            continue\n\n                        # don't check getters values\n                        if optsProps and exports.lookupGetter obj, key\n                            objIds.push null\n                            continue\n\n                        # check whether obj already exists\n                        unless ~(i = objs.indexOf value)\n                            i = cyclic value\n\n                        objIds.push i\n\n                    # cycle proto\n                    if optsProtos and proto = getPrototypeOf obj\n\n                        # don't save protos for native ones (Array, Object, etc..)\n                        if ~(nativeProtos.indexOf proto)\n                            i = null\n\n                        # find recursively if it's for first time\n                        else unless ~(i = objs.indexOf proto)\n                            i = cyclic proto\n\n                        objIds.push i\n\n                    len - 1\n\n                # parse object\n                parse = (obj, index) ->\n\n                    r = if isArray obj then [] else {}\n                    objIds = ids[index]\n\n                    # Create `references` for each object with keys which are a references to others\n                    # Value of each property will be changed to referenced object id\n                    obji = 0\n                    objReferences = null\n                    for key, value of obj when obj.hasOwnProperty key\n\n                        r[key] = value\n\n                        isReference = false\n\n                        # save as reference\n                        if value and typeof value is 'object'\n                            objReferences ?= []\n\n                            objId = value = objIds[obji++]\n\n                            # with `optsProps` id can be a null when value is an object\n                            if value isnt null\n                                isReference = true\n                                objReferences.push key\n\n                        # save as property description\n                        if optsProps\n                            desc = getObjOwnPropDesc obj, key\n                            desc.value = value if isReference\n                            value = desc\n\n                        # override prop value as referenced object id\n                        r[key] = value\n\n                    # save reference to proto\n                    if optsProtos and getPrototypeOf obj\n                        protoObjId = objIds[obji++]\n                        if protoObjId isnt null\n                            protos[index] = protoObjId\n\n                    # save ctor if needed\n                    if optsCtors and ctor = obj.constructor\n\n                        # save for instance or for prototype depend on the flag\n                        if optsInsts or obj.hasOwnProperty('constructor')\n\n                            # omits native constructors (Array, Object etc.)\n                            unless ~(nativeCtors.indexOf ctor)\n                                ctors[index] = ctor\n\n                    # save object references\n                    if objReferences then references[index] = objReferences\n\n                    r\n\n                # find cycles\n                cyclic obj\n\n                # parse all found objects\n                for value, i in objs\n                    objs[i] = parse value, i\n\n                # return\n                opts: opts\n                objects: objs\n                references: references\n                protos: protos\n                constructors: ctors\n\n## utils.assemble(*PlainObject* object)\n\nBackward utils.simplify() operation.\n\n        utils.assemble = do ->\n            ctorPropConfig = value: null\n\n            (obj) ->\n                null\n                `\/\/<development>`\n                unless utils.isPlainObject(obj)\n                    throw new Error 'utils.assemble object must be a plain object'\n                `\/\/<\/development>`\n\n                {opts, objects, references, protos, constructors} = obj\n\n                optsProps = opts.properties\n                optsProtos = opts.protos\n                optsCtors = opts.constructors\n                optsInsts = opts.instances\n\n                # list of all referenced objects ids\n                refsIds = []\n\n                # set references\n                if optsProps\n                    for objI, refs of references\n                        obj = objects[objI]\n\n                        for ref in refs\n                            refsIds.push obj[ref].value\n                            obj[ref].value = objects[obj[ref].value]\n                else\n                    for objI, refs of references\n                        obj = objects[objI]\n\n                        for ref in refs\n                            refsIds.push obj[ref]\n                            obj[ref] = objects[obj[ref]]\n\n                # set properties\n                if optsProps\n                    for obj in objects\n                        for key, value of obj when obj.hasOwnProperty key\n                            defObjProp obj, key, value\n\n                # set protos\n                for objI, refI of protos\n                    objects[objI] = utils.setPrototypeOf objects[objI], objects[refI]\n\n                # set objects as instances\n                if optsInsts\n                    for objI, func of constructors\n                        object = objects[objI] = utils.setPrototypeOf objects[objI], func::\n\n                        # call `fromAssebled` if exists\n                        func.fromAssembled? object\n\n                # .. or set ctors as properties\n                else if optsCtors\n                    for objI, func of constructors\n                        ctorPropConfig.value = func\n                        defObjProp objects[objI], 'constructor', ctorPropConfig\n\n                # update references, because same of them could changed by `setPrototypeOf`\n                refId = 0\n                for objI, refs of references\n                    obj = objects[objI]\n\n                    for ref in refs\n                        obj[ref] = objects[refsIds[refId++]]\n\n                objects[0]\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"6f0456408aa8d6e724915526d946454c9337b237","subject":"Changing css generation to make media and selector nesting symetric","message":"Changing css generation to make media and selector nesting symetric\n","repos":"ojjs\/oj","old_file":"src\/oj.litcoffee","new_file":"src\/oj.litcoffee","new_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\noj function\n-------------------------------------------------------------------------------\n\n  oj function acts like a tag method that doesn't emit\n  Using inline js so the function can be named\n\n    `function oj(){return oj.tag.apply(this, ['oj'].concat([].slice.call(arguments)).concat([{__quiet__:1}]));}`\n\n  Define oj version\n\n    oj.version = '0.2.0'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Store jQuery reference as either the global reference or as required through `jquery2`.\n  This allows this reference to be included as a script tag, included through npm, or overriden.\n\n    if typeof $ != 'undefined'\n      oj.$ = $\n    else if typeof require != 'undefined'\n      try\n        oj.$ = require 'jquery'\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      oj.$ ->\n        oj.$.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrP = Array.prototype\n    FunP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrP.slice\n    unshift = ArrP.unshift\n    concat = ArrP.concat\n\nType helper for oj types\n\n    oj.isOJ = `function(obj){return !!(obj != null ? obj.isOJ : void 0);}`\n\n    oj.isOJType = `function(obj){return oj.isOJ(obj) && obj.type === obj;}`\n\n    oj.isOJInstance = `function(obj){return oj.isOJ(obj) && !oj.isOJType(obj);}`\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isPlainObject = oj.$.isPlainObject\n    oj.isFunction = oj.$.isFunction\n    oj.isArray = oj.$.isArray\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = `function(c){return !!(c.match(\/[A-Z]\/));}`\n    _identity = `function(v){return v;}`\n    _has = `function(obj, key){return ObjP.hasOwnProperty.call(obj, key);}`\n    _keys = Object.keys\n    _values = `function(obj){var keys = _keys(obj);var length = keys.length; var values = new Array(length); for (var i = 0; i < length; i++) {values[i] = obj[keys[i]]; } return values;}`\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      return obj unless (oj.isArray obj) or ((oj.typeOf obj) == 'object')\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n\n  _extend\n\n    _extend = oj.$.extend\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\nError Handling Helpers\n-----------------------------------------------------------------------------\n  Assert cond is true or throw message\n\n    _a = (cond, msg, fn) ->\n      if !cond\n        if fn\n          msg = \"oj.#{fn}: #{msg}\"\n        throw new Error msg\n      return\n\n  Validate fn argument at position n matches type\n\n    _v = (fn, n, v, type) ->\n      n = {1:'first', 2:'second',3:'third',4:'fourth',5:'fifth'}[n]\n      _a (!type or (typeof v == type)), \"#{type} expected for #{n} argument\", fn\n      return\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      r.map (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathRx = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (fname) ->\n      result = _pathRx.exec fname\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      isAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !isAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        isAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !isAbsolute).join('\/')\n\n      ((if isAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n      _v 'addMethod', 2, methodName, 'string'\n      _v 'addMethod', 3, method, 'function'\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n      _v 'removeMethod', 2, methodName, 'string'\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n      _v 'addProperty', 2, propName, 'string'\n      _v 'addProperty', 3, propInfo, 'object'\n\nDefault properties to enumerable and configurable\n\n      propInfo = _extend\n        enumerable: true\n        configurable: true\n        propInfo\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n      _v 'removeProperty', 2, propName, 'string'\n      delete obj[propName]\n      return\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      _v 'isProperty', 2, propName, 'string'\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, rest...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      _v 'tag', 1, name, 'string'\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from rest by unioning all objects\n\n      {args, options:attributes} = oj.unionArguments rest\n\n      if isQuiet = attributes.__quiet__\n        delete attributes.__quiet__\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isPlainObject arg\n          continue\n\n        else if oj.isFunction arg\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to.\n  Do not emit when quiet is set,\n\n      oj._argsAppend(ojml) unless isQuiet\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      oj.tag.elements.open.indexOf(tag) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Get quiet tag name\n\n    _getQuietTagName = (tag) ->\n      '_' + tag\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n\n  Tag functions emit by default\n\n        oj[t] = -> oj.tag t, arguments...\n\n  Underscore tag functions do not emit\n\n        qt = _getQuietTagName t\n        oj[qt] = -> oj.tag t, {__quiet__:1}, arguments...\n\n  Record the tag name so the OJML syntax can use the function instead of a string\n\n        _setTagName oj[t], t\n        _setTagName oj[qt], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extendInto (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.useGlobally = oj.extendInto = (context = root) ->\n\n      o = {}\n      for k,v of oj\n        if k[0] != '_' and k != 'extendInto' and k != 'useGlobally'\n          o[k] = v\n\n  Export _tag and _Type methods\n\n          qn = _getQuietTagName k\n          if oj[qn]\n            o[qn] = oj[qn]\n\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* minify - Minify js and css\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _extend\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        minify: false\n        ignore: {}\n        options\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, minify: options.minify, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      options = _extend\n        inline: true\n        indent: ''\n        options\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isPlainObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators (it outputs flatMapAcc)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n\n  Base Case: Record our selector when `rules` is a value\n\n        if typeof rules != 'object'\n\n  Join selectors and media accumulators with commas\n\n          selectorJoined = selectorsAcc.sort().join ','\n          mediaJoined = mediasAcc.sort().join ','\n\n  Prepend @media as that was removed previously when spliting into parts\n\n          mediaJoined = \"@media \" + mediaJoined if mediaJoined != ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaJoined, selectorJoined, selector, rules\n\n        else\n\n  Recursive Case: Recurse on `rules` when it is an object\n\n  (r1) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n            isMedia = true\n            mediasNext = next = []\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n            acc = mediasAcc\n\n  (r2) Selector found: Generate the next selectors\n\n          else\n            isMedia = false\n            selectorsNext = next = []\n            mediasNext = mediasAcc\n            acc = selectorsAcc\n\n  Media queries and Selectors can be comma seperated\n\n          parts = _splitAndTrim selector, ','\n\n  Media queries have convience substitutions like 'phone', 'tablet'\n\n          if isMedia\n            parts = parts.map (v) ->\n              if medias[v]? then medias[v] else v\n\n  Determine the next selectors or media queries\n\n          for outer in acc\n            for inner in parts\n\n  When `&` is not present just insert in front with the correct join operator\n\n              cur = inner\n              if (inner.indexOf '&') == -1 and outer != ''\n                cur = (if isMedia then '& and ' else '& ') + cur\n\n              next.push cur.replace(\/&\/g, outer)\n\n  Recurse through objects after calculating the next selectors\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.minify then '' else '\\n'\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if (!minify) and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if (!minify) then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\nminify:false will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (any, options) ->\n\n      if oj.isArray any\n        _compileTag any, options\n\n      else if oj.isString any\n        options.html?.push any\n        if any.length > 0 and any[0] == '<'\n          root = document.createElement 'div'\n          root.innerHTML = any\n          els = root.childNodes\n          options.dom?.appendChild root\n          # for el in els\n          #   options.dom?.appendChild el\n        else\n          options.dom?.appendChild document.createTextNode any\n\n      else if oj.isBoolean(any) or oj.isNumber(any)\n        options.html?.push \"#{any}\"\n        options.dom?.appendChild document.createTextNode \"#{any}\"\n\n      else if oj.isFunction any\n        # Wrap function call to allow full oj generation within any\n        _compileAny (oj any), options\n\n      else if oj.isDate any\n        options.html?.push \"#{any.toLocaleString()}\"\n        options.dom?.appendChild document.createTextNode \"#{any.toLocaleString()}\"\n\n      else if oj.isOJ any\n        options.types?.push any\n        options.html?.push any.toHTML(options)\n        options.dom?.appendChild any.toDOM(options)\n        if options.css?\n          _extend options.css, any.toCSSMap(options)\n\n      # Do nothing for: null, undefined, object\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isPlainObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        _v 'compile', 1, ojml[1], 'string'\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isPlainObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip indention if there is only one child\n          if !options.minify and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if (!options.minify) and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n_attributesProcessedForOJ: Process attributes to make them easier to use\n\n    _attributesProcessedForOJ = (attr) ->\n      jqEvents = `{bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mouseleave:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1}`\n\n  Allow attributes to alias c to class and use arrays instead of space seperated strings\n\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n\n  Allow attributes to take style as an object\n\n      if oj.isPlainObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n\n  Omit attributes with values of false, null, or undefined\n\n      if oj.isPlainObject attr\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n  Filter out jquery events\n\n      events = {}\n      if oj.isPlainObject attr\n        # Filter out attributes that are jquery events\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqEvents[k]?\n            events[k] = v\n            delete attr[k]\n\n  Returns bindable events\n\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        _a oj.$?, \"oj: jquery is missing when binding a '#{ek}' event\"\n        if oj.isArray ev\n          oj.$(el)[ek].apply @, ev\n        else\n          oj.$(el)[ek](ev)\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isPlainObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isPlain options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n_inherit\n------------------------------------------------------------------------------\nBased on, but sadly incompatable with, coffeescript inheritance\n\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n_construct(Type, arg1, arg2, ...)\n------------------------------------------------------------------------------\nConstruct with specified arguments. This is only necessary because new doesn't support apply\/call directly.\n\n    _construct = (Type) ->\n      new (FunP.bind.apply(Type, arguments));\n\noj.argumentShift\n------------------------------------------------------------------------------\nHelper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isPlainObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      _v 'createType', 1, name, 'string'\n      _v 'createType', 2, args, 'object'\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSort Out::properties.concat propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSort Out::methods.concat methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isPlainObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        has: (k) ->\n          @properties.some (v) -> v == k\n\n        # can: Determine if method exists\n        can: (k) ->\n          @methods.some (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isPlainObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\n_createQuietType\n-------------------------------------------------------------------------------\n\n    _createQuietType = (typeName) ->\n      oj[_getQuietTagName typeName] = ->\n        _construct oj[typeName], arguments..., __quiet__:1\n\noj.createEnum\n------------------------------------------------------------------------\n\n    oj.createEnum = (name, args) ->\n      _a 0, 'NYI', 'createEnum'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: ->\n        _a oj.isDOM(@el), 'constructor failed to set this.el', @typeName\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        {options,args} = oj.unionArguments arguments\n\n        # Emit as a tag if new wasn't called or quiet is not set\n        if @.__autonew__ and not options.__quiet__\n          @emit()\n\n        # Remove quiet flag\n        if options.__quiet__?\n          delete options.__quiet__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _clone options\n        @properties.forEach (v) -> delete options[v]\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = oj.$ @el)\n\n        # Get and set id attribute of view\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # # Get and set class attribute of view\n        # class:\n        #   get: -> @$el.attr 'class'\n        #   set: (v) ->\n        #     # Join arrays with spaces\n        #     if oj.isArray v\n        #       v = v.join ' '\n        #     @$el.attr 'class', v\n        #     return\n\n        # Alias for classes\n        # c:\n        #   get: -> @class\n        #   set: (v) -> @class = v; return\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          slice.call(@el.attributes).forEach (attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all classes as an array (readwrite)\n        classes:\n          get: ->\n            @$el.attr('class').split(\/\\s+\/)\n          set: (v) ->\n            @$el.attr('class', v.join(' '))\n            return\n\n        # Get \/ set all currently set themes (readwrite)\n        themes:\n          get: ->\n            thms = []\n            prefix = 'theme-'\n            for cls in @classes\n              if cls.indexOf(prefix) == 0\n                thms.push cls.slice prefix.length\n            thms\n\n          set: (v) ->\n            v = [v] unless oj.isArray v\n            @clearThemes()\n            for theme in v\n              @addTheme theme\n            return\n\n        theme:\n          get: -> @themes\n          set: (v) -> @themes = v; return\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isPlainObject attr\n            for k,v of attr\n              if k == 'class'\n                @addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single class\n        addClass: (name) ->\n          @$el.addClass name\n          return\n\n        # Remove a single class\n        removeClass: (name) ->\n          @$el.removeClass name\n          return\n\n        # Determine if class is applied\n        hasClass: (name) ->\n          @$el.hasClass name\n\n        # Add a single theme\n        addTheme: (name) ->\n          @addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @removeClass \"theme-#{name}\"\n          return\n\n        # Determine if theme is applied\n        hasTheme: (name) ->\n          @hasClass \"theme-#{name}\"\n\n        # Clear all themes\n        clearThemes: ->\n          for theme in @themes\n            @removeTheme theme\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.minify then '' else '\\n')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (options) -> _cssFromPluginObject (_flattenCSSMap @cssMap), _extend({}, minify:options.minify, tags:0)\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      _a oj.isString(css) or oj.isPlainObject(css), 'object or string expected for first argument', @typeName\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      _v @typeName, 1, name, 'string'\n      _v @typeName, 2, css, 'object'\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      @themes = _uniqueSort @themes\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> _a 0, '`make` method not implemented by custom view', @typeName\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> _a 0, '`make` method not implemented by custom view', @typeName\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> _a 0, 'value getter not implemented', @typeName\n          set: (v) -> _a 0, 'value setter not implemented', @typeName\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.Text\n------------------------------------------------------------------------------\nText control\n\n    oj.Text = oj.createType 'Text',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Get tag name if provided\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @el = oj =>\n          oj[@tagName]()\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.Text.base.constructor.call @, options\n\n      properties:\n\nvalue: text value of this object (readwrite)\n\n        value:\n          get: -> @$el.ojValue()\n          set: (v) -> @$el.oj(v); return\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = oj.argumentShift(options, 'value') || args.join('\\n');\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\n\n\n\noj.Image\n------------------------------------------------------------------------------\noj.Image creates an `<img>` tag\n\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          ixNew = if ix < 0 then ix + count else ix\n          unless 0 <= ixNew and ixNew < count\n            throw new Error(\"oj.#{@typeName}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n          ixNew\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n          # ix defaults to -1 and is optional\n          if not ojml?\n            ojml = ix\n            ix = -1\n          ix = @_bound ix, @count+1, \".add: index\"\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix = -1) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = @$tdsRow(rx).toArray().map (el) -> $(el).ojValue()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          if not listOJML?\n            listOJML = rx\n            rx = -1\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          throw new Error('oj.addRow: expected array for row content') unless oj.isArray listOJML\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx = -1) ->\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> @$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          ixNew = if ix < 0 then ix + count else ix\n          unless 0 <= ixNew and ixNew < count\n            throw new Error(\"oj.#{@typeName}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n          ixNew\n\nCreate _Types\n------------------------------------------------------------------------------\n\n  Type with captital first letter that doesn't end in \"View\"\n\n    for typeName of oj\n      if _isCapitalLetter(typeName[0]) and typeName.slice(typeName.length - 4) != 'View'\n        oj[_getQuietTagName typeName] = _createQuietType typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if (key.length > 0 and key[0] != '_') or (key.length > 0 and key[0] == '_' and (oj[key.slice(1)])?)\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      _v 'use', 1, plugin, 'function'\n      _v 'use', 2, settings, 'object'\n\n      # Call plugin to gather extension map\n      pluginResult = plugin oj, settings\n\n      # Add _Type quiet types\n      pluginMap = _clone pluginResult\n      for name,value of pluginResult\n        if oj.isOJType value\n          pluginMap[_getQuietTagName name] = _createQuietType value.typeName\n\n      # Extend all properties\n      for name,value of pluginMap\n        # Add to oj\n        oj[name] = value\n\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqExtend(fn)\n-----------------------------------------------------------------------------\njQuery Extend\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqExtend = (options = {}) ->\n      options =  _extend get:_identity, set:_identity, first: false, options\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get oj.$(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set oj.$(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if oj.$('.' + _styleClassFromPlugin plugin).length == 0\n          oj.$('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    oj.$.fn.oj = _jqExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    oj.$.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:'deep', meta:1, title:'deep', link:'deep', script:'deep'\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj.compile: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      oj.$('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      if oj.isDOMText child\n      # Parse the text to turn it into bool, number, or string\n        text = oj.parse child.nodeValue\n\n      # Get elements as oj instances or elements\n      else if oj.isDOMElement child\n        if (inst = _getInstanceOnElement child)?\n          inst\n        else\n          child\n\n    oj.$.fn.ojValue = _jqExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    oj.$.fn.ojValues = _jqExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        oj.$.fn[ojName] = _jqExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","old_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\noj function\n-------------------------------------------------------------------------------\n\n  oj function acts like a tag method that doesn't emit\n  Using inline js so the function can be named\n\n    `function oj(){return oj.tag.apply(this, ['oj'].concat([].slice.call(arguments)).concat([{__quiet__:1}]));}`\n\n  Define oj version\n\n    oj.version = '0.2.0'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Store jQuery reference as either the global reference or as required through `jquery2`.\n  This allows this reference to be included as a script tag, included through npm, or overriden.\n\n    if typeof $ != 'undefined'\n      oj.$ = $\n    else if typeof require != 'undefined'\n      try\n        oj.$ = require 'jquery'\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      oj.$ ->\n        oj.$.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrP = Array.prototype\n    FunP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrP.slice\n    unshift = ArrP.unshift\n    concat = ArrP.concat\n\nType helper for oj types\n\n    oj.isOJ = `function(obj){return !!(obj != null ? obj.isOJ : void 0);}`\n\n    oj.isOJType = `function(obj){return oj.isOJ(obj) && obj.type === obj;}`\n\n    oj.isOJInstance = `function(obj){return oj.isOJ(obj) && !oj.isOJType(obj);}`\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isPlainObject = oj.$.isPlainObject\n    oj.isFunction = oj.$.isFunction\n    oj.isArray = oj.$.isArray\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = `function(c){return !!(c.match(\/[A-Z]\/));}`\n    _identity = `function(v){return v;}`\n    _has = `function(obj, key){return ObjP.hasOwnProperty.call(obj, key);}`\n    _keys = Object.keys\n    _values = `function(obj){var keys = _keys(obj);var length = keys.length; var values = new Array(length); for (var i = 0; i < length; i++) {values[i] = obj[keys[i]]; } return values;}`\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      return obj unless (oj.isArray obj) or ((oj.typeOf obj) == 'object')\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n\n  _extend\n\n    _extend = oj.$.extend\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\nError Handling Helpers\n-----------------------------------------------------------------------------\n  Assert cond is true or throw message\n\n    _a = (cond, msg, fn) ->\n      if !cond\n        if fn\n          msg = \"oj.#{fn}: #{msg}\"\n        throw new Error msg\n      return\n\n  Validate fn argument at position n matches type\n\n    _v = (fn, n, v, type) ->\n      n = {1:'first', 2:'second',3:'third',4:'fourth',5:'fifth'}[n]\n      _a (!type or (typeof v == type)), \"#{type} expected for #{n} argument\", fn\n      return\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      r.map (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathRx = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (fname) ->\n      result = _pathRx.exec fname\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      isAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !isAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        isAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !isAbsolute).join('\/')\n\n      ((if isAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n      _v 'addMethod', 2, methodName, 'string'\n      _v 'addMethod', 3, method, 'function'\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n      _v 'removeMethod', 2, methodName, 'string'\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n      _v 'addProperty', 2, propName, 'string'\n      _v 'addProperty', 3, propInfo, 'object'\n\nDefault properties to enumerable and configurable\n\n      propInfo = _extend\n        enumerable: true\n        configurable: true\n        propInfo\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n      _v 'removeProperty', 2, propName, 'string'\n      delete obj[propName]\n      return\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      _v 'isProperty', 2, propName, 'string'\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, rest...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      _v 'tag', 1, name, 'string'\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from rest by unioning all objects\n\n      {args, options:attributes} = oj.unionArguments rest\n\n      if isQuiet = attributes.__quiet__\n        delete attributes.__quiet__\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isPlainObject arg\n          continue\n\n        else if oj.isFunction arg\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to.\n  Do not emit when quiet is set,\n\n      oj._argsAppend(ojml) unless isQuiet\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      oj.tag.elements.open.indexOf(tag) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Get quiet tag name\n\n    _getQuietTagName = (tag) ->\n      '_' + tag\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n\n  Tag functions emit by default\n\n        oj[t] = -> oj.tag t, arguments...\n\n  Underscore tag functions do not emit\n\n        qt = _getQuietTagName t\n        oj[qt] = -> oj.tag t, {__quiet__:1}, arguments...\n\n  Record the tag name so the OJML syntax can use the function instead of a string\n\n        _setTagName oj[t], t\n        _setTagName oj[qt], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extendInto (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.useGlobally = oj.extendInto = (context = root) ->\n\n      o = {}\n      for k,v of oj\n        if k[0] != '_' and k != 'extendInto' and k != 'useGlobally'\n          o[k] = v\n\n  Export _tag and _Type methods\n\n          qn = _getQuietTagName k\n          if oj[qn]\n            o[qn] = oj[qn]\n\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* minify - Minify js and css\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _extend\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        minify: false\n        ignore: {}\n        options\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, minify: options.minify, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      options = _extend\n        inline: true\n        indent: ''\n        options\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isPlainObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = mediaParts.map (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.minify then '' else '\\n'\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if (!minify) and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if (!minify) then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\nminify:false will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (any, options) ->\n\n      if oj.isArray any\n        _compileTag any, options\n\n      else if oj.isString any\n        options.html?.push any\n        if any.length > 0 and any[0] == '<'\n          root = document.createElement 'div'\n          root.innerHTML = any\n          els = root.childNodes\n          options.dom?.appendChild root\n          # for el in els\n          #   options.dom?.appendChild el\n        else\n          options.dom?.appendChild document.createTextNode any\n\n      else if oj.isBoolean(any) or oj.isNumber(any)\n        options.html?.push \"#{any}\"\n        options.dom?.appendChild document.createTextNode \"#{any}\"\n\n      else if oj.isFunction any\n        # Wrap function call to allow full oj generation within any\n        _compileAny (oj any), options\n\n      else if oj.isDate any\n        options.html?.push \"#{any.toLocaleString()}\"\n        options.dom?.appendChild document.createTextNode \"#{any.toLocaleString()}\"\n\n      else if oj.isOJ any\n        options.types?.push any\n        options.html?.push any.toHTML(options)\n        options.dom?.appendChild any.toDOM(options)\n        if options.css?\n          _extend options.css, any.toCSSMap(options)\n\n      # Do nothing for: null, undefined, object\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isPlainObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        _v 'compile', 1, ojml[1], 'string'\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isPlainObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip indention if there is only one child\n          if !options.minify and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if (!options.minify) and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n_attributesProcessedForOJ: Process attributes to make them easier to use\n\n    _attributesProcessedForOJ = (attr) ->\n      jqEvents = `{bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mouseleave:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1}`\n\n  Allow attributes to alias c to class and use arrays instead of space seperated strings\n\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n\n  Allow attributes to take style as an object\n\n      if oj.isPlainObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n\n  Omit attributes with values of false, null, or undefined\n\n      if oj.isPlainObject attr\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n  Filter out jquery events\n\n      events = {}\n      if oj.isPlainObject attr\n        # Filter out attributes that are jquery events\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqEvents[k]?\n            events[k] = v\n            delete attr[k]\n\n  Returns bindable events\n\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        _a oj.$?, \"oj: jquery is missing when binding a '#{ek}' event\"\n        if oj.isArray ev\n          oj.$(el)[ek].apply @, ev\n        else\n          oj.$(el)[ek](ev)\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isPlainObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isPlain options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n_inherit\n------------------------------------------------------------------------------\nBased on, but sadly incompatable with, coffeescript inheritance\n\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n_construct(Type, arg1, arg2, ...)\n------------------------------------------------------------------------------\nConstruct with specified arguments. This is only necessary because new doesn't support apply\/call directly.\n\n    _construct = (Type) ->\n      new (FunP.bind.apply(Type, arguments));\n\noj.argumentShift\n------------------------------------------------------------------------------\nHelper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isPlainObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      _v 'createType', 1, name, 'string'\n      _v 'createType', 2, args, 'object'\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSort Out::properties.concat propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSort Out::methods.concat methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isPlainObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        has: (k) ->\n          @properties.some (v) -> v == k\n\n        # can: Determine if method exists\n        can: (k) ->\n          @methods.some (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isPlainObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\n_createQuietType\n-------------------------------------------------------------------------------\n\n    _createQuietType = (typeName) ->\n      oj[_getQuietTagName typeName] = ->\n        _construct oj[typeName], arguments..., __quiet__:1\n\noj.createEnum\n------------------------------------------------------------------------\n\n    oj.createEnum = (name, args) ->\n      _a 0, 'NYI', 'createEnum'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: ->\n        _a oj.isDOM(@el), 'constructor failed to set this.el', @typeName\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        {options,args} = oj.unionArguments arguments\n\n        # Emit as a tag if new wasn't called or quiet is not set\n        if @.__autonew__ and not options.__quiet__\n          @emit()\n\n        # Remove quiet flag\n        if options.__quiet__?\n          delete options.__quiet__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _clone options\n        @properties.forEach (v) -> delete options[v]\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = oj.$ @el)\n\n        # Get and set id attribute of view\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # # Get and set class attribute of view\n        # class:\n        #   get: -> @$el.attr 'class'\n        #   set: (v) ->\n        #     # Join arrays with spaces\n        #     if oj.isArray v\n        #       v = v.join ' '\n        #     @$el.attr 'class', v\n        #     return\n\n        # Alias for classes\n        # c:\n        #   get: -> @class\n        #   set: (v) -> @class = v; return\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          slice.call(@el.attributes).forEach (attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all classes as an array (readwrite)\n        classes:\n          get: ->\n            @$el.attr('class').split(\/\\s+\/)\n          set: (v) ->\n            @$el.attr('class', v.join(' '))\n            return\n\n        # Get \/ set all currently set themes (readwrite)\n        themes:\n          get: ->\n            thms = []\n            prefix = 'theme-'\n            for cls in @classes\n              if cls.indexOf(prefix) == 0\n                thms.push cls.slice prefix.length\n            thms\n\n          set: (v) ->\n            v = [v] unless oj.isArray v\n            @clearThemes()\n            for theme in v\n              @addTheme theme\n            return\n\n        theme:\n          get: -> @themes\n          set: (v) -> @themes = v; return\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isPlainObject attr\n            for k,v of attr\n              if k == 'class'\n                @addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single class\n        addClass: (name) ->\n          @$el.addClass name\n          return\n\n        # Remove a single class\n        removeClass: (name) ->\n          @$el.removeClass name\n          return\n\n        # Determine if class is applied\n        hasClass: (name) ->\n          @$el.hasClass name\n\n        # Add a single theme\n        addTheme: (name) ->\n          @addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @removeClass \"theme-#{name}\"\n          return\n\n        # Determine if theme is applied\n        hasTheme: (name) ->\n          @hasClass \"theme-#{name}\"\n\n        # Clear all themes\n        clearThemes: ->\n          for theme in @themes\n            @removeTheme theme\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.minify then '' else '\\n')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (options) -> _cssFromPluginObject (_flattenCSSMap @cssMap), _extend({}, minify:options.minify, tags:0)\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      _a oj.isString(css) or oj.isPlainObject(css), 'object or string expected for first argument', @typeName\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      _v @typeName, 1, name, 'string'\n      _v @typeName, 2, css, 'object'\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      @themes = _uniqueSort @themes\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> _a 0, '`make` method not implemented by custom view', @typeName\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> _a 0, '`make` method not implemented by custom view', @typeName\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> _a 0, 'value getter not implemented', @typeName\n          set: (v) -> _a 0, 'value setter not implemented', @typeName\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.Text\n------------------------------------------------------------------------------\nText control\n\n    oj.Text = oj.createType 'Text',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Get tag name if provided\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @el = oj =>\n          oj[@tagName]()\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.Text.base.constructor.call @, options\n\n      properties:\n\nvalue: text value of this object (readwrite)\n\n        value:\n          get: -> @$el.ojValue()\n          set: (v) -> @$el.oj(v); return\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = oj.argumentShift(options, 'value') || args.join('\\n');\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\n\n\n\noj.Image\n------------------------------------------------------------------------------\noj.Image creates an `<img>` tag\n\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          ixNew = if ix < 0 then ix + count else ix\n          unless 0 <= ixNew and ixNew < count\n            throw new Error(\"oj.#{@typeName}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n          ixNew\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n          # ix defaults to -1 and is optional\n          if not ojml?\n            ojml = ix\n            ix = -1\n          ix = @_bound ix, @count+1, \".add: index\"\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix = -1) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = @$tdsRow(rx).toArray().map (el) -> $(el).ojValue()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          if not listOJML?\n            listOJML = rx\n            rx = -1\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          throw new Error('oj.addRow: expected array for row content') unless oj.isArray listOJML\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx = -1) ->\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> @$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          ixNew = if ix < 0 then ix + count else ix\n          unless 0 <= ixNew and ixNew < count\n            throw new Error(\"oj.#{@typeName}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n          ixNew\n\nCreate _Types\n------------------------------------------------------------------------------\n\n  Type with captital first letter that doesn't end in \"View\"\n\n    for typeName of oj\n      if _isCapitalLetter(typeName[0]) and typeName.slice(typeName.length - 4) != 'View'\n        oj[_getQuietTagName typeName] = _createQuietType typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if (key.length > 0 and key[0] != '_') or (key.length > 0 and key[0] == '_' and (oj[key.slice(1)])?)\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      _v 'use', 1, plugin, 'function'\n      _v 'use', 2, settings, 'object'\n\n      # Call plugin to gather extension map\n      pluginResult = plugin oj, settings\n\n      # Add _Type quiet types\n      pluginMap = _clone pluginResult\n      for name,value of pluginResult\n        if oj.isOJType value\n          pluginMap[_getQuietTagName name] = _createQuietType value.typeName\n\n      # Extend all properties\n      for name,value of pluginMap\n        # Add to oj\n        oj[name] = value\n\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqExtend(fn)\n-----------------------------------------------------------------------------\njQuery Extend\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqExtend = (options = {}) ->\n      options =  _extend get:_identity, set:_identity, first: false, options\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get oj.$(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set oj.$(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if oj.$('.' + _styleClassFromPlugin plugin).length == 0\n          oj.$('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    oj.$.fn.oj = _jqExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    oj.$.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:'deep', meta:1, title:'deep', link:'deep', script:'deep'\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj.compile: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      oj.$('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      if oj.isDOMText child\n      # Parse the text to turn it into bool, number, or string\n        text = oj.parse child.nodeValue\n\n      # Get elements as oj instances or elements\n      else if oj.isDOMElement child\n        if (inst = _getInstanceOnElement child)?\n          inst\n        else\n          child\n\n    oj.$.fn.ojValue = _jqExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    oj.$.fn.ojValues = _jqExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        oj.$.fn[ojName] = _jqExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b74d8efbd55f5222c8646da6a3213f822f13cc52","subject":"Fix typo","message":"Fix typo\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/07_request.litcoffee","new_file":"docs\/07_request.litcoffee","new_contents":"# Batman.Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented in the platform layer files.\n\n## Platform Request Implementation Libraries\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\nBatman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\nIn other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n\n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n\nThere are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n1. `loading()`: fired before `send()` has been called.\n\n        test \"Demonstrate the loading event\", 1, ->\n           new Batman.Request\n             url: \"http::\/\/batmanjs.org\"\n             loading: ->\n               ok true, \"After send but before the request is made\"\n\n1. `loaded()`: fired after the request is complete\n\n         test \"Demo the loaded event\", 1, ->\n           Batman.Request.setupMockedResponse()\n           Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n           new Batman.Request\n             url: \"http:\/\/batmanjs.org\"\n             loaded: ->\n               ok true, \"Loaded\"\n\n1. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n        test \"Demo the error event\", 1, ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            error: (xhr) ->\n              ok true, \"Error\"\n\n1. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n        test \"Demonstrate the success event\", 1,  ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            success: (response) ->\n              equal \"foo\", response\n\n## .status\nThe response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\nThe response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : object\nAn key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request(options : object)\n\nConstructs a new `Batman.Request` with the supplied options\n\n### `options` description\n\n1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n\n1. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`.\n\n        test \"method test\", ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            method: \"POST\"\n            data: { some: \"data\" }\n            success: (response) ->\n              ok true\n\n1. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n\n1. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n        test \"contentType default\", ->\n           req = new Batman.Request\n           equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n1. `autosend`: controls whether the request will be sent automatically, defaults to `true`\n\n        test \"autosend test\", ->\n          response_sent = false\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n          req = new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            autosend: false\n            success: (response) ->\n              response_sent = true\n          ok !response_sent\n          req.send()\n          ok response_sent\n\n1. `username`: username for authentication\n\n1. `password`: password for authentication\n\n1. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send([data])\nIf `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","old_contents":"# Batman.Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented in the platform layer files.\n\n## Platform Request Implementation Libraries\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\nBatman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\nIn other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n\n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n\nThere are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n1. `loading()`: fired before `send()` has been called.\n\n        test \"Demonstrate the loading event\", 1, ->\n           new Batman.Request\n             url: \"http::\/\/batmanjs.org\"\n             loading: ->\n               ok true, \"After send but before the request is made\"\n\n1. `loaded()`: fired after the request is complete\n\n         test \"Demo the loaded event\", 1, ->\n           Batman.Request.setupMockedResponse()\n           Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n           new Batman.Request\n             url: \"http:\/\/batmanjs.org\"\n             loaded: ->\n               ok true, \"Loaded\"\n\n1. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n        test \"Demo the error event\", 1, ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            error: (xhr) ->\n              ok true, \"Error\"\n\n1. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n        test \"Demonstrate the success event\", 1,  ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            success: (response) ->\n              equal \"foo\", response\n\n## .status\nThe response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\nThe response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : object\nAn key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request(options : object)\n\nConstructs a new `Batman.Request` with the supplied options\n\n### `options` description\n\n1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n\n1. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`.\n\n        test \"method test\", ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            method: \"POST\"\n            data: { some: \"data\" }\n            success: (response) ->\n              ok true\n\n1. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n\n1. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n        test \"contentType default\", ->\n           req = new Batman.Request\n           equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n1. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n        test \"autosend test\", ->\n          response_sent = false\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n          req = new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            autosend: false\n            success: (response) ->\n              response_sent = true\n          ok !response_sent\n          req.send()\n          ok response_sent\n\n1. `username`: username for authentication\n\n1. `password`: password for authentication\n\n1. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send([data])\nIf `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b4f3a06cb9c5ebd557ead65d7b61b8390d3635ee","subject":"oneof fix","message":"oneof fix\n","repos":"vpj\/models","old_file":"js\/properties\/oneof.litcoffee","new_file":"js\/properties\/oneof.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#OneOf\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Models.Models'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, MODELS, WeyaBase, Weya) ->\n\n\nClass\n\n      class OneOf extends Base\n       @extend()\n\n       propertyType: 'oneof'\n\n       @default 'oneof', ['Null']\n       @default 'default', ->\n        return null if @schema.oneof.length is 0\n        model = new (MODELS.get @schema.oneof[0])\n        r = model.parse @schema.defaultValues.call this\n        return r.value\n\n       @default 'defaultValues', -> {}\n\n       @default 'isDefault', (value) ->\n        return true if @schema.oneof.length is 0\n        model = new (MODELS.get @schema.oneof[0])\n        res = model.parse value\n        if res.score isnt 1\n         return false\n        model.isDefault()\n\n       @isValidSchema: (schema) ->\n        return false if not super schema\n        return false if not schema.oneof?\n        return true\n\n       parse: (data, stack) ->\n        r = super data, stack\n        return r unless r is true\n\n        res = @error 'invalid'\n        for type in @schema.oneof\n         m = new (MODELS.get type)\n         r = m.parse data, stack\n         if res.score < r.score\n          res = r\n\n        return res\n\n       toJSON: (value, stack) -> value.toJSON stack\n       toJSONFull: (value, stack) -> value.toJSONFull stack\n\n       edit: (elem, value, onChanged, stack) ->\n        new Edit this, elem, value, onChanged, stack\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, onChanged, stack) ->\n        @property = property\n        @elems =\n         parent: elem\n        @model = value\n        @onChanged = onChanged\n        @stack = stack\n        @render()\n\n       render: ->\n        Weya elem: @elems.parent, context: this, ->\n         @$.elems.controls = @div \".oneof-controls\", ->\n          @$.elems.type = @select on: {change: @$.on.typeChange}, ->\n           for type in @$.property.schema.oneof\n            @option value: type, type\n\n         @$.elems.model = @div \".model\", null\n\n        if @property.schema.oneof.length <= 1\n         @elems.controls.style.display = 'none'\n\n        @renderModel()\n\n       @listen 'typeChange', (e) ->\n        type = @elems.type.value\n        return if type is @model.type\n        json = @model.toJSON @stack\n        @model = new (MODELS.get type)\n        r = @model.parse json, @stack\n        @onChanged @model, true\n        @renderModel()\n\n       renderModel: ->\n        @elems.model.innerHTML = ''\n        @elems.type.value = @model.type\n        @model.edit @elems.model,\n         @modelChanged.bind this\n         @stack\n\n       modelChanged: (value) ->\n        @onChanged value, false\n\n\n\n\n\n      PROPERTIES.register 'oneof', OneOf\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#OneOf\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Models.Models'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, MODELS, WeyaBase, Weya) ->\n\n\nClass\n\n      class OneOf extends Base\n       @extend()\n\n       propertyType: 'oneof'\n\n       @default 'oneof', ['Null']\n       @default 'default', ->\n        return null if @schema.oneof.length is 0\n        model = new (MODELS.get @schema.oneof[0])\n        r = model.parse @schema.defaultValues.call this\n        return r.value\n\n       @default 'defaultValues', -> {}\n\n       @default 'isDefault', (value) ->\n        return true if @schema.oneof.length is 0\n        model = new (MODELS.get @schema.oneof[0])\n        model.parse value\n        model.isDefault()\n\n       @isValidSchema: (schema) ->\n        return false if not super schema\n        return false if not schema.oneof?\n        return true\n\n       parse: (data, stack) ->\n        r = super data, stack\n        return r unless r is true\n\n        res = @error 'invalid'\n        for type in @schema.oneof\n         m = new (MODELS.get type)\n         r = m.parse data, stack\n         if res.score < r.score\n          res = r\n\n        return res\n\n       toJSON: (value, stack) -> value.toJSON stack\n       toJSONFull: (value, stack) -> value.toJSONFull stack\n\n       edit: (elem, value, onChanged, stack) ->\n        new Edit this, elem, value, onChanged, stack\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, onChanged, stack) ->\n        @property = property\n        @elems =\n         parent: elem\n        @model = value\n        @onChanged = onChanged\n        @stack = stack\n        @render()\n\n       render: ->\n        Weya elem: @elems.parent, context: this, ->\n         @$.elems.controls = @div \".oneof-controls\", ->\n          @$.elems.type = @select on: {change: @$.on.typeChange}, ->\n           for type in @$.property.schema.oneof\n            @option value: type, type\n\n         @$.elems.model = @div \".model\", null\n\n        if @property.schema.oneof.length <= 1\n         @elems.controls.style.display = 'none'\n\n        @renderModel()\n\n       @listen 'typeChange', (e) ->\n        type = @elems.type.value\n        return if type is @model.type\n        json = @model.toJSON stack\n        @model = new (MODELS.get type)\n        r = @model.parse json, stack\n        @onChanged @model, true\n        @renderModel()\n\n       renderModel: ->\n        @elems.model.innerHTML = ''\n        @elems.type.value = @model.type\n        @model.edit @elems.model,\n         @modelChanged.bind this\n         @stack\n\n       modelChanged: (value) ->\n        @onChanged value, false\n\n\n\n\n\n      PROPERTIES.register 'oneof', OneOf\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"681e4f30c297a6219f82ee6729b0bf22f6aac97b","subject":"remove home template helpers","message":"remove home template helpers\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"client\/views\/pages\/home.litcoffee","new_file":"client\/views\/pages\/home.litcoffee","new_contents":"","old_contents":"Autoform callback hooks\n\n    updateClock = (timeCurrentTicketExpires) ->\n      clock = ($ '.countdown-clock').FlipClock\n        autoStart: yes\n        countdown: yes\n        clockFace: 'MinuteCounter'\n      time = Math.round (timeCurrentTicketExpires - new Date()) \/ 1000\n      time = 0 if time < 0\n      clock.setTime time\n      clock.start() if time > 0\n\n    Template.home.rendered = ->\n      Tracker.autorun ->\n        updateClock QueueMeta.findOne()?.timeCurrentTicketExpires\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f3e0b6ba7d35e8732b03fa6dbcb5cee7561a6ab9","subject":"Limit code line length to 79 characters.","message":"Limit code line length to 79 characters.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimelineMaker` class](#the-timelinemaker-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.\n\n#### The `TimelineMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nNotes\n-----\n\n### Notes related to only this file\n\nWell, no notes yet.\n\n### Notes that should be moved away at some point\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug.\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimelineMaker` class](#the-timelinemaker-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.\n\n#### The `TimelineMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nNotes\n-----\n\n### Notes related to only this file\n\nWell, no notes yet.\n\n### Notes that should be moved away at some point\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug.\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c6b74b462091f7c6cc9529572d7ab5aab6ce7e25","subject":"Show the selected module","message":"Show the selected module\n","repos":"prophile\/happiness","old_file":"src\/components\/module-list.litcoffee","new_file":"src\/components\/module-list.litcoffee","new_contents":"Component: Module List\n======================\n\n    Happiness.ModuleList = {}\n\nThe module list is displayed to the left of the editor, and contains\na list of modules contained within the current project.\n\nThis all comes from Firebase, and the first thing we do is grab the\ncurrent child.\n\n    combinePath = (team, proj) ->\n      return null unless team?\n      return null unless proj?\n      \"#{team}\/#{proj}\"\n    rootPath = Bacon.combineWith(combinePath,\n                                 Happiness.TeamList.CurrentTeam,\n                                 Happiness.ProjectSwitcher.CurrentProject)\n    root = Happiness.Firebase.Child(rootPath)\n\nModules\n-------\n\nThe list of current modules is a matter of streaming out the list\nfrom Firebase. We do a quick check to make sure we're actually\nlooking at the current project too.\n\n    eventChecker = (expectedPath, result) ->\n      return null unless result.name() is expectedPath[1]\n      return null unless result.ref().parent().name() is expectedPath[0]\n      _.keys(result.val())\n\n    modules = Bacon.combineAsArray(Happiness.TeamList.CurrentTeam,\n                                   Happiness.ProjectSwitcher.CurrentProject)\n                   .sampledBy(Happiness.Firebase.Stream(root),\n                              eventChecker)\n                   .skipDuplicates(_.isEqual)\n                   .merge(rootPath.changes().map(null))\n                   .map((x) -> if x?.length is 0 then [\"robot\"] else x)\n                   .toProperty(null)\n    Happiness.ModuleList.Modules = modules\n\nSelected Module\n---------------\n\nThe selected module can be changed by a number of factors.\n\n    selectedModule = new Bacon.Bus()\n\nFirstly, it gets reset when we change project: to null if there is no project,\notherwise to 'robot'.\n\n    selectedModule.plug rootPath.map((x) -> if x? then \"robot\" else null)\n\n    Happiness.ModuleList.CurrentModule = selectedModule.skipDuplicates()\n                                                       .toProperty(null)\n\nModule List\n-----------\n\nWhenever the module list gets updated, we re-create the selector.\n\n    Happiness.ModuleList.Modules\n                        .toEventStream()\n                        .filter((x) -> x?)\n                        .onValue (mods) ->\n\nAll modules have the mod-list-item class.\n\n      $('.mod-list-item').remove()\n\n      list = $('#mod-list')\n      for mod in mods\n        element = $('<a href=\"#\">')\n        element.text(mod)\n        selectedModule.plug element.asEventStream('click')\n                                   .map(mod)\n        item = $('<li class=\"mod-list-item\">')\n        item.append element\n        list.prepend item\n\nModule Highlight\n----------------\n\nWhenever the module list or the module changes, we highlight the\ncurrently selected module.\n\n    Bacon.combineWith(((x, y) -> x),\n                      Happiness.ModuleList.CurrentModule,\n                      Happiness.ModuleList.Modules)\n         .onValue (selected) ->\n      $('.mod-list-item').each (element) ->\n        $(this).toggleClass \"active\", $(this).text() is selected\n\nNew Modules\n-----------\n\nCreating new modules is essentially the same as creating projects.\n\n    handleSubmitEvent = (event) ->\n      event.preventDefault()\n      $('#new-mod').blur()\n    newModuleRequest = $('#new-mod').asEventStream('submit', handleSubmitEvent)\n    selectedModule.plug Happiness.InputValues('#new-mod input')\n                                 .sampledBy(newModuleRequest)\n\n","old_contents":"Component: Module List\n======================\n\n    Happiness.ModuleList = {}\n\nThe module list is displayed to the left of the editor, and contains\na list of modules contained within the current project.\n\nThis all comes from Firebase, and the first thing we do is grab the\ncurrent child.\n\n    combinePath = (team, proj) ->\n      return null unless team?\n      return null unless proj?\n      \"#{team}\/#{proj}\"\n    rootPath = Bacon.combineWith(combinePath,\n                                 Happiness.TeamList.CurrentTeam,\n                                 Happiness.ProjectSwitcher.CurrentProject)\n    root = Happiness.Firebase.Child(rootPath)\n\nModules\n-------\n\nThe list of current modules is a matter of streaming out the list\nfrom Firebase. We do a quick check to make sure we're actually\nlooking at the current project too.\n\n    eventChecker = (expectedPath, result) ->\n      return null unless result.name() is expectedPath[1]\n      return null unless result.ref().parent().name() is expectedPath[0]\n      _.keys(result.val())\n\n    modules = Bacon.combineAsArray(Happiness.TeamList.CurrentTeam,\n                                   Happiness.ProjectSwitcher.CurrentProject)\n                   .sampledBy(Happiness.Firebase.Stream(root),\n                              eventChecker)\n                   .skipDuplicates(_.isEqual)\n                   .merge(rootPath.changes().map(null))\n                   .map((x) -> if x?.length is 0 then [\"robot\"] else x)\n                   .toProperty(null)\n    Happiness.ModuleList.Modules = modules\n\nSelected Module\n---------------\n\nThe selected module can be changed by a number of factors.\n\n    selectedModule = new Bacon.Bus()\n\nFirstly, it gets reset when we change project: to null if there is no project,\notherwise to 'robot'.\n\n    selectedModule.plug rootPath.map((x) -> if x? then \"robot\" else null)\n\n    Happiness.ModuleList.CurrentModule = selectedModule.skipDuplicates()\n                                                       .toProperty(null)\n\nModule List\n-----------\n\nWhenever the module list gets updated, we re-create the selector.\n\n    Happiness.ModuleList.Modules\n                        .toEventStream()\n                        .filter((x) -> x?)\n                        .onValue (mods) ->\n\nAll modules have the mod-list-item class.\n\n      $('.mod-list-item').remove()\n\n      list = $('#mod-list')\n      for mod in mods\n        element = $('<a href=\"#\">')\n        element.text(mod)\n        selectedModule.plug element.asEventStream('click')\n                                   .map(mod)\n        item = $('<li class=\"mod-list-item\">')\n        item.append element\n        list.prepend item\n\nNew Modules\n-----------\n\nCreating new modules is essentially the same as creating projects.\n\n    handleSubmitEvent = (event) ->\n      event.preventDefault()\n      $('#new-mod').blur()\n    newModuleRequest = $('#new-mod').asEventStream('submit', handleSubmitEvent)\n    selectedModule.plug Happiness.InputValues('#new-mod input')\n                                 .sampledBy(newModuleRequest)\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8c3ca2672ba3b9de2a3684f4b31f6b7db50c441e","subject":"Add binding for reidentifying the screen","message":"Add binding for reidentifying the screen\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/keyboard.litcoffee","new_file":"src\/coffee\/keyboard.litcoffee","new_contents":"Keyboard Input\n==============\n\nWe first collect an event stream of all keyboard events sent to the\npage.\n\n    keyboardEvents = $(document).asEventStream('keydown')\n                                .map('.keyCode')\n\nWe keep a map of keycodes to internal names.\n\n    keyMap =\n        48: 'view-0',\n        49: 'view-1',\n        50: 'view-2',\n        51: 'view-3',\n        52: 'view-4',\n        53: 'view-5',\n        54: 'view-6',\n        55: 'view-7',\n        56: 'view-8',\n        57: 'view-9',\n        75: 'kill', # k\n        82: 'reidentify', # t\n        84: 'load-debug', # t\n\nWe then have a stream of keyboard events coming in based on that\nmap, discarding those that are not present as well as bounces.\n\n    window.Keyboard = keyboardEvents.map( (k) -> keyMap[k] )\n                                    .filter( (x) -> x? )\n                                    .debounce(150)\n\nJudge Selection\n---------------\n\nThe keys 1-6 are used to select between display on the judge's desk.\n\nWe keep a property here to select between them.\n\n    displayMap =\n        'view-1': 'match-display'\n        'view-2': 'match-sched'\n        'view-3': 'league-state'\n        'view-4': 'knockout-state'\n        'view-5': 'next-match'\n        'view-6': 'day-sched'\n\n    window.JudgeSelection = window.Keyboard.map( (k) -> displayMap[k] )\n                                           .filter( (x) -> x? )\n                                           .toProperty('match-display')\n                                           .skipDuplicates()\n\nRe-identification Triggering\n----------------------------\n\nWhen the 'R' character is pressed, we allow the user to re-enter\nthe screen's identity.\n\n    Keyboard.filter( (x) -> x is 'reidentify' )\n            .onValue ->\n                do IdentityPrompt.push\n\n","old_contents":"Keyboard Input\n==============\n\nWe first collect an event stream of all keyboard events sent to the\npage.\n\n    keyboardEvents = $(document).asEventStream('keydown')\n                                .map('.keyCode')\n\nWe keep a map of keycodes to internal names.\n\n    keyMap =\n        48: 'view-0',\n        49: 'view-1',\n        50: 'view-2',\n        51: 'view-3',\n        52: 'view-4',\n        53: 'view-5',\n        54: 'view-6',\n        55: 'view-7',\n        56: 'view-8',\n        57: 'view-9',\n        75: 'kill', # k\n        84: 'load-debug', # t\n\nWe then have a stream of keyboard events coming in based on that\nmap, discarding those that are not present as well as bounces.\n\n    window.Keyboard = keyboardEvents.map( (k) -> keyMap[k] )\n                                    .filter( (x) -> x? )\n                                    .debounce(150)\n\nJudge Selection\n---------------\n\nThe keys 1-6 are used to select between display on the judge's desk.\n\nWe keep a property here to select between them.\n\n    displayMap =\n        'view-1': 'match-display'\n        'view-2': 'match-sched'\n        'view-3': 'league-state'\n        'view-4': 'knockout-state'\n        'view-5': 'next-match'\n        'view-6': 'day-sched'\n\n    window.JudgeSelection = window.Keyboard.map( (k) -> displayMap[k] )\n                                           .filter( (x) -> x? )\n                                           .toProperty('match-display')\n                                           .skipDuplicates()\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6f3db54c9a843cd06ba2b10a021e60758f1a73cf","subject":"error handling now prints to console","message":"error handling now prints to console\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/lib\/error\/index.litcoffee","new_file":"src\/lib\/error\/index.litcoffee","new_contents":"\n# Application Errors\n\nTo configure error middleware, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/error\")(app)` as long as `app` is an already\ninitialized ExpressJS application.\n\n    module.exports = (app) ->\n\n## Catch All\n\nIf an error occurs, return an HTTP 500\n\n      app.use (err, req, res, next) ->\n        console.error(err.stack)\n        res.status(500)\n        res.render('error\/500')\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Errors\n\nTo configure error middleware, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/error\")(app)` as long as `app` is an already\ninitialized ExpressJS application.\n\n    module.exports = (app) ->\n\n## Catch All\n\nIf an error occurs, return an HTTP 500\n\n      app.use (err, req, res, next) ->\n        res.status(500)\n        res.render('error\/500')\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"08b5bb7aeb29e4427b0c0c99eb31ac5a97fb1216","subject":"allocate dispatch table on-demand","message":"allocate dispatch table on-demand\n","repos":"nickfargo\/restate","old_file":"src\/state.litcoffee","new_file":"src\/state.litcoffee","new_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneCategory   _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method for this state. Providing an optional `out` object\nallows the appropriate `context` for a state-bound method to be delivered as a\nproperty of `out`; if included, `context` is confined to the local state tree.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out, boxed ) ->\n        realized = ~@attributes & VIRTUAL\n\n> During the pseudo-loop block, the `context` reference should be considered\n  provisional, because its potential value is in part a product of the manner\n  in which its accompanying `method` was retrieved. After `break`ing out of the\n  block, `method` can be type-checked and `context` may be kept or discarded as\n  appropriate.\n\n        loop # once\n\nFirst seek the named method locally.\n\n          if realized\n            method = @_?.methods?[ methodName ]\n            if method is rootNoop then method = null\n            if method? then context = this\n            else if record = @_?.__dispatch_table__?[ methodName ]\n              [ method, context ] = record\n            break if method?\n\nIf no method is held locally, start traversing, first up the protostate chain.\nIf this succeeds, the provisional `context` *must be the epistate* inheriting\nthe method (constrast with the `VIA_SUPER` case).\n\n          if ( viaProto = via & VIA_PROTO ) and\n              method = @protostate()?.method methodName, VIA_PROTO, out, yes\n            context = this\n            inherited = yes; break\n\nIf no method is found yet, continue traversing up the superstate chain. If this\nsucceeds, the provisional `context` *must be the superstate* from which the\nmethod is inherited.\n\n          if via & VIA_SUPER and method = @superstate?.method \\\n              methodName, VIA_SUPER | viaProto, out, yes\n            { context } = out if out?\n            inherited = yes; break\n\nThe method cannot be found.\n\n          context = null\n          break # always\n\n        if method?\n\nIf `method` is a function, it is not state-bound, so `context` is unnecessary.\n\n          if typeof method is 'function'\n            context = null\n\nIff `this` is a realized `State`, inherited lookup results can be memoized in\nthe local dispatch table.\n\n          if realized and inherited\n            table = @_?.__dispatch_table__ or = {}\n            table[ methodName ] = [ method, context ]\n\nUnbox a state-bound function unless directed otherwise.\n\n          if not boxed and method.type is 'state-bound-function'\n            method = method.fn\n\nExport `method` and `context` together if the `out` reference was provided.\n\n> Callers who know that `method` will be unbound need not provide an `out`.\n\n        if out?\n          out.method = method\n          out.context = context\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state. The provided `fn` may be any of:\n\n  1.  A proper function, which will be called in the context of `@owner`;\n  2.  A boxing of a *bound* function as prepared by `state.bind`, which will\n      cause the boxed function to be called in the context of either `this`\n      `State` or the *epistate* inheriting the method;\n  3.  A boxing of a *fixed* function as prepared by `state.fix`, whose boxed\n      function will be closed over hard references to `this` as `autostate`,\n      and to the *protostate* of `this`, as `protostate`.\n\n> See also: `state.bind`, `state.fix`\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` boxes a *state-fixed* function, then partially apply that function to\nextract the actual method, closed over references to the locality of `this`.\n\n        if typeof fn is 'object' and fn.type is 'state-fixed-function'\n          fn = fn.fn this, @protostate()\n\n        throw TypeError unless typeof fn is 'function' or\n          fn?.type is 'state-bound-function'\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root._?.methods?[ methodName ]\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n            root.addMethod methodName, ownerMethod\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context.\n\nIf the named method does not exist locally and cannot be inherited, then\n`noSuchMethod` events are emitted, and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n\nFirst try to resolve the method quickly from the local dispatch table.\n\n        if record = @_?.__dispatch_table__?[ methodName ]\n          [ method, context ] = record\n          method = method.fn if method?.type is 'state-bound-function'\n\nResort to a proper lookup if the fast way turns up nothing.\n\n        unless method?\n          if method = @method methodName, VIA_ALL, out = {}\n            { context } = out\n\nBail out gracefully if the method definitively cannot be resolved.\n\n          else\n            @emit 'noSuchMethod', [ methodName, args ]\n            @emit 'noSuchMethod:' + methodName, args\n            return\n\nIf at this point a `context` is provided, this means that `method` is a\nstate-bound function, and `context` will be the appropriately bound `State`. If\nno `context` exists, this means that `method` is a typical non-state-bound\nfunction, which is meant to be invoked in the usual fashion, just as if it were\ncalled directly as a method of `this` state\u2019s `owner`.\n\n        method.apply context or @owner, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","old_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneCategory   _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method for this state. Providing an optional `out` object\nallows the appropriate `context` for a state-bound method to be delivered as a\nproperty of `out`; if included, `context` is confined to the local state tree.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out, boxed ) ->\n        realized = ~@attributes & VIRTUAL\n\n> During the pseudo-loop block, the `context` reference should be considered\n  provisional, because its potential value is in part a product of the manner\n  in which its accompanying `method` was retrieved. After `break`ing out of the\n  block, `method` can be type-checked and `context` may be kept or discarded as\n  appropriate.\n\n        loop # once\n\nFirst seek the named method locally.\n\n          if realized\n            method = @_?.methods?[ methodName ]\n            if method is rootNoop then method = null\n            if method? then context = this\n            else if record = @_?.__dispatch_table__?[ methodName ]\n              [ method, context ] = record\n            break if method?\n\nIf no method is held locally, start traversing, first up the protostate chain.\nIf this succeeds, the provisional `context` *must be the epistate* inheriting\nthe method (constrast with the `VIA_SUPER` case).\n\n          if ( viaProto = via & VIA_PROTO ) and\n              method = @protostate()?.method methodName, VIA_PROTO, out, yes\n            context = this\n            inherited = yes; break\n\nIf no method is found yet, continue traversing up the superstate chain. If this\nsucceeds, the provisional `context` *must be the superstate* from which the\nmethod is inherited.\n\n          if via & VIA_SUPER and method = @superstate?.method \\\n              methodName, VIA_SUPER | viaProto, out, yes\n            { context } = out if out?\n            inherited = yes; break\n\nThe method cannot be found.\n\n          context = null\n          break # always\n\n        if method?\n\nIf `method` is a function, it is not state-bound, so `context` is unnecessary.\n\n          if typeof method is 'function'\n            context = null\n\nIff `this` is a realized `State`, inherited lookup results can be memoized in\nthe local dispatch table.\n\n          if realized and inherited\n            @_?.__dispatch_table__?[ methodName ] = [ method, context ]\n\nUnbox a state-bound function unless directed otherwise.\n\n          if not boxed and method.type is 'state-bound-function'\n            method = method.fn\n\nExport `method` and `context` together if the `out` reference was provided.\n\n> Callers who know that `method` will be unbound need not provide an `out`.\n\n        if out?\n          out.method = method\n          out.context = context\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state. The provided `fn` may be any of:\n\n  1.  A proper function, which will be called in the context of `@owner`;\n  2.  A boxing of a *bound* function as prepared by `state.bind`, which will\n      cause the boxed function to be called in the context of either `this`\n      `State` or the *epistate* inheriting the method;\n  3.  A boxing of a *fixed* function as prepared by `state.fix`, whose boxed\n      function will be closed over hard references to `this` as `autostate`,\n      and to the *protostate* of `this`, as `protostate`.\n\n> See also: `state.bind`, `state.fix`\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` boxes a *state-fixed* function, then partially apply that function to\nextract the actual method, closed over references to the locality of `this`.\n\n        if typeof fn is 'object' and fn.type is 'state-fixed-function'\n          fn = fn.fn this, @protostate()\n\n        throw TypeError unless typeof fn is 'function' or\n          fn?.type is 'state-bound-function'\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root._?.methods?[ methodName ]\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n            root.addMethod methodName, ownerMethod\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context.\n\nIf the named method does not exist locally and cannot be inherited, then\n`noSuchMethod` events are emitted, and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n\nFirst try to resolve the method quickly from the local dispatch table.\n\n        if record = @_?.__dispatch_table__?[ methodName ]\n          [ method, context ] = record\n          method = method.fn if method?.type is 'state-bound-function'\n\nResort to a proper lookup if the fast way turns up nothing.\n\n        unless method?\n          if method = @method methodName, VIA_ALL, out = {}\n            { context } = out\n\nBail out gracefully if the method definitively cannot be resolved.\n\n          else\n            @emit 'noSuchMethod', [ methodName, args ]\n            @emit 'noSuchMethod:' + methodName, args\n            return\n\nIf at this point a `context` is provided, this means that `method` is a\nstate-bound function, and `context` will be the appropriately bound `State`. If\nno `context` exists, this means that `method` is a typical non-state-bound\nfunction, which is meant to be invoked in the usual fashion, just as if it were\ncalled directly as a method of `this` state\u2019s `owner`.\n\n        method.apply context or @owner, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a0afec2832bb83bc9fb8e257206d5556754ed9a5","subject":"v0.1.2 - Adding newline args for TextArea","message":"v0.1.2 - Adding newline args for TextArea\n","repos":"ojjs\/oj","old_file":"src\/oj.litcoffee","new_file":"src\/oj.litcoffee","new_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = ->\n\n  oj function acts like a tag method that doesn't emit\n\n      oj._argsPush()\n      ojml = oj.emit.apply @, arguments\n      oj._argsPop()\n      ojml\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.1.2'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\nTODO: Static server side support for loading any generated pages dynamically.\nTODO: Support Backbone routes to trigger page changes.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      jQuery ->\n\n        $.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      # TODO: support cloning OJ instances\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n\nIndexing Helpers\n-----------------------------------------------------------------------------\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = ArrayP.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name) ->\n      obj = if oj.isClient then window[name] else global[name]\n      throw new Error(\"oj: #{name} dependency is missing\") unless oj.isDefined obj\n\nDepend on jQuery\n\n    oj.dependency 'jQuery'\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw new Error('oj.isProperty: string expected for second argument') unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, args...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from args by unioning all objects\n\n      attributes = {}\n      for arg in args\n\n  TODO: evaluate argument if necessary\n\n        if oj.isObject arg\n          _extend attributes, arg\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n        else if oj.isFunction arg\n\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to\n\n      oj._argsAppend ojml\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n        oj[t] = -> oj.tag t, arguments...\n        # Remember the tag name\n        _setTagName oj[t], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extend (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.extend = (context = root) ->\n      o = {}\n      for k,v of oj\n        if k[0] != '_'\n          o[k] = v\n      delete o.extend\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* minify - Minify js and css\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        minify: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, minify: options.minify, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n  TODO: Refactor to use the same code as media queries\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.minify then '' else '\\n'\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if (!minify) and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if (!minify) then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\nminify:false will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        when 'jquery'\n          # TODO: Missing unit tests for the jquery case\n          options.html?.push ojml.html()\n          options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML(options)\n            options.dom?.appendChild ojml.toDOM(options)\n            if options.css?\n              _extend options.css, ojml.toCSSMap(options)\n\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        throw new Error('oj.compile: doctype expects string as first argument') unless oj.isString ojml[1]\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip intention if there is only one child\n          if !options.minify and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if (!options.minify) and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mouseleave:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # TODO: Consider jsoning anything that isn't a string\n      # any keys that aren't strings are jsoned\n      # _attributesJSONAllKeys attributes\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if $?\n          if oj.isArray ev\n            $(el)[ek].apply @, ev\n          else\n            $(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        # TODO: Make this O(1)\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        # TODO: Make this O(1)\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = $ @el)\n\n        # Get and set id attribute of view\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # # Get and set class attribute of view\n        # class:\n        #   get: -> @$el.attr 'class'\n        #   set: (v) ->\n        #     # Join arrays with spaces\n        #     if oj.isArray v\n        #       v = v.join ' '\n        #     @$el.attr 'class', v\n        #     return\n\n        # # Alias for class\n        # c:\n        #   get: -> @class\n        #   set: (v) -> @class = v; return\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all currently set themes (readwrite)\n        themes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n              if k == 'class'\n                @addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single class\n        addClass: (name) ->\n          @$el.addClass name\n          return\n\n        # Remove a single class\n        removeClass: (name) ->\n          @$el.removeClass name\n          return\n\n        # Add a single theme\n        addTheme: (name) ->\n          @addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @removeClass \"theme-#{name}\"\n          return\n\n        # Clear all themes\n        clearThemes: (name) ->\n          @$el.removeClass \"theme-#{name}\"\n          classes = @$el.attr('class').split(' ')\n          _each classes, (v) ->\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.minify then '' else '\\n')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (options) -> _cssFromPluginObject (_flattenCSSMap @cssMap), _extend({}, minify:options.minify, tags:0)\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      throw new Error(\"oj.#{@typeName}.css: object or string expected for first argument\") unless oj.isString(css) or oj.isObject(css)\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      throw new Error(\"oj.#{@typeName}.theme: string expected for first argument (theme name)\") unless oj.isString name\n      throw new Error(\"oj.#{@typeName}.css: object expected for second argument\") unless oj.isObject(css)\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.Text\n------------------------------------------------------------------------------\nText control\n\n    oj.Text = oj.createType 'Text',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Get tag name if provided\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @el = oj =>\n          oj[@tagName]()\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.Text.base.constructor.call @, options\n\n      properties:\n\nvalue: text value of this object (readwrite)\n\n        value:\n          get: -> @$el.ojValue()\n          set: (v) -> @$el.oj(v); return\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = oj.argumentShift(options, 'value') || args.join('\\n');\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> console.log \"clearing body: oj.litcoffee:2930\";@$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get $(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set $(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if $('.' + _styleClassFromPlugin plugin).length == 0\n          $('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    jQuery.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        `with (oj) {`\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n        `}`\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    jQuery.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:1, meta:1, title:'deep', link:1, script:1\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj.compile: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      $('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    jQuery.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    jQuery.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        jQuery.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","old_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = ->\n\n  oj function acts like a tag method that doesn't emit\n\n      oj._argsPush()\n      ojml = oj.emit.apply @, arguments\n      oj._argsPop()\n      ojml\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.1.1'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\nTODO: Static server side support for loading any generated pages dynamically.\nTODO: Support Backbone routes to trigger page changes.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      jQuery ->\n\n        $.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      # TODO: support cloning OJ instances\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n\nIndexing Helpers\n-----------------------------------------------------------------------------\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = ArrayP.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name) ->\n      obj = if oj.isClient then window[name] else global[name]\n      throw new Error(\"oj: #{name} dependency is missing\") unless oj.isDefined obj\n\nDepend on jQuery\n\n    oj.dependency 'jQuery'\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw new Error('oj.isProperty: string expected for second argument') unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, args...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from args by unioning all objects\n\n      attributes = {}\n      for arg in args\n\n  TODO: evaluate argument if necessary\n\n        if oj.isObject arg\n          _extend attributes, arg\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n        else if oj.isFunction arg\n\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to\n\n      oj._argsAppend ojml\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n        oj[t] = -> oj.tag t, arguments...\n        # Remember the tag name\n        _setTagName oj[t], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extend (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.extend = (context = root) ->\n      o = {}\n      for k,v of oj\n        if k[0] != '_'\n          o[k] = v\n      delete o.extend\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* minify - Minify js and css\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        minify: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, minify: options.minify, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n  TODO: Refactor to use the same code as media queries\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.minify then '' else '\\n'\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if (!minify) and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if (!minify) then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\nminify:false will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        when 'jquery'\n          # TODO: Missing unit tests for the jquery case\n          options.html?.push ojml.html()\n          options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML(options)\n            options.dom?.appendChild ojml.toDOM(options)\n            if options.css?\n              _extend options.css, ojml.toCSSMap(options)\n\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        throw new Error('oj.compile: doctype expects string as first argument') unless oj.isString ojml[1]\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip intention if there is only one child\n          if !options.minify and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if (!options.minify) and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mouseleave:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # TODO: Consider jsoning anything that isn't a string\n      # any keys that aren't strings are jsoned\n      # _attributesJSONAllKeys attributes\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if $?\n          if oj.isArray ev\n            $(el)[ek].apply @, ev\n          else\n            $(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        # TODO: Make this O(1)\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        # TODO: Make this O(1)\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = $ @el)\n\n        # Get and set id attribute of view\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # # Get and set class attribute of view\n        # class:\n        #   get: -> @$el.attr 'class'\n        #   set: (v) ->\n        #     # Join arrays with spaces\n        #     if oj.isArray v\n        #       v = v.join ' '\n        #     @$el.attr 'class', v\n        #     return\n\n        # # Alias for class\n        # c:\n        #   get: -> @class\n        #   set: (v) -> @class = v; return\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all currently set themes (readwrite)\n        themes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n              if k == 'class'\n                @addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single class\n        addClass: (name) ->\n          @$el.addClass name\n          return\n\n        # Remove a single class\n        removeClass: (name) ->\n          @$el.removeClass name\n          return\n\n        # Add a single theme\n        addTheme: (name) ->\n          @addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @removeClass \"theme-#{name}\"\n          return\n\n        # Clear all themes\n        clearThemes: (name) ->\n          @$el.removeClass \"theme-#{name}\"\n          classes = @$el.attr('class').split(' ')\n          _each classes, (v) ->\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.minify then '' else '\\n')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (options) -> _cssFromPluginObject (_flattenCSSMap @cssMap), _extend({}, minify:options.minify, tags:0)\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      throw new Error(\"oj.#{@typeName}.css: object or string expected for first argument\") unless oj.isString(css) or oj.isObject(css)\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      throw new Error(\"oj.#{@typeName}.theme: string expected for first argument (theme name)\") unless oj.isString name\n      throw new Error(\"oj.#{@typeName}.css: object expected for second argument\") unless oj.isObject(css)\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.Text\n------------------------------------------------------------------------------\nText control\n\n    oj.Text = oj.createType 'Text',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Get tag name if provided\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @el = oj =>\n          oj[@tagName]()\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.Text.base.constructor.call @, options\n\n      properties:\n\nvalue: text value of this object (readwrite)\n\n        value:\n          get: -> @$el.ojValue()\n          set: (v) -> @$el.oj(v); return\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> console.log \"clearing body: oj.litcoffee:2930\";@$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get $(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set $(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if $('.' + _styleClassFromPlugin plugin).length == 0\n          $('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    jQuery.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        `with (oj) {`\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n        `}`\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    jQuery.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:1, meta:1, title:'deep', link:1, script:1\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj: dom compile error: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      $('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    jQuery.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    jQuery.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        jQuery.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6baff17e3ad539cf431c1479abcff11e0247fb71","subject":"Revert \"Taking things literally with lists\"","message":"Revert \"Taking things literally with lists\"\n\nThis reverts commit 74f4baf060c184db5126a4886832a42cc4fdfab7.\n\nHappy 4\/1 :3\n","repos":"Psykoral\/canjs,beno\/canjs,gsmeets\/canjs,rasjani\/canjs,bitovi\/canjs,shiftplanning\/canjs,UXsree\/canjs,rjgotten\/canjs,whitecolor\/canjs,whitecolor\/canjs,gsmeets\/canjs,whitecolor\/canjs,patrick-steele-idem\/canjs,beno\/canjs,asavoy\/canjs,bitovi\/canjs,UXsree\/canjs,beno\/canjs,patrick-steele-idem\/canjs,patrick-steele-idem\/canjs,dispatchrabbi\/canjs,Psykoral\/canjs,bitovi\/canjs,rjgotten\/canjs,tracer99\/canjs,ackl\/canjs,rasjani\/canjs,gsmeets\/canjs,rjgotten\/canjs,tracer99\/canjs,rasjani\/canjs,rjgotten\/canjs,ackl\/canjs,rasjani\/canjs,Psykoral\/canjs,tracer99\/canjs,asavoy\/canjs,dispatchrabbi\/canjs,shiftplanning\/canjs,bitovi\/canjs,Psykoral\/canjs,ackl\/canjs","old_file":"list\/list.litcoffee","new_file":"list\/list.litcoffee","new_contents":"","old_contents":"# can.List\n\n\tsteal \"can\/util\", \"can\/map\", (can, Map) ->\n\ncan.List takes care of creating observable lists.\n\n### Misc utilities\n\nWe'll use these later in the implementation of `can.List#splice` to\niron out cross-browser issues, hence why this is up here.\n\n\tsplice = [].splice\n\nWe test whether the browser's native `splice` method removes properties, or\nmerely changes `.length`. Our `can.List#splice` method will be adapted\naccordingly such that it *does* remove them. IE doesn't remove properties,\nspecifically, so we test for that.\n\n\tspliceRemovesProps = ->\n\t\tobj =\n\t\t\t0: \"a\"\n\t\t\tlength: 1\n\t\tsplice.call obj, 0, 1\n\t\tnot obj[0]\n\n## Main implementation\n\nHere we subclass `can.Map` to create our `List`. We will treat the `Map` as\nan array-like.\n\n\tclass list extends Map\n\n`Map` can be changes statically for new `can.List` classes\nto any subclass of `can.Map`. This controls what constructor\nto use when turning objects into `Map`s in the various\nrelevant `can.List` methods.\n\n\t@Map: Map\n\nAnd now we set up our constructor...\n\n\tconstructor: (instances = [], options) ->\n\nBy managing `.length`, we make this object an array-like.\n\n\t\t@length = 0;\n\nThe `cid` is used to namespace event handlers.\n\n\t\tcan.cid this, \".map\"\n\n`@_init` this instance as currently initializing.\n\n\t\t@_init = 1\n\nNow we check if `instances` is a promise because we have special behavior\nin that case...\n\n\t\tif can.isDeferred instances\n\nThe array passed into `new can.List()` can be a promise, in which case we\npass it straight to `can.List#replace()`. This will let us have a working\nlist, and automatically replace its contents when the promise resolves.\n\n\t\t\t@replace instances\n\t\telse\n\nIf our instances argument isn't a promise, we assume it's an array.\n\nThe `teardownMapping` is an implementation detail of `can.Map` used for\nmemory safety. Refer to can\/map for more details on how it works.\n\n\t\t\tteardownMapping = instances.length and can.Map.helpers.addToMap instances, this\n\nThen we `push` each individual element into our new `List`.\n\n\t\t\t@push.apply @, can.makeArray instances\n\nAnd here we use `teardownMapping` if the `can.Map` helper actually returned\none.\n\n\t\tteardownMapping() if teardownMapping\n\nWhenever a change event happens, we also take note of it in the\n`_changes()` method.\n\n\t\t@bind 'change', can.proxy @_changes, @\n\t\tcan.simpleExtend @, options\n\nNo longer initializing, soooo...\n\n\t\tdelete @_init\n\n### _triggerChange\n\n\t_triggerChange: (attr, how, newVal, oldVal) ->\n\nOn top of triggering the change event, we manually trigger `add`, `length`,\nand `remove` events manually, depending on `how`.\n\n\t\tMap::_triggerChange.apply @, arguments\n\nWe definitely do not trigger any `add`\/`remove` events ourselves that\ninvolve dots, so we skip this section in those cases (all of the triggers\nfor `can.List` itself are done on indices)\n\n\t\tif not ~attr.indexOf '.'\n\nIf a new item is added...\n\n\t\t\tif how is 'add'\n\n...trigger the two events, with newVal and the ndex as the values.\n\n\t\t\t\tcan.batch.trigger @, how, [newVal, +attr]\n\t\t\t\tcan.batch.trigger @, 'length', [this.length]\n\notherwise if an item is removed...\n\n\t\t\telse if how is 'remove'\n\nThen do the same, but using the old value (the item removed) in the\n`remove` event.\n\n\t\t\t\tcan.batch.trigger @, how, [oldVal, +attr]\n\t\t\t\tcan.batch.trigger @, 'length', [this.length]\n\t\t\t\t\nAnd just trigger anything else, whatever it is, because why not? As long as\nit has no dot, of course.\n\n\t\t\telse\n\t\t\t\tcan.batch.trigger @, how, [newVal, +attr)\n\n### __get\n\nThis overrides `can.Map`'s version of this method, which is meant to be used to implement the reading version of `attr()`, **after** dotted keys (`\"foo.bar.baz\"`) have already been split up.\n\n\t__get: (attr) -> if attr then this[attr] else @\n\n### ___set\n\nThis overrides `can.Map`'s version of this method, which does the final\ndata assignment to out `List` object.\n\n\t___set: (attr, val) ->\n\t\t@[attr] = val;\n\nnd we use it this way mainly to update the length of\nour array-like.\n\n\t\t@length = (+attr + 1) if (+attr >= @.length)\n\n### _each\n\nThe regular `can.Map` method provides a `for..in`-style\nloop, but this object is supposed to act like an array -- so\nwe treat it like one.\n\n\t_each: (callback) ->\n\t\tdata = @__get();\n\nNote how this method, unlike the native `Array#forEach`,\ncalls its callback on `undefined` for undefined array\nindices, which is more in like with `jQuery`'s `$.each`\nutility.\n\n\t\tcallback datum, i for datum, i in data\n\n### _bindsetup\n\nUsed by `can\/util\/bind` to set up live-binding.\n\n\t_bindsetup: Map.helpers.makeBindSetup(\"*\"),\n\t\n### serialize\n\nReturns the serialized form of this list (meaning, a regular `Array`, not\nJSON).\n\n\tserialize: -> Map.helpers.serialize @, 'serialize', []\n\n### splice\n\nWe write our own splice implementation to make sure arguments are properly\nconverted to observable objects and events are fired as planned.\n\n\tsplice: (index, howMany = @length - index) ->\n\t\targs = can.makeArray arguments\n\nArguments after the first two (`index`, `howMany`) are converted to `Map`s\n(or whatever the static `can.List.Map` configuration is) when\nappropriate. These new observables will also bubble their own events up to\nthe List, because of `hookupBubble`.\n\n\t\tfor val, i in args\n\t\t\tif i >= 2 and Map.helpers.canMakeObserve val\n\t\t\t\targs[i] = Map.helpers.hookupBubble val, \"*\", @, @.constructor.Map, @.constructor);\n\n\nWe call the native `splice` function here with our constructed\narguments. We will use `removed` to trigger appropriate removal events.\n\n\t\tremoved = splice.apply @, args\n\nSome browsers' splice methods do not actually delete properties, so we do\n it manually here. The test for whether this is necessary is at the top of\n the file.\n\n\t\tif not spliceRemovesProps\n\t\t\tfor thing, i in removed\n\t\t\t\tdelete @[i]\n\nWe batch the process of triggering `remove` and `add` events. On removal,\nwe also stop removed items from bubbling their events up to the `List`,\nwith `Map.helpers.unhookup`. Added items have already been given the\n`hookupBubble` treatment above, so we don't need to do it in here.\n\n\t\tcan.batch.start()\n\n\t\tif howMany > 0\n\t\t\t@_triggerChange \"\" + index, \"remove\", undefined, removed\n\t\t\tMap.helpers.unhookup removed, @\n\t\tif args.length > 2\n\t\t\t@_triggerChange \"\" + index, \"add\", args.slice(2), removed\n\n\t\tcan.batch.stop();\n\nTo reflect the API of the native `splice` method, we return a plain array\nof objects that were removed.\n\n\t\tremoved;\n\n### _attrs\n\n`_attrs()` implements part of the functionality of\n`can.List#attr()`. It is invoked in two situations:\n\n1. When `attr()` is called without any arguments\n\n2. When `attr()` is called with an array or array-like of values.\n\n\t_attrs: (items, remove) ->\n\nWhen invoked like `.attr()`, with no arguments, we simply return an `Array`\nversion of the list, recursively converted to regular JS objects.\n\n\t\tif items is undefined\n\t\t\tMap.helpers.serialize(this, 'attr', []);\n\nOtherwise, `items` is expected to be either an `Array` or an\n`Array`-like. From here, we will force `items` to be a proper `Array` copy\nof the original argument and call `_updateAttrs()` inside a batch to\nprevent event spam.\n\n\t\telse\n\t\t\titems = can.makeArray items\n\t\t\tcan.batch.start()\n\t\t\t@_updateAttrs items, remove\n\t\t\tcan.batch.stop()\n\n### _updateAttrs\n\nTODO\n\n\t_updateAttrs: function (items, remove) {\n\t\tvar len = Math.min(items.length, this.length);\n\n\t\tfor (var prop = 0; prop < len; prop++) {\n\t\t\tvar curVal = this[prop],\n\t\t\t\tnewVal = items[prop];\n\n\t\t\tif (Map.helpers.canMakeObserve(curVal) && Map.helpers.canMakeObserve(newVal)) {\n\t\t\t\tcurVal.attr(newVal, remove);\n\t\t\t\t\/\/changed from a coercion to an explicit\n\t\t\t} else if (curVal !== newVal) {\n\t\t\t\tthis._set(prop, newVal);\n\t\t\t} else {\n\n\t\t\t}\n\t\t}\n\t\tif (items.length > this.length) {\n\t\t\t\/\/ Add in the remaining props.\n\t\t\tthis.push.apply(this, items.slice(this.length));\n\t\t} else if (items.length < this.length && remove) {\n\t\t\tthis.splice(items.length);\n\t\t}\n\t}\n\n### indexOf\n\n\tindexOf: (item, fromIndex) ->\n\nWe force computes and helpers to watch out for length changes on this\n`can.List` if the `indexOf` method is used.\n\n\t\t@attr('length');\n\nBut otherwise, `can.List#indefOf()` works just like native, piggybacking on\nthe `can.inArray` utility from `can.util`.\n\n\t\tcan.inArray item, @, fromIndex\n\n### join\n\n`can.List#join()` is just like the native `Array#join()`, except we\n serialize to a regular array before calling the native method.`\n\n\tjoin: -> [].join.apply @attr(), arguments\n\t\n### reverse\n\nThe native `Array#reverse` method already does in-place reversing for us,\nso we just use that. Note that this method will not fire `set` events, as\ndoing the same thing manually with `attr()` usually would.\n\n\treverse: [].reverse,\n\n### slice\n\n\tslice: ->\n\nOur `slice()` is just a call to `Array#slice`...\n\n\t\ttemp = Array.prototype.slice.apply @, arguments\n\n... that returns an `List` of the same type as `this`.\n\n\t\tnew @constructor temp\n\n### concat\n\n\tconcat: ->\n\t\targs = []\n\nWe want to turn any `can.List` arguments into plain old `Array`s,\n\n\t\tfor arg, i in can.makeArray arguments\n\t\t\targs[i] = if arg instanceof can.List then arg.serialize() else arg\n\nso we can use the native `Array#concat` method for\nconcatenation, before turning the results into a new\n`can.List` with the same prototype as `this`.\n\n\t\tnew @constructor (Array.prototype.concat.apply @serialize(), args)\n\n### forEach\n\nWe delegate `List#forEach` to the cross-browser generic implementation in\n`can.util`.\n\n\tforEach: (cb, thisarg = @) -> can.each @, cb, thisarg\n\n### replace\n\nOur reimplementation of `Array#replace()` adds support for replacing with\nthe results of promi\u00f1ses, but otherwise works just like `List#splice()`.\n\n\treplace: (newList) ->\n\nIf `newList` is a promise, we queue a replacement with the promise's\nresult. Note that this method returns the current `List`, so if you want to\ntake any other action after the promise resolves, you'll need to do\n`.then()` on the promise externally, instead of using the returned value\nfrom this.\n\n\t\tif (can.isDeferred(newList)) {\n\t\t\tnewList.then(can.proxy(this.replace, this));\n\t\telse\n\nThis regular `List#splice()` call will replace all\nelements in the `List` and run all the usual event\nhookups that that method does.\n\n\t\t\tthis.splice.apply(this, [0, this.length].concat(can.makeArray(newList || [])));\n\nWe return the current `List`, even if a promise was passed in.\n\n\t\tthis;\n\n### getArgs\n\nConverts to an `array` of arguments.\n\n\tgetArgs = (args) ->\n\t\tif args[0] and can.isArray args[0]\n\t\t\targs[0]\n\t\telse\n\t\t\tcan.makeArray arg)\n\n### push, pop, shift, and unshift\n\nCreate `push`, `pop`, `shift`, and `unshift`\n\n\tobj =\n\t\tpush: \"length\"\n\t\tunshift: 0\n\nAdds a method `name` - The method name.\t `where` - Where items in the\n`array` should be added.\n\n\tfor where, name in obj\n\t\torig = [][name];\n\t\tlist::[name] = -> \n\nGet the items being added.\n\n\t\t\targs = []\n\nWhere we are going to add items.\n\n\t\t\tlen = if where then @length else 0\n\t\t\ti = arguments.length\n\nGo through and convert anything to an `map` that needs to be converted.\n\n\t\t\twhile (i--)\n\t\t\t\tval = arguments[i]\n\t\t\t\targs[i] = if Map.helpers.canMakeObserve val\n\t\t\t\t\tMap.helpers.hookupBubble val, \"*\", @, @constructor.Map, @constructor\n\t\t\t\telse\n\t\t\t\t\tval\n\nCall the original method.\n\n\t\t\tres = orig.apply(this, args);\n\n\t\t\tif not this.comparator or args.length\n\t\t\t\t@_triggerChange \"\" + len, \"add\", args, undefined\n\nAnd then return res\n\n\t\t\tres\n\nWe do the same thing for pop\/length:\n\n\tobj =\n\t\tpop: \"length\"\n\t\tshift: 0\n\nCreates a `remove` type method\n\n\tfor where, name in obj\n\t\tlist::[name] = ->\n\t\t\targs = getArgs arguments\n\t\t\tlen = if where and this.length then this.length - 1 else 0\n\n\t\t\tres = [][name].apply @, args\n\nCreate a change where the args are\n* `len` - Where these items were removed.\n* `remove` - Items removed.\n* `undefined` - The new values (there are none).\n* `res` - The old, removed values (should these be unbound).\n\n\t\t\t@_triggerChange \"\" + len, \"remove\", undefined, [res]\n\n\t\t\tif res and res.unbind\n\t\t\t\tcan.stopListening.call @, res, \"change\"\n\t\t\t\t\nand just return `res`\n\n\t\tres\n\n## The End\n\n\tcan.List = Map.List = list;\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ae1f842effc313892666ac8ca7a21dfcd0e5ca63","subject":"brush up docs","message":"brush up docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# \/api\/App Components\/Batman.View\/Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n#### Available Keypath Filters\n\nThe following is a list of available keypaths that can be used with bindings. For a more complete description with accompanying examples see `Batman.View Filters`\n + `lt` : Checks if left content is _less than_ the right content.\n + `gt` : Checks if left content is _greater than_ the right content.\n + `lteq` : Checks if left content is _less than or equal to_ the right content.\n + `gteq` : Checks if left content is _greater than or equal to_ the right content.\n + `equal` or `eq` : Checks if left content is _is equal to_ the right content.\n + `neq` : Checks if left content is _is NOT equal to_ the right content.\n + `ceil` : Runs `Math.ceil` on input value.\n + `floor` : Runs `Math.floor` on input value.\n + `round` : Runs `Math.round` on input value.\n + `precision` : Runs `toPrecision()` on input value.\n + `fixed` : Runs `toFixed()` on input value.\n + `delimitNumber` : Adds comma delimiters to a number\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n__Automatic Validation Display__\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-route-params\n\nAdds the provided keypath or literal value to the route provided to `data-route`. For example:\n\n```html\n<a data-route='routes.villians.new' data-route-params='\"mastermind=true\"'>Mastermind<\/a>\n```\n\nwill route to `\/villians\/new?mastermind=true` and\n\n```\n<a data-route='routes.villians.new' data-route-params='otherRouteParams'>Other<\/a>\n```\n\nwill look up `otherRouteParams` and append it to `\/villains\/new`, adding a `?` if necessary.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# \/api\/App Components\/Batman.View\/Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## equals(left, right) _or_ eq(left, right): Boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n<span data-showif=\"value | eq 10\"><\/span>\n<span data-showif=\"value | eq true\"><\/span>\n```\n\n__Note__: there is actually _one_ difference between `eq` and `equals`: `equals` rejects undefined values, but `eq` allows them.\n\n## lt(left, right) : Boolean\n\nChecks if left content is `less than` the right content.\n\n```html\n<span data-showif=\"posts.length | lt 10\"><\/span>\n```\n\n## gt(left, right) : Boolean\n\nChecks if left content is `greater than` the right content.\n\n```html\n<span data-showif=\"posts.length | gt 10\"><\/span>\n```\n\n## lteq(left, right) : Boolean\n\nChecks if left content is `less than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | lteq 10\"><\/span>\n```\n\n## gteq(left, right) : Boolean\n\nChecks if left content is `greater than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | gteq 10\"><\/span>\n```\n\n## neq(left, right) : Boolean\n\nChecks if left content is `is NOT equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | neq 10\"><\/span>\n```\n\n## ceil(value) : string\n\nThe `ceil` filter will run `Math.ceil` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | ceil\"><\/span>\n```\n\n## floor(value) : string\n\nThe `floor` filter will run `Math.floor` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | floor\"><\/span>\n```\n\n## round(value) : string\n\nThe `round` filter will run `Math.round` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | round\"><\/span>\n```\n\n## percision(value, toPlace) : string\n\nThe `precision` filter will run `toPrecision()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | precision\"><\/span>\n<span data-bind=\"someValue | precision 3\"><\/span>\n```\n\n## fixed(value, toPlace) : string\n\nThe `fixed` filter will run `toFixed()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | fixed\"><\/span>\n<span data-bind=\"someValue | fixed 3\"><\/span>\n```\n\n## delimitNumber(value) : string\n\nThe `delimitNumber` filter will comma delimit a 'number'. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | delimitNumber\"><\/span>\n```\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","old_contents":"# \/api\/App Components\/Batman.View\/Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n#### Available Keypath Filters\n\nThe following is a list of available keypaths that can be used with bindings. For a more complete description with accompanying examples see `Batman.View Filters`\n + `lt` : Checks if left content is `less than` the right content.\n + `gt` : Checks if left content is `greater than` the right content.\n + `lteq` : Checks if left content is `less than or equal to` the right content.\n + `gteq` : Checks if left content is `greater than or equal to` the right content.\n + `equal` or `eq` : Checks if left content is `is equal to` the right content.\n + `neq` : Checks if left content is `is NOT equal to` the right content.\n + `ceil` : Runs `Math.ceil` on input value.\n + `floor` : Runs `Math.floor` on input value.\n + `round` : Runs `Math.round` on input value.\n + `precision` : Runs `toPrecision()` on input value.\n + `fixed` : Runs `toFixed()` on input value.\n + `delimitNumber` : Adds comma delimiters to a number\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-route-params\n\nAdds the provided keypath or literal value to the route provided to `data-route`. For example:\n\n```html\n<a data-route='routes.villians.new' data-route-params='\"mastermind=true\"'>Mastermind<\/a>\n```\n\nwill route to `\/villians\/new?mastermind=true` and\n\n```\n<a data-route='routes.villians.new' data-route-params='otherRouteParams'>Other<\/a>\n```\n\nwill look up `otherRouteParams` and append it to `\/villains\/new`, adding a `?` if necessary.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# \/api\/App Components\/Batman.View\/Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## equals(left, right) `or` eq(left, right): Boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n<span data-showif=\"value | eq 10\"><\/span>\n<span data-showif=\"value | eq true\"><\/span>\n```\n\n## lt(left, right) : Boolean\n\nChecks if left content is `less than` the right content.\n\n```html\n<span data-showif=\"posts.length | lt 10\"><\/span>\n```\n\n## gt(left, right) : Boolean\n\nChecks if left content is `greater than` the right content.\n\n```html\n<span data-showif=\"posts.length | gt 10\"><\/span>\n```\n\n## lteq(left, right) : Boolean\n\nChecks if left content is `less than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | lteq 10\"><\/span>\n```\n\n## gteq(left, right) : Boolean\n\nChecks if left content is `greater than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | gteq 10\"><\/span>\n```\n\n## neq(left, right) : Boolean\n\nChecks if left content is `is NOT equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | neq 10\"><\/span>\n```\n\n## ceil(value) : string\n\nThe `ceil` filter will run `Math.ceil` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | ceil\"><\/span>\n```\n\n## floor(value) : string\n\nThe `floor` filter will run `Math.floor` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | floor\"><\/span>\n```\n\n## round(value) : string\n\nThe `round` filter will run `Math.round` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | round\"><\/span>\n```\n\n## percision(value, toPlace) : string\n\nThe `precision` filter will run `toPrecision()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | precision\"><\/span>\n<span data-bind=\"someValue | precision 3\"><\/span>\n```\n\n## fixed(value, toPlace) : string\n\nThe `fixed` filter will run `toFixed()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | fixed\"><\/span>\n<span data-bind=\"someValue | fixed 3\"><\/span>\n```\n\n## delimitNumber(value) : string\n\nThe `delimitNumber` filter will comma delimit a 'number'. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | delimitNumber\"><\/span>\n```\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"456595a717e42d47b7facd22688e7fa63791fe46","subject":"Refactor","message":"Refactor\n","repos":"mnmtanish\/vosco-cli","old_file":"index.litcoffee","new_file":"index.litcoffee","new_contents":"Dependencies\n============\n\n    fs     = require \"fs\"\n    path   = require \"path\"\n    {exec} = require \"child_process\"\n    VOSCO  = require \"vosco\"\n\nSanity Checks\n-------------\n\nVOSCO must always be run with **root** previliges. It is expected to run with `sudo` command by logged in user. VOSCO is designed to manage system wide configurations and needs read\/write access to many restricted files. The program will stop unless the user id is zero.\n\n    await exec \"id -u\", defer(error, userId)\n    unless parseInt(userId) is 0\n      console.error \"VOSCO must be run as root user\"\n      process.exit 1\n\nInitialize VOSCO\n----------------\n\nCreate a new VOSCO instance called `vosco` which will be doing all the hard work. No need to set environment variables before running unless you're testing or doing something different using VOSCO.\n\n    vosco = do ->\n      repo_path = process.env.VOSCO_ROOT_DIR or '\/'\n      repo_opts =\n        author_name : process.env.USER\n        author_email: \"#{process.env.USER}@localhost\"\n      return new VOSCO repo_path, repo_opts\n\nShell Mode \/ Script Mode\n------------------------\n\nThe shell mode is interactive. It will guide users using helpful menus and messages. This mode is difficult and not suitable for scripting. Script mode is suitable for scripting and for non-interactive use. Output form this mode is always clean and easy to parse using other programs.\n\n    shell  = require(\".\/lib\/shell\")(vosco)\n    script = require(\".\/lib\/script\")(vosco)\n\nIf no arguments are given, we assume that user wishes to enter an interactive shell to run VOSCO commands. Otherwise assume user needs to run specific commands using script mode. Show the help text if user enters an invalid command.\n\n    command = process.argv[2]\n    args    = process.argv.slice 3\n\n    if command is undefined\n      shell.init()\n    else if typeof script[command] is 'function'\n      script[command].apply script, args\n    else do ->\n      filePath = path.resolve __dirname, \"help-text.txt\"\n      helpText = fs.readFileSync filePath\n      console.log helpText.toString()\n","old_contents":"Dependencies\n============\n\n    fs     = require \"fs\"\n    path   = require \"path\"\n    {exec} = require \"child_process\"\n    VOSCO  = require \"vosco\"\n\nSanity Checks\n-------------\n\nVOSCO must always be run with **root** previliges. It is expected to run with `sudo` command by logged in user. VOSCO is designed to manage system wide configurations and needs read\/write access to many restricted files. The program will stop unless the user id is zero.\n\n    await exec \"id -u\", defer(error, userId)\n    unless parseInt(userId) is 0\n      console.error \"VOSCO must be run as root user\"\n      process.exit 1\n\nInitialize VOSCO\n----------------\n\nCreate a new VOSCO instance called `vosco` which will be doing all the hard work. No need to set environment variables before running unless you're testing or doing something different using VOSCO.\n\n    vosco = do ->\n      repo_path = process.env.VOSCO_ROOT_DIR || '\/'\n      repo_opts =\n        author_name : process.env.USER\n        author_email: \"#{process.env.USER}@localhost\"\n      return new VOSCO repo_path, repo_opts\n\nShell Mode \/ Script Mode\n------------------------\n\nThe shell mode is interactive. It will guide users using helpful menus and messages. This mode is difficult and not suitable for scripting. Script mode is suitable for scripting and for non-interactive use. Output form this mode is always clean and easy to parse using other programs.\n\n    shell  = require(\".\/lib\/shell\")(vosco)\n    script = require(\".\/lib\/script\")(vosco)\n\nIf no arguments are given, we assume that user wishes to enter an interactive shell to run VOSCO commands. Otherwise assume user needs to run specific commands using script mode. Show the help text if user enters an invalid command.\n\n    command = process.argv[2]\n    args    = process.argv.slice 3\n\n    if command is undefined\n      shell.init()\n    else if typeof script[command] is 'function'\n      script[command].apply script, args\n    else do ->\n      filePath = path.resolve __dirname, \"help-text.txt\"\n      helpText = fs.readFileSync filePath\n      console.log helpText.toString()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b9e92864cb7058c7dc86295caa1c7fd7d154ccd4","subject":"search list limit","message":"search list limit\n","repos":"vpj\/models","old_file":"js\/properties\/value.litcoffee","new_file":"js\/properties\/value.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#List\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       @default 'value', (str) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value) -> \"#{str}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value) -> (value is @schema.default())\n\n       parse: (data) ->\n        r = super data\n        return r unless r is true\n        if not @schema.valid data\n         return @error 'invalid'\n\n        res =\n         score: 1\n         errors: []\n         value: @schema.value data\n\n        return res\n\n       toJSON: (value) -> value\n       toJSONFull: (value) -> value\n\n       edit: (elem, value, changed) ->\n        new Edit this, elem, value, changed\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, changed) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = changed\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = @value\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n        @change()\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r, i in results\n          break if i > 10\n          e = @div r\n          e._result = r\n\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @elems.search.style.display = 'none'\n        @change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 100\n\n       @listen 'change', (e) ->\n        @search()\n        @change()\n\n       change: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#List\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       @default 'value', (str) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value) -> \"#{str}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value) -> (value is @schema.default())\n\n       parse: (data) ->\n        r = super data\n        return r unless r is true\n        if not @schema.valid data\n         return @error 'invalid'\n\n        res =\n         score: 1\n         errors: []\n         value: @schema.value data\n\n        return res\n\n       toJSON: (value) -> value\n       toJSONFull: (value) -> value\n\n       edit: (elem, value, changed) ->\n        new Edit this, elem, value, changed\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, changed) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = changed\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = @value\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n        @change()\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r in results\n          e = @div r\n          e._result = r\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @elems.search.style.display = 'none'\n        @change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 100\n\n       @listen 'change', (e) ->\n        @search()\n        @change()\n\n       change: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fa2dabee0295c743baad05d055255348ea9aa5e6","subject":"Use new path data structure (no more row\/col - it's now x\/y)","message":"Use new path data structure (no more row\/col - it's now x\/y)\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_step_count.litcoffee","new_file":"lib\/render-pipelines\/png\/png_step_count.litcoffee","new_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngStepCount extends PngRenderer\n\n      do_render: (ctx, path) =>\n        width  = @config.width\n        height = @config.height\n\n        for step, i in path\n          ctx.font      = \"#{Math.floor height * 0.25}pt Arial\"\n          ctx.textAlign = @config.step_count.text.align\n          ctx.fillStyle = @config.step_count.text.color\n\n          x = (width  * 0.5) + (width  * step.x)\n          y = (height * 0.5) + (height * step.y)\n\n          ctx.beginPath()\n          ctx.fillText i, x, y\n\n    module.exports = PngStepCount\n","old_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngStepCount extends PngRenderer\n\n      do_render: (ctx, path) =>\n        width  = @config.width\n        height = @config.height\n\n        for step, i in path\n          ctx.font      = \"#{Math.floor height * 0.25}pt Arial\"\n          ctx.textAlign = @config.step_count.text.align\n          ctx.fillStyle = @config.step_count.text.color\n\n          x = (width  * 0.5) + (width  * step.col)\n          y = (height * 0.5) + (height * step.row)\n\n          ctx.beginPath()\n          ctx.fillText i, x, y\n\n    module.exports = PngStepCount\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2a01edeb3ad3aa49d666f14a526e3d879f6e2ed0","subject":"State callbacks are no longer attached to input - YAY!","message":"State callbacks are no longer attached to input - YAY!\n","repos":"bsgbryan\/jyn","old_file":"lib\/server.litcoffee","new_file":"lib\/server.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e66464555c0cf7c5f2b3cef6ab6718d0d4043f13","subject":"Logic programs","message":"Logic programs\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n  \t\t              find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return s\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        s = F.unify(_.first(t1), _.first(t2), bindings)\n        s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2),   bindings) else s\n        return s\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logic programs\n# --------------\n\nWe can build more complex goals using lambda-abstractions and previously defined combinators, `conj` and `disj`.  For example, we can define the function `choice` such that `choice(t1, array)` is a goal that succeeds if `t1` is an element of `array`.\n\n    F.choice = ($v, list) ->\n      return F.fail if _.isEmpty(list)\n\n      F.disj(F.goal($v, _.first(list)),\n                    F.choice($v, _.rest(list)))\n\nThe name `choice` should evoke [The Axiom of Choice](http:\/\/en.wikipedia.org\/wiki\/Axiom_of_choice)...\n\n# Exports and sundries\n# --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n  \t\t              find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return s\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        s = F.unify(_.first(t1), _.first(t2), bindings)\n        s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2),   bindings) else s\n        return s\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logico\n# ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ea02a457d15907824fd07149007442c960aed318","subject":"Normalize submits into array form","message":"Normalize submits into array form\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-form\/client\/index.litcoffee","new_file":"packages\/shrub-form\/client\/index.litcoffee","new_contents":"# Form processing\n\n*Define a directive for Angular forms, and a service to cache and look them\nup later.*\n\n    _ = require 'lodash'\n    i8n = require 'inflection'\n\n    pkgman = require 'pkgman'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularDirective`.\n\n      registrar.registerHook 'shrubAngularDirective', -> [\n        '$compile', '$injector', '$log', '$q', 'shrub-form', 'shrub-require'\n        ($compile, $injector, $log, $q, formService, require) ->\n\n          link: (scope, element, attrs) ->\n\nKeep a reference to the form scope, if the form attribute value changes, it'll\nneed to be rebuilt.\n\n###### TODO: It shouldn't be trashed as it is now, it should be moved over to a new scope non-destructively.\n\n            formScope = null\n            scope.$watch attrs.form, (form) ->\n              return unless form?\n\n              form.key ?= attrs.form\n\nNormalize form submits into an array.\n\n              form.submits = [form.submits] unless angular.isArray form.submits\n\nBuild a submit function which will be bound to ngSubmit.\n\n              (scope['$shrubSubmit'] ?= {})[form.key] = ($event) ->\n\nGather all the field values.\n\n                values = {}\n                for name, field of form.fields\n\n                  widget = formService.widgets[field.type]\n                  if widget.extractValues?\n                    widget.extractValues field, values, formService\n                  else\n                    values[field.name] = field.value\n\nCall all the form submission handlers.\n\n                $q.all (submit values, form, $event for submit in form.submits)\n\n#### Invoke hook `shrubFormAlter`.\n\n              pkgman.invokeFlat 'shrubFormAlter', form\n\n#### Invoke hook `shrubFormFormKeyAlter`.\n\n###### TODO: Multiline\n\n              pkgman.invokeFlat \"shrubForm#{pkgman.normalizePath form.key, true}Alter\", form\n\nCreate the form element.\n\n              $form = angular.element '<form \/>'\n              $form.addClass form.key\n\nDefault method to POST.\n\n              $form.attr 'method', attrs.method ? 'POST'\n              $form.attr 'data-ng-submit', \"$shrubSubmit['#{form.key}']($event)\"\n\nBuild the form fields.\n\n              for name, field of form.fields\n\nLook up the widget definition and warn if it doesn't exist.\n\n                unless (widget = formService.widgets[field.type])?\n\n###### TODO: Multiline\n\n                  $log.warn \"Form `#{form.key}` contains non-existent field type `#{field.type}`!\"\n                  continue\n\nDefault name to the key.\n\n                field.name ?= name\n\nHelper function to synchronize the field and model value.\n\n                do (field) -> field.syncModel = (scope) ->\n                  self = this\n\n                  return unless self.model?\n\n                  self.$modelDereg?()\n                  self.$modelDereg = null\n\n                  self.$valueDereg?()\n                  self.$valueDereg = null\n\n                  if self.model isnt 'field.value'\n\n                    self.$valueDereg = scope.$watch 'field.value', (value) ->\n                      scope.$eval \"#{self.model} = value\", value: value\n\n                    self.$modelDereg = scope.$watch self.model, (value) ->\n                      self.value = value\n\n                  return\n\n                $form.append \"\"\"\n\n    <div\n      data-#{widget.directive}\n      data-field=\"#{attrs.form}.fields['#{name}']\"\n      data-form=\"#{attrs.form}\"\n    ><\/div><span> <\/span>\n\n    \"\"\"\n\nAdd hidden form key to allow server-side interception\/processing.\n\n              $formKeyElement = angular.element '<input type=\"hidden\" \/>'\n              $formKeyElement.attr name: 'formKey', value: form.key\n              $form.append $formKeyElement\n\nRemove any old stuff.\n\n              if formScope\n                formScope.$destroy()\n                element.find('form').remove()\n\nInsert and compile the form element.\n\n              element.append $form\n              $compile($form) formScope = scope.$new()\n\nRegister the form in the system.\n\n              formService.cache form.key, formScope, $form\n\n      ]\n\n#### Implements hook `shrubAngularService`.\n\n      registrar.registerHook 'shrubAngularService', -> [\n\n        ->\n\n          service = forms: {}, widgets: {}\n\n## form.cache\n\n* (string) `key` - The form key.\n* (Scope) `scope` - The form's Angular scope.\n* (Element) `element` - The form's jqLite element.\n\n*Cache a form for later lookup.*\n\n          service.cache = (key, scope, element) ->\n            service.forms[key] = scope: scope, element: element\n\n#### Invoke hook `shrubFormWidgets`.\n\n          for formWidgets in pkgman.invokeFlat 'shrubFormWidgets'\n            formWidgets = [formWidgets] unless _.isArray formWidgets\n\n            for formWidget in formWidgets\n              continue unless formWidget.directive?\n              service.widgets[formWidget.type] = formWidget\n\n          service\n\n      ]\n\n      registrar.recur [\n        'widget\/checkbox'\n        'widget\/checkboxes'\n        'widget\/group'\n        'widget\/hidden'\n        'widget\/markup'\n        'widget\/radio'\n        'widget\/radios'\n        'widget\/submit'\n        'widget\/select'\n        'widget\/text'\n      ]\n","old_contents":"# Form processing\n\n*Define a directive for Angular forms, and a service to cache and look them\nup later.*\n\n    _ = require 'lodash'\n    i8n = require 'inflection'\n\n    pkgman = require 'pkgman'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularDirective`.\n\n      registrar.registerHook 'shrubAngularDirective', -> [\n        '$compile', '$injector', '$log', '$q', 'shrub-form', 'shrub-require'\n        ($compile, $injector, $log, $q, formService, require) ->\n\n          link: (scope, element, attrs) ->\n\nKeep a reference to the form scope, if the form attribute value changes, it'll\nneed to be rebuilt.\n\n###### TODO: It shouldn't be trashed as it is now, it should be moved over to a new scope non-destructively.\n\n            formScope = null\n            scope.$watch attrs.form, (form) ->\n              return unless form?\n\n              form.key ?= attrs.form\n\nBuild a submit function which will be bound to ngSubmit.\n\n              (scope['$shrubSubmit'] ?= {})[form.key] = ($event) ->\n\nGather all the field values.\n\n                values = {}\n                for name, field of form.fields\n\n                  widget = formService.widgets[field.type]\n                  if widget.extractValues?\n                    widget.extractValues field, values, formService\n                  else\n                    values[field.name] = field.value\n\nCall all the form submission handlers.\n\n                $q.all (submit values, form, $event for submit in form.submits)\n\n#### Invoke hook `shrubFormAlter`.\n\n              pkgman.invokeFlat 'shrubFormAlter', form\n\n#### Invoke hook `shrubFormFormKeyAlter`.\n\n###### TODO: Multiline\n\n              pkgman.invokeFlat \"shrubForm#{pkgman.normalizePath form.key, true}Alter\", form\n\nCreate the form element.\n\n              $form = angular.element '<form \/>'\n              $form.addClass form.key\n\nDefault method to POST.\n\n              $form.attr 'method', attrs.method ? 'POST'\n              $form.attr 'data-ng-submit', \"$shrubSubmit['#{form.key}']($event)\"\n\nBuild the form fields.\n\n              for name, field of form.fields\n\nLook up the widget definition and warn if it doesn't exist.\n\n                unless (widget = formService.widgets[field.type])?\n\n###### TODO: Multiline\n\n                  $log.warn \"Form `#{form.key}` contains non-existent field type `#{field.type}`!\"\n                  continue\n\nDefault name to the key.\n\n                field.name ?= name\n\nHelper function to synchronize the field and model value.\n\n                do (field) -> field.syncModel = (scope) ->\n                  self = this\n\n                  return unless self.model?\n\n                  self.$modelDereg?()\n                  self.$modelDereg = null\n\n                  self.$valueDereg?()\n                  self.$valueDereg = null\n\n                  if self.model isnt 'field.value'\n\n                    self.$valueDereg = scope.$watch 'field.value', (value) ->\n                      scope.$eval \"#{self.model} = value\", value: value\n\n                    self.$modelDereg = scope.$watch self.model, (value) ->\n                      self.value = value\n\n                  return\n\n                $form.append \"\"\"\n\n    <div\n      data-#{widget.directive}\n      data-field=\"#{attrs.form}.fields['#{name}']\"\n      data-form=\"#{attrs.form}\"\n    ><\/div><span> <\/span>\n\n    \"\"\"\n\nAdd hidden form key to allow server-side interception\/processing.\n\n              $formKeyElement = angular.element '<input type=\"hidden\" \/>'\n              $formKeyElement.attr name: 'formKey', value: form.key\n              $form.append $formKeyElement\n\nRemove any old stuff.\n\n              if formScope\n                formScope.$destroy()\n                element.find('form').remove()\n\nInsert and compile the form element.\n\n              element.append $form\n              $compile($form) formScope = scope.$new()\n\nRegister the form in the system.\n\n              formService.cache form.key, formScope, $form\n\n      ]\n\n#### Implements hook `shrubAngularService`.\n\n      registrar.registerHook 'shrubAngularService', -> [\n\n        ->\n\n          service = forms: {}, widgets: {}\n\n## form.cache\n\n* (string) `key` - The form key.\n* (Scope) `scope` - The form's Angular scope.\n* (Element) `element` - The form's jqLite element.\n\n*Cache a form for later lookup.*\n\n          service.cache = (key, scope, element) ->\n            service.forms[key] = scope: scope, element: element\n\n#### Invoke hook `shrubFormWidgets`.\n\n          for formWidgets in pkgman.invokeFlat 'shrubFormWidgets'\n            formWidgets = [formWidgets] unless _.isArray formWidgets\n\n            for formWidget in formWidgets\n              continue unless formWidget.directive?\n              service.widgets[formWidget.type] = formWidget\n\n          service\n\n      ]\n\n      registrar.recur [\n        'widget\/checkbox'\n        'widget\/checkboxes'\n        'widget\/group'\n        'widget\/hidden'\n        'widget\/markup'\n        'widget\/radio'\n        'widget\/radios'\n        'widget\/submit'\n        'widget\/select'\n        'widget\/text'\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c74ab3390a321bf0a2d2b286b42022962827a627","subject":"respond callback","message":"respond callback\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end callback\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end callback\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e4cec4ed08d7c0b7d81b0fe0a1f68cfbbba32aff","subject":"Load execution contexts as project local dependencies","message":"Load execution contexts as project local dependencies\n","repos":"bsgbryan\/jyn","old_file":"lib\/init_execution_context.litcoffee","new_file":"lib\/init_execution_context.litcoffee","new_contents":"    Madul = require 'madul'\n\n    class InitExecutionContext extends Madul\n\n      _action_exists: (input, ref, done, fail) =>\n        if @[ref]?[input.ACTION]?\n          input.EXECUTE = @[ref][input.ACTION]\n\n          done()\n        else\n          fail \"Action #{input.ACTION} not available\"\n\n      before: (input, done, fail) ->\n        spec = Madul.PARSE_SPEC \".#{input.MODULE}\"\n\n        if @[spec.ref]?\n          @_action_exists input, spec.ref, done, fail\n        else\n          Madul.DUMMY [ \".#{input.MODULE}\" ], (dum) =>\n            @[spec.ref] = dum[spec.ref]\n            @_action_exists input, spec.ref, done, fail\n\n    module.exports = InitExecutionContext\n","old_contents":"    Madul = require 'madul'\n\n    class InitExecutionContext extends Madul\n\n      _action_exists: (input, ref, done, fail) =>\n        if @[ref]?[input.ACTION]?\n          input.EXECUTE = @[ref][input.ACTION]\n\n          done()\n        else\n          fail \"Action #{input.ACTION} not available\"\n\n      before: (input, done, fail) ->\n        spec = Madul.PARSE_SPEC \".#{input.MODULE}\"\n\n        if @[spec.ref]?\n          @_action_exists input, spec.ref, done, fail\n        else\n          Madul.DUMMY [ input.MODULE ], (dum) =>\n            @[spec.ref] = dum[spec.ref]\n            @_action_exists input, spec.ref, done, fail\n\n    module.exports = InitExecutionContext\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"527cc765252460f5d492046377bee36f6109c06f","subject":"Fixed typo","message":"Fixed typo\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-config\/index.litcoffee","new_file":"packages\/shrub-config\/index.litcoffee","new_contents":"# Configuration\n\n*Gathers configuration and serves it as an Angular module for clients.*\n\n    _ = require 'lodash'\n    Promise = require 'bluebird'\n    url = require 'url'\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    {Config} = require 'client\/modules\/config'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAssetsMiddleware`.\n\n      registrar.registerHook 'shrubAssetsMiddleware', ->\n\n        label: 'Config'\n        middleware: [\n\n          (assets, next) ->\n\n            assets.scripts.push '\/js\/config.js'\n\n            next()\n\n        ]\n\n#### Implements hook `shrubHttpMiddleware`.\n\n      registrar.registerHook 'shrubHttpMiddleware', (http) ->\n\n        label: 'Serve package configuration'\n        middleware: [\n\nServe the configuration module.\n\n          (req, res, next) ->\n\nOnly if the path matches.\n\n            return next() unless req.url is '\/js\/config.js'\n\n            exports.renderPackageConfig(req).then((code) ->\n\nEmit the configuration module.\n\n              res.setHeader 'Content-Type', 'text\/javascript'\n              res.send code\n\n            ).catch next\n\n        ]\n\n## shrub-config.renderPackageConfig\n\n* (http.IncomingRequest) `req` - The request object.\n\nUse a client's request object to render configuration.\n\n    exports.renderPackageConfig = (req) ->\n\n#### Invoke hook `shrubConfigClient`.\n\nAllows packages to specify configuration that will be sent to the client.\nImplementations may return an object, or a promise that resolves to an object.\n\n      subconfigs = pkgman.invoke 'shrubConfigClient', req\n\n      Promise.all(\n\n        promise for path, promise of subconfigs\n\n      ).then (fulfilledSubconfigs) ->\n\n        config_ = new Config()\n\nPackage-independent...\n\n        config_.set 'packageList', config.get 'packageList'\n\nMerge in the subconfigs.\n\n        index = 0\n        for path of subconfigs\n\n          subconfig = fulfilledSubconfigs[index++]\n          for key, value of subconfig\n            continue unless value?\n\n###### TODO: Multiline\n\n            config_.set \"packageConfig:#{path.replace \/\\\/\/g, ':'}:#{key.replace \/\\\/\/g, ':'}\", value\n\n#### Invoke hook `shrubConfigClientAlter`.\n\n        pkgman.invoke 'shrubConfigClientAlter', req, config_\n\nFormat the configuration to look nice.\n\n        prettyPrintConfig = ->\n\n          jsonArgs = [config_]\n\n          if 'production' isnt config.get 'NODE_ENV'\n            jsonArgs = jsonArgs.concat [null, '  ']\n\n          stringified = JSON.stringify jsonArgs...\n          [first, rest...] = stringified.split '\\n'\n          ([first].concat rest.map (line) -> '    ' + line).join '\\n'\n\n        \"\"\"\n    angular.module('shrub.config', ['shrub.require']).config([\n      'shrub-requireProvider', function(requireProvider) {\n        requireProvider.require('config').from(#{prettyPrintConfig()});\n      }\n    ]);\n      \"\"\"\n","old_contents":"# Configuration\n\n*Gathers configuration and serves it as an Angular module for clients.*\n\n    _ = require 'lodash'\n    Promise = require 'bluebird'\n    url = require 'url'\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    {Config} = require 'client\/modules\/config'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAssetsMiddleware`.\n\n      registrar.registerHook 'shrubAssetsMiddleware', ->\n\n        label: 'Config'\n        middleware: [\n\n          (assets, next) ->\n\n            assets.scripts.push '\/js\/config.js'\n\n            next()\n\n        ]\n\n#### Implements hook `shrubHttpMiddleware`.\n\n      registrar.registerHook 'shrubHttpMiddleware', (http) ->\n\n        label: 'Serve package configuration'\n        middleware: [\n\nServe the configuration module.\n\n          (req, res, next) ->\n\nOnly if the path matches.\n\n            return next() unless req.url is '\/js\/config.js'\n\n            exports.renderPackageConfig(req).then((code) ->\n\nEmit the configuration module.\n\n              res.setHeader 'Content-Type', 'text\/javascript'\n              res.send code\n\n            ).catch next\n\n        ]\n\n## shrub-config.renderPackageConfig\n\n* (http.IncomingRequest) `req` - The request object.\n\nUSe a client's request object to render configuration.\n\n    exports.renderPackageConfig = (req) ->\n\n#### Invoke hook `shrubConfigClient`.\n\nAllows packages to specify configuration that will be sent to the client.\nImplementations may return an object, or a promise that resolves to an object.\n\n      subconfigs = pkgman.invoke 'shrubConfigClient', req\n\n      Promise.all(\n\n        promise for path, promise of subconfigs\n\n      ).then (fulfilledSubconfigs) ->\n\n        config_ = new Config()\n\nPackage-independent...\n\n        config_.set 'packageList', config.get 'packageList'\n\nMerge in the subconfigs.\n\n        index = 0\n        for path of subconfigs\n\n          subconfig = fulfilledSubconfigs[index++]\n          for key, value of subconfig\n            continue unless value?\n\n###### TODO: Multiline\n\n            config_.set \"packageConfig:#{path.replace \/\\\/\/g, ':'}:#{key.replace \/\\\/\/g, ':'}\", value\n\n#### Invoke hook `shrubConfigClientAlter`.\n\n        pkgman.invoke 'shrubConfigClientAlter', req, config_\n\nFormat the configuration to look nice.\n\n        prettyPrintConfig = ->\n\n          jsonArgs = [config_]\n\n          if 'production' isnt config.get 'NODE_ENV'\n            jsonArgs = jsonArgs.concat [null, '  ']\n\n          stringified = JSON.stringify jsonArgs...\n          [first, rest...] = stringified.split '\\n'\n          ([first].concat rest.map (line) -> '    ' + line).join '\\n'\n\n        \"\"\"\n    angular.module('shrub.config', ['shrub.require']).config([\n      'shrub-requireProvider', function(requireProvider) {\n        requireProvider.require('config').from(#{prettyPrintConfig()});\n      }\n    ]);\n      \"\"\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2718d7a40361d4f8bda54dbc3ed37c7bbb5c4506","subject":"Use madul's dependency injection instead of require for Carver","message":"Use madul's dependency injection instead of require for Carver\n\nAlso, load async library (more on that later)\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/skyll.litcoffee","new_file":"lib\/skyll.litcoffee","new_contents":"    Module = require '.\/module'\n    q      = require 'q'\n\n    class Skyll extends Module\n      deps: [ 'q', 'config', 'carver', 'async' ]\n      pub:  [ 'craft' ]\n\n      render_pipeline: [ ]\n\n      initialize: (params) =>\n        deferred      = q.defer()\n        @starting_row = params.starting_row\n\n        super().then =>\n          for p in @config.pipeline\n            @deps.push p unless @deps.includes p\n\n          @hydrate_dependencies().then =>\n            for p in @config.pipeline\n              @render_pipeline.push @[p] unless @render_pipeline.includes @[p]\n\n            deferred.resolve @\n\n        deferred.promise\n\n      craft: (level) =>\n        new Carver()\n          .initialize @starting_row\n          .then (mod)  => mod.carve_path()\n          .then (path) => @q.all @render_pipeline.map (p) => p.render path\n          .then        => @render_pipeline[0].flush level\n          .then        => @render_pipeline[0].reset()\n          .then        => @done()\n\n    module.exports = Skyll\n","old_contents":"    Module = require '.\/module'\n    Carver = require '.\/carver'\n    q      = require 'q'\n\n    class Skyll extends Module\n      deps: [ 'q', 'config' ]\n      pub:  [ 'craft' ]\n\n      render_pipeline: [ ]\n\n      initialize: (params) =>\n        deferred      = q.defer()\n        @starting_row = params.starting_row\n\n        super().then =>\n          for p in @config.pipeline\n            @deps.push p unless @deps.includes p\n\n          @hydrate_dependencies().then =>\n            for p in @config.pipeline\n              @render_pipeline.push @[p] unless @render_pipeline.includes @[p]\n\n            deferred.resolve @\n\n        deferred.promise\n\n      craft: (level) =>\n        new Carver()\n          .initialize @starting_row\n          .then (mod)  => mod.carve_path()\n          .then (path) => @q.all @render_pipeline.map (p) => p.render path\n          .then        => @render_pipeline[0].flush level\n          .then        => @render_pipeline[0].reset()\n          .then        => @done()\n\n    module.exports = Skyll\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"803ab560039cb70ff4e30f76c6923c5eae0cea55","subject":"Refactor:  improve `translateCoord` function.","message":"Refactor:  improve `translateCoord` function.\n\nNow rounding of coordinates is optional.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatTimeAxis()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatTimeAxis()` function ####\n\nA function that formats time axis.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: switch @options.intervalType\n                when 'year' then timePoint.getFullYear().toString()\n                when 'month' then timePoint.getMonth().toString()\n                when 'week', 'day' then timePoint.getDate().toString()\n                when 'hour' then timePoint.getHours().toString()\n                when 'minute' then timePoint.getMinutes().toString()\n                when 'second' then timePoint.getSeconds().toString()\n                when 'millisecond' then \".#{ timePoint.getMilliseconds() }\"\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n      timeAxisRedrerer = new TimeAxisRenderer()\n      timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\nWell, no notes yet.\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatTimeAxis()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatTimeAxis()` function ####\n\nA function that formats time axis.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: switch @options.intervalType\n                when 'year' then timePoint.getFullYear().toString()\n                when 'month' then timePoint.getMonth().toString()\n                when 'week', 'day' then timePoint.getDate().toString()\n                when 'hour' then timePoint.getHours().toString()\n                when 'minute' then timePoint.getMinutes().toString()\n                when 'second' then timePoint.getSeconds().toString()\n                when 'millisecond' then \".#{ timePoint.getMilliseconds() }\"\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the right value, fixing by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n      timeAxisRedrerer = new TimeAxisRenderer()\n      timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\nWell, no notes yet.\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f252f9b9b69642f4507c92455fa32360dc7df912","subject":"Add translateCoord function to deduplicate code.","message":"Add translateCoord function to deduplicate code.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.\n\n#### The `TimelineMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.\n\n#### The `TimelineMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"69b735f497136b9cceaca51b90df4e10f93b91cb","subject":"Convert the league layout to use the new helper","message":"Convert the league layout to use the new helper\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/managers\/league.litcoffee","new_file":"src\/coffee\/managers\/league.litcoffee","new_contents":"League Table Manager\n====================\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe are interested in two key pieces of input information: the\nleaderboard and the team roster.\n\n        inputStream = Bacon.combineTemplate\n            teams: Data.teams\n            leaderboard: League.leaderboard\n\nTable Management\n----------------\n\nWe use D3 to set the data within the table.\n\n        inputStream.onValue (state) ->\n            nodeHTML = (entry) ->\n                \"<td>#{entry.position}<\/td>\n                 <td>#{state.teams[entry.team].name}<\/td>\"\n\n            updateTable = (element, entries) ->\n                DisplayInformation \"##{element}\",\n                                   entries,\n                                   'tr', nodeHTML\n\n            ENTRIES_PER_SIDE = 14\n            updateTable 'league-table-left',\n                        state.leaderboard[0...ENTRIES_PER_SIDE]\n            updateTable 'league-table-right',\n                        state.leaderboard[ENTRIES_PER_SIDE...ENTRIES_PER_SIDE*2]\n\n","old_contents":"League Table Manager\n====================\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe are interested in two key pieces of input information: the\nleaderboard and the team roster.\n\n        inputStream = Bacon.combineTemplate\n            teams: Data.teams\n            leaderboard: League.leaderboard\n\nTable Management\n----------------\n\nWe use D3 to set the data within the table.\n\n        inputStream.onValue (state) ->\n            nodeHTML = (entry) ->\n                \"<td>#{entry.position}<\/td>\n                 <td>#{state.teams[entry.team].name}<\/td>\"\n\n            updateTable = (element, entries) ->\n                tableNodes = d3.select(\"##{element}\")\n                               .selectAll('tr')\n                               .data(entries)\n                               .html(nodeHTML)\n\n                tableNodes.enter()\n                          .append('tr')\n                          .html(nodeHTML)\n\n                tableNodes.exit()\n                          .remove()\n\n            ENTRIES_PER_SIDE = 14\n            updateTable 'league-table-left',\n                        state.leaderboard[0...ENTRIES_PER_SIDE]\n            updateTable 'league-table-right',\n                        state.leaderboard[ENTRIES_PER_SIDE...ENTRIES_PER_SIDE*2]\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"65591856f1a6754af7e3619acbc01a7e827d4440","subject":"remove specialized `express` cloning for methods","message":"remove specialized `express` cloning for methods\n\nWith deprecation of the `state.method` implementation, cloning methods\nworks the same way as cloning items from any other category.\n","repos":"nickfargo\/restate","old_file":"src\/state.litcoffee","new_file":"src\/state.litcoffee","new_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneCategory   _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method held on this state. If no method is found, move up\nthis state\u2019s protostate chain to find one. If no method is found there, move up\nthe superstate chain and repeat the search.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out ) ->\n        if ( method = @_?.methods?[ methodName ] ) and method isnt rootNoop\n          if out? then out.context = this; out.method = method\n          return method\n\n        if viaProto = via & VIA_PROTO and\n            method = @protostate()?.method methodName, VIA_PROTO, out\n          out?.context = this\n          return method\n\n        if via & VIA_SUPER and\n            method = @superstate?.method methodName, VIA_SUPER | viaProto, out\n          return method\n\n        if out? then out.context = null; out.method = method\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state, which will be callable directly from the owner,\nbut with its context bound to the state.\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn, raw ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` holds a lexical state method, then extract the wrapped method, unless\nexplicitly ordered to regard the function in its `raw` form.\n\n        fn = fn this if not raw and fn.isLexicalStateMethodFactory\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root.method methodName, VIA_NONE\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n\nThe owner method must be added to the root state in its \u201craw\u201d form, i.e., not\nlexically transformed by `state.method`.\n\n            root.addMethod methodName, ownerMethod, yes\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context. If the method\nwas originally defined in the owner, the context will be the owner. Otherwise,\nthe context will either be the state in which the method is defined, or if the\nimplementation resides in a protostate, the corresponding state belonging to\nthe inheriting owner. If the named method does not exist locally and cannot be\ninherited, a `noSuchMethod` event is emitted and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n        out = method: undefined, context: undefined\n        unless method = @method methodName, null, out\n          @emit 'noSuchMethod', [ methodName, args ]\n          @emit 'noSuchMethod:' + methodName, args\n          return\n        { context } = out\n        { owner } = this\n        ownerMethod = owner[ methodName ]\n        context = owner if ownerMethod?.original and context is @root\n        method.apply context, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","old_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneMethods    _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneMethods = ( methods ) ->\n          return unless methods?\n          ( out = {}; break ) for name of methods\n          if out then for name, method of methods\n            out[ name ] = if method.isLexicalStateMethod\n            then method.factory\n            else method\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method held on this state. If no method is found, move up\nthis state\u2019s protostate chain to find one. If no method is found there, move up\nthe superstate chain and repeat the search.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out ) ->\n        if ( method = @_?.methods?[ methodName ] ) and method isnt rootNoop\n          if out? then out.context = this; out.method = method\n          return method\n\n        if viaProto = via & VIA_PROTO and\n            method = @protostate()?.method methodName, VIA_PROTO, out\n          out?.context = this\n          return method\n\n        if via & VIA_SUPER and\n            method = @superstate?.method methodName, VIA_SUPER | viaProto, out\n          return method\n\n        if out? then out.context = null; out.method = method\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state, which will be callable directly from the owner,\nbut with its context bound to the state.\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn, raw ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` holds a lexical state method, then extract the wrapped method, unless\nexplicitly ordered to regard the function in its `raw` form.\n\n        fn = fn this if not raw and fn.isLexicalStateMethodFactory\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root.method methodName, VIA_NONE\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n\nThe owner method must be added to the root state in its \u201craw\u201d form, i.e., not\nlexically transformed by `state.method`.\n\n            root.addMethod methodName, ownerMethod, yes\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context. If the method\nwas originally defined in the owner, the context will be the owner. Otherwise,\nthe context will either be the state in which the method is defined, or if the\nimplementation resides in a protostate, the corresponding state belonging to\nthe inheriting owner. If the named method does not exist locally and cannot be\ninherited, a `noSuchMethod` event is emitted and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n        out = method: undefined, context: undefined\n        unless method = @method methodName, null, out\n          @emit 'noSuchMethod', [ methodName, args ]\n          @emit 'noSuchMethod:' + methodName, args\n          return\n        { context } = out\n        { owner } = this\n        ownerMethod = owner[ methodName ]\n        context = owner if ownerMethod?.original and context is @root\n        method.apply context, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ceaff18ad4bbc9f01f3c95e424105a0e48477e78","subject":"Don't crash if config={}","message":"Don't crash if config={}\n\nThe signature of `docco.parse` is `(source, code, config={})` but `getLanguage` crashes if config is {}.  Fix this.\r\n\r\nThis is a regression which appeared in bb4df7546b248adc47db89d5660d5533148b5fc1 (docco 0.6.3).  In docco 0.6.2 the signature of `docco.parse` was `(source, code)` and it didn't crash.","repos":"DoomHammer\/docco,tbremer\/docco,Hellyna\/docco,guigrpa\/docco,jrvidal\/docco,MaxwellRebo\/docco,lobrien\/docco,lobrien\/docco,whitetrefoil\/docco,whitetrefoil\/docco,osharim\/docco,oponder\/docco,MaxwellRebo\/docco,lbn\/docco,gvithellyna\/docco,guigrpa\/docco,tbremer\/docco,robertmackenzie\/docco,ShawnHuang\/docco-multidir,guigrpa\/docco-extended,ShawnHuang\/docco-multidir,jalleyne\/docco,jalleyne\/docco,DoomHammer\/docco,oponder\/docco,mhkeller\/docco,Hellyna\/docco,guigrpa\/docco-extended,lbn\/docco,robertmackenzie\/docco,mhkeller\/docco,osharim\/docco,gvithellyna\/docco,jrvidal\/docco","old_file":"docco.litcoffee","new_file":"docco.litcoffee","new_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* For all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        isText = maybeCode = yes\n        for line, i in lines\n          lines[i] = if maybeCode and match = \/^([ ]{4}|[ ]{0,3}\\t)\/.exec line\n            isText = no\n            line[match[0].length..]\n          else if maybeCode = \/^\\s*$\/.test line\n            if isText then lang.symbol else ''\n          else\n            isText = yes\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n\nPass any user defined options to Marked if specified via command line option\n\n      markedOptions =\n        smartypants: true\n\n      if config.marked\n        markedOptions = config.marked\n\n      marked.setOptions markedOptions\n\nTell Marked how to highlight code blocks within comments, treating that code\nas either the language specified in the code block or the language of the file\nif not specified.\n\n      marked.setOptions {\n        highlight: (code, lang) ->\n          lang or= language.name\n\n          if highlightjs.getLanguage(lang)\n            highlightjs.highlight(lang, code).value\n          else\n            console.warn \"docco: couldn't highlight code block with unknown language '#{lang}' in #{source}\"\n            code\n      }\n\n      for section, i in sections\n        code = highlightjs.highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, file + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      firstSection = _.find sections, (section) ->\n        section.docsText.length > 0\n      first = marked.lexer(firstSection.docsText)[0] if firstSection\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n      marked:     null\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      config.languages = buildMatchers config.languages\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      if options.marked\n        config.marked = JSON.parse fs.readFileSync(options.marked)\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    highlightjs = require 'highlight.js'\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages?[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [file]', 'use a custom languages.json', _.compose JSON.parse, fs.readFileSync)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .option('-m, --marked [file]',    'use custom marked options', c.marked)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","old_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* For all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        isText = maybeCode = yes\n        for line, i in lines\n          lines[i] = if maybeCode and match = \/^([ ]{4}|[ ]{0,3}\\t)\/.exec line\n            isText = no\n            line[match[0].length..]\n          else if maybeCode = \/^\\s*$\/.test line\n            if isText then lang.symbol else ''\n          else\n            isText = yes\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n\nPass any user defined options to Marked if specified via command line option\n\n      markedOptions =\n        smartypants: true\n\n      if config.marked\n        markedOptions = config.marked\n\n      marked.setOptions markedOptions\n\nTell Marked how to highlight code blocks within comments, treating that code\nas either the language specified in the code block or the language of the file\nif not specified.\n\n      marked.setOptions {\n        highlight: (code, lang) ->\n          lang or= language.name\n\n          if highlightjs.getLanguage(lang)\n            highlightjs.highlight(lang, code).value\n          else\n            console.warn \"docco: couldn't highlight code block with unknown language '#{lang}' in #{source}\"\n            code\n      }\n\n      for section, i in sections\n        code = highlightjs.highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, file + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      firstSection = _.find sections, (section) ->\n        section.docsText.length > 0\n      first = marked.lexer(firstSection.docsText)[0] if firstSection\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n      marked:     null\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      config.languages = buildMatchers config.languages\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      if options.marked\n        config.marked = JSON.parse fs.readFileSync(options.marked)\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    highlightjs = require 'highlight.js'\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [file]', 'use a custom languages.json', _.compose JSON.parse, fs.readFileSync)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .option('-m, --marked [file]',    'use custom marked options', c.marked)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2101c94f4d0af414b6a1bea6162fd3b2e6b03bb4","subject":"PR comment adjustments","message":"PR comment adjustments\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08_app.litcoffee","new_file":"docs\/08_app.litcoffee","new_contents":"# Batman.App\n\n`Batman.App` is the central object in any Batman application. It manages the routing table and the current URL parameters, as well as the initial start of the application. It should also be used as a namespace for models and views so that other objects can find them. Batman assumes that there will only ever be one `Batman.App` in use at once.\n\n## Batman.currentApp\n\nA Batman-wide reference to the currently running `Batman.App`.\n\n## @run() : App\n\n`App.run` is the central entry point for a Batman application. `@run` takes these steps to initialize a Batman application:\n\n 1. Instantiate a `Dispatcher`, an internal object for mananging action dispatch to controllers.\n 2. Instantiate a `Navigator`, an internal object for managing the URL via pushState or hashbangs.\n 3. Instantiate the `layout` view according to the `layout` property on the `App`.\n 4. Wait for the layout view to fire it's `ready` event.\n 5. Start the first action dispatch by telling the `Navigator` to begin monitoring the URL.\n\n_Note_: `@run` emits the `run` class event on the `App`, but not necessarily as soon as `@run` is called. Because the `layout` View renders asynchronously and may need to fetch other components, the `run` event can and often does fire long after `@run` is called. If you need to execute code as soon as the `App` has started running, add a listener to the `run` event on the `App` class. If you need to execute code as soon as the layout has rendered, you can use the `ready` event on the `App` class.\n\n`@run` can be called before or on the `load` DOMEvent of the window. `@run` will return the App if the commencement was successful and complete, or `false` if the App must wait for the `layout` to render or if the `App` has already run.\n\n#### starting an application with DOMEvents\n```coffeescript\nwindow.addEventListener 'load', ->\n  MyApp.run()\n```\n\n#### starting an application with jQuery\n```coffeescript\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\n`@stop` stops the `App` it's called upon. The URL will stop being monitored and no more actions will be dispatched. In usual Batman development you shouldn't have to call this.\n\n## @routes\n\n`@routes` is a class level property referencing the root level `NamedRouteQuery` which allows for binding to routes on objects. See `data-route` bindings for more information.\n\n## @controllers\n\n`@controllers` is a class level property containing the singleton `Batman.Controller` instances for each subclass in the application. This `controllers` directory puts these instances at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`. `@controllers` ideally should never be bound to, but it is very useful for debugging in the console and other such workarounds.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n## @layout\n\n`@layout` is the base view of the entire view hierarchy. By default, it will parse any data-* attributes in the entire document, excluding any `data-yield`'s, when `App.run()` is called. Use `MyApp.layout = null` to disable the creation of this default view.\n\n## @currentParams\n\n`@currentParams` contains the URL parameters for the current request, including the path relative to the app's base path (`Batman.config.pathToApp`). Some interesting parts to look at: `@currentParams.controller`, `@currentParams.action`.\n\n## @paramsManager\n## @paramsPusher\n\n## 'run' class event\n\nThe `run` class event is fired once the app has run. This indeterminately but often happens before the app's layout has finished rendering.\n\n## 'ready' class event\n\nThe `ready` class event is fired once the app's layout is rendered.\n\n# Batman.App Routing\n\nThe `Batman` routing DSL is similar to Rails 3's routing DSL. It is oriented around the notion of a resource:\n\n## @route\n\n`@route` defines a custom route and can be pointed to a controller action directly. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @route 'comments', 'pages#comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/comments` being added to the routing map, pointed to `PagesController#comments`.\n\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n## @member\n\n`@member` defines a routable action you can call on a specific instance of a member of a collection resource. For example, if you have a collection of `Page` resources, and a user can post a comment on a specific page:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @member 'comment'\n\nclass Example.PagesController extends Batman.Controller\n  comment: (params) ->\n```\n\nWould result in `\/pages\/:id\/comment` being added to the routing map, pointed to `PagesController#comment`.\n\n## @collection\n\n`@collection` is similar to `@member` in that it adds routable actions to a `@resources` set of routes. In this case the action would apply to the entire collection. For example, if you have a list of spam comments made across _all_ your `Page` resources:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @collection 'spam_comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/pages\/spam_comments` being added to the routing map, pointed to `PagesController#spam_comments`.\n\n## @root\n\n`@root` defines the root controller and action to be used when visiting the base application URL. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @root 'pages#index'\n\nclass Example.PagesController extends Batman.Controller\n  index: ->\n```\n\nWould result in `\/` being pointed to `PagesController#index`.","old_contents":"# Batman.App\n\n`Batman.App` is the central object in any Batman application. It manages the routing table and the current URL parameters, as well as the initial start of the application. It should also be used as a namespace for models and views so that other objects can find them. Batman assumes that there will only ever be one `Batman.App` in use at once.\n\n## Batman.currentApp\n\nA Batman-wide reference to the currently running `Batman.App`.\n\n## @run() : App\n\n`App.run` is the central entry point for a Batman application. `@run` takes these steps to initialize a Batman application:\n\n 1. Instantiate a `Dispatcher`, an internal object for mananging action dispatch to controllers.\n 2. Instantiate a `Navigator`, an internal object for managing the URL via pushState or hashbangs.\n 3. Instantiate the `layout` view according to the `layout` property on the `App`.\n 4. Wait for the layout view to fire it's `ready` event.\n 5. Start the first action dispatch by telling the `Navigator` to begin monitoring the URL.\n\n_Note_: `@run` emits the `run` class event on the `App`, but not necessarily as soon as `@run` is called. Because the `layout` View renders asynchronously and may need to fetch other components, the `run` event can and often does fire long after `@run` is called. If you need to execute code as soon as the `App` has started running, add a listener to the `run` event on the `App` class. If you need to execute code as soon as the layout has rendered, you can use the `ready` event on the `App` class.\n\n`@run` can be called before or on the `load` DOMEvent of the window. `@run` will return the App if the commencement was successful and complete, or `false` if the App must wait for the `layout` to render or if the `App` has already run.\n\n#### starting an application with DOMEvents\n```coffeescript\nwindow.addEventListener 'load', ->\n  MyApp.run()\n```\n\n#### starting an application with jQuery\n```coffeescript\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\n`@stop` stops the `App` it's called upon. The URL will stop being monitored and no more actions will be dispatched. In usual Batman development you shouldn't have to call this.\n\n## @routes\n\n`@routes` is a class level property referencing the root level `NamedRouteQuery` which allows for binding to routes on objects. See `data-route` bindings for more information.\n\n## @controllers\n\n`@controllers` is a class level property containing the singleton `Batman.Controller` instances for each subclass in the application. This `controllers` directory puts these instances at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`. `@controllers` ideally should never be bound to, but it is very useful for debugging in the console and other such workarounds.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n## @layout\n\n`@layout` is the base view that other views can be yielded into. The\ndefault behavior is that when `app.run()` is called, a new view will\nbe created for the layout using the `document` node as its content.\nUse `MyApp.layout = null` to turn off the default behavior.\n\n## @currentParams\n\n`@currentParams` contains the current parameters for the current request, including the path relative to the app's base path.\n\n## @paramsManager\n## @paramsPusher\n\n## 'run' class event\n\nThe `run` class event is fired once the app has run. This indeterminately but often happens before the app's layout has finished rendering.\n\n## 'ready' class event\n\nThe `ready` class event is fired once the app's layout is rendered.\n\n# Batman.App Routing\n\nThe `Batman` routing DSL is similar to Rails 3's routing DSL. It is oriented around the notion of a resource:\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n## @member\n\n`@member` defines a route relative to a specific resource. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @member 'comment'\n\nclass Example.PagesController extends Batman.Controller\n  comment: (params) ->\n```\n\nWould result in `\/pages\/:id\/comment` being added to the routing map, pointed to `PagesController#comment`.\n\n## @collection\n\n`@collection` defines a route relative to a base resource. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @collection 'comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/pages\/comments` being added to the routing map, pointed to `PagesController#comments`.\n\n## @route\n\n`@route` defines a custom route and can be pointed to a controller action directly. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @route 'comments', 'pages#comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/comments` being added to the routing map, pointed to `PagesController#comments`.\n\n## @root\n\n`@root` defines the root controller and action to be used when visiting the base application URL. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @root 'pages#index'\n\nclass Example.PagesController extends Batman.Controller\n  index: ->\n```\n\nWould result in `\/` being pointed to `PagesController#index`.","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5c131ce48808b82ab86bc256e623aaabf07b3eef","subject":"Add default values for options in TimeLineMaker constructor.","message":"Add default values for options in TimeLineMaker constructor.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a6a9e96313939a18f426b1da3bc59425ffff4057","subject":"removing test nonsense","message":"removing test nonsense\n","repos":"glamp\/leech,glamp\/leech","old_file":"test\/test.litcoffee","new_file":"test\/test.litcoffee","new_contents":"","old_contents":"Testing things out...\n\n    shorten = require '.\/index'\n    shorten \"http:\/\/blog.yhathq.com\/\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"531d3241bfedde60a39ab94457ca87ad4b293295","subject":"Docs for Bindings done","message":"Docs for Bindings done\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n  \t\t              find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n      lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\n  F.ignorance = new Bindings()\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n  \t\t              find(_.rest(lvar), bindings))\n      lvar\n\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"08751db325baef555fcd70b753834c46623de492","subject":"Clean up ToDo","message":"Clean up ToDo\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/cache.litcoffee","new_file":"coffee\/cache.litcoffee","new_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### Todo\n\n* Handle undefined values.\n\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      set       : set\n      get       : get\n      getDoc    : getDoc\n      setForType: setForType\n      getFilter : getFilter\n      filterData: filterData\n      getForType: getForType\n\n","old_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### Todo\n\n* [ ] Handle undefined values (@starefossen)\n\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      set       : set\n      get       : get\n      getDoc    : getDoc\n      setForType: setForType\n      getFilter : getFilter\n      filterData: filterData\n      getForType: getForType\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a2aec7571fb4b1e43d888e7be1d981c2c6c81ab9","subject":"fix tabs on litcoffee tests","message":"fix tabs on litcoffee tests\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/01_batman.litcoffee","new_file":"docs\/01_batman.litcoffee","new_contents":"# Batman\n\nBatman includes a number of useful, general purpose helper functions and references. They can all be found attached to the `Batman` object and can optionally be exported into the global namespace with a `$` prefix.\n\n## container\n\n`Batman.container` points to either the `window` object if running in the browser, or the `global` object if running in node. This is useful if you want to add something to the global scope in all environments.\n\n## @typeOf(object) : string\n\n`typeOf` determines a more specific type of an `object` than the native `typeof` operator in JavaScript. This is useful for a number of situations like dealing with `Object` promoted strings and numbers, or arrays which look like `object`s to `typeof`. Use `typeOf` when you need more than `\"object\"` from `typeof`.\n\n_Note_: `typeOf` is substantially slower than `typeof`. `typeOf` works in a somewhat hackish manner by getting the `Object::toString` representation of the object and slicing it to retrieve the name of the constructor.\n\n    test 'typeOf returns \"String\" for both strings and Object strings', ->\n      primitive = \"test\"\n      objectified = new String(\"test\")\n      equal typeof primitive, \"string\"\n      equal typeof objectified, \"object\"\n      equal Batman.typeOf(primitive), \"String\"\n      equal Batman.typeOf(objectified), \"String\"\n\n    test 'typeOf returns Array for arrays', ->\n      array = [];\n      equal typeof array, \"object\"\n      equal Batman.typeOf(array), \"Array\"\n\n## @mixin(subject, objects...) : subject\n\n`mixin`, occasionally known elsewhere as `extend` or `merge`, flattens a series of objects onto the subject. Key\/value pairs on objects passed as later arguments (arguments with a higher index) take precedence over earlier arguments. Returns the `subject` passed in with the new values.\n\n`mixin` also has special properties that make it different than the canonical `extend` functions:\n\n 1. If the `subject` has a `set` function, `subject.set(key, value)` will be used to apply keys instead of `subject[key] = value`. This means that if the subject is a `Batman.Object`, observers and thus bindings on the object will be notified when other (Batmanified or not) objects are mixed into it.\n 2. If a mixed-in `object` has an `initialize` function defined, that function will be called and passed the `subject`. This is useful for custom extension logic, similar to `self.included` in Ruby. For this reason, the keys `initialize` and `uninitialize` are skipped by `mixin`.\n 3. `mixin` only iterates over keys for which the `hasOwnProperty` test passes.\n\n_Note_: `mixin` is destructive to (only) the first argument. If you need a non-destructive version of `mixin`, just pass an empty object as the first object, and all keys from the successive arguments will be applied to the empty object.\n\n    test 'mixin merges argument objects', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {fit: true}, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual subject, {fit: true, fly: true, funky: true}, \"the subject is modified destructively\"\n\n    test 'mixin merges argument objects', ->\n      unmodified = {fit: true}\n      deepEqual Batman.mixin({}, unmodified, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual unmodified, {fit: true}, \"argument objects are untouched allowing non-destructive merge\"\n\n    test 'mixed in objects passed as higher indexed arguments take precedence', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {x: 1, y: 1}, {x: 2}), {x: 2, y: 1}\n\n## @unmixin(subject, objects...) : subject\n\n`unmixin` \"unmerges\" the passed objects from the `subject`. If a key exists on any of the `objects` it will be `delete`d from the `subject`. Returns the `subject`.\n\n`unmixin`, similar to `mixin`, supports calling an `uninitialize` function for each of the `objects` being unmixed in. If an `uninitialize` function exists on each\n\n    test 'unmixin removes keys found on the unmixined objects on the subject', ->\n      subject = {fit: true, fly: true, funky: true}\n      deepEqual Batman.unmixin(subject, {fit: true}, {fly: true}), {funky: true}, \"unmixin returns the subject\"\n      deepEqual subject, {funky: true}, \"the subject is destructively modified.\"\n\n## @functionName(function) : string\n\n`functionName` returns the name of a given function, if any. Works with Internet Explorer 7\/8\/9, FireFox, Chrome, and Safari.\n\n    test 'functionName returns the name of a given function', ->\n      equal Batman.functionName(\"\".toString), 'toString'\n\n## @isChildOf(parent : HTMLElement, child : HTMLElement) : boolean\n\n`isChildOf` is a simple DOM helper which returns a boolean describing if the passed `child` node can be found in the descendants of the passed `parent` node.\n\n## @setImmediate(callback : Function) : object\n\n`setImmediate` (and its sister `clearImmediate`) are a more efficient version of `setTimeout(callback, 0)`. Due to timer resolution issues, setTimeout passed a timeout of 0 doesn't actually execute the function as soon as the JS execution stack has been emptied, but at minimum 4ms and maxmium 25ms after. For this reason Batman provides a cross browser implementation of `setImmediate` which does its best to call the callback immediately after the stack empties. Batman's `setImmediate` polyfill uses the native version if available, `window.postmessage` trickery if supported, and falls back on `setTimeout(->, 0)`.\n\n`setImmediate` returns a handle which can be passed to `clearImmediate` to cancel the future calling of the callback.\n\n## @clearImmediate(handle)\n\n`clearImmediate` stops the calling of a callback in the future when passed its `handle` (which is returned from the `setImmediate` call used to enqueue it).\n\n## @forEach(iterable : object, iterator : Function[, context : Object])\n\nThe `forEach` Batman helper is a universal iteration helper. When passed an `iterable` object, the helper will call the `iterator` (optionally in the `context`) for each item in the `iterable`. The `iterable` can be:\n\n 1. something which has its own `forEach`, in which case the `iterator` will just be passed to `iterable.forEach`.\n 2. an array like object, in which case a JavaScript `for(;;)` loop will be used to iterate over each entry\n 3. or an object, in which case a JavaScript `for-in` loop will be used to iterate over each entry.\n\nThe `forEach` helper is useful for iterating over objects when the type of those objects isn't guaranteed.\n\n    test 'forEach iterates over objects with forEach defined', ->\n      results = []\n      set = new Batman.SimpleSet('a')\n      Batman.forEach(set, (x) -> results.push(x))\n      deepEqual results, ['a']\n\n    test 'forEach iterates over array like objects', ->\n      results = []\n      ArrayLike = ->\n      ArrayLike:: = []\n      imitation = new ArrayLike\n      Array::push.call(imitation, \"a\")\n      Array::push.call(imitation, \"b\")\n      Batman.forEach(imitation, (x) -> results.push(x))\n      deepEqual results, ['a', 'b']\n\n    test 'forEach iterates over objects', ->\n      result = {}\n      object = {x: true}\n      Batman.forEach(object, (key, val) -> result[key] = val)\n      deepEqual result, object\n\n## @objectHasKey(object, key) : boolean\n\n`objectHasKey` returns a boolean describing the presence of the `key` in the passed `object`. `objectHasKey` delegates to the `object`'s `hasKey` function if present, and otherwise just does a check using the JavaScript `in` operator.\n\n    test 'objectHasKey verifies if a key is present in an object', ->\n      subject = {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n    test 'objectHasKey verifies if a key is present in an object with `hasKey` defined', ->\n      subject = new Batman.SimpleHash {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n## @contains(object, item) : boolean\n\n`contains` returns a boolean describing if the given `object` has member `item`. Membership in this context is defined as:\n\n + the result of `object.has(item)` if the `object` has a `has` function defined\n + the result of `item in object` if the `object` is arraylike\n + the result of the Batman.objectHasKey otherwise\n\n_Note_: When passed an object without a `has` function, `contains` will return `true` if the `object` has `item` as a *`key`*, not as a value at any key.\n\n`contains` is useful for checking item membership when the type of the object can't be relied on.\n\n## @get(object, key) : value\n\n`get` is a general purpose function for retrieving the value from a `key` on an `object` of an indeterminate type. This is useful if code needs to work with both `Batman.Object`s and Plain Old JavaScript Objects. `get` has the following semantics:\n\n- if the `object` has a `get` function defined, return the result of `object.get(key)`\n- if the object does not have a `get` function defined, use an ephemeral `Batman.Property` to retrieve the key. This is equivalent to `object[key]` for single segment `key`s, but if the `key` is multi-segment (example: 'product.customer.name'), `get` will do nested gets until the either `undefined` or the end of the keypath is reached.\n\n<!-- tests -->\n\n    test 'get returns the value at a key on a POJO', ->\n      subject = {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a key on a Batman.Object', ->\n      subject = Batman {fit: true}\n      equal Batman.get(subject, 'fit'), true\n      equal Batman.get(subject, 'flirty'), undefined\n\n    test 'get returns the value at a deep key on a POJO', ->\n      subject = {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n    test 'get returns the value at a deep key on a Batman.Object', ->\n      subject = Batman {customer: {name: \"Joe\"}}\n      equal Batman.get(subject, 'customer.name'), \"Joe\"\n      equal Batman.get(subject, 'customer.age'), undefined\n\n## @getPath(base, segments) : string\n\n`getPath` returns the hash value denoted by the specified path, which consists of an array of nested hash keys. See examples below for more detail.\n\n    test \"takes a base and an array of keys and returns the corresponding nested value\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo', 'bar']), 'nested value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo.bar']), 'flat value'\n      strictEqual Batman.getPath(@complexObject, ['hash', 'not-foo', 'bar']), undefined\n\n    test \"returns just the base if the key array is empty\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(@complexObject, []), @complexObject\n      strictEqual Batman.getPath(null, []), null\n\n    test \"returns undefined if the base is null-ish\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(null, ['foo']), undefined\n      strictEqual Batman.getPath(undefined, ['foo']), undefined\n\n    test \"returns falsy values\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(num: 0, ['num']), 0\n      strictEqual Batman.getPath(thing: null, ['thing']), null\n\n## @escapeHTML(input) : string\n\n`escapeHTML` takes a string of unknown origin and makes it safe for display on a web page by encoding control characters in HTML into their HTML entities.\n\n*Warning*: Do not rely on `escapeHTML` to purge unsafe data from user submitted content. While `escapeHTML` is applied to every binding's contents by default, it should not be your only line of defence against script injection attacks.\n\n    test 'escapeHTML encodes special characters into HTML entities', ->\n      equal Batman.escapeHTML(\"& < > \\\" '\"), \"&amp; &lt; &gt; &#34; &#39;\"\n\n## @redirect(options: [string|Object])\n\nRedirects to a new path with either pushState or hashbang navigation, depending on your [configuration](\/docs\/configuration.html). `options` may be:\n\n- a string, which is treated as the target path (eg, `\"\/posts\"`)\n- a `Batman.Model` class, which redirects to \"index\" (eg, `Batman.redirect(MyApp.Post)` redirects to `\"\/posts\"`)\n- a `Batman.Model` instance, which redirects to \"show\" (eg, `Batman.redirect(thisPost)` redirects to `\"\/posts\/#{thisPost.toParam()}\"`)\n- an object containing params:\n  - `Batman.redirect({controller: \"posts\", action: \"index\"})` redirects to  `\"\/posts\"`\n  - `Batman.redirect({controller: \"posts\", action: \"edit\", id: 6})` redirects to `\"\/posts\/6\/edit\"`\n","old_contents":"# Batman\n\nBatman includes a number of useful, general purpose helper functions and references. They can all be found attached to the `Batman` object and can optionally be exported into the global namespace with a `$` prefix.\n\n## container\n\n`Batman.container` points to either the `window` object if running in the browser, or the `global` object if running in node. This is useful if you want to add something to the global scope in all environments.\n\n## @typeOf(object) : string\n\n`typeOf` determines a more specific type of an `object` than the native `typeof` operator in JavaScript. This is useful for a number of situations like dealing with `Object` promoted strings and numbers, or arrays which look like `object`s to `typeof`. Use `typeOf` when you need more than `\"object\"` from `typeof`.\n\n_Note_: `typeOf` is substantially slower than `typeof`. `typeOf` works in a somewhat hackish manner by getting the `Object::toString` representation of the object and slicing it to retrieve the name of the constructor.\n\n    test 'typeOf returns \"String\" for both strings and Object strings', ->\n      primitive = \"test\"\n      objectified = new String(\"test\")\n      equal typeof primitive, \"string\"\n      equal typeof objectified, \"object\"\n      equal Batman.typeOf(primitive), \"String\"\n      equal Batman.typeOf(objectified), \"String\"\n\n    test 'typeOf returns Array for arrays', ->\n      array = [];\n      equal typeof array, \"object\"\n      equal Batman.typeOf(array), \"Array\"\n\n## @mixin(subject, objects...) : subject\n\n`mixin`, occasionally known elsewhere as `extend` or `merge`, flattens a series of objects onto the subject. Key\/value pairs on objects passed as later arguments (arguments with a higher index) take precedence over earlier arguments. Returns the `subject` passed in with the new values.\n\n`mixin` also has special properties that make it different than the canonical `extend` functions:\n\n 1. If the `subject` has a `set` function, `subject.set(key, value)` will be used to apply keys instead of `subject[key] = value`. This means that if the subject is a `Batman.Object`, observers and thus bindings on the object will be notified when other (Batmanified or not) objects are mixed into it.\n 2. If a mixed-in `object` has an `initialize` function defined, that function will be called and passed the `subject`. This is useful for custom extension logic, similar to `self.included` in Ruby. For this reason, the keys `initialize` and `uninitialize` are skipped by `mixin`.\n 3. `mixin` only iterates over keys for which the `hasOwnProperty` test passes.\n\n_Note_: `mixin` is destructive to (only) the first argument. If you need a non-destructive version of `mixin`, just pass an empty object as the first object, and all keys from the successive arguments will be applied to the empty object.\n\n    test 'mixin merges argument objects', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {fit: true}, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual subject, {fit: true, fly: true, funky: true}, \"the subject is modified destructively\"\n\n    test 'mixin merges argument objects', ->\n      unmodified = {fit: true}\n      deepEqual Batman.mixin({}, unmodified, {fly: true}, {funky: true}), {fit: true, fly: true, funky: true}, \"mixin returns the subject\"\n      deepEqual unmodified, {fit: true}, \"argument objects are untouched allowing non-destructive merge\"\n\n    test 'mixed in objects passed as higher indexed arguments take precedence', ->\n      subject = {}\n      deepEqual Batman.mixin(subject, {x: 1, y: 1}, {x: 2}), {x: 2, y: 1}\n\n## @unmixin(subject, objects...) : subject\n\n`unmixin` \"unmerges\" the passed objects from the `subject`. If a key exists on any of the `objects` it will be `delete`d from the `subject`. Returns the `subject`.\n\n`unmixin`, similar to `mixin`, supports calling an `uninitialize` function for each of the `objects` being unmixed in. If an `uninitialize` function exists on each\n\n    test 'unmixin removes keys found on the unmixined objects on the subject', ->\n      subject = {fit: true, fly: true, funky: true}\n      deepEqual Batman.unmixin(subject, {fit: true}, {fly: true}), {funky: true}, \"unmixin returns the subject\"\n      deepEqual subject, {funky: true}, \"the subject is destructively modified.\"\n\n## @functionName(function) : string\n\n`functionName` returns the name of a given function, if any. Works with Internet Explorer 7\/8\/9, FireFox, Chrome, and Safari.\n\n    test 'functionName returns the name of a given function', ->\n      equal Batman.functionName(\"\".toString), 'toString'\n\n## @isChildOf(parent : HTMLElement, child : HTMLElement) : boolean\n\n`isChildOf` is a simple DOM helper which returns a boolean describing if the passed `child` node can be found in the descendants of the passed `parent` node.\n\n## @setImmediate(callback : Function) : object\n\n`setImmediate` (and its sister `clearImmediate`) are a more efficient version of `setTimeout(callback, 0)`. Due to timer resolution issues, setTimeout passed a timeout of 0 doesn't actually execute the function as soon as the JS execution stack has been emptied, but at minimum 4ms and maxmium 25ms after. For this reason Batman provides a cross browser implementation of `setImmediate` which does its best to call the callback immediately after the stack empties. Batman's `setImmediate` polyfill uses the native version if available, `window.postmessage` trickery if supported, and falls back on `setTimeout(->, 0)`.\n\n`setImmediate` returns a handle which can be passed to `clearImmediate` to cancel the future calling of the callback.\n\n## @clearImmediate(handle)\n\n`clearImmediate` stops the calling of a callback in the future when passed its `handle` (which is returned from the `setImmediate` call used to enqueue it).\n\n## @forEach(iterable : object, iterator : Function[, context : Object])\n\nThe `forEach` Batman helper is a universal iteration helper. When passed an `iterable` object, the helper will call the `iterator` (optionally in the `context`) for each item in the `iterable`. The `iterable` can be:\n\n 1. something which has its own `forEach`, in which case the `iterator` will just be passed to `iterable.forEach`.\n 2. an array like object, in which case a JavaScript `for(;;)` loop will be used to iterate over each entry\n 3. or an object, in which case a JavaScript `for-in` loop will be used to iterate over each entry.\n\nThe `forEach` helper is useful for iterating over objects when the type of those objects isn't guaranteed.\n\n    test 'forEach iterates over objects with forEach defined', ->\n      results = []\n      set = new Batman.SimpleSet('a')\n      Batman.forEach(set, (x) -> results.push(x))\n      deepEqual results, ['a']\n\n    test 'forEach iterates over array like objects', ->\n      results = []\n      ArrayLike = ->\n      ArrayLike:: = []\n      imitation = new ArrayLike\n      Array::push.call(imitation, \"a\")\n      Array::push.call(imitation, \"b\")\n      Batman.forEach(imitation, (x) -> results.push(x))\n      deepEqual results, ['a', 'b']\n\n    test 'forEach iterates over objects', ->\n      result = {}\n      object = {x: true}\n      Batman.forEach(object, (key, val) -> result[key] = val)\n      deepEqual result, object\n\n## @objectHasKey(object, key) : boolean\n\n`objectHasKey` returns a boolean describing the presence of the `key` in the passed `object`. `objectHasKey` delegates to the `object`'s `hasKey` function if present, and otherwise just does a check using the JavaScript `in` operator.\n\n    test 'objectHasKey verifies if a key is present in an object', ->\n      subject = {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n    test 'objectHasKey verifies if a key is present in an object with `hasKey` defined', ->\n      subject = new Batman.SimpleHash {fit: true}\n      ok Batman.objectHasKey(subject, 'fit')\n      equal Batman.objectHasKey(subject, 'flirty'), false\n\n## @contains(object, item) : boolean\n\n`contains` returns a boolean describing if the given `object` has member `item`. Membership in this context is defined as:\n\n + the result of `object.has(item)` if the `object` has a `has` function defined\n + the result of `item in object` if the `object` is arraylike\n + the result of the Batman.objectHasKey otherwise\n\n_Note_: When passed an object without a `has` function, `contains` will return `true` if the `object` has `item` as a *`key`*, not as a value at any key.\n\n`contains` is useful for checking item membership when the type of the object can't be relied on.\n\n## @get(object, key) : value\n\n`get` is a general purpose function for retrieving the value from a `key` on an `object` of an indeterminate type. This is useful if code needs to work with both `Batman.Object`s and Plain Old JavaScript Objects. `get` has the following semantics:\n\n + if the `object` has a `get` function defined, return the result of `object.get(key)`\n + if the object does not have a `get` function defined, use an ephemeral `Batman.Property` to retrieve the key. This is equivalent to `object[key]` for single segment `key`s, but if the `key` is multi-segment (example: 'product.customer.name'), `get` will do nested gets until the either `undefined` or the end of the keypath is reached.\n\n        test 'get returns the value at a key on a POJO', ->\n          subject = {fit: true}\n          equal Batman.get(subject, 'fit'), true\n          equal Batman.get(subject, 'flirty'), undefined\n\n        test 'get returns the value at a key on a Batman.Object', ->\n          subject = Batman {fit: true}\n          equal Batman.get(subject, 'fit'), true\n          equal Batman.get(subject, 'flirty'), undefined\n\n        test 'get returns the value at a deep key on a POJO', ->\n          subject = {customer: {name: \"Joe\"}}\n          equal Batman.get(subject, 'customer.name'), \"Joe\"\n          equal Batman.get(subject, 'customer.age'), undefined\n\n        test 'get returns the value at a deep key on a Batman.Object', ->\n          subject = Batman {customer: {name: \"Joe\"}}\n          equal Batman.get(subject, 'customer.name'), \"Joe\"\n          equal Batman.get(subject, 'customer.age'), undefined\n\n## @getPath(base, segments) : string\n\n`getPath` returns the hash value denoted by the specified path, which consists of an array of nested hash keys. See examples below for more detail.\n\n    test \"takes a base and an array of keys and returns the corresponding nested value\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo', 'bar']), 'nested value'\n      equal Batman.getPath(@complexObject, ['hash', 'foo.bar']), 'flat value'\n      strictEqual Batman.getPath(@complexObject, ['hash', 'not-foo', 'bar']), undefined\n\n    test \"returns just the base if the key array is empty\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(@complexObject, []), @complexObject\n      strictEqual Batman.getPath(null, []), null\n\n    test \"returns undefined if the base is null-ish\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(null, ['foo']), undefined\n      strictEqual Batman.getPath(undefined, ['foo']), undefined\n\n    test \"returns falsy values\", ->\n      @complexObject = new Batman.Object\n        hash: new Batman.Hash\n          foo: new Batman.Object(bar: 'nested value'),\n          \"foo.bar\": 'flat value'\n      strictEqual Batman.getPath(num: 0, ['num']), 0\n      strictEqual Batman.getPath(thing: null, ['thing']), null\n\n## @escapeHTML(input) : string\n\n`escapeHTML` takes a string of unknown origin and makes it safe for display on a web page by encoding control characters in HTML into their HTML entities.\n\n*Warning*: Do not rely on `escapeHTML` to purge unsafe data from user submitted content. While `escapeHTML` is applied to every binding's contents by default, it should not be your only line of defence against script injection attacks.\n\n    test 'escapeHTML encodes special characters into HTML entities', ->\n      equal Batman.escapeHTML(\"& < > \\\" '\"), \"&amp; &lt; &gt; &#34; &#39;\"\n\n## @redirect(options: [string|Object])\n\nRedirects to a new path with either pushState or hashbang navigation, depending on your [configuration](\/docs\/configuration.html). `options` may be:\n\n- a string, which is treated as the target path (eg, `\"\/posts\"`)\n- a `Batman.Model` class, which redirects to \"index\" (eg, `Batman.redirect(MyApp.Post)` redirects to `\"\/posts\"`)\n- a `Batman.Model` instance, which redirects to \"show\" (eg, `Batman.redirect(thisPost)` redirects to `\"\/posts\/#{thisPost.toParam()}\"`)\n- an object containing params:\n  - `Batman.redirect({controller: \"posts\", action: \"index\"})` redirects to  `\"\/posts\"`\n  - `Batman.redirect({controller: \"posts\", action: \"edit\", id: 6})` redirects to `\"\/posts\/6\/edit\"`\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"aa279e7d796538e4297d2a0e9fedeaaff58c1e8d","subject":"Removed logger","message":"Removed logger\n\nMadul no longer handles logging directly - instead it fires events.\n\nClients or sub-maduls can listen for these events and log as they see fit.\n","repos":"bsgbryan\/madul","old_file":"lib\/logger.litcoffee","new_file":"lib\/logger.litcoffee","new_contents":"","old_contents":"    winston    = require 'winston'\n    prettyjson = require 'prettyjson'\n\n    pretty = prettyjson.render\n    args   =\n      noAlign:            true\n      inlineArrays:       true\n      defaultIndentation: 2\n\n    clone_depth = 0\n    clone_limit = (process.env.MADUL_LOG_LEVEL || 3) - 4\n\n    commaize = (x) -> x.toString().replace \/\\B(?=(\\d{3})+(?!\\d))\/g, ','\n\n    clone = (obj) ->\n      if obj == null || typeof obj != 'object'\n        obj\n      else\n        temp = { }\n\n        for key, val of obj\n          if typeof val == 'object' && Array.isArray(val) == false\n            if clone_depth++ < clone_limit\n              temp[key] = clone val\n            else\n              temp[key] = 'nested object'\n          else if typeof val != 'function' && key != 'clauses'\n            if key.toLowerCase().includes 'password'\n              temp[key] = '********'\n            else\n              temp[key] = val\n\n        clone_depth = 0\n\n        temp\n\n    winston.loggers.add 'trace',\n      console:\n        level: 'silly'\n        formatter: (o) ->\n          meta = if o.meta?   then \"\\n#{pretty o.meta, args, 2}\" else ''\n          msg  = if o.message then o.message                     else ''\n\n          \"#{msg}#{meta}\"\n\n    winston.loggers.add 'debug',\n      console:\n        level: 'debug'\n        formatter: (o) ->\n          meta = if o.meta?   then \"\\n#{pretty o.meta, args, 2}\" else ''\n          msg  = if o.message then o.message                     else ''\n\n          \"\\n-= ^.^ =-\\n\\n#{msg}#{meta}\\n\"\n\n    winston.loggers.add 'info',\n      console:\n        level: 'info'\n        formatter: (o) ->\n          first = o.level.toUpperCase()\n          meta  = if o.meta?   then \"\\n\\n#{pretty o.meta, args, 4}\" else ''\n          msg   = if o.message then \"\\n  #{o.message}\"              else ''\n\n          \"#{first}#{msg}#{meta}\\n\\n-= o.o =-\\n\\n\"\n\n    winston.loggers.add 'warn',\n      console:\n        level: 'warn'\n        timestamp: -> new Date()\n        formatter: (o) ->\n          level = o.level.toUpperCase()\n          time  = \"  #{o.timestamp()}\"\n          meta  = if o.meta?   then \"\\n#{pretty o.meta, args, 6}\" else ''\n          msg   = if o.message then \"\\n    #{o.message}\"          else ''\n\n          \"\\n... -= o.O =- ...  #{level}#{time}#{msg}#{meta}\\n\"\n\n    winston.loggers.add 'error',\n      console:\n        level: 'error'\n        timestamp: -> new Date()\n        formatter: (o) ->\n          level = o.level.toUpperCase()\n          time  = \"  #{o.timestamp()}\"\n          meta  = if o.meta?   then \"\\n#{pretty o.meta, args, 6}\" else ''\n          msg   = if o.message then \"\\n    #{o.message}\"          else ''\n\n          \"\\n!!! -= O.O =- !!!  #{level}\\n#{time}#{msg}#{meta}\\n\"\n\n    resolved = (clazz, method, runtime, data) ->\n      stats = \"status: success, runtime: #{commaize runtime}\u03bc\"\n      trace \"#{clazz}.#{method}(#{stats})\", data\n\n    notify = (clazz, method, delta, data) ->\n      stats = \"status: update, iteration: #{commaize delta}\u03bc\"\n      trace \"#{clazz}.#{method}(#{stats})\", data\n\n    rejected = (clazz, method, runtime, data) ->\n      stats = \"status: error, runtime: #{commaize runtime}\u03bc\"\n      error \"#{clazz}.#{method}(#{stats})\", data\n\n    trace = (msg, meta) ->\n      if process.env.MADUL_LOG_LEVEL > 4\n        winston.loggers.get('trace').silly msg, clone meta\n\n    debug = (msg, meta) ->\n      if process.env.MADUL_LOG_LEVEL > 3\n        winston.loggers.get('debug').debug msg, clone meta\n\n    info = (msg, meta) ->\n      if process.env.MADUL_LOG_LEVEL > 2\n        winston.loggers.get('info').info msg, clone meta\n\n    warn = (msg, meta) ->\n      if process.env.MADUL_LOG_LEVEL > 1\n        winston.loggers.get('warn').warn msg, clone meta\n\n    error = (msg, meta) ->\n      if process.env.MADUL_LOG_LEVEL > 0\n        winston.loggers.get('error').error msg, clone meta\n\n    module.exports =\n      resolved: resolved\n      rejected: rejected\n      notify:   notify\n      trace:    trace\n      debug:    debug\n      info:     info\n      warn:     warn\n      error:    error\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3133a3fb71e83fca6534bc87a633936bbfccf580","subject":"Remove leading empty new-line","message":"Remove leading empty new-line\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/helper\/cache.litcoffee","new_file":"coffee\/helper\/cache.litcoffee","new_contents":"## getFilter()\n\nGet data filter to use in caching.\n\n### Params\n\n* `string` type - object type to get filter for\n\n### Return\n\nReturns an `object` with `field` and filter status (`boolean`).\n\n    exports.getFilter = (type) ->\n      {\n        _id       : false\n        tilbyder  : true\n        endret    : true\n        checksum  : true\n        status    : true\n        navn      : true\n        omr\u00e5der   : true\n        steder    : true\n        bilder    : true\n        grupper   : true\n      }\n\n\n## filterData()\n\nFilter raw data before storing it in cache.\n\n### Params\n\n* `string` type - object type\n* `object` data - data to filter\n\n### Return\n\nReturns an `object` with correct data fields.\n\n    exports.filterData = (type, data) ->\n      ret = {}\n      ret[key] = data[key] for key, val of exports.getFilter(type) when val and data[key]\n      ret\n\n\n## arrayify()\n\nMake certain string values in data structure into arrays.\n\n### Params\n\n* `string` type - object type\n* `object` data - data to arrayify\n\n### ToDo\n\n* [] Make this not hard coded\n\n### Return\n\nReturns an `object` with correct fields as arrays.\n\n    exports.arrayify = (type, data) ->\n      data.omr\u00e5der = if data.omr\u00e5der then data.omr\u00e5der.split(',') else []\n      data.grupper = if data.grupper then data.grupper.split(',') else []\n      data.bilder  = if data.bilder  then data.bilder.split(',')  else []\n      data.steder  = if data.steder  then data.steder.split(',')  else []\n\n      return data\n\n","old_contents":"\n## getFilter()\n\nGet data filter to use in caching.\n\n### Params\n\n* `string` type - object type to get filter for\n\n### Return\n\nReturns an `object` with `field` and filter status (`boolean`).\n\n    exports.getFilter = (type) ->\n      {\n        _id       : false\n        tilbyder  : true\n        endret    : true\n        checksum  : true\n        status    : true\n        navn      : true\n        omr\u00e5der   : true\n        steder    : true\n        bilder    : true\n        grupper   : true\n      }\n\n\n## filterData()\n\nFilter raw data before storing it in cache.\n\n### Params\n\n* `string` type - object type\n* `object` data - data to filter\n\n### Return\n\nReturns an `object` with correct data fields.\n\n    exports.filterData = (type, data) ->\n      ret = {}\n      ret[key] = data[key] for key, val of exports.getFilter(type) when val and data[key]\n      ret\n\n\n## arrayify()\n\nMake certain string values in data structure into arrays.\n\n### Params\n\n* `string` type - object type\n* `object` data - data to arrayify\n\n### ToDo\n\n* [] Make this not hard coded\n\n### Return\n\nReturns an `object` with correct fields as arrays.\n\n    exports.arrayify = (type, data) ->\n      data.omr\u00e5der = if data.omr\u00e5der then data.omr\u00e5der.split(',') else []\n      data.grupper = if data.grupper then data.grupper.split(',') else []\n      data.bilder  = if data.bilder  then data.bilder.split(',')  else []\n      data.steder  = if data.steder  then data.steder.split(',')  else []\n\n      return data\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2bf88053c375ba0030702e8f6b2883ccaafcafe5","subject":"Artifacts from the express session update: remove the signedCookies hack, and always gen session for now","message":"Artifacts from the express session update: remove the signedCookies hack, and always gen session for now\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-http-express\/session.litcoffee","new_file":"packages\/shrub-http-express\/session.litcoffee","new_contents":"# Express - routes\n\n    CookieParser = require 'cookie-parser'\n    ExpressSession = require 'express-session'\n\n    express = null\n\n    config = require 'config'\n    {Middleware} = require 'middleware'\n\n    cookieParser = null\n    sessionStore = null\n    signature = null\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        label: 'Bootstrap session handling'\n        middleware: [\n\n          (next) ->\n\n            express = require 'express'\n            signature = require 'cookie-signature'\n\n            {cookie} = config.get(\n              'packageSettings:shrub-session'\n            )\n\n            cookieParser = CookieParser cookie.cryptoKey\n\n            OrmStore = require('shrub-session\/store') express\n            sessionStore = new OrmStore()\n\n            next()\n\n        ]\n\n#### Implements hook `shrubHttpMiddleware`.\n\nParse cookies and load any session.\n\n      registrar.registerHook 'shrubHttpMiddleware', (http) ->\n\n        label: 'Load session from cookie'\n        middleware: sessionMiddleware()\n\n#### Implements hook `shrubRpcRoutesAlter`.\n\n      registrar.registerHook 'shrubRpcRoutesAlter', (routes) ->\n\n        {spliceRouteMiddleware} = require 'shrub-rpc'\n\n        loadSessionMiddleware = (req, res, next) ->\n\n          req.loadSession = (done) ->\n\n            sessionMiddleware_ = new Middleware()\n            for fn in sessionMiddleware()\n              sessionMiddleware_.use fn\n\n            sessionMiddleware_.dispatch req, res, (error) ->\n              return next error if error?\n              done()\n\n          next()\n\n        loadSessionMiddleware.weight = -5000\n\n        for path, route of routes\n          route.middleware.unshift loadSessionMiddleware\n          spliceRouteMiddleware(\n            route, 'shrub-http-express\/session', sessionMiddleware()\n          )\n\n        return\n\n#### Implements hook `shrubSocketConnectionMiddleware`.\n\n      registrar.registerHook 'shrubSocketConnectionMiddleware', ->\n\n        label: 'Load session from cookie'\n        middleware: sessionMiddleware()\n\n    sessionMiddleware = ->\n\n      {cookie, key} = config.get 'packageSettings:shrub-session'\n\n      return [\n\nExpress cookie parser.\n\n        cookieParser\n\nSession reification.\n\n        ExpressSession(\n          cookie: cookie\n          key: key\n          resave: false\n          saveUninitialized: true\n          secret: cookie.cryptoKey\n          store: sessionStore\n        )\n\n      ]\n","old_contents":"# Express - routes\n\n    CookieParser = require 'cookie-parser'\n    ExpressSession = require 'express-session'\n\n    express = null\n\n    config = require 'config'\n    {Middleware} = require 'middleware'\n\n    cookieParser = null\n    sessionStore = null\n    signature = null\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        label: 'Bootstrap session handling'\n        middleware: [\n\n          (next) ->\n\n            express = require 'express'\n            signature = require 'cookie-signature'\n\n            {cookie} = config.get(\n              'packageSettings:shrub-session'\n            )\n\n            cookieParser = CookieParser cookie.cryptoKey\n\n            OrmStore = require('shrub-session\/store') express\n            sessionStore = new OrmStore()\n\n            next()\n\n        ]\n\n#### Implements hook `shrubHttpMiddleware`.\n\nParse cookies and load any session.\n\n      registrar.registerHook 'shrubHttpMiddleware', (http) ->\n\n        label: 'Load session from cookie'\n        middleware: sessionMiddleware()\n\n#### Implements hook `shrubRpcRoutesAlter`.\n\n      registrar.registerHook 'shrubRpcRoutesAlter', (routes) ->\n\n        {spliceRouteMiddleware} = require 'shrub-rpc'\n\n        loadSessionMiddleware = (req, res, next) ->\n\n          req.loadSession = (done) ->\n\n            sessionMiddleware_ = new Middleware()\n            for fn in sessionMiddleware()\n              sessionMiddleware_.use fn\n\n            sessionMiddleware_.dispatch req, res, (error) ->\n              return next error if error?\n              done()\n\n          next()\n\n        loadSessionMiddleware.weight = -5000\n\n        for path, route of routes\n          route.middleware.unshift loadSessionMiddleware\n          spliceRouteMiddleware(\n            route, 'shrub-http-express\/session', sessionMiddleware()\n          )\n\n        return\n\n#### Implements hook `shrubSocketConnectionMiddleware`.\n\n      registrar.registerHook 'shrubSocketConnectionMiddleware', ->\n\n        label: 'Load session from cookie'\n        middleware: sessionMiddleware()\n\n    sessionMiddleware = ->\n\n      {cookie, key} = config.get 'packageSettings:shrub-session'\n\n      return [\n\nExpress cookie parser.\n\n        cookieParser\n\nSession reification.\n\n        ExpressSession(\n          cookie: cookie\n          key: key\n          resave: false\n          saveUninitialized: false\n          secret: cookie.cryptoKey\n          store: sessionStore\n        )\n\nIf this is the first request made by a client, the cookie won't exist in\nreq.headers.cookie. We normalize that inconsistency, so all consumers of the\ncookie will have a consistent interface on the first as well as subsequent\nrequests.\n\n        (req, res, next) ->\n\nIf the client is already in sync, awesome!\n\n          return next() if req.signedCookies[key] is req.sessionID\n\nGenerate the cookie\n\n          val = 's:' + signature.sign req.sessionID, cookie.cryptoKey\n          cookieText = req.session.cookie.serialize key, val\n\nCommit the session before offering the cookie, otherwise it wouldn't actually\nbe pointing at anything yet.\n\n          req.session.save (error) ->\n            next error if error?\n\n            req.signedCookies[key] = req.sessionID\n            req.headers.cookie = cookieText\n            next()\n\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"633f3c26769039bb553b588ae28988be82f889c0","subject":"Extended Box with isVisible predicate","message":"Extended Box with isVisible predicate\n\nSigned-off-by: Diwank Singh <a78369447041e6bcf2913d083e4ed301785fc609@gmail.com>\n","repos":"creatorrr\/browser-bricks","old_file":"bricks.litcoffee","new_file":"bricks.litcoffee","new_contents":"Re: [Letter to a Source-Code-Reader](http:\/\/stewd.io\/pong\/lib\/pong.js)\n\nDear Stewart\n\nThanks for inspiring me and many like me with the wonders of js.\nWith all it's warts and issues, JS is still one of my favorite languages.\nI think simply by it's virtue of being the language of the web, it surpasses most others\nin it's ability to champion the spirit of openness.\n\nI have tried to keep this as simple as possible for the many awesome source code lovers\nto read, reuse and critique.\n\nThanks again for caring to write that letter in 2009. It made a kid smile.\n\nDiwank Singh\nJuly 2013\n\n*****\n\nBrowser Bricks\n==============\n\nAlright, let's get on with it.\n\nHelper Functions\n----------------\n\nFirst, let's define some helper functions for the application.\n\n    _ =   # _ namespace\n      # Extend objects\n      extend: (dest, src) ->\n        dest[k] = v for own k, v of src\n        dest\n\n      # Pick properties\n      pick: (obj, props) ->\n        result = {}\n        result[k] = obj[k] for k in props when obj[k]?\n\n        result\n\n      # UUID function (Copied shamelessly from https:\/\/gist.github.com\/bmc\/1893440)\n      uuid: ->\n        'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(\/[xy]\/g, (c) ->\n          r = Math.random() * 16 | 0\n          v = if c is 'x' then r else (r & 0x3|0x8)\n          v.toString(16)\n        )\n\n      # Simple serializer for flat objects\n      serialize: (obj, {sep, eq}, cb) ->\n        # Exec callback on all values of obj\n        obj[k] = cb v for own k, v of obj if cb?\n\n        # Return serialized obj\n        (\"#{ k }#{ eq }#{ v }\" for own k, v of obj).join sep\n\n      # Defer execution of function\n      defer: (fn, args...) -> window.setTimeout fn, 1, args...\n\n      # Clone object\n      clone: (obj) ->\n        # If object extend\n        if obj is Object obj\n          _.extend {}, obj\n\n        else  # Assume it's array otherwise\n          obj.splice 0\n\nInit Function\n-------------\n\nLet's write a global init function that can be used to register callbacks which are\nexecuted 'onload'.\n\n    # Callback register\n    init = do ->\n      # Store registered callbacks\n      callbacks = []\n\n      # Run callbacks in order registered\n      exec = -> fn?() for fn in callbacks\n\n      # Onload callback\n      onLoad = (fn) ->\n        window.removeEventListener 'load', init, false\n        fn?()\n\n      (cb) ->\n        if cb?\n          # Register callback\n          callbacks.push cb\n        else\n          # Defer execution until stack cleared\n          onLoad -> _.defer exec\n\n        false\n\n    # Attach DOM load listener\n    window.addEventListener 'load', init, false\n\nClass: Box\n----------\n\nNow, let's define a box that will be the basic building block for the game.\nAll the objects will inherit from this class.\n\n    class Box\n      # -- Private --\n\n      _settings:\n        # Default settings\n        height: 100\n        width:  200\n        top:    0\n        left:   0\n\n      _props:\n        # Fixed window props\n        toolbar:     false\n        directories: false\n        fullscreen:  false\n        location:    false\n        menubar:     false\n        resizable:   false\n        scrollbars:  false\n        status:      false\n\n      _window: null  # Empty window object\n      _url: '\/index.html' # Fixed to current page, renders based on context\n\n      _EDITABLE: -> Object.keys @constructor::_settings   # Editable settings\n\n      _update: (settings) ->\n        # Update settings\n        _.extend @_settings, (_.pick settings, @_EDITABLE())\n\n        # Adjust window props\n        @_window?.moveTo?   (@_get 'left'), (@_get 'top')\n        @_window?.resizeTo? (@_get 'width'), (@_get 'height')\n\n        # Return a copy of settings\n        @_getAll()\n\n      _get: (prop) -> @_settings[prop] if prop in @_EDITABLE()\n      _getAll: -> _.extend (_.clone @_settings), @_fixed\n\n      _getDefault: -> @constructor::_settings\n\n      # -- Public --\n\n      constructor: (namespace='', settings) ->\n        # Make a copy of default settings\n        @_settings = _.clone @_settings\n\n        # Override settings.\n        @_update settings\n\n        # Set random name with namespace\n        @id = \"#{ namespace }#{ if namespace then '-' else '' }#{ _.uuid() }\"\n        this\n\n      # Show window with settings.\n      show: ->\n        # Serialize options\n        opts = _.serialize @_getAll(), {sep: ',', eq: '='}, (v) ->\n          switch v\n            when false then 'no'\n            when true then 'yes'\n            else v+''\n\n        @_window = window.open @_url, @id, opts\n        this\n\n      # Hide the window.\n      hide: ->\n        @_window.close()\n        @_window = null\n        this\n\n      # Check if window is visible.\n      isVisible: -> @_window?.location?\n\n      # Reset window settings.\n      reset: ->\n        @_update @_getDefault()\n        this\n\n      # Return or update window position coords.\n      position: (coords...) ->\n        # Set new coords\n        if coords.length then @_update\n          left: coords[0] ? @_getDefault().left  # x\n          top:  coords[1] ? @_getDefault().top   # y\n\n        # Return coords\n        _.pick @_getAll(), ['top', 'left']\n\n      # Return or update window dimensions.\n      size: (dimensions...) ->\n        # Set new dimensions\n        if dimensions.length then @_update\n          width:  dimensions[0] ? @_getDefault().width\n          height: dimensions[1] ? @_getDefault().height\n\n        # Return dimensions\n        _.pick @_getAll(), ['width', 'height']\n\nClass: Brick (Box)\n------------------\n\nNow let's use the class `Box` to design the `Brick` class which\nwill be used to render the bricks.\n\nIt's pretty much a useless box.\n\n    class Brick extends Box\n      constructor: (args...) -> super @type(), args...\n      type: -> 'brick'\n\nClass: Ball (Box)\n-----------------\n\nAlright, so the ball is a little tricky. It has to move two-\ndimensionally and bounce off of objects.\n\nSo, we need an instance that also stores it's velocity at any\ninstant and the methods to manipulate it.\n\n    class Ball extends Box\n      # -- Private --\n      _velocity: [0, 0]\n\n      # Override getDefault to get default velocity\n      _getDefault: -> _.extend super(), velocity: _.clone @_velocity\n\n      # -- Public --\n      constructor: (args...) ->\n        @_velocity = _.clone @_velocity\n        super @type(), args...\n\n      type: -> 'ball'\n\n      # Set or retrieve velocity\n      velocity: (vel...) ->\n        # Set new velocity\n        if vel.length then @_velocity = [\n          vel[0] ? @_getDefault().velocity[0]         # vx\n\n          # y velocity affects distance from top so inverted to preserve\n          # upward positive velocity direction.\n          (vel[1] ? @_getDefault().velocity[1]) * -1  # vy\n        ]\n\n        # Return velocity\n        _.clone @_velocity\n\nClass: Paddle (Ball)\n--------------------\n\nA paddle is basically an enlarged ball that's constrained to move in a\nstraight line.\n\n    class Paddle extends Ball\n      type: -> 'paddle'\n\n      # Override velocity to constrain 1D motion\n      velocity: (vx) ->\n        if vx?\n          super vx, @_velocity[1]\n        else\n          super()\n\nExports\n-------\n\nList of vars exported to global namespace.\n\n    _.extend window ? module.exports ? this,\n      _: _\n      init: init\n      Box: Box\n      Brick: Brick\n      Ball: Ball\n      Paddle: Paddle\n","old_contents":"Re: [Letter to a Source-Code-Reader](http:\/\/stewd.io\/pong\/lib\/pong.js)\n\nDear Stewart\n\nThanks for inspiring me and many like me with the wonders of js.\nWith all it's warts and issues, JS is still one of my favorite languages.\nI think simply by it's virtue of being the language of the web, it surpasses most others\nin it's ability to champion the spirit of openness.\n\nI have tried to keep this as simple as possible for the many awesome source code lovers\nto read, reuse and critique.\n\nThanks again for caring to write that letter in 2009. It made a kid smile.\n\nDiwank Singh\nJuly 2013\n\n*****\n\nBrowser Bricks\n==============\n\nAlright, let's get on with it.\n\nHelper Functions\n----------------\n\nFirst, let's define some helper functions for the application.\n\n    _ =   # _ namespace\n      # Extend objects\n      extend: (dest, src) ->\n        dest[k] = v for own k, v of src\n        dest\n\n      # Pick properties\n      pick: (obj, props) ->\n        result = {}\n        result[k] = obj[k] for k in props when obj[k]?\n\n        result\n\n      # UUID function (Copied shamelessly from https:\/\/gist.github.com\/bmc\/1893440)\n      uuid: ->\n        'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(\/[xy]\/g, (c) ->\n          r = Math.random() * 16 | 0\n          v = if c is 'x' then r else (r & 0x3|0x8)\n          v.toString(16)\n        )\n\n      # Simple serializer for flat objects\n      serialize: (obj, {sep, eq}, cb) ->\n        # Exec callback on all values of obj\n        obj[k] = cb v for own k, v of obj if cb?\n\n        # Return serialized obj\n        (\"#{ k }#{ eq }#{ v }\" for own k, v of obj).join sep\n\n      # Defer execution of function\n      defer: (fn, args...) -> window.setTimeout fn, 1, args...\n\n      # Clone object\n      clone: (obj) ->\n        # If object extend\n        if obj is Object obj\n          _.extend {}, obj\n\n        else  # Assume it's array otherwise\n          obj.splice 0\n\nInit Function\n-------------\n\nLet's write a global init function that can be used to register callbacks which are\nexecuted 'onload'.\n\n    # Callback register\n    init = do ->\n      # Store registered callbacks\n      callbacks = []\n\n      # Run callbacks in order registered\n      exec = -> fn?() for fn in callbacks\n\n      # Onload callback\n      onLoad = (fn) ->\n        window.removeEventListener 'load', init, false\n        fn?()\n\n      (cb) ->\n        if cb?\n          # Register callback\n          callbacks.push cb\n        else\n          # Defer execution until stack cleared\n          onLoad -> _.defer exec\n\n        false\n\n    # Attach DOM load listener\n    window.addEventListener 'load', init, false\n\nClass: Box\n----------\n\nNow, let's define a box that will be the basic building block for the game.\nAll the objects will inherit from this class.\n\n    class Box\n      # -- Private --\n\n      _settings:\n        # Default settings\n        height: 100\n        width:  200\n        top:    0\n        left:   0\n\n      _props:\n        # Fixed window props\n        toolbar:     false\n        directories: false\n        fullscreen:  false\n        location:    false\n        menubar:     false\n        resizable:   false\n        scrollbars:  false\n        status:      false\n\n      _window: null  # Empty window object\n      _url: '\/index.html' # Fixed to current page, renders based on context\n\n      _EDITABLE: -> Object.keys @constructor::_settings   # Editable settings\n\n      _update: (settings) ->\n        # Update settings\n        _.extend @_settings, (_.pick settings, @_EDITABLE())\n\n        # Adjust window props\n        @_window?.moveTo?   (@_get 'left'), (@_get 'top')\n        @_window?.resizeTo? (@_get 'width'), (@_get 'height')\n\n        # Return a copy of settings\n        @_getAll()\n\n      _get: (prop) -> @_settings[prop] if prop in @_EDITABLE()\n      _getAll: -> _.extend (_.clone @_settings), @_fixed\n\n      _getDefault: -> @constructor::_settings\n\n      # -- Public --\n\n      constructor: (namespace='', settings) ->\n        # Make a copy of default settings\n        @_settings = _.clone @_settings\n\n        # Override settings.\n        @_update settings\n\n        # Set random name with namespace\n        @id = \"#{ namespace }#{ if namespace then '-' else '' }#{ _.uuid() }\"\n        this\n\n      # Show window with settings.\n      show: ->\n        # Serialize options\n        opts = _.serialize @_getAll(), {sep: ',', eq: '='}, (v) ->\n          switch v\n            when false then 'no'\n            when true then 'yes'\n            else v+''\n\n        @_window = window.open @_url, @id, opts\n        this\n\n      # Hide the window.\n      hide: ->\n        @_window.close()\n        @_window = null\n        this\n\n      # Reset window settings.\n      reset: ->\n        @_update @_getDefault()\n        this\n\n      # Return or update window position coords.\n      position: (coords...) ->\n        # Set new coords\n        if coords.length then @_update\n          left: coords[0] ? @_getDefault().left  # x\n          top:  coords[1] ? @_getDefault().top   # y\n\n        # Return coords\n        _.pick @_getAll(), ['top', 'left']\n\n      # Return or update window dimensions.\n      size: (dimensions...) ->\n        # Set new dimensions\n        if dimensions.length then @_update\n          width:  dimensions[0] ? @_getDefault().width\n          height: dimensions[1] ? @_getDefault().height\n\n        # Return dimensions\n        _.pick @_getAll(), ['width', 'height']\n\nClass: Brick (Box)\n------------------\n\nNow let's use the class `Box` to design the `Brick` class which\nwill be used to render the bricks.\n\nIt's pretty much a useless box.\n\n    class Brick extends Box\n      constructor: (args...) -> super @type(), args...\n      type: -> 'brick'\n\nClass: Ball (Box)\n-----------------\n\nAlright, so the ball is a little tricky. It has to move two-\ndimensionally and bounce off of objects.\n\nSo, we need an instance that also stores it's velocity at any\ninstant and the methods to manipulate it.\n\n    class Ball extends Box\n      # -- Private --\n      _velocity: [0, 0]\n\n      # Override getDefault to get default velocity\n      _getDefault: -> _.extend super(), velocity: _.clone @_velocity\n\n      # -- Public --\n      constructor: (args...) ->\n        @_velocity = _.clone @_velocity\n        super @type(), args...\n\n      type: -> 'ball'\n\n      # Set or retrieve velocity\n      velocity: (vel...) ->\n        # Set new velocity\n        if vel.length then @_velocity = [\n          vel[0] ? @_getDefault().velocity[0]         # vx\n\n          # y velocity affects distance from top so inverted to preserve\n          # upward positive velocity direction.\n          (vel[1] ? @_getDefault().velocity[1]) * -1  # vy\n        ]\n\n        # Return velocity\n        _.clone @_velocity\n\nClass: Paddle (Ball)\n--------------------\n\nA paddle is basically an enlarged ball that's constrained to move in a\nstraight line.\n\n    class Paddle extends Ball\n      type: -> 'paddle'\n\n      # Override velocity to constrain 1D motion\n      velocity: (vx) ->\n        if vx?\n          super vx, @_velocity[1]\n        else\n          super()\n\nExports\n-------\n\nList of vars exported to global namespace.\n\n    _.extend window ? module.exports ? this,\n      _: _\n      init: init\n      Box: Box\n      Brick: Brick\n      Ball: Ball\n      Paddle: Paddle\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e2fafc6773d78b0455670c9b6cc4518fe3eb8cdf","subject":"Fix test loop bug","message":"Fix test loop bug\n","repos":"hzdg\/urllite.js","old_file":"test\/tests.litcoffee","new_file":"test\/tests.litcoffee","new_contents":"    {assert} = require 'chai'\n    _ = require 'underscore'\n\nUse the global urllite\n\n    urllite = window.urllite\n\nA list of the URL properties we want to verify.\n\n    urlUtilsProps = [\n      'protocol'\n      'username'\n      'password'\n      'host'\n      'hostname'\n      'port'\n      'pathname'\n      'search'\n      'hash'\n      'origin'\n    ]\n\nA list of URLs to check.\n\n    urls = require '.\/urls.json'\n\nCreate an HTML element. We'll use its [decomposed IDL attributes][idl-attributes]\nas the canonical parse result to check against.\n\n    a = document.createElement 'a'\n\n\n    assertParsedEqual = (actual, expected) ->\n      assert.deepEqual _.pick(actual, urlUtilsProps...), _.pick(expected, urlUtilsProps...)\n\n\n    testParsing = (url) ->\n      a.href = url\n      assertParsedEqual urllite(url), a\n\n\n    describe 'urllite', ->\n      for url in urls\n        do (url) ->\n          it \"should correctly parse #{ url }\", -> testParsing url\n\n\n[idl-attributes]: http:\/\/www.whatwg.org\/specs\/web-apps\/current-work\/multipage\/urls.html#url-decomposition-idl-attributes\n","old_contents":"    {assert} = require 'chai'\n    _ = require 'underscore'\n\nUse the global urllite\n\n    urllite = window.urllite\n\nA list of the URL properties we want to verify.\n\n    urlUtilsProps = [\n      'protocol'\n      'username'\n      'password'\n      'host'\n      'hostname'\n      'port'\n      'pathname'\n      'search'\n      'hash'\n      'origin'\n    ]\n\nA list of URLs to check.\n\n    urls = require '.\/urls.json'\n\nCreate an HTML element. We'll use its [decomposed IDL attributes][idl-attributes]\nas the canonical parse result to check against.\n\n    a = document.createElement 'a'\n\n\n    assertParsedEqual = (actual, expected) ->\n      assert.deepEqual _.pick(actual, urlUtilsProps...), _.pick(expected, urlUtilsProps...)\n\n\n    testParsing = (url) ->\n      a.href = url\n      assertParsedEqual urllite(url), a\n\n\n    describe 'urllite', ->\n      for url in urls\n        it \"should correctly parse #{ url }\", -> testParsing url\n\n\n[idl-attributes]: http:\/\/www.whatwg.org\/specs\/web-apps\/current-work\/multipage\/urls.html#url-decomposition-idl-attributes\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8e065fc2eed156bf83a1cdd73759d3cb7862cd18","subject":"Show and hide the placeholders in the container manager","message":"Show and hide the placeholders in the container manager\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/managers\/container.litcoffee","new_file":"src\/coffee\/managers\/container.litcoffee","new_contents":"Container Manager\n=================\n\nThis manager defines the visibility of the individual display\ncontainers. It is driven chiefly by the display selector.\n\nLike all managers, it is run on a jQuery callback so that it executes\nafter the DOM has already been loaded.\n\n    $ ->\n\nWe bind the selected display's equivalence to the string 'default'\nfor the visibility of the default container.\n\n        SelectedDisplay.map( (x) -> x is 'default' )\n                       .assign $('#default'), 'toggle'\n\nIt is left as an exercise to the reader to guess how the rest of these go...\n\n        SelectedDisplay.map( (x) -> x is 'no-entry' )\n                       .assign $('#no-entry'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'kill-origin' )\n                       .assign $('#kill-origin'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'match-display' )\n                       .assign $('#match-display'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'match-sched' )\n                       .assign $('#match-sched'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'league-state' )\n                       .assign $('#league-state'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'knockout-state' )\n                       .assign $('#knockout-state'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'next-match' )\n                       .assign $('#next-match'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'day-sched' )\n                       .assign $('#day-sched'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'zone' )\n                       .assign $('#zone'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'layout' )\n                       .assign $('#layout'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'arena-entrance' )\n                       .assign $('#arena-entrance'), 'toggle'\n\n","old_contents":"Container Manager\n=================\n\nThis manager defines the visibility of the individual display\ncontainers. It is driven chiefly by the display selector.\n\nLike all managers, it is run on a jQuery callback so that it executes\nafter the DOM has already been loaded.\n\n    $ ->\n\nWe bind the selected display's equivalence to the string 'default'\nfor the visibility of the default container.\n\n        SelectedDisplay.map( (x) -> x is 'default' )\n                       .assign $('#default'), 'toggle'\n\nIt is left as an exercise to the reader to guess how the rest of these go...\n\n        SelectedDisplay.map( (x) -> x is 'no-entry' )\n                       .assign $('#no-entry'), 'toggle'\n        SelectedDisplay.map( (x) -> x is 'kill-origin' )\n                       .assign $('#kill-origin'), 'toggle'\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4c78aa5a6054c8285779a56ccb962334320fc3bf","subject":"Use subject title in measurement instead of subject-source-id.","message":"Use subject title in measurement instead of subject-source-id.\n","repos":"fniessink\/checksome,mxipartners\/checksome","old_file":"server\/sonar.litcoffee","new_file":"server\/sonar.litcoffee","new_contents":"This job collects data from Sonar for the Sonar keys in the `SubjectSourceIds`\ncollection.\n\n    class @SonarJob extends Job\n      @setupCron: (parser) ->\n        parser.recur().every(1).minute()\n\n      handleJob: ->\n        for subject_source_id in SubjectSourceIds.find().fetch()\n          source = Sources.findOne({_id: subject_source_id.source})\n          if source.type != 'sonar'\n            continue\n          subject = Subjects.findOne({_id: subject_source_id.subject})\n          title = \"NCLOC \" + subject.title\n          sonar_key = subject_source_id.title\n          try\n            result = HTTP.get source.url + 'api\/resources?resource=' + sonar_key + '&metrics=true'\n            error_message = ''\n          catch e\n            error_message = e.message\n          if result\n            json = result.data\n            for metric in json[0]['msr']\n              if metric['key'] == 'ncloc'\n                ncloc = metric['val']\n          else\n            ncloc = -1\n          if error_message != ''\n            description = error_message\n          else\n            description = ncloc + ' LOC'\n          insertMeasurement\n            projectId: source.projectId\n            title: title\n            description: description\n          console.log(title, description, sonar_key, source.type, source.url, ncloc)\n\n    Job.push new SonarJob\n","old_contents":"This job collects data from Sonar for the Sonar keys in the `SubjectSourceIds`\ncollection.\n\n    class @SonarJob extends Job\n      @setupCron: (parser) ->\n        parser.recur().every(1).minute()\n\n      handleJob: ->\n        for subject_source_id in SubjectSourceIds.find().fetch()\n          source_id = subject_source_id.source\n          source = Sources.findOne({_id: source_id})\n          if source.type != 'sonar'\n            continue\n          sonar_key = subject_source_id.title\n          title = \"NCLOC \" + sonar_key\n          try\n            result = HTTP.get source.url + 'api\/resources?resource=' + sonar_key + '&metrics=true'\n            error_message = ''\n          catch e\n            error_message = e.message\n          if result\n            json = result.data\n            for metric in json[0]['msr']\n              if metric['key'] == 'ncloc'\n                ncloc = metric['val']\n          else\n            ncloc = -1\n          if error_message != ''\n            description = error_message\n          else\n            description = ncloc + ' LOC'\n          insertMeasurement\n            projectId: source.projectId\n            title: title\n            description: description\n          console.log(title, description, source.type, source.url, ncloc)\n\n    Job.push new SonarJob\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"09c3e2beaa922c44566f9243d9011c26c485be7e","subject":"Tweaks for docco gen","message":"Tweaks for docco gen\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n                        find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return s\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        s = F.unify(_.first(t1), _.first(t2), bindings)\n        s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2),   bindings) else s\n        return s\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logic programs\n# --------------\n\nWe can build more complex goals using lambda-abstractions and previously defined combinators, `conj` and `disj`.  For example, we can define the function `choice` such that `choice(t1, array)` is a goal that succeeds if `t1` is an element of `array`.\n\n    F.choice = ($v, list) ->\n      return F.fail if _.isEmpty(list)\n\n      F.disj(F.goal($v, _.first(list)),\n                    F.choice($v, _.rest(list)))\n\nThe name `choice` should evoke [The Axiom of Choice](http:\/\/en.wikipedia.org\/wiki\/Axiom_of_choice)...\n\n# Exports and sundries\n# --------------------\n\n\t  if module?\n\t    module.exports = F\n\t  else\n\t    root.F = F\n\n\t)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n  \t\t              find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return s\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        s = F.unify(_.first(t1), _.first(t2), bindings)\n        s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2),   bindings) else s\n        return s\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logic programs\n# --------------\n\nWe can build more complex goals using lambda-abstractions and previously defined combinators, `conj` and `disj`.  For example, we can define the function `choice` such that `choice(t1, array)` is a goal that succeeds if `t1` is an element of `array`.\n\n    F.choice = ($v, list) ->\n      return F.fail if _.isEmpty(list)\n\n      F.disj(F.goal($v, _.first(list)),\n                    F.choice($v, _.rest(list)))\n\nThe name `choice` should evoke [The Axiom of Choice](http:\/\/en.wikipedia.org\/wiki\/Axiom_of_choice)...\n\n# Exports and sundries\n# --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2d2ac9975507946ebc2834a2573e54873e505df3","subject":"Dynamic directive definition API","message":"Dynamic directive definition API\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"client\/packages.litcoffee","new_file":"client\/packages.litcoffee","new_contents":"\n# Package management for Angular\n\n*This is where shrub's package system meets Angular's module system. Packages'\nimplementations of controllers, services, filters, providers, and directives\nare gathered and registered into Angular.*\n\n    angular.module('shrub.packages', [\n      'shrub.directive'\n      'shrub.require'\n      'shrub.pkgman'\n    ])\n\n      .config([\n        '$compileProvider', '$controllerProvider', '$filterProvider'\n        '$injector', '$provide', 'shrub-directiveProvider'\n        'shrub-pkgmanProvider', 'shrub-requireProvider'\n        (\n          $compileProvider, $controllerProvider, $filterProvider\n          $injector, $provide, directive, pkgman, {require}\n        ) ->\n\n          config = require 'config'\n          debug = require('debug') 'shrub:angular'\n\n#### Invoke hook `shrubAngularController`.\n\n          debug 'Registering controllers...'\n\n          for path, injected of pkgman.invoke 'shrubAngularController'\n            controllerName = pkgman.normalizePath path\n            debug controllerName\n            $controllerProvider.register controllerName, injected\n\n          debug 'Controllers registered.'\n\n          debug 'Registering directives...'\n\n#### Invoke hook `shrubAngularDirective`.\n\n          for path, injected of pkgman.invoke 'shrubAngularDirective'\n            directive.define path, injected\n\n          debug 'Directives registered.'\n\n          debug 'Registering filters...'\n\n#### Invoke hook `shrubAngularFilter`.\n\n          for path, injected of pkgman.invoke 'shrubAngularFilter'\n            filterName = pkgman.normalizePath path\n            debug filterName\n            $filterProvider.register filterName, injected\n\n          debug 'Filters registered.'\n\n#### Invoke hook `shrubAngularProvider`.\n\n          debug 'Registering providers...'\n\n          for path, provider of pkgman.invoke 'shrubAngularProvider'\n            debug path\n            $provide.provider path, provider\n\n          debug 'Providers registered.'\n\n#### Invoke hook `shrubAngularService`.\n\n          debug 'Registering services...'\n\n          for path, injected of pkgman.invoke 'shrubAngularService'\n            debug path\n            $provide.service path, injected\n\n          debug 'Services registered.'\n\n      ])\n\n      .run([\n        '$injector', 'shrub-require'\n        ($injector, require) ->\n\nSet an injector so that Angular injection can occur out of band.\n\n          angular_ = require 'angular'\n          angular_.setInjector $injector\n\n      ])\n\nProvide Shrub's directive definition API.\n\n    angular.module('shrub.directive', [\n      'shrub.pkgman'\n      'shrub.require'\n    ])\n\n      .provider 'shrub-directive', [\n        '$compileProvider', '$injector', '$provide', 'shrub-pkgmanProvider'\n        'shrub-requireProvider'\n        ($compileProvider, $injector, $provide, pkgman, {require}) ->\n\n          debug = require('debug') 'shrub:angular'\n\nNormalize, augment, and register a directive.\n\n          prepareDirective = (name, path, injected) -> ($injector) ->\n\nNormalize the directive to Directive Definition Object form.\n\n            directive = $injector.invoke injected\n            directive = link: directive if angular.isFunction directive\n\nEnsure a compilation function exists for the directive which by default\nreturns the `link` function.\n\n            directive.compile ?= -> directive.link\n\nProxy any defined link function, firing any attached any controllers' `link`\nmethod, as well as passing execution on to the original `link` function.\n\n            link = directive.link\n            directive.link = (scope, element, attrs, controllers) ->\n              if controllers?\n                controllers = [controllers] unless angular.isArray controllers\n                controller.link? arguments... for controller in controllers\n\n              link? arguments...\n\nEnsure the directive has a name. Defaults to the normalized path of the\nimplementing package.\n\n            directive.name ?= name\n\nIf controller binding is specified, the controller defaults to the directive\nname. In other words, if you define a directive and a controller in the same\npackage, and specify `directive.bindToController = true`, your directive will\ninclude the controller automatically.\n\n            if directive.bindToController\n              directive.controller ?= directive.name\n\nHandle a bunch of internal Angular normalization.\n\n            directive.require ?= directive.controller and directive.name\n            directive.priority ?= 0\n            directive.restrict ?= 'EA'\n\n            if angular.isObject directive.scope\n              directive.$$isolateBindings = isolateBindingsFor directive\n\n#### Invoke hook `shrubAngularDirectiveAlter`.\n\n            for injectedDirective in pkgman.invokeFlat(\n              'shrubAngularDirectiveAlter', directive, path\n            )\n              $injector.invoke injectedDirective\n\nHaven't gone deep enough into Angular to understand why this has to be, but it\ndoes.\n\n            directive.index = 0\n            return [directive]\n\nInternal Angular state that we have to reset.\n\n          isolateBindingsFor = (directive) ->\n\n            LOCAL_REGEXP = \/^\\s*([@&]|=(\\*?))(\\??)\\s*(\\w*)\\s*$\/\n\n            bindings = {}\n\n            for scopeName, definition of directive.scope\n              match = definition.match LOCAL_REGEXP\n\n              throw angular.$$minErr('$compile')(\n                'iscp'\n                \"\n                  Invalid isolate scope definition for directive '{0}'.\n                  Definition: {... {1}: '{2}' ...}\n                \"\n                directive.name, scopeName, definition\n              ) unless match\n\n              bindings[scopeName] =\n                mode: match[1][0]\n                collection: match[2] is '*'\n                optional: match[3] is '?'\n                attrName: match[4] or scopeName\n\n            return bindings\n\n          directive = {}\n\n          directive.define = (path, injected) ->\n            directiveName = pkgman.normalizePath path\n            debug directiveName\n\nFirst, register it through Angular's normal registration mechanism. This sets\na bunch of internal state we don't have access to.\n\n            $compileProvider.directive directiveName, injected\n\nFollow that by normalizing, augmenting, and registering the directive again.\nIt will run over the previous definition, ensuring everything works nicely.\n\n            $provide.factory \"#{directiveName}Directive\", [\n              '$injector', prepareDirective directiveName, path, injected\n            ]\n\n          directive.$get = -> directive\n\n          return directive\n\n      ]\n\nProvide Angular with access to Shrub's package manager.\n\n    angular.module('shrub.pkgman', [\n      'shrub.require'\n    ])\n\n      .provider 'shrub-pkgman', [\n        '$provide', 'shrub-requireProvider'\n        ($provide, {require}) ->\n\n          config = require 'config'\n          debug = require('debug') 'shrub:pkgman'\n          pkgman = require 'pkgman'\n\n          debug 'Loading packages...'\n\nLoad the package list from configuration.\n\n          pkgman.registerPackageList config.get 'packageList'\n\n          debug 'Packages loaded.'\n\nSimply pass along pkgman as the 'service'.\n\n          pkgman.$get = -> pkgman\n\n          return pkgman\n      ]\n","old_contents":"\n# Package management for Angular\n\n*This is where shrub's package system meets Angular's module system. Packages'\nimplementations of controllers, services, filters, providers, and directives\nare gathered and registered into Angular.*\n\n    angular.module('shrub.packages', [\n      'shrub.require'\n      'shrub.pkgman'\n    ])\n\n      .config([\n        '$compileProvider', '$controllerProvider', '$filterProvider'\n        '$injector', '$provide', 'shrub-pkgmanProvider'\n        'shrub-requireProvider'\n        (\n          $compileProvider, $controllerProvider, $filterProvider\n          $injector, $provide, pkgman, {require}\n        ) ->\n\n          config = require 'config'\n          debug = require('debug') 'shrub:angular'\n\n#### Invoke hook `shrubAngularController`.\n\n          debug 'Registering controllers...'\n\n          for path, injected of pkgman.invoke 'shrubAngularController'\n            controllerName = pkgman.normalizePath path\n            debug controllerName\n            $controllerProvider.register controllerName, injected\n\n          debug 'Controllers registered.'\n\n          debug 'Registering directives...'\n\nNormalize, augment, and register a directive.\n\n          prepareDirective = (name, path, injected) -> ($injector) ->\n\nNormalize the directive to Directive Definition Object form.\n\n            directive = $injector.invoke injected\n            directive = link: directive if angular.isFunction directive\n\nEnsure a compilation function exists for the directive which by default\nreturns the `link` function.\n\n            directive.compile ?= -> directive.link\n\nProxy any defined link function, firing any attached any controllers' `link`\nmethod, as well as passing execution on to the original `link` function.\n\n            link = directive.link\n            directive.link = (scope, element, attrs, controllers) ->\n              if controllers?\n                controllers = [controllers] unless angular.isArray controllers\n                controller.link? arguments... for controller in controllers\n\n              link? arguments...\n\nEnsure the directive has a name. Defaults to the normalized path of the\nimplementing package.\n\n            directive.name ?= name\n\nIf controller binding is specified, the controller defaults to the directive\nname. In other words, if you define a directive and a controller in the same\npackage, and specify `directive.bindToController = true`, your directive will\ninclude the controller automatically.\n\n            if directive.bindToController\n              directive.controller ?= directive.name\n\nHandle a bunch of internal Angular normalization.\n\n            directive.require ?= directive.controller and directive.name\n            directive.priority ?= 0\n            directive.restrict ?= 'EA'\n\n            if angular.isObject directive.scope\n              directive.$$isolateBindings = isolateBindingsFor directive\n\n#### Invoke hook `shrubAngularDirectiveAlter`.\n\n            for injectedDirective in pkgman.invokeFlat(\n              'shrubAngularDirectiveAlter', directive, path\n            )\n              $injector.invoke injectedDirective\n\nHaven't gone deep enough into Angular to understand why this has to be, but it\ndoes.\n\n            directive.index = 0\n            return [directive]\n\nInternal Angular state that we have to reset.\n\n          isolateBindingsFor = (directive) ->\n\n            LOCAL_REGEXP = \/^\\s*([@&]|=(\\*?))(\\??)\\s*(\\w*)\\s*$\/\n\n            bindings = {}\n\n            for scopeName, definition of directive.scope\n              match = definition.match LOCAL_REGEXP\n\n              throw angular.$$minErr('$compile')(\n                'iscp'\n                \"\n                  Invalid isolate scope definition for directive '{0}'.\n                  Definition: {... {1}: '{2}' ...}\n                \"\n                directive.name, scopeName, definition\n              ) unless match\n\n              bindings[scopeName] =\n                mode: match[1][0]\n                collection: match[2] is '*'\n                optional: match[3] is '?'\n                attrName: match[4] or scopeName\n\n            return bindings\n\n#### Invoke hook `shrubAngularDirective`.\n\n          for path, injected of pkgman.invoke 'shrubAngularDirective'\n            do (path, injected) ->\n              directiveName = pkgman.normalizePath path\n              debug directiveName\n\nFirst, register it through Angular's normal registration mechanism. This sets\na bunch of internal state we don't have access to.\n\n              $compileProvider.directive directiveName, injected\n\nFollow that by normalizing, augmenting, and registering the directive again.\nIt will run over the previous definition, ensuring everything works nicely.\n\n              $provide.factory \"#{directiveName}Directive\", [\n                '$injector', prepareDirective directiveName, path, injected\n              ]\n\n          debug 'Directives registered.'\n\n          debug 'Registering filters...'\n\n#### Invoke hook `shrubAngularFilter`.\n\n          for path, injected of pkgman.invoke 'shrubAngularFilter'\n            filterName = pkgman.normalizePath path\n            debug filterName\n            $filterProvider.register filterName, injected\n\n          debug 'Filters registered.'\n\n#### Invoke hook `shrubAngularProvider`.\n\n          debug 'Registering providers...'\n\n          for path, provider of pkgman.invoke 'shrubAngularProvider'\n            debug path\n            $provide.provider path, provider\n\n          debug 'Providers registered.'\n\n#### Invoke hook `shrubAngularService`.\n\n          debug 'Registering services...'\n\n          for path, injected of pkgman.invoke 'shrubAngularService'\n            debug path\n            $provide.service path, injected\n\n          debug 'Services registered.'\n\n      ])\n\n      .run([\n        '$injector', 'shrub-require'\n        ($injector, require) ->\n\nSet an injector so that Angular injection can occur out of band.\n\n          angular_ = require 'angular'\n          angular_.setInjector $injector\n\n      ])\n\nThe module that provides Angular with access to Shrub's package manager.\n\n    angular.module('shrub.pkgman', [\n      'shrub.require'\n    ])\n\n      .provider 'shrub-pkgman', [\n        '$provide', 'shrub-requireProvider'\n        ($provide, {require}) ->\n\n          config = require 'config'\n          debug = require('debug') 'shrub:pkgman'\n          pkgman = require 'pkgman'\n\n          debug 'Loading packages...'\n\nLoad the package list from configuration.\n\n          pkgman.registerPackageList config.get 'packageList'\n\n          debug 'Packages loaded.'\n\nSimply pass along pkgman as the 'service'.\n\n          pkgman.$get = -> pkgman\n\n          return pkgman\n      ]\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4a1e52dfd180d9a26bc5765079849b01194f4da0","subject":"See if I can get the litcoffee thing working now.","message":"See if I can get the litcoffee thing working now.\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/policies.litcoffee","new_file":"guts\/policies.litcoffee","new_contents":"Libraries\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n    policies = require '..\/config\/policies'\n\n    module.exports = (routeActions, req, res) ->\n        new Promise (resolve, reject) ->\n            require('.\/getPolicies')()\n            .then (actualPolicies) ->\n                policyResults = _.flatten _.map routeActions, (action) ->\n                        # What I'm doing here is looking for the policies file.\n                        # If there is a policy defined for that action, use that, else use the * catch all. \n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\n                        _.map tempPolicies, (policy) ->\n                            # This is pretty straightforward; we'll loop up the policy in the hash\n                            # table and then return back their result (which can just be a true or false\n                            #\n                            # We want to make sure this is properly wrapped in promisey stuff, so we can init\n                            # an empty promise then run our stuff in the \"then\". Since our empty promise only\n                            # resolves, it won't hit the catch. \n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n                \n                Promise.all policyResults\n            .then (results) ->\n                # Not entirely sure I like this logic, but it's pretty straightforward:\n                # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                # either allow the policy to reject if not permitted or to simply return false. \n                unless false in results\n                  resolve true\n                else\n                  reject \"Not Authorized\"\n                \n","old_contents":"Libraries\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n    policies = require '..\/config\/policies'\n\n    module.exports = (routeActions, req, res) ->\n        new Promise (resolve, reject) ->\n            require('.\/getPolicies')()\n            \nThis should give us an object of all the policies attached to the controller\nand action.  To make this a bit more dev-friendly, we'll wrap this in an\narray, then flatten it.  This way we can make it a nice, linear, one-dimensional\nlist to loop through, and that way you can write an array of policies or just one\npolicy for an action.  If that's what you want. I don't wanna tell you how to live\nyour life.\n            .then (actualPolicies) ->\n                policyResults = _.flatten _.map routeActions, (action) ->\n                        # What I'm doing here is looking for the policies file.\n                        # If there is a policy defined for that action, use that, else use the * catch all. \n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\n                        _.map tempPolicies, (policy) ->\n                            # This is pretty straightforward; we'll loop up the policy in the hash\n                            # table and then return back their result (which can just be a true or false\n                            #\n                            # We want to make sure this is properly wrapped in promisey stuff, so we can init\n                            # an empty promise then run our stuff in the \"then\". Since our empty promise only\n                            # resolves, it won't hit the catch. \n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n                \n                Promise.all policyResults\n            .then (results) ->\n                # Not entirely sure I like this logic, but it's pretty straightforward:\n                # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                # either allow the policy to reject if not permitted or to simply return false. \n                unless false in results\n                  resolve true\n                else\n                  reject \"Not Authorized\"\n                \n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"0562936fad4fa6d5c6d647bdc5e504d627b7a166","subject":"Remove invalid reference to batman.errorsset.html and switch wording a bit","message":"Remove invalid reference to batman.errorsset.html and switch wording a bit\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## isNew() : boolean\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## toJSON() : Object\n\n## fromJSON() : Model\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## load(options = {}, callback)\n\n## save(options = {}, callback)\n\n## destroy(options = {}, callback)\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occured within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt takes a callback with two arguments: error and the array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` contains a [`Batman.ErrorsSet`](\/docs\/api\/batman.errorsset.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## isNew() : boolean\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## toJSON() : Object\n\n## fromJSON() : Model\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## load(options = {}, callback)\n\n## save(options = {}, callback)\n\n## destroy(options = {}, callback)\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method takes a callback with two arguments: any JavaScript error that occurs and the [`Batman.ErrorsSet`](\/docs\/api\/batman.errorsset.html) resulting from the validation tests.\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure to validate a particular field on a model.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2dfee44623f4e80bba5cc2d6c84b6ac6afe164ca","subject":"add LoopbackInfo section to README","message":"add LoopbackInfo section to README\n","repos":"CureApp\/loopback-with-admin","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# loopback-with-admin\n\nrun loopback server with admin and push notification features.\n\n# install\n\n```bash\nnpm install loopback-with-admin\n```\n\n# usage\n## simplest run\n\n    # model definitions\n    # see \"models\" section for more detail\n    models =\n        'user':\n            base: 'User'\n\n\n    require('loopback-with-admin').run(models).then (lbInfo) ->\n\n        # see \"LoopbackInfo\" section for more detail\n        console.log lbInfo.getURL()         # loopback api root\n        console.log lbInfo.getAccessToken() # access token of admin\n\n\n## run with config dir\n\nbefore running, you can prepare a directory which contains custom config information.\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    configDir = '\/path\/to\/config-dir'\n\n    lbWithAdmin.run(models, configDir).then ->\n        # loopback started\n\n## run with config\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    lbWithAdmin.run(models, server: port: 3001).then ->\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    require('loopback-with-admin').run(models, configDir, env)\n\nenv is defined as\n\n```coffee\n    env ?= process.env.NODE_ENV or 'development'\n```\n- use custom value if passed\n- use NODE\\_ENV if exists\n- default value is 'development'\n\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-admin selects configs in \"local\" directory.\n\n\n\n# model definitions\n\n    models =\n        player: # model name\n            base: 'User'  \n            aclType: 'admin' # specific for this system\n\n        instrument:\n            aclType: 'owner-read'\n\n\nthe same format as [loopback model definition](http:\/\/docs.strongloop.com\/display\/public\/LB\/Customizing+models)\nexcept \"aclType\" value.\nname is automatically set from definition information.\nplural is set to the same value as name if not set manually.\n\n## aclType\nloopback-with-admin generates acls from aclType.\n\nthree types are available.\n\n aclType     | meaning\n-------------|-----------------------------------------------------\n admin       | only admin can CRUD the model (_default_)\n owner       | admin and the owner of the model can CRUD\n public-read | everyone can READ the model and admin can CRUD\n none        | everyone can CRUD the model\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-values\/non-model-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|---------------------------------\n memory      | on memory datasource\n db          | datasource for custom entities\n\nEach datasource name has its connectors.\n\n### available loopback connectors\n\navailable datasources are \n- mongodb\n- memory\n- memory-idstr\n\n\"memory-idstr\" is the default connector, which stores data only in memory,\nand id type is string whereas id type of \"memory\" is number.\n\n\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n# LoopbackInfo\n    require('loopback-with-admin').run().then (lbInfo) ->\n        lbInfo instanceof LoopbackInfo # true\n\ninstance of LoopbackInfo is obtained after loopback is launched\n\n## getURL()\nreturns hosting URL\n\n    lbInfo.getURL() # e.g. localhost:3000\/api\n\n## getEnv()\nreturns environment name where loopback launched\n\n    lbInfo.getEnv() # development|production or other custom environments\n\n## getAccessToken()\nreturns access token of admin\n\n    lbInfo.getAccessToken()\n\n## config\ncontains all config values used to build loopback.\n\n- admin\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee configs section above.\n\n## models\ncontains model definitions used to build loopback\n\nsee models section above.\n\n\n# admin\n(coming soon)\n\n# push notification \n(coming soon)\n\n\n\n","old_contents":"# loopback-with-admin\n\nrun loopback server with admin and push notification features.\n\n# install\n\n```bash\nnpm install loopback-with-admin\n```\n\n# usage\n## simplest run\n\n    # model definitions\n    # see \"models\" section for more detail\n    models =\n        'user':\n            base: 'User'\n\n\n    require('loopback-with-admin').run(models).then (lbInfo) ->\n\n        # see \"LoopbackInfo\" section for more detail\n        console.log lbInfo.getURL()         # loopback api root\n        console.log lbInfo.getAccessToken() # access token of admin\n\n\n## run with config dir\n\nbefore running, you can prepare a directory which contains custom config information.\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    configDir = '\/path\/to\/config-dir'\n\n    lbWithAdmin.run(models, configDir).then ->\n        # loopback started\n\n## run with config\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    lbWithAdmin.run(models, server: port: 3001).then ->\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    require('loopback-with-admin').run(models, configDir, env)\n\nenv is defined as\n\n```coffee\n    env ?= process.env.NODE_ENV or 'development'\n```\n- use custom value if passed\n- use NODE\\_ENV if exists\n- default value is 'development'\n\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-admin selects configs in \"local\" directory.\n\n\n\n# model definitions\n\n    models =\n        player: # model name\n            base: 'User'  \n            aclType: 'admin' # specific for this system\n\n        instrument:\n            aclType: 'owner-read'\n\n\nthe same format as [loopback model definition](http:\/\/docs.strongloop.com\/display\/public\/LB\/Customizing+models)\nexcept \"aclType\" value.\nname is automatically set from definition information.\nplural is set to the same value as name if not set manually.\n\n## aclType\nloopback-with-admin generates acls from aclType.\n\nthree types are available.\n\n aclType     | meaning\n-------------|-----------------------------------------------------\n admin       | only admin can CRUD the model (_default_)\n owner       | admin and the owner of the model can CRUD\n public-read | everyone can READ the model and admin can CRUD\n none        | everyone can CRUD the model\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-values\/non-model-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|---------------------------------\n memory      | on memory datasource\n db          | datasource for custom entities\n\nEach datasource name has its connectors.\n\n### available loopback connectors\n\navailable datasources are \n- mongodb\n- memory\n- memory-idstr\n\n\"memory-idstr\" is the default connector, which stores data only in memory,\nand id type is string whereas id type of \"memory\" is number.\n\n\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n# admin\n(coming soon)\n\n# push notification \n(coming soon)\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a7244d0e50ad92c08aaff00f7b18a04c82d6a182","subject":"update README","message":"update README\n","repos":"CureApp\/loopback-with-admin","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\nalso, this loopback extends original [loopback](https:\/\/github.com\/strongloop\/loopback).\n\n- admin\n- push notification\n\nfollow these section to see how to use admin and push notification\n\n# install\n\n```bash\nnpm install loopback-with-domain\n```\n\n# simplest run, without domain\n\nyou can just run loopback without domain information by\n\n    require('loopback-with-domain').runWithoutDomain().then (lbInfo) ->\n\n        console.log lbInfo.getURL()         # loopback api root\n        console.log lbInfo.getAccessToken() # access token of admin\n\nthen loopback server (with admin, push-notification function) runs\n\n\n# run with domain\n\nbefore running, you can prepare a directory which contains custom config information.\n\n\n```text\n(config-dir) # any name is acceptable\n|-- model-definitions.coffee\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    configDir = '\/path\/to\/config-dir'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    lbWithDomain.runWithDomain(domain, configDir).then ->\n        # loopback started\n\n# admin\n(coming soon)\n\n# push notification \n(coming soon)\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-values\/non-model-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|-----------------------\n memory      | on memory datasource\n db          | datasource for domain entities\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n# model definitions\n\n    module.exports =\n        player: # model name\n            base: 'User'  # the same as loopback model settings.base\n            aclType: 'admin' # specific for this system\n\n        instrument:\n            aclType: 'owner-read'\n\n\n\nthe same format as [loopback model definition](http:\/\/docs.strongloop.com\/display\/public\/LB\/Customizing+models)\nexcept \"aclType\" value.\nname, base, relations and properties are automatically set from domain information.\n\n## aclType\nloopback-with-domain generates acls from aclType.\n\nthree types are available.\n\n aclType     | meaning\n-------------|-----------------------------------------------------\n admin       | only admin can CRUD the model\n owner       | admin and the owner of the model can CRUD\n public-read | everyone can READ the model and admin can CRUD\n\n\n# switching environment\n\nrunning script with environment variable \"NODE\\_ENV\" like\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\n\"development\" is selected by default.\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-domain selects configs in \"local\" directory.\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    lbWithDomain.runWithDomain(domain, configDir, env)\n\nenv is prior to NODE\\_ENV settings.\n\n\n# modified loopback-datasource-juggler\n\nusing [CureApp\/loopback-datasource-juggler](https:\/\/github.com\/CureApp\/loopback-datasource-juggler).\n\nthis repository is almost the same as original one except 'memory' connector handles id as string\n(orignally integer).\n","old_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\n\n# install\n\n```bash\nnpm install loopback-with-domain\n```\n\n\n# run\n\nbefore running, you can prepare a directory which contains custom config information.\n\n\n```text\n(config-dir) # any name is acceptable\n|-- model-definitions.coffee\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    configDir = '\/path\/to\/config-dir'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    lbWithDomain.runWithDomain(domain, configDir).then ->\n        # loopback started\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-values\/non-model-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|-----------------------\n memory      | on memory datasource\n db          | datasource for domain entities\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n# model definitions\n\n    module.exports =\n        player: # model name\n            base: 'User'  # the same as loopback model settings.base\n            aclType: 'admin' # specific for this system\n\n        instrument:\n            aclType: 'owner-read'\n\n\n\nthe same format as [loopback model definition](http:\/\/docs.strongloop.com\/display\/public\/LB\/Customizing+models)\nexcept \"aclType\" value.\nname, base, relations and properties are automatically set from domain information.\n\n## aclType\nloopback-with-domain generates acls from aclType.\n\nthree types are available.\n\n aclType     | meaning\n-------------|-----------------------------------------------------\n admin       | only admin can CRUD the model\n owner       | admin and the owner of the model can CRUD\n public-read | everyone can READ the model and admin can CRUD\n\n\n# switching environment\n\nrunning script with environment variable \"NODE\\_ENV\" like\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\n\"development\" is selected by default.\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-domain selects configs in \"local\" directory.\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    lbWithDomain.runWithDomain(domain, configDir, env)\n\nenv is prior to NODE\\_ENV settings.\n\n# modified loopback-datasource-juggler\n\nusing [CureApp\/loopback-datasource-juggler](https:\/\/github.com\/CureApp\/loopback-datasource-juggler).\n\nthis repository is almost the same as original one except 'memory' connector handles id as string\n(orignally integer).\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"61205b60f2a48782a4c333e3310b1e41524ae944","subject":"Refactored computeLimb and corrected the orientation of the two clouds being wrong outside of very simplistic scenarios.","message":"Refactored computeLimb and corrected the orientation of the two clouds\nbeing wrong outside of very simplistic scenarios.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/computeLimb.litcoffee","new_file":"src\/computeLimb.litcoffee","new_contents":"Given:\n\n- A vector locating the start of the limb.\n- A vector locating the end of the limb.\n- The length of the limb when fully extended.\n- A vector pointing perpendicular to the bend direction.\n- A matrix to store the transform for the start half of the limb.\n- A matrix to store the transform for the end half of the limb.\n\nWrites to the output matrices to generate transforms for the top and bottom\nhalves of a limb to fill the gap between the start and end locations.\n\n    matrix = require \".\/matrix.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n\n    startEndDifference = []\n    startEndNormal = []\n    bendNormal = []\n    midpoint = []\n    joint = []\n    sideNormal2 = []\n    \n    lookAt = (start, end, sideNormal, transform) ->\n        vector.subtract.vector end, start, startEndDifference\n        vector.normalize startEndDifference, startEndNormal\n        vector.cross startEndNormal, sideNormal, bendNormal\n        vector.normalize bendNormal, bendNormal\n        vector.cross bendNormal, startEndNormal, sideNormal2\n        vector.normalize sideNormal2, sideNormal2\n  \n        matrix.identity transform\n        transform[0] = sideNormal2[0]\n        transform[4] = sideNormal2[1]\n        transform[8] = sideNormal2[2]\n        transform[1] = bendNormal[0]\n        transform[5] = bendNormal[1]\n        transform[9] = bendNormal[2]\n        transform[2] = startEndNormal[0]\n        transform[6] = startEndNormal[1]\n        transform[10] = startEndNormal[2]\n        matrix.translate start, transform\n    \n    module.exports = (start, end, targetLength, sideNormal, startTransform, endTransform) ->\n        vector.subtract.vector end, start, startEndDifference\n        vector.cross startEndDifference, sideNormal, bendNormal\n        realLength = vector.normalize startEndDifference, startEndNormal\n        vector.normalize bendNormal, bendNormal\n        \n        # The two halves of the limb form a pair of square-based triangles.\n        # Work out how far the bend should go based on Pythagoras' theorem.\n        alongBend = Math.sqrt (Math.max 0, (((targetLength \/ 2) * (targetLength \/ 2)) - ((realLength \/ 2) * (realLength \/ 2))))\n    \n        vector.interpolate start, end, 0.5, midpoint\n        vector.multiply.byScalar bendNormal, alongBend, joint\n        vector.add.vector joint, midpoint, joint\n        \n        lookAt start, joint, sideNormal, startTransform\n        lookAt joint, end, sideNormal, endTransform","old_contents":"Given:\n\n- A vector locating the start of the limb.\n- A vector locating the end of the limb.\n- The length of the limb when fully extended.\n- A vector pointing perpendicular to the bend direction.\n- A matrix to store the transform for the start half of the limb.\n- A matrix to store the transform for the end half of the limb.\n\nWrites to the output matrices to generate transforms for the top and bottom\nhalves of a limb to fill the gap between the start and end locations.\n\n    matrix = require \".\/matrix.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n\n    startEndDifference = []\n    startEndNormal = []\n    bendNormal = []\n    midpoint = []\n    joint = []\n    sideNormal2 = []\n    module.exports = (start, end, targetLength, sideNormal, startTransform, endTransform) ->\n        vector.subtract.vector end, start, startEndDifference\n        vector.cross startEndDifference, sideNormal, bendNormal\n        realLength = vector.normalize startEndDifference, startEndNormal\n        vector.normalize bendNormal, bendNormal\n        \n        # The two halves of the limb form a pair of square-based triangles.\n        # Work out how far the bend should go based on Pythagoras' theorem.\n        alongBend = Math.sqrt (Math.max 0, (((targetLength \/ 2) * (targetLength \/ 2)) - ((realLength \/ 2) * (realLength \/ 2))))\n    \n        vector.interpolate start, end, 0.5, midpoint\n        vector.multiply.byScalar bendNormal, alongBend, joint\n        vector.add.vector joint, midpoint, joint\n        \n        vector.subtract.vector end, joint, startEndDifference\n        vector.normalize startEndDifference, startEndNormal\n        vector.cross sideNormal, startEndDifference, bendNormal\n        vector.normalize bendNormal, bendNormal\n        vector.cross bendNormal, startEndDifference, sideNormal2\n        vector.normalize sideNormal2, sideNormal2\n    \n        matrix.identity endTransform\n        endTransform[0] = -sideNormal2[0]\n        endTransform[1] = -sideNormal2[1]\n        endTransform[2] = sideNormal2[2]\n        endTransform[4] = -bendNormal[0]\n        endTransform[5] = -bendNormal[1]\n        endTransform[6] = bendNormal[2]\n        endTransform[8] = -startEndNormal[0]\n        endTransform[9] = -startEndNormal[1]\n        endTransform[10] = startEndNormal[2]\n        matrix.translate joint, endTransform\n        \n        vector.subtract.vector joint, start, startEndDifference\n        vector.normalize startEndDifference, startEndNormal\n        vector.cross sideNormal, startEndDifference, bendNormal\n        vector.normalize bendNormal, bendNormal\n        vector.cross bendNormal, startEndDifference, sideNormal2\n        vector.normalize sideNormal2, sideNormal2\n        \n        matrix.identity startTransform\n        startTransform[0] = -sideNormal2[0]\n        startTransform[1] = -sideNormal2[1]\n        startTransform[2] = sideNormal2[2]\n        startTransform[4] = -bendNormal[0]\n        startTransform[5] = -bendNormal[1]\n        startTransform[6] = bendNormal[2]\n        startTransform[8] = -startEndNormal[0]\n        startTransform[9] = -startEndNormal[1]\n        startTransform[10] = startEndNormal[2]\n        matrix.translate start, startTransform","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0f9930c07025a9e124e997317865dc3bbb2183cf","subject":"Added unify fixes to literate version","message":"Added unify fixes to literate version\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments),\n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n                        find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return bindings\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        bindings = F.unify(_.first(t1), _.first(t2), bindings)\n        bindings = if (bindings isnt null) then F.unify(_.rest(t1), _.rest(t2),   bindings) else bindings\n        return bindings\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logic programs\n# --------------\n\nWe can build more complex goals using lambda-abstractions and previously defined combinators, `conj` and `disj`.  For example, we can define the function `choice` such that `choice(t1, array)` is a goal that succeeds if `t1` is an element of `array`.\n\n    F.choice = ($v, list) ->\n      return F.fail if _.isEmpty(list)\n\n      F.disj(F.goal($v, _.first(list)),\n                    F.choice($v, _.rest(list)))\n\nThe name `choice` should evoke [The Axiom of Choice](http:\/\/en.wikipedia.org\/wiki\/Axiom_of_choice)...\n\n\n\n# Exports and sundries\n# --------------------\n\n\t  if module?\n\t    module.exports = F\n\t  else\n\t    root.F = F\n\n\t)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n                        find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return s\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        s = F.unify(_.first(t1), _.first(t2), bindings)\n        s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2),   bindings) else s\n        return s\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logic programs\n# --------------\n\nWe can build more complex goals using lambda-abstractions and previously defined combinators, `conj` and `disj`.  For example, we can define the function `choice` such that `choice(t1, array)` is a goal that succeeds if `t1` is an element of `array`.\n\n    F.choice = ($v, list) ->\n      return F.fail if _.isEmpty(list)\n\n      F.disj(F.goal($v, _.first(list)),\n                    F.choice($v, _.rest(list)))\n\nThe name `choice` should evoke [The Axiom of Choice](http:\/\/en.wikipedia.org\/wiki\/Axiom_of_choice)...\n\n\n\n# Exports and sundries\n# --------------------\n\n\t  if module?\n\t    module.exports = F\n\t  else\n\t    root.F = F\n\n\t)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9c195d684d1b2655aff7927c4dac05b17b2d26dc","subject":"Add preview snapshot","message":"Add preview snapshot\n","repos":"mnmtanish\/vosco-cli","old_file":"script.litcoffee","new_file":"script.litcoffee","new_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    fs     = require \"fs\"\n    path   = require \"path\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    script =\n\nSetup\n-----\n\n      'install': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        if isInstalled then process.exit 1\n        await @vosco.install defer(error)\n\n      'uninstall': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.uninstall defer(error)\n\nRepository\n----------\n\n      'get-status': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getStatus defer(error, status)\n        getType = (file) -> file.type\n        getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n        groups  = _.groupBy status, getType\n        for group, paths of groups\n          console.log \"\"\"\n          #{group}\n          #{paths.map(getPath).join(\"\\n\")}\n          \"\"\"\n\n      'get-history': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getHistory defer(error, history)\n        for commit in history\n          hash = commit.hash.substr(0, 7)\n          date = new Date(commit.date).toDateString()\n          msg  = commit.message\n          console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n\n      'get-content-history': (path) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        # show warning if file doesn\"t exist\n        console.log \"content history\"\n\nSnapshots\n---------\n\n      'preview-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        hash = hash or 'HEAD'\n        await @vosco.previewSnapshot hash, defer(error, diff)\n        console.log diff\n\n      'create-snapshot': (message) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"creating snapshot\"\n\n      'rollback-to-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"rollback to snapshot\"\n\nBranches\n--------\n\n      'list-branches': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"branches list\"\n\n      'select-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"select branch\"\n\n      'create-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"create new branch\"\n\n      'delete-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"delete branch\"\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      script.vosco = vosco\n      return script\n","old_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    fs     = require \"fs\"\n    path   = require \"path\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    script =\n\nSetup\n-----\n\n      'install': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        if isInstalled then process.exit 1\n        await @vosco.install defer(error)\n\n      'uninstall': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.uninstall defer(error)\n\nRepository\n----------\n\n      'get-status': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getStatus defer(error, status)\n        getType = (file) -> file.type\n        getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n        groups  = _.groupBy status, getType\n        for group, paths of groups\n          console.log \"\"\"\n          #{group}\n          #{paths.map(getPath).join(\"\\n\")}\n          \"\"\"\n\n      'get-history': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getHistory defer(error, history)\n        for commit in history\n          hash = commit.hash.substr(0, 7)\n          date = new Date(commit.date).toDateString()\n          msg  = commit.message\n          console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n\n      'get-content-history': (path) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        # show warning if file doesn\"t exist\n        console.log \"content history\"\n\nSnapshots\n---------\n\n      'preview-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"preview snapshot\"\n\n      'create-snapshot': (message) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"creating snapshot\"\n\n      'rollback-to-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"rollback to snapshot\"\n\nBranches\n--------\n\n      'list-branches': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"branches list\"\n\n      'select-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"select branch\"\n\n      'create-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"create new branch\"\n\n      'delete-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"delete branch\"\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      script.vosco = vosco\n      return script\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b215d7f10a697afe8807474584096046fbbc3f47","subject":"AJAX port default domain","message":"AJAX port default domain\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f8f348f05c23150b8c8ad200964412f24e9a49f0","subject":"Add get branches","message":"Add get branches\n","repos":"mnmtanish\/vosco-cli","old_file":"script.litcoffee","new_file":"script.litcoffee","new_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    fs     = require \"fs\"\n    path   = require \"path\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    script =\n\nSetup\n-----\n\n      'install': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        if isInstalled then process.exit 1\n        await @vosco.install defer(error)\n\n      'uninstall': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.uninstall defer(error)\n\nRepository\n----------\n\n      'get-status': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getStatus defer(error, status)\n        getType = (file) -> file.type\n        getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n        groups  = _.groupBy status, getType\n        for group, paths of groups\n          console.log \"\"\"\n          #{group}\n          #{paths.map(getPath).join(\"\\n\")}\n          \"\"\"\n\n      'get-history': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getHistory defer(error, history)\n        for commit in history\n          hash = commit.hash.substr(0, 7)\n          date = new Date(commit.date).toDateString()\n          msg  = commit.message\n          console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n\n      'get-content-history': (path) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        # show warning if file doesn\"t exist\n        console.log \"content history\"\n\nSnapshots\n---------\n\n      'preview-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        hash = hash or 'HEAD'\n        await @vosco.previewSnapshot hash, defer(error, diff)\n        console.log diff\n\n      'create-snapshot': (message) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        message = message or 'Untitled Snapshot'\n        await @vosco.createSnapshot message, defer(error)\n\n      'rollback-to-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.rollbackToSnapshot hash, defer(error)\n\nBranches\n--------\n\n      'get-branches': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getBranches defer(error, branches, current)\n        for branch in branches\n          branch = if branch is current then \"* #{branch}\" else\n            colors.xterm(240)(\"  #{branch}\")\n          console.log \"#{branch}\"\n\n      'create-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"create new branch\"\n\n      'select-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"select branch\"\n\n      'delete-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"delete branch\"\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      script.vosco = vosco\n      return script\n","old_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    fs     = require \"fs\"\n    path   = require \"path\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    script =\n\nSetup\n-----\n\n      'install': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        if isInstalled then process.exit 1\n        await @vosco.install defer(error)\n\n      'uninstall': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.uninstall defer(error)\n\nRepository\n----------\n\n      'get-status': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getStatus defer(error, status)\n        getType = (file) -> file.type\n        getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n        groups  = _.groupBy status, getType\n        for group, paths of groups\n          console.log \"\"\"\n          #{group}\n          #{paths.map(getPath).join(\"\\n\")}\n          \"\"\"\n\n      'get-history': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getHistory defer(error, history)\n        for commit in history\n          hash = commit.hash.substr(0, 7)\n          date = new Date(commit.date).toDateString()\n          msg  = commit.message\n          console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n\n      'get-content-history': (path) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        # show warning if file doesn\"t exist\n        console.log \"content history\"\n\nSnapshots\n---------\n\n      'preview-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        hash = hash or 'HEAD'\n        await @vosco.previewSnapshot hash, defer(error, diff)\n        console.log diff\n\n      'create-snapshot': (message) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        message = message or 'Untitled Snapshot'\n        await @vosco.createSnapshot message, defer(error)\n\n      'rollback-to-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.rollbackToSnapshot hash, defer(error)\n\nBranches\n--------\n\n      'get-branches': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"branches list\"\n\n      'create-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"create new branch\"\n\n      'select-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"select branch\"\n\n      'delete-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"delete branch\"\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      script.vosco = vosco\n      return script\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"506c6a360d8d3af3f39a356de9be646129a8a444","subject":"progress","message":"progress\n","repos":"atmin\/jtmpl,atmin\/jtmpl","old_file":"src\/coffee\/jtmpl.litcoffee","new_file":"src\/coffee\/jtmpl.litcoffee","new_contents":"## Interface\n\n### Compile:\n\nString jtmpl(String template, AnyType model)\n\n### Compile and bind (browser only):\n\nvoid jtmpl(DOMElement target, String template, AnyType model)\n\n`target` and `template` can be Strings in the format \"#element-id\".\n\n\n\n    root = this\n    jtmpl = root.jtmpl = (target, template, model, options) ->\n\n      # Deprecated. `jtmpl(selector)`?\n      if (target is null or typeof target is 'string') and not template?\n\n        if not document?\n          throw ':( this API is only available in a browser'\n\n        return Array.prototype.slice.call(document.querySelectorAll(target))\n\n      # `jtmpl(template, model)`?\n      if typeof target is 'string' and\n        typeof template in ['number', 'string', 'boolean', 'object'] and\n        model is undefined\n\n        options = model\n        model = template\n        template = target\n        target = undefined\n\n      # `jtmpl('#element-id', ...)`?\n      if typeof target is 'string' and target.match(RE_IDENTIFIER)\n        target = document.getElementById(target.substring(1))\n      \n      if not model?\n        throw ':( no model'\n\n      # `jtmpl('#template-id', ...)` or `jtmpl(element, '#template-id', ...)`\n      template = document.getElementById(template.substring(1)).innerHTML \n        if template.match and template.match(RE_IDENTIFIER)\n\n      # options\n      options = options or {}\n\n      # string-separated opening and closing delimiter\n      options.delimiters = (options.delimiters or '{{ }}').split(' ')\n      # delimiters are changed in the generated HTML comment-enclosed section prototype\n      # to avoid double-parsing\n      options.compiledDelimiters = (options.compiledDelimiters or '<<< >>>').split(' ')\n\n      # sections not enclosed in HTML tag are automatically enclosed\n      options.defaultSection = options.defaultSectionTag or 'div'\n      # default for section items\n      options.defaultSectionItem = options.defaultSectionItem or 'div'\n      # default for section items\n      options.defaultVar = options.defaultVar or 'span'\n\n      # default target tag\n      options.defaultTargetTag = options.defaultTargetTag or 'div'\n\n\n      # Compile template\n      html = jtmpl.compile(template, model, 0, null, false, options)\n\n\n\n\n\n\n## Rules\n\njtmpl is a processor of rules. There are two sequences,\none for each stage, compilation and binding.\n\nRules in each sequence are in increasing specificity order.\n\nBoth stages can be extended with new rules:\n`jtmpl.compileRules.push({ ... })`, `jtmpl.bindRules.push({ ... })`\n\n\n\n\n\n### Regular expression atoms\n\nUsed in various matchers\n\n    RE_IDENTIFIER = '[\\\\w\\\\.\\\\-]+'\n    RE_ANYTHING = '[\\\\s\\\\S]*?'\n\n\n\n\n\n### Compile rules \n\nDelimiters in `pattern`s are replaced with escaped options.delimiters, whitespace - stripped\n\nSignatures:\n\nString `replaceWith` (String for each group in pattern, AnyType model, Object context)\n\nString `context.recurFunc` (AnyType model, String property, Boolean echoMode)\n\nvoid `context.setWrapperAttr` (String attrName, String attrValue)\n\n\n\n    jtmpl.compileRules = [\n\n      { # {{var}}\n        pattern: \"{{ (#{ RE_IDENTIFIER }) }}\"\n        defaultWrapper: 'defaultVar'\n        replaceWith: (prop, model) -> escapeHTML(model[prop])\n      }\n\n\n      { # {{unescaped_var}}\n        pattern: \"{{ & (#{ RE_IDENTIFIER }) }}\"\n        defaultWrapper: 'defaultVar'\n        replaceWith: (prop, model) -> model[prop]\n      }\n\n\n      { # {{#block}}\n        pattern: \"{{ \\\\# (#{ RE_IDENTIFIER }) }}\"\n        defaultWrapper: 'defaultSection'\n        replaceWith: (prop, model, context) ->\n          val = model[prop]\n\n          # Sequence?\n          if Array.isArray(val)\n            # template as HTML comment\n            \"<!-- # #{ context.recurFunc(null, prop, true) } -->\"\n            +\n            # Render body for each item\n            (context.recurFunc(item, prop) for item in val).join('')            \n\n          # Context?\n          else if typeof val is 'object'\n            # Render body using context\n            context.recurFunc(val, prop)\n\n          else\n            # hide if falsy value\n            if not val then context.setWrapperAttr('style', 'display:none')\n            # Render body using model\n            context.recurFunc(model, prop)\n      }\n\n\n      { # {{^block}}\n        pattern: \"{{ \\\\^ (#{ RE_IDENTIFIER }) }}\"\n        defaultWrapper: 'defaultSection'\n        replaceWith: (prop, model, context) ->\n          val = model[prop]\n\n          # Sequence?\n          if Array.isArray(val)\n            # template as HTML comment\n            \"<!-- ^ #{ context.recurFunc(null, prop, true) } -->\"\n            +\n            # Render body if array empty\n            if not val.length then context.recurFunc(model, prop) else ''\n\n          else\n            # hide if truthy value\n            if val then context.setWrapperAttr('style', 'display:none')\n            # Render body using model\n            context.recurFunc(model, prop)\n      }\n\n\n      { # class=\"...{{booleanVar}}\n        pattern: \"(class=\\\"? #{ RE_ANYTHING }) {{ (#{ RE_IDENTIFIER }) }}\"\n        replaceWith: (pre, prop, model) ->\n          val = model[prop]\n          # Emit match, and class name if true\n          pre + (typeof val is 'boolean' and val and prop or '')\n      }\n    ]\n\n\n\n\n\n### Bind rules\n\nMatching is done on tokenized data-jt items\n\nSignatures:\n\nFunction AnyType (AnyType val) `react`\n(DOMElement node, String for each pattern group, AnyType model)\n\n\n\n    bindRules = [\n\n      { # var\n        pattern: \"#{ RE_IDENTIFIER }\",\n        react: (node) ->\n          (val) -> node.innerHTML = val\n      }\n\n\n      { # attr=var\n        pattern: \"(#{ RE_IDENTIFIER }) = #{ RE_IDENTIFIER }\",\n        react: (node, attr) ->\n          (val) -> if node[attr] isnt val then node[attr] = val\n      }\n\n\n      { # class=var\n        pattern: \"class = (#{ RE_IDENTIFIER })\",\n        react: (node, prop, model) ->\n          (val) -> (val and addClass or removeClass)(node, prop)\n      }\n\n\n      { # value\/checked\/selected=var\n        pattern: \"(value | checked | selected) = (#{ RE_IDENTIFIER })\",\n        react: (node, attr, prop, model) ->\n          (val) -> if node[attr] isnt val then node[attr] = val\n      }\n\n\n    ]\n\n\n\n\n\n## Compile rules processor\n\nTokenize template and apply each rule\n\n\n    jtmpl.compile = (template, model, position, openTag, echoMode, options) ->\n\n      tokenizer = regexp(\"{{ (#{ RE_ANYTHING }) }}\", options)\n\n      while (token = tokenizer.exec(template))\n\n        slice = template.slice(0, tokenizer.lastIndex)\n\n        # Process rules in reverse order, most specific to least specific\n        for rule in jtmpl.compileRules by -1\n\n          match = regexp(rule.pattern).match(slice)\n          if match\n            return \n\n\n\n\n\n## Bind rules processor\n\nWalk DOM and setup reactors between model and nodes.\n\n\n\n\n\n\n## Supporting code\n\n\n### Array shortcuts\n\n    ap = Array.prototype\n    apslice = -> ap.slice\n\n    \n\n\n### Functional utilities\n\nFunction curry(Function f, AnyType frozenArg1, AnyType frozenArg2, ...)\n\n    curry = ->\n      args = apslice.call(arguments)\n      ->\n        args2 = apslice.call(arguments)\n        args[0].apply(@, args.slice(1).concat(args2))\n\n\nFunction compose(Function f, Function g)\n\n    compose = (f, g) -> -> f(g.apply(@, apslice.call(arguments)))\n\n\n\n\n### Regular expression utilities\n\nString escapeRE(String s)\n\nEscape regular expression characters\n\n    escapeRE = (s) -> (s + '').replace(\/([.?*+^$[\\]\\\\(){}|-])\/g, '\\\\$1')\n\n\n\n\nRegExp regexp(String src)\n\nReplace mustaches with current delimiters, strip whitespace, return RegExp\n\n    regexp = (src, options) ->\n      new RegExp(src\n        # triple mustache to alt non-escaped var output\n        .replace('{{{', escapeRE(options.delimiters[0]) + '&')\n        .replace('}}}', escapeRE(options.delimiters[1]))\n        .replace('{{',  escapeRE(options.delimiters[0]))\n        .replace('}}',  escapeRE(options.delimiters[1]))\n        .replace(\/\\s+\/g, '')\n      )\n\n\n\n### String utilities\n\nString escapeHTML(String val)\n\nReplace HTML special characters\n\n    escapeHTML = (val) ->\n      (val? and val or '')\n        .toString()\n        .replace \/[&\\\"<>\\\\]\/g, (s) ->\n          switch s\n            when '&' then '&amp;'\n            when '\\\\'then '\\\\\\\\'\n            when '\"' then '\\\"'\n            when '<' then '&lt;'\n            when '>' then '&gt;'\n            else s\n","old_contents":"## Interface\n\n    root = this\n    root.jtmpl = (target, template, model, options) ->\n      reId = \/^\\#[\\w-]+$\/\n\n      # Deprecated. `jtmpl(selector)`?\n      if (target is null or typeof target is 'string') and not template?\n        if not document?\n          throw ':( this API is only available in a browser'\n        return Array.prototype.slice.call(document.querySelectorAll(target))\n\n      # `jtmpl(template, model)`?\n      if typeof target is 'string' and typeof template in ['number', 'string', 'boolean', 'object'] and model is undefined\n        options = model\n        model = template\n        template = target\n        target = undefined    \n\n      # `jtmpl('#element-id', ...)`?\n      if typeof target is 'string' and target.match(reId)\n        target = document.getElementById(target.substring(1))\n      \n      if not model?\n        throw ':( no model'\n\n      # `jtmpl('#template-id', ...)` or `jtmpl(element, '#template-id', ...)`\n      template = document.getElementById(template.substring(1)).innerHTML if template.match and template.match(reId)\n\n\n\n\n\n\n\n## Rules\n\njtmpl is a processor of rules. There are two sequences,\none for each stage, compilation and binding.\n\nRules in each sequence are in increasing specificity order.\n\nBoth stages can be extended with new rules:\n`jtmpl.compileRules.push({ ... })`, `jtmpl.bindRules.push({ ... })`\n\n\n\n\n### Regular expression atoms\n\nUsed in various matchers\n\n    RE_IDENTIFIER = '[\\\\w\\\\.\\\\-]+'\n    RE_ANYTHING = '[\\\\s\\\\S]*?'\n\n\n\n\n\n### Compile rules \n\nDelimiters in `pattern`s are replaced with escaped options.delimiters, whitespace - stripped\n\n`replaceWith` signature\nreturn: String\nparams: String for each group in pattern, AnyType model, Object context\n\n    jtmpl.compileRules = [\n\n      { # {{var}}\n        pattern: \"{{ (#{ RE_IDENTIFIER }) }}\"\n        defaultWrapper: 'defaultVar'\n        replaceWith: (prop, model) -> model[prop]\n      }\n\n\n      { # {{#block}}\n        pattern: \"{{ \\\\# (#{ RE_IDENTIFIER }) }}\"\n        defaultWrapper: 'defaultSection'\n        replaceWith: (prop, model, context) ->\n          val = model[prop]\n\n          # Sequence?\n          if Array.isArray(val)\n            # template as HTML comment\n            \"<!-- # #{ context.recurFunc(null, prop, true) } -->\"\n            +\n            # Render body for each item\n            (context.recurFunc(item, prop) for item in val).join('')            \n\n          # Context?\n          else if typeof val is 'object'\n            # Render body using context\n            context.recurFunc(val, prop)\n\n          else\n            # hide if falsy value\n            if not val then context.setWrapperAttr('style', 'display:none')\n            # Render body using model\n            context.recurFunc(model, prop)\n      }\n\n\n      { # {{^block}}\n        pattern: \"{{ \\\\^ (#{ RE_IDENTIFIER }) }}\"\n        defaultWrapper: 'defaultSection'\n        replaceWith: (prop, model, context) ->\n          val = model[prop]\n\n          # Sequence?\n          if Array.isArray(val)\n            # template as HTML comment\n            \"<!-- ^ #{ context.recurFunc(null, prop, true) } -->\"\n            +\n            # Render body if array empty\n            if not val.length then context.recurFunc(model, prop) else ''\n\n          else\n            # hide if truthy value\n            if val then context.setWrapperAttr('style', 'display:none')\n            # Render body using model\n            context.recurFunc(model, prop)\n      }\n\n\n      { # class=\"...{{booleanVar}}\n        pattern: \"(class=\\\"? #{ RE_ANYTHING }) {{ (#{ RE_IDENTIFIER }) }}\"\n        replaceWith: (pre, prop, model) ->\n          val = model[prop]\n          # Emit match, and class name if true\n          pre + (typeof val is 'boolean' and val and prop or '')\n      }\n    ]\n\n\n\n### Bind rules\n\nMatching is done on tokenized data-jt items\n\n`react` signature\nreturn: function (AnyType val), to be called on prop change\nparams: DOMElement node, String for each pattern group, AnyType model\n\n    bindRules = [\n\n      { # var\n        pattern: \"#{ RE_IDENTIFIER }\",\n        react: (node) ->\n          (val) -> node.innerHTML = val\n      }\n\n\n      { # attr=var\n        pattern: \"(#{ RE_IDENTIFIER }) = #{ RE_IDENTIFIER }\",\n        react: (node, attr) ->\n          (val) -> if node[attr] isnt val then node[attr] = val\n      }\n\n\n      { # class=var\n        pattern: \"class = (#{ RE_IDENTIFIER })\",\n        react: (node, prop, model) ->\n          (val) -> (val and addClass or removeClass)(node, prop)\n      }\n\n\n      { # value\/checked\/selected=var\n        pattern: \"(value | checked | selected) = (#{ RE_IDENTIFIER })\",\n        react: (node, attr, prop, model) ->\n          (val) -> if node[attr] isnt val then node[attr] = val\n      }\n\n\n    ]\n\n\n\n\n\n## Compile rules processor\n\nTokenize template and apply each rule\n\n    jtmpl.compile = (template, model, position, openTag, echoMode) ->\n\n      tokenizer = jtmpl.regexp(\"{{ (#{ RE_ANYTHING }) }}\")\n\n      while (token = tokenizer.exec(template))\n\n        slice = template.slice(0, tokenizer.lastIndex)\n\n        # Process rules in reverse order, most specific to least specific\n        for i in [jtmpl.compileRules.length - 1..0] by -1\n\n          rule = jtmpl.compileRules[i]\n          match = rule.pattern.match(slice)\n\n\n\n## Utility functions\n\nReplace mustaches with current delimiters, strip whitespace, return RegExp\n\n    jtmpl.regexp = (re) ->","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8d441b25967b1bde8b1e421665918858e726fa2c","subject":"Reworked method wrapping decision logic","message":"Reworked method wrapping decision logic\n\nMethod wrapping now has two phases:\n\n1. Collect al methods to be wrapped - and the prototype they belong to.\n2. Execute wrapping, starting at the base of the inheritence hierarchy.\n\nMethods are collected for wrapping by walking up the prototype chain from\nthe leaf class. Methods are wrapped by walking down the prototype chain from\nthe base class.\n\nChecks were also put in place to skip over dependencies that look like methods\nthat need wrapping.\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (done) =>\n        proto  = @.__proto__\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.constructor.name == 'Madul'\n\n          proto = proto.__super__\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            @[initer.execute]().then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        @_call_initializers_for name, =>\n          if listeners[name]?\n            async.each listeners[name], (listener, next) =>\n              listener @\n              next()\n            , => @_register_initialized name\n          else\n            @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              @[initializer.fn]()\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: =>\n        proto = @.__proto__\n        name  = proto.constructor.name\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          for prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if typeof body == 'function' || typeof body.behavior == 'function'\n                proto._do_wrap proto, prop\n\n                INITIALIZERS name, prop if prop[0] == '$'\n\n          proto = proto.__proto__\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (done) =>\n        proto  = @.__proto__\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.constructor.name == 'Madul'\n\n          proto = proto.__super__\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            @[initer.execute]().then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        @_call_initializers_for name, =>\n          if listeners[name]?\n            async.each listeners[name], (listener, next) =>\n              listener @\n              next()\n            , => @_register_initialized name\n          else\n            @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              @[initializer.fn]()\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ee3bc1b3e125d64e1df2b395fda99435a000ad1d","subject":"Update functions.litcoffee","message":"Update functions.litcoffee","repos":"andychase\/date_machine,andychase\/date_machine,andychase\/date_machine,andychase\/date_machine","old_file":"date_machine\/javascript\/functions.litcoffee","new_file":"date_machine\/javascript\/functions.litcoffee","new_contents":"### This file\n\nThe logic in this file builds the date object.\n\nIf you compare this file to the ```python\/functions.py``` file\nyou'll notice they are very similiar. That's intentional,\nthis file was ported over and kept such that it would be somewhat\neasy to port changes back and forth.\n\n### Terminology\n\nBecause it's so confusing here is a list of the different levels to refer to:\n\n- Groups \n  -- This is the capture groups. The lowest level. ```([0-9])``` etc.\n  \"Day\", \"Month\", etc.\n- Expressions \n  -- This is an expression with multiple capture groups. They're usually named\n  after the person that wrote them. \"Greg Burns\", etc.\n  \n  In Python, Expressions functions have nice named arguments, def expr(Day, Month, Year),\n  but Javascript doesn't support this.\n- Type\n  -- This is a collection of expressions with a common goal.\n  Months (Jan, 0-12, January, etc.). \n- Patterns\n  -- This is a collection of types ```<Month>\/<Day>\/<Year>```\n\n### Warning\n\nA note about the above list. Types and Groups are commonly mixed up.\nI think groups SHOULD be the lowest \n(because they are the actual capture *groups* in regular expressions)\nbut a group of expressions also makes sense.\n\nIt's so confusing that there are at least a couple places here that I've\nalso mixed myself up and probably in the documentation for RE|PARSE as well.\n\n---\n\nI use named tuples in python, and ```_replace``` mirrors the functionality of \n```date._replace```.. that is that it returns a copy of the date with only\ncertain things changed and leaves the old well enough alone.\n\n        _replace = (_old, _new) ->\n            year:   if _new.year? then _new.year else _old.year\n            month:  if _new.month? then _new.month else _old.month\n            day:    if _new.day? then _new.day  else _old.day\n            hour:   if _new.hour? then _new.hour else _old.hour\n            minute: if _new.minute? then _new.minute else _old.minute\n            second: if _new.second? then _new.second else _old.second\n            am_pm:  if _new.am_pm? then _new.am_pm else _old.am_pm\n\nI represent lengths of dates (i.e. Thursday, 1-2pm) with a timedelta that goes right\nafter the date hash in the result array.\n\nIn Javascript, I'm just going to represent a timedelta with a hash.\nI make a pretty dumb assumption that timedelta will only cross hour\/minutes\/second boundaries.\n\n        timedelta_from_Date = (start_time, end_time) ->\n            seconds_difference = 0\n            if start_time.hour? and end_time.hour?\n              seconds_difference += 60*60*(end_time.hour - start_time.hour)\n\n              if start_time.minute? and end_time.minute?\n                seconds_difference += 60*(end_time.minute - start_time.minute)\n\n                if start_time.second? and end_time.second?\n                  seconds_difference += end_time.second - start_time.second\n\n            hours = Math.floor(seconds_difference\/60\/60)\n            minutes = Math.floor(seconds_difference\/60) - (hours * 60)\n            seconds = seconds_difference - (minutes * 60) - (hours * 60 * 60)\n\n            return {\n               timedelta: true\n               hours: hours\n               minutes: minutes\n               seconds: seconds\n            }\n\n\nThis is just a helper function\n\n        in_array = (arr, _) -> arr.indexOf(_) != -1\n\n```progressive_match``` is useful for matching abbreviations\nand full spellings. Functions like this could be useful\nto help parse fuzzy matches in the future (i.e. misspellings of months).\n\n        progressive_match = (string, possibilities) ->\n            part = \"\"\n            if not string? then return\n            for character in string.toLowerCase()\n                part += character\n                matches = []\n                for month, value of possibilities\n                    if month.indexOf(part) > -1\n                        matches.push(month)\n                if matches.length == 1\n                    return possibilities[matches[0]]\n### Types\n\n\n        month_to_number = (month_string) ->\n          months =\n              \"january\": 1\n              \"february\": 2\n              \"march\": 3\n              \"april\": 4\n              \"may\": 5\n              \"june\": 6\n              \"july\": 7\n              \"august\": 8\n              \"september\": 9\n              \"october\": 10\n              \"november\": 11\n              \"december\": 12\n           return progressive_match(month_string, months)\n\n        weekday_to_number = (WeekdayString ) ->\n            weekday_list = {\n                \"monday\": 0,\n                \"tuesday\": 1,\n                \"wednesday\": 2,\n                \"thursday\": 3,\n                \"friday\": 4,\n                \"saturday\": 5,\n                \"sunday\": 6,\n            }\n            return progressive_match(WeekdayString, weekday_list)\n\nI serialize am_pm by converting the hours to milliary\/24-hour time format.\nI also include ```am_pm: 'pm'``` in the date format to show that that transformation\nwas done. Making that clear helpful because if you get a time like 1, with no ```am_pm```\ndesignation you might want to assume pm and add 12. This is not done in the libary because\ndate_machine strives for honesty, not guesswork.\n\n        am_pm = (input) ->\n            if not input?\n              return\n            if input.toLowerCase() == \"am\" then 0\n            else if input.toLowerCase() == \"pm\" then 12\n\nYou can see in this function that I try not to repeat logic and use other\nfunctions. In this case I might have been able to simply put time_expression\nin the functions hash\/object, but in python it makes a difference due to named arguments.\nI'm going to leave it as-is for clarity.\n\n        military_time = (MilHour, MilMinute, MilSecond ) ->\n            return time_expression(MilHour, MilMinute, MilSecond, undefined)\n\nHere is the ampm conversion. I omit returns when the expressions are simple,\nbut later on I want to use them as much as possible to make my intentions clear.\n\n        noon = (hour, AMPM) -> hour == 12 and AMPM == 12\n        midnight = (hour, AMPM) -> hour == 12 and AMPM == 0\n\n        time_expression = (Hour, Minute, Second, AMPM, SpecialTimeText ) ->\n            if not Hour? and not Minute? and not Second? and not AMPM? and not SpecialTimeText?\n                return\n            if SpecialTimeText\n                if SpecialTimeText.toLowerCase() == \"noon\"\n                    return {hour: 12}\n                if SpecialTimeText.toLowerCase() == \"midnight\"\n                    return {hour: 0}\n            d = {}\n            if Hour\n                d.hour = Number(Hour)\n            if Minute\n                d.minute = Number(Minute)\n            if Second\n                d.second = Number(Second)\n            if AMPM?\n                if d.hour\n                    if noon(d.hour, AMPM)\n                        d.hour = 12\n                    else if midnight(d.hour, AMPM)\n                        d.hour = 0\n                    else\n                        d.hour = d.hour + AMPM\n                d.am_pm = AMPM\n            if [d.hour, d.minute, d.second] == [undefined, undefined, undefined]\n                return undefined\n            return d\n\n\n        time_and_time = (Hour, Minute, AMPM1, Hour2, Minute2, AMPM2) ->\n            if AMPM2?\n                AMPM2 = am_pm(AMPM2)\n            if not AMPM1? and not AMPM2?\n                return [time_expression(Hour, Minute), time_expression(Hour2, Minute2)]\n            else if not AMPM1?\n                return [time_expression(Hour, Minute, undefined, AMPM2),\n                        time_expression(Hour2, Minute2, undefined, AMPM2)]\n            else if not AMPM2?\n                return [time_expression(Hour, Minute, undefined, AMPM1),\n                        time_expression(Hour2, Minute2, undefined, AMPM1)]\n\n\n        month_type = (input...) ->\n            for value in input\n                if value?\n                    return Number(value)\n\n\n        date_number = (Day, Abbr) -> if Day? then Number(Day)\n\n        month_number = (MonthNum) -> Number(MonthNum)\n\n        month_num_type = (input) -> Number(input)\n\n        year = (Year) -> if Year? then Number(Year)\n\nSometimes the value is [undefined, undefined, <value>],\nso I need to search for it and find it.\n\n        get_first_defined = (_) ->\n          for item in _\n            if item?\n              return item\n\n### Patterns\n\nThere's a some unwrapping values out of arrays here.\nBecause of the namedarguments issue functions receive a lot more\narrays then in Python and so they need to be unwrapped.\n\n        weekday_range_with_time = (time1, time2, [weekday1], [weekday2], MonthRange) ->\n            output = []\n\n            # Get first undefined value\n            # Since only one value in list will be defined (if any)\n            time1 = get_first_defined(time1)\n            time2 = get_first_defined(time2)\n\n            if time1?\n                for date in MonthRange\n                    output.push(_replace(date, time1))\n                    if time2?\n                        output.push(_replace(date, time2))\n            return output\n\n\n        weekday_range_with_extra = ( time, and_time, weekday_start, weekday_end, extra_time, extra_weekday, MonthRange) ->\n            output = []\n            if time?\n                for date in MonthRange\n                    if date.weekday?\n                        if date.weekday in [weekday_start .. weekday_end]\n                            output.push(_replace(date, time))\n                            if and_time?\n                                output.push(_replace(date, and_time))\n                        if date.weekday == extra_weekday\n                            output.push(_replace(date, extra_time))\n            return output\n\n\n        weekday_range_with_extra_backwards = (extra_time, extra_weekday, time, weekday_start, weekday_end, MonthRange ) ->\n            return weekday_range_with_extra(time[0], time[1], weekday_start, weekday_end, extra_time, extra_weekday, MonthRange )\n\n\n        reverse_basic_text = (time, day, month, year) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        basic_text = (time, first_second, weekday, month, day, year) ->\n            if not day?\n                day = 1\n            if (day instanceof Array) and day.length == 1\n              day = day[0]\n            if (year instanceof Array) and year.length == 1\n              year = year[0]\n            if not time?\n                return {year: year, month: month, day: day}\n            else\n                year: year\n                month: month\n                day: day\n                hour: time.hour\n                minute: time.minute\n                second: time.second\n                am_pm: time.am_pm\n\n\n        slash = (month, day, year, time) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        month_range = (month, date_a, date_b) ->\n            output = []\n            for day in [date_a .. date_b]\n                output.push(basic_text(undefined, undefined, undefined, month, day, undefined))\n            return output\n\n\n        multi_time = (time1, BasicText) ->\n            output = []\n            if time1? and BasicText?\n                output.push(_replace(BasicText, time1))\n                output.push(BasicText)\n                return output\n\n\n        large_repeat_words = ->\n            return undefined\n\n\n        weekday_range_with_time_range = (time1, weekday_range) ->\n            output = []\n            if time1? and weekday_range?\n                range = timedelta_from_Date(_replace(weekday_range[0], time1), weekday_range[0])\n                for weekday in weekday_range\n                    output.push(_replace(weekday, {hour:time1.hour, minute:time1.minute, am_pm:time1.am_pm}))\n                    output.push(range)\n                return output\n\n\n        time_range = (unstrict_time, strict_time, date, reverse) ->\n            endtime = date\n            starttime = endtime\n            if unstrict_time\n                starttime = _replace(starttime, {hour:Number(unstrict_time[0])})\n                if date.am_pm\n                    starttime = _replace(starttime, {hour: starttime.hour + date.am_pm, am_pm:date.am_pm})\n            else\n                starttime = _replace(starttime, {hour: strict_time.hour, minute: strict_time.minute})\n\n            time_range = timedelta_from_Date(starttime, endtime)\n            if reverse\n                time_range = timedelta_from_Date(endtime, starttime)\n            return [starttime, time_range]\n\n\n        alt_time_range = (first_second, weekday, month, day, year, time, unstrict_time, strict_time) ->\n            return time_range(unstrict_time, strict_time, basic_text(time, first_second, weekday, month, day, year), reverse)\n\n\n        until_range = (date1, date2) ->\n            if date1 and date2\n                return [date1, timedelta_from_Date(date1, date2)]\n\n\n        through_range = (time, weekday1, weekday2, month, date, beginning) ->\n            output = []\n            if month and date and beginning and weekday1\n                ending =\n                    month: month\n                    day: date\n                for day in [beginning.day .. ending.day]\n                    temp =\n                        month: month\n                        day: date\n                    if temp.weekday and in_array([weekday1 .. weekday2], temp.weekday)\n                        if time\n                            output.push(_replace(temp, time))\n                        else\n                            output.push(temp)\n                return output\n\n\n### The function list\n\nThis hash\/object matches all the functions with a\nstring that represents it in the parse tree.\n\n        functions =\n            # Groups\n            \"MonthString\": month_to_number,\n            \"AMPM\": am_pm,\n            # Expressions\n            \"Chase Year\": year,\n            \"Chase Date\": date_number,\n            \"Chase Month\": month_number,\n            \"Steve Valaitis\": time_expression,\n            \"Greg Burns\": (hour, am_pm) -> time_expression(hour, null, null, am_pm, null),\n            \"Greg Burns UnstrictTime:\": time_expression,\n            \"Steve Valaitis2\": military_time,\n            \"Steve Valaitis And Time\": time_and_time,\n            \"Text Parts\": time_expression,\n            \"Michael Ash10\": weekday_to_number,\n            # Types\n            \"Month\": month_type,\n            \"MonthNum\": month_num_type,\n            # Patterns\n            \"LargeRepeatWords\": large_repeat_words,\n            \"BasicText\": basic_text,\n            \"ReverseBasicText\": reverse_basic_text,\n            \"Slash\": slash,\n            \"MonthRange\": month_range,\n            \"MultiTime\": multi_time,\n            \"WeekdayRangeWithTime\": weekday_range_with_time,\n            \"WeekdayRangeWithExtra\": weekday_range_with_extra,\n            \"WeekdayRangeWithExtraBackwards\": weekday_range_with_extra_backwards,\n            \"WeekdayRangeWithTimeRange\": weekday_range_with_time_range,\n            \"UntilRange\": until_range,\n            \"ThroughRange\": through_range,\n            \"TimeRange\": time_range,\n            \"AltTimeRange\": alt_time_range,\n\nThis is default expression or pattern. ```any``` means\nif value is defined, and there is array with even a single defined value then return true.\n\n            \"_default\": (_) ->\n                if any(_) then _ else undefined\n\n```Type``` there is used to mean collection of expressions.\nI know that because only one will match, so you just have to find\nit and return it.\n\n            \"_default_type\": (_...) ->\n                if _?\n                    for item in _\n                         if item?\n                             return item\n\n            \"_default_group\": (_...) -> if _[0]? then _[0]\n","old_contents":"### This file\n\nThe logic in this file builds the date object.\n\nIf you compare this file to the ```python\/functions.py``` file\nyou'll notice they are very similiar. That's intentional,\nthis file was ported over and kept such that it would be somewhat\neasy to port changes back and forth.\n\n### Terminology\n\nBecause it's so confusing here is a list of the different levels to refer to:\n\n- Groups \n  -- This is the capture groups. The lowest level. ```([0-9])``` etc.\n  \"Day\", \"Month\", etc.\n- Expressions \n  -- This is an expression with multiple capture groups. They're usually named\n  after the person that wrote them. \"Greg Burns\", etc.\n  \n  In Python, Expressions functions have nice named arguments, def expr(Day, Month, Year),\n  but Javascript doesn't support this.\n- Type\n  -- This is a collection of expressions with a common goal.\n  Months (Jan, 0-12, January, etc.). \n- Patterns\n  -- This is a collection of types ```<Month>\/<Day>\/<Year>```\n\n### Warning\n\nA note about the above list. Types and Groups are commonly mixed up.\nI think groups SHOULD be the lowest \n(because they are the actual capture *groups* in regular expressions)\nbut a group of expressions also makes sense.\n\nIt's so confusing that there are at least a couple places here that I've\nalso mixed myself up and probably in the documentation for RE|PARSE as well.\n\n---\n\nI use named tuples in python, and ```_replace``` mirrors the functionality of \n```date._replace```.. that is that it returns a copy of the date with only\ncertain things changed and leaves the old well enough alone.\n\n        _replace = (_old, _new) ->\n            year:   if _new.year? then _new.year else _old.year\n            month:  if _new.month? then _new.month else _old.month\n            day:    if _new.day? then _new.day  else _old.day\n            hour:   if _new.hour? then _new.hour else _old.hour\n            minute: if _new.minute? then _new.minute else _old.minute\n            second: if _new.second? then _new.second else _old.second\n            am_pm:  if _new.am_pm? then _new.am_pm else _old.am_pm\n\nI represent lengths of dates (i.e. Thursday, 1-2pm) with a timedelta that goes right\nafter the date hash in the result array.\n\nIn Javascript, I'm just going to represent a timedelta with a hash.\nI make a pretty dumb assumption that timedelta will only cross hour\/minutes\/second boundaries.\n\n        timedelta_from_Date = (start_time, end_time) ->\n            seconds_difference = 0\n            if start_time.hour? and end_time.hour?\n              seconds_difference += 60*60*(end_time.hour - start_time.hour)\n\n              if start_time.minute? and end_time.minute?\n                seconds_difference += 60*(end_time.minute - start_time.minute)\n\n                if start_time.second? and end_time.second?\n                  seconds_difference += end_time.second - start_time.second\n\n            hours = Math.floor(seconds_difference\/60\/60)\n            minutes = Math.floor(seconds_difference\/60) - (hours * 60)\n            seconds = seconds_difference - (minutes * 60) - (hours * 60 * 60)\n\n            return {\n               timedelta: true\n               hours: hours\n               minutes: minutes\n               seconds: seconds\n            }\n\n\nThis is just a helper function\n\n        in_array = (arr, _) -> arr.indexOf(_) != -1\n\n```progressive_match``` is useful for matching abbreviations\nand full spellings. Functions like this could be useful\nto help parse fuzzy matches in the future (i.e. misspellings of months).\n\n        progressive_match = (string, possibilities) ->\n            part = \"\"\n            if not string? then return\n            for character in string.toLowerCase()\n                part += character\n                matches = []\n                for month, value of possibilities\n                    if month.indexOf(part) > -1\n                        matches.push(month)\n                if matches.length == 1\n                    return possibilities[matches[0]]\n### Types\n\nThe heading above is the heading in the python source.\nI actually don't know if it's referring to collections of expressions\nor capture groups.\n\n        month_to_number = (month_string) ->\n          months =\n              \"january\": 1\n              \"february\": 2\n              \"march\": 3\n              \"april\": 4\n              \"may\": 5\n              \"june\": 6\n              \"july\": 7\n              \"august\": 8\n              \"september\": 9\n              \"october\": 10\n              \"november\": 11\n              \"december\": 12\n           return progressive_match(month_string, months)\n\n        weekday_to_number = (WeekdayString ) ->\n            weekday_list = {\n                \"monday\": 0,\n                \"tuesday\": 1,\n                \"wednesday\": 2,\n                \"thursday\": 3,\n                \"friday\": 4,\n                \"saturday\": 5,\n                \"sunday\": 6,\n            }\n            return progressive_match(WeekdayString, weekday_list)\n\nI serialize am_pm by converting the hours to milliary\/24-hour time format.\nI also include ```am_pm: 'pm'``` in the date format to show that that transformation\nwas done. Making that clear helpful because if you get a time like 1, with no ```am_pm```\ndesignation you might want to assume pm and add 12. This is not done in the libary because\ndate_machine strives for honesty, not guesswork.\n\n        am_pm = (input) ->\n            if not input?\n              return\n            if input.toLowerCase() == \"am\" then 0\n            else if input.toLowerCase() == \"pm\" then 12\n\nYou can see in this function that I try not to repeat logic and use other\nfunctions. In this case I might have been able to simply put time_expression\nin the functions hash\/object, but in python it makes a difference due to named arguments.\nI'm going to leave it as-is for clarity.\n\n        military_time = (MilHour, MilMinute, MilSecond ) ->\n            return time_expression(MilHour, MilMinute, MilSecond, undefined)\n\nHere is the ampm conversion. I omit returns when the expressions are simple,\nbut later on I want to use them as much as possible to make my intentions clear.\n\n        noon = (hour, AMPM) -> hour == 12 and AMPM == 12\n        midnight = (hour, AMPM) -> hour == 12 and AMPM == 0\n\n        time_expression = (Hour, Minute, Second, AMPM, SpecialTimeText ) ->\n            if not Hour? and not Minute? and not Second? and not AMPM? and not SpecialTimeText?\n                return\n            if SpecialTimeText\n                if SpecialTimeText.toLowerCase() == \"noon\"\n                    return {hour: 12}\n                if SpecialTimeText.toLowerCase() == \"midnight\"\n                    return {hour: 0}\n            d = {}\n            if Hour\n                d.hour = Number(Hour)\n            if Minute\n                d.minute = Number(Minute)\n            if Second\n                d.second = Number(Second)\n            if AMPM?\n                if d.hour\n                    if noon(d.hour, AMPM)\n                        d.hour = 12\n                    else if midnight(d.hour, AMPM)\n                        d.hour = 0\n                    else\n                        d.hour = d.hour + AMPM\n                d.am_pm = AMPM\n            if [d.hour, d.minute, d.second] == [undefined, undefined, undefined]\n                return undefined\n            return d\n\n\n        time_and_time = (Hour, Minute, AMPM1, Hour2, Minute2, AMPM2) ->\n            if AMPM2?\n                AMPM2 = am_pm(AMPM2)\n            if not AMPM1? and not AMPM2?\n                return [time_expression(Hour, Minute), time_expression(Hour2, Minute2)]\n            else if not AMPM1?\n                return [time_expression(Hour, Minute, undefined, AMPM2),\n                        time_expression(Hour2, Minute2, undefined, AMPM2)]\n            else if not AMPM2?\n                return [time_expression(Hour, Minute, undefined, AMPM1),\n                        time_expression(Hour2, Minute2, undefined, AMPM1)]\n\n\n        month_type = (input...) ->\n            for value in input\n                if value?\n                    return Number(value)\n\n\n        date_number = (Day, Abbr) -> if Day? then Number(Day)\n\n        month_number = (MonthNum) -> Number(MonthNum)\n\n        month_num_type = (input) -> Number(input)\n\n        year = (Year) -> if Year? then Number(Year)\n\nSometimes the value is [undefined, undefined, <value>],\nso I need to search for it and find it.\n\n        get_first_defined = (_) ->\n          for item in _\n            if item?\n              return item\n\n### Patterns\n\nThere's a some unwrapping values out of arrays here.\nBecause of the namedarguments issue functions receive a lot more\narrays then in Python and so they need to be unwrapped.\n\n        weekday_range_with_time = (time1, time2, [weekday1], [weekday2], MonthRange) ->\n            output = []\n\n            # Get first undefined value\n            # Since only one value in list will be defined (if any)\n            time1 = get_first_defined(time1)\n            time2 = get_first_defined(time2)\n\n            if time1?\n                for date in MonthRange\n                    output.push(_replace(date, time1))\n                    if time2?\n                        output.push(_replace(date, time2))\n            return output\n\n\n        weekday_range_with_extra = ( time, and_time, weekday_start, weekday_end, extra_time, extra_weekday, MonthRange) ->\n            output = []\n            if time?\n                for date in MonthRange\n                    if date.weekday?\n                        if date.weekday in [weekday_start .. weekday_end]\n                            output.push(_replace(date, time))\n                            if and_time?\n                                output.push(_replace(date, and_time))\n                        if date.weekday == extra_weekday\n                            output.push(_replace(date, extra_time))\n            return output\n\n\n        weekday_range_with_extra_backwards = (extra_time, extra_weekday, time, weekday_start, weekday_end, MonthRange ) ->\n            return weekday_range_with_extra(time[0], time[1], weekday_start, weekday_end, extra_time, extra_weekday, MonthRange )\n\n\n        reverse_basic_text = (time, day, month, year) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        basic_text = (time, first_second, weekday, month, day, year) ->\n            if not day?\n                day = 1\n            if (day instanceof Array) and day.length == 1\n              day = day[0]\n            if (year instanceof Array) and year.length == 1\n              year = year[0]\n            if not time?\n                return {year: year, month: month, day: day}\n            else\n                year: year\n                month: month\n                day: day\n                hour: time.hour\n                minute: time.minute\n                second: time.second\n                am_pm: time.am_pm\n\n\n        slash = (month, day, year, time) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        month_range = (month, date_a, date_b) ->\n            output = []\n            for day in [date_a .. date_b]\n                output.push(basic_text(undefined, undefined, undefined, month, day, undefined))\n            return output\n\n\n        multi_time = (time1, BasicText) ->\n            output = []\n            if time1? and BasicText?\n                output.push(_replace(BasicText, time1))\n                output.push(BasicText)\n                return output\n\n\n        large_repeat_words = ->\n            return undefined\n\n\n        weekday_range_with_time_range = (time1, weekday_range) ->\n            output = []\n            if time1? and weekday_range?\n                range = timedelta_from_Date(_replace(weekday_range[0], time1), weekday_range[0])\n                for weekday in weekday_range\n                    output.push(_replace(weekday, {hour:time1.hour, minute:time1.minute, am_pm:time1.am_pm}))\n                    output.push(range)\n                return output\n\n\n        time_range = (unstrict_time, strict_time, date, reverse) ->\n            endtime = date\n            starttime = endtime\n            if unstrict_time\n                starttime = _replace(starttime, {hour:Number(unstrict_time[0])})\n                if date.am_pm\n                    starttime = _replace(starttime, {hour: starttime.hour + date.am_pm, am_pm:date.am_pm})\n            else\n                starttime = _replace(starttime, {hour: strict_time.hour, minute: strict_time.minute})\n\n            time_range = timedelta_from_Date(starttime, endtime)\n            if reverse\n                time_range = timedelta_from_Date(endtime, starttime)\n            return [starttime, time_range]\n\n\n        alt_time_range = (first_second, weekday, month, day, year, time, unstrict_time, strict_time) ->\n            return time_range(unstrict_time, strict_time, basic_text(time, first_second, weekday, month, day, year), reverse)\n\n\n        until_range = (date1, date2) ->\n            if date1 and date2\n                return [date1, timedelta_from_Date(date1, date2)]\n\n\n        through_range = (time, weekday1, weekday2, month, date, beginning) ->\n            output = []\n            if month and date and beginning and weekday1\n                ending =\n                    month: month\n                    day: date\n                for day in [beginning.day .. ending.day]\n                    temp =\n                        month: month\n                        day: date\n                    if temp.weekday and in_array([weekday1 .. weekday2], temp.weekday)\n                        if time\n                            output.push(_replace(temp, time))\n                        else\n                            output.push(temp)\n                return output\n\n\n### The function list\n\nThis hash\/object matches all the functions with a\nstring that represents it in the parse tree.\n\n        functions =\n            # Groups\n            \"MonthString\": month_to_number,\n            \"AMPM\": am_pm,\n            # Expressions\n            \"Chase Year\": year,\n            \"Chase Date\": date_number,\n            \"Chase Month\": month_number,\n            \"Steve Valaitis\": time_expression,\n            \"Greg Burns\": (hour, am_pm) -> time_expression(hour, null, null, am_pm, null),\n            \"Greg Burns UnstrictTime:\": time_expression,\n            \"Steve Valaitis2\": military_time,\n            \"Steve Valaitis And Time\": time_and_time,\n            \"Text Parts\": time_expression,\n            \"Michael Ash10\": weekday_to_number,\n            # Types\n            \"Month\": month_type,\n            \"MonthNum\": month_num_type,\n            # Patterns\n            \"LargeRepeatWords\": large_repeat_words,\n            \"BasicText\": basic_text,\n            \"ReverseBasicText\": reverse_basic_text,\n            \"Slash\": slash,\n            \"MonthRange\": month_range,\n            \"MultiTime\": multi_time,\n            \"WeekdayRangeWithTime\": weekday_range_with_time,\n            \"WeekdayRangeWithExtra\": weekday_range_with_extra,\n            \"WeekdayRangeWithExtraBackwards\": weekday_range_with_extra_backwards,\n            \"WeekdayRangeWithTimeRange\": weekday_range_with_time_range,\n            \"UntilRange\": until_range,\n            \"ThroughRange\": through_range,\n            \"TimeRange\": time_range,\n            \"AltTimeRange\": alt_time_range,\n\nThis is default expression or pattern. ```any``` means\nif value is defined, and there is array with even a single defined value then return true.\n\n            \"_default\": (_) ->\n                if any(_) then _ else undefined\n\n```Type``` there is used to mean collection of expressions.\nI know that because only one will match, so you just have to find\nit and return it.\n\n            \"_default_type\": (_...) ->\n                if _?\n                    for item in _\n                         if item?\n                             return item\n\n            \"_default_group\": (_...) -> if _[0]? then _[0]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c841cf631f724ceec02b171bded7ee5af45dba06","subject":"fixes #64, make yang-js to support windows platform. (#82)","message":"fixes #64, make yang-js to support windows platform. (#82)\n\nAwesome, thanks @quantang!","repos":"corenova\/yang-js","old_file":"src\/yang.litcoffee","new_file":"src\/yang.litcoffee","new_contents":"# Yang - evaluable schema expression\n\nThis module provides support for basic set of YANG schema modeling\nlanguage by using the built-in *extension* syntax to define additional\nschema language constructs. The actual YANG language [RFC\n6020](http:\/\/tools.ietf.org\/html\/rfc6020) specifications are loaded\ninside the [main module](.\/main.coffee).\n\nThis module is the **primary interface** for consumers of this\nlibrary.\n\n## Dependencies\n \n    debug  = require('debug')('yang:schema') if process.env.DEBUG?\n    fs     = require 'fs'\n    path   = require 'path'\n    parser = require 'yang-parser'\n    indent = require 'indent-string'\n\n    Expression = require '.\/expression'\n    XPath = require '.\/xpath'\n\n## Class Yang\n\n    class Yang extends Expression\n      @scope:\n        extension: '0..n'\n        typedef:   '0..n'\n        module:    '0..n'\n        submodule: '0..n'\n\n## Class-level methods\n\n      @clear: ->\n        @module.splice(0,@module.length) if @module?\n        @submodule.splice(0,@submodule.length) if @submodule?\n\n### parse (schema)\n\nThis class-level routine performs recursive parsing of passed in\nstatement and sub-statements. It provides syntactic, semantic and\ncontextual validations on the provided schema and returns the final JS\nobject tree structure as hierarchical Yang expression instances.\n\nIf any validation errors are encountered, it will throw the\nappropriate error along with the context information regarding the\nerror.\n\n      @parse: (schema, opts={}) ->\n        opts.compile ?= true\n        try\n          schema = parser.parse schema if typeof schema is 'string'\n        catch e\n          e.offset = 50 unless e.offset > 50\n          offender = schema.slice e.offset-50, e.offset+50\n          offender = offender.replace \/\\s\\s+\/g, ' '\n          throw @error \"invalid YANG syntax detected around: '#{offender}'\", offender\n\n        unless schema instanceof Object\n          throw @error \"must pass in valid YANG schema\", schema\n\n        kind = switch\n          when !!schema.prf then \"#{schema.prf}:#{schema.kw}\"\n          else schema.kw\n        tag = schema.arg unless schema.arg is false\n\t\t\n        schema = (new this kind, tag).extends schema.substmts.map (x) => @parse x, compile: false\n        # perform final scoped constraint validation\n        for kind, constraint of schema.scope when constraint in [ '1', '1..n' ]\n          unless schema.hasOwnProperty kind\n            throw schema.error \"constraint violation for required '#{kind}' = #{constraint}\"\n        schema.compile() if opts.compile\n        return schema\n\nFor comprehensive overview on currently supported YANG statements,\nplease refer to\n[Compliance Report](..\/test\/yang-compliance-coverage.md) for the latest\n[RFC 6020](http:\/\/tools.ietf.org\/html\/rfc6020) YANG specification\ncompliance.\n\n### compose (data [, opts={}])\n\nThis call *accepts* any arbitrary JS object and it will attempt to\nconvert it into a structural `Yang` expression instance. It will\nanalyze the passed in JS data and perform best match mapping to an\nappropriate YANG schema representation to describe the input\ndata. This method will not be able to determine conditionals or any\nmeta-data to further constrain the data, but it should provide a good\nstarting point with the resulting `Yang` expression instance.\n\n      @compose: (data, opts={}) ->\n        unless data?\n          throw @error \"must supply input 'data' to compose\"\n\n        # explict compose\n        if opts.kind?\n          ext = Yang::lookup.call this, 'extension', opts.kind\n          unless ext instanceof Expression\n            throw @error \"unable to find requested '#{opts.kind}' extension\"\n          return ext.compose? data, opts\n\n        # implicit compose (dynamic discovery)\n        for ext in @extension when ext.compose instanceof Function\n          debug? \"checking data if #{ext.tag}\"\n          res = ext.compose data, opts\n          return res if res instanceof Yang\n\nThis facility is a powerful construct to dynamically generate `Yang`\nschema from ordinary JS objects. For additional usage examples, please\nrefer to [Dynamic Composition](..\/TUTORIAL.md#dynamic-composition)\nsection in the [Getting Started Guide](..\/TUTORIAL.md).\n\n### resolve (from..., name)\n\nThis call is internally used by [import](#import-name-opts) to perform\na search within the local filesystem to locate a given YANG schema\nmodule by `name`. It will first check the calling code's local\n[package.json](..\/package.json) to look for a `yang: { resolve: {} }`\nconfiguration section to identify where the target module can be\nfound. If there is an entry defined, it will then follow that\nreference - which may be a JS file, YANG schema text file, or another\nNPM module. If it is not found within the `yang: { resolve: {} }`\nconfiguration block or it fails to load the referenced dependency, it\nwill then fallback to attempt to locate a YANG schema text file in the\nsame folder that the `resolve` request was made: `#{name}.yang`.\n\n      @resolve: (from..., name) ->\n        return null unless typeof name is 'string'\n        dir = from = switch\n          when from.length then from[0]\n          else path.resolve()\n        while not found? and dir != path.dirname dir\n          target = path.resolve dir, \"package.json\"\n          debug? \"[resolve] #{name} in #{target}\"\n          try\n            pkginfo = require(target)\n            found = pkginfo.yang?.resolve?[name] ? pkginfo.models[name]\n          if found?\n            dir = path.dirname require.resolve(target)\n            debug? \"[resolve] #{name} check #{found} in #{dir}\"\n            unless !!path.extname found\n              from = switch\n                when found of pkginfo.dependencies\n                  path.resolve dir, 'node_modules', found\n                else path.resolve dir, found\n              if fs.existsSync from\n                return @resolve from, name\n              else\n                found = @resolve found, name\n          if not found? and pkginfo?.name is name\n            found = path.dirname require.resolve(target)\n          dir = path.dirname dir unless found?\n        file = switch\n          when not found? then path.resolve from, \"#{name}.yang\"\n          else path.resolve dir, found\n        debug? \"[resolve] checking if #{file} exists\"\n        return if fs.existsSync file then file else null\n\n### import (name [, opts={}])\n\nThis call provides a convenience mechanism for dealing with YANG\nschema module dependencies. It performs parsing of the YANG schema\ncontent from the specified `name` and saves the generated `Yang`\nexpression inside the internal registry. The `name` can be a YANG\nmodule name or a *filename* to the actual schema content (JS or YANG).\n\nOnce a given YANG module has been saved inside the registry,\nsubsequent [parse](#parse-schema) of YANG schema that *import* the\nsaved module will successfully resolve.\n\nTypical usage scenario for this pattern is to internally define common\nmodules such as `ietf-yang-types` which can then be *imported* by\nother schemas.\n\nIt will also return the new `Yang` expression instance (to do with as\nyou please).\n\n      @import: (name, opts={}) ->\n        return unless name?\n        opts.basedir ?= ''\n        extname  = path.extname name\n        filename = path.resolve opts.basedir, name\n        basedir  = path.dirname filename\n\n        unless !!extname\n          return (Yang::match.call this, 'module', name) ? @import (@resolve name), opts\n\n        unless extname is '.yang'\n          res = require filename\n          unless res instanceof Yang\n            throw @error \"unable to import '#{name}' from '#{filename}' (not Yang expression)\", res\n          return res \n\n        try return @use (@parse (fs.readFileSync filename, 'utf-8'), opts)\n        catch e\n          debug? e\n          unless opts.compile and e.name is 'ExpressionError' and e.context.kind in [ 'include', 'import' ]\n            console.error \"unable to parse '#{name}' YANG module from '#{filename}'\"\n            throw e\n          if e.context.kind is 'include'\n            opts = Object.assign {}, opts\n            opts.compile = false \n\n          # try to find the dependency module for import\n          dependency = @import (@resolve basedir, e.context.tag), opts\n          unless dependency?\n            e.message = \"unable to auto-resolve '#{e.context.tag}' dependency module\"\n            throw e\n          unless dependency.tag is e.context.tag\n            e.message = \"found mismatching module '#{dependency.tag}' while resolving '#{e.context.tag}'\"\n            throw e\n\n          # retry the original request\n          debug? \"retrying import(#{name})\"\n          return @import arguments...\n\nPlease note that this method will look for the `name` in current\nworking directory of the script execution if the `name` is a relative\npath. It utilizes the [resolve](#resolve-from-name) method and will\nattempt to **recursively** resolve any failed `import` dependencies.\n\nWhile this is a convenient abstraction, it is **recommended** to\ndirectly use the Node.js built-in `require` mechanism (if\navailable). Using native `require` instead of `Yang.import` will\nallow package bundlers such as `browserify` to capture the\ndependencies as part of the produced bundle.  It also allows you to\ndirectly load YANG schema files from other NPM modules.\n\nBy default, loading the [yang-js](.\/main.coffee) module will attempt\nto associate `.yang` extension inside `require` facility. If\navailable, it will allow you to `require('.\/some-dependency.yang')`\nand get back a parsed `Yang expression` instance.\n\n## Main constructor\n\nThis method can be called directly without the use of `new` keyword\nand will internally parse the provided schema and return a `bound\nfunction` which will invoke [eval](#eval-data-opts) when called.\n\n      constructor: (kind, tag, extension) ->\n        unless this instanceof Yang\n          [ schema, bindings ] = arguments\n          schema = Yang.parse schema unless schema instanceof Yang\n          return schema.bind bindings\n\n        extension ?= (@lookup 'extension', kind)\n        self = super kind, tag, extension\n        unless extension instanceof Expression\n          @debug \"defer processing of custom extension #{kind}\"\n          @once 'compile:before', (->\n            @debug \"processing deferred extension #{kind}\"\n            extension = (@lookup 'extension', kind)\n            unless extension instanceof Yang\n              throw @error \"encountered unknown extension '#{kind}'\"\n            { @source, @argument } = extension\n          ).bind self\n        return self\n\n      @property 'datakey',\n        get: -> switch\n          when @parent instanceof Yang and @parent.kind is 'module' then \"#{@parent.tag}:#{@tag}\"\n          when @parent instanceof Yang and @parent.kind is 'submodule'\n            \"#{@parent['belongs-to'].tag}:#{@tag}\"\n          else @tag ? @kind\n\n      @property 'datapath',\n        get: -> switch\n          when @parent not instanceof Yang then ''\n          when @node then @parent.datapath + \"\/#{@datakey}\"\n          else @parent.datapath + \"\/#{@kind}(#{@datakey})\"\n                  \n      error: (msg, context) -> super \"[#{@trail}] #{msg}\", context\n      \n      emit: (event, args...) ->\n        @emitter.emit arguments...\n        @root.emit event, this if event is 'change' and this isnt @root\n\n## Instance-level methods\n\n### bind (obj)\n\nEvery instance of `Yang` expression can be *bound* with control logic\nwhich will be used during [eval](#eval-data-opts) to produce schema\ninfused **adaptive data object**. This routine is *inherited* from\n[Class Expression](.\/expression.coffee).\n\nThis facility can be used to associate default behaviors for any\nelement in the configuration tree, as well as handler logic for\nvarious YANG statements such as *rpc*, *feature*, etc.\n\nThis call will return the original `Yang` expression instance with the\nnew bindings registered within the `Yang` expression hierarchy.\n\n      # bind() is inherited from Expression\n\nPlease refer to [Schema Binding](..\/TUTORIAL.md#schema-binding)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n### eval (data, opts={})\n\nEvery instance of `Yang` expression can be [eval](#eval-data-opts)\nwith arbitrary JS data input which will apply the schema against the\nprovided data and return a schema infused **adaptive** data object.\n\nThis is an extremely useful construct which brings out the true power\nof YANG for defining and governing arbitrary JS data structures.\n\nBasically, the input `data` will be YANG schema validated and\nconverted to a schema infused *adaptive data model* that dynamically\ndefines properties according to the schema expressions.\n\nIt currently supports the `opts.adaptive` parameter (default `false`)\nwhich establishes a persistent binding relationship with the governing\n`Yang` expression instance. This allows the generated model to\ndynamically **adapt** to any changes to the governing `Yang`\nexpression instance. Refer to below [extends](#extends-schema) section\nfor additional info on how the schema can be programmatically\nmodified.\n\n      eval: (data, opts={}) ->\n        if opts.adaptive is true\n          # TODO: this will break for 'module' which will return Model?\n          @once 'change', arguments.callee.bind(this, data, opts)\n        super\n\nPlease refer to [Working with Models](..\/TUTORIAL.md#working-with-models)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for special\nusage examples for `module` schemas.\n\n### validate (data, opts={})\n\nPerform schema correctness validation for the passed in `data`.  This\ndiffers from [eval](#eval-data-opts) in that the final data returned\nis not infused as dynamic data model using Property instances. It\nshould be used to perform a sanity check on the data if it will not\nbe programmatically modified.\n\nFor example, [Property](.\/property.litcoffee) instance uses `validate`\nwhen dealing with non-configurable data nodes `config false`. \n\n      validate: (data, ctx={}) ->\n        # XXX - for now, we just do the full apply...\n        return @apply data, ctx\n        \n        @compile() unless @resolved\n        debug? \"[#{@trail}] validating data to schema\"\n\n        try @predicate?.call this, data\n        catch e\n          throw @error \"predicate validation error: #{e}\", data\n\n        if @kind is 'list' and Array.isArray data\n          data = data.map (item) =>\n            if Array.isArray item\n              throw @error \"list item cannot be another array\"\n            @validate item\n        else\n          # TODO: consider appending '..' property here?\n          data[node.datakey] = node.validate data[node.datakey] for node in @nodes when data?\n\n        unless @nodes.length\n          data = this.apply data, ctx\n        else\n          data = attr.apply data, ctx for attr in @attrs\n          \n        return data\n\n### extends (schema...)\n\nEvery instance of `Yang` expression can be `extends` with additional\nYANG schema string(s) and it will automatically perform\n[parse](#parse-schema) of the provided schema text and update itself\naccordingly.\n\nThis action also triggers an event emitter which will *retroactively*\nadapt any previously [eval](#eval-data-opts) produced adaptive data\nmodel instances to react accordingly to the newly changed underlying\nschema expression(s).\n\n      # extends() is inherited from Element\n\n      merge: (elem) ->\n        unless elem instanceof Yang\n          throw @error \"cannot merge invalid element into Yang\", elem\n\n        switch elem.kind\n          when 'type'     then super elem, append: true\n          when 'argument' then super elem, replace: true\n          else super\n\nPlease refer to [Schema Extension](..\/TUTORIAL.md#schema-extension)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n      normalizePath: (ypath) ->\n        lastPrefix = null\n        prefix2module = (root, prefix) ->\n          return unless root.kind is 'module'\n          switch\n            when root.tag is prefix then prefix\n            when root.prefix.tag is prefix then root.tag\n            else\n              for m in root.import ? [] when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              modules = root.lookup 'module'\n              for m in modules when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              return prefix # return as-is...\n              \n        normalizeEntry = (x) =>\n          return x unless x? and !!x\n          match = x.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)(?:\\[.+\\])?$\/\n          unless match?\n            throw @error \"invalid path expression '#{x}' found in #{ypath}\"\n          [ prefix, target ] = [ match[1], match[2] ]\n          return switch\n            when not prefix? then target\n            when prefix is lastPrefix then target\n            else\n              lastPrefix = prefix\n              mname = prefix2module @root, prefix\n              \"#{mname}:#{target}\"\n        ypath = ypath.replace \/\\s\/g, ''\n        res = XPath.split(ypath).map(normalizeEntry).join('\/')\n        res = '\/' + res if \/^\\\/\/.test ypath\n        return res\n\n### locate (ypath)\n\nThis is an internal helper facility used to locate a given schema node\nwithin the `Yang` schema expression tree hierarchy. It supports a\nlimited version of XPATH-like expression to locate an explicit\nelement.\n\n      locate: (ypath) ->\n        # TODO: figure out how to eliminate duplicate code-block section\n        # shared with Element\n        return unless ypath?\n        \n        @debug \"locate enter for '#{ypath}'\"\n        if typeof ypath is 'string'\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = @normalizePath(ypath).split('\/').filter (e) -> !!e\n        else\n          [ key, rest... ] = ypath\n        return this unless key? and key isnt '.'\n\n        if key is '..'\n          return @parent?.locate rest\n\n        match = key.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n        [ prefix, target ] = [ match[1], match[2] ]\n        if prefix? and this is @root\n          search = [target].concat(rest)\n          if (@tag is prefix) or (@lookup 'prefix', prefix)\n            @debug \"locate (local) '\/#{prefix}:#{search.join('\/')}'\"\n            return super search\n          for m in @import ? [] when m.tag is prefix or m.prefix.tag is prefix\n            @debug \"locate (external) '\/#{prefix}:#{search.join('\/')}'\"\n            return m.module.locate search\n          m = @lookup 'module', prefix\n          return m?.locate search\n\n        switch\n          when \/^{.+}$\/.test(target)\n            kind = 'grouping'\n            tag  = target.replace \/^{(.+)}$\/, '$1'\n          when \/^\\[.+\\]$\/.test(target)\n            kind = 'feature'\n            tag  = target.replace \/^\\[(.+)\\]$\/, '$1'\n          when \/^[^(]+\\([^)]*\\)$\/.test(target)\n            target = target.match \/^([^(]+)\\((.*)\\)$\/\n            [ kind, tag ] = [ target[1], target[2] ]\n            tag = undefined unless !!tag\n          when \/^\\<.+\\>$\/.test(target)\n            target = target.replace \/^\\<(.+)\\>$\/, '$1'\n            [ kind..., tag ]  = target.split ':'\n            [ tag, selector ] = tag.split '='\n            kind = kind[0] if kind?.length\n          else return super [key].concat rest\n            \n        match = @match kind, tag\n        return switch\n          when rest.length is 0 then match\n          else match?.locate rest\n\n### match (kind, tag)\n\nThis is an internal helper facility used by [locate](#locate-ypath) and\n[lookup](.\/element.litcoffee#lookup-kind-tag) to test whether a given\nentity exists in the local schema tree.\n\n      # Yang Expression can support 'tag' with prefix to another module\n      # (or itself).\n      match: (kind, tag) ->\n        return super unless kind? and tag? and typeof tag is 'string'\n        res = super\n        return res if res?\n        \n        [ prefix..., arg ] = tag.split ':'\n        return unless prefix.length\n\n        debug? \"[match] with #{kind} #{tag}\"\n\n        prefix = prefix[0]\n        debug? \"[match] check if current module's prefix\"\n        if @root.tag is prefix or @root.prefix?.tag is prefix\n          return @root.match kind, arg\n\n        debug? \"[match] checking if submodule's parent\"\n        ctx = @lookup 'belongs-to'\n        if ctx?.prefix.tag is prefix\n          return ctx.module.match kind, arg \n\n        debug? \"[match] check if one of current module's imports\"\n        imports = @root?.import ? []\n        for m in imports when m.prefix.tag is prefix\n          debug? \"[match] checking #{m.module.tag}\"\n          return m.module.match kind, arg\n\n        debug? \"[match] check if one of available modules\"\n        module = @lookup 'module', prefix\n        return module.match kind, arg if module?\n\n### toString (opts={})\n\nThe current `Yang` expression will covert back to the equivalent YANG\nschema text format.\n\nAt first glance, this may not seem like a useful facility since YANG\nschema text is *generally known* before [parse](#parse-schema) but it\nbecomes highly relevant when you consider a given `Yang` expression\nprogramatically changing via [extends](#extends-schema).\n\nCurrently it supports `space` parameter which can be used to specify\nnumber of spaces to use for indenting YANG statement blocks.  It\ndefaults to **2** but when set to **0**, the generated output will\nomit newlines and other spacing for a more compact YANG output.\n\n      toString: (opts={ space: 2 }) ->\n        s = @kind\n        if @source.argument?\n          s += ' ' + switch @source.argument\n            when 'value' then \"'#{@tag}'\"\n            when 'text'\n              \"\\n\" + (indent '\"'+@tag+'\"', ' ', opts.space)\n            else @tag\n        sub =\n          @elements\n            .filter (x) => x.parent is this\n            .map (x) -> x.toString opts\n            .join \"\\n\"\n        if !!sub\n          s += \" {\\n\" + (indent sub, ' ', opts.space) + \"\\n}\"\n        else\n          s += ';'\n        return s\n\n### toJSON\n\nThe current `Yang` expression will convert into a simple JS object\nformat.\n\n      # toJSON() is inherited from Element\n\n### valueOf\n\nThe current 'Yang' expression will convert into a primitive form for\ncomparision purposes.\n\n      valueOf: ->\n        switch @source.argument\n          when 'value','text' then @tag.valueOf()\n          else this\n\nPlease refer to [Schema Conversion](..\/TUTORIAL.md#schema-conversion)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n## Export Yang Class\n\n    module.exports = Yang\n","old_contents":"# Yang - evaluable schema expression\n\nThis module provides support for basic set of YANG schema modeling\nlanguage by using the built-in *extension* syntax to define additional\nschema language constructs. The actual YANG language [RFC\n6020](http:\/\/tools.ietf.org\/html\/rfc6020) specifications are loaded\ninside the [main module](.\/main.coffee).\n\nThis module is the **primary interface** for consumers of this\nlibrary.\n\n## Dependencies\n \n    debug  = require('debug')('yang:schema') if process.env.DEBUG?\n    fs     = require 'fs'\n    path   = require 'path'\n    parser = require 'yang-parser'\n    indent = require 'indent-string'\n\n    Expression = require '.\/expression'\n    XPath = require '.\/xpath'\n\n## Class Yang\n\n    class Yang extends Expression\n      @scope:\n        extension: '0..n'\n        typedef:   '0..n'\n        module:    '0..n'\n        submodule: '0..n'\n\n## Class-level methods\n\n      @clear: ->\n        @module.splice(0,@module.length) if @module?\n        @submodule.splice(0,@submodule.length) if @submodule?\n\n### parse (schema)\n\nThis class-level routine performs recursive parsing of passed in\nstatement and sub-statements. It provides syntactic, semantic and\ncontextual validations on the provided schema and returns the final JS\nobject tree structure as hierarchical Yang expression instances.\n\nIf any validation errors are encountered, it will throw the\nappropriate error along with the context information regarding the\nerror.\n\n      @parse: (schema, opts={}) ->\n        opts.compile ?= true\n        try\n          schema = parser.parse schema if typeof schema is 'string'\n        catch e\n          e.offset = 50 unless e.offset > 50\n          offender = schema.slice e.offset-50, e.offset+50\n          offender = offender.replace \/\\s\\s+\/g, ' '\n          throw @error \"invalid YANG syntax detected around: '#{offender}'\", offender\n\n        unless schema instanceof Object\n          throw @error \"must pass in valid YANG schema\", schema\n\n        kind = switch\n          when !!schema.prf then \"#{schema.prf}:#{schema.kw}\"\n          else schema.kw\n        tag = schema.arg unless schema.arg is false\n\t\t\n        schema = (new this kind, tag).extends schema.substmts.map (x) => @parse x, compile: false\n        # perform final scoped constraint validation\n        for kind, constraint of schema.scope when constraint in [ '1', '1..n' ]\n          unless schema.hasOwnProperty kind\n            throw schema.error \"constraint violation for required '#{kind}' = #{constraint}\"\n        schema.compile() if opts.compile\n        return schema\n\nFor comprehensive overview on currently supported YANG statements,\nplease refer to\n[Compliance Report](..\/test\/yang-compliance-coverage.md) for the latest\n[RFC 6020](http:\/\/tools.ietf.org\/html\/rfc6020) YANG specification\ncompliance.\n\n### compose (data [, opts={}])\n\nThis call *accepts* any arbitrary JS object and it will attempt to\nconvert it into a structural `Yang` expression instance. It will\nanalyze the passed in JS data and perform best match mapping to an\nappropriate YANG schema representation to describe the input\ndata. This method will not be able to determine conditionals or any\nmeta-data to further constrain the data, but it should provide a good\nstarting point with the resulting `Yang` expression instance.\n\n      @compose: (data, opts={}) ->\n        unless data?\n          throw @error \"must supply input 'data' to compose\"\n\n        # explict compose\n        if opts.kind?\n          ext = Yang::lookup.call this, 'extension', opts.kind\n          unless ext instanceof Expression\n            throw @error \"unable to find requested '#{opts.kind}' extension\"\n          return ext.compose? data, opts\n\n        # implicit compose (dynamic discovery)\n        for ext in @extension when ext.compose instanceof Function\n          debug? \"checking data if #{ext.tag}\"\n          res = ext.compose data, opts\n          return res if res instanceof Yang\n\nThis facility is a powerful construct to dynamically generate `Yang`\nschema from ordinary JS objects. For additional usage examples, please\nrefer to [Dynamic Composition](..\/TUTORIAL.md#dynamic-composition)\nsection in the [Getting Started Guide](..\/TUTORIAL.md).\n\n### resolve (from..., name)\n\nThis call is internally used by [import](#import-name-opts) to perform\na search within the local filesystem to locate a given YANG schema\nmodule by `name`. It will first check the calling code's local\n[package.json](..\/package.json) to look for a `yang: { resolve: {} }`\nconfiguration section to identify where the target module can be\nfound. If there is an entry defined, it will then follow that\nreference - which may be a JS file, YANG schema text file, or another\nNPM module. If it is not found within the `yang: { resolve: {} }`\nconfiguration block or it fails to load the referenced dependency, it\nwill then fallback to attempt to locate a YANG schema text file in the\nsame folder that the `resolve` request was made: `#{name}.yang`.\n\n      @resolve: (from..., name) ->\n        return null unless typeof name is 'string'\n        dir = from = switch\n          when from.length then from[0]\n          else path.resolve()\n        while not found? and dir not in [ '\/', '.' ]\n          target = \"#{dir}\/package.json\"\n          debug? \"[resolve] #{name} in #{target}\"\n          try\n            pkginfo = require(target)\n            found = pkginfo.yang?.resolve?[name] ? pkginfo.models[name]\n          if found?\n            dir = path.dirname require.resolve(target)\n            debug? \"[resolve] #{name} check #{found} in #{dir}\"\n            unless !!path.extname found\n              from = switch\n                when found of pkginfo.dependencies\n                  path.resolve dir, 'node_modules', found\n                else path.resolve dir, found\n              if fs.existsSync from\n                return @resolve from, name\n              else\n                found = @resolve found, name\n          if not found? and pkginfo?.name is name\n            found = path.dirname require.resolve(target)\n          dir = path.dirname dir unless found?\n        file = switch\n          when not found? then path.resolve from, \"#{name}.yang\"\n          else path.resolve dir, found\n        debug? \"[resolve] checking if #{file} exists\"\n        return if fs.existsSync file then file else null\n\n### import (name [, opts={}])\n\nThis call provides a convenience mechanism for dealing with YANG\nschema module dependencies. It performs parsing of the YANG schema\ncontent from the specified `name` and saves the generated `Yang`\nexpression inside the internal registry. The `name` can be a YANG\nmodule name or a *filename* to the actual schema content (JS or YANG).\n\nOnce a given YANG module has been saved inside the registry,\nsubsequent [parse](#parse-schema) of YANG schema that *import* the\nsaved module will successfully resolve.\n\nTypical usage scenario for this pattern is to internally define common\nmodules such as `ietf-yang-types` which can then be *imported* by\nother schemas.\n\nIt will also return the new `Yang` expression instance (to do with as\nyou please).\n\n      @import: (name, opts={}) ->\n        return unless name?\n        opts.basedir ?= ''\n        extname  = path.extname name\n        filename = path.resolve opts.basedir, name\n        basedir  = path.dirname filename\n\n        unless !!extname\n          return (Yang::match.call this, 'module', name) ? @import (@resolve name), opts\n\n        unless extname is '.yang'\n          res = require filename\n          unless res instanceof Yang\n            throw @error \"unable to import '#{name}' from '#{filename}' (not Yang expression)\", res\n          return res \n\n        try return @use (@parse (fs.readFileSync filename, 'utf-8'), opts)\n        catch e\n          debug? e\n          unless opts.compile and e.name is 'ExpressionError' and e.context.kind in [ 'include', 'import' ]\n            console.error \"unable to parse '#{name}' YANG module from '#{filename}'\"\n            throw e\n          if e.context.kind is 'include'\n            opts = Object.assign {}, opts\n            opts.compile = false \n\n          # try to find the dependency module for import\n          dependency = @import (@resolve basedir, e.context.tag), opts\n          unless dependency?\n            e.message = \"unable to auto-resolve '#{e.context.tag}' dependency module\"\n            throw e\n          unless dependency.tag is e.context.tag\n            e.message = \"found mismatching module '#{dependency.tag}' while resolving '#{e.context.tag}'\"\n            throw e\n\n          # retry the original request\n          debug? \"retrying import(#{name})\"\n          return @import arguments...\n\nPlease note that this method will look for the `name` in current\nworking directory of the script execution if the `name` is a relative\npath. It utilizes the [resolve](#resolve-from-name) method and will\nattempt to **recursively** resolve any failed `import` dependencies.\n\nWhile this is a convenient abstraction, it is **recommended** to\ndirectly use the Node.js built-in `require` mechanism (if\navailable). Using native `require` instead of `Yang.import` will\nallow package bundlers such as `browserify` to capture the\ndependencies as part of the produced bundle.  It also allows you to\ndirectly load YANG schema files from other NPM modules.\n\nBy default, loading the [yang-js](.\/main.coffee) module will attempt\nto associate `.yang` extension inside `require` facility. If\navailable, it will allow you to `require('.\/some-dependency.yang')`\nand get back a parsed `Yang expression` instance.\n\n## Main constructor\n\nThis method can be called directly without the use of `new` keyword\nand will internally parse the provided schema and return a `bound\nfunction` which will invoke [eval](#eval-data-opts) when called.\n\n      constructor: (kind, tag, extension) ->\n        unless this instanceof Yang\n          [ schema, bindings ] = arguments\n          schema = Yang.parse schema unless schema instanceof Yang\n          return schema.bind bindings\n\n        extension ?= (@lookup 'extension', kind)\n        self = super kind, tag, extension\n        unless extension instanceof Expression\n          @debug \"defer processing of custom extension #{kind}\"\n          @once 'compile:before', (->\n            @debug \"processing deferred extension #{kind}\"\n            extension = (@lookup 'extension', kind)\n            unless extension instanceof Yang\n              throw @error \"encountered unknown extension '#{kind}'\"\n            { @source, @argument } = extension\n          ).bind self\n        return self\n\n      @property 'datakey',\n        get: -> switch\n          when @parent instanceof Yang and @parent.kind is 'module' then \"#{@parent.tag}:#{@tag}\"\n          when @parent instanceof Yang and @parent.kind is 'submodule'\n            \"#{@parent['belongs-to'].tag}:#{@tag}\"\n          else @tag ? @kind\n\n      @property 'datapath',\n        get: -> switch\n          when @parent not instanceof Yang then ''\n          when @node then @parent.datapath + \"\/#{@datakey}\"\n          else @parent.datapath + \"\/#{@kind}(#{@datakey})\"\n                  \n      error: (msg, context) -> super \"[#{@trail}] #{msg}\", context\n      \n      emit: (event, args...) ->\n        @emitter.emit arguments...\n        @root.emit event, this if event is 'change' and this isnt @root\n\n## Instance-level methods\n\n### bind (obj)\n\nEvery instance of `Yang` expression can be *bound* with control logic\nwhich will be used during [eval](#eval-data-opts) to produce schema\ninfused **adaptive data object**. This routine is *inherited* from\n[Class Expression](.\/expression.coffee).\n\nThis facility can be used to associate default behaviors for any\nelement in the configuration tree, as well as handler logic for\nvarious YANG statements such as *rpc*, *feature*, etc.\n\nThis call will return the original `Yang` expression instance with the\nnew bindings registered within the `Yang` expression hierarchy.\n\n      # bind() is inherited from Expression\n\nPlease refer to [Schema Binding](..\/TUTORIAL.md#schema-binding)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n### eval (data, opts={})\n\nEvery instance of `Yang` expression can be [eval](#eval-data-opts)\nwith arbitrary JS data input which will apply the schema against the\nprovided data and return a schema infused **adaptive** data object.\n\nThis is an extremely useful construct which brings out the true power\nof YANG for defining and governing arbitrary JS data structures.\n\nBasically, the input `data` will be YANG schema validated and\nconverted to a schema infused *adaptive data model* that dynamically\ndefines properties according to the schema expressions.\n\nIt currently supports the `opts.adaptive` parameter (default `false`)\nwhich establishes a persistent binding relationship with the governing\n`Yang` expression instance. This allows the generated model to\ndynamically **adapt** to any changes to the governing `Yang`\nexpression instance. Refer to below [extends](#extends-schema) section\nfor additional info on how the schema can be programmatically\nmodified.\n\n      eval: (data, opts={}) ->\n        if opts.adaptive is true\n          # TODO: this will break for 'module' which will return Model?\n          @once 'change', arguments.callee.bind(this, data, opts)\n        super\n\nPlease refer to [Working with Models](..\/TUTORIAL.md#working-with-models)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for special\nusage examples for `module` schemas.\n\n### validate (data, opts={})\n\nPerform schema correctness validation for the passed in `data`.  This\ndiffers from [eval](#eval-data-opts) in that the final data returned\nis not infused as dynamic data model using Property instances. It\nshould be used to perform a sanity check on the data if it will not\nbe programmatically modified.\n\nFor example, [Property](.\/property.litcoffee) instance uses `validate`\nwhen dealing with non-configurable data nodes `config false`. \n\n      validate: (data, ctx={}) ->\n        # XXX - for now, we just do the full apply...\n        return @apply data, ctx\n        \n        @compile() unless @resolved\n        debug? \"[#{@trail}] validating data to schema\"\n\n        try @predicate?.call this, data\n        catch e\n          throw @error \"predicate validation error: #{e}\", data\n\n        if @kind is 'list' and Array.isArray data\n          data = data.map (item) =>\n            if Array.isArray item\n              throw @error \"list item cannot be another array\"\n            @validate item\n        else\n          # TODO: consider appending '..' property here?\n          data[node.datakey] = node.validate data[node.datakey] for node in @nodes when data?\n\n        unless @nodes.length\n          data = this.apply data, ctx\n        else\n          data = attr.apply data, ctx for attr in @attrs\n          \n        return data\n\n### extends (schema...)\n\nEvery instance of `Yang` expression can be `extends` with additional\nYANG schema string(s) and it will automatically perform\n[parse](#parse-schema) of the provided schema text and update itself\naccordingly.\n\nThis action also triggers an event emitter which will *retroactively*\nadapt any previously [eval](#eval-data-opts) produced adaptive data\nmodel instances to react accordingly to the newly changed underlying\nschema expression(s).\n\n      # extends() is inherited from Element\n\n      merge: (elem) ->\n        unless elem instanceof Yang\n          throw @error \"cannot merge invalid element into Yang\", elem\n\n        switch elem.kind\n          when 'type'     then super elem, append: true\n          when 'argument' then super elem, replace: true\n          else super\n\nPlease refer to [Schema Extension](..\/TUTORIAL.md#schema-extension)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n      normalizePath: (ypath) ->\n        lastPrefix = null\n        prefix2module = (root, prefix) ->\n          return unless root.kind is 'module'\n          switch\n            when root.tag is prefix then prefix\n            when root.prefix.tag is prefix then root.tag\n            else\n              for m in root.import ? [] when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              modules = root.lookup 'module'\n              for m in modules when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              return prefix # return as-is...\n              \n        normalizeEntry = (x) =>\n          return x unless x? and !!x\n          match = x.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)(?:\\[.+\\])?$\/\n          unless match?\n            throw @error \"invalid path expression '#{x}' found in #{ypath}\"\n          [ prefix, target ] = [ match[1], match[2] ]\n          return switch\n            when not prefix? then target\n            when prefix is lastPrefix then target\n            else\n              lastPrefix = prefix\n              mname = prefix2module @root, prefix\n              \"#{mname}:#{target}\"\n        ypath = ypath.replace \/\\s\/g, ''\n        res = XPath.split(ypath).map(normalizeEntry).join('\/')\n        res = '\/' + res if \/^\\\/\/.test ypath\n        return res\n\n### locate (ypath)\n\nThis is an internal helper facility used to locate a given schema node\nwithin the `Yang` schema expression tree hierarchy. It supports a\nlimited version of XPATH-like expression to locate an explicit\nelement.\n\n      locate: (ypath) ->\n        # TODO: figure out how to eliminate duplicate code-block section\n        # shared with Element\n        return unless ypath?\n        \n        @debug \"locate enter for '#{ypath}'\"\n        if typeof ypath is 'string'\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = @normalizePath(ypath).split('\/').filter (e) -> !!e\n        else\n          [ key, rest... ] = ypath\n        return this unless key? and key isnt '.'\n\n        if key is '..'\n          return @parent?.locate rest\n\n        match = key.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n        [ prefix, target ] = [ match[1], match[2] ]\n        if prefix? and this is @root\n          search = [target].concat(rest)\n          if (@tag is prefix) or (@lookup 'prefix', prefix)\n            @debug \"locate (local) '\/#{prefix}:#{search.join('\/')}'\"\n            return super search\n          for m in @import ? [] when m.tag is prefix or m.prefix.tag is prefix\n            @debug \"locate (external) '\/#{prefix}:#{search.join('\/')}'\"\n            return m.module.locate search\n          m = @lookup 'module', prefix\n          return m?.locate search\n\n        switch\n          when \/^{.+}$\/.test(target)\n            kind = 'grouping'\n            tag  = target.replace \/^{(.+)}$\/, '$1'\n          when \/^\\[.+\\]$\/.test(target)\n            kind = 'feature'\n            tag  = target.replace \/^\\[(.+)\\]$\/, '$1'\n          when \/^[^(]+\\([^)]*\\)$\/.test(target)\n            target = target.match \/^([^(]+)\\((.*)\\)$\/\n            [ kind, tag ] = [ target[1], target[2] ]\n            tag = undefined unless !!tag\n          when \/^\\<.+\\>$\/.test(target)\n            target = target.replace \/^\\<(.+)\\>$\/, '$1'\n            [ kind..., tag ]  = target.split ':'\n            [ tag, selector ] = tag.split '='\n            kind = kind[0] if kind?.length\n          else return super [key].concat rest\n            \n        match = @match kind, tag\n        return switch\n          when rest.length is 0 then match\n          else match?.locate rest\n\n### match (kind, tag)\n\nThis is an internal helper facility used by [locate](#locate-ypath) and\n[lookup](.\/element.litcoffee#lookup-kind-tag) to test whether a given\nentity exists in the local schema tree.\n\n      # Yang Expression can support 'tag' with prefix to another module\n      # (or itself).\n      match: (kind, tag) ->\n        return super unless kind? and tag? and typeof tag is 'string'\n        res = super\n        return res if res?\n        \n        [ prefix..., arg ] = tag.split ':'\n        return unless prefix.length\n\n        debug? \"[match] with #{kind} #{tag}\"\n\n        prefix = prefix[0]\n        debug? \"[match] check if current module's prefix\"\n        if @root.tag is prefix or @root.prefix?.tag is prefix\n          return @root.match kind, arg\n\n        debug? \"[match] checking if submodule's parent\"\n        ctx = @lookup 'belongs-to'\n        if ctx?.prefix.tag is prefix\n          return ctx.module.match kind, arg \n\n        debug? \"[match] check if one of current module's imports\"\n        imports = @root?.import ? []\n        for m in imports when m.prefix.tag is prefix\n          debug? \"[match] checking #{m.module.tag}\"\n          return m.module.match kind, arg\n\n        debug? \"[match] check if one of available modules\"\n        module = @lookup 'module', prefix\n        return module.match kind, arg if module?\n\n### toString (opts={})\n\nThe current `Yang` expression will covert back to the equivalent YANG\nschema text format.\n\nAt first glance, this may not seem like a useful facility since YANG\nschema text is *generally known* before [parse](#parse-schema) but it\nbecomes highly relevant when you consider a given `Yang` expression\nprogramatically changing via [extends](#extends-schema).\n\nCurrently it supports `space` parameter which can be used to specify\nnumber of spaces to use for indenting YANG statement blocks.  It\ndefaults to **2** but when set to **0**, the generated output will\nomit newlines and other spacing for a more compact YANG output.\n\n      toString: (opts={ space: 2 }) ->\n        s = @kind\n        if @source.argument?\n          s += ' ' + switch @source.argument\n            when 'value' then \"'#{@tag}'\"\n            when 'text'\n              \"\\n\" + (indent '\"'+@tag+'\"', ' ', opts.space)\n            else @tag\n        sub =\n          @elements\n            .filter (x) => x.parent is this\n            .map (x) -> x.toString opts\n            .join \"\\n\"\n        if !!sub\n          s += \" {\\n\" + (indent sub, ' ', opts.space) + \"\\n}\"\n        else\n          s += ';'\n        return s\n\n### toJSON\n\nThe current `Yang` expression will convert into a simple JS object\nformat.\n\n      # toJSON() is inherited from Element\n\n### valueOf\n\nThe current 'Yang' expression will convert into a primitive form for\ncomparision purposes.\n\n      valueOf: ->\n        switch @source.argument\n          when 'value','text' then @tag.valueOf()\n          else this\n\nPlease refer to [Schema Conversion](..\/TUTORIAL.md#schema-conversion)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n## Export Yang Class\n\n    module.exports = Yang\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"e336d2aa1a20851eb84231e6636250c034be6acb","subject":"Docs for LVar","message":"Docs for LVar\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\n\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n  \t\t              find(_.rest(lvar), bindings))\n      lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\n  class LVar\n    constructor: (@name) ->\n\n  F.lvar = (name) -> new LVar(name)\n  F.isLVar = (v) -> (v instanceof LVar)\n\n  find = (v, bindings) ->\n    lvar = bindings.lookup(v)\n    return lvar if F.isLVar(v)\n    if _.isArray(lvar)\n      if _.isEmpty(lvar)\n        return lvar\n      else\n        return _.cons(find(_.first(lvar), bindings), find(_.rest(lvar), bindings))\n    lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"da7ece35cb83d06fc95bd79a628c1c0723389069","subject":"webpack","message":"webpack\n","repos":"duereg\/tile-thinger,vmlinz\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,duereg\/tile-thinger,glebm\/gulp-webpack-react-bootstrap-sass-template","old_file":"webpack.config.litcoffee","new_file":"webpack.config.litcoffee","new_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc).\nIt also manages loading via JavaScript `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    path    = require('path')\n    webpack = require('webpack')\n    _       = require('lodash')\n\n\nDefine an empty configuration:\n\n    module.exports = {}\n\nEntry bundles, i.e. package source paths. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n    module.exports.entry =\n      \"main\"            : \".\/src\/scripts\/main.litcoffee\"\n      \"styles\"          : \".\/src\/styles\/styles.scss\"\n      \"vendor\/es5-shim\" : \".\/bower_components\/es5-shim\/es5-shim.js\"\n      \"vendor\/es5-sham\" : \".\/bower_components\/es5-shim\/es5-sham.js\"\n\n## Loaders\n\nDefine how files should be loaded (required) based on the extension.\n\n### Scripts\n\nProcess CoffeeScript and JSX.\n\n    jsLoaders = [\"jsx\"]\n    scriptModLoaders = [\n      { test: \/\\.coffee$\/   , loaders: jsLoaders.concat([\"coffee\"]) }\n      { test: \/\\.litcoffee$\/, loaders: jsLoaders.concat([\"coffee?literate\"]) }\n      { test: \/\\.js$\/       , loaders: jsLoaders }\n    ]\n\n### Styles\n\nProcess Sass and use Autoprefixer.\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?last 2 versions']\n    styleModLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\n          \"sass?precision=10&outputStyle=expanded&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/ , loaders: cssLoaders }\n    ]\n\n### Static assets\n\nEmbed data-URLs into CSS and JS for small images and `.woff` fonts:\n\n    staticModLoaders = [\n      { test: \/\\.gif$\/ , loader: \"url?limit=10000&mimetype=image\/gif\" }\n      { test: \/\\.jpg$\/ , loader: \"url?limit=10000&mimetype=image\/jpg\" }\n      { test: \/\\.png$\/ , loader: \"url?limit=10000&mimetype=image\/png\" }\n      { test: \/\\.woff$\/, loader: \"url?limit=10000&mimetype=application\/font-woff\" }\n      { test: \/\\.ttf$\/ , loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n      { test: \/\\.eot$\/ , loader: \"file?mimetype=application\/x-font-ttf\" }\n      { test: \/\\.svg$\/ , loader: \"file?mimetype=image\/svg+xml\" }\n    ]\n\n### Output CSS to `.css` files\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not as `.js` files with embedded CSS strings.\n\nRequire the plugin:\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n\nSet `styleModLoaders` to use the plugin:\n\n    styleModLoaders = styleModLoaders.map (e) ->\n      { test: e.test, loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!')) }\n\nCreate an instance of the extractTextPlugin:\n\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\n### Define macro variables\n\n`DefinePlugin` defines variables to be substituted in the assets (a la macro).\n\nDefine `__PRODUCTION__: false` variable (set to true on `useProductionSettings()`):\n\n    definePlugin = new webpack.DefinePlugin(\n      __PRODUCTION__: JSON.stringify(false)\n    )\n\n### Other options\n\n    _.merge module.exports,\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n\nOutput options:\n\n      output:\n        path         : path.join(__dirname, \"dist\", \"assets\")\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: ['bower_components', 'node_modules']\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleModLoaders.concat(scriptModLoaders).concat(staticModLoaders)\n        noParse: \/\\.min\\.js$\/\n\nDefine the plugins:\n\n      plugins: [\n\n`definePlugin` defines variables to be substituted in the assets (a la macro):\n\n        definePlugin\n\n`extractTextPlugin` (defined above) will compile CSS to a .css file, as opposed to inlining it as a string in a .js file.\n\n        extractTextPlugin\n      ]\n\n\n## Production overrides\n\nExport a method that applies production settings (used in gulpfile):\n\n      useProductionSettings: ->\n\nProduction plugins:\n\nSet `__PRODUCTION__` to true in the `DefinePlugin` instance:\n\n        definePlugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\nTell `ExtractTextPlugin` to append hashes (BROKEN, see [plugin issue #9](https:\/\/github.com\/webpack\/extract-text-webpack-plugin\/issues\/9)):\n\n        extractTextPlugin.filename = '[name]-[hash].css'\n\nMerge in production config (deep merge):\n\n        _.merge @,\n\nDisable development settings:\n\n          debug: false\n          watch: false\n          devtool: null\n\nAdd content hashes to the output filenames:\n\n          output:\n            filename: \"[name]-[hash].js\"\n\n          plugins: @plugins.concat [\n\nMinify JavaScript with UglifyJS:\n\n            new webpack.optimize.UglifyJsPlugin()\n          ]\n","old_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc).\nIt also manages loading via JavaScript `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    path    = require('path')\n    webpack = require('webpack')\n    _       = require('lodash')\n\n\nDefine an empty configuration:\n\n    module.exports = {}\n\nEntry bundles, i.e. package source paths. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n    module.exports.entry =\n      \"main\"            : \".\/src\/scripts\/main.litcoffee\"\n      \"styles\"          : \".\/src\/styles\/styles.scss\"\n      \"vendor\/es5-shim\" : \".\/bower_components\/es5-shim\/es5-shim.js\"\n      \"vendor\/es5-sham\" : \".\/bower_components\/es5-shim\/es5-sham.js\"\n\n## Loaders\n\nDefine how files should be loaded (required) based on the extension.\n\n### Scripts\n\nProcess CoffeeScript and JSX.\n\n    jsLoaders = [\"jsx\"]\n    scriptModLoaders = [\n      { test: \/\\.coffee$\/   , loaders: jsLoaders.concat([\"coffee\"]) }\n      { test: \/\\.litcoffee$\/, loaders: jsLoaders.concat([\"coffee?literate\"]) }\n      { test: \/\\.js$\/       , loaders: jsLoaders }\n    ]\n\n### Styles\n\nProcess Sass and use Autoprefixer.\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?last 2 versions']\n    styleModLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\n          \"sass?precision=10&outputStyle=expanded&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/ , loaders: cssLoaders }\n    ]\n\n### Static assets\n\nEmbed data-URLs into CSS and JS for small images and `.woff` fonts:\n\n    staticModLoaders = [\n      { test: \/\\.gif$\/ , loader: \"url?limit=10000&mimetype=image\/gif\" }\n      { test: \/\\.jpg$\/ , loader: \"url?limit=10000&mimetype=image\/jpg\" }\n      { test: \/\\.png$\/ , loader: \"url?limit=10000&mimetype=image\/png\" }\n      { test: \/\\.woff$\/, loader: \"url?limit=10000&mimetype=application\/font-woff\" }\n      { test: \/\\.ttf$\/ , loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n      { test: \/\\.eot$\/ , loader: \"file?mimetype=application\/x-font-ttf\" }\n      { test: \/\\.svg$\/ , loader: \"file?mimetype=image\/svg+xml\" }\n    ]\n\n### Output CSS to `.css` files\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not as `.js` files with embedded CSS strings.\n\nRequire the plugin:\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n\nSet `styleModLoaders` to use the plugin:\n\n    styleModLoaders = styleModLoaders.map (e) ->\n      { test: e.test, loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!')) }\n\nCreate an instance of the extractTextPlugin:\n\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\n### Define macro variables\n\n`DefinePlugin` defines variables to be substituted in the assets (a la macro).\n\nDefine `__PRODUCTION__: false` variable (set to true on `useProductionSettings()`):\n\n    definePlugin = new webpack.DefinePlugin(\n      __PRODUCTION__: JSON.stringify(false)\n    )\n\n### Other options\n\n    _.merge module.exports,\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n\nOutput options:\n\n      output:\n        path         : path.join(__dirname, \"dist\", \"assets\")\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: ['bower_components', 'node_modules']\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleModLoaders.concat(scriptModLoaders).concat(staticModLoaders)\n        noParse: \/\\.min\\.js$\/\n\nDefine the plugins:\n\n      plugins: [\n\n`definePlugin` defines variables to be substituted in the assets (a la macro):\n\n        definePlugin\n\n`extractTextPlugin` (defined above) will compile CSS to a .css file, as opposed to inlining it as a string in a .js file.\n\n        extractTextPlugin\n      ]\n\n\n## Production overrides\n\nExport a method that applies production settings (used in gulpfile):\n\n      useProductionSettings: ->\n\nProduction plugins:\n\n        plugins = @plugins.concat [\n\nMinify JavaScript with UglifyJS:\n\n          new webpack.optimize.UglifyJsPlugin()\n        ]\n\nSet `__PRODUCTION__` to true in the `DefinePlugin` instance:\n\n        definePlugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\nTell `ExtractTextPlugin` to append hashes (BROKEN, see [plugin issue #9](https:\/\/github.com\/webpack\/extract-text-webpack-plugin\/issues\/9)):\n\n        extractTextPlugin.filename = '[name]-[hash].css'\n\nMerge in production config (deep merge):\n\n        _.merge @,\n\nDisable development settings:\n\n          debug: false\n          watch: false\n          devtool: null\n\nAdd content hashes to the output filenames:\n\n          output:\n            filename: \"[name]-[hash].js\"\n\nProduction-only plugins:\n\n          plugins: plugins\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8af7fe18d3061f57b9b1771117f7925136270577","subject":"Fix typo","message":"Fix typo","repos":"monokrome\/glp","old_file":"src\/defaults.litcoffee","new_file":"src\/defaults.litcoffee","new_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How GLP configuration works\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp.watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is false by default, but can be made true if caching\nhappens to be working as expected with your project. This feature is disabled\nby default because it is still experimental for now.\n\n        enabled: no\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nWe'll also want source maps, so let's enabled those.\n\n        coffee:\n          sourceMap: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nSome more default formats are provided here:\n\n          iced: {}\n\n          typescript:\n            matches: '**\/*.ts'\n\n          livescript:\n            matches: '**\/*.ls'\n\n          handlebars:\n            matches: '**\/*.hbs'\n\n          coco:\n            matches: '**\/*.co'\n\n          eco:\n            matches: '**\/*.eco'\n\n          dust:\n            matches: ['**\/*.djs', '**\/*.dust']\n\n          nunjucks:\n            matches: ['**\/*.njs', '**\/*.nunjucks']\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\nSome more default formats are provided here:\n\n          haml: {}\n          ejs: {}\n          mustache: {}\n\n          markdown:\n            matches: ['**\/*.md', '**\/*.markdown']\n\n          template:\n            matches: '**\/*.tpl'\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js`, `.coffee` and a few\nother extensions. After they are built, the resulting files will be placed in\nthe directory specified by the **root** function as separate files. If the\noutput file was not a **directory** (as denoted by the ending slash) then the\nfiles would also be concatenated and the resulting file would be given the\n*extension* which corresponds to this type of file.\n\n          '\/scripts\/': [\n            'src\/scripts\/**\/*.js'\n            'src\/scripts\/**\/*.coffee'\n            'src\/scripts\/**\/*.iced'\n            'src\/scripts\/**\/*.co'\n            'src\/scripts\/**\/*.ls'\n            'src\/scripts\/**\/*.ts'\n            'src\/scripts\/**\/*.hbs'\n            'src\/scripts\/**\/*.eco'\n            'src\/scripts\/**\/*.djs'\n            'src\/scripts\/**\/*.dust'\n            'src\/scripts\/**\/*.njs'\n            'src\/scripts\/**\/*.nunjucks'\n          ]\n\nHere, we are doing the same thing for *html*, *jade*, and some other file\nextensions. This time we are outputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/templates\/**\/*.html'\n            'src\/templates\/**\/*.jade'\n            'src\/templates\/**\/*.md'\n            'src\/templates\/**\/*.markdown'\n            'src\/templates\/**\/*.haml'\n            'src\/templates\/**\/*.ejs'\n            'src\/templates\/**\/*.mustache'\n            'src\/templates\/**\/*.tpl'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/stylesheets\/': [\n            'src\/stylesheets\/**\/*.css'\n            'src\/stylesheets\/**\/*.less'\n            'src\/stylesheets\/**\/*.sass'\n            'src\/stylesheets\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            coffee:\n              sourceMap: no\n\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","old_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How GLP configuration works\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp,watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is false by default, but can be made true if caching\nhappens to be working as expected with your project. This feature is disabled\nby default because it is still experimental for now.\n\n        enabled: no\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nWe'll also want source maps, so let's enabled those.\n\n        coffee:\n          sourceMap: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nSome more default formats are provided here:\n\n          iced: {}\n\n          typescript:\n            matches: '**\/*.ts'\n\n          livescript:\n            matches: '**\/*.ls'\n\n          handlebars:\n            matches: '**\/*.hbs'\n\n          coco:\n            matches: '**\/*.co'\n\n          eco:\n            matches: '**\/*.eco'\n\n          dust:\n            matches: ['**\/*.djs', '**\/*.dust']\n\n          nunjucks:\n            matches: ['**\/*.njs', '**\/*.nunjucks']\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\nSome more default formats are provided here:\n\n          haml: {}\n          ejs: {}\n          mustache: {}\n\n          markdown:\n            matches: ['**\/*.md', '**\/*.markdown']\n\n          template:\n            matches: '**\/*.tpl'\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js`, `.coffee` and a few\nother extensions. After they are built, the resulting files will be placed in\nthe directory specified by the **root** function as separate files. If the\noutput file was not a **directory** (as denoted by the ending slash) then the\nfiles would also be concatenated and the resulting file would be given the\n*extension* which corresponds to this type of file.\n\n          '\/scripts\/': [\n            'src\/scripts\/**\/*.js'\n            'src\/scripts\/**\/*.coffee'\n            'src\/scripts\/**\/*.iced'\n            'src\/scripts\/**\/*.co'\n            'src\/scripts\/**\/*.ls'\n            'src\/scripts\/**\/*.ts'\n            'src\/scripts\/**\/*.hbs'\n            'src\/scripts\/**\/*.eco'\n            'src\/scripts\/**\/*.djs'\n            'src\/scripts\/**\/*.dust'\n            'src\/scripts\/**\/*.njs'\n            'src\/scripts\/**\/*.nunjucks'\n          ]\n\nHere, we are doing the same thing for *html*, *jade*, and some other file\nextensions. This time we are outputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/templates\/**\/*.html'\n            'src\/templates\/**\/*.jade'\n            'src\/templates\/**\/*.md'\n            'src\/templates\/**\/*.markdown'\n            'src\/templates\/**\/*.haml'\n            'src\/templates\/**\/*.ejs'\n            'src\/templates\/**\/*.mustache'\n            'src\/templates\/**\/*.tpl'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/stylesheets\/': [\n            'src\/stylesheets\/**\/*.css'\n            'src\/stylesheets\/**\/*.less'\n            'src\/stylesheets\/**\/*.sass'\n            'src\/stylesheets\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            coffee:\n              sourceMap: no\n\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fce4463bc2640668947ab61c36fca66982a4752f","subject":"Remove debugging info unless we're in testing mode","message":"Remove debugging info unless we're in testing mode\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-angular\/client\/index.litcoffee","new_file":"packages\/shrub-angular\/client\/index.litcoffee","new_contents":"# Angular\n\n*Coordinate various core functionality.*\n\n    _ = require 'lodash'\n    Promise = require 'bluebird'\n\n    config = require 'config'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularAHrefSanitizationWhitelist`.\n\n      registrar.registerHook 'shrubAngularAHrefSanitizationWhitelist', -> [\n\nAllow more protocols.\n\n        '(?:https?|ftp|mailto|tel|file):'\n\nAllow javascript:void(0).\n\n        'javascript:void\\\\(0\\\\)'\n      ]\n\n#### Implements hook `shrubAngularAppConfig`.\n\n      registrar.registerHook 'shrubAngularAppConfig', -> [\n        '$compileProvider', '$injector', '$provide', '$routeProvider', '$locationProvider', 'shrub-pkgmanProvider'\n        ($compileProvider, $injector, $provide, $routeProvider, $locationProvider, pkgmanProvider) ->\n\n#### Invoke hook `shrubAngularAHrefSanitizationWhitelist`.\n\n          regexes = []\n          for regexes_ in pkgmanProvider.invokeFlat(\n            'shrubAngularAHrefSanitizationWhitelist'\n          )\n            regexes.push regex for regex in regexes_\n\n          $compileProvider.aHrefSanitizationWhitelist new RegExp(\n            \"^\\s*(?:#{regexes.join '|'})\"\n          )\n\n          unless config.get 'packageConfig:shrub-core:testMode'\n            $compileProvider.debugInfoEnabled false\n\nCompletely override $q with Bluebird, because it's awesome.\n\n###### TODO: Angular also implements a private service called $$q used for animation. We should override that one, too.\n\n          $provide.decorator '$q', [\n            '$rootScope', '$exceptionHandler'\n            ($rootScope, $exceptionHandler) ->\n\n              Promise.onPossiblyUnhandledRejection (error) ->\n\n$timeout and $interval will throw this for cancellation. It's non-notable.\n\n                return if 'canceled' is error.message\n\n                $exceptionHandler error\n\nHook Bluebird's schedule up to Angular.\n\n              Promise.setScheduler (fn) -> $rootScope.$evalAsync fn\n\n## Promise.defer\n\nSee: https:\/\/docs.angularjs.org\/api\/ng\/service\/$q#the-deferred-api\n\n              Promise.defer = ->\n                resolve = null\n                reject = null\n\n                promise = new Promise ->\n                  resolve = arguments[0]\n                  reject = arguments[1]\n\n                promise: promise\n                resolve: resolve\n                reject: reject\n\n## Promise.when\n\nSee: https:\/\/docs.angularjs.org\/api\/ng\/service\/$q#when\n\n              Promise.when = (value, handlers...) ->\n                Promise.cast(value).then handlers...\n\nProxy Promise.all because Angular supports passing in an object where the\nvalues are promises, and the result is an object keyed with the resolved\nvalues from the promise.\n\n              originalAll = Promise.all\n              Promise.all = (promises) ->\n\nDefer to Bluebird unless it's an object.\n\n                return originalAll promises unless angular.isObject(\n                  promises\n                )\n\nTrack the keys so we can map the values.\n\n                promiseKeys = []\n                promiseArray = for key, promise of promises\n                  promiseKeys.push key\n                  promise\n\n                originalAll(promiseArray).then (results) ->\n                  objectResult = {}\n\n                  for result, index in results\n                    objectResult[promiseKeys[index]] = result\n\n                  objectResult\n\n              Promise\n\n          ]\n\n#### Invoke hook `shrubAngularRoutes`.\n\nAllow packages to define routes in the Angular application.\n\n          routes = {}\n          for route in _.flatten pkgmanProvider.invokeFlat 'shrubAngularRoutes'\n            routes[route.path ? path] = route\n\nInvoke hook `shrubAngularRoutesAlter`.\n\nAllow packages to alter defined routes.\n\n          $injector.invoke(\n            injectable, null\n            routes: routes\n          ) for injectable in pkgmanProvider.invokeFlat 'shrubAngularRoutesAlter'\n\n          for path, route of routes\n            do (path, route) ->\n\nWrap the controller so we can provide some automatic behavior.\n\n              routeController = route.controller\n              route.controller = [\n                '$controller', '$injector', '$q', '$scope'\n                ($controller, $injector, $q, $scope) ->\n\n                  unless routeController?\n                    return $scope.$emit 'shrub.core.routeRendered'\n\nControllers may return a promise, so wait until any returned value fulfills.\nIf it's not a promise, this will be in the next tick.\n\n                  $q.when($injector.invoke(\n                    routeController, null\n                    $scope: $scope\n                    route: route\n                  )).then(-> $scope.$emit 'shrub.core.routeRendered').done()\n\n              ]\n\n              route.template ?= ' '\n\nRegister the path into Angular.\n\n              $routeProvider.when \"\/#{route.path ? path}\", route\n\nCreate a unique entry point.\n\n          $routeProvider.when '\/shrub-angular-entry-point', {}\n\nTurn on HTML5 mode: \"Real\" URLs.\n\n          $locationProvider.html5Mode true\n      ]\n","old_contents":"# Angular\n\n*Coordinate various core functionality.*\n\n    _ = require 'lodash'\n    Promise = require 'bluebird'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularAHrefSanitizationWhitelist`.\n\n      registrar.registerHook 'shrubAngularAHrefSanitizationWhitelist', -> [\n\nAllow more protocols.\n\n        '(?:https?|ftp|mailto|tel|file):'\n\nAllow javascript:void(0).\n\n        'javascript:void\\\\(0\\\\)'\n      ]\n\n#### Implements hook `shrubAngularAppConfig`.\n\n      registrar.registerHook 'shrubAngularAppConfig', -> [\n        '$compileProvider', '$injector', '$provide', '$routeProvider', '$locationProvider', 'shrub-pkgmanProvider'\n        ($compileProvider, $injector, $provide, $routeProvider, $locationProvider, pkgmanProvider) ->\n\n#### Invoke hook `shrubAngularAHrefSanitizationWhitelist`.\n\n          regexes = []\n          for regexes_ in pkgmanProvider.invokeFlat(\n            'shrubAngularAHrefSanitizationWhitelist'\n          )\n            regexes.push regex for regex in regexes_\n\n          $compileProvider.aHrefSanitizationWhitelist new RegExp(\n            \"^\\s*(?:#{regexes.join '|'})\"\n          )\n\nCompletely override $q with Bluebird, because it's awesome.\n\n###### TODO: Angular also implements a private service called $$q used for animation. We should override that one, too.\n\n          $provide.decorator '$q', [\n            '$rootScope', '$exceptionHandler'\n            ($rootScope, $exceptionHandler) ->\n\n              Promise.onPossiblyUnhandledRejection (error) ->\n\n$timeout and $interval will throw this for cancellation. It's non-notable.\n\n                return if 'canceled' is error.message\n\n                $exceptionHandler error\n\nHook Bluebird's schedule up to Angular.\n\n              Promise.setScheduler (fn) -> $rootScope.$evalAsync fn\n\n## Promise.defer\n\nSee: https:\/\/docs.angularjs.org\/api\/ng\/service\/$q#the-deferred-api\n\n              Promise.defer = ->\n                resolve = null\n                reject = null\n\n                promise = new Promise ->\n                  resolve = arguments[0]\n                  reject = arguments[1]\n\n                promise: promise\n                resolve: resolve\n                reject: reject\n\n## Promise.when\n\nSee: https:\/\/docs.angularjs.org\/api\/ng\/service\/$q#when\n\n              Promise.when = (value, handlers...) ->\n                Promise.cast(value).then handlers...\n\nProxy Promise.all because Angular supports passing in an object where the\nvalues are promises, and the result is an object keyed with the resolved\nvalues from the promise.\n\n              originalAll = Promise.all\n              Promise.all = (promises) ->\n\nDefer to Bluebird unless it's an object.\n\n                return originalAll promises unless angular.isObject(\n                  promises\n                )\n\nTrack the keys so we can map the values.\n\n                promiseKeys = []\n                promiseArray = for key, promise of promises\n                  promiseKeys.push key\n                  promise\n\n                originalAll(promiseArray).then (results) ->\n                  objectResult = {}\n\n                  for result, index in results\n                    objectResult[promiseKeys[index]] = result\n\n                  objectResult\n\n              Promise\n\n          ]\n\n#### Invoke hook `shrubAngularRoutes`.\n\nAllow packages to define routes in the Angular application.\n\n          routes = {}\n          for route in _.flatten pkgmanProvider.invokeFlat 'shrubAngularRoutes'\n            routes[route.path ? path] = route\n\nInvoke hook `shrubAngularRoutesAlter`.\n\nAllow packages to alter defined routes.\n\n          $injector.invoke(\n            injectable, null\n            routes: routes\n          ) for injectable in pkgmanProvider.invokeFlat 'shrubAngularRoutesAlter'\n\n          for path, route of routes\n            do (path, route) ->\n\nWrap the controller so we can provide some automatic behavior.\n\n              routeController = route.controller\n              route.controller = [\n                '$controller', '$injector', '$q', '$scope'\n                ($controller, $injector, $q, $scope) ->\n\n                  unless routeController?\n                    return $scope.$emit 'shrub.core.routeRendered'\n\nControllers may return a promise, so wait until any returned value fulfills.\nIf it's not a promise, this will be in the next tick.\n\n                  $q.when($injector.invoke(\n                    routeController, null\n                    $scope: $scope\n                    route: route\n                  )).then(-> $scope.$emit 'shrub.core.routeRendered').done()\n\n              ]\n\n              route.template ?= ' '\n\nRegister the path into Angular.\n\n              $routeProvider.when \"\/#{route.path ? path}\", route\n\nCreate a unique entry point.\n\n          $routeProvider.when '\/shrub-angular-entry-point', {}\n\nTurn on HTML5 mode: \"Real\" URLs.\n\n          $locationProvider.html5Mode true\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f5cf66497029b02a3da397f850ff7c61a221bbc5","subject":"prevent update if property.set with same value as prior value","message":"prevent update if property.set with same value as prior value\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    Yang     = require '.\/yang'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (spec={}) ->\n        # NOTE: ES6\/CS2 does not support below\n        # unless this instanceof Property then return new Property arguments...\n\n        # 1. parse if spec is YANG definition (string)\n        spec = Yang.parse spec if typeof spec is 'string'\n        \n        # 2. assign if spec is an instance of Yang schema\n        schema = spec if spec instanceof Yang\n        \n        # 3. destructure spec as an object if not schema as instance\n        { name, schema } = spec unless schema?\n        \n        # 4. parse if schema is YANG definition (string)\n        schema = Yang.parse schema if typeof schema is 'string'\n        schema ?= kind: 'anydata'\n\n        # 5. initialize property instance\n        @name = name ? schema.datakey\n        @schema = schema\n        @state = \n          parent:    null\n          container: null\n          private:   false\n          mutable:   `schema.config != false`\n          attached:  false\n          prior:     undefined\n          value:     undefined\n          changed:   false\n\n        # 6. soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'container'\n        .access 'parent'\n        .access 'strict'\n        .getter 'mutable'\n        .getter 'private'\n        .getter 'pending'\n        .getter 'changed'\n        .getter 'attached'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'value',\n        get: -> @state.value\n\n      @property 'data',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> switch\n          when @binding?.get? then @binding.get @context\n          else @value\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @data\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.opts = {}\n          ctx.node = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor this\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      debug: -> debug @uri, arguments...\n      \n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@data`.\n\nIt also provides special handling based on different types of\n`@data` currently held.\n\n      get: (key) -> switch\n        when key?\n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].data\n            when match.length > 1  then match.map (x) -> x.data\n            else undefined\n        else @data\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        opts.origin ?= this\n        \n        # @debug \"[set] enter...\"\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n\n        if not opts.force and @binding?.set?\n          try value = @binding.set @context.with(opts), value \n          catch e\n            throw @error \"failed executing set() binding: #{e.message}\", e\n\n        return this if value? and @equals value, @value # return if same value\n        \n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        @debug \"[set] applying schema...\"        \n        value = switch\n          when @schema.apply? and not bypass\n            subopts = Object.assign {}, opts, inner: true, suppress: true\n            @schema.apply value, this, subopts\n          else value\n        @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error\n        return this if value? and @equals value, @value # return if same value\n        @update value, opts\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@value` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if value is null\n        return @set value, opts\n\n### delete\n\n      delete: (opts={}) ->\n        opts.origin ?= this\n        if not opts.force and @binding?.delete?\n          try @binding.delete @context.with(opts), null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @update null, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n        @state.prior = @state.value\n        @state.value = value\n        @state.changed = @active or (value is null)\n        @parent?.update this, opts # unless opts.suppress\n        return this\n\n### commit async transaction\n\nCommits the changes to the data model. Called *once* for each node that\nis part of the change branch.\n\n      commit: (opts={}) ->\n        opts.origin ?= this\n        try\n          # 1. perform commit bindings\n          @debug \"[commit] execute commit binding...\"\n          await @binding?.commit? @context.with(opts)\n          # 2. if parent, then wait for parent commited before updating changed state\n          promise = @parent?.commit? opts\n            .then (ok) =>\n              @state.changed = false if ok\n          unless promise?\n            @state.changed = false\n        catch err\n          @debug \"[commit] rollback due to #{err.message}\"\n          await @revert opts\n          throw @error err\n        return true\n\n      revert: (opts={}) ->\n        try\n          # 1. perform rollback bindings\n          await @binding?.rollback? @context.with(opts)\n          # 2. wait for delete of this property (if newly created)\n          await @delete opts unless @state.prior?\n          @state.value = @state.prior\n          @state.changed = false\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n\n        detached = true unless @container?\n        @container = obj\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        if detached and opts.replace isnt true\n          # @debug \"[attach] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n\n          @set obj[name], Object.assign {}, opts, inner: true, suppress: true\n\n        unless opts.preserve\n          try Object.defineProperty obj, @name,\n              configurable: true\n              enumerable: @enumerable\n              get: (args...) => @get args...\n              set: (args...) => @set args...\n            \n        @state.attached = true\n        @debug \"[attach] attached into #{obj.constructor.name} container\"\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @data = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx) ->\n        err = new Error err unless err instanceof Error\n        err.uri = @uri \n        err.src = this\n        err.ctx = ctx\n        return err\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @data\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:    @name\n          kind:    @kind\n          path:    @path.toString()\n          active:  @active\n          private: @private\n          mutable: @mutable\n          changed: @changed\n          schema: switch\n            when @schema.uri?\n              uri:      @schema.uri\n              summary:  @schema.description?.tag\n              datakey:  @schema.datakey\n              datapath: @schema.datapath\n              external: @schema.external\n              children: @schema.children.map (x) -> x.uri\n            else false\n          value: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    Yang     = require '.\/yang'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (spec={}) ->\n        # NOTE: ES6\/CS2 does not support below\n        # unless this instanceof Property then return new Property arguments...\n\n        # 1. parse if spec is YANG definition (string)\n        spec = Yang.parse spec if typeof spec is 'string'\n        \n        # 2. assign if spec is an instance of Yang schema\n        schema = spec if spec instanceof Yang\n        \n        # 3. destructure spec as an object if not schema as instance\n        { name, schema } = spec unless schema?\n        \n        # 4. parse if schema is YANG definition (string)\n        schema = Yang.parse schema if typeof schema is 'string'\n        schema ?= kind: 'anydata'\n\n        # 5. initialize property instance\n        @name = name ? schema.datakey\n        @schema = schema\n        @state = \n          parent:    null\n          container: null\n          private:   false\n          mutable:   `schema.config != false`\n          attached:  false\n          prior:     undefined\n          value:     undefined\n          changed:   false\n\n        # 6. soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'container'\n        .access 'parent'\n        .access 'strict'\n        .getter 'mutable'\n        .getter 'private'\n        .getter 'pending'\n        .getter 'changed'\n        .getter 'attached'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'value',\n        get: -> @state.value\n\n      @property 'data',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> switch\n          when @binding?.get? then @binding.get @context\n          else @value\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @data\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.opts = {}\n          ctx.node = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor this\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      debug: -> debug @uri, arguments...\n      \n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@data`.\n\nIt also provides special handling based on different types of\n`@data` currently held.\n\n      get: (key) -> switch\n        when key?\n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].data\n            when match.length > 1  then match.map (x) -> x.data\n            else undefined\n        else @data\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        opts.origin ?= this\n        \n        # @debug \"[set] enter...\"\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n\n        if not opts.force and @binding?.set?\n          try value = @binding.set @context.with(opts), value \n          catch e\n            throw @error \"failed executing set() binding: #{e.message}\", e\n\n        return this if value? and @equals value, @value\n        \n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        \n        @debug \"[set] applying schema...\"        \n        value = switch\n          when @schema.apply? and not bypass\n            subopts = Object.assign {}, opts, inner: true, suppress: true\n            @schema.apply value, this, subopts\n          else value\n        @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error\n        @update value, opts\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@value` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if value is null\n        return @set value, opts\n\n### delete\n\n      delete: (opts={}) ->\n        opts.origin ?= this\n        if not opts.force and @binding?.delete?\n          try @binding.delete @context.with(opts), null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @update null, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n        @state.prior = @state.value\n        @state.value = value\n        @state.changed = @active or (value is null)\n        @parent?.update this, opts # unless opts.suppress\n        return this\n\n### commit async transaction\n\nCommits the changes to the data model. Called *once* for each node that\nis part of the change branch.\n\n      commit: (opts={}) ->\n        opts.origin ?= this\n        try\n          # 1. perform commit bindings\n          @debug \"[commit] execute commit binding...\"\n          await @binding?.commit? @context.with(opts)\n          # 2. if parent, then wait for parent commited before updating changed state\n          promise = @parent?.commit? opts\n            .then (ok) =>\n              @state.changed = false if ok\n          unless promise?\n            @state.changed = false\n        catch err\n          @debug \"[commit] rollback due to #{err.message}\"\n          await @revert opts\n          throw @error err\n        return true\n\n      revert: (opts={}) ->\n        try\n          # 1. perform rollback bindings\n          await @binding?.rollback? @context.with(opts)\n          # 2. wait for delete of this property (if newly created)\n          await @delete opts unless @state.prior?\n          @state.value = @state.prior\n          @state.changed = false\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n\n        detached = true unless @container?\n        @container = obj\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        if detached and opts.replace isnt true\n          # @debug \"[attach] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n\n          @set obj[name], Object.assign {}, opts, inner: true, suppress: true\n\n        unless opts.preserve\n          try Object.defineProperty obj, @name,\n              configurable: true\n              enumerable: @enumerable\n              get: (args...) => @get args...\n              set: (args...) => @set args...\n            \n        @state.attached = true\n        @debug \"[attach] attached into #{obj.constructor.name} container\"\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @data = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx) ->\n        err = new Error err unless err instanceof Error\n        err.uri = @uri \n        err.src = this\n        err.ctx = ctx\n        return err\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @data\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:    @name\n          kind:    @kind\n          path:    @path.toString()\n          active:  @active\n          private: @private\n          mutable: @mutable\n          changed: @changed\n          schema: switch\n            when @schema.uri?\n              uri:      @schema.uri\n              summary:  @schema.description?.tag\n              datakey:  @schema.datakey\n              datapath: @schema.datapath\n              external: @schema.external\n              children: @schema.children.map (x) -> x.uri\n            else false\n          value: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"79158efef247fd6deaf2f0d9ea0964ddd0549478","subject":"attach 'update' events to .remove() and .merge()","message":"attach 'update' events to .remove() and .merge()\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object.__` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property') if process.env.DEBUG?\n    co       = require 'co'\n    delegate = require 'delegates'\n    Emitter  = require('events').EventEmitter\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n        Object.setPrototypeOf @state, Emitter.prototype\n\n        @schema.kind ?= 'anydata'\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .method 'once'\n        .method 'on'\n        .access 'container'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, force: true\n\n      @property 'context',\n        get: ->\n          debug? \"creating new context for #{@name}\"\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.defineProperty ctx, 'action',\n            get: -> @content if @content instanceof Function\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'parent', get: -> @container?.__\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          if @parent instanceof Property then @parent.root\n          else this\n      \n      @property 'props',\n        get: -> prop for k, prop of @content?.__props__\n      \n      @property 'key',\n        get: ->\n          return unless @schema is @parent?.schema\n          switch\n            when @content not instanceof Object  then @name + 1\n            when @content.hasOwnProperty('@key') then @content['@key']\n            when Array.isArray @container\n              for idx, item of @container when item is @content\n                idx = Number(idx) unless (Number.isNaN (Number idx))\n                return idx+1\n              return undefined\n\n      # TODO: cache this in @state so that it's not reconstructed every time\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema \n          key = @key\n          debug? \"[#{@name}:path] #{@kind}(#{@name}) has #{key} #{typeof key}\"\n          entity = switch typeof key\n            when 'number' then \".[#{key}]\"\n            when 'string' then \".[key() = '#{key}']\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          debug? \"[#{@name}:path] #{@parent.name} + #{entity}\"\n          @parent.path.append entity\n\n## Instance-level methods\n\n      emit: (event) ->\n        @state.emit arguments...\n        unless this is @root\n          debug? \"[emit] '#{event}' from '#{@name}' to '#{@root.name}'\"\n          @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It registers itself into\n`obj.__props__` as well as defined in the target `obj` via\n`Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false, force: false }) ->\n        return obj unless obj instanceof Object\n\n        debug? \"[join] #{@kind}(#{@name}) into #{obj.constructor.name} container\"\n        if Array.isArray(obj) and Array.isArray(@content)\n          debug? @content\n          throw @error \"cannot join array property into list container\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n\n        exists = obj[@name] \n        Object.defineProperty obj, @name, this\n\n        # if joining for the first time, apply existing data unless explicit replace\n        unless @container?\n          debug? \"[join] #{@kind}(#{@name}) assigning first time\"\n          debug? opts\n          @container = obj\n          unless opts.replace is true\n            opts.suppress = true\n            @set exists, opts\n\n        unless obj.hasOwnProperty '__props__'\n          Object.defineProperty obj, '__props__', value: {}\n        obj.__props__[@name] = this\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern) -> switch\n        when pattern?\n          match = @find pattern\n          debug? match\n          switch\n            when match.length is 1 then match[0].get()\n            when match.length > 1  then match.map (x) -> x.get()\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then switch\n          when @binding? then @invoke.bind this\n          else @content\n        else\n          try @binding.call @context if @binding?\n          catch e then throw @error \"issue executing registered function binding during get()\", e\n          # TODO: should utilize yield to resolve promises\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        debug? \"[set] #{@kind}(#{@name}) enter with:\"\n        debug? value\n        debug? opts\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only element\"\n          \n        try\n          unless value instanceof Function\n            value = value.__.toJSON false if value.__ instanceof Property and value.__ isnt this\n          value = Object.create(value) unless Object.isExtensible(value)\n          Object.defineProperty value, '__', configurable: true, value: this\n          \n        value = switch\n          when @schema.apply?\n            @schema.apply value, @context.with(opts)\n          else value\n        return this if value instanceof Error\n\n        debug? \"[set] schema validation complete\"\n        \n        try\n          Object.defineProperty value, '__', value: this\n          if @schema.nodes.length and @kind isnt 'module'\n            for own k of value\n              desc = Object.getOwnPropertyDescriptor value, k\n              if desc.writable is true\n                debug? \"[set] hiding non-schema defined property: #{k}\"\n                Object.defineProperty value, k, enumerable: false\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        \n        if @binding?.length is 1 and not opts.force\n          try @binding.call @context, value \n          catch e\n            throw @error \"issue executing registered function binding during set()\", e\n        else\n          @state.value = value\n\n        try Object.defineProperty @container, @name, enumerable: @state.enumerable\n\n        @emit 'update', this if this is @root or not opts.suppress\n        # try @join @container, opts\n        # catch e then @state.value = @state.prev; throw e\n        debug? \"[set] #{@kind}(#{@name}) completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        unless typeof @content is 'object' then return @set value\n\n        value = value[@name] if value? and value.hasOwnProperty @name\n        return this unless typeof value is 'object'\n        \n        if Array.isArray @content\n          length = @content.length\n          debug? \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          value = [ value ] unless Array.isArray value\n          try Object.defineProperty value, '__', configurable: true, value: this\n          value = @schema.apply value\n          debug? \"[merge] combining and applying schema\"\n          combine = @content.concat value\n          attr.apply combine for attr in @schema.attrs\n          value.forEach (item) =>\n            item.__.name += length\n            item.__.join @content, opts\n          prop = new Property @name, @schema\n          prop.state.container = @container\n          prop.state.value = value\n          @emit 'update', this unless opts.suppress\n          return prop\n        else\n          # TODO: protect this as a transaction?\n          @content[k] = v for own k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n          return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        if not @content? and @kind is 'list' and not Array.isArray value\n          value = [ value ] \n        res = @merge value, replace: false\n        @emit 'create', res\n        return res\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@container` parent object.\n      \n      remove: ->\n        return this unless @container?\n        if @key?\n          @container.splice @name, 1\n          #delete @parent[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          Object.defineProperty @container, @name, enumerable: false\n        @emit 'update', @parent if @parent?\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        xpath = switch\n          when pattern instanceof XPath then pattern\n          else XPath.parse pattern, @schema\n        debug? \"[#{@path}] finding #{pattern} starting with #{xpath.tag}\"\n        if opts.root or not @container? or xpath.tag not in [ '\/', '..' ]\n          debug? \"[#{@path}] #{@name} applying '#{xpath}'\"\n          debug? @content\n          xpath.apply(@content).props ? []\n        else switch\n          when xpath.tag is '\/'  and @parent? then @parent.find xpath, opts\n          when xpath.tag is '..' and @parent? then @parent.find xpath.xpath, opts\n          else []\n\n### invoke\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\n      invoke: (args...) ->\n        try\n          ctx = @context\n          unless ctx.action?\n            throw @error \"cannot invoke on a property without function\"\n          debug? \"[invoke] calling #{@name} method\"\n          # TODO: need to ensure unique instance of 'input' and 'output' for concurrency\n          ctx.input = args[0] ? {}\n          ctx.action.apply ctx, args\n          return co -> yield Promise.resolve ctx.output\n        catch e\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        res = new Error \"[#{at}] #{msg}\"\n        res.name = 'PropertyError'\n        res.context = ctx\n        return res\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          key:    @key\n          xpath:  @path.toString()\n          schema: @schema.toJSON tag: false, extended: true\n          active: @enumerable\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\nproperty's `@name`.\n\n      toJSON: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            res[k] = copy v for own k, v of src\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object.__` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property') if process.env.DEBUG?\n    co       = require 'co'\n    delegate = require 'delegates'\n    Emitter  = require('events').EventEmitter\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n        Object.setPrototypeOf @state, Emitter.prototype\n\n        @schema.kind ?= 'anydata'\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .method 'once'\n        .method 'on'\n        .access 'container'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, force: true\n\n      @property 'context',\n        get: ->\n          debug? \"creating new context for #{@name}\"\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.defineProperty ctx, 'action',\n            get: -> @content if @content instanceof Function\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'parent', get: -> @container?.__\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          if @parent instanceof Property then @parent.root\n          else this\n      \n      @property 'props',\n        get: -> prop for k, prop of @content?.__props__\n      \n      @property 'key',\n        get: ->\n          return unless @schema is @parent?.schema\n          switch\n            when @content not instanceof Object  then @name + 1\n            when @content.hasOwnProperty('@key') then @content['@key']\n            when Array.isArray @container\n              for idx, item of @container when item is @content\n                idx = Number(idx) unless (Number.isNaN (Number idx))\n                return idx+1\n              return undefined\n\n      # TODO: cache this in @state so that it's not reconstructed every time\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema \n          key = @key\n          debug? \"[#{@name}:path] #{@kind}(#{@name}) has #{key} #{typeof key}\"\n          entity = switch typeof key\n            when 'number' then \".[#{key}]\"\n            when 'string' then \".[key() = '#{key}']\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          debug? \"[#{@name}:path] #{@parent.name} + #{entity}\"\n          @parent.path.append entity\n\n## Instance-level methods\n\n      emit: (event) ->\n        @state.emit arguments...\n        unless this is @root\n          debug? \"[emit] '#{event}' from '#{@name}' to '#{@root.name}'\"\n          @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It registers itself into\n`obj.__props__` as well as defined in the target `obj` via\n`Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false, force: false }) ->\n        return obj unless obj instanceof Object\n\n        debug? \"[join] #{@kind}(#{@name}) into #{obj.constructor.name} container\"\n        if Array.isArray(obj) and Array.isArray(@content)\n          debug? @content\n          throw @error \"cannot join array property into list container\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n\n        exists = obj[@name] \n        Object.defineProperty obj, @name, this\n\n        # if joining for the first time, apply existing data unless explicit replace\n        unless @container?\n          debug? \"[join] #{@kind}(#{@name}) assigning first time\"\n          debug? opts\n          @container = obj\n          unless opts.replace is true\n            opts.suppress = true\n            @set exists, opts\n\n        unless obj.hasOwnProperty '__props__'\n          Object.defineProperty obj, '__props__', value: {}\n        obj.__props__[@name] = this\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern) -> switch\n        when pattern?\n          match = @find pattern\n          debug? match\n          switch\n            when match.length is 1 then match[0].get()\n            when match.length > 1  then match.map (x) -> x.get()\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then switch\n          when @binding? then @invoke.bind this\n          else @content\n        else\n          try @binding.call @context if @binding?\n          catch e then throw @error \"issue executing registered function binding during get()\", e\n          # TODO: should utilize yield to resolve promises\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        debug? \"[set] #{@kind}(#{@name}) enter with:\"\n        debug? value\n        debug? opts\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only element\"\n          \n        try\n          unless value instanceof Function\n            value = value.__.toJSON false if value.__ instanceof Property and value.__ isnt this\n          value = Object.create(value) unless Object.isExtensible(value)\n          Object.defineProperty value, '__', configurable: true, value: this\n          \n        value = switch\n          when @schema.apply?\n            @schema.apply value, @context.with(opts)\n          else value\n        return this if value instanceof Error\n\n        debug? \"[set] schema validation complete\"\n        \n        try\n          Object.defineProperty value, '__', value: this\n          if @schema.nodes.length and @kind isnt 'module'\n            for own k of value\n              desc = Object.getOwnPropertyDescriptor value, k\n              if desc.writable is true\n                debug? \"[set] hiding non-schema defined property: #{k}\"\n                Object.defineProperty value, k, enumerable: false\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        \n        if @binding?.length is 1 and not opts.force\n          try @binding.call @context, value \n          catch e\n            throw @error \"issue executing registered function binding during set()\", e\n        else\n          @state.value = value\n\n        try Object.defineProperty @container, @name, enumerable: @state.enumerable\n\n        @emit 'update', this  if this is @root or not opts.suppress\n        # try @join @container, opts\n        # catch e then @state.value = @state.prev; throw e\n        debug? \"[set] #{@kind}(#{@name}) completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        unless typeof @content is 'object' then return @set value\n\n        value = value[@name] if value? and value.hasOwnProperty @name\n        return this unless typeof value is 'object'\n        \n        if Array.isArray @content\n          length = @content.length\n          debug? \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          value = [ value ] unless Array.isArray value\n          try Object.defineProperty value, '__', configurable: true, value: this\n          value = @schema.apply value\n          debug? \"[merge] combining and applying schema\"\n          combine = @content.concat value\n          attr.apply combine for attr in @schema.attrs\n          value.forEach (item) =>\n            item.__.name += length\n            item.__.join @content, opts\n          prop = new Property @name, @schema\n          prop.state.container = @container\n          prop.state.value = value\n          return prop\n        else\n          # TODO: protect this as a transaction?\n          @content[k] = v for own k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n          return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        if not @content? and @kind is 'list' and not Array.isArray value\n          value = [ value ] \n        res = @merge value, replace: false\n        @emit 'create', this\n        return res\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@parent` containing object.\n      \n      remove: ->\n        if @key?\n          @container.splice @name, 1\n          #delete @parent[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          @join @container\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        xpath = switch\n          when pattern instanceof XPath then pattern\n          else XPath.parse pattern, @schema\n        debug? \"[#{@path}] finding #{pattern} starting with #{xpath.tag}\"\n        if opts.root or not @container? or xpath.tag not in [ '\/', '..' ]\n          debug? \"[#{@path}] #{@name} applying '#{xpath}'\"\n          debug? @content\n          xpath.apply(@content).props ? []\n        else switch\n          when xpath.tag is '\/'  and @parent? then @parent.find xpath, opts\n          when xpath.tag is '..' and @parent? then @parent.find xpath.xpath, opts\n          else []\n\n### invoke\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\n      invoke: (args...) ->\n        try\n          ctx = @context\n          unless ctx.action?\n            throw @error \"cannot invoke on a property without function\"\n          debug? \"[invoke] calling #{@name} method\"\n          # TODO: need to ensure unique instance of 'input' and 'output' for concurrency\n          ctx.input = args[0] ? {}\n          ctx.action.apply ctx, args\n          return co -> yield Promise.resolve ctx.output\n        catch e\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        res = new Error \"[#{at}] #{msg}\"\n        res.name = 'PropertyError'\n        res.context = ctx\n        return res\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          key:    @key\n          xpath:  @path.toString()\n          schema: @schema.toJSON tag: false, extended: true\n          active: @enumerable\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\nproperty's `@name`.\n\n      toJSON: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            res[k] = copy v for own k, v of src\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"51e7b8c059d15a8a9c988f6f460f86d10f57907a","subject":"bound getter should not set property.content","message":"bound getter should not set property.content\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object.__` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property') # if process.env.DEBUG?\n    co       = require 'co'\n    delegate = require 'delegates'\n    clone    = require 'clone'\n    Emitter  = require('events').EventEmitter\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n        Object.setPrototypeOf @state, Emitter.prototype\n\n        @schema.kind ?= 'anydata'\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .method 'once'\n        .method 'on'\n        .access 'container'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, force: true\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'parent', get: -> @container?.__\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n      \n      @property 'props',\n        get: -> prop for k, prop of @content?.__props__\n      \n      @property 'key',\n        get: ->\n          return unless @schema is @parent?.schema\n          switch\n            when @content not instanceof Object  then @name + 1\n            when @content.hasOwnProperty('@key') then @content['@key']\n            when Array.isArray @container\n              for idx, item of @container when item is @content\n                idx = Number(idx) unless (Number.isNaN (Number idx))\n                return idx+1\n              return undefined\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          key = @key\n          return @state.path if @state.path? and not key?\n          @debug \"[path] #{@kind}(#{@name}) has #{key} #{typeof key}\"\n          entity = switch typeof key\n            when 'number' then \".[#{key}]\"\n            when 'string' then \".[key('#{key}')]\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          @debug \"[path] #{@parent.name} + #{entity}\"\n          return @state.path = @parent.path.clone().append entity\n\n## Instance-level methods\n\n      clone: ->\n        @debug \"[clone] cloning with #{@props.length} properties\"\n        copy = (new @constructor @name, @schema)\n        copy.state[k] = v for k, v of @state\n        return copy\n        \n      emit: (event) ->\n        @state.emit arguments...\n        unless this is @root\n          @debug \"[emit] '#{event}' to '#{@root.name}'\"\n          @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It registers itself into\n`obj.__props__` as well as defined in the target `obj` via\n`Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false, force: false }) ->\n        return obj unless obj instanceof Object\n\n        detached = true unless @container?\n        @container = obj\n\n        if Array.isArray(obj) and Array.isArray(@content)\n          @debug @content\n          throw @error \"cannot join array property into list container\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n\n        # if joining for the first time, apply existing data unless explicit replace\n        exists = obj[@name] \n        if detached and opts.replace isnt true\n          @debug \"[join] applying existing data for #{@name} to:\"\n          @debug obj\n          opts.suppress = true\n          @set exists, opts\n\n        Object.defineProperty obj, @name, this\n        unless obj.hasOwnProperty '__props__'\n          Object.defineProperty obj, '__props__', value: {}\n        obj.__props__[@name] = this\n        @debug \"[join] attached into #{obj.constructor.name} container\"\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern, prop=false) -> switch\n        when pattern? and prop then @in pattern\n        when pattern?\n          match = @find pattern\n          switch\n            when match.length is 1 then match[0].content\n            when match.length > 1  then match.map (x) -> x.content\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then switch\n          when @binding? then @do.bind this\n          else @content\n        else\n          if @binding? and not (@kind is 'list' and @key?)\n            try return @binding.call @context\n            catch e\n              throw @error \"issue executing registered function binding during get()\", e\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        @debug \"[set] enter with:\"\n        @debug value\n        #@debug opts\n        return this if value is @content and not opts.force\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only element\"\n\n        try\n          unless value instanceof Function\n            if value.__ instanceof Property and value.__ isnt this\n              @debug \"[set] cloning existing property for assignment\"\n              value = clone(value)\n            value = Object.create(value) unless Object.isExtensible(value)\n          Object.defineProperty value, '__', configurable: true, value: this\n\n        value = switch\n          when @schema.apply?\n            @schema.apply value, @context.with(opts)\n          else value\n        return this if value instanceof Error\n        try\n          Object.defineProperties value,\n            '__': value: this\n            '$':  value: @get.bind(this)\n          if @schema.nodes.length and @kind isnt 'module'\n            for own k of value\n              desc = Object.getOwnPropertyDescriptor value, k\n              if desc.writable is true and not @schema.locate(k)?\n                @debug \"[set] hiding non-schema defined property: #{k}\"\n                Object.defineProperty value, k, enumerable: false\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        \n        if @binding?.length is 1 and not opts.force and @kind not in [ 'action', 'rpc' ]\n          try @binding.call @context, value \n          catch e\n            throw @error \"issue executing registered function binding during set()\", e\n        else\n          @state.value = value\n\n        try Object.defineProperty @container, @name,\n          configurable: true\n          enumerable: @state.enumerable\n\n        @emit 'update', this if this is @root or not opts.suppress\n        @debug \"[set] completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        opts.replace ?= true\n        unless @content instanceof Object\n          opts.replace = false\n          return @set value, opts\n\n        value = value[@name] if value? and value.hasOwnProperty @name\n        return this unless value instanceof Object\n        \n        if Array.isArray @content\n          length = @content.length\n          @debug \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          @debug value\n          # here we clone this Property and update with only the newly merged values\n          # XXX - this logic needs refinement, it doesn't handle min-elements condition properly\n          value = [ value ] unless Array.isArray value\n          copy = @clone()\n          copy.set value, force: opts.force, suppress: true\n          @debug \"[merge] combining and applying schema\"\n          if @schema.key? and opts.replace\n            exists = {}\n            @content.forEach (item) ->\n              key = item['@key']\n              exists[key] = item\n            @debug \"[merge] reducing existing keys\"\n            conflicts = 0\n            newitems = copy.content.reduce ((a, item) ->\n              key = item['@key']\n              item.__.name -= conflicts\n              if key of exists\n                conflicts++\n                exists[key].__.merge item\n              else\n                a.push item\n              return a\n            ), []\n            combine = @content.concat newitems\n          else\n            newitems = copy.content\n            combine = @content.concat newitems\n          attr.apply combine for attr in @schema.attrs\n          newitems.forEach (item) =>\n            item.__.name += length\n            item.__.join @content, opts\n          @emit 'update', copy unless opts.suppress\n          return copy\n        else\n          @debug \"[merge] merging into existing Object(#{Object.keys(@content).length}) for #{@name}\"\n          # TODO: protect this as a transaction?\n          @content[k] = v for own k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n          return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        if not @content? and @kind is 'list' and not Array.isArray value\n          value = [ value ] \n        res = @merge value, replace: false\n        @emit 'create', res\n        return res\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@container` parent object.\n      \n      remove: ->\n        return this unless @container?\n        if @key?\n          @container.splice @name, 1\n          #delete @parent[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          Object.defineProperty @container, @name, enumerable: false\n        @emit 'update', @parent if @parent?\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        unless pattern instanceof XPath\n          if \/^\\.\\.\\\/\/.test(pattern) and @parent?\n            return @parent.find pattern.replace(\/^\\.\\.\\\/\/, ''), opts\n          if \/^\\\/\/.test(pattern) and this isnt @root\n            return @root.find pattern, opts\n          pattern = XPath.parse pattern, @schema\n          \n        @debug \"[find] using #{pattern}\"\n        if opts.root or not @container? or pattern.tag not in [ '\/', '..' ]\n          @debug \"[find] apply #{pattern}\"\n          @debug @content\n          pattern.apply(@content).props ? []\n        else switch\n          when pattern.tag is '\/'  and @parent? then @parent.find pattern, opts\n          when pattern.tag is '..' and @parent? then @parent.find pattern.xpath, opts\n          else []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n            \n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\n      invoke: ->\n        console.warn \"DEPRECATION: please use .do() instead\"\n        @do arguments...\n        \n      do: ->\n        unless @content instanceof Function\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        try\n          @debug \"[do] executing method: #{@name}\"\n          ctx = @context.with('__': this)\n          @schema.input?.eval  ctx.state, {}\n          @schema.output?.eval ctx.state, {}\n          ctx.input = arguments\n          if @binding?\n            @debug \"[do] calling bound function\"\n            @debug @binding.toString()\n            @binding.apply ctx, arguments\n          else\n            @debug \"[do] calling assigned function\"\n            @debug @content.toString()\n            ctx.output = @content.apply ctx, arguments\n          return co =>\n            @debug \"[do] evaluating output schema\"\n            ctx.output = yield Promise.resolve ctx.output\n            @debug \"[do] finish setting output\"\n            return ctx.output\n        catch e\n          @debug e\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        res = new Error \"[#{at}] #{msg}\"\n        res.name = 'PropertyError'\n        res.context = ctx\n        return res\n\n      debug: (msg) ->\n        if debug? then switch typeof msg\n          when 'object' then debug msg\n          else\n            node = this\n            prefix = [ @name ]\n            prefix.unshift node.name while (node = node.parent)\n            debug \"[#{prefix.join('\/')}] #{msg}\"\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          key:    @key\n          xpath:  @path.toString()\n          schema: @schema.toJSON tag: false, extended: true\n          active: @enumerable\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\ncurrent property's `@name`.\n\n      toJSON: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            for own k, v of src when typeof v isnt 'function'\n              res[k] = copy v\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object.__` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property') # if process.env.DEBUG?\n    co       = require 'co'\n    delegate = require 'delegates'\n    clone    = require 'clone'\n    Emitter  = require('events').EventEmitter\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n        Object.setPrototypeOf @state, Emitter.prototype\n\n        @schema.kind ?= 'anydata'\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .method 'once'\n        .method 'on'\n        .access 'container'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, force: true, suppress: true\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'parent', get: -> @container?.__\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n      \n      @property 'props',\n        get: -> prop for k, prop of @content?.__props__\n      \n      @property 'key',\n        get: ->\n          return unless @schema is @parent?.schema\n          switch\n            when @content not instanceof Object  then @name + 1\n            when @content.hasOwnProperty('@key') then @content['@key']\n            when Array.isArray @container\n              for idx, item of @container when item is @content\n                idx = Number(idx) unless (Number.isNaN (Number idx))\n                return idx+1\n              return undefined\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          key = @key\n          return @state.path if @state.path? and not key?\n          @debug \"[path] #{@kind}(#{@name}) has #{key} #{typeof key}\"\n          entity = switch typeof key\n            when 'number' then \".[#{key}]\"\n            when 'string' then \".[key('#{key}')]\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          @debug \"[path] #{@parent.name} + #{entity}\"\n          return @state.path = @parent.path.clone().append entity\n\n## Instance-level methods\n\n      clone: ->\n        @debug \"[clone] cloning with #{@props.length} properties\"\n        copy = (new @constructor @name, @schema)\n        copy.state[k] = v for k, v of @state\n        return copy\n        \n      emit: (event) ->\n        @state.emit arguments...\n        unless this is @root\n          @debug \"[emit] '#{event}' to '#{@root.name}'\"\n          @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It registers itself into\n`obj.__props__` as well as defined in the target `obj` via\n`Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false, force: false }) ->\n        return obj unless obj instanceof Object\n\n        detached = true unless @container?\n        @container = obj\n\n        if Array.isArray(obj) and Array.isArray(@content)\n          @debug @content\n          throw @error \"cannot join array property into list container\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n\n        # if joining for the first time, apply existing data unless explicit replace\n        exists = obj[@name] \n        if detached and opts.replace isnt true\n          @debug \"[join] applying existing data for #{@name} to:\"\n          @debug obj\n          opts.suppress = true\n          @set exists, opts\n\n        Object.defineProperty obj, @name, this\n        unless obj.hasOwnProperty '__props__'\n          Object.defineProperty obj, '__props__', value: {}\n        obj.__props__[@name] = this\n        @debug \"[join] attached into #{obj.constructor.name} container\"\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern, prop=false) -> switch\n        when pattern? and prop then @in pattern\n        when pattern?\n          match = @find pattern\n          switch\n            when match.length is 1 then match[0].content\n            when match.length > 1  then match.map (x) -> x.content\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then switch\n          when @binding? then @do.bind this\n          else @content\n        else\n          if @binding? and not (@kind is 'list' and @key?)\n            try @content = @binding.call @context\n            catch e\n              throw @error \"issue executing registered function binding during get()\", e\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        @debug \"[set] enter with:\"\n        @debug value\n        #@debug opts\n        return this if value is @content and not opts.force\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only element\"\n\n        try\n          unless value instanceof Function\n            if value.__ instanceof Property and value.__ isnt this\n              @debug \"[set] cloning existing property for assignment\"\n              value = clone(value)\n            value = Object.create(value) unless Object.isExtensible(value)\n          Object.defineProperty value, '__', configurable: true, value: this\n\n        value = switch\n          when @schema.apply?\n            @schema.apply value, @context.with(opts)\n          else value\n        return this if value instanceof Error\n        try\n          Object.defineProperties value,\n            '__': value: this\n            '$':  value: @get.bind(this)\n          if @schema.nodes.length and @kind isnt 'module'\n            for own k of value\n              desc = Object.getOwnPropertyDescriptor value, k\n              if desc.writable is true and not @schema.locate(k)?\n                @debug \"[set] hiding non-schema defined property: #{k}\"\n                Object.defineProperty value, k, enumerable: false\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        \n        if @binding?.length is 1 and not opts.force and @kind not in [ 'action', 'rpc' ]\n          try @binding.call @context, value \n          catch e\n            throw @error \"issue executing registered function binding during set()\", e\n        else\n          @state.value = value\n\n        try Object.defineProperty @container, @name,\n          configurable: true\n          enumerable: @state.enumerable\n\n        @emit 'update', this if this is @root or not opts.suppress\n        @debug \"[set] completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        opts.replace ?= true\n        unless @content instanceof Object\n          opts.replace = false\n          return @set value, opts\n\n        value = value[@name] if value? and value.hasOwnProperty @name\n        return this unless value instanceof Object\n        \n        if Array.isArray @content\n          length = @content.length\n          @debug \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          @debug value\n          # here we clone this Property and update with only the newly merged values\n          # XXX - this logic needs refinement, it doesn't handle min-elements condition properly\n          value = [ value ] unless Array.isArray value\n          copy = @clone()\n          copy.set value, force: opts.force, suppress: true\n          @debug \"[merge] combining and applying schema\"\n          if @schema.key? and opts.replace\n            exists = {}\n            @content.forEach (item) ->\n              key = item['@key']\n              exists[key] = item\n            @debug \"[merge] reducing existing keys\"\n            conflicts = 0\n            newitems = copy.content.reduce ((a, item) ->\n              key = item['@key']\n              item.__.name -= conflicts\n              if key of exists\n                conflicts++\n                exists[key].__.merge item\n              else\n                a.push item\n              return a\n            ), []\n            combine = @content.concat newitems\n          else\n            newitems = copy.content\n            combine = @content.concat newitems\n          attr.apply combine for attr in @schema.attrs\n          newitems.forEach (item) =>\n            item.__.name += length\n            item.__.join @content, opts\n          @emit 'update', copy unless opts.suppress\n          return copy\n        else\n          @debug \"[merge] merging into existing Object(#{Object.keys(@content).length}) for #{@name}\"\n          # TODO: protect this as a transaction?\n          @content[k] = v for own k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n          return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        if not @content? and @kind is 'list' and not Array.isArray value\n          value = [ value ] \n        res = @merge value, replace: false\n        @emit 'create', res\n        return res\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@container` parent object.\n      \n      remove: ->\n        return this unless @container?\n        if @key?\n          @container.splice @name, 1\n          #delete @parent[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          Object.defineProperty @container, @name, enumerable: false\n        @emit 'update', @parent if @parent?\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        unless pattern instanceof XPath\n          if \/^\\.\\.\\\/\/.test(pattern) and @parent?\n            return @parent.find pattern.replace(\/^\\.\\.\\\/\/, ''), opts\n          if \/^\\\/\/.test(pattern) and this isnt @root\n            return @root.find pattern, opts\n          pattern = XPath.parse pattern, @schema\n          \n        @debug \"[find] using #{pattern}\"\n        if opts.root or not @container? or pattern.tag not in [ '\/', '..' ]\n          @debug \"[find] apply #{pattern}\"\n          @debug @content\n          pattern.apply(@content).props ? []\n        else switch\n          when pattern.tag is '\/'  and @parent? then @parent.find pattern, opts\n          when pattern.tag is '..' and @parent? then @parent.find pattern.xpath, opts\n          else []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n            \n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\n      invoke: ->\n        console.warn \"DEPRECATION: please use .do() instead\"\n        @do arguments...\n        \n      do: ->\n        unless @content instanceof Function\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        try\n          @debug \"[do] executing method: #{@name}\"\n          ctx = @context.with('__': this)\n          @schema.input?.eval  ctx.state, {}\n          @schema.output?.eval ctx.state, {}\n          ctx.input = arguments\n          if @binding?\n            @debug \"[do] calling bound function\"\n            @debug @binding.toString()\n            @binding.apply ctx, arguments\n          else\n            @debug \"[do] calling assigned function\"\n            @debug @content.toString()\n            ctx.output = @content.apply ctx, arguments\n          return co =>\n            @debug \"[do] evaluating output schema\"\n            ctx.output = yield Promise.resolve ctx.output\n            @debug \"[do] finish setting output\"\n            return ctx.output\n        catch e\n          @debug e\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        res = new Error \"[#{at}] #{msg}\"\n        res.name = 'PropertyError'\n        res.context = ctx\n        return res\n\n      debug: (msg) ->\n        if debug? then switch typeof msg\n          when 'object' then debug msg\n          else\n            node = this\n            prefix = [ @name ]\n            prefix.unshift node.name while (node = node.parent)\n            debug \"[#{prefix.join('\/')}] #{msg}\"\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          key:    @key\n          xpath:  @path.toString()\n          schema: @schema.toJSON tag: false, extended: true\n          active: @enumerable\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\ncurrent property's `@name`.\n\n      toJSON: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            for own k, v of src when typeof v isnt 'function'\n              res[k] = copy v\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"800df0fceb5f98aa01c93e20ef01c6029ee72382","subject":"review changes.","message":"review changes.\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08_request.litcoffee","new_file":"docs\/08_request.litcoffee","new_contents":"# Batman Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented in the platform layer files.\n\n### Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\n  Batman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\n  In other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n    \n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n There are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n 1. `loading()`: fired before `send()` has been called.\n\n    test \"Demonstrate the loading event\", 1, ->\n       new Batman.Request\n         url: \"http::\/\/batmanjs.org\"\n         loading: ->\n           ok true, \"After send but before the request is made\"\n\n 2. `loaded()`: fired after the request is complete\n\n     test \"Demo the loaded event\", 1, ->\n       Batman.Request.setupMockedResponse()\n       Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n       new Batman.Request\n         url: \"http:\/\/batmanjs.org\"\n         loaded: ->\n           ok true, \"Loaded\"\n\n 3. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n    test \"Demo the error event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        error: (xhr) ->\n          ok true, \"Error\"\n\n 4. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n    test \"Demonstrate the success event\", 1,  ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", response\n\n## .status\n  The response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\n  The response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : object\n  An key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request(options : object)\n\n  Constructs a new `Batman.Request` with the supplied options\n\n  `options` description\n  1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n  2. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`\n\n    test \"method test\", ->\n      Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"POST\"\n        data: { some: \"data\" }\n        success: (response) ->\n          ok true\n\n  3. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n  4. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n    test \"contentType default\", ->\n       req = new Batman.Request\n       equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n  5. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n    test \"autosend test\", ->\n      response_sent = false\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        success: (response) ->\n          response_sent = true\n      ok !response_sent\n      req.send()\n      ok response_sent\n\n  6. `username`: username for authentication\n  7. `password`: password for authentication\n  8. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send([data])\n  If `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","old_contents":"# Batman Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented the platform layer files.\n\n### Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.node.js`: \"querystring\" and \"url\"\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\n  Batman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\n  In other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n    \n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n There are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n 1. `loading()`: fired before `send()` has been called.\n\n    test \"Demonstrate the loading event\", 1, ->\n       new Batman.Request\n         url: \"http::\/\/batmanjs.org\"\n         loading: ->\n           ok true, \"After send but before the request is made\"\n\n 2. `loaded()`: fired after the request is complete\n\n     test \"Demo the loaded event\", 1, ->\n       Batman.Request.setupMockedResponse()\n       Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n       new Batman.Request\n         url: \"http:\/\/batmanjs.org\"\n         loaded: ->\n           ok true, \"Loaded\"\n\n 3. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n    test \"Demo the error event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        error: (xhr) ->\n          ok true, \"Error\"\n\n 4. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n    test \"Demonstrate the success event\", 1,  ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", response\n\n## .status\n  The response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\n  The response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : object\n  An key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request(options : object)\n\n  Constructs a new `Batman.Request` with the supplied options\n\n  `options` description\n  1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n  2. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`\n\n    test \"method test\", ->\n      Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"POST\"\n        data: { some: \"data\" }\n        success: (response) ->\n          ok true\n\n  3. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n  4. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n    test \"contentType default\", ->\n       req = new Batman.Request\n       equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n  5. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n    test \"autosend test\", ->\n      response_sent = false\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        success: (response) ->\n          response_sent = true\n      ok !response_sent\n      req.send()\n      ok response_sent\n\n  6. `username`: username for authentication\n  7. `password`: password for authentication\n  8. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send([data])\n  If `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5721f75679455ff47e25ceb2fb9be87b8f1d57e8","subject":"Add some text to make markdown render nicely","message":"Add some text to make markdown render nicely\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee `Model::validate` for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt takes a callback with two arguments: error and the array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## errors : ErrorsSet\n\n## constructor(idOrAttributes = {}) : Model\n\n## isNew() : boolean\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## toJSON() : Object\n\n## fromJSON() : Model\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## load(options = {}, callback)\n\n## save(options = {}, callback)\n\n## destroy(options = {}, callback)\n\n## validate(callback)\n\n# Batman.ValidationError\n\n# Batman.ErrorsSet\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee `Model::validate` for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n  + For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n  + For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## errors : ErrorsSet\n\n## constructor(idOrAttributes = {}) : Model\n\n## isNew() : boolean\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## toJSON() : Object\n\n## fromJSON() : Model\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## load(options = {}, callback)\n\n## save(options = {}, callback)\n\n## destroy(options = {}, callback)\n\n## validate(callback)\n\n# Batman.ValidationError\n\n# Batman.ErrorsSet\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"113ef39c23ea6158e1a3d97f8a010423e3857161","subject":"Add labels under ticks.","message":"Add labels under ticks.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The __TimelineMaker__ class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the __TimelineMaker__ class.  The __options__ parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are __formatTimeAxis()__, which formats time axis into a dictionary that describes the look of axis, and one of the __renderTo...__ functions that render that data dictionary to a desired context.\n\n#### The __formatTimeAxis()__ function\n\nA function that formats time axis into an intermediate format.  It has two parameters, __interval__ (a dictionary with __start__ and __end__ values, each of Date type) and corresponding to that interval __width__ of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be __options.intervalMultiplier__.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, __findPointList()__.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical element properties.  To transform time value into a coordinate we use the __timeToCoord()__ function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe should probably change ticks dictionary to lines dictionary instead, so we can add other types of lines, like baseline.  It could be better also to move all constants to options and make ticks drawing more flexible.\n\n        ticks = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            yTop: -@options.tickLength \/ 5\n            yBottom: @options.tickLength\n          }\n\nNow we add text labels too.\n\nHere we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {ticks, textLabels}\n\n#### The __findPointList()__ function\n\nThis function returns a list of points that are needed to be calculated for a (__start__, __end__) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the __start__ of the interval.  We move code that does that to the __findLeftTime()__.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using __findNextPoint()__ function.\n\n        pointList = until timePoint > end\n          timePoint = @findNextPoint timePoint\n\n#### The __findLeftTime()__ function\n\nThe __findLeftTime()__ function calculates the rightmost point of time for current __options.intervalType__ such that it is not inside the given __interval__ (excluding beginning).  The __options.intervalType__ could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\nAnother option, __options.intervalMultiplier__, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the __options.intervalMultiplier__ should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the __findNextPoint()__ function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In __findNextPoint()__ we make sure that edge points are consistent while using different values of __start__.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The __findNextPoint()__ function\n\nThis function calculates next edge time point for a current options assuming __timePoint__ argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The __timeToCoord()__ function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The __renderToCanvas()__ function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 2\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that the resulting graphics is more sharp (especially horizontal and vertical lines and text).\n\n        for tick in axisData.ticks\n          x = left + tick.x\n          yTop = top + tick.yTop\n          yBottom = top + tick.yBottom\n          context.moveTo @roundForCanvas(x), @roundForCanvas(yTop)\n          context.lineTo @roundForCanvas(x), @roundForCanvas(yBottom)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n      context.stroke()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-14T23:59:59')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\n    window.onload = makeDemo\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. At least show one time label that corresponds to the provided time interval.\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The __TimelineMaker__ class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the __TimelineMaker__ class.  The __options__ parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are __formatTimeAxis()__, which formats time axis into a dictionary that describes the look of axis, and one of the __renderTo...__ functions that render that data dictionary to a desired context.\n\n#### The __formatTimeAxis()__ function\n\nA function that formats time axis into an intermediate format.  It has two parameters, __interval__ (a dictionary with __start__ and __end__ values, each of Date type) and corresponding to that interval __width__ of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be __options.intervalMultiplier__.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, __findPointList()__.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical element properties.  To transform time value into a coordinate we use the __timeToCoord()__ function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.\n\n        ticks = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            yTop: -@options.tickLength \/ 5\n            yBottom: @options.tickLength\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {ticks: ticks}\n\n#### The __findPointList()__ function\n\nThis function returns a list of points that are needed to be calculated for a (__start__, __end__) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the __start__ of the interval.  We move code that does that to the __findLeftTime()__.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using __findNextPoint()__ function.\n\n        pointList = until timePoint > end\n          timePoint = @findNextPoint timePoint\n\n#### The __findLeftTime()__ function\n\nThe __findLeftTime()__ function calculates the rightmost point of time for current __options.intervalType__ such that it is not inside the given __interval__ (excluding beginning).  The __options.intervalType__ could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\nAnother option, __options.intervalMultiplier__, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the __options.intervalMultiplier__ should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the __findNextPoint()__ function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In __findNextPoint()__ we make sure that edge points are consistent while using different values of __start__.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The __findNextPoint()__ function\n\nThis function calculates next edge time point for a current options assuming __timePoint__ argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The __timeToCoord()__ function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The __renderToCanvas()__ function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.lineWidth = 2\n        context.clearRect 0, 0, canvas.width, canvas.height\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that the resulting graphics is more sharp (especially horizontal and vertical lines and text).\n\n        for tick in axisData.ticks\n          x = left + tick.x\n          yTop = top + tick.yTop\n          yBottom = top + tick.yBottom\n          context.moveTo @roundForCanvas(x), @roundForCanvas(yTop)\n          context.lineTo @roundForCanvas(x), @roundForCanvas(yBottom)\n        context.stroke()\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\n    window.onload = makeDemo\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ee879b8f1195eda5453a036b103ec45177eb9248","subject":"Added documentation for params. Also added a new ground.max_segment_width param","message":"Added documentation for params. Also added a new ground.max_segment_width param\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/arguments.litcoffee","new_file":"lib\/arguments.litcoffee","new_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] levelname anotherlevelname yetanotherlevelname ...'\n      .example '$0',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -vvvvvvvv',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to verbosity level 8 (max)\\n\"\n      .example '$0 -w 20 -h 20',\n        \"Creates a level with default row and column counts,\n         the cells 20 units wide, 20 units high,\n         expanded by the default multiplier,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -w 10 -h 10 -x 4',\n        \"Creates a level with default row and column counts,\n         40 x 40 unit cells,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 lvl1 lvl2',\n        \"Creates two levels; named lvl1 and lvl2 -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 --levels one two three',\n        \"Creates three levels; named one, two, and three -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 -l10',\n        \"Creates ten auto-named levels -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .string 'conf'\n      .describe 'conf', 'Absolute path to config file'\n      .string 'block.fill_color'\n      .describe 'block.fill_color', 'Path block color. Can be an html color name or hex value'\n      .string 'ground.fill_color'\n      .describe 'ground.fill_color', 'Ground block color. Can be an html color name or hex value'\n      .string 'step_count.text.align'\n      .choices 'step_count.text.align', [ 'left', 'center', 'right' ]\n      .string 'step_count.text.color'\n      .describe 'step_count.text.color', 'Can be either html color names or hex values'\n      .number 'ground.segments'\n      .describe 'ground.segments', 'The number of horizontal pieces of ground between the left and right edges of the block'\n      .number 'ground.max_height_diff'\n      .describe 'ground.max_height_diff', 'The height unit difference between two adjacent ground segments'\n      .number 'ground.max_segment_width'\n      .describe 'ground.max_segment_width', 'The number of ground segments wide the widest a single ground segment can be'\n      .number 'wall.width'\n      .string 'wall.color'\n      .describe 'wall.color', 'Can be either html color names or hex values'\n      .number 'wall.segments'\n      .describe 'wall.segments', 'The number of vertical pieces of wall between the ground and roof'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      24\n        height:     24\n        multiplier: 4\n        # pipeline:   [ 'json_blocks', 'json_ground', 'json_walls' ]\n        # pipeline:   [ 'png_blocks', 'png_walls', 'png_ground', 'png_step_count' ]\n        pipeline: [\n          [ 'json_blocks', 'json_ground', 'json_walls' ]\n          [ 'png_blocks',  'png_ground',  'png_walls', 'png_roof', 'png_step_count' ]\n        ]\n        block:\n          fill_color: 'white'\n        ground:\n          fill_color:     '#888'\n          segments:        24\n          max_height_diff: 4\n          max_segment_width: 6\n        step_count:\n          text:\n            align: 'center'\n            color: 'black'\n        wall:\n          width: 1\n          color: '#666'\n          segments: 24\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .wrap 120\n      .argv\n","old_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] levelname anotherlevelname yetanotherlevelname ...'\n      .example '$0',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -vvvvvvvv',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to verbosity level 8 (max)\\n\"\n      .example '$0 -w 20 -h 20',\n        \"Creates a level with default row and column counts,\n         the cells 20 units wide, 20 units high,\n         expanded by the default multiplier,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -w 10 -h 10 -x 4',\n        \"Creates a level with default row and column counts,\n         40 x 40 unit cells,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 lvl1 lvl2',\n        \"Creates two levels; named lvl1 and lvl2 -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 --levels one two three',\n        \"Creates three levels; named one, two, and three -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 -l10',\n        \"Creates ten auto-named levels -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .string 'conf'\n      .describe 'conf', 'Absolute path to config file'\n      .string 'block.fill_color'\n      .describe 'block.fill_color', 'Path block color. Can be an html color name or hex value'\n      .string 'ground.fill_color'\n      .describe 'ground.fill_color', 'Ground block color. Can be an html color name or hex value'\n      .string 'step_count.text.align'\n      .choices 'step_count.text.align', [ 'left', 'center', 'right' ]\n      .string 'step_count.text.color'\n      .describe 'step_count.text.color', 'Can be either html color names or hex values'\n      .number 'ground.segments'\n      .number 'ground.max_height_diff'\n      .number 'wall.width'\n      .string 'wall.color'\n      .describe 'wall.color', 'Can be either html color names or hex values'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      24\n        height:     24\n        multiplier: 4\n        # pipeline:   [ 'json_blocks', 'json_ground', 'json_walls' ]\n        # pipeline:   [ 'png_blocks', 'png_walls', 'png_ground', 'png_step_count' ]\n        pipeline: [\n          [ 'json_blocks', 'json_ground', 'json_walls' ]\n          [ 'png_blocks',  'png_ground',  'png_walls', 'png_roof', 'png_step_count' ]\n        ]\n        block:\n          fill_color: 'white'\n        ground:\n          fill_color:     '#888'\n          segments:        24\n          max_height_diff: 4\n        step_count:\n          text:\n            align: 'center'\n            color: 'black'\n        wall:\n          width: 1\n          color: '#666'\n          segments: 24\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .wrap 120\n      .argv\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f82662c3beaaa0c5fd8074014b4397eff8b949fc","subject":"Export Observable object","message":"Export Observable object","repos":"it-vecherka\/jnoid","old_file":"jnoid.litcoffee","new_file":"jnoid.litcoffee","new_contents":"Jnoid\n=====\n\nThis is a functional reactive programming library in Coffescript to use in\nbrowser or Node.js applications. It owes the idea to Bacon.js, but should\ndescribe the domain in proper terms, have less operations in primitives and be\nshorter and simpler.\n\n    Jnoid = {\n      VERSION: \"0.0.1\"\n    }\n\nThe core idea is having an abstraction of `Stream` which is a discrete\nsequence of values and an abstraction of a `Box` which is a continous\ntime-varying value, both of which you can subscribe on.\n\nMaybe and Events\n----------------\n\nWe'll slightly extend the famous `Maybe` idiom to support error values. Now\nit's a sum of `Maybe` and `Either` and can be described as `Maybe = Just x |\nWrong y | Nothing`.\n\n    class Maybe\n\n    class Just extends Maybe\n      constructor: (@value) ->\n      getOrElse: -> @value\n      filter: (f) -> if @test(f) then @ else Nothing\n      test: (f) -> f @value\n      map: (f) -> new Just(f @value)\n      isEmpty: -> false\n      inspect: -> \"Just #{@value}\"\n\n    class Bad extends Maybe\n      getOrElse: (some)-> some\n      filter: (f) -> @\n      test: (f) -> true\n      map: (f) -> @\n      isEmpty: -> true\n\n    class Wrong extends Bad\n      constructor: (@error) ->\n      inspect: -> \"Wrong #{@error}\"\n\n    Nothing = new class extends Bad\n      constructor: ->\n      inspect: -> \"Nothing\"\n\n`Event` class will be just a type alias for it.\n\n    [Event, Fire, Error, Stop] = [Maybe, Just, Wrong, Nothing]\n    toEvent = (x) -> if x instanceof Event then x else new Fire x\n    toError = (x) -> if x instanceof Event then x else new Error x\n\nObservable\n----------\n\nThe point is that we can abstract from `Stream` and `Box` and define a common\nbehavior, calling it `Observable`.\n\nClass `Observable` will be determined via a `subscribe` function. This\nfunction should receive a subscriber or sink function as an argument and\ncall it whenever event is fired. This enables push semantics for `Stream`\nand `Box`.\n\nThere are two ways to unsubscribe. First is to call function that subscribe\nreturns. Second is return `Reply.stop` from event listener.\n\n    class Observable\n      constructor: (subscribe)->\n        @subscribe = @dispatched subscribe\n\n`dispathed` is a function that makes `Observable` abstract and will hold the\nactual implementation differences between `Stream` and `Box`. If you are\ninterested in `dispatched`, check it's implementations there.\n\n      dispatched: fail\n\nA basic ways to listen to Observable are `onValue` and `onError`. While\n`subscribe` sends raw events, `onValue` unwraps them in case they hold values\nand deliver them to the subscriber.\n\n      onValue: (f) ->\n        @subscribe (event) ->\n          event.map((v)-> f(v)).getOrElse(Reply.more)\n\n`onError` does roughly the same as `onValue`, but is selecting errors and\nunwraps them.\n\n      onError: (f) ->\n        @subscribe (event) ->\n          if event instanceof Error\n            f event.error\n          else\n            Reply.more\n\nWe can now define basic transforms. Start with `map` and `filter`. We can\nsee common pattern there, it's abstracted in `withHandler`.\n\n      withHandler: (handler)->\n        new @constructor @dispatched(@subscribe, handler)\n\n      map: (f)->\n        @withHandler (event)-> @push event.map(f)\n\n      filter: (f)->\n        @withHandler (event)-> if event.test(f) then @push event else Reply.more\n\nA useful combinator is `recover`, with will turn errors into regular\nevents using transform function.\n\n      recover: (f)->\n        @withHandler (event) ->\n          if event instanceof Error\n            @push new Fire f(event.error)\n          else\n            @push event\n\nThe most powerful combinator in our case is `flatMap`. It accepts a function\nthat turns each of the values in observable to a new observable. We then return\na new Observable that will combine them.\n\nThe first way to combine them is to just collect all the events from the\nspawned childen. This matches the semantics of `Stream` and will allow us to\nproduce `merge`.\n\nAnother way to combine events is to unsubscribe all the existing children, when\na new event occurs on root, then spawn a new one and just listen to it. You can\nthink of it as swiching from one observable to another one. This matches the\nsemantics of `Box` and will allow us to produce `zip`.\n\n      flatMapGeneric: (f, lastOnly) ->\n        root = this\n        new @constructor (sink) ->\n          children = []\n          rootStop = false\n          unsubRoot = ->\n          unsubChildren = ->\n            unsubChild() for unsubChild in children\n            children = []\n          unbind = ->\n            unsubChildren()\n            unsubRoot()\n          checkStop = ->\n            if rootStop and (children.length == 0)\n              sink Stop\n          spawner = (event) ->\n            if event == Stop\n              rootStop = true\n              checkStop()\n            else\n              unsubChildren() if lastOnly\n              if event instanceof Error\n                sink event\n              else\n                child = f event.value\n                unsubChild = undefined\n                childStopped = false\n                removeChild = ->\n                  remove(unsubChild, children) if unsubChild?\n                  checkStop()\n                handler = (event) ->\n                  if event == Stop\n                    removeChild()\n                    childStopped = true\n                    Reply.stop\n                  else\n                    tap sink(event), (reply)->\n                      unbind() if reply == Reply.stop\n                unsubChild = child.subscribe handler\n                children.push unsubChild if not childStopped\n          unsubRoot = root.subscribe(spawner)\n          unbind\n\n      flatMapAll: (f)-> @flatMapGeneric(f, false)\n      flatMapLast: (f)-> @flatMapGeneric(f, true)\n\nWe can also define `skipDuplicates` which is extremely useful.\n\n      withStateMachine: (initState, f) ->\n        state = initState\n        @withHandler (event) ->\n          [newState, outputs] = f(state, event)\n          state = newState\n          stopped = any outputs,\n                    (output)=> @push(output) == Reply.stop\n          if stopped then Reply.stop else Reply.more\n\n      skipDuplicates: (isEqual = (a, b) -> a is b) ->\n        @withStateMachine Nothing, (prev, event) ->\n          event.map((v)->\n            if prev == Nothing || !prev.test((p)-> isEqual(v, p))\n              [new Just(v), [event]]\n            else\n              [prev, []]\n          ).getOrElse [prev, [event]]\n\nFrom `withStateMachine` we can easily define `scan`:\n\n      scan: (initState, f) ->\n        @withStateMachine initState, (acc, event)->\n          newAcc = event.map((v)->f(acc, v)).getOrElse(acc)\n          [newAcc, [toEvent newAcc]]\n\nAlways good in UI there is an option to `debounce`:\n\n      debounce: (delay)->\n        @flatMapLast (value)=>\n          @constructor.later delay, value\n\nLet's do `take` and `takeWhile`:\n\n      take: (n)->\n        return @constructor.nothing() if n <= 0\n        @withHandler (event) ->\n          unless event instanceof Fire\n            @push event\n          else\n            n--\n            if n > 0\n              @push event\n            else\n              @push event if n == 0\n              @push Stop\n              Reply.stop\n\n      takeWhile: (f)->\n        @withHandler (event) ->\n          if event.test(f)\n            @push event\n          else\n            @push Stop\n            Reply.stop\n\n`takeUntil` is going to be slightly more complicated - it's going to listen to\none stream till an event on another appears. A very useful one:\n\n      takeUntil: (other)->\n        source = this\n        stopper = other.changes()\n        new @constructor (sink)->\n          unsubSource = ->\n          unsubStopper = ->\n          unbind = ->\n            unsubSource()\n            unsubStopper()\n\n          transport = (event)->\n            sink event\n            unbind() if event == Stop\n          watcher = (event)->\n            sink Stop\n            unbind()\n\n          unsubSource = source.subscribe(transport)\n          unsubStopper = stopper.subscribe(watcher)\n          unbind\n\nA helper method for boolean algebra (others are map2 based methods and so are\njust applicable to box):\n\n      not: -> @map (x)-> !x\n\nHow to build observables\n\n------------------------\n\nThe basic ways to build an observable are `nothing`, `unit` and `error`. In\n`Stream` semantics they mean `never`, `once` and `error`, in `Box` semantics\nthey mean `empty`, `always` and `error`. We won't create the aliases and give\nthese names to get you the feel of what they mean.\n\n      @fromList: (values, wrapper = toEvent)->\n        new @ (sink) ->\n          sink event for event in map wrapper, values\n          sink Stop\n\n      @nothing: -> @fromList []\n      @unit: (value)-> @fromList [value]\n      @error: (value)-> @fromList [value], toError\n\n`fromBinder` just adds a syntax sugar for us to easily define more\nsophisticated constructors.\n\n      @fromBinder: (binder, transform = id) ->\n        new @ (sink) ->\n          unbinder = binder (args...) ->\n            events = toArray transform args...\n            for event in map toEvent, events\n              tap sink(event), (reply)->\n                unbinder() if event == Stop or reply == Reply.stop\n\n`poll` polls a function within given interval.\n\n      @poll: (delay, poll) ->\n        @fromBinder (handler) ->\n          i = setInterval(handler, delay)\n          -> clearInterval(i)\n        , poll\n\n`interval` and `later` send a fixed list of events or one event\nrespectively within given interval.\n\n      @interval: (delay, list)->\n        index = 0\n        @poll delay, ->\n          value = list[index++]\n          if index < list.length\n            value\n          else if index == list.length\n            [value, Stop]\n          else\n            Stop\n\n      @later: (delay, value)->\n        @interval(delay, [value])\n\nLet's also define a function that works on promises, e.g., ajax. The\nresource releasing here for ajax is abort. We should also handle promise\nerrors here. In a transform function we attach end to our stream.\n\n      @fromPromise: (promise) ->\n        @fromBinder (handler) ->\n          promise.then handler, (e) ->\n            handler new Error e\n          -> promise.abort?()\n        , (value) -> [value, Stop]\n\nFinally let's define the way to receive events from DOM objects. We'll do\nit assuming we're called in jQuery\/Zepto fashion.\n\nWe allow to override `transform` - by default it'll take the first\nargument, which is usually a jQuery event. We use `on` to subscribe and\n`off` to unsubscribe.\n\n      @fromDOM: (element, event, selector, transform) ->\n        [transform, selector] = [selector, null] if isFunction(selector)\n\n        @fromBinder (handler) =>\n          element.on(event, selector, handler)\n          => element.off(event, selector, handler)\n        , transform\n\n\nStream\n------\n\nClass `Stream` represents a disrete sequence of values, coupled with time.  So\nit uses the appropriate dispatcher to do it.\n\n`Dispatcher` activates the listeners when a first sink is added and then just\nadds them. On each event it just pushes it to all sinks.\n\n    class StreamDispatcher\n      constructor: (subscribe, handler) ->\n        subscribe ?= (event) ->\n        sinks = []\n        @push = (event) =>\n          for sink in sinks by -1\n            tap sink(event), (reply)->\n              remove sink, sinks if reply == Reply.stop\n        handler ?= (event) -> @push event\n        @handler = (event) => handler.apply(this, [event])\n        @subscribe = (sink) =>\n          sinks.push(sink)\n          unsubSelf = subscribe @handler if sinks.length == 1\n          ->\n            remove sink, sinks\n            unsubSelf?() unless any sinks\n\nTo have `Stream` class we just need to override abstract `dispatched` method\nfrom the base class to use `StreamDispatcher`.\n\n    class Stream extends Observable\n      dispatched: (subscribe, handler)->\n        new StreamDispatcher(subscribe, handler).subscribe\n\nFor this class we can have `flatMap` aka `bind`. In our case it's `flatMapAll`.\n\n      flatMap: (args...)-> @flatMapAll(args...)\n\nHaving this we can easily have `merge`.\n\n      merge: (others...)->\n        Stream.fromList(map method(\"changes\"), [@, others...]).flatten()\n      flatten: -> @flatMap(id)\n\nUsing Stream when we need Box\n-----------------------------\n\nTo make it transparent for a user, is this stream or box, we proxy the box\nmethods to box. First we define a conversion method with an optional starting\nvalue.\n\n      box: (initial = Nothing)->\n        initial = toMaybe(initial)\n        new Box (sink)=>\n          sink initial unless initial.isEmpty()\n          @subscribe (event)-> sink event\n      changes: -> @\n\nWe could also define a new stream with initial value merged to the beginning,\nbut the current code is simple enough.\n\nAll proxy methods are trivial.\n\n      zipWith: (others..., f)-> @box().zipWith(others..., f)\n      and: (others...)-> @box().and(others...)\n      or: (others...)-> @box().or(others...)\n      not: -> @box().not()\n\nBox\n---\n\nClass `Box` represents continuous value that changes with time. So we need a\nslightly tweaked dispatcher. The difference is that it holds the current\nvalue and sends it to each new subscriber. Another difference is that even when\nthe Box is ended, it still sends the last value and then immediately sends stop\n\n    class BoxDispatcher extends StreamDispatcher\n      constructor: (subscribe, handler) ->\n        super subscribe, handler\n        current = Nothing\n        push = @push\n        subscribe = @subscribe\n        stopped = false\n\n        @push = (event) =>\n          event.map((x) -> current = new Just x)\n          stopped = true if event == Stop\n          push.apply(this, [event])\n        @subscribe = (sink) =>\n          reply = current.map((v)-> sink new Fire v)\n          if reply.getOrElse(Reply.more) == Reply.stop\n            nop\n          else if stopped\n            sink Stop\n            nop\n          else\n            subscribe.apply(@, [sink])\n\nNow class `Box` is going to use that dispatcher.\n\n    class Box extends Observable\n      dispatched: (subscribe, handler)->\n        new BoxDispatcher(subscribe, handler).subscribe\n\nFor this class we can have `flatMap` aka `bind`. In our case it's `flatMapLast`.\n\n      flatMap: (args...)-> @flatMapLast(args...)\n\nWith this `flatMap` we can define a glorious `map2`, also known as `zipWith`\nfor two boxes.\n\n      map2: (other, f)->\n        @flatMap (x)-> other.box().map (y)-> f(x, y)\n\nHaving this, `zipWith` is easy.\n\n      @sequence: (boxes)->\n        foldl boxes, @unit([]), (acc, box)->\n          acc.map2 box, (memo, value)-> append memo, value\n      @zipWith: (boxes, f)->\n        @sequence(boxes).map uncurry f\n      zipWith: (others..., f)->\n        Box.zipWith [@, others...], f\n\n`zip` method is it just sugar for the `sequence`.\n\n      zip: (boxes...)-> Box.sequence([@, boxes...])\n\nHelpful would be to define boolean algebra over boxes. `not` is defined on\n`Observable`.\n\n      and: (others...)-> @zipWith others..., (a, b)-> a && b\n      or: (others...)-> @zipWith others..., (a, b)-> a || b\n\nAn interesting `sampledBy` function should take a property and stream it's\nvalue when sampler pops:\n\n      sampledBy: (sampler)->\n        sampler.flatMap(=> @take(1)).changes()\n\nUsing Box when we need Stream\n-----------------------------\n\nTo convert `Box` into `Stream` we take it's changes.\n\n      changes: ->\n        new Stream (sink)=>\n          @subscribe (event)-> sink event\n      box: -> @\n\nHere are the proxy methods.\n\n      merge: (others...)-> @changes().merge(others...)\n\nHelpers\n-------\n\nPretty trivial special values to return from event listeners.\n\n    Reply =\n      stop: \"<stop>\"\n      more: \"<more>\"\n\nWe need some simple helper functions.\n\n    empty = (xs)-> xs.length == 0\n    method = (meth)-> (obj)-> obj[meth]()\n    nop = ->\n    id = (x)-> x\n    fail = -> throw \"method not implemented\"\n    head = (xs) -> xs[0]\n    tail = (xs) -> xs[1...xs.length]\n    uncurry = (f) -> (args)-> f(args...)\n    map = (f, xs) -> f(x) for x in xs\n    foldl = (xs, seed, f) ->\n      for x in xs\n        seed = f(seed, x)\n      seed\n    tap = (x, f) ->\n      f(x)\n      x\n    remove = (x, xs) ->\n      i = xs.indexOf(x)\n      xs.splice(i, 1) if i >= 0\n    all = (xs, f = id) ->\n      for x in xs\n        return false if not f(x)\n      return true\n    any = (xs, f = id) ->\n      for x in xs\n        return true if f(x)\n      return false\n    copyArray = (xs)-> xs.slice()\n    append = (xs, x)-> tap copyArray(xs), (copy)-> copy.push x\n    isFunction = (f) -> typeof f == \"function\"\n    toArray = (x) -> if x instanceof Array then x else [x]\n    toMaybe = (x) ->\n      if x instanceof Maybe then x else new Just x\n\nExports\n-------\n\nWe now need to make our objects usable outside.\n\n    for name, value of {Observable, Stream, Box, Event, Fire, Error, Stop,\n                                     Maybe, Just, Wrong, Nothing}\n      Jnoid[name] = value\n\n    if define?.amd\n      define [], -> Jnoid\n    else if module?.exports\n      module.exports = Jnoid\n    else\n      @Jnoid = Jnoid\n\nConclusion\n----------\n\nHave fun!\n","old_contents":"Jnoid\n=====\n\nThis is a functional reactive programming library in Coffescript to use in\nbrowser or Node.js applications. It owes the idea to Bacon.js, but should\ndescribe the domain in proper terms, have less operations in primitives and be\nshorter and simpler.\n\n    Jnoid = {\n      VERSION: \"0.0.1\"\n    }\n\nThe core idea is having an abstraction of `Stream` which is a discrete\nsequence of values and an abstraction of a `Box` which is a continous\ntime-varying value, both of which you can subscribe on.\n\nMaybe and Events\n----------------\n\nWe'll slightly extend the famous `Maybe` idiom to support error values. Now\nit's a sum of `Maybe` and `Either` and can be described as `Maybe = Just x |\nWrong y | Nothing`.\n\n    class Maybe\n\n    class Just extends Maybe\n      constructor: (@value) ->\n      getOrElse: -> @value\n      filter: (f) -> if @test(f) then @ else Nothing\n      test: (f) -> f @value\n      map: (f) -> new Just(f @value)\n      isEmpty: -> false\n      inspect: -> \"Just #{@value}\"\n\n    class Bad extends Maybe\n      getOrElse: (some)-> some\n      filter: (f) -> @\n      test: (f) -> true\n      map: (f) -> @\n      isEmpty: -> true\n\n    class Wrong extends Bad\n      constructor: (@error) ->\n      inspect: -> \"Wrong #{@error}\"\n\n    Nothing = new class extends Bad\n      constructor: ->\n      inspect: -> \"Nothing\"\n\n`Event` class will be just a type alias for it.\n\n    [Event, Fire, Error, Stop] = [Maybe, Just, Wrong, Nothing]\n    toEvent = (x) -> if x instanceof Event then x else new Fire x\n    toError = (x) -> if x instanceof Event then x else new Error x\n\nObservable\n----------\n\nThe point is that we can abstract from `Stream` and `Box` and define a common\nbehavior, calling it `Observable`.\n\nClass `Observable` will be determined via a `subscribe` function. This\nfunction should receive a subscriber or sink function as an argument and\ncall it whenever event is fired. This enables push semantics for `Stream`\nand `Box`.\n\nThere are two ways to unsubscribe. First is to call function that subscribe\nreturns. Second is return `Reply.stop` from event listener.\n\n    class Observable\n      constructor: (subscribe)->\n        @subscribe = @dispatched subscribe\n\n`dispathed` is a function that makes `Observable` abstract and will hold the\nactual implementation differences between `Stream` and `Box`. If you are\ninterested in `dispatched`, check it's implementations there.\n\n      dispatched: fail\n\nA basic ways to listen to Observable are `onValue` and `onError`. While\n`subscribe` sends raw events, `onValue` unwraps them in case they hold values\nand deliver them to the subscriber.\n\n      onValue: (f) ->\n        @subscribe (event) ->\n          event.map((v)-> f(v)).getOrElse(Reply.more)\n\n`onError` does roughly the same as `onValue`, but is selecting errors and\nunwraps them.\n\n      onError: (f) ->\n        @subscribe (event) ->\n          if event instanceof Error\n            f event.error\n          else\n            Reply.more\n\nWe can now define basic transforms. Start with `map` and `filter`. We can\nsee common pattern there, it's abstracted in `withHandler`.\n\n      withHandler: (handler)->\n        new @constructor @dispatched(@subscribe, handler)\n\n      map: (f)->\n        @withHandler (event)-> @push event.map(f)\n\n      filter: (f)->\n        @withHandler (event)-> if event.test(f) then @push event else Reply.more\n\nA useful combinator is `recover`, with will turn errors into regular\nevents using transform function.\n\n      recover: (f)->\n        @withHandler (event) ->\n          if event instanceof Error\n            @push new Fire f(event.error)\n          else\n            @push event\n\nThe most powerful combinator in our case is `flatMap`. It accepts a function\nthat turns each of the values in observable to a new observable. We then return\na new Observable that will combine them.\n\nThe first way to combine them is to just collect all the events from the\nspawned childen. This matches the semantics of `Stream` and will allow us to\nproduce `merge`.\n\nAnother way to combine events is to unsubscribe all the existing children, when\na new event occurs on root, then spawn a new one and just listen to it. You can\nthink of it as swiching from one observable to another one. This matches the\nsemantics of `Box` and will allow us to produce `zip`.\n\n      flatMapGeneric: (f, lastOnly) ->\n        root = this\n        new @constructor (sink) ->\n          children = []\n          rootStop = false\n          unsubRoot = ->\n          unsubChildren = ->\n            unsubChild() for unsubChild in children\n            children = []\n          unbind = ->\n            unsubChildren()\n            unsubRoot()\n          checkStop = ->\n            if rootStop and (children.length == 0)\n              sink Stop\n          spawner = (event) ->\n            if event == Stop\n              rootStop = true\n              checkStop()\n            else\n              unsubChildren() if lastOnly\n              if event instanceof Error\n                sink event\n              else\n                child = f event.value\n                unsubChild = undefined\n                childStopped = false\n                removeChild = ->\n                  remove(unsubChild, children) if unsubChild?\n                  checkStop()\n                handler = (event) ->\n                  if event == Stop\n                    removeChild()\n                    childStopped = true\n                    Reply.stop\n                  else\n                    tap sink(event), (reply)->\n                      unbind() if reply == Reply.stop\n                unsubChild = child.subscribe handler\n                children.push unsubChild if not childStopped\n          unsubRoot = root.subscribe(spawner)\n          unbind\n\n      flatMapAll: (f)-> @flatMapGeneric(f, false)\n      flatMapLast: (f)-> @flatMapGeneric(f, true)\n\nWe can also define `skipDuplicates` which is extremely useful.\n\n      withStateMachine: (initState, f) ->\n        state = initState\n        @withHandler (event) ->\n          [newState, outputs] = f(state, event)\n          state = newState\n          stopped = any outputs,\n                    (output)=> @push(output) == Reply.stop\n          if stopped then Reply.stop else Reply.more\n\n      skipDuplicates: (isEqual = (a, b) -> a is b) ->\n        @withStateMachine Nothing, (prev, event) ->\n          event.map((v)->\n            if prev == Nothing || !prev.test((p)-> isEqual(v, p))\n              [new Just(v), [event]]\n            else\n              [prev, []]\n          ).getOrElse [prev, [event]]\n\nFrom `withStateMachine` we can easily define `scan`:\n\n      scan: (initState, f) ->\n        @withStateMachine initState, (acc, event)->\n          newAcc = event.map((v)->f(acc, v)).getOrElse(acc)\n          [newAcc, [toEvent newAcc]]\n\nAlways good in UI there is an option to `debounce`:\n\n      debounce: (delay)->\n        @flatMapLast (value)=>\n          @constructor.later delay, value\n\nLet's do `take` and `takeWhile`:\n\n      take: (n)->\n        return @constructor.nothing() if n <= 0\n        @withHandler (event) ->\n          unless event instanceof Fire\n            @push event\n          else\n            n--\n            if n > 0\n              @push event\n            else\n              @push event if n == 0\n              @push Stop\n              Reply.stop\n\n      takeWhile: (f)->\n        @withHandler (event) ->\n          if event.test(f)\n            @push event\n          else\n            @push Stop\n            Reply.stop\n\n`takeUntil` is going to be slightly more complicated - it's going to listen to\none stream till an event on another appears. A very useful one:\n\n      takeUntil: (other)->\n        source = this\n        stopper = other.changes()\n        new @constructor (sink)->\n          unsubSource = ->\n          unsubStopper = ->\n          unbind = ->\n            unsubSource()\n            unsubStopper()\n\n          transport = (event)->\n            sink event\n            unbind() if event == Stop\n          watcher = (event)->\n            sink Stop\n            unbind()\n\n          unsubSource = source.subscribe(transport)\n          unsubStopper = stopper.subscribe(watcher)\n          unbind\n\nA helper method for boolean algebra (others are map2 based methods and so are\njust applicable to box):\n\n      not: -> @map (x)-> !x\n\nHow to build observables\n\n------------------------\n\nThe basic ways to build an observable are `nothing`, `unit` and `error`. In\n`Stream` semantics they mean `never`, `once` and `error`, in `Box` semantics\nthey mean `empty`, `always` and `error`. We won't create the aliases and give\nthese names to get you the feel of what they mean.\n\n      @fromList: (values, wrapper = toEvent)->\n        new @ (sink) ->\n          sink event for event in map wrapper, values\n          sink Stop\n\n      @nothing: -> @fromList []\n      @unit: (value)-> @fromList [value]\n      @error: (value)-> @fromList [value], toError\n\n`fromBinder` just adds a syntax sugar for us to easily define more\nsophisticated constructors.\n\n      @fromBinder: (binder, transform = id) ->\n        new @ (sink) ->\n          unbinder = binder (args...) ->\n            events = toArray transform args...\n            for event in map toEvent, events\n              tap sink(event), (reply)->\n                unbinder() if event == Stop or reply == Reply.stop\n\n`poll` polls a function within given interval.\n\n      @poll: (delay, poll) ->\n        @fromBinder (handler) ->\n          i = setInterval(handler, delay)\n          -> clearInterval(i)\n        , poll\n\n`interval` and `later` send a fixed list of events or one event\nrespectively within given interval.\n\n      @interval: (delay, list)->\n        index = 0\n        @poll delay, ->\n          value = list[index++]\n          if index < list.length\n            value\n          else if index == list.length\n            [value, Stop]\n          else\n            Stop\n\n      @later: (delay, value)->\n        @interval(delay, [value])\n\nLet's also define a function that works on promises, e.g., ajax. The\nresource releasing here for ajax is abort. We should also handle promise\nerrors here. In a transform function we attach end to our stream.\n\n      @fromPromise: (promise) ->\n        @fromBinder (handler) ->\n          promise.then handler, (e) ->\n            handler new Error e\n          -> promise.abort?()\n        , (value) -> [value, Stop]\n\nFinally let's define the way to receive events from DOM objects. We'll do\nit assuming we're called in jQuery\/Zepto fashion.\n\nWe allow to override `transform` - by default it'll take the first\nargument, which is usually a jQuery event. We use `on` to subscribe and\n`off` to unsubscribe.\n\n      @fromDOM: (element, event, selector, transform) ->\n        [transform, selector] = [selector, null] if isFunction(selector)\n\n        @fromBinder (handler) =>\n          element.on(event, selector, handler)\n          => element.off(event, selector, handler)\n        , transform\n\n\nStream\n------\n\nClass `Stream` represents a disrete sequence of values, coupled with time.  So\nit uses the appropriate dispatcher to do it.\n\n`Dispatcher` activates the listeners when a first sink is added and then just\nadds them. On each event it just pushes it to all sinks.\n\n    class StreamDispatcher\n      constructor: (subscribe, handler) ->\n        subscribe ?= (event) ->\n        sinks = []\n        @push = (event) =>\n          for sink in sinks by -1\n            tap sink(event), (reply)->\n              remove sink, sinks if reply == Reply.stop\n        handler ?= (event) -> @push event\n        @handler = (event) => handler.apply(this, [event])\n        @subscribe = (sink) =>\n          sinks.push(sink)\n          unsubSelf = subscribe @handler if sinks.length == 1\n          ->\n            remove sink, sinks\n            unsubSelf?() unless any sinks\n\nTo have `Stream` class we just need to override abstract `dispatched` method\nfrom the base class to use `StreamDispatcher`.\n\n    class Stream extends Observable\n      dispatched: (subscribe, handler)->\n        new StreamDispatcher(subscribe, handler).subscribe\n\nFor this class we can have `flatMap` aka `bind`. In our case it's `flatMapAll`.\n\n      flatMap: (args...)-> @flatMapAll(args...)\n\nHaving this we can easily have `merge`.\n\n      merge: (others...)->\n        Stream.fromList(map method(\"changes\"), [@, others...]).flatten()\n      flatten: -> @flatMap(id)\n\nUsing Stream when we need Box\n-----------------------------\n\nTo make it transparent for a user, is this stream or box, we proxy the box\nmethods to box. First we define a conversion method with an optional starting\nvalue.\n\n      box: (initial = Nothing)->\n        initial = toMaybe(initial)\n        new Box (sink)=>\n          sink initial unless initial.isEmpty()\n          @subscribe (event)-> sink event\n      changes: -> @\n\nWe could also define a new stream with initial value merged to the beginning,\nbut the current code is simple enough.\n\nAll proxy methods are trivial.\n\n      zipWith: (others..., f)-> @box().zipWith(others..., f)\n      and: (others...)-> @box().and(others...)\n      or: (others...)-> @box().or(others...)\n      not: -> @box().not()\n\nBox\n---\n\nClass `Box` represents continuous value that changes with time. So we need a\nslightly tweaked dispatcher. The difference is that it holds the current\nvalue and sends it to each new subscriber. Another difference is that even when\nthe Box is ended, it still sends the last value and then immediately sends stop\n\n    class BoxDispatcher extends StreamDispatcher\n      constructor: (subscribe, handler) ->\n        super subscribe, handler\n        current = Nothing\n        push = @push\n        subscribe = @subscribe\n        stopped = false\n\n        @push = (event) =>\n          event.map((x) -> current = new Just x)\n          stopped = true if event == Stop\n          push.apply(this, [event])\n        @subscribe = (sink) =>\n          reply = current.map((v)-> sink new Fire v)\n          if reply.getOrElse(Reply.more) == Reply.stop\n            nop\n          else if stopped\n            sink Stop\n            nop\n          else\n            subscribe.apply(@, [sink])\n\nNow class `Box` is going to use that dispatcher.\n\n    class Box extends Observable\n      dispatched: (subscribe, handler)->\n        new BoxDispatcher(subscribe, handler).subscribe\n\nFor this class we can have `flatMap` aka `bind`. In our case it's `flatMapLast`.\n\n      flatMap: (args...)-> @flatMapLast(args...)\n\nWith this `flatMap` we can define a glorious `map2`, also known as `zipWith`\nfor two boxes.\n\n      map2: (other, f)->\n        @flatMap (x)-> other.box().map (y)-> f(x, y)\n\nHaving this, `zipWith` is easy.\n\n      @sequence: (boxes)->\n        foldl boxes, @unit([]), (acc, box)->\n          acc.map2 box, (memo, value)-> append memo, value\n      @zipWith: (boxes, f)->\n        @sequence(boxes).map uncurry f\n      zipWith: (others..., f)->\n        Box.zipWith [@, others...], f\n\n`zip` method is it just sugar for the `sequence`.\n\n      zip: (boxes...)-> Box.sequence([@, boxes...])\n\nHelpful would be to define boolean algebra over boxes. `not` is defined on\n`Observable`.\n\n      and: (others...)-> @zipWith others..., (a, b)-> a && b\n      or: (others...)-> @zipWith others..., (a, b)-> a || b\n\nAn interesting `sampledBy` function should take a property and stream it's\nvalue when sampler pops:\n\n      sampledBy: (sampler)->\n        sampler.flatMap(=> @take(1)).changes()\n\nUsing Box when we need Stream\n-----------------------------\n\nTo convert `Box` into `Stream` we take it's changes.\n\n      changes: ->\n        new Stream (sink)=>\n          @subscribe (event)-> sink event\n      box: -> @\n\nHere are the proxy methods.\n\n      merge: (others...)-> @changes().merge(others...)\n\nHelpers\n-------\n\nPretty trivial special values to return from event listeners.\n\n    Reply =\n      stop: \"<stop>\"\n      more: \"<more>\"\n\nWe need some simple helper functions.\n\n    empty = (xs)-> xs.length == 0\n    method = (meth)-> (obj)-> obj[meth]()\n    nop = ->\n    id = (x)-> x\n    fail = -> throw \"method not implemented\"\n    head = (xs) -> xs[0]\n    tail = (xs) -> xs[1...xs.length]\n    uncurry = (f) -> (args)-> f(args...)\n    map = (f, xs) -> f(x) for x in xs\n    foldl = (xs, seed, f) ->\n      for x in xs\n        seed = f(seed, x)\n      seed\n    tap = (x, f) ->\n      f(x)\n      x\n    remove = (x, xs) ->\n      i = xs.indexOf(x)\n      xs.splice(i, 1) if i >= 0\n    all = (xs, f = id) ->\n      for x in xs\n        return false if not f(x)\n      return true\n    any = (xs, f = id) ->\n      for x in xs\n        return true if f(x)\n      return false\n    copyArray = (xs)-> xs.slice()\n    append = (xs, x)-> tap copyArray(xs), (copy)-> copy.push x\n    isFunction = (f) -> typeof f == \"function\"\n    toArray = (x) -> if x instanceof Array then x else [x]\n    toMaybe = (x) ->\n      if x instanceof Maybe then x else new Just x\n\nExports\n-------\n\nWe now need to make our objects usable outside.\n\n    for name, value of {Stream, Box, Event, Fire, Error, Stop,\n                                     Maybe, Just, Wrong, Nothing}\n      Jnoid[name] = value\n\n    if define?.amd\n      define [], -> Jnoid\n    else if module?.exports\n      module.exports = Jnoid\n    else\n      @Jnoid = Jnoid\n\nConclusion\n----------\n\nHave fun!\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b87fe9dc86e2099cf4bfc0d23e22aa52ac4d7631","subject":"Fix spacing on the app.coffee","message":"Fix spacing on the app.coffee\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"app.litcoffee","new_file":"app.litcoffee","new_contents":"Kickstart File\n--------------\nThis file is responsible for starting up the entire server. \n\nLets start by initializing our basic express stuff.\n\n    express = require 'express'\n    app = express()\n\n\nWe need to set a default \"views\" directory. \"\/views\" makes sense.\n\n    app.set 'views', __dirname + '\/views'\n\nRight now, jade templates are the default.\n\n    app.set 'view engine', 'jade'\n\nLet's set the \/public directory to be the only public directory for assets\n\n    app.use(express.static(__dirname + '\/public'))\n\nThis is our route-mapper\n\n    require('.\/guts\/routing')(app)\n\nWe will listen on the port 3000.\n\n    app.listen(3000)\n","old_contents":"Kickstart File\n--------------\nThis file is responsible for starting up the entire server. \n\nLets start by initializing our basic express stuff.\n\n    express = require 'express'\n    app = express()\n\n\nWe need to set a default \"views\" directory. \"\/views\" makes sense. \n    app.set 'views', __dirname + '\/views'\n\nRight now, jade templates are the default. \n    app.set 'view engine', 'jade'\n\nLet's set the \/public directory to be the only public directory for assets\n    app.use(express.static(__dirname + '\/public'))\n\nThis is our route-mapper\n    require('.\/guts\/routing')(app)\n\nWe will listen on the port 3000. \n    app.listen(3000)\n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"9d94807878ee458c3e98840ae9dc3cf52e73b900","subject":"Fix logging comment.","message":"Fix logging comment.\n","repos":"brentrockwood\/TwitteRSS","old_file":"server.litcoffee","new_file":"server.litcoffee","new_contents":"# Main Entry Point\n\nWe are using the [Express](http:\/\/expressjs.com) web framework for our server.\n\n    express = require 'express'\n    app = express()\n\nDesmond Morris's [twitter](https:\/\/www.npmjs.com\/package\/twitter) library is the shizzle for talking to the Twitter API.  Don't forget to set your Twitter consumer key environment variables!\n\n    twitter = require 'twitter'\n    twitter = new twitter\n      consumer_key: process.env.TWITTER_CONSUMER_KEY\n      consumer_secret: process.env.TWITTER_CONSUMER_SECRET\n\nWe are using [Jade](http:\/\/jade-lang.com) to render the RSS.\n\n    app.set 'view engine', 'jade'\n\nLog requests.\n\n    logger = require 'connect-logger'\n    app.use logger()\n\n## Routes\n\nThe first route gets the most recent tweets for a particular user.\n\n    app.get '\/user\/:user', (req, res) ->\n      opts =\n        screen_name: req.params.user\n\n      twitter.get '\/statuses\/user_timeline', opts, (err, body) ->\n        if err\n          return res.send 500, err\n\n        res.render 'rss', { statuses: body }\n\nThe second route gets the most recent tweets based on a search term.\n\n    app.get '\/search\/:term', (req, res) ->\n      opts =\n        q: req.params.term\n\n      twitter.get '\/search\/tweets', opts, (err, body) ->\n        if err\n          return res.send 500, err\n\n        res.render 'rss', body\n\n## Startup\n\nIn dev, we listen on port 5000.  The port environment variable is set on common deployment sites like [Heroku](http:\/\/heroku.com\/).\n\n    port = process.env.PORT || 5000\n    app.listen port\n    console.log 'Server is listening on port ' + port\n\n","old_contents":"# Main Entry Point\n\nWe are using the [Express](http:\/\/expressjs.com) web framework for our server.\n\n    express = require 'express'\n    app = express()\n\nDesmond Morris's [twitter](https:\/\/www.npmjs.com\/package\/twitter) library is the shizzle for talking to the Twitter API.  Don't forget to set your Twitter consumer key environment variables!\n\n    twitter = require 'twitter'\n    twitter = new twitter\n      consumer_key: process.env.TWITTER_CONSUMER_KEY\n      consumer_secret: process.env.TWITTER_CONSUMER_SECRET\n\nWe are using [Jade](http:\/\/jade-lang.com) to render the RSS.\n\n    app.set 'view engine', 'jade'\n\nIf you've set the production variable, you get different logs.\n\n    logger = require 'connect-logger'\n    app.use logger()\n\n## Routes\n\nThe first route gets the most recent tweets for a particular user.\n\n    app.get '\/user\/:user', (req, res) ->\n      opts =\n        screen_name: req.params.user\n\n      twitter.get '\/statuses\/user_timeline', opts, (err, body) ->\n        if err\n          return res.send 500, err\n\n        res.render 'rss', { statuses: body }\n\nThe second route gets the most recent tweets based on a search term.\n\n    app.get '\/search\/:term', (req, res) ->\n      opts =\n        q: req.params.term\n\n      twitter.get '\/search\/tweets', opts, (err, body) ->\n        if err\n          return res.send 500, err\n\n        res.render 'rss', body\n\n## Startup\n\nIn dev, we listen on port 5000.  The port environment variable is set on common deployment sites like [Heroku](http:\/\/heroku.com\/).\n\n    port = process.env.PORT || 5000\n    app.listen port\n    console.log 'Server is listening on port ' + port\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"690ad85eff772445c3a5b5e147d13adc763f4484","subject":"Remove reset method","message":"Remove reset method\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_renderer.litcoffee","new_file":"lib\/render-pipelines\/png\/png_renderer.litcoffee","new_contents":"    Module = require '..\/..\/module'\n    q      = require 'q'\n\n    class PngRenderer extends Module\n      deps: [ 'fs', 'canvas', 'path', 'config' ]\n      pub:  [ 'render', 'flush' ]\n\n      @draw_to: undefined\n      @ctx:     undefined\n\n      initialize: (params) =>\n        deferred = q.defer()\n\n        super()\n          .then =>\n            @initialize_drawing_context() unless PngRenderer.draw_to?\n\n            deferred.resolve @\n\n        deferred.promise\n\n      initialize_drawing_context: =>\n        width  = @config.width  * @config.grid[0].length\n        height = @config.height * @config.grid.length\n\n        PngRenderer.draw_to = new @canvas width, height\n        PngRenderer.ctx     = PngRenderer.draw_to.getContext '2d'\n\n      render: (path) => @done @do_render path\n\n      flush: (level) =>\n        stream = @fs.createWriteStream @path.join __dirname, '..', '..', '..', 'output', \"#{level}.png\"\n\n        for row, r in @config.grid\n          for cell, c in @config.grid[r]\n            @config.grid[r][c] = false\n\n        stream.on 'finish', => @done 'Persisted', location: level\n\n        PngRenderer.draw_to.createPNGStream().pipe stream\n\n    module.exports = PngRenderer\n","old_contents":"    Module = require '..\/..\/module'\n    q      = require 'q'\n\n    class PngRenderer extends Module\n      deps: [ 'fs', 'canvas', 'path', 'config' ]\n      pub:  [ 'render', 'flush', 'reset' ]\n\n      @draw_to: undefined\n      @ctx:     undefined\n\n      initialize: (params) =>\n        deferred = q.defer()\n\n        super()\n          .then =>\n            @initialize_drawing_context() unless PngRenderer.draw_to?\n\n            deferred.resolve @\n\n        deferred.promise\n\n      initialize_drawing_context: =>\n        width  = @config.width  * @config.grid[0].length\n        height = @config.height * @config.grid.length\n\n        PngRenderer.draw_to = new @canvas width, height\n        PngRenderer.ctx     = PngRenderer.draw_to.getContext '2d'\n\n      render: (path) => @done @do_render path\n\n      flush: (level) =>\n        stream = @fs.createWriteStream @path.join __dirname, '..', '..', '..', 'output', \"#{level}.png\"\n\n        for row, r in @config.grid\n          for cell, c in @config.grid[r]\n            @config.grid[r][c] = false\n\n        stream.on 'finish', => @done 'Persisted', location: level\n\n        PngRenderer.draw_to.createPNGStream().pipe stream\n\n      reset: => @done @initialize_drawing_context()\n\n    module.exports = PngRenderer\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d75d405119a8a298c2dda3f0bed758bb564f68a8","subject":"Split l & levels into seperate parameters","message":"Split l & levels into seperate parameters\n\n-l is now the number of auto-named levels to generate\n--levels is now an array of named levels to generate\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/arguments.litcoffee","new_file":"lib\/arguments.litcoffee","new_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] name1 name2 ...'\n      .example '$0',\n        'Creates a 50 x 15 level with 16 x 14 cells and an auto-generated name'\n      .example '$0 -vvvvvvvv',\n        \"Create a 50 x 15 level with 16 x 14 cells, an auto-generated name, and\n        logging set to verbosity level 8 (max)\"\n      .example '$0 -w 20 -h 20',\n        'Creates a 50 x 15 level with 40 X 40 cells & an auto-generated name'\n      .example '$0 -w 10 -h 10 -x 4',\n        'Creates a 50 x 15 level with 40 x 40 cells and an auto-generated name'\n      .example '$0 lvl1 lvl2',\n        'Creates two levels, lvl1 & lvl2, each 50 X 15 with 16 x 14 cells'\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .conflicts 'levels', 'l'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      8\n        height:     7\n        multiplier: 4\n        levels:     1\n        pipeline:   'png_blocks,png_walls,png_step_count'\n      .help 'help'\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .argv\n","old_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] name1 name2 ...'\n      .example '$0',\n        'Creates a 50 x 15 level with 16 x 14 cells and an auto-generated name'\n      .example '$0 -vvvvvvvv',\n        \"Create a 50 x 15 level with 16 x 14 cells, an auto-generated name, and\n        logging set to verbosity level 8 (max)\"\n      .example '$0 -w 20 -h 20',\n        'Creates a 50 x 15 level with 40 X 40 cells & an auto-generated name'\n      .example '$0 -w 10 -h 10 -x 4',\n        'Creates a 50 x 15 level with 40 x 40 cells and an auto-generated name'\n      .example '$0 lvl1 lvl2',\n        'Creates two levels, lvl1 & lvl2, each 50 X 15 with 16 x 14 cells'\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .alias 'l', 'levels'\n      .describe 'l', 'Number of auto-named levels to create'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      8\n        height:     7\n        multiplier: 4\n        levels:     1\n        pipeline:   'png_blocks,png_walls,png_step_count'\n      .help 'help'\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .argv\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"634fad0082d57a75e0ff5c5ecd87c9755b0be4cc","subject":"value search list","message":"value search list\n","repos":"vpj\/models","old_file":"js\/properties\/value.litcoffee","new_file":"js\/properties\/value.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#List\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       @default 'value', (str) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value) -> \"#{str}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value) -> (value is @schema.default())\n\n       parse: (data) ->\n        r = super data\n        return r unless r is true\n        if not @schema.valid data\n         return @error 'invalid'\n\n        res =\n         score: 1\n         errors: []\n         value: @schema.value data\n\n        return res\n\n       toJSON: (value) -> value\n       toJSONFull: (value) -> value\n\n       edit: (elem, value, changed) ->\n        new Edit this, elem, value, changed\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, changed) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = changed\n        @render()\n\n       render: ->\n        schema = @property.schema\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           style:\n            width: \"#{2 + Math.round schema.columns * 7.25}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{2 + Math.round schema.columns * 7.25}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search', style: {display: 'none'}\n\n        @elems.input.value = @value\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.search.addEventListener 'click', @on.searchClick\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r in results\n          e = @div r\n          e._result = r\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @on.change()\n\n       @listen 'focus', (e) ->\n        @search()\n\n       @listen 'change', (e) ->\n        @search()\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#List\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       @default 'value', (str) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value) -> \"#{str}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value) -> (value is @schema.default())\n\n       parse: (data) ->\n        r = super data\n        return r unless r is true\n        if not @schema.valid data\n         return @error 'invalid'\n\n        res =\n         score: 1\n         errors: []\n         value: @schema.value data\n\n        return res\n\n       toJSON: (value) -> value\n       toJSONFull: (value) -> value\n\n       edit: (elem, value, changed) ->\n        new Edit this, elem, value, changed\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, changed) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = changed\n        @render()\n\n       render: ->\n        schema = @property.schema\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           style:\n            width: \"#{2 + Math.round schema.columns * 7.25}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{2 + Math.round schema.columns * 7.25}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n        @elems.input.value = @value\n        @elems.input.addEventListener \"input\", @on.change\n\n       @listen 'change', (e) ->\n        #TODO validate\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0a6349477808f09cb9e4f28b9d18113d7b8b963b","subject":"Copy comments over to document @layout","message":"Copy comments over to document @layout\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08_app.litcoffee","new_file":"docs\/08_app.litcoffee","new_contents":"# Batman.App\n\n`Batman.App` is the central object in any Batman application. It manages the routing table and the current URL parameters, as well as the initial start of the application. It should also be used as a namespace for models and views so that other objects can find them. Batman assumes that there will only ever be one `Batman.App` in use at once.\n\n## Batman.currentApp\n\nA Batman-wide reference to the currently running `Batman.App`.\n\n## @run() : App\n\n`App.run` is the central entry point for a Batman application. `@run` takes these steps to initialize a Batman application:\n\n 1. Instantiate a `Dispatcher`, an internal object for mananging action dispatch to controllers.\n 2. Instantiate a `Navigator`, an internal object for managing the URL via pushState or hashbangs.\n 3. Instantiate the `layout` view according to the `layout` property on the `App`.\n 4. Wait for the layout view to fire it's `ready` event.\n 5. Start the first action dispatch by telling the `Navigator` to begin monitoring the URL.\n\n_Note_: `@run` emits the `run` class event on the `App`, but not necessarily as soon as `@run` is called. Because the `layout` View renders asynchronously and may need to fetch other components, the `run` event can and often does fire long after `@run` is called. If you need to execute code as soon as the `App` has started running, add a listener to the `run` event on the `App` class. If you need to execute code as soon as the layout has rendered, you can use the `ready` event on the `App` class.\n\n`@run` can be called before or on the `load` DOMEvent of the window. `@run` will return the App if the commencement was successful and complete, or `false` if the App must wait for the `layout` to render or if the `App` has already run.\n\n#### starting an application with DOMEvents\n```coffeescript\nwindow.addEventListener 'load', ->\n  MyApp.run()\n```\n\n#### starting an application with jQuery\n```coffeescript\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\n`@stop` stops the `App` it's called upon. The URL will stop being monitored and no more actions will be dispatched. In usual Batman development you shouldn't have to call this.\n\n## @routes\n\n`@routes` is a class level property referencing the root level `NamedRouteQuery` which allows for binding to routes on objects. See `data-route` bindings for more information.\n\n## @controllers\n\n`@controllers` is a class level property containing the singleton `Batman.Controller` instances for each subclass in the application. This `controllers` directory puts these instances at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`. `@controllers` ideally should never be bound to, but it is very useful for debugging in the console and other such workarounds.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n## @layout\n\n`@layout` is the base view that other views can be yielded into. The\ndefault behavior is that when `app.run()` is called, a new view will\nbe created for the layout using the `document` node as its content.\nUse `MyApp.layout = null` to turn off the default behavior.\n\n## @currentParams\n## @paramsManager\n## @paramsPusher\n\n## 'run' class event\n\nThe `run` class event is fired once the app has run. This indeterminately but often happens before the app's layout has finished rendering.\n\n## 'ready' class event\n\nThe `ready` class event is fired once the app's layout is rendered.\n\n# Batman.App Routing\n\nThe `Batman` routing DSL is similar to Rails 3's routing DSL. It is oriented around the notion of a resource:\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n\n## @member\n## @collection\n## @route\n## @root\n","old_contents":"# Batman.App\n\n`Batman.App` is the central object in any Batman application. It manages the routing table and the current URL parameters, as well as the initial start of the application. It should also be used as a namespace for models and views so that other objects can find them. Batman assumes that there will only ever be one `Batman.App` in use at once.\n\n## Batman.currentApp\n\nA Batman-wide reference to the currently running `Batman.App`.\n\n## @run() : App\n\n`App.run` is the central entry point for a Batman application. `@run` takes these steps to initialize a Batman application:\n\n 1. Instantiate a `Dispatcher`, an internal object for mananging action dispatch to controllers.\n 2. Instantiate a `Navigator`, an internal object for managing the URL via pushState or hashbangs.\n 3. Instantiate the `layout` view according to the `layout` property on the `App`.\n 4. Wait for the layout view to fire it's `ready` event.\n 5. Start the first action dispatch by telling the `Navigator` to begin monitoring the URL.\n\n_Note_: `@run` emits the `run` class event on the `App`, but not necessarily as soon as `@run` is called. Because the `layout` View renders asynchronously and may need to fetch other components, the `run` event can and often does fire long after `@run` is called. If you need to execute code as soon as the `App` has started running, add a listener to the `run` event on the `App` class. If you need to execute code as soon as the layout has rendered, you can use the `ready` event on the `App` class.\n\n`@run` can be called before or on the `load` DOMEvent of the window. `@run` will return the App if the commencement was successful and complete, or `false` if the App must wait for the `layout` to render or if the `App` has already run.\n\n#### starting an application with DOMEvents\n```coffeescript\nwindow.addEventListener 'load', ->\n  MyApp.run()\n```\n\n#### starting an application with jQuery\n```coffeescript\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\n`@stop` stops the `App` it's called upon. The URL will stop being monitored and no more actions will be dispatched. In usual Batman development you shouldn't have to call this.\n\n## @routes\n\n`@routes` is a class level property referencing the root level `NamedRouteQuery` which allows for binding to routes on objects. See `data-route` bindings for more information.\n\n## @controllers\n\n`@controllers` is a class level property containing the singleton `Batman.Controller` instances for each subclass in the application. This `controllers` directory puts these instances at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`. `@controllers` ideally should never be bound to, but it is very useful for debugging in the console and other such workarounds.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n## @layout\n\n## @currentParams\n## @paramsManager\n## @paramsPusher\n\n## 'run' class event\n\nThe `run` class event is fired once the app has run. This indeterminately but often happens before the app's layout has finished rendering.\n\n## 'ready' class event\n\nThe `ready` class event is fired once the app's layout is rendered.\n\n# Batman.App Routing\n\nThe `Batman` routing DSL is similar to Rails 3's routing DSL. It is oriented around the notion of a resource:\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n\n## @member\n## @collection\n## @route\n## @root\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a3e699788642c19cc8008d1280b9a710083701ef","subject":"Added currentParams docs","message":"Added currentParams docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08_app.litcoffee","new_file":"docs\/08_app.litcoffee","new_contents":"# \/api\/App Components\/Batman.App\n\n`Batman.App` manages routing and action dispatching, as well as the initial start of the application. It is also the namespace for all `Batman.Model`s, `Batman.Controller`s, and `Batman.View`s. Only one `Batman.App` can be running on a page.\n\nA batman.js application extends `Batman.App`. It is never instantiated and it is started by calling `run`.\n\n```coffeescript\nclass @MyApp extends Batman.App\n  @root 'blogPosts#index'\n\n  @on 'run', -> alert(\"Welcome to my blog!\")\n\nclass MyApp.BlogPostsController extends Batman.Controller\n  index: -> @set('blogPosts', MyApp.BlogPost.get('all'))\n\nclass MyApp.BlogPost extends Batman.Model\n  # model definition ...\n\nMyApp.run()\n```\n\nSee [`Batman.App` routing](\/docs\/api\/batman.app_routing.html) for information about batman.js routing.\n\n## @%current : App\n\nThe currently-running `Batman.App`. Also available at `Batman.currentApp`.\n\n## @run()\n\nInitializes the `Batman.App` class by:\n\n- Closing any already-running apps\n- Creates its [`dispatcher`](\/docs\/api\/batman.app.html#class_accessor_navigator) and [`navigator`](\/docs\/api\/batman.app.html#class_accessor_navigator) and starts the navigator.\n- Instantiating the `layout` view according to the `layout` property on the `App`\n- Emitting `run`\n\n`@run` can be called before or on the `load` DOMEvent of the window.\n\n```coffeescript\n# JavaScript:\nwindow.addEventListener 'load', ->\n  MyApp.run()\n# or jQuery:\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\nStops the `App`. The URL will stop being monitored and no more actions will be dispatched. You generally shouldn't have to call this.\n\n## @%routes : NamedRouteQuery\n\nReturns the `Batman.NamedRouteQuery` which allows for binding to routes on objects. See the [`data-route` binding](batman.view_bindings.html#data-route) for more information.\n\n## @%controllers : ControllerDirectory\n\nReturns the `Batman.ControllerDirectory` for application. `Batman.Controller` instances are accessible at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n    test \"Multi-word controller names have a lowercase first letter\", ->\n      class Alfred extends Batman.App\n      class Alfred.ReminderEmailsController extends Batman.Controller\n      controller = Alfred.get('controllers.reminderEmails')\n      equal Batman._functionName(controller.constructor), \"ReminderEmailsController\"\n\n_Note:_ `@controllers` should not be observed, but it is very useful for debugging.\n\n## @.layout\n\n`@layout` is the base view of the entire view hierarchy. By default, it will parse any `data-*` attributes in the entire document, excluding any `data-yield`'s, when `App.run()` is called. Use `MyApp.layout = null` to disable the creation of this default view.\n\n## @%currentURL : String\n\nThe request path relative to `Batman.config.pathToApp`, including query string.\n\n## @%currentParams : Batman.Params\n\nReturns the URL parameters for the current request, including the path relative to the app's base path (`Batman.config.pathToApp`). It includes named parameters (eg `id` from `\/items\/:id`), query string parameters (eg `key` of `?key=value`).\n\n`currentParams` also offers a way to change the current request URL's parameters without refreshing or reloading anything on the page. This way you can influence data on the page and allow your users to get the same data on hard refreshes. Here's an example:\n\n    Batman.currentApp.get('currentParams.url').update(page: 5)\n\nIt will even update the URL match a defined route if found:\n\n    Batman.currentApp.get('currentParams.url').update(action: show, id: 6) # \/items\/6\n    Batman.currentApp.get('currentParams.url').update(page: 5) # \/items\/page\/5\n\n## @%currentRoute : ControllerActionRoute\n\nThe `Batman.ControllerActionRoute` for the current route, which exposes routing information such as `controller` and `action`.\n\n## @%navigator : Navigator\n\nThe `App`'s `Batman.Navigator` instance.\n\n## @%dispatcher : Dispatcher\n## @%routeMap : RouteMap\n## @%routeMapBuilder : RouteMapBuilder\n## @paramsManager : ParamsReplacer\n## @paramsPusher : ParamsPusher\n\n## 'run' class event\n\n`run` is fired after a successful `run`.\n\n## 'ready' class event\n\n`ready` is fired after the app's layout is rendered.\n","old_contents":"# \/api\/App Components\/Batman.App\n\n`Batman.App` manages routing and action dispatching, as well as the initial start of the application. It is also the namespace for all `Batman.Model`s, `Batman.Controller`s, and `Batman.View`s. Only one `Batman.App` can be running on a page.\n\nA batman.js application extends `Batman.App`. It is never instantiated and it is started by calling `run`.\n\n```coffeescript\nclass @MyApp extends Batman.App\n  @root 'blogPosts#index'\n\n  @on 'run', -> alert(\"Welcome to my blog!\")\n\nclass MyApp.BlogPostsController extends Batman.Controller\n  index: -> @set('blogPosts', MyApp.BlogPost.get('all'))\n\nclass MyApp.BlogPost extends Batman.Model\n  # model definition ...\n\nMyApp.run()\n```\n\nSee [`Batman.App` routing](\/docs\/api\/batman.app_routing.html) for information about batman.js routing.\n\n## @%current : App\n\nThe currently-running `Batman.App`. Also available at `Batman.currentApp`.\n\n## @run()\n\nInitializes the `Batman.App` class by:\n\n- Closing any already-running apps\n- Creates its [`dispatcher`](\/docs\/api\/batman.app.html#class_accessor_navigator) and [`navigator`](\/docs\/api\/batman.app.html#class_accessor_navigator) and starts the navigator.\n- Instantiating the `layout` view according to the `layout` property on the `App`\n- Emitting `run`\n\n`@run` can be called before or on the `load` DOMEvent of the window.\n\n```coffeescript\n# JavaScript:\nwindow.addEventListener 'load', ->\n  MyApp.run()\n# or jQuery:\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\nStops the `App`. The URL will stop being monitored and no more actions will be dispatched. You generally shouldn't have to call this.\n\n## @%routes : NamedRouteQuery\n\nReturns the `Batman.NamedRouteQuery` which allows for binding to routes on objects. See the [`data-route` binding](batman.view_bindings.html#data-route) for more information.\n\n## @%controllers : ControllerDirectory\n\nReturns the `Batman.ControllerDirectory` for application. `Batman.Controller` instances are accessible at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n    test \"Multi-word controller names have a lowercase first letter\", ->\n      class Alfred extends Batman.App\n      class Alfred.ReminderEmailsController extends Batman.Controller\n      controller = Alfred.get('controllers.reminderEmails')\n      equal Batman._functionName(controller.constructor), \"ReminderEmailsController\"\n\n_Note:_ `@controllers` should not be observed, but it is very useful for debugging.\n\n## @.layout\n\n`@layout` is the base view of the entire view hierarchy. By default, it will parse any `data-*` attributes in the entire document, excluding any `data-yield`'s, when `App.run()` is called. Use `MyApp.layout = null` to disable the creation of this default view.\n\n## @%currentURL : String\n\nThe request path relative to `Batman.config.pathToApp`, including query string.\n\n## @%currentParams : Hash\n\nReturns the URL parameters for the current request, including the path relative to the app's base path (`Batman.config.pathToApp`). It includes named parameters (eg `id` from `\/items\/:id`), query string parameters (eg `key` of `?key=value`).\n\n## @%currentRoute : ControllerActionRoute\n\nThe `Batman.ControllerActionRoute` for the current route, which exposes routing information such as `controller` and `action`.\n\n## @%navigator : Navigator\n\nThe `App`'s `Batman.Navigator` instance.\n\n## @%dispatcher : Dispatcher\n## @%routeMap : RouteMap\n## @%routeMapBuilder : RouteMapBuilder\n## @paramsManager : ParamsReplacer\n## @paramsPusher : ParamsPusher\n\n## 'run' class event\n\n`run` is fired after a successful `run`.\n\n## 'ready' class event\n\n`ready` is fired after the app's layout is rendered.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2683fb8b065851f1343c387c37bee47c73261fa2","subject":"Reorder steps for initialization","message":"Reorder steps for initialization\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d6fc6b6c19f1e87515de410fb162468e12897d8d","subject":"Wording","message":"Wording\n","repos":"nswarr\/epiquery2-client","old_file":"src\/epi-client.litcoffee","new_file":"src\/epi-client.litcoffee","new_contents":"    EventEmitter      = require('events').EventEmitter\n    _                 = require 'underscore'\n    log               = require 'simplog'\n    AwesomeWebSocket  = require('awesome-websocket').AwesomeWebSocket\n\nEpiClient\n=========\nThis is the base client for communicating with epiquery2.\n\n    class EpiClient extends EventEmitter\n\nThe @url constructor argument can be either a singular string or an array of strings that represent the\nepiquery2 endpoint(s).\n\n      constructor: (@url) ->\n        @connect()\n\nUnder the hood, we're using the [AwesomeWebSocket](https:\/\/github.com\/glg\/awesome-websocket) to ensure auto-reconnect\non interruptions and endpoint hunting to find the fastest connection.\n\n      connect: =>\n        @ws = new AwesomeWebSocket(@url)\n        @queryId = 0\n        @ws.onmessage = @onMessage\n        @ws.onclose = @onClose\n        @ws.onopen = () ->\n          log.debug \"Epiclient connection opened\"\n        @ws.onerror = (err) ->\n          log.error \"EpiClient socket error: \", err\n\nThe **query** function kicks off the processing of a query which triggers a handful of events in the lifecycle of a query.  See the events section below for more details.\n\n**connectionName** - The string key that maps to an epiquery2 named connection e.g. 'mysql', 'mssql', 'file'.  See more [here](https:\/\/github.com\/igroff\/epiquery2#configuration).\n\n**template** - The path to the template you're querying.  The path is relative to the root of the template directory defined in epiquery2.\n\n**data** - This is a just javascript object you can pass that contains any data you want to use in your epiquery template.\n\n**queryId** - A unique identifier used to refer to the query throughout it's Active period. It will be included with all messages generated during it's processing. It is the caller's responsibility to generate a unique id for each query requested.\n\n      query: (connectionName, template, data, queryId=null) =>\n        req =\n          templateName: template\n          connectionName: connectionName\n          data: data\n        req.queryId = null || queryId\n        req.closeOnEnd = data.closeOnEnd if data\n        # if someone has asked us to close on end, we want our fancy\n        # underlying reconnectint sockets to not reconnect\n        @ws.forceClose = req.closeOnEnd\n\n        log.debug \"executing query: #{template} data:#{JSON.stringify(data)}\"\n        @ws.send JSON.stringify(req)\n\nEchoes events returned from epiquery.\n\n      onMessage: (message) =>\n        # if the browser has wrapped this for use, we'll be interested in its\n        # 'data' element\n        message = message.data if message.type? and message.type = 'message'\n        message = JSON.parse(message) if typeof message is 'string'\n        handler = @['on' + message.message]\n        if handler\n          handler(message)\n\n      onClose: () =>\n        @emit 'close'\n\n## Events\nThey're all pretty self explanatory.  The messages provided to the events have the optional field **queryId** that corresponds to the  queryId that was provided to the **query** function.  Use that to track a particular request in the query's lifecycle.\n\nInvoked at the start of the query's lifecycle.  No query has occurred yet.\n\n      onbeginquery: (msg) => @emit 'beginquery', msg\n\nInvoked when a new row set is began.  Row sets are the result of executing an individual statement.  For example, if you executed two SQL statements, each would be its own row set.\n\n      onbeginrowset: (msg) => @emit 'beginrowset', msg\n\nInvoked every time a row of data is returned from a row set.\n\n      onrow: (msg) => @emit 'row', msg\n\nInvoked at the end of a row set.\n\n      onendrowset: (msg) => @emit 'endrowset', msg\n\nInvoked at the end of the query's overall lifecycle.\n\n      onendquery: (msg) => @emit 'endquery', msg\n\nInvoked if an error is encountered while processing the query.\n\n      onerror: (msg) => @emit 'error', msg\n\n\n\n    module.exports = EpiClient","old_contents":"    EventEmitter      = require('events').EventEmitter\n    _                 = require 'underscore'\n    log               = require 'simplog'\n    AwesomeWebSocket  = require('awesome-websocket').AwesomeWebSocket\n\nEpiClient\n=========\nThis is the base client for communicating with epiquery2.\n\n    class EpiClient extends EventEmitter\n\nThe @url constructor argument can be either a singular string or an array of strings that represent the\nepiquery2 endpoint(s).\n\n      constructor: (@url) ->\n        @connect()\n\nUnder the hood, we're using the [AwesomeWebSocket](https:\/\/github.com\/glg\/awesome-websocket) to ensure auto-reconnect\non interruptions and endpoint hunting to find the fastest connection.\n\n      connect: =>\n        @ws = new AwesomeWebSocket(@url)\n        @queryId = 0\n        @ws.onmessage = @onMessage\n        @ws.onclose = @onClose\n        @ws.onopen = () ->\n          log.debug \"Epiclient connection opened\"\n        @ws.onerror = (err) ->\n          log.error \"EpiClient socket error: \", err\n\nThe **query** function kicks off the processing of a query which triggers a handful of events in the lifecycle of a query.  See the events section below for more details.\n\n**connectionName** - The string key that maps to an epiquery2 named connection e.g. 'mysql', 'mssql', 'file'.  See more [here](https:\/\/github.com\/igroff\/epiquery2#configuration).\n\n**template** - The path to the template you're querying.  The path is relative to the root of the template directory defined in epiquery2.\n\n**data** - This is a just javascript object you can pass that contains any data you want to use in your epiquery template.\n\n**queryId** - A unique identifier used to refer to the query throughout it's Active period. It will be included with all messages generated during it's processing. It is the caller's responsibility to generate a unique id for each query requested.\n\n      query: (connectionName, template, data, queryId=null) =>\n        req =\n          templateName: template\n          connectionName: connectionName\n          data: data\n        req.queryId = null || queryId\n        req.closeOnEnd = data.closeOnEnd if data\n        # if someone has asked us to close on end, we want our fancy\n        # underlying reconnectint sockets to not reconnect\n        @ws.forceClose = req.closeOnEnd\n\n        log.debug \"executing query: #{template} data:#{JSON.stringify(data)}\"\n        @ws.send JSON.stringify(req)\n\nEchoes events returned from epiquery.\n\n      onMessage: (message) =>\n        # if the browser has wrapped this for use, we'll be interested in its\n        # 'data' element\n        message = message.data if message.type? and message.type = 'message'\n        message = JSON.parse(message) if typeof message is 'string'\n        handler = @['on' + message.message]\n        if handler\n          handler(message)\n\n      onClose: () =>\n        @emit 'close'\n\n## Events\nThey're all pretty self explanatory.  The messages provided to the events have the optional field **queryId** that corresponds to the  queryId that was provided to the **query** function.  Use that to track a particular request in the query's lifecycle.\n\nInvoked at the start of the query's lifecycle.  No query has occurred yet.\n\n      onbeginquery: (msg) => @emit 'beginquery', msg\n\nInvoked when a new row set is began.  Row sets are the result of executing a singular query.  For example, if you executed two SQL statements, each would be its own row set.\n\n      onbeginrowset: (msg) => @emit 'beginrowset', msg\n\nInvoked every time a row of data is returned from a row set.\n\n      onrow: (msg) => @emit 'row', msg\n\nInvoked at the end of a row set.\n\n      onendrowset: (msg) => @emit 'endrowset', msg\n\nInvoked at the end of the query's overall lifecycle.\n\n      onendquery: (msg) => @emit 'endquery', msg\n\nInvoked if an error is encountered while processing the query.\n\n      onerror: (msg) => @emit 'error', msg\n\n\n\n    module.exports = EpiClient","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"95054ee90b6ee362315e30154cc1b66f7052e85c","subject":"properties base","message":"properties base\n","repos":"vpj\/models","old_file":"js\/properties\/base.litcoffee","new_file":"js\/properties\/base.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#Properties Base\n\n    Mod.require 'Models.Util',\n     (UTIL) ->\n\n\nClass\n\n      class Base\n       propertyType: 'base'\n       _defaults: {}\n\n       @extend: ->\n        @::_defaults = UTIL.extend {}, @::_defaults\n\n       @default: (name, value) ->\n        @::_defaults[name] = value\n\n       @isValidSchema: (schema) ->\n        for k of schema\n         if not @::_defaults[k]?\n          return false\n\n        return true\n\n       @default 'required', false\n       @default 'default', -> null\n       @default 'isDefault', (value) ->\n        return true if not value?\n        return false\n\n\n       constructor: (schema, name) ->\n        @_name = name\n        @schema = {}\n\n        for k, v of @_defaults\n         if schema[k]?\n          @schema[k] = schema[k]\n         else\n          @schema[k] = v\n\nAbstract methods\n\n       toJSON: (value, stack) ->\n        throw new Error \"#{@propertyType}: toJSON not implementaed\"\n\n       toJSONFULL: (value, stack) ->\n        throw new Error \"#{@propertyType}: toJSONFULL not implementaed\"\n\n       edit: (elem, value, onChanged, stack) ->\n        throw new Error \"#{@propertyType}: edit not implementaed\"\n\nError helper\n\n       error: (error) ->\n        return {\n         score: 0\n         value: @schema.default.call this\n         errors: [error]\n        }\n\n       parse: (data, stack) ->\n        if not data?\n         if @schema.required\n          return (@error 'required')\n         else\n          return {score: 1, value: (@schema.default.call this), errors: []}\n\n        return true\n\n       isDefault: (value, stack) ->\n        @schema.isDefault.call this, value, stack\n\n\n\n      Mod.set 'Models.Property.Base', Base\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#List\n\n    Mod.require 'Models.Util',\n     (UTIL) ->\n\n\nClass\n\n      class Base\n       propertyType: 'base'\n       _defaults: {}\n\n       @extend: ->\n        @::_defaults = UTIL.extend {}, @::_defaults\n\n       @default: (name, value) ->\n        @::_defaults[name] = value\n\n       @isValidSchema: (schema) ->\n        for k of schema\n         if not @::_defaults[k]?\n          return false\n\n        return true\n\n       constructor: (schema, name) ->\n        @_name = name\n        @schema = {}\n\n        for k, v of @_defaults\n         if schema[k]?\n          @schema[k] = schema[k]\n         else\n          @schema[k] = v\n\n       error: (error) ->\n        return {\n         score: 0\n         value: @schema.default.call this\n         errors: [error]\n        }\n\n       parse: (data) ->\n        if not data?\n         if @schema.required\n          return (@error 'required')\n         else\n          return {score: 1, value: (@schema.default.call this), errors: []}\n\n        return true\n\n       @default 'required', false\n       @default 'default', -> null\n       @default 'isDefault', (value) ->\n        return true if not value?\n        return false\n\n       isDefault: (value) ->\n        @schema.isDefault.call this, value\n\n\n\n      Mod.set 'Models.Property.Base', Base\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"51753512df204a69a96200e77e9c013a92963234","subject":"[Sheet] Forgot to increment start_index by frame","message":"[Sheet] Forgot to increment start_index by frame\n","repos":"marrus-sh\/jelli","old_file":"coffee\/sheet.litcoffee","new_file":"coffee\/sheet.litcoffee","new_contents":"Jelli Game Engine\n\n#  Sheet  #\n\n`Sheet()` generates sprite-sheets and manages their rendering on a `CanvasRenderingContext2D`.\nIt is packaged with `Sprite()`, which describes a single sprite on the sheet.\n\n##  General functions  ##\n\nThe function `drawSprite()` is called by `Sprite`s and `Sheet`s in order to draw their images.\nIt is not exposed to the window.\n\n    drawSprite = (sheet, start_index, context, x, y, frame = 1) ->\n\n\u2026That's a lot of arguments. Let's go through them:\n\n- `sheet` is the `Sheet` from which to draw the sprite\n- `start_index` gives us the index of the sprite within the sheet\n- `context` is the `CanvasRenderingContext2D` on which to draw the sprite\n- `x` is the x-coordinate of the top-left corner of the sprite\n- `y` is the y-coordinate of the top-left corner of the sprite\n- `frame` is merely there as a convenience: It increments `start_index` by its value\n\nThe first thing we do is make sure everything is typed correctly.\nThe `sheet` and `context`, clearly, need to be of a certain type in order for this to work.\nIf any of the other provided arguments aren't numbers, however, we can go ahead and reset them to zero.\n\n        unless sheet instanceof Sheet and start_index < sheet.size and context instanceof CanvasRenderingContext2D then return\n        if isNaN(start_index = Number(start_index)) then start_index = 0\n        if isNaN(x = Number(x)) then x = 0\n        if isNaN(y = Number(y)) then y = 0\n        if isNaN(frame = Number(frame)) then frame = 0\n\nNow we can increment `start_index` by `frame`'s value:\n\n        `start_index` += frame\n\nNext, we need to find the horizontal (`i`) and vertical (`j`) position of the sprite on the sheet.\nWe can get this information from `start_index` with a little math:\n\n        i = start_index % sheet.width\n        j = Math.floor start_index \/ sheet.width\n\nThese two lines just make the image a little easier to access:\n\n        source = sheet.source\n        image = sheet.image\n\nNow we have all we need to draw the sprite!\nThere is a HUGE `if`-statement that precedes the draw function, because we want to make sure that what we're drawing is actually there.\nIf it isn't, then obviously we can't draw anything.\n\n        if (source instanceof HTMLImageElement and source.complete or source instanceof SVGImageElement or source instanceof HTMLCanvasElement or createImageBitmap? and (image instanceof ImageBitmap or source instanceof ImageBitmap)) and not isNaN(i) and not isNaN(j) and Number(width = sheet.sprite_width) and Number(height = sheet.sprite_height) then context.drawImage (if createImageBitmap? and image instanceof ImageBitmap then image else source), i * width, j * height, width, height, x, y, width, height\n\nLet's go through what those did.\nFirst, we make sure that the `Sheet` actually has an image associated with it:\n\n-   `source instanceof HTMLImageElement and source.complete`\u2014\n    If the image source is an `<img>` element, then it needs to have finished loading.\n\n-   `source instanceof SVGImageElement or source instanceof HTMLCanvasElement`\u2014\n    The source doesn't have to be an `<img>` element though! It can also be an `<svg>` or a `<canvas>`.\n\n-   `createImageBitmap? and (image instanceof ImageBitmap or source instanceof ImageBitmap)`\u2014\n    Finally, the source can be an `ImageBitmap`.\n    This isn't supported in all browsers, so we check to make sure `createImageBitmap` exists first.\n    However, if `createImageBitmap` *is* supported, then `Sheet`s have a special property, `Sheet.image`, which might contain one, and this should be given preference.\n\nWe also need to make sure that the sprite exists on the sheet:\n\n-   `not isNaN(i) and not isNaN(j)`\u2014\n    This makes sure that our indices are actually, y'know, numbers.\n\n-   `Number(width = sheet.sprite_width) and Number(height = sheet.sprite_height)`\u2014\n    This makes sure that the `Sheet` has a non-zero width and height.\n    It also sets the variables `width` and `height` to those values, for convenient access later.\n\nFinally, we can draw the sprite.\nAgain, we preference `image` if it is defined.\n\n##  Sprite  ##\n\nThe `Sprite` constructor creates a reference to a sprite on a sheet.\nFor efficiency's sake, it does *not* actually contain any of the image data associated with that sprite.\nThe constructor takes three arguments: `sheet`, which gives the sheet; `index`, which is the index of the sprite on the sheet; and `length`, which for animated sprites gives the length of the animation.\n\n    Sprite = (sheet, index, length = 1) ->\n\nIf `index` or `length` aren't numbers, then we go ahead and set them to `0` and `1`, respectively.\n\n        if isNaN(index = Number(index)) then index = 0\n        if isNaN(length = Number(length)) then length = 0\n\nNow we can set the properties.\nNote that `draw` simply binds `drawSprite` to the given `Sheet` and `index`.\n\n        @draw = drawSprite.bind(null, sheet, index)\n        @height = if sheet instanceof Sheet then sheet.sprite_height else 0\n        @index = index\n        @frames = length\n        @sheet = if sheet instanceof Sheet then sheet else null\n        @width = if sheet instanceof Sheet then sheet.sprite_width else 0\n\nSince `Sprite`s are just static references, they should be immutable:\n\n        Object.freeze this\n\nAnd we're done!\n\n`Sprite`s are very simple, and because the `draw` function is bound above, they don't have a prototype.\nFor purposes of inheritance, however, I've thrown this minimal one together:\n\n    Sprite.prototype = {draw: ->}\n    Object.freeze Sprite.prototype\n\n##  Sheet  ##\n\n`Sheet`s associate images with data and methods to make them easily referencable as sprite-sheets.\n\n###  The constructor  ###\n\nThe `Sheet` constructor only takes three arguments: `source`, which gives the source image for the sheet, `sprite_width`, which gives the width of the sprites, and `sprite_height`, which gives their height.\nIn doing so, it makes the assumption that sprites and sprite-sheets do not have any borders or padding.\n(Because borders and padding result in larger download times for users, this restriction is considered acceptable, but it may be lifted at some time in the future.)\n\n    Sheet = (source, sprite_width, sprite_height) ->\n\nFirst, we need to handle the arguments.\nIf `source` isn't an image type that we recognize, we go ahead and set it to `null`.\nAnd if the `sprite_width` or `sprite_height` aren't recognizable as numbers, we set them to 0.\n(Note from the above that a `Sheet` with zero `sprite_width` or `sprite_height` cannot be drawn.)\n\n        unless source instanceof HTMLImageElement or source instanceof SVGImageElement or source instanceof HTMLCanvasElement or createImageBitmap? and source instanceof ImageBitmap then source = null\n        if isNaN(sprite_width = Number(sprite_width)) then sprite_width = 0\n        if isNaN(sprite_height = Number(sprite_height)) then sprite_height = 0\n\nRecall that we need to check for `createImageBitmap` before checking to see if the source is an `ImageBitmap`.\n\nWe can get the width and height of the image from one of two sources, depending on the source type.\nAll of the accepted types have `width` and `height` properties, which specify their dimensions.\nHowever, `HTMLImageElement`s also have `naturalWidth` and `naturalHeight` properties, and these should be preferred for pixel-perfect rendering.\n\nIf for some reason we can't get *either* of these properties, then the `source_width` and `source_height` are set to zero.\n\n        unless source? and not isNaN(source_width = Number(if source.naturalWidth? then source.naturalWidth else source.width)) then source_width = 0\n        unless source? and not isNaN(source_height = Number(if source.naturalHeight? then source.naturalHeight else source.height)) then source_height = 0\n\nWe now have everything we need to define the properties.\nNote that `width` and `height` are provided in sprite-units, not pixels.\nIf `sprite_width` or `sprite_height` are `0`, then the corresponding `width` and `height` are obviously `NaN`.\n\n        @height = Math.floor source_height \/ sprite_height\n        @source = source\n        @sprite_height = sprite_height\n        @sprite_width = sprite_width\n        @width = Math.floor source_width \/ sprite_width\n\nThe `size` property is just `width` times `height`.\n\n        @size = @width * @height\n\n`ImageBitmap`s are optimized for drawing to the canvas.\nIf they are supported, we can pre-render the sprite-sheet and store this in the `image` property.\n\n        if createImageBitmap? then (createImageBitmap source).then (image) => @image = image\n\nBecause `Sheet`s contain static images, it doesn't make sense for them to change after creation.\nWe freeze them:\n\n        Object.freeze this\n\nFor convenience's sake, two static method has been defined for `Sheet` to let you draw arbitrary sprites.\nThese are largely intended for use with callbacks.\n\nThe first is called `draw`, and takes five arguments:\n\n- `context`: A `CanvasRenderingContext2D`\n- `sprite`: A `Sprite`\n- `x`: The x-coordinate at which to draw the sprite\n- `y`: The y-coordinate at which to draw the sprite\n- `frame`: The frame of the animation which to draw\n\nIt maps onto `sprite.draw`:\n\n    Sheet.draw = (context, sprite, x, y, frame = 0) -> if sprite instanceof Sprite then sprite.draw context, x, y, frame\n\nThe second is called `drawSheetAtIndex`, and also takes five arguments:\n\n- `context`: A `CanvasRenderingContext2D`\n- `sheet`: A `Sheet`\n- `index`: The index of the sprite\n- `x`: The x-coordinate at which to draw the sprite\n- `y`: The y-coordinate at which to draw the sprite\n\nIt maps onto `sheet.drawIndex`:\n\n    Sheet.drawSheetAtIndex = (context, sheet, index, x, y) -> if sheet instanceof Sheet then sheet.drawIndex context, index, x, y\n\nFinally, the `Sprite` constructor is added to `Sheet` for later access:\n\n    Sheet.Sprite = Sprite\n\nAnd now we can make `Sheet` available to the window:\n\n    window.Sheet = Sheet\n\n##  The prototype  ##\n\nThe `Sheet` prototype is fairly minimal, consisting of only two functions.\n\n    Sheet.prototype = {\n\nThe first, `drawIndex`, draws the sprite located at the given `index`.\nIt is little more than a repackaging of `drawSprite`.\n\n        drawIndex: (context, index, x, y) -> drawSprite this, index, context, x, y\n\nThe second, `getSprite`, creates a new `Sprite` pointing to the given `index`.\nIt is the most convenient way of creating `Sprite` objects.\nIt takes two arguments, the `index` of the sprite, and the `length` of the animation.\n\n        getSprite: (index, length = 1) -> new Sprite this, index, length\n\nWe can now freeze the prototype:\n\n    }\n\n    Object.freeze Sheet.prototype\n\n\u2026And that's the end!\n","old_contents":"Jelli Game Engine\n\n#  Sheet  #\n\n`Sheet()` generates sprite-sheets and manages their rendering on a `CanvasRenderingContext2D`.\nIt is packaged with `Sprite()`, which describes a single sprite on the sheet.\n\n##  General functions  ##\n\nThe function `drawSprite()` is called by `Sprite`s and `Sheet`s in order to draw their images.\nIt is not exposed to the window.\n\n    drawSprite = (sheet, start_index, context, x, y, frame = 0) ->\n\n\u2026That's a lot of arguments. Let's go through them:\n\n- `sheet` is the `Sheet` from which to draw the sprite\n- `start_index` gives us the index of the sprite within the sheet\n- `context` is the `CanvasRenderingContext2D` on which to draw the sprite\n- `x` is the x-coordinate of the top-left corner of the sprite\n- `y` is the y-coordinate of the top-left corner of the sprite\n- `frame` is merely there as a convenience: It increments start_index by its value\n\nThe first thing we do is make sure everything is typed correctly.\nThe `sheet` and `context`, clearly, need to be of a certain type in order for this to work.\nIf any of the other provided arguments aren't numbers, however, we can go ahead and reset them to zero.\n\n        unless sheet instanceof Sheet and start_index < sheet.size and context instanceof CanvasRenderingContext2D then return\n        if isNaN(start_index = Number(start_index)) then start_index = 0\n        if isNaN(x = Number(x)) then x = 0\n        if isNaN(y = Number(y)) then y = 0\n        if isNaN(frame = Number(frame)) then frame = 0\n\nNext, we need to find the horizontal (`i`) and vertical (`j`) position of the sprite on the sheet.\nWe can get this information from `start_index` with a little math:\n\n        i = start_index % sheet.width\n        j = Math.floor start_index \/ sheet.width\n\nThese two lines just make the image a little easier to access:\n\n        source = sheet.source\n        image = sheet.image\n\nNow we have all we need to draw the sprite!\nThere is a HUGE `if`-statement that precedes the draw function, because we want to make sure that what we're drawing is actually there.\nIf it isn't, then obviously we can't draw anything.\n\n        if (source instanceof HTMLImageElement and source.complete or source instanceof SVGImageElement or source instanceof HTMLCanvasElement or createImageBitmap? and (image instanceof ImageBitmap or source instanceof ImageBitmap)) and not isNaN(i) and not isNaN(j) and Number(width = sheet.sprite_width) and Number(height = sheet.sprite_height) then context.drawImage (if createImageBitmap? and image instanceof ImageBitmap then image else source), i * width, j * height, width, height, x, y, width, height\n\nLet's go through what those did.\nFirst, we make sure that the `Sheet` actually has an image associated with it:\n\n-   `source instanceof HTMLImageElement and source.complete`\u2014\n    If the image source is an `<img>` element, then it needs to have finished loading.\n\n-   `source instanceof SVGImageElement or source instanceof HTMLCanvasElement`\u2014\n    The source doesn't have to be an `<img>` element though! It can also be an `<svg>` or a `<canvas>`.\n\n-   `createImageBitmap? and (image instanceof ImageBitmap or source instanceof ImageBitmap)`\u2014\n    Finally, the source can be an `ImageBitmap`.\n    This isn't supported in all browsers, so we check to make sure `createImageBitmap` exists first.\n    However, if `createImageBitmap` *is* supported, then `Sheet`s have a special property, `Sheet.image`, which might contain one, and this should be given preference.\n\nWe also need to make sure that the sprite exists on the sheet:\n\n-   `not isNaN(i) and not isNaN(j)`\u2014\n    This makes sure that our indices are actually, y'know, numbers.\n\n-   `Number(width = sheet.sprite_width) and Number(height = sheet.sprite_height)`\u2014\n    This makes sure that the `Sheet` has a non-zero width and height.\n    It also sets the variables `width` and `height` to those values, for convenient access later.\n\nFinally, we can draw the sprite.\nAgain, we preference `image` if it is defined.\n\n##  Sprite  ##\n\nThe `Sprite` constructor creates a reference to a sprite on a sheet.\nFor efficiency's sake, it does *not* actually contain any of the image data associated with that sprite.\nThe constructor takes three arguments: `sheet`, which gives the sheet; `index`, which is the index of the sprite on the sheet; and `length`, which for animated sprites gives the length of the animation.\n\n    Sprite = (sheet, index, length = 1) ->\n\nIf `index` or `length` aren't numbers, then we go ahead and set them to `0` and `1`, respectively.\n\n        if isNaN(index = Number(index)) then index = 0\n        if isNaN(length = Number(length)) then length = 0\n\nNow we can set the properties.\nNote that `draw` simply binds `drawSprite` to the given `Sheet` and `index`.\n\n        @draw = drawSprite.bind(null, sheet, index)\n        @height = if sheet instanceof Sheet then sheet.sprite_height else 0\n        @index = index\n        @frames = length\n        @sheet = if sheet instanceof Sheet then sheet else null\n        @width = if sheet instanceof Sheet then sheet.sprite_width else 0\n\nSince `Sprite`s are just static references, they should be immutable:\n\n        Object.freeze this\n\nAnd we're done!\n\n`Sprite`s are very simple, and because the `draw` function is bound above, they don't have a prototype.\nFor purposes of inheritance, however, I've thrown this minimal one together:\n\n    Sprite.prototype = {draw: ->}\n    Object.freeze Sprite.prototype\n\n##  Sheet  ##\n\n`Sheet`s associate images with data and methods to make them easily referencable as sprite-sheets.\n\n###  The constructor  ###\n\nThe `Sheet` constructor only takes three arguments: `source`, which gives the source image for the sheet, `sprite_width`, which gives the width of the sprites, and `sprite_height`, which gives their height.\nIn doing so, it makes the assumption that sprites and sprite-sheets do not have any borders or padding.\n(Because borders and padding result in larger download times for users, this restriction is considered acceptable, but it may be lifted at some time in the future.)\n\n    Sheet = (source, sprite_width, sprite_height) ->\n\nFirst, we need to handle the arguments.\nIf `source` isn't an image type that we recognize, we go ahead and set it to `null`.\nAnd if the `sprite_width` or `sprite_height` aren't recognizable as numbers, we set them to 0.\n(Note from the above that a `Sheet` with zero `sprite_width` or `sprite_height` cannot be drawn.)\n\n        unless source instanceof HTMLImageElement or source instanceof SVGImageElement or source instanceof HTMLCanvasElement or createImageBitmap? and source instanceof ImageBitmap then source = null\n        if isNaN(sprite_width = Number(sprite_width)) then sprite_width = 0\n        if isNaN(sprite_height = Number(sprite_height)) then sprite_height = 0\n\nRecall that we need to check for `createImageBitmap` before checking to see if the source is an `ImageBitmap`.\n\nWe can get the width and height of the image from one of two sources, depending on the source type.\nAll of the accepted types have `width` and `height` properties, which specify their dimensions.\nHowever, `HTMLImageElement`s also have `naturalWidth` and `naturalHeight` properties, and these should be preferred for pixel-perfect rendering.\n\nIf for some reason we can't get *either* of these properties, then the `source_width` and `source_height` are set to zero.\n\n        unless source? and not isNaN(source_width = Number(if source.naturalWidth? then source.naturalWidth else source.width)) then source_width = 0\n        unless source? and not isNaN(source_height = Number(if source.naturalHeight? then source.naturalHeight else source.height)) then source_height = 0\n\nWe now have everything we need to define the properties.\nNote that `width` and `height` are provided in sprite-units, not pixels.\nIf `sprite_width` or `sprite_height` are `0`, then the corresponding `width` and `height` are obviously `NaN`.\n\n        @height = Math.floor source_height \/ sprite_height\n        @source = source\n        @sprite_height = sprite_height\n        @sprite_width = sprite_width\n        @width = Math.floor source_width \/ sprite_width\n\nThe `size` property is just `width` times `height`.\n\n        @size = @width * @height\n\n`ImageBitmap`s are optimized for drawing to the canvas.\nIf they are supported, we can pre-render the sprite-sheet and store this in the `image` property.\n\n        if createImageBitmap? then (createImageBitmap source).then (image) => @image = image\n\nBecause `Sheet`s contain static images, it doesn't make sense for them to change after creation.\nWe freeze them:\n\n        Object.freeze this\n\nFor convenience's sake, two static method has been defined for `Sheet` to let you draw arbitrary sprites.\nThese are largely intended for use with callbacks.\n\nThe first is called `draw`, and takes five arguments:\n\n- `context`: A `CanvasRenderingContext2D`\n- `sprite`: A `Sprite`\n- `x`: The x-coordinate at which to draw the sprite\n- `y`: The y-coordinate at which to draw the sprite\n- `frame`: The frame of the animation which to draw\n\nIt maps onto `sprite.draw`:\n\n    Sheet.draw = (context, sprite, x, y, frame = 0) -> if sprite instanceof Sprite then sprite.draw context, x, y, frame\n\nThe second is called `drawSheetAtIndex`, and also takes five arguments:\n\n- `context`: A `CanvasRenderingContext2D`\n- `sheet`: A `Sheet`\n- `index`: The index of the sprite\n- `x`: The x-coordinate at which to draw the sprite\n- `y`: The y-coordinate at which to draw the sprite\n\nIt maps onto `sheet.drawIndex`:\n\n    Sheet.drawSheetAtIndex = (context, sheet, index, x, y) -> if sheet instanceof Sheet then sheet.drawIndex context, index, x, y\n\nFinally, the `Sprite` constructor is added to `Sheet` for later access:\n\n    Sheet.Sprite = Sprite\n\nAnd now we can make `Sheet` available to the window:\n\n    window.Sheet = Sheet\n\n##  The prototype  ##\n\nThe `Sheet` prototype is fairly minimal, consisting of only two functions.\n\n    Sheet.prototype = {\n\nThe first, `drawIndex`, draws the sprite located at the given `index`.\nIt is little more than a repackaging of `drawSprite`.\n\n        drawIndex: (context, index, x, y) -> drawSprite this, index, context, x, y\n\nThe second, `getSprite`, creates a new `Sprite` pointing to the given `index`.\nIt is the most convenient way of creating `Sprite` objects.\nIt takes two arguments, the `index` of the sprite, and the `length` of the animation.\n\n        getSprite: (index, length = 1) -> new Sprite this, index, length\n\nWe can now freeze the prototype:\n\n    }\n\n    Object.freeze Sheet.prototype\n\n\u2026And that's the end!\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8440271b69767991aff914925b55d979bba53cfd","subject":"0.0.16 Tidy tetracoords.litcoffee (4)","message":"0.0.16 Tidy tetracoords.litcoffee (4)\n","repos":"loopdotcoop\/magnubbin,loopdotcoop\/magnubbin","old_file":"supplemental\/tetracoords\/tetracoords.litcoffee","new_file":"supplemental\/tetracoords\/tetracoords.litcoffee","new_contents":"tetraCoords()\n=============\n\n#### Calculates the coordinates of a tetrahedron\u2019s vertices from 6 edge lengths\n\n- __G__ The point on the tabletop furthest away from you\n- __H__ The leftmost point touching the tabletop\n- __I__ The rightmost point touching the tabletop\n- __J__ The point in the middle, not touching the table\n\n\nTo watch and compile automatically:  \n```bash\ncoffee --watch --compile supplemental\/tetracoords\/tetracoords.litcoffee\n```\n\n\n#### `tetraCoords()`\n- `a <number>`  the edge joining __G \u2014 H__\n- `b <number>`  the edge joining __H \u2014 I__\n- `c <number>`  the edge joining __I \u2014 G__\n- `d <number>`  the edge joining __G \u2014 J__\n- `e <number>`  the edge joining __J \u2014 H__\n- `f <number>`  the edge joining __J \u2014 I__\n- `<array>`     twelve numbers, representing (x,y,z) coords of __G, H, I and J__\n\nReturns an array of vertex coordinates for a tetrahedron of given edge-lengths. \n\n      window.tetraCoords = (a, b, c, d, e, f) ->\n        M = 'tetraCoords()\\n  '\n\nRun basic validation of the six arguments. \n\n        for name,arg of { a:a,b:b,c:c,d:d,e:e,f:f }\n          if 'number' != typeof arg then throw TypeError \"\n            #{M}Argument `#{name}` is #{typeof arg} not number\"\n          if 9007199254740991 < arg or 0 > arg then throw RangeError \"\n            #{M}Argument `#{name}` is #{arg} not 0 or a +ve number < 2^53\"\n\nInitialize the output array, and place __G,__ (the point on the tabletop \nfurthest away from you) at the origin. \n\n        out = [\n          0 # [0] = Gx\n          0 # [1] = Gy\n          0 # [2] = Gz\n        ]\n\nUse the [law of cosines](https:\/\/goo.gl\/8djIju) to find the angle (in radians) \nof the corner opposite `b` on the tabletop. `cos B = (a\u00b2 + c\u00b2 \u2212 b\u00b2) \/ 2ac`  \n\n        oppB = Math.acos( (a*a + c*c - b*b) \/ (2*a*c) )\n\nCalculate __H,__ the leftmost point touching the tabletop. \n\n        out.push(\n          Math.sin(oppB\/2) * -a, # [3] = Hx\n          0,                     # [4] = Hy\n          Math.cos(oppB\/2) * -a  # [5] = Hz\n        )\n\nCalculate __I,__ the rightmost point touching the tabletop. \n\n        out.push(\n          Math.sin(oppB\/2) * c,  # [6] = Ix\n          0,                     # [7] = Iy\n          Math.cos(oppB\/2) * -c  # [8] = Iz\n        )\n\nUse `trilaterate()` to calculate __J,__ the raised point in the middle. \n\n        result = trilaterate(\n          { x:0     , y:0, z:0     , r:d }, # p1\n          { x:out[3], y:0, z:out[5], r:e }, # p2\n          { x:out[6], y:0, z:out[8], r:f }  # p3\n        )\n\nDeal with an impossible tetrahedron. \n\n        if null == result then throw RangeError \"\n          #{M}`#{a},#{b},#{c},#{d},#{e},#{f}` cannot be tetrahedron edges\"\n\n`trilaterate()` usually returns coords for __J__ above _and_ below the tabletop. \n\n        if 2 == result.length\n          out.push(\n            result[1].x, #  [9] = Jx\n            result[1].y, # [10] = Jy (`result[1]` is always +ve)\n            result[1].z  # [11] = Jz\n          )\n\nIf `trilaterate()` returns an object, we have a \u2018flat\u2019 tetrahedron\n\n        else\n          out.push(\n            result.x,    #  [9] = Jx\n            result.y,    # [10] = Jy (always 0)\n            result.z     # [11] = Jz\n          )\n\nMove the tetrahedron coords so that the origin is roughly in the center. \n\n        dy = -out[10] \/ 3 # third of height, `-Jy \/ 3`\n        out[y] += dy for y in [1,4,7,10]\n        dz = -(out[5] + out[8]) \/ 4 # half of average depth, `(Hz + Iz) \/ 2 \/ 2`\n        out[z] += dz for z in [2,5,8,11]\n\nRound results to 3 decimal places. \n\n        out = (Math.round(coord * 1000) \/ 1000 for coord in out)\n\nConvert to a neat string. @todo pass tetraCoords()` an argument to enable this\n\n        out = (for coord in out\n          coord  = (if 0 <= coord then ' ' else '') + coord\n          pos = coord.indexOf '.'\n          coord += (if -1 == pos then '.000' else '00')\n          pos = coord.indexOf '.'\n          coord = coord.slice 0, pos + 4\n        )\n\nReturn the output array. \n\n        out\n\n\n\n","old_contents":"tetraCoords()\n=============\n\n#### Calculates the coordinates of a tetrahedron\u2019s vertices from 6 edge lengths\n\n- __G__ The point on the tabletop furthest away from you\n- __H__ The leftmost point touching the tabletop\n- __I__ The rightmost point touching the tabletop\n- __J__ The point in the middle, not touching the table\n\n\nTo watch and compile automatically: \n```bash\ncoffee --watch --compile supplemental\/tetracoords\/tetracoords.litcoffee\n```\n\n\n#### `tetraCoords()`\n- `a <number>`  the edge joining __G \u2014 H__\n- `b <number>`  the edge joining __H \u2014 I__\n- `c <number>`  the edge joining __I \u2014 G__\n- `d <number>`  the edge joining __G \u2014 J__\n- `e <number>`  the edge joining __J \u2014 H__\n- `f <number>`  the edge joining __J \u2014 I__\n- `<array>`     twelve numbers, representing (x,y,z) coords of __G, H, I and J__\n\n      window.tetraCoords = (a, b, c, d, e, f) ->\n        M = 'tetraCoords()\\n  '\n\nRun basic validation of the six arguments. \n\n        for name,arg of { a:a,b:b,c:c,d:d,e:e,f:f }\n          if 'number' != typeof arg then throw TypeError \"\n            #{M}Argument `#{name}` is #{typeof arg} not number\"\n          if 9007199254740991 < arg or 0 > arg then throw RangeError \"\n            #{M}Argument `#{name}` is #{arg} not 0 or a +ve number < 2^53\"\n\nInitialize the output array, and place __G,__ (the point on the tabletop \nfurthest away from you) at the origin. \n\n        out = [\n          0 # [0] = Gx\n          0 # [1] = Gy\n          0 # [2] = Gz\n        ]\n\nUse the [law of cosines](https:\/\/goo.gl\/8djIju) to find the angle (in radians) \nof the corner opposite `b` on the tabletop. `cos B = (a\u00b2 + c\u00b2 \u2212 b\u00b2) \/ 2ac`  \n\n        oppB = Math.acos( (a*a + c*c - b*b) \/ (2*a*c) )\n\nCalculate __H,__ the leftmost point touching the tabletop. \n\n        out.push(\n          Math.sin(oppB\/2) * -a, # [3] = Hx\n          0,                     # [4] = Hy\n          Math.cos(oppB\/2) * -a  # [5] = Hz\n        )\n\nCalculate __I,__ the rightmost point touching the tabletop. \n\n        out.push(\n          Math.sin(oppB\/2) * c,  # [6] = Ix\n          0,                     # [7] = Iy\n          Math.cos(oppB\/2) * -c  # [8] = Iz\n        )\n\nUse `trilaterate()` to calculate __J,__ the raised point in the middle. \n\n        result = trilaterate(\n          { x:0     , y:0, z:0     , r:d }, # p1\n          { x:out[3], y:0, z:out[5], r:e }, # p2\n          { x:out[6], y:0, z:out[8], r:f }  # p3\n        )\n\nDeal with an impossible tetrahedron. \n\n        if null == result then throw RangeError \"\n          #{M}`#{a},#{b},#{c},#{d},#{e},#{f}` cannot be tetrahedron edges\"\n\n`trilaterate()` usually returns coords for __J__ above _and_ below the tabletop. \n\n        if 2 == result.length\n          out.push(\n            result[1].x, #  [9] = Jx\n            result[1].y, # [10] = Jy (`result[1]` is always +ve)\n            result[1].z  # [11] = Jz\n          )\n\nIf `trilaterate()` returns an object, we have a \u2018flat\u2019 tetrahedron\n\n        else\n          out.push(\n            result.x,    #  [9] = Jx\n            result.y,    # [10] = Jy (always 0)\n            result.z     # [11] = Jz\n          )\n\nMove the tetrahedron coords so that the origin is roughly in the center. \n\n        dy = -out[10] \/ 3 # third of height, `-Jy \/ 3`\n        out[y] += dy for y in [1,4,7,10]\n        dz = -(out[5] + out[8]) \/ 4 # half of average depth, `(Hz + Iz) \/ 2 \/ 2`\n        out[z] += dz for z in [2,5,8,11]\n\nRound results to 3 decimal places. \n\n        out = (Math.round(coord * 1000) \/ 1000 for coord in out)\n\nConvert to a neat string. @todo pass tetraCoords()` an argument to enable this\n\n        out = (for coord in out\n          coord  = (if 0 <= coord then ' ' else '') + coord\n          pos = coord.indexOf '.'\n          coord += (if -1 == pos then '.000' else '00')\n          pos = coord.indexOf '.'\n          coord = coord.slice 0, pos + 4\n        )\n\nReturn the output array. \n\n        out\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"41fd31f065282364bbbadc0e3c561ce9ae33a993","subject":"Remove random html\/source reference","message":"Remove random html\/source reference\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/13_view.litcoffee","new_file":"docs\/13_view.litcoffee","new_contents":"# \/api\/App Components\/Batman.View\n\n`Batman.View`s connect a batman.js app to the DOM. This includes rendering HTML, handling DOM events, and maintaining view bindings. `Batman.View` extends `Batman.Object`. When subclassing `Batman.View`, you can create reusable UI components by defining attributes of the new view:\n\n- [`::source`](\/docs\/api\/batman.view.html#prototype_accessor_source) or [`::html`](\/docs\/api\/batman.view.html#prototype_accessor_html) define the view's HTML.\n- [`@option`](\/docs\/api\/batman.view.html#class_function_option) adds context-based initialization options.\n- [`@filter`](\/docs\/api\/batman.view.html#class_function_filter) adds custom view filters.\n- [Lifecycle hooks](\/docs\/views.html) fire when the view is loaded, rendered, or destroyed.\n\nFor more information about views, see [the guide](\/docs\/views.html).\n\n## Accessors and Event Handlers\n\n[View bindings](\/docs\/api\/batman.view_bindings.html) have access to the views they're rendered by, so custom views are a great place to define view-specific accessors and event handlers. Then, you can connect them to your HTML with view bindings. For example, define a view:\n\n```coffeescript\nclass CoffeeView extends Batman.View\n  @accessor 'coffeeOfTheDay', -> \"Guatemalan\"\n  drinkCoffee: -> alert(\"Yum!!\")\n```\n\nthen apply it to some HTML:\n\n```html\n<div data-view='CoffeeView'>\n  <span data-bind='coffeeOfTheDay'><\/span>\n  <button data-event-click='drinkCoffee'> Take a sip! <\/button>\n<div>\n```\n\nData bindings look for keys on their closest views first, so these bindings will be handled by `CoffeeView`.\n\n## ::constructor(options = {}) : Batman.View\n\nReturns a new `Batman.View`. Since `Batman.View` extends `Batman.Object`, all `options` are mixed in to the new instance. Use this to override `html`, `node`, `superview`, `parentNode`, and\/or your custom data.\n\n## ::lookupKeypath(keypath : String)\n\nTraverses up the view tree searching for `keypath` and returns the first\nresult or `undefined` if no match is found. The path it takes is:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\n    test 'lookupKeypath returns the value if defined on the view or on an ancestor', ->\n      superview = new Batman.View(cat: 'Meowie')\n      subview = new Batman.View(superview: superview, dog: 'Fido')\n      equal 'Fido', subview.lookupKeypath('dog'), \"finds an accessor on itself\"\n      equal 'Meowie', subview.lookupKeypath('cat'), \"finds an accessor on its superview\"\n      equal undefined, subview.lookupKeypath('bogusKeypath'), \"returns undefined if the keypath isn't defined\"\n\nIf used in an accessor, `keypath` is registered as source and will be correctly bound. `lookupKeypath` is used by [view bindings](\/docs\/api\/batman.view_bindings.html) to get data.\n\n## ::setKeypath(keypath, value)\n\nTraverses the view tree searching for the specified keypath and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is used by [view bindings](\/docs\/api\/batman.view_bindings.html) to set data.\n\n    test 'setKeypath sets the value if defined on the view or on an ancestor', ->\n      superview = new Batman.View(cat: 'Meowie')\n      subview = new Batman.View(superview: superview, dog: 'Fido')\n      subview.setKeypath('cat', 'Mittens')\n      equal 'Mittens', superview.get('cat'), \"updates an accessor on its superview\"\n      subview.setKeypath('dog', 'Lassie')\n      equal 'Lassie', subview.get('dog'), \"updates an accessor on itself\"\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n## ::%node : Node\n\nReturns the DOM node that this view encapsulates.\n\nAccessing `node` will load and parse the template if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\nYou can also access a view's `node` in its methods, for example, activating jQuery plugins:\n\n```\nclass App.SearchBarView extends Batman.View\n  viewDidAppear: ->\n    $node = $(@get('node'))\n    $node.typeahead() # <= whatever jQuery plugin you want!\n```\n## ::%source : String\n\nThis string will be used to fetch a view's HTML, relative to [`Batman.config.pathToHTML`](\/docs\/configuration.html).\nYou don't need to add `.html` to this string -- it will be added automatically.\n\nInside a controller action, batman.js provides a default source based on the\ncontoller's [`routingKey`](\/docs\/api\/batman.controller.html#routingkey_and_minification) and the [controller action](\/docs\/api\/batman.controller.html#actions).\n\nYou can set `source` in the class definition:\n\n```\nclass App.HeaderNavigationView extends Batman.View\n  source: 'layout\/_header'\n```\n\nOr when calling `@render()` inside a controller action:\n\n```\nclass App.PostsController extends Batman.Controller\n  show: ->\n    @set('post', new App.Post)\n    if @get('post.isAlternative')\n      @render(source: \"posts\/alternative_new\")\n    else\n      @render() # defaults to 'posts\/new'\n```\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview. You can specify a view's HTML when you define the class:\n\n```\nclass App.SearchBarView extends Batman.View\n  html: \"<input type='text' placeholder='Enter a search term' \/>\"\n```\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n    test 'setting a source loads the correct template', ->\n      Batman.View.store.set('\/animals', '<div>cat<\/div>')\n      view = new Batman.View(source: '\/animals')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n## @filter(label : string, filter : function)\n\nDefines a custom [view filter](\/docs\/api\/batman.view_filters.html) for use within the `View`.\n\n`filter` will be invoked with the pre-filter `value` and any arguments passed to the view filter. For example:\n\n```coffeescript\nclass App.MultiplierView extends Batman.View\n  @filter 'multiplyBy', (value, multiplier) -> value * multiplier\n```\n\nwould handle:\n\n```html\n<div data-view='MultiplierView' data-context-amount='100'>\n  <span data-bind='amount | multiplyBy 6'>\n    <!-- would render to \"600\" -->\n  <\/span>\n<\/div>\n```\n\n_Note_: If the `View`'s HTML is loaded before the view is instantiated, this filter won't have been defined yet and batman.js will throw an error. Avoid this by defining your custom filter at app-level or by defining the `View`'s HTML with [`::source`](\/docs\/api\/batman.view.html#prototype_accessor_source) or [`::html`](\/docs\/api\/batman.view.html#prototype_accessor_html).\n\n## @option(keys...)\n\nDefines a custom option for the `View`. `@option` allows you to initialize your view with data from its context. For example:\n\n```coffeescript\nclass App.MultiplierView extends Batman.View\n  @option 'amount', 'multiplier'\n  @accessor 'finalAmount', -> @get('amount') * @get('multiplier')\n```\n\n```html\n<div data-view='MultiplierView' data-view-amount='10' data-view-multiplier='8'>\n  <span data-bind='finalAmount'>\n    <!-- would render to \"80\" !-->\n  <\/span>\n<\/div>\n```\n\nOptions passed with `data-view-#{option}` may also be keypaths. Keypath changes will be tracked by the view.\n\n## ::.superview : Batman.View\n\nReturns the view's superview. Every view except an app's `LayoutView` has a superview.\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of this `View`. Since it's a [`Batman.Set`](\/docs\/api\/batman.set.html), you can operate directly on this set and batman.js will automatically keep the DOM in sync.\n\nAdding to a view's subviews will automatically update the tree and parse\nthe template and bindings. If the superview is in the DOM, this will\ninsert the current view's node into the DOM.\n\n    test 'adding to a superview parses bindings', ->\n      superview = new Batman.View()\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      superview.subviews.add(view)\n      equal 'cat', view.get('node').firstChild.innerHTML\n\nRemoving from a view's subviews will automatically remove the subview from\nthe DOM.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View(html: '', parentNode: document.body)\n      superview.get('node')\n      view = new Batman.View(html: '', superview: superview)\n\n      ok Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n      superview.subviews.remove(view)\n      ok not Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent (and from the DOM), without killing it.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.removeFromSuperview()\n      ok not superview.subviews.has(view)\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n      test 'die kills the view', ->\n        superview = new Batman.View()\n        view = new Batman.View(superview: superview)\n\n        view.die()\n        equal true, view.isDead\n        equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n    test 'destroySubviews kills all subviews', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: superview)\n\n      superview.destroySubviews()\n      ok one.isDead\n      ok two.isDead\n\n\n## ::propagateToSubviews(eventOrKey : string, value : Object)\n\nIf `value` is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n    test 'propagateToSubviews propagates events', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.on 'eventName', superSpy = createSpy()\n      one.on 'eventName', oneSpy = createSpy()\n      two.on 'eventName', twoSpy = createSpy()\n\n      superview.propagateToSubviews('eventName')\n\n      equal 1, superSpy.callCount\n      equal 1, oneSpy.callCount\n      equal 1, twoSpy.callCount\n\n    test 'propagateToSubviews propagates keys', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.propagateToSubviews('key', 'value')\n\n      equal superview.get('key'), 'value'\n      equal one.get('key'), 'value'\n      equal two.get('key'), 'value'\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n","old_contents":"# \/api\/App Components\/Batman.View\n\n`Batman.View`s connect a batman.js app to the DOM. This includes rendering HTML, handling DOM events, and maintaining view bindings. `Batman.View` extends `Batman.Object`. When subclassing `Batman.View`, you can create reusable UI components by defining attributes of the new view:\n\n- [`::source`](\/docs\/api\/batman.view.html#prototype_accessor_source) or [`::html`](\/docs\/api\/batman.view.html#prototype_accessor_html) define the view's HTML.\n- [`@option`](\/docs\/api\/batman.view.html#class_function_option) adds context-based initialization options.\n- [`@filter`](\/docs\/api\/batman.view.html#class_function_filter) adds custom view filters.\n- [Lifecycle hooks](\/docs\/views.html) fire when the view is loaded, rendered, or destroyed.\n\nFor more information about views, see [the guide](\/docs\/views.html).\n\n## Accessors and Event Handlers\n\n[View bindings](\/docs\/api\/batman.view_bindings.html) have access to the views they're rendered by, so custom views are a great place to define view-specific accessors and event handlers. Then, you can connect them to your HTML with view bindings. For example, define a view:\n\n```coffeescript\nclass CoffeeView extends Batman.View\n  @accessor 'coffeeOfTheDay', -> \"Guatemalan\"\n  drinkCoffee: -> alert(\"Yum!!\")\n```\n\nthen apply it to some HTML:\n\n```html\n<div data-view='CoffeeView'>\n  <span data-bind='coffeeOfTheDay'><\/span>\n  <button data-event-click='drinkCoffee'> Take a sip! <\/button>\n<div>\n```\n\nData bindings look for keys on their closest views first, so these bindings will be handled by `CoffeeView`. If the HTML inside a custom view will always be the same, you can use [`::source`](\/docs\/api\/batman.view.html#prototype_accessor_source) or [`::html`](\/docs\/api\/batman.view.html#prototype_accessor_html) to define it.\n\n## ::constructor(options = {}) : Batman.View\n\nReturns a new `Batman.View`. Since `Batman.View` extends `Batman.Object`, all `options` are mixed in to the new instance. Use this to override `html`, `node`, `superview`, `parentNode`, and\/or your custom data.\n\n## ::lookupKeypath(keypath : String)\n\nTraverses up the view tree searching for `keypath` and returns the first\nresult or `undefined` if no match is found. The path it takes is:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\n    test 'lookupKeypath returns the value if defined on the view or on an ancestor', ->\n      superview = new Batman.View(cat: 'Meowie')\n      subview = new Batman.View(superview: superview, dog: 'Fido')\n      equal 'Fido', subview.lookupKeypath('dog'), \"finds an accessor on itself\"\n      equal 'Meowie', subview.lookupKeypath('cat'), \"finds an accessor on its superview\"\n      equal undefined, subview.lookupKeypath('bogusKeypath'), \"returns undefined if the keypath isn't defined\"\n\nIf used in an accessor, `keypath` is registered as source and will be correctly bound. `lookupKeypath` is used by [view bindings](\/docs\/api\/batman.view_bindings.html) to get data.\n\n## ::setKeypath(keypath, value)\n\nTraverses the view tree searching for the specified keypath and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is used by [view bindings](\/docs\/api\/batman.view_bindings.html) to set data.\n\n    test 'setKeypath sets the value if defined on the view or on an ancestor', ->\n      superview = new Batman.View(cat: 'Meowie')\n      subview = new Batman.View(superview: superview, dog: 'Fido')\n      subview.setKeypath('cat', 'Mittens')\n      equal 'Mittens', superview.get('cat'), \"updates an accessor on its superview\"\n      subview.setKeypath('dog', 'Lassie')\n      equal 'Lassie', subview.get('dog'), \"updates an accessor on itself\"\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n## ::%node : Node\n\nReturns the DOM node that this view encapsulates.\n\nAccessing `node` will load and parse the template if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\nYou can also access a view's `node` in its methods, for example, activating jQuery plugins:\n\n```\nclass App.SearchBarView extends Batman.View\n  viewDidAppear: ->\n    $node = $(@get('node'))\n    $node.typeahead() # <= whatever jQuery plugin you want!\n```\n## ::%source : String\n\nThis string will be used to fetch a view's HTML, relative to [`Batman.config.pathToHTML`](\/docs\/configuration.html).\nYou don't need to add `.html` to this string -- it will be added automatically.\n\nInside a controller action, batman.js provides a default source based on the\ncontoller's [`routingKey`](\/docs\/api\/batman.controller.html#routingkey_and_minification) and the [controller action](\/docs\/api\/batman.controller.html#actions).\n\nYou can set `source` in the class definition:\n\n```\nclass App.HeaderNavigationView extends Batman.View\n  source: 'layout\/_header'\n```\n\nOr when calling `@render()` inside a controller action:\n\n```\nclass App.PostsController extends Batman.Controller\n  show: ->\n    @set('post', new App.Post)\n    if @get('post.isAlternative')\n      @render(source: \"posts\/alternative_new\")\n    else\n      @render() # defaults to 'posts\/new'\n```\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview. You can specify a view's HTML when you define the class:\n\n```\nclass App.SearchBarView extends Batman.View\n  html: \"<input type='text' placeholder='Enter a search term' \/>\"\n```\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n    test 'setting a source loads the correct template', ->\n      Batman.View.store.set('\/animals', '<div>cat<\/div>')\n      view = new Batman.View(source: '\/animals')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n## @filter(label : string, filter : function)\n\nDefines a custom [view filter](\/docs\/api\/batman.view_filters.html) for use within the `View`.\n\n`filter` will be invoked with the pre-filter `value` and any arguments passed to the view filter. For example:\n\n```coffeescript\nclass App.MultiplierView extends Batman.View\n  @filter 'multiplyBy', (value, multiplier) -> value * multiplier\n```\n\nwould handle:\n\n```html\n<div data-view='MultiplierView' data-context-amount='100'>\n  <span data-bind='amount | multiplyBy 6'>\n    <!-- would render to \"600\" -->\n  <\/span>\n<\/div>\n```\n\n_Note_: If the `View`'s HTML is loaded before the view is instantiated, this filter won't have been defined yet and batman.js will throw an error. Avoid this by defining your custom filter at app-level or by defining the `View`'s HTML with [`::source`](\/docs\/api\/batman.view.html#prototype_accessor_source) or [`::html`](\/docs\/api\/batman.view.html#prototype_accessor_html).\n\n## @option(keys...)\n\nDefines a custom option for the `View`. `@option` allows you to initialize your view with data from its context. For example:\n\n```coffeescript\nclass App.MultiplierView extends Batman.View\n  @option 'amount', 'multiplier'\n  @accessor 'finalAmount', -> @get('amount') * @get('multiplier')\n```\n\n```html\n<div data-view='MultiplierView' data-view-amount='10' data-view-multiplier='8'>\n  <span data-bind='finalAmount'>\n    <!-- would render to \"80\" !-->\n  <\/span>\n<\/div>\n```\n\nOptions passed with `data-view-#{option}` may also be keypaths. Keypath changes will be tracked by the view.\n\n## ::.superview : Batman.View\n\nReturns the view's superview. Every view except an app's `LayoutView` has a superview.\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of this `View`. Since it's a [`Batman.Set`](\/docs\/api\/batman.set.html), you can operate directly on this set and batman.js will automatically keep the DOM in sync.\n\nAdding to a view's subviews will automatically update the tree and parse\nthe template and bindings. If the superview is in the DOM, this will\ninsert the current view's node into the DOM.\n\n    test 'adding to a superview parses bindings', ->\n      superview = new Batman.View()\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      superview.subviews.add(view)\n      equal 'cat', view.get('node').firstChild.innerHTML\n\nRemoving from a view's subviews will automatically remove the subview from\nthe DOM.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View(html: '', parentNode: document.body)\n      superview.get('node')\n      view = new Batman.View(html: '', superview: superview)\n\n      ok Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n      superview.subviews.remove(view)\n      ok not Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent (and from the DOM), without killing it.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.removeFromSuperview()\n      ok not superview.subviews.has(view)\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n      test 'die kills the view', ->\n        superview = new Batman.View()\n        view = new Batman.View(superview: superview)\n\n        view.die()\n        equal true, view.isDead\n        equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n    test 'destroySubviews kills all subviews', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: superview)\n\n      superview.destroySubviews()\n      ok one.isDead\n      ok two.isDead\n\n\n## ::propagateToSubviews(eventOrKey : string, value : Object)\n\nIf `value` is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n    test 'propagateToSubviews propagates events', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.on 'eventName', superSpy = createSpy()\n      one.on 'eventName', oneSpy = createSpy()\n      two.on 'eventName', twoSpy = createSpy()\n\n      superview.propagateToSubviews('eventName')\n\n      equal 1, superSpy.callCount\n      equal 1, oneSpy.callCount\n      equal 1, twoSpy.callCount\n\n    test 'propagateToSubviews propagates keys', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.propagateToSubviews('key', 'value')\n\n      equal superview.get('key'), 'value'\n      equal one.get('key'), 'value'\n      equal two.get('key'), 'value'\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5a9776c39c29450c06719e67257912a66c50c3fb","subject":"Update routing.litcoffee","message":"Update routing.litcoffee","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/routing.litcoffee","new_file":"guts\/routing.litcoffee","new_contents":"Routing\n=======\nThis file serves as the \"glue\" between the express router and sanity. Basically, we want a rails-esque routing system with all the routes declared in one location.  One advantage over rails, though, is that we're going to allow some degree of function composition in that we can declare multiple, reusable actions per-route, then let them pass the return value from one to the next.\n\nThis is done via unapologetic use of Promises. \n\n##Libraries\n\n    Promise = require 'bluebird'\n    fs = Promise.promisifyAll require 'fs'\n    _ = require 'lodash'\n\nAs a note, the `Promise.promisifyAll` function simply adds `Async` to the end of the methods in `fs` and subsequently allows Promises to be used instead of callbacks. \n\n##Local Modules\n\n    policies = require '.\/policies'\n    bodyParser = require '.\/bodyParser'\n\n\nLet's kickstart this router.\n\n    module.exports = (app) ->\n        \n-----------\n        \nThis grabs the controllers and returns back a promise'd object of them. It made more sense to put this in a separate file, since it'sarguably useful in its own right.\n\n        require('.\/getFiles')('controllers')\n\nOnce we've gotten all the controllers, we'll move on\n\n        .then (controllerObject) ->\n\nLet's load in the routes file\n\n            configuredRoutes = require '..\/config\/routes'\n\nLet's loop through the routes file and do the appropriate mapping.[1]\n\n            _.each configuredRoutes, (totalString, route) ->\n\n                \nRoutes are stored like METHOD \/route, so we'll split on spaces. To make this a bit more dev-friendly, let's get rid of redundant spaces and newlines so that we're not punishing devs for using extra whitespace. \n\n                [method, endpoint] = route\n                             .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                             .replace \/\\s\\s+\/g, ' '\n                             .trim()\n                             .split ' '\n\n-----------\n\nThis bigass thing here is for dev-friendliness.  I don't want to punish people for separating controller calls to multiple lines if they want, and I don't want punish them for adding multiple spaces.  Subsequently, I replace newlines with a  space, then replace extra spaces down to one space, trim it, and split on the @ sign so I can make the dichotomy between application logic and error-handling logic. Utilizing Coffee's \"multi-return\" thing, I can set the values pretty cleanly, but not before I make sure the values are trimmed.\n\n                [actionString, catchString] = totalString\n                                  .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                                  .replace \/\\s\\s+\/g, ' '\n                                  .trim()\n                                  .split '@'\n                                  .map (i) -> do i.trim\n-----------\n\n\nAgain, just make it cleaner, we'll utilize the \"multi-return\" thing coffeescript does. Since I don't want a hard requirement for a catch to exist, I will put a conditional to see if the catch is defined.\n\n                [catchController,catchFunction] = catchString.split '.' if catchString?\n\nIf we have a catch defined, awesome, else we'll just feed in an empty function.\n               \n                catcher = controllerObject[catchController]?[catchFunction] || ->\n\nSplit the routes on a space so as to separate individual action handlers.\n\n                allRoutes = actionString.split ' '\n\n-------\n\nLoop through all the actions that are provided for that route, look them up, return back the handles on the function. So as to save a \"push\" command we'll use a map\n\n                actionHandles = _.map allRoutes, (a) ->\n\nFirst we need to separate out the error handling stuff from the actual program, so let's split that out, and utilize the multi-return value feature of coffeescript.\n\n                    [actionStuff, errorStuff] = a.split '!'\n\nSince I don't want to make a hard requirement to provide an error-handler, let's put a put quick \"if\" at the end of this to make sure we have errorstuff to assign.\n\n                    [errorController, errorAction] = errorStuff.split '.' if errorStuff?\n\nLet's parse out the controller and action.\n\n                    [myController, myAction] = actionStuff.split '.'\n\n\nNow let's grab the appropriate stuff out of the controllers.\n\n                    finalAction =  controllerObject[myController][myAction]\n                    finalError = controllerObject[errorController]?[errorAction]\n                    \nSince everything is parsed out, let's just wrap this in an object so as to easily pipe into the promises.\n\n                    finalObject =\n                        action: finalAction\n                        error: finalError\n                        controllerName: myController\n                        actionName: myAction\n\nOnce everything is done, let's just return out of the map and move on. \n\n                    return finalObject\n\n\nThe `wrapper` function.\n-----------------------\n\nThis here is the glue that does the joining of the actual functions.  In a nutshell, when the request it made, it should run `wrapper`, which will loop through the functions that were returned by the previous map, and run them sequentially as part of the promise chain.  I would like to eventually add a mechanism in which to do this in parallel (instead of just sequentially) eventually. \n\n                wrapper = (req, res) ->\n\nWe need to make sure the user is allowed to use everything that this route has to offer.  Due to the beauty of Bluebird, if this this trips up, it'll just kill the promise chain and make it so that we don't go any farther than we're allowed to.\n\n                        bodyParser req\n                        .then (updatedReq) ->\n                            authPromise = policies actionHandles, updatedReq, res\n\nOnce we've gotten all the handles on the functions we need to call, we can concat it to all previous promises. Afterwards we want these to run sequentially, so we use the reduce function to run them, then converge into a single, final promise.\n\n                            finalPromise =\n                                _.chain [authPromise]\n                                .flatten()\n                                .concat actionHandles\n                                .reduce (cur, next) ->\n                                    cur.then next.action, next.error\n                                .value()\n                                \nEverything should be done.  We can finally render a template or return back JSON depending on what they did on that last function\n\n                            finalPromise.then (endData) ->\n\n\nWhat happens now is pretty simple.  A requirement for frameworkey is that you return an object with your data and the `renderType` property. From there it's pretty straightforward.\n\n                                if endData.renderType.toLowerCase() == 'html'\n                                    # We used \"toLowerCase\" to make it more dev-friendly. \n                                    res.render endData.page\n                                else if endData.renderType.toLowerCase() == 'json'\n                                    res.send endData.data\n                                \nWe'll use the global catch defined at the end of the actions to handle residual errors.  If there's an issue, we go here. We can default to an empty function if there's an issue.\n\n                            finalPromise.catch catcher\n\n                            \nAs stated above, wrapper will return a new function based on what we send in for `allRoutes`.  We're adding the `toLowerCase` to make this a bit more dev-friendly.\n\n                app[do method.toLowerCase] endpoint, wrapper\n\n\n[1]: I *really* hate how the value comes before the key in Lodash\n","old_contents":"Routing\n=======\nThis file serves as the \"glue\" between the express router and sanity. Basically, we want a rails-esque routing system with all the routes declared in one location.  One advantage over rails, though, is that we're going to allow some degree of function composition in that we can declare multiple, reusable actions per-route, then let them pass the return value from one to the next.\n\nThis is done via unapologetic use of Promises. \n\n##Libraries\n\n    Promise = require 'bluebird'\n    fs = Promise.promisifyAll require 'fs'\n    _ = require 'lodash'\n\nAs a note, the `Promise.promisifyAll` function simply adds `Async` to the end of the methods in `fs` and subsequently allows Promises to be used instead of callbacks. \n\n##Local Modules\n\n    policies = require '.\/policies'\n    bodyParser = require '.\/bodyParser'\n\n\nLet's kickstart this router.\n\n    module.exports = (app) ->\n        \n-----------\n        \nThis grabs the controllers and returns back a promise'd object of them. It made more sense to put this in a separate file, since it'sarguably useful in its own right.\n\n        require('.\/getFiles')('controllers')\n\nOnce we've gotten all the controllers, we'll move on\n\n        .then (controllerObject) ->\n\nLet's load in the routes file\n\n            configuredRoutes = require '..\/config\/routes'\n\nLet's loop through the routes file and do the appropriate mapping.[1]\n\n            _.each configuredRoutes, (totalString, route) ->\n\n                \nRoutes are stored like METHOD \/route, so we'll split on spaces. To make this a bit more dev-friendly, let's get rid of redundant spaces and newlines so that we're not punishing devs for using extra whitespace. \n\n                [method, endpoint] = route\n                             .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                             .replace \/\\s\\s+\/g, ' '\n                             .trim()\n                             .split ' '\n\n-----------\n\nThis bigass thing here is for dev-friendliness.  I don't want to punish people for separating controller calls to multiple lines if they want, and I don't want punish them for adding multiple spaces.  Subsequently, I replace newlines with a  space, then replace extra spaces down to one space, trim it, and split on the @ sign so I can make the dichotomy between application logic and error-handling logic. Utilizing Coffee's \"multi-return\" thing, I can set the values pretty cleanly, but not before I make sure the values are trimmed.\n\n                [actionString, catchString] = totalString\n                                  .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                                  .replace \/\\s\\s+\/g, ' '\n                                  .trim()\n                                  .split '@'\n                                  .map (i) -> do i.trim\n-----------\n\n\nAgain, just make it cleaner, we'll utilize the \"multi-return\" thing coffeescript does. Since I don't want a hard requirement for a catch to exist, I will put a conditional to see if the catch is defined.\n\n                [catchController,catchFunction] = catchString.split '.' if catchString?\n\nIf we have a catch defined, awesome, else we'll just feed in an empty function.\n               \n                catcher = controllerObject[catchController]?[catchFunction] || ->\n\nSplit the routes on a space so as to separate individual action handlers.\n\n                allRoutes = actionString.split ' '\n\n-------\n\nLoop through all the actions that are provided for that route, look them up, return back the handles on the function. So as to save a \"push\" command we'll use a map\n\n                actionHandles = _.map allRoutes, (a) ->\n\nFirst we need to separate out the error handling stuff from the actual program, so let's split that out, and utilize the multi-return value feature of coffeescript.\n\n                    [actionStuff, errorStuff] = a.split '!'\n\nSince I don't want to make a hard requirement to provide an error-handler, let's put a put quick \"if\" at the end of this to make sure we have errorstuff to assign.\n\n                    [errorController, errorAction] = errorStuff.split '.' if errorStuff?\n\nLet's parse out the controller and action.\n\n                    [myController, myAction] = actionStuff.split '.'\n\n\nNow let's grab the appropriate stuff out of the controllers.\n\n                    finalAction =  controllerObject[myController][myAction]\n                    finalError = controllerObject[errorController]?[errorAction]\n                    \nSince everything is parsed out, let's just wrap this in an object so as to easily pipe into the promises.\n\n                    finalObject =\n                        action: finalAction\n                        error: finalError\n                        controllerName: myController\n                        actionName: myAction\n\nOnce everything is done, let's just return out of the map and move on. \n\n                    return finalObject\n\n\nThe `wrapper` function.\n-----------------------\n\nThis here is the glue that does the joining of the actual functions.  In a nutshell, when the request it made, it should run `wrapper`, which will loop through the functions that were returned by the previous map, and run them sequentially as part of the promise chain.  I would like to eventually add a mechanism in which to do this in parallel (instead of just sequentially) eventually. \n\n                wrapper = (req, res) ->\n\nWe need to make sure the user is allowed to use everything that this route has to offer.  Due to the beauty of Bluebird, if this this trips up, it'll just kill the promise chain and make it so that we don't go any farther than we're allowed to.\n\n                        bodyParser req\n                        .then (updatedReq) ->\n                            authPromise = policies actionHandles, updatedReq, res\n\nOnce we've gotten all the handles on the functions we need to call, we can concat it to all previous promises. Afterwards we want these to run sequentially, so we use the reduce function to run them, then converge into a single, final promise.\n\n                            finalPromise =\n                                _.chain [authPromise]\n                                .flatten()\n                                .concat actionHandles\n                                .reduce (cur, next) ->\n                                    cur.then next.action, next.error\n                                .value()\n                                \nEverything should be done.  We can finally render a template or return back JSON depending on what they did on that last function\n\n                            finalPromise.then (endData) ->\n\n\nWhat happens now is pretty simple.  A requirement for frameworkey is that you return an object with your data and the `renderType` property. From there it's pretty straightforward.\n\n                                if endData.renderType.toLowerCase() == 'html'\n                                    # We used \"toLowerCase\" to make it more dev-friendly. \n                                    res.render endData.page\n                                else if endData.renderType.toLowerCase() == 'json'\n                                    res.send endData.data\n                                \nWe'll use the global catch defined at the end of the actions to handle residual errors.  If there's an issue, we go here. We can default to an empty function if there's an issue.\n\n                            finalPromise.catch catcher\n\n                            \nAs stated above, wrapper will return a new function based on what we send in for \"allRoutes\".  We're adding the \"toLowerCase()\" to make this a bit more dev-friendly.\n\n                app[do method.toLowerCase] endpoint, wrapper\n\n\n[1]: I *really* hate how the value comes before the key in Lodash\n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"cedf78c33f9c79d4f7baf2cffabafb1b8b98374c","subject":"Removes a superfluously added blank line","message":"Removes a superfluously added blank line\n","repos":"ShawnHuang\/docco-multidir,gvithellyna\/docco,MaxwellRebo\/docco,jalleyne\/docco,lobrien\/docco,DoomHammer\/docco,oponder\/docco,lbn\/docco,jalleyne\/docco,mhkeller\/docco,whitetrefoil\/docco,actano\/docco,erikdiessel\/plidoc,tbremer\/docco,JonathanMatthey\/codeconv,erikdiessel\/plidoc,gvithellyna\/docco,guigrpa\/docco,jrvidal\/docco,STRd6\/docco,MaxwellRebo\/docco,Hellyna\/docco,guigrpa\/docco,robertmackenzie\/docco,Hellyna\/docco,robertmackenzie\/docco,guigrpa\/docco-extended,ShawnHuang\/docco-multidir,whitetrefoil\/docco,jrvidal\/docco,mhkeller\/docco,osharim\/docco,tbremer\/docco,guigrpa\/docco-extended,DoomHammer\/docco,lbn\/docco,osharim\/docco,lobrien\/docco,oponder\/docco","old_file":"docco.litcoffee","new_file":"docco.litcoffee","new_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* Your all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        isText = maybeCode = yes\n        for line, i in lines\n          lines[i] = if maybeCode and match = \/^([ ]{4}|[ ]{0,3}\\t)\/.exec line\n            isText = no\n            line[match[0].length..]\n          else if maybeCode = \/^\\s*$\/.test line\n            if isText then lang.symbol else ''\n          else\n            isText = yes\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n      for section, i in sections\n        code = highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      config.languages = buildMatchers config.languages\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    {highlight} = require 'highlight.js'\n\nEnable nicer typography with marked.\n\n    marked.setOptions smartypants: yes\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [file]', 'use a custom languages.json', _.compose JSON.parse, fs.readFileSync)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","old_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* Your all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        isText = maybeCode = yes\n        for line, i in lines\n          lines[i] = if maybeCode and match = \/^([ ]{4}|[ ]{0,3}\\t)\/.exec line\n            isText = no\n            line[match[0].length..]\n          else if maybeCode = \/^\\s*$\/.test line\n            if isText then lang.symbol else ''\n          else\n            isText = yes\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n      for section, i in sections\n        code = highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      config.languages = buildMatchers config.languages\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    {highlight} = require 'highlight.js'\n\nEnable nicer typography with marked.\n\n    marked.setOptions smartypants: yes\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\n\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [file]', 'use a custom languages.json', _.compose JSON.parse, fs.readFileSync)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e7eb4ef2d3f929841591cf11e912a7387c8e0dc2","subject":"Moved non-executing code to example block","message":"Moved non-executing code to example block","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_controller.litcoffee","new_file":"docs\/10_controller.litcoffee","new_contents":"# Batman.Controller\n\n`Batman.Controller` is the base class from which all an application's controllers should descend from. `Batman.Controller`s are responsible for executing _actions_ which fire off requests for model data, render views, or redirect to other actions in response to navigation state changes.\n\n## Controller Directory\n\n`Batman.Controller`s are singletons which means each controller in your application is instantiated exactly once. The instance of each controller is available on the class at the `@sharedController` property, or within a `ControllerDirectory` on the `Application` class. See `Batman.Application.controllers`.\n\n## Actions\n\nEach `Batman.Controller` should have a number of instance level functions which can fetch the data needed and often render a view (or views) to display that data. These functions can be declared in typical CoffeeScript fashion like so:\n\n```example\n  class Alfred extends Batman.App\n    @root \"todos#index\"\n\n  class Alfred.TodosController extends Batman.Controller\n    index: (params) ->\n    show: (params) ->\n```\n\nEach action function receives the parameters from the dispatcher which are pulled out of the navigated-to URL. This includes both named route parameters (`\/:foo` style) as well as arbitrary query parameters (`?foo=bar` style).\n\n## routingKey and Minification\n\nFor functionality like contextual redirects and automatic view source and class inference, Batman needs to know the name of all your `Controller` subclasses. The usual way to do this is by using `Function::name` which Batman will use in development, but this is often mangled in minified production environments. For this reason, Batman will error out on boot if a `Controller` subclass' `routingKey` is not defined on the prototype. The `routingKey` is a `String` which remains unmangled after minification and thus allows Batman to continue using the aforementioned features. To disable this requirement (if you know your code won't ever be minified), set `Batman.config.minificationErrors` to false.\n\n## ::render([options : [Object|boolean]])\n\n`render` is used to control the rendering of the currently executed action. Passing `false` will prevent the current action from implicitly rendering the view. Passing an `options` object allows the default `view`, `source`, `viewClass` or `yield` block to be overridden, all of which are optional. If no parameters are passed to options, it will manually trigger the render function, rather than waiting for it to be implicitly called at the end of the action.\n\n_Note_: For more information on yield blocks, see Controller::.defaultRenderYield\n\n    class TestController extends Batman.Controller\n      routingKey: 'test'\n\n      nonVisibleAction: ->\n        @render(false)\n\n      customSource: ->\n        @render(source: 'errors\/404')\n\n      customYield: ->\n        @render(into: 'not-main')\n\n      delayedRender: ->\n        setTimeout (-> @render()), 1000\n        @render(false)\n\n## @beforeAction([options : [string|Object],] filter : [string|Function])\n\n`@beforeAction` allows controllers to declare that a function should be executed before the body of an action during action execution. `@beforeAction` optionally accepts some options representing which action(s) to execute the filter before, and then a string naming a function or function proper to execute.\n\nThe `options` argument can take three forms to imply different things:\n\n 1. `undefined`: implies that this filter function should be executed before all actions.\n 2. a String: implies that this filter function should be executed before the action named by the string.\n 3. an Object: implies that this filter function should be executed before the actions named by an Array at the `only` key in the options object, or before all actions excluding those named by an Array at the `except` key in the options object.\n\n  \n\n    test \"@beforeAction allows declaration of filters to execute before an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n    test \"@beforeAction allows declaration of named filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"show\", \"fetchTodo\"\n        fetchTodo: -> @set(\"todo\", {isDone: true})\n        show: ->\n          @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n\n    test \"@beforeAction allows whitelisting or blacklisting filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: [\"show\", \"edit\"], \"fetchTodo\"\n        @beforeAction except: [\"index\"], \"prepareNewTodo\"\n        fetchTodo: -> @set \"todo\", {isDone: true}\n        prepareNewTodo: -> @set \"newTodo\", {isDone: false}\n        index: -> @render false\n        show: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n      deepEqual controller.get(\"newTodo\"), {isDone: false}\n\n    test \"@beforeAction allows declaration of filters to execute before all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n## @afterAction([options : [string|Object],] filter : [string|Function])\n\n`@afterAction` allows controllers to declare that a function should be run after the action body and all operations have completed during action execution. Functions declared by `@afterAction` will thus be run after the code of the action body and also after any redirects or renders have taken place and completed. `@afterAction` optionally accepts some options representing which action(s) to execute the filter after, and then a string naming a function or function proper to execute. See `Batman.Controller.beforeAction` for documentation on the structure of the options.\n\n    test \"@afterAction allows declaration of filters to execute after an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n    test \"@afterAction allows declaration of named filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"create\", \"notify\"\n        notify: -> result = \"Todo created successfully.\"\n        create: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows whitelisting or blacklisting filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: [\"create\", \"update\"], \"notify\"\n        index: -> @render false\n        create: -> @render false\n        notify: -> result = \"Todo created successfully.\"\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal result, null\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows declaration of filters to execute after all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n## ::executeAction(action: string[, params: Object])\n\n`executeAction` will run the `action` specified, running all `@beforeAction` and `@afterAction` filters that match that endpoint. Optionally, `params` can be passed into the new action for processing. If no params are passed, it will default to the params of the current action.\n\n    test \"executeAction will run the called action\", ->\n      result = null\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        show: (params) ->\n          result = params.id \n          @render false\n        other: ->\n          @executeAction(\"show\", {id: 4})\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      equal result, 4\n\n    test \"executeAction will run all @beforeAction and @afterAction filters\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: -> \n          results.push \"action!\"\n          @render false\n        other: ->\n          @executeAction(\"index\")\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      deepEqual results, [\"before!\", \"action!\", \"after!\"]\n\n## ::redirect(url: string)\n\n`redirect` will forward the user to a new route defined by `url` without hard-refreshing the page. This modifies the current page URL using pushState if supported, otherwise falling back to hash-bang fragment identifiers. The url can be obtained dynamically using `MyApp.get('routes').myResourceName().path()` or by manually passing a string, such as `@redirect('\/test')`.\n\n## ::scrollToHash([hash: string])\n\n`scrollToHash` emulates the native scrolling behaviour of the browser by allowing the URL to link to a specific ID on the page. The code will look for an element with a matching ID to `hash` if it is provided otherwise using the `#` parameter in the URL. If an element is found, the page will scroll to the matching element.\n\n## ::.autoScrollToHash[= true] : boolean\n\n`autoScrollToHash` is a boolean property on the instance level of a controller describing whether or not the controller should automatically scroll the browser window to the element with ID equal to the `hash` parameter. This behaviour emulates the native behaviour of the same nature, but is implemented in Batman so the functionality works after each dispatch (instead of each page refresh) and when Batman is using hash bang routing. `autoScrollToHash` is true by default.\n\n## ::.defaultRenderYield[= 'main'] : string\n\n`defaultRenderYield` is a `string` representing which yield a controller should automatically render into if no yield is mentioned explicitly. `defaultRenderYield` is `'main'` normally, which means calls to `@render()` or actions which rely on the implicit rendering render their views into the `main` yield (and end up wherever `data-yield=\"main\"` is found in your HTML).","old_contents":"# Batman.Controller\n\n`Batman.Controller` is the base class from which all an application's controllers should descend from. `Batman.Controller`s are responsible for executing _actions_ which fire off requests for model data, render views, or redirect to other actions in response to navigation state changes.\n\n## Controller Directory\n\n`Batman.Controller`s are singletons which means each controller in your application is instantiated exactly once. The instance of each controller is available on the class at the `@sharedController` property, or within a `ControllerDirectory` on the `Application` class. See `Batman.Application.controllers`.\n\n## Actions\n\nEach `Batman.Controller` should have a number of instance level functions which can fetch the data needed and often render a view (or views) to display that data. These functions can be declared in typical CoffeeScript fashion like so:\n\n    class Alfred extends Batman.App\n      @root \"todos#index\"\n\n    class Alfred.TodosController extends Batman.Controller\n      index: (params) ->\n      show: (params) ->\n\nEach action function receives the parameters from the dispatcher which are pulled out of the navigated-to URL. This includes both named route parameters (`\/:foo` style) as well as arbitrary query parameters (`?foo=bar` style).\n\n## routingKey and Minification\n\nFor functionality like contextual redirects and automatic view source and class inference, Batman needs to know the name of all your `Controller` subclasses. The usual way to do this is by using `Function::name` which Batman will use in development, but this is often mangled in minified production environments. For this reason, Batman will error out on boot if a `Controller` subclass' `routingKey` is not defined on the prototype. The `routingKey` is a `String` which remains unmangled after minification and thus allows Batman to continue using the aforementioned features. To disable this requirement (if you know your code won't ever be minified), set `Batman.config.minificationErrors` to false.\n\n## ::render([options : [Object|boolean]])\n\n`render` is used to control the rendering of the currently executed action. Passing `false` will prevent the current action from implicitly rendering the view. Passing an `options` object allows the default `view`, `source`, `viewClass` or `yield` block to be overridden, all of which are optional. If no parameters are passed to options, it will manually trigger the render function, rather than waiting for it to be implicitly called at the end of the action.\n\n_Note_: For more information on yield blocks, see Controller::.defaultRenderYield\n\n    class TestController extends Batman.Controller\n      routingKey: 'test'\n\n      nonVisibleAction: ->\n        @render(false)\n\n      customSource: ->\n        @render(source: 'errors\/404')\n\n      customYield: ->\n        @render(into: 'not-main')\n\n      delayedRender: ->\n        setTimeout (-> @render()), 1000\n        @render(false)\n\n## @beforeAction([options : [string|Object],] filter : [string|Function])\n\n`@beforeAction` allows controllers to declare that a function should be executed before the body of an action during action execution. `@beforeAction` optionally accepts some options representing which action(s) to execute the filter before, and then a string naming a function or function proper to execute.\n\nThe `options` argument can take three forms to imply different things:\n\n 1. `undefined`: implies that this filter function should be executed before all actions.\n 2. a String: implies that this filter function should be executed before the action named by the string.\n 3. an Object: implies that this filter function should be executed before the actions named by an Array at the `only` key in the options object, or before all actions excluding those named by an Array at the `except` key in the options object.\n\n  \n\n    test \"@beforeAction allows declaration of filters to execute before an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n    test \"@beforeAction allows declaration of named filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"show\", \"fetchTodo\"\n        fetchTodo: -> @set(\"todo\", {isDone: true})\n        show: ->\n          @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n\n    test \"@beforeAction allows whitelisting or blacklisting filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: [\"show\", \"edit\"], \"fetchTodo\"\n        @beforeAction except: [\"index\"], \"prepareNewTodo\"\n        fetchTodo: -> @set \"todo\", {isDone: true}\n        prepareNewTodo: -> @set \"newTodo\", {isDone: false}\n        index: -> @render false\n        show: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n      deepEqual controller.get(\"newTodo\"), {isDone: false}\n\n    test \"@beforeAction allows declaration of filters to execute before all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n## @afterAction([options : [string|Object],] filter : [string|Function])\n\n`@afterAction` allows controllers to declare that a function should be run after the action body and all operations have completed during action execution. Functions declared by `@afterAction` will thus be run after the code of the action body and also after any redirects or renders have taken place and completed. `@afterAction` optionally accepts some options representing which action(s) to execute the filter after, and then a string naming a function or function proper to execute. See `Batman.Controller.beforeAction` for documentation on the structure of the options.\n\n    test \"@afterAction allows declaration of filters to execute after an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n    test \"@afterAction allows declaration of named filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"create\", \"notify\"\n        notify: -> result = \"Todo created successfully.\"\n        create: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows whitelisting or blacklisting filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: [\"create\", \"update\"], \"notify\"\n        index: -> @render false\n        create: -> @render false\n        notify: -> result = \"Todo created successfully.\"\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal result, null\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows declaration of filters to execute after all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n## ::executeAction(action: string[, params: Object])\n\n`executeAction` will run the `action` specified, running all `@beforeAction` and `@afterAction` filters that match that endpoint. Optionally, `params` can be passed into the new action for processing. If no params are passed, it will default to the params of the current action.\n\n    test \"executeAction will run the called action\", ->\n      result = null\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        show: (params) ->\n          result = params.id \n          @render false\n        other: ->\n          @executeAction(\"show\", {id: 4})\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      equal result, 4\n\n    test \"executeAction will run all @beforeAction and @afterAction filters\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: -> \n          results.push \"action!\"\n          @render false\n        other: ->\n          @executeAction(\"index\")\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      deepEqual results, [\"before!\", \"action!\", \"after!\"]\n\n## ::redirect(url: string)\n\n`redirect` will forward the user to a new route defined by `url` without hard-refreshing the page. This modifies the current page URL using pushState if supported, otherwise falling back to hash-bang fragment identifiers. The url can be obtained dynamically using `MyApp.get('routes').myResourceName().path()` or by manually passing a string, such as `@redirect('\/test')`.\n\n## ::scrollToHash([hash: string])\n\n`scrollToHash` emulates the native scrolling behaviour of the browser by allowing the URL to link to a specific ID on the page. The code will look for an element with a matching ID to `hash` if it is provided otherwise using the `#` parameter in the URL. If an element is found, the page will scroll to the matching element.\n\n## ::.autoScrollToHash[= true] : boolean\n\n`autoScrollToHash` is a boolean property on the instance level of a controller describing whether or not the controller should automatically scroll the browser window to the element with ID equal to the `hash` parameter. This behaviour emulates the native behaviour of the same nature, but is implemented in Batman so the functionality works after each dispatch (instead of each page refresh) and when Batman is using hash bang routing. `autoScrollToHash` is true by default.\n\n## ::.defaultRenderYield[= 'main'] : string\n\n`defaultRenderYield` is a `string` representing which yield a controller should automatically render into if no yield is mentioned explicitly. `defaultRenderYield` is `'main'` normally, which means calls to `@render()` or actions which rely on the implicit rendering render their views into the `main` yield (and end up wherever `data-yield=\"main\"` is found in your HTML).","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"abffbb23a5bf0c2dc5d9d8220206c793183ef005","subject":"When a limb is asked to stretch further than it can, it no longer breaks into two halves.","message":"When a limb is asked to stretch further than it can, it no longer breaks\ninto two halves.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat","old_file":"src\/computeLimb.litcoffee","new_file":"src\/computeLimb.litcoffee","new_contents":"Given:\n\n- A vector locating the start of the limb.\n- A vector locating the end of the limb.\n- The length of the limb when fully extended.\n- A vector pointing perpendicular to the bend direction.\n- A matrix to store the transform for the start half of the limb.\n- A matrix to store the transform for the end half of the limb.\n\nWrites to the output matrices to generate transforms for the top and bottom\nhalves of a limb to fill the gap between the start and end locations.\n\n    matrix = require \".\/matrix.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n\n    startEndDifference = []\n    startEndNormal = []\n    bendNormal = []\n    midpoint = []\n    joint = []\n    sideNormal2 = []\n    \n    lookAt = (start, end, sideNormal, transform) ->\n        vector.subtract.vector end, start, startEndDifference\n        vector.normalize startEndDifference, startEndNormal\n        vector.cross startEndNormal, sideNormal, bendNormal\n        vector.normalize bendNormal, bendNormal\n        vector.cross bendNormal, startEndNormal, sideNormal2\n        vector.normalize sideNormal2, sideNormal2\n  \n        matrix.identity transform\n        transform[0] = sideNormal2[0]\n        transform[4] = sideNormal2[1]\n        transform[8] = sideNormal2[2]\n        transform[1] = bendNormal[0]\n        transform[5] = bendNormal[1]\n        transform[9] = bendNormal[2]\n        transform[2] = startEndNormal[0]\n        transform[6] = startEndNormal[1]\n        transform[10] = startEndNormal[2]\n        matrix.translate start, transform\n    \n    module.exports = (start, end, targetLength, sideNormal, startTransform, endTransform) ->\n        vector.subtract.vector end, start, startEndDifference\n        realLength = vector.normalize startEndDifference, startEndNormal\n        \n        if realLength > targetLength\n            vector.multiply.byScalar startEndNormal, (targetLength \/ 2), joint\n            vector.add.vector joint, start, joint\n            lookAt start, joint, sideNormal, startTransform\n            lookAt joint, end, sideNormal, endTransform\n        else\n            vector.cross startEndDifference, sideNormal, bendNormal        \n            vector.normalize bendNormal, bendNormal\n            \n            # The two halves of the limb form a pair of square-based triangles.\n            # Work out how far the bend should go based on Pythagoras' theorem.\n            alongBend = Math.sqrt (Math.max 0, (((targetLength \/ 2) * (targetLength \/ 2)) - ((realLength \/ 2) * (realLength \/ 2))))\n        \n            vector.interpolate start, end, 0.5, midpoint\n            vector.multiply.byScalar bendNormal, alongBend, joint\n            vector.add.vector joint, midpoint, joint\n            \n            lookAt start, joint, sideNormal, startTransform\n            lookAt joint, end, sideNormal, endTransform","old_contents":"Given:\n\n- A vector locating the start of the limb.\n- A vector locating the end of the limb.\n- The length of the limb when fully extended.\n- A vector pointing perpendicular to the bend direction.\n- A matrix to store the transform for the start half of the limb.\n- A matrix to store the transform for the end half of the limb.\n\nWrites to the output matrices to generate transforms for the top and bottom\nhalves of a limb to fill the gap between the start and end locations.\n\n    matrix = require \".\/matrix.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n\n    startEndDifference = []\n    startEndNormal = []\n    bendNormal = []\n    midpoint = []\n    joint = []\n    sideNormal2 = []\n    \n    lookAt = (start, end, sideNormal, transform) ->\n        vector.subtract.vector end, start, startEndDifference\n        vector.normalize startEndDifference, startEndNormal\n        vector.cross startEndNormal, sideNormal, bendNormal\n        vector.normalize bendNormal, bendNormal\n        vector.cross bendNormal, startEndNormal, sideNormal2\n        vector.normalize sideNormal2, sideNormal2\n  \n        matrix.identity transform\n        transform[0] = sideNormal2[0]\n        transform[4] = sideNormal2[1]\n        transform[8] = sideNormal2[2]\n        transform[1] = bendNormal[0]\n        transform[5] = bendNormal[1]\n        transform[9] = bendNormal[2]\n        transform[2] = startEndNormal[0]\n        transform[6] = startEndNormal[1]\n        transform[10] = startEndNormal[2]\n        matrix.translate start, transform\n    \n    module.exports = (start, end, targetLength, sideNormal, startTransform, endTransform) ->\n        vector.subtract.vector end, start, startEndDifference\n        vector.cross startEndDifference, sideNormal, bendNormal\n        realLength = vector.normalize startEndDifference, startEndNormal\n        vector.normalize bendNormal, bendNormal\n        \n        # The two halves of the limb form a pair of square-based triangles.\n        # Work out how far the bend should go based on Pythagoras' theorem.\n        alongBend = Math.sqrt (Math.max 0, (((targetLength \/ 2) * (targetLength \/ 2)) - ((realLength \/ 2) * (realLength \/ 2))))\n    \n        vector.interpolate start, end, 0.5, midpoint\n        vector.multiply.byScalar bendNormal, alongBend, joint\n        vector.add.vector joint, midpoint, joint\n        \n        lookAt start, joint, sideNormal, startTransform\n        lookAt joint, end, sideNormal, endTransform","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"493ac433fc1bad965a3f7d2ead7439aabc1b8b0a","subject":"router callback functions","message":"router callback functions\n","repos":"vpj\/weya,vpj\/weya","old_file":"router.litcoffee","new_file":"router.litcoffee","new_contents":"#Weya.Router.litcoffee\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n    if exports?\n     Weya = require '.\/weya'\n     Weya.Base = require '.\/weya_base'\n\n    if not Weya.Base?\n     throw new Error 'Weya.Base not found'\n\n##Weya.Router\n\nRouting with hash tags or pushState\n\n    class Router extends Weya.Base\n     optionalParam: \/\\((.*?)\\)\/g\n     namedParam: \/(\\(\\?)?:\\w+\/g\n     splatParam: \/\\*\\w+\/g\n     escapeRegExp: \/[\\-{}\\[\\]+?.,\\\\\\^$|#\\s]\/g\n\n     @initialize ->\n      @_bindRoutes()\n      @_event = null\n      @_history = []\n\n     _routes: {}\n\n####Register router\n\n`'analyse\/:analysis': 'onAnalyse'`\n\n`dashboard': ['auth', 'dashboard']`\n\nThis will match urls of the form `analyse\/\\*` and call method @onAnalyse\nwith the parameter. Second route will first call @auth if it returns\n`true` @dashboard will be called.\n\nThe most specific route should be at bottom. Routers can added or overridden\nin subclasses\n\n     @routes: (routes) ->\n      @::_routes = _.clone @::_routes\n      for k, v of routes\n       @::_routes[k] = v\n\n####Starts routing\nOption silent will not trigger an event for the current url\n\n     start: (options) ->\n      Weya.history.start options\n      fragment = Weya.history.getFragment()\n\n      if options?.silent is on\n       @_history.push fragment: fragment, title: document.title\n\n####Goes to previous page if exists\n\n     back: ->\n      if @_history.length > 1\n       Weya.history.back()\n\n####Whether it is possible to go to previous page\n\n     canBack: ->\n      if @_history.length > 1 and Weya.history.canBack()\n       return true\n      else\n       return false\n\n####Registers a route\n\n     route: (route, name) ->\n      (route = @_routeToRegExp route) if not _.isRegExp route\n\nRegisters the route with Weya.history\n\n      Weya.history.route route, (fragment, event) =>\n       args = @_extractParameters route, fragment\n       @_event = event\n\nHandle state\n\n       if @_event?.type is \"popstate\"\n        @_history.pop()\n        if @_history.length is 0\n         @_history.push\n          fragment: fragment\n          title: document.title\n          state: @getState()\n       else\n        @_history.push\n         fragment: fragment\n         title: document.title\n         state: @getState()\n\nCalls callbacks in order\n\n       callbacks = name\n       callbacks = [callbacks] if not Array.isArray callbacks\n\n       for callback in callbacks\n        if (typeof callback) is 'string'\n         callback = @[callback]\n        break unless callback.apply this, args\n\n####Gets the current HTML5 History state\n\n     getState: ->\n      if @_event?.originalEvent?.state?\n       return @_event.originalEvent.state\n      else\n       return null\n\n####Navigate to a new URL, while setting HTML5 History state\n\n     navigate: (fragment, options) ->\n      options = {} unless options\n      if options.replace\n       @_history.pop()\n      if not options.trigger\n       @_history.push\n        fragment: fragment\n        title: options.title\n        state: options.state\n\n      Weya.history.navigate fragment, options\n\nBind routes\n\n     _bindRoutes: ->\n      for route, name of @_routes\n       @route route, name\n\nConvert a route string into a regular expression, suitable for matching\n\n     _routeToRegExp: (route) ->\n      route = route.replace @escapeRegExp, '\\\\$&'\n                   .replace @noptionalParam, '(?:$1)?'\n                   .replace @namedParam, (match, optional) ->\n                     if optional then match else '([^\\\/]+)'\n                   .replace @splatParam, '(.*?)'\n\n       return new RegExp \"^#{route}$\"\n\nExtract parameters from a route regex and URL\n\n     _extractParameters: (route, fragment) ->\n      params = route.exec(fragment).slice(1)\n      return _.map params, (param) ->\n       if param then decodeURIComponent(param) else null\n\n## History class\n\n    class History extends Weya.Base\n\nStrip leading hash\/slash and trailing space\n\n     routeStripper: \/^[#\\\/]|\\s+$\/g\n\nStrip leading and trailing slashes\n\n     rootStripper: \/^\\\/+|\\\/+$\/g\n\nRemove trailing slash\n\n     trailingSlash: \/\\\/$\/\n\nStrip urls of hash and query\n\n     pathStripper: \/[?#].*$\/\n\n     @initialize ->\n      @handlers = []\n      _.bindAll this, 'checkUrl'\n      @history = window.history\n      @location = window.location\n      @stateList = []\n\nHash check interval\n\n     interval: 50\n\nGet hash value\n\n     getHash: ->\n      match = @location.href.match \/#(.*)$\/\n      return (if match? then match[1] else '')\n\nGet emulated state\n\n     getEmulateState: ->\n      if @stateList.length > 0\n       return @stateList[@stateList.length - 1]\n      else\n       return {fragment: \"\"}\n\n     popEmulateState: -> @stateList.pop()\n\n     pushEmulateState: (state, title, fragment) ->\n      @stateList.push\n       state: state\n       title: title\n       fragment: fragment\n\nGet the URL fragment\n\n     getFragment: (fragment, forcePushState) ->\n      if not fragment?\n       if @_emulateState\n        fragment = @getEmulateState().fragment\n       else if @_hasPushState or not @_wantsHashChange or forcePushState\n        fragment = @location.pathname\n        root = @root.replace @trailingSlash, ''\n        if (fragment.indexOf root) is 0\n         fragment = fragment.slice root.length\n       else\n        fragment = @getHash()\n\n      return fragment.replace @routeStripper, ''\n\n####Goto the previous page\n\n     back: ->\n      if @_emulateState is on\n       @popEmulateState()\n       @loadUrl null, null\n      else\n       @history?.back?()\n\n####Can back?\n\n     canBack: ->\n      if @_emulateState is on\n       return @stateList.length > 1\n      else\n       return @history?.back?\n\n####Start listening to events\n\n     start: (options) ->\n      History.started = true\n\n      @options = _.extend {root: '\/'}, @options, options\n      @root = @options.root\n      @_emulateState = @options.emulateState is on\n      @_wantsHashChange = @_emulateState is off and @options.hashChange isnt off\n      @_wantsPushState = @_emulateState is off and @options.pushState is on\n      @_hasPushState = @_wantsPushState is on and @history?.pushState?\n      if @_emulateState and @options.start?\n       @pushEmulateState @options.start.state,\n        @options.start.title\n        @options.start.fragment\n\n      @fragment = @getFragment()\n\nNormalize root to always include a leading and trailing slash.\n\n      @root = \"\/#{@root}\/\".replace @rootStripper, '\/'\n\nDepending on whether we're using pushState or hashes, and whether\n'onhashchange' is supported, determine how we check the URL state.\n\n      if @_hasPushState\n       $(window).on 'popstate', @checkUrl\n      else if @_wantsHashChange and window.onhashchange?\n       @(window).on 'hashchange', @checkUrl\n      else if @_wantsHashChange\n       @_checkUrlInterval = setInterval @checkUrl, @interval\n\n      if not @options.silent\n       @loadUrl null, null\n\n####Add a listener to a router\n\n     route: (route, callback) ->\n      @handlers.unshift route: route, callback: callback\n\nCheck current url for changes\n\n     checkUrl: (e) ->\n      fragment = @getFragment()\n      return if fragment is @fragment\n      @loadUrl fragment, e\n\nCall callbacks of matching route\n\n     loadUrl: (fragment, e) ->\n      fragment = @fragment = @getFragment fragment\n      return _.any this.handlers, (handler) ->\n       if handler.route.test fragment\n        handler.callback fragment, e\n        return true\n       else\n        return false\n\n####Navigate to a URL\nTriggers a route is option trigger is on\nReplaces the url is option replace is on\nSets state and title\n\n     navigate: (fragment, options) ->\n      return false if not History.started\n\n      fragment = @getFragment(fragment or '')\n      url = @root + fragment\n\nStrip the fragment of the query and hash for matching.\n\n      fragment = fragment.replace @pathStripper, ''\n\n      return if @fragment is fragment\n      @fragment = fragment\n\nDon't include a trailing slash on the root.\n\n      if fragment is '' and url isnt '\/'\n       url = url.slice 0, -1\n\nIf pushState is available, we use it to set the fragment as a real URL.\n\n      if @_emulateState\n       if options.replace is on\n        @popEmulateState()\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @pushEmulateState state, title, fragment\n      else if @_hasPushState\n       method = if options.replace then 'replaceState' else 'pushState'\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @history[method] state, title, url\n\nIf hash changes haven't been explicitly disabled, update the hash\nfragment to store history.\n\n      else if @_wantsHashChange\n       @_updateHash @location, fragment, options.replace\n\nIf you've told us that you explicitly don't want fallback hashchange-\nbased history, then `navigate` becomes a page refresh.\n\n      else\n       return @location.assign url\n      if options.trigger\n       return @loadUrl fragment, null\n\nUpdate the hash\n\n     _updateHash: (location, fragment, replace) ->\n      if replace\n       href = location.href.replace \/(javascript:|#).*$\/, ''\n       location.replace \"#{href}##{fragment}\"\n      else\n       location.hash = \"##{fragment}\"\n\n    Weya.Router = Router\n    Weya.history = new History\n\n    if module?\n     module.exports = Weya.Router\n\n","old_contents":"#Weya.Router.litcoffee\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n    if exports?\n     Weya = require '.\/weya'\n     Weya.Base = require '.\/weya_base'\n\n    if not Weya.Base?\n     throw new Error 'Weya.Base not found'\n\n##Weya.Router\n\nRouting with hash tags or pushState\n\n    class Router extends Weya.Base\n     optionalParam: \/\\((.*?)\\)\/g\n     namedParam: \/(\\(\\?)?:\\w+\/g\n     splatParam: \/\\*\\w+\/g\n     escapeRegExp: \/[\\-{}\\[\\]+?.,\\\\\\^$|#\\s]\/g\n\n     @initialize ->\n      @_bindRoutes()\n      @_event = null\n      @_history = []\n\n     _routes: {}\n\n####Register router\n\n`'analyse\/:analysis': 'onAnalyse'`\n\n`dashboard': ['auth', 'dashboard']`\n\nThis will match urls of the form `analyse\/\\*` and call method @onAnalyse\nwith the parameter. Second route will first call @auth if it returns\n`true` @dashboard will be called.\n\nThe most specific route should be at bottom. Routers can added or overridden\nin subclasses\n\n     @routes: (routes) ->\n      @::_routes = _.clone @::_routes\n      for k, v of routes\n       @::_routes[k] = v\n\n####Starts routing\nOption silent will not trigger an event for the current url\n\n     start: (options) ->\n      Weya.history.start options\n      fragment = Weya.history.getFragment()\n\n      if options?.silent is on\n       @_history.push fragment: fragment, title: document.title\n\n####Goes to previous page if exists\n\n     back: ->\n      if @_history.length > 1\n       Weya.history.back()\n\n####Whether it is possible to go to previous page\n\n     canBack: ->\n      if @_history.length > 1 and Weya.history.canBack()\n       return true\n      else\n       return false\n\n####Registers a route\n\n     route: (route, name) ->\n      (route = @_routeToRegExp route) if not _.isRegExp route\n\nRegisters the route with Weya.history\n\n      Weya.history.route route, (fragment, event) =>\n       args = @_extractParameters route, fragment\n       @_event = event\n\nHandle state\n\n       if @_event?.type is \"popstate\"\n        @_history.pop()\n        if @_history.length is 0\n         @_history.push\n          fragment: fragment\n          title: document.title\n          state: @getState()\n       else\n        @_history.push\n         fragment: fragment\n         title: document.title\n         state: @getState()\n\nCalls callbacks in order\n\n       callbacks = name\n       callbacks = [callbacks] if not Array.isArray callbacks\n\n       for callback in callbacks\n        callback = @[callback]\n        break unless callback.apply this, args\n\n####Gets the current HTML5 History state\n\n     getState: ->\n      if @_event?.originalEvent?.state?\n       return @_event.originalEvent.state\n      else\n       return null\n\n####Navigate to a new URL, while setting HTML5 History state\n\n     navigate: (fragment, options) ->\n      options = {} unless options\n      if options.replace\n       @_history.pop()\n      if not options.trigger\n       @_history.push\n        fragment: fragment\n        title: options.title\n        state: options.state\n\n      Weya.history.navigate fragment, options\n\nBind routes\n\n     _bindRoutes: ->\n      for route, name of @_routes\n       @route route, name\n\nConvert a route string into a regular expression, suitable for matching\n\n     _routeToRegExp: (route) ->\n      route = route.replace @escapeRegExp, '\\\\$&'\n                   .replace @noptionalParam, '(?:$1)?'\n                   .replace @namedParam, (match, optional) ->\n                     if optional then match else '([^\\\/]+)'\n                   .replace @splatParam, '(.*?)'\n\n       return new RegExp \"^#{route}$\"\n\nExtract parameters from a route regex and URL\n\n     _extractParameters: (route, fragment) ->\n      params = route.exec(fragment).slice(1)\n      return _.map params, (param) ->\n       if param then decodeURIComponent(param) else null\n\n## History class\n\n    class History extends Weya.Base\n\nStrip leading hash\/slash and trailing space\n\n     routeStripper: \/^[#\\\/]|\\s+$\/g\n\nStrip leading and trailing slashes\n\n     rootStripper: \/^\\\/+|\\\/+$\/g\n\nRemove trailing slash\n\n     trailingSlash: \/\\\/$\/\n\nStrip urls of hash and query\n\n     pathStripper: \/[?#].*$\/\n\n     @initialize ->\n      @handlers = []\n      _.bindAll this, 'checkUrl'\n      @history = window.history\n      @location = window.location\n      @stateList = []\n\nHash check interval\n\n     interval: 50\n\nGet hash value\n\n     getHash: ->\n      match = @location.href.match \/#(.*)$\/\n      return (if match? then match[1] else '')\n\nGet emulated state\n\n     getEmulateState: ->\n      if @stateList.length > 0\n       return @stateList[@stateList.length - 1]\n      else\n       return {fragment: \"\"}\n\n     popEmulateState: -> @stateList.pop()\n\n     pushEmulateState: (state, title, fragment) ->\n      @stateList.push\n       state: state\n       title: title\n       fragment: fragment\n\nGet the URL fragment\n\n     getFragment: (fragment, forcePushState) ->\n      if not fragment?\n       if @_emulateState\n        fragment = @getEmulateState().fragment\n       else if @_hasPushState or not @_wantsHashChange or forcePushState\n        fragment = @location.pathname\n        root = @root.replace @trailingSlash, ''\n        if (fragment.indexOf root) is 0\n         fragment = fragment.slice root.length\n       else\n        fragment = @getHash()\n\n      return fragment.replace @routeStripper, ''\n\n####Goto the previous page\n\n     back: ->\n      if @_emulateState is on\n       @popEmulateState()\n       @loadUrl null, null\n      else\n       @history?.back?()\n\n####Can back?\n\n     canBack: ->\n      if @_emulateState is on\n       return @stateList.length > 1\n      else\n       return @history?.back?\n\n####Start listening to events\n\n     start: (options) ->\n      History.started = true\n\n      @options = _.extend {root: '\/'}, @options, options\n      @root = @options.root\n      @_emulateState = @options.emulateState is on\n      @_wantsHashChange = @_emulateState is off and @options.hashChange isnt off\n      @_wantsPushState = @_emulateState is off and @options.pushState is on\n      @_hasPushState = @_wantsPushState is on and @history?.pushState?\n      if @_emulateState and @options.start?\n       @pushEmulateState @options.start.state,\n        @options.start.title\n        @options.start.fragment\n\n      @fragment = @getFragment()\n\nNormalize root to always include a leading and trailing slash.\n\n      @root = \"\/#{@root}\/\".replace @rootStripper, '\/'\n\nDepending on whether we're using pushState or hashes, and whether\n'onhashchange' is supported, determine how we check the URL state.\n\n      if @_hasPushState\n       $(window).on 'popstate', @checkUrl\n      else if @_wantsHashChange and window.onhashchange?\n       @(window).on 'hashchange', @checkUrl\n      else if @_wantsHashChange\n       @_checkUrlInterval = setInterval @checkUrl, @interval\n\n      if not @options.silent\n       @loadUrl null, null\n\n####Add a listener to a router\n\n     route: (route, callback) ->\n      @handlers.unshift route: route, callback: callback\n\nCheck current url for changes\n\n     checkUrl: (e) ->\n      fragment = @getFragment()\n      return if fragment is @fragment\n      @loadUrl fragment, e\n\nCall callbacks of matching route\n\n     loadUrl: (fragment, e) ->\n      fragment = @fragment = @getFragment fragment\n      return _.any this.handlers, (handler) ->\n       if handler.route.test fragment\n        handler.callback fragment, e\n        return true\n       else\n        return false\n\n####Navigate to a URL\nTriggers a route is option trigger is on\nReplaces the url is option replace is on\nSets state and title\n\n     navigate: (fragment, options) ->\n      return false if not History.started\n\n      fragment = @getFragment(fragment or '')\n      url = @root + fragment\n\nStrip the fragment of the query and hash for matching.\n\n      fragment = fragment.replace @pathStripper, ''\n\n      return if @fragment is fragment\n      @fragment = fragment\n\nDon't include a trailing slash on the root.\n\n      if fragment is '' and url isnt '\/'\n       url = url.slice 0, -1\n\nIf pushState is available, we use it to set the fragment as a real URL.\n\n      if @_emulateState\n       if options.replace is on\n        @popEmulateState()\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @pushEmulateState state, title, fragment\n      else if @_hasPushState\n       method = if options.replace then 'replaceState' else 'pushState'\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @history[method] state, title, url\n\nIf hash changes haven't been explicitly disabled, update the hash\nfragment to store history.\n\n      else if @_wantsHashChange\n       @_updateHash @location, fragment, options.replace\n\nIf you've told us that you explicitly don't want fallback hashchange-\nbased history, then `navigate` becomes a page refresh.\n\n      else\n       return @location.assign url\n      if options.trigger\n       return @loadUrl fragment, null\n\nUpdate the hash\n\n     _updateHash: (location, fragment, replace) ->\n      if replace\n       href = location.href.replace \/(javascript:|#).*$\/, ''\n       location.replace \"#{href}##{fragment}\"\n      else\n       location.hash = \"##{fragment}\"\n\n    Weya.Router = Router\n    Weya.history = new History\n\n    if module?\n     module.exports = Weya.Router\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bb5eba147996e7b21f2648b04355784b48be9e08","subject":"Fix branch method names","message":"Fix branch method names\n","repos":"mnmtanish\/vosco-cli","old_file":"script.litcoffee","new_file":"script.litcoffee","new_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    fs     = require \"fs\"\n    path   = require \"path\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    script =\n\nSetup\n-----\n\n      'install': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        if isInstalled then process.exit 1\n        await @vosco.install defer(error)\n\n      'uninstall': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.uninstall defer(error)\n\nRepository\n----------\n\n      'get-status': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getStatus defer(error, status)\n        getType = (file) -> file.type\n        getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n        groups  = _.groupBy status, getType\n        for group, paths of groups\n          console.log \"\"\"\n          #{group}\n          #{paths.map(getPath).join(\"\\n\")}\n          \"\"\"\n\n      'get-history': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getHistory defer(error, history)\n        for commit in history\n          hash = commit.hash.substr(0, 7)\n          date = new Date(commit.date).toDateString()\n          msg  = commit.message\n          console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n\n      'get-content-history': (path) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        # show warning if file doesn\"t exist\n        console.log \"content history\"\n\nSnapshots\n---------\n\n      'preview-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        hash = hash or 'HEAD'\n        await @vosco.previewSnapshot hash, defer(error, diff)\n        console.log diff\n\n      'create-snapshot': (message) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        message = message or 'Untitled Snapshot'\n        await @vosco.createSnapshot message, defer(error)\n\n      'rollback-to-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.rollbackToSnapshot hash, defer(error)\n\nBranches\n--------\n\n      'get-branches': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"branches list\"\n\n      'create-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"create new branch\"\n\n      'select-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"select branch\"\n\n      'delete-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"delete branch\"\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      script.vosco = vosco\n      return script\n","old_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    fs     = require \"fs\"\n    path   = require \"path\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    script =\n\nSetup\n-----\n\n      'install': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        if isInstalled then process.exit 1\n        await @vosco.install defer(error)\n\n      'uninstall': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.uninstall defer(error)\n\nRepository\n----------\n\n      'get-status': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getStatus defer(error, status)\n        getType = (file) -> file.type\n        getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n        groups  = _.groupBy status, getType\n        for group, paths of groups\n          console.log \"\"\"\n          #{group}\n          #{paths.map(getPath).join(\"\\n\")}\n          \"\"\"\n\n      'get-history': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getHistory defer(error, history)\n        for commit in history\n          hash = commit.hash.substr(0, 7)\n          date = new Date(commit.date).toDateString()\n          msg  = commit.message\n          console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n\n      'get-content-history': (path) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        # show warning if file doesn\"t exist\n        console.log \"content history\"\n\nSnapshots\n---------\n\n      'preview-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        hash = hash or 'HEAD'\n        await @vosco.previewSnapshot hash, defer(error, diff)\n        console.log diff\n\n      'create-snapshot': (message) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        message = message or 'Untitled Snapshot'\n        await @vosco.createSnapshot message, defer(error)\n\n      'rollback-to-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.rollbackToSnapshot hash, defer(error)\n\nBranches\n--------\n\n      'list-branches': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"branches list\"\n\n      'select-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"select branch\"\n\n      'create-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"create new branch\"\n\n      'delete-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"delete branch\"\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      script.vosco = vosco\n      return script\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"25ed14c2f98fefede688acb65c8b9e14347a2d30","subject":"add redis session handling","message":"add redis session handling\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/app.litcoffee","new_file":"src\/app.litcoffee","new_contents":"\n# Application Startup\n\nThis code starts up the application.\n\n## Configure\n\nFirst, include required modules.\n\n    express = require 'express'\n    exp3hbs = require 'express3-handlebars'\n    redis_store = require('connect-redis')(express)\n\nNext, initialize the application.\n\n    app = express()\n\nConfigure HBS to glue Express and Handlebars together with HTML file extensions\nfor templates.  Also, register a partials directory to pre-load.\n\n    app.set 'view engine', 'html'\n    exp3hbs_config =\n      defaultLayout: 'default',\n      extname: '.html'\n    app.engine 'html', exp3hbs(exp3hbs_config)\n\nConfigure Express to serve static files.\n\n    app.use express.static('public')\n\nInitialize a session for later use.\n\n    cookie_secret = 'cfc1924e0b9b2e137a812912a3e3f2346d65aef6'\n    app.use express.cookieParser(cookie_secret)\n    app.use express.session({\n      store: new redis_store({host: '127.0.0.1', port: 6379, prefix: 'app-sess'}),\n      secret: cookie_secret\n    })\n\n## Routes\n\nAdd essential routes.\n\n    app.get '\/', (req, res) ->\n      res.render 'hello_world', {\n        title: 'Hello World'\n      }\n\n## Startup\n\nFinally, start the server.\n\n    app.listen 3000\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Startup\n\nThis code starts up the application.\n\n## Configure\n\nFirst, include required modules.\n\n    express = require 'express'\n    exp3hbs = require 'express3-handlebars'\n\nNext, initialize the application.\n\n    app = express()\n\nConfigure HBS to glue Express and Handlebars together with HTML file extensions\nfor templates.  Also, register a partials directory to pre-load.\n\n    app.set 'view engine', 'html'\n    exp3hbs_config =\n      defaultLayout: 'default',\n      extname: '.html'\n    app.engine 'html', exp3hbs(exp3hbs_config)\n\nConfigure Express to serve static files.\n\n    app.use express.static('public')\n\n## Routes\n\nAdd essential routes.\n\n    app.get '\/', (req, res) ->\n      res.render 'hello_world', {\n        title: 'Hello World'\n      }\n        \n\n## Startup\n\nFinally, start the server.\n\n    app.listen 3000\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"a6810fc9a9391d91a07e8c2c1bf3e06b31373cdc","subject":"update README","message":"update README\n","repos":"CureApp\/loopback-with-admin","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# loopback-with-admin\n\nrun loopback server with admin and push notification features.\n\n# install\n\n```bash\nnpm install loopback-with-admin\n```\n\n# usage\n## simplest run\n\n    # model definitions\n    # see \"models\" section for more detail\n    models =\n        'user':\n            base: 'User'\n\n\n    require('loopback-with-admin').run(models).then (lbInfo) ->\n\n        # see \"LoopbackInfo\" section for more detail\n        console.log lbInfo.getURL()         # loopback api root\n        console.log lbInfo.getAdminTokens() # access tokens of admin\n\n\n## run with config dir\n\nbefore running, you can prepare a directory which contains custom config information.\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    configDir = '\/path\/to\/config-dir'\n\n    lbWithAdmin.run(models, configDir).then ->\n        # loopback started\n\n## run with config\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    lbWithAdmin.run(models, server: port: 3001).then ->\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    require('loopback-with-admin').run(models, configDir, env)\n\nenv is defined as\n\n```coffee\n    env ?= process.env.NODE_ENV or 'development'\n```\n- use custom value if passed\n- use NODE\\_ENV if exists\n- default value is 'development'\n\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-admin selects configs in \"local\" directory.\n\n\n\n# model definitions\n\n    models =\n        player: # model name\n            base: 'User'  \n            aclType: 'admin' # specific for this system\n\n        instrument:\n            aclType: 'owner-read'\n\n\nthe same format as [loopback model definition](http:\/\/docs.strongloop.com\/display\/public\/LB\/Customizing+models)\nexcept \"aclType\" value.\nname is automatically set from definition information.\nplural is set to the same value as name if not set manually.\n\n## aclType\nloopback-with-admin generates acls from aclType.\n\nthree types are available.\n\n aclType              | meaning\n----------------------|-----------------------------------------------------\n admin                | only admin can CRUD the model (_default_)\n owner                | the owner of the model can CRUD\n public-read          | everyone can READ the model and admin can CRUD\n member-read          | authenticated users can READ the model and admin can CRUD\n public-read-by-owner | CRUD by the owner, and read by everyone\n member-read-by-owner | CRUD by the owner, and read by authenticated users\n none                 | everyone can CRUD the model\n\n\n# configs\n\nthese are the config names.\n\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-values\/non-model-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## datasources\n\n config key  | meaning\n-------------|---------------------------------\n memory      | on memory datasource\n db          | datasource for custom entities\n\nEach datasource name has its connectors.\n\n### available loopback connectors\n\navailable datasources are \n- mongodb\n- memory\n- memory-idstr\n\n\"memory-idstr\" is the default connector, which stores data only in memory,\nand id type is string whereas id type of \"memory\" is number.\n\n\nwhen using mongodb, add dependencies in package.json of your repository\n\n- loopback-connector-mongodb: \"1.13.0\"\n- mongodb: \"2.0.35\"\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n# LoopbackInfo\n    require('loopback-with-admin').run().then (lbInfo) ->\n        lbInfo instanceof LoopbackInfo # true\n\ninstance of LoopbackInfo is obtained after loopback is launched\n\n## getURL()\nreturns hosting URL\n\n## getAdminTokens()\nreturns Array of access tokens (string).\n\n    lbInfo.getURL() # e.g. localhost:3000\/api\n\n## getEnv()\nreturns environment name where loopback launched\n\n    lbInfo.getEnv() # development|production or other custom environments\n\n\n## config\ncontains all config values used to build loopback.\n\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee configs section above.\n\n## models\ncontains model definitions used to build loopback\n\nsee models section above.\n\n# push notification \n(coming soon)\n\n\n\n","old_contents":"# loopback-with-admin\n\nrun loopback server with admin and push notification features.\n\n# install\n\n```bash\nnpm install loopback-with-admin\n```\n\n# usage\n## simplest run\n\n    # model definitions\n    # see \"models\" section for more detail\n    models =\n        'user':\n            base: 'User'\n\n\n    require('loopback-with-admin').run(models).then (lbInfo) ->\n\n        # see \"LoopbackInfo\" section for more detail\n        console.log lbInfo.getURL()         # loopback api root\n\n\n## run with config dir\n\nbefore running, you can prepare a directory which contains custom config information.\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    configDir = '\/path\/to\/config-dir'\n\n    lbWithAdmin.run(models, configDir).then ->\n        # loopback started\n\n## run with config\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    lbWithAdmin.run(models, server: port: 3001).then ->\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    require('loopback-with-admin').run(models, configDir, env)\n\nenv is defined as\n\n```coffee\n    env ?= process.env.NODE_ENV or 'development'\n```\n- use custom value if passed\n- use NODE\\_ENV if exists\n- default value is 'development'\n\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-admin selects configs in \"local\" directory.\n\n\n\n# model definitions\n\n    models =\n        player: # model name\n            base: 'User'  \n            aclType: 'admin' # specific for this system\n\n        instrument:\n            aclType: 'owner-read'\n\n\nthe same format as [loopback model definition](http:\/\/docs.strongloop.com\/display\/public\/LB\/Customizing+models)\nexcept \"aclType\" value.\nname is automatically set from definition information.\nplural is set to the same value as name if not set manually.\n\n## aclType\nloopback-with-admin generates acls from aclType.\n\nthree types are available.\n\n aclType              | meaning\n----------------------|-----------------------------------------------------\n admin                | only admin can CRUD the model (_default_)\n owner                | the owner of the model can CRUD\n public-read          | everyone can READ the model and admin can CRUD\n member-read          | authenticated users can READ the model and admin can CRUD\n public-read-by-owner | CRUD by the owner, and read by everyone\n member-read-by-owner | CRUD by the owner, and read by authenticated users\n none                 | everyone can CRUD the model\n\n\n# configs\n\nthese are the config names.\n\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-values\/non-model-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## datasources\n\n config key  | meaning\n-------------|---------------------------------\n memory      | on memory datasource\n db          | datasource for custom entities\n\nEach datasource name has its connectors.\n\n### available loopback connectors\n\navailable datasources are \n- mongodb\n- memory\n- memory-idstr\n\n\"memory-idstr\" is the default connector, which stores data only in memory,\nand id type is string whereas id type of \"memory\" is number.\n\n\nwhen using mongodb, add dependencies in package.json of your repository\n\n- loopback-connector-mongodb: \"1.13.0\"\n- mongodb: \"2.0.35\"\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n# LoopbackInfo\n    require('loopback-with-admin').run().then (lbInfo) ->\n        lbInfo instanceof LoopbackInfo # true\n\ninstance of LoopbackInfo is obtained after loopback is launched\n\n## getURL()\nreturns hosting URL\n\n    lbInfo.getURL() # e.g. localhost:3000\/api\n\n## getEnv()\nreturns environment name where loopback launched\n\n    lbInfo.getEnv() # development|production or other custom environments\n\n\n## config\ncontains all config values used to build loopback.\n\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee configs section above.\n\n## models\ncontains model definitions used to build loopback\n\nsee models section above.\n\n# push notification \n(coming soon)\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"60792dc4a45137819121cc90454f7c63fa9dd7a3","subject":"enhanced generate function, removed copyOwn function","message":"enhanced generate function, removed copyOwn function\n","repos":"arximboldi\/heterarchy","old_file":"heterarchy.litcoffee","new_file":"heterarchy.litcoffee","new_contents":"heterarchy\n==========\n\n> This file is part of [Heterarchy](http:\/\/sinusoid.es\/heterarchy).\n> - **View me [on a static web](http:\/\/sinusoid.es\/heterarchy\/heterarchy.html)**\n> - **View me [on GitHub](https:\/\/github.com\/arximboldi\/heterarchy\/blob\/master\/heterarchy.litcoffee)**\n\nAdds multiple inheritance support to CoffeeScript (and JavaScript).\nIt uses the C3 linearization algorithm as described in the [famous\nDylan paper](http:\/\/192.220.96.201\/dylan\/linearization-oopsla96.html).\n\n    {head, tail, map, find, some, without, isEmpty, every, memoize, reject,\n     partial, isEqual, reduce} = require 'underscore'\n\n    assert = (value, errorMessage) ->\n        if not value\n            throw new Error(errorMessage)\n\nMultiple inheritance\n--------------------\n\nThe **multi** function takes a list of classes and returns a *special*\nclass object that merges the class hierarchies, as linearized by the\nC3 algorithm. Limitations of the approach are:\n\n- `instanceof` does not always work as expected. For example:\n\n  > ```coffee\n  > class A\n  > class B extends A\n  > class C extends A\n  > class D extends multi B, C\n  > assert new D not instanceof B\n  > ```\n\n  Instead, one should use the provided `isinstance` function.\n\n- Some of the bases of a multi-inherited hierarchy are *frozen* when\n  the sub-class is defined -- i.e. later modifications to the\n  superclass are not visible to the subclass or its instances.  For\n  example, in the previous heterarchy:\n\n  > ```coffee\n  > B::newProperty = 42\n  > assert D::newProperty == undefined\n  > ```\n\nThe `multi` function memoizes its results such that identity is\nmaintained, implying `multi X, Y is multi X, Y`.\n\n    exports.multi = (bases...) ->\n        generate merge map(bases, mro).concat [bases]\n\nThis takes a list of classes representing a hierarchy (from most to\nleast derived) and generates a single-inheritance hierarchy that\nbehaves like a class that would have such a hierarchy.\n\n    generate = memoize (linearization) ->\n        next = head linearization\n        if isEqual linearization, hierarchy next\n            next\n        else\n            class Result extends generate tail linearization\n                __mro__: linearization\n                constructor: reparent next, @, next::constructor\n                # 1. Fill up missing class attributes and\n                # 2. Adjust class methods (so the MRO is used).\n                #    Those are already part of the class because when extending\n                #    all class attributes are copied to `this` by CoffeeScript.\n                for own key, value of next\n                    @[key] = reparent next, @, value\n                # fill up missing instance attributes\n                for own key, value of next::\n                    if not @::hasOwnProperty key\n                        @::[key] = reparent next, @, value\n\nMethods in CoffeeScript call super directly, so we have to change the\n`__super__` attribute of the original class during the scope of the\nmethod so it calls the right super of the linearization. Also,\nprogrammers don't call super in constructor of root classes --indeed\ndoing so would rise an error-- so we have to inject such a call when\nthere are classes after these in the linearization. The **reparent**\nfunction takes care of all these and given an original class, and the\nnew class that is replacing it a linearized heterarchy, returns a\nwrapped copy of a value of the former that is suitable for replacing\nit in the later.\n\n    reparent = (oldklass, newklass, value) ->\n        if value not instanceof Function\n            value\n        else if value is oldklass::constructor and inherited(oldklass) is Object\n            superctor = inherited(newklass)::constructor\n            ->\n                superctor.apply @, arguments\n                value.apply @, arguments\n        else\n            newsuper = inherited(newklass)::\n            oldsuper = oldklass.__super__\n            ->\n                oldklass.__super__ = newsuper\n                try\n                    value.apply @, arguments\n                finally\n                    oldklass.__super__ = oldsuper\n\nThis is the C3 linearization algorithm, as translated from the\noriginal paper.\n\n    merge = (inputs) ->\n        while not isEmpty inputs\n            next = find (map inputs, head), (candidate) ->\n                every inputs, (input) -> candidate not in tail input\n            assert next?, \"Inconsistent multiple inheritance\"\n            inputs = reject map(inputs, (lst) -> without lst, next), isEmpty\n            next\n\nIntrospection\n-------------\n\nThe **mro** function returns the method resolution order\n(linearization) of a given class:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends B\n> assert mro(C).equals [C, B, A]\n> ```\n\nIt returns the original classes that were mixed in when used with\nmulti-inherited classes:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert mro(D).equals [D, B, C, A, Object]\n> ```\n\n    javaScriptClassNames = [\n        \"Array\"\n        \"Boolean\"\n        \"Date\"\n        \"Error\"\n        \"Function\"\n        \"Number\"\n        \"RegExp\"\n        \"String\"\n        \"Object\"\n        \"EvalError\"\n        \"RangeError\"\n        \"ReferenceError\"\n        \"SyntaxError\"\n        \"TypeError\"\n        \"URIError\"\n        # non-standard classes\n        \"Symbol\"\n        # typed arrays\n        \"Int8Array\"\n        \"Uint8Array\"\n        \"Uint8ClampedArray\"\n        \"Int16Array\"\n        \"Uint16Array\"\n        \"Int32Array\"\n        \"Uint32Array\"\n        \"Float32Array\"\n        \"Float64Array\"\n        # Keyed collections\n        \"Map\"\n        \"Set\"\n        \"WeakMap\"\n        \"WeakSet\"\n        # Structured data\n        \"ArrayBuffer\"\n        \"DataView\"\n        # Control abstraction objects\n        \"Promise\"\n        \"Generator\"\n        \"GeneratorFunction\"\n        # Reflection\n        \"Reflect\"\n        \"Proxy\"\n    ]\n    javaScriptClasses = reduce javaScriptClassNames, (classes, name) ->\n        classes[global[name]] = global[name]\n        classes\n    , {}\n    isJavaScriptClass = (cls) ->\n        javaScriptClasses[cls] is cls\n\n    exports.mro = mro = (cls) ->\n        if not cls? or not cls::?\n            []\n        else if not cls::hasOwnProperty '__mro__'\n            result = [cls].concat mro inherited(cls)\n            cls::__mro__ = result unless isJavaScriptClass cls\n            result\n        else\n            cls::__mro__\n\nThe **inherited** function returns the CoffeeScript superclass of an\nobject, for example:\n\n> ```coffee\n> class A\n> class B extends A\n> assert inherited(B) == A\n> ```\n\nNote that for multiple inherited classes, this returns the mixed\nobject, not the next class in the MRO, as in:\n\n> ```coffee\n> class C extends multi A, B\n> assert inherited(C) == multi(A, B)\n> ```\n\n    exports.inherited = inherited = (cls) ->\n        Object.getPrototypeOf(cls.prototype)?.constructor\n\nThe **hierarchy** returns the CoffeeScript hierarchy of classes of a\ngiven class, including the class itself.  For multiple inherited\nclasses, it may return special classes that were generated to produce\nthe flattening, as in:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert not mro(D).equals hierarchy(D)\n> assert hierarchy(D).equals\n>     [ D, multi(B, C), inherited(multi B, C), A, Object ]\n> ```\n\n    exports.hierarchy = hierarchy = (cls) ->\n        if not cls?\n            []\n        else\n            [cls].concat hierarchy inherited cls\n\nThe **isinstance** function takes an object and a class or classes and\nreturns whether the object is an instance of any of those classes. It\nis compatible with multi-inherited classes.\n\n    exports.isinstance = (obj, classes...) ->\n        exports.issubclass obj?.constructor, classes...\n\nThe **issubclass** tells whether a class is a subtype of another type.\n\n    exports.issubclass = (klass, classes...) ->\n        linearization = mro klass\n        some classes, (cls) -> cls in linearization\n\nLicense\n-------\n\n> Copyright (c) 2013, 2015 Juan Pedro Bolivar Puente <raskolnikov@gnu.org>\n>\n> Permission is hereby granted, free of charge, to any person obtaining a copy\n> of this software and associated documentation files (the \"Software\"), to deal\n> in the Software without restriction, including without limitation the rights\n> to use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\n> copies of the Software, and to permit persons to whom the Software is\n> furnished to do so, subject to the following conditions:\n>\n> The above copyright notice and this permission notice shall be included in\n> all copies or substantial portions of the Software.\n>\n> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n> THE SOFTWARE.\n","old_contents":"heterarchy\n==========\n\n> This file is part of [Heterarchy](http:\/\/sinusoid.es\/heterarchy).\n> - **View me [on a static web](http:\/\/sinusoid.es\/heterarchy\/heterarchy.html)**\n> - **View me [on GitHub](https:\/\/github.com\/arximboldi\/heterarchy\/blob\/master\/heterarchy.litcoffee)**\n\nAdds multiple inheritance support to CoffeeScript (and JavaScript).\nIt uses the C3 linearization algorithm as described in the [famous\nDylan paper](http:\/\/192.220.96.201\/dylan\/linearization-oopsla96.html).\n\n    {head, tail, map, find, some, without, isEmpty, every, memoize, reject,\n     partial, isEqual, reduce} = require 'underscore'\n\n    assert = (value, errorMessage) ->\n        if not value\n            throw new Error(errorMessage)\n\nMultiple inheritance\n--------------------\n\nThe **multi** function takes a list of classes and returns a *special*\nclass object that merges the class hierarchies, as linearized by the\nC3 algorithm. Limitations of the approach are:\n\n- `instanceof` does not always work as expected. For example:\n\n  > ```coffee\n  > class A\n  > class B extends A\n  > class C extends A\n  > class D extends multi B, C\n  > assert new D not instanceof B\n  > ```\n\n  Instead, one should use the provided `isinstance` function.\n\n- Some of the bases of a multi-inherited hierarchy are *frozen* when\n  the sub-class is defined -- i.e. later modifications to the\n  superclass are not visible to the subclass or its instances.  For\n  example, in the previous heterarchy:\n\n  > ```coffee\n  > B::newProperty = 42\n  > assert D::newProperty == undefined\n  > ```\n\nThe `multi` function memoizes its results such that identity is\nmaintained, implying `multi X, Y is multi X, Y`.\n\n    exports.multi = (bases...) ->\n        generate merge map(bases, mro).concat [bases]\n\nThis takes a list of classes representing a hierarchy (from most to\nleast derived) and generates a single-inheritance hierarchy that\nbehaves like a class that would have such a hierarchy.\n\n    generate = memoize (linearization) ->\n        next = head linearization\n        if isEqual linearization, hierarchy next\n            next\n        else\n            class Result extends generate tail linearization\n                __mro__: linearization\n                constructor: reparent next, @, next::constructor\n                # FILL UP MISSING CLASS ATTRIBUTES\n                # copy class attributes from `next` to `this` that only exist on `next`\n                copyOwn next, @\n                # ADJUST CLASS METHOD (so the MRO is used)\n                # copy class methods from `next` to `this` that are implemented by `next`\n                # note: this is basically the same as copyOwn but ignoring `if not to.hasOwnProperty key`\n                # This is due to the fact that when inheriting all class attributes are copied to `this` by CoffeeScript.\n                for own key, value of next when value instanceof Function\n                    @[key] = partial(reparent, next, @)(value)\n                # FILL UP MISSING INSTANCE ATTRIBUTES\n                # copy instance attributes from `next` to `this` that only exist on `next`\n                # with projection `reparent` (pre-applied `next` and `this`)\n                copyOwn next::, @::, partial reparent, next, @\n\nThis utility lets us copy own properties of a *from* object that are\nnot own properties of a *to* object into the *to* object, optionally\ntransformed via a projection function.\n\n    copyOwn = (from, to, project = (x) -> x) ->\n        for own key, value of from\n            if not to.hasOwnProperty key\n                to[key] = project value\n        to\n\nMethods in CoffeeScript call super directly, so we have to change the\n`__super__` attribute of the original class during the scope of the\nmethod so it calls the right super of the linearization. Also,\nprogrammers don't call super in constructor of root classes --indeed\ndoing so would rise an error-- so we have to inject such a call when\nthere are classes after these in the linearization. The **reparent**\nfunction takes care of all these and given an original class, and the\nnew class that is replacing it a linearized heterarchy, returns a\nwrapped copy of a value of the former that is suitable for replacing\nit in the later.\n\n    reparent = (oldklass, newklass, value) ->\n        if value not instanceof Function\n            value\n        else if value is oldklass::constructor and inherited(oldklass) is Object\n            superctor = inherited(newklass)::constructor\n            ->\n                superctor.apply @, arguments\n                value.apply @, arguments\n        else\n            newsuper = inherited(newklass)::\n            oldsuper = oldklass.__super__\n            ->\n                oldklass.__super__ = newsuper\n                try\n                    value.apply @, arguments\n                finally\n                    oldklass.__super__ = oldsuper\n\nThis is the C3 linearization algorithm, as translated from the\noriginal paper.\n\n    merge = (inputs) ->\n        while not isEmpty inputs\n            next = find (map inputs, head), (candidate) ->\n                every inputs, (input) -> candidate not in tail input\n            assert next?, \"Inconsistent multiple inheritance\"\n            inputs = reject map(inputs, (lst) -> without lst, next), isEmpty\n            next\n\nIntrospection\n-------------\n\nThe **mro** function returns the method resolution order\n(linearization) of a given class:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends B\n> assert mro(C).equals [C, B, A]\n> ```\n\nIt returns the original classes that were mixed in when used with\nmulti-inherited classes:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert mro(D).equals [D, B, C, A, Object]\n> ```\n\n    javaScriptClassNames = [\n        \"Array\"\n        \"Boolean\"\n        \"Date\"\n        \"Error\"\n        \"Function\"\n        \"Number\"\n        \"RegExp\"\n        \"String\"\n        \"Object\"\n        \"EvalError\"\n        \"RangeError\"\n        \"ReferenceError\"\n        \"SyntaxError\"\n        \"TypeError\"\n        \"URIError\"\n        # non-standard classes\n        \"Symbol\"\n        # typed arrays\n        \"Int8Array\"\n        \"Uint8Array\"\n        \"Uint8ClampedArray\"\n        \"Int16Array\"\n        \"Uint16Array\"\n        \"Int32Array\"\n        \"Uint32Array\"\n        \"Float32Array\"\n        \"Float64Array\"\n        # Keyed collections\n        \"Map\"\n        \"Set\"\n        \"WeakMap\"\n        \"WeakSet\"\n        # Structured data\n        \"ArrayBuffer\"\n        \"DataView\"\n        # Control abstraction objects\n        \"Promise\"\n        \"Generator\"\n        \"GeneratorFunction\"\n        # Reflection\n        \"Reflect\"\n        \"Proxy\"\n    ]\n    javaScriptClasses = reduce javaScriptClassNames, (classes, name) ->\n        classes[global[name]] = global[name]\n        classes\n    , {}\n    isJavaScriptClass = (cls) ->\n        javaScriptClasses[cls] is cls\n\n    exports.mro = mro = (cls) ->\n        if not cls? or not cls::?\n            []\n        else if not cls::hasOwnProperty '__mro__'\n            result = [cls].concat mro inherited(cls)\n            cls::__mro__ = result unless isJavaScriptClass cls\n            result\n        else\n            cls::__mro__\n\nThe **inherited** function returns the CoffeeScript superclass of an\nobject, for example:\n\n> ```coffee\n> class A\n> class B extends A\n> assert inherited(B) == A\n> ```\n\nNote that for multiple inherited classes, this returns the mixed\nobject, not the next class in the MRO, as in:\n\n> ```coffee\n> class C extends multi A, B\n> assert inherited(C) == multi(A, B)\n> ```\n\n    exports.inherited = inherited = (cls) ->\n        Object.getPrototypeOf(cls.prototype)?.constructor\n\nThe **hierarchy** returns the CoffeeScript hierarchy of classes of a\ngiven class, including the class itself.  For multiple inherited\nclasses, it may return special classes that were generated to produce\nthe flattening, as in:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert not mro(D).equals hierarchy(D)\n> assert hierarchy(D).equals\n>     [ D, multi(B, C), inherited(multi B, C), A, Object ]\n> ```\n\n    exports.hierarchy = hierarchy = (cls) ->\n        if not cls?\n            []\n        else\n            [cls].concat hierarchy inherited cls\n\nThe **isinstance** function takes an object and a class or classes and\nreturns whether the object is an instance of any of those classes. It\nis compatible with multi-inherited classes.\n\n    exports.isinstance = (obj, classes...) ->\n        exports.issubclass obj?.constructor, classes...\n\nThe **issubclass** tells whether a class is a subtype of another type.\n\n    exports.issubclass = (klass, classes...) ->\n        linearization = mro klass\n        some classes, (cls) -> cls in linearization\n\nLicense\n-------\n\n> Copyright (c) 2013, 2015 Juan Pedro Bolivar Puente <raskolnikov@gnu.org>\n>\n> Permission is hereby granted, free of charge, to any person obtaining a copy\n> of this software and associated documentation files (the \"Software\"), to deal\n> in the Software without restriction, including without limitation the rights\n> to use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\n> copies of the Software, and to permit persons to whom the Software is\n> furnished to do so, subject to the following conditions:\n>\n> The above copyright notice and this permission notice shall be included in\n> all copies or substantial portions of the Software.\n>\n> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n> THE SOFTWARE.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"98b9e85ea8a77350b1dd532d91cdd11fbd7323db","subject":"update README","message":"update README\n","repos":"CureApp\/loopback-with-admin","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# loopback-with-admin\n\nrun loopback server with admin and push notification features.\n\n# install\n\n```bash\nnpm install loopback-with-admin\n```\n\n# usage\n## simplest run\n\n    # model definitions\n    # see \"models\" section for more detail\n    models =\n        'user':\n            base: 'User'\n\n\n    require('loopback-with-admin').run(models).then (lbInfo) ->\n\n        # see \"LoopbackInfo\" section for more detail\n        console.log lbInfo.getURL()         # loopback api root\n        console.log lbInfo.getAccessToken() # access token of admin\n\n\n## run with config dir\n\nbefore running, you can prepare a directory which contains custom config information.\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    configDir = '\/path\/to\/config-dir'\n\n    lbWithAdmin.run(models, configDir).then ->\n        # loopback started\n\n## run with config\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    lbWithAdmin.run(models, server: port: 3001).then ->\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    require('loopback-with-admin').run(models, configDir, env)\n\nenv is defined as\n\n```coffee\n    env ?= process.env.NODE_ENV or 'development'\n```\n- use custom value if passed\n- use NODE\\_ENV if exists\n- default value is 'development'\n\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-admin selects configs in \"local\" directory.\n\n\n\n# model definitions\n\n    models =\n        player: # model name\n            base: 'User'  \n            aclType: 'admin' # specific for this system\n\n        instrument:\n            aclType: 'owner-read'\n\n\nthe same format as [loopback model definition](http:\/\/docs.strongloop.com\/display\/public\/LB\/Customizing+models)\nexcept \"aclType\" value.\nname is automatically set from definition information.\nplural is set to the same value as name if not set manually.\n\n## aclType\nloopback-with-admin generates acls from aclType.\n\nthree types are available.\n\n aclType     | meaning\n-------------|-----------------------------------------------------\n admin       | only admin can CRUD the model (_default_)\n owner       | admin and the owner of the model can CRUD\n public-read | everyone can READ the model and admin can CRUD\n none        | everyone can CRUD the model\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-values\/non-model-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|---------------------------------\n memory      | on memory datasource\n db          | datasource for custom entities\n\nEach datasource name has its connectors.\n\n### available loopback connectors\n\navailable datasources are \n- mongodb\n- memory\n- memory-idstr\n\n\"memory-idstr\" is the default connector, which stores data only in memory,\nand id type is string whereas id type of \"memory\" is number.\n\n\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n# admin\n(coming soon)\n\n# push notification \n(coming soon)\n\n\n\n","old_contents":"# loopback-with-admin\n\nrun loopback server with admin and push notification features.\n\n# install\n\n```bash\nnpm install loopback-with-admin\n```\n\n# simplest run\n\n    models =\n        'user':\n            base: 'User'\n\n\n    require('loopback-with-admin').run(models).then (lbInfo) ->\n\n        console.log lbInfo.getURL()         # loopback api root\n        console.log lbInfo.getAccessToken() # access token of admin\n\n\n# run with config dir\n\nbefore running, you can prepare a directory which contains custom config information.\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    configDir = '\/path\/to\/config-dir'\n\n    lbWithAdmin.run(configDir).then ->\n        # loopback started\n\n# run with config\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    lbWithAdmin.run(models, server: port: 3001).then ->\n\n\n# admin\n(coming soon)\n\n# push notification \n(coming soon)\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-values\/non-model-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|-----------------------\n memory      | on memory datasource\n db          | datasource for custom entities\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n# model definitions\n\n    models =\n        player: # model name\n            base: 'User'  \n            aclType: 'admin' # specific for this system\n\n        instrument:\n            aclType: 'owner-read'\n\n\nthe same format as [loopback model definition](http:\/\/docs.strongloop.com\/display\/public\/LB\/Customizing+models)\nexcept \"aclType\" value.\nname is automatically set from definition information.\nplural is set to the same value as name if not set manually.\n\n## aclType\nloopback-with-admin generates acls from aclType.\n\nthree types are available.\n\n aclType     | meaning\n-------------|-----------------------------------------------------\n admin       | only admin can CRUD the model\n owner       | admin and the owner of the model can CRUD\n public-read | everyone can READ the model and admin can CRUD\n none        | everyone can CRUD the model\n\n\n# switching environment\n\nrunning script with environment variable \"NODE\\_ENV\" like\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\n\"development\" is selected by default.\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-admin selects configs in \"local\" directory.\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    lbWithAdmin.run(configDir, env)\n\nenv is prior to NODE\\_ENV settings.\n\n\n# modified loopback-datasource-juggler\n\nusing [CureApp\/loopback-datasource-juggler](https:\/\/github.com\/CureApp\/loopback-datasource-juggler).\n\nthis repository is almost the same as original one except 'memory' connector handles id as string\n(orignally integer).\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"adb6ad3cd2d6c9ef58b69cc742f644a2a97d3e0f","subject":"Moved to documented Middleware pattern (modulating data)","message":"Moved to documented Middleware pattern (modulating data)\n","repos":"laconalabs\/elliptical,lacona\/lacona","old_file":"src\/lacona.litcoffee","new_file":"src\/lacona.litcoffee","new_contents":"#Includes\n\n\t{EventEmitter} = require 'events'\n\tasync = require 'async'\n\tutil = require 'util'\n\t_ = require 'lodash'\n\n\tElementFactory = require '.\/element-factory'\n\tPhrase = require '.\/phrase'\n\tInputOption = require '.\/input-option'\n\n#Lacona\n\n\tclass Parser extends EventEmitter\n\t\tconstructor: (@options) ->\n\t\t\t@phrases = []\n\n\t\t\t@middleware = []\n\n\t\t\t@understand require('.\/plugins\/literal')\n\t\t\t@understand require('.\/plugins\/freetext')\n\t\t\t@understand require('.\/plugins\/integer')\n\t\t\t@understand require('.\/plugins\/date')\n\n\t\tphraseAccessor: (name) =>\n\t\t\t_.filter @phrases, (phrase) ->\n\t\t\t\tphrase.name is name or name in phrase.extends\n\n###`understand`\n\n`understand` takes a schema and scope, and defines a set of words for Lacona to understand\n\n\t\tunderstand: (options) ->\n\t\t\tscope = options.scope\n\t\t\tschema = if options.schema? then options.schema else options\n\t\t\tif not util.isArray(schema)\n\t\t\t\tschema = [schema]\n\t\t\tfor phrase in schema\n\t\t\t\telementFactory = new ElementFactory(scope, @)\n\t\t\t\t@phrases.push new Phrase(phrase, scope, elementFactory)\n\t\t\treturn @\n\n###`use`\n\n`use` defines middleware. It must be passed a function that accepts 2 arguments, an inputOption,\nand a callback that should be passed an error (or null) and a modulated inputOption. This will be passed\nto the `data` event (or the next middleware) rather than the inputOption itself.\n\n\t\tuse: (next) ->\n\t\t\t@middleware.push next\n\n\t\tparse: (inputText) ->\n\t\t\tinput = new InputOption(inputText)\n\t\t\t\t\n\t\t\tasync.each _.filter(@phrases, (item) -> item.sentence), (phrase, done) =>\n\t\t\t\tphrase.parse input, null, (option) =>\n\t\t\t\t\tif option.text is ''\n\t\t\t\t\t\tasync.eachSeries @middleware, (call, done) =>\n\t\t\t\t\t\t\tcall option, done\n\t\t\t\t\t\t, (err) =>\n\t\t\t\t\t\t\treturn done(err) if err?\n\t\t\t\t\t\t\t@emit 'data', option\n\t\t\t\t, done\n\n\t\t\t, (err) =>\n\t\t\t\tif err?\n\t\t\t\t\t@emit 'error', err\n\t\t\t\telse\n\t\t\t\t\t@emit 'end'\n\n\n\tconvertToHTML = (inputOption, done) ->\n\t\thtml = '<div class=\"option\">'\n\t\thtml += '<span class=\"match\">'\n\t\tfor match in inputOption.match\n\t\t\thtml += \"<span class='word #{match.partOfSpeech}'>#{match.string}<\/span>\"\n\t\thtml += '<\/span><span class=\"suggestion\">'\n\t\tfor suggestion in inputOption.suggestion.words\n\t\t\thtml += \"<span class='word #{suggestion.partOfSpeech}'>#{suggestion.string}<\/span>\"\n\t\thtml += '<\/span><span class=\"completion\">'\n\t\tfor completion in inputOption.completion\n\t\t\thtml += \"<span class='word #{completion.partOfSpeech}'>#{completion.string}<\/span>\"\n\t\thtml += '<\/span><\/div>'\n\n\t\tinputOption.html = html\n\t\tdone()\n\n\tmodule.exports =\n\t\tParser: Parser\n\t\tconvertToHTML: convertToHTML\n\n","old_contents":"#Includes\n\n\t{EventEmitter} = require 'events'\n\tasync = require 'async'\n\tutil = require 'util'\n\t_ = require 'lodash'\n\n\tElementFactory = require '.\/element-factory'\n\tPhrase = require '.\/phrase'\n\tInputOption = require '.\/input-option'\n\n#Lacona\n\n\tclass Parser extends EventEmitter\n\t\tconstructor: (@options) ->\n\t\t\t@phrases = []\n\n\t\t\t@middleware = []\n\n\t\t\t@understand require('.\/plugins\/literal')\n\t\t\t@understand require('.\/plugins\/freetext')\n\t\t\t@understand require('.\/plugins\/integer')\n\t\t\t@understand require('.\/plugins\/date')\n\n\t\tphraseAccessor: (name) =>\n\t\t\t_.filter @phrases, (phrase) ->\n\t\t\t\tphrase.name is name or name in phrase.extends\n\n###`understand`\n\n`understand` takes a schema and scope, and defines a set of words for Lacona to understand\n\n\t\tunderstand: (options) ->\n\t\t\tscope = options.scope\n\t\t\tschema = if options.schema? then options.schema else options\n\t\t\tif not util.isArray(schema)\n\t\t\t\tschema = [schema]\n\t\t\tfor phrase in schema\n\t\t\t\telementFactory = new ElementFactory(scope, @)\n\t\t\t\t@phrases.push new Phrase(phrase, scope, elementFactory)\n\t\t\treturn @\n\n###`use`\n\n`use` defines middleware. It must be passed a function that accepts 2 arguments, an inputOption,\nand a callback that should be passed an error (or null) and a modulated inputOption. This will be passed\nto the `data` event (or the next middleware) rather than the inputOption itself.\n\n\t\tuse: (next) ->\n\t\t\t@middleware.push next\n\n\t\tparse: (inputText) ->\n\t\t\tinput = new InputOption(inputText)\n\t\t\t\t\n\t\t\tasync.each _.filter(@phrases, (item) -> item.sentence), (phrase, done) =>\n\t\t\t\tphrase.parse input, null, (option) =>\n\t\t\t\t\tif option.text is ''\n\t\t\t\t\t\t@_applyMiddleware option, (err, finalOption) =>\n\t\t\t\t\t\t\treturn done(err) if err?\n\t\t\t\t\t\t\t@emit 'data', finalOption\n\t\t\t\t, done\n\n\t\t\t, (err) =>\n\t\t\t\tif err?\n\t\t\t\t\t@emit 'error', err\n\t\t\t\telse\n\t\t\t\t\t@emit 'end'\n\n\t\t_applyMiddleware: (data, done) ->\n\t\t\tasync.eachSeries @middleware, (call, done) ->\n\t\t\t\tcall data, (err, newData) ->\n\t\t\t\t\treturn done(err) if err?\n\t\t\t\t\tdata = newData\n\t\t\t, (err) ->\n\t\t\t\tdone(err, data)\n\n\n\tconvertToHTML = (inputOption) ->\n\t\thtml = '<div class=\"option\">'\n\t\thtml += '<span class=\"match\">'\n\t\tfor match in inputOption.match\n\t\t\thtml += \"<span class='word #{match.partOfSpeech}'>#{match.string}<\/span>\"\n\t\thtml += '<\/span><span class=\"suggestion\">'\n\t\tfor suggestion in inputOption.suggestion.words\n\t\t\thtml += \"<span class='word #{suggestion.partOfSpeech}'>#{suggestion.string}<\/span>\"\n\t\thtml += '<\/span><span class=\"completion\">'\n\t\tfor completion in inputOption.completion\n\t\t\thtml += \"<span class='word #{completion.partOfSpeech}'>#{completion.string}<\/span>\"\n\t\thtml += '<\/span><\/div>'\n\n\t\treturn html\n\n\tmodule.exports =\n\t\tParser: Parser\n\t\tconvertToHTML: convertToHTML\n\n","returncode":0,"stderr":"","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"4b156c59a049d68c1622f2e9365f286f47436b43","subject":"Bug with <script src \/> fixed","message":"Bug with <script src \/> fixed\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/document\/file\/parse\/scripts.litcoffee","new_file":"src\/document\/file\/parse\/scripts.litcoffee","new_contents":"# script\n\n    'use strict'\n\n    fs = require 'fs-extra'\n    os = require 'os'\n    utils = require 'src\/utils'\n    pathUtils = require 'path'\n    {getFilePath} = require '.\/links'\n\n    uid = 0\n    realpath = fs.realpathSync '.\/'\n    tmpdir = os.tmpdir()\n\n    isCoffee = (path) -> \/\\.(?:coffee|litcoffee|coffee\\.md)$\/.test(path)\n    getScriptPath = (filename) ->\n        extname = (filename and pathUtils.extname(filename)) or '.js'\n        \"build\/scripts\/#{uid++}.js\"\n\n    module.exports = (File) -> (file) ->\n        if file instanceof File.Iterator\n            return\n\n        scripts = []\n\n        for tag in file.node.queryAll('script')\n            omit = false\n            for attr of tag.attrs\n                if attr not in ['src', 'href', 'filename']\n                    omit = true\n                    break\n            if omit\n                continue\n\n            tag.parent = null\n\n            {src} = tag.attrs\n            src ||= tag.attrs.href\n\n            if src\n                src = getFilePath File, file, src\n                path = getScriptPath src\n                fs.copySync src, path\n                scripts.push path\n            else\n                # tag body\n                str = tag.stringifyChildren()\n                path = getScriptPath tag.attrs.filename\n                if isCoffee(path)\n                    str = \"`module.exports = function(){`\\n\\n#{str}\\n\\n`};`\"\n                else\n                    str = \"module.exports = function(){\\n\\n#{str}\\n\\n};\"\n                fs.outputFileSync path, str\n                scripts.push path\n\n        file.scripts = new File.Scripts file, scripts\n\n        return\n\n# Glossary\n\n- [script](#neftscript)\n","old_contents":"# script\n\n    'use strict'\n\n    fs = require 'fs-extra'\n    os = require 'os'\n    utils = require 'src\/utils'\n    pathUtils = require 'path'\n    { getFilePath } = require '.\/links'\n\n    uid = 0\n    realpath = fs.realpathSync '.\/'\n    tmpdir = os.tmpdir()\n\n    isCoffee = (path) -> \/\\.(?:coffee|litcoffee|coffee\\.md)$\/.test(path)\n\n    module.exports = (File) -> (file) ->\n        if file instanceof File.Iterator\n            return\n\n        scripts = []\n\n        for tag in file.node.queryAll('script')\n            omit = false\n            for attr of tag.attrs\n                if attr not in ['src', 'href', 'filename']\n                    omit = true\n                    break\n            if omit\n                continue\n\n            tag.parent = null\n\n            {src} = tag.attrs\n            src ||= tag.attrs.href\n\n            if src\n                src = getFilePath File, file, src\n                scripts.push src\n            else\n                # tag body\n                str = tag.stringifyChildren()\n                filename = tag.attrs.filename or \"tmp#{uid++}.js\"\n                if isCoffee(filename)\n                    str = \"`module.exports = function(){`\\n\\n#{str}\\n\\n`};`\"\n                else\n                    str = \"module.exports = function(){\\n\\n#{str}\\n\\n};\"\n                if Neft?\n                    path = pathUtils.join 'build\/scripts\/', filename\n                else\n                    path = pathUtils.join tmpdir, '\/', filename\n                fs.outputFileSync path, str\n                scripts.push path\n\n        file.scripts = new File.Scripts file, scripts\n\n        return\n\n# Glossary\n\n- [script](#neftscript)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"509b9e5861142b460876c9117fa74030823dd063","subject":"Fix default config","message":"Fix default config\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_contents":"nodePush Pushserver\n===================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nFirst we import the required packages and make them available in a global variable.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nNext we try to load the configuration file \"config.js\".\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nIn case not every configuration property is set we initialize it with a default property.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= \"#{__dirname}\/..\/tmp\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= \"#{__dirname}\/..\/tmp\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nWe continue with creating some helper functions.\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\t\n\tfs.open \"#{__dirname}\/..\/tmp\/nodePush.child.pid\", \"w\", 0o600, (err, fd) ->\n\t\tfs.writeSync fd, process.pid\n\t\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.wcf ?= {}\n\nbe.bastelstu.wcf.nodePush\n=========================\n\n\tclass be.bastelstu.wcf.nodePush\n\t\nAttributes\n----------\n\n`app` will become an instance of `express`.\n\n\t\tapp: null\n\n`server` willbecome an instance of `http`.\n\n\t\tserver: null\n\n`io` will become an instance of `socket.io`.\n\n\t\tio: null\n\n`stats` is an object with the different statistics recorded. Statistics will be shown on the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**  \nThe constructor is executed when the class is initialized. It prints some helpful information,\nsuch as the PID and the used sockets and continues with initializing everything.\n\n\t\tconstructor: ->\n\t\t\tlog \"nodePush running (pid:#{process.pid})\"\n\nFirst we display the used inbound and outbound sockets.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\nAfterwards we initialize the inbound and outbound connection.\n\n\t\t\t@initInbound()\n\t\t\t@initOutbound()\n\nIn order to do a proper cleanup on shutdown we bind the `shutdown` method to the needed events and signals.\n\n\t\t\tprocess.on 'exit', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'uncaughtException', (message) =>\n\t\t\t\t@shutdown message, 1\n\t\t\tprocess.on 'SIGINT', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGTERM', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGHUP', =>\n\t\t\t\t@shutdown null, 2\n\nAt the end we set a nice title for `ps`.\n\n\t\t\tprocess.title = 'nodePush'\n\n**initOutbound()**  \n`initOutbound` initializes the connection to the browser. That includes starting the HTTP server and preparing\nsocket.io.\n\n\t\tinitOutbound: ->\n\t\t\tlog 'Initializing outbound socket'\n\nFirst we start the express based HTTP server.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\nAfterwards we set socket.io configuration for the default environment. Files will be minified and logging reduced to a minimum.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nIn case `env` is set to development we show some more debug output.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nNext we listen on the socket.io `connection` event to record statistics.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++ if @app.get('env') is 'development'\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'userID', (userID) =>\n\t\t\t\t\tsocket.get 'userID', (_, currentUserID) =>\n\nIn case a client misbehaves, by sending the `userID` twice, we `disconnect` it.\n\n\t\t\t\t\t\tif currentUserID?\n\t\t\t\t\t\t\tsocket.disconnect()\n\t\t\t\t\t\t\treturn\n\nMark user as *authenticated* by joining **user**. If a client does not send a `userID` it will not receive any messages.\n\n\t\t\t\t\t\tsocket.set 'userID', userID\n\t\t\t\t\t\tsocket.join 'authenticated'\n\t\t\t\t\t\tsocket.join \"user#{userID}\"\n\t\t\t\t\t\tsocket.emit 'authenticated'\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\t\t\t\t\t\t\t\nWe continue with creating a callback for the `listen` call.\n\n\t\t\tlistenCallback = =>\n\nIn case we are running as root we try to shed root privilegies. If this is not possible we exit, as a service\nrunning as root is dangerous.\n\n\t\t\t\tif process.getuid? and (process.getuid() is 0 or process.getgid() is 0)\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nAfter the the HTTP server is listening and we are no longer running as root we start some intervals for the builtin tick events.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\nStart listening on the configured outbound socket.\n\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\nShow detailed information when environment is `development`.\n\n\t\t\t\tif @app.get('env') is 'development'\n\t\t\t\t\t@stats.status++\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\t\tMessages:\n\t\t\t\t\t\"\"\"\n\t\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\telse\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now\n\t\t\t\t\t\"\"\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name, userIDs = [ ]) ->\n\t\t\treturn unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test name\n\t\t\t\n\t\t\tif name is 'be.bastelstu.wcf.nodePush._restart'\n\t\t\t\tprocess.kill process.pid, 'SIGHUP'\n\t\t\t\n\t\t\tif @app.get('env') is 'development'\n\t\t\t\t@stats.messages[name] ?= 0\n\t\t\t\t@stats.messages[name]++\n\t\t\t\n\t\t\tif userIDs.length\n\t\t\t\t@io.sockets.in(\"user#{userID}\").send name for userID in userIDs\n\t\t\telse\n\t\t\t\t@io.sockets.in('authenticated').send name\n\n**initInbound()**  \n`initInbound` initializes the PHP side socket.\n\n\t\tinitInbound: ->\n\t\t\tlog 'Initializing inbound socket'\n\nWe start by creating a server.\n\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++ if @app.get('env') is 'development'\n\nIn case data is written to the server we pass it to the connected browsers and close the connection afterwards.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\t[ message, userIDs ] = data.toString().trim().split \/:\/\n\t\t\t\t\tif userIDs? and userIDs.length\n\t\t\t\t\t\tuserIDs = userIDs.split \/,\/\n\t\t\t\t\t\tuserIDs = (parseInt userID for userID in userIDs when not isNaN parseInt userID)\n\t\t\t\t\telse\n\t\t\t\t\t\tuserIDs = [ ]\n\t\t\t\t\t\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage message, userIDs\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nIn case nothing happens within 5 seconds we close the connection in order to save resources.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\nAfter all callbacks are bound we start listening.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \n`shutdown` performs a clean shutdown of nodePush. It cleans up the unix socket files.\n\n\t\tshutdown: (message = null, code = 0) ->\n\t\t\tif message?\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\telse\n\t\t\t\tlog 'Shutting down'\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket if not config.inbound.useTCP and fs.existsSync config.inbound.socket\n\t\t\tfs.unlinkSync config.outbound.socket if not config.outbound.useTCP and fs.existsSync config.outbound.socket\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit code\n\nIn the end we finally initialize the class with starts all the services.\n\n\tnew be.bastelstu.wcf.nodePush()\n","old_contents":"nodePush Pushserver\n===================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nFirst we import the required packages and make them available in a global variable.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nNext we try to load the configuration file \"config.js\".\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nIn case not every configuration property is set we initialize it with a default property.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nWe continue with creating some helper functions.\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\t\n\tfs.open \"#{__dirname}\/..\/tmp\/nodePush.child.pid\", \"w\", 0o600, (err, fd) ->\n\t\tfs.writeSync fd, process.pid\n\t\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.wcf ?= {}\n\nbe.bastelstu.wcf.nodePush\n=========================\n\n\tclass be.bastelstu.wcf.nodePush\n\t\nAttributes\n----------\n\n`app` will become an instance of `express`.\n\n\t\tapp: null\n\n`server` willbecome an instance of `http`.\n\n\t\tserver: null\n\n`io` will become an instance of `socket.io`.\n\n\t\tio: null\n\n`stats` is an object with the different statistics recorded. Statistics will be shown on the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**  \nThe constructor is executed when the class is initialized. It prints some helpful information,\nsuch as the PID and the used sockets and continues with initializing everything.\n\n\t\tconstructor: ->\n\t\t\tlog \"nodePush running (pid:#{process.pid})\"\n\nFirst we display the used inbound and outbound sockets.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\nAfterwards we initialize the inbound and outbound connection.\n\n\t\t\t@initInbound()\n\t\t\t@initOutbound()\n\nIn order to do a proper cleanup on shutdown we bind the `shutdown` method to the needed events and signals.\n\n\t\t\tprocess.on 'exit', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'uncaughtException', (message) =>\n\t\t\t\t@shutdown message, 1\n\t\t\tprocess.on 'SIGINT', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGTERM', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGHUP', =>\n\t\t\t\t@shutdown null, 2\n\nAt the end we set a nice title for `ps`.\n\n\t\t\tprocess.title = 'nodePush'\n\n**initOutbound()**  \n`initOutbound` initializes the connection to the browser. That includes starting the HTTP server and preparing\nsocket.io.\n\n\t\tinitOutbound: ->\n\t\t\tlog 'Initializing outbound socket'\n\nFirst we start the express based HTTP server.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\nAfterwards we set socket.io configuration for the default environment. Files will be minified and logging reduced to a minimum.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nIn case `env` is set to development we show some more debug output.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nNext we listen on the socket.io `connection` event to record statistics.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++ if @app.get('env') is 'development'\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'userID', (userID) =>\n\t\t\t\t\tsocket.get 'userID', (_, currentUserID) =>\n\nIn case a client misbehaves, by sending the `userID` twice, we `disconnect` it.\n\n\t\t\t\t\t\tif currentUserID?\n\t\t\t\t\t\t\tsocket.disconnect()\n\t\t\t\t\t\t\treturn\n\nMark user as *authenticated* by joining **user**. If a client does not send a `userID` it will not receive any messages.\n\n\t\t\t\t\t\tsocket.set 'userID', userID\n\t\t\t\t\t\tsocket.join 'authenticated'\n\t\t\t\t\t\tsocket.join \"user#{userID}\"\n\t\t\t\t\t\tsocket.emit 'authenticated'\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\t\t\t\t\t\t\t\nWe continue with creating a callback for the `listen` call.\n\n\t\t\tlistenCallback = =>\n\nIn case we are running as root we try to shed root privilegies. If this is not possible we exit, as a service\nrunning as root is dangerous.\n\n\t\t\t\tif process.getuid? and (process.getuid() is 0 or process.getgid() is 0)\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nAfter the the HTTP server is listening and we are no longer running as root we start some intervals for the builtin tick events.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\nStart listening on the configured outbound socket.\n\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\nShow detailed information when environment is `development`.\n\n\t\t\t\tif @app.get('env') is 'development'\n\t\t\t\t\t@stats.status++\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\t\tMessages:\n\t\t\t\t\t\"\"\"\n\t\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\telse\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now\n\t\t\t\t\t\"\"\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name, userIDs = [ ]) ->\n\t\t\treturn unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test name\n\t\t\t\n\t\t\tif name is 'be.bastelstu.wcf.nodePush._restart'\n\t\t\t\tprocess.kill process.pid, 'SIGHUP'\n\t\t\t\n\t\t\tif @app.get('env') is 'development'\n\t\t\t\t@stats.messages[name] ?= 0\n\t\t\t\t@stats.messages[name]++\n\t\t\t\n\t\t\tif userIDs.length\n\t\t\t\t@io.sockets.in(\"user#{userID}\").send name for userID in userIDs\n\t\t\telse\n\t\t\t\t@io.sockets.in('authenticated').send name\n\n**initInbound()**  \n`initInbound` initializes the PHP side socket.\n\n\t\tinitInbound: ->\n\t\t\tlog 'Initializing inbound socket'\n\nWe start by creating a server.\n\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++ if @app.get('env') is 'development'\n\nIn case data is written to the server we pass it to the connected browsers and close the connection afterwards.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\t[ message, userIDs ] = data.toString().trim().split \/:\/\n\t\t\t\t\tif userIDs? and userIDs.length\n\t\t\t\t\t\tuserIDs = userIDs.split \/,\/\n\t\t\t\t\t\tuserIDs = (parseInt userID for userID in userIDs when not isNaN parseInt userID)\n\t\t\t\t\telse\n\t\t\t\t\t\tuserIDs = [ ]\n\t\t\t\t\t\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage message, userIDs\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nIn case nothing happens within 5 seconds we close the connection in order to save resources.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\nAfter all callbacks are bound we start listening.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \n`shutdown` performs a clean shutdown of nodePush. It cleans up the unix socket files.\n\n\t\tshutdown: (message = null, code = 0) ->\n\t\t\tif message?\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\telse\n\t\t\t\tlog 'Shutting down'\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket if not config.inbound.useTCP and fs.existsSync config.inbound.socket\n\t\t\tfs.unlinkSync config.outbound.socket if not config.outbound.useTCP and fs.existsSync config.outbound.socket\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit code\n\nIn the end we finally initialize the class with starts all the services.\n\n\tnew be.bastelstu.wcf.nodePush()\n","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"1da8ff40acd1a5211cb7fa8ab0697a649d57acab","subject":"Updates for review","message":"Updates for review\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a nodes child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it being visible until ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also prevent you from allowing features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","old_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a nodes child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it being visible until ready.\n\n## data-yield\n\n`data-yield` is used for binging HTML from views into the document. By default `data-yield=\"main\"` will bind view HTML based on the current controller and action. You can also define HTML templates using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` provides the keypath for which child nodes are bound to for use in a `data-yield`.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c14d4d31ee18dcc5c9174ba7b4bc3659185ff39b","subject":"Fixed beforeAll and afterAll in subscopes","message":"Fixed beforeAll and afterAll in subscopes\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"lib\/testing\/index.litcoffee","new_file":"lib\/testing\/index.litcoffee","new_contents":"# Testing\n\n    'use strict'\n\n    {utils, log, assert} = Neft\n    stack = require '.\/stack'\n    logger = require '.\/logger'\n    screenshot = require '.\/screenshot\/client'\n\n    {isArray} = Array\n    {push} = Array::\n    {Scope, Test, Listener} = require '.\/structure'\n\n    scopes = [new Scope]\n    currentScope = scopes[0]\n\n    ONLY_OPT = 1 << 1\n\n    raportOnlyUsed = ->\n        if process.env.CI\n            throw new Error \"Cannot use describe.only and it.only on CI\"\n        else\n            log.warn \"describe.only or it.only is used\"\n\n# describe(*String* message, *Function* tests)\n\n    exports.describe = (msg, func, opts = 0) ->\n        beforeEach = utils.NOP\n\n        # new scope\n        scope = new Scope\n        scope.message = msg\n        if scope.isOnly = (opts & ONLY_OPT) > 0\n            stack.onlyScopes += 1\n        scopes.push scope\n\n        # before\/after functions\n        push.apply scope.beforeEachFunctions, currentScope.beforeEachFunctions\n        push.apply scope.afterEachFunctions, currentScope.afterEachFunctions\n\n        # save scope to parent\n        currentScope.children.push scope\n        scope.parent = currentScope\n\n        # save as last\n        currentScope = scope\n\n        # children tests\n        func()\n\n        # set parent as last\n        scopes.pop()\n        currentScope = utils.last scopes\n        return\n\n# describe.only(*String* message, *Function* tests)\n\n    exports.describe.only = (msg, func) ->\n        raportOnlyUsed()\n        exports.describe msg, func, ONLY_OPT\n\n# it(*String* message, *Function* test)\n\nThe given test function can contains optional *callback* argument.\n\n    exports.it = (msg, func, opts = 0) ->\n        testScope = currentScope\n\n        # new test\n        test = new Test\n        test.message = msg\n        test.testFunction = func\n        if test.isOnly = (opts & ONLY_OPT) > 0\n            stack.onlyTests += 1\n\n        # add test into scope\n        scope = utils.last scopes\n        scope.children.push test\n        test.parent = scope\n\n        return\n\n# it.only(*String* message, *Function* test)\n\n    exports.it.only = (msg, func) ->\n        raportOnlyUsed()\n        exports.it msg, func, ONLY_OPT\n\n# beforeEach(*Function* code)\n\n    exports.beforeEach = (func) ->\n        currentScope.beforeEachFunctions.push func\n        return\n\n# afterEach(*Function* code)\n\n    exports.afterEach = (func) ->\n        currentScope.afterEachFunctions.push func\n        return\n\n# beforeAll(*Function* code)\n\n    exports.beforeAll = (func) ->\n        currentScope.beforeAllFunctions.push func\n        return\n\n# afterAll(*Function* code)\n\n    exports.afterAll = (func) ->\n        currentScope.afterAllFunctions.push func\n        return\n\n# whenChange(*Object* watchObject, *Function* callback, [*Integer* maxDelay = `1000`])\n\n    exports.whenChange = do ->\n        listeners = []\n\n        checkListeners = ->\n            i = 0\n            while i < listeners.length\n                listener = listeners[i]\n\n                if listener.test()\n                    listeners.splice i, 1\n                else\n                    i++\n\n            if listeners.length > 0\n                setImmediate checkListeners\n            return\n\n        (obj, callback, maxDelay = 1000) ->\n            listener = new Listener\n            listener.object = obj\n            listener.objectCopy = utils.clone(obj)\n            listener.callback = callback\n            listener.maxDelay = maxDelay\n\n            if listeners.length is 0\n                setImmediate checkListeners\n\n            listeners.push listener\n            return\n\n# takeScreenshot(*String|Object* options, [*Function* callback])\n\n    screenshotInitialized = false\n    exports.takeScreenshot = (opts, callback) ->\n        if typeof opts is 'string'\n            opts = expected: opts\n\n        unless opts?.expected\n            throw new Error \"'expected' path not set in takeScreenshot\"\n\n        {currentTest} = Test\n        assert.notOk currentTest.callbackCalled, \"\"\"\n            takeScreenshot called but current test '#{currentTest.getFullMessage()}' \\\n            is not pending\n        \"\"\"\n\n        currentTest.preventEnding = true\n\n        endCurrentTest = (err) ->\n            callback? err\n            currentTest.preventEnding = false\n            currentTest.onEnd err\n\n        unless screenshotInitialized\n            screenshotInitialized = true\n            screenshot.initialize (err) ->\n                if err\n                    endCurrentTest err\n                else\n                    exports.takeScreenshot opts, callback\n            return\n\n        screenshot.take opts, endCurrentTest\n        return\n\n    runTests = ->\n        [mainScope] = scopes\n        logger.onTestsStart()\n        mainScope.run ->\n            logger.onTestsEnd()\n            onTestsEnd\n                status: if stack.errors.length is 0 then 'success' else 'error'\n                testsAmount: stack.testsAmount\n                errors: stack.errors\n\n    onTestsEnd = (result) ->\n        code = if result.status is 'success' then 0 else 1\n        if process.env.NEFT_NODE\n            # give logs some time to be printed int stdout\n            setTimeout ->\n                process.exit code\n            , 1000\n\n    runAutomatically = do ->\n        val = process?.env.RUN_TESTS\n        if typeof val is 'string'\n            val = try JSON.parse val\n        val ?= true\n        val\n\n    setImmediate ->\n        if runAutomatically\n            runTests()\n","old_contents":"# Testing\n\n    'use strict'\n\n    {utils, log, assert} = Neft\n    stack = require '.\/stack'\n    logger = require '.\/logger'\n    screenshot = require '.\/screenshot\/client'\n\n    {isArray} = Array\n    {push} = Array::\n    {Scope, Test, Listener} = require '.\/structure'\n\n    scopes = [new Scope]\n    currentScope = scopes[0]\n\n    ONLY_OPT = 1 << 1\n\n    raportOnlyUsed = ->\n        if process.env.CI\n            throw new Error \"Cannot use describe.only and it.only on CI\"\n        else\n            log.warn \"describe.only or it.only is used\"\n\n# describe(*String* message, *Function* tests)\n\n    exports.describe = (msg, func, opts = 0) ->\n        beforeEach = utils.NOP\n\n        # new scope\n        scope = new Scope\n        scope.message = msg\n        if scope.isOnly = (opts & ONLY_OPT) > 0\n            stack.onlyScopes += 1\n        scopes.push scope\n\n        # before\/after functions\n        push.apply scope.beforeAllFunctions, currentScope.beforeAllFunctions\n        push.apply scope.afterAllFunctions, currentScope.afterAllFunctions\n        push.apply scope.beforeEachFunctions, currentScope.beforeEachFunctions\n        push.apply scope.afterEachFunctions, currentScope.afterEachFunctions\n\n        # save scope to parent\n        currentScope.children.push scope\n        scope.parent = currentScope\n\n        # save as last\n        currentScope = scope\n\n        # children tests\n        func()\n\n        # set parent as last\n        scopes.pop()\n        currentScope = utils.last scopes\n        return\n\n# describe.only(*String* message, *Function* tests)\n\n    exports.describe.only = (msg, func) ->\n        raportOnlyUsed()\n        exports.describe msg, func, ONLY_OPT\n\n# it(*String* message, *Function* test)\n\nThe given test function can contains optional *callback* argument.\n\n    exports.it = (msg, func, opts = 0) ->\n        testScope = currentScope\n\n        # new test\n        test = new Test\n        test.message = msg\n        test.testFunction = func\n        if test.isOnly = (opts & ONLY_OPT) > 0\n            stack.onlyTests += 1\n\n        # add test into scope\n        scope = utils.last scopes\n        scope.children.push test\n        test.parent = scope\n\n        return\n\n# it.only(*String* message, *Function* test)\n\n    exports.it.only = (msg, func) ->\n        raportOnlyUsed()\n        exports.it msg, func, ONLY_OPT\n\n# beforeEach(*Function* code)\n\n    exports.beforeEach = (func) ->\n        currentScope.beforeEachFunctions.push func\n        return\n\n# afterEach(*Function* code)\n\n    exports.afterEach = (func) ->\n        currentScope.afterEachFunctions.push func\n        return\n\n# beforeAll(*Function* code)\n\n    exports.beforeAll = (func) ->\n        currentScope.beforeAllFunctions.push func\n        return\n\n# afterAll(*Function* code)\n\n    exports.afterAll = (func) ->\n        currentScope.afterAllFunctions.push func\n        return\n\n# whenChange(*Object* watchObject, *Function* callback, [*Integer* maxDelay = `1000`])\n\n    exports.whenChange = do ->\n        listeners = []\n\n        checkListeners = ->\n            i = 0\n            while i < listeners.length\n                listener = listeners[i]\n\n                if listener.test()\n                    listeners.splice i, 1\n                else\n                    i++\n\n            if listeners.length > 0\n                setImmediate checkListeners\n            return\n\n        (obj, callback, maxDelay = 1000) ->\n            listener = new Listener\n            listener.object = obj\n            listener.objectCopy = utils.clone(obj)\n            listener.callback = callback\n            listener.maxDelay = maxDelay\n\n            if listeners.length is 0\n                setImmediate checkListeners\n\n            listeners.push listener\n            return\n\n# takeScreenshot(*String|Object* options, [*Function* callback])\n\n    screenshotInitialized = false\n    exports.takeScreenshot = (opts, callback) ->\n        if typeof opts is 'string'\n            opts = expected: opts\n\n        unless opts?.expected\n            throw new Error \"'expected' path not set in takeScreenshot\"\n\n        {currentTest} = Test\n        assert.notOk currentTest.callbackCalled, \"\"\"\n            takeScreenshot called but current test '#{currentTest.getFullMessage()}' \\\n            is not pending\n        \"\"\"\n\n        currentTest.preventEnding = true\n\n        endCurrentTest = (err) ->\n            callback? err\n            currentTest.preventEnding = false\n            currentTest.onEnd err\n\n        unless screenshotInitialized\n            screenshotInitialized = true\n            screenshot.initialize (err) ->\n                if err\n                    endCurrentTest err\n                else\n                    exports.takeScreenshot opts, callback\n            return\n\n        screenshot.take opts, endCurrentTest\n        return\n\n    runTests = ->\n        [mainScope] = scopes\n        logger.onTestsStart()\n        mainScope.run ->\n            logger.onTestsEnd()\n            onTestsEnd\n                status: if stack.errors.length is 0 then 'success' else 'error'\n                testsAmount: stack.testsAmount\n                errors: stack.errors\n\n    onTestsEnd = (result) ->\n        code = if result.status is 'success' then 0 else 1\n        if process.env.NEFT_NODE\n            # give logs some time to be printed int stdout\n            setTimeout ->\n                process.exit code\n            , 1000\n\n    runAutomatically = do ->\n        val = process?.env.RUN_TESTS\n        if typeof val is 'string'\n            val = try JSON.parse val\n        val ?= true\n        val\n\n    setImmediate ->\n        if runAutomatically\n            runTests()\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"f76b48d50252daf5ade4f65f833da46dcd8046d2","subject":"Fix the message type in the debug dataset matches","message":"Fix the message type in the debug dataset matches\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/debug.litcoffee","new_file":"src\/coffee\/debug.litcoffee","new_contents":"Debug Routines\n==============\n\nOccasionally, software has bugs. It's also often quite convenient\nto be able to fix those bugs.\n\n    window.DEBUG = {}\n\nDebug Data Collections\n----------------------\n\nThis is a collection of debug data, for great debugging, and debug.\n\n    window.DEBUG.loadDebugData = ->\n        dateBase = do DayBase\n        WS.message.push\n            type: 'mode'\n            mode: 'judge'\n        WS.message.push\n            type: 'override'\n            override: null\n        WS.message.push\n            type: 'teams'\n            teams:\n                aaa:\n                    college: 'College A'\n                    name: 'Team A'\n                    notes: 'Bees'\n                    present: yes\n                bbb:\n                    college: 'College B'\n                    name: 'Team B'\n                    notes: ''\n                    present: yes\n                ccc:\n                    college: 'College C'\n                    name: 'Team C Alpha'\n                    notes: ''\n                    present: no\n                ccc2:\n                    college: 'College C'\n                    name: 'Team C Beta'\n                    notes: ''\n                    present: yes\n                ddd:\n                    college: 'College D'\n                    name: 'Team D'\n                    notes: 'eyes'\n                    present: yes\n        WS.message.push\n            type: 'day'\n            schedule: [\n                {key: 'w', start: dateBase + 3600*9, displayName: 'Doors Open', association: 0}\n                {key: 'x', start: dateBase + 3600*9 + 1800, displayName: 'Tinker Time', association: 0}\n                {key: 'y', start: dateBase + 3600*11, displayName: 'Briefing', association: 3}\n                {key: 'z', start: dateBase + 3600*12, displayName: 'League', association: 1}\n            ]\n\n        WS.message.push\n            type: 'matches'\n            schedule: [\n                {key: 'w', start: dateBase + 3600*12 + 3*60, teams: ['aaa', 'bbb', 'ccc', 'ddd'], scores: [4, 2.5, 2.5, 0], knockout_stage: null}\n                {key: 'x', start: dateBase + 3600*12 + 8*60, teams: ['bbb', 'aaa', 'ddd', 'ccc2'], scores: null, knockout_stage: null}\n                {key: 'y', start: dateBase + 3600*12 + 13*60, teams: ['ccc2', 'aaa', 'ddd', 'bbb'], scores: null, knockout_stage: null}\n                {key: 'z', start: dateBase + 3600*12 + 18*60, teams: ['aaa', 'bbb', 'ccc2', 'ddd'], scores: null, knockout_stage: null}\n            ]\n\n","old_contents":"Debug Routines\n==============\n\nOccasionally, software has bugs. It's also often quite convenient\nto be able to fix those bugs.\n\n    window.DEBUG = {}\n\nDebug Data Collections\n----------------------\n\nThis is a collection of debug data, for great debugging, and debug.\n\n    window.DEBUG.loadDebugData = ->\n        dateBase = do DayBase\n        WS.message.push\n            type: 'mode'\n            mode: 'judge'\n        WS.message.push\n            type: 'override'\n            override: null\n        WS.message.push\n            type: 'teams'\n            teams:\n                aaa:\n                    college: 'College A'\n                    name: 'Team A'\n                    notes: 'Bees'\n                    present: yes\n                bbb:\n                    college: 'College B'\n                    name: 'Team B'\n                    notes: ''\n                    present: yes\n                ccc:\n                    college: 'College C'\n                    name: 'Team C Alpha'\n                    notes: ''\n                    present: no\n                ccc2:\n                    college: 'College C'\n                    name: 'Team C Beta'\n                    notes: ''\n                    present: yes\n                ddd:\n                    college: 'College D'\n                    name: 'Team D'\n                    notes: 'eyes'\n                    present: yes\n        WS.message.push\n            type: 'day'\n            schedule: [\n                {key: 'w', start: dateBase + 3600*9, displayName: 'Doors Open', association: 0}\n                {key: 'x', start: dateBase + 3600*9 + 1800, displayName: 'Tinker Time', association: 0}\n                {key: 'y', start: dateBase + 3600*11, displayName: 'Briefing', association: 3}\n                {key: 'z', start: dateBase + 3600*12, displayName: 'League', association: 1}\n            ]\n\n        WS.message.push\n            type: 'match'\n            schedule: [\n                {key: 'w', start: dateBase + 3600*12 + 3*60, teams: ['aaa', 'bbb', 'ccc', 'ddd'], scores: [4, 2.5, 2.5, 0], knockout_stage: null}\n                {key: 'x', start: dateBase + 3600*12 + 8*60, teams: ['bbb', 'aaa', 'ddd', 'ccc2'], scores: null, knockout_stage: null}\n                {key: 'y', start: dateBase + 3600*12 + 13*60, teams: ['ccc2', 'aaa', 'ddd', 'bbb'], scores: null, knockout_stage: null}\n                {key: 'z', start: dateBase + 3600*12 + 18*60, teams: ['aaa', 'bbb', 'ccc2', 'ddd'], scores: null, knockout_stage: null}\n            ]\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0c4b1631ecc24f04a5872232fe67c87b9eafc8da","subject":"never cache login page, csrf","message":"never cache login page, csrf\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/lib\/routes\/index.litcoffee","new_file":"src\/lib\/routes\/index.litcoffee","new_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        fs = require('fs')\n        res.render 'index', {\n          title: 'Welcome',\n          extra_head_css: fs.readFileSync('views\/extra\/nivo.css'),\n          extra_foot_js: fs.readFileSync('views\/extra\/nivo.js')\n        }\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        require('..\/page').getPage(app.models.page, req.params.name, (page) ->\n          if page\n            res.render 'page', page\n          else\n            console.error 'page '+req.params.name+' not found in db, showing static'\n            res.render 'page\/'+req.params.name\n        )\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n\n      app.post '\/page\/_post', (req, res) ->\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          body: 'Hello world, from inside the DB'\n        require('..\/page').setPage(app.models.page, sample, (page) ->\n          if page\n            res.render 'page', page\n          else\n            page =\n              name: 'error'\n              title: 'Error'\n              body: 'There was an error posting your page, please try again.'\n            res.render 'page', page\n        )\n          \n## GET \/login\n\nRender static pages at \/view\/login\/index.html\n\nAnd never cache the login page, it breaks csrf\n\n      app.get '\/login', (req, res) ->\n        res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0')\n        res.render 'login'\n\n          \n## POST \/login\/_post\n\nDo Login action, and redirect as appropriate.\n\n      app.post '\/login\/_post', (req, res) ->\n        require('..\/login').checkUser req.body.username, req.body.password, (user, securityLevel) ->\n          console.info 'login callback = '+user+', '+securityLevel\n          req.session.user = user\n          req.session.securityLevel = securityLevel\n          res.cookie 'nocache', '1'\n          if securityLevel\n            res.redirect '\/'\n          else\n            res.redirect '\/login'\n\n## GET \/login\/clear\n\nLogout from the website by clearing the session\n\n      app.get '\/login\/clear', (req, res) ->\n        req.session.destroy (err) ->\n          res.clearCookie 'nocache'\n          res.redirect '\/login'\n\n## GET \/directory\n \nDownload PDF to browser\n\n      app.get '\/directory', (req, res) ->\n        if req.session.securityLevel\n          request = require 'request'\n          request 'https:\/\/parkrow.nfshost.com\/directory\/api\/1\/directory\/dump\/?uid=prweb1&key=ab8QEV4mQHZ79T5x', (err, cbres, data) ->\n            if err or cbres.statusCode != 200\n              res.render 500, 'Error retrieving full directory'\n            else\n              dir = JSON.parse data\n              page = \n                name: 'Full Directory'\n                title: 'Full Directory'\n                directory: dir.data\n                helpers:\n                  month: (num) ->\n                    return [null, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'][num]\n              res.render 'directory', page\n        else\n          res.redirect '\/login'\n\n\n## GET \/directory\/directory.pdf\n \nDownload PDF to browser\n\n      app.get '\/directory\/directory.pdf', (req, res) ->\n        if req.session.securityLevel\n          res.download 'protected\/directory.pdf'\n        else\n          res.redirect '\/login'\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        fs = require('fs')\n        res.render 'index', {\n          title: 'Welcome',\n          extra_head_css: fs.readFileSync('views\/extra\/nivo.css'),\n          extra_foot_js: fs.readFileSync('views\/extra\/nivo.js')\n        }\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        require('..\/page').getPage(app.models.page, req.params.name, (page) ->\n          if page\n            res.render 'page', page\n          else\n            console.error 'page '+req.params.name+' not found in db, showing static'\n            res.render 'page\/'+req.params.name\n        )\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n\n      app.post '\/page\/_post', (req, res) ->\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          body: 'Hello world, from inside the DB'\n        require('..\/page').setPage(app.models.page, sample, (page) ->\n          if page\n            res.render 'page', page\n          else\n            page =\n              name: 'error'\n              title: 'Error'\n              body: 'There was an error posting your page, please try again.'\n            res.render 'page', page\n        )\n          \n## GET \/login\n\nRender static pages at \/view\/login\/index.html\n\n      app.get '\/login', (req, res) ->\n        res.render 'login'\n\n          \n## POST \/login\/_post\n\nDo Login action, and redirect as appropriate.\n\n      app.post '\/login\/_post', (req, res) ->\n        require('..\/login').checkUser req.body.username, req.body.password, (user, securityLevel) ->\n          console.info 'login callback = '+user+', '+securityLevel\n          req.session.user = user\n          req.session.securityLevel = securityLevel\n          res.cookie 'nocache', '1'\n          if securityLevel\n            res.redirect '\/'\n          else\n            res.redirect '\/login'\n\n## GET \/login\/clear\n\nLogout from the website by clearing the session\n\n      app.get '\/login\/clear', (req, res) ->\n        req.session.destroy (err) ->\n          res.clearCookie 'nocache'\n          res.redirect '\/login'\n\n## GET \/directory\n \nDownload PDF to browser\n\n      app.get '\/directory', (req, res) ->\n        if req.session.securityLevel\n          request = require 'request'\n          request 'https:\/\/parkrow.nfshost.com\/directory\/api\/1\/directory\/dump\/?uid=prweb1&key=ab8QEV4mQHZ79T5x', (err, cbres, data) ->\n            if err or cbres.statusCode != 200\n              res.render 500, 'Error retrieving full directory'\n            else\n              dir = JSON.parse data\n              page = \n                name: 'Full Directory'\n                title: 'Full Directory'\n                directory: dir.data\n                helpers:\n                  month: (num) ->\n                    return [null, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'][num]\n              res.render 'directory', page\n        else\n          res.redirect '\/login'\n\n\n## GET \/directory\/directory.pdf\n \nDownload PDF to browser\n\n      app.get '\/directory\/directory.pdf', (req, res) ->\n        if req.session.securityLevel\n          res.download 'protected\/directory.pdf'\n        else\n          res.redirect '\/login'\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"d9243c654de04e1e37a7a4998311d68f415b3379","subject":"Fix the display of match timings","message":"Fix the display of match timings\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/managers\/match-timing.litcoffee","new_file":"src\/coffee\/managers\/match-timing.litcoffee","new_contents":"Match Timing Manager\n====================\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe require, for displaying match timing, only the current match and\nthe clock.\n\n        inputStream = Bacon.combineTemplate\n            clock: Clock\n            currentMatch: CurrentMatch\n\nFormatting\n----------\n\nMatch timing format differs based on four match modes.\n\nWe treat them here separately, although publicised through one\nfunction -- *formatMatchTime* -- which takes as its argument the\nnumber of seconds from the scheduled start time to display (generally\nthis will be *currentTime* - *startTime*) and returns the formatted\nstring.\n\n        formatMatchTime = (secondsSinceStart) ->\n\nWe floor the seconds since start for sensible display.\n\n            secondsSinceStart = Math.floor secondsSinceStart\n\nThe first match mode is that of the swap time and initial preparation\nfor the match, where we simply display the string \"upcoming\".\n\n            return 'upcoming' if secondsSinceStart < -30\n\nThe second mode is that for the 30 seconds before the start of the\nmatch, where we display a countdown timer.\n\n            return \"#{-secondsSinceStart}s\" if secondsSinceStart < 0\n\nThe third mode is that of the main sequence of the match, where we\ndisplay the time as M:SS. To do this, we exploit the *FormatDoubleDigit*\nfunction from the *clock* module.\n\n            if secondsSinceStart <= 180\n                return Math.floor(secondsSinceStart \/ 60) +\n                       ':' +\n                       FormatDoubleDigit(secondsSinceStart % 60)\n\nFinally, for the fourth mode we simply display the end time of the match.\n\n            return '3:00'\n\nDisplay\n-------\n\nWe pre-select the DOM nodes in which we are interested - all those\nwith the *next-match-time* class.\n\n        matchTimeNodes = $ '.match-timer'\n\nWe bind to our input stream.\n\n        inputStream.onValue (state) ->\n\nThere are two cases, which we handle separately - with and without\nthe existence of a current match.\n\nWe first handle the case with the current match.\n\n            if state.currentMatch?\n                matchTimeNodes.text formatMatchTime(state.clock.valueOf()*0.001-\n                                                    state.currentMatch.start)\n\nWe then handle the case without a current match.\n\n            else\n                matchTimeNodes.text 'no match'\n\n","old_contents":"Match Timing Manager\n====================\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe require, for displaying match timing, only the current match and\nthe clock.\n\n        inputStream = Bacon.combineTemplate\n            clock: Clock\n            currentMatch: CurrentMatch\n\nFormatting\n----------\n\nMatch timing format differs based on four match modes.\n\nWe treat them here separately, although publicised through one\nfunction -- *formatMatchTime* -- which takes as its argument the\nnumber of seconds from the scheduled start time to display (generally\nthis will be *currentTime* - *startTime*) and returns the formatted\nstring.\n\n        formatMatchTime = (secondsSinceStart) ->\n\nThe first match mode is that of the swap time and initial preparation\nfor the match, where we simply display the string \"upcoming\".\n\n            return 'upcoming' if secondsSinceStart < -30\n\nThe second mode is that for the 30 seconds before the start of the\nmatch, where we display a countdown timer.\n\n            return \"#{-secondsSinceStart}s\" if secondsSinceStart < 0\n\nThe third mode is that of the main sequence of the match, where we\ndisplay the time as M:SS. To do this, we exploit the *FormatDoubleDigit*\nfunction from the *clock* module.\n\n            if secondsSinceStart <= 180\n                return Math.floor(secondsSinceStart \/ 60) +\n                       ':' +\n                       FormatDoubleDigit(secondsSinceStart % 60)\n\nFinally, for the fourth mode we simply display the end time of the match.\n\n            return '3:00'\n\nDisplay\n-------\n\nWe pre-select the DOM nodes in which we are interested - all those\nwith the *next-match-time* class.\n\n        matchTimeNodes = $ '.match-timer'\n\nWe bind to our input stream.\n\n        inputStream.onValue (state) ->\n\nThere are two cases, which we handle separately - with and without\nthe existence of a current match.\n\nWe first handle the case with the current match.\n\n            if state.currentMatch?\n                matchTimeNodes.text formatMatchTime(state.clock.valueOf()*0.001-\n                                                    state.currentMatch.start)\n\nWe then handle the case without a current match.\n\n            else\n                matchTimeNodes.text 'no match'\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"025f300bf3427fc11e9e7c81c4eeaad1a346d745","subject":"Using absolute path for modules to prevent issues with .\/lib\/filename","message":"Using absolute path for modules to prevent issues with .\/lib\/filename\n","repos":"WillemDeGroef\/nodesentry","old_file":"src\/module.litcoffee","new_file":"src\/module.litcoffee","new_contents":"    vm = require \"vm\"\n    path = require \"path\"\n    _ = require \"underscore\"\n    Membrane = require \".\/membrane\"\n\n    class WrappedModule\n\n        constructor: (@libName, @modulePaths, @policyObj) ->\n            @modModule = (require \"module\")\n            @fileName = @modModule._findPath @libName, @modulePaths\n            @requestLib = @fileName || @libName\n            @builtIn = @requestLib.indexOf(\".js\") == -1\n            @absolute = @libName.indexOf(\".\/\") == -1\n            if @fileName != false\n                @pathName = path.dirname @fileName\n            else\n                @pathName = \"\"\n\n        load: (requireFunc = @membranedRequire) ->\n            throw new Error \"`require` must be a function\" if typeof requireFunc != \"function\"\n            module.paths = [@pathName].concat(@modModule._nodeModulePaths(@pathName))\n\n            if @builtIn\n                r = require @requestLib\n            else\n                wrappedMod = new @modModule(@libName, this)\n                wrappedMod.require = requireFunc\n                if @absolute\n                    wrappedMod.load @requestLib\n                else\n                    console.log \"Loading the fileName instead\"\n                    wrappedMod.load @fileName\n                r = wrappedMod.exports\n\n\nReturn a membraned variant of the public API interface.\n\n            return r if not @policyObj\n            return new Membrane(r, @policyObj, @requestLib) if (typeof r) == \"function\"\n            return @wrapObjectWithMembrane(@requestLib.replace(\".js\",\"\"), r)\n\n\n        membranedRequire: (libName) =>\n            mod = new WrappedModule libName, module.paths, @policyObj\n            \n            return require(libName) if mod.builtIn or not @policyObj?.wrapWithMembrane?(libName)\n\nLets load the new `Module` for the requested library.\n\n            return mod.load()\n\nThe last step is to create a wrapper function that will carefully wrap each\nexported API call within a membrane.\n\n            @wrapObjectWithMembrane(libName, libexports)\n\n        wrapObjectWithMembrane: (libName, obj) ->\n            _.object(_.map obj, @buildMembraneWrapper libName)\n\n        buildMembraneWrapper: (libName) =>\n            (propObj, propName) => [propName, new Membrane(propObj, @policyObj, \"#{libName}.#{propName}\")]\n\n    module.exports = WrappedModule\n","old_contents":"    vm = require \"vm\"\n    path = require \"path\"\n    _ = require \"underscore\"\n    Membrane = require \".\/membrane\"\n\n    class WrappedModule\n\n        constructor: (@libName, @modulePaths, @policyObj) ->\n            @modModule = (require \"module\")\n            @fileName = @modModule._findPath @libName, @modulePaths\n            @requestLib = @fileName || @libName\n            @builtIn = @requestLib.indexOf(\".js\") == -1\n            if @fileName != false\n                @pathName = path.dirname @fileName\n            else\n                @pathName = \"\"\n\n        load: (requireFunc = @membranedRequire) ->\n            throw new Error \"`require` must be a function\" if typeof requireFunc != \"function\"\n            module.paths = [@pathName].concat(@modModule._nodeModulePaths(@pathName))\n\n            if @builtIn\n                r = require @requestLib\n            else\n                wrappedMod = new @modModule(@libName, this)\n                wrappedMod.require = requireFunc\n                wrappedMod.load @requestLib\n                r = wrappedMod.exports\n\n\nReturn a membraned variant of the public API interface.\n\n            return r if not @policyObj\n            return new Membrane(r, @policyObj, @requestLib) if (typeof r) == \"function\"\n            return @wrapObjectWithMembrane(@requestLib.replace(\".js\",\"\"), r)\n\n\n        membranedRequire: (libName) =>\n            mod = new WrappedModule libName, module.paths, @policyObj\n            \n            return require(libName) if mod.builtIn or not @policyObj?.wrapWithMembrane?(libName)\n\nLets load the new `Module` for the requested library.\n\n            return mod.load()\n\nThe last step is to create a wrapper function that will carefully wrap each\nexported API call within a membrane.\n\n            @wrapObjectWithMembrane(libName, libexports)\n\n        wrapObjectWithMembrane: (libName, obj) ->\n            _.object(_.map obj, @buildMembraneWrapper libName)\n\n        buildMembraneWrapper: (libName) =>\n            (propObj, propName) => [propName, new Membrane(propObj, @policyObj, \"#{libName}.#{propName}\")]\n\n    module.exports = WrappedModule\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"46018864f03a5a91927c1029919181629409f9e9","subject":"Added a function to calculate the reflection of a vector in a surface normal.","message":"Added a function to calculate the reflection of a vector in a surface\nnormal.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/vector.litcoffee","new_file":"src\/vector.litcoffee","new_contents":"# vector\n\nVectors are arrays of 3 numbers; X, Y and Z.\nX runs from left to right.\nY runs from bottom to top.\nZ runs from back to front.\n\nWhen given as outputs, vectors can safely be empty arrays.\n\n    misc = require \".\/misc.litcoffee\"\n\n## sum\n\n- A vector.\n\nReturns the sum of the components.\n\n    sum = (vector) ->\n        total = 0\n        (total += component) for component in vector\n        total\n        \n    unary = (callback) -> (input, output) ->\n        (output[index] = callback value) for value, index in input\n        return\n        \n## copy\n\n- An input vector.\n- An output vector.\n\nCopies every component from the input to the output.\n        \n    copy = unary (component) -> component\n    \n## copy\n\n- An input vector.\n- An output vector.\n\nWrites the negative of every component of the input to the output.\n    \n    negate = unary (component) -> -component\n    \n    binary = (callback) ->\n        vector: (a, b, output) ->\n            (output[index] = callback valueA, b[index]) for valueA, index in a\n            return\n\n        scalarBy: (a, b, output) ->\n            (output[index] = callback a, valueB) for valueB, index in b\n            return\n            \n        byScalar: (a, b, output) ->\n            (output[index] = callback valueA, b) for valueA, index in a\n            return\n    \n## add.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nAdds each component in the input vectors and writes the results to the output \nvector.\n\n## add.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nAdds the number to each component in the vector and and writes the results to\nthe output vector.\n\n## add.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nAdds each component in the vector to the number and writes the result to\nthe output vector.\n    \n    add = binary (a, b) -> a + b\n    \n## subtract.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nSubtracts each compenent in the second input vector from the equivalent in the\nfirst input vector and writes the results to the output vector.\n\n## subtract.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nSubtracts each component in the vector from the number and writes the results to \nthe output vector.\n\n## subtract.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nSubtracts the number from each component in the vector and writes the results to \nthe output vector.\n    \n    subtract = binary (a, b) -> a - b\n    \n## multiply.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nMultiplies each compenent in the second input vector with the equivalent in the\nfirst input vector and writes the results to the output vector.\n\n## multiply.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nMultiplies the number by each component in the vector and writes the results to \nthe output vector.\n\n## multiply.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nMultiplies each component in the vector by the number and writes the results to \nthe output vector.\n    \n    multiply = binary (a, b) -> a * b\n    \n## divide.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nDivides each compenent in the first input vector by the equivalent in the second\ninput vector and writes the results to the output vector.\n\n## divide.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nDivides the number by each component in the vector and writes the results to the\noutput vector.\n\n## divide.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nDivides each component in the vector by the number and writes the results to the\noutput vector.\n    \n    divide = binary (a, b) -> a \/ b\n    \n# dot\n    \n- A vector.\n- A vector.\n\nReturns the dot product of the two vectors.\n\n    tempA = []\n    tempB = []\n    dot = (a, b) -> \n        multiply.vector a, b, tempA\n        sum tempA\n    \n# magnitudeSquared\n\n- A vector.\n\nReturns the square of the magnitude\/length of the vector.\nFaster than \"magnitude\".\n    \n    magnitudeSquared = (v) -> dot v, v\n    \n# magnitude\n\n- A vector.\n\nReturns the magnitude\/length of the vector.\nSlower than \"magnitudeSquared\".\n    \n    magnitude = (v) -> Math.sqrt magnitudeSquared v\n\n# distanceSquared\n\n- A vector.\n- A vector.\n\nReturns the square of the distance between the two vectors.\nFaster than \"distance\".\n    \n    distanceSquared = (a, b) ->\n        subtract.vector a, b, tempB\n        magnitudeSquared tempB\n\n# distance\n\n- A vector.\n- A vector.\n\nReturns the distance between the two vectors.\nSlower than \"distanceSquared\".\n\n    distance = (a, b) ->\n        subtract.vector a, b, tempB\n        magnitude tempB\n        \n# normalize\n\n- An input vector.\n- An output vector.\n\nWrites the normalized\/unit length version of the input vector to the output.\nReturns the magnitude\/length of the original vector.\n\n    normalize = (input, output) ->\n        len = magnitude input\n        divide.byScalar input, len, output\n        len\n     \n# cross\n\n- An input vector.\n- An input vector.\n- An output vector.\n\nWrites the cross product of the two input vectors to the output vector.\n     \n    cross = (a, b, output) ->\n        copy a, tempA\n        copy b, tempB\n        output[0] = tempA[1] * tempB[2] - tempB[1] * tempA[2]\n        output[1] = tempA[2] * tempB[0] - tempB[2] * tempA[0]\n        output[2] = tempA[0] * tempB[1] - tempB[0] * tempA[1]\n        return\n        \n# interpolate\n\n- An input vector to interpolate from.\n- An input vector to interpolate to.\n- A number, where \"0\" is \"from\" and \"1\" is \"to\".\n- An output vector.\n\nWrites the linear interpolation between, or linear extrapolation beyond, the\ntwo input vectors to the output.\n\n    interpolate = (from, to, alpha, output) ->\n        for fromValue, index in from\n            toValue = to[index]\n            output[index] = misc.interpolate fromValue, toValue, alpha\n        return\n        \n# reflect\n\n- An input vector.\n- An input normal vector.\n- An output vector.\n\nWrites the reflection of the input vector against the surface normal specified\nto the output vector.\n        \n    reflectTemp = []\n    reflect = (input, normal, output) ->\n        coefficient = dot input, normal\n        multiply.byScalar normal, (coefficient * 2), reflectTemp\n        subtract.vector input, reflectTemp, output\n        \n    module.exports = { \n            sum, copy, negate\n            add, subtract, multiply, divide\n            dot, cross\n            magnitudeSquared, magnitude\n            distanceSquared, distance\n            normalize\n            interpolate\n            reflect\n        }","old_contents":"# vector\n\nVectors are arrays of 3 numbers; X, Y and Z.\nX runs from left to right.\nY runs from bottom to top.\nZ runs from back to front.\n\nWhen given as outputs, vectors can safely be empty arrays.\n\n    misc = require \".\/misc.litcoffee\"\n\n## sum\n\n- A vector.\n\nReturns the sum of the components.\n\n    sum = (vector) ->\n        total = 0\n        (total += component) for component in vector\n        total\n        \n    unary = (callback) -> (input, output) ->\n        (output[index] = callback value) for value, index in input\n        return\n        \n## copy\n\n- An input vector.\n- An output vector.\n\nCopies every component from the input to the output.\n        \n    copy = unary (component) -> component\n    \n## copy\n\n- An input vector.\n- An output vector.\n\nWrites the negative of every component of the input to the output.\n    \n    negate = unary (component) -> -component\n    \n    binary = (callback) ->\n        vector: (a, b, output) ->\n            (output[index] = callback valueA, b[index]) for valueA, index in a\n            return\n\n        scalarBy: (a, b, output) ->\n            (output[index] = callback a, valueB) for valueB, index in b\n            return\n            \n        byScalar: (a, b, output) ->\n            (output[index] = callback valueA, b) for valueA, index in a\n            return\n    \n## add.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nAdds each component in the input vectors and writes the results to the output \nvector.\n\n## add.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nAdds the number to each component in the vector and and writes the results to\nthe output vector.\n\n## add.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nAdds each component in the vector to the number and writes the result to\nthe output vector.\n    \n    add = binary (a, b) -> a + b\n    \n## subtract.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nSubtracts each compenent in the second input vector from the equivalent in the\nfirst input vector and writes the results to the output vector.\n\n## subtract.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nSubtracts each component in the vector from the number and writes the results to \nthe output vector.\n\n## subtract.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nSubtracts the number from each component in the vector and writes the results to \nthe output vector.\n    \n    subtract = binary (a, b) -> a - b\n    \n## multiply.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nMultiplies each compenent in the second input vector with the equivalent in the\nfirst input vector and writes the results to the output vector.\n\n## multiply.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nMultiplies the number by each component in the vector and writes the results to \nthe output vector.\n\n## multiply.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nMultiplies each component in the vector by the number and writes the results to \nthe output vector.\n    \n    multiply = binary (a, b) -> a * b\n    \n## divide.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nDivides each compenent in the first input vector by the equivalent in the second\ninput vector and writes the results to the output vector.\n\n## divide.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nDivides the number by each component in the vector and writes the results to the\noutput vector.\n\n## divide.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nDivides each component in the vector by the number and writes the results to the\noutput vector.\n    \n    divide = binary (a, b) -> a \/ b\n    \n# dot\n    \n- A vector.\n- A vector.\n\nReturns the dot product of the two vectors.\n\n    tempA = []\n    tempB = []\n    dot = (a, b) -> \n        multiply.vector a, b, tempA\n        sum tempA\n    \n# magnitudeSquared\n\n- A vector.\n\nReturns the square of the magnitude\/length of the vector.\nFaster than \"magnitude\".\n    \n    magnitudeSquared = (v) -> dot v, v\n    \n# magnitude\n\n- A vector.\n\nReturns the magnitude\/length of the vector.\nSlower than \"magnitudeSquared\".\n    \n    magnitude = (v) -> Math.sqrt magnitudeSquared v\n\n# distanceSquared\n\n- A vector.\n- A vector.\n\nReturns the square of the distance between the two vectors.\nFaster than \"distance\".\n    \n    distanceSquared = (a, b) ->\n        subtract.vector a, b, tempB\n        magnitudeSquared tempB\n\n# distance\n\n- A vector.\n- A vector.\n\nReturns the distance between the two vectors.\nSlower than \"distanceSquared\".\n\n    distance = (a, b) ->\n        subtract.vector a, b, tempB\n        magnitude tempB\n        \n# normalize\n\n- An input vector.\n- An output vector.\n\nWrites the normalized\/unit length version of the input vector to the output.\nReturns the magnitude\/length of the original vector.\n\n    normalize = (input, output) ->\n        len = magnitude input\n        divide.byScalar input, len, output\n        len\n     \n# cross\n\n- An input vector.\n- An input vector.\n- An output vector.\n\nWrites the cross product of the two input vectors to the output vector.\n     \n    cross = (a, b, output) ->\n        copy a, tempA\n        copy b, tempB\n        output[0] = tempA[1] * tempB[2] - tempB[1] * tempA[2]\n        output[1] = tempA[2] * tempB[0] - tempB[2] * tempA[0]\n        output[2] = tempA[0] * tempB[1] - tempB[0] * tempA[1]\n        return\n        \n# interpolate\n\n- An input vector to interpolate from.\n- An input vector to interpolate to.\n- A number, where \"0\" is \"from\" and \"1\" is \"to\".\n- An output vector.\n\nWrites the linear interpolation between, or linear extrapolation beyond, the\ntwo input vectors to the output.\n\n    interpolate = (from, to, alpha, output) ->\n        for fromValue, index in from\n            toValue = to[index]\n            output[index] = misc.interpolate fromValue, toValue, alpha\n        return\n        \n    module.exports = { \n            sum, copy, negate\n            add, subtract, multiply, divide\n            dot, cross\n            magnitudeSquared, magnitude\n            distanceSquared, distance\n            normalize\n            interpolate\n        }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e955a325580845842b3c2cb30c9fffd5b116d972","subject":"more rest storage docs","message":"more rest storage docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/12b_rest_storage.litcoffee","new_file":"docs\/12b_rest_storage.litcoffee","new_contents":"# \/api\/App Components\/Batman.StorageAdapter\/Batman.RestStorage\n\n`Batman.RestStorage` connects `Batman.Model`s to a web server via [HTTP REST](https:\/\/en.wikipedia.org\/wiki\/Representational_state_transfer). `Batman.Request` is used to send AJAX requests.\n\nUse `Batman.RestStorage` by passing it to `@persist` in a model definition:\n\n```coffeescript\nclass MyApp.MyModel extends Batman.Model\n  @persist Batman.RestStorage\n```\n\n`Batman.RestStorage` requires a platform implementation library for `Batman.Request`.\n\n## ::.serializeAsForm[= true] : Boolean\n\nBy default, `Batman.RestStorage` sends data as `'application\/x-www-form-urlencoded'`. To send as `'application\/json'`, pass `serializeAsForm: false` to `@persist`:\n\n```coffeescript\nclass MyApp.MyModel extends Batman.Model\n  @persist Batman.RestStorage, serializeAsForm: false\n```\n\n## ::urlForCollection(model, env) : String\n\nReturns a collection URL for `model` by checking:\n\n- `env.options.collectionUrl`\n- `model.url` (can be defined as a string or function, see \"Model Mixin\" below)\n- `model.storageKey`\n- `model.resourceName`\n\n## ::urlForRecord(record, env) : String\n\nReturns a URL for `record` by checking:\n\n- `env.options.recordUrl`\n- `record.url` (can be defined as a string or function, see \"Model Mixin\" below)\n- `urlForCollection` plus `\/:id`\n\n## Model Mixin\n\nThese functions are added to models that are persisted with `Batman.RestStorage`.\n\n## @urlNestsUnder(nestings...)\n\nNest the given model under one or more other resources. A `nesting` can be:\n\n- a string resource name\n- an array of resource names\n\nA resource name normally corresponds to a model attribute with the same name suffixed with `_id`. If it is an array, it defines a deeply nested resource.\n\nThe order of the nestings define the precedence, which means the __first__ nesting where all necessary `_id` attributes are present is used to produce the url. If none of nestings can be satisfied, it falls back to the default url.\n\n    test 'defining url nesting', ->\n      class Product extends Batman.Model\n        @persist Batman.RestStorage\n        @urlNestsUnder ['shop', 'manufacturer'], 'order'\n\n      equal Product.url(data: shop_id: 1, manufacturer_id: 2), 'shops\/1\/manufacturers\/2\/products'\n      equal (new Product(shop_id: 1, manufacturer_id: 2, id: 3)).url(), 'shops\/1\/manufacturers\/2\/products\/3'\n      equal Product.url(data: shop_id: 1, order_id: 2), 'orders\/2\/products'\n      equal (new Product(shop_id: 1, order_id: 2, id: 3)).url(), 'orders\/2\/products\/3'\n      equal Product.url(data: shop_id: 1), 'products'\n      equal (new Product(shop_id: 1, id: 2)).url(), 'products\/2'\n\n## @url() : String\n\nReturns the URL for model.\n\n## ::url() : String\n\nReturns the URL for the record.\n","old_contents":"# \/api\/App Components\/Batman.StorageAdapter\/Batman.RestStorage\n\n`Batman.RestStorage` connects `Batman.Model`s to a web server via [HTTP REST](https:\/\/en.wikipedia.org\/wiki\/Representational_state_transfer). `Batman.Request` is used to send AJAX requests.\n\nUse `Batman.RestStorage` by passing it to `@persist` in a model definition:\n\n```coffeescript\nclass MyApp.MyModel extends Batman.Model\n  @persist Batman.RestStorage\n```\n\n`Batman.RestStorage` requires a platform implementation library for `Batman.Request`.\n\n\n## Model Mixin\n\nThese functions are added to models that are persisted with `Batman.RestStorage`.\n\n## @urlNestsUnder(nestings...)\n\nNest the given model under one or more other resources. A `nesting` can be:\n\n- a string resource name\n- an array of resource names\n\nA resource name normally corresponds to a model attribute with the same name suffixed with `_id`. If it is an array, it defines a deeply nested resource.\n\nThe order of the nestings define the precedence, which means the __first__ nesting where all necessary `_id` attributes are present is used to produce the url. If none of nestings can be satisfied, it falls back to the default url.\n\n    test 'defining url nesting', ->\n      class Product extends Batman.Model\n        @persist Batman.RestStorage\n        @urlNestsUnder ['shop', 'manufacturer'], 'order'\n\n      equal Product.url(data: shop_id: 1, manufacturer_id: 2), 'shops\/1\/manufacturers\/2\/products'\n      equal (new Product(shop_id: 1, manufacturer_id: 2, id: 3)).url(), 'shops\/1\/manufacturers\/2\/products\/3'\n      equal Product.url(data: shop_id: 1, order_id: 2), 'orders\/2\/products'\n      equal (new Product(shop_id: 1, order_id: 2, id: 3)).url(), 'orders\/2\/products\/3'\n      equal Product.url(data: shop_id: 1), 'products'\n      equal (new Product(shop_id: 1, id: 2)).url(), 'products\/2'\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"71a10c5624fb6a8b051f4a687fc271ab05be5104","subject":"Allow to run directly from source file","message":"Allow to run directly from source file\n","repos":"whitetrefoil\/extra-jpg-cleaner","old_file":"src\/cleaner.litcoffee","new_file":"src\/cleaner.litcoffee","new_contents":"This file is the main file of the cleaner.\n\n`\"use strict\";` always first :)\n\n    'use strict'\n\n\nDependencies\n-----\n\nRequire all the dependencies.\n\nFirstly get the arguments from [argv.litcoffee](argv.html)\n\n    yargs = require '.\/argv'\n\nThen there are some external dependencies...\n\n    _ = require 'lodash'\n    colors = require 'colors'\n    fs = require 'fs'\n    path = require 'path'\n    readline = require 'readline'\n    Glob = require('glob').Glob\n\n\nEntry Point\n-----\n\nThe `main()` function of the whole application.\n\nFirstly it will get all the configurations from `yargs`.\n\nIf given a `--help` or `-h`, we will print a help message no matter what else is given.  Besides, if no valid argument is given, we will also print he help message.\n\nI'd like to leave the `argv` open.\nIt will give convenience if who want to require this module in his \/ her code instead of call it in CLI.\nIt will also give myself convenience when writing the UT.\n\nThe priority of each arguments is:\n--help > --list > --delete > --rename\n\nAnd if nothing is given or any invalid arguments exists,\nit will also print the help message.\n\n    main = (argv) ->\n      configs = getConfigs(argv)\n      [ isConfigsValid, messages ] = checkIfValid(configs)\n\n      if isConfigsValid\n        messages.forEach (msg) -> console.war msg\n        if configs.help\n            printHelp()\n        else if configs.list\n          find configs.destination, configs.extnames, list\n        else if configs.remove\n          findSync configs.destination, configs.extnames, removeWithConfirmation, configs.verbose\n        else if configs.removeDirectly\n          findSync configs.destination, configs.extnames, removeDirectly, configs.verbose\n        else\n          find configs.destination, configs.extnames, rename, configs.renameTo, configs.verbose\n      else\n        messages.forEach (msg) ->\n          console.error 'Error: '.red.bold + msg\n        console.log ''\n        printHelp()\n\n\nCore Functions\n-----\n\nNow here are the core functions - finding, renaming, deleting, etc.\n\n    find = (dest, extnames, cb, args...) ->\n      pattern = path.normalize(dest) + '\/**\/*.+(jpg|jpeg|jpe)'\n\n      matching = new Glob pattern,\n        nocase: true\n\n      found = 0\n\n      matching.on 'match', (file) ->\n        file = path.normalize file\n        bareFileName = path.join(path.dirname(file), path.basename(file, path.extname(file)))\n        if (extnames.some (extname) -> fs.existsSync(bareFileName + '.' + extname))\n          found += 1\n          cb?.apply null, [ file ].concat(args)\n\n      matching.on 'end', ->\n        console.log \"#{found} files processed\".green\n\n\nAn async find will be good for performance,\nbut when doing deleting we want a sync find then allow a confirmation before finally deleting.\n\n    findSync = (dest, extnames, cb, args...) ->\n      pattern = path.normalize(dest) + '\/**\/*.+(jpg|jpeg|jpe)'\n\n      matching = new Glob pattern,\n        nocase: true\n\n      matching.on 'end', (files) ->\n        targetFiles = files.filter (file) ->\n          file = path.normalize file\n          bareFileName = path.join(path.dirname(file), path.basename(file, path.extname(file)))\n          extnames.some (extname) -> fs.existsSync(bareFileName + '.' + extname)\n        cb?.apply null, [ targetFiles ].concat(args)\n\n\nList a single file.\nUsed for `-l`.\nSince this function will be called by a async find,\nit only need to handle a single file.\n\n    list = (file) ->\n      console.log 'Found: '.green + file\n\n\nJust like `#list()`, it only need to rename a single file.\n\n    rename = (file, renameTo, verbose) ->\n      newName = path.join(path.dirname(file), path.basename(file, path.extname(file))) + '.' + renameTo\n      fs.rename file, newName\n      if verbose\n        console.log 'File: ' + file.yellow + '\\n  To: ' + newName.cyan\n\n\nBut this one is different.\nSince deleting is too dangerous, we want double confirm with the user.\nSo it will be a sync flow.\n\n    removeWithConfirmation = (files, verbose) ->\n      if files.length is 0\n        console.log 'No file to delete, cheers!'.cyan\n      else\n        files.forEach (file) ->\n          console.log file\n        console.log 'The above files ('.yellow + files.length.toString().red.bold + ' at all) will be removed PERMANENTLY!'.yellow\n        console.log 'Please double check and make sure you will never want to see them again!'.yellow\n        console.log 'Input the full path of the first file listed above to continue:'.yellow.bold\n        expected = path.resolve files[0]\n\n        confirmWithUser expected, ->\n          files.forEach (file) ->\n            console.log 'Deleting: '.red + file if verbose\n            fs.unlinkSync file\n          console.log 'Deleted! Hopefully you will never repent'.green.bold\n\nOr maybe the user don't want to do such a complex confirmation...\n\n    removeDirectly = (files, verbose) ->\n      if files.length is 0\n        console.log 'No file to delete, cheers!'.cyan\n      else\n        files.forEach (file) ->\n          console.log file\n        console.log 'The above files ('.yellow + files.length.toString().red.bold + ' at all) will be removed PERMANENTLY!'.yellow\n        console.log 'Are you really sure? (Y\/N)'\n        confirmWithUser 'Y', ->\n          files.forEach (file) ->\n            console.log 'Deleting: '.red + file if verbose\n            fs.unlinkSync file\n          console.log 'Deleted! Hopefully you will never repent'.green.bold\n\n\nHelpers\n-----\n\nA function to print the help message to the users.\n\nBy default `Yargs` will print the help message to `stderr`. I don't like it, so I redirected it to `stdout`.\n\n    printHelp = ->\n      yargs.showHelp(console.log)\n\n\nAsk user for a confirmation.\nUsed before deleting files.\n\n    confirmWithUser = (expected, cb) ->\n      rl = readline.createInterface\n        input: process.stdin\n        output: process.stdout\n\n      rl.setPrompt 'I say: ', 7\n      rl.prompt()\n\n      rl.on 'line', (input) ->\n        try\n          isCorrect = input.trim() is expected\n        catch e\n          isCorrect = false\n\n        if isCorrect\n          rl.close()\n          cb?()\n        else\n          console.log 'Wrong! Try again? Or press Ctrl-C to abort'.yellow\n          rl.prompt()\n\n\n\nInitialize & Configuration\n-----\n\nGet the configurations from `yargs`.\n\n    getConfigs = (argv) ->\n      args = if argv?\n        yargs.parse argv\n      else\n        yargs.argv\n      configs = {}\n\n      configs.extnames = args.x.split(',').map (ext) -> ext.trim().replace(\/^\\.\/, '')\n      delete args.x\n      delete args.extname\n\n      configs.renameTo = args.r.trim().replace(\/^\\.\/, '')\n      delete args.r\n      delete args.rename\n\n      configs.remove = args.d\n      delete args.d\n      delete args.delete\n\n      configs.removeDirectly = args.D\n      delete args.D\n      delete args.deleteDirectly\n      delete args['delete-directly']\n\n      configs.list = args.l\n      delete args.l\n      delete args.list\n\n      configs.verbose = args.v\n      delete args.v\n      delete args.verbose\n\n      configs.help = args.h\n      delete args.h\n      delete args.help\n\n      configs.destinations = if args._? and args._.length > 0 then args._ else [ '' ]\n      delete args._\n\n      configs.destination = configs.destinations[0].toString()\n\n      configs.$0 = args.$0\n      delete args.$0\n\n      configs.unknown = args\n\n      configs\n\nCheck to see if the arguments given are valid.\n\n    checkIfValid = (configs) ->\n      messages = []\n      passed = true\n\n      _.forEach configs.unknown, (value, key) ->\n        messages.push \"Unknown argument #{key}: #{value} is not allowed\"\n        passed = false\n\n      if configs.destinations.length > 1\n        messages.push 'At most 1 destination is allowed'\n        passed = false\n\n      try\n        unless fs.statSync(path.resolve(configs.destination)).isDirectory()\n          messages.push 'Destination is not a directory'\n          passed = false\n      catch e\n        if e.code is 'ENOENT'\n          messages.push 'Destination is not existing'\n          passed = false\n        else\n          throw e\n\n      [ passed, messages ]\n\nPublic API\n-----\n\nNow we can publish the main entry point.\nOr run it directly.\n\n    if require.main is module\n      main()\n    else\n      module.exports = main\n","old_contents":"This file is the main file of the cleaner.\n\n`\"use strict\";` always first :)\n\n    'use strict'\n\n\nDependencies\n-----\n\nRequire all the dependencies.\n\nFirstly get the arguments from [argv.litcoffee](argv.html)\n\n    yargs = require '.\/argv'\n\nThen there are some external dependencies...\n\n    _ = require 'lodash'\n    colors = require 'colors'\n    fs = require 'fs'\n    path = require 'path'\n    readline = require 'readline'\n    Glob = require('glob').Glob\n\n\nEntry Point\n-----\n\nThe `main()` function of the whole application.\n\nFirstly it will get all the configurations from `yargs`.\n\nIf given a `--help` or `-h`, we will print a help message no matter what else is given.  Besides, if no valid argument is given, we will also print he help message.\n\nI'd like to leave the `argv` open.\nIt will give convenience if who want to require this module in his \/ her code instead of call it in CLI.\nIt will also give myself convenience when writing the UT.\n\nThe priority of each arguments is:\n--help > --list > --delete > --rename\n\nAnd if nothing is given or any invalid arguments exists,\nit will also print the help message.\n\n    main = (argv) ->\n      configs = getConfigs(argv)\n      [ isConfigsValid, messages ] = checkIfValid(configs)\n\n      if isConfigsValid\n        messages.forEach (msg) -> console.war msg\n        if configs.help\n            printHelp()\n        else if configs.list\n          find configs.destination, configs.extnames, list\n        else if configs.remove\n          findSync configs.destination, configs.extnames, removeWithConfirmation, configs.verbose\n        else if configs.removeDirectly\n          findSync configs.destination, configs.extnames, removeDirectly, configs.verbose\n        else\n          find configs.destination, configs.extnames, rename, configs.renameTo, configs.verbose\n      else\n        messages.forEach (msg) ->\n          console.error 'Error: '.red.bold + msg\n        console.log ''\n        printHelp()\n\n\nCore Functions\n-----\n\nNow here are the core functions - finding, renaming, deleting, etc.\n\n    find = (dest, extnames, cb, args...) ->\n      pattern = path.normalize(dest) + '\/**\/*.+(jpg|jpeg|jpe)'\n\n      matching = new Glob pattern,\n        nocase: true\n\n      found = 0\n\n      matching.on 'match', (file) ->\n        file = path.normalize file\n        bareFileName = path.join(path.dirname(file), path.basename(file, path.extname(file)))\n        if (extnames.some (extname) -> fs.existsSync(bareFileName + '.' + extname))\n          found += 1\n          cb?.apply null, [ file ].concat(args)\n\n      matching.on 'end', ->\n        console.log \"#{found} files processed\".green\n\n\nAn async find will be good for performance,\nbut when doing deleting we want a sync find then allow a confirmation before finally deleting.\n\n    findSync = (dest, extnames, cb, args...) ->\n      pattern = path.normalize(dest) + '\/**\/*.+(jpg|jpeg|jpe)'\n\n      matching = new Glob pattern,\n        nocase: true\n\n      matching.on 'end', (files) ->\n        targetFiles = files.filter (file) ->\n          file = path.normalize file\n          bareFileName = path.join(path.dirname(file), path.basename(file, path.extname(file)))\n          extnames.some (extname) -> fs.existsSync(bareFileName + '.' + extname)\n        cb?.apply null, [ targetFiles ].concat(args)\n\n\nList a single file.\nUsed for `-l`.\nSince this function will be called by a async find,\nit only need to handle a single file.\n\n    list = (file) ->\n      console.log 'Found: '.green + file\n\n\nJust like `#list()`, it only need to rename a single file.\n\n    rename = (file, renameTo, verbose) ->\n      newName = path.join(path.dirname(file), path.basename(file, path.extname(file))) + '.' + renameTo\n      fs.rename file, newName\n      if verbose\n        console.log 'File: ' + file.yellow + '\\n  To: ' + newName.cyan\n\n\nBut this one is different.\nSince deleting is too dangerous, we want double confirm with the user.\nSo it will be a sync flow.\n\n    removeWithConfirmation = (files, verbose) ->\n      if files.length is 0\n        console.log 'No file to delete, cheers!'.cyan\n      else\n        files.forEach (file) ->\n          console.log file\n        console.log 'The above files ('.yellow + files.length.toString().red.bold + ' at all) will be removed PERMANENTLY!'.yellow\n        console.log 'Please double check and make sure you will never want to see them again!'.yellow\n        console.log 'Input the full path of the first file listed above to continue:'.yellow.bold\n        expected = path.resolve files[0]\n\n        confirmWithUser expected, ->\n          files.forEach (file) ->\n            console.log 'Deleting: '.red + file if verbose\n            fs.unlinkSync file\n          console.log 'Deleted! Hopefully you will never repent'.green.bold\n\nOr maybe the user don't want to do such a complex confirmation...\n\n    removeDirectly = (files, verbose) ->\n      if files.length is 0\n        console.log 'No file to delete, cheers!'.cyan\n      else\n        files.forEach (file) ->\n          console.log file\n        console.log 'The above files ('.yellow + files.length.toString().red.bold + ' at all) will be removed PERMANENTLY!'.yellow\n        console.log 'Are you really sure? (Y\/N)'\n        confirmWithUser 'Y', ->\n          files.forEach (file) ->\n            console.log 'Deleting: '.red + file if verbose\n            fs.unlinkSync file\n          console.log 'Deleted! Hopefully you will never repent'.green.bold\n\n\nHelpers\n-----\n\nA function to print the help message to the users.\n\nBy default `Yargs` will print the help message to `stderr`. I don't like it, so I redirected it to `stdout`.\n\n    printHelp = ->\n      yargs.showHelp(console.log)\n\n\nAsk user for a confirmation.\nUsed before deleting files.\n\n    confirmWithUser = (expected, cb) ->\n      rl = readline.createInterface\n        input: process.stdin\n        output: process.stdout\n\n      rl.setPrompt 'I say: ', 7\n      rl.prompt()\n\n      rl.on 'line', (input) ->\n        try\n          isCorrect = input.trim() is expected\n        catch e\n          isCorrect = false\n\n        if isCorrect\n          rl.close()\n          cb?()\n        else\n          console.log 'Wrong! Try again? Or press Ctrl-C to abort'.yellow\n          rl.prompt()\n\n\n\nInitialize & Configuration\n-----\n\nGet the configurations from `yargs`.\n\n    getConfigs = (argv) ->\n      args = if argv?\n        yargs.parse argv\n      else\n        yargs.argv\n      configs = {}\n\n      configs.extnames = args.x.split(',').map (ext) -> ext.trim().replace(\/^\\.\/, '')\n      delete args.x\n      delete args.extname\n\n      configs.renameTo = args.r.trim().replace(\/^\\.\/, '')\n      delete args.r\n      delete args.rename\n\n      configs.remove = args.d\n      delete args.d\n      delete args.delete\n\n      configs.removeDirectly = args.D\n      delete args.D\n      delete args.deleteDirectly\n      delete args['delete-directly']\n\n      configs.list = args.l\n      delete args.l\n      delete args.list\n\n      configs.verbose = args.v\n      delete args.v\n      delete args.verbose\n\n      configs.help = args.h\n      delete args.h\n      delete args.help\n\n      configs.destinations = if args._? and args._.length > 0 then args._ else [ '' ]\n      delete args._\n\n      configs.destination = configs.destinations[0].toString()\n\n      configs.$0 = args.$0\n      delete args.$0\n\n      configs.unknown = args\n\n      configs\n\nCheck to see if the arguments given are valid.\n\n    checkIfValid = (configs) ->\n      messages = []\n      passed = true\n\n      _.forEach configs.unknown, (value, key) ->\n        messages.push \"Unknown argument #{key}: #{value} is not allowed\"\n        passed = false\n\n      if configs.destinations.length > 1\n        messages.push 'At most 1 destination is allowed'\n        passed = false\n\n      try\n        unless fs.statSync(path.resolve(configs.destination)).isDirectory()\n          messages.push 'Destination is not a directory'\n          passed = false\n      catch e\n        if e.code is 'ENOENT'\n          messages.push 'Destination is not existing'\n          passed = false\n        else\n          throw e\n\n      [ passed, messages ]\n\nPublic API\n-----\n\nNow we can publish the main entry point.\n\n    module.exports = main\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"538c607c0d4bd316eb136ffbd2767c571f755d3f","subject":"Update do_render signature to accept ctx being passed in","message":"Update do_render signature to accept ctx being passed in\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_step_count.litcoffee","new_file":"lib\/render-pipelines\/png\/png_step_count.litcoffee","new_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngStepCount extends PngRenderer\n\n      do_render: (ctx, path) =>\n        width  = @config.width\n        height = @config.height\n\n        for step, i in path\n          ctx.font      = \"#{Math.floor height * 0.25}pt Arial\"\n          ctx.textAlign = @config.step_count.text.align\n          ctx.fillStyle = @config.step_count.text.color\n\n          x = (width  * 0.5) + (width  * step.col)\n          y = (height * 0.5) + (height * step.row)\n\n          ctx.beginPath()\n          ctx.fillText i, x, y\n\n    module.exports = PngStepCount\n","old_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngStepCount extends PngRenderer\n\n      do_render: (path) =>\n        ctx    = PngRenderer.ctx\n        width  = @config.width\n        height = @config.height\n\n        for step, i in path\n          ctx.font      = \"#{Math.floor height * 0.25}pt Arial\"\n          ctx.textAlign = @config.step_count.text.align\n          ctx.fillStyle = @config.step_count.text.color\n\n          x = (width  * 0.5) + (width  * step.col)\n          y = (height * 0.5) + (height * step.row)\n\n          ctx.beginPath()\n          ctx.fillText i, x, y\n\n    module.exports = PngStepCount\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2319bcf28c069843448faccedb9f6fb91cc37848","subject":"Added back the constructor and capturing extendable listeners","message":"Added back the constructor and capturing extendable listeners\n","repos":"nhz-io\/cnl","old_file":"source\/element.litcoffee","new_file":"source\/element.litcoffee","new_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\nA visual element.\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element()\n\nCreates an Element instance.\n\n      constructor: ->\n        super\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nAdd capturing extendable listener\n          \n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n          \n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## METHODS\n### #mousemoveCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousemove** listener\n    \n      mousemoveCaptureListener: (event) ->\n\nStore the event in the runtime for later\n\n        @___runtime.mousemoveEvent = event\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousedown** listener\n\n      mousedownCaptureListener: (event) ->\n\nStore the event in the runtime for later\n\n        @___runtime.mousedownEvent = event\n\n---\n\n### #mouseupdCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mouseup** listener\n      \n      mouseupCaptureListener: (event) ->\n\nStore the event in the runtime for later\n        \n        @___runtime.mouseupEvent = event\n\n[Element]: .\/element\n\n[Parent]: .\/index.litcoffee\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n","old_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element()\n\nCreates Element instance.\n\n      constructor: (args) ->\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## METHODS\n\n[Parent]: .\/index.litcoffee\n\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"10ea38b63de837231638f6fe5672a4c2da321b0b","subject":"Modified the core game file to use the new, refactored character\/track modules.","message":"Modified the core game file to use the new, refactored character\/track\nmodules.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat","old_file":"src\/game.litcoffee","new_file":"src\/game.litcoffee","new_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    context = require \".\/rendering\/context.litcoffee\"\n    track = require \".\/tracks\/track.litcoffee\"\n    character = require \".\/characters\/character.litcoffee\"\n    \n    thirdPerson = require \".\/cameras\/thirdPerson.litcoffee\"\n    \n    cameraInstance = characterInstance = trackInstance = undefined\n    \n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        context.load()\n        trackDefinition = require \".\/tracks\/island\/index.litcoffee\"\n        track.load trackDefinition, (_trackInstance) ->\n            trackInstance = _trackInstance\n            character.load (require \".\/characters\/test\/index.litcoffee\"), trackDefinition.spawns[0], trackInstance, gamepad, (_characterInstance) ->\n                characterInstance = _characterInstance\n                cameraInstance = thirdPerson.create characterInstance.transform, 20, 10, 7, 0.3, 0.9\n                callback()\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    tick = ->        \n        track.tick trackInstance\n        character.tick characterInstance\n        thirdPerson.tick cameraInstance, characterInstance.triangle, 12\n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n        track.preDraw trackInstance, progress\n        character.preDraw characterInstance, progress\n        thirdPerson.preDraw cameraInstance, progress\n        context.begin 0, 0, context.width, context.height, 1, cameraInstance.transformPreviousDraw, cameraInstance.transform\n        track.draw trackInstance, characterInstance.section\n        character.draw characterInstance\n        return\n        \n    module.exports = { load, tick, draw }","old_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    pose = require \".\/pose.litcoffee\"\n    ik = require \".\/ik.litcoffee\"\n       \n    triangle = undefined\n    \n    character = testMap = testNavmesh = undefined\n    characterData = require \".\/characters\/test\/cloud.coffee\"\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load characterData, (character_) ->\n            character = character_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    matrix.identity entityTransform\n    \n    playerPoseOld = pose.create characterData\n    playerPoseNew = pose.create characterData\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformToDraw = []\n    cameraTransformPreviousDraw = []\n    cameraTransformPreviousTick = []\n    cameraLocation = []\n    cameraLocationPreviousTick = []\n    cameraTarget = []\n    cameraTargetPreviousTick = []\n    \n    torsoAltitude = 0\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    start = []\n    leftFoot = []\n    rightFoot = []\n    leftHand = []\n    leftHandPreviousTick = []\n    leftHandToDraw = []\n    rightHand = []\n    rightHandPreviousTick = []\n    rightHandToDraw = []\n    walked = 0\n    shuffleTicks = 0\n    foot = \"left\"\n    ticksSinceLeft = 0\n    ticksSinceRight = 0\n    offset = []\n    \n    yaw = 0\n    pitch = 0\n    headYawPreviousTick = headYaw = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->        \n        if not firstTick\n            matrix.copy cameraTransform, cameraTransformPreviousTick\n            vector.copy cameraLocation, cameraLocationPreviousTick\n            vector.copy cameraTarget, cameraTargetPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            vector.copy leftHand, leftHandPreviousTick\n            vector.copy rightHand, rightHandPreviousTick\n            \n        matrix.translate velocity, entityTransform  \n        speed = vector.magnitude velocity\n        walked += speed\n        moving = speed > 2\n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # A \"bump\" when you land.\n            matrix.getY entityTransform, yAxis\n            impact = Math.abs (vector.dot triangle.plane.normal, velocity) * (vector.dot triangle.plane.normal, yAxis)\n            impact -= 1\n            if impact < 0 then impact = 0\n            impact *= 2\n            torsoAltitude -= impact\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        torsoAltitude = misc.interpolate torsoAltitude, (12 - Math.min 2, (speed + if inDeadzone then 0 else 1.5)), 0.4\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, torsoAltitude, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.1, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        # Calculating the head angle relative to the torso is complicated by the\n        # stick angle being wrapped to 0...2PI, so we have to shift it out of\n        # that range to clamp it.\n        headYawPreviousTick = headYaw\n        headYaw = Math.max Math.PI - 1, Math.min Math.PI + 1, misc.wrapAngle Math.PI + stickAngle - yaw\n        headYaw -= Math.PI\n        headYaw = misc.interpolateAngle headYawPreviousTick, headYaw, 0.4, headYaw\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.4\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n        \n        shuffleTicks--\n        ticksSinceLeft++\n        ticksSinceRight++\n        while walked > 5 or shuffleTicks < 0\n            shuffleTicks = 5\n            walked -= 5\n            if (not inDeadzone) or moving\n                vector.normalize velocity, offset\n                vector.multiply.byScalar offset, 5, offset\n            else\n                offset[0] = offset[1] = offset[2] = 0\n            foot = switch foot\n                when \"left\"\n                    matrix.applyToVector playerPoseNew.torso, [-2, -10, 0], leftFoot\n                    vector.add.vector offset, leftFoot, leftFoot\n                    plane.project triangle.plane, leftFoot, leftFoot\n                    ticksSinceLeft = 0\n                    \"right\"\n                when \"right\"\n                    matrix.applyToVector playerPoseNew.torso, [2, -10, 0], rightFoot\n                    vector.add.vector offset, rightFoot, rightFoot\n                    plane.project triangle.plane, rightFoot, rightFoot\n                    ticksSinceRight = 0\n                    \"left\"\n        \n        if inDeadzone\n            leftHand[0] = -6\n            rightHand[0] = 6\n            leftHand[1] = rightHand[1] = -4\n            leftHand[2] = rightHand[2] = 0\n        else\n            yScale = 7 \/ (1 + speed)\n            rightHand[0] = 2 + (Math.min 4, speed)\n            leftHand[0] = -rightHand[0]\n            \n            leftHand[1] = rightHand[1] = 3\n            motion = Math.pow (Math.cos ticksSinceLeft * 0.25) * 0.5 + 0.5, 4\n            leftHand[1] += yScale * motion\n            leftHand[2] = 1.5 + 6 * stickLength * motion\n            motion = Math.pow (Math.cos ticksSinceRight * 0.25) * 0.5 + 0.5, 4\n            rightHand[1] += yScale * motion\n            rightHand[2] = 1.5 + 6 * stickLength * motion\n            \n        matrix.applyToVector torsoTransform, leftHand, leftHand                \n        matrix.applyToVector torsoTransform, rightHand, rightHand\n        \n        leftHand[1] -= 2\n        rightHand[1] -= 2\n        \n        matrix.getX entityTransform, xAxis\n        matrix.getY entityTransform, yAxis\n        matrix.getZ entityTransform, zAxis\n        matrix.getTranslation entityTransform, cameraTarget\n        vector.multiply.byScalar yAxis, 18, offset\n        vector.add.vector cameraTarget, offset, cameraTarget\n        vector.multiply.byScalar zAxis, -20, offset\n        vector.add.vector cameraTarget, offset, cameraLocation\n        \n        vector.interpolate cameraTargetPreviousTick, cameraTarget, 0.6, cameraTarget\n        vector.interpolate cameraLocationPreviousTick, cameraLocation, 0.6, cameraLocation\n        \n        cameraTriangle = triangle\n        cameraTriangle = navmesh.constrain cameraLocation, cameraTriangle\n        cameraAltitude = (plane.distance cameraTriangle.plane, cameraLocation) - 4\n        if cameraAltitude < 0\n            vector.multiply.byScalar cameraTriangle.plane.normal, -cameraAltitude, offset\n            vector.add.vector offset, cameraLocation, cameraLocation\n        \n        ik.lookAt cameraLocation, cameraTarget, xAxis, cameraTransform\n        matrix.invert cameraTransform, cameraTransform\n        \n        if firstTick\n            matrix.copy cameraTransform, cameraTransformPreviousTick\n            vector.copy cameraLocation, cameraLocationPreviousTick\n            vector.copy cameraTarget, cameraTargetPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            vector.copy leftHand, leftHandPreviousTick\n            vector.copy rightHand, rightHandPreviousTick\n            firstTick = false\n            \n        lag = 0.15 + 0.4 \/ (1 + speed \/ 3)\n        if inDeadzone then lag = 0.2\n        vector.interpolate leftHandPreviousTick, leftHand, lag, leftHand\n        vector.interpolate rightHandPreviousTick, rightHand, lag, rightHand\n                   \n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n    \n        if not firstDraw\n            matrix.copy cameraTransformToDraw, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n        \n        matrix.interpolate cameraTransformPreviousTick, cameraTransform, progress, cameraTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, playerPoseNew.torso\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, -2.5, 0], start\n        matrix.getX playerPoseNew.torso, xAxis\n        ik.computeLimb start, leftFoot, 10, xAxis, playerPoseNew.legLeftUpper, playerPoseNew.legLeftLower\n        \n        matrix.applyToVector playerPoseNew.torso, [1.5, -2.5, 0], start\n        ik.computeLimb start, rightFoot, 10, xAxis, playerPoseNew.legRightUpper, playerPoseNew.legRightLower\n\n        matrix.getY playerPoseNew.torso, yAxis\n        vector.negate xAxis, xAxis\n        vector.interpolate xAxis, yAxis, 0.05, offset\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, 4, 0], start\n        vector.interpolate leftHandPreviousTick, leftHand, progress, leftHandToDraw\n        ik.computeLimb start, leftHandToDraw, 10, offset, playerPoseNew.armLeftUpper, playerPoseNew.armLeftLower\n        \n        vector.negate yAxis, yAxis\n        vector.interpolate xAxis, yAxis, 0.05, offset\n\n        matrix.applyToVector playerPoseNew.torso, [1.5, 4, 0], start\n        vector.interpolate rightHandPreviousTick, rightHand, progress, rightHandToDraw\n        ik.computeLimb start, rightHandToDraw, 10, offset, playerPoseNew.armRightUpper, playerPoseNew.armRightLower\n        \n        matrix.copy playerPoseNew.torso, playerPoseNew.head\n        matrix.translate [0, 6, 0], playerPoseNew.head, true\n        matrix.rotateY (misc.interpolate headYawPreviousTick, headYaw, progress), playerPoseNew.head, true\n        \n        if firstDraw\n            matrix.copy cameraTransformToDraw, cameraTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransformToDraw, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw character, playerPoseOld, playerPoseNew\n        \n        return\n        \n    module.exports = { load, tick, draw }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3035c3b379dbfba855260720928418c4e15891b9","subject":"clean markdown","message":"clean markdown\n","repos":"nickfargo\/restate","old_file":"src\/state.litcoffee","new_file":"src\/state.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5842bea8b3e60b5545d262e980c2b42f25e2ba15","subject":"Add ObjectID property to returned replace object","message":"Add ObjectID property to returned replace object\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/model\/Document.litcoffee","new_file":"coffee\/model\/Document.litcoffee","new_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n## Class: Doc\n\n### Params\n\n* `string` type - document type\n* `string` id - document id\n\n### Return\n\nNew `Doc`.\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n      @db   = mongo[type]\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n      @type = type\n      @data = {}\n      @chit = false\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if data\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n## Doc.exists\n\nCheck if document exists.\n\n### Return\n\nReturns `true` if document exists; otherwise `false`.\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n## Doc.getId\n\nGet document id (ObjectID) for current document.\n\n### Return\n\nReturns an `ObjectID` if the document has an id; otherwise `null`.\n\n    Doc.prototype.getId = ->\n      @id\n\n\n## Doc.wasCacheHit\n\nCheck if document request was a cache hit.\n\n### Return\n\nReturns `true` if document request was a cache hit; otherwise `false`.\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n## Doc.isNotModifiedSince\n\nCheck if document has not been modified since a given timestamp.\n\n### Params\n\n* `string` time - timestamp to check against.\n\n### Return\n\nReturns `true` if document has not been modified since given tmestamp; otherwise\n`false`.\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make unix timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n## doc.isMatch\n\nCheck if checksum, or Etag, matche current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturns `true` if checksum matches the current checksum; otherwise `false`.\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n## doc.isNoneMatch\n\nCheck if checksum, or Etag, doesnt match current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturn `true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n## Doc.get\n\nGet cached data for current document.\n\n### Params\n\n* `string` key - get specific object property\n\n### Return\n\nReturns an `object` if `key` is `undefined`; otherwise `string`. Will retur\n`undefined` if the given key does not exist.\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n## doc.getFull\n\n### Params\n\n* `object` filter - control which object properties are returned\n* `function` cb - callback function (`Error` err, `object` data)\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n## Doc.insert\n\nInserts a document into databse.\n\n### Params\n\n* `object` data - data to insert for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.replace\n\nReplaces all document data in database.\n\n### Params\n\n* `object` data - replacement data for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          data._id = @id\n          cb err, warn, data\n\n\n## Doc.update\n\nPartially update the document-data in database. This is some times refered to as\nPATCH in a HTTP \/ REST context.\n\n### Params\n\n* `object` data - replacement object for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n## Doc.delete\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n### Params\n\n* `function`  cb - callback function (`Error` err).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet'\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n\n","old_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n## Class: Doc\n\n### Params\n\n* `string` type - document type\n* `string` id - document id\n\n### Return\n\nNew `Doc`.\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n      @db   = mongo[type]\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n      @type = type\n      @data = {}\n      @chit = false\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if data\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n## Doc.exists\n\nCheck if document exists.\n\n### Return\n\nReturns `true` if document exists; otherwise `false`.\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n## Doc.getId\n\nGet document id (ObjectID) for current document.\n\n### Return\n\nReturns an `ObjectID` if the document has an id; otherwise `null`.\n\n    Doc.prototype.getId = ->\n      @id\n\n\n## Doc.wasCacheHit\n\nCheck if document request was a cache hit.\n\n### Return\n\nReturns `true` if document request was a cache hit; otherwise `false`.\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n## Doc.isNotModifiedSince\n\nCheck if document has not been modified since a given timestamp.\n\n### Params\n\n* `string` time - timestamp to check against.\n\n### Return\n\nReturns `true` if document has not been modified since given tmestamp; otherwise\n`false`.\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make unix timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n## doc.isMatch\n\nCheck if checksum, or Etag, matche current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturns `true` if checksum matches the current checksum; otherwise `false`.\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n## doc.isNoneMatch\n\nCheck if checksum, or Etag, doesnt match current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturn `true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n## Doc.get\n\nGet cached data for current document.\n\n### Params\n\n* `string` key - get specific object property\n\n### Return\n\nReturns an `object` if `key` is `undefined`; otherwise `string`. Will retur\n`undefined` if the given key does not exist.\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n## doc.getFull\n\n### Params\n\n* `object` filter - control which object properties are returned\n* `function` cb - callback function (`Error` err, `object` data)\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n## Doc.insert\n\nInserts a document into databse.\n\n### Params\n\n* `object` data - data to insert for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.replace\n\nReplaces all document data in database.\n\n### Params\n\n* `object` data - replacement data for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.update\n\nPartially update the document-data in database. This is some times refered to as\nPATCH in a HTTP \/ REST context.\n\n### Params\n\n* `object` data - replacement object for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n## Doc.delete\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n### Params\n\n* `function`  cb - callback function (`Error` err).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet'\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f2f328e2867811a2927d784668d22a4120b3424d","subject":"add nef and rw2 into default file types","message":"add nef and rw2 into default file types\n","repos":"whitetrefoil\/extra-jpg-cleaner","old_file":"src\/argv.litcoffee","new_file":"src\/argv.litcoffee","new_contents":"This is a internal lib file.  It will be included at the head of [cleaner.litcoffee](cleaner.html).\n\nArguments\n-----\n\n`\"use strict\";` always first :)\n\n    'use strict'\n\nLet the help message more colorful~\n\n    require 'colors'\n\nUse [Yargs](https:\/\/github.com\/chevex\/yargs) to build the argv function and help display.\n\n    yargs = require('yargs')\n\nPrint the common descriptions.\n\n    .usage '''\n           This application will append extra extname to all filtered out JPG files.\n           Then you can check the result by your OS\\'s search function easily.\n           In case there is anything wrong, you can rollback.\n\n           The default destination is here.\n\n           P.S. The priority among -l, -d & -r is -l > -d > -r\n\n\n           ''' +\n           'Usage: clean-jpg [--options] [destination]'.cyan\n\n\nSet the extname(s) of your RAW files.\nYou can give a comma-separated list of extnames (e.g. `-x nef,cr2,dng`).\n\nBesides, this is case-**in**sensitive.\n\nMy default is \"_ARW,RW2,NEF_\",\nbecause I own 2 Sony, 1 Panasonic, and my Dad owns 2 Nikon :)\n\n    .options 'x',\n      alias: 'extname'\n      describe: \"\"\"\n                the extname(s) of your RAW files, case-#{'IN'.yellow}sensitive\n                a comma-seperated list is acceptable\n                #{'e.g. \"-x nef,cr2,dng\"'.cyan}\n\n                \"\"\"\n      default: 'arw,rw2,nef'\n\nThe extname can be overridden if you want.\nBut we still suggest you can use a outstanding name to prevent confusion with others.\nUsually a name will be as safe as long.\n\n    .options 'r',\n      alias: 'rename'\n      default: 'extra-jpg-cleaner-result'\n      describe: 'the extname used when renaming\\n'\n\nDelete the files **DIRECTLY**.\n\nThe default behavior of this application is rename the target files then you can check it manually.\nIt's for safety purpose.\n\nThis will require a complex confirmation.\n\n    .options 'd',\n      alias: 'delete'\n      boolean: true\n      describe: '!!!CAUTION!!!\\n'.yellow.bold +\n                \"\"\"\n                Delete DIRECTLY w\/ a single confirmation\n                instead of confirming one by one.\n                It WON'T move your files to the recycle bin\n                or trash can.\n                Generally this operation will be unrecoverable.\n                Try this only if you think your luck is overwhelming.\n                Incase something goes wrong,\n                go to buy an EasyRecovery or something similar.\n                Then test your overwhelming luck again...\n                \"\"\"\n\nDelete the files **DIRECTLY** with only a simple confirmation.\n\nSame as `-d` but will just ask a simple `Y\/N`.\n\n    .options 'D',\n      alias: 'delete-directly'\n      boolean: true\n      describe: '!!!CAUTION!!!\\n'.red.bold +\n                \"\"\"\n                Same as \"-d\" but with\n                only even simpler \"Y\/N\" confirmation.\n                \"\"\"\n\nFor such a application (who do the cleanup jobs), allow user to dry run is a good idea.\n\n    .options 'l',\n      alias: 'list'\n      describe: 'just print a list of result, will NOT delete anything'\n      boolean: true\n\nGive more messages...\nActually will print every file when renaming \/ deleting.\n\n    .options 'v',\n      alias: 'verbose'\n      describe: 'print when renaming \/ deleting'\n      boolean: true\n\nPrint the help text.\n\n    .options 'h',\n      alias: 'help'\n      describe: 'print this help message'\n      boolean: true\n\nChange a new line at the 80th character.\n\n    .wrap 80\n\n\nExports the whole yargs instance.\n\nAs a result, all properties & results of that are available.\n\n    module.exports = yargs\n","old_contents":"This is a internal lib file.  It will be included at the head of [cleaner.litcoffee](cleaner.html).\n\nArguments\n-----\n\n`\"use strict\";` always first :)\n\n    'use strict'\n\nLet the help message more colorful~\n\n    require 'colors'\n\nUse [Yargs](https:\/\/github.com\/chevex\/yargs) to build the argv function and help display.\n\n    yargs = require('yargs')\n\nPrint the common descriptions.\n\n    .usage '''\n           This application will append extra extname to all filtered out JPG files.\n           Then you can check the result by your OS\\'s search function easily.\n           In case there is anything wrong, you can rollback.\n\n           The default destination is here.\n\n           P.S. The priority among -l, -d & -r is -l > -d > -r\n\n\n           ''' +\n           'Usage: clean-jpg [--options] [destination]'.cyan\n\n\nSet the extname(s) of your RAW files.\nYou can give a comma-separated list of extnames (e.g. `-x nef,cr2,dng`).\n\nBesides, this is case-**in**sensitive.\n\nMy default is \"_ARW_\" because I'm a NEX user :)\n\n    .options 'x',\n      alias: 'extname'\n      describe: \"\"\"\n                the extname(s) of your RAW files, case-#{'IN'.yellow}sensitive\n                a comma-seperated list is acceptable\n                #{'e.g. \"-x nef,cr2,dng\"'.cyan}\n\n                \"\"\"\n      default: 'arw'\n\nThe extname can be overridden if you want.\nBut we still suggest you can use a outstanding name to prevent confusion with others.\nUsually a name will be as safe as long.\n\n    .options 'r',\n      alias: 'rename'\n      default: 'extra-jpg-cleaner-result'\n      describe: 'the extname used when renaming\\n'\n\nDelete the files **DIRECTLY**.\n\nThe default behavior of this application is rename the target files then you can check it manually.\nIt's for safety purpose.\n\nThis will require a complex confirmation.\n\n    .options 'd',\n      alias: 'delete'\n      boolean: true\n      describe: '!!!CAUTION!!!\\n'.yellow.bold +\n                \"\"\"\n                Delete DIRECTLY w\/ a single confirmation\n                instead of confirming one by one.\n                It WON'T move your files to the recycle bin\n                or trash can.\n                Generally this operation will be unrecoverable.\n                Try this only if you think your luck is overwhelming.\n                Incase something goes wrong,\n                go to buy an EasyRecovery or something similar.\n                Then test your overwhelming luck again...\n                \"\"\"\n\nDelete the files **DIRECTLY** with only a simple confirmation.\n\nSame as `-d` but will just ask a simple `Y\/N`.\n\n    .options 'D',\n      alias: 'delete-directly'\n      boolean: true\n      describe: '!!!CAUTION!!!\\n'.red.bold +\n                \"\"\"\n                Same as \"-d\" but with\n                only even simpler \"Y\/N\" confirmation.\n                \"\"\"\n\nFor such a application (who do the cleanup jobs), allow user to dry run is a good idea.\n\n    .options 'l',\n      alias: 'list'\n      describe: 'just print a list of result, will NOT delete anything'\n      boolean: true\n\nGive more messages...\nActually will print every file when renaming \/ deleting.\n\n    .options 'v',\n      alias: 'verbose'\n      describe: 'print when renaming \/ deleting'\n      boolean: true\n\nPrint the help text.\n\n    .options 'h',\n      alias: 'help'\n      describe: 'print this help message'\n      boolean: true\n\nChange a new line at the 80th character.\n\n    .wrap 80\n\n\nExports the whole yargs instance.\n\nAs a result, all properties & results of that are available.\n\n    module.exports = yargs\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d6fa1516cedbe19ed8d495db9ac85ee5f4b148f9","subject":"Move square thumbnail higher up in versions array","message":"Move square thumbnail higher up in versions array\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/upload.litcoffee","new_file":"src\/upload.litcoffee","new_contents":"    Upload = require 's3-uploader'\n\nConfigure [s3-uploader](https:\/\/github.com\/Turistforeningen\/node-s3-uploader) to\nstore the following versions:\n\n|\u00a0Suffix    | Max Height | Max Width\u00a0| Aspect Ratio |\n|-----------|------------|-----------|--------------|\n| `-full`   | `1200`     | `1200`    |              |\n| `-thumb`  | `250`      | `250`     | `1:1`        |\n| `-800`    | `800`      | `800`     | `3:2`        |\n| `-500`    | `500`      | `500`     | `3:2`        |\n| `-260`    | `260`      | `260`     | `3:2`        |\n| `-150`    | `150`      | `150`     | `3:2`        |\n\n    module.exports = new Upload process.env.AWS_BUCKET_NAME,\n      aws:\n        region: process.env.AWS_BUCKET_REGION\n        path: process.env.AWS_BUCKET_PATH\n        acl: 'public-read'\n        httpOptions: timeout: 60000\n\n      returnExif: true\n\n      cleanup:\n        original: true\n        versions: true\n\n      original:\n        awsImageAcl: 'private'\n\n      versions: [\n        suffix: '-full'\n        quality: 80\n        maxHeight: 1200\n        maxWidth: 1200\n      ,\n        suffix: '-thumb'\n        maxHeight: 250\n        maxWidth: 250\n        aspect: '1:1'\n      ,\n        suffix: '-800'\n        maxHeight: 800\n        maxWidth: 800\n        aspect: '3:2'\n      ,\n        suffix: '-500'\n        maxHeight: 500\n        maxWidth: 500\n        aspect: '3:2'\n      ,\n        suffix: '-260'\n        maxHeight: 260\n        maxWidth: 260\n        aspect: '3:2'\n      ,\n        suffix: '-150'\n        maxHeight: 150\n        maxWidth: 150\n        aspect: '3:2'\n      ]\n","old_contents":"    Upload = require 's3-uploader'\n\nConfigure [s3-uploader](https:\/\/github.com\/Turistforeningen\/node-s3-uploader) to\nstore the following versions:\n\n|\u00a0Suffix    | Max Height | Max Width\u00a0| Aspect Ratio |\n|-----------|------------|-----------|--------------|\n| `-full`   | `1200`     | `1200`    |              |\n| `-800`    | `800`      | `800`     | `3:2`        |\n| `-500`    | `500`      | `500`     | `3:2`        |\n| `-260`    | `260`      | `260`     | `3:2`        |\n| `-150`    | `150`      | `150`     | `3:2`        |\n| `-thumb1` | `250`      | `250`     | `1:1`        |\n\n    module.exports = new Upload process.env.AWS_BUCKET_NAME,\n      aws:\n        region: process.env.AWS_BUCKET_REGION\n        path: process.env.AWS_BUCKET_PATH\n        acl: 'public-read'\n        httpOptions: timeout: 60000\n\n      returnExif: true\n\n      cleanup:\n        original: true\n        versions: true\n\n      original:\n        awsImageAcl: 'private'\n\n      versions: [\n        suffix: '-full'\n        quality: 80\n        maxHeight: 1200\n        maxWidth: 1200\n      ,\n        suffix: '-800'\n        maxHeight: 800\n        maxWidth: 800\n        aspect: '3:2'\n      ,\n        suffix: '-500'\n        maxHeight: 500\n        maxWidth: 500\n        aspect: '3:2'\n      ,\n        suffix: '-260'\n        maxHeight: 260\n        maxWidth: 260\n        aspect: '3:2'\n      ,\n        suffix: '-150'\n        maxHeight: 150\n        maxWidth: 150\n        aspect: '3:2'\n      ,\n        suffix: '-thumb1'\n        maxHeight: 250\n        maxWidth: 250\n        aspect: '1:1'\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6a0f515d13e1776d71f2e0c2ac66a77c69390127","subject":"Modify prototype, not instance","message":"Modify prototype, not instance\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    Array.prototype.last = -> this[this.length - 1]\n\n    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n\n    code_root = process.env.MADUL_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n\n    WRAPPED = { }\n\n    _INITIALIZERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push method\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'listen'\n          'fire'\n          'warn'\n          'report'\n          'do_wrap'\n          'wrap_methods'\n          'strip'\n          'make_available'\n          'hydrate'\n          'finish_up'\n          'initialize'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      listen: (event, callback) => Madul.LISTEN \"*.#{@clazz}.#{event}\", callback\n\n      fire: (event, args) => Madul.FIRE \"@.#{@clazz}.#{event}\", args\n\n      warn: (event, details) => Madul.FIRE \"!.#{@clazz}.#{event}\", details\n\n      report: (method, state, id, args) =>\n        @fire \"#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      do_wrap: (method) =>\n        proto  = @constructor.prototype\n        callMe = proto[method]\n\n        Madul.FIRE \"$.#{@clazz}.#{method}.wrap\"\n\n        proto[\"_#{method}\"] = @[method]\n\n        respond = (id, deferred) =>\n          (state, data) =>\n            process.nextTick =>\n              deferred[state] data\n\n              @report method, state, id, data\n\n        WRAPPED[@clazz].push method\n\n        proto[method] = =>\n          id   = uuid.v4fast()\n          def  = q.defer()\n          args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n          res  = respond id, def\n\n          args.push (out) => res 'resolve', out\n          args.push (err) => res 'reject',  err\n          args.push (out) => res 'notify',  out\n\n          @report method, 'invoke', id, args\n\n          proto[\"_#{method}\"].apply @, args\n\n          def.promise\n\n      wrap_methods: =>\n        props = Object.keys @constructor.prototype\n        proto = @constructor.prototype\n\n        for prop in props\n          if prop[0] != '_'                          &&\n             typeof proto[prop] == 'function'        &&\n             typeof proto[\"_#{prop}\"] == 'undefined' &&\n             WRAP(@clazz, prop) == true\n\n            @do_wrap prop\n\n            INITIALIZERS @clazz, prop if prop[0] == '$'\n\n      strip: (name) => name.toLowerCase().replace \/\\W+\/g, ''\n\n      make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[@strip name] = mod\n\n      hydrate: (deps, done) =>\n        load = (name, path, loaded) =>\n          mod = require path\n\n          if typeof mod == 'function'\n            new mod name\n              .initialize @ctor_params?[name]\n              .then (mod) =>\n                @make_available name, mod\n                loaded()\n          else\n            @make_available name, mod\n            loaded()\n\n        check = (path, dep, finished) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              @warn 'file-not-found', err\n\n              done type: 'ERROR', info: err\n            else\n              async.each files, (f, next) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.stat depth, (e, s) =>\n                  if s.isDirectory() && f[0] != '.'\n                    check depth, dep, next\n                  else if s.isFile() && f.substring(0, f.length - 3) == dep\n                    load f.substring(0, f.length - 3), depth, => do_add dep, next\n                  else\n                    next()\n              , finished\n\n        add_dependency = (name, mod) =>\n          Madul.FIRE \"$.#{@clazz}.dependency.register\", name\n          @[underscore name] = mod\n\n        do_add = (name, next) =>\n          add_dependency name, available[@strip name]\n          next()\n\n        add = (name, resource, next) =>\n          @make_available name, require resource\n          do_add name, next\n\n        async.each deps, (d, next) =>\n          if @[underscore d]? == false\n            if available[@strip d]? == true\n              do_add d, next\n            else\n              try\n                add d, d, next\n              catch e\n                cwd = process.cwd()\n                pkg = \"#{cwd}\/node_modules\/#{d}\/package.json\"\n\n                fs.stat pkg, (err, stat) =>\n                  if stat?.isFile()\n                    fs.readFile pkg, 'utf8', (err, data) =>\n                      json = JSON.parse data\n                      main = json.main || json._main || 'index.js'\n\n                      add d, \"#{cwd}\/node_modules\/#{d}\/#{main}\", next\n                  else\n                    check \"#{cwd}\/#{code_root}\", d, next\n          else\n            next()\n        , done\n\n      finish_up: (resolve, args) =>\n        async.each _INITIALIZERS[@clazz], (initializer, next) =>\n          @[initializer] args\n            .then next\n        , =>\n          @make_available @clazz, @\n          resolve @\n          Madul.FIRE \"$.#{@clazz}.initialized\"\n\n      initialize: =>\n        deferred = q.defer()\n        args     = if arguments[0]? then Array.prototype.slice.call arguments else undefined\n\n        @clazz = @constructor.name unless @clazz?\n\n        Madul.FIRE \"$.#{@clazz}.request_instance\", args\n\n        if initialized[@clazz] != true\n          Madul.FIRE \"$.#{@clazz}.initialize\", args\n\n          initialized[@clazz] = true\n\n          @wrap_methods()\n\n          if @deps?\n            @hydrate @deps, => @finish_up deferred.resolve, args\n          else\n            @finish_up deferred.resolve, args\n        else\n          process.nextTick => deferred.resolve available[@strip @clazz]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    Array.prototype.last = -> this[this.length - 1]\n\n    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n\n    code_root = process.env.MADUL_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n\n    WRAPPED = { }\n\n    _INITIALIZERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push method\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'listen'\n          'fire'\n          'warn'\n          'report'\n          'do_wrap'\n          'wrap_methods'\n          'strip'\n          'make_available'\n          'hydrate'\n          'finish_up'\n          'initialize'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      listen: (event, callback) => Madul.LISTEN \"*.#{@clazz}.#{event}\", callback\n\n      fire: (event, args) => Madul.FIRE \"@.#{@clazz}.#{event}\", args\n\n      warn: (event, details) => Madul.FIRE \"!.#{@clazz}.#{event}\", details\n\n      report: (method, state, id, args) =>\n        @fire \"#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      do_wrap: (method) =>\n        callMe = @[method]\n\n        Madul.FIRE \"$.#{@clazz}.#{method}.wrap\"\n\n        @[\"_#{method}\"] = @[method]\n\n        respond = (id, deferred) =>\n          (state, data) =>\n            process.nextTick =>\n              deferred[state] data\n\n              @report method, state, id, data\n\n        WRAPPED[@clazz].push method\n\n        @[method] = =>\n          id   = uuid.v4fast()\n          def  = q.defer()\n          args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n          res  = respond id, def\n\n          args.push (out) => res 'resolve', out\n          args.push (err) => res 'reject',  err\n          args.push (out) => res 'notify',  out\n\n          @report method, 'invoke', id, args\n\n          @[\"_#{method}\"].apply @, args\n\n          def.promise\n\n      wrap_methods: =>\n        props = Object.keys @constructor.prototype\n\n        for prop in props\n          if prop[0] != '_'                      &&\n             typeof @[prop] == 'function'        &&\n             typeof @[\"_#{prop}\"] == 'undefined' &&\n             WRAP(@clazz, prop) == true\n\n            @do_wrap prop\n\n            INITIALIZERS @clazz, prop if prop[0] == '$'\n\n      strip: (name) => name.toLowerCase().replace \/\\W+\/g, ''\n\n      make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[@strip name] = mod\n\n      hydrate: (deps, done) =>\n        load = (name, path, loaded) =>\n          mod = require path\n\n          if typeof mod == 'function'\n            new mod name\n              .initialize @ctor_params?[name]\n              .then (mod) =>\n                @make_available name, mod\n                loaded()\n          else\n            @make_available name, mod\n            loaded()\n\n        check = (path, dep, finished) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              @warn 'file-not-found', err\n\n              done type: 'ERROR', info: err\n            else\n              async.each files, (f, next) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.stat depth, (e, s) =>\n                  if s.isDirectory() && f[0] != '.'\n                    check depth, dep, next\n                  else if s.isFile() && f.substring(0, f.length - 3) == dep\n                    load f.substring(0, f.length - 3), depth, => do_add dep, next\n                  else\n                    next()\n              , finished\n\n        add_dependency = (name, mod) =>\n          Madul.FIRE \"$.#{@clazz}.dependency.register\", name\n          @[underscore name] = mod\n\n        do_add = (name, next) =>\n          add_dependency name, available[@strip name]\n          next()\n\n        add = (name, resource, next) =>\n          @make_available name, require resource\n          do_add name, next\n\n        async.each deps, (d, next) =>\n          if @[underscore d]? == false\n            if available[@strip d]? == true\n              do_add d, next\n            else\n              try\n                add d, d, next\n              catch e\n                cwd = process.cwd()\n                pkg = \"#{cwd}\/node_modules\/#{d}\/package.json\"\n\n                fs.stat pkg, (err, stat) =>\n                  if stat?.isFile()\n                    fs.readFile pkg, 'utf8', (err, data) =>\n                      json = JSON.parse data\n                      main = json.main || json._main || 'index.js'\n\n                      add d, \"#{cwd}\/node_modules\/#{d}\/#{main}\", next\n                  else\n                    check \"#{cwd}\/#{code_root}\", d, next\n          else\n            next()\n        , done\n\n      finish_up: (resolve, args) =>\n        async.each _INITIALIZERS[@clazz], (initializer, next) =>\n          @[initializer] args\n            .then next\n        , =>\n          @make_available @clazz, @\n          resolve @\n          Madul.FIRE \"$.#{@clazz}.initialized\"\n\n      initialize: =>\n        deferred = q.defer()\n        args     = if arguments[0]? then Array.prototype.slice.call arguments else undefined\n\n        @clazz = @constructor.name unless @clazz?\n\n        Madul.FIRE \"$.#{@clazz}.request_instance\", args\n\n        if initialized[@clazz] != true\n          Madul.FIRE \"$.#{@clazz}.initialize\", args\n\n          initialized[@clazz] = true\n\n          @wrap_methods()\n\n          if @deps?\n            @hydrate @deps, => @finish_up deferred.resolve, args\n          else\n            @finish_up deferred.resolve, args\n        else\n          process.nextTick => deferred.resolve available[@strip @clazz]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c8193c0e1710df2418fdb9fc3e30a1eaaa0bc9a6","subject":"Navmesh.constrain, as documented, no longer pins the location to the navmesh surface, only following the walls.","message":"Navmesh.constrain, as documented, no longer pins the location to the\nnavmesh surface, only following the walls.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/navmesh.litcoffee","new_file":"src\/navmesh.litcoffee","new_contents":"# navmesh\n\nNavmeshes are stored as \"MSN\" (MasSplat Navmesh) and are used to define where \nentities (including the player) can travel.  By default, they are unable to \nleave the surface, \"crawling\" over it.  Each tile is a 3D triangle.  A light \nAny two triangles sharing two vertices are joined and the edge formed may be \ncrossed from one to the other, otherwise, the edge is treated as a form of wall.\n\nMSN is a binary format.  It is comprised of:\n\n| Type    | Num.              | Description                                                |\n| ------- | ----------------- | ---------------------------------------------------------- |\n| uint16  | 1                 | The number of vertices defined.                            |\n| uint16  | 1                 | The number of triangles defined.                           |\n| float32 | 3x num. vertices  | The X, Y and Z of each vertex.                             |\n| uint16  | 3x num. triangles | The first, second and third vertex index of each triangle. |\n\n    file = require \".\/file.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n\n## load\n\n- filename: The \"real\" location of the MSN file to load.  (i.e. already \n            \"require\"-d)\n- callback: A callback to execute with the array of objects representing the\n            loaded objects on success, containing:\n            \n+ plane: A plane object for the surface of the triangle itself.\n+ vertices: An array of vectors specifying the locations of the vertices which\n            make up the triangle.\n+ edges: An array of three objects representing the edges of the triangle,\n       containing:\n  \n* neighbor: When null, there is no other triangle over this edge.  Otherwise\n            a reference to the triangle object which can be found over it.\n* plane: A plane facing inwards from the edge.  If this edge borders another\n         triangle, this will be aligned to both this triangle and the \n         neighbor.\n    \n    load = (path, callback) ->\n        file.arrayBuffer path, (response) ->\n            header = new Uint16Array response, 0, 2\n            vertexData = new Float32Array response, 4, header[0] * 3\n            indices = new Uint16Array response, 4 + header[0] * 4 * 3, header[1] * 3\n        \n            vertices = for i in [0...vertexData.length] by 3\n                [\n                    vertexData[i]\n                    vertexData[i + 1]\n                    vertexData[i + 2]\n                ]\n        \n            triangles = for i in [0...indices.length] by 3\n                plane: plane.fromTriangle vertices[indices[i]], vertices[indices[i + 1]], vertices[indices[i + 2]]\n                indices: [\n                    indices[i]\n                    indices[i + 1]\n                    indices[i + 2]\n                ]\n                vertices: [\n                    vertices[indices[i]]\n                    vertices[indices[i + 1]]\n                    vertices[indices[i + 2]]\n                ]\n        \n            for triangle in triangles\n                triangle.edges = for edge in [0...3]\n                    vertexA = triangle.indices[edge]\n                    vertexB = triangle.indices[(edge + 1) % 3]\n                    vertexC = []\n                    vector.add.vector vertices[vertexA], triangle.plane.normal, vertexC\n                    neighbor = null\n                    for other in triangles\n                        if triangle is other then continue\n                        if vertexA not in other.indices then continue\n                        if vertexB not in other.indices then continue\n                        neighbor = other\n                        vector.add.vector vertexC, other.plane.normal, vertexC\n                        break\n                    neighbor: neighbor\n                    plane: plane.fromTriangle vertices[vertexA], vertexC, vertices[vertexB]\n\n            callback triangles\n            return\n        return\n            \n## constrain\n\n- A vector specifying the location moved to.\n- A reference to the navmesh triangle which contained the location moved from.\n\nUpdates the location vector to take into account collision with navmesh triangle \nwalls and returns the new containing navmesh triangle.\n            \n    constrain = (location, triangle) ->\n        \n        for iterations in [0...25]\n            distanceA = plane.distance triangle.edges[0].plane, location\n            distanceB = plane.distance triangle.edges[1].plane, location\n            distanceC = plane.distance triangle.edges[2].plane, location\n            if distanceA >= 0 and distanceB >= 0 and distanceC >= 0 \n                break\n\n            if distanceA < 0 and triangle.edges[0].neighbor\n                triangle = triangle.edges[0].neighbor\n                continue\n                \n            if distanceB < 0 and triangle.edges[1].neighbor\n                triangle = triangle.edges[1].neighbor\n                continue\n                \n            if distanceC < 0 and triangle.edges[2].neighbor\n                triangle = triangle.edges[2].neighbor\n                continue\n            \n            if distanceA < 0 and distanceB < 0\n                vector.copy triangle.vertices[1], location\n                continue\n                \n            if distanceB < 0 and distanceC < 0\n                vector.copy triangle.vertices[2], location\n                continue\n                \n            if distanceC < 0 and distanceA < 0\n                vector.copy triangle.vertices[0], location\n                continue\n\n            if distanceA < 0\n                plane.project triangle.edges[0].plane, location, location\n                continue\n                \n            if distanceB < 0\n                plane.project triangle.edges[1].plane, location, location\n                continue\n                    \n            if distanceC < 0\n                plane.project triangle.edges[2].plane, location, location\n                continue\n                \n        triangle\n        \n    module.exports = { load, constrain }","old_contents":"# navmesh\n\nNavmeshes are stored as \"MSN\" (MasSplat Navmesh) and are used to define where \nentities (including the player) can travel.  By default, they are unable to \nleave the surface, \"crawling\" over it.  Each tile is a 3D triangle.  A light \nAny two triangles sharing two vertices are joined and the edge formed may be \ncrossed from one to the other, otherwise, the edge is treated as a form of wall.\n\nMSN is a binary format.  It is comprised of:\n\n| Type    | Num.              | Description                                                |\n| ------- | ----------------- | ---------------------------------------------------------- |\n| uint16  | 1                 | The number of vertices defined.                            |\n| uint16  | 1                 | The number of triangles defined.                           |\n| float32 | 3x num. vertices  | The X, Y and Z of each vertex.                             |\n| uint16  | 3x num. triangles | The first, second and third vertex index of each triangle. |\n\n    file = require \".\/file.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n\n## load\n\n- filename: The \"real\" location of the MSN file to load.  (i.e. already \n            \"require\"-d)\n- callback: A callback to execute with the array of objects representing the\n            loaded objects on success, containing:\n            \n+ plane: A plane object for the surface of the triangle itself.\n+ vertices: An array of vectors specifying the locations of the vertices which\n            make up the triangle.\n+ edges: An array of three objects representing the edges of the triangle,\n       containing:\n  \n* neighbor: When null, there is no other triangle over this edge.  Otherwise\n            a reference to the triangle object which can be found over it.\n* plane: A plane facing inwards from the edge.  If this edge borders another\n         triangle, this will be aligned to both this triangle and the \n         neighbor.\n    \n    load = (path, callback) ->\n        file.arrayBuffer path, (response) ->\n            header = new Uint16Array response, 0, 2\n            vertexData = new Float32Array response, 4, header[0] * 3\n            indices = new Uint16Array response, 4 + header[0] * 4 * 3, header[1] * 3\n        \n            vertices = for i in [0...vertexData.length] by 3\n                [\n                    vertexData[i]\n                    vertexData[i + 1]\n                    vertexData[i + 2]\n                ]\n        \n            triangles = for i in [0...indices.length] by 3\n                plane: plane.fromTriangle vertices[indices[i]], vertices[indices[i + 1]], vertices[indices[i + 2]]\n                indices: [\n                    indices[i]\n                    indices[i + 1]\n                    indices[i + 2]\n                ]\n                vertices: [\n                    vertices[indices[i]]\n                    vertices[indices[i + 1]]\n                    vertices[indices[i + 2]]\n                ]\n        \n            for triangle in triangles\n                triangle.edges = for edge in [0...3]\n                    vertexA = triangle.indices[edge]\n                    vertexB = triangle.indices[(edge + 1) % 3]\n                    vertexC = []\n                    vector.add.vector vertices[vertexA], triangle.plane.normal, vertexC\n                    neighbor = null\n                    for other in triangles\n                        if triangle is other then continue\n                        if vertexA not in other.indices then continue\n                        if vertexB not in other.indices then continue\n                        neighbor = other\n                        vector.add.vector vertexC, other.plane.normal, vertexC\n                        break\n                    neighbor: neighbor\n                    plane: plane.fromTriangle vertices[vertexA], vertexC, vertices[vertexB]\n\n            callback triangles\n            return\n        return\n            \n## constrain\n\n- A vector specifying the location moved to.\n- A reference to the navmesh triangle which contained the location moved from.\n\nUpdates the location vector to take into account collision with navmesh triangle \nwalls and returns the new containing navmesh triangle.\n            \n    constrain = (location, triangle) ->\n        \n        for iterations in [0...25]\n            distanceA = plane.distance triangle.edges[0].plane, location\n            distanceB = plane.distance triangle.edges[1].plane, location\n            distanceC = plane.distance triangle.edges[2].plane, location\n            if distanceA >= 0 and distanceB >= 0 and distanceC >= 0 \n                break\n\n            if distanceA < 0 and triangle.edges[0].neighbor\n                triangle = triangle.edges[0].neighbor\n                continue\n                \n            if distanceB < 0 and triangle.edges[1].neighbor\n                triangle = triangle.edges[1].neighbor\n                continue\n                \n            if distanceC < 0 and triangle.edges[2].neighbor\n                triangle = triangle.edges[2].neighbor\n                continue\n            \n            if distanceA < 0 and distanceB < 0\n                vector.copy triangle.vertices[1], location\n                continue\n                \n            if distanceB < 0 and distanceC < 0\n                vector.copy triangle.vertices[2], location\n                continue\n                \n            if distanceC < 0 and distanceA < 0\n                vector.copy triangle.vertices[0], location\n                continue\n\n            if distanceA < 0\n                plane.project triangle.edges[0].plane, location, location\n                continue\n                \n            if distanceB < 0\n                plane.project triangle.edges[1].plane, location, location\n                continue\n                    \n            if distanceC < 0\n                plane.project triangle.edges[2].plane, location, location\n                continue\n                \n        plane.project triangle.plane, location, location\n        triangle\n        \n    module.exports = { load, constrain }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"057a2bdcfc7a4c5df526e6a991eeab0231c6997b","subject":"Fixed crash when entering the corner of a navmesh triangle.","message":"Fixed crash when entering the corner of a navmesh triangle.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat","old_file":"src\/navmesh.litcoffee","new_file":"src\/navmesh.litcoffee","new_contents":"# navmesh\n\nNavmeshes are stored as \"MSN\" (MasSplat Navmesh) and are used to define where \nentities (including the player) can travel.  By default, they are unable to \nleave the surface, \"crawling\" over it.  Each tile is a 3D triangle.  A light \nAny two triangles sharing two vertices are joined and the edge formed may be \ncrossed from one to the other, otherwise, the edge is treated as a form of wall.\n\nMSN is a binary format.  It is comprised of:\n\n| Type    | Num.              | Description                                                |\n| ------- | ----------------- | ---------------------------------------------------------- |\n| uint16  | 1                 | The number of vertices defined.                            |\n| uint16  | 1                 | The number of triangles defined.                           |\n| float32 | 3x num. vertices  | The X, Y and Z of each vertex.                             |\n| uint16  | 3x num. triangles | The first, second and third vertex index of each triangle. |\n\n    file = require \".\/file.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n\n## load\n\n- filename: The \"real\" location of the MSN file to load.  (i.e. already \n            \"require\"-d)\n- callback: A callback to execute with the array of objects representing the\n            loaded objects on success, containing:\n            \n+ plane: A plane object for the surface of the triangle itself.\n+ vertices: An array of vectors specifying the locations of the vertices which\n            make up the triangle.\n+ edges: An array of three objects representing the edges of the triangle,\n       containing:\n  \n* neighbor: When null, there is no other triangle over this edge.  Otherwise\n            a reference to the triangle object which can be found over it.\n* plane: A plane facing inwards from the edge.  If this edge borders another\n         triangle, this will be aligned to both this triangle and the \n         neighbor.\n    \n    load = (path, callback) ->\n        file.arrayBuffer path, (response) ->\n            header = new Uint16Array response, 0, 2\n            vertexData = new Float32Array response, 4, header[0] * 3\n            indices = new Uint16Array response, 4 + header[0] * 4 * 3, header[1] * 3\n        \n            vertices = for i in [0...vertexData.length] by 3\n                [\n                    vertexData[i]\n                    vertexData[i + 1]\n                    vertexData[i + 2]\n                ]\n        \n            triangles = for i in [0...indices.length] by 3\n                plane: plane.fromTriangle vertices[indices[i]], vertices[indices[i + 1]], vertices[indices[i + 2]]\n                indices: [\n                    indices[i]\n                    indices[i + 1]\n                    indices[i + 2]\n                ]\n                vertices: [\n                    vertices[indices[i]]\n                    vertices[indices[i + 1]]\n                    vertices[indices[i + 2]]\n                ]\n        \n            for triangle in triangles\n                triangle.edges = for edge in [0...3]\n                    vertexA = triangle.indices[edge]\n                    vertexB = triangle.indices[(edge + 1) % 3]\n                    vertexC = []\n                    vector.add.vector vertices[vertexA], triangle.plane.normal, vertexC\n                    neighbor = null\n                    for other in triangles\n                        if triangle is other then continue\n                        if vertexA not in other.indices then continue\n                        if vertexB not in other.indices then continue\n                        neighbor = other\n                        vector.add.vector vertexC, other.plane.normal, vertexC\n                        break\n                    neighbor: neighbor\n                    plane: plane.fromTriangle vertices[vertexA], vertexC, vertices[vertexB]\n\n            callback triangles\n            return\n        return\n            \n## constrain\n\nCall with an object containing:\n\n- location: An array of three numbers specifying the X, Y and Z moved to.\n- triangle: A reference to the triangle the entity is currently in.\n    \nThis will modify these properties to constrain the entity to the surface of the \nnavmesh.\n            \n    constrain = (obj) ->\n        \n        for iterations in [0...25]\n            distanceA = plane.distance obj.triangle.edges[0].plane, obj.location\n            distanceB = plane.distance obj.triangle.edges[1].plane, obj.location\n            distanceC = plane.distance obj.triangle.edges[2].plane, obj.location\n            if distanceA >= 0 and distanceB >= 0 and distanceC >= 0 \n                break\n\n            if distanceA < 0 and obj.triangle.edges[0].neighbor\n                obj.triangle = obj.triangle.edges[0].neighbor\n                continue\n                \n            if distanceB < 0 and obj.triangle.edges[1].neighbor\n                obj.triangle = obj.triangle.edges[1].neighbor\n                continue\n                \n            if distanceC < 0 and obj.triangle.edges[2].neighbor\n                obj.triangle = obj.triangle.edges[2].neighbor\n                continue\n            \n            if distanceA < 0 and distanceB < 0\n                vector.copy obj.triangle.vertices[1], obj.location\n                continue\n                \n            if distanceB < 0 and distanceC < 0\n                vector.copy obj.triangle.vertices[2], obj.location\n                continue\n                \n            if distanceC < 0 and distanceA < 0\n                vector.copy obj.triangle.vertices[0], obj.location\n                continue\n\n            if distanceA < 0\n                plane.project obj.triangle.edges[0].plane, obj.location, obj.location\n                continue\n                \n            if distanceB < 0\n                plane.project obj.triangle.edges[1].plane, obj.location, obj.location\n                continue\n                    \n            if distanceC < 0\n                plane.project obj.triangle.edges[2].plane, obj.location, obj.location\n                continue\n                \n        plane.project obj.triangle.plane, obj.location, obj.location\n        return        \n        \n    module.exports = { load, constrain }","old_contents":"# navmesh\n\nNavmeshes are stored as \"MSN\" (MasSplat Navmesh) and are used to define where \nentities (including the player) can travel.  By default, they are unable to \nleave the surface, \"crawling\" over it.  Each tile is a 3D triangle.  A light \nAny two triangles sharing two vertices are joined and the edge formed may be \ncrossed from one to the other, otherwise, the edge is treated as a form of wall.\n\nMSN is a binary format.  It is comprised of:\n\n| Type    | Num.              | Description                                                |\n| ------- | ----------------- | ---------------------------------------------------------- |\n| uint16  | 1                 | The number of vertices defined.                            |\n| uint16  | 1                 | The number of triangles defined.                           |\n| float32 | 3x num. vertices  | The X, Y and Z of each vertex.                             |\n| uint16  | 3x num. triangles | The first, second and third vertex index of each triangle. |\n\n    file = require \".\/file.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n\n## load\n\n- filename: The \"real\" location of the MSN file to load.  (i.e. already \n            \"require\"-d)\n- callback: A callback to execute with the array of objects representing the\n            loaded objects on success, containing:\n            \n+ plane: A plane object for the surface of the triangle itself.\n+ edges: An array of three objects representing the edges of the triangle,\n       containing:\n  \n* neighbor: When null, there is no other triangle over this edge.  Otherwise\n            a reference to the triangle object which can be found over it.\n* plane: A plane facing inwards from the edge.  If this edge borders another\n         triangle, this will be aligned to both this triangle and the \n         neighbor.\n    \n    load = (path, callback) ->\n        file.arrayBuffer path, (response) ->\n            header = new Uint16Array response, 0, 2\n            vertexData = new Float32Array response, 4, header[0] * 3\n            indices = new Uint16Array response, 4 + header[0] * 4 * 3, header[1] * 3\n        \n            vertices = for i in [0...vertexData.length] by 3\n                [\n                    vertexData[i]\n                    vertexData[i + 1]\n                    vertexData[i + 2]\n                ]\n        \n            triangles = for i in [0...indices.length] by 3\n                plane: plane.fromTriangle vertices[indices[i]], vertices[indices[i + 1]], vertices[indices[i + 2]]\n                indices: [\n                    indices[i]\n                    indices[i + 1]\n                    indices[i + 2]\n                ]\n        \n            for triangle in triangles\n                triangle.edges = for edge in [0...3]\n                    vertexA = triangle.indices[edge]\n                    vertexB = triangle.indices[(edge + 1) % 3]\n                    vertexC = []\n                    vector.add.vector vertices[vertexA], triangle.plane.normal, vertexC\n                    neighbor = null\n                    for other in triangles\n                        if triangle is other then continue\n                        if vertexA not in other.indices then continue\n                        if vertexB not in other.indices then continue\n                        neighbor = other\n                        vector.add.vector vertexC, other.plane.normal, vertexC\n                        break\n                    neighbor: neighbor\n                    plane: plane.fromTriangle vertices[vertexA], vertexC, vertices[vertexB]\n\n            callback triangles\n            return\n        return\n            \n## constrain\n\nCall with an object containing:\n\n- location: An array of three numbers specifying the X, Y and Z moved to.\n- triangle: A reference to the triangle the entity is currently in.\n    \nThis will modify these properties to constrain the entity to the surface of the \nnavmesh.\n            \n    constrain = (obj) ->\n        \n        for iterations in [0...25]\n            distanceA = plane.distance obj.triangle.edges[0].plane, obj.location\n            distanceB = plane.distance obj.triangle.edges[1].plane, obj.location\n            distanceC = plane.distance obj.triangle.edges[2].plane, obj.location\n            if distanceA >= 0 and distanceB >= 0 and distanceC >= 0 \n                break\n\n            if distanceA < 0 and obj.triangle.edges[0].neighbor\n                obj.triangle = obj.triangle.edges[0].neighbor\n                continue\n                \n            if distanceB < 0 and obj.triangle.edges[1].neighbor\n                obj.triangle = obj.triangle.edges[1].neighbor\n                continue\n                \n            if distanceC < 0 and obj.triangle.edges[2].neighbor\n                obj.triangle = obj.triangle.edges[2].neighbor\n                continue\n            \n            if distanceA < 0 and distanceB < 0\n                vector.copy vertices[obj.triangle.indices[1]], obj.location\n                continue\n                \n            if distanceB < 0 and distanceC < 0\n                vector.copy vertices[obj.triangle.indices[2]], obj.location\n                continue\n                \n            if distanceC < 0 and distanceA < 0\n                vector.copy vertices[obj.triangle.indices[0]], obj.location\n                continue\n\n            if distanceA < 0\n                plane.project obj.triangle.edges[0].plane, obj.location, obj.location\n                continue\n                \n            if distanceB < 0\n                plane.project obj.triangle.edges[1].plane, obj.location, obj.location\n                continue\n                    \n            if distanceC < 0\n                plane.project obj.triangle.edges[2].plane, obj.location, obj.location\n                continue\n                \n        plane.project obj.triangle.plane, obj.location, obj.location\n        return        \n        \n    module.exports = { load, constrain }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"45904a0026372574a59139cc19f1a767bb9ca401","subject":"adds parens","message":"adds parens\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occured within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal name: \"Talia al Ghul\", notorious: true\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal name: \"Dr. Jonathan Crane\", notorious: false\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occured within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"efad0ad945dcc4f000e877b0b25010929be1baa7","subject":"Did a few things:","message":"Did a few things:\n\n1. Some variable renaming\/whitespace cleanup\n2. Reworked dependency hydration and method invocation\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: =>\n        proto = @.__proto__\n        name  = proto.constructor.name\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          for prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if typeof body == 'function' || typeof body.behavior == 'function'\n                proto._do_wrap proto, prop\n\n                INITIALIZERS name, prop if prop[0] == '$'\n\n          proto = proto.__proto__\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (done) =>\n        proto  = @.__proto__\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos, (p, next) =>\n          if p.deps?\n            p._do_hydrate p, p.deps, next\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.constructor.name == 'Madul'\n\n          proto = proto.__super__\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            @[initer.execute]().then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        @_call_initializers_for name, =>\n          if listeners[name]?\n            async.each listeners[name], (listener, next) =>\n              listener @\n              next()\n            , => @_register_initialized name\n          else\n            @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              @[initializer.fn]()\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.MADUL_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    WRAPPED = { }\n\n    _INITIALIZERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                val\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                val\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before) if proto[method].before?\n            decs = decs.concat(proto[method].after)  if proto[method].after?\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              out = undefined\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      proto[val].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      proto[val].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then => q.all me.before.map (b) => proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  out = result\n                  q.all me.after.map (b) => b.after out\n                .then          => def.resolve out\n                .catch   (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: =>\n        proto = @.__proto__\n        name  = proto.constructor.name\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          for method, body of proto\n            if method[0]                  != '_'         &&\n               (\n                typeof body.behavior       == 'function' ||\n                typeof body                == 'function'\n               ) &&\n               typeof proto[\"_#{method}\"] == 'undefined' &&\n               WRAP(name, method)         == true\n\n              proto._do_wrap proto, method\n\n              INITIALIZERS name, method if method[0] == '$'\n\n          proto = proto.__proto__\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (done) =>\n        proto  = @.__proto__\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos, (p, next) =>\n          if p.deps?\n            p._do_hydrate p, p.deps, next\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, initer, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.constructor.name == 'Madul'\n\n          proto = proto.__super__\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then (mod) =>\n              if initer?\n                mod[initer]()\n                  .then => callback mod\n              else\n                callback mod\n        else\n          callback mod\n\n      _load: (me, name, initer, path, loaded) =>\n        me._init_if_madul path, initer, (mod) =>\n          me._make_available name, mod\n          loaded()\n\n      _check: (me, path, dep, ref, initer, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, initer, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, initer, depth, => me._do_add me, dep, ref, next\n                else\n                  next()\n            , finished\n\n      _add_dependency: (me, name, mod) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", name\n\n        me[underscore name] = mod\n\n      _do_add: (me, name, ref, next) =>\n        me._add_dependency me, ref, available[strip name]\n        next()\n\n      _add: (me, name, ref, initer, path, next) =>\n        me._init_if_madul path, initer, (mod) =>\n          me._make_available name, mod\n          me._do_add me, name, ref, next\n\n      _do_hydrate: (proto, deps, callback) =>\n        async.each deps, (d, next) =>\n          name, alias, initer = undefined\n          tokens = d.split '->'\n\n          if tokens.length == 2\n            alias = tokens[0]\n            t     = tokens[1].split '::'\n\n            if t.length == 2\n              name   = t[0]\n              initer = t[1]\n            else\n              name = t[0]\n          else\n            name = alias = tokens[0]\n\n          ref = alias || name\n\n          if proto[underscore ref]? == false\n            if available[strip name]? == true\n              proto._do_add proto, name, ref, next\n            else\n              try\n                proto._add proto, name, ref, initer, d, next\n              catch e\n                cwd = process.cwd()\n                pkg = \"#{cwd}\/node_modules\/#{d}\/package.json\"\n\n                fs.stat pkg, (err, stat) =>\n                  if stat?.isFile()\n                    fs.readFile pkg, 'utf8', (err, data) =>\n                      json = JSON.parse data\n                      main = json.main || json._main || 'index.js'\n                      path = \"#{cwd}\/node_modules\/#{d}\/#{main}\"\n\n                      proto._add proto, name, ref, initer, path, next\n                  else\n                    proto._check proto, \"#{cwd}\/#{code_root}\", d, ref, initer next\n          else\n            next()\n        , callback\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        @_call_initializers_for name, =>\n          if listeners[name]?\n            async.each listeners[name], (listener, next) =>\n              listener @\n              next()\n            , => @_register_initialized name\n          else\n            @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              @[initializer.fn]()\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e6af4c556f5fdf54bdd5e12faf62aff1610aa054","subject":"Doc configalter invo","message":"Doc configalter invo\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-config\/index.litcoffee","new_file":"packages\/shrub-config\/index.litcoffee","new_contents":"# Configuration\n\n*Gathers configuration and serves it as an Angular module for clients.*\n\n    _ = require 'lodash'\n    Promise = require 'bluebird'\n    url = require 'url'\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    {Config} = require 'client\/modules\/config'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `assetMiddleware`.\n\n      registrar.registerHook 'assetMiddleware', ->\n\n        label: 'Config'\n        middleware: [\n\n          (assets, next) ->\n\n            assets.scripts.push '\/js\/config.js'\n\n            next()\n\n        ]\n\n#### Implements hook `httpMiddleware`.\n\n      registrar.registerHook 'httpMiddleware', (http) ->\n\n        label: 'Serve package configuration'\n        middleware: [\n\nServe the configuration module.\n\n          (req, res, next) ->\n\nOnly if the path matches.\n\n            return next() unless req.url is '\/js\/config.js'\n\n            exports.renderPackageConfig(req).then((code) ->\n\nEmit the configuration module.\n\n              res.setHeader 'Content-Type', 'text\/javascript'\n              res.send code\n\n            ).catch next\n\n        ]\n\n## shrub-config.renderPackageConfig\n\n* (http.IncomingRequest) `req` - The request object.\n\nUSe a client's request object to render configuration.\n\n    exports.renderPackageConfig = (req) ->\n\n#### Invoke hook `config`.\n\nAllows packages to specify configuration that will be sent to the client.\nImplementations may return an object, or a promise that resolves to an object.\n\n      subconfigs = pkgman.invoke 'config', req\n\n      Promise.all(\n\n        promise for path, promise of subconfigs\n\n      ).then (fulfilledSubconfigs) ->\n\n        config_ = new Config()\n\nPackage-independent...\n\n        config_.set 'packageList', config.get 'packageList'\n\nMerge in the subconfigs.\n\n        index = 0\n        for path of subconfigs\n\n          subconfig = fulfilledSubconfigs[index++]\n          for key, value of subconfig\n            continue unless value?\n\n###### TODO: Multiline\n\n            config_.set \"packageConfig:#{path.replace \/\\\/\/g, ':'}:#{key.replace \/\\\/\/g, ':'}\", value\n\n#### Invoke hook `configAlter`.\n\n        pkgman.invoke 'configAlter', req, config_\n\nFormat the configuration to look nice.\n\n        prettyPrintConfig = ->\n\n          jsonArgs = [config_]\n\n          if 'production' isnt config.get 'NODE_ENV'\n            jsonArgs = jsonArgs.concat [null, '  ']\n\n          stringified = JSON.stringify jsonArgs...\n          [first, rest...] = stringified.split '\\n'\n          ([first].concat rest.map (line) -> '    ' + line).join '\\n'\n\n        \"\"\"\n    angular.module('shrub.config', ['shrub.require']).config([\n      'shrub-requireProvider', function(requireProvider) {\n        requireProvider.require('config').from(#{prettyPrintConfig()});\n      }\n    ]);\n      \"\"\"\n","old_contents":"# Configuration\n\n*Gathers configuration and serves it as an Angular module for clients.*\n\n    _ = require 'lodash'\n    Promise = require 'bluebird'\n    url = require 'url'\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    {Config} = require 'client\/modules\/config'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `assetMiddleware`.\n\n      registrar.registerHook 'assetMiddleware', ->\n\n        label: 'Config'\n        middleware: [\n\n          (assets, next) ->\n\n            assets.scripts.push '\/js\/config.js'\n\n            next()\n\n        ]\n\n#### Implements hook `httpMiddleware`.\n\n      registrar.registerHook 'httpMiddleware', (http) ->\n\n        label: 'Serve package configuration'\n        middleware: [\n\nServe the configuration module.\n\n          (req, res, next) ->\n\nOnly if the path matches.\n\n            return next() unless req.url is '\/js\/config.js'\n\n            exports.renderPackageConfig(req).then((code) ->\n\nEmit the configuration module.\n\n              res.setHeader 'Content-Type', 'text\/javascript'\n              res.send code\n\n            ).catch next\n\n        ]\n\n## shrub-config.renderPackageConfig\n\n* (http.IncomingRequest) `req` - The request object.\n\nUSe a client's request object to render configuration.\n\n    exports.renderPackageConfig = (req) ->\n\n#### Invoke hook `config`.\n\nAllows packages to specify configuration that will be sent to the client.\nImplementations may return an object, or a promise that resolves to an object.\n\n      subconfigs = pkgman.invoke 'config', req\n\n      Promise.all(\n\n        promise for path, promise of subconfigs\n\n      ).then (fulfilledSubconfigs) ->\n\n        config_ = new Config()\n\nPackage-independent...\n\n        config_.set 'packageList', config.get 'packageList'\n\nMerge in the subconfigs.\n\n        index = 0\n        for path of subconfigs\n\n          subconfig = fulfilledSubconfigs[index++]\n          for key, value of subconfig\n            continue unless value?\n\n###### TODO: Multiline\n\n            config_.set \"packageConfig:#{path.replace \/\\\/\/g, ':'}:#{key.replace \/\\\/\/g, ':'}\", value\n\n        pkgman.invoke 'configAlter', req, config_\n\nFormat the configuration to look nice.\n\n        prettyPrintConfig = ->\n\n          jsonArgs = [config_]\n\n          if 'production' isnt config.get 'NODE_ENV'\n            jsonArgs = jsonArgs.concat [null, '  ']\n\n          stringified = JSON.stringify jsonArgs...\n          [first, rest...] = stringified.split '\\n'\n          ([first].concat rest.map (line) -> '    ' + line).join '\\n'\n\n        \"\"\"\n    angular.module('shrub.config', ['shrub.require']).config([\n      'shrub-requireProvider', function(requireProvider) {\n        requireProvider.require('config').from(#{prettyPrintConfig()});\n      }\n    ]);\n      \"\"\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"08181a931f98889cdb7575b7071953067f1d420b","subject":"Update callback documentation","message":"Update callback documentation\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/cache.litcoffee","new_file":"coffee\/cache.litcoffee","new_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### Todo\n\n* [ ] Handle undefined values (@starefossen)\n\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      getFilter : getFilter\n      filterData: filterData\n      getDoc    : getDoc\n      set       : set\n      get       : get\n      setForType: setForType\n      getForType: getForType\n\n","old_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n### Todo\n\n* [ ] Handle undefined values.\n\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if lookup failed; otherwise `null`.\n* `Object` doc - filtered document if found; otherwise `null`.\n\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis write failed; otherwise `null`.\n* `Object` data - the original data as it was stored in Redis.\n\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function\n\n### Callback\n\n#### Params\n\n* `Error` err -  error object if Redis lookup failed, otherwise `null`.\n* `Object` data - data retrieved from Redis if found; otherwise `null`.\n\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the filtered data object as it was stored in Redis.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the data object returned from Redis or Mongodb.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      getFilter : getFilter\n      filterData: filterData\n      getDoc    : getDoc\n      set       : set\n      get       : get\n      setForType: setForType\n      getForType: getForType\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8f90ef4b093dad2ff74d63cdad6237b0e907564a","subject":"Angular still uses the promise notification API in some places, so here is some hacked-in support for it","message":"Angular still uses the promise notification API in some places, so here is some hacked-in support for it\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-angular\/client\/index.litcoffee","new_file":"packages\/shrub-angular\/client\/index.litcoffee","new_contents":"# Angular\n\n*Coordinate various core functionality.*\n\n    _ = require 'lodash'\n    Promise = require 'bluebird'\n\n    config = require 'config'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularAHrefSanitizationWhitelist`.\n\n      registrar.registerHook 'shrubAngularAHrefSanitizationWhitelist', -> [\n\nAllow more protocols.\n\n        '(?:https?|ftp|mailto|tel|file):'\n\nAllow javascript:void(0).\n\n        'javascript:void\\\\(0\\\\)'\n      ]\n\n#### Implements hook `shrubAngularAppConfig`.\n\n      registrar.registerHook 'shrubAngularAppConfig', -> [\n        '$compileProvider', '$injector', '$provide', '$routeProvider', '$locationProvider', 'shrub-pkgmanProvider'\n        ($compileProvider, $injector, $provide, $routeProvider, $locationProvider, pkgmanProvider) ->\n\n#### Invoke hook `shrubAngularAHrefSanitizationWhitelist`.\n\n          regexes = []\n          for regexes_ in pkgmanProvider.invokeFlat(\n            'shrubAngularAHrefSanitizationWhitelist'\n          )\n            regexes.push regex for regex in regexes_\n\n          $compileProvider.aHrefSanitizationWhitelist new RegExp(\n            \"^\\s*(?:#{regexes.join '|'})\"\n          )\n\n          unless config.get 'packageConfig:shrub-core:testMode'\n            $compileProvider.debugInfoEnabled false\n\nCompletely override $q with Bluebird, because it's awesome.\n\n###### TODO: Angular also implements a private service called $$q used for animation. We should override that one, too.\n\n          $provide.decorator '$q', [\n            '$rootScope', '$exceptionHandler'\n            ($rootScope, $exceptionHandler) ->\n\n              Promise.onPossiblyUnhandledRejection (error) ->\n\n$timeout and $interval will throw this for cancellation. It's non-notable.\n\n                return if 'canceled' is error.message\n\n                $exceptionHandler error\n\nHook Bluebird's schedule up to Angular.\n\n              Promise.setScheduler (fn) -> $rootScope.$evalAsync fn\n\n## Promise.defer\n\nSee: https:\/\/docs.angularjs.org\/api\/ng\/service\/$q#the-deferred-api\n\n              Promise.defer = ->\n                resolve = null\n                reject = null\n\n                promise = new Promise ->\n                  resolve = arguments[0]\n                  reject = arguments[1]\n\nAngular depends on notify, which is a crap API. We'll hack support for it in.\n\n                __notifications = []\n                proxyThen = promise.then\n                promise.then = ->\n                  args = (arg for arg in arguments)\n                  __notifications.push args[2] if args[2]?\n                  proxyThen.apply promise, args\n                notify: (args...) -> fn args... for fn in __notifications\n\n                promise: promise\n                resolve: resolve\n                reject: reject\n\n## Promise.when\n\nSee: https:\/\/docs.angularjs.org\/api\/ng\/service\/$q#when\n\n              Promise.when = (value, handlers...) ->\n                Promise.cast(value).then handlers...\n\nProxy Promise.all because Angular supports passing in an object where the\nvalues are promises, and the result is an object keyed with the resolved\nvalues from the promise.\n\n              originalAll = Promise.all\n              Promise.all = (promises) ->\n\nDefer to Bluebird unless it's an object.\n\n                return originalAll promises unless angular.isObject(\n                  promises\n                )\n\nTrack the keys so we can map the values.\n\n                promiseKeys = []\n                promiseArray = for key, promise of promises\n                  promiseKeys.push key\n                  promise\n\n                originalAll(promiseArray).then (results) ->\n                  objectResult = {}\n\n                  for result, index in results\n                    objectResult[promiseKeys[index]] = result\n\n                  objectResult\n\n              Promise\n\n          ]\n\n#### Invoke hook `shrubAngularRoutes`.\n\nAllow packages to define routes in the Angular application.\n\n          routes = {}\n          for route in _.flatten pkgmanProvider.invokeFlat 'shrubAngularRoutes'\n            routes[route.path ? path] = route\n\nInvoke hook `shrubAngularRoutesAlter`.\n\nAllow packages to alter defined routes.\n\n          $injector.invoke(\n            injectable, null\n            routes: routes\n          ) for injectable in pkgmanProvider.invokeFlat 'shrubAngularRoutesAlter'\n\n          for path, route of routes\n            do (path, route) ->\n\nWrap the controller so we can provide some automatic behavior.\n\n              routeController = route.controller\n              route.controller = [\n                '$controller', '$injector', '$q', '$scope'\n                ($controller, $injector, $q, $scope) ->\n\n                  unless routeController?\n                    return $scope.$emit 'shrub.core.routeRendered'\n\nControllers may return a promise, so wait until any returned value fulfills.\nIf it's not a promise, this will be in the next tick.\n\n                  $q.when($injector.invoke(\n                    routeController, null\n                    $scope: $scope\n                    route: route\n                  )).then(-> $scope.$emit 'shrub.core.routeRendered').done()\n\n              ]\n\n              route.template ?= ' '\n\nRegister the path into Angular.\n\n              $routeProvider.when \"\/#{route.path ? path}\", route\n\nCreate a unique entry point.\n\n          $routeProvider.when '\/shrub-angular-entry-point', {}\n\nTurn on HTML5 mode: \"Real\" URLs.\n\n          $locationProvider.html5Mode true\n      ]\n","old_contents":"# Angular\n\n*Coordinate various core functionality.*\n\n    _ = require 'lodash'\n    Promise = require 'bluebird'\n\n    config = require 'config'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularAHrefSanitizationWhitelist`.\n\n      registrar.registerHook 'shrubAngularAHrefSanitizationWhitelist', -> [\n\nAllow more protocols.\n\n        '(?:https?|ftp|mailto|tel|file):'\n\nAllow javascript:void(0).\n\n        'javascript:void\\\\(0\\\\)'\n      ]\n\n#### Implements hook `shrubAngularAppConfig`.\n\n      registrar.registerHook 'shrubAngularAppConfig', -> [\n        '$compileProvider', '$injector', '$provide', '$routeProvider', '$locationProvider', 'shrub-pkgmanProvider'\n        ($compileProvider, $injector, $provide, $routeProvider, $locationProvider, pkgmanProvider) ->\n\n#### Invoke hook `shrubAngularAHrefSanitizationWhitelist`.\n\n          regexes = []\n          for regexes_ in pkgmanProvider.invokeFlat(\n            'shrubAngularAHrefSanitizationWhitelist'\n          )\n            regexes.push regex for regex in regexes_\n\n          $compileProvider.aHrefSanitizationWhitelist new RegExp(\n            \"^\\s*(?:#{regexes.join '|'})\"\n          )\n\n          unless config.get 'packageConfig:shrub-core:testMode'\n            $compileProvider.debugInfoEnabled false\n\nCompletely override $q with Bluebird, because it's awesome.\n\n###### TODO: Angular also implements a private service called $$q used for animation. We should override that one, too.\n\n          $provide.decorator '$q', [\n            '$rootScope', '$exceptionHandler'\n            ($rootScope, $exceptionHandler) ->\n\n              Promise.onPossiblyUnhandledRejection (error) ->\n\n$timeout and $interval will throw this for cancellation. It's non-notable.\n\n                return if 'canceled' is error.message\n\n                $exceptionHandler error\n\nHook Bluebird's schedule up to Angular.\n\n              Promise.setScheduler (fn) -> $rootScope.$evalAsync fn\n\n## Promise.defer\n\nSee: https:\/\/docs.angularjs.org\/api\/ng\/service\/$q#the-deferred-api\n\n              Promise.defer = ->\n                resolve = null\n                reject = null\n\n                promise = new Promise ->\n                  resolve = arguments[0]\n                  reject = arguments[1]\n\n                promise: promise\n                resolve: resolve\n                reject: reject\n\n## Promise.when\n\nSee: https:\/\/docs.angularjs.org\/api\/ng\/service\/$q#when\n\n              Promise.when = (value, handlers...) ->\n                Promise.cast(value).then handlers...\n\nProxy Promise.all because Angular supports passing in an object where the\nvalues are promises, and the result is an object keyed with the resolved\nvalues from the promise.\n\n              originalAll = Promise.all\n              Promise.all = (promises) ->\n\nDefer to Bluebird unless it's an object.\n\n                return originalAll promises unless angular.isObject(\n                  promises\n                )\n\nTrack the keys so we can map the values.\n\n                promiseKeys = []\n                promiseArray = for key, promise of promises\n                  promiseKeys.push key\n                  promise\n\n                originalAll(promiseArray).then (results) ->\n                  objectResult = {}\n\n                  for result, index in results\n                    objectResult[promiseKeys[index]] = result\n\n                  objectResult\n\n              Promise\n\n          ]\n\n#### Invoke hook `shrubAngularRoutes`.\n\nAllow packages to define routes in the Angular application.\n\n          routes = {}\n          for route in _.flatten pkgmanProvider.invokeFlat 'shrubAngularRoutes'\n            routes[route.path ? path] = route\n\nInvoke hook `shrubAngularRoutesAlter`.\n\nAllow packages to alter defined routes.\n\n          $injector.invoke(\n            injectable, null\n            routes: routes\n          ) for injectable in pkgmanProvider.invokeFlat 'shrubAngularRoutesAlter'\n\n          for path, route of routes\n            do (path, route) ->\n\nWrap the controller so we can provide some automatic behavior.\n\n              routeController = route.controller\n              route.controller = [\n                '$controller', '$injector', '$q', '$scope'\n                ($controller, $injector, $q, $scope) ->\n\n                  unless routeController?\n                    return $scope.$emit 'shrub.core.routeRendered'\n\nControllers may return a promise, so wait until any returned value fulfills.\nIf it's not a promise, this will be in the next tick.\n\n                  $q.when($injector.invoke(\n                    routeController, null\n                    $scope: $scope\n                    route: route\n                  )).then(-> $scope.$emit 'shrub.core.routeRendered').done()\n\n              ]\n\n              route.template ?= ' '\n\nRegister the path into Angular.\n\n              $routeProvider.when \"\/#{route.path ? path}\", route\n\nCreate a unique entry point.\n\n          $routeProvider.when '\/shrub-angular-entry-point', {}\n\nTurn on HTML5 mode: \"Real\" URLs.\n\n          $locationProvider.html5Mode true\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"57b92b7451327a02003b5bd706245fe4ff4ba93a","subject":"Fix order of success and failure callbacks for this call to _load_from_package_json","message":"Fix order of success and failure callbacks for this call to _load_from_package_json\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push e\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = e\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        proto._report method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err.message\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.Promise (resolve, reject) =>\n                  async.eachSeries me.validators, (v, next) =>\n                    arg       = Object.keys(v)[0]\n                    validator = v[arg]\n                    input     = arg\n                    prop      = args\n\n                    for a in arg.split '.'\n                      prop  = prop[a]\n                      input = a\n\n                    if Array.isArray validator\n                      async.eachSeries validator, (v, nxt) =>\n                        proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                        proto[v].EXECUTE.call proto[v], input, prop\n                          .then nxt\n                          .catch handle_err v, { \"#{input}\": prop }, nxt, reject\n                      , next\n                    else\n                      proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                      proto[validator].EXECUTE.call proto[validator], input, prop\n                        .then next\n                        .catch handle_err v, { \"#{input}\": prop }, next, reject\n                  , resolve\n                .then =>\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries before, (b, next) =>\n                      proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                      proto[b].before.call proto[b], args\n                        .then next\n                        .catch handle_err b, args, next, reject\n                    , resolve\n                .then =>\n                  input = proto._prep_invocation proto, method, args, def\n\n                  try\n                    me.behavior.apply me, input\n                  catch e\n                    failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                    me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                    failed e.message\n                .then (result) =>\n                  q.Promise (resolve, reject) =>\n                    if after.length > 0\n                      async.eachSeries after, (a, next) =>\n                        proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                        proto[a].after.call proto[a], result\n                          .then next\n                          .catch handle_err b, args, next, reject\n                      , => resolve result\n                    else\n                      process.nextTick => resolve result\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n\n              INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n              wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, next\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        error = true\n\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) =>\n                    error = undefined\n                    me._do_add me, ref, next\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, nxt, =>\n                    stop = new Error()\n                    stop.break = true\n\n                    next()\n                    nxt stop\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push e\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = e\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        proto._report method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err.message\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.Promise (resolve, reject) =>\n                  async.eachSeries me.validators, (v, next) =>\n                    arg       = Object.keys(v)[0]\n                    validator = v[arg]\n                    input     = arg\n                    prop      = args\n\n                    for a in arg.split '.'\n                      prop  = prop[a]\n                      input = a\n\n                    if Array.isArray validator\n                      async.eachSeries validator, (v, nxt) =>\n                        proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                        proto[v].EXECUTE.call proto[v], input, prop\n                          .then nxt\n                          .catch handle_err v, { \"#{input}\": prop }, nxt, reject\n                      , next\n                    else\n                      proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                      proto[validator].EXECUTE.call proto[validator], input, prop\n                        .then next\n                        .catch handle_err v, { \"#{input}\": prop }, next, reject\n                  , resolve\n                .then =>\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries before, (b, next) =>\n                      proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                      proto[b].before.call proto[b], args\n                        .then next\n                        .catch handle_err b, args, next, reject\n                    , resolve\n                .then =>\n                  input = proto._prep_invocation proto, method, args, def\n\n                  try\n                    me.behavior.apply me, input\n                  catch e\n                    failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                    me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                    failed e.message\n                .then (result) =>\n                  q.Promise (resolve, reject) =>\n                    if after.length > 0\n                      async.eachSeries after, (a, next) =>\n                        proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                        proto[a].after.call proto[a], result\n                          .then next\n                          .catch handle_err b, args, next, reject\n                      , => resolve result\n                    else\n                      process.nextTick => resolve result\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n\n              INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n              wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, next\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        error = true\n\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) =>\n                    error = undefined\n                    me._do_add me, ref, next\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    stop = new Error()\n                    stop.break = true\n\n                    next()\n                    nxt stop\n                  , nxt\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ece29c012d24fdbee778e8e4f43f151e57a4c40a","subject":"modify README","message":"modify README\n","repos":"CureApp\/loopback-with-admin","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\n\n# install\n\n```bash\nnpm install loopback-with-domain\n```\n\n\n# run\n\nbefore running, you can prepare a directory which contains custom config information.\n\n\n```text\n(config-dir) # any name is acceptable\n|-- model-definitions.coffee\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    configDir = '\/path\/to\/config-dir'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    lbWithDomain.runWithDomain(domain, configDir).then ->\n        # loopback started\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-values\/non-model-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|-----------------------\n memory      | on memory datasource\n db          | datasource for domain entities\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n# model definitions\n\n    module.exports =\n        player: # model name\n            base: 'User'  # the same as loopback model settings.base\n            aclType: 'admin' # specific for this system\n\n        instrument:\n            aclType: 'owner-read'\n\n\n\nthe same format as [loopback model definition](http:\/\/docs.strongloop.com\/display\/public\/LB\/Customizing+models)\nexcept \"aclType\" value.\nname, base, relations and properties are automatically set from domain information.\n\n## aclType\nloopback-with-domain generates acls from aclType.\n\nthree types are available.\n\n aclType     | meaning\n-------------|-----------------------------------------------------\n admin       | only admin can CRUD the model\n owner       | admin and the owner of the model can CRUD\n public-read | everyone can READ the model and admin can CRUD\n\n\n# switching environment\n\nrunning script with environment variable \"NODE\\_ENV\" like\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\n\"development\" is selected by default.\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-domain selects configs in \"local\" directory.\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    lbWithDomain.runWithDomain(domain, configDir, env)\n\nenv is prior to NODE\\_ENV settings.\n\n# modified loopback-datasource-juggler\n\nusing [CureApp\/loopback-datasource-juggler](https:\/\/github.com\/CureApp\/loopback-datasource-juggler).\n\nthis repository is almost the same as original one except 'memory' connector handles id as string\n(orignally integer).\n","old_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\n\n# install\n\n```\nnpm install loopback-with-domain\n```\n\n\n# run\n\nbefore running, you can prepare a directory which contains custom config information.\n\n\n```text\n(config-dir) # any name is acceptable\n|-- model-definitions.coffee\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    configDir = '\/path\/to\/config-dir'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    lbWithDomain.runWithDomain(domain, configDir).then ->\n        # loopback started\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-values\/non-model-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|-----------------------\n memory      | on memory datasource\n db          | datasource for domain entities\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n# model definitions\n\n    module.exports =\n        player: # model name\n            base: 'User'  # the same as loopback model settings.base\n            aclType: 'admin' # specific for this system\n\n        instrument:\n            aclType: 'owner-read'\n\n\n\nthe same format as [loopback model definition](http:\/\/docs.strongloop.com\/display\/public\/LB\/Customizing+models)\nexcept \"aclType\" value.\nname, base, relations and properties are automatically set from domain information.\n\n## aclType\nloopback-with-domain generates acls from aclType.\n\nthree types are available.\n\n aclType     | meaning\n-------------|-----------------------------------------------------\n admin       | only admin can CRUD the model\n owner       | admin and the owner of the model can CRUD\n public-read | everyone can READ the model and admin can CRUD\n\n\n# switching environment\n\nrunning script with environment variable \"NODE\\_ENV\" like\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\n\"development\" is selected by default.\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-domain selects configs in \"local\" directory.\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    lbWithDomain.runWithDomain(domain, configDir, env)\n\nenv is prior to NODE\\_ENV settings.\n\n# modified loopback-datasource-juggler\n\nusing [CureApp\/loopback-datasource-juggler](https:\/\/github.com\/CureApp\/loopback-datasource-juggler).\n\nthis repository is almost the same as original one except 'memory' connector handles id as string\n(orignally integer).\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e63ab3eef69844e97feb0a01be6c69737bc4fbcd","subject":"Transition animation duration bug fixed","message":"Transition animation duration bug fixed\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/renderer\/types\/extensions\/transition.litcoffee","new_file":"src\/renderer\/types\/extensions\/transition.litcoffee","new_contents":"# Transition\n\n```javascript\nRectangle {\n    width: 100; height: 100;\n    color: 'red'\n    pointer.onClick: function () {\n        this.x = Math.random() * 300;\n    }\n    Transition {\n        property: 'x'\n        animation: NumberAnimation {\n            duration: 1500\n        }\n    }\n}\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n    signal = require 'src\/signal'\n    log = require 'src\/log'\n\n    log = log.scope 'Renderer', 'Transition'\n\n# **Class** Transition : *Renderer.Extension*\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Transition extends Renderer.Extension\n        @__name__ = 'Transition'\n\n## *Transition* Transition.New([*Component* component, *Object* options])\n\n        @New = (component, opts) ->\n            item = new Transition\n            itemUtils.Object.initialize item, component, opts\n            item\n\n        constructor: ->\n            super()\n            @_animation = null\n            @_property = ''\n            @_to = 0\n\n        listener = (oldVal) ->\n            {animation} = @\n            to = @_target[@property]\n            if not animation or not @running or animation.updatePending or not utils.isFloat(oldVal) or not utils.isFloat(to)\n                return\n\n            @_to = to\n\n            animation.stop()\n            animation.from = oldVal\n            animation.to = @_to\n\n            animation.target ?= @target\n            animation.start()\n            return\n\n        onTargetReady = ->\n            @_running = true\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'target'\n            defaultValue: null\n            setter: (_super) -> (val) ->\n                oldVal = @target\n                if oldVal is val\n                    return\n\n                {animation, property} = @\n\n                if animation\n                    animation.target = val\n                    animation.stop()\n\n                _super.call @, val\n\n                if oldVal\n                    utils.remove oldVal._extensions, @\n\n                @_running = false\n                if val instanceof itemUtils.Object\n                    item = val\n                else if val instanceof itemUtils.MutableDeepObject\n                    item = val._ref\n                else\n                    setImmediate onTargetReady.bind(@)\n\n                if item\n                    item._extensions.push @\n                    @_running = true\n                    # else\n                    #   item.onReady onTargetReady, @\n\n                if property\n                    handlerName = itemUtils.getPropHandlerName property\n                    if oldVal\n                        oldVal[handlerName]?.disconnect listener, @\n\n                    if val\n                        if handlerName of val\n                            val[handlerName] listener, @\n                        else\n                            log.error \"'#{property}' property signal not found\"\n                return\n\n## *Animation* Transition::animation\n\n## *Signal* Transition::onAnimationChange(*Animation* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'animation'\n            defaultValue: null\n            developmentSetter: (val) ->\n                assert.instanceOf val, Renderer.Animation if val?\n            setter: (_super) -> (val) ->\n                oldVal = @animation\n                if oldVal is val\n                    return\n\n                _super.call @, val\n\n                if oldVal\n                    oldVal.target = null\n                    oldVal.stop()\n\n                if val\n                    val.target = null\n                    val.property = @property\n                return\n\n## *String* Transition::property\n\n## *Signal* Transition::onPropertyChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'property'\n            defaultValue: ''\n            setter: (_super) -> (val) ->\n                oldVal = @property\n                if oldVal is val\n                    return\n\n                {animation, target} = @\n\n                if target and val.indexOf('.') isnt -1\n                    chains = val.split '.'\n                    n = chains.length\n                    for chain, i in chains when i < n-1\n                        target = target[chain]\n                        unless target\n                            log.error \"No object found for the '#{val}' property\"\n                            break\n                    val = chains[n-1]\n                    @target = target\n\n                if animation\n                    animation.stop()\n                    animation.property = val\n\n                _super.call @, val\n\n                if target\n                    if oldVal\n                        handlerName = \"on#{utils.capitalize(oldVal)}Change\"\n                        target[handlerName].disconnect listener, @\n\n                    if val\n                        handlerName = \"on#{utils.capitalize(val)}Change\"\n                        target[handlerName] listener, @\n                return\n\n# Glossary\n\n- [Transition](#class-transition)\n","old_contents":"# Transition\n\n```javascript\nRectangle {\n    width: 100; height: 100;\n    color: 'red'\n    pointer.onClick: function () {\n        this.x = Math.random() * 300;\n    }\n    Transition {\n        property: 'x'\n        animation: NumberAnimation {\n            duration: 1500\n        }\n    }\n}\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n    signal = require 'src\/signal'\n    log = require 'src\/log'\n\n    log = log.scope 'Renderer', 'Transition'\n\n# **Class** Transition : *Renderer.Extension*\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Transition extends Renderer.Extension\n        @__name__ = 'Transition'\n\n## *Transition* Transition.New([*Component* component, *Object* options])\n\n        @New = (component, opts) ->\n            item = new Transition\n            itemUtils.Object.initialize item, component, opts\n            item\n\n        constructor: ->\n            super()\n            @_animation = null\n            @_property = ''\n            @_duration = 0\n            @_to = 0\n\n        listener = (oldVal) ->\n            {animation} = @\n            to = @_target[@property]\n            if not animation or not @running or animation.updatePending or not utils.isFloat(oldVal) or not utils.isFloat(to)\n                return\n\n            @_to = to\n\n            animation.stop()\n            animation.duration = @_duration\n            animation.from = oldVal\n            animation.to = @_to\n\n            animation.target ?= @target\n            animation.start()\n            return\n\n        onTargetReady = ->\n            @_running = true\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'target'\n            defaultValue: null\n            setter: (_super) -> (val) ->\n                oldVal = @target\n                if oldVal is val\n                    return\n\n                {animation, property} = @\n\n                if animation\n                    animation.target = val\n                    animation.stop()\n\n                _super.call @, val\n\n                if oldVal\n                    utils.remove oldVal._extensions, @\n\n                @_running = false\n                if val instanceof itemUtils.Object\n                    item = val\n                else if val instanceof itemUtils.MutableDeepObject\n                    item = val._ref\n                else\n                    setImmediate onTargetReady.bind(@)\n\n                if item\n                    item._extensions.push @\n                    @_running = true\n                    # else\n                    #   item.onReady onTargetReady, @\n\n                if property\n                    handlerName = itemUtils.getPropHandlerName property\n                    if oldVal\n                        oldVal[handlerName]?.disconnect listener, @\n\n                    if val\n                        if handlerName of val\n                            val[handlerName] listener, @\n                        else\n                            log.error \"'#{property}' property signal not found\"\n                return\n\n## *Animation* Transition::animation\n\n## *Signal* Transition::onAnimationChange(*Animation* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'animation'\n            defaultValue: null\n            developmentSetter: (val) ->\n                assert.instanceOf val, Renderer.Animation if val?\n            setter: (_super) -> (val) ->\n                oldVal = @animation\n                if oldVal is val\n                    return\n\n                _super.call @, val\n\n                if oldVal\n                    oldVal.target = null\n                    oldVal.stop()\n\n                if val\n                    @_duration = val.duration\n                    val.target = null\n                    val.property = @property\n                return\n\n## *String* Transition::property\n\n## *Signal* Transition::onPropertyChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'property'\n            defaultValue: ''\n            setter: (_super) -> (val) ->\n                oldVal = @property\n                if oldVal is val\n                    return\n\n                {animation, target} = @\n\n                if target and val.indexOf('.') isnt -1\n                    chains = val.split '.'\n                    n = chains.length\n                    for chain, i in chains when i < n-1\n                        target = target[chain]\n                        unless target\n                            log.error \"No object found for the '#{val}' property\"\n                            break\n                    val = chains[n-1]\n                    @target = target\n\n                if animation\n                    animation.stop()\n                    animation.property = val\n\n                _super.call @, val\n\n                if target\n                    if oldVal\n                        handlerName = \"on#{utils.capitalize(oldVal)}Change\"\n                        target[handlerName].disconnect listener, @\n\n                    if val\n                        handlerName = \"on#{utils.capitalize(val)}Change\"\n                        target[handlerName] listener, @\n                return\n\n# Glossary\n\n- [Transition](#class-transition)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"38c0ad60a028140dd5c76908a4557ae1303f6ea8","subject":"start storage adapter docs","message":"start storage adapter docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/12_storage_adapters.litcoffee","new_file":"docs\/12_storage_adapters.litcoffee","new_contents":"# Batman.StorageAdapter\n\n`Batman.StorageAdapter`s handle persistence of [`Batman.Model`s](\/docs\/api\/batman.model.html). Any `Batman.Model` which will be persisted must have a storage adapter, which is declared with [`Batman.Model@persist`](\/docs\/api\/batman.model.html#class_function_persist):\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @persist Batman.RestStorage # a StorageAdapter subclass\n```\n\n__Protip:__ Consider setting the storage adapter in one `Batman.Model` subclass, then extending that subclass in the rest of your app. Then, you won't have to call `@persist` every time:\n\n```coffeescript\nclass App.Model extends Batman.Model\n  @persist Batman.LocalStorage\n\nclass App.Superhero extends App.Model\n  # no need to call @persist here!\n\nclass App.Sidekick extends App.Model\n  # or here!\n```\n\n### Batman's Included StorageAdapters\n\nBatman ships with a few storage adapters to help you get up and coding quickly:\n\n- `Batman.LocalStorage` uses `window.localStorage` to persist records.\n- `Batman.SessionStorage` extends `Batman.LocalStorage` and uses `window.sessionStorage` to persist records.\n- `Batman.RestStorage` uses [HTTP REST](http:\/\/en.wikipedia.org\/wiki\/REST) to persist records, mapping HTTP verbs to storage operations and handling HTTP response codes appropriately. _Note: Because `Batman.RestStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implmentation_libraries) to implement `Batman.Request`._\n\n### Batman.RailsStorage\nAlso, `Batman.RailsStorage` (available in separate file: [Coffee](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.rails.coffee), [JS](#)) extends `Batman.RestStorage` and provides some helpful Rails integrations:\n\n- If the response's status code is 422 (`Unprocessable Entity`), Any `errors` defined in the JSON response will be added to the `Batman.Model`'s [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n- By default, Batman will get the Rails CSRF token from the `<head>`and send it as a request header. (This can be prevented by setting `Batman.config.protectFromCSRF = false`.)\n- If a record's URL doesn't end in `.json` and doesn't include a query string, `.json` is automatically appended to the URL.\n\n\n_Note: Like `Batman.RestStorage`, `Batman.RailsStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), so you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implmentation_libraries) to implement `Batman.Request`._\n\n## Subclassing Batman.StorageAdapter\n\nYou may want to customize Batman's storage operations for your own app, for example:\n\n- Adding before- and after-operation callbacks\n- Overriding default storage operations\n\nTo do this, extend `Batman.StorageAdapter` (or one of the provided subclasses), then use your storage adapter to persist your models.\n```\nclass HeroicStorageAdapter extends Batman.LocalStorage\n  # filters, overrides\n\nclass App.Superhero extends Batman.Model\n  @persist App.HeroicStorageAdapter\n```\n### `env` and `next`\n\nStorage operations and callbacks each take two arguments: `env` and `next`.\n\n`next` ...\n\n`env` ...\n\n### Adding Callbacks\n\nCallbacks can be registered on any storage operation (listed below).\n\n```coffeescript\nclass App.SpecificHeaderStorageAdapter extends Batman.RestStorage\n  # include a specific header in all requests:\n  @::before 'all' (env, next) ->\n    headers = env.options.headers || {}\n    headers[\"App-Specific-Header\"] = App.getSpecificHeader()\n    next()\n\n  @::after 'create', (env, next) ->\n    console.log \"A #{env.subject.constructor.name} was created!\"\n    next()\n```\n\n### Storage operations\n\nAny `StorageAdapter` must implement these operations as instance methods, for example:\n```\nclass App.ModifiedStorageAdapter extends Batman.RestStorage\n  destroy: (env, next) ->\n    # your destroy operation\n    next()\n```\n\n## create\n\n## read\n\n## update\n\n## destroy\n\n## readAll\n","old_contents":"","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d7aa0ef9f9a063499daab0fbcae411c937e064d7","subject":"Add zooming functionality to testing demo.","message":"Add zooming functionality to testing demo.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The __TimelineMaker__ class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the __TimelineMaker__ class.  The __options__ parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are __formatTimeAxis()__, which formats time axis into a dictionary that describes the look of axis, and one of the __renderTo...__ functions that render that data dictionary to a desired context.\n\n#### The __formatTimeAxis()__ function\n\nA function that formats time axis into an intermediate format.  It has two parameters, __interval__ (a dictionary with __start__ and __end__ values, each of Date type) and corresponding to that interval __width__ of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be __options.intervalMultiplier__.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, __findPointList()__.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical element properties.  To transform time value into a coordinate we use the __timeToCoord()__ function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe should probably change ticks dictionary to lines dictionary instead, so we can add other types of lines, like baseline.  It could be better also to move all constants to options and make ticks drawing more flexible.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we add text labels too.\n\nHere we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {\n          lines: ticks.concat axisLine\n          textLabels\n        }\n\n#### The __findPointList()__ function\n\nThis function returns a list of points that are needed to be calculated for a (__start__, __end__) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the __start__ of the interval.  We move code that does that to the __findLeftTime()__.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using __findNextPoint()__ function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The __findLeftTime()__ function\n\nThe __findLeftTime()__ function calculates the rightmost point of time for current __options.intervalType__ such that it is not inside the given __interval__ (excluding beginning).  The __options.intervalType__ could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\nAnother option, __options.intervalMultiplier__, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the __options.intervalMultiplier__ should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the __findNextPoint()__ function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In __findNextPoint()__ we make sure that edge points are consistent while using different values of __start__.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The __findNextPoint()__ function\n\nThis function calculates next edge time point for a current options assuming __timePoint__ argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The __timeToCoord()__ function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The __renderToCanvas()__ function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        oldX = event.clientX\n        oldY = event.clientY\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          multiplier = Math.pow(base, event.deltaY)\n          interval = end-start\n          midPoint = start.getTime() + interval \/ 2\n          interval *= multiplier\n          start = new Date(midPoint - interval\/2)\n          end = new Date(midPoint + interval\/2)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The __TimelineMaker__ class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the __TimelineMaker__ class.  The __options__ parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are __formatTimeAxis()__, which formats time axis into a dictionary that describes the look of axis, and one of the __renderTo...__ functions that render that data dictionary to a desired context.\n\n#### The __formatTimeAxis()__ function\n\nA function that formats time axis into an intermediate format.  It has two parameters, __interval__ (a dictionary with __start__ and __end__ values, each of Date type) and corresponding to that interval __width__ of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be __options.intervalMultiplier__.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, __findPointList()__.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical element properties.  To transform time value into a coordinate we use the __timeToCoord()__ function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe should probably change ticks dictionary to lines dictionary instead, so we can add other types of lines, like baseline.  It could be better also to move all constants to options and make ticks drawing more flexible.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we add text labels too.\n\nHere we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {\n          lines: ticks.concat axisLine\n          textLabels\n        }\n\n#### The __findPointList()__ function\n\nThis function returns a list of points that are needed to be calculated for a (__start__, __end__) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the __start__ of the interval.  We move code that does that to the __findLeftTime()__.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using __findNextPoint()__ function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The __findLeftTime()__ function\n\nThe __findLeftTime()__ function calculates the rightmost point of time for current __options.intervalType__ such that it is not inside the given __interval__ (excluding beginning).  The __options.intervalType__ could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\nAnother option, __options.intervalMultiplier__, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the __options.intervalMultiplier__ should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the __findNextPoint()__ function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In __findNextPoint()__ we make sure that edge points are consistent while using different values of __start__.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The __findNextPoint()__ function\n\nThis function calculates next edge time point for a current options assuming __timePoint__ argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The __timeToCoord()__ function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The __renderToCanvas()__ function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.clearRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      timeInterval = end - start\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        oldX = event.clientX\n        oldY = event.clientY\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"96f6d8803f588c520105f4f0dda23f47a6325f45","subject":"Update table of contents.","message":"Update table of contents.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimelineMaker` class](#the-timelinemaker-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary implementation\n----------------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.\n\n#### The `TimelineMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary implementation\n----------------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.\n\n#### The `TimelineMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3ad04e4004a7f7e366641100bd6a17b953925efd","subject":"Added arguments to BeforeRule if","message":"Added arguments to BeforeRule if\n","repos":"WillemDeGroef\/nodesentry","old_file":"src\/policy.litcoffee","new_file":"src\/policy.litcoffee","new_contents":"Policy\n======\n\n    _ = require \"underscore\"\n\n    class Policy\n        constructor: () ->\n            @rules = []\n            @libsToWrap = []\n\n            @policy =\n\nIndicate if a given library (name) should be wrapped in a separate membrane. If\na policy doesn't talk about a specific depending library, then it there is no\nneed for it to be wrapped. Therefor, the default return value is `false`:\n\n                wrapWithMembrane: (libName) -> false\n\n        disable: (lib) -> this\n\n        on: (name) ->\n            child = new OnRule name, this\n            # check if (lib, call) = name must be added to libsToWrap\n            # iff lib[0].toLowerCase() == lib[0]\n            @rules.push child\n            child\n\n        before: (name) ->\n            child = new BeforeRule name, this\n            @rules.push child\n            child\n\n        after: (name) ->\n            child = new AfterRule name, this\n            @rules.push child\n            child\n\nThe `build` method generates the whole structure of our semantic model of the membrane object.\n\n        build: () =>\n            @libsToWrap = []\n\n            strEqual = (fullName) -> (rule) -> fullName == rule.apiCall\n\n            areType = (t) ->\n                (rule) -> rule instanceof t\n\n            conditionsAreTrue = (dTgt, ret) ->\n                (rule) ->\n                    _.chain(rule.conditions)\n                        .map (cond) -> cond(dTgt, ret) == true\n                        .reduce ((memo, c) -> memo and c), true\n                        .value()\n\n            doGetActions = (dTgt, args...) ->\n                (rule) ->\n                    _.chain(rule.actions)\n                        .map (action) -> action.apply(this, [dTgt].concat(args))\n                    return rule\n\n            calcRetValue = (origRet, rule) -> rule.ret(origRet)\n\n            isEmpty = (l) -> l.size().value() == 0\n            isNotFunction = (v) -> typeof v != \"function\"\n\n            @policy.onGet = (wTgt, name, wRec, dTgt, ret) =>\n                name = name.toString()\n                fullName = \"#{dTgt.constructor.name.toString()}.#{name}\"\n                relevantRules = _.chain(@rules)\n                    .filter(strEqual(fullName))\n\n                onRules = relevantRules.filter(areType(OnRule))\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n\n                onGetValue = onRules.filter(conditionsAreTrue(dTgt, ret))\n                    .map(doGetActions(dTgt, ret))\n                    .reduce(calcRetValue, ret)\n                    .value()\n\n            @policy.functionCall = (dTgt, dryThis, dryArgs, calcResult, fullName) =>\n                if dryThis != undefined and fullName.indexOf(\"\/\") != -1\n                    fullName = \"#{dryThis.constructor.name}.#{dTgt.name}\"\n                relevantRules = _.chain(@rules).filter(strEqual(fullName))\n\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n                calcResult = beforeRules.filter(conditionsAreTrue(dTgt, dryArgs))\n                       .map(doGetActions(dTgt, dryArgs, calcResult))\n                       .reduce(calcRetValue, calcResult)\n                       .value()\n\n                # return as function because the generic membrane will invoke it afterwards\n                ->\n                    ret = calcResult()\n                    afterRules.filter(conditionsAreTrue(dTgt, ret))\n                        .map(doGetActions(dTgt, dryArgs, ret))\n                        .reduce(calcRetValue, ret)\n                        .value()\n\n            @policy\n\n\n    class Rule\n        constructor: (@apiCall, @parent) ->\n\nList of actions with side effects [0..n]:\n\n            @actions = []\n\nThe default return function [1..1]:\n\n            @ret = (v) -> v\n\nA list of conditions that evaluate to `true` or `false` [1..n]:\n\n            @conditions = [ -> true]\n\n        do: (f) =>\n            @actions.push f\n            this\n\n        return: (f) =>\n            @ret = (v) -> f.call(this, v)\n            this\n\n        if: (cond) =>\n            @conditions.push (dtgt, ret) -> cond(dtgt, ret)\n            this\n\n        on: (name) => @parent.on name\n        before: (name) => @parent.before name\n        after: (name) => @parent.after name\n        build: () -> @parent.build()\n\n\n    class OnRule extends Rule\n    class AfterRule extends Rule\n    class BeforeRule extends Rule\n\n\n\n\n\n    module.exports = Policy\n","old_contents":"Policy\n======\n\n    _ = require \"underscore\"\n\n    class Policy\n        constructor: () ->\n            @rules = []\n            @libsToWrap = []\n\n            @policy =\n\nIndicate if a given library (name) should be wrapped in a separate membrane. If\na policy doesn't talk about a specific depending library, then it there is no\nneed for it to be wrapped. Therefor, the default return value is `false`:\n\n                wrapWithMembrane: (libName) -> false\n\n        disable: (lib) -> this\n\n        on: (name) ->\n            child = new OnRule name, this\n            # check if (lib, call) = name must be added to libsToWrap\n            # iff lib[0].toLowerCase() == lib[0]\n            @rules.push child\n            child\n\n        before: (name) ->\n            child = new BeforeRule name, this\n            @rules.push child\n            child\n\n        after: (name) ->\n            child = new AfterRule name, this\n            @rules.push child\n            child\n\nThe `build` method generates the whole structure of our semantic model of the membrane object.\n\n        build: () =>\n            @libsToWrap = []\n\n            strEqual = (fullName) -> (rule) -> fullName == rule.apiCall\n\n            areType = (t) ->\n                (rule) -> rule instanceof t\n\n            conditionsAreTrue = (dTgt, ret) ->\n                (rule) ->\n                    _.chain(rule.conditions)\n                        .map (cond) -> cond(dTgt, ret) == true\n                        .reduce ((memo, c) -> memo and c), true\n                        .value()\n\n            doGetActions = (dTgt, args...) ->\n                (rule) ->\n                    _.chain(rule.actions)\n                        .map (action) -> action.apply(this, [dTgt].concat(args))\n                    return rule\n\n            calcRetValue = (origRet, rule) -> rule.ret(origRet)\n\n            isEmpty = (l) -> l.size().value() == 0\n            isNotFunction = (v) -> typeof v != \"function\"\n\n            @policy.onGet = (wTgt, name, wRec, dTgt, ret) =>\n                name = name.toString()\n                fullName = \"#{dTgt.constructor.name.toString()}.#{name}\"\n                relevantRules = _.chain(@rules)\n                    .filter(strEqual(fullName))\n\n                onRules = relevantRules.filter(areType(OnRule))\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n\n                onGetValue = onRules.filter(conditionsAreTrue(dTgt, ret))\n                    .map(doGetActions(dTgt, ret))\n                    .reduce(calcRetValue, ret)\n                    .value()\n\n            @policy.functionCall = (dTgt, dryThis, dryArgs, calcResult, fullName) =>\n                if dryThis != undefined and fullName.indexOf(\"\/\") != -1\n                    fullName = \"#{dryThis.constructor.name}.#{dTgt.name}\"\n                relevantRules = _.chain(@rules).filter(strEqual(fullName))\n\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n                calcResult = beforeRules.filter(conditionsAreTrue(dTgt))\n                       .map(doGetActions(dTgt, dryArgs, calcResult))\n                       .reduce(calcRetValue, calcResult)\n                       .value()\n\n                # return as function because the generic membrane will invoke it afterwards\n                ->\n                    ret = calcResult()\n                    afterRules.filter(conditionsAreTrue(dTgt, ret))\n                        .map(doGetActions(dTgt, dryArgs, ret))\n                        .reduce(calcRetValue, ret)\n                        .value()\n\n            @policy\n\n\n    class Rule\n        constructor: (@apiCall, @parent) ->\n\nList of actions with side effects [0..n]:\n\n            @actions = []\n\nThe default return function [1..1]:\n\n            @ret = (v) -> v\n\nA list of conditions that evaluate to `true` or `false` [1..n]:\n\n            @conditions = [ -> true]\n\n        do: (f) =>\n            @actions.push f\n            this\n\n        return: (f) =>\n            @ret = (v) -> f.call(this, v)\n            this\n\n        if: (cond) =>\n            @conditions.push (dtgt, ret) -> cond(dtgt, ret)\n            this\n\n        on: (name) => @parent.on name\n        before: (name) => @parent.before name\n        after: (name) => @parent.after name\n        build: () -> @parent.build()\n\n\n    class OnRule extends Rule\n    class AfterRule extends Rule\n    class BeforeRule extends Rule\n\n\n\n\n\n    module.exports = Policy\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8417103e93fcce26e6777cda7f547da2d2bb6cc5","subject":"Assign a special LOCALS path for the __DUMMY__ madul","message":"Assign a special LOCALS path for the __DUMMY__ madul\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = underscore tokens[1].trim()\n      else if tokens.length == 1\n        alias = underscore name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @DUMMY: (deps, cb) ->\n        class __DUMMY__ extends Madul\n          deps: deps\n\n        new __DUMMY__()\n          .initialize()\n          .then cb\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || underscore(name), alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            WRAPPED[proto.constructor.name].push method\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, (errors) =>\n              if errors?\n                wrapped errors\n              else\n                proto[\"_#{method}\"] = proto[method]\n\n                proto[method] = =>\n                  def = q.defer()\n                  me  = proto[\"_#{method}\"]\n\n                  if args_format == 'ARRAY'\n                    args = Array.prototype.slice.call arguments\n                  else if args_format == 'OBJECT'\n                    args = arguments[0]\n                  else\n                    proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                    return def.reject 'No arg format specified'\n\n                  before = @_process_decorators me, 'before'\n                  after  = @_process_decorators me, 'after'\n\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries me.validators, (v, next) =>\n                      arg       = Object.keys(v)[0]\n                      validator = v[arg]\n                      input     = arg\n                      prop      = args\n\n                      for a in arg.split '.'\n                        prop  = prop[a]\n                        input = a\n\n                      if Array.isArray validator\n                        async.eachSeries validator, (v, nxt) =>\n                          proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                          proto[v].EXECUTE.call proto[v], input, prop\n                            .then nxt\n                            .catch handle_err v, { \"#{input}\": prop }, nxt, (err) =>\n                              reject err\n                              def.reject err\n                        , next\n                      else\n                        proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                        proto[validator].EXECUTE.call proto[validator], input, prop\n                          .then next\n                          .catch handle_err v, { \"#{input}\": prop }, next, (err) =>\n                            reject err\n                            def.reject err\n                    , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      async.eachSeries before, (b, next) =>\n                        proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                        proto[b].before.call proto[b], args\n                          .then next\n                          .catch handle_err b, args, next, (err) =>\n                            reject err\n                            def.reject err\n                      , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      d     = q.defer()\n                      input = proto._prep_invocation proto, method, args, d\n\n                      try\n                        me.behavior.apply proto, input\n                          .then  (out) => resolve out\n                          .catch (err) => reject  err\n                      catch e\n                        me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                        reject e\n                  .catch (err) => def.reject err\n                  .then (result) =>\n                    q.Promise (resolve, reject) =>\n                      if after.length > 0\n                        async.eachSeries after, (a, next) =>\n                          proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                          proto[a].after.call proto[a], result\n                            .then next\n                            .catch handle_err b, args, next, (err) =>\n                              reject err\n                              def.reject err\n                        , => resolve result\n                      else\n                        process.nextTick => resolve result\n                  .then  (out) => def.resolve out\n                  .catch (err) => def.reject  err\n\n                  def.promise\n\n                INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n                WRAPPED[proto.constructor.name].push method\n\n                wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if proto.deps?\n                filtered = proto.deps.filter (d) => Madul.PARSE_SPEC(d).name == prop.replace \/_\/g, '-'\n\n                continue if filtered.length > 0\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, (errors) =>\n              if errors?\n                stop = new Error()\n                stop.break = true\n\n                next stop\n              else\n                next()\n          , (errors) =>\n            if errors?\n              stop = new Error()\n              stop.break = true\n\n              completed stop\n            else\n              @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{strip name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, (errors) =>\n                if errors?\n                  stop = new Error()\n                  stop.break = true\n\n                  next stop\n                else\n                  HYDRATED[name] = true\n\n                  for listener in HYRDATION_LISTENERS[name]\n                    listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, done, fail) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then  (m)   => done m\n            .catch (err) => fail err\n        else\n          done mod\n\n      _load: (me, name, path, loaded, fail) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded()\n        , fail\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.eachSeries files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.' && f != 'node_modules'\n                  me._check me, depth, dep, ref, => next()\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  stop  = new Error()\n                  stop.break = true\n\n                  me._load me, ref, depth, =>\n                    me._do_add me, ref, => next stop\n                  , (err) => next stop\n                else\n                  next()\n            , => finished()\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next() if typeof next == 'function'\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n        , (err) =>\n          stop = new Error()\n          stop.break = true\n\n          next stop\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n        errors  = [ ]\n\n        async.eachSeries deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                if proto[spec.parent]?\n                  deep = SEARCH_ROOTS[spec.parent]\n\n                  proto._check proto, deep, spec.name, spec.ref, (err) =>\n                    if err == 'NOT_FOUND'\n                      proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                        if err?\n                          stop = new Error()\n                          stop.break = true\n\n                          proto.warn.call proto, 'not-found', dep: d\n\n                          next stop\n                        else\n                          next()\n                    else\n                      next()\n                else\n                  proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                  @_do_hydrate proto, [ spec.parent ], (errors) =>\n                    if errors?\n                      stop = new Error()\n                      stop.break = true\n\n                      next stop\n                    else\n                      if SEARCH_ROOTS[spec.parent] == undefined\n                        SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                      deep = SEARCH_ROOTS[spec.parent]\n\n                      proto._check proto, deep, spec.name, spec.ref, (err) =>\n                        if err == 'NOT_FOUND'\n                          proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                            if err?\n                              stop = new Error()\n                              stop.break = true\n\n                              proto.warn.call proto, 'not-found', dep: d\n\n                              next stop\n                            else\n                              next()\n                        else\n                          next()\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    nxt()\n                  , =>\n                    nxt()\n                , =>\n                  next()\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, (err) =>\n                  if err?\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next stop\n                  else\n                    next()\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , (err) =>\n          if err?.length > 0\n            proto.warn.call proto, 'hydration.halt', errors\n\n            hydration_complete errors\n          else\n            async.eachSeries initers, (initer, next) =>\n              proto[initer.execute].apply(@).then next\n            , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, next) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n        fs.stat pkg, (err, stat) =>\n          if err?\n            next()\n          else if stat.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            next()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        filtered = found.filter (f) => f?\n\n        if filtered.length > 0\n          filtered.sort((a, b) => a.length - b.length)[0]\n        else\n          [ ]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            if name == '__DUMMY__'\n              LOCALS[name] = \"#{process.cwd()}\/dist\"\n            else\n              LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, (errors) =>\n            if errors?\n              deferred.reject errors\n            else\n              @_wrap_methods proto, (err) =>\n                if err?\n                  deferred.reject err\n                else\n                  @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = underscore tokens[1].trim()\n      else if tokens.length == 1\n        alias = underscore name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @DUMMY: (deps, cb) ->\n        class __DUMMY__ extends Madul\n          deps: deps\n\n        new __DUMMY__()\n          .initialize()\n          .then cb\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || underscore(name), alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            WRAPPED[proto.constructor.name].push method\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, (errors) =>\n              if errors?\n                wrapped errors\n              else\n                proto[\"_#{method}\"] = proto[method]\n\n                proto[method] = =>\n                  def = q.defer()\n                  me  = proto[\"_#{method}\"]\n\n                  if args_format == 'ARRAY'\n                    args = Array.prototype.slice.call arguments\n                  else if args_format == 'OBJECT'\n                    args = arguments[0]\n                  else\n                    proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                    return def.reject 'No arg format specified'\n\n                  before = @_process_decorators me, 'before'\n                  after  = @_process_decorators me, 'after'\n\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries me.validators, (v, next) =>\n                      arg       = Object.keys(v)[0]\n                      validator = v[arg]\n                      input     = arg\n                      prop      = args\n\n                      for a in arg.split '.'\n                        prop  = prop[a]\n                        input = a\n\n                      if Array.isArray validator\n                        async.eachSeries validator, (v, nxt) =>\n                          proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                          proto[v].EXECUTE.call proto[v], input, prop\n                            .then nxt\n                            .catch handle_err v, { \"#{input}\": prop }, nxt, (err) =>\n                              reject err\n                              def.reject err\n                        , next\n                      else\n                        proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                        proto[validator].EXECUTE.call proto[validator], input, prop\n                          .then next\n                          .catch handle_err v, { \"#{input}\": prop }, next, (err) =>\n                            reject err\n                            def.reject err\n                    , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      async.eachSeries before, (b, next) =>\n                        proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                        proto[b].before.call proto[b], args\n                          .then next\n                          .catch handle_err b, args, next, (err) =>\n                            reject err\n                            def.reject err\n                      , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      d     = q.defer()\n                      input = proto._prep_invocation proto, method, args, d\n\n                      try\n                        me.behavior.apply proto, input\n                          .then  (out) => resolve out\n                          .catch (err) => reject  err\n                      catch e\n                        me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                        reject e\n                  .catch (err) => def.reject err\n                  .then (result) =>\n                    q.Promise (resolve, reject) =>\n                      if after.length > 0\n                        async.eachSeries after, (a, next) =>\n                          proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                          proto[a].after.call proto[a], result\n                            .then next\n                            .catch handle_err b, args, next, (err) =>\n                              reject err\n                              def.reject err\n                        , => resolve result\n                      else\n                        process.nextTick => resolve result\n                  .then  (out) => def.resolve out\n                  .catch (err) => def.reject  err\n\n                  def.promise\n\n                INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n                WRAPPED[proto.constructor.name].push method\n\n                wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if proto.deps?\n                filtered = proto.deps.filter (d) => Madul.PARSE_SPEC(d).name == prop.replace \/_\/g, '-'\n\n                continue if filtered.length > 0\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, (errors) =>\n              if errors?\n                stop = new Error()\n                stop.break = true\n\n                next stop\n              else\n                next()\n          , (errors) =>\n            if errors?\n              stop = new Error()\n              stop.break = true\n\n              completed stop\n            else\n              @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{strip name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, (errors) =>\n                if errors?\n                  stop = new Error()\n                  stop.break = true\n\n                  next stop\n                else\n                  HYDRATED[name] = true\n\n                  for listener in HYRDATION_LISTENERS[name]\n                    listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, done, fail) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then  (m)   => done m\n            .catch (err) => fail err\n        else\n          done mod\n\n      _load: (me, name, path, loaded, fail) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded()\n        , fail\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.eachSeries files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.' && f != 'node_modules'\n                  me._check me, depth, dep, ref, => next()\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  stop  = new Error()\n                  stop.break = true\n\n                  me._load me, ref, depth, =>\n                    me._do_add me, ref, => next stop\n                  , (err) => next stop\n                else\n                  next()\n            , => finished()\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next() if typeof next == 'function'\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n        , (err) =>\n          stop = new Error()\n          stop.break = true\n\n          next stop\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n        errors  = [ ]\n\n        async.eachSeries deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                if proto[spec.parent]?\n                  deep = SEARCH_ROOTS[spec.parent]\n\n                  proto._check proto, deep, spec.name, spec.ref, (err) =>\n                    if err == 'NOT_FOUND'\n                      proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                        if err?\n                          stop = new Error()\n                          stop.break = true\n\n                          proto.warn.call proto, 'not-found', dep: d\n\n                          next stop\n                        else\n                          next()\n                    else\n                      next()\n                else\n                  proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                  @_do_hydrate proto, [ spec.parent ], (errors) =>\n                    if errors?\n                      stop = new Error()\n                      stop.break = true\n\n                      next stop\n                    else\n                      if SEARCH_ROOTS[spec.parent] == undefined\n                        SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                      deep = SEARCH_ROOTS[spec.parent]\n\n                      proto._check proto, deep, spec.name, spec.ref, (err) =>\n                        if err == 'NOT_FOUND'\n                          proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                            if err?\n                              stop = new Error()\n                              stop.break = true\n\n                              proto.warn.call proto, 'not-found', dep: d\n\n                              next stop\n                            else\n                              next()\n                        else\n                          next()\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    nxt()\n                  , =>\n                    nxt()\n                , =>\n                  next()\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, (err) =>\n                  if err?\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next stop\n                  else\n                    next()\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , (err) =>\n          if err?.length > 0\n            proto.warn.call proto, 'hydration.halt', errors\n\n            hydration_complete errors\n          else\n            async.eachSeries initers, (initer, next) =>\n              proto[initer.execute].apply(@).then next\n            , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, next) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n        fs.stat pkg, (err, stat) =>\n          if err?\n            next()\n          else if stat.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            next()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        filtered = found.filter (f) => f?\n\n        if filtered.length > 0\n          filtered.sort((a, b) => a.length - b.length)[0]\n        else\n          [ ]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, (errors) =>\n            if errors?\n              deferred.reject errors\n            else\n              @_wrap_methods proto, (err) =>\n                if err?\n                  deferred.reject err\n                else\n                  @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ce1e2bace3e92b350c8923240ab01f445aebebe4","subject":"Cleaned up decorator and validator processing","message":"Cleaned up decorator and validator processing\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (type) =>\n        if Array.isArray me[type]\n          me[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof me[type] == 'string'\n          [ Madul.PARSE_SPEC(me[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                  proto[validator].EXECUTE.call proto[validator], args[arg]\n\n                before = @_process_decorators 'before'\n                after  = @_process_decorators 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                val\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = Madul.PARSE_SPEC val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE.call proto[ref], args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = Madul.PARSE_SPEC val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE.call proto[ref], args[key]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                if Array.isArray me.before\n                  before = me.before.map (b) => Madul.PARSE_SPEC(b).ref\n                else if typeof me.before == 'string'\n                  before = [ Madul.PARSE_SPEC(me.before).ref ]\n                else\n                  before = [ ]\n\n                if Array.isArray me.after\n                  after = me.after.map (a) => Madul.PARSE_SPEC(a).ref\n                else if typeof me.after == 'string'\n                  after = [ Madul.PARSE_SPEC(me.after).ref ]\n                else\n                  after = [ ]\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"25272c214b7d7072f990da3c0523fd1bbd16a646","subject":"add how-to for reading docs","message":"add how-to for reading docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/00_general\/00_index.litcoffee","new_file":"docs\/00_general\/00_index.litcoffee","new_contents":"# Using This Reference\n\nThe API Reference contains specific documentation for individual components of\nthe framework. You may also find tests included, which serve as\nan example for correct usage as well as an assertion that the API has not\nchanged.\n\n## How to Read API Entries\n\nEntries for __functions__ take the form:\n\n```coffeescript\n \"#{classOrPrototype}#{name}(#{arguments}) : #{returnType}\"\n```\n\n- `arguments` may include the _type_ or _default value_ for each argument\n- `returnType` may be omitted if it is unpredictable or irrelevant\n\nEntries for __properties__ take the form:\n\n```coffeescript\n \"#{classOrPrototype}#{name}[=#{defaultValue}] : #{returnType}\"\n```\n\n- `defaultValue` may be omitted if there isn't one\n- `returnType` may be omitted if it is unpredictable or irrelevant\n\n\n### Class Properties\n\nIf the entry is preceded with `@`, it is defined on the _class_. This means you should call (or `get`) it on the class. For example, `Model.find` is a class function:\n\n```coffeescript\nModel.find 1, (err, record) -> # ...\n```\n\nAnd `Model.loaded` is a class accessor:\n\n```coffeescript\nModel.get('loaded')\n```\n\nAlso, class properties are defined in class definitions with `@`. For example, to define `Model.resourceName` and call `Model.persist`:\n\n```coffeescript\nclass MyApp.MyModel extends Batman.Model\n  @resourceName: \"my_model\"\n  @persist(Batman.RestStorage)\n```\n\n### Prototype Properties\n\nIf an entry is _not_ preceded with `@`, it is defined on the _prototype_. This means you should call (or `get`) it on instances of that class. For example, `View::lookupKeypath` is a prototype function:\n\n```coffeescript\nmyView = new Batman.View(myOptions)\nmyView.lookupKeypath(\"myRecord.name\")\n```\n\nSimilarly, `View::node` is a prototype accessor:\n\n```coffeescript\nmyView = new Batman.View\nmyView.get('node')\n```\n\nPrototype properties can be defined in class definitions. For example, to override the `View::viewDidAppear` hook:\n\n```coffeescript\nclass MyApp.MyView extends Batman.View\n  viewDidAppear: ->\n    alert(\"Welcome to my great app!\")\n```\n\n","old_contents":"# Using This Reference\n\nThe API Reference contains specific documentation for individual components of\nthe framework. In most sections you'll also find tests included, which serve as\nan example for correct usage as well as an assertion that the API has not\nchanged.\n\nWithin the reference, types are documented by suffixing with a colon followed\nby the type (e.g. `toString() : string`). This applies to function arguments,\nreturn types, property types and accessor types. If there is no type specified,\nit's either self-evident or the type is undefined (e.g. in the case of a\nfunction with no return value).  All function\/property\/accessor headings are\nprefixed with an `@` if they exist at the class level, otherwise they exist at\nthe prototype\/instance level.\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"754249b2f8719e5d8bf70c3a090ac547e18971d7","subject":"fixing tempalte","message":"fixing tempalte\n","repos":"glamp\/leech,glamp\/leech","old_file":"src\/remora.litcoffee","new_file":"src\/remora.litcoffee","new_contents":"    handlebars = require 'handlebars'\n    aws = require 'aws-sdk'\n    shortid = require 'shortid'\n\nSetup the connection to s3\n\n    aws.config.update {\n        accessKeyId: process.env[\"AWS_ACCESS_KEY\"],\n        secretAccessKey: process.env[\"AWS_SECRET_KEY\"]\n    }\n    aws.config.region = 'us-east-1'\n    s3 = new aws.S3()\n\nSet the name for your domain.\n\n    module.exports = (url) ->\n      DOMAIN = process.env[\"DOMAIN\"] || \"shortcake.com\"\n      BUCKET = process.env[\"BUCKET\"] || DOMAIN\n      GA_ID = process.env[\"GA_ID\"]\n      shortid.characters \"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ()\"\n\nThis is our basic HTML template that we'll use for doing the redirect. It's just\ngoing to send the user to another page as soon as it's loaded. There's no server\nsince it's just a static file, but everything will be tracked by GA.\n\n      source = \"\"\"\n      <html>\n          <title>{{url}}<\/title>\n          <body>\n            <!-- Google Analytics -->\n            <script type=\"text\/javascript\">\n              (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){\n              (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),\n              m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)\n              })(window,document,'script','\/\/www.google-analytics.com\/analytics.js','ga');\n\n              ga('create', '{{ga_id}}', 'auto');\n              ga('send', 'pageview');\n\n            <\/script>\n            <!-- redirect -->\n            <script type=\"text\/javascript\">\n              window.location.replace('{{url}}');\n            <\/script>\n          <\/body>\n      <\/html>\n      \"\"\"\n\n      template = handlebars.compile(source)\n\nData should just be the user's Google Analytics Id and the URL that they want to\nminify.\n\n      data = { url: url, ga_id: GA_ID }\n      html = template(data)\n\nWe're going to generate a shortlink for the URL. [`shortid`](https:\/\/github.com\/dylang\/shortid) does a pretty good job at balancing between being short, and also\nbeing unique!\n\n      _id = shortid.generate()\n\nWe could break up the files by the [first 3 letters in the id](http:\/\/docs.aws.amazon.com\/AmazonS3\/latest\/dev\/request-rate-perf-considerations.html).\nThis makes it much easier for S3 to distribute the bucket (and greatly improves performance).\n...but we're not going to do this yet.\n\n      params = {\n          Bucket: BUCKET,\n          Key: _id\n          ACL: \"public-read\",\n          Body: html\n      }\n      s3.putObject params, (err, data) ->\n          if err\n              console.log err\n\nWe'll keep a running record of all links we've shortened and throw it into a\nbasic HTML page just to make it easy to do lookups.\n\n      source = \"\"\"\n      <html>\n          <title>Shortened Links<\/title>\n          <body>\n              <h1>Shortened Links<\/h1>\n              <ul>\n              {{#objs}}\n                  <li><a href='{{ Key }}'>{{ Key }}<\/a><\/li>\n              {{\/objs}}\n              <\/ul>\n          <\/body>\n      <\/html>\n      \"\"\"\n      params = { Bucket: BUCKET }\n      s3.listObjects params, (err, objs) ->\n        if err\n            console.log \"[ERROR]: could not list objects: \" + err\n        objs = objs.Contents.filter (obj) ->\n          ! \/index.html$\/.test obj.Key\n        html = handlebars.compile(source)({ objs: objs })\n        params = {\n            Bucket: BUCKET,\n            Key: \"index.html\",\n            ACL: \"public-read\",\n            Body: html\n        }\n        s3.putObject params, (err, data) ->\n            if err\n                console.log \"[ERROR]: \" + err\n        console.error \"Visit: https:\/\/s3.amazonaws.com\/#{BUCKET}\/index.html\"\n","old_contents":"    handlebars = require 'handlebars'\n    aws = require 'aws-sdk'\n    shortid = require 'shortid'\n\nSetup the connection to s3\n\n    aws.config.update {\n        accessKeyId: process.env[\"AWS_ACCESS_KEY\"],\n        secretAccessKey: process.env[\"AWS_SECRET_KEY\"]\n    }\n    aws.config.region = 'us-east-1'\n    s3 = new aws.S3()\n\nSet the name for your domain.\n\n    module.exports = (url) ->\n      DOMAIN = process.env[\"DOMAIN\"] || \"shortcake.com\"\n      BUCKET = process.env[\"BUCKET\"] || DOMAIN\n      GA_ID = process.env[\"GA_ID\"]\n      shortid.characters \"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ()\"\n\nThis is our basic HTML template that we'll use for doing the redirect. It's just\ngoing to send the user to another page as soon as it's loaded. There's no server\nsince it's just a static file, but everything will be tracked by GA.\n\n      source = \"\"\"\n      <html>\n          <title>{{url}}<\/title>\n          <body>\n            <!-- Google Analytics -->\n            <script type=\"text\/javascript\">\n              (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){\n              (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),\n              m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)\n              })(window,document,'script','\/\/www.google-analytics.com\/analytics.js','ga');\n\n              ga('create', '{{ga_id}}', 'auto');\n              ga('send', 'pageview');\n\n            <\/script>\n            <!-- redirect -->\n            <script type=\"text\/javascript\">\n              window.location.replace('{{url}}');\n            <\/script>\n          <\/body>\n      <\/html>\n      \"\"\"\n\n      template = handlebars.compile(source)\n\nData should just be the user's Google Analytics Id and the URL that they want to\nminify.\n\n      data = { url: url, ga_id: GA_ID }\n      html = template(data)\n\nWe're going to generate a shortlink for the URL. [`shortid`](https:\/\/github.com\/dylang\/shortid) does a pretty good job at balancing between being short, and also\nbeing unique!\n\n      _id = shortid.generate()\n\nWe could break up the files by the [first 3 letters in the id](http:\/\/docs.aws.amazon.com\/AmazonS3\/latest\/dev\/request-rate-perf-considerations.html).\nThis makes it much easier for S3 to distribute the bucket (and greatly improves performance).\n...but we're not going to do this yet.\n\n      params = {\n          Bucket: BUCKET,\n          Key: _id\n          ACL: \"public-read\",\n          Body: html\n      }\n      s3.putObject params, (err, data) ->\n          if err\n              console.log err\n\nWe'll keep a running record of all links we've shortened and throw it into a\nbasic HTML page just to make it easy to do lookups.\n\n      source = \"\"\"\n      <html>\n          <title>Shortened Links<\/title>\n          <body>\n              <h1>Shortened Links<\/h1>\n              <ul>\n              {{#objs}}\n                  <li><a href='{{ Key }}'>{{ Key }}<\/a><\/li>\n              {{\/objs}}\n              <\/ul>\n          <\/body>\n      <\/html>\n      \"\"\"\n      params = { Bucket: BUCKET }\n      s3.listObjects params, (err, objs) ->\n        if err\n            console.log \"[ERROR]: could not list objects: \" + err\n        objs = objs.Contents.filter (obj) ->\n          ! \/index.html$\/.test obj.Key\n        html = handlebars.compile(source)({ objects: objs })\n        params = {\n            Bucket: BUCKET,\n            Key: \"index.html\",\n            ACL: \"public-read\",\n            Body: html\n        }\n        s3.putObject params, (err, data) ->\n            if err\n                console.log \"[ERROR]: \" + err\n        console.error \"Visit: https:\/\/s3.amazonaws.com\/#{BUCKET}\/index.html\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d0e62d3cfb01dc05566a57cab150f8aeff3f6a29","subject":"Measurements don't need a position attribute; they're sorted by date submitted.","message":"Measurements don't need a position attribute; they're sorted by date submitted.\n","repos":"mxipartners\/checksome,fniessink\/checksome","old_file":"lib\/collections\/measurements.litcoffee","new_file":"lib\/collections\/measurements.litcoffee","new_contents":"`Measurements` are ...\n\n    @Measurements = new Mongo.Collection 'measurements'\n\n    Measurements.allow\n      update: (userId, measurement) -> false\n      remove: (userId, measurement) -> false\n\nInsert a new measurement\n\n    @insertMeasurement = (measurementAttributes) ->\n      validateMeasurement measurementAttributes\n      measurement = _.extend measurementAttributes,\n        submitted: new Date()\n        kind: 'measurement'\n\nCreate the measurement\n\n      measurement._id = Measurements.insert measurement\n      return measurement._id\n","old_contents":"`Measurements` are ...\n\n    @Measurements = new Mongo.Collection 'measurements'\n\n    Measurements.allow\n      update: (userId, measurement) -> false\n      remove: (userId, measurement) -> false\n\nInsert a new measurement\n\n    @insertMeasurement = (measurementAttributes) ->\n      validateMeasurement measurementAttributes\n      measurement = _.extend measurementAttributes,\n        submitted: new Date()\n        position: 0\n        kind: 'measurement'\n\nUpdate the positions of the existing measurements\n\n      Measurements.update({_id: m._id}, {$set: {position: m.position+1}}) for m in Measurements.find({projectId: measurement.projectId}).fetch()\n\nCreate the measurement\n\n      measurement._id = Measurements.insert measurement\n      return measurement._id\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3fff6daf194998564f7247f7ea4a13cd80f5d175","subject":"Replace hard coded query logic","message":"Replace hard coded query logic\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.usr}]\n\n#### ToDo\n\n * Limit number of private fields?\n * Limit depth of private fields?\n\n`NB` This section is looping through all of the url query parameters and hence\nshould take the queries from above sections into concideration so we don't need\nto do double amount of work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true, tags: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col]\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n      query = {}\n\n### ?tag=`String`\n\n      if typeof req.query.tag is 'string' and req.query.tag isnt ''\n        if req.query.tag.charAt(0) is '!' and req.query.tag.length > 1\n          query['tags.0'] = $ne: req.query.tag.substr(1)\n        else\n          query['tags.0'] = req.query.tag\n\n### ?grupper=`String`\n\n      if typeof req.query.gruppe is 'string' and req.query.gruppe isnt ''\n        query['grupper'] = req.query.gruppe\n\n### ?after=`Mixed`\n\n      if typeof req.query.after is 'string' and req.query.after isnt ''\n        time = req.query.after\n\n        if not isNaN time\n          # Make unix timestamp into milliseconds\n          time = time + '000' if (time + '').length is 10\n          time = parseInt time\n\n        time = new Date time\n\n        if time.toString() isnt 'Invalid Date'\n          query.endret = $gte: time.toISOString()\n\n### ?bbox=`min_lng`,`min_lat`,`max_lng`,`max_lat`\n\n      if typeof req.query.bbox is 'string' and req.query.bbox.split(',').length is 4\n        bbox = req.query.bbox.split(',')\n        bbox[i] = parseFloat(val) for val, i in bbox\n\n        query.geojson =\n          '$geoWithin':\n            '$geometry':\n              type: 'Polygon'\n              coordinates: [[\n                [bbox[0], bbox[1]]\n                [bbox[2], bbox[1]]\n                [bbox[2], bbox[3]]\n                [bbox[0], bbox[3]]\n                [bbox[0], bbox[1]]\n              ]]\n\n### ?privat.`String`=`String`\n\nThis allows the user to filter documents based on private document properties.\nThis will autumaticly limit returned documents to those owned by the current\nuser.\n\n#### ToDo\n\n * Limit number of private fields?\n * Limit depth of private fields?\n\n`NB` This section is looping through all of the url query parameters and hence\nshould take the queries from above sections into concideration so we don't need\nto do double amount of work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true, tags: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9e932d5eb5578aa3a8aa2b992cbb17daa1889fca","subject":"NativeItem.defineProperty predefined types added","message":"NativeItem.defineProperty predefined types added\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/renderer\/types\/basics\/item\/types\/native.litcoffee","new_file":"src\/renderer\/types\/basics\/item\/types\/native.litcoffee","new_contents":"# Native\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    assert = require 'src\/assert'\n    nativeBridge = require 'src\/native'\n    colorUtils = require 'src\/renderer\/utils\/color'\n\n# **Class** Native : *Item*\n\n    module.exports = (Renderer, Impl, itemUtils) ->\n\n        class Native extends Renderer.Item\n            @__name__ = 'Native'\n            @__path__ = 'Renderer.Native'\n\n            @New = (component, opts) ->\n                item = new this\n                itemUtils.Object.initialize item, component, opts\n                @Initialize? item\n                item\n\n## Native.defineProperty(*Object* config)\n\nDefines new property with the given name.\n\nFor each property, signal `onXXXChange` is created,\nwhere `XXX` is the given name.\n\n`config` parameter must be an object with specified keys:\n- `enabled` - whether it's supported on current platform,\n- `name` - name of the property,\n- `type` - type of predefined condifuration described below,\n- `defaultValue`,\n- `setter`,\n- `getter`,\n- `developmentSetter`\n- `implementationValue` - function returning value passed to the implementation.\n\n### Predefined types\n\n            PROPERTY_TYPES = Object.create null\n\n#### text\n\n            PROPERTY_TYPES.text = ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n\n#### number\n\n            PROPERTY_TYPES.number = ->\n                defaultValue: 0\n                developmentSetter: (val) ->\n                    assert.isFloat val\n\n#### boolean\n\n            PROPERTY_TYPES.boolean = ->\n                defaultValue: false\n                developmentSetter: (val) ->\n                    assert.isBoolean val\n\n#### color\n\n            PROPERTY_TYPES.color = (config) ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n                implementationValue: (val) ->\n                    colorUtils.toRGBAHex val, config.defaultValue\n\n            @defineProperty = (config) ->\n                itemName = @__name__\n                properties = @_properties ||= []\n                config = utils.clone config\n\n                assert.isString itemName, '''\n                    NativeItem.__name__ unique name must be specified\n                '''\n                assert.isObject config, '''\n                    NativeItem.defineProperty config parameter must be an object\n                '''\n                assert.isString config.name, '''\n                    NativeItem property name must be a string\n                '''\n                assert.isNotDefined properties[config.name], \"\"\"\n                    Property #{config.name} is already defined\n                \"\"\"\n                assert.isDefined PROPERTY_TYPES[config.type], \"\"\"\n                    Unknown property type #{config.type}\n                \"\"\" if config.type\n\n                # type\n                if typeConfigFunc = PROPERTY_TYPES[config.type]\n                    typeConfig = typeConfigFunc(config)\n                    for key, val of typeConfig\n                        if key not of config\n                            config[key] = val\n\n                # constructor\n                config.constructor = @\n\n                # internalName\n                config.internalName = itemUtils.getPropInternalName config.name\n\n                # implementation\n                config.implementation = do ->\n                    if config.enabled is false\n                        return utils.NOP\n\n                    ctorName = utils.capitalize itemName\n                    name = utils.capitalize config.name\n                    funcName = \"rendererSet#{ctorName}#{name}\"\n                    (val) ->\n                        nativeBridge.callFunction funcName, @_impl.id, val\n\n                # save\n                properties.push config\n\n                # create\n                itemUtils.defineProperty config\n\n            constructor: ->\n                super()\n\n                # save properties with default values\n                if properties = @constructor._properties\n                    for property in properties\n                        @[property.internalName] = property.defaultValue\n\n## Native::set(*String* propName, *Any* val)\n\n            set: (name, val) ->\n                assert.isString name\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n                funcName = \"rendererSet#{ctorName}#{name}\"\n                nativeBridge.callFunction funcName, id, val\n                return\n\n## Native::call(*String* funcName, *Any* args...)\n\n            call: (name, args...) ->\n                assert.isString name\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n                funcName = \"rendererCall#{ctorName}#{name}\"\n\n                callArgs = [funcName, id, args...]\n                nativeBridge.callFunction.apply nativeBridge, callArgs\n                return\n\n## Native::on(*String* eventName, *Function* listener)\n\n            # nativeEventName -> item id -> [item, listeners...]\n            eventListeners = Object.create null\n\n            createNativeEventListener = (listeners, eventName) -> (id) ->\n                unless itemListeners = listeners[id]\n                    log.warn \"Got a native event '#{eventName}' for an item which \" +\n                        \"didn't register a listener on this event; check if you \" +\n                        \"properly call 'on()' method with a signal listener\"\n                    return\n\n                length = arguments.length\n                args = new Array length - 1\n                for i in [0...length-1] by 1\n                    args[i] = arguments[i + 1]\n\n                item = itemListeners[0]\n                for i in [1...itemListeners.length] by 1\n                    itemListeners[i].apply item, args\n\n                return\n\n            on: (name, func) ->\n                assert.isString name\n                assert.isFunction func\n\n                ctorName = utils.capitalize @constructor.__name__\n                name = utils.capitalize name\n                eventName = \"rendererOn#{ctorName}#{name}\"\n\n                unless listeners = eventListeners[eventName]\n                    listeners = eventListeners[eventName] = Object.create(null)\n                    nativeBridge.on eventName, createNativeEventListener(listeners, eventName)\n\n                itemListeners = listeners[@_impl.id] ?= [@]\n                itemListeners.push func\n                return\n\n        Native\n\n# Glossary\n\n- [Native](#class-native)\n","old_contents":"# Native\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    assert = require 'src\/assert'\n    nativeBridge = require 'src\/native'\n\n# **Class** Native : *Item*\n\n    module.exports = (Renderer, Impl, itemUtils) ->\n\n        class Native extends Renderer.Item\n            @__name__ = 'Native'\n            @__path__ = 'Renderer.Native'\n\n            @New = (component, opts) ->\n                item = new this\n                itemUtils.Object.initialize item, component, opts\n                @Initialize? item\n                item\n\n            @defineProperty = (opts) ->\n                unless opts.hasOwnProperty('constructor')\n                    opts.constructor = this\n                opts.implementation ?= do ->\n                    ctorName = utils.capitalize opts.constructor.__name__\n                    name = utils.capitalize opts.name\n                    funcName = \"rendererSet#{ctorName}#{name}\"\n                    (val) ->\n                        nativeBridge.callFunction funcName, @_impl.id, val\n                itemUtils.defineProperty opts\n\n            constructor: ->\n                super()\n\n## Native::set(*String* propName, *Any* val)\n\n            set: (name, val) ->\n                assert.isString name\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n                funcName = \"rendererSet#{ctorName}#{name}\"\n                nativeBridge.callFunction funcName, id, val\n                return\n\n## Native::call(*String* funcName, *Any* args...)\n\n            call: (name, args...) ->\n                assert.isString name\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n                funcName = \"rendererCall#{ctorName}#{name}\"\n\n                callArgs = [funcName, id, args...]\n                nativeBridge.callFunction.apply nativeBridge, callArgs\n                return\n\n## Native::on(*String* eventName, *Function* listener)\n\n            # nativeEventName -> item id -> [item, listeners...]\n            eventListeners = Object.create null\n\n            createNativeEventListener = (listeners, eventName) -> (id) ->\n                unless itemListeners = listeners[id]\n                    log.warn \"Got a native event '#{eventName}' for an item which \" +\n                        \"didn't register a listener on this event; check if you \" +\n                        \"properly call 'on()' method with a signal listener\"\n                    return\n\n                length = arguments.length\n                args = new Array length - 1\n                for i in [0...length-1] by 1\n                    args[i] = arguments[i + 1]\n\n                item = itemListeners[0]\n                for i in [1...itemListeners.length] by 1\n                    itemListeners[i].apply item, args\n\n                return\n\n            on: (name, func) ->\n                assert.isString name\n                assert.isFunction func\n\n                ctorName = utils.capitalize @constructor.__name__\n                name = utils.capitalize name\n                eventName = \"rendererOn#{ctorName}#{name}\"\n\n                unless listeners = eventListeners[eventName]\n                    listeners = eventListeners[eventName] = Object.create(null)\n                    nativeBridge.on eventName, createNativeEventListener(listeners, eventName)\n\n                itemListeners = listeners[@_impl.id] ?= [@]\n                itemListeners.push func\n                return\n\n        Native\n\n# Glossary\n\n- [Native](#class-native)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"78dbdff26c14f241f0e1ef10e945e02bf2ef69e1","subject":"docs: nextIfError -> skipIfError","message":"docs: nextIfError -> skipIfError\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/12_storage_adapters.litcoffee","new_file":"docs\/12_storage_adapters.litcoffee","new_contents":"# Batman.StorageAdapter\n\n`Batman.StorageAdapter`s handle persistence of [`Batman.Model`s](\/docs\/api\/batman.model.html). Any `Batman.Model` which will be created, read, updated or deleted must have a storage adapter, which is declared with [`Batman.Model@persist`](\/docs\/api\/batman.model.html#class_function_persist):\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @persist Batman.RestStorage # a StorageAdapter subclass\n```\n\n__Protip:__ Consider setting the storage adapter in one `Batman.Model` subclass, then extending that subclass in the rest of your app. Then, you won't have to call `@persist` every time:\n\n```coffeescript\nclass App.Model extends Batman.Model\n  @persist Batman.LocalStorage\n\nclass App.Superhero extends App.Model\n  # no need to call @persist here!\n\nclass App.Sidekick extends App.Model\n  # or here!\n```\n\n### Batman's Included StorageAdapters\n\nBatman ships with a few storage adapters to get you up and coding quickly:\n\n- `Batman.LocalStorage` uses [`window.localStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#localStorage) to persist records.\n- `Batman.SessionStorage` extends `Batman.LocalStorage` and uses [`window.sessionStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#sessionStorage) to persist records.\n- `Batman.RestStorage` uses [HTTP REST](http:\/\/en.wikipedia.org\/wiki\/REST) to persist records, mapping HTTP verbs to storage operations and handling HTTP response codes appropriately. _Note: Because `Batman.RestStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\n### Batman.RailsStorage\nAlso, `Batman.RailsStorage` (available in separate file: [Coffee](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.rails.coffee), JS) extends `Batman.RestStorage` and provides some helpful Rails integrations:\n\n- If the response's status code is 422 (`Unprocessable Entity`), Any `errors` defined in the JSON response will be added to the `Batman.Model`'s [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n- By default, Batman will get the Rails CSRF token from the `<head>`and send it as a request header. (This can be prevented by setting `Batman.config.protectFromCSRF = false`.)\n- If a record's URL doesn't end in `.json` and doesn't include a query string, `.json` is automatically appended to the URL.\n\n\n_Note: Like `Batman.RestStorage`, `Batman.RailsStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), so you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\nIf you're using Batman and Rails, be sure to check out the [batman-rails](https:\/\/github.com\/batmanjs\/batman-rails) gem.\n\n## Subclassing Batman.StorageAdapter\n\nYou may want to customize Batman's storage operations for your own app, for example:\n\n- Adding before- and after-operation callbacks\n- Overriding default storage operations\n\nTo do this, extend `Batman.StorageAdapter` (or one of the provided subclasses), then use your storage adapter to persist your models.\n```\nclass App.HeroicStorageAdapter extends Batman.LocalStorage\n  # filters, overrides\n\nclass App.Superhero extends Batman.Model\n  @persist App.HeroicStorageAdapter\n```\n### `env` and `next`\n\nStorage operations and callbacks each take two arguments: `env` and `next`.\n\n`env` is a vanilla JS object which is passed to each function in the chain. `Batman.StorageAdapter` sets these attributes on `env`:\n\n- `env.subject` is the `Batman.Model` record which had the storage operation called on it.\n- `env.options` contains the options passed to the operation on the subject.\n- `env.action` is the storage operation that will be executed by the storage adapter.\n- `env.error` stores any errors that occur during the chain. It becomes the first argument to the operation callback.\n- `env.result` contains the record(s) returned by the operation and should be set by the storage adapter implementation. It becomes the second argument to the operation's callback.\n\nStorage adapters may use `env` to collect any extra information needed by their operations. For example, `Batman.RestStorage` adds some attributes to `env` and `env.options`:\n\n- `env.request` is the `Batman.Request` which implements the storage operation.\n- `env.options.method` is the HTTP method used by `Batman.Request` to implement the storage operation.\n- `env.options.url` is the URL used by `Batman.Request` to implement the storage operation.\n\n`next` is a reference to the next function in the call chain for the current storage operation. `Batman.StorageAdapter` uses this to execute before-filters, storage operations and after-filters in the correct sequence.\n\n\n`next` should be called (`next()`) when the current function has completed. This indicates that the operation should proceed with the next function in its call chain. To ensure the completion of the call chain, consider wrapping your function in [`@skipIfError`](\/docs\/api\/batman.storageadapter.html#class_function_skipiferror).\n\n\n### Adding Callbacks\n\nCallbacks can be registered with [`before`](\/docs\/api\/batman.storageadapter.html#prototype_function_before) and [`after`](\/docs\/api\/batman.storageadapter.html#prototype_function_after) on any storage operation (listed below) or `'all'` (which runs the callback before or after any operation). Callbacks accept two arguments, `env` and `next`, discussed below.\n\n```coffeescript\nclass App.SpecificHeaderStorageAdapter extends Batman.RestStorage\n  # include a specific header in all requests:\n  @::before 'all', (env, next) ->\n    headers = env.options.headers || {}\n    headers[\"App-Specific-Header\"] = App.getSpecificHeader()\n    next()\n\n  @::after 'create', (env, next) ->\n    console.log \"A #{env.subject.constructor.name} was created!\"\n    next()\n```\n\n## Storage Operations\n\nAny `StorageAdapter` must implement these operations as instance methods, for example:\n\n\n```\nclass App.ModifiedStorageAdapter extends Batman.RestStorage\n  destroy: (env, next) ->\n    # your custom destroy operation\n    next()\n```\n\nWhen a record is saved, destroyed or loaded, `Batman.StorageAdapter` invokes these methods. Although you may reimplement them, you probably don't need to call them in your application code.\n\n## ::create(env : Object, next : Function)\nCalled to save a new record. When `save` is called on a record and `isNew` returns `true`, the storage adapter's `create` method is called.\n\n## ::read(env : Object, next : Function)\nCalled to load a record from storage.\n\n## ::update(env : Object, next : Function)\nCalled to update an existing record. When `save` is called on a record and `isNew` returns `false`, the storage adapter's `update` method is called.\n\n## ::destroy(env : Object, next : Function)\nCalled to destroy an existing record.\n\n## ::readAll(env : Object, next : Function)\nCalled to load all records of a particular type from storage.\n\n## Other Useful Methods\n\n## @skipIfError(wrappedFunction : Function )\n\nWraps a function, bypassing the function body and calling next() if an error has already occurred.\n\n    test \"StorageAdapter@skipIfError doesn't call the function if env.error?\", ->\n      insideFunction = createSpy()\n      nextFunction = createSpy()\n\n      functionWithWrapper = Batman.LocalStorage.skipIfError (env, next) ->\n        insideFunction()\n\n      dummyEnv = {error: true}\n\n      functionWithWrapper(dummyEnv, nextFunction)\n\n      equal dummyEnv.error?, true, 'an error is present'\n      equal insideFunction.called, false, 'insideFunction was skipped'\n      equal nextFunction.called, true, 'nextFunction was called'\n\nInside a storage adapter definition, this function is referenced as `@skipIfError`, for example:\n\n```\nclass App.SpecialStorageAdapter extends Batman.RestStorage\n  @::before 'create', @skipIfError (env, next) ->\n    console.log(\"This will be skipped if env.error? is true!\")\n    next()\n```\n\n## ::before (keys... : Strings, filter : Function)\nRegisters `filter` as a before-operation callback for the storage operations named by `keys...`.\n\n## ::after (keys... : Strings, filter : Function)\nRegisters `filter` as a after-operation callback for the storage operations named by `keys...`.\n","old_contents":"# Batman.StorageAdapter\n\n`Batman.StorageAdapter`s handle persistence of [`Batman.Model`s](\/docs\/api\/batman.model.html). Any `Batman.Model` which will be created, read, updated or deleted must have a storage adapter, which is declared with [`Batman.Model@persist`](\/docs\/api\/batman.model.html#class_function_persist):\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @persist Batman.RestStorage # a StorageAdapter subclass\n```\n\n__Protip:__ Consider setting the storage adapter in one `Batman.Model` subclass, then extending that subclass in the rest of your app. Then, you won't have to call `@persist` every time:\n\n```coffeescript\nclass App.Model extends Batman.Model\n  @persist Batman.LocalStorage\n\nclass App.Superhero extends App.Model\n  # no need to call @persist here!\n\nclass App.Sidekick extends App.Model\n  # or here!\n```\n\n### Batman's Included StorageAdapters\n\nBatman ships with a few storage adapters to get you up and coding quickly:\n\n- `Batman.LocalStorage` uses [`window.localStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#localStorage) to persist records.\n- `Batman.SessionStorage` extends `Batman.LocalStorage` and uses [`window.sessionStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#sessionStorage) to persist records.\n- `Batman.RestStorage` uses [HTTP REST](http:\/\/en.wikipedia.org\/wiki\/REST) to persist records, mapping HTTP verbs to storage operations and handling HTTP response codes appropriately. _Note: Because `Batman.RestStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\n### Batman.RailsStorage\nAlso, `Batman.RailsStorage` (available in separate file: [Coffee](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.rails.coffee), JS) extends `Batman.RestStorage` and provides some helpful Rails integrations:\n\n- If the response's status code is 422 (`Unprocessable Entity`), Any `errors` defined in the JSON response will be added to the `Batman.Model`'s [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n- By default, Batman will get the Rails CSRF token from the `<head>`and send it as a request header. (This can be prevented by setting `Batman.config.protectFromCSRF = false`.)\n- If a record's URL doesn't end in `.json` and doesn't include a query string, `.json` is automatically appended to the URL.\n\n\n_Note: Like `Batman.RestStorage`, `Batman.RailsStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), so you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\nIf you're using Batman and Rails, be sure to check out the [batman-rails](https:\/\/github.com\/batmanjs\/batman-rails) gem.\n\n## Subclassing Batman.StorageAdapter\n\nYou may want to customize Batman's storage operations for your own app, for example:\n\n- Adding before- and after-operation callbacks\n- Overriding default storage operations\n\nTo do this, extend `Batman.StorageAdapter` (or one of the provided subclasses), then use your storage adapter to persist your models.\n```\nclass App.HeroicStorageAdapter extends Batman.LocalStorage\n  # filters, overrides\n\nclass App.Superhero extends Batman.Model\n  @persist App.HeroicStorageAdapter\n```\n### `env` and `next`\n\nStorage operations and callbacks each take two arguments: `env` and `next`.\n\n`env` is a vanilla JS object which is passed to each function in the chain. `Batman.StorageAdapter` sets these attributes on `env`:\n\n- `env.subject` is the `Batman.Model` record which had the storage operation called on it.\n- `env.options` contains the options passed to the operation on the subject.\n- `env.action` is the storage operation that will be executed by the storage adapter.\n- `env.error` stores any errors that occur during the chain. It becomes the first argument to the operation callback.\n- `env.result` contains the record(s) returned by the operation and should be set by the storage adapter implementation. It becomes the second argument to the operation's callback.\n\nStorage adapters may use `env` to collect any extra information needed by their operations. For example, `Batman.RestStorage` adds some attributes to `env` and `env.options`:\n\n- `env.request` is the `Batman.Request` which implements the storage operation.\n- `env.options.method` is the HTTP method used by `Batman.Request` to implement the storage operation.\n- `env.options.url` is the URL used by `Batman.Request` to implement the storage operation.\n\n`next` is a reference to the next function in the call chain for the current storage operation. `Batman.StorageAdapter` uses this to execute before-filters, storage operations and after-filters in the correct sequence.\n\n\n`next` should be called (`next()`) when the current function has completed. This indicates that the operation should proceed with the next function in its call chain. To ensure the completion of the call chain, consider wrapping your function in [`@nextIfError`](\/docs\/api\/batman.storageadapter.html#class_function_nextiferror).\n\n\n### Adding Callbacks\n\nCallbacks can be registered with [`before`](\/docs\/api\/batman.storageadapter.html#prototype_function_before) and [`after`](\/docs\/api\/batman.storageadapter.html#prototype_function_after) on any storage operation (listed below) or `'all'` (which runs the callback before or after any operation). Callbacks accept two arguments, `env` and `next`, discussed below.\n\n```coffeescript\nclass App.SpecificHeaderStorageAdapter extends Batman.RestStorage\n  # include a specific header in all requests:\n  @::before 'all', (env, next) ->\n    headers = env.options.headers || {}\n    headers[\"App-Specific-Header\"] = App.getSpecificHeader()\n    next()\n\n  @::after 'create', (env, next) ->\n    console.log \"A #{env.subject.constructor.name} was created!\"\n    next()\n```\n\n## Storage Operations\n\nAny `StorageAdapter` must implement these operations as instance methods, for example:\n\n\n```\nclass App.ModifiedStorageAdapter extends Batman.RestStorage\n  destroy: (env, next) ->\n    # your custom destroy operation\n    next()\n```\n\nWhen a record is saved, destroyed or loaded, `Batman.StorageAdapter` invokes these methods. Although you may reimplement them, you probably don't need to call them in your application code.\n\n## ::create(env : Object, next : Function)\nCalled to save a new record. When `save` is called on a record and `isNew` returns `true`, the storage adapter's `create` method is called.\n\n## ::read(env : Object, next : Function)\nCalled to load a record from storage.\n\n## ::update(env : Object, next : Function)\nCalled to update an existing record. When `save` is called on a record and `isNew` returns `false`, the storage adapter's `update` method is called.\n\n## ::destroy(env : Object, next : Function)\nCalled to destroy an existing record.\n\n## ::readAll(env : Object, next : Function)\nCalled to load all records of a particular type from storage.\n\n## Other Useful Methods\n\n## @nextIfError(wrappedFunction : Function )\n\nWraps a function, bypassing the function body and calling next() if an error has already occurred.\n\n    test \"StorageAdapter@skipIfError doesn't call the function if env.error?\", ->\n      insideFunction = createSpy()\n      nextFunction = createSpy()\n\n      functionWithWrapper = Batman.LocalStorage.skipIfError (env, next) ->\n        insideFunction()\n\n      dummyEnv = {error: true}\n\n      functionWithWrapper(dummyEnv, nextFunction)\n\n      equal dummyEnv.error?, true, 'an error is present'\n      equal insideFunction.called, false, 'insideFunction was skipped'\n      equal nextFunction.called, true, 'nextFunction was called'\n\nInside a storage adapter definition, this function is referenced as `@skipIfError`, for example:\n\n```\nclass App.SpecialStorageAdapter extends Batman.RestStorage\n  @::before 'create', @skipIfError (env, next) ->\n    console.log(\"This will be skipped if env.error? is true!\")\n    next()\n```\n\n## ::before (keys... : Strings, filter : Function)\nRegisters `filter` as a before-operation callback for the storage operations named by `keys...`.\n\n## ::after (keys... : Strings, filter : Function)\nRegisters `filter` as a after-operation callback for the storage operations named by `keys...`.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4156ae869628f7da7c0410febef8a9dff9429033","subject":"Add error on malformed hyperlink object.","message":"Add error on malformed hyperlink object.\n","repos":"orgsync\/node-xlsx-writestream,STRML\/node-xlsx-writestream","old_file":"src\/index.litcoffee","new_file":"src\/index.litcoffee","new_contents":"Node-XLSX-Writer\n================\n\nNode-XLSX-Writer is written in literate coffeescript. The following is the actual source of the \nmodule.\n\n    fs = require('fs')\n    blobs = require('.\/blobs')\n    Archiver = require('archiver')\n    numberRegex = \/^[1-9\\.][\\d\\.]+$\/\n\n    module.exports = class XlsxWriter\n\n\n\n### Simple writes\n\n##### XlsxWriter.write(out: String, data: Array, cb: Function)\n\nThe simplest way to use Node-XLSX-Writer is to use the write method.\n\nThe callback comes directly from `fs.writeFile` and has the arity `(err)`\n\n      # @param {String} out Output file path.\n      # @param {Array} data Data to write.\n      # @param {Function} cb Callback to call when done. Fed (err).\n      @write = (out, data, cb) ->\n          writer = new XlsxWriter({out: out})\n          writer.addRows(data)\n          writer.writeToFile(cb)\n\n### Advanced usage\n\nNode-XLSX-Writer has more advanced features available for better customization\nof spreadsheets.\n\nWhen constructing a writer, pass it an optional file path and customization options.\n\n##### new XlsxWriter([options]: Object) : XlsxWriter\n\n      # Build a writer object.\n      # @param {Object} [options] Preparation options.\n      # @param {String} [options.out] Output file path.\n      # @param {Array}  [options.columns] Column definition. Must be added in constructor.\n      # @example options.columns = [\n      #     {  width: 30 }, \/\/ width is in 'characters'\n      #     {  width: 10 }\n      # ]\n      constructor: (options = {}) ->\n\n        # Support just passing a string path into the constructor.\n        if (typeof options == 'string')\n          options = {out: options}\n\n        # Set options.\n        defaults = {\n            defaultWidth: 15\n            zip: {\n              forceUTC: true # this is required, zips will be unreadable without it\n            },\n            columns: []\n        }\n        @options = _extend(defaults, options)\n\n        # Start sheet.\n        @_resetSheet()\n\n        # Write column definition.\n        @defineColumns(@options.columns)\n\n        # Create Zip.\n        zipOptions = @options.zip || {}\n        zipOptions.forceUTC = true # force this on in all cases for now, otherwise we're useless\n        @zip = Archiver('zip', zipOptions)\n\n        # Archiver attaches an exit listener on the process, we don't want this,\n        # it will fire if this object is never finalized.\n        @zip.catchEarlyExitAttached = true \n\n        # Hook this passthrough into the zip stream.\n        @zip.append(@sheetStream, {name: 'xl\/worksheets\/sheet1.xml'})\n\n#### Adding rows\n\nRows are easy to add one by one or all at once. Data types within the sheet will \nbe inferred from the data types passed to addRow().\n\n##### addRow(row: Object)\n\nAdd a single row.\n\n      # @example (javascript)\n      # writer.addRow({\n      #     \"A String Column\" : \"A String Value\",\n      #     \"A Number Column\" : 12345,\n      #     \"A Date Column\" : new Date(1999,11,31)\n      # })\n      addRow: (row) ->\n\n        # Values in header are defined by the keys of the object we've passed in.\n        # They need to be written the first time they're passed in.\n        if !@haveHeader\n          @_write(blobs.sheetDataHeader)\n          @_startRow()\n          col = 1\n          for key of row\n            @_addCell(key, col)\n            @cellMap.push(key)\n            col += 1\n          @_endRow()\n\n          @haveHeader = true\n\n        @_startRow()\n        for key, col in @cellMap\n          @_addCell(row[key] || \"\", col + 1)\n        @_endRow()\n\n##### addRows(rows: Array)\n\nRows can be added in batch.\n\n      addRows: (rows) ->\n        for row in rows\n          @addRow(row)\n\n##### defineColumns(columns: Array)\n\nColumn definitions can be easily added, but it *must* be done before rows are added\nto prevent a nasty Excel bug.\n\n      # @example (javascript)\n      # writer.defineColumns([\n      #     {  width: 30 }, \/\/ width is in 'characters'\n      #     {  width: 10 }\n      # ])\n      defineColumns: (columns) ->\n        if @haveHeader\n          throw new Error \"\"\"\n            Columns cannot be added after rows! Unfortunately Excel will crash\n            if column definitions come after sheet data. Please move your `defineColumns()`\n            call before any `addRow()` calls, or define options.columns in the XlsxWriter\n            constructor.\n          \"\"\"\n        @options.columns = columns\n        # Write column metadata.\n        # Would really like to do this at the end so that we don't have to mandate\n        # it comes first, but Excel pukes if <cols> comes before <sheetData>.\n        @_write(@_generateColumnDefinition())\n\n\n#### File generation\n\nOnce you are done adding rows & defining columns, you have a few options\nfor generating the file. The `writeToFile` helper is a one-stop-shop for writing\ndirectly to a file using `fs.writeFile`; otherwise, you can pack() manually,\nwhich will return a readable stream.\n\n##### writeToFile([fileName]: String, cb: Function)\n\nWrites data to a file. Convenience method.\n\nIf no filename is specified, will attempt to use the one specified in the\nconstructor as `options.out`.\n\nThe callback is fed directly to `fs.writeFile`.\n\n      # @param {String} [fileName] File path to write.\n      # @param {Function} cb Callback.\n      writeToFile: (fileName, cb) ->\n        if fileName instanceof Function\n          cb = fileName\n          fileName = @options.out\n        if !fileName\n          throw new Error(\"Filename required. Supply one in writeToFile() or in options.out.\")\n\n        # Create zip, pipe it into a file writeStream.\n        zip = @createReadStream(fileName)\n        fileStream = fs.createWriteStream(fileName);\n        fileStream.once 'finish', cb\n        zip.pipe(fileStream)\n\n\n##### createReadStream([jsZipOptions]: Object) : Stream\n\nPacks the file and returns a readable stream. You can pipe this directly to a file\nor response object. Be sure to use 'binary' mode.\n\nWill finalize the sheet & generate shared strings if they haven't been already. \n\n      # @return {Stream} Readable stream with ZIP data.\n      createReadStream: (options) ->\n\n        # Finalize sheet if it hasn't been already.\n        if (!@finalized)\n          @finalize()\n\n        @zip\n          .append(blobs.contentTypes, {name: '[Content_Types].xml'})\n          .append(blobs.rels, {name: '_rels\/.rels'})\n          .append(blobs.workbook, {name: 'xl\/workbook.xml'})\n          .append(blobs.styles, {name: 'xl\/styles.xml'})\n          .append(blobs.workbookRels, {name: 'xl\/_rels\/workbook.xml.rels'})\n          .append(@relsData, {name: 'xl\/worksheets\/_rels\/sheet1.xml.rels'})\n          .append(@stringsData, {name: 'xl\/sharedStrings.xml'})\n          .finalize()\n\n        return @zip\n\n##### finalize()\n\nFinishes up the sheet & generate shared strings.\n\n      finalize: () ->\n\n        # If there was data, end sheetData\n        if @haveHeader\n          @_write(blobs.sheetDataFooter)\n\n        # Write relationships data.\n        @_write(blobs.worksheetRels(@relationships))\n\n        # End sheet\n        @sheetStream.end(blobs.sheetFooter);\n\n        # Generate shared strings\n        @_generateStrings()\n\n        # Generate external rels\n        @_generateRelationships()\n\n        # Mark this as finished\n        @finalized = true\n\n##### dispose()\n\nCancel use of this writer and close all streams. This is not needed if you've written to a file.\n\n      dispose: () ->\n        return if @disposed\n\n        @sheetStream.end()\n        @sheetStream.unpipe()\n        @zip.unpipe()\n        while(@zip.read()) # drain stream\n          1; # noop\n        delete @zip\n        delete @sheetStream\n        @disposed = true\n\n\n#### Internal methods\n\n\nAdds a cell to the row in progress.\n\n      # @param {String|Number|Date} value Value to write.\n      # @param {Number}             col   Column index.\n      _addCell: (value = '', col) ->\n        row = @currentRow\n        cell = @_getCellIdentifier(row, col)\n\n        # Hyperlink support\n        if Object.prototype.toString.call(value) == '[object Object]'\n          if !value.value || !value.hyperlink\n            throw new Error(\"A hyperlink cell must have both 'value' and 'hyperlink' keys.\")\n          @_addCell(value.value, col)\n          @_createRelationship(cell, value.hyperlink)\n          return\n\n        if typeof value == 'number' or numberRegex.test(value)\n          @rowBuffer += blobs.numberCell(value, cell)\n        else if value instanceof Date\n          date = @_dateToOADate(value)\n          @rowBuffer += blobs.dateCell(date, cell)\n        else\n          index = @_lookupString(value)\n          @rowBuffer += blobs.cell(index, cell)\n\n\n\nBegins a row. Call this before starting any row. Will start a buffer\nfor all proceeding cells, until @_endRow is called.\n\n      _startRow: () ->\n        @rowBuffer = blobs.startRow(@currentRow)\n        @currentRow += 1\n\nEnds a row. Will write the row to the sheet.\n\n      _endRow: () ->\n        @_write(@rowBuffer + blobs.endRow)\n\nGiven row and column indices, returns a cell identifier, e.g. \"E20\"\n\n      # @param {Number} row  Row index.\n      # @param {Number} cell Cell index.\n      # @return {String}     Cell identifier.\n      _getCellIdentifier: (row, col) ->\n        colIndex = ''\n        if @cellLabelMap[col]\n          colIndex = @cellLabelMap[col]\n        else\n          if col == 0\n            # Provide a fallback for empty spreadsheets\n            row = 1\n            col = 1\n\n          input = (+col - 1).toString(26)\n          while input.length\n            a = input.charCodeAt(input.length - 1)\n            colIndex = String.fromCharCode(a + if a >= 48 and a <= 57 then 17 else -22) + colIndex\n            input = if input.length > 1 then (parseInt(input.substr(0, input.length - 1), 26) - 1).toString(26) else \"\"\n          @cellLabelMap[col] = colIndex\n\n        return colIndex + row\n\nCreates column definitions, if any definitions exist.\nThis will write column styles, widths, etc.\n\n      # @return {String} Column definition.\n      _generateColumnDefinition: () ->\n        # <cols\/> tag (empty) crashes excel, weeeeee\n        if !@options.columns || !@options.columns.length\n          return ''\n\n        columnDefinition = ''\n        columnDefinition += blobs.startColumns\n\n        idx = 1\n        for index, column of @options.columns\n          columnDefinition += blobs.column(column.width || @options.defaultWidth, idx)\n          idx += 1\n\n        columnDefinition += blobs.endColumns\n        return columnDefinition\n\nGenerates StringMap XML. Used as a finalization step - don't call this while\nbuilding the xlsx is in progress.\n\nSaves string data to this object so it can be written to the zip.\n\n      _generateStrings: () ->\n        stringTable = ''\n        for string in @strings\n          stringTable += blobs.string(@escapeXml(string))\n        @stringsData = blobs.stringsHeader(@strings.length) + stringTable + blobs.stringsFooter\n\nLooks up a string inside the internal string map. If it doesn't exist, it will be added to the map.\n\n      # @param {String} value String to look up.\n      # @return {Number}      Index within the string map where this string is located.\n      _lookupString: (value) ->\n        if !@stringMap[value]\n          @stringMap[value] = @stringIndex\n          @strings.push(value)\n          @stringIndex += 1\n        return @stringMap[value]\n\nCreate a relationship. For now, this is always a hyperlink. This writes to a array that will later be used define the rels.\n\n      _createRelationship: (cell, target) ->\n        @relationships.push({cell: cell, target: target})\n\nGenerate external relationships data. This is saved into \"xl\/worksheets\/_rels\/sheet1.xml.rels\".\n\n      _generateRelationships: () ->\n        @relsData = blobs.externalWorksheetRels(@relationships)\n\nConverts a Date to an OADate.\nSee [this stackoverflow post](http:\/\/stackoverflow.com\/a\/15550284\/2644351)\n\n      # @param {Date} date Date to convert.\n      # @return {Number}   OADate.\n      _dateToOADate: (date) ->\n        epoch = new Date(1899,11,30)\n        msPerDay = 8.64e7\n\n        v = -1 * (epoch - date) \/ msPerDay;\n\n        # Deal with dates prior to 1899-12-30 00:00:00\n        dec = v - Math.floor(v)\n\n        if v < 0 and dec\n          v = Math.floor(v) - dec\n\n        return v\n\nConvert an OADate to a Date.\n\n      # @param {Number} oaDate OADate.\n      # @return {Date}         Converted date.\n      _OADateToDate: (oaDate) ->\n        epoch = new Date(1899,11,30)\n        msPerDay = 8.64e7\n\n        # Deal with -ve values\n        dec = oaDate - Math.floor(oaDate)\n\n        if oaDate < 0 and dec\n          oaDate = Math.floor(oaDate) - dec\n\n        return new Date(oaDate * msPerDay + +epoch)\n\nResets sheet data. Called on initialization.\n\n      _resetSheet: () ->\n\n        # Sheet data storage.\n        @sheetData = ''\n        @strings = []\n        @stringMap = {}\n        @stringIndex = 0\n        @stringData = null\n        @currentRow = 0\n\n        # Cell data storage\n        @cellMap = []\n        @cellLabelMap = {}\n\n        # Column data storage\n        @columns = []\n\n        # Rels data storage\n        @relData = ''\n        @relationships = []\n\n        # Flags\n        @haveHeader = false\n        @finalized = false\n\n        # Create sheet stream.\n        PassThrough = require('stream').PassThrough\n        @sheetStream = new PassThrough()\n\n        # Start off the sheet.\n        @_write(blobs.sheetHeader)\n\nWrapper around writing sheet data.\n\n      # @param {String} data Data to write to the sheet.\n      _write: (data) ->\n        @sheetStream.write(data)\n\nUtility method for escaping XML - used within blobs and can be used manually.\n\n      # @param {String} str String to escape.\n      escapeXml: (str = '') ->\n        return str.replace(\/&\/g, '&amp;')\n          .replace(\/<\/g, '&lt;')\n          .replace(\/>\/g, '&gt;')\n\nSimple extend helper.\n\n    _extend = (dest, src) ->\n      for key, val of src\n        dest[key] = val\n      dest \n","old_contents":"Node-XLSX-Writer\n================\n\nNode-XLSX-Writer is written in literate coffeescript. The following is the actual source of the \nmodule.\n\n    fs = require('fs')\n    blobs = require('.\/blobs')\n    Archiver = require('archiver')\n    numberRegex = \/^[1-9\\.][\\d\\.]+$\/\n\n    module.exports = class XlsxWriter\n\n\n\n### Simple writes\n\n##### XlsxWriter.write(out: String, data: Array, cb: Function)\n\nThe simplest way to use Node-XLSX-Writer is to use the write method.\n\nThe callback comes directly from `fs.writeFile` and has the arity `(err)`\n\n      # @param {String} out Output file path.\n      # @param {Array} data Data to write.\n      # @param {Function} cb Callback to call when done. Fed (err).\n      @write = (out, data, cb) ->\n          writer = new XlsxWriter({out: out})\n          writer.addRows(data)\n          writer.writeToFile(cb)\n\n### Advanced usage\n\nNode-XLSX-Writer has more advanced features available for better customization\nof spreadsheets.\n\nWhen constructing a writer, pass it an optional file path and customization options.\n\n##### new XlsxWriter([options]: Object) : XlsxWriter\n\n      # Build a writer object.\n      # @param {Object} [options] Preparation options.\n      # @param {String} [options.out] Output file path.\n      # @param {Array}  [options.columns] Column definition. Must be added in constructor.\n      # @example options.columns = [\n      #     {  width: 30 }, \/\/ width is in 'characters'\n      #     {  width: 10 }\n      # ]\n      constructor: (options = {}) ->\n\n        # Support just passing a string path into the constructor.\n        if (typeof options == 'string')\n          options = {out: options}\n\n        # Set options.\n        defaults = {\n            defaultWidth: 15\n            zip: {\n              forceUTC: true # this is required, zips will be unreadable without it\n            },\n            columns: []\n        }\n        @options = _extend(defaults, options)\n\n        # Start sheet.\n        @_resetSheet()\n\n        # Write column definition.\n        @defineColumns(@options.columns)\n\n        # Create Zip.\n        zipOptions = @options.zip || {}\n        zipOptions.forceUTC = true # force this on in all cases for now, otherwise we're useless\n        @zip = Archiver('zip', zipOptions)\n\n        # Archiver attaches an exit listener on the process, we don't want this,\n        # it will fire if this object is never finalized.\n        @zip.catchEarlyExitAttached = true \n\n        # Hook this passthrough into the zip stream.\n        @zip.append(@sheetStream, {name: 'xl\/worksheets\/sheet1.xml'})\n\n#### Adding rows\n\nRows are easy to add one by one or all at once. Data types within the sheet will \nbe inferred from the data types passed to addRow().\n\n##### addRow(row: Object)\n\nAdd a single row.\n\n      # @example (javascript)\n      # writer.addRow({\n      #     \"A String Column\" : \"A String Value\",\n      #     \"A Number Column\" : 12345,\n      #     \"A Date Column\" : new Date(1999,11,31)\n      # })\n      addRow: (row) ->\n\n        # Values in header are defined by the keys of the object we've passed in.\n        # They need to be written the first time they're passed in.\n        if !@haveHeader\n          @_write(blobs.sheetDataHeader)\n          @_startRow()\n          col = 1\n          for key of row\n            @_addCell(key, col)\n            @cellMap.push(key)\n            col += 1\n          @_endRow()\n\n          @haveHeader = true\n\n        @_startRow()\n        for key, col in @cellMap\n          @_addCell(row[key] || \"\", col + 1)\n        @_endRow()\n\n##### addRows(rows: Array)\n\nRows can be added in batch.\n\n      addRows: (rows) ->\n        for row in rows\n          @addRow(row)\n\n##### defineColumns(columns: Array)\n\nColumn definitions can be easily added, but it *must* be done before rows are added\nto prevent a nasty Excel bug.\n\n      # @example (javascript)\n      # writer.defineColumns([\n      #     {  width: 30 }, \/\/ width is in 'characters'\n      #     {  width: 10 }\n      # ])\n      defineColumns: (columns) ->\n        if @haveHeader\n          throw new Error \"\"\"\n            Columns cannot be added after rows! Unfortunately Excel will crash\n            if column definitions come after sheet data. Please move your `defineColumns()`\n            call before any `addRow()` calls, or define options.columns in the XlsxWriter\n            constructor.\n          \"\"\"\n        @options.columns = columns\n        # Write column metadata.\n        # Would really like to do this at the end so that we don't have to mandate\n        # it comes first, but Excel pukes if <cols> comes before <sheetData>.\n        @_write(@_generateColumnDefinition())\n\n\n#### File generation\n\nOnce you are done adding rows & defining columns, you have a few options\nfor generating the file. The `writeToFile` helper is a one-stop-shop for writing\ndirectly to a file using `fs.writeFile`; otherwise, you can pack() manually,\nwhich will return a readable stream.\n\n##### writeToFile([fileName]: String, cb: Function)\n\nWrites data to a file. Convenience method.\n\nIf no filename is specified, will attempt to use the one specified in the\nconstructor as `options.out`.\n\nThe callback is fed directly to `fs.writeFile`.\n\n      # @param {String} [fileName] File path to write.\n      # @param {Function} cb Callback.\n      writeToFile: (fileName, cb) ->\n        if fileName instanceof Function\n          cb = fileName\n          fileName = @options.out\n        if !fileName\n          throw new Error(\"Filename required. Supply one in writeToFile() or in options.out.\")\n\n        # Create zip, pipe it into a file writeStream.\n        zip = @createReadStream(fileName)\n        fileStream = fs.createWriteStream(fileName);\n        fileStream.once 'finish', cb\n        zip.pipe(fileStream)\n\n\n##### createReadStream([jsZipOptions]: Object) : Stream\n\nPacks the file and returns a readable stream. You can pipe this directly to a file\nor response object. Be sure to use 'binary' mode.\n\nWill finalize the sheet & generate shared strings if they haven't been already. \n\n      # @return {Stream} Readable stream with ZIP data.\n      createReadStream: (options) ->\n\n        # Finalize sheet if it hasn't been already.\n        if (!@finalized)\n          @finalize()\n\n        @zip\n          .append(blobs.contentTypes, {name: '[Content_Types].xml'})\n          .append(blobs.rels, {name: '_rels\/.rels'})\n          .append(blobs.workbook, {name: 'xl\/workbook.xml'})\n          .append(blobs.styles, {name: 'xl\/styles.xml'})\n          .append(blobs.workbookRels, {name: 'xl\/_rels\/workbook.xml.rels'})\n          .append(@relsData, {name: 'xl\/worksheets\/_rels\/sheet1.xml.rels'})\n          .append(@stringsData, {name: 'xl\/sharedStrings.xml'})\n          .finalize()\n\n        return @zip\n\n##### finalize()\n\nFinishes up the sheet & generate shared strings.\n\n      finalize: () ->\n\n        # If there was data, end sheetData\n        if @haveHeader\n          @_write(blobs.sheetDataFooter)\n\n        # Write relationships data.\n        @_write(blobs.worksheetRels(@relationships))\n\n        # End sheet\n        @sheetStream.end(blobs.sheetFooter);\n\n        # Generate shared strings\n        @_generateStrings()\n\n        # Generate external rels\n        @_generateRelationships()\n\n        # Mark this as finished\n        @finalized = true\n\n##### dispose()\n\nCancel use of this writer and close all streams. This is not needed if you've written to a file.\n\n      dispose: () ->\n        return if @disposed\n\n        @sheetStream.end()\n        @sheetStream.unpipe()\n        @zip.unpipe()\n        while(@zip.read()) # drain stream\n          1; # noop\n        delete @zip\n        delete @sheetStream\n        @disposed = true\n\n\n#### Internal methods\n\n\nAdds a cell to the row in progress.\n\n      # @param {String|Number|Date} value Value to write.\n      # @param {Number}             col   Column index.\n      _addCell: (value = '', col) ->\n        row = @currentRow\n        cell = @_getCellIdentifier(row, col)\n\n        # Hyperlink support\n        if Object.prototype.toString.call(value) == '[object Object]' && value.hyperlink && value.value\n          @_addCell(value.value, col)\n          @_createRelationship(cell, value.hyperlink)\n          return\n\n        if typeof value == 'number' or numberRegex.test(value)\n          @rowBuffer += blobs.numberCell(value, cell)\n        else if value instanceof Date\n          date = @_dateToOADate(value)\n          @rowBuffer += blobs.dateCell(date, cell)\n        else\n          index = @_lookupString(value)\n          @rowBuffer += blobs.cell(index, cell)\n\n\n\nBegins a row. Call this before starting any row. Will start a buffer\nfor all proceeding cells, until @_endRow is called.\n\n      _startRow: () ->\n        @rowBuffer = blobs.startRow(@currentRow)\n        @currentRow += 1\n\nEnds a row. Will write the row to the sheet.\n\n      _endRow: () ->\n        @_write(@rowBuffer + blobs.endRow)\n\nGiven row and column indices, returns a cell identifier, e.g. \"E20\"\n\n      # @param {Number} row  Row index.\n      # @param {Number} cell Cell index.\n      # @return {String}     Cell identifier.\n      _getCellIdentifier: (row, col) ->\n        colIndex = ''\n        if @cellLabelMap[col]\n          colIndex = @cellLabelMap[col]\n        else\n          if col == 0\n            # Provide a fallback for empty spreadsheets\n            row = 1\n            col = 1\n\n          input = (+col - 1).toString(26)\n          while input.length\n            a = input.charCodeAt(input.length - 1)\n            colIndex = String.fromCharCode(a + if a >= 48 and a <= 57 then 17 else -22) + colIndex\n            input = if input.length > 1 then (parseInt(input.substr(0, input.length - 1), 26) - 1).toString(26) else \"\"\n          @cellLabelMap[col] = colIndex\n\n        return colIndex + row\n\nCreates column definitions, if any definitions exist.\nThis will write column styles, widths, etc.\n\n      # @return {String} Column definition.\n      _generateColumnDefinition: () ->\n        # <cols\/> tag (empty) crashes excel, weeeeee\n        if !@options.columns || !@options.columns.length\n          return ''\n\n        columnDefinition = ''\n        columnDefinition += blobs.startColumns\n\n        idx = 1\n        for index, column of @options.columns\n          columnDefinition += blobs.column(column.width || @options.defaultWidth, idx)\n          idx += 1\n\n        columnDefinition += blobs.endColumns\n        return columnDefinition\n\nGenerates StringMap XML. Used as a finalization step - don't call this while\nbuilding the xlsx is in progress.\n\nSaves string data to this object so it can be written to the zip.\n\n      _generateStrings: () ->\n        stringTable = ''\n        for string in @strings\n          stringTable += blobs.string(@escapeXml(string))\n        @stringsData = blobs.stringsHeader(@strings.length) + stringTable + blobs.stringsFooter\n\nLooks up a string inside the internal string map. If it doesn't exist, it will be added to the map.\n\n      # @param {String} value String to look up.\n      # @return {Number}      Index within the string map where this string is located.\n      _lookupString: (value) ->\n        if !@stringMap[value]\n          @stringMap[value] = @stringIndex\n          @strings.push(value)\n          @stringIndex += 1\n        return @stringMap[value]\n\nCreate a relationship. For now, this is always a hyperlink. This writes to a array that will later be used define the rels.\n\n      _createRelationship: (cell, target) ->\n        @relationships.push({cell: cell, target: target})\n\nGenerate external relationships data. This is saved into \"xl\/worksheets\/_rels\/sheet1.xml.rels\".\n\n      _generateRelationships: () ->\n        @relsData = blobs.externalWorksheetRels(@relationships)\n\nConverts a Date to an OADate.\nSee [this stackoverflow post](http:\/\/stackoverflow.com\/a\/15550284\/2644351)\n\n      # @param {Date} date Date to convert.\n      # @return {Number}   OADate.\n      _dateToOADate: (date) ->\n        epoch = new Date(1899,11,30)\n        msPerDay = 8.64e7\n\n        v = -1 * (epoch - date) \/ msPerDay;\n\n        # Deal with dates prior to 1899-12-30 00:00:00\n        dec = v - Math.floor(v)\n\n        if v < 0 and dec\n          v = Math.floor(v) - dec\n\n        return v\n\nConvert an OADate to a Date.\n\n      # @param {Number} oaDate OADate.\n      # @return {Date}         Converted date.\n      _OADateToDate: (oaDate) ->\n        epoch = new Date(1899,11,30)\n        msPerDay = 8.64e7\n\n        # Deal with -ve values\n        dec = oaDate - Math.floor(oaDate)\n\n        if oaDate < 0 and dec\n          oaDate = Math.floor(oaDate) - dec\n\n        return new Date(oaDate * msPerDay + +epoch)\n\nResets sheet data. Called on initialization.\n\n      _resetSheet: () ->\n\n        # Sheet data storage.\n        @sheetData = ''\n        @strings = []\n        @stringMap = {}\n        @stringIndex = 0\n        @stringData = null\n        @currentRow = 0\n\n        # Cell data storage\n        @cellMap = []\n        @cellLabelMap = {}\n\n        # Column data storage\n        @columns = []\n\n        # Rels data storage\n        @relData = ''\n        @relationships = []\n\n        # Flags\n        @haveHeader = false\n        @finalized = false\n\n        # Create sheet stream.\n        PassThrough = require('stream').PassThrough\n        @sheetStream = new PassThrough()\n\n        # Start off the sheet.\n        @_write(blobs.sheetHeader)\n\nWrapper around writing sheet data.\n\n      # @param {String} data Data to write to the sheet.\n      _write: (data) ->\n        @sheetStream.write(data)\n\nUtility method for escaping XML - used within blobs and can be used manually.\n\n      # @param {String} str String to escape.\n      escapeXml: (str = '') ->\n        return str.replace(\/&\/g, '&amp;')\n          .replace(\/<\/g, '&lt;')\n          .replace(\/>\/g, '&gt;')\n\nSimple extend helper.\n\n    _extend = (dest, src) ->\n      for key, val of src\n        dest[key] = val\n      dest \n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"23ce0e83402f58d8fc6834e6f64fd8e18ee8f840","subject":"Moved initialization of the input system to the index file.","message":"Moved initialization of the input system to the index file.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator","old_file":"src\/index.litcoffee","new_file":"src\/index.litcoffee","new_contents":"# index\n\nThis module is used to run the main event loop.  Please see the \"game\" module\nfor details.\n\n    # Required for Webpack to include the stylesheet in the HTML.\n    require \".\/index.sass\"\n    \n    addEventListener \"load\", ->\n        (require \".\/input\/keyboard.litcoffee\")()\n    \n        game = require \".\/game.litcoffee\"\n    \n        game.load ->\n            lastTimestamp = undefined\n            tickProgress = 0\n            \n            # Ensures the game has ticked once before the first draw.\n            game.tick()\n            \n            run = (timestamp) ->\n                if lastTimestamp isnt undefined\n                    tickProgress += (timestamp - lastTimestamp) * 20 \/ 1000 \n                \n                lastTimestamp = timestamp\n                \n                # If more than a quarter second of ticks have occurred, don't\n                # process any more than that, as the game was likely suspended.\n                tickProgress = Math.min 5, tickProgress\n            \n                while tickProgress >= 1\n                    game.tick()\n                    tickProgress--\n\n                game.draw tickProgress\n                \n                requestAnimationFrame run\n                \n                return\n            \n            requestAnimationFrame run\n            \n            return\n            \n        return","old_contents":"# index\n\nThis module is used to run the main event loop.  Please see the \"game\" module\nfor details.\n\n    # Required for Webpack to include the stylesheet in the HTML.\n\trequire \".\/index.sass\"\n\t\n\taddEventListener \"load\", ->\n\t\tgame = require \".\/game.litcoffee\"\n\t\n\t\tgame.load ->\n            lastTimestamp = undefined\n            tickProgress = 0\n            \n            # Ensures the game has ticked once before the first draw.\n            game.tick()\n            \n            run = (timestamp) ->\n                if lastTimestamp isnt undefined\n                    tickProgress += (timestamp - lastTimestamp) * 20 \/ 1000 \n                \n                lastTimestamp = timestamp\n                \n                # If more than a quarter second of ticks have occurred, don't\n                # process any more than that, as the game was likely suspended.\n                tickProgress = Math.min 5, tickProgress\n            \n                while tickProgress >= 1\n                    game.tick()\n                    tickProgress--\n\n                game.draw tickProgress\n                \n                requestAnimationFrame run\n                \n                return\n            \n            requestAnimationFrame run\n            \n            return\n            \n        return","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5942a7249e3c20ad1d3130a9d4a9c069be5b4a38","subject":"Refactor: export lines instead of ticks.","message":"Refactor: export lines instead of ticks.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The __TimelineMaker__ class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the __TimelineMaker__ class.  The __options__ parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are __formatTimeAxis()__, which formats time axis into a dictionary that describes the look of axis, and one of the __renderTo...__ functions that render that data dictionary to a desired context.\n\n#### The __formatTimeAxis()__ function\n\nA function that formats time axis into an intermediate format.  It has two parameters, __interval__ (a dictionary with __start__ and __end__ values, each of Date type) and corresponding to that interval __width__ of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be __options.intervalMultiplier__.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, __findPointList()__.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical element properties.  To transform time value into a coordinate we use the __timeToCoord()__ function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe should probably change ticks dictionary to lines dictionary instead, so we can add other types of lines, like baseline.  It could be better also to move all constants to options and make ticks drawing more flexible.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nNow we add text labels too.\n\nHere we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {lines: ticks, textLabels}\n\n#### The __findPointList()__ function\n\nThis function returns a list of points that are needed to be calculated for a (__start__, __end__) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the __start__ of the interval.  We move code that does that to the __findLeftTime()__.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using __findNextPoint()__ function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The __findLeftTime()__ function\n\nThe __findLeftTime()__ function calculates the rightmost point of time for current __options.intervalType__ such that it is not inside the given __interval__ (excluding beginning).  The __options.intervalType__ could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\nAnother option, __options.intervalMultiplier__, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the __options.intervalMultiplier__ should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the __findNextPoint()__ function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In __findNextPoint()__ we make sure that edge points are consistent while using different values of __start__.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The __findNextPoint()__ function\n\nThis function calculates next edge time point for a current options assuming __timePoint__ argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The __timeToCoord()__ function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The __renderToCanvas()__ function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n      context.stroke()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\n    window.onload = makeDemo\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The __TimelineMaker__ class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the __TimelineMaker__ class.  The __options__ parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are __formatTimeAxis()__, which formats time axis into a dictionary that describes the look of axis, and one of the __renderTo...__ functions that render that data dictionary to a desired context.\n\n#### The __formatTimeAxis()__ function\n\nA function that formats time axis into an intermediate format.  It has two parameters, __interval__ (a dictionary with __start__ and __end__ values, each of Date type) and corresponding to that interval __width__ of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be __options.intervalMultiplier__.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, __findPointList()__.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical element properties.  To transform time value into a coordinate we use the __timeToCoord()__ function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe should probably change ticks dictionary to lines dictionary instead, so we can add other types of lines, like baseline.  It could be better also to move all constants to options and make ticks drawing more flexible.\n\n        ticks = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            yTop: -@options.tickLength \/ 5\n            yBottom: @options.tickLength\n          }\n\nNow we add text labels too.\n\nHere we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {ticks, textLabels}\n\n#### The __findPointList()__ function\n\nThis function returns a list of points that are needed to be calculated for a (__start__, __end__) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the __start__ of the interval.  We move code that does that to the __findLeftTime()__.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using __findNextPoint()__ function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The __findLeftTime()__ function\n\nThe __findLeftTime()__ function calculates the rightmost point of time for current __options.intervalType__ such that it is not inside the given __interval__ (excluding beginning).  The __options.intervalType__ could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\nAnother option, __options.intervalMultiplier__, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the __options.intervalMultiplier__ should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the __findNextPoint()__ function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In __findNextPoint()__ we make sure that edge points are consistent while using different values of __start__.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The __findNextPoint()__ function\n\nThis function calculates next edge time point for a current options assuming __timePoint__ argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The __timeToCoord()__ function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The __renderToCanvas()__ function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 2\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that the resulting graphics is more sharp (especially horizontal and vertical lines and text).\n\n        for tick in axisData.ticks\n          x = left + tick.x\n          yTop = top + tick.yTop\n          yBottom = top + tick.yBottom\n          context.moveTo @roundForCanvas(x), @roundForCanvas(yTop)\n          context.lineTo @roundForCanvas(x), @roundForCanvas(yBottom)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n      context.stroke()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\n    window.onload = makeDemo\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d356fe0ac0a04489b1236b43b2dc14e0e8c6c589","subject":"Handle createdAt and updatedAt for client models","message":"Handle createdAt and updatedAt for client models\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-orm\/client\/index.litcoffee","new_file":"packages\/shrub-orm\/client\/index.litcoffee","new_contents":"# Object-relational mapping\n\n*This is mostly stubbed for the browser. I can't justify sending a 400k ORM\nlibrary to the client, even though it would be awesome.*\n\n    Promise = require 'bluebird'\n\n    pkgman = require 'pkgman'\n\n    collections = {}\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularService`.\n\n      registrar.registerHook 'shrubAngularService', -> [\n        '$http'\n        ($http) ->\n\n          service = {}\n\n          exports.initialize()\n\n## orm.collection\n\n* (String) `identity` - Collection identity. e.g. `'shrub-user'`\n\n*Get a collection by identity.*\n\n          service.collection = (identity) -> collections[identity]\n\n## orm.collections\n\n*Get all collections.*\n\n          service.collections = -> collections\n\n          service\n\n      ]\n\n    exports.initialize = ->\n\n#### Invoke hook `shrubOrmCollections`.\n\n      collections_ = {}\n      for collectionList in pkgman.invokeFlat 'shrubOrmCollections'\n        for identity, collection of collectionList\n\nCollection defaults.\n\n          collection.identity ?= identity\n          collections_[collection.identity] = collection\n\nInstantiate a model with defaults supplied.\n\n          collection.instantiate = (values = {}) ->\n            model = JSON.parse JSON.stringify values\n\n            if not @autoCreatedAt? or @autoCreatedAt is true\n              model.createdAt = new Date values.createdAt ? Date.now()\n\n            if not @autoUpdatedAt? or @autoUpdatedAt is true\n              model.updatedAt = new Date values.updatedAt ? Date.now()\n\n            for key, value of @attributes\n\nSet functions.\n\n              model[key] = value if 'function' is typeof value\n\nSet any model defaults.\n\n              if value.defaultsTo?\n                model[key] ?= if 'function' is typeof value.defaultsTo\n                  value.defaultsTo.call model\n                else\n                  JSON.parse JSON.stringify value.defaultsTo\n\nHandle dates.\n\n              if model[key]? and 'date' is value or 'date' is value.type\n                model[key] = new Date model[key]\n\n            model\n\n#### Invoke hook `shrubOrmCollectionsAlter`.\n\n      pkgman.invoke 'shrubOrmCollectionsAlter', collections_\n\n      collections = collections_\n","old_contents":"# Object-relational mapping\n\n*This is mostly stubbed for the browser. I can't justify sending a 400k ORM\nlibrary to the client, even though it would be awesome.*\n\n    Promise = require 'bluebird'\n\n    pkgman = require 'pkgman'\n\n    collections = {}\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularService`.\n\n      registrar.registerHook 'shrubAngularService', -> [\n        '$http'\n        ($http) ->\n\n          service = {}\n\n          exports.initialize()\n\n## orm.collection\n\n* (String) `identity` - Collection identity. e.g. `'shrub-user'`\n\n*Get a collection by identity.*\n\n          service.collection = (identity) -> collections[identity]\n\n## orm.collections\n\n*Get all collections.*\n\n          service.collections = -> collections\n\n          service\n\n      ]\n\n    exports.initialize = ->\n\n#### Invoke hook `shrubOrmCollections`.\n\n      collections_ = {}\n      for collectionList in pkgman.invokeFlat 'shrubOrmCollections'\n        for identity, collection of collectionList\n\nCollection defaults.\n\n          collection.identity ?= identity\n          collections_[collection.identity] = collection\n\nInstantiate a model with defaults supplied.\n\n          collection.instantiate = (values = {}) ->\n            model = JSON.parse JSON.stringify values\n\n            for key, value of @attributes\n\nSet functions.\n\n              model[key] = value if 'function' is typeof value\n\nSet any model defaults.\n\n              if value.defaultsTo?\n\n                model[key] ?= if 'function' is typeof value.defaultsTo\n                  value.defaultsTo.call model\n                else\n                  JSON.parse JSON.stringify value.defaultsTo\n\nHandle dates.\n\n              if model[key]? and 'date' is value or 'date' is value.type\n                model[key] = new Date model[key]\n\n            model\n\n#### Invoke hook `shrubOrmCollectionsAlter`.\n\n      pkgman.invoke 'shrubOrmCollectionsAlter', collections_\n\n      collections = collections_\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5c9fa4112d19c139eb79c792561d0da9c7ca606b","subject":"missed these setupMockedResponses","message":"missed these setupMockedResponses\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08_request.litcoffee","new_file":"docs\/08_request.litcoffee","new_contents":"# Batman Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented in the platform layer files.\n\n### Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\n  Batman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\n  In other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n    \n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n There are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n 1. `loading()`: fired before `send()` has been called.\n\n    test \"Demonstrate the loading event\", 1, ->\n       new Batman.Request\n         url: \"http::\/\/batmanjs.org\"\n         loading: ->\n           ok true, \"After send but before the request is made\"\n\n 2. `loaded()`: fired after the request is complete\n\n     test \"Demo the loaded event\", 1, ->\n       Batman.Request.setupMockedResponse()\n       Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n       new Batman.Request\n         url: \"http:\/\/batmanjs.org\"\n         loaded: ->\n           ok true, \"Loaded\"\n\n 3. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n    test \"Demo the error event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        error: (xhr) ->\n          ok true, \"Error\"\n\n 4. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n    test \"Demonstrate the success event\", 1,  ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", response\n\n## .status\n  The response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\n  The response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : object\n  An key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request(options : object)\n\n  Constructs a new `Batman.Request` with the supplied options\n\n  `options` description\n  1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n  2. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`\n\n    test \"method test\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"POST\"\n        data: { some: \"data\" }\n        success: (response) ->\n          ok true\n\n  3. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n  4. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n    test \"contentType default\", ->\n       req = new Batman.Request\n       equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n  5. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n    test \"autosend test\", ->\n      response_sent = false\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        success: (response) ->\n          response_sent = true\n      ok !response_sent\n      req.send()\n      ok response_sent\n\n  6. `username`: username for authentication\n  7. `password`: password for authentication\n  8. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send([data])\n  If `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","old_contents":"# Batman Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented in the platform layer files.\n\n### Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\n  Batman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\n  In other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n    \n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n There are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n 1. `loading()`: fired before `send()` has been called.\n\n    test \"Demonstrate the loading event\", 1, ->\n       new Batman.Request\n         url: \"http::\/\/batmanjs.org\"\n         loading: ->\n           ok true, \"After send but before the request is made\"\n\n 2. `loaded()`: fired after the request is complete\n\n     test \"Demo the loaded event\", 1, ->\n       Batman.Request.setupMockedResponse()\n       Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n       new Batman.Request\n         url: \"http:\/\/batmanjs.org\"\n         loaded: ->\n           ok true, \"Loaded\"\n\n 3. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n    test \"Demo the error event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        error: (xhr) ->\n          ok true, \"Error\"\n\n 4. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n    test \"Demonstrate the success event\", 1,  ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", response\n\n## .status\n  The response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\n  The response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : object\n  An key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request(options : object)\n\n  Constructs a new `Batman.Request` with the supplied options\n\n  `options` description\n  1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n  2. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`\n\n    test \"method test\", ->\n      Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"POST\"\n        data: { some: \"data\" }\n        success: (response) ->\n          ok true\n\n  3. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n  4. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n    test \"contentType default\", ->\n       req = new Batman.Request\n       equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n  5. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n    test \"autosend test\", ->\n      response_sent = false\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        success: (response) ->\n          response_sent = true\n      ok !response_sent\n      req.send()\n      ok response_sent\n\n  6. `username`: username for authentication\n  7. `password`: password for authentication\n  8. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send([data])\n  If `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2394f2e4dcfa0a097b9989f6e85a3499f6d1f220","subject":"Dead code","message":"Dead code\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-http\/index.litcoffee","new_file":"packages\/shrub-http\/index.litcoffee","new_contents":"# HTTP\n\nManage HTTP connections.\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    debug = require('debug') 'shrub:http'\n\n    httpManager = null\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        label: 'Bootstrap HTTP server'\n        middleware: [\n\n          (next) ->\n\n            {manager, port} = config.get 'packageSettings:shrub-http'\n\n            {Manager} = require manager.module\n\nSpin up the HTTP server, and initialize it.\n\n            httpManager = new Manager()\n\nSpawn workers into a cluster.\n\n            httpManager.cluster()\n\n            httpManager.initialize().then(->\n\n              debug \"Shrub HTTP server up and running on port #{port}!\"\n              next()\n\n            ).catch next\n\n        ]\n\n#### Implements hook `shrubHttpMiddleware`.\n\n      registrar.registerHook 'shrubHttpMiddleware', (http) ->\n\n        label: 'Finalize HTTP request'\n        middleware: [\n\n          (req, res, next) ->\n\n            if req.delivery?\n\n              res.send req.delivery\n\n            else\n\n              res.status 501\n              res.end '<h1>501 Internal Server Error<\/h1>'\n\n        ]\n\n#### Implements hook `shrubConfigServer`.\n\n      registrar.registerHook 'shrubConfigServer', ->\n\n        manager:\n\nModule implementing the socket manager.\n\n          module: 'shrub-http-express'\n\n        middleware: [\n          'shrub-http-express\/static'\n          'shrub-core'\n          'shrub-socket\/factory'\n          'shrub-http-express\/session'\n          'shrub-user'\n          'shrub-http-express\/logger'\n          'shrub-villiany'\n          'shrub-form'\n          'shrub-http-express\/routes'\n          'shrub-config'\n          'shrub-skin\/path'\n          'shrub-assets'\n          'shrub-skin\/render'\n          'shrub-http-express\/errors'\n        ]\n\n        path: \"#{config.get 'path'}\/app\"\n\n        port: 4201\n\n    exports.manager = -> httpManager\n","old_contents":"# HTTP\n\nManage HTTP connections.\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    debug = require('debug') 'shrub:http'\n\n    httpManager = null\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        label: 'Bootstrap HTTP server'\n        middleware: [\n\n          (next) ->\n\n            {manager, port} = config.get 'packageSettings:shrub-http'\n\n            {Manager} = require manager.module\n\nSpin up the HTTP server, and initialize it.\n\n            httpManager = new Manager()\n\nSpawn workers into a cluster.\n\n            httpManager.cluster()\n\n            httpManager.initialize().then(->\n\n              debug \"Shrub HTTP server up and running on port #{port}!\"\n              next()\n\n            ).catch next\n\n        ]\n\n#### Implements hook `shrubHttpMiddleware`.\n\n      registrar.registerHook 'shrubHttpMiddleware', (http) ->\n\n        label: 'Finalize HTTP request'\n        middleware: [\n\n          (req, res, next) ->\n\n            if req.delivery?\n\n              res.send req.delivery\n\n            else\n\n              res.status 501\n              res.end '<h1>501 Internal Server Error<\/h1>'\n\n        ]\n\n#### Implements hook `shrubConfigServer`.\n\n      registrar.registerHook 'shrubConfigServer', ->\n\n        manager:\n\nModule implementing the socket manager.\n\n          module: 'shrub-http-express'\n\n        middleware: [\n          'shrub-http-express\/static'\n          'shrub-core'\n          'shrub-socket\/factory'\n          'shrub-http-express\/session'\n          'shrub-user'\n          'shrub-http-express\/logger'\n          'shrub-villiany'\n          'shrub-form'\n          'shrub-http-express\/routes'\n          'shrub-config'\n          'shrub-skin\/path'\n          'shrub-assets'\n          'shrub-skin\/render'\n          'shrub-angular'\n          'shrub-http-express\/errors'\n        ]\n\n        path: \"#{config.get 'path'}\/app\"\n\n        port: 4201\n\n    exports.manager = -> httpManager\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"56c94ac83a66bf5eaf88892feceec29b6e150601","subject":"Dox look a little nicer now","message":"Dox look a little nicer now\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-grunt\/dox\/dynamic.litcoffee","new_file":"packages\/shrub-grunt\/dox\/dynamic.litcoffee","new_contents":"# Grunt build process - Dynamic documentation\n\n    {exec} = require 'child_process'\n    fs = require 'fs'\n    path = require 'path'\n    {Transform} = require 'stream'\n\n    _ = require 'lodash'\n    {LineStream} = require 'byline'\n    glob = require 'grunt\/node_modules\/glob'\n    Promise = require 'bluebird'\n\nImplement a Transform stream to accumulate hook invocations from a source file.\n\n    class HookInvocations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Invoke hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream to accumulate hook implementations from a source\nfile.\n\n    class HookImplementations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Implements hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream fo accumulate TODOs from a source file. Also\ncaches lines to be able to build context around each TODO item.\n\n    class Todos extends Transform\n\n      @context = 4\n\n      constructor: ->\n        super\n\n        @lines = []\n        @todos = []\n\n      _transform: (chunk, encoding, done) ->\n        @lines.push line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\#\\#\\# TODO\/\n          @todos.push @lines.length - 1\n\n        done()\n\n      withContext: ->\n\n        for todo in @todos\n\n          start = Math.max 0, todo - Todos.context\n          end = Math.min @lines.length - 1, todo + Todos.context\n\n          index: todo\n          lines: @lines.slice start, end\n\nGather all source files.\n\n    _allSourceFiles = ->\n      new Promise (resolve, reject) ->\n        glob(\n          '{{client,custom,packages,server}\/**\/*.litcoffee,*.litcoffee}'\n          (error, files) ->\n            return reject error if error?\n            resolve files\n        )\n\nGenerate an HTML ID from a string.\n\n    _idFromString = (string) -> string.replace(\n      \/\\\/\/g, ''\n    ).replace(\n      \/[^0-9A-Za-z-]+\/g, '-'\n    ).replace(\n      \/\\-+\/g, '-'\n    ).toLowerCase()\n\nGet the source path from a filename. This removes the extension and any \/index\nportion from the end of the filename.\n\n    _sourcePath = (filename) ->\n\n        dirname = path.dirname filename\n        if dirname is '.' then dirname = '' else dirname += '\/'\n        extname = path.extname filename\n        filename = \"#{dirname}#{path.basename filename, extname}\"\n\n        parts = filename.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'index'\n        return parts.join '\/'\n\nCollate a list of files by type (client or server).\n\n    _collateFilesByType = (files) ->\n\n      client = []\n      server = []\n\n      for file in files\n        parts = file.split '\/'\n\n        if parts[0] is 'client'\n          client.push file\n        else if parts[0] is 'custom' and parts[2] is 'client'\n          client.push file\n        else if parts[0] is 'packages' and parts[2] is 'client'\n          client.push file\n        else\n          server.push file\n\n      client: client, server: server\n\nGather statistics for all files.\n\n    fileStatsListPromise = _allSourceFiles().then (allFiles) ->\n\n      allFilesPromises = for type, files of _collateFilesByType allFiles\n\n        typePromises = for file in files\n\n          do (type, file) -> new Promise (resolve, reject) ->\n\n            fstream = fs.createReadStream file\n            fstream.pipe lineStream = new LineStream keepEmptyLines: true\n\nPass all files through the Transform list to parse out relevant information.\n\n            lineStream.pipe hookImplementations = new HookImplementations()\n            lineStream.pipe hookInvocations = new HookInvocations()\n            lineStream.pipe todos = new Todos()\n\n            fstream.on 'error', reject\n\n            fstream.on 'end', ->\n\nInclude all information from Transform streams in the statistics.\n\n              resolve(\n                type: type\n                file: file\n                implementations: hookImplementations.list\n                invocations: hookInvocations.list\n                todos: todos.withContext()\n              )\n\n        Promise.all typePromises\n\n      Promise.all(allFilesPromises).then (fileStatsLists) ->\n        _.flatten fileStatsLists\n\nMassage the statistics to help rendering the hooks page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      hooksIndex = {}\n\n      indexes = {}\n      keys = ['implementations', 'invocations']\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        for remove in ['client', 'packages']\n          if ~(index = parts.indexOf remove)\n            parts.splice index, 1\n        mergeFile = parts.join '\/'\n\n        for key in keys\n          indexes[key] ?= {}\n\n          for hook in fileStats[key]\n            indexes[key][hook] ?= {}\n\n            indexes[key][hook][mergeFile] ?= fullName: fileStats.file\n            (indexes[key][hook][mergeFile].types ?= []).push fileStats.type\n\n            hooksIndex[hook] = true\n\n      for key in keys\n        for hook, stats of indexes[key]\n          for file of stats\n            stats[file].types = _.unique stats[file].types ? []\n\n      hooks = (hook for hook of hooksIndex).sort()\n\n      hookFiles = {}\n      for hook in hooks\n        hookFiles[hook] = try\n          fs.readFileSync \"docs\/hook\/#{hook}.md\", 'utf8'\n        catch error\n          ''\n\n      O =\n        hookFiles: hookFiles\n        hooks: hooks\n\n      O[key] = indexes[key] for key in keys\n\n      return O\n\nRender the hooks page.\n\n    ).then((O) ->\n\n      {hookFiles, hooks} = O\n\n      keys = ['implementation', 'invocation']\n\n      wordingFor =\n        implementation: 'implements'\n        invocation: 'invoke'\n\n      render = fs.readFileSync 'docs\/hooks.template.md', 'utf8'\n\n      for hook in hooks\n\n        render += \"## #{hook}\\n\\n\"\n        render += hookFiles[hook] + '\\n\\n' if hookFiles[hook]\n\n        for key in keys\n          pluralKey = \"#{key}s\"\n\n          if O[pluralKey][hook]?\n\n            count = Object.keys(O[pluralKey][hook]).length\n\n            render += \"!!! note \\\"#{count} #{key}\"\n            render += 's' if count > 1\n            render += '\"\\n'\n\n            instances = for file, {fullName, types} of O[pluralKey][hook]\n\nRemove packages and file part.\n\n              parts = fullName.split '\/'\n              parts.shift()\n              parts.pop()\n              packageName = parts.join '\/'\n\n              types = types.map (type) ->\n                packageNameParts = packageName.split '\/'\n                packageNameParts.pop() if packageNameParts[packageNameParts.length - 1] isnt type\n                \"    * [#{_sourcePath file} (#{type})](packages\/##{_idFromString packageNameParts.join '\/'}) &mdash; [#{key}](source\/#{_sourcePath fullName}##{wordingFor[key]}-hook-#{_idFromString hook}) \\n\"\n              types.join ''\n\n            render += instances.join ''\n\n            render += '\\n\\n'\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/hooks.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nRender the TODOs page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/todos.template.md', 'utf8'\n\n      for fileStats in fileStatsList\n\nKeep track of used IDs, it will be necessary to link to the correct location\nhash in the case of multiple TODO items with the same wording.\n\n        idMap = {}\n\n        for todo in fileStats.todos\n\n          render += '\\n'\n\n          id = ''\n          for line, index in todo.lines\n            render += '>'\n\nIf this is the line with the TODO, parse the ID from the TODO item text, and\nrender it as h2 (TODO are h6) to increase visibility.\n\n            if index is Todos.context\n              id = _idFromString(line).slice 1, -1\n\n              render += line.slice 4\n            else\n              render += \" #{line}\"\n            render += '\\n'\n\n          render += '\\n'\n\n          filename = _sourcePath fileStats.file\n\nKeep track of ID usage and modify the location hash for subsequent uses.\n\n          if idMap[id]?\n            idMap[id] += 1\n            id += \"_#{idMap[id]}\"\n          else\n            idMap[id] = 0\n\n          render += \"###### the above found in [#{fileStats.file}:#{todo.index}](source\/#{filename}##{id})\\n\"\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/todos.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nAdd all the source files to a generated mkdocs.yml\n\n    _allSourceFiles().then (files) ->\n\n      yml = fs.readFileSync 'docs\/mkdocs.template.yml', 'utf8'\n\n      for file in files\n        parts = file.split '\/'\n\n        for i in [0...parts.length]\n          try\n            fs.mkdirSync \"docs\/source\/#{parts.slice(0, i).join '\/'}\"\n          catch error\n\n        fs.createReadStream(file).pipe(\n          fs.createWriteStream(\"docs\/source\/#{file}\")\n        )\n\nAdd them under the 'Source code' path.\n\n        yml += \"- [source\/#{file}, 'Source code', '#{file}']\\n\"\n\n      fs.writeFileSync 'mkdocs.yml', yml\n\n      return\n\nRender the packages page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\nSort by package name first.\n\n      newList = []\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        continue unless ~['custom', 'packages'].indexOf parts[0]\n\n        sourcePath = _sourcePath fileStats.file\n\n        parts = sourcePath.split '\/'\n        # parts.pop() if parts[parts.length - 1] is 'client'\n        pkg = parts.join '\/'\n        fileStats.pkg = pkg.split('\/').slice(1).join '\/'\n\n        newList.push fileStats\n\n      newList.sort (l, r) ->\n        return -1 if l.type is 'client' and r.type is 'server'\n        return 1 if l.type is 'server' and r.type is 'client'\n        if l.pkg < r.pkg then -1 else if l.pkg > r.pkg then 1 else 0\n\n    ).then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/packages.template.md', 'utf8'\n      render += '\\n'\n\n      type = null\n\n      for fileStats in fileStatsList\n\n        if fileStats.type isnt type\n          type = fileStats.type\n\n          render += if type is 'client'\n            '## Client-side'\n          else\n            '## Server-side'\n\n          render += '\\n\\n'\n\n        pkgParts = fileStats.pkg.split '\/'\n        isSubpackage = pkgParts.length isnt 1 and pkgParts.pop() isnt 'client'\n\nLink to the package.\n\n        sourcePath = _sourcePath fileStats.file\n\n        if isSubpackage\n          render += '> '\n          parts = fileStats.pkg.split '\/'\n          parentPkg = parts.shift()\n          subPkg = parts.join '\/'\n          render += \"## [<small>#{parentPkg}\/<\/small>#{subPkg}](source\/#{sourcePath})\"\n        else\n          render += \"## [#{fileStats.pkg}](source\/#{sourcePath})\"\n\nNaively parse out the file description. It must be wrapped in asterisks, i.e.\nitalicized in markdown.\n\n###### TODO: This 'chunk' parsing should be done with a Transform like the others.\n\n        data = fs.readFileSync fileStats.file, 'utf8'\n        chunks = data.split '\\n\\n'\n\n        title = chunks[0]\n        if 35 is title.charCodeAt 0\n          render += '\\n\\n'\n          render += '> ' if isSubpackage\n          render += \"<span class=\\\"package-title\\\">#{title.substr 2}<\/span>\"\n\n        render += '\\n\\n'\n\n        description = chunks[1]\n        if 42 is description.charCodeAt 0 and 42 is description.charCodeAt description.length - 1\n          render += '> ' if isSubpackage\n          render += \"#{description}\\n\\n\"\n\n        if fileStats.implementations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Implements hooks\"\\n'\n          render += fileStats.implementations.map((hook) ->\n            \"    * [#{hook}](hooks\/##{_idFromString hook}) &mdash; [implementation](source\/#{sourcePath}#implements-hook-#{hook.toLowerCase()})\\n\"\n          ).join ''\n          render += '\\n\\n'\n\n        if fileStats.invocations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Invokes hooks\"\\n'\n          render += fileStats.invocations.map((hook) ->\n            \"    * [#{hook}](hooks\/##{_idFromString hook}) &mdash; [invocation](source\/#{sourcePath}#invoke-hook-#{hook.toLowerCase()})\\n\"\n          ).join ''\n          render += '\\n\\n'\n\n###### TODO: We should do some preprocessing hre with a transform, namely linking the hook headers to their respective documentation.\n\n      fs.writeFileSync 'docs\/packages.md', render\n\n    )\n","old_contents":"# Grunt build process - Dynamic documentation\n\n    {exec} = require 'child_process'\n    fs = require 'fs'\n    path = require 'path'\n    {Transform} = require 'stream'\n\n    _ = require 'lodash'\n    {LineStream} = require 'byline'\n    glob = require 'grunt\/node_modules\/glob'\n    Promise = require 'bluebird'\n\nImplement a Transform stream to accumulate hook invocations from a source file.\n\n    class HookInvocations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Invoke hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream to accumulate hook implementations from a source\nfile.\n\n    class HookImplementations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Implements hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream fo accumulate TODOs from a source file. Also\ncaches lines to be able to build context around each TODO item.\n\n    class Todos extends Transform\n\n      @context = 4\n\n      constructor: ->\n        super\n\n        @lines = []\n        @todos = []\n\n      _transform: (chunk, encoding, done) ->\n        @lines.push line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\#\\#\\# TODO\/\n          @todos.push @lines.length - 1\n\n        done()\n\n      withContext: ->\n\n        for todo in @todos\n\n          start = Math.max 0, todo - Todos.context\n          end = Math.min @lines.length - 1, todo + Todos.context\n\n          index: todo\n          lines: @lines.slice start, end\n\nGather all source files.\n\n    _allSourceFiles = ->\n      new Promise (resolve, reject) ->\n        glob(\n          '{{client,custom,packages,server}\/**\/*.litcoffee,*.litcoffee}'\n          (error, files) ->\n            return reject error if error?\n            resolve files\n        )\n\nGenerate an HTML ID from a hook name.\n\n    _idFromHook = (hook) -> hook.replace(\n      \/[^0-9A-Za-z-]+\/g, '-'\n    ).replace(\n      \/\\-+\/g, '-'\n    ).toLowerCase()\n\nGet the source path from a filename. This removes the extension and any \/index\nportion from the end of the filename.\n\n    _sourcePath = (filename) ->\n\n        dirname = path.dirname filename\n        if dirname is '.' then dirname = '' else dirname += '\/'\n        extname = path.extname filename\n        filename = \"#{dirname}#{path.basename filename, extname}\"\n\n        parts = filename.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'index'\n        return parts.join '\/'\n\nCollate a list of files by type (client or server).\n\n    _collateFilesByType = (files) ->\n\n      client = []\n      server = []\n\n      for file in files\n        parts = file.split '\/'\n\n        if parts[0] is 'client'\n          client.push file\n        else if parts[0] is 'custom' and parts[2] is 'client'\n          client.push file\n        else if parts[0] is 'packages' and parts[2] is 'client'\n          client.push file\n        else\n          server.push file\n\n      client: client, server: server\n\nGather statistics for all files.\n\n    fileStatsListPromise = _allSourceFiles().then (allFiles) ->\n\n      allFilesPromises = for type, files of _collateFilesByType allFiles\n\n        typePromises = for file in files\n\n          do (type, file) -> new Promise (resolve, reject) ->\n\n            fstream = fs.createReadStream file\n            fstream.pipe lineStream = new LineStream keepEmptyLines: true\n\nPass all files through the Transform list to parse out relevant information.\n\n            lineStream.pipe hookImplementations = new HookImplementations()\n            lineStream.pipe hookInvocations = new HookInvocations()\n            lineStream.pipe todos = new Todos()\n\n            fstream.on 'error', reject\n\n            fstream.on 'end', ->\n\nInclude all information from Transform streams in the statistics.\n\n              resolve(\n                type: type\n                file: file\n                implementations: hookImplementations.list\n                invocations: hookInvocations.list\n                todos: todos.withContext()\n              )\n\n        Promise.all typePromises\n\n      Promise.all(allFilesPromises).then (fileStatsLists) ->\n        _.flatten fileStatsLists\n\nMassage the statistics to help rendering the hooks page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      hooksIndex = {}\n\n      indexes = {}\n      keys = ['implementations', 'invocations']\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        for remove in ['client', 'packages']\n          if ~(index = parts.indexOf remove)\n            parts.splice index, 1\n        mergeFile = parts.join '\/'\n\n        for key in keys\n          indexes[key] ?= {}\n\n          for hook in fileStats[key]\n            indexes[key][hook] ?= {}\n\n            indexes[key][hook][mergeFile] ?= fullName: fileStats.file\n            (indexes[key][hook][mergeFile].types ?= []).push fileStats.type\n\n            hooksIndex[hook] = true\n\n      for key in keys\n        for hook, stats of indexes[key]\n          for file of stats\n            stats[file].types = _.unique stats[file].types ? []\n\n      hooks = (hook for hook of hooksIndex).sort()\n\n      hookFiles = {}\n      for hook in hooks\n        hookFiles[hook] = try\n          fs.readFileSync \"docs\/hook\/#{hook}.md\", 'utf8'\n        catch error\n          ''\n\n      O =\n        hookFiles: hookFiles\n        hooks: hooks\n\n      O[key] = indexes[key] for key in keys\n\n      return O\n\nRender the hooks page.\n\n    ).then((O) ->\n\n      {hookFiles, hooks} = O\n\n      keys = ['implementation', 'invocation']\n\n      wordingFor =\n        implementation: 'implements'\n        invocation: 'invoke'\n\n      render = fs.readFileSync 'docs\/hooks.template.md', 'utf8'\n\n      for hook in hooks\n\n        render += \"## #{hook}\\n\\n\"\n        render += hookFiles[hook] + '\\n\\n' if hookFiles[hook]\n\n        for key in keys\n          pluralKey = \"#{key}s\"\n\n          if O[pluralKey][hook]?\n\n            count = Object.keys(O[pluralKey][hook]).length\n\n            render += \"!!! note \\\"#{count} #{key}\"\n            render += 's' if count > 1\n            render += '\"\\n'\n\n            instances = for file, {fullName, types} of O[pluralKey][hook]\n              types = types.map (type) -> \"[#{type}](source\/#{_sourcePath fullName}##{wordingFor[key]}-hook-#{_idFromHook hook})\"\n              \"    * #{_sourcePath file} (#{types.join ', '})\\n\"\n\n            render += instances.join('')\n\n            render += '\\n\\n'\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/hooks.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nRender the TODOs page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/todos.template.md', 'utf8'\n\n      for fileStats in fileStatsList\n\nKeep track of used IDs, it will be necessary to link to the correct location\nhash in the case of multiple TODO items with the same wording.\n\n        idMap = {}\n\n        for todo in fileStats.todos\n\n          render += '\\n'\n\n          id = ''\n          for line, index in todo.lines\n            render += '>'\n\nIf this is the line with the TODO, parse the ID from the TODO item text, and\nrender it as h2 (TODO are h6) to increase visibility.\n\n            if index is Todos.context\n              id = _idFromHook(line).slice 1, -1\n\n              render += line.slice 4\n            else\n              render += \" #{line}\"\n            render += '\\n'\n\n          render += '\\n'\n\n          filename = _sourcePath fileStats.file\n\nKeep track of ID usage and modify the location hash for subsequent uses.\n\n          if idMap[id]?\n            idMap[id] += 1\n            id += \"_#{idMap[id]}\"\n          else\n            idMap[id] = 0\n\n          render += \"###### the above found in [#{fileStats.file}:#{todo.index}](source\/#{filename}##{id})\\n\"\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/todos.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nAdd all the source files to a generated mkdocs.yml\n\n    _allSourceFiles().then (files) ->\n\n      yml = fs.readFileSync 'docs\/mkdocs.template.yml', 'utf8'\n\n      for file in files\n        parts = file.split '\/'\n\n        for i in [0...parts.length]\n          try\n            fs.mkdirSync \"docs\/source\/#{parts.slice(0, i).join '\/'}\"\n          catch error\n\n        fs.createReadStream(file).pipe(\n          fs.createWriteStream(\"docs\/source\/#{file}\")\n        )\n\nAdd them under the 'Source code' path.\n\n        yml += \"- [source\/#{file}, 'Source code', '#{file}']\\n\"\n\n      fs.writeFileSync 'mkdocs.yml', yml\n\n      return\n\nRender the packages page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\nSort by package name first.\n\n      newList = []\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        continue unless ~['custom', 'packages'].indexOf parts[0]\n\n        sourcePath = _sourcePath fileStats.file\n\n        parts = sourcePath.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'client'\n        pkg = parts.join '\/'\n        fileStats.pkg = pkg.split('\/').slice(1).join '\/'\n\n        newList.push fileStats\n\n      newList.sort (l, r) ->\n        return -1 if l.type is 'client' and r.type is 'server'\n        return 1 if l.type is 'server' and r.type is 'client'\n        if l.pkg < r.pkg then -1 else if l.pkg > r.pkg then 1 else 0\n\n    ).then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/packages.template.md', 'utf8'\n      render += '\\n'\n\n      type = null\n\n      for fileStats in fileStatsList\n\n        if fileStats.type isnt type\n          type = fileStats.type\n\n          render += if type is 'client'\n            '## Client-side'\n          else\n            '## Server-side'\n\n          render += '\\n\\n'\n\n        isSubpackage = fileStats.pkg.split('\/').length isnt 1\n\nLink to the package.\n\n        sourcePath = _sourcePath fileStats.file\n\n        if isSubpackage\n          render += '> '\n          parts = fileStats.pkg.split '\/'\n          parentPkg = parts.shift()\n          subPkg = parts.join '\/'\n          render += \"## [<small>#{parentPkg}\/<\/small>#{subPkg}](source\/#{sourcePath})\"\n        else\n          render += \"## [#{fileStats.pkg}](source\/#{sourcePath})\"\n\nNaively parse out the file description. It must be wrapped in asterisks, i.e.\nitalicized in markdown.\n\n###### TODO: This 'chunk' parsing should be done with a Transform like the others.\n\n        data = fs.readFileSync fileStats.file, 'utf8'\n        chunks = data.split '\\n\\n'\n\n        title = chunks[0]\n        if 35 is title.charCodeAt 0\n          render += '\\n\\n'\n          render += '> ' if isSubpackage\n          render += \"<span class=\\\"package-title\\\">#{title.substr 2}<\/span>\"\n\n        render += '\\n\\n'\n\n        description = chunks[1]\n        if 42 is description.charCodeAt 0 and 42 is description.charCodeAt description.length - 1\n          render += '> ' if isSubpackage\n          render += \"#{description}\\n\\n\"\n\n        if fileStats.implementations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Implements hooks\"\\n    '\n          render += fileStats.implementations.map((hook) ->\n            \"[#{hook}](source\/#{sourcePath}#implements-hook-#{hook.toLowerCase()})\"\n          ).join ', '\n          render += '\\n\\n'\n\n        if fileStats.invocations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Invokes hooks\"\\n    '\n          render += fileStats.invocations.map((hook) ->\n            \"[#{hook}](source\/#{sourcePath}#invoke-hook-#{hook.toLowerCase()})\"\n          ).join ', '\n          render += '\\n\\n'\n\n###### TODO: We should do some preprocessing hre with a transform, namely linking the hook headers to their respective documentation.\n\n      fs.writeFileSync 'docs\/packages.md', render\n\n    )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"369742db2ed58262667a9179d2e4c6aecddb570a","subject":"Rework Skyll's rendering pipeline","message":"Rework Skyll's rendering pipeline\n\nThe rendering pipeline now supports nested arrays - each nested array\nspecifying a complete rendering pipeline.\n\nData cascades from pipeline to pipeline since pipelines are rendered in\norder.\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/skyll.litcoffee","new_file":"lib\/skyll.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c5873b85086d71419924d55b1fb2a7ff7331fde2","subject":"Fixed Typo in View Bindings Documentation","message":"Fixed Typo in View Bindings Documentation\n\nThe interpolate function replaces on `%{content}` but the example for\nthe filters docs has an extra `%` at the end.\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# \/api\/App Components\/Batman.View\/Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n#### Available Keypath Filters\n\nThe following is a list of available keypaths that can be used with bindings. For a more complete description with accompanying examples see `Batman.View Filters`\n + `ceil` : Runs `Math.ceil` on input value.\n + `floor` : Runs `Math.floor` on input value.\n + `round` : Runs `Math.round` on input value.\n + `precision` : Runs `toPrecision()` on input value.\n + `fixed` : Runs `toFixed()` on input value.\n + `delimitNumber` : Adds comma delimiters to a number\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-route-params\n\nAdds the provided keypath or literal value to the route provided to `data-route`. For example:\n\n```html\n<a data-route='routes.villians.new' data-route-params='\"mastermind=true\"'>Mastermind<\/a>\n```\n\nwill route to `\/villians\/new?mastermind=true` and\n\n```\n<a data-route='routes.villians.new' data-route-params='otherRouteParams'>Other<\/a>\n```\n\nwill look up `otherRouteParams` and append it to `\/villains\/new`, adding a `?` if necessary.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# \/api\/App Components\/Batman.View\/Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## ceil(value) : string\n\nThe `ceil` filter will run `Math.ceil` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | ceil\"><\/span>\n```\n\n## floor(value) : string\n\nThe `floor` filter will run `Math.floor` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | floor\"><\/span>\n```\n\n## round(value) : string\n\nThe `round` filter will run `Math.round` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | round\"><\/span>\n```\n\n## percision(value, toPlace) : string\n\nThe `precision` filter will run `toPrecision()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | precision\"><\/span>\n<span data-bind=\"someValue | precision 3\"><\/span>\n```\n\n## fixed(value, toPlace) : string\n\nThe `fixed` filter will run `toFixed()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | fixed\"><\/span>\n<span data-bind=\"someValue | fixed 3\"><\/span>\n```\n\n## delimitNumber(value) : string\n\nThe `delimitNumber` filter will comma delimit a 'number'. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | delimitNumber\"><\/span>\n```\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","old_contents":"# \/api\/App Components\/Batman.View\/Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n#### Available Keypath Filters\n\nThe following is a list of available keypaths that can be used with bindings. For a more complete description with accompanying examples see `Batman.View Filters`\n + `ceil` : Runs `Math.ceil` on input value.\n + `floor` : Runs `Math.floor` on input value.\n + `round` : Runs `Math.round` on input value.\n + `precision` : Runs `toPrecision()` on input value.\n + `fixed` : Runs `toFixed()` on input value.\n + `delimitNumber` : Adds comma delimiters to a number\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-route-params\n\nAdds the provided keypath or literal value to the route provided to `data-route`. For example:\n\n```html\n<a data-route='routes.villians.new' data-route-params='\"mastermind=true\"'>Mastermind<\/a>\n```\n\nwill route to `\/villians\/new?mastermind=true` and\n\n```\n<a data-route='routes.villians.new' data-route-params='otherRouteParams'>Other<\/a>\n```\n\nwill look up `otherRouteParams` and append it to `\/villains\/new`, adding a `?` if necessary.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# \/api\/App Components\/Batman.View\/Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## ceil(value) : string\n\nThe `ceil` filter will run `Math.ceil` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | ceil\"><\/span>\n```\n\n## floor(value) : string\n\nThe `floor` filter will run `Math.floor` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | floor\"><\/span>\n```\n\n## round(value) : string\n\nThe `round` filter will run `Math.round` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | round\"><\/span>\n```\n\n## percision(value, toPlace) : string\n\nThe `precision` filter will run `toPrecision()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | precision\"><\/span>\n<span data-bind=\"someValue | precision 3\"><\/span>\n```\n\n## fixed(value, toPlace) : string\n\nThe `fixed` filter will run `toFixed()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | fixed\"><\/span>\n<span data-bind=\"someValue | fixed 3\"><\/span>\n```\n\n## delimitNumber(value) : string\n\nThe `delimitNumber` filter will comma delimit a 'number'. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | delimitNumber\"><\/span>\n```\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2615d63671fb7e8a18b2c9b13c2c0e2ad77da871","subject":"Refactor `formatLabel()`.","message":"Refactor `formatLabel()`.\n\nMove `options` argument to object field.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/timeline-scale-library.litcoffee","new_file":"src\/timeline-scale-library.litcoffee","new_contents":"Timeline Scale Library -- library implementation\n================================================\n\nAbstract\n--------\n\nThis file contains an implementation of timeline scale visualization in literate CoffeeScript.  Description is followed by source code with explanations.  The library is exported both as a Node module and client-side library.  For more information about this library, have a look at the [readme file](..\/README.md).\n\nThe project is hosted [here](https:\/\/github.com\/nasedil\/timeline-scale).  This project is licensed under the terms of the MIT license.\n\nThis file is written in Literate [CoffeeScript](http:\/\/coffeescript.org\/#literate), using [Github Flavored Markdown](https:\/\/help.github.com\/articles\/github-flavored-markdown\/).\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n    3. [Exports](#exports)\n    4. [Helper code](#helper-code)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/).\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming).\n * Implement beautiful, informative and concise timeline axis\/scale and try new visual and technical ideas.\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatMultiLaneAxis()`:  builds ticks and labels in several lanes, so that it is possible to see exactly which interval is displayed;  each lane shows ticks and labels for different interval types (time (up to hours), days, months, years).  Up to four lanes are displayed then.\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.\n\n  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.tickLaneMultiplier`:  how much tick length is multiplied while on next lane from current lane.\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n * `options.laneOffset`: absolute offset between lanes.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tightness: options.tightness ? 5\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          tickLaneMultiplier: options.tickLaneMultiplier ? 1.5\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n          laneOffset: options.laneOffset ? 30\n\n_Note_:  I wonder if the code above that assigns default values could be improved.  Maybe use [underscore extend](http:\/\/underscorejs.org\/#extend).\n\n#### The `formatMultiLaneAxis()` function ####\n\nThis function makes axis look like several axes stacked together, from smaller time intervals to larger, until years are shown.  That makes it complete, providing full information about the corresponding time interval.  It's arguments and return value are the same as for `formatAutomatic()`.\n\n      formatMultiLaneAxis: (interval, width = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\n__TODO__:  fix saving options.\n\n        oldAxisLineOffset = @options.axisLineOffset\n\nIn the beginning we format the first lane using `formatAutomatic()`:\n\n        features = @formatAutomatic interval, width\n\nThen, we need to format lanes one by one, increasing interval type, until we it is equal to 'years'.  `intervalMultiplier` will be equal to one always on these lanes.\n\n__Note__:  switch could be changed to some array progression, should it be done?\n\n        @options.intervalMultiplier = 1\n        @options.labelPlacement = 'interval'\n        while @options.intervalType isnt 'year'\n\nWe increase interval to the next interval type interval.\n\n          switch @options.intervalType\n            when 'millisecond', 'second', 'minute', 'hour'\n              @options.intervalType = 'day'\n            when 'day', 'week'\n              @options.intervalType = 'month'\n            when 'month'\n              @options.intervalType = 'year'\n\nNow we format a lane using the new interval type and multiplier, and after changing placement options.  New data is merged with previous data.\n\n__Note__:  merging code should be done in some other function. Refactor.\n\n          @options.axisLineOffset += @options.laneOffset\n          newLane = @formatFixed interval, width\n          features =\n            lines: features.lines.concat newLane.lines\n            textLabels: features.textLabels.concat newLane.textLabels\n\n__TODO__:  these horrible options restoration shoud be rewritten with the whole otpions and argument system.\n\n        @options.axisLineOffset = oldAxisLineOffset\n        features\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has the following arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `@options.tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * @options.tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval.  Depending on `intervalType` we choose interval or point label placement.\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        switch @options.intervalType\n          when 'year', 'month', 'week', 'day'\n            @options.labelPlacement = 'interval'\n          else\n            @options.labelPlacement = 'point'\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: @options.axisLineOffset + -@options.tickLength * @options.tickTailRatio\n            y2: @options.axisLineOffset + @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.axisLineOffset + @options.labelOffset\n            text: @formatLabel timePoint\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        if @options.labelPlacement is 'interval'\n          for textLabel, i in textLabels when i isnt (textLabels.length-1)\n            textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n          textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (week is just 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\nA special consideration is negative dates and dates before Epoch.  We need to treat them correctly too.  Arithmetic remainder function in JavaScript return negative remainder if dividend is negative.  Because of that we add divisor to such remainder in case of negative years.\n\nBut if dates are outside of allowed by JavaScript ranges (\u00b11000000000 dates from Epoch) then the behaviour is not defined.\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            yearReminder = start.getFullYear() % @options.intervalMultiplier\n            if yearReminder < 0\n              yearReminder += @options.intervalMultiplier\n            newYear = start.getFullYear() - yearReminder\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n\nHere it can happen that `start` is actually earlier than Epoch.  Then we decrease `leftTime` first:\n\n            if start < leftTime\n              delta = 1\n              while start <= leftTime\n                leftTime = new Date leftTime.getFullYear(),\n                  leftTime.getMonth()\n                  leftTime.getDate() - delta*intervalMultiplier\n                  leftTime.getHours()\n                  leftTime.getMinutes()\n                  leftTime.getSeconds()\n                  leftTime.getMilliseconds()\n                delta *= 2\n\nNow we move forwart until we find the right point:\n\n            delta = 1048576\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `formatLabel()` function ####\n\nThis function returns text representation of date.\n\n      formatLabel: (timePoint) ->\n        switch @options.intervalType\n          when 'year'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setFullYear(nextTimePoint.getFullYear() - 1)\n              timePoint.getFullYear().toString() +\n                '\u2013' + nextTimePoint.getFullYear()\n            else\n              timePoint.getFullYear().toString()\n          when 'month'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMonth(nextTimePoint.getMonth() - 1)\n              timePoint.getMonth().toString() +\n                '\u2013' + nextTimePoint.getMonth().toString()\n            else\n              timePoint.getMonth().toString()\n          when 'week'\n            if @options.labelPlacement is 'interval'\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'day'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'hour'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setHours(nextTimePoint.getHours())\n              timePoint.getHours().toString() +\n                '\u2013' + nextTimePoint.getHours().toString()\n            else\n              timePoint.getHours().toString()\n          when 'minute'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMinutes(nextTimePoint.getMinutes())\n              timePoint.getMinutes().toString() +\n                '\u2013' + nextTimePoint.getMinutes().toString()\n            else\n              timePoint.getMinutes().toString()\n          when 'second'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setSeconds(nextTimePoint.getSeconds())\n              timePoint.getSeconds().toString() +\n                '\u2013' + nextTimePoint.getSeconds().toString()\n            else\n              timePoint.getSeconds().toString()\n          when 'millisecond'\n            if (@options.intervalMultiplier > 1 and\n                @options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMilliseconds(nextTimePoint.getMilliseconds())\n              \".#{ timePoint.getMilliseconds() }\u2013.#{ nextTimePoint.getMilliseconds() }\"\n            else\n              \".#{ timePoint.getMilliseconds() }\"\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\n### Exports\n\nBoth `TimeAxisMaker` and `TimeAxisRenderer` are exported.\n\n    library =\n      TimeAxisMaker: TimeAxisMaker\n      TimeAxisRenderer: TimeAxisRenderer\n\nWe export both as a Node package and as a window property in client, depending on current environment.\n\n    if typeof module isnt \"undefined\" and module.exports\n      module.exports = library\n    else\n      window.TimelineScale = library\n\n### Helper code\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\nYou can have a look at an example in [demo.jade](src\/demo.jade) (needs to be compiled with Jade) and [timeline-library-example.litcoffee](src\/timeline-scale-example.litcoffee).\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nThis code is licensed under the terms of the MIT license.\n\n### Technical information ###\nThis file is written in Literate [CoffeeScript](http:\/\/coffeescript.org\/#literate), using [Github Flavored Markdown](https:\/\/help.github.com\/articles\/github-flavored-markdown\/).  You need to compile to get javascript code, and it is best highlighted when viewed in Github.\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline Scale Library -- library implementation\n================================================\n\nAbstract\n--------\n\nThis file contains an implementation of timeline scale visualization in literate CoffeeScript.  Description is followed by source code with explanations.  The library is exported both as a Node module and client-side library.  For more information about this library, have a look at the [readme file](..\/README.md).\n\nThe project is hosted [here](https:\/\/github.com\/nasedil\/timeline-scale).  This project is licensed under the terms of the MIT license.\n\nThis file is written in Literate [CoffeeScript](http:\/\/coffeescript.org\/#literate), using [Github Flavored Markdown](https:\/\/help.github.com\/articles\/github-flavored-markdown\/).\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n    3. [Exports](#exports)\n    4. [Helper code](#helper-code)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/).\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming).\n * Implement beautiful, informative and concise timeline axis\/scale and try new visual and technical ideas.\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatMultiLaneAxis()`:  builds ticks and labels in several lanes, so that it is possible to see exactly which interval is displayed;  each lane shows ticks and labels for different interval types (time (up to hours), days, months, years).  Up to four lanes are displayed then.\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.\n\n  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.tickLaneMultiplier`:  how much tick length is multiplied while on next lane from current lane.\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n * `options.laneOffset`: absolute offset between lanes.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tightness: options.tightness ? 5\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          tickLaneMultiplier: options.tickLaneMultiplier ? 1.5\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n          laneOffset: options.laneOffset ? 30\n\n_Note_:  I wonder if the code above that assigns default values could be improved.  Maybe use [underscore extend](http:\/\/underscorejs.org\/#extend).\n\n#### The `formatMultiLaneAxis()` function ####\n\nThis function makes axis look like several axes stacked together, from smaller time intervals to larger, until years are shown.  That makes it complete, providing full information about the corresponding time interval.  It's arguments and return value are the same as for `formatAutomatic()`.\n\n      formatMultiLaneAxis: (interval, width = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\n__TODO__:  fix saving options.\n\n        oldAxisLineOffset = @options.axisLineOffset\n\nIn the beginning we format the first lane using `formatAutomatic()`:\n\n        features = @formatAutomatic interval, width\n\nThen, we need to format lanes one by one, increasing interval type, until we it is equal to 'years'.  `intervalMultiplier` will be equal to one always on these lanes.\n\n__Note__:  switch could be changed to some array progression, should it be done?\n\n        @options.intervalMultiplier = 1\n        @options.labelPlacement = 'interval'\n        while @options.intervalType isnt 'year'\n\nWe increase interval to the next interval type interval.\n\n          switch @options.intervalType\n            when 'millisecond', 'second', 'minute', 'hour'\n              @options.intervalType = 'day'\n            when 'day', 'week'\n              @options.intervalType = 'month'\n            when 'month'\n              @options.intervalType = 'year'\n\nNow we format a lane using the new interval type and multiplier, and after changing placement options.  New data is merged with previous data.\n\n__Note__:  merging code should be done in some other function. Refactor.\n\n          @options.axisLineOffset += @options.laneOffset\n          newLane = @formatFixed interval, width\n          features =\n            lines: features.lines.concat newLane.lines\n            textLabels: features.textLabels.concat newLane.textLabels\n\n__TODO__:  these horrible options restoration shoud be rewritten with the whole otpions and argument system.\n\n        @options.axisLineOffset = oldAxisLineOffset\n        features\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has the following arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `@options.tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * @options.tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval.  Depending on `intervalType` we choose interval or point label placement.\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        switch @options.intervalType\n          when 'year', 'month', 'week', 'day'\n            @options.labelPlacement = 'interval'\n          else\n            @options.labelPlacement = 'point'\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: @options.axisLineOffset + -@options.tickLength * @options.tickTailRatio\n            y2: @options.axisLineOffset + @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.axisLineOffset + @options.labelOffset\n            text: @formatLabel timePoint, @options\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        if @options.labelPlacement is 'interval'\n          for textLabel, i in textLabels when i isnt (textLabels.length-1)\n            textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n          textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (week is just 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\nA special consideration is negative dates and dates before Epoch.  We need to treat them correctly too.  Arithmetic remainder function in JavaScript return negative remainder if dividend is negative.  Because of that we add divisor to such remainder in case of negative years.\n\nBut if dates are outside of allowed by JavaScript ranges (\u00b11000000000 dates from Epoch) then the behaviour is not defined.\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            yearReminder = start.getFullYear() % @options.intervalMultiplier\n            if yearReminder < 0\n              yearReminder += @options.intervalMultiplier\n            newYear = start.getFullYear() - yearReminder\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n\nHere it can happen that `start` is actually earlier than Epoch.  Then we decrease `leftTime` first:\n\n            if start < leftTime\n              delta = 1\n              while start <= leftTime\n                leftTime = new Date leftTime.getFullYear(),\n                  leftTime.getMonth()\n                  leftTime.getDate() - delta*intervalMultiplier\n                  leftTime.getHours()\n                  leftTime.getMinutes()\n                  leftTime.getSeconds()\n                  leftTime.getMilliseconds()\n                delta *= 2\n\nNow we move forwart until we find the right point:\n\n            delta = 1048576\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `formatLabel` function ####\n\nThis function returns text representation of date.\n\n      formatLabel: (timePoint, options) ->\n        switch options.intervalType\n          when 'year'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setFullYear(nextTimePoint.getFullYear() - 1)\n              timePoint.getFullYear().toString() +\n                '\u2013' + nextTimePoint.getFullYear()\n            else\n              timePoint.getFullYear().toString()\n          when 'month'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMonth(nextTimePoint.getMonth() - 1)\n              timePoint.getMonth().toString() +\n                '\u2013' + nextTimePoint.getMonth().toString()\n            else\n              timePoint.getMonth().toString()\n          when 'week'\n            if options.labelPlacement is 'interval'\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'day'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'hour'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setHours(nextTimePoint.getHours())\n              timePoint.getHours().toString() +\n                '\u2013' + nextTimePoint.getHours().toString()\n            else\n              timePoint.getHours().toString()\n          when 'minute'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMinutes(nextTimePoint.getMinutes())\n              timePoint.getMinutes().toString() +\n                '\u2013' + nextTimePoint.getMinutes().toString()\n            else\n              timePoint.getMinutes().toString()\n          when 'second'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setSeconds(nextTimePoint.getSeconds())\n              timePoint.getSeconds().toString() +\n                '\u2013' + nextTimePoint.getSeconds().toString()\n            else\n              timePoint.getSeconds().toString()\n          when 'millisecond'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMilliseconds(nextTimePoint.getMilliseconds())\n              \".#{ timePoint.getMilliseconds() }\u2013.#{ nextTimePoint.getMilliseconds() }\"\n            else\n              \".#{ timePoint.getMilliseconds() }\"\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\n### Exports\n\nBoth `TimeAxisMaker` and `TimeAxisRenderer` are exported.\n\n    library =\n      TimeAxisMaker: TimeAxisMaker\n      TimeAxisRenderer: TimeAxisRenderer\n\nWe export both as a Node package and as a window property in client, depending on current environment.\n\n    if typeof module isnt \"undefined\" and module.exports\n      module.exports = library\n    else\n      window.TimelineScale = library\n\n### Helper code\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\nYou can have a look at an example in [demo.jade](src\/demo.jade) (needs to be compiled with Jade) and [timeline-library-example.litcoffee](src\/timeline-scale-example.litcoffee).\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nThis code is licensed under the terms of the MIT license.\n\n### Technical information ###\nThis file is written in Literate [CoffeeScript](http:\/\/coffeescript.org\/#literate), using [Github Flavored Markdown](https:\/\/help.github.com\/articles\/github-flavored-markdown\/).  You need to compile to get javascript code, and it is best highlighted when viewed in Github.\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3eaeaa5c70eccaf85ab5147412945a5a7e8eb059","subject":"Dox tweak","message":"Dox tweak\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"dox.litcoffee","new_file":"dox.litcoffee","new_contents":"\n# Documentation generation\n\n*Generate the dynamic portions of Shrub's documentation.*\n\n    {exec} = require 'child_process'\n    fs = require 'fs'\n    path = require 'path'\n    {Transform} = require 'stream'\n\n    _ = require 'lodash'\n    {LineStream} = require 'byline'\n    glob = require 'grunt\/node_modules\/glob'\n    Promise = require 'bluebird'\n\nImplement a Transform stream to accumulate hook invocations from a source file.\n\n    class HookInvocations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Invoke hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream to accumulate hook implementations from a source\nfile.\n\n    class HookImplementations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Implements hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream fo accumulate TODOs from a source file. Also\ncaches lines to be able to build context around each TODO item.\n\n    class Todos extends Transform\n\n      @context = 4\n\n      constructor: ->\n        super\n\n        @lines = []\n        @todos = []\n\n      _transform: (chunk, encoding, done) ->\n        @lines.push line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\#\\#\\# TODO\/\n          @todos.push @lines.length - 1\n\n        done()\n\n      withContext: ->\n\n        for todo in @todos\n\n          start = Math.max 0, todo - Todos.context\n          end = Math.min @lines.length - 1, todo + Todos.context\n\n          index: todo\n          lines: @lines.slice start, end\n\nGather all source files.\n\n    _allSourceFiles = ->\n      new Promise (resolve, reject) ->\n        glob(\n          '{{client,custom,packages,server}\/**\/*.litcoffee,*.litcoffee}'\n          (error, files) ->\n            return reject error if error?\n            resolve files\n        )\n\nGenerate an HTML ID from a hook name.\n\n    _idFromHook = (hook) -> hook.replace(\n      \/[^0-9A-Za-z-]+\/g, '-'\n    ).toLowerCase()\n\nGet the source path from a filename. This removes the extension and any \/index\nportion from the end of the filename.\n\n    _sourcePath = (filename) ->\n\n        dirname = path.dirname filename\n        if dirname is '.' then dirname = '' else dirname += '\/'\n        extname = path.extname filename\n        filename = \"#{dirname}#{path.basename filename, extname}\"\n\n        parts = filename.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'index'\n        return parts.join '\/'\n\nCollate a list of files by type (client or server).\n\n    _collateFilesByType = (files) ->\n\n      client = []\n      server = []\n\n      for file in files\n        parts = file.split '\/'\n\n        if parts[0] is 'client'\n          client.push file\n        else if parts[0] is 'custom' and parts[2] is 'client'\n          client.push file\n        else if parts[0] is 'packages' and parts[2] is 'client'\n          client.push file\n        else\n          server.push file\n\n      client: client, server: server\n\nGather statistics for all files.\n\n    fileStatsListPromise = _allSourceFiles().then (allFiles) ->\n\n      allFilesPromises = for type, files of _collateFilesByType allFiles\n\n        typePromises = for file in files\n\n          do (type, file) -> new Promise (resolve, reject) ->\n\n            fstream = fs.createReadStream file\n            fstream.pipe lineStream = new LineStream keepEmptyLines: true\n\nPass all files through the Transform list to parse out relevant information.\n\n            lineStream.pipe hookImplementations = new HookImplementations()\n            lineStream.pipe hookInvocations = new HookInvocations()\n            lineStream.pipe todos = new Todos()\n\n            fstream.on 'error', reject\n\n            fstream.on 'end', ->\n\nInclude all information from Transform streams in the statistics.\n\n              resolve(\n                type: type\n                file: file\n                implementations: hookImplementations.list\n                invocations: hookInvocations.list\n                todos: todos.withContext()\n              )\n\n        Promise.all typePromises\n\n      Promise.all(allFilesPromises).then (fileStatsLists) ->\n        _.flatten fileStatsLists\n\nMassage the statistics to help rendering the hooks page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      hooksIndex = {}\n\n      indexes = {}\n      keys = ['implementations', 'invocations']\n\n      for fileStats in fileStatsList\n\n        for key in keys\n          indexes[key] ?= {}\n\n          for hook in fileStats[key]\n            indexes[key][hook] ?= {}\n            (indexes[key][hook][fileStats.file] ?= []).push fileStats.type\n\n            hooksIndex[hook] = true\n\n      for key in keys\n        for hook, stats of indexes[key]\n          for file of stats\n            stats[file] = _.unique stats[file] ? []\n\n      hooks = (hook for hook of hooksIndex).sort()\n\n      hookFiles = {}\n      for hook in hooks\n        hookFiles[hook] = try\n          fs.readFileSync \"docs\/hook\/#{hook}.md\", 'utf8'\n        catch error\n          ''\n\n      O =\n        hookFiles: hookFiles\n        hooks: hooks\n\n      O[key] = indexes[key] for key in keys\n\n      return O\n\nRender the hooks page.\n\n    ).then((O) ->\n\n      {hookFiles, hooks} = O\n\n      keys = ['implementations', 'invocations']\n\n      wordingFor =\n        implementations: 'implements'\n        invocations: 'invoke'\n\n      render = fs.readFileSync 'docs\/hooks.template.md', 'utf8'\n\n      for hook in hooks\n\n        render += \"## #{hook}\\n\\n\"\n        render += hookFiles[hook] + '\\n\\n' if hookFiles[hook]\n\n        for key in keys\n\n          if O[key][hook]?\n\n            count = Object.keys(O[key][hook]).length\n            render += \"### #{count} #{key}(s)\\n\\n\"\n\n            for file, types of O[key][hook]\n\n              file = _sourcePath file\n\n              types = types.map (type) -> \"[#{type}](source\/#{file}##{wordingFor[key]}-hook-#{hook.toLowerCase()})\"\n\n              render += \"* #{file} (#{types.join ','})\\n\"\n\n            render += '\\n'\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/hooks.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nRender the TODOs page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/todos.template.md', 'utf8'\n\n      for fileStats in fileStatsList\n\nKeep track of used IDs, it will be necessary to link to the correct location\nhash in the case of multiple TODO items with the same wording.\n\n        idMap = {}\n\n        for todo in fileStats.todos\n\n          render += '\\n'\n\n          id = ''\n          for line, index in todo.lines\n            render += '>'\n\nIf this is the line with the TODO, parse the ID from the TODO item text, and\nrender it as h2 (TODO are h6) to increase visibility.\n\n            if index is Todos.context\n              id = _idFromHook(line).slice 1, -1\n\n              render += line.slice 4\n            else\n              render += \" #{line}\"\n            render += '\\n'\n\n          render += '\\n'\n\n          filename = _sourcePath fileStats.file\n\nKeep track of ID usage and modify the location hash for subsequent uses.\n\n          if idMap[id]?\n            idMap[id] += 1\n            id += \"_#{idMap[id]}\"\n          else\n            idMap[id] = 0\n\n          render += \"###### the above found in [#{fileStats.file}:#{todo.index}](source\/#{filename}##{id})\\n\"\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/todos.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nAdd all the source files to a generated mkdocs.yml\n\n    _allSourceFiles().then (files) ->\n\n      yml = fs.readFileSync 'docs\/mkdocs.template.yml', 'utf8'\n\n      for file in files\n        parts = file.split '\/'\n\n        for i in [0...parts.length]\n          try\n            fs.mkdirSync \"docs\/source\/#{parts.slice(0, i).join '\/'}\"\n          catch error\n\n        fs.createReadStream(file).pipe(\n          fs.createWriteStream(\"docs\/source\/#{file}\")\n        )\n\nAdd them under the 'Source code' path.\n\n        yml += \"- [source\/#{file}, 'Source code', '#{file}']\\n\"\n\n      fs.writeFileSync 'mkdocs.yml', yml\n\n      return\n\nRender the packages page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\nSort by package name first.\n\n      newList = []\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        continue unless ~['custom', 'packages'].indexOf parts[0]\n\n        sourcePath = _sourcePath fileStats.file\n\n        parts = sourcePath.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'client'\n        pkg = parts.join '\/'\n        fileStats.pkg = pkg.split('\/').slice(1).join '\/'\n\n        newList.push fileStats\n\n      newList.sort (l, r) ->\n        if l.pkg < r.pkg then -1 else if l.pkg > r.pkg then 1 else 0\n\n    ).then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/packages.template.md', 'utf8'\n      render += '\\n'\n\n      type = null\n\n      for fileStats in fileStatsList\n\n        if fileStats.type isnt type\n          type = fileStats.type\n\n          render += if type is 'client'\n            '## Client-side'\n          else\n            '## Server-side'\n\n          render += '\\n\\n'\n\n        isSubpackage = fileStats.pkg.split('\/').length isnt 1\n\nLink to the package.\n\n        sourcePath = _sourcePath fileStats.file\n\n        if isSubpackage\n          render += '> '\n          parts = fileStats.pkg.split '\/'\n          parentPkg = parts.shift()\n          subPkg = parts.join '\/'\n          render += \"## [<small>#{parentPkg}\/<\/small>#{subPkg}](source\/#{sourcePath})\"\n        else\n          render += \"## [#{fileStats.pkg}](source\/#{sourcePath})\"\n\nNaively parse out the file description. It must be wrapped in asterisks, i.e.\nitalicized in markdown.\n\n###### TODO: This 'chunk' parsing should be done with a Transform like the others.\n\n        data = fs.readFileSync fileStats.file, 'utf8'\n        chunks = data.split '\\n\\n'\n\n        title = chunks[0]\n        if 35 is title.charCodeAt 0\n          render += \" &mdash; #{title.substr 2}\"\n\n        render += '\\n\\n'\n\n        description = chunks[1]\n        if 42 is description.charCodeAt 0 and 42 is description.charCodeAt description.length - 1\n          render += '> ' if isSubpackage\n          render += \"#{description}\\n\\n\"\n\n        if fileStats.implementations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Implements hooks\"\\n    '\n          render += fileStats.implementations.map((hook) ->\n            \"[#{hook}](source\/#{sourcePath}#implements-hook-#{hook.toLowerCase()})\"\n          ).join ', '\n          render += '\\n\\n'\n\n        if fileStats.invocations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Invokes hooks\"\\n    '\n          render += fileStats.invocations.map((hook) ->\n            \"[#{hook}](source\/#{sourcePath}#invoke-hook-#{hook.toLowerCase()})\"\n          ).join ', '\n          render += '\\n\\n'\n\n      fs.writeFileSync 'docs\/packages.md', render\n\n    )\n","old_contents":"\n# Documentation generation\n\n*Generate the dynamic portions of Shrub's documentation.*\n\n    {exec} = require 'child_process'\n    fs = require 'fs'\n    path = require 'path'\n    {Transform} = require 'stream'\n\n    _ = require 'lodash'\n    {LineStream} = require 'byline'\n    glob = require 'grunt\/node_modules\/glob'\n    Promise = require 'bluebird'\n\nImplement a Transform stream to accumulate hook invocations from a source file.\n\n    class HookInvocations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Invoke hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream to accumulate hook implementations from a source\nfile.\n\n    class HookImplementations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Implements hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream fo accumulate TODOs from a source file. Also\ncaches lines to be able to build context around each TODO item.\n\n    class Todos extends Transform\n\n      @context = 4\n\n      constructor: ->\n        super\n\n        @lines = []\n        @todos = []\n\n      _transform: (chunk, encoding, done) ->\n        @lines.push line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\#\\#\\# TODO\/\n          @todos.push @lines.length - 1\n\n        done()\n\n      withContext: ->\n\n        for todo in @todos\n\n          start = Math.max 0, todo - Todos.context\n          end = Math.min @lines.length - 1, todo + Todos.context\n\n          index: todo\n          lines: @lines.slice start, end\n\nGather all source files.\n\n    _allSourceFiles = ->\n      new Promise (resolve, reject) ->\n        glob(\n          '{{client,custom,packages,server}\/**\/*.litcoffee,*.litcoffee}'\n          (error, files) ->\n            return reject error if error?\n            resolve files\n        )\n\nGenerate an HTML ID from a hook name.\n\n    _idFromHook = (hook) -> hook.replace(\n      \/[^0-9A-Za-z-]+\/g, '-'\n    ).toLowerCase()\n\nGet the source path from a filename. This removes the extension and any \/index\nportion from the end of the filename.\n\n    _sourcePath = (filename) ->\n\n        dirname = path.dirname filename\n        if dirname is '.' then dirname = '' else dirname += '\/'\n        extname = path.extname filename\n        filename = \"#{dirname}#{path.basename filename, extname}\"\n\n        parts = filename.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'index'\n        return parts.join '\/'\n\nCollate a list of files by type (client or server).\n\n    _collateFilesByType = (files) ->\n\n      client = []\n      server = []\n\n      for file in files\n        parts = file.split '\/'\n\n        if parts[0] is 'client'\n          client.push file\n        else if parts[0] is 'custom' and parts[2] is 'client'\n          client.push file\n        else if parts[0] is 'packages' and parts[2] is 'client'\n          client.push file\n        else\n          server.push file\n\n      client: client, server: server\n\nGather statistics for all files.\n\n    fileStatsListPromise = _allSourceFiles().then (allFiles) ->\n\n      allFilesPromises = for type, files of _collateFilesByType allFiles\n\n        typePromises = for file in files\n\n          do (type, file) -> new Promise (resolve, reject) ->\n\n            fstream = fs.createReadStream file\n            fstream.pipe lineStream = new LineStream keepEmptyLines: true\n\nPass all files through the Transform list to parse out relevant information.\n\n            lineStream.pipe hookImplementations = new HookImplementations()\n            lineStream.pipe hookInvocations = new HookInvocations()\n            lineStream.pipe todos = new Todos()\n\n            fstream.on 'error', reject\n\n            fstream.on 'end', ->\n\nInclude all information from Transform streams in the statistics.\n\n              resolve(\n                type: type\n                file: file\n                implementations: hookImplementations.list\n                invocations: hookInvocations.list\n                todos: todos.withContext()\n              )\n\n        Promise.all typePromises\n\n      Promise.all(allFilesPromises).then (fileStatsLists) ->\n        _.flatten fileStatsLists\n\nMassage the statistics to help rendering the hooks page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      hooksIndex = {}\n\n      indexes = {}\n      keys = ['implementations', 'invocations']\n\n      for fileStats in fileStatsList\n\n        for key in keys\n          indexes[key] ?= {}\n\n          for hook in fileStats[key]\n            indexes[key][hook] ?= {}\n            (indexes[key][hook][fileStats.file] ?= []).push fileStats.type\n\n            hooksIndex[hook] = true\n\n      for key in keys\n        for hook, stats of indexes[key]\n          for file of stats\n            stats[file] = _.unique stats[file] ? []\n\n      hooks = (hook for hook of hooksIndex).sort()\n\n      hookFiles = {}\n      for hook in hooks\n        hookFiles[hook] = try\n          fs.readFileSync \"docs\/hook\/#{hook}.md\", 'utf8'\n        catch error\n          ''\n\n      O =\n        hookFiles: hookFiles\n        hooks: hooks\n\n      O[key] = indexes[key] for key in keys\n\n      return O\n\nRender the hooks page.\n\n    ).then((O) ->\n\n      {hookFiles, hooks} = O\n\n      keys = ['implementations', 'invocations']\n\n      wordingFor =\n        implementations: 'implements'\n        invocations: 'invoke'\n\n      render = fs.readFileSync 'docs\/hooks.template.md', 'utf8'\n\n      for hook in hooks\n\n        render += \"## #{hook}\\n\\n\"\n        render += hookFiles[hook] + '\\n\\n' if hookFiles[hook]\n\n        for key in keys\n\n          if O[key][hook]?\n\n            count = Object.keys(O[key][hook]).length\n            render += \"### #{count} #{key}(s)\\n\\n\"\n\n            for file, types of O[key][hook]\n\n              file = _sourcePath file\n\n              types = types.map (type) -> \"[#{type}](source\/#{file}##{wordingFor[key]}-hook-#{hook.toLowerCase()})\"\n\n              render += \"* #{file} (#{types.join ','})\\n\"\n\n            render += '\\n'\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/hooks.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nRender the TODOs page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/todos.template.md', 'utf8'\n\n      for fileStats in fileStatsList\n\nKeep track of used IDs, it will be necessary to link to the correct location\nhash in the case of multiple TODO items with the same wording.\n\n        idMap = {}\n\n        for todo in fileStats.todos\n\n          render += '\\n'\n\n          id = ''\n          for line, index in todo.lines\n            render += '>'\n\nIf this is the line with the TODO, parse the ID from the TODO item text, and\nrender it as h2 (TODO are h6) to increase visibility.\n\n            if index is Todos.context\n              id = _idFromHook(line).slice 1, -1\n\n              render += line.slice 4\n            else\n              render += \" #{line}\"\n            render += '\\n'\n\n          render += '\\n'\n\n          filename = _sourcePath fileStats.file\n\nKeep track of ID usage and modify the location hash for subsequent uses.\n\n          if idMap[id]?\n            idMap[id] += 1\n            id += \"_#{idMap[id]}\"\n          else\n            idMap[id] = 0\n\n          render += \"###### the above found in [#{fileStats.file}:#{todo.index}](source\/#{filename}##{id})\\n\"\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/todos.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nAdd all the source files to a generated mkdocs.yml\n\n    _allSourceFiles().then (files) ->\n\n      yml = fs.readFileSync 'docs\/mkdocs.template.yml', 'utf8'\n\n      for file in files\n        parts = file.split '\/'\n\n        for i in [0...parts.length]\n          try\n            fs.mkdirSync \"docs\/source\/#{parts.slice(0, i).join '\/'}\"\n          catch error\n\n        fs.createReadStream(file).pipe(\n          fs.createWriteStream(\"docs\/source\/#{file}\")\n        )\n\nAdd them under the 'Source code' path.\n\n        yml += \"- [source\/#{file}, 'Source code', '#{file}']\\n\"\n\n      fs.writeFileSync 'mkdocs.yml', yml\n\n      return\n\nRender the packages page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\nSort by package name first.\n\n      newList = []\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        continue unless ~['custom', 'packages'].indexOf parts[0]\n\n        sourcePath = _sourcePath fileStats.file\n\n        parts = sourcePath.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'client'\n        pkg = parts.join '\/'\n        fileStats.pkg = pkg.split('\/').slice(1).join '\/'\n\n        newList.push fileStats\n\n      newList.sort (l, r) ->\n        if l.pkg < r.pkg then -1 else if l.pkg > r.pkg then 1 else 0\n\n    ).then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/packages.template.md', 'utf8'\n      render += '\\n'\n\n      type = null\n\n      for fileStats in fileStatsList\n\n        if fileStats.type isnt type\n          type = fileStats.type\n\n          render += if type is 'client'\n            '## Client-side'\n          else\n            '## Server-side'\n\n          render += '\\n\\n'\n\n        isSubpackage = fileStats.pkg.split('\/').length isnt 1\n\nLink to the package.\n\n        sourcePath = _sourcePath fileStats.file\n\n        if isSubpackage\n          render += '> '\n          parts = fileStats.pkg.split '\/'\n          parentPkg = parts.shift()\n          subPkg = parts.join '\/'\n          render += \"### [<small>#{parentPkg}\/<\/small>#{subPkg}](source\/#{sourcePath})\"\n        else\n          render += \"### [#{fileStats.pkg}](source\/#{sourcePath})\"\n\nNaively parse out the file description. It must be wrapped in asterisks, i.e.\nitalicized in markdown.\n\n###### TODO: This 'chunk' parsing should be done with a Transform like the others.\n\n        data = fs.readFileSync fileStats.file, 'utf8'\n        chunks = data.split '\\n\\n'\n\n        title = chunks[0]\n        if 35 is title.charCodeAt 0\n          render += \" &mdash; #{title.substr 2}\"\n\n        render += '\\n\\n'\n\n        description = chunks[1]\n        if 42 is description.charCodeAt 0 and 42 is description.charCodeAt description.length - 1\n          render += '> ' if isSubpackage\n          render += \"#{description}\\n\\n\"\n\n        if fileStats.implementations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Implements hooks\"\\n    '\n          render += fileStats.implementations.map((hook) ->\n            \"[#{hook}](source\/#{sourcePath}#implements-hook-#{hook.toLowerCase()})\"\n          ).join ', '\n          render += '\\n\\n'\n\n        if fileStats.invocations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Invokes hooks\"\\n    '\n          render += fileStats.invocations.map((hook) ->\n            \"[#{hook}](source\/#{sourcePath}#invoke-hook-#{hook.toLowerCase()})\"\n          ).join ', '\n          render += '\\n\\n'\n\n      fs.writeFileSync 'docs\/packages.md', render\n\n    )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9e92b92c17b92a1eedbd71bb9563707ce273e36b","subject":"Send file upload count to Librato","message":"Send file upload count to Librato\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/server.litcoffee","new_file":"src\/server.litcoffee","new_contents":"    url          = require 'url'\n\n    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n    librato      = require '.\/librato'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      origin = url.parse req.get('Origin') or ''\n\n      if origin.hostname not in origins\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status = 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      librato.measure 'image.upload', Object.keys(req.files).length, {}\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","old_contents":"    url          = require 'url'\n\n    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      origin = url.parse req.get('Origin') or ''\n\n      if origin.hostname not in origins\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status = 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3f2386f8f74d82c1b10055cc0d7956a4d5b3f52e","subject":"Fix a socket bug with Firefox","message":"Fix a socket bug with Firefox\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/socket.litcoffee","new_file":"src\/coffee\/socket.litcoffee","new_contents":"WebSockets API\n==============\n\nThis API acts as the bridge between the Bacon.js-filled world of\nthe screens and the raw WebSockets API with which we communicate\nwith the server.\n\nIt is publicised through the *WS* public API.\n\nFirst, we create the actual WebSocket.\n\n    socket = new WebSocket 'ws:\/\/localhost:8080\/websocket.rpy'\n\nTransmission\n------------\n\nTransmission of data is significantly frustrated by an unfortunate\nside-effect of the asynchronous nature of programming on the web -\nthat is, we cannot guarantee that the socket is actually open yet\nwhen a call is made. Instead, we use a bus to push messages, with\na custom buffering function which will hold all messages until the\nsocket is ready.\n\nWe first create the actual bus. This contains already-encoded data,\nwhich merely needs to be passed to the native WebSockets *send*\nAPI.\n\n    transmitBus = new Bacon.Bus\n\nWe also define two auxiliary variables necessary for this to work:\na flag indicating whether the connection has yet been opened, and\na list of callbacks to invoke once it has been opened.\n\n    connected = false\n    onConnectCallbacks = []\n\nThe buffering function, *bufferTXBus*, implements the protocol\nrequired for *bufferWithTime*. Given its argument, *f*, which decides\nwhen to dispatch the actual message, it:\n\n* Schedules a call at the end of the current iteration of the JavaScript run\n  loop if the socket is already connected, and\n* Adds it to the list of callbacks to invoked once the socket is open.\n\n    bufferTXBus = (f) ->\n        _.defer f if connected\n        onConnectCallbacks.push f if not connected\n\nOnce the socket is opened, indicated by the *onopen* function in\nthe WebSocket, we flush the *onConnectCallbacks* queue and set the\n*connected* flag, preventing further calls being added to the queue.\n\n    socket.onopen = ->\n        connected = true\n        do f for f in onConnectCallbacks\n        onConnectCallbacks = []\n\nWe bind the *transmitBus*, with buffering, to transmit messages\nthrough the native WebSockets API.\n\n    transmitBus.bufferWithTime(bufferTXBus).onValue (x) ->\n        socket.send msg for msg in x\n\nFinally, we define the public API function through which clients\ncan send messages. This function constructs a native JavaScript\nobject representing the message (without modifying the argument),\nthen pushes it to the *transmitBus*.\n\n    send = (message, data = {}) ->\n        target = _.clone(data)\n        target.type = message\n        transmitBus.push JSON.stringify(target)\n\nReceipt\n-------\n\nReceiving messages through the WebSockets API is an altogether\nsimpler affair.  We simply define a bus on which messages are\nreceived, and interested clients subscribe to it.\n\nThe bus is deliberately publicly exposed as a bus rather than an\nevent source, so that (for testing and debugging purposes or for\ndisgusting hacks) clients can *inject* messages to be spread through\nthe system as if they were received from the server.\n\n    messageBus = new Bacon.Bus\n    socket.onmessage = (msg) ->\n        messageBus.push JSON.parse(msg.data)\n\nPublic API\n----------\n\nFinally, the public interface to the WebSockets API is presented\nthrough the *WS* global.\n\n    window.WS =\n        message: messageBus\n        send: send\n\n","old_contents":"WebSockets API\n==============\n\nThis API acts as the bridge between the Bacon.js-filled world of\nthe screens and the raw WebSockets API with which we communicate\nwith the server.\n\nIt is publicised through the *WS* public API.\n\nFirst, we create the actual WebSocket.\n\n    socket = new WebSocket 'ws:\/\/localhost:8080\/websocket.rpy'\n\nTransmission\n------------\n\nTransmission of data is significantly frustrated by an unfortunate\nside-effect of the asynchronous nature of programming on the web -\nthat is, we cannot guarantee that the socket is actually open yet\nwhen a call is made. Instead, we use a bus to push messages, with\na custom buffering function which will hold all messages until the\nsocket is ready.\n\nWe first create the actual bus. This contains already-encoded data,\nwhich merely needs to be passed to the native WebSockets *send*\nAPI.\n\n    transmitBus = new Bacon.Bus\n\nWe also define two auxiliary variables necessary for this to work:\na flag indicating whether the connection has yet been opened, and\na list of callbacks to invoke once it has been opened.\n\n    connected = false\n    onConnectCallbacks = []\n\nThe buffering function, *bufferTXBus*, implements the protocol\nrequired for *bufferWithTime*. Given its argument, *f*, which decides\nwhen to dispatch the actual message, it:\n\n* Schedules a call at the end of the current iteration of the JavaScript run\n  loop if the socket is already connected, and\n* Adds it to the list of callbacks to invoked once the socket is open.\n\n    bufferTXBus = (f) ->\n        _.defer f if connected\n        onConnectCallbacks.push f if not connected\n\nOnce the socket is opened, indicated by the *onopen* function in\nthe WebSocket, we flush the *onConnectCallbacks* queue and set the\n*connected* flag, preventing further calls being added to the queue.\n\n    socket.onopen = ->\n        connected = true\n        do f for f in onConnectCallbacks\n        onConnectCallbacks = []\n\nWe bind the *transmitBus*, with buffering, to transmit messages\nthrough the native WebSockets API.\n\n    transmitBus.bufferWithTime(bufferTXBus).onValue (x) ->\n        socket.send x\n\nFinally, we define the public API function through which clients\ncan send messages. This function constructs a native JavaScript\nobject representing the message (without modifying the argument),\nthen pushes it to the *transmitBus*.\n\n    send = (message, data = {}) ->\n        target = _.clone(data)\n        target.type = message\n        transmitBus.push JSON.stringify(target)\n\nReceipt\n-------\n\nReceiving messages through the WebSockets API is an altogether\nsimpler affair.  We simply define a bus on which messages are\nreceived, and interested clients subscribe to it.\n\nThe bus is deliberately publicly exposed as a bus rather than an\nevent source, so that (for testing and debugging purposes or for\ndisgusting hacks) clients can *inject* messages to be spread through\nthe system as if they were received from the server.\n\n    messageBus = new Bacon.Bus\n    socket.onmessage = (msg) ->\n        messageBus.push JSON.parse(msg.data)\n\nPublic API\n----------\n\nFinally, the public interface to the WebSockets API is presented\nthrough the *WS* global.\n\n    window.WS =\n        message: messageBus\n        send: send\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"56fc8a30dd22f4e815f8a0b9aefb29e7cfb53660","subject":"Return JSON with correct spacing","message":"Return JSON with correct spacing\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.user.tilbyder}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.user.tilbyder}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bf8ec131c7d019b90f980572a552d39cc3d03427","subject":"- use WrappedModule","message":"- use WrappedModule\n","repos":"WillemDeGroef\/nodesentry","old_file":"src\/index.litcoffee","new_file":"src\/index.litcoffee","new_contents":"NodeSentry\n==========\n\nThe key idea of our proposal, called \\ns, is to use a variant of an inline\nreference monitor~\\cite{schneider2000,erlingsson2003} as modified for the\nSecurity-by-Contract approach for Java and {.NET}~\\cite{desmet2008} in order to\nmake it more flexible. Specifically, we do not embed the monitor into the code as\nsuggested by most approaches for inline reference monitors but inline only \nhooks in a few key places, while the monitor itself is an external component. In our\ncase this has the added advantage of potentially improving performance (a key\nrequirement for server-side code) as the monitor can now run in a separate\nthread and threads that do not call security relevant actions are unaffected.\nFurther, and maybe most important, we do not limit ourselves to purely\nraising security exceptions and stopping the execution but support policies\nthat specify how to ``fix'' the execution; the ability to continue executing after\nsecurity errors is an essential requirement\nfor server-side applications.\n\nIn order to maintain control over all references acquired by the library, e.g.,\nvia a call to \\jslib{require}, \\ns applies the \\emph{membrane} pattern,\noriginally proposed by Miller~\\cite[\\S 9]{miller2006} and further refined\nby Van Cutsem and Miller~\\cite{vancutsem2013}. The goal of a membrane is to fully isolate two object\ngraphs~\\cite{miller2006,vancutsem2013}.  Intuitively, a membrane creates a\nshadow object that is a ``clone'' of the target object that it wishes to\nprotect. Only the references to the shadow\nobject are passed further to callers. Any access to the shadowed object is then\nintercepted and either served directly or eventually reflected on the target\nobject through handlers. In this way, when a membrane revokes a reference,\nessentially by destroying the shadow object~\\cite{vancutsem2013}, it instantly\nachieves the goal of transitively revoking all references as advocated by\nMiller~\\cite{miller2006}.\n\n\n    harmonyFlagsEnabled = -> \"function\" == typeof Map\n    throw new Error \"NodeSentry requires the harmony flags. (`node --harmony`)\" if not harmonyFlagsEnabled()\n    \n    harmony = require \"harmony-reflect\"\n    log = require \".\/logger\"\n    WrappedModule = require \".\/module\"\n    path = require \"path\"\n\n    absolutePath = (name) -> name[0] == \"\/\"\n    installedModule = (name) -> not (name.indexOf(\".js\") > -1) and not (name.indexOf(\".\") > -1)\n    updatePath = (name) -> path.join(path.dirname(module.parent.filename), name)\n\n    global.safe_require = (libName, policyObj) ->\n        libName = updatePath(libName) unless absolutePath(libName) or installedModule(libName)\n        modPaths = module.parent.paths\n\nLoad the module in a specific `ModuleLoader` that makes it possible to intercept all subsequent calls to `require`.\n\n        wrappedModule = new WrappedModule(libName, modPaths, policyObj)\n        do wrappedModule.load\n\n    module.exports.Policy = require \".\/policy\"\n\nCopyright 2014 -- iMinds-DistriNet, KU Leuven\n","old_contents":"NodeSentry\n==========\n\nThe key idea of our proposal, called \\ns, is to use a variant of an inline\nreference monitor~\\cite{schneider2000,erlingsson2003} as modified for the\nSecurity-by-Contract approach for Java and {.NET}~\\cite{desmet2008} in order to\nmake it more flexible. Specifically, we do not embed the monitor into the code as\nsuggested by most approaches for inline reference monitors but inline only \nhooks in a few key places, while the monitor itself is an external component. In our\ncase this has the added advantage of potentially improving performance (a key\nrequirement for server-side code) as the monitor can now run in a separate\nthread and threads that do not call security relevant actions are unaffected.\nFurther, and maybe most important, we do not limit ourselves to purely\nraising security exceptions and stopping the execution but support policies\nthat specify how to ``fix'' the execution; the ability to continue executing after\nsecurity errors is an essential requirement\nfor server-side applications.\n\nIn order to maintain control over all references acquired by the library, e.g.,\nvia a call to \\jslib{require}, \\ns applies the \\emph{membrane} pattern,\noriginally proposed by Miller~\\cite[\\S 9]{miller2006} and further refined\nby Van Cutsem and Miller~\\cite{vancutsem2013}. The goal of a membrane is to fully isolate two object\ngraphs~\\cite{miller2006,vancutsem2013}.  Intuitively, a membrane creates a\nshadow object that is a ``clone'' of the target object that it wishes to\nprotect. Only the references to the shadow\nobject are passed further to callers. Any access to the shadowed object is then\nintercepted and either served directly or eventually reflected on the target\nobject through handlers. In this way, when a membrane revokes a reference,\nessentially by destroying the shadow object~\\cite{vancutsem2013}, it instantly\nachieves the goal of transitively revoking all references as advocated by\nMiller~\\cite{miller2006}.\n\n\n    harmonyFlagsEnabled = -> \"function\" == typeof Map\n    throw new Error \"NodeSentry requires the harmony flags. (`node --harmony`)\" if not harmonyFlagsEnabled()\n    \n    harmony = require \"harmony-reflect\"\n    log = require \".\/logger\"\n    Module = require \".\/module\"\n    path = require \"path\"\n\n    absolutePath = (name) -> name[0] == \"\/\"\n    installedModule = (name) -> not (name.indexOf(\".js\") > -1)\n    updatePath = (name) -> path.join(path.dirname(module.parent.filename), name)\n\n    global.safe_require = (libName, policyObj) ->\n        # update relative paths\n        libName = updatePath(libName) unless absolutePath(libName) or installedModule(libName)\n        # update search paths for local\/global modules\n        module.paths = module.parent.paths\n        if policyObj?\n            m = new Module(libName)\n            m.setPolicy policyObj\n            m.loadLibrary()\n        else\n            require libName\n\n    module.exports.Policy = require \".\/policy\"\n\nCopyright 2014 -- iMinds-DistriNet, KU Leuven\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4289bc5b665cd932d3e115750630b62097e47f68","subject":"http socket","message":"http socket\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n##Response class\n\n    class Response\n     constructor: (data, port) ->\n      @id = data.id\n      @port = port\n\n     progress: (progress, data) ->\n      @port.respond this, 'progress', data, progress: progress\n\n     success: (data) ->\n      @port.respond this, 'success', data\n\n     fail: (data) ->\n      @port.respond this, 'fail', data\n\n\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks) -> null\n\n     handle: (data) ->\n      if not @callbacks[data.status]?\n       throw new Error \"No callback registered #{@method} #{data.status}\"\n      @callback[data.status] data\n\n##Port base class\n\n    class Port\n     constructor: (options = {}) ->\n      @handlers = options.handlers ? {}\n      @callsCache = {}\n      @callsCounter = 0\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      @_send @_createCall method, data, callbacks, options\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}) ->\n      @_respond @_createRespose response, status, data, options\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      #TODO other params via options\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      call = new Call @callsCounter, method, data, callbacks\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       mehtod: call.method\n       data: call.data\n\n      return params\n\n###Create Response object\n\n     _createRespose: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     addHandler: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     handleMessage: (data) ->\n      if data.type is 'response'\n       return unless @callsCache[data.id]?\n       @callsCache[data.id].handle data\n      else if data.type is 'call'\n       return unless @handlers[data.method]?\n       @handlers[data.method] data.data, new Response data, this\n\n\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (options, worker) ->\n      super options\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @handleMessage data\n\n     _onError: (e) -> console.log e\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (options, socket) ->\n      super options\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (options, server) ->\n      super options\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super options\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n\n     _send: (data) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, (res) =>\n       console.log 'STATUS: ' + res.statusCode\n       console.log 'HEADERS: ' + JSON.stringify res.headers\n       res.setEncoding 'utf8'\n       res.on 'data', (chunk) ->\n        console.log 'BODY: ' + chunk\n       #console.log 'result', res\n\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       console.log 'error', e\n\n      req.write data\n      req.end()\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      NodeHttpPort: NodeHttpPort\n      ServerSocketPort: ServerSocketPort\n\n     setup: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    class Response\n     constructor: (data, port) ->\n      @id = data.id\n      @port = port\n\n     progress: (progress, data) ->\n      @port.respond this, 'progress', data, progress: progress\n     success: (data) ->\n      @port.respond this, 'success', data\n     fail: (data) ->\n      @port.respond this, 'fail', data\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks) -> null\n\n     handle: (data) ->\n      if not @callbacks[data.status]?\n       throw new Error \"No callback registered #{@method} #{data.status}\"\n      @callback[data.status] data\n\n    class Port\n     constructor: (options = {}) ->\n      @handlers = options.handlers ? {}\n      @callsCache = {}\n      @callsCounter = 0\n\n     send: (method, data, callbacks, options = {}) ->\n      @_send @_createCall method, data, callbacks, options\n\n     respond: (response, status, data, options = {}) ->\n      @_respond @_createRespose response, status, data, options\n\n\n     _createCall: (method, data, callbacks, options) ->\n      #TODO other params via options\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      call = new Call @callsCounter, method, data, callbacks\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       mehtod: call.method\n       data: call.data\n\n      return params\n\n     _createRespose: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n     addHandler: (method, callback) ->\n      @handlers[method] = callback\n\n     handleMessage: (data) ->\n      if data.type is 'response'\n       return unless @callsCache[data.id]?\n       @callsCache[data.id].handle data\n      else if data.type is 'call'\n       return unless @handlers[data.method]?\n       @handlers[data.method] data.data, new Response data, this\n\n    class WorkerPort extends Port\n     constructor: (options, worker) ->\n      super options\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @handleMessage data\n\n     _onError: (e) -> console.log e\n\n    class SocketPort extends Port\n     constructor: (options, socket) ->\n      super options\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @handleMessage data\n\n    class ServerSocketPort extends Port\n     constructor: (options, server) ->\n      super options\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      ServerSocketPort: ServerSocketPort\n\n     setup: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8262625f25c45f4ddf500d6279ed99304875a73a","subject":"Update floor thickness rendering to make more sense visually","message":"Update floor thickness rendering to make more sense visually\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_ground.litcoffee","new_file":"lib\/render-pipelines\/png\/png_ground.litcoffee","new_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngGround extends PngRenderer\n\n      do_render: (ctx, path) =>\n        cell_width  = @config.width\n        cell_height = @config.height\n\n        ground_segments = @config.ground.segments\n        segment_width   = 1 \/ ground_segments\n        ground_width    = cell_width * segment_width\n\n        fill_segment = (block, segment, height, color) =>\n          right  = segment * (cell_width * segment_width)\n          left   = (cell_width * block.x) + right\n          top    = (cell_height * (block.y + 1)) - height\n\n          ctx.fillStyle = color\n\n          ctx.beginPath()\n          ctx.rect left, top, ground_width, height\n          ctx.fill()\n\n        for step in path\n          for g, i in step.ground\n            fill_segment step, i, (g.thickness * @config.multiplier) * 0.5, @config.ground.fill_color\n\n    module.exports = PngGround\n","old_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngGround extends PngRenderer\n\n      do_render: (ctx, path) =>\n        cell_width  = @config.width\n        cell_height = @config.height\n\n        ground_segments = @config.ground.segments\n        segment_width   = 1 \/ ground_segments\n        ground_width    = cell_width * segment_width\n\n        fill_segment = (block, segment, height, color) =>\n          right  = segment * (cell_width * segment_width)\n          left   = (cell_width * block.x) + right\n          top    = (cell_height * (block.y + 1)) - height\n\n          ctx.fillStyle = color\n\n          ctx.beginPath()\n          ctx.rect left, top, ground_width, height\n          ctx.fill()\n\n        for step in path\n          for g, i in step.ground\n            fill_segment step, i, g.thickness * @config.multiplier, @config.ground.fill_color\n\n    module.exports = PngGround\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d617622abe3797cd995fc038939dbcd2e41e7086","subject":"fix proper return from create call, see #40","message":"fix proper return from create call, see #40\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object.__` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property') if process.env.DEBUG?\n    co       = require 'co'\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state  = \n          value: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n\n        @schema.kind   ?= 'anydata'\n        @schema.config ?= true\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n\n        # Below makes this Property adaptive to @schema changes\n        unless @kind is 'list' and @name isnt @schema.datakey\n          unless @kind isnt 'list' and @schema.parent?.kind is 'list'\n            @schema.counter ?= 0\n            @schema.counter++\n            #console.log \"#{@name} listening to schema change #{@schema.counter} times\"\n            @schema.on? 'change', =>\n              debug? \"[adaptive] #{@kind}(#{@name}) detected schema change, re-applying data\"\n              @set @content, force: true\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'container'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, force: true\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.property = this\n          Object.defineProperty ctx, 'action',\n            get: -> @content if @content instanceof Function\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'parent', get: -> @container?.__\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          if @parent instanceof Property then @parent.root\n          else this\n      \n      @property 'props',\n        get: -> prop for k, prop of @content?.__props__\n      \n      @property 'key',\n        get: ->\n          return unless @schema is @parent?.schema\n          switch\n            when @content not instanceof Object  then @name + 1\n            when @content.hasOwnProperty('@key') then @content['@key']\n            when Array.isArray @container\n              for idx, item of @container when item is @content\n                idx = Number(idx) unless (Number.isNaN (Number idx))\n                return idx+1\n              return undefined\n\n      # TODO: cache this in @state so that it's not reconstructed every time\n      @property 'path',\n        get: ->\n          return XPath.parse '\/', @schema if this is @root\n          #debug? \"[path] #{@kind}(#{@name}) has #{@key} #{typeof @key}\"\n          entity = switch typeof @key\n            when 'number' then \".[#{@key}]\"\n            when 'string' then \".[key() = '#{@key}']\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          #debug? \"[#{@name}] path: #{@parent.name} + #{entity}\"\n          @parent.path.append entity\n\n## Instance-level methods\n\n      emit: (event) ->\n        return if this is @root\n        debug? \"[emit] '#{event}' from '#{@name}' to '#{@root.name}'\"\n        @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It registers itself into\n`obj.__props__` as well as defined in the target `obj` via\n`Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false }) ->\n        return obj unless obj instanceof Object\n\n        # when joining for the first time, apply the data found in the\n        # 'obj' into the property instance\n        unless @container?\n          debug? \"[join] #{@kind}(#{@name}) assigning container\"\n          debug? opts\n          @container = obj\n          unless opts.replace is true\n            opts.suppress = true\n            @set obj[@name], opts\n          return obj\n\n        debug? \"[join] #{@kind}(#{@name}) into #{obj.constructor.name} container\"\n        if Array.isArray(obj) and Array.isArray(@content)\n          debug? @content\n          throw @error \"cannot join array property into list container\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n          \n        unless obj.hasOwnProperty '__props__'\n          Object.defineProperty obj, '__props__', value: {}\n        obj.__props__[@name] = this\n        try Object.defineProperty obj, @name, this\n        @emit 'update', this unless opts.suppress\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern) -> switch\n        when pattern?\n          match = @find pattern\n          debug? match\n          switch\n            when match.length is 1 then match[0].get()\n            when match.length > 1  then match.map (x) -> x.get()\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then @invoke.bind this\n        else\n          @binding.call @context if @binding?\n          # TODO: should utilize yield to resolve promises\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        debug? \"[set] #{@kind}(#{@name}) enter with:\"\n        debug? value\n        debug? opts\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only element\"\n\n        try Object.defineProperty value, '__', configurable: true, value: this\n        value = switch\n          when @schema.apply?\n            @schema.apply value, @context.with(opts)\n          else value\n        try Object.defineProperty value, '__', value: this\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        @state.value = value\n        \n        try @join @container, opts\n        catch e then @state.value = @state.prev; throw e\n        debug? \"[set] #{@kind}(#{@name}) completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        unless typeof @content is 'object' then return @set value\n\n        value = value[@name] if value? and value.hasOwnProperty @name\n        return unless typeof value is 'object'\n        \n        if Array.isArray @content\n          length = @content.length\n          debug? \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          value = [ value ] unless Array.isArray value\n          try Object.defineProperty value, '__', configurable: true, value: this\n          value = @schema.apply value\n          value.forEach (item) =>\n            item.__.name += length\n            item.__.join @content, opts\n          # TODO: need to re-apply schema on the 'list'\n        else\n          # TODO: protect this as a transaction?\n          @content[k] = v for k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n        return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        @merge value, replace: false\n        @emit 'create', this\n        return this\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@parent` containing object.\n      \n      remove: ->\n        if @key?\n          @container.splice @name, 1\n          #delete @parent[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          @join @container\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        xpath = switch\n          when pattern instanceof XPath then pattern\n          else XPath.parse pattern, @schema\n        debug? \"[#{@path}] finding #{pattern} starting with #{xpath.tag}\"\n        if opts.root or not @container? or xpath.tag not in [ '\/', '..' ]\n          debug? \"[#{@path}] #{@name} applying '#{xpath}'\"\n          debug? @content\n          xpath.apply(@content).props ? []\n        else switch\n          when xpath.tag is '\/'  and @parent? then @parent.find xpath, opts\n          when xpath.tag is '..' and @parent? then @parent.find xpath.xpath, opts\n          else []\n\n### invoke\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\n      invoke: (args...) ->\n        try\n          ctx = @context\n          unless ctx.action?\n            throw @error \"cannot invoke on a property without function\"\n          debug? \"[invoke] calling #{@name} method\"\n          # TODO: need to ensure unique instance of 'input' and 'output' for concurrency\n          ctx.input = args[0] ? {}\n          ctx.action.apply ctx, args\n          return co -> yield Promise.resolve ctx.output\n        catch e\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        res = new Error \"[#{at}] #{msg}\"\n        res.name = 'PropertyError'\n        res.context = ctx\n        return res\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          key:    @key\n          xpath:  @path.toString()\n          schema: @schema.toJSON tag: false, extended: true\n          active: @enumerable\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\nproperty's `@name`.\n\n      toJSON: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            res[k] = copy v for own k, v of src\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object.__` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property') if process.env.DEBUG?\n    co       = require 'co'\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state  = \n          value: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n\n        @schema.kind   ?= 'anydata'\n        @schema.config ?= true\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n\n        # Below makes this Property adaptive to @schema changes\n        unless @kind is 'list' and @name isnt @schema.datakey\n          unless @kind isnt 'list' and @schema.parent?.kind is 'list'\n            @schema.counter ?= 0\n            @schema.counter++\n            #console.log \"#{@name} listening to schema change #{@schema.counter} times\"\n            @schema.on? 'change', =>\n              debug? \"[adaptive] #{@kind}(#{@name}) detected schema change, re-applying data\"\n              @set @content, force: true\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'container'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, force: true\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.property = this\n          Object.defineProperty ctx, 'action',\n            get: -> @content if @content instanceof Function\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'parent', get: -> @container?.__\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          if @parent instanceof Property then @parent.root\n          else this\n      \n      @property 'props',\n        get: -> prop for k, prop of @content?.__props__\n      \n      @property 'key',\n        get: ->\n          return unless @schema is @parent?.schema\n          switch\n            when @content not instanceof Object  then @name + 1\n            when @content.hasOwnProperty('@key') then @content['@key']\n            when Array.isArray @container\n              for idx, item of @container when item is @content\n                idx = Number(idx) unless (Number.isNaN (Number idx))\n                return idx+1\n              return undefined\n\n      # TODO: cache this in @state so that it's not reconstructed every time\n      @property 'path',\n        get: ->\n          return XPath.parse '\/', @schema if this is @root\n          #debug? \"[path] #{@kind}(#{@name}) has #{@key} #{typeof @key}\"\n          entity = switch typeof @key\n            when 'number' then \".[#{@key}]\"\n            when 'string' then \".[key() = '#{@key}']\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          #debug? \"[#{@name}] path: #{@parent.name} + #{entity}\"\n          @parent.path.append entity\n\n## Instance-level methods\n\n      emit: (event) ->\n        return if this is @root\n        debug? \"[emit] '#{event}' from '#{@name}' to '#{@root.name}'\"\n        @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It registers itself into\n`obj.__props__` as well as defined in the target `obj` via\n`Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false }) ->\n        return obj unless obj instanceof Object\n\n        # when joining for the first time, apply the data found in the\n        # 'obj' into the property instance\n        unless @container?\n          debug? \"[join] #{@kind}(#{@name}) assigning container\"\n          debug? opts\n          @container = obj\n          unless opts.replace is true\n            opts.suppress = true\n            @set obj[@name], opts\n          return obj\n\n        debug? \"[join] #{@kind}(#{@name}) into #{obj.constructor.name} container\"\n        if Array.isArray(obj) and Array.isArray(@content)\n          debug? @content\n          throw @error \"cannot join array property into list container\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n          \n        unless obj.hasOwnProperty '__props__'\n          Object.defineProperty obj, '__props__', value: {}\n        obj.__props__[@name] = this\n        try Object.defineProperty obj, @name, this\n        @emit 'update', this unless opts.suppress\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern) -> switch\n        when pattern?\n          match = @find pattern\n          debug? match\n          switch\n            when match.length is 1 then match[0].get()\n            when match.length > 1  then match.map (x) -> x.get()\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then @invoke.bind this\n        else\n          @binding.call @context if @binding?\n          # TODO: should utilize yield to resolve promises\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        debug? \"[set] #{@kind}(#{@name}) enter with:\"\n        debug? value\n        debug? opts\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only element\"\n\n        try Object.defineProperty value, '__', configurable: true, value: this\n        value = switch\n          when @schema.apply?\n            @schema.apply value, @context.with(opts)\n          else value\n        try Object.defineProperty value, '__', value: this\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        @state.value = value\n        \n        try @join @container, opts\n        catch e then @state.value = @state.prev; throw e\n        debug? \"[set] #{@kind}(#{@name}) completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        unless typeof @content is 'object' then return @set value\n\n        value = value[@name] if value? and value.hasOwnProperty @name\n        return unless typeof value is 'object'\n        \n        if Array.isArray @content\n          length = @content.length\n          debug? \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          value = [ value ] unless Array.isArray value\n          try Object.defineProperty value, '__', configurable: true, value: this\n          value = @schema.apply value\n          value.forEach (item) =>\n            item.__.name += length\n            item.__.join @content, opts\n          # TODO: need to re-apply schema on the 'list'\n        else\n          # TODO: protect this as a transaction?\n          @content[k] = v for k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n        return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        @merge value, replace: false\n        @emit 'create', this\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@parent` containing object.\n      \n      remove: ->\n        if @key?\n          @container.splice @name, 1\n          #delete @parent[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          @join @container\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        xpath = switch\n          when pattern instanceof XPath then pattern\n          else XPath.parse pattern, @schema\n        debug? \"[#{@path}] finding #{pattern} starting with #{xpath.tag}\"\n        if opts.root or not @container? or xpath.tag not in [ '\/', '..' ]\n          debug? \"[#{@path}] #{@name} applying '#{xpath}'\"\n          debug? @content\n          xpath.apply(@content).props ? []\n        else switch\n          when xpath.tag is '\/'  and @parent? then @parent.find xpath, opts\n          when xpath.tag is '..' and @parent? then @parent.find xpath.xpath, opts\n          else []\n\n### invoke\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\n      invoke: (args...) ->\n        try\n          ctx = @context\n          unless ctx.action?\n            throw @error \"cannot invoke on a property without function\"\n          debug? \"[invoke] calling #{@name} method\"\n          # TODO: need to ensure unique instance of 'input' and 'output' for concurrency\n          ctx.input = args[0] ? {}\n          ctx.action.apply ctx, args\n          return co -> yield Promise.resolve ctx.output\n        catch e\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        res = new Error \"[#{at}] #{msg}\"\n        res.name = 'PropertyError'\n        res.context = ctx\n        return res\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          key:    @key\n          xpath:  @path.toString()\n          schema: @schema.toJSON tag: false, extended: true\n          active: @enumerable\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\nproperty's `@name`.\n\n      toJSON: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            res[k] = copy v for own k, v of src\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"5bd86ed0890616c7815d4e37d0dac5b30f1fcf9b","subject":"respond callback fix","message":"respond callback fix\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response\n      else\n       @_sendBuffer buffer, options.response\n\n     _sendBuffer: (buf, res) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d1a906151a710970f1a492b0ad329b5bed338c89","subject":"Improve time formatting.","message":"Improve time formatting.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description\n\nHere we try to implement a time axis that would be more readable and at the same time more informative than conventionally used time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\nTest cases\n----------\n\n### Visual test cases\n\nThis are draft-thoughts.\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done, this is a draft:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\n### The `TimeAxisMaker` class\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n * `options.tickTailRatio`:  relative size of a tick on the other side of a baseline, upwards (so the length of the tick upwards will be tickTailRatio * tickLength).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n * `options.textTemplate`:  formatting string for text labels.\n\nThe code:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: switch @options.intervalType\n                when 'year' then timePoint.getFullYear().toString()\n                when 'month' then timePoint.getMonth().toString()\n                when 'week', 'day' then timePoint.getDate().toString()\n                when 'hour' then timePoint.getHours().toString()\n                when 'minute' then timePoint.getMinutes().toString()\n                when 'second' then timePoint.getSeconds().toString()\n                when 'millisecond' then \".#{ timePoint.getMilliseconds() }\"\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n### The `TimeAxisRenderer` class\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n      timeAxisRedrerer = new TimeAxisRenderer()\n      timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nNotes\n-----\n\n### Notes related to only this file\n\nWell, no notes yet.\n\n### Notes that should be moved away at some point\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description\n\nHere we try to implement a time axis that would be more readable and at the same time more informative than conventionally used time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\nTest cases\n----------\n\n### Visual test cases\n\nThis are draft-thoughts.\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done, this is a draft:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\n### The `TimeAxisMaker` class\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n * `options.tickTailRatio`:  relative size of a tick on the other side of a baseline, upwards (so the length of the tick upwards will be tickTailRatio * tickLength).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`: absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n\nThe code:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n### The `TimeAxisRenderer` class\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n      timeAxisRedrerer = new TimeAxisRenderer()\n      timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nNotes\n-----\n\n### Notes related to only this file\n\nWell, no notes yet.\n\n### Notes that should be moved away at some point\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"dac19c1229d9673465bd4425f06379b750717f7e","subject":"[Screen][minor] Documentation improvements","message":"[Screen][minor] Documentation improvements\n","repos":"marrus-sh\/jelli","old_file":"source\/modules\/Screen.litcoffee","new_file":"source\/modules\/Screen.litcoffee","new_contents":"#  SCREEN  #\nConvenient canvas and context packaging\n\n- - -\n\n##  Description  ##\n\nThe `Screen` module provides a convenient wrapper object for HTML `<canvas>`s.\n\n###  The `Screen` object:  ###\n\n####  The constructor  ####\n\n#####  SYNTAX  #####\n\n>   ```javascript\n>   new Screen(canvas);\n>   new Screen(canvas, context);\n>   ```\n\n-   **`canvas`**\u2014\n    An `HTMLCanvasElement`, or the `id` of one.\n    Note that if an `id` is provided, it is assumed to belong to `window.document`.\n\n-   **`context`**\u2014\n    The string to pass to `canvas.getContext()`.\n    This defaults to `\"2d\"`.\n\n#####  PROPERTIES  #####\n\n-   **`Screen.prototype`**\u2014\n    The `Screen` prototype object.\n\n#####  METHODS  #####\n\nThe `Screen()` constructor does not have any methods.\n\n####  `Screen` instances  ####\n\n#####  PROPERTIES  #####\n\nIf no canvas has been defined, all of the following properties return `undefined`.\n\n-   **`scrn.canvas`**\u2014\n    The `HTMLCanvasElement` associated with the `Screen` instance.\n    **Read-only.**\n\n-   **`scrn.context`**\u2014\n    The rendering context associated with the `Screen` instance.\n    **Read-only.**\n\n-   **`scrn.height`, `scrn.width`**\u2014\n    The width and height of the canvas.\n\n-   **`scrn.ownerDocument`**\u2014\n    An alias for `scrn.canvas.ownerDocument`.\n    **Read-only.**\n\n#####  METHODS  #####\n\n-   **`Screen.prototype.clear()`**\u2014\n    Clears the canvas.\n    This uses `scrn.context.clearRect()` for `CanvasRenderingContext2D`s and `scrn.context.clear()` for `WebGLRenderingContext`s.\n    For other contexts (ie, as a fallback), it calls `scrn.canvas.width = scrn.canvas.width`, which is much slower and less efficient.\n\n###  Examples:  ###\n\n####  Setting up a 2D screen  ####\n\n>   ```html\n>   <!DOCTYPE html>\n>   <canvas id=\"canvas\"><\/canvas>\n>   <script type=\"text\/javascript\">\n>       scrn = new Screen(\"canvas\");  \/\/  The \"2d\" is optional.\n>       scrn.context.fillStyle = \"red\";\n>       scrn.context.fillRect(0, 0, scrn.width, scrn.height);\n>   <\/script>\n\n##  Implementation  ##\n\n    \"use strict\";\n\n    ###\n    SCREEN\n    Convenient canvas and context packaging\n    ---------------------------------------\n    ###\n\n`Screen` is a very simple constructor.\nIts goal is to provide a simple means of accessing both the canvas and the context for an HTML canvas element.\n\n###  The constructor:  ###\n\nThe `Screen` constructor takes two arguments: `canvas`, of type `HTMLCanvasElement`, and `context`, which should be the string to pass to `canvas.getContext()`.\nThe former of these arguments can also be passed as a string, in which case Screen will call `document.getElementById` to find the element.\nThe latter of these arguments defaults to `\"2d\"`.\n\n    Screen = (canvas, context = \"2d\") ->\n\nFirst we handle the arguments.\nNote `doc` is used here to store the owner document, which is not assumed to be `document` (unless `canvas` is not an `HTMLCanvasElement`):\n\n        unless canvas instanceof HTMLCanvasElement\n            doc = document\n            canvas = doc.getElementById(canvas)\n            canvas = undefined unless canvas instanceof HTMLCanvasElement\n        else doc = canvas.ownerDocument\n\nNote in the above code that if no `HTMLCanvasElement` can be found, `canvas` is set to `undefined`.\n\nThe width and height of the canvas are accessible through `Screen` attributes, but require some special getters and setters in case the canvas isn't defined.\nNow we go ahead and set the properties:\n\n        Object.defineProperties this, {\n            canvas:\n                value: canvas\n                enumerable: yes\n            context:\n                value: (canvas.getContext(context) if canvas)\n                enumerable: yes\n            height:\n                get: -> @canvas.height if @canvas\n                set: (n) -> @canvas.height = n if @canvas\n            ownerDocument: {value: doc}\n            width:\n                get: ->  @canvas.width if @canvas\n                set: (n) -> @canvas.width = n if @canvas\n        }\n\n###  The prototype:  ###\n\nThe `Screen` prototype is very simple, and just provides a few convenience functions for dealing with canvases.\n\n    Screen.prototype = Object.create(Object.prototype, {\n\nOur first function clears the canvas.\nIt supports both `\"2d\"` and `\"webgl\"` rendering contexts (but not `\"webgl2\"`, yet).\nIf the canvas isn't a canvas element, then this function does nothing.\n\n        clear:\n            value: ->\n                return unless @canvas instanceof HTMLCanvasElement\n                switch\n                    when @context instanceof CanvasRenderingContext2D then @context.clearRect(0, 0, @canvas.width, @canvas.height)\n                    when @context instanceof WebGLRenderingContext then @context.clear(@context.COLOR_BUFFER_BIT | context.DEPTH_BUFFER_BIT)\n                    else @canvas.width = @canvas.width\n                return\n\nRight now `clear()` is the only prototype function for `Screen`, but more may be added later.\nAgain, the `Screen` prototype is immutable, so we freeze it:\n\n    })\n\n    Object.freeze Screen.prototype\n\n###  Final touches:  ###\n\nWe want screen to be accessible to all the denizens out there, so we attach it to the window object.\nHowever, we don't want them extending the `Screen` constructor willy-nilly.\nSuch behaviours wouldn't break any of the above code, but it might mess with other scripts that expect `Screen` to only have certain properties defined.\nSo, to enforce this, we'll go ahead and freeze the whole thing:\n\n    @Screen = Object.freeze(Screen)\n\n\u2026And we're done!\nHappy screening!\n","old_contents":"#  SCREEN  #\nConvenient canvas and context packaging\n\n- - -\n\n##  Description  ##\n\nThe `Screen` module provides a convenient wrapper object for HTML `<canvas>`s.\n\n###  The `Screen` object:  ###\n\n####  The constructor  ####\n\n#####  SYNTAX  #####\n\n>   ```javascript\n>   new Screen(canvas, context);\n>   ```\n\n-   **`canvas`**\u2014\n    An `HTMLCanvasElement`, or the `id` of one.\n    Note that if an `id` is provided, it is assumed to belong to `window.document`.\n\n-   **`context`**\u2014\n    The string to pass to `canvas.getContext()`.\n    This defaults to `\"2d\"`.\n\n#####  PROPERTIES  #####\n\n-   **`Screen.prototype`**\u2014\n    The `Screen` prototype object.\n\n#####  METHODS  #####\n\nThe `Screen()` constructor does not have any methods.\n\n####  `Screen` instances  ####\n\n#####  PROPERTIES  #####\n\nIf no canvas has been defined, all of the following properties return `undefined`.\n\n-   **`scrn.canvas`**\u2014\n    The `HTMLCanvasElement` associated with the `Screen` instance.\n    **Read-only.**\n\n-   **`scrn.context`**\u2014\n    The rendering context associated with the `Screen` instance.\n    **Read-only.**\n\n-   **`scrn.height`, `scrn.width`**\u2014\n    The width and height of the canvas.\n\n-   **`scrn.ownerDocument`**\u2014\n    An alias for `scrn.canvas.ownerDocument`.\n    **Read-only.**\n\n#####  METHODS  #####\n\n-   **`Screen.prototype.clear()`**\u2014\n    Clears the canvas.\n    This uses `scrn.context.clearRect()` for `CanvasRenderingContext2D`s and `scrn.context.clear()` for `WebGLRenderingContext`s.\n    For other contexts (ie, as a fallback), it calls `scrn.canvas.width = scrn.canvas.width`, which is much slower and less efficient.\n\n###  Examples:  ###\n\n####  Setting up a 2D screen  ####\n\n>   ```html\n>   <!DOCTYPE html>\n>   <canvas id=\"canvas\"><\/canvas>\n>   <script type=\"text\/javascript\"\n>       scrn = new Screen(\"canvas\", \"2d\");  \/\/  The \"2d\" is optional.\n>   <\/script>\n\n##  Implementation  ##\n\n    \"use strict\";\n\n    ###\n    SCREEN\n    Convenient canvas and context packaging\n    ---------------------------------------\n    ###\n\n`Screen` is a very simple constructor.\nIts goal is to provide a simple means of accessing both the canvas and the context for an HTML canvas element.\n\n###  The constructor:  ###\n\nThe `Screen` constructor takes two arguments: `canvas`, of type `HTMLCanvasElement`, and `context`, which should be the string to pass to `canvas.getContext()`.\nThe former of these arguments can also be passed as a string, in which case Screen will call `document.getElementById` to find the element.\nThe latter of these arguments defaults to `\"2d\"`.\n\n    Screen = (canvas, context = \"2d\") ->\n\nFirst we handle the arguments.\nNote `doc` is used here to store the owner document, which is not assumed to be `document` (unless `canvas` is not an `HTMLCanvasElement`):\n\n        unless canvas instanceof HTMLCanvasElement\n            doc = document\n            canvas = doc.getElementById(canvas)\n            canvas = undefined unless canvas instanceof HTMLCanvasElement\n        else doc = canvas.ownerDocument\n\nNote in the above code that if no `HTMLCanvasElement` can be found, `canvas` is set to `undefined`.\n\nThe width and height of the canvas are accessible through `Screen` attributes, but require some special getters and setters in case the canvas isn't defined.\nNow we go ahead and set the properties:\n\n        Object.defineProperties this, {\n            canvas:\n                value: canvas\n                enumerable: yes\n            context:\n                value: (canvas.getContext(context) if canvas)\n                enumerable: yes\n            height:\n                get: -> @canvas.height if @canvas\n                set: (n) -> @canvas.height = n if @canvas\n            ownerDocument: {value: doc}\n            width:\n                get: ->  @canvas.width if @canvas\n                set: (n) -> @canvas.width = n if @canvas\n        }\n\n###  The prototype:  ###\n\nThe `Screen` prototype is very simple, and just provides a few convenience functions for dealing with canvases.\n\n    Screen.prototype = Object.create(Object.prototype, {\n\nOur first function clears the canvas.\nIt supports both `\"2d\"` and `\"webgl\"` rendering contexts (but not `\"webgl2\"`, yet).\nIf the canvas isn't a canvas element, then this function does nothing.\n\n        clear:\n            value: ->\n                return unless @canvas instanceof HTMLCanvasElement\n                switch\n                    when @context instanceof CanvasRenderingContext2D then @context.clearRect(0, 0, @canvas.width, @canvas.height)\n                    when @context instanceof WebGLRenderingContext then @context.clear(@context.COLOR_BUFFER_BIT | context.DEPTH_BUFFER_BIT)\n                    else @canvas.width = @canvas.width\n                return\n\nRight now `clear()` is the only prototype function for `Screen`, but more may be added later.\nAgain, the `Screen` prototype is immutable, so we freeze it:\n\n    })\n\n    Object.freeze Screen.prototype\n\n###  Final touches:  ###\n\nWe want screen to be accessible to all the denizens out there, so we attach it to the window object.\nHowever, we don't want them extending the `Screen` constructor willy-nilly.\nSuch behaviours wouldn't break any of the above code, but it might mess with other scripts that expect `Screen` to only have certain properties defined.\nSo, to enforce this, we'll go ahead and freeze the whole thing:\n\n    @Screen = Object.freeze(Screen)\n\n\u2026And we're done!\nHappy screening!\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e483707d69254a622db1dcba23a9aaa6756ed516","subject":"Fix #getfilter anchor link","message":"Fix #getfilter anchor link\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/cache.litcoffee","new_file":"coffee\/cache.litcoffee","new_contents":"We only use strict JavaScript in this shop.\n\n    \"use strict\"\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### ToDo\n\n* Handle undefined values.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      ObjectID = require('mongodb').ObjectID\n      require('.\/db\/mongo')[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      require('.\/db\/redis').hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      require('.\/db\/redis').hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getfilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      set       : set\n      get       : get\n      getDoc    : getDoc\n      setForType: setForType\n      getFilter : getFilter\n      filterData: filterData\n      getForType: getForType\n\n","old_contents":"We only use strict JavaScript in this shop.\n\n    \"use strict\"\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### ToDo\n\n* Handle undefined values.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      ObjectID = require('mongodb').ObjectID\n      require('.\/db\/mongo')[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      require('.\/db\/redis').hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      require('.\/db\/redis').hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      set       : set\n      get       : get\n      getDoc    : getDoc\n      setForType: setForType\n      getFilter : getFilter\n      filterData: filterData\n      getForType: getForType\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"50f40025e3fa332826fd315d8cc732161fe7738c","subject":"don't say the same thing twice","message":"don't say the same thing twice\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee `Model::validate` for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt takes a callback with two arguments: error and the array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## errors : ErrorsSet\n\nA record's errors are accessible with `get('errors')`, which returns a `Batman.Set` of `Batman.ValidationError`s.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## isNew() : boolean\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## toJSON() : Object\n\n## fromJSON() : Model\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## load(options = {}, callback)\n\n## save(options = {}, callback)\n\n## destroy(options = {}, callback)\n\n## validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (see `Model@validate` above). This method takes a callback with two arguments: any JavaScript error that occurs, then the `Batman.ErrorsSet` corresponding to the validation action.\nFor example:\n\n    asyncTest \"validate(callback) will call the callback only after all keys have been validated\", 4, ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      p = new Product\n      p.validate (js_error, validation_errors) ->\n        throw js_error if js_error\n        equal validation_errors.length, 2\n        equal p.get('errors.length'), 2\n        equal p.get('errors.name.length'), 1\n        equal p.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\nA `Batman.ValidationError` is a `Batman.Object`. It is initialized with an `attribute` and a `message`.  It also responds to `fullMessage`:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n\n# Batman.ErrorsSet\n\nA `Batman.ErrorsSet` is a `Batman.Set` populated with `Batman.ValidationErrors`.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n`Batman.ErrorsSet::add` is overridden for convenience. It takes an attribute name and a message, which it uses to\ncreate a new `Batman.ValidationError` then it adds that error to the `Batman.ErrorsSet`.\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee `Model::validate` for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt takes a callback with two arguments: error and the array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## errors : ErrorsSet\n\nA record's errors are accessible with `get('errors')`, which returns a `Batman.Set` of `Batman.ValidationError`s.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## isNew() : boolean\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## toJSON() : Object\n\n## fromJSON() : Model\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## load(options = {}, callback)\n\n## save(options = {}, callback)\n\n## destroy(options = {}, callback)\n\n## validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (see `Model@validate` above). Its callback takes two arguments:\n\n- Any JavaScript errors\n- A `Batman.ErrorsSet`\n\nThis method takes a callback with two arguments: any JavaScript error that occurs, then the `Batman.ErrorsSet` corresponding to the validation action.\nFor example:\n\n    asyncTest \"validate(callback) will call the callback only after all keys have been validated\", 4, ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      p = new Product\n      p.validate (js_error, validation_errors) ->\n        throw js_error if js_error\n        equal validation_errors.length, 2\n        equal p.get('errors.length'), 2\n        equal p.get('errors.name.length'), 1\n        equal p.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\nA `Batman.ValidationError` is a `Batman.Object`. It is initialized with an `attribute` and a `message`.  It also responds to `fullMessage`:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n\n# Batman.ErrorsSet\n\nA `Batman.ErrorsSet` is a `Batman.Set` populated with `Batman.ValidationErrors`.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n`Batman.ErrorsSet::add` is overridden for convenience. It takes an attribute name and a message, which it uses to\ncreate a new `Batman.ValidationError` then it adds that error to the `Batman.ErrorsSet`.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"395df87fdb0c701e48a73760a8649e1f3e8c0993","subject":"MOre litcoffee","message":"MOre litcoffee\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/policies.litcoffee","new_file":"guts\/policies.litcoffee","new_contents":"Policies\n--------\nThis is the glue-file that manages how user-policies (e.g. who's allowed to do what) get defined.  This file is responsible for grabbing the \n\nLoad in the required libraries\n\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n\nLoad up the user-defined policies. \n\n    policies = require '..\/config\/policies'\n\n\n\n    module.exports = (routeActions, req, res) ->\n        new Promise (resolve, reject) ->\n            require('.\/getPolicies')()\n            .then (actualPolicies) ->\n                policyResults = _.flatten _.map routeActions, (action) ->\n\nWhat I'm doing here is looking for the policies file.\nIf there is a policy defined for that action, use that, else use the * catch all. \n\n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\n                        _.map tempPolicies, (policy) ->\n                            # This is pretty straightforward; we'll loop up the policy in the hash\n                            # table and then return back their result (which can just be a true or false\n                            #\n                            # We want to make sure this is properly wrapped in promisey stuff, so we can init\n                            # an empty promise then run our stuff in the \"then\". Since our empty promise only\n                            # resolves, it won't hit the catch. \n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n                \n                Promise.all policyResults\n            .then (results) ->\n                # Not entirely sure I like this logic, but it's pretty straightforward:\n                # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                # either allow the policy to reject if not permitted or to simply return false. \n                unless false in results\n                  resolve true\n                else\n                  reject \"Not Authorized\"\n                \n","old_contents":"Load in the libraries\n\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n\nLoad up the user-defined policies. \n\n    policies = require '..\/config\/policies'\n\n\n    module.exports = (routeActions, req, res) ->\n        new Promise (resolve, reject) ->\n            require('.\/getPolicies')()\n            .then (actualPolicies) ->\n                policyResults = _.flatten _.map routeActions, (action) ->\n                        # What I'm doing here is looking for the policies file.\n                        # If there is a policy defined for that action, use that, else use the * catch all. \n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\n                        _.map tempPolicies, (policy) ->\n                            # This is pretty straightforward; we'll loop up the policy in the hash\n                            # table and then return back their result (which can just be a true or false\n                            #\n                            # We want to make sure this is properly wrapped in promisey stuff, so we can init\n                            # an empty promise then run our stuff in the \"then\". Since our empty promise only\n                            # resolves, it won't hit the catch. \n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n                \n                Promise.all policyResults\n            .then (results) ->\n                # Not entirely sure I like this logic, but it's pretty straightforward:\n                # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                # either allow the policy to reject if not permitted or to simply return false. \n                unless false in results\n                  resolve true\n                else\n                  reject \"Not Authorized\"\n                \n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"58844ad618cc85bdb124dbc4b00ea497481c92ec","subject":"error handling","message":"error handling\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        console.error 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      console.error msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options) ->\n      @errorCallback 'AJAX cannot respond', data\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onerror: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        console.error 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n     errorCallback: (msg, options) ->\n      console.error msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       throw new Error \"Unknown method: #{data.method}\"\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      if @callsCache[data.id].handle data.data, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      throw new Error \"Poll not implemented\"\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @onerror.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onerror 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onerror 'Cannot connect to server'\n\n     _respond: (data, options) ->\n      throw new Error 'AJAX cannot respond'\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onerror 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e, data\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       throw new Error \"Poll without response: #{data.id}\"\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"df78d6990665095baf14e0b36b9b3dc0244b05ea","subject":"rollback but still log error","message":"rollback but still log error\n","repos":"MetaMemoryT\/websql-client,MetaMemoryT\/websql-client","old_file":"src\/websql-client.litcoffee","new_file":"src\/websql-client.litcoffee","new_contents":"# WebSQL Client\r\n\r\n# Top-level SQLitePlugin objects\r\n\r\n## root window object:\r\n\r\n    root = @\r\n\r\n## constant(s):\r\n\r\n    READ_ONLY_REGEX = \/^\\s*(?:drop|delete|insert|update|create)\\s\/i\r\n\r\n## global(s):\r\n\r\n    txLocks = {}\r\n\r\n## utility functions:\r\n\r\n    nextTick = window.setImmediate || (fun) ->\r\n      window.setTimeout(fun, 0)\r\n      return\r\n\r\n    ###\r\n      Utility that avoids leaking the arguments object. See\r\n      https:\/\/www.npmjs.org\/package\/argsarray\r\n    ###\r\n    argsArray = (fun) ->\r\n      return ->\r\n        len = arguments.length\r\n        if len\r\n          args = []\r\n          i = -1\r\n          while ++i < len\r\n            args[i] = arguments[i]\r\n          return fun.call this, args\r\n        else\r\n          return fun.call this, []\r\n\r\n## SQLitePlugin db-connection\r\n\r\n#### SQLitePlugin object\r\n\r\n    SQLitePlugin = (openargs, openSuccess, openError, primusAdaptor) ->\r\n      console.log \"SQLitePlugin openargs: #{JSON.stringify openargs}\"\r\n\r\n      if !(openargs and openargs['name'])\r\n        throw new Error(\"Cannot create a SQLitePlugin\" +\r\n                        \"instance without a db name\")\r\n\r\n      dbname = openargs.name\r\n\r\n      @primusAdaptor = primusAdaptor\r\n      @openargs = openargs\r\n      @dbname = dbname\r\n\r\n      @openSuccess = openSuccess\r\n      @openError = openError\r\n\r\n      unless @openSuccess\r\n        @openSuccess = ->\r\n          console.log \"DB opened: \" + dbname\r\n          return\r\n\r\n      unless @openError\r\n        @openError = (e) ->\r\n          console.log e.message\r\n          return\r\n\r\n      @open @openSuccess, @openError\r\n      return\r\n\r\n    SQLitePlugin::databaseFeatures = isSQLitePluginDatabase: true\r\n    SQLitePlugin::openDBs = {}\r\n\r\n    SQLitePlugin::addTransaction = (t) ->\r\n\r\n      if !txLocks[@dbname]\r\n        txLocks[@dbname] = {\r\n          queue: []\r\n          inProgress: false\r\n        }\r\n      txLocks[@dbname].queue.push t\r\n      @startNextTransaction()\r\n      return\r\n\r\n    SQLitePlugin::transaction = (fn, error, success) ->\r\n      if !@openDBs[@dbname]\r\n        error('database not open')\r\n        return\r\n      @addTransaction new\r\n        SQLitePluginTransaction(this, fn, error, success,\r\n            true, false, @primusAdaptor)\r\n      return\r\n\r\n    SQLitePlugin::readTransaction = (fn, error, success) ->\r\n      if !@openDBs[@dbname]\r\n        error('database not open')\r\n        return\r\n      @addTransaction new\r\n        SQLitePluginTransaction(this, fn, error, success,\r\n          true, true, @primusAdaptor)\r\n      return\r\n\r\n    SQLitePlugin::startNextTransaction = ->\r\n      self = @\r\n\r\n      nextTick () ->\r\n        txLock = txLocks[self.dbname]\r\n        if txLock.queue.length > 0 && !txLock.inProgress\r\n          txLock.inProgress = true\r\n          txLock.queue.shift().start()\r\n        return\r\n      return\r\n\r\n    SQLitePlugin::open = (success, error) ->\r\n      onSuccess = () => success this\r\n      unless @dbname of @openDBs\r\n        @openDBs[@dbname] = true\r\n        @primusAdaptor.open onSuccess, error, [ @openargs ]\r\n      else\r\n        ###\r\n        for a re-open run onSuccess async so that the openDatabase return value\r\n        can be used in the success handler as an alternative to the handler's\r\n        db argument\r\n        ###\r\n        nextTick () -> onSuccess();\r\n      return\r\n\r\n    SQLitePlugin::close = (success, error) ->\r\n      #console.log \"SQLitePlugin.prototype.close\"\r\n\r\n      if @dbname of @openDBs\r\n        if txLocks[@dbname] && txLocks[@dbname].inProgress\r\n          error(new Error('database cannot be closed ' +\r\n                          'while a transaction is in progress'))\r\n          return\r\n\r\n        delete @openDBs[@dbname]\r\n\r\n        @primusAdaptor.close success, error, [ { path: @dbname } ]\r\n\r\n      return\r\n\r\n    SQLitePlugin::executeSql = (statement, params, success, error) ->\r\n      mysuccess = (t, r) -> if !!success then success r\r\n      myerror = (t, e) -> if !!error then error e\r\n\r\n      myfn = (tx) ->\r\n        tx.executeSql(statement, params, mysuccess, myerror)\r\n        return\r\n\r\n      @addTransaction new SQLitePluginTransaction(this, myfn, null, null,\r\n         false, false, @primusAdaptor)\r\n      return\r\n\r\n## SQLitePluginTransaction object for batching:\r\n\r\n    ###\r\n    Transaction batching object:\r\n    ###\r\n    SQLitePluginTransaction = (db, fn, error, success,\r\n                              txlock, readOnly, primusAdaptor) ->\r\n      if typeof(fn) != \"function\"\r\n        ###\r\n        This is consistent with the implementation in Chrome -- it\r\n        throws if you pass anything other than a function. This also\r\n        prevents us from stalling our txQueue if somebody passes a\r\n        false value for fn.\r\n        ###\r\n        throw new Error(\"transaction expected a function\")\r\n\r\n      @primusAdaptor = primusAdaptor\r\n      @db = db\r\n      @fn = fn\r\n      @error = error\r\n      @success = success\r\n      @txlock = txlock\r\n      @readOnly = readOnly\r\n      @executes = []\r\n\r\n      if txlock\r\n        @executeSql \"BEGIN\", [], null, (tx, err) ->\r\n          throw new Error(\"unable to begin transaction: \" + err.message)\r\n\r\n      return\r\n\r\n    SQLitePluginTransaction::start = ->\r\n      try\r\n        @fn this\r\n        @run()\r\n      catch err\r\n        ###\r\n        If \"fn\" throws, we must report the whole transaction as failed.\r\n        ###\r\n        txLocks[@db.dbname].inProgress = false\r\n        @db.startNextTransaction()\r\n        if @error\r\n          @error err\r\n      return\r\n\r\n    SQLitePluginTransaction::executeSql = (sql, values, success, error) ->\r\n\r\n      if @readOnly && READ_ONLY_REGEX.test(sql)\r\n        @handleStatementFailure(error,\r\n          {message: 'invalid sql for a read-only transaction'})\r\n        return\r\n\r\n\r\n      qid = @executes.length\r\n\r\n      @executes.push\r\n        success: success\r\n        error: error\r\n        qid: qid\r\n\r\n        sql: sql\r\n        params: values || []\r\n\r\n      return\r\n\r\n    SQLitePluginTransaction::handleStatementSuccess = (handler, response) ->\r\n      if !handler\r\n        return\r\n\r\n      rows = response.rows || []\r\n      payload =\r\n        rows:\r\n          item: (i) ->\r\n            rows[i]\r\n\r\n          length: rows.length\r\n\r\n        rowsAffected: response.rowsAffected or 0\r\n        insertId: response.insertId or undefined\r\n\r\n      handler this, payload\r\n\r\n      return\r\n\r\n    SQLitePluginTransaction::handleStatementFailure = (handler, response) ->\r\n      if !handler\r\n        throw new Error \"a statement with no error handler failed: \" +\r\n          response.message\r\n      if handler(this, response)\r\n        throw new Error \"a statement error callback did not return false\"\r\n      return\r\n\r\n    SQLitePluginTransaction::run = ->\r\n      txFailure = null\r\n\r\n      tropts = []\r\n      batchExecutes = @executes\r\n      waiting = batchExecutes.length\r\n      @executes = []\r\n      tx = this\r\n\r\n      handlerFor = (index, didSucceed) ->\r\n        (response) ->\r\n          try\r\n            if didSucceed\r\n              tx.handleStatementSuccess batchExecutes[index].success, response\r\n            else\r\n              tx.handleStatementFailure batchExecutes[index].error, response\r\n          catch err\r\n            txFailure = err  unless txFailure\r\n\r\n          if --waiting == 0\r\n            if txFailure\r\n              tx.abort txFailure\r\n            else if tx.executes.length > 0\r\n              ###\r\n              new requests have been issued by the callback\r\n              handlers, so run another batch.\r\n              ###\r\n              tx.run()\r\n            else\r\n              tx.finish()\r\n\r\n          return\r\n\r\n      i = 0\r\n\r\n      mycbmap = {}\r\n\r\n      while i < batchExecutes.length\r\n        request = batchExecutes[i]\r\n\r\n        qid = request.qid\r\n\r\n        mycbmap[qid] =\r\n          success: handlerFor(i, true)\r\n          error: handlerFor(i, false)\r\n\r\n        tropts.push\r\n          qid: qid\r\n          sql: request.sql\r\n          params: request.params\r\n\r\n        i++\r\n\r\n      mycb = (result) ->\r\n        #console.log \"mycb result #{JSON.stringify result}\"\r\n\r\n        for r in result\r\n          type = r.type\r\n          qid = r.qid\r\n          res = r.result\r\n\r\n          q = mycbmap[qid]\r\n\r\n          if q\r\n            if q[type]\r\n              q[type] res\r\n\r\n        return\r\n\r\n      errcb = (err) =>\r\n        @error = (err) -> console.warn err\r\n        @abort(new Error(err))\r\n\r\n      @primusAdaptor.backgroundExecuteSqlBatch mycb,\r\n        errcb, [{dbargs: {dbname: @db.dbname}, executes: tropts}]\r\n\r\n      return\r\n\r\n    SQLitePluginTransaction::abort = (txFailure) ->\r\n      if @finalized then return\r\n      tx = @\r\n\r\n      succeeded = (tx) ->\r\n        txLocks[tx.db.dbname].inProgress = false\r\n        tx.db.startNextTransaction()\r\n        if tx.error then tx.error txFailure\r\n        return\r\n\r\n      failed = (tx, err) ->\r\n        txLocks[tx.db.dbname].inProgress = false\r\n        tx.db.startNextTransaction()\r\n        if tx.error\r\n          tx.error new Error(\"error while trying to roll back: \" + err.message)\r\n        return\r\n\r\n      @finalized = true\r\n\r\n      if @txlock\r\n        @executeSql \"ROLLBACK\", [], succeeded, failed\r\n        @run()\r\n      else\r\n        succeeded(tx)\r\n\r\n      return\r\n\r\n    SQLitePluginTransaction::finish = ->\r\n      if @finalized then return\r\n      tx = @\r\n\r\n      succeeded = (tx) ->\r\n        txLocks[tx.db.dbname].inProgress = false\r\n        tx.db.startNextTransaction()\r\n        if tx.success then tx.success()\r\n        return\r\n\r\n      failed = (tx, err) ->\r\n        txLocks[tx.db.dbname].inProgress = false\r\n        tx.db.startNextTransaction()\r\n        if tx.error\r\n          tx.error new Error(\"error while trying to commit: \" + err.message)\r\n        return\r\n\r\n      @finalized = true\r\n\r\n      if @txlock\r\n        @executeSql \"COMMIT\", [], succeeded, failed\r\n        @run()\r\n      else\r\n        succeeded(tx)\r\n\r\n      return\r\n\r\n## PrimusAdaptor class\r\n\r\n    class PrimusAdaptor\r\n      constructor: ->\r\n        @primus = Primus.connect('http:\/\/localhost:8082')\r\n        @id = 0 # command id\r\n        @cblist = []\r\n        self = @\r\n        @primus.on('data', (data) -> return self.onData(data))\r\n\r\n      onData: (data) ->\r\n        switch data.command\r\n          when 'openComplete'\r\n            if data.err\r\n              @cblist[data.id].e(data.err, data.databaseID)\r\n            else\r\n              @cblist[data.id].s(data.err, data.databaseID)\r\n            delete @cblist[data.id]\r\n          when 'backgroundExecuteSqlBatchFailed'\r\n            @cblist[data.id].e(data.err, data.databaseID)\r\n          when 'backgroundExecuteSqlBatchComplete'\r\n            @cblist[data.id].s(data.answer)\r\n\r\n      open: (onSuccess, onError, args) ->\r\n        @cblist[@id] = {\r\n          s: onSuccess,\r\n          e: onError\r\n        }\r\n        @primus.write({\r\n          command: 'open',\r\n          args: args,\r\n          id: @id++\r\n        })\r\n\r\n      close: (onSuccess, onError, args) ->\r\n        @cblist[@id] = {\r\n          s: onSuccess,\r\n          e: onError\r\n        }\r\n        @primus.write({\r\n          command: 'close',\r\n          path: args[0].path,\r\n          args: args,\r\n          id: @id++\r\n        })\r\n\r\n      delete: (onSuccess, onError, args) ->\r\n        @cblist[@id] = {\r\n          s: onSuccess,\r\n          e: onError\r\n        }\r\n        @primus.write({\r\n          command: 'delete',\r\n          args: args,\r\n          id: @id++\r\n        })\r\n\r\n      backgroundExecuteSqlBatch: (onSuccess, onError, args) ->\r\n        @cblist[@id] = {\r\n          s: onSuccess,\r\n          e: onError\r\n        }\r\n        @primus.write({\r\n          command: 'backgroundExecuteSqlBatch',\r\n          args: args,\r\n          id: @id++\r\n        })\r\n\r\n## SQLite plugin object factory:\r\n\r\n    dblocations = [ \"docs\", \"libs\", \"nosync\" ]\r\n\r\n    SQLiteFactory =\r\n      primusAdaptor: null\r\n      ###\r\n      NOTE: this function should NOT be translated from Javascript\r\n      back to CoffeeScript by js2coffee.\r\n      If this function is edited in Javascript then someone will\r\n      have to translate it back to CoffeeScript by hand.\r\n      ###\r\n      opendb: argsArray (args) ->\r\n        if args.length < 1 then return null\r\n\r\n        unless primusAdaptor\r\n          primusAdaptor = new PrimusAdaptor()\r\n\r\n        first = args[0]\r\n        openargs = null\r\n        okcb = null\r\n        errorcb = null\r\n\r\n        if first.constructor == String\r\n          openargs = {name: first}\r\n\r\n          if args.length >= 5\r\n            okcb = args[4]\r\n            if args.length > 5 then errorcb = args[5]\r\n\r\n        else\r\n          openargs = first\r\n\r\n          if args.length >= 2\r\n            okcb = args[1]\r\n            if args.length > 2 then errorcb = args[2]\r\n\r\n        if openargs.location\r\n          dblocation = dblocations[openargs.location]\r\n        openargs.dblocation = dblocation || dblocations[0]\r\n\r\n        if !!openargs.createFromLocation and openargs.createFromLocation == 1\r\n          openargs.createFromResource = \"1\"\r\n\r\n        new SQLitePlugin openargs, okcb, errorcb, primusAdaptor\r\n\r\n      deleteDb: (first, success, error) ->\r\n        args = {}\r\n\r\n        if first.constructor == String\r\n          #console.log \"delete db name: #{first}\"\r\n          args.path = first\r\n          args.dblocation = dblocations[0]\r\n\r\n        else\r\n          #console.log \"delete db args: #{JSON.stringify first}\"\r\n          if !(first and first['name'])\r\n            throw new Error(\"Please specify db name\")\r\n          args.path = first.name\r\n          if first.location\r\n            dblocation = dblocations[first.location]\r\n          args.dblocation = dblocation || dblocations[0]\r\n\r\n        delete SQLitePlugin::openDBs[args.path]\r\n        @primusAdaptor.delete success, error, [ args ]\r\n\r\n## Exported API:\r\n\r\n    root.sqlitePlugin =\r\n      sqliteFeatures:\r\n        isSQLitePlugin: true\r\n\r\n      openDatabase: SQLiteFactory.opendb\r\n      deleteDatabase: SQLiteFactory.deleteDb\r\n","old_contents":"# WebSQL Client\r\n\r\n# Top-level SQLitePlugin objects\r\n\r\n## root window object:\r\n\r\n    root = @\r\n\r\n## constant(s):\r\n\r\n    READ_ONLY_REGEX = \/^\\s*(?:drop|delete|insert|update|create)\\s\/i\r\n\r\n## global(s):\r\n\r\n    txLocks = {}\r\n\r\n## utility functions:\r\n\r\n    nextTick = window.setImmediate || (fun) ->\r\n      window.setTimeout(fun, 0)\r\n      return\r\n\r\n    ###\r\n      Utility that avoids leaking the arguments object. See\r\n      https:\/\/www.npmjs.org\/package\/argsarray\r\n    ###\r\n    argsArray = (fun) ->\r\n      return ->\r\n        len = arguments.length\r\n        if len\r\n          args = []\r\n          i = -1\r\n          while ++i < len\r\n            args[i] = arguments[i]\r\n          return fun.call this, args\r\n        else\r\n          return fun.call this, []\r\n\r\n## SQLitePlugin db-connection\r\n\r\n#### SQLitePlugin object\r\n\r\n    SQLitePlugin = (openargs, openSuccess, openError, primusAdaptor) ->\r\n      console.log \"SQLitePlugin openargs: #{JSON.stringify openargs}\"\r\n\r\n      if !(openargs and openargs['name'])\r\n        throw new Error(\"Cannot create a SQLitePlugin\" +\r\n                        \"instance without a db name\")\r\n\r\n      dbname = openargs.name\r\n\r\n      @primusAdaptor = primusAdaptor\r\n      @openargs = openargs\r\n      @dbname = dbname\r\n\r\n      @openSuccess = openSuccess\r\n      @openError = openError\r\n\r\n      unless @openSuccess\r\n        @openSuccess = ->\r\n          console.log \"DB opened: \" + dbname\r\n          return\r\n\r\n      unless @openError\r\n        @openError = (e) ->\r\n          console.log e.message\r\n          return\r\n\r\n      @open @openSuccess, @openError\r\n      return\r\n\r\n    SQLitePlugin::databaseFeatures = isSQLitePluginDatabase: true\r\n    SQLitePlugin::openDBs = {}\r\n\r\n    SQLitePlugin::addTransaction = (t) ->\r\n\r\n      if !txLocks[@dbname]\r\n        txLocks[@dbname] = {\r\n          queue: []\r\n          inProgress: false\r\n        }\r\n      txLocks[@dbname].queue.push t\r\n      @startNextTransaction()\r\n      return\r\n\r\n    SQLitePlugin::transaction = (fn, error, success) ->\r\n      if !@openDBs[@dbname]\r\n        error('database not open')\r\n        return\r\n      @addTransaction new\r\n        SQLitePluginTransaction(this, fn, error, success,\r\n            true, false, @primusAdaptor)\r\n      return\r\n\r\n    SQLitePlugin::readTransaction = (fn, error, success) ->\r\n      if !@openDBs[@dbname]\r\n        error('database not open')\r\n        return\r\n      @addTransaction new\r\n        SQLitePluginTransaction(this, fn, error, success,\r\n          true, true, @primusAdaptor)\r\n      return\r\n\r\n    SQLitePlugin::startNextTransaction = ->\r\n      self = @\r\n\r\n      nextTick () ->\r\n        txLock = txLocks[self.dbname]\r\n        if txLock.queue.length > 0 && !txLock.inProgress\r\n          txLock.inProgress = true\r\n          txLock.queue.shift().start()\r\n        return\r\n      return\r\n\r\n    SQLitePlugin::open = (success, error) ->\r\n      onSuccess = () => success this\r\n      unless @dbname of @openDBs\r\n        @openDBs[@dbname] = true\r\n        @primusAdaptor.open onSuccess, error, [ @openargs ]\r\n      else\r\n        ###\r\n        for a re-open run onSuccess async so that the openDatabase return value\r\n        can be used in the success handler as an alternative to the handler's\r\n        db argument\r\n        ###\r\n        nextTick () -> onSuccess();\r\n      return\r\n\r\n    SQLitePlugin::close = (success, error) ->\r\n      #console.log \"SQLitePlugin.prototype.close\"\r\n\r\n      if @dbname of @openDBs\r\n        if txLocks[@dbname] && txLocks[@dbname].inProgress\r\n          error(new Error('database cannot be closed ' +\r\n                          'while a transaction is in progress'))\r\n          return\r\n\r\n        delete @openDBs[@dbname]\r\n\r\n        @primusAdaptor.close success, error, [ { path: @dbname } ]\r\n\r\n      return\r\n\r\n    SQLitePlugin::executeSql = (statement, params, success, error) ->\r\n      mysuccess = (t, r) -> if !!success then success r\r\n      myerror = (t, e) -> if !!error then error e\r\n\r\n      myfn = (tx) ->\r\n        tx.executeSql(statement, params, mysuccess, myerror)\r\n        return\r\n\r\n      @addTransaction new SQLitePluginTransaction(this, myfn, null, null,\r\n         false, false, @primusAdaptor)\r\n      return\r\n\r\n## SQLitePluginTransaction object for batching:\r\n\r\n    ###\r\n    Transaction batching object:\r\n    ###\r\n    SQLitePluginTransaction = (db, fn, error, success,\r\n                              txlock, readOnly, primusAdaptor) ->\r\n      if typeof(fn) != \"function\"\r\n        ###\r\n        This is consistent with the implementation in Chrome -- it\r\n        throws if you pass anything other than a function. This also\r\n        prevents us from stalling our txQueue if somebody passes a\r\n        false value for fn.\r\n        ###\r\n        throw new Error(\"transaction expected a function\")\r\n\r\n      @primusAdaptor = primusAdaptor\r\n      @db = db\r\n      @fn = fn\r\n      @error = error\r\n      @success = success\r\n      @txlock = txlock\r\n      @readOnly = readOnly\r\n      @executes = []\r\n\r\n      if txlock\r\n        @executeSql \"BEGIN\", [], null, (tx, err) ->\r\n          throw new Error(\"unable to begin transaction: \" + err.message)\r\n\r\n      return\r\n\r\n    SQLitePluginTransaction::start = ->\r\n      try\r\n        @fn this\r\n        @run()\r\n      catch err\r\n        ###\r\n        If \"fn\" throws, we must report the whole transaction as failed.\r\n        ###\r\n        txLocks[@db.dbname].inProgress = false\r\n        @db.startNextTransaction()\r\n        if @error\r\n          @error err\r\n      return\r\n\r\n    SQLitePluginTransaction::executeSql = (sql, values, success, error) ->\r\n\r\n      if @readOnly && READ_ONLY_REGEX.test(sql)\r\n        @handleStatementFailure(error,\r\n          {message: 'invalid sql for a read-only transaction'})\r\n        return\r\n\r\n\r\n      qid = @executes.length\r\n\r\n      @executes.push\r\n        success: success\r\n        error: error\r\n        qid: qid\r\n\r\n        sql: sql\r\n        params: values || []\r\n\r\n      return\r\n\r\n    SQLitePluginTransaction::handleStatementSuccess = (handler, response) ->\r\n      if !handler\r\n        return\r\n\r\n      rows = response.rows || []\r\n      payload =\r\n        rows:\r\n          item: (i) ->\r\n            rows[i]\r\n\r\n          length: rows.length\r\n\r\n        rowsAffected: response.rowsAffected or 0\r\n        insertId: response.insertId or undefined\r\n\r\n      handler this, payload\r\n\r\n      return\r\n\r\n    SQLitePluginTransaction::handleStatementFailure = (handler, response) ->\r\n      if !handler\r\n        throw new Error \"a statement with no error handler failed: \" +\r\n          response.message\r\n      if handler(this, response)\r\n        throw new Error \"a statement error callback did not return false\"\r\n      return\r\n\r\n    SQLitePluginTransaction::run = ->\r\n      txFailure = null\r\n\r\n      tropts = []\r\n      batchExecutes = @executes\r\n      waiting = batchExecutes.length\r\n      @executes = []\r\n      tx = this\r\n\r\n      handlerFor = (index, didSucceed) ->\r\n        (response) ->\r\n          try\r\n            if didSucceed\r\n              tx.handleStatementSuccess batchExecutes[index].success, response\r\n            else\r\n              tx.handleStatementFailure batchExecutes[index].error, response\r\n          catch err\r\n            txFailure = err  unless txFailure\r\n\r\n          if --waiting == 0\r\n            if txFailure\r\n              tx.abort txFailure\r\n            else if tx.executes.length > 0\r\n              ###\r\n              new requests have been issued by the callback\r\n              handlers, so run another batch.\r\n              ###\r\n              tx.run()\r\n            else\r\n              tx.finish()\r\n\r\n          return\r\n\r\n      i = 0\r\n\r\n      mycbmap = {}\r\n\r\n      while i < batchExecutes.length\r\n        request = batchExecutes[i]\r\n\r\n        qid = request.qid\r\n\r\n        mycbmap[qid] =\r\n          success: handlerFor(i, true)\r\n          error: handlerFor(i, false)\r\n\r\n        tropts.push\r\n          qid: qid\r\n          sql: request.sql\r\n          params: request.params\r\n\r\n        i++\r\n\r\n      mycb = (result) ->\r\n        #console.log \"mycb result #{JSON.stringify result}\"\r\n\r\n        for r in result\r\n          type = r.type\r\n          qid = r.qid\r\n          res = r.result\r\n\r\n          q = mycbmap[qid]\r\n\r\n          if q\r\n            if q[type]\r\n              q[type] res\r\n\r\n        return\r\n\r\n      errcb = (err) ->\r\n        throw new Error(err)\r\n\r\n      @primusAdaptor.backgroundExecuteSqlBatch mycb,\r\n        errcb, [{dbargs: {dbname: @db.dbname}, executes: tropts}]\r\n\r\n      return\r\n\r\n    SQLitePluginTransaction::abort = (txFailure) ->\r\n      if @finalized then return\r\n      tx = @\r\n\r\n      succeeded = (tx) ->\r\n        txLocks[tx.db.dbname].inProgress = false\r\n        tx.db.startNextTransaction()\r\n        if tx.error then tx.error txFailure\r\n        return\r\n\r\n      failed = (tx, err) ->\r\n        txLocks[tx.db.dbname].inProgress = false\r\n        tx.db.startNextTransaction()\r\n        if tx.error\r\n          tx.error new Error(\"error while trying to roll back: \" + err.message)\r\n        return\r\n\r\n      @finalized = true\r\n\r\n      if @txlock\r\n        @executeSql \"ROLLBACK\", [], succeeded, failed\r\n        @run()\r\n      else\r\n        succeeded(tx)\r\n\r\n      return\r\n\r\n    SQLitePluginTransaction::finish = ->\r\n      if @finalized then return\r\n      tx = @\r\n\r\n      succeeded = (tx) ->\r\n        txLocks[tx.db.dbname].inProgress = false\r\n        tx.db.startNextTransaction()\r\n        if tx.success then tx.success()\r\n        return\r\n\r\n      failed = (tx, err) ->\r\n        txLocks[tx.db.dbname].inProgress = false\r\n        tx.db.startNextTransaction()\r\n        if tx.error\r\n          tx.error new Error(\"error while trying to commit: \" + err.message)\r\n        return\r\n\r\n      @finalized = true\r\n\r\n      if @txlock\r\n        @executeSql \"COMMIT\", [], succeeded, failed\r\n        @run()\r\n      else\r\n        succeeded(tx)\r\n\r\n      return\r\n\r\n## PrimusAdaptor class\r\n\r\n    class PrimusAdaptor\r\n      constructor: ->\r\n        @primus = Primus.connect('http:\/\/localhost:8082')\r\n        @id = 0 # command id\r\n        @cblist = []\r\n        self = @\r\n        @primus.on('data', (data) -> return self.onData(data))\r\n\r\n      onData: (data) ->\r\n        switch data.command\r\n          when 'openComplete'\r\n            if data.err\r\n              @cblist[data.id].e(data.err, data.databaseID)\r\n            else\r\n              @cblist[data.id].s(data.err, data.databaseID)\r\n            delete @cblist[data.id]\r\n          when 'backgroundExecuteSqlBatchFailed'\r\n            @cblist[data.id].e(data.err, data.databaseID)\r\n          when 'backgroundExecuteSqlBatchComplete'\r\n            @cblist[data.id].s(data.answer)\r\n\r\n      open: (onSuccess, onError, args) ->\r\n        @cblist[@id] = {\r\n          s: onSuccess,\r\n          e: onError\r\n        }\r\n        @primus.write({\r\n          command: 'open',\r\n          args: args,\r\n          id: @id++\r\n        })\r\n\r\n      close: (onSuccess, onError, args) ->\r\n        @cblist[@id] = {\r\n          s: onSuccess,\r\n          e: onError\r\n        }\r\n        @primus.write({\r\n          command: 'close',\r\n          path: args[0].path,\r\n          args: args,\r\n          id: @id++\r\n        })\r\n\r\n      delete: (onSuccess, onError, args) ->\r\n        @cblist[@id] = {\r\n          s: onSuccess,\r\n          e: onError\r\n        }\r\n        @primus.write({\r\n          command: 'delete',\r\n          args: args,\r\n          id: @id++\r\n        })\r\n\r\n      backgroundExecuteSqlBatch: (onSuccess, onError, args) ->\r\n        @cblist[@id] = {\r\n          s: onSuccess,\r\n          e: onError\r\n        }\r\n        @primus.write({\r\n          command: 'backgroundExecuteSqlBatch',\r\n          args: args,\r\n          id: @id++\r\n        })\r\n\r\n## SQLite plugin object factory:\r\n\r\n    dblocations = [ \"docs\", \"libs\", \"nosync\" ]\r\n\r\n    SQLiteFactory =\r\n      primusAdaptor: null\r\n      ###\r\n      NOTE: this function should NOT be translated from Javascript\r\n      back to CoffeeScript by js2coffee.\r\n      If this function is edited in Javascript then someone will\r\n      have to translate it back to CoffeeScript by hand.\r\n      ###\r\n      opendb: argsArray (args) ->\r\n        if args.length < 1 then return null\r\n\r\n        unless primusAdaptor\r\n          primusAdaptor = new PrimusAdaptor()\r\n\r\n        first = args[0]\r\n        openargs = null\r\n        okcb = null\r\n        errorcb = null\r\n\r\n        if first.constructor == String\r\n          openargs = {name: first}\r\n\r\n          if args.length >= 5\r\n            okcb = args[4]\r\n            if args.length > 5 then errorcb = args[5]\r\n\r\n        else\r\n          openargs = first\r\n\r\n          if args.length >= 2\r\n            okcb = args[1]\r\n            if args.length > 2 then errorcb = args[2]\r\n\r\n        if openargs.location\r\n          dblocation = dblocations[openargs.location]\r\n        openargs.dblocation = dblocation || dblocations[0]\r\n\r\n        if !!openargs.createFromLocation and openargs.createFromLocation == 1\r\n          openargs.createFromResource = \"1\"\r\n\r\n        new SQLitePlugin openargs, okcb, errorcb, primusAdaptor\r\n\r\n      deleteDb: (first, success, error) ->\r\n        args = {}\r\n\r\n        if first.constructor == String\r\n          #console.log \"delete db name: #{first}\"\r\n          args.path = first\r\n          args.dblocation = dblocations[0]\r\n\r\n        else\r\n          #console.log \"delete db args: #{JSON.stringify first}\"\r\n          if !(first and first['name'])\r\n            throw new Error(\"Please specify db name\")\r\n          args.path = first.name\r\n          if first.location\r\n            dblocation = dblocations[first.location]\r\n          args.dblocation = dblocation || dblocations[0]\r\n\r\n        delete SQLitePlugin::openDBs[args.path]\r\n        @primusAdaptor.delete success, error, [ args ]\r\n\r\n## Exported API:\r\n\r\n    root.sqlitePlugin =\r\n      sqliteFeatures:\r\n        isSQLitePlugin: true\r\n\r\n      openDatabase: SQLiteFactory.opendb\r\n      deleteDatabase: SQLiteFactory.deleteDb\r\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f9d4d5682da86178e71d0f16c4dcbee359700885","subject":"Let's make it a bit more markdowney","message":"Let's make it a bit more markdowney\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"app.litcoffee","new_file":"app.litcoffee","new_contents":"Kickstart File\n--------------\nThis file is responsible for starting up the entire server. \n\nLets start by initializing our basic express stuff.\n\n    express = require 'express'\n    app = express()\n\n\nWe need to set a default \"views\" directory. `\/views` makes sense.\n\n    app.set 'views', __dirname + '\/views'\n\nRight now, jade templates are the default.\n\n    app.set 'view engine', 'jade'\n\nLet's set the `\/public` directory to be the only public directory for assets\n\n    app.use(express.static(__dirname + '\/public'))\n\nThis is our route-mapper, which is responsible for acting as \"glue\" between the routes and the controllers. \n\n    require('.\/guts\/routing')(app)\n\nWe will listen on the port `3000`.\n\n    app.listen(3000)\n","old_contents":"Kickstart File\n--------------\nThis file is responsible for starting up the entire server. \n\nLets start by initializing our basic express stuff.\n\n    express = require 'express'\n    app = express()\n\n\nWe need to set a default \"views\" directory. \"\/views\" makes sense.\n\n    app.set 'views', __dirname + '\/views'\n\nRight now, jade templates are the default.\n\n    app.set 'view engine', 'jade'\n\nLet's set the \/public directory to be the only public directory for assets\n\n    app.use(express.static(__dirname + '\/public'))\n\nThis is our route-mapper\n\n    require('.\/guts\/routing')(app)\n\nWe will listen on the port 3000.\n\n    app.listen(3000)\n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"402c66f7a2e4325667e6c1508079b480e7498c4c","subject":"collapse menu on click link","message":"collapse menu on click link\n","repos":"jfols\/liftoff,jfols\/liftoff,modweb\/pinki","old_file":"client\/views\/layout\/header.litcoffee","new_file":"client\/views\/layout\/header.litcoffee","new_contents":"# Header helpers\n\n    Template.header.events\n      'click #at-nav-link': (event) ->\n        if Meteor.user() then AccountsTemplates.logout()\n      'click .logout': (event) ->\n        AccountsTemplates.logout()\n      'click a': (event) ->\n        $('.navbar-toggle').click()\n","old_contents":"# Header helpers\n\n    Template.header.events\n      'click #at-nav-link': (event) ->\n        if Meteor.user() then AccountsTemplates.logout()\n      'click .logout': (event) ->\n        AccountsTemplates.logout()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4a0ea618b6a998d668364f1564113a9fa5f74a32","subject":"Move some descriptions around","message":"Move some descriptions around\n","repos":"ygt-mikekchar\/react-maybe-matchers,ygt-mikekchar\/react-maybe-matchers","old_file":"src\/ReactMaybeMatchers.litcoffee","new_file":"src\/ReactMaybeMatchers.litcoffee","new_contents":"# React Maybe Matchers for Jasmine\n\nTests using the React test utilities directly are both difficult to read\nand inconvenient to type. These matchers are intended to to make it\neasier to write tests and to understand what they are doing later.\n\nOne of the biggest problems with writing Jasmine matchers for React is that\nyou often have to search through Reacts tree to find the things you want\nto test.  In Rspec (in Ruby) you can often chain matchers together to create\ncomplex and readable tests.  Alas, this is not possible for Jasmine.\n\nTo compensate for this we will make a [Maybe monad](monad.md#what-is-a-monad)\nwhich will allow us to chain a series of filters.  People often get flustered\nabout monads, but their use is very straight forward.\n\n## DSL for React tests\n\nThese matchers will allow us to write tests like:\n\n```coffee\n  expect(component).toBeAComponent (it) ->\n    it.contains.tags(\"div\")\n      .with.cssClass(\"my-class\")\n      .and.text(\"contents\")\n      .exactly(2).times\n      .result()\n```\n\n**Note:** text() is not implemented yet.\n\nIn the example above, `toBeAComponent` accepts a callback, which it will call,\nfunishing a monad called `it`.  We can then chain a series of tests.\n\nThe chain in this example means that I am expecting my component to contain a DOM `div`\nwith the class `my-css-class`.  This `div` should contain the text, `contents`.\nThere should be exactly 2 such `divs` in my tree.  The `result()` at the\nend simply means, \"I'm done with my testing, please calculate the results\".\n\nThe Maybe monad is a special kind of monad that only processes when\nthe data is valid.  In this case, if there are no `div` elements, then it\nwont bother trying to figure out the cssClass, etc.  It will ignore\neverything until it gets to the `result`.  Its a useful technique when\nyou dont want to constantly check return values for errors.\n\n## Requirements\n\nThe matchers need to pluralize strings, so we need to load\n[a string pluralizer method](pluralize.litcoffee)\n\n    require(\".\/pluralize.litcoffee\")\n\nThe [ComponentQuery](.\/ComponentQuery.litcoffee) is a\n[JasmineMonad](.\/JasmineMonad.litcoffee)\nthat allows you to take a single React component and make queries\nof it, often generating a [ComponentFilter](.\/ComponentFilter.litcoffee). \n\n    ComponentQuery = require(\".\/ComponentQuery.litcoffee\")\n\n### Main matcher interface\n\nWe actually only require one main method in our matchers interface because\nall of our matchers are actually implemented as methods on our monads.\n\n    ReactMatchers =\n\n      toBeAComponent: (util, testers) ->\n        compare: (component, func) ->\n          filter = new ComponentQuery(component, util, testers)\n          func(filter)\n\nExport our matchers from this file.\n\n    module.exports = ReactMatchers\n","old_contents":"# React Maybe Matchers for Jasmine\n\nTests using the React test utilities directly are both difficult to read\nand inconvenient to type. These matchers are intended to to make it\neasier to write tests and to understand what they are doing later.\n\n## DSL for React tests\n\nThese matchers will allow us to write tests like:\n\n```coffee\n  expect(component).toBeAComponent (it) ->\n    it.contains.tags(\"div\")\n      .with.cssClass(\"my-class\")\n      .and.text(\"contents\")\n      .exactly(2).times\n      .result()\n```\n\n**Note:** text() is not implemented yet.\n\nOne of the biggest problems with writing Jasmine matchers for React is that\nyou often have to search through Reacts tree to find the things you want\nto test.  In Rspec (in Ruby) you can often chain matchers together to create\ncomplex and readable tests.  Alas, this is not possible for Jasmine.\n\nTo compensate for this we will make a [Maybe monad](monad.md#what-is-a-monad)\nwhich will allow us to chain a series of filters.  People often get flustered\nabout monads, but their use is very straight forward.\n\nIn the example above, `toBeAComponent` accepts a callback, which it will call,\nfunishing a monad called `it`.  We can then chain a series of tests.\n\nThe chain in this example means that I am expecting my component to contain a DOM `div`\nwith the class `my-css-class`.  This `div` should contain the text, `contents`.\nThere should be exactly 2 such `divs` in my tree.  The `result()` at the\nend simply means, \"I'm done with my testing, please calculate the results\".\n\nThe Maybe monad is a special kind of monad that only processes when\nthe data is valid.  In this case, if there are no `div` elements, then it\nwont bother trying to figure out the cssClass, etc.  It will ignore\neverything until it gets to the `result`.  Its a useful technique when\nyou dont want to constantly check return values for errors.\n\n## Requirements\n\nThe matchers need to pluralize strings, so we need to load\n[a string pluralizer method](pluralize.litcoffee)\n\n    require(\".\/pluralize.litcoffee\")\n\nThe [ComponentQuery](.\/ComponentQuery.litcoffee) is a\n[JasmineMonad](.\/JasmineMonad.litcoffee)\nthat allows you to take a single React component and make queries\nof it, often generating a [ComponentFilter](.\/ComponentFilter.litcoffee). \n\n    ComponentQuery = require(\".\/ComponentQuery.litcoffee\")\n\n### Main matcher interface\n\nWe actually only require one main method in our matchers interface because\nall of our matchers are actually implemented as methods on our monads.\n\n    ReactMatchers =\n\n      toBeAComponent: (util, testers) ->\n        compare: (component, func) ->\n          filter = new ComponentQuery(component, util, testers)\n          func(filter)\n\nExport our matchers from this file.\n\n    module.exports = ReactMatchers\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0e37006452b9c143b7f98908217249969b2fac4b","subject":"Fix another no-TLA failure","message":"Fix another no-TLA failure\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/managers\/next-match.litcoffee","new_file":"src\/coffee\/managers\/next-match.litcoffee","new_contents":"Next Match Manager\n==================\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe need both the next match and the list of teams as our inputs.\n\n        inputStream = Bacon.combineTemplate\n            teams: Data.teams\n            next: NextMatch\n\nList Management\n---------------\n\nWe use D3 to set the data within the list.\n\n        inputStream.onValue (state) ->\n            return unless state.next?\n\n            nodeHTML = (entry) ->\n                name = state.teams[entry]?.name ? entry\n                \"<li>#{name}<\/li>\"\n\n            DisplayInformation '.next-match-teams',\n                               state.next.teams ? [],\n                               'li', nodeHTML\n\nTime Display\n------------\n\nWe use the next match alone for the display of its start time.\n\n    NextMatch.onValue (match) ->\n        if match?\n            $('.next-match-time').text(FormatTime(FromUNIX(match.start),\n                                                        false))\n        else\n            $('.next-match-time').text('-')\n\n","old_contents":"Next Match Manager\n==================\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe need both the next match and the list of teams as our inputs.\n\n        inputStream = Bacon.combineTemplate\n            teams: Data.teams\n            next: NextMatch\n\nList Management\n---------------\n\nWe use D3 to set the data within the list.\n\n        inputStream.onValue (state) ->\n            return unless state.next?\n\n            nodeHTML = (entry) ->\n                \"<li>#{state.teams[entry].name}<\/li>\"\n\n            DisplayInformation '.next-match-teams',\n                               state.next.teams ? [],\n                               'li', nodeHTML\n\nTime Display\n------------\n\nWe use the next match alone for the display of its start time.\n\n    NextMatch.onValue (match) ->\n        if match?\n            $('.next-match-time').text(FormatTime(FromUNIX(match.start),\n                                                        false))\n        else\n            $('.next-match-time').text('-')\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"64ec9c2bff5a6aabfbcbb0529d0f4e8eacb7ec1a","subject":"\tmodified:   addressExample.litcoffee","message":"\tmodified:   addressExample.litcoffee\n","repos":"ai10\/simple-schema-EJSON","old_file":"collections\/addressExample.litcoffee","new_file":"collections\/addressExample.litcoffee","new_contents":"Example for simple-schema\n===\n\n\n\n      @Address = (city, state) ->\n        this.city = city\n        this.state = state\n\n      @Address:: =\n        constructor: Address\n\n        toString: () ->\n          @city + ',' + @state\n     \n        clone: () ->\n          new Address @city, @state\n\n        equals: (other) ->\n          if not (other instanceof Address) then return false\n\n        typeName: () ->\n          \"Address\"\n\n        toJSONValue: () ->\n          return {\n            @city\n            @state\n          }\n\n      EJSON.addType \"Address\", (value)->\n        console.log value\n        new Address value.city, value.state\n\n\n      @personA =\n        name: \"Chris Mather\"\n\n        createdAt: new Date()\n\n        file: new Uint8Array([104, 101, 108, 108, 111])\n\n        address: new Address(\"San Francisco\", \"CA\")\n\n      @personB =\n        name: \"Chuck Short\"\n\n        createdAt: new Date()\n\n        file: new Uint8Array([104, 101, 108, 108, 111])\n\n        address: new Address(\"Columbia\", \"SC\")\n\n\n\n\n\n      @People = new Meteor.Collection \"people\"\n\n      @People2 = new Meteor.Collection2 \"people2\", {\n        schema:\n          name:\n            type: String\n            label: \"name\"\n            max: 200\n          address:\n            type: Object\n            label: \"address\"\n        }\n\n      if (Meteor.isClient)\n        Meteor.subscribe \"people\"\n        Meteor.subscribe \"people2\"\n        Meteor.startup ()->\n          People.insert personB\n          People2.insert personB\n\n      if (Meteor.isServer)\n        Meteor.publish \"people\", ()->\n          @added \"people\", Meteor.uuid(), personA\n          @ready()\n        Meteor.publish \"people2\", ()->\n          @added \"people2\", Meteor.uuid(), personA\n          @ready()\n\n\n","old_contents":"Example for simple-schema\n===\n\n\n\n      @Address = (city, state) ->\n        this.city = city\n        this.state = state\n\n      @Address:: =\n        constructor: Address\n\n        toString: () ->\n          @city + ',' + @state\n     \n        clone: () ->\n          new Address @city, @state\n\n        equals: (other) ->\n          if not (other instanceof Address) then return false\n\n        typeName: () ->\n          \"Address\"\n\n        toJSONValue: () ->\n          return {\n            @city\n            @state\n          }\n\n      EJSON.addType \"Address\", (value)->\n        console.log value\n        new Address value.city, value.state\n\n\n      @person =\n        name: \"Chris Mather\"\n\n        createdAt: new Date()\n\n        file: new Uint8Array([104, 101, 108, 108, 111])\n\n        address: new Address(\"San Francisco\", \"CA\")\n\n      @person2 =\n        name: \"Chuck Short\"\n\n        createdAt: new Date()\n\n        file: new Uint8Array([104, 101, 108, 108, 111])\n\n        address: new Address(\"Columbia\", \"SC\")\n\n\n\n\n\n      @People = new Meteor.Collection \"people\"\n\n      @People2 = new Meteor.Collection2 \"people2\", {\n        schema:\n          name:\n            type: String\n            label: \"name\"\n            max: 200\n          address:\n            type: Object\n            label: \"address\"\n        }\n\n      if (Meteor.isClient)\n        Meteor.subscribe \"people\"\n        Meteor.subscribe \"people2\"\n        Meteor.startup ()->\n          People.insert person2\n          People2.insert person2\n\n      if (Meteor.isServer)\n        Meteor.publish \"people\", ()->\n          @added \"people\", Meteor.uuid(), person\n          @ready()\n        Meteor.publish \"people2\", ()->\n          @added \"people2\", Meteor.uuid(), person\n          @ready()\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"57c29ef4016d3646218a63e42117affcab76b1a6","subject":"Added more test coverage","message":"Added more test coverage\n","repos":"merciba\/ecrit,merciba\/ecrit","old_file":"test\/controllers\/users.litcoffee","new_file":"test\/controllers\/users.litcoffee","new_contents":"### Users Controller Test\n\nUnit tests for the `users` controller. Any new methods added to `\/server\/controllers\/users` should have matching tests here. \n\n\tfs = require 'fs'\n\tpath = require 'path'\n\tcolors = require 'colors'\n\tmoment = require 'moment'\n\tchai = require 'chai'\n\tchai.should()\n\ttestConfig = require '..\/config.json'\n\nCreate mock server objects to pass through the tests\n\n\treq = {\n\t\tparams: {}\n\t\tbody: {}\n\t}\n\tres = {}\n\tapp = {\n\t\tdialog: (str) -> console.log str.green if testConfig.console\n\t\tlog: (str) -> console.log str.cyan if testConfig.console\n\t\terror: (str) -> throw new Error str.red if testConfig.console\n\t\twarn: (str) -> console.warn \"[Warning]\".yellow, str.yellow if testConfig.console\n\t\tmodels: {}\n\t\tdata_config: {}\n\t}\n\nAssign the controller\n\n\tcontroller = require(\"..\/..\/factory\/server\/controllers\/users\")(app)\n\nBegin tests.\n\n\tdescribe 'controllers.users', () ->\n\n#### [create_new_user](https:\/\/github.com\/merciba\/ecrit\/blob\/master\/factory\/server\/controllers\/users.litcoffee#create_new_user)\n\t\t\n\t\tit 'create_new_user', (done) ->\n\n__Scenario:__ `req.body.user` matches [User model](https:\/\/github.com\/merciba\/ecrit\/blob\/master\/factory\/server\/models\/User.litcoffee)  \n__Should:__ Call `app.models.users.create` with identical query.\n\t\t\t\n\t\t\tscenario_one = () ->\n\n\t\t\t\treq.body.user = {\n\t\t\t\t\tid: 'id'\n\t\t\t\t\tfirst_name: 'Test'\n\t\t\t\t}\n\t\t\t\tapp.models.users = {\n\t\t\t\t\tcreate: (query, next) ->\n\t\t\t\t\t\tquery.id.should.equal 'id'\n\t\t\t\t\t\tquery.first_name.should.equal 'Test'\n\t\t\t\t\t\tnext null, query\n\t\t\t\t\t\t\n\t\t\t\t\tattributes: require('..\/..\/factory\/server\/models\/User').attributes\n\t\t\t\t}\n\n\t\t\t\tcontroller.create_new_user req, res, done\n\n\t\t\tscenario_one()","old_contents":"### Users Controller Test\n\nUnit tests for the `users` controller. Any new methods added to `\/server\/controllers\/users` should have matching tests here. \n\n\tfs = require 'fs'\n\tpath = require 'path'\n\tcolors = require 'colors'\n\tmoment = require 'moment'\n\tchai = require 'chai'\n\tchai.should()\n\ttestConfig = require '..\/config.json'\n\nCreate mock server objects to pass through the tests\n\n\treq = {\n\t\tparams: {}\n\t\tbody: {}\n\t}\n\tres = {}\n\tapp = {\n\t\tdialog: (str) -> console.log str.green if testConfig.console\n\t\tlog: (str) -> console.log str.cyan if testConfig.console\n\t\terror: (str) -> throw new Error str.red if testConfig.console\n\t\twarn: (str) -> console.warn \"[Warning]\".yellow, str.yellow if testConfig.console\n\t\tmodels: {}\n\t\tdata_config: {}\n\t}\n\nAssign the controller\n\n\tcontroller = require(\"..\/..\/factory\/server\/controllers\/users\")(app)\n\nBegin tests.\n\n\tdescribe 'controllers.users', () ->\n\n#### [create_new_user](https:\/\/github.com\/merciba\/ecrit\/blob\/master\/factory\/server\/controllers\/users.litcoffee#create_new_user)\n\t\t\n\t\tit 'create_new_user', (done) ->\n\n__Scenario:__ `req.body.user` matches [User model](https:\/\/github.com\/merciba\/ecrit\/blob\/master\/factory\/server\/models\/User.litcoffee)  \n__Should:__ Display the time, method and original URL if `ecrit test` is invoked with the `--console` flag.\n\t\t\t\n\t\t\tscenario_one = () ->\n\n\t\t\t\treq.body.user = {\n\t\t\t\t\tid: 'id'\n\t\t\t\t}\n\t\t\t\tapp.models.users = {\n\t\t\t\t\tcreate: (query, next) ->\n\t\t\t\t\t\tquery.should.have.property 'id'\n\t\t\t\t\t\tnext null, query\n\t\t\t\t\tattributes: require('..\/..\/factory\/server\/models\/User').attributes\n\t\t\t\t}\n\n\t\t\t\tcontroller.create_new_user req, res, done\n\n\t\t\tscenario_one()","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1b529b1e7f2a04da51b29b6c6e0610b0ca595e65","subject":"No longer need this method (thank god)","message":"No longer need this method (thank god)\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b8dce0dad62ce78c3e6420618ab38e0884f07065","subject":"Don't call initializers in _finish_up anymore","message":"Don't call initializers in _finish_up anymore\n\nThat's handled in _wrap_methods now\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (done) =>\n        proto  = @.__proto__\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            @[initer.execute]().then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              @[initializer.fn]()\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (done) =>\n        proto  = @.__proto__\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            @[initer.execute]().then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        @_call_initializers_for name, =>\n          if listeners[name]?\n            async.each listeners[name], (listener, next) =>\n              listener @\n              next()\n            , => @_register_initialized name\n          else\n            @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              @[initializer.fn]()\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"84aa5dd37b5d1ee0376d7cbf8547e845f83a564c","subject":"Refactor to use volor instead of carver","message":"Refactor to use volor instead of carver\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/skyll.litcoffee","new_file":"lib\/skyll.litcoffee","new_contents":"    Madul = require 'madul'\n\n    class Skyll extends Madul\n      deps: [ '~volor', 'async', 'path' ]\n\n      _do_flush: (step, ctx, level_name, exception, next) =>\n        if step.flush?\n          step.flush ctx, level_name\n            .then  next\n            .catch (err) =>\n              console.log 'flushing', err\n              exception err\n        else\n          next()\n\n      _do_render: (ctx, step, level_name, exception, next) =>\n        step.render ctx, level_name\n          .then  next\n          .catch (err) =>\n            console.log 'rendering', err\n            exception err\n\n      _decorate: (thing, args, delegates) =>\n        for i in [ 'args', 'delegates' ]\n          if thing[i]?\n            for j in thing[i]\n              thing.set j, if i == 'args' then args[j] else delegates[j]\n\n        thing\n\n      craft: (level_name, args, pipeline, delegates, done, exception) ->\n        map = @volor()\n\n        @async.eachOfSeries pipeline, (pipe, i, next) =>\n          if Array.isArray pipe\n            @async.eachSeries pipe, (step, nxt) =>\n              decorated = @_decorate step, args, delegates\n\n              @_do_render map, decorated, level_name, exception(nxt), nxt\n            , =>\n              @_do_flush pipeline[i][0], map, level_name, exception(next), => next()\n          else\n            decorated = @_decorate pipe, args, delegates\n\n            @_do_render map, decorated, level_name, exception(next), =>\n              if i == pipeline.length - 1\n                @_do_flush decorated, map, level_name, exception(next), => next()\n              else\n                next()\n        , done\n\n    module.exports = Skyll\n","old_contents":"    Madul = require 'madul'\n\n    class Skyll extends Madul\n      deps: [ 'carver', 'async', 'path' ]\n\n      _do_flush: (step, ctx, level_name, exception, next) =>\n        if step.flush?\n          step.flush ctx, level_name\n            .then  next\n            .catch (err) =>\n              console.log 'flushing', err\n              exception err\n        else\n          next()\n\n      _do_render: (ctx, step, path, level_name, exception, next) =>\n        step.render ctx, path, level_name\n          .then  next\n          .catch (err) =>\n            console.log 'rendering', err\n            exception err\n\n      _decorate: (thing, args, delegates) =>\n        for i in [ 'args', 'delegates' ]\n          if thing[i]?\n            for j in thing[i]\n              thing.set j, if i == 'args' then args[j] else delegates[j]\n\n        thing\n\n      craft: (level_name, args, pipeline, delegates, done, exception) ->\n        ctx = [ ]\n\n        @carver.carve_path delegates.pathfinder, args.rows, args.columns\n          .then (path) =>\n            console.log 'STARTING RENDER'\n            @async.eachOfSeries pipeline, (pipe, i, next) =>\n              if Array.isArray pipe\n                @async.eachSeries pipe, (step, nxt) =>\n                  decorated = @_decorate step, args, delegates\n\n                  @_do_render ctx, decorated, path, level_name, exception(nxt), nxt\n                , =>\n                  @_do_flush pipeline[i][0], ctx, level_name, exception(next), => next()\n              else\n                decorated = @_decorate pipe, args, delegates\n\n                @_do_render ctx, decorated, path, level_name, exception(next), =>\n                  if i == pipeline.length - 1\n                    @_do_flush decorated, ctx, level_name, exception(next), => next()\n                  else\n                    next()\n            , done\n          .catch exception\n\n    module.exports = Skyll\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"57b02c1a1507779b21cb865712f0f6f2545c6832","subject":"Get rid of undefined variable.","message":"Get rid of undefined variable.\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/routing.litcoffee","new_file":"guts\/routing.litcoffee","new_contents":"Routing\n=======\nThis file serves as the \"glue\" between the express router and sanity. Basically, we want a rails-esque routing system with all the routes declared in one location.  One advantage over rails, though, is that we're going to allow some degree of function composition in that we can declare multiple, reusable actions per-route, then let them pass the return value from one to the next.\n\nThis is done via unapologetic use of Promises. \n\n##Libraries\n\n    Promise = require 'bluebird'\n    fs = Promise.promisifyAll require 'fs'\n    _ = require 'lodash'\n\nAs a note, the `Promise.promisifyAll` function simply adds `Async` to the end of the methods in `fs` and subsequently allows Promises to be used instead of callbacks. \n\n##Local Modules\n\n    getControllers = require '.\/getControllers'\n    policies = require '.\/policies'\n    bodyParser = require '.\/bodyParser'\n\n\nLet's kickstart this router.\n\n    module.exports = (app) ->\n        \n-----------\n        \nThis grabs the controllers and returns back a promise'd object of them. It made more sense to put this in a separate file, since it'sarguably useful in its own right.\n\n        getControllers()\n\nOnce we've gotten all the controllers, we'll move on\n\n        .then (controllerObject) ->\n\nLet's load in the routes file\n\n            configuredRoutes = require '..\/config\/routes'\n\nLet's loop through the routes file and do the appropriate mapping.[1]\n\n            _.each configuredRoutes, (totalString, route) ->\n\n                \nRoutes are stored like METHOD \/route, so we'll split on spaces. To make this a bit more dev-friendly, let's get rid of redundant spaces and newlines.\n\n                [method, endpoint] = route\n                             .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                             .replace \/\\s\\s+\/g, ' '\n                             .trim()\n                             .split ' '\n\n-----------\n\nThis bigass thing here is for dev-friendliness.  I don't want to punish people for separating controller calls to multiple lines if they want, and I don't want punish them for adding multiple spaces.  Subsequently, I replace newlines with a  space, then replace extra spaces down to one space, trim it, and split on the @ sign so I can make the dichotomy between application logic and error-handling logic. Utilizing Coffee's \"multi-return\" thing, I can set the values pretty cleanly, but not before I make sure the values are trimmed.\n\n                [actionString, catchString] = totalString\n                                  .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                                  .replace \/\\s\\s+\/g, ' '\n                                  .trim()\n                                  .split '@'\n                                  .map (i) -> do i.trim\n-----------\n\n\nAgain, just make it cleaner, we'll utilize the \"multi-return\" thing coffeescript does. Since I don't want a hard requirement for a catch to exist, I will put a conditional to see if the catch is defined.\n\n                [catchController,catchFunction] = catchString.split '.' if catchString?\n\nIf we have a catch defined, awesome, else we'll just feed in an empty function.\n               \n                catcher = controllerObject[catchController]?[catchFunction] || ->\n\nSplit the routes on a space so as to separate individual action handlers.\n\n                allRoutes = actionString.split ' '\n\n-------\n\nLoop through all the actions that are provided for that route, look them up, return back the handles on the function. So as to save a \"push\" command we'll use a map\n\n                actionHandles = _.map allRoutes, (a) ->\n\nFirst we need to separate out the error handling stuff from the actual program, so let's split that out, and utilize the multi-return value feature of coffeescript.\n\n                    [actionStuff, errorStuff] = a.split '!'\n\nSince I don't want to make a hard requirement to provide an error-handler, let's put a put quick \"if\" at the end of this to make sure we have errorstuff to assign.\n\n                    [errorController, errorAction] = errorStuff.split '.' if errorStuff?\n\nLet's parse out the controller and action.\n\n                    [myController, myAction] = actionStuff.split '.'\n\n\nNow let's grab the appropriate stuff out of the controllers.\n\n                    finalAction =  controllerObject[myController][myAction]\n                    finalError = controllerObject[errorController]?[errorAction]\n                    \nSince everything is parsed out, let's just wrap this in an object so as to easily pipe into the promises.\n\n                    finalObject =\n                        action: finalAction\n                        error: finalError\n                        controllerName: myController\n                        actionName: myAction\n\nOnce everything is done, let's just return out of the map and move on. \n\n                    return finalObject\n\n\nThe `wrapper` function.\n-----------------------\n\nThis here is the glue that does the joining of the actual functions.  In a nutshell, when the request it made, it should run `wrapper`, which will loop through the functions that were returned by the previous map, and run them sequentially as part of the promise chain.  I would like to eventually add a mechanism in which to do this in parallel (instead of just sequentially) eventually. \n\n                wrapper = (req, res) ->\n\nWe need to make sure the user is allowed to use everything that this route has to offer.  Due to the beauty of Bluebird, if this this trips up, it'll just kill the promise chain and make it so that we don't go any farther than we're allowed to.\n\n                        bodyParser req\n                        .then (updatedReq) ->\n                            policies actionHandles, updatedReq, res\n\nOnce we've gotten all the handles on the functions we need to call, we can concat it to all previous promises. Afterwards we want these to run sequentially, so we use the reduce function to run them, then converge into a single, final promise.\n\n                            finalPromise =\n                                _.chain [authPromise]\n                                .flatten()\n                                .concat actionHandles\n                                .reduce (cur, next) ->\n                                    cur.then next.action, next.error\n                                .value()\n                                \nEverything should be done.  We can finally render a template or return back JSON depending on what they did on that last function\n\n                            finalPromise.then (endData) ->\n\n\nWhat happens now is pretty simple.  A requirement for frameworkey is that you return an object with your data and the `renderType` property. From there it's pretty straightforward.\n\n                                if endData.renderType.toLowerCase() == 'html'\n                                    # We used \"toLowerCase\" to make it more dev-friendly. \n                                    res.render endData.page\n                                else if endData.renderType.toLowerCase() == 'json'\n                                    res.send endData.data\n                                \nWe'll use the global catch defined at the end of the actions to handle residual errors.  If there's an issue, we go here. We can default to an empty function if there's an issue.\n\n                            finalPromise.catch catcher\n\n                            \nAs stated above, wrapper will return a new function based on what we send in for \"allRoutes\".  We're adding the \"toLowerCase()\" to make this a bit more dev-friendly.\n\n                app[do method.toLowerCase] endpoint, wrapper\n\n\n[1]: I *really* hate how the value comes before the key in Lodash\n","old_contents":"Routing\n=======\nThis file serves as the \"glue\" between the express router and sanity. Basically, we want a rails-esque routing system with all the routes declared in one location.  One advantage over rails, though, is that we're going to allow some degree of function composition in that we can declare multiple, reusable actions per-route, then let them pass the return value from one to the next.\n\nThis is done via unapologetic use of Promises. \n\n##Libraries\n\n    Promise = require 'bluebird'\n    fs = Promise.promisifyAll require 'fs'\n    _ = require 'lodash'\n\nAs a note, the `Promise.promisifyAll` function simply adds `Async` to the end of the methods in `fs` and subsequently allows Promises to be used instead of callbacks. \n\n##Local Modules\n\n    getControllers = require '.\/getControllers'\n    policies = require '.\/policies'\n    bodyParser = require '.\/bodyParser'\n\n\nLet's kickstart this router.\n\n    module.exports = (app) ->\n        \n-----------\n        \nThis grabs the controllers and returns back a promise'd object of them. It made more sense to put this in a separate file, since it'sarguably useful in its own right.\n\n        getControllers()\n\nOnce we've gotten all the controllers, we'll move on\n\n        .then (controllerObject) ->\n\nLet's load in the routes file\n\n            configuredRoutes = require '..\/config\/routes'\n\nLet's loop through the routes file and do the appropriate mapping.[1]\n\n            _.each configuredRoutes, (totalString, route) ->\n\n                \nRoutes are stored like METHOD \/route, so we'll split on spaces. To make this a bit more dev-friendly, let's get rid of redundant spaces and newlines.\n\n                [method, endpoint] = route\n                             .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                             .replace \/\\s\\s+\/g, ' '\n                             .trim()\n                             .split ' '\n\n-----------\n\nThis bigass thing here is for dev-friendliness.  I don't want to punish people for separating controller calls to multiple lines if they want, and I don't want punish them for adding multiple spaces.  Subsequently, I replace newlines with a  space, then replace extra spaces down to one space, trim it, and split on the @ sign so I can make the dichotomy between application logic and error-handling logic. Utilizing Coffee's \"multi-return\" thing, I can set the values pretty cleanly, but not before I make sure the values are trimmed.\n\n                [actionString, catchString] = totalString\n                                  .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                                  .replace \/\\s\\s+\/g, ' '\n                                  .trim()\n                                  .split '@'\n                                  .map (i) -> do i.trim\n-----------\n\n\nAgain, just make it cleaner, we'll utilize the \"multi-return\" thing coffeescript does. Since I don't want a hard requirement for a catch to exist, I will put a conditional to see if the catch is defined.\n\n                [catchController,catchFunction] = catchString.split '.' if catchString?\n\nIf we have a catch defined, awesome, else we'll just feed in an empty function.\n               \n                catcher = controllerObject[catchController]?[catchFunction] || ->\n\nSplit the routes on a space so as to separate individual action handlers.\n\n                allRoutes = actionString.split ' '\n\n-------\n\nLoop through all the actions that are provided for that route, look them up, return back the handles on the function. So as to save a \"push\" command we'll use a map\n\n                actionHandles = _.map allRoutes, (a) ->\n\nFirst we need to separate out the error handling stuff from the actual program, so let's split that out, and utilize the multi-return value feature of coffeescript.\n\n                    [actionStuff, errorStuff] = a.split '!'\n\nSince I don't want to make a hard requirement to provide an error-handler, let's put a put quick \"if\" at the end of this to make sure we have errorstuff to assign.\n\n                    [errorController, errorAction] = errorStuff.split '.' if errorStuff?\n\nLet's parse out the controller and action.\n\n                    [myController, myAction] = actionStuff.split '.'\n\n\nNow let's grab the appropriate stuff out of the controllers.\n\n                    finalAction =  controllerObject[myController][myAction]\n                    finalError = controllerObject[errorController]?[errorAction]\n                    \nSince everything is parsed out, let's just wrap this in an object so as to easily pipe into the promises.\n\n                    finalObject =\n                        action: finalAction\n                        error: finalError\n                        controllerName: myController\n                        actionName: myAction\n\nOnce everything is done, let's just return out of the map and move on. \n\n                    return finalObject\n\n\nThe `wrapper` function.\n-----------------------\n\nThis here is the glue that does the joining of the actual functions.  In a nutshell, when the request it made, it should run `wrapper`, which will loop through the functions that were returned by the previous map, and run them sequentially as part of the promise chain.  I would like to eventually add a mechanism in which to do this in parallel (instead of just sequentially) eventually. \n\n                wrapper = (req, res) ->\n\nWe need to make sure the user is allowed to use everything that this route has to offer.  Due to the beauty of Bluebird, if this this trips up, it'll just kill the promise chain and make it so that we don't go any farther than we're allowed to.\n\n                        bodyParser req\n                        .then (updatedReq) ->\n                            policies actionHandles, updatedReq, res\n\nOnce we've gotten all the handles on the functions we need to call, we can concat it to all previous promises. Afterwards we want these to run sequentially, so we use the reduce function to run them, then converge into a single, final promise.\n\n                            finalPromise =\n                                _.chain [authPromise, bodyParsePromise]\n                                .flatten()\n                                .concat actionHandles\n                                .reduce (cur, next) ->\n                                    cur.then next.action, next.error\n                                .value()\n                                \nEverything should be done.  We can finally render a template or return back JSON depending on what they did on that last function\n\n                            finalPromise.then (endData) ->\n\n\nWhat happens now is pretty simple.  A requirement for frameworkey is that you return an object with your data and the `renderType` property. From there it's pretty straightforward.\n\n                                if endData.renderType.toLowerCase() == 'html'\n                                    # We used \"toLowerCase\" to make it more dev-friendly. \n                                    res.render endData.page\n                                else if endData.renderType.toLowerCase() == 'json'\n                                    res.send endData.data\n                                \nWe'll use the global catch defined at the end of the actions to handle residual errors.  If there's an issue, we go here. We can default to an empty function if there's an issue.\n\n                            finalPromise.catch catcher\n\n                            \nAs stated above, wrapper will return a new function based on what we send in for \"allRoutes\".  We're adding the \"toLowerCase()\" to make this a bit more dev-friendly.\n\n                app[do method.toLowerCase] endpoint, wrapper\n\n\n[1]: I *really* hate how the value comes before the key in Lodash\n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"d5b143b86bfcf4a79e8e8bde6a3bae3562c3e282","subject":"Path issue","message":"Path issue\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-skin-strapped\/index.litcoffee","new_file":"packages\/shrub-skin-strapped\/index.litcoffee","new_contents":"# Strapped\n\n*Shrub's default skin.*\n\n    path = require 'path'\n\n    shrubSkin = require 'shrub-skin'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubNodemailerHtml`.\n\n      registrar.registerHook 'shrubNodemailerHtml', ($body, html, $) ->\n\n        $('.container > .main', $body).html html\n\n        $body.find('.navbar-toggle, .navbar-collapse').remove()\n        $body.find('[data-shrub-ui-messages]').remove()\n\n        $body.find('script').remove()\n\n        $('noscript', $body).remove()\n\n#### Implements hook `skinAssets`.\n\n      registrar.registerHook 'skinAssets', (assets) ->\n\nAdd our future-compiled LESS style sheets.\n\n        assets.styleSheets.default.push '\/css\/style.css'\n        assets.styleSheets.production.push '\/css\/style.css'\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig) ->\n\n        gruntConfig.less ?= {}\n\n        shrubSkin.gruntSkin gruntConfig, 'shrub-skin-strapped'\n\n        gruntConfig.configureTask 'less', 'shrub-skin-strapped', files: [\n          src: [\n            \"#{__dirname}\/app\/less\/style.less\"\n          ]\n          dest: 'app\/skin\/shrub-skin-strapped\/css\/style.css'\n        ]\n\n        gruntConfig.configureTask(\n          'watch', 'shrub-skin-strappedLess'\n\n          files: [\n            \"#{__dirname}\/app\/less\/style.less\"\n          ]\n          tasks: [\n            'newer:less:shrub-skin-strapped'\n          ]\n        )\n\n        gruntConfig.registerTask 'build:shrub-skin-strapped', [\n          'clean:shrub-skin-strapped'\n          'newer:copy:shrub-skin-strapped'\n          'less:shrub-skin-strapped'\n        ]\n\n        gruntConfig.registerTask 'build', ['build:shrub-skin-strapped']\n\n        gruntConfig.loadNpmTasks ['grunt-contrib-less']\n","old_contents":"# Strapped\n\n*Shrub's default skin.*\n\n    path = require 'path'\n\n    shrubSkin = require 'shrub-skin'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubNodemailerHtml`.\n\n      registrar.registerHook 'shrubNodemailerHtml', ($body, html, $) ->\n\n        $('.container > .main', $body).html html\n\n        $body.find('.navbar-toggle, .navbar-collapse').remove()\n        $body.find('[data-shrub-ui-messages]').remove()\n\n        $body.find('script').remove()\n\n        $('noscript', $body).remove()\n\n#### Implements hook `skinAssets`.\n\n      registrar.registerHook 'skinAssets', (assets) ->\n\nAdd our future-compiled LESS style sheets.\n\n        assets.styleSheets.default.push 'css\/style.css'\n        assets.styleSheets.production.push 'css\/style.css'\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig) ->\n\n        gruntConfig.less ?= {}\n\n        shrubSkin.gruntSkin gruntConfig, 'shrub-skin-strapped'\n\n        gruntConfig.configureTask 'less', 'shrub-skin-strapped', files: [\n          src: [\n            \"#{__dirname}\/app\/less\/style.less\"\n          ]\n          dest: 'app\/skin\/shrub-skin-strapped\/css\/style.css'\n        ]\n\n        gruntConfig.configureTask(\n          'watch', 'shrub-skin-strappedLess'\n\n          files: [\n            \"#{__dirname}\/app\/less\/style.less\"\n          ]\n          tasks: [\n            'newer:less:shrub-skin-strapped'\n          ]\n        )\n\n        gruntConfig.registerTask 'build:shrub-skin-strapped', [\n          'clean:shrub-skin-strapped'\n          'newer:copy:shrub-skin-strapped'\n          'less:shrub-skin-strapped'\n        ]\n\n        gruntConfig.registerTask 'build', ['build:shrub-skin-strapped']\n\n        gruntConfig.loadNpmTasks ['grunt-contrib-less']\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ee33daf1af9d92b5c88863b2015c331f90dfb32a","subject":"add environment info to README","message":"add environment info to README\n","repos":"CureApp\/loopback-with-admin","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\n\n# install\n\n```\nnpm install loopback-with-domain\n```\n\n\n# run\n\nbefore running, you can prepare a directory which contains custom config information.\n\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    configDir = '\/path\/to\/config-dir'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    lbWithDomain.runWithDomain(domain, configDir).then ->\n        # loopback started\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- model-config\n- server\n- push-credentials\n\nsee JSON files in \"default-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|-----------------------\n memory      | on memory datasource\n db          | datasource for domain entities\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n# switching environment\n\nrunning script with environment variable \"NODE\\_ENV\" like\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\n\"development\" is selected by default.\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-domain selects configs in \"local\" directory.\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    lbWithDomain.runWithDomain(domain, configDir, env)\n\nenv is prior to NODE\\_ENV settings.\n\n","old_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\n\n# install\n\n```\nnpm install loopback-with-domain\n```\n\n\n# run\n\nbefore running, you can prepare a directory which contains custom config information.\n\n\n```\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    configDir = '\/path\/to\/config-dir'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    lbWithDomain.runWithDomain(domain, configDir).then ->\n        # loopback started\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- model-config\n- server\n- push-credentials\n\nsee JSON files in \"default-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|-----------------------\n memory      | on memory datasource\n db          | datasource for domain entities\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e269e0747185ad93dfc49bbd3bd26a073f471a21","subject":"Fix test that shouldn't be async","message":"Fix test that shouldn't be async\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::%dirtyKeys : Set\n\nThe set of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## @constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    asyncTest \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::%dirtyKeys : Set\n\nThe set of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## @constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d8f04a4b6bd51ab1aa7007cb25a7507e8bb92dbb","subject":"console","message":"console\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       #throw e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options) ->\n      @errorCallback 'AJAX cannot respond', data\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        console.error 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      console.error msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       #throw e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options) ->\n      @errorCallback 'AJAX cannot respond', data\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1e7216a8d8b9b26e55308518c8a5afdb0fbe1c0b","subject":"The waterline migration default (now?) is alter... create is safer.","message":"The waterline migration default (now?) is alter... create is safer.\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-orm\/index.litcoffee","new_file":"packages\/shrub-orm\/index.litcoffee","new_contents":"# Object-relational mapping\n\n*Tools for working with [Waterline](https:\/\/github.com\/balderdashy\/waterline).*\n\n    require('events').EventEmitter.prototype._maxListeners = 100\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    Waterline = null\n\n    collections = {}\n    connections = {}\n\n    waterline = null\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCorePreBootstrap`.\n\n      registrar.registerHook 'shrubCorePreBootstrap', ->\n\n        Waterline = require 'waterline'\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        waterline = new Waterline()\n\n        label: 'Bootstrap ORM'\n        middleware: [\n\n          (next) -> exports.initialize next\n\n        ]\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig) ->\n\n        gruntConfig.copyAppFiles \"#{__dirname}\/app\", 'shrub-orm'\n\n        gruntConfig.registerTask 'build:shrub-orm', [\n          'newer:copy:shrub-orm'\n        ]\n\n        gruntConfig.registerTask 'build', ['build:shrub-orm']\n\n#### Implements hook `shrubConfigServer`.\n\n      registrar.registerHook 'shrubConfigServer', ->\n\nThe available adapters. This is a list of module names. We provide sails-redis\nby default.\n\n        adapters: [\n          'sails-redis'\n        ]\n\nThe available connnections. This is a keyed list of available connections\nwhich are defined as an adapter and the configuration for the adapter. The\nentries in the `adapters` list are available for use here. We provide a `shrub`\nconnection by default, which uses the sails-redis adapter with defaults.\n\n        connections:\n\n          shrub:\n\n            adapter: 'sails-redis'\n            port: 6379\n            host: 'localhost'\n            password: null\n            database: null\n\n#### Implements hook `shrubReplContext`.\n\nProvide ORM to the REPL context.\n\n      registrar.registerHook 'shrubReplContext', (context) -> context.orm = exports\n\n## initialize\n\n* (Function) `fn` - Nodeback called when initialization completes.\n\n*Spin up Waterline with our configuration.*\n\n    exports.initialize = (fn) ->\n\n      config_ = config.get 'packageSettings:shrub-orm'\n\n      waterlineConfig = adapters: {}, connections: {}\n\n`require` all the adapter modules.\n\n      for adapter in config_.adapters\n        waterlineConfig.adapters[adapter] = require adapter\n\n      waterlineConfig.connections = config_.connections\n\n#### Invoke hook `shrubOrmCollections`.\n\n      collections_ = {}\n      for collectionList in pkgman.invokeFlat 'shrubOrmCollections', waterline\n        for identity, collection of collectionList\n\nSet collection defaults.\n\n          collection.connection ?= 'shrub'\n          collection.identity ?= identity\n          collection.migrate ?= 'create'\n          collections_[collection.identity] = collection\n\n## Collection#instantiate.\n\n* (Object) `values` - An object with values to populate the model properties.\n\n*Instantiate a model with defaults supplied.*\n\n          collection.instantiate = (values = {}) ->\n\n            for key, value of @attributes\n              continue unless value.defaultsTo?\n\nSet any model defaults.\n\n              values[key] ?= if 'function' is typeof value.defaultsTo\n                value.defaultsTo.call values\n              else\n                JSON.parse JSON.stringify value.defaultsTo\n\nReach into Waterline a bit, hackish but they simply don't provide us with a\nsane API for this.\n\n            new @_model @_schema.cleanValues @_transformer.serialize values\n\n#### Invoke hook `shrubOrmCollectionsAlter`.\n\n      pkgman.invoke 'shrubOrmCollectionsAlter', collections_, waterline\n\nLoad the collections into Waterline.\n\n      for i, collection of collections_\n        waterline.loadCollection Waterline.Collection.extend collection\n\n      waterline.initialize waterlineConfig, (error, data) ->\n        return fn error if error?\n\n        collections = data.collections\n        connections = data.connections\n\n        fn()\n\n## collection\n\n* (String) `identity` - Collection identity. e.g. `'shrub-user'`\n\n*Get a collection by identity.*\n\n    exports.collection = (identity) -> collections[identity]\n\n## collections\n\n*Get all collections.*\n\n    exports.collections = -> collections\n\n## connections\n\n*Get all connections.*\n\n    exports.connections = -> connections\n\n## teardown\n\n* (Function) `fn` - Nodeback called after teardown.\n\n*Tear down Waterline.*\n\n    exports.teardown = (fn) -> waterline.teardown fn\n\n## waterline\n\n*Get the Waterline instance.*\n\n    exports.waterline = -> waterline\n","old_contents":"# Object-relational mapping\n\n*Tools for working with [Waterline](https:\/\/github.com\/balderdashy\/waterline).*\n\n    require('events').EventEmitter.prototype._maxListeners = 100\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    Waterline = null\n\n    collections = {}\n    connections = {}\n\n    waterline = null\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCorePreBootstrap`.\n\n      registrar.registerHook 'shrubCorePreBootstrap', ->\n\n        Waterline = require 'waterline'\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        waterline = new Waterline()\n\n        label: 'Bootstrap ORM'\n        middleware: [\n\n          (next) -> exports.initialize next\n\n        ]\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig) ->\n\n        gruntConfig.copyAppFiles \"#{__dirname}\/app\", 'shrub-orm'\n\n        gruntConfig.registerTask 'build:shrub-orm', [\n          'newer:copy:shrub-orm'\n        ]\n\n        gruntConfig.registerTask 'build', ['build:shrub-orm']\n\n#### Implements hook `shrubConfigServer`.\n\n      registrar.registerHook 'shrubConfigServer', ->\n\nThe available adapters. This is a list of module names. We provide sails-redis\nby default.\n\n        adapters: [\n          'sails-redis'\n        ]\n\nThe available connnections. This is a keyed list of available connections\nwhich are defined as an adapter and the configuration for the adapter. The\nentries in the `adapters` list are available for use here. We provide a `shrub`\nconnection by default, which uses the sails-redis adapter with defaults.\n\n        connections:\n\n          shrub:\n\n            adapter: 'sails-redis'\n            port: 6379\n            host: 'localhost'\n            password: null\n            database: null\n\n#### Implements hook `shrubReplContext`.\n\nProvide ORM to the REPL context.\n\n      registrar.registerHook 'shrubReplContext', (context) -> context.orm = exports\n\n## initialize\n\n* (Function) `fn` - Nodeback called when initialization completes.\n\n*Spin up Waterline with our configuration.*\n\n    exports.initialize = (fn) ->\n\n      config_ = config.get 'packageSettings:shrub-orm'\n\n      waterlineConfig = adapters: {}, connections: {}\n\n`require` all the adapter modules.\n\n      for adapter in config_.adapters\n        waterlineConfig.adapters[adapter] = require adapter\n\n      waterlineConfig.connections = config_.connections\n\n#### Invoke hook `shrubOrmCollections`.\n\n      collections_ = {}\n      for collectionList in pkgman.invokeFlat 'shrubOrmCollections', waterline\n        for identity, collection of collectionList\n\nSet collection defaults.\n\n          collection.connection ?= 'shrub'\n          collection.identity ?= identity\n          collections_[collection.identity] = collection\n\n## Collection#instantiate.\n\n* (Object) `values` - An object with values to populate the model properties.\n\n*Instantiate a model with defaults supplied.*\n\n          collection.instantiate = (values = {}) ->\n\n            for key, value of @attributes\n              continue unless value.defaultsTo?\n\nSet any model defaults.\n\n              values[key] ?= if 'function' is typeof value.defaultsTo\n                value.defaultsTo.call values\n              else\n                JSON.parse JSON.stringify value.defaultsTo\n\nReach into Waterline a bit, hackish but they simply don't provide us with a\nsane API for this.\n\n            new @_model @_schema.cleanValues @_transformer.serialize values\n\n#### Invoke hook `shrubOrmCollectionsAlter`.\n\n      pkgman.invoke 'shrubOrmCollectionsAlter', collections_, waterline\n\nLoad the collections into Waterline.\n\n      for i, collection of collections_\n        waterline.loadCollection Waterline.Collection.extend collection\n\n      waterline.initialize waterlineConfig, (error, data) ->\n        return fn error if error?\n\n        collections = data.collections\n        connections = data.connections\n\n        fn()\n\n## collection\n\n* (String) `identity` - Collection identity. e.g. `'shrub-user'`\n\n*Get a collection by identity.*\n\n    exports.collection = (identity) -> collections[identity]\n\n## collections\n\n*Get all collections.*\n\n    exports.collections = -> collections\n\n## connections\n\n*Get all connections.*\n\n    exports.connections = -> connections\n\n## teardown\n\n* (Function) `fn` - Nodeback called after teardown.\n\n*Tear down Waterline.*\n\n    exports.teardown = (fn) -> waterline.teardown fn\n\n## waterline\n\n*Get the Waterline instance.*\n\n    exports.waterline = -> waterline\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9314f014026affd0569df50302b9cf3f8bb3aed9","subject":"added :bashcode - custom jade filter (with Pygments)","message":"added :bashcode - custom jade filter (with Pygments)\n","repos":"romanpitak\/pitak.net,romanpitak\/pitak.net","old_file":"src\/jade\/build.litcoffee","new_file":"src\/jade\/build.litcoffee","new_contents":"# The build script\n\nThis is a very simple build script that puts together the YAML + JADE page files\nand the pure JADE template files. It also builds the blog index.\n\nLoad modules\n\n    fs = require 'fs'\n    mkdirp = require('mkdirp').sync;\n    jade = require 'jade'\n    yaml = require 'js-yaml'\n    config = require '.\/config'\n    execSync = (require 'child_process').execSync\n\nAdd custom Pygments filters to Jade\n\n    jade.filters.bashcode = (text) ->\n        result = execSync 'pygmentize -l bash -f html',\n            input: text\n        return result.toString()\n\n### Template loader\n\nTemplates are different from pages in that they don't have a YAML front matter.\nThey are written in clean jade and can extend and include other templates.\n\n    class Template\n        constructor: (@name = 'page', @location = config.templatesPath) ->\n        getHtml: (options) ->\n            cwd = process.cwd()\n            options.pretty = config.pretty\n            options.filename = @name\n            try\n                process.chdir @location\n                content = fs.readFileSync \"#{@name}.jade\", 'utf8'\n                @html = jade.render content, options\n            catch error\n                console.log error\n            finally\n                process.chdir cwd\n            return @html\n\n## Page loader\n\n    class Page\n\nA nice \/regexp?\/ from the\n[dworthen\/js-yaml-front-matter](https:\/\/github.com\/dworthen\/js-yaml-front-matter\/blob\/master\/lib\/js-yaml-front.js)\nrepo to separate the YAML front matter from the JADE page content.\n\n        re: \/^(-{3}(?:\\n|\\r)([\\w\\W]+?)(?:\\n|\\r)-{3})?([\\w\\W]*)*\/\n\nSet the file name and location\n\n        constructor: (@pageFile, @location = config.pagesPath) ->\n\nRender the HTML\n\n        render: ->\n\nMake sure we have content\n\n            if not @content?\n                if not @pageFile?\n                    throw new Error 'pageFile not set'\n                location = \"#{@location}\/#{@pageFile}\"\n                @content = fs.readFileSync location, 'utf8'\n\nParse the content\n\n            parts = @re.exec @content\n            if ! @frontMatter?\n                @frontMatter = if parts[2]? then yaml.safeLoad parts[2] else {}\n            this[key] = value for key, value of @frontMatter\n            if ! @containerContent?\n                @containerContent = jade.render parts[3] or '',\n                    filename: @pageFile\n                    pretty: config.pretty\n\nParse the template\n\n            template = new Template @template or null\n            @html = template.getHtml this\n\nWrite the page into the output directory. I might move this to a separate\nfunction (class) later on maybe?\n\n        write: ->\n            folder = \"#{config.htmlPath}#{@url}\"\n            mkdirp folder unless fs.existsSync folder\n            fs.writeFileSync \"#{folder}\/index.html\", @html\n\n#### Blog\n\nIt's the blog index page.\n\n    class Blog extends Page\n        posts: []\n        content: ''\n        template: 'blog'\n        title: 'Blog'\n        url: '\/blog'\n\n#### Pages\n\nIterate through a given directory and process the given pages.\n\nEach page is pushed into a list of pages that will later be used for blog building\nand sitemap.xml\n\n    class Pages\n        constructor: (@location) ->\n            @pages = []\n        render: ->\n            for pageFile in (fs.readdirSync @location).reverse()\n                page = new Page pageFile, @location\n                page.render()\n                page.write()\n                @pages.push page\n\n#### Blogs\n\nDo the Pages thing and build a blog index on top.\n\n    class Blogs extends Pages\n        render: ->\n            super()\n            blog = new Blog\n            blog.posts = @pages\n            do blog.render\n            do blog.write\n\n# Render\n\n    pages = new Pages config.pagesPath\n    pages.render()\n    blogs = new Blogs config.blogPath\n    blogs.render()\n","old_contents":"# The build script\n\nThis is a very simple build script that puts together the YAML + JADE page files\nand the pure JADE template files. It also builds the blog index.\n\nLoad modules\n\n    fs = require 'fs'\n    mkdirp = require('mkdirp').sync;\n    jade = require 'jade'\n    yaml = require 'js-yaml'\n    config = require '.\/config'\n\n### Template loader\n\nTemplates are different from pages in that they don't have a YAML front matter.\nThey are written in clean jade and can extend and include other templates.\n\n    class Template\n        constructor: (@name = 'page', @location = config.templatesPath) ->\n        getHtml: (options) ->\n            cwd = process.cwd()\n            options.pretty = config.pretty\n            options.filename = @name\n            try\n                process.chdir @location\n                content = fs.readFileSync \"#{@name}.jade\", 'utf8'\n                @html = jade.render content, options\n            catch error\n                console.log error\n            finally\n                process.chdir cwd\n            return @html\n\n## Page loader\n\n    class Page\n\nA nice \/regexp?\/ from the\n[dworthen\/js-yaml-front-matter](https:\/\/github.com\/dworthen\/js-yaml-front-matter\/blob\/master\/lib\/js-yaml-front.js)\nrepo to separate the YAML front matter from the JADE page content.\n\n        re: \/^(-{3}(?:\\n|\\r)([\\w\\W]+?)(?:\\n|\\r)-{3})?([\\w\\W]*)*\/\n\nSet the file name and location\n\n        constructor: (@pageFile, @location = config.pagesPath) ->\n\nRender the HTML\n\n        render: ->\n\nMake sure we have content\n\n            if not @content?\n                if not @pageFile?\n                    throw new Error 'pageFile not set'\n                location = \"#{@location}\/#{@pageFile}\"\n                @content = fs.readFileSync location, 'utf8'\n\nParse the content\n\n            parts = @re.exec @content\n            if ! @frontMatter?\n                @frontMatter = if parts[2]? then yaml.safeLoad parts[2] else {}\n            this[key] = value for key, value of @frontMatter\n            if ! @containerContent?\n                @containerContent = jade.render parts[3] or '',\n                    filename: @pageFile\n                    pretty: config.pretty\n\nParse the template\n\n            template = new Template @template or null\n            @html = template.getHtml this\n\nWrite the page into the output directory. I might move this to a separate\nfunction (class) later on maybe?\n\n        write: ->\n            folder = \"#{config.htmlPath}#{@url}\"\n            mkdirp folder unless fs.existsSync folder\n            fs.writeFileSync \"#{folder}\/index.html\", @html\n\n#### Blog\n\nIt's the blog index page.\n\n    class Blog extends Page\n        posts: []\n        content: ''\n        template: 'blog'\n        title: 'Blog'\n        url: '\/blog'\n\n#### Pages\n\nIterate through a given directory and process the given pages.\n\nEach page is pushed into a list of pages that will later be used for blog building\nand sitemap.xml\n\n    class Pages\n        constructor: (@location) ->\n            @pages = []\n        render: ->\n            for pageFile in (fs.readdirSync @location).reverse()\n                page = new Page pageFile, @location\n                page.render()\n                page.write()\n                @pages.push page\n\n#### Blogs\n\nDo the Pages thing and build a blog index on top.\n\n    class Blogs extends Pages\n        render: ->\n            super()\n            blog = new Blog\n            blog.posts = @pages\n            do blog.render\n            do blog.write\n\n# Render\n\n    pages = new Pages config.pagesPath\n    pages.render()\n    blogs = new Blogs config.blogPath\n    blogs.render()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c05e6994b97faa23337560128cef751977f571fd","subject":"Fix bug with negative dates #22.","message":"Fix bug with negative dates #22.\n\nWhen dates were with negative number of years, it didn't work as it should.  This was fixed by checking reminder of years.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.  The main classes are exported as a Node module.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n    3. [Node module exports](#node-module-exports)\n    4. [Helper code](#helper-code)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatMultiLaneAxis()`:  builds ticks and labels in several lanes, so that it is possible to see exactly which interval is displayed;  each lane shows ticks and labels for different interval types (time (up to hours), days, months, years).  Up to four lanes are displayed then.\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.  Only desired label\/tick tightness is supplied as an option.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.tickLaneMultiplier`:  how much tick length is multiplied while on next lane from current lane.\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n * `options.laneOffset`: absolute offset between lanes.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          tickLaneMultiplier: options.tickLaneMultiplier ? 1.5\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n          laneOffset: options.laneOffset ? 30\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatMultiLaneAxis()` function ####\n\nThis function makes axis look like several axes stacked together, from smaller time intervals to larger, until years are shown.  That makes it complete, providing full information about the corresponding time interval.  It's arguments and return value are the same as for `formatAutomatic()`.\n\n      formatMultiLaneAxis: (interval, width, tightness = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\n__TODO__:  fix saving options.\n\n        oldAxisLineOffset = @options.axisLineOffset\n\nIn the beginning we format the first lane using `formatAutomatic()`:\n\n        features = @formatAutomatic interval, width, tightness\n\nThen, we need to format lanes one by one, increasing interval type, until we it is equal to 'years'.  `intervalMultiplier` will be equal to one always on these lanes.\n\n__Note__:  switch could be changed to some array progression, should it be done?\n\n        @options.intervalMultiplier = 1\n        @options.labelPlacement = 'interval'\n        while @options.intervalType isnt 'year'\n\nWe increase interval to the next interval type interval.\n\n          switch @options.intervalType\n            when 'millisecond', 'second', 'minute', 'hour'\n              @options.intervalType = 'day'\n            when 'day', 'week'\n              @options.intervalType = 'month'\n            when 'month'\n              @options.intervalType = 'year'\n\nNow we format a lane using the new interval type and multiplier, and after changing placement options.  New data is merged with previous data.\n\n__Note__:  merging code should be done in some other function. Refactor.\n\n          @options.axisLineOffset += @options.laneOffset\n          newLane = @formatFixed interval, width\n          features =\n            lines: features.lines.concat newLane.lines\n            textLabels: features.textLabels.concat newLane.textLabels\n\n__TODO__:  these horrible options restoration shoud be rewritten with the whole otpions and argument system.\n\n        @options.axisLineOffset = oldAxisLineOffset\n        features\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width, tightness = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval.  Depending on `intervalType` we choose interval or point label placement.\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        switch @options.intervalType\n          when 'year', 'month', 'week', 'day'\n            @options.labelPlacement = 'interval'\n          else\n            @options.labelPlacement = 'point'\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: @options.axisLineOffset + -@options.tickLength * @options.tickTailRatio\n            y2: @options.axisLineOffset + @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.axisLineOffset + @options.labelOffset\n            text: @formatLabel timePoint, @options\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        if @options.labelPlacement is 'interval'\n          for textLabel, i in textLabels when i isnt (textLabels.length-1)\n            textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n          textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (week is just 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\nA special consideration is negative dates and dates before Epoch.  We need to treat them correctly too.  Arithmetic remainder function in JavaScript return negative remainder if dividend is negative.  Because of that we add divisor to such remainder in case of negative years.\n\nBut if dates are outside of allowed by JavaScript ranges (\u00b11000000000 dates from Epoch) then the behaviour is not defined.\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            yearReminder = start.getFullYear() % @options.intervalMultiplier\n            if yearReminder < 0\n              yearReminder += @options.intervalMultiplier\n            newYear = start.getFullYear() - yearReminder\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n\nHere it can happen that `start` is actually earlier than Epoch.  Then we decrease `leftTime` first:\n\n            if start < leftTime\n              delta = 1\n              while start <= leftTime\n                leftTime = new Date leftTime.getFullYear(),\n                  leftTime.getMonth()\n                  leftTime.getDate() - delta*intervalMultiplier\n                  leftTime.getHours()\n                  leftTime.getMinutes()\n                  leftTime.getSeconds()\n                  leftTime.getMilliseconds()\n                delta *= 2\n\nNow we move forwart until we find the right point:\n\n            delta = 1048576\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `formatLabel` function ####\n\nThis function returns text representation of date.\n\n      formatLabel: (timePoint, options) ->\n        switch options.intervalType\n          when 'year'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setFullYear(nextTimePoint.getFullYear() - 1)\n              timePoint.getFullYear().toString() +\n                '\u2013' + nextTimePoint.getFullYear()\n            else\n              timePoint.getFullYear().toString()\n          when 'month'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMonth(nextTimePoint.getMonth() - 1)\n              timePoint.getMonth().toString() +\n                '\u2013' + nextTimePoint.getMonth().toString()\n            else\n              timePoint.getMonth().toString()\n          when 'week'\n            if options.labelPlacement is 'interval'\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'day'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'hour'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setHours(nextTimePoint.getHours())\n              timePoint.getHours().toString() +\n                '\u2013' + nextTimePoint.getHours().toString()\n            else\n              timePoint.getHours().toString()\n          when 'minute'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMinutes(nextTimePoint.getMinutes())\n              timePoint.getMinutes().toString() +\n                '\u2013' + nextTimePoint.getMinutes().toString()\n            else\n              timePoint.getMinutes().toString()\n          when 'second'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setSeconds(nextTimePoint.getSeconds())\n              timePoint.getSeconds().toString() +\n                '\u2013' + nextTimePoint.getSeconds().toString()\n            else\n              timePoint.getSeconds().toString()\n          when 'millisecond'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMilliseconds(nextTimePoint.getMilliseconds())\n              \".#{ timePoint.getMilliseconds() }\u2013.#{ nextTimePoint.getMilliseconds() }\"\n            else\n              \".#{ timePoint.getMilliseconds() }\"\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\n### Node module exports\n\nBoth `TimeAxisMaker` and `TimeAxisRenderer` are exported.\n\nWe temporarily disable it.\n\n    #module.exports =\n      #TimeAxisMaker: TimeAxisMaker\n      #TimeAxisRenderer: TimeAxisRenderer\n\n### Helper code\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker({})\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      timeAxisRedrerer = new TimeAxisRenderer()\n\nCode that draws builds and draws axis is also moved in a function:\n\n      makeAxis = ->\n        axisData = timeAxisMaker.formatMultiLaneAxis {start, end}, canvas.width, 15\n        timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nInitial drawing:\n\n      do makeAxis\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          do makeAxis\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          do makeAxis\n\nWe run the `makeDemo` function when page loads.\n\n__TODO__:  we need to put example in another file.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.  The main classes are exported as a Node module.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n    3. [Node module exports](#node-module-exports)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatMultiLaneAxis()`:  builds ticks and labels in several lanes, so that it is possible to see exactly which interval is displayed;  each lane shows ticks and labels for different interval types (time (up to hours), days, months, years).  Up to four lanes are displayed then.\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.  Only desired label\/tick tightness is supplied as an option.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.tickLaneMultiplier`:  how much tick length is multiplied while on next lane from current lane.\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n * `options.laneOffset`: absolute offset between lanes.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          tickLaneMultiplier: options.tickLaneMultiplier ? 1.5\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n          laneOffset: options.laneOffset ? 30\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatMultiLaneAxis()` function ####\n\nThis function makes axis look like several axes stacked together, from smaller time intervals to larger, until years are shown.  That makes it complete, providing full information about the corresponding time interval.  It's arguments and return value are the same as for `formatAutomatic()`.\n\n      formatMultiLaneAxis: (interval, width, tightness = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\n__TODO__:  fix saving options.\n\n        oldAxisLineOffset = @options.axisLineOffset\n\nIn the beginning we format the first lane using `formatAutomatic()`:\n\n        features = @formatAutomatic interval, width, tightness\n\nThen, we need to format lanes one by one, increasing interval type, until we it is equal to 'years'.  `intervalMultiplier` will be equal to one always on these lanes.\n\n__Note__:  switch could be changed to some array progression, should it be done?\n\n        @options.intervalMultiplier = 1\n        @options.labelPlacement = 'interval'\n        while @options.intervalType isnt 'year'\n\nWe increase interval to the next interval type interval.\n\n          switch @options.intervalType\n            when 'millisecond', 'second', 'minute', 'hour'\n              @options.intervalType = 'day'\n            when 'day', 'week'\n              @options.intervalType = 'month'\n            when 'month'\n              @options.intervalType = 'year'\n\nNow we format a lane using the new interval type and multiplier, and after changing placement options.  New data is merged with previous data.\n\n__Note__:  merging code should be done in some other function. Refactor.\n\n          @options.axisLineOffset += @options.laneOffset\n          newLane = @formatFixed interval, width\n          features =\n            lines: features.lines.concat newLane.lines\n            textLabels: features.textLabels.concat newLane.textLabels\n\n__TODO__:  these horrible options restoration shoud be rewritten with the whole otpions and argument system.\n\n        @options.axisLineOffset = oldAxisLineOffset\n        features\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width, tightness = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval.  Depending on `intervalType` we choose interval or point label placement.\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        switch @options.intervalType\n          when 'year', 'month', 'week', 'day'\n            @options.labelPlacement = 'interval'\n          else\n            @options.labelPlacement = 'point'\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: @options.axisLineOffset + -@options.tickLength * @options.tickTailRatio\n            y2: @options.axisLineOffset + @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.axisLineOffset + @options.labelOffset\n            text: @formatLabel timePoint, @options\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        if @options.labelPlacement is 'interval'\n          for textLabel, i in textLabels when i isnt (textLabels.length-1)\n            textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n          textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n\nHere it can happen that `start` is actually earlier than Epoch.  Then we decrease `leftTime` first:\n\n            if start < leftTime\n              delta = 1\n              while start <= leftTime\n                leftTime = new Date leftTime.getFullYear(),\n                  leftTime.getMonth()\n                  leftTime.getDate() - delta*intervalMultiplier\n                  leftTime.getHours()\n                  leftTime.getMinutes()\n                  leftTime.getSeconds()\n                  leftTime.getMilliseconds()\n                delta *= 2\n\nNow we move forwart until we find the right point:\n\n            delta = 1048576\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds 0, 0\n            nextTime = leftTime\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `formatLabel` function ####\n\nThis function returns text representation of date.\n\n      formatLabel: (timePoint, options) ->\n        switch options.intervalType\n          when 'year'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setFullYear(nextTimePoint.getFullYear() - 1)\n              timePoint.getFullYear().toString() +\n                '\u2013' + nextTimePoint.getFullYear()\n            else\n              timePoint.getFullYear().toString()\n          when 'month'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMonth(nextTimePoint.getMonth() - 1)\n              timePoint.getMonth().toString() +\n                '\u2013' + nextTimePoint.getMonth().toString()\n            else\n              timePoint.getMonth().toString()\n          when 'week'\n            if options.labelPlacement is 'interval'\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'day'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'hour'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setHours(nextTimePoint.getHours())\n              timePoint.getHours().toString() +\n                '\u2013' + nextTimePoint.getHours().toString()\n            else\n              timePoint.getHours().toString()\n          when 'minute'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMinutes(nextTimePoint.getMinutes())\n              timePoint.getMinutes().toString() +\n                '\u2013' + nextTimePoint.getMinutes().toString()\n            else\n              timePoint.getMinutes().toString()\n          when 'second'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setSeconds(nextTimePoint.getSeconds())\n              timePoint.getSeconds().toString() +\n                '\u2013' + nextTimePoint.getSeconds().toString()\n            else\n              timePoint.getSeconds().toString()\n          when 'millisecond'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMilliseconds(nextTimePoint.getMilliseconds())\n              \".#{ timePoint.getMilliseconds() }\u2013.#{ nextTimePoint.getMilliseconds() }\"\n            else\n              \".#{ timePoint.getMilliseconds() }\"\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\n### Node module exports\n\nBoth `TimeAxisMaker` and `TimeAxisRenderer` are exported.\n\nWe temporarily disable it.\n\n    #module.exports =\n      #TimeAxisMaker: TimeAxisMaker\n      #TimeAxisRenderer: TimeAxisRenderer\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker({})\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      timeAxisRedrerer = new TimeAxisRenderer()\n\nCode that draws builds and draws axis is also moved in a function:\n\n      makeAxis = ->\n        axisData = timeAxisMaker.formatMultiLaneAxis {start, end}, canvas.width, 15\n        timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nInitial drawing:\n\n      do makeAxis\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          do makeAxis\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          do makeAxis\n\nWe run the `makeDemo` function when page loads.\n\n__TODO__:  we need to put example in another file.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d67f9b4065bdfbad92923cf5001cc8f3de22da8e","subject":"in. jokes","message":"in. jokes\n","repos":"nomilous\/in.","old_file":"in.jokes\/spandex.litcoffee","new_file":"in.jokes\/spandex.litcoffee","new_contents":"#! \/usr\/bin\/env coffee\n\nThe expander supports multiple asyncronous functions that `appear = syncronous()`.\n\nTo achieve that it needed to do some peculiar things.\n\n__Very peculiar!__\n\nThings that [some](https:\/\/www.google.co.za\/search?q=uptight+people&espv=2&biw=1063&bih=1058&source=lnms&tbm=isch&sa=X&ei=q6CJVYTyIpPB7Ab95YLQBA&ved=0CAYQ_AUoAQ#tbm=isch&q=uptight) may disaprove of.\n\nLike wearing [spandex in public](https:\/\/www.google.co.za\/search?q=spandex+in+public+nuts&espv=2&biw=1063&bih=1058&tbm=isch&source=lnms&sa=X&ei=5Z-JVez6KeWY7gbl_oCYAg&ved=0CAYQ_AUoAQ#tbm=isch&q=spandex+in+public).\n\nIt broke the [expan](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/expander.js)sion (to be [eval](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/compiler.js#L57)'d) [into pieces and substituted](https:\/\/www.google.co.za\/search?q=into+pieces+and+substituted+an+array&es_sm=91&source=lnms&tbm=isch&sa=X&ei=laOJVbKFOqKM7Abs4Y_ACw&ved=0CAkQ_AUoAw&biw=1063&bih=1058#tbm=isch&q=into+pieces+and+substituted) an array ($e[n]) for each function's results.\n\nThe results of the division are loaded into a variable called `spandex`...\n\nWhich happens to be in scope at injection eval.\n\n    require('..\/')\n\n    $$in (arg) ->\n\n        ### in(arg).as {{1}}###\n\n        console.log arg\n\n\n#### Return and finish later - few bits still to wire together\n","old_contents":"#! \/usr\/bin\/env coffee\n\nThe expander supports multiple asyncronous functions that `appear = syncronous()`.\n\nTo achieve that it needed to do some peculiar things.\n\n__Very peculiar!__\n\nThings that [some](https:\/\/www.google.co.za\/search?q=uptight+people&espv=2&biw=1063&bih=1058&source=lnms&tbm=isch&sa=X&ei=q6CJVYTyIpPB7Ab95YLQBA&ved=0CAYQ_AUoAQ#tbm=isch&q=uptight) may disaprove of.\n\nLike wearing [spandex in public](https:\/\/www.google.co.za\/search?q=spandex+in+public+nuts&espv=2&biw=1063&bih=1058&tbm=isch&source=lnms&sa=X&ei=5Z-JVez6KeWY7gbl_oCYAg&ved=0CAYQ_AUoAQ#tbm=isch&q=spandex+in+public).\n\nIt broke the [expan](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/expander.js)sion (to be [eval](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/compiler.js#L57)'d) [into pieces and substituted](https:\/\/www.google.co.za\/search?q=into+pieces+and+substituted+an+array&es_sm=91&source=lnms&tbm=isch&sa=X&ei=laOJVbKFOqKM7Abs4Y_ACw&ved=0CAkQ_AUoAw&biw=1063&bih=1058#tbm=isch&q=into+pieces+and+substituted) an array ($e[n]) for each function's results.\n\nThen pipelined the fuctions to produce ($e) so that the final eval\n\n`{{ i for an.i in ( an = $e[0] ) }}`\n\nWhere `$e[0]` was originally `async(fn1)`\n\n`{{ i for an.i in ( an = async(fn1) ) }}`\n\nThe results of the division are loaded into a variable called `spandex`...\n\nWhich happens to be in scope at eval.\n\n    require('..\/')\n\n    $$in (arg) ->\n\n        ### in(arg).as {{1}}###\n\n        console.log arg\n\n\n#### Return and finish later - few bits still to wire together\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"09e27138506e889547d1fdffc42c9fdcda5699ab","subject":"fill out api docs","message":"fill out api docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/12_storage_adapters.litcoffee","new_file":"docs\/12_storage_adapters.litcoffee","new_contents":"# Batman.StorageAdapter\n\n`Batman.StorageAdapter`s handle persistence of [`Batman.Model`s](\/docs\/api\/batman.model.html). Any `Batman.Model` which will be created, read, updated or deleted must have a storage adapter, which is declared with [`Batman.Model@persist`](\/docs\/api\/batman.model.html#class_function_persist):\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @persist Batman.RestStorage # a StorageAdapter subclass\n```\n\n__Protip:__ Consider setting the storage adapter in one `Batman.Model` subclass, then extending that subclass in the rest of your app. Then, you won't have to call `@persist` every time:\n\n```coffeescript\nclass App.Model extends Batman.Model\n  @persist Batman.LocalStorage\n\nclass App.Superhero extends App.Model\n  # no need to call @persist here!\n\nclass App.Sidekick extends App.Model\n  # or here!\n```\n\n### Batman's Included StorageAdapters\n\nBatman ships with a few storage adapters to get you up and coding quickly:\n\n- `Batman.LocalStorage` uses [`window.localStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#localStorage) to persist records.\n- `Batman.SessionStorage` extends `Batman.LocalStorage` and uses [`window.sessionStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#sessionStorage) to persist records.\n- `Batman.RestStorage` uses [HTTP REST](http:\/\/en.wikipedia.org\/wiki\/REST) to persist records, mapping HTTP verbs to storage operations and handling HTTP response codes appropriately. _Note: Because `Batman.RestStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implmentation_libraries) to implement `Batman.Request`._\n\n### Batman.RailsStorage\nAlso, `Batman.RailsStorage` (available in separate file: [Coffee](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.rails.coffee), JS) extends `Batman.RestStorage` and provides some helpful Rails integrations:\n\n- If the response's status code is 422 (`Unprocessable Entity`), Any `errors` defined in the JSON response will be added to the `Batman.Model`'s [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n- By default, Batman will get the Rails CSRF token from the `<head>`and send it as a request header. (This can be prevented by setting `Batman.config.protectFromCSRF = false`.)\n- If a record's URL doesn't end in `.json` and doesn't include a query string, `.json` is automatically appended to the URL.\n\n\n_Note: Like `Batman.RestStorage`, `Batman.RailsStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), so you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implmentation_libraries) to implement `Batman.Request`._\n\n## Subclassing Batman.StorageAdapter\n\nYou may want to customize Batman's storage operations for your own app, for example:\n\n- Adding before- and after-operation callbacks\n- Overriding default storage operations\n\nTo do this, extend `Batman.StorageAdapter` (or one of the provided subclasses), then use your storage adapter to persist your models.\n```\nclass App.HeroicStorageAdapter extends Batman.LocalStorage\n  # filters, overrides\n\nclass App.Superhero extends Batman.Model\n  @persist App.HeroicStorageAdapter\n```\n### `env` and `next`\n\nStorage operations and callbacks each take two arguments: `env` and `next`.\n\n`env` is a vanilla JS object which is passed to each function in the chain. `Batman.StorageAdapter` sets these attributes on `env`:\n\n- `env.subject` is the `Batman.Model` record which had the storage operation called on it.\n- `env.options` is an object containing the options passed when the operations was called on the subject.\n- `env.action` is the storage operation that will be executed by the storage adapter.\n- `env.error` stores any errors that occur during the chain. It becomes the first argument to them model's callback.\n- `env.result` must be set by the `Batman.StorageAdapter` subclass after the operation is complete. It is a copy of the record and it becomes the second argument to the model's callback.\n\nStorage adapters may use `env` to gather information and use it in its operations. For example, `Batman.RestStorage` adds some attributes to `env` and `env.options`:\n\n- `env.request` is the `Batman.Request` which implements the storage operation.\n- `env.options.method` is the HTTP method used by `Batman.Request` to implement the storage operation.\n- `env.options.url` is the URL used by `Batman.Request` to implement the storage operation.\n\n`next` is a reference to the next operation in the call chain. Any operation must call `next()`, otherwise the call chain will not continue. To ensure the completion of the call chain, consider wrapping your function in [`@nextIfError`](\/docs\/api\/batman.storageadapter.html#class_function_nextiferror).\n\n\n### Adding Callbacks\n\nCallbacks can be registered with [`before`](\/docs\/api\/batman.storageadapter.html#prototype_function_before) and [`after`](\/docs\/api\/batman.storageadapter.html#prototype_function_after) on any storage operation (listed below) or `'all'` (which runs the callback before or after any operation). Callbacks accept two arguments, `env` and `next`, discussed below.\n\n```coffeescript\nclass App.SpecificHeaderStorageAdapter extends Batman.RestStorage\n  # include a specific header in all requests:\n  @::before 'all', (env, next) ->\n    headers = env.options.headers || {}\n    headers[\"App-Specific-Header\"] = App.getSpecificHeader()\n    next()\n\n  @::after 'create', (env, next) ->\n    console.log \"A #{env.subject.constructor.name} was created!\"\n    next()\n```\n\n### Storage Operations\n\nAny `StorageAdapter` must implement these operations as instance methods, for example:\n```\nclass App.ModifiedStorageAdapter extends Batman.RestStorage\n  destroy: (env, next) ->\n    # your custom destroy operation\n    next()\n```\n\n## ::create(env : Object, next : Function)\n\nSaves a new record. When `save` is called on a record and `isNew` returns `true`, the storage adapter's `create` method is called.\n\n## ::read(env : Object, next : Function)\n\nLoads a record from storage into a Batman app.\n\n## ::update(env : Object, next : Function)\n\nUpdates an existing record. When `save` is called on a record and `isNew` returns `false`, the storage adapter's `save` method is called.\n\n## ::destroy(env : Object, next : Function)\n\nDestroys an existing record.\n\n## ::readAll(env : Object, next : Function)\n\nLoads all instances of a `Batman.Model` from storage into memory.\n\n### Other useful methods\n\n## @nextIfError(wrappedFunction : Function )\n\nWraps functions in the call chain, bypassing the function body and calling `next()` if `env.error?`\nOtherwise, calls the wrapped function with `env` and `next`.\n\n    test \"StorageAdapter@skipIfError doesn't call the function if env.error?\", ->\n      insideFunction = createSpy()\n      nextFunction = createSpy()\n\n      functionWithWrapper = Batman.LocalStorage.skipIfError (env, next) ->\n        insideFunction()\n\n      dummyEnv = {error: true}\n\n      functionWithWrapper(dummyEnv, nextFunction)\n\n      equal dummyEnv.error?, true, 'an error is present'\n      equal insideFunction.called, false, 'insideFunction was skipped'\n      equal nextFunction.called, true, 'nextFunction was called'\n\nNote that inside a storage adapter definition, this function is referenced as `@skipIfError`, for example:\n\n```\nclass App.SpecialStorageAdapter extends Batman.RestStorage\n  @::before 'create', @skipIfError (env, next) ->\n    console.log(\"This will be skipped if env.error? is true!\")\n    next()\n```\n\n## ::before (keys... : Strings, filter : Function)\n\nRegisters `filter` as a before-operation callback for the storage operations named by `keys...`.\n\n## ::after (keys... : Strings, filter : Function)\n\nRegisters `filter` as a after-operation callback for the storage operations named by `keys...`.\n","old_contents":"# Batman.StorageAdapter\n\n`Batman.StorageAdapter`s handle persistence of [`Batman.Model`s](\/docs\/api\/batman.model.html). Any `Batman.Model` which will be persisted must have a storage adapter, which is declared with [`Batman.Model@persist`](\/docs\/api\/batman.model.html#class_function_persist):\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @persist Batman.RestStorage # a StorageAdapter subclass\n```\n\n__Protip:__ Consider setting the storage adapter in one `Batman.Model` subclass, then extending that subclass in the rest of your app. Then, you won't have to call `@persist` every time:\n\n```coffeescript\nclass App.Model extends Batman.Model\n  @persist Batman.LocalStorage\n\nclass App.Superhero extends App.Model\n  # no need to call @persist here!\n\nclass App.Sidekick extends App.Model\n  # or here!\n```\n\n### Batman's Included StorageAdapters\n\nBatman ships with a few storage adapters to help you get up and coding quickly:\n\n- `Batman.LocalStorage` uses `window.localStorage` to persist records.\n- `Batman.SessionStorage` extends `Batman.LocalStorage` and uses `window.sessionStorage` to persist records.\n- `Batman.RestStorage` uses [HTTP REST](http:\/\/en.wikipedia.org\/wiki\/REST) to persist records, mapping HTTP verbs to storage operations and handling HTTP response codes appropriately. _Note: Because `Batman.RestStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implmentation_libraries) to implement `Batman.Request`._\n\n### Batman.RailsStorage\nAlso, `Batman.RailsStorage` (available in separate file: [Coffee](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.rails.coffee), [JS](#)) extends `Batman.RestStorage` and provides some helpful Rails integrations:\n\n- If the response's status code is 422 (`Unprocessable Entity`), Any `errors` defined in the JSON response will be added to the `Batman.Model`'s [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n- By default, Batman will get the Rails CSRF token from the `<head>`and send it as a request header. (This can be prevented by setting `Batman.config.protectFromCSRF = false`.)\n- If a record's URL doesn't end in `.json` and doesn't include a query string, `.json` is automatically appended to the URL.\n\n\n_Note: Like `Batman.RestStorage`, `Batman.RailsStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), so you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implmentation_libraries) to implement `Batman.Request`._\n\n## Subclassing Batman.StorageAdapter\n\nYou may want to customize Batman's storage operations for your own app, for example:\n\n- Adding before- and after-operation callbacks\n- Overriding default storage operations\n\nTo do this, extend `Batman.StorageAdapter` (or one of the provided subclasses), then use your storage adapter to persist your models.\n```\nclass HeroicStorageAdapter extends Batman.LocalStorage\n  # filters, overrides\n\nclass App.Superhero extends Batman.Model\n  @persist App.HeroicStorageAdapter\n```\n### `env` and `next`\n\nStorage operations and callbacks each take two arguments: `env` and `next`.\n\n`env` in a vanilla JS object which is passed to each function in the chain. `Batman.StorageAdapter` expects at least two attributes:\n\n- `env.subject` is the `Batman.Model` record which had the storage operation called on it.\n- `env.options` is an object containing the options passed when the operations was called on the subject.\n\n        test \"env.subject and env.options are present in storage adapter calls\", ->\n          spiedEnvSubject = false\n          spiedEnvOptions = false\n\n          class SpyStorageAdapter extends TestStorageAdapter\n            @::before 'create', 'update' (env, next) ->\n              console.log \"Spying!\", env, next\n              spiedEnvSubject = env.subject\n              spiedEnvOptions = env.options\n              next()\n\n          class SpyModel extends Batman.Model\n            @persist SpyStorageAdapter\n\n          @spy = new SpyModel\n          saveOptions = {someKey: \"someValue\"}\n          @spy.save saveOptions, (err, savedSpy) ->\n            throw err if err\n\n          console.log @spy, spiedEnvSubject\n          console.log saveOptions, spiedEnvOptions\n\n          equal undefined, spiedEnvSubject.message\n          equal spiedEnvSubject, @spy.toJSON()\n          equal spiedEnvOptions, saveOptions\n\n`next` is a reference to the next operation in the call chain. Any operation must call `next()`, otherwise the call chain will fail.\n\n\n### Adding Callbacks\n\nCallbacks can be registered on any storage operation (listed below). Callbacks accept\n\n```coffeescript\nclass App.SpecificHeaderStorageAdapter extends Batman.RestStorage\n  # include a specific header in all requests:\n  @::before 'all' (env, next) ->\n    headers = env.options.headers || {}\n    headers[\"App-Specific-Header\"] = App.getSpecificHeader()\n    next()\n\n  @::after 'create', (env, next) ->\n    console.log \"A #{env.subject.constructor.name} was created!\"\n    next()\n```\n\n### Storage operations\n\nAny `StorageAdapter` must implement these operations as instance methods, for example:\n```\nclass App.ModifiedStorageAdapter extends Batman.RestStorage\n  destroy: (env, next) ->\n    # your alternative destroy operation\n    next()\n```\n\n## ::create(env : Object, next : Function)\n\nWhen `save` is called on a record and `isNew` returns\n\n## ::read(env : Object, next : Function)\n\n## ::update(env : Object, next : Function)\n\n## ::destroy(env : Object, next : Function)\n\n## ::readAll(env : Object, next : Function)\n\n### Other useful methods\n\n## @nextIfError(wrappedFunction : Function )\n\nWraps functions in the call chain, bypassing the function body and calling `next()` if `env.error?`\nOtherwise, calls the wrapped function with `env` and `next`.\n\n    test \"StorageAdapter@skipIfError doesn't call the function if env.error?\", ->\n      insideFunctionWasCalled = false\n      nextFunctionWasCalled = false\n\n      insideFunction = ->\n        insideFunctionWasCalled = true\n\n      nextFunction = ->\n        nextFunctionWasCalled = true\n\n      functionWithWrapper = Batman.LocalStorage.skipIfError (env, next) ->\n        insideFunction() # would set insideFunctionWasCalled to true\n\n      dummyEnv = {error: true}\n\n      functionWithWrapper(dummyEnv, nextFunction)\n\n      equal nextFunctionWasCalled, true\n      equal insideFunctionWasCalled, false\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4e81d9bff0a55cc195be1471702291815e527e47","subject":"add a horizontal rule","message":"add a horizontal rule\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/policies.litcoffee","new_file":"guts\/policies.litcoffee","new_contents":"Policies\n--------\nThis is the glue-file that manages how user-policies (e.g. who's allowed to do what) get defined.  This file is responsible for grabbing the \n\nLoad in the required libraries\n\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n\nLoad up the user-defined policies. \n\n    policies = require '..\/config\/policies'\n\n\nStart the function.  We're expecting an array of objects with the fields `actionName` and `controllerName`, and the node `req` and `res` objects just in case the policies need them.\n\n    module.exports = (routeActions, req, res) ->\n\nWe want to reject or resolve the promise based on whether or not someone is allowed to do something.  Therefore, it'd be smart to wrap this in a promise.\n\n        new Promise (resolve, reject) ->\n\nLet's load up the helper function that grabs all the policy files.  This function was arguably useful in its own right, so it made sense to make it its own separate module. \n\n            require('.\/getPolicies')()\n\nOnce the policies are done loading, we can move on. \n\n            .then (actualPolicies) ->\n\nSince there is an array routeActions (purposefully), we need to loop through them, and since we need the result afterwards, we can use a map.  Also, since there is a small risk of a couple nested arrays (due to the way that the policies have been implemented, lets flatten it after we're done. \n                \n                policyResults = _.flatten _.map routeActions, (action) ->\n\n*****\n                    \nWhat I'm doing here is looking for the policies file.\nIf there is a policy defined for that action, use that, else use the * catch all.\n\nThe flatten is necessary simply because I don't want to punish people for only listing one policy outside of an array.  Subsequently, we'll wrap everything in an array and then flatten it. \n\n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\nThis is pretty straightforward; we'll loop up the policy in the hash\ntable and then return back their result (which can just be a true or false\n\nWe want to make sure this is properly wrapped in promisey stuff, so we can init\nan empty promise then run our stuff in the \"then\". Since our empty promise only\nresolves, it won't hit the catch. \n\n                        _.map tempPolicies, (policy) ->\n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n\nOnce all the policy promises have resolved, let's return out response.\n                \n                Promise.all policyResults\n                .then (results) ->\n                    # Not entirely sure I like this logic, but it's pretty straightforward:\n                    # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                    # either allow the policy to reject if not permitted or to simply return false. \n                    unless false in results\n                      resolve true\n                    else\n                      reject \"Not Authorized\"\n                \n","old_contents":"Policies\n--------\nThis is the glue-file that manages how user-policies (e.g. who's allowed to do what) get defined.  This file is responsible for grabbing the \n\nLoad in the required libraries\n\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n\nLoad up the user-defined policies. \n\n    policies = require '..\/config\/policies'\n\n\nStart the function.  We're expecting an array of objects with the fields `actionName` and `controllerName`, and the node `req` and `res` objects just in case the policies need them.\n\n    module.exports = (routeActions, req, res) ->\n\nWe want to reject or resolve the promise based on whether or not someone is allowed to do something.  Therefore, it'd be smart to wrap this in a promise.\n\n        new Promise (resolve, reject) ->\n\nLet's load up the helper function that grabs all the policy files.  This function was arguably useful in its own right, so it made sense to make it its own separate module. \n\n            require('.\/getPolicies')()\n\nOnce the policies are done loading, we can move on. \n\n            .then (actualPolicies) ->\n\nSince there is an array routeActions (purposefully), we need to loop through them, and since we need the result afterwards, we can use a map.  Also, since there is a small risk of a couple nested arrays (due to the way that the policies have been implemented, lets flatten it after we're done. \n                \n                policyResults = _.flatten _.map routeActions, (action) ->\n\n                    \nWhat I'm doing here is looking for the policies file.\nIf there is a policy defined for that action, use that, else use the * catch all.\n\nThe flatten is necessary simply because I don't want to punish people for only listing one policy outside of an array.  Subsequently, we'll wrap everything in an array and then flatten it. \n\n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\nThis is pretty straightforward; we'll loop up the policy in the hash\ntable and then return back their result (which can just be a true or false\n\nWe want to make sure this is properly wrapped in promisey stuff, so we can init\nan empty promise then run our stuff in the \"then\". Since our empty promise only\nresolves, it won't hit the catch. \n\n                        _.map tempPolicies, (policy) ->\n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n\nOnce all the policy promises have resolved, let's return out response.\n                \n                Promise.all policyResults\n                .then (results) ->\n                    # Not entirely sure I like this logic, but it's pretty straightforward:\n                    # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                    # either allow the policy to reject if not permitted or to simply return false. \n                    unless false in results\n                      resolve true\n                    else\n                      reject \"Not Authorized\"\n                \n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"b8a308b41f6d4cc9811e974313cc06d0b741aeaa","subject":"Add getContentHistory","message":"Add getContentHistory\n","repos":"mnmtanish\/vosco-cli","old_file":"lib\/vosco-cli.litcoffee","new_file":"lib\/vosco-cli.litcoffee","new_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    voscoCLI = {}\n\nSetup\n-----\n\n    voscoCLI.install = (callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      if isInstalled then process.exit 1\n      await @original.install defer(error)\n      callback null\n\n    voscoCLI.uninstall = (callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.uninstall defer(error)\n      callback null\n\n    voscoCLI.isInstalled = (callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      callback null, isInstalled\n\nRepository\n----------\n\n    voscoCLI.getStatus = (callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.getStatus defer(error, status)\n      getType = (file) -> file.type\n      getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n      groups  = _.groupBy status, getType\n      for group, paths of groups\n        console.log \"\"\"\n        #{group}\n        #{paths.map(getPath).join(\"\\n\")}\n        \"\"\"\n      callback null\n\n    voscoCLI.getHistory = (callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.getHistory defer(error, history)\n      for commit in history\n        hash = commit.hash.substr(0, 7)\n        date = new Date(commit.date).toDateString()\n        msg  = commit.message\n        console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n      callback null\n\n    voscoCLI.getContentHistory = (path, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.getContentHistory path, defer(error, history)\n      console.log history\n      callback null\n\nSnapshots\n---------\n\n    voscoCLI.previewSnapshot = (hash, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      hash = hash or 'HEAD'\n      await @original.previewSnapshot hash, defer(error, diff)\n      console.log diff\n      callback null\n\n    voscoCLI.createSnapshot = (message, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      message = message or 'Untitled Snapshot'\n      await @original.createSnapshot message, defer(error)\n      callback null\n\n    voscoCLI.rollbackToSnapshot = (hash, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.rollbackToSnapshot hash, defer(error)\n      callback null\n\nBranches\n--------\n\n    voscoCLI.getBranches = (callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.getBranches defer(error, branches, current)\n      for branch in branches\n        branch = if branch is current then \"* #{branch}\" else\n          colors.xterm(240)(\"  #{branch}\")\n        console.log \"#{branch}\"\n      callback null\n\n    voscoCLI.createBranch = (branch, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.createBranch branch, defer(error)\n      callback null\n\n    voscoCLI.selectBranch = (branch, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.selectBranch branch, defer(error)\n      callback null\n\n    voscoCLI.deleteBranch = (branch, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.deleteBranch branch, defer(error)\n      callback null\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      voscoCLI.original = vosco\n      return voscoCLI\n","old_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    voscoCLI = {}\n\nSetup\n-----\n\n    voscoCLI.install = (callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      if isInstalled then process.exit 1\n      await @original.install defer(error)\n      callback null\n\n    voscoCLI.uninstall = (callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.uninstall defer(error)\n      callback null\n\n    voscoCLI.isInstalled = (callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      callback null, isInstalled\n\nRepository\n----------\n\n    voscoCLI.getStatus = (callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.getStatus defer(error, status)\n      getType = (file) -> file.type\n      getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n      groups  = _.groupBy status, getType\n      for group, paths of groups\n        console.log \"\"\"\n        #{group}\n        #{paths.map(getPath).join(\"\\n\")}\n        \"\"\"\n      callback null\n\n    voscoCLI.getHistory = (callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.getHistory defer(error, history)\n      for commit in history\n        hash = commit.hash.substr(0, 7)\n        date = new Date(commit.date).toDateString()\n        msg  = commit.message\n        console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n      callback null\n\n    voscoCLI.getContentHistory = (path, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      # show warning if file doesn\"t exist\n      console.log \"content history for #{path}\"\n      callback null\n\nSnapshots\n---------\n\n    voscoCLI.previewSnapshot = (hash, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      hash = hash or 'HEAD'\n      await @original.previewSnapshot hash, defer(error, diff)\n      console.log diff\n      callback null\n\n    voscoCLI.createSnapshot = (message, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      message = message or 'Untitled Snapshot'\n      await @original.createSnapshot message, defer(error)\n      callback null\n\n    voscoCLI.rollbackToSnapshot = (hash, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.rollbackToSnapshot hash, defer(error)\n      callback null\n\nBranches\n--------\n\n    voscoCLI.getBranches = (callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.getBranches defer(error, branches, current)\n      for branch in branches\n        branch = if branch is current then \"* #{branch}\" else\n          colors.xterm(240)(\"  #{branch}\")\n        console.log \"#{branch}\"\n      callback null\n\n    voscoCLI.createBranch = (branch, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.createBranch branch, defer(error)\n      callback null\n\n    voscoCLI.selectBranch = (branch, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.selectBranch branch, defer(error)\n      callback null\n\n    voscoCLI.deleteBranch = (branch, callback) ->\n      await @original.isInstalled defer(error, isInstalled)\n      unless isInstalled then process.exit 1\n      await @original.deleteBranch branch, defer(error)\n      callback null\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      voscoCLI.original = vosco\n      return voscoCLI\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2effa50d84a11340fd87a0d7a07a89d1087fa3a0","subject":"mark invalid in validate","message":"mark invalid in validate\n","repos":"vpj\/models","old_file":"js\/properties\/value.litcoffee","new_file":"js\/properties\/value.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#Value\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Models.Property.EditBase'\n     'Weya'\n     (PROPERTIES, Base, EditBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       propertyType: 'value'\n\n       @default 'value', (str, stack, isData = false) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value, stack) -> \"#{value}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str, stack, isData = false) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str, stack) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value, stack) ->\n        value is @schema.default()\n\n       parse: (data, stack) ->\n        r = super data, stack\n        return r unless r is true\n        if not @schema.valid data, stack, true\n         return @error 'invalid'\n\n        return {\n         score: 1\n         errors: []\n         value: @schema.value data, stack, true\n        }\n\n       toJSON: (value, stack) -> value\n       toJSONFull: (value, stack) -> value\n\n       edit: (elem, value, onChanged, stack) ->\n        new Edit this, elem, value, onChanged, stack\n\n\nEdit\n\n      class Edit extends EditBase\n       @extend()\n\n       @initialize (property, elem, value, onChanged, stack) ->\n        @value = value\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           placeholder: @$.property._name\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = schema.string @value, @stack\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n        @change()\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value, @stack\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r, i in results\n          break if i > 10\n          e = @div r\n          e._result = r\n\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @elems.search.style.display = 'none'\n        @change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 400\n\n       @listen 'change', (e) ->\n        @search()\n        @change()\n\n       change: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value, @stack\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value, @stack\n         @onChanged value, true\n\n       validate: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value, @stack\n         @elems.input.classList.add 'invalid'\n         return false\n        else\n         @elems.input.classList.remove 'invalid'\n         return true\n\n       destroy: ->\n\n\n\n\n      PROPERTIES.register 'value', Value\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#Value\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Models.Property.EditBase'\n     'Weya'\n     (PROPERTIES, Base, EditBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       propertyType: 'value'\n\n       @default 'value', (str, stack, isData = false) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value, stack) -> \"#{value}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str, stack, isData = false) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str, stack) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value, stack) ->\n        value is @schema.default()\n\n       parse: (data, stack) ->\n        r = super data, stack\n        return r unless r is true\n        if not @schema.valid data, stack, true\n         return @error 'invalid'\n\n        return {\n         score: 1\n         errors: []\n         value: @schema.value data, stack, true\n        }\n\n       toJSON: (value, stack) -> value\n       toJSONFull: (value, stack) -> value\n\n       edit: (elem, value, onChanged, stack) ->\n        new Edit this, elem, value, onChanged, stack\n\n\nEdit\n\n      class Edit extends EditBase\n       @extend()\n\n       @initialize (property, elem, value, onChanged, stack) ->\n        @value = value\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           placeholder: @$.property._name\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = schema.string @value, @stack\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n        @change()\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value, @stack\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r, i in results\n          break if i > 10\n          e = @div r\n          e._result = r\n\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @elems.search.style.display = 'none'\n        @change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 400\n\n       @listen 'change', (e) ->\n        @search()\n        @change()\n\n       change: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value, @stack\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value, @stack\n         @onChanged value, true\n\n       validate: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value, @stack\n         return false\n        else\n         return true\n\n       destroy: ->\n\n\n\n\n      PROPERTIES.register 'value', Value\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"abf767134f10211a8d98a9b3d45eb26f3dcaab80","subject":"fix function syntax error for caching","message":"fix function syntax error for caching\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/lib\/routes\/index.litcoffee","new_file":"src\/lib\/routes\/index.litcoffee","new_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n      \n## Function cache(res, seconds)\n\nSet cache headers on this response.\n\nUsage: `cache(res,86400)`\n\n    cache = (res,seconds) ->\n      res.header 'Cache-control', 'Cache-Control:public, max-age='+seconds\n      \n## Function nocache(res)\n\nSet uncacheable headers on this response\n\nUsage: `nocache(res)`\n\n    nocache = (res) ->\n      res.header 'Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0'\n\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        cache res, 2592000\n        res.redirect '\/page\/index'\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        app.models.page.get req.params.name, (err, page) ->\n          if err\n            console.error 'page '+req.params.name+' not found in db, showing 500'\n            nocache res\n            res.render 'error\/500'\n          else\n            cache res, 86400\n            res.render 'page\/dynamic', page\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n<!-- ' -->\n\n      app.post '\/page\/_post', (req, res) ->\n        nocache res\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          content: 'Hello world, from inside the DB'\n        app.models.page sample, (err, page) ->\n          if err\n            page = \n              name: 'error'\n              title: 'Error'\n              content: 'There was an error posting your page, please try again.'\n          res.render 'page\/dynamic', page\n          \n## GET \/login\n\nRender static pages at \/view\/login\/index.html\n\nAnd never cache the login page, it breaks csrf\n\n      app.get '\/login', (req, res) ->\n        nocache res\n        res.render 'login'\n\n          \n## POST \/login\/_post\n\nDo Login action, and redirect as appropriate.\n\n      app.post '\/login\/_post', (req, res) ->\n        nocache res\n        require('..\/login').checkUser req.body.username, req.body.password, (user, securityLevel) ->\n          console.info 'login callback = '+user+', '+securityLevel\n          req.session.user = user\n          req.session.securityLevel = securityLevel\n          res.cookie 'nocache', '1'\n          if securityLevel\n            res.redirect '\/'\n          else\n            res.redirect '\/login'\n\n## GET \/login\/clear\n\nLogout from the website by clearing the session\n\n      app.get '\/login\/clear', (req, res) ->\n        nocache res\n        req.session.destroy (err) ->\n          res.clearCookie 'nocache'\n          res.redirect '\/login'\n\n## GET \/directory\n \nDownload PDF to browser\n\n      app.get '\/directory', (req, res) ->\n        nocache res\n        if req.session.securityLevel\n          request = require 'request'\n          request app.directory_url, (err, cbres, data) ->\n            if err or cbres.statusCode != 200\n              res.render 500, 'Error retrieving full directory'\n            else\n              dir = JSON.parse data\n              page = \n                name: 'Full Directory'\n                title: 'Full Directory'\n                directory: dir.data\n                helpers:\n                  month: (num) ->\n                    return [null, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'][num]\n              res.render 'directory', page\n        else\n          res.redirect '\/login'\n\n\n## GET \/directory\/directory.pdf\n \nDownload PDF to browser\n\n      app.get '\/directory\/directory.pdf', (req, res) ->\n        nocache res\n        if req.session.securityLevel\n          res.download 'protected\/directory.pdf'\n        else\n          res.redirect '\/login'\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n      \n## Function cache(res, seconds)\n\nSet cache headers on this response.\n\nUsage: `cache(res,86400)`\n\n    cache(res,seconds) ->\n      res.header 'Cache-control', 'Cache-Control:public, max-age='+seconds\n      \n## Function nocache(res)\n\nSet uncacheable headers on this response\n\nUsage: `nocache(res)`\n\n    nocache(res) ->\n      res.header 'Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0'\n\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        cache res, 2592000\n        res.redirect '\/page\/index'\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        app.models.page.get req.params.name, (err, page) ->\n          if err\n            console.error 'page '+req.params.name+' not found in db, showing 500'\n            nocache res\n            res.render 'error\/500'\n          else\n            cache res, 86400\n            res.render 'page\/dynamic', page\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n<!-- ' -->\n\n      app.post '\/page\/_post', (req, res) ->\n        nocache res\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          content: 'Hello world, from inside the DB'\n        app.models.page sample, (err, page) ->\n          if err\n            page = \n              name: 'error'\n              title: 'Error'\n              content: 'There was an error posting your page, please try again.'\n          res.render 'page\/dynamic', page\n          \n## GET \/login\n\nRender static pages at \/view\/login\/index.html\n\nAnd never cache the login page, it breaks csrf\n\n      app.get '\/login', (req, res) ->\n        nocache res\n        res.render 'login'\n\n          \n## POST \/login\/_post\n\nDo Login action, and redirect as appropriate.\n\n      app.post '\/login\/_post', (req, res) ->\n        nocache res\n        require('..\/login').checkUser req.body.username, req.body.password, (user, securityLevel) ->\n          console.info 'login callback = '+user+', '+securityLevel\n          req.session.user = user\n          req.session.securityLevel = securityLevel\n          res.cookie 'nocache', '1'\n          if securityLevel\n            res.redirect '\/'\n          else\n            res.redirect '\/login'\n\n## GET \/login\/clear\n\nLogout from the website by clearing the session\n\n      app.get '\/login\/clear', (req, res) ->\n        nocache res\n        req.session.destroy (err) ->\n          res.clearCookie 'nocache'\n          res.redirect '\/login'\n\n## GET \/directory\n \nDownload PDF to browser\n\n      app.get '\/directory', (req, res) ->\n        nocache res\n        if req.session.securityLevel\n          request = require 'request'\n          request app.directory_url, (err, cbres, data) ->\n            if err or cbres.statusCode != 200\n              res.render 500, 'Error retrieving full directory'\n            else\n              dir = JSON.parse data\n              page = \n                name: 'Full Directory'\n                title: 'Full Directory'\n                directory: dir.data\n                helpers:\n                  month: (num) ->\n                    return [null, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'][num]\n              res.render 'directory', page\n        else\n          res.redirect '\/login'\n\n\n## GET \/directory\/directory.pdf\n \nDownload PDF to browser\n\n      app.get '\/directory\/directory.pdf', (req, res) ->\n        nocache res\n        if req.session.securityLevel\n          res.download 'protected\/directory.pdf'\n        else\n          res.redirect '\/login'\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"cdd32b4593e8b372615086c1858746a554657dfe","subject":"Fix match info display","message":"Fix match info display\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/managers\/match-info.litcoffee","new_file":"src\/coffee\/managers\/match-info.litcoffee","new_contents":"Match Info Manager\n==================\n\nWe first set everything in a callback, so that it is invoked only after the\nloading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe build the match info from the team DB, the scores, and the\ncurrent match.\n\n        inputStream = Bacon.combineTemplate\n            match: CurrentMatch\n            scores: League.scores\n            teams: Data.teams\n\nDisplay Management\n------------------\n\nFirst, we bind up the current match ID display.\n\n        inputStream.filter( (x) -> x.match? )\n                   .map( (x) -> x.match.key )\n                   .assign $('.match-id'), 'text'\n\nFor each zone, we bind up the relevant information points.\n\n        for n in [0..3]\n            do (n) ->\n                ifTeams = inputStream.filter( (x) -> x.match? )\n                                     .filter( (x) -> x.match.teams? )\n                team = ifTeams.map( (x) -> x.teams[x.match.teams[n]] ?\n                                           {name: x.match.teams[n]} )\n                score = ifTeams.map( (x) -> x.scores[x.match.teams[n]] ? 0 )\n\nThe team name, college, points, and notes.\n\n                team.map( (x) -> x.name  )\n                    .assign $(\".zone-#{n}-name\"), 'text'\n                team.map( (x) -> x.college ? x.name )\n                    .assign $(\".zone-#{n}-college\"), 'text'\n                team.map( (x) -> x.notes ? '' )\n                    .assign $(\".zone-#{n}-notes\"), 'text'\n                score.assign $(\".zone-#{n}-points\"), 'text'\n\n","old_contents":"Match Info Manager\n==================\n\nWe first set everything in a callback, so that it is invoked only after the\nloading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe build the match info from the team DB, the scores, and the\ncurrent match.\n\n        inputStream = Bacon.combineTemplate\n            match: CurrentMatch\n            scores: League.scores\n            teams: Data.teams\n\nDisplay Management\n------------------\n\nFirst, we bind up the current match ID display.\n\n        #inputStream.filter( (x) -> x.match? )\n        #           .map( (x) -> x.match.key? )\n        #           .assign $('.match-id'), 'text'\n        inputStream.filter( (x) -> x.match? )\n                   .filter( (x) -> x.match.key? )\n                   .map( (x) -> x.teams )\n                   .assign $('.match-id'), 'text'\n\nFor each zone, we bind up the relevant information points.\n\n        for n in [0..3]\n            #ifTeams = inputStream.filter( (x) -> x.match? )\n            #                     .filter( (x) -> x.match.teams? )\n            ifTeams = Bacon.never().toProperty()\n            team = ifTeams.map( (x) -> x.teams[x.match.teams[n]] )\n            score = ifTeams.map( (x) -> x.scores[x.match.teams[n]] )\n\nThe team name, college, points, and notes.\n\n            team.map( (x) -> x.name )\n                .assign $(\".zone-#{n}-name\"), 'text'\n            team.map( (x) -> x.college )\n                .assign $(\".zone-#{n}-college\"), 'text'\n            team.map( (x) -> x.notes )\n                .assign $(\".zone-#{n}-notes\"), 'text'\n            score.assign $(\".zone-#{n}-points\"), 'text'\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"af494607b2c71f062c1015570e3c5b2ac32f3bcf","subject":"byteLength for content-length","message":"byteLength for content-length\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"359309932356ac2538dfbaa86dada02b20fa614e","subject":"Began working on arm animation.","message":"Began working on arm animation.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/game.litcoffee","new_file":"src\/game.litcoffee","new_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    pose = require \".\/pose.litcoffee\"\n    ik = require \".\/ik.litcoffee\"\n       \n    triangle = undefined\n    \n    character = testMap = testNavmesh = undefined\n    characterData = require \".\/characters\/test\/cloud.coffee\"\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load characterData, (character_) ->\n            character = character_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n    \n    playerPoseOld = pose.create characterData\n    playerPoseNew = pose.create characterData\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n    \n    torsoAltitude = 0\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    start = []\n    leftFoot = []\n    rightFoot = []\n    leftHand = []\n    leftHandPreviousTick = []\n    leftHandToDraw = []\n    rightHand = []\n    rightHandPreviousTick = []\n    rightHandToDraw = []\n    walked = 0\n    shuffleTicks = 0\n    foot = \"left\"\n    ticksSinceLeft = 0\n    ticksSinceRight = 0\n    offset = []\n    \n    yaw = 0\n    pitch = 0\n    headYawPreviousTick = headYaw = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->        \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            vector.copy leftHand, leftHandPreviousTick\n            vector.copy rightHand, rightHandPreviousTick\n            \n        matrix.translate velocity, entityTransform  \n        speed = vector.magnitude velocity\n        walked += speed\n        moving = speed > 2\n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # A \"bump\" when you land.\n            matrix.getY entityTransform, yAxis\n            impact = Math.abs (vector.dot triangle.plane.normal, velocity) * (vector.dot triangle.plane.normal, yAxis)\n            impact -= 1\n            if impact < 0 then impact = 0\n            impact *= 2\n            torsoAltitude -= impact\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        torsoAltitude = misc.interpolate torsoAltitude, (12 - Math.min 2, (speed + if inDeadzone then 0 else 1.5)), 0.4\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, torsoAltitude, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.1, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        # Calculating the head angle relative to the torso is complicated by the\n        # stick angle being wrapped to 0...2PI, so we have to shift it out of\n        # that range to clamp it.\n        headYawPreviousTick = headYaw\n        headYaw = Math.max Math.PI - 1, Math.min Math.PI + 1, misc.wrapAngle Math.PI + stickAngle - yaw\n        headYaw -= Math.PI\n        headYaw = misc.interpolateAngle headYawPreviousTick, headYaw, 0.4, headYaw\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.4\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n        \n        shuffleTicks--\n        ticksSinceLeft++\n        ticksSinceRight++\n        while walked > 5 or shuffleTicks < 0\n            shuffleTicks = 5\n            walked -= 5\n            if (not inDeadzone) or moving\n                vector.normalize velocity, offset\n                vector.multiply.byScalar offset, 5, offset\n            else\n                offset[0] = offset[1] = offset[2] = 0\n            foot = switch foot\n                when \"left\"\n                    matrix.applyToVector playerPoseNew.torso, [-2, -10, 0], leftFoot\n                    vector.add.vector offset, leftFoot, leftFoot\n                    plane.project triangle.plane, leftFoot, leftFoot\n                    ticksSinceLeft = 0\n                    \"right\"\n                when \"right\"\n                    matrix.applyToVector playerPoseNew.torso, [2, -10, 0], rightFoot\n                    vector.add.vector offset, rightFoot, rightFoot\n                    plane.project triangle.plane, rightFoot, rightFoot\n                    ticksSinceRight = 0\n                    \"left\"\n        \n        if inDeadzone\n            leftHand[0] = -6\n            rightHand[0] = 6\n            leftHand[1] = rightHand[1] = -4\n            leftHand[2] = rightHand[2] = 0\n        else\n            yScale = 7 \/ (1 + speed)\n            rightHand[0] = 2 + (Math.min 4, speed)\n            leftHand[0] = -rightHand[0]\n            \n            leftHand[1] = rightHand[1] = 3\n            motion = Math.pow (Math.cos ticksSinceLeft * 0.25) * 0.5 + 0.5, 4\n            leftHand[1] += yScale * motion\n            leftHand[2] = 1.5 + 6 * stickLength * motion\n            motion = Math.pow (Math.cos ticksSinceRight * 0.25) * 0.5 + 0.5, 4\n            rightHand[1] += yScale * motion\n            rightHand[2] = 1.5 + 6 * stickLength * motion\n            \n        matrix.applyToVector torsoTransform, leftHand, leftHand                \n        matrix.applyToVector torsoTransform, rightHand, rightHand\n        \n        leftHand[1] -= 2\n        rightHand[1] -= 2\n        \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            vector.copy leftHand, leftHandPreviousTick\n            vector.copy rightHand, rightHandPreviousTick\n            firstTick = false\n            \n        lag = 0.15 + 0.4 \/ (1 + speed \/ 3)\n        if inDeadzone then lag = 0.2\n        vector.interpolate leftHandPreviousTick, leftHand, lag, leftHand\n        vector.interpolate rightHandPreviousTick, rightHand, lag, rightHand\n            \n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n    \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, playerPoseNew.torso\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, -2.5, 0], start\n        matrix.getX playerPoseNew.torso, xAxis\n        ik.computeLimb start, leftFoot, 10, xAxis, playerPoseNew.legLeftUpper, playerPoseNew.legLeftLower\n        \n        matrix.applyToVector playerPoseNew.torso, [1.5, -2.5, 0], start\n        ik.computeLimb start, rightFoot, 10, xAxis, playerPoseNew.legRightUpper, playerPoseNew.legRightLower\n\n        matrix.getY playerPoseNew.torso, yAxis\n        vector.negate xAxis, xAxis\n        vector.interpolate xAxis, yAxis, 0.05, offset\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, 4, 0], start\n        vector.interpolate leftHandPreviousTick, leftHand, progress, leftHandToDraw\n        ik.computeLimb start, leftHandToDraw, 10, offset, playerPoseNew.armLeftUpper, playerPoseNew.armLeftLower\n        \n        vector.negate yAxis, yAxis\n        vector.interpolate xAxis, yAxis, 0.05, offset\n\n        matrix.applyToVector playerPoseNew.torso, [1.5, 4, 0], start\n        vector.interpolate rightHandPreviousTick, rightHand, progress, rightHandToDraw\n        ik.computeLimb start, rightHandToDraw, 10, offset, playerPoseNew.armRightUpper, playerPoseNew.armRightLower\n        \n        matrix.copy playerPoseNew.torso, playerPoseNew.head\n        matrix.translate [0, 6, 0], playerPoseNew.head, true\n        matrix.rotateY (misc.interpolate headYawPreviousTick, headYaw, progress), playerPoseNew.head, true\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw character, playerPoseOld, playerPoseNew\n        \n        return\n        \n    module.exports = { load, tick, draw }","old_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    pose = require \".\/pose.litcoffee\"\n    ik = require \".\/ik.litcoffee\"\n       \n    triangle = undefined\n    \n    character = testMap = testNavmesh = undefined\n    characterData = require \".\/characters\/test\/cloud.coffee\"\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load characterData, (character_) ->\n            character = character_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n    \n    playerPoseOld = pose.create characterData\n    playerPoseNew = pose.create characterData\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n    \n    torsoAltitude = 0\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    start = []\n    leftFoot = []\n    rightFoot = []\n    walked = 0\n    shuffleTicks = 0\n    foot = \"left\"\n    offset = []\n    \n    yaw = 0\n    pitch = 0\n    headYawPreviousTick = headYaw = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->        \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            \n        matrix.translate velocity, entityTransform  \n        speed = vector.magnitude velocity\n        walked += speed\n        moving = speed > 2\n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # A \"bump\" when you land.\n            matrix.getY entityTransform, yAxis\n            impact = Math.abs (vector.dot triangle.plane.normal, velocity) * (vector.dot triangle.plane.normal, yAxis)\n            impact -= 1\n            if impact < 0 then impact = 0\n            impact *= 2\n            torsoAltitude -= impact\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        torsoAltitude = misc.interpolate torsoAltitude, (12 - Math.min 2, (speed + if inDeadzone then 0 else 1.5)), 0.4\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, torsoAltitude, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.1, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        # Calculating the head angle relative to the torso is complicated by the\n        # stick angle being wrapped to 0...2PI, so we have to shift it out of\n        # that range to clamp it.\n        headYawPreviousTick = headYaw\n        headYaw = Math.max Math.PI - 1, Math.min Math.PI + 1, misc.wrapAngle Math.PI + stickAngle - yaw\n        headYaw -= Math.PI\n        headYaw = misc.interpolateAngle headYawPreviousTick, headYaw, 0.4, headYaw\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.2\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n        \n        if walked < 5\n            shuffleTicks--\n        while walked > 5 or shuffleTicks < 0\n            shuffleTicks = 5\n            walked -= 5\n            if (not inDeadzone) or moving\n                vector.normalize velocity, offset\n                vector.multiply.byScalar offset, 5, offset\n            else\n                offset[0] = offset[1] = offset[2] = 0\n            foot = switch foot\n                when \"left\"\n                    matrix.applyToVector playerPoseNew.torso, [-2, -10, 0], leftFoot\n                    vector.add.vector offset, leftFoot, leftFoot\n                    plane.project triangle.plane, leftFoot, leftFoot\n                    \"right\"\n                when \"right\"\n                    matrix.applyToVector playerPoseNew.torso, [2, -10, 0], rightFoot\n                    vector.add.vector offset, rightFoot, rightFoot\n                    plane.project triangle.plane, rightFoot, rightFoot\n                    \"left\"\n    \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            firstTick = false\n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n    \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, playerPoseNew.torso\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, -2.5, 0], start\n        matrix.getX playerPoseNew.torso, xAxis\n        ik.computeLimb start, leftFoot, 10, xAxis, playerPoseNew.legLeftUpper, playerPoseNew.legLeftLower\n        \n        matrix.applyToVector playerPoseNew.torso, [1.5, -2.5, 0], start\n        ik.computeLimb start, rightFoot, 10, xAxis, playerPoseNew.legRightUpper, playerPoseNew.legRightLower\n        \n        matrix.copy playerPoseNew.torso, playerPoseNew.head\n        matrix.translate [0, 6, 0], playerPoseNew.head, true\n        matrix.rotateY (misc.interpolate headYawPreviousTick, headYaw, progress), playerPoseNew.head, true\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw character, playerPoseOld, playerPoseNew\n        \n        return\n        \n    module.exports = { load, tick, draw }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0edf1f974b538d4f190b9091204f58968769d8f7","subject":"modify README","message":"modify README\n","repos":"CureApp\/loopback-with-admin","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# loopback-with-admin\n\nrun loopback server with admin and push notification features.\n\n# install\n\n```bash\nnpm install loopback-with-admin\n```\n\n# simplest run\n\n    models =\n        'user':\n            base: 'User'\n\n\n    require('loopback-with-admin').run(models).then (lbInfo) ->\n\n        console.log lbInfo.getURL()         # loopback api root\n        console.log lbInfo.getAccessToken() # access token of admin\n\n\n# run with config dir\n\nbefore running, you can prepare a directory which contains custom config information.\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    configDir = '\/path\/to\/config-dir'\n\n    lbWithAdmin.run(configDir).then ->\n        # loopback started\n\n# run with config\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    lbWithAdmin.run(models, server: port: 3001).then ->\n\n\n# admin\n(coming soon)\n\n# push notification \n(coming soon)\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-values\/non-model-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|-----------------------\n memory      | on memory datasource\n db          | datasource for custom entities\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n# model definitions\n\n    models =\n        player: # model name\n            base: 'User'  \n            aclType: 'admin' # specific for this system\n\n        instrument:\n            aclType: 'owner-read'\n\n\nthe same format as [loopback model definition](http:\/\/docs.strongloop.com\/display\/public\/LB\/Customizing+models)\nexcept \"aclType\" value.\nname is automatically set from definition information.\nplural is set to the same value as name if not set manually.\n\n## aclType\nloopback-with-admin generates acls from aclType.\n\nthree types are available.\n\n aclType     | meaning\n-------------|-----------------------------------------------------\n admin       | only admin can CRUD the model\n owner       | admin and the owner of the model can CRUD\n public-read | everyone can READ the model and admin can CRUD\n none        | everyone can CRUD the model\n\n\n# switching environment\n\nrunning script with environment variable \"NODE\\_ENV\" like\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\n\"development\" is selected by default.\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-admin selects configs in \"local\" directory.\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    lbWithAdmin.run(configDir, env)\n\nenv is prior to NODE\\_ENV settings.\n\n\n# modified loopback-datasource-juggler\n\nusing [CureApp\/loopback-datasource-juggler](https:\/\/github.com\/CureApp\/loopback-datasource-juggler).\n\nthis repository is almost the same as original one except 'memory' connector handles id as string\n(orignally integer).\n","old_contents":"# loopback-with-admin\n\nrun loopback server with admin and push notification features.\n\n# install\n\n```bash\nnpm install loopback-with-admin\n```\n\n# simplest run\n\n    require('loopback-with-admin').run().then (lbInfo) ->\n\n        console.log lbInfo.getURL()         # loopback api root\n        console.log lbInfo.getAccessToken() # access token of admin\n\n\n# run with config dir\n\nbefore running, you can prepare a directory which contains custom config information.\n\n```text\n(config-dir) # any name is acceptable\n|-- model-definitions.coffee\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    configDir = '\/path\/to\/config-dir'\n\n    lbWithAdmin.run(configDir).then ->\n        # loopback started\n\n# run with config dir\n\n    lbWithAdmin = require 'loopback-with-admin'\n\n    lbWithAdmin.run(server: port: 3001).then ->\n\n\n# admin\n(coming soon)\n\n# push notification \n(coming soon)\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-values\/non-model-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|-----------------------\n memory      | on memory datasource\n db          | datasource for custom entities\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n# model definitions\n\n    module.exports =\n        player: # model name\n            base: 'User'  # the same as loopback model settings.base\n            aclType: 'admin' # specific for this system\n\n        instrument:\n            aclType: 'owner-read'\n\n\n\nthe same format as [loopback model definition](http:\/\/docs.strongloop.com\/display\/public\/LB\/Customizing+models)\nexcept \"aclType\" value.\nname is automatically set from definition information.\nplural is set to the same value as name if not set manually.\n\n## aclType\nloopback-with-admin generates acls from aclType.\n\nthree types are available.\n\n aclType     | meaning\n-------------|-----------------------------------------------------\n admin       | only admin can CRUD the model\n owner       | admin and the owner of the model can CRUD\n public-read | everyone can READ the model and admin can CRUD\n none        | everyone can CRUD the model\n\n\n# switching environment\n\nrunning script with environment variable \"NODE\\_ENV\" like\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\n\"development\" is selected by default.\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-admin selects configs in \"local\" directory.\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    lbWithAdmin.run(configDir, env)\n\nenv is prior to NODE\\_ENV settings.\n\n\n# modified loopback-datasource-juggler\n\nusing [CureApp\/loopback-datasource-juggler](https:\/\/github.com\/CureApp\/loopback-datasource-juggler).\n\nthis repository is almost the same as original one except 'memory' connector handles id as string\n(orignally integer).\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d05e359ecd48b89eb05380f58830570a29f4528b","subject":"fix for cases when element update\/merge into a new extension","message":"fix for cases when element update\/merge into a new extension\n","repos":"corenova\/yang-js","old_file":"src\/element.litcoffee","new_file":"src\/element.litcoffee","new_contents":"# Element - cascading element tree\n\n## Class Element\n\n    debug = require('debug')('yang:element')\n    delegate = require 'delegates'\n    Emitter = require('events').EventEmitter\n    Emitter.defaultMaxListeners = 100\n\n    kIndex = Symbol.for('element:index');\n    kCache = Symbol.for('element:cache');\n    \n    class Element\n      \n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n        \n      @use: ->\n        res = [].concat(arguments...)\n          .filter (x) -> x?\n          .map (elem) =>\n            exists = Element::match.call this, elem.kind, elem.tag\n            if exists?\n              debug \"use: using previously loaded '#{elem.kind}:#{elem.tag}'\"\n              return exists\n            try Element::merge.call this, elem\n            catch e\n              throw @error \"use: unable to merge '#{elem.kind}:#{elem.tag}'\", e\n        return switch \n          when res.length > 1  then res\n          when res.length is 1 then res[0]\n          else undefined\n            \n      @debug: -> debug @uri, arguments...\n      \n      @error: (err, ctx) ->\n        err = new Error err unless err instanceof Error\n        err.uri = @uri\n        err.src = this\n        err.ctx = ctx\n        return err\n\n      constructor: (@kind, @tag, scope) ->\n        unless @kind?\n          throw @error \"must supply 'kind' to create a new Element\"\n\n        @scope = scope if scope?\n          \n        Object.defineProperties this,\n          parent: value: null, writable: true\n          origin: value: null, writable: true\n          state:  value: {}, writable: true\n          [kIndex]: value: 0, writable: true\n          emitter: value: new Emitter\n\n      error: @error\n      debug: @debug\n\n      delegate @prototype, 'emitter'\n        .method 'emit'\n        .method 'once'\n        .method 'on'\n        .method 'off'\n\n### Computed Properties\n\n      @property 'datakey',\n        get: -> @tag ? @kind\n\n      @property 'uri',\n        get: -> switch\n          when @parent instanceof Element\n            mark = @kind\n            mark += \"(#{@tag})\" if @tag? and @parent.scope?[@kind] in [ '0..n', '1..n', '*' ]\n            \"#{@parent.uri}\/#{mark}\"\n          when @tag?\n            \"#{@kind}(#{@tag})\"\n          else\n            @kind\n\n      @property 'root',\n        get: -> switch\n          when @parent instanceof Element then @parent.root\n          when @origin instanceof Element then @origin.root\n          else this\n\n      @property 'children',\n        get: ->\n          unless this[kCache]?\n            elements = (v for own k, v of this when k not in [ 'parent', 'origin', 'tag', kCache, 'source' ])\n              .reduce ((a,b) -> switch\n                when b instanceof Element then a.concat b\n                when b instanceof Array\n                  a.concat b.filter (x) -> x instanceof Element\n                else a\n              ), []\n            this[kCache] = elements.sort (a,b) -> a[kIndex] - b[kIndex]\n          return this[kCache];\n            \n      @property '*',  get: -> @children\n      @property '..', get: -> @parent\n\n## Instance-level methods\n\n### clone\n\n      clone: (opts={}) ->\n        { origin = @origin, relative = true } = opts\n        @debug \"cloning #{@kind}:#{@tag} with #{@children.length} elements\"\n        copy = (new @constructor @kind, @tag, @source).extends @children.map (x) -> x.clone opts\n        copy.state = Object.create(@state)\n        copy.state.relative = relative\n        copy.origin = origin ? this\n        return copy\n\n### extends (elements...)\n\nThis is the primary mechanism for defining sub-elements to become part\nof the element tree\n\n      extends: ->\n        elems = ([].concat arguments...).filter (x) -> x? and !!x\n        return this unless elems.length > 0\n        elems.forEach (expr) => @merge expr\n        @emit 'change', elems...\n        return this\n\n### merge (element)\n\nThis helper method merges a specific Element into current Element\nwhile performing `@scope` validations.\n\n      merge: (elem, opts={}) ->\n        unless elem instanceof Element\n          throw @error \"cannot merge invalid element into Element\", elem\n          \n        elem.parent = this\n        elem[kIndex] = @children.length if @children?\n        this[kCache] = null \n\n        _merge = (item) ->\n          if not item.node or opts.append or item.datakey not in (@keys ? [])\n            @push item\n            true\n          else if opts.replace is true\n            for x, i in this when x.datakey is item.datakey\n              @splice i, 1, item\n              break\n            true\n          else false\n\n        unless @scope?\n          unless @hasOwnProperty elem.kind\n            @[elem.kind] = elem\n            return elem\n\n          unless Array.isArray @[elem.kind]\n            exists = @[elem.kind]\n            @[elem.kind] = [ exists ]\n            Object.defineProperty @[elem.kind], 'keys',\n              get: (-> @map (x) -> x.datakey ).bind @[elem.kind]\n          unless _merge.call @[elem.kind], elem\n            throw @error \"constraint violation for '#{elem.kind} #{elem.datakey}' - cannot define more than once\"\n\n          return elem\n\n        unless elem.kind of @scope\n          if elem.scope? and (not elem.source.state.unbound and not @source.state.unbound)\n            @debug @scope\n            throw @error \"scope violation - invalid '#{elem.kind}' extension found\"\n          else\n            @scope[elem.kind] = '*' # this is hackish...\n\n        switch @scope[elem.kind]\n          when '0..n', '1..n', '*'\n            unless @hasOwnProperty elem.kind\n              @[elem.kind] = []\n              Object.defineProperty @[elem.kind], 'keys',\n                get: (-> @map (x) -> x.datakey ).bind @[elem.kind]\n            unless Array.isArray @[elem.kind]\n              exists = @[elem.kind]\n              @[elem.kind] = [ exists ]\n              Object.defineProperty @[elem.kind], 'keys',\n                get: (-> @map (x) -> x.datakey ).bind @[elem.kind]\n            unless _merge.call @[elem.kind], elem\n              throw @error \"constraint violation for '#{elem.kind} #{elem.datakey}' - already defined\"\n          when '0..1', '1'\n            unless @hasOwnProperty elem.kind\n              @[elem.kind] = elem\n            else if opts.replace is true\n              @debug \"replacing pre-existing #{elem.kind}\"\n              @[elem.kind] = elem\n            else\n              throw @error \"constraint violation for '#{elem.kind}' - cannot define more than once\"\n          else\n            throw @error \"unrecognized scope constraint defined for '#{elem.kind}' with #{@scope[elem.kind]}\"\n\n        return elem\n\n      removes: ->\n        elems = ([].concat arguments...).filter (x) -> x? and !!x\n        return this unless elems.length > 0\n        elems.forEach (expr) => @remove expr\n        @emit 'change', elems...\n        return this\n\n      remove: (elem) ->\n        unless elem instanceof Element\n          throw @error \"cannot remove a non-Element from an Element\", elem\n\n        exists = Element::match.call this, elem.kind, elem.datakey\n        return this unless exists?\n\n        if Array.isArray @[elem.kind]\n          @[elem.kind] = @[elem.kind].filter (x) -> x.datakey isnt elem.datakey\n          delete @[elem.kind] unless @[elem.kind].length\n        else\n          delete @[elem.kind]\n\n        this[kCache] = null\n        return this\n\n### update (element)\n\nThis alternative form of [merge](#merge-element) performs conditional\nmerge based on existence check. It is considered *safer* alternative\nto direct [merge](#merge-element) call.\n\n      # performs conditional merge based on existence\n      update: (elem) ->\n        unless elem instanceof Element\n          throw @error \"cannot update a non-Element into an Element\", elem\n\n        #@debug \"update with #{elem.kind}\/#{elem.tag}\"\n        exists = switch\n          when elem.tag? then Element::match.call this, elem.kind, elem.datakey\n          else Element::match.call this, elem.kind\n        return @merge elem unless exists?\n\n        #@debug \"update #{exists.kind} in-place for #{elem.children.length} elements\"\n        exists.update target for target in elem.children\n        return exists\n\n      # Looks for matching Elements using kind and tag\n      # Direction: up the hierarchy (towards root)\n      lookup: (kind, tag) ->\n        #@debug \"lookup: #{kind}(#{tag})...\"\n        res = switch\n          when this not instanceof Object then undefined\n          when this instanceof Element then @match kind, tag\n          else Element::match.call this, kind, tag\n        res ?= switch\n          when @origin? then Element::lookup.apply @origin, arguments\n          when @parent? then Element::lookup.apply @parent, arguments\n          else Element::match.call @constructor, kind, tag\n        #@debug \"lookup: #{kind}(#{tag}) got result: #{res?}\"\n        return res\n\n      # Looks for matching Elements using YPATH notation\n      # Direction: down the hierarchy (away from root)\n      at: -> @locate arguments...\n      locate: (ypath) ->\n        return unless ypath?\n        if typeof ypath is 'string'\n          @debug \"locate: #{ypath}\"\n          ypath = ypath.replace \/\\s\/g, ''\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = ypath.split('\/').filter (e) -> !!e\n        else\n          @debug \"locate: #{ypath.join('\/')}\"\n          [ key, rest... ] = ypath\n        return this unless key?\n\n        match = switch\n          when key is '..' then @match key\n          else @match '*', key\n            \n        match ?= @match key if @scope[key] in ['0..1', '1']\n\n        return switch\n          when rest.length > 0 then match?.locate rest\n          else match\n\n      # Looks for a matching Element(s) in immediate sub-elements\n      match: (kind, tag) ->\n        return unless kind? and @[kind]?\n        return @[kind] unless tag?\n\n        match = @[kind]\n        match = [ match ] unless match instanceof Array\n        return match if tag is '*'\n\n        for elem in match when elem instanceof Element\n          return elem if tag is elem.datakey or tag is elem.tag\n        return undefined\n\n### toJSON\n\nConverts the Element into a JS object\n\n      toJSON: (opts={ tag: true, extended: false }) ->\n        #@debug \"converting #{@kind} toJSON with #{@children.length}\"\n        sub =\n          @children\n            .filter (x) => opts.extended or x.parent is this\n            .reduce ((a,b) ->\n              for k, v of b.toJSON()\n                if a[k] instanceof Object\n                  a[k][kk] = vv for kk, vv of v if v instanceof Object\n                else\n                  a[k] = v\n              return a\n            ), {}\n        if opts.tag\n          \"#{@kind}\": switch\n            when Object.keys(sub).length > 0\n              if @tag? then \"#{@tag}\": sub else sub\n            when @tag instanceof Object then \"#{@tag}\"\n            else @tag\n        else sub\n\n## Export Element Class\n\n    module.exports = Element\n","old_contents":"# Element - cascading element tree\n\n## Class Element\n\n    debug = require('debug')('yang:element')\n    delegate = require 'delegates'\n    Emitter = require('events').EventEmitter\n    Emitter.defaultMaxListeners = 100\n\n    kIndex = Symbol.for('element:index');\n    kCache = Symbol.for('element:cache');\n    \n    class Element\n      \n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n        \n      @use: ->\n        res = [].concat(arguments...)\n          .filter (x) -> x?\n          .map (elem) =>\n            exists = Element::match.call this, elem.kind, elem.tag\n            if exists?\n              debug \"use: using previously loaded '#{elem.kind}:#{elem.tag}'\"\n              return exists\n            try Element::merge.call this, elem\n            catch e\n              throw @error \"use: unable to merge '#{elem.kind}:#{elem.tag}'\", e\n        return switch \n          when res.length > 1  then res\n          when res.length is 1 then res[0]\n          else undefined\n            \n      @debug: -> debug @uri, arguments...\n      \n      @error: (err, ctx) ->\n        err = new Error err unless err instanceof Error\n        err.uri = @uri\n        err.src = this\n        err.ctx = ctx\n        return err\n\n      constructor: (@kind, @tag, scope) ->\n        unless @kind?\n          throw @error \"must supply 'kind' to create a new Element\"\n\n        @scope = scope if scope?\n          \n        Object.defineProperties this,\n          parent: value: null, writable: true\n          origin: value: null, writable: true\n          state:  value: {}, writable: true\n          [kIndex]: value: 0, writable: true\n          emitter: value: new Emitter\n\n      error: @error\n      debug: @debug\n\n      delegate @prototype, 'emitter'\n        .method 'emit'\n        .method 'once'\n        .method 'on'\n        .method 'off'\n\n### Computed Properties\n\n      @property 'datakey',\n        get: -> @tag ? @kind\n\n      @property 'uri',\n        get: -> switch\n          when @parent instanceof Element\n            mark = @kind\n            mark += \"(#{@tag})\" if @tag? and @parent.scope?[@kind] in [ '0..n', '1..n', '*' ]\n            \"#{@parent.uri}\/#{mark}\"\n          when @tag?\n            \"#{@kind}(#{@tag})\"\n          else\n            @kind\n\n      @property 'root',\n        get: -> switch\n          when @parent instanceof Element then @parent.root\n          when @origin instanceof Element then @origin.root\n          else this\n\n      @property 'children',\n        get: ->\n          unless this[kCache]?\n            elements = (v for own k, v of this when k not in [ 'parent', 'origin', 'tag', kCache, 'source' ])\n              .reduce ((a,b) -> switch\n                when b instanceof Element then a.concat b\n                when b instanceof Array\n                  a.concat b.filter (x) -> x instanceof Element\n                else a\n              ), []\n            this[kCache] = elements.sort (a,b) -> a[kIndex] - b[kIndex]\n          return this[kCache];\n            \n      @property '*',  get: -> @children\n      @property '..', get: -> @parent\n\n## Instance-level methods\n\n### clone\n\n      clone: (opts={}) ->\n        { origin = @origin, relative = true } = opts\n        @debug \"cloning #{@kind}:#{@tag} with #{@children.length} elements\"\n        copy = (new @constructor @kind, @tag, @source).extends @children.map (x) -> x.clone opts\n        copy.state = Object.create(@state)\n        copy.state.relative = relative\n        copy.origin = origin ? this\n        return copy\n\n### extends (elements...)\n\nThis is the primary mechanism for defining sub-elements to become part\nof the element tree\n\n      extends: ->\n        elems = ([].concat arguments...).filter (x) -> x? and !!x\n        return this unless elems.length > 0\n        elems.forEach (expr) => @merge expr\n        @emit 'change', elems...\n        return this\n\n### merge (element)\n\nThis helper method merges a specific Element into current Element\nwhile performing `@scope` validations.\n\n      merge: (elem, opts={}) ->\n        unless elem instanceof Element\n          throw @error \"cannot merge invalid element into Element\", elem\n          \n        elem.parent = this\n        elem[kIndex] = @children.length if @children?\n        this[kCache] = null \n\n        _merge = (item) ->\n          if not item.node or opts.append or item.datakey not in (@keys ? [])\n            @push item\n            true\n          else if opts.replace is true\n            for x, i in this when x.datakey is item.datakey\n              @splice i, 1, item\n              break\n            true\n          else false\n\n        unless @scope?\n          unless @hasOwnProperty elem.kind\n            @[elem.kind] = elem\n            return elem\n\n          unless Array.isArray @[elem.kind]\n            exists = @[elem.kind]\n            @[elem.kind] = [ exists ]\n            Object.defineProperty @[elem.kind], 'keys',\n              get: (-> @map (x) -> x.datakey ).bind @[elem.kind]\n              \n          unless _merge.call @[elem.kind], elem\n            throw @error \"constraint violation for '#{elem.kind} #{elem.datakey}' - cannot define more than once\"\n\n          return elem\n\n        unless elem.kind of @scope\n          if elem.scope? and (not elem.source.state.unbound and not @source.state.unbound)\n            @debug @scope\n            throw @error \"scope violation - invalid '#{elem.kind}' extension found\"\n          else\n            @scope[elem.kind] = '*' # this is hackish...\n\n        switch @scope[elem.kind]\n          when '0..n', '1..n', '*'\n            unless @hasOwnProperty elem.kind\n              @[elem.kind] = []\n              Object.defineProperty @[elem.kind], 'keys',\n                get: (-> @map (x) -> x.datakey ).bind @[elem.kind]\n            unless _merge.call @[elem.kind], elem\n              throw @error \"constraint violation for '#{elem.kind} #{elem.datakey}' - already defined\"\n          when '0..1', '1'\n            unless @hasOwnProperty elem.kind\n              @[elem.kind] = elem\n            else if opts.replace is true\n              @debug \"replacing pre-existing #{elem.kind}\"\n              @[elem.kind] = elem\n            else\n              throw @error \"constraint violation for '#{elem.kind}' - cannot define more than once\"\n          else\n            throw @error \"unrecognized scope constraint defined for '#{elem.kind}' with #{@scope[elem.kind]}\"\n\n        return elem\n\n      removes: ->\n        elems = ([].concat arguments...).filter (x) -> x? and !!x\n        return this unless elems.length > 0\n        elems.forEach (expr) => @remove expr\n        @emit 'change', elems...\n        return this\n\n      remove: (elem) ->\n        unless elem instanceof Element\n          throw @error \"cannot remove a non-Element from an Element\", elem\n\n        exists = Element::match.call this, elem.kind, elem.datakey\n        return this unless exists?\n\n        if Array.isArray @[elem.kind]\n          @[elem.kind] = @[elem.kind].filter (x) -> x.datakey isnt elem.datakey\n          delete @[elem.kind] unless @[elem.kind].length\n        else\n          delete @[elem.kind]\n\n        this[kCache] = null\n        return this\n\n### update (element)\n\nThis alternative form of [merge](#merge-element) performs conditional\nmerge based on existence check. It is considered *safer* alternative\nto direct [merge](#merge-element) call.\n\n      # performs conditional merge based on existence\n      update: (elem) ->\n        unless elem instanceof Element\n          throw @error \"cannot update a non-Element into an Element\", elem\n\n        #@debug \"update with #{elem.kind}\/#{elem.tag}\"\n        exists = switch\n          when elem.tag? then Element::match.call this, elem.kind, elem.datakey\n          else Element::match.call this, elem.kind\n        return @merge elem unless exists?\n\n        #@debug \"update #{exists.kind} in-place for #{elem.children.length} elements\"\n        exists.update target for target in elem.children\n        return exists\n\n      # Looks for matching Elements using kind and tag\n      # Direction: up the hierarchy (towards root)\n      lookup: (kind, tag) ->\n        #@debug \"lookup: #{kind}(#{tag})...\"\n        res = switch\n          when this not instanceof Object then undefined\n          when this instanceof Element then @match kind, tag\n          else Element::match.call this, kind, tag\n        res ?= switch\n          when @origin? then Element::lookup.apply @origin, arguments\n          when @parent? then Element::lookup.apply @parent, arguments\n          else Element::match.call @constructor, kind, tag\n        #@debug \"lookup: #{kind}(#{tag}) got result: #{res?}\"\n        return res\n\n      # Looks for matching Elements using YPATH notation\n      # Direction: down the hierarchy (away from root)\n      at: -> @locate arguments...\n      locate: (ypath) ->\n        return unless ypath?\n        if typeof ypath is 'string'\n          @debug \"locate: #{ypath}\"\n          ypath = ypath.replace \/\\s\/g, ''\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = ypath.split('\/').filter (e) -> !!e\n        else\n          @debug \"locate: #{ypath.join('\/')}\"\n          [ key, rest... ] = ypath\n        return this unless key?\n\n        match = switch\n          when key is '..' then @match key\n          else @match '*', key\n            \n        match ?= @match key if @scope[key] in ['0..1', '1']\n\n        return switch\n          when rest.length > 0 then match?.locate rest\n          else match\n\n      # Looks for a matching Element(s) in immediate sub-elements\n      match: (kind, tag) ->\n        return unless kind? and @[kind]?\n        return @[kind] unless tag?\n\n        match = @[kind]\n        match = [ match ] unless match instanceof Array\n        return match if tag is '*'\n\n        for elem in match when elem instanceof Element\n          return elem if tag is elem.datakey or tag is elem.tag\n        return undefined\n\n### toJSON\n\nConverts the Element into a JS object\n\n      toJSON: (opts={ tag: true, extended: false }) ->\n        #@debug \"converting #{@kind} toJSON with #{@children.length}\"\n        sub =\n          @children\n            .filter (x) => opts.extended or x.parent is this\n            .reduce ((a,b) ->\n              for k, v of b.toJSON()\n                if a[k] instanceof Object\n                  a[k][kk] = vv for kk, vv of v if v instanceof Object\n                else\n                  a[k] = v\n              return a\n            ), {}\n        if opts.tag\n          \"#{@kind}\": switch\n            when Object.keys(sub).length > 0\n              if @tag? then \"#{@tag}\": sub else sub\n            when @tag instanceof Object then \"#{@tag}\"\n            else @tag\n        else sub\n\n## Export Element Class\n\n    module.exports = Element\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"62d87d0b64bf9966b77c278a21219bb8d8f6f333","subject":"Update audio.litcoffee","message":"Update audio.litcoffee","repos":"alexrkass\/oscilloscope,alexrkass\/oscilloscope,alexrkass\/oscilloscope","old_file":"js\/audio.litcoffee","new_file":"js\/audio.litcoffee","new_contents":"See [this blog](http:\/\/srchea.com\/experimenting-with-web-audio-api-three-js-webgl) for a very helpful tutorial.\n\n\nFirst set up a context within upon all the functions\nused to parse the audio will be called:\n\n\n\ttry audio = new AudioContext()\n\nThen open an HTTP request to asynchronously get your audio file:\n\n\turl = 'data\/11 Where I\\'m Trying To Go (Marvel Years Remix).mp3';\n\trequest = new XMLHttpRequest();\n\trequest.open('GET', url, true);\n\trequest.responseType = \"arraybuffer\";\n\nWhen the request returns, onload is called, which in turn calls setup.\n\n\trequest.onload = ()->\n\t\taudio.decodeAudioData(\n\t\t\trequest.response,\n\t\t\t(buffer) ->\n\nThe AudioBufferSourceNode contains the input audio data and outputs to the analyser and output.\n\n\t\t\t\tsource = audio.createBufferSource();\n\t\t\t\tsource.buffer = buffer;\n\nThe ScriptProcessorNode takes data from the analyser as its input and outputs to the destination node which plays the sound.\n\n\t\t\t\tsourceJs = audio.createScriptProcessor(2048,1,1)\n\t\t\t\tsourceJs.buffer = buffer\n\n\n\nThe AnalyserNode takes the current frequency data from the AudioBufferSourceNode, smoothes it, and outputs to the ScriptProcessorNode\n\n\t\t\t\tanalyser = audio.createAnalyser();\n\t\t\t\tanalyser.smoothingTimeConstant = 1;\n\t\t\t\tanalyser.fftSize = 512;\n\t\t\t\tsource.connect(analyser);\n\t\t\t\tanalyser.connect(sourceJs);\n\nCreate the oscilloscope and connect the AudioBufferSourceNode to it\n\n\t\t\t\tmyOscilloscope = new WavyJones(audio, 'oscilloscope');\n\t\t\t\tsource.connect(myOscilloscope);\n\t\t\t\tsource.connect(audio.destination);\n\t\t\t\tsourceJs.onaudioprocess = (e) ->\n\t\t\t\t\tarray = new Uint8Array(analyser.frequencyBinCount);\n\t\t\t\t\tanalyser.getByteFrequencyData(array);\n\t\t\t\tsource.start(0)\n\t\t\t\treturn\n\t\t\t);\n\nFinally, send the request which begins the flow that ends with the source.start function being called.\n\n\trequest.send()\n","old_contents":"First set up a context within upon all the functions\nused to parse the audio will be called:\n\n\n\ttry audio = new AudioContext()\n\nThen open an HTTP request to asynchronously get your audio file:\n\n\turl = 'data\/11 Where I\\'m Trying To Go (Marvel Years Remix).mp3';\n\trequest = new XMLHttpRequest();\n\trequest.open('GET', url, true);\n\trequest.responseType = \"arraybuffer\";\n\nWhen the request returns, onload is called, which in turn calls setup.\n\n\trequest.onload = ()->\n\t\taudio.decodeAudioData(\n\t\t\trequest.response,\n\t\t\t(buffer) ->\n\nThe AudioBufferSourceNode contains the buffer that is loaded asynchronously with decodeAudioData.\n\n\t\t\t\tsource = audio.createBufferSource();\n\t\t\t\tsource.buffer = buffer;\n\nThe ScriptProcessorNode takes the audio data as its input and outputs to the destination node which plays the sound.\n\n\t\t\t\tsourceJs = audio.createScriptProcessor(2048,1,1)\n\t\t\t\tsourceJs.buffer = buffer\n\n\n\nThe AnalyserNode takes the current frequency data from the AudioBufferSourceNode, smoothes it, and outputs to the ScriptProcessorNode\n\n\t\t\t\tanalyser = audio.createAnalyser();\n\t\t\t\tanalyser.smoothingTimeConstant = 1;\n\t\t\t\tanalyser.fftSize = 512;\n\t\t\t\tsource.connect(analyser);\n\t\t\t\tanalyser.connect(sourceJs);\n\nCreate the oscilloscope and connect the AnalyserNode to it\n\n\t\t\t\tmyOscilloscope = new WavyJones(audio, 'oscilloscope');\n\t\t\t\tanalyser.connect(myOscilloscope);\n\t\t\t\tsourceJs.onaudioprocess = (e) ->\n\t\t\t\t\tarray = new Uint8Array(analyser.frequencyBinCount);\n\t\t\t\t\tanalyser.getByteFrequencyData(array);\n\t\t\t\tsource.start(0)\n\t\t\t\treturn\n\t\t\t);\n\nFinally, send the request which begins the flow that ends with the source.start function being called.\n\n\trequest.send()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a198226593d2528931ed562d2d5e09c1e2983779","subject":"more tweaks for correctness and documentedness","message":"more tweaks for correctness and documentedness\n","repos":"bchociej\/platform-ng","old_file":"config-defaults.litcoffee","new_file":"config-defaults.litcoffee","new_contents":"*This is [Literate Coffeescript](http:\/\/coffeescript.org\/#literate): code interleaved with Markdown\ncomments. The Coffeescript compiler will strip the Markdown and compile it like any other file.*\n\n\tmodule.exports =\n\n## platform-ng config defaults\n\nThis file defines the default configuration options for platform-ng and explains\nhow can modify the configuration to suit your needs.\n\nWhen you call `Platform#config()` with your configuration object, this configuration is deep-extended with\nyours to produce the working configuration.\n\n### General application configuration\n\nWhat's the app called (`name`), and what environment is it running in (`env`)? For `env`, anything other\nthan the string `'production'` is automatically considered `'development'` for debuggability.\n\n\t\tapp:\n\t\t\tname: 'unnamed-app'\n\t\t\tenv: 'development'\n\n#### Sessions\n\nFor sessions, you can choose to entirely disable them by setting `enabled` to `false`. Otherwise, your\nchoices for `type` are currently `cookie` or `vanilla`.\n\nThe `cookie` type stores all session data in a garbled (not encrypted) client-side cookie, signed using\nthe `secret`.\n\nThe `vanilla` type stores the session in a server-side session store and only transmits a signed session\nID to the client.\n\n`cookie` is default for now, but `vanilla` will replace it in the next major version. The `secure` option\ndetermines whether the cookies are HTTPS-only or not.\n\n\t\t\tsession:\n\t\t\t\tenabled: true\n\t\t\t\ttype: 'cookie'\n\t\t\t\tsecret: 'change-me'\n\t\t\t\tsecure: false\n\n#### Cookie parser\n\nThe cookie parser transforms the `cookie` header into `request.cookies`, `request.signedCookies`, and\n`request.secureCookies` objects. You still have to use `response.cookie(...)` and\/or \n`response.clearCookie(...)` to actually manipulate cookies. The `secret` defined here will be used to\nverify signed cookies, and, if you set `{signed: true}` in the third argument to `response.cookie(...)`,\nthis `secret` will be used to sign the outbound cookies too.\n\n\t\t\tcookies:\n\t\t\t\tenabled: true\n\t\t\t\tsecret: 'change-me'\n\n### HTTP server configuration\n\nThe `server` sections deals with how platform-ng handles the exchange, parsing, and encoding of HTTP\nrequests and responses.\n\n\t\tserver:\n\t\t\t# Use automatic gzip compression for responses?\n\t\t\tcompress: true\n\n\t\t\t# TCP port to listen on (overriden by PORT environment variable)\n\t\t\tport: 8001\n\n\t\t\t# Is the app behind a proxy? If so, replace request.ip with X-Forwarded-For, and trust\n\t\t\t# all cookies for HTTPS-only mode.\n\t\t\tbehind_proxy: false\n\n\t\t\t# Enable\/disable various body parsers, for performance and security reasons\n\t\t\tparsers:\n\t\t\t\turlencoded: true\n\t\t\t\tjson: true\n\t\t\t\tmultipart: false # potential security problem; read http:\/\/goo.gl\/N4Bci1\n\n\t\t\t# Allow requests to change HTTP verb using 'X-HTTP-Method-Override' header?\n\t\t\tmethod_override: false\n\n### Language configuration\n\nThis section controls which protolanguages platform-ng will compile, as well as language-specific options\nfor some of the languages. (The NPM dependencies for these languages are listed in `package.json` as\n`optionalDependencies` and can be skipped entirely by calling `npm install --no-optional`.)\n\n\t\tlanguages:\n\t\t\tcoffeescript:\n\t\t\t\tenabled: true\n\n\t\t\tstylus:\n\t\t\t\tenabled: true\n\t\t\t\tinclude_css: true\t# Whether to inline @include()'d CSS files\n\t\t\t\tnib: true\t\t\t# Whether to automatically load the nib library\n\n`compile` controls generic compilation options for all language compilers. The `minify` option will\ncause the compiler to munge the output in order to produce the smallest possible code. The `expose_sources`\noption will cause the server to serve the original files (e.g. .coffee, .styl, etc) if requested, AND it\nwill ask the compiler to generate source maps, if supported.\n\n\t\tcompile:\n\t\t\tminify: true\n\t\t\texpose_sources: true \n\nplatform-ng is powered by Express. You can directly configure Express settings here. The settings are\ndocumented on [this page](http:\/\/expressjs.com\/3x\/api.html#app-settings).\n\n\t\texpress:\n\t\t\t'view engine': 'jade'","old_contents":"\tmodule.exports =\n\n## platform-ng config defaults\n\nThis literate Coffeescript file defines the default configuration options for platform-ng and explains\nhow can modify the configuration to suit your needs.\n\nWhen you call `Platform#config()` with your configuration object, this configuration is deep-extended with\nyours to produce the working configuration.\n\n### General application configuration\n\nWhat's the app called (`name`), and what environment is it running in (`env`)? For `env`, anything other\nthan the string `'production'` is automatically considered `'development'` for debuggability.\n\n\t\tapp:\n\t\t\tname: 'unnamed-app'\n\t\t\tenv: 'development'\n\n#### Sessions\n\nFor sessions, you can choose to entirely disable them by setting `enabled` to `false`. Otherwise, your\nchoices for `type` are currently `cookie` or `vanilla`.\n\nThe `cookie` type stores all session data in a garbled (not encrypted) client-side cookie, signed using\nthe `secret`.\n\nThe `vanilla` type stores the session in a server-side session store and only transmits a signed session\nID to the client.\n\n`cookie` is default for now, but `vanilla` will replace it in the next major version. The `secure` option\ndetermines whether the cookies are HTTPS-only or not.\n\n\t\t\tsession:\n\t\t\t\tenabled: true\n\t\t\t\ttype: 'cookie'\n\t\t\t\tsecret: 'change-me'\n\t\t\t\tsecure: false\n\n#### Cookie parser\n\nThe cookie parser transforms the `cookie` header into `request.cookies`, `request.signedCookies`, and\n`request.secureCookies` objects. You still have to use `response.cookie(...)` and\/or \n`response.clearCookie(...)` to actually manipulate cookies. The `secret` defined here will be used to\nverify signed cookies, and, if you set `{signed: true}` in the third argument to `response.cookie(...)`,\nthis `secret` will be used to sign the outbound cookies too.\n\n\t\t\tcookies:\n\t\t\t\tenabled: true\n\t\t\t\tsecret: 'change-me'\n\n### HTTP server configuration\n\nThe `server` sections deals with how platform-ng handles the exchange, parsing, and encoding of HTTP\nrequests and responses.\n\n\t\tserver:\n\t\t\t# Use automatic gzip compression for responses?\n\t\t\tcompress: true\n\n\t\t\t# TCP port to listen on (overriden by PORT environment variable)\n\t\t\tport: 8001\n\n\t\t\t# Is the app behind a proxy? If so, replace request.ip with X-Forwarded-For, and trust\n\t\t\t# all cookies for HTTPS-only mode.\n\t\t\tbehind_proxy: false\n\n\t\t\t# Enable\/disable various body parsers, for performance and security reasons\n\t\t\tparsers:\n\t\t\t\turlencoded: true\n\t\t\t\tjson: true\n\t\t\t\tmultipart: false # potential security problem; read http:\/\/goo.gl\/N4Bci1\n\n\t\t\t# Allow requests to change HTTP verb using 'X-HTTP-Method-Override' header?\n\t\t\tmethod_override: false\n\n### Language configuration\n\nThis section controls which protolanguages platform-ng will compile, as well as language-specific options\nfor some of the languages. (The NPM dependencies for these languages are listed in `package.json` as\n`optionalDependencies` and can be skipped entirely by calling `npm install --no-optional`.)\n\n\t\tlanguages:\n\t\t\tcoffeescript:\n\t\t\t\tenabled: true\n\n\t\t\tstylus:\n\t\t\t\tenabled: true\n\t\t\t\tinclude_css: true\t# Whether to inline @include()'d CSS files\n\t\t\t\tnib: true\t\t\t# Whether to automatically load the nib library\n\n`compile` controls generic compilation options for all language compilers. The `minify` option will\ncause the compiler to munge the output in order to produce the smallest possible code. The `expose_sources`\noption will cause the server to serve the original files (e.g. .coffee, .styl, etc) if requested, AND it\nwill ask the compiler to generate source maps, if supported.\n\n\t\tcompile:\n\t\t\tminify: true\n\t\t\texpose_sources: true \n\nplatform-ng is powered by Express. You can directly configure Express settings here. The settings are\ndocumented on [this page](http:\/\/expressjs.com\/3x\/api.html#app-settings).\n\n\t\texpress:\n\t\t\t'view engine': 'jade'","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"901a6cd1ec2723fdb97d833e5e382a860b851c0d","subject":"Add rollback to snapshot","message":"Add rollback to snapshot\n","repos":"mnmtanish\/vosco-cli","old_file":"script.litcoffee","new_file":"script.litcoffee","new_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    fs     = require \"fs\"\n    path   = require \"path\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    script =\n\nSetup\n-----\n\n      'install': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        if isInstalled then process.exit 1\n        await @vosco.install defer(error)\n\n      'uninstall': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.uninstall defer(error)\n\nRepository\n----------\n\n      'get-status': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getStatus defer(error, status)\n        getType = (file) -> file.type\n        getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n        groups  = _.groupBy status, getType\n        for group, paths of groups\n          console.log \"\"\"\n          #{group}\n          #{paths.map(getPath).join(\"\\n\")}\n          \"\"\"\n\n      'get-history': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getHistory defer(error, history)\n        for commit in history\n          hash = commit.hash.substr(0, 7)\n          date = new Date(commit.date).toDateString()\n          msg  = commit.message\n          console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n\n      'get-content-history': (path) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        # show warning if file doesn\"t exist\n        console.log \"content history\"\n\nSnapshots\n---------\n\n      'preview-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        hash = hash or 'HEAD'\n        await @vosco.previewSnapshot hash, defer(error, diff)\n        console.log diff\n\n      'create-snapshot': (message) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        message = message or 'Untitled Snapshot'\n        await @vosco.createSnapshot message, defer(error)\n\n      'rollback-to-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.rollbackToSnapshot hash, defer(error)\n\nBranches\n--------\n\n      'list-branches': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"branches list\"\n\n      'select-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"select branch\"\n\n      'create-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"create new branch\"\n\n      'delete-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"delete branch\"\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      script.vosco = vosco\n      return script\n","old_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    fs     = require \"fs\"\n    path   = require \"path\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    script =\n\nSetup\n-----\n\n      'install': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        if isInstalled then process.exit 1\n        await @vosco.install defer(error)\n\n      'uninstall': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.uninstall defer(error)\n\nRepository\n----------\n\n      'get-status': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getStatus defer(error, status)\n        getType = (file) -> file.type\n        getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n        groups  = _.groupBy status, getType\n        for group, paths of groups\n          console.log \"\"\"\n          #{group}\n          #{paths.map(getPath).join(\"\\n\")}\n          \"\"\"\n\n      'get-history': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getHistory defer(error, history)\n        for commit in history\n          hash = commit.hash.substr(0, 7)\n          date = new Date(commit.date).toDateString()\n          msg  = commit.message\n          console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n\n      'get-content-history': (path) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        # show warning if file doesn\"t exist\n        console.log \"content history\"\n\nSnapshots\n---------\n\n      'preview-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        hash = hash or 'HEAD'\n        await @vosco.previewSnapshot hash, defer(error, diff)\n        console.log diff\n\n      'create-snapshot': (message) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        message = message or 'Untitled Snapshot'\n        await @vosco.createSnapshot message, defer(error)\n\n      'rollback-to-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"rollback to snapshot\"\n\nBranches\n--------\n\n      'list-branches': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"branches list\"\n\n      'select-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"select branch\"\n\n      'create-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"create new branch\"\n\n      'delete-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"delete branch\"\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      script.vosco = vosco\n      return script\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f0648abb8c9bb00aa59cb5c59339fa227f969f01","subject":"Fix link for github","message":"Fix link for github\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"client\/packages.litcoffee","new_file":"client\/packages.litcoffee","new_contents":"\nThis is where shrub's package system meets Angular's module system. Packages'\nimplementations of controllers, services, filters, providers, and directives\nare gathered and registered into Angular.\n\n\tangular.module('shrub.packages', [\n\t\t'shrub.require'\n\t\t'shrub.pkgman'\n\t])\n\n\t\t.config([\n\t\t\t'$compileProvider', '$controllerProvider', '$filterProvider'\n\t\t\t'$injector', '$provide', 'shrub-pkgmanProvider'\n\t\t\t'shrub-requireProvider'\n\t\t\t(\n\t\t\t\t$compileProvider, $controllerProvider, $filterProvider\n\t\t\t\t$injector, $provide, pkgman, {require}\n\t\t\t) ->\n\n\t\t\t\tconfig = require 'config'\n\t\t\t\tdebug = require('debug') 'shrub:angular'\n\nSet an injector so that Angular injection can occur out of band.\n\n\t\t\t\tangular_ = require 'angular'\n\t\t\t\tangular_.setInjector $injector\n\nInvoke hook `controller`.\nAllows packages to define Angular controllers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tdebug 'Registering controllers...'\n\n\t\t\t\tfor path, injected of pkgman.invoke 'controller'\n\t\t\t\t\tcontrollerName = pkgman.normalizePath path\n\t\t\t\t\tdebug controllerName\n\t\t\t\t\t$controllerProvider.register controllerName, injected\n\n\t\t\t\tdebug 'Controllers registered.'\n\n\t\t\t\tdebug 'Registering directives...'\n\nNormalize, augment, and register a directive.\n\n\t\t\t\tregisterDirective = (name, path, injected) -> ($injector) ->\n\t\t\t\t\tdirective = $injector.invoke injected\n\nEnsure a compilation function exists for the directive, and ensure that by\ndefault it returns the `link` function.\n\n\t\t\t\t\tif angular.isFunction directive\n\t\t\t\t\t\tdirective = link: directive\n\t\t\t\t\t\tdirective.compile = -> directive.link\n\t\t\t\t\telse if not directive.compile\n\t\t\t\t\t\tdirective.compile = -> directive.link\n\nProxy any defined link function, firing any attached any controllers' `link`\nmethod, as well as passing execution on to the original `link` function.\n\n\t\t\t\t\tlink = directive.link\n\t\t\t\t\tdirective.link = (scope, element, attrs, controllers) ->\n\t\t\t\t\t\tif controllers?\n\t\t\t\t\t\t\tunless angular.isArray controllers\n\t\t\t\t\t\t\t\tcontrollers = [controllers]\n\n\t\t\t\t\t\t\tfor controller in controllers\n\t\t\t\t\t\t\t\tcontroller.link? arguments...\n\n\t\t\t\t\t\tlink? arguments...\n\nEnsure the directive has a name. Defaults to the normalized path of the\nimplementing package.\n\n\t\t\t\t\tdirective.name ?= name\n\nIf controller binding is specified, the controller defaults to the directive\nname. In other words, if you define a directive and a controller in the same\npackage, and specify `directive.bindToController = true`, your directive will\ninclude the controller automatically.\n\n\t\t\t\t\tif directive.bindToController\n\t\t\t\t\t\tdirective.controller ?= directive.name\n\nHandle a bunch of internal Angular normalization.\n\n\t\t\t\t\tdirective.require ?= directive.controller and directive.name\n\t\t\t\t\tdirective.priority ?= 0\n\t\t\t\t\tdirective.restrict ?= 'EA'\n\n\t\t\t\t\tif angular.isObject directive.scope\n\t\t\t\t\t\tdirectiveIsolateBindings directive\n\nInvoke hook `augmentDirective`.\nAllows packages to augment the directives defined by packages. One example is\nthe automatic relinking functionality implemented by\n[shrub-skin](..\/packages\/shrub-skin\/client\/index.coffee#L12).\n\n\t\t\t\t\tfor injectedDirective in pkgman.invokeFlat(\n\t\t\t\t\t\t'augmentDirective', directive, path\n\t\t\t\t\t)\n\t\t\t\t\t\t$injector.invoke injectedDirective\n\nHaven't gone deep enough into Angular to understand why this has to be, but it\ndoes.\n\n\t\t\t\t\tdirective.index = 0\n\t\t\t\t\treturn [directive]\n\nInternal Angular state that we have to reset.\n\n\t\t\t\tdirectiveIsolateBindings = (directive) ->\n\n\t\t\t\t\tLOCAL_REGEXP = \/^\\s*([@&]|=(\\*?))(\\??)\\s*(\\w*)\\s*$\/\n\n\t\t\t\t\tbindings = {}\n\n\t\t\t\t\tfor scopeName, definition of directive.scope\n\t\t\t\t\t\tmatch = definition.match LOCAL_REGEXP\n\n\t\t\t\t\t\tunless match\n\t\t\t\t\t\t\tthrow angular.$$minErr('$compile')(\n\t\t\t\t\t\t\t\t'iscp'\n\t\t\t\t\t\t\t\t\"Invalid isolate scope definition for directive\n\t\t\t\t\t\t\t\t'{0}'. Definition: {... {1}: '{2}' ...}\"\n\t\t\t\t\t\t\t\tdirective.name, scopeName, definition\n\t\t\t\t\t\t\t)\n\n\t\t\t\t\t\tbindings[scopeName] =\n\t\t\t\t\t\t\tmode: match[1][0]\n\t\t\t\t\t\t\tcollection: match[2] is '*'\n\t\t\t\t\t\t\toptional: match[3] is '?'\n\t\t\t\t\t\t\tattrName: match[4] or scopeName\n\n\t\t\t\t\tdirective.$$isolateBindings = bindings\n\nInvoke hook `directive`.\nAllows packages to define Angular directives. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tfor path, injected of pkgman.invoke 'directive'\n\t\t\t\t\tdo (path, injected) ->\n\t\t\t\t\t\tdirectiveName = pkgman.normalizePath path\n\n\t\t\t\t\t\tdebug directiveName\n\nFirst, register it through Angular's normal registration mechanism. This sets\na bunch of internal state we don't have access to.\n\n\t\t\t\t\t\t$compileProvider.directive directiveName, injected\n\nFollow that by normalizing, augmenting, and registering the directive again.\nIt will run over the previous definition, ensuring everything works nicely.\n\n\t\t\t\t\t\t$provide.factory \"#{directiveName}Directive\", [\n\t\t\t\t\t\t\t'$injector'\n\t\t\t\t\t\t\tregisterDirective directiveName, path, injected\n\t\t\t\t\t\t]\n\n\t\t\t\tdebug 'Directives registered.'\n\n\t\t\t\tdebug 'Registering filters...'\n\nInvoke hook `filter`.\nAllows packages to define Angular filters. Implementations should return a\nfunction.\n\n\t\t\t\tfor path, injected of pkgman.invoke 'filter'\n\t\t\t\t\tfilterName = pkgman.normalizePath path\n\n\t\t\t\t\tdebug filterName\n\n\t\t\t\t\t$filterProvider.register filterName, injected\n\n\t\t\t\tdebug 'Filters registered.'\n\nInvoke hook `provider`.\nAllows packages to define Angular providers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tdebug 'Registering providers...'\n\n\t\t\t\tfor path, provider of pkgman.invoke 'provider'\n\t\t\t\t\tdebug path\n\n\t\t\t\t\t$provide.provider path, provider\n\n\t\t\t\tdebug 'Providers registered.'\n\nInvoke hook `service`.\nAllows packages to define Angular services. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tdebug 'Registering services...'\n\n\t\t\t\tfor path, injected of pkgman.invoke 'service'\n\t\t\t\t\tdebug path\n\n\t\t\t\t\t$provide.service path, injected\n\n\t\t\t\tdebug 'Services registered.'\n\n\t\t])\n\nThe module that provides Angular with access to Shrub's package manager.\n\n\tangular.module('shrub.pkgman', [\n\t\t'shrub.require'\n\t])\n\n\t\t.provider 'shrub-pkgman', [\n\t\t\t'$provide', 'shrub-requireProvider'\n\t\t\t($provide, {require}) ->\n\n\t\t\t\tconfig = require 'config'\n\t\t\t\tdebug = require('debug') 'shrub:pkgman'\n\t\t\t\tpkgman = require 'pkgman'\n\n\t\t\t\tdebug 'Loading packages...'\n\nLoad the package list from configuration.\n\n\t\t\t\tpkgman.registerPackageList config.get 'packageList'\n\n\t\t\t\tdebug 'Packages loaded.'\n\nSimply pass along pkgman as the 'service'.\n\n\t\t\t\tpkgman.$get = -> pkgman\n\n\t\t\t\treturn pkgman\n\t\t]\n","old_contents":"\nThis is where shrub's package system meets Angular's module system. Packages'\nimplementations of controllers, services, filters, providers, and directives\nare gathered and registered into Angular.\n\n\tangular.module('shrub.packages', [\n\t\t'shrub.require'\n\t\t'shrub.pkgman'\n\t])\n\n\t\t.config([\n\t\t\t'$compileProvider', '$controllerProvider', '$filterProvider'\n\t\t\t'$injector', '$provide', 'shrub-pkgmanProvider'\n\t\t\t'shrub-requireProvider'\n\t\t\t(\n\t\t\t\t$compileProvider, $controllerProvider, $filterProvider\n\t\t\t\t$injector, $provide, pkgman, {require}\n\t\t\t) ->\n\n\t\t\t\tconfig = require 'config'\n\t\t\t\tdebug = require('debug') 'shrub:angular'\n\nSet an injector so that Angular injection can occur out of band.\n\n\t\t\t\tangular_ = require 'angular'\n\t\t\t\tangular_.setInjector $injector\n\nInvoke hook `controller`.\nAllows packages to define Angular controllers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tdebug 'Registering controllers...'\n\n\t\t\t\tfor path, injected of pkgman.invoke 'controller'\n\t\t\t\t\tcontrollerName = pkgman.normalizePath path\n\t\t\t\t\tdebug controllerName\n\t\t\t\t\t$controllerProvider.register controllerName, injected\n\n\t\t\t\tdebug 'Controllers registered.'\n\n\t\t\t\tdebug 'Registering directives...'\n\nNormalize, augment, and register a directive.\n\n\t\t\t\tregisterDirective = (name, path, injected) -> ($injector) ->\n\t\t\t\t\tdirective = $injector.invoke injected\n\nEnsure a compilation function exists for the directive, and ensure that by\ndefault it returns the `link` function.\n\n\t\t\t\t\tif angular.isFunction directive\n\t\t\t\t\t\tdirective = link: directive\n\t\t\t\t\t\tdirective.compile = -> directive.link\n\t\t\t\t\telse if not directive.compile\n\t\t\t\t\t\tdirective.compile = -> directive.link\n\nProxy any defined link function, firing any attached any controllers' `link`\nmethod, as well as passing execution on to the original `link` function.\n\n\t\t\t\t\tlink = directive.link\n\t\t\t\t\tdirective.link = (scope, element, attrs, controllers) ->\n\t\t\t\t\t\tif controllers?\n\t\t\t\t\t\t\tunless angular.isArray controllers\n\t\t\t\t\t\t\t\tcontrollers = [controllers]\n\n\t\t\t\t\t\t\tfor controller in controllers\n\t\t\t\t\t\t\t\tcontroller.link? arguments...\n\n\t\t\t\t\t\tlink? arguments...\n\nEnsure the directive has a name. Defaults to the normalized path of the\nimplementing package.\n\n\t\t\t\t\tdirective.name ?= name\n\nIf controller binding is specified, the controller defaults to the directive\nname. In other words, if you define a directive and a controller in the same\npackage, and specify `directive.bindToController = true`, your directive will\ninclude the controller automatically.\n\n\t\t\t\t\tif directive.bindToController\n\t\t\t\t\t\tdirective.controller ?= directive.name\n\nHandle a bunch of internal Angular normalization.\n\n\t\t\t\t\tdirective.require ?= directive.controller and directive.name\n\t\t\t\t\tdirective.priority ?= 0\n\t\t\t\t\tdirective.restrict ?= 'EA'\n\n\t\t\t\t\tif angular.isObject directive.scope\n\t\t\t\t\t\tdirectiveIsolateBindings directive\n\nInvoke hook `augmentDirective`.\nAllows packages to augment the directives defined by packages. One example is\nthe automatic relinking functionality implemented by [shrub-skin](..\/packages\/shrub-skin\/client\/index.html#implementshookaugmentdirective).\n\n\t\t\t\t\tfor injectedDirective in pkgman.invokeFlat(\n\t\t\t\t\t\t'augmentDirective', directive, path\n\t\t\t\t\t)\n\t\t\t\t\t\t$injector.invoke injectedDirective\n\nHaven't gone deep enough into Angular to understand why this has to be, but it\ndoes.\n\n\t\t\t\t\tdirective.index = 0\n\t\t\t\t\treturn [directive]\n\nInternal Angular state that we have to reset.\n\n\t\t\t\tdirectiveIsolateBindings = (directive) ->\n\n\t\t\t\t\tLOCAL_REGEXP = \/^\\s*([@&]|=(\\*?))(\\??)\\s*(\\w*)\\s*$\/\n\n\t\t\t\t\tbindings = {}\n\n\t\t\t\t\tfor scopeName, definition of directive.scope\n\t\t\t\t\t\tmatch = definition.match LOCAL_REGEXP\n\n\t\t\t\t\t\tunless match\n\t\t\t\t\t\t\tthrow angular.$$minErr('$compile')(\n\t\t\t\t\t\t\t\t'iscp'\n\t\t\t\t\t\t\t\t\"Invalid isolate scope definition for directive\n\t\t\t\t\t\t\t\t'{0}'. Definition: {... {1}: '{2}' ...}\"\n\t\t\t\t\t\t\t\tdirective.name, scopeName, definition\n\t\t\t\t\t\t\t)\n\n\t\t\t\t\t\tbindings[scopeName] =\n\t\t\t\t\t\t\tmode: match[1][0]\n\t\t\t\t\t\t\tcollection: match[2] is '*'\n\t\t\t\t\t\t\toptional: match[3] is '?'\n\t\t\t\t\t\t\tattrName: match[4] or scopeName\n\n\t\t\t\t\tdirective.$$isolateBindings = bindings\n\nInvoke hook `directive`.\nAllows packages to define Angular directives. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tfor path, injected of pkgman.invoke 'directive'\n\t\t\t\t\tdo (path, injected) ->\n\t\t\t\t\t\tdirectiveName = pkgman.normalizePath path\n\n\t\t\t\t\t\tdebug directiveName\n\nFirst, register it through Angular's normal registration mechanism. This sets\na bunch of internal state we don't have access to.\n\n\t\t\t\t\t\t$compileProvider.directive directiveName, injected\n\nFollow that by normalizing, augmenting, and registering the directive again.\nIt will run over the previous definition, ensuring everything works nicely.\n\n\t\t\t\t\t\t$provide.factory \"#{directiveName}Directive\", [\n\t\t\t\t\t\t\t'$injector'\n\t\t\t\t\t\t\tregisterDirective directiveName, path, injected\n\t\t\t\t\t\t]\n\n\t\t\t\tdebug 'Directives registered.'\n\n\t\t\t\tdebug 'Registering filters...'\n\nInvoke hook `filter`.\nAllows packages to define Angular filters. Implementations should return a\nfunction.\n\n\t\t\t\tfor path, injected of pkgman.invoke 'filter'\n\t\t\t\t\tfilterName = pkgman.normalizePath path\n\n\t\t\t\t\tdebug filterName\n\n\t\t\t\t\t$filterProvider.register filterName, injected\n\n\t\t\t\tdebug 'Filters registered.'\n\nInvoke hook `provider`.\nAllows packages to define Angular providers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tdebug 'Registering providers...'\n\n\t\t\t\tfor path, provider of pkgman.invoke 'provider'\n\t\t\t\t\tdebug path\n\n\t\t\t\t\t$provide.provider path, provider\n\n\t\t\t\tdebug 'Providers registered.'\n\nInvoke hook `service`.\nAllows packages to define Angular services. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n\t\t\t\tdebug 'Registering services...'\n\n\t\t\t\tfor path, injected of pkgman.invoke 'service'\n\t\t\t\t\tdebug path\n\n\t\t\t\t\t$provide.service path, injected\n\n\t\t\t\tdebug 'Services registered.'\n\n\t\t])\n\nThe module that provides Angular with access to Shrub's package manager.\n\n\tangular.module('shrub.pkgman', [\n\t\t'shrub.require'\n\t])\n\n\t\t.provider 'shrub-pkgman', [\n\t\t\t'$provide', 'shrub-requireProvider'\n\t\t\t($provide, {require}) ->\n\n\t\t\t\tconfig = require 'config'\n\t\t\t\tdebug = require('debug') 'shrub:pkgman'\n\t\t\t\tpkgman = require 'pkgman'\n\n\t\t\t\tdebug 'Loading packages...'\n\nLoad the package list from configuration.\n\n\t\t\t\tpkgman.registerPackageList config.get 'packageList'\n\n\t\t\t\tdebug 'Packages loaded.'\n\nSimply pass along pkgman as the 'service'.\n\n\t\t\t\tpkgman.$get = -> pkgman\n\n\t\t\t\treturn pkgman\n\t\t]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"53d38807de5ff1957c4802d83057a6520bd601d2","subject":"Removed unneeded property","message":"Removed unneeded property\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    Array.prototype.last = -> this[this.length - 1]\n\n    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n\n    code_root = process.env.MADUL_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n\n    WRAPPED = { }\n\n    _INITIALIZERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push method\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'listen'\n          'fire'\n          'warn'\n          'report'\n          'do_wrap'\n          'wrap_methods'\n          'strip'\n          'make_available'\n          'hydrate'\n          'finish_up'\n          'initialize'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      listen: (event, callback) => Madul.LISTEN \"*.#{@clazz}.#{event}\", callback\n\n      fire: (event, args) => Madul.FIRE \"@.#{@clazz}.#{event}\", args\n\n      warn: (event, details) => Madul.FIRE \"!.#{@clazz}.#{event}\", details\n\n      report: (method, state, id, args) =>\n        @fire \"#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      do_wrap: (method) =>\n        callMe = @[method]\n\n        Madul.FIRE \"$.#{@clazz}.#{method}.wrap\"\n\n        @[\"_#{method}\"] = @[method]\n\n        respond = (id, deferred) =>\n          (state, data) =>\n            process.nextTick =>\n              deferred[state] data\n\n              @report method, state, id, data\n\n        WRAPPED[@clazz].push method\n\n        @[method] = =>\n          id   = uuid.v4fast()\n          def  = q.defer()\n          args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n          res  = respond id, def\n\n          args.push (out) => res 'resolve', out\n          args.push (err) => res 'reject',  err\n          args.push (out) => res 'notify',  out\n\n          @report method, 'invoke', id, args\n\n          @[\"_#{method}\"].apply @, args\n\n          def.promise\n\n      wrap_methods: =>\n        props = Object.keys @constructor.prototype\n\n        for prop in props\n          if prop[0] != '_'                      &&\n             typeof @[prop] == 'function'        &&\n             typeof @[\"_#{prop}\"] == 'undefined' &&\n             WRAP(@clazz, prop) == true\n\n            @do_wrap prop\n\n            INITIALIZERS @clazz, prop if prop[0] == '$'\n\n      strip: (name) => name.toLowerCase().replace \/\\W+\/g, ''\n\n      make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[@strip name] = mod\n\n      hydrate: (deps, done) =>\n        load = (name, path, loaded) =>\n          mod = require path\n\n          if typeof mod == 'function'\n            new mod name\n              .initialize @ctor_params?[name]\n              .then (mod) =>\n                @make_available name, mod\n                loaded()\n          else\n            @make_available name, mod\n            loaded()\n\n        check = (path, dep, finished) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              Madul.FIRE '$.error', err\n\n              done type: 'ERROR', info: err\n            else\n              async.each files, (f, next) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.stat depth, (e, s) =>\n                  if s.isDirectory() && f[0] != '.'\n                    check depth, dep, next\n                  else if s.isFile() && f.substring(0, f.length - 3) == dep\n                    load f.substring(0, f.length - 3), depth, => do_add dep, next\n                  else\n                    next()\n              , finished\n\n        add_dependency = (name, mod) =>\n          Madul.FIRE \"$.#{@clazz}.dependency.register\", name\n          @[underscore name] = mod\n\n        do_add = (name, next) =>\n          add_dependency name, available[@strip name]\n          next()\n\n        add = (name, resource, next) =>\n          @make_available name, require resource\n          do_add name, next\n\n        async.each deps, (d, next) =>\n          if @[underscore d]? == false\n            if available[@strip d]? == true\n              do_add d, next\n            else\n              try\n                add d, d, next\n              catch e\n                cwd = process.cwd()\n                pkg = \"#{cwd}\/node_modules\/#{d}\/package.json\"\n\n                fs.stat pkg, (err, stat) =>\n                  if stat?.isFile()\n                    fs.readFile pkg, 'utf8', (err, data) =>\n                      json = JSON.parse data\n                      main = json.main || json._main || 'index.js'\n\n                      add d, \"#{cwd}\/node_modules\/#{d}\/#{main}\", next\n                  else\n                    check \"#{cwd}\/#{code_root}\", d, next\n          else\n            next()\n        , done\n\n      finish_up: (resolve, args) =>\n        async.each _INITIALIZERS[@clazz], (initializer, next) =>\n          @[initializer] args\n            .then next\n        , =>\n          @make_available @clazz, @\n          resolve @\n          Madul.FIRE \"$.#{@clazz}.initialized\"\n\n      initialize: =>\n        deferred = q.defer()\n        args     = if arguments[0]? then Array.prototype.slice.call arguments else undefined\n\n        @clazz = @constructor.name unless @clazz?\n\n        Madul.FIRE \"$.#{@clazz}.request_instance\", args\n\n        if initialized[@clazz] != true\n          Madul.FIRE \"$.#{@clazz}.initialize\", args\n\n          initialized[@clazz] = true\n\n          @wrap_methods()\n\n          if @deps?\n            @hydrate @deps, => @finish_up deferred.resolve, args\n          else\n            @finish_up deferred.resolve, args\n        else\n          process.nextTick => deferred.resolve available[@strip @clazz]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    Array.prototype.last = -> this[this.length - 1]\n\n    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n\n    code_root = process.env.MADUL_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n\n    WRAPPED = { }\n\n    _INITIALIZERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push method\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'listen'\n          'fire'\n          'warn'\n          'report'\n          'do_wrap'\n          'wrap_methods'\n          'strip'\n          'make_available'\n          'hydrate'\n          'finish_up'\n          'initialize'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      INITIALIZERS: [ ]\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      listen: (event, callback) => Madul.LISTEN \"*.#{@clazz}.#{event}\", callback\n\n      fire: (event, args) => Madul.FIRE \"@.#{@clazz}.#{event}\", args\n\n      warn: (event, details) => Madul.FIRE \"!.#{@clazz}.#{event}\", details\n\n      report: (method, state, id, args) =>\n        @fire \"#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      do_wrap: (method) =>\n        callMe = @[method]\n\n        Madul.FIRE \"$.#{@clazz}.#{method}.wrap\"\n\n        @[\"_#{method}\"] = @[method]\n\n        respond = (id, deferred) =>\n          (state, data) =>\n            process.nextTick =>\n              deferred[state] data\n\n              @report method, state, id, data\n\n        WRAPPED[@clazz].push method\n\n        @[method] = =>\n          id   = uuid.v4fast()\n          def  = q.defer()\n          args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n          res  = respond id, def\n\n          args.push (out) => res 'resolve', out\n          args.push (err) => res 'reject',  err\n          args.push (out) => res 'notify',  out\n\n          @report method, 'invoke', id, args\n\n          @[\"_#{method}\"].apply @, args\n\n          def.promise\n\n      wrap_methods: =>\n        props = Object.keys @constructor.prototype\n\n        for prop in props\n          if prop[0] != '_'                      &&\n             typeof @[prop] == 'function'        &&\n             typeof @[\"_#{prop}\"] == 'undefined' &&\n             WRAP(@clazz, prop) == true\n\n            @do_wrap prop\n\n            INITIALIZERS @clazz, prop if prop[0] == '$'\n\n      strip: (name) => name.toLowerCase().replace \/\\W+\/g, ''\n\n      make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[@strip name] = mod\n\n      hydrate: (deps, done) =>\n        load = (name, path, loaded) =>\n          mod = require path\n\n          if typeof mod == 'function'\n            new mod name\n              .initialize @ctor_params?[name]\n              .then (mod) =>\n                @make_available name, mod\n                loaded()\n          else\n            @make_available name, mod\n            loaded()\n\n        check = (path, dep, finished) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              Madul.FIRE '$.error', err\n\n              done type: 'ERROR', info: err\n            else\n              async.each files, (f, next) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.stat depth, (e, s) =>\n                  if s.isDirectory() && f[0] != '.'\n                    check depth, dep, next\n                  else if s.isFile() && f.substring(0, f.length - 3) == dep\n                    load f.substring(0, f.length - 3), depth, => do_add dep, next\n                  else\n                    next()\n              , finished\n\n        add_dependency = (name, mod) =>\n          Madul.FIRE \"$.#{@clazz}.dependency.register\", name\n          @[underscore name] = mod\n\n        do_add = (name, next) =>\n          add_dependency name, available[@strip name]\n          next()\n\n        add = (name, resource, next) =>\n          @make_available name, require resource\n          do_add name, next\n\n        async.each deps, (d, next) =>\n          if @[underscore d]? == false\n            if available[@strip d]? == true\n              do_add d, next\n            else\n              try\n                add d, d, next\n              catch e\n                cwd = process.cwd()\n                pkg = \"#{cwd}\/node_modules\/#{d}\/package.json\"\n\n                fs.stat pkg, (err, stat) =>\n                  if stat?.isFile()\n                    fs.readFile pkg, 'utf8', (err, data) =>\n                      json = JSON.parse data\n                      main = json.main || json._main || 'index.js'\n\n                      add d, \"#{cwd}\/node_modules\/#{d}\/#{main}\", next\n                  else\n                    check \"#{cwd}\/#{code_root}\", d, next\n          else\n            next()\n        , done\n\n      finish_up: (resolve, args) =>\n        async.each _INITIALIZERS[@clazz], (initializer, next) =>\n          @[initializer] args\n            .then next\n        , =>\n          @make_available @clazz, @\n          resolve @\n          Madul.FIRE \"$.#{@clazz}.initialized\"\n\n      initialize: =>\n        deferred = q.defer()\n        args     = if arguments[0]? then Array.prototype.slice.call arguments else undefined\n\n        @clazz = @constructor.name unless @clazz?\n\n        Madul.FIRE \"$.#{@clazz}.request_instance\", args\n\n        if initialized[@clazz] != true\n          Madul.FIRE \"$.#{@clazz}.initialize\", args\n\n          initialized[@clazz] = true\n\n          @wrap_methods()\n\n          if @deps?\n            @hydrate @deps, => @finish_up deferred.resolve, args\n          else\n            @finish_up deferred.resolve, args\n        else\n          process.nextTick => deferred.resolve available[@strip @clazz]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4126dc788eb6d5b3b15878aa6419799ec580530d","subject":"Improved LiveReload hostname","message":"Improved LiveReload hostname\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-grunt\/index.litcoffee","new_file":"packages\/shrub-grunt\/index.litcoffee","new_contents":"# Grunt build process\n\n    config = require 'config'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAssetsMiddleware`.\n\n      registrar.registerHook 'shrubAssetsMiddleware', ->\n\n        label: 'Livereload'\n        middleware: [\n\n          (assets, next) ->\n\n            return next() if 'production' is config.get 'NODE_ENV'\n\n            hostname = config.get 'packageSettings:shrub-core:siteHostname'\n            [hostname] = hostname.split ':'\n            assets.scripts.push \"http:\/\/#{hostname}:35729\/livereload.js\"\n\n            next()\n\n        ]\n\n#### Implements hook `shrubConfigClientAlter`.\n\n      registrar.registerHook 'shrubConfigClientAlter', (req, config_) ->\n        return unless req.grunt?\n\n        config_.set 'packageConfig:shrub-socket', manager: module: 'shrub-socket\/dummy'\n        config_.set 'packageConfig:shrub-user', name: 'Anonymous'\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig, grunt) ->\n\n        gruntConfig.configureTask 'clean', 'shrub', [\n          'app'\n          'build'\n        ]\n\n        gruntConfig.configureTask 'concat', 'shrub', files: [\n          src: [\n            'build\/js\/app\/{app-bundled,modules}.js'\n          ]\n          dest: 'app\/lib\/shrub\/shrub.js'\n        ]\n\n        gruntConfig.configureTask 'uglify', 'shrub', files: [\n          src: [\n            'app\/lib\/shrub\/shrub.js'\n          ]\n          dest: 'app\/lib\/shrub\/shrub.min.js'\n        ]\n\n        gruntConfig.registerTask 'executeFunction:shrub', ->\n          done = @async()\n\nPass arguments to the child process.\n\n          args = process.argv.slice 2\n\nPass the environment to the child process.\n\n          options = env: process.env\n\nFork it.\n\n          {fork} = require 'child_process'\n          child = fork \"#{__dirname}\/..\/..\/server.litcoffee\", args, options\n          child.on 'close', (code) ->\n            return done() if code is 0\n\n            grunt.fail.fatal 'Server process failed', code\n\n        gruntConfig.registerTask 'build:shrub', [\n          'concat:shrub'\n        ]\n\n        gruntConfig.registerTask 'production:shrub', [\n          'newer:uglify:shrub'\n        ]\n\n        gruntConfig.registerTask 'execute', [\n          'buildOnce'\n          'executeFunction:shrub'\n        ]\n\n        gruntConfig.loadNpmTasks [\n          'grunt-contrib-clean'\n          'grunt-contrib-coffee'\n          'grunt-contrib-concat'\n          'grunt-contrib-copy'\n          'grunt-contrib-uglify'\n          'grunt-contrib-watch'\n          'grunt-newer'\n          'grunt-wrap'\n        ]\n\n#### Implements hook `shrubGruntConfigAlter`.\n\n      registrar.registerHook 'shrubGruntConfigAlter', (gruntConfig) ->\n\n        gruntConfig.registerTask 'build', [\n          'build:shrub'\n        ]\n\n        gruntConfig.registerTask 'production', [\n          'production:shrub'\n        ]\n\n      registrar.recur [\n        'dox', 'lint', 'modules', 'tests'\n      ]\n","old_contents":"# Grunt build process\n\n    config = require 'config'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAssetsMiddleware`.\n\n      registrar.registerHook 'shrubAssetsMiddleware', ->\n\n        label: 'Livereload'\n        middleware: [\n\n          (assets, next) ->\n\n            return next() if 'production' is config.get 'NODE_ENV'\n\n            assets.scripts.push 'http:\/\/localhost:35729\/livereload.js'\n\n            next()\n\n        ]\n\n#### Implements hook `shrubConfigClientAlter`.\n\n      registrar.registerHook 'shrubConfigClientAlter', (req, config_) ->\n        return unless req.grunt?\n\n        config_.set 'packageConfig:shrub-socket', manager: module: 'shrub-socket\/dummy'\n        config_.set 'packageConfig:shrub-user', name: 'Anonymous'\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig, grunt) ->\n\n        gruntConfig.configureTask 'clean', 'shrub', [\n          'app'\n          'build'\n        ]\n\n        gruntConfig.configureTask 'concat', 'shrub', files: [\n          src: [\n            'build\/js\/app\/{app-bundled,modules}.js'\n          ]\n          dest: 'app\/lib\/shrub\/shrub.js'\n        ]\n\n        gruntConfig.configureTask 'uglify', 'shrub', files: [\n          src: [\n            'app\/lib\/shrub\/shrub.js'\n          ]\n          dest: 'app\/lib\/shrub\/shrub.min.js'\n        ]\n\n        gruntConfig.registerTask 'executeFunction:shrub', ->\n          done = @async()\n\nPass arguments to the child process.\n\n          args = process.argv.slice 2\n\nPass the environment to the child process.\n\n          options = env: process.env\n\nFork it.\n\n          {fork} = require 'child_process'\n          child = fork \"#{__dirname}\/..\/..\/server.litcoffee\", args, options\n          child.on 'close', (code) ->\n            return done() if code is 0\n\n            grunt.fail.fatal 'Server process failed', code\n\n        gruntConfig.registerTask 'build:shrub', [\n          'concat:shrub'\n        ]\n\n        gruntConfig.registerTask 'production:shrub', [\n          'newer:uglify:shrub'\n        ]\n\n        gruntConfig.registerTask 'execute', [\n          'buildOnce'\n          'executeFunction:shrub'\n        ]\n\n        gruntConfig.loadNpmTasks [\n          'grunt-contrib-clean'\n          'grunt-contrib-coffee'\n          'grunt-contrib-concat'\n          'grunt-contrib-copy'\n          'grunt-contrib-uglify'\n          'grunt-contrib-watch'\n          'grunt-newer'\n          'grunt-wrap'\n        ]\n\n#### Implements hook `shrubGruntConfigAlter`.\n\n      registrar.registerHook 'shrubGruntConfigAlter', (gruntConfig) ->\n\n        gruntConfig.registerTask 'build', [\n          'build:shrub'\n        ]\n\n        gruntConfig.registerTask 'production', [\n          'production:shrub'\n        ]\n\n      registrar.recur [\n        'dox', 'lint', 'modules', 'tests'\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bcd865aff25de479183a23a362138f7d9cb57250","subject":"fixed indentation","message":"fixed indentation\n","repos":"nhz-io\/cnl","old_file":"source\/lib\/event.litcoffee","new_file":"source\/lib\/event.litcoffee","new_contents":"# CLASS: Event\n* Extends: [Base][Base]\n* Parent: [lib][lib]\n\nThis class provides a data transport between instances of [Evented][Evented].\nAny instance of this class must have at least the **type** property set\nso that [Evented][Evented] methods will not drop it. This class does not provide\nany functionality and mostly saves as the envelope for data.\n\n    module.exports = class Event extends require '.\/base'\n\n## CONSTRUCTOR\n\n### new Event(type)\n### new Event(callback)\n### new Event(args, callback)\n### new Event(type, callback)\n\n* Returns: [Event][Event]\n\nCreate the event. All the key-value pairs from **args** will be copied\nto the event instance. If **callback** is provided in the **args**, it\nwill override the **callback** provided as the second argument.\n\nUpon instance creation, the event will log it's creation timestamp. This\ncan be disabled by passing `timestamp:null` to constructor.\n\nAny Event instance at its minimum will have **timestamp** property. This\nis the only mandatory property.\n\nCreate Event instance, accepting arguments in multiple forms.\n\n      constructor: (args = {}, callback) ->\n\nSet the event type to the value of the first argument if it is a [String][String]\n\n        if typeof args is 'string' then args = type:args\n\nOtherwise, set the `args` to empty [Object][Object] and `callback` to the value of the\nfirst argument if it is a [Function][Function].\n\n        else if (arguments.length < 2) and typeof args is 'function'\n          callback = args\n          args = {}\n\nCopy contents of args into this instance\n\n        this[key] = value for key, value of args\n\nOverwrite the **#callback** only if it is not set.\n\n        @callback = callback if callback and not @callback\n\nCalculate and set the event creation timestamp if it was not disabled or set from **args**\n\n        if (args.timestamp is true) or not args.hasOwnProperty 'timestamp'\n          date = Date.now()\n          perf = performance?.now() or 0\n          @timestamp = 1000 * date + Math.floor 1000 * (perf - Math.floor perf)\n\n### PARAMETERS\n**args**\n* Type: [Object][Object] - event data\n\n**args.type**\n* Type: [String][String] - event type\n\n**args.callback**\n* Type: [Function][Function] - event completion callback\n* Optional\n* Overrides the **callback** parameter\n\n**args.timestamp**\n* Type: [Boolean][Boolean] - set to `false` to disable the timestamp calculation\n* Type: [Number][Number] - event timestamp\n\n**type**\n* Type: [String][String] - event type\n\n**callback**\n* Type: [Function][Function] - event completion callback\n* Optional\n\n---\n\n## PROPERTIES\n\n### #type\n* Type: [String][String] - event type\n\n### #phase\n* Type: [Number][Number] - event phase (1..3)\n\n### #timestamp\n* Type: [Number][Number] - event creation timestamp\n\n### #callback\n* Type: [Function][Function] - event completion callback\n\n---\n\n## FLAGS\n\n### #started\n* Type: [Boolean][Boolean] - event **started** flag\n\n### #stopped\n* Type: [Boolean][Boolean] - event **stopped** flag\n\n### #canceled\n* Type: [Boolean][Boolean] - event **canceled** flag\n\n### #aborted\n* Type: [Boolean][Boolean] - event **aborted** flag\n\n### #done\n* Type: [Boolean][Boolean] - event **done** flag\n\n---\n\n## METHODS\n\n### #start()\n* Returns: [Event][Event]\n\n**started** flag setter\n\n      start: -> (@started = yes) and this\n\n---\n\n### #stop()\n* Returns: [Event][Event]\n\n**stopped** flag setter\n\n      stop: -> (@stopped = yes) and this\n\n---\n\n### #cancel()\n* Returns: [Event][Event]\n\n**canceled** flag setter\n\n      cancel: -> (@canceled = yes) and this\n\n---\n\n### #abort()\n* Returns: [Event][Event]\n\n**aborted** flag setter\n\n      abort: -> (@aborted = yes) and this\n\n---\n\n### #finish()\n* Returns: [Event][Event]\n\n**done** flag setter\n\n      finish: -> (@done = yes) and this\n\n[lib]: .\/index.litcoffee\n[Evented]: .\/evented.litcoffee\n[Base]: .\/base.litcoffee\n[Event]: .\/event.litcoffee\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[String]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/String\n[Function]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Function\n[Boolean]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Boolean\n[Number]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Number\n","old_contents":"# CLASS: Event\n* Extends: [Base][Base]\n* Parent: [lib][lib]\n\nThis class provides a data transport between instances of [Evented][Evented].\nAny instance of this class must have at least the **type** property set\nso that [Evented][Evented] methods will not drop it. This class does not provide\nany functionality and mostly saves as the envelope for data.\n\n      module.exports = class Event extends require '.\/base'\n\n## CONSTRUCTOR\n\n### new Event(type)\n### new Event(callback)\n### new Event(args, callback)\n### new Event(type, callback)\n\n* Returns: [Event][Event]\n\nCreate the event. All the key-value pairs from **args** will be copied\nto the event instance. If **callback** is provided in the **args**, it\nwill override the **callback** provided as the second argument.\n\nUpon instance creation, the event will log it's creation timestamp. This\ncan be disabled by passing `timestamp:null` to constructor.\n\nAny Event instance at its minimum will have **timestamp** property. This\nis the only mandatory property.\n\nCreate Event instance, accepting arguments in multiple forms.\n\n        constructor: (args = {}, callback) ->\n\nSet the event type to the value of the first argument if it is a [String][String]\n\n          if typeof args is 'string' then args = type:args\n\nOtherwise, set the `args` to empty [Object][Object] and `callback` to the value of the\nfirst argument if it is a [Function][Function].\n\n          else if (arguments.length < 2) and typeof args is 'function'\n            callback = args\n            args = {}\n\nCopy contents of args into this instance\n\n          this[key] = value for key, value of args\n\nOverwrite the **#callback** only if it is not set.\n\n          @callback = callback if callback and not @callback\n\nCalculate and set the event creation timestamp if it was not disabled or set from **args**\n\n          if (args.timestamp is true) or not args.hasOwnProperty 'timestamp'\n            date = Date.now()\n            perf = performance?.now() or 0\n            @timestamp = 1000 * date + Math.floor 1000 * (perf - Math.floor perf)\n\n### PARAMETERS\n**args**\n* Type: [Object][Object] - event data\n\n**args.type**\n* Type: [String][String] - event type\n\n**args.callback**\n* Type: [Function][Function] - event completion callback\n* Optional\n* Overrides the **callback** parameter\n\n**args.timestamp**\n* Type: [Boolean][Boolean] - set to `false` to disable the timestamp calculation\n* Type: [Number][Number] - event timestamp\n\n**type**\n* Type: [String][String] - event type\n\n**callback**\n* Type: [Function][Function] - event completion callback\n* Optional\n\n---\n\n## PROPERTIES\n\n### #type\n* Type: [String][String] - event type\n\n### #phase\n* Type: [Number][Number] - event phase (1..3)\n\n### #timestamp\n* Type: [Number][Number] - event creation timestamp\n\n### #callback\n* Type: [Function][Function] - event completion callback\n\n---\n\n## FLAGS\n\n### #started\n* Type: [Boolean][Boolean] - event **started** flag\n\n### #stopped\n* Type: [Boolean][Boolean] - event **stopped** flag\n\n### #canceled\n* Type: [Boolean][Boolean] - event **canceled** flag\n\n### #aborted\n* Type: [Boolean][Boolean] - event **aborted** flag\n\n### #done\n* Type: [Boolean][Boolean] - event **done** flag\n\n---\n\n## METHODS\n\n### #start()\n* Returns: [Event][Event]\n\n**started** flag setter\n\n        start: -> (@started = yes) and this\n\n---\n\n### #stop()\n* Returns: [Event][Event]\n\n**stopped** flag setter\n\n        stop: -> (@stopped = yes) and this\n\n---\n\n### #cancel()\n* Returns: [Event][Event]\n\n**canceled** flag setter\n\n        cancel: -> (@canceled = yes) and this\n\n---\n\n### #abort()\n* Returns: [Event][Event]\n\n**aborted** flag setter\n\n        abort: -> (@aborted = yes) and this\n\n---\n\n### #finish()\n* Returns: [Event][Event]\n\n**done** flag setter\n\n        finish: -> (@done = yes) and this\n\n[lib]: .\/index.litcoffee\n[Evented]: .\/evented.litcoffee\n[Base]: .\/base.litcoffee\n[Event]: .\/event.litcoffee\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[String]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/String\n[Function]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Function\n[Boolean]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Boolean\n[Number]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Number\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8d8b9b8c35f135503660f6d552f02141eba2a7ef","subject":"Added logic to load node_local deps","message":"Added logic to load node_local deps\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                if Array.isArray val\n                  \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else\n                  \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = [ ]\n\n                for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  if Array.isArray validator\n                    for v in validator\n                      Madul.FIRE '$.Madul.validator.execute', \"#{v}\": args[arg]\n\n                      validators.push proto[v].EXECUTE.call proto[v], arg, args[arg]\n                  else\n                    Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                    validators.push proto[validator].EXECUTE.call proto[validator], arg, args[arg]\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, available[strip spec.ref], spec.ref, next\n            else\n              if spec.parent?\n                Madul.FIRE '$.Madul.search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    stop = new Error()\n                    stop.break = true\n\n                    next()\n                    nxt stop\n                  , nxt\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                if Array.isArray val\n                  \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else\n                  \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = [ ]\n\n                for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  if Array.isArray validator\n                    for v in validator\n                      Madul.FIRE '$.Madul.validator.execute', \"#{v}\": args[arg]\n\n                      validators.push proto[v].EXECUTE.call proto[v], arg, args[arg]\n                  else\n                    Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                    validators.push proto[validator].EXECUTE.call proto[validator], arg, args[arg]\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, available[strip spec.ref], spec.ref, next\n            else\n              if spec.parent?\n                Madul.FIRE '$.Madul.search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"86ecf946fad5e22fcf9443c6d5c88788d697c2a7","subject":"Apply width and hight to all generated images","message":"Apply width and hight to all generated images\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/routes\/api_v1.litcoffee","new_file":"src\/routes\/api_v1.litcoffee","new_contents":"    express = require 'express'\n    multer  = require 'multer'\n    async   = require 'async'\n    dms2dec = require 'dms2dec'\n\n    sentry  = require '..\/sentry'\n    librato = require '..\/librato'\n    s3      = require '..\/upload'\n\nMake a new Express router object for this part of the application.\n\n    api = express.Router()\n\n## Metrics\n\nAgregate metrics for all requests and wheter they succeded (`finish`) or closed\nbefore the request succeeded (`close`).\n\n    api.use (req, res, next) ->\n      librato.logRequest req.method\n\n      res.once 'close', ->\n        librato.logResponse 'closed'\n        sentry.captureResClose res\n\n      res.once 'finish', ->\n        librato.logResponse res.statusCode\n\n      next()\n\n## GET \/\n\n    api.get '\/', (req, res, next) ->\n      res.status(204).end()\n\n## POST \/upload\n\nConfigure [multer](https:\/\/github.com\/expressjs\/multer) to store files in the\nOS's temorary directory `tempdir()`. This way we should not need to clean up the\nuploaded files since that should be the job of the OS.\n\n    multer = require('multer')\n      putSingleFilesInArray: true\n      dest: require('os').tmpdir()\n\nConfigure the `\/upload` route handler.\n\n    api.post '\/upload', multer, (req, res, next) ->\n      librato.logImagesUploaded Object.keys req.files\n\n      files = []\n      for key, f of req.files\n        files.push file for file in f\n\n      async.mapSeries files, (file, cb) ->\n        if file.extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif']\n          error = new Error \"Invalid Image #{file.extension}\"\n          error.status = 422\n          return cb error\n\n        t1 = new Date().getTime()\n        s3.upload file.path, {}, (err, images, meta) ->\n          return cb err if err\n\n          librato.logImageProcessingTime t1, new Date().getTime()\n\n          if meta.exif?.GPSLatitude and meta.exif?.GPSLongitude\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif.GPSLatitude, \\\n                meta.exif.GPSLatitudeRef, \\\n                meta.exif.GPSLongitude, \\\n                meta.exif.GPSLongitudeRef\n              .reverse()\n\n          #if meta.imageSize.height > meta.imageSize.width\n          #  ratio = meta.imageSize.height \/ meta.imageSize.width\n          #  edge = 'width'\n          #else\n          #  ratio = meta.imageSize.width \/ meta.imageSize.height\n          #  edge = 'height'\n\n          images = images.splice 0, images.length - 1\n\n            image.path = undefined\n            image.src = undefined\n\n          for image in images\n            # Since we\n            if not image.width\n              image.height = image.maxHeight\n              image.width = image.maxWidth\n\n              if image.aspect\n                image.height = Math.floor image.maxHeight * 2 \/ 3\n              else\n                if meta.height > meta.width\n                  image.width = Math.floor image.height * meta.width \/ meta.height\n                else\n                  image.height = Math.floor image.width * meta.height \/ meta.width\n\n            image.key       = undefined\n            image.maxHeight = undefined\n            image.maxWidth  = undefined\n            image.path      = undefined\n            image.suffix    = undefined\n\n            console.log image\n\n          return cb null, versions: images, meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    module.exports = api\n\n","old_contents":"    express = require 'express'\n    multer  = require 'multer'\n    async   = require 'async'\n    dms2dec = require 'dms2dec'\n\n    sentry  = require '..\/sentry'\n    librato = require '..\/librato'\n    s3      = require '..\/upload'\n\nMake a new Express router object for this part of the application.\n\n    api = express.Router()\n\n## Metrics\n\nAgregate metrics for all requests and wheter they succeded (`finish`) or closed\nbefore the request succeeded (`close`).\n\n    api.use (req, res, next) ->\n      librato.logRequest req.method\n\n      res.once 'close', ->\n        librato.logResponse 'closed'\n        sentry.captureResClose res\n\n      res.once 'finish', ->\n        librato.logResponse res.statusCode\n\n      next()\n\n## GET \/\n\n    api.get '\/', (req, res, next) ->\n      res.status(204).end()\n\n## POST \/upload\n\nConfigure [multer](https:\/\/github.com\/expressjs\/multer) to store files in the\nOS's temorary directory `tempdir()`. This way we should not need to clean up the\nuploaded files since that should be the job of the OS.\n\n    multer = require('multer')\n      putSingleFilesInArray: true\n      dest: require('os').tmpdir()\n\nConfigure the `\/upload` route handler.\n\n    api.post '\/upload', multer, (req, res, next) ->\n      librato.logImagesUploaded Object.keys req.files\n\n      files = []\n      for key, f of req.files\n        files.push file for file in f\n\n      async.mapSeries files, (file, cb) ->\n        if file.extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif']\n          error = new Error \"Invalid Image #{file.extension}\"\n          error.status = 422\n          return cb error\n\n        t1 = new Date().getTime()\n        s3.upload file.path, {}, (err, images, meta) ->\n          return cb err if err\n\n          librato.logImageProcessingTime t1, new Date().getTime()\n\n          if meta.exif?.GPSLatitude and meta.exif?.GPSLongitude\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif.GPSLatitude, \\\n                meta.exif.GPSLatitudeRef, \\\n                meta.exif.GPSLongitude, \\\n                meta.exif.GPSLongitudeRef\n              .reverse()\n\n          #if meta.imageSize.height > meta.imageSize.width\n          #  ratio = meta.imageSize.height \/ meta.imageSize.width\n          #  edge = 'width'\n          #else\n          #  ratio = meta.imageSize.width \/ meta.imageSize.height\n          #  edge = 'height'\n\n          for image in images\n            #image[edge] = Math.floor(image[edge] \/ ratio)\n\n            image.path = undefined\n            image.src = undefined\n\n          return cb null, versions: images.splice(0, images.length - 1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    module.exports = api\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e822833b085fda6dbef805a008b4d68eeca46cb3","subject":"RpcRouteResponse::write mostly to make Express 4 session handling happy","message":"RpcRouteResponse::write mostly to make Express 4 session handling happy\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-rpc\/index.litcoffee","new_file":"packages\/shrub-rpc\/index.litcoffee","new_contents":"# RPC\n\nFramework for communication between client and server through\n[RPC](http:\/\/en.wikipedia.org\/wiki\/Remote_procedure_call#Message_passing)\n\n    {EventEmitter} = require 'events'\n    {IncomingMessage} = require 'http'\n\n    pkgman = null\n\nRPC route information.\n\n    routes = {}\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCorePreBootstrap`.\n\n      registrar.registerHook 'shrubCorePreBootstrap', ->\n\n        pkgman = require 'pkgman'\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        _ = require 'lodash'\n        debug = require('debug') 'shrub-silly:rpc'\n\n        {Middleware} = require 'middleware'\n\n        clientModule = require '.\/client'\n\n        label: 'Bootstrap RPC'\n        middleware: [\n\n          (next) ->\n\n#### Invoke hook `shrubRpcRoutes`.\n\n            debug '- Registering RPC routess...'\n            for route in _.flatten pkgman.invokeFlat 'shrubRpcRoutes'\n\n              debug route.path\n\nNormalize middleware to array form.\n\n              route.middleware ?= []\n              if 'function' is typeof route.middleware\n                route.middleware = [route.middleware]\n\n              routes[route.path] = route\n            debug '- RPC routes registered.'\n\n#### Invoke hook `shrubRpcRoutesAlter`.\n\n            pkgman.invoke 'shrubRpcRoutesAlter', routes\n\nSet up the middleware dispatcher.\n\n            for path, route of routes\n              route.dispatcher = new Middleware()\n\n              fn.weight ?= index for fn, index in route.middleware\n\n              sortedMiddleware = route.middleware.sort (l, r) ->\n                (l.weight ? 0) - (r.weight ? 0)\n\n              route.dispatcher.use fn for fn in sortedMiddleware\n\n            next()\n\n        ]\n\n#### Implements hook `shrubSocketConnectionMiddleware`.\n\n      registrar.registerHook 'shrubSocketConnectionMiddleware', ->\n\n        Promise = require 'bluebird'\n\n        config = require 'config'\n        errors = require 'errors'\n        logging = require 'logging'\n\n        logger = logging.create 'logs\/rpc.log'\n        {TransmittableError} = errors\n\n        label: 'Receive and dispatch RPC calls'\n        middleware: [\n\n          (req, res, next) ->\n\nLog an error without transmitting it.\n\n            logError = (error) -> logger.error errors.stack error\n\nHub for RPC calls. Dispatch routes.\n\n            req.socket.on 'shrub-rpc', ({path, data}, fn) ->\n              unless (route = routes[path])?\n                return logError new Error \"Unknown route called: #{path}\"\n\nDon't pass req directly, since it can be mutated by routes, and violate other\nroutes' expectations.\n\n              routeReq = new IncomingMessage req.socket.conn\n              routeReq.body = data\n              routeReq.route = route\n              routeReq.socket = req.socket\n\n              routeRes = new class RpcRouteResponse extends EventEmitter\n\n                constructor: ->\n                  super\n\n                  @data = {}\n                  @error = null\n\nStubs.\n\n`TODO`: Make this not a stub.\n\n                getHeader: -> null\n\n                setError: (@error) -> return this\n\n                end: (data) ->\n\n                  @write data\n\n                  return fn error: errors.serialize @error if @error?\n                  fn result: @data\n\n                write: (data) -> @data[k] = v for k, v of data\n\nSend an error to the client.\n\n              emitError = (error) -> routeRes.setError(error).end()\n\nSend an error to the client, but don't notify them of the real underlying\nissue.\n\n              concealErrorFromClient = (error) ->\n\n                emitError new Error 'Please try again later.'\n                logError error\n\nTransmit the error as it is directly to the client.\n\n              sendErrorToClient = (error) ->\n                emitError error\n\nLog the full error stack, because it might help track down any problem.\n\n                logError error if do ->\n\nUnknown errors.\n\n                  unless error instanceof TransmittableError\n                    return true\n\nIf we're not running in production.\n\n                  if 'production' isnt config.get 'NODE_ENV'\n                    return true\n\nDispatch the route.\n\n              route.dispatcher.dispatch routeReq, routeRes, (error) ->\n                sendErrorToClient error if error?\n\n            next()\n\n        ]\n\n### spliceRouteMiddleware\n\n* (Object) `route` - The RPC route definition object.\n* (String) `key` - The key used by RPC routes to be replaced with middleware.\n* (Function Array) `middleware` - The middleware to be spliced in.\n\n*Splice middleware functions in place of a key.*\n\nSome packages define RPC route middleware that can be included as a string\n(e.g. `'shrub-user'`). This function will splice in an array of middleware\nwhere a placeholder key specifies.\n\n    exports.spliceRouteMiddleware = (route, key, middleware) ->\n      return unless ~(index = route.middleware.indexOf key)\n\n      l = route.middleware.slice 0, index\n      r = route.middleware.slice index + 1\n\n      route.middleware = l.concat middleware, r\n\n      return\n","old_contents":"# RPC\n\nFramework for communication between client and server through\n[RPC](http:\/\/en.wikipedia.org\/wiki\/Remote_procedure_call#Message_passing)\n\n    {EventEmitter} = require 'events'\n    {IncomingMessage} = require 'http'\n\n    pkgman = null\n\nRPC route information.\n\n    routes = {}\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCorePreBootstrap`.\n\n      registrar.registerHook 'shrubCorePreBootstrap', ->\n\n        pkgman = require 'pkgman'\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        _ = require 'lodash'\n        debug = require('debug') 'shrub-silly:rpc'\n\n        {Middleware} = require 'middleware'\n\n        clientModule = require '.\/client'\n\n        label: 'Bootstrap RPC'\n        middleware: [\n\n          (next) ->\n\n#### Invoke hook `shrubRpcRoutes`.\n\n            debug '- Registering RPC routess...'\n            for route in _.flatten pkgman.invokeFlat 'shrubRpcRoutes'\n\n              debug route.path\n\nNormalize middleware to array form.\n\n              route.middleware ?= []\n              if 'function' is typeof route.middleware\n                route.middleware = [route.middleware]\n\n              routes[route.path] = route\n            debug '- RPC routes registered.'\n\n#### Invoke hook `shrubRpcRoutesAlter`.\n\n            pkgman.invoke 'shrubRpcRoutesAlter', routes\n\nSet up the middleware dispatcher.\n\n            for path, route of routes\n              route.dispatcher = new Middleware()\n\n              fn.weight ?= index for fn, index in route.middleware\n\n              sortedMiddleware = route.middleware.sort (l, r) ->\n                (l.weight ? 0) - (r.weight ? 0)\n\n              route.dispatcher.use fn for fn in sortedMiddleware\n\n            next()\n\n        ]\n\n#### Implements hook `shrubSocketConnectionMiddleware`.\n\n      registrar.registerHook 'shrubSocketConnectionMiddleware', ->\n\n        Promise = require 'bluebird'\n\n        config = require 'config'\n        errors = require 'errors'\n        logging = require 'logging'\n\n        logger = logging.create 'logs\/rpc.log'\n        {TransmittableError} = errors\n\n        label: 'Receive and dispatch RPC calls'\n        middleware: [\n\n          (req, res, next) ->\n\nLog an error without transmitting it.\n\n            logError = (error) -> logger.error errors.stack error\n\nHub for RPC calls. Dispatch routes.\n\n            req.socket.on 'shrub-rpc', ({path, data}, fn) ->\n              unless (route = routes[path])?\n                return logError new Error \"Unknown route called: #{path}\"\n\nDon't pass req directly, since it can be mutated by routes, and violate other\nroutes' expectations.\n\n              routeReq = new IncomingMessage req.socket.conn\n              routeReq.body = data\n              routeReq.route = route\n              routeReq.socket = req.socket\n\n              routeRes = new class RpcRouteResponse extends EventEmitter\n\n                constructor: ->\n                  super\n\n                  @error = null\n\nStubs.\n\n`TODO`: Make these not stubs.\n\n                getHeader: -> null\n                write: -> null\n\n                setError: (@error) -> return this\n\n                end: (data) ->\n                  return fn error: errors.serialize @error if @error?\n                  fn result: data\n\nSend an error to the client.\n\n              emitError = (error) -> routeRes.setError(error).end()\n\nSend an error to the client, but don't notify them of the real underlying\nissue.\n\n              concealErrorFromClient = (error) ->\n\n                emitError new Error 'Please try again later.'\n                logError error\n\nTransmit the error as it is directly to the client.\n\n              sendErrorToClient = (error) ->\n                emitError error\n\nLog the full error stack, because it might help track down any problem.\n\n                logError error if do ->\n\nUnknown errors.\n\n                  unless error instanceof TransmittableError\n                    return true\n\nIf we're not running in production.\n\n                  if 'production' isnt config.get 'NODE_ENV'\n                    return true\n\nDispatch the route.\n\n              route.dispatcher.dispatch routeReq, routeRes, (error) ->\n                sendErrorToClient error if error?\n\n            next()\n\n        ]\n\n### spliceRouteMiddleware\n\n* (Object) `route` - The RPC route definition object.\n* (String) `key` - The key used by RPC routes to be replaced with middleware.\n* (Function Array) `middleware` - The middleware to be spliced in.\n\n*Splice middleware functions in place of a key.*\n\nSome packages define RPC route middleware that can be included as a string\n(e.g. `'shrub-user'`). This function will splice in an array of middleware\nwhere a placeholder key specifies.\n\n    exports.spliceRouteMiddleware = (route, key, middleware) ->\n      return unless ~(index = route.middleware.indexOf key)\n\n      l = route.middleware.slice 0, index\n      r = route.middleware.slice index + 1\n\n      route.middleware = l.concat middleware, r\n\n      return\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"96f6afa37386f561be736502eb7faeb2d8bccf43","subject":"modify README","message":"modify README\n","repos":"CureApp\/loopback-with-admin","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\n\n# install\n\n```\nnpm install loopback-with-domain\n```\n\n\n# run\n\nbefore running, you can prepare a directory which contains custom config information.\n\n\n```\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    configDir = '\/path\/to\/config-dir'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    lbWithDomain.runWithDomain(domain, configDir).then ->\n        # loopback started\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- model-config\n- server\n- push-credentials\n\nsee JSON files in \"default-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|-----------------------\n memory      | on memory datasource\n db          | datasource for domain entities\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n","old_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\n\n# install\n\n```\nnpm install loopback-with-domain\n```\n\n\n# run\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    config =\n        admin:\n            accessToken: 'Your Secret Value Here'\n        server:\n            port: 4000\n\n    lbWithDomain.runWithDomain(domain, config).then ->\n        # loopback started\n\n\n# configs\n\nsee JSON files in \"default-configs\" directory.\nyou can set the same properties as these JSONs.\n\n## server\n\n config name | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n## admin\n\n config name | meaning               | default\n-------------|-----------------------|----------------------------\n accessToken | accessToken for admin | (you must set access token)\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"691aac154aeed96e890db847855886e9e87000ac","subject":"event more refactoring","message":"event more refactoring\n","repos":"nhz-io\/cnl","old_file":"source\/shape.litcoffee","new_file":"source\/shape.litcoffee","new_contents":"# CLASS: Shape\n* Extends: [Element][Element]\n* Parent: [Index][Parent]\n\nA drawable shape. Manages **regions**.\n\n---\n\n    module.exports = class Shape extends require '.\/element'\n\n## CONSTRUCTOR\n\n### new Shape(args)\n\nCreates Shape instance.\n\n      constructor: ->\n        super\n\nCopy the element regions if they were set from named arguments\n\n        if regions = @regions\n          @regions = {}\n          @regions[name] = region for name, region of regions\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n### #regions\n* Type: [Object][Object] - region name\/value pairs\n* **{REGION NAME}**\n    * Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## METHODS\n### #draw(context, args)\n* Returns: [Shape][Shape]\n\nA draw method stub\n\n      draw: -> this\n\n---\n\n### #getEventRegions(event)\n* Returns: [Object][Object] - named set of matching regions\n\nHelper method, to get element regions that match the event.\n\n      getEventRegions: (event) ->\n        result = null\n\nProceed only if event coordinates are localized\n\n        if event and (x = event.localX)? and (y = event.localY)?\n\nWalk through the element regions\n\n          for name, $ of @regions\n\nand add the region to the result if event localized coordinates are within\nthe region rectangle.\n\n            if $[0] <= x <= ($[0] + $[2]) and $[1] <= y <= ($[1] + $[3])\n\nInitialize result only if at least one region matches\n\n              result or= {}\n              result[name] = $\n\n        return result\n\n---\n\n## LISTENERS\n\n### #mousemoveCaptureListener(event)\n* Returns: [Shape][Shape]\n\nCapture **mousemove** events passing through this shape\n\n      mousemoveCaptureListener: (event) ->\n        super\n\nProceed only for valid event\n\n        if event\n\nCheck if there are any regions that match the event,\nstore them in the event and set this shape as event target\n\n          event.target = this if event.regions = @getEventRegions event\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Shape][Shape]\n\nCapture **mousedown** events passing through this shape\n\n      mousedownCaptureListener: (event) ->\n        super\n\nProceed only for valid event\n\n        if event\n\nCheck if there are any regions that match the event,\nstore them in the event and set this shape as event target\n\n          event.target = this if event.regions = @getEventRegions event\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Event][Event]\n\nCapture **mouseup** events passing through this shape\n\n      mouseupCaptureListener: (event) ->\n        super\n\nProceed only for valid event\n\n        if event\n\nCheck if there are any regions that match the event,\nstore them in the event and set this shape as event target\n\n          event.target = this if event.regions = @getEventRegions event\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n[Parent]: .\/index.litcoffee\n[Shape]: .\/shape.litcoffee\n[Element]: .\/element.litcoffee\n[Event]: .\/event.litcoffee\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[Array]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Array\n","old_contents":"# CLASS: Shape\n* Extends: [Element][Element]\n* Parent: [Index][Parent]\n\nA drawable shape. Manages **regions**.\n\n---\n\n    module.exports = class Shape extends require '.\/element'\n\n## CONSTRUCTOR\n\n### new Shape(args)\n\nCreates Shape instance.\n\n      constructor: ->\n        super\n\nCopy the element regions if they were set from named arguments\n\n        if regions = @regions\n          @regions = {}\n          @regions[name] = region for name, region of regions\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n### #regions\n* Type: [Object][Object] - region name\/value pairs\n* **{REGION NAME}**\n    * Type: [Array][Array] - [x, y, width, height]\n\n---\n\n## METHODS\n### #draw(context, args)\n* Returns: [Shape][Shape]\n\nA draw method stub\n\n      draw: -> this\n\n---\n\n### #getEventRegions(event)\n* Returns: [Object][Object] - named set of matching regions\n\nHelper method, to get element regions that match the event.\n\n      getEventRegions: (event) ->\n        result = null\n\nProceed only if event coordinates are localized\n\n        if event and (x = event.localX)? and (y = event.localY)?\n\nWalk through the element regions\n\n          for name, $ of @regions\n\nand add the region to the result if event localized coordinates are within\nthe region rectangle.\n\n            if $[0] <= x <= ($[0] + $[2]) and $[1] <= y <= ($[1] + $[3])\n\nInitialize result only if at least one region matches\n\n              result or= {}\n              result[name] = $\n\n        return result\n\n---\n\n## LISTENERS\n\n### #mousemoveCaptureListener(event)\n* Returns: [Shape][Shape]\n\nCapture **mousemove** events passing through this shape\n\n      mousemoveCaptureListener: (event) ->\n        super\n\nCheck if there are any regions which match the event.\n\n        if regions = @getEventRegions event\n\nStore those regions in the event and make this shape an event target\n\n          event.regions = regions\n          event.target = this\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Shape][Shape]\n\nCapture **mousedown** events passing through this shape\n\n      mousedownCaptureListener: (event) ->\n        super\n\nCheck if there are any regions which match the event.\n\n        if regions = @getEventRegions event\n\nStore those regions in the event and make this shape an event target\n\n          event.regions = regions\n          event.target = this\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Event][Event]\n\nCapture **mouseup** events passing through this shape\n\n      mouseupCaptureListener: (event) ->\n        super\n\nCheck if there are any regions which match the event.\n\n        if regions = @getEventRegions event\n\nStore those regions in the event and make this shape an event target\n\n          event.regions = regions\n          event.target = this\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n[Parent]: .\/index.litcoffee\n[Shape]: .\/shape.litcoffee\n[Element]: .\/element.litcoffee\n[Event]: .\/event.litcoffee\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[Array]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Array\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"64f1c3d1a63e347560301e8cd3de938cb2102fd5","subject":"Clunky event limit increase","message":"Clunky event limit increase\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-orm\/index.litcoffee","new_file":"packages\/shrub-orm\/index.litcoffee","new_contents":"# Object-relational mapping\n\n*Tools for working with [Waterline](https:\/\/github.com\/balderdashy\/waterline).*\n\n    require('events').EventEmitter.prototype._maxListeners = 100\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    Waterline = null\n\n    collections = {}\n    connections = {}\n\n    waterline = null\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCorePreBootstrap`.\n\n      registrar.registerHook 'shrubCorePreBootstrap', ->\n\n        Waterline = require 'waterline'\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        waterline = new Waterline()\n\n        label: 'Bootstrap ORM'\n        middleware: [\n\n          (next) -> exports.initialize next\n\n        ]\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig) ->\n\n        gruntConfig.copyAppFiles \"#{__dirname}\/app\", 'shrub-orm'\n\n        gruntConfig.registerTask 'build:shrub-orm', [\n          'newer:copy:shrub-orm'\n        ]\n\n        gruntConfig.registerTask 'build', ['build:shrub-orm']\n\n#### Implements hook `shrubConfigServer`.\n\n      registrar.registerHook 'shrubConfigServer', ->\n\nThe available adapters. This is a list of module names. We provide sails-redis\nby default.\n\n        adapters: [\n          'sails-redis'\n        ]\n\nThe available connnections. This is a keyed list of available connections\nwhich are defined as an adapter and the configuration for the adapter. The\nentries in the `adapters` list are available for use here. We provide a `shrub`\nconnection by default, which uses the sails-redis adapter with defaults.\n\n        connections:\n\n          shrub:\n\n            adapter: 'sails-redis'\n            port: 6379\n            host: 'localhost'\n            password: null\n            database: null\n\n#### Implements hook `shrubReplContext`.\n\nProvide ORM to the REPL context.\n\n      registrar.registerHook 'shrubReplContext', (context) -> context.orm = exports\n\n## initialize\n\n* (Function) `fn` - Nodeback called when initialization completes.\n\n*Spin up Waterline with our configuration.*\n\n    exports.initialize = (fn) ->\n\n      config_ = config.get 'packageSettings:shrub-orm'\n\n      waterlineConfig = adapters: {}, connections: {}\n\n`require` all the adapter modules.\n\n      for adapter in config_.adapters\n        waterlineConfig.adapters[adapter] = require adapter\n\n      waterlineConfig.connections = config_.connections\n\n#### Invoke hook `shrubOrmCollections`.\n\n      collections_ = {}\n      for collectionList in pkgman.invokeFlat 'shrubOrmCollections', waterline\n        for identity, collection of collectionList\n\nSet collection defaults.\n\n          collection.connection ?= 'shrub'\n          collection.identity ?= identity\n          collections_[collection.identity] = collection\n\n## Collection#instantiate.\n\n* (Object) `values` - An object with values to populate the model properties.\n\n*Instantiate a model with defaults supplied.*\n\n          collection.instantiate = (values = {}) ->\n\n            for key, value of @attributes\n              continue unless value.defaultsTo?\n\nSet any model defaults.\n\n              values[key] ?= if 'function' is typeof value.defaultsTo\n                value.defaultsTo.call values\n              else\n                JSON.parse JSON.stringify value.defaultsTo\n\nReach into Waterline a bit, hackish but they simply don't provide us with a\nsane API for this.\n\n            new @_model @_schema.cleanValues @_transformer.serialize values\n\n#### Invoke hook `shrubOrmCollectionsAlter`.\n\n      pkgman.invoke 'shrubOrmCollectionsAlter', collections_, waterline\n\nLoad the collections into Waterline.\n\n      for i, collection of collections_\n        waterline.loadCollection Waterline.Collection.extend collection\n\n      waterline.initialize waterlineConfig, (error, data) ->\n        return fn error if error?\n\n        collections = data.collections\n        connections = data.connections\n\n        fn()\n\n## collection\n\n* (String) `identity` - Collection identity. e.g. `'shrub-user'`\n\n*Get a collection by identity.*\n\n    exports.collection = (identity) -> collections[identity]\n\n## collections\n\n*Get all collections.*\n\n    exports.collections = -> collections\n\n## connections\n\n*Get all connections.*\n\n    exports.connections = -> connections\n\n## teardown\n\n* (Function) `fn` - Nodeback called after teardown.\n\n*Tear down Waterline.*\n\n    exports.teardown = (fn) -> waterline.teardown fn\n\n## waterline\n\n*Get the Waterline instance.*\n\n    exports.waterline = -> waterline\n","old_contents":"# Object-relational mapping\n\n*Tools for working with [Waterline](https:\/\/github.com\/balderdashy\/waterline).*\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    Waterline = null\n\n    collections = {}\n    connections = {}\n\n    waterline = null\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCorePreBootstrap`.\n\n      registrar.registerHook 'shrubCorePreBootstrap', ->\n\n        Waterline = require 'waterline'\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        waterline = new Waterline()\n\n        label: 'Bootstrap ORM'\n        middleware: [\n\n          (next) -> exports.initialize next\n\n        ]\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig) ->\n\n        gruntConfig.copyAppFiles \"#{__dirname}\/app\", 'shrub-orm'\n\n        gruntConfig.registerTask 'build:shrub-orm', [\n          'newer:copy:shrub-orm'\n        ]\n\n        gruntConfig.registerTask 'build', ['build:shrub-orm']\n\n#### Implements hook `shrubConfigServer`.\n\n      registrar.registerHook 'shrubConfigServer', ->\n\nThe available adapters. This is a list of module names. We provide sails-redis\nby default.\n\n        adapters: [\n          'sails-redis'\n        ]\n\nThe available connnections. This is a keyed list of available connections\nwhich are defined as an adapter and the configuration for the adapter. The\nentries in the `adapters` list are available for use here. We provide a `shrub`\nconnection by default, which uses the sails-redis adapter with defaults.\n\n        connections:\n\n          shrub:\n\n            adapter: 'sails-redis'\n            port: 6379\n            host: 'localhost'\n            password: null\n            database: null\n\n#### Implements hook `shrubReplContext`.\n\nProvide ORM to the REPL context.\n\n      registrar.registerHook 'shrubReplContext', (context) -> context.orm = exports\n\n## initialize\n\n* (Function) `fn` - Nodeback called when initialization completes.\n\n*Spin up Waterline with our configuration.*\n\n    exports.initialize = (fn) ->\n\n      config_ = config.get 'packageSettings:shrub-orm'\n\n      waterlineConfig = adapters: {}, connections: {}\n\n`require` all the adapter modules.\n\n      for adapter in config_.adapters\n        waterlineConfig.adapters[adapter] = require adapter\n\n      waterlineConfig.connections = config_.connections\n\n#### Invoke hook `shrubOrmCollections`.\n\n      collections_ = {}\n      for collectionList in pkgman.invokeFlat 'shrubOrmCollections', waterline\n        for identity, collection of collectionList\n\nSet collection defaults.\n\n          collection.connection ?= 'shrub'\n          collection.identity ?= identity\n          collections_[collection.identity] = collection\n\n## Collection#instantiate.\n\n* (Object) `values` - An object with values to populate the model properties.\n\n*Instantiate a model with defaults supplied.*\n\n          collection.instantiate = (values = {}) ->\n\n            for key, value of @attributes\n              continue unless value.defaultsTo?\n\nSet any model defaults.\n\n              values[key] ?= if 'function' is typeof value.defaultsTo\n                value.defaultsTo.call values\n              else\n                JSON.parse JSON.stringify value.defaultsTo\n\nReach into Waterline a bit, hackish but they simply don't provide us with a\nsane API for this.\n\n            new @_model @_schema.cleanValues @_transformer.serialize values\n\n#### Invoke hook `shrubOrmCollectionsAlter`.\n\n      pkgman.invoke 'shrubOrmCollectionsAlter', collections_, waterline\n\nLoad the collections into Waterline.\n\n      for i, collection of collections_\n        waterline.loadCollection Waterline.Collection.extend collection\n\n      waterline.initialize waterlineConfig, (error, data) ->\n        return fn error if error?\n\n        collections = data.collections\n        connections = data.connections\n\n        fn()\n\n## collection\n\n* (String) `identity` - Collection identity. e.g. `'shrub-user'`\n\n*Get a collection by identity.*\n\n    exports.collection = (identity) -> collections[identity]\n\n## collections\n\n*Get all collections.*\n\n    exports.collections = -> collections\n\n## connections\n\n*Get all connections.*\n\n    exports.connections = -> connections\n\n## teardown\n\n* (Function) `fn` - Nodeback called after teardown.\n\n*Tear down Waterline.*\n\n    exports.teardown = (fn) -> waterline.teardown fn\n\n## waterline\n\n*Get the Waterline instance.*\n\n    exports.waterline = -> waterline\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a2a649d13e0b765042f4c657f77e700102dca901","subject":"Clean up parentheses syntax for nice CoffeeScript","message":"Clean up parentheses syntax for nice CoffeeScript\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nMake new cursor object with the correct query, fields, and other options (limit,\nskip, and sort).\n\n      cursor = req.db.col.find req.db.query, fields,\n        limit: Math.min (parseInt(req.query.limit, 10) or 20), 50\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min cursor.cmd.limit, Math.max total - cursor.cmd.skip, 0\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nMake new cursor object with the correct query, fields, and other options (limit,\nskip, and sort).\n\n      cursor = req.db.col.find req.db.query, fields,\n        limit: Math.min (parseInt(req.query.limit, 10) or 20), 50\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min(cursor.cmd.limit, Math.max(total - cursor.cmd.skip, 0))\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0ebc0ae0b18cdcfd5a572e6353d4c9635ecf5c79","subject":"Added an extra parameter to rotateX\/Y\/Z to allow for local transformations.","message":"Added an extra parameter to rotateX\/Y\/Z to allow for local\ntransformations.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat","old_file":"src\/matrix.litcoffee","new_file":"src\/matrix.litcoffee","new_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    tempVector = []\n    tempVectorFrom = []\n    tempVectorTo = []\n    fromTemp = []\n    toTemp = []\n    tempVectorX = []\n    tempVectorY = []\n    tempVectorZ = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output, local) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            if local\n                module.exports.multiply temp3, output, output\n            else\n                module.exports.multiply output, temp3, output\n            return\n\n    vector = require \".\/vector.litcoffee\"\n            \n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\nIf the third parameter is truthy, the rotation is applied in local rather than\nglobal space.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\nIf the third parameter is truthy, the rotation is applied in local rather than\nglobal space.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\nIf the third parameter is truthy, the rotation is applied in local rather than\nglobal space.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\nGiven a vector specifying a translation and a matrix to translate, calling the \n\"translate\" property applies that translation to that matrix.\n            \n        translate: (vector, output) ->\n            output[3] += vector[0]\n            output[7] += vector[1]\n            output[11] += vector[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \nGiven a matrix, input vector and output vector, calling the \"applyToVector\"\nproperty writes the input vector transformed by the matrix to the output vector.\n        \n        applyToVector: (matrix, input, output) ->\n            vector.copy input, tempVector\n            output[0] = tempVector[0] * matrix[0] + tempVector[1] * matrix[1] + tempVector[2] * matrix[2] + matrix[3]\n            output[1] = tempVector[0] * matrix[4] + tempVector[1] * matrix[5] + tempVector[2] * matrix[6] + matrix[7]\n            output[2] = tempVector[0] * matrix[8] + tempVector[1] * matrix[9] + tempVector[2] * matrix[10] + matrix[11]\n            return\n            \nGiven a matrix and output vector, calling the \"getTranslation\" property writes\nthe translation applied by the matrix to the output vector.\n\n        getTranslation: (matrix, output) ->\n            output[0] = matrix[3]\n            output[1] = matrix[7]\n            output[2] = matrix[11]\n\nGiven a matrix and output vector, calling the \"getX\" property writes the vector\nof the matrix's X axis (a scaled normal) to the output vector.\n\n        getX: (matrix, output) ->\n            output[0] = matrix[0]\n            output[1] = matrix[4]\n            output[2] = matrix[8]\n\nGiven a matrix and output vector, calling the \"getY\" property writes the vector\nof the matrix's Y axis (a scaled normal) to the output vector.\n\n        getY: (matrix, output) ->\n            output[0] = matrix[1]\n            output[1] = matrix[5]\n            output[2] = matrix[9]\n            \nGiven a matrix and output vector, calling the \"getZ\" property writes the vector\nof the matrix's Z axis (a scaled normal) to the output vector.\n\n        getZ: (matrix, output) ->\n            output[0] = matrix[2]\n            output[1] = matrix[6]\n            output[2] = matrix[10]\n            \n# setTranslation\n\n- A vector specifying the translation to set.\n- A matrix to set the translation of.\n\nOverwrites the translation of the matrix with the content of the given vector.\n\n        setTranslation: (output, matrix) ->\n            matrix[3] = output[0]\n            matrix[7] = output[1]\n            matrix[11] = output[2]\n\n# setX\n\n- A vector specifying the X axis vector to set.\n- A matrix to set the X axis vector of.\n\nOverwrites the X axis of the matrix with the content of the given vector.\n\n        setX: (output, matrix) ->\n            matrix[0] = output[0]\n            matrix[4] = output[1]\n            matrix[8] = output[2]\n\n# setY\n\n- A vector specifying the Y axis vector to set.\n- A matrix to set the Y axis vector of.\n\nOverwrites the Y axis of the matrix with the content of the given vector.\n\n        setY: (output, matrix) ->\n            matrix[1] = output[0]\n            matrix[5] = output[1]\n            matrix[9] = output[2]\n\n# setZ\n\n- A vector specifying the Z axis vector to set.\n- A matrix to set the Z axis vector of.\n\nOverwrites the Z axis of the matrix with the content of the given vector.\n\n        setZ: (output, matrix) ->\n            matrix[2] = output[0]\n            matrix[6] = output[1]\n            matrix[10] = output[2]\n            \n# interpolate\n\n- An input matrix to interpolate from.\n- An input matrix to interpolate to.\n- A number specifying how far along to interpolate; \"0\" is \"from\" and \"1\" is \n  \"to\".\n- An output matrix.\n\nAttempts to perform a somewhat crude interpolation between the two matrices\nwhich is not very linear.  Good enough for smoothing over small changes.\nPrioritizes the Z and Y axes over the X axis when ensuring orthogonal.\n\n        interpolate: (from, to, alpha, output) ->       \n            module.exports.copy from, fromTemp\n            module.exports.copy to, toTemp\n            module.exports.identity output\n            module.exports.getTranslation fromTemp, tempVectorFrom\n            module.exports.getTranslation toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            module.exports.setTranslation tempVector, output\n            \n            module.exports.getX fromTemp, tempVectorFrom\n            module.exports.getX toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            vector.normalize tempVector, tempVectorX, true  \n            \n            module.exports.getY fromTemp, tempVectorFrom\n            module.exports.getY toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVectorY\n            \n            vector.cross tempVectorX, tempVectorY, tempVectorZ\n            vector.normalize tempVectorZ, tempVectorZ\n            vector.cross tempVectorZ, tempVectorX, tempVectorY\n            vector.normalize tempVectorY, tempVectorY\n            \n            module.exports.setX tempVectorX, output\n            module.exports.setY tempVectorY, output\n            module.exports.setZ tempVectorZ, output\n            return\n            \n# invert\n\n- An input matrix to invert.\n- An output matrix to write to.\n\nAttempts to calculate the inverse of a matrix by negating its translation and\ntransposing its X, Y and Z axes.  Will not work if any scaling has been applied.\n\n        invert: (input, output) ->\n            module.exports.copy input, fromTemp\n            module.exports.getX fromTemp, tempVectorX\n            module.exports.getY fromTemp, tempVectorY\n            module.exports.getZ fromTemp, tempVectorZ\n            module.exports.getTranslation fromTemp, tempVector\n            output[0] = input[0]\n            output[1] = input[4]\n            output[2] = input[8]\n            output[3] = -vector.dot tempVector, tempVectorX\n            \n            output[4] = input[1]\n            output[5] = input[5]\n            output[6] = input[9]\n            output[7] = -vector.dot tempVector, tempVectorY\n            \n            output[8] = input[2]\n            output[9] = input[6]\n            output[10] = input[10]\n            output[11] = -vector.dot tempVector, tempVectorZ\n            \n            output[12] = 0\n            output[13] = 0\n            output[14] = 0\n            output[15] = 1\n            \n            return\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","old_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    tempVector = []\n    tempVectorFrom = []\n    tempVectorTo = []\n    fromTemp = []\n    toTemp = []\n    tempVectorX = []\n    tempVectorY = []\n    tempVectorZ = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            module.exports.multiply output, temp3, output\n            return\n\n    vector = require \".\/vector.litcoffee\"\n            \n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\nGiven a vector specifying a translation and a matrix to translate, calling the \n\"translate\" property applies that translation to that matrix.\n            \n        translate: (vector, output) ->\n            output[3] += vector[0]\n            output[7] += vector[1]\n            output[11] += vector[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \nGiven a matrix, input vector and output vector, calling the \"applyToVector\"\nproperty writes the input vector transformed by the matrix to the output vector.\n        \n        applyToVector: (matrix, input, output) ->\n            vector.copy input, tempVector\n            output[0] = tempVector[0] * matrix[0] + tempVector[1] * matrix[1] + tempVector[2] * matrix[2] + matrix[3]\n            output[1] = tempVector[0] * matrix[4] + tempVector[1] * matrix[5] + tempVector[2] * matrix[6] + matrix[7]\n            output[2] = tempVector[0] * matrix[8] + tempVector[1] * matrix[9] + tempVector[2] * matrix[10] + matrix[11]\n            return\n            \nGiven a matrix and output vector, calling the \"getTranslation\" property writes\nthe translation applied by the matrix to the output vector.\n\n        getTranslation: (matrix, output) ->\n            output[0] = matrix[3]\n            output[1] = matrix[7]\n            output[2] = matrix[11]\n\nGiven a matrix and output vector, calling the \"getX\" property writes the vector\nof the matrix's X axis (a scaled normal) to the output vector.\n\n        getX: (matrix, output) ->\n            output[0] = matrix[0]\n            output[1] = matrix[4]\n            output[2] = matrix[8]\n\nGiven a matrix and output vector, calling the \"getY\" property writes the vector\nof the matrix's Y axis (a scaled normal) to the output vector.\n\n        getY: (matrix, output) ->\n            output[0] = matrix[1]\n            output[1] = matrix[5]\n            output[2] = matrix[9]\n            \nGiven a matrix and output vector, calling the \"getZ\" property writes the vector\nof the matrix's Z axis (a scaled normal) to the output vector.\n\n        getZ: (matrix, output) ->\n            output[0] = matrix[2]\n            output[1] = matrix[6]\n            output[2] = matrix[10]\n            \n# setTranslation\n\n- A vector specifying the translation to set.\n- A matrix to set the translation of.\n\nOverwrites the translation of the matrix with the content of the given vector.\n\n        setTranslation: (output, matrix) ->\n            matrix[3] = output[0]\n            matrix[7] = output[1]\n            matrix[11] = output[2]\n\n# setX\n\n- A vector specifying the X axis vector to set.\n- A matrix to set the X axis vector of.\n\nOverwrites the X axis of the matrix with the content of the given vector.\n\n        setX: (output, matrix) ->\n            matrix[0] = output[0]\n            matrix[4] = output[1]\n            matrix[8] = output[2]\n\n# setY\n\n- A vector specifying the Y axis vector to set.\n- A matrix to set the Y axis vector of.\n\nOverwrites the Y axis of the matrix with the content of the given vector.\n\n        setY: (output, matrix) ->\n            matrix[1] = output[0]\n            matrix[5] = output[1]\n            matrix[9] = output[2]\n\n# setZ\n\n- A vector specifying the Z axis vector to set.\n- A matrix to set the Z axis vector of.\n\nOverwrites the Z axis of the matrix with the content of the given vector.\n\n        setZ: (output, matrix) ->\n            matrix[2] = output[0]\n            matrix[6] = output[1]\n            matrix[10] = output[2]\n            \n# interpolate\n\n- An input matrix to interpolate from.\n- An input matrix to interpolate to.\n- A number specifying how far along to interpolate; \"0\" is \"from\" and \"1\" is \n  \"to\".\n- An output matrix.\n\nAttempts to perform a somewhat crude interpolation between the two matrices\nwhich is not very linear.  Good enough for smoothing over small changes.\nPrioritizes the Z and Y axes over the X axis when ensuring orthogonal.\n\n        interpolate: (from, to, alpha, output) ->       \n            module.exports.copy from, fromTemp\n            module.exports.copy to, toTemp\n            module.exports.identity output\n            module.exports.getTranslation fromTemp, tempVectorFrom\n            module.exports.getTranslation toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            module.exports.setTranslation tempVector, output\n            \n            module.exports.getX fromTemp, tempVectorFrom\n            module.exports.getX toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            vector.normalize tempVector, tempVectorX, true  \n            \n            module.exports.getY fromTemp, tempVectorFrom\n            module.exports.getY toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVectorY\n            \n            vector.cross tempVectorX, tempVectorY, tempVectorZ\n            vector.normalize tempVectorZ, tempVectorZ\n            vector.cross tempVectorZ, tempVectorX, tempVectorY\n            vector.normalize tempVectorY, tempVectorY\n            \n            module.exports.setX tempVectorX, output\n            module.exports.setY tempVectorY, output\n            module.exports.setZ tempVectorZ, output\n            return\n            \n# invert\n\n- An input matrix to invert.\n- An output matrix to write to.\n\nAttempts to calculate the inverse of a matrix by negating its translation and\ntransposing its X, Y and Z axes.  Will not work if any scaling has been applied.\n\n        invert: (input, output) ->\n            module.exports.copy input, fromTemp\n            module.exports.getX fromTemp, tempVectorX\n            module.exports.getY fromTemp, tempVectorY\n            module.exports.getZ fromTemp, tempVectorZ\n            module.exports.getTranslation fromTemp, tempVector\n            output[0] = input[0]\n            output[1] = input[4]\n            output[2] = input[8]\n            output[3] = -vector.dot tempVector, tempVectorX\n            \n            output[4] = input[1]\n            output[5] = input[5]\n            output[6] = input[9]\n            output[7] = -vector.dot tempVector, tempVectorY\n            \n            output[8] = input[2]\n            output[9] = input[6]\n            output[10] = input[10]\n            output[11] = -vector.dot tempVector, tempVectorZ\n            \n            output[12] = 0\n            output[13] = 0\n            output[14] = 0\n            output[15] = 1\n            \n            return\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b6ff8db0a9a20a263eff34b4a681870676fae5a5","subject":"- updated policy model","message":"- updated policy model\n","repos":"WillemDeGroef\/nodesentry","old_file":"src\/policy.litcoffee","new_file":"src\/policy.litcoffee","new_contents":"Policy\n======\n\n    _ = require \"underscore\"\n\n    class Policy\n        constructor: () ->\n            @rules = []\n            @libsToWrap = []\n\n            @policy =\n\nIndicate if a given library (name) should be wrapped in a separate membrane. If\na policy doesn't talk about a specific depending library, then it there is no\nneed for it to be wrapped. Therefor, the default return value is `false`:\n\n                wrapWithMembrane: (libName) -> false\n\n        disable: (lib) -> this\n        enableHSTS: -> this\n\n        on: (name) ->\n            child = new OnRule name, this\n            # check if (lib, call) = name must be added to libsToWrap\n            # iff lib[0].toLowerCase() == lib[0]\n            @rules.push child\n            child\n\n        before: (name) ->\n            child = new BeforeRule name, this\n            @rules.push child\n            child\n\n        after: (name) ->\n            child = new AfterRule name, this\n            @rules.push child\n            child\n\nThe `build` method generates the whole structure of our semantic model of the membrane object.\n\n        build: () =>\n            @libsToWrap = []\n\n            strEqual = (fullName) ->\n                (rule) -> fullName.indexOf(rule.apiCall) > -1\n\n            areType = (t) ->\n                (rule) -> rule instanceof t\n\n            conditionsAreTrue = (dTgt, ret) ->\n                (rule) ->\n                    _.chain(rule.conditions)\n                        .map (cond) -> cond(dTgt, ret) == true\n                        .reduce ((memo, c) -> memo and c), true\n                        .value()\n\n            doGetActions = (dTgt, args...) ->\n                (rule) ->\n                    _.chain(rule.actions)\n                        .map (action) -> action.apply(this, [dTgt].concat(args))\n                    return rule\n\n            calcRetValue = (origRet, rule) -> rule.ret(origRet)\n\n            isEmpty = (l) -> l.size().value() == 0\n            isNotFunction = (v) -> typeof v != \"function\"\n\n            @policy.onGet = (wTgt, name, wRec, dTgt, ret) =>\n                fullName = \"#{dTgt.constructor.name.toString()}.#{name}\"\n                relevantRules = _.chain(@rules)\n                    .filter(strEqual(fullName))\n\n                onRules = relevantRules.filter(areType(OnRule))\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n                onGetValue = onRules.filter(conditionsAreTrue(dTgt, ret))\n                    .map(doGetActions(dTgt, ret))\n                    .reduce(calcRetValue, ret)\n                    .value()\n\n            @policy.functionCall = (dTgt, dryThis, dryArgs, calcResult, fullName) =>\n                relevantRules = _.chain(@rules).filter(strEqual(fullName))\n\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n                calcResult = beforeRules.filter(conditionsAreTrue(dTgt))\n                       .map(doGetActions(dTgt, dryArgs, calcResult))\n                       .reduce(calcRetValue, calcResult)\n                       .value()\n\n                # return as function because the generic membrane will invoke it afterwards\n                ->\n                    ret = calcResult()\n                    afterRules.filter(conditionsAreTrue(dTgt, ret))\n                        .map(doGetActions(dTgt, dryArgs, ret))\n                        .reduce(calcRetValue, ret)\n                        .value()\n\n            @policy\n\n\n    class Rule\n        constructor: (@apiCall, @parent) ->\n\nList of actions with side effects [0..n]:\n\n            @actions = []\n\nThe default return function [1..1]:\n\n            @ret = (v) -> v\n\nA list of conditions that evaluate to `true` or `false` [1..n]:\n\n            @conditions = [ -> true]\n\n        do: (f) =>\n            @actions.push f\n            this\n\n        return: (f) =>\n            @ret = (v) -> f.call(this, v)\n            this\n\n        if: (cond) =>\n            @conditions.push (dtgt, ret) -> cond(dtgt, ret)\n            this\n\n        on: (name) => @parent.on name\n        before: (name) => @parent.before name\n        after: (name) => @parent.after name\n        build: () -> @parent.build()\n\n\n    class OnRule extends Rule\n    class AfterRule extends Rule\n    class BeforeRule extends Rule\n\n\n\n\n\n    module.exports = Policy\n","old_contents":"Policy\n======\n\n    _ = require \"underscore\"\n\n    class Policy\n        constructor: () ->\n            @rules = []\n            @libsToWrap = []\n\n            @policy =\n\nIndicate if a given library (name) should be wrapped in a separate membrane. If\na policy doesn't talk about a specific depending library, then it there is no\nneed for it to be wrapped. Therefor, the default return value is `false`:\n\n                mustWrap: (libName) ->\n                    #return true if libName == \"fs\"\n                    false\n                skip: (libName) -> false\n\n        disable: (lib) -> this\n        enableHSTS: -> this\n\n        on: (name) ->\n            child = new OnRule name, this\n            # check if (lib, call) = name must be added to libsToWrap\n            # iff lib[0].toLowerCase() == lib[0]\n            @rules.push child\n            child\n\n        before: (name) ->\n            child = new BeforeRule name, this\n            @rules.push child\n            child\n\n        after: (name) ->\n            child = new AfterRule name, this\n            @rules.push child\n            child\n\nThe `build` method generates the whole structure of our semantic model of the membrane object.\n\n        build: () =>\n            @libsToWrap = []\n\n            strEqual = (fullName) ->\n                (rule) -> fullName.indexOf(rule.apiCall) > -1\n\n            areType = (t) ->\n                (rule) -> rule instanceof t\n\n            conditionsAreTrue = (dTgt, ret) ->\n                (rule) ->\n                    _.chain(rule.conditions)\n                        .map (cond) -> cond(dTgt, ret) == true\n                        .reduce ((memo, c) -> memo and c), true\n                        .value()\n\n            doGetActions = (dTgt, args...) ->\n                (rule) ->\n                    _.chain(rule.actions)\n                        .map (action) -> action.apply(this, [dTgt].concat(args))\n                    return rule\n\n            calcRetValue = (origRet, rule) -> rule.ret(origRet)\n\n            isEmpty = (l) -> l.size().value() == 0\n            isNotFunction = (v) -> typeof v != \"function\"\n\n            @policy.onGet = (wTgt, name, wRec, dTgt, ret) =>\n                fullName = \"#{dTgt.constructor.name.toString()}.#{name}\"\n                relevantRules = _.chain(@rules)\n                    .filter(strEqual(fullName))\n\n                onRules = relevantRules.filter(areType(OnRule))\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n                onGetValue = onRules.filter(conditionsAreTrue(dTgt, ret))\n                    .map(doGetActions(dTgt, ret))\n                    .reduce(calcRetValue, ret)\n                    .value()\n\n            @policy.functionCall = (dTgt, dryThis, dryArgs, calcResult, fullName) =>\n                throw new Error \"here\" if fullName.indexOf(\"writeHead\") > -1\n                relevantRules = _.chain(@rules).filter(strEqual(fullName))\n\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n                calcResult = beforeRules.filter(conditionsAreTrue(dTgt))\n                       .map(doGetActions(dTgt, dryArgs, calcResult))\n                       .reduce(calcRetValue, calcResult)\n                       .value()\n\n                # return as function because the generic membrane will invoke it afterwards\n                ->\n                    ret = calcResult()\n                    afterRules.filter(conditionsAreTrue(dTgt, ret))\n                        .map(doGetActions(dTgt, dryArgs, ret))\n                        .reduce(calcRetValue, ret)\n                        .value()\n\n            @policy\n\n\n    class Rule\n        constructor: (@apiCall, @parent) ->\n\nList of actions with side effects [0..n]:\n\n            @actions = []\n\nThe default return function [1..1]:\n\n            @ret = (v) -> v\n\nA list of conditions that evaluate to `true` or `false` [1..n]:\n\n            @conditions = [() -> true]\n\n        do: (f) =>\n            @actions.push f\n            this\n\n        return: (f) =>\n            @ret = (v) -> f.call(this, v)\n            this\n\n        if: (cond) =>\n            @conditions.push (dtgt, ret) -> cond(dtgt, ret)\n            this\n\n        on: (name) => @parent.on name\n        before: (name) => @parent.before name\n        after: (name) => @parent.after name\n        build: () -> @parent.build()\n\n\n    class OnRule extends Rule\n    class AfterRule extends Rule\n    class BeforeRule extends Rule\n\n\n\n\n\n    module.exports = Policy\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a05bece55e4f91fd185f689ee286666bf1260afd","subject":"Remove old CC 3.0 lisences","message":"Remove old CC 3.0 lisences\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/helper\/schema.litcoffee","new_file":"coffee\/helper\/schema.litcoffee","new_contents":"    joi = require 'joi'\n\n## All\n\n### Required\n\nThese fields are required for all objects.\n\n    exports.required =\n      _id: joi.string().regex(\/^[a-f0-9]{24}$\/)\n      tilbyder: joi.string()\n      endret: joi.string()\n      checksum: joi.string()\n      lisens: joi.string().valid([\n        'Privat' # @TODO This is just temporarily\n        'CC BY 4.0'\n        'CC BY-SA 4.0'\n        'CC BY-ND 4.0'\n        'CC BY-NC 4.0'\n        'CC BY-NC-SA 4.0'\n        'CC BY-NC-ND 4.0'\n      ])\n      navngiving: joi.string()\n      status: joi.string().valid([\n        'Offentlig'\n        'Privat'\n        'Kladd'\n        'Slettet'\n      ])\n\n### Optional\n\nThere optional are optional for all objects.\n\n    exports.optional =\n      navn: joi.string()\n      kommuner: joi.array().includes(joi.string())\n      fylker: joi.array().includes(joi.string())\n      omr\u00e5der: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      beskrivelse: joi.string()\n      lenker: joi.array().includes(joi.object(\n        tittel: joi.string().optional()\n        type: joi.string().optional()\n        url: joi.string().regex(\/^https?:\\\/\\\/\/)\n      ))\n      tags: joi.array().includes(joi.string())\n      privat: joi.object()\n      grupper: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      steder: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      bilder: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      url: joi.string().regex(\/^https?:\\\/\\\/\/)\n\n## Data types\n\n    exports.type =\n\n### Bilder\n\n      bilder:\n        geojson: joi.object(\n          type: joi.string().valid('Point').required()\n          properties: joi.object(\n            altitude: joi.number().integer()\n          )\n          coordinates: joi.array().includes(joi.number()).length(2).required()\n        )\n        fotograf: joi.object(\n          navn: joi.string()\n          telefon: joi.string()\n          epost: joi.string().email()\n        )\n        eier: joi.object(\n          navn: joi.string()\n          telefon: joi.string()\n          epost: joi.string().email()\n          url: joi.string().regex(\/^https?:\\\/\\\/\/)\n        )\n        img: joi.array().includes(joi.object(\n          url: joi.string().regex(\/^https?:\\\/\\\/\/).required()\n          width: joi.number().integer()\n          height: joi.number().integer()\n          size: joi.number()\n        ))\n\n### Grupper\n\n      grupper:\n        geojson: joi.object(\n          type: joi.string().valid('Polygon').required()\n          coordinates: joi.array().includes(\n            joi.array().includes(\n              joi.array().includes(joi.number()).length(2)\n            )\n          ).required()\n        )\n        organisasjonsnr: joi.string()\n        logo: joi.string().regex(\/^https?:\\\/\\\/\/)\n        ansatte: joi.number().integer()\n        kontaktinfo: joi.array().includes(joi.object(\n          tittel: joi.string()\n          adresse1: joi.string()\n          adresse2: joi.string()\n          postnummer: joi.number().integer()\n          poststed: joi.string()\n          land: joi.string()\n          telefon: joi.string()\n          fax: joi.string()\n          epost: joi.string().email()\n          url: joi.string().regex(\/^https?:\\\/\\\/\/)\n        ))\n        foreldregruppe: joi.string().regex(\/^[a-f0-9]{24}$\/)\n\n### Turer\n\n      turer:\n        geojson: joi.object(\n          type: joi.string().valid('LineString').required()\n          coordinates: joi.array().includes(\n            joi.array().includes(joi.number()).length(2)\n          ).required()\n        )\n        distanse: joi.number()\n        retning: joi.string().valid([\n          \"AB\"\n          \"BA\"\n          \"ABA\"\n          \"BAB\"\n        ])\n        adkomst: joi.string()\n        gradering: joi.string().valid([\n          \"Enkel\"\n          \"Middels\"\n          \"Krevende\"\n          \"Ekspert\"\n        ])\n        passer_for: joi.array().includes(joi.string())\n        tilrettelagt_for: joi.array().includes(joi.string())\n        sesong: joi.array().includes(joi.number().integer().min(1).max(12))\n        tidsbruk: joi.object(\n          normal: joi.object(\n            dager: joi.number().integer()\n            timer: joi.number().integer()\n            minutter: joi.number().integer()\n          )\n          min: joi.object(\n            dager: joi.number().integer()\n            timer: joi.number().integer()\n            minutter: joi.number().integer()\n          )\n          max: joi.object(\n            dager: joi.number().integer()\n            timer: joi.number().integer()\n            minutter: joi.number().integer()\n          )\n        )\n\n### Omr\u00e5der\n\n      omr\u00e5der:\n        geojson: joi.object(\n          type: joi.string().valid('Polygon').required()\n          coordinates: joi.array().includes(\n            joi.array().includes(\n              joi.array().includes(joi.number()).length(2)\n            )\n          ).required()\n        )\n        foreldreomr\u00e5der: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n\n### Steder\n\n      steder:\n        navn_alt: joi.array().includes(joi.string())\n        ssr_id: joi.number().integer()\n        geojson: joi.object(\n          type: joi.string().valid('Point').required()\n          properties: joi.object(\n            altitude: joi.number().integer()\n          )\n          coordinates: joi.array().includes(joi.number()).length(2).required()\n        )\n        kommune: joi.string()\n        fylke: joi.string()\n        adkomst: joi.object(\n          sommer: joi.string()\n          vinter: joi.string()\n        )\n        tilrettelagt_for: joi.array().includes(joi.string())\n        fasiliteter: joi.object()\n        bygge\u00e5r: joi.number().integer()\n        bes\u00f8ksstatisikk: joi.object()\n        betjeningsgrad: joi.string()\n        kart: joi.string()\n        turkart: joi.array().includes(joi.string())\n\n","old_contents":"    joi = require 'joi'\n\n## All\n\n### Required\n\nThese fields are required for all objects.\n\n    exports.required =\n      _id: joi.string().regex(\/^[a-f0-9]{24}$\/)\n      tilbyder: joi.string()\n      endret: joi.string()\n      checksum: joi.string()\n      lisens: joi.string().valid([\n        'Privat' # @TODO This is just temporarily\n        'CC BY 3.0 NO'\n        'CC BY-SA 3.0 NO'\n        'CC BY-ND 3.0 NO'\n        'CC BY-NC 3.0 NO'\n        'CC BY-NC-SA 3.0 NO'\n        'CC BY-NC-ND 3.0 NO'\n        'CC BY 4.0'\n        'CC BY-SA 4.0'\n        'CC BY-ND 4.0'\n        'CC BY-NC 4.0'\n        'CC BY-NC-SA 4.0'\n        'CC BY-NC-ND 4.0'\n      ])\n      navngiving: joi.string()\n      status: joi.string().valid([\n        'Offentlig'\n        'Privat'\n        'Kladd'\n        'Slettet'\n      ])\n\n### Optional\n\nThere optional are optional for all objects.\n\n    exports.optional =\n      navn: joi.string()\n      kommuner: joi.array().includes(joi.string())\n      fylker: joi.array().includes(joi.string())\n      omr\u00e5der: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      beskrivelse: joi.string()\n      lenker: joi.array().includes(joi.object(\n        tittel: joi.string().optional()\n        type: joi.string().optional()\n        url: joi.string().regex(\/^https?:\\\/\\\/\/)\n      ))\n      tags: joi.array().includes(joi.string())\n      privat: joi.object()\n      grupper: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      steder: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      bilder: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      url: joi.string().regex(\/^https?:\\\/\\\/\/)\n\n## Data types\n\n    exports.type =\n\n### Bilder\n\n      bilder:\n        geojson: joi.object(\n          type: joi.string().valid('Point').required()\n          properties: joi.object(\n            altitude: joi.number().integer()\n          )\n          coordinates: joi.array().includes(joi.number()).length(2).required()\n        )\n        fotograf: joi.object(\n          navn: joi.string()\n          telefon: joi.string()\n          epost: joi.string().email()\n        )\n        eier: joi.object(\n          navn: joi.string()\n          telefon: joi.string()\n          epost: joi.string().email()\n          url: joi.string().regex(\/^https?:\\\/\\\/\/)\n        )\n        img: joi.array().includes(joi.object(\n          url: joi.string().regex(\/^https?:\\\/\\\/\/).required()\n          width: joi.number().integer()\n          height: joi.number().integer()\n          size: joi.number()\n        ))\n\n### Grupper\n\n      grupper:\n        geojson: joi.object(\n          type: joi.string().valid('Polygon').required()\n          coordinates: joi.array().includes(\n            joi.array().includes(\n              joi.array().includes(joi.number()).length(2)\n            )\n          ).required()\n        )\n        organisasjonsnr: joi.string()\n        logo: joi.string().regex(\/^https?:\\\/\\\/\/)\n        ansatte: joi.number().integer()\n        kontaktinfo: joi.array().includes(joi.object(\n          tittel: joi.string()\n          adresse1: joi.string()\n          adresse2: joi.string()\n          postnummer: joi.number().integer()\n          poststed: joi.string()\n          land: joi.string()\n          telefon: joi.string()\n          fax: joi.string()\n          epost: joi.string().email()\n          url: joi.string().regex(\/^https?:\\\/\\\/\/)\n        ))\n        foreldregruppe: joi.string().regex(\/^[a-f0-9]{24}$\/)\n\n### Turer\n\n      turer:\n        geojson: joi.object(\n          type: joi.string().valid('LineString').required()\n          coordinates: joi.array().includes(\n            joi.array().includes(joi.number()).length(2)\n          ).required()\n        )\n        distanse: joi.number()\n        retning: joi.string().valid([\n          \"AB\"\n          \"BA\"\n          \"ABA\"\n          \"BAB\"\n        ])\n        adkomst: joi.string()\n        gradering: joi.string().valid([\n          \"Enkel\"\n          \"Middels\"\n          \"Krevende\"\n          \"Ekspert\"\n        ])\n        passer_for: joi.array().includes(joi.string())\n        tilrettelagt_for: joi.array().includes(joi.string())\n        sesong: joi.array().includes(joi.number().integer().min(1).max(12))\n        tidsbruk: joi.object(\n          normal: joi.object(\n            dager: joi.number().integer()\n            timer: joi.number().integer()\n            minutter: joi.number().integer()\n          )\n          min: joi.object(\n            dager: joi.number().integer()\n            timer: joi.number().integer()\n            minutter: joi.number().integer()\n          )\n          max: joi.object(\n            dager: joi.number().integer()\n            timer: joi.number().integer()\n            minutter: joi.number().integer()\n          )\n        )\n\n### Omr\u00e5der\n\n      omr\u00e5der:\n        geojson: joi.object(\n          type: joi.string().valid('Polygon').required()\n          coordinates: joi.array().includes(\n            joi.array().includes(\n              joi.array().includes(joi.number()).length(2)\n            )\n          ).required()\n        )\n        foreldreomr\u00e5der: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n\n### Steder\n\n      steder:\n        navn_alt: joi.array().includes(joi.string())\n        ssr_id: joi.number().integer()\n        geojson: joi.object(\n          type: joi.string().valid('Point').required()\n          properties: joi.object(\n            altitude: joi.number().integer()\n          )\n          coordinates: joi.array().includes(joi.number()).length(2).required()\n        )\n        kommune: joi.string()\n        fylke: joi.string()\n        adkomst: joi.object(\n          sommer: joi.string()\n          vinter: joi.string()\n        )\n        tilrettelagt_for: joi.array().includes(joi.string())\n        fasiliteter: joi.object()\n        bygge\u00e5r: joi.number().integer()\n        bes\u00f8ksstatisikk: joi.object()\n        betjeningsgrad: joi.string()\n        kart: joi.string()\n        turkart: joi.array().includes(joi.string())\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ba8b536ac3a93fd45f00e8dd8530310536504112","subject":"Update Librato image count handling","message":"Update Librato image count handling\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/server.litcoffee","new_file":"src\/server.litcoffee","new_contents":"    url          = require 'url'\n\n    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n    librato      = require '.\/librato'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketRegion: process.env.AWS_BUCKET_REGION\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      origin = url.parse req.get('Origin') or ''\n\n      if origin.hostname not in origins\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status = 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      librato.logImagesUploaded Object.keys req.files\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        t1 = new Date().getTime()\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          librato.logImageProcessingTime t1, new Date().getTime()\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","old_contents":"    url          = require 'url'\n\n    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n    librato      = require '.\/librato'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketRegion: process.env.AWS_BUCKET_REGION\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      origin = url.parse req.get('Origin') or ''\n\n      if origin.hostname not in origins\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status = 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      librato.measure 'image.upload', Object.keys(req.files).length, {}\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        t1 = new Date().getTime()\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          librato.logImageProcessingTime t1, new Date().getTime()\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d2246cc26833d93370cf6f9f0682fce3fab49f88","subject":"more formatting","message":"more formatting\n","repos":"stephenhutchings\/written,stephenhutchings\/written","old_file":"underscore.strings.litcoffee","new_file":"underscore.strings.litcoffee","new_contents":"### Underscore Strings\n\nUseful Underscore string methods for more readable, human language:\n\n- [Capitalization](#capitalization)\n- [Cases](#cases)\n- [Tags](#tags)\n- [Lists](#lists)\n- [Hyphenation](#hyphenation)\n- [Quantify](#quantify)\n- [Written Numbers](#written-numbers)\n\n-------\n\n#### Setup\nDo nothing without the presence of Underscore.\n\n    return unless _?\n\nThis regular expression includes words we won't capitalize.\n\n    noncapsWords = \/^(a|an|and|as|be|of|the|to)$\/\n\n...and this helps to split \"cased\" words into their constituent parts...\n\n    caseSplitter = \/[-_\\s]|(!?[A-Z][a-z]*)\/g\n\n...so we can join them together with some glue.\n\n    cleanJoin    = (arr, glue) -> _.compact(arr).join(glue)\n\nAssuming we are using the English language, we'll declare some numbers\n\n    numbers =\n      \"EN\": [\"one\", \"two\", \"three\", \"four\", \"five\", \"six\", \"seven\",\"eight\", \"nine\", \"ten\", \"eleven\", \"twelve\"]\n      \"FR\": [{m: \"un\", f: \"une\"}, \"deux\", \"trois\", \"quatre\", \"cinq\", \"six\", \"sept\", \"huit\", \"neuf\", \"dix\", \"onze\", \"douze\"]\n      \"DE\": [\"eins\", \"zwei\", \"drei\", \"vier\", \"f\u00fcnf\", \"sechs\", \"sieben\", \"acht\", \"neun\", \"zehn\", \"elf\", \"zw\u00f6lf\"]\n      \"IT\": [{m: \"uno\", f: \"una\"}, \"due\", \"tre\", \"quattro\", \"cinque\", \"sei\", \"sette\", \"otto\", \"nove\", \"dieci\", \"undici\", \"dodic\"]\n      \"ES\": [{m: \"uno\", f: \"una\"}, \"dos\", \"tres\", \"cuatro\", \"cinco\", \"seis\", \"siete\", \"ocho\", \"nueve\", \"diez\", \"once\", \"doce\"]\n\nDeclare the mixins we're adding...\n\n    mixins =\n\n-------\n\n#### Capitalization\nCapitalize the first letter of a string.\n\n      capitalize: (str) ->\n        str.charAt(0).toUpperCase() + str.slice(1)\n\nCapitalize all words in a string apart from some common lower case words.\n\n```coffee\n# Examples\n_.capitalizeAll(\"this and that\") # \"This and That\"\n```\n\n      capitalizeAll: (str, regEx = noncapsWords) ->\n        _.map(str.split(\" \"), (s, i) ->\n          if i > 0 and regEx.test(s) then s else _.capitalize(s)\n        ).join(\" \")\n\n\n#### Cases\nTransform strings between common code cases:\n\n```coffee\n# Examples\n_.camelCase(\"some-thing\")  # \"someThing\"\n_.hyphenCase(\"some_thing\") # \"some-thing\"\n_.snakeCase(\"someThing\")   # \"some_thing\"\n_.humanCase(\"fromA_to-Z\")  # \"from A to Z\"\n```\n\n      camelCase: (str) ->\n        str.replace(\/[\\s_-](\\w)\/g, (a, w) -> w.toUpperCase())\n\n      hyphenCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \"-\").toLowerCase()\n\n      snakeCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \"_\").toLowerCase()\n\n      humanCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \" \")\n\n\n#### Tags\nEnclose a string inside an HTML tag.\n\n```coffee\n# Examples\n_.wrapInTag(\"Hello world!\", \"strong\") # \"<strong>Hello world!<\/strong>\"\n```\n\n      wrapInTag: (str, tag = \"span\") ->\n        \"<#{tag}>#{str}<\/#{tag}>\"\n\n#### Lists\nGroup strings into a grammatically correct list with an arbitrary limit.\n\n```coffee\n# Examples\n_.prettyList([\"Ben\", \"Bob\"])                      # \"Ben and Bob\"\n_.prettyList([\"Ben\", \"Bob\", \"Bill\"])              # \"Ben, Bob and Bill\"\n_.prettyList([\"Ben\", \"Bob\", \"Bill\", \"Max\"], 2)    # \"Ben, Bob and 2 more\"\n_.prettyList([\"Ben\", \"Bob\"], 1, {more: \"other\"})  # \"Ben and 1 other\"\n```\n\n      prettyList: (arr, max, opts = {}) ->\n        more   = opts.more or \"more\"\n        amp    = opts.amp or \"and\"\n\n        if opts.wrap\n          arr = _.map(arr, (s) -> _.wrapInTag(s, opts.wrap))\n\n        if max < (len = arr.length)\n          diff = len - max\n          more = _.quantify(more, diff, false) if opts.quantify\n          diff = _.writtenNumber(diff, opts.numbers) if opts.written\n          arr  = arr.slice(0, max)\n          arr  = arr.concat(\"#{diff} #{more}\")\n\n        arr\n          .slice(0, -1)\n          .join(\", \")\n          .concat((if arr.length is 1 then \"\" else \" #{amp} \"), arr.slice(-1))\n\n\n#### Hyphenation\nAdd soft hyphens every `n` characters so that the CSS attribute\n`hyphens: manual` will allow for nice breaks in long strings of text.\n\n```coffee\n# Examples\n_.hyphenate(\"antidisestablishmentarianism\") # \"antidisest%C2%ADablishment%C2%ADarianism\"\n```\n\n      hyphenate: (str = \"\", n = 10, softHyphen = \"\\u00AD\") ->\n        str.replace new RegExp(\"\\\\w{#{n}}\", \"g\"), (w) -> w + softHyphen\n\n\n#### Quantify\nAdd an \"s\" to a string when an amount is non-singular, disregarding the\norder of the arguments passsed.\n\n```coffee\n# Examples\n_.prettyList(\"monkey\", 1)                   # \"1 monkey\"\n_.prettyList(1, \"monkey\")                   # \"1 monkey\"\n_.prettyList(\"monkey\", 9, written: true)    # \"nine monkeys\"\n```\n\n      quantify: (str, n, {numberless, written, lang}) ->\n        { n, str } = str: n, n: str unless _.isString(str)\n\n        _n = _.writtenNumber(n, lang) if written?\n\n        (if numberless? then \"\" else _n + \" \") +\n        str +\n        (if n is 1 then \"\" else \"s\")\n\n#### Written Numbers\nConvert numbers between one and twelve into their written counter-parts.\n\n```coffee\n# Examples\n_.writtenNumber(1)                          # \"one\"\n_.writtenNumber(2, \"DE\")                    # \"zwei\"\n```\n\n      writtenNumber: (n, lang = \"EN\", gender = \"m\") ->\n        if n < 13\n          num = numbers[lang][n - 1]\n          num[gender] and num[gender] or num\n        else\n          n\n\n      setNumbers: (arr, lang) ->\n        numbers[lang] = arr\n\nAdd the mixin object to Underscore.\n\n    _.mixin(mixins)\n","old_contents":"### Underscore Strings\n\nUseful Underscore string methods for more readable, human language\n\nDo nothing without the presence of Underscore.\n\n    return unless _?\n\nThis regular expression includes words we won't capitalize.\n\n    noncapsWords = \/^(a|an|and|as|be|of|the|to)$\/\n\n...and this helps to split \"cased\" words into their constituent parts...\n\n    caseSplitter = \/[-_\\s]|(!?[A-Z][a-z]*)\/g\n\n...so we can join them together with some glue.\n\n    cleanJoin    = (arr, glue) -> _.compact(arr).join(glue)\n\nAssuming we are using the English language, we'll declare some numbers\n\n    numbers =\n      \"EN\": [\"one\", \"two\", \"three\", \"four\", \"five\", \"six\", \"seven\",\"eight\", \"nine\", \"ten\", \"eleven\", \"twelve\"]\n      \"FR\": [{m: \"un\", f: \"une\"}, \"deux\", \"trois\", \"quatre\", \"cinq\", \"six\", \"sept\", \"huit\", \"neuf\", \"dix\", \"onze\", \"douze\"]\n      \"DE\": [\"eins\", \"zwei\", \"drei\", \"vier\", \"f\u00fcnf\", \"sechs\", \"sieben\", \"acht\", \"neun\", \"zehn\", \"elf\", \"zw\u00f6lf\"]\n      \"IT\": [{m: \"uno\", f: \"una\"}, \"due\", \"tre\", \"quattro\", \"cinque\", \"sei\", \"sette\", \"otto\", \"nove\", \"dieci\", \"undici\", \"dodic\"]\n      \"ES\": [{m: \"uno\", f: \"una\"}, \"dos\", \"tres\", \"cuatro\", \"cinco\", \"seis\", \"siete\", \"ocho\", \"nueve\", \"diez\", \"once\", \"doce\"]\n\nDeclare the mixins we're adding...\n\n    mixins =\n\n#### Capitalization\nCapitalize the first letter of a string.\n\n      capitalize: (str) ->\n        str.charAt(0).toUpperCase() + str.slice(1)\n\nCapitalize all words in a string apart from some common lower case words.\n\n```coffee\n# Examples\n_.capitalizeAll(\"this and that\") # \"This and That\"\n```\n\n      capitalizeAll: (str, regEx = noncapsWords) ->\n        _.map(str.split(\" \"), (s, i) ->\n          if i > 0 and regEx.test(s) then s else _.capitalize(s)\n        ).join(\" \")\n\n\n#### Cases\nTransform strings between common code cases:\n\n```coffee\n# Examples\n_.camelCase(\"some-thing\")  # \"someThing\"\n_.hyphenCase(\"some_thing\") # \"some-thing\"\n_.snakeCase(\"someThing\")   # \"some_thing\"\n_.humanCase(\"fromA_to-Z\")  # \"from A to Z\"\n```\n\n      camelCase: (str) ->\n        str.replace(\/[\\s_-](\\w)\/g, (a, w) -> w.toUpperCase())\n\n      hyphenCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \"-\").toLowerCase()\n\n      snakeCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \"_\").toLowerCase()\n\n      humanCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \" \")\n\n\n#### Tags\nEnclose a string inside an HTML tag.\n\n```coffee\n# Examples\n_.wrapInTag(\"Hello world!\", \"strong\") # \"<strong>Hello world!<\/strong>\"\n```\n\n      wrapInTag: (str, tag = \"span\") ->\n        \"<#{tag}>#{str}<\/#{tag}>\"\n\n#### Lists\nGroup strings into a grammatically correct list with an arbitrary limit.\n\n```coffee\n# Examples\n_.prettyList([\"Ben\", \"Bob\"])                      # \"Ben and Bob\"\n_.prettyList([\"Ben\", \"Bob\", \"Bill\"])              # \"Ben, Bob and Bill\"\n_.prettyList([\"Ben\", \"Bob\", \"Bill\", \"Max\"], 2)    # \"Ben, Bob and 2 more\"\n_.prettyList([\"Ben\", \"Bob\"], 1, {more: \"other\"})  # \"Ben and 1 other\"\n```\n\n      prettyList: (arr, max, opts = {}) ->\n        more   = opts.more or \"more\"\n        amp    = opts.amp or \"and\"\n\n        if opts.wrap\n          arr = _.map(arr, (s) -> _.wrapInTag(s, opts.wrap))\n\n        if max < (len = arr.length)\n          diff = len - max\n          more = _.quantify(more, diff, false) if opts.quantify\n          diff = _.writtenNumber(diff, opts.numbers) if opts.written\n          arr  = arr.slice(0, max)\n          arr  = arr.concat(\"#{diff} #{more}\")\n\n        arr\n          .slice(0, -1)\n          .join(\", \")\n          .concat((if arr.length is 1 then \"\" else \" #{amp} \"), arr.slice(-1))\n\n\n#### Hyphenation\nAdd soft hyphens every `n` characters so that the CSS attribute\n`hyphens: manual` will allow for nice breaks in long strings of text.\n\n```coffee\n# Examples\n_.hyphenate(\"antidisestablishmentarianism\") # \"antidisest%C2%ADablishment%C2%ADarianism\"\n```\n\n      hyphenate: (str = \"\", n = 10, softHyphen = \"\\u00AD\") ->\n        str.replace new RegExp(\"\\\\w{#{n}}\", \"g\"), (w) -> w + softHyphen\n\n\nAdd an \"s\" to a string when an amount is non-singular, disregarding the\norder of the arguments passsed.\n\n```coffee\n# Examples\n_.prettyList(\"monkey\", 1)                   # \"1 monkey\"\n_.prettyList(1, \"monkey\")                   # \"1 monkey\"\n_.prettyList(\"monkey\", 9, written: true)    # \"nine monkeys\"\n```\n\n      quantify: (str, n, {numberless, written, lang}) ->\n        { n, str } = str: n, n: str unless _.isString(str)\n\n        _n = _.writtenNumber(n, lang) if written?\n\n        (if numberless? then \"\" else _n + \" \") +\n        str +\n        (if n is 1 then \"\" else \"s\")\n\n#### Written Numbers\nConvert numbers between one and twelve into their written counter-parts.\n\n```coffee\n# Examples\n_.writtenNumber(1)                          # \"one\"\n_.writtenNumber(2, \"DE\")                    # \"zwei\"\n```\n\n      writtenNumber: (n, lang = \"EN\", gender = \"m\") ->\n        if n < 13\n          num = numbers[lang][n - 1]\n          num[gender] and num[gender] or num\n        else\n          n\n\n      setNumbers: (arr, lang) ->\n        numbers[lang] = arr\n\nAdd the mixin object to Underscore.\n\n    _.mixin(mixins)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1e820d94c31d17625a78b4d88e223ec191546103","subject":"Don't be rude.","message":"Don't be rude.\n","repos":"daithiocrualaoich\/euler","old_file":"litcoffee\/001.litcoffee","new_file":"litcoffee\/001.litcoffee","new_contents":"Multiples of 3 and 5\n====================\nIf we list all the natural numbers below 10 that are multiples of 3 or 5, we get\n3, 5, 6 and 9. The sum of these multiples is 23.\n\nFind the sum of all the multiples of 3 or 5 below 1000.\n\n\nAnswer\n======\nInclude library functions for Number Theory.\n\n    require('.\/number-theory')\n\nDon't include 1000 in this strange Fizz Buzz.\n\n    multiples = (n for n in [1..999] when 3.divides(n) || 5.divides(n))\n\n    answer = multiples.sum()\n    console.log(answer)\n","old_contents":"Multiples of 3 and 5\n====================\nIf we list all the natural numbers below 10 that are multiples of 3 or 5, we get\n3, 5, 6 and 9. The sum of these multiples is 23.\n\nFind the sum of all the multiples of 3 or 5 below 1000.\n\n\nAnswer\n======\nInclude library functions for Number Theory.\n\n    require('.\/number-theory')\n\nDon't include 1000 in this perverted Fizz Buzz.\n\n    multiples = (n for n in [1..999] when 3.divides(n) || 5.divides(n))\n\n    answer = multiples.sum()\n    console.log(answer)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"41e6600c548ce9bdec40814d9ae737c398df7307","subject":"removing sourceColumn reset","message":"removing sourceColumn reset\n","repos":"sterpe\/coffee-fmt","old_file":"sourcemap.litcoffee","new_file":"sourcemap.litcoffee","new_contents":"Source maps allow JavaScript runtimes to match running JavaScript back to\nthe original source code that corresponds to it. This can be minified\nJavaScript, but in our case, we're concerned with mapping pretty-printed\nJavaScript back to CoffeeScript.\n\nIn order to produce maps, we must keep track of positions (line number, column number)\nthat originated every node in the syntax tree, and be able to generate a\n[map file](https:\/\/docs.google.com\/document\/d\/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k\/edit)\n\u2014 which is a compact, VLQ-encoded representation of the JSON serialization\nof this information \u2014 to write out alongside the generated JavaScript.\n\n\nLineMap\n-------\n\nA **LineMap** object keeps track of information about original line and column\npositions for a single line of output JavaScript code.\n**SourceMaps** are implemented in terms of **LineMaps**.\n\n    class LineMap\n      constructor: (@line) ->\n        @columns = []\n\n      add: (column, [sourceLine, sourceColumn], options={}) ->\n        return if @columns[column] and options.noReplace\n        @columns[column] = {line: @line, column, sourceLine, sourceColumn}\n\n      sourceLocation: (column) ->\n        column-- until (mapping = @columns[column]) or (column <= 0)\n        mapping and [mapping.sourceLine, mapping.sourceColumn]\n\n\nSourceMap\n---------\n\nMaps locations in a single generated JavaScript file back to locations in\nthe original CoffeeScript source file.\n\nThis is intentionally agnostic towards how a source map might be represented on\ndisk. Once the compiler is ready to produce a \"v3\"-style source map, we can walk\nthrough the arrays of line and column buffer to produce it.\n\n    class SourceMap\n      constructor: ->\n        @lines = []\n\nAdds a mapping to this SourceMap. `sourceLocation` and `generatedLocation`\nare both `[line, column]` arrays. If `options.noReplace` is true, then if there\nis already a mapping for the specified `line` and `column`, this will have no\neffect.\n\n      add: (sourceLocation, generatedLocation, options = {}) ->\n        [line, column] = generatedLocation\n        lineMap = (@lines[line] or= new LineMap(line))\n        lineMap.add column, sourceLocation, options\n\nLook up the original position of a given `line` and `column` in the generated\ncode.\n\n      sourceLocation: ([line, column]) ->\n        line-- until (lineMap = @lines[line]) or (line <= 0)\n        lineMap and lineMap.sourceLocation column\n\n\nV3 SourceMap Generation\n-----------------------\n\nBuilds up a V3 source map, returning the generated JSON as a string.\n`options.sourceRoot` may be used to specify the sourceRoot written to the source\nmap.  Also, `options.sourceFiles` and `options.generatedFile` may be passed to\nset \"sources\" and \"file\", respectively.\n\n      generate: (options = {}, code = null) ->\n        writingline       = 0\n        lastColumn        = 0\n        lastSourceLine    = 0\n        lastSourceColumn  = 0\n        needComma         = no\n        buffer            = \"\"\n\n        for lineMap, lineNumber in @lines when lineMap\n          for mapping in lineMap.columns when mapping\n            while writingline < mapping.line\n              lastColumn = 0\n              needComma = no\n              buffer += \";\"\n              writingline++\n\nWrite a comma if we've already written a segment on this line.\n\n            if needComma\n              buffer += \",\"\n              needComma = no\n\nWrite the next segment. Segments can be 1, 4, or 5 values.  If just one, then it\nis a generated column which doesn't match anything in the source code.\n\nThe starting column in the generated source, relative to any previous recorded\ncolumn for the current line:\n\n            buffer += @encodeVlq mapping.column - lastColumn\n            lastColumn = mapping.column\n\nThe index into the list of sources:\n\n            buffer += @encodeVlq 0\n\nThe starting line in the original source, relative to the previous source line.\n\n            buffer += @encodeVlq mapping.sourceLine - lastSourceLine\n            lastSourceLine = mapping.sourceLine\n\nThe starting column in the original source, relative to the previous column.\n\n            buffer += @encodeVlq mapping.sourceColumn - lastSourceColumn\n            lastSourceColumn = mapping.sourceColumn\n            needComma = yes\n\nProduce the canonical JSON object format for a \"v3\" source map.\n\n        v3 =\n          version:    3\n          file:       options.generatedFile or ''\n          sourceRoot: options.sourceRoot or ''\n          sources:    options.sourceFiles or ['']\n          names:      []\n          mappings:   buffer\n\n        v3.sourcesContent = [code] if options.inline\n\n        JSON.stringify v3, null, 2\n\n\nBase64 VLQ Encoding\n-------------------\n\nNote that SourceMap VLQ encoding is \"backwards\".  MIDI-style VLQ encoding puts\nthe most-significant-bit (MSB) from the original value into the MSB of the VLQ\nencoded value (see [Wikipedia](http:\/\/en.wikipedia.org\/wiki\/File:Uintvar_coding.svg)).\nSourceMap VLQ does things the other way around, with the least significat four\nbits of the original value encoded into the first byte of the VLQ encoded value.\n\n      VLQ_SHIFT            = 5\n      VLQ_CONTINUATION_BIT = 1 << VLQ_SHIFT             # 0010 0000\n      VLQ_VALUE_MASK       = VLQ_CONTINUATION_BIT - 1   # 0001 1111\n\n      encodeVlq: (value) ->\n        answer = ''\n\n        # Least significant bit represents the sign.\n        signBit = if value < 0 then 1 else 0\n\n        # The next bits are the actual value.\n        valueToEncode = (Math.abs(value) << 1) + signBit\n\n        # Make sure we encode at least one character, even if valueToEncode is 0.\n        while valueToEncode or not answer\n          nextChunk = valueToEncode & VLQ_VALUE_MASK\n          valueToEncode = valueToEncode >> VLQ_SHIFT\n          nextChunk |= VLQ_CONTINUATION_BIT if valueToEncode\n          answer += @encodeBase64 nextChunk\n\n        answer\n\n\nRegular Base64 Encoding\n-----------------------\n\n      BASE64_CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+\/'\n\n      encodeBase64: (value) ->\n        BASE64_CHARS[value] or throw new Error \"Cannot Base64 encode value: #{value}\"\n\n\nOur API for source maps is just the `SourceMap` class.\n\n    module.exports = SourceMap\n\n\n\n","old_contents":"Source maps allow JavaScript runtimes to match running JavaScript back to\nthe original source code that corresponds to it. This can be minified\nJavaScript, but in our case, we're concerned with mapping pretty-printed\nJavaScript back to CoffeeScript.\n\nIn order to produce maps, we must keep track of positions (line number, column number)\nthat originated every node in the syntax tree, and be able to generate a\n[map file](https:\/\/docs.google.com\/document\/d\/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k\/edit)\n\u2014 which is a compact, VLQ-encoded representation of the JSON serialization\nof this information \u2014 to write out alongside the generated JavaScript.\n\n\nLineMap\n-------\n\nA **LineMap** object keeps track of information about original line and column\npositions for a single line of output JavaScript code.\n**SourceMaps** are implemented in terms of **LineMaps**.\n\n    class LineMap\n      constructor: (@line) ->\n        @columns = []\n\n      add: (column, [sourceLine, sourceColumn], options={}) ->\n        return if @columns[column] and options.noReplace\n        @columns[column] = {line: @line, column, sourceLine, sourceColumn}\n\n      sourceLocation: (column) ->\n        column-- until (mapping = @columns[column]) or (column <= 0)\n        mapping and [mapping.sourceLine, mapping.sourceColumn]\n\n\nSourceMap\n---------\n\nMaps locations in a single generated JavaScript file back to locations in\nthe original CoffeeScript source file.\n\nThis is intentionally agnostic towards how a source map might be represented on\ndisk. Once the compiler is ready to produce a \"v3\"-style source map, we can walk\nthrough the arrays of line and column buffer to produce it.\n\n    class SourceMap\n      constructor: ->\n        @lines = []\n\nAdds a mapping to this SourceMap. `sourceLocation` and `generatedLocation`\nare both `[line, column]` arrays. If `options.noReplace` is true, then if there\nis already a mapping for the specified `line` and `column`, this will have no\neffect.\n\n      add: (sourceLocation, generatedLocation, options = {}) ->\n        [line, column] = generatedLocation\n        lineMap = (@lines[line] or= new LineMap(line))\n        lineMap.add column, sourceLocation, options\n\nLook up the original position of a given `line` and `column` in the generated\ncode.\n\n      sourceLocation: ([line, column]) ->\n        line-- until (lineMap = @lines[line]) or (line <= 0)\n        lineMap and lineMap.sourceLocation column\n\n\nV3 SourceMap Generation\n-----------------------\n\nBuilds up a V3 source map, returning the generated JSON as a string.\n`options.sourceRoot` may be used to specify the sourceRoot written to the source\nmap.  Also, `options.sourceFiles` and `options.generatedFile` may be passed to\nset \"sources\" and \"file\", respectively.\n\n      generate: (options = {}, code = null) ->\n        writingline       = 0\n        lastColumn        = 0\n        lastSourceLine    = 0\n        lastSourceColumn  = 0\n        needComma         = no\n        buffer            = \"\"\n\n        for lineMap, lineNumber in @lines when lineMap\n          for mapping in lineMap.columns when mapping\n            while writingline < mapping.line\n              lastColumn = 0\n              needComma = no\n              buffer += \";\"\n              writingline++\n\nWrite a comma if we've already written a segment on this line.\n\n            if needComma\n              buffer += \",\"\n              needComma = no\n\nWrite the next segment. Segments can be 1, 4, or 5 values.  If just one, then it\nis a generated column which doesn't match anything in the source code.\n\nThe starting column in the generated source, relative to any previous recorded\ncolumn for the current line:\n\n            buffer += @encodeVlq mapping.column - lastColumn\n            lastColumn = mapping.column\n\nThe index into the list of sources:\n\n            buffer += @encodeVlq 0\n\nThe starting line in the original source, relative to the previous source line.\n\n            buffer += @encodeVlq mapping.sourceLine - lastSourceLine\n            if lastSourceLine isnt mapping.sourceLine\n              lastSourceLine = mapping.sourceLine\n              lastSourceColumn = 0\n\nThe starting column in the original source, relative to the previous column.\n\n            buffer += @encodeVlq mapping.sourceColumn - lastSourceColumn\n            lastSourceColumn = mapping.sourceColumn\n            needComma = yes\n\nProduce the canonical JSON object format for a \"v3\" source map.\n\n        v3 =\n          version:    3\n          file:       options.generatedFile or ''\n          sourceRoot: options.sourceRoot or ''\n          sources:    options.sourceFiles or ['']\n          names:      []\n          mappings:   buffer\n\n        v3.sourcesContent = [code] if options.inline\n\n        JSON.stringify v3, null, 2\n\n\nBase64 VLQ Encoding\n-------------------\n\nNote that SourceMap VLQ encoding is \"backwards\".  MIDI-style VLQ encoding puts\nthe most-significant-bit (MSB) from the original value into the MSB of the VLQ\nencoded value (see [Wikipedia](http:\/\/en.wikipedia.org\/wiki\/File:Uintvar_coding.svg)).\nSourceMap VLQ does things the other way around, with the least significat four\nbits of the original value encoded into the first byte of the VLQ encoded value.\n\n      VLQ_SHIFT            = 5\n      VLQ_CONTINUATION_BIT = 1 << VLQ_SHIFT             # 0010 0000\n      VLQ_VALUE_MASK       = VLQ_CONTINUATION_BIT - 1   # 0001 1111\n\n      encodeVlq: (value) ->\n        answer = ''\n\n        # Least significant bit represents the sign.\n        signBit = if value < 0 then 1 else 0\n\n        # The next bits are the actual value.\n        valueToEncode = (Math.abs(value) << 1) + signBit\n\n        # Make sure we encode at least one character, even if valueToEncode is 0.\n        while valueToEncode or not answer\n          nextChunk = valueToEncode & VLQ_VALUE_MASK\n          valueToEncode = valueToEncode >> VLQ_SHIFT\n          nextChunk |= VLQ_CONTINUATION_BIT if valueToEncode\n          answer += @encodeBase64 nextChunk\n\n        answer\n\n\nRegular Base64 Encoding\n-----------------------\n\n      BASE64_CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+\/'\n\n      encodeBase64: (value) ->\n        BASE64_CHARS[value] or throw new Error \"Cannot Base64 encode value: #{value}\"\n\n\nOur API for source maps is just the `SourceMap` class.\n\n    module.exports = SourceMap\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6a7a8f5c09dd3d45de2f78e3cbcf7ba8c2bf0940","subject":"add to usage notes","message":"add to usage notes\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/24_paginator.litcoffee","new_file":"docs\/24_paginator.litcoffee","new_contents":"# \/api\/Extras\/Batman.Paginator\n\n`Batman.Paginator` is an abstract class which is implemented by `Batman.ModelPaginator`. For information about paginating records, see `Batman.ModelPaginator`.\n\n\n`Batman.Paginator` provides:\n\n- exposing pages of records (via `toArray`) and changing pages (`nextPage` \/ `previousPage`)\n- item caching and  prevention of reloading\/concurrent loading of pages\n- calculation calucations for `page`, `offset`, `limit`, etc.\n\n## ::constructor(options={}) : Paginator\n\nReturns a new paginator, mixing in `options`. `options` may include:\n\n- `limit`\n- `offset` or `page`\n- `totalCount`\n\n## ::loadItemsForOffsetAndLimit(offset, limit)\n\nImplementations of `Batman.Paginator` must implement this function. See `Batman.ModelPaginator` for an example.\n\nThis function should load items, then call `@updateCache(offset, limit, items)`.\n\nInternally, `Batman.Paginator`:\n\n- prevents reloading a page when it's still loading\n- prevents loading a page twice\n\n## ::%toArray : Array\n\nReturns an array of items in the current `page`. This property depends on `offset` and `limit`, so changing `offset`, `limit` or `page` will automatically update `toArray`.\n\n## ::nextPage()\n\nIncrements the current `page`, causing `toArray` to be updated.\n\n## ::previousPage()\n\nDecrements the current `page`, causing `toArray` to be updated.\n\n## ::%page : Number\n\nCurrent page number, determined by `offset` and `limit`. Setting `page` automatically increases `offset`.\n\nSince `toArray` depends on `offset`, setting `page` will also cause `toArray` to be updated.\n\n## ::%offset : Number\n\nNumber of items skipped for the current `page`.\n\n## ::%limit : Number\n\nItems per page.\n\n## ::%totalCount : Number\n\nTotal number of records covered by the `Paginator`.\n\n## ::%pageCount : Number\n\nTotal number of pages covered by the `Paginator`, calculated from `totalCount` and `limit`.\n\n## ::updateCache(offset, limit, items)\n\nRegisters `items` as the items from `offset` for `limit`. This should be called by `loadItemsForOffsetAndLimit` to inform the paginator of loaded records.\n\n# \/api\/Extras\/Batman.Paginator\/Batman.ModelPaginator\n\n`Batman.ModelPaginator` is a concrete implementation of `Batman.Paginator`. It may be used for paginating `Batman.Model` instances.\n\nA `Batman.ModelPaginator` provides pagination by:\n\n- Taking `model`, `limit`, `params`, and `page`\/`offset` as input\n- Exposing records by its `toArray` property (eg, `paginator.get('toArray')`)\n\n## Using Batman.ModelPaginator\n\nAdd a paginator to your controller:\n\n```coffeescript\nclass App.PostsController extends Batman.Controller\n  index: -> # renders posts\/index.html\n    @set 'paginator, new Batman.ModelPaginator\n      model: App.Post\n      limit: 10\n      page: 1\n      params: {order: \"created_at\"}\n```\n\nThen, bind to it in your HTML:\n\n```html\n<ul>\n  <li data-foreach-post='paginator.toArray'>\n    <span data-bind='post.name'><\/span>\n  <\/li>\n<\/ul>\n<button data-event-click='paginator.previousPage'>Prev<\/button>\n<button data-event-click='paginator.nextPage'>    Next<\/button>\n```\n\nIf you want your paginator to update from other properties, wrap it in `@accessor`. For example, to make a new paginator when `postsOrder` changes, you could:\n\n\n```coffeescript\nclass App.PostsController extends Batman.Controller\n  index: ->\n    @set('postsOrder', 'created_at')\n    # renders posts\/index.html\n\n  @accessor 'paginator,\n    new Batman.ModelPaginator\n      model: App.Post\n      limit: 10\n      page: 1\n      params: {order: @get('postsOrder')}\n```\n\nNow, if you set `postsOrder` to `length`, it would cause `paginator` to be reevaluated, and the new paginator would use `order=length` to load records. Also, `paginator.toArray` would be updated with the new records in the new order.\n\n## ::constructor(options) : ModelPaginator\n\nBesides the options passed to `Batman.Paginator`, you may also pass:\n\n- `model`: A `Batman.Model` class whose records are paginated\n- `params` : A plain JS object which will be used when loading items from the server\n\n## ::loadItemsForOffsetAndLimit(offset, limit)\n\nLoads records by calling `@model.load` with:\n\n- any key\/values passed as `@params`\n- `offset` and `limit`\n\n## ::.params : Object\n\nA plain JavaScript object whose key-value pairs will be passed to `@model.load` when loading records.\n\n## ::.model : Class\n\nA `Batman.Model` subclass whose records are paginated by the `ModelPaginator`.\n\n\n","old_contents":"# \/api\/Extras\/Batman.Paginator\n\n`Batman.Paginator` is an abstract class which is implemented by `Batman.ModelPaginator`. For information about paginating records, see `Batman.ModelPaginator`.\n\n\nInternally, `Batman.Paginator` prevents loading the same page twice.\n\n## ::constructor(options={}) : Paginator\n\nReturns a new paginator, mixing in `options`. `options` may include:\n\n- `limit`\n- `offset` or `page`\n- `totalCount`\n\n## ::loadItemsForOffsetAndLimit(offset, limit)\n\nImplementations of `Batman.Paginator` must implement this function. See `Batman.ModelPaginator` for an example.\n\nThis function should load items, then call `@updateCache(offset, limit, items)`.\n\nInternally, `Batman.Paginator`:\n\n- prevents reloading a page when it's still loading\n- prevents loading a page twice\n\n## ::%toArray : Array\n\nReturns an array of items in the current `page`. This property depends on `offset` and `limit`, so changing `offset`, `limit` or `page` will automatically update `toArray`.\n\n## ::nextPage()\n\nIncrements the current `page`, causing `toArray` to be updated.\n\n## ::previousPage()\n\nDecrements the current `page`, causing `toArray` to be updated.\n\n## ::%page : Number\n\nCurrent page number, determined by `offset` and `limit`. Setting `page` automatically increases `offset`.\n\nSince `toArray` depends on `offset`, setting `page` will also cause `toArray` to be updated.\n\n## ::%offset : Number\n\nNumber of items skipped for the current `page`.\n\n## ::%limit : Number\n\nItems per page.\n\n## ::%totalCount : Number\n\nTotal number of records covered by the `Paginator`.\n\n## ::%pageCount : Number\n\nTotal number of pages covered by the `Paginator`, calculated from `totalCount` and `limit`.\n\n## ::updateCache(offset, limit, items)\n\nRegisters `items` as the items from `offset` for `limit`. This should be called by `loadItemsForOffsetAndLimit` to inform the paginator of loaded records.\n\n# \/api\/Extras\/Batman.Paginator\/Batman.ModelPaginator\n\n`Batman.ModelPaginator` is a concrete implementation of `Batman.Paginator`. It may be used for paginating `Batman.Model` instances.\n\nA `Batman.ModelPaginator` provides pagination by:\n\n- Taking `model`, `limit`, `params`, and `page`\/`offset` as input\n- Exposing records by its `toArray` property (eg, `paginator.get('toArray')`)\n\n## Using Batman.ModelPaginator\n\nAdd a paginator to your controller:\n\n```coffee\nclass App.PostsController extends Batman.Controller\n  index: -> # renders posts\/index.html\n    @set 'paginator, new Batman.ModelPaginator\n      model: App.Post\n      limit: 10\n      page: 1\n      params: {order: \"created_at\"}\n```\n\nThen, bind to it in your HTML:\n\n```html\n<ul>\n  <li data-foreach-post='paginator.toArray'>\n    <span data-bind='post.name'><\/span>\n  <\/li>\n<\/ul>\n<button data-event-click='paginator.previousPage'>Prev<\/button>\n<button data-event-click='paginator.nextPage'>    Next<\/button>\n```\n\n\n## ::constructor(options) : ModelPaginator\n\nBesides the options passed to `Batman.Paginator`, you may also pass:\n\n- `model`: A `Batman.Model` class whose records are paginated\n- `params` : A plain JS object which will be used when loading items from the server\n\n## ::loadItemsForOffsetAndLimit(offset, limit)\n\nLoads records by calling `@model.load` with:\n\n- any key\/values passed as `@params`\n- `offset` and `limit`\n\n## ::.params : Object\n\nA plain JavaScript object whose key-value pairs will be passed to `@model.load` when loading records.\n\n## ::.model : Class\n\nA `Batman.Model` subclass whose records are paginated by the `ModelPaginator`.\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4bef435e0e9624006730e93c8135dc4eba678df1","subject":"better docs for source maps","message":"better docs for source maps\n","repos":"angeliaz\/coffeescript,angeliaz\/coffeescript,connec\/coffeescript,TobiaszCudnik\/coffeescript-to-typescript,isaacs\/coffee-script,Infowatch\/coffee-script,GabrielRatener\/coffeescript-next,alubbe\/coffee-script,sidthekidder\/coffee-script,ASnow\/coffeescript,shihang0001\/coffee-script,ambrusc\/coffee-script,coffee-js\/coffee-script,mikeyhew\/coffeescript-await-transform,jjoos\/coffee-script,ls2uper\/coffeescript,behind2\/coffee-script,jjoos\/coffee-script,helixbass\/copheescript,sombr\/coffeescript,akavi\/CoffeeAF,DoriKal\/coffeescript,will-weiss\/coffeescript,jiangmiao\/toffee-script,princejwesley\/coffeescript,DoriKal\/coffeescript,Kingson4Wu\/coffee-script,stanly-johnson\/coffeescript,bobcassels\/pencil-coffee-script,kannannilakantaayyar\/coffeescript,EmielM\/blackcoffee,shreeve\/coffeescript,tempbottle\/coffeescript,hgGeorg\/coffee-script,ASnow\/coffeescript,jobedom\/coffee-script,davidbau\/coffee-script,decaffeinate\/coffeescript,protez\/coffee-script,GabrielRatener\/coffeescript-next,youleiy\/coffee-script,cosmicexplorer\/coffeescript,sjbarag\/coffeescript,xixixao\/coffee-script,princejwesley\/coffeescript,mekuriam\/coffeescript,kidaa\/coffeescript,paiq\/blackcoffee,jamesknelson\/coffee-script,helixbass\/copheescript,EmielM\/blackcoffee,tonghuashuai\/coffee-script,SonOfLilit\/coffeescript,longjl\/coffeescript,guzhaoyuan\/coffee-script,wangyue-ramy\/coffeescript,lydell\/coffee-script,rev22\/reflective-coffeescript,AndersonFirmino\/coffeescript,davidbau\/coffee-script,flaing\/coffeescript,lbeschastny\/coffeescript,jobedom\/coffee-script,tempbottle\/coffeescript,MartyIX\/coffeescript-to-typescript,yjerem\/coffee-script,FrancoCotter\/coffeescript,maowug\/coffeescript,lbeschastny\/coffeescript,sebmck\/coffee-script,will-weiss\/coffeescript,mikeyhew\/coffeescript-await-transform,rev22\/reflective-coffeescript,Infowatch\/coffee-script,jiangmiao\/toffee-script,DylanPiercey\/coffeescript,lieuwex\/coffeescript-to-typescript,292388900\/coffee-script,shimaore\/cake,sombr\/coffeescript,abbshr\/coffeescript,aslihandincer\/coffeescript,guzhaoyuan\/coffee-script,maowug\/coffeescript,helixbass\/copheescript,kannannilakantaayyar\/coffeescript,shimaore\/cake,beni55\/coffee-script,Kingson4Wu\/coffee-script,tonghuashuai\/coffee-script,maxtaco\/coffee-script,ambrusc\/coffee-script,alubbe\/coffee-script,lieuwex\/coffeescript-to-typescript,coffee-js\/coffee-script,wangyue-ramy\/coffeescript,chaosim\/coffee-script,charlieflowers\/coffee-script,stanly-johnson\/coffeescript,kyroskoh\/coffee-script,mrmowgli\/coffeescript,tvanderbruggen\/coffeescript,hgGeorg\/coffee-script,youleiy\/coffee-script,lydell\/coffee-script,casidiablo\/coffeescript,sidthekidder\/coffee-script,longjl\/coffeescript,jiangmiao\/toffee-script,sqlwwx\/coffeescript-zh,helixbass\/copheescript,alxarch\/coffeescript,GabrielRatener\/coffeescript-next,behind2\/coffee-script,ls2uper\/coffeescript,jokerhing\/coffeescript,coffee-void\/coffeescript,jashkenas\/coffeescript,alxarch\/coffeescript,isaacs\/coffee-script,tvanderbruggen\/coffeescript,charlieflowers\/coffee-script,FrancoCotter\/coffeescript,Geoion\/coffee-script,legokichi\/typecoffee,abbshr\/coffeescript,beni55\/coffee-script,Geoion\/coffee-script,kyroskoh\/coffee-script,sqlwwx\/coffeescript-zh,maxtaco\/coffee-script,kittens\/coffee-script,PencilCode\/pencil-coffee-script,AndersonFirmino\/coffeescript,schory\/coffee-script,protez\/coffee-script,chaosim\/coffee-script,pagreczner\/express-coffee,TobiaszCudnik\/coffeescript-to-typescript,mekuriam\/coffeescript,jjoos\/coffee-script,ardha2008\/coffeescript,jokerhing\/coffeescript,kittens\/coffee-script,yjerem\/coffee-script,casidiablo\/coffeescript,DylanPiercey\/coffeescript,jamesknelson\/coffee-script,bobcassels\/pencil-coffee-script,aslihandincer\/coffeescript,coffee-void\/coffeescript,shihang0001\/coffee-script,legokichi\/typecoffee,SonOfLilit\/coffeescript,PencilCode\/pencil-coffee-script,kidaa\/coffeescript,TobiaszCudnik\/coffeescript-to-typescript,sebmck\/coffee-script,292388900\/coffee-script,pagreczner\/express-coffee,connec\/coffeescript,schory\/coffee-script,ardha2008\/coffeescript,MartyIX\/coffeescript-to-typescript","old_file":"src\/sourcemap.litcoffee","new_file":"src\/sourcemap.litcoffee","new_contents":"Source maps allow JavaScript runtimes to match running JavaScript back to\nthe original source code that corresponds to it. This can be minified\nJavaScript, but in our case, we're concerned with mapping pretty-printed\nJavaScript back to CoffeeScript.\n\nIn order to produce maps, we must keep track of positions (line number, column number)\nthat originated every node in the syntax tree, and be able to generate a\n[map file](https:\/\/docs.google.com\/document\/d\/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k\/edit)\n\u2014 which is a compact, VLQ-encoded representation of the JSON serialization\nof this information \u2014 to write out alongside the generated JavaScript.\n\n\nLineMap\n-------\n\nA **LineMap** object keeps track of information about original line and column\npositions for a single line of output JavaScript code.\n**SourceMaps** are implemented in terms of **LineMaps**.\n\n    class LineMap\n      constructor: (@line) ->\n        @columns = []\n\n      add: (column, [sourceLine, sourceColumn], options={}) ->\n        return if @columns[column] and options.noReplace\n        @columns[column] = {line: @line, column, sourceLine, sourceColumn}\n\n      sourceLocation: (column) ->\n        column-- until (mapping = @columns[column]) or (column <= 0)\n        mapping and [mapping.sourceLine, mapping.sourceColumn]\n\n\nSourceMap\n---------\n\nMaps locations in a single generated JavaScript file back to locations in\nthe original CoffeeScript source file.\n\nThis is intentionally agnostic towards how a source map might be represented on\ndisk. Once the compiler is ready to produce a \"v3\"-style source map, we can walk\nthrough the arrays of line and column buffer to produce it.\n\n    class SourceMap\n      constructor: ->\n        @lines = []\n\nAdds a mapping to this SourceMap. `sourceLocation` and `generatedLocation`\nare both `[line, column]` arrays. If `options.noReplace` is true, then if there\nis already a mapping for the specified `line` and `column`, this will have no\neffect.\n\n      add: (sourceLocation, generatedLocation, options = {}) ->\n        [line, column] = generatedLocation\n        lineMap = (@lines[line] or= new LineMap(line))\n        lineMap.add column, sourceLocation, options\n\nLook up the original position of a given `line` and `column` in the generated\ncode.\n\n      sourceLocation: ([line, column]) ->\n        line-- until (lineMap = @lines[line]) or (line <= 0)\n        lineMap and lineMap.sourceLocation column\n\n\nV3 SourceMap Generation\n-----------------------\n\nBuilds up a V3 source map, returning the generated JSON as a string.\n`options.sourceRoot` may be used to specify the sourceRoot written to the source\nmap.  Also, `options.sourceFiles` and `options.generatedFile` may be passed to\nset \"sources\" and \"file\", respectively.\n\n      generate: (options = {}, code = null) ->\n        writingline       = 0\n        lastColumn        = 0\n        lastSourceLine    = 0\n        lastSourceColumn  = 0\n        needComma         = no\n        buffer            = \"\"\n\n        for lineMap, lineNumber in @lines when lineMap\n          for mapping in lineMap.columns when mapping\n            while writingline < mapping.line\n              lastColumn = 0\n              needComma = no\n              buffer += \";\"\n              writingline++\n\nWrite a comma if we've already written a segment on this line.\n\n            if needComma\n              buffer += \",\"\n              needComma = no\n\nWrite the next segment. Segments can be 1, 4, or 5 values.  If just one, then it\nis a generated column which doesn't match anything in the source code.\n\nThe starting column in the generated source, relative to any previous recorded\ncolumn for the current line:\n\n            buffer += @encodeVlq mapping.column - lastColumn\n            lastColumn = mapping.column\n\nThe index into the list of sources:\n\n            buffer += @encodeVlq 0\n\nThe starting line in the original source, relative to the previous source line.\n\n            buffer += @encodeVlq mapping.sourceLine - lastSourceLine\n            if lastSourceLine isnt mapping.sourceLine\n              lastSourceLine = mapping.sourceLine\n              lastSourceColumn = 0\n\nThe starting column in the original source, relative to the previous column.\n\n            buffer += @encodeVlq mapping.sourceColumn - lastSourceColumn\n            lastSourceColumn = mapping.sourceColumn\n            needComma = yes\n\nProduce the canonical JSON object format for a \"v3\" source map.\n\n        v3 =\n          version:    3\n          file:       options.generatedFile or ''\n          sourceRoot: options.sourceRoot or ''\n          sources:    options.sourceFiles or ['']\n          names:      []\n          mappings:   buffer\n\n        v3.sourcesContent = [code] if options.inline\n\n        JSON.stringify v3, null, 2\n\n\nBase64 VLQ Encoding\n-------------------\n\nNote that SourceMap VLQ encoding is \"backwards\".  MIDI-style VLQ encoding puts\nthe most-significant-bit (MSB) from the original value into the MSB of the VLQ\nencoded value (see [Wikipedia](http:\/\/en.wikipedia.org\/wiki\/File:Uintvar_coding.svg)).\nSourceMap VLQ does things the other way around, with the least significat four\nbits of the original value encoded into the first byte of the VLQ encoded value.\n\n      VLQ_SHIFT            = 5\n      VLQ_CONTINUATION_BIT = 1 << VLQ_SHIFT             # 0010 0000\n      VLQ_VALUE_MASK       = VLQ_CONTINUATION_BIT - 1   # 0001 1111\n\n      encodeVlq: (value) ->\n        answer = ''\n\n        # Least significant bit represents the sign.\n        signBit = if value < 0 then 1 else 0\n\n        # The next bits are the actual value.\n        valueToEncode = (Math.abs(value) << 1) + signBit\n\n        # Make sure we encode at least one character, even if valueToEncode is 0.\n        while valueToEncode or not answer\n          nextChunk = valueToEncode & VLQ_VALUE_MASK\n          valueToEncode = valueToEncode >> VLQ_SHIFT\n          nextChunk |= VLQ_CONTINUATION_BIT if valueToEncode\n          answer += @encodeBase64 nextChunk\n\n        answer\n\n\nRegular Base64 Encoding\n-----------------------\n\n      BASE64_CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+\/'\n\n      encodeBase64: (value) ->\n        BASE64_CHARS[value] or throw new Error \"Cannot Base64 encode value: #{value}\"\n\n\nOur API for source maps is just the `SourceMap` class.\n\n    module.exports = SourceMap\n\n\n\n","old_contents":"Source maps allow JavaScript runtimes to match running JavaScript back to\nthe original source code that corresponds to it. This can be minified\nJavaScript, but in our case, we're concerned with mapping pretty-printed\nJavaScript back to CoffeeScript.\n\nIn order to produce maps, we must keep track of positions (line number, column number)\nthat originated every node in the syntax tree, and be able to generate a\n[map file](https:\/\/docs.google.com\/document\/d\/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k\/edit)\n\u2014 which is a compact, VLQ-encoded representation of the JSON serialization\nof this information \u2014 to write out alongside the generated JavaScript.\n\n\nLineMap\n-------\n\nA **LineMap** object keeps track of information about original line and column\npositions for a single line of output JavaScript code.\n**SourceMaps** are implemented in terms of **LineMaps**.\n\n    class LineMap\n      constructor: (@line) ->\n        @columns = []\n\n      add: (column, [sourceLine, sourceColumn], options={}) ->\n        return if @columns[column] and options.noReplace\n        @columns[column] = {line: @line, column, sourceLine, sourceColumn}\n\n      sourceLocation: (column) ->\n        column-- until (mapping = @columns[column]) or (column <= 0)\n        mapping and [mapping.sourceLine, mapping.sourceColumn]\n\n\nSourceMap\n---------\n\nMaps locations in for a single generated JavaScript file back to locations in\nthe original CoffeeScript source file.\n\nThis is intentionally agnostic towards how a source map might be represented on\ndisk. Once the compiler is ready to produce a \"v3\"-style source map, we can walk\nthrough the arrays of line and column buffer to produce it.\n\n    class SourceMap\n      constructor: ->\n        @lines = []\n\nAdds a mapping to this SourceMap. `sourceLocation` and `generatedLocation`\nare both `[line, column]` arrays. If `options.noReplace` is true, then if there\nis already a mapping for the specified `line` and `column`, this will have no\neffect.\n\n      add: (sourceLocation, generatedLocation, options = {}) ->\n        [line, column] = generatedLocation\n        lineMap = (@lines[line] or= new LineMap(line))\n        lineMap.add column, sourceLocation, options\n\nLook up the original position of a given `line` and `column` in the generated\ncode.\n\n      sourceLocation: ([line, column]) ->\n        line-- until (lineMap = @lines[line]) or (line <= 0)\n        lineMap and lineMap.sourceLocation column\n\n\nV3 SourceMap Generation\n-----------------------\n\nBuilds up a V3 source map, returning the generated JSON as a string.\n`options.sourceRoot` may be used to specify the sourceRoot written to the source\nmap.  Also, `options.sourceFiles` and `options.generatedFile` may be passed to\nset \"sources\" and \"file\", respectively.\n\n      generate: (options = {}, code = null) ->\n        writingline       = 0\n        lastColumn        = 0\n        lastSourceLine    = 0\n        lastSourceColumn  = 0\n        needComma         = no\n        buffer            = \"\"\n\n        for lineMap, lineNumber in @lines when lineMap\n          for mapping in lineMap.columns when mapping\n            while writingline < mapping.line\n              lastColumn = 0\n              needComma = no\n              buffer += \";\"\n              writingline++\n\nWrite a comma if we've already written a segment on this line.\n\n            if needComma\n              buffer += \",\"\n              needComma = no\n\nWrite the next segment. Segments can be 1, 4, or 5 values.  If just one, then it\nis a generated column which doesn't match anything in the source code.\n\nThe starting column in the generated source, relative to any previous recorded\ncolumn for the current line:\n\n            buffer += @encodeVlq mapping.column - lastColumn\n            lastColumn = mapping.column\n\nThe index into the list of sources:\n\n            buffer += @encodeVlq 0\n\nThe starting line in the original source, relative to the previous source line.\n\n            buffer += @encodeVlq mapping.sourceLine - lastSourceLine\n            if lastSourceLine isnt mapping.sourceLine\n              lastSourceLine = mapping.sourceLine\n              lastSourceColumn = 0\n\nThe starting column in the original source, relative to the previous column.\n\n            buffer += @encodeVlq mapping.sourceColumn - lastSourceColumn\n            lastSourceColumn = mapping.sourceColumn\n            needComma = yes\n\nProduce the canonical JSON object format for a \"v3\" source map.\n\n        v3 =\n          version:    3\n          file:       options.generatedFile or ''\n          sourceRoot: options.sourceRoot or ''\n          sources:    options.sourceFiles or ['']\n          names:      []\n          mappings:   buffer\n\n        v3.sourcesContent = [code] if options.inline\n\n        JSON.stringify v3, null, 2\n\n\nBase64 VLQ Encoding\n-------------------\n\nNote that SourceMap VLQ encoding is \"backwards\".  MIDI-style VLQ encoding puts\nthe most-significant-bit (MSB) from the original value into the MSB of the VLQ\nencoded value (see [Wikipedia](http:\/\/en.wikipedia.org\/wiki\/File:Uintvar_coding.svg)).\nSourceMap VLQ does things the other way around, with the least significat four\nbits of the original value encoded into the first byte of the VLQ encoded value.\n\n      VLQ_SHIFT            = 5\n      VLQ_CONTINUATION_BIT = 1 << VLQ_SHIFT             # 0010 0000\n      VLQ_VALUE_MASK       = VLQ_CONTINUATION_BIT - 1   # 0001 1111\n\n      encodeVlq: (value) ->\n        answer = ''\n\n        # Least significant bit represents the sign.\n        signBit = if value < 0 then 1 else 0\n\n        # The next bits are the actual value.\n        valueToEncode = (Math.abs(value) << 1) + signBit\n\n        # Make sure we encode at least one character, even if valueToEncode is 0.\n        while valueToEncode or not answer\n          nextChunk = valueToEncode & VLQ_VALUE_MASK\n          valueToEncode = valueToEncode >> VLQ_SHIFT\n          nextChunk |= VLQ_CONTINUATION_BIT if valueToEncode\n          answer += @encodeBase64 nextChunk\n\n        answer\n\n\nRegular Base64 Encoding\n-----------------------\n\n      BASE64_CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+\/'\n\n      encodeBase64: (value) ->\n        BASE64_CHARS[value] or throw new Error \"Cannot Base64 encode value: #{value}\"\n\n\nOur API for source maps is just the `SourceMap` class.\n\n    module.exports = SourceMap\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"23540bb96e322d6d8db8fd887d3440631735a45f","subject":"keypress event for textarea","message":"keypress event for textarea\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-form\/client\/widget\/textarea.litcoffee","new_file":"packages\/shrub-form\/client\/widget\/textarea.litcoffee","new_contents":"# Form - Text\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularDirective`.\n\n      registrar.registerHook 'shrubAngularDirective', -> [\n        ->\n\n          scope: field: '=', form: '='\n\n          link: (scope) ->\n\n            scope.$watch 'field', (field) ->\n\n              field.minLength ?= 0\n              field.maxLength ?= Infinity\n              field.pattern ?= \/.*\/\n              field.model ?= 'field.value'\n\n              field.syncModel scope\n\n          template: '''\n\n    <label\n      data-ng-if=\"!!field.label\"\n      data-ng-bind=\"field.label\"\n    ><\/label>\n\n    <textarea\n      class=\"form-control\"\n      name=\"{{field.name}}\"\n      type=\"{{field.type}}\"\n\n      data-shrub-ui-attributes=\"field.attributes\"\n      data-ng-keypress=\"field.keyPress($event)\"\n      data-ng-model=\"field.value\"\n      data-ng-required=\"field.required\"\n      data-ng-minlength=\"{{field.minlength}}\"\n      data-ng-maxlength=\"{{field.maxlength}}\"\n      data-ng-pattern=\"field.pattern\"\n      data-ng-trim=\"{{field.trim}}\"\n    ><\/textarea>\n\n    '''\n\n      ]\n\n      assignToElement = (element, value) -> element.val value\n\n#### Implements hook `shrubFormWidgets`.\n\n      registrar.registerHook 'shrubFormWidgets', ->\n\n        widgets = []\n\n        widgets.push\n\n          type: 'textarea'\n          assignToElement: assignToElement\n          directive: 'shrub-form-widget-textarea'\n\n        widgets\n","old_contents":"# Form - Text\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularDirective`.\n\n      registrar.registerHook 'shrubAngularDirective', -> [\n        ->\n\n          scope: field: '=', form: '='\n\n          link: (scope) ->\n\n            scope.$watch 'field', (field) ->\n\n              field.minLength ?= 0\n              field.maxLength ?= Infinity\n              field.pattern ?= \/.*\/\n              field.model ?= 'field.value'\n\n              field.syncModel scope\n\n          template: '''\n\n    <label\n      data-ng-if=\"!!field.label\"\n      data-ng-bind=\"field.label\"\n    ><\/label>\n\n    <textarea\n      class=\"form-control\"\n      name=\"{{field.name}}\"\n      type=\"{{field.type}}\"\n\n      data-shrub-ui-attributes=\"field.attributes\"\n      data-ng-model=\"field.value\"\n      data-ng-required=\"field.required\"\n      data-ng-minlength=\"{{field.minlength}}\"\n      data-ng-maxlength=\"{{field.maxlength}}\"\n      data-ng-pattern=\"field.pattern\"\n      data-ng-trim=\"{{field.trim}}\"\n    ><\/textarea>\n\n    '''\n\n      ]\n\n      assignToElement = (element, value) -> element.val value\n\n#### Implements hook `shrubFormWidgets`.\n\n      registrar.registerHook 'shrubFormWidgets', ->\n\n        widgets = []\n\n        widgets.push\n\n          type: 'textarea'\n          assignToElement: assignToElement\n          directive: 'shrub-form-widget-textarea'\n\n        widgets\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0016e3cb2ad98072ebb4a5521c4844bb056b3a6a","subject":"style, content, Batman --> batman.js","message":"style, content, Batman --> batman.js\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/11_associations.litcoffee","new_file":"docs\/11_associations.litcoffee","new_contents":"# Batman.Model Associations\nbatman.js associations are modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). There are 3 types of assocations available on `Batman.Model`: [`hasMany`](\/docs\/api\/batman.model_associations.html#class_function_hasmany), [`belongsTo`](\/docs\/api\/batman.model_associations.html#class_function_belongsto), and [`hasOne`](\/docs\/api\/batman.model_associations.html#class_function_hasone). batman.js also supports polymorphic associations through the use of [polymorphic-specific options](\/docs\/api\/batman.model_associations.html#polymorphic_association_options).\n\nTo add associations to your models, declare them in your model definition. Association functions take a label (string) and options (Object). The label names the association and is used to provide smart defaults for several options. All available options are [detailed below](\/docs\/api\/batman.model_associations.html#association_options).\n\nFor example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', inverseOf: 'parentItem', encoderKey: 'children'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItem'\n```\n\nThen, associated records will be available via accessors:\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n\n  child.set('parentItem', parent)\n  child.get('parentItem') # => parent\n```\n\nor,\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n  secondChild = new App.ChildItem\n  parent.get('childItems').add(child)\n  parent.get('childItems').add(secondChild)\n  parent.get('childItems') # => Batman.AssociationSet\n  parent.get('childItems.length') # => 2\n```\n\n## @hasMany(label : string [, options : Object])\n`hasMany` expresses a one-to-many relationship on a `Batman.Model`.\n\n## @hasOne(label : string [, options : Object])\n`hasOne` expresses a one-to-one relationship on a `Batman.Model` when this model contains the primary key (eg, `id`) and does not contain the foreign key. If this model contains the foreign key, use `belongsTo` instead.\n\n## @belongsTo(label : string [, options : Object])\n`belongsTo` expresses a one-to-one relationship on a `Batman.Model` when this model contains the foreign key (eg, `parent_id`). If the other model contains the foreign key, use `hasOne` instead. It often expresses inverse of a `hasMany` or `hasOne` association. You can declare this with the `inverseOf` option (see [options](\/docs\/api\/batman.model_associations.html#association_options) below) so that both sides of the association are loaded from JSON.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.AssociationSet` or `Batman.Model`. Generally they will return a `Batman.AssocationProxy` named after the association type, such as `Batman.BelongsToAssociationProxy` or `Batman.HasOneAssociationProxy`.\n\n\n## ::load(callback : Function)\nCalled to load the associated record from storage, setting it as  [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target). If a callback is passed, it is called with two arguments: any error and the loaded record. Also, when this function finishes, it sets [`loaded`](\/docs\/api\/batman.model_associations.html#prototype_accessor_loaded) to `true` and fires `loaded` on the record.\n\n## ::toJSON() : Object\nReturns a [stringifiable JavaScript object](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/JSON\/stringify#toJSON_behavior) for the target record, if the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) is present.\n\n## ::%target\nThe associated record. Getting `target` does not implicitly call `load` on the association.\n\n## ::%loaded\n`true` or `false`, whether or not the record has been loaded from storage.\n\n## ::fetchFromLocal()\nThis method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). If this method returns a falsy value, then [`fetchFromRemote`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromremote) is called.  `Batman.AssocationProxy` subclasses must implement this method.\n\n## ::fetchFromRemote([callback : Function])\nIf [`fetchFromLocal`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromlocal) returns a falsy value, this method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). The `callback` is called with two arguments: any error and the fetched record(s). `Batman.AssocationProxy` subclasses must implement this method.\n\n## Association Options\n\n##### `primaryKey[= \"id\"] : string`\nThe primary key for the association.\n\n##### `foreignKey[= \"#{label}_id\"] : string`\nThe foreign key for the association.\n\n##### `saveInline[= true] : boolean`\nIf true, this model's attributes will be included in the associated model's JSON. This means that when an associated record is saved, this record's attributes will be included in the JSON.  (An alternative might be to include the associations' primary keys in the model's JSON with an [encoder](\/docs\/api\/batman.model.html#class_function_encode).)\n\n##### `autoload[= true] : boolean`\nIf `true`, batman.js will automatically call `load` when the associated records are accessed. This is useful in view bindings, where binding to the associated records will automatically cause them to be loaded.\n\n##### `nestUrl[= false] : boolean`\nIf `true`, this model's URL will be nested under the associated model:\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', nestUrl: true\n\n# ...\n\nchild = new ChildItem(parent_id: 1, id: 5)\nchild.url() # => 'parent_items\/1\/child_items\/5'\n```\n\n`nestUrl` only applies if the model is persisted with `Batman.RestStorage` (or a subclass).\n\n##### `name : string`\nBy default, batman.js checks for a model with the singular, camel-case name of association's `label` attached to `Batman.currentApp`. If the associated model's name is different from that, use `name` to specify it.\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem' # automatically finds App.ParentItem\n  @belongsTo 'alternativeParentItem', name: 'ParentItem' # also finds App.ParentItem\n```\n\n##### `inverseOf : string`\nThe foreign association to set on load. If the associated model has an association with the same name as the `inverseOf` value, it will be populated when data is loaded from storage. For example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true, inverseOf: 'parentItem'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItems'\n```\n\nwould allow:\n\n```coffeescript\nApp.ParentItem.find 1, (err, parent) ->\n  children = parent.get('childItems')\n  children.get('first.parentItem') == parent # => true\n\nApp.ChildItem.find 5, (err, childItem) ->\n  childItem.get('parentItem').load (err, parent) ->\n    parent.get('childItems').has(childItem) # => true\n```\n\n##### `encoderKey[= label] : string`\nKey that represents this association's records when in serialized form. For example,\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', encoderKey: 'children'\n```\n\nwill correctly decode this JSON:\n\n```javascript\n{id: 1, children: [{ id: 5, parent_id: 1 }, {id: 6, parent_id: 1}]}\n```\n\nIt will also encode the `childItems` as `children` (unless `saveInline` is set to `false`).\n\n##### `namespace[= Batman.currentApp] : string`\nbatman.js expects to find a model with the given `name` on `Batman.currentApp`. If your model is defined elsewhere, use `namespace` to specify where the model is defined.\n\n```coffeescript\nclass App.Admin.Person extends Batman.Model\n  @belongsTo 'organization', namespace: App.Admin # finds App.Admin.Organization instead of App.Organization\n```\n\n## Polymorphic Association Options\nbatman.js also supports [polymorphic associations](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations). For example:\n\n```coffeescript\nclass App.Superpower extends Batman.Model\n  @encode 'name'\n  @belongsTo 'superpowerable', polymorphic: true\n\nclass App.Hero extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n\nclass App.Villain extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n```\nBy default, attributes of the polymorphic association will be encoded according to the label. So, `hero.toJSON()` might return:\n\n```javascript\n{ id: 1,\n  name: 'Superman',\n  superpowers: [\n    {id: 15, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Super Strength'},\n    {id: 16, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Invincibility'},\n  ]\n}\n```\n\n##### `polymorphic[= false] : boolean`\nSet to `true` when the association is [polymorphic](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations).\n\n##### `as : string`\nSpecifies the name of the polymorphic interface.\n\n##### `foreignTypeKey[= \"#{label}_type\"] : string`\nSpecifies the field which contains the `type` for a polymorphic record.\n\n##### `encodeForeignTypeKey[=true] : boolean`\nSet to `true` when the `foreignTypeKey` should be included in the JSON of the record.\n","old_contents":"# Batman.Model Associations\nBatman associations are modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). There are 3 types of assocations available on `Batman.Model`: [`hasMany`](\/docs\/api\/batman.model_associations.html#class_function_hasmany), [`belongsTo`](\/docs\/api\/batman.model_associations.html#class_function_belongsto), and [`hasOne`](\/docs\/api\/batman.model_associations.html#class_function_hasone). Batman also supports polymorphic associations through the use of [polymorphic-specific options](\/docs\/api\/batman.model_associations.html#polymorphic_association_options).\n\nTo add associations to your models, declare them in your model definition. Association functions take a label (string) and options (Object). The label names the association and is used to provide smart defaults for several options. All available options are [detailed below](\/docs\/api\/batman.model_associations.html#association_options).\n\nFor example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', inverseOf: 'parentItem', encoderKey: 'children'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItem'\n```\n\nThen, associated records will be available via accessors:\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n\n  child.set('parentItem', parent)\n  child.get('parentItem') # => parent\n```\n\nor,\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n  secondChild = new App.ChildItem\n  parent.get('childItems').add(child)\n  parent.get('childItems').add(secondChild)\n  parent.get('childItems') # => Batman.AssociationSet\n  parent.get('childItems.length') # => 2\n```\n\n## @hasMany(label : string [, options : Object])\n`hasMany` expresses a one-to-many relationship on a `Batman.Model`.\n\n## @hasOne(label : string [, options : Object])\n`hasOne` expresses a one-to-one relationship on a `Batman.Model` when this model contains the primary key (eg, `id`) and does not contain the foreign key. If this model contains the foreign key, use `belongsTo` instead.\n\n## @belongsTo(label : string [, options : Object])\n`belongsTo` expresses a one-to-one relationship on a `Batman.Model` when this model contains the foreign key (eg, `parent_id`). If the other model contains the foreign key, use `hasOne` instead.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.AssociationSet` or `Batman.Model`. Generally they will return a `Batman.AssocationProxy` named after the association type, such as `Batman.BelongsToAssociationProxy` or `Batman.HasOneAssociationProxy`.\n\n\n## ::load(callback : Function)\nCalled to load the associated record from storage, setting it as  [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target). If a callback is passed, it is called with two arguments: any error and the loaded record. Also, when this function finishes, it sets [`loaded`](\/docs\/api\/batman.model_associations.html#prototype_accessor_loaded) to `true` and fires `loaded` on the record.\n\n## ::toJSON() : Object\nReturns JSON for the target record, if the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) is present.\n\n## ::%target\nThe associated record. Getting `target` does not implicitly call `load` on the association.\n\n## ::%loaded\n`true` or `false`, whether or not the record has been loaded from storage.\n\n## ::fetchFromLocal()\nThis method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). If this method returns a falsy value, then [`fetchFromRemote`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromremote) is called.  `Batman.AssocationProxy` subclasses must implement this method.\n\n## ::fetchFromRemote([callback : Function])\nIf [`fetchFromLocal`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromlocal) returns a falsy value, this method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). The `callback` is called with two arguments: any error and the fetched record(s). `Batman.AssocationProxy` subclasses must implement this method.\n\n## Association Options\n\n##### `primaryKey[= \"id\"] : string`\nThe primary key for the association.\n\n##### `foreignKey[= \"#{label}_id\"] : string`\nThe foreign key for the association.\n\n##### `saveInline[= true] : boolean`\nIf true, this model's attributes will be included in the associated model's JSON. This means that when an associated record is saved, this record's attributes will be included in the JSON.\n\n##### `autoload[= true] : boolean`\nIf `true`, Batman will automatically call `load` when the associated records are accessed. This is useful in view bindings, where binding to the associated records will automatically cause them to be loaded.\n\n##### `nestUrl[= false] : boolean`\nIf `true`, this model's URL will be nested under the associated model:\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', nestUrl: true\n\n# ...\n\nchild = new ChildItem(parent_id: 1, id: 5)\nchild.url() # => 'parent_items\/1\/child_items\/5'\n```\n\n`nestUrl` only applies if the model is persisted with `Batman.RestStorage` (or a subclass).\n\n##### `name : string`\nBy default, Batman checks for a model with the singular, camel-case name of association's `label` attached to `Batman.currentApp`. If the associated model's name is different from that, use `name` to specify it.\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem' # automatically finds App.ParentItem\n  @belongsTo 'alternativeParentItem', name: 'ParentItem' # also finds App.ParentItem\n```\n\n##### `inverseOf : string`\nThe foreign association to set on load. If the associated model has an association with the same name as the `inverseOf` value, it will be populated when data is loaded from storage. For example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true, inverseOf: 'parentItem'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItems'\n```\n\nwould allow:\n\n```coffeescript\nApp.ParentItem.find 1, (err, parent) ->\n  children = parent.get('childItems')\n  children.get('first.parentItem') == parent # => true\n\nApp.ChildItem.find 5, (err, childItem) ->\n  childItem.get('parentItem').load (err, parent) ->\n    parent.get('childItems').has(childItem) # => true\n```\n\n##### `encoderKey[= label] : string`\nKey where attributes for associated records will be found.\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', encoderKey: 'children'\n```\n\nwill correctly decode this JSON:\n\n```javascript\n{id: 1, children: [{ id: 5, parent_id: 1 }, {id: 6, parent_id: 1}]}\n```\n\nIt will also encode the `childItems` as `children` (unless `saveInline` is set to `false`).\n\n##### `namespace[= Batman.currentApp] : string`\nBatman expects to find a model with the given `name` on `Batman.currentApp`. If your model is defined elsewhere, use `namespace` to specify where the model is defined.\n\n```coffeescript\nclass App.Admin.Person extends Batman.Model\n  @belongsTo 'organization', namespace: App.Admin # finds App.Admin.Organization instead of App.Organization\n```\n\n## Polymorphic Association Options\nBatman also supports [polymorphic associations](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations). For example:\n\n```coffeescript\nclass App.Superpower extends Batman.Model\n  @encode 'name'\n  @belongsTo 'superpowerable', polymorphic: true\n\nclass App.Hero extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n\nclass App.Villain extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n```\nBy default, attributes of the polymorphic association will be encoded according to the label. So, `hero.toJSON()` might return:\n\n```javascript\n{ id: 1,\n  name: 'Superman',\n  superpowers: [\n    {id: 15, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Super Strength'},\n    {id: 16, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Invincibility'},\n  ]\n}\n```\n\n##### `polymorphic[= false] : boolean`\nWhether the association is [polymorphic](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations).\n\n##### `as : string`\nSpecifies the name of the polymorphic interface.\n\n##### `foreignTypeKey[= \"#{label}_type\"] : string`\nSpecifies the field which contains the `type` for a polymorphic record.\n\n##### `encodeForeignTypeKey[=true] : boolean`\nSpecifies whether the `foreignTypeKey` should be included in the JSON of the record.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"001766e18deb8d22a4ad5081263974146ee687e9","subject":"clean up","message":"clean up\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/11_associations.litcoffee","new_file":"docs\/11_associations.litcoffee","new_contents":"# Batman.Model Associations\n\nThere are 3 types of assocations available on `Batman.Model`: [`hasMany`](\/docs\/api\/batman.model_associations.html#class_function_hasmany), [`belongsTo`](\/docs\/api\/batman.model_associations.html#class_function_belongsto), and [`hasOne`](\/docs\/api\/batman.model_associations.html#class_function_hasone). They're modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). Batman also supports polymorphic associations through the use of [polymorphic-specific options](\/docs\/api\/batman.model_associations.html#polymorphic_association_options).\n\nTo add associations to your models, declare them in your model definition. Association functions take a label (string) and options (Object). The label names the association and is used to provide smart defaults for several options. All available options are [detailed below](\/docs\/api\/batman.model_associations.html#association_options).\n\nFor example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', inverseOf: 'parentItem', encoderKey: 'children'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItem'\n```\n\nThen, associated records will be available via accessors:\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n\n  child.set('parentItem', parent)\n  child.get('parentItem') # => parent\n```\n\nor,\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n  secondChild = new App.ChildItem\n  parent.get('childItems').add(child)\n  parent.get('childItems').add(secondChild)\n  parent.get('childItems') # => Batman.AssociationSet\n  parent.get('childItems.length') # => 2\n```\n\n## @hasMany(label : string [, options : Object])\n`hasMany` expresses a one-to-many relationship on a `Batman.Model`.\n\n## @hasOne(label : string [, options : Object])\n`hasOne` expresses a one-to-one relationship on a `Batman.Model` when this model contains the primary key (eg, `id`) and does not contain the foreign key. If this model contains the foreign key, use `belongsTo` instead.\n\n## @belongsTo(label : string [, options : Object])\n`belongsTo` expresses a one-to-one relationship on a `Batman.Model` when this model contains the foreign key (eg, `parent_id`). If the other model contains the foreign key, use `hasOne` instead.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.AssociationSet` or `Batman.Model`. Generally they will return a `Batman.AssocationProxy` named after the association type, such as `Batman.BelongsToAssociationProxy` or `Batman.HasOneAssociationProxy`.\n\n\n## ::load(callback : Function)\nCalled to load the associated record from storage, setting it as  [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target). If a callback is passed, it is called with two arguments: any error and the loaded record. Also, when this function finishes, it sets [`loaded`](\/docs\/api\/batman.model_associations.html#prototype_accessor_loaded) to `true` and fires `loaded` on the record.\n\n## ::toJSON() : Object\nReturns JSON for the target record, if the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) is present.\n\n## ::%target\nThe associated record. Getting `target` does not implicitly call `load` on the association.\n\n## ::%loaded\n`true` or `false`, whether or not the record has been loaded from storage.\n\n## ::fetchFromLocal()\nThis method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). If this method returns a falsy value, then [`fetchFromRemote`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromremote) is called.  `Batman.AssocationProxy` subclasses must implement this method.\n\n## ::fetchFromRemote([callback : Function])\nIf [`fetchFromLocal`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromlocal) returns a falsy value, this method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). The `callback` is called with two arguments: any error and the fetched record(s). `Batman.AssocationProxy` subclasses must implement this method.\n\n## Association Options\n\n##### `primaryKey[= \"id\"] : string`\nThe primary key for the association.\n\n##### `foreignKey[= \"#{label}_id\"] : string`\nThe foreign key for the association.\n\n##### `saveInline[= true] : boolean`\nIf true, this model's attributes will be included in the associated model's JSON. This means that when an associated record is saved, this record's attributes will be included in the JSON.\n\n##### `autoload[= true] : boolean`\nIf `true`, Batman will automatically call `load` when the associated records are accessed. This is useful in view bindings, where binding to the associated records will automatically cause them to be loaded.\n\n##### `nestUrl[= false] : boolean`\nIf `true`, this model's URL will be nested under the associated model:\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', nestUrl: true\n\n# ...\n\nchild = new ChildItem(parent_id: 1, id: 5)\nchild.url() # => 'parent_items\/1\/child_items\/5'\n```\n\n`nestUrl` only applies if the model is persisted with `Batman.RestStorage` (or a subclass).\n\n##### `name : string`\nBy default, Batman checks for a model with the singular, camel-case name of association's `label` attached to `Batman.currentApp`. If the associated model's name is different from that, use `name` to specify it.\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem' # automatically finds App.ParentItem\n  @belongsTo 'alternativeParentItem', name: 'ParentItem' # also finds App.ParentItem\n```\n\n##### `inverseOf : string`\nThe foreign association to set on load. If the associated model has an association with the same name as the `inverseOf` value, it will be populated when data is loaded from storage. For example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true, inverseOf: 'parentItem'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItems'\n```\n\nwould allow:\n\n```coffeescript\nApp.ParentItem.find 1, (err, parent) ->\n  children = parent.get('childItems')\n  children.get('first.parentItem') == parent # => true\n\nApp.ChildItem.find 5, (err, childItem) ->\n  childItem.get('parentItem').load (err, parent) ->\n    parent.get('childItems').has(childItem) # => true\n```\n\n##### `encoderKey[= label] : string`\nKey where attributes for associated records will be found.\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', encoderKey: 'children'\n```\n\nwill correctly decode this JSON:\n\n```javascript\n{id: 1, children: [{ id: 5, parent_id: 1 }, {id: 6, parent_id: 1}]}\n```\n\nIt will also encode the `childItems` as `children` (unless `saveInline` is set to `false`).\n\n##### `namespace[= Batman.currentApp] : string`\nBatman expects to find a model with the given `name` on `Batman.currentApp`. If your model is defined elsewhere, use `namespace` to specify where the model is defined.\n\n```coffeescript\nclass App.Admin.Person extends Batman.Model\n  @belongsTo 'organization', namespace: App.Admin # finds App.Admin.Organization instead of App.Organization\n```\n\n## Polymorphic Association Options\nBatman also supports [polymorphic associations](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations). For example:\n\n```coffeescript\nclass App.Superpower extends Batman.Model\n  @encode 'name'\n  @belongsTo 'superpowerable', polymorphic: true\n\nclass App.Hero extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n\nclass App.Villain extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n```\nBy default, attributes of the polymorphic association will be encoded according to the label. So, `hero.toJSON()` might return:\n\n```javascript\n{ id: 1,\n  name: 'Superman',\n  superpowers: [\n    {id: 15, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Super Strength'},\n    {id: 16, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Invincibility'},\n  ]\n}\n```\n\n##### `polymorphic[= false] : boolean`\nWhether the association is [polymorphic](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations).\n\n##### `as : string`\nSpecifies the name of the polymorphic interface.\n\n##### `foreignTypeKey[= \"#{label}_type\"] : string`\nSpecifies the field which contains the `type` for a polymorphic record.\n\n##### `encodeForeignTypeKey[=true] : boolean`\nSpecifies whether the `foreignTypeKey` should be included in the JSON of the record.\n","old_contents":"# Batman.Model Associations\n\nThere are 3 types of assocations available on `Batman.Model`: [`hasMany`](\/docs\/api\/batman.model_associations.html#class_function_hasmany), [`belongsTo`](\/docs\/api\/batman.model_associations.html#class_function_belongsto), and [`hasOne`](\/docs\/api\/batman.model_associations.html#class_function_hasone). They're modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). Batman also supports polymorphic associations through the use of [polymorphic-specific options](\/docs\/api\/batman.model_associations.html#polymorphic_association_options).\n\nTo add associations to your models, declare them in your model definition. Association functions take a label (string) and options (Object). The label names the association and is used to provide smart defaults for several options. All available options are [detailed below](\/docs\/api\/batman.model_associations.html#association_options).\n\nFor example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', inverseOf: 'parentItem', encoderKey: 'children'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItem'\n```\n\nThen, associated records will be available via accessors:\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n\n  child.set('parentItem', parent)\n  child.get('parentItem') # => parent\n```\n\nor,\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n  secondChild = new App.ChildItem\n  parent.get('childItems').add(child)\n  parent.get('childItems').add(secondChild)\n  parent.get('childItems') # => Batman.AssociationSet\n  parent.get('childItems.length') # => 2\n```\n\n## @hasMany(label : string [, options : Object])\n`hasMany` expresses a one-to-many relationship on a `Batman.Model`.\n\n## @hasOne(label : string [, options : Object])\n`hasOne` expresses a one-to-one relationship on a `Batman.Model` when this model contains the primary key (eg, `id`) and does not contain the foreign key. If this model contains the foreign key, use `belongsTo` instead.\n\n## @belongsTo(label : string [, options : Object])\n`belongsTo` expresses a one-to-one relationship on a `Batman.Model` when this model contains the foreign key (eg, `parent_id`). If the other model contains the foreign key, use `hasOne` instead.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.AssociationSet` or `Batman.Model`. Generally they will return a `Batman.AssocationProxy` named after the association type,\nsuch as `Batman.BelongsToAssociationProxy` or `Batman.HasOneAssociationProxy`.\n\n\n## ::load(callback : Function)\nCalled to load the associated record from storage, setting it as  [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target). If a callback is passed, it is called with two arguments: any error and the loaded record. Also, when this function finishes, it sets [`loaded`](\/docs\/api\/batman.model_associations.html#prototype_accessor_loaded) to `true` and fires `loaded` on the record.\n\n## ::toJSON() : Object\nReturns JSON for the target record, if the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) is present.\n\n## ::%target\nThe associated record. Getting `target` does not implicitly call `load` on the association.\n\n## ::%loaded\n`true` or `false`, Whether or not the record has been loaded from storage.\n\n## ::fetchFromLocal() : Model\nThis method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record. If this method returns a falsy value, then [`fetchFromRemote`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromremote) is called.  `Batman.AssocationProxy` subclasses must implement this method.\n\n## ::fetchFromRemote() : Model\nIf [`fetchFromLocal`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromlocal) returns a falsy value, this method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record. `Batman.AssocationProxy` subclasses must implement this method.\n\n\n## Association Options\nAll assocations have a common set of options, as well as specific options for each type of relationship.\n\n##### `primaryKey[= \"id\"] : string`\nThe primary key for the association.\n\n##### `foreignKey[= \"#{label}_id\"] : string`\nThe foreign key for the association.\n\n##### `saveInline[= true] : boolean`\nIf true, this model's attributes will be included in the associated model's JSON. This means that when an associated record is saved, this record's attributes will be included in the JSON.\n\n##### `autoload[= true] : boolean`\nIf `true`, Batman will automatically call `load` when the associated records are accessed. This is useful in view bindings, where binding to the associated records will automatically cause them to be loaded.\n\n##### `nestUrl[= false] : boolean`\nIf `true`, this model's URL will be nested under the associated model:\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', nestUrl: true\n\n# ...\n\nchild = new ChildItem(parent_id: 1, id: 5)\nchild.url() # => 'parent_items\/1\/child_items\/5'\n```\n\n`nestUrl` only applies if the model is persisted with `Batman.RestStorage` (or a subclass).\n\n##### `name : string`\nBy default, Batman checks for a model with this singular, camel-case name of association's `label` attached to `Batman.currentApp`. If the associated model is different from that, use `name` (and\/or `namespace` to specify it.\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem' # automatically finds App.ParentItem\n  @belongsTo 'alternativeParentItem', name: 'ParentItem' # also finds App.ParentItem\n```\n\n##### `inverseOf : string`\nThe foreign association to set on load. If the associated model has an association with the same name as the `inverseOf` value, it will be populated when data is loaded from storage. For example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true, inverseOf: 'parentItem'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItems'\n```\n\nwould allow:\n\n```coffeescript\nApp.ParentItem.find 1, (err, parent) ->\n  children = parent.get('childItems')\n  children.get('first.parentItem') == parent # => true\n\nApp.ChildItem.find 5, (err, childItem) ->\n  childItem.get('parentItem').load (err, parent) ->\n    parent.get('childItems').has(childItem) # => true\n```\n\n##### `encoderKey[= label] : string`\nKey where attributes for associated records will be found.\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', encoderKey: 'children'\n```\n\nwill correctly decode this JSON:\n\n```javascript\n{id: 1, children: [{ id: 5, parent_id: 1 }, {id: 6, parent_id: 1}]}\n```\n\nIt will also encode the `childItems` as `children` (unless `saveInline` is set to `false`).\n\n##### `namespace[= Batman.currentApp] : string`\nBatman expects to find a model with the given `name` on `Batman.currentApp`. If your model is defined elsewhere, use `namespace` to specify where the model is defined.\n\n```coffeescript\nclass App.Admin.Person extends Batman.Model\n  @belongsTo 'organization', namespace: App.Admin # finds App.Admin.Organization instead of App.Organization\n```\n\n## Polymorphic Association Options\nBatman also supports [polymorphic associations](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations). For example:\n\n```coffeescript\nclass App.Superpower extends Batman.Model\n  @encode 'name'\n  @belongsTo 'superpowerable', polymorphic: true\n\nclass App.Hero extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n\nclass App.Villain extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n```\nBy default, attributes of the polymorphic association will be encoded according to the label. So, `hero.toJSON()` might return:\n\n```javascript\n{ id: 1,\n  name: 'Superman',\n  superpowers: [\n    {id: 15, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Super Strength'},\n    {id: 16, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Invincibility'},\n  ]\n}\n```\n\n##### `polymorphic[= false] : boolean`\nWhether the association is [polymorphic](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations).\n\n##### `as : string`\nSpecifies the name of the polymorphic interface.\n\n##### `foreignTypeKey[= \"#{label}_type\"] : string`\nSpecifies the field which contains the `type` for a polymorphic record.\n\n##### `encodeForeignTypeKey[=true] : boolean`\nSpecifies whether the `foreignTypeKey` should be included in the JSON of the record.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"523b6b90333976e3d22c82540f11e590d253b80b","subject":"Fix typos","message":"Fix typos\n","repos":"smizell\/hyperdescribe-uber-json","old_file":"doc\/parser.litcoffee","new_file":"doc\/parser.litcoffee","new_contents":"# UBER and Hyperdescribe\n\nThe goal of this document is to outline how Hyperdescribe would be used to describe a UBER document according to the [current specs](https:\/\/rawgithub.com\/mamund\/media-types\/e034e9d9eae7fb4455f25c928cb84cd513f9472c\/uber-hypermedia.html). This document will look at the JSON variant of the UBER format.\n\n    _ = require 'underscore'\n\n    cleanItem = (data) ->\n      _.reduce data, (total, value, key) ->\n        total[key] = value if value? and value.length != 0\n        total\n      , {}\n\n## Types\n\nEven though UBER really only has one data element, `data`, this data element can be treated differently depending on the context. This section will look at each of these different types along with the conditions for those types and the means to describe them with Hyperdescribe.\n\n### Transitions\n\nIn Hyperdescribe, there are two types of transitions:\n\n1. Links\n2. Actions\n\nIn the UBER spec, though, links and actions are not separated in this way, so this document will specify how it is determined whether an item is a link or an action.\n\n#### Links\n\nItems in UBER that are considered links in Hyperdescribe are items with `read` as the action. If the `@action` attribute is absent and the `@url` attribute is present, the action is assumed to be `read`. Additionally, if the action specified is not listed in the spec, it should be treated as `read`. This is according to the UBER spec.\n\nFor an item to be considered a link, it MUST have a `@url` attribute, it MUST NOT have any data, and it MUST be a `read` action.\n\n    #getPropertyName = (data) ->\n    #  if data.id? then id else data.name\n\n    hasData = (data, level) ->\n      data.data? and data.data?.length != 0\n\n    isReadAction = (data) ->\n      (!data.action? or \n        data.action == 'read' or \n        data.action not in _.keys(availableActions))\n\n    isLink = (data, level) ->\n      data.url? and !hasData(data, level) and isReadAction(data)\n\n    mapLink = (data) ->\n      linkUrl = if data.model? then data.url + data.model else data.url\n\n      link =\n        id: data.id\n        name: data.name\n        rel: data.rel\n        #property: getPropertyName(data)\n        transclude: data.transclude\n        types: data.accepting\n        label: data.value\n\n      link.href = if data.model? then data.url + data.model else data.url\n      link.template = true if data.model?\n\n      link\n\n#### Actions\n\nUBER only specifies available actions and also provides a mapping of these actions to their corresponding HTTP verbs (see [section 4.1.1](https:\/\/rawgithub.com\/mamund\/media-types\/master\/uber-hypermedia.html#_mapping_uber_tt_action_tt_values_to_http_methods)).\n\n    availableActions =\n      append: 'POST'\n      partial: 'PATCH'\n      read: 'GET'\n      remove: 'DELETE'\n      replace: 'PUT'\n\nItems that are considered actions MUST have an `@action` attribute, MUST have a `@url`, MAY have a `@model`, and MUST use an avaiable action from the spec.\n\n    isAction = (data, level) ->\n      data.action? and\n        data.url? and\n        data.action in _.keys(availableActions)\n\nAccording to 4.1.1, there are only three actions that modify the body of the message sent:\n\n* append\n* partial\n* replace\n\nSince `read` actions are handled by links, `remove` is the only action that needs special treatment.\n\n    modifiesBody = [\n      'append'\n      'partial'\n      'replace'\n    ]\n\n    parseBodyModel = (model) ->\n      items = model.split('&').map (item) ->\n        [key, value] = item.split('=')\n        { name: key, type: \"text\", mapsTo: value[1..-2] }\n\n    mapAction = (data) ->\n      action = \n        name: data.name\n        rel: data.rel\n        method: availableActions[data.action]\n        sendAs: data.sending\n\nIf an action is one that does not modify the body, the model is added to the action's `@url` attribute and template is set to `true`, which conveys it is templated action.\n\n      if data.action not in modifiesBody and data.model?\n        action.url = data.url + data.model\n        action.template = true\n\nIf the action does modify the body, the model is parsed and fields are created.\n\n      if data.action in modifiesBody\n        action.url = data.url\n        action.fields = parseBodyModel(data.model)\n      cleanItem(action)\n\n### Properties\n\nAn item that is considered a property of a resource MUST have a `@value`, MUST NOT be at the root level (or in other words, MUST be a child element), MUST NOT be a transition, and MUST NOT have a `@data` attribute.\n\n    isTransition = (data, level) ->\n      isLink(data, level) or isAction(data, level)\n\n    isProperty = (data, level) ->\n      data.value? and level != 0 and !isTransition(data, level) and !hasData(data, level)\n\nCurrently, with regards to mapping to Hyperdescribe, the only relevant values will be `@name` and `@value`.\n\n    mapProperty = (data) ->\n      cleanItem\n        name: data.name\n        value: data.value\n\n### Resources\n\nAn item considered a resource MUST NOT have an `@action` attribute and MUST have a `@data` attribute. Like the `data` element in UBER, Hyperdescribe can handle nested resources.\n\n    isResource = (data, level) ->\n      !data.action? and hasData(data, level)\n\nMapping a resource from UBER to Hyperdescribe requires finding all of the links, actions, and properties, along with all nested resources. Once those are all found, they can then be mapped to how \n\n    mapResource = (data, level) ->\n      links = data.data.filter (d) -> isLink(d, level)\n      actions = data.data.filter (d) -> isAction(d, level)\n      resources = data.data.filter (d) -> isResource(d, level)\n      properties = data.data.filter (d) -> isProperty(d, level)\n\n      hLinks = links.map (link) -> mapLink(link)\n      hActions = actions.map (action) -> mapAction(action)\n      hResources = resources.map (resource) -> mapResource(resource, level + 1)\n      hProperties = properties.map (property) -> mapProperty(property)\n\n      cleanItem\n        name: data.name\n        links: hLinks\n        actions: hActions\n        resources: hResources\n        properties: hProperties\n\n## UBER Document\n\nMapping an UBER document to Hyperdescribe requires treating the root `@uber` element as a resource. Since each resource can have nested resources, Hyperdescribe should map each resource recursively.\n\n    mapUberDocument = module.exports = (uber) -> mapResource(uber.uber, 0)\n\n## Issues\n\n1. There is currently no way to tell whether a nested link should be a property of the resource (e.g. the `avatarUrl` in the example in the spec) or just a normal link. \n2. Is there any way to specify schema.org information for an UBER document?\n\n","old_contents":"# UBER and Hyperdescribe\n\nThe goal of this document is to outline how Hyperdescribe would be used to describe a UBER document according to the [current specs](https:\/\/rawgithub.com\/mamund\/media-types\/e034e9d9eae7fb4455f25c928cb84cd513f9472c\/uber-hypermedia.html). This document will look at the JSON variant of the UBER format.\n\n    _ = require 'underscore'\n\n    cleanItem = (data) ->\n      _.reduce data, (total, value, key) ->\n        total[key] = value if value? and value.length != 0\n        total\n      , {}\n\n## Types\n\nEven though UBER really only has one data element, `data`, this data element can be treated differently depending on the context. This section will look at each of these different types along with the conditions for those types and the means to describe them with Hyperdescribe.\n\n### Transitions\n\nIn Hyperdescribe, there are two types of transitions:\n\n1. Links\n2. Actions\n\nIn the UBER spec, though, links and actions are not separated in this way, so this document will specify how it is determined whether an item is a link or an action.\n\n#### Links\n\nItems in UBER that are considered links in Hyperdescribe are items with `read` as the action. If the `@action` attribute is absent and the `@url` attribute is present, the action is assumed to be `read`. Additionally, if the action specified is not listed in the spec, it should be treated as `read`. This is according to the UBER spec.\n\nFor an item to be considered a link, it MUST have a `@url` attribute, it MUST NOT have any data, and it MUST be a `read` action.\n\n    #getPropertyName = (data) ->\n    #  if data.id? then id else data.name\n\n    hasData = (data, level) ->\n      data.data? and data.data?.length != 0\n\n    isReadAction = (data) ->\n      (!data.action? or \n        data.action == 'read' or \n        data.action not in _.keys(availableActions))\n\n    isLink = (data, level) ->\n      data.url? and !hasData(data, level) and isReadAction(data)\n\n    mapLink = (data) ->\n      linkUrl = if data.model? then data.url + data.model else data.url\n\n      link =\n        id: data.id\n        name: data.name\n        rel: data.rel\n        #property: getPropertyName(data)\n        transclude: data.transclude\n        types: data.accepting\n        label: data.value\n\n      link.href = if data.model? then data.url + data.model else data.url\n      link.template = true if data.model?\n\n      link\n\n#### Actions\n\nUBER only specifies available actions and also provides a mapping of these actions to their corresponding HTTP verbs (see [section 4.1.1](https:\/\/rawgithub.com\/mamund\/media-types\/master\/uber-hypermedia.html#_mapping_uber_tt_action_tt_values_to_http_methods)).\n\n    availableActions =\n      append: 'POST'\n      partial: 'PATCH'\n      read: 'GET'\n      remove: 'DELETE'\n      replace: 'PUT'\n\nItems that are considered actions MUST have an `@action` attribute, MUST have a `@url`, MAY have a `@model`, and MUST use an avaiable action from the spec.\n\n    isAction = (data, level) ->\n      data.action? and\n        data.url? and\n        data.action in _.keys(availableActions)\n\nAccording to 4.1.1, there are only three actions that modify the body of the message sent:\n\n* append\n* partial\n* replace\n\nSince `read` actions are handled by links, `remove` is the only action that needs special treatment.\n\n    modifiesBody = [\n      'append'\n      'partial'\n      'replace'\n    ]\n\n    parseBodyModel = (model) ->\n      items = model.split('&').map (item) ->\n        [key, value] = item.split('=')\n        { name: key, type: \"text\", mapsTo: value[1..-2] }\n\n    mapAction = (data) ->\n      action = \n        name: data.name\n        rel: data.rel\n        method: availableActions[data.action]\n        sendAs: data.sending\n\nIf an action is one that does not modify the body, the model is added to the action's `@url` attribute and template is set to `true`, which conveys it is templated action.\n\n      if data.action not in modifiesBody and data.model?\n        action.url = data.url + data.model\n        action.template = true\n\nIf the action does modify the body, the model is parsed and fields are created. This will be treated as \n\n      if data.action in modifiesBody\n        action.url = data.url\n        action.fields = parseBodyModel(data.model)\n      cleanItem(action)\n\n### Properties\n\nAn item that is considered a property of a resource MUST have a `@value`, MUST NOT be at the root level, MUST NOT be a transition, and MUST NOT have data.\n\n    isTransition = (data, level) ->\n      isLink(data, level) or isAction(data, level)\n\n    isProperty = (data, level) ->\n      data.value? and level != 0 and !isTransition(data, level) and !hasData(data, level)\n\nCurrently, with regards to mapping to Hyperdescribe, the only relevant values will be `@name` and `@value`.\n\n    mapProperty = (data) ->\n      cleanItem\n        name: data.name\n        value: data.value\n\n### Resources\n\nAn item considered a resource MUST NOT have an `@action` attribute and MUST have a `@data` attribute. Like the `data` element in UBER, Hyperdescribe can handle nested resources.\n\n    isResource = (data, level) ->\n      !data.action? and hasData(data, level)\n\nMapping a resource from UBER to Hyperdescribe requires finding all of the links, actions, and properties, along with all nested resources. Once those are all found, they can then be mapped to how \n\n    mapResource = (data, level) ->\n      links = data.data.filter (d) -> isLink(d, level)\n      actions = data.data.filter (d) -> isAction(d, level)\n      resources = data.data.filter (d) -> isResource(d, level)\n      properties = data.data.filter (d) -> isProperty(d, level)\n\n      hLinks = links.map (link) -> mapLink(link)\n      hActions = actions.map (action) -> mapAction(action)\n      hResources = resources.map (resource) -> mapResource(resource, level + 1)\n      hProperties = properties.map (property) -> mapProperty(property)\n\n      cleanItem\n        name: data.name\n        links: hLinks\n        actions: hActions\n        resources: hResources\n        properties: hProperties\n\n## UBER Document\n\nMapping an UBER document to Hyperdescribe requires treating the root `@uber` element as a resource. Since each resource can have nested resources, Hyperdescribe should map each resource recursively.\n\n    mapUberDocument = module.exports = (uber) -> mapResource(uber.uber, 0)\n\n## Issues\n\n1. There is currently no way to tell whether a nested link should be a property of the resource (e.g. the `avatarUrl` in the example in the spec) or just a normal link. \n2. Is there any way to specify schema.org information for an UBER document?\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"67dfcc865d91505056bb7b4d9a66404508b813ad","subject":"Fix a comment","message":"Fix a comment\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/keyboard.litcoffee","new_file":"src\/coffee\/keyboard.litcoffee","new_contents":"Keyboard Input\n==============\n\nWe first collect an event stream of all keyboard events sent to the\npage.\n\n    keyboardEvents = $(document).asEventStream('keydown')\n                                .map('.keyCode')\n\nWe keep a map of keycodes to internal names.\n\n    keyMap =\n        48: 'view-0',\n        49: 'view-1',\n        50: 'view-2',\n        51: 'view-3',\n        52: 'view-4',\n        53: 'view-5',\n        54: 'view-6',\n        55: 'view-7',\n        56: 'view-8',\n        57: 'view-9',\n        75: 'kill', # k\n        84: 'load-debug', # t\n\nWe then have a stream of keyboard events coming in based on that\nmap, discarding those that are not present as well as bounces.\n\n    window.Keyboard = keyboardEvents.map( (k) -> keyMap[k] )\n                                    .filter( (x) -> x? )\n                                    .debounce(150)\n\nJudge Selection\n---------------\n\nThe keys 1-6 are used to select between display on the judge's desk.\n\nWe keep a property here to select between them.\n\n    displayMap =\n        'view-1': 'match-display'\n        'view-2': 'match-sched'\n        'view-3': 'league-state'\n        'view-4': 'knockout-state'\n        'view-5': 'next-match'\n        'view-6': 'day-sched'\n\n    window.JudgeSelection = window.Keyboard.map( (k) -> displayMap[k] )\n                                           .filter( (x) -> x? )\n                                           .toProperty('match-display')\n                                           .skipDuplicates()\n\n","old_contents":"Keyboard Input\n==============\n\nWe first collect an event stream of all keyboard events sent to the\npage.\n\n    keyboardEvents = $(document).asEventStream('keydown')\n                                .map('.keyCode')\n\nWe keep a map of keycodes to internal names.\n\n    keyMap =\n        48: 'view-0',\n        49: 'view-1',\n        50: 'view-2',\n        51: 'view-3',\n        52: 'view-4',\n        53: 'view-5',\n        54: 'view-6',\n        55: 'view-7',\n        56: 'view-8',\n        57: 'view-9',\n        75: 'kill', # k\n        84: 'load-debug', # t\n\nWe then have a stream of keyboard events coming in based on that\nmap, discarding those that are not present as well as bounces.\n\n    window.Keyboard = keyboardEvents.map( (k) -> keyMap[k] )\n                                    .filter( (x) -> x? )\n                                    .debounce(150)\n\nJudge Selection\n---------------\n\nThe keys 1-4 are used to select between display on the judge's desk.\n\nWe keep a property here to select between them.\n\n    displayMap =\n        'view-1': 'match-display'\n        'view-2': 'match-sched'\n        'view-3': 'league-state'\n        'view-4': 'knockout-state'\n        'view-5': 'next-match'\n        'view-6': 'day-sched'\n\n    window.JudgeSelection = window.Keyboard.map( (k) -> displayMap[k] )\n                                           .filter( (x) -> x? )\n                                           .toProperty('match-display')\n                                           .skipDuplicates()\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9834b819ba0130a29fd3cc3e3799b5018a3dfb7b","subject":"Improve documentation such that it shows properly on GitHub","message":"Improve documentation such that it shows properly on GitHub\n","repos":"arximboldi\/heterarchy","old_file":"heterarchy.litcoffee","new_file":"heterarchy.litcoffee","new_contents":"heterarchy\n==========\n\nAdds multiple inheritance support to CoffeeScript (and JavaScript).\nIt uses the C3 linearization algorithm as described in the [famous\nDylan paper](http:\/\/192.220.96.201\/dylan\/linearization-oopsla96.html).\n\n    {head, tail, map, find, some, without, isEmpty, every, memoize, reject,\n     partial, isEqual} =\n        require 'underscore'\n\n    assert = (value, error=undefined) ->\n        if not value\n           throw new Error(if error? then error else \"Assertion failed\")\n\nMultiple inheritance\n--------------------\n\nThe **multi** function takes a list of classes and returns a *special*\nclass object that merges the class hierarchies, as linearized by the\nC3 algorithm. Limitations of the approach are:\n\n- `instanceof` does not always work as expected. For example:\n\n  > ```coffee\n  > class A\n  > class B extends A\n  > class C extends A\n  > class D extends multi B, C\n  > assert new D not instanceof B\n  > ```\n\n  Instead, one should use the provided `isinstance` function.\n\n- Some of the bases of a multi-inherited hierarchy are *frozen* when\n  the sub-class is defined -- i.e. later modifications to the\n  superclass are not visible to the subclass or its instances.  For\n  example, in the previous heterarchy:\n\n  > ```coffee\n  > B::newProperty = 42\n  > assert D::newProperty == undefined\n  > ```\n\nThe `multi` function memoizes its results such that identity is\nmaintained, implying `multi X, Y is multi X, Y`.\n\n    exports.multi = (bases...) ->\n        generate merge map(bases, mro).concat [bases]\n\nThis takes a list of classes representing a hierarchy (from most to\nleast derived) and generates a single-inheritance hierarchy that\nbehaves like a class that would be have such a hierarchy.\n\n    generate = memoize (linearization) ->\n        next = head linearization\n        if isEqual linearization, hierarchy next\n            next\n        else\n            class result extends generate tail linearization\n                __mro__: linearization\n                constructor: reparent next, @, next::constructor\n                copyOwn next, @\n                copyOwn next::, @::, partial reparent, next, @\n\nThis utility lets us copy own properties of a *from* object that are\nnot own properties of a *to* object into the *to* object, optionally\ntransformed via a projection function.\n\n    copyOwn = (from, to, project = (x) -> x) ->\n        for own key, value of from\n            if not to.hasOwnProperty key\n                to[key] = project value\n        to\n\nMethods in CoffeeScript call super directly, so we have to change the\n`__super__` attribute of the original class during the scope of the\nmethod so it calls the right super of the linearization.  Also,\nprogrammers don't call super in constructor of root classes --indeed\ndoing so would rise an error-- so we have to inject such a call when\nthere are classes after these in the linearization.  The **reparent**\nfunction takes care of all these and given an original class, and the\nnew class that is replacing it a linearized heterarchy, returns a\nwrapped copy of a value of the former that is suitable for replacing\nit in the later.\n\n    reparent = (oldklass, newklass, value) ->\n        if value not instanceof Function\n            value\n        else if value == oldklass::constructor and inherited(oldklass) == Object\n            superctor = inherited(newklass)::constructor\n            ->\n                superctor.apply @, arguments\n                value.apply @, arguments\n        else\n            newsuper = inherited(newklass)::\n            oldsuper = oldklass.__super__\n            ->\n                oldklass.__super__ = newsuper\n                try\n                    value.apply @, arguments\n                finally\n                    oldklass.__super__ = oldsuper\n\nThis is the C3 linearization algorithm, as translated from the\noriginal paper.\n\n    merge = (inputs) ->\n        while not isEmpty inputs\n            next = find (map inputs, head), (candidate) ->\n                every inputs, (input) -> candidate not in tail input\n            assert next?, \"Inconsistent multiple inheritance\"\n            inputs = reject map(inputs, (lst) -> without lst, next), isEmpty\n            next\n\nIntrospection\n-------------\n\nThe **mro** function returns the method resolution order\n(linearization) of a given class:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends B\n> assert mro(C).equals [C, B, A]\n> ```\n\nIt returns the original classes that were mixed in when used with\nmult-inherited classes:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert mro(D).equals [D, B, C, A, Object]\n> ```\n\n    exports.mro = mro = (cls) ->\n        if not cls? or not cls::?\n            []\n        else if not cls::hasOwnProperty '__mro__'\n            cls::__mro__ = [cls].concat mro inherited(cls)\n        else\n            cls::__mro__\n\nThe **inherited** function returns the CoffeeScript superclass of an\nobject, for example:\n\n> ```coffee\n> class A\n> class B extends A\n> assert inherited(B) == A\n> ```\n\nNote that for multiple inherited classes, this returns the mixed\nobject, not the next class in the MRO, as in:\n\n> ```coffee\n> class C extends multi A, B\n> assert inherited(C) == multi(A, B)\n> ```\n\n    exports.inherited = inherited = (cls) ->\n        Object.getPrototypeOf(cls.prototype)?.constructor\n\nThe **hierarchy** returns the CoffeeScript hierarchy of classes of a\ngiven class, including the class itself.  For multiple inherited\nclasses, it may return speciall classes that were generated to produce\nthe flattening, as in:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert not mro(D).equals hierarchy(D)\n> assert hierarchy(D).equals\n>     [ D, multi(B, C), inherited(multi B, C), A, Object ]\n> ```\n\n    exports.hierarchy = hierarchy = (cls) ->\n        if not cls?\n            []\n        else\n            [cls].concat hierarchy inherited cls\n\nThe **isinstance** function takes an object and a class or classes and\nreturns whether the object is an instance of any of those classes. It\nis compatible with multi-inherited classes.\n\n    exports.isinstance = (obj, classes...) ->\n        exports.issubclass obj?.constructor, classes...\n\nThe **issubclass** tells whether a class is a subtype of another type.\n\n    exports.issubclass = (klass, classes...) ->\n        linearization = mro klass\n        some classes, (cls) -> cls in linearization\n\nLicense\n-------\n\n> Copyright (c) 2013, 2015 Juan Pedro Bolivar Puente <raskolnikov@gnu.org>\n>\n> Permission is hereby granted, free of charge, to any person obtaining a copy\n> of this software and associated documentation files (the \"Software\"), to deal\n> in the Software without restriction, including without limitation the rights\n> to use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\n> copies of the Software, and to permit persons to whom the Software is\n> furnished to do so, subject to the following conditions:\n>\n> The above copyright notice and this permission notice shall be included in\n> all copies or substantial portions of the Software.\n>\n> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n> THE SOFTWARE.\n","old_contents":"heterarchy\n==========\n\nAdds multiple inheritance support to CoffeeScript (and JavaScript).\nIt uses the C3 linearization algorithm as described in the [famous\nDylan paper](http:\/\/192.220.96.201\/dylan\/linearization-oopsla96.html).\n\n    {head, tail, map, find, some, without, isEmpty, every, memoize, reject,\n     partial, isEqual} =\n        require 'underscore'\n\n    assert = (value, error=undefined) ->\n        if not value\n           throw new Error(if error? then error else \"Assertion failed\")\n\nMultiple inheritance\n--------------------\n\nThe **multi** function takes a list of classes and returns a *special*\nclass object that merges the class hierarchies, as linearized by the\nC3 algorithm. Limitations of the approach are:\n\n- `instanceof` does not always work as expected. For example:\n\n  > class A\n  > class B extends A\n  > class C extends A\n  > class D extends multi B, C\n  > assert new D not instanceof B\n\n  Instead, one should use the provided `isinstance` function.\n\n- Some of the bases of a multi-inherited hierarchy are *frozen* when\n  the sub-class is defined -- i.e. later modifications to the\n  superclass are not visible to the subclass or its instances.  For\n  example, in the previous heterarchy:\n\n  > B::newProperty = 42\n  > assert D::newProperty == undefined\n\n    exports.multi = (bases...) ->\n        generate merge map(bases, mro).concat [bases]\n\nThis takes a list of classes representing a hierarchy (from most to\nleast derived) and generates a single-inheritance hierarchy that\nbehaves like a class that would be have such a hierarchy.\n\n    generate = memoize (linearization) ->\n        next = head linearization\n        if isEqual linearization, hierarchy next\n            next\n        else\n            class result extends generate tail linearization\n                __mro__: linearization\n                constructor: reparent next, @, next::constructor\n                copyOwn next, @\n                copyOwn next::, @::, partial reparent, next, @\n\nThis utility lets us copy own properties of a *from* object that are\nnot own properties of a *to* object into the *to* object, optionally\ntransformed via a projection function.\n\n    copyOwn = (from, to, project = (x) -> x) ->\n        for own key, value of from\n            if not to.hasOwnProperty key\n                to[key] = project value\n        to\n\nMethods in CoffeeScript call super directly, so we have to change the\n`__super__` attribute of the original class during the scope of the\nmethod so it calls the right super of the linearization.  Also,\nprogrammers don't call super in constructor of root classes --indeed\ndoing so would rise an error-- so we have to inject such a call when\nthere are classes after these in the linearization.  The **reparent**\nfunction takes care of all these and given an original class, and the\nnew class that is replacing it a linearized heterarchy, returns a\nwrapped copy of a value of the former that is suitable for replacing\nit in the later.\n\n    reparent = (oldklass, newklass, value) ->\n        if value not instanceof Function\n            value\n        else if value == oldklass::constructor and inherited(oldklass) == Object\n            superctor = inherited(newklass)::constructor\n            ->\n                superctor.apply @, arguments\n                value.apply @, arguments\n        else\n            newsuper = inherited(newklass)::\n            oldsuper = oldklass.__super__\n            ->\n                oldklass.__super__ = newsuper\n                try\n                    value.apply @, arguments\n                finally\n                    oldklass.__super__ = oldsuper\n\nThis is the C3 linearization algorithm, as translated from the\noriginal paper.\n\n    merge = (inputs) ->\n        while not isEmpty inputs\n            next = find (map inputs, head), (candidate) ->\n                every inputs, (input) -> candidate not in tail input\n            assert next?, \"Inconsistent multiple inheritance\"\n            inputs = reject map(inputs, (lst) -> without lst, next), isEmpty\n            next\n\nIntrospection\n-------------\n\nThe **mro** function returns the method resolution order\n(linearization) of a given class:\n\n> class A\n> class B extends A\n> class C extends B\n> assert mro(C).equals [C, B, A]\n\nIt returns the original classes that were mixed in when used with\nmult-inherited classes:\n\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert mro(D).equals [D, B, C, A, Object]\n\n    exports.mro = mro = (cls) ->\n        if not cls? or not cls::?\n            []\n        else if not cls::hasOwnProperty '__mro__'\n            cls::__mro__ = [cls].concat mro inherited(cls)\n        else\n            cls::__mro__\n\nThe **inherited** function returns the CoffeeScript superclass of an\nobject, for example:\n\n> class A\n> class B extends A\n> assert inherited(B) == A\n\nNote that for multiple inherited classes, this returns the mixed\nobject, not the next class in the MRO, as in:\n\n> class C extends multi A, B\n> assert inherited(C) == multi(A, B)\n\n    exports.inherited = inherited = (cls) ->\n        Object.getPrototypeOf(cls.prototype)?.constructor\n\nThe **hierarchy** returns the CoffeeScript hierarchy of classes of a\ngiven class, including the class itself.  For multiple inherited\nclasses, it may return speciall classes that were generated to produce\nthe flattening, as in:\n\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert not mro(D).equals hierarchy(D)\n> assert hierarchy(D).equals\n>     [ D, multi(B, C), inherited(multi B, C), A, Object ]\n\n    exports.hierarchy = hierarchy = (cls) ->\n        if not cls?\n            []\n        else\n            [cls].concat hierarchy inherited cls\n\nThe **isinstance** function takes an object and a class or classes and\nreturns whether the object is an instance of any of those classes. It\nis compatible with multi-inherited classes.\n\n    exports.isinstance = (obj, classes...) ->\n        exports.issubclass obj?.constructor, classes...\n\nThe **issubclass** tells whether a class is a subtype of another type.\n\n    exports.issubclass = (klass, classes...) ->\n        linearization = mro klass\n        some classes, (cls) -> cls in linearization\n\nLicense\n-------\n\n> Copyright (c) 2013, 2015 Juan Pedro Bolivar Puente <raskolnikov@gnu.org>\n>\n> Permission is hereby granted, free of charge, to any person obtaining a copy\n> of this software and associated documentation files (the \"Software\"), to deal\n> in the Software without restriction, including without limitation the rights\n> to use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\n> copies of the Software, and to permit persons to whom the Software is\n> furnished to do so, subject to the following conditions:\n>\n> The above copyright notice and this permission notice shall be included in\n> all copies or substantial portions of the Software.\n>\n> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n> THE SOFTWARE.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0a6c58eb54843d762738bc90337985c13206dac2","subject":"improved helpers","message":"improved helpers\n","repos":"vpj\/weya,vpj\/weya","old_file":"weya.litcoffee","new_file":"weya.litcoffee","new_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       if elem.classList?\n        for c in idClass.class\n         elem.classList.add c\n       else #For older browsers; does not work with svgs\n        className = ''\n        for c in idClass.class\n         className += ' ' if className isnt ''\n         className += \"#{c}\"\n        elem.className = className\n\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        buf.push \" class=\\\"#{params.idClass.class}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       setIndent buf, @_indent\n       buf.push params.text\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, func of options.helpers\n       if not weya[name]?\n        added.push name\n        weya[name] = func.bind weya\n\n\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, func of options.helpers\n       if not weya[name]?\n        added.push name\n        weya[name] = func.bind weya\n\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","old_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       if elem.classList?\n        for c in idClass.class\n         elem.classList.add c\n       else #For older browsers; does not work with svgs\n        className = ''\n        for c in idClass.class\n         className += ' ' if className isnt ''\n         className += \"#{c}\"\n        elem.className = className\n\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        buf.push \" class=\\\"#{params.idClass.class}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       setIndent buf, @_indent\n       buf.push params.text\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     added = []\n     setFunc = (name, f) ->\n      weya[name] = ->\n       f.apply weya, arguments\n     if options.helpers?\n      for name, f of options.helpers\n       if not weya[name]?\n        added.push name\n        setFunc name, f\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n     for name in added\n      weya[name] = null\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"77f4aa007045c4cfd556ab0306146afe0a1e6a82","subject":"indent code 8 spaces instead","message":"indent code 8 spaces instead\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/07_request.litcoffee","new_file":"docs\/07_request.litcoffee","new_contents":"# Batman.Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented in the platform layer files.\n\n### Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\nBatman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\nIn other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n\n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n\nThere are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n1. `loading()`: fired before `send()` has been called.\n\n        test \"Demonstrate the loading event\", 1, ->\n           new Batman.Request\n             url: \"http::\/\/batmanjs.org\"\n             loading: ->\n               ok true, \"After send but before the request is made\"\n\n1. `loaded()`: fired after the request is complete\n\n         test \"Demo the loaded event\", 1, ->\n           Batman.Request.setupMockedResponse()\n           Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n           new Batman.Request\n             url: \"http:\/\/batmanjs.org\"\n             loaded: ->\n               ok true, \"Loaded\"\n\n1. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n        test \"Demo the error event\", 1, ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            error: (xhr) ->\n              ok true, \"Error\"\n\n1. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n        test \"Demonstrate the success event\", 1,  ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            success: (response) ->\n              equal \"foo\", response\n\n## .status\nThe response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\nThe response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : object\nAn key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request(options : object)\n\nConstructs a new `Batman.Request` with the supplied options\n\n### `options` description\n\n1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n\n1. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`.\n\n        test \"method test\", ->\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n          new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            method: \"POST\"\n            data: { some: \"data\" }\n            success: (response) ->\n              ok true\n\n1. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n\n1. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n        test \"contentType default\", ->\n           req = new Batman.Request\n           equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n1. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n        test \"autosend test\", ->\n          response_sent = false\n          Batman.Request.setupMockedResponse()\n          Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n          req = new Batman.Request\n            url: \"http:\/\/batmanjs.org\"\n            autosend: false\n            success: (response) ->\n              response_sent = true\n          ok !response_sent\n          req.send()\n          ok response_sent\n\n1. `username`: username for authentication\n\n1. `password`: password for authentication\n\n1. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send([data])\nIf `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","old_contents":"# Batman.Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented in the platform layer files.\n\n### Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\nBatman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\nIn other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n\n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n\nThere are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n1) `loading()`: fired before `send()` has been called.\n\n    test \"Demonstrate the loading event\", 1, ->\n       new Batman.Request\n         url: \"http::\/\/batmanjs.org\"\n         loading: ->\n           ok true, \"After send but before the request is made\"\n\n2) `loaded()`: fired after the request is complete\n\n     test \"Demo the loaded event\", 1, ->\n       Batman.Request.setupMockedResponse()\n       Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n       new Batman.Request\n         url: \"http:\/\/batmanjs.org\"\n         loaded: ->\n           ok true, \"Loaded\"\n\n3) `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n    test \"Demo the error event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        error: (xhr) ->\n          ok true, \"Error\"\n\n4) `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n    test \"Demonstrate the success event\", 1,  ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", response\n\n## .status\nThe response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\nThe response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : object\nAn key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request(options : object)\n\nConstructs a new `Batman.Request` with the supplied options\n\n### `options` description\n\n1) `url : String`: A string containing the URL to which the request is sent.  Mandatory\n\n2) `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`\n\n    test \"method test\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"POST\"\n        data: { some: \"data\" }\n        success: (response) ->\n          ok true\n\n3) `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n\n4) `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n    test \"contentType default\", ->\n       req = new Batman.Request\n       equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n5) `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n    test \"autosend test\", ->\n      response_sent = false\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        success: (response) ->\n          response_sent = true\n      ok !response_sent\n      req.send()\n      ok response_sent\n\n6) `username`: username for authentication\n\n7) `password`: password for authentication\n\n8) `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send([data])\nIf `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a633e1e521802dd52359f0433600c74ac8335662","subject":"remove extra if","message":"remove extra if\n","repos":"nickfargo\/restate","old_file":"src\/state.litcoffee","new_file":"src\/state.litcoffee","new_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\n      { memoizeProtostates, useDispatchTables } = state.options\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        do substate.destroy for own name, substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneCategory   _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method for this state. Providing an optional `out` object\nallows the appropriate `context` for a state-bound method to be delivered as a\nproperty of `out`; if included, `context` is confined to the local state tree.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out, boxed ) ->\n        realized = ~@attributes & VIRTUAL\n\n> During the pseudo-loop block, the `context` reference should be considered\n  provisional, because its potential value is in part a product of the manner\n  in which its accompanying `method` was retrieved. After `break`ing out of the\n  block, `method` can be type-checked and `context` may be kept or discarded as\n  appropriate.\n\n        loop # once\n\nFirst seek the named method locally.\n\n          if realized\n            method = @_?.methods?[ methodName ]\n            if method is rootNoop then method = null\n            if method? then context = this\n            else if record = @_?.__dispatch_table__?[ methodName ]\n              [ method, context ] = record\n            break if method?\n\nIf no method is held locally, start traversing, first up the protostate chain.\nIf this succeeds, the provisional `context` *must be the epistate* inheriting\nthe method (constrast with the `VIA_SUPER` case).\n\n          if ( viaProto = via & VIA_PROTO ) and\n              method = @protostate()?.method methodName, VIA_PROTO, out, yes\n            context = this\n            inherited = yes; break\n\nIf no method is found yet, continue traversing up the superstate chain. If this\nsucceeds, the provisional `context` *must be the superstate* from which the\nmethod is inherited.\n\n          if via & VIA_SUPER and method = @superstate?.method \\\n              methodName, VIA_SUPER | viaProto, out, yes\n            { context } = out if out?\n            inherited = yes; break\n\nThe method cannot be found.\n\n          context = null\n          break # always\n\n        if method?\n\nIf `method` is a function, it is not state-bound, so `context` is unnecessary.\n\n          if typeof method is 'function'\n            context = null\n\nIff `this` is a realized `State`, inherited lookup results can be memoized in\nthe local dispatch table.\n\n          if realized and inherited and useDispatchTables\n            table = @_?.__dispatch_table__ or = {}\n            table[ methodName ] = [ method, context ]\n\nUnbox a state-bound function unless directed otherwise.\n\n          if not boxed and method.type is 'state-bound-function'\n            method = method.fn\n\nExport `method` and `context` together if the `out` reference was provided.\n\n> Callers who know that `method` will be unbound need not provide an `out`.\n\n        if out?\n          out.method = method\n          out.context = context\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state. The provided `fn` may be any of:\n\n  1.  A proper function, which will be called in the context of `@owner`;\n  2.  A boxing of a *bound* function as prepared by `state.bind`, which will\n      cause the boxed function to be called in the context of either `this`\n      `State` or the *epistate* inheriting the method;\n  3.  A boxing of a *fixed* function as prepared by `state.fix`, whose boxed\n      function will be closed over hard references to `this` as `autostate`,\n      and to the *protostate* of `this`, as `protostate`.\n\n> See also: `state.bind`, `state.fix`\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` boxes a *state-fixed* function, then partially apply that function to\nextract the actual method, closed over references to the locality of `this`.\n\n        if typeof fn is 'object' and fn.type is 'state-fixed-function'\n          fn = fn.fn this, @protostate()\n\n        throw TypeError unless typeof fn is 'function' or\n          fn?.type is 'state-bound-function'\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root._?.methods?[ methodName ]\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n            root.addMethod methodName, ownerMethod\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context.\n\nIf the named method does not exist locally and cannot be inherited, then\n`noSuchMethod` events are emitted, and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n\nFirst try to resolve the method quickly from the local dispatch table.\n\n        if record = @_?.__dispatch_table__?[ methodName ]\n          [ method, context ] = record\n          method = method.fn if method?.type is 'state-bound-function'\n\nResort to a proper lookup if the fast way turns up nothing.\n\n        unless method?\n          if method = @method methodName, VIA_ALL, out = {}\n            { context } = out\n\nBail out gracefully if the method definitively cannot be resolved.\n\n          else\n            @emit 'noSuchMethod', [ methodName, args ]\n            @emit 'noSuchMethod:' + methodName, args\n            return\n\nIf at this point a `context` is provided, this means that `method` is a\nstate-bound function, and `context` will be the appropriately bound `State`. If\nno `context` exists, this means that `method` is a typical non-state-bound\nfunction, which is meant to be invoked in the usual fashion, just as if it were\ncalled directly as a method of `this` state\u2019s `owner`.\n\n        method.apply context or @owner, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","old_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\n      { memoizeProtostates, useDispatchTables } = state.options\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        do substate.destroy for own name, substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneCategory   _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method for this state. Providing an optional `out` object\nallows the appropriate `context` for a state-bound method to be delivered as a\nproperty of `out`; if included, `context` is confined to the local state tree.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out, boxed ) ->\n        realized = ~@attributes & VIRTUAL\n\n> During the pseudo-loop block, the `context` reference should be considered\n  provisional, because its potential value is in part a product of the manner\n  in which its accompanying `method` was retrieved. After `break`ing out of the\n  block, `method` can be type-checked and `context` may be kept or discarded as\n  appropriate.\n\n        loop # once\n\nFirst seek the named method locally.\n\n          if realized\n            method = @_?.methods?[ methodName ]\n            if method is rootNoop then method = null\n            if method? then context = this\n            else if record = @_?.__dispatch_table__?[ methodName ]\n              [ method, context ] = record\n            break if method?\n\nIf no method is held locally, start traversing, first up the protostate chain.\nIf this succeeds, the provisional `context` *must be the epistate* inheriting\nthe method (constrast with the `VIA_SUPER` case).\n\n          if ( viaProto = via & VIA_PROTO ) and\n              method = @protostate()?.method methodName, VIA_PROTO, out, yes\n            context = this\n            inherited = yes; break\n\nIf no method is found yet, continue traversing up the superstate chain. If this\nsucceeds, the provisional `context` *must be the superstate* from which the\nmethod is inherited.\n\n          if via & VIA_SUPER and method = @superstate?.method \\\n              methodName, VIA_SUPER | viaProto, out, yes\n            { context } = out if out?\n            inherited = yes; break\n\nThe method cannot be found.\n\n          context = null\n          break # always\n\n        if method?\n\nIf `method` is a function, it is not state-bound, so `context` is unnecessary.\n\n          if typeof method is 'function'\n            context = null\n\nIff `this` is a realized `State`, inherited lookup results can be memoized in\nthe local dispatch table.\n\n          if realized and inherited and useDispatchTables\n            table = @_?.__dispatch_table__ or = {}\n            table[ methodName ] = [ method, context ]\n\nUnbox a state-bound function unless directed otherwise.\n\n          if not boxed and method.type is 'state-bound-function'\n            method = method.fn\n\nExport `method` and `context` together if the `out` reference was provided.\n\n> Callers who know that `method` will be unbound need not provide an `out`.\n\n        if out?\n          out.method = method\n          out.context = context\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state. The provided `fn` may be any of:\n\n  1.  A proper function, which will be called in the context of `@owner`;\n  2.  A boxing of a *bound* function as prepared by `state.bind`, which will\n      cause the boxed function to be called in the context of either `this`\n      `State` or the *epistate* inheriting the method;\n  3.  A boxing of a *fixed* function as prepared by `state.fix`, whose boxed\n      function will be closed over hard references to `this` as `autostate`,\n      and to the *protostate* of `this`, as `protostate`.\n\n> See also: `state.bind`, `state.fix`\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` boxes a *state-fixed* function, then partially apply that function to\nextract the actual method, closed over references to the locality of `this`.\n\n        if typeof fn is 'object' and fn.type is 'state-fixed-function'\n          fn = fn.fn this, @protostate()\n\n        throw TypeError unless typeof fn is 'function' or\n          fn?.type is 'state-bound-function'\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root._?.methods?[ methodName ]\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n            root.addMethod methodName, ownerMethod\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context.\n\nIf the named method does not exist locally and cannot be inherited, then\n`noSuchMethod` events are emitted, and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n\nFirst try to resolve the method quickly from the local dispatch table.\n\n        if record = @_?.__dispatch_table__?[ methodName ]\n          [ method, context ] = record\n          method = method.fn if method?.type is 'state-bound-function'\n\nResort to a proper lookup if the fast way turns up nothing.\n\n        unless method?\n          if method = @method methodName, VIA_ALL, out = {}\n            { context } = out\n\nBail out gracefully if the method definitively cannot be resolved.\n\n          else\n            @emit 'noSuchMethod', [ methodName, args ]\n            @emit 'noSuchMethod:' + methodName, args\n            return\n\nIf at this point a `context` is provided, this means that `method` is a\nstate-bound function, and `context` will be the appropriately bound `State`. If\nno `context` exists, this means that `method` is a typical non-state-bound\nfunction, which is meant to be invoked in the usual fashion, just as if it were\ncalled directly as a method of `this` state\u2019s `owner`.\n\n        method.apply context or @owner, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e73f1ed4766b5e60d4fed11d632ec5eaed57429d","subject":"More jsdom","message":"More jsdom\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"server\/sandboxes.litcoffee","new_file":"server\/sandboxes.litcoffee","new_contents":"# Sandboxes\n\nThis module provides a method for creating sandboxed DOMs (using\n[jsdom](https:\/\/github.com\/tmpvar\/jsdom)). It augments the DOM with a\nfunctional [WebSocket](http:\/\/en.wikipedia.org\/wiki\/WebSocket) using\n[ws](https:\/\/github.com\/einaros\/ws\/), and generally makes spinning up arbitrary\nDOM contexts a pleasant breeze.\n\n    config = require 'config'\n    Promise = require 'bluebird'\n    WebSocket = require 'ws\/lib\/WebSocket'\n\n    errors = require 'errors'\n    logging = require 'logging'\n\n    {jsdom} = require 'jsdom'\n\nHax: Fix document.domain since jsdom has a stub here.\n\n    {HTMLDocument} = require 'jsdom\/lib\/jsdom\/living'\n    Object.defineProperties(\n      HTMLDocument.prototype\n      domain: get: -> 'localhost'\n    )\n\nThis class is responsible for creating and cleaning up DOMs, and provides\nsome methods to inspect the state of the document.\n\n    exports.Sandbox = class Sandbox\n\n## *constructor*\n\n*Spin up a DOM.*\n\n      constructor: ->\n\n        @_cleanupFunctions = []\n        @_window = null\n\n## Sandbox#close\n\n*Close a DOM.*\n\n      close: ->\n\nIf the window is already gone, nope out.\n\n        return Promise.resolve() unless @_window?\n\nRun all the registered cleanup functions.\n\n        Promise.all(\n          fn() for fn in @_cleanupFunctions\n\nSuppress cleanup errors.\n\n        ).catch(->\n\nActually close the window and null it out.\n\n        ).finally =>\n\n          @_window.close()\n          @_window = null\n\n## Sandbox#createDocument\n\n* (string) `html` - The HTML document.\n* (object) `options` - An options object which may contain the following\n  values:\n    * (string) `cookie` - Cookie string.\n    * (string) `cookieDomain` - The domain the cookie applies to.\n    * (string) `url` - The canonical URL of the HTML document.\n\n*Create a DOM from an HTML document.*\n\n      createDocument: (html, options = {}) ->\n\nSet up a DOM, forwarding our cookie.\n\n        document = jsdom(\n          html\n\n          cookie: options.cookie\n          cookieDomain: options.cookieDomain ? 'localhost'\n\n          url: options.url ? \"http:\/\/localhost:#{config.get 'packageSettings:shrub-http:port'}\/\"\n        )\n        @_window = window = document.defaultView\n\nCapture \"client\" console logs.\n\n        for level in ['info', 'log', 'debug', 'warn', 'error']\n          do (level) -> window.console[level] = (args...) ->\n\nMake errors as detailed as possible.\n\n            for arg, i in args\n              if arg instanceof Error\n                args[i] = errors.stack arg\n              else\n                arg\n\n            console[level] args...\n\nHack in WebSocket.\n\n        window.WebSocket = WebSocket\n\n        sandbox = this\n        new Promise (resolve, reject) ->\n\nWhen the window is loaded, we'll reject with any error, or resolve.\n\n          window.onload = ->\n\n            for documentError in window.document.errors ? []\n              if documentError.data?.error?\n                error = new Error \"#{documentError.message}\\n#{errors.stack documentError.data.error}\"\n\n            if error?\n              reject error\n            else\n              resolve sandbox\n\n## Sandbox#emitHtml\n\n*Emit the document as HTML.*\n\n      emitHtml: -> \"\"\"\n    <!doctype html>\n    #{@_window.document.innerHTML}\n    \"\"\"\n\n## Sandbox#registerCleanupFunction\n\n* (function) `fn` - The function to run when the sandbox is closing.\n\n*Register a function to run when the sandbox is closing.*\n\n      registerCleanupFunction: (fn) -> @_cleanupFunctions.push fn\n\n## Sandbox#url\n\n*The current URL the sandbox is at.*\n\n      url: -> @_window.location.href\n","old_contents":"# Sandboxes\n\nThis module provides a method for creating sandboxed DOMs (using\n[jsdom](https:\/\/github.com\/tmpvar\/jsdom)). It augments the DOM with a\nfunctional [WebSocket](http:\/\/en.wikipedia.org\/wiki\/WebSocket) using\n[ws](https:\/\/github.com\/einaros\/ws\/), and generally makes spinning up arbitrary\nDOM contexts a pleasant breeze.\n\n    config = require 'config'\n    Promise = require 'bluebird'\n    WebSocket = require 'ws\/lib\/WebSocket'\n\n    errors = require 'errors'\n    logging = require 'logging'\n\n    {jsdom} = require 'jsdom'\n\nHax: Fix document.domain since jsdom has a stub here.\n\n    {HTMLDocument} = require 'jsdom\/lib\/jsdom\/living'\n    Object.defineProperties(\n      HTMLDocument.prototype\n      domain: get: -> 'localhost'\n    )\n\nThis class is responsible for creating and cleaning up DOMs, and provides\nsome methods to inspect the state of the document.\n\n    exports.Sandbox = class Sandbox\n\n## *constructor*\n\n*Spin up a DOM.*\n\n      constructor: ->\n\n        @_cleanupFunctions = []\n        @_window = null\n\n## Sandbox#close\n\n*Close a DOM.*\n\n      close: ->\n\nIf the window is already gone, nope out.\n\n        return Promise.resolve() unless @_window?\n\nRun all the registered cleanup functions.\n\n        Promise.all(\n          fn() for fn in @_cleanupFunctions\n\nSuppress cleanup errors.\n\n        ).catch(->\n\nActually close the window and null it out.\n\n        ).finally =>\n\n          @_window.close()\n          @_window = null\n\n## Sandbox#createDocument\n\n* (string) `html` - The HTML document.\n* (object) `options` - An options object which may contain the following\n  values:\n    * (string) `cookie` - Cookie string.\n    * (string) `cookieDomain` - The domain the cookie applies to.\n    * (string) `url` - The canonical URL of the HTML document.\n\n*Create a DOM from an HTML document.*\n\n      createDocument: (html, options = {}) ->\n\nSet up a DOM, forwarding our cookie.\n\n        document = jsdom(\n          html, jsdom.defaultLevel\n\n          cookie: options.cookie\n          cookieDomain: options.cookieDomain ? 'localhost'\n\n          url: options.url ? \"http:\/\/localhost:#{config.get 'packageSettings:shrub-http:port'}\/\"\n        )\n        @_window = window = document.defaultView\n\nCapture \"client\" console logs.\n\n        for level in ['info', 'log', 'debug', 'warn', 'error']\n          do (level) -> window.console[level] = (args...) ->\n\nMake errors as detailed as possible.\n\n            for arg, i in args\n              if arg instanceof Error\n                args[i] = errors.stack arg\n              else\n                arg\n\n            console[level] args...\n\nHack in WebSocket.\n\n        window.WebSocket = WebSocket\n\n        sandbox = this\n        new Promise (resolve, reject) ->\n\nWhen the window is loaded, we'll reject with any error, or resolve.\n\n          window.onload = ->\n\n            for documentError in window.document.errors ? []\n              if documentError.data?.error?\n                error = new Error \"#{\n                  documentError.message\n                }\\n#{\n                  errors.stack documentError.data.error\n                }\"\n\n            if error?\n              reject error\n            else\n              resolve sandbox\n\n## Sandbox#emitHtml\n\n*Emit the document as HTML.*\n\n      emitHtml: -> \"\"\"\n    <!doctype html>\n    #{@_window.document.innerHTML}\n    \"\"\"\n\n## Sandbox#registerCleanupFunction\n\n* (function) `fn` - The function to run when the sandbox is closing.\n\n*Register a function to run when the sandbox is closing.*\n\n      registerCleanupFunction: (fn) -> @_cleanupFunctions.push fn\n\n## Sandbox#url\n\n*The current URL the sandbox is at.*\n\n      url: -> @_window.location.href\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5cfd797a4e269e8c74a5af53677291b8ba0d0290","subject":"structre webpack.config","message":"structre webpack.config\n","repos":"duereg\/tile-thinger,glebm\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,duereg\/tile-thinger,vmlinz\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template","old_file":"webpack.config.litcoffee","new_file":"webpack.config.litcoffee","new_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc).\nIt also manages loading via JavaScript `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    path    = require('path')\n    webpack = require('webpack')\n    _       = require('lodash')\n\n\nDefine an empty configuration\n\n    module.exports = {}\n\nList bundle entry points, i.e. packages to compile in the distribution. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n    module.exports.entry =\n      main             : \".\/src\/scripts\/main.litcoffee\"\n      \"styles\"         : \".\/src\/styles\/styles.scss\"\n      \"vendor\/es5-shim\": \".\/bower_components\/es5-shim\/es5-shim.js\"\n      \"vendor\/es5-sham\": \".\/bower_components\/es5-shim\/es5-sham.js\"\n\n\nThen, define how files should be loaded (required) based on the extension:\n\n### Scripts\n\nProcess CoffeeScript and JSX in CoffeeScript and JavaScript.\n\n    scriptModLoaders = [\n      { test: \/\\.coffee$\/, loader: \"jsx!coffee\" }\n      { test: \/\\.litcoffee$\/, loader: \"jsx!coffee?literate\"}\n      { test: \/\\.js$\/, loader: \"jsx\" }\n    ]\n\n### Styles\n\nProcess with Sass and Autoprefixer.\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?last 2 versions']\n    styleModLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\"sass?precision=10&outputStyle=expanded&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/, loaders: cssLoaders }\n    ]\n\n### Static assets\n\nEmbed data-URLs into CSS and JS for small images and `.woff` fonts:\n\n    staticModLoaders = [\n      { test: \/\\.gif$\/, loader: \"url?limit=10000&mimetype=image\/gif\" }\n      { test: \/\\.jpg$\/, loader: \"url?limit=10000&mimetype=image\/jpg\" }\n      { test: \/\\.png$\/, loader: \"url?limit=10000&mimetype=image\/png\" }\n      { test: \/\\.woff$\/, loader: \"url?limit=10000&mimetype=application\/font-woff\" }\n      { test: \/\\.ttf$\/, loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n      { test: \/\\.eot$\/, loader: \"file?mimetype=application\/x-font-ttf\" }\n      { test: \/\\.svg$\/, loader: \"file?mimetype=image\/svg+xml\" }\n    ]\n\n### Output CSS to `.css` files\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not as `.js` files with embedded CSS strings.\n\nRequire the plugin:\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n\nSet `styleModLoaders` to use the plugin:\n\n    styleModLoaders = styleModLoaders.map (e) ->\n      { test: e.test, loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!')) }\n\nCreate an instance of the extractTextPlugin:\n\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\n### Define macro variables\n\n`DefinePlugin` defines variables to be substituted in the assets (a la macro).\n\nDefine `__PRODUCTION__: false` variable (set to true on `useProductionSettings()`):\n\n    definePlugin = new webpack.DefinePlugin(\n      __PRODUCTION__: JSON.stringify(false)\n    )\n\n### Other options\n\n    _.merge module.exports,\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n\nOutput options:\n\n      output:\n        path         : path.join(__dirname, \"dist\", \"assets\")\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: ['bower_components', 'node_modules']\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleModLoaders.concat(scriptModLoaders).concat(staticModLoaders)\n        noParse: \/\\.min\\.js$\/\n\nDefine the plugins:\n\n      plugins: [\n\n`definePlugin` defines variables to be substituted in the assets (a la macro):\n\n        definePlugin\n\n`extractTextPlugin` (defined above) will compile CSS to a .css file, as opposed to inlining it as a string in a .js file.\n\n        extractTextPlugin\n      ]\n\n\n## Production overrides\n\nExport a method that applies production settings (used in gulpfile):\n\n      useProductionSettings: ->\n\nProduction plugins:\n\n        plugins = @plugins.concat [\n\nMinify JavaScript with UglifyJS:\n\n          new webpack.optimize.UglifyJsPlugin()\n        ]\n\nSet `__PRODUCTION__` to true in the `DefinePlugin` instance:\n\n        definePlugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\nTell `ExtractTextPlugin` to append hashes (BROKEN, see [plugin issue #9](https:\/\/github.com\/webpack\/extract-text-webpack-plugin\/issues\/9)):\n\n        extractTextPlugin.filename = '[name]-[hash].css'\n\nMerge in production config (deep merge):\n\n        _.merge @,\n\nDisable development settings:\n\n          debug: false\n          watch: false\n          devtool: null\n\nAdd content hashes to the output filenames:\n\n          output:\n            filename: \"[name]-[hash].js\"\n\nProduction-only plugins:\n\n          plugins: plugins\n","old_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc).\nIt also manages loading via JavaScript `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    path    = require('path')\n    webpack = require('webpack')\n    _       = require('lodash')\n\n## Prepare CSS configuration\n\nList of loader names for CSS files:\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?last 2 versions']\n\nStyle module loaders (used later):\n\n    styleLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\"sass?precision=10&outputStyle=expanded&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/, loaders: cssLoaders }\n    ]\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not `.js` files. Create plugin instance (used later):\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\nOverride style loaders to use `ExtractTextPlugin`:\n\n    styleLoaders = styleLoaders.map (e) ->\n      test: e.test\n      loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!'))\n\n## Export configuration\n\n    module.exports =\n\nList of bundle entry points, i.e. packages to compile in the distribution. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n      entry:\n        main             : \".\/src\/scripts\/main.litcoffee\"\n        \"styles\"         : \".\/src\/styles\/styles.scss\"\n        \"vendor\/es5-shim\": \".\/bower_components\/es5-shim\/es5-shim.js\"\n        \"vendor\/es5-sham\": \".\/bower_components\/es5-shim\/es5-sham.js\"\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n\nOutput options:\n\n      output:\n        path         : path.join(__dirname, \"dist\", \"assets\")\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: ['bower_components', 'node_modules']\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleLoaders.concat [\n          { test: \/\\.gif$\/, loader: \"url?limit=10000&minetype=image\/gif\" }\n          { test: \/\\.jpg$\/, loader: \"url?limit=10000&minetype=image\/jpg\" }\n          { test: \/\\.png$\/, loader: \"url?limit=10000&minetype=image\/png\" }\n          { test: \/\\.js$\/, loader: \"jsx\" }\n          { test: \/\\.coffee$\/, loader: \"jsx!coffee\" }\n          { test: \/\\.litcoffee$\/, loader: \"jsx!coffee?literate\"}\n          # url-loader embeds DataUrls.\n          { test: \/\\.woff$\/, loader: \"url?limit=10000&minetype=application\/font-woff\" }\n          # file-loader emits files.\n          { test: \/\\.ttf$\/, loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n          { test: \/\\.eot$\/, loader: \"file?mimetype=application\/x-font-ttf\" }\n          { test: \/\\.svg$\/, loader: \"file?mimetype=image\/svg+xml\" }\n        ]\n        noParse: \/\\.min\\.js$\/\n\nDefine the plugins:\n\n      plugins: [\n\n`DefinePlugin` defines a variable that will be substituted in the assets (a la macro):\n\n        new webpack.DefinePlugin(__PRODUCTION__: JSON.stringify(false))\n\n`extractTextPlugin` (defined above) will compile CSS to a .css file, as opposed to inlining it as a string in a .js file.\n\n        extractTextPlugin\n      ]\n\n\n## Production overrides\n\nExport a method that applies production settings (used in gulpfile):\n\n      useProductionSettings: ->\n\nProduction plugins:\n\n        plugins = @plugins.concat [\n\nMinify JavaScript with UglifyJS:\n\n          new webpack.optimize.UglifyJsPlugin()\n        ]\n\nSet `__PRODUCTION__` to true in the `DefinePlugin` instance:\n\n        for plugin in plugins when plugin.definitions?.__PRODUCTION__\n          plugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\nTell `ExtractTextPlugin` to append hashes (BROKEN, see [plugin issue #9](https:\/\/github.com\/webpack\/extract-text-webpack-plugin\/issues\/9)):\n\n        for plugin in plugins when plugin.filename == '[name].css'\n          plugin.filename = '[name]-[hash].css'\n\nMerge in production config (deep merge):\n\n        _.merge @,\n\nDisable development settings:\n\n          debug: false\n          watch: false\n          devtool: null\n\nAdd content hashes to the output filenames:\n\n          output:\n            filename: \"[name]-[hash].js\"\n\nProduction-only plugins:\n\n          plugins: plugins\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ba8641cf81da247f103a0b231e0be073a87e8e2a","subject":"Add some docs for data-yield and data-contentfor","message":"Add some docs for data-yield and data-contentfor\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a nodes child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it being visible until ready.\n\n## data-yield\n\n`data-yield` is used for binging HTML from views into the document. By default `data-yield=\"main\"` will bind view HTML based on the current controller and action. You can also define HTML templates using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` provides the keypath for which child nodes are bound to for use in a `data-yield`.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","old_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a nodes child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it being visible until ready.\n\n## data-yield\n\n## data-contentfor\n\n# Batman.View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b287bd8ae127c97b7fedc6bf25424277219779cd","subject":"Add tests for set operations","message":"Add tests for set operations\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/05c_binary_set_operations.litcoffee","new_file":"docs\/05c_binary_set_operations.litcoffee","new_contents":"# \/api\/Data Structures\/Batman.BinarySetOperation\n\n`Batman.BinarySetOperation` extends `Batman.Set` and tracks _two_ `Batman.Set`s and updates its contents whenever an item is added to or removed from either set. `Batman.BinarySetOperation` is an abstract class. It is extended by `Batman.SetUnion`, `Batman.SetIntersection`, and `Batman.SetComplement`.\n\n## ::constructor(left: Set, right: Set) : BinarySetOperation\n\nReturns a new `BinarySetOperation` between `left` and `right`.\n\n## ::merge(others... : Set) : Set\n\nReturns a new `Batman.Set` with the contents of the `BinarySetOperation` plus the contents of `others`.\n\n## ::filter(func: Function) : Set\n\nExecutes `func(item)` for each item in the `BinarySetOperation` and returns a new `Batman.Set` with items where `func(item)` returned a truthy value.\n\n## ::.left : Set\n\nReturns the first `Batman.Set` passed to the constructor.\n\n## ::.right : Set\n\nReturns the second `Batman.Set` passed to the constructor.\n\n\n# \/api\/Data Structures\/Batman.BinarySetOperation\/Batman.SetUnion\n\n`Batman.SetUnion` extends `Batman.BinarySetOperation`. It implements a [union operation](http:\/\/en.wikipedia.org\/wiki\/Union_%28set_theory%29): the `SetUnion` contains members found in _either set_ passed to the constructor, without duplicates.\n\nSince `Batman.SetUnion` is a subclass of `Batman.Set`, you can use it just like a `Batman.Set`.\n\n    test 'SetUnion contains the union of two sets', ->\n      left = new Batman.Set(1, 2, 3)\n      right = new Batman.Set(3, 4, 5)\n      operation = new Batman.SetUnion(left, right)\n      ok operation.has(1), 'has items from the left set'\n      ok operation.has(4), 'has items from the right set'\n      ok operation.has(3), 'has items from both sets'\n\n\n# \/api\/Data Structures\/Batman.BinarySetOperation\/Batman.SetIntersection\n\n`Batman.SetIntersection` extends `Batman.BinarySetOperation`. It implements an [intersection operation](http:\/\/en.wikipedia.org\/wiki\/Intersection_%28set_theory%29): it contains members of _both sets_ passed to its constructor without duplicates.\n\nSince `Batman.SetIntersection` is a subclass of `Batman.Set`, you can use it just like a `Batman.Set`.\n\n    test 'SetIntersection contains the intersection of two sets', ->\n      left = new Batman.Set(1, 2, 3)\n      right = new Batman.Set(3, 4, 5)\n      operation = new Batman.SetIntersection(left, right)\n      ok !operation.has(1), 'doesnt have items from the left set only'\n      ok !operation.has(4), 'doesnt have items from the right set only'\n      ok operation.has(3), 'has items from both sets'\n\n# \/api\/Data Structures\/Batman.BinarySetOperation\/Batman.SetComplement\n\n`Batman.SetComplement` extends `Batman.BinarySetOperation`. It implements a [complement operation](http:\/\/en.wikipedia.org\/wiki\/Complement_%28set_theory%29): it contains the members of _`left`_ which aren't in _`right`_.\n\nSince `Batman.SetComplement` is a subclass of `Batman.Set`, you can use it just like a `Batman.Set`.\n\n    test 'SetComplement contains the complement of two sets', ->\n      left = new Batman.Set(1, 2, 3)\n      right = new Batman.Set(3, 4, 5)\n      operation = new Batman.SetComplement(left, right)\n      ok operation.has(1), 'has items from the left set only'\n      ok !operation.has(4), 'doesnt have items from the right set only'\n      ok !operation.has(3), 'doesnt have items from both sets'\n","old_contents":"# \/api\/Data Structures\/Batman.BinarySetOperation\n\n`Batman.BinarySetOperation` extends `Batman.Set` and tracks _two_ `Batman.Set`s and updates its contents whenever an item is added to or removed from either set. `Batman.BinarySetOperation` is an abstract class. It is extended by `Batman.SetUnion`, `Batman.SetIntersection`, and `Batman.SetComplement`.\n\n## ::constructor(left: Set, right: Set) : BinarySetOperation\n\nReturns a new `BinarySetOperation` between `left` and `right`.\n\n## ::merge(others... : Set) : Set\n\nReturns a new `Batman.Set` with the contents of the `BinarySetOperation` plus the contents of `others`.\n\n## ::filter(func: Function) : Set\n\nExecutes `func(item)` for each item in the `BinarySetOperation` and returns a new `Batman.Set` with items where `func(item)` returned a truthy value.\n\n## ::.left : Set\n\nReturns the first `Batman.Set` passed to the constructor.\n\n## ::.right : Set\n\nReturns the second `Batman.Set` passed to the constructor.\n\n\n# \/api\/Data Structures\/Batman.BinarySetOperation\/Batman.SetUnion\n\n`Batman.SetUnion` extends `Batman.BinarySetOperation`. It implements a [union operation](http:\/\/en.wikipedia.org\/wiki\/Union_%28set_theory%29): the `SetUnion` contains members found in _either set_ passed to the constructor, without duplicates.\n\nSince `Batman.SetUnion` is a subclass of `Batman.Set`, you can use it just like a `Batman.Set`.\n\n# \/api\/Data Structures\/Batman.BinarySetOperation\/Batman.SetIntersection\n\n`Batman.SetIntersection` extends `Batman.BinarySetOperation`. It implements an [intersection operation](http:\/\/en.wikipedia.org\/wiki\/Intersection_%28set_theory%29): it contains members of _both sets_ passed to its constructor without duplicates.\n\nSince `Batman.SetIntersection` is a subclass of `Batman.Set`, you can use it just like a `Batman.Set`.\n\n# \/api\/Data Structures\/Batman.BinarySetOperation\/Batman.SetComplement\n\n`Batman.SetComplement` extends `Batman.BinarySetOperation`. It implements a [complement operation](http:\/\/en.wikipedia.org\/wiki\/Complement_%28set_theory%29): it contains the members of _`left`_ which aren't in _`right`_.\n\nSince `Batman.SetComplement` is a subclass of `Batman.Set`, you can use it just like a `Batman.Set`.\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9efe557b38a83d2cae632737654b85bf59fd4bfa","subject":"Added functions to handle angles.","message":"Added functions to handle angles.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/misc.litcoffee","new_file":"src\/misc.litcoffee","new_contents":"# misc\n\n## interpolate\n\n- from: A number to interpolate from.\n- to: A number to interpolate to.\n- alpha: A number, where \"0\" is \"from\" and \"1\" is \"to\".\n\nReturns the linear interpolation or extrapolation from \"from\" to \"to\".\n\n    interpolate = (from, to, alpha) -> from + (to - from) * alpha\n    \n## wrapAngle\n\n- radians: A number of radians to wrap.\n\nReturns the input wrapped to the 0...2PI range.\n\n    wrapAngle = (radians) -> radians - (Math.PI * 2 * Math.floor (radians \/ (Math.PI * 2)))\n    \n## interpolateAngle\n\n- from: A number of radians to interpolate from.\n- to: A number of radians to interpolate to.\n- alpha: A number, where \"0\" is \"from\" and \"1\" is \"to\".\n\nReturns the linear interpolation or extrapolation from \"from\" to \"to\".  Can\nshortcut over the 0\/2PI boundary.\n\n    interpolateAngle = (from, to, alpha) -> \n        from = wrapAngle from\n        to = wrapAngle to\n        if from < Math.PI \/ 2 and to > Math.PI * 1.5\n            to -= Math.PI * 2\n        else if to < Math.PI \/ 2 and from > Math.PI * 1.5\n            to += Math.PI * 2\n        wrapAngle (from + (to - from) * alpha)\n        \n    module.exports = { interpolate, wrapAngle, interpolateAngle }","old_contents":"\n\tmodule.exports = \n\nCall the \"interpolate\" property with a number to interpolate from, a number to\ninterpolate to, and a number specifying the alpha (0 is from, 1 is to) to return\nthe linearly interpolated, or extrapolated number.\n\n\t\tinterpolate: (from, to, alpha) -> from + (to - from) * alpha","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"17f0cb75e9aaf7866ff62d8e10edbe35511f49d2","subject":"Load render pipeline passed via input","message":"Load render pipeline passed via input\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/cli.litcoffee","new_file":"lib\/cli.litcoffee","new_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    Madul = require 'madul'\n\n    if process.env.SKYLL_MADUL_LOGGING == 'true'\n      require 'magnus'\n\n    Skyll = require '.\/index'\n    args  = require '.\/arguments'\n    uuid  = require 'node-uuid'\n    fs    = require 'fs'\n    path  = require 'path'\n\n    EXTRACT = [\n      'rows'\n      'columns'\n      'width'\n      'height'\n      'multiplier'\n      'pipeline'\n      'block'\n      'ground'\n      'step_count'\n      'wall'\n    ]\n\n    new Skyll()\n      .initialize args\n      .then (mod) ->\n        levels = [ ]\n\n        if args._?.length > 0\n          levels = levels.concat argv._\n        else if args.l?\n          for level in [0...argv.l]\n            levels.push uuid.v4()\n        else if Array.isArray args.levels\n          for level in args.levels\n            levels.push level\n        else if args.levels? == false\n          levels.push new Date().toString()\n\n        if args.delegates?\n          location = args.delegates\n        else\n          location = path.join __dirname, 'delegates.js'\n\n        fs.stat location, (err) ->\n          if err?\n            mod.warn 'file-not-found', location\n          else\n            delegates = require location\n            next      = 0\n            input     = { }\n            pipe      = [ ]\n\n            for own key, val of args\n              input[key] = val if EXTRACT.includes key\n\n            for p in input.pipeline\n              if Array.isArray p\n                for q in p\n                  pipe.push(q) unless pipe.includes q\n              else\n                pipe.push(p) unless pipe.includes p\n\n            Madul.DUMMY pipe, (dum) ->\n              dum.render_pipeline = [ ]\n\n              for p in input.pipeline\n                if Array.isArray p\n                  new_pipeline = for q in p\n                    dum[Madul.PARSE_SPEC(q).ref]\n\n                  dum.render_pipeline.push new_pipeline\n                else\n                  dum.render_pipeline.push dum[Madul.PARSE_SPEC(p).ref]\n\n              args = { }\n              name = new Date().toString()\n\n              for own key, val of input\n                args[key] = val if EXTRACT.includes key\n\n              render = (level) ->\n                mod.craft level, input, dum.render_pipeline, delegates\n                  .then -> render levels[next] if ++next < levels.length\n\n              render levels[next]\n","old_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    Madul = require 'madul'\n\n    if process.env.SKYLL_MADUL_LOGGING == 'true'\n      require 'magnus'\n\n    Skyll = require '.\/index'\n    args  = require '.\/arguments'\n    uuid  = require 'node-uuid'\n    fs    = require 'fs'\n    path  = require 'path'\n\n    EXTRACT = [\n      'rows'\n      'columns'\n      'width'\n      'height'\n      'multiplier'\n      'pipeline'\n      'block'\n      'ground'\n      'step_count'\n      'wall'\n    ]\n\n    new Skyll()\n      .initialize args\n      .then (mod) ->\n        levels = [ ]\n\n        if args._?.length > 0\n          levels = levels.concat argv._\n        else if args.l?\n          for level in [0...argv.l]\n            levels.push uuid.v4()\n        else if Array.isArray args.levels\n          for level in args.levels\n            levels.push level\n        else if args.levels? == false\n          levels.push new Date().toString()\n\n        if args.delegates?\n          location = args.delegates\n        else\n          location = path.join __dirname, 'delegates.js'\n\n        fs.stat location, (err) ->\n          if err?\n            mod.warn 'file-not-found', location\n          else\n            delegates = require location\n            next      = 0\n            input     = { }\n            pipe      = [ ]\n\n            for own key, val of args\n              input[key] = val if EXTRACT.includes key\n\n\n            Madul.DUMMY pipe, (dum) ->\n              dum.render_pipeline = [ ]\n\n              for p in input.pipeline\n                if Array.isArray p\n                  new_pipeline = for q in p\n                    dum[Madul.PARSE_SPEC(q).ref]\n\n                  dum.render_pipeline.push new_pipeline\n                else\n                  dum.render_pipeline.push dum[Madul.PARSE_SPEC(p).ref]\n\n              args = { }\n              name = new Date().toString()\n\n              for own key, val of input\n                args[key] = val if EXTRACT.includes key\n\n              render = (level) ->\n                mod.craft level, input, dum.render_pipeline, delegates\n                  .then -> render levels[next] if ++next < levels.length\n\n              render levels[next]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f344f39d9443f0c30240d1f636b40bc3d66388c6","subject":"modify README","message":"modify README\n","repos":"CureApp\/loopback-with-admin","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\n\n# install\n\n```\nnpm install loopback-with-domain\n```\n\n\n# run\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    config =\n        admin:\n            accessToken: 'Your Secret Value Here'\n        server:\n            port: 4000\n\n    lbWithDomain.runWithDomain(domain, config).then ->\n        # loopback started\n\n\n# configs\n\nsee JSON files in \"default-configs\" directory.\nyou can set the same properties as these JSONs.\n\n## server\n\n config name | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n## admin\n\n config name | meaning               | default\n-------------|-----------------------|----------------------------\n accessToken | accessToken for admin | (you must set access token)\n\n\n","old_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\n\n# install\n\n```\nnpm install loopback-with-domain\n```\n\n\n# run\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    config =\n        admin:\n            accessToken: 'Your Secret Value Here'\n        server:\n            port: 4000\n\n    lbWithDomain.runWithDomain(domain, config).then ->\n        # loopback started\n\n\n# configs\n\n## server\n\n config name | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n## admin\n\n config name | meaning               | default\n-------------|-----------------------|----------------------------\n accessToken | accessToken for admin | (you must set access token)\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ea160e405b66f02a5c4004f1c58b76ff678e52c6","subject":"Convert the day sched display to use the new helper","message":"Convert the day sched display to use the new helper\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/managers\/day-sched.litcoffee","new_file":"src\/coffee\/managers\/day-sched.litcoffee","new_contents":"Day Schedule Table Manager\n==========================\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe are interested in two key nuggets of input information: the full day\nschedule, and the current item within it.\n\n        inputStream = Bacon.combineTemplate\n            schedule: Data.daySchedule\n            current: CurrentDSItem\n\nTable Management\n----------------\n\nWe use D3 to set the data within the table.\n\n\n        nodeHTML = (entry) ->\n            dateString = FormatTime(FromUNIX(entry.start), false)\n            \"<td>#{dateString}<\/td>\n             <td>#{entry.displayName}<\/td>\"\n\n        inputStream.onValue (state) ->\n            DisplayInformation '#day-sched-table',\n                               state.schedule,\n                               'tr', nodeHTML,\n                               (nodes) ->\n                                   nodes.classed 'info', (entry) ->\n                                       entry.key == state.current?.key\n\n","old_contents":"Day Schedule Table Manager\n==========================\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe are interested in two key nuggets of input information: the full day\nschedule, and the current item within it.\n\n        inputStream = Bacon.combineTemplate\n            schedule: Data.daySchedule\n            current: CurrentDSItem\n\nTable Management\n----------------\n\nWe use D3 to set the data within the table.\n\n\n        nodeHTML = (entry) ->\n            dateString = FormatTime(FromUNIX(entry.start), false)\n            \"<td>#{dateString}<\/td>\n             <td>#{entry.displayName}<\/td>\"\n\n        inputStream.onValue (state) ->\n            tableNodes = d3.select('#day-sched-table')\n                           .selectAll('tr')\n                           .data(state.schedule)\n                           .html(nodeHTML)\n                           .classed 'info', (entry) ->\n                               entry.key == state.current?.key\n\n            tableNodes.enter()\n                      .append('tr')\n                      .html(nodeHTML)\n                      .classed 'info', (entry) ->\n                          entry.key == state.current?.key\n\n            tableNodes.exit()\n                      .remove()\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a4b40db1d1a8fd83e25e7b6cae6c3445453919fb","subject":"Improve JS documentation","message":"Improve JS documentation\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/js\/be.bastelstu.wcf.nodePush.litcoffee","new_file":"file\/js\/be.bastelstu.wcf.nodePush.litcoffee","new_contents":"Frontend JavaScript for nodePush\n================================\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\nEnsure sane values for `$` and `window`\n\n\t(($, window) ->\n\t\t# Enable strict mode\n\t\t\"use strict\";\n\t\t\n\t\t# Ensure our namespace is present\n\t\twindow.be ?= {}\n\t\tbe.bastelstu ?= {}\n\t\tbe.bastelstu.wcf ?= {}\n\nOverwrite `console` to add the origin in front of the message\n\n\t\tconsole =\n\t\t\tlog: (message) ->\n\t\t\t\twindow.console.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\twarn: (message) ->\n\t\t\t\twindow.console.warn \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\terror: (message) ->\n\t\t\t\twindow.console.error \"[be.bastelstu.wcf.nodePush] #{message}\"\n\nbe.bastelstu.Chat\n=================\n\nPrivate Attributes\n------------------\n\n\t\tsocket = null\n\t\tconnected = false\n\t\tinitialized = false\n\t\tevents =\n\t\t\tconnect: $.Callbacks()\n\t\t\tdisconnect: $.Callbacks()\n\t\t\tmessage: { }\n\t\t\n\t\tbe.bastelstu.wcf.nodePush = \n\nMethods\n-------\n\n**init(host)**  \nInitialize socket.io to enable nodePush.\n\n\t\t\tinit: (host) ->\n\t\t\t\treturn if initialized\n\t\t\t\tinitialized = true\n\t\t\t\tconsole.log 'Initializing nodePush'\n\t\t\t\t\n\t\t\t\tunless window.io?\n\t\t\t\t\tconsole.error 'nodePush not available, aborting'\n\t\t\t\t\treturn\n\t\t\t\t\t\n\t\t\t\tsocket = window.io.connect host\n\t\t\t\t\n\t\t\t\tsocket.on 'connect', =>\n\t\t\t\t\tconnected = true\n\t\t\t\t\tconsole.log 'Connected to nodePush'\n\t\t\t\t\tevents.connect.fire()\n\t\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\tconnected = false\n\t\t\t\t\tconsole.warn 'Lost connection to nodePush'\n\t\t\t\t\tevents.disconnect.fire()\n\t\t\t\t\n\t\t\t\tsocket.on 'message', (message) =>\n\t\t\t\t\treturn unless events.message[message]?\n\t\t\t\t\t\n\t\t\t\t\tevents.message[message].fire()\n\n**onConnect(callback)**  \nAdds a new `callback` that will be called when a connection to nodePush is established. The given \n`callback` will be called once if a connection is established at time of calling. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonConnect: (callback) ->\n\t\t\t\treturn false unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.connect.add callback\n\t\t\t\t\n\t\t\t\tcallback() if connected\n\t\t\t\ttrue\n\n**onDisconnect(callback)**  \nAdds a new `callback` that will be called when the connection to nodePush is lost. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonDisconnect: (callback) ->\n\t\t\t\treturn false unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.disconnect.add callback\n\t\t\t\ttrue\n\n**onMessage(message, callback)**  \nAdds a new `callback` that will be called when the specified `message` is received. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonMessage: (message, callback) ->\n\t\t\t\tfalse unless $.isFunction callback\n\t\t\t\tfalse unless \/[a-zA-Z0-9-_.]+$\/.test message\n\t\t\t\t\n\t\t\t\tevents.message[message] ?= $.Callbacks()\n\t\t\t\tevents.message[message].add callback\n\t\t\t\ttrue\n\t\t\t\n\t)(jQuery, @)\n","old_contents":"Frontend JavaScript for nodePush\n================================\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\nEnsure sane values for `$` and `window`\n\n\t(($, window) ->\n\t\t# Enable strict mode\n\t\t\"use strict\";\n\t\t\n\t\t# Ensure our namespace is present\n\t\twindow.be ?= {}\n\t\tbe.bastelstu ?= {}\n\t\tbe.bastelstu.wcf ?= {}\n\nOverwrite `console` to add the origin in front of the message\n\n\t\tconsole =\n\t\t\tlog: (message) ->\n\t\t\t\twindow.console.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\twarn: (message) ->\n\t\t\t\twindow.console.warn \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\terror: (message) ->\n\t\t\t\twindow.console.error \"[be.bastelstu.wcf.nodePush] #{message}\"\n\nbe.bastelstu.Chat\n=================\n\nPrivate Attributes\n------------------\n\n\t\tsocket = null\n\t\tconnected = false\n\t\tinitialized = false\n\t\tevents =\n\t\t\tconnect: $.Callbacks()\n\t\t\tdisconnect: $.Callbacks()\n\t\t\tmessage: { }\n\t\t\n\t\tbe.bastelstu.wcf.nodePush = \n\nMethods\n-------\n\n**init(host)**  \nInitialize socket.io to enable nodePush.\n\n\t\t\tinit: (host) ->\n\t\t\t\treturn if initialized\n\t\t\t\tinitialized = true\n\t\t\t\tconsole.log 'Initializing nodePush'\n\t\t\t\t\n\t\t\t\tunless window.io?\n\t\t\t\t\tconsole.error 'nodePush not available, aborting'\n\t\t\t\t\treturn\n\t\t\t\t\t\n\t\t\t\tsocket = window.io.connect host\n\t\t\t\t\n\t\t\t\tsocket.on 'connect', =>\n\t\t\t\t\tconnected = true\n\t\t\t\t\tconsole.log 'Connected to nodePush'\n\t\t\t\t\tevents.connect.fire()\n\t\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\tconnected = false\n\t\t\t\t\tconsole.warn 'Lost connection to nodePush'\n\t\t\t\t\tevents.disconnect.fire()\n\t\t\t\t\n\t\t\t\tsocket.on 'message', (message) =>\n\t\t\t\t\treturn unless events.message[message]?\n\t\t\t\t\t\n\t\t\t\t\tevents.message[message].fire()\n\n**onConnect(callback)**  \nAdds a new callback that will be called when a connection to nodePush is established. The given \ncallback will be called once if a connection is established at time of calling.\n\n\t\t\tonConnect: (callback) ->\n\t\t\t\treturn unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.connect.add callback\n\t\t\t\t\n\t\t\t\tcallback() if connected\n\t\t\t\tundefined\n\n**onDisconnect(callback)**  \nAdds a new callback that will be called when the connection to nodePush is lost.\n\n\t\t\tonDisconnect: (callback) ->\n\t\t\t\treturn unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.disconnect.add callback\n\t\t\t\tundefined\n\n**onMessage(message, callback)**  \nAdds a new callback that will be called when the specified message is received. \n\n\t\t\tonMessage: (message, callback) ->\n\t\t\t\treturn unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.message[message] ?= $.Callbacks()\n\t\t\t\tevents.message[message].add callback\n\t\t\t\tundefined\n\t\t\t\n\t)(jQuery, @)\n","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"986f959f81189eb71d63a12fbd57f184382f4998","subject":"Return image exifdata","message":"Return image exifdata\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/server.litcoffee","new_file":"src\/server.litcoffee","new_contents":"    compression  = require 'compression'\n    express      = require 'express'\n    errorHandler = require 'errorhandler'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      if not req.get('Origin') or not (req.get('Origin') in origins)\n        return res.status(403).json message: 'Bad Origin Header'\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        # @TODO check if file is valid image\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use raven.middleware.express sentry\n    app.use errorHandler dumpExceptions: true, showStack: true\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","old_contents":"    compression  = require 'compression'\n    express      = require 'express'\n    errorHandler = require 'errorhandler'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      if not req.get('Origin') or not (req.get('Origin') in origins)\n        return res.status(403).json message: 'Bad Origin Header'\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        # @TODO check if file is valid image\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n          return cb null, images.splice(1)\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use raven.middleware.express sentry\n    app.use errorHandler dumpExceptions: true, showStack: true\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1833053244cca0b016f0d75d8d00c0f0bc5c9e6f","subject":"Updated docs so the examples are not executed as tests","message":"Updated docs so the examples are not executed as tests\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08_app.litcoffee","new_file":"docs\/08_app.litcoffee","new_contents":"# \/api\/App Components\/Batman.App\n\n`Batman.App` manages routing and action dispatching, as well as the initial start of the application. It is also the namespace for all `Batman.Model`s, `Batman.Controller`s, and `Batman.View`s. Only one `Batman.App` can be running on a page.\n\nA batman.js application extends `Batman.App`. It is never instantiated and it is started by calling `run`.\n\n```coffeescript\nclass @MyApp extends Batman.App\n  @root 'blogPosts#index'\n\n  @on 'run', -> alert(\"Welcome to my blog!\")\n\nclass MyApp.BlogPostsController extends Batman.Controller\n  index: -> @set('blogPosts', MyApp.BlogPost.get('all'))\n\nclass MyApp.BlogPost extends Batman.Model\n  # model definition ...\n\nMyApp.run()\n```\n\nSee [`Batman.App` routing](\/docs\/api\/batman.app_routing.html) for information about batman.js routing.\n\n## @%current : App\n\nThe currently-running `Batman.App`. Also available at `Batman.currentApp`.\n\n## @run()\n\nInitializes the `Batman.App` class by:\n\n- Closing any already-running apps\n- Creates its [`dispatcher`](\/docs\/api\/batman.app.html#class_accessor_navigator) and [`navigator`](\/docs\/api\/batman.app.html#class_accessor_navigator) and starts the navigator.\n- Instantiating the `layout` view according to the `layout` property on the `App`\n- Emitting `run`\n\n`@run` can be called before or on the `load` DOMEvent of the window.\n\n```coffeescript\n# JavaScript:\nwindow.addEventListener 'load', ->\n  MyApp.run()\n# or jQuery:\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\nStops the `App`. The URL will stop being monitored and no more actions will be dispatched. You generally shouldn't have to call this.\n\n## @%routes : NamedRouteQuery\n\nReturns the `Batman.NamedRouteQuery` which allows for binding to routes on objects. See the [`data-route` binding](batman.view_bindings.html#data-route) for more information.\n\n## @%controllers : ControllerDirectory\n\nReturns the `Batman.ControllerDirectory` for application. `Batman.Controller` instances are accessible at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n    test \"Multi-word controller names have a lowercase first letter\", ->\n      class Alfred extends Batman.App\n      class Alfred.ReminderEmailsController extends Batman.Controller\n      controller = Alfred.get('controllers.reminderEmails')\n      equal Batman._functionName(controller.constructor), \"ReminderEmailsController\"\n\n_Note:_ `@controllers` should not be observed, but it is very useful for debugging.\n\n## @.layout\n\n`@layout` is the base view of the entire view hierarchy. By default, it will parse any `data-*` attributes in the entire document, excluding any `data-yield`'s, when `App.run()` is called. Use `MyApp.layout = null` to disable the creation of this default view.\n\n## @%currentURL : String\n\nThe request path relative to `Batman.config.pathToApp`, including query string.\n\n## @%currentParams : Batman.Params\n\nReturns the URL parameters for the current request, including the path relative to the app's base path (`Batman.config.pathToApp`). It includes named parameters (eg `id` from `\/items\/:id`), query string parameters (eg `key` of `?key=value`).\n\n`currentParams` also offers a way to change the current request URL's parameters without refreshing or reloading anything on the page. This way you can influence data on the page and allow your users to get the same data on hard refreshes. Here's an example:\n\n```coffeescript\nBatman.currentApp.get('currentParams.url').update(page: 5)\n```\n\nIt will even update the URL match a defined route if found:\n\n```coffeescript\nBatman.currentApp.get('currentParams.url').update(action: show, id: 6) # \/items\/6\nBatman.currentApp.get('currentParams.url').update(page: 5) # \/items\/page\/5\n```\n\n## @%currentRoute : ControllerActionRoute\n\nThe `Batman.ControllerActionRoute` for the current route, which exposes routing information such as `controller` and `action`.\n\n## @%navigator : Navigator\n\nThe `App`'s `Batman.Navigator` instance.\n\n## @%dispatcher : Dispatcher\n## @%routeMap : RouteMap\n## @%routeMapBuilder : RouteMapBuilder\n## @paramsManager : ParamsReplacer\n## @paramsPusher : ParamsPusher\n\n## 'run' class event\n\n`run` is fired after a successful `run`.\n\n## 'ready' class event\n\n`ready` is fired after the app's layout is rendered.\n","old_contents":"# \/api\/App Components\/Batman.App\n\n`Batman.App` manages routing and action dispatching, as well as the initial start of the application. It is also the namespace for all `Batman.Model`s, `Batman.Controller`s, and `Batman.View`s. Only one `Batman.App` can be running on a page.\n\nA batman.js application extends `Batman.App`. It is never instantiated and it is started by calling `run`.\n\n```coffeescript\nclass @MyApp extends Batman.App\n  @root 'blogPosts#index'\n\n  @on 'run', -> alert(\"Welcome to my blog!\")\n\nclass MyApp.BlogPostsController extends Batman.Controller\n  index: -> @set('blogPosts', MyApp.BlogPost.get('all'))\n\nclass MyApp.BlogPost extends Batman.Model\n  # model definition ...\n\nMyApp.run()\n```\n\nSee [`Batman.App` routing](\/docs\/api\/batman.app_routing.html) for information about batman.js routing.\n\n## @%current : App\n\nThe currently-running `Batman.App`. Also available at `Batman.currentApp`.\n\n## @run()\n\nInitializes the `Batman.App` class by:\n\n- Closing any already-running apps\n- Creates its [`dispatcher`](\/docs\/api\/batman.app.html#class_accessor_navigator) and [`navigator`](\/docs\/api\/batman.app.html#class_accessor_navigator) and starts the navigator.\n- Instantiating the `layout` view according to the `layout` property on the `App`\n- Emitting `run`\n\n`@run` can be called before or on the `load` DOMEvent of the window.\n\n```coffeescript\n# JavaScript:\nwindow.addEventListener 'load', ->\n  MyApp.run()\n# or jQuery:\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\nStops the `App`. The URL will stop being monitored and no more actions will be dispatched. You generally shouldn't have to call this.\n\n## @%routes : NamedRouteQuery\n\nReturns the `Batman.NamedRouteQuery` which allows for binding to routes on objects. See the [`data-route` binding](batman.view_bindings.html#data-route) for more information.\n\n## @%controllers : ControllerDirectory\n\nReturns the `Batman.ControllerDirectory` for application. `Batman.Controller` instances are accessible at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n    test \"Multi-word controller names have a lowercase first letter\", ->\n      class Alfred extends Batman.App\n      class Alfred.ReminderEmailsController extends Batman.Controller\n      controller = Alfred.get('controllers.reminderEmails')\n      equal Batman._functionName(controller.constructor), \"ReminderEmailsController\"\n\n_Note:_ `@controllers` should not be observed, but it is very useful for debugging.\n\n## @.layout\n\n`@layout` is the base view of the entire view hierarchy. By default, it will parse any `data-*` attributes in the entire document, excluding any `data-yield`'s, when `App.run()` is called. Use `MyApp.layout = null` to disable the creation of this default view.\n\n## @%currentURL : String\n\nThe request path relative to `Batman.config.pathToApp`, including query string.\n\n## @%currentParams : Batman.Params\n\nReturns the URL parameters for the current request, including the path relative to the app's base path (`Batman.config.pathToApp`). It includes named parameters (eg `id` from `\/items\/:id`), query string parameters (eg `key` of `?key=value`).\n\n`currentParams` also offers a way to change the current request URL's parameters without refreshing or reloading anything on the page. This way you can influence data on the page and allow your users to get the same data on hard refreshes. Here's an example:\n\n    Batman.currentApp.get('currentParams.url').update(page: 5)\n\nIt will even update the URL match a defined route if found:\n\n    Batman.currentApp.get('currentParams.url').update(action: show, id: 6) # \/items\/6\n    Batman.currentApp.get('currentParams.url').update(page: 5) # \/items\/page\/5\n\n## @%currentRoute : ControllerActionRoute\n\nThe `Batman.ControllerActionRoute` for the current route, which exposes routing information such as `controller` and `action`.\n\n## @%navigator : Navigator\n\nThe `App`'s `Batman.Navigator` instance.\n\n## @%dispatcher : Dispatcher\n## @%routeMap : RouteMap\n## @%routeMapBuilder : RouteMapBuilder\n## @paramsManager : ParamsReplacer\n## @paramsPusher : ParamsPusher\n\n## 'run' class event\n\n`run` is fired after a successful `run`.\n\n## 'ready' class event\n\n`ready` is fired after the app's layout is rendered.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2cd02270e24f50dfe4b792b0b9bf086000b66b7e","subject":"add this.next() to route filter","message":"add this.next() to route filter\n","repos":"jfols\/liftoff,jfols\/liftoff","old_file":"client\/router\/config.litcoffee","new_file":"client\/router\/config.litcoffee","new_contents":"# Iron-router configuration\n\n    Router.configure\n      layoutTemplate: 'layout'\n      loadingTemplate: 'loading'\n\n## Filters\n\n    filters =\n      isLoggedIn: ->\n        Router.go 'home' unless Meteor.loggingIn() or Meteor.user()\n        this.next()\n\nLogin filter, except public routes\n\n    Router.onBeforeAction filters.isLoggedIn,\n      except: [\n        'home'\n        'about'\n        'atSignIn'\n        'atSignUp'\n        'atForgotPwd'\n        'atResetPwd'\n        'atVerifyEmail'\n        'atEnrollAccount'\n        'atChangePwd'\n      ]\n","old_contents":"# Iron-router configuration\n\n    Router.configure\n      layoutTemplate: 'layout'\n      loadingTemplate: 'loading'\n\n## Filters\n\n    filters =\n      isLoggedIn: ->\n        Router.go 'home' unless Meteor.loggingIn() or Meteor.user()\n\nLogin filter, except public routes\n\n    Router.onBeforeAction filters.isLoggedIn,\n      except: [\n        'home'\n        'about'\n        'atSignIn'\n        'atSignUp'\n        'atForgotPwd'\n        'atResetPwd'\n        'atVerifyEmail'\n        'atEnrollAccount'\n        'atChangePwd'\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"24c93c7ceb89a533f2e83b4448402d1d01f574df","subject":"Change phrasing in the docs.","message":"Change phrasing in the docs.\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/policies.litcoffee","new_file":"guts\/policies.litcoffee","new_contents":"Policies\n--------\nThis is the glue-file that manages how user-policies (e.g. who's allowed to do what) get defined.  This file is responsible for grabbing the \n\nLet's load in the required libraries.  \n\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n\nThen load up the user-defined policies. \n\n    policies = require '..\/config\/policies'\n\n\nStart the function.  We're expecting an array of objects with the fields `actionName` and `controllerName`, and the node `req` and `res` objects just in case the policies need them.\n\n    module.exports = (routeActions, req, res) ->\n\nWe want to reject or resolve the promise based on whether or not someone is allowed to do something.  Therefore, it'd be smart to wrap this in a promise.\n\n        new Promise (resolve, reject) ->\n\nLet's load up the helper function that grabs all the policy files.  This function was arguably useful in its own right, so it made sense to make it its own separate module. \n\n            require('.\/getPolicies')()\n\nOnce the policies are done loading, we can move on. \n\n            .then (actualPolicies) ->\n\nSince there is an array routeActions (purposefully), we need to loop through them, and since we need the result afterwards, we can use a map.  Also, since there is a small risk of a couple nested arrays (due to the way that the policies have been implemented, lets flatten it after we're done. \n                \n                policyResults = _.flatten _.map routeActions, (action) ->\n\n\n\n                    \n---------------------------------------\n\n\n                    \nWhat I'm doing here is looking for the policies file.\nIf there is a policy defined for that action, use that, else use the `*` catch all.\n\nThe flatten is necessary simply because I don't want to punish people for only listing one policy outside of an array.  Subsequently, we'll wrap everything in an array and then flatten it. \n\n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\nThis is pretty straightforward; we'll loop up the policy in the hash\ntable and then return back their result (which can just be a true or false\n\nWe want to make sure this is properly wrapped in promisey stuff, so we can init\nan empty promise then run our stuff in the \"then\". Since our empty promise only\nresolves, it won't hit the catch. \n\n                        _.map tempPolicies, (policy) ->\n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n\nOnce all the policy promises have resolved, let's return out response.\n                \n                Promise.all policyResults\n                .then (results) ->\n                    # Not entirely sure I like this logic, but it's pretty straightforward:\n                    # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                    # either allow the policy to reject if not permitted or to simply return false. \n                    unless false in results\n                      resolve true\n                    else\n                      reject \"Not Authorized\"\n                \n","old_contents":"Policies\n--------\nThis is the glue-file that manages how user-policies (e.g. who's allowed to do what) get defined.  This file is responsible for grabbing the \n\nLoad in the required libraries\n\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n\nLoad up the user-defined policies. \n\n    policies = require '..\/config\/policies'\n\n\nStart the function.  We're expecting an array of objects with the fields `actionName` and `controllerName`, and the node `req` and `res` objects just in case the policies need them.\n\n    module.exports = (routeActions, req, res) ->\n\nWe want to reject or resolve the promise based on whether or not someone is allowed to do something.  Therefore, it'd be smart to wrap this in a promise.\n\n        new Promise (resolve, reject) ->\n\nLet's load up the helper function that grabs all the policy files.  This function was arguably useful in its own right, so it made sense to make it its own separate module. \n\n            require('.\/getPolicies')()\n\nOnce the policies are done loading, we can move on. \n\n            .then (actualPolicies) ->\n\nSince there is an array routeActions (purposefully), we need to loop through them, and since we need the result afterwards, we can use a map.  Also, since there is a small risk of a couple nested arrays (due to the way that the policies have been implemented, lets flatten it after we're done. \n                \n                policyResults = _.flatten _.map routeActions, (action) ->\n\n\n\n                    \n---------------------------------------\n\n\n                    \nWhat I'm doing here is looking for the policies file.\nIf there is a policy defined for that action, use that, else use the `*` catch all.\n\nThe flatten is necessary simply because I don't want to punish people for only listing one policy outside of an array.  Subsequently, we'll wrap everything in an array and then flatten it. \n\n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\nThis is pretty straightforward; we'll loop up the policy in the hash\ntable and then return back their result (which can just be a true or false\n\nWe want to make sure this is properly wrapped in promisey stuff, so we can init\nan empty promise then run our stuff in the \"then\". Since our empty promise only\nresolves, it won't hit the catch. \n\n                        _.map tempPolicies, (policy) ->\n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n\nOnce all the policy promises have resolved, let's return out response.\n                \n                Promise.all policyResults\n                .then (results) ->\n                    # Not entirely sure I like this logic, but it's pretty straightforward:\n                    # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                    # either allow the policy to reject if not permitted or to simply return false. \n                    unless false in results\n                      resolve true\n                    else\n                      reject \"Not Authorized\"\n                \n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"da962349f7feefdbbfa1a0029f857b3138927d53","subject":"Rewrite the models file in literate coffeescript.","message":"Rewrite the models file in literate coffeescript.\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/models.litcoffee","new_file":"guts\/models.litcoffee","new_contents":"Make the Models\n===============\n\nThis file is in charge of grabbing the model files, then binding them to Sequelize models.\n\n## Libraries.\n\nThis will load in the libraries we're using, and load in the right credentials to sequelize.\n\n    _ = require 'lodash'\n    Sequelize = require 'sequelize'\n    sequelize = new Sequelize config.db.database, config.db.username, config.db.password, config.db.options\n\nNow we should load in the environment configuration. \n\n    cf = require '..\/config\/config.json'\n    config = cf[process.env.NODE_ENV]\n\nLet's start the function.\n\n    module.exports = () ->\n        \n-------------\n\nFirst we need to grab all the model files\n \n        require('.\/getModels')()\n\nOnce we have a handle on the models, we can proceeed to process them. We'll just map through the models, and concatinate them into one big object of Sequelize objects using a combination of the `reduce` and `extend` function from lodash. \n\n        .then (models) ->            \n            db =\n                _.chain models\n                .map (model, name) ->\n                    db = {}\n                    db[name] = sequelize.define name, model\n                    db\n                .reduce _.extend\n                .value()\n\n\n\nNow that we've created a bunch of sequelize models, let's make sure that the database is synchronized.  If there's any issues, we'll log it out.  Otherwise, we'll just print a message that everything is sync'd.\n\n\n            sequelize.sync().success -> console.log \"Database Synchronized at: \", new Date()\n                .error (e) -> console.log e\n\n\nLet's just return a handle on the database.\n\n\n            return db\n","old_contents":"Make the Models\n===============\n\nThis file is in charge of grabbing the model files, then binding them to sequelize models.\n\n## Libraries.\nThis will load in the libraries we're using, and load in the right credentials to sequelize.\n\n    _ = require 'lodash'\n    Sequelize = require 'sequelize'\n    sequelize = new Sequelize config.db.database, config.db.username, config.db.password, config.db.options\n\nNow we should load in the environment configuration. \n\n    cf = require '..\/config\/config.json'\n    config = cf[process.env.NODE_ENV]\n\n## Local Files.\n    \n    models = require '..\/models'\n\n\n\n    module.exports = () ->\n        # Let's loop through and create the database. \n        db =\n            _.chain models\n            .map (model, name) ->\n\n                # We need a handle on the database objects,\n                # so lets bind them to a temp object\n                db = {}\n                db[name] = sequelize.define name, model\n\n                # After we're done, let's return the object\n                db\n\n            # Now that we have a bunch of random objects in an array,\n            # let's concat them into on big databse object. \n            .reduce _.extend\n            .value()\n\n        # Now that we've created all these DB relations, let's \n        sequelize.sync().success -> console.log \"Database Synchronized at: \", new Date()\n\n        return db\n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"2f6f51950f0f9c55296278ac8fae829763fcbebd","subject":"lift `toString` method of dispatcher","message":"lift `toString` method of dispatcher\n","repos":"nickfargo\/restate","old_file":"src\/state.litcoffee","new_file":"src\/state.litcoffee","new_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> [Constructor][]\n\n> [initialize](\/api\/#state--methods--initialize)\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> [initialize][]\n> [virtualize][]\n\n      realize: ( expression ) ->\n        return this unless @attributes & ( INCIPIENT | VIRTUAL )\n\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy](\/api\/#state--methods--destroy)\n> [destroy](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneMethods    _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneMethods = ( methods ) ->\n          return unless methods?\n          ( out = {}; break ) for name of methods\n          if out then for name, method of methods\n            out[ name ] = if method.isLexicalStateMethod\n            then method.factory\n            else method\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: [`createAccessor`][]\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: [`set`][]\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method held on this state. If no method is found, move up\nthis state\u2019s protostate chain to find one. If no method is found there, move up\nthe superstate chain and repeat the search.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out ) ->\n        if ( method = @_?.methods?[ methodName ] ) and method isnt rootNoop\n          if out? then out.context = this; out.method = method\n          return method\n\n        if viaProto = via & VIA_PROTO and\n            method = @protostate()?.method methodName, VIA_PROTO, out\n          out?.context = this\n          return method\n\n        if via & VIA_SUPER and\n            method = @superstate?.method methodName, VIA_SUPER | viaProto, out\n          return method\n\n        if out? then out.context = null; out.method = method\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state, which will be callable directly from the owner,\nbut with its context bound to the state.\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn, raw ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` holds a lexical state method, then extract the wrapped method, unless\nexplicitly ordered to regard the function in its `raw` form.\n\n        fn = fn this if not raw and fn.isLexicalStateMethodFactory\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root.method methodName, VIA_NONE\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n\nThe owner method must be added to the root state in its \u201craw\u201d form, i.e., not\nlexically transformed by `state.method`.\n\n            root.addMethod methodName, ownerMethod, yes\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context. If the method\nwas originally defined in the owner, the context will be the owner. Otherwise,\nthe context will either be the state in which the method is defined, or if the\nimplementation resides in a protostate, the corresponding state belonging to\nthe inheriting owner. If the named method does not exist locally and cannot be\ninherited, a `noSuchMethod` event is emitted and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n        out = method: undefined, context: undefined\n        unless method = @method methodName, null, out\n          @emit 'noSuchMethod', [ methodName, args ]\n          @emit 'noSuchMethod:' + methodName, args\n          return\n        { context } = out\n        { owner } = this\n        ownerMethod = owner[ methodName ]\n        context = owner if ownerMethod?.original and context is @root\n        method.apply context, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic [`apply`][].\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n[`addEvent`][].\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","old_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = ( accessorName, methodName, original ) ->\n        dispatcher = -> @[ accessorName ]().apply methodName, arguments\n        dispatcher.isDispatcher = yes\n        dispatcher.toString = -> \"[dispatcher]\" if O.env.debug\n        dispatcher.original = original if original\n        dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> [Constructor][]\n\n> [initialize](\/api\/#state--methods--initialize)\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> [initialize][]\n> [virtualize][]\n\n      realize: ( expression ) ->\n        return this unless @attributes & ( INCIPIENT | VIRTUAL )\n\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy](\/api\/#state--methods--destroy)\n> [destroy](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneMethods    _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneMethods = ( methods ) ->\n          return unless methods?\n          ( out = {}; break ) for name of methods\n          if out then for name, method of methods\n            out[ name ] = if method.isLexicalStateMethod\n            then method.factory\n            else method\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: [`createAccessor`][]\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: [`set`][]\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method held on this state. If no method is found, move up\nthis state\u2019s protostate chain to find one. If no method is found there, move up\nthe superstate chain and repeat the search.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out ) ->\n        if ( method = @_?.methods?[ methodName ] ) and method isnt rootNoop\n          if out? then out.context = this; out.method = method\n          return method\n\n        if viaProto = via & VIA_PROTO and\n            method = @protostate()?.method methodName, VIA_PROTO, out\n          out?.context = this\n          return method\n\n        if via & VIA_SUPER and\n            method = @superstate?.method methodName, VIA_SUPER | viaProto, out\n          return method\n\n        if out? then out.context = null; out.method = method\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state, which will be callable directly from the owner,\nbut with its context bound to the state.\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn, raw ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` holds a lexical state method, then extract the wrapped method, unless\nexplicitly ordered to regard the function in its `raw` form.\n\n        fn = fn this if not raw and fn.isLexicalStateMethodFactory\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root.method methodName, VIA_NONE\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n\nThe owner method must be added to the root state in its \u201craw\u201d form, i.e., not\nlexically transformed by `state.method`.\n\n            root.addMethod methodName, ownerMethod, yes\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context. If the method\nwas originally defined in the owner, the context will be the owner. Otherwise,\nthe context will either be the state in which the method is defined, or if the\nimplementation resides in a protostate, the corresponding state belonging to\nthe inheriting owner. If the named method does not exist locally and cannot be\ninherited, a `noSuchMethod` event is emitted and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n        out = method: undefined, context: undefined\n        unless method = @method methodName, null, out\n          @emit 'noSuchMethod', [ methodName, args ]\n          @emit 'noSuchMethod:' + methodName, args\n          return\n        { context } = out\n        { owner } = this\n        ownerMethod = owner[ methodName ]\n        context = owner if ownerMethod?.original and context is @root\n        method.apply context, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic [`apply`][].\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n[`addEvent`][].\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"559927bf6808ae4647ab2b14c8a2e1cdbb9b7fee","subject":"Remove parameters from documentation headings","message":"Remove parameters from documentation headings\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/cache.litcoffee","new_file":"coffee\/cache.litcoffee","new_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` (`{}`) if the `preventDefault` parameter is set to\n`true` and no filter was found for the given `type`.\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n### Todo\n\n* [] Handle undefined values.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if lookup failed; otherwise `null`.\n* `Object` doc - filtered document if found; otherwise `null`.\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis write failed; otherwise `null`.\n* `Object` data - the original data as it was stored in Redis.\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function\n\n### Callback\n\n#### Params\n\n* `Error` err -  error object if Redis lookup failed, otherwise `null`.\n* `Object` data - data retrieved from Redis if found; otherwise `null`.\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the filtered data object as it was stored in Redis.\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the data object returned from Redis or Mongodb.\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n    module.exports =\n      getFilter : getFilter\n      filterData: filterData\n      getDoc    : getDoc\n      set       : set\n      get       : get\n      setForType: setForType\n      getForType: getForType\n\n\n","old_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## #getFilter(`String` type, `boolean` preventDefault)\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` (`{}`) if the `preventDefault` parameter is set to\n`true` and no filter was found for the given `type`.\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## #filterData(`String` type, `Object` data)\n\nFilter data for given type.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n### Todo\n\n* [] Handle undefined values.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## #getDoc(`String` type, `String` id, `function` cb)\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if lookup failed; otherwise `null`.\n* `Object` doc - filtered document if found; otherwise `null`.\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## #set(`String` key, `Object` data, `function` cb)\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis write failed; otherwise `null`.\n* `Object` data - the original data as it was stored in Redis.\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## #get(`String` key, `function` cb)\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function\n\n### Callback\n\n#### Params\n\n* `Error` err -  error object if Redis lookup failed, otherwise `null`.\n* `Object` data - data retrieved from Redis if found; otherwise `null`.\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## #setForType(`String` type, `String` id, `Object` data, `function` cb)\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the filtered data object as it was stored in Redis.\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## #getForType(`String` type, `String` id, `function` cb)\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the data object returned from Redis or Mongodb.\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n    module.exports =\n      getFilter : getFilter\n      filterData: filterData\n      getDoc    : getDoc\n      set       : set\n      get       : get\n      setForType: setForType\n      getForType: getForType\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"99d351edaa7ab1ba0b461b5028b5ee3d00cf0bf9","subject":"what are you doing here, you don't exist","message":"what are you doing here, you don't exist\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a nodes child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it being visible until ready.\n\n## data-yield\n\n## data-contentfor\n\n# Batman.View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","old_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a nodes child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it being visible until ready.\n\n## data-yield\n\n## data-contentfor\n\n## data-replace\n\n# Batman.View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c3a687bbff94d6d7a464e83c441980b840dd83d0","subject":"adding corresponding documentation for new filters","message":"adding corresponding documentation for new filters\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n#### Available Keypath Filters\n\nThe following is a list of available keypaths that can be used with bindings. For a more complete description with acompanying example see `Batman.View Filters`\n + `ceil` : Runs `Math.ceil` on input value.\n + `floor` : Runs `Math.floor` on input value.\n + `round` : Runs `Math.round` on input value.\n + `precision` : Runs `toPrecision()` on input value.\n + `fixed` : Runs `toFixed()` on input value.\n + `commafy` : Adds comma delimiters to a number\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## ceil(value) : [ string, integer ]\n\nThe `ceil` filter will run `Math.ceil` on the input value\n\n```html\n<span data-bind=\"someValue | ceil\"><\/span>\n```\n\n## floor(value) : [ string, integer ]\n\nThe `floor` filter will run `Math.floor` on the input value\n\n```html\n<span data-bind=\"someValue | floor\"><\/span>\n```\n\n## round(value) : [ string, integer ]\n\nThe `round` filter will run `Math.round` on the input value\n\n```html\n<span data-bind=\"someValue | round\"><\/span>\n```\n\n## percision(value, toPlace) : [ string, integer ]\n\nThe `precision` filter will run `toPrecision()` on the input value\n\n```html\n<span data-bind=\"someValue | precision\"><\/span>\n<span data-bind=\"someValue | precision 3\"><\/span>\n```\n\n## fixed(value, toPlace) : [ string, integer ]\n\nThe `fixed` filter will run `toFixed()` on the input value\n\n```html\n<span data-bind=\"someValue | fixed\"><\/span>\n<span data-bind=\"someValue | fixed 3\"><\/span>\n```\n\n## commafy(value) : [ string, integer ]\n\nThe `commafy` filter will comma delimit a 'number'\n\n```html\n<span data-bind=\"someValue | commafy\"><\/span>\n```\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","old_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"37b1716a90369c48e0298c15fa03ee285748e232","subject":"New jsdom and node 5","message":"New jsdom and node 5\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"server\/sandboxes.litcoffee","new_file":"server\/sandboxes.litcoffee","new_contents":"# Sandboxes\n\nThis module provides a method for creating sandboxed DOMs (using\n[jsdom](https:\/\/github.com\/tmpvar\/jsdom)). It augments the DOM with a\nfunctional [WebSocket](http:\/\/en.wikipedia.org\/wiki\/WebSocket) using\n[ws](https:\/\/github.com\/einaros\/ws\/), and generally makes spinning up arbitrary\nDOM contexts a pleasant breeze.\n\n    config = require 'config'\n    Promise = require 'bluebird'\n    WebSocket = require 'ws\/lib\/WebSocket'\n\n    errors = require 'errors'\n    logging = require 'logging'\n\n    {jsdom} = require 'jsdom'\n\nHax: Fix document.domain since jsdom has a stub here.\n\n    {HTMLDocument} = require 'jsdom\/lib\/jsdom\/living'\n    Object.defineProperties(\n      HTMLDocument.prototype\n      domain: get: -> 'localhost'\n    )\n\nThis class is responsible for creating and cleaning up DOMs, and provides\nsome methods to inspect the state of the document.\n\n    exports.Sandbox = class Sandbox\n\n## *constructor*\n\n*Spin up a DOM.*\n\n      constructor: ->\n\n        @_cleanupFunctions = []\n        @_window = null\n\n## Sandbox#close\n\n*Close a DOM.*\n\n      close: ->\n\nIf the window is already gone, nope out.\n\n        return Promise.resolve() unless @_window?\n\nRun all the registered cleanup functions.\n\n        Promise.all(\n          fn() for fn in @_cleanupFunctions\n\nSuppress cleanup errors.\n\n        ).catch(->\n\nActually close the window and null it out.\n\n        ).finally =>\n\n          @_window.close()\n          @_window = null\n\n## Sandbox#createDocument\n\n* (string) `html` - The HTML document.\n* (object) `options` - An options object which may contain the following\n  values:\n    * (string) `cookie` - Cookie string.\n    * (string) `cookieDomain` - The domain the cookie applies to.\n    * (string) `url` - The canonical URL of the HTML document.\n\n*Create a DOM from an HTML document.*\n\n      createDocument: (html, options = {}) ->\n\nSet up a DOM, forwarding our cookie.\n\n        document = jsdom(\n          html, jsdom.defaultLevel\n\n          cookie: options.cookie\n          cookieDomain: options.cookieDomain ? 'localhost'\n\n          url: options.url ? \"http:\/\/localhost:#{config.get 'packageSettings:shrub-http:port'}\/\"\n        )\n        @_window = window = document.defaultView\n\nCapture \"client\" console logs.\n\n        for level in ['info', 'log', 'debug', 'warn', 'error']\n          do (level) -> window.console[level] = (args...) ->\n\nMake errors as detailed as possible.\n\n            for arg, i in args\n              if arg instanceof Error\n                args[i] = errors.stack arg\n              else\n                arg\n\n            console[level] args...\n\nHack in WebSocket.\n\n        window.WebSocket = WebSocket\n\n        sandbox = this\n        new Promise (resolve, reject) ->\n\nWhen the window is loaded, we'll reject with any error, or resolve.\n\n          window.onload = ->\n\n            for documentError in window.document.errors ? []\n              if documentError.data?.error?\n                error = new Error \"#{\n                  documentError.message\n                }\\n#{\n                  errors.stack documentError.data.error\n                }\"\n\n            if error?\n              reject error\n            else\n              resolve sandbox\n\n## Sandbox#emitHtml\n\n*Emit the document as HTML.*\n\n      emitHtml: -> \"\"\"\n    <!doctype html>\n    #{@_window.document.innerHTML}\n    \"\"\"\n\n## Sandbox#registerCleanupFunction\n\n* (function) `fn` - The function to run when the sandbox is closing.\n\n*Register a function to run when the sandbox is closing.*\n\n      registerCleanupFunction: (fn) -> @_cleanupFunctions.push fn\n\n## Sandbox#url\n\n*The current URL the sandbox is at.*\n\n      url: -> @_window.location.href\n","old_contents":"# Sandboxes\n\nThis module provides a method for creating sandboxed DOMs (using\n[jsdom](https:\/\/github.com\/tmpvar\/jsdom)). It augments the DOM with a\nfunctional [WebSocket](http:\/\/en.wikipedia.org\/wiki\/WebSocket) using\n[ws](https:\/\/github.com\/einaros\/ws\/), and generally makes spinning up arbitrary\nDOM contexts a pleasant breeze.\n\n    config = require 'config'\n    Promise = require 'bluebird'\n    WebSocket = require 'socket.io\/node_modules\/socket.io-client\/node_modules\/engine.io-client\/node_modules\/ws\/lib\/WebSocket'\n\n    errors = require 'errors'\n    logging = require 'logging'\n\n    {jsdom} = require 'jsdom'\n\nHax: Fix document.domain since jsdom has a stub here.\n\n    level2Html = require 'jsdom\/lib\/jsdom\/level2\/html'\n    Object.defineProperties(\n      level2Html.dom.level2.html.HTMLDocument.prototype\n      domain: get: -> 'localhost'\n    )\n\nThis class is responsible for creating and cleaning up DOMs, and provides\nsome methods to inspect the state of the document.\n\n    exports.Sandbox = class Sandbox\n\n## *constructor*\n\n*Spin up a DOM.*\n\n      constructor: ->\n\n        @_cleanupFunctions = []\n        @_window = null\n\n## Sandbox#close\n\n*Close a DOM.*\n\n      close: ->\n\nIf the window is already gone, nope out.\n\n        return Promise.resolve() unless @_window?\n\nRun all the registered cleanup functions.\n\n        Promise.all(\n          fn() for fn in @_cleanupFunctions\n\nSuppress cleanup errors.\n\n        ).catch(->\n\nActually close the window and null it out.\n\n        ).finally =>\n\n          @_window.close()\n          @_window = null\n\n## Sandbox#createDocument\n\n* (string) `html` - The HTML document.\n* (object) `options` - An options object which may contain the following\n  values:\n    * (string) `cookie` - Cookie string.\n    * (string) `cookieDomain` - The domain the cookie applies to.\n    * (string) `url` - The canonical URL of the HTML document.\n\n*Create a DOM from an HTML document.*\n\n      createDocument: (html, options = {}) ->\n\nSet up a DOM, forwarding our cookie.\n\n        document = jsdom(\n          html, jsdom.defaultLevel\n\n          cookie: options.cookie\n          cookieDomain: options.cookieDomain ? 'localhost'\n\n          url: options.url ? \"http:\/\/localhost:#{\n            config.get 'packageSettings:shrub-http:port'\n          }\/\"\n        )\n        @_window = window = document.createWindow()\n\nCapture \"client\" console logs.\n\n        for level in ['info', 'log', 'debug', 'warn', 'error']\n          do (level) -> window.console[level] = (args...) ->\n\nMake errors as detailed as possible.\n\n            for arg, i in args\n              if arg instanceof Error\n                args[i] = errors.stack arg\n              else\n                arg\n\n            console[level] args...\n\nHack in WebSocket.\n\n        window.WebSocket = WebSocket\n\n        sandbox = this\n        new Promise (resolve, reject) ->\n\nWhen the window is loaded, we'll reject with any error, or resolve.\n\n          window.onload = ->\n\n            for documentError in window.document.errors ? []\n              if documentError.data?.error?\n                error = new Error \"#{\n                  documentError.message\n                }\\n#{\n                  errors.stack documentError.data.error\n                }\"\n\n            if error?\n              reject error\n            else\n              resolve sandbox\n\n## Sandbox#emitHtml\n\n*Emit the document as HTML.*\n\n      emitHtml: -> \"\"\"\n    <!doctype html>\n    #{@_window.document.innerHTML}\n    \"\"\"\n\n## Sandbox#registerCleanupFunction\n\n* (function) `fn` - The function to run when the sandbox is closing.\n\n*Register a function to run when the sandbox is closing.*\n\n      registerCleanupFunction: (fn) -> @_cleanupFunctions.push fn\n\n## Sandbox#url\n\n*The current URL the sandbox is at.*\n\n      url: -> @_window.location.href\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"301932f0bad1991e1864d2410e70d84f682938d2","subject":"dragCaptureListener tests ready","message":"dragCaptureListener tests ready\n","repos":"nhz-io\/cnl","old_file":"source\/test\/component.litcoffee","new_file":"source\/test\/component.litcoffee","new_contents":"# TEST CLASS: Component\n* Parent: [Index][Parent]\n\n---\n\n    should = require 'should'\n    module.exports = (Component, name='Component') ->\n\n## CONSTRUCTOR\n\n      describe name, ->\n        it 'should be a class', -> Component.should.be.a.class\n\n        describe '#constructor(args)', ->\n          it 'should return an instance of Component', ->\n            (new Component).should.be.an.instanceof Component\n\n---\n\n## LISTENERS\n\nMousemove capturing listener\n\n      describe '#mousemoveCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .mousemoveCaptureListener()\n            .should.be.equal component\n\n        it 'should set the state to active if component is grabbed', ->\n          component = new Component\n          component.___runtime.grab = true\n          component.state = null\n          component.mousemoveCaptureListener({})\n          component.state.should.be.equal 'active'\n\n        it 'should broadcast drag event with drag offset', (done) ->\n          component = new Component events:drag:true\n          component.___runtime.grab = true\n          component.___runtime.grabEvent = x:10, y:10\n          component.broadcastEvent = (event) ->\n            event.offsetX.should.be.equal 10\n            event.offsetY.should.be.equal 5\n            done()\n          component.mousemoveCaptureListener x:20, y:15\n\n        it 'should broadcast drag event with drag offset using previous drag', (done) ->\n          component = new Component events:drag:true\n          component.___runtime.grab = true\n          component.___runtime.dragEvent = x:10, y:10\n          component.broadcastEvent = (event) ->\n            event.offsetX.should.be.equal 10\n            event.offsetY.should.be.equal 5\n            done()\n          component.mousemoveCaptureListener x:20, y:15\n\n        it 'should set the component state to hover', ->\n          component = new Component\n            origin  : x:0, y:0\n            regions : hover: [0,0,1,1]\n          component.mousemoveCaptureListener x:0.5, y:0.5\n          component.state.should.be.equal 'hover'\n\n        it 'should set the component state to hover', ->\n          component = new Component\n            origin  : x:0, y:0\n            regions : normal: [0,0,1,1]\n          component.mousemoveCaptureListener x:0.5, y:0.5\n          component.state.should.be.equal 'normal'\n\n        it 'should set the component state to hover preceeding normal', ->\n          component = new Component\n            origin  : x:0, y:0\n            regions : normal: [0,0,1,1], hover: [0,0,1,1]\n          component.mousemoveCaptureListener x:0.5, y:0.5\n          component.state.should.be.equal 'hover'\n\nDrag capturing listener\n\n      describe '#dragCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .mousemoveCaptureListener()\n            .should.be.equal component\n\n        it 'should save the event in #___runtime', ->\n          (component = new Component)\n            .dragCaptureListener 'test'\n            .___runtime.dragEvent.should.be.equal 'test'\n\n        it 'should localize the event coordinates', ->\n          (component = new Component origin: x:10, y:15)\n            .dragCaptureListener (event = x:20, y:30)\n\n          event.localX.should.be.equal 10\n          event.localY.should.be.equal 15\n\nGrab capturing listener\n\n      describe '#grabCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .grabCaptureListener()\n            .should.be.equal component\n\nRelease capturing listener\n\n      describe '#releaseCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .releaseCaptureListener()\n            .should.be.equal component\n\nMousedown listener\n\n      describe '#mousedownListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .mousedownListener()\n            .should.be.equal component\n\n        it 'should set grab flag in #___runtime', ->\n          (component = new Component state:'active', events:grab:true)\n            .mousedownListener {}\n            .___runtime.grab.should.be.true\n\nDrag listener\n      \n      describe '#dragListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .dragListener()\n            .should.be.equal component\n\nGrab listener\n\n      describe '#grabListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .grabListener()\n            .should.be.equal component\n\nRelease listener\n\n      describe '#releaseListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .releaseListener()\n            .should.be.equal component\n\n[Component#constructor]: ..\/component.litcoffee#constructor\n[Parent]: .\/index.litcoffee\n","old_contents":"# TEST CLASS: Component\n* Parent: [Index][Parent]\n\n---\n\n    should = require 'should'\n    module.exports = (Component, name='Component') ->\n\n## CONSTRUCTOR\n\n      describe name, ->\n        it 'should be a class', -> Component.should.be.a.class\n\n        describe '#constructor(args)', ->\n          it 'should return an instance of Component', ->\n            (new Component).should.be.an.instanceof Component\n\n---\n\n## LISTENERS\n\nMousemove capturing listener\n\n      describe '#mousemoveCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .mousemoveCaptureListener()\n            .should.be.equal component\n\n        it 'should set the state to active if component is grabbed', ->\n          component = new Component\n          component.___runtime.grab = true\n          component.state = null\n          component.mousemoveCaptureListener({})\n          component.state.should.be.equal 'active'\n\n        it 'should broadcast drag event with drag offset', (done) ->\n          component = new Component events:drag:true\n          component.___runtime.grab = true\n          component.___runtime.grabEvent = x:10, y:10\n          component.broadcastEvent = (event) ->\n            event.offsetX.should.be.equal 10\n            event.offsetY.should.be.equal 5\n            done()\n          component.mousemoveCaptureListener x:20, y:15\n\n        it 'should broadcast drag event with drag offset using previous drag', (done) ->\n          component = new Component events:drag:true\n          component.___runtime.grab = true\n          component.___runtime.dragEvent = x:10, y:10\n          component.broadcastEvent = (event) ->\n            event.offsetX.should.be.equal 10\n            event.offsetY.should.be.equal 5\n            done()\n          component.mousemoveCaptureListener x:20, y:15\n\n        it 'should set the component state to hover', ->\n          component = new Component\n            origin  : x:0, y:0\n            regions : hover: [0,0,1,1]\n          component.mousemoveCaptureListener x:0.5, y:0.5\n          component.state.should.be.equal 'hover'\n\n        it 'should set the component state to hover', ->\n          component = new Component\n            origin  : x:0, y:0\n            regions : normal: [0,0,1,1]\n          component.mousemoveCaptureListener x:0.5, y:0.5\n          component.state.should.be.equal 'normal'\n\n        it 'should set the component state to hover preceeding normal', ->\n          component = new Component\n            origin  : x:0, y:0\n            regions : normal: [0,0,1,1], hover: [0,0,1,1]\n          component.mousemoveCaptureListener x:0.5, y:0.5\n          component.state.should.be.equal 'hover'\n\nDrag capturing listener\n\n      describe '#dragCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .mousemoveCaptureListener()\n            .should.be.equal component\n\nGrab capturing listener\n\n      describe '#grabCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .grabCaptureListener()\n            .should.be.equal component\n\nRelease capturing listener\n\n      describe '#releaseCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .releaseCaptureListener()\n            .should.be.equal component\n\nMousedown listener\n\n      describe '#mousedownListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .mousedownListener()\n            .should.be.equal component       \n\nDrag listener\n      \n      describe '#dragListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .dragListener()\n            .should.be.equal component\n\nGrab listener\n\n      describe '#grabListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .grabListener()\n            .should.be.equal component\n\nRelease listener\n\n      describe '#releaseListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .releaseListener()\n            .should.be.equal component\n\n[Component#constructor]: ..\/component.litcoffee#constructor\n[Parent]: .\/index.litcoffee\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4debea3c873cb1ae2d32c1b3395d13f3e8c4f843","subject":"Sketch node module exports.","message":"Sketch node module exports.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.  The main classes are exported as a Node module.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n    3. [Node module exports](#node-module-exports)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.  Only desired label\/tick tightness is supplied as an option.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width, tightness = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval.  Depending on `intervalType` we choose interval or point label placement.\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        switch @options.intervalType\n          when 'year', 'month', 'week', 'day'\n            @options.labelPlacement = 'interval'\n          else\n            @options.labelPlacement = 'point'\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: @formatLabel timePoint, @options\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        if @options.labelPlacement is 'interval'\n          for textLabel, i in textLabels when i isnt (textLabels.length-1)\n            textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n          textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n\nHere it can happen that `start` is actually earlier than Epoch.  Then we decrease `leftTime` first:\n\n            if start < leftTime\n              delta = 1\n              while start <= leftTime\n                leftTime = new Date leftTime.getFullYear(),\n                  leftTime.getMonth()\n                  leftTime.getDate() - delta*intervalMultiplier\n                  leftTime.getHours()\n                  leftTime.getMinutes()\n                  leftTime.getSeconds()\n                  leftTime.getMilliseconds()\n                delta *= 2\n\nNow we move forwart until we find the right point:\n\n            delta = 1048576\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `formatLabel` function ####\n\nThis function returns text representation of date.\n\n      formatLabel: (timePoint, options) ->\n        switch options.intervalType\n          when 'year'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setFullYear(nextTimePoint.getFullYear() - 1)\n              timePoint.getFullYear().toString() +\n                '\u2013' + nextTimePoint.getFullYear()\n            else\n              timePoint.getFullYear().toString()\n          when 'month'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMonth(nextTimePoint.getMonth() - 1)\n              timePoint.getMonth().toString() +\n                '\u2013' + nextTimePoint.getMonth().toString()\n            else\n              timePoint.getMonth().toString()\n          when 'week'\n            if options.labelPlacement is 'interval'\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'day'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'hour'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setHours(nextTimePoint.getHours())\n              timePoint.getHours().toString() +\n                '\u2013' + nextTimePoint.getHours().toString()\n            else\n              timePoint.getHours().toString()\n          when 'minute'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMinutes(nextTimePoint.getMinutes())\n              timePoint.getMinutes().toString() +\n                '\u2013' + nextTimePoint.getMinutes().toString()\n            else\n              timePoint.getMinutes().toString()\n          when 'second'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setSeconds(nextTimePoint.getSeconds())\n              timePoint.getSeconds().toString() +\n                '\u2013' + nextTimePoint.getSeconds().toString()\n            else\n              timePoint.getSeconds().toString()\n          when 'millisecond'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMilliseconds(nextTimePoint.getMilliseconds())\n              \".#{ timePoint.getMilliseconds() }\u2013.#{ nextTimePoint.getMilliseconds() }\"\n            else\n              \".#{ timePoint.getMilliseconds() }\"\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\n### Node module exports\n\nBoth `TimeAxisMaker` and `TimeAxisRenderer` are exported.\n\nWe temporarily disable it.\n\n    #module.exports =\n      #TimeAxisMaker: TimeAxisMaker\n      #TimeAxisRenderer: TimeAxisRenderer\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n        labelOffset: 29\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      timeAxisRedrerer = new TimeAxisRenderer()\n\nCode that draws builds and draws axis is also moved in a function:\n\n      makeAxis = ->\n        axisData = timeAxisMaker.formatAutomatic {start, end}, canvas.width, 15\n        timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nInitial drawing:\n\n      do makeAxis\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          do makeAxis\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          do makeAxis\n\nWe run the `makeDemo` function when page loads.\n\n__TODO__:  we need to put example in another file.\n\n    #window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.  Only desired label\/tick tightness is supplied as an option.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width, tightness = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval.  Depending on `intervalType` we choose interval or point label placement.\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        switch @options.intervalType\n          when 'year', 'month', 'week', 'day'\n            @options.labelPlacement = 'interval'\n          else\n            @options.labelPlacement = 'point'\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: @formatLabel timePoint, @options\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        if @options.labelPlacement is 'interval'\n          for textLabel, i in textLabels when i isnt (textLabels.length-1)\n            textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n          textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n\nHere it can happen that `start` is actually earlier than Epoch.  Then we decrease `leftTime` first:\n\n            if start < leftTime\n              delta = 1\n              while start <= leftTime\n                leftTime = new Date leftTime.getFullYear(),\n                  leftTime.getMonth()\n                  leftTime.getDate() - delta*intervalMultiplier\n                  leftTime.getHours()\n                  leftTime.getMinutes()\n                  leftTime.getSeconds()\n                  leftTime.getMilliseconds()\n                delta *= 2\n\nNow we move forwart until we find the right point:\n\n            delta = 1048576\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `formatLabel` function ####\n\nThis function returns text representation of date.\n\n      formatLabel: (timePoint, options) ->\n        switch options.intervalType\n          when 'year'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setFullYear(nextTimePoint.getFullYear() - 1)\n              timePoint.getFullYear().toString() +\n                '\u2013' + nextTimePoint.getFullYear()\n            else\n              timePoint.getFullYear().toString()\n          when 'month'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMonth(nextTimePoint.getMonth() - 1)\n              timePoint.getMonth().toString() +\n                '\u2013' + nextTimePoint.getMonth().toString()\n            else\n              timePoint.getMonth().toString()\n          when 'week'\n            if options.labelPlacement is 'interval'\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'day'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setDate(nextTimePoint.getDate() - 1)\n              timePoint.getDate().toString() +\n                '\u2013' + nextTimePoint.getDate().toString()\n            else\n              timePoint.getDate().toString()\n          when 'hour'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setHours(nextTimePoint.getHours())\n              timePoint.getHours().toString() +\n                '\u2013' + nextTimePoint.getHours().toString()\n            else\n              timePoint.getHours().toString()\n          when 'minute'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMinutes(nextTimePoint.getMinutes())\n              timePoint.getMinutes().toString() +\n                '\u2013' + nextTimePoint.getMinutes().toString()\n            else\n              timePoint.getMinutes().toString()\n          when 'second'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setSeconds(nextTimePoint.getSeconds())\n              timePoint.getSeconds().toString() +\n                '\u2013' + nextTimePoint.getSeconds().toString()\n            else\n              timePoint.getSeconds().toString()\n          when 'millisecond'\n            if (options.intervalMultiplier > 1 and\n                options.labelPlacement is 'interval')\n              nextTimePoint = @findNextPoint timePoint\n              nextTimePoint.setMilliseconds(nextTimePoint.getMilliseconds())\n              \".#{ timePoint.getMilliseconds() }\u2013.#{ nextTimePoint.getMilliseconds() }\"\n            else\n              \".#{ timePoint.getMilliseconds() }\"\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n        labelOffset: 29\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      timeAxisRedrerer = new TimeAxisRenderer()\n\nCode that draws builds and draws axis is also moved in a function:\n\n      makeAxis = ->\n        axisData = timeAxisMaker.formatAutomatic {start, end}, canvas.width, 15\n        timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nInitial drawing:\n\n      do makeAxis\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          do makeAxis\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          do makeAxis\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"070468828137313cbf914520a7fb8a6568668503","subject":"Fix Wikipedia link by escaping parens","message":"Fix Wikipedia link by escaping parens\n","repos":"jalleyne\/docco,lobrien\/docco,oponder\/docco,gvithellyna\/docco,ShawnHuang\/docco-multidir,guigrpa\/docco-extended,lobrien\/docco,jalleyne\/docco,mhkeller\/docco,guigrpa\/docco,osharim\/docco,guigrpa\/docco,whitetrefoil\/docco,erikdiessel\/plidoc,jrvidal\/docco,Hellyna\/docco,whitetrefoil\/docco,JonathanMatthey\/codeconv,DoomHammer\/docco,MaxwellRebo\/docco,robertmackenzie\/docco,actano\/docco,osharim\/docco,tbremer\/docco,jrvidal\/docco,ShawnHuang\/docco-multidir,erikdiessel\/plidoc,robertmackenzie\/docco,oponder\/docco,mhkeller\/docco,lbn\/docco,MaxwellRebo\/docco,guigrpa\/docco-extended,STRd6\/docco,lbn\/docco,Hellyna\/docco,tbremer\/docco,DoomHammer\/docco,gvithellyna\/docco","old_file":"docco.litcoffee","new_file":"docco.litcoffee","new_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.com\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.com\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.com\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.com\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* Your all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.com\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.com\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.com\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        for line, i in lines\n          lines[i] = if \/^\\s*$\/.test line\n            ''\n          else if match = (\/^([ ]{4}|\\t)\/).exec line\n            line[match[0].length..]\n          else\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n          prev = 'text'\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n          prev = 'code'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n      for section, i in sections\n        code = highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    {highlight} = require 'highlight.js'\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    for ext, l of languages\n\nDoes the line begin with a comment?\n\n      l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n      l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, version}\n","old_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.com\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.com\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.com\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.com\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* Your all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.com\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.com\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.com\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        for line, i in lines\n          lines[i] = if \/^\\s*$\/.test line\n            ''\n          else if match = (\/^([ ]{4}|\\t)\/).exec line\n            line[match[0].length..]\n          else\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n          prev = 'text'\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n          prev = 'code'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n      for section, i in sections\n        code = highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    {highlight} = require 'highlight.js'\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    for ext, l of languages\n\nDoes the line begin with a comment?\n\n      l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_(Unix\\)) and interpolations...\n\n      l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, version}\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6af8b7700997d3e7232a9d130e484b602665d6c6","subject":"Disable cache by default.","message":"Disable cache by default.\n","repos":"monokrome\/glp","old_file":"src\/defaults.litcoffee","new_file":"src\/defaults.litcoffee","new_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How GLP configuration works\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp,watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is false by default, but can be made true if caching\nhappens to be working as expected with your project. This feature is disabled\nby default because it is still experimental.\n\n        enabled: no\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js` or `.coffee`. After\nthey are built, the resulting files will be placed in the directory specified\nby the **root** function as separate files. If the output file was not a\n**directory** (as denoted by the ending slash) then the files would also be\nconcatenated and the resulting file would be given the *extension* which\ncorresponds to this type of file.\n\n          '\/': [\n            'src\/**\/*.js'\n            'src\/**\/*.coffee'\n          ]\n\nHere, we are doing the same thing for *html* and *jade* files, but we are\noutputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/**\/*.html'\n            'src\/**\/*.jade'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/': [\n            'src\/**\/*.css'\n            'src\/**\/*.less'\n            'src\/**\/*.sass'\n            'src\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","old_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How GLP configuration works\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp,watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is true by default, but can be made false if\ncaching isn't working as expected with your project.\n\n        enabled: yes\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js` or `.coffee`. After\nthey are built, the resulting files will be placed in the directory specified\nby the **root** function as separate files. If the output file was not a\n**directory** (as denoted by the ending slash) then the files would also be\nconcatenated and the resulting file would be given the *extension* which\ncorresponds to this type of file.\n\n          '\/': [\n            'src\/**\/*.js'\n            'src\/**\/*.coffee'\n          ]\n\nHere, we are doing the same thing for *html* and *jade* files, but we are\noutputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/**\/*.html'\n            'src\/**\/*.jade'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/': [\n            'src\/**\/*.css'\n            'src\/**\/*.less'\n            'src\/**\/*.sass'\n            'src\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7f6615b8d5e12b123865ad3c76b2ff226b0b616a","subject":"Move redis require to code","message":"Move redis require to code\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/cache.litcoffee","new_file":"coffee\/cache.litcoffee","new_contents":"    \"use strict\"\n\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### ToDo\n\n* Handle undefined values.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      require('.\/db\/mongo')[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      require('.\/db\/redis').hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      require('.\/db\/redis').hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      set       : set\n      get       : get\n      getDoc    : getDoc\n      setForType: setForType\n      getFilter : getFilter\n      filterData: filterData\n      getForType: getForType\n\n","old_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### ToDo\n\n* Handle undefined values.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      set       : set\n      get       : get\n      getDoc    : getDoc\n      setForType: setForType\n      getFilter : getFilter\n      filterData: filterData\n      getForType: getForType\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a4d744fafd99c51bcd86cd8b241047427d9fbe68","subject":"[Sheet] well that was a really bad typo","message":"[Sheet] well that was a really bad typo\n","repos":"marrus-sh\/jelli","old_file":"coffee\/sheet.litcoffee","new_file":"coffee\/sheet.litcoffee","new_contents":"Jelli Game Engine\n\n#  Sheet  #\n\nThe `Sheet` constructor generates sprite-sheets and manages their rendering on a `CanvasRenderingContext2D`.\nIt is packaged with `Sprite`, which describes a single sprite on the sheet.\n\n##  General functions  ##\n\nThe function `drawSprite()` is called by `Sprite`s and `Sheet`s in order to draw their images.\nIt is not exposed to the window.\n\n    drawSprite = (sheet, start_index, context, x, y, frame = 1) ->\n\n\u2026That's a lot of arguments. Let's go through them:\n\n- `sheet` is the `Sheet` from which to draw the sprite\n- `start_index` gives us the index of the sprite within the sheet\n- `context` is the `CanvasRenderingContext2D` on which to draw the sprite\n- `x` is the x-coordinate of the top-left corner of the sprite\n- `y` is the y-coordinate of the top-left corner of the sprite\n- `frame` is merely there as a convenience: It increments `start_index` by its value\n\nThe first thing we do is make sure everything is typed correctly.\nThe `sheet` and `context`, clearly, need to be of a certain type in order for this to work.\nIf any of the other provided arguments aren't numbers, however, we can go ahead and reset them to zero.\n\n        unless sheet instanceof Sheet and start_index < sheet.size and context instanceof CanvasRenderingContext2D then return\n        if isNaN(start_index = Number(start_index)) then start_index = 0\n        if isNaN(x = Number(x)) then x = 0\n        if isNaN(y = Number(y)) then y = 0\n        if isNaN(frame = Number(frame)) then frame = 0\n\nNow we can increment `start_index` by `frame`'s value:\n\n        start_index += frame\n\nNext, we need to find the horizontal (`i`) and vertical (`j`) position of the sprite on the sheet.\nWe can get this information from `start_index` with a little math:\n\n        i = start_index % sheet.width\n        j = Math.floor start_index \/ sheet.width\n\nThese two lines just make the image a little easier to access:\n\n        source = sheet.source\n        image = sheet.image\n\nNow we have all we need to draw the sprite!\nThere is a HUGE `if`-statement that precedes the draw function, because we want to make sure that what we're drawing is actually there.\nIf it isn't, then obviously we can't draw anything.\n\n        if (source instanceof HTMLImageElement and source.complete or source instanceof SVGImageElement or source instanceof HTMLCanvasElement or createImageBitmap? and (image instanceof ImageBitmap or source instanceof ImageBitmap)) and not isNaN(i) and not isNaN(j) and Number(width = sheet.sprite_width) and Number(height = sheet.sprite_height) then context.drawImage (if createImageBitmap? and image instanceof ImageBitmap then image else source), i * width, j * height, width, height, x, y, width, height\n\nLet's go through what those did.\nFirst, we make sure that the `Sheet` actually has an image associated with it:\n\n-   `source instanceof HTMLImageElement and source.complete`\u2014\n    If the image source is an `<img>` element, then it needs to have finished loading.\n\n-   `source instanceof SVGImageElement or source instanceof HTMLCanvasElement`\u2014\n    The source doesn't have to be an `<img>` element though! It can also be an `<svg>` or a `<canvas>`.\n\n-   `createImageBitmap? and (image instanceof ImageBitmap or source instanceof ImageBitmap)`\u2014\n    Finally, the source can be an `ImageBitmap`.\n    This isn't supported in all browsers, so we check to make sure `createImageBitmap` exists first.\n    However, if `createImageBitmap` *is* supported, then `Sheet`s have a special property, `Sheet.image`, which might contain one, and this should be given preference.\n\nWe also need to make sure that the sprite exists on the sheet:\n\n-   `not isNaN(i) and not isNaN(j)`\u2014\n    This makes sure that our indices are actually, y'know, numbers.\n\n-   `Number(width = sheet.sprite_width) and Number(height = sheet.sprite_height)`\u2014\n    This makes sure that the sprites in the sheet have a non-zero width and height.\n    It also sets the variables `width` and `height` to those values, for convenient access later.\n\nFinally, we can draw the sprite.\nAgain, we preference `image` if it is defined.\n\n##  Sprite  ##\n\nThe `Sprite` constructor creates a reference to a sprite on a sheet.\nFor efficiency's sake, it does *not* actually contain any of the image data associated with that sprite.\nThe constructor takes three arguments: `sheet`, which gives the sheet; `index`, which is the index of the sprite on the sheet; and `length`, which for animated sprites gives the length of the animation.\n\n    Sprite = (sheet, index, length = 1) ->\n\nIf `index` or `length` aren't numbers, then we go ahead and set them to `0` and `1`, respectively.\n\n        if isNaN(index = Number(index)) then index = 0\n        if isNaN(length = Number(length)) then length = 1\n\nNow we can set the properties.\nNote that `draw` simply binds `drawSprite` to the given `Sheet` and `index`.\n\n        @draw = drawSprite.bind(null, sheet, index)\n        @height = if sheet instanceof Sheet then sheet.sprite_height else 0\n        @index = index\n        @frames = length\n        @sheet = if sheet instanceof Sheet then sheet else null\n        @width = if sheet instanceof Sheet then sheet.sprite_width else 0\n\nSince `Sprite`s are just static references, they should be immutable:\n\n        Object.freeze this\n\nAnd we're done!\n\n`Sprite`s are very simple, and because the `draw` function is bound above, they don't have a prototype.\nFor purposes of inheritance, however, I've thrown this minimal one together:\n\n    Sprite.prototype = {draw: ->}\n    Object.freeze Sprite.prototype\n\n##  Sheet  ##\n\n`Sheet`s associate images with data and methods to make them easily referencable as sprite-sheets.\n\n###  The constructor  ###\n\nThe `Sheet` constructor only takes three arguments: `source`, which gives the source image for the sheet, `sprite_width`, which gives the width of the sprites, and `sprite_height`, which gives their height.\nIn doing so, it makes the assumption that sprites and sprite-sheets do not have any borders or padding.\n(Because borders and padding result in larger download times for users, this restriction is considered acceptable, but it may be lifted at some time in the future.)\n\n    Sheet = (source, sprite_width, sprite_height) ->\n\nFirst, we need to handle the arguments.\nIf `source` isn't an image type that we recognize, we go ahead and set it to `null`.\nAnd if the `sprite_width` or `sprite_height` aren't recognizable as numbers, we set them to 0.\n(Note from the above that a `Sheet` with zero `sprite_width` or `sprite_height` cannot be drawn.)\n\n        unless source instanceof HTMLImageElement or source instanceof SVGImageElement or source instanceof HTMLCanvasElement or createImageBitmap? and source instanceof ImageBitmap then source = null\n        if isNaN(sprite_width = Number(sprite_width)) then sprite_width = 0\n        if isNaN(sprite_height = Number(sprite_height)) then sprite_height = 0\n\nRecall that we need to check for `createImageBitmap` before checking to see if the source is an `ImageBitmap`.\n\nWe can get the width and height of the image from one of two sources, depending on the source type.\nAll of the accepted types have `width` and `height` properties, which specify their dimensions.\nHowever, `HTMLImageElement`s also have `naturalWidth` and `naturalHeight` properties, and these should be preferred for pixel-perfect rendering.\n\nIf for some reason we can't get *either* of these properties, then the `source_width` and `source_height` are set to zero.\n\n        unless source? and not isNaN(source_width = Number(if source.naturalWidth? then source.naturalWidth else source.width)) then source_width = 0\n        unless source? and not isNaN(source_height = Number(if source.naturalHeight? then source.naturalHeight else source.height)) then source_height = 0\n\nWe now have everything we need to define the properties.\nNote that `width` and `height` are provided in sprite-units, not pixels.\nIf `sprite_width` or `sprite_height` are `0`, then the corresponding `width` and `height` are obviously `NaN`.\n\n        @height = Math.floor source_height \/ sprite_height\n        @source = source\n        @sprite_height = sprite_height\n        @sprite_width = sprite_width\n        @width = Math.floor source_width \/ sprite_width\n\nThe `size` property is just `width` times `height`.\n\n        @size = @width * @height\n\n`ImageBitmap`s are optimized for drawing to the canvas.\nIf they are supported, we can pre-render the sprite-sheet and store this in the `image` property.\n\n        if createImageBitmap? then (createImageBitmap source).then (image) => @image = image\n\nBecause `Sheet`s contain static images, it doesn't make sense for them to change after creation.\nWe freeze them:\n\n        Object.freeze this\n\nFor convenience's sake, two static methods have been defined for `Sheet` to let you draw arbitrary sprites.\nThese are largely intended for use with callbacks.\n\nThe first is called `draw`, and takes five arguments:\n\n- `context`: A `CanvasRenderingContext2D`\n- `sprite`: A `Sprite`\n- `x`: The x-coordinate at which to draw the sprite\n- `y`: The y-coordinate at which to draw the sprite\n- `frame`: The frame of the animation which to draw\n\nIt maps onto `sprite.draw`:\n\n    Sheet.draw = (context, sprite, x, y, frame = 0) -> if sprite instanceof Sprite then sprite.draw context, x, y, frame\n\nThe second is called `drawSheetAtIndex`, and also takes five arguments:\n\n- `context`: A `CanvasRenderingContext2D`\n- `sheet`: A `Sheet`\n- `index`: The index of the sprite\n- `x`: The x-coordinate at which to draw the sprite\n- `y`: The y-coordinate at which to draw the sprite\n\nIt maps onto `sheet.drawIndex`:\n\n    Sheet.drawSheetAtIndex = (context, sheet, index, x, y) -> if sheet instanceof Sheet then sheet.drawIndex context, index, x, y\n\nFinally, the `Sprite` constructor is added to `Sheet` for later access:\n\n    Sheet.Sprite = Sprite\n\nAnd now we can make `Sheet` available to the window:\n\n    window.Sheet = Sheet\n\n##  The prototype  ##\n\nThe `Sheet` prototype is fairly minimal, consisting of only two functions.\n\n    Sheet.prototype = {\n\nThe first, `drawIndex`, draws the sprite located at the given `index`.\nIt is little more than a repackaging of `drawSprite`.\n\n        drawIndex: (context, index, x, y) -> drawSprite this, index, context, x, y\n\nThe second, `getSprite`, creates a new `Sprite` pointing to the given `index`.\nIt is the most convenient way of creating `Sprite` objects.\nIt takes two arguments, the `index` of the sprite, and the `length` of the animation.\n\n        getSprite: (index, length = 1) -> new Sprite this, index, length\n\nWe can now freeze the prototype:\n\n    }\n\n    Object.freeze Sheet.prototype\n\n\u2026And that's the end!\n","old_contents":"Jelli Game Engine\n\n#  Sheet  #\n\nThe `Sheet` constructor generates sprite-sheets and manages their rendering on a `CanvasRenderingContext2D`.\nIt is packaged with `Sprite`, which describes a single sprite on the sheet.\n\n##  General functions  ##\n\nThe function `drawSprite()` is called by `Sprite`s and `Sheet`s in order to draw their images.\nIt is not exposed to the window.\n\n    drawSprite = (sheet, start_index, context, x, y, frame = 1) ->\n\n\u2026That's a lot of arguments. Let's go through them:\n\n- `sheet` is the `Sheet` from which to draw the sprite\n- `start_index` gives us the index of the sprite within the sheet\n- `context` is the `CanvasRenderingContext2D` on which to draw the sprite\n- `x` is the x-coordinate of the top-left corner of the sprite\n- `y` is the y-coordinate of the top-left corner of the sprite\n- `frame` is merely there as a convenience: It increments `start_index` by its value\n\nThe first thing we do is make sure everything is typed correctly.\nThe `sheet` and `context`, clearly, need to be of a certain type in order for this to work.\nIf any of the other provided arguments aren't numbers, however, we can go ahead and reset them to zero.\n\n        unless sheet instanceof Sheet and start_index < sheet.size and context instanceof CanvasRenderingContext2D then return\n        if isNaN(start_index = Number(start_index)) then start_index = 0\n        if isNaN(x = Number(x)) then x = 0\n        if isNaN(y = Number(y)) then y = 0\n        if isNaN(frame = Number(frame)) then frame = 0\n\nNow we can increment `start_index` by `frame`'s value:\n\n        `start_index` += frame\n\nNext, we need to find the horizontal (`i`) and vertical (`j`) position of the sprite on the sheet.\nWe can get this information from `start_index` with a little math:\n\n        i = start_index % sheet.width\n        j = Math.floor start_index \/ sheet.width\n\nThese two lines just make the image a little easier to access:\n\n        source = sheet.source\n        image = sheet.image\n\nNow we have all we need to draw the sprite!\nThere is a HUGE `if`-statement that precedes the draw function, because we want to make sure that what we're drawing is actually there.\nIf it isn't, then obviously we can't draw anything.\n\n        if (source instanceof HTMLImageElement and source.complete or source instanceof SVGImageElement or source instanceof HTMLCanvasElement or createImageBitmap? and (image instanceof ImageBitmap or source instanceof ImageBitmap)) and not isNaN(i) and not isNaN(j) and Number(width = sheet.sprite_width) and Number(height = sheet.sprite_height) then context.drawImage (if createImageBitmap? and image instanceof ImageBitmap then image else source), i * width, j * height, width, height, x, y, width, height\n\nLet's go through what those did.\nFirst, we make sure that the `Sheet` actually has an image associated with it:\n\n-   `source instanceof HTMLImageElement and source.complete`\u2014\n    If the image source is an `<img>` element, then it needs to have finished loading.\n\n-   `source instanceof SVGImageElement or source instanceof HTMLCanvasElement`\u2014\n    The source doesn't have to be an `<img>` element though! It can also be an `<svg>` or a `<canvas>`.\n\n-   `createImageBitmap? and (image instanceof ImageBitmap or source instanceof ImageBitmap)`\u2014\n    Finally, the source can be an `ImageBitmap`.\n    This isn't supported in all browsers, so we check to make sure `createImageBitmap` exists first.\n    However, if `createImageBitmap` *is* supported, then `Sheet`s have a special property, `Sheet.image`, which might contain one, and this should be given preference.\n\nWe also need to make sure that the sprite exists on the sheet:\n\n-   `not isNaN(i) and not isNaN(j)`\u2014\n    This makes sure that our indices are actually, y'know, numbers.\n\n-   `Number(width = sheet.sprite_width) and Number(height = sheet.sprite_height)`\u2014\n    This makes sure that the sprites in the sheet have a non-zero width and height.\n    It also sets the variables `width` and `height` to those values, for convenient access later.\n\nFinally, we can draw the sprite.\nAgain, we preference `image` if it is defined.\n\n##  Sprite  ##\n\nThe `Sprite` constructor creates a reference to a sprite on a sheet.\nFor efficiency's sake, it does *not* actually contain any of the image data associated with that sprite.\nThe constructor takes three arguments: `sheet`, which gives the sheet; `index`, which is the index of the sprite on the sheet; and `length`, which for animated sprites gives the length of the animation.\n\n    Sprite = (sheet, index, length = 1) ->\n\nIf `index` or `length` aren't numbers, then we go ahead and set them to `0` and `1`, respectively.\n\n        if isNaN(index = Number(index)) then index = 0\n        if isNaN(length = Number(length)) then length = 1\n\nNow we can set the properties.\nNote that `draw` simply binds `drawSprite` to the given `Sheet` and `index`.\n\n        @draw = drawSprite.bind(null, sheet, index)\n        @height = if sheet instanceof Sheet then sheet.sprite_height else 0\n        @index = index\n        @frames = length\n        @sheet = if sheet instanceof Sheet then sheet else null\n        @width = if sheet instanceof Sheet then sheet.sprite_width else 0\n\nSince `Sprite`s are just static references, they should be immutable:\n\n        Object.freeze this\n\nAnd we're done!\n\n`Sprite`s are very simple, and because the `draw` function is bound above, they don't have a prototype.\nFor purposes of inheritance, however, I've thrown this minimal one together:\n\n    Sprite.prototype = {draw: ->}\n    Object.freeze Sprite.prototype\n\n##  Sheet  ##\n\n`Sheet`s associate images with data and methods to make them easily referencable as sprite-sheets.\n\n###  The constructor  ###\n\nThe `Sheet` constructor only takes three arguments: `source`, which gives the source image for the sheet, `sprite_width`, which gives the width of the sprites, and `sprite_height`, which gives their height.\nIn doing so, it makes the assumption that sprites and sprite-sheets do not have any borders or padding.\n(Because borders and padding result in larger download times for users, this restriction is considered acceptable, but it may be lifted at some time in the future.)\n\n    Sheet = (source, sprite_width, sprite_height) ->\n\nFirst, we need to handle the arguments.\nIf `source` isn't an image type that we recognize, we go ahead and set it to `null`.\nAnd if the `sprite_width` or `sprite_height` aren't recognizable as numbers, we set them to 0.\n(Note from the above that a `Sheet` with zero `sprite_width` or `sprite_height` cannot be drawn.)\n\n        unless source instanceof HTMLImageElement or source instanceof SVGImageElement or source instanceof HTMLCanvasElement or createImageBitmap? and source instanceof ImageBitmap then source = null\n        if isNaN(sprite_width = Number(sprite_width)) then sprite_width = 0\n        if isNaN(sprite_height = Number(sprite_height)) then sprite_height = 0\n\nRecall that we need to check for `createImageBitmap` before checking to see if the source is an `ImageBitmap`.\n\nWe can get the width and height of the image from one of two sources, depending on the source type.\nAll of the accepted types have `width` and `height` properties, which specify their dimensions.\nHowever, `HTMLImageElement`s also have `naturalWidth` and `naturalHeight` properties, and these should be preferred for pixel-perfect rendering.\n\nIf for some reason we can't get *either* of these properties, then the `source_width` and `source_height` are set to zero.\n\n        unless source? and not isNaN(source_width = Number(if source.naturalWidth? then source.naturalWidth else source.width)) then source_width = 0\n        unless source? and not isNaN(source_height = Number(if source.naturalHeight? then source.naturalHeight else source.height)) then source_height = 0\n\nWe now have everything we need to define the properties.\nNote that `width` and `height` are provided in sprite-units, not pixels.\nIf `sprite_width` or `sprite_height` are `0`, then the corresponding `width` and `height` are obviously `NaN`.\n\n        @height = Math.floor source_height \/ sprite_height\n        @source = source\n        @sprite_height = sprite_height\n        @sprite_width = sprite_width\n        @width = Math.floor source_width \/ sprite_width\n\nThe `size` property is just `width` times `height`.\n\n        @size = @width * @height\n\n`ImageBitmap`s are optimized for drawing to the canvas.\nIf they are supported, we can pre-render the sprite-sheet and store this in the `image` property.\n\n        if createImageBitmap? then (createImageBitmap source).then (image) => @image = image\n\nBecause `Sheet`s contain static images, it doesn't make sense for them to change after creation.\nWe freeze them:\n\n        Object.freeze this\n\nFor convenience's sake, two static methods have been defined for `Sheet` to let you draw arbitrary sprites.\nThese are largely intended for use with callbacks.\n\nThe first is called `draw`, and takes five arguments:\n\n- `context`: A `CanvasRenderingContext2D`\n- `sprite`: A `Sprite`\n- `x`: The x-coordinate at which to draw the sprite\n- `y`: The y-coordinate at which to draw the sprite\n- `frame`: The frame of the animation which to draw\n\nIt maps onto `sprite.draw`:\n\n    Sheet.draw = (context, sprite, x, y, frame = 0) -> if sprite instanceof Sprite then sprite.draw context, x, y, frame\n\nThe second is called `drawSheetAtIndex`, and also takes five arguments:\n\n- `context`: A `CanvasRenderingContext2D`\n- `sheet`: A `Sheet`\n- `index`: The index of the sprite\n- `x`: The x-coordinate at which to draw the sprite\n- `y`: The y-coordinate at which to draw the sprite\n\nIt maps onto `sheet.drawIndex`:\n\n    Sheet.drawSheetAtIndex = (context, sheet, index, x, y) -> if sheet instanceof Sheet then sheet.drawIndex context, index, x, y\n\nFinally, the `Sprite` constructor is added to `Sheet` for later access:\n\n    Sheet.Sprite = Sprite\n\nAnd now we can make `Sheet` available to the window:\n\n    window.Sheet = Sheet\n\n##  The prototype  ##\n\nThe `Sheet` prototype is fairly minimal, consisting of only two functions.\n\n    Sheet.prototype = {\n\nThe first, `drawIndex`, draws the sprite located at the given `index`.\nIt is little more than a repackaging of `drawSprite`.\n\n        drawIndex: (context, index, x, y) -> drawSprite this, index, context, x, y\n\nThe second, `getSprite`, creates a new `Sprite` pointing to the given `index`.\nIt is the most convenient way of creating `Sprite` objects.\nIt takes two arguments, the `index` of the sprite, and the `length` of the animation.\n\n        getSprite: (index, length = 1) -> new Sprite this, index, length\n\nWe can now freeze the prototype:\n\n    }\n\n    Object.freeze Sheet.prototype\n\n\u2026And that's the end!\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3ca4f2abd590a558c3bfff4904f7754bbedb4ccb","subject":"custom nbsp parsing in markdown","message":"custom nbsp parsing in markdown\n","repos":"romanpitak\/html-resume","old_file":"bin\/render-html.litcoffee","new_file":"bin\/render-html.litcoffee","new_contents":"# Builder\n\n### Load modules\n\n    {readFileSync, writeFileSync} = require 'fs'\n    {renderFile} = require 'jade'\n    {safeLoad} = require 'js-yaml'\n    marked = require 'marked'\n\n### Add custom `nbsp` support\n\nExtend the default `renderer.paragraph` method\nby first replacing all `~` characters\n(which I don't use in paragraphs) with `&nbsp;`.\nIf I want to add a `~` character, I can write `&#126;`.\n\n    renderer = new marked.Renderer()\n    {paragraph} = renderer\n    renderer.paragraph = (text) ->\n        return paragraph text.replace \/~\/g, '&nbsp;'\n\nOverride the `marked` function by a new one with the custom renderer. \n\n    marked = do (marked) ->\n        return (text) ->\n            return marked text,\n                renderer: renderer\n\n### Render html\n\n    options = safeLoad readFileSync process.argv[3], 'utf8'\n    options.markdown = marked\n    html = renderFile process.argv[2], options\n\n### Write the output\n\n    if process.argv[4]?\n        writeFileSync process.argv[4], html\n    else\n        console.log html\n","old_contents":"# Builder\n\nload modules\n\n    {readFileSync, writeFileSync} = require 'fs'\n    {renderFile} = require 'jade'\n    {safeLoad} = require 'js-yaml'\n    marked = require 'marked'\n\nrender html\n\n    options = safeLoad readFileSync process.argv[3], 'utf8'\n    options.markdown = marked\n    html = renderFile process.argv[2], options\n\nwrite the output\n\n    if process.argv[4]?\n        writeFileSync process.argv[4], html\n    else\n        console.log html\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3c579068d362c1fb9bedb308c797f79a396f48dd","subject":"fix maxage for static caching, one more 0","message":"fix maxage for static caching, one more 0\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/app.litcoffee","new_file":"src\/app.litcoffee","new_contents":"\n# Application Startup\n\nThis code starts up the application.\n\n## Configure\n\nFirst, include required modules.\n\n    express = require 'express'\n    exp3hbs = require 'express3-handlebars'\n    redis_store = require('connect-redis')(express)\n    config = require '.\/config\/config.js'\n    secrets = require '.\/config\/private.js'\n\nNext, initialize the application.\n\n    app = express()\n\nConfigure HBS to glue Express and Handlebars together with HTML file extensions\nfor templates.\n\n    app.set 'view engine', 'html'\n    exp3hbs_config =\n      defaultLayout: 'default',\n      extname: '.html'\n    app.engine 'html', exp3hbs(exp3hbs_config)\n\nConfigure Express to serve static files.\n\n    app.use express.static('public', { maxAge: 86400000 })\n\nInitialize a session for later use.  Associate session data with\n`res.locals.session`.\n\n    app.use express.cookieParser(secrets.session_key)\n    app.use express.session({\n      store: new redis_store({host: config.redis_host, port: config.redis_port, prefix: config.redis_prefix}),\n      secret: secrets.session_key,\n      maxAge: 86400000\n    })\n    app.use (req, res, next) ->\n      res.locals.session = req.session\n      next()\n\nPlace directory URL in a place where we can find it later.\n\n    app.directory_url = secrets.directory_url\n\n## Cross-Site Request Forgeries\n\nAdd the CSRF submission protection middleware.  This generates\n`req.session.\\_csrf` and maps it to `res.locals.token` so it will be available\nin all templates as {{{token}}}.\n\nAnything other than a GET, HEAD, or OPTIONS will require a valid `\\_CSRF` field\nor else it will be rejected with a 403.\n\nMust be after sessions and before routers.\n\n    app.use express.bodyParser()\n    app.use express.csrf()\n    app.use (req, res, next) ->\n      res.locals.token = req.csrfToken()\n      next()\n\n## Database\n\nConnect to MongoDB through Mongoose and initialize models.\n\n    app.models = require('.\/lib\/models')(config)\n\n## Routes\n\nExecute routes module.\n\n    app.use (req, res, next) ->\n      if req.session.securityLevel\n        res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0')\n      next()\n\n    require('.\/lib\/routes')(app)\n\n## Errors\n\nExecute error handling module.\n\n    require('.\/lib\/error')(app)\n\n    # This must be the very last middleware added to the app\n    require('.\/lib\/error\/404')(app)\n\n## Startup\n\nFinally, start the server.\n\n    app.listen config.port, config.ip\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Startup\n\nThis code starts up the application.\n\n## Configure\n\nFirst, include required modules.\n\n    express = require 'express'\n    exp3hbs = require 'express3-handlebars'\n    redis_store = require('connect-redis')(express)\n    config = require '.\/config\/config.js'\n    secrets = require '.\/config\/private.js'\n\nNext, initialize the application.\n\n    app = express()\n\nConfigure HBS to glue Express and Handlebars together with HTML file extensions\nfor templates.\n\n    app.set 'view engine', 'html'\n    exp3hbs_config =\n      defaultLayout: 'default',\n      extname: '.html'\n    app.engine 'html', exp3hbs(exp3hbs_config)\n\nConfigure Express to serve static files.\n\n    app.use express.static('public', { maxAge: 8640000 })\n\nInitialize a session for later use.  Associate session data with\n`res.locals.session`.\n\n    app.use express.cookieParser(secrets.session_key)\n    app.use express.session({\n      store: new redis_store({host: config.redis_host, port: config.redis_port, prefix: config.redis_prefix}),\n      secret: secrets.session_key,\n      maxAge: 86400000\n    })\n    app.use (req, res, next) ->\n      res.locals.session = req.session\n      next()\n\nPlace directory URL in a place where we can find it later.\n\n    app.directory_url = secrets.directory_url\n\n## Cross-Site Request Forgeries\n\nAdd the CSRF submission protection middleware.  This generates\n`req.session.\\_csrf` and maps it to `res.locals.token` so it will be available\nin all templates as {{{token}}}.\n\nAnything other than a GET, HEAD, or OPTIONS will require a valid `\\_CSRF` field\nor else it will be rejected with a 403.\n\nMust be after sessions and before routers.\n\n    app.use express.bodyParser()\n    app.use express.csrf()\n    app.use (req, res, next) ->\n      res.locals.token = req.csrfToken()\n      next()\n\n## Database\n\nConnect to MongoDB through Mongoose and initialize models.\n\n    app.models = require('.\/lib\/models')(config)\n\n## Routes\n\nExecute routes module.\n\n    app.use (req, res, next) ->\n      if req.session.securityLevel\n        res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0')\n      next()\n\n    require('.\/lib\/routes')(app)\n\n## Errors\n\nExecute error handling module.\n\n    require('.\/lib\/error')(app)\n\n    # This must be the very last middleware added to the app\n    require('.\/lib\/error\/404')(app)\n\n## Startup\n\nFinally, start the server.\n\n    app.listen config.port, config.ip\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"531c4514a31e700e29a7154a3da6c4055af35645","subject":"added exports","message":"added exports\n","repos":"nhz-io\/cnl","old_file":"source\/index.litcoffee","new_file":"source\/index.litcoffee","new_contents":"# cnl    \n\n## CLASSES\n* [Engine][Engine] - rendering engine\n* [Element][Element] - visual element\n* [Shape][Shape] - drawable shape\n* [Component][Component] - interactive component\n* [Style][Style] - loadable style\n* [Pen][Pen] - drawing pen\n\n---\n\n### EXPORTS  \n\n    module.exports =\n      Engine    : require '.\/base'\n      Element   : require '.\/element'\n      Shape     : require '.\/shape'\n      Style     : require '.\/style'\n      Pen       : require '.\/pen'\n      Component : require '.\/component'\n\n[Engine]: .\/engine.litcoffee\n[Element]: .\/element.litcoffee\n[Component]: .\/component.litcoffee\n[Shape]: .\/shape.litcoffee\n[Style]: .\/style.litcoffee\n[Pen]: .\/pen.litcoffee\n","old_contents":"# ecl    \n\n## CLASSES\n* [Engine][Engine] - rendering engine\n\n---\n\n### EXPORTS  \n\n    module.exports =\n      Engine    : require '.\/base'\n\n[Engine]: .\/base.litcoffee\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"59a346378f858119e8b6f1ee0a6301a93d14abbf","subject":"Widened help display","message":"Widened help display\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/arguments.litcoffee","new_file":"lib\/arguments.litcoffee","new_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] name1 name2 ...'\n      .example '$0',\n        'Creates a 50 x 15 level with 16 x 14 cells and an auto-generated name'\n      .example '$0 -vvvvvvvv',\n        \"Create a 50 x 15 level with 16 x 14 cells, an auto-generated name, and\n        logging set to verbosity level 8 (max)\"\n      .example '$0 -w 20 -h 20',\n        'Creates a 50 x 15 level with 40 X 40 cells & an auto-generated name'\n      .example '$0 -w 10 -h 10 -x 4',\n        'Creates a 50 x 15 level with 40 x 40 cells and an auto-generated name'\n      .example '$0 lvl1 lvl2',\n        'Creates two levels, lvl1 & lvl2, each 50 X 15 with 16 x 14 cells'\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      8\n        height:     7\n        multiplier: 4\n        pipeline:   [ 'png_blocks', 'png_walls', 'png_step_count' ]\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .wrap 120\n      .argv\n","old_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] name1 name2 ...'\n      .example '$0',\n        'Creates a 50 x 15 level with 16 x 14 cells and an auto-generated name'\n      .example '$0 -vvvvvvvv',\n        \"Create a 50 x 15 level with 16 x 14 cells, an auto-generated name, and\n        logging set to verbosity level 8 (max)\"\n      .example '$0 -w 20 -h 20',\n        'Creates a 50 x 15 level with 40 X 40 cells & an auto-generated name'\n      .example '$0 -w 10 -h 10 -x 4',\n        'Creates a 50 x 15 level with 40 x 40 cells and an auto-generated name'\n      .example '$0 lvl1 lvl2',\n        'Creates two levels, lvl1 & lvl2, each 50 X 15 with 16 x 14 cells'\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      8\n        height:     7\n        multiplier: 4\n        pipeline:   [ 'png_blocks', 'png_walls', 'png_step_count' ]\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .argv\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c4a00624fef5af46554785faa14bc455c2a692f9","subject":"Fixed getTranslation\/getX\/getY\/getZ reading from the wrong parts of the matrix.  Added setTranslation\/setX\/setY\/setZ functions.  Added an experimental matrix interpolation function.","message":"Fixed getTranslation\/getX\/getY\/getZ reading from the wrong parts of the\nmatrix.  Added setTranslation\/setX\/setY\/setZ functions.  Added an\nexperimental matrix interpolation function.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat","old_file":"src\/matrix.litcoffee","new_file":"src\/matrix.litcoffee","new_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    tempVector = []\n    tempVectorFrom = []\n    tempVectorTo = []\n    fromTemp = []\n    toTemp = []\n    tempVectorX = []\n    tempVectorY = []\n    tempVectorZ = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            module.exports.multiply output, temp3, output\n            return\n\n    vector = require \".\/vector.litcoffee\"\n            \n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\nGiven a vector specifying a translation and a matrix to translate, calling the \n\"translate\" property applies that translation to that matrix.\n            \n        translate: (vector, output) ->\n            output[3] += vector[0]\n            output[7] += vector[1]\n            output[11] += vector[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \nGiven a matrix, input vector and output vector, calling the \"applyToVector\"\nproperty writes the input vector transformed by the matrix to the output vector.\n        \n        applyToVector: (matrix, input, output) ->\n            vector.copy input, vectorTemp\n            output[0] = vectorTemp[0] * matrix[0] + vectorTemp[1] * matrix[1] + vectorTemp[2] * matrix[2] + matrix[3]\n            output[1] = vectorTemp[0] * matrix[4] + vectorTemp[1] * matrix[5] + vectorTemp[2] * matrix[6] + matrix[7]\n            output[2] = vectorTemp[0] * matrix[8] + vectorTemp[1] * matrix[9] + vectorTemp[2] * matrix[10] + matrix[11]\n            return\n            \nGiven a matrix and output vector, calling the \"getTranslation\" property writes\nthe translation applied by the matrix to the output vector.\n\n        getTranslation: (matrix, output) ->\n            output[0] = matrix[3]\n            output[1] = matrix[7]\n            output[2] = matrix[11]\n\nGiven a matrix and output vector, calling the \"getX\" property writes the vector\nof the matrix's X axis (a scaled normal) to the output vector.\n\n        getX: (matrix, output) ->\n            output[0] = matrix[0]\n            output[1] = matrix[1]\n            output[2] = matrix[2]\n\nGiven a matrix and output vector, calling the \"getY\" property writes the vector\nof the matrix's Y axis (a scaled normal) to the output vector.\n\n        getY: (matrix, output) ->\n            output[0] = matrix[4]\n            output[1] = matrix[5]\n            output[2] = matrix[6]\n            \nGiven a matrix and output vector, calling the \"getZ\" property writes the vector\nof the matrix's Z axis (a scaled normal) to the output vector.\n\n        getZ: (matrix, output) ->\n            output[0] = matrix[8]\n            output[1] = matrix[9]\n            output[2] = matrix[10]\n            \n# setTranslation\n\n- A vector specifying the translation to set.\n- A matrix to set the translation of.\n\nOverwrites the translation of the matrix with the content of the given vector.\n\n        setTranslation: (output, matrix) ->\n            matrix[3] = output[0]\n            matrix[7] = output[1]\n            matrix[11] = output[2]\n\n# setX\n\n- A vector specifying the X axis vector to set.\n- A matrix to set the X axis vector of.\n\nOverwrites the X axis of the matrix with the content of the given vector.\n\n        setX: (output, matrix) ->\n            matrix[0] = output[0]\n            matrix[1] = output[1]\n            matrix[2] = output[2]\n\n# setY\n\n- A vector specifying the Y axis vector to set.\n- A matrix to set the Y axis vector of.\n\nOverwrites the Y axis of the matrix with the content of the given vector.\n\n        setY: (output, matrix) ->\n            matrix[4] = output[0]\n            matrix[5] = output[1]\n            matrix[6] = output[2]\n\n# setZ\n\n- A vector specifying the Z axis vector to set.\n- A matrix to set the Z axis vector of.\n\nOverwrites the Z axis of the matrix with the content of the given vector.\n\n        setZ: (output, matrix) ->\n            matrix[8] = output[0]\n            matrix[9] = output[1]\n            matrix[10] = output[2]\n            \n# interpolate\n\n- An input matrix to interpolate from.\n- An input matrix to interpolate to.\n- A number specifying how far along to interpolate; \"0\" is \"from\" and \"1\" is \n  \"to\".\n- An output matrix.\n\nAttempts to perform a somewhat crude interpolation between the two matrices\nwhich is not very linear.  Good enough for smoothing over small changes.\nPrioritizes the Z and Y axes over the X axis when ensuring orthogonal.\n\n        interpolate: (from, to, alpha, output) ->       \n            module.exports.copy from, fromTemp\n            module.exports.copy to, toTemp\n            module.exports.identity output\n            module.exports.getTranslation fromTemp, tempVectorFrom\n            module.exports.getTranslation toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            module.exports.setTranslation tempVector, output\n            \n            module.exports.getX fromTemp, tempVectorFrom\n            module.exports.getX toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            vector.normalize tempVector, tempVectorX, true  \n            \n            module.exports.getY fromTemp, tempVectorFrom\n            module.exports.getY toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVectorY\n            \n            vector.cross tempVectorX, tempVectorY, tempVectorZ\n            vector.normalize tempVectorZ, tempVectorZ\n            vector.cross tempVectorZ, tempVectorX, tempVectorY\n            vector.normalize tempVectorY, tempVectorY\n            \n            module.exports.setX tempVectorX, output\n            module.exports.setY tempVectorY, output\n            module.exports.setZ tempVectorZ, output\n            return\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","old_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    vectorTemp = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            module.exports.multiply output, temp3, output\n            return\n\n    vector = require \".\/vector.litcoffee\"\n            \n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\nGiven a vector specifying a translation and a matrix to translate, calling the \n\"translate\" property applies that translation to that matrix.\n            \n        translate: (vector, output) ->\n            output[3] += vector[0]\n            output[7] += vector[1]\n            output[11] += vector[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \nGiven a matrix, input vector and output vector, calling the \"applyToVector\"\nproperty writes the input vector transformed by the matrix to the output vector.\n        \n        applyToVector: (matrix, input, output) ->\n            vector.copy input, vectorTemp\n            output[0] = vectorTemp[0] * matrix[0] + vectorTemp[1] * matrix[1] + vectorTemp[2] * matrix[2] + matrix[3]\n            output[1] = vectorTemp[0] * matrix[4] + vectorTemp[1] * matrix[5] + vectorTemp[2] * matrix[6] + matrix[7]\n            output[2] = vectorTemp[0] * matrix[8] + vectorTemp[1] * matrix[9] + vectorTemp[2] * matrix[10] + matrix[11]\n            return\n            \nGiven a matrix and output vector, calling the \"getTranslation\" property writes\nthe translation applied by the matrix to the output vector.\n\n        getTranslation: (matrix, output) ->\n            output[0] = matrix[12]\n            output[1] = matrix[13]\n            output[2] = matrix[14]\n\nGiven a matrix and output vector, calling the \"getX\" property writes the vector\nof the matrix's X axis (a scaled normal) to the output vector.\n\n        getX: (matrix, output) ->\n            output[0] = matrix[0]\n            output[1] = matrix[4]\n            output[2] = matrix[8]\n\nGiven a matrix and output vector, calling the \"getY\" property writes the vector\nof the matrix's Y axis (a scaled normal) to the output vector.\n\n        getY: (matrix, output) ->\n            output[0] = matrix[1]\n            output[1] = matrix[5]\n            output[2] = matrix[9]\n            \nGiven a matrix and output vector, calling the \"getZ\" property writes the vector\nof the matrix's Z axis (a scaled normal) to the output vector.\n\n        getZ: (matrix, output) ->\n            output[0] = matrix[2]\n            output[1] = matrix[6]\n            output[2] = matrix[10]\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3b054764b0e547c8b2ac6735446cda78ccbdd4b8","subject":"Clean up iteration logic","message":"Clean up iteration logic\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = underscore tokens[1].trim()\n      else if tokens.length == 1\n        alias = underscore name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @DUMMY: (deps, cb) ->\n        class __DUMMY__ extends Madul\n          deps: deps\n\n        new __DUMMY__()\n          .initialize()\n          .then cb\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || underscore(name), alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            WRAPPED[proto.constructor.name].push method\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, (errors) =>\n              if errors?\n                wrapped errors\n              else\n                proto[\"_#{method}\"] = proto[method]\n\n                proto[method] = =>\n                  def = q.defer()\n                  me  = proto[\"_#{method}\"]\n\n                  if args_format == 'ARRAY'\n                    args = Array.prototype.slice.call arguments\n                  else if args_format == 'OBJECT'\n                    args = arguments[0]\n                  else\n                    proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                    return def.reject 'No arg format specified'\n\n                  before = @_process_decorators me, 'before'\n                  after  = @_process_decorators me, 'after'\n\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries me.validators, (v, next) =>\n                      arg       = Object.keys(v)[0]\n                      validator = v[arg]\n                      input     = arg\n                      prop      = args\n\n                      for a in arg.split '.'\n                        prop  = prop[a]\n                        input = a\n\n                      if Array.isArray validator\n                        async.eachSeries validator, (v, nxt) =>\n                          proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                          proto[v].EXECUTE.call proto[v], input, prop\n                            .then nxt\n                            .catch handle_err v, { \"#{input}\": prop }, nxt, (err) =>\n                              reject err\n                              def.reject err\n                        , next\n                      else\n                        proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                        proto[validator].EXECUTE.call proto[validator], input, prop\n                          .then next\n                          .catch handle_err v, { \"#{input}\": prop }, next, (err) =>\n                            reject err\n                            def.reject err\n                    , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      async.eachSeries before, (b, next) =>\n                        proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                        proto[b].before.call proto[b], args\n                          .then next\n                          .catch handle_err b, args, next, (err) =>\n                            reject err\n                            def.reject err\n                      , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      d     = q.defer()\n                      input = proto._prep_invocation proto, method, args, d\n\n                      try\n                        me.behavior.apply proto, input\n                          .then  (out) => resolve out\n                          .catch (err) => reject  err\n                      catch e\n                        me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                        reject e\n                  .catch (err) => def.reject err\n                  .then (result) =>\n                    q.Promise (resolve, reject) =>\n                      if after.length > 0\n                        async.eachSeries after, (a, next) =>\n                          proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                          proto[a].after.call proto[a], result\n                            .then next\n                            .catch handle_err b, args, next, (err) =>\n                              reject err\n                              def.reject err\n                        , => resolve result\n                      else\n                        process.nextTick => resolve result\n                  .then  (out) => def.resolve out\n                  .catch (err) => def.reject  err\n\n                  def.promise\n\n                INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n                WRAPPED[proto.constructor.name].push method\n\n                wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if proto.deps?\n                filtered = proto.deps.filter (d) => Madul.PARSE_SPEC(d).name == prop.replace \/_\/g, '-'\n\n                continue if filtered.length > 0\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, (errors) =>\n              if errors?\n                stop = new Error()\n                stop.break = true\n\n                next stop\n              else\n                next()\n          , (errors) =>\n            if errors?\n              stop = new Error()\n              stop.break = true\n\n              completed stop\n            else\n              @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{strip name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, (errors) =>\n                if errors?\n                  stop = new Error()\n                  stop.break = true\n\n                  next stop\n                else\n                  HYDRATED[name] = true\n\n                  for listener in HYRDATION_LISTENERS[name]\n                    listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, done, fail) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then  (m)   => done m\n            .catch (err) => fail err\n        else\n          done mod\n\n      _load: (me, name, path, loaded, fail) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded()\n        , fail\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.eachSeries files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.' && f != 'node_modules'\n                  me._check me, depth, dep, ref, => next()\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  stop  = new Error()\n                  stop.break = true\n\n                  me._load me, ref, depth, =>\n                    me._do_add me, ref, => next stop\n                  , (err) => next stop\n                else\n                  next()\n            , => finished()\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next() if typeof next == 'function'\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n        , (err) =>\n          stop = new Error()\n          stop.break = true\n\n          next stop\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n        errors  = [ ]\n\n        async.eachSeries deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                if proto[spec.parent]?\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                    if err?\n                      deep = \"#{SEARCH_ROOTS[spec.parent]}\/node_modules\/#{spec.parent}\/dist\"\n\n                      proto._check proto, deep, spec.name, spec.ref, (e) =>\n                        next()\n                    else\n                      next()\n                else\n                  proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                  @_do_hydrate proto, [ spec.parent ], (errors) =>\n                    if errors?\n                      stop = new Error()\n                      stop.break = true\n\n                      next stop\n                    else\n                      if SEARCH_ROOTS[spec.parent] == undefined\n                        SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                      proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                        if err?\n                          deep = \"#{SEARCH_ROOTS[spec.parent]}\/node_modules\/#{spec.parent}\/dist\"\n\n                          proto._check proto, deep, spec.name, spec.ref, (e) =>\n                            next()\n                        else\n                          next()\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    nxt()\n                  , =>\n                    nxt()\n                , =>\n                  next()\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, (err) =>\n                  if err?\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next stop\n                  else\n                    next()\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , (err) =>\n          if err?.length > 0\n            proto.warn.call proto, 'hydration.halt', errors\n\n            hydration_complete errors\n          else\n            async.eachSeries initers, (initer, next) =>\n              proto[initer.execute].apply(@).then next\n            , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, next) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n        fs.stat pkg, (err, stat) =>\n          if err?\n            next()\n          else if stat.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            next()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        filtered = found.filter (f) => f?\n\n        if filtered.length > 0\n          filtered.sort((a, b) => a.length - b.length)[0]\n        else\n          [ ]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, (errors) =>\n            if errors?\n              deferred.reject errors\n            else\n              @_wrap_methods proto, (err) =>\n                if err?\n                  deferred.reject err\n                else\n                  @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = underscore tokens[1].trim()\n      else if tokens.length == 1\n        alias = underscore name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @DUMMY: (deps, cb) ->\n        class __DUMMY__ extends Madul\n          deps: deps\n\n        new __DUMMY__()\n          .initialize()\n          .then cb\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || underscore(name), alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            WRAPPED[proto.constructor.name].push method\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, (errors) =>\n              if errors?\n                wrapped errors\n              else\n                proto[\"_#{method}\"] = proto[method]\n\n                proto[method] = =>\n                  def = q.defer()\n                  me  = proto[\"_#{method}\"]\n\n                  if args_format == 'ARRAY'\n                    args = Array.prototype.slice.call arguments\n                  else if args_format == 'OBJECT'\n                    args = arguments[0]\n                  else\n                    proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                    return def.reject 'No arg format specified'\n\n                  before = @_process_decorators me, 'before'\n                  after  = @_process_decorators me, 'after'\n\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries me.validators, (v, next) =>\n                      arg       = Object.keys(v)[0]\n                      validator = v[arg]\n                      input     = arg\n                      prop      = args\n\n                      for a in arg.split '.'\n                        prop  = prop[a]\n                        input = a\n\n                      if Array.isArray validator\n                        async.eachSeries validator, (v, nxt) =>\n                          proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                          proto[v].EXECUTE.call proto[v], input, prop\n                            .then nxt\n                            .catch handle_err v, { \"#{input}\": prop }, nxt, (err) =>\n                              reject err\n                              def.reject err\n                        , next\n                      else\n                        proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                        proto[validator].EXECUTE.call proto[validator], input, prop\n                          .then next\n                          .catch handle_err v, { \"#{input}\": prop }, next, (err) =>\n                            reject err\n                            def.reject err\n                    , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      async.eachSeries before, (b, next) =>\n                        proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                        proto[b].before.call proto[b], args\n                          .then next\n                          .catch handle_err b, args, next, (err) =>\n                            reject err\n                            def.reject err\n                      , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      d     = q.defer()\n                      input = proto._prep_invocation proto, method, args, d\n\n                      try\n                        me.behavior.apply proto, input\n                          .then  (out) => resolve out\n                          .catch (err) => reject  err\n                      catch e\n                        me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                        reject e\n                  .catch (err) => def.reject err\n                  .then (result) =>\n                    q.Promise (resolve, reject) =>\n                      if after.length > 0\n                        async.eachSeries after, (a, next) =>\n                          proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                          proto[a].after.call proto[a], result\n                            .then next\n                            .catch handle_err b, args, next, (err) =>\n                              reject err\n                              def.reject err\n                        , => resolve result\n                      else\n                        process.nextTick => resolve result\n                  .then  (out) => def.resolve out\n                  .catch (err) => def.reject  err\n\n                  def.promise\n\n                INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n                WRAPPED[proto.constructor.name].push method\n\n                wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if proto.deps?\n                filtered = proto.deps.filter (d) => Madul.PARSE_SPEC(d).name == prop.replace \/_\/g, '-'\n\n                continue if filtered.length > 0\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, (errors) =>\n              if errors?\n                stop = new Error()\n                stop.break = true\n\n                next stop\n              else\n                next()\n          , (errors) =>\n            if errors?\n              stop = new Error()\n              stop.break = true\n\n              completed stop\n            else\n              @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{strip name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, (errors) =>\n                if errors?\n                  stop = new Error()\n                  stop.break = true\n\n                  next stop\n                else\n                  HYDRATED[name] = true\n\n                  for listener in HYRDATION_LISTENERS[name]\n                    listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, done, fail) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then  (m)   => done m\n            .catch (err) => fail err\n        else\n          done mod\n\n      _load: (me, name, path, loaded, fail) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded()\n        , fail\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            error   = true\n            checked = 0\n\n            async.eachOfSeries files, (f, i, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.' && f != 'node_modules'\n                  me._check me, depth, dep, ref, => next()\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  stop  = new Error()\n                  stop.break = true\n\n                  me._load me, ref, depth, =>\n                    error  = undefined\n                    loaded = true\n\n                    me._do_add me, ref, => next stop\n                  , (err) => next stop\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next() if typeof next == 'function'\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n        , (err) =>\n          stop = new Error()\n          stop.break = true\n\n          next stop\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n        errors  = [ ]\n\n        async.eachSeries deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                if proto[spec.parent]?\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                    if err?\n                      deep = \"#{SEARCH_ROOTS[spec.parent]}\/node_modules\/#{spec.parent}\/dist\"\n\n                      proto._check proto, deep, spec.name, spec.ref, (e) =>\n                        next()\n                    else\n                      next()\n                else\n                  proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                  @_do_hydrate proto, [ spec.parent ], (errors) =>\n                    if errors?\n                      stop = new Error()\n                      stop.break = true\n\n                      next stop\n                    else\n                      if SEARCH_ROOTS[spec.parent] == undefined\n                        SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                      proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                        if err?\n                          deep = \"#{SEARCH_ROOTS[spec.parent]}\/node_modules\/#{spec.parent}\/dist\"\n\n                          proto._check proto, deep, spec.name, spec.ref, (e) =>\n                            next()\n                        else\n                          next()\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    nxt()\n                  , =>\n                    nxt()\n                , =>\n                  next()\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, (err) =>\n                  if err?\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next stop\n                  else\n                    next()\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , (err) =>\n          if err?.length > 0\n            proto.warn.call proto, 'hydration.halt', errors\n\n            hydration_complete errors\n          else\n            async.eachSeries initers, (initer, next) =>\n              proto[initer.execute].apply(@).then next\n            , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, next) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n        fs.stat pkg, (err, stat) =>\n          if err?\n            next()\n          else if stat.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            next()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        filtered = found.filter (f) => f?\n\n        if filtered.length > 0\n          filtered.sort((a, b) => a.length - b.length)[0]\n        else\n          [ ]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, (errors) =>\n            if errors?\n              deferred.reject errors\n            else\n              @_wrap_methods proto, (err) =>\n                if err?\n                  deferred.reject err\n                else\n                  @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7665d258ec03bfaf1bcd7e617b0429e6e08031cc","subject":"Remove debug output","message":"Remove debug output\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.tilbyder}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      console.log sentry\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.tilbyder}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fc9b26d4a1346d4a2d6fcf3f935076d1321ffd68","subject":"Remove welcome litcoffee file","message":"Remove welcome litcoffee file\n","repos":"rianadon\/CheckPCR,rianadon\/CheckPCR,19RyanA\/CheckPCR,rianadon\/CheckPCR,19RyanA\/CheckPCR","old_file":"welcome.litcoffee","new_file":"welcome.litcoffee","new_contents":"","old_contents":"Welcome to the welcome file.\n\nThis script runs on the welcome page, which welcomes new users, to make it more welcoming.\nIf you haven't already, I welcome you to view the more important [main script](client.litcoffee).\n\nAlso, if you haven't noticed yet, I'm trying my best to use the word welcome as many times as I can just to welcome you.\n\nFirst off, the buttons big, green, welcoming buttons on the bottom of the welcome page are assigned event listeners so that they can make the page show more welcoming information.\n\n    for nextButton in document.getElementsByClassName \"next\"\n      nextButton.addEventListener \"click\", advance = ->\n        # The box holding the individual pages that ge scrolled\n        # when pressing the \"next\" button is assigned to a varialbe.\n        container = document.body\n        # show the next page\n        view = +container.getAttribute(\"data-view\")\n        window.scrollTo(0,0) # Scoll to top of the page\n        history.pushState {page: view+1}, \"\", \"?page=#{view}\" # Make the broswer register a page shift\n        (npage = document.querySelector(\"section:nth-child(#{view+2})\")).style.display = \"inline-block\"\n        npage.style.transform = npage.style.webkitTransform = npage.style.MozTransform = \"translateX(#{view*100}%)\"\n        # increase the data-view attribute by 1. The rest is handled by the css.\n        container.setAttribute \"data-view\", view+1\n        setTimeout ->\n          #After animating is done, don't display the first page\n          npage.style.transform = npage.style.webkitTransform = npage.style.MozTransform = \"translateX(#{view+1}00%)\"\n          document.querySelector(\"section:nth-child(#{view+1})\").style.display = \"none\"\n        , 50\n        return\n\nAdditionally, the active class needs to be added when text fields are selected (for the login box) [copied from main script].\n\n    for input in document.querySelectorAll \"input[type=text], input[type=password], input[type=email], input[type=url], input[type=tel], input[type=number], input[type=search]\"\n      input.addEventListener \"change\", (evt) ->\n        evt.target.parentNode.querySelector(\"label\").classList.add \"active\"\n      input.addEventListener \"focus\", (evt) ->\n        evt.target.parentNode.querySelector(\"label\").classList.add \"active\"\n      input.addEventListener \"blur\", (evt) ->\n        if evt.target.value.length is 0\n          evt.target.parentNode.querySelector(\"label\").classList.remove \"active\"\n\nAn event listener is attached to the window so that when the back button is pressed, a more welcoming page is displayed.\nMost of the code is the same from next button event listener, except that the page is switched the previous one, not the next one.\n\n    window.onpopstate = (event) ->\n      container = document.body\n      view = if event.state? then event.state.page else 0\n      window.scrollTo(0,0) # Scoll to top of the page\n      (npage = document.querySelector(\"section:nth-child(#{view+1})\")).style.display = \"inline-block\"\n      npage.style.transform = npage.style.webkitTransform = npage.style.MozTransform = \"translateX(#{view*100}%)\"\n      # increase the data-view attribute by 1. The rest is handled by the css.\n      container.setAttribute \"data-view\", view\n      setTimeout ->\n        #After animating is done, don't display the first page\n        npage.style.transform = npage.style.webkitTransform = npage.style.MozTransform = \"translateX(#{view}00%)\"\n        document.querySelector(\"section:nth-child(#{view+2})\").style.display = \"none\"\n      , 50\n      return\n\nWhen there is an error with parsing the data for Athena, a welcoming warning needs to be displayed (and the data needs to be saved too).\n\nThis code below is copied from the main script with two unwelcome lines commented out.\n\n    parseAthenaData = (dat) ->\n      if dat is \"\"\n        athenaData = null\n        localStorage.removeItem \"athenaData\"\n      else\n        try\n          d = JSON.parse dat\n          athenaData2 = {}\n          allCourseDetails = {}\n          for section in d.body.courses.sections\n            allCourseDetails[section.course_nid] = section\n          for course in d.body.courses.courses by -1\n            courseDetails = allCourseDetails[course.nid]\n            athenaData2[course.course_title] =\n              link: \"https:\/\/athena.harker.org\"+courseDetails.link\n              logo: courseDetails.logo.substr(0, courseDetails.logo.indexOf(\"\\\" alt=\\\"\")).replace(\"<div class=\\\"profile-picture\\\"><img src=\\\"\", \"\").replace(\"tiny\", \"reg\")\n              period: courseDetails.section_title\n          athenaData = athenaData2\n          localStorage[\"athenaData\"] = JSON.stringify athenaData\n          document.getElementById(\"athenaDataError\").style.display = \"none\"\n          #document.getElementById(\"athenaDataRefresh\").style.display = \"block\"\n        catch e\n          document.getElementById(\"athenaDataError\").style.display = \"block\"\n          #document.getElementById(\"athenaDataRefresh\").style.display = \"none\"\n          document.getElementById(\"athenaDataError\").innerHTML = e.message\n      return\n\nThe text box also needs to execute this function when anything is typed \/ pasted.\n\n    document.getElementById(\"athenaData\").addEventListener \"input\", (evt) ->\n      parseAthenaData evt.target.value\n\nTo avoid some unwelcoming errors, some constants are defined.\n\n    loginURL = \"\"\n    loginHeaders = {}\n    viewData = {} # The data to send when switching PCR views\n\nThe following code is copied from the main script and slightly modified since there is no login dialog.\n\n    send = (url, respType, headers, data, progress=false) ->\n      return new Promise (resolve, reject) ->\n        req = new XMLHttpRequest()\n        req.open (if data? then \"POST\" else \"GET\"), url, true\n\n        progressElement = document.getElementById \"progress\"\n        progressInner = progressElement.querySelector \"div\"\n        if progress\n          progressElement.offsetWidth # Wait for it to render\n          progressElement.classList.add \"active\"\n          if progressInner.classList.contains \"determinate\"\n            progressInner.classList.remove \"determinate\"\n            progressInner.classList.add \"indeterminate\"\n\n        load = localStorage[\"load\"] or 170000\n\n        req.onload = (evt) ->\n          localStorage[\"load\"] = evt.loaded\n          progressElement.classList.remove \"active\" if progress\n          if req.status is 200\n            resolve req\n          else\n            reject Error req.statusText\n          return\n\n        req.onerror = ->\n          progressElement.classList.remove \"active\" if progress\n          reject Error \"Network Error\"\n          return\n        if progress\n          req.onprogress = (evt) ->\n            if progressInner.classList.contains \"indeterminate\"\n              progressInner.classList.remove \"indeterminate\"\n              progressInner.classList.add \"determinate\"\n            progressInner.style.width = 100 * evt.loaded \/ (if evt.lengthComputable then evt.total else load) + \"%\"\n\n        if respType?\n          req.responseType = respType;\n        if headers?\n          for headername, header of headers\n            req.setRequestHeader headername, header\n        if data?\n          req.send data\n        else\n          req.send()\n        return\n\n    getCookie = (cname) ->\n      name = cname + \"=\"\n      ca = document.cookie.split(\";\")\n      i = 0\n      while i < ca.length\n        c = ca[i]\n        while c.charAt(0) is \" \"\n          c = c.substring(1)\n        if c.indexOf(name) isnt -1\n          return c.substring(name.length, c.length)\n        i++\n      \"\" # Blank if cookie not found\n\n    setCookie = (cname, cvalue, exdays) ->\n      d = new Date\n      d.setTime d.getTime() + exdays * 24 * 60 * 60 * 1000\n      expires = \"expires=\" + d.toUTCString()\n      document.cookie = cname + \"=\" + cvalue + \"; \" + expires\n      return\n\n    snackbar = (message, action, f) ->\n      snack = element \"div\", \"snackbar\"\n      snackInner = element \"div\", \"snackInner\", message\n      snack.appendChild snackInner\n      if action? and f?\n        actionE = element \"a\", [], action\n        actionE.addEventListener \"click\", ->\n            snack.classList.remove \"active\"\n            f()\n        snackInner.appendChild actionE\n\n      add = ->\n        document.body.appendChild snack\n        snack.offsetHeight\n        snack.classList.add \"active\"\n        setTimeout ->\n          snack.classList.remove \"active\"\n          setTimeout ->\n            snack.remove()\n          , 900\n        , 5000\n\n      existing = document.querySelector(\".snackbar\")\n      if existing?\n        existing.classList.remove \"active\"\n        setTimeout add, 300\n      else\n        add()\n      return\n\n    element = (tag, cls, html, id) ->\n      e = document.createElement tag\n      if typeof cls is \"string\"\n        e.classList.add cls\n      else\n        for c in cls\n          e.classList.add c\n      if html?\n        e.innerHTML = html\n      if id?\n        e.setAttribute \"id\", id\n      e\n\n    dologin = (val, submitEvt=false) ->\n      document.getElementById(\"login\").classList.remove \"active\"\n      # setTimeout ->\n      #   document.getElementById(\"loginBackground\").style.display = \"none\"\n      # , 350\n      postArray = [] # Array of data to post\n      localStorage[\"username\"] = if val? and not submitEvt then val[0] else document.getElementById(\"username\").value\n      # updateAvatar()\n      for h of loginHeaders # Loop through the input elements contained in the login page. As mentioned before, they will be sent to PCR to log in.\n        if h.toLowerCase().indexOf(\"user\") isnt -1\n          loginHeaders[h] = if val? and not submitEvt then val[0] else document.getElementById(\"username\").value\n        if h.toLowerCase().indexOf(\"pass\") isnt -1\n          loginHeaders[h] = if val? and not submitEvt then val[1] else document.getElementById(\"password\").value\n        postArray.push encodeURIComponent(h) + \"=\" + encodeURIComponent(loginHeaders[h])\n\n      # Now send the login request to PCR\n      if location.protocol is \"chrome-extension:\"\n        console.time \"Logging in\"\n        send loginURL, \"document\", { \"Content-type\": \"application\/x-www-form-urlencoded\" }, postArray.join(\"&\"), true\n          .then (resp) ->\n            console.timeEnd \"Logging in\"\n            if resp.responseURL.indexOf(\"Login\") isnt -1\n              # If PCR still wants us to log in, then the username or password enterred were incorrect.\n              document.getElementById(\"loginIncorrect\").style.display = \"block\"\n              document.getElementById(\"password\").value = \"\"\n\n              #document.getElementById(\"login\").classList.add \"active\"\n              #document.getElementById(\"loginBackground\").style.display = \"block\"\n            else\n              # Otherwise, we are logged in\n              if document.getElementById(\"remember\").checked #Is the \"remember me\" checkbox checked?\n                setCookie \"userPass\", window.btoa(document.getElementById(\"username\").value + \":\" + document.getElementById(\"password\").value), 14 # Set a cookie with the username and password so we can log in automatically in the future without having to prompt for a username and password again\n              # loadingBar.style.display = \"none\"\n              t = Date.now()\n              localStorage[\"lastUpdate\"] = t\n              #document.getElementById(\"lastUpdate\").innerHTML = formatUpdate t\n              try\n                parse resp.response # Parse the data PCR has replied with\n                display() # Added\n              catch e\n                console.log e\n                alert \"Error parsing assignments. Is PCR on list or month view?\"\n              return\n          , (error) ->\n            console.log \"Could not log in to PCR. Either your network connection was lost during your visit or PCR is just not working. Here's the error:\", error\n      else\n        console.log postArray\n        send \"\/api\/login?remember=#{document.getElementById(\"remember\").checked}\", \"json\", { \"Content-type\": \"application\/x-www-form-urlencoded\" }, postArray.join(\"&\"), true\n          .then (resp) ->\n            console.debug \"Logging in:\",resp.response.time\n            if resp.response.login\n              # If PCR still wants us to log in, then the username or password enterred were incorrect.\n              document.getElementById(\"loginIncorrect\").style.display = \"block\"\n              document.getElementById(\"password\").value = \"\"\n\n              # document.getElementById(\"login\").classList.add \"active\"\n              # document.getElementById(\"loginBackground\").style.display = \"block\"\n            else\n              t = Date.now()\n              localStorage[\"lastUpdate\"] = t\n              #document.getElementById(\"lastUpdate\").innerHTML = formatUpdate t\n\n              window.data = resp.response.data\n              display()\n              localStorage[\"data\"] = JSON.stringify(data)\n            return\n          , (error) ->\n            console.log \"Could not log in to PCR. Either your network connection was lost during your visit or PCR is just not working. Here's the error:\", error\n      return\n\n    attachmentify = (element) ->\n      attachments = []\n\n      # Get all links\n      as = element.getElementsByTagName('a')\n\n      a = 0\n      while a < as.length\n        if as[a].id.indexOf('Attachment') isnt -1\n          attachments.push [\n            as[a].innerHTML\n            as[a].search + as[a].hash\n          ]\n          as[a].remove()\n          a-- # subtract because all elements have shifted down\n        a++\n      attachments\n\n    urlify = (text) ->\n      text.replace \/\/\/ (\n        https?:\\\/\\\/                  # http:\/\/ or https:\/\/\n        [-A-Z0-9+&@#\\\/%?=~_|!:,.;]*  # Any number of url-OK characters\n        [-A-Z0-9+&@#\\\/%=~_|]+        # At least one url-OK character except ?, !, :, ,, ., and ;\n      )\/\/\/ig, (str, str2, offset) -> # Function to replace matches\n        if \/href\\s*=\\s*.\/.test(text.substring(offset - 10, offset)) or\n          \/originalpath\\s*=\\s*.\/.test(text.substring(offset - 20, offset))\n          then str else '<a href=\"' + str + '\">' + str + '<\/a>'\n\n    findId = (element, tag, id) ->\n      for e in element.getElementsByTagName(tag)\n        if e.id.indexOf(id) isnt -1\n          return e\n      return\n\n    parse = (doc) ->\n      console.time \"Handling data\" # To time how long it takes to parse the assignments\n      handledDataShort = [] # Array used to make sure we don\"t parse the same assignment twice.\n      window.data = {classes: [], assignments: [], monthView: doc.querySelector(\".rsHeaderMonth\").parentNode.classList.contains(\"rsSelected\")} # Reset the array in which all of your assignments are stored in.\n\n      for e in doc.getElementsByTagName(\"input\")\n        viewData[e.name] = e.value or \"\"\n\n      # Now, the classes you take are parsed (these are the checkboxes you see up top when looking at PCR).\n\n      classes = findId(doc, \"table\", \"cbClasses\").getElementsByTagName(\"label\")\n      for c in classes\n        window.data.classes.push c.innerHTML\n\n      assignments = doc.getElementsByClassName(\"rsApt rsAptSimple\")\n\n      # Now parse the assignments\n\n      for ca in assignments\n        assignment = {}\n\n        # The starting date and ending date of the assignment are parsed first\n        range = findId(ca, \"span\", \"StartingOn\").innerHTML.split(\" - \")\n        assignment.start = Math.floor (Date.parse range[0])\/1000\/3600\/24\n        assignment.end = if range[1]? then Math.floor (Date.parse range[1])\/1000\/3600\/24 else assignment.start\n\n        # Then, the name of the assignment is parsed\n        t = findId(ca, \"span\", \"lblTitle\")\n        title = t.innerHTML\n\n        # The actual body of the assignment and its attachments are parsed next\n        b = t.parentNode.parentNode\n        divs = b.getElementsByTagName(\"div\")\n        for d in [0...2]\n          divs[0].remove()\n        ap = attachmentify(b) # Separates attachments from the body\n        assignment.attachments = ap\n        assignment.body = urlify(b.innerHTML).replace(\/^(?:\\s*<br\\s*\\\/?>)*\/, \"\").replace(\/(?:\\s*<br\\s*\\\/?>)*\\s*$\/, \"\").trim() # The replaces remove leading and trailing newlines\n\n        # Finally, we separate the class name and type (homework, classwork, or projects) from the title of the assignment\n        assignment.type = title.match(\/\\(([^)]*\\)*)\\)$\/)[1].toLowerCase().replace(\"& quizzes\", \"\").replace(\"tests\", \"test\")\n        assignment.baseType = (ca.title.substring 0, ca.title.indexOf \"\\n\").toLowerCase().replace(\"& quizzes\", \"\").replace(\/\\s\/g, \"\")\n        for c, pos in window.data.classes\n          if title.indexOf(c) isnt -1\n            assignment.class = pos\n            title = title.replace(c,\"\")\n            break\n        assignment.title = title.substring(title.indexOf(\": \") + 2).replace(\/\\([^\\(\\)]*\\)$\/,\"\").trim()\n\n        # To make sure there are no repeats, the title of the assignment (only letters) and its start & end date are combined to give it a unique identifier.\n        assignment.id = assignment.title.replace(\/[^\\w]*\/g, \"\") + (assignment.start + assignment.end)\n        if handledDataShort.indexOf(assignment.id) is -1 # Make sure we haven't already parsed the assignment\n          handledDataShort.push assignment.id\n          window.data.assignments.push assignment\n\n      console.timeEnd \"Handling data\"\n\n      # Now allow the view to be switched\n      document.body.classList.add \"loaded\"\n\n      #display() # Display the data\n      localStorage[\"data\"] = JSON.stringify(data) # Store for offline use\n      return\n\nA slightly modified fetch function is then called\n\n    do ->\n      if location.protocol is \"chrome-extension:\"\n        console.time \"Fetching assignments\"\n        send \"https:\/\/webappsca.pcrsoft.com\/Clue\/SC-Assignments-End-Date-Range\/7536\", \"document\"\n          .then (resp) ->\n            console.timeEnd \"Fetching assignments\"\n            if resp.responseURL.indexOf(\"Login\") isnt -1\n              # We have to log in now\n              loginURL = resp.responseURL\n              for e in resp.response.getElementsByTagName(\"input\")\n                loginHeaders[e.name] = e.value or \"\"\n              console.log \"Need to log in\"\n              ### up = getCookie(\"userPass\") # Attempts to get the cookie *userPass*, which is set if the \"Remember me\" checkbox is checked when logging in through CheckPCR\n              if up is \"\"\n                document.getElementById(\"loginBackground\").style.display = \"block\"\n                document.getElementById(\"login\").classList.add \"active\"\n              else\n                dologin window.atob(up).split(\":\") # Because we were remembered, we can log in immediately without waiting for the user to log in through the login form\n              ###\n              # Add login button event listeners and enable the login button\n              document.getElementById(\"login\").classList.add \"ready\"\n              document.getElementById(\"login\").addEventListener \"submit\", (evt) ->\n                evt.preventDefault()\n                dologin(null, true)\n            else\n              # Logged in now\n              console.log \"Fetching assignments successful\"\n              t = Date.now()\n              localStorage[\"lastUpdate\"] = t\n              # document.getElementById(\"lastUpdate\").innerHTML = formatUpdate t\n              try\n                parse resp.response\n              catch e\n                console.log e\n                alert \"Error parsing assignments. Is PCR on list or month view?\"\n              document.getElementById(\"loginNext\").style.display = \"\"\n              document.getElementById(\"login\").classList.add \"done\"\n            return\n          , (error) ->\n            console.log \"Could not fetch assignments; You are probably offline. Here's the error:\", error\n            snackbar \"You must be online to set up Check PCR. Please refresh when the internet works.\"\n            return\n      else\n        send \"\/api\/start\", \"json\"\n          .then (resp) ->\n            console.debug \"Fetching assignments:\",resp.response.time\n            if resp.response.login\n              loginHeaders = resp.response.loginHeaders\n              # document.getElementById(\"loginBackground\").style.display = \"block\"\n              # document.getElementById(\"login\").classList.add \"active\"\n              # Add login button event listeners and enable the login button\n              document.getElementById(\"login\").classList.add \"ready\"\n              document.getElementById(\"login\").addEventListener \"submit\", (evt) ->\n                evt.preventDefault()\n                dologin(null, true)\n            else\n              console.log \"Fetching assignments successful\"\n              t = Date.now()\n              localStorage[\"lastUpdate\"] = t\n              # document.getElementById(\"lastUpdate\").innerHTML = formatUpdate t\n\n              window.data = resp.response.data\n              localStorage[\"data\"] = JSON.stringify(data)\n              document.getElementById(\"loginNext\").style.display = \"\"\n              document.getElementById(\"login\").classList.add \"done\"\n            return\n          , (error) ->\n            console.log \"Could not fetch assignments; You are probably offline. Here's the error:\", error\n            snackbar \"Could not fetch your assignments\", \"Retry\", fetch\n      return\n\nThe display function is set to advance the setup proccess so there aren't any unwelcoming errors.\n\n    display = advance\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d339a3934ef3c0a613b55ec77d669b49204651f7","subject":"markdown fix","message":"markdown fix","repos":"vpj\/weya,vpj\/weya","old_file":"weya.litcoffee","new_file":"weya.litcoffee","new_contents":"Gist of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n# Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\n## Manipulating dom objects\n\nSet styles\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\nSet events\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\nSet data\n\n     setData = (elem, data) ->\n      for k, v of data\n       elem[k] = v\n\nSet attributes\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        when 'data' then setData elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\nSet ID and Class with `classList`\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       for c in idClass.class\n        elem.classList.add c\n\nSet ID and Class with setAttributes\n\n     setIdClassFallback = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       className = idClass.class.join ' '\n       elem.setAttribute 'class', className\n\nCheck whether classList is available and switch to fallback otherwise\n\n     switchIdClass = ->\n      elem = Api.document.createElementNS \"http:\/\/www.w3.org\/2000\/svg\", 'g'\n      if not elem.classList\n       setIdClass = setIdClassFallback\n\nSwitch to fall back if no classList\n\n     switchIdClass() if Api.document?\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n# Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setData = (buf, data) ->\n      for k, v of data\n       buf.push \" data-#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        when 'data' then setData buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, isVoid, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        className = params.idClass.class.join ' '\n        buf.push \" class=\\\"#{className}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      if isVoid\n       buf.push \"\/>\\n\"\n       if params.func? or params.text?\n        throw new Error 'Void tags cannot have content'\n\n      else\n       buf.push \">\\n\"\n       @_indent++\n\n       if params.func?\n        params.func.call this\n       else if params.text?\n        setIndent buf, @_indent\n        buf.push params.text\n        buf.push \"\\n\"\n\n       @_indent--\n       setIndent buf, @_indent\n       buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name, isVoid) ->\n      ->\n       append.call this, ns, name, isVoid, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name, false\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name, false\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name, true\n\n     return weya\n\n\n# Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n     weyaDom = weyaDomCreate()\n     weyaMarkup = weyaMarkupCreate()\n\n    if module?\n     module.exports = Weya\n","old_contents":"Gist of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\n##Manipulating dom objects\n\nSet styles\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\nSet events\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\nSet data\n\n     setData = (elem, data) ->\n      for k, v of data\n       elem[k] = v\n\nSet attributes\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        when 'data' then setData elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\nSet ID and Class with `classList`\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       for c in idClass.class\n        elem.classList.add c\n\nSet ID and Class with setAttributes\n\n     setIdClassFallback = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       className = idClass.class.join ' '\n       elem.setAttribute 'class', className\n\nCheck whether classList is available and switch to fallback otherwise\n\n     switchIdClass = ->\n      elem = Api.document.createElementNS \"http:\/\/www.w3.org\/2000\/svg\", 'g'\n      if not elem.classList\n       setIdClass = setIdClassFallback\n\nSwitch to fall back if no classList\n\n     switchIdClass() if Api.document?\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setData = (buf, data) ->\n      for k, v of data\n       buf.push \" data-#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        when 'data' then setData buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, isVoid, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        className = params.idClass.class.join ' '\n        buf.push \" class=\\\"#{className}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      if isVoid\n       buf.push \"\/>\\n\"\n       if params.func? or params.text?\n        throw new Error 'Void tags cannot have content'\n\n      else\n       buf.push \">\\n\"\n       @_indent++\n\n       if params.func?\n        params.func.call this\n       else if params.text?\n        setIndent buf, @_indent\n        buf.push params.text\n        buf.push \"\\n\"\n\n       @_indent--\n       setIndent buf, @_indent\n       buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name, isVoid) ->\n      ->\n       append.call this, ns, name, isVoid, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name, false\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name, false\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name, true\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n     weyaDom = weyaDomCreate()\n     weyaMarkup = weyaMarkupCreate()\n\n    if module?\n     module.exports = Weya\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0188f9545c7527260ca1407aedad54a7eceedbc6","subject":"The description here got out of sync from the actual implementation","message":"The description here got out of sync from the actual implementation","repos":"pandastrike\/fairmont-helpers","old_file":"src\/type.litcoffee","new_file":"src\/type.litcoffee","new_contents":"# Type Functions\n\n    {curry}  = require \"fairmont-core\"\n\n## type\n\nReturn the constructor function of the value, or `undefined`.\n\n    type = (x) -> x?.constructor\n\n## isType\n\n    isType = curry (t, x) -> type(x) == t\n\n## instanceOf\n\n    instanceOf = curry (t, x) -> x instanceof t\n\n## isNumber\n\n    isNumber = isType Number\n\n## isNaN\n\n    isNaN = (n) -> Number.isNaN n\n\n## isFinite\n\n    isFinite = (n) -> Number.isFinite n\n\n## isInteger\n\n    isInteger = (n) -> Number.isInteger n\n\n## isFloat\n\nAdapted from [StackOverflow][isFloat].\n\n[isFloat]:http:\/\/stackoverflow.com\/questions\/3885817\/how-to-check-if-a-number-is-float-or-integer\/3885844#3885844\n\n    isFloat = (n) -> n == +n && n != (n|0)\n\n## isBoolean\n\n    isBoolean = isType Boolean\n\n## isDate\n\n    isDate = isType Date\n\n## isRegExp\n\n    isRegExp = isType RegExp\n\n## isString\n\n    isString = isType String\n\n## isFunction\n\n    isFunction = isType Function\n\n## isObject\n\n    isObject = isType Object\n\n## isArray\n\n    isArray = isType Array\n\n## isDefined\n\n    isDefined = (x) -> x?\n\n## isGenerator\n\n    GeneratorFunction = (-> yield null).constructor\n\n    isGenerator = isType GeneratorFunction\n\n## isPromise\n\n    isPromise = (x) -> x?.then? && isFunction x.then\n\n---\n\n    module.exports = {type, isType, instanceOf,\n      isBoolean, isNumber, isNaN, isFinite, isInteger, isFloat,\n      isString, isFunction, isObject, isArray, isDefined,\n      isRegExp, isDate, isGenerator, isPromise}\n","old_contents":"# Type Functions\n\n    {curry}  = require \"fairmont-core\"\n\n## type\n\nGet the type of a value. Possible values are: `number`, `string`, '`boolean`, `date`, `regexp`, `function`, `array`, `object`, `null`, `undefined`.\n\n    type = (x) -> x?.constructor\n\n## isType\n\n    isType = curry (t, x) -> type(x) == t\n\n## instanceOf\n\n    instanceOf = curry (t, x) -> x instanceof t\n\n## isNumber\n\n    isNumber = isType Number\n\n## isNaN\n\n    isNaN = (n) -> Number.isNaN n\n\n## isFinite\n\n    isFinite = (n) -> Number.isFinite n\n\n## isInteger\n\n    isInteger = (n) -> Number.isInteger n\n\n## isFloat\n\nAdapted from [StackOverflow][isFloat].\n\n[isFloat]:http:\/\/stackoverflow.com\/questions\/3885817\/how-to-check-if-a-number-is-float-or-integer\/3885844#3885844\n\n    isFloat = (n) -> n == +n && n != (n|0)\n\n## isBoolean\n\n    isBoolean = isType Boolean\n\n## isDate\n\n    isDate = isType Date\n\n## isRegExp\n\n    isRegExp = isType RegExp\n\n## isString\n\n    isString = isType String\n\n## isFunction\n\n    isFunction = isType Function\n\n## isObject\n\n    isObject = isType Object\n\n## isArray\n\n    isArray = isType Array\n\n## isDefined\n\n    isDefined = (x) -> x?\n\n## isGenerator\n\n    GeneratorFunction = (-> yield null).constructor\n\n    isGenerator = isType GeneratorFunction\n\n## isPromise\n\n    isPromise = (x) -> x?.then? && isFunction x.then\n\n---\n\n    module.exports = {type, isType, instanceOf,\n      isBoolean, isNumber, isNaN, isFinite, isInteger, isFloat,\n      isString, isFunction, isObject, isArray, isDefined,\n      isRegExp, isDate, isGenerator, isPromise}\n","returncode":0,"stderr":"","license":"isc","lang":"Literate CoffeeScript"}
{"commit":"f983516c0394fd6195bc563a4daf8546ac0eb9d4","subject":"Cleanup obsolete API calls","message":"Cleanup obsolete API calls\n","repos":"opencog\/link-grammar,ampli\/link-grammar,opencog\/link-grammar,ampli\/link-grammar,linas\/link-grammar,ampli\/link-grammar,ampli\/link-grammar,ampli\/link-grammar,linas\/link-grammar,linas\/link-grammar,ampli\/link-grammar,opencog\/link-grammar,linas\/link-grammar,opencog\/link-grammar,linas\/link-grammar,linas\/link-grammar,opencog\/link-grammar,linas\/link-grammar,opencog\/link-grammar,linas\/link-grammar,linas\/link-grammar,opencog\/link-grammar,ampli\/link-grammar,ampli\/link-grammar,ampli\/link-grammar,opencog\/link-grammar,opencog\/link-grammar","old_file":"bindings\/node.js\/src\/index.litcoffee","new_file":"bindings\/node.js\/src\/index.litcoffee","new_contents":"# Node.js Bindings for Link Grammar\n\nThe parser is built using the awesome ffi library which allows\nus to communicate with a native library under the covers.\nAlong with ffi, we also use ref library to reference the native\nobjects used by the library.\n\n    ffi = require 'ffi'\n    ref = require 'ref'\n    Struct = require 'ref-struct'\n    _ = require 'underscore'\n\nEasier references to base types of data.\n\n    pointerType = 'pointer'\n    string = ref.types.CString\n    int = ref.types.int\n\nThese are just references to different native structs, which are\nall just pointers because we never use their actual referenced object.\n\n    ParseOptions = pointerType\n    Dictionary = pointerType\n    Sentence = pointerType\n    Linkage = pointerType\n\nHere are the templates for the native functions we will use.\n\n    apiTemplate =\n        parse_options_create: [ ParseOptions, [ ] ]\n        parse_options_set_islands_ok: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_verbosity: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_min_null_count: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_max_null_count: [ ref.types.void, [ ParseOptions, int ] ]\n        dictionary_create_lang: [ Dictionary, [ string ] ]\n        sentence_create: [ Sentence, [ string, Dictionary ] ]\n        sentence_parse: [ int, [ Sentence, ParseOptions ] ]\n        sentence_length: [ int, [ Sentence ] ]\n        linkage_create: [ Linkage, [ int, Sentence, ParseOptions ] ]\n        linkage_print_diagram: [ string, [ Linkage ] ]\n        linkage_get_num_links: [ int, [ Linkage ] ]\n        linkage_get_link_label: [ string, [ Linkage, int ] ]\n        linkage_get_link_llabel: [ string, [ Linkage, int ] ]\n        linkage_get_link_rlabel: [ string, [ Linkage, int ] ]\n        linkage_get_word: [ string, [ Linkage, int ] ]\n        linkage_get_link_lword: [ int, [ Linkage, int ] ]\n        linkage_get_link_rword: [ int, [ Linkage, int ] ]\n\nLoad the library.\n\n    libPath = __dirname + '\/..\/..\/..\/build\/link-grammar\/.libs\/liblink-grammar.so'\n    lib = ffi.Library libPath, apiTemplate\n    defaultDataPath = __dirname + '\/..\/..\/..\/data\/en\/'\n\nDefault configuration for data paths.\n\n    defaultConfig =\n        lang: 'en'\n        verbose: false\n\nMain parser class which interfaces the native library to make\nit very simple to get Link Grammar data from an input string.\n\n    class LinkGrammar\n\nA few utility methods for the parser.\n\n        constructor: (config) ->\n            @config = _.extend config or {}, defaultConfig\n            @options = lib.parse_options_create()\n            lib.parse_options_set_verbosity @options, (if @config.verbose then 1  else 0)\n            lib.parse_options_set_min_null_count @options, 0\n            lib.parse_options_set_max_null_count @options, 3\n            @dictionary = lib.dictionary_create_lang @config.lang\n\nParse input, and return linkage, if it exists.\n\n        parse: (input, index) ->\n            sentence = lib.sentence_create input, @dictionary\n            numLinkages = lib.sentence_parse sentence, @options\n            if numLinkages > 0\n              new Linkage lib.linkage_create index or 0, sentence, @options\n            else\n              throw new Error('No linkages found')\n\nLinkage class which allows for more specific parsing of grammar.\n\n    class Linkage\n\n        constructor: (@linkage) ->\n            @links = @getLinks()\n            @words = @getWords()\n\nGet array of grammar links based on linkage.\n\n        getLinks: ->\n            _(lib.linkage_get_num_links @linkage).times ((index) ->\n                leftIndex = lib.linkage_get_link_lword @linkage, index\n                rightIndex = lib.linkage_get_link_rword @linkage, index\n                link =\n                    label: lib.linkage_get_link_label @linkage, index\n                    left:\n                        label: lib.linkage_get_link_llabel @linkage, index\n                        word: lib.linkage_get_word @linkage, leftIndex\n                        index: leftIndex\n                    right:\n                        label: lib.linkage_get_link_rlabel @linkage, index\n                        word: lib.linkage_get_word @linkage, rightIndex\n                        index: rightIndex\n                if link.left.word.indexOf '.' isnt -1\n                    temp = link.left.word.split '.'\n                    link.left.word = temp[0]\n                    link.left.type = temp[1]\n                if link.right.word.indexOf '.' isnt -1\n                    temp = link.right.word.split '.'\n                    link.right.word = temp[0]\n                    link.right.type = temp[1]\n                link\n            ), @\n\nGet parsed words with their grammar type and index\n\n        getWords: ->\n            _.chain(@links)\n                .map (link) -> [link.left, link.right]\n                .flatten()\n                .uniq (link) -> link.word\n                .value()\n\nGet list of links by specific label type\n\n        linksByLabel: (labelPattern) ->\n            labelPattern = new RegExp labelPattern if typeof labelPattern is 'string'\n            @links.filter (link) ->\n                labelPattern.test link.left.label or labelPattern.test link.right.label\n\nGet list of connector links for a specific word\n\n        getConnectorWords: (common) ->\n            words = []\n            @links.forEach (link) ->\n                if link.left.word is common\n                    words.push\n                        source: link.left\n                        target: link.right\n                if link.right.word is common\n                    words.push\n                        source: link.right\n                        target: link.left\n            words\n\n    module.exports = LinkGrammar\n","old_contents":"# Node.js Bindings for Link Grammar\n\nThe parser is built using the awesome ffi library which allows\nus to communicate with a native library under the covers.\nAlong with ffi, we also use ref library to reference the native\nobjects used by the library.\n\n    ffi = require 'ffi'\n    ref = require 'ref'\n    Struct = require 'ref-struct'\n    _ = require 'underscore'\n\nEasier references to base types of data.\n\n    pointerType = 'pointer'\n    string = ref.types.CString\n    int = ref.types.int\n\nThese are just references to different native structs, which are\nall just pointers because we never use their actual referenced object.\n\n    ParseOptions = pointerType\n    Dictionary = pointerType\n    Sentence = pointerType\n    Linkage = pointerType\n\nHere are the templates for the native functions we will use.\n\n    apiTemplate =\n        parse_options_create: [ ParseOptions, [ ] ]\n        parse_options_set_null_block: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_islands_ok: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_verbosity: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_allow_null: [ ref.types.void, [ ParseOptions, int ] ]\n        parse_options_set_max_null_count: [ ref.types.void, [ ParseOptions, int ] ]\n        dictionary_create: [ Dictionary, [ string, string, string, string ] ]\n        sentence_create: [ Sentence, [ string, Dictionary ] ]\n        sentence_parse: [ int, [ Sentence, ParseOptions ] ]\n        sentence_length: [ int, [ Sentence ] ]\n        sentence_get_word: [ string, [ Sentence, int ] ]\n        linkage_create: [ Linkage, [ int, Sentence, ParseOptions ] ]\n        linkage_print_diagram: [ string, [ Linkage ] ]\n        linkage_get_num_links: [ int, [ Linkage ] ]\n        linkage_get_link_label: [ string, [ Linkage, int ] ]\n        linkage_get_link_llabel: [ string, [ Linkage, int ] ]\n        linkage_get_link_rlabel: [ string, [ Linkage, int ] ]\n        linkage_get_word: [ string, [ Linkage, int ] ]\n        linkage_get_link_lword: [ int, [ Linkage, int ] ]\n        linkage_get_link_rword: [ int, [ Linkage, int ] ]\n\nLoad the library.\n\n    libPath = __dirname + '\/..\/..\/..\/build\/link-grammar\/.libs\/liblink-grammar.so'\n    lib = ffi.Library libPath, apiTemplate\n    defaultDataPath = __dirname + '\/..\/..\/..\/data\/en\/'\n\nDefault configuration for data paths.\n\n    defaultConfig =\n        lang: 'en'\n        verbose: false\n\nMain parser class which interfaces the native library to make\nit very simple to get Link Grammar data from an input string.\n\n    class LinkGrammar\n\nA few utility methods for the parser.\n\n        constructor: (config) ->\n            @config = _.extend config or {}, defaultConfig\n            @options = lib.parse_options_create()\n            lib.parse_options_set_verbosity @options, (if @config.verbose then 1  else 0)\n            lib.parse_options_set_allow_null @options, 1\n            lib.parse_options_set_max_null_count @options, 3\n            @dictionary = lib.dictionary_create @config.lang\n\nParse input, and return linkage, if it exists.\n\n        parse: (input, index) ->\n            sentence = lib.sentence_create input, @dictionary\n            numLinkages = lib.sentence_parse sentence, @options\n            if numLinkages > 0\n              new Linkage lib.linkage_create index or 0, sentence, @options\n            else\n              throw new Error('No linkages found')\n\nLinkage class which allows for more specific parsing of grammar.\n\n    class Linkage\n\n        constructor: (@linkage) ->\n            @links = @getLinks()\n            @words = @getWords()\n\nGet array of grammar links based on linkage.\n\n        getLinks: ->\n            _(lib.linkage_get_num_links @linkage).times ((index) ->\n                leftIndex = lib.linkage_get_link_lword @linkage, index\n                rightIndex = lib.linkage_get_link_rword @linkage, index\n                link =\n                    label: lib.linkage_get_link_label @linkage, index\n                    left:\n                        label: lib.linkage_get_link_llabel @linkage, index\n                        word: lib.linkage_get_word @linkage, leftIndex\n                        index: leftIndex\n                    right:\n                        label: lib.linkage_get_link_rlabel @linkage, index\n                        word: lib.linkage_get_word @linkage, rightIndex\n                        index: rightIndex\n                if link.left.word.indexOf '.' isnt -1\n                    temp = link.left.word.split '.'\n                    link.left.word = temp[0]\n                    link.left.type = temp[1]\n                if link.right.word.indexOf '.' isnt -1\n                    temp = link.right.word.split '.'\n                    link.right.word = temp[0]\n                    link.right.type = temp[1]\n                link\n            ), @\n\nGet parsed words with their grammar type and index\n\n        getWords: ->\n            _.chain(@links)\n                .map (link) -> [link.left, link.right]\n                .flatten()\n                .uniq (link) -> link.word\n                .value()\n\nGet list of links by specific label type\n\n        linksByLabel: (labelPattern) ->\n            labelPattern = new RegExp labelPattern if typeof labelPattern is 'string'\n            @links.filter (link) ->\n                labelPattern.test link.left.label or labelPattern.test link.right.label\n\nGet list of connector links for a specific word\n\n        getConnectorWords: (common) ->\n            words = []\n            @links.forEach (link) ->\n                if link.left.word is common\n                    words.push\n                        source: link.left\n                        target: link.right\n                if link.right.word is common\n                    words.push\n                        source: link.right\n                        target: link.left\n            words\n\n    module.exports = LinkGrammar\n","returncode":0,"stderr":"","license":"lgpl-2.1","lang":"Literate CoffeeScript"}
{"commit":"db530151bf49a4a8acaab84ea751432472065051","subject":"Skip over node_modules directories","message":"Skip over node_modules directories\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = underscore tokens[1].trim()\n      else if tokens.length == 1\n        alias = underscore name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @DUMMY: (deps, cb) ->\n        class __DUMMY__ extends Madul\n          deps: deps\n\n        new __DUMMY__()\n          .initialize()\n          .then cb\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || underscore(name), alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            WRAPPED[proto.constructor.name].push method\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, (errors) =>\n              if errors?\n                wrapped errors\n              else\n                proto[\"_#{method}\"] = proto[method]\n\n                proto[method] = =>\n                  def = q.defer()\n                  me  = proto[\"_#{method}\"]\n\n                  if args_format == 'ARRAY'\n                    args = Array.prototype.slice.call arguments\n                  else if args_format == 'OBJECT'\n                    args = arguments[0]\n                  else\n                    proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                    return def.reject 'No arg format specified'\n\n                  before = @_process_decorators me, 'before'\n                  after  = @_process_decorators me, 'after'\n\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries me.validators, (v, next) =>\n                      arg       = Object.keys(v)[0]\n                      validator = v[arg]\n                      input     = arg\n                      prop      = args\n\n                      for a in arg.split '.'\n                        prop  = prop[a]\n                        input = a\n\n                      if Array.isArray validator\n                        async.eachSeries validator, (v, nxt) =>\n                          proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                          proto[v].EXECUTE.call proto[v], input, prop\n                            .then nxt\n                            .catch handle_err v, { \"#{input}\": prop }, nxt, (err) =>\n                              reject err\n                              def.reject err\n                        , next\n                      else\n                        proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                        proto[validator].EXECUTE.call proto[validator], input, prop\n                          .then next\n                          .catch handle_err v, { \"#{input}\": prop }, next, (err) =>\n                            reject err\n                            def.reject err\n                    , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      async.eachSeries before, (b, next) =>\n                        proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                        proto[b].before.call proto[b], args\n                          .then next\n                          .catch handle_err b, args, next, (err) =>\n                            reject err\n                            def.reject err\n                      , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      d     = q.defer()\n                      input = proto._prep_invocation proto, method, args, d\n\n                      try\n                        me.behavior.apply proto, input\n                          .then  (out) => resolve out\n                          .catch (err) => reject  err\n                      catch e\n                        me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                        reject e\n                  .catch (err) => def.reject err\n                  .then (result) =>\n                    q.Promise (resolve, reject) =>\n                      if after.length > 0\n                        async.eachSeries after, (a, next) =>\n                          proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                          proto[a].after.call proto[a], result\n                            .then next\n                            .catch handle_err b, args, next, (err) =>\n                              reject err\n                              def.reject err\n                        , => resolve result\n                      else\n                        process.nextTick => resolve result\n                  .then  (out) => def.resolve out\n                  .catch (err) => def.reject  err\n\n                  def.promise\n\n                INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n                WRAPPED[proto.constructor.name].push method\n\n                wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if proto.deps?\n                filtered = proto.deps.filter (d) => Madul.PARSE_SPEC(d).name == prop.replace \/_\/g, '-'\n\n                continue if filtered.length > 0\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, (errors) =>\n              if errors?\n                stop = new Error()\n                stop.break = true\n\n                next stop\n              else\n                next()\n          , (errors) =>\n            if errors?\n              stop = new Error()\n              stop.break = true\n\n              completed stop\n            else\n              @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{strip name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, (errors) =>\n                if errors?\n                  stop = new Error()\n                  stop.break = true\n\n                  next stop\n                else\n                  HYDRATED[name] = true\n\n                  for listener in HYRDATION_LISTENERS[name]\n                    listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, done, fail) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then  (m)   => done m\n            .catch (err) => fail err\n        else\n          done mod\n\n      _load: (me, name, path, loaded, fail) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded()\n        , fail\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            error   = true\n            checked = 0\n\n            async.eachOfSeries files, (f, i, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.' && f != 'node_modules'\n                  me._check me, depth, dep, ref, => next()\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  stop  = new Error()\n                  stop.break = true\n\n                  me._load me, ref, depth, =>\n                    error  = undefined\n                    loaded = true\n\n                    me._do_add me, ref, => next stop\n                  , (err) => next stop\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next() if typeof next == 'function'\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n        , (err) =>\n          stop = new Error()\n          stop.break = true\n\n          next stop\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n        errors  = [ ]\n\n        async.eachSeries deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                if proto[spec.parent]?\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                    if err?\n                      deep = \"#{SEARCH_ROOTS[spec.parent]}\/node_modules\/#{spec.parent}\/dist\"\n\n                      proto._check proto, deep, spec.name, spec.ref, (e) =>\n                        next()\n                    else\n                      next()\n                else\n                  proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                  @_do_hydrate proto, [ spec.parent ], (errors) =>\n                    if errors?\n                      stop = new Error()\n                      stop.break = true\n\n                      next stop\n                    else\n                      if SEARCH_ROOTS[spec.parent] == undefined\n                        SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                      proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                        if err?\n                          deep = \"#{SEARCH_ROOTS[spec.parent]}\/node_modules\/#{spec.parent}\/dist\"\n\n                          proto._check proto, deep, spec.name, spec.ref, (e) =>\n                            next()\n                        else\n                          next()\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    nxt()\n                  , =>\n                    nxt()\n                , =>\n                  next()\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, (err) =>\n                  if err?\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next stop\n                  else\n                    next()\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , (err) =>\n          if err?.length > 0\n            proto.warn.call proto, 'hydration.halt', errors\n\n            hydration_complete errors\n          else\n            async.eachSeries initers, (initer, next) =>\n              proto[initer.execute].apply(@).then next\n            , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, next) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n        fs.stat pkg, (err, stat) =>\n          if err?\n            next()\n          else if stat.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            next()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        filtered = found.filter (f) => f?\n\n        if filtered.length > 0\n          filtered.sort((a, b) => a.length - b.length)[0]\n        else\n          [ ]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, (errors) =>\n            if errors?\n              deferred.reject errors\n            else\n              @_wrap_methods proto, (err) =>\n                if err?\n                  deferred.reject err\n                else\n                  @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = underscore tokens[1].trim()\n      else if tokens.length == 1\n        alias = underscore name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @DUMMY: (deps, cb) ->\n        class __DUMMY__ extends Madul\n          deps: deps\n\n        new __DUMMY__()\n          .initialize()\n          .then cb\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || underscore(name), alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            WRAPPED[proto.constructor.name].push method\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, (errors) =>\n              if errors?\n                wrapped errors\n              else\n                proto[\"_#{method}\"] = proto[method]\n\n                proto[method] = =>\n                  def = q.defer()\n                  me  = proto[\"_#{method}\"]\n\n                  if args_format == 'ARRAY'\n                    args = Array.prototype.slice.call arguments\n                  else if args_format == 'OBJECT'\n                    args = arguments[0]\n                  else\n                    proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                    return def.reject 'No arg format specified'\n\n                  before = @_process_decorators me, 'before'\n                  after  = @_process_decorators me, 'after'\n\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries me.validators, (v, next) =>\n                      arg       = Object.keys(v)[0]\n                      validator = v[arg]\n                      input     = arg\n                      prop      = args\n\n                      for a in arg.split '.'\n                        prop  = prop[a]\n                        input = a\n\n                      if Array.isArray validator\n                        async.eachSeries validator, (v, nxt) =>\n                          proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                          proto[v].EXECUTE.call proto[v], input, prop\n                            .then nxt\n                            .catch handle_err v, { \"#{input}\": prop }, nxt, (err) =>\n                              reject err\n                              def.reject err\n                        , next\n                      else\n                        proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                        proto[validator].EXECUTE.call proto[validator], input, prop\n                          .then next\n                          .catch handle_err v, { \"#{input}\": prop }, next, (err) =>\n                            reject err\n                            def.reject err\n                    , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      async.eachSeries before, (b, next) =>\n                        proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                        proto[b].before.call proto[b], args\n                          .then next\n                          .catch handle_err b, args, next, (err) =>\n                            reject err\n                            def.reject err\n                      , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      d     = q.defer()\n                      input = proto._prep_invocation proto, method, args, d\n\n                      try\n                        me.behavior.apply proto, input\n                          .then  (out) => resolve out\n                          .catch (err) => reject  err\n                      catch e\n                        me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                        reject e\n                  .catch (err) => def.reject err\n                  .then (result) =>\n                    q.Promise (resolve, reject) =>\n                      if after.length > 0\n                        async.eachSeries after, (a, next) =>\n                          proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                          proto[a].after.call proto[a], result\n                            .then next\n                            .catch handle_err b, args, next, (err) =>\n                              reject err\n                              def.reject err\n                        , => resolve result\n                      else\n                        process.nextTick => resolve result\n                  .then  (out) => def.resolve out\n                  .catch (err) => def.reject  err\n\n                  def.promise\n\n                INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n                WRAPPED[proto.constructor.name].push method\n\n                wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if proto.deps?\n                filtered = proto.deps.filter (d) => Madul.PARSE_SPEC(d).name == prop.replace \/_\/g, '-'\n\n                continue if filtered.length > 0\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, (errors) =>\n              if errors?\n                stop = new Error()\n                stop.break = true\n\n                next stop\n              else\n                next()\n          , (errors) =>\n            if errors?\n              stop = new Error()\n              stop.break = true\n\n              completed stop\n            else\n              @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{strip name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, (errors) =>\n                if errors?\n                  stop = new Error()\n                  stop.break = true\n\n                  next stop\n                else\n                  HYDRATED[name] = true\n\n                  for listener in HYRDATION_LISTENERS[name]\n                    listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, done, fail) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then  (m)   => done m\n            .catch (err) => fail err\n        else\n          done mod\n\n      _load: (me, name, path, loaded, fail) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded()\n        , fail\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            error   = true\n            checked = 0\n\n            async.eachOfSeries files, (f, i, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, => next()\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  stop  = new Error()\n                  stop.break = true\n\n                  me._load me, ref, depth, =>\n                    error  = undefined\n                    loaded = true\n\n                    me._do_add me, ref, => next stop\n                  , (err) => next stop\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next() if typeof next == 'function'\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n        , (err) =>\n          stop = new Error()\n          stop.break = true\n\n          next stop\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n        errors  = [ ]\n\n        async.eachSeries deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                if proto[spec.parent]?\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                    if err?\n                      deep = \"#{SEARCH_ROOTS[spec.parent]}\/node_modules\/#{spec.parent}\/dist\"\n\n                      proto._check proto, deep, spec.name, spec.ref, (e) =>\n                        next()\n                    else\n                      next()\n                else\n                  proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                  @_do_hydrate proto, [ spec.parent ], (errors) =>\n                    if errors?\n                      stop = new Error()\n                      stop.break = true\n\n                      next stop\n                    else\n                      if SEARCH_ROOTS[spec.parent] == undefined\n                        SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                      proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                        if err?\n                          deep = \"#{SEARCH_ROOTS[spec.parent]}\/node_modules\/#{spec.parent}\/dist\"\n\n                          proto._check proto, deep, spec.name, spec.ref, (e) =>\n                            next()\n                        else\n                          next()\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    nxt()\n                  , =>\n                    nxt()\n                , =>\n                  next()\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, (err) =>\n                  if err?\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next stop\n                  else\n                    next()\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , (err) =>\n          if err?.length > 0\n            proto.warn.call proto, 'hydration.halt', errors\n\n            hydration_complete errors\n          else\n            async.eachSeries initers, (initer, next) =>\n              proto[initer.execute].apply(@).then next\n            , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, next) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n        fs.stat pkg, (err, stat) =>\n          if err?\n            next()\n          else if stat.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            next()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        filtered = found.filter (f) => f?\n\n        if filtered.length > 0\n          filtered.sort((a, b) => a.length - b.length)[0]\n        else\n          [ ]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, (errors) =>\n            if errors?\n              deferred.reject errors\n            else\n              @_wrap_methods proto, (err) =>\n                if err?\n                  deferred.reject err\n                else\n                  @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1d43059139071e6519cf5720ca23a910bc11e949","subject":"Production config: fix OccurenceOrderPlugin arg","message":"Production config: fix OccurenceOrderPlugin arg\n","repos":"vmlinz\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template","old_file":"webpack.config.litcoffee","new_file":"webpack.config.litcoffee","new_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc).\nIt also manages loading via JavaScript `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    webpack = require('webpack')\n    fs      = require('fs')\n    path    = require('path')\n    _       = require('lodash')\n\n\nDefine an empty configuration:\n\n    module.exports = {}\n\nEntry bundles, i.e. package source paths. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n    entries = module.exports.entry =\n      \"main\"            : \".\/src\/scripts\/main.litcoffee\"\n      \"styles\"          : \".\/src\/styles\/styles.scss\"\n      \"vendor\/es5-shim\" : \".\/bower_components\/es5-shim\/es5-shim.js\"\n      \"vendor\/es5-sham\" : \".\/bower_components\/es5-shim\/es5-sham.js\"\n\nDefine compiled distribution output directory:\n\n    outputDir = path.join(__dirname, \"dist\", \"assets\")\n\n## Loaders\n\nDefine how files should be loaded (required) based on the extension.\n\n### Scripts\n\nProcess CoffeeScript and JSX.\n\n    jsLoaders = [\"jsx\"]\n    scriptModLoaders = [\n      { test: \/\\.coffee$\/   , loaders: jsLoaders.concat([\"coffee\"]) }\n      { test: \/\\.litcoffee$\/, loaders: jsLoaders.concat([\"coffee?literate\"]) }\n      { test: \/\\.js$\/       , loaders: jsLoaders }\n    ]\n\n### Styles\n\nProcess Sass and use Autoprefixer.\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?browsers=last 2 versions']\n    styleModLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\n          \"sass?precision=10&outputStyle=expanded&sourceMap=true&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/ , loaders: cssLoaders }\n    ]\n\n### Static assets\n\nEmbed data-URLs into CSS and JS for small images and `.woff` fonts:\n\n    staticModLoaders = [\n      { test: \/\\.gif$\/  , loader: \"url?limit=10000&mimetype=image\/gif\" }\n      { test: \/\\.jpg$\/  , loader: \"url?limit=10000&mimetype=image\/jpg\" }\n      { test: \/\\.png$\/  , loader: \"url?limit=10000&mimetype=image\/png\" }\n      { test: \/\\.woff$\/ , loader: \"url?limit=10000&mimetype=application\/font-woff\" }\n      { test: \/\\.woff2$\/, loader: \"url?limit=10000&mimetype=application\/font-woff2\" }\n      { test: \/\\.ttf$\/  , loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n      { test: \/\\.eot$\/  , loader: \"file?mimetype=application\/x-font-ttf\" }\n      { test: \/\\.svg$\/  , loader: \"file?mimetype=image\/svg+xml\" }\n    ]\n\n### Output CSS to `.css` files\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not as `.js` files with embedded CSS strings.\n\nRequire the plugin:\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n\nSet `styleModLoaders` to use the plugin:\n\n    styleModLoaders = styleModLoaders.map (e) ->\n      { test: e.test, loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!')) }\n\nCreate an instance of the extractTextPlugin:\n\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\n### Define macro variables\n\n`DefinePlugin` defines variables to be substituted in the assets (a la macro).\n\nDefine `__PRODUCTION__: false` variable (set to true on `useProductionSettings()`):\n\n    definePlugin = new webpack.DefinePlugin(\n      __PRODUCTION__: JSON.stringify(false)\n    )\n\n### Generate a manifest\n\nGenerate a manifest mapping logical paths to actual paths:\n\n    generateManifestPlugin = (compiler) ->\n      @plugin 'done', (stats) ->\n        stats = stats.toJson()\n\nSet target path extension to `.css` for style assets, because we use `ExtractTextPlugin`:\n\n        assetStats = stats.assetsByChunkName\n        setCssExt = (p) -> p.replace(\/\\.js$\/, '.css')\n        for entryName, entryPath of assetStats when \/\\.(?:scss|sass|css)$\/.test(entries[entryName])\n          if _.isArray(entryPath)\n            assetStats[entryName] = entryPath.map (p) -> setCssExt(p)\n          else\n            assetStats[entryName] = setCssExt(entryPath)\n\nWrite asset-ref -> asset-hash manifest to outputDir\/stats.json\n\n        fs.writeFileSync(path.join(outputDir, \"asset-stats.json\"), JSON.stringify(stats.assetsByChunkName, null, 2))\n\n### Other options\n\n    _.merge module.exports,\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      cache: true\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n      devtool: 'source-map'\n\nOutput options:\n\n      output:\n        path         : outputDir\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: [\n          'src'\n          'bower_components'\n          'node_modules'\n        ]\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleModLoaders.concat(scriptModLoaders).concat(staticModLoaders)\n\nDefine the plugins:\n\n      plugins: [\n        definePlugin\n        extractTextPlugin\n        generateManifestPlugin\n      ]\n\n\n## Production overrides\n\nExport a method that applies production settings (used in gulpfile):\n\n      mergeProductionConfig: (addHashes = true) ->\n\nProduction plugins:\n\nSet `__PRODUCTION__` to true in the `DefinePlugin` instance:\n\n        definePlugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\nAdd content hashes to the output filenames:\n\n        _.merge @,\n          output:\n            filename: \"[name]-[hash].js\"\n\nTell `ExtractTextPlugin` to append hashes:\n\n        extractTextPlugin.filename = '[name]-[hash].css'\n\nDisable development settings:\n\n        _.merge @,\n          debug: false\n          watch: false\n          devtool: null\n\nTurn on production optimizations:\n\n          plugins: @plugins.concat [\n\nOrder the modules and chunks by occurrence. This saves space, because often referenced modules and chunks get smaller ids.\n\n            new webpack.optimize.OccurenceOrderPlugin(true)\n\nMinify JavaScript with UglifyJS:\n\n            new webpack.optimize.UglifyJsPlugin()\n\n          ]\n\n[Learn more](https:\/\/github.com\/webpack\/docs\/wiki\/internal-webpack-plugins#optimize)\nabout optimization plugins shipped with Webpack.\n","old_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc).\nIt also manages loading via JavaScript `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    webpack = require('webpack')\n    fs      = require('fs')\n    path    = require('path')\n    _       = require('lodash')\n\n\nDefine an empty configuration:\n\n    module.exports = {}\n\nEntry bundles, i.e. package source paths. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n    entries = module.exports.entry =\n      \"main\"            : \".\/src\/scripts\/main.litcoffee\"\n      \"styles\"          : \".\/src\/styles\/styles.scss\"\n      \"vendor\/es5-shim\" : \".\/bower_components\/es5-shim\/es5-shim.js\"\n      \"vendor\/es5-sham\" : \".\/bower_components\/es5-shim\/es5-sham.js\"\n\nDefine compiled distribution output directory:\n\n    outputDir = path.join(__dirname, \"dist\", \"assets\")\n\n## Loaders\n\nDefine how files should be loaded (required) based on the extension.\n\n### Scripts\n\nProcess CoffeeScript and JSX.\n\n    jsLoaders = [\"jsx\"]\n    scriptModLoaders = [\n      { test: \/\\.coffee$\/   , loaders: jsLoaders.concat([\"coffee\"]) }\n      { test: \/\\.litcoffee$\/, loaders: jsLoaders.concat([\"coffee?literate\"]) }\n      { test: \/\\.js$\/       , loaders: jsLoaders }\n    ]\n\n### Styles\n\nProcess Sass and use Autoprefixer.\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?browsers=last 2 versions']\n    styleModLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\n          \"sass?precision=10&outputStyle=expanded&sourceMap=true&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/ , loaders: cssLoaders }\n    ]\n\n### Static assets\n\nEmbed data-URLs into CSS and JS for small images and `.woff` fonts:\n\n    staticModLoaders = [\n      { test: \/\\.gif$\/  , loader: \"url?limit=10000&mimetype=image\/gif\" }\n      { test: \/\\.jpg$\/  , loader: \"url?limit=10000&mimetype=image\/jpg\" }\n      { test: \/\\.png$\/  , loader: \"url?limit=10000&mimetype=image\/png\" }\n      { test: \/\\.woff$\/ , loader: \"url?limit=10000&mimetype=application\/font-woff\" }\n      { test: \/\\.woff2$\/, loader: \"url?limit=10000&mimetype=application\/font-woff2\" }\n      { test: \/\\.ttf$\/  , loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n      { test: \/\\.eot$\/  , loader: \"file?mimetype=application\/x-font-ttf\" }\n      { test: \/\\.svg$\/  , loader: \"file?mimetype=image\/svg+xml\" }\n    ]\n\n### Output CSS to `.css` files\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not as `.js` files with embedded CSS strings.\n\nRequire the plugin:\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n\nSet `styleModLoaders` to use the plugin:\n\n    styleModLoaders = styleModLoaders.map (e) ->\n      { test: e.test, loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!')) }\n\nCreate an instance of the extractTextPlugin:\n\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\n### Define macro variables\n\n`DefinePlugin` defines variables to be substituted in the assets (a la macro).\n\nDefine `__PRODUCTION__: false` variable (set to true on `useProductionSettings()`):\n\n    definePlugin = new webpack.DefinePlugin(\n      __PRODUCTION__: JSON.stringify(false)\n    )\n\n### Generate a manifest\n\nGenerate a manifest mapping logical paths to actual paths:\n\n    generateManifestPlugin = (compiler) ->\n      @plugin 'done', (stats) ->\n        stats = stats.toJson()\n\nSet target path extension to `.css` for style assets, because we use `ExtractTextPlugin`:\n\n        assetStats = stats.assetsByChunkName\n        setCssExt = (p) -> p.replace(\/\\.js$\/, '.css')\n        for entryName, entryPath of assetStats when \/\\.(?:scss|sass|css)$\/.test(entries[entryName])\n          if _.isArray(entryPath)\n            assetStats[entryName] = entryPath.map (p) -> setCssExt(p)\n          else\n            assetStats[entryName] = setCssExt(entryPath)\n\nWrite asset-ref -> asset-hash manifest to outputDir\/stats.json\n\n        fs.writeFileSync(path.join(outputDir, \"asset-stats.json\"), JSON.stringify(stats.assetsByChunkName, null, 2))\n\n### Other options\n\n    _.merge module.exports,\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      cache: true\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n      devtool: 'source-map'\n\nOutput options:\n\n      output:\n        path         : outputDir\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: [\n          'src'\n          'bower_components'\n          'node_modules'\n        ]\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleModLoaders.concat(scriptModLoaders).concat(staticModLoaders)\n\nDefine the plugins:\n\n      plugins: [\n        definePlugin\n        extractTextPlugin\n        generateManifestPlugin\n      ]\n\n\n## Production overrides\n\nExport a method that applies production settings (used in gulpfile):\n\n      mergeProductionConfig: (addHashes = true) ->\n\nProduction plugins:\n\nSet `__PRODUCTION__` to true in the `DefinePlugin` instance:\n\n        definePlugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\nAdd content hashes to the output filenames:\n\n        _.merge @,\n          output:\n            filename: \"[name]-[hash].js\"\n\nTell `ExtractTextPlugin` to append hashes:\n\n        extractTextPlugin.filename = '[name]-[hash].css'\n\nDisable development settings:\n\n        _.merge @,\n          debug: false\n          watch: false\n          devtool: null\n\nTurn on production optimizations:\n\n          plugins: @plugins.concat [\n\nOrder the modules and chunks by occurrence. This saves space, because often referenced modules and chunks get smaller ids.\n\n            new webpack.optimize.OccurenceOrderPlugin(preferEntry: true)\n\nMinify JavaScript with UglifyJS:\n\n            new webpack.optimize.UglifyJsPlugin()\n\n          ]\n\n[Learn more](https:\/\/github.com\/webpack\/docs\/wiki\/internal-webpack-plugins#optimize)\nabout optimization plugins shipped with Webpack.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"65557e259ea2a18f72f6d96c304fdc3322d4a1c9","subject":"Reload page on jade template change","message":"Reload page on jade template change\n","repos":"Poniverse\/Equestria.tv,Poniverse\/Equestria.tv,Poniverse\/Equestria.tv","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"Equestria.tv Gulpfile\n=========================\n\n## Config\n\n    autoprefixerConfig =\n      browsers: ['> 5%']\n      cascade: true\n\n## Dependencies\n\n#### Base Deps\n\n    gulp = require 'gulp'\n    concat = require 'gulp-concat'\n\n#### Gulp Utils\n\n    livereload = require 'gulp-livereload'\n    plumber = require 'gulp-plumber'\n    notify = require 'gulp-notify'\n\n#### Browser Utilities\n\n    autoprefixer = require 'gulp-autoprefixer'\n\n#### Pre-compilers\n\n    sass = require 'gulp-sass'\n\n## Tasks\n\nSCSS Compilation\n\n    gulp.task 'css', () ->\n      gulp.src 'resources\/stylesheets\/eqtv.scss'\n        .pipe plumber({errorHandler: notify.onError(\"Error: <%= error.message %>\")})\n        .pipe sass()\n        .pipe autoprefixer autoprefixerConfig\n        .pipe gulp.dest 'www\/css'\n        .pipe notify 'Application SCSS has been compiled'\n\nCopy fonts\n\n    gulp.task 'copy:fonts', () ->\n      gulp.src [\n        'bower_components\/bootstrap-sass\/assets\/fonts\/**\/*'\n        'bower_components\/font-awesome\/fonts\/**\/*'\n      ]\n        .pipe gulp.dest('www\/fonts')\n\nCopy JS\n\n    gulp.task 'copy:js', () ->\n      gulp.src [\n        'bower_components\/nanoscroller\/bin\/javascripts\/jquery.nanoscroller.js'\n      ]\n        .pipe gulp.dest('www\/js\/vendor')\n\nRealtime Compilation\n\n    gulp.task 'watch', ['build'], () ->\n      livereload.listen();\n\n      gulp.watch('resources\/stylesheets\/**\/*.scss', ['css'])\n      gulp.watch('www\/css\/eqtv.css').on 'change', livereload.changed\n      gulp.watch('templates\/**\/*.jade').on 'change', livereload.changed\n\nBuild everything!\n\n    gulp.task 'build', ['css', 'copy:fonts', 'copy:js']\n    # Not much else to do here - everything has already run!\n\nDefault Task\n\n    gulp.task 'default', ['build'] # All we do is call build!","old_contents":"Equestria.tv Gulpfile\n=========================\n\n## Config\n\n    autoprefixerConfig =\n      browsers: ['> 5%']\n      cascade: true\n\n## Dependencies\n\n#### Base Deps\n\n    gulp = require 'gulp'\n    concat = require 'gulp-concat'\n\n#### Gulp Utils\n\n    livereload = require 'gulp-livereload'\n    plumber = require 'gulp-plumber'\n    notify = require 'gulp-notify'\n\n#### Browser Utilities\n\n    autoprefixer = require 'gulp-autoprefixer'\n\n#### Pre-compilers\n\n    sass = require 'gulp-sass'\n\n## Tasks\n\nSCSS Compilation\n\n    gulp.task 'css', () ->\n      gulp.src 'resources\/stylesheets\/eqtv.scss'\n        .pipe plumber({errorHandler: notify.onError(\"Error: <%= error.message %>\")})\n        .pipe sass()\n        .pipe autoprefixer autoprefixerConfig\n        .pipe gulp.dest 'www\/css'\n        .pipe notify 'Application SCSS has been compiled'\n\nCopy fonts\n\n    gulp.task 'copy:fonts', () ->\n      gulp.src [\n        'bower_components\/bootstrap-sass\/assets\/fonts\/**\/*'\n        'bower_components\/font-awesome\/fonts\/**\/*'\n      ]\n        .pipe gulp.dest('www\/fonts')\n\nCopy JS\n\n    gulp.task 'copy:js', () ->\n      gulp.src [\n        'bower_components\/nanoscroller\/bin\/javascripts\/jquery.nanoscroller.js'\n      ]\n        .pipe gulp.dest('www\/js\/vendor')\n\nRealtime Compilation\n\n    gulp.task 'watch', ['build'], () ->\n      livereload.listen();\n\n      gulp.watch('resources\/stylesheets\/**\/*.scss', ['css'])\n      gulp.watch('www\/css\/eqtv.css').on 'change', livereload.changed\n\nBuild everything!\n\n    gulp.task 'build', ['css', 'copy:fonts', 'copy:js']\n    # Not much else to do here - everything has already run!\n\nDefault Task\n\n    gulp.task 'default', ['build'] # All we do is call build!","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7069f2c87e4054537a065c55e33cb38c1e14a07a","subject":"added helpers - localizer and region finder","message":"added helpers - localizer and region finder\n","repos":"nhz-io\/cnl","old_file":"source\/element.litcoffee","new_file":"source\/element.litcoffee","new_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\nA visual element.\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element()\n\nCreates an Element instance.\n\n      constructor: ->\n        super\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nAdd capturing extendable listener\n          \n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n          \n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## METHODS\n### #localizeEventCoordinates(event) ->\n* Returns: [Element][Element]\n\nHelper method, to localize event coordinates.\n    \n      localizeEventCoordinates: (event) ->\n        if event\n\nIf event already has localized **x**, use it instead of absolute **x**\n\n          x = (if event.localX? then event.localX else event.x)                  \n          event.localX = x - (@origin?.x or 0)\n\nIf event already has localized **y**, use it instead of absolute **y**\n          \n          y = (if event.localY? then event.localY else event.y)\n          event.localY = y - (origin?.y or 0)\n\n        return this\n---\n\n### #getEventRegions(event)\n* Returns: [Object][Object] - named set of matching regions\n\nHelper method, to get element regions that match the event.\n      \n      getEventRegions: (event) ->\n\nProceed only if event coordinates are localized\n\n        if event and (x = event.localX)? and (y = event.localY)?          \n          result = {}\n\nWalk through the element regions\n\n          for name, $ of @regions\n\nand add the region to the result if event localized coordinates are within\nthe region rectangle.\n\n            if $[0] <= x <= ($[0] + $[2]) and $[1] <= y <= ($[1] + $[3])\n              result[name] = $\n              \n        return result\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousemove** listener\n    \n      mousemoveCaptureListener: (event) ->\n\nStore the event in the runtime for later\n\n        @___runtime.mousemoveEvent = event\n        return this\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousedown** listener\n\n      mousedownCaptureListener: (event) ->\n\nStore the event in the runtime for later\n\n        @___runtime.mousedownEvent = event\n        return this\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mouseup** listener\n      \n      mouseupCaptureListener: (event) ->\n\nStore the event in the runtime for later\n        \n        @___runtime.mouseupEvent = event\n        return this\n\n---\n\n### #mousemoveListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mousemoveListener: -> this\n\n---\n\n### #mousedownListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mousedownListener: -> this\n\n---\n\n### #mouseupListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mouseupListener: -> this\n\n\n[Element]: .\/element\n\n[Parent]: .\/index.litcoffee\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n","old_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\nA visual element.\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element()\n\nCreates an Element instance.\n\n      constructor: ->\n        super\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nAdd capturing extendable listener\n          \n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n          \n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## METHODS\n### #mousemoveCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousemove** listener\n    \n      mousemoveCaptureListener: (event) ->\n\nStore the event in the runtime for later\n\n        @___runtime.mousemoveEvent = event\n        return this\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousedown** listener\n\n      mousedownCaptureListener: (event) ->\n\nStore the event in the runtime for later\n\n        @___runtime.mousedownEvent = event\n        return this\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mouseup** listener\n      \n      mouseupCaptureListener: (event) ->\n\nStore the event in the runtime for later\n        \n        @___runtime.mouseupEvent = event\n        return this\n\n---\n\n### #mousemoveListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mousemoveListener: -> this\n\n---\n\n### #mousedownListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mousedownListener: -> this\n\n---\n\n### #mouseupListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mouseupListener: -> this\n\n\n[Element]: .\/element\n\n[Parent]: .\/index.litcoffee\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"71826d331b4f6c5489110da43ff0b99b14cd505c","subject":"fix infinite loop for unbound and undefined methods","message":"fix infinite loop for unbound and undefined methods\n","repos":"corenova\/yang-js","old_file":"src\/method.litcoffee","new_file":"src\/method.litcoffee","new_contents":"# Method - controller of functions\n\n## Class Method\n\n    debug = require('debug')('yang:method')\n    Property = require('.\/property')\n\n    class Method extends Property\n      debug: -> debug @uri, arguments...\n\n      get: (pattern) -> switch\n        when pattern? then super arguments...\n        when @binding? then @do.bind this\n        else @data\n\n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      do: (input={}, opts={}) ->\n        unless (@binding instanceof Function) or (@data instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        @debug \"[do] executing method: #{@name}\"\n        @debug input\n        ctx = @parent?.context ? @context\n        ctx = ctx.with opts, path: @path\n        try\n          # calling context is the parent node of the method\n          input = @schema.input.apply input, this, force: true\n          \n          # first apply schema bound function (if availble), otherwise\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\"\n            @debug @binding.toString()\n            output = @binding? ctx, input\n          else\n            @debug \"[do] calling assigned function: #{@data.name}\"\n            @debug @value\n            @debug @data\n            output = @data.call @parent.data, input, ctx\n\n          output = await output\n          { output } = @schema.output.eval { output }, this, force: true\n          return output\n        catch e\n          @debug e\n          return Promise.reject(e)\n\n      update: (value, opts) ->\n        super value, opts unless value instanceof Property\n\n### toJSON\n\nThis call always returns undefined for the Method node.\n\n      toJSON: (key) ->\n        value = undefined\n        value = \"#{@name}\": value if key is true\n        return value\n\n    module.exports = Method\n","old_contents":"# Method - controller of functions\n\n## Class Method\n\n    debug = require('debug')('yang:method')\n    Property = require('.\/property')\n\n    class Method extends Property\n      debug: -> debug @uri, arguments...\n\n      @property 'value',\n        get: -> @state.value ? @do.bind this\n\n      get: (pattern) -> switch\n        when pattern? then super arguments...\n        when @binding? then @do.bind this\n        else @data\n\n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      do: (input={}, opts={}) ->\n        unless (@binding instanceof Function) or (@data instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        @debug \"[do] executing method: #{@name}\"\n        @debug input\n        ctx = @parent?.context ? @context\n        ctx = ctx.with opts, path: @path\n        try\n          # calling context is the parent node of the method\n          input = @schema.input.apply input, this, force: true\n          \n          # first apply schema bound function (if availble), otherwise\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\"\n            @debug @binding.toString()\n            output = @binding? ctx, input\n          else\n            @debug \"[do] calling assigned function: #{@data.name}\"\n            @debug @value\n            @debug @data\n            output = @data.call @parent.data, input, ctx\n\n          output = await output\n          { output } = @schema.output.eval { output }, this, force: true\n          return output\n        catch e\n          @debug e\n          return Promise.reject(e)\n\n      update: (value, opts) ->\n        super value, opts unless value instanceof Property\n\n### toJSON\n\nThis call always returns undefined for the Method node.\n\n      toJSON: (key) ->\n        value = undefined\n        value = \"#{@name}\": value if key is true\n        return value\n\n    module.exports = Method\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"b6a16802988f38451f4215c1d7eeac27651652d9","subject":"node http client send error","message":"node http client send error\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onerror: (msg, options) ->\n      console.log msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       throw new Error \"Unknown method: #{data.method}\"\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      @callsCache[data.id].handle data.data, data\n\n     _handlePoll: (data, options) ->\n      throw new Error \"Poll not implemented\"\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n     _onError: (e) -> console.log e\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText?) or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onerror 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onerror 'xhr error'\n\n     _respond: (data, options) ->\n      throw new Error 'AJAX cannot respond'\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e, data\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       throw new Error \"Poll without response: #{data.id}\"\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onerror: (msg, options) ->\n      console.log msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      @_send @_createCall method, data, callbacks, options\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       throw new Error \"Unknown method: #{data.method}\"\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      @callsCache[data.id].handle data.data, data\n\n     _handlePoll: (data, options) ->\n      throw new Error \"Poll not implemented\"\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n     _onError: (e) -> console.log e\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText?) or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onerror 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onerror 'xhr error'\n\n     _respond: (data, options) ->\n      throw new Error 'AJAX cannot respond'\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       console.log 'error', e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e, data\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       throw new Error \"Poll without response: #{data.id}\"\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"536e462a86c3e479d52915245916abb96f932b38","subject":"do output schema eval inside method (action and rpc) so that path resolution will be proper","message":"do output schema eval inside method (action and rpc) so that path resolution will be proper\n","repos":"corenova\/yang-js","old_file":"src\/method.litcoffee","new_file":"src\/method.litcoffee","new_contents":"# Method - controller of functions\n\n## Class Method\n\n    debug = require('debug')('yang:method')\n    Container = require('.\/container')\n\n    class Method extends Container\n      debug: -> debug @uri, arguments...\n\n      @property 'value',\n        get: -> @state.value ? @do.bind this\n\n      get: (pattern) -> switch\n        when pattern? then super arguments...\n        when @binding? then @do.bind this\n        else @data\n\n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      do: (input={}, opts={}) ->\n        unless (@binding instanceof Function) or (@data instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        @debug \"[do] executing method: #{@name}\"\n        @debug input\n        ctx = @parent?.context ? @context\n        ctx = ctx.with opts, path: @path\n        try\n          # calling context is the parent node of the method\n          input = @schema.input.apply input, this, force: true\n          \n          # first apply schema bound function (if availble), otherwise\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\"\n            @debug @binding.toString()\n            output = @binding? ctx, input\n          else\n            @debug \"[do] calling assigned function: #{@data.name}\"\n            output = @data.call @parent.data, input, ctx\n\n          output = await Promise.resolve output\n          { output } = @schema.output.eval { output }, this, force: true\n          return output\n        catch e\n          @debug e\n          return Promise.reject e\n\n### toJSON\n\nThis call always returns undefined for the Method node.\n\n      toJSON: (key) ->\n        value = undefined\n        value = \"#{@name}\": value if key is true\n        return value\n\n    module.exports = Method\n","old_contents":"# Method - controller of functions\n\n## Class Method\n\n    debug = require('debug')('yang:method')\n    Container = require('.\/container')\n\n    class Method extends Container\n      debug: -> debug @uri, arguments...\n\n      @property 'value',\n        get: -> @state.value ? @do.bind this\n\n      get: (pattern) -> switch\n        when pattern? then super arguments...\n        when @binding? then @do.bind this\n        else @data\n\n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      do: (input={}, opts={}) ->\n        unless (@binding instanceof Function) or (@data instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        @debug \"[do] executing method: #{@name}\"\n        @debug input\n        ctx = @parent?.context ? @context\n        ctx = ctx.with opts, path: @path\n        try\n          # calling context is the parent node of the method\n          input = @schema.input.apply input, this, force: true\n          \n          # first apply schema bound function (if availble), otherwise\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\"\n            @debug @binding.toString()\n            output = @binding? ctx, input\n          else\n            @debug \"[do] calling assigned function: #{@data.name}\"\n            output = @data.call @parent.data, input, ctx\n\n          output = await Promise.resolve output\n          output = @schema.output.apply output, this, force: true\n          return output\n        catch e\n          @debug e\n          return Promise.reject e\n\n### toJSON\n\nThis call always returns undefined for the Method node.\n\n      toJSON: (key) ->\n        value = undefined\n        value = \"#{@name}\": value if key is true\n        return value\n\n    module.exports = Method\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"00cbe6d7abdb14d556c67fb0ed79f50b90afddbf","subject":"Be sure to undefine our error before calling next","message":"Be sure to undefine our error before calling next\n\nIt's SUPER IMPORTANT that error get undefined before the call to _do_add so that\nwe don't falsly report an error condition for our search through a directory tree\nfor a madul.\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push e\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = e\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        proto._report method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err.message\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.Promise (resolve, reject) =>\n                  async.eachSeries me.validators, (v, next) =>\n                    arg       = Object.keys(v)[0]\n                    validator = v[arg]\n                    input     = arg\n                    prop      = args\n\n                    for a in arg.split '.'\n                      prop  = prop[a]\n                      input = a\n\n                    if Array.isArray validator\n                      async.eachSeries validator, (v, nxt) =>\n                        proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                        proto[v].EXECUTE.call proto[v], input, prop\n                          .then nxt\n                          .catch handle_err v, { \"#{input}\": prop }, nxt, reject\n                      , next\n                    else\n                      proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                      proto[validator].EXECUTE.call proto[validator], input, prop\n                        .then next\n                        .catch handle_err v, { \"#{input}\": prop }, next, reject\n                  , resolve\n                .then =>\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries before, (b, next) =>\n                      proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                      proto[b].before.call proto[b], args\n                        .then next\n                        .catch handle_err b, args, next, reject\n                    , resolve\n                .then =>\n                  input = proto._prep_invocation proto, method, args, def\n\n                  try\n                    me.behavior.apply me, input\n                  catch e\n                    failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                    me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                    failed e.message\n                .then (result) =>\n                  q.Promise (resolve, reject) =>\n                    if after.length > 0\n                      async.eachSeries after, (a, next) =>\n                        proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                        proto[a].after.call proto[a], result\n                          .then next\n                          .catch handle_err b, args, next, reject\n                      , => resolve result\n                    else\n                      process.nextTick => resolve result\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n\n              INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n              wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, next\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        error = true\n\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) =>\n                    error = undefined\n                    me._do_add me, ref, next\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    stop = new Error()\n                    stop.break = true\n\n                    next()\n                    nxt stop\n                  , nxt\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push e\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = e\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        proto._report method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err.message\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.Promise (resolve, reject) =>\n                  async.eachSeries me.validators, (v, next) =>\n                    arg       = Object.keys(v)[0]\n                    validator = v[arg]\n                    input     = arg\n                    prop      = args\n\n                    for a in arg.split '.'\n                      prop  = prop[a]\n                      input = a\n\n                    if Array.isArray validator\n                      async.eachSeries validator, (v, nxt) =>\n                        proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                        proto[v].EXECUTE.call proto[v], input, prop\n                          .then nxt\n                          .catch handle_err v, { \"#{input}\": prop }, nxt, reject\n                      , next\n                    else\n                      proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                      proto[validator].EXECUTE.call proto[validator], input, prop\n                        .then next\n                        .catch handle_err v, { \"#{input}\": prop }, next, reject\n                  , resolve\n                .then =>\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries before, (b, next) =>\n                      proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                      proto[b].before.call proto[b], args\n                        .then next\n                        .catch handle_err b, args, next, reject\n                    , resolve\n                .then =>\n                  input = proto._prep_invocation proto, method, args, def\n\n                  try\n                    me.behavior.apply me, input\n                  catch e\n                    failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                    me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                    failed e.message\n                .then (result) =>\n                  q.Promise (resolve, reject) =>\n                    if after.length > 0\n                      async.eachSeries after, (a, next) =>\n                        proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                        proto[a].after.call proto[a], result\n                          .then next\n                          .catch handle_err b, args, next, reject\n                      , => resolve result\n                    else\n                      process.nextTick => resolve result\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n\n              INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n              wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, next\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        error = true\n\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) =>\n                    me._do_add me, ref, next\n                    error = undefined\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    stop = new Error()\n                    stop.break = true\n\n                    next()\n                    nxt stop\n                  , nxt\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bd55e0523d2e85f1be32b7796aaa8f217d9a037f","subject":"Remvoe reference to async package","message":"Remvoe reference to async package\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/routes\/api_v1.litcoffee","new_file":"src\/routes\/api_v1.litcoffee","new_contents":"    express = require 'express'\n    multer  = require 'multer'\n    dms2dec = require 'dms2dec'\n\n    sentry  = require '..\/sentry'\n    librato = require '..\/librato'\n    s3      = require '..\/upload'\n\nMake a new Express router object for this part of the application.\n\n    api = express.Router()\n\n## Metrics\n\nAgregate metrics for all requests and wheter they succeded (`finish`) or closed\nbefore the request succeeded (`close`).\n\n    api.use (req, res, next) ->\n      librato.logRequest req.method\n\n      res.once 'close', ->\n        librato.logResponse 'closed'\n        sentry.captureResClose res\n\n      res.once 'finish', ->\n        librato.logResponse res.statusCode\n\n      next()\n\n## GET \/\n\n    api.get '\/', (req, res, next) ->\n      res.status(204).end()\n\n## POST \/upload\n\nConfigure [multer](https:\/\/github.com\/expressjs\/multer) to store files in the\nOS's temorary directory `tempdir()`. This way we should not need to clean up the\nuploaded files since that should be the job of the OS.\n\n    uuid = require('uuid')\n    extname = require('path').extname\n    multer = require('multer')\n      storage: require('multer').diskStorage\n        destination: require('os').tmpdir()\n        filename: (req, file, cb) ->\n          cb null, uuid.v4() + '.' + extname(file.originalname).substr(1).toLowerCase()\n\nConfigure the `\/upload` route handler.\n\n    api.post '\/upload', multer.single('image'), (req, res, next) ->\n      librato.logImageUpload()\n\n      if not \/(jpe?g|png|gif)$\/i.test req.file.originalname\n        error = new Error \"Invalid Image #{req.file.originalname}\"\n        error.statusCode = 422\n        return next error\n\n      t1 = new Date().getTime()\n      s3.upload req.file.path, {}, (error, images, meta) ->\n        return next error if error\n\n        librato.logImageProcessingTime t1, new Date().getTime()\n\nFormat image GeoJSON correctly if the image has GPS properties.\n\n        if meta.exif?.GPSLatitude and meta.exif?.GPSLongitude\n          meta.geojson =\n            type: 'Point'\n            coordinates: dms2dec \\\n              meta.exif.GPSLatitude, \\\n              meta.exif.GPSLatitudeRef, \\\n              meta.exif.GPSLongitude, \\\n              meta.exif.GPSLongitudeRef\n            .reverse()\n\nWe need to remove the original image (index i - 1) since it is not publicly\naccessible. It gets uploaded to AWS as backup of the original image.\n\n        images = images.splice 0, images.length - 1\n\n        for image in images\n          image.aspect      = undefined\n          image.awsImageAcl = undefined\n          image.key         = undefined\n          image.maxHeight   = undefined\n          image.maxWidth    = undefined\n          image.path        = undefined\n          image.suffix      = undefined\n\n        sentry.captureHeaderSent req, images if res._headerSent\n\n        res.status 201\n        res.json meta: meta, versions: images\n\n    module.exports = api\n","old_contents":"    express = require 'express'\n    multer  = require 'multer'\n    async   = require 'async'\n    dms2dec = require 'dms2dec'\n\n    sentry  = require '..\/sentry'\n    librato = require '..\/librato'\n    s3      = require '..\/upload'\n\nMake a new Express router object for this part of the application.\n\n    api = express.Router()\n\n## Metrics\n\nAgregate metrics for all requests and wheter they succeded (`finish`) or closed\nbefore the request succeeded (`close`).\n\n    api.use (req, res, next) ->\n      librato.logRequest req.method\n\n      res.once 'close', ->\n        librato.logResponse 'closed'\n        sentry.captureResClose res\n\n      res.once 'finish', ->\n        librato.logResponse res.statusCode\n\n      next()\n\n## GET \/\n\n    api.get '\/', (req, res, next) ->\n      res.status(204).end()\n\n## POST \/upload\n\nConfigure [multer](https:\/\/github.com\/expressjs\/multer) to store files in the\nOS's temorary directory `tempdir()`. This way we should not need to clean up the\nuploaded files since that should be the job of the OS.\n\n    uuid = require('uuid')\n    extname = require('path').extname\n    multer = require('multer')\n      storage: require('multer').diskStorage\n        destination: require('os').tmpdir()\n        filename: (req, file, cb) ->\n          cb null, uuid.v4() + '.' + extname(file.originalname).substr(1).toLowerCase()\n\nConfigure the `\/upload` route handler.\n\n    api.post '\/upload', multer.single('image'), (req, res, next) ->\n      librato.logImageUpload()\n\n      if not \/(jpe?g|png|gif)$\/i.test req.file.originalname\n        error = new Error \"Invalid Image #{req.file.originalname}\"\n        error.statusCode = 422\n        return next error\n\n      t1 = new Date().getTime()\n      s3.upload req.file.path, {}, (error, images, meta) ->\n        return next error if error\n\n        librato.logImageProcessingTime t1, new Date().getTime()\n\nFormat image GeoJSON correctly if the image has GPS properties.\n\n        if meta.exif?.GPSLatitude and meta.exif?.GPSLongitude\n          meta.geojson =\n            type: 'Point'\n            coordinates: dms2dec \\\n              meta.exif.GPSLatitude, \\\n              meta.exif.GPSLatitudeRef, \\\n              meta.exif.GPSLongitude, \\\n              meta.exif.GPSLongitudeRef\n            .reverse()\n\nWe need to remove the original image (index i - 1) since it is not publicly\naccessible. It gets uploaded to AWS as backup of the original image.\n\n        images = images.splice 0, images.length - 1\n\n        for image in images\n          image.aspect      = undefined\n          image.awsImageAcl = undefined\n          image.key         = undefined\n          image.maxHeight   = undefined\n          image.maxWidth    = undefined\n          image.path        = undefined\n          image.suffix      = undefined\n\n        sentry.captureHeaderSent req, images if res._headerSent\n\n        res.status 201\n        res.json meta: meta, versions: images\n\n    module.exports = api\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"475dd271061de187af58d2f0b003274c0b4ee40e","subject":"spacing fixes","message":"spacing fixes\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08_request.litcoffee","new_file":"docs\/08_request.litcoffee","new_contents":"# Batman Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented the platform layer files.\n\n### Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.node.js`: \"querystring\" and \"url\"\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\n  Batman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\n  In other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n    \n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n There are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n 1. `loading()`: fired before `send()` has been called.\n\n    test \"Demonstrate the loading event\", 1, ->\n       new Batman.Request\n         url: \"http::\/\/batmanjs.org\"\n         loading: ->\n           ok true, \"After send but before the request is made\"\n\n 2. `loaded()`: fired after the request is complete\n\n     test \"Demo the loaded event\", 1, ->\n       Batman.Request.setupMockedResponse()\n       Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n       new Batman.Request\n         url: \"http:\/\/batmanjs.org\"\n         loaded: ->\n           ok true, \"Loaded\"\n\n 3. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n    test \"Demo the error event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        error: (xhr) ->\n          ok true, \"Error\"\n\n 4. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n    test \"Demonstrate the success event\", 1,  ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", response\n\n## .status\n  The response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\n  The response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : object\n  An key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request(options : object)\n\n  Constructs a new `Batman.Request` with the supplied options\n\n  `options` description\n  1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n  2. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`\n\n    test \"method test\", ->\n      Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"POST\"\n        data: { some: \"data\" }\n        success: (response) ->\n          ok true\n\n  3. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n  4. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n    test \"contentType default\", ->\n       req = new Batman.Request\n       equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n  5. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n    test \"autosend test\", ->\n      response_sent = false\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        success: (response) ->\n          response_sent = true\n      ok !response_sent\n      req.send()\n      ok response_sent\n\n  6. `username`: username for authentication\n  7. `password`: password for authentication\n  8. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send([data])\n  If `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","old_contents":"# Batman Request\n Request is an abstraction around XHR requests.  It can be used with a variety of platforms, and is implemented the platform layer files.\n\n### Platform Request Implmentation Libraries:\n  Depending on the platform library the underlying request implementation will change:\n\n - `batman.jquery.js`: jQuery XHR\n - `batman.node.js`: \"querystring\" and \"url\"\n - `batman.solo.js`: Reqwest.js\n\n _note_ For the tests there are some mocked responses, in a normal non testing situation you would not use these\n\n### How to use Batman Request\n\n  Batman.Request can be used a variety of ways.  This is the underlying library that the `rest_storage_adapater` uses to communicate.\n\n  In other cases where you want to communicate with a server that isn't your default storage_adapter you would use it like:\n    \n    test \"Send a simple Batman.Request\", ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse( \"GET\", \"http:\/\/batmanjs.org\", ->{})\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"GET\"\n        success: (result) ->\n          ok true\n\n### Lifecycle events\n There are a variety of lifecycle events that get fired in a `Request`.  Each of these are passed in as parameters in the options object in the `Request` constructor.\n\n 1. `loading()`: fired before `send()` has been called.\n\n    test \"Demonstrate the loading event\", 1, ->\n       new Batman.Request\n         url: \"http::\/\/batmanjs.org\"\n         loading: ->\n           ok true, \"After send but before the request is made\"\n\n 2. `loaded()`: fired after the request is complete\n\n     test \"Demo the loaded event\", 1, ->\n       Batman.Request.setupMockedResponse()\n       Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {})\n       new Batman.Request\n         url: \"http:\/\/batmanjs.org\"\n         loaded: ->\n           ok true, \"Loaded\"\n\n 3. `error( xhr )`: fired when an error is detected,  `xhr` is the platform defined xhr object with a property named `request` being the `Batman.Request` object.\n\n    test \"Demo the error event\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        error: (xhr) ->\n          ok true, \"Error\"\n\n 4. `success ( response )`: fired when a successful request has been made, `response` is the body of the request response.\n\n    test \"Demonstrate the success event\", 1,  ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\")\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", response\n\n## .status\n  The response status, only set after `error` or `success`\n\n    test \"Demo the error event\", 1, ->\n     Batman.Request.setupMockedResponse()\n     Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> status: 400)\n     new Batman.Request\n       url: \"http:\/\/batmanjs.org\"\n       error: (xhr) ->\n         equal 400, @status\n\n## .response\n  The response object\n\n    test \"Demonstrate the response object\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> response: \"foo\" )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          equal \"foo\", JSON.parse(@response)\n\n## .responseHeaders : PlainObject\n  An key\/value object with the response headers\n\n    test \"responseHeaders\", 1, ->\n      Batman.Request.setupMockedResponse()\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> responseHeaders: { FOO: \"bar\" } )\n\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        success: (response) ->\n          deepEqual @responseHeaders,{ FOO: \"bar\" }\n\n## @Request( options : PlainObject )\n\n  Constructs a new `Batman.Request` with the supplied options\n\n  `options` description\n  1. `url : String`: A string containing the URL to which the request is sent.  Mandatory\n  2. `method : String`: The type of request to make eg. `GET`, `POST`.  Default is `GET`\n\n    test \"method test\", ->\n      Batman.Request.addMockedResponse(\"POST\", \"http:\/\/batmanjs.org\", -> response : { FOO: \"BAR\" })\n      new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        method: \"POST\"\n        data: { some: \"data\" }\n        success: (response) ->\n          ok true\n\n  3. `data`: Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests.\n  4. `contentType`: the content type to send, defaults to `application\/x-www-form-urlencoded`\n\n    test \"contentType default\", ->\n       req = new Batman.Request\n       equal req.contentType, \"application\/x-www-form-urlencoded\"\n\n  5. `autosend`: controls whether the request will be sent automatically, deafults to `true`\n\n    test \"autosend test\", ->\n      response_sent = false\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        success: (response) ->\n          response_sent = true\n      ok !response_sent\n      req.send()\n      ok response_sent\n\n  6. `username`: username for authentication\n  7. `password`: password for authentication\n  8. `type`: The type of data you're expecting from the server, defaults to `json`\n\n\n## ::send( [data] )\n  If `autosend` is `false`, this will initiate the request.  The data object passed in will take priority over the one specified in the `options` object\n\n    test \"request.send()\", ->\n      beforeResponse = (req, data) ->\n        deepEqual data, { other: \"thing\" }\n      Batman.Request.addMockedResponse(\"GET\", \"http:\/\/batmanjs.org\", -> {beforeResponse: beforeResponse} )\n      req = new Batman.Request\n        url: \"http:\/\/batmanjs.org\"\n        autosend: false\n        data: { some: \"data\" }\n      req.send( { other: \"thing\" } )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e7ee3c78b72bc5c016f2259cea46d760eb480ab6","subject":"Use correct name.","message":"Use correct name.\n","repos":"mxipartners\/checksome,fniessink\/checksome","old_file":"lib\/collections\/measurements.litcoffee","new_file":"lib\/collections\/measurements.litcoffee","new_contents":"`Measurements` are ...\n\n    @Measurements = new Mongo.Collection 'measurements'\n\n    Measurements.allow\n      update: (userId, measurement) -> false\n      remove: (userId, measurement) -> false\n\nInsert a new measurement\n\n    @insertMeasurement = (measurementAttributes) ->\n      validateMeasurement measurementAttributes\n      measurement = _.extend measurementAttributes,\n        submitted: new Date()\n        position: 0\n        kind: 'measurement'\n\nUpdate the positions of the existing measurements\n\n      Measurements.update({_id: m._id}, {$set: {position: m.position+1}}) for m in Measurements.find({projectId: measurement.projectId}).fetch()\n\nCreate the measurement\n\n      measurement._id = Measurements.insert measurement\n      return measurement._id\n","old_contents":"`Metrics` are ...\n\n    @Measurements = new Mongo.Collection 'measurements'\n\n    Measurements.allow\n      update: (userId, measurement) -> false\n      remove: (userId, measurement) -> false\n\nInsert a new measurement\n\n    @insertMeasurement = (measurementAttributes) ->\n      validateMeasurement measurementAttributes\n      measurement = _.extend measurementAttributes,\n        submitted: new Date()\n        position: 0\n        kind: 'measurement'\n\nUpdate the positions of the existing measurements\n\n      Measurements.update({_id: m._id}, {$set: {position: m.position+1}}) for m in Measurements.find({projectId: measurement.projectId}).fetch()\n\nCreate the measurement\n\n      measurement._id = Measurements.insert measurement\n      return measurement._id\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a74912d0dfa86865d32c3277d37485fb73ff635b","subject":"Add support for tests written in Literal CoffeeScript","message":"Add support for tests written in Literal CoffeeScript\n","repos":"aln787\/jasmine-node,aln787\/jasmine-node,relekang\/jasmine-node,kidaa\/jasmine-node,rdohms\/jasmine-node,herpiko\/jasmine-node,authbox-lib\/jasmine-node,mmv\/jasmine-node,kidaa\/jasmine-node,kevinsawicki\/jasmine-node,synthecypher\/jasmine-node,authbox-lib\/jasmine-node,mhevery\/jasmine-node,synthecypher\/jasmine-node,mhevery\/jasmine-node,herpiko\/jasmine-node,kevinsawicki\/jasmine-node,rdohms\/jasmine-node,mmv\/jasmine-node,relekang\/jasmine-node","old_file":"spec\/litcoffee\/Litcoffee.spec.litcoffee","new_file":"spec\/litcoffee\/Litcoffee.spec.litcoffee","new_contents":"Literate CoffeeScript\n====================\n\nThis is a spec using written in Literate CoffeeScript\n\n    describe 'Coffee.litcoffee', ->\n\n        it 'should pass', ->\n            expect(1+2).toEqual(3)\n","old_contents":"Literal CoffeeScript\n====================\n\nThis is a spec using written in Literal CoffeeScript\n\n    describe 'Coffee.litcoffee', ->\n\n        it 'should pass', ->\n            expect(1+2).toEqual(3)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9de7a8007d5c9b98c6b977f44ba6fa079ceddc89","subject":"better description","message":"better description\n","repos":"nhz-io\/cnl","old_file":"source\/lib\/shape.litcoffee","new_file":"source\/lib\/shape.litcoffee","new_contents":"# CLASS: Shape\n* Extends: [Element][Element]\n\nA drawable shape class.\n\n    Event = require '.\/event'\n    zonesFromEvent = require '..\/helper\/zones-from-point'\n\n    module.exports = class Shape extends require '.\/element'\n\n## CONSTRUCTOR\n\n### #new Shape(args)\n* Returns: [Shape][Shape]\n\nCreate new Shape instance\n\n      constructor: (args = {}) ->\n        super\n\noptionally settings **zones** property if it was provided in args.\n\n        (@zones ||= {}) and @zones[key] = value for key, value of args.zones\n\nRegister capturing and non-capturing validation listeners. Those will stop the\nevent propagation if the event **type** is not enabled (Only one listener here)\n\n        for name in ['draw']\n          do (name) =>\n            @addListener name, ((e) -> e.stop() unless @events?[name]), yes\n            @addListener name, ((e) -> e.stop() unless @events?[name]), no\n\n---\n\n## PROPERTIES\n\n### #zones\n* Type: [Object][Object] - collection of shape zones\n\n---\n\n## METHODS\n      \n### #mousemoveCaptureListener(event)\n* Returns: [Event][Event]\n\nCapture **mousemove** events passing through this shape\n\n      mousemoveCaptureListener: (event) ->\n        super\n\nGet shape zones which match the event and store them in the event (for later).\n\n        if (zones = @getEventZones event)\n          event.zones = zones\n\nSet the shape state to the first matching zone name in order.\n\n          for name in ['active', 'hover', 'normal'] when zones[name]\n            state = name\n            break\n\nIf any state was set then make this shape a target of the event (for now)\n\n          if (@state = state or null) then event.target = this\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Shape][Shape]\n\nCapture **mousedown** events passing through this shape\n\n      mousedownCaptureListener: (event) ->\n        super\n\nGet shape zones which match the event and store them in the event (for later).\n\n        if (zones = @getEventZones event)\n          event.zones = zones\n\nSet the shape state to the first matching zone name in order\n\n          for name in ['active', 'hover', 'normal'] when zones[name]\n            state = name\n            break\n\nIf any state was set then make this shape a target of the event (for now)\n\n          if (@state = state or null) then event.target = this\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Event][Event]\n\nCapture **mouseup** events passing through this shape\n\n      mouseupCaptureListener: (event) ->\n        super\n\nGet shape zones which match the event and store them in the event (for later).\n\n        if zones = @getEventZones event\n          event.zones = zones\n\nSet the shape state to the first matching zone name in order\n\n          for name in ['active', 'hover', 'normal'] when zones[name]\n            state = name\n            break\n\nIf any state was set then make this shape a target of the event (for now)\n\n          if (@state = state or null) then event.target = this\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n---\n\n### #draw(context, args)\n* Returns: [Shape][Shape]\n\nCreate **draw** event and deliver it to this shape\n\n      draw: (context, args) ->\n        if @events?.draw then @broadcastEvent new Event\n          type:'draw', target:this, context:context, args:args\n        return this\n\n#### PARAMETERS\n**context**\n* Type: [Object][Object] - context to draw on\n\n**args**\n* Type: [Object][Object] - drawing options\n\n[Shape]: .\/shape.litcoffee\n[Element]: .\/element.litcoffee\n[Event]: .\/event.litcoffee\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n","old_contents":"# CLASS: Shape\n* Extends: [Element][Element]\n\nA drawable shape class.\n\n    Event = require '.\/event'\n    zonesFromEvent = require '..\/helper\/zones-from-point'\n\n    module.exports = class Shape extends require '.\/element'\n\n## CONSTRUCTOR\n\n### #new Shape(args)\n* Returns: [Shape][Shape]\n\nCreate new Shape instance\n\n      constructor: (args = {}) ->\n        super\n\noptionally settings **zones** property if it was provided in args.\n\n        (@zones ||= {}) and @zones[key] = value for key, value of args.zones\n\nRegister capturing and non-capturing validation listeners. Those will stop the\nevent propagation if the event **type** is not enabled (Only one listener here)\n\n        for name in ['draw']\n          do (name) =>\n            @addListener name, ((e) -> e.stop() unless @events?[name]), yes\n            @addListener name, ((e) -> e.stop() unless @events?[name]), no\n\n---\n\n## PROPERTIES\n\n### #zones\n* Type: [Object][Object] - collection of shape zones\n\n---\n\n## METHODS\n      \n### #mousemoveCaptureListener(event)\n* Returns: [Event][Event]\n\nCapture **mousemove** events passing through this shape\n\n      mousemoveCaptureListener: (event) ->\n        super\n\nGet shape zones which match the event\n\n        if (zones = @getEventZones event)\n          event.zones = zones\n\nand set the shape state to the first matching zone in order.\n\n          for name in ['active', 'hover', 'normal'] when zones[name]\n            state = name\n            break\n\nif any state was found make this shape a target of the event (for now)\n\n          if (@state = state or null) then event.target = this\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Shape][Shape]\n\nCapture **mousedown** events passing through this shape\n\n      mousedownCaptureListener: (event) ->\n        super\n\nGet shape zones which match the event\n\n        if (zones = @getEventZones event)\n          event.zones = zones\n\nand set the shape state to the first matching zone in order\n\n          for name in ['active', 'hover', 'normal'] when zones[name]\n            state = name\n            break\n\nif any state was found make this shape a target of the event (for now)\n\n          if (@state = state or null) then event.target = this\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Event][Event]\n\nCapture **mouseup** events passing through this shape\n\n      mouseupCaptureListener: (event) ->\n        super\n\nGet shape zones which match the event\n\n        if zones = @getEventZones event\n          event.zones = zones\n\nand set the shape state to the first matching zone in order\n\n          for name in ['active', 'hover', 'normal'] when zones[name]\n            state = name\n            break\n\nif any state was found make this shape a target of the event (for now)\n\n          if (@state = state or null) then event.target = this\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event] - captured event\n\n---\n\n### #draw(context, args)\n* Returns: [Shape][Shape]\n\nCreate **draw** event and deliver it to this shape\n\n      draw: (context, args) ->\n        if @events?.draw then @broadcastEvent new Event\n          type:'draw', target:this, context:context, args:args\n        return this\n\n#### PARAMETERS\n**context**\n* Type: [Object][Object] - context to draw on\n\n**args**\n* Type: [Object][Object] - drawing options\n\n[Shape]: .\/shape.litcoffee\n[Element]: .\/element.litcoffee\n[Event]: .\/event.litcoffee\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"aee62cf38293129b1ded354fd1cb1fb4b11568a4","subject":"Fixed dot product being misimplemented, and normalize function dividing by square of magnitude rather than magnitude.","message":"Fixed dot product being misimplemented, and normalize function dividing by\nsquare of magnitude rather than magnitude.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/vector.litcoffee","new_file":"src\/vector.litcoffee","new_contents":"Vectors are arrays of 3 numbers; X, Y and Z.\nX runs from left to right.\nY runs from bottom to top.\nZ runs from back to front.\n\nThis module exports an object.\n\n    misc = require \".\/misc.litcoffee\"\n\nGiven a vector, calling the \"sum\" property returns the sum of its components.\n\n    sum = (vector) ->\n        total = 0\n        (total += component) for component in vector\n        total\n        \n    unary = (callback) -> (input, output) ->\n        (output[index] = callback value) for value, index in input\n        return\n        \nGiven an input vector and output vector, calling the \"copy\" property copies each\ncomponent from the input to the output.\n        \n    copy = unary (component) -> component\n    \nGiven an input vector and output vector, calling the \"negate\" property writes\nthe negative of each component in the input vector to the output vector.\n    \n    negate = unary (component) -> -component\n    \n    binary = (callback) ->\n        vector: (a, b, output) ->\n            (output[index] = callback valueA, b[index]) for valueA, index in a\n            return\n\n        scalarBy: (a, b, output) ->\n            (output[index] = callback a, valueB) for valueB, index in b\n            return\n            \n        byScalar: (a, b, output) ->\n            (output[index] = callback valueA, b) for valueA, index in a\n            return\n    \nGiven two input vectors and an output vector, calling \"add.vector\" adds each\ncomponent in the input vectors and writes the results to the output vector.\n\nGiven a number, an input vector and an output vector, calling \"add.scalarBy\" \nadds the number to each component in the vector and and writes the results to\nthe output vector.\n\nGiven an input vector, a number and an output vector, calling \"add.byScalar\" \nadds each component in the vector to the number and writes the result to\nthe output vector.\n    \n    add = binary (a, b) -> a + b\n    \nGiven two input vectors and an output vector, calling \"subtract.vector\" \nsubtracts each compenent in the second input vector from the equivalent in the\nfirst input vector and writes the results to the output vector.\n\nGiven a number, an input vector and an output vector, calling \n\"subtract.scalarBy\" subtracts each component in the vector from the number and\nwrites the results to the output vector.\n\nGiven an input vector, a number and an output vector, calling \n\"subtract.byScalar\" subtracts the number from each component in the vector and\nwrites the results to the output vector.\n    \n    subtract = binary (a, b) -> a - b\n    \nGiven two input vectors and an output vector, calling \"multiply.vector\" \nmultiplies each compenent in the second input vector with the equivalent in the\nfirst input vector and writes the results to the output vector.\n\nGiven a number, an input vector and an output vector, calling \n\"multiply.scalarBy\" multiplies the number by each component in the vector and\nwrites the results to the output vector.\n\nGiven an input vector, a number and an output vector, calling \n\"multiply.byScalar\" multiplies each component in the vector by the number and\nwrites the results to the output vector.\n    \n    multiply = binary (a, b) -> a * b\n    \nGiven two input vectors and an output vector, calling \"divide.vector\" \ndivides each compenent in the first input vector by the equivalent in the\nsecond input vector and writes the results to the output vector.\n\nGiven a number, an input vector and an output vector, calling \n\"divide.scalarBy\" divides the number by each component in the vector and\nwrites the results to the output vector.\n\nGiven an input vector, a number and an output vector, calling \n\"divide.byScalar\" divides each component in the vector by the number and\nwrites the results to the output vector.\n    \n    divide = binary (a, b) -> a \/ b\n    \nGiven two vectors, calling the \"dot\" property returns the dot product of those\ntwo vectors.\n\n    tempA = []\n    tempB = []\n    dot = (a, b) -> \n        multiply.vector a, b, tempA\n        sum tempA\n    \nGiven a vector, calling the \"magnitudeSquared\" property returns the square of\nits magnitude.\n    \n    magnitudeSquared = (v) -> dot v, v\n    \nGiven a vector, calling the \"magnitude\" property returns its magnitude.\n    \n    magnitude = (v) -> Math.sqrt magnitudeSquared v\n\nGiven two vectors, calling the \"distanceSquared\" property returns the square of\nthe distance between them.\n    \n    distanceSquared = (a, b) ->\n        subtract.vector a, b, tempB\n        magnitudeSquared tempB\n\nGiven two vectors, calling the \"distance\" property returns the distance between\nthem.\n        \n    distance = (a, b) ->\n        subtract.vector a, b, tempB\n        magnitude tempB\n        \nGiven an input and output vector, calling the \"normalize\" property writes the\nnormalized\/unit length version of the input to the output.  The magnitude of the\ninput vector is also returned.\n\n    normalize = (input, output) ->\n        len = magnitude input\n        divide.byScalar input, len, output\n        len\n     \nGiven two input vectors and an output vector, calling the \"cross\" property\nwrites the cross product of the two input vectors to the output vector.\n     \n    cross = (a, b, output) ->\n        copy a, tempA\n        copy b, tempB\n        output[0] = tempA[1] * tempB[2] - tempB[1] * tempA[2]\n        output[1] = tempA[2] * tempB[0] - tempB[2] * tempA[0]\n        output[2] = tempA[0] * tempB[1] - tempB[0] * tempA[1]\n        return\n        \nGiven an input vector to interpolate from, an input vector to interpolate to,\na number where 0 is \"from\" and 1 is \"to\", and an output vector, calling the\n\"interpolate\" property writes the linear interpolation to the output vector.\n\n    interpolate = (from, to, alpha, output) ->\n        for fromValue, index in from\n            toValue = to[index]\n            output[index] = misc.interpolate fromValue, toValue, alpha\n        return\n        \n    module.exports = { \n            sum, copy, negate\n            add, subtract, multiply, divide\n            dot, cross\n            magnitudeSquared, magnitude\n            distanceSquared, distance\n            normalize\n            interpolate\n        }","old_contents":"Vectors are arrays of 3 numbers; X, Y and Z.\nX runs from left to right.\nY runs from bottom to top.\nZ runs from back to front.\n\nThis module exports an object.\n\n    misc = require \".\/misc.litcoffee\"\n\nGiven a vector, calling the \"sum\" property returns the sum of its components.\n\n    sum = (vector) ->\n        total = 0\n        (total += component) for component in vector\n        total\n        \n    unary = (callback) -> (input, output) ->\n        (output[index] = callback value) for value, index in input\n        return\n        \nGiven an input vector and output vector, calling the \"copy\" property copies each\ncomponent from the input to the output.\n        \n    copy = unary (component) -> component\n    \nGiven an input vector and output vector, calling the \"negate\" property writes\nthe negative of each component in the input vector to the output vector.\n    \n    negate = unary (component) -> -component\n    \n    binary = (callback) ->\n        vector: (a, b, output) ->\n            (output[index] = callback valueA, b[index]) for valueA, index in a\n            return\n\n        scalarBy: (a, b, output) ->\n            (output[index] = callback a, valueB) for valueB, index in b\n            return\n            \n        byScalar: (a, b, output) ->\n            (output[index] = callback valueA, b) for valueA, index in a\n            return\n    \nGiven two input vectors and an output vector, calling \"add.vector\" adds each\ncomponent in the input vectors and writes the results to the output vector.\n\nGiven a number, an input vector and an output vector, calling \"add.scalarBy\" \nadds the number to each component in the vector and and writes the results to\nthe output vector.\n\nGiven an input vector, a number and an output vector, calling \"add.byScalar\" \nadds each component in the vector to the number and writes the result to\nthe output vector.\n    \n    add = binary (a, b) -> a + b\n    \nGiven two input vectors and an output vector, calling \"subtract.vector\" \nsubtracts each compenent in the second input vector from the equivalent in the\nfirst input vector and writes the results to the output vector.\n\nGiven a number, an input vector and an output vector, calling \n\"subtract.scalarBy\" subtracts each component in the vector from the number and\nwrites the results to the output vector.\n\nGiven an input vector, a number and an output vector, calling \n\"subtract.byScalar\" subtracts the number from each component in the vector and\nwrites the results to the output vector.\n    \n    subtract = binary (a, b) -> a - b\n    \nGiven two input vectors and an output vector, calling \"multiply.vector\" \nmultiplies each compenent in the second input vector with the equivalent in the\nfirst input vector and writes the results to the output vector.\n\nGiven a number, an input vector and an output vector, calling \n\"multiply.scalarBy\" multiplies the number by each component in the vector and\nwrites the results to the output vector.\n\nGiven an input vector, a number and an output vector, calling \n\"multiply.byScalar\" multiplies each component in the vector by the number and\nwrites the results to the output vector.\n    \n    multiply = binary (a, b) -> a * b\n    \nGiven two input vectors and an output vector, calling \"divide.vector\" \ndivides each compenent in the first input vector by the equivalent in the\nsecond input vector and writes the results to the output vector.\n\nGiven a number, an input vector and an output vector, calling \n\"divide.scalarBy\" divides the number by each component in the vector and\nwrites the results to the output vector.\n\nGiven an input vector, a number and an output vector, calling \n\"divide.byScalar\" divides each component in the vector by the number and\nwrites the results to the output vector.\n    \n    divide = binary (a, b) -> a \/ b\n    \nGiven two vectors, calling the \"dot\" property returns the dot product of those\ntwo vectors.\n\n    tempA = []\n    tempB = []\n    dot = (a, b) -> sum multiply.vector a, b, tempA\n    \nGiven a vector, calling the \"magnitudeSquared\" property returns the square of\nits magnitude.\n    \n    magnitudeSquared = (v) -> dot v, v\n    \nGiven a vector, calling the \"magnitude\" property returns its magnitude.\n    \n    magnitude = (v) -> Math.sqrt magnitudeSquared v\n\nGiven two vectors, calling the \"distanceSquared\" property returns the square of\nthe distance between them.\n    \n    distanceSquared = (a, b) ->\n        subtract.vector a, b, tempB\n        magnitudeSquared tempB\n\nGiven two vectors, calling the \"distance\" property returns the distance between\nthem.\n        \n    distance = (a, b) ->\n        subtract.vector a, b, tempB\n        magnitude tempB\n        \nGiven an input and output vector, calling the \"normalize\" property writes the\nnormalized\/unit length version of the input to the output.  The magnitude of the\ninput vector is also returned.\n\n    normalize = (input, output) ->\n        len = magnitudeSquared input\n        divide.byScalar input, len, output\n        len\n     \nGiven two input vectors and an output vector, calling the \"cross\" property\nwrites the cross product of the two input vectors to the output vector.\n     \n    cross = (a, b, output) ->\n        copy a, tempA\n        copy b, tempB\n        output[0] = tempA[1] * tempB[2] - tempB[1] * tempA[2]\n        output[1] = tempA[2] * tempB[0] - tempB[2] * tempA[0]\n        output[2] = tempA[0] * tempB[1] - tempB[0] * tempA[1]\n        return\n        \nGiven an input vector to interpolate from, an input vector to interpolate to,\na number where 0 is \"from\" and 1 is \"to\", and an output vector, calling the\n\"interpolate\" property writes the linear interpolation to the output vector.\n\n    interpolate = (from, to, alpha, output) ->\n        for fromValue, index in from\n            toValue = to[index]\n            output[index] = misc.interpolate fromValue, toValue, alpha\n        return\n        \n    module.exports = { \n            sum, copy, negate\n            add, subtract, multiply, divide\n            dot, cross\n            magnitudeSquared, magnitude\n            distanceSquared, distance\n            normalize\n            interpolate\n        }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2a52bc6f3263841539cfc087dbf1a4461ed06e73","subject":"Fix documentation indentation.","message":"Fix documentation indentation.","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/06_set.litcoffee","new_file":"docs\/06_set.litcoffee","new_contents":"# Batman.Set\n\n`Set` is an observable, `Batman.Object` wrapper around `SimpleSet`.\n\n### SimpleSet vs Set\n\n`SimpleSet` and `Set` are two distinct classes in Batman. `SimpleSet` implements the basic set semantics, but it is *not* a `Batman.Object`, so properties on it (like its `length` or `toArray`) cannot be bound. `Set` is a `Batman.Object`, so it can be observed, and thus plays nicely with the accessor system. Use a `SimpleSet` only when you know nothing will need to be observed on the set you are creating, which usually isn't a valid assumption. If it is in fact valid, consider using a native array as well, as iteration and membership checks will be faster.\n\n## constructor(items...)\n\nWhen creating a `Set`, items forming the initial set can be passed as separate arguments to the constructor\n\n    test 'new Set constructor can be called without arguments', ->\n      set = new Batman.Set\n      deepEqual set.toArray(), []\n\n    test 'new Set constructor can be passed items to add to the set.', ->\n      set = new Batman.Set('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n## length : number\n\nA count of the items in a `Set` can be found at its `length` property.\n\n## isEmpty : boolean\n\nObservable property for `isEmpty()`\n\n## toArray : Array\n\nObservable property for `toArray()`. Whenever items are added or removed on the set, the `toArray` property will change. This is the mechanism by which Batman's view bindings get notified of collection updates.\n\n    test 'observers on the toArray property fire when the set changes', ->\n      results = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.observe('toArray', (newArray) -> results = newArray.sort())\n      deepEqual set.add('d'), ['d']\n      deepEqual results, ['a', 'b', 'c', 'd']\n      deepEqual set.remove('b'), ['b']\n      deepEqual results, ['a', 'c', 'd']\n\n## has(item) : Boolean\n\n`has` returns a boolean describing if the given `item` is a member of the set.\n\n_Note_: Using `has(item)` in an accessor body will register the set `has` is called upon as a source of the property being calculated. This so that whenever the set changes, the property will be recalculated, because the set may now have or not have the item in question.\n\n    test 'Set::has indicates if an item is a member of the set or not.', ->\n      set = new Batman.Set('a', 'b', 'c')\n      ok set.has('a')\n      equal set.has('d'), false\n\n    test 'Set::has registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @awards = new Batman.Set()\n\n        @accessor 'bestEver?', -> @get('awards').has('Stanley Cup')\n\n      result = null\n      team = new Team\n      team.observeAndFire 'bestEver?', (status) -> result = status\n      team.get('awards').add 'Eastern Conference Champs'\n      equal result, false\n      team.get('awards').add 'Stanley Cup'\n      equal result, true\n\n## add(items...)\n\n`add` adds 0 or more new items to the set. `add` returns an array of the items which have been newly added to the set, which is to say the intersection of the argument items and the set's complement before addition.\n\n`add` fires the `itemsWereAdded` event with the list of items newly added to the set if that list has length greater than 0. This is to say the event will not be fired if the items passed to add were all already members of the set.\n\n    test 'Set::add adds an item to the set', ->\n      set = new Batman.Set()\n      equal set.has('a'), false\n      deepEqual set.add('a'), ['a']\n      equal set.has('a'), true\n\n    test 'Set::add returns only the new items that weren\\'t previously in the set', ->\n      set = new Batman.Set('a', 'b')\n      deepEqual set.add('b','c','d').sort(), ['c', 'd']\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd']\n\n    test 'Set::add fires the itemsWereAdded event with the items newly added to the set', ->\n      results = null\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereAdded', (item) -> results = item)\n      set.add('b','c','d')\n      deepEqual results.sort(), ['c','d']\n\n    test 'Set::add does not fire the itemsWereAdded event if the added items were already in the set.', ->\n      results = undefined\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereAdded', (items) -> results = items)\n      set.add('a', 'b')\n      equal typeof results, 'undefined'\n\n## remove(items...)\n\n`remove` removes 0 or more items from the set. `remove` returns an array of the items which were successfully removed from the set, which is to say the intersection of the argument items and the set itself before removal.\n\n`remove` fires the `itemsWereRemoved` event with the list of removed items if that list has length greater than 0. This is to say the event will not be fired if none of the passed items were members of the set.\n\n    test 'Set::remove removes an item from the set', ->\n      set = new Batman.Set('a')\n      equal set.has('a'), true\n      deepEqual set.remove('a'), ['a']\n      equal set.has('a'), false\n\n    test 'Set::remove returns only the new items that were previously in the set', ->\n      set = new Batman.Set('a', 'b')\n      deepEqual set.remove('b','c','d').sort(), ['b']\n      deepEqual set.toArray(), ['a']\n\n    test 'Set::remove fires the itemsWereRemoved event with the items removed to the set', ->\n      results = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('b','c')\n      deepEqual results.sort(), ['b','c']\n\n    test 'Set::remove does not fire the itemsWereRemoved event if the removed items were not already members of the set.', ->\n      results = undefined\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('c', 'd')\n      equal typeof results, 'undefined'\n\n## find(testFunction : function) : [Object]\n\n`find` returns the first item within the set for which the `testFunction` called with the item returns `true`, or `undefined` if no item passes the test.\n\n_Note_: `find` returns the first item the test passes for, but since set iteration has no specified order, no guarantee can be made about which item will be returned if more than one item in the set passes the test. However, set iteration order is stable, so `find` called on the same set twice should return the same item.\n\n\n    test 'Set::find returns the first item for which the test function passes', ->\n      set = new Batman.Set(1, 2, 3)\n      equal set.find((x) -> x % 2 == 0), 2\n\n    test 'Set::find returns undefined if no items pass the test function', ->\n      set = new Batman.Set(1, 2, 3)\n      equal typeof set.find((x) -> x > 5), 'undefined'\n\n## forEach(iteratorFunction : function[, context: Object])\n\n`forEach` calls the `iteratorFunction` with each item in the set, optionally executing the `iteratorFunction` in the passed context. Returns `undefined`.\n\n_Note_: Set iteration order is not defined, thus Set client code cannot rely on one item being iterated over before another, regardless of when the Set's items were added. If you need an ordered set, Batman provides `SetSort` for exactly this, while including the added benefit of observability. If you need a one time ordering of a set, you can get the array representation with `toArray` and then use vanilla JavaScript `sort` on that array.\n\n_Note_: Using `forEach()` in an accessor body will register the set iterated over as a source of the property being calculated. This so that whenever the set changes, the property will be recalculated. This can become an issue if you iterate over a set and modify the set's items, as when the property recalculates that modification will potentially happen on items it's happened on previously.\n\n    test 'Set::forEach iterates over each item in the set', ->\n      sum = 0\n      set = new Batman.Set(1,2,3)\n      set.forEach (x) -> sum += x\n      equal sum, 6\n\n    test 'Set::forEach iterates over each item in the set optionally in the provided context', ->\n      context = {sum: 0}\n      set = new Batman.Set(1,2,3)\n      set.forEach((x) ->\n        @sum += x\n      , context)\n      equal context.sum, 6\n\n    test 'Set::forEach registers the set as a source if called in an accessor body', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @players = new Batman.Set()\n        @accessor 'willWinTheCup?', ->\n          sedinCount = 0\n          @players.forEach (player) ->\n            sedinCount++ if player.split(' ')[1] == 'Sedin'\n          sedinCount >= 2\n\n      result = null\n      team = new Team()\n      team.observeAndFire 'willWinTheCup?', (status) -> result = status\n      equal team.get('willWinTheCup?'), false\n      team.get('players').add 'Henrik Sedin'\n      equal result, false\n      team.get('players').add 'Daniel Sedin'\n      equal result, true\n\n## isEmpty() : boolean\n\n`isEmpty` returns a boolean: `true` if the set has no items, and `false` if it has any items.\n\n_Note_: Using `isEmpty()` in an accessor body will register the set `isEmpty` is called on as a source of the property being calculated, so that whenever the set changes the property will be recalculated.\n\n    test 'Set::isEmpty returns true if the set has no items', ->\n      set = new Batman.Set()\n      ok set.isEmpty()\n      set.add('a')\n      equal set.isEmpty(), false\n\n    test 'Set::isEmpty registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @games = new Batman.Set()\n        @accessor 'seasonStarted?', -> !@games.isEmpty()\n\n      team = new Team\n      equal team.get('seasonStarted?'), false\n      team.get('games').add({win: true})\n      equal team.get('seasonStarted?'), true\n\n## clear() : Array\n\n`clear` removes all items from a set. Returns an array of all the items in the set.\n\n`clear` will fire the `itemsWereRemoved` event once with all the items in the set.\n\n_Note_: Set iteration order is not defined, so the order of the array of items returned by `clear` is undefined.\n\n    test 'Set::clear empties the set', ->\n      set = new Batman.Set('a', 'b', 'c')\n      equal set.isEmpty(), false\n      deepEqual set.clear().sort(), ['a', 'b', 'c']\n      ok set.isEmpty()\n\n    test 'Set::clear fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.clear()\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## replace(collection : Enumerable) : Array\n\n`replace` removes all the items in a set and then adds all the items found in another `collection`. The other collection must have a `toArray` function which returns an array representation of the collection. Returns the array of items added.\n\n`replace` will fire the `itemsWereRemoved` event once with all the items in the set, and then the `itemsWereAdded` event once with the items from the incoming collection.\n\n    test 'Set::replace empties the set and then adds items from a different collection', ->\n      set = new Batman.Set('a', 'b', 'c')\n      secondSet = new Batman.Set('d', 'e', 'f')\n      set.replace(secondSet)\n      deepEqual set.toArray().sort(), ['d', 'e', 'f']\n\n    test 'Set::replace fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.replace(new Batman.SimpleSet())\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n    test 'Set::replace fires the itemsWereAdded event with all the items in the incoming set', ->\n      result = null\n      set = new Batman.Set()\n      set.on('itemsWereAdded', (items) -> result = items)\n      set.replace(new Batman.SimpleSet('a', 'b', 'c'))\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## toArray() : Array\n\n`toArray` returns an array representation of the set.\n\n_Note_: Set iteration order is not defined, so the order in which the set's items appear in the array is not defined. It is however stable, so the order of the items in two successive `toArray` calls where the set was not modified in between should be the same.\n\n_Note_: `toArray` is also an observable property.\n\n_Note_: Using `toArray()` in an accessor body will register the set `toArray` is called on as a source of the property being calculated, so that whenever the set changes the property will be recalculated.\n\n    test 'Set::toArray returns an array representation of the set', ->\n      set = new Batman.Set()\n      deepEqual set.toArray(), []\n      set.add('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n## merge(collections... : Enumerable) : Set\n\n`merge` adds all the items in a set and all the items in the passed `collections` to a new set and returns it. A `collection` is an object which has a `forEach` function. `merge` is a non-destructive collection union, so the set `merge` is called on and each `collection` passed to `merge` are unaffected by the call.\n\n_Note_: Be careful about using `merge` within accessors. Calling `merge` in an accessor function body will register the set `merge` is called upon as a source of the property being calculated, which means when the set changes, that accessor will be recalculated. This means the O(n * m) merge will occur again each time, and return an entirely new `Set` instance. If the previously returned `Set` instance is retained after recalculation, this is a big memory leak. Instead of merging in accessors, try to use a `SetUnion` or a `SetIntersection`.\n\n    test 'Set::merge returns a new set with the items of the original set and the passed set', ->\n      abc = new Batman.Set('a', 'b', 'c')\n      def = new Batman.Set('d', 'e', 'f')\n      equal Batman.typeOf(set = abc.merge(def)), 'Object'\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd', 'e', 'f']\n\n## indexedBy(key : String) : SetIndex\n\n`indexedBy` returns a hash of sets which buckets all the items in the callee set by the value of a particular `key`. The value of the passed `key` is `get`ted from each object in the set, and then a hash of each value to a set of the items with that value at the `key` is built. This hash of sets is a smart object called a `SetIndex` which will continue to observe the set and the value of the `key` on each item in the set to ensure the set index remains up to date. `SetIndex` also has a friend named `UniqueSetIndex` which will give you a hash of items instead of a hash of sets with items for easy access if you know each item's value at the `key` is unique.\n\n    test 'Set::indexedBy returns a new SetIndex with the items bucketed by the value of the key', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'), Batman(colour: 'blue'))\n      index = set.indexedBy('colour')\n      ok index.get('blue') instanceof Batman.Set\n      equal index.get('blue').get('length'), 2\n      equal index.get('green').get('length'), 1\n\n    test 'Set::indexedBy returns a new SetIndex which observes the set for new additions and stays up to date', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.indexedBy('colour')\n      equal index.get('blue').get('length'), 1\n      newItem = Batman(colour: 'blue')\n      set.add(newItem)\n      equal index.get('blue').get('length'), 2\n      ok index.get('blue').has(newItem)\n      set.remove(newItem)\n      equal index.get('blue').get('length'), 1\n\n    test 'Set::indexedBy returns a new SetIndex which observes the items in the set for changes to the observed key', ->\n      itemA = Batman(colour: 'blue')\n      itemB = Batman(colour: 'green')\n      set = new Batman.Set(itemA, itemB)\n      index = set.indexedBy('colour')\n      equal index.get('blue').get('length'), 1\n      equal index.get('green').get('length'), 1\n      itemA.set('colour', 'green')\n      equal index.get('blue').get('length'), 0\n      equal index.get('green').get('length'), 2\n\n`SetIndex`es can be created by calling the `indexedBy` function on the `Set`, as well as by `get`ting a `key` on the `indexedBy` property.\n\n    test \"Set::get('indexedBy.someKey') returns a new SetIndex for 'someKey'\", ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.get('indexedBy.colour')\n      equal index.get('blue').get('length'), 1\n\n## indexedByUnique(key : String) : UniqueSetIndex\n\n`indexedByUnique` returns a hash of items keyed by the value of the given `key` on each item from the callee set. The value of the passed `key` is `get`ted from each object in the set, and then a hash of each value to an item with that value at the `key` is built. This hash of items is a smart object called a `UniqueSetIndex` which will continue to observe the set and the value of the `key` on each item in the set to ensure the index remains up to date. Note that the semantics for which item ends up in the hash if two items have the same value for the `key` are undefined, so it is wise to only use `UniqueSetIndex`es on keys who's values are going to be unique in the set. If the values are not going to be unique, you may be interested in `SetIndex` and `Set::indexedBy`.\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex with the items hashed by the value of the key', ->\n      greenItem = Batman(colour: 'green')\n      blueItem = Batman(colour: 'blue')\n      set = new Batman.Set(greenItem, blueItem)\n      index = set.indexedByUnique('colour')\n      ok blueItem == index.get('blue')\n      ok greenItem == index.get('green')\n      equal undefined, index.get('red')\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex which observes the set for new additions and stays up to date', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.indexedByUnique('colour')\n      newItem = Batman(colour: 'red')\n      set.add(newItem)\n      ok newItem == index.get('red')\n      set.remove(newItem)\n      equal undefined, index.get('red')\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex which observes the items in the set for changes to the observed key', ->\n      itemA = Batman(colour: 'blue')\n      itemB = Batman(colour: 'green')\n      set = new Batman.Set(itemA, itemB)\n      index = set.indexedByUnique('colour')\n      equal index.get('blue')?, true\n      equal index.get('green')?, true\n      equal index.get('red')?, false\n      itemA.set('colour', 'red')\n      equal index.get('blue')?, false\n      equal index.get('green')?, true\n      equal index.get('red')?, true\n\n`UniqueSetIndex`es can be created by calling the `indexedByUnique` function on the `Set`, as well as by `get`ting a `key` on the `indexedByUnique` property.\n\n    test \"Set::get('indexedByUnique.someKey') returns a new UniqueSetIndex for 'someKey'\", ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.get('indexedByUnique.colour')\n      equal 'blue', index.get('blue').get('colour')\n\n## sortedBy(key: String [, order: String]) : SetSort\n\n`sortedBy` returns a `Set` like object containing all the items of the callee set but with a defined iteration order (unlike `Set`). The iteration order is defined as the alpha numeric sorting of the values of the passed `key` gotten from each item. The direction of the sort can be controlled with the `order` argument, which defaults to `asc` (short for ascending) or can be passed as `desc` (short for descending). This `Set` like object is a `SetSort` which encapsulates the logic to get the values from each item at the passed `key` and traverse the `Set` in the values sorted order.\n\n`SetSort`s are useful for getting a transform of a `Set` which sorted, but also because the sort stays up to date as items are added or removed to the sorted set, or the value at the `key` changes on any of the items in the set.\n\n    test 'Set::sortedBy returns a new SetSort who can be iterated in the sorted order of the value of the key on each item', ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n\n    test 'Set::sortedBy returns a new SetSort which observes the callee set for additions or removals and puts new items in the sorted order', ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n      burke = Batman(place: 1.5, name: 'Burke')\n      set.add(burke)\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Burke', 'Camilo', 'Harry']\n\n    test 'Set::sortedBy returns a new SetSort which observes each item in the callee set for changes to the sort key', ->\n      harry = Batman(place: 2, name: 'Harry')\n      tom = Batman(place: 1, name: 'Tom')\n      set = new Batman.Set(harry, tom)\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Harry']\n      tom.set('place', 3)\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Harry', 'Tom']\n\n`SetSort`s can be created by calling the `sortedBy` function on the `Set`, as well as by `get`ting a `key` on the `sortedBy` property. Note that with this instantiation form you can't pass an order to the `SetSort`.\n\n    test \"Set::get('sortedBy.someKey') returns a new SetSort onn 'someKey'\", ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.get('sortedBy.place')\n      equal 'Harry', sort.get('toArray')[2].get('name')\n","old_contents":"## Batman.Set\n\n`Set` is an observable, `Batman.Object` wrapper around `SimpleSet`.\n\n#### SimpleSet vs Set\n\n`SimpleSet` and `Set` are two distinct classes in Batman. `SimpleSet` implements the basic set semantics, but it is *not* a `Batman.Object`, so properties on it (like its `length` or `toArray`) cannot be bound. `Set` is a `Batman.Object`, so it can be observed, and thus plays nicely with the accessor system. Use a `SimpleSet` only when you know nothing will need to be observed on the set you are creating, which usually isn't a valid assumption. If it is in fact valid, consider using a native array as well, as iteration and membership checks will be faster.\n\n### constructor(items...)\n\nWhen creating a `Set`, items forming the initial set can be passed as separate arguments to the constructor\n\n    test 'new Set constructor can be called without arguments', ->\n      set = new Batman.Set\n      deepEqual set.toArray(), []\n\n    test 'new Set constructor can be passed items to add to the set.', ->\n      set = new Batman.Set('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n### length : number\n\nA count of the items in a `Set` can be found at its `length` property.\n\n### isEmpty : boolean\n\nObservable property for `isEmpty()`\n\n### toArray : Array\n\nObservable property for `toArray()`. Whenever items are added or removed on the set, the `toArray` property will change. This is the mechanism by which Batman's view bindings get notified of collection updates.\n\n    test 'observers on the toArray property fire when the set changes', ->\n      results = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.observe('toArray', (newArray) -> results = newArray.sort())\n      deepEqual set.add('d'), ['d']\n      deepEqual results, ['a', 'b', 'c', 'd']\n      deepEqual set.remove('b'), ['b']\n      deepEqual results, ['a', 'c', 'd']\n\n### has(item) : Boolean\n\n`has` returns a boolean describing if the given `item` is a member of the set.\n\n_Note_: Using `has(item)` in an accessor body will register the set `has` is called upon as a source of the property being calculated. This so that whenever the set changes, the property will be recalculated, because the set may now have or not have the item in question.\n\n    test 'Set::has indicates if an item is a member of the set or not.', ->\n      set = new Batman.Set('a', 'b', 'c')\n      ok set.has('a')\n      equal set.has('d'), false\n\n    test 'Set::has registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @awards = new Batman.Set()\n\n        @accessor 'bestEver?', -> @get('awards').has('Stanley Cup')\n\n      result = null\n      team = new Team\n      team.observeAndFire 'bestEver?', (status) -> result = status\n      team.get('awards').add 'Eastern Conference Champs'\n      equal result, false\n      team.get('awards').add 'Stanley Cup'\n      equal result, true\n\n### add(items...)\n\n`add` adds 0 or more new items to the set. `add` returns an array of the items which have been newly added to the set, which is to say the intersection of the argument items and the set's complement before addition.\n\n`add` fires the `itemsWereAdded` event with the list of items newly added to the set if that list has length greater than 0. This is to say the event will not be fired if the items passed to add were all already members of the set.\n\n    test 'Set::add adds an item to the set', ->\n      set = new Batman.Set()\n      equal set.has('a'), false\n      deepEqual set.add('a'), ['a']\n      equal set.has('a'), true\n\n    test 'Set::add returns only the new items that weren\\'t previously in the set', ->\n      set = new Batman.Set('a', 'b')\n      deepEqual set.add('b','c','d').sort(), ['c', 'd']\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd']\n\n    test 'Set::add fires the itemsWereAdded event with the items newly added to the set', ->\n      results = null\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereAdded', (item) -> results = item)\n      set.add('b','c','d')\n      deepEqual results.sort(), ['c','d']\n\n    test 'Set::add does not fire the itemsWereAdded event if the added items were already in the set.', ->\n      results = undefined\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereAdded', (items) -> results = items)\n      set.add('a', 'b')\n      equal typeof results, 'undefined'\n\n### remove(items...)\n\n`remove` removes 0 or more items from the set. `remove` returns an array of the items which were successfully removed from the set, which is to say the intersection of the argument items and the set itself before removal.\n\n`remove` fires the `itemsWereRemoved` event with the list of removed items if that list has length greater than 0. This is to say the event will not be fired if none of the passed items were members of the set.\n\n    test 'Set::remove removes an item from the set', ->\n      set = new Batman.Set('a')\n      equal set.has('a'), true\n      deepEqual set.remove('a'), ['a']\n      equal set.has('a'), false\n\n    test 'Set::remove returns only the new items that were previously in the set', ->\n      set = new Batman.Set('a', 'b')\n      deepEqual set.remove('b','c','d').sort(), ['b']\n      deepEqual set.toArray(), ['a']\n\n    test 'Set::remove fires the itemsWereRemoved event with the items removed to the set', ->\n      results = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('b','c')\n      deepEqual results.sort(), ['b','c']\n\n    test 'Set::remove does not fire the itemsWereRemoved event if the removed items were not already members of the set.', ->\n      results = undefined\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('c', 'd')\n      equal typeof results, 'undefined'\n\n### find(testFunction : function) : [Object]\n\n`find` returns the first item within the set for which the `testFunction` called with the item returns `true`, or `undefined` if no item passes the test.\n\n_Note_: `find` returns the first item the test passes for, but since set iteration has no specified order, no guarantee can be made about which item will be returned if more than one item in the set passes the test. However, set iteration order is stable, so `find` called on the same set twice should return the same item.\n\n\n    test 'Set::find returns the first item for which the test function passes', ->\n      set = new Batman.Set(1, 2, 3)\n      equal set.find((x) -> x % 2 == 0), 2\n\n    test 'Set::find returns undefined if no items pass the test function', ->\n      set = new Batman.Set(1, 2, 3)\n      equal typeof set.find((x) -> x > 5), 'undefined'\n\n### forEach(iteratorFunction : function[, context: Object])\n\n`forEach` calls the `iteratorFunction` with each item in the set, optionally executing the `iteratorFunction` in the passed context. Returns `undefined`.\n\n_Note_: Set iteration order is not defined, thus Set client code cannot rely on one item being iterated over before another, regardless of when the Set's items were added. If you need an ordered set, Batman provides `SetSort` for exactly this, while including the added benefit of observability. If you need a one time ordering of a set, you can get the array representation with `toArray` and then use vanilla JavaScript `sort` on that array.\n\n_Note_: Using `forEach()` in an accessor body will register the set iterated over as a source of the property being calculated. This so that whenever the set changes, the property will be recalculated. This can become an issue if you iterate over a set and modify the set's items, as when the property recalculates that modification will potentially happen on items it's happened on previously.\n\n    test 'Set::forEach iterates over each item in the set', ->\n      sum = 0\n      set = new Batman.Set(1,2,3)\n      set.forEach (x) -> sum += x\n      equal sum, 6\n\n    test 'Set::forEach iterates over each item in the set optionally in the provided context', ->\n      context = {sum: 0}\n      set = new Batman.Set(1,2,3)\n      set.forEach((x) ->\n        @sum += x\n      , context)\n      equal context.sum, 6\n\n    test 'Set::forEach registers the set as a source if called in an accessor body', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @players = new Batman.Set()\n        @accessor 'willWinTheCup?', ->\n          sedinCount = 0\n          @players.forEach (player) ->\n            sedinCount++ if player.split(' ')[1] == 'Sedin'\n          sedinCount >= 2\n\n      result = null\n      team = new Team()\n      team.observeAndFire 'willWinTheCup?', (status) -> result = status\n      equal team.get('willWinTheCup?'), false\n      team.get('players').add 'Henrik Sedin'\n      equal result, false\n      team.get('players').add 'Daniel Sedin'\n      equal result, true\n\n### isEmpty() : boolean\n\n`isEmpty` returns a boolean: `true` if the set has no items, and `false` if it has any items.\n\n_Note_: Using `isEmpty()` in an accessor body will register the set `isEmpty` is called on as a source of the property being calculated, so that whenever the set changes the property will be recalculated.\n\n    test 'Set::isEmpty returns true if the set has no items', ->\n      set = new Batman.Set()\n      ok set.isEmpty()\n      set.add('a')\n      equal set.isEmpty(), false\n\n    test 'Set::isEmpty registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @games = new Batman.Set()\n        @accessor 'seasonStarted?', -> !@games.isEmpty()\n\n      team = new Team\n      equal team.get('seasonStarted?'), false\n      team.get('games').add({win: true})\n      equal team.get('seasonStarted?'), true\n\n### clear() : Array\n\n`clear` removes all items from a set. Returns an array of all the items in the set.\n\n`clear` will fire the `itemsWereRemoved` event once with all the items in the set.\n\n_Note_: Set iteration order is not defined, so the order of the array of items returned by `clear` is undefined.\n\n    test 'Set::clear empties the set', ->\n      set = new Batman.Set('a', 'b', 'c')\n      equal set.isEmpty(), false\n      deepEqual set.clear().sort(), ['a', 'b', 'c']\n      ok set.isEmpty()\n\n    test 'Set::clear fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.clear()\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n### replace(collection : Enumerable) : Array\n\n`replace` removes all the items in a set and then adds all the items found in another `collection`. The other collection must have a `toArray` function which returns an array representation of the collection. Returns the array of items added.\n\n`replace` will fire the `itemsWereRemoved` event once with all the items in the set, and then the `itemsWereAdded` event once with the items from the incoming collection.\n\n    test 'Set::replace empties the set and then adds items from a different collection', ->\n      set = new Batman.Set('a', 'b', 'c')\n      secondSet = new Batman.Set('d', 'e', 'f')\n      set.replace(secondSet)\n      deepEqual set.toArray().sort(), ['d', 'e', 'f']\n\n    test 'Set::replace fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.replace(new Batman.SimpleSet())\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n    test 'Set::replace fires the itemsWereAdded event with all the items in the incoming set', ->\n      result = null\n      set = new Batman.Set()\n      set.on('itemsWereAdded', (items) -> result = items)\n      set.replace(new Batman.SimpleSet('a', 'b', 'c'))\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n### toArray() : Array\n\n`toArray` returns an array representation of the set.\n\n_Note_: Set iteration order is not defined, so the order in which the set's items appear in the array is not defined. It is however stable, so the order of the items in two successive `toArray` calls where the set was not modified in between should be the same.\n\n_Note_: `toArray` is also an observable property.\n\n_Note_: Using `toArray()` in an accessor body will register the set `toArray` is called on as a source of the property being calculated, so that whenever the set changes the property will be recalculated.\n\n    test 'Set::toArray returns an array representation of the set', ->\n      set = new Batman.Set()\n      deepEqual set.toArray(), []\n      set.add('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n### merge(collections... : Enumerable) : Set\n\n`merge` adds all the items in a set and all the items in the passed `collections` to a new set and returns it. A `collection` is an object which has a `forEach` function. `merge` is a non-destructive collection union, so the set `merge` is called on and each `collection` passed to `merge` are unaffected by the call.\n\n_Note_: Be careful about using `merge` within accessors. Calling `merge` in an accessor function body will register the set `merge` is called upon as a source of the property being calculated, which means when the set changes, that accessor will be recalculated. This means the O(n * m) merge will occur again each time, and return an entirely new `Set` instance. If the previously returned `Set` instance is retained after recalculation, this is a big memory leak. Instead of merging in accessors, try to use a `SetUnion` or a `SetIntersection`.\n\n    test 'Set::merge returns a new set with the items of the original set and the passed set', ->\n      abc = new Batman.Set('a', 'b', 'c')\n      def = new Batman.Set('d', 'e', 'f')\n      equal Batman.typeOf(set = abc.merge(def)), 'Object'\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd', 'e', 'f']\n\n### indexedBy(key : String) : SetIndex\n\n`indexedBy` returns a hash of sets which buckets all the items in the callee set by the value of a particular `key`. The value of the passed `key` is `get`ted from each object in the set, and then a hash of each value to a set of the items with that value at the `key` is built. This hash of sets is a smart object called a `SetIndex` which will continue to observe the set and the value of the `key` on each item in the set to ensure the set index remains up to date. `SetIndex` also has a friend named `UniqueSetIndex` which will give you a hash of items instead of a hash of sets with items for easy access if you know each item's value at the `key` is unique.\n\n    test 'Set::indexedBy returns a new SetIndex with the items bucketed by the value of the key', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'), Batman(colour: 'blue'))\n      index = set.indexedBy('colour')\n      ok index.get('blue') instanceof Batman.Set\n      equal index.get('blue').get('length'), 2\n      equal index.get('green').get('length'), 1\n\n    test 'Set::indexedBy returns a new SetIndex which observes the set for new additions and stays up to date', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.indexedBy('colour')\n      equal index.get('blue').get('length'), 1\n      newItem = Batman(colour: 'blue')\n      set.add(newItem)\n      equal index.get('blue').get('length'), 2\n      ok index.get('blue').has(newItem)\n      set.remove(newItem)\n      equal index.get('blue').get('length'), 1\n\n    test 'Set::indexedBy returns a new SetIndex which observes the items in the set for changes to the observed key', ->\n      itemA = Batman(colour: 'blue')\n      itemB = Batman(colour: 'green')\n      set = new Batman.Set(itemA, itemB)\n      index = set.indexedBy('colour')\n      equal index.get('blue').get('length'), 1\n      equal index.get('green').get('length'), 1\n      itemA.set('colour', 'green')\n      equal index.get('blue').get('length'), 0\n      equal index.get('green').get('length'), 2\n\n`SetIndex`es can be created by calling the `indexedBy` function on the `Set`, as well as by `get`ting a `key` on the `indexedBy` property.\n\n    test \"Set::get('indexedBy.someKey') returns a new SetIndex for 'someKey'\", ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.get('indexedBy.colour')\n      equal index.get('blue').get('length'), 1\n\n### indexedByUnique(key : String) : UniqueSetIndex\n\n`indexedByUnique` returns a hash of items keyed by the value of the given `key` on each item from the callee set. The value of the passed `key` is `get`ted from each object in the set, and then a hash of each value to an item with that value at the `key` is built. This hash of items is a smart object called a `UniqueSetIndex` which will continue to observe the set and the value of the `key` on each item in the set to ensure the index remains up to date. Note that the semantics for which item ends up in the hash if two items have the same value for the `key` are undefined, so it is wise to only use `UniqueSetIndex`es on keys who's values are going to be unique in the set. If the values are not going to be unique, you may be interested in `SetIndex` and `Set::indexedBy`.\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex with the items hashed by the value of the key', ->\n      greenItem = Batman(colour: 'green')\n      blueItem = Batman(colour: 'blue')\n      set = new Batman.Set(greenItem, blueItem)\n      index = set.indexedByUnique('colour')\n      ok blueItem == index.get('blue')\n      ok greenItem == index.get('green')\n      equal undefined, index.get('red')\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex which observes the set for new additions and stays up to date', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.indexedByUnique('colour')\n      newItem = Batman(colour: 'red')\n      set.add(newItem)\n      ok newItem == index.get('red')\n      set.remove(newItem)\n      equal undefined, index.get('red')\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex which observes the items in the set for changes to the observed key', ->\n      itemA = Batman(colour: 'blue')\n      itemB = Batman(colour: 'green')\n      set = new Batman.Set(itemA, itemB)\n      index = set.indexedByUnique('colour')\n      equal index.get('blue')?, true\n      equal index.get('green')?, true\n      equal index.get('red')?, false\n      itemA.set('colour', 'red')\n      equal index.get('blue')?, false\n      equal index.get('green')?, true\n      equal index.get('red')?, true\n\n`UniqueSetIndex`es can be created by calling the `indexedByUnique` function on the `Set`, as well as by `get`ting a `key` on the `indexedByUnique` property.\n\n    test \"Set::get('indexedByUnique.someKey') returns a new UniqueSetIndex for 'someKey'\", ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.get('indexedByUnique.colour')\n      equal 'blue', index.get('blue').get('colour')\n\n### sortedBy(key: String [, order: String]) : SetSort\n\n`sortedBy` returns a `Set` like object containing all the items of the callee set but with a defined iteration order (unlike `Set`). The iteration order is defined as the alpha numeric sorting of the values of the passed `key` gotten from each item. The direction of the sort can be controlled with the `order` argument, which defaults to `asc` (short for ascending) or can be passed as `desc` (short for descending). This `Set` like object is a `SetSort` which encapsulates the logic to get the values from each item at the passed `key` and traverse the `Set` in the values sorted order.\n\n`SetSort`s are useful for getting a transform of a `Set` which sorted, but also because the sort stays up to date as items are added or removed to the sorted set, or the value at the `key` changes on any of the items in the set.\n\n    test 'Set::sortedBy returns a new SetSort who can be iterated in the sorted order of the value of the key on each item', ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n\n    test 'Set::sortedBy returns a new SetSort which observes the callee set for additions or removals and puts new items in the sorted order', ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n      burke = Batman(place: 1.5, name: 'Burke')\n      set.add(burke)\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Burke', 'Camilo', 'Harry']\n\n    test 'Set::sortedBy returns a new SetSort which observes each item in the callee set for changes to the sort key', ->\n      harry = Batman(place: 2, name: 'Harry')\n      tom = Batman(place: 1, name: 'Tom')\n      set = new Batman.Set(harry, tom)\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Harry']\n      tom.set('place', 3)\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Harry', 'Tom']\n\n`SetSort`s can be created by calling the `sortedBy` function on the `Set`, as well as by `get`ting a `key` on the `sortedBy` property. Note that with this instantiation form you can't pass an order to the `SetSort`.\n\n    test \"Set::get('sortedBy.someKey') returns a new SetSort onn 'someKey'\", ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.get('sortedBy.place')\n      equal 'Harry', sort.get('toArray')[2].get('name')\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"689b19604ea248c7efeb9771c5cfa1045840486a","subject":"Fixing minor typo and rewording a few names","message":"Fixing minor typo and rewording a few names\n","repos":"ojjs\/oj","old_file":"src\/oj.litcoffee","new_file":"src\/oj.litcoffee","new_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\noj function\n-------------------------------------------------------------------------------\n\n  oj function acts like a tag method that doesn't emit\n  Using inline js so the function can be named\n\n    `function oj(){return oj.tag.apply(this, ['oj'].concat([].slice.call(arguments)).concat([{__quiet__:1}]));}`\n\n  Define oj version\n\n    oj.version = '0.2.0'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Store jQuery reference as either the global reference or as required through `jquery2`.\n  This allows this reference to be included as a script tag, included through npm, or overriden.\n\n    if typeof $ != 'undefined'\n      oj.$ = $\n    else if typeof require != 'undefined'\n      try\n        oj.$ = require 'jquery'\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      oj.$ ->\n        oj.$.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrP = Array.prototype\n    FunP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrP.slice\n    unshift = ArrP.unshift\n    concat = ArrP.concat\n\nType helper for oj types\n\n    oj.isOJ = `function(obj){return !!(obj != null ? obj.isOJ : void 0);}`\n\n    oj.isOJType = `function(obj){return oj.isOJ(obj) && obj.type === obj;}`\n\n    oj.isOJInstance = `function(obj){return oj.isOJ(obj) && !oj.isOJType(obj);}`\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isPlainObject = oj.$.isPlainObject\n    oj.isFunction = oj.$.isFunction\n    oj.isArray = oj.$.isArray\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = `function(c){return !!(c.match(\/[A-Z]\/));}`\n    _identity = `function(v){return v;}`\n    _has = `function(obj, key){return ObjP.hasOwnProperty.call(obj, key);}`\n    _keys = Object.keys\n    _values = `function(obj){var keys = _keys(obj);var length = keys.length; var values = new Array(length); for (var i = 0; i < length; i++) {values[i] = obj[keys[i]]; } return values;}`\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      return obj unless (oj.isArray obj) or ((oj.typeOf obj) == 'object')\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n\n  _extend\n\n    _extend = oj.$.extend\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\nError Handling Helpers\n-----------------------------------------------------------------------------\n  Assert cond is true or throw message\n\n    _a = (cond, msg, fn) ->\n      if !cond\n        if fn\n          msg = \"oj.#{fn}: #{msg}\"\n        throw new Error msg\n      return\n\n  Validate fn argument at position n matches type\n\n    _v = (fn, n, v, type) ->\n      n = {1:'first', 2:'second',3:'third',4:'fourth',5:'fifth'}[n]\n      _a (!type or (typeof v == type)), \"#{type} expected for #{n} argument\", fn\n      return\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      r.map (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathRx = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (fname) ->\n      result = _pathRx.exec fname\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      isAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !isAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        isAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !isAbsolute).join('\/')\n\n      ((if isAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n      _v 'addMethod', 2, methodName, 'string'\n      _v 'addMethod', 3, method, 'function'\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n      _v 'removeMethod', 2, methodName, 'string'\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n      _v 'addProperty', 2, propName, 'string'\n      _v 'addProperty', 3, propInfo, 'object'\n\nDefault properties to enumerable and configurable\n\n      propInfo = _extend\n        enumerable: true\n        configurable: true\n        propInfo\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n      _v 'removeProperty', 2, propName, 'string'\n      delete obj[propName]\n      return\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      _v 'isProperty', 2, propName, 'string'\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, rest...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      _v 'tag', 1, name, 'string'\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from rest by unioning all objects\n\n      {args, options:attributes} = oj.unionArguments rest\n\n      if isQuiet = attributes.__quiet__\n        delete attributes.__quiet__\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isPlainObject arg\n          continue\n\n        else if oj.isFunction arg\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to.\n  Do not emit when quiet is set,\n\n      oj._argsAppend(ojml) unless isQuiet\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      oj.tag.elements.open.indexOf(tag) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Get quiet tag name\n\n    _getQuietTagName = (tag) ->\n      '_' + tag\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n\n  Tag functions emit by default\n\n        oj[t] = -> oj.tag t, arguments...\n\n  Underscore tag functions do not emit\n\n        qt = _getQuietTagName t\n        oj[qt] = -> oj.tag t, {__quiet__:1}, arguments...\n\n  Record the tag name so the OJML syntax can use the function instead of a string\n\n        _setTagName oj[t], t\n        _setTagName oj[qt], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extendInto (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.useGlobally = oj.extendInto = (context = root) ->\n\n      o = {}\n      for k,v of oj\n        if k[0] != '_' and k != 'extendInto' and k != 'useGlobally'\n          o[k] = v\n\n  Export _tag and _Type methods\n\n          qn = _getQuietTagName k\n          if oj[qn]\n            o[qn] = oj[qn]\n\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* minify - Minify js and css\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _extend\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        minify: false\n        ignore: {}\n        options\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, minify: options.minify, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      options = _extend\n        inline: true\n        indent: ''\n        options\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isPlainObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = mediaParts.map (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.minify then '' else '\\n'\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if (!minify) and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if (!minify) then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\nminify:false will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (any, options) ->\n\n      if oj.isArray any\n        _compileTag any, options\n\n      else if oj.isString any\n        options.html?.push any\n        if any.length > 0 and any[0] == '<'\n          root = document.createElement 'div'\n          root.innerHTML = any\n          els = root.childNodes\n          options.dom?.appendChild root\n          # for el in els\n          #   options.dom?.appendChild el\n        else\n          options.dom?.appendChild document.createTextNode any\n\n      else if oj.isBoolean(any) or oj.isNumber(any)\n        options.html?.push \"#{any}\"\n        options.dom?.appendChild document.createTextNode \"#{any}\"\n\n      else if oj.isFunction any\n        # Wrap function call to allow full oj generation within any\n        _compileAny (oj any), options\n\n      else if oj.isDate any\n        options.html?.push \"#{any.toLocaleString()}\"\n        options.dom?.appendChild document.createTextNode \"#{any.toLocaleString()}\"\n\n      else if oj.isOJ any\n        options.types?.push any\n        options.html?.push any.toHTML(options)\n        options.dom?.appendChild any.toDOM(options)\n        if options.css?\n          _extend options.css, any.toCSSMap(options)\n\n      # Do nothing for: null, undefined, object\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isPlainObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        _v 'compile', 1, ojml[1], 'string'\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isPlainObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip indention if there is only one child\n          if !options.minify and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if (!options.minify) and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n_attributesProcessedForOJ: Process attributes to make them easier to use\n\n    _attributesProcessedForOJ = (attr) ->\n      jqEvents = `{bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mouseleave:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1}`\n\n  Allow attributes to alias c to class and use arrays instead of space seperated strings\n\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n\n  Allow attributes to take style as an object\n\n      if oj.isPlainObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n\n  Omit attributes with values of false, null, or undefined\n\n      if oj.isPlainObject attr\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n  Filter out jquery events\n\n      events = {}\n      if oj.isPlainObject attr\n        # Filter out attributes that are jquery events\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqEvents[k]?\n            events[k] = v\n            delete attr[k]\n\n  Returns bindable events\n\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        _a oj.$?, \"oj: jquery is missing when binding a '#{ek}' event\"\n        if oj.isArray ev\n          oj.$(el)[ek].apply @, ev\n        else\n          oj.$(el)[ek](ev)\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isPlainObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isPlain options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n_inherit\n------------------------------------------------------------------------------\nBased on, but sadly incompatable with, coffeescript inheritance\n\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n_construct(Type, arg1, arg2, ...)\n------------------------------------------------------------------------------\nConstruct with specified arguments. This is only necessary because new doesn't support apply\/call directly.\n\n    _construct = (Type) ->\n      new (FunP.bind.apply(Type, arguments));\n\noj.argumentShift\n------------------------------------------------------------------------------\nHelper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isPlainObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      _v 'createType', 1, name, 'string'\n      _v 'createType', 2, args, 'object'\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSort Out::properties.concat propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSort Out::methods.concat methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isPlainObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        has: (k) ->\n          @properties.some (v) -> v == k\n\n        # can: Determine if method exists\n        can: (k) ->\n          @methods.some (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isPlainObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\n_createQuietType\n-------------------------------------------------------------------------------\n\n    _createQuietType = (typeName) ->\n      oj[_getQuietTagName typeName] = ->\n        _construct oj[typeName], arguments..., __quiet__:1\n\noj.createEnum\n------------------------------------------------------------------------\n\n    oj.createEnum = (name, args) ->\n      _a 0, 'NYI', 'createEnum'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: ->\n        _a oj.isDOM(@el), 'constructor failed to set this.el', @typeName\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        {options,args} = oj.unionArguments arguments\n\n        # Emit as a tag if new wasn't called or quiet is not set\n        if @.__autonew__ and not options.__quiet__\n          @emit()\n\n        # Remove quiet flag\n        if options.__quiet__?\n          delete options.__quiet__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _clone options\n        @properties.forEach (v) -> delete options[v]\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = oj.$ @el)\n\n        # Get and set id attribute of view\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # # Get and set class attribute of view\n        # class:\n        #   get: -> @$el.attr 'class'\n        #   set: (v) ->\n        #     # Join arrays with spaces\n        #     if oj.isArray v\n        #       v = v.join ' '\n        #     @$el.attr 'class', v\n        #     return\n\n        # Alias for classes\n        # c:\n        #   get: -> @class\n        #   set: (v) -> @class = v; return\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          slice.call(@el.attributes).forEach (attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all classes as an array (readwrite)\n        classes:\n          get: ->\n            @$el.attr('class').split(\/\\s+\/)\n          set: (v) ->\n            @$el.attr('class', v.join(' '))\n            return\n\n        # Get \/ set all currently set themes (readwrite)\n        themes:\n          get: ->\n            thms = []\n            prefix = 'theme-'\n            for cls in @classes\n              if cls.indexOf(prefix) == 0\n                thms.push cls.slice prefix.length\n            thms\n\n          set: (v) ->\n            v = [v] unless oj.isArray v\n            @clearThemes()\n            for theme in v\n              @addTheme theme\n            return\n\n        theme:\n          get: -> @themes\n          set: (v) -> @themes = v; return\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isPlainObject attr\n            for k,v of attr\n              if k == 'class'\n                @addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single class\n        addClass: (name) ->\n          @$el.addClass name\n          return\n\n        # Remove a single class\n        removeClass: (name) ->\n          @$el.removeClass name\n          return\n\n        # Determine if class is applied\n        hasClass: (name) ->\n          @$el.hasClass name\n\n        # Add a single theme\n        addTheme: (name) ->\n          @addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @removeClass \"theme-#{name}\"\n          return\n\n        # Determine if theme is applied\n        hasTheme: (name) ->\n          @hasClass \"theme-#{name}\"\n\n        # Clear all themes\n        clearThemes: ->\n          for theme in @themes\n            @removeTheme theme\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.minify then '' else '\\n')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (options) -> _cssFromPluginObject (_flattenCSSMap @cssMap), _extend({}, minify:options.minify, tags:0)\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      _a oj.isString(css) or oj.isPlainObject(css), 'object or string expected for first argument', @typeName\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      _v @typeName, 1, name, 'string'\n      _v @typeName, 2, css, 'object'\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      @themes = _uniqueSort @themes\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> _a 0, '`make` method not implemented by custom view', @typeName\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> _a 0, '`make` method not implemented by custom view', @typeName\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> _a 0, 'value getter not implemented', @typeName\n          set: (v) -> _a 0, 'value setter not implemented', @typeName\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.Text\n------------------------------------------------------------------------------\nText control\n\n    oj.Text = oj.createType 'Text',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Get tag name if provided\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @el = oj =>\n          oj[@tagName]()\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.Text.base.constructor.call @, options\n\n      properties:\n\nvalue: text value of this object (readwrite)\n\n        value:\n          get: -> @$el.ojValue()\n          set: (v) -> @$el.oj(v); return\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = oj.argumentShift(options, 'value') || args.join('\\n');\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\n\n\n\noj.Image\n------------------------------------------------------------------------------\noj.Image creates an `<img>` tag\n\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          ixNew = if ix < 0 then ix + count else ix\n          unless 0 <= ixNew and ixNew < count\n            throw new Error(\"oj.#{@typeName}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n          ixNew\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n          # ix defaults to -1 and is optional\n          if not ojml?\n            ojml = ix\n            ix = -1\n          ix = @_bound ix, @count+1, \".add: index\"\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix = -1) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = @$tdsRow(rx).toArray().map (el) -> $(el).ojValue()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          if not listOJML?\n            listOJML = rx\n            rx = -1\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          throw new Error('oj.addRow: expected array for row content') unless oj.isArray listOJML\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx = -1) ->\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> @$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          ixNew = if ix < 0 then ix + count else ix\n          unless 0 <= ixNew and ixNew < count\n            throw new Error(\"oj.#{@typeName}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n          ixNew\n\nCreate _Types\n------------------------------------------------------------------------------\n\n  Type with captital first letter that doesn't end in \"View\"\n\n    for typeName of oj\n      if _isCapitalLetter(typeName[0]) and typeName.slice(typeName.length - 4) != 'View'\n        oj[_getQuietTagName typeName] = _createQuietType typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if (key.length > 0 and key[0] != '_') or (key.length > 0 and key[0] == '_' and (oj[key.slice(1)])?)\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      _v 'use', 1, plugin, 'function'\n      _v 'use', 2, settings, 'object'\n\n      # Call plugin to gather extension map\n      pluginResult = plugin oj, settings\n\n      # Add _Type quiet types\n      pluginMap = _clone pluginResult\n      for name,value of pluginResult\n        if oj.isOJType value\n          pluginMap[_getQuietTagName name] = _createQuietType value.typeName\n\n      # Extend all properties\n      for name,value of pluginMap\n        # Add to oj\n        oj[name] = value\n\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqExtend(fn)\n-----------------------------------------------------------------------------\njQuery Extend\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqExtend = (options = {}) ->\n      options =  _extend get:_identity, set:_identity, first: false, options\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get oj.$(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set oj.$(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if oj.$('.' + _styleClassFromPlugin plugin).length == 0\n          oj.$('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    oj.$.fn.oj = _jqExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    oj.$.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:'deep', meta:1, title:'deep', link:'deep', script:'deep'\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj.compile: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      oj.$('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      if oj.isDOMText child\n      # Parse the text to turn it into bool, number, or string\n        text = oj.parse child.nodeValue\n\n      # Get elements as oj instances or elements\n      else if oj.isDOMElement child\n        if (inst = _getInstanceOnElement child)?\n          inst\n        else\n          child\n\n    oj.$.fn.ojValue = _jqExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    oj.$.fn.ojValues = _jqExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        oj.$.fn[ojName] = _jqExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","old_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\noj function\n-------------------------------------------------------------------------------\n\n  oj function acts like a tag method that doesn't emit\n  Using inline js so the function can be named\n\n    `function oj(){return oj.tag.apply(this, ['oj'].concat([].slice.call(arguments)).concat([{__quiet__:1}]));}`\n\n  Define oj version\n\n    oj.version = '0.2.0'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Store jQuery reference as either the global reference or as required through `jquery2`.\n  This allows this reference to be included as a script tag, included through npm, or overriden.\n\n    if typeof $ != 'undefined'\n      oj.$ = $\n    else if typeof require != 'undefined'\n      try\n        oj.$ = require 'jquery'\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      oj.$ ->\n        oj.$.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrP = Array.prototype\n    FunP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrP.slice\n    unshift = ArrP.unshift\n    concat = ArrP.concat\n\nType helper for oj types\n\n    oj.isOJ = `function(obj){return !!(obj != null ? obj.isOJ : void 0);}`\n\n    oj.isOJType = `function(obj){return oj.isOJ(obj) && obj.type === obj;}`\n\n    oj.isOJInstance = `function(obj){return oj.isOJ(obj) && !oj.isOJType(obj);}`\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isPlainObject = oj.$.isPlainObject\n    oj.isFunction = oj.$.isFunction\n    oj.isArray = oj.$.isArray\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = `function(c){return !!(c.match(\/[A-Z]\/));}`\n    _identity = `function(v){return v;}`\n    _has = `function(obj, key){return ObjP.hasOwnProperty.call(obj, key);}`\n    _keys = Object.keys\n    _values = `function(obj){var keys = _.keys(obj);var length = keys.length; var values = new Array(length); for (var i = 0; i < length; i++) {values[i] = obj[keys[i]]; } return values;}`\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      return obj unless (oj.isArray obj) or ((oj.typeOf obj) == 'object')\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n\n  _extend\n\n    _extend = oj.$.extend\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\nError Handling Helpers\n-----------------------------------------------------------------------------\n  Assert cond is true or throw message\n\n    _a = (cond, msg, fn) ->\n      if !cond\n        if fn\n          msg = \"oj.#{fn}: #{msg}\"\n        throw new Error msg\n      return\n\n  Validate fn argument at position n matches type\n\n    _v = (fn, n, v, type) ->\n      n = {1:'first', 2:'second',3:'third',4:'fourth',5:'fifth'}[n]\n      _a (!type or (typeof v == type)), \"#{type} expected for #{n} argument\", fn\n      return\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      r.map (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n      _v 'addMethod', 2, methodName, 'string'\n      _v 'addMethod', 3, method, 'function'\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n      _v 'removeMethod', 2, methodName, 'string'\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n      _v 'addProperty', 2, propName, 'string'\n      _v 'addProperty', 3, propInfo, 'object'\n\nDefault properties to enumerable and configurable\n\n      propInfo = _extend {}, {\n        enumerable: true\n        configurable: true},\n        propInfo\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n      _v 'removeProperty', 2, propName, 'string'\n      delete obj[propName]\n      return\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      _v 'isProperty', 2, propName, 'string'\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, rest...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      _v 'tag', 1, name, 'string'\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from rest by unioning all objects\n\n      {args, options:attributes} = oj.unionArguments rest\n\n      if isQuiet = attributes.__quiet__\n        delete attributes.__quiet__\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isPlainObject arg\n          continue\n\n        else if oj.isFunction arg\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to.\n  Do not emit when quiet is set,\n\n      oj._argsAppend(ojml) unless isQuiet\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      oj.tag.elements.open.indexOf(tag) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Get quiet tag name\n\n    _getQuietTagName = (tag) ->\n      '_' + tag\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n\n  Tag functions emit by default\n\n        oj[t] = -> oj.tag t, arguments...\n\n  Underscore tag functions do not emit\n\n        qt = _getQuietTagName t\n        oj[qt] = -> oj.tag t, {__quiet__:1}, arguments...\n\n  Record the tag name so the OJML syntax can use the function instead of a string\n\n        _setTagName oj[t], t\n        _setTagName oj[qt], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extendInto (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.useGlobally = oj.extendInto = (context = root) ->\n\n      o = {}\n      for k,v of oj\n        if k[0] != '_' and k != 'extendInto' and k != 'useGlobally'\n          o[k] = v\n\n  Export _tag and _Type methods\n\n          qn = _getQuietTagName k\n          if oj[qn]\n            o[qn] = oj[qn]\n\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* minify - Minify js and css\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _extend\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        minify: false\n        ignore: {}\n        options\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, minify: options.minify, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      options = _extend\n        inline: true\n        indent: ''\n        options\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isPlainObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = mediaParts.map (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.minify then '' else '\\n'\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if (!minify) and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if (!minify) then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\nminify:false will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (any, options) ->\n\n      if oj.isArray any\n        _compileTag any, options\n\n      else if oj.isString any\n        options.html?.push any\n        if any.length > 0 and any[0] == '<'\n          root = document.createElement 'div'\n          root.innerHTML = any\n          els = root.childNodes\n          options.dom?.appendChild root\n          # for el in els\n          #   options.dom?.appendChild el\n        else\n          options.dom?.appendChild document.createTextNode any\n\n      else if oj.isBoolean(any) or oj.isNumber(any)\n        options.html?.push \"#{any}\"\n        options.dom?.appendChild document.createTextNode \"#{any}\"\n\n      else if oj.isFunction any\n        # Wrap function call to allow full oj generation within any\n        _compileAny (oj any), options\n\n      else if oj.isDate any\n        options.html?.push \"#{any.toLocaleString()}\"\n        options.dom?.appendChild document.createTextNode \"#{any.toLocaleString()}\"\n\n      else if oj.isOJ any\n        options.types?.push any\n        options.html?.push any.toHTML(options)\n        options.dom?.appendChild any.toDOM(options)\n        if options.css?\n          _extend options.css, any.toCSSMap(options)\n\n      # Do nothing for: null, undefined, object\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isPlainObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        _v 'compile', 1, ojml[1], 'string'\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isPlainObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip indention if there is only one child\n          if !options.minify and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if (!options.minify) and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n      jqEvents = `{bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mouseleave:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1}`\n\n      # Allow attributes to alias c to class and use arrays instead of space seperated strings\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n\n      # Allow attributes to take style as an object\n      if oj.isPlainObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n\n      # Omit attributes with values of false, null, or undefined\n      if oj.isPlainObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n      # Filter out jquery events\n      events = {}\n      if oj.isPlainObject attr\n        # Filter out attributes that are jquery events\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqEvents[k]?\n            events[k] = v\n            delete attr[k]\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        _a oj.$?, \"oj: jquery is missing when binding a '#{ek}' event\"\n        if oj.isArray ev\n          oj.$(el)[ek].apply @, ev\n        else\n          oj.$(el)[ek](ev)\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isPlainObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isPlain options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n_inherit\n------------------------------------------------------------------------------\nBased on, but sadly incompatable with, coffeescript inheritance\n\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n_construct(Type, arg1, arg2, ...)\n------------------------------------------------------------------------------\nConstruct with specified arguments. This is only necessary because new doesn't support apply\/call directly.\n\n    _construct = (Type) ->\n      new (FunP.bind.apply(Type, arguments));\n\noj.argumentShift\n------------------------------------------------------------------------------\nHelper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isPlainObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      _v 'createType', 1, name, 'string'\n      _v 'createType', 2, args, 'object'\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSort Out::properties.concat propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSort Out::methods.concat methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isPlainObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        has: (k) ->\n          @properties.some (v) -> v == k\n\n        # can: Determine if method exists\n        can: (k) ->\n          @methods.some (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isPlainObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\n_createQuietType\n-------------------------------------------------------------------------------\n\n    _createQuietType = (typeName) ->\n      oj[_getQuietTagName typeName] = ->\n        _construct oj[typeName], arguments..., __quiet__:1\n\noj.createEnum\n------------------------------------------------------------------------\n\n    oj.createEnum = (name, args) ->\n      _a 0, 'NYI', 'createEnum'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: ->\n        _a oj.isDOM(@el), 'constructor failed to set this.el', @typeName\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        {options,args} = oj.unionArguments arguments\n\n        # Emit as a tag if new wasn't called or quiet is not set\n        if @.__autonew__ and not options.__quiet__\n          @emit()\n\n        # Remove quiet flag\n        if options.__quiet__?\n          delete options.__quiet__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _clone options\n        @properties.forEach (v) -> delete options[v]\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = oj.$ @el)\n\n        # Get and set id attribute of view\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # # Get and set class attribute of view\n        # class:\n        #   get: -> @$el.attr 'class'\n        #   set: (v) ->\n        #     # Join arrays with spaces\n        #     if oj.isArray v\n        #       v = v.join ' '\n        #     @$el.attr 'class', v\n        #     return\n\n        # Alias for classes\n        # c:\n        #   get: -> @class\n        #   set: (v) -> @class = v; return\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          slice.call(@el.attributes).forEach (attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all classes as an array (readwrite)\n        classes:\n          get: ->\n            @$el.attr('class').split(\/\\s+\/)\n          set: (v) ->\n            @$el.attr('class', v.join(' '))\n            return\n\n        # Get \/ set all currently set themes (readwrite)\n        themes:\n          get: ->\n            thms = []\n            prefix = 'theme-'\n            for cls in @classes\n              if cls.indexOf(prefix) == 0\n                thms.push cls.slice prefix.length\n            thms\n\n          set: (v) ->\n            v = [v] unless oj.isArray v\n            @clearThemes()\n            for theme in v\n              @addTheme theme\n            return\n\n        theme:\n          get: -> @themes\n          set: (v) -> @themes = v; return\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isPlainObject attr\n            for k,v of attr\n              if k == 'class'\n                @addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single class\n        addClass: (name) ->\n          @$el.addClass name\n          return\n\n        # Remove a single class\n        removeClass: (name) ->\n          @$el.removeClass name\n          return\n\n        # Determine if class is applied\n        hasClass: (name) ->\n          @$el.hasClass name\n\n        # Add a single theme\n        addTheme: (name) ->\n          @addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @removeClass \"theme-#{name}\"\n          return\n\n        # Determine if theme is applied\n        hasTheme: (name) ->\n          @hasClass \"theme-#{name}\"\n\n        # Clear all themes\n        clearThemes: ->\n          for theme in @themes\n            @removeTheme theme\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.minify then '' else '\\n')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (options) -> _cssFromPluginObject (_flattenCSSMap @cssMap), _extend({}, minify:options.minify, tags:0)\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      _a oj.isString(css) or oj.isPlainObject(css), 'object or string expected for first argument', @typeName\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      _v @typeName, 1, name, 'string'\n      _v @typeName, 2, css, 'object'\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      @themes = _uniqueSort @themes\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> _a 0, '`make` method not implemented by custom view', @typeName\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> _a 0, '`make` method not implemented by custom view', @typeName\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> _a 0, 'value getter not implemented', @typeName\n          set: (v) -> _a 0, 'value setter not implemented', @typeName\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.Text\n------------------------------------------------------------------------------\nText control\n\n    oj.Text = oj.createType 'Text',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Get tag name if provided\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @el = oj =>\n          oj[@tagName]()\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.Text.base.constructor.call @, options\n\n      properties:\n\nvalue: text value of this object (readwrite)\n\n        value:\n          get: -> @$el.ojValue()\n          set: (v) -> @$el.oj(v); return\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = oj.argumentShift(options, 'value') || args.join('\\n');\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\n\n\n\noj.Image\n------------------------------------------------------------------------------\noj.Image creates an `<img>` tag\n\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          ixNew = if ix < 0 then ix + count else ix\n          unless 0 <= ixNew and ixNew < count\n            throw new Error(\"oj.#{@typeName}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n          ixNew\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n          # ix defaults to -1 and is optional\n          if not ojml?\n            ojml = ix\n            ix = -1\n          ix = @_bound ix, @count+1, \".add: index\"\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix = -1) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = @$tdsRow(rx).toArray().map (el) -> $(el).ojValue()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          if not listOJML?\n            listOJML = rx\n            rx = -1\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          throw new Error('oj.addRow: expected array for row content') unless oj.isArray listOJML\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx = -1) ->\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> @$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          ixNew = if ix < 0 then ix + count else ix\n          unless 0 <= ixNew and ixNew < count\n            throw new Error(\"oj.#{@typeName}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n          ixNew\n\nCreate _Types\n------------------------------------------------------------------------------\n\n  Type with captital first letter that doesn't end in \"View\"\n\n    for typeName of oj\n      if _isCapitalLetter(typeName[0]) and typeName.slice(typeName.length - 4) != 'View'\n        oj[_getQuietTagName typeName] = _createQuietType typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if (key.length > 0 and key[0] != '_') or (key.length > 0 and key[0] == '_' and (oj[key.slice(1)])?)\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      _v 'use', 1, plugin, 'function'\n      _v 'use', 2, settings, 'object'\n\n      # Call plugin to gather extension map\n      pluginResult = plugin oj, settings\n\n      # Add _Type quiet types\n      pluginMap = _clone pluginResult\n      for name,value of pluginResult\n        if oj.isOJType value\n          pluginMap[_getQuietTagName name] = _createQuietType value.typeName\n\n      # Extend all properties\n      for name,value of pluginMap\n        # Add to oj\n        oj[name] = value\n\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqExtend(fn)\n-----------------------------------------------------------------------------\njQuery Extend\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqExtend = (options = {}) ->\n      options =  _extend get:_identity, set:_identity, first: false, options\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get oj.$(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set oj.$(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if oj.$('.' + _styleClassFromPlugin plugin).length == 0\n          oj.$('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    oj.$.fn.oj = _jqExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    oj.$.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:'deep', meta:1, title:'deep', link:'deep', script:'deep'\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj.compile: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      oj.$('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      if oj.isDOMText child\n      # Parse the text to turn it into bool, number, or string\n        text = oj.parse child.nodeValue\n\n      # Get elements as oj instances or elements\n      else if oj.isDOMElement child\n        if (inst = _getInstanceOnElement child)?\n          inst\n        else\n          child\n\n    oj.$.fn.ojValue = _jqExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    oj.$.fn.ojValues = _jqExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        oj.$.fn[ojName] = _jqExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d322c0bc86dedf83237b0ff56b017529547ba355","subject":"in. jokes","message":"in. jokes\n","repos":"nomilous\/in.","old_file":"in.jokes\/spandex.litcoffee","new_file":"in.jokes\/spandex.litcoffee","new_contents":"#! \/usr\/bin\/env coffee\n\nThe expander supports multiple asyncronous functions that `appear = synchronous()`.\n\nTo achieve that it needed to do some peculiar things.\n\n__Very peculiar!__\n\nThings that [some](https:\/\/www.google.co.za\/search?q=uptight+people&espv=2&biw=1063&bih=1058&source=lnms&tbm=isch&sa=X&ei=q6CJVYTyIpPB7Ab95YLQBA&ved=0CAYQ_AUoAQ#tbm=isch&q=uptight) may disaprove of.\n\nLike wearing [spandex in public](https:\/\/www.google.co.za\/search?q=spandex+in+public+nuts&espv=2&biw=1063&bih=1058&tbm=isch&source=lnms&sa=X&ei=5Z-JVez6KeWY7gbl_oCYAg&ved=0CAYQ_AUoAQ#tbm=isch&q=spandex+in+public).\n\nIt broke the [expan](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/expander.js)sion (to be [eval](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/compiler.js#L57)'d) [into pieces and substituted](https:\/\/www.google.co.za\/search?q=into+pieces+and+substituted+an+array&es_sm=91&source=lnms&tbm=isch&sa=X&ei=laOJVbKFOqKM7Abs4Y_ACw&ved=0CAkQ_AUoAw&biw=1063&bih=1058#tbm=isch&q=into+pieces+and+substituted) an array ($e[n]) for each function's results.\n\nThe results of the division are loaded into a variable called `spandex`...\n\nWhich happens to be in scope at injection eval.\n\n    require('..\/')\n\n    $$in (arg) ->\n\n        ### in(arg).as {{1}}###\n\n        console.log arg\n\n\n#### Return and finish later - few bits still to wire together\n","old_contents":"#! \/usr\/bin\/env coffee\n\nThe expander supports multiple asyncronous functions that `appear = syncronous()`.\n\nTo achieve that it needed to do some peculiar things.\n\n__Very peculiar!__\n\nThings that [some](https:\/\/www.google.co.za\/search?q=uptight+people&espv=2&biw=1063&bih=1058&source=lnms&tbm=isch&sa=X&ei=q6CJVYTyIpPB7Ab95YLQBA&ved=0CAYQ_AUoAQ#tbm=isch&q=uptight) may disaprove of.\n\nLike wearing [spandex in public](https:\/\/www.google.co.za\/search?q=spandex+in+public+nuts&espv=2&biw=1063&bih=1058&tbm=isch&source=lnms&sa=X&ei=5Z-JVez6KeWY7gbl_oCYAg&ved=0CAYQ_AUoAQ#tbm=isch&q=spandex+in+public).\n\nIt broke the [expan](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/expander.js)sion (to be [eval](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/compiler.js#L57)'d) [into pieces and substituted](https:\/\/www.google.co.za\/search?q=into+pieces+and+substituted+an+array&es_sm=91&source=lnms&tbm=isch&sa=X&ei=laOJVbKFOqKM7Abs4Y_ACw&ved=0CAkQ_AUoAw&biw=1063&bih=1058#tbm=isch&q=into+pieces+and+substituted) an array ($e[n]) for each function's results.\n\nThe results of the division are loaded into a variable called `spandex`...\n\nWhich happens to be in scope at injection eval.\n\n    require('..\/')\n\n    $$in (arg) ->\n\n        ### in(arg).as {{1}}###\n\n        console.log arg\n\n\n#### Return and finish later - few bits still to wire together\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d38cd13705a38e7de397affb7916b744cb1d0d74","subject":"Temporarily accept \"Privat\" as a valid lisence","message":"Temporarily accept \"Privat\" as a valid lisence\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/helper\/schema.litcoffee","new_file":"coffee\/helper\/schema.litcoffee","new_contents":"    joi = require 'joi'\n\n## All\n\n### Required\n\nThese fields are required for all objects.\n\n    exports.required =\n      _id: joi.string().regex(\/^[a-f0-9]{24}$\/)\n      tilbyder: joi.string()\n      endret: joi.string()\n      checksum: joi.string()\n      lisens: joi.string().valid([\n        'Privat' # @TODO This is just temporarily\n        'CC BY 3.0 NO'\n        'CC BY-SA 3.0 NO'\n        'CC BY-ND 3.0 NO'\n        'CC BY-NC 3.0 NO'\n        'CC BY-NC-SA 3.0 NO'\n        'CC BY-NC-ND 3.0 NO'\n        'CC BY 4.0'\n        'CC BY-SA 4.0'\n        'CC BY-ND 4.0'\n        'CC BY-NC 4.0'\n        'CC BY-NC-SA 4.0'\n        'CC BY-NC-ND 4.0'\n      ])\n      navngiving: joi.string()\n      status: joi.string().valid([\n        'Offentlig'\n        'Privat'\n        'Kladd'\n        'Slettet'\n      ])\n\n### Optional\n\nThere optional are optional for all objects.\n\n    exports.optional =\n      navn: joi.string()\n      kommuner: joi.array().includes(joi.string())\n      fylker: joi.array().includes(joi.string())\n      omr\u00e5der: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      beskrivelse: joi.string()\n      lenker: joi.array().includes(joi.object(\n        tittel: joi.string().optional()\n        type: joi.string().optional()\n        url: joi.string().regex(\/^https?:\\\/\\\/\/)\n      ))\n      tags: joi.array().includes(joi.string())\n      privat: joi.object()\n      grupper: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      steder: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      bilder: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      url: joi.string().regex(\/^https?:\\\/\\\/\/)\n\n## Data types\n\n    exports.type =\n\n### Bilder\n\n      bilder:\n        geojson: joi.object(\n          type: joi.string().valid('Point').required()\n          properties: joi.object(\n            altitude: joi.number().integer()\n          )\n          coordinates: joi.array().includes(joi.number()).length(2).required()\n        )\n        fotograf: joi.object(\n          navn: joi.string()\n          telefon: joi.string()\n          epost: joi.string().email()\n        )\n        eier: joi.object(\n          navn: joi.string()\n          telefon: joi.string()\n          epost: joi.string().email()\n          url: joi.string().regex(\/^https?:\\\/\\\/\/)\n        )\n        img: joi.array().includes(joi.object(\n          url: joi.string().regex(\/^https?:\\\/\\\/\/).required()\n          width: joi.number().integer()\n          height: joi.number().integer()\n          size: joi.number()\n        ))\n\n### Grupper\n\n      grupper:\n        geojson: joi.object(\n          type: joi.string().valid('Polygon').required()\n          coordinates: joi.array().includes(\n            joi.array().includes(\n              joi.array().includes(joi.number()).length(2)\n            )\n          ).required()\n        )\n        organisasjonsnr: joi.string()\n        logo: joi.string().regex(\/^https?:\\\/\\\/\/)\n        ansatte: joi.number().integer()\n        kontaktinfo: joi.array().includes(joi.object(\n          tittel: joi.string()\n          adresse1: joi.string()\n          adresse2: joi.string()\n          postnummer: joi.number().integer()\n          poststed: joi.string()\n          land: joi.string()\n          telefon: joi.string()\n          fax: joi.string()\n          epost: joi.string().email()\n          url: joi.string().regex(\/^https?:\\\/\\\/\/)\n        ))\n        foreldregruppe: joi.string().regex(\/^[a-f0-9]{24}$\/)\n\n### Turer\n\n      turer:\n        geojson: joi.object(\n          type: joi.string().valid('LineString').required()\n          coordinates: joi.array().includes(\n            joi.array().includes(joi.number()).length(2)\n          ).required()\n        )\n        distanse: joi.number()\n        retning: joi.string().valid([\n          \"AB\"\n          \"BA\"\n          \"ABA\"\n          \"BAB\"\n        ])\n        adkomst: joi.string()\n        gradering: joi.string().valid([\n          \"Enkel\"\n          \"Middels\"\n          \"Krevende\"\n          \"Ekspert\"\n        ])\n        passer_for: joi.array().includes(joi.string())\n        tilrettelagt_for: joi.array().includes(joi.string())\n        sesong: joi.array().includes(joi.number().integer().min(1).max(12))\n        tidsbruk: joi.object(\n          normal: joi.object(\n            dager: joi.number().integer()\n            timer: joi.number().integer()\n            minutter: joi.number().integer()\n          )\n          min: joi.object(\n            dager: joi.number().integer()\n            timer: joi.number().integer()\n            minutter: joi.number().integer()\n          )\n          max: joi.object(\n            dager: joi.number().integer()\n            timer: joi.number().integer()\n            minutter: joi.number().integer()\n          )\n        )\n\n### Omr\u00e5der\n\n      omr\u00e5der:\n        geojson: joi.object(\n          type: joi.string().valid('Polygon').required()\n          coordinates: joi.array().includes(\n            joi.array().includes(\n              joi.array().includes(joi.number()).length(2)\n            )\n          ).required()\n        )\n        foreldreomr\u00e5der: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n\n### Steder\n\n      steder:\n        navn_alt: joi.array().includes(joi.string())\n        ssr_id: joi.number().integer()\n        geojson: joi.object(\n          type: joi.string().valid('Point').required()\n          properties: joi.object(\n            altitude: joi.number().integer()\n          )\n          coordinates: joi.array().includes(joi.number()).length(2).required()\n        )\n        kommune: joi.string()\n        fylke: joi.string()\n        adkomst: joi.object(\n          sommer: joi.string()\n          vinter: joi.string()\n        )\n        tilrettelagt_for: joi.array().includes(joi.string())\n        fasiliteter: joi.object()\n        bygge\u00e5r: joi.number().integer()\n        bes\u00f8ksstatisikk: joi.object()\n        betjeningsgrad: joi.string()\n        kart: joi.string()\n        turkart: joi.array().includes(joi.string())\n\n","old_contents":"    joi = require 'joi'\n\n## All\n\n### Required\n\nThese fields are required for all objects.\n\n    exports.required =\n      _id: joi.string().regex(\/^[a-f0-9]{24}$\/)\n      tilbyder: joi.string()\n      endret: joi.string()\n      checksum: joi.string()\n      lisens: joi.string().valid([\n        'CC BY 3.0 NO'\n        'CC BY-SA 3.0 NO'\n        'CC BY-ND 3.0 NO'\n        'CC BY-NC 3.0 NO'\n        'CC BY-NC-SA 3.0 NO'\n        'CC BY-NC-ND 3.0 NO'\n        'CC BY 4.0'\n        'CC BY-SA 4.0'\n        'CC BY-ND 4.0'\n        'CC BY-NC 4.0'\n        'CC BY-NC-SA 4.0'\n        'CC BY-NC-ND 4.0'\n      ])\n      navngiving: joi.string()\n      status: joi.string().valid([\n        'Offentlig'\n        'Privat'\n        'Kladd'\n        'Slettet'\n      ])\n\n### Optional\n\nThere optional are optional for all objects.\n\n    exports.optional =\n      navn: joi.string()\n      kommuner: joi.array().includes(joi.string())\n      fylker: joi.array().includes(joi.string())\n      omr\u00e5der: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      beskrivelse: joi.string()\n      lenker: joi.array().includes(joi.object(\n        tittel: joi.string().optional()\n        type: joi.string().optional()\n        url: joi.string().regex(\/^https?:\\\/\\\/\/)\n      ))\n      tags: joi.array().includes(joi.string())\n      privat: joi.object()\n      grupper: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      steder: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      bilder: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n      url: joi.string().regex(\/^https?:\\\/\\\/\/)\n\n## Data types\n\n    exports.type =\n\n### Bilder\n\n      bilder:\n        geojson: joi.object(\n          type: joi.string().valid('Point').required()\n          properties: joi.object(\n            altitude: joi.number().integer()\n          )\n          coordinates: joi.array().includes(joi.number()).length(2).required()\n        )\n        fotograf: joi.object(\n          navn: joi.string()\n          telefon: joi.string()\n          epost: joi.string().email()\n        )\n        eier: joi.object(\n          navn: joi.string()\n          telefon: joi.string()\n          epost: joi.string().email()\n          url: joi.string().regex(\/^https?:\\\/\\\/\/)\n        )\n        img: joi.array().includes(joi.object(\n          url: joi.string().regex(\/^https?:\\\/\\\/\/).required()\n          width: joi.number().integer()\n          height: joi.number().integer()\n          size: joi.number()\n        ))\n\n### Grupper\n\n      grupper:\n        geojson: joi.object(\n          type: joi.string().valid('Polygon').required()\n          coordinates: joi.array().includes(\n            joi.array().includes(\n              joi.array().includes(joi.number()).length(2)\n            )\n          ).required()\n        )\n        organisasjonsnr: joi.string()\n        logo: joi.string().regex(\/^https?:\\\/\\\/\/)\n        ansatte: joi.number().integer()\n        kontaktinfo: joi.array().includes(joi.object(\n          tittel: joi.string()\n          adresse1: joi.string()\n          adresse2: joi.string()\n          postnummer: joi.number().integer()\n          poststed: joi.string()\n          land: joi.string()\n          telefon: joi.string()\n          fax: joi.string()\n          epost: joi.string().email()\n          url: joi.string().regex(\/^https?:\\\/\\\/\/)\n        ))\n        foreldregruppe: joi.string().regex(\/^[a-f0-9]{24}$\/)\n\n### Turer\n\n      turer:\n        geojson: joi.object(\n          type: joi.string().valid('LineString').required()\n          coordinates: joi.array().includes(\n            joi.array().includes(joi.number()).length(2)\n          ).required()\n        )\n        distanse: joi.number()\n        retning: joi.string().valid([\n          \"AB\"\n          \"BA\"\n          \"ABA\"\n          \"BAB\"\n        ])\n        adkomst: joi.string()\n        gradering: joi.string().valid([\n          \"Enkel\"\n          \"Middels\"\n          \"Krevende\"\n          \"Ekspert\"\n        ])\n        passer_for: joi.array().includes(joi.string())\n        tilrettelagt_for: joi.array().includes(joi.string())\n        sesong: joi.array().includes(joi.number().integer().min(1).max(12))\n        tidsbruk: joi.object(\n          normal: joi.object(\n            dager: joi.number().integer()\n            timer: joi.number().integer()\n            minutter: joi.number().integer()\n          )\n          min: joi.object(\n            dager: joi.number().integer()\n            timer: joi.number().integer()\n            minutter: joi.number().integer()\n          )\n          max: joi.object(\n            dager: joi.number().integer()\n            timer: joi.number().integer()\n            minutter: joi.number().integer()\n          )\n        )\n\n### Omr\u00e5der\n\n      omr\u00e5der:\n        geojson: joi.object(\n          type: joi.string().valid('Polygon').required()\n          coordinates: joi.array().includes(\n            joi.array().includes(\n              joi.array().includes(joi.number()).length(2)\n            )\n          ).required()\n        )\n        foreldreomr\u00e5der: joi.array().includes(joi.string().regex(\/^[a-f0-9]{24}$\/))\n\n### Steder\n\n      steder:\n        navn_alt: joi.array().includes(joi.string())\n        ssr_id: joi.number().integer()\n        geojson: joi.object(\n          type: joi.string().valid('Point').required()\n          properties: joi.object(\n            altitude: joi.number().integer()\n          )\n          coordinates: joi.array().includes(joi.number()).length(2).required()\n        )\n        kommune: joi.string()\n        fylke: joi.string()\n        adkomst: joi.object(\n          sommer: joi.string()\n          vinter: joi.string()\n        )\n        tilrettelagt_for: joi.array().includes(joi.string())\n        fasiliteter: joi.object()\n        bygge\u00e5r: joi.number().integer()\n        bes\u00f8ksstatisikk: joi.object()\n        betjeningsgrad: joi.string()\n        kart: joi.string()\n        turkart: joi.array().includes(joi.string())\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d4a7febc24f7f40ec986df28c2fd80a3953cb728","subject":"provide proper return during Property.merge to only include newly merged element(s). see #40","message":"provide proper return during Property.merge to only include newly merged element(s). see #40\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object.__` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property') if process.env.DEBUG?\n    co       = require 'co'\n    delegate = require 'delegates'\n    Emitter  = require('events').EventEmitter\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n        Object.setPrototypeOf @state, Emitter.prototype\n\n        @schema.kind ?= 'anydata'\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .method 'once'\n        .method 'on'\n        .access 'container'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, force: true\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.property = this\n          Object.defineProperty ctx, 'action',\n            get: -> @content if @content instanceof Function\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'parent', get: -> @container?.__\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          if @parent instanceof Property then @parent.root\n          else this\n      \n      @property 'props',\n        get: -> prop for k, prop of @content?.__props__\n      \n      @property 'key',\n        get: ->\n          return unless @schema is @parent?.schema\n          switch\n            when @content not instanceof Object  then @name + 1\n            when @content.hasOwnProperty('@key') then @content['@key']\n            when Array.isArray @container\n              for idx, item of @container when item is @content\n                idx = Number(idx) unless (Number.isNaN (Number idx))\n                return idx+1\n              return undefined\n\n      # TODO: cache this in @state so that it's not reconstructed every time\n      @property 'path',\n        get: ->\n          return XPath.parse '\/', @schema if this is @root\n          key = @key\n          #debug? \"[#{@name}:path] #{@kind}(#{@name}) has #{key} #{typeof key}\"\n          entity = switch typeof key\n            when 'number' then \".[#{key}]\"\n            when 'string' then \".[key() = '#{key}']\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          #debug? \"[#{@name}:path] #{@parent.name} + #{entity}\"\n          @parent.path.append entity\n\n## Instance-level methods\n\n      emit: (event) ->\n        @state.emit arguments...\n        unless this is @root\n          debug? \"[emit] '#{event}' from '#{@name}' to '#{@root.name}'\"\n          @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It registers itself into\n`obj.__props__` as well as defined in the target `obj` via\n`Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false }) ->\n        return obj unless obj instanceof Object\n\n        # when joining for the first time, apply the data found in the\n        # 'obj' into the property instance\n        unless @container?\n          debug? \"[join] #{@kind}(#{@name}) assigning container\"\n          debug? opts\n          @container = obj\n          unless opts.replace is true\n            opts.suppress = true\n            exists = obj[@name]\n            unless exists?.__ instanceof Property\n              @set obj[@name], opts\n            return obj\n\n        debug? \"[join] #{@kind}(#{@name}) into #{obj.constructor.name} container\"\n        if Array.isArray(obj) and Array.isArray(@content)\n          debug? @content\n          throw @error \"cannot join array property into list container\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n          \n        unless obj.hasOwnProperty '__props__'\n          Object.defineProperty obj, '__props__', value: {}\n        obj.__props__[@name] = this\n        try Object.defineProperty obj, @name, this\n        @emit 'update', this if this is @root or not opts.suppress\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern) -> switch\n        when pattern?\n          match = @find pattern\n          debug? match\n          switch\n            when match.length is 1 then match[0].get()\n            when match.length > 1  then match.map (x) -> x.get()\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then @invoke.bind this\n        else\n          @binding.call @context if @binding?\n          # TODO: should utilize yield to resolve promises\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        debug? \"[set] #{@kind}(#{@name}) enter with:\"\n        debug? value\n        debug? opts\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only element\"\n\n        try Object.defineProperty value, '__', configurable: true, value: this\n        value = switch\n          when @schema.apply?\n            @schema.apply value, @context.with(opts)\n          else value\n        try Object.defineProperty value, '__', value: this\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        @state.value = value\n        \n        try @join @container, opts\n        catch e then @state.value = @state.prev; throw e\n        debug? \"[set] #{@kind}(#{@name}) completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        unless typeof @content is 'object' then return @set value\n\n        value = value[@name] if value? and value.hasOwnProperty @name\n        return this unless typeof value is 'object'\n        \n        if Array.isArray @content\n          length = @content.length\n          debug? \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          value = [ value ] unless Array.isArray value\n          value = @schema.apply value\n          # apply schema on a combined array\n          combine = @content.concat value\n          attr.apply combine for attr in @schema.attrs\n          value.forEach (item) =>\n            item.__.name += length\n            item.__.join @content, opts\n          prop = new Property @name, @schema\n          prop.state.container = @container\n          prop.state.value = value\n          return prop\n        else\n          # TODO: protect this as a transaction?\n          @content[k] = v for k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n          return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        if not @content? and @kind is 'list' and not Array.isArray value\n          value = [ value ] \n        res = @merge value, replace: false\n        @emit 'create', this\n        return res\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@parent` containing object.\n      \n      remove: ->\n        if @key?\n          @container.splice @name, 1\n          #delete @parent[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          @join @container\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        xpath = switch\n          when pattern instanceof XPath then pattern\n          else XPath.parse pattern, @schema\n        debug? \"[#{@path}] finding #{pattern} starting with #{xpath.tag}\"\n        if opts.root or not @container? or xpath.tag not in [ '\/', '..' ]\n          debug? \"[#{@path}] #{@name} applying '#{xpath}'\"\n          debug? @content\n          xpath.apply(@content).props ? []\n        else switch\n          when xpath.tag is '\/'  and @parent? then @parent.find xpath, opts\n          when xpath.tag is '..' and @parent? then @parent.find xpath.xpath, opts\n          else []\n\n### invoke\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\n      invoke: (args...) ->\n        try\n          ctx = @context\n          unless ctx.action?\n            throw @error \"cannot invoke on a property without function\"\n          debug? \"[invoke] calling #{@name} method\"\n          # TODO: need to ensure unique instance of 'input' and 'output' for concurrency\n          ctx.input = args[0] ? {}\n          ctx.action.apply ctx, args\n          return co -> yield Promise.resolve ctx.output\n        catch e\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        res = new Error \"[#{at}] #{msg}\"\n        res.name = 'PropertyError'\n        res.context = ctx\n        return res\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          key:    @key\n          xpath:  @path.toString()\n          schema: @schema.toJSON tag: false, extended: true\n          active: @enumerable\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\nproperty's `@name`.\n\n      toJSON: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            res[k] = copy v for own k, v of src\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object.__` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property') if process.env.DEBUG?\n    co       = require 'co'\n    delegate = require 'delegates'\n    Emitter  = require('events').EventEmitter\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n        Object.setPrototypeOf @state, Emitter.prototype\n\n        @schema.kind ?= 'anydata'\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .method 'once'\n        .method 'on'\n        .access 'container'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, force: true\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.property = this\n          Object.defineProperty ctx, 'action',\n            get: -> @content if @content instanceof Function\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'parent', get: -> @container?.__\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          if @parent instanceof Property then @parent.root\n          else this\n      \n      @property 'props',\n        get: -> prop for k, prop of @content?.__props__\n      \n      @property 'key',\n        get: ->\n          return unless @schema is @parent?.schema\n          switch\n            when @content not instanceof Object  then @name + 1\n            when @content.hasOwnProperty('@key') then @content['@key']\n            when Array.isArray @container\n              for idx, item of @container when item is @content\n                idx = Number(idx) unless (Number.isNaN (Number idx))\n                return idx+1\n              return undefined\n\n      # TODO: cache this in @state so that it's not reconstructed every time\n      @property 'path',\n        get: ->\n          return XPath.parse '\/', @schema if this is @root\n          key = @key\n          #debug? \"[#{@name}:path] #{@kind}(#{@name}) has #{key} #{typeof key}\"\n          entity = switch typeof key\n            when 'number' then \".[#{key}]\"\n            when 'string' then \".[key() = '#{key}']\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          #debug? \"[#{@name}:path] #{@parent.name} + #{entity}\"\n          @parent.path.append entity\n\n## Instance-level methods\n\n      emit: (event) ->\n        @state.emit arguments...\n        unless this is @root\n          debug? \"[emit] '#{event}' from '#{@name}' to '#{@root.name}'\"\n          @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It registers itself into\n`obj.__props__` as well as defined in the target `obj` via\n`Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false }) ->\n        return obj unless obj instanceof Object\n\n        # when joining for the first time, apply the data found in the\n        # 'obj' into the property instance\n        unless @container?\n          debug? \"[join] #{@kind}(#{@name}) assigning container\"\n          debug? opts\n          @container = obj\n          unless opts.replace is true\n            opts.suppress = true\n            exists = obj[@name]\n            unless exists?.__ instanceof Property\n              @set obj[@name], opts\n            return obj\n\n        debug? \"[join] #{@kind}(#{@name}) into #{obj.constructor.name} container\"\n        if Array.isArray(obj) and Array.isArray(@content)\n          debug? @content\n          throw @error \"cannot join array property into list container\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n          \n        unless obj.hasOwnProperty '__props__'\n          Object.defineProperty obj, '__props__', value: {}\n        obj.__props__[@name] = this\n        try Object.defineProperty obj, @name, this\n        @emit 'update', this if this is @root or not opts.suppress\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern) -> switch\n        when pattern?\n          match = @find pattern\n          debug? match\n          switch\n            when match.length is 1 then match[0].get()\n            when match.length > 1  then match.map (x) -> x.get()\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then @invoke.bind this\n        else\n          @binding.call @context if @binding?\n          # TODO: should utilize yield to resolve promises\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        debug? \"[set] #{@kind}(#{@name}) enter with:\"\n        debug? value\n        debug? opts\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only element\"\n\n        try Object.defineProperty value, '__', configurable: true, value: this\n        value = switch\n          when @schema.apply?\n            @schema.apply value, @context.with(opts)\n          else value\n        try Object.defineProperty value, '__', value: this\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        @state.value = value\n        \n        try @join @container, opts\n        catch e then @state.value = @state.prev; throw e\n        debug? \"[set] #{@kind}(#{@name}) completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        unless typeof @content is 'object' then return @set value\n\n        value = value[@name] if value? and value.hasOwnProperty @name\n        return unless typeof value is 'object'\n        \n        if Array.isArray @content\n          length = @content.length\n          debug? \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          value = [ value ] unless Array.isArray value\n          try Object.defineProperty value, '__', configurable: true, value: this\n          value = @schema.apply value\n          # apply schema on a combined array\n          combine = @content.concat value\n          attr.apply combine for attr in @schema.attrs\n          value.forEach (item) =>\n            item.__.name += length\n            item.__.join @content, opts\n          return value[0].__ if value.length is 1\n        else\n          # TODO: protect this as a transaction?\n          @content[k] = v for k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n        return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        if not @content? and @kind is 'list' and not Array.isArray value\n          value = [ value ] \n        res = @merge value, replace: false\n        @emit 'create', this\n        return res\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@parent` containing object.\n      \n      remove: ->\n        if @key?\n          @container.splice @name, 1\n          #delete @parent[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          @join @container\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        xpath = switch\n          when pattern instanceof XPath then pattern\n          else XPath.parse pattern, @schema\n        debug? \"[#{@path}] finding #{pattern} starting with #{xpath.tag}\"\n        if opts.root or not @container? or xpath.tag not in [ '\/', '..' ]\n          debug? \"[#{@path}] #{@name} applying '#{xpath}'\"\n          debug? @content\n          xpath.apply(@content).props ? []\n        else switch\n          when xpath.tag is '\/'  and @parent? then @parent.find xpath, opts\n          when xpath.tag is '..' and @parent? then @parent.find xpath.xpath, opts\n          else []\n\n### invoke\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\n      invoke: (args...) ->\n        try\n          ctx = @context\n          unless ctx.action?\n            throw @error \"cannot invoke on a property without function\"\n          debug? \"[invoke] calling #{@name} method\"\n          # TODO: need to ensure unique instance of 'input' and 'output' for concurrency\n          ctx.input = args[0] ? {}\n          ctx.action.apply ctx, args\n          return co -> yield Promise.resolve ctx.output\n        catch e\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        res = new Error \"[#{at}] #{msg}\"\n        res.name = 'PropertyError'\n        res.context = ctx\n        return res\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          key:    @key\n          xpath:  @path.toString()\n          schema: @schema.toJSON tag: false, extended: true\n          active: @enumerable\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\nproperty's `@name`.\n\n      toJSON: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            res[k] = copy v for own k, v of src\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"c80f738660e432d927315fb097823cc83171066c","subject":"fix detection for invalid array joining another array","message":"fix detection for invalid array joining another array\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object.__` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    co       = require 'co'\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state  = \n          value: null\n          parent: null\n          configurable: true\n          enumerable: false\n\n        @schema.kind   ?= 'anydata'\n        @schema.config ?= true\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'parent'\n        .getter 'configurable'\n        .getter 'enumerable'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'config'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, force: true\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.property = this\n          ctx.state = {}\n          Object.defineProperty ctx, 'action',\n            get: -> @content if @content instanceof Function\n          return ctx\n\n      @property 'root',\n        get: ->\n          #debug \"looking for root from #{@name} has parent: #{@parent?}\"\n          return this if @kind is 'module'\n          if @parent?.__ instanceof Property then @parent.__.root\n          else this\n      \n      @property 'props',\n        get: -> prop for k, prop of @content?.__props__\n      \n      @property 'key',\n        get: -> switch\n          when @content not instanceof Object  then undefined\n          when @content.hasOwnProperty('@key') then @content['@key']\n          when Array.isArray @parent\n            for idx, item of @parent when item is @content\n              idx = Number(idx) unless (Number.isNaN (Number idx))\n              return idx+1\n            return undefined\n          \n      @property 'path',\n        get: ->\n          return XPath.parse '\/', @schema if this is @root\n          entity = switch typeof @key\n            when 'number' then \".[#{@key}]\"\n            when 'string' then \".[key() = '#{@key}']\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          debug \"[#{@name}] path: #{@parent.__.name} + #{entity}\"\n          @parent.__.path.append entity\n\n## Instance-level methods\n\n      emit: (event) ->\n        return if this is @root\n        debug \"[emit] '#{event}' from '#{@name}' to '#{@root.name}'\"\n        @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It registers itself into\n`obj.__props__` as well as defined in the target `obj` via\n`Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false }) ->\n        return obj unless obj instanceof Object\n\n        # when joining for the first time, apply the data found in the\n        # 'obj' into the property instance\n        unless @parent?\n          debug \"[join] assigning parent to new property: #{@name}\"\n          debug obj\n          @parent = obj\n          @set obj[@name] unless opts.replace is true\n          return obj\n\n        debug \"[join] object with new property: #{@name}\"\n\n        if Array.isArray(obj) and Array.isArray(@content)\n          throw @error \"cannot join array property into containing list\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n          \n        unless obj.hasOwnProperty '__props__'\n          Object.defineProperty obj, '__props__', value: {}\n        prev = obj.__props__[@name]\n        obj.__props__[@name] = this\n        Object.defineProperty obj, @name, this\n        @emit 'update', this, prev unless opts.suppress\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern) -> switch\n        when pattern?\n          match = @find pattern\n          switch\n            when match.length is 1 then match[0].get()\n            when match.length > 1  then match.map (x) -> x.get()\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then @invoke.bind this\n        else\n          @binding.call @context if @binding?\n          # TODO: should utilize yield to resolve promises\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        debug \"[set] setting '#{@name}' with:\"\n        debug value\n\n        debug \"[set] #{@kind}(#{@name}) attaching '__' property\"\n        try Object.defineProperty value, '__', configurable: true, value: this\n\n        unless not value? or opts.force or @config?.valueOf() isnt false\n          throw @error \"cannot set data on read-only element\"\n          \n        value = switch\n          when @schema.apply? then @schema.apply value, @context\n          else value\n\n        try\n          Object.defineProperty value, '__', value: this\n          delete value[k] for own k of value when k not of value.__props__\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        @state.value = value\n        \n        try @join @parent, opts\n        catch e then @state.value = @state.prev; throw e\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        unless typeof @content is 'object' then return @set value\n\n        value = value[@name] if value? and value.hasOwnProperty @name\n        return unless typeof value is 'object'\n        \n        if Array.isArray @content\n          length = @content.length\n          debug \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          value = [ value ] unless Array.isArray value\n          value = @schema.apply value\n          value.forEach (item) =>\n            item.__.name += length\n            item.__.join @content, opts\n          # TODO: need to re-apply schema on the 'list'\n        else\n          # TODO: protect this as a transaction?\n          @content[k] = v for k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n        return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        @merge value, replace: false\n        @emit 'create', this\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@parent` containing object.\n      \n      remove: ->\n        if @key?\n          @parent.splice @name, 1\n          #delete @parent[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          @join @parent\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\n      find: (pattern='.', opts={}) ->\n        xpath = switch\n          when pattern instanceof XPath then pattern\n          else XPath.parse pattern, @schema\n        debug \"[#{@path}] finding #{pattern} starting with #{xpath.tag}\"\n        if opts.root or not @parent? or xpath.tag not in [ '\/', '..' ]\n          debug \"[#{@path}] #{@name} applying '#{xpath}'\"\n          debug @content\n          xpath.apply(@content).props\n        else switch\n          when xpath.tag is '\/'  and @parent.__? then @parent.__.find xpath, opts\n          when xpath.tag is '..' and @parent.__? then @parent.__.find xpath.xpath, opts\n          else []\n\n### invoke\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\n      invoke: (args...) ->\n        try\n          ctx = @context\n          unless ctx.action?\n            throw @error \"cannot invoke on a property without function\"\n          debug \"[invoke] calling #{@name} method\"\n          # TODO: need to ensure unique instance of 'input' and 'output' for concurrency\n          ctx.input = args[0] ? {}\n          ctx.action.apply ctx, args\n          return co -> yield Promise.resolve ctx.output\n        catch e\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        res = new Error \"[#{at}] #{msg}\"\n        res.name = 'PropertyError'\n        res.context = ctx\n        return res\n        \n### valueOf (tag)\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\nproperty's `@name`.\n\n      valueOf: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            res[k] = copy v for own k, v of src\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object.__` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    co       = require 'co'\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state  = \n          value: null\n          parent: null\n          configurable: true\n          enumerable: false\n\n        @schema.kind   ?= 'anydata'\n        @schema.config ?= true\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'parent'\n        .getter 'configurable'\n        .getter 'enumerable'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'config'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, force: true\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.property = this\n          ctx.state = {}\n          Object.defineProperty ctx, 'action',\n            get: -> @content if @content instanceof Function\n          return ctx\n\n      @property 'root',\n        get: ->\n          #debug \"looking for root from #{@name} has parent: #{@parent?}\"\n          return this if @kind is 'module'\n          if @parent?.__ instanceof Property then @parent.__.root\n          else this\n      \n      @property 'props',\n        get: -> prop for k, prop of @content?.__props__\n      \n      @property 'key',\n        get: -> switch\n          when @content not instanceof Object  then undefined\n          when @content.hasOwnProperty('@key') then @content['@key']\n          when Array.isArray @parent\n            for idx, item of @parent\n              return idx if item is @content\n            return undefined\n          \n      @property 'path',\n        get: ->\n          return XPath.parse '\/', @schema if this is @root\n          entity = switch typeof @key\n            when 'number' then \".[#{@key}]\"\n            when 'string' then \".[key() = '#{@key}']\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          debug \"[#{@name}] path: #{@parent.__.name} + #{entity}\"\n          @parent.__.path.append entity\n\n## Instance-level methods\n\n      emit: (event) ->\n        return if this is @root\n        debug \"[emit] '#{event}' from '#{@name}' to '#{@root.name}'\"\n        @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It registers itself into\n`obj.__props__` as well as defined in the target `obj` via\n`Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false }) ->\n        return obj unless obj instanceof Object\n\n        # when joining for the first time, apply the data found in the\n        # 'obj' into the property instance\n        unless @parent?\n          debug \"[join] assigning parent to new property: #{@name}\"\n          debug obj\n          @parent = obj\n          @set obj[@name] unless opts.replace is true\n          return obj\n\n        debug \"[join] object with new property: #{@name}\"\n\n        if Array.isArray obj and Array.isArray @content\n          throw @error \"cannot join array property into containing list\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n          \n        unless obj.hasOwnProperty '__props__'\n          Object.defineProperty obj, '__props__', value: {}\n        prev = obj.__props__[@name]\n        obj.__props__[@name] = this\n        Object.defineProperty obj, @name, this\n        @emit 'update', this, prev unless opts.suppress\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern) -> switch\n        when pattern?\n          match = @find pattern\n          switch\n            when match.length is 1 then match[0].get()\n            when match.length > 1  then match.map (x) -> x.get()\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then @invoke.bind this\n        else\n          @binding.call @context if @binding?\n          # TODO: should utilize yield to resolve promises\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        debug \"[set] setting '#{@name}' with:\"\n        debug value\n\n        debug \"[set] #{@kind}(#{@name}) attaching '__' property\"\n        try Object.defineProperty value, '__', configurable: true, value: this\n\n        unless not value? or opts.force or @config?.valueOf() isnt false\n          throw @error \"cannot set data on read-only element\"\n          \n        value = switch\n          when @schema.apply? then @schema.apply value, @context\n          else value\n\n        try\n          Object.defineProperty value, '__', value: this\n          delete value[k] for own k of value when k not of value.__props__\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        @state.value = value\n        \n        try @join @parent, opts\n        catch e then @state.value = @state.prev; throw e\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        unless typeof @content is 'object' then return @set value\n\n        value = value[@name] if value? and value.hasOwnProperty @name\n        return unless typeof value is 'object'\n        \n        if Array.isArray @content\n          length = @content.length\n          debug \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          value = [ value ] unless Array.isArray value\n          value = @schema.apply value\n          value.forEach (item) =>\n            item.__.name += length\n            item.__.join @content, opts\n          # TODO: need to re-apply schema on the 'list'\n        else\n          # TODO: protect this as a transaction?\n          @content[k] = v for k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n        return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        @merge value, replace: false\n        @emit 'create', this\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@parent` containing object.\n      \n      remove: ->\n        if @key?\n          @parent.splice @name, 1\n          #delete @parent[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          @join @parent\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\n      find: (pattern='.', opts={}) ->\n        xpath = switch\n          when pattern instanceof XPath then pattern\n          else XPath.parse pattern, @schema\n        debug \"[#{@path}] finding #{pattern} starting with #{xpath.tag}\"\n        if opts.root or not @parent? or xpath.tag not in [ '\/', '..' ]\n          debug \"[#{@path}] #{@name} applying '#{xpath}'\"\n          debug @content\n          xpath.apply(@content).props\n        else switch\n          when xpath.tag is '\/'  and @parent.__? then @parent.__.find xpath, opts\n          when xpath.tag is '..' and @parent.__? then @parent.__.find xpath.xpath, opts\n          else []\n\n### invoke\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\n      invoke: (args...) ->\n        try\n          ctx = @context\n          unless ctx.action?\n            throw @error \"cannot invoke on a property without function\"\n          debug \"[invoke] calling #{@name} method\"\n          # TODO: need to ensure unique instance of 'input' and 'output' for concurrency\n          ctx.input = args[0] ? {}\n          ctx.action.apply ctx, args\n          return co -> yield Promise.resolve ctx.output\n        catch e\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        res = new Error \"[#{at}] #{msg}\"\n        res.name = 'PropertyError'\n        res.context = ctx\n        return res\n        \n### valueOf (tag)\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\nproperty's `@name`.\n\n      valueOf: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            res[k] = copy v for own k, v of src\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"a9f340be4226c8b060ef0e04beb8158501aa1c93","subject":"spec SetIndex and UniqueSetIndex","message":"spec SetIndex and UniqueSetIndex\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/05_set.litcoffee","new_file":"docs\/05_set.litcoffee","new_contents":"# Batman.Set\n\n`Set` is an observable, `Batman.Object` wrapper around `SimpleSet`. `Set` also extends [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html), which provides [many useful methods](\/docs\/api\/batman.enumerable.html).\n\n### SimpleSet vs Set\n\n`SimpleSet` and `Set` are two distinct classes in Batman. `SimpleSet` implements the basic set semantics, but it is *not* a `Batman.Object`, so properties on it (like its `length` or `toArray`) cannot be bound. `Set` is a `Batman.Object`, so it can be observed, and thus plays nicely with the accessor system. Use a `SimpleSet` only when you know nothing will need to be observed on the set you are creating, which usually isn't a valid assumption. If it is in fact valid, consider using a native array as well, as iteration and membership checks will be faster.\n\n## constructor(items...)\n\nWhen creating a `Set`, items forming the initial set can be passed as separate arguments to the constructor\n\n    test 'new Set constructor can be called without arguments', ->\n      set = new Batman.Set\n      deepEqual set.toArray(), []\n\n    test 'new Set constructor can be passed items to add to the set.', ->\n      set = new Batman.Set('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n## length : number\n\nA count of the items in a `Set` can be found at its `length` property.\n\n## isEmpty : boolean\n\nObservable property for `isEmpty()`\n\n## toArray : Array\n\nObservable property for `toArray()`. Whenever items are added or removed on the set, the `toArray` property will change. This is the mechanism by which Batman's view bindings get notified of collection updates.\n\n    test 'observers on the toArray property fire when the set changes', ->\n      results = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.observe('toArray', (newArray) -> results = newArray.sort())\n      deepEqual set.add('d'), ['d']\n      deepEqual results, ['a', 'b', 'c', 'd']\n      deepEqual set.remove('b'), ['b']\n      deepEqual results, ['a', 'c', 'd']\n\n## has(item) : Boolean\n\n`has` returns a boolean describing if the given `item` is a member of the set.\n\n_Note_: Using `has(item)` in an accessor body will register the set `has` is called upon as a source of the property being calculated. This so that whenever the set changes, the property will be recalculated, because the set may now have or not have the item in question.\n\n    test 'Set::has indicates if an item is a member of the set or not.', ->\n      set = new Batman.Set('a', 'b', 'c')\n      ok set.has('a')\n      equal set.has('d'), false\n\n    test 'Set::has registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @awards = new Batman.Set()\n\n        @accessor 'bestEver?', -> @get('awards').has('Stanley Cup')\n\n      result = null\n      team = new Team\n      team.observeAndFire 'bestEver?', (status) -> result = status\n      team.get('awards').add 'Eastern Conference Champs'\n      equal result, false\n      team.get('awards').add 'Stanley Cup'\n      equal result, true\n\n## add(items...)\n\n`add` adds 0 or more new items to the set. `add` returns an array of the items which have been newly added to the set, which is to say the intersection of the argument items and the set's complement before addition.\n\n`add` fires the `itemsWereAdded` event with the list of items newly added to the set if that list has length greater than 0. This is to say the event will not be fired if the items passed to add were all already members of the set.\n\n    test 'Set::add adds an item to the set', ->\n      set = new Batman.Set()\n      equal set.has('a'), false\n      deepEqual set.add('a'), ['a']\n      equal set.has('a'), true\n\n    test 'Set::add returns only the new items that weren\\'t previously in the set', ->\n      set = new Batman.Set('a', 'b')\n      deepEqual set.add('b','c','d').sort(), ['c', 'd']\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd']\n\n    test 'Set::add fires the itemsWereAdded event with the items newly added to the set', ->\n      results = null\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereAdded', (item) -> results = item)\n      set.add('b','c','d')\n      deepEqual results.sort(), ['c','d']\n\n    test 'Set::add does not fire the itemsWereAdded event if the added items were already in the set.', ->\n      results = undefined\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereAdded', (items) -> results = items)\n      set.add('a', 'b')\n      equal typeof results, 'undefined'\n\n## remove(items...)\n\n`remove` removes 0 or more items from the set. `remove` returns an array of the items which were successfully removed from the set, which is to say the intersection of the argument items and the set itself before removal.\n\n`remove` fires the `itemsWereRemoved` event with the list of removed items if that list has length greater than 0. This is to say the event will not be fired if none of the passed items were members of the set.\n\n    test 'Set::remove removes an item from the set', ->\n      set = new Batman.Set('a')\n      equal set.has('a'), true\n      deepEqual set.remove('a'), ['a']\n      equal set.has('a'), false\n\n    test 'Set::remove returns only the new items that were previously in the set', ->\n      set = new Batman.Set('a', 'b')\n      deepEqual set.remove('b','c','d').sort(), ['b']\n      deepEqual set.toArray(), ['a']\n\n    test 'Set::remove fires the itemsWereRemoved event with the items removed to the set', ->\n      results = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('b','c')\n      deepEqual results.sort(), ['b','c']\n\n    test 'Set::remove does not fire the itemsWereRemoved event if the removed items were not already members of the set.', ->\n      results = undefined\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('c', 'd')\n      equal typeof results, 'undefined'\n\n## find(testFunction : function) : [Object]\n\n`find` returns the first item within the set for which the `testFunction` called with the item returns `true`, or `undefined` if no item passes the test.\n\n_Note_: `find` returns the first item the test passes for, but since set iteration has no specified order, no guarantee can be made about which item will be returned if more than one item in the set passes the test. However, set iteration order is stable, so `find` called on the same set twice should return the same item.\n\n\n    test 'Set::find returns the first item for which the test function passes', ->\n      set = new Batman.Set(1, 2, 3)\n      equal set.find((x) -> x % 2 == 0), 2\n\n    test 'Set::find returns undefined if no items pass the test function', ->\n      set = new Batman.Set(1, 2, 3)\n      equal typeof set.find((x) -> x > 5), 'undefined'\n\n## forEach(iteratorFunction : function[, context: Object])\n\n`forEach` calls the `iteratorFunction` with each item in the set, optionally executing the `iteratorFunction` in the passed context. Returns `undefined`.\n\n_Note_: Set iteration order is not defined, thus Set client code cannot rely on one item being iterated over before another, regardless of when the Set's items were added. If you need an ordered set, Batman provides `SetSort` for exactly this, while including the added benefit of observability. If you need a one time ordering of a set, you can get the array representation with `toArray` and then use vanilla JavaScript `sort` on that array.\n\n_Note_: Using `forEach()` in an accessor body will register the set iterated over as a source of the property being calculated. This so that whenever the set changes, the property will be recalculated. This can become an issue if you iterate over a set and modify the set's items, as when the property recalculates that modification will potentially happen on items it's happened on previously.\n\n    test 'Set::forEach iterates over each item in the set', ->\n      sum = 0\n      set = new Batman.Set(1,2,3)\n      set.forEach (x) -> sum += x\n      equal sum, 6\n\n    test 'Set::forEach iterates over each item in the set optionally in the provided context', ->\n      context = {sum: 0}\n      set = new Batman.Set(1,2,3)\n      set.forEach((x) ->\n        @sum += x\n      , context)\n      equal context.sum, 6\n\n    test 'Set::forEach registers the set as a source if called in an accessor body', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @players = new Batman.Set()\n        @accessor 'willWinTheCup?', ->\n          sedinCount = 0\n          @players.forEach (player) ->\n            sedinCount++ if player.split(' ')[1] == 'Sedin'\n          sedinCount >= 2\n\n      result = null\n      team = new Team()\n      team.observeAndFire 'willWinTheCup?', (status) -> result = status\n      equal team.get('willWinTheCup?'), false\n      team.get('players').add 'Henrik Sedin'\n      equal result, false\n      team.get('players').add 'Daniel Sedin'\n      equal result, true\n\n## isEmpty() : boolean\n\n`isEmpty` returns a boolean: `true` if the set has no items, and `false` if it has any items.\n\n_Note_: Using `isEmpty()` in an accessor body will register the set `isEmpty` is called on as a source of the property being calculated, so that whenever the set changes the property will be recalculated.\n\n    test 'Set::isEmpty returns true if the set has no items', ->\n      set = new Batman.Set()\n      ok set.isEmpty()\n      set.add('a')\n      equal set.isEmpty(), false\n\n    test 'Set::isEmpty registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @games = new Batman.Set()\n        @accessor 'seasonStarted?', -> !@games.isEmpty()\n\n      team = new Team\n      equal team.get('seasonStarted?'), false\n      team.get('games').add({win: true})\n      equal team.get('seasonStarted?'), true\n\n## clear() : Array\n\n`clear` removes all items from a set. Returns an array of all the items in the set.\n\n`clear` will fire the `itemsWereRemoved` event once with all the items in the set.\n\n_Note_: Set iteration order is not defined, so the order of the array of items returned by `clear` is undefined.\n\n    test 'Set::clear empties the set', ->\n      set = new Batman.Set('a', 'b', 'c')\n      equal set.isEmpty(), false\n      deepEqual set.clear().sort(), ['a', 'b', 'c']\n      ok set.isEmpty()\n\n    test 'Set::clear fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.clear()\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## replace(collection : Enumerable) : Array\n\n`replace` removes all the items in a set and then adds all the items found in another `collection`. The other collection must have a `toArray` function which returns an array representation of the collection. Returns the array of items added.\n\n`replace` will fire the `itemsWereRemoved` event once with all the items in the set, and then the `itemsWereAdded` event once with the items from the incoming collection.\n\n    test 'Set::replace empties the set and then adds items from a different collection', ->\n      set = new Batman.Set('a', 'b', 'c')\n      secondSet = new Batman.Set('d', 'e', 'f')\n      set.replace(secondSet)\n      deepEqual set.toArray().sort(), ['d', 'e', 'f']\n\n    test 'Set::replace fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.replace(new Batman.SimpleSet())\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n    test 'Set::replace fires the itemsWereAdded event with all the items in the incoming set', ->\n      result = null\n      set = new Batman.Set()\n      set.on('itemsWereAdded', (items) -> result = items)\n      set.replace(new Batman.SimpleSet('a', 'b', 'c'))\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## toArray() : Array\n\n`toArray` returns an array representation of the set.\n\n_Note_: Set iteration order is not defined, so the order in which the set's items appear in the array is not defined. It is however stable, so the order of the items in two successive `toArray` calls where the set was not modified in between should be the same.\n\n_Note_: `toArray` is also an observable property.\n\n_Note_: Using `toArray()` in an accessor body will register the set `toArray` is called on as a source of the property being calculated, so that whenever the set changes the property will be recalculated.\n\n    test 'Set::toArray returns an array representation of the set', ->\n      set = new Batman.Set()\n      deepEqual set.toArray(), []\n      set.add('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n## merge(collections... : Enumerable) : Set\n\n`merge` adds all the items in a set and all the items in the passed `collections` to a new set and returns it. A `collection` is an object which has a `forEach` function. `merge` is a non-destructive collection union, so the set `merge` is called on and each `collection` passed to `merge` are unaffected by the call.\n\n_Note_: Be careful about using `merge` within accessors. Calling `merge` in an accessor function body will register the set `merge` is called upon as a source of the property being calculated, which means when the set changes, that accessor will be recalculated. This means the O(n * m) merge will occur again each time, and return an entirely new `Set` instance. If the previously returned `Set` instance is retained after recalculation, this is a big memory leak. Instead of merging in accessors, try to use a `SetUnion` or a `SetIntersection`.\n\n    test 'Set::merge returns a new set with the items of the original set and the passed set', ->\n      abc = new Batman.Set('a', 'b', 'c')\n      def = new Batman.Set('d', 'e', 'f')\n      equal Batman.typeOf(set = abc.merge(def)), 'Object'\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd', 'e', 'f']\n\n## indexedBy(key : String) : SetIndex\n\n`indexedBy` returns a hash of sets which buckets all the items in the callee set by the value of a particular `key`. The value of the passed `key` is `get`ted from each object in the set, and then a hash of each value to a set of the items with that value at the `key` is built. This hash of sets is a smart object called a `SetIndex` which will continue to observe the set and the value of the `key` on each item in the set to ensure the set index remains up to date. `SetIndex` also has a friend named `UniqueSetIndex` which will give you a hash of items instead of a hash of sets with items for easy access if you know each item's value at the `key` is unique.\n\n    test 'Set::indexedBy returns a new SetIndex with the items bucketed by the value of the key', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'), Batman(colour: 'blue'))\n      index = set.indexedBy('colour')\n      ok index.get('blue') instanceof Batman.Set\n      equal index.get('blue').get('length'), 2\n      equal index.get('green').get('length'), 1\n\n    test 'Set::indexedBy returns a new SetIndex which observes the set for new additions and stays up to date', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.indexedBy('colour')\n      equal index.get('blue').get('length'), 1\n      newItem = Batman(colour: 'blue')\n      set.add(newItem)\n      equal index.get('blue').get('length'), 2\n      ok index.get('blue').has(newItem)\n      set.remove(newItem)\n      equal index.get('blue').get('length'), 1\n\n    test 'Set::indexedBy returns a new SetIndex which observes the items in the set for changes to the observed key', ->\n      itemA = Batman(colour: 'blue')\n      itemB = Batman(colour: 'green')\n      set = new Batman.Set(itemA, itemB)\n      index = set.indexedBy('colour')\n      equal index.get('blue').get('length'), 1\n      equal index.get('green').get('length'), 1\n      itemA.set('colour', 'green')\n      equal index.get('blue').get('length'), 0\n      equal index.get('green').get('length'), 2\n\n`SetIndex`es can be created by calling the `indexedBy` function on the `Set`, as well as by `get`ting a `key` on the `indexedBy` property.\n\n    test \"Set::get('indexedBy.someKey') returns a new SetIndex for 'someKey'\", ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.get('indexedBy.colour')\n      equal index.get('blue').get('length'), 1\n\n## indexedByUnique(key : String) : UniqueSetIndex\n\n`indexedByUnique` returns a hash of items keyed by the value of the given `key` on each item from the callee set. The value of the passed `key` is `get`ted from each object in the set, and then a hash of each value to an item with that value at the `key` is built. This hash of items is a smart object called a `UniqueSetIndex` which will continue to observe the set and the value of the `key` on each item in the set to ensure the index remains up to date. Note that the semantics for which item ends up in the hash if two items have the same value for the `key` are undefined, so it is wise to only use `UniqueSetIndex`es on keys who's values are going to be unique in the set. If the values are not going to be unique, you may be interested in `SetIndex` and `Set::indexedBy`.\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex with the items hashed by the value of the key', ->\n      greenItem = Batman(colour: 'green')\n      blueItem = Batman(colour: 'blue')\n      set = new Batman.Set(greenItem, blueItem)\n      index = set.indexedByUnique('colour')\n      ok blueItem == index.get('blue')\n      ok greenItem == index.get('green')\n      equal undefined, index.get('red')\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex which observes the set for new additions and stays up to date', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.indexedByUnique('colour')\n      newItem = Batman(colour: 'red')\n      set.add(newItem)\n      ok newItem == index.get('red')\n      set.remove(newItem)\n      equal undefined, index.get('red')\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex which observes the items in the set for changes to the observed key', ->\n      itemA = Batman(colour: 'blue')\n      itemB = Batman(colour: 'green')\n      set = new Batman.Set(itemA, itemB)\n      index = set.indexedByUnique('colour')\n      equal index.get('blue')?, true\n      equal index.get('green')?, true\n      equal index.get('red')?, false\n      itemA.set('colour', 'red')\n      equal index.get('blue')?, false\n      equal index.get('green')?, true\n      equal index.get('red')?, true\n\n`UniqueSetIndex`es can be created by calling the `indexedByUnique` function on the `Set`, as well as by `get`ting a `key` on the `indexedByUnique` property.\n\n    test \"Set::get('indexedByUnique.someKey') returns a new UniqueSetIndex for 'someKey'\", ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.get('indexedByUnique.colour')\n      equal 'blue', index.get('blue').get('colour')\n\n## sortedBy(key: String [, order: String]) : SetSort\n\n`sortedBy` returns a `Set` like object containing all the items of the callee set but with a defined iteration order (unlike `Set`). The iteration order is defined as the alpha numeric sorting of the values of the passed `key` gotten from each item. The direction of the sort can be controlled with the `order` argument, which defaults to `asc` (short for ascending) or can be passed as `desc` (short for descending). This `Set` like object is a `SetSort` which encapsulates the logic to get the values from each item at the passed `key` and traverse the `Set` in the values sorted order.\n\n`SetSort`s are useful for getting a transform of a `Set` which sorted, but also because the sort stays up to date as items are added or removed to the sorted set, or the value at the `key` changes on any of the items in the set.\n\n    test 'Set::sortedBy returns a new SetSort who can be iterated in the sorted order of the value of the key on each item', ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n\n    test 'Set::sortedBy returns a new SetSort which observes the callee set for additions or removals and puts new items in the sorted order', ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n      burke = Batman(place: 1.5, name: 'Burke')\n      set.add(burke)\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Burke', 'Camilo', 'Harry']\n\n    test 'Set::sortedBy returns a new SetSort which observes each item in the callee set for changes to the sort key', ->\n      harry = Batman(place: 2, name: 'Harry')\n      tom = Batman(place: 1, name: 'Tom')\n      set = new Batman.Set(harry, tom)\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Harry']\n      tom.set('place', 3)\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Harry', 'Tom']\n\n`SetSort`s can be created by calling the `sortedBy` function on the `Set`, as well as by `get`ting a `key` on the `sortedBy` property. Note that with this instantiation form you can't pass an order to the `SetSort`.\n\n    test \"Set::get('sortedBy.someKey') returns a new SetSort onn 'someKey'\", ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.get('sortedBy.place')\n      equal 'Harry', sort.get('toArray')[2].get('name')\n\n# Batman.SetIndex\n\n`Batman.SetIndex` is a grouped collection of items derived from a [`Batman.Set`]() filled with [`Batman.Object`]()s. It extends `Batman.Object` and [`Batman.Enumerable`](), so it inherits methods from them, too. In short, a `SetIndex` tracks its base `Set` and contains \"buckets\" of items from that `Set`, grouped by the provided key.\n\n```coffeescript\nbatarang = new Batman.Object(name: \"Batarang\", type: \"ranged\")\ngrappleGun = new Batman.Object(name: \"Grapple Gun\", type: \"ranged\")\nfists = new Batman.Object(name: \"Fists\", type: \"melee\")\n\nweapons = new Batman.Set(batarang, grappleGun, fists)\nweaponsByType = new Batman.SetIndex(set, 'type')\n\nweaponsByType.get('ranged.length') # => 2\nweaponsByType.get('melee.length')  # => 1\nweaponsByType.get('ranged').map (weapon) -> weapon.get('name')  # => [\"Batarang\", \"GrappleGun\"]\nweaponsByType.toArray()                                         # => [\"ranged\", \"melee\"]\n```\n\n## ::constructor(base : Set, key : String ) : SetIndex\n\nA `SetIndex` is made with a `base` and a `key`. Items in the `base` set will be grouped according to their value for `key`. The resulting `SetIndex` observes its `base`, so any items added to the `base` are also added (and indexed) in the `SetIndex`\n\n## ::get(value : String) : Set\n\nReturns a `Batman.Set` of items whose indexed `key` matches `value`. It returns an empty set if no items match `value`, but if any matching items are added to the `base` set, they will also be added to this set.\n\n## ::toArray() : Array\n\nReturns an array with the distinct values of `key` provided to the constructor.\n\n## ::forEach(func)\n\nCalls `func(key, group)` for each group in the SetIndex.\n\n# Batman.UniqueSetIndex\n\n`Batman.UniqueSetIndex` extends `SetIndex` but adds a new consideration: its index contains _first matching item_ for each value of the `key` (rather than all matching items).\n\n```coffeescript\nbatarang = new Batman.Object(name: \"Batarang\", type: \"ranged\")\ngrappleGun = new Batman.Object(name: \"Grapple Gun\", type: \"ranged\")\nfists = new Batman.Object(name: \"Fists\", type: \"melee\")\n\nweapons = new Batman.Set(batarang, grappleGun, fists)\nweaponsByUniqueType = new Batman.UniqueSetIndex(set, 'type')\nweaponsByUniqueType.get('ranged.name') # => \"Batarang\"\n```\n\n## ::get(value : String) : Object\n\nReturns the first matching member whose indexed `key` is equal to `value`.\n\n# Batman.SetSort\n# Batman.SetUnion\n# Batman.SetIntersection\n# Batman.SetComplement\n","old_contents":"# Batman.Set\n\n`Set` is an observable, `Batman.Object` wrapper around `SimpleSet`. `Set` also extends [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html), which provides [many useful methods](\/docs\/api\/batman.enumerable.html).\n\n### SimpleSet vs Set\n\n`SimpleSet` and `Set` are two distinct classes in Batman. `SimpleSet` implements the basic set semantics, but it is *not* a `Batman.Object`, so properties on it (like its `length` or `toArray`) cannot be bound. `Set` is a `Batman.Object`, so it can be observed, and thus plays nicely with the accessor system. Use a `SimpleSet` only when you know nothing will need to be observed on the set you are creating, which usually isn't a valid assumption. If it is in fact valid, consider using a native array as well, as iteration and membership checks will be faster.\n\n## constructor(items...)\n\nWhen creating a `Set`, items forming the initial set can be passed as separate arguments to the constructor\n\n    test 'new Set constructor can be called without arguments', ->\n      set = new Batman.Set\n      deepEqual set.toArray(), []\n\n    test 'new Set constructor can be passed items to add to the set.', ->\n      set = new Batman.Set('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n## length : number\n\nA count of the items in a `Set` can be found at its `length` property.\n\n## isEmpty : boolean\n\nObservable property for `isEmpty()`\n\n## toArray : Array\n\nObservable property for `toArray()`. Whenever items are added or removed on the set, the `toArray` property will change. This is the mechanism by which Batman's view bindings get notified of collection updates.\n\n    test 'observers on the toArray property fire when the set changes', ->\n      results = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.observe('toArray', (newArray) -> results = newArray.sort())\n      deepEqual set.add('d'), ['d']\n      deepEqual results, ['a', 'b', 'c', 'd']\n      deepEqual set.remove('b'), ['b']\n      deepEqual results, ['a', 'c', 'd']\n\n## has(item) : Boolean\n\n`has` returns a boolean describing if the given `item` is a member of the set.\n\n_Note_: Using `has(item)` in an accessor body will register the set `has` is called upon as a source of the property being calculated. This so that whenever the set changes, the property will be recalculated, because the set may now have or not have the item in question.\n\n    test 'Set::has indicates if an item is a member of the set or not.', ->\n      set = new Batman.Set('a', 'b', 'c')\n      ok set.has('a')\n      equal set.has('d'), false\n\n    test 'Set::has registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @awards = new Batman.Set()\n\n        @accessor 'bestEver?', -> @get('awards').has('Stanley Cup')\n\n      result = null\n      team = new Team\n      team.observeAndFire 'bestEver?', (status) -> result = status\n      team.get('awards').add 'Eastern Conference Champs'\n      equal result, false\n      team.get('awards').add 'Stanley Cup'\n      equal result, true\n\n## add(items...)\n\n`add` adds 0 or more new items to the set. `add` returns an array of the items which have been newly added to the set, which is to say the intersection of the argument items and the set's complement before addition.\n\n`add` fires the `itemsWereAdded` event with the list of items newly added to the set if that list has length greater than 0. This is to say the event will not be fired if the items passed to add were all already members of the set.\n\n    test 'Set::add adds an item to the set', ->\n      set = new Batman.Set()\n      equal set.has('a'), false\n      deepEqual set.add('a'), ['a']\n      equal set.has('a'), true\n\n    test 'Set::add returns only the new items that weren\\'t previously in the set', ->\n      set = new Batman.Set('a', 'b')\n      deepEqual set.add('b','c','d').sort(), ['c', 'd']\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd']\n\n    test 'Set::add fires the itemsWereAdded event with the items newly added to the set', ->\n      results = null\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereAdded', (item) -> results = item)\n      set.add('b','c','d')\n      deepEqual results.sort(), ['c','d']\n\n    test 'Set::add does not fire the itemsWereAdded event if the added items were already in the set.', ->\n      results = undefined\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereAdded', (items) -> results = items)\n      set.add('a', 'b')\n      equal typeof results, 'undefined'\n\n## remove(items...)\n\n`remove` removes 0 or more items from the set. `remove` returns an array of the items which were successfully removed from the set, which is to say the intersection of the argument items and the set itself before removal.\n\n`remove` fires the `itemsWereRemoved` event with the list of removed items if that list has length greater than 0. This is to say the event will not be fired if none of the passed items were members of the set.\n\n    test 'Set::remove removes an item from the set', ->\n      set = new Batman.Set('a')\n      equal set.has('a'), true\n      deepEqual set.remove('a'), ['a']\n      equal set.has('a'), false\n\n    test 'Set::remove returns only the new items that were previously in the set', ->\n      set = new Batman.Set('a', 'b')\n      deepEqual set.remove('b','c','d').sort(), ['b']\n      deepEqual set.toArray(), ['a']\n\n    test 'Set::remove fires the itemsWereRemoved event with the items removed to the set', ->\n      results = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('b','c')\n      deepEqual results.sort(), ['b','c']\n\n    test 'Set::remove does not fire the itemsWereRemoved event if the removed items were not already members of the set.', ->\n      results = undefined\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('c', 'd')\n      equal typeof results, 'undefined'\n\n## find(testFunction : function) : [Object]\n\n`find` returns the first item within the set for which the `testFunction` called with the item returns `true`, or `undefined` if no item passes the test.\n\n_Note_: `find` returns the first item the test passes for, but since set iteration has no specified order, no guarantee can be made about which item will be returned if more than one item in the set passes the test. However, set iteration order is stable, so `find` called on the same set twice should return the same item.\n\n\n    test 'Set::find returns the first item for which the test function passes', ->\n      set = new Batman.Set(1, 2, 3)\n      equal set.find((x) -> x % 2 == 0), 2\n\n    test 'Set::find returns undefined if no items pass the test function', ->\n      set = new Batman.Set(1, 2, 3)\n      equal typeof set.find((x) -> x > 5), 'undefined'\n\n## forEach(iteratorFunction : function[, context: Object])\n\n`forEach` calls the `iteratorFunction` with each item in the set, optionally executing the `iteratorFunction` in the passed context. Returns `undefined`.\n\n_Note_: Set iteration order is not defined, thus Set client code cannot rely on one item being iterated over before another, regardless of when the Set's items were added. If you need an ordered set, Batman provides `SetSort` for exactly this, while including the added benefit of observability. If you need a one time ordering of a set, you can get the array representation with `toArray` and then use vanilla JavaScript `sort` on that array.\n\n_Note_: Using `forEach()` in an accessor body will register the set iterated over as a source of the property being calculated. This so that whenever the set changes, the property will be recalculated. This can become an issue if you iterate over a set and modify the set's items, as when the property recalculates that modification will potentially happen on items it's happened on previously.\n\n    test 'Set::forEach iterates over each item in the set', ->\n      sum = 0\n      set = new Batman.Set(1,2,3)\n      set.forEach (x) -> sum += x\n      equal sum, 6\n\n    test 'Set::forEach iterates over each item in the set optionally in the provided context', ->\n      context = {sum: 0}\n      set = new Batman.Set(1,2,3)\n      set.forEach((x) ->\n        @sum += x\n      , context)\n      equal context.sum, 6\n\n    test 'Set::forEach registers the set as a source if called in an accessor body', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @players = new Batman.Set()\n        @accessor 'willWinTheCup?', ->\n          sedinCount = 0\n          @players.forEach (player) ->\n            sedinCount++ if player.split(' ')[1] == 'Sedin'\n          sedinCount >= 2\n\n      result = null\n      team = new Team()\n      team.observeAndFire 'willWinTheCup?', (status) -> result = status\n      equal team.get('willWinTheCup?'), false\n      team.get('players').add 'Henrik Sedin'\n      equal result, false\n      team.get('players').add 'Daniel Sedin'\n      equal result, true\n\n## isEmpty() : boolean\n\n`isEmpty` returns a boolean: `true` if the set has no items, and `false` if it has any items.\n\n_Note_: Using `isEmpty()` in an accessor body will register the set `isEmpty` is called on as a source of the property being calculated, so that whenever the set changes the property will be recalculated.\n\n    test 'Set::isEmpty returns true if the set has no items', ->\n      set = new Batman.Set()\n      ok set.isEmpty()\n      set.add('a')\n      equal set.isEmpty(), false\n\n    test 'Set::isEmpty registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @games = new Batman.Set()\n        @accessor 'seasonStarted?', -> !@games.isEmpty()\n\n      team = new Team\n      equal team.get('seasonStarted?'), false\n      team.get('games').add({win: true})\n      equal team.get('seasonStarted?'), true\n\n## clear() : Array\n\n`clear` removes all items from a set. Returns an array of all the items in the set.\n\n`clear` will fire the `itemsWereRemoved` event once with all the items in the set.\n\n_Note_: Set iteration order is not defined, so the order of the array of items returned by `clear` is undefined.\n\n    test 'Set::clear empties the set', ->\n      set = new Batman.Set('a', 'b', 'c')\n      equal set.isEmpty(), false\n      deepEqual set.clear().sort(), ['a', 'b', 'c']\n      ok set.isEmpty()\n\n    test 'Set::clear fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.clear()\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## replace(collection : Enumerable) : Array\n\n`replace` removes all the items in a set and then adds all the items found in another `collection`. The other collection must have a `toArray` function which returns an array representation of the collection. Returns the array of items added.\n\n`replace` will fire the `itemsWereRemoved` event once with all the items in the set, and then the `itemsWereAdded` event once with the items from the incoming collection.\n\n    test 'Set::replace empties the set and then adds items from a different collection', ->\n      set = new Batman.Set('a', 'b', 'c')\n      secondSet = new Batman.Set('d', 'e', 'f')\n      set.replace(secondSet)\n      deepEqual set.toArray().sort(), ['d', 'e', 'f']\n\n    test 'Set::replace fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.replace(new Batman.SimpleSet())\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n    test 'Set::replace fires the itemsWereAdded event with all the items in the incoming set', ->\n      result = null\n      set = new Batman.Set()\n      set.on('itemsWereAdded', (items) -> result = items)\n      set.replace(new Batman.SimpleSet('a', 'b', 'c'))\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## toArray() : Array\n\n`toArray` returns an array representation of the set.\n\n_Note_: Set iteration order is not defined, so the order in which the set's items appear in the array is not defined. It is however stable, so the order of the items in two successive `toArray` calls where the set was not modified in between should be the same.\n\n_Note_: `toArray` is also an observable property.\n\n_Note_: Using `toArray()` in an accessor body will register the set `toArray` is called on as a source of the property being calculated, so that whenever the set changes the property will be recalculated.\n\n    test 'Set::toArray returns an array representation of the set', ->\n      set = new Batman.Set()\n      deepEqual set.toArray(), []\n      set.add('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n## merge(collections... : Enumerable) : Set\n\n`merge` adds all the items in a set and all the items in the passed `collections` to a new set and returns it. A `collection` is an object which has a `forEach` function. `merge` is a non-destructive collection union, so the set `merge` is called on and each `collection` passed to `merge` are unaffected by the call.\n\n_Note_: Be careful about using `merge` within accessors. Calling `merge` in an accessor function body will register the set `merge` is called upon as a source of the property being calculated, which means when the set changes, that accessor will be recalculated. This means the O(n * m) merge will occur again each time, and return an entirely new `Set` instance. If the previously returned `Set` instance is retained after recalculation, this is a big memory leak. Instead of merging in accessors, try to use a `SetUnion` or a `SetIntersection`.\n\n    test 'Set::merge returns a new set with the items of the original set and the passed set', ->\n      abc = new Batman.Set('a', 'b', 'c')\n      def = new Batman.Set('d', 'e', 'f')\n      equal Batman.typeOf(set = abc.merge(def)), 'Object'\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd', 'e', 'f']\n\n## indexedBy(key : String) : SetIndex\n\n`indexedBy` returns a hash of sets which buckets all the items in the callee set by the value of a particular `key`. The value of the passed `key` is `get`ted from each object in the set, and then a hash of each value to a set of the items with that value at the `key` is built. This hash of sets is a smart object called a `SetIndex` which will continue to observe the set and the value of the `key` on each item in the set to ensure the set index remains up to date. `SetIndex` also has a friend named `UniqueSetIndex` which will give you a hash of items instead of a hash of sets with items for easy access if you know each item's value at the `key` is unique.\n\n    test 'Set::indexedBy returns a new SetIndex with the items bucketed by the value of the key', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'), Batman(colour: 'blue'))\n      index = set.indexedBy('colour')\n      ok index.get('blue') instanceof Batman.Set\n      equal index.get('blue').get('length'), 2\n      equal index.get('green').get('length'), 1\n\n    test 'Set::indexedBy returns a new SetIndex which observes the set for new additions and stays up to date', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.indexedBy('colour')\n      equal index.get('blue').get('length'), 1\n      newItem = Batman(colour: 'blue')\n      set.add(newItem)\n      equal index.get('blue').get('length'), 2\n      ok index.get('blue').has(newItem)\n      set.remove(newItem)\n      equal index.get('blue').get('length'), 1\n\n    test 'Set::indexedBy returns a new SetIndex which observes the items in the set for changes to the observed key', ->\n      itemA = Batman(colour: 'blue')\n      itemB = Batman(colour: 'green')\n      set = new Batman.Set(itemA, itemB)\n      index = set.indexedBy('colour')\n      equal index.get('blue').get('length'), 1\n      equal index.get('green').get('length'), 1\n      itemA.set('colour', 'green')\n      equal index.get('blue').get('length'), 0\n      equal index.get('green').get('length'), 2\n\n`SetIndex`es can be created by calling the `indexedBy` function on the `Set`, as well as by `get`ting a `key` on the `indexedBy` property.\n\n    test \"Set::get('indexedBy.someKey') returns a new SetIndex for 'someKey'\", ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.get('indexedBy.colour')\n      equal index.get('blue').get('length'), 1\n\n## indexedByUnique(key : String) : UniqueSetIndex\n\n`indexedByUnique` returns a hash of items keyed by the value of the given `key` on each item from the callee set. The value of the passed `key` is `get`ted from each object in the set, and then a hash of each value to an item with that value at the `key` is built. This hash of items is a smart object called a `UniqueSetIndex` which will continue to observe the set and the value of the `key` on each item in the set to ensure the index remains up to date. Note that the semantics for which item ends up in the hash if two items have the same value for the `key` are undefined, so it is wise to only use `UniqueSetIndex`es on keys who's values are going to be unique in the set. If the values are not going to be unique, you may be interested in `SetIndex` and `Set::indexedBy`.\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex with the items hashed by the value of the key', ->\n      greenItem = Batman(colour: 'green')\n      blueItem = Batman(colour: 'blue')\n      set = new Batman.Set(greenItem, blueItem)\n      index = set.indexedByUnique('colour')\n      ok blueItem == index.get('blue')\n      ok greenItem == index.get('green')\n      equal undefined, index.get('red')\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex which observes the set for new additions and stays up to date', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.indexedByUnique('colour')\n      newItem = Batman(colour: 'red')\n      set.add(newItem)\n      ok newItem == index.get('red')\n      set.remove(newItem)\n      equal undefined, index.get('red')\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex which observes the items in the set for changes to the observed key', ->\n      itemA = Batman(colour: 'blue')\n      itemB = Batman(colour: 'green')\n      set = new Batman.Set(itemA, itemB)\n      index = set.indexedByUnique('colour')\n      equal index.get('blue')?, true\n      equal index.get('green')?, true\n      equal index.get('red')?, false\n      itemA.set('colour', 'red')\n      equal index.get('blue')?, false\n      equal index.get('green')?, true\n      equal index.get('red')?, true\n\n`UniqueSetIndex`es can be created by calling the `indexedByUnique` function on the `Set`, as well as by `get`ting a `key` on the `indexedByUnique` property.\n\n    test \"Set::get('indexedByUnique.someKey') returns a new UniqueSetIndex for 'someKey'\", ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.get('indexedByUnique.colour')\n      equal 'blue', index.get('blue').get('colour')\n\n## sortedBy(key: String [, order: String]) : SetSort\n\n`sortedBy` returns a `Set` like object containing all the items of the callee set but with a defined iteration order (unlike `Set`). The iteration order is defined as the alpha numeric sorting of the values of the passed `key` gotten from each item. The direction of the sort can be controlled with the `order` argument, which defaults to `asc` (short for ascending) or can be passed as `desc` (short for descending). This `Set` like object is a `SetSort` which encapsulates the logic to get the values from each item at the passed `key` and traverse the `Set` in the values sorted order.\n\n`SetSort`s are useful for getting a transform of a `Set` which sorted, but also because the sort stays up to date as items are added or removed to the sorted set, or the value at the `key` changes on any of the items in the set.\n\n    test 'Set::sortedBy returns a new SetSort who can be iterated in the sorted order of the value of the key on each item', ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n\n    test 'Set::sortedBy returns a new SetSort which observes the callee set for additions or removals and puts new items in the sorted order', ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n      burke = Batman(place: 1.5, name: 'Burke')\n      set.add(burke)\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Burke', 'Camilo', 'Harry']\n\n    test 'Set::sortedBy returns a new SetSort which observes each item in the callee set for changes to the sort key', ->\n      harry = Batman(place: 2, name: 'Harry')\n      tom = Batman(place: 1, name: 'Tom')\n      set = new Batman.Set(harry, tom)\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Harry']\n      tom.set('place', 3)\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Harry', 'Tom']\n\n`SetSort`s can be created by calling the `sortedBy` function on the `Set`, as well as by `get`ting a `key` on the `sortedBy` property. Note that with this instantiation form you can't pass an order to the `SetSort`.\n\n    test \"Set::get('sortedBy.someKey') returns a new SetSort onn 'someKey'\", ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.get('sortedBy.place')\n      equal 'Harry', sort.get('toArray')[2].get('name')\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e2a7bb81ffda7fc6442f5afc87df69f743695a10","subject":"don't document Set::at","message":"don't document Set::at\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/05_set.litcoffee","new_file":"docs\/05_set.litcoffee","new_contents":"# \/api\/Data Structures\/Batman.Set\n\nA `Batman.Set` is an observable collection of _unique_ items. `Set` extends `Batman.Object` and mixes in much of its implementation from `Batman.SimpleSet`. `Set` also mixes in [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html), which provides [many useful methods](\/docs\/api\/batman.enumerable.html).\n\n### SimpleSet vs Set\n\n`SimpleSet` and `Set` are two distinct classes in batman.js:\n\n- `SimpleSet` implements the basic set semantics, but it is *not* a `Batman.Object`, so it is not observable.\n- `Set` is a `Batman.Object`, so it can be observed, and thus plays nicely with the rest of batman.js.\n\nIf you want an observable object, choose `Batman.Set`. Use a `Batman.SimpleSet` only when you don't need observers. In fact, if you don't need observers, consider using a native array, as iteration and membership checks will be faster!\n\n## ::constructor(items: Array) : Set\n\nReturns a new `Batman.Set` containing `items`.\n\n    test 'new Set constructor can be called without arguments', ->\n      set = new Batman.Set\n      deepEqual set.toArray(), []\n\n    test 'new Set constructor can be passed an Array of items to add to the set.', ->\n      set = new Batman.Set(['a', 'b', 'c'])\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n## ::%length : Number\n\nNumber of items in the `Set`. Always access it with `get`:\n\n```coffeescript\nmySet.get('length')\n```\n\n## ::has(item) : Boolean\n\nReturns true if `item` is in the `Set`.\n\n_Note_: Using `has(item)` in an accessor body will register base `Set` as a source of the property being calculated. @henever the `Set` changes, the property will be recalculated.\n\n    test 'Set::has indicates if an item is a member of the set or not.', ->\n      set = new Batman.Set(['a', 'b', 'c'])\n      ok set.has('a')\n      equal set.has('d'), false\n\n    test 'Set::has registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @awards = new Batman.Set()\n\n        @accessor 'bestEver?', -> @get('awards').has('Stanley Cup')\n\n      result = null\n      team = new Team\n      team.observeAndFire 'bestEver?', (status) -> result = status\n      team.get('awards').add 'Eastern Conference Champs'\n      equal result, false\n      team.get('awards').add 'Stanley Cup'\n      equal result, true\n\n## ::add(items...) : Array\n\nAdds any `items` to the `Set` that aren't already in the `Set`. Returns `items` which were _actually added_. (If an item was already in the `Set`, it won't be returned).\n\nIf any items are added, `add` also fires the `itemsWereAdded` event with an array of added items.\n\n    test 'Set::add adds an item to the set', ->\n      set = new Batman.Set()\n      equal set.has('a'), false\n      deepEqual set.add('a'), ['a']\n      equal set.has('a'), true\n\n    test 'Set::add returns only the new items that weren\\'t previously in the set', ->\n      set = new Batman.Set(['a', 'b'])\n      deepEqual set.add('b','c','d').sort(), ['c', 'd']\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd']\n\n    test 'Set::add fires the itemsWereAdded event with the items newly added to the set', ->\n      results = null\n      set = new Batman.Set(['a', 'b'])\n      set.on('itemsWereAdded', (item) -> results = item)\n      set.add('b','c','d')\n      deepEqual results.sort(), ['c','d']\n\n    test 'Set::add does not fire the itemsWereAdded event if the added items were already in the set.', ->\n      results = undefined\n      set = new Batman.Set(['a', 'b'])\n      set.on('itemsWereAdded', (items) -> results = items)\n      set.add('a', 'b')\n      equal typeof results, 'undefined'\n\n## ::addArray(items: Array) : Array\n\nJust like `Batman.Set::add`, but takes an array of items.\n\n## ::remove(items...) : Array\n\nRemoves `items` from the `Set` if they are present. Returns any items _actually removed_ from the `Set`. (If any of `items` weren't in the `Set`, they won't be returned.)\n\nIf any items were removed, the `Set` fires the `itemsWereRemoved` event with an array of removed items.\n\n    test 'Set::remove removes an item from the set', ->\n      set = new Batman.Set(['a'])\n      equal set.has('a'), true\n      deepEqual set.remove('a'), ['a']\n      equal set.has('a'), false\n\n    test 'Set::remove returns only the new items that were previously in the set', ->\n      set = new Batman.Set(['a', 'b'])\n      deepEqual set.remove('b','c','d').sort(), ['b']\n      deepEqual set.toArray(), ['a']\n\n    test 'Set::remove fires the itemsWereRemoved event with the items removed to the set', ->\n      results = null\n      set = new Batman.Set(['a', 'b', 'c'])\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('b','c')\n      deepEqual results.sort(), ['b','c']\n\n    test 'Set::remove does not fire the itemsWereRemoved event if the removed items were not already members of the set.', ->\n      results = undefined\n      set = new Batman.Set(['a', 'b'])\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('c', 'd')\n      equal typeof results, 'undefined'\n\n## ::removeArray(items: Array) : Array\n\nJust like `Batman.Set::remove`, but takes an array of items.\n\n## ::find(testFunction : Function) : Object\n\nReturns the first item for which `testFunction` returns a truthy value. It returns `undefined` if no item returns a truthy value.\n\n_Note_: `find` returns the _first_ matching item, but a `Set` does not have a specified order. If two items would pass `testFunction`, either one may be returned.\n\n    test 'Set::find returns the first item for which the test function passes', ->\n      set = new Batman.Set([1, 2, 3])\n      equal set.find((x) -> x % 2 == 0), 2\n\n    test 'Set::find returns undefined if no items pass the test function', ->\n      set = new Batman.Set([1, 2, 3])\n      equal typeof set.find((x) -> x > 5), 'undefined'\n\n## ::forEach(iteratorFunction : Function[, context: Object]) : undefined\n\nCalls `iteratorFunction` for each item in the set, passing the item as the first argument. If `context` is passed, it will be `@` inside `iteratorFuction`.\n\n_Note_: `Set::forEach` is not ordered. Consider `Batman.SetSort` if you need sorted iteration.\n\n_Note_: `Set::forEach` registers the `Set` as a source of the property being calculated. Whenever the `Set` changes, the property will be recalculated. If you modify members of `Set` inside an accessor function, you may trigger unexpected loops.\n\n    test 'Set::forEach iterates over each item in the set', ->\n      sum = 0\n      set = new Batman.Set([1,2,3])\n      set.forEach (x) -> sum += x\n      equal sum, 6\n\n    test 'Set::forEach iterates over each item in the set optionally in the provided context', ->\n      context = {sum: 0}\n      set = new Batman.Set([1,2,3])\n      set.forEach((x) ->\n        @sum += x\n      , context)\n      equal context.sum, 6\n\n    test 'Set::forEach registers the set as a source if called in an accessor body', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @players = new Batman.Set()\n        @accessor 'willWinTheCup?', ->\n          sedinCount = 0\n          @players.forEach (player) ->\n            sedinCount++ if player.split(' ')[1] == 'Sedin'\n          sedinCount >= 2\n\n      result = null\n      team = new Team()\n      team.observeAndFire 'willWinTheCup?', (status) -> result = status\n      equal team.get('willWinTheCup?'), false\n      team.get('players').add 'Henrik Sedin'\n      equal result, false\n      team.get('players').add 'Daniel Sedin'\n      equal result, true\n\n## ::isEmpty() : Boolean\n\nReturns `true` if the `Set` has no members.\n\n_Note_: Using `Set::isEmpty` in an accessor body will register `isEmpty` as a source of the property being calculated, so that whenever the `Set` changes, the property will be recalculated.\n\n    test 'Set::isEmpty returns true if the set has no items', ->\n      set = new Batman.Set()\n      ok set.isEmpty()\n      set.add('a')\n      equal set.isEmpty(), false\n\n    test 'Set::isEmpty registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @games = new Batman.Set()\n        @accessor 'seasonStarted?', -> !@games.isEmpty()\n\n      team = new Team\n      equal team.get('seasonStarted?'), false\n      team.get('games').add({win: true})\n      equal team.get('seasonStarted?'), true\n\n## ::%isEmpty : Boolean\n\nAccessor for `Set::isEmpty`.\n\n## ::clear() : Array\n\nRemoves all items from the `Set`, returning an array of all removed items. If any items were removed, the `Set`   will fire the `itemsWereRemoved` event with an array of removed items.\n\n_Note_: Set order is not defined, so the array of removed items is unordered.\n\n    test 'Set::clear empties the set', ->\n      set = new Batman.Set(['a', 'b', 'c'])\n      equal set.isEmpty(), false\n      deepEqual set.clear().sort(), ['a', 'b', 'c']\n      ok set.isEmpty()\n\n    test 'Set::clear fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set(['a', 'b', 'c'])\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.clear()\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## ::replace(collection : Enumerable) : Array\n\nRemoves all items from `Set`, then adds all the items found in `collection`. The `collection` must have a `toArray` function which returns an array representation of the collection. Returns the array of items added.\n\n`replace` will fire the `itemsWereRemoved` event once with all the items in the set, and then the `itemsWereAdded` event once with the items from the incoming collection.\n\n    test 'Set::replace empties the set and then adds items from a different collection', ->\n      set = new Batman.Set(['a', 'b', 'c'])\n      secondSet = new Batman.Set(['d', 'e', 'f'])\n      set.replace(secondSet)\n      deepEqual set.toArray().sort(), ['d', 'e', 'f']\n\n    test 'Set::replace fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set(['a', 'b', 'c'])\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.replace(new Batman.SimpleSet())\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n    test 'Set::replace fires the itemsWereAdded event with all the items in the incoming set', ->\n      result = null\n      set = new Batman.Set()\n      set.on('itemsWereAdded', (items) -> result = items)\n      set.replace(new Batman.SimpleSet(['a', 'b', 'c']))\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## ::toArray() : Array\n\nReturns an _unordered_ array of the `Set`'s  members.\n\n_Note_: Using `Set::toArray` in an accessor will register the `Set` as a source of the property being calculated, so that whenever the `Set` changes, the property will be recalculated.\n\n    test 'Set::toArray returns an array representation of the set', ->\n      set = new Batman.Set()\n      deepEqual set.toArray(), []\n      set.add('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n\n## ::%toArray : Array\n\nAccessor for `Set::toArray`. Whenever items are added or removed on the set, the `toArray` property will change. This is the mechanism by which batman.js's view bindings get notified of collection updates.\n\n    test 'observers on the toArray property fire when the set changes', ->\n      results = null\n      set = new Batman.Set(['a', 'b', 'c'])\n      set.observe('toArray', (newArray) -> results = newArray.sort())\n      deepEqual set.add('d'), ['d']\n      deepEqual results, ['a', 'b', 'c', 'd']\n      deepEqual set.remove('b'), ['b']\n      deepEqual results, ['a', 'c', 'd']\n\n## ::merge(collections... : Enumerable) : Set\n\nCombines the `Set` and `collections` into a new `Set` and returns it. `collection` must implement `forEach`.\n\n`Set::merge` is non-destructive: the `Set` won't be affected.\n\n_Note_: Be careful about using `merge` within accessors. It registers the `Set` as a source, meaning the O(n * m) merge will occur again each time, and return an entirely new `Set` instance. If the previously returned `Set` instance is retained after recalculation, this is a __big memory leak__. Instead of merging in accessors, try to use a `Batman.SetUnion` or a `Batman.SetIntersection`.\n\n    test 'Set::merge returns a new set with the items of the original set and the passed set', ->\n      abc = new Batman.Set(['a', 'b', 'c'])\n      def = new Batman.Set(['d', 'e', 'f'])\n      equal Batman.typeOf(set = abc.merge(def)), 'Object'\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd', 'e', 'f']\n\n## ::indexedBy(key : String) : SetIndex\n\nReturns a `Batman.SetIndex` based on the `Set`, grouping by `key`. This is batman.js's way of grouping `Set`s. See the `Batman.SetIndex` documentation for more information about using `Batman.SetIndex`es.\n\nThe `Batman.SetIndex` tracks the `Set` and its members (in case their value for `key` changes).\n\n    test 'Set::indexedBy returns a new SetIndex with the items bucketed by the value of the key', ->\n      set = new Batman.Set([Batman(colour: 'blue'), Batman(colour: 'green'), Batman(colour: 'blue')])\n      index = set.indexedBy('colour')\n      ok index.get('blue') instanceof Batman.Set\n      equal index.get('blue').get('length'), 2\n      equal index.get('green').get('length'), 1\n\n\n## ::%indexedBy\n\nAccessor for `Set::indexedBy`. `mySet.get('indexedBy.myKey')` returns the same result as  `mySet.indexedBy('myKey')`. This is convenient in view bindings:\n\n\n```html\n<ul>\n  <li data-foreach-colorgroup='collection.indexedBy.color'>\n    <!-- colorgroup is a SetIndex for collection, by color -->\n  <\/li>\n<\/ul>\n```\n\n    test \"Set::get('indexedBy.someKey') returns a new SetIndex for 'someKey'\", ->\n      set = new Batman.Set([Batman(colour: 'blue'), Batman(colour: 'green')])\n      index = set.get('indexedBy.colour')\n      equal index.get('blue').get('length'), 1\n\n## ::indexedByUnique(key : String) : UniqueSetIndex\n\nReturns a `Batman.UniqueSetIndex` based on `Set`, indexed by `key`. See the `Batman.UniqueSetIndex` documentation for more information.\n\nThe `Batman.UniqueSetIndex` tracks the `Set` and its members (in case their value for `key` changes).\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex with the items hashed by the value of the key', ->\n      greenItem = Batman(colour: 'green')\n      blueItem = Batman(colour: 'blue')\n      set = new Batman.Set([greenItem, blueItem])\n      index = set.indexedByUnique('colour')\n      ok blueItem == index.get('blue')\n      ok greenItem == index.get('green')\n      equal undefined, index.get('red')\n\n## ::%indexedByUnique\n\nAccessor for `Set::indexedByUnique`. `mySet.get('indexedByUnique.myUniqueKey')` returns the same result as  `mySet.indexedByUnique('myUniqueKey')`.\n\n    test \"Set::get('indexedByUnique.someKey') returns a new UniqueSetIndex for 'someKey'\", ->\n      set = new Batman.Set([Batman(colour: 'blue'), Batman(colour: 'green')])\n      index = set.get('indexedByUnique.colour')\n      equal 'blue', index.get('blue').get('colour')\n\n## ::sortedBy(key: String, order=\"asc\") : SetSort\n\nReturns a `Batman.SetSort` based on the `Set`, sorted by `key` in `order`. This is batman.js's way of sorting `Batman.Set`s. See the `Batman.SetSort` documentation for more information.\n\n`order` may be `\"asc\"` or `\"desc\"`.\n\nThe `Batman.SetSort` tracks the `Set` and its members (in case their value for `key` changes).\n\n    test 'Set::sortedBy returns a new SetSort who can be iterated in the sorted order of the value of the key on each item', ->\n      set = new Batman.Set([Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo')])\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n\n## ::%sortedBy\n\nAccessor for `Set::sortedBy`. `mySet.get('sortedBy.myKey')` returns the same result as  `mySet.sortedBy('myKey')`.  This is very convenient in view bindings:\n\n```html\n<h1> Rankings: <\/h1>\n<ul>\n  <li data-foreach-player='players.sortedBy.rank'>\n    <!-- players are rendered in order -->\n  <li>\n<\/ul>\n```\n\n    test \"Set::get('sortedBy.someKey') returns a new SetSort on 'someKey'\", ->\n      set = new Batman.Set([Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo')])\n\n      sort = set.get('sortedBy.place')\n      equal 'Harry', sort.get('toArray')[2].get('name')\n\n## ::%sortedByDescending\n\nLike `Set::%sortedBy`, but returns a descending `Batman.SetSort`. `mySet.get('sortedByDescending.myKey')` returns the same result as  `mySet.sortedBy('myKey', \"desc\")`.\n\n## ::mappedTo(key : String) : SetMapping\n\nReturns a `Batman.SetMapping` on the `Set`, for values of `key`. A `Batman.SetMapping` is an observable `map` result. See the documentation for `Batman.SetMapping` for more information.\n\n    test 'Set::mappedTo(key) returns SetMapping on `key`', ->\n      set = new Batman.Set([\n        Batman(place: 3, name: 'Harry'),\n        Batman(place: 1, name: 'Tom'),\n        Batman(place: 2, name: 'Camilo')\n      ])\n      mapping = set.mappedTo('place')\n      deepEqual mapping.toArray(), [3,1,2]\n\n## ::%mappedTo\n\nAccessor for `Set::mappedTo`. `mySet.get('mappedTo.myKey')` returns the same result as  `mySet.mappedTo('myKey')`.\n\n    test 'set.get(\"mappedTo.key\") returns SetMapping on `key`', ->\n      set = new Batman.Set([\n        Batman(place: 3, name: 'Harry'),\n        Batman(place: 1, name: 'Tom'),\n        Batman(place: 2, name: 'Camilo')\n      ])\n      mapping = set.get('mappedTo.place')\n      deepEqual mapping.toArray(), [3,1,2]\n","old_contents":"# \/api\/Data Structures\/Batman.Set\n\nA `Batman.Set` is an observable collection of _unique_ items. `Set` extends `Batman.Object` and mixes in much of its implementation from `Batman.SimpleSet`. `Set` also mixes in [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html), which provides [many useful methods](\/docs\/api\/batman.enumerable.html).\n\n### SimpleSet vs Set\n\n`SimpleSet` and `Set` are two distinct classes in batman.js:\n\n- `SimpleSet` implements the basic set semantics, but it is *not* a `Batman.Object`, so it is not observable.\n- `Set` is a `Batman.Object`, so it can be observed, and thus plays nicely with the rest of batman.js.\n\nIf you want an observable object, choose `Batman.Set`. Use a `Batman.SimpleSet` only when you don't need observers. In fact, if you don't need observers, consider using a native array, as iteration and membership checks will be faster!\n\n## ::constructor(items: Array) : Set\n\nReturns a new `Batman.Set` containing `items`.\n\n    test 'new Set constructor can be called without arguments', ->\n      set = new Batman.Set\n      deepEqual set.toArray(), []\n\n    test 'new Set constructor can be passed an Array of items to add to the set.', ->\n      set = new Batman.Set(['a', 'b', 'c'])\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n## ::%length : Number\n\nNumber of items in the `Set`. Always access it with `get`:\n\n```coffeescript\nmySet.get('length')\n```\n\n## ::has(item) : Boolean\n\nReturns true if `item` is in the `Set`.\n\n_Note_: Using `has(item)` in an accessor body will register base `Set` as a source of the property being calculated. @henever the `Set` changes, the property will be recalculated.\n\n    test 'Set::has indicates if an item is a member of the set or not.', ->\n      set = new Batman.Set(['a', 'b', 'c'])\n      ok set.has('a')\n      equal set.has('d'), false\n\n    test 'Set::has registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @awards = new Batman.Set()\n\n        @accessor 'bestEver?', -> @get('awards').has('Stanley Cup')\n\n      result = null\n      team = new Team\n      team.observeAndFire 'bestEver?', (status) -> result = status\n      team.get('awards').add 'Eastern Conference Champs'\n      equal result, false\n      team.get('awards').add 'Stanley Cup'\n      equal result, true\n\n## ::add(items...) : Array\n\nAdds any `items` to the `Set` that aren't already in the `Set`. Returns `items` which were _actually added_. (If an item was already in the `Set`, it won't be returned).\n\nIf any items are added, `add` also fires the `itemsWereAdded` event with an array of added items.\n\n    test 'Set::add adds an item to the set', ->\n      set = new Batman.Set()\n      equal set.has('a'), false\n      deepEqual set.add('a'), ['a']\n      equal set.has('a'), true\n\n    test 'Set::add returns only the new items that weren\\'t previously in the set', ->\n      set = new Batman.Set(['a', 'b'])\n      deepEqual set.add('b','c','d').sort(), ['c', 'd']\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd']\n\n    test 'Set::add fires the itemsWereAdded event with the items newly added to the set', ->\n      results = null\n      set = new Batman.Set(['a', 'b'])\n      set.on('itemsWereAdded', (item) -> results = item)\n      set.add('b','c','d')\n      deepEqual results.sort(), ['c','d']\n\n    test 'Set::add does not fire the itemsWereAdded event if the added items were already in the set.', ->\n      results = undefined\n      set = new Batman.Set(['a', 'b'])\n      set.on('itemsWereAdded', (items) -> results = items)\n      set.add('a', 'b')\n      equal typeof results, 'undefined'\n\n## ::addArray(items: Array) : Array\n\nJust like `Batman.Set::add`, but takes an array of items.\n\n## ::remove(items...) : Array\n\nRemoves `items` from the `Set` if they are present. Returns any items _actually removed_ from the `Set`. (If any of `items` weren't in the `Set`, they won't be returned.)\n\nIf any items were removed, the `Set` fires the `itemsWereRemoved` event with an array of removed items.\n\n    test 'Set::remove removes an item from the set', ->\n      set = new Batman.Set(['a'])\n      equal set.has('a'), true\n      deepEqual set.remove('a'), ['a']\n      equal set.has('a'), false\n\n    test 'Set::remove returns only the new items that were previously in the set', ->\n      set = new Batman.Set(['a', 'b'])\n      deepEqual set.remove('b','c','d').sort(), ['b']\n      deepEqual set.toArray(), ['a']\n\n    test 'Set::remove fires the itemsWereRemoved event with the items removed to the set', ->\n      results = null\n      set = new Batman.Set(['a', 'b', 'c'])\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('b','c')\n      deepEqual results.sort(), ['b','c']\n\n    test 'Set::remove does not fire the itemsWereRemoved event if the removed items were not already members of the set.', ->\n      results = undefined\n      set = new Batman.Set(['a', 'b'])\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('c', 'd')\n      equal typeof results, 'undefined'\n\n## ::removeArray(items: Array) : Array\n\nJust like `Batman.Set::remove`, but takes an array of items.\n\n## ::find(testFunction : Function) : Object\n\nReturns the first item for which `testFunction` returns a truthy value. It returns `undefined` if no item returns a truthy value.\n\n_Note_: `find` returns the _first_ matching item, but a `Set` does not have a specified order. If two items would pass `testFunction`, either one may be returned.\n\n    test 'Set::find returns the first item for which the test function passes', ->\n      set = new Batman.Set([1, 2, 3])\n      equal set.find((x) -> x % 2 == 0), 2\n\n    test 'Set::find returns undefined if no items pass the test function', ->\n      set = new Batman.Set([1, 2, 3])\n      equal typeof set.find((x) -> x > 5), 'undefined'\n\n## ::forEach(iteratorFunction : Function[, context: Object]) : undefined\n\nCalls `iteratorFunction` for each item in the set, passing the item as the first argument. If `context` is passed, it will be `@` inside `iteratorFuction`.\n\n_Note_: `Set::forEach` is not ordered. Consider `Batman.SetSort` if you need sorted iteration.\n\n_Note_: `Set::forEach` registers the `Set` as a source of the property being calculated. Whenever the `Set` changes, the property will be recalculated. If you modify members of `Set` inside an accessor function, you may trigger unexpected loops.\n\n    test 'Set::forEach iterates over each item in the set', ->\n      sum = 0\n      set = new Batman.Set([1,2,3])\n      set.forEach (x) -> sum += x\n      equal sum, 6\n\n    test 'Set::forEach iterates over each item in the set optionally in the provided context', ->\n      context = {sum: 0}\n      set = new Batman.Set([1,2,3])\n      set.forEach((x) ->\n        @sum += x\n      , context)\n      equal context.sum, 6\n\n    test 'Set::forEach registers the set as a source if called in an accessor body', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @players = new Batman.Set()\n        @accessor 'willWinTheCup?', ->\n          sedinCount = 0\n          @players.forEach (player) ->\n            sedinCount++ if player.split(' ')[1] == 'Sedin'\n          sedinCount >= 2\n\n      result = null\n      team = new Team()\n      team.observeAndFire 'willWinTheCup?', (status) -> result = status\n      equal team.get('willWinTheCup?'), false\n      team.get('players').add 'Henrik Sedin'\n      equal result, false\n      team.get('players').add 'Daniel Sedin'\n      equal result, true\n\n## ::isEmpty() : Boolean\n\nReturns `true` if the `Set` has no members.\n\n_Note_: Using `Set::isEmpty` in an accessor body will register `isEmpty` as a source of the property being calculated, so that whenever the `Set` changes, the property will be recalculated.\n\n    test 'Set::isEmpty returns true if the set has no items', ->\n      set = new Batman.Set()\n      ok set.isEmpty()\n      set.add('a')\n      equal set.isEmpty(), false\n\n    test 'Set::isEmpty registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @games = new Batman.Set()\n        @accessor 'seasonStarted?', -> !@games.isEmpty()\n\n      team = new Team\n      equal team.get('seasonStarted?'), false\n      team.get('games').add({win: true})\n      equal team.get('seasonStarted?'), true\n\n## ::%isEmpty : Boolean\n\nAccessor for `Set::isEmpty`.\n\n## ::clear() : Array\n\nRemoves all items from the `Set`, returning an array of all removed items. If any items were removed, the `Set`   will fire the `itemsWereRemoved` event with an array of removed items.\n\n_Note_: Set order is not defined, so the array of removed items is unordered.\n\n    test 'Set::clear empties the set', ->\n      set = new Batman.Set(['a', 'b', 'c'])\n      equal set.isEmpty(), false\n      deepEqual set.clear().sort(), ['a', 'b', 'c']\n      ok set.isEmpty()\n\n    test 'Set::clear fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set(['a', 'b', 'c'])\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.clear()\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## ::replace(collection : Enumerable) : Array\n\nRemoves all items from `Set`, then adds all the items found in `collection`. The `collection` must have a `toArray` function which returns an array representation of the collection. Returns the array of items added.\n\n`replace` will fire the `itemsWereRemoved` event once with all the items in the set, and then the `itemsWereAdded` event once with the items from the incoming collection.\n\n    test 'Set::replace empties the set and then adds items from a different collection', ->\n      set = new Batman.Set(['a', 'b', 'c'])\n      secondSet = new Batman.Set(['d', 'e', 'f'])\n      set.replace(secondSet)\n      deepEqual set.toArray().sort(), ['d', 'e', 'f']\n\n    test 'Set::replace fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set(['a', 'b', 'c'])\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.replace(new Batman.SimpleSet())\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n    test 'Set::replace fires the itemsWereAdded event with all the items in the incoming set', ->\n      result = null\n      set = new Batman.Set()\n      set.on('itemsWereAdded', (items) -> result = items)\n      set.replace(new Batman.SimpleSet(['a', 'b', 'c']))\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## ::toArray() : Array\n\nReturns an _unordered_ array of the `Set`'s  members.\n\n_Note_: Using `Set::toArray` in an accessor will register the `Set` as a source of the property being calculated, so that whenever the `Set` changes, the property will be recalculated.\n\n    test 'Set::toArray returns an array representation of the set', ->\n      set = new Batman.Set()\n      deepEqual set.toArray(), []\n      set.add('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n\n## ::%toArray : Array\n\nAccessor for `Set::toArray`. Whenever items are added or removed on the set, the `toArray` property will change. This is the mechanism by which batman.js's view bindings get notified of collection updates.\n\n    test 'observers on the toArray property fire when the set changes', ->\n      results = null\n      set = new Batman.Set(['a', 'b', 'c'])\n      set.observe('toArray', (newArray) -> results = newArray.sort())\n      deepEqual set.add('d'), ['d']\n      deepEqual results, ['a', 'b', 'c', 'd']\n      deepEqual set.remove('b'), ['b']\n      deepEqual results, ['a', 'c', 'd']\n\n## ::merge(collections... : Enumerable) : Set\n\nCombines the `Set` and `collections` into a new `Set` and returns it. `collection` must implement `forEach`.\n\n`Set::merge` is non-destructive: the `Set` won't be affected.\n\n_Note_: Be careful about using `merge` within accessors. It registers the `Set` as a source, meaning the O(n * m) merge will occur again each time, and return an entirely new `Set` instance. If the previously returned `Set` instance is retained after recalculation, this is a __big memory leak__. Instead of merging in accessors, try to use a `Batman.SetUnion` or a `Batman.SetIntersection`.\n\n    test 'Set::merge returns a new set with the items of the original set and the passed set', ->\n      abc = new Batman.Set(['a', 'b', 'c'])\n      def = new Batman.Set(['d', 'e', 'f'])\n      equal Batman.typeOf(set = abc.merge(def)), 'Object'\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd', 'e', 'f']\n\n## ::indexedBy(key : String) : SetIndex\n\nReturns a `Batman.SetIndex` based on the `Set`, grouping by `key`. This is batman.js's way of grouping `Set`s. See the `Batman.SetIndex` documentation for more information about using `Batman.SetIndex`es.\n\nThe `Batman.SetIndex` tracks the `Set` and its members (in case their value for `key` changes).\n\n    test 'Set::indexedBy returns a new SetIndex with the items bucketed by the value of the key', ->\n      set = new Batman.Set([Batman(colour: 'blue'), Batman(colour: 'green'), Batman(colour: 'blue')])\n      index = set.indexedBy('colour')\n      ok index.get('blue') instanceof Batman.Set\n      equal index.get('blue').get('length'), 2\n      equal index.get('green').get('length'), 1\n\n\n## ::%indexedBy\n\nAccessor for `Set::indexedBy`. `mySet.get('indexedBy.myKey')` returns the same result as  `mySet.indexedBy('myKey')`. This is convenient in view bindings:\n\n\n```html\n<ul>\n  <li data-foreach-colorgroup='collection.indexedBy.color'>\n    <!-- colorgroup is a SetIndex for collection, by color -->\n  <\/li>\n<\/ul>\n```\n\n    test \"Set::get('indexedBy.someKey') returns a new SetIndex for 'someKey'\", ->\n      set = new Batman.Set([Batman(colour: 'blue'), Batman(colour: 'green')])\n      index = set.get('indexedBy.colour')\n      equal index.get('blue').get('length'), 1\n\n## ::indexedByUnique(key : String) : UniqueSetIndex\n\nReturns a `Batman.UniqueSetIndex` based on `Set`, indexed by `key`. See the `Batman.UniqueSetIndex` documentation for more information.\n\nThe `Batman.UniqueSetIndex` tracks the `Set` and its members (in case their value for `key` changes).\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex with the items hashed by the value of the key', ->\n      greenItem = Batman(colour: 'green')\n      blueItem = Batman(colour: 'blue')\n      set = new Batman.Set([greenItem, blueItem])\n      index = set.indexedByUnique('colour')\n      ok blueItem == index.get('blue')\n      ok greenItem == index.get('green')\n      equal undefined, index.get('red')\n\n## ::%indexedByUnique\n\nAccessor for `Set::indexedByUnique`. `mySet.get('indexedByUnique.myUniqueKey')` returns the same result as  `mySet.indexedByUnique('myUniqueKey')`.\n\n    test \"Set::get('indexedByUnique.someKey') returns a new UniqueSetIndex for 'someKey'\", ->\n      set = new Batman.Set([Batman(colour: 'blue'), Batman(colour: 'green')])\n      index = set.get('indexedByUnique.colour')\n      equal 'blue', index.get('blue').get('colour')\n\n## ::sortedBy(key: String, order=\"asc\") : SetSort\n\nReturns a `Batman.SetSort` based on the `Set`, sorted by `key` in `order`. This is batman.js's way of sorting `Batman.Set`s. See the `Batman.SetSort` documentation for more information.\n\n`order` may be `\"asc\"` or `\"desc\"`.\n\nThe `Batman.SetSort` tracks the `Set` and its members (in case their value for `key` changes).\n\n    test 'Set::sortedBy returns a new SetSort who can be iterated in the sorted order of the value of the key on each item', ->\n      set = new Batman.Set([Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo')])\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n\n## ::%sortedBy\n\nAccessor for `Set::sortedBy`. `mySet.get('sortedBy.myKey')` returns the same result as  `mySet.sortedBy('myKey')`.  This is very convenient in view bindings:\n\n```html\n<h1> Rankings: <\/h1>\n<ul>\n  <li data-foreach-player='players.sortedBy.rank'>\n    <!-- players are rendered in order -->\n  <li>\n<\/ul>\n```\n\n    test \"Set::get('sortedBy.someKey') returns a new SetSort on 'someKey'\", ->\n      set = new Batman.Set([Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo')])\n\n      sort = set.get('sortedBy.place')\n      equal 'Harry', sort.get('toArray')[2].get('name')\n\n## ::%sortedByDescending\n\nLike `Set::%sortedBy`, but returns a descending `Batman.SetSort`. `mySet.get('sortedByDescending.myKey')` returns the same result as  `mySet.sortedBy('myKey', \"desc\")`.\n\n## ::mappedTo(key : String) : SetMapping\n\nReturns a `Batman.SetMapping` on the `Set`, for values of `key`. A `Batman.SetMapping` is an observable `map` result. See the documentation for `Batman.SetMapping` for more information.\n\n    test 'Set::mappedTo(key) returns SetMapping on `key`', ->\n      set = new Batman.Set([\n        Batman(place: 3, name: 'Harry'),\n        Batman(place: 1, name: 'Tom'),\n        Batman(place: 2, name: 'Camilo')\n      ])\n      mapping = set.mappedTo('place')\n      deepEqual mapping.toArray(), [3,1,2]\n\n## ::%mappedTo\n\nAccessor for `Set::mappedTo`. `mySet.get('mappedTo.myKey')` returns the same result as  `mySet.mappedTo('myKey')`.\n\n    test 'set.get(\"mappedTo.key\") returns SetMapping on `key`', ->\n      set = new Batman.Set([\n        Batman(place: 3, name: 'Harry'),\n        Batman(place: 1, name: 'Tom'),\n        Batman(place: 2, name: 'Camilo')\n      ])\n      mapping = set.get('mappedTo.place')\n      deepEqual mapping.toArray(), [3,1,2]\n\n## ::at(idx)\n\nReturns the item from the `Set` at `idx`. Note that sets have no specified order, so this may return a different value each time.\n\n## ::%at\n\nAn accessor for `::at`. You can use like:\n\n```coffeescript\nmySet.get('at.0')       # => first; OR\nmySet.get('at').get(1)  # => second\n```","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0222800296bf60980efc7dc2260b186ddfce1f22","subject":"Document conditional filter","message":"Document conditional filter\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/02_app_components\/14a_filters.litcoffee","new_file":"docs\/02_app_components\/14a_filters.litcoffee","new_contents":"# \/api\/App Components\/Batman.View\/Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\nBatman.js ships with many built-in view filters:\n\nType | Filters\n---|----\n__Logical Operators__ |  `and`, `or`, `not`, `conditional`\n__Comparison Operators__ | `equals`, `eq`, `neq`, `lt`, `gt`, `lteq`, `gteq`\n__General Utilities__ | `get`, `[]`, `meta`, `default`\n__Number Helpers__ | `ceil`, `floor`, `round`, `precision`, `fixed`, `delimitNumber`, `ordinalize`\n__Set Helpers__ |  `join`, `sort`, `map`, `has`, `first`, `toSentence`\n__String Helpers__ | `interpolate`, `escape`, `capitalize`, `titleize`, `singularize`, `underscore`, `camelize`, `trim`, `raw`, `matches`, `truncate`, `prepend`, `append`, `replace`, `downcase`, `upcase`, `pluralize`, `humanize`\n__Event Helpers__ | `withArguments`, `toggle`, `increment`, `decrement`\n__Debuggers__ | `log`, `logStack`\n\n\n## Custom Filters\n\nYou can define custom filters by setting them on the `Batman.Filters` object. For example, a batman.js view filter that formats a date with [moment.js](http:\/\/momentjs.com):\n\n```coffeescript\n# `moment` is the moment.js object\nBatman.Filters.dateFormat = (date, format) ->\n  moment(date).format(format)\n```\n\nYou can also define custom filters when defining custom views with [`Batman.View.filter`](docs\/api\/batman.view.html#class_function_filter).\n\n## equals(left, right) or eq(left, right): Boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n<span data-showif=\"value | eq 10\"><\/span>\n<span data-showif=\"value | eq true\"><\/span>\n```\n\n__Note__: there is actually _one_ difference between `eq` and `equals`: `equals` rejects undefined values, but `eq` allows them.\n\n## lt(left, right) : Boolean\n\nChecks if left content is `less than` the right content.\n\n```html\n<span data-showif=\"posts.length | lt 10\"><\/span>\n```\n\n## gt(left, right) : Boolean\n\nChecks if left content is `greater than` the right content.\n\n```html\n<span data-showif=\"posts.length | gt 10\"><\/span>\n```\n\n## lteq(left, right) : Boolean\n\nChecks if left content is `less than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | lteq 10\"><\/span>\n```\n\n## gteq(left, right) : Boolean\n\nChecks if left content is `greater than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | gteq 10\"><\/span>\n```\n\n## neq(left, right) : Boolean\n\nChecks if left content is `is NOT equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | neq 10\"><\/span>\n```\n\n## ceil(value) : string\n\nThe `ceil` filter will run `Math.ceil` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | ceil\"><\/span>\n```\n\n## floor(value) : string\n\nThe `floor` filter will run `Math.floor` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | floor\"><\/span>\n```\n\n## round(value) : string\n\nThe `round` filter will run `Math.round` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | round\"><\/span>\n```\n\n## percision(value, toPlace) : string\n\nThe `precision` filter will run `toPrecision()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | precision\"><\/span>\n<span data-bind=\"someValue | precision 3\"><\/span>\n```\n\n## fixed(value, toPlace) : string\n\nThe `fixed` filter will run `toFixed()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | fixed\"><\/span>\n<span data-bind=\"someValue | fixed 3\"><\/span>\n```\n\n## delimitNumber(value) : string\n\nThe `delimitNumber` filter will comma delimit a 'number'. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | delimitNumber\"><\/span>\n```\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## and(inputValue, otherValue) : boolean\n\nReturns `true` if `inputValue` and `otherValue` are truthy:\n\n```html\n<p data-showif='post.published | and currentUser.loggedIn'><\/p>\n```\n\n## or(inputValue, otherValue) : boolean\n\nReturns `true` if either `inputValue` or `otherValue` are truthy:\n\n```html\n<p data-showif='post.published | or currentUser.isAdmin'><\/p>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## conditional(testValue, truthyValue, falsyValue)\n\nReturns either `truthyValue` or `falsyValue` based on the truthiness of `testValue`. For example, to show `\"Create Post\"` for a new `Post` but `\"Edit Post\"` for an already-saved one:\n\n```html\n<input type='submit' data-bind-value='post.isNew | conditional \"Create Post\", \"Edit Post\"'><\/input>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count, includeCount[=true]) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## singularize(string) : string\n\nReturns the singular inflection of `string`.\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## titleize(value) : string\n\nHumanizes `string` and capitalizes each word. For example,\n\n```html\n<span data-bind=\"'about_us_page' | titleize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | titleize\">About Us Page<\/span>\n```\n\n## underscore(string) : string\n\nConverts `string` to underscore case.\n\n## camelize(string, firstLetterLower[=false]) : string\n\nConverts `string` to camel case. if `firstLetterLower` is true, the first letter will be lowercase.\n\n## ordinalize(numberOrString) : string\n\nTurns `numberOrString` into an ordinalized number, for example, `4 | ordinalize` becomes `4th`.\n\n## join(array, separator = '') : string\n\nJoins `array` into a single string with `separator`:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## toSentence(array) : string\n\nJoins `array` with `, ` and ` and`, as appropriate. See [helpers.toSentence](\/docs\/api\/batman.helpers.html#class_function_tosentence).\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\nLooks up `keypath` on `value.meta`. The `value` must have a `meta` property to look up against.\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n\n## toggle(keypath) : function\n\nReturns a handler for toggling `keypath`. Clicking this button will toggle `showMeMore` between `true` and `false`:\n\n```html\n<button data-event-click='showMeMore | toggle'><\/button>\n```\n\n## increment(keypath, change[=1]) : function\n\nReturns a handler that increments `keypath` by `change`. If `keypath` 's value isn't set, it will be treated as 0.\n\n```html\n<button data-event-click='totalScore | increment'>Add 1<\/button>\n```\n\n## decrement(keypath, change[=1]) : function\n\nReturns a handler that decrements `keypath` by `change`. If `keypath` 's value isn't set, it will be treated as 0.\n\n```html\n<button data-event-click='totalScore | decrement 3'>Subtract 3<\/button>\n```\n","old_contents":"# \/api\/App Components\/Batman.View\/Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\nBatman.js ships with many built-in view filters:\n\nType | Filters\n---|----\n__Logical Operators__ |  `and`, `or`, `not`\n__Comparison Operators__ | `equals`, `eq`, `neq`, `lt`, `gt`, `lteq`, `gteq`\n__General Utilities__ | `get`, `[]`, `meta`, `default`\n__Number Helpers__ | `ceil`, `floor`, `round`, `precision`, `fixed`, `delimitNumber`, `ordinalize`\n__Set Helpers__ |  `join`, `sort`, `map`, `has`, `first`, `toSentence`\n__String Helpers__ | `interpolate`, `escape`, `capitalize`, `titleize`, `singularize`, `underscore`, `camelize`, `trim`, `raw`, `matches`, `truncate`, `prepend`, `append`, `replace`, `downcase`, `upcase`, `pluralize`, `humanize`\n__Event Helpers__ | `withArguments`, `toggle`, `increment`, `decrement`\n__Debuggers__ | `log`, `logStack`\n\n\n## Custom Filters\n\nYou can define custom filters by setting them on the `Batman.Filters` object. For example, a batman.js view filter that formats a date with [moment.js](http:\/\/momentjs.com):\n\n```coffeescript\n# `moment` is the moment.js object\nBatman.Filters.dateFormat = (date, format) ->\n  moment(date).format(format)\n```\n\nYou can also define custom filters when defining custom views with [`Batman.View.filter`](docs\/api\/batman.view.html#class_function_filter).\n\n## equals(left, right) or eq(left, right): Boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n<span data-showif=\"value | eq 10\"><\/span>\n<span data-showif=\"value | eq true\"><\/span>\n```\n\n__Note__: there is actually _one_ difference between `eq` and `equals`: `equals` rejects undefined values, but `eq` allows them.\n\n## lt(left, right) : Boolean\n\nChecks if left content is `less than` the right content.\n\n```html\n<span data-showif=\"posts.length | lt 10\"><\/span>\n```\n\n## gt(left, right) : Boolean\n\nChecks if left content is `greater than` the right content.\n\n```html\n<span data-showif=\"posts.length | gt 10\"><\/span>\n```\n\n## lteq(left, right) : Boolean\n\nChecks if left content is `less than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | lteq 10\"><\/span>\n```\n\n## gteq(left, right) : Boolean\n\nChecks if left content is `greater than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | gteq 10\"><\/span>\n```\n\n## neq(left, right) : Boolean\n\nChecks if left content is `is NOT equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | neq 10\"><\/span>\n```\n\n## ceil(value) : string\n\nThe `ceil` filter will run `Math.ceil` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | ceil\"><\/span>\n```\n\n## floor(value) : string\n\nThe `floor` filter will run `Math.floor` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | floor\"><\/span>\n```\n\n## round(value) : string\n\nThe `round` filter will run `Math.round` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | round\"><\/span>\n```\n\n## percision(value, toPlace) : string\n\nThe `precision` filter will run `toPrecision()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | precision\"><\/span>\n<span data-bind=\"someValue | precision 3\"><\/span>\n```\n\n## fixed(value, toPlace) : string\n\nThe `fixed` filter will run `toFixed()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | fixed\"><\/span>\n<span data-bind=\"someValue | fixed 3\"><\/span>\n```\n\n## delimitNumber(value) : string\n\nThe `delimitNumber` filter will comma delimit a 'number'. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | delimitNumber\"><\/span>\n```\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## and(inputValue, otherValue) : boolean\n\nReturns `true` if `inputValue` and `otherValue` are truthy:\n\n```html\n<p data-showif='post.published | and currentUser.loggedIn'><\/p>\n```\n\n## or(inputValue, otherValue) : boolean\n\nReturns `true` if either `inputValue` or `otherValue` are truthy:\n\n```html\n<p data-showif='post.published | or currentUser.isAdmin'><\/p>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count, includeCount[=true]) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## singularize(string) : string\n\nReturns the singular inflection of `string`.\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## titleize(value) : string\n\nHumanizes `string` and capitalizes each word. For example,\n\n```html\n<span data-bind=\"'about_us_page' | titleize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | titleize\">About Us Page<\/span>\n```\n\n## underscore(string) : string\n\nConverts `string` to underscore case.\n\n## camelize(string, firstLetterLower[=false]) : string\n\nConverts `string` to camel case. if `firstLetterLower` is true, the first letter will be lowercase.\n\n## ordinalize(numberOrString) : string\n\nTurns `numberOrString` into an ordinalized number, for example, `4 | ordinalize` becomes `4th`.\n\n## join(array, separator = '') : string\n\nJoins `array` into a single string with `separator`:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## toSentence(array) : string\n\nJoins `array` with `, ` and ` and`, as appropriate. See [helpers.toSentence](\/docs\/api\/batman.helpers.html#class_function_tosentence).\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\nLooks up `keypath` on `value.meta`. The `value` must have a `meta` property to look up against.\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n\n## toggle(keypath) : function \n\nReturns a handler for toggling `keypath`. Clicking this button will toggle `showMeMore` between `true` and `false`:\n\n```html\n<button data-event-click='showMeMore | toggle'><\/button>\n```\n\n## increment(keypath, change[=1]) : function\n\nReturns a handler that increments `keypath` by `change`. If `keypath` 's value isn't set, it will be treated as 0.\n\n```html\n<button data-event-click='totalScore | increment'>Add 1<\/button>\n```\n\n## decrement(keypath, change[=1]) : function\n\nReturns a handler that decrements `keypath` by `change`. If `keypath` 's value isn't set, it will be treated as 0.\n\n```html\n<button data-event-click='totalScore | decrement 3'>Subtract 3<\/button>\n```\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2415cb06310344aafa43544027a3afe2f128300a","subject":"Add note about overwriting ::compare","message":"Add note about overwriting ::compare","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/05a_set_proxies.litcoffee","new_file":"docs\/05a_set_proxies.litcoffee","new_contents":"# \/api\/Data Structures\/Batman.Set\/Batman.SetProxy\n\n`Batman.SetProxy` provides a wrapper around a `Batman.Set` which delegates most methods and accessors to the base `Set`. `SetProxy` extends [`Batman.Object`](\/docs\/api\/batman.object.html) and [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html). To see `Batman.SetProxy` in action, see [`Batman.SetSort`](\/docs\/api\/batman.setsort.html).\n\n## ::constructor(base : Set) SetProxy\n\nReturns a new `SetProxy` tracking `base`.\n\n## Methods delegated to base\n\n- `add`\n- `insert`\n- `insertWithIndexes`\n- `remove`\n- `removeWithIndexes`\n- `at`\n- `find`\n- `clear`\n- `has`\n- `merge`\n- `replace`\n- `filter`\n- `toArray`\n- `isEmpty`\n- `indexedBy`\n- `indexedByUnique`\n- `sortedBy`\n\n## Accessors delegated to base\n\n- `first`\n- `last`\n- `isEmpty`\n- `toArray`\n- `length`\n- `indexedBy`\n- `indexedByUnique`\n- `sortedBy`\n- `sortedByDescending`\n\n\n# \/api\/Data Structures\/Batman.Set\/Batman.SetSort\n\n`Batman.SetSort` is a [`Batman.SetProxy`](\/docs\/api\/batman.setproxy.html) which sorts the members of its `base` by provided `key` and `order`. Through `SetProxy`, `SetSort` extends [`Batman.Object`](\/docs\/api\/batman.object.html) and [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html). `SetSort`s are generally derived from `Set`s. For example:\n\n    test \"SetSorts are sorted proxies of their Sets\", ->\n      batmobile = new Batman.Object(name: \"Batmobile\", wheelCount: 4)\n      batcycle = new Batman.Object(name: \"Batcycle\", wheelCount: 2)\n      vehicles = new Batman.Set(batmobile, batcycle)\n\n      vehiclesByWheelCount1 = new Batman.SetSort(vehicles, 'wheelCount') # order defaults to 'asc'\n      vehiclesByWheelCount2 = vehicles.sortedBy('wheelCount')\n      vehiclesByWheelCount3 = vehicles.get('sortedBy.wheelCount')\n\n      batcopter = new Batman.Object(name: \"Batcopter\", wheelCount: 0)\n      vehicles.add(batcopter)\n\n      for setSort in [vehiclesByWheelCount1, vehiclesByWheelCount2, vehiclesByWheelCount3]\n        deepEqual setSort.mapToProperty('wheelCount'), [0, 2, 4]\n\n\n## ::constructor(base : Set, key : String, order : [\"asc\"|\"desc\", default \"asc\"]) : SetSort\n\nReturns a new `SetSort`, tracking `base` and ordering by `key` in the direction of `order`.\n\n## ::.isSorted[= true]\n\nReturns `true`.\n\n## ::.descending\n\n`true` if `\"desc\"` was passed to as `order` to the constructor, otherwise `false`.\nDescending `SetSort`s may also be made by getting `sortedByDescending` from a `Set`:\n\n    test \"get sortedByDescending creates a descending SetSort\", ->\n      batmobile = new Batman.Object(name: \"Batmobile\", wheelCount: 4)\n      batcycle = new Batman.Object(name: \"Batcycle\", wheelCount: 2)\n      vehicles = new Batman.Set(batmobile, batcycle)\n\n      vehiclesByWheelCountDescending1 = new Batman.SetSort(vehicles, 'wheelCount', 'desc')\n      vehiclesByWheelCountDescending2 = vehicles.get('sortedByDescending.wheelCount')\n\n      for descendingSetSort in [vehiclesByWheelCountDescending1, vehiclesByWheelCountDescending2]\n        equal descendingSetSort.descending, true\n        deepEqual descendingSetSort.mapToProperty('wheelCount'), [4, 2]\n\n## ::find(func : Function)\n\nReturns the first item from the `SetSort` for which `func(item)` returns a truthy value.\n\n## ::forEach(func : Function)\n\nCalls `func(item)` for each item in the `SetSort`.\n\n## ::toArray() : Array\n\nReturns a sorted array representation of the `SetSort`'s contents.\n\n## ::merge(other : Set) : SetSort\n\nReturns a new `SetSort` whose items are the union of this `SetSort` and `other`. It will have the same `key` and `order` as the starting `SetSort`.\n\n## ::compare(a, b) : Number\n\nReturns:\n\n- `-1` if `a` has higher precedence than `b`\n- `0` if `a` and `b` have equal precedence or if precedence can't be determined\n- `1` if `b` has higher precedence than `a`\n\nPrecedence is determined by testing for `undefined`, `null`, `false`, `true`, `NaN`, `a < b` and `a > b`. Please see [the source](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/set\/set_sort.coffee#L91) for implementation details.\n\nSince `::compareElements` delegates to `::compare`, you can acheive custom sorting by overriding `::compare` in a `SetSort` subclass.\n\n## ::compareElements(a, b) : Number\n\nUsed by `SetSort` to compare its elements when sorting. Like `::compare`, it returns `-1`, `0`, or `1`. To arrive at this value, it:\n\n- tries `a.get(@key)` (where `@key` is the `SetSort`s key)\n- if the resulting value is a function, calls `resultingFunction(a)`\n- calls `resultingValue.valueOf()`\n- repeats the process for `b`\n- delegates to `::compare` to compare the resulting values\n- inverts the value if `::.descending`\n\nBy following this process, it provides sort values for `Batman.Object`s `a` and `b` according to `@key`.\n\n\n","old_contents":"# \/api\/Data Structures\/Batman.Set\/Batman.SetProxy\n\n`Batman.SetProxy` provides a wrapper around a `Batman.Set` which delegates most methods and accessors to the base `Set`. `SetProxy` extends [`Batman.Object`](\/docs\/api\/batman.object.html) and [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html). To see `Batman.SetProxy` in action, see [`Batman.SetSort`](\/docs\/api\/batman.setsort.html).\n\n## ::constructor(base : Set) SetProxy\n\nReturns a new `SetProxy` tracking `base`.\n\n## Methods delegated to base\n\n- `add`\n- `insert`\n- `insertWithIndexes`\n- `remove`\n- `removeWithIndexes`\n- `at`\n- `find`\n- `clear`\n- `has`\n- `merge`\n- `replace`\n- `filter`\n- `toArray`\n- `isEmpty`\n- `indexedBy`\n- `indexedByUnique`\n- `sortedBy`\n\n## Accessors delegated to base\n\n- `first`\n- `last`\n- `isEmpty`\n- `toArray`\n- `length`\n- `indexedBy`\n- `indexedByUnique`\n- `sortedBy`\n- `sortedByDescending`\n\n\n# \/api\/Data Structures\/Batman.Set\/Batman.SetSort\n\n`Batman.SetSort` is a [`Batman.SetProxy`](\/docs\/api\/batman.setproxy.html) which sorts the members of its `base` by provided `key` and `order`. Through `SetProxy`, `SetSort` extends [`Batman.Object`](\/docs\/api\/batman.object.html) and [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html). `SetSort`s are generally derived from `Set`s. For example:\n\n    test \"SetSorts are sorted proxies of their Sets\", ->\n      batmobile = new Batman.Object(name: \"Batmobile\", wheelCount: 4)\n      batcycle = new Batman.Object(name: \"Batcycle\", wheelCount: 2)\n      vehicles = new Batman.Set(batmobile, batcycle)\n\n      vehiclesByWheelCount1 = new Batman.SetSort(vehicles, 'wheelCount') # order defaults to 'asc'\n      vehiclesByWheelCount2 = vehicles.sortedBy('wheelCount')\n      vehiclesByWheelCount3 = vehicles.get('sortedBy.wheelCount')\n\n      batcopter = new Batman.Object(name: \"Batcopter\", wheelCount: 0)\n      vehicles.add(batcopter)\n\n      for setSort in [vehiclesByWheelCount1, vehiclesByWheelCount2, vehiclesByWheelCount3]\n        deepEqual setSort.mapToProperty('wheelCount'), [0, 2, 4]\n\n\n## ::constructor(base : Set, key : String, order : [\"asc\"|\"desc\", default \"asc\"]) : SetSort\n\nReturns a new `SetSort`, tracking `base` and ordering by `key` in the direction of `order`.\n\n## ::.isSorted[= true]\n\nReturns `true`.\n\n## ::.descending\n\n`true` if `\"desc\"` was passed to as `order` to the constructor, otherwise `false`.\nDescending `SetSort`s may also be made by getting `sortedByDescending` from a `Set`:\n\n    test \"get sortedByDescending creates a descending SetSort\", ->\n      batmobile = new Batman.Object(name: \"Batmobile\", wheelCount: 4)\n      batcycle = new Batman.Object(name: \"Batcycle\", wheelCount: 2)\n      vehicles = new Batman.Set(batmobile, batcycle)\n\n      vehiclesByWheelCountDescending1 = new Batman.SetSort(vehicles, 'wheelCount', 'desc')\n      vehiclesByWheelCountDescending2 = vehicles.get('sortedByDescending.wheelCount')\n\n      for descendingSetSort in [vehiclesByWheelCountDescending1, vehiclesByWheelCountDescending2]\n        equal descendingSetSort.descending, true\n        deepEqual descendingSetSort.mapToProperty('wheelCount'), [4, 2]\n\n## ::find(func : Function)\n\nReturns the first item from the `SetSort` for which `func(item)` returns a truthy value.\n\n## ::forEach(func : Function)\n\nCalls `func(item)` for each item in the `SetSort`.\n\n## ::toArray() : Array\n\nReturns a sorted array representation of the `SetSort`'s contents.\n\n## ::merge(other : Set) : SetSort\n\nReturns a new `SetSort` whose items are the union of this `SetSort` and `other`. It will have the same `key` and `order` as the starting `SetSort`.\n\n## ::compare(a, b) : Number\n\nReturns:\n\n- `-1` if `a` has higher precedence than `b`\n- `0` if `a` and `b` have equal precedence or if precedence can't be determined\n- `1` if `b` has higher precedence than `a`\n\nPrecedence is determined by testing for `undefined`, `null`, `false`, `true`, `NaN`, `a < b` and `a > b`. Please see [the source](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/set\/set_sort.coffee#L91) for implementation details.\n\n## ::compareElements(a, b) : Number\n\nUsed by `SetSort` to compare its elements when sorting. Like `::compare`, it returns `-1`, `0`, or `1`. To arrive at this value, it:\n\n- tries `a.get(@key)` (where `@key` is the `SetSort`s key)\n- if the resulting value is a function, calls `resultingFunction(a)`\n- calls `resultingValue.valueOf()`\n- repeats the process for `b`\n- delegates to `::compare` to compare the resulting values\n- inverts the value if `::.descending`\n\nBy following this process, it provides sort values for `Batman.Object`s `a` and `b` according to `@key`.\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bbdfb761570475c3be4c0fef082851ce11edeca3","subject":"add notes about association return values and polymorphic 'interface'","message":"add notes about association return values and polymorphic 'interface'\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/02_app_components\/10b_model_association_api.litcoffee","new_file":"docs\/02_app_components\/10b_model_association_api.litcoffee","new_contents":"# \/api\/App Components\/Batman.Model\/Batman.Model Associations\n\nBatman.js associations are modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). There are 3 types of assocations available on `Batman.Model`:\n\n- [`hasMany`](\/docs\/api\/batman.model_associations.html#class_function_hasmany)\n- [`belongsTo`](\/docs\/api\/batman.model_associations.html#class_function_belongsto)\n- [`hasOne`](\/docs\/api\/batman.model_associations.html#class_function_hasone)\n\nBatman.js also supports [polymorphic associations](\/docs\/api\/batman.model_associations.html#polymorphic_associations).\n\n## Declaring Associations\n\nTo declare associations, use class functions in your model definition. Each function accepts a `label` and an `options` object.\n\nFor example, to describe the relationship between `ParentItem` and `ChildItem`:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'child_items', inverseOf: 'parent_item', saveInline: true\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parent_item', inverseOf: 'child_items', autoload: true\n```\n\n## Association Accessors\n\nWhen you declare an association, you also create an accessor for the `label` you pass in the declaration. You can `get` and `set` that `label` to work with the association.\n\nWhen you __`get`__ an association value, it returns a `Batman.AssociationSet` or a `Batman.AssociationProxy`. These objects help manage the association and provide transparent access to the actual records.\n\nIf you __`set`__ an association value, it will return the value which you assigned, not the proxy.\n\nIn the example above, we declared `ChildItem.belongsTo('parent_item')`. That means that you can use the `\"parent_item\"` accessor to get the related record:\n\n```coffeescript\n  child.get('parent_item.name') # => \"Parent 1\"\n  otherParent = new App.ParentItem(name: \"Parent 2\")\n  child.set('parent_item', otherParent)\n```\n\nWe also declared `ParentItem.hasMany('child_items')`, so we can use the `\"child_items\"` accessor to access those records:\n\n```coffeescript\n  parent.get('child_items') # => Batman.AssociationSet\n  parent.get('child_items.length') # => 1\n  # add an item:\n  newChild = new App.ChildItem(parent_item: parent)\n  parent.get('child_items').add(child)\n  parent.get('child_items.length') # => 2\n```\n\n## Specifying Related Classes\n\nBy default, each association converts its `label` to the appropriate class name and looks it up on `Batman.currentApp`. However, you can also specify the class's `name` and `namespace` by passing them as options.\n\nIf your model is defined somewhere other than `MyApp`, you should use the `namespace` option to show batman.js where the model can be found. For example, if your `User` model was defined on a namespace called `Admin`, you would pass that object to any associations that looked for `User`:\n\n```coffeescript\nclass MyApp.Admin.User extends Batman.Model\n  @hasMany 'assignments'\n# ...\nclass MyApp.Assignment extends Batman.Model\n  @belongsTo 'user', namespace: MyApp.Admin\n```\n\nIf you create an association whose name differs from the class name of the related model, you should pass the class name as `name`. For example, if an `Assignment` belongs to an `owner`, which is a `User` record, you can declare it like this:\n\n```coffeescript\nclass MyApp.Assignment extends Batman.Model\n  @belongsTo 'owner', name: \"User\"\n```\n\nNow, batman.js will use `MyApp.User` for the `owner` association.\n\n## Polymorphic Associations\n\nBatman.js also supports [Rails-inspired polymorphic associations](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations). In a polymorphic association, a record may belong to records of _different types_. Instead of specifying a related model, you specify an \"interface\" for the association.\n\nFor example, a `Superpower` may belong to a `Hero` or a `Villain`. The interface is `\"superpowerable\"`:\n\n```coffeescript\nclass App.Superpower extends Batman.Model\n  @encode 'name'\n  @belongsTo 'superpowerable', polymorphic: true\n\nclass App.Hero extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', saveInline: true\n\nclass App.Villain extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', saveInline: true\n```\n\nBy default, attributes of the polymorphic association will be encoded according to the label. So, `hero.toJSON()` might return:\n\n```javascript\n{ id: 1,\n  name: 'Superman',\n  superpowers: [\n    {id: 15, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Super Strength'},\n    {id: 16, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Invincibility'},\n  ]\n}\n```\n\n## Inverse Associations\n\nYou can declare `inverseOf` in you associations to tell batman.js which foreign association to set on load. If the associated model has an association with the same name as the `inverseOf` value, it will be populated when data is loaded from storage. For example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true, inverseOf: 'parentItem'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItems'\n```\n\nwould allow:\n\n```coffeescript\nApp.ParentItem.find 1, (err, parent) ->\n  children = parent.get('childItems')\n  children.get('first.parentItem') == parent # => true\n\nApp.ChildItem.find 5, (err, childItem) ->\n  childItem.get('parentItem').load (err, parent) ->\n    parent.get('childItems').has(childItem) # => true\n```\n\n\n## @hasMany(label : string [, options : Object])\n\n`@hasMany` expresses a one-to-many relationship on a `Batman.Model`.\n\n`get`ting a `@hasMany` accessor returns a `Batman.AssociationSet` (or a `Batman.PolymorphicAssociationSet` of the association is polymorphic).\n\nIt accepts options:\n\nOption | Default | Description\n-- | -- | --\n`name` | singularized, camelized `@label` | The class name for the associatiated model\n`namespace` | `Batman.currentApp` | The object where the class is defined\n`encoderKey` | `@label` | The JSON key for associated records' data\n`saveInline` | `false` | If true, child records will be saved inline with their parent\n`autoload` | `false` | If true, `parent.get(\"children\")` will trigger a load operation with request param `parent_id`.\n`url` |  model's collection URL | The URL where children can be loaded\n`includeInTransaction` | `true` | If false, this association will be skipped when deep-copying the record.\n`inverseOf` | | Names the corresponding relation on the associated model.\n`extend` | `{}` | An object to be mixed into the `Batman.Association` object.\n`primaryKey` | `\"id\"` | The primary key for the parent model\n`foreignKey` | underscored `@model.resourceName` + `\"_id\"`] | The key on child records which contains the parent's primary key value\n`encodeWithIndexes` | `false` | If true, children will be encoded as an Object instead of an Array.\n`replaceFromJSON` | `true` | If false, objects which aren't found when loading JSON will be _left in_ the association set. Use this option if you will paginate through child records.\n`as` | | Denotes a polymorphic association with the given name\n`foreignTypeKey` | `\"#{as}_type\"` | The field where polymorphic children's class names will be stored\n\n`encodeWithIndexes` provides a second option for serializing children wtih `saveInline`. If `ecnodeWithIndexes: true`, `@hasMany` children will be encoded as a JSON object with index keys instead of arrays. For example:\n\n```javascript\n{ id: 1,\n  name: \"As Seen on TV Warehouse\",\n  products: {\n    \"0\": {id: 1, name: \"Orange Glo\"},\n    \"1\": {name: \"Oxyclean\"}\n  }\n}\n```\n\n## @belongsTo(label : string [, options : Object])\n\n`@belongsTo` expresses a one-to-one relationship on a `Batman.Model` when this model contains the foreign key (eg, `parent_id`). If the other model contains the foreign key, use `@hasOne` instead.\n\n`@belongsTo` often expresses inverse of a `@hasMany` or `@hasOne` association. You can declare this with the [`inverseOf` option](\/docs\/api\/batman.model_associations.html#inverse_associations) so that both sides of the association are loaded from JSON.\n\n`get`ting a `@belongsTo` accessor returns a `Batman.BelongsToProxy` (or a `Batman.PolymorphicBelongsToProxy` if the association is polymorphic).\n\nIt accepts options:\n\nOption | Default | Description\n-- | -- | --\n`name` | singularized, camelized `@label` | The class name for the associatiated model\n`namespace` | `Batman.currentApp` | The object where the class is defined\n`encoderKey` | `@label` | The JSON key for associated records' data\n`saveInline` | `false` | If true, child records will be saved inline with their parent\n`autoload` | `false` | If true, `parent.get(\"children\")` will trigger a load operation with request param `parent_id`.\n`nestUrl` | `false` | If true, the associated model will be passed to `@urlNestsUnder`\n`url` |  associated model's URL, with the `foreignKey` value | The URL where the parent can be loaded\n`includeInTransaction` | `true` | If false, this association will be skipped when deep-copying the record.\n`inverseOf` | | Names the corresponding relation on the associated model.\n`extend` | | An object to be mixed into the `Batman.Association` object.\n`primaryKey` | `\"id\"` | The primary key for the parent model\n`foreignKey` | `\"#{@label}_id\"` | The key on child records which contains the parent's primary key value\n`encodeForeignKey` | `true` | If false, the foreign key will be excluded from the record's JSON.\n`polymorphic` | | Denotes the association as polymorphic\n\n## @hasOne(label : string [, options : Object])\n\n`@hasOne` expresses a one-to-one relationship on a `Batman.Model` when this model contains the primary key (eg, `id`) and does not contain the foreign key. If this model contains the foreign key, use `@belongsTo` instead.\n\n`get`ting a `@hasOne` accessor returns a `Batman.HasOneProxy`\n\nIt accepts options:\n\nOption | Default | Description\n-- | -- | --\n`name` | camelized `@label` | The class name for the associatiated model\n`namespace` | `Batman.currentApp` | The object where the class is defined\n`encoderKey` | `@label` | The JSON key for associated records' data\n`saveInline` | `false` | If true, child records will be saved inline with their parent\n`autoload` | `false` | If true, `parent.get(\"child\")` will trigger a load operation with request param `parent_id`.\n`url` |  associated model's URL, with the `primaryKey` value | The UR where the child can be loaded\n`includeInTransaction` | `true` | If false, this association will be skipped when deep-copying the record.\n`inverseOf` | | Names the corresponding relation on the associated model.\n`extend` |  |  An object to be mixed into the `Batman.Association` object.\n`primaryKey` | `\"id\"` | The primary key for the parent model\n`foreignKey` | underscored `@model.resourceName` + `\"_id\"` | The key on the child record which contains the parent's primary key value\n\n","old_contents":"# \/api\/App Components\/Batman.Model\/Batman.Model Associations\n\nBatman.js associations are modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). There are 3 types of assocations available on `Batman.Model`:\n\n- [`hasMany`](\/docs\/api\/batman.model_associations.html#class_function_hasmany)\n- [`belongsTo`](\/docs\/api\/batman.model_associations.html#class_function_belongsto)\n- [`hasOne`](\/docs\/api\/batman.model_associations.html#class_function_hasone)\n\nBatman.js also supports [polymorphic associations](\/docs\/api\/batman.model_associations.html#polymorphic_associations).\n\n## Declaring Associations\n\nTo declare associations, use class functions in your model definition. Each function accepts a `label` and an `options` object.\n\nFor example, to describe the relationship between `ParentItem` and `ChildItem`:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'child_items', inverseOf: 'parent_item', saveInline: true\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parent_item', inverseOf: 'child_items', autoload: true\n```\n\n## Association Accessors\n\nWhen you declare an association, you also create an accessor for the `label` you pass in the declaration. You can `get` and `set` that `label` to work with the association.\n\nWhen you __`get`__ an association value, it returns a `Batman.AssociationSet` or a `Batman.AssociationProxy`. These objects help manage the association and provide transparent access to the actual records.\n\nIf you __`set`__ an association value, it will return the value which you assigned, not the proxy.\n\nIn the example above, we declared `ChildItem.belongsTo('parent_item')`. That means that you can use the `\"parent_item\"` accessor to get the related record:\n\n```coffeescript\n  child.get('parent_item.name') # => \"Parent 1\"\n  otherParent = new App.ParentItem(name: \"Parent 2\")\n  child.set('parent_item', otherParent)\n```\n\nWe also declared `ParentItem.hasMany('child_items')`, so we can use the `\"child_items\"` accessor to access those records:\n\n```coffeescript\n  parent.get('child_items') # => Batman.AssociationSet\n  parent.get('child_items.length') # => 1\n  # add an item:\n  newChild = new App.ChildItem(parent_item: parent)\n  parent.get('child_items').add(child)\n  parent.get('child_items.length') # => 2\n```\n\n## Specifying Related Classes\n\nBy default, each association converts its `label` to the appropriate class name and looks it up on `Batman.currentApp`. However, you can also specify the class's `name` and `namespace` by passing them as options.\n\nIf your model is defined somewhere other than `MyApp`, you should use the `namespace` option to show batman.js where the model can be found. For example, if your `User` model was defined on a namespace called `Admin`, you would pass that object to any associations that looked for `User`:\n\n```coffeescript\nclass MyApp.Admin.User extends Batman.Model\n  @hasMany 'assignments'\n# ...\nclass MyApp.Assignment extends Batman.Model\n  @belongsTo 'user', namespace: MyApp.Admin\n```\n\nIf you create an association whose name differs from the class name of the related model, you should pass the class name as `name`. For example, if an `Assignment` belongs to an `owner`, which is a `User` record, you can declare it like this:\n\n```coffeescript\nclass MyApp.Assignment extends Batman.Model\n  @belongsTo 'owner', name: \"User\"\n```\n\nNow, batman.js will use `MyApp.User` for the `owner` association.\n\n## Polymorphic Associations\n\nBatman.js also supports [Rails-inspired polymorphic associations](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations). In a polymorphic association, a record may belong to records of _different types_.\n\nFor example, a `Superpower` may belong to a `Hero` or a `Villain`:\n\n```coffeescript\nclass App.Superpower extends Batman.Model\n  @encode 'name'\n  @belongsTo 'superpowerable', polymorphic: true\n\nclass App.Hero extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', saveInline: true\n\nclass App.Villain extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', saveInline: true\n```\n\nBy default, attributes of the polymorphic association will be encoded according to the label. So, `hero.toJSON()` might return:\n\n```javascript\n{ id: 1,\n  name: 'Superman',\n  superpowers: [\n    {id: 15, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Super Strength'},\n    {id: 16, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Invincibility'},\n  ]\n}\n```\n\n## Inverse Associations\n\nYou can declare `inverseOf` in you associations to tell batman.js which foreign association to set on load. If the associated model has an association with the same name as the `inverseOf` value, it will be populated when data is loaded from storage. For example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true, inverseOf: 'parentItem'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItems'\n```\n\nwould allow:\n\n```coffeescript\nApp.ParentItem.find 1, (err, parent) ->\n  children = parent.get('childItems')\n  children.get('first.parentItem') == parent # => true\n\nApp.ChildItem.find 5, (err, childItem) ->\n  childItem.get('parentItem').load (err, parent) ->\n    parent.get('childItems').has(childItem) # => true\n```\n\n\n## @hasMany(label : string [, options : Object])\n\n`hasMany` expresses a one-to-many relationship on a `Batman.Model`.\n\nIt accepts options:\n\nOption | Default | Description\n-- | -- | --\n`name` | singularized, camelized `@label` | The class name for the associatiated model\n`namespace` | `Batman.currentApp` | The object where the class is defined\n`encoderKey` | `@label` | The JSON key for associated records' data\n`saveInline` | `false` | If true, child records will be saved inline with their parent\n`autoload` | `false` | If true, `parent.get(\"children\")` will trigger a load operation with request param `parent_id`.\n`url` |  model's collection URL | The URL where children can be loaded\n`includeInTransaction` | `true` | If false, this association will be skipped when deep-copying the record.\n`inverseOf` | | Names the corresponding relation on the associated model.\n`extend` | `{}` | An object to be mixed into the `Batman.Association` object.\n`primaryKey` | `\"id\"` | The primary key for the parent model\n`foreignKey` | underscored `@model.resourceName` + `\"_id\"`] | The key on child records which contains the parent's primary key value\n`encodeWithIndexes` | `false` | If true, children will be encoded as an Object instead of an Array.\n`replaceFromJSON` | `true` | If false, objects which aren't found when loading JSON will be _left in_ the association set. Use this option if you will paginate through child records.\n`as` | | Denotes a polymorphic association with the given name\n`foreignTypeKey` | `\"#{as}_type\"` | The field where polymorphic children's class names will be stored\n\n`encodeWithIndexes` provides a second option for serializing children wtih `saveInline`. If `ecnodeWithIndexes: true`, `@hasMany` children will be encoded as a JSON object with index keys instead of arrays. For example:\n\n```javascript\n{ id: 1,\n  name: \"As Seen on TV Warehouse\",\n  products: {\n    \"0\": {id: 1, name: \"Orange Glo\"},\n    \"1\": {name: \"Oxyclean\"}\n  }\n}\n```\n\n## @belongsTo(label : string [, options : Object])\n\n`belongsTo` expresses a one-to-one relationship on a `Batman.Model` when this model contains the foreign key (eg, `parent_id`). If the other model contains the foreign key, use `hasOne` instead. It often expresses inverse of a `hasMany` or `hasOne` association. You can declare this with the [`inverseOf` option](\/docs\/api\/batman.model_associations.html#inverse_associations) so that both sides of the association are loaded from JSON.\n\nIt accepts options:\n\nOption | Default | Description\n-- | -- | --\n`name` | singularized, camelized `@label` | The class name for the associatiated model\n`namespace` | `Batman.currentApp` | The object where the class is defined\n`encoderKey` | `@label` | The JSON key for associated records' data\n`saveInline` | `false` | If true, child records will be saved inline with their parent\n`autoload` | `false` | If true, `parent.get(\"children\")` will trigger a load operation with request param `parent_id`.\n`nestUrl` | `false` | If true, the associated model will be passed to `@urlNestsUnder`\n`url` |  associated model's URL, with the `foreignKey` value | The URL where the parent can be loaded\n`includeInTransaction` | `true` | If false, this association will be skipped when deep-copying the record.\n`inverseOf` | | Names the corresponding relation on the associated model.\n`extend` | | An object to be mixed into the `Batman.Association` object.\n`primaryKey` | `\"id\"` | The primary key for the parent model\n`foreignKey` | `\"#{@label}_id\"` | The key on child records which contains the parent's primary key value\n`encodeForeignKey` | `true` | If false, the foreign key will be excluded from the record's JSON.\n`polymorphic` | | Denotes the association as polymorphic\n\n## @hasOne(label : string [, options : Object])\n\n`hasOne` expresses a one-to-one relationship on a `Batman.Model` when this model contains the primary key (eg, `id`) and does not contain the foreign key. If this model contains the foreign key, use `belongsTo` instead.\n\nIt accepts options:\n\nOption | Default | Description\n-- | -- | --\n`name` | camelized `@label` | The class name for the associatiated model\n`namespace` | `Batman.currentApp` | The object where the class is defined\n`encoderKey` | `@label` | The JSON key for associated records' data\n`saveInline` | `false` | If true, child records will be saved inline with their parent\n`autoload` | `false` | If true, `parent.get(\"child\")` will trigger a load operation with request param `parent_id`.\n`url` |  associated model's URL, with the `primaryKey` value | The UR where the child can be loaded\n`includeInTransaction` | `true` | If false, this association will be skipped when deep-copying the record.\n`inverseOf` | | Names the corresponding relation on the associated model.\n`extend` |  |  An object to be mixed into the `Batman.Association` object.\n`primaryKey` | `\"id\"` | The primary key for the parent model\n`foreignKey` | underscored `@model.resourceName` + `\"_id\"` | The key on the child record which contains the parent's primary key value\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9ac02f64faaa7ff742ea4f6be62c912636ce608c","subject":"document options and reorganize a bit","message":"document options and reorganize a bit\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/11_associations.litcoffee","new_file":"docs\/11_associations.litcoffee","new_contents":"# Batman.Model Associations\n\nThere are 3 types of assocations available on `Batman.Model`: [`hasMany`](\/docs\/api\/batman.model_associations.html#class_function_hasmany), [`belongsTo`](\/docs\/api\/batman.model_associations.html#class_function_belongsto), and [`hasOne`](\/docs\/api\/batman.model_associations.html#class_function_hasone). They're modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). Batman also supports polymorphic associations through the use of [polymorphic-specific options](\/docs\/api\/batman.model_associations.html#polymorphic_association_options).\n\nTo add associations to your models, declare them in your model definition. Association functions take a label (string) and options (Object). The label names the association and is used to provide smart defaults for several options. All available options are [detailed below](\/docs\/api\/batman.model_associations.html#association_options).\n\nFor example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', inverseOf: 'parentItem', encoderKey: 'children'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItem'\n```\n\nThen, associated records will be available via accessors:\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n\n  child.set('parentItem', parent)\n  child.get('parentItem') # => parent\n```\n\nor,\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n  secondChild = new App.ChildItem\n  parent.get('childItems').add(child)\n  parent.get('childItems').add(secondChild)\n  parent.get('childItems') # => Batman.AssociationSet\n  parent.get('childItems.length') # => 2\n```\n\n## @hasMany(label : string [, options : Object])\n`hasMany` expresses a one-to-many relationship on a `Batman.Model`.\n\n## @hasOne(label : string [, options : Object])\n`hasOne` expresses a one-to-one relationship on a `Batman.Model` when this model contains the primary key (eg, `id`) and does not contain the foreign key. If this model contains the foreign key, use `belongsTo` instead.\n\n## @belongsTo(label : string [, options : Object])\n`belongsTo` expresses a one-to-one relationship on a `Batman.Model` when this model contains the foreign key (eg, `parent_id`). If the other model contains the foreign key, use `hasOne` instead.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.AssociationSet` or `Batman.Model`. Generally they will return a `Batman.AssocationProxy` named after the association type,\nsuch as `Batman.BelongsToAssociationProxy` or `Batman.HasOneAssociationProxy`.\n\n\n## ::load(callback : Function)\nCalled to load the associated record from storage, setting it as  [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target). If a callback is passed, it is called with two arguments: any error and the loaded record. Also, when this function finishes, it sets [`loaded`](\/docs\/api\/batman.model_associations.html#prototype_accessor_loaded) to `true` and fires `loaded` on the record.\n\n## ::toJSON() : Object\nReturns JSON for the target record, if the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) is present.\n\n## ::%target\nThe associated record. Getting `target` does not implicitly call `load` on the association.\n\n## ::%loaded\n`true` or `false`, Whether or not the record has been loaded from storage.\n\n## ::fetchFromLocal() : Model\nThis method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record. If this method returns a falsy value, then [`fetchFromRemote`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromremote) is called.  `Batman.AssocationProxy` subclasses must implement this method.\n\n## ::fetchFromRemote() : Model\nIf [`fetchFromLocal`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromlocal) returns a falsy value, this method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record. `Batman.AssocationProxy` subclasses must implement this method.\n\n\n## Association Options\nAll assocations have a common set of options, as well as specific options for each type of relationship.\n\n##### `primaryKey[= \"id\"] : string`\nThe primary key for the association.\n\n##### `foreignKey[= \"#{label}_id\"] : string`\nThe foreign key for the association.\n\n##### `saveInline[= true] : boolean`\nIf true, this model's attributes will be included in the associated model's JSON. This means that when an associated record is saved, this record's attributes will be included in the JSON.\n\n##### `autoload[= true] : boolean`\nIf `true`, Batman will automatically call `load` when the associated records are accessed. This is useful in view bindings, where binding to the associated records will automatically cause them to be loaded.\n\n##### `nestUrl[= false] : boolean`\nIf `true`, this model's URL will be nested under the associated model:\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', nestUrl: true\n\n# ...\n\nchild = new ChildItem(parent_id: 1, id: 5)\nchild.url() # => 'parent_items\/1\/child_items\/5'\n```\n\n`nestUrl` only applies if the model is persisted with `Batman.RestStorage` (or a subclass).\n\n##### `name : string`\nBy default, Batman checks for a model with this singular, camel-case name of association's `label` attached to `Batman.currentApp`. If the associated model is different from that, use `name` (and\/or `namespace` to specify it.\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem' # automatically finds App.ParentItem\n  @belongsTo 'alternativeParentItem', name: 'ParentItem' # also finds App.ParentItem\n```\n\n##### `inverseOf : string`\nThe foreign association to set on load. If the associated model has an association with the same name as the `inverseOf` value, it will be populated when data is loaded from storage. For example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true, inverseOf: 'parentItem'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItems'\n```\n\nwould allow:\n\n```coffeescript\nApp.ParentItem.find 1, (err, parent) ->\n  children = parent.get('childItems')\n  children.get('first.parentItem') == parent # => true\n\nApp.ChildItem.find 5, (err, childItem) ->\n  childItem.get('parentItem').load (err, parent) ->\n    parent.get('childItems').has(childItem) # => true\n```\n\n##### `encoderKey[= label] : string`\nKey where attributes for associated records will be found.\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', encoderKey: 'children'\n```\n\nwill correctly decode this JSON:\n\n```javascript\n{id: 1, children: [{ id: 5, parent_id: 1 }, {id: 6, parent_id: 1}]}\n```\n\nIt will also encode the `childItems` as `children` (unless `saveInline` is set to `false`).\n\n##### `namespace[= Batman.currentApp] : string`\nBatman expects to find a model with the given `name` on `Batman.currentApp`. If your model is defined elsewhere, use `namespace` to specify where the model is defined.\n\n```coffeescript\nclass App.Admin.Person extends Batman.Model\n  @belongsTo 'organization', namespace: App.Admin # finds App.Admin.Organization instead of App.Organization\n```\n\n## Polymorphic Association Options\nBatman also supports [polymorphic associations](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations). For example:\n\n```coffeescript\nclass App.Superpower extends Batman.Model\n  @encode 'name'\n  @belongsTo 'superpowerable', polymorphic: true\n\nclass App.Hero extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n\nclass App.Villain extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n```\nBy default, attributes of the polymorphic association will be encoded according to the label. So, `hero.toJSON()` might return:\n\n```javascript\n{ id: 1,\n  name: 'Superman',\n  superpowers: [\n    {id: 15, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Super Strength'},\n    {id: 16, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Invincibility'},\n  ]\n}\n```\n\n##### `polymorphic[= false] : boolean`\nWhether the association is [polymorphic](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations).\n\n##### `as : string`\nSpecifies the name of the polymorphic interface.\n\n##### `foreignTypeKey[= \"#{label}_type\"] : string`\nSpecifies the field which contains the `type` for a polymorphic record.\n\n##### `encodeForeignTypeKey[=true] : boolean`\nSpecifies whether the `foreignTypeKey` should be included in the JSON of the record.\n","old_contents":"# Batman.Model Associations\n\nThere are 3 types of assocations available on `Batman.Model`: `hasMany`, `belongsTo`, and `hasOne`. They're modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). To add associations to your models, declare the associations in your model definition:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem'\n```\n\nThen, associated records will be available via accessors:\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n\n  child.set('parentItem', parent)\n  child.get('parentItem') # => parent\n```\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n  secondChild = new App.ChildItem\n  parent.get('childItems').add(child)\n  parent.get('childItems').add(secondChild)\n  parent.get('childItems') # => Batman.AssociationSet\n  parent.get('childItems.length') # => 2\n```\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.AssociationSet` or `Batman.Model`. Generally they will return a `Batman.AssocationProxy` named after the association type,\nsuch as `Batman.BelongsToAssociationProxy` or `Batman.HasOneAssociationProxy`.\n\n\n## ::load(callback : Function)\nCalled to load the associated record from storage, setting it as  [`target`](http:\/\/localhost:4000\/docs\/api\/batman.model_associations.html#prototype_accessor_target). If a callback is passed, it is called with two arguments: any error and the loaded record. Also, when this function finishes, it sets [`loaded`](http:\/\/localhost:4000\/docs\/api\/batman.model_associations.html#prototype_accessor_loaded) to `true` and fires `loaded` on the record.\n\n## ::toJSON() : Object\nReturns JSON for the target record, if the [`target`](http:\/\/localhost:4000\/docs\/api\/batman.model_associations.html#prototype_accessor_target) is present.\n\n## ::%target\nThe associated record. Getting `target` does not implicitly call `load` on the association.\n\n## ::%loaded\n`true` or `false`, Whether or not the record has been loaded from storage.\n\n## ::fetchFromLocal() : Model\nThis method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](http:\/\/localhost:4000\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record. If this method returns a falsy value, then [`fetchFromRemote`](http:\/\/localhost:4000\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromremote) is called.  `Batman.AssocationProxy` subclasses must implement this method.\n\n## ::fetchFromRemote() : Model\nIf [`fetchFromLocal`](http:\/\/localhost:4000\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromlocal) returns a falsy value, this method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](http:\/\/localhost:4000\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record. `Batman.AssocationProxy` subclasses must implement this method.\n\n\n## Shared Options\nAll assocations have a common set of options, as well as specific options for each type of relationship.\n\n##### `saveInline[= true] : boolean`\nWhether we should save the child objects as part of the parent object's JSON\n\n##### `autoload[= true] : boolean`\n Whether we should load the child objects when loading the parent object.\n\n##### `nestUrl[= false] : boolean`\nWhether the child models are persisted beneath the parent model's url structure.\n\n##### `name : string`\nThe name of the child model for the association. (eg. App.Product)\n\n##### `inverseOf : string`\nThe foreign association to set on load.\n\n##### `encoderKey : string`\nThe key to encode and decode the assocation into\/from JSON.\n\n##### `namespace[= Batman.currentApp] : string`\nThe location of the model definition for the association.\n\n##### `polymorphic[= false] : boolean`\nWhether the association is polymorphic.\n\n## @hasMany(label[, options])\n`hasMany` assocations are used for expressing one-to-many relationships on a `Batman.Model`.\n\n- `label : string`\n- `options : Object`\n  - `primaryKey : string`\n  - `foreignKey : string`\n  - `as : string`\n    - the parent association name on child objects in a polymorphic association\n\n## @hasOne(label[, options])\n`hasOne` associations are used for expressing one-to-one relationships on a `Batman.Model`.\n\n- `label : string`\n- `options : Object`\n  - `primaryKey : string`\n  - `foreignKey : string`\n  - `as : string`\n    - the parent association name on child objects in a polymorphic association\n\n## @belongsTo(label[, options])\n`belongsTo` associatons are used for expressing one-to-one child relationships on a `Batman.Model`.\n\n- `label : string`\n- `options : Object`\n  - `primaryKey : string`\n  - `foreignKey : string`\n  - `encodeForeignKey[= true] boolean`\n    - whether to encode the foreignKey value when persisting the model","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"06b4964985e8e1afc8d701c78bf497b2b9d36162","subject":"Added arguments for all Png rendering parameters","message":"Added arguments for all Png rendering parameters\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/arguments.litcoffee","new_file":"lib\/arguments.litcoffee","new_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] levelname anotherlevelname yetanotherlevelname ...'\n      .example '$0',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -vvvvvvvv',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to verbosity level 8 (max)\\n\"\n      .example '$0 -w 20 -h 20',\n        \"Creates a level with default row and column counts,\n         the cells 20 units wide, 20 units high,\n         expanded by the default multiplier,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -w 10 -h 10 -x 4',\n        \"Creates a level with default row and column counts,\n         40 x 40 unit cells,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 lvl1 lvl2',\n        \"Creates two levels; named lvl1 and lvl2 -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 --levels one two three',\n        \"Creates three levels; named one, two, and three -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 -l10',\n        \"Creates ten auto-named levels -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .string 'conf'\n      .describe 'conf', 'Absolute path to config file'\n      .string 'block.fill_color'\n      .describe 'block.fill_color', 'The color path blocks should be'\n      .string 'step_count.text_align'\n      .choices 'step_count.text_align', [ 'left', 'center', 'right' ]\n      .string 'step_count.text_color'\n      .describe 'step_count.text_color', 'Can be either html color names or hex values'\n      .number 'wall.width'\n      .string 'wall.color'\n      .describe 'wall.color', 'Can be either html color names or hex values'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      8\n        height:     7\n        multiplier: 4\n        pipeline:   [ 'png_blocks', 'png_walls', 'png_step_count' ]\n        block:\n          fill_color: 'white'\n        step_count:\n          text_align: 'center'\n          text_color: 'black'\n        wall:\n          width: 1\n          color: '#666'\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .wrap 120\n      .argv\n","old_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] levelname anotherlevelname yetanotherlevelname ...'\n      .example '$0',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -vvvvvvvv',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to verbosity level 8 (max)\\n\"\n      .example '$0 -w 20 -h 20',\n        \"Creates a level with default row and column counts,\n         the cells 20 units wide, 20 units high,\n         expanded by the default multiplier,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -w 10 -h 10 -x 4',\n        \"Creates a level with default row and column counts,\n         40 x 40 unit cells,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 lvl1 lvl2',\n        \"Creates two levels; named lvl1 and lvl2 -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 --levels one two three',\n        \"Creates three levels; named one, two, and three -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 -l10',\n        \"Creates ten auto-named levels -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      8\n        height:     7\n        multiplier: 4\n        pipeline:   [ 'png_blocks', 'png_walls', 'png_step_count' ]\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .wrap 120\n      .argv\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2834c8b6b1a753e3101005d56abca6876d316fb6","subject":"Initial work on the new view docs","message":"Initial work on the new view docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_view.litcoffee","new_file":"docs\/14_view.litcoffee","new_contents":"# Batman.View\n\nFor a general explanation of `Batman.View`s and how they work, see [the\nguide](\/docs\/views.html).\n\n\n## ::constructor(options = {})\n\nA `View` is a `Batman.Object`, so any options you pass are mixed in. Use this\nto set `html`, `node`, `superview`, `parentNode` and\/or your custom data.\n\n    test 'constructor can be called without arguments', ->\n      set = new Batman.Set\n      deepEqual set.toArray(), []\n\n\n## ::lookupKeypath(keypath) : Object\n\nTraverses up the view tree searching for the specified keypath, and returns the\nresult. This is equivalent to performing a `Batman.get` for each view above\n`this` in the tree, until a defined result is returned. The path it takes is as\nfollows:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\nIf there is no match, `undefined` is returned. However if used in an accessor\nor binding, the entire path to the root will be registered as a potential\nsource of the keypath. Consequently, if the keypath is later set on any part of\nthe chain, the data will be correctly bound.\n\n`lookupKeypath` is the function invoked to locate data when evaluating a\nbinding.\n\n    test 'lookupKeypath returns the value if defined on the view', ->\n      view = new Batman.View(animal: 'cats')\n      equal 'cats', view.lookupKeypath('animal')\n\n    test 'lookupKeypath returns the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'cats')\n      subview = new Batman.View(superview: superview)\n      equal 'cats', subview.lookupKeypath('animal')\n\n\n## ::setKeypath(keypath, value) : Object\n\nTraverses the View tree searching for the specified keypath, and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is the function invoked to set data when using an input binding.\n\n    test 'setKeypath sets the value if defined on the view', ->\n      view = new Batman.View(animal: 'dogs')\n\n      view.setKeypath('animal', cats)\n      equal 'cats', view.get('animal')\n\n    test 'setKeypath sets the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'dogs')\n      subview = new Batman.View(superview: superview)\n\n      subview.setKeypath('animal', cats)\n      equal 'cats', superview.get('animal')\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', cats)\n      equal 'cats', view.get('animal')\n\n\n## ::%node : Node\n\nA reference to the DOM node that this view encapsulates. The entire tree\nbeneath this node is also the responsibility of this view and\/or its subviews.\n\nAccessing `node` will load and parse the template on demand if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n    test 'node parses bindings too', ->\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview.\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n\n## ::.superview : Batman.View\n\nA reference to the current superview (the direct ancestor in the tree). This is\nused for traversing the tree when searching for data, as in\n`View::lookupKeypath`.\n\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of a `View`. To manipulate the view tree, you should\noperate directly on this set \u2014 batman.js will automatically keep the DOM in\nsync with the logical tree.\n\n\n## ::subviews.add(view)\n\nAdding to a view's subview set will automatically update the tree, and parse\nthe template and bindings. If the superview is already in the DOM, this will\ninsert the current view's node into the DOM.\n\n\n## ::subviews.remove(view)\n\nRemoving from a view's subview set will automatically remove the subview from\nthe DOM.\n\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent, without killing it.\n\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n    test 'die kills the view', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.die()\n      equal true, view.isDead\n      equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n\n## ::propagateToSubviews(eventOrKey : string, value)\n\nIf value is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n\n","old_contents":"# Batman.View\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9a75e78e62050cd0f164a032e92e316e2165b333","subject":"add setPage and cleanup getPage","message":"add setPage and cleanup getPage\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/lib\/page\/index.litcoffee","new_file":"src\/lib\/page\/index.litcoffee","new_contents":"\n# Page Controller\n\nThe Page controller requires access to models.  In this application, models can\nbe found at `app.models`.  To access this module, use the following code: \n`page = require('..\/page')(app.models)`.\n\nAlso note, `models` contians:\n\n- **models.db** - Mongoose MongoDB connection\n- **models.MODELNAME** - model objects\n\nCode:\n\n    module.exports = {}\n\n## getPage\n\nRequires:\n\n- **model** - the Page model\n- **name** - the name of the page to fetch\n- **callback** - (page) -> {...}\n    - **page** - a dict containing:\n        - **page.name** - a string of the page name\n        - **page.title** - a string of the page title\n        - **page.body** - a string of the page body\n\nCode:\n\n    \n    getPage = (model, name, callback) ->\n      model.findOne {name: name}, (err, doc) ->\n        if err\n          console.error err.stack\n        if !doc\n          callback null\n        else\n          callback {\n            name: doc.get 'name'\n            title: doc.get 'title'\n            body: doc.get 'body'\n          }\n    module.exports.getPage = getPage\n\n## setPage\n\nRequires:\n\n- **model** - the Page model\n- **page** - a dict of the page to set containing:\n    - **page.name** - a string of the page name\n    - **page.title** - a string of the page title\n    - **page.body** - a string of the page body\n- **callback** - (page) -> {...}\n    - **page** - a dict of the page written to the db (uses getPage):\n        - **page.name** - a string of the page name\n        - **page.title** - a string of the page title\n        - **page.body** - a string of the page body\n\nCode:\n\n    setPage = (model, page, callback) ->\n      if !page || !page.name || !page.title || !page.body\n        console.error 'setPage called with invalid page'\n        callback null\n      model.create [page], (err) ->\n        if err\n          console.error err.stack\n          callback null\n        else\n          getPage model, page.name, callback\n    module.exports.setPage = setPage\n          \n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Page Controller\n\nThe Page controller requires access to models.  In this application, models can\nbe found at `app.models`.  To access this module, use the following code: \n`page = require('..\/page')(app.models)`.\n\nAlso note, `models` contians:\n\n- **models.db** - Mongoose MongoDB connection\n- **models.MODELNAME** - model objects\n\nCode:\n\n    module.exports =\n\n## getPage\n\nRequires:\n\n- **name** - the name of the page to fetch\n- **callback** - (page) -> {...}\n    - **page** - a dict containing:\n        - **page.title** - a string of the page title\n        - **page.body** - a string of the page body\n\nCode:\n\n      getPage: (model, name, callback) ->\n        model.findOne {name: name}, (err, doc) ->\n          if !doc\n            callback null\n          else\n            callback {\n              name: doc.get 'name'\n              body: doc.get 'body'\n            }\n          \n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"7aacdad3b38001e598e4bcb1af047b6e3490ae9d","subject":"Add enough spacing arround code blocks","message":"Add enough spacing arround code blocks\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/cache.litcoffee","new_file":"coffee\/cache.litcoffee","new_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n### Todo\n\n* [ ] Handle undefined values.\n\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if lookup failed; otherwise `null`.\n* `Object` doc - filtered document if found; otherwise `null`.\n\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis write failed; otherwise `null`.\n* `Object` data - the original data as it was stored in Redis.\n\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function\n\n### Callback\n\n#### Params\n\n* `Error` err -  error object if Redis lookup failed, otherwise `null`.\n* `Object` data - data retrieved from Redis if found; otherwise `null`.\n\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the filtered data object as it was stored in Redis.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the data object returned from Redis or Mongodb.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      getFilter : getFilter\n      filterData: filterData\n      getDoc    : getDoc\n      set       : set\n      get       : get\n      setForType: setForType\n      getForType: getForType\n\n","old_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n### Todo\n\n* [ ] Handle undefined values.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if lookup failed; otherwise `null`.\n* `Object` doc - filtered document if found; otherwise `null`.\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis write failed; otherwise `null`.\n* `Object` data - the original data as it was stored in Redis.\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function\n\n### Callback\n\n#### Params\n\n* `Error` err -  error object if Redis lookup failed, otherwise `null`.\n* `Object` data - data retrieved from Redis if found; otherwise `null`.\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the filtered data object as it was stored in Redis.\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function.\n\n### Callback\n\n#### Params\n\n* `Error` err - error object if Redis failed; otherwise `null`.\n* `Object` data - the data object returned from Redis or Mongodb.\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n    module.exports =\n      getFilter : getFilter\n      filterData: filterData\n      getDoc    : getDoc\n      set       : set\n      get       : get\n      setForType: setForType\n      getForType: getForType\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"11f6917f49e8bd8bb93116361ebec44677531396","subject":"document AssociationProxy","message":"document AssociationProxy\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/11_associations.litcoffee","new_file":"docs\/11_associations.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9b4e222e82ac2dc8803a6588ca66c673fb9f9952","subject":"Waterline API changed? Oh well.","message":"Waterline API changed? Oh well.\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-orm\/index.litcoffee","new_file":"packages\/shrub-orm\/index.litcoffee","new_contents":"# Object-relational mapping\n\n*Tools for working with [Waterline](https:\/\/github.com\/balderdashy\/waterline).*\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    Waterline = null\n\n    collections = {}\n    connections = {}\n\n    waterline = null\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCorePreBootstrap`.\n\n      registrar.registerHook 'shrubCorePreBootstrap', ->\n\n        Waterline = require 'waterline'\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        waterline = new Waterline()\n\n        label: 'Bootstrap ORM'\n        middleware: [\n\n          (next) -> exports.initialize next\n\n        ]\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig) ->\n\n        gruntConfig.copyAppFiles \"#{__dirname}\/app\", 'shrub-orm'\n\n        gruntConfig.registerTask 'build:shrub-orm', [\n          'newer:copy:shrub-orm'\n        ]\n\n        gruntConfig.registerTask 'build', ['build:shrub-orm']\n\n#### Implements hook `shrubConfigServer`.\n\n      registrar.registerHook 'shrubConfigServer', ->\n\nThe available adapters. This is a list of module names. We provide sails-redis\nby default.\n\n        adapters: [\n          'sails-redis'\n        ]\n\nThe available connnections. This is a keyed list of available connections\nwhich are defined as an adapter and the configuration for the adapter. The\nentries in the `adapters` list are available for use here. We provide a `shrub`\nconnection by default, which uses the sails-redis adapter with defaults.\n\n        connections:\n\n          shrub:\n\n            adapter: 'sails-redis'\n            port: 6379\n            host: 'localhost'\n            password: null\n            database: null\n\n#### Implements hook `shrubReplContext`.\n\nProvide ORM to the REPL context.\n\n      registrar.registerHook 'shrubReplContext', (context) -> context.orm = exports\n\n## initialize\n\n* (Function) `fn` - Nodeback called when initialization completes.\n\n*Spin up Waterline with our configuration.*\n\n    exports.initialize = (fn) ->\n\n      config_ = config.get 'packageSettings:shrub-orm'\n\n      waterlineConfig = adapters: {}, connections: {}\n\n`require` all the adapter modules.\n\n      for adapter in config_.adapters\n        waterlineConfig.adapters[adapter] = require adapter\n\n      waterlineConfig.connections = config_.connections\n\n#### Invoke hook `shrubOrmCollections`.\n\n      collections_ = {}\n      for collectionList in pkgman.invokeFlat 'shrubOrmCollections', waterline\n        for identity, collection of collectionList\n\nSet collection defaults.\n\n          collection.connection ?= 'shrub'\n          collection.identity ?= identity\n          collections_[collection.identity] = collection\n\n## Collection#instantiate.\n\n* (Object) `values` - An object with values to populate the model properties.\n\n*Instantiate a model with defaults supplied.*\n\n          collection.instantiate = (values = {}) ->\n\n            for key, value of @attributes\n              continue unless value.defaultsTo?\n\nSet any model defaults.\n\n              values[key] ?= if 'function' is typeof value.defaultsTo\n                value.defaultsTo.call values\n              else\n                JSON.parse JSON.stringify value.defaultsTo\n\nReach into Waterline a bit, hackish but they simply don't provide us with a\nsane API for this.\n\n            new @_model @_schema.cleanValues @_transformer.serialize values\n\n#### Invoke hook `shrubOrmCollectionsAlter`.\n\n      pkgman.invoke 'shrubOrmCollectionsAlter', collections_, waterline\n\nLoad the collections into Waterline.\n\n      for i, collection of collections_\n        waterline.loadCollection Waterline.Collection.extend collection\n\n      waterline.initialize waterlineConfig, (error, data) ->\n        return fn error if error?\n\n        collections = data.collections\n        connections = data.connections\n\n        fn()\n\n## collection\n\n* (String) `identity` - Collection identity. e.g. `'shrub-user'`\n\n*Get a collection by identity.*\n\n    exports.collection = (identity) -> collections[identity]\n\n## collections\n\n*Get all collections.*\n\n    exports.collections = -> collections\n\n## connections\n\n*Get all connections.*\n\n    exports.connections = -> connections\n\n## teardown\n\n* (Function) `fn` - Nodeback called after teardown.\n\n*Tear down Waterline.*\n\n    exports.teardown = (fn) -> waterline.teardown fn\n\n## waterline\n\n*Get the Waterline instance.*\n\n    exports.waterline = -> waterline\n","old_contents":"# Object-relational mapping\n\n*Tools for working with [Waterline](https:\/\/github.com\/balderdashy\/waterline).*\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    Waterline = null\n\n    collections = {}\n    connections = {}\n\n    waterline = null\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCorePreBootstrap`.\n\n      registrar.registerHook 'shrubCorePreBootstrap', ->\n\n        Waterline = require 'waterline'\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        waterline = new Waterline()\n\n        label: 'Bootstrap ORM'\n        middleware: [\n\n          (next) -> exports.initialize next\n\n        ]\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig) ->\n\n        gruntConfig.copyAppFiles \"#{__dirname}\/app\", 'shrub-orm'\n\n        gruntConfig.registerTask 'build:shrub-orm', [\n          'newer:copy:shrub-orm'\n        ]\n\n        gruntConfig.registerTask 'build', ['build:shrub-orm']\n\n#### Implements hook `shrubConfigServer`.\n\n      registrar.registerHook 'shrubConfigServer', ->\n\nThe available adapters. This is a list of module names. We provide sails-redis\nby default.\n\n        adapters: [\n          'sails-redis'\n        ]\n\nThe available connnections. This is a keyed list of available connections\nwhich are defined as an adapter and the configuration for the adapter. The\nentries in the `adapters` list are available for use here. We provide a `shrub`\nconnection by default, which uses the sails-redis adapter with defaults.\n\n        connections:\n\n          shrub:\n\n            adapter: 'sails-redis'\n            port: 6379\n            host: 'localhost'\n            password: null\n            database: null\n\n#### Implements hook `shrubReplContext`.\n\nProvide ORM to the REPL context.\n\n      registrar.registerHook 'shrubReplContext', (context) -> context.orm = exports\n\n## initialize\n\n* (Function) `fn` - Nodeback called when initialization completes.\n\n*Spin up Waterline with our configuration.*\n\n    exports.initialize = (fn) ->\n\n      config_ = config.get 'packageSettings:shrub-orm'\n\n      waterlineConfig = adapters: {}, connections: {}\n\n`require` all the adapter modules.\n\n      for adapter in config_.adapters\n        waterlineConfig.adapters[adapter] = require adapter\n\n      waterlineConfig.connections = config_.connections\n\n#### Invoke hook `shrubOrmCollections`.\n\n      collections_ = {}\n      for collectionList in pkgman.invokeFlat 'shrubOrmCollections', waterline\n        for identity, collection of collectionList\n\nSet collection defaults.\n\n          collection.connection ?= 'shrub'\n          collection.identity ?= identity\n          collections_[collection.identity] = collection\n\n## Collection#instantiate.\n\n* (Object) `values` - An object with values to populate the model properties.\n\n*Instantiate a model with defaults supplied.*\n\n          collection.instantiate = (values = {}) ->\n\n            for key, value of @attributes\n              continue unless value.defaultsTo?\n\nSet any model defaults.\n\n              values[key] ?= if 'function' is typeof value.defaultsTo\n                value.defaultsTo.call values\n              else\n                JSON.parse JSON.stringify value.defaultsTo\n\nReach into Waterline a bit, hackish but they simply don't provide us with a\nsane API for this.\n\n            new @_model @_schema.cleanValues @_transformer.serialize values\n\n#### Invoke hook `shrubOrmCollectionsAlter`.\n\n      pkgman.invoke 'shrubOrmCollectionsAlter', collections_, waterline\n\nLoad the collections into Waterline.\n\n      waterlineConfig.collections = for i, collection of collections_\n        Waterline.Collection.extend collection\n\n      waterline.initialize waterlineConfig, (error, data) ->\n        return fn error if error?\n\n        collections = data.collections\n        connections = data.connections\n\n        fn()\n\n## collection\n\n* (String) `identity` - Collection identity. e.g. `'shrub-user'`\n\n*Get a collection by identity.*\n\n    exports.collection = (identity) -> collections[identity]\n\n## collections\n\n*Get all collections.*\n\n    exports.collections = -> collections\n\n## connections\n\n*Get all connections.*\n\n    exports.connections = -> connections\n\n## teardown\n\n* (Function) `fn` - Nodeback called after teardown.\n\n*Tear down Waterline.*\n\n    exports.teardown = (fn) -> waterline.teardown fn\n\n## waterline\n\n*Get the Waterline instance.*\n\n    exports.waterline = -> waterline\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"55aa0fa3a19da5c363ff2a54bc1b117c278dc3b8","subject":"weya router fix + lint","message":"weya router fix + lint\n","repos":"vpj\/weya,vpj\/weya","old_file":"router.litcoffee","new_file":"router.litcoffee","new_contents":"#Weya.Router.litcoffee\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n    if exports?\n     Weya = require '.\/weya'\n     Weya.Base = require '.\/weya_base'\n\n    if not Weya.Base?\n     throw new Error 'Weya.Base not found'\n\n##Weya.Router\n\nRouting with hash tags or pushState\n\n    class Router extends Weya.Base\n     optionalParam: \/\\((.*?)\\)\/g\n     namedParam: \/(\\(\\?)?:\\w+\/g\n     splatParam: \/\\*\\w+\/g\n     escapeRegExp: \/[\\-{}\\[\\]+?.,\\\\\\^$|#\\s]\/g\n\n     @initialize ->\n      @_bindRoutes()\n      @_event = null\n      @_history = []\n\n     _routes: {}\n\n####Register router\n\n`'analyse\/:analysis': 'onAnalyse'`\n\n`dashboard': ['auth', 'dashboard']`\n\nThis will match urls of the form `analyse\/\\*` and call method @onAnalyse\nwith the parameter. Second route will first call @auth if it returns\n`true` @dashboard will be called.\n\nThe most specific route should be at bottom. Routers can added or overridden\nin subclasses\n\n     @routes: (routes) ->\n      @::_routes = _.clone @::_routes\n      for k, v of routes\n       @::_routes[k] = v\n\n####Starts routing\nOption silent will not trigger an event for the current url\n\n     start: (options) ->\n      Weya.history.start options\n      fragment = Weya.history.getFragment()\n\n      if options?.silent is on\n       @_history.push fragment: fragment, title: document.title\n\n####Goes to previous page if exists\n\n     back: ->\n      if @_history.length > 1\n       Weya.history.back()\n\n####Whether it is possible to go to previous page\n\n     canBack: ->\n      if @_history.length > 1 and Weya.history.canBack()\n       return true\n      else\n       return false\n\n####Registers a route\n\n     route: (route, name) ->\n      (route = @_routeToRegExp route) if not _.isRegExp route\n\nRegisters the route with Weya.history\n\n      Weya.history.route route, (fragment, event) =>\n       args = @_extractParameters route, fragment\n       @_event = event\n\nHandle state\n\n       if @_event?.type is \"popstate\"\n        @_history.pop()\n        if @_history.length is 0\n         @_history.push\n          fragment: fragment\n          title: document.title\n          state: @getState()\n       else\n        @_history.push\n         fragment: fragment\n         title: document.title\n         state: @getState()\n\nCalls callbacks in order\n\n       callbacks = name\n       callbacks = [callbacks] if not Array.isArray callbacks\n\n       for callback in callbacks\n        if (typeof callback) is 'string'\n         callback = @[callback]\n        break unless callback.apply this, args\n\n####Gets the current HTML5 History state\n\n     getState: ->\n      if @_event?.originalEvent?.state?\n       return @_event.originalEvent.state\n      else\n       return null\n\n####Navigate to a new URL, while setting HTML5 History state\n\n     navigate: (fragment, options) ->\n      options = {} unless options\n      if options.replace\n       @_history.pop()\n      if not options.trigger\n       @_history.push\n        fragment: fragment\n        title: options.title\n        state: options.state\n\n      Weya.history.navigate fragment, options\n\nBind routes\n\n     _bindRoutes: ->\n      for route, name of @_routes\n       @route route, name\n\nConvert a route string into a regular expression, suitable for matching\n\n     _routeToRegExp: (route) ->\n      route = route.replace @escapeRegExp, '\\\\$&'\n                   .replace @noptionalParam, '(?:$1)?'\n                   .replace @namedParam, (match, optional) ->\n                    if optional then match else '([^\\\/]+)'\n                   .replace @splatParam, '(.*?)'\n\n       return new RegExp \"^#{route}$\"\n\nExtract parameters from a route regex and URL\n\n     _extractParameters: (route, fragment) ->\n      params = route.exec(fragment).slice(1)\n      return _.map params, (param) ->\n       if param then decodeURIComponent(param) else null\n\n## History class\n\n    class History extends Weya.Base\n\nStrip leading hash\/slash and trailing space\n\n     routeStripper: \/^[#\\\/]|\\s+$\/g\n\nStrip leading and trailing slashes\n\n     rootStripper: \/^\\\/+|\\\/+$\/g\n\nRemove trailing slash\n\n     trailingSlash: \/\\\/$\/\n\nStrip urls of hash and query\n\n     pathStripper: \/[?#].*$\/\n\n     @initialize ->\n      @handlers = []\n      _.bindAll this, 'checkUrl'\n      @history = window.history\n      @location = window.location\n      @stateList = []\n\nHash check interval\n\n     interval: 50\n\nGet hash value\n\n     getHash: ->\n      match = @location.href.match \/#(.*)$\/\n      return (if match? then match[1] else '')\n\nGet emulated state\n\n     getEmulateState: ->\n      if @stateList.length > 0\n       return @stateList[@stateList.length - 1]\n      else\n       return {fragment: \"\"}\n\n     popEmulateState: -> @stateList.pop()\n\n     pushEmulateState: (state, title, fragment) ->\n      @stateList.push\n       state: state\n       title: title\n       fragment: fragment\n\nGet the URL fragment\n\n     getFragment: (fragment, forcePushState) ->\n      if not fragment?\n       if @_emulateState\n        fragment = @getEmulateState().fragment\n       else if @_hasPushState or not @_wantsHashChange or forcePushState\n        fragment = @location.pathname\n        root = @root.replace @trailingSlash, ''\n        if (fragment.indexOf root) is 0\n         fragment = fragment.slice root.length\n       else\n        fragment = @getHash()\n\n      return fragment.replace @routeStripper, ''\n\n####Goto the previous page\n\n     back: ->\n      if @_emulateState is on\n       @popEmulateState()\n       @loadUrl null, null\n      else\n       @history?.back?()\n\n####Can back?\n\n     canBack: ->\n      if @_emulateState is on\n       return @stateList.length > 1\n      else\n       return @history?.back?\n\n####Start listening to events\n\n     start: (options) ->\n      History.started = true\n\n      @options = _.extend {root: '\/'}, @options, options\n      @root = @options.root\n      @_emulateState = @options.emulateState is on\n      @_wantsHashChange = @_emulateState is off and @options.hashChange isnt off\n      @_wantsPushState = @_emulateState is off and @options.pushState is on\n      @_hasPushState = @_wantsPushState is on and @history?.pushState?\n      if @_emulateState and @options.start?\n       @pushEmulateState @options.start.state,\n        @options.start.title\n        @options.start.fragment\n\n      @fragment = @getFragment()\n\nNormalize root to always include a leading and trailing slash.\n\n      @root = \"\/#{@root}\/\".replace @rootStripper, '\/'\n\nDepending on whether we're using pushState or hashes, and whether\n'onhashchange' is supported, determine how we check the URL state.\n\n      if @_hasPushState\n       $(window).on 'popstate', @checkUrl\n      else if @_wantsHashChange and window.onhashchange?\n       $(window).on 'hashchange', @checkUrl\n      else if @_wantsHashChange\n       @_checkUrlInterval = setInterval @checkUrl, @interval\n\n      if not @options.silent\n       @loadUrl null, null\n\n####Add a listener to a router\n\n     route: (route, callback) ->\n      @handlers.unshift route: route, callback: callback\n\nCheck current url for changes\n\n     checkUrl: (e) ->\n      fragment = @getFragment()\n      return if fragment is @fragment\n      @loadUrl fragment, e\n\nCall callbacks of matching route\n\n     loadUrl: (fragment, e) ->\n      fragment = @fragment = @getFragment fragment\n      return _.any this.handlers, (handler) ->\n       if handler.route.test fragment\n        handler.callback fragment, e\n        return true\n       else\n        return false\n\n####Navigate to a URL\nTriggers a route is option trigger is on\nReplaces the url is option replace is on\nSets state and title\n\n     navigate: (fragment, options) ->\n      return false if not History.started\n\n      fragment = @getFragment(fragment or '')\n      url = @root + fragment\n\nStrip the fragment of the query and hash for matching.\n\n      fragment = fragment.replace @pathStripper, ''\n\n      return if @fragment is fragment\n      @fragment = fragment\n\nDon't include a trailing slash on the root.\n\n      if fragment is '' and url isnt '\/'\n       url = url.slice 0, -1\n\nIf pushState is available, we use it to set the fragment as a real URL.\n\n      if @_emulateState\n       if options.replace is on\n        @popEmulateState()\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @pushEmulateState state, title, fragment\n      else if @_hasPushState\n       method = if options.replace then 'replaceState' else 'pushState'\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @history[method] state, title, url\n\nIf hash changes haven't been explicitly disabled, update the hash\nfragment to store history.\n\n      else if @_wantsHashChange\n       @_updateHash @location, fragment, options.replace\n\nIf you've told us that you explicitly don't want fallback hashchange-\nbased history, then `navigate` becomes a page refresh.\n\n      else\n       return @location.assign url\n      if options.trigger\n       return @loadUrl fragment, null\n\nUpdate the hash\n\n     _updateHash: (location, fragment, replace) ->\n      if replace\n       href = location.href.replace \/(javascript:|#).*$\/, ''\n       location.replace \"#{href}##{fragment}\"\n      else\n       location.hash = \"##{fragment}\"\n\n    Weya.Router = Router\n    Weya.history = new History\n\n    if module?\n     module.exports = Weya.Router\n\n","old_contents":"#Weya.Router.litcoffee\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n    if exports?\n     Weya = require '.\/weya'\n     Weya.Base = require '.\/weya_base'\n\n    if not Weya.Base?\n     throw new Error 'Weya.Base not found'\n\n##Weya.Router\n\nRouting with hash tags or pushState\n\n    class Router extends Weya.Base\n     optionalParam: \/\\((.*?)\\)\/g\n     namedParam: \/(\\(\\?)?:\\w+\/g\n     splatParam: \/\\*\\w+\/g\n     escapeRegExp: \/[\\-{}\\[\\]+?.,\\\\\\^$|#\\s]\/g\n\n     @initialize ->\n      @_bindRoutes()\n      @_event = null\n      @_history = []\n\n     _routes: {}\n\n####Register router\n\n`'analyse\/:analysis': 'onAnalyse'`\n\n`dashboard': ['auth', 'dashboard']`\n\nThis will match urls of the form `analyse\/\\*` and call method @onAnalyse\nwith the parameter. Second route will first call @auth if it returns\n`true` @dashboard will be called.\n\nThe most specific route should be at bottom. Routers can added or overridden\nin subclasses\n\n     @routes: (routes) ->\n      @::_routes = _.clone @::_routes\n      for k, v of routes\n       @::_routes[k] = v\n\n####Starts routing\nOption silent will not trigger an event for the current url\n\n     start: (options) ->\n      Weya.history.start options\n      fragment = Weya.history.getFragment()\n\n      if options?.silent is on\n       @_history.push fragment: fragment, title: document.title\n\n####Goes to previous page if exists\n\n     back: ->\n      if @_history.length > 1\n       Weya.history.back()\n\n####Whether it is possible to go to previous page\n\n     canBack: ->\n      if @_history.length > 1 and Weya.history.canBack()\n       return true\n      else\n       return false\n\n####Registers a route\n\n     route: (route, name) ->\n      (route = @_routeToRegExp route) if not _.isRegExp route\n\nRegisters the route with Weya.history\n\n      Weya.history.route route, (fragment, event) =>\n       args = @_extractParameters route, fragment\n       @_event = event\n\nHandle state\n\n       if @_event?.type is \"popstate\"\n        @_history.pop()\n        if @_history.length is 0\n         @_history.push\n          fragment: fragment\n          title: document.title\n          state: @getState()\n       else\n        @_history.push\n         fragment: fragment\n         title: document.title\n         state: @getState()\n\nCalls callbacks in order\n\n       callbacks = name\n       callbacks = [callbacks] if not Array.isArray callbacks\n\n       for callback in callbacks\n        if (typeof callback) is 'string'\n         callback = @[callback]\n        break unless callback.apply this, args\n\n####Gets the current HTML5 History state\n\n     getState: ->\n      if @_event?.originalEvent?.state?\n       return @_event.originalEvent.state\n      else\n       return null\n\n####Navigate to a new URL, while setting HTML5 History state\n\n     navigate: (fragment, options) ->\n      options = {} unless options\n      if options.replace\n       @_history.pop()\n      if not options.trigger\n       @_history.push\n        fragment: fragment\n        title: options.title\n        state: options.state\n\n      Weya.history.navigate fragment, options\n\nBind routes\n\n     _bindRoutes: ->\n      for route, name of @_routes\n       @route route, name\n\nConvert a route string into a regular expression, suitable for matching\n\n     _routeToRegExp: (route) ->\n      route = route.replace @escapeRegExp, '\\\\$&'\n                   .replace @noptionalParam, '(?:$1)?'\n                   .replace @namedParam, (match, optional) ->\n                     if optional then match else '([^\\\/]+)'\n                   .replace @splatParam, '(.*?)'\n\n       return new RegExp \"^#{route}$\"\n\nExtract parameters from a route regex and URL\n\n     _extractParameters: (route, fragment) ->\n      params = route.exec(fragment).slice(1)\n      return _.map params, (param) ->\n       if param then decodeURIComponent(param) else null\n\n## History class\n\n    class History extends Weya.Base\n\nStrip leading hash\/slash and trailing space\n\n     routeStripper: \/^[#\\\/]|\\s+$\/g\n\nStrip leading and trailing slashes\n\n     rootStripper: \/^\\\/+|\\\/+$\/g\n\nRemove trailing slash\n\n     trailingSlash: \/\\\/$\/\n\nStrip urls of hash and query\n\n     pathStripper: \/[?#].*$\/\n\n     @initialize ->\n      @handlers = []\n      _.bindAll this, 'checkUrl'\n      @history = window.history\n      @location = window.location\n      @stateList = []\n\nHash check interval\n\n     interval: 50\n\nGet hash value\n\n     getHash: ->\n      match = @location.href.match \/#(.*)$\/\n      return (if match? then match[1] else '')\n\nGet emulated state\n\n     getEmulateState: ->\n      if @stateList.length > 0\n       return @stateList[@stateList.length - 1]\n      else\n       return {fragment: \"\"}\n\n     popEmulateState: -> @stateList.pop()\n\n     pushEmulateState: (state, title, fragment) ->\n      @stateList.push\n       state: state\n       title: title\n       fragment: fragment\n\nGet the URL fragment\n\n     getFragment: (fragment, forcePushState) ->\n      if not fragment?\n       if @_emulateState\n        fragment = @getEmulateState().fragment\n       else if @_hasPushState or not @_wantsHashChange or forcePushState\n        fragment = @location.pathname\n        root = @root.replace @trailingSlash, ''\n        if (fragment.indexOf root) is 0\n         fragment = fragment.slice root.length\n       else\n        fragment = @getHash()\n\n      return fragment.replace @routeStripper, ''\n\n####Goto the previous page\n\n     back: ->\n      if @_emulateState is on\n       @popEmulateState()\n       @loadUrl null, null\n      else\n       @history?.back?()\n\n####Can back?\n\n     canBack: ->\n      if @_emulateState is on\n       return @stateList.length > 1\n      else\n       return @history?.back?\n\n####Start listening to events\n\n     start: (options) ->\n      History.started = true\n\n      @options = _.extend {root: '\/'}, @options, options\n      @root = @options.root\n      @_emulateState = @options.emulateState is on\n      @_wantsHashChange = @_emulateState is off and @options.hashChange isnt off\n      @_wantsPushState = @_emulateState is off and @options.pushState is on\n      @_hasPushState = @_wantsPushState is on and @history?.pushState?\n      if @_emulateState and @options.start?\n       @pushEmulateState @options.start.state,\n        @options.start.title\n        @options.start.fragment\n\n      @fragment = @getFragment()\n\nNormalize root to always include a leading and trailing slash.\n\n      @root = \"\/#{@root}\/\".replace @rootStripper, '\/'\n\nDepending on whether we're using pushState or hashes, and whether\n'onhashchange' is supported, determine how we check the URL state.\n\n      if @_hasPushState\n       $(window).on 'popstate', @checkUrl\n      else if @_wantsHashChange and window.onhashchange?\n       @(window).on 'hashchange', @checkUrl\n      else if @_wantsHashChange\n       @_checkUrlInterval = setInterval @checkUrl, @interval\n\n      if not @options.silent\n       @loadUrl null, null\n\n####Add a listener to a router\n\n     route: (route, callback) ->\n      @handlers.unshift route: route, callback: callback\n\nCheck current url for changes\n\n     checkUrl: (e) ->\n      fragment = @getFragment()\n      return if fragment is @fragment\n      @loadUrl fragment, e\n\nCall callbacks of matching route\n\n     loadUrl: (fragment, e) ->\n      fragment = @fragment = @getFragment fragment\n      return _.any this.handlers, (handler) ->\n       if handler.route.test fragment\n        handler.callback fragment, e\n        return true\n       else\n        return false\n\n####Navigate to a URL\nTriggers a route is option trigger is on\nReplaces the url is option replace is on\nSets state and title\n\n     navigate: (fragment, options) ->\n      return false if not History.started\n\n      fragment = @getFragment(fragment or '')\n      url = @root + fragment\n\nStrip the fragment of the query and hash for matching.\n\n      fragment = fragment.replace @pathStripper, ''\n\n      return if @fragment is fragment\n      @fragment = fragment\n\nDon't include a trailing slash on the root.\n\n      if fragment is '' and url isnt '\/'\n       url = url.slice 0, -1\n\nIf pushState is available, we use it to set the fragment as a real URL.\n\n      if @_emulateState\n       if options.replace is on\n        @popEmulateState()\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @pushEmulateState state, title, fragment\n      else if @_hasPushState\n       method = if options.replace then 'replaceState' else 'pushState'\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @history[method] state, title, url\n\nIf hash changes haven't been explicitly disabled, update the hash\nfragment to store history.\n\n      else if @_wantsHashChange\n       @_updateHash @location, fragment, options.replace\n\nIf you've told us that you explicitly don't want fallback hashchange-\nbased history, then `navigate` becomes a page refresh.\n\n      else\n       return @location.assign url\n      if options.trigger\n       return @loadUrl fragment, null\n\nUpdate the hash\n\n     _updateHash: (location, fragment, replace) ->\n      if replace\n       href = location.href.replace \/(javascript:|#).*$\/, ''\n       location.replace \"#{href}##{fragment}\"\n      else\n       location.hash = \"##{fragment}\"\n\n    Weya.Router = Router\n    Weya.history = new History\n\n    if module?\n     module.exports = Weya.Router\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"540fc1422215557eacf588ffb0aacf4148cd48db","subject":"Fix subheadings for main server file","message":"Fix subheadings for main server file\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.methodOverride())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n    app.use(raven.middleware.express(process.env.SENTRY_DNS)) if process.env.SENTRY_DNS\n\n### Error handling\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n### API keys\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'DNT'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone about the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        when 'PUT'  then collection.put req, res, next\n        when 'PATCH' then collection.patch req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then document.options req, res, next\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n## Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\n## Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.methodOverride())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n    app.use(raven.middleware.express(process.env.SENTRY_DNS)) if process.env.SENTRY_DNS\n\n## Error handling\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## API keys\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'DNT'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone about the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        when 'PUT'  then collection.put req, res, next\n        when 'PATCH' then collection.patch req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then document.options req, res, next\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fc6049078b7c181a8019c2d9f89fc03fc3fd7e13","subject":"Added text for commono","message":"Added text for commono\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments),\n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nFor convenience I'll add a couple of readily accessible logic variables:\n\n    F.$x = F.lvar(\"x\")\n    F.$y = F.lvar(\"y\")\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n                        find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return bindings\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        bindings = F.unify(_.first(t1), _.first(t2), bindings)\n        bindings = if (bindings isnt null) then F.unify(_.rest(t1), _.rest(t2),   bindings) else bindings\n        return bindings\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logic programs\n# --------------\n\nWe can build more complex goals using lambda-abstractions and previously defined combinators, `conj` and `disj`.  For example, we can define the function `choice` such that `choice(t1, array)` is a goal that succeeds if `t1` is an element of `array`.\n\n    F.choice = ($v, list) ->\n      return F.fail if _.isEmpty(list)\n\n      F.disj(F.goal($v, _.first(list)),\n                    F.choice($v, _.rest(list)))\n\nTODO - examples\n\nThe name `choice` should evoke [The Axiom of Choice](http:\/\/en.wikipedia.org\/wiki\/Axiom_of_choice)...\n\nNow I can write a very primitive program: find an element that is common in two lists:\n\n    F.commono = (l, r) ->\n      $x = F.lvar(\"x\")\n      F.conj(F.choice($x, l),\n             F.choice($x, r))\n\nTODO - examples\n\n# Exports and sundries\n# --------------------\n\n\t  if module?\n\t    module.exports = F\n\t  else\n\t    root.F = F\n\n\t)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments),\n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nFor convenience I'll add a couple of readily accessible logic variables:\n\n    F.$x = F.lvar(\"x\")\n    F.$y = F.lvar(\"y\")\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n                        find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return bindings\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        bindings = F.unify(_.first(t1), _.first(t2), bindings)\n        bindings = if (bindings isnt null) then F.unify(_.rest(t1), _.rest(t2),   bindings) else bindings\n        return bindings\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logic programs\n# --------------\n\nWe can build more complex goals using lambda-abstractions and previously defined combinators, `conj` and `disj`.  For example, we can define the function `choice` such that `choice(t1, array)` is a goal that succeeds if `t1` is an element of `array`.\n\n    F.choice = ($v, list) ->\n      return F.fail if _.isEmpty(list)\n\n      F.disj(F.goal($v, _.first(list)),\n                    F.choice($v, _.rest(list)))\n\nThe name `choice` should evoke [The Axiom of Choice](http:\/\/en.wikipedia.org\/wiki\/Axiom_of_choice)...\n\n\n\n# Exports and sundries\n# --------------------\n\n\t  if module?\n\t    module.exports = F\n\t  else\n\t    root.F = F\n\n\t)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e2080090cfc3e222b31829c6474734305caf6b0b","subject":"Removing with from jquery plugins","message":"Removing with from jquery plugins\n","repos":"ojjs\/oj","old_file":"src\/oj.litcoffee","new_file":"src\/oj.litcoffee","new_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = ->\n\n  oj function acts like a tag method that doesn't emit\n\n      oj._argsPush()\n      ojml = oj.emit.apply @, arguments\n      oj._argsPop()\n      ojml\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.1.4'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Store jQuery reference as either the global reference or as required through `jquery2`.\n  This allows this reference to be included as a script tag, included through npm, or overriden.\n\n    if typeof $ != 'undefined'\n      oj.$ = $\n    else if typeof require != 'undefined'\n      try\n        oj.$ = require 'jquery'\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      oj.$ ->\n\n        oj.$.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n\nIndexing Helpers\n-----------------------------------------------------------------------------\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = ArrayP.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name, check) ->\n      check ?= ->\n        if oj.isClient then oj.isDefined(window[name]) else oj.isDefined(global[name])\n      throw new Error(\"oj: #{name} dependency is missing\") unless check()\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw new Error('oj.isProperty: string expected for second argument') unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, rest...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from rest by unioning all objects\n\n      {args, options:attributes} = oj.unionArguments rest\n\n      if isQuiet = attributes.__quiet__\n        delete attributes.__quiet__\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n\n        else if oj.isFunction arg\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to.\n  Do not emit when quiet is set,\n\n      oj._argsAppend(ojml) unless isQuiet\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Get quiet tag name\n\n    _getQuietTagName = (tag) ->\n      tag + '_'\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n\n  Tag functions emit by default\n\n        oj[t] = -> oj.tag t, arguments...\n\n  Underscore tag functions do not emit\n\n        qt = _getQuietTagName t\n        oj[qt] = -> oj.tag t, {__quiet__:1}, arguments...\n\n  Record the tag name so the OJML syntax can use the function instead of a string\n\n        _setTagName oj[t], t\n        _setTagName oj[qt], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extendInto (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.useGlobally = oj.extendInto = (context = root) ->\n\n      o = {}\n      for k,v of oj\n        if k[0] != '_' and k != 'extendInto' and k != 'useGlobally'\n          o[k] = v\n\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* minify - Minify js and css\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        minify: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, minify: options.minify, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.minify then '' else '\\n'\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if (!minify) and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if (!minify) then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\nminify:false will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        # when 'jquery'\n        #   options.html?.push ojml.html()\n        #   options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML(options)\n            options.dom?.appendChild ojml.toDOM(options)\n            if options.css?\n              _extend options.css, ojml.toCSSMap(options)\n\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        throw new Error('oj.compile: doctype expects string as first argument') unless oj.isString ojml[1]\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip indention if there is only one child\n          if !options.minify and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if (!options.minify) and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mouseleave:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if oj.$?\n          if oj.isArray ev\n            oj.$(el)[ek].apply @, ev\n          else\n            oj.$(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = oj.$ @el)\n\n        # Get and set id attribute of view\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # # Get and set class attribute of view\n        # class:\n        #   get: -> @$el.attr 'class'\n        #   set: (v) ->\n        #     # Join arrays with spaces\n        #     if oj.isArray v\n        #       v = v.join ' '\n        #     @$el.attr 'class', v\n        #     return\n\n        # # Alias for class\n        # c:\n        #   get: -> @class\n        #   set: (v) -> @class = v; return\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          oj.$.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all currently set themes (readwrite)\n        themes: get: ->\n          out = {}\n          oj.$.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n              if k == 'class'\n                @addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single class\n        addClass: (name) ->\n          @$el.addClass name\n          return\n\n        # Remove a single class\n        removeClass: (name) ->\n          @$el.removeClass name\n          return\n\n        # Add a single theme\n        addTheme: (name) ->\n          @addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @removeClass \"theme-#{name}\"\n          return\n\n        # Clear all themes\n        clearThemes: (name) ->\n          @$el.removeClass \"theme-#{name}\"\n          classes = @$el.attr('class').split(' ')\n          _each classes, (v) ->\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.minify then '' else '\\n')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (options) -> _cssFromPluginObject (_flattenCSSMap @cssMap), _extend({}, minify:options.minify, tags:0)\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      throw new Error(\"oj.#{@typeName}.css: object or string expected for first argument\") unless oj.isString(css) or oj.isObject(css)\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      throw new Error(\"oj.#{@typeName}.theme: string expected for first argument (theme name)\") unless oj.isString name\n      throw new Error(\"oj.#{@typeName}.css: object expected for second argument\") unless oj.isObject(css)\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.Text\n------------------------------------------------------------------------------\nText control\n\n    oj.Text = oj.createType 'Text',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Get tag name if provided\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @el = oj =>\n          oj[@tagName]()\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.Text.base.constructor.call @, options\n\n      properties:\n\nvalue: text value of this object (readwrite)\n\n        value:\n          get: -> @$el.ojValue()\n          set: (v) -> @$el.oj(v); return\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = oj.argumentShift(options, 'value') || args.join('\\n');\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> @$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n\n      # Allow use to extend globally\n      if arguments.length == 0\n        return oj.useGlobally();\n\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get oj.$(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set oj.$(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if oj.$('.' + _styleClassFromPlugin plugin).length == 0\n          oj.$('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    oj.$.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    oj.$.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:'deep', meta:1, title:'deep', link:'deep', script:'deep'\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj.compile: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      oj.$('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    oj.$.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    oj.$.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        oj.$.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","old_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = ->\n\n  oj function acts like a tag method that doesn't emit\n\n      oj._argsPush()\n      ojml = oj.emit.apply @, arguments\n      oj._argsPop()\n      ojml\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.1.4'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Store jQuery reference as either the global reference or as required through `jquery2`.\n  This allows this reference to be included as a script tag, included through npm, or overriden.\n\n    if typeof $ != 'undefined'\n      oj.$ = $\n    else if typeof require != 'undefined'\n      try\n        oj.$ = require 'jquery'\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      oj.$ ->\n\n        oj.$.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n\nIndexing Helpers\n-----------------------------------------------------------------------------\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = ArrayP.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name, check) ->\n      check ?= ->\n        if oj.isClient then oj.isDefined(window[name]) else oj.isDefined(global[name])\n      throw new Error(\"oj: #{name} dependency is missing\") unless check()\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw new Error('oj.isProperty: string expected for second argument') unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, rest...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from rest by unioning all objects\n\n      {args, options:attributes} = oj.unionArguments rest\n\n      if isQuiet = attributes.__quiet__\n        delete attributes.__quiet__\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n\n        else if oj.isFunction arg\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to.\n  Do not emit when quiet is set,\n\n      oj._argsAppend(ojml) unless isQuiet\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Get quiet tag name\n\n    _getQuietTagName = (tag) ->\n      tag + '_'\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n\n  Tag functions emit by default\n\n        oj[t] = -> oj.tag t, arguments...\n\n  Underscore tag functions do not emit\n\n        qt = _getQuietTagName t\n        oj[qt] = -> oj.tag t, {__quiet__:1}, arguments...\n\n  Record the tag name so the OJML syntax can use the function instead of a string\n\n        _setTagName oj[t], t\n        _setTagName oj[qt], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extendInto (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.useGlobally = oj.extendInto = (context = root) ->\n\n      o = {}\n      for k,v of oj\n        if k[0] != '_' and k != 'extendInto' and k != 'useGlobally'\n          o[k] = v\n\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* minify - Minify js and css\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        minify: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, minify: options.minify, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.minify then '' else '\\n'\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if (!minify) and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if (!minify) then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\nminify:false will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        # when 'jquery'\n        #   options.html?.push ojml.html()\n        #   options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML(options)\n            options.dom?.appendChild ojml.toDOM(options)\n            if options.css?\n              _extend options.css, ojml.toCSSMap(options)\n\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        throw new Error('oj.compile: doctype expects string as first argument') unless oj.isString ojml[1]\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip indention if there is only one child\n          if !options.minify and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if (!options.minify) and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mouseleave:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if oj.$?\n          if oj.isArray ev\n            oj.$(el)[ek].apply @, ev\n          else\n            oj.$(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = oj.$ @el)\n\n        # Get and set id attribute of view\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # # Get and set class attribute of view\n        # class:\n        #   get: -> @$el.attr 'class'\n        #   set: (v) ->\n        #     # Join arrays with spaces\n        #     if oj.isArray v\n        #       v = v.join ' '\n        #     @$el.attr 'class', v\n        #     return\n\n        # # Alias for class\n        # c:\n        #   get: -> @class\n        #   set: (v) -> @class = v; return\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          oj.$.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all currently set themes (readwrite)\n        themes: get: ->\n          out = {}\n          oj.$.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n              if k == 'class'\n                @addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single class\n        addClass: (name) ->\n          @$el.addClass name\n          return\n\n        # Remove a single class\n        removeClass: (name) ->\n          @$el.removeClass name\n          return\n\n        # Add a single theme\n        addTheme: (name) ->\n          @addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @removeClass \"theme-#{name}\"\n          return\n\n        # Clear all themes\n        clearThemes: (name) ->\n          @$el.removeClass \"theme-#{name}\"\n          classes = @$el.attr('class').split(' ')\n          _each classes, (v) ->\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.minify then '' else '\\n')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (options) -> _cssFromPluginObject (_flattenCSSMap @cssMap), _extend({}, minify:options.minify, tags:0)\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      throw new Error(\"oj.#{@typeName}.css: object or string expected for first argument\") unless oj.isString(css) or oj.isObject(css)\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      throw new Error(\"oj.#{@typeName}.theme: string expected for first argument (theme name)\") unless oj.isString name\n      throw new Error(\"oj.#{@typeName}.css: object expected for second argument\") unless oj.isObject(css)\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.Text\n------------------------------------------------------------------------------\nText control\n\n    oj.Text = oj.createType 'Text',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Get tag name if provided\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @el = oj =>\n          oj[@tagName]()\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.Text.base.constructor.call @, options\n\n      properties:\n\nvalue: text value of this object (readwrite)\n\n        value:\n          get: -> @$el.ojValue()\n          set: (v) -> @$el.oj(v); return\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = oj.argumentShift(options, 'value') || args.join('\\n');\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> @$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n\n      # Allow use to extend globally\n      if arguments.length == 0\n        return oj.useGlobally();\n\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get oj.$(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set oj.$(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if oj.$('.' + _styleClassFromPlugin plugin).length == 0\n          oj.$('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    oj.$.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        `with (oj) {`\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n        `}`\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    oj.$.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:'deep', meta:1, title:'deep', link:'deep', script:'deep'\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj.compile: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      oj.$('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    oj.$.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    oj.$.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        oj.$.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cf404228da8e01e2e0661f63748a5fcd62605d47","subject":"Goals document","message":"Goals document\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n  \t\t              find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return s\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        s = F.unify(_.first(t1), _.first(t2), bindings)\n        s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2),   bindings) else s\n        return s\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logico\n# ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n  \t\t              find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return s\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        s = F.unify(_.first(t1), _.first(t2), bindings)\n        s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2),   bindings) else s\n        return s\n      return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"77684599ddfec0090e1ecf028b1ae678c46abe67","subject":"less words","message":"less words\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @.primaryKey[= \"id\"] : String\n\nDefines the `Model`'s primary key. This attribute will be used for determining:\n\n- record identity (ie, records with the same `primaryKey` are assumed to be the same record)\n- whether a record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew)\n- whether records are related (see [`Batman.Model` Associations](\/docs\/api\/batman.model_associations.html))\n- URL parameters via [`toParam`](\/docs\/api\/batman.model.html#prototype_function_toparam)\n\nChange the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n      equal Shop.get('primaryKey'), 'shop_id'\n\n## @.resourceName[= null] : String\n\n`resourceName` is a minification-safe identifier for the `Model`. It is usually an underscore-cased version of the `Model`'s class name (for example, `App.BlogPost => \"blog_post\"`) . It is used by:\n\n- Model assocations (for providing default `primaryKey`s and `foreignKey`s and for `urlNestsUnder`)\n- Storage adapters (unless overriden by `storageKey`)\n- `data-route` bindings (eg, `routes.items[item]`)\n\n## @.storageKey[= null] : String\n\n`storageKey` is used as a namespace by the model's storage adapter. `Batman.LocalStorage` and `Batman.SessionStorage` use it as a JSON namespace and `Batman.RestStorage` uses it as a URL segment. If `storageKey` isn't set, `resourceName` may be used.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\nSpecifies that `keys` will be persisted. Use it to white-list fields that should be loaded from JSON and sent back as JSON.\n\nIf no `encoderObject` is provided, the identity function (`(x) -> x`) will be used to encode and decode values.\n\nIf `encoderObject` is provided, it may have `encode`, `decode` and `as` properties, for example:\n\n```coffeescript\n@encode 'myProperty',\n  decode: (value, key, incomingJSON, outgoingObject, record) -> # returns a value to set on the record\n  encode: (value, key, builtJSON, record) ->                    # returns a value to put into the JSON\n  as: \"my_property\"                                             # overrides \"myProperty\" as the JSON key\n```\n\n__`decode`__ is applied to _incoming JSON values_ before they're set on the record. It may be `false` to prevent receiving data from the storage adapter.\n\nThe `decode` function's arguments are:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\n__`encode`__ is applied to _outgoing record values_ before they're added to the JSON. It may be set to `false` to prevent sending data to the storage adapter.\n\nThe `encode` function's arguments are:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\n__`as`__ will override the `encode` key when getting and setting values from JSON. It may be a string or a function.\n\nIf `as` is a function, it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for the model's `primaryKey`.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nAssigns validators to `keys` based on `options`. All instances of the defined model will be validated according to these keys.\n\nSee [Model Validations](\/docs\/api\/batman.model_validations.html) for a detailed description of validation options.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @%loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @%all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## @createMultipleFromJSON(attributesArray: Array) : Array\n\nLoads data from JSON like `Model.createFromJSON`, but `attributesArray` is an array of objects and returns an array of records. `createMultipleFromJSON` loads new records all at once, so `Model.loaded.itemsWereAdded` is only fired once.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::isDirty() : Boolean\n\nReturns `true` if any keys have been changed since the record was initialized or saved.\n\n## ::%isDirty : Boolean\n\nA bindable accessor on [`isDirty`](\/docs\/api\/batman.model.html#prototype_function_isdirty).\n\n## ::%dirtyKeys : Set\n\nThe [`Batman.Set`](\/docs\/api\/batman.set.html) of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::constructor(idOrAttributes = {}) : Model\n\nIf `idOrAttributes` is an object, the values are mixed into the new record. Otherwise, `idOrAttrubutes` is set to the new record's [`id`](\/docs\/api\/batman.model.html#prototype_accessor_id).\n\n## ::isNew() : boolean\n\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## ::%isNew : Boolean\n\nA bindable accessor on [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew).\n\n## updateAttributes(attributes) : Model\n\nMixes in `attributes` into the record (using `set`). Doesn't save the record.\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::%attributes : Hash\n\n`attributes` is a `Batman.Hash` where a record's attributes are stored. `Batman.Model`'s default accessor stores values in `attributes`, so it includes:\n\n- attributes defined with `@encode`\n- keys assigned with `set`, unless the key has a specifically defined accessor\n\nBut it doesn't include:\n\n- keys that have specifically defined accessors (eg, `errors`, `lifecycle`, `isNew`)\n\nA record's attributes are used by `Model::transaction` to create a deep copy of the record.\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n## ::transaction() : Model\n\nCreates a deep copy of the record instance based on its `\"attributes\"`, allowing it to be modified without affecting the original. Also mixes in `Batman.Transaction`.\nUseful for implementing actions that can be cancelled.\n\nTo apply the changes made to a transaction, call `applyChanges`.\nTo apply changes and save the record after running validations, call `save`.\n\n    test \"transaction creates an independent clone of a record\", ->\n      record = new Batman.Model(name: 'Felix')\n\n      transaction = record.transaction()\n      transaction.set('name', 'Camouflage')\n      equal transaction.get('name'), 'Camouflage'\n      equal record.get('name'), 'Felix'\n\n      transaction.applyChanges()\n      equal record.get('name'), 'Camouflage'\n\n\n## ::reflectOnAssociation(label : String)\n\nReturns the `Batman.Association` for the record's association named by `label`.\nReturns `null` if the association does not exist.\n\n## ::reflectOnAllAssociations([type: String])\n\nIf `type` is passed (eg, `hasMany`), returns a `Batman.SimpleSet` of all associations of that type on the record.\nIf no type is passed, all associations are returned.\nIf the record has no associations, returns `null`.\n\n","old_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @.primaryKey[= \"id\"] : String\n\nDefines the `Model`'s primary key. This attribute will be used for determining:\n\n- record identity (ie, records with the same `primaryKey` are assumed to be the same record)\n- whether a record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew)\n- whether records are related (see [`Batman.Model` Associations](\/docs\/api\/batman.model_associations.html))\n- URL parameters via [`toParam`](\/docs\/api\/batman.model.html#prototype_function_toparam)\n\nChange the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n      equal Shop.get('primaryKey'), 'shop_id'\n\n## @.resourceName[= null] : String\n\n`resourceName` is a minification-safe identifier for the `Model`. It is usually an underscore-cased version of the `Model`'s class name (for example, `App.BlogPost => \"blog_post\"`) . It is used by:\n\n- Model assocations (for providing default `primaryKey`s and `foreignKey`s and for `urlNestsUnder`)\n- Storage adapters (unless overriden by `storageKey`)\n- `data-route` bindings (eg, `routes.items[item]`)\n\n## @.storageKey[= null] : String\n\n`storageKey` is used as a namespace by the model's storage adapter. `Batman.LocalStorage` and `Batman.SessionStorage` use it as a JSON namespace and `Batman.RestStorage` uses it as a URL segment. If `storageKey` isn't set, `resourceName` may be used.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\nSpecifies that `keys` will be persisted with the `Batman.StorageAdapter` passed to `@persist`. Use it to white-list fields that should be loaded from JSON and sent back as JSON.\n\nIf no `encoderObject` is provided, the identity function (`(x) -> x`) will be used to encode and decode values.\n\nIf `encoderObject` is provided, it may have `encode`, `decode` and `as` properties, for example:\n\n```coffeescript\n@encode 'myProperty',\n  decode: (value, key, incomingJSON, outgoingObject, record) -> # returns a value to set on the record\n  encode: (value, key, builtJSON, record) ->                    # returns a value to put into the JSON\n  as: \"my_property\"                                             # overrides \"myProperty\" as the JSON key\n```\n\n__`decode`__ is applied to _incoming JSON values_ before they're set on the record. It may be `false` to prevent receiving data from the storage adapter.\n\nThe `decode` function's arguments are:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\n__`encode`__ is applied to _outgoing record values_ before they're added to the JSON. It may be set to `false` to prevent sending data to the storage adapter.\n\nThe `encode` function's arguments are:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\n__`as`__ will override the `encode` key when getting and setting values from JSON. It may be a string or a function.\n\nIf `as` is a function, it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for the model's `primaryKey`.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nAssigns validators to `keys` based on `options`. All instances of the defined model will be validated according to these keys.\n\nSee [Model Validations](\/docs\/api\/batman.model_validations.html) for a detailed description of validation options.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @%loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @%all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## @createMultipleFromJSON(attributesArray: Array) : Array\n\nLoads data from JSON like `Model.createFromJSON`, but `attributesArray` is an array of objects and returns an array of records. `createMultipleFromJSON` loads new records all at once, so `Model.loaded.itemsWereAdded` is only fired once.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::isDirty() : Boolean\n\nReturns `true` if any keys have been changed since the record was initialized or saved.\n\n## ::%isDirty : Boolean\n\nA bindable accessor on [`isDirty`](\/docs\/api\/batman.model.html#prototype_function_isdirty).\n\n## ::%dirtyKeys : Set\n\nThe [`Batman.Set`](\/docs\/api\/batman.set.html) of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::constructor(idOrAttributes = {}) : Model\n\nIf `idOrAttributes` is an object, the values are mixed into the new record. Otherwise, `idOrAttrubutes` is set to the new record's [`id`](\/docs\/api\/batman.model.html#prototype_accessor_id).\n\n## ::isNew() : boolean\n\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## ::%isNew : Boolean\n\nA bindable accessor on [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew).\n\n## updateAttributes(attributes) : Model\n\nMixes in `attributes` into the record (using `set`). Doesn't save the record.\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::%attributes : Hash\n\n`attributes` is a `Batman.Hash` where a record's attributes are stored. `Batman.Model`'s default accessor stores values in `attributes`, so it includes:\n\n- attributes defined with `@encode`\n- keys assigned with `set`, unless the key has a specifically defined accessor\n\nBut it doesn't include:\n\n- keys that have specifically defined accessors (eg, `errors`, `lifecycle`, `isNew`)\n\nA record's attributes are used by `Model::transaction` to create a deep copy of the record.\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n## ::transaction() : Model\n\nCreates a deep copy of the record instance based on its `\"attributes\"`, allowing it to be modified without affecting the original. Also mixes in `Batman.Transaction`.\nUseful for implementing actions that can be cancelled.\n\nTo apply the changes made to a transaction, call `applyChanges`.\nTo apply changes and save the record after running validations, call `save`.\n\n    test \"transaction creates an independent clone of a record\", ->\n      record = new Batman.Model(name: 'Felix')\n\n      transaction = record.transaction()\n      transaction.set('name', 'Camouflage')\n      equal transaction.get('name'), 'Camouflage'\n      equal record.get('name'), 'Felix'\n\n      transaction.applyChanges()\n      equal record.get('name'), 'Camouflage'\n\n\n## ::reflectOnAssociation(label : String)\n\nReturns the `Batman.Association` for the record's association named by `label`.\nReturns `null` if the association does not exist.\n\n## ::reflectOnAllAssociations([type: String])\n\nIf `type` is passed (eg, `hasMany`), returns a `Batman.SimpleSet` of all associations of that type on the record.\nIf no type is passed, all associations are returned.\nIf the record has no associations, returns `null`.\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3230f37f86ea2c8de76aebf29ce35b7d1f1c3763","subject":"io response bundling","message":"io response bundling\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        @_handleResponse data, options, last\n       when 'call'\n        @_handleCall data, options, last\n       when 'poll'\n        @_handlePoll data, options, last\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"afe8511e7eb8f49c573ed36ebf2b20fde146192b","subject":"worker port transferList","message":"worker port transferList\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        if self.port.onerror?\n         self.port.onerror e\n        else\n         throw e\n      , 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      if data._transferList?\n       transferList = data._transferList\n       delete data._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n\n     _respond: (data, options, callback) ->\n      if data._transferList?\n       transferList = data._transferList\n       delete data._transferList\n      else\n       transferList = []\n      @worker.postMessage data, transferList\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) =>\n       try\n        callbacks.fail? e\n       catch err\n        @onerror? err\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        if self.port.onerror?\n         self.port.onerror e\n        else\n         throw e\n      , 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) =>\n       try\n        callbacks.fail? e\n       catch err\n        @onerror? err\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"29ed553d43ee42e755be4a68819929ba2cffe331","subject":"one more thing","message":"one more thing\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @.primaryKey[= \"id\"] : String\n\nDefines the `Model`'s primary key. This attribute will be used for determining:\n\n- record identity (ie, records with the same `primaryKey` are assumed to be the same record)\n- whether a record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew)\n- whether records are related (see [`Batman.Model` Associations](\/docs\/api\/batman.model_associations.html))\n- URL parameters via [`toParam`](\/docs\/api\/batman.model.html#prototype_function_toparam)\n\nChange the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n      equal Shop.get('primaryKey'), 'shop_id'\n\n## @.resourceName[= null] : String\n\n`resourceName` is a minification-safe identifier for the `Model`. It is usually an underscore-cased version of the `Model`'s class name (for example, `App.BlogPost => \"blog_post\"`) . It is used by:\n\n- Model assocations (for providing default `primaryKey`s and `foreignKey`s and for `urlNestsUnder`)\n- Storage adapters (unless overriden by `storageKey`)\n- `data-route` bindings (eg, `routes.items[item]`)\n\n## @.storageKey[= null] : String\n\n`storageKey` is used as a namespace by the model's storage adapter. `Batman.LocalStorage` and `Batman.SessionStorage` use it as a JSON namespace and `Batman.RestStorage` uses it as a URL segment. If `storageKey` isn't set, `resourceName` may be used.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n\n        @validate 'title', 'body', {presence: true} # title and body must be present (not undefined nor '')\n        @validate 'body', {minLength: 10}           # body must be 10 characters long at least\n        @validate 'title', {pattern: \/^[A-Z]\/}      # Title must start with an uppercase letter\n        @validate 'author', {email: true}           # the author field must contain a valid email address\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n + `regexp : \/regexp\/` : Assert that the value is matching the provided regular expression.\n + `email : true` : Assert that the value is an email address, per the [W3C HTML5 definition](http:\/\/www.w3.org\/TR\/html5\/forms.html#valid-e-mail-address).\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\nValidations can be skipped by including a conditional check:\n\n    test '@validate accepts an if or unless option to determine whether the validation should be performed or not', ->\n      QUnit.expect(0)\n      class Invoice extends Batman.Model\n        @resourceName: 'invoice'\n        @validate 'tax_1_rate', {presence: true, if: (errors, record, key) -> record.get('tax_1_enabled')} # tax 1 rate must be present if tax 1 is enabled\n        @validate 'tax_2_rate', {presence: true, if: 'tax_2_rate'} # passing a string will look for an attribute or accessor with that name on the record\n        @validate 'discount_rate', {presence: true, unless: 'discount_disabled'} # discount rate must be present unless discount is disabled\n\n + `if`: Specifies a function or string to determine whether the validation should occur. Should return either true or false.\n + `unless`: Specifies a function or string to determine whether the validation should not occur. Should return either true or false.\n\nIf you specify the if or unless option as a string, it will do a `@get(string)` on the record being validated. Functions should have the signature `(errors, record, key)`. The arguments are as follows:\n\n + `errors`: the ErrorsSet instance\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n\n## @%loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @%all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## @createMultipleFromJSON(attributesArray: Array) : Array\n\nLoads data from JSON like `Model.createFromJSON`, but `attributesArray` is an array of objects and returns an array of records. `createMultipleFromJSON` loads new records all at once, so `Model.loaded.itemsWereAdded` is only fired once.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::isDirty() : Boolean\n\nReturns `true` if any keys have been changed since the record was initialized or saved.\n\n## ::%isDirty : Boolean\n\nA bindable accessor on [`isDirty`](\/docs\/api\/batman.model.html#prototype_function_isdirty).\n\n## ::%dirtyKeys : Set\n\nThe [`Batman.Set`](\/docs\/api\/batman.set.html) of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::constructor(idOrAttributes = {}) : Model\n\nIf `idOrAttributes` is an object, the values are mixed into the new record. Otherwise, `idOrAttrubutes` is set to the new record's [`id`](\/docs\/api\/batman.model.html#prototype_accessor_id).\n\n## ::isNew() : boolean\n\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## ::%isNew : Boolean\n\nA bindable accessor on [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew).\n\n## updateAttributes(attributes) : Model\n\nMixes in `attributes` into the record (using `set`). Doesn't save the record.\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# \/api\/App Components\/Batman.Model\/Batman.Validator\n\nbatman.js ships with a plethora of [built-in validators](\/docs\/api\/batman.model.html#class_function_validate), but when they don't meet your needs, you can create custom validators by subclassing `Batman.Validator`, implementing `Batman.Validator::validateEach`, and adding the new validator to `Batman.Validators`. For example:\n\n```coffeescript\nclass App.LessThanPropertyValidator extends Batman.Validator\n  @triggers 'lessThanProperty'\n  @options 'allowBlank'\n\n  validateEach: (errors, record, key, callback) ->\n      value = record.get(key)\n      compareKey = @options.lessThanProperty\n      otherValue = record.get(compareKey)\n      else !@handleBlank(value) && value >= otherValue\n        errors.add(key, 'must be less than #{compareKey}')\n      callback()\n\nBatman.Validators.push App.LessThanPropertyValidator\n```\n\n## ::constructor(options : Object[, mixins...])\n\nThe first argument becomes the validator's `@options`. Subsequent arguments are mixed in to the validator with `Batman.Object::mixin`. You can override this method to alter the options object before it's assigned to `@options`. (Make sure to call `super` afterwards!)\n\n## @triggers(triggers...)\n\nWhen any of the strings in `triggers` is passed to `Model@validate`:\n\n- this validator will be instantiated and its `validateEach` will be invoked\n- the key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUse this method when one validator will handle many kinds of validations. For example, a simplified length validator:\n\n```coffeescript\nclass App.SimpleLengthValidator extends Batman.Validator\n  @triggers 'minLength', 'maxLength', 'length'\n\n  constructor: (options) ->\n    # has access to options.minLength, options.maxLength, options.length\n    super\n\n  validateEach: (errors, record, key, callback) ->\n    # has access to @options.minLength, @options.maxLength, @options.length\n```\n\nAll three of these validations will be handled by `App.SimpleLengthValidator::validateEach`:\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @validate 'name', minLength: 3\n  @validate 'bio', maxLength: 250\n  @validate 'phone_number', length: 10\n```\n\n## @options(options...)\n\nThe key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUnlike `@triggers`, the presence of a key in `options` will not cause this validator to be instantiated.\n\n## ::validateEach(errors: Batman.ErrorsSet, record: Batman.Model, key: String, callback: Function)\n\nThis method is invoked to validate `key` on `record`. If this method determins that the key is invalid, it should add a validation error to `errors`.\n\n`errors` is a `Batman.ErrorsSet`, which is a [`Batman.Set`](\/docs\/api\/batman.set.html) with `::add(key, message)` as a convenience method for adding [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s. So, to easily add a new validation error:\n\n```coffeescript\nerrors.add(\"phone_number\", \"isn't 10 characters long\")\n```\n\nWhen the validator is finished, it must call `callback` to continue the validation chain.\n\n## @handleBlank(value)\n\nReturns `true` if `options.allowBlank` is `true` _and_ `value` is `null`, `undefined` or `\"\"`\n\n# \/api\/App Components\/Batman.Model\/Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @.primaryKey[= \"id\"] : String\n\nDefines the `Model`'s primary key. This attribute will be used for determining:\n\n- record identity (ie, records with the same `primaryKey` are assumed to be the same record)\n- whether a record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew)\n- whether records are related (see [`Batman.Model` Associations](\/docs\/api\/batman.model_associations.html))\n- URL parameters via [`toParam`](\/docs\/api\/batman.model.html#prototype_function_toparam)\n\nChange the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n      equal Shop.get('primaryKey'), 'shop_id'\n\n## @.resourceName[= null] : String\n\n`resourceName` is a minification-safe identifier for the `Model`. It is usually an underscore-cased version of the `Model`'s class name (for example, `App.BlogPost => \"blog_post\"`) . It is used by:\n\n- Model assocations (for providing default `primaryKey`s and `foreignKey`s and for `urlNestsUnder`)\n- Storage adapters (unless overriden by `storageKey`)\n- `data-route` bindings (eg, `routes.items[item]`)\n\n## @.storageKey : String\n\n`storageKey` is used as a namespace by the model's storage adapter. `Batman.LocalStorage` and `Batman.SessionStorage` use it as a JSON namespace and `Batman.RestStorage` uses it as a URL segment. If `storageKey` isn't set, `resourceName` may be used.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n\n        @validate 'title', 'body', {presence: true} # title and body must be present (not undefined nor '')\n        @validate 'body', {minLength: 10}           # body must be 10 characters long at least\n        @validate 'title', {pattern: \/^[A-Z]\/}      # Title must start with an uppercase letter\n        @validate 'author', {email: true}           # the author field must contain a valid email address\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n + `regexp : \/regexp\/` : Assert that the value is matching the provided regular expression.\n + `email : true` : Assert that the value is an email address, per the [W3C HTML5 definition](http:\/\/www.w3.org\/TR\/html5\/forms.html#valid-e-mail-address).\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\nValidations can be skipped by including a conditional check:\n\n    test '@validate accepts an if or unless option to determine whether the validation should be performed or not', ->\n      QUnit.expect(0)\n      class Invoice extends Batman.Model\n        @resourceName: 'invoice'\n        @validate 'tax_1_rate', {presence: true, if: (errors, record, key) -> record.get('tax_1_enabled')} # tax 1 rate must be present if tax 1 is enabled\n        @validate 'tax_2_rate', {presence: true, if: 'tax_2_rate'} # passing a string will look for an attribute or accessor with that name on the record\n        @validate 'discount_rate', {presence: true, unless: 'discount_disabled'} # discount rate must be present unless discount is disabled\n\n + `if`: Specifies a function or string to determine whether the validation should occur. Should return either true or false.\n + `unless`: Specifies a function or string to determine whether the validation should not occur. Should return either true or false.\n\nIf you specify the if or unless option as a string, it will do a `@get(string)` on the record being validated. Functions should have the signature `(errors, record, key)`. The arguments are as follows:\n\n + `errors`: the ErrorsSet instance\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n\n## @%loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @%all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## @createMultipleFromJSON(attributesArray: Array) : Array\n\nLoads data from JSON like `Model.createFromJSON`, but `attributesArray` is an array of objects and returns an array of records. `createMultipleFromJSON` loads new records all at once, so `Model.loaded.itemsWereAdded` is only fired once.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::isDirty() : Boolean\n\nReturns `true` if any keys have been changed since the record was initialized or saved.\n\n## ::%isDirty : Boolean\n\nA bindable accessor on [`isDirty`](\/docs\/api\/batman.model.html#prototype_function_isdirty).\n\n## ::%dirtyKeys : Set\n\nThe [`Batman.Set`](\/docs\/api\/batman.set.html) of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::constructor(idOrAttributes = {}) : Model\n\nIf `idOrAttributes` is an object, the values are mixed into the new record. Otherwise, `idOrAttrubutes` is set to the new record's [`id`](\/docs\/api\/batman.model.html#prototype_accessor_id).\n\n## ::isNew() : boolean\n\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## ::%isNew : Boolean\n\nA bindable accessor on [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew).\n\n## updateAttributes(attributes) : Model\n\nMixes in `attributes` into the record (using `set`). Doesn't save the record.\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# \/api\/App Components\/Batman.Model\/Batman.Validator\n\nbatman.js ships with a plethora of [built-in validators](\/docs\/api\/batman.model.html#class_function_validate), but when they don't meet your needs, you can create custom validators by subclassing `Batman.Validator`, implementing `Batman.Validator::validateEach`, and adding the new validator to `Batman.Validators`. For example:\n\n```coffeescript\nclass App.LessThanPropertyValidator extends Batman.Validator\n  @triggers 'lessThanProperty'\n  @options 'allowBlank'\n\n  validateEach: (errors, record, key, callback) ->\n      value = record.get(key)\n      compareKey = @options.lessThanProperty\n      otherValue = record.get(compareKey)\n      else !@handleBlank(value) && value >= otherValue\n        errors.add(key, 'must be less than #{compareKey}')\n      callback()\n\nBatman.Validators.push App.LessThanPropertyValidator\n```\n\n## ::constructor(options : Object[, mixins...])\n\nThe first argument becomes the validator's `@options`. Subsequent arguments are mixed in to the validator with `Batman.Object::mixin`. You can override this method to alter the options object before it's assigned to `@options`. (Make sure to call `super` afterwards!)\n\n## @triggers(triggers...)\n\nWhen any of the strings in `triggers` is passed to `Model@validate`:\n\n- this validator will be instantiated and its `validateEach` will be invoked\n- the key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUse this method when one validator will handle many kinds of validations. For example, a simplified length validator:\n\n```coffeescript\nclass App.SimpleLengthValidator extends Batman.Validator\n  @triggers 'minLength', 'maxLength', 'length'\n\n  constructor: (options) ->\n    # has access to options.minLength, options.maxLength, options.length\n    super\n\n  validateEach: (errors, record, key, callback) ->\n    # has access to @options.minLength, @options.maxLength, @options.length\n```\n\nAll three of these validations will be handled by `App.SimpleLengthValidator::validateEach`:\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @validate 'name', minLength: 3\n  @validate 'bio', maxLength: 250\n  @validate 'phone_number', length: 10\n```\n\n## @options(options...)\n\nThe key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUnlike `@triggers`, the presence of a key in `options` will not cause this validator to be instantiated.\n\n## ::validateEach(errors: Batman.ErrorsSet, record: Batman.Model, key: String, callback: Function)\n\nThis method is invoked to validate `key` on `record`. If this method determins that the key is invalid, it should add a validation error to `errors`.\n\n`errors` is a `Batman.ErrorsSet`, which is a [`Batman.Set`](\/docs\/api\/batman.set.html) with `::add(key, message)` as a convenience method for adding [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s. So, to easily add a new validation error:\n\n```coffeescript\nerrors.add(\"phone_number\", \"isn't 10 characters long\")\n```\n\nWhen the validator is finished, it must call `callback` to continue the validation chain.\n\n## @handleBlank(value)\n\nReturns `true` if `options.allowBlank` is `true` _and_ `value` is `null`, `undefined` or `\"\"`\n\n# \/api\/App Components\/Batman.Model\/Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c6e1b03515085b978ff709bde97b6ba6c834f62f","subject":"Use valueOf() rather than toValue() for Dates","message":"Use valueOf() rather than toValue() for Dates\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/match-sched.litcoffee","new_file":"src\/coffee\/match-sched.litcoffee","new_contents":"Match Schedule\n==============\n\nThe match schedule, as with the day schedule, is mainly managed within the basic\ndata module - this module defines only useful utilities.\n\nConstants\n---------\n\nWe define two constants within this module -- *MATCH_PREROLL*, and\n*MATCH_LENGTH*.\n\n*MATCH_PREROLL* is the amount of time, in seconds, before the start\ntime of a match during which it should be considered active. Its\ncurrent value is 180 seconds, which is 30 seconds of swap time and\n60 seconds boot period.\n\n    MATCH_PREROLL = 30 + 60\n\n*MATCH_LENGTH* is simply the length of a match in seconds, including\nsetup and tear-down time - presently 5 minutes.\n\n    MATCH_LENGTH = 60*5\n\n*MATCH_POSTROLL* is the amount of time, in seconds, between the\nstart time of a match and when it is considered to have ended. It\nis defined in terms of *MATCH_PREROLL* and *MATCH_LENGTH*.\n\n    MATCH_POSTROLL = MATCH_LENGTH - MATCH_PREROLL\n\nMatch Tracking\n--------------\n\nThe *firstMatchAfter* function takes as its argument a match schedule,\nand a *reference point*, being a JavaScript *Date* object. It finds\nthe first match in the schedule whose consideration period begins\nat or after the reference point. It may also take an optional\n*feasibility condition*, to further filter the matches considered.\n\n    firstMatchAfter = (schedule, referencePoint, feasilibilty) ->\n\nIf the feasibility condition is unspecified, we use a default\ncondition which simply accepts all matches.\n\n        unless feasibility?\n            feasibility = (match) -> yes\n\nWe convert the reference point into a UNIX timestamp for our use.\n\n        referenceUNIX = referencePoint.valueOf() * 0.001\n\nWe then use Underscore's *find* function to find the first satisfying\nmatch.\n\n        _.find schedule, (match) ->\n            return no unless feasibility(match, referencePoint)\n            match.start - MATCH_PREROLL <= referenceUNIX\n\nCurrent Match\n-------------\n\nWe provide the current match (nullable) via the *CurrentMatch*\nproperty. It is a map on the *Data.matchSchedule* property, and the\nclock.\n\nFirst, we define the data source.\n\n    currentMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n\nWe then define the stream itself, as a map over the input source.\n\n    currentMatch = Data.matchSchedule.map (data) ->\n\nWe find the first match active now, using *firstMatchAfter*. A\nfeasibility condition is passed to constrain matches to only those\nwhich have not ended.\n\n        firstMatchAfter data.schedule, data.clock, (match, ref) ->\n            not (match.start + MAX_POSTROLL > ref)\n\nThe public property simply removes the duplicates from that stream.\n\n    window.CurrentMatch = currentMatch.skipDuplicates()\n\nNext Match\n----------\n\nWe also provide the next match (nullable) via the *NextMatch*\nproperty. It is defined similarly to *CurrentMatch*, except with\nthe additional feasibility condition of not being the current match.\n\nWe first define the data source.\n\n    nextMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n            currentMatch: CurrentMatch\n\nWe then define the stream itself, again as a map over the source.\n\n    nextMatch = nextMatchSource.map (data) ->\n\nAs with the current match, we use *firstMatchAfter*, with a feasibility\ncondition this time specifying that the match is not the current\nmatch.\n\n        firstMatchAfter data.schedule, data.clock, (match) ->\n            match.key isnt data.currentMatch?.key\n\nWe then publish it by removing duplicates.\n\n    window.NextMatch = nextMatch.skipDuplicates()\n\n","old_contents":"Match Schedule\n==============\n\nThe match schedule, as with the day schedule, is mainly managed within the basic\ndata module - this module defines only useful utilities.\n\nConstants\n---------\n\nWe define two constants within this module -- *MATCH_PREROLL*, and\n*MATCH_LENGTH*.\n\n*MATCH_PREROLL* is the amount of time, in seconds, before the start\ntime of a match during which it should be considered active. Its\ncurrent value is 180 seconds, which is 30 seconds of swap time and\n60 seconds boot period.\n\n    MATCH_PREROLL = 30 + 60\n\n*MATCH_LENGTH* is simply the length of a match in seconds, including\nsetup and tear-down time - presently 5 minutes.\n\n    MATCH_LENGTH = 60*5\n\n*MATCH_POSTROLL* is the amount of time, in seconds, between the\nstart time of a match and when it is considered to have ended. It\nis defined in terms of *MATCH_PREROLL* and *MATCH_LENGTH*.\n\n    MATCH_POSTROLL = MATCH_LENGTH - MATCH_PREROLL\n\nMatch Tracking\n--------------\n\nThe *firstMatchAfter* function takes as its argument a match schedule,\nand a *reference point*, being a JavaScript *Date* object. It finds\nthe first match in the schedule whose consideration period begins\nat or after the reference point. It may also take an optional\n*feasibility condition*, to further filter the matches considered.\n\n    firstMatchAfter = (schedule, referencePoint, feasilibilty) ->\n\nIf the feasibility condition is unspecified, we use a default\ncondition which simply accepts all matches.\n\n        unless feasibility?\n            feasibility = (match) -> yes\n\nWe convert the reference point into a UNIX timestamp for our use.\n\n        referenceUNIX = referencePoint.toValue() * 0.001\n\nWe then use Underscore's *find* function to find the first satisfying\nmatch.\n\n        _.find schedule, (match) ->\n            return no unless feasibility(match, referencePoint)\n            match.start - MATCH_PREROLL <= referenceUNIX\n\nCurrent Match\n-------------\n\nWe provide the current match (nullable) via the *CurrentMatch*\nproperty. It is a map on the *Data.matchSchedule* property, and the\nclock.\n\nFirst, we define the data source.\n\n    currentMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n\nWe then define the stream itself, as a map over the input source.\n\n    currentMatch = Data.matchSchedule.map (data) ->\n\nWe find the first match active now, using *firstMatchAfter*. A\nfeasibility condition is passed to constrain matches to only those\nwhich have not ended.\n\n        firstMatchAfter data.schedule, data.clock, (match, ref) ->\n            not (match.start + MAX_POSTROLL > ref)\n\nThe public property simply removes the duplicates from that stream.\n\n    window.CurrentMatch = currentMatch.skipDuplicates()\n\nNext Match\n----------\n\nWe also provide the next match (nullable) via the *NextMatch*\nproperty. It is defined similarly to *CurrentMatch*, except with\nthe additional feasibility condition of not being the current match.\n\nWe first define the data source.\n\n    nextMatchSource =\n        Bacon.combineTemplate\n            schedule: Data.matchSchedule\n            clock: Clock\n            currentMatch: CurrentMatch\n\nWe then define the stream itself, again as a map over the source.\n\n    nextMatch = nextMatchSource.map (data) ->\n\nAs with the current match, we use *firstMatchAfter*, with a feasibility\ncondition this time specifying that the match is not the current\nmatch.\n\n        firstMatchAfter data.schedule, data.clock, (match) ->\n            match.key isnt data.currentMatch?.key\n\nWe then publish it by removing duplicates.\n\n    window.NextMatch = nextMatch.skipDuplicates()\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b1ff51c2916df68bbe5bd1bedbe019536a41bafd","subject":"Added listeners for dependency hydration","message":"Added listeners for dependency hydration\n\nSo, loading dependencies in parallel means that they can step on each other if we're\nnot careful - who knew!\n\nThere are now three distinct phases of dependency hydration:\n\n1. undefined: This is the default phase. It means the hydration system is not aware a\n   dependency needs to be hydrated.\n2. false: This phase indicates that the hydration system is aware of a dependency, but it\n   is not hydrated yet.\n3. true: This phase indicates that a dependency is completely hydrated and ready to go.\n\nWhen a dependency is in the false phase, any subclasses trying to initialize are added to a list\nand notified when the dependency moves to the true phase.\n\nThis forces subclasses to wait on their initialization until their superclass has all it's dependencies\nfully hydrated.\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: =>\n        proto = @.__proto__\n        name  = proto.constructor.name\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          for prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if typeof body == 'function' || typeof body.behavior == 'function'\n                proto._do_wrap proto, prop\n\n                INITIALIZERS name, prop if prop[0] == '$'\n\n          proto = proto.__proto__\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (done) =>\n        proto  = @.__proto__\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.constructor.name == 'Madul'\n\n          proto = proto.__super__\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            @[initer.execute]().then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        @_call_initializers_for name, =>\n          if listeners[name]?\n            async.each listeners[name], (listener, next) =>\n              listener @\n              next()\n            , => @_register_initialized name\n          else\n            @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              @[initializer.fn]()\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: =>\n        proto = @.__proto__\n        name  = proto.constructor.name\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          for prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if typeof body == 'function' || typeof body.behavior == 'function'\n                proto._do_wrap proto, prop\n\n                INITIALIZERS name, prop if prop[0] == '$'\n\n          proto = proto.__proto__\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (done) =>\n        proto  = @.__proto__\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos, (p, next) =>\n          if p.deps?\n            p._do_hydrate p, p.deps, next\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.constructor.name == 'Madul'\n\n          proto = proto.__super__\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            @[initer.execute]().then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        @_call_initializers_for name, =>\n          if listeners[name]?\n            async.each listeners[name], (listener, next) =>\n              listener @\n              next()\n            , => @_register_initialized name\n          else\n            @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              @[initializer.fn]()\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b7665765f6a169625a47394005b488d06f5ede86","subject":"Don't attach state callbacks to input when it's an object","message":"Don't attach state callbacks to input when it's an object\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err.message\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.Promise (resolve, reject) =>\n                  async.eachSeries me.validators, (v, next) =>\n                    arg       = Object.keys(v)[0]\n                    validator = v[arg]\n                    input     = arg\n                    prop      = args\n\n                    for a in arg.split '.'\n                      prop  = prop[a]\n                      input = a\n\n                    if Array.isArray validator\n                      async.eachSeries validator, (v, nxt) =>\n                        proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                        proto[v].EXECUTE.call proto[v], input, prop\n                          .then nxt\n                          .catch handle_err v, { \"#{input}\": prop }, nxt, reject\n                      , next\n                    else\n                      proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                      proto[validator].EXECUTE.call proto[validator], input, prop\n                        .then next\n                        .catch handle_err v, { \"#{input}\": prop }, next, reject\n                  , resolve\n                .then =>\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries before, (b, next) =>\n                      proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                      proto[b].before.call proto[b], args\n                        .then next\n                        .catch handle_err b, args, next, reject\n                    , resolve\n                .then =>\n                  input = proto._prep_invocation proto, method, args, def\n\n                  try\n                    me.behavior.apply me, input\n                  catch e\n                    failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                    me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                    failed e.message\n                .then (result) =>\n                  q.Promise (resolve, reject) =>\n                    if after.length > 0\n                      async.eachSeries after, (a, next) =>\n                        proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                        proto[a].after.call proto[a], result\n                          .then next\n                          .catch handle_err b, args, next, reject\n                      , => resolve result\n                    else\n                      process.nextTick => resolve result\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n\n              INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n              wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, next\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        error = true\n\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) =>\n                    error = undefined\n                    me._do_add me, ref, next\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, nxt, =>\n                    stop = new Error()\n                    stop.break = true\n\n                    next()\n                    nxt stop\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push e\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = e\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        proto._report method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err.message\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.Promise (resolve, reject) =>\n                  async.eachSeries me.validators, (v, next) =>\n                    arg       = Object.keys(v)[0]\n                    validator = v[arg]\n                    input     = arg\n                    prop      = args\n\n                    for a in arg.split '.'\n                      prop  = prop[a]\n                      input = a\n\n                    if Array.isArray validator\n                      async.eachSeries validator, (v, nxt) =>\n                        proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                        proto[v].EXECUTE.call proto[v], input, prop\n                          .then nxt\n                          .catch handle_err v, { \"#{input}\": prop }, nxt, reject\n                      , next\n                    else\n                      proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                      proto[validator].EXECUTE.call proto[validator], input, prop\n                        .then next\n                        .catch handle_err v, { \"#{input}\": prop }, next, reject\n                  , resolve\n                .then =>\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries before, (b, next) =>\n                      proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                      proto[b].before.call proto[b], args\n                        .then next\n                        .catch handle_err b, args, next, reject\n                    , resolve\n                .then =>\n                  input = proto._prep_invocation proto, method, args, def\n\n                  try\n                    me.behavior.apply me, input\n                  catch e\n                    failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                    me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                    failed e.message\n                .then (result) =>\n                  q.Promise (resolve, reject) =>\n                    if after.length > 0\n                      async.eachSeries after, (a, next) =>\n                        proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                        proto[a].after.call proto[a], result\n                          .then next\n                          .catch handle_err b, args, next, reject\n                      , => resolve result\n                    else\n                      process.nextTick => resolve result\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n\n              INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n              wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, next\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        error = true\n\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) =>\n                    error = undefined\n                    me._do_add me, ref, next\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, nxt, =>\n                    stop = new Error()\n                    stop.break = true\n\n                    next()\n                    nxt stop\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e9426e273f57a75ac9ca5db0609d7bd325215003","subject":"Add sentry logging for 401 and 403 errors","message":"Add sentry logging for 401 and 403 errors\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      console.log sentry\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.tilbyder}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.status >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"062aca66d490c120a8726a7fec4f961bd257f9ab","subject":"Added support for conditional logging","message":"Added support for conditional logging\n","repos":"bsgbryan\/jyn","old_file":"lib\/cli.litcoffee","new_file":"lib\/cli.litcoffee","new_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    if process.env.JYN_ENABLE_LOGGING\n      require 'magnus'\n\n    Server = require '.\/server'\n    args   = require '.\/arguments'\n\n    new Server()\n      .initialize()\n      .then (server) ->\n        server.boot args\n          .then ->\n            console.log \"\\nJyn listening on port #{args.ws.port}\"\n","old_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    Server = require '.\/server'\n    args   = require '.\/arguments'\n\n    new Server()\n      .initialize()\n      .then (server) ->\n        server.boot args\n          .then ->\n            console.log \"\\nJyn listening on port #{args.ws.port}\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b7dc0614e975256a71b13a1644c00756f7a70239","subject":"Typo in parser.litcoffee","message":"Typo in parser.litcoffee","repos":"andychase\/date_machine,andychase\/date_machine,andychase\/date_machine,andychase\/date_machine","old_file":"javascript\/parser.litcoffee","new_file":"javascript\/parser.litcoffee","new_contents":"We can assume that higher ordered patterns return more complex results than lower ordered patterns.\nSo if we come across an input like ```Oct. 1-2```, one pattern might match ```Oct. 1```, and another\n```Oct. 1-2```, with the latter having a higher order. Because dateMachine can operates on\nfull text, it's not enough to simply discard all results but the highest ordered one.\nInstead we have to find the best match per section of text.\n\nThe best match is found by removing results that overlap with higher-ordered results.\n\n        overlapping = (start1, end1, start2, end2) ->\n            return not ((start1 <= start2 and start1 <= end2 and end1 <= end2 and end1 <= start2) or\n                        (start1 >= start2 and start1 >= end2 and end1 >= end2 and end1 >= start2))\n\n\n        overlappingAt = (start, end, current) ->\n            output = []\n            for currentIndex of current\n                [_, cStart, cEnd, _] = current[currentIndex]\n\n                if overlapping(cStart, cEnd, start, end)\n                    output.push currentIndex\n            return output\n\n        removeLowerOverlapping = (current, higher) ->\n            [order, hStart, hEnd, match] = higher\n            overlaps = overlappingAt(hStart, hEnd, current)\n            for overlap in overlaps\n                current.splice(overlap, 1)\n            if overlaps.length > 0\n                # Keeps order in place\n                current.splice(overlaps[0], 0, higher)\n            else\n                current.push(higher)\n\n            return current\n\nHelper functions\n\n        asList = (_) -> [].concat(_)\n        getResults = (_) -> (i[3] for i in _)\n        any = (_) -> _? and ((not (_ instanceof Array )) or _.filter((a)->a?).length > 0)\n        getBest = (_) ->\n            getResults(_.reduce(removeLowerOverlapping, []))\n        sortByOrderAscending = (_) -> _.sort((a,b)->a[0]-b[0])\n        getCaptureGroups = (_) -> _.slice(1)\n        matchedTextLength = (_) -> _[0].length\n\n\nThis is the actual parser function, ```this.dateMachine``` should be the only thing exported by dateMachine.js.\n\n        this.dateMachine = (input) ->\n            dateMachineOutput = []\n            for pattern in parserDescription\n                regex = pattern.regex\n                [take, functionName, tree] = pattern.tree\n                while (matches = regex.exec(input)) isnt null\n                    matcherOutput = reparseEmulator(take, functionName, tree, getCaptureGroups(matches), functions)\n\n                    start = regex.lastIndex - matchedTextLength(matches)\n                    end = regex.lastIndex - 1\n                    if any(matcherOutput)\n                        dateMachineOutput.push [pattern.order, start, end, asList(matcherOutput)]\n\n              return getBest(sortByOrderAscending(dateMachineOutput))\n","old_contents":"We can assume that higher ordered patterns return more complex results than lower ordered patterns.\nSo if we come across an input like ```Oct. 1-2```, one pattern might match ```Oct. 1```, and another\n```Oct. 1-2```, with the latter having a higher order. Because dateMachine can operates on\nfull text machines, it's not enough to simply discard all results but the highest ordered one.\nInstead we have to find the best match per section of text.\n\nThe best match is found by removing results that overlap with higher-ordered results.\n\n        overlapping = (start1, end1, start2, end2) ->\n            return not ((start1 <= start2 and start1 <= end2 and end1 <= end2 and end1 <= start2) or\n                        (start1 >= start2 and start1 >= end2 and end1 >= end2 and end1 >= start2))\n\n\n        overlappingAt = (start, end, current) ->\n            output = []\n            for currentIndex of current\n                [_, cStart, cEnd, _] = current[currentIndex]\n\n                if overlapping(cStart, cEnd, start, end)\n                    output.push currentIndex\n            return output\n\n        removeLowerOverlapping = (current, higher) ->\n            [order, hStart, hEnd, match] = higher\n            overlaps = overlappingAt(hStart, hEnd, current)\n            for overlap in overlaps\n                current.splice(overlap, 1)\n            if overlaps.length > 0\n                # Keeps order in place\n                current.splice(overlaps[0], 0, higher)\n            else\n                current.push(higher)\n\n            return current\n\nHelper functions\n\n        asList = (_) -> [].concat(_)\n        getResults = (_) -> (i[3] for i in _)\n        any = (_) -> _? and ((not (_ instanceof Array )) or _.filter((a)->a?).length > 0)\n        getBest = (_) ->\n            getResults(_.reduce(removeLowerOverlapping, []))\n        sortByOrderAscending = (_) -> _.sort((a,b)->a[0]-b[0])\n        getCaptureGroups = (_) -> _.slice(1)\n        matchedTextLength = (_) -> _[0].length\n\n\nThis is the actual parser function, ```this.dateMachine``` should be the only thing exported by dateMachine.js.\n\n        this.dateMachine = (input) ->\n            dateMachineOutput = []\n            for pattern in parserDescription\n                regex = pattern.regex\n                [take, functionName, tree] = pattern.tree\n                while (matches = regex.exec(input)) isnt null\n                    matcherOutput = reparseEmulator(take, functionName, tree, getCaptureGroups(matches), functions)\n\n                    start = regex.lastIndex - matchedTextLength(matches)\n                    end = regex.lastIndex - 1\n                    if any(matcherOutput)\n                        dateMachineOutput.push [pattern.order, start, end, asList(matcherOutput)]\n\n              return getBest(sortByOrderAscending(dateMachineOutput))\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"aa18e77f57413573c9021f4868db7529e13fe102","subject":"App.Route support for Document.scope -> root added","message":"App.Route support for Document.scope -> root added\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/app\/route.litcoffee","new_file":"src\/app\/route.litcoffee","new_contents":"Route @class\n============\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n    log = require 'src\/log'\n    Schema = require 'src\/schema'\n    Networking = require 'src\/networking'\n    Document = require 'src\/document'\n    Renderer = require 'src\/renderer'\n    Dict = require 'src\/dict'\n\n    log = log.scope 'App', 'Route'\n\n    module.exports = (app) -> class Route\n\n        if utils.isNode\n            usedTemplates = []\n        else\n            templates = Object.create null\n\n        lastClientHTMLRoute = null\n\n*Document* Route.getTemplateView(*String* viewName)\n---------------------------------------------------\n\n        @getTemplateView = do ->\n            if utils.isNode\n                (name) ->\n                    scope = app: app, routes: new Dict\n                    tmpl = app.views[name].render null, scope\n                    usedTemplates.push tmpl\n                    tmpl\n            else\n                (name) ->\n                    scope = app: app, routes: new Dict\n                    templates[name] ?= app.views[name].render null, scope\n\n*Route* Route(*Object* options)\n-------------------------------\n\nAccess it with:\n```javascript\nmodule.exports = function(app){\n  var Route = app.Route;\n};\n```\n\nAcceptable syntaxes:\n```javascript\n*Route* app.Route(*String* method, *String* uri, *Object* options)\n*Route* app.Route(*String* methodWithUri, *Function* getData)\n*Route* app.Route(*String* methodWithUri, *Object* options)\n*Route* app.Route(*String* uri, *Function* getData)\n*Route* app.Route(*String* uri, *Object* options)\n*Route* app.Route(*String* method, *String* uri)\n*Route* app.Route(*String* uri)\n*Route* app.Route(*String* methodWithUri)\n```\n\n        constructor: (method, uri, opts) ->\n            if utils.isObject(method)\n                # opts\n                opts = method\n            else if utils.isObject(uri)\n                opts = uri\n            else unless utils.isObject(opts)\n                opts = {}\n\n            if typeof method is 'string' and typeof uri isnt 'string'\n                opts.uri = method\n            else if typeof method is 'string' and typeof uri is 'string'\n                opts.method ?= method\n                opts.uri ?= uri\n            if typeof uri is 'function'\n                opts.getData ?= uri\n\n            assert.isObject opts\n            opts = utils.clone opts\n\n            if typeof opts.uri is 'string'\n                # support methodWithUri e.g. 'get \/home'\n                spaceIndex = opts.uri.indexOf ' '\n                if spaceIndex isnt -1\n                    opts.method ?= opts.uri.slice 0, spaceIndex\n                    opts.uri = opts.uri.slice spaceIndex+1\n                opts.uri = new Networking.Uri opts.uri\n            assert.instanceOf opts.uri, Networking.Uri\n\n            opts.method ?= 'get'\n            assert.isString opts.method\n            opts.method = opts.method.toLowerCase()\n            assert.ok utils.has(Networking.Request.METHODS, opts.method)\n            , \"Networking doesn't provide a `#{opts.method}` method\"\n\n            if opts.schema?\n                if utils.isPlainObject(opts.schema)\n                    opts.schema = new Schema opts.schema\n                assert.instanceOf opts.schema, Schema\n\n            if opts.redirect?\n                if typeof opts.redirect is 'string'\n                    opts.redirect = new Networking.Uri opts.redirect\n                else\n                    assert.isFunction opts.redirect\n\n            if utils.isObject(opts.toHTML)\n                opts.toHTML = createToHTMLFromObject opts.toHTML\n\n            for key, val of opts\n                @[key] = val\n            @__id__ = utils.uid()\n            @app = app\n            @name ||= getRouteName(@)\n\n            app.networking.createHandler\n                method: @method\n                uri: @uri\n                schema: @schema\n                callback: utils.bindFunctionContext(handleRequest, @)\n\n        getRouteName = (route) ->\n            assert.instanceOf route, Route\n\n            uri = route.uri._uri\n            uri = uri.replace Networking.Uri.NAMES_RE, ''\n            uri = uri.replace \/\\*\/g, ''\n            while uri.indexOf('\/\/') isnt -1\n                uri = uri.replace \/\\\/\\\/\/g, '\/'\n            uri = uri.replace \/^\\\/\/, ''\n            uri = uri.replace \/\\\/$\/, ''\n            uri\n\n        routesCache = Object.create null\n        pendingRoutes = Object.create null\n\n        factoryRoute = do ->\n            createInstance = (route) ->\n                r = Object.create route\n                r.__hash__ = utils.uid()\n                r.factory?()\n                r\n\n            (route) ->\n                assert.instanceOf route, Route\n\n                id = route.__id__\n                routesCache[id] ?= []\n                r = routesCache[id].pop() or createInstance(route)\n                r = Object.create r\n                r.request = r.response = null\n                r.route = r\n                r._dataPrepared = false\n                r._destroyViewOnEnd = false\n                r\n\n        destroyRoute = (route) ->\n            assert.instanceOf route, Route\n\n            if lastClientHTMLRoute is route\n                lastClientHTMLRoute = null\n\n            route.response.onSend.disconnect onResponseSent, route\n            pendingRoutes[route.__hash__] = false\n            route.destroy?()\n            if route._dataPrepared\n                switch route.request.type\n                    when 'text'\n                        route.destroyText?()\n                    when 'json'\n                        route.destroyJSON?()\n                    when 'html'\n                        route.destroyHTML?()\n            if route._destroyViewOnEnd\n                route.response.data.destroy()\n            routesCache[route.__id__].push Object.getPrototypeOf(route)\n\n        resolveSyncGetDataFunc = (route) ->\n            assert.instanceOf route, Route\n\n            try\n                data = route.getData()\n                if data?\n                    route.data = data\n            catch err\n                if route.response.status is 200\n                    route.response.status = 500\n                route.error = err\n\n        resolveAsyncGetDataFuncCallback = (route, err, data) ->\n            assert.instanceOf route, Route\n\n            if err?\n                if route.response.status is 200\n                    route.response.status = 500\n                if route._dataPrepared and route.error is err\n                    return false\n                route.error = err\n            else\n                if route._dataPrepared and route.data is data\n                    return false\n                route.data = data\n            true\n\n        prepareRouteData = (route) ->\n            assert.instanceOf route, Route\n            {response} = route\n\n            if route.error\n                log.error \"Error in route '#{route.uri}':\\n#{route.error}\"\n\n            respData = response.data\n            switch route.request.type\n                when 'text'\n                    data = route.toText()\n                when 'json'\n                    data = route.toJSON()\n                when 'html'\n                    data = route.toHTML()\n                    if respData instanceof Document and route._destroyViewOnEnd\n                        respData.destroy()\n                        response.data = null\n                    if not (data instanceof Document) and response.data is respData\n                        data = renderViewFromConfig.call route, data\n            route._dataPrepared = true\n            if data?\n                response.data = data\n            else if response.data is respData\n                response.data = ''\n\n        onResponseSent = ->\n            if utils.isNode or @request.type isnt 'html'\n                destroyRoute @\n\n                if utils.isNode and utils.has(usedTemplates, @response.data)\n                    @response.data.destroy()\n                    utils.remove usedTemplates, @response.data\n            return\n\n        finishRequest = (route) ->\n            assert.instanceOf route, Route\n            if route.response.data instanceof Document\n                Renderer.window.document.node = route.response.data.node\n            if route.response.pending\n                route.response.send()\n            return\n\n        callNextIfNeeded = (route, next) ->\n            unless pendingRoutes[route.__hash__]\n                if route.response.pending\n                    next()\n                return true\n            false\n\n        handleRequest = (req, res, next) ->\n            assert.instanceOf req, Networking.Request\n            assert.instanceOf res, Networking.Response\n            assert.isFunction next\n\n            route = factoryRoute @\n            hash = route.__hash__\n            assert.notOk pendingRoutes[hash]\n\n            if utils.isClient\n                if lastClientHTMLRoute\n                    destroyRoute lastClientHTMLRoute\n                lastClientHTMLRoute = route\n\n            route.request = req\n            route.response = res\n            pendingRoutes[hash] = true\n\n            res.onSend onResponseSent, route\n\n            # init\n            route.init?()\n\n            unless pendingRoutes[hash]\n                return next()\n\n            # redirect\n            {redirect} = route\n            if typeof redirect is 'function'\n                redirect = route.redirect()\n                unless pendingRoutes[hash]\n                    return next()\n            if typeof redirect is 'string'\n                redirect = new Networking.Uri redirect\n            if redirect instanceof Networking.Uri\n                res.redirect redirect.toString(req.params)\n                return\n\n            # getData\n            {getData} = route\n            fakeAsync = false\n            if typeof getData is 'function'\n                if getData.length is 1\n                    route.getData (err, data) ->\n                        fakeAsync = true\n                        if callNextIfNeeded(route, next)\n                            return\n                        unless resolveAsyncGetDataFuncCallback(route, err, data)\n                            return\n                        prepareRouteData route\n                        if callNextIfNeeded(route, next)\n                            return\n                        finishRequest route\n                else\n                    resolveSyncGetDataFunc route\n                    if callNextIfNeeded(route, next)\n                        return\n                    prepareRouteData route\n                    if callNextIfNeeded(route, next)\n                        return\n                    finishRequest route\n            else\n                prepareRouteData route\n                if callNextIfNeeded(route, next)\n                    return\n                finishRequest route\n\n            if not fakeAsync and callNextIfNeeded(route, next)\n                return\n\n*String* Route::method = 'get'\n------------------------------\n\n*Networking.Uri* Route::uri\n---------------------------\n\n*App* Route::app\n----------------\n\n*Route* Route::route\n--------------------\n\n*String* Route::name\n--------------------\n\n*Schema* Route::schema\n----------------------\n\n*Any* Route::data\n-----------------\n\n*Any* Route::error\n------------------\n\n*Function* Route::factory()\n---------------------------\n\n*Function* Route::init()\n------------------------\n\n*Function* Route::getData([*Function* callback])\n------------------------------------------------\n\n*Function* Route::destroy()\n---------------------------\n\n*Function* Route::destroyJSON()\n-------------------------------\n\n*Function* Route::destroyText()\n-------------------------------\n\n*Function* Route::destroyHTML()\n-------------------------------\n\n*Function|Networking.Uri* Route::redirect\n-----------------------------------------\n\n*Networking.Request* Route::request\n-----------------------------------\n\n*Networking.Response* Route::response\n-------------------------------------\n\n*Function* Route::next()\n------------------------\n\n        next: ->\n            assert.ok pendingRoutes[@__hash__]\n            destroyRoute @\n\n*Any* Route::toJSON()\n---------------------\n\n        toJSON: ->\n            if @response.status < 400\n                @data?.toJSON?() or @data\n            else\n                @error.toJSON?() or @error\n\n*String* Route::toText()\n------------------------\n\n        toText: ->\n            if @response.status < 400\n                @data+''\n            else\n                @error+''\n\n*Document* Route::toHTML()\n--------------------------\n\n        routeToString = ->\n            \"#{@method} #{@uri}\"\n\n        getDefaultRouteViewName = ->\n            path = \"views\/#{@name}.html\"\n            if app.views[path]\n                return path\n\n        renderViewFromConfig = (opts) ->\n            viewName = opts?.view or getDefaultRouteViewName.call(@) or 'views\/index.html'\n            tmplName = opts?.template or 'views\/template.html'\n            useName = opts?.use or 'body'\n\n            logtime = log.time 'Render'\n            if viewName isnt tmplName\n                if tmpl = app.views[tmplName]\n                    tmplView = Route.getTemplateView tmplName\n                    tmplView.use useName, null\n                else\n                    log.warn \"Template view '#{tmplName}' can't be found for route '#{routeToString.call(@)}'\"\n            if view = app.views[viewName]\n                r = view.render null, @\n            else\n                log.warn \"View '#{tmplName}' can't be found for route '#{routeToString.call(@)}'\"\n            if tmplView\n                if r?\n                    r = tmplView.use(useName, r)\n                else\n                    r = tmplView\n                if tmplView.root.routes.has(useName)\n                    tmplView.root.routes.pop useName\n                tmplView.root.routes.set useName, @\n                @_destroyViewOnEnd = false\n            else\n                @_destroyViewOnEnd = true\n            log.end logtime\n            r\n\n        createToHTMLFromObject = (opts) ->\n            -> renderViewFromConfig.call @, opts\n\n        toHTML: createToHTMLFromObject\n            view: ''\n            template: ''\n            use: ''\n","old_contents":"Route @class\n============\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n    log = require 'src\/log'\n    Schema = require 'src\/schema'\n    Networking = require 'src\/networking'\n    Document = require 'src\/document'\n    Renderer = require 'src\/renderer'\n    Dict = require 'src\/dict'\n\n    log = log.scope 'App', 'Route'\n\n    module.exports = (app) -> class Route\n\n        if utils.isNode\n            usedTemplates = []\n        else\n            templates = Object.create null\n\n        lastClientHTMLRoute = null\n\n*Document* Route.getTemplateView(*String* viewName)\n---------------------------------------------------\n\n        @getTemplateView = do ->\n            if utils.isNode\n                (name) ->\n                    scope = app: app, routes: new Dict\n                    tmpl = app.views[name].render null, scope\n                    usedTemplates.push tmpl\n                    tmpl\n            else\n                (name) ->\n                    scope = app: app, routes: new Dict\n                    templates[name] ?= app.views[name].render null, scope\n\n*Route* Route(*Object* options)\n-------------------------------\n\nAccess it with:\n```javascript\nmodule.exports = function(app){\n  var Route = app.Route;\n};\n```\n\nAcceptable syntaxes:\n```javascript\n*Route* app.Route(*String* method, *String* uri, *Object* options)\n*Route* app.Route(*String* methodWithUri, *Function* getData)\n*Route* app.Route(*String* methodWithUri, *Object* options)\n*Route* app.Route(*String* uri, *Function* getData)\n*Route* app.Route(*String* uri, *Object* options)\n*Route* app.Route(*String* method, *String* uri)\n*Route* app.Route(*String* uri)\n*Route* app.Route(*String* methodWithUri)\n```\n\n        constructor: (method, uri, opts) ->\n            if utils.isObject(method)\n                # opts\n                opts = method\n            else if utils.isObject(uri)\n                opts = uri\n            else unless utils.isObject(opts)\n                opts = {}\n\n            if typeof method is 'string' and typeof uri isnt 'string'\n                opts.uri = method\n            else if typeof method is 'string' and typeof uri is 'string'\n                opts.method ?= method\n                opts.uri ?= uri\n            if typeof uri is 'function'\n                opts.getData ?= uri\n\n            assert.isObject opts\n            opts = utils.clone opts\n\n            if typeof opts.uri is 'string'\n                # support methodWithUri e.g. 'get \/home'\n                spaceIndex = opts.uri.indexOf ' '\n                if spaceIndex isnt -1\n                    opts.method ?= opts.uri.slice 0, spaceIndex\n                    opts.uri = opts.uri.slice spaceIndex+1\n                opts.uri = new Networking.Uri opts.uri\n            assert.instanceOf opts.uri, Networking.Uri\n\n            opts.method ?= 'get'\n            assert.isString opts.method\n            opts.method = opts.method.toLowerCase()\n            assert.ok utils.has(Networking.Request.METHODS, opts.method)\n            , \"Networking doesn't provide a `#{opts.method}` method\"\n\n            if opts.schema?\n                if utils.isPlainObject(opts.schema)\n                    opts.schema = new Schema opts.schema\n                assert.instanceOf opts.schema, Schema\n\n            if opts.redirect?\n                if typeof opts.redirect is 'string'\n                    opts.redirect = new Networking.Uri opts.redirect\n                else\n                    assert.isFunction opts.redirect\n\n            if utils.isObject(opts.toHTML)\n                opts.toHTML = createToHTMLFromObject opts.toHTML\n\n            for key, val of opts\n                @[key] = val\n            @__id__ = utils.uid()\n            @app = app\n            @name ||= getRouteName(@)\n\n            app.networking.createHandler\n                method: @method\n                uri: @uri\n                schema: @schema\n                callback: utils.bindFunctionContext(handleRequest, @)\n\n        getRouteName = (route) ->\n            assert.instanceOf route, Route\n\n            uri = route.uri._uri\n            uri = uri.replace Networking.Uri.NAMES_RE, ''\n            uri = uri.replace \/\\*\/g, ''\n            while uri.indexOf('\/\/') isnt -1\n                uri = uri.replace \/\\\/\\\/\/g, '\/'\n            uri = uri.replace \/^\\\/\/, ''\n            uri = uri.replace \/\\\/$\/, ''\n            uri\n\n        routesCache = Object.create null\n        pendingRoutes = Object.create null\n\n        factoryRoute = do ->\n            createInstance = (route) ->\n                r = Object.create route\n                r.__hash__ = utils.uid()\n                r.factory?()\n                r\n\n            (route) ->\n                assert.instanceOf route, Route\n\n                id = route.__id__\n                routesCache[id] ?= []\n                r = routesCache[id].pop() or createInstance(route)\n                r = Object.create r\n                r.request = r.response = null\n                r.route = r\n                r._dataPrepared = false\n                r._destroyViewOnEnd = false\n                r\n\n        destroyRoute = (route) ->\n            assert.instanceOf route, Route\n\n            if lastClientHTMLRoute is route\n                lastClientHTMLRoute = null\n\n            route.response.onSend.disconnect onResponseSent, route\n            pendingRoutes[route.__hash__] = false\n            route.destroy?()\n            if route._dataPrepared\n                switch route.request.type\n                    when 'text'\n                        route.destroyText?()\n                    when 'json'\n                        route.destroyJSON?()\n                    when 'html'\n                        route.destroyHTML?()\n            if route._destroyViewOnEnd\n                route.response.data.destroy()\n            routesCache[route.__id__].push Object.getPrototypeOf(route)\n\n        resolveSyncGetDataFunc = (route) ->\n            assert.instanceOf route, Route\n\n            try\n                data = route.getData()\n                if data?\n                    route.data = data\n            catch err\n                if route.response.status is 200\n                    route.response.status = 500\n                route.error = err\n\n        resolveAsyncGetDataFuncCallback = (route, err, data) ->\n            assert.instanceOf route, Route\n\n            if err?\n                if route.response.status is 200\n                    route.response.status = 500\n                if route._dataPrepared and route.error is err\n                    return false\n                route.error = err\n            else\n                if route._dataPrepared and route.data is data\n                    return false\n                route.data = data\n            true\n\n        prepareRouteData = (route) ->\n            assert.instanceOf route, Route\n            {response} = route\n\n            if route.error\n                log.error \"Error in route '#{route.uri}':\\n#{route.error}\"\n\n            respData = response.data\n            switch route.request.type\n                when 'text'\n                    data = route.toText()\n                when 'json'\n                    data = route.toJSON()\n                when 'html'\n                    data = route.toHTML()\n                    if respData instanceof Document and route._destroyViewOnEnd\n                        respData.destroy()\n                        response.data = null\n                    if not (data instanceof Document) and response.data is respData\n                        data = renderViewFromConfig.call route, data\n            route._dataPrepared = true\n            if data?\n                response.data = data\n            else if response.data is respData\n                response.data = ''\n\n        onResponseSent = ->\n            if utils.isNode or @request.type isnt 'html'\n                destroyRoute @\n\n                if utils.isNode and utils.has(usedTemplates, @response.data)\n                    @response.data.destroy()\n                    utils.remove usedTemplates, @response.data\n            return\n\n        finishRequest = (route) ->\n            assert.instanceOf route, Route\n            if route.response.data instanceof Document\n                Renderer.window.document.node = route.response.data.node\n            if route.response.pending\n                route.response.send()\n            return\n\n        callNextIfNeeded = (route, next) ->\n            unless pendingRoutes[route.__hash__]\n                if route.response.pending\n                    next()\n                return true\n            false\n\n        handleRequest = (req, res, next) ->\n            assert.instanceOf req, Networking.Request\n            assert.instanceOf res, Networking.Response\n            assert.isFunction next\n\n            route = factoryRoute @\n            hash = route.__hash__\n            assert.notOk pendingRoutes[hash]\n\n            if utils.isClient\n                if lastClientHTMLRoute\n                    destroyRoute lastClientHTMLRoute\n                lastClientHTMLRoute = route\n\n            route.request = req\n            route.response = res\n            pendingRoutes[hash] = true\n\n            res.onSend onResponseSent, route\n\n            # init\n            route.init?()\n\n            unless pendingRoutes[hash]\n                return next()\n\n            # redirect\n            {redirect} = route\n            if typeof redirect is 'function'\n                redirect = route.redirect()\n                unless pendingRoutes[hash]\n                    return next()\n            if typeof redirect is 'string'\n                redirect = new Networking.Uri redirect\n            if redirect instanceof Networking.Uri\n                res.redirect redirect.toString(req.params)\n                return\n\n            # getData\n            {getData} = route\n            fakeAsync = false\n            if typeof getData is 'function'\n                if getData.length is 1\n                    route.getData (err, data) ->\n                        fakeAsync = true\n                        if callNextIfNeeded(route, next)\n                            return\n                        unless resolveAsyncGetDataFuncCallback(route, err, data)\n                            return\n                        prepareRouteData route\n                        if callNextIfNeeded(route, next)\n                            return\n                        finishRequest route\n                else\n                    resolveSyncGetDataFunc route\n                    if callNextIfNeeded(route, next)\n                        return\n                    prepareRouteData route\n                    if callNextIfNeeded(route, next)\n                        return\n                    finishRequest route\n            else\n                prepareRouteData route\n                if callNextIfNeeded(route, next)\n                    return\n                finishRequest route\n\n            if not fakeAsync and callNextIfNeeded(route, next)\n                return\n\n*String* Route::method = 'get'\n------------------------------\n\n*Networking.Uri* Route::uri\n---------------------------\n\n*App* Route::app\n----------------\n\n*Route* Route::route\n--------------------\n\n*String* Route::name\n--------------------\n\n*Schema* Route::schema\n----------------------\n\n*Any* Route::data\n-----------------\n\n*Any* Route::error\n------------------\n\n*Function* Route::factory()\n---------------------------\n\n*Function* Route::init()\n------------------------\n\n*Function* Route::getData([*Function* callback])\n------------------------------------------------\n\n*Function* Route::destroy()\n---------------------------\n\n*Function* Route::destroyJSON()\n-------------------------------\n\n*Function* Route::destroyText()\n-------------------------------\n\n*Function* Route::destroyHTML()\n-------------------------------\n\n*Function|Networking.Uri* Route::redirect\n-----------------------------------------\n\n*Networking.Request* Route::request\n-----------------------------------\n\n*Networking.Response* Route::response\n-------------------------------------\n\n*Function* Route::next()\n------------------------\n\n        next: ->\n            assert.ok pendingRoutes[@__hash__]\n            destroyRoute @\n\n*Any* Route::toJSON()\n---------------------\n\n        toJSON: ->\n            if @response.status < 400\n                @data?.toJSON?() or @data\n            else\n                @error.toJSON?() or @error\n\n*String* Route::toText()\n------------------------\n\n        toText: ->\n            if @response.status < 400\n                @data+''\n            else\n                @error+''\n\n*Document* Route::toHTML()\n--------------------------\n\n        routeToString = ->\n            \"#{@method} #{@uri}\"\n\n        getDefaultRouteViewName = ->\n            path = \"views\/#{@name}.html\"\n            if app.views[path]\n                return path\n\n        renderViewFromConfig = (opts) ->\n            viewName = opts?.view or getDefaultRouteViewName.call(@) or 'views\/index.html'\n            tmplName = opts?.template or 'views\/template.html'\n            useName = opts?.use or 'body'\n\n            logtime = log.time 'Render'\n            if viewName isnt tmplName\n                if tmpl = app.views[tmplName]\n                    tmplView = Route.getTemplateView tmplName\n                    tmplView.use useName, null\n                else\n                    log.warn \"Template view '#{tmplName}' can't be found for route '#{routeToString.call(@)}'\"\n            if view = app.views[viewName]\n                r = view.render null, @\n            else\n                log.warn \"View '#{tmplName}' can't be found for route '#{routeToString.call(@)}'\"\n            if tmplView\n                if r?\n                    r = tmplView.use(useName, r)\n                else\n                    r = tmplView\n                if tmplView.scope.routes.has(useName)\n                    tmplView.scope.routes.pop useName\n                tmplView.scope.routes.set useName, @\n                @_destroyViewOnEnd = false\n            else\n                @_destroyViewOnEnd = true\n            log.end logtime\n            r\n\n        createToHTMLFromObject = (opts) ->\n            -> renderViewFromConfig.call @, opts\n\n        toHTML: createToHTMLFromObject\n            view: ''\n            template: ''\n            use: ''\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"f5d81465a4f0b36cf194372d99cf251baf7c03f1","subject":"Fix it again.","message":"Fix it again.\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/policies.litcoffee","new_file":"guts\/policies.litcoffee","new_contents":"Libraries\n\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n    policies = require '..\/config\/policies'\n\n    module.exports = (routeActions, req, res) ->\n        new Promise (resolve, reject) ->\n            require('.\/getPolicies')()\n            .then (actualPolicies) ->\n                policyResults = _.flatten _.map routeActions, (action) ->\n                        # What I'm doing here is looking for the policies file.\n                        # If there is a policy defined for that action, use that, else use the * catch all. \n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\n                        _.map tempPolicies, (policy) ->\n                            # This is pretty straightforward; we'll loop up the policy in the hash\n                            # table and then return back their result (which can just be a true or false\n                            #\n                            # We want to make sure this is properly wrapped in promisey stuff, so we can init\n                            # an empty promise then run our stuff in the \"then\". Since our empty promise only\n                            # resolves, it won't hit the catch. \n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n                \n                Promise.all policyResults\n            .then (results) ->\n                # Not entirely sure I like this logic, but it's pretty straightforward:\n                # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                # either allow the policy to reject if not permitted or to simply return false. \n                unless false in results\n                  resolve true\n                else\n                  reject \"Not Authorized\"\n                \n","old_contents":"Libraries\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n    policies = require '..\/config\/policies'\n\n    module.exports = (routeActions, req, res) ->\n        new Promise (resolve, reject) ->\n            require('.\/getPolicies')()\n            .then (actualPolicies) ->\n                policyResults = _.flatten _.map routeActions, (action) ->\n                        # What I'm doing here is looking for the policies file.\n                        # If there is a policy defined for that action, use that, else use the * catch all. \n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\n                        _.map tempPolicies, (policy) ->\n                            # This is pretty straightforward; we'll loop up the policy in the hash\n                            # table and then return back their result (which can just be a true or false\n                            #\n                            # We want to make sure this is properly wrapped in promisey stuff, so we can init\n                            # an empty promise then run our stuff in the \"then\". Since our empty promise only\n                            # resolves, it won't hit the catch. \n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n                \n                Promise.all policyResults\n            .then (results) ->\n                # Not entirely sure I like this logic, but it's pretty straightforward:\n                # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                # either allow the policy to reject if not permitted or to simply return false. \n                unless false in results\n                  resolve true\n                else\n                  reject \"Not Authorized\"\n                \n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"b7375a4dd0b90067d68f2f1dd8b86245c43eb73b","subject":"using global instead of window","message":"using global instead of window","repos":"arximboldi\/heterarchy","old_file":"heterarchy.litcoffee","new_file":"heterarchy.litcoffee","new_contents":"heterarchy\n==========\n\n> This file is part of [Heterarchy](http:\/\/sinusoid.es\/heterarchy).\n> - **View me [on a static web](http:\/\/sinusoid.es\/heterarchy\/heterarchy.html)**\n> - **View me [on GitHub](https:\/\/github.com\/arximboldi\/heterarchy\/blob\/master\/heterarchy.litcoffee)**\n\nAdds multiple inheritance support to CoffeeScript (and JavaScript).\nIt uses the C3 linearization algorithm as described in the [famous\nDylan paper](http:\/\/192.220.96.201\/dylan\/linearization-oopsla96.html).\n\n    {head, tail, map, find, some, without, isEmpty, every, memoize, reject,\n     partial, isEqual} =\n        require 'underscore'\n\n    assert = (value, error) ->\n        if not value\n           throw new Error(if error? then error else \"Assertion failed\")\n\nMultiple inheritance\n--------------------\n\nThe **multi** function takes a list of classes and returns a *special*\nclass object that merges the class hierarchies, as linearized by the\nC3 algorithm. Limitations of the approach are:\n\n- `instanceof` does not always work as expected. For example:\n\n  > ```coffee\n  > class A\n  > class B extends A\n  > class C extends A\n  > class D extends multi B, C\n  > assert new D not instanceof B\n  > ```\n\n  Instead, one should use the provided `isinstance` function.\n\n- Some of the bases of a multi-inherited hierarchy are *frozen* when\n  the sub-class is defined -- i.e. later modifications to the\n  superclass are not visible to the subclass or its instances.  For\n  example, in the previous heterarchy:\n\n  > ```coffee\n  > B::newProperty = 42\n  > assert D::newProperty == undefined\n  > ```\n\nThe `multi` function memoizes its results such that identity is\nmaintained, implying `multi X, Y is multi X, Y`.\n\n    exports.multi = (bases...) ->\n        generate merge map(bases, mro).concat [bases]\n\nThis takes a list of classes representing a hierarchy (from most to\nleast derived) and generates a single-inheritance hierarchy that\nbehaves like a class that would be have such a hierarchy.\n\n    generate = memoize (linearization) ->\n        next = head linearization\n        if isEqual linearization, hierarchy next\n            next\n        else\n            class Result extends generate tail linearization\n                __mro__: linearization\n                constructor: reparent next, @, next::constructor\n                copyOwn next, @\n                copyOwn next::, @::, partial reparent, next, @\n\nThis utility lets us copy own properties of a *from* object that are\nnot own properties of a *to* object into the *to* object, optionally\ntransformed via a projection function.\n\n    copyOwn = (from, to, project = (x) -> x) ->\n        for own key, value of from\n            if not to.hasOwnProperty key\n                to[key] = project value\n        to\n\nMethods in CoffeeScript call super directly, so we have to change the\n`__super__` attribute of the original class during the scope of the\nmethod so it calls the right super of the linearization.  Also,\nprogrammers don't call super in constructor of root classes --indeed\ndoing so would rise an error-- so we have to inject such a call when\nthere are classes after these in the linearization.  The **reparent**\nfunction takes care of all these and given an original class, and the\nnew class that is replacing it a linearized heterarchy, returns a\nwrapped copy of a value of the former that is suitable for replacing\nit in the later.\n\n    reparent = (oldklass, newklass, value) ->\n        if value not instanceof Function\n            value\n        else if value is oldklass::constructor and inherited(oldklass) is Object\n            superctor = inherited(newklass)::constructor\n            ->\n                superctor.apply @, arguments\n                value.apply @, arguments\n        else\n            newsuper = inherited(newklass)::\n            oldsuper = oldklass.__super__\n            ->\n                oldklass.__super__ = newsuper\n                try\n                    value.apply @, arguments\n                finally\n                    oldklass.__super__ = oldsuper\n\nThis is the C3 linearization algorithm, as translated from the\noriginal paper.\n\n    merge = (inputs) ->\n        while not isEmpty inputs\n            next = find (map inputs, head), (candidate) ->\n                every inputs, (input) -> candidate not in tail input\n            assert next?, \"Inconsistent multiple inheritance\"\n            inputs = reject map(inputs, (lst) -> without lst, next), isEmpty\n            next\n\nIntrospection\n-------------\n\nThe **mro** function returns the method resolution order\n(linearization) of a given class:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends B\n> assert mro(C).equals [C, B, A]\n> ```\n\nIt returns the original classes that were mixed in when used with\nmult-inherited classes:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert mro(D).equals [D, B, C, A, Object]\n> ```\n\n    isJavaScriptClass = (cls) ->\n        standardClasses = [\n            Array\n            Boolean\n            Date\n            Error\n            Function\n            Number\n            RegExp\n            String\n            Object\n            EvalError\n            RangeError\n            ReferenceError\n            SyntaxError\n            TypeError\n            URIError\n        ]\n\n        if cls in standardClasses\n            true\n        else\n            # according to https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\n            nonStandardClasses = [\n                \"Symbol\"\n                # typed arrays\n                \"Int8Array\"\n                \"Uint8Array\"\n                \"Uint8ClampedArray\"\n                \"Int16Array\"\n                \"Uint16Array\"\n                \"Int32Array\"\n                \"Uint32Array\"\n                \"Float32Array\"\n                \"Float64Array\"\n                # keyed Keyed collections\n                \"Map\"\n                \"Set\"\n                \"WeakMap\"\n                \"WeakSet\"\n                # Structured data\n                \"ArrayBuffer\"\n                \"DataView\"\n                # Control abstraction objects\n                \"Promise\"\n                \"Generator\"\n                \"GeneratorFunction\"\n                # Reflection\n                \"Reflect\"\n                \"Proxy\"\n            ]\n            for nonStandardClass in nonStandardClasses when cls is global[nonStandardClass]\n                return true\n            false\n\n    exports.mro = mro = (cls) ->\n        if not cls? or not cls::?\n            []\n        else if not cls::hasOwnProperty '__mro__'\n            result = [cls].concat mro inherited(cls)\n            cls::__mro__ = result unless isJavaScriptClass cls\n            result\n        else\n            cls::__mro__\n\nThe **inherited** function returns the CoffeeScript superclass of an\nobject, for example:\n\n> ```coffee\n> class A\n> class B extends A\n> assert inherited(B) == A\n> ```\n\nNote that for multiple inherited classes, this returns the mixed\nobject, not the next class in the MRO, as in:\n\n> ```coffee\n> class C extends multi A, B\n> assert inherited(C) == multi(A, B)\n> ```\n\n    exports.inherited = inherited = (cls) ->\n        Object.getPrototypeOf(cls.prototype)?.constructor\n\nThe **hierarchy** returns the CoffeeScript hierarchy of classes of a\ngiven class, including the class itself.  For multiple inherited\nclasses, it may return speciall classes that were generated to produce\nthe flattening, as in:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert not mro(D).equals hierarchy(D)\n> assert hierarchy(D).equals\n>     [ D, multi(B, C), inherited(multi B, C), A, Object ]\n> ```\n\n    exports.hierarchy = hierarchy = (cls) ->\n        if not cls?\n            []\n        else\n            [cls].concat hierarchy inherited cls\n\nThe **isinstance** function takes an object and a class or classes and\nreturns whether the object is an instance of any of those classes. It\nis compatible with multi-inherited classes.\n\n    exports.isinstance = (obj, classes...) ->\n        exports.issubclass obj?.constructor, classes...\n\nThe **issubclass** tells whether a class is a subtype of another type.\n\n    exports.issubclass = (klass, classes...) ->\n        linearization = mro klass\n        some classes, (cls) -> cls in linearization\n\nLicense\n-------\n\n> Copyright (c) 2013, 2015 Juan Pedro Bolivar Puente <raskolnikov@gnu.org>\n>\n> Permission is hereby granted, free of charge, to any person obtaining a copy\n> of this software and associated documentation files (the \"Software\"), to deal\n> in the Software without restriction, including without limitation the rights\n> to use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\n> copies of the Software, and to permit persons to whom the Software is\n> furnished to do so, subject to the following conditions:\n>\n> The above copyright notice and this permission notice shall be included in\n> all copies or substantial portions of the Software.\n>\n> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n> THE SOFTWARE.\n","old_contents":"heterarchy\n==========\n\n> This file is part of [Heterarchy](http:\/\/sinusoid.es\/heterarchy).\n> - **View me [on a static web](http:\/\/sinusoid.es\/heterarchy\/heterarchy.html)**\n> - **View me [on GitHub](https:\/\/github.com\/arximboldi\/heterarchy\/blob\/master\/heterarchy.litcoffee)**\n\nAdds multiple inheritance support to CoffeeScript (and JavaScript).\nIt uses the C3 linearization algorithm as described in the [famous\nDylan paper](http:\/\/192.220.96.201\/dylan\/linearization-oopsla96.html).\n\n    {head, tail, map, find, some, without, isEmpty, every, memoize, reject,\n     partial, isEqual} =\n        require 'underscore'\n\n    assert = (value, error) ->\n        if not value\n           throw new Error(if error? then error else \"Assertion failed\")\n\nMultiple inheritance\n--------------------\n\nThe **multi** function takes a list of classes and returns a *special*\nclass object that merges the class hierarchies, as linearized by the\nC3 algorithm. Limitations of the approach are:\n\n- `instanceof` does not always work as expected. For example:\n\n  > ```coffee\n  > class A\n  > class B extends A\n  > class C extends A\n  > class D extends multi B, C\n  > assert new D not instanceof B\n  > ```\n\n  Instead, one should use the provided `isinstance` function.\n\n- Some of the bases of a multi-inherited hierarchy are *frozen* when\n  the sub-class is defined -- i.e. later modifications to the\n  superclass are not visible to the subclass or its instances.  For\n  example, in the previous heterarchy:\n\n  > ```coffee\n  > B::newProperty = 42\n  > assert D::newProperty == undefined\n  > ```\n\nThe `multi` function memoizes its results such that identity is\nmaintained, implying `multi X, Y is multi X, Y`.\n\n    exports.multi = (bases...) ->\n        generate merge map(bases, mro).concat [bases]\n\nThis takes a list of classes representing a hierarchy (from most to\nleast derived) and generates a single-inheritance hierarchy that\nbehaves like a class that would be have such a hierarchy.\n\n    generate = memoize (linearization) ->\n        next = head linearization\n        if isEqual linearization, hierarchy next\n            next\n        else\n            class Result extends generate tail linearization\n                __mro__: linearization\n                constructor: reparent next, @, next::constructor\n                copyOwn next, @\n                copyOwn next::, @::, partial reparent, next, @\n\nThis utility lets us copy own properties of a *from* object that are\nnot own properties of a *to* object into the *to* object, optionally\ntransformed via a projection function.\n\n    copyOwn = (from, to, project = (x) -> x) ->\n        for own key, value of from\n            if not to.hasOwnProperty key\n                to[key] = project value\n        to\n\nMethods in CoffeeScript call super directly, so we have to change the\n`__super__` attribute of the original class during the scope of the\nmethod so it calls the right super of the linearization.  Also,\nprogrammers don't call super in constructor of root classes --indeed\ndoing so would rise an error-- so we have to inject such a call when\nthere are classes after these in the linearization.  The **reparent**\nfunction takes care of all these and given an original class, and the\nnew class that is replacing it a linearized heterarchy, returns a\nwrapped copy of a value of the former that is suitable for replacing\nit in the later.\n\n    reparent = (oldklass, newklass, value) ->\n        if value not instanceof Function\n            value\n        else if value is oldklass::constructor and inherited(oldklass) is Object\n            superctor = inherited(newklass)::constructor\n            ->\n                superctor.apply @, arguments\n                value.apply @, arguments\n        else\n            newsuper = inherited(newklass)::\n            oldsuper = oldklass.__super__\n            ->\n                oldklass.__super__ = newsuper\n                try\n                    value.apply @, arguments\n                finally\n                    oldklass.__super__ = oldsuper\n\nThis is the C3 linearization algorithm, as translated from the\noriginal paper.\n\n    merge = (inputs) ->\n        while not isEmpty inputs\n            next = find (map inputs, head), (candidate) ->\n                every inputs, (input) -> candidate not in tail input\n            assert next?, \"Inconsistent multiple inheritance\"\n            inputs = reject map(inputs, (lst) -> without lst, next), isEmpty\n            next\n\nIntrospection\n-------------\n\nThe **mro** function returns the method resolution order\n(linearization) of a given class:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends B\n> assert mro(C).equals [C, B, A]\n> ```\n\nIt returns the original classes that were mixed in when used with\nmult-inherited classes:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert mro(D).equals [D, B, C, A, Object]\n> ```\n\n    isJavaScriptClass = (cls) ->\n        standardClasses = [\n            Array\n            Boolean\n            Date\n            Error\n            Function\n            Number\n            RegExp\n            String\n            Object\n            EvalError\n            RangeError\n            ReferenceError\n            SyntaxError\n            TypeError\n            URIError\n        ]\n\n        if cls in standardClasses\n            true\n        else\n            # according to https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\n            nonStandardClasses = [\n                \"Symbol\"\n                # typed arrays\n                \"Int8Array\"\n                \"Uint8Array\"\n                \"Uint8ClampedArray\"\n                \"Int16Array\"\n                \"Uint16Array\"\n                \"Int32Array\"\n                \"Uint32Array\"\n                \"Float32Array\"\n                \"Float64Array\"\n                # keyed Keyed collections\n                \"Map\"\n                \"Set\"\n                \"WeakMap\"\n                \"WeakSet\"\n                # Structured data\n                \"ArrayBuffer\"\n                \"DataView\"\n                # Control abstraction objects\n                \"Promise\"\n                \"Generator\"\n                \"GeneratorFunction\"\n                # Reflection\n                \"Reflect\"\n                \"Proxy\"\n            ]\n            for nonStandardClass in nonStandardClasses when cls is window[nonStandardClass]\n                return true\n            false\n\n    exports.mro = mro = (cls) ->\n        if not cls? or not cls::?\n            []\n        else if not cls::hasOwnProperty '__mro__'\n            result = [cls].concat mro inherited(cls)\n            cls::__mro__ = result unless isJavaScriptClass cls\n            result\n        else\n            cls::__mro__\n\nThe **inherited** function returns the CoffeeScript superclass of an\nobject, for example:\n\n> ```coffee\n> class A\n> class B extends A\n> assert inherited(B) == A\n> ```\n\nNote that for multiple inherited classes, this returns the mixed\nobject, not the next class in the MRO, as in:\n\n> ```coffee\n> class C extends multi A, B\n> assert inherited(C) == multi(A, B)\n> ```\n\n    exports.inherited = inherited = (cls) ->\n        Object.getPrototypeOf(cls.prototype)?.constructor\n\nThe **hierarchy** returns the CoffeeScript hierarchy of classes of a\ngiven class, including the class itself.  For multiple inherited\nclasses, it may return speciall classes that were generated to produce\nthe flattening, as in:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert not mro(D).equals hierarchy(D)\n> assert hierarchy(D).equals\n>     [ D, multi(B, C), inherited(multi B, C), A, Object ]\n> ```\n\n    exports.hierarchy = hierarchy = (cls) ->\n        if not cls?\n            []\n        else\n            [cls].concat hierarchy inherited cls\n\nThe **isinstance** function takes an object and a class or classes and\nreturns whether the object is an instance of any of those classes. It\nis compatible with multi-inherited classes.\n\n    exports.isinstance = (obj, classes...) ->\n        exports.issubclass obj?.constructor, classes...\n\nThe **issubclass** tells whether a class is a subtype of another type.\n\n    exports.issubclass = (klass, classes...) ->\n        linearization = mro klass\n        some classes, (cls) -> cls in linearization\n\nLicense\n-------\n\n> Copyright (c) 2013, 2015 Juan Pedro Bolivar Puente <raskolnikov@gnu.org>\n>\n> Permission is hereby granted, free of charge, to any person obtaining a copy\n> of this software and associated documentation files (the \"Software\"), to deal\n> in the Software without restriction, including without limitation the rights\n> to use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\n> copies of the Software, and to permit persons to whom the Software is\n> furnished to do so, subject to the following conditions:\n>\n> The above copyright notice and this permission notice shall be included in\n> all copies or substantial portions of the Software.\n>\n> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n> THE SOFTWARE.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fa48c1134802beda69285772ed72752176d63677","subject":"Server side express works (partially) for separated modules","message":"Server side express works (partially) for separated modules\n","repos":"ojjs\/oj","old_file":"server.litcoffee","new_file":"server.litcoffee","new_contents":"\nserver.coffee\n==============================================================================\nStatic website creator for oj and the npm module\nExpress templating engine and middleware\n\n  Include common modules\n\n    for m in ['path', 'fs', 'vm']\n      global[m] = require m\n\n  Include dependencies\n\n    _ = require 'underscore'\n    coffee = require 'coffee-script'\n    url = require 'url'\n    mkdirp = require 'mkdirp'\n    csso = require 'csso'\n    uglifyjs = require 'uglify-js'\n\n  Static site creation runs in the context of the dom and jQuery\n\n    jsdom = (require 'jsdom').jsdom\n    global.jQuery = global.$ = require 'jquery'\n    global.document = jsdom \"<html><head><\/head><body><\/body><\/html>\"\n    global.window = document.createWindow()\n\nExport Server Side OJ\n-------------------------------------------------------------------------------\n\n  Include the client library in this module\n\n    oj = require '..\/oj'\n\n  Indicate it is server side\n\n    oj.isClient = false\n\n  Export this module\n\n    module.exports = oj\n\n  Make sure jquery is hooked up\n\n    oj.$ = global.$\n\n  Store console codes for color logging\n\n    oj.codes =\n      reset: '\\u001b[0m'\n      black: '\\u001b[30m'\n      red: '\\u001b[31m'\n      green: '\\u001b[32m'\n      yellow: '\\u001b[33m'\n      blue: '\\u001b[34m'\n      magenta: '\\u001b[35m'\n      cyan: '\\u001b[36m'\n      gray: '\\u001b[37m'\n\nRegister require.extension for .oj and .ojc file types\n-------------------------------------------------------------------------------\n\n    if require.extensions\n\n      coffee = require 'coffee-script'\n\n      stripBOM = (c) -> if c.charCodeAt(0) == 0xFEFF then (c.slice 1) else c\n      wrapJS = (code) ->\n        \"(function(){with(oj.sandbox){#{code}}}).call(this);\"\n      wrapCSMessage = (message, filepath) ->\n        \"#{oj.codes?.red}coffee-script error in #{filepath}: #{message}#{oj.codes?.reset}\"\n      wrapJSMessage = (message, filepath) ->\n        \"#{oj.codes?.red}javascript error in #{filepath}: #{message}#{oj.codes?.reset}\"\n      compileJS = (module, code, filepath) ->\n        code = wrapJS code\n        global.oj = oj\n        module._compile code, filepath\n        delete global.oj\n\n  Compile .oj files as javascript\n\n      require.extensions['.oj'] = (module, filepath) ->\n        # Ensure absolute paths are found correctly for oj file types\n        if filepath[0] == '\/' && filepath != module.filename\n          filepath = module.filename\n\n        # Read the file\n        code = stripBOM fs.readFileSync filepath, 'utf8'\n        try\n          compileJS module, code, filepath\n        catch eJS\n          eJS.message = wrapJSMessage eJS.message, filepath\n          throw eJS\n\n  Compile .js files with absolute paths\n\n      _extensionJS = require.extensions['.js']\n      require.extensions['.js'] = (module, filePath) ->\n        # Ensure absolute paths are found correctly for oj file types\n        if filePath[0] == '\/' && filePath != module.filename\n          filePath = module.filename\n        _extensionJS module, filePath\n\n  Compile .ojc files as coffee-script\n\n      require.extensions['.ojc'] = (module, filepath) ->\n        # Ensure absolute paths are found correctly for oj file types\n        if filepath[0] == '\/' && filepath != module.filename\n          filepath = module.filename\n\n        code = stripBOM fs.readFileSync filepath, 'utf8'\n\n        # Compile in coffee-script\n        try\n          code = coffee.compile code, bare: true\n        catch eCoffee\n          eCoffee.message = wrapCSMessage eCoffee.message, filepath\n          throw eCoffee\n\n        # Compile javascript\n        try\n          compileJS module, code, filepath\n\n        catch eJS\n          eJS.message = wrapJSMessage eJS.message, filepath\n          throw eJS\n\nCommands\n==============================================================================\n\noj.watch\n------------------------------------------------------------------------------\nWatch list of files or directories\n\n    oj.watch = (filesOrDirectories, options) ->\n      options = _.extend {}, options,\n        args: filesOrDirectories\n        watch: true\n        write: true\n      oj.command options\n\noj.build\n------------------------------------------------------------------------------\nBuild list of files or directories\n\n    oj.build = (filesOrDirectories, options) ->\n      options = _.extend {}, options,\n        args: filesOrDirectories\n        watch: false\n        write: true\n      oj.command options\n\noj.command\n------------------------------------------------------------------------------\n\nRemember verbosity level\n\n    verbosity = null\n\noj.command options:\n\n  * args: list of files or directories\n  * debug: bool\n  * watch: bool\n  * recurse: bool\n  * output: directory\/path\n  * modules: list of strings to include manually\n  * verbose: level\n  * html: Only output html\n  * css: Only output css\n  * js: Only output page js (no modules)\n  * modules: Only output modules (no page rendering)\n\nDefine command\n\n    oj.command = (options = {}) ->\n\n      verbosity = options.verbose || 1\n      options.watch ?= false    # Watch for changes and recompile\n      options.write ?= true     # Output to a file\n      options.recurse ?= true   # Recurse in sub directories\n      options.include ?= []     # Include modules\n      options.exclude ?= []     # Exclude modules\n\n  Default to all when no output options are specified\n\n      options.html ?= false\n      options.css ?= false\n      options.js ?= false\n      options.modules ?= false\n\n      if options.all or (!options.html and !options.css and !options.js and !options.modules)\n        options.modules = options.js = options.css = options.html = true\n\n  Resolve directory args to full path and append \/ to ensure path prefixes refer to directories\n\n      options.output = (path.resolve process.cwd(), (options.output ? www)) + '\/'\n\n      if options.modulesDir\n        options.modulesDir = (path.resolve process.cwd(), (options.modulesDir ? '.\/modules')) + '\/'\n\n  cssDir is optional\n\n      if options.cssDir\n        options.cssDir = (path.resolve process.cwd(), options.cssDir) + '\/'\n\n  Verify output directory isn't the root directory\n\n      if options.output == process.cwd()\n        error('oj: output directory cannot be current directory')\n        return\n\n  Verify args exist\n\n      throw new Error('oj: no args found') unless (_.isArray options.args) and options.args.length > 0\n\n  Convert args to full paths\n\n      options.args = fullPaths options.args, process.cwd()\n\n      for fullPath in options.args\n        compilePath fullPath, options\n\n      return\n\ncompilePath\n------------------------------------------------------------------------------\nCompile any file or directory path\n\n    compilePath = (fullPath, options = {}, cb = ->) ->\n      if isDirectory fullPath\n        return compileDir fullPath, options, cb\n      includeDir = path.dirname fullPath\n      compileFile fullPath, includeDir, options, cb\n\ncompileDir\n------------------------------------------------------------------------------\n\n    compileDir = (dirPath, options = {}, cb = ->) ->\n      # Handle recursion and gather files to watch and compile\n      lsWatch dirPath, options, (err, files, dirs) ->\n        # Watch all directories if option is set\n        if options.watch\n          for d in dirs\n            watchDir d, dirPath, options\n\n        # Call cb when it has been called length times\n        _cb = _.after files.length, cb\n\n        for f in files\n\n          # Compile and watch all pages\n          if isOJPage f\n            compileFile f, dirPath, options, _cb\n\n          # Watch files that aren't pages\n          else if options.watch\n            watchFile f, dirPath, options\n            _cb()\n        return\n      return\n\nnodeModulePaths: Determine node_module paths from a given path\n------------------------------------------------------------------------------\nImplementation is from node.js' Module._nodeModulePaths\nThis is not a public API so it seemed to horrible.\n\n    nodeModulePaths = (from) ->\n      from = path.resolve from\n      splitRe = (if process.platform == 'win32' then  \/[\\\/\\\\]\/ else \/\\\/\/)\n      joiner = (if process.platform == 'win32' then '\\\\' else '\/')\n      paths = []\n      parts = from.split splitRe\n      for tip in [(parts.length-1)..0]\n\n  Don't search in ...\/node_modules\/node_modules\n\n        if parts[tip] == 'node_modules'\n          continue\n        dir = parts.slice(0, tip + 1).concat('node_modules').join(joiner)\n        paths.push(dir)\n      paths\n\n    # Recursively get final link path\n    resolveLink = (linkPath, out) ->\n      try\n        newPath = fs.readlinkSync linkPath\n        return (resolveLink newPath, newPath)\n      catch e\n      out\n\n  Get module mapping from link dest to link source\n  \/some\/path\/linked-module  -> \/another\/path\/node_modules\/linked-module\n\n    nodeModulesLinkMap = (fileDir) ->\n      dirs = nodeModulePaths fileDir\n      out = {}\n      for dir in dirs\n        try\n          modules = fs.readdirSync dir\n          for moduleName in modules\n            modulePath = path.join dir, moduleName\n            linkPath = resolveLink modulePath\n            if linkPath?\n              out[linkPath] = modulePath\n        catch e\n      out\n\n    # basenameForExtensions: Get basename for multiple extensions\n    basenameForExtensions = (p, arrayOfExt = []) ->\n      out = path.basename p\n      for ext in arrayOfExt\n        out = path.basename out, ext\n      out\n\ncompileFile\n------------------------------------------------------------------------------\n\n    compileFile = (filePath, includeDir, options = {}, cb = ->) ->\n\n      options = _.clone options\n\n      # Time this method\n      startTime = process.hrtime()\n\n      # Clear underscore as modules might need it\n      _clearRequireCacheRecord 'underscore'\n\n      options.exclude ?= []\n\n      throw new Error('oj: file not found') unless isFile filePath\n\n      # Default some values\n      isMinify = options.minify ? false\n\n      includedModules = options.include or []\n      includedModules = includedModules.concat ['oj', 'jquery']\n\n      rootDir = options.root or path.dirname filePath\n      fileDir = path.dirname filePath\n\n      # Directory specifications win over options every time\n      if options.modulesDir and _startsWith filePath, options.modulesDir\n        options.modules = true\n        options.css = false\n        options.html = false\n        options.js = false\n      else if options.cssDir and _startsWith filePath, options.cssDir\n        options.modules = false\n        options.css = true\n        options.html = false\n        options.js = false\n\n      throw new Error('oj: root is not a directory') unless isDirectory rootDir\n\n      # Watch file if option is set\n      if options.watch\n        watchFile filePath, includeDir, options\n\n      verbose 2, \"compiling #{filePath}\"\n\n      # Cache of modules, files, and native modules\n      cache = modules:{}, files:{}, native:{}\n\n      # Determine global modules with soft linking\n      moduleLinkMap = nodeModulesLinkMap fileDir\n\n      # Hook require to intercept requires in oj files\n      modules = {}\n      moduleParents = {}  # map file name to parent list\n      hookCache = {}\n      hookOriginalCache = {}\n      _hookRequire modules, moduleLinkMap, hookCache, hookOriginalCache\n\n      # Save require cache to restore it later\n      _saveRequireCache()\n\n      # Remove excluded\n      if _.isArray options.exclude\n        for ex in options.exclude\n          verbose 3, \"excluding #{ex}\"\n        includedModules = _.difference includedModules, options.exclude\n\n      # Catch messages thrown by requiring\n      try\n\n        # Require user defined modules\n        for m in includedModules\n          if isNodeModule m\n            _buildNativeCacheFromModuleList cache.native, [m], isMinify\n          else\n            verbose 3, \"including #{m}\"\n            require m\n\n        # Require this file to start the process\n        ojml = require filePath\n\n      # Abort require with message on failure\n      catch eRequire\n        verbose 1, eRequire.message\n\n        # Unwind ourselves from require before failing\n        _restoreRequireCache()\n        _unhookRequire modules, hookCache, hookOriginalCache\n        return\n\n      # Restore require cache\n      _restoreRequireCache()\n      _unhookRequire modules, hookCache, hookOriginalCache\n\n      # Watch needs records of file dependencies\n      _rememberModuleDependencies modules\n\n  Compile css if --css is set\n\n      cssOption = !!options.css\n\n  Compile html only if --html is set\n\n      htmlOption = !!options.html\n\n  Create compile options\n\n      compileOptions = minify:isMinify, html:htmlOption, cssMap:cssOption, css:cssOption, dom:false\n      # Catch the messages thrown by compiling ojml\n      try\n        # Compile\n        results = oj.compile compileOptions, ojml\n      catch eCompile\n        error \"runtime error in #{filePath}: #{eCompile.message}\"\n        return\n\n      # Build cache\n      verbose 3, \"caching #{filePath} (#{_length modules} files)\"\n      cache = _buildRequireCache modules, cache, isMinify\n\n  Calculate file locations for outputing\n\n      # (assuming filePath is \/input\/dir\/file.oj)\n      # fileBaseName = file\n      fileBaseName = basenameForExtensions filePath, ['.oj', '.ojc', 'ojlc']\n      # outputDir = \/output\n      outputDir = options.output || process.cwd()\n      # fileDir = \/input\/dir\n      fileDir = path.dirname filePath\n      # subDir = \/dir\n      subDir = path.relative includeDir, fileDir\n\n  Calculate the file extension. Default is .html\n\n      extOut = '.html'\n\n  Use .css if only --css is specified\n\n      if options.css and not (options.html or options.js or options.modules)\n        extOut = '.css'\n\n  Use .js if css and html aren't specified\n\n      else if (options.js or options.modules) and not (options.html or options.css)\n        extOut = '.js'\n\n  Calculate file path to output to\n\n      # fileOut = \/output\/dir\/file.html\n      fileOut = path.join outputDir, subDir, fileBaseName + extOut\n\n  Extend info to calculate output file locations and other meta data\n\n      options.info = _.extend {},\n        includeDir: includeDir\n        # Profiling data\n        startTime: startTime\n        # Results of compile\n        results: results\n        # Module cache\n        cache: cache\n        filePath: filePath\n        fileDir: fileDir\n        fileBaseName: fileBaseName\n        outputDir: outputDir\n        subDir: subDir\n        extOut: extOut\n        fileOut: fileOut\n        isMinify: isMinify\n\n      _outputFile options, cb\n\n      return\n\n    # _outputFile:\n    # Generic output file function that takes cached state and options and does the right thing\n    # including options for:\n    #   options.write:false output to callback instead of file\n    # ------------------------------------------------------------------------------\n    _outputFile = (options, cb) ->\n      # Output html only as a .html\n      if options.html and not (options.css or options.js or options.modules)\n        _outputHtml options, cb\n      # Output css as a .css file\n      else if options.css and not (options.html or options.js or options.modules)\n        _outputCss options, cb\n      # Output js, modules or both as a .js file\n      else if (options.js or options.modules) and not (options.html or options.css)\n        _outputJs options, cb\n      # Output some combination of html,css,js and modules in a .html file\n      else\n        _outputCombinedHtml options, cb\n\n    # outputUnifed\n    # ------------------------------------------------------------------------------\n\n    _outputCombinedHtml = (options, cb) ->\n\n      info = options.info\n      results = info.results\n      filePath = info.filePath\n      fileOut = info.fileOut\n      html = results.html\n      cssMap = results.cssMap\n      cache = info.cache\n      cacheLength = _length(cache.files) + _length(cache.modules) + _length(cache.native)\n      verbose 3, \"serializing #{filePath} (#{cacheLength} files)\"\n      scriptHtml = _requireCacheToHtml cache, filePath, options.minify ? false, options\n\n      if !results.tags.html\n        error \"validation error #{filePath}: <html> tag is missing\"\n        return\n\n      else if !results.tags.head\n        error \"validation error #{filePath}: <head> tag is missing\"\n        return\n\n      else if !results.tags.body\n        error \"validation error #{filePath}: <body> tag is missing\"\n        return\n\n      # TODO: Should we auto-insert doctype 5?\n      # Insert script before <\/body> or before <\/html> or at the end\n      scriptIndex = html.lastIndexOf '<\/body>'\n      html = _insertAt html, scriptIndex, scriptHtml\n\n      # Insert styles before <\/head> or after <html> or at the beginning\n      styleIndex = html.indexOf '<\/head>'\n      styleHTML = ''\n      for plugin,mediaMap of results.cssMap\n        styleHTML += oj._styleTagFromMediaObject plugin, mediaMap, options\n      html = _insertAt html, styleIndex, styleHTML\n\n      _outputDataToFileOrCallback html, options, cb\n\n    # _outputCss\n    # ------------------------------------------------------------------------------\n\n    _outputCss = (options, cb) ->\n      _outputDataToFileOrCallback options.info.results.css, options, cb\n\n    # _outputHtml\n    # ------------------------------------------------------------------------------\n    _outputHtml = (options, cb) ->\n      _outputDataToFileOrCallback options.info.results.html, options, cb\n\n    # _outputJs\n    # ------------------------------------------------------------------------------\n    _outputJs = (options, cb) ->\n      info = options.info\n      js = _requireCacheToJS info.cache, info.filePath, info.isMinify, options\n      _outputDataToFileOrCallback js, options, cb\n\n    # _outputDataToFileOrCallback\n    # ------------------------------------------------------------------------------\n    # Output data to the fileOut location taking into account options.write flag\n    # If options.write is set the file is outputed otherwise it is sent only to the cb\n    _outputDataToFileOrCallback = (data, options, cb) ->\n\n      info = options.info\n      fileOut = info.fileOut\n\n      filePath = info.filePath\n      fileOut = info.fileOut\n\n      # Create directory\n      dirOut = path.dirname fileOut\n      if mkdirp.sync dirOut\n        verbose 3, \"mkdir #{dirOut}\"\n\n      timeStamp = _timeStampFromStartTime info.startTime\n\n      # Write file\n      if options.write\n\n        fs.writeFile fileOut, data, (err) ->\n          if err\n            error \"file writing error #{filePath}: #{err}\"\n            return\n\n          verbose 1, \"compiled #{fileOut}#{timeStamp}\", 'cyan'\n          cb(null, data)\n          return\n      else\n        verbose 1, \"compiled #{fileOut}#{timeStamp}\", 'cyan'\n        cb(null, data)\n\n    _timeStampFromStartTime = (startTime) ->\n      deltaTime = process.hrtime(startTime)\n      timeStamp = \" (#{deltaTime[0] + Math.round(10000*deltaTime[1]\/1000000000)\/10000} sec)\"\n\n    # Keep track of which files are watched\n    watchCache = {}\n    isWatched = (fullPath) ->\n      watchCache[fullPath]?\n    triggerWatched = (fullPath) ->\n      watchCache[fullPath]?._events?.change?()\n    # Keep track of dependency tree of files\n    watchParents = {}\n\n    # watchFile\n    # ------------------------------------------------------------------------------\n\n    watchFile = (filePath, includeDir, options = {}) ->\n      # Do nothing if this file is already watched\n      return if isWatched filePath\n\n      prevStats = null\n      compileTimeout = null\n\n      _watchErr = (e) ->\n        if e.code is 'ENOENT'\n          try\n            _rewatch()\n            _compile()\n          catch e\n            verbose 2, \"unwatching missing file: #{filePath}\", 'yellow'\n            _unwatch()\n        else throw e\n\n      timeLast = new Date(2000)\n      timeEpsilon = 2 # milliseconds\n\n      _onWatch = ->\n        try\n          clearTimeout compileTimeout\n          compileTimeout = wait 0.025, ->\n\n            # Ignore recompiles within epsilon time\n            timeNow = new Date()\n            return if (timeNow - timeLast) \/ 1000 < timeEpsilon\n            timeLast = timeNow\n\n            # Files that aren't pages should trigger their parents\n            if not isOJPage filePath\n              parents = watchParents[filePath]\n              if parents?\n                for parent in parents\n                  triggerWatched parent\n\n            # Files that are pages should recompile\n            else\n              fs.stat filePath, (err, stats) ->\n                return _watchErr err if err\n                verbose 2, \"updating file #{filePath}\", 'yellow'\n                compileFile filePath, includeDir, options\n\n        catch e\n          verbose 1, 'unknown watch error on #{filePath}'\n          _unwatch()\n      try\n        verbose 2, \"watching file #{filePath}\", 'yellow'\n        watcher = fs.watch filePath, _onWatch\n        watchCache[filePath] = watcher\n      catch e\n        _watchErr e\n\n      _rewatch = ->\n        verbose 3, \"rewatch file #{filePath}\", 'yellow'\n        _unwatch()\n\n        watchCache[filePath] = watcher = fs.watch filePath, _onWatch\n\n      _unwatch = ->\n        if isWatched filePath\n          watchCache[filePath].close()\n        watchCache[filePath] = null\n\nwatchDir\n------------------------------------------------------------------------------\nWatch a directory of files for new additions.\nThis method does not recurse as it is called from methods that do (compileDir)\n\n    watchDir = (dir, includeDir, options) ->\n\n      # Short circuit if already watching this directory\n      return if isWatched dir\n\n      # Throttle\n      compileTimeout = null\n\n      verbose 2, \"watching directory #{dir}\/\", 'yellow'\n      watcher = fs.watch dir, (err) ->\n        verbose 2, \"updating directory #{dir}\/\", 'yellow'\n\n        # Unwatch missing directories\n        if err and not isDirectory dir\n          return unwatchDir dir\n\n        # When the directory changes a file may have been added or removed\n        # Watch all the directories and files that aren't currently being watched\n        lsOJ dir, options, (err, files, dirs) ->\n          for d in dirs\n            if not isWatched d\n              watchDir d\n          for f in files\n            if not isWatched f\n              compileFile f, includeDir, options\n\n      # Cache watch\n      watchCache[dir] = watcher\n      return\n\n    unwatchDir = (dir) ->\n      verbose 2, \"unwatching #{dir}\/\", 'yellow'\n      if isWatched dir\n        watchCache[dir].close()\n      watchCache[dir] = null\n      return\n\n    unwatchAll = ->\n      verbose 2, \"unwatching all files and directories\", 'yellow'\n      for k in _.keys watchCache\n        if watchCache[k]?\n          watchCache[k].close()\n          watchCache[k] = null\n\n    # Cleanup watches on exit\n    process.on 'SIGINT', ->\n      verbose 1, \"\\n\"\n      unwatchAll()\n      verbose 1, \"oj exited successfully.\", 'cyan'\n      process.exit()\n\nrenderPath\n------------------------------------------------------------------------------\nRender a file as a view. Used by express plugin\n\n    renderPath = (path, options, cb) ->\n\n      _.defaults options,\n        minify:options.minify\n        write:false\n        watch:false\n        recurse:true\n        modules:false\n        html: true\n        css: true\n        js: true\n\n      compilePath path, options, cb\n\nHelpers\n===============================================================================\n\nOutput helpers\n-------------------------------------------------------------------------------\n\n    success = ->\n      process.exit 0\n\n    tabs = (count) ->\n      Array(count + 1).join('\\t')\n\n    spaces = (count) ->\n      Array(count + 1).join(' ')\n\n    # Print if verbose is set\n    verbose = (level, message, color = 'reset') ->\n      if verbosity >= level\n        console.log oj.codes[color] + \"#{spaces(4 * (level-1))}#{message}\" + oj.codes.reset\n\n    error = (message) ->\n      red = oj.codes?.red ? ''\n      reset = oj.codes?.reset ? ''\n      console.error \"#{red}#{message}#{reset}\"\n      return\n\nFile helpers\n------------------------------------------------------------------------------\n\n    # isFile: Determine if path is to a file\n    isFile = (filePath) ->\n      try\n        (fs.statSync filePath).isFile()\n      catch e\n        false\n\n    isOJFile = (filePath) ->\n      ext = path.extname filePath\n      ext == '.oj' or ext == '.ojc'\n\n    # isOJPage: Determine if path is an oj page.\n    isOJPage = (filePath) ->\n      ext = path.extname filePath\n      base = path.basename filePath\n      (isOJFile filePath) and base[0] != '_'and base.slice(0,2) != 'oj' and not isHiddenFile filePath\n\n    # isOJDir: Determine if path is an oj directory.\n    isOJDir = (dirPath, outputDir) ->\n      base = path.basename dirPath\n      base[0] != '_'and base[0] != '.' and base != 'node_modules'\n\n    # isWatchFile: Determine if file can be required and therefore is worth watching\n    isWatchFile = (filePath) ->\n      ext = path.extname filePath\n      (isOJFile filePath) or ext == '.js' or ext == '.coffee' or ext == '.json'\n\n    # isHiddenFile: Determine if file is hidden\n    isHiddenFile = (file) -> \/^\\.|~$\/.test file\n\n    # isDirectory: Determine if path is to directory\n    isDirectory = (dirpath) ->\n      try\n        (fs.statSync dirpath).isDirectory()\n      catch e\n        false\n\n    # relativePathWithEscaping\n    # Example: '\/User\/name\/folder1\/file.oj' => '\/file.oj'\n    relativePathWithEscaping = (fullPath, relativeTo) ->\n      _escapeSingleQuotes '\/' + path.relative relativeTo , fullPath\n\n    # fullPaths: Convert relative paths to full paths from origin dir\n    fullPaths = (relativePaths, dir) ->\n      _.map relativePaths, (p) -> path.resolve dir, p\n\n    # commonPath: Given a list of full paths. Find the common root\n    commonPath = (paths, seperator = '\/') ->\n      if paths.length == 1\n        return path.dirname paths[0]\n\n      common = paths[0].split seperator\n      ixCommon = common.length\n      for p in paths\n        parts = p.split seperator\n        for part, ixPart in parts\n          if common[ixPart] != part or ixPart > ixCommon\n            break\n        ixCommon = Math.min ixPart, ixCommon\n      if ixCommon == 1 && paths[0][0] == seperator\n        return seperator\n      else if ixCommon == 0\n        return null\n      (common.slice 0, ixCommon).join seperator\n\n    # lsOJ\n    # Abstract if recursion happened and filters to only files \/ directories that don't start with _ and end in an oj filetype (.oj, .ojc, .ojlc)\n\n    lsOJ = (paths, options, cb) ->\n      options ?= {}\n\n      # Choose visible files with extension `.oj` and don't start with `oj` (plugins) or `_` (partials & templates)\n      options = _.extend {},\n        recurse: options.recurse\n        filterFile: ((f) -> isOJPage f)\n        filterDir:((d) -> isOJDir d)\n\n      ls paths, options, (err, files, dirs) ->\n        cb err, files, dirs\n      return\n\n    # lsWatch\n    # Look for all files I should consider watching.\n    # This includes: .js, .coffee, .oj, .ojc, with no limitations on\n    # hidden, underscore or oj prefixes.\n\n    lsWatch = (paths, options, cb) ->\n\n      # Choose visible files with extension `.oj` and don't start with `oj` (plugins) or `_` (partials & templates)\n      lsOptions = _.extend {},\n        recurse: options.recurse,\n        filterFile: isWatchFile\n        filterDir:(nameWithPath) ->\n          # Doesn't start with output directory and fits isOJDir criteria\n          !(_startsWith nameWithPath, options.output) and isOJDir nameWithPath\n\n      ls paths, lsOptions, (err, files, dirs) ->\n        cb err, files, dirs\n      return\n\nls: List directories and files from paths asynchronously\n  options.filterFile: accept those files that return true\n  options.filterDir: accept those directories that return true\n  options.recurse: boolean to indicate recursion is desired\n\n    ls = (fullPath, options, cb, acc) ->\n\n      # Optional options\n      if _.isFunction options\n        cb = options\n        options = {}\n\n      options ?= {}\n      options.recurse ?= false\n      options.filterFile ?= -> true # Keep everything by default\n      options.filterDir ?= -> true # Keep everything by default\n      options.recurseDepth ?= if options.recurse then Infinity else 1\n\n      acc ?= {}\n      acc.files ?= []\n      acc.dirs ?= []\n      acc.pending ?= 1\n\n      breakIfDone = ->\n        if acc.pending == 0\n          files = _.uniq acc.files\n          dirs = _.uniq acc.dirs\n          cb null, files, dirs\n        return\n\n      fs.stat fullPath, (err, stat) ->\n        return cb err if err\n\n        # File found\n        if stat.isFile() and options.filterFile(fullPath)\n          acc.files.push fullPath\n          return breakIfDone --acc.pending\n\n        # Directory found\n        else if stat.isDirectory() and options.filterDir(fullPath)\n          acc.dirs.push fullPath\n\n          fs.readdir fullPath, (errReadDir, paths) ->\n            return cb errReadDir if errReadDir\n\n            if !paths or paths.length == 0\n              return breakIfDone --acc.pending\n\n            # Directory has contents\n            acc.pending += paths.length\n\n            paths = fullPaths paths, fullPath\n\n            # Recurse if we haven't hit max depth\n            if options.recurseDepth > 0\n              options_ = _.clone options\n              options_.recurseDepth--\n              for fullPath_ in paths\n                ls fullPath_, options_, cb, acc\n\n            return breakIfDone --acc.pending\n\n        else\n          return breakIfDone --acc.pending\n\n      return\n\n    readFileSync = (filePath) ->\n      fs.readFileSync filePath, 'utf8'\n\nTiming helpers\n------------------------------------------------------------------------------\n\n    wait = (seconds, fn) -> setTimeout fn, seconds*1000\n\nString helpers\n------------------------------------------------------------------------------\n\n    trimArgList = (v) ->\n      _trim v.split(',')\n\n    # trim\n    _trim = (any) ->\n      if _.isString any\n        any.trim()\n      else if _.isArray any\n        out = _.map any, (v) -> v.trim()\n        _.reject out, ((v) -> v == '' or v == null)\n      else\n        any\n\n    # startsWith\n    _startsWith = (strInput, strStart) ->\n      throw new Error('startsWith: argument error') unless (_.isString strInput) and (_.isString strStart)\n      strInput.length >= strStart.length and strInput.lastIndexOf(strStart, 0) == 0\n\n    _escapeSingleQuotes = (str) ->\n      str.replace \/'\/g, \"\\\\'\"\n\n    _insertAt = (str, ix, substr) ->\n      str.slice(0,ix) + substr + str.slice(ix)\n\n    _length = (any) ->\n      any.length or _.keys(any).length\n\nCode minification\n------------------------------------------------------------------------------\n\n    oj._minifyJS = (js, options = {}) ->\n\n      if options.filename\n        verbose 4, \"minified #{options.filename}\"\n\n      if options.minify\n        uglifyjs js\n      else\n        js\n\n    oj._minifyCSS = (css, options = {}) ->\n      if options.minify\n        csso.justDoIt css, true # true means apply structural changes\n      else\n        css\n\nRequiring\n------------------------------------------------------------------------------\n\n    # Hooking into require inspired by [node-dev](http:\/\/github.com\/fgnass\/node-dev)\n    _hookRequire = (modules, moduleLinkMap, hookCache={}, hookOriginalCache={}) ->\n      handlers = require.extensions\n      for ext of handlers\n        # Get or create the hook for the extension\n        hook = hookCache[ext] or (hookCache[ext] = _createHook(ext, modules, moduleLinkMap, hookCache, hookOriginalCache))\n        if handlers[ext] != hook\n          # Save a reference to the original handler\n          hookOriginalCache[ext] = handlers[ext]\n          # and replace the handler by our hook\n          handlers[ext] = hook\n      return\n\n    # Hook into one extension\n    _createHook = (ext, modules, moduleLinkMap, hookCache, hookOriginalCache) ->\n      (module, filename) ->\n\n        # Unfortunately require resolves `filename` through soft links\n        # For our module detection to work we need to unresolve these back\n        # Use the moduleLinkMap to unresolve paths starting with `linkPath`\n        # to start with `modulePath` instead.\n        for linkPath, modulePath of moduleLinkMap\n          # Prefix found then replace\n          if 0 == filename.indexOf linkPath\n            rest = filename.slice linkPath.length\n            filename = modulePath + rest\n            # break\n\n        # Override compile to intercept file\n        if !module.loaded\n          _rememberModule modules, filename, null, module.parent.filename\n\n          # if path.extension filename _.indexOf ['.coffee']\n          moduleCompile = module._compile\n          module._compile = (code) ->\n            _rememberModule modules, filename, code, module.parent.filename\n            moduleCompile.apply this, arguments\n            return\n\n        # Invoke the original handler\n        hookOriginalCache[ext](module, filename)\n\n        # Make sure the module did not hijack the handler\n        _hookRequire modules, moduleLinkMap, hookCache, hookOriginalCache\n\n    _unhookRequire = (modules, hookCache, hookOriginalCache) ->\n      handlers = require.extensions\n      for ext of handlers\n        if hookCache[ext] == handlers[ext]\n          handlers[ext] = hookOriginalCache[ext]\n      hookCache = null\n      hookOriginalCache = null\n      return\n\n    # Remember require references\n    _rememberModule = (modules, filename, code, parent) ->\n      verbose 3, \"requiring #{filename}\" if code\n      modules[filename] = _.defaults {code: code, parent:parent}, (modules[filename] or {})\n\n    _rememberModuleDependencies = (modules) ->\n      for filename, module of modules\n        watchParents[filename] ?= []\n        watchParents[filename].push module.parent\n        watchParents[filename] = _.unique watchParents[filename]\n\n    _nodeModulesSupported = oj:1, jquery:1, assert:1, console:1, crypto:1, events:1, freelist:1, path:1, punycode:1, querystring:1, string_decoder:1, tty:1, url:1, util:1\n    _nodeModuleUnsupported = child_process:1, domain:1, fs:1, net:1, os:1, vm:1, buffer:1\n    isNodeModule = (module) -> !!_nodeModulesSupported[module]\n    isUnsupportedNodeModule = (module) -> !!_nodeModuleUnsupported[module]\n    isAppModule = (module) -> (module.indexOf '\/') == -1\n    isRelativeModule = (module) -> (module.indexOf '\/') != -1\n\n    # _saveRequireCache\n    # Save a record of the cache so we can restore it later\n    _requireCache = null\n    _saveRequireCache = ->\n      _requireCache = _.clone require.cache\n\n    # _restoreRequireCache\n    # Remove all recoreds in the cache that weren't there before\n    _restoreRequireCache = ->\n      for k of require.cache\n        delete require.cache[k] unless _requireCache[k]?\n\n    # Clear one record. This does not work in general because\n    # it doesn't recurse. It does work on stand alone modules\n    # like 'path' and 'underscore'\n    _clearRequireCacheRecord = (record) ->\n      delete require.cache[require.resolve record]\n\n    # Parse code with\n    _getRequiresInSource = (code) ->\n      r = new RegExp(\"require\\\\s*\\\\(?\\\\s*[\\\"']([^\\\"']+)\", 'g');\n      out = []\n      while match = r.exec code\n        out.push match[1]\n      out\n\n    _first = (array, fn) ->\n      for x in array\n        y = fn x\n        return y if y\n\n    # Build out the cache into the form:\n    #   cache.native = ['oj','jquery',...]\n    #   cache.modules = {<path\/to\/node_modules>: {<moduleName>:<path\/to\/main\/file.js, ...}, ...}\n    #   cache.files = {<path\/to\/files.js>:<code>}\n\n    _buildRequireCache = (modules, cache, isMinify) ->\n      for fileLocation, data of modules\n\n        # Read code if it is missing\n        if not data.code?\n          throw new Error('data.code is missing')\n          # data.code = stripBOM readFileSync fileLocation\n\n        # Save code to _fileCache\n        _buildFileCache cache.files, fileLocation, data.code, isMinify\n\n        # Generate possible node_module paths given this file\n        modulePrefixes = nodeModulePaths fileLocation\n\n        pathComponents = _first modulePrefixes, (prefix) ->\n          if _startsWith fileLocation, prefix + path.sep\n            modulePath = (fileLocation.slice (prefix.length + 1)).split(path.sep)\n            moduleName = modulePath[0]\n            moduleMain = modulePath.slice(1).join(path.sep)\n            modulesDir: prefix, moduleName:  moduleName, moduleMain: moduleMain, moduleParentPath: module.id\n\n        # Save to cache.modules\n        if pathComponents\n          if not cache.modules[pathComponents.modulesDir]\n            cache.modules[pathComponents.modulesDir] = {}\n          # Example: \/Users\/evan\/oj\/node_modules: {underscore: 'underscore.js'}\n          cache.modules[pathComponents.modulesDir][pathComponents.moduleName] = pathComponents.moduleMain\n\n        # Build cache.native given source code in _fileCache\n        _buildNativeCache cache.native, data.code, isMinify\n\n        # Store complete\n        verbose 4, \"stored #{fileLocation}\"\n\n      # Remove client and server oj if they exist.\n      # This is a special case of the way stuff is included.\n      # To ourselves oj is local but to them oj is native.\n      # Removing this cache record ensures only the native copy\n      # is saved to the client.\n      delete cache.files[require.resolve '..\/oj.js']\n\n      # Separate files into three parts so each can be outputed separately:\n      #   moduleFiles, pageFiles, nativeFiles\n      cache.nativeFiles = cache.native\n      cache.moduleFiles = {}\n      cache.pageFiles = {}\n      for filePath, code of cache.files\n        if filePath.indexOf(\"\/node_modules\/\") != -1\n          cache.moduleFiles[filePath] = code\n        else\n          cache.pageFiles[filePath] = code\n      return cache\n\n    # ###_buildFileCache: build file cache\n    _buildFileCache = (_filesCache, fileName, code, isMinify) ->\n      # Minify code if necessary and cache it\n      _filesCache[fileName] = oj._minifyJS code, {filename:fileName, minify: isMinify}\n\n    # build native module cache given moduleNameList\n    pass = 1\n\n    _buildNativeCache = (nativeCache, code, isMinify) ->\n      # Get moduleName references from code\n      moduleNameList = _getRequiresInSource code\n      _buildNativeCacheFromModuleList nativeCache, moduleNameList, isMinify\n\n    _buildNativeCacheFromModuleList = (nativeCache, moduleNameList, isMinify) ->\n\n      # Loop over modules and add them to native cache\n      while moduleName = moduleNameList.shift()\n\n        # Continue on already loaded native modules\n        continue if nativeCache[moduleName]\n\n        # OJ is built in\n        if moduleName == 'oj'\n          nativeCache.oj = _ojModuleCode isMinify\n\n        # Do nothing if unsupported\n        # Error checking happens earlier and missing modules at this stage are intentional\n        else if isUnsupportedNodeModule moduleName\n          pass\n\n        else if isNodeModule moduleName\n          # Get code\n          codeModule = _nativeModuleCode moduleName, isMinify\n\n          # Cache it\n          nativeCache[moduleName] = codeModule\n\n          # Concat all dependencies and continue on\n          moduleNameList = moduleNameList.concat _getRequiresInSource codeModule\n\n        else\n          pass\n      null\n\n    # ojModuleCode: Get code for oj\n    _ojModuleCode = (isMinify) ->\n      code = readFileSync path.join __dirname, \"..\/oj.js\"\n      oj._minifyJS code, filename:'oj', minify:isMinify\n\n    # nativeModuleCode: Get code for native module\n    _nativeModuleCode = (moduleName, isMinify) ->\n      verbose 3, \"found #{moduleName}\"\n      code = readFileSync path.join __dirname, \"..\/modules\/#{moduleName}.js\"\n\nTemplating\n==============================================================================\n\nCode generation\n------------------------------------------------------------------------------\n\n    # ###_requireCacheToHtml\n    _requireCacheToHtml = (cache, filePath, isMinify, options) ->\n      return \"\"\"\n        <script>\n        #{_requireCacheToJS cache, filePath, isMinify, options}\n        <\/script>\n      \"\"\"\n\n    # ###_requireCacheToJS\n    # Output html from cache and file\n    _requireCacheToJS = (cache, filePath, isMinify, options) ->\n      newline = if isMinify then '' else '\\n'\n\n      # Example:\n      #   filePath: \/User\/name\/project\/www\/file.oj\n      #   commonDir: \/User\/name\/project\n      #   clientDir: \/www\n      #   clientfile: \/file\n\n      # Calculate common path root between all cached files\n      commonDir = commonPath _.keys cache.files\n\n      # Determine directory for client using common path\n      clientDir = _escapeSingleQuotes '\/' + path.relative commonDir, path.dirname filePath\n\n      # Determine file for client given the above directory\n      clientFile = _escapeSingleQuotes '\/' + basenameForExtensions filePath, ['.ojc', '.oj', '.coffee', '.js']\n\n      # Maps from moduleDir -> moduleName -> moduleMain such that\n      # the file path is: moduleDir\/moduleName\/moduleMain\n      _modulesToString = (moduleDir, nameToMain) ->\n        # Use relative path to hide server directory info\n        moduleDir = relativePathWithEscaping moduleDir, commonDir\n        \"M['#{moduleDir}'] = #{JSON.stringify nameToMain};\\n\"\n\n      # Maps moduleName -> code for built in \"native\" modules\n      _nativeModuleToString = (moduleName, code) ->\n        # Use relative path to hide server directory info\n        moduleName = _escapeSingleQuotes moduleName\n        \"\"\"F['#{moduleName}'] = (function(module,exports){(function(process,global,__dirname,__filename){#{newline}#{code}})(P,G,'\/','#{moduleName}');});\\n\"\"\"\n\n      # Maps filePath -> code\n      _fileToString = (filePath, code, prefixWithRequire) ->\n        # Use relative and escaped path\n        filePath = relativePathWithEscaping filePath, commonDir\n        fileDir = path.dirname filePath\n        fileName = path.basename filePath\n        out = if prefixWithRequire then \"require.\" else \"\"\n        out += \"\"\"F['#{filePath}'] = (function(module,exports){(function(require,process,global,__dirname,__filename){#{newline}#{code}})(require.RR('#{filePath}'),require.P,require.G,'#{fileDir}','#{fileName}');});#{newline}\\n\"\"\"\n\n      # Client side code to include modules\n      _modules = \"\"\n      # { '\/Users\/evan\/oj\/node_modules': { underscore: 'underscore.js' } }\n      for moduleDir, nameToMain of cache.modules\n        _modules += _modulesToString moduleDir, nameToMain\n\n      # Client side code to include files from modules and from pages\n      _moduleFiles = \"\"\n      for filePath, code of cache.moduleFiles\n        _moduleFiles += _fileToString filePath, code\n        verbose 4, \"serialized module file `#{filePath}`\"\n\n      _pageFiles = \"\"\n      # Prefix require if modules aren't being output with this\n      prefixWithRequire = !options.modules\n      for filePath, code of cache.pageFiles\n        _pageFiles += _fileToString filePath, code, prefixWithRequire\n        verbose 4, \"serialized page file `#{filePath}`\"\n\n      # Client side code to include native modules\n      _nativeFiles = \"\"\n      for moduleName, code of cache.native\n        _nativeFiles += _nativeModuleToString moduleName, code\n        verbose 4, \"serialized native file '#{moduleName}'\"\n\n      # Browser side node has these abbreviations:\n      #     G = Global\n      #     P = Process\n      #     RR = Require factory to generated require for a given path\n      #     R = Require cache\n      #     F = File cache\n      #     M = Module cache\n\n      # Client side function to run module and cache result\n      _run = oj._minifyJS \"\"\"\n      function run(f){\n          if(R[f] != null)\n            return R[f];\n          var eo = {},\n            mo = {exports: eo};\n          if(typeof F[f] != 'function')\n            throw new Error(\"file not found (\" + f + \")\");\n          F[f](mo,eo);\n          return R[f] = mo.exports;\n        }\n    \"\"\", minify:isMinify\n\n      # Client side function to find module\n      _find = oj._minifyJS \"\"\"\n      function find(m,f){\n          var r, dir, dm, ext, ex, i;\n\n          if (F[m] && !m.match(\/\\\\\/\/))\n            return m;\n\n          if (!!m.match(\/\\\\\/\/)) {\n            r = oj._pathResolve(f, oj._pathJoin(oj._pathDirname(f), m));\n            ext = ['.ojc','.oj','.coffee','.js','.json'];\n            for(i = 0; i < ext.length; i++){\n              ex = ext[i];\n              if(F[r+ex])\n                return r+ex;\n            }\n          } else {\n            if (typeof oj !== 'undefined') {\n              dir = oj._pathDirname(f);\n              while(true) {\n                dm = oj._pathJoin(dir, 'node_modules');\n                if(M[dm] && M[dm][m])\n                  return oj._pathJoin(dm, m, M[dm][m]);\n                if(dir == '\/')\n                  break;\n                dir = oj._pathResolve(dir, '..');\n              }\n            }\n          }\n          throw new Error(\"module not found (\" + m + \")\");\n        }\n      \"\"\", minify: isMinify\n\n      # Begin function\n      js = \"\"\"\n        \/\/ Generated with oj v#{oj.version}\n        ;(function(){\n      \"\"\"\n\n  Add modules if we want to include them\n\n      if options.modules\n        js += \"\"\"\n          var M = {}, F = {}, R = {}, P, G, RR;\n\n          \/\/ Package modules\n          #{_modules}\n          #{_moduleFiles}\n          \/\/ Native modules\n          #{_nativeFiles}\n          \/\/ Define node environment: process P, global G and require factory RR\n          P = {cwd: function(){return '\/'}}\n          G = {process: P,Buffer: {}}\n          RR = function(f){\n            var o = function(m){return run(find(m, f))};\n            o.P = P; o.G = G; o.F = F; o.M = M, o.RR = RR;\n            return o;\n            #{_run}\n            #{_find}\n          };\n\n          \/\/ Define require and oj\n          require = RR('\/');\n          oj = require('oj');\\n\n        \"\"\"\n\n  Include page js if we want to include it\n\n      if options.js\n        js += \"\"\"\n          \\n\/\/ Page files\n          #{_pageFiles}\n          oj.load('#{clientFile}');\\n\n        \"\"\"\n      # End function\n      js += \"\"\"\n        }).call(this);\n      \"\"\"\n\nExpress View Engine\n------------------------------------------------------------------------------\n\n    oj.__express = renderPath\n\nExpress Middleware\n------------------------------------------------------------------------------\nrequired options:\n  publicDir: Public directory statically hosted by node\n  modulesDirSrc: Directory to build module files from\n  modulesDirDest: Directory to build module files to (should be public)\n\n    oj.middleware = (options) ->\n\n  Determine the url path relative the public directory\n\n      urlModulesDir = '\/' + path.relative(options.publicDir, options.modulesDirDest)\n\n  Output connect\/express middleware\n\n      (req,res,next) ->\n\n  Short circuit if this isn't a GET or HEAD request\n\n        if 'GET' != req.method && 'HEAD' != req.method\n          return next()\n\n  Get the path out of the url and figure out where to output the file\n\n        urlPath = url.parse(req.url).pathname\n\n  The path starts with  module dir and ends with .js\n\n        if \/\\.js$\/.test(urlPath) and _startsWith(urlPath, urlModulesDir)\n\n          fileRelativePath = path.relative urlModulesDir, urlPath\n          outputFilePath = path.join options.modulesDirDest, fileRelativePath\n          outputFileDir = path.dirname outputFilePath\n\n          baseFileName = path.basename urlPath, '.js'\n\n          findFile options.modulesDirSrc, baseFileName, ['.oj', '.ojc'], (err, inputFilePath) ->\n\n  Found the file so lets get to compiling\n\n            if inputFilePath\n\n  Compile only if the input file is newer then the output file or the force option is set\n\n              if options.force\n                _middlewareCompileModule()\n\n              else\n                fileIsOutdated outputFilePath, inputFilePath, (err, idOutdated) ->\n                  if idOutdated\n                    _middlewareCompileModule()\n                  else\n                    next()\n                  return\n\n  Compile using internal compilePath function that will generate the output to a directory\n\n              _middlewareCompileModule = ->\n                try\n                  compilePath inputFilePath,\n                    output: outputFileDir\n                    force: options.force ? false\n                    minify: options.minify ? true\n                    html:0, css:0, js:0, write:1, modules:1, ->\n                      console.log \"file is compiled: server.litcoffee:1490\"\n                      # File is compiled so let static middleware handle it\n                      next()\n                catch e\n                  next()\n\n            else\n              next()\n\n  The path doesn't match so just pass it on\n\n        else\n          next()\n\n    # Returns true if dest is older then source\n    fileIsOutdated = (fileDest, fileSource, cb) ->\n      fs.stat fileSource, (errSource, statSource) ->\n        return cb(errSource, null) if errSource\n        fs.stat fileDest, (errDest, statDest) ->\n          if !errDest || errDest.code == 'ENOENT'\n            cb(null, !!errDest || statSource.mtime.getTime() > statDest.mtime.getTime())\n          else\n            cb(errDest, null)\n      return\n\n    # Find file with given extensions in directory\n    findFile = (dir, baseFileName, extensions, cb) ->\n        if !dir or !baseFileName or !extensions or !cb\n          return cb('findFile: invalid input')\n\n        # Fail if can't find file\n        ext = extensions.shift()\n        fileName = baseFileName + ext\n        do (dir, fileName) ->\n          fs.stat path.join(dir, fileName), (err, statInfo) ->\n            if statInfo and statInfo.isFile()\n              return cb null, path.join(dir, fileName)\n            else if extensions.length > 0\n              return findFile dir, baseFileName, extensions, cb\n            else\n              return cb null, null\n\n\n\n\n\n\n\n","old_contents":"\nserver.coffee\n==============================================================================\nStatic website creator for oj and the npm module\nExpress templating engine and middleware\n\n  Include common modules\n\n    for m in ['path', 'fs', 'vm']\n      global[m] = require m\n\n  Include dependencies\n\n    _ = require 'underscore'\n    coffee = require 'coffee-script'\n    mkdirp = require 'mkdirp'\n    csso = require 'csso'\n    uglifyjs = require 'uglify-js'\n\n  Static site creation runs in the context of the dom and jQuery\n\n    jsdom = (require 'jsdom').jsdom\n    global.jQuery = global.$ = require 'jquery'\n    global.document = jsdom \"<html><head><\/head><body><\/body><\/html>\"\n    global.window = document.createWindow()\n\nExport Server Side OJ\n-------------------------------------------------------------------------------\n\n  Include the client library in this module\n\n    oj = require '..\/oj'\n\n  Indicate it is server side\n\n    oj.isClient = false\n\n  Export this module\n\n    module.exports = oj\n\n  Make sure jquery is hooked up\n\n    oj.$ = global.$\n\n  Store console codes for color logging\n\n    oj.codes =\n      reset: '\\u001b[0m'\n      black: '\\u001b[30m'\n      red: '\\u001b[31m'\n      green: '\\u001b[32m'\n      yellow: '\\u001b[33m'\n      blue: '\\u001b[34m'\n      magenta: '\\u001b[35m'\n      cyan: '\\u001b[36m'\n      gray: '\\u001b[37m'\n\nRegister require.extension for .oj and .ojc file types\n-------------------------------------------------------------------------------\n\n    if require.extensions\n\n      coffee = require 'coffee-script'\n\n      stripBOM = (c) -> if c.charCodeAt(0) == 0xFEFF then (c.slice 1) else c\n      wrapJS = (code) ->\n        \"(function(){with(oj.sandbox){#{code}}}).call(this);\"\n      wrapCSMessage = (message, filepath) ->\n        \"#{oj.codes?.red}coffee-script error in #{filepath}: #{message}#{oj.codes?.reset}\"\n      wrapJSMessage = (message, filepath) ->\n        \"#{oj.codes?.red}javascript error in #{filepath}: #{message}#{oj.codes?.reset}\"\n      compileJS = (module, code, filepath) ->\n        code = wrapJS code\n        global.oj = oj\n        module._compile code, filepath\n        delete global.oj\n\n  Compile .oj files as javascript\n\n      require.extensions['.oj'] = (module, filepath) ->\n        # Ensure absolute paths are found correctly for oj file types\n        if filepath[0] == '\/' && filepath != module.filename\n          filepath = module.filename\n\n        # Read the file\n        code = stripBOM fs.readFileSync filepath, 'utf8'\n        try\n          compileJS module, code, filepath\n        catch eJS\n          eJS.message = wrapJSMessage eJS.message, filepath\n          throw eJS\n\n  Compile .ojc files as coffee-script\n\n      require.extensions['.ojc'] = (module, filepath) ->\n        # Ensure absolute paths are found correctly for oj file types\n        if filepath[0] == '\/' && filepath != module.filename\n          filepath = module.filename\n\n        code = stripBOM fs.readFileSync filepath, 'utf8'\n\n        # Compile in coffee-script\n        try\n          code = coffee.compile code, bare: true\n        catch eCoffee\n          eCoffee.message = wrapCSMessage eCoffee.message, filepath\n          throw eCoffee\n\n        # Compile javascript\n        try\n          compileJS module, code, filepath\n\n        catch eJS\n          eJS.message = wrapJSMessage eJS.message, filepath\n          throw eJS\n\nCommands\n==============================================================================\n\noj.watch\n------------------------------------------------------------------------------\nWatch list of files or directories\n\n    oj.watch = (filesOrDirectories, options) ->\n      options = _.extend {}, options,\n        args: filesOrDirectories\n        watch: true\n        write: true\n      oj.command options\n\noj.build\n------------------------------------------------------------------------------\nBuild list of files or directories\n\n    oj.build = (filesOrDirectories, options) ->\n      options = _.extend {}, options,\n        args: filesOrDirectories\n        watch: false\n        write: true\n      oj.command options\n\noj.command\n------------------------------------------------------------------------------\n\nRemember verbosity level\n\n    verbosity = null\n\noj.command options:\n\n  * args: list of files or directories\n  * debug: bool\n  * watch: bool\n  * recurse: bool\n  * output: directory\/path\n  * modules: list of strings to include manually\n  * verbose: level\n  * html: Only output html\n  * css: Only output css\n  * js: Only output page js (no modules)\n  * modules: Only output modules (no page rendering)\n\nDefine command\n\n    oj.command = (options = {}) ->\n\n      verbosity = options.verbose || 1\n      options.watch ?= false    # Watch for changes and recompile\n      options.write ?= true     # Output to a file\n      options.recurse ?= true   # Recurse in sub directories\n      options.include ?= []     # Include modules\n      options.exclude ?= []     # Exclude modules\n\n  Default to all when no output options are specified\n\n      options.html ?= false\n      options.css ?= false\n      options.js ?= false\n      options.modules ?= false\n\n      if options.all or (!options.html and !options.css and !options.js and !options.modules)\n        options.modules = options.js = options.css = options.html = true\n\n  Resolve directory args to full path and append \/ to ensure path prefixes refer to directories\n\n      options.output = (path.resolve process.cwd(), (options.output ? www)) + '\/'\n      options.modulesDir = (path.resolve process.cwd(), (options.modulesDir ? '.\/modules')) + '\/'\n\n  cssDir is optional\n\n      if options.cssDir\n        options.cssDir = (path.resolve process.cwd(), options.cssDir) + '\/'\n\n  Verify output directory isn't the root directory\n\n      if options.output == process.cwd()\n        error('oj: output directory cannot be current directory')\n        return\n\n  Verify args exist\n\n      throw new Error('oj: no args found') unless (_.isArray options.args) and options.args.length > 0\n\n  Convert args to full paths\n\n      options.args = fullPaths options.args, process.cwd()\n\n      for fullPath in options.args\n        compilePath fullPath, options\n\n      return\n\ncompilePath\n------------------------------------------------------------------------------\nCompile any file or directory path\n\n    compilePath = (fullPath, options = {}, cb = ->) ->\n      if isDirectory fullPath\n        return compileDir fullPath, options, cb\n      includeDir = path.dirname fullPath\n      compileFile fullPath, includeDir, options, cb\n\ncompileDir\n------------------------------------------------------------------------------\n\n    compileDir = (dirPath, options = {}, cb = ->) ->\n      # Handle recursion and gather files to watch and compile\n      lsWatch dirPath, options, (err, files, dirs) ->\n        console.log \"lsWATCH CB CALLED\"\n        console.log \"files: \", files\n        console.log \"dirs: \", dirs\n        # Watch all directories if option is set\n        if options.watch\n          for d in dirs\n            watchDir d, dirPath, options\n\n        # Call cb when it has been called length times\n        _cb = _.after files.length, cb\n\n        for f in files\n\n          # Compile and watch all pages\n          if isOJPage f\n            compileFile f, dirPath, options, _cb\n\n          # Watch files that aren't pages\n          else if options.watch\n            watchFile f, dirPath, options\n            _cb()\n        return\n      return\n\nnodeModulePaths: Determine node_module paths from a given path\n------------------------------------------------------------------------------\nImplementation is from node.js' Module._nodeModulePaths\nThis is not a public API so it seemed to horrible.\n\n    nodeModulePaths = (from) ->\n      from = path.resolve from\n      splitRe = (if process.platform == 'win32' then  \/[\\\/\\\\]\/ else \/\\\/\/)\n      joiner = (if process.platform == 'win32' then '\\\\' else '\/')\n      paths = []\n      parts = from.split splitRe\n      for tip in [(parts.length-1)..0]\n\n  Don't search in ...\/node_modules\/node_modules\n\n        if parts[tip] == 'node_modules'\n          continue\n        dir = parts.slice(0, tip + 1).concat('node_modules').join(joiner)\n        paths.push(dir)\n      paths\n\n    # Recursively get final link path\n    resolveLink = (linkPath, out) ->\n      try\n        newPath = fs.readlinkSync linkPath\n        return (resolveLink newPath, newPath)\n      catch e\n      out\n\n  Get module mapping from link dest to link source\n  \/some\/path\/linked-module  -> \/another\/path\/node_modules\/linked-module\n\n    nodeModulesLinkMap = (fileDir) ->\n      dirs = nodeModulePaths fileDir\n      out = {}\n      for dir in dirs\n        try\n          modules = fs.readdirSync dir\n          for moduleName in modules\n            modulePath = path.join dir, moduleName\n            linkPath = resolveLink modulePath\n            if linkPath?\n              out[linkPath] = modulePath\n        catch e\n      out\n\n    # basenameForExtensions: Get basename for multiple extensions\n    basenameForExtensions = (p, arrayOfExt = []) ->\n      out = path.basename p\n      for ext in arrayOfExt\n        out = path.basename out, ext\n      out\n\ncompileFile\n------------------------------------------------------------------------------\n\n    compileFile = (filePath, includeDir, options = {}, cb = ->) ->\n      options = _.clone options\n\n      # Time this method\n      startTime = process.hrtime()\n\n      # Clear underscore as modules might need it\n      _clearRequireCacheRecord 'underscore'\n\n      options.exclude ?= []\n\n      throw new Error('oj: file not found') unless isFile filePath\n\n      # Default some values\n      isMinify = options.minify ? false\n\n      includedModules = options.include or []\n      includedModules = includedModules.concat ['oj', 'jquery']\n\n      rootDir = options.root or path.dirname filePath\n      fileDir = path.dirname filePath\n\n      # Directory specifications win over options every time\n      if _startsWith filePath, options.modulesDir\n        options.modules = true\n        options.css = false\n        options.html = false\n        options.js = false\n      else if options.cssDir and _startsWith filePath, options.cssDir\n        console.log \"css dir found\"\n        options.modules = false\n        options.css = true\n        options.html = false\n        options.js = false\n\n      throw new Error('oj: root is not a directory') unless isDirectory rootDir\n\n      # Watch file if option is set\n      if options.watch\n        watchFile filePath, includeDir, options\n\n      verbose 2, \"compiling #{filePath}\"\n\n      # Cache of modules, files, and native modules\n      cache = modules:{}, files:{}, native:{}\n\n      # Determine global modules with soft linking\n      moduleLinkMap = nodeModulesLinkMap fileDir\n\n      # Hook require to intercept requires in oj files\n      modules = {}\n      moduleParents = {}  # map file name to parent list\n      hookCache = {}\n      hookOriginalCache = {}\n      _hookRequire modules, moduleLinkMap, hookCache, hookOriginalCache\n\n      # Save require cache to restore it later\n      _saveRequireCache()\n\n      # Remove excluded\n      for ex in options.exclude\n        verbose 3, \"excluding #{ex}\"\n      includedModules = _.difference includedModules, options.exclude\n\n      # Catch messages thrown by requiring\n      try\n\n        # Require user defined modules\n        for m in includedModules\n          if isNodeModule m\n            _buildNativeCacheFromModuleList cache.native, [m], isMinify\n          else\n            verbose 3, \"including #{m}\"\n            require m\n\n        # Require this file to start the process\n        ojml = require filePath\n\n      # Abort require with message on failure\n      catch eRequire\n        verbose 1, eRequire.message\n\n        # Unwind ourselves from require before failing\n        _restoreRequireCache()\n        _unhookRequire modules, hookCache, hookOriginalCache\n        return\n\n      # Restore require cache\n      _restoreRequireCache()\n      _unhookRequire modules, hookCache, hookOriginalCache\n\n      # Watch needs records of file dependencies\n      _rememberModuleDependencies modules\n\n  Compile css if --css is set\n\n      cssOption = !!options.css\n\n  Compile html only if --html is set\n\n      htmlOption = !!options.html\n\n  Create compile options\n\n      compileOptions = minify:isMinify, html:htmlOption, cssMap:cssOption, css:cssOption, dom:false\n      # Catch the messages thrown by compiling ojml\n      try\n        # Compile\n        results = oj.compile compileOptions, ojml\n      catch eCompile\n        error \"runtime error in #{filePath}: #{eCompile.message}\"\n        return\n\n      # Build cache\n      verbose 3, \"caching #{filePath} (#{_length modules} files)\"\n      cache = _buildRequireCache modules, cache, isMinify\n\n  Calculate file locations for outputing\n\n      # (assuming filePath is \/input\/dir\/file.oj)\n      # fileBaseName = file\n      fileBaseName = basenameForExtensions filePath, ['.oj', '.ojc', 'ojlc']\n      # outputDir = \/output\n      outputDir = options.output || process.cwd()\n      # fileDir = \/input\/dir\n      fileDir = path.dirname filePath\n      # subDir = \/dir\n      subDir = path.relative includeDir, fileDir\n\n  Calculate the file extension. Default is .html\n\n      extOut = '.html'\n\n  Use .css if only --css is specified\n\n      if options.css and not (options.html or options.js or options.modules)\n        extOut = '.css'\n\n  Use .js if css and html aren't specified\n\n      else if (options.js or options.modules) and not (options.html or options.css)\n        extOut = '.js'\n\n  Calculate file path to output to\n\n      # fileOut = \/output\/dir\/file.html\n      fileOut = path.join outputDir, subDir, fileBaseName + extOut\n\n  Extend info to calculate output file locations and other meta data\n\n      options.info = _.extend {},\n        includeDir: includeDir\n        # Profiling data\n        startTime: startTime\n        # Results of compile\n        results: results\n        # Module cache\n        cache: cache\n        filePath: filePath\n        fileDir: fileDir\n        fileBaseName: fileBaseName\n        outputDir: outputDir\n        subDir: subDir\n        extOut: extOut\n        fileOut: fileOut\n        isMinify: isMinify\n\n      _outputFile options, cb\n\n      return\n\n    # _outputFile:\n    # Generic output file function that takes cached state and options and does the right thing\n    # including options for:\n    #   options.write:false output to callback instead of file\n    # ------------------------------------------------------------------------------\n    _outputFile = (options, cb) ->\n      # Output html only as a .html\n      if options.html and not (options.css or options.js or options.modules)\n        _outputHtml options, cb\n      # Output css as a .css file\n      else if options.css and not (options.html or options.js or options.modules)\n        _outputCss options, cb\n      # Output js, modules or both as a .js file\n      else if (options.js or options.modules) and not (options.html or options.css)\n        _outputJs options, cb\n      # Output some combination of html,css,js and modules in a .html file\n      else\n        _outputCombinedHtml options, cb\n\n    # outputUnifed\n    # ------------------------------------------------------------------------------\n\n    _outputCombinedHtml = (options, cb) ->\n\n      info = options.info\n      results = info.results\n      filePath = info.filePath\n      fileOut = info.fileOut\n      html = results.html\n      cssMap = results.cssMap\n      cache = info.cache\n      cacheLength = _length(cache.files) + _length(cache.modules) + _length(cache.native)\n      verbose 3, \"serializing #{filePath} (#{cacheLength} files)\"\n      scriptHtml = _requireCacheToHtml cache, filePath, options.minify ? false, options\n\n      if !results.tags.html\n        error \"validation error #{filePath}: <html> tag is missing\"\n        return\n\n      else if !results.tags.head\n        error \"validation error #{filePath}: <head> tag is missing\"\n        return\n\n      else if !results.tags.body\n        error \"validation error #{filePath}: <body> tag is missing\"\n        return\n\n      # TODO: Should we auto-insert doctype 5?\n      # Insert script before <\/body> or before <\/html> or at the end\n      scriptIndex = html.lastIndexOf '<\/body>'\n      html = _insertAt html, scriptIndex, scriptHtml\n\n      # Insert styles before <\/head> or after <html> or at the beginning\n      styleIndex = html.indexOf '<\/head>'\n      styleHTML = ''\n      for plugin,mediaMap of results.cssMap\n        styleHTML += oj._styleTagFromMediaObject plugin, mediaMap, options\n      html = _insertAt html, styleIndex, styleHTML\n\n      _outputDataToFileOrCallback html, options, cb\n\n    # _outputCss\n    # ------------------------------------------------------------------------------\n\n    _outputCss = (options, cb) ->\n      _outputDataToFileOrCallback options.info.results.css, options, cb\n\n    # _outputHtml\n    # ------------------------------------------------------------------------------\n    _outputHtml = (options, cb) ->\n      _outputDataToFileOrCallback options.info.results.html, options, cb\n\n    # _outputJs\n    # ------------------------------------------------------------------------------\n    _outputJs = (options, cb) ->\n      info = options.info\n      js = _requireCacheToJS info.cache, info.filePath, info.isMinify, options\n      _outputDataToFileOrCallback js, options, cb\n\n    # _outputDataToFileOrCallback\n    # ------------------------------------------------------------------------------\n    # Output data to the fileOut location taking into account options.write flag\n    # If options.write is set the file is outputed otherwise it is sent only to the cb\n    _outputDataToFileOrCallback = (data, options, cb) ->\n\n      info = options.info\n      fileOut = info.fileOut\n\n      filePath = info.filePath\n      fileOut = info.fileOut\n\n      # Create directory\n      dirOut = path.dirname fileOut\n      if mkdirp.sync dirOut\n        verbose 3, \"mkdir #{dirOut}\"\n\n      timeStamp = _timeStampFromStartTime info.startTime\n\n      # Write file\n      if options.write\n\n        fs.writeFile fileOut, data, (err) ->\n          if err\n            error \"file writing error #{filePath}: #{err}\"\n            return\n\n          verbose 1, \"compiled #{fileOut}#{timeStamp}\", 'cyan'\n          cb(null, data)\n          return\n      else\n        verbose 1, \"compiled #{fileOut}#{timeStamp}\", 'cyan'\n        cb(null, data)\n\n    _timeStampFromStartTime = (startTime) ->\n      deltaTime = process.hrtime(startTime)\n      timeStamp = \" (#{deltaTime[0] + Math.round(10000*deltaTime[1]\/1000000000)\/10000} sec)\"\n\n    # Keep track of which files are watched\n    watchCache = {}\n    isWatched = (fullPath) ->\n      watchCache[fullPath]?\n    triggerWatched = (fullPath) ->\n      watchCache[fullPath]?._events?.change?()\n    # Keep track of dependency tree of files\n    watchParents = {}\n\n    # watchFile\n    # ------------------------------------------------------------------------------\n\n    watchFile = (filePath, includeDir, options = {}) ->\n      # Do nothing if this file is already watched\n      return if isWatched filePath\n\n      prevStats = null\n      compileTimeout = null\n\n      _watchErr = (e) ->\n        if e.code is 'ENOENT'\n          try\n            _rewatch()\n            _compile()\n          catch e\n            verbose 2, \"unwatching missing file: #{filePath}\", 'yellow'\n            _unwatch()\n        else throw e\n\n      timeLast = new Date(2000)\n      timeEpsilon = 2 # milliseconds\n\n      _onWatch = ->\n        try\n          clearTimeout compileTimeout\n          compileTimeout = wait 0.025, ->\n\n            # Ignore recompiles within epsilon time\n            timeNow = new Date()\n            return if (timeNow - timeLast) \/ 1000 < timeEpsilon\n            timeLast = timeNow\n\n            # Files that aren't pages should trigger their parents\n            if not isOJPage filePath\n              parents = watchParents[filePath]\n              if parents?\n                for parent in parents\n                  triggerWatched parent\n\n            # Files that are pages should recompile\n            else\n              fs.stat filePath, (err, stats) ->\n                return _watchErr err if err\n                verbose 2, \"updating file #{filePath}\", 'yellow'\n                compileFile filePath, includeDir, options\n\n        catch e\n          verbose 1, 'unknown watch error on #{filePath}'\n          _unwatch()\n      try\n        verbose 2, \"watching file #{filePath}\", 'yellow'\n        watcher = fs.watch filePath, _onWatch\n        watchCache[filePath] = watcher\n      catch e\n        _watchErr e\n\n      _rewatch = ->\n        verbose 3, \"rewatch file #{filePath}\", 'yellow'\n        _unwatch()\n\n        watchCache[filePath] = watcher = fs.watch filePath, _onWatch\n\n      _unwatch = ->\n        if isWatched filePath\n          watchCache[filePath].close()\n        watchCache[filePath] = null\n\nwatchDir\n------------------------------------------------------------------------------\nWatch a directory of files for new additions.\nThis method does not recurse as it is called from methods that do (compileDir)\n\n    watchDir = (dir, includeDir, options) ->\n\n      # Short circuit if already watching this directory\n      return if isWatched dir\n\n      # Throttle\n      compileTimeout = null\n\n      verbose 2, \"watching directory #{dir}\/\", 'yellow'\n      watcher = fs.watch dir, (err) ->\n        verbose 2, \"updating directory #{dir}\/\", 'yellow'\n\n        # Unwatch missing directories\n        if err and not isDirectory dir\n          return unwatchDir dir\n\n        # When the directory changes a file may have been added or removed\n        # Watch all the directories and files that aren't currently being watched\n        lsOJ dir, options, (err, files, dirs) ->\n          for d in dirs\n            if not isWatched d\n              watchDir d\n          for f in files\n            if not isWatched f\n              compileFile f, includeDir, options\n\n      # Cache watch\n      watchCache[dir] = watcher\n      return\n\n    unwatchDir = (dir) ->\n      verbose 2, \"unwatching #{dir}\/\", 'yellow'\n      if isWatched dir\n        watchCache[dir].close()\n      watchCache[dir] = null\n      return\n\n    unwatchAll = ->\n      verbose 2, \"unwatching all files and directories\", 'yellow'\n      for k in _.keys watchCache\n        if watchCache[k]?\n          watchCache[k].close()\n          watchCache[k] = null\n\n    # Cleanup watches on exit\n    process.on 'SIGINT', ->\n      verbose 1, \"\\n\"\n      unwatchAll()\n      verbose 1, \"oj exited successfully.\", 'cyan'\n      process.exit()\n\nrenderPath\n------------------------------------------------------------------------------\nRender a file as a view. Used by express plugin\n\n    renderPath = (path, options, cb) ->\n      compilePath(path, {write:false, minify:false}, cb)\n\nHelpers\n===============================================================================\n\nOutput helpers\n-------------------------------------------------------------------------------\n\n    success = ->\n      process.exit 0\n\n    tabs = (count) ->\n      Array(count + 1).join('\\t')\n\n    spaces = (count) ->\n      Array(count + 1).join(' ')\n\n    # Print if verbose is set\n    verbose = (level, message, color = 'reset') ->\n      if verbosity >= level\n        console.log oj.codes[color] + \"#{spaces(4 * (level-1))}#{message}\" + oj.codes.reset\n\n    error = (message) ->\n      red = oj.codes?.red ? ''\n      reset = oj.codes?.reset ? ''\n      console.error \"#{red}#{message}#{reset}\"\n      return\n\nFile helpers\n------------------------------------------------------------------------------\n\n    # isFile: Determine if path is to a file\n    isFile = (filePath) ->\n      try\n        (fs.statSync filePath).isFile()\n      catch e\n        false\n\n    isOJFile = (filePath) ->\n      ext = path.extname filePath\n      ext == '.oj' or ext == '.ojc'\n\n    # isOJPage: Determine if path is an oj page.\n    isOJPage = (filePath) ->\n      ext = path.extname filePath\n      base = path.basename filePath\n      (isOJFile filePath) and base[0] != '_'and base.slice(0,2) != 'oj' and not isHiddenFile filePath\n\n    # isOJDir: Determine if path is an oj directory.\n    isOJDir = (dirPath, outputDir) ->\n      base = path.basename dirPath\n      base[0] != '_'and base[0] != '.' and base != 'node_modules'\n\n    # isWatchFile: Determine if file can be required and therefore is worth watching\n    isWatchFile = (filePath) ->\n      ext = path.extname filePath\n      (isOJFile filePath) or ext == '.js' or ext == '.coffee' or ext == '.json'\n\n    # isHiddenFile: Determine if file is hidden\n    isHiddenFile = (file) -> \/^\\.|~$\/.test file\n\n    # isDirectory: Determine if path is to directory\n    isDirectory = (dirpath) ->\n      try\n        (fs.statSync dirpath).isDirectory()\n      catch e\n        false\n\n    # relativePathWithEscaping\n    # Example: '\/User\/name\/folder1\/file.oj' => '\/file.oj'\n    relativePathWithEscaping = (fullPath, relativeTo) ->\n      _escapeSingleQuotes '\/' + path.relative relativeTo , fullPath\n\n    # fullPaths: Convert relative paths to full paths from origin dir\n    fullPaths = (relativePaths, dir) ->\n      _.map relativePaths, (p) -> path.resolve dir, p\n\n    # commonPath: Given a list of full paths. Find the common root\n    commonPath = (paths, seperator = '\/') ->\n      if paths.length == 1\n        return path.dirname paths[0]\n\n      common = paths[0].split seperator\n      ixCommon = common.length\n      for p in paths\n        parts = p.split seperator\n        for part, ixPart in parts\n          if common[ixPart] != part or ixPart > ixCommon\n            break\n        ixCommon = Math.min ixPart, ixCommon\n      if ixCommon == 1 && paths[0][0] == seperator\n        return seperator\n      else if ixCommon == 0\n        return null\n      (common.slice 0, ixCommon).join seperator\n\n    # lsOJ\n    # Abstract if recursion happened and filters to only files \/ directories that don't start with _ and end in an oj filetype (.oj, .ojc, .ojlc)\n\n    lsOJ = (paths, options, cb) ->\n      options ?= {}\n\n      # Choose visible files with extension `.oj` and don't start with `oj` (plugins) or `_` (partials & templates)\n      options = _.extend {},\n        recurse: options.recurse\n        filterFile: ((f) -> isOJPage f)\n        filterDir:((d) -> isOJDir d)\n\n      ls paths, options, (err, files, dirs) ->\n        cb err, files, dirs\n      return\n\n    # lsWatch\n    # Look for all files I should consider watching.\n    # This includes: .js, .coffee, .oj, .ojc, with no limitations on\n    # hidden, underscore or oj prefixes.\n\n    lsWatch = (paths, options, cb) ->\n\n      # Choose visible files with extension `.oj` and don't start with `oj` (plugins) or `_` (partials & templates)\n      lsOptions = _.extend {},\n        recurse: options.recurse,\n        filterFile: isWatchFile\n        filterDir:(nameWithPath) ->\n          # Doesn't start with output directory and fits isOJDir criteria\n          !(_startsWith nameWithPath, options.output) and isOJDir nameWithPath\n\n      ls paths, lsOptions, (err, files, dirs) ->\n        cb err, files, dirs\n      return\n\nls: List directories and files from paths asynchronously\n  options.filterFile: accept those files that return true\n  options.filterDir: accept those directories that return true\n  options.recurse: boolean to indicate recursion is desired\n\n    ls = (fullPath, options, cb, acc) ->\n\n      # Optional options\n      if _.isFunction options\n        cb = options\n        options = {}\n\n      options ?= {}\n      options.recurse ?= false\n      options.filterFile ?= -> true # Keep everything by default\n      options.filterDir ?= -> true # Keep everything by default\n      options.recurseDepth ?= if options.recurse then Infinity else 1\n\n      acc ?= {}\n      acc.files ?= []\n      acc.dirs ?= []\n      acc.pending ?= 1\n\n      breakIfDone = ->\n        if acc.pending == 0\n          files = _.uniq acc.files\n          dirs = _.uniq acc.dirs\n          cb null, files, dirs\n        return\n\n      fs.stat fullPath, (err, stat) ->\n        return cb err if err\n        # File calculated\n        --acc.pending\n\n        # File found\n        if stat.isFile() and options.filterFile(fullPath)\n          acc.files.push fullPath\n          return breakIfDone()\n\n        # Directory found\n        else if stat.isDirectory() and options.filterDir(fullPath)\n          acc.dirs.push fullPath\n\n          fs.readdir fullPath, (errReadDir, paths) ->\n            return cb errReadDir if errReadDir\n\n            if !paths or paths.length == 0\n              return breakIfDone()\n\n            # Directory has contents\n            acc.pending += paths.length\n\n            paths = fullPaths paths, fullPath\n\n            # Recurse if we haven't hit max depth\n            if options.recurseDepth > 0\n              options_ = _.clone options\n              options_.recurseDepth--\n              for fullPath_ in paths\n                ls fullPath_, options_, cb, acc\n\n        else\n          return breakIfDone()\n\n      return\n\n    readFileSync = (filePath) ->\n      fs.readFileSync filePath, 'utf8'\n\nTiming helpers\n------------------------------------------------------------------------------\n\n    wait = (seconds, fn) -> setTimeout fn, seconds*1000\n\nString helpers\n------------------------------------------------------------------------------\n\n    trimArgList = (v) ->\n      _trim v.split(',')\n\n    # trim\n    _trim = (any) ->\n      if _.isString any\n        any.trim()\n      else if _.isArray any\n        out = _.map any, (v) -> v.trim()\n        _.reject out, ((v) -> v == '' or v == null)\n      else\n        any\n\n    # startsWith\n    _startsWith = (strInput, strStart) ->\n      throw new Error('startsWith: argument error') unless (_.isString strInput) and (_.isString strStart)\n      strInput.length >= strStart.length and strInput.lastIndexOf(strStart, 0) == 0\n\n    _escapeSingleQuotes = (str) ->\n      str.replace \/'\/g, \"\\\\'\"\n\n    _insertAt = (str, ix, substr) ->\n      str.slice(0,ix) + substr + str.slice(ix)\n\n    _length = (any) ->\n      any.length or _.keys(any).length\n\nCode minification\n------------------------------------------------------------------------------\n\n    oj._minifyJS = (js, options = {}) ->\n\n      if options.filename\n        verbose 4, \"minified #{options.filename}\"\n\n      if options.minify\n        uglifyjs js\n      else\n        js\n\n    oj._minifyCSS = (css, options = {}) ->\n      if options.minify\n        csso.justDoIt css, true # true means apply structural changes\n      else\n        css\n\nRequiring\n------------------------------------------------------------------------------\n\n    # Hooking into require inspired by [node-dev](http:\/\/github.com\/fgnass\/node-dev)\n    _hookRequire = (modules, moduleLinkMap, hookCache={}, hookOriginalCache={}) ->\n      handlers = require.extensions\n      for ext of handlers\n        # Get or create the hook for the extension\n        hook = hookCache[ext] or (hookCache[ext] = _createHook(ext, modules, moduleLinkMap, hookCache, hookOriginalCache))\n        if handlers[ext] != hook\n          # Save a reference to the original handler\n          hookOriginalCache[ext] = handlers[ext]\n          # and replace the handler by our hook\n          handlers[ext] = hook\n      return\n\n    # Hook into one extension\n    _createHook = (ext, modules, moduleLinkMap, hookCache, hookOriginalCache) ->\n      (module, filename) ->\n\n        # Unfortunately require resolves `filename` through soft links\n        # For our module detection to work we need to unresolve these back\n        # Use the moduleLinkMap to unresolve paths starting with `linkPath`\n        # to start with `modulePath` instead.\n        for linkPath, modulePath of moduleLinkMap\n          # Prefix found then replace\n          if 0 == filename.indexOf linkPath\n            rest = filename.slice linkPath.length\n            filename = modulePath + rest\n            # break\n\n        # Override compile to intercept file\n        if !module.loaded\n          _rememberModule modules, filename, null, module.parent.filename\n\n          # if path.extension filename _.indexOf ['.coffee']\n          moduleCompile = module._compile\n          module._compile = (code) ->\n            _rememberModule modules, filename, code, module.parent.filename\n            moduleCompile.apply this, arguments\n            return\n\n        # Invoke the original handler\n        hookOriginalCache[ext](module, filename)\n\n        # Make sure the module did not hijack the handler\n        _hookRequire modules, moduleLinkMap, hookCache, hookOriginalCache\n\n    _unhookRequire = (modules, hookCache, hookOriginalCache) ->\n      handlers = require.extensions\n      for ext of handlers\n        if hookCache[ext] == handlers[ext]\n          handlers[ext] = hookOriginalCache[ext]\n      hookCache = null\n      hookOriginalCache = null\n      return\n\n    # Remember require references\n    _rememberModule = (modules, filename, code, parent) ->\n      verbose 3, \"requiring #{filename}\" if code\n      modules[filename] = _.defaults {code: code, parent:parent}, (modules[filename] or {})\n\n    _rememberModuleDependencies = (modules) ->\n      for filename, module of modules\n        watchParents[filename] ?= []\n        watchParents[filename].push module.parent\n        watchParents[filename] = _.unique watchParents[filename]\n\n    _nodeModulesSupported = oj:1, jquery:1, assert:1, console:1, crypto:1, events:1, freelist:1, path:1, punycode:1, querystring:1, string_decoder:1, tty:1, url:1, util:1\n    _nodeModuleUnsupported = child_process:1, domain:1, fs:1, net:1, os:1, vm:1, buffer:1\n    isNodeModule = (module) -> !!_nodeModulesSupported[module]\n    isUnsupportedNodeModule = (module) -> !!_nodeModuleUnsupported[module]\n    isAppModule = (module) -> (module.indexOf '\/') == -1\n    isRelativeModule = (module) -> (module.indexOf '\/') != -1\n\n    # _saveRequireCache\n    # Save a record of the cache so we can restore it later\n    _requireCache = null\n    _saveRequireCache = ->\n      _requireCache = _.clone require.cache\n\n    # _restoreRequireCache\n    # Remove all recoreds in the cache that weren't there before\n    _restoreRequireCache = ->\n      for k of require.cache\n        delete require.cache[k] unless _requireCache[k]?\n\n    # Clear one record. This does not work in general because\n    # it doesn't recurse. It does work on stand alone modules\n    # like 'path' and 'underscore'\n    _clearRequireCacheRecord = (record) ->\n      delete require.cache[require.resolve record]\n\n    # Parse code with\n    _getRequiresInSource = (code) ->\n      r = new RegExp(\"require\\\\s*\\\\(?\\\\s*[\\\"']([^\\\"']+)\", 'g');\n      out = []\n      while match = r.exec code\n        out.push match[1]\n      out\n\n    _first = (array, fn) ->\n      for x in array\n        y = fn x\n        return y if y\n\n    # Build out the cache into the form:\n    #   cache.native = ['oj','jquery',...]\n    #   cache.modules = {<path\/to\/node_modules>: {<moduleName>:<path\/to\/main\/file.js, ...}, ...}\n    #   cache.files = {<path\/to\/files.js>:<code>}\n\n    _buildRequireCache = (modules, cache, isMinify) ->\n      for fileLocation, data of modules\n        console.log \"fileLocation: \", fileLocation\n\n        # Read code if it is missing\n        if not data.code?\n          throw new Error('data.code is missing')\n          # data.code = stripBOM readFileSync fileLocation\n\n        # Save code to _fileCache\n        _buildFileCache cache.files, fileLocation, data.code, isMinify\n\n        # Generate possible node_module paths given this file\n        modulePrefixes = nodeModulePaths fileLocation\n\n        pathComponents = _first modulePrefixes, (prefix) ->\n          if _startsWith fileLocation, prefix + path.sep\n            modulePath = (fileLocation.slice (prefix.length + 1)).split(path.sep)\n            moduleName = modulePath[0]\n            moduleMain = modulePath.slice(1).join(path.sep)\n            modulesDir: prefix, moduleName:  moduleName, moduleMain: moduleMain, moduleParentPath: module.id\n\n        # Save to cache.modules\n        console.log \"pathComponents: \", pathComponents\n        if pathComponents\n          if not cache.modules[pathComponents.modulesDir]\n            cache.modules[pathComponents.modulesDir] = {}\n          # Example: \/Users\/evan\/oj\/node_modules: {underscore: 'underscore.js'}\n          cache.modules[pathComponents.modulesDir][pathComponents.moduleName] = pathComponents.moduleMain\n\n        # Build cache.native given source code in _fileCache\n        _buildNativeCache cache.native, data.code, isMinify\n\n        # Store complete\n        verbose 4, \"stored #{fileLocation}\"\n\n      # Remove client and server oj if they exist.\n      # This is a special case of the way stuff is included.\n      # To ourselves oj is local but to them oj is native.\n      # Removing this cache record ensures only the native copy\n      # is saved to the client.\n      delete cache.files[require.resolve '..\/oj.js']\n\n      # Separate files into three parts so each can be outputed separately:\n      #   moduleFiles, pageFiles, nativeFiles\n      cache.nativeFiles = cache.native\n      cache.moduleFiles = {}\n      cache.pageFiles = {}\n      for filePath, code of cache.files\n        console.log \"filePath: \", filePath\n        if filePath.indexOf(\"\/node_modules\/\") != -1\n          cache.moduleFiles[filePath] = code\n        else\n          cache.pageFiles[filePath] = code\n      console.log \"\\n\\n\"\n      console.log \"_.keys cache.moduleFiles: \", _.keys cache.moduleFiles\n      console.log \"_.keys cache.pageFiles: \", _.keys cache.pageFiles\n      console.log \"cache.modules: \", cache.modules\n      return cache\n\n    # ###_buildFileCache: build file cache\n    _buildFileCache = (_filesCache, fileName, code, isMinify) ->\n      # Minify code if necessary and cache it\n      _filesCache[fileName] = oj._minifyJS code, {filename:fileName, minify: isMinify}\n\n    # build native module cache given moduleNameList\n    pass = 1\n\n    _buildNativeCache = (nativeCache, code, isMinify) ->\n      # Get moduleName references from code\n      moduleNameList = _getRequiresInSource code\n      _buildNativeCacheFromModuleList nativeCache, moduleNameList, isMinify\n\n    _buildNativeCacheFromModuleList = (nativeCache, moduleNameList, isMinify) ->\n\n      # Loop over modules and add them to native cache\n      while moduleName = moduleNameList.shift()\n\n        # Continue on already loaded native modules\n        continue if nativeCache[moduleName]\n\n        # OJ is built in\n        if moduleName == 'oj'\n          nativeCache.oj = _ojModuleCode isMinify\n\n        # Do nothing if unsupported\n        # Error checking happens earlier and missing modules at this stage are intentional\n        else if isUnsupportedNodeModule moduleName\n          pass\n\n        else if isNodeModule moduleName\n          # Get code\n          codeModule = _nativeModuleCode moduleName, isMinify\n\n          # Cache it\n          nativeCache[moduleName] = codeModule\n\n          # Concat all dependencies and continue on\n          moduleNameList = moduleNameList.concat _getRequiresInSource codeModule\n\n        else\n          pass\n      null\n\n    # ojModuleCode: Get code for oj\n    _ojModuleCode = (isMinify) ->\n      code = readFileSync path.join __dirname, \"..\/oj.js\"\n      oj._minifyJS code, filename:'oj', minify:isMinify\n\n    # nativeModuleCode: Get code for native module\n    _nativeModuleCode = (moduleName, isMinify) ->\n      verbose 3, \"found #{moduleName}\"\n      code = readFileSync path.join __dirname, \"..\/modules\/#{moduleName}.js\"\n\nTemplating\n==============================================================================\n\nCode generation\n------------------------------------------------------------------------------\n\n    # ###_requireCacheToHtml\n    _requireCacheToHtml = (cache, filePath, isMinify, options) ->\n      return \"\"\"\n        <script>\n        #{_requireCacheToJS cache, filePath, isMinify, options}\n        <\/script>\n      \"\"\"\n\n    # ###_requireCacheToJS\n    # Output html from cache and file\n    _requireCacheToJS = (cache, filePath, isMinify, options) ->\n      newline = if isMinify then '' else '\\n'\n\n      # Example:\n      #   filePath: \/User\/name\/project\/www\/file.oj\n      #   commonDir: \/User\/name\/project\n      #   clientDir: \/www\n      #   clientfile: \/file\n\n      # Calculate common path root between all cached files\n      commonDir = commonPath _.keys cache.files\n\n      # Determine directory for client using common path\n      clientDir = _escapeSingleQuotes '\/' + path.relative commonDir, path.dirname filePath\n\n      # Determine file for client given the above directory\n      clientFile = _escapeSingleQuotes '\/' + basenameForExtensions filePath, ['.ojc', '.oj', '.coffee', '.js']\n\n      # Maps from moduleDir -> moduleName -> moduleMain such that\n      # the file path is: moduleDir\/moduleName\/moduleMain\n      _modulesToString = (moduleDir, nameToMain) ->\n        # Use relative path to hide server directory info\n        moduleDir = relativePathWithEscaping moduleDir, commonDir\n        \"M['#{moduleDir}'] = #{JSON.stringify nameToMain};\\n\"\n\n      # Maps moduleName -> code for built in \"native\" modules\n      _nativeModuleToString = (moduleName, code) ->\n        # Use relative path to hide server directory info\n        moduleName = _escapeSingleQuotes moduleName\n        \"\"\"F['#{moduleName}'] = (function(module,exports){(function(process,global,__dirname,__filename){#{newline}#{code}})(P,G,'\/','#{moduleName}');});\\n\"\"\"\n\n      # Maps filePath -> code\n      _fileToString = (filePath, code, prefixWithRequire) ->\n        # Use relative and escaped path\n        filePath = relativePathWithEscaping filePath, commonDir\n        fileDir = path.dirname filePath\n        fileName = path.basename filePath\n        out = if prefixWithRequire then \"require.\" else \"\"\n        out += \"\"\"F['#{filePath}'] = (function(module,exports){(function(require,process,global,__dirname,__filename){#{newline}#{code}})(require.RR('#{filePath}'),require.P,require.G,'#{fileDir}','#{fileName}');});#{newline}\\n\"\"\"\n\n      # Client side code to include modules\n      _modules = \"\"\n      # { '\/Users\/evan\/oj\/node_modules': { underscore: 'underscore.js' } }\n      for moduleDir, nameToMain of cache.modules\n        _modules += _modulesToString moduleDir, nameToMain\n\n      # Client side code to include files from modules and from pages\n      _moduleFiles = \"\"\n      for filePath, code of cache.moduleFiles\n        _moduleFiles += _fileToString filePath, code\n        verbose 4, \"serialized module file `#{filePath}`\"\n\n      _pageFiles = \"\"\n      # Prefix require if modules aren't being output with this\n      prefixWithRequire = !options.modules\n      for filePath, code of cache.pageFiles\n        _pageFiles += _fileToString filePath, code, prefixWithRequire\n        verbose 4, \"serialized page file `#{filePath}`\"\n\n      # Client side code to include native modules\n      _nativeFiles = \"\"\n      for moduleName, code of cache.native\n        _nativeFiles += _nativeModuleToString moduleName, code\n        verbose 4, \"serialized native file '#{moduleName}'\"\n\n      # Browser side node has these abbreviations:\n      #     G = Global\n      #     P = Process\n      #     RR = Require factory to generated require for a given path\n      #     R = Require cache\n      #     F = File cache\n      #     M = Module cache\n\n      # Client side function to run module and cache result\n      _run = oj._minifyJS \"\"\"\n      function run(f){\n          if(R[f] != null)\n            return R[f];\n          var eo = {},\n            mo = {exports: eo};\n          if(typeof F[f] != 'function')\n            throw new Error(\"file not found (\" + f + \")\");\n          F[f](mo,eo);\n          return R[f] = mo.exports;\n        }\n    \"\"\", minify:isMinify\n\n      # Client side function to find module\n      _find = oj._minifyJS \"\"\"\n      function find(m,f){\n          var r, dir, dm, ext, ex, i;\n\n          if (F[m] && !m.match(\/\\\\\/\/))\n            return m;\n\n          if (!!m.match(\/\\\\\/\/)) {\n            r = oj._pathResolve(f, oj._pathJoin(oj._pathDirname(f), m));\n            ext = ['.ojc','.oj','.coffee','.js','.json'];\n            for(i = 0; i < ext.length; i++){\n              ex = ext[i];\n              if(F[r+ex])\n                return r+ex;\n            }\n          } else {\n            if (typeof oj !== 'undefined') {\n              dir = oj._pathDirname(f);\n              while(true) {\n                dm = oj._pathJoin(dir, 'node_modules');\n                if(M[dm] && M[dm][m])\n                  return oj._pathJoin(dm, m, M[dm][m]);\n                if(dir == '\/')\n                  break;\n                dir = oj._pathResolve(dir, '..');\n              }\n            }\n          }\n          throw new Error(\"module not found (\" + m + \")\");\n        }\n      \"\"\", minify: isMinify\n\n      # Begin function\n      js = \"\"\"\n        \/\/ Generated with oj v#{oj.version}\n        ;(function(){\n      \"\"\"\n\n  Add modules if we want to include them\n\n      if options.modules\n        js += \"\"\"\n          var M = {}, F = {}, R = {}, P, G, RR;\n\n          \/\/ Package modules\n          #{_modules}\n          #{_moduleFiles}\n          \/\/ Native modules\n          #{_nativeFiles}\n          \/\/ Define node environment: process P, global G and require factory RR\n          P = {cwd: function(){return '\/'}}\n          G = {process: P,Buffer: {}}\n          RR = function(f){\n            var o = function(m){return run(find(m, f))};\n            o.P = P; o.G = G; o.F = F; o.M = M, o.RR = RR;\n            return o;\n            #{_run}\n            #{_find}\n          };\n\n          \/\/ Define require and oj\n          require = RR('\/');\n          oj = require('oj');\\n\n        \"\"\"\n\n  Include page js if we want to include it\n\n      if options.js\n        js += \"\"\"\n          \\n\/\/ Page files\n          #{_pageFiles}\n          oj.load('#{clientFile}');\\n\n        \"\"\"\n      # End function\n      js += \"\"\"\n        }).call(this);\n      \"\"\"\n\nExpress\n==============================================================================\n\n    oj.__express = renderPath\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9b48b1eecc0c023e072ea081043eac7b20982ed5","subject":"Fixed typo in PHP blurb.","message":"Fixed typo in PHP blurb.","repos":"DoomHammer\/docco,robertmackenzie\/docco,actano\/docco,guigrpa\/docco,jalleyne\/docco,Hellyna\/docco,ShawnHuang\/docco-multidir,lbn\/docco,jrvidal\/docco,DoomHammer\/docco,guigrpa\/docco-extended,lobrien\/docco,lbn\/docco,lobrien\/docco,mhkeller\/docco,whitetrefoil\/docco,jrvidal\/docco,jalleyne\/docco,guigrpa\/docco-extended,erikdiessel\/plidoc,tbremer\/docco,mhkeller\/docco,Hellyna\/docco,guigrpa\/docco,gvithellyna\/docco,tbremer\/docco,MaxwellRebo\/docco,MaxwellRebo\/docco,ShawnHuang\/docco-multidir,gvithellyna\/docco,robertmackenzie\/docco,osharim\/docco,erikdiessel\/plidoc,oponder\/docco,oponder\/docco,osharim\/docco,whitetrefoil\/docco","old_file":"docco.litcoffee","new_file":"docco.litcoffee","new_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* For all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        isText = maybeCode = yes\n        for line, i in lines\n          lines[i] = if maybeCode and match = \/^([ ]{4}|[ ]{0,3}\\t)\/.exec line\n            isText = no\n            line[match[0].length..]\n          else if maybeCode = \/^\\s*$\/.test line\n            if isText then lang.symbol else ''\n          else\n            isText = yes\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n\nTell Marked how to highlight code blocks within comments, treating that code\nas either the language specified in the code block or the language of the file\nif not specified.\n\n      marked.setOptions {\n        highlight: (code, lang) ->\n          lang or= language.name\n\n          if highlightjs.LANGUAGES[lang]\n            highlightjs.highlight(lang, code).value\n          else\n            console.warn \"docco: couldn't highlight code block with unknown language '#{lang}' in #{source}\"\n            code\n      }\n\n      for section, i in sections\n        code = highlightjs.highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      config.languages = buildMatchers config.languages\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    highlightjs = require 'highlight.js'\n\nEnable nicer typography with marked.\n\n    marked.setOptions smartypants: yes\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [file]', 'use a custom languages.json', _.compose JSON.parse, fs.readFileSync)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","old_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* Your all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        isText = maybeCode = yes\n        for line, i in lines\n          lines[i] = if maybeCode and match = \/^([ ]{4}|[ ]{0,3}\\t)\/.exec line\n            isText = no\n            line[match[0].length..]\n          else if maybeCode = \/^\\s*$\/.test line\n            if isText then lang.symbol else ''\n          else\n            isText = yes\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n\nTell Marked how to highlight code blocks within comments, treating that code\nas either the language specified in the code block or the language of the file\nif not specified.\n\n      marked.setOptions {\n        highlight: (code, lang) ->\n          lang or= language.name\n\n          if highlightjs.LANGUAGES[lang]\n            highlightjs.highlight(lang, code).value\n          else\n            console.warn \"docco: couldn't highlight code block with unknown language '#{lang}' in #{source}\"\n            code\n      }\n\n      for section, i in sections\n        code = highlightjs.highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      config.languages = buildMatchers config.languages\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    highlightjs = require 'highlight.js'\n\nEnable nicer typography with marked.\n\n    marked.setOptions smartypants: yes\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [file]', 'use a custom languages.json', _.compose JSON.parse, fs.readFileSync)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ecb534c4fbf16b0a05e8e6fb529fb5a41f34feec","subject":"Reworked search roots, added support for local deps","message":"Reworked search roots, added support for local deps\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"38b363db2f34e0578aba63e87e8d746990a1d84c","subject":"Fix undefined has no method 'status' error","message":"Fix undefined has no method 'status' error\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/server.litcoffee","new_file":"src\/server.litcoffee","new_contents":"    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      if not req.get('Origin') or not (req.get('Origin') in origins)\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status = 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","old_contents":"    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      if not req.get('Origin') or not (req.get('Origin') in origins)\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fed4b9f566085709ea31f2d332d19522bb0bd043","subject":"Add info about Controller::render options","message":"Add info about Controller::render options\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/09_controller.litcoffee","new_file":"docs\/09_controller.litcoffee","new_contents":"# \/api\/App Components\/Batman.Controller\n\nAll controllers in a batman.js app extend `Batman.Controller`. `Batman.Controller`s are responsible for executing _actions_ which fire off requests for model data, render views, or redirect to other actions in response to navigation state changes. `Batman.Controller` is inspired by [ActionController](http:\/\/guides.rubyonrails.org\/action_controller_overview.html), a key component of Ruby on Rails.\n\n## Controller Directory\n\n`Batman.Controller`s are singletons and each controller's instance is available at [`@sharedController`](\/docs\/api\/batman.controller.html#class_accessor_sharedcontroller). Controller instances are also available at `MyApp.get('controllers')`( the app's [`ControllerDirectory`](\/docs\/api\/controllerdirectory.html)). You can get the controller instance by the part of its name before \"Controller\", downcased. For example:\n\n```\nAlfred.TodosController.get('sharedController') # => TodosController instance\nAlfred.get('controllers.todos')                # => TodosController instance\n```\n\n## Actions\n\nEach `Batman.Controller` declares functions which represent actions to be run on a particular page. Typically, these functions will fetch data or render views:\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n  index: (params) ->\n    @set('todos', Alfred.Todo.get('all'))\n    # will automatically render Alfred.TodosIndexView with source `todos\/index`\n\n  show: (params) ->\n    Alfred.Todo.find params.id, (err, record) ->\n      throw err if err\n      @set('todo', record)\n    # will automatically render Alfred.TodosShowView with source `todos\/show`\n```\n\nActions are passed a `params` argument, which is an object containing URL parameters. Named route parameters (eg, `todos\/:id`) and query string parameters (`?key=value`) are accessible in `params`.\n\n## routingKey and Minification\n\nEach `Batman.Controller` must have a `routingKey`, which is used by the batman.js router. It also makes the app minification-safe. You can set it inside the controller definition:\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n```\n\nAn app will fail to run if a controller's `routingKey` is not defined. To disable this requirement, set `Batman.config.minificationErrors` to false.\n\n## Error Handling\n\n`Batman.Controller` has a built-in structure for handling errors that occur during controller actions. Inside a controller definition, you can map errors to handlers using `@catchError`. Then, you can wrap a storage operation callback with `@errorHandler` to have any errors caught by the defined handlers. If you use `@errorHandler`, errors without declared handlers will be thrown (since they aren't passed to the callback).\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n  # declare a handler with `@catchError`:\n  @catchError Batman.StorageAdapter.NotFoundError, with: 'render404'\n\n  show: (params) ->\n    # wrap your storage operation in `@errorHandler`\n    App.Todo.find params.id, @errorHandler (record, env) =>\n      @set('todo', record)\n\n  # error is passed to the handler\n  render404: (error) -> @render(source: \"errors\/404\")\n```\n\nUsually, you want to declare error handlers in `MyApp.ApplicationController`, then extend `MyApp.ApplicationController` in your other controllers:\n\n```coffeescript\nclass Alfred.ApplicationController extends Batman.Controller\n  @catchError Batman.StorageAdapter.NotFoundError, with: 'render404'\n  # etc...\n\nclass Alfred.TodosController extends Alfred.ApplicationController\n  # will use ApplicationController's handlers for @errorHandler\n```\n\nFor a full list of storage errors, see [`Batman.StorageAdapter` Errors](\/docs\/api\/batman.storageadapter_errors.html).\n\n## ::render([options : [Object|Boolean]]) : View\n\n`render` is used to control the rendering of the current action. Unless specified otherwise, `Batman.Controller` actions render automatically.\n\nPassing `false` will prevent the current action from rendering the view.\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  actionWithNoRender: ->\n    @render(false) # no view will be rendered\n\n  actionWithDelayedRender: ->\n    setTimeout (-> @render()), 1000 # view rendered after 1 second\n    @render(false)\n```\n\nBy passing an `options` object, you may override the default `view`, `source`, `viewClass` or `yield` block.\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  actionWithCustomSource: ->\n    @render(source: 'errors\/404')\n\n  actionWithCustomYield: ->\n    @render(into: 'not-main')\n```\n\n`render` options include:\n\n- `view`: a view instance to render\n- `viewClass`: a class to instantiate and render\n- `source`: An HTML source path to use for the rendered view\n- `into`: The yield where the view should be rendered\n- Other options are passed to the `viewClass` constructor, if provided.\n\nFor more information on yield blocks, see [`Controller::.defaultRenderYield`](\/docs\/api\/batman.controller.html#prototype_property_defaultrenderyield).\n\n## @beforeAction([options : [string|Object],] filter : [string|Function])\n\nDeclares that a function should be executed should be executed before this controller's actions. If any `beforeAction` filter returns `false` or calls [`@redirect`](\/docs\/api\/batman.controller.html#prototype_function_redirect), the controller action won't be executed. `@beforeAction` accepts:\n\n-  `options` representing which action(s) to execute the filter before (optional)\n-  `filter`, either a string naming a function _or_ a function to execute.\n\nThe `options` argument can take three forms:\n\n1. `undefined`: this filter should be executed before all actions.\n2. `String`: this filter should be executed before the action named by the string.\n3. `Object`: this filter should be executed before the actions named by an Array at the `only` key in the options object, or before all actions excluding those named by an Array at the `except` key in the options object.\n\n<!-- tests -->\n\n    test \"@beforeAction allows declaration of filters to execute before an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n    test \"@beforeAction allows declaration of named filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"show\", \"fetchTodo\"\n        fetchTodo: -> @set(\"todo\", {isDone: true})\n        show: ->\n          @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n\n    test \"@beforeAction allows whitelisting or blacklisting filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: [\"show\", \"edit\"], \"fetchTodo\"\n        @beforeAction except: [\"index\"], \"prepareNewTodo\"\n        fetchTodo: -> @set \"todo\", {isDone: true}\n        prepareNewTodo: -> @set \"newTodo\", {isDone: false}\n        index: -> @render false\n        show: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n      deepEqual controller.get(\"newTodo\"), {isDone: false}\n\n    test \"@beforeAction allows declaration of filters to execute before all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n## @afterAction([options : [string|Object],] filter : [string|Function])\n\nDeclares that a function should be executed after this controller's actions (and after any `render` or `redirect`s). `@afterAction` accepts `options` and `filter` (see [`@beforeAction`](\/docs\/api\/batman.controller.html#class_function_beforeaction)).\n\n    test \"@afterAction allows declaration of filters to execute after an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n    test \"@afterAction allows declaration of named filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"create\", \"notify\"\n        notify: -> result = \"Todo created successfully.\"\n        create: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows whitelisting or blacklisting filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: [\"create\", \"update\"], \"notify\"\n        index: -> @render false\n        create: -> @render false\n        notify: -> result = \"Todo created successfully.\"\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal result, null\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows declaration of filters to execute after all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n## ::executeAction(action: string[, params: Object])\n\nRuns the `action` specified, including all applicable `@beforeAction`s and `@afterAction`s. Optionally, `params` can be passed into the new action for processing. If no params are passed, it will default to the params of the current action.\n\n    test \"executeAction will run the action and all @beforeAction and @afterAction filters\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n        other: ->\n          @executeAction(\"index\")\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      deepEqual results, [\"before!\", \"action!\", \"after!\"]\n\n## ::redirect(options: [string|Object])\n\nProperly handles the controller filter chain and loads a new page with [`Batman.redirect`](\/docs\/api\/batman.html#class_function_redirect). See [`Batman.redirect`](\/docs\/api\/batman.html#class_function_redirect) for allowed `options`. If `options` is an object, the current controller will be added as the object's `controller` attribute (if it isn't already present), so calling `@redirect({action: \"show\", id: itemId})` is equivalent to calling `@redirect({action: 'show', id: itemId, controller: 'items'})`.\n\n## ::scrollToHash([hash: string])\n\n`scrollToHash` emulates the native scrolling behaviour of the browser by allowing the URL to link to a specific ID on the page. The code will look for an element with a matching ID to `hash` if it is provided otherwise using the `#` parameter in the URL. If an element is found, the page will scroll to the matching element.\n\n## ::.autoScrollToHash[= true] : boolean\n\nSpecifies if the controller should automatically scroll to the element with ID equal to the `hash` parameter. This behaviour emulates the native behaviour of the same nature, but is implemented in Batman so the functionality works after each dispatch (instead of each page refresh) and when Batman is using hash bang routing.\n\n## ::.defaultRenderYield[= 'main'] : string\n\n`defaultRenderYield` specifies which yield (see [`data-yield`](\/docs\/api\/batman.view_bindings.html#data-yield)) a controller should automatically render into if no yield is declared.\n\n## @%sharedController : Controller\n\nThe singleton instance of the `Controller`.\n\n## @catchError(errorClasses..., {with : [String|Array]})\n\nDeclares that errors which are `instanceof` any of `errorClasses` should be handled by `with` when using [`@errorHandler`](\/docs\/api\/batman.controller.html#class_function_errorhandler). `with` is the name of a prototype function (or an array of names) which will be invoked with the error. See [\"Error Handling\"](\/docs\/api\/batman.controller.html#error_handling).\n\n## @errorHandler(callback)\n\nWraps a storage action, passing the first argument (`error`) to error handlers declared with [`@catchError`](\/docs\/api\/batman.controller.html#class_function_catcherror). Callback should take arguments `result, env` (`error` is not present because it was passed to error handlers). See [\"Error Handling\"](\/docs\/api\/batman.controller.html#error_handling).\n","old_contents":"# \/api\/App Components\/Batman.Controller\n\nAll controllers in a batman.js app extend `Batman.Controller`. `Batman.Controller`s are responsible for executing _actions_ which fire off requests for model data, render views, or redirect to other actions in response to navigation state changes. `Batman.Controller` is inspired by [ActionController](http:\/\/guides.rubyonrails.org\/action_controller_overview.html), a key component of Ruby on Rails.\n\n## Controller Directory\n\n`Batman.Controller`s are singletons and each controller's instance is available at [`@sharedController`](\/docs\/api\/batman.controller.html#class_accessor_sharedcontroller). Controller instances are also available at `MyApp.get('controllers')`( the app's [`ControllerDirectory`](\/docs\/api\/controllerdirectory.html)). You can get the controller instance by the part of its name before \"Controller\", downcased. For example:\n\n```\nAlfred.TodosController.get('sharedController') # => TodosController instance\nAlfred.get('controllers.todos')                # => TodosController instance\n```\n\n## Actions\n\nEach `Batman.Controller` declares functions which represent actions to be run on a particular page. Typically, these functions will fetch data or render views:\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n  index: (params) ->\n    @set('todos', Alfred.Todo.get('all'))\n    # will automatically render Alfred.TodosIndexView with source `todos\/index`\n\n  show: (params) ->\n    Alfred.Todo.find params.id, (err, record) ->\n      throw err if err\n      @set('todo', record)\n    # will automatically render Alfred.TodosShowView with source `todos\/show`\n```\n\nActions are passed a `params` argument, which is an object containing URL parameters. Named route parameters (eg, `todos\/:id`) and query string parameters (`?key=value`) are accessible in `params`.\n\n## routingKey and Minification\n\nEach `Batman.Controller` must have a `routingKey`, which is used by the batman.js router. It also makes the app minification-safe. You can set it inside the controller definition:\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n```\n\nAn app will fail to run if a controller's `routingKey` is not defined. To disable this requirement, set `Batman.config.minificationErrors` to false.\n\n## Error Handling\n\n`Batman.Controller` has a built-in structure for handling errors that occur during controller actions. Inside a controller definition, you can map errors to handlers using `@catchError`. Then, you can wrap a storage operation callback with `@errorHandler` to have any errors caught by the defined handlers. If you use `@errorHandler`, errors without declared handlers will be thrown (since they aren't passed to the callback).\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n  # declare a handler with `@catchError`:\n  @catchError Batman.StorageAdapter.NotFoundError, with: 'render404'\n\n  show: (params) ->\n    # wrap your storage operation in `@errorHandler`\n    App.Todo.find params.id, @errorHandler (record, env) =>\n      @set('todo', record)\n\n  # error is passed to the handler\n  render404: (error) -> @render(source: \"errors\/404\")\n```\n\nUsually, you want to declare error handlers in `MyApp.ApplicationController`, then extend `MyApp.ApplicationController` in your other controllers:\n\n```coffeescript\nclass Alfred.ApplicationController extends Batman.Controller\n  @catchError Batman.StorageAdapter.NotFoundError, with: 'render404'\n  # etc...\n\nclass Alfred.TodosController extends Alfred.ApplicationController\n  # will use ApplicationController's handlers for @errorHandler\n```\n\nFor a full list of storage errors, see [`Batman.StorageAdapter` Errors](\/docs\/api\/batman.storageadapter_errors.html).\n\n## ::render([options : [Object|boolean]])\n\n`render` is used to control the rendering of the current action. Unless specified otherwise, `Batman.Controller` actions render automatically.\n\nPassing `false` will prevent the current action from rendering the view.\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  actionWithNoRender: ->\n    @render(false) # no view will be rendered\n\n  actionWithDelayedRender: ->\n    setTimeout (-> @render()), 1000 # view rendered after 1 second\n    @render(false)\n```\n\nBy passing an `options` object, you may override the default `view`, `source`, `viewClass` or `yield` block.\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  actionWithCustomSource: ->\n    @render(source: 'errors\/404')\n\n  actionWithCustomYield: ->\n    @render(into: 'not-main')\n```\n\nFor more information on yield blocks, see [`Controller::.defaultRenderYield`](\/docs\/api\/batman.controller.html#prototype_property_defaultrenderyield).\n\n## @beforeAction([options : [string|Object],] filter : [string|Function])\n\nDeclares that a function should be executed should be executed before this controller's actions. If any `beforeAction` filter returns `false` or calls [`@redirect`](\/docs\/api\/batman.controller.html#prototype_function_redirect), the controller action won't be executed. `@beforeAction` accepts:\n\n-  `options` representing which action(s) to execute the filter before (optional)\n-  `filter`, either a string naming a function _or_ a function to execute.\n\nThe `options` argument can take three forms:\n\n1. `undefined`: this filter should be executed before all actions.\n2. `String`: this filter should be executed before the action named by the string.\n3. `Object`: this filter should be executed before the actions named by an Array at the `only` key in the options object, or before all actions excluding those named by an Array at the `except` key in the options object.\n\n<!-- tests -->\n\n    test \"@beforeAction allows declaration of filters to execute before an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n    test \"@beforeAction allows declaration of named filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"show\", \"fetchTodo\"\n        fetchTodo: -> @set(\"todo\", {isDone: true})\n        show: ->\n          @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n\n    test \"@beforeAction allows whitelisting or blacklisting filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: [\"show\", \"edit\"], \"fetchTodo\"\n        @beforeAction except: [\"index\"], \"prepareNewTodo\"\n        fetchTodo: -> @set \"todo\", {isDone: true}\n        prepareNewTodo: -> @set \"newTodo\", {isDone: false}\n        index: -> @render false\n        show: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n      deepEqual controller.get(\"newTodo\"), {isDone: false}\n\n    test \"@beforeAction allows declaration of filters to execute before all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n## @afterAction([options : [string|Object],] filter : [string|Function])\n\nDeclares that a function should be executed after this controller's actions (and after any `render` or `redirect`s). `@afterAction` accepts `options` and `filter` (see [`@beforeAction`](\/docs\/api\/batman.controller.html#class_function_beforeaction)).\n\n    test \"@afterAction allows declaration of filters to execute after an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n    test \"@afterAction allows declaration of named filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"create\", \"notify\"\n        notify: -> result = \"Todo created successfully.\"\n        create: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows whitelisting or blacklisting filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: [\"create\", \"update\"], \"notify\"\n        index: -> @render false\n        create: -> @render false\n        notify: -> result = \"Todo created successfully.\"\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal result, null\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows declaration of filters to execute after all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n## ::executeAction(action: string[, params: Object])\n\nRuns the `action` specified, including all applicable `@beforeAction`s and `@afterAction`s. Optionally, `params` can be passed into the new action for processing. If no params are passed, it will default to the params of the current action.\n\n    test \"executeAction will run the action and all @beforeAction and @afterAction filters\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n        other: ->\n          @executeAction(\"index\")\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      deepEqual results, [\"before!\", \"action!\", \"after!\"]\n\n## ::redirect(options: [string|Object])\n\nProperly handles the controller filter chain and loads a new page with [`Batman.redirect`](\/docs\/api\/batman.html#class_function_redirect). See [`Batman.redirect`](\/docs\/api\/batman.html#class_function_redirect) for allowed `options`. If `options` is an object, the current controller will be added as the object's `controller` attribute (if it isn't already present), so calling `@redirect({action: \"show\", id: itemId})` is equivalent to calling `@redirect({action: 'show', id: itemId, controller: 'items'})`.\n\n## ::scrollToHash([hash: string])\n\n`scrollToHash` emulates the native scrolling behaviour of the browser by allowing the URL to link to a specific ID on the page. The code will look for an element with a matching ID to `hash` if it is provided otherwise using the `#` parameter in the URL. If an element is found, the page will scroll to the matching element.\n\n## ::.autoScrollToHash[= true] : boolean\n\nSpecifies if the controller should automatically scroll to the element with ID equal to the `hash` parameter. This behaviour emulates the native behaviour of the same nature, but is implemented in Batman so the functionality works after each dispatch (instead of each page refresh) and when Batman is using hash bang routing.\n\n## ::.defaultRenderYield[= 'main'] : string\n\n`defaultRenderYield` specifies which yield (see [`data-yield`](\/docs\/api\/batman.view_bindings.html#data-yield)) a controller should automatically render into if no yield is declared.\n\n## @%sharedController : Controller\n\nThe singleton instance of the `Controller`.\n\n## @catchError(errorClasses..., {with : [String|Array]})\n\nDeclares that errors which are `instanceof` any of `errorClasses` should be handled by `with` when using [`@errorHandler`](\/docs\/api\/batman.controller.html#class_function_errorhandler). `with` is the name of a prototype function (or an array of names) which will be invoked with the error. See [\"Error Handling\"](\/docs\/api\/batman.controller.html#error_handling).\n\n## @errorHandler(callback)\n\nWraps a storage action, passing the first argument (`error`) to error handlers declared with [`@catchError`](\/docs\/api\/batman.controller.html#class_function_catcherror). Callback should take arguments `result, env` (`error` is not present because it was passed to error handlers). See [\"Error Handling\"](\/docs\/api\/batman.controller.html#error_handling).\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"aec1e5133db3bbe7a742f3868f77af431608bf73","subject":"Update audio.litcoffee","message":"Update audio.litcoffee","repos":"alexrkass\/oscilloscope,alexrkass\/oscilloscope,alexrkass\/oscilloscope","old_file":"js\/audio.litcoffee","new_file":"js\/audio.litcoffee","new_contents":"See [this blog](http:\/\/srchea.com\/experimenting-with-web-audio-api-three-js-webgl) for a very helpful tutorial.\n\n\nFirst set up a context upon which all the functions\nused to parse the audio will be called:\n\n\n\ttry audio = new AudioContext()\n\nThen open an HTTP request to asynchronously get your audio file:\n\n\turl = 'data\/11 Where I\\'m Trying To Go (Marvel Years Remix).mp3';\n\trequest = new XMLHttpRequest();\n\trequest.open('GET', url, true);\n\trequest.responseType = \"arraybuffer\";\n\nWhen the request returns, onload is called, which in turn calls setup.\n\n\trequest.onload = ()->\n\t\taudio.decodeAudioData(\n\t\t\trequest.response,\n\t\t\t(buffer) ->\n\nThe AudioBufferSourceNode contains the input audio data and outputs to the analyser and output.\n\n\t\t\t\tsource = audio.createBufferSource();\n\t\t\t\tsource.buffer = buffer;\n\t\t\t\tsource.connect(audio.destination);\n\nThe ScriptProcessorNode takes data from the analyser as its input and outputs to the destination node which plays the sound.\n\n\t\t\t\tsourceJs = audio.createScriptProcessor(2048,1,1)\n\t\t\t\tsourceJs.buffer = buffer\n\n\n\nThe AnalyserNode takes the current frequency data from the AudioBufferSourceNode, smoothes it, and outputs to the ScriptProcessorNode\n\n\t\t\t\tanalyser = audio.createAnalyser();\n\t\t\t\tanalyser.smoothingTimeConstant = 1;\n\t\t\t\tanalyser.fftSize = 512;\n\t\t\t\tsource.connect(analyser);\n\t\t\t\tanalyser.connect(sourceJs);\n\nCreate the oscilloscope and connect the AudioBufferSourceNode to it\n\n\t\t\t\tmyOscilloscope = new WavyJones(audio, 'oscilloscope');\n\t\t\t\tanalyser.connect(myOscilloscope);\n\t\t\t\tsourceJs.onaudioprocess = (e) ->\n\t\t\t\t\tarray = new Uint8Array(analyser.frequencyBinCount);\n\t\t\t\t\tanalyser.getByteFrequencyData(array);\n\t\t\t\tsource.start(0)\n\t\t\t\treturn\n\t\t\t);\n\nFinally, send the request which begins the flow that ends with the source.start function being called.\n\n\trequest.send()\n","old_contents":"See [this blog](http:\/\/srchea.com\/experimenting-with-web-audio-api-three-js-webgl) for a very helpful tutorial.\n\n\nFirst set up a context within upon all the functions\nused to parse the audio will be called:\n\n\n\ttry audio = new AudioContext()\n\nThen open an HTTP request to asynchronously get your audio file:\n\n\turl = 'data\/11 Where I\\'m Trying To Go (Marvel Years Remix).mp3';\n\trequest = new XMLHttpRequest();\n\trequest.open('GET', url, true);\n\trequest.responseType = \"arraybuffer\";\n\nWhen the request returns, onload is called, which in turn calls setup.\n\n\trequest.onload = ()->\n\t\taudio.decodeAudioData(\n\t\t\trequest.response,\n\t\t\t(buffer) ->\n\nThe AudioBufferSourceNode contains the input audio data and outputs to the analyser and output.\n\n\t\t\t\tsource = audio.createBufferSource();\n\t\t\t\tsource.buffer = buffer;\n\t\t\t\tsource.connect(audio.destination);\n\nThe ScriptProcessorNode takes data from the analyser as its input and outputs to the destination node which plays the sound.\n\n\t\t\t\tsourceJs = audio.createScriptProcessor(2048,1,1)\n\t\t\t\tsourceJs.buffer = buffer\n\n\n\nThe AnalyserNode takes the current frequency data from the AudioBufferSourceNode, smoothes it, and outputs to the ScriptProcessorNode\n\n\t\t\t\tanalyser = audio.createAnalyser();\n\t\t\t\tanalyser.smoothingTimeConstant = 1;\n\t\t\t\tanalyser.fftSize = 512;\n\t\t\t\tsource.connect(analyser);\n\t\t\t\tanalyser.connect(sourceJs);\n\nCreate the oscilloscope and connect the AudioBufferSourceNode to it\n\n\t\t\t\tmyOscilloscope = new WavyJones(audio, 'oscilloscope');\n\t\t\t\tanalyser.connect(myOscilloscope);\n\t\t\t\tsourceJs.onaudioprocess = (e) ->\n\t\t\t\t\tarray = new Uint8Array(analyser.frequencyBinCount);\n\t\t\t\t\tanalyser.getByteFrequencyData(array);\n\t\t\t\tsource.start(0)\n\t\t\t\treturn\n\t\t\t);\n\nFinally, send the request which begins the flow that ends with the source.start function being called.\n\n\trequest.send()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9290d8a13133b98c19ad1c7c84000bd5b86c9279","subject":"Began implementing player controls.  Part of #10.","message":"Began implementing player controls.  Part of #10.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator","old_file":"src\/game.litcoffee","new_file":"src\/game.litcoffee","new_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n       \n    triangle = undefined\n    \n    testEntity = testMap = testNavmesh = undefined\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load (require \".\/testEntity.msc\"), (testEntity_) ->\n            testEntity = testEntity_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    yaw = 0\n    pitch = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->    \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            \n        matrix.translate velocity, entityTransform        \n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, 10, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.2, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.2\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n    \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            firstTick = false\n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n\n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, torsoTransformToDraw\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw testEntity, torsoTransformPreviousDraw, torsoTransformToDraw\n        \n        return\n        \n    module.exports = { load, tick, draw }","old_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n       \n    triangle = undefined\n    \n    testEntity = testMap = testNavmesh = undefined\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load (require \".\/testEntity.msc\"), (testEntity_) ->\n            testEntity = testEntity_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    translation = []\n    acceleration = []\n    forwardVelocity = []\n    sidewardVelocity = []\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->    \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            \n        matrix.translate velocity, entityTransform        \n        \n        # Left\/right rotation.\n        matrix.rotateY ((gamepad.left - gamepad.right) * 0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            vector.multiply.byScalar zAxis, ((gamepad.forward - gamepad.backward) * 0.2), acceleration\n            vector.add.vector velocity, acceleration, velocity\n        \n            # Apply friction.  There is more sidewards than backwards\/forwards.\n            vector.flatten velocity, zAxis, sidewardVelocity\n            vector.straighten velocity, zAxis, forwardVelocity\n            vector.multiply.byScalar sidewardVelocity, 0.9, sidewardVelocity\n            vector.multiply.byScalar forwardVelocity, 0.99, forwardVelocity\n            vector.add.vector sidewardVelocity, forwardVelocity, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n    \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            firstTick = false\n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw testEntity, entityTransformPreviousDraw, entityTransformToDraw\n        \n        return\n        \n    module.exports = { load, tick, draw }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ab06c14b3b75f7125108747cd0d14717cddd34f6","subject":"Fixed plane.fromTriangle generating a backwards normal.","message":"Fixed plane.fromTriangle generating a backwards normal.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat","old_file":"src\/plane.litcoffee","new_file":"src\/plane.litcoffee","new_contents":"A plane is an object containing:\n\n- normal: A vector specifying the facing direction of the plane.\n- distance: A number specifying how far from 0, 0, 0 along the normal the plane \n            is.\n            \nExports an object.\n\n    vector = require \".\/vector.litcoffee\"\n    tempA = []\n    tempB = []\n\nCall the \"fromTriangle\" property with three input vectors forming a clockwise \ntriangle and an output object to create a plane on which those three vectors \nlie.  If the output object is undefined, an empty one is created.  The output \nobject is returned.\n\n    fromTriangle = (a, b, c, output) ->\n        output = output or {}\n        output.normal = output.normal or []\n        vector.subtract.vector a, b, tempA\n        vector.subtract.vector a, c, tempB\n        vector.cross tempB, tempA, output.normal\n        vector.normalize output.normal, output.normal\n        output.distance = vector.dot output.normal, a\n        output\n            \nCall the \"distance\" property with a plane and a vector.  The distance between\nthe plane and vector is returned.  If the vector is behind the plane, the\ndistance is negative.\n\n    distance = (plane, input) -> (vector.dot plane.normal, input) - plane.distance\n    \nCall the \"project\" property with a plane, input vector and output vector to\nwrite the nearest point to the input vector on the plane to the output vector.\n    \n    project = (plane, input, output) ->\n        dist = distance plane, input\n        vector.multiply.scalarBy dist, plane.normal, tempA\n        vector.subtract.vector input, tempA, output\n        return\n    \n    module.exports = {\n        fromTriangle\n        distance\n        project\n    }","old_contents":"A plane is an object containing:\n\n- normal: A vector specifying the facing direction of the plane.\n- distance: A number specifying how far from 0, 0, 0 along the normal the plane \n            is.\n            \nExports an object.\n\n    vector = require \".\/vector.litcoffee\"\n    tempA = []\n    tempB = []\n\nCall the \"fromTriangle\" property with three input vectors forming a clockwise \ntriangle and an output object to create a plane on which those three vectors \nlie.  If the output object is undefined, an empty one is created.  The output \nobject is returned.\n\n    fromTriangle = (a, b, c, output) ->\n        output = output or {}\n        output.normal = output.normal or []\n        vector.subtract.vector a, b, tempA\n        vector.subtract.vector a, c, tempB\n        vector.cross tempA, tempB, output.normal\n        vector.normalize output.normal, output.normal\n        output.distance = vector.dot output.normal, a\n        output\n            \nCall the \"distance\" property with a plane and a vector.  The distance between\nthe plane and vector is returned.  If the vector is behind the plane, the\ndistance is negative.\n\n    distance = (plane, input) -> (vector.dot plane.normal, input) - plane.distance\n    \nCall the \"project\" property with a plane, input vector and output vector to\nwrite the nearest point to the input vector on the plane to the output vector.\n    \n    project = (plane, input, output) ->\n        dist = distance plane, input\n        vector.multiply.scalarBy dist, plane.normal, tempA\n        vector.subtract.vector input, tempA, output\n        return\n    \n    module.exports = {\n        fromTriangle\n        distance\n        project\n    }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fa1af4c8c03fe6c6a47b1795870648ae924c34c3","subject":"Work on Batman.View docs","message":"Work on Batman.View docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/13_view.litcoffee","new_file":"docs\/13_view.litcoffee","new_contents":"# \/api\/App Components\/Batman.View\n\n`Batman.View`s connect a batman.js app to the DOM. This includes rendering HTML, handling DOM events, and maintaining view bindings. `Batman.View` extends `Batman.Object`. When subclassing `Batman.View`, you can create reusable UI components by defining attributes of the new view:\n\n- [`::source`](\/docs\/api\/batman.view.html#prototype_accessor_source) or [`::html`](\/docs\/api\/batman.view.html#prototype_accessor_html) define the view's HTML.\n- [`@option`](\/docs\/api\/batman.view.html#class_function_option) adds context-based initialization options.\n- [`@filter`](\/docs\/api\/batman.view.html#class_function_filter) adds custom view filters.\n- [Lifecycle hooks](\/docs\/views.html) fire when the view is loaded, rendered, or destroyed.\n\nFor more information about views, see [the guide](\/docs\/views.html).\n\n## Accessors and Event Handlers\n\n[View bindings](\/docs\/api\/batman.view_bindings.html) have access to the views they're rendered by, so custom views are a great place to define view-specific accessors and event handlers. Then, you can connect them to your HTML with view bindings. For example, define a view:\n\n```coffeescript\nclass CoffeeView extends Batman.View\n  @accessor 'coffeeOfTheDay', -> \"Guatemalan\"\n  drinkCoffee: -> alert(\"Yum!!\")\n```\n\nthen apply it to some HTML:\n\n```html\n<div data-view='CoffeeView'>\n  <span data-bind='coffeeOfTheDay'><\/span>\n  <button data-event-click='drinkCoffee'> Take a sip! <\/button>\n<div>\n```\n\nData bindings look for keys on their closest views first, so these bindings will be handled by `CoffeeView`. If the HTML inside a custom view will always be the same, you can use [`::source`](\/docs\/api\/batman.view.html#prototype_accessor_source) or [`::html`](\/docs\/api\/batman.view.html#prototype_accessor_html) to define it.\n\n## ::constructor(options = {}) : Batman.View\n\nReturns a new `Batman.View`. Since `Batman.View` extends `Batman.Object`, all `options` are mixed in to the new instance. Use this to override `html`, `node`, `superview`, `parentNode`, and\/or your custom data.\n\n## ::lookupKeypath(keypath : String)\n\nTraverses up the view tree searching for `keypath` and returns the first\nresult or `undefined` if no match is found. The path it takes is:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\n    test 'lookupKeypath returns the value if defined on the view or on an ancestor', ->\n      superview = new Batman.View(cat: 'Meowie')\n      subview = new Batman.View(superview: superview, dog: 'Fido')\n      equal 'Fido', subview.lookupKeypath('dog'), \"finds an accessor on itself\"\n      equal 'Meowie', subview.lookupKeypath('cat'), \"finds an accessor on its superview\"\n      equal undefined, subview.lookupKeypath('bogusKeypath'), \"returns undefined if the keypath isn't defined\"\n\nIf used in an accessor, `keypath` is registered as source and will be correctly bound. `lookupKeypath` is used by [view bindings](\/docs\/api\/batman.view_bindings.html) to get data.\n\n## ::setKeypath(keypath, value)\n\nTraverses the view tree searching for the specified keypath and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is used by [view bindings](\/docs\/api\/batman.view_bindings.html) to set data.\n\n    test 'setKeypath sets the value if defined on the view or on an ancestor', ->\n      superview = new Batman.View(cat: 'Meowie')\n      subview = new Batman.View(superview: superview, dog: 'Fido')\n      subview.setKeypath('cat', 'Mittens')\n      equal 'Mittens', superview.get('cat'), \"updates an accessor on its superview\"\n      subview.setKeypath('dog', 'Lassie')\n      equal 'Lassie', subview.get('dog'), \"updates an accessor on itself\"\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n## ::%node : Node\n\nReturns the DOM node that this view encapsulates.\n\nAccessing `node` will load and parse the template if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\nYou can also access a view's `node` in its methods, for example, activating jQuery plugins:\n\n```\nclass App.SearchBarView extends Batman.View\n  viewDidAppear: ->\n    $node = $(@get('node'))\n    $node.typeahead() # <= whatever jQuery plugin you want!\n```\n## ::%source : String\n\nThis string will be used to fetch a view's HTML, relative to [`Batman.config.pathToHTML`](\/docs\/configuration.html).\nYou don't need to add `.html` to this string -- it will be added automatically.\n\nInside a controller action, batman.js provides a default source based on the\ncontoller's [`routingKey`](\/docs\/api\/batman.controller.html#routingkey_and_minification) and the [controller action](\/docs\/api\/batman.controller.html#actions).\n\nYou can set `source` in the class definition:\n\n```\nclass App.HeaderNavigationView extends Batman.View\n  source: 'layout\/_header'\n```\n\nOr when calling `@render()` inside a controller action:\n\n```\nclass App.PostsController extends Batman.Controller\n  show: ->\n    @set('post', new App.Post)\n    if @get('post.isAlternative')\n      @render(source: \"posts\/alternative_new\")\n    else\n      @render() # defaults to 'posts\/new'\n```\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview. You can specify a view's HTML when you define the class:\n\n```\nclass App.SearchBarView extends Batman.View\n  html: \"<input type='text' placeholder='Enter a search term' \/>\"\n```\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n    test 'setting a source loads the correct template', ->\n      Batman.View.store.set('\/animals', '<div>cat<\/div>')\n      view = new Batman.View(source: '\/animals')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n## @filter(label : string, filter : function)\n\nDefines a custom [view filter](\/docs\/api\/batman.view_filters.html) for use within the `View`.\n\n`filter` will be invoked with the pre-filter `value` and any arguments passed to the view filter. For example:\n\n```coffeescript\nclass App.MultiplierView extends Batman.View\n  @filter 'multiplyBy', (value, multiplier) -> value * multiplier\n```\n\nwould handle:\n\n```html\n<div data-view='MultiplierView' data-context-amount='100'>\n  <span data-bind='amount | multiplyBy 6'>\n    <!-- would render to \"600\" -->\n  <\/span>\n<\/div>\n```\n\n_Note_: If the `View`'s HTML is loaded before the view is instantiated, this filter won't have been defined yet and batman.js will throw an error. Avoid this by defining your custom filter at app-level or by defining the `View`'s HTML with [`::source`](\/docs\/api\/batman.view.html#prototype_accessor_source) or [`::html`](\/docs\/api\/batman.view.html#prototype_accessor_html).\n\n## @option(keys...)\n\nDefines a custom option for the `View`. `@option` allows you to initialize your view with data from its context. For example:\n\n```coffeescript\nclass App.MultiplierView extends Batman.View\n  @option 'amount', 'multiplier'\n  @accessor 'finalAmount', -> @get('amount') * @get('multiplier')\n```\n\n```html\n<div data-view='MultiplierView' data-view-amount='10' data-view-multiplier='8'>\n  <span data-bind='finalAmount'>\n    <!-- would render to \"80\" !-->\n  <\/span>\n<\/div>\n```\n\nOptions passed with `data-view-#{option}` may also be keypaths. Keypath changes will be tracked by the view.\n\n## ::.superview : Batman.View\n\nReturns the view's superview. Every view except an app's `LayoutView` has a superview.\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of this `View`. Since it's a [`Batman.Set`](\/docs\/api\/batman.set.html), you can operate directly on this set and batman.js will automatically keep the DOM in sync.\n\nAdding to a view's subviews will automatically update the tree and parse\nthe template and bindings. If the superview is in the DOM, this will\ninsert the current view's node into the DOM.\n\n    test 'adding to a superview parses bindings', ->\n      superview = new Batman.View()\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      superview.subviews.add(view)\n      equal 'cat', view.get('node').firstChild.innerHTML\n\nRemoving from a view's subviews will automatically remove the subview from\nthe DOM.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View(html: '', parentNode: document.body)\n      superview.get('node')\n      view = new Batman.View(html: '', superview: superview)\n\n      ok Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n      superview.subviews.remove(view)\n      ok not Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent (and from the DOM), without killing it.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.removeFromSuperview()\n      ok not superview.subviews.has(view)\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n      test 'die kills the view', ->\n        superview = new Batman.View()\n        view = new Batman.View(superview: superview)\n\n        view.die()\n        equal true, view.isDead\n        equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n    test 'destroySubviews kills all subviews', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: superview)\n\n      superview.destroySubviews()\n      ok one.isDead\n      ok two.isDead\n\n\n## ::propagateToSubviews(eventOrKey : string, value : Object)\n\nIf `value` is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n    test 'propagateToSubviews propagates events', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.on 'eventName', superSpy = createSpy()\n      one.on 'eventName', oneSpy = createSpy()\n      two.on 'eventName', twoSpy = createSpy()\n\n      superview.propagateToSubviews('eventName')\n\n      equal 1, superSpy.callCount\n      equal 1, oneSpy.callCount\n      equal 1, twoSpy.callCount\n\n    test 'propagateToSubviews propagates keys', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.propagateToSubviews('key', 'value')\n\n      equal superview.get('key'), 'value'\n      equal one.get('key'), 'value'\n      equal two.get('key'), 'value'\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n","old_contents":"# \/api\/App Components\/Batman.View\n\nFor a general explanation of `Batman.View` and how it works, see [the guide](\/docs\/views.html).\n\n\n## ::constructor(options = {})\n\nA `View` is a `Batman.Object`, so any options you pass are mixed in. Use this\nto set `html`, `node`, `superview`, `parentNode` and\/or your custom data.\n\n    test 'constructor mixes in options', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'constructor automatically adds to the superview if supplied', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      equal 1, superview.subviews.length\n\n\n## ::lookupKeypath(keypath) : Object\n\nTraverses up the view tree searching for the specified keypath, and returns the\nresult. This is equivalent to performing a `Batman.get` for each view above\n`this` in the tree, until a defined result is returned. The path it takes is as\nfollows:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\nIf there is no match, `undefined` is returned. However, if used in an accessor\nor binding, the entire path to the root will be registered as a potential\nsource of data. Consequently, if the keypath is later set on any part of the\nchain, the data will be correctly bound.\n\n`lookupKeypath` is the function invoked to locate data when evaluating a\nbinding.\n\n    test 'lookupKeypath returns the value if defined on the view', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.lookupKeypath('animal')\n\n    test 'lookupKeypath returns the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'cat')\n      subview = new Batman.View(superview: superview)\n      equal 'cat', subview.lookupKeypath('animal')\n\n\n## ::setKeypath(keypath, value) : Object\n\nTraverses the View tree searching for the specified keypath, and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is the function invoked to set data when using an input binding.\n\n    test 'setKeypath sets the value if defined on the view', ->\n      view = new Batman.View(animal: 'dog')\n\n      view.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'setKeypath sets the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'dog')\n      subview = new Batman.View(superview: superview)\n\n      subview.setKeypath('animal', 'cat')\n      equal 'cat', superview.get('animal')\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n\n## ::%node : Node\n\nA reference to the DOM node that this view encapsulates. The entire tree\nbeneath this node is also the responsibility of this view and\/or its subviews.\n\nAccessing `node` will load and parse the template on demand if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\nYou can also access a view's `node` in its methods, for example, activating jQuery plugins:\n\n```\nclass App.SearchBarView extends Batman.View\n  viewDidAppear: ->\n    $node = $(@get('node'))\n    $node.typeahead() # <= whatever jQuery plugin you want!\n```\n## ::%source : String\n\nThis string will be used to fetch a view's HTML, relative to [`Batman.config.pathToHTML`](\/docs\/configuration.html).\nYou don't need to add `.html` to this string -- it will be added automatically.\n\nInside a controller action, batman.js provides a default source based on the\ncontoller's [`routingKey`](\/docs\/api\/batman.controller.html#routingkey_and_minification) and the [controller action](\/docs\/api\/batman.controller.html#actions).\n\nYou can set `source` in the class definition:\n\n```\nclass App.HeaderNavigationView extends Batman.View\n  source: 'layout\/_header'\n```\n\nOr when calling `@render()` inside a controller action:\n\n```\nclass App.PostsController extends Batman.Controller\n  show: ->\n    @set('post', new App.Post)\n    if @get('post.isAlternative')\n      @render(source: \"posts\/alternative_new\")\n    else\n      @render() # defaults to 'posts\/new'\n```\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview. You can specify a view's HTML when you define the class:\n\n```\nclass App.SearchBarView extends Batman.View\n  html: \"<input type='text' placeholder='Enter a search term' \/>\"\n```\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n    test 'setting a source loads the correct template', ->\n      Batman.View.store.set('\/animals', '<div>cat<\/div>')\n      view = new Batman.View(source: '\/animals')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n## ::.superview : Batman.View\n\nA reference to the current superview (the direct ancestor in the tree). This is\nused for traversing the tree when searching for data, as in\n`View::lookupKeypath`.\n\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of a `View`. To manipulate the view tree, you should\noperate directly on this set \u2014 batman.js will automatically keep the DOM in\nsync with the logical tree.\n\n\n## ::subviews.add(view)\n\nAdding to a view's subview set will automatically update the tree, and parse\nthe template and bindings. If the superview is already in the DOM, this will\ninsert the current view's node into the DOM.\n\n    test 'adding to a superview parses bindings', ->\n      superview = new Batman.View()\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      superview.subviews.add(view)\n      equal 'cat', view.get('node').firstChild.innerHTML\n\n\n## ::subviews.remove(view)\n\nRemoving from a view's subview set will automatically remove the subview from\nthe DOM.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View(html: '', parentNode: document.body)\n      superview.get('node')\n      view = new Batman.View(html: '', superview: superview)\n\n      ok Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n      superview.subviews.remove(view)\n      ok not Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent, without killing it.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.removeFromSuperview()\n      ok not superview.subviews.has(view)\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n    test 'die kills the view', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.die()\n      equal true, view.isDead\n      equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n    test 'destroySubviews kills all subviews', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: superview)\n\n      superview.destroySubviews()\n      ok one.isDead\n      ok two.isDead\n\n\n## ::propagateToSubviews(eventOrKey : string, value : Object)\n\nIf `value` is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n    test 'propagateToSubviews propagates events', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.on 'eventName', superSpy = createSpy()\n      one.on 'eventName', oneSpy = createSpy()\n      two.on 'eventName', twoSpy = createSpy()\n\n      superview.propagateToSubviews('eventName')\n\n      equal 1, superSpy.callCount\n      equal 1, oneSpy.callCount\n      equal 1, twoSpy.callCount\n\n    test 'propagateToSubviews propagates keys', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.propagateToSubviews('key', 'value')\n\n      equal superview.get('key'), 'value'\n      equal one.get('key'), 'value'\n      equal two.get('key'), 'value'\n\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n\n\n## ::filter(label : string, filter : function)\n\nDefines a filter on the `View` class for use within the `View` during rendering.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7c669b7dc39ccff5f6dca3c13032d43733f914da","subject":"Fix greeting when starting server","message":"Fix greeting when starting server\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\tconfig = require '..\/config.js'\n\nInitialize sane values.\n\n\tconfig.port ?= 9001\n\tconfig.host ?= '0.0.0.0'\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\t\tunixSocket: \"#{__dirname}\/..\/inbound.sock\"\n\t\tapp: null\n\t\tserver: null\n\t\tio: null\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting nodePush'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tlog \"Using port: #{config.port}\"\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing Frontend'\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\t@server.listen config.port, config.host, null, =>\n\t\t\t\tif process.getuid() is 0 or process.getgid() is 0\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.type 'text\/plain'\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\t\t\t\t\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\tsocket.listen @unixSocket\n\t\t\tfs.chmod @unixSocket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync @unixSocket\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","old_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\tconfig = require '..\/config.js'\n\nInitialize sane values.\n\n\tconfig.port ?= 9001\n\tconfig.host ?= '0.0.0.0'\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\t\tunixSocket: \"#{__dirname}\/..\/inbound.sock\"\n\t\tapp: null\n\t\tserver: null\n\t\tio: null\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting Pushserver for Tims Chat'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tlog \"Using port: #{config.port}\"\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing Frontend'\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\t@server.listen config.port, config.host, null, =>\n\t\t\t\tif process.getuid() is 0 or process.getgid() is 0\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.type 'text\/plain'\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\t\t\t\t\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\tsocket.listen @unixSocket\n\t\t\tfs.chmod @unixSocket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync @unixSocket\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"f87b47fe6ea6ae11a01129fd7b69327a55480986","subject":"Adding default index to addRow\/removeRow in Table. Fixing themes in View","message":"Adding default index to addRow\/removeRow in Table. Fixing themes in View\n","repos":"ojjs\/oj","old_file":"src\/oj.litcoffee","new_file":"src\/oj.litcoffee","new_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\noj function\n-------------------------------------------------------------------------------\n\n  oj function acts like a tag method that doesn't emit\n  Using inline js so the function can be named\n\n    `function oj(){\n      return oj.tag.apply(this, ['oj'].concat([].slice.call(arguments)).concat([{__quiet__:1}]));\n    }`\n\n  Define oj version\n\n    oj.version = '0.1.5'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Store jQuery reference as either the global reference or as required through `jquery2`.\n  This allows this reference to be included as a script tag, included through npm, or overriden.\n\n    if typeof $ != 'undefined'\n      oj.$ = $\n    else if typeof require != 'undefined'\n      try\n        oj.$ = require 'jquery'\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      oj.$ ->\n\n        oj.$.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n    oj.isOJType = (obj) -> oj.isOJ(obj) and obj.type == obj\n    oj.isOJInstance = (obj) -> oj.isOJ(obj) and not oj.isOJType(obj)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    _map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            _map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n\nIndexing Helpers\n-----------------------------------------------------------------------------\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      _map r, (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name, check) ->\n      check ?= ->\n        if oj.isClient then oj.isDefined(window[name]) else oj.isDefined(global[name])\n      throw new Error(\"oj: #{name} dependency is missing\") unless check()\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw new Error('oj.isProperty: string expected for second argument') unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, rest...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from rest by unioning all objects\n\n      {args, options:attributes} = oj.unionArguments rest\n\n      if isQuiet = attributes.__quiet__\n        delete attributes.__quiet__\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n\n        else if oj.isFunction arg\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to.\n  Do not emit when quiet is set,\n\n      oj._argsAppend(ojml) unless isQuiet\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Get quiet tag name\n\n    _getQuietTagName = (tag) ->\n      '_' + tag\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n\n  Tag functions emit by default\n\n        oj[t] = -> oj.tag t, arguments...\n\n  Underscore tag functions do not emit\n\n        qt = _getQuietTagName t\n        oj[qt] = -> oj.tag t, {__quiet__:1}, arguments...\n\n  Record the tag name so the OJML syntax can use the function instead of a string\n\n        _setTagName oj[t], t\n        _setTagName oj[qt], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extendInto (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.useGlobally = oj.extendInto = (context = root) ->\n\n      o = {}\n      for k,v of oj\n        if k[0] != '_' and k != 'extendInto' and k != 'useGlobally'\n          o[k] = v\n\n  Export _tag and _Type methods\n\n          qn = _getQuietTagName k\n          if oj[qn]\n            o[qn] = oj[qn]\n\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* minify - Minify js and css\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        minify: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, minify: options.minify, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = _map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.minify then '' else '\\n'\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if (!minify) and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if (!minify) then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\nminify:false will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        # when 'jquery'\n        #   options.html?.push ojml.html()\n        #   options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML(options)\n            options.dom?.appendChild ojml.toDOM(options)\n            if options.css?\n              _extend options.css, ojml.toCSSMap(options)\n\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        throw new Error('oj.compile: doctype expects string as first argument') unless oj.isString ojml[1]\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip indention if there is only one child\n          if !options.minify and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if (!options.minify) and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mouseleave:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if oj.$?\n          if oj.isArray ev\n            oj.$(el)[ek].apply @, ev\n          else\n            oj.$(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n_inherit\n------------------------------------------------------------------------------\nBased on, but sadly incompatable with, coffeescript inheritance\n\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n_construct(Type, arg1, arg2, ...)\n------------------------------------------------------------------------------\nConstruct with specified arguments. This is only necessary because new doesn't support apply\/call directly.\n\n    oj._construct = _construct = (Type) ->\n      new (FuncP.bind.apply(Type, arguments));\n\noj.argumentShift\n------------------------------------------------------------------------------\nHelper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\n_createQuietType\n-------------------------------------------------------------------------------\n\n    _createQuietType = (typeName) ->\n      qt = _getQuietTagName typeName\n      oj[qt] = ->\n        _construct oj[typeName], arguments..., __quiet__:1\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw new Error 'oj.enum: NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: ->\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        {options,args} = oj.unionArguments arguments\n\n        # Emit as a tag if new wasn't called or quiet is not set\n        if @.__autonew__ and not options.__quiet__\n          @emit()\n\n        # Remove quiet flag\n        if options.__quiet__?\n          delete options.__quiet__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = oj.$ @el)\n\n        # Get and set id attribute of view\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # # Get and set class attribute of view\n        # class:\n        #   get: -> @$el.attr 'class'\n        #   set: (v) ->\n        #     # Join arrays with spaces\n        #     if oj.isArray v\n        #       v = v.join ' '\n        #     @$el.attr 'class', v\n        #     return\n\n        # Alias for classes\n        # c:\n        #   get: -> @class\n        #   set: (v) -> @class = v; return\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          oj.$.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all classes as an array (readwrite)\n        classes:\n          get: ->\n            @$el.attr('class').split(\/\\s+\/)\n          set: (v) ->\n            @$el.attr('class', v.join(' '))\n            return\n\n        # Get \/ set all currently set themes (readwrite)\n        themes:\n          get: ->\n            thms = []\n            prefix = 'theme-'\n            for cls in @classes\n              if cls.indexOf(prefix) == 0\n                thms.push cls.slice prefix.length\n            thms\n\n          set: (v) ->\n            v = [v] unless oj.isArray v\n            @clearThemes()\n            for theme in v\n              @addTheme theme\n            return\n\n        theme:\n          get: -> @themes\n          set: (v) -> @themes = v; return\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n              if k == 'class'\n                @addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single class\n        addClass: (name) ->\n          @$el.addClass name\n          return\n\n        # Remove a single class\n        removeClass: (name) ->\n          @$el.removeClass name\n          return\n\n        # Determine if class is applied\n        hasClass: (name) ->\n          @$el.hasClass name\n\n        # Add a single theme\n        addTheme: (name) ->\n          @addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @removeClass \"theme-#{name}\"\n          return\n\n        # Determine if theme is applied\n        hasTheme: (name) ->\n          @hasClass \"theme-#{name}\"\n\n        # Clear all themes\n        clearThemes: ->\n          for theme in @themes\n            @removeTheme theme\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.minify then '' else '\\n')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (options) -> _cssFromPluginObject (_flattenCSSMap @cssMap), _extend({}, minify:options.minify, tags:0)\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      throw new Error(\"oj.#{@typeName}.css: object or string expected for first argument\") unless oj.isString(css) or oj.isObject(css)\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      throw new Error(\"oj.#{@typeName}.theme: string expected for first argument (theme name)\") unless oj.isString name\n      throw new Error(\"oj.#{@typeName}.css: object expected for second argument\") unless oj.isObject(css)\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      @themes = _uniqueSort @themes\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.Text\n------------------------------------------------------------------------------\nText control\n\n    oj.Text = oj.createType 'Text',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Get tag name if provided\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @el = oj =>\n          oj[@tagName]()\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.Text.base.constructor.call @, options\n\n      properties:\n\nvalue: text value of this object (readwrite)\n\n        value:\n          get: -> @$el.ojValue()\n          set: (v) -> @$el.oj(v); return\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = oj.argumentShift(options, 'value') || args.join('\\n');\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\n\n\n\noj.Image\n------------------------------------------------------------------------------\noj.Image creates an `<img>` tag\n\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n          # ix defaults to -1 and is optional\n          if not ojml?\n            ojml = ix\n            ix = -1\n          ix = @_bound ix, @count+1, \".add: index\"\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix = -1) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = _map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          if not listOJML?\n            listOJML = rx\n            rx = -1\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          throw new Error('oj.addRow: expected array for row content') unless oj.isArray listOJML\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx = -1) ->\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> @$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\nCreate _Types\n------------------------------------------------------------------------------\n\n  Type with captital first letter that doesn't end in \"View\"\n\n    for typeName of oj\n      if _isCapitalLetter(typeName[0]) and typeName.slice(typeName.length - 4) != 'View'\n        oj[_getQuietTagName typeName] = _createQuietType typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if (key.length > 0 and key[0] != '_') or (key.length > 0 and key[0] == '_' and (oj[key.slice(1)])?)\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginResult = plugin oj, settings\n\n      # Add _Type quiet types\n      pluginMap = _clone pluginResult\n      for name,value of pluginResult\n        if oj.isOJType value\n          pluginMap[_getQuietTagName name] = _createQuietType value.typeName\n\n      # Extend all properties\n      for name,value of pluginMap\n        # Add to oj\n        oj[name] = value\n\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get oj.$(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set oj.$(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if oj.$('.' + _styleClassFromPlugin plugin).length == 0\n          oj.$('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    oj.$.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    oj.$.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:'deep', meta:1, title:'deep', link:'deep', script:'deep'\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj.compile: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      oj.$('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    oj.$.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    oj.$.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        oj.$.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","old_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\noj function\n-------------------------------------------------------------------------------\n\n  oj function acts like a tag method that doesn't emit\n  Using inline js so the function can be named\n\n    `function oj(){\n      return oj.tag.apply(this, ['oj'].concat([].slice.call(arguments)).concat([{__quiet__:1}]));\n    }`\n\n  Define oj version\n\n    oj.version = '0.1.4'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Store jQuery reference as either the global reference or as required through `jquery2`.\n  This allows this reference to be included as a script tag, included through npm, or overriden.\n\n    if typeof $ != 'undefined'\n      oj.$ = $\n    else if typeof require != 'undefined'\n      try\n        oj.$ = require 'jquery'\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      oj.$ ->\n\n        oj.$.ojBody (require page)\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n    oj.isOJType = (obj) -> oj.isOJ(obj) and obj.type == obj\n    oj.isOJInstance = (obj) -> oj.isOJ(obj) and not oj.isOJType(obj)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    _map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            _map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n\nIndexing Helpers\n-----------------------------------------------------------------------------\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      _map r, (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name, check) ->\n      check ?= ->\n        if oj.isClient then oj.isDefined(window[name]) else oj.isDefined(global[name])\n      throw new Error(\"oj: #{name} dependency is missing\") unless check()\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw new Error('oj.isProperty: string expected for second argument') unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argsStack = []\n\n  Result is top of the stack\n\n    oj._argsTop = ->\n      if _argsStack.length\n        _argsStack[_argsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argsPush = (args = []) ->\n      _argsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argsPop = ->\n      if _argsStack.length\n        return _argsStack.pop()\n      null\n\n  Append argument\n\n    oj._argsAppend = (arg) ->\n      top = oj._argsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, rest...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from rest by unioning all objects\n\n      {args, options:attributes} = oj.unionArguments rest\n\n      if isQuiet = attributes.__quiet__\n        delete attributes.__quiet__\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n\n        else if oj.isFunction arg\n          len = oj._argsTop().length\n\n  Call the argument it will auto append to oj._argsTop() which is ojml\n\n          r = arg()\n\n  Use return value if oj._argsTop() weren't changed\n\n          if len == oj._argsTop().length and r?\n            oj._argsAppend r\n\n        else\n          oj._argsAppend arg\n\n  Pop to restore previous context\n\n      oj._argsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to.\n  Do not emit when quiet is set,\n\n      oj._argsAppend(ojml) unless isQuiet\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Get quiet tag name\n\n    _getQuietTagName = (tag) ->\n      '_' + tag\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n\n  Tag functions emit by default\n\n        oj[t] = -> oj.tag t, arguments...\n\n  Underscore tag functions do not emit\n\n        qt = _getQuietTagName t\n        oj[qt] = -> oj.tag t, {__quiet__:1}, arguments...\n\n  Record the tag name so the OJML syntax can use the function instead of a string\n\n        _setTagName oj[t], t\n        _setTagName oj[qt], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = 'HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = 'html'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\"'\n\n  Define possible arguments\n\n    _doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\"'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\"'\n\n  Define the method passing through to !DOCTYPE tag function\n\n    oj.doctype = (typeOrValue = '5') ->\n      value = _doctypes[typeOrValue] ? typeOrValue\n      oj['!DOCTYPE'](value)\n\noj.extendInto (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.useGlobally = oj.extendInto = (context = root) ->\n\n      o = {}\n      for k,v of oj\n        if k[0] != '_' and k != 'extendInto' and k != 'useGlobally'\n          o[k] = v\n\n  Export _tag and _Type methods\n\n          qn = _getQuietTagName k\n          if oj[qn]\n            o[qn] = oj[qn]\n\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* minify - Minify js and css\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        minify: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, minify: options.minify, tags:0\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = _map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_styleClassFromPlugin:\n-----------------------------------------------------------------------------\n\n    _styleClassFromPlugin = (plugin) ->\n      \"#{plugin}-style\"\n\n_styleTagFromMediaObject:\n-----------------------------------------------------------------------------\n\n    oj._styleTagFromMediaObject = (plugin, mediaMap, options) ->\n      newline = if options?.minify then '' else '\\n'\n      css = _cssFromMediaObject mediaMap, options\n      \"<style class=\\\"#{_styleClassFromPlugin plugin}\\\">#{newline}#{css}<\/style>\"\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if (!minify) and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if (!minify) then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\nminify:false will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      minify = options.minify ? 0\n      tags = options.tags ? 0\n\n  Deterine what output characters are needed\n\n      newline = if minify then '' else '\\n'\n      space = if minify then '' else ' '\n      inline = minify\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n_compileAny\n-----------------------------------------------------------------------------\nRecursive helper for compiling any type\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        # when 'jquery'\n        #   options.html?.push ojml.html()\n        #   options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML(options)\n            options.dom?.appendChild ojml.toDOM(options)\n            if options.css?\n              _extend options.css, ojml.toCSSMap(options)\n\n      return\n\n_compileTag\n-----------------------------------------------------------------------------\nRecursive helper for compiling ojml tags\n\n    _compileTag = (ojml, options) ->\n\n  Empty list compiles to undefined\n\n      return if ojml.length == 0\n\n  Get tag name, allowing the tag parameter to be 'table' (tag name) or table (function) or Table (object)\n\n      tag = ojml[0]\n      tagType = typeof tag\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n  Record tag as encountered\n\n      options.tags[tag] = true\n\n  Instance oj object if tag is capitalized\n\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n  Gather attributes if present\n\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n  Gather children if present\n\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n  Compile to css if requested\n\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n  Compile DOCTYPE as special case because it is not really an element\n  It has attributes with spaces and cannot be created by dom manipulation\n  In this way it is HTML generation only.\n\n      if tag == '!DOCTYPE'\n        throw new Error('oj.compile: doctype expects string as first argument') unless oj.isString ojml[1]\n        if not options.ignore[tag]\n          if options.html\n            options.html.push \"<#{tag} #{ojml[1]}>\"\n          # options.dom is purposely ignored\n        return\n\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n  Compile to dom if requested\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n  Compile to html if requested\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n  Recurse through children if this tag isn't ignored deeply\n\n      if options.ignore[tag] != 'deep'\n        for child in children\n          # Skip indention if there is only one child\n          if !options.minify and children.length > 1\n            options.html?.push \"\\n\\t#{options.indent}\"\n          _compileDeeper _compileAny, child, options\n\n      # Skip indention if there is only one child\n      if (!options.minify) and children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n  End html tag if you have children or your tag closes\n\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mouseleave:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if oj.$?\n          if oj.isArray ev\n            oj.$(el)[ek].apply @, ev\n          else\n            oj.$(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\noj.toHTML\n-------------------------------------------------------------------------------\nMake ojml directly to HTML ignoring event bindings and css.\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\noj.toCSS\n-------------------------------------------------------------------------------\nCompile ojml directly to css ignoring event bindings and html.\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n_inherit\n------------------------------------------------------------------------------\nBased on, but sadly incompatable with, coffeescript inheritance\n\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n_construct(Type, arg1, arg2, ...)\n------------------------------------------------------------------------------\nConstruct with specified arguments. This is only necessary because new doesn't support apply\/call directly.\n\n    oj._construct = _construct = (Type) ->\n      new (FuncP.bind.apply(Type, arguments));\n\noj.argumentShift\n------------------------------------------------------------------------------\nHelper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # unionArguments:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.unionArguments = (argList) ->\n      options = {}\n      args = []\n      for v in argList\n        if oj.isObject v\n          options = _extend options, v\n        else\n          args.push v\n      options: options, args: args\n\n_createQuietType\n-------------------------------------------------------------------------------\n\n    _createQuietType = (typeName) ->\n      qt = _getQuietTagName typeName\n      oj[qt] = ->\n        _construct oj[typeName], arguments..., __quiet__:1\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw new Error 'oj.enum: NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: ->\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        {options,args} = oj.unionArguments arguments\n\n        # Emit as a tag if new wasn't called or quiet is not set\n        if @.__autonew__ and not options.__quiet__\n          @emit()\n\n        # Remove quiet flag\n        if options.__quiet__?\n          delete options.__quiet__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = oj.$ @el)\n\n        # Get and set id attribute of view\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # # Get and set class attribute of view\n        # class:\n        #   get: -> @$el.attr 'class'\n        #   set: (v) ->\n        #     # Join arrays with spaces\n        #     if oj.isArray v\n        #       v = v.join ' '\n        #     @$el.attr 'class', v\n        #     return\n\n        # # Alias for class\n        # c:\n        #   get: -> @class\n        #   set: (v) -> @class = v; return\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          oj.$.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get \/ set all currently set themes (readwrite)\n        themes:\n          get: ->\n            out = {}\n            oj.$.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n            out\n          set: (v) ->\n            v = [v] unless oj.isArray v\n            @clearThemes()\n            for theme in v\n              @addTheme theme\n            return\n\n        theme: @themes\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n              if k == 'class'\n                @addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single class\n        addClass: (name) ->\n          @$el.addClass name\n          return\n\n        # Remove a single class\n        removeClass: (name) ->\n          @$el.removeClass name\n          return\n\n        # Add a single theme\n        addTheme: (name) ->\n          @addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @removeClass \"theme-#{name}\"\n          return\n\n        # Clear all themes\n        clearThemes: (name) ->\n          @$el.removeClass \"theme-#{name}\"\n          classes = @$el.attr('class').split(' ')\n          _each classes, (v) ->\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.minify then '' else '\\n')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (options) -> _cssFromPluginObject (_flattenCSSMap @cssMap), _extend({}, minify:options.minify, tags:0)\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n  oj.View.css: set view's css with css object mapping, or raw css string\n\n    oj.View.css = (css) ->\n      throw new Error(\"oj.#{@typeName}.css: object or string expected for first argument\") unless oj.isString(css) or oj.isObject(css)\n      if oj.isString css\n        @cssMap[\"oj-#{@typeName}\"] ?= \"\"\n        @cssMap[\"oj-#{@typeName}\"] += css\n      else\n        @cssMap[\"oj-#{@typeName}\"] ?= {}\n        cssMap = _setObject {}, \".oj-#{@typeName}\", css\n        _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n  oj.View.theme: create a View specific theme with css object mapping\n\n    oj.View.theme = (name, css) ->\n      throw new Error(\"oj.#{@typeName}.theme: string expected for first argument (theme name)\") unless oj.isString name\n      throw new Error(\"oj.#{@typeName}.css: object expected for second argument\") unless oj.isObject(css)\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", css\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      @themes = _uniqueSort @themes\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.Text\n------------------------------------------------------------------------------\nText control\n\n    oj.Text = oj.createType 'Text',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Get tag name if provided\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @el = oj =>\n          oj[@tagName]()\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.Text.base.constructor.call @, options\n\n      properties:\n\nvalue: text value of this object (readwrite)\n\n        value:\n          get: -> @$el.ojValue()\n          set: (v) -> @$el.oj(v); return\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.textarea\n            # Delay change event slighty as value is updated after key presses\n            keydown: => if @live then setTimeout((=> @$el.change()),10); return\n            keyup: => if @live then setTimeout((=> @$el.change()),10); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = oj.argumentShift(options, 'value') || args.join('\\n');\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: ->\n        {options, args} = oj.unionArguments arguments\n\n        # Label is first argument\n        title = ''\n        if args.length > 0\n          title = args[0]\n\n        # Label is specified as option\n        if options.title?\n          title = oj.argumentShift(options, 'title')\n\n        @el = oj =>\n          oj.button(title)\n\n        oj.Button.base.constructor.apply @, [options]\n        @title = title\n      properties:\n        title:\n          get: -> @_title ? ''\n          set: (v) -> @$el.oj (@_title = v); return\n\n      methods:\n        click: ->\n          if arguments.length > 0\n            @$el.click(arguments...)\n          else\n            @$el.click()\n\n\n\n\noj.Image\n------------------------------------------------------------------------------\noj.Image creates an `<img>` tag\n\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.unionArguments arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = _map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @$td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> @$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\nCreate _Types\n------------------------------------------------------------------------------\n\n  Type with captital first letter that doesn't end in \"View\"\n\n    for typeName of oj\n      if _isCapitalLetter(typeName[0]) and typeName.slice(typeName.length - 4) != 'View'\n        oj[_getQuietTagName typeName] = _createQuietType typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if (key.length > 0 and key[0] != '_') or (key.length > 0 and key[0] == '_' and (oj[key.slice(1)])?)\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginResult = plugin oj, settings\n\n      # Add _Type quiet types\n      pluginMap = _clone pluginResult\n      for name,value of pluginResult\n        if oj.isOJType value\n          pluginMap[_getQuietTagName name] = _createQuietType value.typeName\n\n      # Extend all properties\n      for name,value of pluginMap\n        # Add to oj\n        oj[name] = value\n\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get oj.$(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set oj.$(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\n    _triggerTypes = (types) ->\n      for type in types\n        type.inserted()\n      return\n\n    _insertStyles = (pluginMap, options) ->\n      for plugin, mediaMap of pluginMap\n        # Skip global css if options.global is true\n        continue if plugin == 'oj-style' and not options?.global\n        # Create <style> tag for the plugin\n        if oj.$('.' + _styleClassFromPlugin plugin).length == 0\n          oj.$('head').append oj._styleTagFromMediaObject plugin, mediaMap\n      return\n\njQuery.fn.oj\n-----------------------------------------------------------------------------\n\n    oj.$.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types,cssMap} = oj.compile {dom:1,html:0,cssMap:1}, args...\n\n        _insertStyles cssMap, global:0\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        $el.append(d) for d in dom\n\n        _triggerTypes types\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njQuery.ojBody ojml\n-----------------------------------------------------------------------------\nReplace body with ojml. Global css is rebuild when using this method.\n\n    oj.$.ojBody = (ojml) ->\n\n  Compile only the body and below\n\n      bodyOnly = html:1, '!DOCTYPE':1, body:1, head:'deep', meta:1, title:'deep', link:'deep', script:'deep'\n\n      try\n        {dom,types,cssMap} = oj.compile dom:1, html:0, css:0, cssMap:1, ignore:bodyOnly, ojml\n\n      catch eCompile\n        throw new Error(\"oj.compile: #{eCompile.message}\")\n\n  Clear body and insert dom elements\n\n      oj.$('body').html(dom) if dom?\n\n      _insertStyles cssMap, global:1\n\n      _triggerTypes types\n\njQuery.fn.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    oj.$.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njQuery.fn.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    oj.$.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njQuery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        oj.$.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types,cssMap} = oj.compile {dom:1,html:0,css:0,cssMap:1}, args...\n\n            _insertStyles cssMap, global:0\n\n            # Append to the dom\n            $el[jqName] dom\n\n            _triggerTypes types\n\n            return\n\n          get:null\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bfde1e7eddc9d15e34dea2bdc84c1940af527271","subject":"removed the eventlistener code as phantom doesn't accept new Event() \u00af\\(\u00b0_o)\/\u00af","message":"removed the eventlistener code as phantom doesn't accept new Event() \u00af\\(\u00b0_o)\/\u00af\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/16_dom.litcoffee","new_file":"docs\/16_dom.litcoffee","new_contents":"# Batman.DOM\n\nBatman includes some helper methods to assist in DOM manipulation.\n\nThe following are included in the platform adapters:\n - `querySelector`\n - `querySelectorAll`\n - `destroyNode`\n - `setInnerHTML`\n - `textContent`\n - `addEventListener`\n - `removeEventListener`\n\n## @scrollIntoView(elementID : string)\nScrolls the desired element into view.  If the element isn't there or\ndoesn't have a `scrollIntoView` method this will fail silently.\n\n## @setStyleProperty(node : Node,property : string,value : string, importance : string)\nSets the style property or attribute on the supplied node.  This method will prefer `setProperty` over `setAttribute`.\n\n\ttest \"setStyleProperty\", ->\n\t  node = document.createElement('div')\n\t  Batman.DOM.setStyleProperty( node, \"color\", \"white\", \"important\")\n\t  equal node.style.getPropertyValue(\"color\"), \"white\"\n\t  equal \"important\", node.style.getPropertyPriority(\"color\")\n\n## @valueForNode(node: Node [, value = '',escapeValue = true ]) : string\nGets the value of a node and optionally sets it as well.  `escapeValue` will escape the value via `Batman.escapeHTML`\n\n\ttest 'valueForNode', ->\n\t  node = document.createElement('input')\n\t  val = Batman.DOM.valueForNode(node, 'stuff' )\n\t  equal val, \"stuff\"\n\t  equal node.value, \"stuff\"\n\n## @nodeIsEditable(node) : boolean\nReturns whether a node is editable or not.\n\n\ttest 'nodeIsEditable', ->\n\t  node = document.createElement('div')\n\t  ok !Batman.DOM.nodeIsEditable(node)\n\t  node = document.createElement('input')\n\t  ok Batman.DOM.nodeIsEditable(node)\n\n## @addEventListener(node : Node, eventName : string, callback : function)\nAdds the event listener, uses the platform `addEventListener` if available otherwise use `attachEvent on{eventName}`\nBatman stores the listeners internally.\n\n## @removeEventListener(node : Node, eventName : string, callback : function)\nRemoves the event listener from the node and removes any internal references to it.\n\n## @cleanupNode(node : Node)\nRemoves all the event listeners from the specified node and any child nodes.\n\n## .hasAddEventListener : boolean\nReturns the whether the `window` object contains addEventListener.\n\n\ttest \"does the window have an event listener\", ->\n\t  ok Batman.DOM.hasAddEventListener\n\n## @preventDefault(e : Event)\nPrevents the default event from happening.  If preventDefault isn't a `function` then it will set the `returnValue` to false\n\n\ttest \"preventDefault\", ->\n\t  e = { returnValue: true }\n\t  Batman.DOM.preventDefault(e)\n\t  ok !e.returnValue\n\n\t  e = { preventDefault: -> ok true }\n\t  Batman.DOM.preventDefault(e)\n\n## @stopPropagation(e : Event)\nStops the event from propogating.  If the stopPropgation isn't a `function` then it will set `cancelBubble` to true\n\n\ttest \"stopPropagation\", ->\n\t  e = { cancelBubble: false }\n\t  Batman.DOM.stopPropagation(e)\n\t  ok e.cancelBubble\n\n\t  e = {stopPropagation: -> ok true }\n\t  Batman.DOM.stopPropagation(e)\n\n### The following methods are only available with the jQuery platform or a polyfill\n\n## @querySelectorAll(node : Node, selector : string)\nPerforms a jQuery like selector depending on your platform\n\n## @querySelector(node : Node, selector : string)\nPerforms a jQuery like selector that returns one element\n\n## @destroyNode(node : Node)\nCalls `Batman.DOM.cleanupNode` and  removes node and anything inside from the document tree.\n\n\ttest 'destroyNode', ->\n\t  node1 = document.createElement('div')\n\t  node2 = document.createElement('div')\n\t  node3 = document.createElement('div')\n\t  node1.appendChild(node2)\n\t  node2.appendChild(node3)\n\n\t  Batman.DOM.destroyNode( node1 )\n\t  equal node1.childNodes.length, 1\n\n## @setInnerHtml(node : Node, html : string)\nSet an element's content and any content that was in that element is completely replaced by the new content.\n_note_ this can't be used on XML documents.\n\n\ttest \"innerHTML\", ->\n\t  node = document.createElement('div')\n\t  Batman.DOM.setInnerHTML(node, \"FOO\")\n\t  equal node.innerHTML, \"FOO\"\n\n## @textContent(node) : string\nReturns the string of the text contained in the node.\n\n\ttest \"textContent\", ->\n\t  node = document.createElement('div')\n\t  content = document.createTextNode(\"FOO\")\n\t  node.appendChild(content)\n\t  equal Batman.DOM.textContent(node), \"FOO\"\n","old_contents":"# Batman.DOM\n\nBatman includes some helper methods to assist in DOM manipulation.\n\nThe following are included in the platform adapters:\n - `querySelector`\n - `querySelectorAll`\n - `destroyNode`\n - `setInnerHTML`\n - `textContent`\n - `addEventListener`\n - `removeEventListener`\n\n## @scrollIntoView(elementID : string)\nScrolls the desired element into view.  If the element isn't there or\ndoesn't have a `scrollIntoView` method this will fail silently.\n\n## @setStyleProperty(node : Node,property : string,value : string, importance : string)\nSets the style property or attribute on the supplied node.  This method will prefer `setProperty` over `setAttribute`.\n\n\ttest \"setStyleProperty\", ->\n\t  node = document.createElement('div')\n\t  Batman.DOM.setStyleProperty( node, \"color\", \"white\", \"important\")\n\t  equal node.style.getPropertyValue(\"color\"), \"white\"\n\t  equal \"important\", node.style.getPropertyPriority(\"color\")\n\n## @valueForNode(node: Node [, value = '',escapeValue = true ]) : string\nGets the value of a node and optionally sets it as well.  `escapeValue` will escape the value via `Batman.escapeHTML`\n\n\ttest 'valueForNode', ->\n\t  node = document.createElement('input')\n\t  val = Batman.DOM.valueForNode(node, 'stuff' )\n\t  equal val, \"stuff\"\n\t  equal node.value, \"stuff\"\n\n## @nodeIsEditable(node) : boolean\nReturns whether a node is editable or not.\n\n\ttest 'nodeIsEditable', ->\n\t  node = document.createElement('div')\n\t  ok !Batman.DOM.nodeIsEditable(node)\n\t  node = document.createElement('input')\n\t  ok Batman.DOM.nodeIsEditable(node)\n\n## @addEventListener(node : Node, eventName : string, callback : function)\nAdds the event listener, uses the platform `addEventListener` if available otherwise use `attachEvent on{eventName}`\nBatman stores the listeners internally.\n\n\ttest 'addEventListener', 1, ->\n\t  node = document.createElement('div')\n\t  Batman.DOM.addEventListener( node, 'click', -> ok true )\n\t  node.dispatchEvent(new Event('click'))\n\n## @removeEventListener(node : Node, eventName : string, callback : function)\nRemoves the event listener from the node and removes any internal references to it.\n\n## @cleanupNode(node : Node)\nRemoves all the event listeners from the specified node and any child nodes.\n\n## .hasAddEventListener : boolean\nReturns the whether the `window` object contains addEventListener.\n\n\ttest \"does the window have an event listener\", ->\n\t  ok Batman.DOM.hasAddEventListener\n\n## @preventDefault(e : Event)\nPrevents the default event from happening.  If preventDefault isn't a `function` then it will set the `returnValue` to false\n\n\ttest \"preventDefault\", ->\n\t  e = { returnValue: true }\n\t  Batman.DOM.preventDefault(e)\n\t  ok !e.returnValue\n\n\t  e = { preventDefault: -> ok true }\n\t  Batman.DOM.preventDefault(e)\n\n## @stopPropagation(e : Event)\nStops the event from propogating.  If the stopPropgation isn't a `function` then it will set `cancelBubble` to true\n\n\ttest \"stopPropagation\", ->\n\t  e = { cancelBubble: false }\n\t  Batman.DOM.stopPropagation(e)\n\t  ok e.cancelBubble\n\n\t  e = {stopPropagation: -> ok true }\n\t  Batman.DOM.stopPropagation(e)\n\n### The following methods are only available with the jQuery platform or a polyfill\n\n## @querySelectorAll(node : Node, selector : string)\nPerforms a jQuery like selector depending on your platform\n\n## @querySelector(node : Node, selector : string)\nPerforms a jQuery like selector that returns one element\n\n## @destroyNode(node : Node)\nCalls `Batman.DOM.cleanupNode` and  removes node and anything inside from the document tree.\n\n\ttest 'destroyNode', ->\n\t  node1 = document.createElement('div')\n\t  node2 = document.createElement('div')\n\t  node3 = document.createElement('div')\n\t  node1.appendChild(node2)\n\t  node2.appendChild(node3)\n\n\t  Batman.DOM.destroyNode( node1 )\n\t  equal node1.childNodes.length, 1\n\n## @setInnerHtml(node : Node, html : string)\nSet an element's content and any content that was in that element is completely replaced by the new content.\n_note_ this can't be used on XML documents.\n\n\ttest \"innerHTML\", ->\n\t  node = document.createElement('div')\n\t  Batman.DOM.setInnerHTML(node, \"FOO\")\n\t  equal node.innerHTML, \"FOO\"\n\n## @textContent(node) : string\nReturns the string of the text contained in the node.\n\n\ttest \"textContent\", ->\n\t  node = document.createElement('div')\n\t  content = document.createTextNode(\"FOO\")\n\t  node.appendChild(content)\n\t  equal Batman.DOM.textContent(node), \"FOO\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6c76d4c87bfd89e2c17bacc27a9eeb4b640b82c5","subject":"Fixed signal stop propagation result","message":"Fixed signal stop propagation result\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/signal\/index.litcoffee","new_file":"src\/signal\/index.litcoffee","new_contents":"# Signal\n\nSignal is a function with listeners which can be emitted.\n\nAccess it with:\n```javascript\nconst { signal } = Neft;\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n\n## *Integer* signal.STOP_PROPAGATION\n\nSpecial constant used to stop calling further listeners.\n\nMust be returned by the listener function.\n\n```javascript\nvar obj = {};\nsignal.create(obj, 'onPress');\n\nobj.onPress(function(){\n  console.log('listener 1');\n  return signal.STOP_PROPAGATION;\n});\n\n\/\/ this listener won't be called, because first listener will capture this signal\nobj.onPress(function(){\n  console.log('listener 2');\n});\n\nobj.onPress.emit();\n\/\/ listener 1\n```\n\n    STOP_PROPAGATION = exports.STOP_PROPAGATION = 1 << 30\n\n## *Signal* signal.create([*NotPrimitive* object, *String* name])\n\nCreates a new signal in the given object under the given name property.\n\nReturns created signal.\n\n```javascript\nvar obj = {};\n\nsignal.create(obj, 'onRename');\n\nobj.onRename.connect(function(){\n  console.log(arguments);\n});\n\nobj.onRename.emit('Max', 'George');\n\/\/ {0: \"Max\", 1: \"George\"}\n```\n\n    exports.create = (obj, name) ->\n        signal = createSignalFunction obj\n        if name is undefined\n            return signal\n\n        assert.isNotPrimitive obj, 'signal object cannot be primitive'\n        assert.isString name, 'signal name must be a string'\n        assert.notLengthOf name, 0, 'signal name cannot be an empty string'\n\n        assert not obj.hasOwnProperty(name)\n        , \"signal object has already defined the '#{name}' property\"\n\n        obj[name] = signal\n\n## *Boolean* signal.isEmpty(*Signal* signal)\n\nReturns `true` if the given signal has no listeners.\n\n    exports.isEmpty = (signal) ->\n        for func in signal.listeners by 2\n            if func isnt null\n                return false\n        return true\n\n    callSignal = (obj, listeners, arg1, arg2) ->\n        i = 0\n        n = listeners.length\n        result = 0\n        containsGaps = false\n        while i < n\n            func = listeners[i]\n            if func is null\n                containsGaps = true\n            else\n                ctx = listeners[i + 1]\n                if func.call(ctx or obj, arg1, arg2) is STOP_PROPAGATION\n                    result = STOP_PROPAGATION\n                    if containsGaps\n                        break\n            i += 2\n\n        if containsGaps\n            shift = 0\n            while i < n\n                func = listeners[i]\n                if func is null\n                    shift -= 2\n                else if shift > 0\n                    assert.isNotDefined listeners[i + shift]\n                    assert.isNotDefined listeners[i + shift + 1]\n                    listeners[i + shift] = func\n                    listeners[i + shift + 1] = listeners[i + 1]\n                    listeners[i] = null\n                    listeners[i + 1] = null\n                i += 2\n\n        result\n\n    createSignalFunction = (obj) ->\n        handler = (listener, ctx) ->\n            handler.connect listener, ctx\n\n        handler.obj = obj\n        handler.listeners = []\n        utils.setPrototypeOf handler, SignalPrototype\n\n        handler\n\n    disconnectFromListeners = (listeners, listener, ctx) ->\n        index = 0\n\n        loop\n            index = listeners.indexOf listener, index\n            if index is -1 or listeners[index + 1] is ctx\n                break\n            index += 2\n        assert.isNot index, -1, \"listener doesn't exist in this signal\"\n        assert.is listeners[index], listener\n        assert.is listeners[index + 1], ctx\n\n        listeners[index] = null\n        listeners[index + 1] = null\n\n        return\n\n    SignalPrototype =\n\n## Signal::emit([*Any* argument1, *Any* argument2])\n\nCall all of the signal listeners with the given arguments (2 maximally).\n\n        emit: (arg1, arg2) ->\n            assert.isFunction @, 'emit must be called on a signal function'\n            assert.isArray @listeners, 'emit must be called on a signal function'\n            assert.operator arguments.length, '<', 3, \"\"\"\n                signal accepts maximally two parameters; use object instead\n            \"\"\"\n\n            callSignal @obj, @listeners, arg1, arg2\n\n## Signal::connect(*Function* listener, [*Any* context])\n\nAdds the given listener function into the signal listeners.\n\nBy default, the signal function works like this method.\n\n```javascript\nvar obj = {};\nsignal.create(obj, 'onPress');\n\nobj.onPress(function(){\n  console.log('listener 1');\n});\n\nobj.onPress.connect(function(){\n  console.log('listener 2');\n});\n\nobj.onPress.emit()\n\/\/ listener 1\n\/\/ listener 2\n```\n\nThe given context will be used as a context in listener calling.\nBy default, the listener is called with the object on which the signal is created.\n\n```javascript\nvar obj = {standard: true};\nsignal.create(obj, 'onPress');\n\nvar fakeContext = {fake: true};\nobj.onPress(function(){\n  console.log(this);\n}, fakeContext);\n\nobj.onPress(function(){\n  console.log(this);\n});\n\nobj.onPress.emit();\n\/\/ {fake: true}\n\/\/ {standard: true}\n```\n\n        connect: (listener, ctx = null) ->\n            assert.isFunction @, 'connect must be called on a signal function'\n            assert.isFunction listener, 'listener is not a function'\n\n            {listeners} = @\n\n            i = n = listeners.length\n            while (i -= 2) >= 0\n                if listeners[i] isnt null\n                    break\n\n            if i + 2 is n\n                listeners.push listener, ctx\n            else\n                assert.isNotDefined listeners[i + 2]\n                assert.isNotDefined listeners[i + 3]\n                listeners[i + 2] = listener\n                listeners[i + 3] = ctx\n\n            return\n\n## Signal::connectOnce(*Function* listener, [*Any* context])\n\n        connectOnce: (listener, ctx = null) ->\n            assert.isFunction @, 'connectOnce must be called on a signal function'\n            assert.isFunction listener, 'listener is not a function'\n\n            {listeners} = @\n            wrapper = (arg1, arg2) ->\n                disconnectFromListeners listeners, wrapper, ctx\n                listener.call @, arg1, arg2\n\n            @connect wrapper, ctx\n\n\n## Signal::disconnect(*Function* listener, [*Any* context])\n\nReturns the given listener function from the signal listeners.\n\n```javascript\nvar obj = {};\n\nsignal.create(obj, 'onPress');\n\nvar listener = function(){\n  console.log('listener called!');\n};\n\nobj.onPress.connect(listener);\nobj.onPress.disconnect(listener);\n\nobj.onPress.emit()\n\/\/ no loggs...\n```\n\n        disconnect: (listener, ctx = null) ->\n            assert.isFunction @, 'disconnect must be called on a signal function'\n            assert.isFunction listener, 'listener is not a function'\n\n            disconnectFromListeners @listeners, listener, ctx\n\n            return\n\n## Signal::disconnectAll()\n\nRemoves all the signal listeners.\n\n        disconnectAll: ->\n            assert.isFunction @, 'disconnectAll must be called on a signal function'\n\n            {listeners} = @\n            for _, i in listeners\n                listeners[i] = null\n\n            return\n\n    exports.Emitter = require('.\/emitter')\n        create: exports.create\n        createSignalFunction: createSignalFunction\n        callSignal: callSignal\n","old_contents":"# Signal\n\nSignal is a function with listeners which can be emitted.\n\nAccess it with:\n```javascript\nconst { signal } = Neft;\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n\n## *Integer* signal.STOP_PROPAGATION\n\nSpecial constant used to stop calling further listeners.\n\nMust be returned by the listener function.\n\n```javascript\nvar obj = {};\nsignal.create(obj, 'onPress');\n\nobj.onPress(function(){\n  console.log('listener 1');\n  return signal.STOP_PROPAGATION;\n});\n\n\/\/ this listener won't be called, because first listener will capture this signal\nobj.onPress(function(){\n  console.log('listener 2');\n});\n\nobj.onPress.emit();\n\/\/ listener 1\n```\n\n    STOP_PROPAGATION = exports.STOP_PROPAGATION = 1 << 30\n\n## *Signal* signal.create([*NotPrimitive* object, *String* name])\n\nCreates a new signal in the given object under the given name property.\n\nReturns created signal.\n\n```javascript\nvar obj = {};\n\nsignal.create(obj, 'onRename');\n\nobj.onRename.connect(function(){\n  console.log(arguments);\n});\n\nobj.onRename.emit('Max', 'George');\n\/\/ {0: \"Max\", 1: \"George\"}\n```\n\n    exports.create = (obj, name) ->\n        signal = createSignalFunction obj\n        if name is undefined\n            return signal\n\n        assert.isNotPrimitive obj, 'signal object cannot be primitive'\n        assert.isString name, 'signal name must be a string'\n        assert.notLengthOf name, 0, 'signal name cannot be an empty string'\n\n        assert not obj.hasOwnProperty(name)\n        , \"signal object has already defined the '#{name}' property\"\n\n        obj[name] = signal\n\n## *Boolean* signal.isEmpty(*Signal* signal)\n\nReturns `true` if the given signal has no listeners.\n\n    exports.isEmpty = (signal) ->\n        for func in signal.listeners by 2\n            if func isnt null\n                return false\n        return true\n\n    callSignal = (obj, listeners, arg1, arg2) ->\n        i = 0\n        n = listeners.length\n        result = 0\n        containsGaps = false\n        while i < n\n            func = listeners[i]\n            if func is null\n                containsGaps = true\n            else\n                ctx = listeners[i + 1]\n                if result <= 0 and func.call(ctx or obj, arg1, arg2) is STOP_PROPAGATION\n                    result = STOP_PROPAGATION\n                    if containsGaps\n                        break\n            i += 2\n\n        if containsGaps\n            shift = 0\n            while i < n\n                func = listeners[i]\n                if func is null\n                    shift -= 2\n                else if shift > 0\n                    assert.isNotDefined listeners[i + shift]\n                    assert.isNotDefined listeners[i + shift + 1]\n                    listeners[i + shift] = func\n                    listeners[i + shift + 1] = listeners[i + 1]\n                    listeners[i] = null\n                    listeners[i + 1] = null\n                i += 2\n\n        result\n\n    createSignalFunction = (obj) ->\n        handler = (listener, ctx) ->\n            handler.connect listener, ctx\n\n        handler.obj = obj\n        handler.listeners = []\n        utils.setPrototypeOf handler, SignalPrototype\n\n        handler\n\n    disconnectFromListeners = (listeners, listener, ctx) ->\n        index = 0\n\n        loop\n            index = listeners.indexOf listener, index\n            if index is -1 or listeners[index + 1] is ctx\n                break\n            index += 2\n        assert.isNot index, -1, \"listener doesn't exist in this signal\"\n        assert.is listeners[index], listener\n        assert.is listeners[index + 1], ctx\n\n        listeners[index] = null\n        listeners[index + 1] = null\n\n        return\n\n    SignalPrototype =\n\n## Signal::emit([*Any* argument1, *Any* argument2])\n\nCall all of the signal listeners with the given arguments (2 maximally).\n\n        emit: (arg1, arg2) ->\n            assert.isFunction @, 'emit must be called on a signal function'\n            assert.isArray @listeners, 'emit must be called on a signal function'\n            assert.operator arguments.length, '<', 3, \"\"\"\n                signal accepts maximally two parameters; use object instead\n            \"\"\"\n\n            callSignal @obj, @listeners, arg1, arg2\n\n## Signal::connect(*Function* listener, [*Any* context])\n\nAdds the given listener function into the signal listeners.\n\nBy default, the signal function works like this method.\n\n```javascript\nvar obj = {};\nsignal.create(obj, 'onPress');\n\nobj.onPress(function(){\n  console.log('listener 1');\n});\n\nobj.onPress.connect(function(){\n  console.log('listener 2');\n});\n\nobj.onPress.emit()\n\/\/ listener 1\n\/\/ listener 2\n```\n\nThe given context will be used as a context in listener calling.\nBy default, the listener is called with the object on which the signal is created.\n\n```javascript\nvar obj = {standard: true};\nsignal.create(obj, 'onPress');\n\nvar fakeContext = {fake: true};\nobj.onPress(function(){\n  console.log(this);\n}, fakeContext);\n\nobj.onPress(function(){\n  console.log(this);\n});\n\nobj.onPress.emit();\n\/\/ {fake: true}\n\/\/ {standard: true}\n```\n\n        connect: (listener, ctx = null) ->\n            assert.isFunction @, 'connect must be called on a signal function'\n            assert.isFunction listener, 'listener is not a function'\n\n            {listeners} = @\n\n            i = n = listeners.length\n            while (i -= 2) >= 0\n                if listeners[i] isnt null\n                    break\n\n            if i + 2 is n\n                listeners.push listener, ctx\n            else\n                assert.isNotDefined listeners[i + 2]\n                assert.isNotDefined listeners[i + 3]\n                listeners[i + 2] = listener\n                listeners[i + 3] = ctx\n\n            return\n\n## Signal::connectOnce(*Function* listener, [*Any* context])\n\n        connectOnce: (listener, ctx = null) ->\n            assert.isFunction @, 'connectOnce must be called on a signal function'\n            assert.isFunction listener, 'listener is not a function'\n\n            {listeners} = @\n            wrapper = (arg1, arg2) ->\n                disconnectFromListeners listeners, wrapper, ctx\n                listener.call @, arg1, arg2\n\n            @connect wrapper, ctx\n\n\n## Signal::disconnect(*Function* listener, [*Any* context])\n\nReturns the given listener function from the signal listeners.\n\n```javascript\nvar obj = {};\n\nsignal.create(obj, 'onPress');\n\nvar listener = function(){\n  console.log('listener called!');\n};\n\nobj.onPress.connect(listener);\nobj.onPress.disconnect(listener);\n\nobj.onPress.emit()\n\/\/ no loggs...\n```\n\n        disconnect: (listener, ctx = null) ->\n            assert.isFunction @, 'disconnect must be called on a signal function'\n            assert.isFunction listener, 'listener is not a function'\n\n            disconnectFromListeners @listeners, listener, ctx\n\n            return\n\n## Signal::disconnectAll()\n\nRemoves all the signal listeners.\n\n        disconnectAll: ->\n            assert.isFunction @, 'disconnectAll must be called on a signal function'\n\n            {listeners} = @\n            for _, i in listeners\n                listeners[i] = null\n\n            return\n\n    exports.Emitter = require('.\/emitter')\n        create: exports.create\n        createSignalFunction: createSignalFunction\n        callSignal: callSignal\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"5cde6fb14335926d2bf1824b824c3151d1942342","subject":"a few other changes","message":"a few other changes\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey[= \"id\"] : string\n\nDefines the `Model`'s primary key. This attribute will be used for determining:\n\n- record identity (ie, records with the same `primaryKey` are assumed to be the same record)\n- whether a record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew)\n- records are related (see [`Batman.Model` Associations](\/docs\/api\/batman.model_associations.html))\n- generating URLs\n\nChange the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n      equal Shop.get('primaryKey'), 'shop_id'\n\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n\n        @validate 'title', 'body', {presence: true} # title and body must be present (not undefined nor '')\n        @validate 'body', {minLength: 10}           # body must be 10 characters long at least\n        @validate 'title', {pattern: \/^[A-Z]\/}      # Title must start with an uppercase letter\n        @validate 'author', {email: true}           # the author field must contain a valid email address\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n + `regexp : \/regexp\/` : Assert that the value is matching the provided regular expression.\n + `email : true` : Assert that the value is an email address, per the [W3C HTML5 definition](http:\/\/www.w3.org\/TR\/html5\/forms.html#valid-e-mail-address).\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::isDirty() : Boolean\n\nReturns `true` if any keys have been changed since the record was initialized or saved.\n\n## ::%isDirty : Boolean\n\nA bindable accessor on [`isDirty`](\/docs\/api\/batman.model.html#prototype_function_isdirty).\n\n## ::%dirtyKeys : Set\n\nThe [`Batman.Set`](\/docs\/api\/batman.set.html) of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::constructor(idOrAttributes = {}) : Model\n\nReturns a new `Batman.Model`. If `idOrAttributes` is an object, the values are mixed into the new record. Otherwise, `idOrAttrubutes` is set to the new record's [`id`](\/docs\/api\/batman.model.html#prototype_accessor_id).\n\n## ::isNew() : boolean\n\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## ::%isNew : Boolean\n\nA bindable accessor on [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew).\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# \/api\/App Components\/Batman.Model\/Batman.Validator\n\nbatman.js ships with a plethora of [built-in validators](\/docs\/api\/batman.model.html#class_function_validate), but when they don't meet your needs, you can create custom validators by subclassing `Batman.Validator`, implementing `Batman.Validator::validateEach`, and adding the new validator to `Batman.Validators`. For example:\n\n```coffeescript\nclass App.LessThanPropertyValidator extends Batman.Validator\n  @triggers 'lessThanProperty'\n  @options 'allowBlank'\n\n  validateEach: (errors, record, key, callback) ->\n      value = record.get(key)\n      compareKey = @options.lessThanProperty\n      otherValue = record.get(compareKey)\n      else !@handleBlank(value) && value >= otherValue\n        errors.add(key, 'must be less than #{compareKey}')\n      callback()\n\nBatman.Validators.push App.LessThanPropertyValidator\n```\n\n## ::constructor(options : Object[, mixins...])\n\nThe first argument becomes the validator's `@options`. Subsequent arguments are mixed in to the validator with `Batman.Object::mixin`. You can override this method to alter the options object before it's assigned to `@options`. (Make sure to call `super` afterwards!)\n\n## @triggers(triggers...)\n\nWhen any of the strings in `triggers` is passed to `Model@validate`:\n\n- this validator will be instantiated and its `validateEach` will be invoked\n- the key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUse this method when one validator will handle many kinds of validations. For example, a simplified length validator:\n\n```coffeescript\nclass App.SimpleLengthValidator extends Batman.Validator\n  @triggers 'minLength', 'maxLength', 'length'\n\n  constructor: (options) ->\n    # has access to options.minLength, options.maxLength, options.length\n    super\n\n  validateEach: (errors, record, key, callback) ->\n    # has access to @options.minLength, @options.maxLength, @options.length\n```\n\nAll three of these validations will be handled by `App.SimpleLengthValidator::validateEach`:\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @validate 'name', minLength: 3\n  @validate 'bio', maxLength: 250\n  @validate 'phone_number', length: 10\n```\n\n## @options(options...)\n\nThe key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUnlike `@triggers`, the presence of a key in `options` will not cause this validator to be instantiated.\n\n## ::validateEach(errors: Batman.ErrorsSet, record: Batman.Model, key: String, callback: Function)\n\nThis method is invoked to validate `key` on `record`. If this method determins that the key is invalid, it should add a validation error to `errors`.\n\n`errors` is a `Batman.ErrorsSet`, which is a [`Batman.Set`](\/docs\/api\/batman.set.html) with `::add(key, message)` as a convenience method for adding [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s. So, to easily add a new validation error:\n\n```coffeescript\nerrors.add(\"phone_number\", \"isn't 10 characters long\")\n```\n\nWhen the validator is finished, it must call `callback` to continue the validation chain.\n\n## @handleBlank(value)\n\nReturns `true` if `options.allowBlank` is `true` _and_ `value` is `null`, `undefined` or `\"\"`\n\n# \/api\/App Components\/Batman.Model\/Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n\n        @validate 'title', 'body', {presence: true} # title and body must be present (not undefined nor '')\n        @validate 'body', {minLength: 10}           # body must be 10 characters long at least\n        @validate 'title', {pattern: \/^[A-Z]\/}      # Title must start with an uppercase letter\n        @validate 'author', {email: true}           # the author field must contain a valid email address\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n + `regexp : \/regexp\/` : Assert that the value is matching the provided regular expression.\n + `email : true` : Assert that the value is an email address, per the [W3C HTML5 definition](http:\/\/www.w3.org\/TR\/html5\/forms.html#valid-e-mail-address).\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::%isDirty : Boolean\n\nReturns `true` if any keys have been changed since the record was initialized or saved.\n\n## ::%dirtyKeys : Set\n\nThe [`Batman.Set`](\/docs\/api\/batman.set.html) of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::constructor(idOrAttributes = {}) : Model\n\nReturns a new `Batman.Model`. If `idOrAttributes` is an object, the values are mixed into the new record. Otherwise, `idOrAttrubutes` is set to the new record's [`id`](\/docs\/api\/batman.model.html#prototype_accessor_id).\n\n## ::isNew() : boolean\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# \/api\/App Components\/Batman.Model\/Batman.Validator\n\nbatman.js ships with a plethora of [built-in validators](\/docs\/api\/batman.model.html#class_function_validate), but when they don't meet your needs, you can create custom validators by subclassing `Batman.Validator`, implementing `Batman.Validator::validateEach`, and adding the new validator to `Batman.Validators`. For example:\n\n```coffeescript\nclass App.LessThanPropertyValidator extends Batman.Validator\n  @triggers 'lessThanProperty'\n  @options 'allowBlank'\n\n  validateEach: (errors, record, key, callback) ->\n      value = record.get(key)\n      compareKey = @options.lessThanProperty\n      otherValue = record.get(compareKey)\n      else !@handleBlank(value) && value >= otherValue\n        errors.add(key, 'must be less than #{compareKey}')\n      callback()\n\nBatman.Validators.push App.LessThanPropertyValidator\n```\n\n## ::constructor(options : Object[, mixins...])\n\nThe first argument becomes the validator's `@options`. Subsequent arguments are mixed in to the validator with `Batman.Object::mixin`. You can override this method to alter the options object before it's assigned to `@options`. (Make sure to call `super` afterwards!)\n\n## @triggers(triggers...)\n\nWhen any of the strings in `triggers` is passed to `Model@validate`:\n\n- this validator will be instantiated and its `validateEach` will be invoked\n- the key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUse this method when one validator will handle many kinds of validations. For example, a simplified length validator:\n\n```coffeescript\nclass App.SimpleLengthValidator extends Batman.Validator\n  @triggers 'minLength', 'maxLength', 'length'\n\n  constructor: (options) ->\n    # has access to options.minLength, options.maxLength, options.length\n    super\n\n  validateEach: (errors, record, key, callback) ->\n    # has access to @options.minLength, @options.maxLength, @options.length\n```\n\nAll three of these validations will be handled by `App.SimpleLengthValidator::validateEach`:\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @validate 'name', minLength: 3\n  @validate 'bio', maxLength: 250\n  @validate 'phone_number', length: 10\n```\n\n## @options(options...)\n\nThe key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUnlike `@triggers`, the presence of a key in `options` will not cause this validator to be instantiated.\n\n## ::validateEach(errors: Batman.ErrorsSet, record: Batman.Model, key: String, callback: Function)\n\nThis method is invoked to validate `key` on `record`. If this method determins that the key is invalid, it should add a validation error to `errors`.\n\n`errors` is a `Batman.ErrorsSet`, which is a [`Batman.Set`](\/docs\/api\/batman.set.html) with `::add(key, message)` as a convenience method for adding [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s. So, to easily add a new validation error:\n\n```coffeescript\nerrors.add(\"phone_number\", \"isn't 10 characters long\")\n```\n\nWhen the validator is finished, it must call `callback` to continue the validation chain.\n\n## @handleBlank(value)\n\nReturns `true` if `options.allowBlank` is `true` _and_ `value` is `null`, `undefined` or `\"\"`\n\n# \/api\/App Components\/Batman.Model\/Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9380ff9c676635a1a025d1f4e85b1c67e17dca13","subject":"update comment on route\/index","message":"update comment on route\/index\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/lib\/routes\/index.litcoffee","new_file":"src\/lib\/routes\/index.litcoffee","new_contents":"\n# Application Routes\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\n    module.exports = (app) ->\n\n## \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        fs = require('fs')\n        res.render 'index', {\n          title: 'Welcome',\n          extra_head_css: fs.readFileSync('views\/extra\/nivo.css'),\n          extra_foot_js: fs.readFileSync('views\/extra\/nivo.js')\n        }\n\n## \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        pg_view = \"page\/\" + req.params.name\n        res.render pg_view\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Routes\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\n    module.exports = (app) ->\n\n## \/\n\nRender Hello World.\n\n      app.get '\/', (req, res) ->\n        fs = require('fs')\n        res.render 'index', {\n          title: 'Welcome',\n          extra_head_css: fs.readFileSync('views\/extra\/nivo.css'),\n          extra_foot_js: fs.readFileSync('views\/extra\/nivo.js')\n        }\n\n## \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        pg_view = \"page\/\" + req.params.name\n        res.render pg_view\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"5b1f630035380dffa4921bf9d1107a4178103050","subject":"Minor comment changes","message":"Minor comment changes\n","repos":"ojjs\/oj","old_file":"src\/oj.litcoffee","new_file":"src\/oj.litcoffee","new_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = ->\n\n   Prevent oj function from emitting\n\n      oj._argumentsPush()\n\n  oj function acts like a tag method that doesn't emit\n\n      ojml = oj.emit.apply @, arguments\n      oj._argumentsPop()\n      ojml\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.0.14'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\nTODO: Static server side support for loading any generated pages dynamically.\nTODO: Support Backbone routes to trigger page changes.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      jQuery ->\n\n  Compile only the body and below\n\n        bodyOnly = html:1, doctype:1, head:1, link:1, script:1\n        {dom,types} = oj.compile dom:1, html:0, css:0, styles:1, ignore:bodyOnly, (require page)\n\n        if not dom?\n          throw new Error 'oj: dom failed to compile'\n          return\n\n  Find body element\n\n        body = document.getElementsByTagName 'body'\n        if body.length == 0\n          throw new Error('oj: <body> was not found')\n        body = body[0]\n\n  Clear body and insert dom elements\n\n        body.innerHTML = ''\n        if not oj.isArray dom\n          dom = [dom]\n        for d in dom\n          body.appendChild d\n\n  Trigger inserted event for types\n\n        for t in types\n          t.inserted()\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\nGenerate a unique guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      # TODO: support cloning OJ instances\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nFunctional Helpers\n------------------------------------------------------------------------\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n\nIndexing Helpers\n-----------------------------------------------------------------------------\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n-----------------------------------------------------------------------------\n\n  _splitAndTrim: Split string by seperator and trim the resulting values\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _dasherize: Convert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n  _decamelize: Convert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\nPath Helpers\n------------------------------------------------------------------------------\nUsed to implement require client side. These methods are simplified versions of\nthe node `path` library: github.com\/joyent\/node\/lib\/path.js\n\n    _pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    _pathSplit = (filename) ->\n      result = _pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n    _pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n      parts\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = _pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n      path = _pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n      if !path and !isAbsolute\n        path = '.'\n      if path and trailingSlash\n        path += '\/'\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = ArrayP.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = _pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        return '.'\n      if dir\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name) ->\n      obj = if oj.isClient then window[name] else global[name]\n      throw new Error(\"oj: #{name} dependency is missing\") unless oj.isDefined obj\n\nDepend on jQuery\n\n    oj.dependency 'jQuery'\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw 'oj.addProperty: string expected for second argument' unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw 'oj.isProperty: string expected for second argument' unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argumentsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argumentsStack = []\n\n  Result is top of the stack\n\n    oj._argumentsTop = ->\n      if _argumentsStack.length\n        _argumentsStack[_argumentsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argumentsPush = (args = []) ->\n      _argumentsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argumentsPop = ->\n      if _argumentsStack.length\n        return _argumentsStack.pop()\n      null\n\n  Append argument\n\n    oj._argumentsAppend = (arg) ->\n      top = oj._argumentsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, args...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from args by unioning all objects\n\n      attributes = {}\n      for arg in args\n\n  TODO: evaluate argument if necessary\n\n        if oj.isObject arg\n          _extend attributes, arg\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argumentsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n        else if oj.isFunction arg\n\n          len = oj._argumentsTop().length\n\n          # Call the argument it will auto append to oj._argumentsTop() which is ojml\n          r = arg()\n\n          # Use return value if oj._argumentsTop() weren't changed\n          if len == oj._argumentsTop().length and r?\n            oj._argumentsAppend r\n\n        else\n          oj._argumentsAppend arg\n\n  Pop to restore previous context\n\n      oj._argumentsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to\n\n      oj._argumentsAppend ojml\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n        oj[t] = -> oj.tag t, arguments...\n        # Remember the tag name\n        _setTagName oj[t], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = '<!DOCTYPE HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = '<!DOCTYPE html>'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\">'\n\n  Define possible arguments\n\n    doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\">'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\">'\n\n  Define the method\n\n    oj.doctype = (type = 5) ->\n      ojml = doctypes[type]\n\n  Emit as a tag would\n\n      oj._argumentsAppend ojml\n      ojml\n\noj.extend (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.extend = (context = root) ->\n      o = {}\n      for k,v of oj\n        if k[0] != '_'\n          o[k] = v\n      delete o.extend\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* debug - Keep all source including comments\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        styles: false\n        debug: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap or options.styles then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, debug: options.debug, tags:0\n\n      # Generate style tags if necessary\n      if options.styles\n        styles = _cssFromPluginObject pluginCSSMap, debug: options.debug, tags:1\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, styles:styles, types:acc.types, tags:acc.tags\n\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n  TODO: Refactor to use the same code as media queries\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      debug = options.debug ? 0\n      tags = options.tags ? 0\n      minify = options.minify ? 0\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if debug and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if debug then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\ndebug:true will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      debug = options.debug ? 0\n      tags = options.tags ? 0\n      minify = options.minify ? 0\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        when 'jquery'\n          # TODO: Missing unit tests for the jquery case\n          options.html?.push ojml.html()\n          options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML()\n            options.dom?.appendChild ojml.toDOM()\n            if options.css?\n              _extend options.css, ojml.toCSSMap()\n\n      return\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Compile ojml tag (an array)\n    _compileTag = (ojml, options) ->\n\n      # Empty list compiles to nothing\n      return if ojml.length == 0\n\n      # Get tag\n      tag = ojml[0]\n      tagType = typeof tag\n\n      # Allow ojml's tag parameter to be 'table' or table or Table\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n\n      # Fail if we couldn't find a string by now\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n      # Create oj object if tag is capitalized\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n      # Record tag\n      options.tags[tag] = true\n\n      # Get attributes (optional)\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n      # Remaining arguments are children of this tag\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n      # Compile to css if requested\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n      # Compile to html if requested\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n\n      # Compile your children if necessary\n      for child in children\n        # Skip intention if there is only one child\n        if options.debug && children.length > 1\n          options.html?.push \"\\n\\t#{options.indent}\"\n        _compileDeeper _compileAny, child, options\n\n      # Skip intention if there is only one child\n      if options.debug && children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n      # End html tag if you have children or your tag closes\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Allow attributes to take class as an array of strings\n    _attributeClassAllowsArrays = (attr) ->\n      if oj.isArray attr?.class\n        attr.class = attr.join ' '\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # TODO: Consider jsoning anything that isn't a string\n      # any keys that aren't strings are jsoned\n      # _attributesJSONAllKeys attributes\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if $?\n          if oj.isArray ev\n            $(el)[ek].apply @, ev\n          else\n            $(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\n    # oj.toHTML\n    # ------------------------------------------------------------------------------\n    # Make oj directly to HTML. It will ignore all event bindings\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\n    # oj.toCSS\n    # ------------------------------------------------------------------------------\n    # Make oj directly to css. It will ignore all event bindings and html\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        # TODO: Make this O(1)\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        # TODO: Make this O(1)\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # argumentsUnion:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.argumentsUnion = (argList) ->\n      obj = {}\n      list = []\n      for v in argList\n        if oj.isObject v\n          obj = _extend obj, v\n        else\n          list.push v\n      options: obj, args: list\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = $ @el)\n\n        # Get and set id of view from attribute\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all currently set themes (readwrite)\n        themes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n\n              # Wrap k in quotes if it has whitespace\n              if k == 'class'\n                @$el.addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single theme\n        addTheme: (name) ->\n          @$el.addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @$el.removeClass \"theme-#{name}\"\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argumentsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.debug then '\\n' else '')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (debug) -> _cssFromPluginObject (_flattenCSSMap @cssMap), debug:debug,tags:0\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n    oj.View.css = (def) ->\n      # TODO: Support def being a raw css string\n      cssMap = _setObject {}, \".oj-#{@typeName}\", def\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n    oj.View.theme = (name, def) ->\n      throw new Error(\"oj.#{@typeName}.theme: string expected for first argument (theme name)\") unless oj.isString name\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", def\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.textarea\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: (args) ->\n        {options, args} = oj.argumentsUnion arguments\n\n        # Label is first argument\n        options.label ?= if args.length > 0 then args[0] else ''\n\n        @el = oj =>\n          oj.button options.label\n\n        oj.Button.base.constructor.apply @, [options]\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> console.log \"clearing body: oj.litcoffee:2930\";@$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get $(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set $(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\njquery.oj\n-----------------------------------------------------------------------------\n\n    jQuery.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types} = oj.compile {dom:1,html:0,css:0}, args...\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        for d in dom\n          $el.append d\n\n        # Call inserted event on all types\n        for t in types\n          t.inserted()\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njquery.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    jQuery.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njquery.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    jQuery.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njquery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        jQuery.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types} = oj.compile {dom:1,html:0,css:0}, args...\n\n            # Append to the dom\n            $el[jqName] dom\n\n            for t in types\n              t.inserted()\n\n            return\n\n          get:null\n","old_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = ->\n\n   Prevent oj function from emitting\n\n      oj._argumentsPush()\n\n  oj function acts like a tag method that doesn't emit\n\n      ojml = oj.emit.apply @, arguments\n\n      oj._argumentsPop()\n      ojml\n\noj.emit\n-------------------------------------------------------------------------------\nEmit arguments as a tag would.\nUsed by plugins to group multiple elements as if it is a single tag.\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.0.14'\n\n  Detect if this is client or server-side\n\n    oj.isClient = not process?.versions?.node\n\n  Export as a module in node\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in node\n\n    else\n      root['oj'] = oj\n\n  Reference ourselves for template files to see\n\n    oj.oj = oj\n\noj.load\n-------------------------------------------------------------------------------\nLoad the page specified generating necessary html, css, and client side events.\nTODO: Static server side support for loading any generated pages dynamically.\nTODO: Support Backbone routes to trigger page changes.\n\n    oj.load = (page) ->\n\n  Defer dom manipulation until the page is ready\n\n      jQuery ->\n\n  Compile only the body and below\n\n        bodyOnly = html:1, doctype:1, head:1, link:1, script:1\n        {dom,types} = oj.compile dom:1, html:0, css:0, styles:1, ignore:bodyOnly, (require page)\n\n        if not dom?\n          throw new Error 'oj: dom failed to compile'\n          return\n\n  Find body element\n\n        body = document.getElementsByTagName 'body'\n        if body.length == 0\n          throw new Error('oj: <body> was not found')\n        body = body[0]\n\n  Clear body and insert dom elements\n\n        body.innerHTML = ''\n        if not oj.isArray dom\n          dom = [dom]\n        for d in dom\n          body.appendChild d\n\n  Trigger inserted event for types\n\n        for t in types\n          t.inserted()\n\n  Trigger events bound through onload\n\n        oj.onload()\n\noj.onload\n-------------------------------------------------------------------------------\nEnlist in onload action.\n\n    _onLoadQueue = queue:[], loaded:false\n    oj.onload = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _onLoadQueue.loaded = true\n        while (f = _onLoadQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _onLoadQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _onLoadQueue.queue.push f\n      return\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\noj.guid\n-----------------------------------------------------------------------------\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility: Helpers\n------------------------------------------------------------------------------\n\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      # TODO: support cloning OJ instances\n      # TODO: support options, deep: true\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nUtility: Iteration\n------------------------------------------------------------------------\n\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n  _splitAndTrim\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n------------------------------------------------------------------------------\n\n    _dasherize = (str) ->\n\n      out\n\nPath Helpers\n------------------------------------------------------------------------------\nA simplified form of  github.com\/joyent\/node\/lib\/path.js\n\n    pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n\n      parts\n\n    pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    pathSplit = (filename) ->\n      result = pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n\n      # Normalize the path\n      path = pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n\n      if !path and !isAbsolute\n        path = '.'\n\n      if path and trailingSlash\n        path += '\/'\n\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = Array.prototype.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        # No dirname whatsoever\n        return '.'\n      if dir\n        # It has a dirname, strip trailing slash\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name) ->\n      obj = if oj.isClient then window[name] else global[name]\n      throw new Error(\"oj: #{name} dependency is missing\") unless oj.isDefined obj\n\nDepend on jQuery\n\n    oj.dependency 'jQuery'\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw 'oj.addProperty: string expected for second argument' unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw 'oj.isProperty: string expected for second argument' unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argumentsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argumentsStack = []\n\n  Result is top of the stack\n\n    oj._argumentsTop = ->\n      if _argumentsStack.length\n        _argumentsStack[_argumentsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argumentsPush = (args = []) ->\n      _argumentsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argumentsPop = ->\n      if _argumentsStack.length\n        return _argumentsStack.pop()\n      null\n\n  Append argument\n\n    oj._argumentsAppend = (arg) ->\n      top = oj._argumentsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, args...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from args by unioning all objects\n\n      attributes = {}\n      for arg in args\n\n  TODO: evaluate argument if necessary\n\n        if oj.isObject arg\n          _extend attributes, arg\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argumentsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n        else if oj.isFunction arg\n\n          len = oj._argumentsTop().length\n\n          # Call the argument it will auto append to oj._argumentsTop() which is ojml\n          r = arg()\n\n          # Use return value if oj._argumentsTop() weren't changed\n          if len == oj._argumentsTop().length and r?\n            oj._argumentsAppend r\n\n        else\n          oj._argumentsAppend arg\n\n  Pop to restore previous context\n\n      oj._argumentsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to\n\n      oj._argumentsAppend ojml\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n        oj[t] = -> oj.tag t, arguments...\n        # Remember the tag name\n        _setTagName oj[t], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = '<!DOCTYPE HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = '<!DOCTYPE html>'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\">'\n\n  Define possible arguments\n\n    doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\">'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\">'\n\n  Define the method\n\n    oj.doctype = (type = 5) ->\n      ojml = doctypes[type]\n\n  Emit as a tag would\n\n      oj._argumentsAppend ojml\n      ojml\n\noj.extend (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.extend = (context = root) ->\n      o = {}\n      for k,v of oj\n        if k[0] != '_'\n          o[k] = v\n      delete o.extend\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* debug - Keep all source including comments\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: false\n        css: false\n        cssMap: false\n        styles: false\n        debug: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css or options.cssMap or options.styles then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      if acc.css?\n        pluginCSSMap = _flattenCSSMap acc.css\n\n      # Output cssMap if necessary\n      if options.cssMap\n        cssMap = pluginCSSMap\n\n      # Generate css if necessary\n      if options.css\n        css = _cssFromPluginObject pluginCSSMap, debug: options.debug, tags:0\n\n      # Generate style tags if necessary\n      if options.styles\n        styles = _cssFromPluginObject pluginCSSMap, debug: options.debug, tags:1\n\n      # Generate HTML if necessary\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom if necessary\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, styles:styles, types:acc.types, tags:acc.tags\n\n      out\n\n_dasherize\n-----------------------------------------------------------------------------\nConvert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n_decamelize\n-----------------------------------------------------------------------------\nConvert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n`'plugin' -> '@media query' -> 'selector' ->'rulesMap'`\n\nThis method vastly simplifies `_cssFromPluginObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      for plugin,cssMap_ of cssMap\n        _flattenCSSMap_ cssMap_, flatMap, [''], [''], plugin\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc, plugin) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n  TODO: Refactor to use the same code as media queries\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext, plugin\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, plugin, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_cssFromMediaObject:\n-----------------------------------------------------------------------------\nConvert css from a flattened rule object. The rule object is of the form:\nmediaQuery => selector => rulesObject\n\nPlaceholder functions for server side minification\n\n    oj._minifyJS = (js,options) -> js\n    oj._minifyCSS = (css,options) -> css\n\n    _cssFromMediaObject = (mediaMap, options = {}) ->\n\n      debug = options.debug ? 0\n      tags = options.tags ? 0\n      minify = options.minify ? 0\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n  Build css for media => selector =>  rules\n\n      css = ''\n      for media, selectorMap of mediaMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if debug and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if debug then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += rules + indent + '}' + newline\n\n  End media query\n\n        if media != ''\n          css += '}' + newline\n      try\n        css = oj._minifyCSS css, options\n      catch eCSS\n        throw new Error \"css minification error: #{eCSS.message}\\nCould not minify:\\n#{css}\"\n\n      css\n\n_cssFromPluginObject:\n-----------------------------------------------------------------------------\nConvert flattened css selectors and rules to a string. Plugin objects are of the form:\npluginName => mediaQuery => selector => rulesObject\n\nSupports nested objections, comma seperated rules, and @media queries\n\ndebug:true will output newlines\ntags:true will output the css in `<style>` tags\n\n    _cssFromPluginObject = (flatCSSMap, options = {}) ->\n\n      debug = options.debug ? 0\n      tags = options.tags ? 0\n      minify = options.minify ? 0\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n      css = ''\n      for plugin, mediaMap of flatCSSMap\n        if tags\n          css += \"<style class=\\\"#{plugin}-style\\\">#{newline}\"\n\n  Serialize CSS with potential minification\n\n        css += _cssFromMediaObject mediaMap, options\n\n        if tags\n          css += \"#{newline}<\/style>#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        when 'jquery'\n          # TODO: Missing unit tests for the jquery case\n          options.html?.push ojml.html()\n          options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML()\n            options.dom?.appendChild ojml.toDOM()\n            if options.css?\n              _extend options.css, ojml.toCSSMap()\n\n      return\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Compile ojml tag (an array)\n    _compileTag = (ojml, options) ->\n\n      # Empty list compiles to nothing\n      return if ojml.length == 0\n\n      # Get tag\n      tag = ojml[0]\n      tagType = typeof tag\n\n      # Allow ojml's tag parameter to be 'table' or table or Table\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n\n      # Fail if we couldn't find a string by now\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n      # Create oj object if tag is capitalized\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n      # Record tag\n      options.tags[tag] = true\n\n      # Get attributes (optional)\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n      # Remaining arguments are children of this tag\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n      # Compile to css if requested\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css['oj'] ?= {}\n          options.css['oj'][selector] ?= {}\n          _extend options.css['oj'][selector], styles\n\n      # Compile to html if requested\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n\n      # Compile your children if necessary\n      for child in children\n        # Skip intention if there is only one child\n        if options.debug && children.length > 1\n          options.html?.push \"\\n\\t#{options.indent}\"\n        _compileDeeper _compileAny, child, options\n\n      # Skip intention if there is only one child\n      if options.debug && children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n      # End html tag if you have children or your tag closes\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Allow attributes to take class as an array of strings\n    _attributeClassAllowsArrays = (attr) ->\n      if oj.isArray attr?.class\n        attr.class = attr.join ' '\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # TODO: Consider jsoning anything that isn't a string\n      # any keys that aren't strings are jsoned\n      # _attributesJSONAllKeys attributes\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if $?\n          if oj.isArray ev\n            $(el)[ek].apply @, ev\n          else\n            $(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\n    # oj.toHTML\n    # ------------------------------------------------------------------------------\n    # Make oj directly to HTML. It will ignore all event bindings\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options, dom:0, js:0, html:1, css:0\n      (oj.compile options, ojml).html\n\n    # oj.toCSS\n    # ------------------------------------------------------------------------------\n    # Make oj directly to css. It will ignore all event bindings and html\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create css only\n      _extend options, dom:0, js:0, html:0, css:1\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        # TODO: Make this O(1)\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        # TODO: Make this O(1)\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # argumentsUnion:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.argumentsUnion = (argList) ->\n      obj = {}\n      list = []\n      for v in argList\n        if oj.isObject v\n          obj = _extend obj, v\n        else\n          list.push v\n      options: obj, args: list\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el} = oj.compile css:0, cssMap:0, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = $ @el)\n\n        # Get and set id of view from attribute\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # Get all currently set attributes (readonly)\n        attributes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get all currently set themes (readwrite)\n        themes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n          return\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n\n              # Wrap k in quotes if it has whitespace\n              if k == 'class'\n                @$el.addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # Add a single theme\n        addTheme: (name) ->\n          @$el.addClass \"theme-#{name}\"\n          return\n\n        # Remove a single theme\n        removeTheme: (name) ->\n          @$el.removeClass \"theme-#{name}\"\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argumentsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.debug then '\\n' else '')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (debug) -> _cssFromPluginObject (_flattenCSSMap @cssMap), debug:debug,tags:0\n\n        # Convert\n        toCSSMap: -> @type.cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n    oj.View.css = (def) ->\n      # TODO: Support def being a raw css string\n      cssMap = _setObject {}, \".oj-#{@typeName}\", def\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      return\n\n    oj.View.theme = (name, def) ->\n      throw new Error(\"oj.#{@typeName}.theme: string expected for first argument (theme name)\") unless oj.isString name\n\n      @cssMap[\"oj-#{@typeName}\"] ?= {}\n      dashName = _dasherize name\n      cssMap = _setObject {}, \".oj-#{@typeName}.theme-#{dashName}\", def\n      _extend @cssMap[\"oj-#{@typeName}\"], cssMap\n      @themes.push dashName\n      return\n\n    oj.View.cssMap = {}\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionModelAdded, @\n              @_models.on 'remove', @collectionModelRemoved, @\n              @_models.on 'change', @collectionModelChanged, @\n              @_models.on 'destroy', @collectionModelDestroyed, @\n              @_models.on 'reset', @collectionReset, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionModelAdded: (model, collection) -> @make()\n        collectionModelRemoved: (model, collection, options) -> @make()\n        collectionModelChanged: (model, collection, options) -> # Do nothing\n        collectionModelDestroyed: (collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.textarea\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: (args) ->\n        {options, args} = oj.argumentsUnion arguments\n\n        # Label is first argument\n        options.label ?= if args.length > 0 then args[0] else ''\n\n        @el = oj =>\n          oj.button options.label\n\n        oj.Button.base.constructor.apply @, [options]\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionModelAdded: Model add occurred, add the item\n\n        collectionModelAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionModelRemoved: Model remove occured, delete the item\n\n        collectionModelRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionModelRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionModelAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionModelRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> console.log \"clearing body: oj.litcoffee:2930\";@$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get $(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set $(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\njquery.oj\n-----------------------------------------------------------------------------\n\n    jQuery.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types} = oj.compile {dom:1,html:0,css:0}, args...\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        for d in dom\n          $el.append d\n\n        # Call inserted event on all types\n        for t in types\n          t.inserted()\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njquery.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    jQuery.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njquery.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    jQuery.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njquery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        jQuery.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types} = oj.compile {dom:1,html:0,css:0}, args...\n\n            # Append to the dom\n            $el[jqName] dom\n\n            for t in types\n              t.inserted()\n\n            return\n\n          get:null\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"deb72687b745b852fb0f7e24f1b34a4d3836628d","subject":"updated documentation","message":"updated documentation\n","repos":"LiuJinliang\/yangforge,corenova\/yang-forge,saintkepha\/yangjs,saintkepha\/yangforge,opnfv\/yangforge","old_file":"src\/yang-v1-compiler.litcoffee","new_file":"src\/yang-v1-compiler.litcoffee","new_contents":"Yang Version 1.0 Compiler\n=========================\n\nThe Yang v1 compiler is a Yang schema derived compiler that implements\nthe [RFC 6020](http:\/\/www.rfc-editor.org\/rfc\/rfc6020.txt) compliant\nlanguage extensions.  It is compiled by the `yang-core-compiler` to\nproduce a new compiler that can then be used to compile any other v1\ncompatible Yang schema definitions into JS code.\n\nOther uses of this compiler can be to compile yet another compiler\nthat can extend the Yang v1 extension keywords with other syntax that\ncan then natively support other Yang schemas without requiring the use\nof `prefix` semantics to define the schema definitions deriving from\nthe extension keywords.  For an example of an extended compiler,\nplease take a look at:\n[yang-storm](http:\/\/github.com\/stormstack\/yang-storm)\n\nCompiling a new Compiler\n------------------------\n\n1. Specify the compiler that will be utilized to compile\n2. Retrieve the target schema (in this case, a local schema file)\n3. Preprocess the schema to extract the meta data\n4. Extend the preprocessed schema's `meta` data with additional parameters\n5. Compile the schema with the modified `meta` data information\n\nBelow we select the locally available `yang-core-compiler` as the\ninitial compiler that will be used to generate the new Yang v1.0\nCompiler.  Click [here](.\/yang-core-compiler.litcoffee) to learn more\nabout the core compiler.\n\n    compiler = require '.\/yang-core-compiler'\n    schema = (require 'fs').readFileSync \"#{__dirname}\/..\/schemas\/yang-v1-compiler.yang\", 'utf-8'\n\nThe steps 3 and 4 are used **ONLY** when compiling a new `compiler`.\nWhen using a `compiler` to compile a new Yang schema based module,\nthere is usually no need to `preprocess` the schema and extend the\n`meta` data prior to `compile`.\n\n    meta = compiler.preprocess schema\n\nThe `meta` data represents the set of **rules** that the `compiler`\nwill utilize during `compile` operation.  The primary parameter for\nextending the underlying `meta` data is the `resolver`.\n\nThe `resolver` is a JS function which is used by the `compiler` when\ndefined for a given Yang extension keyword to handle that particular\nextension keyword.  It can resolve to a new class definition that will\nhouse the keyword and its sub-statements (for container style\nkeywords) or perform a specific operation without returning any value\nfor handling non-data schema extensions such as import, include, etc.\n\nThe `resolver` function runs with the context of the `compiler` itself\nso that the `this` keyword can be used to access any `meta` data or\nother functions available within the `compiler`.\n  \nOther parameters can be passed in during `meta` data augmentation as a\ncollection of key\/value pairs which inform what the valid\nsubstatements are for the given extension keyword.  The `key` is the\nname of the extension that can be further defined under the given\nextension and the `value` specifies the **cardinality** of the given\nsub statement (how many times it can appear under the given\nstatement). This facility is provided here due to the fact that Yang\nversion 1.0 language definition does not provide a sub-statement\nextension to the `extension` keyword to specify such constraints.\n\nHere we associate a new `resolver` to the `augment` statement\nextension.  The behavior of `augment` is to expand the target-node\nidentified by the `argument` with additional sub-statements described\nby the `augment` statement.\n\n    meta.merge 'augment', resolver: (arg, params) -> @[arg]?.extend? params; null\n\nFor below `import` and `include` statements, special resolvers are\nassociated to handle accessing the specified `argument` within the\nscope of the current schema being compiled.\n      \n    meta.merge 'import', resolver: (arg, params) -> @set params.prefix, (@get \"module:#{arg}\"); null\n    meta.merge 'include', resolver: (arg, params) -> @extend (@get \"module:#{arg}\"); null\n\nThe `refine` statement uses similar extend capability as `augment`.\n\n    meta.merge 'refine', resolver: (arg, params) -> @[arg]?.extend? params; null\n\nThe `uses` statement references a `grouping` node available within the\ncontext of the schema being compiled to return the contents at the\ncurrent `uses` node context.\n\n    meta.merge 'uses', resolver: (arg, params) -> @get \"grouping:#{arg}\"\n\nFinally, compile the schema with the modified `meta` data information\nand export it for use by external modules.\n\n    module.exports = compiler.compile schema, meta\n","old_contents":"Yang Version 1.0 Compiler\n=========================\n\nThe Yang v1 compiler is a Yang schema derived compiler that implements\nthe RFC 6020 compliant language extensions.  It is compiled by the\n`yang-core-compiler` to produce a new compiler that can then be used\nto compile any other v1 compatible Yang schema definitions into JS\ncode.\n\nOther uses of this compiler can be to compile yet another compiler\nthat can extend the Yang v1 extension keywords with other syntax that\ncan then natively support other Yang schemas without requiring the use\nof `prefix` semantics to define the schema definitions deriving from\nthe extension keywords.  For an example of an extended compiler,\nplease take a look at:\n[yang-storm](http:\/\/github.com\/stormstack\/yang-storm)\n\nCompiling a new Compiler\n------------------------\n\n1. Specify the compiler that will be utilized to compile\n2. Retrieve the target schema (in this case, a local schema file)\n3. Preprocess the schema to extract the meta data\n4. Extend the preprocessed schema's `meta` data with additional parameters\n5. Compile the schema with the modified `meta` data information\n\n    compiler = require '.\/yang-core-compiler'\n    schema = (require 'fs').readFileSync \"#{__dirname}\/..\/schemas\/yang-v1-compiler.yang\", 'utf-8'\n\nThe below steps 3 and 4 are used **ONLY** when compiling a new\n`compiler`.  When using a `compiler` to compile a new Yang schema\nbased module, there is usually no need to `preprocess` the schema and\nextend the `meta` data prior to `compile`.\n\n    meta = compiler.preprocess schema\n\nThe `meta` data represents the set of **rules** that the `compiler`\nwill utilize during `compile` operation.  The primary parameter for\nextending the underlying `meta` data is the `resolver`.\n\nThe `resolver` is a JS function which is used by the `compiler` when\ndefined for a given Yang extension keyword to handle that particular\nextension keyword.  It can resolve to a new class definition that will\nhouse the keyword and its sub-statements (for container style\nkeywords) or perform a specific operation without returning any value\nfor handling non-data schema extensions such as import, include, etc.\n\nThe `resolver` function runs with the context of the `compiler` itself\nso that the `this` keyword can be used to access any `meta` data or\nother functions available within the `compiler`.\n  \nOther parameters can be passed in during `meta` data augmentation as a\ncollection of key\/value pairs which inform what the valid\nsubstatements are for the given extension keyword.  The `key` is the\nname of the extension that can be further defined under the given\nextension and the `value` specifies the **cardinality** of the given\nsub statement (how many times it can appear under the given\nstatement). This facility is provided here due to the fact that Yang\nversion 1.0 language definition does not provide a sub-statement\nextension to the `extension` keyword to specify such constraints.\n\nHere we associate a new `resolver` to the `augment` statement extension.\n\n    meta.merge 'augment', resolver: (arg, params) -> @[arg]?.extend? params; null\n\nFor below `import` and `include` statements, special resolvers are\nassociated to handle accessing the specified `argument` within the\nscope of the current schema being compiled.\n      \n    meta.merge 'import', resolver: (arg, params) -> @set params.prefix, (@get \"module:#{arg}\"); null\n      \n    meta.merge 'include', resolver: (arg, params) -> @extend (@get \"module:#{arg}\"); null\n\nThe `refine` statement uses similar extend capability as `augment`\n\n    meta.merge 'refine', resolver: (arg, params) -> @[arg]?.extend? params; null # XXX - need to handle different?\n\nThe `uses` statement references a `grouping` node available within the\ncontext of the schema being compiled to return the contents at the\ncurrent `uses` node context.\n\n    meta.merge 'uses', resolver: (arg, params) -> @get \"grouping:#{arg}\"\n\nFinally, compile the schema with the modified `meta` data information\n\n    module.exports = compiler.compile schema, meta\n","returncode":0,"stderr":"","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"bfa9f74b757ee671948e43f769d33be4f76aa717","subject":"copyAppFiles API improvement","message":"copyAppFiles API improvement\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"Gruntfile.litcoffee","new_file":"Gruntfile.litcoffee","new_contents":"# Gruntfile\n\n*Entry point for the Grunt build process.*\n\n    {fork} = require \"#{__dirname}\/server\/bootstrap\"\n\n    module.exports = (grunt) ->\n\nFork so we can bootstrap a Shrub environment.\n\n      if child = fork()\n        grunt.registerTask 'bootstrap', ->\n\n          done = @async()\n\n          child.on 'close', (code) ->\n\n            return done() if code is 0\n\n            grunt.fail.fatal 'Child process failed', code\n\nForward all tasks.\n\n        {tasks} = require 'grunt\/lib\/grunt\/cli'\n        grunt.registerTask tasks[0] ? 'default', ['bootstrap']\n        grunt.registerTask(task, (->)) for task in tasks.slice 1\n\n        return\n\n      config = require 'config'\n      pkgman = require 'pkgman'\n\nLoad configuration.\n\n      config.load()\n      config.loadPackageSettings()\n\n## GruntConfiguration\n\n      class GruntConfiguration\n\n## *constructor*\n\n        constructor: ->\n\n          @_npmTasks = []\n          @_taskConfig = {}\n          @_tasks = {}\n\n          @pkg = grunt.file.readJSON 'package.json'\n\n## GruntConfiguration#configureTask\n\n* (String) `task` - The name of the task to configure.\n* (String) `key` - The name of the key in the task configuration to set. This\n  is generally the name of the package, but can be anything.\n* (Object) `config_` - The configuration to set. See the documentation for the\n  particular grunt task being configured to learn how to configure it.\n\n*Configure a Grunt task.*\n\n        configureTask: (task, key, config_) ->\n\n          (@_taskConfig[task] ?= {})[key] = config_\n\n          return\n\n## GruntConfiguration#taskConfiguration\n\n* (String) `task` - The name of the task to configure.\n* (String) `key` - The name of the key in the task configuration to set. This\n  is generally the name of the package, but can be anything.\n\n*Get the configuration for a Grunt task.*\n\n        taskConfiguration: (task, key) -> @_taskConfig[task]?[key]\n\n## GruntConfiguration#loadNpmTasks\n\n* (String Array) `tasks` - The list of NPM tasks to load.\n\n*Load NPM tasks.*\n\n        loadNpmTasks: (tasks) ->\n\n          @_npmTasks.push task for task in tasks\n\n          return\n\n## GruntConfiguration#registerTask\n\n* (String) `task` - The name of the task to configure.\n* (String Array or Function) `subtasksOrFunction` - Either an array of strings\n  which define the dependencies for the task, or a function which will be\n  executed for the task.\n\n*Register a Grunt task.*\n\n        registerTask: (task, subtasksOrFunction) ->\n\n          if 'function' is typeof subtasksOrFunction\n            @_tasks[task] = subtasksOrFunction\n          else\n            (@_tasks[task] ?= []).push subtasksOrFunction...\n\n          return\n\n## GruntConfiguration#copyAppFiles\n\n* (String) `path` - The path of the files to copy.\n* (String) `key` - The name of the key in the task configuration to set. This\n* (String) `dest` - The destination where the files will be copied. Defaults to\n  `'app'`.\n\n*Copy package files to `app`.*\n\n        copyAppFiles: (path, key, dest = 'app') ->\n\n          dest ?= 'app'\n\n          gruntConfig.configureTask 'copy', key, files: [\n            src: '**\/*'\n            dest: dest\n            expand: true\n            cwd: path\n          ]\n\n          gruntConfig.configureTask(\n            'watch', key\n\n            files: [\n              \"#{path}\/**\/*\"\n            ]\n            tasks: [\"build:#{key}\"]\n          )\n\n      gruntConfig = new GruntConfiguration()\n\n      gruntConfig.registerTask 'production', ['build']\n      gruntConfig.registerTask 'default', ['buildOnce']\n\n      built = false\n\n      gruntConfig.registerTask 'buildOnce', ->\n        return if built\n        built = true\n\n        grunt.task.run 'build'\n\n#### Invoke hook `shrubGruntConfig`.\n\n      pkgman.invoke 'shrubGruntConfig', gruntConfig, grunt\n\n#### Invoke hook `shrubGruntConfigAlter`.\n\n      pkgman.invoke 'shrubGruntConfigAlter', gruntConfig, grunt\n\nInitialize configuration.\n\n      grunt.initConfig gruntConfig._taskConfig\n\nLoad NPM tasks.\n\n      npmTasksLoaded = {}\n      for task in gruntConfig._npmTasks\n        continue if npmTasksLoaded[task]?\n        npmTasksLoaded[task] = true\n        grunt.loadNpmTasks task\n\nRegister custom tasks.\n\n      grunt.registerTask task, actions for task, actions of gruntConfig._tasks\n","old_contents":"# Gruntfile\n\n*Entry point for the Grunt build process.*\n\n    {fork} = require \"#{__dirname}\/server\/bootstrap\"\n\n    module.exports = (grunt) ->\n\nFork so we can bootstrap a Shrub environment.\n\n      if child = fork()\n        grunt.registerTask 'bootstrap', ->\n\n          done = @async()\n\n          child.on 'close', (code) ->\n\n            return done() if code is 0\n\n            grunt.fail.fatal 'Child process failed', code\n\nForward all tasks.\n\n        {tasks} = require 'grunt\/lib\/grunt\/cli'\n        grunt.registerTask tasks[0] ? 'default', ['bootstrap']\n        grunt.registerTask(task, (->)) for task in tasks.slice 1\n\n        return\n\n      config = require 'config'\n      pkgman = require 'pkgman'\n\nLoad configuration.\n\n      config.load()\n      config.loadPackageSettings()\n\n## GruntConfiguration\n\n      class GruntConfiguration\n\n## *constructor*\n\n        constructor: ->\n\n          @_npmTasks = []\n          @_taskConfig = {}\n          @_tasks = {}\n\n          @pkg = grunt.file.readJSON 'package.json'\n\n## GruntConfiguration#configureTask\n\n* (String) `task` - The name of the task to configure.\n* (String) `key` - The name of the key in the task configuration to set. This\n  is generally the name of the package, but can be anything.\n* (Object) `config_` - The configuration to set. See the documentation for the\n  particular grunt task being configured to learn how to configure it.\n\n*Configure a Grunt task.*\n\n        configureTask: (task, key, config_) ->\n\n          (@_taskConfig[task] ?= {})[key] = config_\n\n          return\n\n## GruntConfiguration#taskConfiguration\n\n* (String) `task` - The name of the task to configure.\n* (String) `key` - The name of the key in the task configuration to set. This\n  is generally the name of the package, but can be anything.\n\n*Get the configuration for a Grunt task.*\n\n        taskConfiguration: (task, key) -> @_taskConfig[task]?[key]\n\n## GruntConfiguration#loadNpmTasks\n\n* (String Array) `tasks` - The list of NPM tasks to load.\n\n*Load NPM tasks.*\n\n        loadNpmTasks: (tasks) ->\n\n          @_npmTasks.push task for task in tasks\n\n          return\n\n## GruntConfiguration#registerTask\n\n* (String) `task` - The name of the task to configure.\n* (String Array or Function) `subtasksOrFunction` - Either an array of strings\n  which define the dependencies for the task, or a function which will be\n  executed for the task.\n\n*Register a Grunt task.*\n\n        registerTask: (task, subtasksOrFunction) ->\n\n          if 'function' is typeof subtasksOrFunction\n            @_tasks[task] = subtasksOrFunction\n          else\n            (@_tasks[task] ?= []).push subtasksOrFunction...\n\n          return\n\n## GruntConfiguration#copyAppFiles\n\n* (String) `path` - The path of the files to copy.\n* (String) `key` - The name of the key in the task configuration to set. This\n* (Array) `watchTasks` - An array of tasks to run when any of the files in the\n  directory to move are added, updated or deleted.\n\n*Copy package files to `app`.*\n\n        copyAppFiles: (path, key, watchTasks) ->\n\n          watchTasks ?= [\"build:#{key}\"]\n\n          gruntConfig.configureTask 'copy', key, files: [\n            src: '**\/*'\n            dest: 'app'\n            expand: true\n            cwd: path\n          ]\n\n          gruntConfig.configureTask(\n            'watch', key\n\n            files: [\n              \"#{path}\/**\/*\"\n            ]\n            tasks: watchTasks\n          )\n\n      gruntConfig = new GruntConfiguration()\n\n      gruntConfig.registerTask 'production', ['build']\n      gruntConfig.registerTask 'default', ['buildOnce']\n\n      built = false\n\n      gruntConfig.registerTask 'buildOnce', ->\n        return if built\n        built = true\n\n        grunt.task.run 'build'\n\n#### Invoke hook `shrubGruntConfig`.\n\n      pkgman.invoke 'shrubGruntConfig', gruntConfig, grunt\n\n#### Invoke hook `shrubGruntConfigAlter`.\n\n      pkgman.invoke 'shrubGruntConfigAlter', gruntConfig, grunt\n\nInitialize configuration.\n\n      grunt.initConfig gruntConfig._taskConfig\n\nLoad NPM tasks.\n\n      npmTasksLoaded = {}\n      for task in gruntConfig._npmTasks\n        continue if npmTasksLoaded[task]?\n        npmTasksLoaded[task] = true\n        grunt.loadNpmTasks task\n\nRegister custom tasks.\n\n      grunt.registerTask task, actions for task, actions of gruntConfig._tasks\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"40b9492a566a6c5c571ca4d1ae34343d8609dd6d","subject":"docs data-defineview","message":"docs data-defineview\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the innerHTML of an element should be used for rendering the given view.\nThis is especially useful for defining multiple views in one HTML file.\n\nThe value follows Rails-style \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif\n\n`data-renderif` defers parsing of a node's child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","old_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a node's child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b5940765d44a90df343f8f4384b07f1bf2a467b5","subject":"Remove db dep","message":"Remove db dep\n\nHaving built-in api call logging is cool, but introduces a whole new class of problems\nand things for jyn to track that aren't really in it's wheelhouse.\n","repos":"bsgbryan\/jyn","old_file":"lib\/server.litcoffee","new_file":"lib\/server.litcoffee","new_contents":"    Madul = require 'madul'\n\n    STATUSES =\n      COMPLETE: 'COMPLETE'\n      ERROR:    'ERROR'\n      PROGRESS: 'PROGRESS'\n\n    EXCLUDE = [\n      'MODULE'\n      'ACTION'\n      'EXECUTE'\n    ]\n\n    heartbeat = -> @isAlive = true\n\n    class Server extends Madul\n\n      deps: [ '~ws' ]\n\n      boot: (args, done) ->\n        wss = new @ws.Server port: args.ws.port\n\n        setInterval ->\n          wss.clients.forEach (ws) ->\n            return ws.terminate() if ws.isAlive == false\n\n            ws.isAlive = false\n            ws.ping '', false, true\n        , 10000\n\n        wss.on 'error', (details) =>\n          console.log 'WebSocket Server got error', details\n\n        wss.on 'connection', (ws, req) =>\n          try\n            raw_ip = (req.headers['x-forwarded-for'] || req.connection.remoteAddress).split ':'\n            ip_v4  = raw_ip.pop()\n            ip_v6  = raw_ip.join ':'\n\n            ip_v4 = null if ip_v4.split('.').length != 4\n            ip_v6 = null if ip_v6.split(':').length  < 3\n          catch e\n            ip_v4  = null\n            ip_v6  = null\n          \n          ws.isAlive = true\n          ws.on 'pong', heartbeat\n          \n          ws.on 'message', (mess) =>\n            try\n              input = JSON.parse mess\n            catch e\n              return @_notify ws, STATUSES.ERROR, \"Could not parse as JSON: #{mess}\"\n\n            args = { }\n\n            for key, val of input\n              if key != 'MODULE' and key != 'ACTION'\n                args[key] = val\n\n            input._client_ip_address =\n              v4: ip_v4\n              v6: ip_v6\n\n            @handle input\n              .then (output) => @_notify ws, STATUSES.COMPLETE, output\n              .catch   (err) => @_notify ws, STATUSES.ERROR,    err.args? || err\n              .progress (up) => @_notify ws, STATUSES.PROGRESS, up\n\n          ws.on 'error', (details) =>\n            console.log 'WebSocket got error', details\n\n        done()\n\n      _notify: (socket, status, data) =>\n        if status == STATUSES.ERROR\n          out = { status, message: data }\n        else\n          out = { status, data }\n\n        try\n          if socket.readyState == @ws.OPEN\n            socket.send JSON.stringify(out), (err) =>\n              if err?\n                console.log 'Get error sending message', err\n          else\n            console.log 'SOCKET NOT OPEN'\n        catch e\n          console.log 'Message send threw an error', e\n\n      handle:\n        validate:\n          # KEY:    [ '.is_present', '.hasnt_expired' ]\n          MODULE: '.is_present'\n          ACTION: '.is_present'\n        before:   '.init_execution_context'\n        behavior: (input, done, fail, update) ->\n          args = { }\n\n          for own key, val of input\n            args[key] = val unless EXCLUDE.includes key\n\n          input.EXECUTE args\n            .then     done\n            .catch    fail\n            .progress update\n            .done()\n\n    module.exports = Server\n","old_contents":"    Madul = require 'madul'\n\n    STATUSES =\n      COMPLETE: 'COMPLETE'\n      ERROR:    'ERROR'\n      PROGRESS: 'PROGRESS'\n\n    EXCLUDE = [\n      'MODULE'\n      'ACTION'\n      'EXECUTE'\n    ]\n\n    heartbeat = -> @isAlive = true\n\n    class Server extends Madul\n\n      deps: [ '~ws', '.db' ]\n\n      boot: (args, done) ->\n        wss = new @ws.Server port: args.ws.port\n\n        setInterval ->\n          wss.clients.forEach (ws) ->\n            return ws.terminate() if ws.isAlive == false\n\n            ws.isAlive = false\n            ws.ping '', false, true\n        , 10000\n\n        wss.on 'error', (details) =>\n          console.log 'WebSocket Server got error', details\n\n        wss.on 'connection', (ws, req) =>\n          try\n            raw_ip = (req.headers['x-forwarded-for'] || req.connection.remoteAddress).split ':'\n            ip_v4  = raw_ip.pop()\n            ip_v6  = raw_ip.join ':'\n\n            ip_v4 = null if ip_v4.split('.').length != 4\n            ip_v6 = null if ip_v6.split(':').length  < 3\n          catch e\n            ip_v4  = null\n            ip_v6  = null\n          \n          ws.isAlive = true\n          ws.on 'pong', heartbeat\n          \n          ws.on 'message', (mess) =>\n            try\n              input = JSON.parse mess\n            catch e\n              return @_notify ws, STATUSES.ERROR, \"Could not parse as JSON: #{mess}\"\n\n            args = { }\n\n            for key, val of input\n              if key != 'MODULE' and key != 'ACTION'\n                args[key] = val\n\n            @db.log_api_call\n              v4_address: ip_v4\n              v6_address: ip_v6\n              module:     input.MODULE || 'NONE'\n              action:     input.ACTION || 'NONE'\n              args:       args\n\n            input._client_ip_address =\n              v4: ip_v4\n              v6: ip_v6\n\n            @handle input\n              .then (output) => @_notify ws, STATUSES.COMPLETE, output\n              .catch   (err) => @_notify ws, STATUSES.ERROR,    err.args? || err\n              .progress (up) => @_notify ws, STATUSES.PROGRESS, up\n\n          ws.on 'error', (details) =>\n            console.log 'WebSocket got error', details\n\n        done()\n\n      _notify: (socket, status, data) =>\n        if status == STATUSES.ERROR\n          out = { status, message: data }\n        else\n          out = { status, data }\n\n        try\n          if socket.readyState == @ws.OPEN\n            socket.send JSON.stringify(out), (err) =>\n              if err?\n                console.log 'Get error sending message', err\n          else\n            console.log 'SOCKET NOT OPEN'\n        catch e\n          console.log 'Message send threw an error', e\n\n      handle:\n        validate:\n          # KEY:    [ '.is_present', '.hasnt_expired' ]\n          MODULE: '.is_present'\n          ACTION: '.is_present'\n        before:   '.init_execution_context'\n        behavior: (input, done, fail, update) ->\n          args = { }\n\n          for own key, val of input\n            args[key] = val unless EXCLUDE.includes key\n\n          input.EXECUTE args\n            .then     done\n            .catch    fail\n            .progress update\n            .done()\n\n    module.exports = Server\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9c8086031a8c36279ec48573ae886731ba103c35","subject":"Replace deprecated ignore property with blacklist","message":"Replace deprecated ignore property with blacklist\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      blacklist:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nMake new cursor object with the correct query, fields, and other options (limit,\nskip, and sort).\n\n      cursor = req.db.col.find req.db.query, fields,\n        limit: Math.min (parseInt(req.query.limit, 10) or 20), 50\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min cursor.cmd.limit, Math.max total - cursor.cmd.skip, 0\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nMake new cursor object with the correct query, fields, and other options (limit,\nskip, and sort).\n\n      cursor = req.db.col.find req.db.query, fields,\n        limit: Math.min (parseInt(req.query.limit, 10) or 20), 50\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min cursor.cmd.limit, Math.max total - cursor.cmd.skip, 0\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"24a0b5ac5b87ba1de95c61534377167029e4aed6","subject":"Watch custom packages' js files","message":"Watch custom packages' js files\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-grunt\/modules.litcoffee","new_file":"packages\/shrub-grunt\/modules.litcoffee","new_contents":"# Grunt build process - Modules\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig) ->\n\n        gruntConfig.configureTask 'coffee', 'modules', files: [\n          cwd: 'client'\n          src: [\n            'packages.litcoffee'\n            'require.litcoffee'\n            'modules\/**\/*.{coffee,litcoffee}'\n          ]\n          dest: 'build\/js\/app'\n          expand: true\n          ext: '.js'\n        ,\n          src: [\n            '{custom,packages}\/*\/client\/**\/*.{coffee,litcoffee}'\n          ]\n          dest: 'build\/js\/app'\n          expand: true\n          ext: '.js'\n        ]\n\n        gruntConfig.configureTask 'concat', 'modules', files: [\n          src: [\n            'build\/js\/app\/{modules,packages,require}.js'\n          ]\n          dest: 'build\/js\/app\/modules.js'\n        ]\n\n        gruntConfig.configureTask 'copy', 'modules', files: [\n          expand: true\n          cwd: 'client\/modules'\n          src: ['**\/*.js']\n          dest: 'build\/js\/app\/modules'\n        ,\n          expand: true\n          src: ['{custom,packages}\/*\/client\/**\/*.js']\n          dest: 'build\/js\/app'\n        ]\n\n        gruntConfig.configureTask(\n          'watch', 'modules'\n\n          files: [\n            'client\/{packages,require}.litcoffee'\n            'client\/modules\/**\/*.{coffee,litcoffee}'\n            '{custom,packages}\/*\/client\/**\/*.{coffee,litcoffee}'\n            'custom\/*\/client\/**\/*.js'\n          ]\n          tasks: [\n            'build:modules', 'build:shrub'\n          ]\n          options: livereload: true\n        )\n\n        gruntConfig.configureTask(\n          'wrap', 'modules'\n\n          files: [\n            src: [\n              'build\/js\/app\/modules\/**\/*.js'\n              'build\/js\/app\/{custom,packages}\/*\/client\/**\/*.js'\n            ]\n            dest: 'build\/js\/app\/modules.js'\n          ]\n          options:\n            indent: '  '\n            wrapper: (filepath) ->\n\n              path = require 'path'\n\n              matches = filepath.match \/build\\\/js\\\/app\\\/([^\/]+)\\\/(.*)\/\n\n              switch matches[1]\n\n                when 'modules'\n\n                  moduleName = matches[2]\n\n                when 'custom', 'packages'\n\n                  parts = matches[2].split '\/'\n                  parts.splice 1, 1\n                  moduleName = parts.join '\/'\n\n              dirname = path.dirname moduleName\n              if dirname is '.' then dirname = '' else dirname += '\/'\n\n              extname = path.extname moduleName\n\n              moduleName = \"#{dirname}#{path.basename moduleName, extname}\"\n\n              if moduleName?\n                [\n                  \"requires_['#{moduleName}'] = function(module, exports, require, __dirname, __filename) {\\n\\n\"\n                  '\\n};\\n'\n                ]\n              else\n                ['', '']\n\n        )\n\n        gruntConfig.configureTask(\n          'wrap', 'modulesAll'\n\n          files: ['build\/js\/app\/modules.js'].map (file) -> src: file, dest: file\n          options:\n            indent: '  '\n            wrapper: [\n              '(function() {\\n\\n  var requires_ = {};\\n\\n'\n              '\\n\\n})();\\n\\n'\n            ]\n\n        )\n\n        gruntConfig.registerTask 'build:modules', [\n          'newer:coffee:modules'\n          'newer:copy:modules'\n          'wrap:modules'\n          'concat:modules'\n          'newer:wrap:modulesAll'\n        ]\n\n        gruntConfig.registerTask 'build', ['build:modules']\n","old_contents":"# Grunt build process - Modules\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubGruntConfig`.\n\n      registrar.registerHook 'shrubGruntConfig', (gruntConfig) ->\n\n        gruntConfig.configureTask 'coffee', 'modules', files: [\n          cwd: 'client'\n          src: [\n            'packages.litcoffee'\n            'require.litcoffee'\n            'modules\/**\/*.{coffee,litcoffee}'\n          ]\n          dest: 'build\/js\/app'\n          expand: true\n          ext: '.js'\n        ,\n          src: [\n            '{custom,packages}\/*\/client\/**\/*.{coffee,litcoffee}'\n          ]\n          dest: 'build\/js\/app'\n          expand: true\n          ext: '.js'\n        ]\n\n        gruntConfig.configureTask 'concat', 'modules', files: [\n          src: [\n            'build\/js\/app\/{modules,packages,require}.js'\n          ]\n          dest: 'build\/js\/app\/modules.js'\n        ]\n\n        gruntConfig.configureTask 'copy', 'modules', files: [\n          expand: true\n          cwd: 'client\/modules'\n          src: ['**\/*.js']\n          dest: 'build\/js\/app\/modules'\n        ,\n          expand: true\n          src: ['{custom,packages}\/*\/client\/**\/*.js']\n          dest: 'build\/js\/app'\n        ]\n\n        gruntConfig.configureTask(\n          'watch', 'modules'\n\n          files: [\n            'client\/{packages,require}.litcoffee'\n            'client\/modules\/**\/*.{coffee,litcoffee}'\n            '{custom,packages}\/*\/client\/**\/*.{coffee,litcoffee}'\n          ]\n          tasks: [\n            'build:modules', 'build:shrub'\n          ]\n          options: livereload: true\n        )\n\n        gruntConfig.configureTask(\n          'wrap', 'modules'\n\n          files: [\n            src: [\n              'build\/js\/app\/modules\/**\/*.js'\n              'build\/js\/app\/{custom,packages}\/*\/client\/**\/*.js'\n            ]\n            dest: 'build\/js\/app\/modules.js'\n          ]\n          options:\n            indent: '  '\n            wrapper: (filepath) ->\n\n              path = require 'path'\n\n              matches = filepath.match \/build\\\/js\\\/app\\\/([^\/]+)\\\/(.*)\/\n\n              switch matches[1]\n\n                when 'modules'\n\n                  moduleName = matches[2]\n\n                when 'custom', 'packages'\n\n                  parts = matches[2].split '\/'\n                  parts.splice 1, 1\n                  moduleName = parts.join '\/'\n\n              dirname = path.dirname moduleName\n              if dirname is '.' then dirname = '' else dirname += '\/'\n\n              extname = path.extname moduleName\n\n              moduleName = \"#{dirname}#{path.basename moduleName, extname}\"\n\n              if moduleName?\n                [\n                  \"requires_['#{moduleName}'] = function(module, exports, require, __dirname, __filename) {\\n\\n\"\n                  '\\n};\\n'\n                ]\n              else\n                ['', '']\n\n        )\n\n        gruntConfig.configureTask(\n          'wrap', 'modulesAll'\n\n          files: ['build\/js\/app\/modules.js'].map (file) -> src: file, dest: file\n          options:\n            indent: '  '\n            wrapper: [\n              '(function() {\\n\\n  var requires_ = {};\\n\\n'\n              '\\n\\n})();\\n\\n'\n            ]\n\n        )\n\n        gruntConfig.registerTask 'build:modules', [\n          'newer:coffee:modules'\n          'newer:copy:modules'\n          'wrap:modules'\n          'concat:modules'\n          'newer:wrap:modulesAll'\n        ]\n\n        gruntConfig.registerTask 'build', ['build:modules']\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9e380e7d043d34c3654b6b2f7e3ea120ad6897a5","subject":"Use the new conversion functions in the debug loader","message":"Use the new conversion functions in the debug loader\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/debug.litcoffee","new_file":"src\/coffee\/debug.litcoffee","new_contents":"Debug Routines\n==============\n\nOccasionally, software has bugs. It's also often quite convenient\nto be able to fix those bugs.\n\n    window.DEBUG = {}\n\nDebug Data Collections\n----------------------\n\nThis is a collection of debug data, for great debugging, and debug.\n\n    window.DEBUG.loadDebugData = ->\n        dateBase = do DayBase\n        WS.message.push\n            type: 'mode'\n            mode: 'judge'\n        WS.message.push\n            type: 'override'\n            override: null\n        WS.message.push\n            type: 'teams'\n            teams:\n                aaa:\n                    college: 'College A'\n                    name: 'Team A'\n                    notes: 'Bees'\n                    present: yes\n                bbb:\n                    college: 'College B'\n                    name: 'Team B'\n                    notes: ''\n                    present: yes\n                ccc:\n                    college: 'College C'\n                    name: 'Team C Alpha'\n                    notes: ''\n                    present: no\n                ccc2:\n                    college: 'College C'\n                    name: 'Team C Beta'\n                    notes: ''\n                    present: yes\n                ddd:\n                    college: 'College D'\n                    name: 'Team D'\n                    notes: 'eyes'\n                    present: yes\n        WS.message.push\n            type: 'day'\n            schedule: [\n                {key: 'w', start: dateBase + 3600*9, displayName: 'Doors Open', association: 0}\n                {key: 'x', start: dateBase + 3600*9 + 1800, displayName: 'Tinker Time', association: 0}\n                {key: 'y', start: dateBase + 3600*11, displayName: 'Briefing', association: 3}\n                {key: 'z', start: dateBase + 3600*12, displayName: 'League', association: 1}\n            ]\n\n","old_contents":"Debug Routines\n==============\n\nOccasionally, software has bugs. It's also often quite convenient\nto be able to fix those bugs.\n\n    window.DEBUG = {}\n\nDebug Data Collections\n----------------------\n\nThis is a collection of debug data, for great debugging, and debug.\n\n    window.DEBUG.loadDebugData = ->\n        currentDate = new Date\n        currentDate.setHours 0\n        currentDate.setMinutes 0\n        currentDate.setSeconds 0\n        dateBase = currentDate.valueOf() \/ 1000\n        WS.message.push\n            type: 'mode'\n            mode: 'judge'\n        WS.message.push\n            type: 'override'\n            override: null\n        WS.message.push\n            type: 'teams'\n            teams:\n                aaa:\n                    college: 'College A'\n                    name: 'Team A'\n                    notes: 'Bees'\n                    present: yes\n                bbb:\n                    college: 'College B'\n                    name: 'Team B'\n                    notes: ''\n                    present: yes\n                ccc:\n                    college: 'College C'\n                    name: 'Team C Alpha'\n                    notes: ''\n                    present: no\n                ccc2:\n                    college: 'College C'\n                    name: 'Team C Beta'\n                    notes: ''\n                    present: yes\n                ddd:\n                    college: 'College D'\n                    name: 'Team D'\n                    notes: 'eyes'\n                    present: yes\n        WS.message.push\n            type: 'day'\n            schedule: [\n                {key: 'w', start: dateBase + 3600*9, displayName: 'Doors Open', association: 0}\n                {key: 'x', start: dateBase + 3600*9 + 1800, displayName: 'Tinker Time', association: 0}\n                {key: 'y', start: dateBase + 3600*11, displayName: 'Briefing', association: 3}\n                {key: 'z', start: dateBase + 3600*12, displayName: 'League', association: 1}\n            ]\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"101b6ef880164706d7206806cb82ca7f5db87923","subject":"Added dynamic update to Box class","message":"Added dynamic update to Box class\n\nSigned-off-by: Diwank Singh <a78369447041e6bcf2913d083e4ed301785fc609@gmail.com>\n","repos":"creatorrr\/browser-bricks","old_file":"bricks.litcoffee","new_file":"bricks.litcoffee","new_contents":"Re: [Letter to a Source-Code-Reader](http:\/\/stewd.io\/pong\/lib\/pong.js)\n\nDear Stewart\n\nThanks for inspiring me and many like me with the wonders of js.\nWith all it's warts and issues, JS is still one of my favorite languages.\nI think simply by it's virtue of being the language of the web, it surpasses most others\nin it's ability to champion the spirit of openness and the creative.\n\nI have tried to keep this as simple as possible for the many awesome source code lovers\nto read, copy-paste and critique.\n\nThanks again for caring to write that letter in 2009. It made a kid smile.\n\nDiwank Singh\nJuly 2013\n\n*****\n\nBrowser Bricks\n==============\n\nAlright, let's get on with it.\n\nHelper Functions\n----------------\n\nFirst, let's define some helper functions for the application.\n\n    @_ = _ =   # _ namespace\n      # Extend objects\n      extend: (dest, src) ->\n        dest[k] = v for own k, v of src\n        dest\n\n      # Pick properties\n      pick: (obj, props) ->\n        result = {}\n        result[k] = obj[k] for k in props when obj[k]?\n\n        result\n\n      # UUID function (Copied shamelessly from https:\/\/gist.github.com\/bmc\/1893440)\n      uuid: ->\n        'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(\/[xy]\/g, (c) ->\n          r = Math.random() * 16 | 0\n          v = if c is 'x' then r else (r & 0x3|0x8)\n          v.toString(16)\n        )\n\n      # Simple serializer for flat objects\n      serialize: (obj, {sep, eq}, cb) ->\n        # Exec callback on all values of obj\n        obj[k] = cb v for own k, v of obj if cb?\n\n        # Return serialized obj\n        (\"#{ k }#{ eq }#{ v }\" for own k, v of obj).join sep\n\n      # Defer execution of function\n      defer: (fn, args...) -> window.setTimeout fn, 1, args...\n\n      # Clone object\n      clone: (obj) -> _.extend {}, obj\n\nInit Function\n-------------\n\nLet's write a global init function that can be used to register callbacks which are\nexecuted 'onload'.\n\n    # Callback register\n    @init = init = do ->\n      # Store registered callbacks\n      callbacks = []\n\n      # Run callbacks in order registered\n      exec = -> fn?() for fn in callbacks\n\n      # Onload callback\n      onLoad = (fn) ->\n        window.removeEventListener 'load', init, false\n        fn?()\n\n      (cb) ->\n        if cb?\n          # Register callback\n          callbacks.push cb\n        else\n          # Defer execution until stack cleared\n          onLoad -> _.defer exec\n\n        false\n\n    # Attach DOM load listener\n    window.addEventListener 'load', init, false\n\nClass: Box\n----------\n\nNow, let's define a box that will be the basic building block for the game.\nAll the objects will inherit from this class.\n\n    class Box\n      _EDITABLE: ['height', 'width', 'top', 'left']   # Editable settings\n      _settings:\n        # Default settings\n        height: 100\n        width:  200\n        top:    0\n        left:   0\n\n        # Fixed props\n        toolbar:     false\n        directories: false\n        fullscreen:  false\n        location:    false\n        menubar:     false\n        resizable:   false\n        scrollbars:  false\n        status:      false\n\n      _window: null  # Empty window object\n\n      constructor: (@url, settings) ->\n        # Override settings.\n        @_update settings\n\n        # Set random name\n        @id = _.uuid()\n        this\n\n      # -- Private --\n\n      _update: (settings) ->\n        # Update settings\n        _.extend @_settings, (_.pick settings, @_EDITABLE)\n\n        # Adjust window props\n        @_window?.moveTo (@_get 'left'), (@_get 'top')\n        @_window?.resizeTo (@_get 'width'), (@_get 'height')\n\n        # Return a copy of settings\n        @_getAll()\n\n      _get: (prop) -> @_settings[prop] if prop in @_EDITABLE\n      _getAll: -> _.clone @_settings\n\n      # -- Public --\n\n      # Show window with settings.\n      show: ->\n        # Serialize options\n        opts = _.serialize @_getAll(), {sep: ',', eq: '='}, (v) ->\n          switch v\n            when false then 'no'\n            when true then 'yes'\n            else v+''\n\n        @_window = window.open @url, @id, opts\n        this\n\n      # Hide the window.\n      hide: ->\n        @_window.close()\n        @_window = null\n        this\n\n      # Reset window settings.\n      reset: ->\n        @_update Box::settings\n        this\n\n      # Return or update window position coords.\n      position: (coords...) ->\n        # Set new coords\n        if coords.length then @_update\n          left: coords[0] ? Box::settings.left  # x\n          top:  coords[1] ? Box::settings.top   # y\n\n        # Return coords\n        [(@_get 'left'), (@_get 'top')]\n\n      # Return or update window dimensions.\n      size: (dimensions...) ->\n        # Set new dimensions\n        if dimensions.length then @_update\n          width: dimensions[0] ? Box::settings.width\n          height:  dimensions[1] ? Box::settings.height\n\n        # Return dimensions\n        [(@_get 'width'), (@_get 'height')]\n\n","old_contents":"Re: [Letter to a Source-Code-Reader](http:\/\/stewd.io\/pong\/lib\/pong.js)\n\nDear Stewart\n\nThanks for inspiring me and many like me with the wonders of js.\nWith all it's warts and issues, JS is still one of my favorite languages.\nI think simply by it's virtue of being the language of the web, it surpasses most others\nin it's ability to champion the spirit of openness and the creative.\n\nI have tried to keep this as simple as possible for the many awesome source code lovers\nto read, copy-paste and critique.\n\nThanks again for caring to write that letter in 2009. It made a kid smile.\n\nDiwank Singh\nJuly 2013\n\n*****\n\nBrowser Bricks\n==============\n\nAlright, let's get on with it.\n\nHelper Functions\n----------------\n\nFirst, let's define some helper functions for the application.\n\n    @_ = _ =   # _ namespace\n      # Extend objects\n      extend: (dest, src) ->\n        dest[k] = v for own k, v of src\n        dest\n\n      # Pick properties\n      pick: (obj, props) ->\n        result = {}\n        result[k] = obj[k] for k in props when obj[k]?\n\n        result\n\n      # UUID function (Copied shamelessly from https:\/\/gist.github.com\/bmc\/1893440)\n      uuid: ->\n        'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(\/[xy]\/g, (c) ->\n          r = Math.random() * 16 | 0\n          v = if c is 'x' then r else (r & 0x3|0x8)\n          v.toString(16)\n        )\n\n      # Simple serializer for flat objects\n      serialize: (obj, {sep, eq}, cb) ->\n        # Exec callback on all values of obj\n        obj[k] = cb v for own k, v of obj if cb?\n\n        # Return serialized obj\n        (\"#{ k }#{ eq }#{ v }\" for own k, v of obj).join sep\n\n      # Defer execution of function\n      defer: (fn, args...) -> window.setTimeout fn, 1, args...\n\n      # Clone object\n      clone: (obj) -> _.extend {}, obj\n\nInit Function\n-------------\n\nLet's write a global init function that can be used to register callbacks which are\nexecuted 'onload'.\n\n    # Callback register\n    @init = init = do ->\n      # Store registered callbacks\n      callbacks = []\n\n      # Run callbacks in order registered\n      exec = -> fn?() for fn in callbacks\n\n      # Onload callback\n      onLoad = (fn) ->\n        window.removeEventListener 'load', init, false\n        fn?()\n\n      (cb) ->\n        if cb?\n          # Register callback\n          callbacks.push cb\n        else\n          # Defer execution until stack cleared\n          onLoad -> _.defer exec\n\n        false\n\n    # Attach DOM load listener\n    window.addEventListener 'load', init, false\n\nClass: Box\n----------\n\nNow, let's define a box that will be the basic building block for the game.\nAll the objects will inherit from this class.\n\n    class Box\n      _EDITABLE: ['height', 'width', 'top', 'left']   # Editable settings\n      _settings:\n        # Default settings\n        height: 100\n        width:  200\n        top:    0\n        left:   0\n\n        # Fixed props\n        toolbar:     false\n        directories: false\n        fullscreen:  false\n        location:    false\n        menubar:     false\n        resizable:   false\n        scrollbars:  false\n        status:      false\n\n      _window: null  # Empty window object\n\n      constructor: (@url, settings) ->\n        # Override settings.\n        @_update settings\n\n        # Set random name\n        @id = _.uuid()\n        this\n\n      # -- Private --\n\n      _update: (settings) -> _.extend @_settings, (_.pick settings, @_EDITABLE)\n      _get: (prop) -> @_settings[prop] if prop in @_EDITABLE\n      _getAll: -> _.clone @_settings\n\n      # -- Public --\n\n      # Show window with settings.\n      show: ->\n        # Serialize options\n        opts = _.serialize @_getAll(), {sep: ',', eq: '='}, (v) ->\n          switch v\n            when false then 'no'\n            when true then 'yes'\n            else v+''\n\n        @_window = window.open @url, @id, opts\n        this\n\n      # Hide the window.\n      hide: ->\n        @_window.close()\n        @_window = null\n        this\n\n      # Reset window settings.\n      reset: ->\n        @_update Box::settings\n        this\n\n      # Return or update window position coords.\n      position: (coords) ->\n        # Set new coords\n        if coords? then @_update\n          left: coords[0] ? Box::settings.left  # x\n          top:  coords[1] ? Box::settings.top   # y\n\n        # Return coords\n        [(@_get 'left'), (@_get 'top')]\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"249e4df0d813afe2eaa1a259a18a971e3eba32e6","subject":"Update thumbnail version table documentation","message":"Update thumbnail version table documentation\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/upload.litcoffee","new_file":"src\/upload.litcoffee","new_contents":"    Upload = require 's3-uploader'\n\nConfigure [s3-uploader](https:\/\/github.com\/Turistforeningen\/node-s3-uploader) to\nstore the following versions:\n\n| Suffix    | Max Height | Max Width | Aspect Ratio |\n|-----------|------------|-----------|--------------|\n| `-full`   | `1200`     | `1200`    |              |\n| `-800`    | `800`      | `800`     | `3:2`        |\n| `-500`    | `500`      | `500`     | `3:2`        |\n| `-260`    | `260`      | `260`     | `3:2`        |\n| `-150`    | `150`      | `150`     | `3:2`        |\n\n    module.exports = new Upload process.env.AWS_BUCKET_NAME,\n      aws:\n        region: process.env.AWS_BUCKET_REGION\n        path: process.env.AWS_BUCKET_PATH\n        acl: 'public-read'\n        httpOptions: timeout: 60000\n\n      returnExif: true\n\n      cleanup:\n        original: true\n        versions: true\n\n      original:\n        awsImageAcl: 'private'\n\n      versions: [\n        suffix: '-full'\n        quality: 80\n        maxHeight: 1200\n        maxWidth: 1200\n      ,\n        suffix: '-800'\n        maxHeight: 800\n        maxWidth: 800\n        aspect: '3:2!h'\n      ,\n        suffix: '-500'\n        maxHeight: 500\n        maxWidth: 500\n        aspect: '3:2!h'\n      ,\n        suffix: '-260'\n        maxHeight: 260\n        maxWidth: 260\n        aspect: '3:2!h'\n      ,\n        suffix: '-150'\n        maxHeight: 150\n        maxWidth: 150\n        aspect: '3:2!h'\n      ]\n","old_contents":"    Upload = require 's3-uploader'\n\nConfigure [s3-uploader](https:\/\/github.com\/Turistforeningen\/node-s3-uploader) to\nstore the following versions:\n\n|\u00a0Suffix    | Max Height | Max Width\u00a0| Aspect Ratio |\n|-----------|------------|-----------|--------------|\n| `-full`   | `1200`     | `1200`    |              |\n| `-thumb`  | `250`      | `250`     | `1:1`        |\n| `-800`    | `800`      | `800`     | `3:2`        |\n| `-500`    | `500`      | `500`     | `3:2`        |\n| `-260`    | `260`      | `260`     | `3:2`        |\n| `-150`    | `150`      | `150`     | `3:2`        |\n\n    module.exports = new Upload process.env.AWS_BUCKET_NAME,\n      aws:\n        region: process.env.AWS_BUCKET_REGION\n        path: process.env.AWS_BUCKET_PATH\n        acl: 'public-read'\n        httpOptions: timeout: 60000\n\n      returnExif: true\n\n      cleanup:\n        original: true\n        versions: true\n\n      original:\n        awsImageAcl: 'private'\n\n      versions: [\n        suffix: '-full'\n        quality: 80\n        maxHeight: 1200\n        maxWidth: 1200\n      ,\n        suffix: '-800'\n        maxHeight: 800\n        maxWidth: 800\n        aspect: '3:2!h'\n      ,\n        suffix: '-500'\n        maxHeight: 500\n        maxWidth: 500\n        aspect: '3:2!h'\n      ,\n        suffix: '-260'\n        maxHeight: 260\n        maxWidth: 260\n        aspect: '3:2!h'\n      ,\n        suffix: '-150'\n        maxHeight: 150\n        maxWidth: 150\n        aspect: '3:2!h'\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"678f7bd8e3a35c8068c090046d0d2afa23c269f7","subject":"Finish writing documentation.","message":"Finish writing documentation.\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/routing.litcoffee","new_file":"guts\/routing.litcoffee","new_contents":"Routing\n=======\nThis file serves as the \"glue\" between the express router and sanity. Basically, we want a rails-esque routing system with all the routes declared in one location.  One advantage over rails, though, is that we're going to allow some degree of function composition in that we can declare multiple, reusable actions per-route, then let them pass the return value from one to the next.\n\nThis is done via unapologetic use of Promises. \n\n##Libraries\n\n    Promise = require 'bluebird'\n    fs = Promise.promisifyAll require 'fs'\n    _ = require 'lodash'\n\nAs a note, the `Promise.promisifyAll` function simply adds `Async` to the end of the methods in `fs` and subsequently allows Promises to be used instead of callbacks. \n\n##Local Modules\n\n    getControllers = require '.\/getControllers'\n    policies = require '.\/policies'\n\n\nLet's kickstart this router.\n\n    module.exports = (app) ->\n        \n-----------\n        \nThis grabs the controllers and returns back a promise'd object of them. It made more sense to put this in a separate file, since it'sarguably useful in its own right.\n\n        getControllers()\n\nOnce we've gotten all the controllers, we'll move on\n\n        .then (controllerObject) ->\n\nLet's load in the routes file\n\n            configuredRoutes = require '..\/config\/routes'\n\nLet's loop through the routes file and do the appropriate mapping.[1]\n            _.each configuredRoutes, (totalString, route) ->\n\n                \nRoutes are stored like METHOD \/route, so we'll split on spaces. To make this a bit more dev-friendly, let's get rid of redundant spaces and newlines.\n\n                [method, endpoint] = route\n                             .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                             .replace \/\\s\\s+\/g, ' '\n                             .trim()\n                             .split ' '\n\n-----------\n\nThis bigass thing here is for dev-friendliness.  I don't want to punish people for separating controller calls to multiple lines if they want, and I don't want punish them for adding multiple spaces.  Subsequently, I replace newlines with a  space, then replace extra spaces down to one space, trim it, and split on the @ sign so I can make the dichotomy between application logic and error-handling logic. Utilizing Coffee's \"multi-return\" thing, I can set the values pretty cleanly, but not before I make sure the values are trimmed.\n\n                [actionString, catchString] = totalString\n                                  .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                                  .replace \/\\s\\s+\/g, ' '\n                                  .trim()\n                                  .split '@'\n                                  .map (i) -> do i.trim\n-----------\n\n\nAgain, just make it cleaner, we'll utilize the \"multi-return\" thing coffeescript does. Since I don't want a hard requirement for a catch to exist, I will put a conditional to see if the catch is defined.\n\n                [catchController,catchFunction] = catchString.split '.' if catchString?\n\nIf we have a catch defined, awesome, else we'll just feed in an empty function.\n               \n                catcher = controllerObject[catchController]?[catchFunction] || ->\n\nSplit the routes on a space so as to separate individual action handlers.\n\n                allRoutes = actionString.split ' '\n\n-------\n\nLoop through all the actions that are provided for that route, look them up, return back the handles on the function. So as to save a \"push\" command we'll use a map\n\n                actionHandles = _.map allRoutes, (a) ->\n\nFirst we need to separate out the error handling stuff from the actual program, so let's split that out, and utilize the multi-return value feature of coffeescript.\n\n                    [actionStuff, errorStuff] = a.split '!'\n\nSince I don't want to make a hard requirement to provide an error-handler, let's put a put quick \"if\" at the end of this to make sure we have errorstuff to assign.\n\n                    [errorController, errorAction] = errorStuff.split '.' if errorStuff?\n\nLet's parse out the controller and action.\n\n                    [myController, myAction] = actionStuff.split '.'\n\n\nNow let's grab the appropriate stuff out of the controllers.\n\n                    finalAction =  controllerObject[myController][myAction]\n                    finalError = controllerObject[errorController]?[errorAction]\n                    \nSince everything is parsed out, let's just wrap this in an object so as to easily pipe into the promises.\n\n                    finalObject =\n                        action: finalAction\n                        error: finalError\n                        controllerName: myController\n                        actionName: myAction\n\nOnce everything is done, let's just return out of the map and move on. \n\n                    return finalObject\n\n\nThe `wrapper` function.\n-----------------------\n\nThis here is the glue that does the joining of the actual functions.  In a nutshell, when the request it made, it should run `wrapper`, which will loop through the functions that were returned by the previous map, and run them sequentially as part of the promise chain.  I would like to eventually add a mechanism in which to do this in parallel (instead of just sequentially) eventually. \n\n                wrapper = (req, res) ->\n\nWe need to make sure the user is allowed to use everything that this route has to offer.  Due to the beauty of Bluebird, if this this trips up, it'll just kill the promise chain and make it so that we don't go any farther than we're allowed to.\n\n                        authPromise = policies actionHandles, req, res\n\n\n\nOnce we've gotten all the handles on the functions we need to call, we can concat it to all previous promises. Afterwards we want these to run sequentially, so we use the reduce function to run them, then converge into a single, final promise.\n\n                        finalPromise =\n                            _.chain [authPromise]\n                            .flatten()\n                            .concat actionHandles\n                            .reduce (cur, next) ->\n                                cur.then next.action, next.error\n                            .value()\n\nEverything should be done.  We can finally render a template or return back JSON depending on what they did on that last function\n\n                        finalPromise.then (endData) ->\n\n\nWhat happens now is pretty simple.  A requirement for frameworkey is that you return an object with your data and the `renderType` property. From there it's pretty straightforward. \n\n                            if endData.renderType.toLowerCase() == 'html'\n                                # We used \"toLowerCase\" to make it more dev-friendly. \n                                res.render endData.page\n                            else if endData.renderType.toLowerCase() == 'json'\n                                res.send endData.data\n                                \nWe'll use the global catch defined at the end of the actions to handle residual errors.  If there's an issue, we go here. We can default to an empty function if there's an issue.\n\n                        finalPromise.catch catcher\n\n                            \nAs stated above, wrapper will return a new function based on what we send in for \"allRoutes\".  We're adding the \"toLowerCase()\" to make this a bit more dev-friendly.\n\n                app[do method.toLowerCase] endpoint, wrapper\n\n\n[1]: I *really* hate how the value comes before the key in Lodash\n","old_contents":"Routing\n=======\nThis file serves as the \"glue\" between the express router and sanity. Basically, we want a rails-esque routing system with all the routes declared in one location.  One advantage over rails, though, is that we're going to allow some degree of function composition in that we can declare multiple, reusable actions per-route, then let them pass the return value from one to the next.\n\nThis is done via unapologetic use of Promises. \n\n##Libraries\n    Promise = require 'bluebird'\n    fs = Promise.promisifyAll require 'fs'\n    _ = require 'lodash'\n\n##Local \n    getControllers = require '.\/getControllers'\n    policies = require '.\/policies'\n\n    module.exports = (app) ->\n        # This grabs the controllers and returns back a promise'd object of \n        # them. It made more sense to put this in a separate file, since it's\n        # arguably useful in its own right. \n        getControllers()\n\n        # Note, do this asynchronously. we'll load the controllers and policies\n        # simultaneously.   \n        .then (controllerObject) ->\n            console.log \"sdafsd\"\n\n            #Let's load in the routes file\n            configuredRoutes = require '..\/config\/routes'\n\n            # Let's loop through the routes file and do the appropriate mapping.\n            # NOTE: I really hate that the value comes before the key. \n            _.each configuredRoutes, (totalString, route) -> \n                # routes are stored like METHOD \/route, so we'll split on spaces.\n                # To make this a bit more dev-friendly, let's get rid of redundant \n                # spaces and newlines. \n                [method, endpoint] = route\n                             .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                             .replace \/\\s\\s+\/g, ' '\n                             .trim()\n                             .split ' '\n\n                # This bigass thing here is for dev-friendliness.  I don't want to punish people\n                # for separating controller calls to multiple lines if they want, and I don't want \n                # punish them for adding multiple spaces.  Subsequently, I replace newlines with a \n                # space, then replace extra spaces down to one space, trim it, and split on the @ \n                # sign so I can make the dichotomy between application logic and error-handling logic.\n                # Utilizing Coffee's \"multi-return\" thing, I can set the values pretty cleanly, \n                # but not before I make sure the values are trimmed. \n                [actionString, catchString] = totalString\n                                  .replace \/(?:\\r\\n|\\r|\\n)\/g, ' '\n                                  .replace \/\\s\\s+\/g, ' '\n                                  .trim()\n                                  .split '@'\n                                  .map (i) -> do i.trim\n\n                # Again, just make it cleaner, we'll utilize the \"multi-return\" thing coffeescript does. \n                # Since I don't want a hard requirement for a catch to exist, I will put a conditional to \n                # see if the catch is defined. \n                [catchController,catchFunction] = catchString.split '.' if catchString?\n\n                # If we have a catch defined, awesome, else we'll just feed in an empty function.             \n                catcher = controllerObject[catchController]?[catchFunction] || ->\n\n                # Split the routes on a space so as to separate individual action handlers.\n                allRoutes = actionString.split ' '\n\n                # Loop through all the actions that are provided for that route,\n                # look them up, return back the handles on the function.\n                #\n                # So as to save a \"push\" command we'll use a map\n                actionHandles = _.map allRoutes, (a) ->\n                    # First we need to separate out the error handling stuff from the\n                    # actual program, so let's split that out, and utilize the multi-return\n                    # value feature of coffeescript. \n                    [actionStuff, errorStuff] = a.split '!'\n\n                    # Since I don't want to make a hard requirement to provide an error-handler,\n                    # Let's put a put quick \"if\" at the end of this to make sure we have errorstuff\n                    # to assign. \n                    [errorController, errorAction] = errorStuff.split '.' if errorStuff?\n\n                    #Let's parse out the controller and action. \n                    [myController, myAction] = actionStuff.split '.'\n\n\n                    # Now let's grab the appropriate stuff out of the controllers. \n                    finalAction =  controllerObject[myController][myAction]\n                    finalError = controllerObject[errorController]?[errorAction]\n                    \n                    # Since everything is parsed out, let's just wrap this in an object \n                    # So as to easily pipe into the promises.\n                    finalObject =\n                        action: finalAction\n                        error: finalError\n                        controllerName: myController\n                        actionName: myAction\n                    return finalObject\n\n                wrapper = (req, res) ->\n\n                        # We need to make sure the user is allowed to use everything that\n                        # this route has to offer.  Due to the beauty of Bluebird, if\n                        # this this trips up, it'll just kill the promise chain and\n                        # make it so that we don't go any farther than we're allowed to.\n                        console.log \"blah\"\n                        authPromise = policies actionHandles, req, res\n\n\n\n                        # Once we've gotten all the handles on the functions we need\n                        # to call, we can concat it to all previous promises. Afterwards\n                        # we want these to run sequentially, so we use the reduce function\n                        # to run them, then converge into a single, final promise. \n                        finalPromise =\n                            _.chain [authPromise]\n                            .flatten()\n                            .concat actionHandles\n                            .reduce (cur, next) ->\n                                cur.then next.action, next.error\n                            .value()\n\n                        # Everything should be done.  We can finally render a template\n                        # or return back JSON depending on what they did on that last function\n                        finalPromise.then (endData) ->\n\n                            # If they want HTML, we'll give them HTML, gosh-darnit!\n                            #\n                            # We're using toLowerCase to make it a bit more dev-friendly\n                            # in case they want to write html as HTML for some reason\n                            if endData.renderType.toLowerCase() == 'html'\n                                # End the request by rendering the jade template\n                                res.render endData.page\n                                \n                            # If they're making an API, let them make an api. \n                            else if endData.renderType.toLowerCase() == 'json'\n                                # end the request by sending back a status JSON\n                                res.send endData.data\n                                \n                        # We'll use the global catch defined at the end of the actions\n                        # to handle residual errors.  If there's an issue, we go here.\n                        # We can default to an empty function if there's an issue. \n                        finalPromise.catch catcher\n\n                            \n                # As stated above, wrapper will return a new function based on what \n                # we send in for \"allRoutes\".  We're adding the \"toLowerCase()\" to make \n                # this a bit more dev-friendly.\n                console.log method\n                app[do method.toLowerCase] endpoint, wrapper\n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"d3fbb2072f33973134467057a1415802b2e5a4d4","subject":"added draw stub test","message":"added draw stub test\n","repos":"nhz-io\/cnl","old_file":"source\/test\/shape.litcoffee","new_file":"source\/test\/shape.litcoffee","new_contents":"# TEST CLASS: Shape\n* Parent: [Index][Parent]\n\n---\n\n    should = require 'should'\n    module.exports = (Shape, name='Shape') ->\n\n      describe name, ->\n        it 'should be a class', -> Shape.should.be.a.class\n\n---\n\n## CONSTRUCTOR\n\n        describe '#constructor(args)', ->\n          it 'should return an instance of Shape', ->\n            (new Shape).should.be.an.instanceof Shape\n\nConstructor should copy regions passed as named arguments into the instance\n\n          it 'should copy the regions to the instance', ->\n            shape = new Shape regions: (regions = test: (region = []))\n            shape.regions.test.should.be.equal region\n            shape.regions.should.not.be.equal regions\n\n---\n\n## METHODS\n\n        describe '#getEventRegions', ->\n          it 'should return the regions matching the event', ->\n            shape = new Shape regions: test: [0,0,10,10]\n            regions = shape.getEventRegions localX:5, localY:5\n            regions.should.have.property 'test'\n            regions.test[0].should.be.equal 0\n            regions.test[1].should.be.equal 0\n            regions.test[2].should.be.equal 10\n            regions.test[3].should.be.equal 10\n\n          it 'should return undefined if no regions match', ->\n            shape = new Shape regions: test: [0,0,10,10]\n            should(shape.getEventRegions localX:20, localY:20).not.be.ok\n\n        describe '#draw', ->\n          it 'should return the shape', ->\n            (shape = new Shape).draw().should.be.equal shape\n\n---\n\n## LISTENERS\n\nMousemove capturing listener should store the event in the runtime\nand localize the event coordinates.\n\n        describe '#mousemoveCaptureListener', ->\n          it 'should return the shape', ->\n            (shape = new Shape)\n              .mousemoveCaptureListener()\n              .should.be.equal shape\n\n---\n\nMousedown capturing listener should store the event in the runtime\nand localize the event coordinates.\n\n        describe '#mousedownCaptureListener', ->\n          it 'should return the shape', ->\n            (shape = new Shape)\n              .mousedownCaptureListener()\n              .should.be.equal shape\n\n---\n\nMouseup capturing listener should store the event in the runtime\nand localize the event coordinates.\n\n        describe '#mouseupCaptureListener', ->\n          it 'should return the shape', ->\n            (shape = new Shape)\n              .mouseupCaptureListener()\n              .should.be.equal shape\n\n\n[Shape#constructor]: ..\/shape.litcoffee#constructor\n[Parent]: .\/index.litcoffee\n","old_contents":"# TEST CLASS: Shape\n* Parent: [Index][Parent]\n\n---\n\n    should = require 'should'\n    module.exports = (Shape, name='Shape') ->\n\n      describe name, ->\n        it 'should be a class', -> Shape.should.be.a.class\n\n---\n\n## CONSTRUCTOR\n\n        describe '#constructor(args)', ->\n          it 'should return an instance of Shape', ->\n            (new Shape).should.be.an.instanceof Shape\n\nConstructor should copy regions passed as named arguments into the instance\n\n          it 'should copy the regions to the instance', ->\n            shape = new Shape regions: (regions = test: (region = []))\n            shape.regions.test.should.be.equal region\n            shape.regions.should.not.be.equal regions\n\n---\n\n## METHODS\n\n        describe '#getEventRegions', ->\n          it 'should return the regions matching the event', ->\n            shape = new Shape regions: test: [0,0,10,10]\n            regions = shape.getEventRegions localX:5, localY:5\n            regions.should.have.property 'test'\n            regions.test[0].should.be.equal 0\n            regions.test[1].should.be.equal 0\n            regions.test[2].should.be.equal 10\n            regions.test[3].should.be.equal 10\n\n          it 'should return undefined if no regions match', ->\n            shape = new Shape regions: test: [0,0,10,10]\n            should(shape.getEventRegions localX:20, localY:20).not.be.ok\n\n---\n\n## LISTENERS\n\nMousemove capturing listener should store the event in the runtime\nand localize the event coordinates.\n\n        describe '#mousemoveCaptureListener', ->\n          it 'should return the shape', ->\n            (shape = new Shape)\n              .mousemoveCaptureListener()\n              .should.be.equal shape\n\n---\n\nMousedown capturing listener should store the event in the runtime\nand localize the event coordinates.\n\n        describe '#mousedownCaptureListener', ->\n          it 'should return the shape', ->\n            (shape = new Shape)\n              .mousedownCaptureListener()\n              .should.be.equal shape\n\n---\n\nMouseup capturing listener should store the event in the runtime\nand localize the event coordinates.\n\n        describe '#mouseupCaptureListener', ->\n          it 'should return the shape', ->\n            (shape = new Shape)\n              .mouseupCaptureListener()\n              .should.be.equal shape\n\n\n[Shape#constructor]: ..\/shape.litcoffee#constructor\n[Parent]: .\/index.litcoffee\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3a6f7cac9483ff2bb0e9d00e3f9333baabd19b4a","subject":"Documention for encoders \"as\" option","message":"Documention for encoders \"as\" option\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with its raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will have the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"958ef6d2c0a6f0a846e3e0414e9d4f5e72545899","subject":"More logic programs","message":"More logic programs\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, \n\t\t\t\t  _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nFor convenience I'll add a couple of readily accessible logic variables:\n\n    F.$x = F.lvar(\"x\")\n    F.$y = F.lvar(\"y\")\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n                        find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return bindings\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        bindings = F.unify(_.first(t1), _.first(t2), bindings)\n        bindings = if (bindings isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else bindings\n        return bindings\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logic programs\n# --------------\n\nWe can build more complex goals using lambda-abstractions and previously defined combinators, `conj` and `disj`.  For example, we can define the function `choice` such that `choice(t1, array)` is a goal that succeeds if `t1` is an element of `array`.\n\n    F.choice = ($v, list) ->\n      return F.fail if _.isEmpty(list)\n\n      F.disj(F.goal($v, _.first(list)),\n                    F.choice($v, _.rest(list)))\n\nThe name `choice` should evoke [The Axiom of Choice](http:\/\/en.wikipedia.org\/wiki\/Axiom_of_choice), but I'll use a more common name:\n\n      F.membero = F.choice\n\nNow I can write a very primitive program: find an element that is common in two lists:\n\n    F.commono = (l, r) ->\n      $x = F.lvar(\"x\")\n      F.conj(F.choice($x, l),\n             F.choice($x, r))\n\n    F.conso = ($a, $b, list) -> F.goal(_.cons($a, $b), list)\n\n    F.joino = ($a, $b, list) -> F.goal([$a, $b], list)\n\n\nTODO - more examples\n\n# Exports and sundries\n# --------------------\n\n\t  if module?\n\t    module.exports = F\n\t  else\n\t    root.F = F\n\n\t)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, \n\t\t\t\t  _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nFor convenience I'll add a couple of readily accessible logic variables:\n\n    F.$x = F.lvar(\"x\")\n    F.$y = F.lvar(\"y\")\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n                        find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return bindings\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        bindings = F.unify(_.first(t1), _.first(t2), bindings)\n        bindings = if (bindings isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else bindings\n        return bindings\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logic programs\n# --------------\n\nWe can build more complex goals using lambda-abstractions and previously defined combinators, `conj` and `disj`.  For example, we can define the function `choice` such that `choice(t1, array)` is a goal that succeeds if `t1` is an element of `array`.\n\n    F.choice = ($v, list) ->\n      return F.fail if _.isEmpty(list)\n\n      F.disj(F.goal($v, _.first(list)),\n                    F.choice($v, _.rest(list)))\n\nTODO - examples\n\nThe name `choice` should evoke [The Axiom of Choice](http:\/\/en.wikipedia.org\/wiki\/Axiom_of_choice)...\n\nNow I can write a very primitive program: find an element that is common in two lists:\n\n    F.commono = (l, r) ->\n      $x = F.lvar(\"x\")\n      F.conj(F.choice($x, l),\n             F.choice($x, r))\n\nTODO - examples\n\n# Exports and sundries\n# --------------------\n\n\t  if module?\n\t    module.exports = F\n\t  else\n\t    root.F = F\n\n\t)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ca706b83ce86554d3997af7ca82ec1b5f235fe5c","subject":"specify use of some of View's attributes","message":"specify use of some of View's attributes\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/13_view.litcoffee","new_file":"docs\/13_view.litcoffee","new_contents":"# Batman.View\n\nFor a general explanation of `Batman.View` and how it works, see [the guide](\/docs\/views.html).\n\n\n## ::constructor(options = {})\n\nA `View` is a `Batman.Object`, so any options you pass are mixed in. Use this\nto set `html`, `node`, `superview`, `parentNode` and\/or your custom data.\n\n    test 'constructor mixes in options', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'constructor automatically adds to the superview if supplied', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      equal 1, superview.subviews.length\n\n\n## ::lookupKeypath(keypath) : Object\n\nTraverses up the view tree searching for the specified keypath, and returns the\nresult. This is equivalent to performing a `Batman.get` for each view above\n`this` in the tree, until a defined result is returned. The path it takes is as\nfollows:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\nIf there is no match, `undefined` is returned. However, if used in an accessor\nor binding, the entire path to the root will be registered as a potential\nsource of data. Consequently, if the keypath is later set on any part of the\nchain, the data will be correctly bound.\n\n`lookupKeypath` is the function invoked to locate data when evaluating a\nbinding.\n\n    test 'lookupKeypath returns the value if defined on the view', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.lookupKeypath('animal')\n\n    test 'lookupKeypath returns the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'cat')\n      subview = new Batman.View(superview: superview)\n      equal 'cat', subview.lookupKeypath('animal')\n\n\n## ::setKeypath(keypath, value) : Object\n\nTraverses the View tree searching for the specified keypath, and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is the function invoked to set data when using an input binding.\n\n    test 'setKeypath sets the value if defined on the view', ->\n      view = new Batman.View(animal: 'dog')\n\n      view.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'setKeypath sets the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'dog')\n      subview = new Batman.View(superview: superview)\n\n      subview.setKeypath('animal', 'cat')\n      equal 'cat', superview.get('animal')\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n\n## ::%node : Node\n\nA reference to the DOM node that this view encapsulates. The entire tree\nbeneath this node is also the responsibility of this view and\/or its subviews.\n\nAccessing `node` will load and parse the template on demand if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\nYou can also access a view's `node` in its methods, for example, activating jQuery plugins:\n\n```\nclass App.SearchBarView extends Batman.View\n  viewDidAppear: ->\n    $node = $(@get('node'))\n    $node.typeahead() # <= whatever jQuery plugin you want!\n```\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview. You can specify a view's HTML when you define the class:\n\n```\nclass App.SearchBarView extends Batman.View\n  html: \"<input type='text' placeholder='Enter a search term' \/>\"\n```\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n    test 'setting a source loads the correct template', ->\n      Batman.View.store.set('\/animals', '<div>cat<\/div>')\n      view = new Batman.View(source: '\/animals')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n## ::.superview : Batman.View\n\nA reference to the current superview (the direct ancestor in the tree). This is\nused for traversing the tree when searching for data, as in\n`View::lookupKeypath`.\n\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of a `View`. To manipulate the view tree, you should\noperate directly on this set \u2014 batman.js will automatically keep the DOM in\nsync with the logical tree.\n\n\n## ::subviews.add(view)\n\nAdding to a view's subview set will automatically update the tree, and parse\nthe template and bindings. If the superview is already in the DOM, this will\ninsert the current view's node into the DOM.\n\n    test 'adding to a superview parses bindings', ->\n      superview = new Batman.View()\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      superview.subviews.add(view)\n      equal 'cat', view.get('node').firstChild.innerHTML\n\n\n## ::subviews.remove(view)\n\nRemoving from a view's subview set will automatically remove the subview from\nthe DOM.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View(html: '', parentNode: document.body)\n      superview.get('node')\n      view = new Batman.View(html: '', superview: superview)\n\n      ok Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n      superview.subviews.remove(view)\n      ok not Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent, without killing it.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.removeFromSuperview()\n      ok not superview.subviews.has(view)\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n    test 'die kills the view', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.die()\n      equal true, view.isDead\n      equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n    test 'destroySubviews kills all subviews', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: superview)\n\n      superview.destroySubviews()\n      ok one.isDead\n      ok two.isDead\n\n\n## ::propagateToSubviews(eventOrKey : string, value : Object)\n\nIf `value` is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n    test 'propagateToSubviews propagates events', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.on 'eventName', superSpy = createSpy()\n      one.on 'eventName', oneSpy = createSpy()\n      two.on 'eventName', twoSpy = createSpy()\n\n      superview.propagateToSubviews('eventName')\n\n      equal 1, superSpy.callCount\n      equal 1, oneSpy.callCount\n      equal 1, twoSpy.callCount\n\n    test 'propagateToSubviews propagates keys', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.propagateToSubviews('key', 'value')\n\n      equal superview.get('key'), 'value'\n      equal one.get('key'), 'value'\n      equal two.get('key'), 'value'\n\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n\n\n## ::filter(label : string, filter : function)\n\nDefines a filter on the `View` class for use within the `View` during rendering.\n","old_contents":"# Batman.View\n\nFor a general explanation of `Batman.View` and how it works, see [the guide](\/docs\/views.html).\n\n\n## ::constructor(options = {})\n\nA `View` is a `Batman.Object`, so any options you pass are mixed in. Use this\nto set `html`, `node`, `superview`, `parentNode` and\/or your custom data.\n\n    test 'constructor mixes in options', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'constructor automatically adds to the superview if supplied', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      equal 1, superview.subviews.length\n\n\n## ::lookupKeypath(keypath) : Object\n\nTraverses up the view tree searching for the specified keypath, and returns the\nresult. This is equivalent to performing a `Batman.get` for each view above\n`this` in the tree, until a defined result is returned. The path it takes is as\nfollows:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\nIf there is no match, `undefined` is returned. However, if used in an accessor\nor binding, the entire path to the root will be registered as a potential\nsource of data. Consequently, if the keypath is later set on any part of the\nchain, the data will be correctly bound.\n\n`lookupKeypath` is the function invoked to locate data when evaluating a\nbinding.\n\n    test 'lookupKeypath returns the value if defined on the view', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.lookupKeypath('animal')\n\n    test 'lookupKeypath returns the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'cat')\n      subview = new Batman.View(superview: superview)\n      equal 'cat', subview.lookupKeypath('animal')\n\n\n## ::setKeypath(keypath, value) : Object\n\nTraverses the View tree searching for the specified keypath, and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is the function invoked to set data when using an input binding.\n\n    test 'setKeypath sets the value if defined on the view', ->\n      view = new Batman.View(animal: 'dog')\n\n      view.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'setKeypath sets the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'dog')\n      subview = new Batman.View(superview: superview)\n\n      subview.setKeypath('animal', 'cat')\n      equal 'cat', superview.get('animal')\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n\n## ::%node : Node\n\nA reference to the DOM node that this view encapsulates. The entire tree\nbeneath this node is also the responsibility of this view and\/or its subviews.\n\nAccessing `node` will load and parse the template on demand if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview.\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n    test 'setting a source loads the correct template', ->\n      Batman.View.store.set('\/animals', '<div>cat<\/div>')\n      view = new Batman.View(source: '\/animals')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n## ::.superview : Batman.View\n\nA reference to the current superview (the direct ancestor in the tree). This is\nused for traversing the tree when searching for data, as in\n`View::lookupKeypath`.\n\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of a `View`. To manipulate the view tree, you should\noperate directly on this set \u2014 batman.js will automatically keep the DOM in\nsync with the logical tree.\n\n\n## ::subviews.add(view)\n\nAdding to a view's subview set will automatically update the tree, and parse\nthe template and bindings. If the superview is already in the DOM, this will\ninsert the current view's node into the DOM.\n\n    test 'adding to a superview parses bindings', ->\n      superview = new Batman.View()\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      superview.subviews.add(view)\n      equal 'cat', view.get('node').firstChild.innerHTML\n\n\n## ::subviews.remove(view)\n\nRemoving from a view's subview set will automatically remove the subview from\nthe DOM.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View(html: '', parentNode: document.body)\n      superview.get('node')\n      view = new Batman.View(html: '', superview: superview)\n\n      ok Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n      superview.subviews.remove(view)\n      ok not Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent, without killing it.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.removeFromSuperview()\n      ok not superview.subviews.has(view)\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n    test 'die kills the view', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.die()\n      equal true, view.isDead\n      equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n    test 'destroySubviews kills all subviews', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: superview)\n\n      superview.destroySubviews()\n      ok one.isDead\n      ok two.isDead\n\n\n## ::propagateToSubviews(eventOrKey : string, value : Object)\n\nIf `value` is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n    test 'propagateToSubviews propagates events', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.on 'eventName', superSpy = createSpy()\n      one.on 'eventName', oneSpy = createSpy()\n      two.on 'eventName', twoSpy = createSpy()\n\n      superview.propagateToSubviews('eventName')\n\n      equal 1, superSpy.callCount\n      equal 1, oneSpy.callCount\n      equal 1, twoSpy.callCount\n\n    test 'propagateToSubviews propagates keys', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.propagateToSubviews('key', 'value')\n\n      equal superview.get('key'), 'value'\n      equal one.get('key'), 'value'\n      equal two.get('key'), 'value'\n\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n\n\n## ::filter(label : string, filter : function)\n\nDefines a filter on the `View` class for use within the `View` during rendering.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f3be0f3080ed2fd97ac24b7cc95dc67780a8ec7e","subject":"Modified output directories.","message":"Modified output directories.\n","repos":"monokrome\/glp","old_file":"src\/defaults.litcoffee","new_file":"src\/defaults.litcoffee","new_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How GLP configuration works\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp,watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is false by default, but can be made true if caching\nhappens to be working as expected with your project. This feature is disabled\nby default because it is still experimental.\n\n        enabled: no\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nWe'll also want source maps, so let's enabled those.\n\n        coffee:\n          sourceMap: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nSome more default formats are provided here:\n\n          iced: {}\n\n          typescript:\n            matches: '**\/*.ts'\n\n          livescript:\n            matches: '**\/*.ls'\n\n          handlebars:\n            matches: '**\/*.hbs'\n\n          coco:\n            matches: '**\/*.co'\n\n          eco:\n            matches: '**\/*.eco'\n\n          dust:\n            matches: ['**\/*.djs', '**\/*.dust']\n\n          nunjucks:\n            matches: ['**\/*.njs', '**\/*.nunjucks']\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\nSome more default formats are provided here:\n\n          haml: {}\n          ejs: {}\n          mustache: {}\n\n          markdown:\n            matches: ['**\/*.md', '**\/*.markdown']\n\n          template:\n            matches: '**\/*.tpl'\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js`, `.coffee` and a few\nother extensions. After they are built, the resulting files will be placed in\nthe directory specified by the **root** function as separate files. If the\noutput file was not a **directory** (as denoted by the ending slash) then the\nfiles would also be concatenated and the resulting file would be given the\n*extension* which corresponds to this type of file.\n\n          '\/scripts\/': [\n            'src\/scripts\/**\/*.js'\n            'src\/scripts\/**\/*.coffee'\n            'src\/scripts\/**\/*.iced'\n            'src\/scripts\/**\/*.co'\n            'src\/scripts\/**\/*.ls'\n            'src\/scripts\/**\/*.ts'\n            'src\/scripts\/**\/*.hbs'\n            'src\/scripts\/**\/*.eco'\n            'src\/scripts\/**\/*.djs'\n            'src\/scripts\/**\/*.dust'\n            'src\/scripts\/**\/*.njs'\n            'src\/scripts\/**\/*.nunjucks'\n          ]\n\nHere, we are doing the same thing for *html*, *jade*, and some other file\nextensions. This time we are outputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/templates\/**\/*.html'\n            'src\/templates\/**\/*.jade'\n            'src\/templates\/**\/*.md'\n            'src\/templates\/**\/*.markdown'\n            'src\/templates\/**\/*.haml'\n            'src\/templates\/**\/*.ejs'\n            'src\/templates\/**\/*.mustache'\n            'src\/templates\/**\/*.tpl'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/stylesheets\/': [\n            'src\/stylesheets\/**\/*.css'\n            'src\/stylesheets\/**\/*.less'\n            'src\/stylesheets\/**\/*.sass'\n            'src\/stylesheets\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            coffee:\n              sourceMap: no\n\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","old_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How GLP configuration works\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp,watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is false by default, but can be made true if caching\nhappens to be working as expected with your project. This feature is disabled\nby default because it is still experimental.\n\n        enabled: no\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nWe'll also want source maps, so let's enabled those.\n\n        coffee:\n          sourceMap: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nSome more default formats are provided here:\n\n          iced: {}\n\n          typescript:\n            matches: '**\/*.ts'\n\n          livescript:\n            matches: '**\/*.ls'\n\n          handlebars:\n            matches: '**\/*.hbs'\n\n          coco:\n            matches: '**\/*.co'\n\n          eco:\n            matches: '**\/*.eco'\n\n          dust:\n            matches: ['**\/*.djs', '**\/*.dust']\n\n          nunjucks:\n            matches: ['**\/*.njs', '**\/*.nunjucks']\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\nSome more default formats are provided here:\n\n          haml: {}\n          ejs: {}\n          mustache: {}\n\n          markdown:\n            matches: ['**\/*.md', '**\/*.markdown']\n\n          template:\n            matches: '**\/*.tpl'\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js`, `.coffee` and a few\nother extensions. After they are built, the resulting files will be placed in\nthe directory specified by the **root** function as separate files. If the\noutput file was not a **directory** (as denoted by the ending slash) then the\nfiles would also be concatenated and the resulting file would be given the\n*extension* which corresponds to this type of file.\n\n          '\/': [\n            'src\/scripts\/**\/*.js'\n            'src\/scripts\/**\/*.coffee'\n            'src\/scripts\/**\/*.iced'\n            'src\/scripts\/**\/*.co'\n            'src\/scripts\/**\/*.ls'\n            'src\/scripts\/**\/*.ts'\n            'src\/scripts\/**\/*.hbs'\n            'src\/scripts\/**\/*.eco'\n            'src\/scripts\/**\/*.djs'\n            'src\/scripts\/**\/*.dust'\n            'src\/scripts\/**\/*.njs'\n            'src\/scripts\/**\/*.nunjucks'\n          ]\n\nHere, we are doing the same thing for *html*, *jade*, and some other file\nextensions. This time we are outputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/templates\/**\/*.html'\n            'src\/templates\/**\/*.jade'\n            'src\/templates\/**\/*.md'\n            'src\/templates\/**\/*.markdown'\n            'src\/templates\/**\/*.haml'\n            'src\/templates\/**\/*.ejs'\n            'src\/templates\/**\/*.mustache'\n            'src\/templates\/**\/*.tpl'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/': [\n            'src\/stylesheets\/**\/*.css'\n            'src\/stylesheets\/**\/*.less'\n            'src\/stylesheets\/**\/*.sass'\n            'src\/stylesheets\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            coffee:\n              sourceMap: no\n\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f99bd1b6e3abbe433118286f81232736b60ee7e0","subject":"A few changes to PngRenderer.flush","message":"A few changes to PngRenderer.flush\n\n1. Renamed `level` to `level_name` for clarity\n2. Stop messing with `@config.grid` - Png renderers don't create or\n   modify data anymore\n3. Reset renderer by calling `@initialize_drawing_context` when rendering\n   is complete\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_renderer.litcoffee","new_file":"lib\/render-pipelines\/png\/png_renderer.litcoffee","new_contents":"    Module = require '..\/..\/module'\n    q      = require 'q'\n\n    class PngRenderer extends Module\n      deps: [ 'fs', 'canvas', 'path', 'config' ]\n      pub:  [ 'render', 'flush' ]\n\n      @draw_to: undefined\n      @ctx:     undefined\n\n      initialize: (params) =>\n        deferred = q.defer()\n\n        super()\n          .then =>\n            @initialize_drawing_context()\n\n            deferred.resolve @\n\n        deferred.promise\n\n      initialize_drawing_context: =>\n        width  = @config.width  * @config.grid[0].length\n        height = @config.height * @config.grid.length\n\n        PngRenderer.draw_to = new @canvas width, height\n        PngRenderer.ctx     = PngRenderer.draw_to.getContext '2d'\n\n      render: (path, level_name) =>\n        location = @path.join __dirname, '..', '..', '..', 'output', \"#{level_name}.json\"\n        @fs.readFile location, 'utf8', (err, data) =>\n          @done @do_render PngRenderer.ctx, JSON.parse data\n\n      flush: (level_name) =>\n        stream = @fs.createWriteStream @path.join __dirname, '..', '..', '..', 'output', \"#{level_name}.png\"\n\n        stream.on 'finish', =>\n          @initialize_drawing_context()\n          @done 'Persisted', location: level_name\n\n        PngRenderer.draw_to.createPNGStream().pipe stream\n\n    module.exports = PngRenderer\n","old_contents":"    Module = require '..\/..\/module'\n    q      = require 'q'\n\n    class PngRenderer extends Module\n      deps: [ 'fs', 'canvas', 'path', 'config' ]\n      pub:  [ 'render', 'flush' ]\n\n      @draw_to: undefined\n      @ctx:     undefined\n\n      initialize: (params) =>\n        deferred = q.defer()\n\n        super()\n          .then =>\n            @initialize_drawing_context()\n\n            deferred.resolve @\n\n        deferred.promise\n\n      initialize_drawing_context: =>\n        width  = @config.width  * @config.grid[0].length\n        height = @config.height * @config.grid.length\n\n        PngRenderer.draw_to = new @canvas width, height\n        PngRenderer.ctx     = PngRenderer.draw_to.getContext '2d'\n\n      render: (path, level_name) =>\n        location = @path.join __dirname, '..', '..', '..', 'output', \"#{level_name}.json\"\n        @fs.readFile location, 'utf8', (err, data) =>\n          @done @do_render PngRenderer.ctx, JSON.parse data\n\n      flush: (level) =>\n        stream = @fs.createWriteStream @path.join __dirname, '..', '..', '..', 'output', \"#{level}.png\"\n\n        for row, r in @config.grid\n          for cell, c in @config.grid[r]\n            @config.grid[r][c] = false\n\n        stream.on 'finish', => @done 'Persisted', location: level\n\n        PngRenderer.draw_to.createPNGStream().pipe stream\n\n    module.exports = PngRenderer\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ebef0c69aca1cf13b29ea0dd034aa609be60f05c","subject":"Update API keys","message":"Update API keys\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n    if process.env.SENTRY_DNS\n      app.use raven.middleware.express process.env.SENTRY_DNS\n      raven.patchGlobal process.env.SENTRY_DNS\n\n### Error handling\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n### API keys\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'NRK'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone about the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        when 'PUT'  then collection.put req, res, next\n        when 'PATCH' then collection.patch req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then document.options req, res, next\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n    if process.env.SENTRY_DNS\n      app.use raven.middleware.express process.env.SENTRY_DNS\n      raven.patchGlobal process.env.SENTRY_DNS\n\n### Error handling\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n### API keys\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'DNT'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone about the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        when 'PUT'  then collection.put req, res, next\n        when 'PATCH' then collection.patch req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then document.options req, res, next\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"63d0d8b064da3e3fd163d128882c3d1e06eb5696","subject":"Added a little comment about conso.  Need to make a distinction between JS _.cons and Scheme cons","message":"Added a little comment about conso.  Need to make a distinction between JS _.cons and Scheme cons\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, \n\t\t\t\t  _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nFor convenience I'll add a couple of readily accessible logic variables:\n\n    F.$x = F.lvar(\"x\")\n    F.$y = F.lvar(\"y\")\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n                        find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return bindings\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        bindings = F.unify(_.first(t1), _.first(t2), bindings)\n        bindings = if (bindings isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else bindings\n        return bindings\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logic programs\n# --------------\n\nWe can build more complex goals using lambda-abstractions and previously defined combinators, `conj` and `disj`.  For example, we can define the function `choice` such that `choice(t1, array)` is a goal that succeeds if `t1` is an element of `array`.\n\n    F.choice = ($v, list) ->\n      return F.fail if _.isEmpty(list)\n\n      F.disj(F.goal($v, _.first(list)),\n                    F.choice($v, _.rest(list)))\n\nThe name `choice` should evoke [The Axiom of Choice](http:\/\/en.wikipedia.org\/wiki\/Axiom_of_choice), but I'll use a more common name:\n\n      F.membero = F.choice\n\nNow I can write a very primitive program: find an element that is common in two lists:\n\n    F.commono = (l, r) ->\n      $x = F.lvar(\"x\")\n      F.conj(F.choice($x, l),\n             F.choice($x, r))\n\nNow for something a little different.\n\n    F.conso = ($a, $b, list) -> F.goal(_.cons($a, $b), list)\n\n`conso` is a goal that succeeds if in the current state of the world, `_.cons($a, $b)` is the same as `l`.  That may, at first, sound like the meaning of cons. However, the declarative formulation is more powerful, because `$a`, `$b`, or `l` might be logic variables.\n\n    F.joino = ($a, $b, list) -> F.goal([$a, $b], list)\n\n\nTODO - more examples\n\n# Exports and sundries\n# --------------------\n\n\t  if module?\n\t    module.exports = F\n\t  else\n\t    root.F = F\n\n\t)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, \n\t\t\t\t  _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nFor convenience I'll add a couple of readily accessible logic variables:\n\n    F.$x = F.lvar(\"x\")\n    F.$y = F.lvar(\"y\")\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n                        find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return bindings\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        bindings = F.unify(_.first(t1), _.first(t2), bindings)\n        bindings = if (bindings isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else bindings\n        return bindings\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logic programs\n# --------------\n\nWe can build more complex goals using lambda-abstractions and previously defined combinators, `conj` and `disj`.  For example, we can define the function `choice` such that `choice(t1, array)` is a goal that succeeds if `t1` is an element of `array`.\n\n    F.choice = ($v, list) ->\n      return F.fail if _.isEmpty(list)\n\n      F.disj(F.goal($v, _.first(list)),\n                    F.choice($v, _.rest(list)))\n\nThe name `choice` should evoke [The Axiom of Choice](http:\/\/en.wikipedia.org\/wiki\/Axiom_of_choice), but I'll use a more common name:\n\n      F.membero = F.choice\n\nNow I can write a very primitive program: find an element that is common in two lists:\n\n    F.commono = (l, r) ->\n      $x = F.lvar(\"x\")\n      F.conj(F.choice($x, l),\n             F.choice($x, r))\n\n    F.conso = ($a, $b, list) -> F.goal(_.cons($a, $b), list)\n\n    F.joino = ($a, $b, list) -> F.goal([$a, $b], list)\n\n\nTODO - more examples\n\n# Exports and sundries\n# --------------------\n\n\t  if module?\n\t    module.exports = F\n\t  else\n\t    root.F = F\n\n\t)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0068a035e0bbe8f0556b3941f71154ce60b66479","subject":"Move coco to fit docs.","message":"Move coco to fit docs.\n","repos":"monokrome\/glp","old_file":"src\/defaults.litcoffee","new_file":"src\/defaults.litcoffee","new_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How GLP configuration works\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp,watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is false by default, but can be made true if caching\nhappens to be working as expected with your project. This feature is disabled\nby default because it is still experimental.\n\n        enabled: no\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nWe'll also want source maps, so let's enabled those.\n\n        coffee:\n          sourceMap: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nSome more default formats are provided here:\n\n          handlebars:\n            matches: '**\/*.hbs'\n\n          coco:\n            matches: '**\/*.co'\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\nSome more default formats are provided here:\n\n          haml: {}\n          ejs: {}\n          mustache: {}\n\n          markdown:\n            matches: ['**\/*.md', '**\/*.markdown']\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js`, `.coffee` and a few\nother extensions. After they are built, the resulting files will be placed in\nthe directory specified by the **root** function as separate files. If the\noutput file was not a **directory** (as denoted by the ending slash) then the\nfiles would also be concatenated and the resulting file would be given the\n*extension* which corresponds to this type of file.\n\n          '\/': [\n            'src\/**\/*.js'\n            'src\/**\/*.coffee'\n            'src\/**\/*.co'\n            'src\/**\/*.hbs'\n          ]\n\nHere, we are doing the same thing for *html*, *jade*, and some other file\nextensions. This time we are outputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/**\/*.html'\n            'src\/**\/*.jade'\n            'src\/**\/*.md'\n            'src\/**\/*.markdown'\n            'src\/**\/*.haml'\n            'src\/**\/*.ejs'\n            'src\/**\/*.mustache'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/': [\n            'src\/**\/*.css'\n            'src\/**\/*.less'\n            'src\/**\/*.sass'\n            'src\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            coffee:\n              sourceMap: no\n\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","old_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How GLP configuration works\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp,watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is false by default, but can be made true if caching\nhappens to be working as expected with your project. This feature is disabled\nby default because it is still experimental.\n\n        enabled: no\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nWe'll also want source maps, so let's enabled those.\n\n        coffee:\n          sourceMap: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n          coco:\n            matches: '**\/*.co'\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nSome more default formats are provided here:\n\n          handlebars:\n            matches: '**\/*.hbs'\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\nSome more default formats are provided here:\n\n          haml: {}\n          ejs: {}\n          mustache: {}\n\n          markdown:\n            matches: ['**\/*.md', '**\/*.markdown']\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js`, `.coffee` and a few\nother extensions. After they are built, the resulting files will be placed in\nthe directory specified by the **root** function as separate files. If the\noutput file was not a **directory** (as denoted by the ending slash) then the\nfiles would also be concatenated and the resulting file would be given the\n*extension* which corresponds to this type of file.\n\n          '\/': [\n            'src\/**\/*.js'\n            'src\/**\/*.coffee'\n            'src\/**\/*.co'\n            'src\/**\/*.hbs'\n          ]\n\nHere, we are doing the same thing for *html*, *jade*, and some other file\nextensions. This time we are outputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/**\/*.html'\n            'src\/**\/*.jade'\n            'src\/**\/*.md'\n            'src\/**\/*.markdown'\n            'src\/**\/*.haml'\n            'src\/**\/*.ejs'\n            'src\/**\/*.mustache'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/': [\n            'src\/**\/*.css'\n            'src\/**\/*.less'\n            'src\/**\/*.sass'\n            'src\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            coffee:\n              sourceMap: no\n\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1a36414fe7fdda20af2841eb494e0447bec37242","subject":"ensure that changed state is preserved across multiple set\/merge operations on a property before commit even if new value is same as previous value","message":"ensure that changed state is preserved across multiple set\/merge operations on a property before commit even if new value is same as previous value\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    Yang     = require '.\/yang'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (spec={}) ->\n        # NOTE: ES6\/CS2 does not support below\n        # unless this instanceof Property then return new Property arguments...\n\n        # 1. parse if spec is YANG definition (string)\n        spec = Yang.parse spec if typeof spec is 'string'\n        \n        # 2. assign if spec is an instance of Yang schema\n        schema = spec if spec instanceof Yang\n        \n        # 3. destructure spec as an object if not schema as instance\n        { name, schema } = spec unless schema?\n        \n        # 4. parse if schema is YANG definition (string)\n        schema = Yang.parse schema if typeof schema is 'string'\n        schema ?= kind: 'anydata'\n\n        # 5. initialize property instance\n        @name = name ? schema.datakey\n        @schema = schema\n        @state = \n          parent:    null\n          strict:    false\n          private:   false\n          mutable:   `schema.config != false`\n          attached:  false\n          changed:   false\n          prior:     undefined\n          value:     undefined\n\n        # 6. soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'parent'\n        .access 'strict'\n        .getter 'private'\n        .getter 'mutable'\n        .getter 'attached'\n        .getter 'changed'\n        .getter 'prior'\n        .getter 'value'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'value',\n        get: -> @state.value\n\n      @property 'data',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> switch\n          when @binding?.get? then @binding.get @context\n          else @value\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @data\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.opts = {}\n          ctx.node = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor this\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      debug: -> debug @uri, arguments...\n      \n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@data`.\n\nIt also provides special handling based on different types of\n`@data` currently held.\n\n      get: (key) -> switch\n        when key?\n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].data\n            when match.length > 1  then match.map (x) -> x.data\n            else undefined\n        else @data\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        opts.origin ?= this\n        \n        # @debug \"[set] enter...\"\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n\n        if not opts.force and @binding?.set?\n          try value = @binding.set @context.with(opts), value \n          catch e\n            throw @error \"failed executing set() binding: #{e.message}\", e\n\n        return this if value? and @equals value, @value # return if same value\n        \n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        @debug \"[set] applying schema...\"        \n        value = switch\n          when @schema.apply? and not bypass\n            subopts = Object.assign {}, opts, inner: true, suppress: true\n            @schema.apply value, this, subopts\n          else value\n        @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error\n        return this if value? and @equals value, @value # return if same value\n        @update value, opts\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@value` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if value is null\n        return @set value, opts\n\n### delete\n\n      delete: (opts={}) ->\n        opts.origin ?= this\n        return this if @state.value is null\n        if not opts.force and @binding?.delete?\n          try @binding.delete @context.with(opts), null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @update null, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n        @state.prior ?= @state.value\n        @state.changed = @state.changed or (@state.value isnt value)\n        @state.value = value\n        @parent?.update this, opts # unless opts.suppress\n        return this\n\n### commit async transaction\n\nCommits the changes to the data model. Called *once* for each node that\nis part of the change branch.\n\n      commit: (opts={}) ->\n        opts.origin ?= this\n        return true unless @changed\n        try\n          unless opts.sync\n            # 1. perform save binding\n            @debug \"[commit] execute binding...\"\n            await @binding?.commit? @context.with(opts)\n            # 2. if has parent, then wait for parent commited before updating changed state\n            promise = @parent?.commit? opts\n              .then (ok) =>\n                @state.changed = false if ok\n          unless promise?\n            @state.changed = false\n        catch err\n          @debug \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          throw @error err\n        return true\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @delete opts unless @state.prior?\n        @state.value = @state.prior\n\n        @debug \"[revert] execute binding...\"\n        try await @binding?.commit? @context.with(opts) unless opts.sync\n        catch err\n          @debug \"[revert] failed due to #{err.message}\"\n          throw @error err\n          \n        @state.changed = false\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        unless @attached\n          # @debug \"[attach] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n\n          @set obj[name], Object.assign {}, opts, inner: true, suppress: true\n\n        unless opts.preserve\n          try Object.defineProperty obj, @name,\n              configurable: true\n              enumerable: @enumerable\n              get: (args...) => @get args...\n              set: (args...) => @set args...\n            \n        @state.attached = true\n        @debug \"[attach] attached into #{obj.constructor.name} container\"\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @data = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx) ->\n        err = new Error err unless err instanceof Error\n        err.uri ?= @uri\n        err.src ?= this\n        err.ctx ?= ctx\n        return err\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @data\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:    @name\n          kind:    @kind\n          path:    @path.toString()\n          active:  @active\n          private: @private\n          mutable: @mutable\n          changed: @changed\n          schema: switch\n            when @schema.uri?\n              uri:      @schema.uri\n              summary:  @schema.description?.tag\n              datakey:  @schema.datakey\n              datapath: @schema.datapath\n              external: @schema.external\n              children: @schema.children.map (x) -> x.uri\n            else false\n          value: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    Yang     = require '.\/yang'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (spec={}) ->\n        # NOTE: ES6\/CS2 does not support below\n        # unless this instanceof Property then return new Property arguments...\n\n        # 1. parse if spec is YANG definition (string)\n        spec = Yang.parse spec if typeof spec is 'string'\n        \n        # 2. assign if spec is an instance of Yang schema\n        schema = spec if spec instanceof Yang\n        \n        # 3. destructure spec as an object if not schema as instance\n        { name, schema } = spec unless schema?\n        \n        # 4. parse if schema is YANG definition (string)\n        schema = Yang.parse schema if typeof schema is 'string'\n        schema ?= kind: 'anydata'\n\n        # 5. initialize property instance\n        @name = name ? schema.datakey\n        @schema = schema\n        @state = \n          parent:    null\n          strict:    false\n          private:   false\n          mutable:   `schema.config != false`\n          attached:  false\n          changed:   false\n          prior:     undefined\n          value:     undefined\n\n        # 6. soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'parent'\n        .access 'strict'\n        .getter 'private'\n        .getter 'mutable'\n        .getter 'attached'\n        .getter 'changed'\n        .getter 'prior'\n        .getter 'value'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'value',\n        get: -> @state.value\n\n      @property 'data',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> switch\n          when @binding?.get? then @binding.get @context\n          else @value\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @data\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.opts = {}\n          ctx.node = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor this\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      debug: -> debug @uri, arguments...\n      \n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@data`.\n\nIt also provides special handling based on different types of\n`@data` currently held.\n\n      get: (key) -> switch\n        when key?\n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].data\n            when match.length > 1  then match.map (x) -> x.data\n            else undefined\n        else @data\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        opts.origin ?= this\n        \n        # @debug \"[set] enter...\"\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n\n        if not opts.force and @binding?.set?\n          try value = @binding.set @context.with(opts), value \n          catch e\n            throw @error \"failed executing set() binding: #{e.message}\", e\n\n        return this if value? and @equals value, @value # return if same value\n        \n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        @debug \"[set] applying schema...\"        \n        value = switch\n          when @schema.apply? and not bypass\n            subopts = Object.assign {}, opts, inner: true, suppress: true\n            @schema.apply value, this, subopts\n          else value\n        @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error\n        return this if value? and @equals value, @value # return if same value\n        @update value, opts\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@value` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if value is null\n        return @set value, opts\n\n### delete\n\n      delete: (opts={}) ->\n        opts.origin ?= this\n        return this if @state.value is null\n        if not opts.force and @binding?.delete?\n          try @binding.delete @context.with(opts), null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @update null, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n        @state.prior ?= @state.value\n        @state.changed = @state.value isnt value\n        @state.value = value\n        @parent?.update this, opts # unless opts.suppress\n        return this\n\n### commit async transaction\n\nCommits the changes to the data model. Called *once* for each node that\nis part of the change branch.\n\n      commit: (opts={}) ->\n        opts.origin ?= this\n        return true unless @changed\n        try\n          unless opts.sync\n            # 1. perform save binding\n            @debug \"[commit] execute binding...\"\n            await @binding?.commit? @context.with(opts)\n            # 2. if has parent, then wait for parent commited before updating changed state\n            promise = @parent?.commit? opts\n              .then (ok) =>\n                @state.changed = false if ok\n          unless promise?\n            @state.changed = false\n        catch err\n          @debug \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          throw @error err\n        return true\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @delete opts unless @state.prior? # XXX - prior not good indicator\n        @state.value = @state.prior\n\n        @debug \"[revert] execute binding...\"\n        try await @binding?.commit? @context.with(opts) unless opts.sync\n        catch err\n          @debug \"[revert] failed due to #{err.message}\"\n          throw @error err\n          \n        @state.changed = false\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        unless @attached\n          # @debug \"[attach] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n\n          @set obj[name], Object.assign {}, opts, inner: true, suppress: true\n\n        unless opts.preserve\n          try Object.defineProperty obj, @name,\n              configurable: true\n              enumerable: @enumerable\n              get: (args...) => @get args...\n              set: (args...) => @set args...\n            \n        @state.attached = true\n        @debug \"[attach] attached into #{obj.constructor.name} container\"\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @data = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx) ->\n        err = new Error err unless err instanceof Error\n        err.uri ?= @uri\n        err.src ?= this\n        err.ctx ?= ctx\n        return err\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @data\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:    @name\n          kind:    @kind\n          path:    @path.toString()\n          active:  @active\n          private: @private\n          mutable: @mutable\n          changed: @changed\n          schema: switch\n            when @schema.uri?\n              uri:      @schema.uri\n              summary:  @schema.description?.tag\n              datakey:  @schema.datakey\n              datapath: @schema.datapath\n              external: @schema.external\n              children: @schema.children.map (x) -> x.uri\n            else false\n          value: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"8826bd9ed6170fc421f190013a985b93d4fa5127","subject":"only conditionally traverse up parent during commit if opts.suppress is false","message":"only conditionally traverse up parent during commit if opts.suppress is false\n","repos":"corenova\/yang-js","old_file":"src\/container.litcoffee","new_file":"src\/container.litcoffee","new_contents":"# Container - controller of object properties\n\n## Class Container\n\n    delegate = require 'delegates'\n    Emitter  = require('events').EventEmitter\n    Property = require('.\/property')\n    kProp = Symbol.for('property')\n\n    class Container extends Property\n      logger: require('debug')('yang:container')\n\n      constructor: ->\n        super arguments...\n        @state.children = new Map # committed props\n        @state.pending = new Map # uncommitted changed props\n        @state.delta = undefined\n        @state.proxy =\n          has: (obj, key) => @children.has(key) or key of obj\n          get: (obj, key) => switch\n            when key is kProp then this\n            when key is 'toJSON' then @toJSON.bind(this)\n            when @has(key) then @get(key)\n            when key of obj then obj[key]\n            when key is 'inspect' then @toJSON.bind(this)\n            when key of this and typeof @[key] is 'function' then @[key].bind(this)\n          set: (obj, key, value) => switch\n            when @has(key) then @_get(key).set(value)\n            else obj[key] = value\n          deleteProperty: (obj, key) => switch\n            when @has(key) then @_get(key).delete()\n            when key of obj then delete obj[key]\n        Object.setPrototypeOf @state, Emitter.prototype\n        \n      delegate @prototype, 'state'\n        .getter 'children'\n        .getter 'pending'\n        .getter 'delta'\n        .method 'once'\n        .method 'on'\n        .method 'off'\n        .method 'emit'\n\n      @property 'props',\n        get: -> Array.from(@children.values())\n\n      @property 'changed',\n        get: -> @pending.size > 0 or @state.changed\n\n      @property 'changes',\n        get: -> @pending.values()\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed and @pending.size\n            obj = {}\n            obj[prop.key] = prop.change for prop from @changes\n            obj\n          when @changed then @data\n\n      @property 'data',\n        set: (value) -> @set value, { force: true }\n        get: ->\n          value = switch\n            when @binding?.get? then @binding.get @context\n            else @value\n          return value unless value instanceof Object\n          new Proxy value, @state.proxy\n      \n      clone: ->\n        copy = super children: new Map, pending: new Map\n        copy.add prop.clone(parent: copy) for prop in @props\n        return copy\n\n### add (child)\n\nThis call is used to add a child property to map of children.\n\n      add: (child) ->\n        @children.set child.key, child\n        if @value?\n          Object.defineProperty @value, child.key,\n            configurable: true\n            enumerable: child.active\n\n### remove (child)\n\nThis call is used to remove a child property from map of children.\n\n      remove: (child) ->\n        @children.delete child.key\n        if @value?\n          delete @value[child.key]\n\n### has (key)\n\n      has: (key) -> @children.has(key)\n\n### get (key)\n\n      _get: (key) -> @children.get(key)\n      \n      get: (key) -> switch\n        when key? and @has(key) then @_get(key).data\n        else super arguments...\n\n### set (obj, opts)\n\n      set: (obj, opts={}) ->\n        # TODO: should we preserve prior changes and restore if super fails?\n        @pending.clear()\n        # TODO: should we also clear Object.defineProperties?\n        try obj = Object.assign {}, obj if kProp of obj\n        super obj, opts\n        # remove all props not part of pending changes\n        subopts = Object.assign {}, opts\n        #prop.delete(subopts) for prop in @props when not @pending.has(prop.key)\n        @props.forEach (prop) => prop.delete(subopts) unless @pending.has(prop.key) \n        return this\n\n### merge (obj, opts)\n\nEnumerate key\/value of the passed in `obj` and merge into known child\nproperties.\n\n      merge: (obj, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if obj is null\n        return @set obj, opts if opts.replace or not @value?\n        \n        # TODO: protect this as a transaction?\n        { deep = true } = opts\n\n        subopts = Object.assign {}, opts, inner: true, replace: not deep\n        for own k, v of obj\n          @debug => \"[merge] looking for #{k} inside #{@children.size} children\"\n          prop = @children.get(k) ? @in(k)\n          continue unless prop? and not Array.isArray(prop)\n          @debug => \"[merge] applying value to child prop #{prop.key}\"\n          prop.merge(v, subopts)\n        # TODO: we should consider evaluating schema.attrs here before update\n        @update @value, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      _update: (value, opts) ->\n        @debug => \"[update] handle #{@pending.size} changed props\"\n        \n        for prop from @changes\n          @debug => \"[update] child #{prop.uri} changed? #{prop.changed}\"\n          @add prop, opts\n          @pending.delete prop.key unless prop.changed\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n\n        if value instanceof Property\n          @debug => \"[update] pending.set #{value.key}\"\n          @pending.set value.key, value if value.parent is this\n          if opts.inner or opts.origin is this\n            return this\n          # higher up from change origin\n          value = @value\n\n        @_update value, opts # internal update handler\n\n        # we must clear children here if being deleted before calling super (which calls parent.update)\n        @children.clear() if value is null\n        super value, opts\n            \n        @emit 'update', this, opts\n        return this\n\n### commit (opts)\n\nCommits the changes to the data model. Async transaction.\nEvents: commit, change\n\n      commit: (opts={}) ->\n        return true unless @changed\n        \n        if @locked\n          return new Promise (resolve, reject) => @once 'commit', (res) => resolve res\n          \n        @debug => \"[commit] #{@pending.size} changes\"\n        try\n          @state.locked = true\n          @state.delta = @change\n          @state.setMaxListeners(30 + (@pending.size * 2))\n          \n          subopts = Object.assign {}, opts, inner: true\n\n          # 1. traverse down the children\n          await prop.commit subopts for prop from @changes when not prop.locked\n          \n          @debug => \"[commit] execute commit binding (if any)...\" unless opts.sync\n          await @binding?.commit? @context.with(opts) unless opts.sync\n\n          # TODO: enable this later after kos stops using a '.' dummy container between module and nodes\n          # opts.origin = this if @pending.size > 1 or not @active\n          opts.origin ?= this\n\n          # 2. traverse up the parent (if inner or not suppressed and has parent)\n          if (opts.inner or not opts.suppress) and @parent?\n            promise = @parent.commit? opts\n              .then (ok) =>\n                @debug => \"[commit] parent returned: #{ok}\"\n                await @revert opts unless ok\n                if ok\n                  @emit 'change', opts.origin, opts.actor unless opts.suppress\n                  @finalize()\n                @emit 'commit', ok, opts\n                return ok\n          unless promise?\n            @emit 'change', opts.origin, opts.actor unless opts.suppress\n            @finalize()\n            @emit 'commit', true, opts\n            promise = true\n        catch err\n          @debug => \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          @emit 'commit', false, opts\n          throw @error err, 'commit'\n        finally\n          @state.locked = false\n\n        return switch\n          when opts.inner then true\n          else Promise.resolve promise\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @debug => \"[revert] #{@pending.size} changes\"\n        # below is hackish but works to make a copy of current value\n        # to be used as ctx.prior during revert commit binding call\n        @state.value = @toJSON() \n        await prop.revert opts for prop from @changes\n        @add prop for prop from @changes\n        await super opts\n\n      finalize: ->\n        @pending.clear()\n        super() \n\n### toJSON\n\nThis call creates a new copy of the current `Property.data`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        props = @props\n        value = switch\n          when props.length\n            obj = {}\n            for prop in props when prop.enumerable and (state or prop.mutable)\n              value = prop.toJSON false, state\n              obj[prop.key] = value if value?\n            obj\n          else @value\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        output = super arguments...\n        return Object.assign output, children: @children.size\n        \n    module.exports = Container\n","old_contents":"# Container - controller of object properties\n\n## Class Container\n\n    delegate = require 'delegates'\n    Emitter  = require('events').EventEmitter\n    Property = require('.\/property')\n    kProp = Symbol.for('property')\n\n    class Container extends Property\n      logger: require('debug')('yang:container')\n\n      constructor: ->\n        super arguments...\n        @state.children = new Map # committed props\n        @state.pending = new Map # uncommitted changed props\n        @state.delta = undefined\n        @state.proxy =\n          has: (obj, key) => @children.has(key) or key of obj\n          get: (obj, key) => switch\n            when key is kProp then this\n            when key is 'toJSON' then @toJSON.bind(this)\n            when @has(key) then @get(key)\n            when key of obj then obj[key]\n            when key is 'inspect' then @toJSON.bind(this)\n            when key of this and typeof @[key] is 'function' then @[key].bind(this)\n          set: (obj, key, value) => switch\n            when @has(key) then @_get(key).set(value)\n            else obj[key] = value\n          deleteProperty: (obj, key) => switch\n            when @has(key) then @_get(key).delete()\n            when key of obj then delete obj[key]\n        Object.setPrototypeOf @state, Emitter.prototype\n        \n      delegate @prototype, 'state'\n        .getter 'children'\n        .getter 'pending'\n        .getter 'delta'\n        .method 'once'\n        .method 'on'\n        .method 'off'\n        .method 'emit'\n\n      @property 'props',\n        get: -> Array.from(@children.values())\n\n      @property 'changed',\n        get: -> @pending.size > 0 or @state.changed\n\n      @property 'changes',\n        get: -> @pending.values()\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed and @pending.size\n            obj = {}\n            obj[prop.key] = prop.change for prop from @changes\n            obj\n          when @changed then @data\n\n      @property 'data',\n        set: (value) -> @set value, { force: true }\n        get: ->\n          value = switch\n            when @binding?.get? then @binding.get @context\n            else @value\n          return value unless value instanceof Object\n          new Proxy value, @state.proxy\n      \n      clone: ->\n        copy = super children: new Map, pending: new Map\n        copy.add prop.clone(parent: copy) for prop in @props\n        return copy\n\n### add (child)\n\nThis call is used to add a child property to map of children.\n\n      add: (child) ->\n        @children.set child.key, child\n        if @value?\n          Object.defineProperty @value, child.key,\n            configurable: true\n            enumerable: child.active\n\n### remove (child)\n\nThis call is used to remove a child property from map of children.\n\n      remove: (child) ->\n        @children.delete child.key\n        if @value?\n          delete @value[child.key]\n\n### has (key)\n\n      has: (key) -> @children.has(key)\n\n### get (key)\n\n      _get: (key) -> @children.get(key)\n      \n      get: (key) -> switch\n        when key? and @has(key) then @_get(key).data\n        else super arguments...\n\n### set (obj, opts)\n\n      set: (obj, opts={}) ->\n        # TODO: should we preserve prior changes and restore if super fails?\n        @pending.clear()\n        # TODO: should we also clear Object.defineProperties?\n        try obj = Object.assign {}, obj if kProp of obj\n        super obj, opts\n        # remove all props not part of pending changes\n        subopts = Object.assign {}, opts\n        #prop.delete(subopts) for prop in @props when not @pending.has(prop.key)\n        @props.forEach (prop) => prop.delete(subopts) unless @pending.has(prop.key) \n        return this\n\n### merge (obj, opts)\n\nEnumerate key\/value of the passed in `obj` and merge into known child\nproperties.\n\n      merge: (obj, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if obj is null\n        return @set obj, opts if opts.replace or not @value?\n        \n        # TODO: protect this as a transaction?\n        { deep = true } = opts\n\n        subopts = Object.assign {}, opts, inner: true, replace: not deep\n        for own k, v of obj\n          @debug => \"[merge] looking for #{k} inside #{@children.size} children\"\n          prop = @children.get(k) ? @in(k)\n          continue unless prop? and not Array.isArray(prop)\n          @debug => \"[merge] applying value to child prop #{prop.key}\"\n          prop.merge(v, subopts)\n        # TODO: we should consider evaluating schema.attrs here before update\n        @update @value, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      _update: (value, opts) ->\n        @debug => \"[update] handle #{@pending.size} changed props\"\n        \n        for prop from @changes\n          @debug => \"[update] child #{prop.uri} changed? #{prop.changed}\"\n          @add prop, opts\n          @pending.delete prop.key unless prop.changed\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n\n        if value instanceof Property\n          @debug => \"[update] pending.set #{value.key}\"\n          @pending.set value.key, value if value.parent is this\n          if opts.inner or opts.origin is this\n            return this\n          # higher up from change origin\n          value = @value\n\n        @_update value, opts # internal update handler\n\n        # we must clear children here if being deleted before calling super (which calls parent.update)\n        @children.clear() if value is null\n        super value, opts\n            \n        @emit 'update', this, opts\n        return this\n\n### commit (opts)\n\nCommits the changes to the data model. Async transaction.\nEvents: commit, change\n\n      commit: (opts={}) ->\n        return true unless @changed\n        \n        if @locked\n          return new Promise (resolve, reject) => @once 'commit', (res) => resolve res\n          \n        @debug => \"[commit] #{@pending.size} changes\"\n        try\n          @state.locked = true\n          @state.delta = @change\n          @state.setMaxListeners(30 + (@pending.size * 2))\n          \n          subopts = Object.assign {}, opts, inner: true\n\n          # 1. traverse down the children\n          await prop.commit subopts for prop from @changes when not prop.locked\n          \n          @debug => \"[commit] execute commit binding (if any)...\" unless opts.sync\n          await @binding?.commit? @context.with(opts) unless opts.sync\n\n          # TODO: enable this later after kos stops using a '.' dummy container between module and nodes\n          # opts.origin = this if @pending.size > 1 or not @active\n          opts.origin ?= this\n\n          # 2. traverse up the parent (if has parent)\n          promise = @parent?.commit? opts\n            .then (ok) =>\n              @debug => \"[commit] parent returned: #{ok}\"\n              await @revert opts unless ok\n              if ok\n                @emit 'change', opts.origin, opts.actor unless opts.suppress\n                @finalize()\n              @emit 'commit', ok, opts\n              return ok\n          unless promise?\n            @emit 'change', opts.origin, opts.actor unless opts.suppress\n            @finalize()\n            promise = true\n        catch err\n          @debug => \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          @emit 'commit', false, opts\n          throw @error err, 'commit'\n        finally\n          @state.locked = false\n\n        return switch\n          when opts.inner then true\n          else Promise.resolve promise\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @debug => \"[revert] #{@pending.size} changes\"\n        # below is hackish but works to make a copy of current value\n        # to be used as ctx.prior during revert commit binding call\n        @state.value = @toJSON() \n        await prop.revert opts for prop from @changes\n        @add prop for prop from @changes\n        await super opts\n\n      finalize: ->\n        @pending.clear()\n        super() \n\n### toJSON\n\nThis call creates a new copy of the current `Property.data`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        props = @props\n        value = switch\n          when props.length\n            obj = {}\n            for prop in props when prop.enumerable and (state or prop.mutable)\n              value = prop.toJSON false, state\n              obj[prop.key] = value if value?\n            obj\n          else @value\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        output = super arguments...\n        return Object.assign output, children: @children.size\n        \n    module.exports = Container\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"d68725697ec2049ff062c88c6ef75556e9590ba8","subject":"Updated the game module to include basic physics.  Needs iteration.","message":"Updated the game module to include basic physics.  Needs iteration.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/game.litcoffee","new_file":"src\/game.litcoffee","new_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n       \n    triangle = undefined\n    \n    testEntity = testMap = testNavmesh = undefined\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load (require \".\/testEntity.msc\"), (testEntity_) ->\n            testEntity = testEntity_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    translation = []\n    acceleration = []\n    forwardVelocity = []\n    sidewardVelocity = []\n    \n    tick = ->    \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            \n        matrix.translate velocity, entityTransform        \n        \n        # Left\/right rotation.\n        matrix.rotateY ((gamepad.left - gamepad.right) * 0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            vector.multiply.byScalar zAxis, ((gamepad.forward - gamepad.backward) * 0.2), acceleration\n            vector.add.vector velocity, acceleration, velocity\n        \n            # Apply friction.  There is more sidewards than backwards\/forwards.\n            vector.flatten velocity, zAxis, sidewardVelocity\n            vector.straighten velocity, zAxis, forwardVelocity\n            vector.multiply.byScalar sidewardVelocity, 0.9, sidewardVelocity\n            vector.multiply.byScalar forwardVelocity, 0.99, forwardVelocity\n            vector.add.vector sidewardVelocity, forwardVelocity, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n    \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            firstTick = false\n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw testEntity, entityTransformPreviousDraw, entityTransformToDraw\n        \n        return\n        \n    module.exports = { load, tick, draw }","old_contents":"    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    loadVertices = require \".\/rendering\/loadVertices.litcoffee\"\n\n    identity = []\n    matrix.identity identity\n    matrix.translate -150, -20, -150, identity\n    \n    oldTransform = []\n    newTransform = []\n    \n    turned = oldTurned = 0\n\n    testMap = undefined\n\n    module.exports = \n\nCall the \"load\" property to initialize the game.\n\n    load: (callback) ->\n        context.load()\n        cloud.load ->\n            loadVertices (require \".\/testMap.msc\"), (testMap_) ->\n                testMap = testMap_\n                callback()\n                return\n            return\n        return\n    \nCall the \"tick\" property at 20Hz to update game state.\n    \n    tick: ->\n        oldTurned = turned\n        turned += 0.05\n        return\n  \nCall the \"draw\" property with the progress through the current frame in 0...1\nspace to render the game.\n  \n    draw: (progress) ->     \n        matrix.copy newTransform, oldTransform\n        matrix.identity newTransform\n        matrix.rotateY (misc.interpolate oldTurned, turned, progress), newTransform\n        matrix.translate 50, 0, 0, newTransform\n        context.begin 0, 0, context.width, context.height, 1, oldTransform, newTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap, identity, identity\n        return","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"769e93475b48b69ae541f3648fd142eb854e1f53","subject":"Made cells taller and wider to allow for more rendering detail","message":"Made cells taller and wider to allow for more rendering detail\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/arguments.litcoffee","new_file":"lib\/arguments.litcoffee","new_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] levelname anotherlevelname yetanotherlevelname ...'\n      .example '$0',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -vvvvvvvv',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to verbosity level 8 (max)\\n\"\n      .example '$0 -w 20 -h 20',\n        \"Creates a level with default row and column counts,\n         the cells 20 units wide, 20 units high,\n         expanded by the default multiplier,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -w 10 -h 10 -x 4',\n        \"Creates a level with default row and column counts,\n         40 x 40 unit cells,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 lvl1 lvl2',\n        \"Creates two levels; named lvl1 and lvl2 -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 --levels one two three',\n        \"Creates three levels; named one, two, and three -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 -l10',\n        \"Creates ten auto-named levels -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .string 'conf'\n      .describe 'conf', 'Absolute path to config file'\n      .string 'block.fill_color'\n      .describe 'block.fill_color', 'Path block color. Can be an html color name or hex value'\n      .string 'ground.fill_color'\n      .describe 'ground.fill_color', 'Ground block color. Can be an html color name or hex value'\n      .string 'step_count.text.align'\n      .choices 'step_count.text.align', [ 'left', 'center', 'right' ]\n      .string 'step_count.text.color'\n      .describe 'step_count.text.color', 'Can be either html color names or hex values'\n      .number 'ground.segments'\n      .number 'ground.max_height_diff'\n      .number 'wall.width'\n      .string 'wall.color'\n      .describe 'wall.color', 'Can be either html color names or hex values'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      24\n        height:     24\n        multiplier: 4\n        pipeline:   [ 'png_blocks', 'png_walls', 'png_grounder', 'png_step_count' ]\n        block:\n          fill_color: 'white'\n        ground:\n          fill_color:     '#888'\n          segments:        24\n          max_height_diff: 4\n        step_count:\n          text:\n            align: 'center'\n            color: 'black'\n        wall:\n          width: 1\n          color: '#666'\n          segments: 24\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .wrap 120\n      .argv\n","old_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] levelname anotherlevelname yetanotherlevelname ...'\n      .example '$0',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -vvvvvvvv',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to verbosity level 8 (max)\\n\"\n      .example '$0 -w 20 -h 20',\n        \"Creates a level with default row and column counts,\n         the cells 20 units wide, 20 units high,\n         expanded by the default multiplier,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -w 10 -h 10 -x 4',\n        \"Creates a level with default row and column counts,\n         40 x 40 unit cells,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 lvl1 lvl2',\n        \"Creates two levels; named lvl1 and lvl2 -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 --levels one two three',\n        \"Creates three levels; named one, two, and three -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 -l10',\n        \"Creates ten auto-named levels -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .string 'conf'\n      .describe 'conf', 'Absolute path to config file'\n      .string 'block.fill_color'\n      .describe 'block.fill_color', 'Path block color. Can be an html color name or hex value'\n      .string 'ground.fill_color'\n      .describe 'ground.fill_color', 'Ground block color. Can be an html color name or hex value'\n      .string 'step_count.text.align'\n      .choices 'step_count.text.align', [ 'left', 'center', 'right' ]\n      .string 'step_count.text.color'\n      .describe 'step_count.text.color', 'Can be either html color names or hex values'\n      .number 'ground.segments'\n      .number 'ground.max_height_diff'\n      .number 'wall.width'\n      .string 'wall.color'\n      .describe 'wall.color', 'Can be either html color names or hex values'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      8\n        height:     7\n        multiplier: 4\n        pipeline:   [ 'png_blocks', 'png_walls', 'png_grounder', 'png_step_count' ]\n        block:\n          fill_color: 'white'\n        ground:\n          fill_color:     '#888'\n          segments:        8\n          max_height_diff: 4\n        step_count:\n          text:\n            align: 'center'\n            color: 'black'\n        wall:\n          width: 1\n          color: '#666'\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .wrap 120\n      .argv\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c35281405d823f0f477ee38c307d808a3111791a","subject":"better docs for source maps","message":"better docs for source maps\n","repos":"sterpe\/coffee-fmt","old_file":"sourcemap.litcoffee","new_file":"sourcemap.litcoffee","new_contents":"Source maps allow JavaScript runtimes to match running JavaScript back to\nthe original source code that corresponds to it. This can be minified\nJavaScript, but in our case, we're concerned with mapping pretty-printed\nJavaScript back to CoffeeScript.\n\nIn order to produce maps, we must keep track of positions (line number, column number)\nthat originated every node in the syntax tree, and be able to generate a\n[map file](https:\/\/docs.google.com\/document\/d\/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k\/edit)\n\u2014 which is a compact, VLQ-encoded representation of the JSON serialization\nof this information \u2014 to write out alongside the generated JavaScript.\n\n\nLineMap\n-------\n\nA **LineMap** object keeps track of information about original line and column\npositions for a single line of output JavaScript code.\n**SourceMaps** are implemented in terms of **LineMaps**.\n\n    class LineMap\n      constructor: (@line) ->\n        @columns = []\n\n      add: (column, [sourceLine, sourceColumn], options={}) ->\n        return if @columns[column] and options.noReplace\n        @columns[column] = {line: @line, column, sourceLine, sourceColumn}\n\n      sourceLocation: (column) ->\n        column-- until (mapping = @columns[column]) or (column <= 0)\n        mapping and [mapping.sourceLine, mapping.sourceColumn]\n\n\nSourceMap\n---------\n\nMaps locations in a single generated JavaScript file back to locations in\nthe original CoffeeScript source file.\n\nThis is intentionally agnostic towards how a source map might be represented on\ndisk. Once the compiler is ready to produce a \"v3\"-style source map, we can walk\nthrough the arrays of line and column buffer to produce it.\n\n    class SourceMap\n      constructor: ->\n        @lines = []\n\nAdds a mapping to this SourceMap. `sourceLocation` and `generatedLocation`\nare both `[line, column]` arrays. If `options.noReplace` is true, then if there\nis already a mapping for the specified `line` and `column`, this will have no\neffect.\n\n      add: (sourceLocation, generatedLocation, options = {}) ->\n        [line, column] = generatedLocation\n        lineMap = (@lines[line] or= new LineMap(line))\n        lineMap.add column, sourceLocation, options\n\nLook up the original position of a given `line` and `column` in the generated\ncode.\n\n      sourceLocation: ([line, column]) ->\n        line-- until (lineMap = @lines[line]) or (line <= 0)\n        lineMap and lineMap.sourceLocation column\n\n\nV3 SourceMap Generation\n-----------------------\n\nBuilds up a V3 source map, returning the generated JSON as a string.\n`options.sourceRoot` may be used to specify the sourceRoot written to the source\nmap.  Also, `options.sourceFiles` and `options.generatedFile` may be passed to\nset \"sources\" and \"file\", respectively.\n\n      generate: (options = {}, code = null) ->\n        writingline       = 0\n        lastColumn        = 0\n        lastSourceLine    = 0\n        lastSourceColumn  = 0\n        needComma         = no\n        buffer            = \"\"\n\n        for lineMap, lineNumber in @lines when lineMap\n          for mapping in lineMap.columns when mapping\n            while writingline < mapping.line\n              lastColumn = 0\n              needComma = no\n              buffer += \";\"\n              writingline++\n\nWrite a comma if we've already written a segment on this line.\n\n            if needComma\n              buffer += \",\"\n              needComma = no\n\nWrite the next segment. Segments can be 1, 4, or 5 values.  If just one, then it\nis a generated column which doesn't match anything in the source code.\n\nThe starting column in the generated source, relative to any previous recorded\ncolumn for the current line:\n\n            buffer += @encodeVlq mapping.column - lastColumn\n            lastColumn = mapping.column\n\nThe index into the list of sources:\n\n            buffer += @encodeVlq 0\n\nThe starting line in the original source, relative to the previous source line.\n\n            buffer += @encodeVlq mapping.sourceLine - lastSourceLine\n            if lastSourceLine isnt mapping.sourceLine\n              lastSourceLine = mapping.sourceLine\n              lastSourceColumn = 0\n\nThe starting column in the original source, relative to the previous column.\n\n            buffer += @encodeVlq mapping.sourceColumn - lastSourceColumn\n            lastSourceColumn = mapping.sourceColumn\n            needComma = yes\n\nProduce the canonical JSON object format for a \"v3\" source map.\n\n        v3 =\n          version:    3\n          file:       options.generatedFile or ''\n          sourceRoot: options.sourceRoot or ''\n          sources:    options.sourceFiles or ['']\n          names:      []\n          mappings:   buffer\n\n        v3.sourcesContent = [code] if options.inline\n\n        JSON.stringify v3, null, 2\n\n\nBase64 VLQ Encoding\n-------------------\n\nNote that SourceMap VLQ encoding is \"backwards\".  MIDI-style VLQ encoding puts\nthe most-significant-bit (MSB) from the original value into the MSB of the VLQ\nencoded value (see [Wikipedia](http:\/\/en.wikipedia.org\/wiki\/File:Uintvar_coding.svg)).\nSourceMap VLQ does things the other way around, with the least significat four\nbits of the original value encoded into the first byte of the VLQ encoded value.\n\n      VLQ_SHIFT            = 5\n      VLQ_CONTINUATION_BIT = 1 << VLQ_SHIFT             # 0010 0000\n      VLQ_VALUE_MASK       = VLQ_CONTINUATION_BIT - 1   # 0001 1111\n\n      encodeVlq: (value) ->\n        answer = ''\n\n        # Least significant bit represents the sign.\n        signBit = if value < 0 then 1 else 0\n\n        # The next bits are the actual value.\n        valueToEncode = (Math.abs(value) << 1) + signBit\n\n        # Make sure we encode at least one character, even if valueToEncode is 0.\n        while valueToEncode or not answer\n          nextChunk = valueToEncode & VLQ_VALUE_MASK\n          valueToEncode = valueToEncode >> VLQ_SHIFT\n          nextChunk |= VLQ_CONTINUATION_BIT if valueToEncode\n          answer += @encodeBase64 nextChunk\n\n        answer\n\n\nRegular Base64 Encoding\n-----------------------\n\n      BASE64_CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+\/'\n\n      encodeBase64: (value) ->\n        BASE64_CHARS[value] or throw new Error \"Cannot Base64 encode value: #{value}\"\n\n\nOur API for source maps is just the `SourceMap` class.\n\n    module.exports = SourceMap\n\n\n\n","old_contents":"Source maps allow JavaScript runtimes to match running JavaScript back to\nthe original source code that corresponds to it. This can be minified\nJavaScript, but in our case, we're concerned with mapping pretty-printed\nJavaScript back to CoffeeScript.\n\nIn order to produce maps, we must keep track of positions (line number, column number)\nthat originated every node in the syntax tree, and be able to generate a\n[map file](https:\/\/docs.google.com\/document\/d\/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k\/edit)\n\u2014 which is a compact, VLQ-encoded representation of the JSON serialization\nof this information \u2014 to write out alongside the generated JavaScript.\n\n\nLineMap\n-------\n\nA **LineMap** object keeps track of information about original line and column\npositions for a single line of output JavaScript code.\n**SourceMaps** are implemented in terms of **LineMaps**.\n\n    class LineMap\n      constructor: (@line) ->\n        @columns = []\n\n      add: (column, [sourceLine, sourceColumn], options={}) ->\n        return if @columns[column] and options.noReplace\n        @columns[column] = {line: @line, column, sourceLine, sourceColumn}\n\n      sourceLocation: (column) ->\n        column-- until (mapping = @columns[column]) or (column <= 0)\n        mapping and [mapping.sourceLine, mapping.sourceColumn]\n\n\nSourceMap\n---------\n\nMaps locations in for a single generated JavaScript file back to locations in\nthe original CoffeeScript source file.\n\nThis is intentionally agnostic towards how a source map might be represented on\ndisk. Once the compiler is ready to produce a \"v3\"-style source map, we can walk\nthrough the arrays of line and column buffer to produce it.\n\n    class SourceMap\n      constructor: ->\n        @lines = []\n\nAdds a mapping to this SourceMap. `sourceLocation` and `generatedLocation`\nare both `[line, column]` arrays. If `options.noReplace` is true, then if there\nis already a mapping for the specified `line` and `column`, this will have no\neffect.\n\n      add: (sourceLocation, generatedLocation, options = {}) ->\n        [line, column] = generatedLocation\n        lineMap = (@lines[line] or= new LineMap(line))\n        lineMap.add column, sourceLocation, options\n\nLook up the original position of a given `line` and `column` in the generated\ncode.\n\n      sourceLocation: ([line, column]) ->\n        line-- until (lineMap = @lines[line]) or (line <= 0)\n        lineMap and lineMap.sourceLocation column\n\n\nV3 SourceMap Generation\n-----------------------\n\nBuilds up a V3 source map, returning the generated JSON as a string.\n`options.sourceRoot` may be used to specify the sourceRoot written to the source\nmap.  Also, `options.sourceFiles` and `options.generatedFile` may be passed to\nset \"sources\" and \"file\", respectively.\n\n      generate: (options = {}, code = null) ->\n        writingline       = 0\n        lastColumn        = 0\n        lastSourceLine    = 0\n        lastSourceColumn  = 0\n        needComma         = no\n        buffer            = \"\"\n\n        for lineMap, lineNumber in @lines when lineMap\n          for mapping in lineMap.columns when mapping\n            while writingline < mapping.line\n              lastColumn = 0\n              needComma = no\n              buffer += \";\"\n              writingline++\n\nWrite a comma if we've already written a segment on this line.\n\n            if needComma\n              buffer += \",\"\n              needComma = no\n\nWrite the next segment. Segments can be 1, 4, or 5 values.  If just one, then it\nis a generated column which doesn't match anything in the source code.\n\nThe starting column in the generated source, relative to any previous recorded\ncolumn for the current line:\n\n            buffer += @encodeVlq mapping.column - lastColumn\n            lastColumn = mapping.column\n\nThe index into the list of sources:\n\n            buffer += @encodeVlq 0\n\nThe starting line in the original source, relative to the previous source line.\n\n            buffer += @encodeVlq mapping.sourceLine - lastSourceLine\n            if lastSourceLine isnt mapping.sourceLine\n              lastSourceLine = mapping.sourceLine\n              lastSourceColumn = 0\n\nThe starting column in the original source, relative to the previous column.\n\n            buffer += @encodeVlq mapping.sourceColumn - lastSourceColumn\n            lastSourceColumn = mapping.sourceColumn\n            needComma = yes\n\nProduce the canonical JSON object format for a \"v3\" source map.\n\n        v3 =\n          version:    3\n          file:       options.generatedFile or ''\n          sourceRoot: options.sourceRoot or ''\n          sources:    options.sourceFiles or ['']\n          names:      []\n          mappings:   buffer\n\n        v3.sourcesContent = [code] if options.inline\n\n        JSON.stringify v3, null, 2\n\n\nBase64 VLQ Encoding\n-------------------\n\nNote that SourceMap VLQ encoding is \"backwards\".  MIDI-style VLQ encoding puts\nthe most-significant-bit (MSB) from the original value into the MSB of the VLQ\nencoded value (see [Wikipedia](http:\/\/en.wikipedia.org\/wiki\/File:Uintvar_coding.svg)).\nSourceMap VLQ does things the other way around, with the least significat four\nbits of the original value encoded into the first byte of the VLQ encoded value.\n\n      VLQ_SHIFT            = 5\n      VLQ_CONTINUATION_BIT = 1 << VLQ_SHIFT             # 0010 0000\n      VLQ_VALUE_MASK       = VLQ_CONTINUATION_BIT - 1   # 0001 1111\n\n      encodeVlq: (value) ->\n        answer = ''\n\n        # Least significant bit represents the sign.\n        signBit = if value < 0 then 1 else 0\n\n        # The next bits are the actual value.\n        valueToEncode = (Math.abs(value) << 1) + signBit\n\n        # Make sure we encode at least one character, even if valueToEncode is 0.\n        while valueToEncode or not answer\n          nextChunk = valueToEncode & VLQ_VALUE_MASK\n          valueToEncode = valueToEncode >> VLQ_SHIFT\n          nextChunk |= VLQ_CONTINUATION_BIT if valueToEncode\n          answer += @encodeBase64 nextChunk\n\n        answer\n\n\nRegular Base64 Encoding\n-----------------------\n\n      BASE64_CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+\/'\n\n      encodeBase64: (value) ->\n        BASE64_CHARS[value] or throw new Error \"Cannot Base64 encode value: #{value}\"\n\n\nOur API for source maps is just the `SourceMap` class.\n\n    module.exports = SourceMap\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"01ae4fbe11f7a972003605c355e679261f2d3c05","subject":"Add missing return statement","message":"Add missing return statement\n","repos":"Turistforeningen\/node-mongo-querystring","old_file":"src\/index.litcoffee","new_file":"src\/index.litcoffee","new_contents":"    module.exports = MongoQS = (opts) ->\n      @ops = opts?.ops or ['!', '^', '$', '~', '>', '<']\n      @alias = opts?.alias or {}\n      @ignore = opts?.ignore or {}\n      @custom = opts?.custom or {}\n\n      for param, field of @custom\n        switch param\n          when 'bbox' then @custom.bbox = @customBBOX field\n          when 'near' then @custom.near = @customNear field\n          when 'after' then @custom.after = @customAfter field\n\n      return @\n\n    MongoQS.prototype.customBBOX = (field) ->\n      (res, bbox) ->\n        bbox = bbox.split ','\n\n        if bbox.length is 4\n          bbox[key] = parseFloat(val) for val, key in bbox\n\n          res[field] = $geoWithin: $geometry:\n            type: 'Polygon'\n            coordinates: [[\n              [bbox[0], bbox[1]]\n              [bbox[2], bbox[1]]\n              [bbox[2], bbox[3]]\n              [bbox[0], bbox[3]]\n              [bbox[0], bbox[1]]\n            ]]\n\n        return\n\n    MongoQS.prototype.customNear = (field) ->\n      (query, input) ->\n        input = input.split ','\n\n        if input.length is 2\n          input[key] = parseFloat(val) for val, key in input\n\n          query[field] = $near: $geometry:\n            type: 'Point'\n            coordinates: input\n\n        return\n\n    MongoQS.prototype.customAfter = (field) ->\n      (query, input) ->\n\n        if not isNaN input\n          input = input + '000' if (input + '').length is 10\n          input = parseInt input\n\n        input = new Date input\n\n        if input.toString() isnt 'Invalid Date'\n          query[field] = $gte: input.toISOString()\n\n        return\n\n\n    MongoQS.prototype.parse = (query) ->\n      res = {}\n\n      for key, val of query\n        continue if @ignore[key]\n        continue if typeof val isnt 'string'\n        continue if not \/^[a-z\u00e6\u00f8\u00e50-9-_.]+$\/i.test key\n\n        key = @alias[key] if @alias[key]\n\nIf the value is empty we treat the query parameter as an\n[$exists](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/exists\/)\noperator.\n\n        if not val\n          res[key] = $exists: true\n\nCheck for supported operators in `@ops`. This is configured when\ninstanciating `MongoQS` and the defaults are `!`, `^`, `$`, `~`, `>`, and `<`.\n\n        else if val.charAt(0) in @ops\n          op = val.charAt(0)\n          val = val.substr(1)\n\n          res[key] = switch op\n            when '!'\n              if val\n                $ne: if isNaN(val) then val else parseFloat(val, 10)\n              else\n                $exists: false\n            when '>' then $gt: parseFloat(val, 10)\n            when '<' then $lt: parseFloat(val, 10)\n            else\n              val = val.replace \/[^a-z\u00e6\u00f8\u00e50-9-_.* ]\/i, ''\n              switch op\n                when '^' then $regex: '^' + val, $options: 'i'\n                when '$' then $regex: val + '$', $options: 'i'\n                else $regex: val, $options: 'i'\n\n        else\n          res[key] = if isNaN(val) then val else parseFloat(val, 10)\n\n      res\n\n","old_contents":"    module.exports = MongoQS = (opts) ->\n      @ops = opts?.ops or ['!', '^', '$', '~', '>', '<']\n      @alias = opts?.alias or {}\n      @ignore = opts?.ignore or {}\n      @custom = opts?.custom or {}\n\n      for param, field of @custom\n        switch param\n          when 'bbox' then @custom.bbox = @customBBOX field\n          when 'near' then @custom.near = @customNear field\n          when 'after' then @custom.after = @customAfter field\n\n      return @\n\n    MongoQS.prototype.customBBOX = (field) ->\n      (res, bbox) ->\n        bbox = bbox.split ','\n\n        if bbox.length is 4\n          bbox[key] = parseFloat(val) for val, key in bbox\n\n          res[field] = $geoWithin: $geometry:\n            type: 'Polygon'\n            coordinates: [[\n              [bbox[0], bbox[1]]\n              [bbox[2], bbox[1]]\n              [bbox[2], bbox[3]]\n              [bbox[0], bbox[3]]\n              [bbox[0], bbox[1]]\n            ]]\n\n        return\n\n    MongoQS.prototype.customNear = (field) ->\n      (query, input) ->\n        input = input.split ','\n\n        if input.length is 2\n          input[key] = parseFloat(val) for val, key in input\n\n          query[field] = $near: $geometry:\n            type: 'Point'\n            coordinates: input\n\n        return\n\n    MongoQS.prototype.customAfter = (field) ->\n      (query, input) ->\n\n        if not isNaN input\n          input = input + '000' if (input + '').length is 10\n          input = parseInt input\n\n        input = new Date input\n\n        if input.toString() isnt 'Invalid Date'\n          query[field] = $gte: input.toISOString()\n\n\n    MongoQS.prototype.parse = (query) ->\n      res = {}\n\n      for key, val of query\n        continue if @ignore[key]\n        continue if typeof val isnt 'string'\n        continue if not \/^[a-z\u00e6\u00f8\u00e50-9-_.]+$\/i.test key\n\n        key = @alias[key] if @alias[key]\n\nIf the value is empty we treat the query parameter as an\n[$exists](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/exists\/)\noperator.\n\n        if not val\n          res[key] = $exists: true\n\nCheck for supported operators in `@ops`. This is configured when\ninstanciating `MongoQS` and the defaults are `!`, `^`, `$`, `~`, `>`, and `<`.\n\n        else if val.charAt(0) in @ops\n          op = val.charAt(0)\n          val = val.substr(1)\n\n          res[key] = switch op\n            when '!'\n              if val\n                $ne: if isNaN(val) then val else parseFloat(val, 10)\n              else\n                $exists: false\n            when '>' then $gt: parseFloat(val, 10)\n            when '<' then $lt: parseFloat(val, 10)\n            else\n              val = val.replace \/[^a-z\u00e6\u00f8\u00e50-9-_.* ]\/i, ''\n              switch op\n                when '^' then $regex: '^' + val, $options: 'i'\n                when '$' then $regex: val + '$', $options: 'i'\n                else $regex: val, $options: 'i'\n\n        else\n          res[key] = if isNaN(val) then val else parseFloat(val, 10)\n\n      res\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"022abf0a0d3bec67a81731a92fe8cee8952b479c","subject":"Fix nested object parsing to properly assign values at the correct level","message":"Fix nested object parsing to properly assign values at the correct level\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/config.litcoffee","new_file":"lib\/config.litcoffee","new_contents":"    Madul = require 'madul'\n\n    class Config extends Madul\n\n      deps: [ 'arguments', 'fs', 'path', 'node-uuid' ]\n\n      post_initialize: =>\n        levels = [ ]\n\n        process.env.MADUL_LOG_LEVEL = if @arguments?.verbosity? then @arguments.verbosity else 3\n\n        if @arguments.conf?\n          config = @arguments.conf\n        else\n          config = @path.join __dirname, '..', '.skyll.conf.js'\n\n\n        if @arguments?._?.length > 0\n          levels = levels.concat argv._\n        else if @arguments?.l?\n          for level in [0...argv.l]\n            levels.push @node_uuid.v4()\n        else if @arguments?.levels? == false\n          levels.push new Date().toString()\n\n        for key, val of @arguments\n          if key.length > 2 && typeof val != 'undefined'\n            if key == 'levels'\n              levels = levels.concat val\n            else\n              if typeof val == 'object' && val != null && val.length? == false\n                @dive_deeper key, val, @\n              else\n                @[key] = val\n\n        @fs.stat config, (err) =>\n          if err?\n            @fail 'DOES NOT EXIST', file: config\n          else\n            for key, val of require config\n              if key == 'levels'\n                for level in [0...val]\n                  levels.push new Date(Date.now() - (((val - 1) - level) * 1000)).toString()\n              else\n                if typeof val == 'object' && val != null && val.length? == false\n                  @dive_deeper key, val, @\n                else\n                  @[key] = val\n\n            levels.push new Date().toString() if levels.length == 0\n\n            @levels = levels\n            @grid   = ((false for j in [0..@columns]) for i in [0..@rows])\n            @width  = @width  * @multiplier\n            @height = @height * @multiplier\n\n            @done()\n\n      dive_deeper: (prop, obj, context) =>\n        for key, val of obj\n          context[prop] = { } unless context[prop]?\n\n          if typeof val == 'object' && val != null && val.length? == false\n            @dive_deeper key, val, context[prop]\n          else\n            context[prop][key] = val\n\n    module.exports = Config\n","old_contents":"    Madul = require 'madul'\n\n    class Config extends Madul\n\n      deps: [ 'arguments', 'fs', 'path', 'node-uuid' ]\n\n      post_initialize: =>\n        levels = [ ]\n\n        process.env.MADUL_LOG_LEVEL = if @arguments?.verbosity? then @arguments.verbosity else 3\n\n        if @arguments.conf?\n          config = @arguments.conf\n        else\n          config = @path.join __dirname, '..', '.skyll.conf.js'\n\n\n        if @arguments?._?.length > 0\n          levels = levels.concat argv._\n        else if @arguments?.l?\n          for level in [0...argv.l]\n            levels.push @node_uuid.v4()\n        else if @arguments?.levels? == false\n          levels.push new Date().toString()\n\n        for key, val of @arguments\n          if key.length > 2 && typeof val != 'undefined'\n            if key == 'levels'\n              levels = levels.concat val\n            else\n              if typeof val == 'object' && val != null && val.length? == false\n                @dive_deeper key, val, @\n              else\n                @[key] = val\n\n        @fs.stat config, (err) =>\n          if err?\n            @fail 'DOES NOT EXIST', file: config\n          else\n            for key, val of require config\n              if key == 'levels'\n                for level in [0...val]\n                  levels.push new Date(Date.now() - (((val - 1) - level) * 1000)).toString()\n              else\n                if typeof val == 'object' && val != null && val.length? == false\n                  @dive_deeper val, @\n                else\n                  @[key] = val\n\n          levels.push new Date().toString() if levels.length == 0\n\n          @levels = levels\n          @grid   = ((false for j in [0..@columns]) for i in [0..@rows])\n          @width  = @width  * @multiplier\n          @height = @height * @multiplier\n\n            @done()\n\n        deferred.promise\n\n      dive_deeper: (obj, context) =>\n        for key, val of obj\n          context[key] = { } unless context[key]?\n\n          if typeof val == 'object' && val != null && val.length? == false\n            @dive_deeper val, context[key]\n          else\n            context[key] = val\n\n    module.exports = Config\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fcd2a23c70937bc690f4166630f34662beac69c3","subject":"Add docs for wrapAccessor","message":"Add docs for wrapAccessor\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/03_object.litcoffee","new_file":"docs\/03_object.litcoffee","new_contents":"# \/api\/Data Structures\/Batman.Object\n\n`Batman.Object` is the superclass for virtually all objects in a batman.js application. `Batman.Object` mixes in:\n\n- `Batman.Observable` for `get`, `set`, `observe` and others\n- `Batman.EventEmitter` for `on`, `off`, `fire` and others\n\nSee [`Batman.Object Accessors`](\/docs\/api\/batman.object_accessors.html) for a full description of `@accessor`, which defines properties on `Batman.Object`s.\n\n\n## @accessor([keys...], objectOrFunction)\n\nIf `keys` is empty, defines a new default accessor for instances of the object, otherwise defines a new accessor on instances of the `Object` for `keys`.\n\n`objectOrFunction` may be:\n\n- An object with `get`, `set`, and\/or `unset` keys whose values are functions which implement those operations.\n- A function which will be treated as the `get` key of the accessor object.\n\n## @classAccessor([keys...], objectOrFunction)\n\nFollows the pattern of `Bamtan.Object.accessor`, but defines the accessor on the class (constructor) instead of on instances of the object.\n\n    test '@classAccessor defines an accessor on the class', ->\n      class WayneManor extends Batman.Object\n        @classAccessor 'address', -> \"123 Wayne Dr.\"\n\n      equal WayneManor.get('address'), \"123 Wayne Dr.\"\n      # Wayne Manor burned down...\n      equal (new WayneManor(isRebuilt: true)).constructor.get('address'), \"123 Wayne Dr.\"\n\n## @mixin(objects...) : prototype\n\nMixes in `objects` to the `Object`'s prototype. Keys from `objects` are applied with `set`. If any of `objects` has an `initialize` function, it will be called with the prototype being mixed into.\n\n_Note_: `@mixin`, similar to `@accessor`, applies to all instances of a class. If you need to mix in to the class itself, look at `classMixin`. `@mixin` is intended for use during the class definition of a `Batman.Object` subclass.\n\n    test '@mixin extends the prototype of a Batman.Object subclass', ->\n      FishBehaviour =\n        canBreatheUnderwater: true\n      MammalBehaviour =\n        initialize: ->\n          @set('isMammal', true)\n        canBreatheAboveWater: true\n\n      class Platypus extends Batman.Object\n        @mixin FishBehaviour, MammalBehaviour\n\n      platypus = new Platypus\n      ok platypus.get('isMammal'), \"the initialize function is called with the target prototype\"\n      ok platypus.get('canBreatheAboveWater')\n      ok platypus.get('canBreatheUnderwater')\n\n## @classMixin(objects...) : this\n\n`@classMixin` mixes `objects` into the class (constructor) in the same way that `@mixin` mixes into the prototype.\n\n    test '@classMixin extends the Batman.Object subclass', ->\n      Singleton =\n        initialze: (subject) ->\n          subject.accessor 'instance', -> new subject\n\n      class Highlander extends Batman.Object\n        @classMixin Singleton\n\n      instance = Highlander.get('instance')\n      ok instance == Highlander.get('instance'), \"There can only be one.\"\n\n## @observeAll(key, callback : function) : prototype\n\n`@observeAll` extends the `Batman.Object` implementation of `Batman.Observable` with the ability to observe all instances of the class (and subclasses). Observers attached with `@observeAll` function exactly as if they were attached to the object directly. Returns the prototype of the class.\n\n_Note_: `@observeAll` is intended to be used during the class definition for a `Batman.Object` subclass, but it can be called after the class has been defined as a function on the class. It supports being called after instances of the class have been instantiated as well.\n\n    test \"@observeAll attaches handlers which get called upon change\", ->\n      results = []\n      class Song extends Batman.Object\n        @observeAll 'length', (newValue, oldValue) -> results.push newValue\n\n      song = new Song({length: 340, bpm: 120})\n      equal song.set('length', 200), 200\n      deepEqual results[1], 200\n\n    test \"@observeAll can attach handlers after instance instantiation\", ->\n      results = []\n      class Song extends Batman.Object\n\n      song = new Song({length: 340, bpm: 120})\n      equal song.set('length', 360), 360\n      deepEqual results[0], undefined\n      Song.observeAll 'length', (newValue, oldValue) -> results.push newValue\n      equal song.set('length', 200), 200\n      deepEqual results[0], 200\n\n## @delegate(properties..., options)\n\nDelegates `properties` to `options.to` by creating new accessors for `properties` which call `to.get(property)`. `options` must include a `to` Object.\n\n## @singleton(singletonMethodName[=\"sharedInstance\"])\n\nShorthand for [singleton classes](http:\/\/en.wikipedia.org\/wiki\/Singleton_pattern). Defines a class accessor `singletonMethodName` which returns the singleton instance.\n\n## @wrapAccessor([keys...,] wrapperFunction: Function)\n\nDefines a *wrap accessor* for the given keys. These accessors are intended to\nextend an existing accessor or property by wrapping calls to `get`\/`set`\/`unset`.\n\n`wrapperFunction` is called immediately, and should return an object with the\nsame format as an accessor definition. It is passed an object that represents\nthe original accessor being wrapped, called `core`.\n\nSome trivial examples:\n\n    test \"@wrapAccessor can be used to extend get functionality\", ->\n      class Product extends Batman.Object\n        @wrapAccessor 'title', (core) ->\n          get: (key) -> 'Product ' + core.get.call(this, key) # Call the original get function.\n\n      foo = new Product(title: 'Foo')\n      equal foo.get('title'), 'Product Foo'\n\n    test \"@wrapAccessor can be used to extend set functionality\", ->\n      class Product extends Batman.Object\n        @wrapAccessor 'title', (core) ->\n          set: (key, value) ->\n            core.set.call(this, key, value.toUpperCase()) # Call the original set function, with different arguments.\n\n      foo = new Product(title: 'Product Foo')\n      equal foo.get('title'), 'PRODUCT FOO'\n\nHere's a real-world example of a fairly common use-case.\n`Product` has a `handle`, which is the token used to identify the product in a\nURL. If the user hasn't set a custom handle, then the handle should be generated\nfrom the title. If they do set a custom handle, then changes to the title should\nnot affect the handle.\n\n    test \"@wrapAccessor makes custom shit woohoo\", ->\n      handleize = (value) -> value?.toLowerCase().replace(\/\\W+\/g, '-')\n\n      class Product extends Batman.Object\n        @wrapAccessor 'handle', (core) ->\n          get: -> core.get.apply(@, arguments) || handleize(@get('title'))\n\n        @wrapAccessor 'title', (core) ->\n          set: (key, value) ->\n            if @get('handle') == handleize(@get('title'))\n              @set('handle', handleize(value))\n\n            core.set.call(this, key, value)\n\n      foo = new Product(title: 'Product Foo!!')\n      equal foo.get('handle'), 'product-foo-' # Handle is automatically set.\n\n      foo.set('title', 'Product Bar')\n      equal foo.get('handle'), 'product-bar' # Handle is automatically set again.\n\n      foo.set('handle', 'custom-handle') # User defines a custom handle for this product...\n      foo.set('title', 'Product Foo!!')\n      equal foo.get('handle'), 'custom-handle' # so now it's not automatically set.\n\n`@wrapAccessor` may be called with no keys to wrap *all* accessors.\n\n## @wrapClassAccessor([keys...,] wrapperFunction: Function )\n\nLike `@wrapAccessor`, but to wrap a class-level accessor.\n\n## ::wrapAccessor([keys...,] wrapperFunction)\n\nLike `@wrapAccessor`, but wraps an accessor on a single instance.\n\n## ::constructor(objects...) : Object\n\nCreates a new `Batman.Object` with properties from `objects`. If items in `objects` have the same keys, later values take precendence over earlier ones. Values are applied with `set`, so custom accessors are applied. The `Batman` namespace performs the same function.\n\n    test 'Batman() function allows for handy creation of Batman.Objects', ->\n      object = Batman(foo: 'bar')\n      equal typeof object.get, 'function'\n\n    test 'Batman.Object constructor function accepts multiple mixin arguments and later mixins take precedence.', ->\n      song = Batman({length: 100, bpm: 120}, {bpm: 130})\n      equal song.get('length'), 100\n      equal song.get('bpm'), 130, \"The property from the second object passed to the constructor overwrites that from the first.\"\n\n## ::toJSON() : object\n\n`toJSON` returns a vanilla JavaScript object representing this `Batman.Object`.\n\n    test 'toJSON returns a vanilla JS object', ->\n      object = Batman(foo: 'bar')\n      deepEqual object.toJSON(), {foo: 'bar'}\n\n## ::hashKey() : string\n\nReturns a unique string identifying this `Batman.Object`.\n\n## ::batchAccessorChanges(key, wrappedFunction)\n\nPrevents accessor `key` from being recalculated while the `wrappedFunction` is called on the `Object`. After `wrappedFunction` is complete, the accessor will be recomputed. Returns the result of `wrappedFunction`.\n\n\n## ::accessor([keys...], objectOrFunction)\n\n`accessor` defines an accessor on one instance of an object instead of on all instances like the class level `@accessor`. See `@accessor` for the details surrounding accessors.\n\n    test 'accessor can be called on an instance of Batman.Object to define an accessor just on that instance', ->\n      class Post extends Batman.Object\n        @accessor 'summary', -> @get('body').slice(0, 10) + \"...\"\n\n      post = new Post(body: \"Why Batman is Useful: A lengthy post on an important subject\")\n      equal post.get('summary'), \"Why Batman...\"\n      post.accessor('longSummary', -> @get('body').slice(0, 20) + \"...\")  # \"Instance level accessor defines accessors just for that instance\"\n      equal post.get('longSummary'), \"Why Batman is Useful...\"\n\n    test 'defining an accessor on an instance does not affect the other instances', ->\n      class Post extends Batman.Object\n\n      post = new Post(body: \"Why Batman is Useful: A lengthy post on an important subject\")\n      otherPost = new Post(body: \"Why State Machines Are Useful: Another lengthy post\")\n      post.accessor 'longSummary', -> @get('body').slice(0, 20) + \"...\"\n      equal post.get('longSummary'), \"Why Batman is Useful...\"\n      equal otherPost.get('longSummary'), undefined\n\n## ::mixin(objects...) : this\n\nMixes `objects` into the `Object` instance. Keys from `objects` are applied with `set`. If any of `objects` has an `initialize` function, it will be called with the prototype being mixed into.\n\n\n    test 'mixin on an instance applies the keys from the mixed in object to the instance', ->\n      class Snake extends Batman.Object\n\n      snake = new Snake()\n      snake.mixin {canSlither: true}, {canHiss: true}\n      ok snake.get('canSlither')\n      ok snake.get('canHiss')\n","old_contents":"# \/api\/Data Structures\/Batman.Object\n\n`Batman.Object` is the superclass for virtually all objects in a batman.js application. `Batman.Object` mixes in:\n\n- `Batman.Observable` for `get`, `set`, `observe` and others\n- `Batman.EventEmitter` for `on`, `off`, `fire` and others\n\nSee [`Batman.Object Accessors`](\/docs\/api\/batman.object_accessors.html) for a full description of `@accessor`, which defines properties on `Batman.Object`s.\n\n\n## @accessor([keys...], objectOrFunction)\n\nIf `keys` is empty, defines a new default accessor for instances of the object, otherwise defines a new accessor on instances of the `Object` for `keys`.\n\n`objectOrFunction` may be:\n\n- An object with `get`, `set`, and\/or `unset` keys whose values are functions which implement those operations.\n- A function which will be treated as the `get` key of the accessor object.\n\n## @classAccessor([keys...], objectOrFunction)\n\nFollows the pattern of `Bamtan.Object.accessor`, but defines the accessor on the class (constructor) instead of on instances of the object.\n\n    test '@classAccessor defines an accessor on the class', ->\n      class WayneManor extends Batman.Object\n        @classAccessor 'address', -> \"123 Wayne Dr.\"\n\n      equal WayneManor.get('address'), \"123 Wayne Dr.\"\n      # Wayne Manor burned down...\n      equal (new WayneManor(isRebuilt: true)).constructor.get('address'), \"123 Wayne Dr.\"\n\n## @mixin(objects...) : prototype\n\nMixes in `objects` to the `Object`'s prototype. Keys from `objects` are applied with `set`. If any of `objects` has an `initialize` function, it will be called with the prototype being mixed into.\n\n_Note_: `@mixin`, similar to `@accessor`, applies to all instances of a class. If you need to mix in to the class itself, look at `classMixin`. `@mixin` is intended for use during the class definition of a `Batman.Object` subclass.\n\n    test '@mixin extends the prototype of a Batman.Object subclass', ->\n      FishBehaviour =\n        canBreatheUnderwater: true\n      MammalBehaviour =\n        initialize: ->\n          @set('isMammal', true)\n        canBreatheAboveWater: true\n\n      class Platypus extends Batman.Object\n        @mixin FishBehaviour, MammalBehaviour\n\n      platypus = new Platypus\n      ok platypus.get('isMammal'), \"the initialize function is called with the target prototype\"\n      ok platypus.get('canBreatheAboveWater')\n      ok platypus.get('canBreatheUnderwater')\n\n## @classMixin(objects...) : this\n\n`@classMixin` mixes `objects` into the class (constructor) in the same way that `@mixin` mixes into the prototype.\n\n    test '@classMixin extends the Batman.Object subclass', ->\n      Singleton =\n        initialze: (subject) ->\n          subject.accessor 'instance', -> new subject\n\n      class Highlander extends Batman.Object\n        @classMixin Singleton\n\n      instance = Highlander.get('instance')\n      ok instance == Highlander.get('instance'), \"There can only be one.\"\n\n## @observeAll(key, callback : function) : prototype\n\n`@observeAll` extends the `Batman.Object` implementation of `Batman.Observable` with the ability to observe all instances of the class (and subclasses). Observers attached with `@observeAll` function exactly as if they were attached to the object directly. Returns the prototype of the class.\n\n_Note_: `@observeAll` is intended to be used during the class definition for a `Batman.Object` subclass, but it can be called after the class has been defined as a function on the class. It supports being called after instances of the class have been instantiated as well.\n\n    test \"@observeAll attaches handlers which get called upon change\", ->\n      results = []\n      class Song extends Batman.Object\n        @observeAll 'length', (newValue, oldValue) -> results.push newValue\n\n      song = new Song({length: 340, bpm: 120})\n      equal song.set('length', 200), 200\n      deepEqual results[1], 200\n\n    test \"@observeAll can attach handlers after instance instantiation\", ->\n      results = []\n      class Song extends Batman.Object\n\n      song = new Song({length: 340, bpm: 120})\n      equal song.set('length', 360), 360\n      deepEqual results[0], undefined\n      Song.observeAll 'length', (newValue, oldValue) -> results.push newValue\n      equal song.set('length', 200), 200\n      deepEqual results[0], 200\n\n## @delegate(properties..., options)\n\nDelegates `properties` to `options.to` by creating new accessors for `properties` which call `to.get(property)`. `options` must include a `to` Object.\n\n## @singleton(singletonMethodName[=\"sharedInstance\"])\n\nShorthand for [singleton classes](http:\/\/en.wikipedia.org\/wiki\/Singleton_pattern). Defines a class accessor `singletonMethodName` which returns the singleton instance.\n\n## @wrapAccessor([keys...,] wrapperFunction: Function)\n## @wrapClassAccessor([keys...,] wrapperFunction: Function )\n## ::wrapAccessor([keys...,] wrapperFunction)\n\n## ::constructor(objects...) : Object\n\nCreates a new `Batman.Object` with properties from `objects`. If items in `objects` have the same keys, later values take precendence over earlier ones. Values are applied with `set`, so custom accessors are applied. The `Batman` namespace performs the same function.\n\n    test 'Batman() function allows for handy creation of Batman.Objects', ->\n      object = Batman(foo: 'bar')\n      equal typeof object.get, 'function'\n\n    test 'Batman.Object constructor function accepts multiple mixin arguments and later mixins take precedence.', ->\n      song = Batman({length: 100, bpm: 120}, {bpm: 130})\n      equal song.get('length'), 100\n      equal song.get('bpm'), 130, \"The property from the second object passed to the constructor overwrites that from the first.\"\n\n## ::toJSON() : object\n\n`toJSON` returns a vanilla JavaScript object representing this `Batman.Object`.\n\n    test 'toJSON returns a vanilla JS object', ->\n      object = Batman(foo: 'bar')\n      deepEqual object.toJSON(), {foo: 'bar'}\n\n## ::hashKey() : string\n\nReturns a unique string identifying this `Batman.Object`.\n\n## ::batchAccessorChanges(key, wrappedFunction)\n\nPrevents accessor `key` from being recalculated while the `wrappedFunction` is called on the `Object`. After `wrappedFunction` is complete, the accessor will be recomputed. Returns the result of `wrappedFunction`.\n\n\n## ::accessor([keys...], objectOrFunction)\n\n`accessor` defines an accessor on one instance of an object instead of on all instances like the class level `@accessor`. See `@accessor` for the details surrounding accessors.\n\n    test 'accessor can be called on an instance of Batman.Object to define an accessor just on that instance', ->\n      class Post extends Batman.Object\n        @accessor 'summary', -> @get('body').slice(0, 10) + \"...\"\n\n      post = new Post(body: \"Why Batman is Useful: A lengthy post on an important subject\")\n      equal post.get('summary'), \"Why Batman...\"\n      post.accessor('longSummary', -> @get('body').slice(0, 20) + \"...\")  # \"Instance level accessor defines accessors just for that instance\"\n      equal post.get('longSummary'), \"Why Batman is Useful...\"\n\n    test 'defining an accessor on an instance does not affect the other instances', ->\n      class Post extends Batman.Object\n\n      post = new Post(body: \"Why Batman is Useful: A lengthy post on an important subject\")\n      otherPost = new Post(body: \"Why State Machines Are Useful: Another lengthy post\")\n      post.accessor 'longSummary', -> @get('body').slice(0, 20) + \"...\"\n      equal post.get('longSummary'), \"Why Batman is Useful...\"\n      equal otherPost.get('longSummary'), undefined\n\n## ::mixin(objects...) : this\n\nMixes `objects` into the `Object` instance. Keys from `objects` are applied with `set`. If any of `objects` has an `initialize` function, it will be called with the prototype being mixed into.\n\n\n    test 'mixin on an instance applies the keys from the mixed in object to the instance', ->\n      class Snake extends Batman.Object\n\n      snake = new Snake()\n      snake.mixin {canSlither: true}, {canHiss: true}\n      ok snake.get('canSlither')\n      ok snake.get('canHiss')\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6d20980f09639241eb5c4c1cea6c7759215515cd","subject":"Add link from main spec to pluralize tests","message":"Add link from main spec to pluralize tests\n","repos":"ygt-mikekchar\/react-maybe-matchers,ygt-mikekchar\/react-maybe-matchers","old_file":"spec\/spec.litcoffee","new_file":"spec\/spec.litcoffee","new_contents":"react-maybe-matchers was built to write tests for another project.\nThe tests for the other project worked as a framework for testing\nthe matchers.  As such, the specs in this project have lagged behind.\nI will try to update some realistic integration tests as soon\nas possible.\n\nOne of the problems with integration tests is that you can't write\ntests for failing matchers.  This project is unfortunately missing\nany unit tests (high up on my priority list).\n\n## Integration tests\n\nIn the [integration tests](.\/spec\/integration_spec.litcoffee) you\nwill find examples of how to use the matchers.\n\n    require(\".\/integration_spec.litcoffee\")\n\n## String#pluralize unit tests\n\nSome [examples of pluralizing strings](\".\/pluralize_spec.litcoffee\")\n\n    require(\".\/pluralize_spec.litcoffee\")\n","old_contents":"react-maybe-matchers was built to write tests for another project.\nThe tests for the other project worked as a framework for testing\nthe matchers.  As such, the specs in this project have lagged behind.\nI will try to update some realistic integration tests as soon\nas possible.\n\nOne of the problems with integration tests is that you can't write\ntests for failing matchers.  This project is unfortunately missing\nany unit tests (high up on my priority list).\n\n## Integration tests\n\nIn the [integration tests](.\/spec\/integration_spec.litcoffee) you\nwill find examples of how to use the matchers.\n\n    require(\".\/integration_spec.litcoffee\")\n\n## String#pluralize unit tests\n\n    require(\".\/pluralize_spec.litcoffee\")\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5d1d18276ab52018895c036d4d6973c28ba9dd00","subject":"Fix links in spec (again)","message":"Fix links in spec (again)\n","repos":"ygt-mikekchar\/react-maybe-matchers,ygt-mikekchar\/react-maybe-matchers","old_file":"spec\/spec.litcoffee","new_file":"spec\/spec.litcoffee","new_contents":"# Tests for react-maybe-matchers\n\nreact-maybe-matchers was built to write tests for another project.\nThe tests for the other project worked as a framework for testing\nthe matchers.  As such, the specs in this project have lagged behind.\nI will try to update some realistic integration tests as soon\nas possible.\n\nOne of the problems with integration tests is that you can't write\ntests for failing matchers.  This project is unfortunately missing\nany unit tests (high up on my priority list).\n\n## Integration tests\n\nIn the [integration tests](.\/integration_spec.litcoffee#integration-tests) you\nwill find examples of how to use the matchers.\n\n    require(\".\/integration_spec.litcoffee\")\n\n## String#pluralize unit tests\n\nSome [examples of pluralizing strings](.\/pluralize_spec.litcoffee#unit-tests-for-stringpluralize)\n\n    require(\".\/pluralize_spec.litcoffee\")\n","old_contents":"# Tests for react-maybe-matchers\n\nreact-maybe-matchers was built to write tests for another project.\nThe tests for the other project worked as a framework for testing\nthe matchers.  As such, the specs in this project have lagged behind.\nI will try to update some realistic integration tests as soon\nas possible.\n\nOne of the problems with integration tests is that you can't write\ntests for failing matchers.  This project is unfortunately missing\nany unit tests (high up on my priority list).\n\n## Integration tests\n\nIn the [integration tests](.\/spec\/integration_spec.litcoffee#integration-tests) you\nwill find examples of how to use the matchers.\n\n    require(\".\/integration_spec.litcoffee\")\n\n## String#pluralize unit tests\n\nSome [examples of pluralizing strings](\".\/pluralize_spec.litcoffee#unit-tests-for-stringpluralize\")\n\n    require(\".\/pluralize_spec.litcoffee\")\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f377b8635d8562ed5306282e5bcf517b8b3deda5","subject":"Beauty","message":"Beauty\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"client\/app.litcoffee","new_file":"client\/app.litcoffee","new_contents":"\n# Application entry point.\n\n*Definition of the main top-level Angular module, with dependency gathering\nand config\/run hook invocation.*\n\nTop-level module.\n\n    angular.module 'shrub', ['shrub.core']\n\nInclude core Angular dependencies.\n\n    coreDependencies = []\n    coreDependencies.push 'ngRoute'\n    coreDependencies.push 'ngSanitize'\n\n`packageDependencies` will be automatically generated and populated by Grunt.\nPackages implement the hook `angularPackageDependencies` to specify their\n3rd-party module dependencies.\n\n###### TODO: Link this to where this happens in Grunt for illustration.\n\n    coreDependencies.push packageDependencies...\n\nInclude core shrub dependencies.\n\n    coreDependencies.push 'shrub.config'\n    coreDependencies.push 'shrub.packages'\n    coreDependencies.push 'shrub.require'\n\nDefine the core Shrub module.\n\n    angular.module('shrub.core', coreDependencies)\n\n      .config([\n        '$injector', 'shrub-pkgmanProvider'\n        ({invoke}, {invokeFlat}) ->\n\n#### Invoke hook `appConfig`.\n\nInvoked when the Angular application is in the configuration phase.\nImplementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          invoke injectable for injectable in invokeFlat 'appConfig'\n\n      ])\n\n      .run([\n\n        '$injector', 'shrub-pkgman'\n        ({invoke}, {invokeFlat}) ->\n\n#### Invoke hook `appRun`.\n\nInvoked when the Angular application is the run phase. Implementations should\nreturn an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          invoke injectable for injectable in invokeFlat 'appRun'\n\n      ])\n","old_contents":"\n# Application entry point.\n\nTop-level module.\n\n    angular.module 'shrub', ['shrub.core']\n\nInclude core Angular dependencies.\n\n    coreDependencies = []\n    coreDependencies.push 'ngRoute'\n    coreDependencies.push 'ngSanitize'\n\n`packageDependencies` will be automatically generated and populated by Grunt.\nPackages implement the hook `angularPackageDependencies` to specify their\n3rd-party module dependencies.\n\n###### TODO: Link this to where this happens in Grunt for illustration.\n\n    coreDependencies.push packageDependencies...\n\nInclude core shrub dependencies.\n\n    coreDependencies.push 'shrub.config'\n    coreDependencies.push 'shrub.packages'\n    coreDependencies.push 'shrub.require'\n\nDefine the core Shrub module.\n\n    angular.module('shrub.core', coreDependencies)\n\n      .config([\n        '$injector', 'shrub-pkgmanProvider'\n        ({invoke}, {invokeFlat}) ->\n\n#### Invoke hook `appConfig`.\n\nInvoked when the Angular application is in the configuration phase.\nImplementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          invoke injectable for injectable in invokeFlat 'appConfig'\n\n      ])\n\n      .run([\n\n        '$injector', 'shrub-pkgman'\n        ({invoke}, {invokeFlat}) ->\n\n#### Invoke hook `appRun`.\n\nInvoked when the Angular application is the run phase. Implementations should\nreturn an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          invoke injectable for injectable in invokeFlat 'appRun'\n\n      ])\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ef85e01b6d43ee5b871e3ee5d7649194514df704","subject":"Using the methods fixed for https:\/\/github.com\/o2platform\/fluentnode\/issues\/68 on http json calls","message":"Using the methods fixed for https:\/\/github.com\/o2platform\/fluentnode\/issues\/68 on http json calls\n","repos":"modulexcite\/fluentnode,o2platform\/fluentnode,modulexcite\/fluentnode,o2platform\/fluentnode","old_file":"src\/http.litcoffee","new_file":"src\/http.litcoffee","new_contents":"dependencies\n\n    http  = require('http')\n    https = require('https');\n    url   = require('url')\n    Server = http.Server\n\nsettings\n\n    global.__fluentnode ?= {}\n    global.__fluentnode.http ?= {}\n    using global.__fluentnode.http, ->\n      @.HTTP_GET_TIMEOUT = 500\n      @.HTTP_GET_DELAY   = 10\n\n**Server::add_Sockets_Close_Suport**\n\n    Server::add_Sockets_Close_Suport = ()->\n      #add support for capturing and closing open sockets\n      @._sockets = {}\n      @._socket_Count = 0;\n      @.on 'connection',  (socket)=>\n        socket_id = @._socket_Count++\n        @._sockets[socket_id] = socket\n\n        socket.on 'close',  ()=>\n          delete @._sockets[socket_id];\n      @\n\n    Server::close_And_Destroy_Sockets = (callback)->\n      if (@._sockets != undefined)                    # if this was set, destroy open sockets\n        for socket_Id of @._sockets\n            @._sockets[socket_Id].destroy()\n            delete @._sockets[socket_Id];\n      @.close ->\n        callback()\n\n    Server::listen_OnPort_Saying = (port, text, callback)->\n      ip = '127.0.0.1'\n      @.respond_With_String_As_Text(text)\n       .add_Sockets_Close_Suport()\n       .listen port, ip, ->\n          callback()\n\n    Server::respond_With_Request_Headers = (value)->\n      delete @._events.request\n      simple_Response = (req, res) ->\n        res.writeHead(200, {'Content-Type': 'application\/json'})\n        res.end(req.headers.json_Str())\n      @.addListener('request', simple_Response)\n      @\n\n    Server::respond_With_String_As_Text = (value)->\n      delete @._events.request                                # removes previous listeners\n      simple_Response = (req, res) ->\n          res.writeHead(200, {'Content-Type': 'text\/plain'})\n          res.end(value)\n      @.addListener('request', simple_Response)\n      @\n\n    Server::respond_With_Object_As_Json = (value)->\n      delete @._events.request\n      json_Response = (req, res) ->\n        res.writeHead(200, {'Content-Type': 'application\/json'})\n        res.end(value.json_Str())\n      @.addListener('request', json_Response)\n      @\n\n    Server::respond_With_Request_Object = ()->\n      delete @._events.request\n      json_Response = (req, res) ->\n        res.writeHead(200, {'Content-Type': 'application\/json'})\n        res.end(req.json_Inspect())                           # unfortunatly there doesn't seem to be a way to create a JSON parseable object from req\n      @.addListener('request', json_Response)\n      @\n\n    String::http_Status = (callback) ->\n      http.get @.str(), (res) ->\n        callback res.statusCode\n\n    String::http_GET = (callback) ->\n      url = url.parse(@.str())\n      engine = if url.protocol is 'https:' then https else http\n      req = engine.get @.str(), (res) ->\n        data = '';\n        res.on 'data', (chunk) -> data += chunk\n        res.on 'end' , (     ) -> callback null, data, res\n\n      req.on   'error',(err  ) ->\n        callback err, null, null\n      req\n\n    String::GET = (callback) ->\n      @.http_GET (error, data, res)-> callback(data)\n\n\n@.**GET_Json**\n@.**json_GET**\n\nMakes a GET request to @ and JSON parses the html data received\n\nWill throw an error if the returned data is not a valid JSON objec\n\nTwin methods: json_GET\n\n    String::GET_Json = (callback) ->\n      @.http_GET (error, data, res)-> callback(data.json_Parse())\n\n    String::json_GET = String::GET_Json\n\n@.**json_GET_With_Timeout**\n\nMakes a GET request (with a 500ms wait for valid data),\nand JSON parses the html data received\n\n    String::json_GET_With_Timeout = (callback)->\n      @.http_GET_With_Timeout (data)->\n        callback data.json_Parse()\n\n\n@.**http_GET_Wait_For_Null**\n\nWaits until a GET request to @ results null (or empty)\n\nThis is a good util method to check when servers go offline\n\n    String::http_GET_Wait_For_Null = (callback)->\n      timeout  = global.__fluentnode.http.HTTP_GET_TIMEOUT\n      delay    = global.__fluentnode.http.HTTP_GET_DELAY\n      attempts = ~~(timeout\/delay)\n      try_Http_Get = (next) =>\n        @.GET (data)  =>\n          if data\n            next.invoke_In(delay)\n          else\n            callback(null)\n      run_Tests = (count)=>\n        if count\n          try_Http_Get ()->\n            run_Tests(count-1)\n        else\n          callback new Error(\"[http_GET_Wait_For_Null] never got a null from server #{@} after #{attempts} attempts\")\n\n      run_Tests(attempts)\n\n\n@.**http_GET_With_Timeout**\n\nMakes a GET request (with a 500ms wait for valid data)\n\n    String::http_GET_With_Timeout = (callback)->\n      timeout = global.__fluentnode.http.HTTP_GET_TIMEOUT\n      delay   = global.__fluentnode.http.HTTP_GET_DELAY\n      attempts = ~~(timeout\/delay)\n      try_Http_Get = (next) =>\n        @.GET (data) =>\n          if data\n            callback(data)\n          else\n            (delay).invoke_After(next)\n      run_Tests = (count)=>\n        if count\n          try_Http_Get ()->\n            run_Tests(count-1)\n        else\n          callback null\n\n      run_Tests attempts\n\n\n    String::http_With_Options = (options, callback) ->\n      url = url.parse(@.str())\n      engine = if url.protocol is 'https:' then https else http\n      options.hostname = options.hostname || url.hostname\n      options.port     = options.port     || url.port\n      options.path     = options.path     || url.path\n      options.method   = options.method   || 'GET'\n\n      req = engine.get options, (res) ->\n        data = '';\n        res.on 'data', (chunk) -> data += chunk\n        res.on 'end' , (     ) -> callback null, data, res\n\n      req.on   'error',(err  ) ->\n        callback err, null, null\n      req\n\n\n    ###options =\n        hostname: @,\n        port: port,\n        path: '\/',\n        method: 'GET'\n        console.log @.str()###\n\n---\nback to [index](index.html)\n","old_contents":"dependencies\n\n    http  = require('http')\n    https = require('https');\n    url   = require('url')\n    Server = http.Server\n\nsettings\n\n    global.__fluentnode ?= {}\n    global.__fluentnode.http ?= {}\n    using global.__fluentnode.http, ->\n      @.HTTP_GET_TIMEOUT = 500\n      @.HTTP_GET_DELAY   = 10\n\n**Server::add_Sockets_Close_Suport**\n\n    Server::add_Sockets_Close_Suport = ()->\n      #add support for capturing and closing open sockets\n      @._sockets = {}\n      @._socket_Count = 0;\n      @.on 'connection',  (socket)=>\n        socket_id = @._socket_Count++\n        @._sockets[socket_id] = socket\n\n        socket.on 'close',  ()=>\n          delete @._sockets[socket_id];\n      @\n\n    Server::close_And_Destroy_Sockets = (callback)->\n      if (@._sockets != undefined)                    # if this was set, destroy open sockets\n        for socket_Id of @._sockets\n            @._sockets[socket_Id].destroy()\n            delete @._sockets[socket_Id];\n      @.close ->\n        callback()\n\n    Server::listen_OnPort_Saying = (port, text, callback)->\n      ip = '127.0.0.1'\n      @.respond_With_String_As_Text(text)\n       .add_Sockets_Close_Suport()\n       .listen port, ip, ->\n          callback()\n\n    Server::respond_With_Request_Headers = (value)->\n      delete @._events.request\n      simple_Response = (req, res) ->\n        res.writeHead(200, {'Content-Type': 'application\/json'})\n        res.end(JSON.stringify(req.headers))\n      @.addListener('request', simple_Response)\n      @\n\n    Server::respond_With_String_As_Text = (value)->\n      delete @._events.request                                # removes previous listeners\n      simple_Response = (req, res) ->\n          res.writeHead(200, {'Content-Type': 'text\/plain'})\n          res.end(value)\n      @.addListener('request', simple_Response)\n      @\n\n    Server::respond_With_Object_As_Json = (value)->\n      delete @._events.request\n      json_Response = (req, res) ->\n        res.writeHead(200, {'Content-Type': 'application\/json'})\n        res.end(JSON.stringify(value))\n      @.addListener('request', json_Response)\n      @\n\n    Server::respond_With_Request_Object = ()->\n      delete @._events.request\n      json_Response = (req, res) ->\n        res.writeHead(200, {'Content-Type': 'application\/json'})\n        res.end(req.json_inspect())                           # unfortunatly there doesn't seem to be a way to create a JSON parseable object from req\n      @.addListener('request', json_Response)\n      @\n\n    String::http_Status = (callback) ->\n      http.get @.str(), (res) ->\n        callback res.statusCode\n\n    String::http_GET = (callback) ->\n      url = url.parse(@.str())\n      engine = if url.protocol is 'https:' then https else http\n      req = engine.get @.str(), (res) ->\n        data = '';\n        res.on 'data', (chunk) -> data += chunk\n        res.on 'end' , (     ) -> callback null, data, res\n\n      req.on   'error',(err  ) ->\n        callback err, null, null\n      req\n\n    String::GET = (callback) ->\n      @.http_GET (error, data, res)-> callback(data)\n\n\n@.**GET_Json**\n@.**json_GET**\n\nMakes a GET request to @ and JSON parses the html data received\n\nWill throw an error if the returned data is not a valid JSON objec\n\nTwin methods: json_GET\n\n    String::GET_Json = (callback) ->\n      @.http_GET (error, data, res)-> callback(JSON.parse(data))\n\n    String::json_GET = String::GET_Json\n\n@.**json_GET_With_Timeout**\n\nMakes a GET request (with a 500ms wait for valid data),\nand JSON parses the html data received\n\n    String::json_GET_With_Timeout = (callback)->\n      @.http_GET_With_Timeout (data)->\n        callback data.json_Parse()\n\n\n@.**http_GET_Wait_For_Null**\n\nWaits until a GET request to @ results null (or empty)\n\nThis is a good util method to check when servers go offline\n\n    String::http_GET_Wait_For_Null = (callback)->\n      timeout  = global.__fluentnode.http.HTTP_GET_TIMEOUT\n      delay    = global.__fluentnode.http.HTTP_GET_DELAY\n      attempts = ~~(timeout\/delay)\n      try_Http_Get = (next) =>\n        @.GET (data)  =>\n          if data\n            next.invoke_In(delay)\n          else\n            callback(null)\n      run_Tests = (count)=>\n        if count\n          try_Http_Get ()->\n            run_Tests(count-1)\n        else\n          callback new Error(\"[http_GET_Wait_For_Null] never got a null from server #{@} after #{attempts} attempts\")\n\n      run_Tests(attempts)\n\n\n@.**http_GET_With_Timeout**\n\nMakes a GET request (with a 500ms wait for valid data)\n\n    String::http_GET_With_Timeout = (callback)->\n      timeout = global.__fluentnode.http.HTTP_GET_TIMEOUT\n      delay   = global.__fluentnode.http.HTTP_GET_DELAY\n      attempts = ~~(timeout\/delay)\n      try_Http_Get = (next) =>\n        @.GET (data) =>\n          if data\n            callback(data)\n          else\n            (delay).invoke_After(next)\n      run_Tests = (count)=>\n        if count\n          try_Http_Get ()->\n            run_Tests(count-1)\n        else\n          callback null\n\n      run_Tests attempts\n\n\n    String::http_With_Options = (options, callback) ->\n      url = url.parse(@.str())\n      engine = if url.protocol is 'https:' then https else http\n      options.hostname = options.hostname || url.hostname\n      options.port     = options.port     || url.port\n      options.path     = options.path     || url.path\n      options.method   = options.method   || 'GET'\n\n      req = engine.get options, (res) ->\n        data = '';\n        res.on 'data', (chunk) -> data += chunk\n        res.on 'end' , (     ) -> callback null, data, res\n\n      req.on   'error',(err  ) ->\n        callback err, null, null\n      req\n\n\n    ###options =\n        hostname: @,\n        port: port,\n        path: '\/',\n        method: 'GET'\n        console.log @.str()###\n\n---\nback to [index](index.html)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"1a5fa2924ed278c3c22dca109750608b13cad9ad","subject":"combine bit field values","message":"combine bit field values\n","repos":"nickfargo\/restate","old_file":"src\/state.litcoffee","new_file":"src\/state.litcoffee","new_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneMethods    _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneMethods = ( methods ) ->\n          return unless methods?\n          ( out = {}; break ) for name of methods\n          if out then for name, method of methods\n            out[ name ] = if method.isLexicalStateMethod\n            then method.factory\n            else method\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: [`createAccessor`][]\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: [`set`][]\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method held on this state. If no method is found, move up\nthis state\u2019s protostate chain to find one. If no method is found there, move up\nthe superstate chain and repeat the search.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out ) ->\n        if ( method = @_?.methods?[ methodName ] ) and method isnt rootNoop\n          if out? then out.context = this; out.method = method\n          return method\n\n        if viaProto = via & VIA_PROTO and\n            method = @protostate()?.method methodName, VIA_PROTO, out\n          out?.context = this\n          return method\n\n        if via & VIA_SUPER and\n            method = @superstate?.method methodName, VIA_SUPER | viaProto, out\n          return method\n\n        if out? then out.context = null; out.method = method\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state, which will be callable directly from the owner,\nbut with its context bound to the state.\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn, raw ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` holds a lexical state method, then extract the wrapped method, unless\nexplicitly ordered to regard the function in its `raw` form.\n\n        fn = fn this if not raw and fn.isLexicalStateMethodFactory\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root.method methodName, VIA_NONE\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n\nThe owner method must be added to the root state in its \u201craw\u201d form, i.e., not\nlexically transformed by `state.method`.\n\n            root.addMethod methodName, ownerMethod, yes\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context. If the method\nwas originally defined in the owner, the context will be the owner. Otherwise,\nthe context will either be the state in which the method is defined, or if the\nimplementation resides in a protostate, the corresponding state belonging to\nthe inheriting owner. If the named method does not exist locally and cannot be\ninherited, a `noSuchMethod` event is emitted and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n        out = method: undefined, context: undefined\n        unless method = @method methodName, null, out\n          @emit 'noSuchMethod', [ methodName, args ]\n          @emit 'noSuchMethod:' + methodName, args\n          return\n        { context } = out\n        { owner } = this\n        ownerMethod = owner[ methodName ]\n        context = owner if ownerMethod?.original and context is @root\n        method.apply context, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic [`apply`][].\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n[`addEvent`][].\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","old_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & ( INCIPIENT | VIRTUAL )\n\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneMethods    _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneMethods = ( methods ) ->\n          return unless methods?\n          ( out = {}; break ) for name of methods\n          if out then for name, method of methods\n            out[ name ] = if method.isLexicalStateMethod\n            then method.factory\n            else method\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: [`createAccessor`][]\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: [`set`][]\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method held on this state. If no method is found, move up\nthis state\u2019s protostate chain to find one. If no method is found there, move up\nthe superstate chain and repeat the search.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out ) ->\n        if ( method = @_?.methods?[ methodName ] ) and method isnt rootNoop\n          if out? then out.context = this; out.method = method\n          return method\n\n        if viaProto = via & VIA_PROTO and\n            method = @protostate()?.method methodName, VIA_PROTO, out\n          out?.context = this\n          return method\n\n        if via & VIA_SUPER and\n            method = @superstate?.method methodName, VIA_SUPER | viaProto, out\n          return method\n\n        if out? then out.context = null; out.method = method\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state, which will be callable directly from the owner,\nbut with its context bound to the state.\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn, raw ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` holds a lexical state method, then extract the wrapped method, unless\nexplicitly ordered to regard the function in its `raw` form.\n\n        fn = fn this if not raw and fn.isLexicalStateMethodFactory\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root.method methodName, VIA_NONE\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n\nThe owner method must be added to the root state in its \u201craw\u201d form, i.e., not\nlexically transformed by `state.method`.\n\n            root.addMethod methodName, ownerMethod, yes\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context. If the method\nwas originally defined in the owner, the context will be the owner. Otherwise,\nthe context will either be the state in which the method is defined, or if the\nimplementation resides in a protostate, the corresponding state belonging to\nthe inheriting owner. If the named method does not exist locally and cannot be\ninherited, a `noSuchMethod` event is emitted and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n        out = method: undefined, context: undefined\n        unless method = @method methodName, null, out\n          @emit 'noSuchMethod', [ methodName, args ]\n          @emit 'noSuchMethod:' + methodName, args\n          return\n        { context } = out\n        { owner } = this\n        ownerMethod = owner[ methodName ]\n        context = owner if ownerMethod?.original and context is @root\n        method.apply context, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic [`apply`][].\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n[`addEvent`][].\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ecc1a6a3026feff78d76c46f8c2aab89e0df703f","subject":"modify","message":"modify\n","repos":"babascript\/babaspec","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"=======\nbabaspec: Test framework for human and real-world.\n========\n\n\ntest framework using babascript\n\n- \u4eba\u306e\u6319\u52d5\u3092\u8a18\u8ff0\u3059\u308bDSL Babascript\u3092\u5229\u7528\u3057\u305f\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af\n- \u4eba\u306e\u30b9\u30da\u30c3\u30af\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3057\u3001\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306b\u306a\u308b\n\n## Background\n\n- \u30d7\u30ed\u30b0\u30e9\u30e0\u304c\u3069\u306e\u3088\u3046\u306b\u52d5\u4f5c\u3059\u308b\u3079\u304d\u304b\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3059\u308b\u305f\u3081\u306b\u30c6\u30b9\u30c8\u304c\u5b58\u5728\u3059\u308b\u3002\n- \u30c6\u30b9\u30c8\u3092\u66f8\u304f\u3053\u3068\u306f\u30d7\u30ed\u30b0\u30e9\u30e0\u3092\u958b\u767a\u3057\u3066\u3044\u304f\u4e0a\u3067\u975e\u5e38\u306b\u6709\u7528\u3067\u3042\u308b\u3002\n- \u3057\u304b\u3057\u3001\u73fe\u72b6\u306e\u30c6\u30b9\u30c8\u306f\u30d7\u30ed\u30b0\u30e9\u30e0\u3092\u30c6\u30b9\u30c8\u3059\u308b\u3053\u3068\u3057\u304b\u3067\u304d\u306a\u3044\u3002\n- TODO: \u5b9f\u4e16\u754c\u3084\u4eba\u306b\u30c6\u30b9\u30c8\u624b\u6cd5\u3092\u9069\u5fdc\u3059\u308b\u610f\u5473\n\n- \u4eba\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u5b9a\u7fa9\u3057\u3001\u305d\u308c\u3092\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306a\u4ed5\u7d44\u307f\u306f\u306a\u3044\u3002\n- \u305d\u3053\u3067\u3001\u672c\u7814\u7a76\u3067\u306f\u3001\u4eba\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u5b9a\u7fa9\u3057\u3066\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306a\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af Babaspec \u3092\u63d0\u6848\u3059\u308b\u3002\n\n### \u4eba\u3084\u5b9f\u4e16\u754c\u3092\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3068\u4f55\u304c\u5b09\u3057\u3044\u306e\uff1f\n\n- \n\n\u30d7\u30ed\u30b0\u30e9\u30e0\u306f\u3001\u305d\u306e\u30d7\u30ed\u30b0\u30e9\u30e0\u304c\u3069\u306e\u3088\u3046\u306b\u52d5\u4f5c\u3059\u308b\u3079\u304d\u304b\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3057\u3001\u30c6\u30b9\u30c8\u3059\u308b\u3002\n\u30d7\u30ed\u30b0\u30e9\u30e0\u304c\u30c6\u30b9\u30c8\u3067\u304d\u308b\u5bfe\u8c61\u306f\u30d7\u30ed\u30b0\u30e9\u30e0\u306e\u307f\u3067\u3042\u308b\u304c\u3001\u4eba\u3084\u5b9f\u4e16\u754c\u3068\u3044\u3046\u8981\u7d20\u3092\u3082\u30c6\u30b9\u30c8\u3057\u305f\u3044\u306f\u305a\u3060\u3002\n\u3057\u304b\u3057\u3001\u4eba\u306e\u30b9\u30da\u30c3\u30af\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u5b9a\u7fa9\u3057\u3001\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306a\u4ed5\u7d44\u307f\u306f\u306a\u3044\u3002\n\u305d\u3053\u3067\u3001\u672c\u7814\u7a76\u3067\u306f\u3001\u4eba\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u5b9a\u7fa9\u3057\u3066\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306a\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af Babaspec \u3092\u63d0\u6848\u3059\u308b\u3002\n\n## Babaspec\n\nBabaspec\u306f\u3001\u4eba\u3078\u306e\u884c\u52d5\u547d\u4ee4\u3092\u30d7\u30ed\u30b0\u30e9\u30e0\u4e0a\u3067\u8a18\u8ff0\u53ef\u80fd\u306b\u3059\u308b Babascript \u3068 node.js\u4e0a\u3067\u5229\u7528\u53ef\u80fd\u306a\n\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af mocha \u3092\u7d44\u307f\u5408\u308f\u305b\u308b\u3002\n\n    describe \"baba spec test\", ->\n\n      it \"should return true\", ->\n\n        # \u4eba\u9593\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3059\u308b\n        baba = new Babaspec \"baba\"\n\n        baba.equal \"\u30d7\u30ed\u30b0\u30e9\u30e0\u304c\u66f8\u3051\u307e\u3059\u304b\", true # format is boolean\n        baba.notEqual \"hoge\", 'are' # format is string\n        baba.lt \"\u4f55\u6b73\u3067\u3059\u304b\", 20 # format is number\n        # fomat List \u306e\u5834\u5408\u3092\u3069\u3046\u3059\u308b\u304b\n        baba.equal baba.\u9078\u3093\u3067\u304f\u3060\u3055\u3044({formatL list, list: [1,2,3]}), [1,2] # format is list?\n\n        # \u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3059\u308b\n        world = new Babaspec \"real-world\", \"name\"\n        world.equal \"SFC\u306e\u3059\u3050\u8fd1\u304f\", true\n\n\n## \u8b70\u8ad6\n\n- \u672c\u5f53\u306b\u30c6\u30b9\u30c8\u3057\u305f\u3068\u8a00\u3044\u5207\u308c\u308b\u306e\u304b\uff1f \n\n## \u95a2\u9023\u7814\u7a76\n\n- \u4eba\u3068\u304b\u5b9f\u4e16\u754c\u3092\u30c6\u30b9\u30c8\u3059\u308b\u3088\u3046\u306a\u4ed5\u7d44\u307f\u3042\u308b\uff1f\n\n## \u304a\u308f\u308a\u306b","old_contents":"=======\nbabaspec: Test framework for human and real-world.\n========\n\n\ntest framework using babascript\n\n- \u4eba\u306e\u6319\u52d5\u3092\u8a18\u8ff0\u3059\u308bDSL Babascript\u3092\u5229\u7528\u3057\u305f\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af\n- \u4eba\u306e\u30b9\u30da\u30c3\u30af\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3057\u3001\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306b\u306a\u308b\n\n## Background\n\n\u30d7\u30ed\u30b0\u30e9\u30e0\u306f\u3001\u305d\u306e\u30d7\u30ed\u30b0\u30e9\u30e0\u304c\u3069\u306e\u3088\u3046\u306b\u52d5\u4f5c\u3059\u308b\u3079\u304d\u304b\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3057\u3001\u30c6\u30b9\u30c8\u3059\u308b\u3002\n\u30d7\u30ed\u30b0\u30e9\u30e0\u304c\u30c6\u30b9\u30c8\u3067\u304d\u308b\u5bfe\u8c61\u306f\u30d7\u30ed\u30b0\u30e9\u30e0\u306e\u307f\u3067\u3042\u308b\u304c\u3001\u4eba\u3084\u5b9f\u4e16\u754c\u3068\u3044\u3046\u8981\u7d20\u3092\u3082\u30c6\u30b9\u30c8\u3057\u305f\u3044\u306f\u305a\u3060\u3002\n\u3057\u304b\u3057\u3001\u4eba\u306e\u30b9\u30da\u30c3\u30af\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u5b9a\u7fa9\u3057\u3001\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306a\u4ed5\u7d44\u307f\u306f\u306a\u3044\u3002\n\u305d\u3053\u3067\u3001\u672c\u7814\u7a76\u3067\u306f\u3001\u4eba\u3084\u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u5b9a\u7fa9\u3057\u3066\u30c6\u30b9\u30c8\u3067\u304d\u308b\u3088\u3046\u306a\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af Babaspec \u3092\u63d0\u6848\u3059\u308b\u3002\n\n## Babaspec\n\nBabaspec\u306f\u3001\u4eba\u3078\u306e\u884c\u52d5\u547d\u4ee4\u3092\u30d7\u30ed\u30b0\u30e9\u30e0\u4e0a\u3067\u8a18\u8ff0\u53ef\u80fd\u306b\u3059\u308b Babascript \u3068 node.js\u4e0a\u3067\u5229\u7528\u53ef\u80fd\u306a\n\u30c6\u30b9\u30c8\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af mocha \u3092\u7d44\u307f\u5408\u308f\u305b\u308b\u3002\n\n    describe \"baba spec test\", ->\n\n      it \"should return true\", ->\n\n        # \u4eba\u9593\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3059\u308b\n        baba = new Babaspec \"baba\"\n\n        baba.equal \"\u30d7\u30ed\u30b0\u30e9\u30e0\u304c\u66f8\u3051\u307e\u3059\u304b\", true # format is boolean\n        baba.notEqual \"hoge\", 'are' # format is string\n        baba.lt \"\u4f55\u6b73\u3067\u3059\u304b\", 20 # format is number\n        # fomat List \u306e\u5834\u5408\u3092\u3069\u3046\u3059\u308b\u304b\n        baba.equal baba.\u9078\u3093\u3067\u304f\u3060\u3055\u3044({formatL list, list: [1,2,3]}), [1,2] # format is list?\n\n        # \u5b9f\u4e16\u754c\u306e\u30b9\u30da\u30c3\u30af\u3092\u8a18\u8ff0\u3059\u308b\n        world = new Babaspec \"real-world\", \"name\"\n        world.equal \"SFC\u306e\u3059\u3050\u8fd1\u304f\", true\n\n\n## \u8b70\u8ad6\n\n## \u95a2\u9023\u7814\u7a76\n\n- \u4eba\u3068\u304b\u5b9f\u4e16\u754c\u3092\u30c6\u30b9\u30c8\u3059\u308b\u3088\u3046\u306a\u4ed5\u7d44\u307f\u3042\u308b\uff1f\n\n## \u304a\u308f\u308a\u306b","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"462ef4fea3b90e4b31696d6cf2882650af237d19","subject":"Minor whitespaces change, clearer init of @farthest_right property","message":"Minor whitespaces change, clearer init of @farthest_right property\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/carver.litcoffee","new_file":"lib\/carver.litcoffee","new_contents":"    Madul = require 'madul'\n\n    class Carver extends Madul\n      deps: [ 'config' ]\n\n      starting_row: 0\n\n      row:   0\n      col:   0\n      steps: 0\n\n      previous_direction: undefined\n      total_distance:     0\n      farthest_right:\n        row: 0\n        col: 0\n\n      directions:\n        LEFT:  0\n        RIGHT: 1\n        UP:    2\n        DOWN:  3\n\n      clear_state: =>\n        @row = @starting_row\n        @col = 0\n\n        @farthest_right     = row: @row, col: @col\n        @previous_direction = undefined\n\n        @steps          = 0\n        @total_distance = 0\n\n        for row, r in @config.grid\n          for cell, c in @config.grid[r]\n            @config.grid[r][c] = false\n\n        @config.grid[@row][@col] = true\n\n      update_steps: (dir) =>\n        if @previous_direction?\n          if @previous_direction == @directions[dir]\n            ++@steps\n          else\n            @steps = 0\n        else\n          @previous_direction = @directions[dir]\n          @steps = 0\n\n      neighbor: (x = 0, y = 0) => @config.grid[@row + x][@col + y]\n\n      carve_path: =>\n        more_to_carve = true\n        path          = [{ row: @row, col: @col }]\n\n        while more_to_carve\n          neighbors = [ ]\n          width     = @config.grid[0].length\n          height    = @config.grid.length\n\n          neighbors.push 'UP'    if @row > 0          && @neighbor(-1,  0) == false\n          neighbors.push 'DOWN'  if @row < height - 2 && @neighbor( 1,  0) == false\n          neighbors.push 'LEFT'  if @col > 0          && @neighbor( 0, -1) == false\n          neighbors.push 'RIGHT' if @col < width      && @neighbor( 0,  1) == false\n\n          if neighbors.length == 0\n            @col = @farthest_right.col\n            @row = @farthest_right.row\n\n            continue\n          else\n            direction = @config.pathfinder neighbors\n\n            switch @directions[direction]\n              when @directions.RIGHT then @config.grid[@row][++@col] = true\n              when @directions.LEFT  then @config.grid[@row][--@col] = true\n              when @directions.UP    then @config.grid[--@row][@col] = true\n              when @directions.DOWN  then @config.grid[++@row][@col] = true\n              when undefined         then continue\n\n            @update_steps direction\n\n            if @col > @farthest_right.col\n              @farthest_right.col = @col\n              @farthest_right.row = @row\n\n            if @farthest_right.col < @config.grid[0].length - 1\n              path.push row: @row, col: @col, direction: direction\n\n              continue\n            else\n              more_to_carve = false\n\n        path\n\n    module.exports = Carver\n","old_contents":"    Madul = require 'madul'\n\n    class Carver extends Madul\n      deps: [ 'config' ]\n\n      starting_row: 0\n\n      row:   0\n      col:   0\n      steps: 0\n\n      previous_direction: undefined\n      total_distance:     0\n      farthest_right:\n        row: 0\n        col: 0\n\n      directions:\n        LEFT:  0\n        RIGHT: 1\n        UP:    2\n        DOWN:  3\n\n      clear_state: =>\n        @row  = @starting_row\n        @col  = 0\n\n        @farthest_right     = row: @row, col: 0\n        @previous_direction = undefined\n\n        @steps          = 0\n        @total_distance = 0\n\n        for row, r in @config.grid\n          for cell, c in @config.grid[r]\n            @config.grid[r][c] = false\n\n        @config.grid[@row][@col] = true\n\n      update_steps: (dir) =>\n        if @previous_direction?\n          if @previous_direction == @directions[dir]\n            ++@steps\n          else\n            @steps = 0\n        else\n          @previous_direction = @directions[dir]\n          @steps = 0\n\n      neighbor: (x = 0, y = 0) => @config.grid[@row + x][@col + y]\n\n      carve_path: =>\n        more_to_carve = true\n        path          = [{ row: @row, col: @col }]\n\n        while more_to_carve\n          neighbors = [ ]\n          width     = @config.grid[0].length\n          height    = @config.grid.length\n\n          neighbors.push 'UP'    if @row > 0          && @neighbor(-1,  0) == false\n          neighbors.push 'DOWN'  if @row < height - 2 && @neighbor( 1,  0) == false\n          neighbors.push 'LEFT'  if @col > 0          && @neighbor( 0, -1) == false\n          neighbors.push 'RIGHT' if @col < width      && @neighbor( 0,  1) == false\n\n          if neighbors.length == 0\n            @col = @farthest_right.col\n            @row = @farthest_right.row\n\n            continue\n          else\n            direction = @config.pathfinder neighbors\n\n            switch @directions[direction]\n              when @directions.RIGHT then @config.grid[@row][++@col] = true\n              when @directions.LEFT  then @config.grid[@row][--@col] = true\n              when @directions.UP    then @config.grid[--@row][@col] = true\n              when @directions.DOWN  then @config.grid[++@row][@col] = true\n              when undefined         then continue\n\n            @update_steps direction\n\n            if @col > @farthest_right.col\n              @farthest_right.col = @col\n              @farthest_right.row = @row\n\n            if @farthest_right.col < @config.grid[0].length - 1\n              path.push row: @row, col: @col, direction: direction\n\n              continue\n            else\n              more_to_carve = false\n\n        path\n\n    module.exports = Carver\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d03c260c3c3a735ab0f415c3731c6cd4ce84f1ed","subject":"Changed stuff (sorry - shitty week, shitty commit message)","message":"Changed stuff (sorry - shitty week, shitty commit message)\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push e\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = e\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        proto._report method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            Madul.FIRE '$.Madul.decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.Promise (resolve, reject) =>\n                  async.eachSeries me.validators, (v, next) =>\n                    arg       = Object.keys(v)[0]\n                    validator = v[arg]\n                    input     = arg\n                    prop      = args\n\n                    for a in arg.split '.'\n                      prop  = prop[a]\n                      input = a\n\n                    if Array.isArray validator\n                      async.eachSeries validator, (v, nxt) =>\n                        proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                        proto[v].EXECUTE.call proto[v], input, prop\n                          .then nxt\n                          .catch handle_err v, { \"#{input}\": prop }, nxt, reject\n                      , next\n                    else\n                      proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                      proto[validator].EXECUTE.call proto[validator], input, prop\n                        .then next\n                        .catch handle_err v, { \"#{input}\": prop }, next, reject\n                  , resolve\n                .then =>\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries before, (b, next) =>\n                      proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                      proto[b].before.call proto[b], args\n                        .then next\n                        .catch handle_err b, args, next, reject\n                    , resolve\n                .then =>\n                  input = proto._prep_invocation proto, method, args, def\n\n                  try\n                    me.behavior.apply me, input\n                  catch e\n                    failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                    me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                    failed e.message\n                .then (result) =>\n                  q.Promise (resolve, reject) =>\n                    if after.length > 0\n                      async.eachSeries after, (a, next) =>\n                        proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                        proto[a].after.call proto[a], result\n                          .then next\n                          .catch handle_err b, args, next, reject\n                      , => resolve result\n                    else\n                      process.nextTick => resolve result\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n\n              INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n              wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, next\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        error = true\n\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) =>\n                    me._do_add me, ref, next\n                    error = undefined\n                else\n                  next()\n            , => finished error\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                Madul.FIRE '$.Madul.search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    stop = new Error()\n                    stop.break = true\n\n                    next()\n                    nxt stop\n                  , nxt\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                if Array.isArray val\n                  \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else\n                  \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = [ ]\n\n                for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  if Array.isArray validator\n                    for v in validator\n                      Madul.FIRE '$.Madul.validator.execute', \"#{v}\": args[arg]\n\n                      validators.push proto[v].EXECUTE.call proto[v], arg, args[arg]\n                  else\n                    Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                    validators.push proto[validator].EXECUTE.call proto[validator], arg, args[arg]\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, available[strip spec.ref], spec.ref, next\n            else\n              if spec.parent?\n                Madul.FIRE '$.Madul.search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    stop = new Error()\n                    stop.break = true\n\n                    next()\n                    nxt stop\n                  , nxt\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    proto._check proto, pth, spec.name, spec.ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, fail) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n\n        fs.stat pkg, (err, stat) =>\n          if stat?.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            fail()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ec132f6439ca1099e2844ace6346b43ce16cdf20","subject":"Disabled old test","message":"Disabled old test\n","repos":"mxipartners\/mijnmxi,mxipartners\/mijnmxi,mxipartners\/mijnmxi","old_file":"lib\/validation\/item.litcoffee","new_file":"lib\/validation\/item.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a465330cf564b1fec45790186819c2170bc2b62e","subject":"Switch ip address check order","message":"Switch ip address check order\n\nWe don't want to always be gettign the ip address nginx is using ;-)\n","repos":"bsgbryan\/jyn","old_file":"lib\/server.litcoffee","new_file":"lib\/server.litcoffee","new_contents":"    Madul = require 'madul'\n\n    STATUSES =\n      COMPLETE: 'COMPLETE'\n      ERROR:    'ERROR'\n      PROGRESS: 'PROGRESS'\n\n    EXCLUDE = [\n      'MODULE'\n      'ACTION'\n      'EXECUTE'\n    ]\n\n    heartbeat = -> @isAlive = true\n\n    class Server extends Madul\n\n      deps: [ '~ws', '.db' ]\n\n      boot: (args, done) ->\n        wss = new @ws.Server port: args.ws.port\n\n        setInterval ->\n          wss.clients.forEach (ws) ->\n            return ws.terminate() if ws.isAlive == false\n\n            ws.isAlive = false\n            ws.ping '', false, true\n        , 10000\n\n        wss.on 'error', (details) =>\n          console.log 'WebSocket Server got error', details\n\n        wss.on 'connection', (ws, req) =>\n          try\n            raw_ip = (req.headers['x-forwarded-for'] || req.connection.remoteAddress).split ':'\n            ip_v4  = raw_ip.pop()\n            ip_v6  = raw_ip.join ':'\n\n            ip_v4 = null if ip_v4.split('.').length != 4\n            ip_v6 = null if ip_v6.split(':').length  < 3\n          catch e\n            ip_v4  = null\n            ip_v6  = null\n          \n          ws.isAlive = true\n          ws.on 'pong', heartbeat\n          \n          ws.on 'message', (mess) =>\n            try\n              input = JSON.parse mess\n            catch e\n              return @_notify ws, STATUSES.ERROR, \"Could not parse as JSON: #{mess}\"\n\n            args = { }\n\n            for key, val of input\n              if key != 'MODULE' and key != 'ACTION'\n                args[key] = val\n\n            @db.log_api_call\n              v4_address: ip_v4\n              v6_address: ip_v6\n              module:     input.MODULE || 'NONE'\n              action:     input.ACTION || 'NONE'\n              args:       args\n\n            input._client_ip_address =\n              v4: ip_v4\n              v6: ip_v6\n\n            @handle input\n              .then (output) => @_notify ws, STATUSES.COMPLETE, output\n              .catch   (err) => @_notify ws, STATUSES.ERROR,    err.args? || err\n              .progress (up) => @_notify ws, STATUSES.PROGRESS, up\n\n          ws.on 'error', (details) =>\n            console.log 'WebSocket got error', details\n\n        done()\n\n      _notify: (socket, status, data) =>\n        if status == STATUSES.ERROR\n          out = { status, message: data }\n        else\n          out = { status, data }\n\n        try\n          if socket.readyState == @ws.OPEN\n            socket.send JSON.stringify(out), (err) =>\n              if err?\n                console.log 'Get error sending message', err\n          else\n            consle.log 'SOCKET NOT OPEN'\n        catch e\n          console.log 'Message send threw an error', e\n\n      handle:\n        validate:\n          # KEY:    [ '.is_present', '.hasnt_expired' ]\n          MODULE: '.is_present'\n          ACTION: '.is_present'\n        before:   '.init_execution_context'\n        behavior: (input, done, fail, update) ->\n          args = { }\n\n          for own key, val of input\n            args[key] = val unless EXCLUDE.includes key\n\n          input.EXECUTE args\n            .then     done\n            .catch    fail\n            .progress update\n            .done()\n\n    module.exports = Server\n","old_contents":"    Madul = require 'madul'\n\n    STATUSES =\n      COMPLETE: 'COMPLETE'\n      ERROR:    'ERROR'\n      PROGRESS: 'PROGRESS'\n\n    EXCLUDE = [\n      'MODULE'\n      'ACTION'\n      'EXECUTE'\n    ]\n\n    heartbeat = -> @isAlive = true\n\n    class Server extends Madul\n\n      deps: [ '~ws', '.db' ]\n\n      boot: (args, done) ->\n        wss = new @ws.Server port: args.ws.port\n\n        setInterval ->\n          wss.clients.forEach (ws) ->\n            return ws.terminate() if ws.isAlive == false\n\n            ws.isAlive = false\n            ws.ping '', false, true\n        , 10000\n\n        wss.on 'error', (details) =>\n          console.log 'WebSocket Server got error', details\n\n        wss.on 'connection', (ws, req) =>\n          try\n            raw_ip = (req.connection.remoteAddress || req.headers['x-forwarded-for']).split ':'\n            ip_v4  = raw_ip.pop()\n            ip_v6  = raw_ip.join ':'\n\n            ip_v4 = null if ip_v4.split('.').length != 4\n            ip_v6 = null if ip_v6.split(':').length  < 3\n          catch e\n            ip_v4  = null\n            ip_v6  = null\n          \n          ws.isAlive = true\n          ws.on 'pong', heartbeat\n          \n          ws.on 'message', (mess) =>\n            try\n              input = JSON.parse mess\n            catch e\n              return @_notify ws, STATUSES.ERROR, \"Could not parse as JSON: #{mess}\"\n\n            args = { }\n\n            for key, val of input\n              if key != 'MODULE' and key != 'ACTION'\n                args[key] = val\n\n            @db.log_api_call\n              v4_address: ip_v4\n              v6_address: ip_v6\n              module:     input.MODULE || 'NONE'\n              action:     input.ACTION || 'NONE'\n              args:       args\n\n            input._client_ip_address =\n              v4: ip_v4\n              v6: ip_v6\n\n            @handle input\n              .then (output) => @_notify ws, STATUSES.COMPLETE, output\n              .catch   (err) => @_notify ws, STATUSES.ERROR,    err.args? || err\n              .progress (up) => @_notify ws, STATUSES.PROGRESS, up\n\n          ws.on 'error', (details) =>\n            console.log 'WebSocket got error', details\n\n        done()\n\n      _notify: (socket, status, data) =>\n        if status == STATUSES.ERROR\n          out = { status, message: data }\n        else\n          out = { status, data }\n\n        try\n          if socket.readyState == @ws.OPEN\n            socket.send JSON.stringify(out), (err) =>\n              if err?\n                console.log 'Get error sending message', err\n          else\n            consle.log 'SOCKET NOT OPEN'\n        catch e\n          console.log 'Message send threw an error', e\n\n      handle:\n        validate:\n          # KEY:    [ '.is_present', '.hasnt_expired' ]\n          MODULE: '.is_present'\n          ACTION: '.is_present'\n        before:   '.init_execution_context'\n        behavior: (input, done, fail, update) ->\n          args = { }\n\n          for own key, val of input\n            args[key] = val unless EXCLUDE.includes key\n\n          input.EXECUTE args\n            .then     done\n            .catch    fail\n            .progress update\n            .done()\n\n    module.exports = Server\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ebc14cd27aab90d21d3ce2b19144e1382d3c2eca","subject":"fixing","message":"fixing\n","repos":"glamp\/leech,glamp\/leech","old_file":"index.litcoffee","new_file":"index.litcoffee","new_contents":"Pretty simple setup here.\n\n    handlebars = require 'handlebars'\n    aws = require 'aws-sdk'\n    shortid = require 'shortid'\n\nSetup the connection to s3\n\n    aws.config.update {\n        accessKeyId: process.env[\"AWS_ACCESS_KEY\"],\n        secretAccessKey: process.env[\"AWS_SECRET_KEY\"]\n    }\n    aws.config.region = 'us-east-1'\n    s3 = new aws.S3()\n\nSet the name for your domain.\n\n    module.exports = (url) ->\n      DOMAIN = process.env[\"DOMAIN\"] || \"shortcake.com\"\n      BUCKET = process.env[\"BUCKET\"] || DOMAIN\n      GA_ID = process.env[\"GA_ID\"]\n      shortid.characters \"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ()\"\n\nThis is our basic HTML template that we'll use for doing the redirect. It's just\ngoing to send the user to another page as soon as it's loaded. There's no server\nsince it's just a static file, but everything will be tracked by GA.\n\n      source = \"\"\"\n      <html>\n          <title>{{url}}<\/title>\n          <body>\n            <!-- Google Analytics -->\n            <script type=\"text\/javascript\">var _gaq = _gaq || [];_gaq.push(['_setAccount', '{{ga_id}}']);_gaq.push(['_setDomainName', 'yhathq.com']);_gaq.push(['_trackPageview']);(function() {var ga = document.createElement('script'); ga.type = 'text\/javascript'; ga.async = true;ga.src = ('https:' == document.location.protocol ? 'https:\/\/ssl' : 'http:\/\/www') + '.google-analytics.com\/ga.js';var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);})();<\/script>\n            <!-- redirect -->\n            <script type=\"text\/javascript\">\n              window.location.replace('{{url}}');\n            <\/script>\n          <\/body>\n      <\/html>\n      \"\"\"\n\n      template = handlebars.compile(source)\n\nData should just be the user's Google Analytics Id and the URL that they want to\nminify.\n\n      data = { url: url, ga_id: GA_ID }\n      html = template(data)\n\nWe're going to generate a shortlink for the URL. [`shortid`](https:\/\/github.com\/dylang\/shortid) does a pretty good job at balancing between being short, and also\nbeing unique!\n\n      _id = shortid.generate()\n\nWe could break up the files by the [first 3 letters in the id](http:\/\/docs.aws.amazon.com\/AmazonS3\/latest\/dev\/request-rate-perf-considerations.html).\nThis makes it much easier for S3 to distribute the bucket (and greatly improves performance).\n...but we're not going to do this yet.\n\n      params = {\n          Bucket: BUCKET,\n          Key: _id\n          ACL: \"public-read\",\n          Body: html\n      }\n      s3.putObject params, (err, data) ->\n          if err\n              console.log err\n\nWe'll keep a running record of all links we've shortened and throw it into a \nbasic HTML page just to make it easy to do lookups.\n\n      source = \"\"\"\n      <html>\n          <title>Shortened Links<\/title>\n          <body>\n              <h1>Shortened Links<\/h1>\n              <ul>\n              {{#objs}}\n                  <li><a href='{{ Key }}'>{{ Key }}<\/a><\/li>\n              {{\/objs}}\n              <\/ul>\n          <\/body>\n      <\/html>\n      \"\"\"\n      params = { Bucket: BUCKET }\n      s3.listObjects params, (err, objs) ->\n        if err\n            console.log \"[ERROR]: could not list objects: \" + err\n        objs = objs.Contents.filter (obj) ->\n          ! \/index.html$\/.test obj.Key\n        html = handlebars.compile(source)({ objects: objs })\n        params = {\n            Bucket: BUCKET,\n            Key: \"index.html\",\n            ACL: \"public-read\",\n            Body: html\n        }\n        s3.putObject params, (err, data) ->\n            if err\n                console.log \"[ERROR]: \" + err\n        console.error \"Visit: https:\/\/s3.amazonaws.com\/#{BUCKET}\/index.html\"\n\n","old_contents":"Pretty simple setup here.\n\n    handlebars = require 'handlebars'\n    aws = require 'aws-sdk'\n    shortid = require 'shortid'\n\nSetup the connection to s3\n\n    aws.config.update {\n        accessKeyId: process.env[\"AWS_ACCESS_KEY\"],\n        secretAccessKey: process.env[\"AWS_SECRET_KEY\"]\n    }\n    aws.config.region = 'us-east-1'\n    s3 = new aws.S3()\n\nSet the name for your domain.\n\n    module.exports = (url) ->\n      DOMAIN = process.env[\"DOMAIN\"] || \"shortcake.com\"\n      BUCKET = process.env[\"BUCKET\"] || DOMAIN\n      GA_ID = process.env[\"GA_ID\"]\n      shortid.characters \"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ()\"\n\nThis is our basic HTML template that we'll use for doing the redirect. It's just\ngoing to send the user to another page as soon as it's loaded. There's no server\nsince it's just a static file, but everything will be tracked by GA.\n\n      source = \"\"\"\n      <html>\n          <title>{{url}}<\/title>\n          <body>\n            <!-- Google Analytics -->\n            <script type=\"text\/javascript\">var _gaq = _gaq || [];_gaq.push(['_setAccount', '{{ga_id}}']);_gaq.push(['_setDomainName', 'yhathq.com']);_gaq.push(['_trackPageview']);(function() {var ga = document.createElement('script'); ga.type = 'text\/javascript'; ga.async = true;ga.src = ('https:' == document.location.protocol ? 'https:\/\/ssl' : 'http:\/\/www') + '.google-analytics.com\/ga.js';var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);})();<\/script>\n            <!-- redirect -->\n            <script type=\"text\/javascript\">\n              window.location.replace('{{url}}');\n            <\/script>\n          <\/body>\n      <\/html>\n      \"\"\"\n\n      template = handlebars.compile(source)\n\nData should just be the user's Google Analytics Id and the URL that they want to\nminify.\n\n      data = { url: url, ga_id: GA_ID }\n      html = template(data)\n\nWe're going to generate a shortlink for the URL. [`shortid`](https:\/\/github.com\/dylang\/shortid) does a pretty good job at balancing between being short, and also\nbeing unique!\n\n      _id = shortid.generate()\n\nWe could break up the files by the [first 3 letters in the id](http:\/\/docs.aws.amazon.com\/AmazonS3\/latest\/dev\/request-rate-perf-considerations.html).\nThis makes it much easier for S3 to distribute the bucket (and greatly improves performance).\n...but we're not going to do this yet.\n\n      params = {\n          Bucket: BUCKET,\n          Key: _id\n          ACL: \"public-read\",\n          Body: html\n      }\n      s3.putObject params, (err, data) ->\n          if err\n              console.log err\n\nWe'll keep a running record of all links we've shortened and throw it into a \nbasic HTML page just to make it easy to do lookups.\n\n      source = \"\"\"\n      <html>\n          <title>Shortened Links<\/title>\n          <body>\n              <h1>Shortened Links<\/h1>\n              <ul>\n              {{#objs}}\n                  <li><a href='{{ Key }}'>{{ Key }}<\/a><\/li>\n              {{\/objs}}\n              <\/ul>\n          <\/body>\n      <\/html>\n      \"\"\"\n      params = { Bucket: BUCKET }\n      s3.listObjects params, (err, objs) ->\n        if err\n            console.log \"[ERROR]: could not list objects: \" + err\n        objs = objs.Contents.filter (obj) ->\n          ! \/index.html$\/.test obj.Key\n        html = handlebars.compile(source)({ objects: objs })\n        params = {\n            Bucket: BUCKET,\n            Key: \"index.html\",\n            ACL: \"public-read\",\n            Body: html\n        }\n        s3.putObject params, (err, data) ->\n            if err\n                econsole.log \"[ERROR]: \" + err\n        console.error \"Visit: https:\/\/s3.amazonaws.com\/#{BUCKET}\/index.html\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f979a8fac1357d69c3e8d3d8b0c87578602d1b71","subject":"more accurate seconds\/year","message":"more accurate seconds\/year\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"client\/views\/globalHelpers.litcoffee","new_file":"client\/views\/globalHelpers.litcoffee","new_contents":"    Template.registerHelper 'totalWaitTimeMinutes', ->\n      minutes = (QueueMeta.findOne()?.totalWaitTimeSeconds \/ 60).toFixed 0\n      \"#{minutes} minutes\"\n\n    Template.registerHelper 'totalWaitTimeYears', ->\n      secondsInYear = 31556900\n      years = (QueueMeta.findOne()?.totalWaitTimeSeconds \/ secondsInYear ).toFixed 2\n      \"#{years} years\"\n\n    Template.registerHelper 'nameAllowedIn', ->\n      QueueMeta.findOne()?.theOnlyConnectionAllowedIn?.name\n\n    Template.registerHelper 'isBeingServed', ->\n      queueEntry = Queue.findOne()\n      queueMeta = QueueMeta.findOne()\n\nUpdate timeCurrentTicketExpires hackily here...\n\n      timeCurrentTicketExpires = Session.get 'timeCurrentTicketExpires'\n      if timeCurrentTicketExpires isnt queueMeta?.timeCurrentTicketExpires\n        Session.set 'timeCurrentTicketExpires', queueMeta?.timeCurrentTicketExpires\n\nNot being served in either queueEntry or queueMeta are non-existant\n\n      return no if not (queueEntry? and queueMeta?)\n      now = moment().utc().toDate()\n      isBeingServed = queueEntry._id is queueMeta?.currentlyServingQueueId and\n        queueMeta.timeCurrentTicketExpires > now\n      if isBeingServed\n        cachedIsBeingServed = Session.get 'isBeingServed'\n        Session.set 'isBeingServed', yes if cachedIsBeingServed is undefined or no\n      return isBeingServed\n","old_contents":"    Template.registerHelper 'totalWaitTimeMinutes', ->\n      minutes = (QueueMeta.findOne()?.totalWaitTimeSeconds \/ 60).toFixed 0\n      \"#{minutes} minutes\"\n\n    Template.registerHelper 'totalWaitTimeYears', ->\n      secondsInYear = 31536000\n      years = (QueueMeta.findOne()?.totalWaitTimeSeconds \/ secondsInYear ).toFixed 2\n      \"#{years} years\"\n\n    Template.registerHelper 'nameAllowedIn', ->\n      QueueMeta.findOne()?.theOnlyConnectionAllowedIn?.name\n\n    Template.registerHelper 'isBeingServed', ->\n      queueEntry = Queue.findOne()\n      queueMeta = QueueMeta.findOne()\n\nUpdate timeCurrentTicketExpires hackily here...\n\n      timeCurrentTicketExpires = Session.get 'timeCurrentTicketExpires'\n      if timeCurrentTicketExpires isnt queueMeta?.timeCurrentTicketExpires\n        Session.set 'timeCurrentTicketExpires', queueMeta?.timeCurrentTicketExpires\n\nNot being served in either queueEntry or queueMeta are non-existant\n\n      return no if not (queueEntry? and queueMeta?)\n      now = moment().utc().toDate()\n      isBeingServed = queueEntry._id is queueMeta?.currentlyServingQueueId and\n        queueMeta.timeCurrentTicketExpires > now\n      if isBeingServed\n        cachedIsBeingServed = Session.get 'isBeingServed'\n        Session.set 'isBeingServed', yes if cachedIsBeingServed is undefined or no\n      return isBeingServed\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d40026dc259c3e2ffa016f083a32bd5d5da4dcec","subject":"Fix documentation list of generated versions","message":"Fix documentation list of generated versions\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/upload.litcoffee","new_file":"src\/upload.litcoffee","new_contents":"    Upload = require 's3-uploader'\n\nConfigure [s3-uploader](https:\/\/github.com\/Turistforeningen\/node-s3-uploader) to\nstore the following versions:\n\n|\u00a0Suffix    | Max Height | Max Width\u00a0| Aspect Ratio |\n|-----------|------------|-----------|--------------|\n| `-full`   | `1200`     | `1200`    |              |\n| `-800`    | `800`      | `800`     | `3:2`        |\n| `-500`    | `500`      | `500`     | `3:2`        |\n| `-260`    | `260`      | `260`     | `3:2`        |\n| `-150`    | `150`      | `150`     | `3:2`        |\n| `-thumb1` | `250`      | `250`     | `1:1`        |\n\n    module.exports = new Upload process.env.AWS_BUCKET_NAME,\n      aws:\n        region: process.env.AWS_BUCKET_REGION\n        path: process.env.AWS_BUCKET_PATH\n        acl: 'public-read'\n        httpOptions: timeout: 60000\n\n      returnExif: true\n\n      cleanup:\n        original: true\n        versions: true\n\n      original:\n        awsImageAcl: 'private'\n\n      versions: [\n        suffix: '-full'\n        quality: 80\n        maxHeight: 1200\n        maxWidth: 1200\n      ,\n        suffix: '-800'\n        maxHeight: 800\n        maxWidth: 800\n        aspect: '3:2'\n      ,\n        suffix: '-500'\n        maxHeight: 500\n        maxWidth: 500\n        aspect: '3:2'\n      ,\n        suffix: '-260'\n        maxHeight: 260\n        maxWidth: 260\n        aspect: '3:2'\n      ,\n        suffix: '-150'\n        maxHeight: 150\n        maxWidth: 150\n        aspect: '3:2'\n      ,\n        suffix: '-thumb1'\n        maxHeight: 250\n        maxWidth: 250\n        aspect: '1:1'\n      ]\n","old_contents":"    Upload = require 's3-uploader'\n\nConfigure [s3-uploader](https:\/\/github.com\/Turistforeningen\/node-s3-uploader) to\nstore the following versions:\n\n|\u00a0Suffix    | Max Height | Max Width\u00a0| Aspect Ratio |\n|-----------|------------|-----------|--------------|\n| `-full`   | `1200`     | `1200`    |              |\n| `-800`    | `800`      | `800`     | `3:2`        |\n| `-500`    | `500`      | `500`     | `3:2`        |\n| `-260`    | `260`      | `260`     | `3:2`        |\n| `-150`    | `150`      | `150`     | `3:2`        |\n| `-thumb1` | `250`      | `250`     | `1:1`        |\n| `-thumb2` | `150`      | `150`     | `1:1`        |\n\n    module.exports = new Upload process.env.AWS_BUCKET_NAME,\n      aws:\n        region: process.env.AWS_BUCKET_REGION\n        path: process.env.AWS_BUCKET_PATH\n        acl: 'public-read'\n        httpOptions: timeout: 60000\n\n      returnExif: true\n\n      cleanup:\n        original: true\n        versions: true\n\n      original:\n        awsImageAcl: 'private'\n\n      versions: [\n        suffix: '-full'\n        quality: 80\n        maxHeight: 1200\n        maxWidth: 1200\n      ,\n        suffix: '-800'\n        maxHeight: 800\n        maxWidth: 800\n        aspect: '3:2'\n      ,\n        suffix: '-500'\n        maxHeight: 500\n        maxWidth: 500\n        aspect: '3:2'\n      ,\n        suffix: '-260'\n        maxHeight: 260\n        maxWidth: 260\n        aspect: '3:2'\n      ,\n        suffix: '-150'\n        maxHeight: 150\n        maxWidth: 150\n        aspect: '3:2'\n      ,\n        suffix: '-thumb1'\n        maxHeight: 250\n        maxWidth: 250\n        aspect: '1:1'\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fa4f7def562982dc87f22d1eace0b0adf4ce4796","subject":"Refactor\/cleanup PARSE_SPEC","message":"Refactor\/cleanup PARSE_SPEC\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                if Array.isArray val\n                  \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else\n                  \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = [ ]\n\n                for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  if Array.isArray validator\n                    for v in validator\n                      Madul.FIRE '$.Madul.validator.execute', \"#{v}\": args[arg]\n\n                      validators.push proto[v].EXECUTE.call proto[v], arg, args[arg]\n                  else\n                    Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                    validators.push proto[validator].EXECUTE.call proto[validator], arg, args[arg]\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                if Array.isArray val\n                  \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else\n                  \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = [ ]\n\n                for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  if Array.isArray validator\n                    for v in validator\n                      Madul.FIRE '$.Madul.validator.execute', \"#{v}\": args[arg]\n\n                      validators.push proto[v].EXECUTE.call proto[v], arg, args[arg]\n                  else\n                    Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                    validators.push proto[validator].EXECUTE.call proto[validator], arg, args[arg]\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9fd5b9c08f33cc3a691781b3302c50c522f134f7","subject":"Update docco.litcoffee","message":"Update docco.litcoffee\n\nSpelling mistake: the word is hierarchy, not 'heirarchy'","repos":"lobrien\/docco,DoomHammer\/docco,guigrpa\/docco-extended,guigrpa\/docco,jrvidal\/docco,oponder\/docco,gvithellyna\/docco,mhkeller\/docco,lbn\/docco,MaxwellRebo\/docco,lbn\/docco,actano\/docco,jalleyne\/docco,DoomHammer\/docco,HubSpot\/docco,robertmackenzie\/docco,tbremer\/docco,lobrien\/docco,Hellyna\/docco,whitetrefoil\/docco,mhkeller\/docco,jalleyne\/docco,ShawnHuang\/docco-multidir,guigrpa\/docco,ShawnHuang\/docco-multidir,jrvidal\/docco,gvithellyna\/docco,Hellyna\/docco,tbremer\/docco,whitetrefoil\/docco,osharim\/docco,erikdiessel\/plidoc,MaxwellRebo\/docco,guigrpa\/docco-extended,robertmackenzie\/docco,oponder\/docco,STRd6\/docco,JonathanMatthey\/codeconv,osharim\/docco,erikdiessel\/plidoc","old_file":"docco.litcoffee","new_file":"docco.litcoffee","new_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If **Node.js** doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.com\/rocco\/rocco.html), the Ruby port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.com\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If Python's more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.com\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.com\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.com\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.com\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.com\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = ->\n      wrench.mkdirSyncRecursive config.output\n\n      cssName = path.basename config.css\n      cssOutput = path.join config.output, cssName\n      cssContents = fs.readFileSync config.css\n      fs.writeFileSync cssOutput, cssContents\n\n      if fs.existsSync config.public\n        wrench.copyDirSyncRecursive config.public, config.output, preserve: yes\n\n      files = config.sources.slice()\n\n      nextFile = ->\n        source = files.shift()\n        fs.readFile source, (error, buffer) ->\n          throw error if error\n\n          code = buffer.toString()\n          sections = parse source, code\n          format source, sections\n          write source, sections\n          nextFile() if files.length\n\n      nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        for line, i in lines\n          lines[i] = if \/^\\s*$\/.test line\n            ''\n          else if match = (\/^([ ]{4}|\\t)\/).exec line\n            line[match[0].length..]\n          else\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if (not line and prev is 'text') or\n            (line.match(lang.commentMatcher) and not line.match(lang.commentFilter))\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n          prev = 'text'\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n          prev = 'code'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections) ->\n      language = getLanguage source\n      for section, i in sections\n        code = highlight(language.name, section.codeText).value .trim()\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be overriden by command-line\noptions.\n\n    config =\n      layout:     'parallel'\n      output:     'docs\/'\n      template:   null\n      css:        null\n      extension:  null\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      _.extend config, _.pick(options, _.keys(config)...)\n\n      if options.template or options.css\n        config.layout = null\n      else\n        dir = config.layout = \"#{__dirname}\/resources\/#{config.layout}\"\n        config.public       = \"#{dir}\/public\" if fs.existsSync \"#{dir}\/public\"\n        config.template     = \"#{dir}\/docco.jst\"\n        config.css          = \"#{dir}\/docco.css\"\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{m})\" unless lang\n        lang\n      ).sort()\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _             = require 'underscore'\n    fs            = require 'fs'\n    path          = require 'path'\n    marked        = require 'marked'\n    commander     = require 'commander'\n    wrench        = require 'wrench'\n    {highlight}   = require 'highlight.js'\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(\"#{__dirname}\/resources\/languages.json\")\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    for ext, l of languages\n\nDoes the line begin with a comment?\n\n      l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_(Unix\\)) and interpolations...\n\n      l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(\"#{__dirname}\/package.json\")).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = config\n      commander.version(version)\n        .usage('[options] files')\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document configure commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, version}\n","old_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If **Node.js** doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.com\/rocco\/rocco.html), the Ruby port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.com\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If Python's more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.com\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.com\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.com\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.com\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.com\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex heirarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = ->\n      wrench.mkdirSyncRecursive config.output\n\n      cssName = path.basename config.css\n      cssOutput = path.join config.output, cssName\n      cssContents = fs.readFileSync config.css\n      fs.writeFileSync cssOutput, cssContents\n\n      if fs.existsSync config.public\n        wrench.copyDirSyncRecursive config.public, config.output, preserve: yes\n\n      files = config.sources.slice()\n\n      nextFile = ->\n        source = files.shift()\n        fs.readFile source, (error, buffer) ->\n          throw error if error\n\n          code = buffer.toString()\n          sections = parse source, code\n          format source, sections\n          write source, sections\n          nextFile() if files.length\n\n      nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        for line, i in lines\n          lines[i] = if \/^\\s*$\/.test line\n            ''\n          else if match = (\/^([ ]{4}|\\t)\/).exec line\n            line[match[0].length..]\n          else\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if (not line and prev is 'text') or\n            (line.match(lang.commentMatcher) and not line.match(lang.commentFilter))\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n          prev = 'text'\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n          prev = 'code'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections) ->\n      language = getLanguage source\n      for section, i in sections\n        code = highlight(language.name, section.codeText).value .trim()\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be overriden by command-line\noptions.\n\n    config =\n      layout:     'parallel'\n      output:     'docs\/'\n      template:   null\n      css:        null\n      extension:  null\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      _.extend config, _.pick(options, _.keys(config)...)\n\n      if options.template or options.css\n        config.layout = null\n      else\n        dir = config.layout = \"#{__dirname}\/resources\/#{config.layout}\"\n        config.public       = \"#{dir}\/public\" if fs.existsSync \"#{dir}\/public\"\n        config.template     = \"#{dir}\/docco.jst\"\n        config.css          = \"#{dir}\/docco.css\"\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{m})\" unless lang\n        lang\n      ).sort()\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _             = require 'underscore'\n    fs            = require 'fs'\n    path          = require 'path'\n    marked        = require 'marked'\n    commander     = require 'commander'\n    wrench        = require 'wrench'\n    {highlight}   = require 'highlight.js'\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(\"#{__dirname}\/resources\/languages.json\")\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    for ext, l of languages\n\nDoes the line begin with a comment?\n\n      l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_(Unix\\)) and interpolations...\n\n      l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(\"#{__dirname}\/package.json\")).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = config\n      commander.version(version)\n        .usage('[options] files')\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document configure commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, version}\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"40fde705501f3f83d3d63bde4bf36306fc0d3b77","subject":"Document lowercase first letter in controller name","message":"Document lowercase first letter in controller name\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08_app.litcoffee","new_file":"docs\/08_app.litcoffee","new_contents":"# Batman.App\n\n`Batman.App` is the central object in any Batman application. It manages the routing table and the current URL parameters, as well as the initial start of the application. It should also be used as a namespace for models and views so that other objects can find them. Batman assumes that there will only ever be one `Batman.App` in use at once.\n\n## Batman.currentApp\n\nA Batman-wide reference to the currently running `Batman.App`.\n\n## @run() : App\n\n`App.run` is the central entry point for a Batman application. `@run` takes these steps to initialize a Batman application:\n\n 1. Instantiate a `Dispatcher`, an internal object for mananging action dispatch to controllers.\n 2. Instantiate a `Navigator`, an internal object for managing the URL via pushState or hashbangs.\n 3. Instantiate the `layout` view according to the `layout` property on the `App`.\n 4. Wait for the layout view to fire it's `ready` event.\n 5. Start the first action dispatch by telling the `Navigator` to begin monitoring the URL.\n\n_Note_: `@run` emits the `run` class event on the `App`, but not necessarily as soon as `@run` is called. Because the `layout` View renders asynchronously and may need to fetch other components, the `run` event can and often does fire long after `@run` is called. If you need to execute code as soon as the `App` has started running, add a listener to the `run` event on the `App` class. If you need to execute code as soon as the layout has rendered, you can use the `ready` event on the `App` class.\n\n`@run` can be called before or on the `load` DOMEvent of the window. `@run` will return the App if the commencement was successful and complete, or `false` if the App must wait for the `layout` to render or if the `App` has already run.\n\n#### starting an application with DOMEvents\n```coffeescript\nwindow.addEventListener 'load', ->\n  MyApp.run()\n```\n\n#### starting an application with jQuery\n```coffeescript\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\n`@stop` stops the `App` it's called upon. The URL will stop being monitored and no more actions will be dispatched. In usual Batman development you shouldn't have to call this.\n\n## @routes\n\n`@routes` is a class level property referencing the root level `NamedRouteQuery` which allows for binding to routes on objects. See `data-route` bindings for more information.\n\n## @controllers\n\n`@controllers` is a class level property containing the singleton `Batman.Controller` instances for each subclass in the application. This `controllers` directory puts these instances at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`. `@controllers` ideally should never be bound to, but it is very useful for debugging in the console and other such workarounds.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n    test \"Multi-word controller names have a lowercase first letter\", ->\n      class Alfred extends Batman.App\n      class Alfred.ReminderEmailsController extends Batman.Controller\n      controller = Alfred.get('controllers.reminderEmails')\n      equal Batman._functionName(controller.constructor), \"ReminderEmailsController\"\n\n## @layout\n\n`@layout` is the base view of the entire view hierarchy. By default, it will parse any data-* attributes in the entire document, excluding any `data-yield`'s, when `App.run()` is called. Use `MyApp.layout = null` to disable the creation of this default view.\n\n## @currentParams\n\n`@currentParams` contains the URL parameters for the current request, including the path relative to the app's base path (`Batman.config.pathToApp`). Some interesting parts to look at: `@currentParams.controller`, `@currentParams.action`.\n\n## @paramsManager\n## @paramsPusher\n\n## 'run' class event\n\nThe `run` class event is fired once the app has run. This indeterminately but often happens before the app's layout has finished rendering.\n\n## 'ready' class event\n\nThe `ready` class event is fired once the app's layout is rendered.\n\n# Batman.App Routing\n\nThe `Batman` routing DSL is similar to Rails 3's routing DSL. It is oriented around the notion of a resource:\n\n## @route\n\n`@route` defines a custom route and can be pointed to a controller action directly. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @route 'comments', 'pages#comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/comments` being added to the routing map, pointed to `PagesController#comments`.\n\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n## @member\n\n`@member` defines a routable action you can call on a specific instance of a member of a collection resource. For example, if you have a collection of `Page` resources, and a user can post a comment on a specific page:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @member 'comment'\n\nclass Example.PagesController extends Batman.Controller\n  comment: (params) ->\n```\n\nWould result in `\/pages\/:id\/comment` being added to the routing map, pointed to `PagesController#comment`.\n\n## @collection\n\n`@collection` is similar to `@member` in that it adds routable actions to a `@resources` set of routes. In this case the action would apply to the entire collection. For example, if you have a list of spam comments made across _all_ your `Page` resources:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @collection 'spam_comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/pages\/spam_comments` being added to the routing map, pointed to `PagesController#spam_comments`.\n\n## @root\n\n`@root` defines the root controller and action to be used when visiting the base application URL. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @root 'pages#index'\n\nclass Example.PagesController extends Batman.Controller\n  index: ->\n```\n\nWould result in `\/` being pointed to `PagesController#index`.","old_contents":"# Batman.App\n\n`Batman.App` is the central object in any Batman application. It manages the routing table and the current URL parameters, as well as the initial start of the application. It should also be used as a namespace for models and views so that other objects can find them. Batman assumes that there will only ever be one `Batman.App` in use at once.\n\n## Batman.currentApp\n\nA Batman-wide reference to the currently running `Batman.App`.\n\n## @run() : App\n\n`App.run` is the central entry point for a Batman application. `@run` takes these steps to initialize a Batman application:\n\n 1. Instantiate a `Dispatcher`, an internal object for mananging action dispatch to controllers.\n 2. Instantiate a `Navigator`, an internal object for managing the URL via pushState or hashbangs.\n 3. Instantiate the `layout` view according to the `layout` property on the `App`.\n 4. Wait for the layout view to fire it's `ready` event.\n 5. Start the first action dispatch by telling the `Navigator` to begin monitoring the URL.\n\n_Note_: `@run` emits the `run` class event on the `App`, but not necessarily as soon as `@run` is called. Because the `layout` View renders asynchronously and may need to fetch other components, the `run` event can and often does fire long after `@run` is called. If you need to execute code as soon as the `App` has started running, add a listener to the `run` event on the `App` class. If you need to execute code as soon as the layout has rendered, you can use the `ready` event on the `App` class.\n\n`@run` can be called before or on the `load` DOMEvent of the window. `@run` will return the App if the commencement was successful and complete, or `false` if the App must wait for the `layout` to render or if the `App` has already run.\n\n#### starting an application with DOMEvents\n```coffeescript\nwindow.addEventListener 'load', ->\n  MyApp.run()\n```\n\n#### starting an application with jQuery\n```coffeescript\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\n`@stop` stops the `App` it's called upon. The URL will stop being monitored and no more actions will be dispatched. In usual Batman development you shouldn't have to call this.\n\n## @routes\n\n`@routes` is a class level property referencing the root level `NamedRouteQuery` which allows for binding to routes on objects. See `data-route` bindings for more information.\n\n## @controllers\n\n`@controllers` is a class level property containing the singleton `Batman.Controller` instances for each subclass in the application. This `controllers` directory puts these instances at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`. `@controllers` ideally should never be bound to, but it is very useful for debugging in the console and other such workarounds.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n## @layout\n\n`@layout` is the base view of the entire view hierarchy. By default, it will parse any data-* attributes in the entire document, excluding any `data-yield`'s, when `App.run()` is called. Use `MyApp.layout = null` to disable the creation of this default view.\n\n## @currentParams\n\n`@currentParams` contains the URL parameters for the current request, including the path relative to the app's base path (`Batman.config.pathToApp`). Some interesting parts to look at: `@currentParams.controller`, `@currentParams.action`.\n\n## @paramsManager\n## @paramsPusher\n\n## 'run' class event\n\nThe `run` class event is fired once the app has run. This indeterminately but often happens before the app's layout has finished rendering.\n\n## 'ready' class event\n\nThe `ready` class event is fired once the app's layout is rendered.\n\n# Batman.App Routing\n\nThe `Batman` routing DSL is similar to Rails 3's routing DSL. It is oriented around the notion of a resource:\n\n## @route\n\n`@route` defines a custom route and can be pointed to a controller action directly. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @route 'comments', 'pages#comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/comments` being added to the routing map, pointed to `PagesController#comments`.\n\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n## @member\n\n`@member` defines a routable action you can call on a specific instance of a member of a collection resource. For example, if you have a collection of `Page` resources, and a user can post a comment on a specific page:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @member 'comment'\n\nclass Example.PagesController extends Batman.Controller\n  comment: (params) ->\n```\n\nWould result in `\/pages\/:id\/comment` being added to the routing map, pointed to `PagesController#comment`.\n\n## @collection\n\n`@collection` is similar to `@member` in that it adds routable actions to a `@resources` set of routes. In this case the action would apply to the entire collection. For example, if you have a list of spam comments made across _all_ your `Page` resources:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @collection 'spam_comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/pages\/spam_comments` being added to the routing map, pointed to `PagesController#spam_comments`.\n\n## @root\n\n`@root` defines the root controller and action to be used when visiting the base application URL. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @root 'pages#index'\n\nclass Example.PagesController extends Batman.Controller\n  index: ->\n```\n\nWould result in `\/` being pointed to `PagesController#index`.","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6521c31dc1bfdab4a5d1871929d23dc7feccbc03","subject":"<style> inside another element warning added","message":"<style> inside another element warning added\n\nIssue #191\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/document\/file\/parse\/styles.litcoffee","new_file":"src\/document\/file\/parse\/styles.litcoffee","new_contents":"# style\n\n    'use strict'\n\n    fs = require 'fs-extra'\n    os = require 'os'\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    pathUtils = require 'path'\n    bundleStyle = null\n\n    log = log.scope 'Document'\n    uid = 0\n    realpath = fs.realpathSync '.\/'\n    tmpdir = os.tmpdir()\n\n    module.exports = (File) -> (file) ->\n        bundleStyle = Neft.nmlParser.bundle\n\n        queries = []\n        addedStyles = {}\n\n        if file instanceof File.Iterator\n            return\n\n        styleTags = []\n        stylePath = \"styles:#{file.path}\"\n        for tag in file.node.children\n            if tag.name isnt 'style'\n                continue\n\n            styleTags.push tag\n\n            # tag body\n            str = tag.stringifyChildren()\n            styleFile =\n                data: str\n                path: \"#{file.path}.js\"\n                filename: file.path\n            bundleStyle styleFile\n\n            if utils.isEmpty(styleFile.codes)\n                continue\n\n            File.onStyle.emit styleFile\n\n            for query, style of styleFile.queries\n                itemPath = \"#{stylePath}:#{style}\"\n                addedStyles[itemPath] = true\n                queries.push\n                    query: query\n                    style: itemPath\n\n            # detect main item with no document.query\n            unless file.node.props['n-style']\n                mainHasDoc = false\n                mainId = styleFile.codes._main.link\n                for _, id of styleFile.queries\n                    if id is mainId\n                        mainHasDoc = true\n                        break\n                unless mainHasDoc\n                    file.node.props.set 'n-style', \"#{stylePath}:#{mainId}\"\n\n        while styleTags.length > 0\n            styleTags.pop().parent = null\n\n        # detect not supported <style> tags inside another nodes\n        if tag = file.node.query('style')\n            log.warn \"<style> inside '#{tag.parent.name}' element detected;\" +\n                ' <style> needs to be defined as top-level element in your file or component'\n\n        unless utils.isEmpty(queries)\n            File.Style.applyStyleQueriesInDocument file, queries\n\n        return\n\n# Glossary\n\n- [style](#style)\n","old_contents":"# style\n\n    'use strict'\n\n    fs = require 'fs-extra'\n    os = require 'os'\n    utils = require 'src\/utils'\n    pathUtils = require 'path'\n    bundleStyle = null\n\n    uid = 0\n    realpath = fs.realpathSync '.\/'\n    tmpdir = os.tmpdir()\n\n    module.exports = (File) -> (file) ->\n        bundleStyle = Neft.nmlParser.bundle\n\n        queries = []\n        addedStyles = {}\n\n        if file instanceof File.Iterator\n            return\n\n        styleTags = []\n        stylePath = \"styles:#{file.path}\"\n        for tag in file.node.children\n            if tag.name isnt 'style'\n                continue\n\n            styleTags.push tag\n\n            # tag body\n            str = tag.stringifyChildren()\n            styleFile =\n                data: str\n                path: \"#{file.path}.js\"\n                filename: file.path\n            bundleStyle styleFile\n\n            if utils.isEmpty(styleFile.codes)\n                continue\n\n            File.onStyle.emit styleFile\n\n            for query, style of styleFile.queries\n                itemPath = \"#{stylePath}:#{style}\"\n                addedStyles[itemPath] = true\n                queries.push\n                    query: query\n                    style: itemPath\n\n            # detect main item with no document.query\n            unless file.node.props['n-style']\n                mainHasDoc = false\n                mainId = styleFile.codes._main.link\n                for _, id of styleFile.queries\n                    if id is mainId\n                        mainHasDoc = true\n                        break\n                unless mainHasDoc\n                    file.node.props.set 'n-style', \"#{stylePath}:#{mainId}\"\n\n        while styleTags.length > 0\n            styleTags.pop().parent = null\n\n        unless utils.isEmpty(queries)\n            File.Style.applyStyleQueriesInDocument file, queries\n\n        return\n\n# Glossary\n\n- [style](#style)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"bc14bed90a61da090794f279b73a41ca84ebb22f","subject":"Fixed zero size issue on native items in browsers","message":"Fixed zero size issue on native items in browsers\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/renderer\/types\/basics\/native.litcoffee","new_file":"src\/renderer\/types\/basics\/native.litcoffee","new_contents":"# Native\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    assert = require 'src\/assert'\n    colorUtils = require 'src\/renderer\/utils\/color'\n\n    IS_NATIVE = utils.isNative\n\n    if IS_NATIVE\n        {callNativeFunction, onNativeEvent} = require 'src\/native'\n\n    module.exports = (Renderer, Impl, itemUtils) ->\n\n        class Native extends Renderer.Item\n            @__name__ = 'Native'\n            @__path__ = 'Renderer.Native'\n\n## *Native* Native.New([*Object* options])\n\n            @New = (opts) ->\n                item = new @\n                itemUtils.Object.initialize item, opts\n                @Initialize? item\n                item\n\n## Native.defineProperty(*Object* config)\n\nDefines new property with the given name.\n\nFor each property, signal `onXYZChange` is created,\nwhere `XYZ` is the given name.\n\n`config` parameter must be an object with specified keys:\n- `enabled` - whether it's supported on current platform,\n- `name` - name of the property,\n- `type` - type of predefined condifuration described below,\n- `defaultValue`,\n- `setter`,\n- `getter`,\n- `developmentSetter`\n- `implementationValue` - function returning value passed to the implementation.\n\n### Predefined types\n\n            PROPERTY_TYPES = Object.create null\n\n#### text\n\n            PROPERTY_TYPES.text = ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n\n#### number\n\n            PROPERTY_TYPES.number = ->\n                defaultValue: 0\n                developmentSetter: (val) ->\n                    assert.isFloat val\n\n#### boolean\n\n            PROPERTY_TYPES.boolean = ->\n                defaultValue: false\n                developmentSetter: (val) ->\n                    assert.isBoolean val\n\n#### color\n\n            PROPERTY_TYPES.color = (config) ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n                implementationValue: do ->\n                    RESOURCE_REQUEST =\n                        property: 'color'\n                    (val) ->\n                        val = Renderer.resources?.resolve(val, RESOURCE_REQUEST) or val\n                        if IS_NATIVE\n                            if val?\n                                colorUtils.toRGBAHex val, config.defaultValue\n                            else\n                                null\n                        else\n                            val\n\n#### item\n\n            PROPERTY_TYPES.item = (config) ->\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Renderer.Item\n                implementationValue: (val) ->\n                    if IS_NATIVE\n                        if val?\n                            val._impl.id\n                        else\n                            null\n                    else\n                        val\n\n            @defineProperty = (config) ->\n                itemName = @__name__\n                properties = @_properties ||= []\n                config = utils.clone config\n\n                assert.isString itemName, '''\n                    NativeItem.__name__ unique name must be specified\n                '''\n                assert.isObject config, '''\n                    NativeItem.defineProperty config parameter must be an object\n                '''\n                assert.isString config.name, '''\n                    NativeItem property name must be a string\n                '''\n                assert.isNotDefined properties[config.name], \"\"\"\n                    Property #{config.name} is already defined\n                \"\"\"\n                assert.isDefined PROPERTY_TYPES[config.type], \"\"\"\n                    Unknown property type #{config.type}\n                \"\"\" if config.type\n\n                # type\n                if typeConfigFunc = PROPERTY_TYPES[config.type]\n                    typeConfig = typeConfigFunc(config)\n                    for key, val of typeConfig\n                        if key not of config\n                            config[key] = val\n\n                # constructor\n                config.constructor = @\n\n                # internalName\n                config.internalName = itemUtils.getPropInternalName config.name\n\n                # implementation\n                config.implementation = do ->\n                    if config.enabled is false\n                        return utils.NOP\n\n                    ctorName = utils.capitalize itemName\n                    name = utils.capitalize config.name\n                    if IS_NATIVE\n                        funcName = \"rendererSet#{ctorName}#{name}\"\n                        (val) ->\n                            callNativeFunction funcName, @_impl.id, val\n                    else\n                        funcName = \"set#{ctorName}#{name}\"\n                        (val) ->\n                            Impl[funcName]?.call @, val\n\n                # save\n                properties.push config\n\n                # create\n                itemUtils.defineProperty config\n\n## *Native* Native::constructor() : *Item*\n\n            constructor: ->\n                super()\n\n                @_autoWidth = true\n                @_autoHeight = true\n                @_width = -1\n                @_height = -1\n\n                # save properties with default values\n                if properties = @constructor._properties\n                    for property in properties\n                        @[property.internalName] = property.defaultValue\n\n            _width: -1\n            getter = utils.lookupGetter @::, 'width'\n            itemWidthSetter = utils.lookupSetter @::, 'width'\n            utils.defineProperty @::, 'width', null, getter,\n                do (_super = itemWidthSetter) -> (val) ->\n                    if @_autoWidth = val is -1\n                        Impl.updateNativeSize.call @\n                    else\n                        _super.call @, val\n                    return\n\n            _height: -1\n            getter = utils.lookupGetter @::, 'height'\n            itemHeightSetter = utils.lookupSetter @::, 'height'\n            utils.defineProperty @::, 'height', null, getter,\n                do (_super = itemHeightSetter) -> (val) ->\n                    if @_autoHeight = val is -1\n                        Impl.updateNativeSize.call @\n                    else\n                        _super.call @, val\n                    return\n\n## Native::set(*String* propName, *Any* val)\n\n            set: (name, val) ->\n                assert.isString name, \"NativeItem.set name must be a string, but #{name} given\"\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    funcName = \"rendererSet#{ctorName}#{name}\"\n                    callNativeFunction funcName, id, val\n                else\n                    funcName = \"set#{ctorName}#{name}\"\n                    Impl[funcName]?.call @, val\n                return\n\n## Native::call(*String* funcName, *Any* args...)\n\n            call: (name, args...) ->\n                assert.isString name, \"NativeItem.call name must be a string, but #{name} given\"\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    funcName = \"rendererCall#{ctorName}#{name}\"\n                    callArgs = [funcName, id, args...]\n                    callNativeFunction callArgs...\n                else\n                    funcName = \"call#{ctorName}#{name}\"\n                    Impl[funcName]?.apply @, args\n                return\n\n## Native::on(*String* eventName, *Function* listener)\n\n            # nativeEventName -> item id -> [item, listeners...]\n            eventListeners = Object.create null\n\n            createNativeEventListener = (listeners, eventName) -> (id) ->\n                unless itemListeners = listeners[id]\n                    log.warn \"Got a native event '#{eventName}' for an item which \" +\n                        \"didn't register a listener on this event; check if you \" +\n                        \"properly call 'on()' method with a signal listener\"\n                    return\n\n                length = arguments.length\n                args = new Array length - 1\n                for i in [0...length - 1] by 1\n                    args[i] = arguments[i + 1]\n\n                item = itemListeners[0]\n                for i in [1...itemListeners.length] by 1\n                    itemListeners[i].apply item, args\n\n                return\n\n            on: (name, func) ->\n                assert.isString name, \"NativeItem.on name must be a string, but #{name} given\"\n                assert.isFunction func, \"\"\"\n                    NativeItem.on listener must be a function, but #{func} given\n                \"\"\"\n\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    ctorName = utils.capitalize @constructor.__name__\n                    eventName = \"rendererOn#{ctorName}#{name}\"\n\n                    unless listeners = eventListeners[eventName]\n                        listeners = eventListeners[eventName] = Object.create(null)\n                        onNativeEvent eventName, createNativeEventListener(listeners, eventName)\n\n                    itemListeners = listeners[@_impl.id] ?= [@]\n                    itemListeners.push func\n                else\n                    eventName = \"on#{name}\"\n                    @_impl[eventName]?.connect func\n                return\n\n        Native\n","old_contents":"# Native\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    assert = require 'src\/assert'\n    colorUtils = require 'src\/renderer\/utils\/color'\n\n    IS_NATIVE = utils.isNative\n\n    if IS_NATIVE\n        {callNativeFunction, onNativeEvent} = require 'src\/native'\n\n    module.exports = (Renderer, Impl, itemUtils) ->\n\n        class Native extends Renderer.Item\n            @__name__ = 'Native'\n            @__path__ = 'Renderer.Native'\n\n## *Native* Native.New([*Object* options])\n\n            @New = (opts) ->\n                item = new @\n                itemUtils.Object.initialize item, opts\n                unless IS_NATIVE\n                    item.onParentChange Impl.updateNativeSize\n                @Initialize? item\n                item\n\n## Native.defineProperty(*Object* config)\n\nDefines new property with the given name.\n\nFor each property, signal `onXYZChange` is created,\nwhere `XYZ` is the given name.\n\n`config` parameter must be an object with specified keys:\n- `enabled` - whether it's supported on current platform,\n- `name` - name of the property,\n- `type` - type of predefined condifuration described below,\n- `defaultValue`,\n- `setter`,\n- `getter`,\n- `developmentSetter`\n- `implementationValue` - function returning value passed to the implementation.\n\n### Predefined types\n\n            PROPERTY_TYPES = Object.create null\n\n#### text\n\n            PROPERTY_TYPES.text = ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n\n#### number\n\n            PROPERTY_TYPES.number = ->\n                defaultValue: 0\n                developmentSetter: (val) ->\n                    assert.isFloat val\n\n#### boolean\n\n            PROPERTY_TYPES.boolean = ->\n                defaultValue: false\n                developmentSetter: (val) ->\n                    assert.isBoolean val\n\n#### color\n\n            PROPERTY_TYPES.color = (config) ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n                implementationValue: do ->\n                    RESOURCE_REQUEST =\n                        property: 'color'\n                    (val) ->\n                        val = Renderer.resources?.resolve(val, RESOURCE_REQUEST) or val\n                        if IS_NATIVE\n                            if val?\n                                colorUtils.toRGBAHex val, config.defaultValue\n                            else\n                                null\n                        else\n                            val\n\n#### item\n\n            PROPERTY_TYPES.item = (config) ->\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Renderer.Item\n                implementationValue: (val) ->\n                    if IS_NATIVE\n                        if val?\n                            val._impl.id\n                        else\n                            null\n                    else\n                        val\n\n            @defineProperty = (config) ->\n                itemName = @__name__\n                properties = @_properties ||= []\n                config = utils.clone config\n\n                assert.isString itemName, '''\n                    NativeItem.__name__ unique name must be specified\n                '''\n                assert.isObject config, '''\n                    NativeItem.defineProperty config parameter must be an object\n                '''\n                assert.isString config.name, '''\n                    NativeItem property name must be a string\n                '''\n                assert.isNotDefined properties[config.name], \"\"\"\n                    Property #{config.name} is already defined\n                \"\"\"\n                assert.isDefined PROPERTY_TYPES[config.type], \"\"\"\n                    Unknown property type #{config.type}\n                \"\"\" if config.type\n\n                # type\n                if typeConfigFunc = PROPERTY_TYPES[config.type]\n                    typeConfig = typeConfigFunc(config)\n                    for key, val of typeConfig\n                        if key not of config\n                            config[key] = val\n\n                # constructor\n                config.constructor = @\n\n                # internalName\n                config.internalName = itemUtils.getPropInternalName config.name\n\n                # implementation\n                config.implementation = do ->\n                    if config.enabled is false\n                        return utils.NOP\n\n                    ctorName = utils.capitalize itemName\n                    name = utils.capitalize config.name\n                    if IS_NATIVE\n                        funcName = \"rendererSet#{ctorName}#{name}\"\n                        (val) ->\n                            callNativeFunction funcName, @_impl.id, val\n                    else\n                        funcName = \"set#{ctorName}#{name}\"\n                        (val) ->\n                            Impl[funcName]?.call @, val\n\n                # save\n                properties.push config\n\n                # create\n                itemUtils.defineProperty config\n\n## *Native* Native::constructor() : *Item*\n\n            constructor: ->\n                super()\n\n                @_autoWidth = true\n                @_autoHeight = true\n                @_width = -1\n                @_height = -1\n\n                # save properties with default values\n                if properties = @constructor._properties\n                    for property in properties\n                        @[property.internalName] = property.defaultValue\n\n            _width: -1\n            getter = utils.lookupGetter @::, 'width'\n            itemWidthSetter = utils.lookupSetter @::, 'width'\n            utils.defineProperty @::, 'width', null, getter,\n                do (_super = itemWidthSetter) -> (val) ->\n                    if @_autoWidth = val is -1\n                        Impl.updateNativeSize.call @\n                    else\n                        _super.call @, val\n                    return\n\n            _height: -1\n            getter = utils.lookupGetter @::, 'height'\n            itemHeightSetter = utils.lookupSetter @::, 'height'\n            utils.defineProperty @::, 'height', null, getter,\n                do (_super = itemHeightSetter) -> (val) ->\n                    if @_autoHeight = val is -1\n                        Impl.updateNativeSize.call @\n                    else\n                        _super.call @, val\n                    return\n\n## Native::set(*String* propName, *Any* val)\n\n            set: (name, val) ->\n                assert.isString name, \"NativeItem.set name must be a string, but #{name} given\"\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    funcName = \"rendererSet#{ctorName}#{name}\"\n                    callNativeFunction funcName, id, val\n                else\n                    funcName = \"set#{ctorName}#{name}\"\n                    Impl[funcName]?.call @, val\n                return\n\n## Native::call(*String* funcName, *Any* args...)\n\n            call: (name, args...) ->\n                assert.isString name, \"NativeItem.call name must be a string, but #{name} given\"\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    funcName = \"rendererCall#{ctorName}#{name}\"\n                    callArgs = [funcName, id, args...]\n                    callNativeFunction callArgs...\n                else\n                    funcName = \"call#{ctorName}#{name}\"\n                    Impl[funcName]?.apply @, args\n                return\n\n## Native::on(*String* eventName, *Function* listener)\n\n            # nativeEventName -> item id -> [item, listeners...]\n            eventListeners = Object.create null\n\n            createNativeEventListener = (listeners, eventName) -> (id) ->\n                unless itemListeners = listeners[id]\n                    log.warn \"Got a native event '#{eventName}' for an item which \" +\n                        \"didn't register a listener on this event; check if you \" +\n                        \"properly call 'on()' method with a signal listener\"\n                    return\n\n                length = arguments.length\n                args = new Array length - 1\n                for i in [0...length - 1] by 1\n                    args[i] = arguments[i + 1]\n\n                item = itemListeners[0]\n                for i in [1...itemListeners.length] by 1\n                    itemListeners[i].apply item, args\n\n                return\n\n            on: (name, func) ->\n                assert.isString name, \"NativeItem.on name must be a string, but #{name} given\"\n                assert.isFunction func, \"\"\"\n                    NativeItem.on listener must be a function, but #{func} given\n                \"\"\"\n\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    ctorName = utils.capitalize @constructor.__name__\n                    eventName = \"rendererOn#{ctorName}#{name}\"\n\n                    unless listeners = eventListeners[eventName]\n                        listeners = eventListeners[eventName] = Object.create(null)\n                        onNativeEvent eventName, createNativeEventListener(listeners, eventName)\n\n                    itemListeners = listeners[@_impl.id] ?= [@]\n                    itemListeners.push func\n                else\n                    eventName = \"on#{name}\"\n                    @_impl[eventName]?.connect func\n                return\n\n        Native\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"db20720a85ca36e7d07b0f239eabb160eeef52ba","subject":"Some wording changes","message":"Some wording changes\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a node's child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","old_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a nodes child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it being visible until ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also prevent you from allowing features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"540e259b41fb83e89422a33d6b37925faf13fa37","subject":"Added documentation for new config params","message":"Added documentation for new config params\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/arguments.litcoffee","new_file":"lib\/arguments.litcoffee","new_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] levelname anotherlevelname yetanotherlevelname ...'\n      .example '$0',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -vvvvvvvv',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to verbosity level 8 (max)\\n\"\n      .example '$0 -w 20 -h 20',\n        \"Creates a level with default row and column counts,\n         the cells 20 units wide, 20 units high,\n         expanded by the default multiplier,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -w 10 -h 10 -x 4',\n        \"Creates a level with default row and column counts,\n         40 x 40 unit cells,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 lvl1 lvl2',\n        \"Creates two levels; named lvl1 and lvl2 -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 --levels one two three',\n        \"Creates three levels; named one, two, and three -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 -l10',\n        \"Creates ten auto-named levels -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .string 'conf'\n      .describe 'conf', 'Absolute path to config file'\n      .string 'block.fill_color'\n      .describe 'block.fill_color', 'Path block color. Can be an html color name or hex value'\n      .string 'ground.fill_color'\n      .describe 'ground.fill_color', 'Ground block color. Can be an html color name or hex value'\n      .string 'step_count.text.align'\n      .choices 'step_count.text.align', [ 'left', 'center', 'right' ]\n      .string 'step_count.text.color'\n      .describe 'step_count.text.color', 'Can be either html color names or hex values'\n      .number 'ground.segments'\n      .describe 'ground.segments', 'The number of horizontal pieces of ground between the left and right edges of the block'\n      .number 'ground.max_height_diff'\n      .describe 'ground.max_height_diff', 'The height unit difference between two adjacent ground segments'\n      .number 'ground.max_segment_width'\n      .describe 'ground.max_segment_width', 'The number of ground segments wide the widest a single ground segment can be'\n      .number 'wall.width'\n      .string 'wall.color'\n      .describe 'wall.color', 'Can be either html color names or hex values'\n      .number 'wall.segments'\n      .describe 'wall.segments', 'The number of vertical pieces of wall between the ground and roof'\n      .string 'db.user'\n      .describe 'The username used when connecting to a database'\n      .string 'db.password'\n      .describe 'The password used when connecting to a database (may be blank)'\n      .string 'db.host'\n      .describe 'The hostname used when connecting to a database'\n      .number 'db.port'\n      .describe 'The port number used when connecting to a database'\n      .string 'db.name'\n      .describe 'The name of the database to connect to'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      24\n        height:     24\n        multiplier: 4\n        pipeline:   [ 'json_blocks', 'json_ground', 'json_walls', 'json_platforms' ]\n        # pipeline:   [ 'png_blocks', 'png_walls', 'png_ground', 'png_platforms', 'png_step_count' ]\n        # pipeline: [\n        #   [ 'json_blocks',   'json_ground', 'json_walls', 'json_platforms' ]\n        #   [ 'png_blocks',    'png_ground',  'png_walls', 'png_roof', 'png_platforms', 'png_step_count' ]\n        #   [ 'postgres_grid', 'postgres_blocks', 'postgres_ground' ]\n        # ]\n        block:\n          fill_color: 'white'\n        ground:\n          fill_color:     '#888'\n          segments:        24\n          max_height_diff: 4\n          max_segment_width: 6\n        step_count:\n          text:\n            align: 'center'\n            color: 'black'\n        wall:\n          width: 1\n          color: '#666'\n          segments: 48\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .wrap 120\n      .argv\n","old_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] levelname anotherlevelname yetanotherlevelname ...'\n      .example '$0',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -vvvvvvvv',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to verbosity level 8 (max)\\n\"\n      .example '$0 -w 20 -h 20',\n        \"Creates a level with default row and column counts,\n         the cells 20 units wide, 20 units high,\n         expanded by the default multiplier,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -w 10 -h 10 -x 4',\n        \"Creates a level with default row and column counts,\n         40 x 40 unit cells,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 lvl1 lvl2',\n        \"Creates two levels; named lvl1 and lvl2 -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 --levels one two three',\n        \"Creates three levels; named one, two, and three -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 -l10',\n        \"Creates ten auto-named levels -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .string 'conf'\n      .describe 'conf', 'Absolute path to config file'\n      .string 'block.fill_color'\n      .describe 'block.fill_color', 'Path block color. Can be an html color name or hex value'\n      .string 'ground.fill_color'\n      .describe 'ground.fill_color', 'Ground block color. Can be an html color name or hex value'\n      .string 'step_count.text.align'\n      .choices 'step_count.text.align', [ 'left', 'center', 'right' ]\n      .string 'step_count.text.color'\n      .describe 'step_count.text.color', 'Can be either html color names or hex values'\n      .number 'ground.segments'\n      .describe 'ground.segments', 'The number of horizontal pieces of ground between the left and right edges of the block'\n      .number 'ground.max_height_diff'\n      .describe 'ground.max_height_diff', 'The height unit difference between two adjacent ground segments'\n      .number 'ground.max_segment_width'\n      .describe 'ground.max_segment_width', 'The number of ground segments wide the widest a single ground segment can be'\n      .number 'wall.width'\n      .string 'wall.color'\n      .describe 'wall.color', 'Can be either html color names or hex values'\n      .number 'wall.segments'\n      .describe 'wall.segments', 'The number of vertical pieces of wall between the ground and roof'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      24\n        height:     24\n        multiplier: 4\n        # pipeline:   [ 'json_blocks', 'json_ground', 'json_walls' ]\n        # pipeline:   [ 'png_blocks', 'png_walls', 'png_ground', 'png_step_count' ]\n        pipeline: [\n          [ 'json_blocks', 'json_ground', 'json_walls' ]\n          [ 'png_blocks',  'png_ground',  'png_walls', 'png_roof', 'png_step_count' ]\n        ]\n        block:\n          fill_color: 'white'\n        ground:\n          fill_color:     '#888'\n          segments:        24\n          max_height_diff: 4\n          max_segment_width: 6\n        step_count:\n          text:\n            align: 'center'\n            color: 'black'\n        wall:\n          width: 1\n          color: '#666'\n          segments: 24\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .wrap 120\n      .argv\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cc9a1f61468fd65aaac0c672c9394983a6c698e6","subject":"Changed Item::scaleInPoint() to be absolute","message":"Changed Item::scaleInPoint() to be absolute\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/renderer\/types\/basics\/item.litcoffee","new_file":"src\/renderer\/types\/basics\/item.litcoffee","new_contents":"# Item\n\n    'use strict'\n\n    assert = require 'src\/assert'\n    utils = require 'src\/utils'\n    signal = require 'src\/signal'\n    List = require 'src\/list'\n    Matrix = require 'src\/renderer\/utils\/Matrix'\n\n    {isArray} = Array\n    {emitSignal} = signal.Emitter\n\n    assert = assert.scope 'Renderer.Item'\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Item extends itemUtils.Object\n        @__name__ = 'Item'\n        @__path__ = 'Renderer.Item'\n\n        Document = require 'src\/document'\n        DocElement = Document.Element\n\n## *Item* Item.New([*Object* options])\n\n        @New = (opts) ->\n            item = new Item\n            itemUtils.Object.initialize item, opts\n            item\n\n## *Item* Item::constructor()\n\nThis is a base class for everything which is visible.\n\n        constructor: ->\n            assert.instanceOf @, Item\n\n            super()\n            @_parent = null\n            @_children = null\n            @_previousSibling = null\n            @_nextSibling = null\n            @_belowSibling = null\n            @_aboveSibling = null\n            @_width = 0\n            @_height = 0\n            @_x = 0\n            @_y = 0\n            @_z = 0\n            @_visible = true\n            @_clip = false\n            @_scale = 1\n            @_rotation = 0\n            @_opacity = 1\n            @_linkUri = ''\n            @_anchors = null\n            @_layout = null\n            @_keys = null\n            @_pointer = null\n            @_margin = null\n            @_classes = null\n            @_query = ''\n            @_node = null\n\n### Custom properties\n\n```nml\nItem {\n    id: main\n    property currentLife: 0.8\n    Text {\n        text: \"Life: \" + main.currentLife\n    }\n}\n```\n\n### Custom signals\n\n```nml\nItem {\n    signal onPlayerCollision\n    onPlayerCollision(){\n        \/\/ boom!\n    }\n}\n```\n\n## ReadOnly *String* Item::query\n\n        utils.defineProperty @::, 'query', null, ->\n            @_query\n        , (val) ->\n            if @_query is ''\n                @_query = val\n            return\n\n## ReadOnly *Document.Element* Item::node\n\n## *Signal* Item::onNodeChange(*Document.Element* oldValue)\n\n```javascript\nText {\n    text: this.node.props.value\n}\n```\n\n```javascript\nText {\n    onNodeChange: function(){\n        var inputs = this.node.queryAll('input[type=string]');\n    }\n}\n```\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'node'\n            defaultValue: null\n            developmentSetter: (val) ->\n                if val?\n                    assert.instanceOf val, DocElement\n\n## *Signal* Item::ready()\n\nCalled when the Item is ready, that is, all\nproperties have been set and it's ready to use.\n\n```nml\nRectangle {\n    width: 200\n    height: 50\n    color: 'green'\n    Rectangle {\n        width: parent.width \/ 2\n        height: parent.height \/ 2\n        color: 'yellow'\n        onReady: function(){\n            console.log(this.width, this.height);\n            \/\/ 100, 25\n        }\n    }\n}\n```\n\n        signal.Emitter.createSignal @, 'onReady'\n\n## *Signal* Item::onAnimationFrame(*Integer* miliseconds)\n\n        signal.Emitter.createSignal @, 'onAnimationFrame', do ->\n            now = Date.now()\n            items = []\n\n            frame = ->\n                oldNow = now\n                now = Date.now()\n                ms = now - oldNow\n\n                for item in items\n                    emitSignal item, 'onAnimationFrame', ms\n                requestAnimationFrame frame\n\n            requestAnimationFrame? frame\n\n            (item) ->\n                items.push item\n\n## ReadOnly *String* Item::id\n\n## *Object* Item::children\n\n        utils.defineProperty @::, 'children', null, ->\n            @_children ||= new ChildrenObject(@)\n        , (val) ->\n            assert.isArray val, \"Item.children needs to be an array, but #{val} given\"\n            @clear()\n            for item in val\n                val.parent = @\n            return\n\n## *Signal* Item::onChildrenChange(*Item* added, *Item* removed)\n\n        signal.Emitter.createSignal @, 'onChildrenChange'\n\n        class ChildrenObject extends itemUtils.MutableDeepObject\n            constructor: (ref) ->\n                @_layout = null\n                @_target = null\n                @_firstChild = null\n                @_lastChild = null\n                @_bottomChild = null\n                @_topChild = null\n                @_length = 0\n                super ref\n\n### ReadOnly *Item* Item::children.firstChild\n\n            utils.defineProperty @::, 'firstChild', null, ->\n                @_firstChild\n            , null\n\n### ReadOnly *Item* Item::children.lastChild\n\n            utils.defineProperty @::, 'lastChild', null, ->\n                @_lastChild\n            , null\n\n### ReadOnly *Item* Item::children.bottomChild\n\n            utils.defineProperty @::, 'bottomChild', null, ->\n                @_bottomChild\n            , null\n\n### ReadOnly *Item* Item::children.topChild\n\n            utils.defineProperty @::, 'topChild', null, ->\n                @_topChild\n            , null\n\n### ReadOnly *Integer* Item::children.length\n\n            utils.defineProperty @::, 'length', null, ->\n                @_length\n            , null\n\n### *Item* Item::children.layout\n\nItem used to position children items.\nCan be e.g. *Flow*, *Grid* etc.\n\n### *Signal* Item::children.onLayoutChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'layout'\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Item, \"\"\"\n                            Item.children.layout needs to be an Item, but #{val} given\n                        \"\"\"\n                setter: (_super) -> (val) ->\n                    if @_layout?.effectItem\n                        @_layout.parent = null\n                        @_layout.effectItem = @_layout\n\n                    _super.call @, val\n\n                    if '_effectItem' of @_ref\n                        @_ref.effectItem = if val then null else @_ref\n\n                    if val?\n                        ref = @_ref\n                        setFakeParent val, ref, 0\n                        if val.effectItem\n                            val.effectItem = ref\n\n                    return\n\n### *Item* Item::children.target\n\nA new child trying to be added into the item with the `children.target` defined\nwill be added into the `target` item.\n\n### *Signal* Item::children.onTargetChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'target'\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Item, \"\"\"\n                            Item.children.target needs to be an Item, but #{val} given\n                        \"\"\"\n\n### *Item* Item::children.get(*Integer* index)\n\nReturns an item with the given index.\n\n            get: (val) ->\n                assert.operator val, '>=', 0, \"\"\"\n                    Item.children.get index cannot be lower than zero, #{val} given\n                \"\"\"\n                assert.operator val, '<', @length, \"\"\"\n                    Item.children.get index must be lower than children.length, \\\n                    #{val} given\n                \"\"\"\n\n                if val < @length \/ 2\n                    sibling = @firstChild\n                    while val > 0\n                        sibling = sibling.nextSibling\n                        val--\n                else\n                    sibling = @lastChild\n                    while val > 0\n                        sibling = sibling.previousSibling\n                        val--\n\n                sibling\n\n### *Integer* Item::children.index(*Item* value)\n\nReturns an index of the given child in the children array.\n\n            index: (val) ->\n                if @has(val)\n                    val.index\n                else\n                    -1\n\n### *Boolean* Item::children.has(*Item* value)\n\nReturns `true` if the given item is an item child.\n\n            has: (val) ->\n                @_ref is val._parent\n\n### Item::children.clear()\n\nRemoves all children from the item.\n\n            clear: ->\n                while last = @last\n                    last.parent = null\n                return\n\n## *Item* Item::parent = `null`\n\n## *Signal* Item::onParentChange(*Item* oldParent)\n\n        setFakeParent = (child, parent, index=-1) ->\n            child.parent = null\n\n            if index >= 0 and parent.children._length < index\n                Impl.insertItemBefore.call child, parent.children[index]\n            else\n                Impl.setItemParent.call child, parent\n\n            child._parent = parent\n            emitSignal child, 'onParentChange', null\n            return\n\n        updateZSiblingsForAppendedItem = (item, z, newChildren) ->\n            child = newChildren._topChild\n            while child\n                if child._z <= z\n                    if item._aboveSibling = child._aboveSibling\n                        item._aboveSibling._belowSibling = item\n                    item._belowSibling = child\n                    child._aboveSibling = item\n                    return\n                unless nextChild = child._belowSibling\n                    item._aboveSibling = child\n                    child._belowSibling = item\n                    item._belowSibling = null\n                    return\n                child = nextChild\n            return\n\n        insertItemInImpl = (item) ->\n            if aboveSibling = item._aboveSibling\n                Impl.insertItemBefore.call item, aboveSibling\n            else\n                Impl.setItemParent.call item, item._parent\n            return\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'parent'\n            defaultValue: null\n            setter: (_super) -> (val = null) ->\n                old = @_parent\n                oldChildren = old?.children\n                valChildren = val?.children\n\n                if valChildren?._target\n                    # detect whether target is a child of this item\n                    containsItem = false\n                    tmpItem = valChildren._target\n                    while tmpItem\n                        if tmpItem is @\n                            containsItem = true\n                            break\n                        tmpItem = tmpItem._parent\n\n                    unless containsItem\n                        val = valChildren._target\n                        valChildren = val.children\n\n                if old is val\n                    return\n\n                assert.isNot @, val, \"Item.parent cannot be set with context item, #{val} given\"\n\n                if pointer = @_pointer\n                    pointer.hover = pointer.pressed = false\n\n                if val isnt null\n                    assert.instanceOf val, Item, \"\"\"\n                        Item.parent needs to be an Item or null, but #{val} given\n                    \"\"\"\n\n                # old siblings\n                oldPreviousSibling = @_previousSibling\n                oldNextSibling = @_nextSibling\n                if oldPreviousSibling isnt null\n                    oldPreviousSibling._nextSibling = oldNextSibling\n                if oldNextSibling isnt null\n                    oldNextSibling._previousSibling = oldPreviousSibling\n\n                # new siblings\n                if val isnt null\n                    if previousSibling = @_previousSibling = valChildren.lastChild\n                        previousSibling._nextSibling = @\n                else\n                    @_previousSibling = null\n                if oldNextSibling isnt null\n                    @_nextSibling = null\n\n                # children\n                if oldChildren\n                    oldChildren._length -= 1\n                    if oldChildren.firstChild is @\n                        oldChildren._firstChild = oldNextSibling\n                    if oldChildren.lastChild is @\n                        oldChildren._lastChild = oldPreviousSibling\n                if valChildren\n                    if ++valChildren._length is 1\n                        valChildren._firstChild = @\n                    valChildren._lastChild = @\n\n                # old z-index siblings\n                oldBelowSibling = @_belowSibling\n                oldAboveSibling = @_aboveSibling\n                if oldBelowSibling isnt null\n                    oldBelowSibling._aboveSibling = oldAboveSibling\n                if oldAboveSibling isnt null\n                    oldAboveSibling._belowSibling = oldBelowSibling\n\n                # new z-index siblings\n                @_belowSibling = @_aboveSibling = null\n                if valChildren\n                    updateZSiblingsForAppendedItem @, @_z, valChildren\n\n                # z-index children\n                if oldChildren\n                    unless oldAboveSibling\n                        oldChildren._topChild = oldBelowSibling\n                    unless oldBelowSibling\n                        oldChildren._bottomChild = oldAboveSibling\n                if valChildren\n                    unless @_aboveSibling\n                        valChildren._topChild = @\n                    unless @_belowSibling\n                        valChildren._bottomChild = @\n\n                # parent\n                @_parent = val\n                insertItemInImpl @\n\n                `\/\/<development>`\n                assert.is @nextSibling, null\n                if val\n                    assert.is val.children.lastChild, @\n                    assert.isDefined val.children.firstChild\n                    assert.isDefined val.children.lastChild\n                    assert.isDefined val.children.topChild\n                    assert.isDefined val.children.bottomChild\n                if old and old.children.length is 0\n                    assert.isNotDefined old.children.firstChild\n                    assert.isNotDefined old.children.lastChild\n                    assert.isNotDefined old.children.topChild\n                    assert.isNotDefined old.children.bottomChild\n                `\/\/<\/development>`\n\n                # signals\n                if old isnt null\n                    emitSignal old, 'onChildrenChange', null, @\n                if val isnt null\n                    emitSignal val, 'onChildrenChange', @, null\n\n                emitSignal @, 'onParentChange', old\n\n                if oldPreviousSibling isnt null\n                    emitSignal oldPreviousSibling, 'onNextSiblingChange', @\n                if oldNextSibling isnt null\n                    emitSignal oldNextSibling, 'onPreviousSiblingChange', @\n\n                if val isnt null or oldPreviousSibling isnt null\n                    if previousSibling\n                        emitSignal previousSibling, 'onNextSiblingChange', null\n                    emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling\n                if oldNextSibling isnt null\n                    emitSignal @, 'onNextSiblingChange', oldNextSibling\n\n                return\n\n## *Item* Item::previousSibling\n\n        utils.defineProperty @::, 'previousSibling', null, ->\n            @_previousSibling\n        , (val = null) ->\n            assert.isNot @, val, \"\"\"\n                Item.previousSibling cannot be set with context Item, #{val} given\n            \"\"\"\n\n            if val is @_previousSibling\n                return\n\n            if val\n                assert.instanceOf val, Item, \"\"\"\n                    Item.previousSibling must be an Item or null, but #{val} given\n                \"\"\"\n                nextSibling = val._nextSibling\n                if not nextSibling and val._parent isnt @_parent\n                    @parent = val._parent\n                else\n                    @nextSibling = nextSibling\n            else\n                assert.isDefined @_parent, \"\"\"\n                    Cannot null Item.previousSibling when Item has no parent\n                \"\"\"\n                @nextSibling = @_parent.children.firstChild\n\n            assert.is @_previousSibling, val\n            return\n\n## *Signal* Item::onPreviousSiblingChange(*Item* oldValue)\n\n        signal.Emitter.createSignal @, 'onPreviousSiblingChange'\n\n## *Item* Item::nextSibling\n\n        isNextSibling = (item, sibling) ->\n            while item\n                nextItem = item._nextSibling\n                if nextItem is sibling\n                    return true\n                item = nextItem\n            return false\n\n        isPreviousSibling = (item, sibling) ->\n            while item\n                prevItem = item._previousSibling\n                if prevItem is sibling\n                    return true\n                item = prevItem\n            return false\n\n        updateZSiblingsForInsertedItem = (item, nextSibling, z, newChildren) ->\n            if nextSibling._z is z\n                # simple case - the same z-index as in nextSibling\n                if item._belowSibling = nextSibling._belowSibling\n                    item._belowSibling._aboveSibling = item\n                item._aboveSibling = nextSibling\n                nextSibling._belowSibling = item\n            else\n                # hard case - different z-indexes\n                nextChild = newChildren._bottomChild\n                while child = nextChild\n                    nextChild = child._aboveSibling\n                    if child._z > z or (child._z is z and isNextSibling(item, child))\n                        item._aboveSibling = child\n                        if item._belowSibling = child._belowSibling\n                            item._belowSibling._aboveSibling = item\n                        child._belowSibling = item\n                        break\n                    unless nextChild\n                        item._aboveSibling = null\n                        item._belowSibling = child\n                        child._aboveSibling = item\n            return\n\n        utils.defineProperty @::, 'nextSibling', null, ->\n            @_nextSibling\n        , (val = null) ->\n            assert.isNot @, val, \"\"\"\n                Item.nextSibling cannot be set with context Item, #{val} given\n            \"\"\"\n            if val\n                assert.instanceOf val, Item, \"\"\"\n                    Item.nextSibling needs to be an Item or null, but #{val} given\n                \"\"\"\n                assert.isDefined val._parent, \"\"\"\n                    Item.nextSibling value needs to have a parent, given #{val} has no parent\n                \"\"\"\n            else\n                assert.isDefined @_parent, \"\"\"\n                    Cannot null Item.nextSibling when Item has no parent\n                \"\"\"\n\n            if val is @_nextSibling\n                return\n\n            oldParent = @_parent\n            oldChildren = oldParent?._children\n            oldPreviousSibling = @_previousSibling\n            oldNextSibling = @_nextSibling\n\n            if val\n                newParent = val._parent\n                newChildren = newParent._children\n            else\n                newParent = oldParent\n                newChildren = oldChildren\n\n            # new parent\n            @_parent = newParent\n\n            # current siblings\n            oldPreviousSibling?._nextSibling = oldNextSibling\n            oldNextSibling?._previousSibling = oldPreviousSibling\n\n            # new siblings\n            previousSibling = previousSiblingOldNextSibling = null\n            nextSibling = nextSiblingOldPreviousSibling = null\n            if val\n                if previousSibling = val._previousSibling\n                    previousSiblingOldNextSibling = previousSibling._nextSibling\n                    previousSibling._nextSibling = @\n\n                nextSibling = val\n                nextSiblingOldPreviousSibling = nextSibling._previousSibling\n                nextSibling._previousSibling = @\n            else\n                if previousSibling = newChildren.lastChild\n                    previousSibling._nextSibling = @\n\n            @_previousSibling = previousSibling\n            @_nextSibling = nextSibling\n\n            # children\n            if oldChildren\n                oldChildren._length -= 1\n                unless oldPreviousSibling\n                    oldChildren._firstChild = oldNextSibling\n                unless oldNextSibling\n                    oldChildren._lastChild = oldPreviousSibling\n            newChildren._length += 1\n            if newChildren.firstChild is val\n                newChildren._firstChild = @\n            unless val\n                newChildren._lastChild = @\n\n            # old z-index siblings\n            oldBelowSibling = @_belowSibling\n            oldAboveSibling = @_aboveSibling\n            if oldBelowSibling isnt null\n                oldBelowSibling._aboveSibling = oldAboveSibling\n            if oldAboveSibling isnt null\n                oldAboveSibling._belowSibling = oldBelowSibling\n\n            # new z-index siblings\n            @_belowSibling = @_aboveSibling = null\n            if nextSibling\n                updateZSiblingsForInsertedItem @, nextSibling, @_z, newChildren\n            else\n                updateZSiblingsForAppendedItem @, @_z, newChildren\n\n            # z-index children\n            if oldChildren\n                unless oldAboveSibling\n                    oldChildren._topChild = oldBelowSibling\n                unless oldBelowSibling\n                    oldChildren._bottomChild = oldAboveSibling\n            unless @_aboveSibling\n                newChildren._topChild = @\n            unless @_belowSibling\n                newChildren._bottomChild = @\n\n            # implementation\n            insertItemInImpl @\n\n            `\/\/<development>`\n            assert.is @_nextSibling, val\n            assert.is @_parent, newParent\n            if val\n                assert.is @_parent, val._parent\n            if @_previousSibling\n                assert.is @_previousSibling._nextSibling, @\n            if @_nextSibling\n                assert.is @_nextSibling._previousSibling, @\n            if oldPreviousSibling\n                assert.is oldPreviousSibling._nextSibling, oldNextSibling\n            if oldNextSibling\n                assert.is oldNextSibling._previousSibling, oldPreviousSibling\n            `\/\/<\/development>`\n\n            # children signal\n            if oldParent isnt newParent\n                if oldParent\n                    emitSignal oldParent, 'onChildrenChange', null, @\n                emitSignal newParent, 'onChildrenChange', @, null\n                emitSignal @, 'onParentChange', oldParent\n            else\n                emitSignal newParent, 'onChildrenChange', null, null\n\n            # current siblings signals\n            if oldPreviousSibling\n                emitSignal oldPreviousSibling, 'onNextSiblingChange', @\n            if oldNextSibling\n                emitSignal oldNextSibling, 'onPreviousSiblingChange', @\n\n            # new siblings signals\n            emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling\n            if previousSibling\n                emitSignal previousSibling, 'onNextSiblingChange', previousSiblingOldNextSibling\n            emitSignal @, 'onNextSiblingChange', oldNextSibling\n            if nextSibling\n                emitSignal nextSibling, 'onPreviousSiblingChange', nextSiblingOldPreviousSibling\n\n            return\n\n## *Signal* Item::onNextSiblingChange(*Item* oldValue)\n\n        signal.Emitter.createSignal @, 'onNextSiblingChange'\n\n## ReadOnly *Item* Item::belowSibling\n\n        utils.defineProperty @::, 'belowSibling', null, ->\n            @_belowSibling\n        , null\n\n## ReadOnly *Item* Item::aboveSibling\n\n        utils.defineProperty @::, 'aboveSibling', null, ->\n            @_aboveSibling\n        , null\n\n## *Integer* Item::index\n\n        utils.defineProperty @::, 'index', null, ->\n            index = 0\n            sibling = @\n            while sibling = sibling.previousSibling\n                index++\n            index\n        , (val) ->\n            assert.isInteger val, \"Item.index needs to be a integer, but #{val} given\"\n            assert.isDefined @_parent, \"\"\"\n                When setting Item.index, item needs to have a parent, #{@} has no parent\n            \"\"\"\n            assert.operator val, '>=', 0, \"Item.index needs to greater than zero, #{val} given\"\n            assert.operator val, '<=', @_parent._children.length, \"\"\"\n                Item.index needs to be lower than parent.children.length, #{val} given\n            \"\"\"\n\n            {children} = @parent\n            if val >= children.length\n                @nextSibling = null\n            else if (valItem = children.get(val)) isnt @\n                @nextSibling = valItem\n\n            return\n\n## *Boolean* Item::visible = `true`\n\nDetermines whether an item is visible or not.\n\n```nml\nItem {\n    width: 100\n    height: 100\n    pointer.onClick: function(){\n        rect.visible = !rect.visible;\n        text.text = rect.visible ? \"Click to hide\" : \"Click to show\";\n    }\n    Rectangle {\n        id: rect\n        anchors.fill: parent\n        color: 'blue'\n    }\n    Text {\n        id: text\n        text: \"Click to hide\"\n        anchors.centerIn: parent\n    }\n}\n```\n\n## *Signal* Item::onVisibleChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'visible'\n            defaultValue: true\n            implementation: Impl.setItemVisible\n            developmentSetter: (val) ->\n                assert.isBoolean val, \"Item.visible needs to be a boolean, but #{val} given\"\n\n## *Boolean* Item::clip = `false`\n\n## *Signal* Item::onClipChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'clip'\n            defaultValue: false\n            implementation: Impl.setItemClip\n            developmentSetter: (val) ->\n                assert.isBoolean val, \"Item.clip needs to be a boolean, but #{val} given\"\n\n## *Float* Item::width = `0`\n\n## *Signal* Item::onWidthChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'width'\n            defaultValue: 0\n            implementation: Impl.setItemWidth\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.width needs to be a float, but #{val} given\"\n\n## *Float* Item::height = `0`\n\n## *Signal* Item::onHeightChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'height'\n            defaultValue: 0\n            implementation: Impl.setItemHeight\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.height needs to be a float, but #{val} given\"\n\n## *Float* Item::x = `0`\n\n## *Signal* Item::onXChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'x'\n            defaultValue: 0\n            implementation: Impl.setItemX\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.x needs to be a float, but #{val} given\"\n\n## *Float* Item::y = `0`\n\n## *Signal* Item::onYChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'y'\n            defaultValue: 0\n            implementation: Impl.setItemY\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.y needs to be a float, but #{val} given\"\n\n## *Float* Item::z = `0`\n\n## *Signal* Item::onZChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'z'\n            defaultValue: 0\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.z needs to be a float, but #{val} given\"\n            setter: (_super) -> (val) ->\n                oldVal = @_z\n                if oldVal is val\n                    return\n\n                _super.call @, val\n\n                unless parent = @_parent\n                    return\n                children = parent._children\n                oldAboveSibling = @_aboveSibling\n                oldBelowSibling = @_belowSibling\n\n                # new siblings\n                if val > oldVal\n                    nextChild = @_aboveSibling\n                    while child = nextChild\n                        nextChild = child._aboveSibling\n                        if child._z > val or (child._z is val and isNextSibling(@, child))\n                            if oldAboveSibling is child\n                                break\n                            @_aboveSibling = child\n                            if @_belowSibling = child._belowSibling\n                                @_belowSibling._aboveSibling = @\n                            child._belowSibling = @\n                            break\n                        unless nextChild\n                            @_aboveSibling = null\n                            @_belowSibling = child\n                            child._aboveSibling = @\n\n                if val < oldVal\n                    prevChild = @_belowSibling\n                    while child = prevChild\n                        prevChild = child._belowSibling\n                        if child._z < val or (child._z is val and isPreviousSibling(@, child))\n                            if oldBelowSibling is child\n                                break\n                            @_belowSibling = child\n                            aboveSibling = child._aboveSibling\n                            if @_aboveSibling = child._aboveSibling\n                                @_aboveSibling._belowSibling = @\n                            child._aboveSibling = @\n                            break\n                        unless prevChild\n                            @_belowSibling = null\n                            @_aboveSibling = child\n                            child._belowSibling = @\n\n                # clean old siblings\n                if oldBelowSibling and oldBelowSibling isnt @_belowSibling\n                    oldBelowSibling._aboveSibling = oldAboveSibling\n                if oldAboveSibling and oldAboveSibling isnt @_aboveSibling\n                    oldAboveSibling._belowSibling = oldBelowSibling\n\n                # new children\n                if @_belowSibling\n                    if children._bottomChild is @\n                        children._bottomChild = oldAboveSibling\n                else\n                    children._bottomChild = @\n                if @_aboveSibling\n                    if children._topChild is @\n                        children._topChild = oldBelowSibling\n                else\n                    children._topChild = @\n\n                # implementation\n                if oldAboveSibling isnt @_aboveSibling\n                    insertItemInImpl @\n\n                `\/\/<development>`\n                assert.isNot @_belowSibling, @\n                assert.isNot @_belowSibling?._belowSibling, @\n                assert.isNot @_aboveSibling, @\n                assert.isNot @_aboveSibling?._aboveSibling, @\n                if @_belowSibling\n                    assert.is @_belowSibling._aboveSibling, @\n                if @_aboveSibling\n                    assert.is @_aboveSibling._belowSibling, @\n                `\/\/<\/development>`\n                return\n\n## *Float* Item::scale = `1`\n\n## *Signal* Item::onScaleChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'scale'\n            defaultValue: 1\n            implementation: Impl.setItemScale\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.scale needs to be a float, but #{val} given\"\n\n## *Float* Item::rotation = `0`\n\n```nml\nRectangle {\n    width: 100\n    height: 100\n    color: 'red'\n    rotation: Math.PI \/ 4\n}\n```\n\n## *Signal* Item::onRotationChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'rotation'\n            defaultValue: 0\n            implementation: Impl.setItemRotation\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.rotation needs to be a float, but #{val} given\"\n\n## *Float* Item::opacity = `1`\n\n## *Signal* Item::onOpacityChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'opacity'\n            defaultValue: 1\n            implementation: Impl.setItemOpacity\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.opacity needs to be a float, but #{val} given\"\n\n## *String* Item::linkUri = `''`\n\nPoints to the URI which will be used when user clicks on this item.\n\n## *Signal* Item::onLinkUriChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'linkUri'\n            defaultValue: ''\n            implementation: Impl.setItemLinkUri\n            developmentSetter: (val) ->\n                assert.isString val, \"Item.linkUri needs to be a string, but #{val} given\"\n\n## Item::scaleInPoint(*Float* scale, *Float* pointX, *Float* pointY)\n\n        scaleInPoint: (scale, pointX, pointY) ->\n            oldScale = @scale\n\n            # scale\n            @scale = scale\n\n            # move to point horizontal\n            {width} = @\n            widthChange = (width * scale - width * oldScale) \/ 2\n            xOriginToChange = -2 * (pointX \/ width) + 1\n            @x += xOriginToChange * widthChange\n\n            # move to point vertical\n            {height} = @\n            heightChange = (height * scale - height * oldScale) \/ 2\n            yOriginToChange = -2 * (pointY \/ height) + 1\n            @y += yOriginToChange * heightChange\n\n            return\n\n## *Object* Item::getGlobalComputes()\n\nReturns globally computed x, y, scale, rotation, visible and opacity.\n\n        getGlobalComputes: ->\n            m = new Matrix()\n            {visible, opacity} = @\n\n            chain = []\n            item = @\n            while item\n                chain.push(item)\n\n                visible and= item.visible\n                opacity *= item.opacity\n                item = item.parent\n\n            for item in chain by -1\n                originX = item.width \/ 2\n                originY = item.height \/ 2\n\n                m.translate(item.x + originX, item.y + originY)\n                m.scale(item.scale)\n                m.rotate(item.rotation)\n                m.translate(-originX, -originY)\n\n            mScale = m.getScale()\n            mRotation = m.getRotation()\n\n            m2 = new Matrix()\n            m2.translate(-@width \/ 2, -@height \/ 2)\n            m2.rotate(mRotation)\n            m2.translate(@width * mScale \/ 2, @height * mScale \/ 2)\n\n            mTranslate = m.getTranslate()\n            m2Translate = m2.getTranslate()\n\n            x: mTranslate.x + m2Translate.x\n            y: mTranslate.y + m2Translate.y\n            scale: mScale\n            rotation: mRotation\n\n        @createSpacing = require('.\/item\/spacing') Renderer, Impl, itemUtils, Item\n        @createAlignment = require('.\/item\/alignment') Renderer, Impl, itemUtils, Item\n        @createAnchors = require('.\/item\/anchors') Renderer, Impl, itemUtils, Item\n        @createLayout = require('.\/item\/layout') Renderer, Impl, itemUtils, Item\n        @createMargin = require('.\/item\/margin') Renderer, Impl, itemUtils, Item\n        @createPointer = require('.\/item\/pointer') Renderer, Impl, itemUtils, Item\n        @createKeys = require('.\/item\/keys') Renderer, Impl, itemUtils, Item\n\n## *Item.Anchors* Item::anchors\n\n## *Signal* Item::onAnchorsChange(*String* property, *Array* oldValue)\n\n        @createAnchors @\n\n## *Item.Layout* Item::layout\n\n## *Signal* Item::onLayoutChange(*String* property, *Any* oldValue)\n\n        @createLayout @\n\n## *Item.Pointer* Item::pointer\n\n        @Pointer = @createPointer @\n\n## *Item.Margin* Item::margin\n\n## *Signal* Item::onMarginChange(*String* property, *Any* oldValue)\n\n        @createMargin @\n\n## *Item.Keys* Item::keys\n\n        @Keys = @createKeys @\n\n        Item\n","old_contents":"# Item\n\n    'use strict'\n\n    assert = require 'src\/assert'\n    utils = require 'src\/utils'\n    signal = require 'src\/signal'\n    List = require 'src\/list'\n    Matrix = require 'src\/renderer\/utils\/Matrix'\n\n    {isArray} = Array\n    {emitSignal} = signal.Emitter\n\n    assert = assert.scope 'Renderer.Item'\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Item extends itemUtils.Object\n        @__name__ = 'Item'\n        @__path__ = 'Renderer.Item'\n\n        Document = require 'src\/document'\n        DocElement = Document.Element\n\n## *Item* Item.New([*Object* options])\n\n        @New = (opts) ->\n            item = new Item\n            itemUtils.Object.initialize item, opts\n            item\n\n## *Item* Item::constructor()\n\nThis is a base class for everything which is visible.\n\n        constructor: ->\n            assert.instanceOf @, Item\n\n            super()\n            @_parent = null\n            @_children = null\n            @_previousSibling = null\n            @_nextSibling = null\n            @_belowSibling = null\n            @_aboveSibling = null\n            @_width = 0\n            @_height = 0\n            @_x = 0\n            @_y = 0\n            @_z = 0\n            @_visible = true\n            @_clip = false\n            @_scale = 1\n            @_rotation = 0\n            @_opacity = 1\n            @_linkUri = ''\n            @_anchors = null\n            @_layout = null\n            @_keys = null\n            @_pointer = null\n            @_margin = null\n            @_classes = null\n            @_query = ''\n            @_node = null\n\n### Custom properties\n\n```nml\nItem {\n    id: main\n    property currentLife: 0.8\n    Text {\n        text: \"Life: \" + main.currentLife\n    }\n}\n```\n\n### Custom signals\n\n```nml\nItem {\n    signal onPlayerCollision\n    onPlayerCollision(){\n        \/\/ boom!\n    }\n}\n```\n\n## ReadOnly *String* Item::query\n\n        utils.defineProperty @::, 'query', null, ->\n            @_query\n        , (val) ->\n            if @_query is ''\n                @_query = val\n            return\n\n## ReadOnly *Document.Element* Item::node\n\n## *Signal* Item::onNodeChange(*Document.Element* oldValue)\n\n```javascript\nText {\n    text: this.node.props.value\n}\n```\n\n```javascript\nText {\n    onNodeChange: function(){\n        var inputs = this.node.queryAll('input[type=string]');\n    }\n}\n```\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'node'\n            defaultValue: null\n            developmentSetter: (val) ->\n                if val?\n                    assert.instanceOf val, DocElement\n\n## *Signal* Item::ready()\n\nCalled when the Item is ready, that is, all\nproperties have been set and it's ready to use.\n\n```nml\nRectangle {\n    width: 200\n    height: 50\n    color: 'green'\n    Rectangle {\n        width: parent.width \/ 2\n        height: parent.height \/ 2\n        color: 'yellow'\n        onReady: function(){\n            console.log(this.width, this.height);\n            \/\/ 100, 25\n        }\n    }\n}\n```\n\n        signal.Emitter.createSignal @, 'onReady'\n\n## *Signal* Item::onAnimationFrame(*Integer* miliseconds)\n\n        signal.Emitter.createSignal @, 'onAnimationFrame', do ->\n            now = Date.now()\n            items = []\n\n            frame = ->\n                oldNow = now\n                now = Date.now()\n                ms = now - oldNow\n\n                for item in items\n                    emitSignal item, 'onAnimationFrame', ms\n                requestAnimationFrame frame\n\n            requestAnimationFrame? frame\n\n            (item) ->\n                items.push item\n\n## ReadOnly *String* Item::id\n\n## *Object* Item::children\n\n        utils.defineProperty @::, 'children', null, ->\n            @_children ||= new ChildrenObject(@)\n        , (val) ->\n            assert.isArray val, \"Item.children needs to be an array, but #{val} given\"\n            @clear()\n            for item in val\n                val.parent = @\n            return\n\n## *Signal* Item::onChildrenChange(*Item* added, *Item* removed)\n\n        signal.Emitter.createSignal @, 'onChildrenChange'\n\n        class ChildrenObject extends itemUtils.MutableDeepObject\n            constructor: (ref) ->\n                @_layout = null\n                @_target = null\n                @_firstChild = null\n                @_lastChild = null\n                @_bottomChild = null\n                @_topChild = null\n                @_length = 0\n                super ref\n\n### ReadOnly *Item* Item::children.firstChild\n\n            utils.defineProperty @::, 'firstChild', null, ->\n                @_firstChild\n            , null\n\n### ReadOnly *Item* Item::children.lastChild\n\n            utils.defineProperty @::, 'lastChild', null, ->\n                @_lastChild\n            , null\n\n### ReadOnly *Item* Item::children.bottomChild\n\n            utils.defineProperty @::, 'bottomChild', null, ->\n                @_bottomChild\n            , null\n\n### ReadOnly *Item* Item::children.topChild\n\n            utils.defineProperty @::, 'topChild', null, ->\n                @_topChild\n            , null\n\n### ReadOnly *Integer* Item::children.length\n\n            utils.defineProperty @::, 'length', null, ->\n                @_length\n            , null\n\n### *Item* Item::children.layout\n\nItem used to position children items.\nCan be e.g. *Flow*, *Grid* etc.\n\n### *Signal* Item::children.onLayoutChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'layout'\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Item, \"\"\"\n                            Item.children.layout needs to be an Item, but #{val} given\n                        \"\"\"\n                setter: (_super) -> (val) ->\n                    if @_layout?.effectItem\n                        @_layout.parent = null\n                        @_layout.effectItem = @_layout\n\n                    _super.call @, val\n\n                    if '_effectItem' of @_ref\n                        @_ref.effectItem = if val then null else @_ref\n\n                    if val?\n                        ref = @_ref\n                        setFakeParent val, ref, 0\n                        if val.effectItem\n                            val.effectItem = ref\n\n                    return\n\n### *Item* Item::children.target\n\nA new child trying to be added into the item with the `children.target` defined\nwill be added into the `target` item.\n\n### *Signal* Item::children.onTargetChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'target'\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Item, \"\"\"\n                            Item.children.target needs to be an Item, but #{val} given\n                        \"\"\"\n\n### *Item* Item::children.get(*Integer* index)\n\nReturns an item with the given index.\n\n            get: (val) ->\n                assert.operator val, '>=', 0, \"\"\"\n                    Item.children.get index cannot be lower than zero, #{val} given\n                \"\"\"\n                assert.operator val, '<', @length, \"\"\"\n                    Item.children.get index must be lower than children.length, \\\n                    #{val} given\n                \"\"\"\n\n                if val < @length \/ 2\n                    sibling = @firstChild\n                    while val > 0\n                        sibling = sibling.nextSibling\n                        val--\n                else\n                    sibling = @lastChild\n                    while val > 0\n                        sibling = sibling.previousSibling\n                        val--\n\n                sibling\n\n### *Integer* Item::children.index(*Item* value)\n\nReturns an index of the given child in the children array.\n\n            index: (val) ->\n                if @has(val)\n                    val.index\n                else\n                    -1\n\n### *Boolean* Item::children.has(*Item* value)\n\nReturns `true` if the given item is an item child.\n\n            has: (val) ->\n                @_ref is val._parent\n\n### Item::children.clear()\n\nRemoves all children from the item.\n\n            clear: ->\n                while last = @last\n                    last.parent = null\n                return\n\n## *Item* Item::parent = `null`\n\n## *Signal* Item::onParentChange(*Item* oldParent)\n\n        setFakeParent = (child, parent, index=-1) ->\n            child.parent = null\n\n            if index >= 0 and parent.children._length < index\n                Impl.insertItemBefore.call child, parent.children[index]\n            else\n                Impl.setItemParent.call child, parent\n\n            child._parent = parent\n            emitSignal child, 'onParentChange', null\n            return\n\n        updateZSiblingsForAppendedItem = (item, z, newChildren) ->\n            child = newChildren._topChild\n            while child\n                if child._z <= z\n                    if item._aboveSibling = child._aboveSibling\n                        item._aboveSibling._belowSibling = item\n                    item._belowSibling = child\n                    child._aboveSibling = item\n                    return\n                unless nextChild = child._belowSibling\n                    item._aboveSibling = child\n                    child._belowSibling = item\n                    item._belowSibling = null\n                    return\n                child = nextChild\n            return\n\n        insertItemInImpl = (item) ->\n            if aboveSibling = item._aboveSibling\n                Impl.insertItemBefore.call item, aboveSibling\n            else\n                Impl.setItemParent.call item, item._parent\n            return\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'parent'\n            defaultValue: null\n            setter: (_super) -> (val = null) ->\n                old = @_parent\n                oldChildren = old?.children\n                valChildren = val?.children\n\n                if valChildren?._target\n                    # detect whether target is a child of this item\n                    containsItem = false\n                    tmpItem = valChildren._target\n                    while tmpItem\n                        if tmpItem is @\n                            containsItem = true\n                            break\n                        tmpItem = tmpItem._parent\n\n                    unless containsItem\n                        val = valChildren._target\n                        valChildren = val.children\n\n                if old is val\n                    return\n\n                assert.isNot @, val, \"Item.parent cannot be set with context item, #{val} given\"\n\n                if pointer = @_pointer\n                    pointer.hover = pointer.pressed = false\n\n                if val isnt null\n                    assert.instanceOf val, Item, \"\"\"\n                        Item.parent needs to be an Item or null, but #{val} given\n                    \"\"\"\n\n                # old siblings\n                oldPreviousSibling = @_previousSibling\n                oldNextSibling = @_nextSibling\n                if oldPreviousSibling isnt null\n                    oldPreviousSibling._nextSibling = oldNextSibling\n                if oldNextSibling isnt null\n                    oldNextSibling._previousSibling = oldPreviousSibling\n\n                # new siblings\n                if val isnt null\n                    if previousSibling = @_previousSibling = valChildren.lastChild\n                        previousSibling._nextSibling = @\n                else\n                    @_previousSibling = null\n                if oldNextSibling isnt null\n                    @_nextSibling = null\n\n                # children\n                if oldChildren\n                    oldChildren._length -= 1\n                    if oldChildren.firstChild is @\n                        oldChildren._firstChild = oldNextSibling\n                    if oldChildren.lastChild is @\n                        oldChildren._lastChild = oldPreviousSibling\n                if valChildren\n                    if ++valChildren._length is 1\n                        valChildren._firstChild = @\n                    valChildren._lastChild = @\n\n                # old z-index siblings\n                oldBelowSibling = @_belowSibling\n                oldAboveSibling = @_aboveSibling\n                if oldBelowSibling isnt null\n                    oldBelowSibling._aboveSibling = oldAboveSibling\n                if oldAboveSibling isnt null\n                    oldAboveSibling._belowSibling = oldBelowSibling\n\n                # new z-index siblings\n                @_belowSibling = @_aboveSibling = null\n                if valChildren\n                    updateZSiblingsForAppendedItem @, @_z, valChildren\n\n                # z-index children\n                if oldChildren\n                    unless oldAboveSibling\n                        oldChildren._topChild = oldBelowSibling\n                    unless oldBelowSibling\n                        oldChildren._bottomChild = oldAboveSibling\n                if valChildren\n                    unless @_aboveSibling\n                        valChildren._topChild = @\n                    unless @_belowSibling\n                        valChildren._bottomChild = @\n\n                # parent\n                @_parent = val\n                insertItemInImpl @\n\n                `\/\/<development>`\n                assert.is @nextSibling, null\n                if val\n                    assert.is val.children.lastChild, @\n                    assert.isDefined val.children.firstChild\n                    assert.isDefined val.children.lastChild\n                    assert.isDefined val.children.topChild\n                    assert.isDefined val.children.bottomChild\n                if old and old.children.length is 0\n                    assert.isNotDefined old.children.firstChild\n                    assert.isNotDefined old.children.lastChild\n                    assert.isNotDefined old.children.topChild\n                    assert.isNotDefined old.children.bottomChild\n                `\/\/<\/development>`\n\n                # signals\n                if old isnt null\n                    emitSignal old, 'onChildrenChange', null, @\n                if val isnt null\n                    emitSignal val, 'onChildrenChange', @, null\n\n                emitSignal @, 'onParentChange', old\n\n                if oldPreviousSibling isnt null\n                    emitSignal oldPreviousSibling, 'onNextSiblingChange', @\n                if oldNextSibling isnt null\n                    emitSignal oldNextSibling, 'onPreviousSiblingChange', @\n\n                if val isnt null or oldPreviousSibling isnt null\n                    if previousSibling\n                        emitSignal previousSibling, 'onNextSiblingChange', null\n                    emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling\n                if oldNextSibling isnt null\n                    emitSignal @, 'onNextSiblingChange', oldNextSibling\n\n                return\n\n## *Item* Item::previousSibling\n\n        utils.defineProperty @::, 'previousSibling', null, ->\n            @_previousSibling\n        , (val = null) ->\n            assert.isNot @, val, \"\"\"\n                Item.previousSibling cannot be set with context Item, #{val} given\n            \"\"\"\n\n            if val is @_previousSibling\n                return\n\n            if val\n                assert.instanceOf val, Item, \"\"\"\n                    Item.previousSibling must be an Item or null, but #{val} given\n                \"\"\"\n                nextSibling = val._nextSibling\n                if not nextSibling and val._parent isnt @_parent\n                    @parent = val._parent\n                else\n                    @nextSibling = nextSibling\n            else\n                assert.isDefined @_parent, \"\"\"\n                    Cannot null Item.previousSibling when Item has no parent\n                \"\"\"\n                @nextSibling = @_parent.children.firstChild\n\n            assert.is @_previousSibling, val\n            return\n\n## *Signal* Item::onPreviousSiblingChange(*Item* oldValue)\n\n        signal.Emitter.createSignal @, 'onPreviousSiblingChange'\n\n## *Item* Item::nextSibling\n\n        isNextSibling = (item, sibling) ->\n            while item\n                nextItem = item._nextSibling\n                if nextItem is sibling\n                    return true\n                item = nextItem\n            return false\n\n        isPreviousSibling = (item, sibling) ->\n            while item\n                prevItem = item._previousSibling\n                if prevItem is sibling\n                    return true\n                item = prevItem\n            return false\n\n        updateZSiblingsForInsertedItem = (item, nextSibling, z, newChildren) ->\n            if nextSibling._z is z\n                # simple case - the same z-index as in nextSibling\n                if item._belowSibling = nextSibling._belowSibling\n                    item._belowSibling._aboveSibling = item\n                item._aboveSibling = nextSibling\n                nextSibling._belowSibling = item\n            else\n                # hard case - different z-indexes\n                nextChild = newChildren._bottomChild\n                while child = nextChild\n                    nextChild = child._aboveSibling\n                    if child._z > z or (child._z is z and isNextSibling(item, child))\n                        item._aboveSibling = child\n                        if item._belowSibling = child._belowSibling\n                            item._belowSibling._aboveSibling = item\n                        child._belowSibling = item\n                        break\n                    unless nextChild\n                        item._aboveSibling = null\n                        item._belowSibling = child\n                        child._aboveSibling = item\n            return\n\n        utils.defineProperty @::, 'nextSibling', null, ->\n            @_nextSibling\n        , (val = null) ->\n            assert.isNot @, val, \"\"\"\n                Item.nextSibling cannot be set with context Item, #{val} given\n            \"\"\"\n            if val\n                assert.instanceOf val, Item, \"\"\"\n                    Item.nextSibling needs to be an Item or null, but #{val} given\n                \"\"\"\n                assert.isDefined val._parent, \"\"\"\n                    Item.nextSibling value needs to have a parent, given #{val} has no parent\n                \"\"\"\n            else\n                assert.isDefined @_parent, \"\"\"\n                    Cannot null Item.nextSibling when Item has no parent\n                \"\"\"\n\n            if val is @_nextSibling\n                return\n\n            oldParent = @_parent\n            oldChildren = oldParent?._children\n            oldPreviousSibling = @_previousSibling\n            oldNextSibling = @_nextSibling\n\n            if val\n                newParent = val._parent\n                newChildren = newParent._children\n            else\n                newParent = oldParent\n                newChildren = oldChildren\n\n            # new parent\n            @_parent = newParent\n\n            # current siblings\n            oldPreviousSibling?._nextSibling = oldNextSibling\n            oldNextSibling?._previousSibling = oldPreviousSibling\n\n            # new siblings\n            previousSibling = previousSiblingOldNextSibling = null\n            nextSibling = nextSiblingOldPreviousSibling = null\n            if val\n                if previousSibling = val._previousSibling\n                    previousSiblingOldNextSibling = previousSibling._nextSibling\n                    previousSibling._nextSibling = @\n\n                nextSibling = val\n                nextSiblingOldPreviousSibling = nextSibling._previousSibling\n                nextSibling._previousSibling = @\n            else\n                if previousSibling = newChildren.lastChild\n                    previousSibling._nextSibling = @\n\n            @_previousSibling = previousSibling\n            @_nextSibling = nextSibling\n\n            # children\n            if oldChildren\n                oldChildren._length -= 1\n                unless oldPreviousSibling\n                    oldChildren._firstChild = oldNextSibling\n                unless oldNextSibling\n                    oldChildren._lastChild = oldPreviousSibling\n            newChildren._length += 1\n            if newChildren.firstChild is val\n                newChildren._firstChild = @\n            unless val\n                newChildren._lastChild = @\n\n            # old z-index siblings\n            oldBelowSibling = @_belowSibling\n            oldAboveSibling = @_aboveSibling\n            if oldBelowSibling isnt null\n                oldBelowSibling._aboveSibling = oldAboveSibling\n            if oldAboveSibling isnt null\n                oldAboveSibling._belowSibling = oldBelowSibling\n\n            # new z-index siblings\n            @_belowSibling = @_aboveSibling = null\n            if nextSibling\n                updateZSiblingsForInsertedItem @, nextSibling, @_z, newChildren\n            else\n                updateZSiblingsForAppendedItem @, @_z, newChildren\n\n            # z-index children\n            if oldChildren\n                unless oldAboveSibling\n                    oldChildren._topChild = oldBelowSibling\n                unless oldBelowSibling\n                    oldChildren._bottomChild = oldAboveSibling\n            unless @_aboveSibling\n                newChildren._topChild = @\n            unless @_belowSibling\n                newChildren._bottomChild = @\n\n            # implementation\n            insertItemInImpl @\n\n            `\/\/<development>`\n            assert.is @_nextSibling, val\n            assert.is @_parent, newParent\n            if val\n                assert.is @_parent, val._parent\n            if @_previousSibling\n                assert.is @_previousSibling._nextSibling, @\n            if @_nextSibling\n                assert.is @_nextSibling._previousSibling, @\n            if oldPreviousSibling\n                assert.is oldPreviousSibling._nextSibling, oldNextSibling\n            if oldNextSibling\n                assert.is oldNextSibling._previousSibling, oldPreviousSibling\n            `\/\/<\/development>`\n\n            # children signal\n            if oldParent isnt newParent\n                if oldParent\n                    emitSignal oldParent, 'onChildrenChange', null, @\n                emitSignal newParent, 'onChildrenChange', @, null\n                emitSignal @, 'onParentChange', oldParent\n            else\n                emitSignal newParent, 'onChildrenChange', null, null\n\n            # current siblings signals\n            if oldPreviousSibling\n                emitSignal oldPreviousSibling, 'onNextSiblingChange', @\n            if oldNextSibling\n                emitSignal oldNextSibling, 'onPreviousSiblingChange', @\n\n            # new siblings signals\n            emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling\n            if previousSibling\n                emitSignal previousSibling, 'onNextSiblingChange', previousSiblingOldNextSibling\n            emitSignal @, 'onNextSiblingChange', oldNextSibling\n            if nextSibling\n                emitSignal nextSibling, 'onPreviousSiblingChange', nextSiblingOldPreviousSibling\n\n            return\n\n## *Signal* Item::onNextSiblingChange(*Item* oldValue)\n\n        signal.Emitter.createSignal @, 'onNextSiblingChange'\n\n## ReadOnly *Item* Item::belowSibling\n\n        utils.defineProperty @::, 'belowSibling', null, ->\n            @_belowSibling\n        , null\n\n## ReadOnly *Item* Item::aboveSibling\n\n        utils.defineProperty @::, 'aboveSibling', null, ->\n            @_aboveSibling\n        , null\n\n## *Integer* Item::index\n\n        utils.defineProperty @::, 'index', null, ->\n            index = 0\n            sibling = @\n            while sibling = sibling.previousSibling\n                index++\n            index\n        , (val) ->\n            assert.isInteger val, \"Item.index needs to be a integer, but #{val} given\"\n            assert.isDefined @_parent, \"\"\"\n                When setting Item.index, item needs to have a parent, #{@} has no parent\n            \"\"\"\n            assert.operator val, '>=', 0, \"Item.index needs to greater than zero, #{val} given\"\n            assert.operator val, '<=', @_parent._children.length, \"\"\"\n                Item.index needs to be lower than parent.children.length, #{val} given\n            \"\"\"\n\n            {children} = @parent\n            if val >= children.length\n                @nextSibling = null\n            else if (valItem = children.get(val)) isnt @\n                @nextSibling = valItem\n\n            return\n\n## *Boolean* Item::visible = `true`\n\nDetermines whether an item is visible or not.\n\n```nml\nItem {\n    width: 100\n    height: 100\n    pointer.onClick: function(){\n        rect.visible = !rect.visible;\n        text.text = rect.visible ? \"Click to hide\" : \"Click to show\";\n    }\n    Rectangle {\n        id: rect\n        anchors.fill: parent\n        color: 'blue'\n    }\n    Text {\n        id: text\n        text: \"Click to hide\"\n        anchors.centerIn: parent\n    }\n}\n```\n\n## *Signal* Item::onVisibleChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'visible'\n            defaultValue: true\n            implementation: Impl.setItemVisible\n            developmentSetter: (val) ->\n                assert.isBoolean val, \"Item.visible needs to be a boolean, but #{val} given\"\n\n## *Boolean* Item::clip = `false`\n\n## *Signal* Item::onClipChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'clip'\n            defaultValue: false\n            implementation: Impl.setItemClip\n            developmentSetter: (val) ->\n                assert.isBoolean val, \"Item.clip needs to be a boolean, but #{val} given\"\n\n## *Float* Item::width = `0`\n\n## *Signal* Item::onWidthChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'width'\n            defaultValue: 0\n            implementation: Impl.setItemWidth\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.width needs to be a float, but #{val} given\"\n\n## *Float* Item::height = `0`\n\n## *Signal* Item::onHeightChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'height'\n            defaultValue: 0\n            implementation: Impl.setItemHeight\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.height needs to be a float, but #{val} given\"\n\n## *Float* Item::x = `0`\n\n## *Signal* Item::onXChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'x'\n            defaultValue: 0\n            implementation: Impl.setItemX\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.x needs to be a float, but #{val} given\"\n\n## *Float* Item::y = `0`\n\n## *Signal* Item::onYChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'y'\n            defaultValue: 0\n            implementation: Impl.setItemY\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.y needs to be a float, but #{val} given\"\n\n## *Float* Item::z = `0`\n\n## *Signal* Item::onZChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'z'\n            defaultValue: 0\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.z needs to be a float, but #{val} given\"\n            setter: (_super) -> (val) ->\n                oldVal = @_z\n                if oldVal is val\n                    return\n\n                _super.call @, val\n\n                unless parent = @_parent\n                    return\n                children = parent._children\n                oldAboveSibling = @_aboveSibling\n                oldBelowSibling = @_belowSibling\n\n                # new siblings\n                if val > oldVal\n                    nextChild = @_aboveSibling\n                    while child = nextChild\n                        nextChild = child._aboveSibling\n                        if child._z > val or (child._z is val and isNextSibling(@, child))\n                            if oldAboveSibling is child\n                                break\n                            @_aboveSibling = child\n                            if @_belowSibling = child._belowSibling\n                                @_belowSibling._aboveSibling = @\n                            child._belowSibling = @\n                            break\n                        unless nextChild\n                            @_aboveSibling = null\n                            @_belowSibling = child\n                            child._aboveSibling = @\n\n                if val < oldVal\n                    prevChild = @_belowSibling\n                    while child = prevChild\n                        prevChild = child._belowSibling\n                        if child._z < val or (child._z is val and isPreviousSibling(@, child))\n                            if oldBelowSibling is child\n                                break\n                            @_belowSibling = child\n                            aboveSibling = child._aboveSibling\n                            if @_aboveSibling = child._aboveSibling\n                                @_aboveSibling._belowSibling = @\n                            child._aboveSibling = @\n                            break\n                        unless prevChild\n                            @_belowSibling = null\n                            @_aboveSibling = child\n                            child._belowSibling = @\n\n                # clean old siblings\n                if oldBelowSibling and oldBelowSibling isnt @_belowSibling\n                    oldBelowSibling._aboveSibling = oldAboveSibling\n                if oldAboveSibling and oldAboveSibling isnt @_aboveSibling\n                    oldAboveSibling._belowSibling = oldBelowSibling\n\n                # new children\n                if @_belowSibling\n                    if children._bottomChild is @\n                        children._bottomChild = oldAboveSibling\n                else\n                    children._bottomChild = @\n                if @_aboveSibling\n                    if children._topChild is @\n                        children._topChild = oldBelowSibling\n                else\n                    children._topChild = @\n\n                # implementation\n                if oldAboveSibling isnt @_aboveSibling\n                    insertItemInImpl @\n\n                `\/\/<development>`\n                assert.isNot @_belowSibling, @\n                assert.isNot @_belowSibling?._belowSibling, @\n                assert.isNot @_aboveSibling, @\n                assert.isNot @_aboveSibling?._aboveSibling, @\n                if @_belowSibling\n                    assert.is @_belowSibling._aboveSibling, @\n                if @_aboveSibling\n                    assert.is @_aboveSibling._belowSibling, @\n                `\/\/<\/development>`\n                return\n\n## *Float* Item::scale = `1`\n\n## *Signal* Item::onScaleChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'scale'\n            defaultValue: 1\n            implementation: Impl.setItemScale\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.scale needs to be a float, but #{val} given\"\n\n## *Float* Item::rotation = `0`\n\n```nml\nRectangle {\n    width: 100\n    height: 100\n    color: 'red'\n    rotation: Math.PI \/ 4\n}\n```\n\n## *Signal* Item::onRotationChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'rotation'\n            defaultValue: 0\n            implementation: Impl.setItemRotation\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.rotation needs to be a float, but #{val} given\"\n\n## *Float* Item::opacity = `1`\n\n## *Signal* Item::onOpacityChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'opacity'\n            defaultValue: 1\n            implementation: Impl.setItemOpacity\n            developmentSetter: (val) ->\n                assert.isFloat val, \"Item.opacity needs to be a float, but #{val} given\"\n\n## *String* Item::linkUri = `''`\n\nPoints to the URI which will be used when user clicks on this item.\n\n## *Signal* Item::onLinkUriChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'linkUri'\n            defaultValue: ''\n            implementation: Impl.setItemLinkUri\n            developmentSetter: (val) ->\n                assert.isString val, \"Item.linkUri needs to be a string, but #{val} given\"\n\n## Item::scaleInPoint(*Float* scale, *Float* pointX, *Float* pointY)\n\n        scaleInPoint: (scale, pointX, pointY) ->\n            oldScale = @scale\n\n            # scale\n            @scale *= scale\n\n            # move to point horizontal\n            {width} = @\n            widthChange = (width * @scale - width * oldScale) \/ 2\n            xOriginToChange = -2 * (pointX \/ width) + 1\n            @x += xOriginToChange * widthChange\n\n            # move to point vertical\n            {height} = @\n            heightChange = (height * @scale - height * oldScale) \/ 2\n            yOriginToChange = -2 * (pointY \/ height) + 1\n            @y += yOriginToChange * heightChange\n\n            return\n\n## *Object* Item::getGlobalComputes()\n\nReturns globally computed x, y, scale, rotation, visible and opacity.\n\n        getGlobalComputes: ->\n            m = new Matrix()\n            {visible, opacity} = @\n\n            chain = []\n            item = @\n            while item\n                chain.push(item)\n\n                visible and= item.visible\n                opacity *= item.opacity\n                item = item.parent\n\n            for item in chain by -1\n                originX = item.width \/ 2\n                originY = item.height \/ 2\n\n                m.translate(item.x + originX, item.y + originY)\n                m.scale(item.scale)\n                m.rotate(item.rotation)\n                m.translate(-originX, -originY)\n\n            mScale = m.getScale()\n            mRotation = m.getRotation()\n\n            m2 = new Matrix()\n            m2.translate(-@width \/ 2, -@height \/ 2)\n            m2.rotate(mRotation)\n            m2.translate(@width * mScale \/ 2, @height * mScale \/ 2)\n\n            mTranslate = m.getTranslate()\n            m2Translate = m2.getTranslate()\n\n            x: mTranslate.x + m2Translate.x\n            y: mTranslate.y + m2Translate.y\n            scale: mScale\n            rotation: mRotation\n\n        @createSpacing = require('.\/item\/spacing') Renderer, Impl, itemUtils, Item\n        @createAlignment = require('.\/item\/alignment') Renderer, Impl, itemUtils, Item\n        @createAnchors = require('.\/item\/anchors') Renderer, Impl, itemUtils, Item\n        @createLayout = require('.\/item\/layout') Renderer, Impl, itemUtils, Item\n        @createMargin = require('.\/item\/margin') Renderer, Impl, itemUtils, Item\n        @createPointer = require('.\/item\/pointer') Renderer, Impl, itemUtils, Item\n        @createKeys = require('.\/item\/keys') Renderer, Impl, itemUtils, Item\n\n## *Item.Anchors* Item::anchors\n\n## *Signal* Item::onAnchorsChange(*String* property, *Array* oldValue)\n\n        @createAnchors @\n\n## *Item.Layout* Item::layout\n\n## *Signal* Item::onLayoutChange(*String* property, *Any* oldValue)\n\n        @createLayout @\n\n## *Item.Pointer* Item::pointer\n\n        @Pointer = @createPointer @\n\n## *Item.Margin* Item::margin\n\n## *Signal* Item::onMarginChange(*String* property, *Any* oldValue)\n\n        @createMargin @\n\n## *Item.Keys* Item::keys\n\n        @Keys = @createKeys @\n\n        Item\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"ab38e77c20a896af63f1d2405ef1342964fae06d","subject":"adds note for refresh","message":"adds note for refresh\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/18b_property.litcoffee","new_file":"docs\/18b_property.litcoffee","new_contents":"\n# \/api\/Data Structures\/Batman.Event\/Batman.Property\n\n`Batman.Property` extends `Batman.PropertyEvent` (which extends `Batman.Event`). `Batman.Property` is home to batman.js's powerful source tracking capabilities.\n\n## Source Tracking by Batman.Property\n\nWhen you define an `@accessor` on a `Batman.Object`, the accessor's `get` function is actually wrapped in source tracking by `Batman.Property`. Source tracking is implemented by a global source tracker stack, `SOURCE_TRACKER_STACK`, which is inside `Batman.Property`'s closure scope. The source tracker stack's members are arrays of source objects. For example:\n\n```coffeescript\n## SOURCE_TRACKER_STACK\n[\n  [<Batman.Property 1>, <Batman.Property 2>], # a set of sources\n  [<Batman.Property 3>, <Batman.Property 4>], # another set of sources\n  [ < ... > ]\n]\n```\n\nCalling `get` signals to batman.js that a new source set may be added (via a variable inside `Batman.Property`'s closure scope, `SOURCE_TRACKER_STACK_VALID`). At the onset of a subsequent `get`:\n\n- a new, empty source set is pushed to the global tracker if needed\n- the property pushes itself to the current set of sources\n- the `get` signals that a new source set may be added.\n\nAt the completion of each `get`:\n\n- the last item of the global source tracker is popped off and stored as the `Property`'s `@sources`.\n\nSo, the global source tracker stack grows until a `get` doesn't depend on any other `Batman.Property` objects, then it starts to shrink. As it shrinks, each set of sources is attached to the `Property` which put it on the stack.\n\n## ::constructor(base, key: String) : Property\n\nReturns a new `Property` on `base` named `key`.\n\n## ::.base\n\nReturns `base` specified in the constructor. Represents the object the `Property` belongs to.\n\n## ::.key\n\nReturns the `key` specified in the constructor. Represents the name of property.\n\n## @.defaultAccessor : Object\n\nA JavaScript object implementing the [`Batman.Object.accessor`](\/docs\/api\/batman.object_accessors.html) pattern by storing the value on the `Property` directly.\n\n## @defaultAccessorForBase(base) : Object\n\nReturns the `base`s `'defualtAccessor'` if present, otherwise returns `Batman.Property.defaultAccessor`.\n\n## @accessorForBaseAndKey(base, key: String) :\n\nChecks `base` and its ancestors for an accessor for `string` and returns it if found, otherwise returns `Batman.Property.defaultAccessor`.\n\n## @forBaseAndKey(base, key: String) : Property\n\nIf `base.isObservable`, delegates to the object's `property` function to return a `Property` for key, otherwise returns a new `Batman.Keypath` for `base` and `key`.\n\n## @wrapTrackingPrevention(block: Function) : Function\n\nCreates a new function by wrapping `block` in _tracking prevention_ and returns it. When changes are wrapped in tracking prevention, they won't cause updates to other properties.\n\n## @withoutTracking(block: Function)\n\nWraps `block` in tracking prevention and calls it.\n\n## @registerSource(object)\n\nIf `object` is a `Batman.EventEmitter` or a `Batman.Property`, registers `object` in the current set in the global source tracker. Otherwise, it does nothing.\n\n## @pushSourceTracker()\n\nAdds a new set to the global source tracker.\n\n## @popSourceTracker()\n\nGets the last set from the global source tracker.\n\n## @pushDummySourceTracker()\n\nAdds a dummy set to the global source tracker. Used for preventing source tracking.\n\n## ::.cached[=false] : Boolean\n\nReturns `true` if the value was retrieved from the accessor and the cache hasn't been busted.\n\n## ::.value\n\nReturns the value last retrieved from the accessor.\n\n## ::.sources : Array\n\nReturns the dependencies of the `Property`, set automatically by `updateSourcesFromTracker`. Each source maybe a `Batman.EventEmitter` (which responds to `on`\/`off`), or a function (which is managed with `addHandler`\/`removeHandler`).\n\n## ::.isProperty[=true] : Boolean\n\nReturns `true`.\n\n## ::.isDead[=false] : Boolean\n\nReturns `false` unless `die` was called on the `Property`.\n\n## ::.isBatchingChanges[=false] : Boolean\n\nIf set to `true`, source changes won't cause the `Property` to `refresh` itself.\n\n## ::registerAsMutableSource()\n\nRegisters the property as a source with `Batman.Property.registerSource`.\n\n## ::isEqual(other: Property) : Boolean\n\nReturns `true` if `other`'s `constructor`, `base`, and `key` match the `Property`'s `constructor`, `base`, and `key`.\n\n## ::hashKey() : String\n\nReturns a string representation of the `Property`.\n\n## ::accessor() : Object\n\nReturns the accessor object for the `Property` by using `Batman.Property.accessorForBaseAndKey` for the `Property`'s `base` and `key`.\n\n## ::eachObserver(iterator: Function)\n\nCalls `iterator(handler)` for each handler on the `Property` and each of its `Observable` ancestors.\n\n## ::observers() : Array\n\nReturns handlers from the `Property` and each of its `Observable` ancestors.\n\n## ::hasObservers() : Boolean\n\nReturns `true` if it has any observers.\n\n## ::updateSourcesFromTracker()\n\nPops sources off the global tracker and replaces the `Property`'s current sources with the new ones, using `off`\/`on` or `removeHandler`\/`addHandler` as appropriate.\n\n## ::getValue()\n\nRegisters itself as a mutable source, and if isn't cached,retrieves the value form the accessor and keeps other properties updated. Returns the retrieved value.\n\n## ::isCachable() : Boolean\n\nReturns `true` if the `Property.isFinal()` or if the `Property`'s accessor doesn't specify `cache: false`.\n\n## ::isCached() : Boolean\n\nReturns `true` if `isCachable()` and `cached` are `true`.\n\n## ::isFinal() : Boolean\n\nReturns `true` if the accessor specifies `final: true`.\n\n## ::refresh()\n\nReloads the value from the accessor and, if the value has changed, fires itself with `value`, `previousValue`, `@key`. If the new value isn't undefined and `isFinal()` is true, it locks the value with `lockValue`.\n\n_Note:_ For a `Batman.Keypath`, these two are not equivalent:\n\n```\nsomeObject.property('nestedObject.someNestedProperty').refresh()        # refreshes the Keypath on someObject\nsomeObject.get('nestedObject').property('someNestedProperty').refresh() # refreshes the Property on nestedObject\n```\n\n## ::sourceChangeHandler() : Function\n\nReturns the function to be called when any of the `Property`'s sources change. By default, this function implements several of `Batman.Property`'s features:\n\n- the `Property` is refreshed when its sources change\n- If `@isBatchingChanges`, the `Property` isn't refreshed\n- If the `Property` `isIsolated`, it isn't refreshed\n- Dead properties aren't updated\n\n## ::valueFromAccessor()\n\nCalls the accessor's `get` function with `base` and `key`, returning the result.\n\n## ::setValue(value)\n\nIf the `Property`'s accessor has a `set` function, calls that function on `base` with `key` and `value`. This update is wrapped in source tracking, so other properties will be updated.\n\n## ::unsetValue()\n\nIf the `Property`'s accessor has a `unset` function, calls that function on `base` with `key`. This update is wrapped in source tracking, so other properties will be updated.\n\n## ::forget([handler: Function])\n\nIf `handler` is passed, removes `handler` from the `Property`'s handlers, otherwise removes all handlers from the `Property`.\n\n## ::observeAndFire(handler: Function)\n\nAdds `handler` to the `Property`'s handlers and fires it once. The handler will be called with `oldValue`, `newValue`, but for the first firing, `oldValue` and `newValue` are both the `Property`'s current value.\n\n## ::observe(handler: Function) : Property\n\nAdds `handler` to the `Property`'s handlers. The handler will be called with `oldValue`, `newValue`.\n\n## ::observeOnce(handler: Function) : Property\n\nAdds the `handler` to the `Property`'s handlers, but removes it after being fired once. The handler will be called with `oldValue`, `newValue`.\n\n## ::lockValue()\n\nPrevents changes to the `Property` by:\n- removing handlers on the `Property`\n- overriding `@getValue` to return the current value\n- overriding `@setValue`, `@unsetValue`, `@refresh`, and `@observe` to be no-ops.\n\n## ::die()\n\nKills the `Property` by removing handlers, unsetting itself, forgetting its `base` and setting `isDead = true`.\n\n## ::isolate()\n\nIsolates the `Property` from other properties. If the property is changed, it won't update its dependents until it's exposed. If its sources change, it won't refresh itself until it's exposed. `expose` must be called once for each time `isolate` is called, so if `isolate` is called twice, `expose` must be called twice.\n\n## ::expose()\n\nExposes the `Property` to its dependents. If its sources have changed since it was isolated, it refreshes itself. Then, if its own value changed since it was isolated, it updates its dependents.\n\n## ::isIsolated() : Boolean\n\nReturns `true` if the `Property` if `isolate` has been called more times than `expose`.\n","old_contents":"\n# \/api\/Data Structures\/Batman.Event\/Batman.Property\n\n`Batman.Property` extends `Batman.PropertyEvent` (which extends `Batman.Event`). `Batman.Property` is home to batman.js's powerful source tracking capabilities.\n\n## Source Tracking by Batman.Property\n\nWhen you define an `@accessor` on a `Batman.Object`, the accessor's `get` function is actually wrapped in source tracking by `Batman.Property`. Source tracking is implemented by a global source tracker stack, `SOURCE_TRACKER_STACK`, which is inside `Batman.Property`'s closure scope. The source tracker stack's members are arrays of source objects. For example:\n\n```coffeescript\n## SOURCE_TRACKER_STACK\n[\n  [<Batman.Property 1>, <Batman.Property 2>], # a set of sources\n  [<Batman.Property 3>, <Batman.Property 4>], # another set of sources\n  [ < ... > ]\n]\n```\n\nCalling `get` signals to batman.js that a new source set may be added (via a variable inside `Batman.Property`'s closure scope, `SOURCE_TRACKER_STACK_VALID`). At the onset of a subsequent `get`:\n\n- a new, empty source set is pushed to the global tracker if needed\n- the property pushes itself to the current set of sources\n- the `get` signals that a new source set may be added.\n\nAt the completion of each `get`:\n\n- the last item of the global source tracker is popped off and stored as the `Property`'s `@sources`.\n\nSo, the global source tracker stack grows until a `get` doesn't depend on any other `Batman.Property` objects, then it starts to shrink. As it shrinks, each set of sources is attached to the `Property` which put it on the stack.\n\n## ::constructor(base, key: String) : Property\n\nReturns a new `Property` on `base` named `key`.\n\n## ::.base\n\nReturns `base` specified in the constructor. Represents the object the `Property` belongs to.\n\n## ::.key\n\nReturns the `key` specified in the constructor. Represents the name of property.\n\n## @.defaultAccessor : Object\n\nA JavaScript object implementing the [`Batman.Object.accessor`](\/docs\/api\/batman.object_accessors.html) pattern by storing the value on the `Property` directly.\n\n## @defaultAccessorForBase(base) : Object\n\nReturns the `base`s `'defualtAccessor'` if present, otherwise returns `Batman.Property.defaultAccessor`.\n\n## @accessorForBaseAndKey(base, key: String) :\n\nChecks `base` and its ancestors for an accessor for `string` and returns it if found, otherwise returns `Batman.Property.defaultAccessor`.\n\n## @forBaseAndKey(base, key: String) : Property\n\nIf `base.isObservable`, delegates to the object's `property` function to return a `Property` for key, otherwise returns a new `Batman.Keypath` for `base` and `key`.\n\n## @wrapTrackingPrevention(block: Function) : Function\n\nCreates a new function by wrapping `block` in _tracking prevention_ and returns it. When changes are wrapped in tracking prevention, they won't cause updates to other properties.\n\n## @withoutTracking(block: Function)\n\nWraps `block` in tracking prevention and calls it.\n\n## @registerSource(object)\n\nIf `object` is a `Batman.EventEmitter` or a `Batman.Property`, registers `object` in the current set in the global source tracker. Otherwise, it does nothing.\n\n## @pushSourceTracker()\n\nAdds a new set to the global source tracker.\n\n## @popSourceTracker()\n\nGets the last set from the global source tracker.\n\n## @pushDummySourceTracker()\n\nAdds a dummy set to the global source tracker. Used for preventing source tracking.\n\n## ::.cached[=false] : Boolean\n\nReturns `true` if the value was retrieved from the accessor and the cache hasn't been busted.\n\n## ::.value\n\nReturns the value last retrieved from the accessor.\n\n## ::.sources : Array\n\nReturns the dependencies of the `Property`, set automatically by `updateSourcesFromTracker`. Each source maybe a `Batman.EventEmitter` (which responds to `on`\/`off`), or a function (which is managed with `addHandler`\/`removeHandler`).\n\n## ::.isProperty[=true] : Boolean\n\nReturns `true`.\n\n## ::.isDead[=false] : Boolean\n\nReturns `false` unless `die` was called on the `Property`.\n\n## ::.isBatchingChanges[=false] : Boolean\n\nIf set to `true`, source changes won't cause the `Property` to `refresh` itself.\n\n## ::registerAsMutableSource()\n\nRegisters the property as a source with `Batman.Property.registerSource`.\n\n## ::isEqual(other: Property) : Boolean\n\nReturns `true` if `other`'s `constructor`, `base`, and `key` match the `Property`'s `constructor`, `base`, and `key`.\n\n## ::hashKey() : String\n\nReturns a string representation of the `Property`.\n\n## ::accessor() : Object\n\nReturns the accessor object for the `Property` by using `Batman.Property.accessorForBaseAndKey` for the `Property`'s `base` and `key`.\n\n## ::eachObserver(iterator: Function)\n\nCalls `iterator(handler)` for each handler on the `Property` and each of its `Observable` ancestors.\n\n## ::observers() : Array\n\nReturns handlers from the `Property` and each of its `Observable` ancestors.\n\n## ::hasObservers() : Boolean\n\nReturns `true` if it has any observers.\n\n## ::updateSourcesFromTracker()\n\nPops sources off the global tracker and replaces the `Property`'s current sources with the new ones, using `off`\/`on` or `removeHandler`\/`addHandler` as appropriate.\n\n## ::getValue()\n\nRegisters itself as a mutable source, and if isn't cached,retrieves the value form the accessor and keeps other properties updated. Returns the retrieved value.\n\n## ::isCachable() : Boolean\n\nReturns `true` if the `Property.isFinal()` or if the `Property`'s accessor doesn't specify `cache: false`.\n\n## ::isCached() : Boolean\n\nReturns `true` if `isCachable()` and `cached` are `true`.\n\n## ::isFinal() : Boolean\n\nReturns `true` if the accessor specifies `final: true`.\n\n## ::refresh()\n\nReloads the value from the accessor and, if the value has changed, fires itself with `value`, `previousValue`, `@key`. If the new value isn't undefined and `isFinal()` is true, it locks the value with `lockValue`.\n\n## ::sourceChangeHandler() : Function\n\nReturns the function to be called when any of the `Property`'s sources change. By default, this function implements several of `Batman.Property`'s features:\n\n- the `Property` is refreshed when its sources change\n- If `@isBatchingChanges`, the `Property` isn't refreshed\n- If the `Property` `isIsolated`, it isn't refreshed\n- Dead properties aren't updated\n\n## ::valueFromAccessor()\n\nCalls the accessor's `get` function with `base` and `key`, returning the result.\n\n## ::setValue(value)\n\nIf the `Property`'s accessor has a `set` function, calls that function on `base` with `key` and `value`. This update is wrapped in source tracking, so other properties will be updated.\n\n## ::unsetValue()\n\nIf the `Property`'s accessor has a `unset` function, calls that function on `base` with `key`. This update is wrapped in source tracking, so other properties will be updated.\n\n## ::forget([handler: Function])\n\nIf `handler` is passed, removes `handler` from the `Property`'s handlers, otherwise removes all handlers from the `Property`.\n\n## ::observeAndFire(handler: Function)\n\nAdds `handler` to the `Property`'s handlers and fires it once. The handler will be called with `oldValue`, `newValue`, but for the first firing, `oldValue` and `newValue` are both the `Property`'s current value.\n\n## ::observe(handler: Function) : Property\n\nAdds `handler` to the `Property`'s handlers. The handler will be called with `oldValue`, `newValue`.\n\n## ::observeOnce(handler: Function) : Property\n\nAdds the `handler` to the `Property`'s handlers, but removes it after being fired once. The handler will be called with `oldValue`, `newValue`.\n\n## ::lockValue()\n\nPrevents changes to the `Property` by:\n- removing handlers on the `Property`\n- overriding `@getValue` to return the current value\n- overriding `@setValue`, `@unsetValue`, `@refresh`, and `@observe` to be no-ops.\n\n## ::die()\n\nKills the `Property` by removing handlers, unsetting itself, forgetting its `base` and setting `isDead = true`.\n\n## ::isolate()\n\nIsolates the `Property` from other properties. If the property is changed, it won't update its dependents until it's exposed. If its sources change, it won't refresh itself until it's exposed. `expose` must be called once for each time `isolate` is called, so if `isolate` is called twice, `expose` must be called twice.\n\n## ::expose()\n\nExposes the `Property` to its dependents. If its sources have changed since it was isolated, it refreshes itself. Then, if its own value changed since it was isolated, it updates its dependents.\n\n## ::isIsolated() : Boolean\n\nReturns `true` if the `Property` if `isolate` has been called more times than `expose`.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"38d10995591a3d166f8f38b8e6bed7bcb03424cf","subject":"Restructured navmesh module and improved documentation.","message":"Restructured navmesh module and improved documentation.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat","old_file":"src\/navmesh.litcoffee","new_file":"src\/navmesh.litcoffee","new_contents":"# navmesh\n\nNavmeshes are stored as \"MSN\" (MasSplat Navmesh) and are used to define where \nentities (including the player) can travel.  By default, they are unable to \nleave the surface, \"crawling\" over it.  Each tile is a 3D triangle.  A light \nAny two triangles sharing two vertices are joined and the edge formed may be \ncrossed from one to the other, otherwise, the edge is treated as a form of wall.\n\nMSN is a binary format.  It is comprised of:\n\n| Type    | Num.              | Description                                                |\n| ------- | ----------------- | ---------------------------------------------------------- |\n| uint16  | 1                 | The number of vertices defined.                            |\n| uint16  | 1                 | The number of triangles defined.                           |\n| float32 | 3x num. vertices  | The X, Y and Z of each vertex.                             |\n| uint16  | 3x num. triangles | The first, second and third vertex index of each triangle. |\n\n    file = require \".\/file.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n\n## load\n\n- filename: The \"real\" location of the MSN file to load.  (i.e. already \n            \"require\"-d)\n- callback: A callback to execute with the array of objects representing the\n            loaded objects on success, containing:\n            \n+ plane: A plane object for the surface of the triangle itself.\n+ edges: An array of three objects representing the edges of the triangle,\n       containing:\n  \n* neighbor: When null, there is no other triangle over this edge.  Otherwise\n            a reference to the triangle object which can be found over it.\n* plane: A plane facing inwards from the edge.  If this edge borders another\n         triangle, this will be aligned to both this triangle and the \n         neighbor.\n    \n    load = (path, callback) ->\n        file.arrayBuffer path, (response) ->\n            header = new Uint16Array response, 0, 2\n            vertexData = new Float32Array response, 4, header[0] * 3\n            indices = new Uint16Array response, 4 + header[0] * 4 * 3, header[1] * 3\n        \n            vertices = for i in [0...vertexData.length] by 3\n                [\n                    vertexData[i]\n                    vertexData[i + 1]\n                    vertexData[i + 2]\n                ]\n        \n            triangles = for i in [0...indices.length] by 3\n                plane: plane.fromTriangle vertices[indices[i]], vertices[indices[i + 1]], vertices[indices[i + 2]]\n                indices: [\n                    indices[i]\n                    indices[i + 1]\n                    indices[i + 2]\n                ]\n        \n            for triangle in triangles\n                triangle.edges = for edge in [0...3]\n                    vertexA = triangle.indices[edge]\n                    vertexB = triangle.indices[(edge + 1) % 3]\n                    vertexC = []\n                    vector.add.vector vertices[vertexA], triangle.plane.normal, vertexC\n                    neighbor = null\n                    for other in triangles\n                        if triangle is other then continue\n                        if vertexA not in other.indices then continue\n                        if vertexB not in other.indices then continue\n                        neighbor = other\n                        vector.add.vector vertexC, other.plane.normal, vertexC\n                        break\n                    neighbor: neighbor\n                    plane: plane.fromTriangle vertices[vertexA], vertexC, vertices[vertexB]\n\n            callback triangles\n            return\n        return\n            \n## constrain\n\nCall with an object containing:\n\n- location: An array of three numbers specifying the X, Y and Z moved to.\n- triangle: A reference to the triangle the entity is currently in.\n    \nThis will modify these properties to constrain the entity to the surface of the \nnavmesh.\n            \n    constrain = (obj) ->\n        \n        for iterations in [0...25]\n            distanceA = plane.distance obj.triangle.edges[0].plane, obj.location\n            distanceB = plane.distance obj.triangle.edges[1].plane, obj.location\n            distanceC = plane.distance obj.triangle.edges[2].plane, obj.location\n            if distanceA >= 0 and distanceB >= 0 and distanceC >= 0 \n                break\n\n            if distanceA < 0 and obj.triangle.edges[0].neighbor\n                obj.triangle = obj.triangle.edges[0].neighbor\n                continue\n                \n            if distanceB < 0 and obj.triangle.edges[1].neighbor\n                obj.triangle = obj.triangle.edges[1].neighbor\n                continue\n                \n            if distanceC < 0 and obj.triangle.edges[2].neighbor\n                obj.triangle = obj.triangle.edges[2].neighbor\n                continue\n            \n            if distanceA < 0 and distanceB < 0\n                vector.copy vertices[obj.triangle.indices[1]], obj.location\n                continue\n                \n            if distanceB < 0 and distanceC < 0\n                vector.copy vertices[obj.triangle.indices[2]], obj.location\n                continue\n                \n            if distanceC < 0 and distanceA < 0\n                vector.copy vertices[obj.triangle.indices[0]], obj.location\n                continue\n\n            if distanceA < 0\n                plane.project obj.triangle.edges[0].plane, obj.location, obj.location\n                continue\n                \n            if distanceB < 0\n                plane.project obj.triangle.edges[1].plane, obj.location, obj.location\n                continue\n                    \n            if distanceC < 0\n                plane.project obj.triangle.edges[2].plane, obj.location, obj.location\n                continue\n                \n        plane.project obj.triangle.plane, obj.location, obj.location\n        return        \n        \n    module.exports = { load, constrain }","old_contents":"# navmesh\n\nNavmeshes are stored as \"MSN\" (MasSplat Navmesh) and are used to define where \nentities (including the player) can travel.  By default, they are unable to \nleave the surface, \"crawling\" over it.  Each tile is a 3D triangle.  A light \nAny two triangles sharing two vertices are joined and the edge formed may be \ncrossed from one to the other, otherwise, the edge is treated as a form of wall.\n\nMSN is a binary format.  It is comprised of:\n\n| Type    | Num.              | Description                                                |\n| ------- | ----------------- | ---------------------------------------------------------- |\n| uint16  | 1                 | The number of vertices defined.                            |\n| uint16  | 1                 | The number of triangles defined.                           |\n| float32 | 3x num. vertices  | The X, Y and Z of each vertex.                             |\n| uint16  | 3x num. triangles | The first, second and third vertex index of each triangle. |\n\nOn calling with the path to a MSN file and a callback, reads the MSN file and\nexecutes the callback with an object as the argument.\n    \n    file = require \".\/file.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    \n    module.exports = (path, callback) ->\n        file.arrayBuffer path, (response) ->\n            header = new Uint16Array response, 0, 2\n            vertexData = new Float32Array response, 4, header[0] * 3\n            indices = new Uint16Array response, 4 + header[0] * 4 * 3, header[1] * 3\n        \n            vertices = for i in [0...vertexData.length] by 3\n                [\n                    vertexData[i]\n                    vertexData[i + 1]\n                    vertexData[i + 2]\n                ]\n        \n            triangles = for i in [0...indices.length] by 3\n                plane: plane.fromTriangle vertices[indices[i]], vertices[indices[i + 1]], vertices[indices[i + 2]]\n                indices: [\n                    indices[i]\n                    indices[i + 1]\n                    indices[i + 2]\n                ]\n        \n            for triangle in triangles\n                triangle.edges = for edge in [0...3]\n                    vertexA = triangle.indices[edge]\n                    vertexB = triangle.indices[(edge + 1) % 3]\n                    vertexC = []\n                    vector.add.vector vertices[vertexA], triangle.plane.normal, vertexC\n                    neighbor = null\n                    for other in triangles\n                        if triangle is other then continue\n                        if vertexA not in other.indices then continue\n                        if vertexB not in other.indices then continue\n                        neighbor = other\n                        vector.add.vector vertexC, other.plane.normal, vertexC\n                        break\n                    neighbor: neighbor\n                    plane: plane.fromTriangle vertices[vertexA], vertexC, vertices[vertexB]\n                   \n            callback\n            \nCall the \"constrain\" property with an object containing:\n\n- location: An array of three numbers specifying the X, Y and Z moved to.\n- triangle: A reference to the triangle the entity is currently in.  If not\n    known, falsy.\n    \nThis will modify these properties to constrain the entity to the surface of the \nnavmesh.\n            \n                constrain: (obj) ->\n                    if not obj.triangle\n                        obj.triangle = triangles[0]\n                    \n                    for iterations in [0...25]\n                        distanceA = plane.distance obj.triangle.edges[0].plane, obj.location\n                        distanceB = plane.distance obj.triangle.edges[1].plane, obj.location\n                        distanceC = plane.distance obj.triangle.edges[2].plane, obj.location\n                        if distanceA >= 0 and distanceB >= 0 and distanceC >= 0 \n                            break\n\n                        if distanceA < 0 and obj.triangle.edges[0].neighbor\n                            obj.triangle = obj.triangle.edges[0].neighbor\n                            continue\n                            \n                        if distanceB < 0 and obj.triangle.edges[1].neighbor\n                            obj.triangle = obj.triangle.edges[1].neighbor\n                            continue\n                            \n                        if distanceC < 0 and obj.triangle.edges[2].neighbor\n                            obj.triangle = obj.triangle.edges[2].neighbor\n                            continue\n                        \n                        if distanceA < 0 and distanceB < 0\n                            vector.copy vertices[obj.triangle.indices[1]], obj.location\n                            continue\n                            \n                        if distanceB < 0 and distanceC < 0\n                            vector.copy vertices[obj.triangle.indices[2]], obj.location\n                            continue\n                            \n                        if distanceC < 0 and distanceA < 0\n                            vector.copy vertices[obj.triangle.indices[0]], obj.location\n                            continue\n\n                        if distanceA < 0\n                            plane.project obj.triangle.edges[0].plane, obj.location, obj.location\n                            continue\n                            \n                        if distanceB < 0\n                            plane.project obj.triangle.edges[1].plane, obj.location, obj.location\n                            continue\n                                \n                        if distanceC < 0\n                            plane.project obj.triangle.edges[2].plane, obj.location, obj.location\n                            continue\n                            \n                    plane.project obj.triangle.plane, obj.location, obj.location\n                    return        \n            return\n        return","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d70d043ad08f2e9393d50ce94b986f7daadadde3","subject":"- removed unused feature from policy","message":"- removed unused feature from policy\n","repos":"WillemDeGroef\/nodesentry","old_file":"src\/policy.litcoffee","new_file":"src\/policy.litcoffee","new_contents":"Policy\n======\n\n    _ = require \"underscore\"\n\n    class Policy\n        constructor: () ->\n            @rules = []\n            @libsToWrap = []\n\n            @policy =\n\nIndicate if a given library (name) should be wrapped in a separate membrane. If\na policy doesn't talk about a specific depending library, then it there is no\nneed for it to be wrapped. Therefor, the default return value is `false`:\n\n                wrapWithMembrane: (libName) -> false\n\n        disable: (lib) -> this\n\n        on: (name) ->\n            child = new OnRule name, this\n            # check if (lib, call) = name must be added to libsToWrap\n            # iff lib[0].toLowerCase() == lib[0]\n            @rules.push child\n            child\n\n        before: (name) ->\n            child = new BeforeRule name, this\n            @rules.push child\n            child\n\n        after: (name) ->\n            child = new AfterRule name, this\n            @rules.push child\n            child\n\nThe `build` method generates the whole structure of our semantic model of the membrane object.\n\n        build: () =>\n            @libsToWrap = []\n\n            strEqual = (fullName) ->\n                (rule) -> fullName.indexOf(rule.apiCall) > -1\n\n            areType = (t) ->\n                (rule) -> rule instanceof t\n\n            conditionsAreTrue = (dTgt, ret) ->\n                (rule) ->\n                    _.chain(rule.conditions)\n                        .map (cond) -> cond(dTgt, ret) == true\n                        .reduce ((memo, c) -> memo and c), true\n                        .value()\n\n            doGetActions = (dTgt, args...) ->\n                (rule) ->\n                    _.chain(rule.actions)\n                        .map (action) -> action.apply(this, [dTgt].concat(args))\n                    return rule\n\n            calcRetValue = (origRet, rule) -> rule.ret(origRet)\n\n            isEmpty = (l) -> l.size().value() == 0\n            isNotFunction = (v) -> typeof v != \"function\"\n\n            @policy.onGet = (wTgt, name, wRec, dTgt, ret) =>\n                fullName = \"#{dTgt.constructor.name.toString()}.#{name}\"\n                relevantRules = _.chain(@rules)\n                    .filter(strEqual(fullName))\n\n                onRules = relevantRules.filter(areType(OnRule))\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n                onGetValue = onRules.filter(conditionsAreTrue(dTgt, ret))\n                    .map(doGetActions(dTgt, ret))\n                    .reduce(calcRetValue, ret)\n                    .value()\n\n            @policy.functionCall = (dTgt, dryThis, dryArgs, calcResult, fullName) =>\n                relevantRules = _.chain(@rules).filter(strEqual(fullName))\n\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n                calcResult = beforeRules.filter(conditionsAreTrue(dTgt))\n                       .map(doGetActions(dTgt, dryArgs, calcResult))\n                       .reduce(calcRetValue, calcResult)\n                       .value()\n\n                # return as function because the generic membrane will invoke it afterwards\n                ->\n                    ret = calcResult()\n                    afterRules.filter(conditionsAreTrue(dTgt, ret))\n                        .map(doGetActions(dTgt, dryArgs, ret))\n                        .reduce(calcRetValue, ret)\n                        .value()\n\n            @policy\n\n\n    class Rule\n        constructor: (@apiCall, @parent) ->\n\nList of actions with side effects [0..n]:\n\n            @actions = []\n\nThe default return function [1..1]:\n\n            @ret = (v) -> v\n\nA list of conditions that evaluate to `true` or `false` [1..n]:\n\n            @conditions = [ -> true]\n\n        do: (f) =>\n            @actions.push f\n            this\n\n        return: (f) =>\n            @ret = (v) -> f.call(this, v)\n            this\n\n        if: (cond) =>\n            @conditions.push (dtgt, ret) -> cond(dtgt, ret)\n            this\n\n        on: (name) => @parent.on name\n        before: (name) => @parent.before name\n        after: (name) => @parent.after name\n        build: () -> @parent.build()\n\n\n    class OnRule extends Rule\n    class AfterRule extends Rule\n    class BeforeRule extends Rule\n\n\n\n\n\n    module.exports = Policy\n","old_contents":"Policy\n======\n\n    _ = require \"underscore\"\n\n    class Policy\n        constructor: () ->\n            @rules = []\n            @libsToWrap = []\n\n            @policy =\n\nIndicate if a given library (name) should be wrapped in a separate membrane. If\na policy doesn't talk about a specific depending library, then it there is no\nneed for it to be wrapped. Therefor, the default return value is `false`:\n\n                wrapWithMembrane: (libName) -> false\n\n        disable: (lib) -> this\n        enableHSTS: -> this\n\n        on: (name) ->\n            child = new OnRule name, this\n            # check if (lib, call) = name must be added to libsToWrap\n            # iff lib[0].toLowerCase() == lib[0]\n            @rules.push child\n            child\n\n        before: (name) ->\n            child = new BeforeRule name, this\n            @rules.push child\n            child\n\n        after: (name) ->\n            child = new AfterRule name, this\n            @rules.push child\n            child\n\nThe `build` method generates the whole structure of our semantic model of the membrane object.\n\n        build: () =>\n            @libsToWrap = []\n\n            strEqual = (fullName) ->\n                (rule) -> fullName.indexOf(rule.apiCall) > -1\n\n            areType = (t) ->\n                (rule) -> rule instanceof t\n\n            conditionsAreTrue = (dTgt, ret) ->\n                (rule) ->\n                    _.chain(rule.conditions)\n                        .map (cond) -> cond(dTgt, ret) == true\n                        .reduce ((memo, c) -> memo and c), true\n                        .value()\n\n            doGetActions = (dTgt, args...) ->\n                (rule) ->\n                    _.chain(rule.actions)\n                        .map (action) -> action.apply(this, [dTgt].concat(args))\n                    return rule\n\n            calcRetValue = (origRet, rule) -> rule.ret(origRet)\n\n            isEmpty = (l) -> l.size().value() == 0\n            isNotFunction = (v) -> typeof v != \"function\"\n\n            @policy.onGet = (wTgt, name, wRec, dTgt, ret) =>\n                fullName = \"#{dTgt.constructor.name.toString()}.#{name}\"\n                relevantRules = _.chain(@rules)\n                    .filter(strEqual(fullName))\n\n                onRules = relevantRules.filter(areType(OnRule))\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n                onGetValue = onRules.filter(conditionsAreTrue(dTgt, ret))\n                    .map(doGetActions(dTgt, ret))\n                    .reduce(calcRetValue, ret)\n                    .value()\n\n            @policy.functionCall = (dTgt, dryThis, dryArgs, calcResult, fullName) =>\n                relevantRules = _.chain(@rules).filter(strEqual(fullName))\n\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n                calcResult = beforeRules.filter(conditionsAreTrue(dTgt))\n                       .map(doGetActions(dTgt, dryArgs, calcResult))\n                       .reduce(calcRetValue, calcResult)\n                       .value()\n\n                # return as function because the generic membrane will invoke it afterwards\n                ->\n                    ret = calcResult()\n                    afterRules.filter(conditionsAreTrue(dTgt, ret))\n                        .map(doGetActions(dTgt, dryArgs, ret))\n                        .reduce(calcRetValue, ret)\n                        .value()\n\n            @policy\n\n\n    class Rule\n        constructor: (@apiCall, @parent) ->\n\nList of actions with side effects [0..n]:\n\n            @actions = []\n\nThe default return function [1..1]:\n\n            @ret = (v) -> v\n\nA list of conditions that evaluate to `true` or `false` [1..n]:\n\n            @conditions = [ -> true]\n\n        do: (f) =>\n            @actions.push f\n            this\n\n        return: (f) =>\n            @ret = (v) -> f.call(this, v)\n            this\n\n        if: (cond) =>\n            @conditions.push (dtgt, ret) -> cond(dtgt, ret)\n            this\n\n        on: (name) => @parent.on name\n        before: (name) => @parent.before name\n        after: (name) => @parent.after name\n        build: () -> @parent.build()\n\n\n    class OnRule extends Rule\n    class AfterRule extends Rule\n    class BeforeRule extends Rule\n\n\n\n\n\n    module.exports = Policy\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6bc1bfe947cd2ca0399c644f8f02d86d7525c784","subject":"Reject invalid image types","message":"Reject invalid image types\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/server.litcoffee","new_file":"src\/server.litcoffee","new_contents":"    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      if not req.get('Origin') or not (req.get('Origin') in origins)\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError error\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","old_contents":"    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      if not req.get('Origin') or not (req.get('Origin') in origins)\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        # @TODO check if file is valid image\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError error\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4cd4cab890d5e11ecc31fa3454327734cfa5c0c1","subject":"Clean up the formatting for times a bit","message":"Clean up the formatting for times a bit\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/managers\/clock.litcoffee","new_file":"src\/coffee\/managers\/clock.litcoffee","new_contents":"Clock Manager\n=============\n\nThis manager controls the clock display on the *default* layout.\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nTime Formatting\n---------------\n\nTime must be consistently formatted in the output. We display the\ntime with a 24-hour clock.\n\nTime is formatted by calling the *formatTime* function, which takes\na JavaScript *Date* object as the argument.\n\nBefore defining *formatTime*, we first define *formatDoubleDigit*,\nwhich takes as its first argument an integer in the range 0 -- 99\ninclusive, and returns a two character wide string representing it,\nwith a given *padding* character for left-padding given in the\nsecond argument, which defaults to '0'.\n\n        formatDoubleDigit = (value, padding = '0') ->\n            if value < 10\n                \"#{padding}#{value}\"\n            else\n                \"#{value}\"\n\nWe now define *formatTime* utilising *formatDoubleDigit*.\n\n        formatTime = (date) ->\n            return formatDoubleDigit(date.getHours()) +\n                   ':' +\n                   formatDoubleDigit(date.getMinutes()) +\n                   ':' +\n                   formatDoubleDigit(date.getSeconds())\n\nClock Pulse Updates\n-------------------\n\nWe bind to the *Clock* property, which gives the date.\n\n        Clock.map(formatTime)\n             .assign $('#clock'), 'text'\n\n","old_contents":"Clock Manager\n=============\n\nThis manager controls the clock display on the *default* layout.\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nTime Formatting\n---------------\n\nTime must be consistently formatted in the output. We display the\ntime with a 24-hour clock.\n\nTime is formatted by calling the *formatTime* function, which takes\na JavaScript *Date* object as the argument.\n\nBefore defining *formatTime*, we first define *formatDoubleDigit*,\nwhich takes as its first argument an integer in the range 0 -- 99\ninclusive, and returns a two character wide string representing it,\nwith a given *padding* character for left-padding given in the\nsecond argument, which defaults to '0'.\n\nWe cast to a string in either case by exploiting JavaScript's weak\ntyping - concatenating a string and an integer yields an string.\n\n        formatDoubleDigit = (value, padding = '0') ->\n            return padding + value if value < 10\n            '' + value\n\nWe now define *formatTime* utilising *formatDoubleDigit*.\n\n        formatTime = (date) ->\n            return formatDoubleDigit(date.getHours()) +\n                   ':' +\n                   formatDoubleDigit(date.getMinutes()) +\n                   ':' +\n                   formatDoubleDigit(date.getSeconds())\n\nClock Pulse Updates\n-------------------\n\nWe bind to the *Clock* property, which gives the date.\n\n        Clock.map(formatTime)\n             .assign $('#clock'), 'text'\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"61c82b1a43efa7e1a99b6f5fd1088c3810506df4","subject":"Fix 1-char username\/password bug","message":"Fix 1-char username\/password bug\n","repos":"hzdg\/urllite.js","old_file":"src\/core.litcoffee","new_file":"src\/core.litcoffee","new_contents":"\n    URL_PATTERN = \/\/\/\n      ^\n      (?:\n        (?:\n          (                                       # protocol* (\"http:\")\n             [^:\/?\\#]+                            # scheme (\"http\")\n             :\n          )\/+\n          |\n          (\/\/)                                    # [Scheme-relative]\n        )\n        # (                                       # authority\n          (?:\n            # (                                   # userinfo\n              ([a-z0-9-\\._~%]+)                   # username*\n              (?:\n                :\n                ([a-z0-9-\\._~%]+)                 # password*\n              )?\n            # )\n            @\n          )?\n          (                                       # host*\n            ([a-z0-9-\\._~%!$&'()*+,;=]+)          # hostname*\n            (?:\n              :\n              ([0-9]+)                            # port*\n            )?\n          )?\n        # )\n      )?\n      ([^?\\#]*?)                                  # pathname*\n      (\\?                                         # search*\n        [^\\#]*                                    # query\n      )?\n      (\\#                                         # hash*\n        .*                                        # fragment\n      )?\n      $\n    \/\/\/\n\n    urllite = (raw) -> new urllite.URL raw\n\n    urllite.URL =\n      class URL\n        constructor: (raw) ->\n          m = raw.toString().match URL_PATTERN\n          @protocol = m[1] or ''\n          isProtocolRelative = m[2]?\n          @username = m[3] or ''\n          @password = m[4] or ''\n          @host = m[5] or ''\n          @hostname = m[6] or ''\n          @port = m[7] or ''\n          pathname = m[8] or ''\n          @pathname = if @protocol and pathname.charAt(0) isnt '\/' then \"\/#{ pathname }\" else pathname\n          @search = m[9] or ''\n          @hash = m[10] or ''\n          @origin = \"#{ @protocol }\/\/#{ @host }\"\n\n    module.exports = urllite\n","old_contents":"\n    URL_PATTERN = \/\/\/\n      ^\n      (?:\n        (?:\n          (                                       # protocol* (\"http:\")\n             [^:\/?\\#]+                            # scheme (\"http\")\n             :\n          )\/+\n          |\n          (\/\/)                                    # [Scheme-relative]\n        )\n        # (                                       # authority\n          (?:\n            # (                                   # userinfo\n              ([a-z0-9-\\._~%])                    # username*\n              (?:\n                :\n                ([a-z0-9-\\._~%])                  # password*\n              )?\n            # )\n            @\n          )?\n          (                                       # host*\n            ([a-z0-9-\\._~%!$&'()*+,;=]+)          # hostname*\n            (?:\n              :\n              ([0-9]+)                            # port*\n            )?\n          )?\n        # )\n      )?\n      ([^?\\#]*?)                                  # pathname*\n      (\\?                                         # search*\n        [^\\#]*                                    # query\n      )?\n      (\\#                                         # hash*\n        .*                                        # fragment\n      )?\n      $\n    \/\/\/\n\n    urllite = (raw) -> new urllite.URL raw\n\n    urllite.URL =\n      class URL\n        constructor: (raw) ->\n          m = raw.toString().match URL_PATTERN\n          @protocol = m[1] or ''\n          isProtocolRelative = m[2]?\n          @username = m[3] or ''\n          @password = m[4] or ''\n          @host = m[5] or ''\n          @hostname = m[6] or ''\n          @port = m[7] or ''\n          pathname = m[8] or ''\n          @pathname = if @protocol and pathname.charAt(0) isnt '\/' then \"\/#{ pathname }\" else pathname\n          @search = m[9] or ''\n          @hash = m[10] or ''\n          @origin = \"#{ @protocol }\/\/#{ @host }\"\n\n    module.exports = urllite\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d423213ed72109fd5c105b24ce7c4c571b1a3911","subject":"Fixed restoring attributes with aliases in Class","message":"Fixed restoring attributes with aliases in Class\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"packages\/neft-core\/src\/renderer\/types\/extensions\/class.litcoffee","new_file":"packages\/neft-core\/src\/renderer\/types\/extensions\/class.litcoffee","new_contents":"# Class\n\n    'use strict'\n\n    assert = require '..\/..\/..\/assert'\n    utils = require '..\/..\/..\/util'\n    {SignalsEmitter} = require '..\/..\/..\/signal'\n    log = require '..\/..\/..\/log'\n    TagQuery = require '..\/..\/..\/document\/element\/element\/tag\/query'\n\n    log = log.scope 'Rendering', 'Class'\n\n    module.exports = (Renderer, Impl, itemUtils) ->\n        class ChangesObject\n            constructor: ->\n                @_attributes = Object.create null\n                @_bindings = Object.create null\n\n            setAttribute: (prop, val) ->\n                @_attributes[prop] = val\n                return\n\n            setBinding: (prop, val) ->\n                @_attributes[prop] = val\n                @_bindings[prop] = true\n                return\n\n        class Class extends Renderer.Extension\n            @__name__ = 'Class'\n\n## *Renderer.Class* Class.New([*Object* options])\n\n            @New = (opts) ->\n                item = new Class\n                itemUtils.Object.initialize item, opts\n                item\n\n## *Class* Class::constructor() : *Renderer.Extension*\n\n            lastUid = 0\n            constructor: ->\n                super()\n                @_classUid = String(lastUid++)\n                @_priority = 0\n                @_inheritsPriority = 0\n                @_nestingPriority = 0\n                @_changes = null\n                @_document = null\n                @_children = null\n\n## *Item* Class::target\n\nReference to the *Item* on which this class has effects.\n\nIf state is created inside the *Item*, this property is set automatically.\n\n## *Signal* Class::onTargetChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'target'\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, itemUtils.Object\n                setter: (_super) -> (val) ->\n                    oldVal = @_target\n\n                    if oldVal is val\n                        return\n\n                    isRunning = @_running\n\n                    if isRunning\n                        @running = false\n\n                    if oldVal\n                        utils.remove oldVal._extensions, @\n                        if @_running and not @_document?._query\n                            unloadObjects @, oldVal\n\n                    _super.call @, val\n\n                    if val\n                        val._extensions.push @\n                        if @_priority isnt -1 and !@_bindings?.running and !@_document?._query\n                            @running = true\n\n                    if isRunning\n                        @running = true\n                    return\n\n## *Object* Class::changes\n\nThis objects contains all properties to change on the target item.\n\n            CHANGES_OMIT_ATTRIBUTES =\n                __proto__: null\n                id: true\n                properties: true\n                signals: true\n                children: true\n\n            utils.defineProperty @::, 'changes', null, ->\n                @_changes ||= new ChangesObject\n            , (obj = {}) ->\n                assert.isObject obj\n\n                isRunning = @_running and !!@_target\n\n                if isRunning\n                    updateTargetClass disableClass, @_target, @\n\n                @_changes = new ChangesObject\n                changes = @_changes\n\n                for prop, val of obj\n                    if Array.isArray(val) and val.length is 2 and typeof val[0] is 'function' and Array.isArray(val[1])\n                        changes.setBinding prop, val\n                    else if not CHANGES_OMIT_ATTRIBUTES[prop]\n                        changes.setAttribute prop, val\n\n                if isRunning\n                    updateTargetClass enableClass, @_target, @\n\n                return\n\n## *Integer* Class::priority = `0`\n\n## *Signal* Class::onPriorityChange(*Integer* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'priority'\n                defaultValue: 0\n                developmentSetter: (val) ->\n                    assert.isInteger val\n                setter: (_super) -> (val) ->\n                    _super.call @, val\n                    updatePriorities @\n                    return\n\n## *Boolean* Class::running\n\nIndicates whether the class is active or not.\n\nMostly used with bindings.\n\n```javascript\nGrid {\n    columns: 2\n    \/\/ reduce to one column if the view width is lower than 500 pixels\n    Class {\n        running: windowItem.width < 500\n        changes: {\n            columns: 1\n        }\n    }\n}\n```\n\n## *Signal* Class::onRunningChange(*Boolean* oldValue)\n\n            _enable: ->\n                assert.ok @_running\n\n                docQuery = @_document?._query\n                if not @_target or docQuery\n                    if docQuery\n                        for classElem in @_document._classesInUse\n                            classElem.running = true\n                    return\n\n                updateTargetClass saveAndEnableClass, @_target, @\n\n                unless @_document?._query\n                    loadObjects @, @_target\n\n                return\n\n            _disable: ->\n                assert.notOk @_running\n\n                if not @_target\n                    if @_document and @_document._query\n                        for classElem in @_document._classesInUse\n                            classElem.running = false\n                    return\n\n                unless @_document?._query\n                    unloadObjects @, @_target\n\n                updateTargetClass saveAndDisableClass, @_target, @\n                return\n\n## *Object* Class::children\n\n            utils.defineProperty @::, 'children', null, ->\n                @_children ||= new ChildrenObject(@)\n            , (val) ->\n                {children} = @\n\n                # clear\n                length = children.length\n                while length--\n                    children.pop length\n\n                if val\n                    assert.isArray val\n\n                    for child in val\n                        children.append child\n\n                return\n\n            class ChildrenObject\n\n## *Integer* Class::children.length = `0`\n\n                constructor: (ref) ->\n                    @_ref = ref\n                    @length = 0\n\n## *Object* Class::children.append(*Object* value)\n\n                append: (val) ->\n                    assert.instanceOf val, itemUtils.Object\n                    assert.isNot val, @_ref\n\n                    if val instanceof Class\n                        updateChildPriorities @_ref, val\n\n                    @[@length++] = val\n\n                    val\n\n## *Object* Class::children.pop(*Integer* index)\n\n                pop: (i = @length - 1) ->\n                    assert.operator i, '>=', 0\n                    assert.operator i, '<', @length\n\n                    oldVal = @[i]\n                    delete @[i]\n                    --@length\n\n                    oldVal\n\n            clone: ->\n                clone = cloneClassWithNoDocument.call @\n\n                if doc = @_document\n                    cloneDoc = clone.document\n                    cloneDoc.query = doc.query\n                    for name, arr of doc._signals\n                        cloneDoc._signals[name] = utils.clone arr\n\n                clone\n\n        loadObjects = (classElem, item) ->\n            if children = classElem._children\n                for child in children\n                    if child instanceof Renderer.Item\n                        child.parent ?= item\n                    else\n                        if child instanceof Class\n                            updateChildPriorities classElem, child\n                        child.target ?= item\n            return\n\n        unloadObjects = (classElem, item) ->\n            if children = classElem._children\n                for child in children\n                    if child instanceof Renderer.Item\n                        if child.parent is item\n                            child.parent = null\n                    else\n                        if child.target is item\n                            child.target = null\n            return\n\n        updateChildPriorities = (parent, child) ->\n            child._inheritsPriority = parent._inheritsPriority + parent._priority\n            child._nestingPriority = parent._nestingPriority + 1 + (child._document?._priority or 0)\n            updatePriorities child\n            return\n\n        updatePriorities = (classElem) ->\n            # refresh if needed\n            if classElem._running and ifClassListWillChange(classElem)\n                target = classElem._target\n                updateTargetClass disableClass, target, classElem\n                updateClassList target\n                updateTargetClass enableClass, target, classElem\n\n            # children\n            if children = classElem._children\n                for child in children\n                    if child instanceof Class\n                        updateChildPriorities classElem, child\n\n            # document\n            if document = classElem._document\n                {_inheritsPriority, _nestingPriority} = classElem\n                for child in document._classesInUse\n                    child._inheritsPriority = _inheritsPriority\n                    child._nestingPriority = _nestingPriority\n                    updatePriorities child\n                for child in document._classesPool\n                    child._inheritsPriority = _inheritsPriority\n                    child._nestingPriority = _nestingPriority\n            return\n\n        ifClassListWillChange = (classElem) ->\n            unless target = classElem._target\n                return false\n            classList = target._classList\n            index = classList.indexOf classElem\n\n            if index > 0 and classListSortFunc(classElem, classList[index - 1]) < 0\n                return true\n            if index < classList.length - 1 and classListSortFunc(classElem, classList[index + 1]) > 0\n                return true\n            false\n\n        classListSortFunc = (a, b) ->\n            (b._priority + b._inheritsPriority) - (a._priority + a._inheritsPriority) or\n            (b._nestingPriority) - (a._nestingPriority)\n\n        updateClassList = (item) ->\n            item._classList.sort classListSortFunc\n\n        cloneClassChild = (classElem, child) ->\n            child.clone()\n\n        cloneClassWithNoDocument = ->\n            clone = Class.New()\n            clone.id = @id\n            clone._classUid = @_classUid\n            clone._priority = @_priority\n            clone._inheritsPriority = @_inheritsPriority\n            clone._nestingPriority = @_nestingPriority\n            clone._changes = @_changes\n\n            if @_bindings\n                for prop, val of @_bindings\n                    clone.createBinding prop, val\n\n            # clone children\n            if children = @_children\n                for child, i in children\n                    childClone = cloneClassChild clone, child\n                    clone.children.append childClone\n\n            clone\n\n        {splitAttribute, getObjectByPath} = itemUtils\n\n        setAttribute = (item, attr, val) ->\n            path = splitAttribute attr\n            if object = getObjectByPath(item, path)\n                object[path[path.length - 1]] = val\n            return\n\n        saveAndEnableClass = (item, classElem) ->\n            assert.notOk utils.has(item._classList, classElem)\n            item._classList.unshift classElem\n            if ifClassListWillChange(classElem)\n                updateClassList item\n            enableClass item, classElem\n\n        saveAndDisableClass = (item, classElem) ->\n            assert.ok utils.has(item._classList, classElem)\n            disableClass item, classElem\n            utils.remove item._classList, classElem\n\n        ATTRS_ALIAS_DEF = [\n            ['x', 'anchors.left', 'anchors.right', 'anchors.horizontalCenter', 'anchors.centerIn', 'anchors.fill', 'anchors.fillWidth'],\n            ['y', 'anchors.top', 'anchors.bottom', 'anchors.verticalCenter', 'anchors.centerIn', 'anchors.fill', 'anchors.fillHeight'],\n            ['width', 'anchors.fill', 'anchors.fillWidth', 'fillWidth'],\n            ['height', 'anchors.fill', 'anchors.fillHeight', 'fillHeight'],\n        ]\n\n        ATTRS_ALIAS = Object.create null\n        ATTRS_ALIAS['margin'] = ['margin.left', 'margin.right', 'margin.top', 'margin.bottom']\n        ATTRS_ALIAS['padding'] = ['padding.left', 'padding.right', 'padding.top', 'padding.bottom']\n        ATTRS_ALIAS['alignment'] = ['alignment.horizontal', 'alignment.vertical']\n\n        do ->\n            for aliases in ATTRS_ALIAS_DEF\n                for prop in aliases\n                    arr = ATTRS_ALIAS[prop] ?= []\n                    for alias in aliases\n                        if alias isnt prop\n                            arr.push alias\n            return\n\n        getContainedAttribute = (classElem, attr) ->\n            if changes = classElem._changes\n                attrs = changes._attributes\n                if attrs[attr] isnt undefined\n                    return attr\n            return ''\n\n        getContainedAttributeOrAlias = (classElem, attr) ->\n            if changes = classElem._changes\n                attrs = changes._attributes\n                if attrs[attr] isnt undefined\n                    return attr\n                else if aliases = ATTRS_ALIAS[attr]\n                    for alias in aliases\n                        if attrs[alias] isnt undefined\n                            return alias\n            return ''\n\n        getPropertyDefaultValue = (obj, prop) ->\n            proto = Object.getPrototypeOf obj\n            innerProp = itemUtils.getInnerPropName(prop)\n            if innerProp of proto\n                proto[innerProp]\n            else\n                proto[prop]\n\n        enableClass = (item, classElem) ->\n            assert.instanceOf item, itemUtils.Object\n            assert.instanceOf classElem, Class\n\n            classList = item._classList\n            classListIndex = classList.indexOf classElem\n            classListLength = classList.length\n            if classListIndex is -1\n                return\n\n            unless changes = classElem._changes\n                return\n\n            attributes = changes._attributes\n            bindings = changes._bindings\n\n            # attributes\n            for attr, val of attributes\n                path = null\n                writeAttr = true\n                alias = ''\n                for i in [classListIndex - 1..0] by -1\n                    if getContainedAttributeOrAlias(classList[i], attr)\n                        writeAttr = false\n                        break\n\n                if writeAttr\n                    # unset alias\n                    for i in [classListIndex + 1...classListLength] by 1\n                        if (alias = getContainedAttributeOrAlias(classList[i], attr)) and alias isnt attr\n                            path = splitAttribute alias\n                            object = getObjectByPath item, path\n                            lastPath = path[path.length - 1]\n                            unless object\n                                continue\n                            defaultValue = getPropertyDefaultValue object, lastPath\n                            defaultIsBinding = !!classList[i].changes._bindings[alias]\n                            if defaultIsBinding\n                                object.createBinding lastPath, null, item\n                            object[lastPath] = defaultValue\n                            break\n\n                    # set new attribute\n                    if attr isnt alias or not path\n                        path = splitAttribute attr\n                        lastPath = path[path.length - 1]\n                        object = getObjectByPath item, path\n\n                    `\/\/<development>`\n                    if not object or not (lastPath of object)\n                        log.error \"\"\"\n                            Attribute '#{attr}' doesn't exist in '#{item}'\n                        \"\"\"\n                        continue\n                    `\/\/<\/development>`\n                    unless object\n                        continue\n\n                    if bindings[attr]\n                        object.createBinding lastPath, val, item\n                    else if typeof val is 'function' and object[lastPath]?.connect\n                        object[lastPath].connect val, item\n                    else\n                        if object._bindings?[lastPath]\n                            object.createBinding lastPath, null, item\n                        object[lastPath] = val\n\n            return\n\n        disableClass = (item, classElem) ->\n            assert.instanceOf item, itemUtils.Object\n            assert.instanceOf classElem, Class\n\n            classList = item._classList\n            classListIndex = classList.indexOf classElem\n            classListLength = classList.length\n            if classListIndex is -1\n                return\n\n            unless changes = classElem._changes\n                return\n\n            attributes = changes._attributes\n            bindings = changes._bindings\n\n            # attributes\n            for attr, val of attributes\n                restoreDefault = true\n\n                # don't restore if this attribute is already set by more important class\n                for i in [classListIndex - 1..0] by -1\n                    if getContainedAttributeOrAlias(classList[i], attr)\n                        restoreDefault = false\n                        break\n\n                if restoreDefault\n                    # we firstly restore the attribute itself or its alias\n                    getAttributeMethod = getContainedAttributeOrAlias\n                    while getAttributeMethod\n                        path = null\n                        alias = ''\n\n                        # get default value\n                        defaultValue = undefined\n                        defaultIsBinding = false\n                        for i in [classListIndex + 1...classListLength] by 1\n                            if alias = getAttributeMethod(classList[i], attr)\n                                defaultValue = classList[i].changes._attributes[alias]\n                                defaultIsBinding = !!classList[i].changes._bindings[alias]\n                                break\n                        alias ||= attr\n\n                        if alias is attr\n                            # no more aliases to restore\n                            getAttributeMethod = null\n                        else\n                            # we need to restore the original attribute in the next iteration\n                            getAttributeMethod = getContainedAttribute\n\n                        # restore binding\n                        if !!bindings[attr]\n                            path = splitAttribute attr\n                            object = getObjectByPath item, path\n                            lastPath = path[path.length - 1]\n                            unless object\n                                continue\n                            object.createBinding lastPath, null, item\n\n                        # set default value\n                        if attr isnt alias or not path\n                            path = splitAttribute alias\n                            object = getObjectByPath item, path\n                            lastPath = path[path.length - 1]\n                            unless object\n                                continue\n\n                        if defaultIsBinding\n                            object.createBinding lastPath, defaultValue, item\n                        else if typeof val is 'function' and object[lastPath]?.connect\n                            object[lastPath].disconnect val, item\n                        else\n                            if defaultValue is undefined\n                                defaultValue = getPropertyDefaultValue object, lastPath\n                            object[lastPath] = defaultValue\n\n            return\n\n        runQueue = (target) ->\n            classQueue = target._classQueue\n            [func, target, classElem] = classQueue\n            func target, classElem\n            classQueue.shift()\n            classQueue.shift()\n            classQueue.shift()\n            if classQueue.length > 0\n                runQueue target\n            return\n\n        updateTargetClass = (func, target, classElem) ->\n            classQueue = target._classQueue\n            classQueue.push func, target, classElem\n            if classQueue.length is 3\n                runQueue target\n            return\n\n        class ElementTarget extends itemUtils.Object\n            constructor: (element) ->\n                super()\n                @_element = element\n                Object.seal @\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'element'\n                defaultValue: null\n\n        Class.ElementTarget = ElementTarget\n\n## *Object* Class::document\n\n        class ClassChildDocument\n            constructor: (parent) ->\n                @_ref = parent._ref\n                @_parent = parent\n                @_multiplicity = 0\n                Object.preventExtensions @\n\n        class ClassDocument extends itemUtils.DeepObject\n            @__name__ = 'ClassDocument'\n\n## *Signal* Class::onDocumentChange(*Object* document)\n\n            itemUtils.defineProperty\n                constructor: Class\n                name: 'document'\n                valueConstructor: @\n\n            onTargetChange = (oldVal) ->\n                if oldVal\n                    oldVal.onElementChange.disconnect @reloadQuery, @\n                if val = @_ref._target\n                    val.onElementChange.connect @reloadQuery, @\n                if oldVal isnt val\n                    @reloadQuery()\n                return\n\n            constructor: (ref) ->\n                @_query = ''\n                @_classesInUse = []\n                @_classesPool = []\n                @_nodeWatcher = null\n                @_priority = 0\n                super ref\n\n                ref.onTargetChange.connect onTargetChange, @\n                onTargetChange.call @, ref._target\n\n## *Signal* Class::document.onNodeAdd(*Element* node)\n\n            SignalsEmitter.createSignal @, 'onNodeAdd'\n\n## *Signal* Class::document.onNodeRemove(*Element* node)\n\n            SignalsEmitter.createSignal @, 'onNodeRemove'\n\n## *String* Class::document.query\n\n## *Signal* Class::document.onQueryChange(*String* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'query'\n                defaultValue: ''\n                namespace: 'document'\n                parentConstructor: ClassDocument\n                developmentSetter: (val) ->\n                    assert.isString val\n                setter: (_super) -> (val) ->\n                    assert.notOk @_parent\n\n                    if @_query is val\n                        return\n\n                    unless @_query\n                        unloadObjects @, @_target\n\n                    _super.call @, val\n                    @reloadQuery()\n\n                    # update priority\n                    if @_ref._priority < 1\n                        # TODO\n                        # while calculating selector priority we take only the first query\n                        # as a priority for the whole selector;\n                        # to fix this we can split selector with multiple queries ('a, b')\n                        # into separated class instances\n                        cmdLen = TagQuery.getSelectorPriority val, 0, 1\n                        oldPriority = @_priority\n                        @_priority = cmdLen\n                        @_ref._nestingPriority += cmdLen - oldPriority\n                        updatePriorities @_ref\n\n                    unless val\n                        loadObjects @, @_target\n                    return\n\n            getChildClass = (style, parentClass) ->\n                for classElem in style._extensions\n                    if classElem instanceof Class\n                        if classElem._document?._parent is parentClass\n                            return classElem\n                return\n\n            connectNodeStyle = (style) ->\n                # omit duplications\n                uid = @_ref._classUid\n                for classElem in style._extensions\n                    if classElem instanceof Class\n                        if classElem isnt @_ref and classElem._classUid is uid and classElem._document instanceof ClassChildDocument\n                            classElem._document._multiplicity++\n                            return\n\n                # get class\n                unless classElem = @_classesPool.pop()\n                    classElem = cloneClassWithNoDocument.call @_ref\n                    classElem._document = new ClassChildDocument @\n\n                # save\n                @_classesInUse.push classElem\n                classElem.target = style\n\n                # run if needed\n                if not classElem._bindings?.running\n                    classElem.running = true\n                return\n\n            disconnectNodeStyle = (style) ->\n                unless classElem = getChildClass(style, @)\n                    return\n                if classElem._document._multiplicity > 0\n                    classElem._document._multiplicity--\n                    return\n                classElem.target = null\n                utils.remove @_classesInUse, classElem\n                @_classesPool.push classElem\n                return\n\n            onNodeStyleChange = (oldVal, val) ->\n                if oldVal\n                    disconnectNodeStyle.call @, oldVal\n                if val\n                    connectNodeStyle.call @, val\n                return\n\n            onNodeAdd = (node) ->\n                node.onStyleChange.connect onNodeStyleChange, @\n                if style = node._style\n                    connectNodeStyle.call @, style\n                @emit 'onNodeAdd', node\n                return\n\n            onNodeRemove = (node) ->\n                node.onStyleChange.disconnect onNodeStyleChange, @\n                if style = node._style\n                    disconnectNodeStyle.call @, style\n                @emit 'onNodeRemove', node\n                return\n\n            reloadQuery: ->\n                # remove old\n                @_nodeWatcher?.disconnect()\n                @_nodeWatcher = null\n                while classElem = @_classesInUse.pop()\n                    classElem.target = null\n                    @_classesPool.push classElem\n\n                # add new ones\n                if (query = @_query) and (target = @_ref.target) and (node = target.element) and node.watch\n                    watcher = @_nodeWatcher = node.watch query\n                    watcher.onAdd.connect onNodeAdd, @\n                    watcher.onRemove.connect onNodeRemove, @\n                return\n\n        Class\n","old_contents":"# Class\n\n    'use strict'\n\n    assert = require '..\/..\/..\/assert'\n    utils = require '..\/..\/..\/util'\n    {SignalsEmitter} = require '..\/..\/..\/signal'\n    log = require '..\/..\/..\/log'\n    TagQuery = require '..\/..\/..\/document\/element\/element\/tag\/query'\n\n    log = log.scope 'Rendering', 'Class'\n\n    module.exports = (Renderer, Impl, itemUtils) ->\n        class ChangesObject\n            constructor: ->\n                @_attributes = Object.create null\n                @_bindings = Object.create null\n\n            setAttribute: (prop, val) ->\n                @_attributes[prop] = val\n                return\n\n            setBinding: (prop, val) ->\n                @_attributes[prop] = val\n                @_bindings[prop] = true\n                return\n\n        class Class extends Renderer.Extension\n            @__name__ = 'Class'\n\n## *Renderer.Class* Class.New([*Object* options])\n\n            @New = (opts) ->\n                item = new Class\n                itemUtils.Object.initialize item, opts\n                item\n\n## *Class* Class::constructor() : *Renderer.Extension*\n\n            lastUid = 0\n            constructor: ->\n                super()\n                @_classUid = String(lastUid++)\n                @_priority = 0\n                @_inheritsPriority = 0\n                @_nestingPriority = 0\n                @_changes = null\n                @_document = null\n                @_children = null\n\n## *Item* Class::target\n\nReference to the *Item* on which this class has effects.\n\nIf state is created inside the *Item*, this property is set automatically.\n\n## *Signal* Class::onTargetChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'target'\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, itemUtils.Object\n                setter: (_super) -> (val) ->\n                    oldVal = @_target\n\n                    if oldVal is val\n                        return\n\n                    isRunning = @_running\n\n                    if isRunning\n                        @running = false\n\n                    if oldVal\n                        utils.remove oldVal._extensions, @\n                        if @_running and not @_document?._query\n                            unloadObjects @, oldVal\n\n                    _super.call @, val\n\n                    if val\n                        val._extensions.push @\n                        if @_priority isnt -1 and !@_bindings?.running and !@_document?._query\n                            @running = true\n\n                    if isRunning\n                        @running = true\n                    return\n\n## *Object* Class::changes\n\nThis objects contains all properties to change on the target item.\n\n            CHANGES_OMIT_ATTRIBUTES =\n                __proto__: null\n                id: true\n                properties: true\n                signals: true\n                children: true\n\n            utils.defineProperty @::, 'changes', null, ->\n                @_changes ||= new ChangesObject\n            , (obj = {}) ->\n                assert.isObject obj\n\n                isRunning = @_running and !!@_target\n\n                if isRunning\n                    updateTargetClass disableClass, @_target, @\n\n                @_changes = new ChangesObject\n                changes = @_changes\n\n                for prop, val of obj\n                    if Array.isArray(val) and val.length is 2 and typeof val[0] is 'function' and Array.isArray(val[1])\n                        changes.setBinding prop, val\n                    else if not CHANGES_OMIT_ATTRIBUTES[prop]\n                        changes.setAttribute prop, val\n\n                if isRunning\n                    updateTargetClass enableClass, @_target, @\n\n                return\n\n## *Integer* Class::priority = `0`\n\n## *Signal* Class::onPriorityChange(*Integer* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'priority'\n                defaultValue: 0\n                developmentSetter: (val) ->\n                    assert.isInteger val\n                setter: (_super) -> (val) ->\n                    _super.call @, val\n                    updatePriorities @\n                    return\n\n## *Boolean* Class::running\n\nIndicates whether the class is active or not.\n\nMostly used with bindings.\n\n```javascript\nGrid {\n    columns: 2\n    \/\/ reduce to one column if the view width is lower than 500 pixels\n    Class {\n        running: windowItem.width < 500\n        changes: {\n            columns: 1\n        }\n    }\n}\n```\n\n## *Signal* Class::onRunningChange(*Boolean* oldValue)\n\n            _enable: ->\n                assert.ok @_running\n\n                docQuery = @_document?._query\n                if not @_target or docQuery\n                    if docQuery\n                        for classElem in @_document._classesInUse\n                            classElem.running = true\n                    return\n\n                updateTargetClass saveAndEnableClass, @_target, @\n\n                unless @_document?._query\n                    loadObjects @, @_target\n\n                return\n\n            _disable: ->\n                assert.notOk @_running\n\n                if not @_target\n                    if @_document and @_document._query\n                        for classElem in @_document._classesInUse\n                            classElem.running = false\n                    return\n\n                unless @_document?._query\n                    unloadObjects @, @_target\n\n                updateTargetClass saveAndDisableClass, @_target, @\n                return\n\n## *Object* Class::children\n\n            utils.defineProperty @::, 'children', null, ->\n                @_children ||= new ChildrenObject(@)\n            , (val) ->\n                {children} = @\n\n                # clear\n                length = children.length\n                while length--\n                    children.pop length\n\n                if val\n                    assert.isArray val\n\n                    for child in val\n                        children.append child\n\n                return\n\n            class ChildrenObject\n\n## *Integer* Class::children.length = `0`\n\n                constructor: (ref) ->\n                    @_ref = ref\n                    @length = 0\n\n## *Object* Class::children.append(*Object* value)\n\n                append: (val) ->\n                    assert.instanceOf val, itemUtils.Object\n                    assert.isNot val, @_ref\n\n                    if val instanceof Class\n                        updateChildPriorities @_ref, val\n\n                    @[@length++] = val\n\n                    val\n\n## *Object* Class::children.pop(*Integer* index)\n\n                pop: (i = @length - 1) ->\n                    assert.operator i, '>=', 0\n                    assert.operator i, '<', @length\n\n                    oldVal = @[i]\n                    delete @[i]\n                    --@length\n\n                    oldVal\n\n            clone: ->\n                clone = cloneClassWithNoDocument.call @\n\n                if doc = @_document\n                    cloneDoc = clone.document\n                    cloneDoc.query = doc.query\n                    for name, arr of doc._signals\n                        cloneDoc._signals[name] = utils.clone arr\n\n                clone\n\n        loadObjects = (classElem, item) ->\n            if children = classElem._children\n                for child in children\n                    if child instanceof Renderer.Item\n                        child.parent ?= item\n                    else\n                        if child instanceof Class\n                            updateChildPriorities classElem, child\n                        child.target ?= item\n            return\n\n        unloadObjects = (classElem, item) ->\n            if children = classElem._children\n                for child in children\n                    if child instanceof Renderer.Item\n                        if child.parent is item\n                            child.parent = null\n                    else\n                        if child.target is item\n                            child.target = null\n            return\n\n        updateChildPriorities = (parent, child) ->\n            child._inheritsPriority = parent._inheritsPriority + parent._priority\n            child._nestingPriority = parent._nestingPriority + 1 + (child._document?._priority or 0)\n            updatePriorities child\n            return\n\n        updatePriorities = (classElem) ->\n            # refresh if needed\n            if classElem._running and ifClassListWillChange(classElem)\n                target = classElem._target\n                updateTargetClass disableClass, target, classElem\n                updateClassList target\n                updateTargetClass enableClass, target, classElem\n\n            # children\n            if children = classElem._children\n                for child in children\n                    if child instanceof Class\n                        updateChildPriorities classElem, child\n\n            # document\n            if document = classElem._document\n                {_inheritsPriority, _nestingPriority} = classElem\n                for child in document._classesInUse\n                    child._inheritsPriority = _inheritsPriority\n                    child._nestingPriority = _nestingPriority\n                    updatePriorities child\n                for child in document._classesPool\n                    child._inheritsPriority = _inheritsPriority\n                    child._nestingPriority = _nestingPriority\n            return\n\n        ifClassListWillChange = (classElem) ->\n            unless target = classElem._target\n                return false\n            classList = target._classList\n            index = classList.indexOf classElem\n\n            if index > 0 and classListSortFunc(classElem, classList[index - 1]) < 0\n                return true\n            if index < classList.length - 1 and classListSortFunc(classElem, classList[index + 1]) > 0\n                return true\n            false\n\n        classListSortFunc = (a, b) ->\n            (b._priority + b._inheritsPriority) - (a._priority + a._inheritsPriority) or\n            (b._nestingPriority) - (a._nestingPriority)\n\n        updateClassList = (item) ->\n            item._classList.sort classListSortFunc\n\n        cloneClassChild = (classElem, child) ->\n            child.clone()\n\n        cloneClassWithNoDocument = ->\n            clone = Class.New()\n            clone.id = @id\n            clone._classUid = @_classUid\n            clone._priority = @_priority\n            clone._inheritsPriority = @_inheritsPriority\n            clone._nestingPriority = @_nestingPriority\n            clone._changes = @_changes\n\n            if @_bindings\n                for prop, val of @_bindings\n                    clone.createBinding prop, val\n\n            # clone children\n            if children = @_children\n                for child, i in children\n                    childClone = cloneClassChild clone, child\n                    clone.children.append childClone\n\n            clone\n\n        {splitAttribute, getObjectByPath} = itemUtils\n\n        setAttribute = (item, attr, val) ->\n            path = splitAttribute attr\n            if object = getObjectByPath(item, path)\n                object[path[path.length - 1]] = val\n            return\n\n        saveAndEnableClass = (item, classElem) ->\n            assert.notOk utils.has(item._classList, classElem)\n            item._classList.unshift classElem\n            if ifClassListWillChange(classElem)\n                updateClassList item\n            enableClass item, classElem\n\n        saveAndDisableClass = (item, classElem) ->\n            assert.ok utils.has(item._classList, classElem)\n            disableClass item, classElem\n            utils.remove item._classList, classElem\n\n        ATTRS_ALIAS_DEF = [\n            ['x', 'anchors.left', 'anchors.right', 'anchors.horizontalCenter', 'anchors.centerIn', 'anchors.fill', 'anchors.fillWidth'],\n            ['y', 'anchors.top', 'anchors.bottom', 'anchors.verticalCenter', 'anchors.centerIn', 'anchors.fill', 'anchors.fillHeight'],\n            ['width', 'anchors.fill', 'anchors.fillWidth', 'fillWidth'],\n            ['height', 'anchors.fill', 'anchors.fillHeight', 'fillHeight'],\n        ]\n\n        ATTRS_ALIAS = Object.create null\n        ATTRS_ALIAS['margin'] = ['margin.left', 'margin.right', 'margin.top', 'margin.bottom']\n        ATTRS_ALIAS['padding'] = ['padding.left', 'padding.right', 'padding.top', 'padding.bottom']\n        ATTRS_ALIAS['alignment'] = ['alignment.horizontal', 'alignment.vertical']\n\n        do ->\n            for aliases in ATTRS_ALIAS_DEF\n                for prop in aliases\n                    arr = ATTRS_ALIAS[prop] ?= []\n                    for alias in aliases\n                        if alias isnt prop\n                            arr.push alias\n            return\n\n        getContainedAttributeOrAlias = (classElem, attr) ->\n            if changes = classElem._changes\n                attrs = changes._attributes\n                if attrs[attr] isnt undefined\n                    return attr\n                else if aliases = ATTRS_ALIAS[attr]\n                    for alias in aliases\n                        if attrs[alias] isnt undefined\n                            return alias\n            return ''\n\n        getPropertyDefaultValue = (obj, prop) ->\n            proto = Object.getPrototypeOf obj\n            innerProp = itemUtils.getInnerPropName(prop)\n            if innerProp of proto\n                proto[innerProp]\n            else\n                proto[prop]\n\n        enableClass = (item, classElem) ->\n            assert.instanceOf item, itemUtils.Object\n            assert.instanceOf classElem, Class\n\n            classList = item._classList\n            classListIndex = classList.indexOf classElem\n            classListLength = classList.length\n            if classListIndex is -1\n                return\n\n            unless changes = classElem._changes\n                return\n\n            attributes = changes._attributes\n            bindings = changes._bindings\n\n            # attributes\n            for attr, val of attributes\n                path = null\n                writeAttr = true\n                alias = ''\n                for i in [classListIndex - 1..0] by -1\n                    if getContainedAttributeOrAlias(classList[i], attr)\n                        writeAttr = false\n                        break\n\n                if writeAttr\n                    # unset alias\n                    for i in [classListIndex + 1...classListLength] by 1\n                        if (alias = getContainedAttributeOrAlias(classList[i], attr)) and alias isnt attr\n                            path = splitAttribute alias\n                            object = getObjectByPath item, path\n                            lastPath = path[path.length - 1]\n                            unless object\n                                continue\n                            defaultValue = getPropertyDefaultValue object, lastPath\n                            defaultIsBinding = !!classList[i].changes._bindings[alias]\n                            if defaultIsBinding\n                                object.createBinding lastPath, null, item\n                            object[lastPath] = defaultValue\n                            break\n\n                    # set new attribute\n                    if attr isnt alias or not path\n                        path = splitAttribute attr\n                        lastPath = path[path.length - 1]\n                        object = getObjectByPath item, path\n\n                    `\/\/<development>`\n                    if not object or not (lastPath of object)\n                        log.error \"\"\"\n                            Attribute '#{attr}' doesn't exist in '#{item}'\n                        \"\"\"\n                        continue\n                    `\/\/<\/development>`\n                    unless object\n                        continue\n\n                    if bindings[attr]\n                        object.createBinding lastPath, val, item\n                    else if typeof val is 'function' and object[lastPath]?.connect\n                        object[lastPath].connect val, item\n                    else\n                        if object._bindings?[lastPath]\n                            object.createBinding lastPath, null, item\n                        object[lastPath] = val\n\n            return\n\n        disableClass = (item, classElem) ->\n            assert.instanceOf item, itemUtils.Object\n            assert.instanceOf classElem, Class\n\n            classList = item._classList\n            classListIndex = classList.indexOf classElem\n            classListLength = classList.length\n            if classListIndex is -1\n                return\n\n            unless changes = classElem._changes\n                return\n\n            attributes = changes._attributes\n            bindings = changes._bindings\n\n            # attributes\n            for attr, val of attributes\n                path = null\n                restoreDefault = true\n                alias = ''\n                for i in [classListIndex - 1..0] by -1\n                    if getContainedAttributeOrAlias(classList[i], attr)\n                        restoreDefault = false\n                        break\n\n                if restoreDefault\n                    # get default value\n                    defaultValue = undefined\n                    defaultIsBinding = false\n                    for i in [classListIndex + 1...classListLength] by 1\n                        if alias = getContainedAttributeOrAlias(classList[i], attr)\n                            defaultValue = classList[i].changes._attributes[alias]\n                            defaultIsBinding = !!classList[i].changes._bindings[alias]\n                            break\n                    alias ||= attr\n\n                    # restore binding\n                    if !!bindings[attr]\n                        path = splitAttribute attr\n                        object = getObjectByPath item, path\n                        lastPath = path[path.length - 1]\n                        unless object\n                            continue\n                        object.createBinding lastPath, null, item\n\n                    # set default value\n                    if attr isnt alias or not path\n                        path = splitAttribute alias\n                        object = getObjectByPath item, path\n                        lastPath = path[path.length - 1]\n                        unless object\n                            continue\n\n                    if defaultIsBinding\n                        object.createBinding lastPath, defaultValue, item\n                    else if typeof val is 'function' and object[lastPath]?.connect\n                        object[lastPath].disconnect val, item\n                    else\n                        if defaultValue is undefined\n                            defaultValue = getPropertyDefaultValue object, lastPath\n                        object[lastPath] = defaultValue\n\n            return\n\n        runQueue = (target) ->\n            classQueue = target._classQueue\n            [func, target, classElem] = classQueue\n            func target, classElem\n            classQueue.shift()\n            classQueue.shift()\n            classQueue.shift()\n            if classQueue.length > 0\n                runQueue target\n            return\n\n        updateTargetClass = (func, target, classElem) ->\n            classQueue = target._classQueue\n            classQueue.push func, target, classElem\n            if classQueue.length is 3\n                runQueue target\n            return\n\n        class ElementTarget extends itemUtils.Object\n            constructor: (element) ->\n                super()\n                @_element = element\n                Object.seal @\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'element'\n                defaultValue: null\n\n        Class.ElementTarget = ElementTarget\n\n## *Object* Class::document\n\n        class ClassChildDocument\n            constructor: (parent) ->\n                @_ref = parent._ref\n                @_parent = parent\n                @_multiplicity = 0\n                Object.preventExtensions @\n\n        class ClassDocument extends itemUtils.DeepObject\n            @__name__ = 'ClassDocument'\n\n## *Signal* Class::onDocumentChange(*Object* document)\n\n            itemUtils.defineProperty\n                constructor: Class\n                name: 'document'\n                valueConstructor: @\n\n            onTargetChange = (oldVal) ->\n                if oldVal\n                    oldVal.onElementChange.disconnect @reloadQuery, @\n                if val = @_ref._target\n                    val.onElementChange.connect @reloadQuery, @\n                if oldVal isnt val\n                    @reloadQuery()\n                return\n\n            constructor: (ref) ->\n                @_query = ''\n                @_classesInUse = []\n                @_classesPool = []\n                @_nodeWatcher = null\n                @_priority = 0\n                super ref\n\n                ref.onTargetChange.connect onTargetChange, @\n                onTargetChange.call @, ref._target\n\n## *Signal* Class::document.onNodeAdd(*Element* node)\n\n            SignalsEmitter.createSignal @, 'onNodeAdd'\n\n## *Signal* Class::document.onNodeRemove(*Element* node)\n\n            SignalsEmitter.createSignal @, 'onNodeRemove'\n\n## *String* Class::document.query\n\n## *Signal* Class::document.onQueryChange(*String* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'query'\n                defaultValue: ''\n                namespace: 'document'\n                parentConstructor: ClassDocument\n                developmentSetter: (val) ->\n                    assert.isString val\n                setter: (_super) -> (val) ->\n                    assert.notOk @_parent\n\n                    if @_query is val\n                        return\n\n                    unless @_query\n                        unloadObjects @, @_target\n\n                    _super.call @, val\n                    @reloadQuery()\n\n                    # update priority\n                    if @_ref._priority < 1\n                        # TODO\n                        # while calculating selector priority we take only the first query\n                        # as a priority for the whole selector;\n                        # to fix this we can split selector with multiple queries ('a, b')\n                        # into separated class instances\n                        cmdLen = TagQuery.getSelectorPriority val, 0, 1\n                        oldPriority = @_priority\n                        @_priority = cmdLen\n                        @_ref._nestingPriority += cmdLen - oldPriority\n                        updatePriorities @_ref\n\n                    unless val\n                        loadObjects @, @_target\n                    return\n\n            getChildClass = (style, parentClass) ->\n                for classElem in style._extensions\n                    if classElem instanceof Class\n                        if classElem._document?._parent is parentClass\n                            return classElem\n                return\n\n            connectNodeStyle = (style) ->\n                # omit duplications\n                uid = @_ref._classUid\n                for classElem in style._extensions\n                    if classElem instanceof Class\n                        if classElem isnt @_ref and classElem._classUid is uid and classElem._document instanceof ClassChildDocument\n                            classElem._document._multiplicity++\n                            return\n\n                # get class\n                unless classElem = @_classesPool.pop()\n                    classElem = cloneClassWithNoDocument.call @_ref\n                    classElem._document = new ClassChildDocument @\n\n                # save\n                @_classesInUse.push classElem\n                classElem.target = style\n\n                # run if needed\n                if not classElem._bindings?.running\n                    classElem.running = true\n                return\n\n            disconnectNodeStyle = (style) ->\n                unless classElem = getChildClass(style, @)\n                    return\n                if classElem._document._multiplicity > 0\n                    classElem._document._multiplicity--\n                    return\n                classElem.target = null\n                utils.remove @_classesInUse, classElem\n                @_classesPool.push classElem\n                return\n\n            onNodeStyleChange = (oldVal, val) ->\n                if oldVal\n                    disconnectNodeStyle.call @, oldVal\n                if val\n                    connectNodeStyle.call @, val\n                return\n\n            onNodeAdd = (node) ->\n                node.onStyleChange.connect onNodeStyleChange, @\n                if style = node._style\n                    connectNodeStyle.call @, style\n                @emit 'onNodeAdd', node\n                return\n\n            onNodeRemove = (node) ->\n                node.onStyleChange.disconnect onNodeStyleChange, @\n                if style = node._style\n                    disconnectNodeStyle.call @, style\n                @emit 'onNodeRemove', node\n                return\n\n            reloadQuery: ->\n                # remove old\n                @_nodeWatcher?.disconnect()\n                @_nodeWatcher = null\n                while classElem = @_classesInUse.pop()\n                    classElem.target = null\n                    @_classesPool.push classElem\n\n                # add new ones\n                if (query = @_query) and (target = @_ref.target) and (node = target.element) and node.watch\n                    watcher = @_nodeWatcher = node.watch query\n                    watcher.onAdd.connect onNodeAdd, @\n                    watcher.onRemove.connect onNodeRemove, @\n                return\n\n        Class\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"a1bf275c6fabcc2af24f839a5c7f4cf2528c653f","subject":"Updated documentation comment to identify that gamepad inputs are not clamped.","message":"Updated documentation comment to identify that gamepad inputs are not\nclamped.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat","old_file":"src\/input\/gamepad.litcoffee","new_file":"src\/input\/gamepad.litcoffee","new_contents":"This exports an object, where keys are control names and values are numbers from\n0 to 1 representing state.  These are not, however, clamped to this range.\n\n    module.exports = \n        left: 0\n        right: 0\n        forward: 0\n        backward: 0\n        up: 0\n        down: 0","old_contents":"This exports an object, where keys are control names and values are numbers from\n0 to 1 representing state.\n\n    module.exports = \n        left: 0\n        right: 0\n        forward: 0\n        backward: 0\n        up: 0\n        down: 0","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"99ca567c7a95833876700d75f97269bf69d4380c","subject":"remove `state.method`","message":"remove `state.method`\n","repos":"nickfargo\/restate","old_file":"src\/state-function.litcoffee","new_file":"src\/state-function.litcoffee","new_contents":"## [state()](#state-function)\n\n> [`state()`](\/api\/#state-function)\n> [The `state` function](\/docs\/#getting-started--the-state-function)\n\nThe `state` module is exported as a function. Invoking this function is the\nprimary point of entry into the module. It is used either to:\n\n1. generate a formal `StateExpression`; or\n\n2. bestow an arbitrary `owner` object with a state implementation, based on the\n   application of the provided `expression` to a new `RootState` \u2014 and then\n   return the owner\u2019s initial `State`.\n\nAll arguments are optional. If only one `object`-typed argument is provided,\nit is assigned to the `expression` parameter. If no `owner` is present,\n`state()` returns a `StateExpression` based on the contents of `expression`\n(and `attributes`). If both an `owner` and `expression` are present, `state`\nacts in the second capacity, causing `owner` to become stateful.\n\nThe `attributes` argument may include any of the words defined in\n`STATE_ATTRIBUTE_MODIFIERS`, which are encoded into the provided `expression`.\n\n> See also:\n> [`State`][],\n> [`STATE_ATTRIBUTES`][],\n> [`StateExpression`][]\n\n    state = ( owner, attributes, expression, options ) ->\n      if arguments.length < 2\n        if typeof owner is 'string'\n        then attributes = owner\n        else expression = owner\n        owner = undefined\n      else\n        if typeof owner is 'string'\n          options = expression\n          expression = attributes\n          attributes = owner\n          owner = undefined\n        if typeof attributes isnt 'string'\n          options = expression\n          expression = attributes\n          attributes = undefined\n\nFormalize the provided `expression` (even if `expression` is already a formal\n`StateExpression`), incorporating any provided `attributes`.\n\n      expression = new StateExpression attributes, expression\n\nWith an `owner` present, the inferred intent is to *implement* `expression`\ninto `owner`; otherwise the inference is only to *formalize* the `expression`\nas a `StateExpression`.\n\n      if owner\n      then ( new RootState owner, expression, options )._current\n      else expression\n\n\n\n### Accessory properties\n\n\n#### Metadata\n\nMix the project\u2019s `meta` properties into the exported `state` function.\n\n    O.assign state, meta\n\n\n\n### Utility functions\n\n\n#### [state.bind](#state-function--bind)\n\nUsed inside a state expression, a function `fn` wrapped with `state.bind` will\nbind the context of `fn` either to any `State` created from that expression, or\nwhen invoked for an object that inherits from the `owner` of the bound `State`,\nto the corresponding **epistate** of that `State`.\n\nThusly bound methods, event listeners, etc., whose context would have normally\nbeen the `owner`, still retain a reference thereto via `this.owner`.\n\n* `fn` : ( any\u2026 ) \u2192 any\n\n    state.bind = ( fn ) -> { type: 'state-bound-function', fn }\n\n\n#### [state.fix](#state-function--fix)\n\nUsed inside a state expression, a combinator `fn` wrapped with `state.fix` will\nbe partially applied with a reference to `autostate`, the precise `State` to\nwhich the combinator\u2019s returned function will belong, and a reference to\n`protostate`, the immediate **protostate** of `autostate`.\n\nA method, event listener, etc. that is `fix`ed thusly has access to, and full\nlexical awareness of, the particular `State` environment in which it exists.\n\n* `fn` : ( autostate, protostate ) \u2192 ( any\u2026 ) \u2192 any\n\n    state.fix = ( fn ) -> { type: 'state-fixed-function', fn }\n\n\n### Exports\n\nThe `state` module is exported via CommonJS on the server, and globally in the\nbrowser.\n\n    if O.env.server then module.exports = exports = state\n    if O.env.client then global['state'] = state\n","old_contents":"## [state()](#state-function)\n\n> [`state()`](\/api\/#state-function)\n> [The `state` function](\/docs\/#getting-started--the-state-function)\n\nThe `state` module is exported as a function. Invoking this function is the\nprimary point of entry into the module. It is used either to:\n\n1. generate a formal `StateExpression`; or\n\n2. bestow an arbitrary `owner` object with a state implementation, based on the\n   application of the provided `expression` to a new `RootState` \u2014 and then\n   return the owner\u2019s initial `State`.\n\nAll arguments are optional. If only one `object`-typed argument is provided,\nit is assigned to the `expression` parameter. If no `owner` is present,\n`state()` returns a `StateExpression` based on the contents of `expression`\n(and `attributes`). If both an `owner` and `expression` are present, `state`\nacts in the second capacity, causing `owner` to become stateful.\n\nThe `attributes` argument may include any of the words defined in\n`STATE_ATTRIBUTE_MODIFIERS`, which are encoded into the provided `expression`.\n\n> See also:\n> [`State`][],\n> [`STATE_ATTRIBUTES`][],\n> [`StateExpression`][]\n\n    state = ( owner, attributes, expression, options ) ->\n      if arguments.length < 2\n        if typeof owner is 'string'\n        then attributes = owner\n        else expression = owner\n        owner = undefined\n      else\n        if typeof owner is 'string'\n          options = expression\n          expression = attributes\n          attributes = owner\n          owner = undefined\n        if typeof attributes isnt 'string'\n          options = expression\n          expression = attributes\n          attributes = undefined\n\nFormalize the provided `expression` (even if `expression` is already a formal\n`StateExpression`), incorporating any provided `attributes`.\n\n      expression = new StateExpression attributes, expression\n\nWith an `owner` present, the inferred intent is to *implement* `expression`\ninto `owner`; otherwise the inference is only to *formalize* the `expression`\nas a `StateExpression`.\n\n      if owner\n      then ( new RootState owner, expression, options )._current\n      else expression\n\n\n\n### Accessory properties\n\n\n#### Metadata\n\nMix the project\u2019s `meta` properties into the exported `state` function.\n\n    O.assign state, meta\n\n\n\n### Utility functions\n\n\n#### [state.bind](#state-function--bind)\n\nUsed inside a state expression, a function `fn` wrapped with `state.bind` will\nbind the context of `fn` either to any `State` created from that expression, or\nwhen invoked for an object that inherits from the `owner` of the bound `State`,\nto the corresponding **epistate** of that `State`.\n\nThusly bound methods, event listeners, etc., whose context would have normally\nbeen the `owner`, still retain a reference thereto via `this.owner`.\n\n* `fn` : ( any\u2026 ) \u2192 any\n\n    state.bind = ( fn ) -> { type: 'state-bound-function', fn }\n\n\n#### [state.fix](#state-function--fix)\n\nUsed inside a state expression, a combinator `fn` wrapped with `state.fix` will\nbe partially applied with a reference to `autostate`, the precise `State` to\nwhich the combinator\u2019s returned function will belong, and a reference to\n`protostate`, the immediate **protostate** of `autostate`.\n\nA method, event listener, etc. that is `fix`ed thusly has access to, and full\nlexical awareness of, the particular `State` environment in which it exists.\n\n* `fn` : ( autostate, protostate ) \u2192 ( any\u2026 ) \u2192 any\n\n    state.fix = ( fn ) -> { type: 'state-fixed-function', fn }\n\n\n#### [state.method](#state-function--method)\n\n> Deprecate me\n\nReturns a `factory`, nominally for internal use, which will flatten the scope\nof the provided `fn`, reclose it both over any provided `bindings` and over a\nset of `lexicals` based on `autostate`, which is provided to `factory` as the\n`State` instance that will contain the **lexical state methods** that `factory`\nproduces.\n\nWrapping method functions with `state.method` inside a state expression is\nuseful particularly for exposing to the method body a correct reference to the\n**protostate**, while also ensuring that the method is fully heritable by both\n**substates** and **epistates** (inheritors of a protostate).\n\n> [Lexical binding in state methods][]\n\n> [`state.method`](\/api\/#state-function--method)\n\n    state.method = do ->\n      lexicals = ['__State__', 'autostate', 'protostate']\n\n      pattern = \/\/\/^\n        ( function\n            \\s*\n          (?:[$_A-Za-z][$\\w]*)?\n            \\s*\n          \\((?:[\\s\\S]*?)\\)\n            \\s*\n          \\{\n        )\n        (\\s\\S]*)\n      \/\/\/\n\n      template = \"\"\"\n        return $1\n          var superstate, owner;\n          if ( this instanceof __State__ ) {\n            superstate = this.superstate;\n            owner = this.owner;\n          }\n        $2;\n      \"\"\"\n\n      createMethod = ( factory, autostate, bindings, fn ) ->\n\nGather all the identifiers that the transformed `fn` will be closed over, and\narrange them into an array of named `params`.\n\n        identifiers = if bindings? and ( typeof bindings is 'object' or\n          typeof bindings is 'function' ) then O.keys bindings else []\n        values = ( bindings[ id ] for id in identifiers )\n        params = identifiers.concat lexicals\n\nGather all the values that will be mapped to the `params`.\n\n        args = [ State, autostate, autostate.protostate() ]\n        args = values.concat args if values.length\n\nWrite the body of the function that wraps `fn`, and inject `fn` with references\nto the superstate and owner of the context `State`.\n\n        body = Function::toString.call( fn ).replace pattern, template\n\nGenerate the wrapper function defined by `params` and `body`, and immediately\napply it with all of the closed binding values to produce the `method`.\n\n        method = Function.apply( null, params.concat body ).apply( null, args )\n\nSave the `factory` from which the method was created, so that the method can be\ncloned or exported, e.g. by calling `express`, to a separate `State`, where the\nmethod will need to be re-transformed with bindings to the environment of the\nnew state.\n\n        method.factory = factory\n\n        method.isLexicalStateMethod = true\n        method\n\n\n      return ( bindings, fn ) ->\n\n        factory = ( autostate ) ->\n\nInvocation from outside the module is forbidden, as this could expose\n`bindings`, which must remain private.\n\n          throw ReferenceError unless this is __MODULE__\n\nWith proper `bindings` and `fn` arguments, forward the invocation to\n`createMethod`.\n\n          if typeof bindings is 'object' and typeof fn is 'function'\n            createMethod factory, autostate, bindings, fn\n\nIf passed `bindings` only, return a partially applied function that accepts\n`fn` later.\n\n          else if typeof bindings is 'object' and fn is undefined\n            ( fn ) -> createMethod factory, autostate, bindings, fn\n\nIf passed only `fn` as the first argument, assume no `bindings`.\n\n          else if typeof bindings is 'function' and fn is undefined\n            createMethod factory, autostate, null, bindings\n\n        factory.isLexicalStateMethodFactory = true\n        factory\n\n\n\n### Exports\n\nThe `state` module is exported via CommonJS on the server, and globally in the\nbrowser.\n\n    if O.env.server then module.exports = exports = state\n    if O.env.client then global['state'] = state\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f55aa17da10da794249ee2f1e63d0abda2873831","subject":"Ensure we dont' add the same render_pipeline entries twice","message":"Ensure we dont' add the same render_pipeline entries twice\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/skyll.litcoffee","new_file":"lib\/skyll.litcoffee","new_contents":"    Module = require '.\/module'\n    Carver = require '.\/carver'\n    q      = require 'q'\n\n    class Skyll extends Module\n      deps: [ 'q' ]\n      pub:  [ 'craft' ]\n\n      render_pipeline: [ ]\n      starting_row:    0\n\n      grid: undefined\n\n      cell:\n        width:  0\n        height: 0\n\n      pathfinder: (neighbors) ->\n        o = [ ]\n\n        for n in [1..(neighbors.length \/ 1)]\n          c = 1 \/ neighbors.length\n\n          if neighbors[n - 1] == 'RIGHT'\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * ((2 \/ c) * 0.5)) * c\n          else\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * (0.5 \/ c)) * c\n\n        chance = Math.random()\n\n        for option in o\n          neighbor = Object.keys(option)[0]\n\n          return neighbor if option[neighbor] > chance\n\n      initialize: (params) =>\n        deferred = q.defer()\n\n        @grid = params.grid\n        @cell = params.cell\n\n        @ctor_params = { }\n\n        @starting_row = params.starting_row\n\n        for p in params.pipeline\n          @ctor_params[p] =\n            width:  params.cell.width  * params.grid[0].length\n            height: params.cell.height * params.grid.length\n            cell:   params.cell\n\n          @deps.push p unless @deps.includes p\n\n        super().then =>\n          for p in params.pipeline\n            @render_pipeline.push @[p] unless @render_pipeline.includes @[p]\n          deferred.resolve @\n\n        deferred.promise\n\n      craft: (level) =>\n        new Carver()\n          .initialize @grid, @starting_row, @pathfinder\n          .then (mod)  => mod.carve_path()\n          .then (path) => @q.all @render_pipeline.map (p) => p.render level, path\n          .then        => @done()\n\n    module.exports = Skyll\n","old_contents":"    Module = require '.\/module'\n    Carver = require '.\/carver'\n    q      = require 'q'\n\n    class Skyll extends Module\n      deps: [ 'q' ]\n      pub:  [ 'craft' ]\n\n      render_pipeline: [ ]\n      starting_row:    0\n\n      grid: undefined\n\n      cell:\n        width:  0\n        height: 0\n\n      pathfinder: (neighbors) ->\n        o = [ ]\n\n        for n in [1..(neighbors.length \/ 1)]\n          c = 1 \/ neighbors.length\n\n          if neighbors[n - 1] == 'RIGHT'\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * ((2 \/ c) * 0.5)) * c\n          else\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * (0.5 \/ c)) * c\n\n        chance = Math.random()\n\n        for option in o\n          neighbor = Object.keys(option)[0]\n\n          return neighbor if option[neighbor] > chance\n\n      initialize: (params) =>\n        deferred = q.defer()\n\n        @grid = params.grid\n        @cell = params.cell\n\n        @ctor_params = { }\n\n        @starting_row = params.starting_row\n\n        for p in params.pipeline\n          @ctor_params[p] =\n            width:  params.cell.width  * params.grid[0].length\n            height: params.cell.height * params.grid.length\n            cell:   params.cell\n\n          @deps.push p unless @deps.includes p\n\n        super().then =>\n          for p in params.pipeline\n            render_pipeline.push @[p]\n\n          deferred.resolve @\n\n        deferred.promise\n\n      craft: (level) =>\n        new Carver()\n          .initialize @grid, @starting_row, @pathfinder\n          .then (mod)  => mod.carve_path()\n          .then (path) => @q.all @render_pipeline.map (p) => p.render level, path\n          .then        => @done()\n\n    module.exports = Skyll\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ce4b4635090dd627283a19a257298078e5cb001f","subject":"Finished the Box class","message":"Finished the Box class\n\nSigned-off-by: Diwank Singh <a78369447041e6bcf2913d083e4ed301785fc609@gmail.com>\n","repos":"creatorrr\/browser-bricks","old_file":"bricks.litcoffee","new_file":"bricks.litcoffee","new_contents":"Re: [Letter to a Source-Code-Reader](http:\/\/stewd.io\/pong\/lib\/pong.js)\n\nDear Stewart\n\nThanks for inspiring me and many like me with the wonders of js.\nWith all it's warts and issues, JS is still one of my favorite languages.\nI think simply by it's virtue of being the language of the web, it surpasses most others\nin it's ability to champion the spirit of openness.\n\nI have tried to keep this as simple as possible for the many awesome source code lovers\nto read, reuse and critique.\n\nThanks again for caring to write that letter in 2009. It made a kid smile.\n\nDiwank Singh\nJuly 2013\n\n*****\n\nBrowser Bricks\n==============\n\nAlright, let's get on with it.\n\nHelper Functions\n----------------\n\nFirst, let's define some helper functions for the application.\n\n    @_ = _ =   # _ namespace\n      # Extend objects\n      extend: (dest, src) ->\n        dest[k] = v for own k, v of src\n        dest\n\n      # Pick properties\n      pick: (obj, props) ->\n        result = {}\n        result[k] = obj[k] for k in props when obj[k]?\n\n        result\n\n      # UUID function (Copied shamelessly from https:\/\/gist.github.com\/bmc\/1893440)\n      uuid: ->\n        'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(\/[xy]\/g, (c) ->\n          r = Math.random() * 16 | 0\n          v = if c is 'x' then r else (r & 0x3|0x8)\n          v.toString(16)\n        )\n\n      # Simple serializer for flat objects\n      serialize: (obj, {sep, eq}, cb) ->\n        # Exec callback on all values of obj\n        obj[k] = cb v for own k, v of obj if cb?\n\n        # Return serialized obj\n        (\"#{ k }#{ eq }#{ v }\" for own k, v of obj).join sep\n\n      # Defer execution of function\n      defer: (fn, args...) -> window.setTimeout fn, 1, args...\n\n      # Clone object\n      clone: (obj) -> _.extend {}, obj\n\nInit Function\n-------------\n\nLet's write a global init function that can be used to register callbacks which are\nexecuted 'onload'.\n\n    # Callback register\n    @init = init = do ->\n      # Store registered callbacks\n      callbacks = []\n\n      # Run callbacks in order registered\n      exec = -> fn?() for fn in callbacks\n\n      # Onload callback\n      onLoad = (fn) ->\n        window.removeEventListener 'load', init, false\n        fn?()\n\n      (cb) ->\n        if cb?\n          # Register callback\n          callbacks.push cb\n        else\n          # Defer execution until stack cleared\n          onLoad -> _.defer exec\n\n        false\n\n    # Attach DOM load listener\n    window.addEventListener 'load', init, false\n\nClass: Box\n----------\n\nNow, let's define a box that will be the basic building block for the game.\nAll the objects will inherit from this class.\n\n    class Box\n      _EDITABLE: ['height', 'width', 'top', 'left']   # Editable settings\n      _settings:\n        # Default settings\n        height: 100\n        width:  200\n        top:    0\n        left:   0\n\n        # Fixed props\n        toolbar:     false\n        directories: false\n        fullscreen:  false\n        location:    false\n        menubar:     false\n        resizable:   false\n        scrollbars:  false\n        status:      false\n\n      _window: null  # Empty window object\n\n      constructor: (@url, settings) ->\n        # Override settings.\n        @_update settings\n\n        # Set random name\n        @id = _.uuid()\n        this\n\n      # -- Private --\n\n      _update: (settings) ->\n        # Update settings\n        _.extend @_settings, (_.pick settings, @_EDITABLE)\n\n        # Adjust window props\n        @_window?.moveTo (@_get 'left'), (@_get 'top')\n        @_window?.resizeTo (@_get 'width'), (@_get 'height')\n\n        # Return a copy of settings\n        @_getAll()\n\n      _get: (prop) -> @_settings[prop] if prop in @_EDITABLE\n      _getAll: -> _.clone @_settings\n\n      _getDefaults: -> Box::_settings\n\n      # -- Public --\n\n      # Show window with settings.\n      show: ->\n        # Serialize options\n        opts = _.serialize @_getAll(), {sep: ',', eq: '='}, (v) ->\n          switch v\n            when false then 'no'\n            when true then 'yes'\n            else v+''\n\n        @_window = window.open @url, @id, opts\n        this\n\n      # Hide the window.\n      hide: ->\n        @_window.close()\n        @_window = null\n        this\n\n      # Reset window settings.\n      reset: ->\n        @_update @_getDefaults()\n        this\n\n      # Return or update window position coords.\n      position: (coords...) ->\n        # Set new coords\n        if coords.length then @_update\n          left: coords[0] ? @_getDefaults().left  # x\n          top:  coords[1] ? @_getDefaults().top   # y\n\n        # Return coords\n        _.pick @_getAll(), ['top', 'left']\n\n      # Return or update window dimensions.\n      size: (dimensions...) ->\n        # Set new dimensions\n        if dimensions.length then @_update\n          width:  dimensions[0] ? @_getDefaults().width\n          height: dimensions[1] ? @_getDefaults().height\n\n        # Return dimensions\n        _.pick @_getAll(), ['width', 'height']\n\n","old_contents":"Re: [Letter to a Source-Code-Reader](http:\/\/stewd.io\/pong\/lib\/pong.js)\n\nDear Stewart\n\nThanks for inspiring me and many like me with the wonders of js.\nWith all it's warts and issues, JS is still one of my favorite languages.\nI think simply by it's virtue of being the language of the web, it surpasses most others\nin it's ability to champion the spirit of openness and the creative.\n\nI have tried to keep this as simple as possible for the many awesome source code lovers\nto read, copy-paste and critique.\n\nThanks again for caring to write that letter in 2009. It made a kid smile.\n\nDiwank Singh\nJuly 2013\n\n*****\n\nBrowser Bricks\n==============\n\nAlright, let's get on with it.\n\nHelper Functions\n----------------\n\nFirst, let's define some helper functions for the application.\n\n    @_ = _ =   # _ namespace\n      # Extend objects\n      extend: (dest, src) ->\n        dest[k] = v for own k, v of src\n        dest\n\n      # Pick properties\n      pick: (obj, props) ->\n        result = {}\n        result[k] = obj[k] for k in props when obj[k]?\n\n        result\n\n      # UUID function (Copied shamelessly from https:\/\/gist.github.com\/bmc\/1893440)\n      uuid: ->\n        'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(\/[xy]\/g, (c) ->\n          r = Math.random() * 16 | 0\n          v = if c is 'x' then r else (r & 0x3|0x8)\n          v.toString(16)\n        )\n\n      # Simple serializer for flat objects\n      serialize: (obj, {sep, eq}, cb) ->\n        # Exec callback on all values of obj\n        obj[k] = cb v for own k, v of obj if cb?\n\n        # Return serialized obj\n        (\"#{ k }#{ eq }#{ v }\" for own k, v of obj).join sep\n\n      # Defer execution of function\n      defer: (fn, args...) -> window.setTimeout fn, 1, args...\n\n      # Clone object\n      clone: (obj) -> _.extend {}, obj\n\nInit Function\n-------------\n\nLet's write a global init function that can be used to register callbacks which are\nexecuted 'onload'.\n\n    # Callback register\n    @init = init = do ->\n      # Store registered callbacks\n      callbacks = []\n\n      # Run callbacks in order registered\n      exec = -> fn?() for fn in callbacks\n\n      # Onload callback\n      onLoad = (fn) ->\n        window.removeEventListener 'load', init, false\n        fn?()\n\n      (cb) ->\n        if cb?\n          # Register callback\n          callbacks.push cb\n        else\n          # Defer execution until stack cleared\n          onLoad -> _.defer exec\n\n        false\n\n    # Attach DOM load listener\n    window.addEventListener 'load', init, false\n\nClass: Box\n----------\n\nNow, let's define a box that will be the basic building block for the game.\nAll the objects will inherit from this class.\n\n    class Box\n      _EDITABLE: ['height', 'width', 'top', 'left']   # Editable settings\n      _settings:\n        # Default settings\n        height: 100\n        width:  200\n        top:    0\n        left:   0\n\n        # Fixed props\n        toolbar:     false\n        directories: false\n        fullscreen:  false\n        location:    false\n        menubar:     false\n        resizable:   false\n        scrollbars:  false\n        status:      false\n\n      _window: null  # Empty window object\n\n      constructor: (@url, settings) ->\n        # Override settings.\n        @_update settings\n\n        # Set random name\n        @id = _.uuid()\n        this\n\n      # -- Private --\n\n      _update: (settings) ->\n        # Update settings\n        _.extend @_settings, (_.pick settings, @_EDITABLE)\n\n        # Adjust window props\n        @_window?.moveTo (@_get 'left'), (@_get 'top')\n        @_window?.resizeTo (@_get 'width'), (@_get 'height')\n\n        # Return a copy of settings\n        @_getAll()\n\n      _get: (prop) -> @_settings[prop] if prop in @_EDITABLE\n      _getAll: -> _.clone @_settings\n\n      # -- Public --\n\n      # Show window with settings.\n      show: ->\n        # Serialize options\n        opts = _.serialize @_getAll(), {sep: ',', eq: '='}, (v) ->\n          switch v\n            when false then 'no'\n            when true then 'yes'\n            else v+''\n\n        @_window = window.open @url, @id, opts\n        this\n\n      # Hide the window.\n      hide: ->\n        @_window.close()\n        @_window = null\n        this\n\n      # Reset window settings.\n      reset: ->\n        @_update Box::settings\n        this\n\n      # Return or update window position coords.\n      position: (coords...) ->\n        # Set new coords\n        if coords.length then @_update\n          left: coords[0] ? Box::settings.left  # x\n          top:  coords[1] ? Box::settings.top   # y\n\n        # Return coords\n        [(@_get 'left'), (@_get 'top')]\n\n      # Return or update window dimensions.\n      size: (dimensions...) ->\n        # Set new dimensions\n        if dimensions.length then @_update\n          width: dimensions[0] ? Box::settings.width\n          height:  dimensions[1] ? Box::settings.height\n\n        # Return dimensions\n        [(@_get 'width'), (@_get 'height')]\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9a0f0604520d27cf7331273e45473fd8c3a36709","subject":"Delete client.litcoffee","message":"Delete client.litcoffee\n","repos":"rianadon\/CheckPCR,19RyanA\/CheckPCR,19RyanA\/CheckPCR,rianadon\/CheckPCR,rianadon\/CheckPCR","old_file":"client.litcoffee","new_file":"client.litcoffee","new_contents":"","old_contents":"Welcome to the documentation of and the actual program of CheckPCR.\n\nThis is the main processing program containing that fetches your assignments from PCR, parses them, and displays them.\nIt is written in [Literate CoffeeScript](http:\/\/coffeescript.org\/#literate), a version of CoffeeScript (a language that compiles into JavaScript, which is used to modify content on webpages and allow interactions with webpages) that is also compliant with Markdown syntax and can be displayed as a Markdown file (as you see here if you are viewing this file from Github).\n\n#### Table of Contents\n* [Basic Definitions](#defs)\n* [Retrieving Data](#ret)\n* [Parsing](#parsing\")\n* [Displaying the assignments](#displaying)\n* [Side menu and Navbar](#side)\n* [Athena (Schoology)](#athena)\n* [Settings](#settings)\n* [Starting everything](#starting)\n* [Analytics](#analytics)\n* [Events](#events)\n* [Updates and News](#updates)\n* [Adding new assignments](#new)\n* [Firebase](#fb)\n* [Other](#other)\n\n##### So, here is the annotated code:\n\n<a name=\"defs\"\/>\nBasic Definitions\n-----------------\n\nFirst of all, if the online version is used, the http version is redirected to https.\n\n    if window.location.protocol is \"http:\" and location.hostname isnt \"localhost\"\n      window.location.href = \"https:\" + window.location.href.substring(window.location.protocol.length)\n\nAdditionally, if it's the user's first time, the page is set to the welcome page.\n\n    if not localStorage[\"noWelcome\"]?\n      localStorage[\"noWelcome\"] = \"true\"\n      window.location = \"welcome.html\"\n\nThen we have most of the global variables.\n\n    loginURL = \"https:\/\/webappsca.pcrsoft.com\/Clue\/SC-Student-Portal-Login-LDAP\/8464?returnUrl=https%3a%2f%2fwebappsca.pcrsoft.com%2fClue%2fSC-Assignments-End-Date-Range%2f7536\"\n    loginHeaders = {}\n    months = [\"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\", \"Jul\", \"Aug\", \"Sep\", \"Oct\", \"Nov\", \"Dec\"]\n    weekdays = [\"Sunday\", \"Monday\", \"Tuesday\", \"Wednesday\", \"Thursday\", \"Friday\", \"Saturday\"]\n    fullMonths = [\"January\", \"February\", \"March\", \"April\", \"May\", \"June\", \"July\", \"August\", \"September\", \"October\", \"November\", \"December\"]\n    tzoff = (new Date()).getTimezoneOffset()*1000*60 # For future calculations\n    mimeTypes =\n      \"application\/msword\": [\"Word Doc\", \"document\"]\n      \"application\/vnd.openxmlformats-officedocument.wordprocessingml.document\": [\"Word Doc\", \"document\"]\n      \"application\/vnd.ms-powerpoint\": [\"PPT Presentation\", \"slides\"]\n      \"application\/pdf\": [\"PDF File\", \"pdf\"]\n      \"text\/plain\": [\"Text Doc\", \"plain\"]\n    scroll = 0 # The location to scroll to in order to reach today in calendar view\n    viewData = {} # The data to send when switching PCR views\n    activity = []\n    dmp = new diff_match_patch() # For diffing\n    lastUpdate = 0 # The last time verything was updated\n    listDateOffset = 0\n\n    version = \"2.24.3\"\n\n#### Send function\n\nThis function sends a request to a server and returns a Promise.\n- *url* is the url we want to retrieve\n- *respType* is the type of response that should be recieved\n- *headers* is an object of headers that will be sent to the server\n- *data* is data that will be sent to the server (only for POST requests)\n- *progress* is a boolean that determines whether or not the progress bar should be used to display the status of the request\n\n\n    send = (url, respType, headers, data, progress=false) ->\n      return new Promise (resolve, reject) ->\n        req = new XMLHttpRequest()\n        req.open (if data? then \"POST\" else \"GET\"), url, true\n\n        progressElement = document.getElementById \"progress\"\n        progressInner = progressElement.querySelector \"div\"\n        if progress\n          progressElement.offsetWidth # Wait for it to render\n          progressElement.classList.add \"active\"\n          if progressInner.classList.contains \"determinate\"\n            progressInner.classList.remove \"determinate\"\n            progressInner.classList.add \"indeterminate\"\n\n        load = localStorage[\"load\"] or 170000\n\n        req.onload = (evt) ->\n          localStorage[\"load\"] = evt.loaded\n          progressElement.classList.remove \"active\" if progress\n          if req.status is 200\n            resolve req\n          else\n            reject Error req.statusText\n          return\n\n        req.onerror = ->\n          progressElement.classList.remove \"active\" if progress\n          reject Error \"Network Error\"\n          return\n        if progress\n          req.onprogress = (evt) ->\n            if progressInner.classList.contains \"indeterminate\"\n              progressInner.classList.remove \"indeterminate\"\n              progressInner.classList.add \"determinate\"\n            progressInner.style.width = 100 * evt.loaded \/ (if evt.lengthComputable then evt.total else load) + \"%\"\n\n        if respType?\n          req.responseType = respType;\n        if headers?\n          for headername, header of headers\n            req.setRequestHeader headername, header\n        if data?\n          req.send data\n        else\n          req.send()\n        return\n\n#### Cookie functions\n\nBelow is a function that will retrieve a cookie (a small text document that the browser can remember).\n- *cname* is the name of the cookie to retrieve\n\n\n    getCookie = (cname) ->\n      name = cname + \"=\"\n      ca = document.cookie.split(\";\")\n      i = 0\n      while i < ca.length\n        c = ca[i]\n        while c.charAt(0) is \" \"\n          c = c.substring(1)\n        if c.indexOf(name) isnt -1\n          return c.substring(name.length, c.length)\n        i++\n      \"\" # Blank if cookie not found\n\nTo set a cookie, this function is called.\n- *cname* is the name of the cookie to set\n- *cvalue* is the value to set the cookie to\n- *exdays* is the number of days that the cookie will expire in (and not be existent anymore)\n\n\n    setCookie = (cname, cvalue, exdays) ->\n      d = new Date\n      d.setTime d.getTime() + exdays * 24 * 60 * 60 * 1000\n      expires = \"expires=\" + d.toUTCString()\n      document.cookie = cname + \"=\" + cvalue + \"; \" + expires\n      return\n\nThe delete cookie function is like *setCookie*, but sets the expiry date to something in the past so the cookie is deleted.\n\n    deleteCookie = (cname) ->\n      document.cookie = cname + \"=; expires=Thu, 01 Jan 1970 00:00:01 GMT;\"\n      return\n\nThis function displays a snackbar to tell the user something\n\n    snackbar = (message, action, f) ->\n      snack = element \"div\", \"snackbar\"\n      snackInner = element \"div\", \"snackInner\", message\n      snack.appendChild snackInner\n      if action? and f?\n        actionE = element \"a\", [], action\n        actionE.addEventListener \"click\", ->\n            snack.classList.remove \"active\"\n            f()\n        snackInner.appendChild actionE\n\n      add = ->\n        document.body.appendChild snack\n        snack.offsetHeight\n        snack.classList.add \"active\"\n        setTimeout ->\n          snack.classList.remove \"active\"\n          setTimeout ->\n            snack.remove()\n          , 900\n        , 5000\n\n      existing = document.querySelector(\".snackbar\")\n      if existing?\n        existing.classList.remove \"active\"\n        setTimeout add, 300\n      else\n        add()\n      return\n\n*displayError* displays a dialog containing information about an error.\n\n    displayError = (e) ->\n      errorHTML = \"Messsage: #{e.message}\\nStack: #{e.stack or e.lineNumber}\\nBrowser: #{navigator.userAgent}\\nVersion: #{version}\"\n      document.getElementById(\"errorContent\").innerHTML = errorHTML.replace(\"\\n\", \"<br>\")\n      document.getElementById(\"errorGoogle\").href = \"https:\/\/docs.google.com\/a\/students.harker.org\/forms\/d\/1sa2gUtYFPdKT5YENXIEYauyRPucqsQCVaQAPeF3bZ4Q\/viewform?entry.120036223=#{encodeURIComponent(errorHTML)}\"\n      document.getElementById(\"errorGitHub\").href = \"https:\/\/github.com\/19RyanA\/CheckPCR\/issues\/new?body=#{encodeURIComponent(\"I've encountered an bug.\\n\\n```\\n#{errorHTML}\\n```\")}\"\n      document.getElementById(\"errorBackground\").style.display = \"block\"\n      document.getElementById(\"error\").classList.add \"active\"\n\n*FromDateNum* converts a number of days to a number of seconds\n\n    fromDateNum = (days) ->\n      d = new Date days*1000*3600*24+tzoff\n      if d.getHours() is 1 then d.setHours 0\n      if d.getHours() is 22 or d.getHours() is 23\n        d.setHours 24\n        d.setMinutes 0\n        d.setSeconds 0\n      d.getTime()\n\nBecause the requestIdleCallback function is very new (as of writing only works with Chrome version 47), the below function polyfills that method.\n\n    window.requestIdleCallback ?= (cb) ->\n      start = Date.now()\n      setTimeout ->\n        cb {\n          didTimeout: false,\n          timeRemaining: ->\n            Math.max 0, 50 - (Date.now() - start)\n        }\n      , 1\n\nBecause some localStorage entries can become corrupted due to error side effects, the below method tries to read a value from localStorage and handles errors.\n\n    localStorageRead = (name) ->\n      try\n        JSON.parse localStorage[name]\n      catch e\n        undefined\n\n<a name=\"ret\"\/>\nRetrieving data\n---------------\n\nThe function below converts an update time to a human-readable date.\n\n    formatUpdate = (date) ->\n      now = new Date()\n      update = new Date(+date)\n      if now.getDate() is update.getDate()\n        ampm = \"AM\"\n        hr = update.getHours()\n        if hr > 12\n          ampm = \"PM\"\n          hr -= 12\n        min = update.getMinutes()\n        \"Today at #{hr}:#{if min<10 then \"0\"+min else min} #{ampm}\"\n      else\n        daysPast = Math.ceil (now.getTime()-update.getTime())\/1000\/3600\/24\n        if daysPast is 1 then \"Yesterday\" else daysPast+\" days ago\"\n\nThis is the function that retrieves your assignments from PCR.\n\nFirst, a request is sent to PCR to load the page you would normally see when accessing PCR.\n\nBecause this is run as a chrome extension, this page can be accessed. Otherwise, the browser would throw an error for security reasons (you don't want a random website being able to access confidential data from a website you have logged into).\n\n    fetch = (override=false, data) ->\n      if not override and Date.now()-lastUpdate < 60000 # Less than a minute ago\n        return\n      lastUpdate = Date.now()\n      headers = if data? then { \"Content-type\": \"application\/x-www-form-urlencoded\" } else null\n      if location.protocol is \"chrome-extension:\"\n        console.time \"Fetching assignments\"\n        send \"https:\/\/webappsca.pcrsoft.com\/Clue\/SC-Assignments-End-Date-Range\/7536\", \"document\", headers, data, true\n          .then (resp) ->\n            console.timeEnd \"Fetching assignments\"\n            if resp.responseURL.indexOf(\"Login\") isnt -1\n              # We have to log in now\n              for e in resp.response.getElementsByTagName(\"input\")\n                loginHeaders[e.name] = e.value or \"\"\n              console.log \"Need to log in\"\n              up = getCookie(\"userPass\") # Attempts to get the cookie *userPass*, which is set if the \"Remember me\" checkbox is checked when logging in through CheckPCR\n              if up is \"\"\n                document.getElementById(\"loginBackground\").style.display = \"block\"\n                document.getElementById(\"login\").classList.add \"active\"\n              else\n                dologin window.atob(up).split(\":\") # Because we were remembered, we can log in immediately without waiting for the user to log in through the login form\n            else\n              # Logged in now\n              console.log \"Fetching assignments successful\"\n              t = Date.now()\n              localStorage[\"lastUpdate\"] = t\n              document.getElementById(\"lastUpdate\").innerHTML = formatUpdate t\n              try\n                parse resp.response\n              catch e\n                console.log e\n                displayError e\n            return\n          , (error) ->\n            console.log \"Could not fetch assignments; You are probably offline. Here's the error:\", error\n            snackbar \"Could not fetch your assignments\", \"Retry\", -> fetch(true)\n            return\n      else\n        send \"\/api\/start\", \"json\", headers, data, true\n          .then (resp) ->\n            console.debug \"Fetching assignments:\",resp.response.time\n            if resp.response.login\n              loginHeaders = resp.response.loginHeaders\n              document.getElementById(\"loginBackground\").style.display = \"block\"\n              document.getElementById(\"login\").classList.add \"active\"\n            else\n              console.log \"Fetching assignments successful\"\n              t = Date.now()\n              localStorage[\"lastUpdate\"] = t\n              document.getElementById(\"lastUpdate\").innerHTML = formatUpdate t\n\n              window.data = resp.response.data\n              viewData = resp.response.viewData\n              display()\n              localStorage[\"data\"] = JSON.stringify(data)\n            return\n          , (error) ->\n            console.log \"Could not fetch assignments; You are probably offline. Here's the error:\", error\n            snackbar \"Could not fetch your assignments\", \"Retry\", -> fetch(true)\n      return\n\nNow, we have the function that will log us into PCR.\n*val* is an optional argument that is an array of the username and password to log in with\n\n    dologin = (val, submitEvt=false) ->\n      document.getElementById(\"login\").classList.remove \"active\"\n      setTimeout ->\n        document.getElementById(\"loginBackground\").style.display = \"none\"\n      , 350\n      postArray = [] # Array of data to post\n      localStorage[\"username\"] = if val? and not submitEvt then val[0] else document.getElementById(\"username\").value\n      updateAvatar()\n      for h of loginHeaders # Loop through the input elements contained in the login page. As mentioned before, they will be sent to PCR to log in.\n        if h.toLowerCase().indexOf(\"user\") isnt -1\n          loginHeaders[h] = if val? and not submitEvt then val[0] else document.getElementById(\"username\").value\n        if h.toLowerCase().indexOf(\"pass\") isnt -1\n          loginHeaders[h] = if val? and not submitEvt then val[1] else document.getElementById(\"password\").value\n        postArray.push encodeURIComponent(h) + \"=\" + encodeURIComponent(loginHeaders[h])\n\n      # Now send the login request to PCR\n      if location.protocol is \"chrome-extension:\"\n        console.time \"Logging in\"\n        send loginURL, \"document\", { \"Content-type\": \"application\/x-www-form-urlencoded\" }, postArray.join(\"&\"), true\n          .then (resp) ->\n            console.timeEnd \"Logging in\"\n            if resp.responseURL.indexOf(\"Login\") isnt -1\n              # If PCR still wants us to log in, then the username or password entered were incorrect.\n              document.getElementById(\"loginIncorrect\").style.display = \"block\"\n              document.getElementById(\"password\").value = \"\"\n\n              document.getElementById(\"login\").classList.add \"active\"\n              document.getElementById(\"loginBackground\").style.display = \"block\"\n            else\n              # Otherwise, we are logged in\n              if document.getElementById(\"remember\").checked #Is the \"remember me\" checkbox checked?\n                setCookie \"userPass\", window.btoa(document.getElementById(\"username\").value + \":\" + document.getElementById(\"password\").value), 14 # Set a cookie with the username and password so we can log in automatically in the future without having to prompt for a username and password again\n              # loadingBar.style.display = \"none\"\n              t = Date.now()\n              localStorage[\"lastUpdate\"] = t\n              document.getElementById(\"lastUpdate\").innerHTML = formatUpdate t\n              try\n                parse resp.response # Parse the data PCR has replied with\n              catch e\n                console.log e\n                displayError e\n              return\n          , (error) ->\n            console.log \"Could not log in to PCR. Either your network connection was lost during your visit or PCR is just not working. Here's the error:\", error\n      else\n        send \"\/api\/login?remember=#{document.getElementById(\"remember\").checked}\", \"json\", { \"Content-type\": \"application\/x-www-form-urlencoded\" }, postArray.join(\"&\"), true\n          .then (resp) ->\n            console.debug \"Logging in:\",resp.response.time\n            if resp.response.login\n              # If PCR still wants us to log in, then the username or password entered were incorrect.\n              document.getElementById(\"loginIncorrect\").style.display = \"block\"\n              document.getElementById(\"password\").value = \"\"\n\n              document.getElementById(\"login\").classList.add \"active\"\n              document.getElementById(\"loginBackground\").style.display = \"block\"\n            else\n              t = Date.now()\n              localStorage[\"lastUpdate\"] = t\n              document.getElementById(\"lastUpdate\").innerHTML = formatUpdate t\n\n              window.data = resp.response.data\n              display()\n              localStorage[\"data\"] = JSON.stringify(data)\n            return\n          , (error) ->\n            console.log \"Could not log in to PCR. Either your network connection was lost during your visit or PCR is just not working. Here's the error:\", error\n      return\n\n    document.getElementById(\"login\").addEventListener \"submit\", (evt) ->\n      evt.preventDefault()\n      dologin(null, true)\n\n<a name=\"parsing\"\/>\nParsing\n-------\n\nBelow are now functions used to parse your assignments.\n\nIn PCR's interface, you can click a date in month or week view to see it in day view.\nTherefore, the HTML element that shows the date that you can click on has a hyperlink that looks like `#2015-04-26`.\nThe function below will parse that String and return a **Date**.\n\n    parseDateHash = (element) ->\n      dateSplit = element.hash.substring(1).split(\"-\")\n      (new Date +dateSplit[0], +dateSplit[1] - 1, +dateSplit[2]).getTime()\n\nThe *attachmentify* function parses the body of an assignment (*text*) and returns the assignment's attachments.\n\n    attachmentify = (element) ->\n      attachments = []\n\n      # Get all links\n      as = element.getElementsByTagName('a')\n\n      a = 0\n      while a < as.length\n        if as[a].id.indexOf('Attachment') isnt -1\n          attachments.push [\n            as[a].innerHTML\n            as[a].search + as[a].hash\n          ]\n          as[a].remove()\n          a-- # subtract because all elements have shifted down\n        a++\n      attachments\n\nThis function replaces text that represents a hyperlink with a functional hyperlink by using javascript's replace function with a regular expression if the text already isn't part of a hyperlink.\n\n    urlify = (text) ->\n      text.replace \/\/\/ (\n        https?:\\\/\\\/                  # http:\/\/ or https:\/\/\n        [-A-Z0-9+&@#\\\/%?=~_|!:,.;]*  # Any number of url-OK characters\n        [-A-Z0-9+&@#\\\/%=~_|]+        # At least one url-OK character except ?, !, :, ,, ., and ;\n      )\/\/\/ig, (str, str2, offset) -> # Function to replace matches\n        if \/href\\s*=\\s*.\/.test(text.substring(offset - 10, offset)) or\n          \/originalpath\\s*=\\s*.\/.test(text.substring(offset - 20, offset))\n          then str else '<a href=\"' + str + '\">' + str + '<\/a>'\n\nAlso, PCR\"s interface uses a system of IDs to identify different elements. For example, the ID of one of the boxes showing the name of an assignment could be `ctl00_ctl00_baseContent_baseContent_flashTop_ctl00_RadScheduler1_95_0`.\nThe function below will return the first HTML element whose ID contains a specified String (*id*) and containing a specified tag (*tag*).\n\n    findId = (element, tag, id) ->\n      for e in element.getElementsByTagName(tag)\n        if e.id.indexOf(id) isnt -1\n          return e\n      return\n\nNow, we get to the code intensive functions.\nThe function below will parse the data given by PCR and convert it into an object.\nIf you open up the developer console on CheckPCR and type in `data`, you can see the array containing all of your assignments.\n\n    parse = (doc) ->\n      console.time \"Handling data\" # To time how long it takes to parse the assignments\n      handledDataShort = [] # Array used to make sure we don\"t parse the same assignment twice.\n      window.data = {classes: [], assignments: [], monthView: doc.querySelector(\".rsHeaderMonth\").parentNode.classList.contains(\"rsSelected\")} # Reset the array in which all of your assignments are stored in.\n\n      for e in doc.querySelectorAll(\"input:not([type=\\\"submit\\\"])\")\n        viewData[e.name] = e.value or \"\"\n\n      # Now, the classes you take are parsed (these are the checkboxes you see up top when looking at PCR).\n\n      classes = findId(doc, \"table\", \"cbClasses\").getElementsByTagName(\"label\")\n      for c in classes\n        window.data.classes.push c.innerHTML\n\n      assignments = doc.getElementsByClassName(\"rsApt rsAptSimple\")\n\n      # Now parse the assignments\n\n      for ca in assignments\n        assignment = {}\n\n        # The starting date and ending date of the assignment are parsed first\n        range = findId(ca, \"span\", \"StartingOn\").innerHTML.split(\" - \")\n        assignment.start = Math.floor (Date.parse range[0])\/1000\/3600\/24\n        assignment.end = if range[1]? then Math.floor (Date.parse range[1])\/1000\/3600\/24 else assignment.start\n\n        # Then, the name of the assignment is parsed\n        t = findId(ca, \"span\", \"lblTitle\")\n        title = t.innerHTML\n\n        # The actual body of the assignment and its attachments are parsed next\n        b = t.parentNode.parentNode\n        divs = b.getElementsByTagName(\"div\")\n        for d in [0...2]\n          divs[0].remove()\n        ap = attachmentify(b) # Separates attachments from the body\n        assignment.attachments = ap\n        assignment.body = urlify(b.innerHTML).replace(\/^(?:\\s*<br\\s*\\\/?>)*\/, \"\").replace(\/(?:\\s*<br\\s*\\\/?>)*\\s*$\/, \"\").trim() # The replaces remove leading and trailing newlines\n\n        # Finally, we separate the class name and type (homework, classwork, or projects) from the title of the assignment\n        matchedTitle = title.match(\/\\(([^)]*\\)*)\\)$\/)\n        if not matchedTitle?\n          throw new Error(\"Could not parse assignment title \\\"#{title}\\\"\")\n        assignment.type = matchedTitle[1].toLowerCase().replace(\"& quizzes\", \"\").replace(\"tests\", \"test\")\n        assignment.baseType = (ca.title.substring 0, ca.title.indexOf \"\\n\").toLowerCase().replace(\"& quizzes\", \"\").replace(\/\\s\/g, \"\")\n        for c, pos in window.data.classes\n          if title.indexOf(c) isnt -1\n            assignment.class = pos\n            title = title.replace(c,\"\")\n            break\n        assignment.title = title.substring(title.indexOf(\": \") + 2).replace(\/\\([^\\(\\)]*\\)$\/,\"\").trim()\n\n        # To make sure there are no repeats, the title of the assignment (only letters) and its start & end date are combined to give it a unique identifier.\n        assignment.id = assignment.title.replace(\/[^\\w]*\/g, \"\") + (assignment.start + assignment.end)\n        if handledDataShort.indexOf(assignment.id) is -1 # Make sure we haven't already parsed the assignment\n          handledDataShort.push assignment.id\n          window.data.assignments.push assignment\n\n      console.timeEnd \"Handling data\"\n\n      # Now allow the view to be switched\n      document.body.classList.add \"loaded\"\n\n      display() # Display the data\n      localStorage[\"data\"] = JSON.stringify(data) # Store for offline use\n      return\n\nThe view switching button needs an event handler.\n\n    document.getElementById(\"switchViews\").addEventListener \"click\", ->\n      if Object.keys(viewData).length > 0\n        document.getElementById(\"sideBackground\").click()\n        viewData[\"__EVENTTARGET\"] = \"ctl00$ctl00$baseContent$baseContent$flashTop$ctl00$RadScheduler1\"\n        viewData[\"__EVENTARGUMENT\"] = JSON.stringify {Command: \"SwitchTo#{if document.body.getAttribute(\"data-pcrview\") is \"month\" then \"Week\" else \"Month\"}View\"}\n        viewData[\"ctl00_ctl00_baseContent_baseContent_flashTop_ctl00_RadScheduler1_ClientState\"] = JSON.stringify {scrollTop:0,scrollLeft:0,isDirty:false}\n        viewData[\"ctl00_ctl00_RadScriptManager1_TSM\"] = \";;System.Web.Extensions, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35:en-US:d28568d3-e53e-4706-928f-3765912b66ca:ea597d4b:b25378d2\"\n        postArray = [] # Array of data to post\n        for h,v of viewData\n          postArray.push encodeURIComponent(h) + \"=\" + encodeURIComponent(v)\n        fetch true, postArray.join(\"&\")\n\nThe same goes for the log out button.\n\n    document.getElementById(\"logout\").addEventListener \"click\", ->\n      if Object.keys(viewData).length > 0\n        deleteCookie \"userPass\"\n        document.getElementById(\"sideBackground\").click()\n        viewData[\"__EVENTTARGET\"] = \"ctl00$ctl00$baseContent$LogoutControl1$LoginStatus1$ctl00\"\n        viewData[\"__EVENTARGUMENT\"] = \"\"\n        viewData[\"ctl00_ctl00_baseContent_baseContent_flashTop_ctl00_RadScheduler1_ClientState\"] = JSON.stringify {scrollTop:0,scrollLeft:0,isDirty:false}\n        postArray = [] # Array of data to post\n        for h,v of viewData\n          postArray.push encodeURIComponent(h) + \"=\" + encodeURIComponent(v)\n        fetch true, postArray.join(\"&\")\n\n<a name=\"displaying\"\/>\nDisplaying the assignments\n--------------------------\n\nThis is a little helper function to simplify the creation of HTML elements\n\n    element = (tag, cls, html, id) ->\n      e = document.createElement tag\n      if typeof cls is \"string\"\n        e.classList.add cls\n      else\n        for c in cls\n          e.classList.add c\n      if html?\n        e.innerHTML = html\n      if id?\n        e.setAttribute \"id\", id\n      e\n\nAnother function that will return a human-readable date string\n\n    dateString = (date, addThis=false) ->\n      return date if date is \"Forever\"\n      relative = [\"Tomorrow\", \"Today\", \"Yesterday\", \"2 days ago\"]\n      today = new Date()\n      today.setDate(today.getDate()+1)\n      for r in relative\n        if date.getDate() is today.getDate() and date.getMonth() is today.getMonth() and date.getFullYear() is today.getFullYear()\n          return r\n        today.setDate(today.getDate()-1)\n      today = new Date()\n      # If the date is within 6 days of today, only display the day of the week\n      if 0<(date.getTime()-today.getTime())\/1000\/3600\/24<=6\n        return (if addThis then \"This \" else \"\")+weekdays[date.getDay()]\n      \"#{weekdays[date.getDay()]}, #{fullMonths[date.getMonth()]} #{date.getDate()}\"\n\nThis function separates the parts of a class name.\n\n    separate = (cl) ->\n      cl.match \/\/\/ (\n        (?:\\d*\\s+)?                           # digits and a space(s) if they exist [the grade level for the class]\n        (?:(?:hon\\w*|(?:adv\\w*\\s*)?core)\\s+)? # matches the honors, advanced core, or core if that exists\n      )\n      (.*)                                    # the actual class name (English, Science, Math, etc.)\n      \/\/\/i\n\nThe one below scrolls smoothly to a y position.\n\n    smoothScroll = (to) ->\n      return new Promise (resolve, reject) ->\n        start = null\n        from = document.body.scrollTop\n        amount = to-from\n        step = (timestamp) ->\n          start ?= timestamp\n          progress = timestamp-start\n          window.scrollTo 0, from+amount*(progress\/350)\n          if progress < 350\n            requestAnimationFrame step\n          else\n            setTimeout ->\n              document.querySelector(\"nav\").classList.remove \"headroom--unpinned\"\n            , 1\n            setTimeout ->\n              resolve()\n            , amount\n        requestAnimationFrame step\n\nIn order to display an assignment in the correct X position, classes with names eX and eX are used, where X is the number of squares to from the assignment to the left\/right side of the screen.\nThe function below determines which eX and sX class the given element has.\n\n    getES = (element) ->\n      e = 0\n      s = 0\n      for x in [0...7]\n        if element.classList.contains(\"e\"+x)\n          e = x\n        if element.classList.contains(\"s\"+x)\n          s = x\n      return [\"e\"+e, \"s\"+s]\n\nNow the functions that actually display something are defined. First up is one to add an activity line to the activity panel.\n\n    addActivity = (type, assignment, newActivity, className=window.data.classes[assignment.class]) ->\n      className ?= \"Unknown class\"\n      insertTo=document.getElementById(\"infoActivity\")\n      date = if newActivity is true then Date.now() else newActivity\n      if newActivity is true then activity.push [type, assignment, Date.now(), className]\n      te = element \"div\", [\"activity\", \"assignmentItem\", assignment.baseType, type], \"<i class='material-icons'>#{type}<\/i><span class='title'>#{assignment.title}<\/span><small>#{separate(className)[2]}<\/small><div class='range'>#{dateString(new Date date)}<\/div>\", \"activity\"+assignment.id\n      te.setAttribute \"data-class\", className\n      id = assignment.id\n      if type isnt \"delete\"\n        do(id) ->\n          te.addEventListener \"click\", ->\n            doScrolling = ->\n              el = document.querySelector(\".assignment[id*=\\\"#{id}\\\"]\")\n              smoothScroll el.getBoundingClientRect().top+document.body.scrollTop-116\n                .then ->\n                  el.click()\n                  return\n            if document.body.getAttribute(\"data-view\") is \"0\"\n              doScrolling()\n            else\n              document.querySelector(\"#navTabs>li:first-child\").click()\n              setTimeout doScrolling, 500\n\n      if assignment.id in done.array\n        te.classList.add \"done\"\n      insertTo.insertBefore te, insertTo.querySelector(\".activity\")\n\nThis function will convert the array of assignments generated by *parse* into readable HTML.\n\n    display = (doScroll=true) ->\n      console.time \"Displaying data\"\n      document.body.setAttribute \"data-pcrview\", if window.data.monthView then \"month\" else \"other\"\n      main = document.querySelector \"main\"\n      taken = {}\n      timeafter = {\n        day: 24*3600*1000\n        ms: [24, 15+35\/60, 15+35\/60, 15+15\/60, 15+15\/60, 15+15\/60, 24][(new Date()).getDay()]\n        us: 15*3600*1000\n      }[localStorage[\"hideassignments\"]] or 24*3600*1000\n\n      today = Math.floor (Date.now()-tzoff)\/1000\/3600\/24\n\n      if window.data.monthView\n        start = Math.min (assignment.start for assignment in window.data.assignments)... # Smallest date\n        end = Math.max (assignment.end for assignment in window.data.assignments)... # Largest date\n\n        year = (new Date()).getFullYear() # For future calculations\n\n        # Calculate what month we will be displaying by finding the month of today\n        month = (new Date()).getMonth()\n\n        # Make sure the start and end dates lie within the month\n        start = new Date Math.max fromDateNum(start), (new Date year, month).getTime()\n        end = new Date Math.min fromDateNum(end), (new Date year, month+1, 0).getTime() # If the day argument for Date is 0, then the resulting date will be of the previous month\n      else\n        todaySE = new Date()\n        start = new Date todaySE.getFullYear(), todaySE.getMonth(), todaySE.getDate()\n        end = new Date todaySE.getFullYear(), todaySE.getMonth(), todaySE.getDate()\n\n      # Set the start date to be a Sunday and the end date to be a Saturday\n      start.setDate start.getDate()-start.getDay()\n      end.setDate end.getDate()+(6-end.getDay())\n\n      # First populate the calendar with boxes for each day\n      d = new Date start\n      wk = null\n      lastData = localStorageRead \"data\"\n      while d <= end\n        if d.getDay() is 0\n          id = \"wk#{d.getMonth()}-#{d.getDate()}\" # Don't create a new week element if one already exists\n          if not (document.getElementById id)?\n            wk = element \"section\", \"week\", null, \"wk#{d.getMonth()}-#{d.getDate()}\"\n\n            dayTable = element \"table\", \"dayTable\"\n            tr = dayTable.insertRow()\n            tr.insertCell() for day in [0...7]\n            wk.appendChild dayTable\n\n            main.appendChild wk\n\n          else\n            wk = document.getElementById id\n\n        if wk.getElementsByClassName(\"day\").length <= d.getDay()\n          day = element \"div\", \"day\", null, \"day\"\n          day.setAttribute \"data-date\", d.getTime()\n          if Math.floor((d.getTime()-d.getTimezoneOffset())\/1000\/3600\/24) is today\n            day.classList.add \"today\"\n\n          month = element \"span\", \"month\", months[d.getMonth()]\n          day.appendChild month\n\n          date = element \"span\", \"date\", d.getDate()\n          day.appendChild date\n\n          wk.appendChild day\n\n        taken[d] = []\n        d.setDate d.getDate()+1\n\n      # Split assignments taking more than 1 week\n      split = []\n      for assignment, num in window.data.assignments\n        if localStorageRead(\"assignmentSpan\") == \"multiple\"\n          s = Math.max start.getTime(), fromDateNum assignment.start\n          e = Math.min end.getTime(), fromDateNum assignment.end\n          span = (e-s)\/1000\/3600\/24+1 # Number of days assignment takes up\n          spanRelative = 6-(new Date s).getDay() # Number of days until the next Saturday\n\n          ns = new Date s\n          ns.setDate ns.getDate()+spanRelative #e\/1000\/3600\/24-spanRelative # The date of the next Saturday\n\n          n = -6\n          while n <span-spanRelative\n            lastSun = new Date ns\n            lastSun.setDate lastSun.getDate()+n\n\n            nextSat = new Date lastSun\n            nextSat.setDate nextSat.getDate()+6\n            split.push\n              assignment: num\n              start: new Date Math.max s, lastSun.getTime()\n              end: new Date Math.min e, nextSat.getTime()\n            n+=7\n        else if localStorageRead(\"assignmentSpan\") == \"start\"\n          s = fromDateNum assignment.start\n          if s >= start.getTime()\n            split.push\n              assignment: num\n              start: new Date s\n              end: new Date s\n        else if localStorageRead(\"assignmentSpan\") == \"end\"\n          e = fromDateNum assignment.end\n          if e <= end.getTime()\n            split.push\n              assignment: num\n              start: new Date e\n              end: new Date e\n\n        # Activity stuff\n        if lastData?\n          found = false\n          for oldAssignment, num in lastData.assignments\n            if oldAssignment.id is assignment.id\n              found = true\n              if oldAssignment.body isnt assignment.body\n                addActivity \"edit\", oldAssignment, true, lastData.classes[oldAssignment.class]\n                delete modified[assignment.id] #If the assignment is modified, reset it\n              lastData.assignments.splice(num, 1)\n              break\n          if not found\n            addActivity \"add\", assignment, true\n      if lastData?\n        # Check if any of the last assignments weren't deleted (so they have been deleted in PCR)\n        for assignment in lastData.assignments\n          addActivity \"delete\", assignment, true, lastData.classes[assignment.class]\n          if done.indexOf(assignment.id) >= 0\n            done.splice done.indexOf(assignment.id), 1\n          delete modified[assignment.id]\n\n        # Then save activity\n        localStorage[\"activity\"] = JSON.stringify activity.slice activity.length-128, activity.length # save a maximum of 128 activity items\n\n        # And completed assignments + modifications\n        done.save()\n        localStorage[\"modified\"] = JSON.stringify modified\n\n      # Add custom assignments to the split array\n      for custom in extra\n        cls = null\n        if custom.class?\n          for c,n in data.classes\n            if c.toLowerCase().indexOf(custom.class) isnt -1\n              cls = n\n              break\n\n        # Same logic as above\n        taskAssignment =\n          title: \"Task\"\n          baseType: \"task\"\n          attachments: []\n          start: custom.start\n          end: custom.end or \"Forever\"\n          body: custom.body\n          id: \"task#{custom.body.replace(\/[^\\w]*\/g, \"\")}#{custom.start}#{custom.end}#{custom.class}\"\n          class: cls\n\n        if localStorageRead(\"assignmentSpan\") == \"multiple\"\n          s = Math.max start.getTime(), fromDateNum custom.start\n          e = Math.min end.getTime(), fromDateNum if custom.end? then custom.end else custom.start\n          span = (e-s)\/1000\/3600\/24+1 # Number of days assignment takes up\n          spanRelative = 6-(new Date s).getDay() # Number of days until the next Saturday\n\n          ns = new Date s\n          ns.setDate ns.getDate()+spanRelative #e\/1000\/3600\/24-spanRelative # The date of the next Saturday\n\n          n = -6\n          while n <span-spanRelative\n            lastSun = new Date ns\n            lastSun.setDate lastSun.getDate()+n\n\n            nextSat = new Date lastSun\n            nextSat.setDate nextSat.getDate()+6\n            split.push\n              start: new Date Math.max s, lastSun.getTime()\n              end: new Date Math.min e, nextSat.getTime()\n              custom: true\n              assignment: taskAssignment\n              reference: custom\n            n+=7\n        else if localStorageRead(\"assignmentSpan\") == \"start\"\n          s = fromDateNum custom.start\n          if s >= start.getTime()\n            split.push\n              start: new Date s\n              end: new Date s\n              custom: true\n              assignment: taskAssignment\n              reference: custom\n        else if localStorageRead(\"assignmentSpan\") == \"end\"\n          e = fromDateNum custom.end\n          if e <= end.getTime()\n            split.push\n              start: new Date e\n              end: new Date e\n              custom: true\n              assignment: taskAssignment\n              reference: custom\n\n      # Calculate the today's week id\n      tdst = new Date()\n      tdst.setDate tdst.getDate() - tdst.getDay()\n      todayWkId = \"wk#{tdst.getMonth()}-#{tdst.getDate()}\"\n\n      # Then add assignments\n      weekHeights = {}\n      previousAssignments = {}\n      for assignment in document.getElementsByClassName \"assignment\"\n        previousAssignments[assignment.getAttribute(\"id\")] = assignment\n\n      separateTaskClass = JSON.parse localStorage[\"sepTaskClass\"]\n      for s in split\n        assignment = if s.custom then s.assignment else window.data.assignments[s.assignment]\n        reference = s.reference\n\n        # Separate the class description from the actual class\n        separated = separate if assignment.class? then window.data.classes[assignment.class] else \"Task\"\n\n        startSun = new Date(s.start.getTime())\n        startSun.setDate startSun.getDate()-startSun.getDay()\n        weekId = \"wk#{startSun.getMonth()}-#{startSun.getDate()}\"\n\n        smallTag = \"small\"\n        link = null\n        if athenaData? and athenaData[window.data.classes[assignment.class]]?\n          link = athenaData[window.data.classes[assignment.class]].link\n          smallTag = \"a\"\n\n        e = element \"div\", [\"assignment\", assignment.baseType, \"anim\"], \"<#{smallTag}#{if link? then \" href='#{link}' class='linked' target='_blank'\" else \"\"}><span class='extra'>#{separated[1]}<\/span>#{separated[2]}<\/#{smallTag}><span class='title'>#{assignment.title}<\/span><input type='hidden' class='due' value='#{if isNaN(assignment.end) then 0 else assignment.end}' \/>\", assignment.id+weekId\n        if (reference? and reference.done) or assignment.id in done.array\n          e.classList.add \"done\"\n        e.setAttribute \"data-class\", if s.custom and separateTaskClass then \"Task\" else window.data.classes[assignment.class]\n        close = element \"a\", [\"close\", \"material-icons\"], \"close\"\n        close.addEventListener \"click\", closeOpened\n        e.appendChild close\n\n        if link?\n          e.querySelector(\"a\").addEventListener \"click\", (evt) ->\n            el = evt.target\n            until el.classList.contains \"assignment\"\n              el = el.parentNode\n            if not (document.body.getAttribute(\"data-view\") isnt \"0\" or el.classList.contains \"full\")\n              evt.preventDefault()\n\n        complete = element \"a\", [\"complete\", \"material-icons\", \"waves\"], \"done\"\n        ripple complete\n        id = assignment.id\n        do (id, reference) ->\n          complete.addEventListener \"mouseup\", (evt) ->\n            if evt.which == 1 # Left button\n              el = this.parentNode\n              added = true\n              if reference? # Task item\n                if el.classList.contains \"done\"\n                  reference.done = false\n                else\n                  added = false\n                  reference.done = true\n                localStorage[\"extra\"] = JSON.stringify extra\n              else\n                if el.classList.contains \"done\"\n                  done.splice done.indexOf(id), 1\n                else\n                  added = false\n                  done.push id\n                done.save()\n              if document.body.getAttribute(\"data-view\") == \"1\"\n                setTimeout ->\n                  for elem in document.querySelectorAll \".assignment[id^=\\\"#{id}\\\"], #test#{id}, #activity#{id}, #ia#{id}\"\n                    elem.classList.toggle \"done\"\n                  if added\n                    document.body.classList.remove \"noList\" if document.querySelectorAll(\".assignment.listDisp:not(.done)\").length != 0\n                  else\n                    document.body.classList.add \"noList\" if document.querySelectorAll(\".assignment.listDisp:not(.done)\").length == 0\n                  resize()\n                , 100\n              else\n                for elem in document.querySelectorAll \".assignment[id^=\\\"#{id}\\\"], #test#{id}, #activity#{id}, #ia#{id}\"\n                  elem.classList.toggle \"done\"\n                if added\n                  document.body.classList.remove \"noList\" if document.querySelectorAll(\".assignment.listDisp:not(.done)\").length != 0\n                else\n                  document.body.classList.add \"noList\" if document.querySelectorAll(\".assignment.listDisp:not(.done)\").length == 0\n            return\n        e.appendChild complete\n\n        # If the assignment is a custom one, add a button to delete it\n        if s.custom\n          deleteA = element \"a\", [\"material-icons\", \"deleteAssignment\", \"waves\"], \"delete\"\n          do (reference, e) ->\n            ripple deleteA\n            deleteA.addEventListener \"mouseup\", (evt) ->\n              if evt.which == 1\n                extra.splice(extra.indexOf(reference), 1)\n                localStorage[\"extra\"] = JSON.stringify extra\n                if document.querySelector(\".full\")?\n                  document.body.style.overflow = \"auto\"\n                  back = document.getElementById(\"background\")\n                  back.classList.remove \"active\"\n                  setTimeout ->\n                    back.style.display = \"none\"\n                  , 350\n                e.remove()\n                display(false)\n          e.appendChild deleteA\n\n        # Modification button\n        edit = element \"a\", [\"editAssignment\", \"material-icons\", \"waves\"], \"edit\"\n        do (id) ->\n          edit.addEventListener \"mouseup\", (evt) ->\n            if evt.which == 1\n              el = evt.target\n              until el.classList.contains \"editAssignment\"\n                el = el.parentNode\n              remove = el.classList.contains \"active\"\n              el.classList.toggle \"active\"\n              el.parentNode.querySelector(\".body\").setAttribute \"contentEditable\", if remove then \"false\" else \"true\"\n              if not remove\n                el.parentNode.querySelector(\".body\").focus()\n              dn = el.parentNode.querySelector \".complete\"\n              dn.style.display = if remove then \"block\" else \"none\"\n            return\n        ripple edit\n\n        e.appendChild edit\n\n        start = new Date fromDateNum assignment.start\n        end = if isNaN assignment.end then assignment.end else new Date fromDateNum assignment.end\n        times = element \"div\", \"range\", if assignment.start is assignment.end then dateString(start) else \"#{dateString(start)} &ndash; #{dateString(end)}\"\n        e.appendChild times\n        if assignment.attachments.length > 0\n          attachments = element \"div\", \"attachments\"\n          for attachment in assignment.attachments\n            do (attachment) ->\n              a = element \"a\", [], attachment[0]\n              a.href = if location.protocol is \"chrome-extension:\" then \"https:\/\/webappsca.pcrsoft.com\/Clue\/Common\/AttachmentRender.aspx#{attachment[1]}\" else \"\/api\/attachment#{attachment[1]}\"\n              req = new XMLHttpRequest()\n              req.open \"HEAD\", a.href\n              req.onload = ->\n                if req.status == 200\n                  type = req.getResponseHeader \"Content-Type\"\n                  if mimeTypes[type]?\n                    a.classList.add mimeTypes[type][1]\n                    span = element \"span\", [], mimeTypes[type][0]\n                  else\n                    span = element \"span\", [], \"Unknown file type\"\n                  a.appendChild span\n                return\n              req.send()\n              attachments.appendChild a\n              return\n          e.appendChild attachments\n\n        body = element \"div\", \"body\", assignment.body.replace(\/font-family:[^;]*?(?:Times New Roman|serif)[^;]*\/g, \"\")\n        edits = element \"div\", \"edits\", \"<span class='additions'><\/span><span class='deletions'><\/span>\"\n        if (m=modified[assignment.id])?\n          d = dmp.diff_main assignment.body, m\n          dmp.diff_cleanupSemantic d\n          if d.length isnt 0 # Has been edited\n            added = 0\n            deleted = 0\n            for diff in d\n              if diff[0] is 1 then added++\n              if diff[0] is -1 then deleted++\n            edits.querySelector(\".additions\").innerHTML = if added != 0 then \"+#{added}\" else \"\"\n            edits.querySelector(\".deletions\").innerHTML = if deleted != 0 then \"-#{deleted}\" else \"\"\n            edits.classList.add \"notEmpty\"\n            body.innerHTML = m\n        ((b, ad, di, ed, id, ref) ->\n          body.addEventListener \"input\", (evt) ->\n            if ref?\n              ref.body = evt.target.innerHTML\n              localStorage[\"extra\"] = JSON.stringify extra\n            else\n              modified[id] = evt.target.innerHTML\n              localStorage[\"modified\"] = JSON.stringify modified\n              d = dmp.diff_main b, evt.target.innerHTML\n              dmp.diff_cleanupSemantic d\n              additions = 0\n              deletions = 0\n              for diff in d\n                if diff[0] is 1 then additions++\n                if diff[0] is -1 then deletions++\n              ad.innerHTML = if additions != 0 then \"+#{additions}\" else \"\"\n              di.innerHTML = if deletions != 0 then \"-#{deletions}\" else \"\"\n              if additions != 0 or deletions != 0\n                ed.classList.add \"notEmpty\"\n              else\n                ed.classList.remove \"notEmpty\"\n            if document.body.getAttribute(\"data-view\") is \"1\" then resize()\n        )(assignment.body, edits.querySelector(\".additions\"), edits.querySelector(\".deletions\"), edits, assignment.id, reference)\n        e.appendChild body\n\n        restore = element \"a\", [\"material-icons\", \"restore\"], \"settings_backup_restore\"\n        ((b, bd, ed, id) ->\n          restore.addEventListener \"click\", ->\n            delete modified[id]\n            localStorage[\"modified\"] = JSON.stringify modified\n            bd.innerHTML = b\n            ed.classList.remove \"notEmpty\"\n            if document.body.getAttribute(\"data-view\") is \"1\" then resize()\n        )(assignment.body, body, edits, assignment.id)\n        edits.appendChild restore\n        e.appendChild edits\n\n        mods = element \"div\", [\"mods\"]\n        for a in activity.slice activity.length-32, activity.length\n          if a[0] is \"edit\" and a[1].id is assignment.id\n            d = dmp.diff_main a[1].body, assignment.body\n            dmp.diff_cleanupSemantic d\n            added = 0\n            deleted = 0\n            for diff in d\n              if diff[0] is 1 then added++\n              if diff[0] is -1 then deleted++\n            te = element \"div\", [\"innerActivity\", \"assignmentItem\", assignment.baseType], \"<i class='material-icons'>edit<\/i><span class='title'>#{dateString(new Date a[2])}<\/span><span class='additions'>#{if added != 0 then \"+\"+added else \"\"}<\/span><span class='deletions'>#{if deleted != 0 then \"-\"+deleted else \"\"}<\/span>\", \"ia\"+assignment.id\n            te.setAttribute \"data-class\", window.data.classes[assignment.class]\n            te.appendChild element \"div\", \"iaDiff\", dmp.diff_prettyHtml d\n            te.addEventListener \"click\", ->\n              this.classList.toggle \"active\";\n              resize() if document.body.getAttribute(\"data-view\") is \"1\"\n            mods.appendChild te\n        e.appendChild mods\n\n        if localStorageRead(\"assignmentSpan\") == \"multiple\" and start < s.start\n          e.classList.add \"fromWeekend\"\n        if localStorageRead(\"assignmentSpan\") == \"multiple\" and end > s.end\n          e.classList.add \"overWeekend\"\n        e.classList.add \"s#{s.start.getDay()}\"\n        e.classList.add if isNaN(s.end) then \"e#{6-s.start.getDay()}\" else \"e#{6-s.end.getDay()}\"\n\n        st = Math.floor(s.start\/1000\/3600\/24)\n        if s.assignment.end is \"Forever\"\n          if st <= today+listDateOffset\n            e.classList.add \"listDisp\"\n        else\n          midDate = new Date()\n          midDate.setDate midDate.getDate()+listDateOffset\n          if (st-(if assignment.baseType is \"test\" and assignment.start is st then JSON.parse(localStorage[\"earlyTest\"]) else 0))*1000*3600*24+tzoff <= midDate.getTime() <= s.end.getTime()+(if listDateOffset is 0 then timeafter else 24*3600*1000)\n            e.classList.add \"listDisp\"\n\n        # Calculate how many assignments are placed before the current one\n        if not s.custom or not JSON.parse localStorage[\"sepTasks\"]\n          pos = 0\n          loop\n            found = true\n            d = new Date s.start\n            while d <= s.end\n              if taken[d].indexOf(pos) isnt -1\n                found = false\n              d.setDate d.getDate()+1\n            break if found\n            pos++\n\n          # Append the position the assignment is at to the taken array\n          d = new Date s.start\n          while d <= s.end\n            taken[d].push pos\n            d.setDate d.getDate()+1\n\n          # Calculate how far down the assignment must be placed as to not block the ones above it\n          e.style.marginTop = pos*30+\"px\"\n\n        # Add click interactivity\n        if not s.custom or not JSON.parse localStorage[\"sepTasks\"] then e.addEventListener \"click\", (evt) ->\n          el = evt.target\n          until el.classList.contains \"assignment\"\n            el = el.parentNode\n          if document.getElementsByClassName(\"full\").length == 0 and document.body.getAttribute(\"data-view\") == \"0\"\n            el.classList.remove \"anim\"\n            el.classList.add \"modify\"\n            el.style.top = el.getBoundingClientRect().top-document.body.scrollTop-parseInt(el.style.marginTop)+44+\"px\"\n            el.setAttribute \"data-top\", el.style.top\n            document.body.style.overflow = \"hidden\"\n            back = document.getElementById(\"background\")\n            back.classList.add \"active\"\n            back.style.display = \"block\"\n            el.classList.add \"anim\"\n            setTimeout ->\n              el.classList.add \"full\"\n              el.style.top = 75-parseInt(el.style.marginTop)+\"px\"\n              setTimeout ->\n                el.classList.remove \"anim\"\n              , 350\n            , 0\n          return\n\n        # Append the assignment to the correct week element and set its height to contain the assignments in it\n        wk = document.getElementById weekId\n        if not wk? then continue # Don't add the assignment if the week doesn't exist\n\n        # If the assignment is a test and is upcoming, add it to the upcoming tests panel.\n        if (assignment.baseType is \"test\" or (localStorageRead(\"projectsInTestPane\") and assignment.baseType is \"longterm\")) and assignment.end >= today\n          te = element \"div\", [\"upcomingTest\", \"assignmentItem\", assignment.baseType], \"<i class='material-icons'>#{if assignment.baseType is \"longterm\" then \"assignment\" else \"assessment\"}<\/i><span class='title'>#{assignment.title}<\/span><small>#{separated[2]}<\/small><div class='range'>#{dateString(end, true)}<\/div>\", \"test\"+assignment.id\n          te.setAttribute \"data-class\", window.data.classes[assignment.class]\n          id = assignment.id\n          do(id) ->\n            te.addEventListener \"click\", ->\n              doScrolling = ->\n                el = document.querySelector(\".assignment[id*=\\\"#{id}\\\"]\")\n                smoothScroll el.getBoundingClientRect().top+document.body.scrollTop-116\n                  .then ->\n                    el.click()\n                    return\n              if document.body.getAttribute(\"data-view\") is \"0\"\n                doScrolling()\n              else\n                document.querySelector(\"#navTabs>li:first-child\").click()\n                setTimeout doScrolling, 500\n\n          if assignment.id in done.array\n            te.classList.add \"done\"\n          if document.getElementById(\"test\"+assignment.id)?\n            document.getElementById(\"test\"+assignment.id).innerHTML = te.innerHTML\n          else\n            document.getElementById(\"infoTests\").appendChild te\n\n        if not weekHeights[weekId]? or pos > weekHeights[weekId]\n          weekHeights[weekId] = pos\n          wk.style.height = 47+(pos+1)*30+\"px\"\n        already = document.getElementById assignment.id+weekId\n        if already? # Assignment already exists\n          already.style.marginTop = e.style.marginTop\n          already.setAttribute \"data-class\", if s.custom and separateTaskClass then \"Task\" else window.data.classes[assignment.class]\n          if not modified[assignment.id]?\n            already.getElementsByClassName(\"body\")[0].innerHTML = e.getElementsByClassName(\"body\")[0].innerHTML\n          already.querySelector(\".edits\").className = e.querySelector(\".edits\").className\n          if already.classList.toggle? then already.classList.toggle \"listDisp\", e.classList.contains \"listDisp\"\n          already.classList.remove(cl) for cl in getES(already)\n          already.classList.add(cl) for cl in getES(e)\n          for cl in [\"fromWeekend\", \"overWeekend\"]\n            already.classList.remove(cl)\n            if e.classList.contains(cl) then already.classList.add(cl)\n        else\n          if s.custom and JSON.parse localStorage[\"sepTasks\"]\n            if assignment.start is st and assignment.end >= today\n              e.classList.remove \"assignment\"\n              e.classList.add \"taskPaneItem\"\n              e.style.order = assignment.end\n              if (link=e.querySelector(\".linked\"))?\n                e.insertBefore element(\"small\", [], link.innerHTML), link\n                link.remove()\n              document.getElementById(\"infoTasksInner\").appendChild e\n          else wk.appendChild e\n        delete previousAssignments[assignment.id+weekId]\n\n      # Delete any assignments that have been deleted since updating\n      for name, assignment of previousAssignments\n        if assignment.classList.contains \"full\"\n          document.getElementById(\"background\").classList.remove \"active\"\n        assignment.remove()\n\n      # Scroll to the correct position in calendar view\n      if weekHeights[todayWkId]?\n        h = 0\n        sw = (wkid) -> parseInt(x) for x in wkid.substring(2).split(\"-\")\n        todayWk = sw todayWkId\n        for wkId, val of weekHeights\n          wk = sw wkId\n          if wk[0] < todayWk[0] or (wk[0] is todayWk[0] and wk[1] < todayWk[1])\n            h += val\n        scroll = h*30+112+14\n        scroll = 0 if scroll < 50 # Also show the day headers if today's date is displayed in the first row of the calendar\n        if doScroll and document.body.getAttribute(\"data-view\") is \"0\" and not document.body.querySelector(\".full\") #in calendar view\n          window.scrollTo 0, scroll\n\n      document.body.classList.toggle \"noList\", document.querySelectorAll(\".assignment.listDisp:not(.done)\").length is 0\n      if document.body.getAttribute(\"data-view\") is \"1\" # in list view\n        resize()\n      console.timeEnd \"Displaying data\"\n\nBelow is a function to close the current assignment that is opened.\n\n    closeOpened = (evt) ->\n      evt.stopPropagation()\n      el = document.querySelector(\".full\")\n      if not el? then return\n\n      el.style.top = el.getAttribute \"data-top\"\n      el.classList.add \"anim\"\n      el.classList.remove \"full\"\n      el.scrollTop = 0\n      document.body.style.overflow = \"auto\"\n      back = document.getElementById(\"background\")\n      back.classList.remove \"active\"\n      setTimeout ->\n        back.style.display = \"none\"\n        el.classList.remove \"anim\"\n        el.classList.remove \"modify\"\n        el.style.top = \"auto\"\n        el.offsetHeight\n        el.classList.add \"anim\"\n      , 1000\n\nNow we assign it to clicking the background.\n\n    document.getElementById(\"background\").addEventListener \"click\", closeOpened\n\nAnd a function to apply an ink effect\n\n    ripple = (el) ->\n      el.addEventListener \"mousedown\", (evt) ->\n        if evt.which == 1 # Left button\n          target = if evt.target.classList.contains \"wave\" then evt.target.parentNode else evt.target\n          wave = element \"span\", \"wave\"\n          size = Math.max parseInt(target.offsetWidth), parseInt(target.offsetHeight)\n          wave.style.width = wave.style.height = size+\"px\"\n\n          e = evt.target\n          x = evt.clientX\n          y = evt.clientY\n          rect = e.getBoundingClientRect()\n          x -= rect.left\n          y -= rect.top\n\n          wave.style.top = y - size\/2 + \"px\"\n          wave.style.left = x - size\/2 + \"px\"\n          target.appendChild wave\n          wave.setAttribute \"data-hold\", Date.now()\n          wave.offsetWidth\n          wave.style.transform = \"scale(2.5)\"\n        return\n      el.addEventListener \"mouseup\", (evt) ->\n        if evt.which == 1 # Left button\n          target = if evt.target.classList.contains \"wave\" then evt.target.parentNode else evt.target\n          waves = target.getElementsByClassName \"wave\"\n          for wave in waves\n            do (wave) ->\n              diff = Date.now() - Number wave.getAttribute \"data-hold\"\n              delay = Math.max 350-diff, 0\n              setTimeout ->\n                wave.style.opacity = \"0\"\n                setTimeout ->\n                  wave.remove()\n                , 550\n              , delay\n        return\n      return\n\nThen, the tabs are made interactive.\n\n    for tab in document.querySelectorAll \"#navTabs>li\"\n      tab.addEventListener \"click\", (evt) ->\n        if ga? then ga 'send', 'event', 'navigation', evt.target.textContent,\n          page: '\/new.html'\n          title: \"Version #{version}\"\n        trans = JSON.parse localStorage[\"viewTrans\"]\n        if not trans\n          document.body.classList.add \"noTrans\"\n          document.body.offsetHeight\n        document.body.setAttribute \"data-view\", localStorage[\"view\"] = (Array::slice.call document.querySelectorAll \"#navTabs>li\").indexOf evt.target\n        if document.body.getAttribute(\"data-view\") == \"1\"\n          window.addEventListener \"resize\", resizeCaller\n          if trans\n            start = null\n            # The code below is the same code used in the resize() function. It basically just positions the assignments correctly as they animate\n            widths = if document.body.classList.contains \"showInfo\" then [650,1100,1800,2700,3800,5100] else [350,800,1500,2400,3500,4800]\n            columns = null\n            for w,index in widths\n              columns = index+1 if window.innerWidth > w\n            assignments = getResizeAssignments()\n            columnHeights = (0 for [0...columns])\n            step = (timestamp) ->\n              start ?= timestamp\n              for assignment, n in assignments\n                col = n%columns\n                if n < columns\n                  columnHeights[col] = 0\n                assignment.style.top = columnHeights[col]+\"px\"\n                assignment.style.left = 100\/columns*col+\"%\"\n                assignment.style.right = 100\/columns*(columns-col-1)+\"%\"\n                columnHeights[col] += assignment.offsetHeight+24\n              if timestamp-start < 350\n                window.requestAnimationFrame step\n            window.requestAnimationFrame step\n            setTimeout ->\n              for assignment, n in assignments\n                col = n%columns\n                if n < columns\n                  columnHeights[col] = 0\n                assignment.style.top = columnHeights[col]+\"px\"\n                columnHeights[col] += assignment.offsetHeight+24\n              return\n            , 350\n          else\n            resize()\n        else\n          window.scrollTo 0, scroll\n          document.querySelector(\"nav\").classList.add \"headroom--locked\"\n          setTimeout ->\n            document.querySelector(\"nav\").classList.remove \"headroom--unpinned\"\n            document.querySelector(\"nav\").classList.remove \"headroom--locked\"\n            document.querySelector(\"nav\").classList.add \"headroom--pinned\"\n            requestIdleCallback ->\n              listDateOffset = 0\n              updateListNav()\n              display()\n            , {timeout: 2000}\n          , 350\n          window.removeEventListener \"resize\", resizeCaller\n          for assignment in document.getElementsByClassName \"assignment\"\n            assignment.style.top = \"auto\"\n        if not trans\n          document.body.offsetHeight\n          setTimeout ->\n            document.body.classList.remove \"noTrans\"\n          , 350\n        return\n\nAnd the info tabs (just a little less code)\n\n    for tab in document.querySelectorAll \"#infoTabs>li\"\n      tab.addEventListener \"click\", (evt) ->\n        document.getElementById(\"info\").setAttribute \"data-view\", (Array::slice.call document.querySelectorAll \"#infoTabs>li\").indexOf evt.target\n\nFor list view, the assignments can't be on top of each other.\nTherefore, a listener is attached to the resizing of the browser window.\n\n    ticking = false\n    timeoutId = null\n    getResizeAssignments = ->\n      assignments = Array::slice.call document.querySelectorAll if document.body.classList.contains(\"showDone\") then \".assignment.listDisp\" else \".assignment.listDisp:not(.done)\"\n      assignments.sort (a,b) ->\n        ad = a.classList.contains \"done\"\n        bd = b.classList.contains \"done\"\n        return 1 if ad and not bd\n        return -1 if bd and not ad\n        a.getElementsByClassName(\"due\")[0].value-b.getElementsByClassName(\"due\")[0].value\n      assignments\n    resizeCaller = ->\n      if not ticking\n        requestAnimationFrame resize\n        ticking = true\n    resize = ->\n      ticking = true\n      #To calculate the number of columns, the below algorithm is used becase as the screen size increases, the column width increases\n      widths = if document.body.classList.contains \"showInfo\" then [650,1100,1800,2700,3800,5100] else [350,800,1500,2400,3500,4800]\n      columns = 1\n      for w,index in widths\n        columns = index+1 if window.innerWidth > w\n      columnHeights = (0 for [0...columns])\n      cch = []\n      assignments = getResizeAssignments()\n      for assignment, n in assignments\n        col = n%columns\n        cch.push(columnHeights[col])\n        columnHeights[col] += assignment.offsetHeight+24\n      for assignment, n in assignments\n        col = n%columns\n        assignment.style.top = cch[n]+\"px\"\n        assignment.style.left = 100\/columns*col+\"%\"\n        assignment.style.right = 100\/columns*(columns-col-1)+\"%\"\n      clearTimeout timeoutId\n      timeoutId = setTimeout ->\n        cch.length = 0\n        for assignment, n in assignments\n          col = n%columns\n          if n < columns\n            columnHeights[col] = 0\n          cch.push(columnHeights[col])\n          columnHeights[col] += assignment.offsetHeight+24\n        for assignment, n in assignments\n          assignment.style.top = cch[n]+\"px\"\n        return\n      , 500\n      ticking = false\n      return\n\nThe view is set to what it was last.\n\n    if localStorage[\"view\"]?\n      document.body.setAttribute \"data-view\", localStorage[\"view\"]\n      if localStorage[\"view\"] is \"1\"\n        window.addEventListener \"resize\", resizeCaller\n\nAdditionally, the active class needs to be added when inputs are selected (for the login box).\n\n    for input in document.querySelectorAll \"input[type=text]:not(#newText):not([readonly]), input[type=password], input[type=email], input[type=url], input[type=tel], input[type=number]:not(.control), input[type=search]\"\n      input.addEventListener \"change\", (evt) ->\n        evt.target.parentNode.querySelector(\"label\").classList.add \"active\"\n      input.addEventListener \"focus\", (evt) ->\n        evt.target.parentNode.querySelector(\"label\").classList.add \"active\"\n      input.addEventListener \"blur\", (evt) ->\n        if evt.target.value.length is 0\n          evt.target.parentNode.querySelector(\"label\").classList.remove \"active\"\n\nWhen the escape key is pressed, the current assignment should be closed.\n\n    window.addEventListener \"keydown\", (evt) ->\n      if evt.which is 27 # Escape key pressed\n        closeOpened(new Event(\"Generated Event\")) if document.getElementsByClassName(\"full\").length isnt 0\n\nIf it's winter time, a class is added to the body element.\n\n    do ->\n      today = new Date()\n      if new Date(today.getFullYear(), 10, 27) <= today <= new Date(today.getFullYear(), 11, 32)\n        document.body.classList.add \"winter\"\n\nFor the navbar toggle buttons, a function to toggle the action is defined to eliminate code.\n\n    navToggle = (element, ls, f) ->\n        ripple document.getElementById element\n        document.getElementById(element).addEventListener \"mouseup\", ->\n          document.body.classList.toggle ls\n          resize()\n          localStorage[ls] = JSON.stringify document.body.classList.contains ls\n          if f? then f()\n\n        if localStorage[ls]? and JSON.parse localStorage[ls]\n          document.body.classList.add ls\n\nThe button to show\/hide completed assignments in list view also needs event listeners.\n\n    navToggle \"cvButton\", \"showDone\", ->\n        setTimeout resize, 1000\n\nThe same goes for the button that shows upcoming tests.\n\n    localStorage[\"showInfo\"] ?= JSON.stringify true\n    navToggle \"infoButton\", \"showInfo\"\n\nThis also gets repeated for the theme toggling.\n\n    navToggle \"lightButton\", \"dark\"\n\nFor ease of animations, a function that returns a promise is defined.\n\n    animateEl = (el, args...) ->\n      new Promise (resolve, reject) ->\n        player = el.animate args...\n        player.onfinish = (e) -> resolve e\n\nIn order to make the previous date \/ next date buttons do something, they need event listeners.\n\n    document.getElementById(\"listnext\").addEventListener \"click\", ->\n      pd = document.getElementById \"listprevdate\"\n      td = document.getElementById \"listnowdate\"\n      nd = document.getElementById \"listnextdate\"\n      listDateOffset += 1\n      display()\n      nd.style.display = \"inline-block\"\n      Promise.race([\n        animateEl(td, [\n          {transform: 'translateX(0%)', opacity: 1},\n          {opacity: 0},\n          {transform: 'translateX(-100%)', opacity: 0}\n        ], {duration: 300, easing: \"ease-out\"}),\n        animateEl(nd, [\n          {transform: 'translateX(0%)', opacity: 0},\n          {opacity: 0},\n          {transform: 'translateX(-100%)', opacity: 1}\n        ], {duration: 300, easing: \"ease-out\"})\n      ]).then ->\n        pd.innerHTML = td.innerHTML\n        td.innerHTML = nd.innerHTML\n        listDate2 = new Date()\n        listDate2.setDate listDate2.getDate()+1+listDateOffset\n        nd.innerHTML = dateString(listDate2).replace(\"Today\", \"Now\")\n        nd.style.display = \"none\"\n\nThe event listener for the previous date button is mostly the same.\n\n    document.getElementById(\"listbefore\").addEventListener \"click\", ->\n      pd = document.getElementById \"listprevdate\"\n      td = document.getElementById \"listnowdate\"\n      nd = document.getElementById \"listnextdate\"\n      listDateOffset -= 1\n      display()\n      pd.style.display = \"inline-block\"\n      Promise.race([\n        animateEl(td, [\n          {transform: 'translateX(-100%)', opacity: 1},\n          {opacity: 0},\n          {transform: 'translateX(0%)', opacity: 0}\n        ], {duration: 300, easing: \"ease-out\"}),\n        animateEl(pd, [\n          {transform: 'translateX(-100%)', opacity: 0},\n          {opacity: 0},\n          {transform: 'translateX(0%)', opacity: 1}\n        ], {duration: 300, easing: \"ease-out\"})\n      ]).then ->\n        nd.innerHTML = td.innerHTML\n        td.innerHTML = pd.innerHTML\n        listDate2 = new Date()\n        listDate2.setDate listDate2.getDate()+listDateOffset-1\n        pd.innerHTML = dateString(listDate2).replace(\"Today\", \"Now\")\n        pd.style.display = \"none\"\n\nWhenever a date is double clicked, long tapped, or force touched, list view for that day is displayed.\n\n    updateListNav = ->\n      d = new Date()\n      d.setDate(d.getDate()+listDateOffset-1)\n      up = (id) ->\n        document.getElementById(id).innerHTML = dateString(d).replace(\"Today\", \"Now\")\n        d.setDate d.getDate()+1\n      up \"listprevdate\"\n      up \"listnowdate\"\n      up \"listnextdate\"\n\n    switchToList = (evt) ->\n      if evt.target.classList.contains(\"month\") or evt.target.classList.contains(\"date\")\n        today = Math.floor (Date.now()-tzoff)\/1000\/3600\/24\n        listDateOffset = (evt.target.parentNode.getAttribute(\"data-date\")-tzoff)\/1000\/3600\/24 - today\n        updateListNav()\n        document.body.setAttribute \"data-view\", \"1\"\n        display()\n\n    document.body.addEventListener \"dblclick\", switchToList\n    document.body.addEventListener \"webkitmouseforceup\", switchToList\n    do ->\n      taptimer = null\n      document.body.addEventListener \"touchstart\", (evt) ->\n        taptimer = setTimeout (-> switchToList(evt)), 1000\n      document.body.addEventListener \"touchend\", (evt) ->\n        taptimer = clearTimeout taptimer\n\n\n<a name=\"side\"\/>\nSide menu and Navbar\n--------------------\n\nThe [Headroom library](https:\/\/github.com\/WickyNilliams\/headroom.js) is used to show the navbar when scrolling up\n\n    headroom = new Headroom document.querySelector(\"nav\"),\n      tolerance: 10\n      offset: 66\n    headroom.init()\n\nAlso, the side menu needs event listeners.\n\n    document.getElementById(\"collapseButton\").addEventListener \"click\", ->\n      document.body.style.overflow = \"hidden\"\n      document.getElementById(\"sideNav\").classList.add \"active\"\n      document.getElementById(\"sideBackground\").style.display = \"block\"\n\n    document.getElementById(\"sideBackground\").addEventListener \"click\", ->\n      document.getElementById(\"sideBackground\").style.opacity = 0\n      document.getElementById(\"sideNav\").classList.remove \"active\"\n      document.getElementById(\"dragTarget\").style.width = \"\"\n      setTimeout ->\n        document.body.style.overflow = \"auto\"\n        document.getElementById(\"sideBackground\").style.display = \"none\"\n      , 350\n\nThen, the username in the sidebar needs to be set and we need to generate an \"avatar\" based on initals.\nTo do that, some code to convert from LAB to RGB colors is borrowed from https:\/\/github.com\/boronine\/colorspaces.js\n\nLAB is a color naming scheme that uses two values (A and B) along with a lightness value in order to produce colors that are equally spaced between all of the colors that can be seen by the human eye.\nThis works great because everyone has letters in his\/her initials.\n\n    labrgb = (_L,_a,_b) ->\n      # The D65 standard illuminant\n      ref_X = 0.95047\n      ref_Y = 1.00000\n      ref_Z = 1.08883\n\n      # CIE L*a*b* constants\n      lab_e = 0.008856\n      lab_k = 903.3\n\n      f_inv = (t) ->\n        if Math.pow(t, 3) > lab_e\n          Math.pow(t, 3)\n        else\n          (116 * t - 16) \/ lab_k\n      dot_product = (a, b) ->\n        ret = 0\n        for i in [0..a.length-1]\n          ret += a[i] * b[i]\n        return ret\n\n      var_y = (_L + 16) \/ 116\n      var_z = var_y - _b \/ 200\n      var_x = _a \/ 500 + var_y\n      _X = ref_X * f_inv(var_x)\n      _Y = ref_Y * f_inv(var_y)\n      _Z = ref_Z * f_inv(var_z)\n\n      tuple = [_X, _Y, _Z]\n\n      m = [\n        [3.2406, -1.5372, -0.4986]\n        [-0.9689, 1.8758,  0.0415]\n        [0.0557, -0.2040,  1.0570]\n      ]\n      from_linear = (c) ->\n        a = 0.055\n        if c <= 0.0031308\n          12.92 * c\n        else\n          1.055 * Math.pow(c, 1 \/ 2.4) - 0.055\n      _R = from_linear dot_product m[0], tuple\n      _G = from_linear dot_product m[1], tuple\n      _B = from_linear dot_product m[2], tuple\n\n      # Original from here\n      n = (v) ->\n        Math.round Math.max(Math.min(v*256,255), 0)\n      \"rgb(#{n _R}, #{n _G}, #{n _B})\"\n\nThe function below uses this algorithm to generate a background color for the initials displayed in the sidebar.\n\n    updateAvatar = ->\n      if localStorage[\"username\"]?\n        document.getElementById(\"user\").innerHTML = localStorage[\"username\"]\n        initials = localStorage[\"username\"].match \/\\d*(.).*?(.$)\/ # Separate year from first name and initial\n        if initials?\n          bg = labrgb 50, (initials[1].charCodeAt(0)-65)\/26*256-128, (initials[2].charCodeAt(0)-65)\/26*256-128 # Compute the color\n          document.getElementById(\"initials\").style.backgroundColor = bg\n          document.getElementById(\"initials\").innerHTML = initials[1]+initials[2]\n    updateAvatar()\n\n<a name=\"athena\"\/>\nAthena (Schoology)\n------------------\n\nNow, there's the schoology\/athena integration stuff.\nFirst, we need to check if it's been more than a day. There's no point constantly retrieving classes from Athena; they dont't change that much.\n\n    athenaData = if localStorage[\"athenaData\"]? then JSON.parse(localStorage[\"athenaData\"]) else null\n\nThen, once the variable for the last date is initialized, it's time to get the classes from athena.\nLuckily, there's this file at \/iapi\/course\/active - and it's in JSON! Life can't be any better! Seriously! It's just too bad the login page isn't in JSON.\n\n    parseAthenaData = (dat) ->\n      if dat is \"\"\n        athenaData = null\n        localStorage.removeItem \"athenaData\"\n      else\n        try\n          d = JSON.parse dat\n          athenaData2 = {}\n          allCourseDetails = {}\n          for section in d.body.courses.sections\n            allCourseDetails[section.course_nid] = section\n          for course in d.body.courses.courses by -1\n            courseDetails = allCourseDetails[course.nid]\n            athenaData2[course.course_title] =\n              link: \"https:\/\/athena.harker.org\"+courseDetails.link\n              logo: courseDetails.logo.substr(0, courseDetails.logo.indexOf(\"\\\" alt=\\\"\")).replace(\"<div class=\\\"profile-picture\\\"><img src=\\\"\", \"\").replace(\"tiny\", \"reg\")\n              period: courseDetails.section_title\n          athenaData = athenaData2\n          localStorage[\"athenaData\"] = JSON.stringify athenaData\n          document.getElementById(\"athenaDataError\").style.display = \"none\"\n          document.getElementById(\"athenaDataRefresh\").style.display = \"block\"\n        catch e\n          document.getElementById(\"athenaDataError\").style.display = \"block\"\n          document.getElementById(\"athenaDataRefresh\").style.display = \"none\"\n          document.getElementById(\"athenaDataError\").innerHTML = e.message\n      return\n\n<a name=\"settings\"\/>\nSettings\n--------\n\nThe code below updates the current version text in the settings. I should've put this under the Updates section, but it should go before the display() function forces a reflow.\n\n    document.getElementById(\"version\").innerHTML = version\n\nTo bring up the settings windows, an event listener needs to be added to the button.\n\n    document.getElementById(\"settingsB\").addEventListener \"click\", ->\n      document.getElementById(\"sideBackground\").click()\n      document.body.classList.add \"settingsShown\"\n      document.getElementById(\"brand\").innerHTML = \"Settings\"\n      setTimeout ->\n        document.querySelector(\"main\").style.display = \"none\"\n\nThe back button also needs to close the settings window.\n\n    document.getElementById(\"backButton\").addEventListener \"click\", ->\n      document.querySelector(\"main\").style.display = \"block\"\n      document.body.classList.remove \"settingsShown\"\n      document.getElementById(\"brand\").innerHTML = \"Check PCR\"\n\nThe code below is what the settings control.\n\n    localStorage[\"viewTrans\"] ?= JSON.stringify true\n    localStorage[\"earlyTest\"] ?= JSON.stringify 1\n    localStorage[\"googleA\"] ?= JSON.stringify true\n    localStorage[\"sepTasks\"] ?= JSON.stringify false\n    localStorage[\"sepTaskClass\"] ?= JSON.stringify true\n    localStorage[\"projectsInTestPane\"] ?= JSON.stringify false\n    localStorage[\"assignmentSpan\"] ?= JSON.stringify \"multiple\"\n    localStorage[\"hideassignments\"] ?= JSON.stringify \"day\"\n    if JSON.parse localStorage[\"sepTasks\"]\n      document.getElementById(\"info\").classList.add \"isTasks\"\n      document.getElementById(\"new\").style.display = \"none\"\n    localStorage[\"holidayThemes\"] ?= JSON.stringify false\n    document.body.classList.add \"holidayThemes\" if JSON.parse localStorage[\"holidayThemes\"]\n    document.body.classList.add \"sepTaskClass\" if JSON.parse localStorage[\"sepTaskClass\"]\n    localStorage[\"colorType\"] ?= \"assignment\"\n    localStorage[\"assignmentColors\"] ?= JSON.stringify {homework: \"#2196f3\", classwork: \"#689f38\", test: \"#f44336\", longterm: \"#f57c00\"}\n    if localStorageRead(\"data\")? and not localStorage[\"classColors\"]?\n      a = {}\n      for c in localStorageRead(\"data\").classes\n        a[c] = \"#616161\"\n      localStorage[\"classColors\"] = JSON.stringify a\n    document.getElementById(\"#{localStorage[\"colorType\"]}Colors\").style.display = \"block\"\n    localStorage[\"refreshOnFocus\"] ?= JSON.stringify true\n    window.addEventListener \"focus\", ->\n      if JSON.parse localStorage[\"refreshOnFocus\"]\n        fetch()\n    localStorage[\"refreshRate\"] ?= JSON.stringify -1\n    intervalRefresh = ->\n      r = JSON.parse localStorage[\"refreshRate\"]\n      if r > 0\n        setTimeout ->\n          console.debug \"Refreshing because of timer\"\n          fetch()\n          intervalRefresh()\n        , r*60*1000\n    intervalRefresh()\n\nFor choosing colors, the color choosing boxes need to be initialized.\n\n    ac = JSON.parse localStorage[\"assignmentColors\"]\n    cc = if localStorage[\"classColors\"]? then JSON.parse(localStorage[\"classColors\"]) else {}\n    palette =\n      \"#f44336\": \"#B71C1C\"\n      \"#e91e63\": \"#880E4F\"\n      \"#9c27b0\": \"#4A148C\"\n      \"#673ab7\": \"#311B92\"\n      \"#3f51b5\": \"#1A237E\"\n      \"#2196f3\": \"#0D47A1\"\n      \"#03a9f4\": \"#01579B\"\n      \"#00bcd4\": \"#006064\"\n      \"#009688\": \"#004D40\"\n      \"#4caf50\": \"#1B5E20\"\n      \"#689f38\": \"#33691E\"\n      \"#afb42b\": \"#827717\"\n      \"#fbc02d\": \"#F57F17\"\n      \"#ffa000\": \"#FF6F00\"\n      \"#f57c00\": \"#E65100\"\n      \"#ff5722\": \"#BF360C\"\n      \"#795548\": \"#3E2723\"\n      \"#616161\": \"#212121\"\n    if localStorageRead(\"data\")?\n      for c in localStorageRead(\"data\").classes\n        d = element \"div\", [], c\n        d.setAttribute \"data-control\", c\n        d.appendChild element \"span\", []\n        document.getElementById(\"classColors\").appendChild d\n    for e in document.getElementsByClassName \"colors\"\n      for color in e.getElementsByTagName \"div\"\n        sp = color.querySelector(\"span\")\n        listName = if e.getAttribute(\"id\") is \"classColors\" then \"classColors\" else \"assignmentColors\"\n        list = if e.getAttribute(\"id\") is \"classColors\" then cc else ac\n        sp.style.backgroundColor = list[color.getAttribute(\"data-control\")]\n        for p of palette\n          pe = element \"span\", []\n          pe.style.backgroundColor = p\n          if p is list[color.getAttribute(\"data-control\")]\n            pe.classList.add \"selected\"\n          sp.appendChild pe\n        custom = element \"span\", [\"customColor\"], \"<a>Custom<\/a>\n          <input type='text' placeholder='Was #{list[color.getAttribute(\"data-control\")]}' \/>\n          <span class='customInfo'>Use any CSS valid color name, such as\n          <code>#F44336<\/code> or <code>rgb(64, 43, 2)<\/code> or <code>cyan<\/code><\/span>\n          <a class='customOk'>Set<\/a>\"\n        custom.addEventListener \"click\", (evt) -> evt.stopPropagation()\n        custom.querySelector(\"a\").addEventListener \"click\", (evt) ->\n          this.parentNode.parentNode.classList.toggle \"onCustom\"\n          evt.stopPropagation()\n        sp.appendChild custom\n        do (sp, color, list, listName) ->\n          sp.addEventListener \"click\", (evt) ->\n            if sp.classList.contains \"choose\"\n              bg = tinycolor(evt.target.style.backgroundColor).toHexString()\n              list[color.getAttribute(\"data-control\")] = bg\n              sp.style.backgroundColor = bg\n              if sp.querySelector(\".selected\")?\n                sp.querySelector(\".selected\").classList.remove \"selected\"\n              evt.target.classList.add \"selected\"\n              localStorage[listName] = JSON.stringify list\n              updateColors()\n            sp.classList.toggle \"choose\"\n          custom.querySelector(\".customOk\").addEventListener \"click\", (evt) ->\n            this.parentNode.parentNode.classList.remove \"onCustom\"\n            this.parentNode.parentNode.classList.toggle \"choose\"\n            if sp.querySelector(\".selected\")?\n              sp.querySelector(\".selected\").classList.remove \"selected\"\n            sp.style.backgroundColor = list[color.getAttribute(\"data-control\")] =\n              this.parentNode.querySelector(\"input\").value\n            localStorage[listName] = JSON.stringify list\n            updateColors()\n            evt.stopPropagation()\n\nThen, a function that updates the color preferences is defined.\n\n    updateColors = ->\n      style = document.createElement \"style\"\n      style.appendChild document.createTextNode(\"\")\n      document.head.appendChild style\n      sheet = style.sheet\n\n      addColorRule = (selector, light, dark, extra=\"\") ->\n        sheet.insertRule(\"#{extra}.assignment#{selector} { background-color: #{light}; }\", 0)\n        sheet.insertRule(\"#{extra}.assignment#{selector}.done { background-color: #{dark}; }\", 0)\n        sheet.insertRule(\"#{extra}.assignment#{selector}::before { background-color: #{tinycolor.mix(light, \"#1B5E20\", 70).toHexString()}; }\", 0)\n        sheet.insertRule(\"#{extra}.assignmentItem#{selector}>i { background-color: #{light}; }\", 0)\n        sheet.insertRule(\"#{extra}.assignmentItem#{selector}.done>i { background-color: #{dark}; }\", 0)\n\n      createPalette = (color) ->\n        tinycolor(color).darken(24).toHexString()\n\n      if localStorage[\"colorType\"] is \"assignment\"\n        for name, color of JSON.parse localStorage[\"assignmentColors\"]\n          addColorRule \".#{name}\", color, palette[color] or createPalette(color)\n      else\n        for name, color of JSON.parse localStorage[\"classColors\"]\n          addColorRule \"[data-class=\\\"#{name}\\\"]\", color, palette[color] or createPalette(color)\n\n      addColorRule \".task\", \"#F5F5F5\", \"#E0E0E0\"\n      addColorRule \".task\", \"#424242\", \"#212121\", \".dark \"\n      return\n\nThe function then needs to be called.\n\n    updateColors()\n\nThe elements that control the settings also need event listeners\n\n    for e in document.getElementsByClassName \"settingsControl\"\n      if localStorage[e.name]?\n        if e.type is \"checkbox\"\n          e.checked = JSON.parse localStorage[e.name]\n        else\n          e.value = JSON.parse localStorage[e.name]\n      e.addEventListener \"change\", (evt) ->\n        if evt.target.type is \"checkbox\"\n          localStorage[evt.target.name] = JSON.stringify evt.target.checked\n        else\n          localStorage[evt.target.name] = JSON.stringify evt.target.value\n        switch evt.target.name\n          when \"refreshRate\" then intervalRefresh()\n          when \"earlyTest\" then display()\n          when \"assignmentSpan\" then display()\n          when \"projectsInTestPane\" then display()\n          when \"hideassignments\" then display()\n          when \"holidayThemes\" then document.body.classList.toggle \"holidayThemes\", evt.target.checked\n          when \"sepTaskClass\" then document.body.classList.toggle \"sepTaskClass\", evt.target.checked; display()\n          when \"sepTasks\" then document.getElementById(\"sepTasksRefresh\").style.display = \"block\"\n\nThis also needs to be done for radio buttons\n\n    document.querySelector(\"input[name=\\\"colorType\\\"][value=\\\"#{localStorage[\"colorType\"]}\\\"]\").checked = true\n    for c in document.getElementsByName(\"colorType\")\n      c.addEventListener \"change\", (evt) ->\n        v = document.querySelector('input[name=\"colorType\"]:checked').value\n        localStorage[\"colorType\"] = v\n        if v == \"class\"\n          document.getElementById(\"assignmentColors\").style.display = \"none\"\n          document.getElementById(\"classColors\").style.display = \"block\"\n        else\n          document.getElementById(\"assignmentColors\").style.display = \"block\"\n          document.getElementById(\"classColors\").style.display = \"none\"\n        updateColors()\n\nThe same goes for textareas.\n\n    for e in document.getElementsByTagName(\"textarea\")\n      if e.name isnt \"athenaDataRaw\" and localStorage[e.name]?\n        e.value = localStorage[e.name]\n      e.addEventListener \"input\", (evt) ->\n        localStorage[evt.target.name] = evt.target.value\n        if evt.target.name is \"athenaDataRaw\"\n          parseAthenaData evt.target.value\n\n<a name=\"starting\"\/>\nStarting everything\n-------------------\n\nFinally! We are (almost) done!\n\nBefore getting to anything, let's print out a welcoming message to the console!\n\n    console.log \"%cCheck PCR\", \"color: #004000; font-size: 3em\"\n    console.log \"%cVersion #{version} (Check below for current version)\", \"font-size: 1.1em\"\n    console.log \"\"\"Welcome to the developer console for your browser! Besides looking at the source code, you can also play around with Check PCR by executing the lines below:\n                   %c\\tfetch(true)               %c\/\/ Reloads all of your assignments (the true is for forcing a reload if one has already been triggered in the last minute)\n                   %c\\tdata                      %c\/\/ Displays the object that contains the data parsed from PCR's interface\n                   %c\\tactivity                  %c\/\/ The data for the assignments that show up in the activity pane\n                   %c\\textra                     %c\/\/ All of the tasks you've created by clicking the + button\n                   %c\\tathenaData                %c\/\/ The data fetched from Athena (if you've pasted the raw data into settings)\n                   %c\\tsnackbar(\"Hello World!\")  %c\/\/ Creates a snackbar showing the message \"Hello World!\"\n                   %c\\tdisplayError(new Error()) %c\/\/ Displays the stack trace for a random error (Just don't submit it!)\n                   %c\\tcloseError()              %c\/\/ Closes that dialog\"\"\",\n                   [].concat(([\"color: initial\", \"color: grey\"] for i in [0...8])...)...\n    console.log \"\"\n\n*Note: Because the hosted Parse server is no longer going to be available, the below code is commented out*\n\nThe *sendToParse* function puts \/ removes data on Parse since the completed and modified assignments are loaded and saved to \/ from Parse.\n\n    ###\n    sendToParse = (name, func, value, update=true) ->\n      # onerror will be called if there is an error sending the info to Parse or there is no connection to it\n      onerror = ->\n        console.debug \"Adding failed request to localStorage for later reattempts\"\n        parseFailed = if (pf = localStorage[\"parseFailed\"])? then JSON.parse(pf) else []\n        parseFailed.push [name, func, value]\n        localStorage[\"parseFailed\"] = JSON.stringify parseFailed\n      if window.userData # Check if parse has been initialized yet\n        console.log \"executing #{func} with argument #{value} into #{name}\"\n        Parse.CoreManager.getInstallationController().currentInstallationId().then (iid) ->\n          send(\"https:\/\/api.parse.com\/1\/classes\/UserData\/#{window.userData.id}\", \"json\",\n            null, # No special headers to send\n            JSON.stringify\n              _ApplicationId: Parse.CoreManager.get \"APPLICATION_ID\"\n              _ClientVersion: Parse.CoreManager.get \"VERSION\"\n              _InstallationId: iid\n              _JavaScriptKey: Parse.CoreManager.get \"JAVASCRIPT_KEY\"\n              _SessionToken: Parse.User.current().getSessionToken()\n              _method: \"PUT\"\n              \"#{name}\":\n                __op: func\n                objects: [sjcl.encrypt localStorage[\"cryptoPhrase\"], value]\n          ).then (resp) ->\n            console.log \"Successfully synced change to Parse\", resp.response\n            if update\n              window[name][{Remove: \"onremove\", AddUnique: \"onadd\"}[func]](value)\n          , onerror\n      else\n        onerror() # Parse not initialized yet\n    ###\n\nThen, a class similar to an array that interacts with Parse is defined.\n\n    class ParseArray\n      @onadd = ->\n      @onremove = ->\n      constructor: (@name, @windowname) ->\n        local = localStorage[@name]\n        @array = if local? then JSON.parse(local) else []\n      push: (item) ->\n        # sendToParse @name, \"AddUnique\", item, false\n        @array.push item\n      indexOf: (item) ->\n        @array.indexOf item\n      splice: (index, number) ->\n        # for n in [index...index+number]\n        #   sendToParse @name, \"Remove\", @array[n], false\n        @array.splice index, number\n      save: ->\n        localStorage[@name] = JSON.stringify @array\n      update: (updatedData) ->\n        updated = updatedData.slice 0\n        n = 0\n        while n < @array.length\n          item = @array[n]\n          # If the item was present in the old version but not in the new\n          # then it was removed\n          if updated.indexOf(item) is -1\n            @onremove item\n            @array.splice n, 1\n          else\n            n++\n          updated.splice 0,1 # Remove it since we've already handled it\n        # Now everything left in updated wasn't present in the old version\n        # has been added\n        for newitem in updated\n          @onadd newitem\n          @array.push newitem\n\nThe completed and modified assignments are loaded.\n\n    done = new ParseArray \"done\"\n    done.onadd = (id) -> # Called when another device has marked an assignment as done\n        for elem in document.querySelectorAll \".assignment[id^=\\\"#{id}\\\"], #test#{id}, #activity#{id}, #ia#{id}\"\n          elem.classList.add \"done\"\n        document.body.classList.remove \"noList\" if document.querySelectorAll(\".assignment.listDisp:not(.done)\").length != 0\n        resize() if document.body.getAttribute(\"data-view\") is \"1\"\n    done.onremove = (id) -> # Called when another device has marked an assignment as not done\n        for elem in document.querySelectorAll \".assignment[id^=\\\"#{id}\\\"], #test#{id}, #activity#{id}, #ia#{id}\"\n          elem.classList.remove \"done\"\n        document.body.classList.add \"noList\" if document.querySelectorAll(\".assignment.listDisp:not(.done)\").length == 0\n        resize() if document.body.getAttribute(\"data-view\") is \"1\"\n    modified = {}\n    if localStorage[\"modified\"]?\n      modified = JSON.parse localStorage[\"modified\"]\n    extra = []\n    if localStorage[\"extra\"]?\n      extra = JSON.parse localStorage[\"extra\"]\n    schedules = do -> if (s=localStorage[\"schedules\"]) then JSON.parse(s) else null\n\nThe \"last updated\" text is set to the correct date.\n\n    document.getElementById(\"lastUpdate\").innerHTML = if localStorage[\"lastUpdate\"]? then formatUpdate(localStorage[\"lastUpdate\"]) else \"Never\"\n\nNow, we load the saved assignments (if any) and fetch the current assignments from PCR.\n\n    if localStorageRead(\"data\")?\n      window.data = localStorageRead \"data\"\n\n      # Now check if there's activity\n      if localStorage[\"activity\"]?\n        activity = JSON.parse localStorage[\"activity\"]\n        for act in activity.slice activity.length-32, activity.length\n          addActivity act...\n\n      display()\n\n    fetch()\n\nIf the page is being viewed from the website, a couple changes need to be made.\n\n    if location.protocol isnt \"chrome-extension:\"\n      lc = document.querySelector(\"#login .content\")\n      document.getElementById(\"login\").classList.add \"large\"\n      lc.appendChild element \"div\", [], \"While this feature is very useful, it will store your credentials on the server's database. If you are uncomfortable with this, then unckeck the box to only have the servery proxy your credentials to PCR.\", \"storeAbout\"\n      lc.appendChild element \"span\", [],\n        \"\"\"The online version of Check PCR will send your login credentials through the server hosting this website so that it can fetch your assignments from PCR.\n        If you do not trust me to avoid stealing your credentials, you can use\n        <a href='https:\/\/github.com\/19RyanA\/CheckPCR'>the Check PCR unofficial chrome extension<\/a>, which will communicate directly with PCR and thus not send any data through this server.\"\"\", \"loginExtra\"\n      up = document.getElementById(\"update\")\n      upc = up.getElementsByClassName(\"content\")[0]\n      up.querySelector(\"h1\").innerHTML = \"A new update has been applied.\"\n      for el in upc.childNodes by -1\n        el.remove() if el.nodeType is 3 or el.tagName is \"BR\" or el.tagName is \"CODE\" or el.tagName is \"A\"\n      upc.insertBefore document.createTextNode(\"Because you are using the online version, the update has already been download. Click GOT IT to reload the page and apply the changes.\"), upc.querySelector(\"h2\")\n      document.getElementById(\"updateDelay\").style.display = \"none\"\n      document.getElementById(\"updateIgnore\").innerHTML = \"GOT IT\"\n      document.getElementById(\"updateIgnore\").style.right = \"8px\"\n\n<a name=\"analytics\"\/>\nAnalytics\n---------\n\nThe page to be sent to Google Analytics is set to the correct one.\n\n    gp =\n      page: '\/new.html'\n      title: if location.protocol is \"chrome-extension:\" then \"Version #{version}\" else \"Online\"\n\nThis is the code for Google Analytics. There's not much more to explain.\n\n    if not JSON.parse(localStorage[\"googleA\"])\n      window['ga-disable-UA-66932824-1'] = true\n    else\n      `(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){\n      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),\n      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)\n      })(window,document,'script','https:\/\/www.google-analytics.com\/analytics.js','ga');`\n\n      ga 'create', 'UA-66932824-1', 'auto'\n      ga 'set', 'checkProtocolTask', (->)\n      ga 'require', 'displayfeatures'\n      ga 'send', 'pageview', gp\n\nThe user is also alerted that the page uses Google Analytics just to be nice.\n\n    if not localStorage[\"askGoogleAnalytics\"]?\n      snackbar \"This page uses Google Analytics. You can opt out vai Settings.\", \"Settings\", ->\n        document.getElementById(\"settingsB\").click()\n      localStorage[\"askGoogleAnalytics\"] = \"false\"\n\n<a name=\"events\"\/>\nEvents\n------\n\nThe document body needs to be enabled for hammer.js events.\n\n    delete Hammer.defaults.cssProps.userSelect\n    hammertime = new Hammer.Manager document.body,\n      recognizers: [\n        [Hammer.Pan, {direction: Hammer.DIRECTION_HORIZONTAL}]\n      ]\n\nFor touch displays, hammer.js is used to make the side menu appear\/disappear. The code below is adapted from Materialize's implementation.\n\n    menuOut = false\n    dragTarget = new Hammer document.getElementById \"dragTarget\"\n    dragTarget.on \"pan\", (e) ->\n      if e.pointerType is \"touch\"\n        e.preventDefault()\n        direction = e.direction\n        x = e.center.x\n        y = e.center.y\n\n        sbkg = document.getElementById(\"sideBackground\")\n        sbkg.style.display = \"block\"\n        sbkg.style.opacity = 0\n        document.getElementById(\"sideNav\").classList.add \"manual\"\n\n        # Keep within boundaries\n        if x > 240\n          x = 240\n        else if x < 0\n          x = 0\n\n          # Left Direction\n          if x < 120\n            menuOut = false\n          # Right Direction\n          else if x >= 120\n            menuOut = true\n\n        document.getElementById(\"sideNav\").style.transform = \"translateX(#{x-240}px)\"\n        overlayPerc = Math.min(x \/ 480, 0.5)\n        sbkg.style.opacity = overlayPerc\n\n    dragTarget.on \"panend\", (e) ->\n      if e.pointerType is \"touch\"\n        velocityX = e.velocityX\n        # If velocityX <= 0.3 then the user is flinging the menu closed so ignore menuOut\n        if (menuOut and velocityX <= 0.3) or velocityX < -0.5\n          sideNav = document.getElementById(\"sideNav\")\n          sideNav.classList.remove \"manual\"\n          sideNav.classList.add \"active\"\n          sideNav.style.transform = \"\"\n          document.getElementById(\"dragTarget\").style.width = \"100%\"\n\n        else if !menuOut or velocityX > 0.3\n          document.body.style.overflow = \"auto\"\n          sideNav = document.getElementById(\"sideNav\")\n          sideNav.classList.remove \"manual\"\n          sideNav.classList.remove \"active\"\n          sideNav.style.transform = \"\"\n          document.getElementById(\"sideBackground\").style.opacity = \"\"\n          document.getElementById(\"dragTarget\").style.width = \"10px\"\n          setTimeout ->\n            document.getElementById(\"sideBackground\").style.display = \"none\"\n          , 350\n\n    dragTarget.on \"tap\", (e) ->\n      document.getElementById(\"sideBackground\").click()\n      e.preventDefault()\n\n    dt = document.getElementById(\"dragTarget\")\n    ###hammertime.on \"pan\", (e) ->\n      if e.pointerType is \"touch\" and e.deltaX < -100 or e.deltaX > 100 and e.target isnt dt and (-25 < e.deltaY < 25)\n        if e.velocityX > 0.5\n          el = document.querySelector(\"#navTabs>li:nth-child(#{document.body.getAttribute(\"data-view\")+2})\")\n        else if e.velocityX < -0.5\n          el = document.querySelector(\"#navTabs>li:nth-child(#{document.body.getAttribute(\"data-view\")})\")\n        if el?\n          el.click()\n      return###\n\nThe activity filter button also needs an event listener.\n\n    ripple document.getElementById(\"filterActivity\")\n    document.getElementById(\"filterActivity\").addEventListener \"click\", ->\n      document.getElementById(\"infoActivity\").classList.toggle(\"filter\")\n\nAt the start, it needs to be correctly populated\n\n    activityTypes = if localStorage[\"shownActivity\"] then JSON.parse(localStorage[\"shownActivity\"]) else\n      add: true\n      edit: true\n      delete: true\n    updateSelectNum = ->\n      c = (bool) -> if bool then 1 else 0\n      document.getElementById(\"selectNum\").innerHTML = c(activityTypes.add)+c(activityTypes.edit)+c(activityTypes.delete)\n    updateSelectNum()\n    for type,enabled of activityTypes\n      document.getElementById(type+\"Select\").checked = enabled\n      if enabled then document.getElementById(\"infoActivity\").classList.add type\n      do (type) ->\n        document.getElementById(type+\"Select\").addEventListener \"change\", (evt) ->\n          activityTypes[type] = evt.target.checked\n          document.getElementById(\"infoActivity\").setAttribute \"data-filtered\", updateSelectNum()\n          document.getElementById(\"infoActivity\").classList.toggle type\n          localStorage[\"shownActivity\"] = JSON.stringify activityTypes\n\nThe show completed tasks checkbox is set correctly and is assigned an event listener.\n\n    if localStorage[\"showDoneTasks\"] and JSON.parse(localStorage[\"showDoneTasks\"])\n      document.getElementById(\"showDoneTasks\").checked = true\n      document.getElementById(\"infoTasksInner\").classList.add \"showDoneTasks\"\n    document.getElementById(\"showDoneTasks\").addEventListener \"change\", ->\n      localStorage[\"showDoneTasks\"] = JSON.stringify this.checked\n      document.getElementById(\"infoTasksInner\").classList.toggle \"showDoneTasks\", this.checked\n\n<a name=\"updates\"\/>\nUpdates and News\n----------------\n\nFor updating, a request will be send to Github to get the current commit id and check that against what's stored\n\n    checkCommit = ->\n      send \"https:\/\/raw.githubusercontent.com\/19RyanA\/CheckPCR\/master\/version.txt\", \"text\"\n        .then (resp) ->\n          c = resp.responseText.trim()\n          console.log \"Current version: #{c} #{if version is c then \"(no update available)\" else \"(update available)\"}\"\n          document.getElementById(\"newversion\").innerHTML = c\n          if version isnt c\n            document.getElementById(\"updateIgnore\").addEventListener \"click\", ->\n              if location.protocol is \"chrome-extension:\"\n                document.getElementById(\"update\").classList.remove \"active\"\n                setTimeout ->\n                  document.getElementById(\"updateBackground\").style.display = \"none\"\n                , 350\n              else\n                window.location.reload()\n            send (if location.protocol is \"chrome-extension:\" then \"https:\/\/api.github.com\/repos\/19RyanA\/CheckPCR\/git\/refs\/heads\/master\" else \"\/api\/commit\"), \"json\"\n              .then (resp) ->\n                sha = resp.response.object.sha\n                send (if location.protocol is \"chrome-extension:\" then resp.response.object.url else \"\/api\/commit\/#{sha}\"), \"json\"\n                  .then (resp) ->\n                    document.getElementById(\"pastUpdateVersion\").innerHTML = version\n                    document.getElementById(\"newUpdateVersion\").innerHTML = c\n                    document.getElementById(\"updateFeatures\").innerHTML = resp.response.message.substr(resp.response.message.indexOf(\"\\n\\n\")+2).replace(\/\\* (.*?)(?=$|\\n)\/g, (a,b) -> \"<li>#{b}<\/li>\").replace(\/>\\n<\/g, \"><\").replace(\/\\n\/g, \"<br>\")\n                    document.getElementById(\"updateBackground\").style.display = \"block\"\n                    document.getElementById(\"update\").classList.add \"active\"\n        , (err) ->\n          console.log \"Could not access Github. Here's the error:\", err\n\n    if location.protocol is \"chrome-extension:\" then checkCommit()\n\nThis update dialog also needs to be closed when the butons are clicked.\n\n    document.getElementById(\"updateDelay\").addEventListener \"click\", ->\n      document.getElementById(\"update\").classList.remove \"active\"\n      setTimeout ->\n        document.getElementById(\"updateBackground\").style.display = \"none\"\n      , 350\n\nFor news, the latest news is fetched from a GitHub gist.\n\n    send \"https:\/\/api.github.com\/gists\/21bf11a429da257539a68520f513a38b\", \"json\"\n      .then (resp) ->\n        last = localStorage[\"newsCommit\"]\n        nc = resp.response.history[0].version\n\n        if not last?\n          localStorage[\"newsCommit\"] = nc\n\n        window.getNews = (onfail) ->\n          send resp.response.files[\"updates.htm\"].raw_url\n            .then (resp) ->\n              localStorage[\"newsCommit\"] = nc\n              for news in resp.responseText.split(\"<hr>\")\n                document.getElementById(\"newsContent\").appendChild element \"div\", \"newsItem\", news\n              document.getElementById(\"newsBackground\").style.display = \"block\"\n              document.getElementById(\"news\").classList.add \"active\"\n            , (err) ->\n              if onfail? then onfail()\n\n        if last isnt nc\n          window.getNews()\n      , (err) ->\n        console.log \"Could not access Github. Here's the error:\", err\n\nThe news dialog then needs to be closed when OK or the background is clicked.\n\n    closeNews = ->\n      document.getElementById(\"news\").classList.remove \"active\"\n      setTimeout ->\n        document.getElementById(\"newsBackground\").style.display = \"none\"\n      , 350\n\n    document.getElementById(\"newsOk\").addEventListener \"click\", closeNews\n    document.getElementById(\"newsBackground\").addEventListener \"click\", closeNews\n\nIt also needs to be opened when the news button is clicked.\n\n    document.getElementById(\"newsB\").addEventListener \"click\", ->\n      document.getElementById(\"sideBackground\").click()\n      dispNews = ->\n        document.getElementById(\"newsBackground\").style.display = \"block\"\n        document.getElementById(\"news\").classList.add \"active\"\n\n      if document.getElementById(\"newsContent\").childNodes.length == 0\n        if getNews? then getNews dispNews else dispNews()\n      else\n        dispNews()\n\nThe same goes for the error dialog.\n\n    closeError = ->\n      document.getElementById(\"error\").classList.remove \"active\"\n      setTimeout ->\n        document.getElementById(\"errorBackground\").style.display = \"none\"\n      , 350\n\n    document.getElementById(\"errorNo\").addEventListener \"click\", closeError\n    document.getElementById(\"errorBackground\").addEventListener \"click\", closeError\n\n<a name=\"new\"\/>\nAdding new assignments\n----------------------\n\nThe event listeners for the new buttons are added.\n\n    ripple document.getElementById(\"new\")\n    ripple document.getElementById(\"newTask\")\n    onNewTask = ->\n      updateNewTips document.getElementById(\"newText\").value = \"\"\n      document.body.style.overflow = \"hidden\"\n      document.getElementById(\"newBackground\").style.display = \"block\"\n      document.getElementById(\"newDialog\").classList.add \"active\"\n      document.getElementById(\"newText\").focus()\n    document.getElementById(\"new\").addEventListener \"mouseup\", onNewTask\n    document.getElementById(\"newTask\").addEventListener \"mouseup\", onNewTask\n\nA function to close the dialog is then defined.\n\n    closeNew = ->\n      document.body.style.overflow = \"auto\"\n      document.getElementById(\"newDialog\").classList.remove \"active\"\n      setTimeout ->\n        document.getElementById(\"newBackground\").style.display = \"none\"\n      , 350\n\nThis function is set to be called called when the ESC key is called inside of the dialog.\n\n    document.getElementById(\"newText\").addEventListener \"keydown\", (evt) ->\n      if evt.which is 27 # Escape key pressed\n        closeNew()\n\nAn event listener to call the function is also added to the X button\n\n    document.getElementById(\"newCancel\").addEventListener \"click\", closeNew\n\n\nWhen the enter key is pressed or the submit button is clicked, the new assignment is added.\n\n    document.getElementById(\"newDialog\").addEventListener \"submit\", (evt) ->\n      evt.preventDefault()\n      text = document.getElementById(\"newText\").value\n\n      while true\n        parsed = text.match \/(.*) (for|by|due|assigned|starting|ending|beginning) (.*)\/\n        if parsed?\n          switch parsed[2]\n            when \"for\" then cls = parsed[3]\n            when \"by\",\"due\",\"ending\" then due = parsed[3]\n            when \"assigned\",\"starting\",\"beginning\" then st = parsed[3]\n          text = parsed[1]\n        else\n          break\n      start = if st? then Math.floor (chrono.parseDate(st).getTime()-tzoff)\/1000\/3600\/24 else Math.floor (Date.now()-tzoff)\/1000\/3600\/24\n      if due?\n        end = Math.floor (chrono.parseDate(due).getTime()-tzoff)\/1000\/3600\/24\n        if end<start # Assignmend ends before it is assigned\n          end += Math.ceil((start-end)\/7)*7\n      extra.push\n        body: text.charAt(0).toUpperCase()+text.substr(1)\n        done: false\n        start: start\n        class: if cls? then cls.toLowerCase().trim() else null\n        end: end\n      localStorage[\"extra\"] = JSON.stringify extra\n      closeNew()\n      display(false)\n\nWhen anything is typed, the search suggestions need to be updated.\n\n    tipNames =\n      for: [\"for\"]\n      by: [\"by\", \"due\", \"ending\"]\n      starting: [\"starting\", \"beginning\", \"assigned\"]\n\n    updateTip = (name, typed, uppercase) ->\n      el = document.getElementById \"tip#{name}\"\n      el.classList.add \"active\"\n      el.querySelector(\".typed\").innerHTML = (if uppercase then typed.charAt(0).toUpperCase()+typed.substr(1) else typed)+\"...\"\n      newNames = []\n      for n in tipNames[name]\n        if n != typed then newNames.push \"<b>#{n}<\/b>\"\n      el.querySelector(\".others\").innerHTML = if newNames.length>0 then \"You can also use \"+newNames.join(\" or \") else \"\"\n\n    tipComplete = (evt) ->\n      val = document.getElementById(\"newText\").value\n      lastSpace = val.lastIndexOf \" \"\n      lastWord = if lastSpace is -1 then 0 else lastSpace+1\n      updateNewTips document.getElementById(\"newText\").value = val.substring(0,lastWord)+this.querySelector(\".typed\").innerHTML.replace(\"...\",\"\")+\" \"\n      document.getElementById(\"newText\").focus()\n\n    updateNewTips = (val, scroll=true) ->\n      if scroll\n        document.getElementById(\"newTips\").scrollTop = 0\n      if (i=val.lastIndexOf \" \") isnt -1\n        beforeSpace = val.lastIndexOf \" \", i-1\n        before = val.substring (if beforeSpace is -1 then 0 else beforeSpace+1), i\n        for name, possible of tipNames\n          if possible.indexOf(before) isnt -1\n            if name is \"for\"\n              for name of tipNames\n                document.getElementById(\"tip\"+name).classList.remove \"active\"\n              for cls in data.classes\n                id = \"tipclass\"+cls.replace \/\\W\/, \"\"\n                if i is val.length-1\n                  if (e=document.getElementById(id))?\n                    e.classList.add \"active\"\n                  else\n                    container = element \"div\", [\"classTip\",\"active\",\"tip\"], \"<i class='material-icons'>class<\/i><span class='typed'>#{cls}<\/span>\", id\n                    container.addEventListener \"click\", tipComplete\n                    document.getElementById(\"newTips\").appendChild container\n                else\n                  document.getElementById(id).classList.toggle \"active\", cls.toLowerCase().indexOf(val.toLowerCase().substr i+1) isnt -1\n              return\n\n      for el in document.getElementsByClassName \"classTip\"\n        el.classList.remove \"active\"\n      if val is \"\" or val.charAt(val.length-1) is \" \"\n        updateTip \"for\", \"for\", false\n        updateTip \"by\", \"by\", false\n        updateTip \"starting\", \"starting\", false\n      else\n        lastSpace = val.lastIndexOf \" \"\n        lastWord = if lastSpace is -1 then val else val.substr lastSpace+1\n        uppercase = lastWord.charAt(0) is lastWord.charAt(0).toUpperCase()\n        lastWord = lastWord.toLowerCase()\n        for name, possible of tipNames\n          found = false\n          for p in possible\n            if p.slice(0,lastWord.length) is lastWord\n              found = p\n          if found\n            updateTip name, found, uppercase\n          else\n            document.getElementById(\"tip\"+name).classList.remove \"active\"\n      return\n\n    updateNewTips \"\", false\n    document.getElementById(\"newText\").addEventListener \"input\", ->\n      updateNewTips this.value\n\nThe event listener is then added to the preexisting tips.\n\n    for tip in document.getElementsByClassName \"tip\"\n      tip.addEventListener \"click\", tipComplete\n\n<a name=\"parse\" \/>\nParse\n-----\n\nFirst of all, to interact with Parse, the SDK must be initialized.\n\n    # Parse.initialize \"y0LK2CGd1Th6yHtOmmgN7CjplpFiDslTEwmtz7q2\", \"WQxQSzup108DdG4Ey0dJJJ9yw0KNWK2Ss2JBQPkb\"\n\nTo be able to query for the data stored in parse, the *UserData* class is defined.\n\n    # UserData = Parse.Object.extend \"UserData\"\n\nThe function *newParseData* creates an object in parse that will store the data.\n\n    ###\n    newParseData = ->\n      userData = new UserData()\n      passphrase = localStorage[\"cryptoPhrase\"]\n      userData.set \"done\", (sjcl.encrypt(passphrase, x) for x in done.array)\n      userData.set \"user\", Parse.User.current()\n      userData.setACL new Parse.ACL Parse.User.current() # Only\n      userData.save().then (userData) ->\n        window.userData = userData\n        console.debug \"Successfully saved userData\", userData\n      , (err) ->\n        alert \"Unable to save your current data to Parse because of this error: #{err.code} #{err.message}\"\n    ###\n\nThe function *onParseOnline* is called when a network connection to parse is made (again) and attempts to sync data that was created when offline\n\n    ###\n    onParseOnline = ->\n      if (pf = localStorage[\"parseFailed\"])?\n        delete localStorage[\"parseFailed\"] # CLear the failed requests\n        for failed in JSON.parse pf\n          sendToParse.apply sendToParse, failed\n    ###\n\nIn order to call this function when the browswer regains a network connection, an event listener is attached to the window.\n\n    # window.addEventListener \"online\", onParseOnline\n\n*getParseData* retrieves the object from Parse.\n\n    ###\n    getParseData = ->\n      query = new Parse.Query UserData\n      query.equalTo(\"user\", Parse.User.current())\n      query.first()\n        .then (result) ->\n          console.log result\n          window.userData = result\n          passphrase = localStorage[\"cryptoPhrase\"]\n          try\n            done.update (sjcl.decrypt(passphrase, x) for x in result.get \"done\")\n            # Attempt to sync when internet connection is reestablished\n            onParseOnline()\n          catch e\n            console.log e\n            if confirm \"Your data on Parse couldn't be decrypted (probably because the passphrase used to encode it and the passphrase on this device don't match). Do you want to overwrite the data on Parse with encrypted data using your passphrase?\"\n              console.log \"Replacing data\"\n              result.destroy()\n              newParseData()\n        , (err) ->\n          console.log \"Could not get data from Parse because of error\", err.code, err.message\n    ###\n\nIf the user is logged into the Parse database, then the login buttons are removed.\n\n    ###\n    requestIdleCallback ->\n      # Try to get the current user logged in\n      currentUser = Parse.User.current()\n      if currentUser\n        console.log \"Logged into parse with\", currentUser\n        # Logged in\n        document.getElementById(\"parseenc\").value = localStorage[\"cryptoPhrase\"]\n        document.getElementById(\"parsemanage\").style.display = \"block\"\n        getParseData()\n          .then ->\n            # Make it so that all data in the cloud can be replaced\n            document.getElementById(\"parseover\").addEventListener \"click\", ->\n              window.userData.destroy().then newParseData\n\n      else\n        getParseUP = ->\n          [document.getElementById(\"parseusername\").value,\n          document.getElementById(\"parsepassword\").value,\n          document.getElementById(\"parsekey\").value]\n        # Not logged in\n        document.getElementById(\"parsenew\").addEventListener \"click\", ->\n          [username, pass, key] = getParseUP()\n          document.getElementById(\"parseenc\").value = localStorage[\"cryptoPhrase\"] = key\n          user = new Parse.User()\n          user.set \"username\", username\n          user.set \"password\", pass\n          user.signUp().then ->\n            user.setACL new Parse.ACL Parse.User.current() # User's information only visiible to the user\n            newParseData()\n            document.getElementById(\"parsebuttons\").style.display = \"none\"\n            document.getElementById(\"parsemanage\").style.display = \"block\"\n          , (err) ->\n            alert \"Error creating a new account: #{err.code} #{err.message}\"\n\n        document.getElementById(\"parselogin\").addEventListener \"click\", ->\n          [username, pass, key] = getParseUP()\n          document.getElementById(\"parseenc\").value = localStorage[\"cryptoPhrase\"] = key\n          Parse.User.logIn username, pass\n            .then ->\n              document.getElementById(\"parsebuttons\").style.display = \"none\"\n              document.getElementById(\"parsemanage\").style.display = \"block\"\n            , (err) ->\n              alert \"Error logging in: #{err.code} #{err.message}\"\n\n        document.getElementById(\"parsebuttons\").style.display = \"block\"\n    , { timeout: 2000 }\n    ###\n\n<a name=\"other\"\/>\nOther\n-----\n\nIn order to show assignments when school ends, the bell schedule needs to be loaded.\n\n    ### To be implemented later when the pilot ends\n    requestIdleCallback ->\n      send \"https:\/\/raw.githubusercontent.com\/harkerdev\/schedules\/master\/index.html\", \"text\"\n        .then (resp) ->\n          requestIdleCallback ->\n            schedules = {index: [], schedules: []}\n            days = resp.response.replace(\/<.?div.*?>\/g, \"\").split(\"\\n\\n\")\n            for line in days.shift().split(\"\\n\") # Loop through the days\n              [day, label] = line.split(\"\\t\")\n              console.log line, day, label\n              spday = day.split(\"|\")\n              if spday.length is 1\n                schedules.index.push [Date.parse(spday[0]), label]\n              else\n                day = new Date spday[0]\n                while day < new Date(spday[1])\n                  schedules.index.push [day.getTime(), label]\n                  day.setDate day.getDate()+1\n          , {timeout: 2000}\n    , {timeout: 2000}\n    ###\n\nThe code below registers a service worker that caches the page so it can be viewed offline.\n\n    if `'serviceWorker' in navigator`\n      navigator.serviceWorker.register \"\/service-worker.js\"\n        .then (registration) ->\n          # Registration was successful\n          console.log \"ServiceWorker registration successful with scope\", registration.scope\n        .catch (err) ->\n          # registration failed :(\n          console.log \"ServiceWorker registration failed: \", err\n\nIf the serviceworker detects that the web app has been updated, the commit is fetched from GitHub.\n\n    navigator.serviceWorker.addEventListener 'message', (event) ->\n      console.log \"Getting commit because of serviceworker\"\n      if event.data.getCommit then checkCommit()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"25083f3a58dafa0cd356120b8f99a8b76315ec8f","subject":"Added a couple lvars","message":"Added a couple lvars\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments),\n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nFor convenience I'll add a couple of readily accessible logic variables:\n\n    F.$x = F.lvar(\"x\")\n    F.$y = F.lvar(\"y\")\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n                        find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return bindings\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        bindings = F.unify(_.first(t1), _.first(t2), bindings)\n        bindings = if (bindings isnt null) then F.unify(_.rest(t1), _.rest(t2),   bindings) else bindings\n        return bindings\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logic programs\n# --------------\n\nWe can build more complex goals using lambda-abstractions and previously defined combinators, `conj` and `disj`.  For example, we can define the function `choice` such that `choice(t1, array)` is a goal that succeeds if `t1` is an element of `array`.\n\n    F.choice = ($v, list) ->\n      return F.fail if _.isEmpty(list)\n\n      F.disj(F.goal($v, _.first(list)),\n                    F.choice($v, _.rest(list)))\n\nThe name `choice` should evoke [The Axiom of Choice](http:\/\/en.wikipedia.org\/wiki\/Axiom_of_choice)...\n\n\n\n# Exports and sundries\n# --------------------\n\n\t  if module?\n\t    module.exports = F\n\t  else\n\t    root.F = F\n\n\t)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments),\n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n                        find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return bindings\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        bindings = F.unify(_.first(t1), _.first(t2), bindings)\n        bindings = if (bindings isnt null) then F.unify(_.rest(t1), _.rest(t2),   bindings) else bindings\n        return bindings\n      return null\n\n# Operational logic\n# -----------------\n\nNow we can combine non-deterministic functions (Part 1) and the representation of knowledge (Part 2) into a logic system.  We introduce a `goal` -- a non-deterministic function that takes a substitution and produces 0, 1 or more other bindings (new knowledge). In case the goal produces 0 bindings, we say that the goal failed. We will call any result produced by the goal an \"outcome\".\n\nThe functions `succeed` and `fail` defined earlier are obviously  goals.  The latter is the failing goal. OTH, `succeed` is the trivial successful goal, a tautology that doesn't improve our knowledge of the world. We can now add another primitive goal, the result of a \"measurement\".  The quantum-mechanical connotations of \"the measurement\" must be obvious by now.\n\n    F.goal = (l, r) ->\n      (bindings) ->\n        result = F.unify(l, r, bindings)\n        return F.succeed(result) if result isnt null\n        return F.fail(bindings)\n\nWe also need a way to 'run' a goal, to see what knowledge we can obtain starting from sheer ignorance\n\n    F.run = (goal) ->\n      goal(F.ignorance)\n\n# Logic programs\n# --------------\n\nWe can build more complex goals using lambda-abstractions and previously defined combinators, `conj` and `disj`.  For example, we can define the function `choice` such that `choice(t1, array)` is a goal that succeeds if `t1` is an element of `array`.\n\n    F.choice = ($v, list) ->\n      return F.fail if _.isEmpty(list)\n\n      F.disj(F.goal($v, _.first(list)),\n                    F.choice($v, _.rest(list)))\n\nThe name `choice` should evoke [The Axiom of Choice](http:\/\/en.wikipedia.org\/wiki\/Axiom_of_choice)...\n\n\n\n# Exports and sundries\n# --------------------\n\n\t  if module?\n\t    module.exports = F\n\t  else\n\t    root.F = F\n\n\t)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7bba92cf86e0c4c9830bd349f3ca15067923da96","subject":"you had one job!!","message":"you had one job!!\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/05a_set_proxies.litcoffee","new_file":"docs\/05a_set_proxies.litcoffee","new_contents":"# \/api\/Data Structures\/Batman.Set\/Batman.SetProxy\n\n`Batman.SetProxy` provides a wrapper around a `Batman.Set` which delegates most methods and accessors to the base `Set`. `SetProxy` extends [`Batman.Object`](\/docs\/api\/batman.object.html) and [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html). To see `Batman.SetProxy` in action, see [`Batman.SetSort`](\/docs\/api\/batman.setsort.html).\n\n## ::constructor(base : Set) SetProxy\n\nReturns a new `SetProxy` tracking `base`.\n\n## Methods delegated to base\n\n- `add`\n- `insert`\n- `insertWithIndexes`\n- `remove`\n- `removeWithIndexes`\n- `at`\n- `find`\n- `clear`\n- `has`\n- `merge`\n- `replace`\n- `filter`\n- `toArray`\n- `isEmpty`\n- `indexedBy`\n- `indexedByUnique`\n- `sortedBy`\n\n## Accessors delegated to base\n\n- `first`\n- `last`\n- `isEmpty`\n- `toArray`\n- `length`\n- `indexedBy`\n- `indexedByUnique`\n- `sortedBy`\n- `sortedByDescending`\n\n\n# \/api\/Data Structures\/Batman.Set\/Batman.SetSort\n\n`Batman.SetSort` is a [`Batman.SetProxy`](\/docs\/api\/batman.setproxy.html) which sorts the members of its `base` by provided `key` and `order`. Through `SetProxy`, `SetSort` extends [`Batman.Object`](\/docs\/api\/batman.object.html) and [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html). `SetSort`s are generally derived from `Set`s. For example:\n\n    test \"SetSorts are sorted proxies of their Sets\", ->\n      batmobile = new Batman.Object(name: \"Batmobile\", wheelCount: 4)\n      batcycle = new Batman.Object(name: \"Batcycle\", wheelCount: 2)\n      vehicles = new Batman.Set(batmobile, batcycle)\n\n      vehiclesByWheelCount1 = new Batman.SetSort(vehicles, 'wheelCount') # order defaults to 'asc'\n      vehiclesByWheelCount2 = vehicles.sortedBy('wheelCount')\n      vehiclesByWheelCount3 = vehicles.get('sortedBy.wheelCount')\n\n      batcopter = new Batman.Object(name: \"Batcopter\", wheelCount: 0)\n      vehicles.add(batcopter)\n\n      for setSort in [vehiclesByWheelCount1, vehiclesByWheelCount2, vehiclesByWheelCount3]\n        deepEqual setSort.mapToProperty('wheelCount'), [0, 2, 4]\n\n\n## ::constructor(base : Set, key : String, order : [\"asc\"|\"desc\", default \"asc\"]) : SetSort\n\nReturns a new `SetSort`, tracking `base` and ordering by `key` in the direction of `order`.\n\n## ::.isSorted[= true]\n\nReturns `true`.\n\n## ::.key : String\n\nReturns the key used to sort members of the `SetSort`, as defined in the constructor.\n\n## ::.descending\n\n`true` if `\"desc\"` was passed to as `order` to the constructor, otherwise `false`. Descending `SetSort`s may also be made by getting `sortedByDescending` from a `Set`:\n\n    test \"get sortedByDescending creates a descending SetSort\", ->\n      batmobile = new Batman.Object(name: \"Batmobile\", wheelCount: 4)\n      batcycle = new Batman.Object(name: \"Batcycle\", wheelCount: 2)\n      vehicles = new Batman.Set(batmobile, batcycle)\n\n      vehiclesByWheelCountDescending1 = new Batman.SetSort(vehicles, 'wheelCount', 'desc')\n      vehiclesByWheelCountDescending2 = vehicles.get('sortedByDescending.wheelCount')\n\n      for descendingSetSort in [vehiclesByWheelCountDescending1, vehiclesByWheelCountDescending2]\n        equal descendingSetSort.descending, true\n        deepEqual descendingSetSort.mapToProperty('wheelCount'), [4, 2]\n\n## ::find(func : Function)\n\nReturns the first item from the `SetSort` for which `func(item)` returns a truthy value.\n\n## ::forEach(func : Function)\n\nCalls `func(item)` for each item in the `SetSort`.\n\n## ::toArray() : Array\n\nReturns a sorted array representation of the `SetSort`'s contents.\n\n## ::merge(other : Set) : SetSort\n\nReturns a new `SetSort` whose items are the union of this `SetSort` and `other`. It will have the same `key` and `order` as the starting `SetSort`.\n\n## ::compare(a, b) : Number\n\nReturns:\n\n- `-1` if `a` has higher precedence than `b`\n- `0` if `a` and `b` have equal precedence or if precedence can't be determined\n- `1` if `b` has higher precedence than `a`\n\nPrecedence is determined by testing for `undefined`, `null`, `false`, `true`, `NaN`, `a < b` and `a > b`. Please see [the source](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/set\/set_sort.coffee#L91) for implementation details.\n\nSince `::compareElements` delegates to `::compare`, you can acheive custom sorting by overriding `::compare` in a `SetSort` subclass.\n\n## ::compareElements(a, b) : Number\n\nUsed by `SetSort` to compare its elements when sorting. Like `::compare`, it returns `-1`, `0`, or `1`. To arrive at this value, it:\n\n- tries `a.get(@key)` (where `@key` is the `SetSort`s key)\n- if the resulting value is a function, calls `resultingFunction(a)`\n- calls `resultingValue.valueOf()`\n- repeats the process for `b`\n- delegates to `::compare` to compare the resulting values\n- inverts the value if `::.descending`\n\nBy following this process, it provides sort values for `Batman.Object`s `a` and `b` according to `@key`.\n\n\n","old_contents":"# \/api\/Data Structures\/Batman.Set\/Batman.SetProxy\n\n`Batman.SetProxy` provides a wrapper around a `Batman.Set` which delegates most methods and accessors to the base `Set`. `SetProxy` extends [`Batman.Object`](\/docs\/api\/batman.object.html) and [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html). To see `Batman.SetProxy` in action, see [`Batman.SetSort`](\/docs\/api\/batman.setsort.html).\n\n## ::constructor(base : Set) SetProxy\n\nReturns a new `SetProxy` tracking `base`.\n\n## Methods delegated to base\n\n- `add`\n- `insert`\n- `insertWithIndexes`\n- `remove`\n- `removeWithIndexes`\n- `at`\n- `find`\n- `clear`\n- `has`\n- `merge`\n- `replace`\n- `filter`\n- `toArray`\n- `isEmpty`\n- `indexedBy`\n- `indexedByUnique`\n- `sortedBy`\n\n## Accessors delegated to base\n\n- `first`\n- `last`\n- `isEmpty`\n- `toArray`\n- `length`\n- `indexedBy`\n- `indexedByUnique`\n- `sortedBy`\n- `sortedByDescending`\n\n\n# \/api\/Data Structures\/Batman.Set\/Batman.SetSort\n\n`Batman.SetSort` is a [`Batman.SetProxy`](\/docs\/api\/batman.setproxy.html) which sorts the members of its `base` by provided `key` and `order`. Through `SetProxy`, `SetSort` extends [`Batman.Object`](\/docs\/api\/batman.object.html) and [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html). `SetSort`s are generally derived from `Set`s. For example:\n\n    test \"SetSorts are sorted proxies of their Sets\", ->\n      batmobile = new Batman.Object(name: \"Batmobile\", wheelCount: 4)\n      batcycle = new Batman.Object(name: \"Batcycle\", wheelCount: 2)\n      vehicles = new Batman.Set(batmobile, batcycle)\n\n      vehiclesByWheelCount1 = new Batman.SetSort(vehicles, 'wheelCount') # order defaults to 'asc'\n      vehiclesByWheelCount2 = vehicles.sortedBy('wheelCount')\n      vehiclesByWheelCount3 = vehicles.get('sortedBy.wheelCount')\n\n      batcopter = new Batman.Object(name: \"Batcopter\", wheelCount: 0)\n      vehicles.add(batcopter)\n\n      for setSort in [vehiclesByWheelCount1, vehiclesByWheelCount2, vehiclesByWheelCount3]\n        deepEqual setSort.mapToProperty('wheelCount'), [0, 2, 4]\n\n\n## ::constructor(base : Set, key : String, order : [\"asc\"|\"desc\", default \"asc\"]) : SetSort\n\nReturns a new `SetSort`, tracking `base` and ordering by `key` in the direction of `order`.\n\n## ::.isSorted[= true]\n\nReturns `true`.\n\n## ::.key : String\n\nReturns the used to sort members of the `SetSort`, as defined in the constructor.\n\n## ::.descending\n\n`true` if `\"desc\"` was passed to as `order` to the constructor, otherwise `false`. Descending `SetSort`s may also be made by getting `sortedByDescending` from a `Set`:\n\n    test \"get sortedByDescending creates a descending SetSort\", ->\n      batmobile = new Batman.Object(name: \"Batmobile\", wheelCount: 4)\n      batcycle = new Batman.Object(name: \"Batcycle\", wheelCount: 2)\n      vehicles = new Batman.Set(batmobile, batcycle)\n\n      vehiclesByWheelCountDescending1 = new Batman.SetSort(vehicles, 'wheelCount', 'desc')\n      vehiclesByWheelCountDescending2 = vehicles.get('sortedByDescending.wheelCount')\n\n      for descendingSetSort in [vehiclesByWheelCountDescending1, vehiclesByWheelCountDescending2]\n        equal descendingSetSort.descending, true\n        deepEqual descendingSetSort.mapToProperty('wheelCount'), [4, 2]\n\n## ::find(func : Function)\n\nReturns the first item from the `SetSort` for which `func(item)` returns a truthy value.\n\n## ::forEach(func : Function)\n\nCalls `func(item)` for each item in the `SetSort`.\n\n## ::toArray() : Array\n\nReturns a sorted array representation of the `SetSort`'s contents.\n\n## ::merge(other : Set) : SetSort\n\nReturns a new `SetSort` whose items are the union of this `SetSort` and `other`. It will have the same `key` and `order` as the starting `SetSort`.\n\n## ::compare(a, b) : Number\n\nReturns:\n\n- `-1` if `a` has higher precedence than `b`\n- `0` if `a` and `b` have equal precedence or if precedence can't be determined\n- `1` if `b` has higher precedence than `a`\n\nPrecedence is determined by testing for `undefined`, `null`, `false`, `true`, `NaN`, `a < b` and `a > b`. Please see [the source](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/set\/set_sort.coffee#L91) for implementation details.\n\nSince `::compareElements` delegates to `::compare`, you can acheive custom sorting by overriding `::compare` in a `SetSort` subclass.\n\n## ::compareElements(a, b) : Number\n\nUsed by `SetSort` to compare its elements when sorting. Like `::compare`, it returns `-1`, `0`, or `1`. To arrive at this value, it:\n\n- tries `a.get(@key)` (where `@key` is the `SetSort`s key)\n- if the resulting value is a function, calls `resultingFunction(a)`\n- calls `resultingValue.valueOf()`\n- repeats the process for `b`\n- delegates to `::compare` to compare the resulting values\n- inverts the value if `::.descending`\n\nBy following this process, it provides sort values for `Batman.Object`s `a` and `b` according to `@key`.\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f31517b3b9f68b158c87fcde2816e7c8f7042655","subject":"Simplify Angular navigation request object","message":"Simplify Angular navigation request object\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-angular\/index.litcoffee","new_file":"packages\/shrub-angular\/index.litcoffee","new_contents":"# Angular on the server\n\n*A sandboxed version of Angular, for clients lacking JS.*\n\n###### TODO: Sandbox pool, might be better handled by [sandboxes](source\/server\/sandboxes).\n\n    _ = require 'lodash'\n    Promise = require 'bluebird'\n    url = require 'url'\n\n    config = require 'config'\n    debug = require('debug') 'shrub:angular'\n    middleware = require 'middleware'\n    {Sandbox} = require 'sandboxes'\n\nThe middleware dispatched every time sandboxed angular is navigated.\n\n    navigationMiddleware = []\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `endpoint`.\n\nAllow a JSful client to call us back and inform us that we don't need to\nhold their sandbox.\n\n      registrar.registerHook 'endpoint', ->\n\n        route: 'shrub.hangup'\n        receiver: (req, fn) ->\n\n###### TODO: Cookie-less clients won't have a valid session ID to call with. This should be some other token, perhaps CSRF.\n\n          id = req.session?.id\n          if (sandbox = sandboxManager.lookup id)?\n            sandbox.close().finally -> fn()\n          else\n            fn()\n\n#### Implements hook `httpMiddleware`.\n\nIf configuration dictates, render the client-side Angular application in a\nsandbox.\n\n      registrar.registerHook 'httpMiddleware', (http) ->\n\n        label: 'Render page with Angular'\n        middleware: [\n\n          (req, res, next) ->\n\nSkip render in a sandbox?\n\n            settings = config.get 'packageSettings:shrub-angular'\n            return next() unless settings.render\n\nThrown when a request is complete.\n\n            class ResponseComplete extends Error\n              constructor: (@message) ->\n\nAfter the template is rendered, lookup or create the sandbox.\n\n            Promise.resolve(req.delivery).bind({}).then((html) ->\n\n              sandboxManager.lookupOrCreate(\n                html\n              ,\n                cookie: req.headers.cookie\n\n###### TODO: Multiline.\n\n                url: \"http:\/\/localhost:#{config.get 'packageSettings:shrub-http:port'}\/shrub-entry-point\"\n              ,\n                req.session.id\n              )\n\n            ).then((@sandbox) ->\n\nEmit the HTML from before the last redirection.\n\n              if (redirectionHtml = @sandbox.redirectionHtml())?\n                @sandbox.setRedirectionHtml null\n                res.end redirectionHtml\n                throw new ResponseComplete()\n\nCheck for any new redirection and handle it.\n\n              if (redirectionPath = @sandbox.redirectionPath())?\n                @sandbox.setRedirectionPath null\n                res.redirect redirectionPath\n                throw new ResponseComplete()\n\n              @sandbox.navigate req\n\n            ).then(->\n\n              emission = @sandbox.emitHtml()\n\nIf a redirect happened in the sandbox, actually redirect\nthe browser and save the emission for the next request.\n\n              if (redirectionPath = @sandbox.redirectionPath())?\n                @sandbox.setRedirectionPath null\n                @sandbox.setRedirectionHtml emission\n                res.redirect redirectionPath\n\nOtherwise, just emit.\n\n              else\n\n                req.delivery = emission\n                next()\n\nThe request was completed early.\n\n            ).catch(ResponseComplete, ->\n\n            ).catch next\n\n      ]\n\n#### Implements hook `bootstrapMiddleware`.\n\n      registrar.registerHook 'bootstrapMiddleware', ->\n\n        label: 'Bootstrap Angular'\n        middleware: [\n\n          (next) ->\n\nAlways disable sandbox rendering in end-to-end testing mode.\n\n            if config.get 'E2E'\n              config.set 'packageSettings:shrub-angular:render', false\n\n#### Invoke hook `angularNavigationMiddleware`.\n\nLoad the navigation middleware.\n\n            navigationMiddleware = middleware.fromShortName(\n              'angular navigation', 'shrub-angular'\n            )\n\n            next()\n\n        ]\n\n#### Implements hook `packageSettings`.\n\n      registrar.registerHook 'packageSettings', ->\n\nDefault navigation middleware.\n\n        navigationMiddleware: [\n          'shrub-form'\n        ]\n\nShould we render in the sandbox?\n\n        render: true\n\nTime-to-live for rendering sandboxes.\n\n        ttl: 1000 * 60 * 5\n\nThis class handles instantiation of new sandboxes, as well as providing a\nmechanism for registering and looking up persistent sandboxes using an id.\n\n    sandboxManager = new class SandboxManager\n\n## *constructor*\n\n*Initialize the persistent store.*\n\n      constructor: ->\n\n        @_sandboxes = {}\n\n## SandboxManager#create\n\n* (string) `html` - The HTML to use as the sandbox document.\n* (string) `cookie` - The cookie to use for the document.\n* (optional string) `id` - An ID for looking up this sandbox later.\n\n*Create a sandbox.*\n\n      create: (html, options, id = null) ->\n\n        debug \"Creating sandbox ID: #{id}\"\n\n        sandbox = new Sandbox()\n        sandbox.id = id\n\n## Sandbox#close (monkeypatch)\n\n*Remove from the manager when closing.*\n\n        close = sandbox.close\n        sandbox.close = =>\n          debug \"Closing sandbox ID: #{id}\"\n\n          @_sandboxes[id] = null\n          close.apply sandbox\n\nCreate the document.\n\n        (@_sandboxes[id] = sandbox).createDocument html, options\n\n## SandboxManager#lookup\n\n* (string) `id` - An ID for looking up this sandbox later.\n\n*Look up a sandbox by ID.*\n\n      lookup: (id) -> @_sandboxes[id]?.touch()\n\n## SandboxManager#lookupOrCreate\n\n* (string) `html` - The HTML to use as the sandbox document if creating.\n* (string) `cookie` - The cookie to use for the document if creating.\n* (optional string) `id` - An ID either for looking up later (if creating), or\n  as a search now.\n\n*Look up a sandbox by ID, or create one if none is registered for this\nID.*\n\n      lookupOrCreate: (html, options, id = null) ->\n\n        if (sandbox = @lookup id)?\n\n          Promise.resolve sandbox\n\n        else\n\n          @create(html, options, id).then (sandbox) -> augmentSandbox sandbox\n\nAugment a sandbox with Angular-specific functionality.\n\n    augmentSandbox = (sandbox) ->\n\n## Sandbox#touch\n\n*Reset the time-to-live for a sandbox.*\n\n      ttl = config.get 'packageSettings:shrub-angular:ttl'\n      toucher = _.debounce (-> sandbox.close()), ttl\n      do sandbox.touch = ->\n        debug \"Touched sandbox ID: #{id}\"\n\n        toucher()\n        sandbox\n\n## Sandbox#(setR|r)edirectionHtml\n\n* (string) `html` - The HTML to be deliviered.\n\n*HTML to be delivered upon the next request using this sandbox.*\n\n      redirectionHtml = null\n      sandbox.redirectionHtml = -> redirectionHtml\n      sandbox.setRedirectionHtml = (html) -> redirectionHtml = html\n\n## Sandbox#(setR|r)edirectionPath\n\n* (string) `path` - The URL path to redirect to.\n\n*The path that the client will be redirected to at the end of this\nrequest.*\n\n      redirectionPath = null\n      sandbox.redirectionPath = -> redirectionPath\n      sandbox.setRedirectionPath = (path) -> redirectionPath = path\n\n## Sandbox#catchAngularRedirection\n\n* (string) `path` - URL path.\n\n*Check whether Angular was redirected, and set the client redirection\npath if it was.*\n\n      sandbox.catchAngularRedirection = (path) ->\n        self = this\n\n        @inject [\n          '$location'\n          ($location) ->\n\n            return if path is $location.url()\n\n            if redirect = self.pathRedirectsTo $location.url()\n              self.setRedirectionPath redirect\n            else\n              self.setRedirectionPath $location.url()\n\n        ]\n\n## Sandbox#checkPathChanges\n\n* (string) `path` - URL path.\n\n*Check whether the navigation path is different than the current Angular\nlocation path. If it is, redirect Angular.*\n\n      sandbox.checkPathChanges = (path) ->\n        self = this\n\n        new Promise (resolve) ->\n\n          self.inject [\n            '$location', '$rootScope'\n            ($location, $rootScope) ->\n\n              # } Nowhere to go?\n              return resolve() if path is url.parse(self.url()).path\n\n              # } Navigate Angular to the request path.\n              unlisten = $rootScope.$on 'shrub.core.routeRendered', ->\n                unlisten()\n                resolve()\n\n              $rootScope.$apply -> $location.path path\n\n          ]\n\n## Sandbox#navigate\n\n* (http.IncomingMessage) `req` - The HTTP request object.\n\n*Navigate angular to a path, and dispatch navigation middleware.*\n\n      sandbox.navigate = (req) ->\n        self = this\n\n        {path} = url.parse req.url\n\n        @checkPathChanges(path).then ->\n\n          new Promise (resolve, reject) ->\n\n            navigationReq = Object.create req\n            navigationReq.sandbox = sandbox\n\n###### TODO: Remove unused `res` parameter.\n\n            navigationMiddleware.dispatch navigationReq, null, (error) =>\n              return reject error if error?\n\n              self.catchAngularRedirection path\n              resolve()\n\n## Sandbox#pathRedirectsTo\n\n* (string) `path` - URL path.\n\n*Check where a path would be redirected by Angular's router.*\n\n      sandbox.pathRedirectsTo = (path) ->\n\n        routes = null\n\n        @inject [\n          '$route'\n          ($route) -> routes = $route.routes\n        ]\n\nPerfect match.\n\n        if routes[path]?\n\nDoes this path redirect? Do an HTTP redirect.\n\n          return routes[path].redirectTo if routes[path].redirectTo?\n\n        else\n\n          match = false\n\nCheck for any regexs.\n\n          for key, route of routes\n            if route.regexp?.test path\n\n###### TODO: Need to extract params to build redirectTo, it's a small enough mismatch to ignore for now.\n\n              return\n\nAngular's $routeProvider.otherwise() target.\n\n          return routes[null].redirectTo if routes[null]?\n\n## Sandbox#inject\n\n* (mixed) `injectable` - An annotated function to inject with\n  dependencies.\n\n*Inject an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation)\nwith dependencies.*\n\n      sandbox.inject = (injectable) ->\n\n        injector = @_window.angular.element(@_window.document).injector()\n        injector.invoke injectable\n\nMake sure the socket is dead.\n\n      sandbox.registerCleanupFunction ->\n\n        new Promise (resolve) ->\n\n          sandbox.inject [\n            'shrub-socket'\n            (socket) ->\n\n              socket.on 'disconnect', -> resolve()\n              socket.disconnect()\n\n          ]\n\n      new Promise (resolve) ->\n\n        sandbox.inject [\n          '$sniffer', 'shrub-socket'\n          ($sniffer, socket) ->\n\nDon't even try HTML 5 history on the server side.\n\n            $sniffer.history = false\n\nLet the socket finish initialization.\n\n            socket.on 'initialized', -> resolve sandbox\n\n        ]\n","old_contents":"# Angular on the server\n\n*A sandboxed version of Angular, for clients lacking JS.*\n\n###### TODO: Sandbox pool, might be better handled by [sandboxes](source\/server\/sandboxes).\n\n    _ = require 'lodash'\n    Promise = require 'bluebird'\n    url = require 'url'\n\n    config = require 'config'\n    debug = require('debug') 'shrub:angular'\n    middleware = require 'middleware'\n    {Sandbox} = require 'sandboxes'\n\nThe middleware dispatched every time sandboxed angular is navigated.\n\n    navigationMiddleware = []\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `endpoint`.\n\nAllow a JSful client to call us back and inform us that we don't need to\nhold their sandbox.\n\n      registrar.registerHook 'endpoint', ->\n\n        route: 'shrub.hangup'\n        receiver: (req, fn) ->\n\n###### TODO: Cookie-less clients won't have a valid session ID to call with. This should be some other token, perhaps CSRF.\n\n          id = req.session?.id\n          if (sandbox = sandboxManager.lookup id)?\n            sandbox.close().finally -> fn()\n          else\n            fn()\n\n#### Implements hook `httpMiddleware`.\n\nIf configuration dictates, render the client-side Angular application in a\nsandbox.\n\n      registrar.registerHook 'httpMiddleware', (http) ->\n\n        label: 'Render page with Angular'\n        middleware: [\n\n          (req, res, next) ->\n\nSkip render in a sandbox?\n\n            settings = config.get 'packageSettings:shrub-angular'\n            return next() unless settings.render\n\nThrown when a request is complete.\n\n            class ResponseComplete extends Error\n              constructor: (@message) ->\n\n            # } After the template is rendered, lookup or create the sandbox.\n            Promise.resolve(req.delivery).bind({}).then((html) ->\n\n              sandboxManager.lookupOrCreate(\n                html\n              ,\n                cookie: req.headers.cookie\n\n###### TODO: Multiline.\n\n                url: \"http:\/\/localhost:#{config.get 'packageSettings:shrub-http:port'}\/shrub-entry-point\"\n              ,\n                req.session.id\n              )\n\n            ).then((@sandbox) ->\n\nEmit the HTML from before the last redirection.\n\n              if (redirectionHtml = @sandbox.redirectionHtml())?\n                @sandbox.setRedirectionHtml null\n                res.end redirectionHtml\n                throw new ResponseComplete()\n\nCheck for any new redirection and handle it.\n\n              if (redirectionPath = @sandbox.redirectionPath())?\n                @sandbox.setRedirectionPath null\n                res.redirect redirectionPath\n                throw new ResponseComplete()\n\n              {path} = url.parse req.url\n              @sandbox.navigate path, req.body\n\n            ).then(->\n\n              emission = @sandbox.emitHtml()\n\nIf a redirect happened in the sandbox, actually redirect\nthe browser and save the emission for the next request.\n\n              if (redirectionPath = @sandbox.redirectionPath())?\n                @sandbox.setRedirectionPath null\n                @sandbox.setRedirectionHtml emission\n                res.redirect redirectionPath\n\nOtherwise, just emit.\n\n              else\n\n                req.delivery = emission\n                next()\n\nThe request was completed early.\n\n            ).catch(ResponseComplete, ->\n\n            ).catch next\n\n      ]\n\n#### Implements hook `bootstrapMiddleware`.\n\n      registrar.registerHook 'bootstrapMiddleware', ->\n\n        label: 'Bootstrap Angular'\n        middleware: [\n\n          (next) ->\n\nAlways disable sandbox rendering in end-to-end testing mode.\n\n            if config.get 'E2E'\n              config.set 'packageSettings:shrub-angular:render', false\n\n#### Invoke hook `angularNavigationMiddleware`.\n\nLoad the navigation middleware.\n\n            navigationMiddleware = middleware.fromShortName(\n              'angular navigation', 'shrub-angular'\n            )\n\n            next()\n\n        ]\n\n#### Implements hook `packageSettings`.\n\n      registrar.registerHook 'packageSettings', ->\n\nDefault navigation middleware.\n\n        navigationMiddleware: [\n          'shrub-form'\n        ]\n\nShould we render in the sandbox?\n\n        render: true\n\nTime-to-live for rendering sandboxes.\n\n        ttl: 1000 * 60 * 5\n\nThis class handles instantiation of new sandboxes, as well as providing a\nmechanism for registering and looking up persistent sandboxes using an id.\n\n    sandboxManager = new class SandboxManager\n\n## *constructor*\n\n*Initialize the persistent store.*\n\n      constructor: ->\n\n        @_sandboxes = {}\n\n## SandboxManager#create\n\n* (string) `html` - The HTML to use as the sandbox document.\n* (string) `cookie` - The cookie to use for the document.\n* (optional string) `id` - An ID for looking up this sandbox later.\n\n*Create a sandbox.*\n\n      create: (html, options, id = null) ->\n\n        debug \"Creating sandbox ID: #{id}\"\n\n        sandbox = new Sandbox()\n        sandbox.id = id\n\n## Sandbox#close (monkeypatch)\n\n*Remove from the manager when closing.*\n\n        close = sandbox.close\n        sandbox.close = =>\n          debug \"Closing sandbox ID: #{id}\"\n\n          @_sandboxes[id] = null\n          close.apply sandbox\n\nCreate the document.\n\n        (@_sandboxes[id] = sandbox).createDocument html, options\n\n## SandboxManager#lookup\n\n* (string) `id` - An ID for looking up this sandbox later.\n\n*Look up a sandbox by ID.*\n\n      lookup: (id) -> @_sandboxes[id]?.touch()\n\n## SandboxManager#lookupOrCreate\n\n* (string) `html` - The HTML to use as the sandbox document if creating.\n* (string) `cookie` - The cookie to use for the document if creating.\n* (optional string) `id` - An ID either for looking up later (if creating), or\n  as a search now.\n\n*Look up a sandbox by ID, or create one if none is registered for this\nID.*\n\n      lookupOrCreate: (html, options, id = null) ->\n\n        if (sandbox = @lookup id)?\n\n          Promise.resolve sandbox\n\n        else\n\n          @create(html, options, id).then (sandbox) -> augmentSandbox sandbox\n\nAugment a sandbox with Angular-specific functionality.\n\n    augmentSandbox = (sandbox) ->\n\n## Sandbox#touch\n\n*Reset the time-to-live for a sandbox.*\n\n      ttl = config.get 'packageSettings:shrub-angular:ttl'\n      toucher = _.debounce (-> sandbox.close()), ttl\n      do sandbox.touch = ->\n        debug \"Touched sandbox ID: #{id}\"\n\n        toucher()\n        sandbox\n\n## Sandbox#(setR|r)edirectionHtml\n\n* (string) `html` - The HTML to be deliviered.\n\n*HTML to be delivered upon the next request using this sandbox.*\n\n      redirectionHtml = null\n      sandbox.redirectionHtml = -> redirectionHtml\n      sandbox.setRedirectionHtml = (html) -> redirectionHtml = html\n\n## Sandbox#(setR|r)edirectionPath\n\n* (string) `path` - The URL path to redirect to.\n\n*The path that the client will be redirected to at the end of this\nrequest.*\n\n      redirectionPath = null\n      sandbox.redirectionPath = -> redirectionPath\n      sandbox.setRedirectionPath = (path) -> redirectionPath = path\n\n## Sandbox#catchAngularRedirection\n\n* (string) `path` - URL path.\n\n*Check whether Angular was redirected, and set the client redirection\npath if it was.*\n\n      sandbox.catchAngularRedirection = (path) ->\n        self = this\n\n        @inject [\n          '$location'\n          ($location) ->\n\n            return if path is $location.url()\n\n            if redirect = self.pathRedirectsTo $location.url()\n              self.setRedirectionPath redirect\n            else\n              self.setRedirectionPath $location.url()\n\n        ]\n\n## Sandbox#checkPathChanges\n\n* (string) `path` - URL path.\n\n*Check whether the navigation path is different than the current Angular\nlocation path. If it is, redirect Angular.*\n\n      sandbox.checkPathChanges = (path) ->\n        self = this\n\n        new Promise (resolve) ->\n\n          self.inject [\n            '$location', '$rootScope'\n            ($location, $rootScope) ->\n\n              # } Nowhere to go?\n              return resolve() if path is url.parse(self.url()).path\n\n              # } Navigate Angular to the request path.\n              unlisten = $rootScope.$on 'shrub.core.routeRendered', ->\n                unlisten()\n                resolve()\n\n              $rootScope.$apply -> $location.path path\n\n          ]\n\n## Sandbox#navigate\n\n* (string) `path` - URL path.\n* (string) `body` - Request body.\n\n*Navigate angular to a path, and dispatch navigation middleware.*\n\n      sandbox.navigate = (path, body) ->\n        self = this\n\n        @checkPathChanges(path).then ->\n\n          new Promise (resolve, reject) ->\n\n            req =\n              body: body\n              path: path\n              sandbox: sandbox\n\n###### TODO: Remove unused `res` parameter.\n\n            navigationMiddleware.dispatch req, null, (error) =>\n              return reject error if error?\n\n              self.catchAngularRedirection path\n              resolve()\n\n## Sandbox#pathRedirectsTo\n\n* (string) `path` - URL path.\n\n*Check where a path would be redirected by Angular's router.*\n\n      sandbox.pathRedirectsTo = (path) ->\n\n        routes = null\n\n        @inject [\n          '$route'\n          ($route) -> routes = $route.routes\n        ]\n\nPerfect match.\n\n        if routes[path]?\n\nDoes this path redirect? Do an HTTP redirect.\n\n          return routes[path].redirectTo if routes[path].redirectTo?\n\n        else\n\n          match = false\n\nCheck for any regexs.\n\n          for key, route of routes\n            if route.regexp?.test path\n\n###### TODO: Need to extract params to build redirectTo, it's a small enough mismatch to ignore for now.\n\n              return\n\nAngular's $routeProvider.otherwise() target.\n\n          return routes[null].redirectTo if routes[null]?\n\n## Sandbox#inject\n\n* (mixed) `injectable` - An annotated function to inject with\n  dependencies.\n\n*Inject an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation)\nwith dependencies.*\n\n      sandbox.inject = (injectable) ->\n\n        injector = @_window.angular.element(@_window.document).injector()\n        injector.invoke injectable\n\nMake sure the socket is dead.\n\n      sandbox.registerCleanupFunction ->\n\n        new Promise (resolve) ->\n\n          sandbox.inject [\n            'shrub-socket'\n            (socket) ->\n\n              socket.on 'disconnect', -> resolve()\n              socket.disconnect()\n\n          ]\n\n      new Promise (resolve) ->\n\n        sandbox.inject [\n          '$sniffer', 'shrub-socket'\n          ($sniffer, socket) ->\n\nDon't even try HTML 5 history on the server side.\n\n            $sniffer.history = false\n\nLet the socket finish initialization.\n\n            socket.on 'initialized', -> resolve sandbox\n\n        ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"411944572f3ea856c9925dbe3d2a48cbeb2a8e1a","subject":"Set Access-Control headers for collection","message":"Set Access-Control headers for collection\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    ObjectID    = require('mongodb').ObjectID\n    stringify   = require('JSONStream').stringify\n    createHash  = require('crypto').createHash\n\n    Document    = require '.\/model\/Document'\n\n    mongo       = require '.\/db\/mongo'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col]\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n      query = {}\n\n### ?tag=`String`\n\n      if typeof req.query.tag is 'string' and req.query.tag isnt ''\n        if req.query.tag.charAt(0) is '!' and req.query.tag.length > 1\n          query['tags.0'] = $ne: req.query.tag.substr(1)\n        else\n          query['tags.0'] = req.query.tag\n\n### ?grupper=`String`\n\n      if typeof req.query.gruppe is 'string' and req.query.gruppe isnt ''\n        query['grupper'] = req.query.gruppe\n\n### ?after=`Mixed`\n\n      if typeof req.query.after is 'string' and req.query.after isnt ''\n        if not isNaN(req.query.after)\n          req.query.after = new Date(parseInt(req.query.after, 10)).toISOString()\n        query.endret = {$gte:req.query.after}\n\n### ?bbox=`min_lng`,`min_lat`,`max_lng`,`max_lat`\n\n      if typeof req.query.bbox is 'string' and req.query.bbox.split(',').length is 4\n        bbox = req.query.bbox.split(',')\n        bbox[i] = parseFloat(val) for val, i in bbox\n\n        query.geojson =\n          '$geoWithin':\n            '$geometry':\n              type: 'Polygon'\n              coordinates: [[\n                [bbox[0], bbox[1]]\n                [bbox[2], bbox[1]]\n                [bbox[2], bbox[3]]\n                [bbox[0], bbox[3]]\n                [bbox[0], bbox[1]]\n              ]]\n\n### ?privat.`String`=`String`\n\nThis allows the user to filter documents based on private document properties.\nThis will autumaticly limit returned documents to those owned by the current\nuser.\n\n#### ToDo\n\n * Limit number of private fields?\n * Limit depth of private fields?\n\n`NB` This section is looping through all of the url query parameters and hence\nshould take the queries from above sections into concideration so we don't need\nto do double amount of work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    ObjectID    = require('mongodb').ObjectID\n    stringify   = require('JSONStream').stringify\n    createHash  = require('crypto').createHash\n\n    Document    = require '.\/model\/Document'\n\n    mongo       = require '.\/db\/mongo'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col]\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST, PATCH, PUT'\n      res.send()\n\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n      query = {}\n\n### ?tag=`String`\n\n      if typeof req.query.tag is 'string' and req.query.tag isnt ''\n        if req.query.tag.charAt(0) is '!' and req.query.tag.length > 1\n          query['tags.0'] = $ne: req.query.tag.substr(1)\n        else\n          query['tags.0'] = req.query.tag\n\n### ?grupper=`String`\n\n      if typeof req.query.gruppe is 'string' and req.query.gruppe isnt ''\n        query['grupper'] = req.query.gruppe\n\n### ?after=`Mixed`\n\n      if typeof req.query.after is 'string' and req.query.after isnt ''\n        if not isNaN(req.query.after)\n          req.query.after = new Date(parseInt(req.query.after, 10)).toISOString()\n        query.endret = {$gte:req.query.after}\n\n### ?bbox=`min_lng`,`min_lat`,`max_lng`,`max_lat`\n\n      if typeof req.query.bbox is 'string' and req.query.bbox.split(',').length is 4\n        bbox = req.query.bbox.split(',')\n        bbox[i] = parseFloat(val) for val, i in bbox\n\n        query.geojson =\n          '$geoWithin':\n            '$geometry':\n              type: 'Polygon'\n              coordinates: [[\n                [bbox[0], bbox[1]]\n                [bbox[2], bbox[1]]\n                [bbox[2], bbox[3]]\n                [bbox[0], bbox[3]]\n                [bbox[0], bbox[1]]\n              ]]\n\n### ?privat.`String`=`String`\n\nThis allows the user to filter documents based on private document properties.\nThis will autumaticly limit returned documents to those owned by the current\nuser.\n\n#### ToDo\n\n * Limit number of private fields?\n * Limit depth of private fields?\n\n`NB` This section is looping through all of the url query parameters and hence\nshould take the queries from above sections into concideration so we don't need\nto do double amount of work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b4e13b294df81f0ee1f6fcd09da300328a3a8821","subject":"pretty decent initial test.","message":"pretty decent initial test.\n","repos":"kittens\/coffee-script,Geoion\/coffee-script,Infowatch\/coffee-script,AndersonFirmino\/coffeescript,EmielM\/blackcoffee,PencilCode\/pencil-coffee-script,lieuwex\/coffeescript-to-typescript,davidbau\/coffee-script,casidiablo\/coffeescript,DylanPiercey\/coffeescript,jjoos\/coffee-script,alxarch\/coffeescript,ardha2008\/coffeescript,jashkenas\/coffeescript,guzhaoyuan\/coffee-script,longjl\/coffeescript,mrmowgli\/coffeescript,mekuriam\/coffeescript,protez\/coffee-script,legokichi\/typecoffee,kittens\/coffee-script,pagreczner\/express-coffee,connec\/coffeescript,aslihandincer\/coffeescript,helixbass\/copheescript,jamesknelson\/coffee-script,GabrielRatener\/coffeescript-next,legokichi\/typecoffee,DylanPiercey\/coffeescript,sqlwwx\/coffeescript-zh,MartyIX\/coffeescript-to-typescript,maowug\/coffeescript,mikeyhew\/coffeescript-await-transform,shimaore\/cake,kannannilakantaayyar\/coffeescript,pagreczner\/express-coffee,princejwesley\/coffeescript,shihang0001\/coffee-script,behind2\/coffee-script,mikeyhew\/coffeescript-await-transform,AndersonFirmino\/coffeescript,xixixao\/coffee-script,coffee-void\/coffeescript,helixbass\/copheescript,youleiy\/coffee-script,sjbarag\/coffeescript,paiq\/blackcoffee,ASnow\/coffeescript,SonOfLilit\/coffeescript,jjoos\/coffee-script,will-weiss\/coffeescript,aslihandincer\/coffeescript,lbeschastny\/coffeescript,schory\/coffee-script,tonghuashuai\/coffee-script,charlieflowers\/coffee-script,coffee-js\/coffee-script,sombr\/coffeescript,ls2uper\/coffeescript,sebmck\/coffee-script,tvanderbruggen\/coffeescript,stanly-johnson\/coffeescript,FrancoCotter\/coffeescript,kidaa\/coffeescript,kyroskoh\/coffee-script,beni55\/coffee-script,maowug\/coffeescript,helixbass\/copheescript,GabrielRatener\/coffeescript-next,sidthekidder\/coffee-script,isaacs\/coffee-script,schory\/coffee-script,akavi\/CoffeeAF,angeliaz\/coffeescript,lydell\/coffee-script,ambrusc\/coffee-script,hgGeorg\/coffee-script,shihang0001\/coffee-script,casidiablo\/coffeescript,guzhaoyuan\/coffee-script,alubbe\/coffee-script,princejwesley\/coffeescript,kidaa\/coffeescript,GabrielRatener\/coffeescript-next,jiangmiao\/toffee-script,Kingson4Wu\/coffee-script,tempbottle\/coffeescript,292388900\/coffee-script,flaing\/coffeescript,wangyue-ramy\/coffeescript,hgGeorg\/coffee-script,tvanderbruggen\/coffeescript,jamesknelson\/coffee-script,behind2\/coffee-script,chaosim\/coffee-script,youleiy\/coffee-script,DoriKal\/coffeescript,DoriKal\/coffeescript,jobedom\/coffee-script,lydell\/coffee-script,sombr\/coffeescript,cosmicexplorer\/coffeescript,mekuriam\/coffeescript,chaosim\/coffee-script,shimaore\/cake,coffee-js\/coffee-script,rev22\/reflective-coffeescript,TobiaszCudnik\/coffeescript-to-typescript,jokerhing\/coffeescript,alubbe\/coffee-script,abbshr\/coffeescript,alxarch\/coffeescript,ambrusc\/coffee-script,jjoos\/coffee-script,SonOfLilit\/coffeescript,Kingson4Wu\/coffee-script,isaacs\/coffee-script,kyroskoh\/coffee-script,beni55\/coffee-script,protez\/coffee-script,maxtaco\/coffee-script,lieuwex\/coffeescript-to-typescript,ASnow\/coffeescript,ls2uper\/coffeescript,rev22\/reflective-coffeescript,will-weiss\/coffeescript,sqlwwx\/coffeescript-zh,coffee-void\/coffeescript,PencilCode\/pencil-coffee-script,jobedom\/coffee-script,Geoion\/coffee-script,jokerhing\/coffeescript,davidbau\/coffee-script,connec\/coffeescript,jiangmiao\/toffee-script,longjl\/coffeescript,EmielM\/blackcoffee,FrancoCotter\/coffeescript,angeliaz\/coffeescript,bobcassels\/pencil-coffee-script,yjerem\/coffee-script,bobcassels\/pencil-coffee-script,Infowatch\/coffee-script,helixbass\/copheescript,tonghuashuai\/coffee-script,yjerem\/coffee-script,lbeschastny\/coffeescript,292388900\/coffee-script,maxtaco\/coffee-script,kannannilakantaayyar\/coffeescript,charlieflowers\/coffee-script,tempbottle\/coffeescript,MartyIX\/coffeescript-to-typescript,jiangmiao\/toffee-script,wangyue-ramy\/coffeescript,decaffeinate\/coffeescript,stanly-johnson\/coffeescript,TobiaszCudnik\/coffeescript-to-typescript,sebmck\/coffee-script,ardha2008\/coffeescript,shreeve\/coffeescript,abbshr\/coffeescript,TobiaszCudnik\/coffeescript-to-typescript,sidthekidder\/coffee-script","old_file":"test\/literate.litcoffee","new_file":"test\/literate.litcoffee","new_contents":"Literate CoffeeScript Test\n--------------------------\n\ncomment comment\n\n    test \"basic literate CoffeeScript parsing\", ->\n      ok yes\n      \nnow with a...\n  \n    test \"broken up indentation\", ->\n    \n... broken up ...\n\n      do ->\n      \n... nested block.\n\n        ok yes\n        \nCode in `backticks is not parsed` and...\n\n    test \"comments in indented blocks work\", ->\n      do ->\n        do ->\n          # Regular comment.\n          \n          ###\n            Block comment.\n          ###\n          \n          ok yes\n          \nRegular [Markdown](http:\/\/example.com\/markdown) features, like links \nand unordered lists, are fine:\n\n  * I \n  \n  * Am\n  \n  * A\n  \n  * List","old_contents":"comment comment\n\n    test \"basic literate CoffeeScript parsing\", ->\n      ok yes\n      \nnow with a...\n  \n    test \"broken up indentation\", ->\n    \n... broken up ...\n\n      do ->\n      \n... nested block.\n\n        ok yes\n        \nCode in `backticks is not parsed` and...\n\n    test \"comments in indented blocks work\", ->\n      do ->\n        do ->\n          # Regular comment.\n          \n          ###\n            Block comment.\n          ###\n          \n          ok yes","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8be2c94603640afd9b5c0392a907e6cc90ad7d22","subject":"use timeKeepAlive to calculate waitTime of deads","message":"use timeKeepAlive to calculate waitTime of deads\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"server\/queueMethods.litcoffee","new_file":"server\/queueMethods.litcoffee","new_contents":"# Super secret queue methods\n\n    @QueueMethods =\n      popAndServeNextTicket: ->\n\nMove the current connection to the processed queue\n\nTODO: get postID\n\n        queueMeta = QueueMeta.findOne()\n\nUpdate object, extended at various point for updating the QueueMeta in one swoop\n\n        update =\n          $set: {}\n\nIf `theOnlyConnectionAllowedIn` is set to something, check if the connection\nhas expired and process the connection if it has.\n\n        if queueMeta.theOnlyConnectionAllowedIn isnt undefined\n\n          previousConnection = queueMeta.theOnlyConnectionAllowedIn\n          previousConnectionDidntPosted = not queueMeta.hasCurrentConnectionPosted\n\nReturn if timeCurrentTicketExpires is in the future (hasn't expired)\n\n          hasntExpired = queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n          return if hasntExpired\n\nOkay then, the current connection has expired, time to get bumped.\nInsert the processed connection into the ProcessedQueue\n\n          try\n\nCalculate how long the connection had to wait in line.\n\n            waitTimeSeconds = moment.utc().diff (moment.utc queueMeta.theOnlyConnectionAllowedIn.timeEnqueued), 'seconds'\n\nMake the processed object.\n\n            processed =\n              connection: queueMeta.theOnlyConnectionAllowedIn\n              waitTimeSeconds: waitTimeSeconds\n\nInsert the processed connection to `QueueProcessed`\n\n            QueueProcessed.insert processed\n          catch err\n            console.log err\n\nRemove the connection from the `Queue`\n\n          criteria = _id: queueMeta.currentlyServingQueueId\n          Queue.remove criteria\n\nUpdate `QueueMeta` stats and ticket number.\n\n          try\n            totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n            currentlyServingTicketNumber = queueMeta.currentlyServingTicketNumber + 1\n            _.extend update.$set,\n              currentlyServingTicketNumber: currentlyServingTicketNumber\n              hasCurrentConnectionPosted: no\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          catch err\n            console.log err\n\nLookup the lowest ticket # waiting in the `Queue`\n\n        nextConnection = Queue.findOne {}, { sort: { 'ticketNumber': 1 } }\n\nSet the allowed connection and expireTime if one exists\n\nIf there is a nextConnection (i.e. someone waiting in line), then serve them.\nOtherwise clear out theOnlyConnectionAllowedIn.\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          _.extend update.$set,\n            theOnlyConnectionAllowedIn: nextConnection\n            timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n            currentlyServingTicketNumber: nextConnection.ticketNumber\n            currentlyServingQueueId: nextConnection._id\n\nIf there is no nextConnection, unset theOnlyConnectionAllowedIn.\nNote, fake data is filled in to pass schema, even though we're $unset'ing\n\n        else\n          update.$unset = theOnlyConnectionAllowedIn: \"\"\n\n        criteria = _id: queueMeta._id\n\nDelete `update.$set` if it's empty\n\n        if _.isEmpty update.$set\n          delete update.$set\n\nIf `update` isn't empty, update!\n\n        if not _.isEmpty update\n          QueueMeta.update criteria, update\n\n\nTODO: keep it DRY; logic isn't exactly shared and want to keep update atomic to\navoid extraneous DDP messages.\n\n## Disconnect dead connections, remove from queue\n\n      cleanUpDeadConnections: ->\n\nA connection is dead if keepAlive > 5 minutes ago\n\n        timeFiveMinutesAgoUtc = moment.utc().subtract('5', 'minutes').toDate()\n        criteria =\n          timeKeepAlive:\n            $lt: timeFiveMinutesAgoUtc\n\n        deadQueue = Queue.find criteria\n        deadQueue.forEach (queue) ->\n          criteria =\n            _id: queue._id\n          Queue.remove criteria\n\nCalculate how long the connection had to wait in line.\n\n          waitTimeSeconds = moment.utc().diff (moment.utc queue.timeKeepAlive), 'seconds'\n\nMake the processed object.\n\n          processed =\n            connection: queue\n            waitTimeSeconds: waitTimeSeconds\n            diconnect: yes\n          QueueProcessed.insert processed\n\n          queueMeta = QueueMeta.findOne()\n\n          totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n\n          criteria =\n            _id: queueMeta._id\n          action =\n            $set:\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          QueueMeta.update criteria, action\n","old_contents":"# Super secret queue methods\n\n    @QueueMethods =\n      popAndServeNextTicket: ->\n\nMove the current connection to the processed queue\n\nTODO: get postID\n\n        queueMeta = QueueMeta.findOne()\n\nUpdate object, extended at various point for updating the QueueMeta in one swoop\n\n        update =\n          $set: {}\n\nIf `theOnlyConnectionAllowedIn` is set to something, check if the connection\nhas expired and process the connection if it has.\n\n        if queueMeta.theOnlyConnectionAllowedIn isnt undefined\n\n          previousConnection = queueMeta.theOnlyConnectionAllowedIn\n          previousConnectionDidntPosted = not queueMeta.hasCurrentConnectionPosted\n\nReturn if timeCurrentTicketExpires is in the future (hasn't expired)\n\n          hasntExpired = queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n          return if hasntExpired\n\nOkay then, the current connection has expired, time to get bumped.\nInsert the processed connection into the ProcessedQueue\n\n          try\n\nCalculate how long the connection had to wait in line.\n\n            waitTimeSeconds = moment.utc().diff (moment.utc queueMeta.theOnlyConnectionAllowedIn.timeEnqueued), 'seconds'\n\nMake the processed object.\n\n            processed =\n              connection: queueMeta.theOnlyConnectionAllowedIn\n              waitTimeSeconds: waitTimeSeconds\n\nInsert the processed connection to `QueueProcessed`\n\n            QueueProcessed.insert processed\n          catch err\n            console.log err\n\nRemove the connection from the `Queue`\n\n          criteria = _id: queueMeta.currentlyServingQueueId\n          Queue.remove criteria\n\nUpdate `QueueMeta` stats and ticket number.\n\n          try\n            totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n            currentlyServingTicketNumber = queueMeta.currentlyServingTicketNumber + 1\n            _.extend update.$set,\n              currentlyServingTicketNumber: currentlyServingTicketNumber\n              hasCurrentConnectionPosted: no\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          catch err\n            console.log err\n\nLookup the lowest ticket # waiting in the `Queue`\n\n        nextConnection = Queue.findOne {}, { sort: { 'ticketNumber': 1 } }\n\nSet the allowed connection and expireTime if one exists\n\nIf there is a nextConnection (i.e. someone waiting in line), then serve them.\nOtherwise clear out theOnlyConnectionAllowedIn.\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          _.extend update.$set,\n            theOnlyConnectionAllowedIn: nextConnection\n            timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n            currentlyServingTicketNumber: nextConnection.ticketNumber\n            currentlyServingQueueId: nextConnection._id\n\nIf there is no nextConnection, unset theOnlyConnectionAllowedIn.\nNote, fake data is filled in to pass schema, even though we're $unset'ing\n\n        else\n          update.$unset = theOnlyConnectionAllowedIn: \"\"\n\n        criteria = _id: queueMeta._id\n\nDelete `update.$set` if it's empty\n\n        if _.isEmpty update.$set\n          delete update.$set\n\nIf `update` isn't empty, update!\n\n        if not _.isEmpty update\n          QueueMeta.update criteria, update\n\n\nTODO: keep it DRY; logic isn't exactly shared and want to keep update atomic to\navoid extraneous DDP messages.\n\n## Disconnect dead connections, remove from queue\n\n      cleanUpDeadConnections: ->\n\nA connection is dead if keepAlive > 5 minutes ago\n\n        timeFiveMinutesAgoUtc = moment.utc().subtract('5', 'minutes').toDate()\n        criteria =\n          timeKeepAlive:\n            $lt: timeFiveMinutesAgoUtc\n\n        deadQueue = Queue.find criteria\n        deadQueue.forEach (queue) ->\n          criteria =\n            _id: queue._id\n          Queue.remove criteria\n\nCalculate how long the connection had to wait in line.\n\n          waitTimeSeconds = moment.utc().diff (moment.utc queue.timeEnqueued), 'seconds'\n\nMake the processed object.\n\n          processed =\n            connection: queue\n            waitTimeSeconds: waitTimeSeconds\n            diconnect: yes\n          QueueProcessed.insert processed\n\n          queueMeta = QueueMeta.findOne()\n\n          totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n\n          criteria =\n            _id: queueMeta._id\n          action =\n            $set:\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          QueueMeta.update criteria, action\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4c0b60a5f4c34abe681cfe594aceb83b52fd2450","subject":"Fix the display selection logic to account for the day schedule","message":"Fix the display selection logic to account for the day schedule\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/display-select.litcoffee","new_file":"src\/coffee\/display-select.litcoffee","new_contents":"Display Selection\n=================\n\nThe display selector -- as its name probably suggests -- selects what to display\non screen, other than overrides taking priority.\n\nCore Logic\n----------\n\nWe structure the core logic as a simple series of conditionals.\n\n    selectedDisplay = (state) ->\n\nIf the kill mode is active, we display a no entry sign on all displays.\n\nAs an exception, judges' displays are not public-facing: on those\nwe display the origin of the kill.\n\n        return 'no-entry' if state.kill? unless state.mode is 'judge'\n        return 'kill-origin' if state.kill? and state.mode is 'judge'\n\nFor the judge's display, give the selection from the keyboard.\n\n        return state.judgeSelection if state.mode is 'judge'\n\nFor info displays, alternate between the league and timetables based\non the turnover clock - unless an association 3 DS item is active\n(which would indicate prizegiving, where we want to minimise\ndistractions).\n\n        if state.mode is 'info'\n            return 'blank' if state.dsAssociation is 3\n            return 'day-sched' if state.turnover is 0\n            return 'match-sched' if state.turnover is 1\n            if state.turnover is 2\n                return 'knockout-state' if state.dsAssociation is 2\n                return 'league-state'\n\nFor zones, we display the zone layout during match time, and blank\nduring association 3 items, otherwise the default display.\n\n        if state.mode is 'zone'\n            return 'zone' if state.dsAssociation in [1, 2]\n            return 'blank' if state.dsAssociation is 3\n            return 'default'\n\nFor layout-mode displays, we display the layout layout during\nmatches, and blank during association 3 items -- otherwise the arena\nwelcome sign.\n\n        if state.mode is 'layout'\n            return 'layout' if state.dsAssociation in [1, 2]\n            return 'blank' if state.dsAssociation is 3\n            return 'arena-entrance'\n\nFor blank displays, always show blank.\n\n        return 'blank' if state.mode is 'blank'\n\nIn all other cases, fall back to the default view.\n\n        return 'default'\n\nPublic Property\n---------------\n\nFirst, we define the *data source*, which combines all the streams which the\ndisplay selector uses as input.\n\n    dataSource = Bacon.combineTemplate\n                     mode: Data.mode,\n                     kill: Data.killState\n                     judgeSelection: window.JudgeSelection\n                     turnover: window.Turnover.map((x) -> x % 3)\n                     dsAssociation: window.CurrentDSAssociation\n\nWe then use *selectedDisplay* to map the data source, followed by\na final pass to skip duplicates, so that we do not flap display\nmodes.\n\n    window.SelectedDisplay = dataSource.map(selectedDisplay)\n                                       .skipDuplicates()\n\n\n","old_contents":"Display Selection\n=================\n\nThe display selector -- as its name probably suggests -- selects what to display\non screen, other than overrides taking priority.\n\nCore Logic\n----------\n\nWe structure the core logic as a simple series of conditionals.\n\n    selectedDisplay = (state) ->\n\nIf the kill mode is active, we display a no entry sign on all displays.\n\nAs an exception, judges' displays are not public-facing: on those\nwe display the origin of the kill.\n\n        return 'no-entry' if state.kill? unless state.mode is 'judge'\n        return 'kill-origin' if state.kill? and state.mode is 'judge'\n\nFor the judge's display, give the selection from the keyboard.\n\n        return state.judgeSelection if state.mode is 'judge'\n\nFor info displays, alternate between the league and timetables based\non the turnover clock.\n\n        if state.mode is 'info'\n            return 'match-sched' if state.turnover is 0\n            return 'league-state' if state.turnover is 1\n            return 'day-sched' if state.turnover is 2\n\nIn all other cases, fall back to the default view.\n\n        return 'default'\n\nPublic Property\n---------------\n\nFirst, we define the *data source*, which combines all the streams which the\ndisplay selector uses as input.\n\n    dataSource = Bacon.combineTemplate\n                     mode: Data.mode,\n                     kill: Data.killState\n                     judgeSelection: window.JudgeSelection\n                     turnover: window.Turnover.map((x) -> x % 3)\n\nWe then use *selectedDisplay* to map the data source, followed by\na final pass to skip duplicates, so that we do not flap display\nmodes.\n\n    window.SelectedDisplay = dataSource.map(selectedDisplay)\n                                       .skipDuplicates()\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"761a6556644c79cbdcda5e5bb9f409fe916d743b","subject":"revert primary change detection up the tree","message":"revert primary change detection up the tree\n","repos":"corenova\/yang-js","old_file":"src\/container.litcoffee","new_file":"src\/container.litcoffee","new_contents":"# Container - controller of object properties\n\n## Class Container\n\n    debug = require('debug')('yang:container')\n    delegate = require 'delegates'\n    Emitter  = require('events').EventEmitter\n    Property = require('.\/property')\n    kProp = Symbol.for('property')\n\n    class Container extends Property\n\n      constructor: ->\n        super arguments...\n        @state.children = new Map\n        @state.changes = new Set\n        Object.setPrototypeOf @state, Emitter.prototype\n        \n      delegate @prototype, 'state'\n        .getter 'children'\n        .getter 'changes'\n        .method 'once'\n        .method 'on'\n        .method 'off'\n        .method 'emit'\n\n      @property 'props',\n        get: -> Array.from(@children.values())\n\n      @property 'changed',\n        get: -> @changes.size > 0 or @state.changed\n\n      @property 'data',\n        set: (value) -> @set value, { force: true }\n        get: ->\n          value = switch\n            when @binding?.get? then @binding.get @context\n            else @value\n          \n          return value unless value instanceof Object\n          \n          new Proxy value,\n            has: (obj, key) => @children.has(key) or key of obj\n            get: (obj, key) => switch\n              when key is kProp then this\n              when key is 'toJSON' then @toJSON.bind(this)\n              when @children.has(key) then @children.get(key).data\n              when key of obj then obj[key]\n              when key is 'inspect' then @toJSON.bind(this)\n              when key of this and typeof @[key] is 'function' then @[key].bind(this)\n            set: (obj, key, value) => switch\n              when @children.has(key) then @children.get(key).set(value)\n              else obj[key] = value\n            deleteProperty: (obj, key) => switch\n              when @children.has(key) then @children.get(key).delete()\n              when key of obj then delete obj[key]\n      \n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed and @changes.size\n            obj = {}\n            obj[prop.name] = prop.change for prop in Array.from(@changes)\n            obj\n          when @changed then @data\n\n      clone: ->\n        copy = super children: new Map, changes: new Set\n        copy.add prop.clone(parent: copy) for prop in @props\n        return copy\n\n      debug: -> debug @uri, arguments...\n\n### add (child)\n\nThis call is used to add a child property to map of children.\n\n      add: (child) ->\n        @children.set child.name, child\n        if @value?\n          Object.defineProperty @value, child.name,\n            configurable: true\n            enumerable: child.active\n\n### remove (child)\n\nThis call is used to remove a child property from map of children.\n\n      remove: (child) ->\n        @children.delete child.name\n        if @value?\n          delete @value[child.name]\n\n### get (key)\n\n      get: (key) -> switch\n        when key? and @children.has(key) then @children.get(key).data\n        else super arguments...\n\n### set (obj, opts)\n\n      set: (obj, opts={}) ->\n        @children.clear()\n        @changes.clear()\n        # TODO: should we also clear Object.defineProperties?\n        try obj = Object.assign {}, obj if kProp of obj\n        super obj, opts\n\n### merge (obj, opts)\n\nEnumerate key\/value of the passed in `obj` and merge into known child\nproperties.\n\n      merge: (obj, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if obj is null\n        return @set obj, opts if opts.replace or not @value?\n        \n        # TODO: protect this as a transaction?\n        { deep = true } = opts\n\n        subopts = Object.assign {}, opts, inner: true, replace: not deep\n        for own k, v of obj\n          @debug \"[merge] looking for #{k} inside #{@children.size} children\"\n          prop = @children.get(k) ? @in(k)\n          continue unless prop? and not Array.isArray(prop)\n          @debug \"[merge] applying value to child prop #{prop.name}\"\n          prop.merge(v, subopts)\n        @update @value, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n\n        if value instanceof Property\n          @debug \"[update] changes.add #{value.name}\"\n          @changes.add value if value.parent is this\n          if opts.inner or opts.origin is this\n            return this\n          # higher up from change origin\n          value = @value\n\n        @debug \"[update] handle #{@changes.size} changed props\"\n        \n        for prop from @changes\n          @add prop, opts\n          @debug \"[update] child #{prop.uri} changed? #{prop.changed}\"\n          @changes.delete prop unless prop.changed\n\n        # we must clear children here if being deleted before calling super (which calls parent.update)\n        @children.clear() if value is null\n        super value, opts\n            \n        @emit 'update', this, opts\n        return this\n\n### commit (opts)\n\nCommits the changes to the data model. Async transaction.\nEvents: commit, change\n\n      commit: (opts={}) ->\n        return true unless @changed\n        \n        if @locked\n          return new Promise (resolve, reject) => @once 'commit', (res) => resolve res\n          \n        @debug \"[commit] #{@changes.size} changes\"\n        try\n          @state.locked = true\n          @state.setMaxListeners(30 + (@changes.size * 2))\n          \n          subopts = Object.assign {}, opts, inner: true\n\n          # 1. traverse down the children\n          await prop.commit subopts for prop from @changes when not prop.locked\n          \n          @debug \"[commit] execute commit binding (if any)...\" unless opts.sync\n          await @binding?.commit? @context.with(opts) unless opts.sync\n\n          # TODO: enable this later after kos stops using a '.' dummy container between module and nodes\n          # opts.origin = this if @changes.size > 1 or not @active\n          opts.origin ?= this\n\n          # 2. traverse up the parent (if has parent)\n          promise = @parent?.commit? opts\n            .then (ok) =>\n              @debug \"[commit] parent returned: #{ok}\"\n              await @revert opts unless ok\n              if ok\n                @emit 'change', opts.origin, opts.actor unless opts.suppress\n                @finalize()\n              @emit 'commit', ok, opts\n              return ok\n          unless promise?\n            @emit 'change', opts.origin, opts.actor unless opts.suppress\n            @finalize()\n            promise = true\n        catch err\n          @debug \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          @emit 'commit', false, opts\n          throw @error err\n        finally\n          @state.locked = false\n\n        return switch\n          when opts.inner then true\n          else Promise.resolve promise\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @debug \"[revert] #{@changes.size} changes\"\n        # below is hackish but works to make a copy of current value\n        # to be used as ctx.prior during revert commit binding call\n        @state.value = @toJSON() \n        await prop.revert opts for prop from @changes\n        @add prop for prop from @changes\n        await super opts\n\n      finalize: ->\n        @changes.clear()\n        super() \n\n### toJSON\n\nThis call creates a new copy of the current `Property.data`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        props = @props\n        value = switch\n          when props.length\n            obj = {}\n            for prop in props when prop.enumerable and (state or prop.mutable)\n              value = prop.toJSON false, state\n              obj[prop.name] = value if value?\n            obj\n          else @value\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        output = super arguments...\n        return Object.assign output, children: @children.size\n        \n    module.exports = Container\n","old_contents":"# Container - controller of object properties\n\n## Class Container\n\n    debug = require('debug')('yang:container')\n    delegate = require 'delegates'\n    Emitter  = require('events').EventEmitter\n    Property = require('.\/property')\n    kProp = Symbol.for('property')\n\n    class Container extends Property\n\n      constructor: ->\n        super arguments...\n        @state.children = new Map\n        @state.changes = new Set\n        Object.setPrototypeOf @state, Emitter.prototype\n        \n      delegate @prototype, 'state'\n        .getter 'children'\n        .getter 'changes'\n        .method 'once'\n        .method 'on'\n        .method 'off'\n        .method 'emit'\n\n      @property 'props',\n        get: -> Array.from(@children.values())\n\n      @property 'changed',\n        get: -> @changes.size > 0 or @state.changed\n\n      @property 'data',\n        set: (value) -> @set value, { force: true }\n        get: ->\n          value = switch\n            when @binding?.get? then @binding.get @context\n            else @value\n          \n          return value unless value instanceof Object\n          \n          new Proxy value,\n            has: (obj, key) => @children.has(key) or key of obj\n            get: (obj, key) => switch\n              when key is kProp then this\n              when key is 'toJSON' then @toJSON.bind(this)\n              when @children.has(key) then @children.get(key).data\n              when key of obj then obj[key]\n              when key is 'inspect' then @toJSON.bind(this)\n              when key of this and typeof @[key] is 'function' then @[key].bind(this)\n            set: (obj, key, value) => switch\n              when @children.has(key) then @children.get(key).set(value)\n              else obj[key] = value\n            deleteProperty: (obj, key) => switch\n              when @children.has(key) then @children.get(key).delete()\n              when key of obj then delete obj[key]\n      \n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed and @changes.size\n            obj = {}\n            obj[prop.name] = prop.change for prop in Array.from(@changes)\n            obj\n          when @changed then @data\n\n      clone: ->\n        copy = super children: new Map, changes: new Set\n        copy.add prop.clone(parent: copy) for prop in @props\n        return copy\n\n      debug: -> debug @uri, arguments...\n\n### add (child)\n\nThis call is used to add a child property to map of children.\n\n      add: (child) ->\n        @children.set child.name, child\n        if @value?\n          Object.defineProperty @value, child.name,\n            configurable: true\n            enumerable: child.active\n\n### remove (child)\n\nThis call is used to remove a child property from map of children.\n\n      remove: (child) ->\n        @children.delete child.name\n        if @value?\n          delete @value[child.name]\n\n### get (key)\n\n      get: (key) -> switch\n        when key? and @children.has(key) then @children.get(key).data\n        else super arguments...\n\n### set (obj, opts)\n\n      set: (obj, opts={}) ->\n        @children.clear()\n        @changes.clear()\n        # TODO: should we also clear Object.defineProperties?\n        try obj = Object.assign {}, obj if kProp of obj\n        super obj, opts\n\n### merge (obj, opts)\n\nEnumerate key\/value of the passed in `obj` and merge into known child\nproperties.\n\n      merge: (obj, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if obj is null\n        return @set obj, opts if opts.replace or not @value?\n        \n        # TODO: protect this as a transaction?\n        { deep = true } = opts\n\n        subopts = Object.assign {}, opts, inner: true, replace: not deep\n        for own k, v of obj\n          @debug \"[merge] looking for #{k} inside #{@children.size} children\"\n          prop = @children.get(k) ? @in(k)\n          continue unless prop? and not Array.isArray(prop)\n          @debug \"[merge] applying value to child prop #{prop.name}\"\n          prop.merge(v, subopts)\n        @update @value, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n\n        if value instanceof Property\n          @debug \"[update] changes.add #{value.name}\"\n          @changes.add value if value.parent is this\n          if opts.inner or opts.origin is this\n            return this\n          # higher up from change origin\n          value = @value\n\n        @debug \"[update] handle #{@changes.size} changed props\"\n        \n        for prop from @changes\n          @add prop, opts\n          @debug \"[update] child #{prop.uri} changed? #{prop.changed}\"\n          @changes.delete prop unless prop.changed\n\n        # we must clear children here if being deleted before calling super (which calls parent.update)\n        @children.clear() if value is null\n        super value, opts\n            \n        @emit 'update', this, opts\n        return this\n\n### commit (opts)\n\nCommits the changes to the data model. Async transaction.\nEvents: commit, change\n\n      commit: (opts={}) ->\n        return true unless @changed\n        \n        if @locked\n          return new Promise (resolve, reject) => @once 'commit', (res) => resolve res\n          \n        @debug \"[commit] #{@changes.size} changes\"\n        try\n          @state.locked = true\n          @state.setMaxListeners(30 + (@changes.size * 2))\n          \n          subopts = Object.assign {}, opts, inner: true\n\n          # 1. traverse down the children\n          await prop.commit subopts for prop from @changes when not prop.locked\n          \n          @debug \"[commit] execute commit binding (if any)...\" unless opts.sync\n          await @binding?.commit? @context.with(opts) unless opts.sync\n\n          opts.origin = this if @changes.size > 1 or not @active\n          opts.origin ?= this\n\n          # 2. traverse up the parent (if has parent)\n          promise = @parent?.commit? opts\n            .then (ok) =>\n              @debug \"[commit] parent returned: #{ok}\"\n              await @revert opts unless ok\n              if ok\n                @emit 'change', opts.origin, opts.actor unless opts.suppress\n                @finalize()\n              @emit 'commit', ok, opts\n              return ok\n          unless promise?\n            @emit 'change', opts.origin, opts.actor unless opts.suppress\n            @finalize()\n            promise = true\n        catch err\n          @debug \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          @emit 'commit', false, opts\n          throw @error err\n        finally\n          @state.locked = false\n\n        return switch\n          when opts.inner then true\n          else Promise.resolve promise\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @debug \"[revert] #{@changes.size} changes\"\n        # below is hackish but works to make a copy of current value\n        # to be used as ctx.prior during revert commit binding call\n        @state.value = @toJSON() \n        await prop.revert opts for prop from @changes\n        @add prop for prop from @changes\n        await super opts\n\n      finalize: ->\n        @changes.clear()\n        super() \n\n### toJSON\n\nThis call creates a new copy of the current `Property.data`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        props = @props\n        value = switch\n          when props.length\n            obj = {}\n            for prop in props when prop.enumerable and (state or prop.mutable)\n              value = prop.toJSON false, state\n              obj[prop.name] = value if value?\n            obj\n          else @value\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        output = super arguments...\n        return Object.assign output, children: @children.size\n        \n    module.exports = Container\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"676b5a06b90134fb87c9c6d87a4ed7f67960fe6f","subject":"style","message":"style\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/08_app.litcoffee","new_file":"docs\/08_app.litcoffee","new_contents":"# Batman.App\n\n`Batman.App` is the central object in any Batman application. It manages the routing table and the current URL parameters, as well as the initial start of the application. It should also be used as a namespace for models and views so that other objects can find them. Batman assumes that there will only ever be one `Batman.App` in use at once.\n\n## Batman.currentApp\n\nA Batman-wide reference to the currently running `Batman.App`.\n\n## @run() : App\n\n`App.run` is the central entry point for a Batman application. `@run` takes these steps to initialize a Batman application:\n\n 1. Instantiate a `Dispatcher`, an internal object for mananging action dispatch to controllers.\n 2. Instantiate a `Navigator`, an internal object for managing the URL via pushState or hashbangs.\n 3. Instantiate the `layout` view according to the `layout` property on the `App`.\n 4. Wait for the layout view to fire it's `ready` event.\n 5. Start the first action dispatch by telling the `Navigator` to begin monitoring the URL.\n\n_Note_: `@run` emits the `run` class event on the `App`, but not necessarily as soon as `@run` is called. Because the `layout` View renders asynchronously and may need to fetch other components, the `run` event can and often does fire long after `@run` is called. If you need to execute code as soon as the `App` has started running, add a listener to the `run` event on the `App` class. If you need to execute code as soon as the layout has rendered, you can use the `ready` event on the `App` class.\n\n`@run` can be called before or on the `load` DOMEvent of the window. `@run` will return the App if the commencement was successful and complete, or `false` if the App must wait for the `layout` to render or if the `App` has already run.\n\n#### starting an application with DOMEvents\n```coffeescript\nwindow.addEventListener 'load', ->\n  MyApp.run()\n```\n\n#### starting an application with jQuery\n```coffeescript\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\n`@stop` stops the `App` it's called upon. The URL will stop being monitored and no more actions will be dispatched. In usual Batman development you shouldn't have to call this.\n\n## @routes\n\n`@routes` is a class level property referencing the root level `NamedRouteQuery` which allows for binding to routes on objects. See `data-route` bindings for more information.\n\n## @controllers\n\n`@controllers` is a class level property containing the singleton `Batman.Controller` instances for each subclass in the application. This `controllers` directory puts these instances at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`. `@controllers` ideally should never be bound to, but it is very useful for debugging in the console and other such workarounds.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n    test \"Multi-word controller names have a lowercase first letter\", ->\n      class Alfred extends Batman.App\n      class Alfred.ReminderEmailsController extends Batman.Controller\n      controller = Alfred.get('controllers.reminderEmails')\n      equal Batman._functionName(controller.constructor), \"ReminderEmailsController\"\n\n## @layout\n\n`@layout` is the base view of the entire view hierarchy. By default, it will parse any data-* attributes in the entire document, excluding any `data-yield`'s, when `App.run()` is called. Use `MyApp.layout = null` to disable the creation of this default view.\n\n## @currentParams\n\n`@currentParams` contains the URL parameters for the current request, including the path relative to the app's base path (`Batman.config.pathToApp`). Some interesting parts to look at: `@currentParams.controller`, `@currentParams.action`.\n\n## @paramsManager\n## @paramsPusher\n\n## 'run' class event\n\nThe `run` class event is fired once the app has run. This indeterminately but often happens before the app's layout has finished rendering.\n\n## 'ready' class event\n\nThe `ready` class event is fired once the app's layout is rendered.\n\n# Batman.App Routing\n\nThe `Batman` routing DSL is similar to Rails 3's routing DSL. It is oriented around the notion of a resource:\n\n## @route\n\n`@route` defines a custom route and can be pointed to a controller action directly. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @route 'comments', 'pages#comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/comments` being added to the routing map, pointed to `PagesController#comments`.\n\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n`@resources` is modeled after the Rails routing `resources` method. It automatically defines some routes and matches them to controller actions. For example,\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages'\n\nclass App.PagesController extends Batman.Controller\n  index: ->\n    # ...\n  new: ->\n    # ...\n  show: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n  edit: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n```\n\nWill set up these routes:\n\nPath | Controller Action | View binding\n-- | -- | -- |\n\/pages | App.PagesController#index | `data-route=\"routes.pages\"`\n\/pages\/new | App.PagesController#new | `data-route=\"routes.pages.new\"`\n\/pages\/:id | App.PagesController#show | `data-route=\"routes.pages[currentPage]\"`\n\/pages\/:id\/edit | App.PagesController#edit | `data-route=\"routes.pages[currentPage].edit\"`\n\nOf course, `destroy`, `update`, and `create` are not performed by controller actions in Batman. Instead, call `save` or `destroy` on your records.\n\n### Nested Resources\n\nYou may also nest resources, as in Rails:\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages', ->\n    @resources 'comments'\n```\n\nWill set up these routes for `App.Comment`:\n\nPath | Controller Action | View binding\n-- | -- | -- |\n\/pages\/:page_id\/comments | App.CommentsController#index | `data-route=\"routes.pages[currentPage].comments\"`\n\/pages\/:page_id\/comments\/new | App.CommentsController#new | `data-route=\"routes.pages[currentPage].comments.new\"`\n\/pages\/:page_id\/comments\/:id | App.CommentsController#show | `data-route=\"routes.pages[currentPage].comments[currentComment]\"`\n\/pages\/:page_id\/comments\/:id\/edit | App.CommentsController#edit | `data-route=\"routes.pages[currentPage].comments[currentComment].edit\"`\n\n\n## @member\n\n`@member` defines a routable action you can call on a specific instance of a member of a collection resource. For example, if you have a collection of `Page` resources, and a user can post a comment on a specific page:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @member 'comment'\n\nclass Example.PagesController extends Batman.Controller\n  comment: (params) ->\n```\n\nWould result in `\/pages\/:id\/comment` being added to the routing map, pointed to `PagesController#comment`.\n\n## @collection\n\n`@collection` is similar to `@member` in that it adds routable actions to a `@resources` set of routes. In this case the action would apply to the entire collection. For example, if you have a list of spam comments made across _all_ your `Page` resources:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @collection 'spam_comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/pages\/spam_comments` being added to the routing map, pointed to `PagesController#spam_comments`.\n\n## @root\n\n`@root` defines the root controller and action to be used when visiting the base application URL. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @root 'pages#index'\n\nclass Example.PagesController extends Batman.Controller\n  index: ->\n```\n\nWould result in `\/` being pointed to `PagesController#index`.","old_contents":"# Batman.App\n\n`Batman.App` is the central object in any Batman application. It manages the routing table and the current URL parameters, as well as the initial start of the application. It should also be used as a namespace for models and views so that other objects can find them. Batman assumes that there will only ever be one `Batman.App` in use at once.\n\n## Batman.currentApp\n\nA Batman-wide reference to the currently running `Batman.App`.\n\n## @run() : App\n\n`App.run` is the central entry point for a Batman application. `@run` takes these steps to initialize a Batman application:\n\n 1. Instantiate a `Dispatcher`, an internal object for mananging action dispatch to controllers.\n 2. Instantiate a `Navigator`, an internal object for managing the URL via pushState or hashbangs.\n 3. Instantiate the `layout` view according to the `layout` property on the `App`.\n 4. Wait for the layout view to fire it's `ready` event.\n 5. Start the first action dispatch by telling the `Navigator` to begin monitoring the URL.\n\n_Note_: `@run` emits the `run` class event on the `App`, but not necessarily as soon as `@run` is called. Because the `layout` View renders asynchronously and may need to fetch other components, the `run` event can and often does fire long after `@run` is called. If you need to execute code as soon as the `App` has started running, add a listener to the `run` event on the `App` class. If you need to execute code as soon as the layout has rendered, you can use the `ready` event on the `App` class.\n\n`@run` can be called before or on the `load` DOMEvent of the window. `@run` will return the App if the commencement was successful and complete, or `false` if the App must wait for the `layout` to render or if the `App` has already run.\n\n#### starting an application with DOMEvents\n```coffeescript\nwindow.addEventListener 'load', ->\n  MyApp.run()\n```\n\n#### starting an application with jQuery\n```coffeescript\n$ ->\n  MyApp.run()\n```\n\n## @stop() : App\n\n`@stop` stops the `App` it's called upon. The URL will stop being monitored and no more actions will be dispatched. In usual Batman development you shouldn't have to call this.\n\n## @routes\n\n`@routes` is a class level property referencing the root level `NamedRouteQuery` which allows for binding to routes on objects. See `data-route` bindings for more information.\n\n## @controllers\n\n`@controllers` is a class level property containing the singleton `Batman.Controller` instances for each subclass in the application. This `controllers` directory puts these instances at the lowercase name of the controller. For example, the `TodosController` would be found at `controllers.todos`. `@controllers` ideally should never be bound to, but it is very useful for debugging in the console and other such workarounds.\n\n    test \"App.controllers references a directory of controller instances\", ->\n      class Alfred extends Batman.App\n      class Alfred.TodosController extends Batman.Controller\n      controller = Alfred.get('controllers.todos')\n      equal Batman._functionName(controller.constructor), \"TodosController\"\n\n    test \"Multi-word controller names have a lowercase first letter\", ->\n      class Alfred extends Batman.App\n      class Alfred.ReminderEmailsController extends Batman.Controller\n      controller = Alfred.get('controllers.reminderEmails')\n      equal Batman._functionName(controller.constructor), \"ReminderEmailsController\"\n\n## @layout\n\n`@layout` is the base view of the entire view hierarchy. By default, it will parse any data-* attributes in the entire document, excluding any `data-yield`'s, when `App.run()` is called. Use `MyApp.layout = null` to disable the creation of this default view.\n\n## @currentParams\n\n`@currentParams` contains the URL parameters for the current request, including the path relative to the app's base path (`Batman.config.pathToApp`). Some interesting parts to look at: `@currentParams.controller`, `@currentParams.action`.\n\n## @paramsManager\n## @paramsPusher\n\n## 'run' class event\n\nThe `run` class event is fired once the app has run. This indeterminately but often happens before the app's layout has finished rendering.\n\n## 'ready' class event\n\nThe `ready` class event is fired once the app's layout is rendered.\n\n# Batman.App Routing\n\nThe `Batman` routing DSL is similar to Rails 3's routing DSL. It is oriented around the notion of a resource:\n\n## @route\n\n`@route` defines a custom route and can be pointed to a controller action directly. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @route 'comments', 'pages#comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/comments` being added to the routing map, pointed to `PagesController#comments`.\n\n\n## @resources(resourceName : String[, otherResourceNames... : String][, options : Object][, scopedCallback : Function])\n\n`@resources` is modeled after the Rails routing `resources` method. It automatically defines some routes (and matches them to controller actions) for you. For example,\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages'\n\nclass App.PagesController extends Batman.Controller\n  index: ->\n    # ...\n  new: ->\n    # ...\n  show: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n  edit: (params) ->\n    App.Page.find params.id, (err, page) ->\n      @set('currentPage', page)\n```\n\nWill set up these routes:\n\nPath | Controller Action | View binding\n-- | -- | -- |\n\/pages | App.PagesController#index | `data-route=\"routes.pages\"`\n\/pages\/new | App.PagesController#new | `data-route=\"routes.pages.new\"`\n\/pages\/:id | App.PagesController#show | `data-route=\"routes.pages[currentPage]\"`\n\/pages\/:id\/edit | App.PagesController#edit | `data-route=\"routes.pages[currentPage].edit\"`\n\nOf course, `destroy`, `update`, and `create` are not performed by controller actions in Batman. Instead, call `save` or `destroy` on your records.\n\n### Nested Resources\n\nYou may also nest resources, as in Rails:\n\n```coffeescript\nclass App extends Batman.App\n  @resources 'pages', ->\n    @resources 'comments'\n```\n\nWill set up these routes for `App.Comment`:\n\nPath | Controller Action | View binding\n-- | -- | -- |\n\/pages\/:page_id\/comments | App.CommentsController#index | `data-route=\"routes.pages[currentPage].comments\"`\n\/pages\/:page_id\/comments\/new | App.CommentsController#new | `data-route=\"routes.pages[currentPage].comments.new\"`\n\/pages\/:page_id\/comments\/:id | App.CommentsController#show | `data-route=\"routes.pages[currentPage].comments[currentComment]\"`\n\/pages\/:page_id\/comments\/:id\/edit | App.CommentsController#edit | `data-route=\"routes.pages[currentPage].comments[currentComment].edit\"`\n\n\n## @member\n\n`@member` defines a routable action you can call on a specific instance of a member of a collection resource. For example, if you have a collection of `Page` resources, and a user can post a comment on a specific page:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @member 'comment'\n\nclass Example.PagesController extends Batman.Controller\n  comment: (params) ->\n```\n\nWould result in `\/pages\/:id\/comment` being added to the routing map, pointed to `PagesController#comment`.\n\n## @collection\n\n`@collection` is similar to `@member` in that it adds routable actions to a `@resources` set of routes. In this case the action would apply to the entire collection. For example, if you have a list of spam comments made across _all_ your `Page` resources:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @resources 'pages', ->\n    @collection 'spam_comments'\n\nclass Example.PagesController extends Batman.Controller\n  comments: ->\n```\n\nWould result in `\/pages\/spam_comments` being added to the routing map, pointed to `PagesController#spam_comments`.\n\n## @root\n\n`@root` defines the root controller and action to be used when visiting the base application URL. For example:\n\n```coffeescript\nclass window.Example extends Batman.App\n  @root 'pages#index'\n\nclass Example.PagesController extends Batman.Controller\n  index: ->\n```\n\nWould result in `\/` being pointed to `PagesController#index`.","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ddeff53499d69ff17178871a87e485d0f6005458","subject":"throw errors if no onerror","message":"throw errors if no onerror\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        if self.port.onerror?\n         self.port.onerror e\n        else\n         throw e\n      , 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) =>\n       try\n        callbacks.fail? e\n       catch err\n        @onerror? err\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options, @port) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout ->\n       try\n        self.callbacks[options.status] data, options\n       catch e\n        self.port.onerror? e\n      , 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\",\n                      method\n                      data\n                      callbacks\n                      options\n                      this\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) =>\n       try\n        callbacks.fail? e\n       catch err\n        @onerror? err\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"77749a0491c44b125757bb408878cce4612e7377","subject":"minor commenting change","message":"minor commenting change\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object[Symbol.for('property')]` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property') # if process.env.DEBUG?\n    co       = require 'co'\n    delegate = require 'delegates'\n    clone    = require 'clone'\n    Emitter  = require('events').EventEmitter\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n    kProp    = Symbol.for('property')\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n        Object.setPrototypeOf @state, Emitter.prototype\n\n        @schema.kind ?= 'anydata'\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n        # expose the BoundThis for the set\/get\n        @set.bound = @get.bound = this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .method 'once'\n        .method 'on'\n        .access 'container'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n        .getter 'prev'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, { force: true, suppress: true }\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'parent', get: -> @container?[kProp]\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n      \n      @property 'children',\n        get: ->\n          return [] unless @content instanceof Object\n          children = []\n          for own k of @content\n            desc = Object.getOwnPropertyDescriptor(@content, k)\n            children.push desc.get.bound if desc?.get?.bound instanceof Property\n          return children\n      \n      @property 'key',\n        get: ->\n          return unless @schema is @parent?.schema\n          switch\n            when @content not instanceof Object  then @name + 1\n            when @content.hasOwnProperty('@key') then @content['@key']\n            when Array.isArray @container\n              for idx, item of @container when item is @content\n                idx = Number(idx) unless (Number.isNaN (Number idx))\n                return idx+1\n              return undefined\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          key = @key\n          return @state.path if @state.path? and not key?\n          @debug \"[path] #{@kind}(#{@name}) has #{key} #{typeof key}\"\n          entity = switch typeof key\n            when 'number' then \".[#{key}]\"\n            when 'string' then \".[key('#{key}')]\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          @debug \"[path] #{@parent.name} + #{entity}\"\n          return @state.path = @parent.path.clone().append entity\n\n## Instance-level methods\n\n      clone: ->\n        @debug \"[clone] cloning with #{@children.length} properties\"\n        copy = (new @constructor @name, @schema)\n        copy.state[k] = v for k, v of @state\n        return copy\n        \n      emit: (event) ->\n        @state.emit arguments...\n        unless this is @root\n          @debug \"[emit] '#{event}' to '#{@root.name}'\"\n          @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false, force: false }) ->\n        return obj unless obj instanceof Object\n\n        detached = true unless @container?\n        @container = obj\n\n        if Array.isArray(obj) and Array.isArray(@content)\n          @debug @content\n          throw @error \"cannot join array property into list container\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n\n        # if joining for the first time, apply existing data unless explicit replace\n        exists = obj[@name] \n        if detached and opts.replace isnt true\n          @debug \"[join] applying existing data for #{@name} to:\"\n          @debug obj\n          opts.suppress = true\n          @set exists, opts\n\n        # TODO: should produce meaningful warning?\n        try Object.defineProperty obj, @name, this\n        @debug \"[join] attached into #{obj.constructor.name} container\"\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern, prop=false) -> switch\n        when pattern? and prop then @in pattern\n        when pattern?\n          try match = @find pattern\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].content\n            when match.length > 1  then match.map (x) -> x.content\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then switch\n          when @binding? then @do.bind this\n          else @content\n        else\n          if @binding? and not (@kind is 'list' and @key?)\n            try return @binding.call @context\n            catch e\n              throw @error \"issue executing registered function binding during get(): #{e.message}\", e\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        @debug \"[set] enter with:\"\n        @debug value\n        #@debug opts\n        return this if value is @content and not opts.force\n\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only element\"\n\n        try\n          unless value instanceof Function\n            if value[kProp] instanceof Property and value[kProp] isnt this\n              @debug \"[set] cloning existing property for assignment\"\n              value = clone(value)\n            value = Object.create(value) unless Object.isExtensible(value)\n          Object.defineProperty value, kProp, configurable: true, value: this\n\n        value = switch\n          when @schema.apply?\n            @schema.apply value, @context.with(opts)\n          else value\n        return this if value instanceof Error\n        try\n          Object.defineProperty value, kProp, value: this\n          Object.defineProperty value, '$', value: @get.bind(this)\n          if @schema.nodes.length and @kind isnt 'module'\n            for own k of value\n              desc = Object.getOwnPropertyDescriptor value, k\n              if desc.writable is true and not @schema.locate(k)?\n                @debug \"[set] hiding non-schema defined property: #{k}\"\n                Object.defineProperty value, k, enumerable: false\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        \n        if @binding?.length is 1 and not opts.force and @kind not in [ 'action', 'rpc' ]\n          try @binding.call @context, value \n          catch e\n            @debug e\n            throw @error \"issue executing registered function binding during set(): #{e.message}\", e\n        else\n          @state.value = value\n\n        try Object.defineProperty @container, @name,\n          configurable: true\n          enumerable: @state.enumerable\n\n        @emit 'update', this if this is @root or not opts.suppress\n        @debug \"[set] completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        opts.replace ?= true\n        unless @content instanceof Object and @kind is 'list'\n          opts.replace = false\n          return @set value, opts\n\n        value = value[@name] if value? and value.hasOwnProperty? @name\n        return this unless value instanceof Object\n        \n        if Array.isArray @content\n          length = @content.length\n          @debug \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          @debug value\n          # here we clone this Property and update with only the newly merged values\n          # XXX - this logic needs refinement, it doesn't handle min-elements condition properly\n          value = [ value ] unless Array.isArray value\n          copy = @clone()\n          copy.set value, force: opts.force, suppress: true\n          @debug \"[merge] combining and applying schema\"\n          if @schema.key? and opts.replace\n            exists = {}\n            @content.forEach (item) ->\n              key = item['@key']\n              exists[key] = item\n            @debug \"[merge] reducing existing keys\"\n            conflicts = 0\n            newitems = copy.content.reduce ((a, item) ->\n              key = item['@key']\n              item[kProp].name -= conflicts\n              if key of exists\n                conflicts++\n                exists[key][kProp].merge item, opts\n              else\n                a.push item\n              return a\n            ), []\n            combine = @content.concat newitems\n          else\n            newitems = copy.content\n            combine = @content.concat newitems\n          attr.apply combine, @context.with(opts) for attr in @schema.attrs\n          newitems.forEach (item) =>\n            item[kProp].name += length\n            item[kProp].join @content, opts\n          @emit 'update', this unless opts.suppress\n          return copy\n        else\n          @debug \"[merge] merging into existing Object(#{Object.keys(@content).length}) for #{@name}\"\n          # TODO: protect this as a transaction?\n          @in(k)?.merge(v, opts) for own k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n          return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        if not @content? and @kind is 'list' and not Array.isArray value\n          value = [ value ] \n        res = @merge value, replace: false\n        @emit 'create', res\n        return res\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@container` parent object.\n      \n      remove: ->\n        return this unless @container?\n        if @key?\n          #@container.splice @name, 1\n          delete @container[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          Object.defineProperty @container, @name, enumerable: false\n        @emit 'update', @parent if @parent?\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        unless pattern instanceof XPath\n          if \/^\\.\\.\\\/\/.test(pattern) and @parent?\n            return @parent.find pattern.replace(\/^\\.\\.\\\/\/, ''), opts\n          if \/^\\\/\/.test(pattern) and this isnt @root\n            return @root.find pattern, opts\n          pattern = XPath.parse pattern, @schema\n          \n        @debug \"[find] using #{pattern}\"\n        if opts.root or not @container? or pattern.tag not in [ '\/', '..' ]\n          @debug \"[find] apply #{pattern}\"\n          @debug @content\n          pattern.apply(@content).props ? []\n        else switch\n          when pattern.tag is '\/'  and @parent? then @parent.find pattern, opts\n          when pattern.tag is '..' and @parent? then @parent.find pattern.xpath, opts\n          else []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n            \n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      invoke: ->\n        console.warn \"DEPRECATION: please use .do() instead\"\n        @do arguments...\n        \n      do: (input={}) ->\n        unless (@binding instanceof Function) or (@content instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        transaction = true if @root.kind is 'module' and @root.transactable isnt true\n        try\n          @debug \"[do] executing method: #{@name}\"\n          @debug input\n          @root.transactable = true if transaction\n          ctx = @context\n          ctx.state[kProp] = this\n          @schema.input?.eval  ctx.state, {}\n          @schema.output?.eval ctx.state, {}\n          ctx.input = input\n          # first apply schema bound function (if availble), otherwise\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\"\n            @debug @binding.toString()\n            res = @binding.call ctx, input\n            ctx.output ?= res\n          else\n            @debug \"[do] calling assigned function: #{@content.name}\"\n            @debug @content.toString()\n            ctx.output = @content.call @container, input\n          return co =>\n            @debug \"[do] evaluating output schema\"\n            ctx.output = yield Promise.resolve ctx.output\n            @debug \"[do] finish setting output\"\n            @emit 'done', ctx\n            if transaction\n              @root.save()\n              @root.transactable = false\n            return ctx.output\n        catch e\n          @debug e\n          if transaction\n            @root.rollback()\n            @root.transactable = false\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        err = new Error \"[#{at}] #{msg}\"\n        err.name = 'PropertyError'\n        err.context = ctx\n        @emit 'error', err, this\n        return err\n\n      debug: (msg) ->\n        if debug? then switch typeof msg\n          when 'object' then debug msg\n          else\n            node = this\n            prefix = [ @name ]\n            prefix.unshift node.name while (node = node.parent)\n            debug \"[#{prefix.join('\/')}] #{msg}\"\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          key:    @key\n          xpath:  @path.toString()\n          schema: @schema.toJSON tag: false, extended: true\n          active: @enumerable\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\ncurrent property's `@name`.\n\n      toJSON: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            for own k, v of src when typeof v isnt 'function'\n              res[k] = copy v\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object[Symbol.for('property')]` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property') # if process.env.DEBUG?\n    co       = require 'co'\n    delegate = require 'delegates'\n    clone    = require 'clone'\n    Emitter  = require('events').EventEmitter\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n    kProp    = Symbol.for('property')\n\n    class Property\n\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n        Object.setPrototypeOf @state, Emitter.prototype\n\n        @schema.kind ?= 'anydata'\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n        # expose the BoundThis for the set\/get\n        @set.bound = @get.bound = this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .method 'once'\n        .method 'on'\n        .access 'container'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n        .getter 'prev'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, { force: true, suppress: true }\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'parent', get: -> @container?[kProp]\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n      \n      @property 'children',\n        get: ->\n          return [] unless @content instanceof Object\n          children = []\n          for own k of @content\n            desc = Object.getOwnPropertyDescriptor(@content, k)\n            children.push desc.get.bound if desc?.get?.bound instanceof Property\n          return children\n      \n      @property 'key',\n        get: ->\n          return unless @schema is @parent?.schema\n          switch\n            when @content not instanceof Object  then @name + 1\n            when @content.hasOwnProperty('@key') then @content['@key']\n            when Array.isArray @container\n              for idx, item of @container when item is @content\n                idx = Number(idx) unless (Number.isNaN (Number idx))\n                return idx+1\n              return undefined\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          key = @key\n          return @state.path if @state.path? and not key?\n          @debug \"[path] #{@kind}(#{@name}) has #{key} #{typeof key}\"\n          entity = switch typeof key\n            when 'number' then \".[#{key}]\"\n            when 'string' then \".[key('#{key}')]\"\n            else switch\n              when @kind is 'list' then @schema.datakey\n              else @name\n          @debug \"[path] #{@parent.name} + #{entity}\"\n          return @state.path = @parent.path.clone().append entity\n\n## Instance-level methods\n\n      clone: ->\n        @debug \"[clone] cloning with #{@children.length} properties\"\n        copy = (new @constructor @name, @schema)\n        copy.state[k] = v for k, v of @state\n        return copy\n        \n      emit: (event) ->\n        @state.emit arguments...\n        unless this is @root\n          @debug \"[emit] '#{event}' to '#{@root.name}'\"\n          @root.emit arguments...\n\n### join (obj)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      join: (obj, opts={ replace: false, suppress: false, force: false }) ->\n        return obj unless obj instanceof Object\n\n        detached = true unless @container?\n        @container = obj\n\n        if Array.isArray(obj) and Array.isArray(@content)\n          @debug @content\n          throw @error \"cannot join array property into list container\"\n        if @kind is 'list' and not Array.isArray(obj) and @content? and not Array.isArray(@content)\n          throw @error \"cannot join non-list array property into containing object\"\n\n        # if joining for the first time, apply existing data unless explicit replace\n        exists = obj[@name] \n        if detached and opts.replace isnt true\n          @debug \"[join] applying existing data for #{@name} to:\"\n          @debug obj\n          opts.suppress = true\n          @set exists, opts\n\n        # TODO: should produce meaningful warning?\n        try Object.defineProperty obj, @name, this\n        @debug \"[join] attached into #{obj.constructor.name} container\"\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern, prop=false) -> switch\n        when pattern? and prop then @in pattern\n        when pattern?\n          try match = @find pattern\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].content\n            when match.length > 1  then match.map (x) -> x.content\n            else undefined\n        when @kind in [ 'rpc', 'action' ] then switch\n          when @binding? then @do.bind this\n          else @content\n        else\n          if @binding? and not (@kind is 'list' and @key?)\n            try return @binding.call @context\n            catch e\n              throw @error \"issue executing registered function binding during get(): #{e.message}\", e\n          @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={ force: false, suppress: false }) ->\n        @debug \"[set] enter with:\"\n        @debug value\n        #@debug opts\n        return this if value is @content and not opts.force\n\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only element\"\n\n        try\n          unless value instanceof Function\n            if value[kProp] instanceof Property and value[kProp] isnt this\n              @debug \"[set] cloning existing property for assignment\"\n              value = clone(value)\n            value = Object.create(value) unless Object.isExtensible(value)\n          Object.defineProperty value, kProp, configurable: true, value: this\n\n        value = switch\n          when @schema.apply?\n            @schema.apply value, @context.with(opts)\n          else value\n        return this if value instanceof Error\n        try\n          Object.defineProperty value, kProp, value: this\n          Object.defineProperty value, '$', value: @get.bind(this)\n          if @schema.nodes.length and @kind isnt 'module'\n            for own k of value\n              desc = Object.getOwnPropertyDescriptor value, k\n              if desc.writable is true and not @schema.locate(k)?\n                @debug \"[set] hiding non-schema defined property: #{k}\"\n                Object.defineProperty value, k, enumerable: false\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        \n        if @binding?.length is 1 and not opts.force and @kind not in [ 'action', 'rpc' ]\n          try @binding.call @context, value \n          catch e\n            @debug e\n            throw @error \"issue executing registered function binding during set(): #{e.message}\", e\n        else\n          @state.value = value\n\n        try Object.defineProperty @container, @name,\n          configurable: true\n          enumerable: @state.enumerable\n\n        @emit 'update', this if this is @root or not opts.suppress\n        @debug \"[set] completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={ replace: true, suppress: false }) ->\n        opts.replace ?= true\n        unless @content instanceof Object and @kind is 'list'\n          opts.replace = false\n          return @set value, opts\n\n        value = value[@name] if value? and value.hasOwnProperty? @name\n        return this unless value instanceof Object\n        \n        if Array.isArray @content\n          length = @content.length\n          @debug \"[merge] merging into existing Array(#{length}) for #{@name}\"\n          @debug value\n          # here we clone this Property and update with only the newly merged values\n          # XXX - this logic needs refinement, it doesn't handle min-elements condition properly\n          value = [ value ] unless Array.isArray value\n          copy = @clone()\n          copy.set value, force: opts.force, suppress: true\n          @debug \"[merge] combining and applying schema\"\n          if @schema.key? and opts.replace\n            exists = {}\n            @content.forEach (item) ->\n              key = item['@key']\n              exists[key] = item\n            @debug \"[merge] reducing existing keys\"\n            conflicts = 0\n            newitems = copy.content.reduce ((a, item) ->\n              key = item['@key']\n              item[kProp].name -= conflicts\n              if key of exists\n                conflicts++\n                exists[key][kProp].merge item, opts\n              else\n                a.push item\n              return a\n            ), []\n            combine = @content.concat newitems\n          else\n            newitems = copy.content\n            combine = @content.concat newitems\n          attr.apply combine, @context.with(opts) for attr in @schema.attrs\n          newitems.forEach (item) =>\n            item[kProp].name += length\n            item[kProp].join @content, opts\n          @emit 'update', this unless opts.suppress\n          return copy\n        else\n          @debug \"[merge] merging into existing Object(#{Object.keys(@content).length}) for #{@name}\"\n          # TODO: protect this as a transaction?\n          @in(k)?.merge(v, opts) for own k, v of value when @content.hasOwnProperty k\n          # TODO: need to reapply schema to self\n          return this\n\n### create (value)\n\nA simple convenience wrap around the above [merge](#merge-value) operation.\n\n      create: (value) ->\n        if not @content? and @kind is 'list' and not Array.isArray value\n          value = [ value ] \n        res = @merge value, replace: false\n        @emit 'create', res\n        return res\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@container` parent object.\n      \n      remove: ->\n        return this unless @container?\n        if @key?\n          #@container.splice @name, 1\n          delete @container[@name]\n        else\n          @state.enumerable = false\n          @state.value = undefined unless @kind is 'list'\n          Object.defineProperty @container, @name, enumerable: false\n        @emit 'update', @parent if @parent?\n        @emit 'delete', this\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        unless pattern instanceof XPath\n          if \/^\\.\\.\\\/\/.test(pattern) and @parent?\n            return @parent.find pattern.replace(\/^\\.\\.\\\/\/, ''), opts\n          if \/^\\\/\/.test(pattern) and this isnt @root\n            return @root.find pattern, opts\n          pattern = XPath.parse pattern, @schema\n          \n        @debug \"[find] using #{pattern}\"\n        if opts.root or not @container? or pattern.tag not in [ '\/', '..' ]\n          @debug \"[find] apply #{pattern}\"\n          @debug @content\n          pattern.apply(@content).props ? []\n        else switch\n          when pattern.tag is '\/'  and @parent? then @parent.find pattern, opts\n          when pattern.tag is '..' and @parent? then @parent.find pattern.xpath, opts\n          else []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n            \n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      invoke: ->\n        console.warn \"DEPRECATION: please use .do() instead\"\n        @do arguments...\n        \n      do: (input={}) ->\n        unless (@binding instanceof Function) or (@content instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        transaction = true if @root.kind is 'module' and @root.transactable isnt true\n        try\n          @debug \"[do] executing method: #{@name}\"\n          @debug input\n          @root.transactable = true if transaction\n          ctx = @context\n          ctx.state[kProp] = this\n          @schema.input?.eval  ctx.state, {}\n          @schema.output?.eval ctx.state, {}\n          ctx.input = input\n          # first apply schema bound function (if availble), then\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\"\n            @debug @binding.toString()\n            res = @binding.call ctx, input\n            ctx.output ?= res\n          else\n            @debug \"[do] calling assigned function: #{@content.name}\"\n            @debug @content.toString()\n            ctx.output = @content.call @container, input\n          return co =>\n            @debug \"[do] evaluating output schema\"\n            ctx.output = yield Promise.resolve ctx.output\n            @debug \"[do] finish setting output\"\n            @emit 'done', ctx\n            if transaction\n              @root.save()\n              @root.transactable = false\n            return ctx.output\n        catch e\n          @debug e\n          if transaction\n            @root.rollback()\n            @root.transactable = false\n          return Promise.reject e\n\n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (msg, ctx=this) ->\n        at = \"#{@path}\"\n        at += @name if at is '\/'\n        err = new Error \"[#{at}] #{msg}\"\n        err.name = 'PropertyError'\n        err.context = ctx\n        @emit 'error', err, this\n        return err\n\n      debug: (msg) ->\n        if debug? then switch typeof msg\n          when 'object' then debug msg\n          else\n            node = this\n            prefix = [ @name ]\n            prefix.unshift node.name while (node = node.parent)\n            debug \"[#{prefix.join('\/')}] #{msg}\"\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          key:    @key\n          xpath:  @path.toString()\n          schema: @schema.toJSON tag: false, extended: true\n          active: @enumerable\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `false` will not tag the produced object with the\ncurrent property's `@name`.\n\n      toJSON: (tag=true) ->\n        copy = (src) ->\n          return unless src? and typeof src isnt 'function'\n          if typeof src is 'object'\n            try res = new src.constructor\n            catch then res = {}\n            for own k, v of src when typeof v isnt 'function'\n              res[k] = copy v\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        value ?= [] if @kind is 'list'\n        if tag\n          name = switch\n            when @kind is 'list' then @schema.datakey\n            else @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"d71736f5a643c03a1d84a18037bcb844aebefc7e","subject":"Fix path","message":"Fix path\n","repos":"mysugr\/bootstrap,mysugr\/bootstrap,mysugr\/bootstrap,mysugr\/bootstrap","old_file":"Gulpfile.litcoffee","new_file":"Gulpfile.litcoffee","new_contents":"Deploy Script for mySugr Bootstrap\n==================================\nThe primary purpose of this script is to provide a well-defined location for the mySugr Bootstrap css file while cache-busting the contents on updates.\n\n## Installing\n\n```\n$ npm install\n```\n\n## Running\n\nThe following environment variables need to be set:\n\n  * `AWS_ACCESS_KEY_ID`\n  * `AWS_SECRET_ACCESS_KEY`\n  * `AWS_REGION`\n\n```\n$ gulp\n```\n\nwill upload the newest `bootstrap.css` to `mysugr-elements.com`.\n\n## Using\n\n```\n<link rel=\"stylesheet\" href=\"\/\/mysugr-elements.com\/bootstrap.css\">\n```\n\n## Technical Implementation Strategy\nWe provide a CSS-files with non-caching headers, namely `bootstrap.css`. This file `@import`s the actual CSS file, which has a hash appended to its filename (for caching) and long expiry headers.\n\n```\n@import \"bootstrap-87fa525a.css\"\n```\n\n### Implementation\n\n    gulp = require 'gulp'\n    gutil= require 'gulp-util'\n    rev  = require 'gulp-rev'\n    s3   = require 'gulp-s3'\n\n    s3Credentials =\n      key:    process.env.AWS_ACCESS_KEY_ID\n      secret: process.env.AWS_SECRET_ACCESS_KEY\n      region: process.env.AWS_REGION\n      bucket: 'mysugr-elements.com'\n\n    s3CacheLong =\n      headers:'cache-control': 'max-age=315360000, no-transform, public'\n\n    s3CacheOff =\n      headers:'cache-control': 'private, max-age=0, no-cache, must-revalidate'\n\n    string_src = (filename, contents)->\n      src = require('stream').Readable objectMode:true\n      src._read = ()->\n        @push new gutil.File cwd: '', base: '', path: filename, contents: new Buffer contents\n        @push null\n      return src\n\n    gulp.task 'deploy:minify',->\n      minifyCss = require 'gulp-minify-css'\n      rename    = require 'gulp-rename'\n\n      gulp.src 'dist\/css\/bootstrap.css'\n      .pipe minifyCss()\n      .pipe rename suffix:'.min'\n      .pipe gulp.dest 'dist\/css\/'\n\n    gulp.task 'deploy:rev',['deploy:minify'],->\n      gulp.src 'dist\/css\/bootstrap.min.css'\n        .pipe rev()\n        .pipe gulp.dest 'dist\/s3'\n        .pipe s3 s3Credentials, s3CacheLong\n        .pipe rev.manifest()\n        .pipe gulp.dest 'dist\/s3'\n\n    gulp.task 'deploy:css', ['deploy:rev'],->\n      rev = require '.\/dist\/s3\/rev-manifest.json'\n      importClause = \"\"\"\n        \/* This file was generated automatically on #{(new Date()).toISOString()} *\/\n        @import \\\"#{rev['bootstrap.min.css']}\\\"\n      \"\"\"\n\n      string_src 'bootstrap.css', importClause\n        .pipe gulp.dest 'dist\/s3'\n        .pipe s3 s3Credentials, s3CacheOff\n\n    gulp.task 'default', ['deploy:css']","old_contents":"Deploy Script for mySugr Bootstrap\n==================================\nThe primary purpose of this script is to provide a well-defined location for the mySugr Bootstrap css file while cache-busting the contents on updates.\n\n## Installing\n\n```\n$ npm install\n```\n\n## Running\n\nThe following environment variables need to be set:\n\n  * `AWS_ACCESS_KEY_ID`\n  * `AWS_SECRET_ACCESS_KEY`\n  * `AWS_REGION`\n\n```\n$ gulp\n```\n\nwill upload the newest `bootstrap.css` to `mysugr-elements.com`.\n\n## Using\n\n```\n<link rel=\"stylesheet\" href=\"\/\/mysugr-elements.com\/bootstrap.css\">\n```\n\n## Technical Implementation Strategy\nWe provide a CSS-files with non-caching headers, namely `bootstrap.css`. This file `@import`s the actual CSS file, which has a hash appended to its filename (for caching) and long expiry headers.\n\n```\n@import \"bootstrap-87fa525a.css\"\n```\n\n### Implementation\n\n    gulp = require 'gulp'\n    gutil= require 'gulp-util'\n    rev  = require 'gulp-rev'\n    s3   = require 'gulp-s3'\n\n    s3Credentials =\n      key:    process.env.AWS_ACCESS_KEY_ID\n      secret: process.env.AWS_SECRET_ACCESS_KEY\n      region: process.env.AWS_REGION\n      bucket: 'mysugr-elements.com'\n\n    s3CacheLong =\n      headers:'cache-control': 'max-age=315360000, no-transform, public'\n\n    s3CacheOff =\n      headers:'cache-control': 'private, max-age=0, no-cache, must-revalidate'\n\n    string_src = (filename, contents)->\n      src = require('stream').Readable objectMode:true\n      src._read = ()->\n        @push new gutil.File cwd: '', base: '', path: filename, contents: new Buffer contents\n        @push null\n      return src\n\n    gulp.task 'deploy:minify',->\n      minifyCss = require 'gulp-minify-css'\n      rename    = require 'gulp-rename'\n\n      gulp.src 'dist\/css\/bootstrap.css'\n      .pipe minifyCss()\n      .pipe rename suffix:'.min'\n      .pipe gulp.dest 'dist\/css\/'\n\n    gulp.task 'deploy:rev',['deploy:minify'],->\n      gulp.src 'dist\/css\/bootstrap.min.css'\n        .pipe rev()\n        .pipe gulp.dest 'dist\/s3'\n        .pipe s3 s3Credentials, s3CacheLong\n        .pipe rev.manifest()\n        .pipe gulp.dest 'dist\/s3'\n\n    gulp.task 'deploy:css', ['deploy:rev'],->\n      rev = require 'dist\/s3\/rev-manifest.json'\n      importClause = \"\"\"\n        \/* This file was generated automatically on #{(new Date()).toISOString()} *\/\n        @import \\\"#{rev['bootstrap.min.css']}\\\"\n      \"\"\"\n\n      string_src 'bootstrap.css', importClause\n        .pipe gulp.dest 'dist\/s3'\n        .pipe s3 s3Credentials, s3CacheOff\n\n    gulp.task 'default', ['deploy:css']","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"dc21c62e12bcd0c7d10de611b2108aaa744e4285","subject":"Cleanup, elegance","message":"Cleanup, elegance\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"client\/packages.litcoffee","new_file":"client\/packages.litcoffee","new_contents":"\nThis is where shrub's package system meets Angular's module system. Packages'\nimplementations of controllers, services, filters, providers, and directives\nare gathered and registered into Angular.\n\n    angular.module('shrub.packages', [\n      'shrub.require'\n      'shrub.pkgman'\n    ])\n\n      .config([\n        '$compileProvider', '$controllerProvider', '$filterProvider'\n        '$injector', '$provide', 'shrub-pkgmanProvider'\n        'shrub-requireProvider'\n        (\n          $compileProvider, $controllerProvider, $filterProvider\n          $injector, $provide, pkgman, {require}\n        ) ->\n\n          config = require 'config'\n          debug = require('debug') 'shrub:angular'\n\nSet an injector so that Angular injection can occur out of band.\n\n          angular_ = require 'angular'\n          angular_.setInjector $injector\n\nInvoke hook `controller`.\nAllows packages to define Angular controllers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          debug 'Registering controllers...'\n\n          for path, injected of pkgman.invoke 'controller'\n            controllerName = pkgman.normalizePath path\n            debug controllerName\n            $controllerProvider.register controllerName, injected\n\n          debug 'Controllers registered.'\n\n          debug 'Registering directives...'\n\nNormalize, augment, and register a directive.\n\n          prepareDirective = (name, path, injected) -> ($injector) ->\n            directive = $injector.invoke injected\n\nEnsure a compilation function exists for the directive, and ensure that by\ndefault it returns the `link` function.\n\n            if angular.isFunction directive\n              directive = link: directive\n              directive.compile = -> directive.link\n            else if not directive.compile\n              directive.compile = -> directive.link\n\nProxy any defined link function, firing any attached any controllers' `link`\nmethod, as well as passing execution on to the original `link` function.\n\n            link = directive.link\n            directive.link = (scope, element, attrs, controllers) ->\n              if controllers?\n                controllers = [controllers] unless angular.isArray controllers\n                controller.link? arguments... for controller in controllers\n\n              link? arguments...\n\nEnsure the directive has a name. Defaults to the normalized path of the\nimplementing package.\n\n            directive.name ?= name\n\nIf controller binding is specified, the controller defaults to the directive\nname. In other words, if you define a directive and a controller in the same\npackage, and specify `directive.bindToController = true`, your directive will\ninclude the controller automatically.\n\n            if directive.bindToController\n              directive.controller ?= directive.name\n\nHandle a bunch of internal Angular normalization.\n\n            directive.require ?= directive.controller and directive.name\n            directive.priority ?= 0\n            directive.restrict ?= 'EA'\n\n            if angular.isObject directive.scope\n              directive.$$isolateBindings = isolateBindingsFor directive\n\nInvoke hook `augmentDirective`.\nAllows packages to augment the directives defined by packages. One example is\nthe automatic relinking functionality implemented by\n[shrub-skin](..\/packages\/shrub-skin\/client\/index.coffee#L12).\n\n            for injectedDirective in pkgman.invokeFlat(\n              'augmentDirective', directive, path\n            )\n              $injector.invoke injectedDirective\n\nHaven't gone deep enough into Angular to understand why this has to be, but it\ndoes.\n\n            directive.index = 0\n            return [directive]\n\nInternal Angular state that we have to reset.\n\n          isolateBindingsFor = (directive) ->\n\n            LOCAL_REGEXP = \/^\\s*([@&]|=(\\*?))(\\??)\\s*(\\w*)\\s*$\/\n\n            bindings = {}\n\n            for scopeName, definition of directive.scope\n              match = definition.match LOCAL_REGEXP\n\n              throw angular.$$minErr('$compile')(\n                'iscp'\n                \"\n                  Invalid isolate scope definition for directive '{0}'.\n                  Definition: {... {1}: '{2}' ...}\n                \"\n                directive.name, scopeName, definition\n              ) unless match\n\n              bindings[scopeName] =\n                mode: match[1][0]\n                collection: match[2] is '*'\n                optional: match[3] is '?'\n                attrName: match[4] or scopeName\n\n            return bindings\n\nInvoke hook `directive`.\nAllows packages to define Angular directives. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          for path, injected of pkgman.invoke 'directive'\n            do (path, injected) ->\n              directiveName = pkgman.normalizePath path\n              debug directiveName\n\nFirst, register it through Angular's normal registration mechanism. This sets\na bunch of internal state we don't have access to.\n\n              $compileProvider.directive directiveName, injected\n\nFollow that by normalizing, augmenting, and registering the directive again.\nIt will run over the previous definition, ensuring everything works nicely.\n\n              $provide.factory \"#{directiveName}Directive\", [\n                '$injector', prepareDirective directiveName, path, injected\n              ]\n\n          debug 'Directives registered.'\n\n          debug 'Registering filters...'\n\nInvoke hook `filter`.\nAllows packages to define Angular filters. Implementations should return a\nfunction.\n\n          for path, injected of pkgman.invoke 'filter'\n            filterName = pkgman.normalizePath path\n            debug filterName\n            $filterProvider.register filterName, injected\n\n          debug 'Filters registered.'\n\nInvoke hook `provider`.\nAllows packages to define Angular providers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          debug 'Registering providers...'\n\n          for path, provider of pkgman.invoke 'provider'\n            debug path\n            $provide.provider path, provider\n\n          debug 'Providers registered.'\n\nInvoke hook `service`.\nAllows packages to define Angular services. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          debug 'Registering services...'\n\n          for path, injected of pkgman.invoke 'service'\n            debug path\n            $provide.service path, injected\n\n          debug 'Services registered.'\n\n      ])\n\nThe module that provides Angular with access to Shrub's package manager.\n\n    angular.module('shrub.pkgman', [\n      'shrub.require'\n    ])\n\n      .provider 'shrub-pkgman', [\n        '$provide', 'shrub-requireProvider'\n        ($provide, {require}) ->\n\n          config = require 'config'\n          debug = require('debug') 'shrub:pkgman'\n          pkgman = require 'pkgman'\n\n          debug 'Loading packages...'\n\nLoad the package list from configuration.\n\n          pkgman.registerPackageList config.get 'packageList'\n\n          debug 'Packages loaded.'\n\nSimply pass along pkgman as the 'service'.\n\n          pkgman.$get = -> pkgman\n\n          return pkgman\n      ]\n","old_contents":"\nThis is where shrub's package system meets Angular's module system. Packages'\nimplementations of controllers, services, filters, providers, and directives\nare gathered and registered into Angular.\n\n    angular.module('shrub.packages', [\n      'shrub.require'\n      'shrub.pkgman'\n    ])\n\n      .config([\n        '$compileProvider', '$controllerProvider', '$filterProvider'\n        '$injector', '$provide', 'shrub-pkgmanProvider'\n        'shrub-requireProvider'\n        (\n          $compileProvider, $controllerProvider, $filterProvider\n          $injector, $provide, pkgman, {require}\n        ) ->\n\n          config = require 'config'\n          debug = require('debug') 'shrub:angular'\n\nSet an injector so that Angular injection can occur out of band.\n\n          angular_ = require 'angular'\n          angular_.setInjector $injector\n\nInvoke hook `controller`.\nAllows packages to define Angular controllers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          debug 'Registering controllers...'\n\n          for path, injected of pkgman.invoke 'controller'\n            controllerName = pkgman.normalizePath path\n            debug controllerName\n            $controllerProvider.register controllerName, injected\n\n          debug 'Controllers registered.'\n\n          debug 'Registering directives...'\n\nNormalize, augment, and register a directive.\n\n          registerDirective = (name, path, injected) -> ($injector) ->\n            directive = $injector.invoke injected\n\nEnsure a compilation function exists for the directive, and ensure that by\ndefault it returns the `link` function.\n\n            if angular.isFunction directive\n              directive = link: directive\n              directive.compile = -> directive.link\n            else if not directive.compile\n              directive.compile = -> directive.link\n\nProxy any defined link function, firing any attached any controllers' `link`\nmethod, as well as passing execution on to the original `link` function.\n\n            link = directive.link\n            directive.link = (scope, element, attrs, controllers) ->\n              if controllers?\n                unless angular.isArray controllers\n                  controllers = [controllers]\n\n                for controller in controllers\n                  controller.link? arguments...\n\n              link? arguments...\n\nEnsure the directive has a name. Defaults to the normalized path of the\nimplementing package.\n\n            directive.name ?= name\n\nIf controller binding is specified, the controller defaults to the directive\nname. In other words, if you define a directive and a controller in the same\npackage, and specify `directive.bindToController = true`, your directive will\ninclude the controller automatically.\n\n            if directive.bindToController\n              directive.controller ?= directive.name\n\nHandle a bunch of internal Angular normalization.\n\n            directive.require ?= directive.controller and directive.name\n            directive.priority ?= 0\n            directive.restrict ?= 'EA'\n\n            if angular.isObject directive.scope\n              directiveIsolateBindings directive\n\nInvoke hook `augmentDirective`.\nAllows packages to augment the directives defined by packages. One example is\nthe automatic relinking functionality implemented by\n[shrub-skin](..\/packages\/shrub-skin\/client\/index.coffee#L12).\n\n            for injectedDirective in pkgman.invokeFlat(\n              'augmentDirective', directive, path\n            )\n              $injector.invoke injectedDirective\n\nHaven't gone deep enough into Angular to understand why this has to be, but it\ndoes.\n\n            directive.index = 0\n            return [directive]\n\nInternal Angular state that we have to reset.\n\n          directiveIsolateBindings = (directive) ->\n\n            LOCAL_REGEXP = \/^\\s*([@&]|=(\\*?))(\\??)\\s*(\\w*)\\s*$\/\n\n            bindings = {}\n\n            for scopeName, definition of directive.scope\n              match = definition.match LOCAL_REGEXP\n\n              unless match\n                throw angular.$$minErr('$compile')(\n                  'iscp'\n                  \"Invalid isolate scope definition for directive\n                  '{0}'. Definition: {... {1}: '{2}' ...}\"\n                  directive.name, scopeName, definition\n                )\n\n              bindings[scopeName] =\n                mode: match[1][0]\n                collection: match[2] is '*'\n                optional: match[3] is '?'\n                attrName: match[4] or scopeName\n\n            directive.$$isolateBindings = bindings\n\nInvoke hook `directive`.\nAllows packages to define Angular directives. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          for path, injected of pkgman.invoke 'directive'\n            do (path, injected) ->\n              directiveName = pkgman.normalizePath path\n\n              debug directiveName\n\nFirst, register it through Angular's normal registration mechanism. This sets\na bunch of internal state we don't have access to.\n\n              $compileProvider.directive directiveName, injected\n\nFollow that by normalizing, augmenting, and registering the directive again.\nIt will run over the previous definition, ensuring everything works nicely.\n\n              $provide.factory \"#{directiveName}Directive\", [\n                '$injector'\n                registerDirective directiveName, path, injected\n              ]\n\n          debug 'Directives registered.'\n\n          debug 'Registering filters...'\n\nInvoke hook `filter`.\nAllows packages to define Angular filters. Implementations should return a\nfunction.\n\n          for path, injected of pkgman.invoke 'filter'\n            filterName = pkgman.normalizePath path\n\n            debug filterName\n\n            $filterProvider.register filterName, injected\n\n          debug 'Filters registered.'\n\nInvoke hook `provider`.\nAllows packages to define Angular providers. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          debug 'Registering providers...'\n\n          for path, provider of pkgman.invoke 'provider'\n            debug path\n\n            $provide.provider path, provider\n\n          debug 'Providers registered.'\n\nInvoke hook `service`.\nAllows packages to define Angular services. Implementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          debug 'Registering services...'\n\n          for path, injected of pkgman.invoke 'service'\n            debug path\n\n            $provide.service path, injected\n\n          debug 'Services registered.'\n\n      ])\n\nThe module that provides Angular with access to Shrub's package manager.\n\n    angular.module('shrub.pkgman', [\n      'shrub.require'\n    ])\n\n      .provider 'shrub-pkgman', [\n        '$provide', 'shrub-requireProvider'\n        ($provide, {require}) ->\n\n          config = require 'config'\n          debug = require('debug') 'shrub:pkgman'\n          pkgman = require 'pkgman'\n\n          debug 'Loading packages...'\n\nLoad the package list from configuration.\n\n          pkgman.registerPackageList config.get 'packageList'\n\n          debug 'Packages loaded.'\n\nSimply pass along pkgman as the 'service'.\n\n          pkgman.$get = -> pkgman\n\n          return pkgman\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d326f6a8e9a340ecc62bd96c2ad768528f70fb3e","subject":"fix inheritance via superstate of boxed methods","message":"fix inheritance via superstate of boxed methods\n","repos":"nickfargo\/restate","old_file":"src\/state.litcoffee","new_file":"src\/state.litcoffee","new_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n\n        @_ or = new @Content\n        @__dispatch_table__ = {}\n\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneCategory   _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method for this state. Providing an optional `out` object\nallows the appropriate `context` for a state-bound method to be delivered as a\nproperty of `out`; if included, `context` is confined to the local state tree.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out, boxed ) ->\n        realized = ~@attributes & VIRTUAL\n\n> During the pseudo-loop block, the `context` reference should be considered\n  provisional, because its potential value is in part a product of the manner\n  in which its accompanying `method` was retrieved. After `break`ing out of the\n  block, `method` can be type-checked and `context` may be kept or discarded as\n  appropriate.\n\n        loop # once\n\nFirst seek the named method locally.\n\n          if realized\n            method = @_?.methods?[ methodName ]\n            if method is rootNoop then method = null\n            if method? then context = this\n            else if record = @__dispatch_table__?[ methodName ]\n              [ method, context ] = record\n            break if method?\n\nIf no method is held locally, start traversing, first up the protostate chain.\nIf this succeeds, the provisional `context` *must be the epistate* inheriting\nthe method (constrast with the `VIA_SUPER` case).\n\n          if ( viaProto = via & VIA_PROTO ) and\n              method = @protostate()?.method methodName, VIA_PROTO, out, yes\n            context = this\n            inherited = yes; break\n\nIf no method is found yet, continue traversing up the superstate chain. If this\nsucceeds, the provisional `context` *must be the superstate* from which the\nmethod is inherited.\n\n          if via & VIA_SUPER and method = @superstate?.method \\\n              methodName, VIA_SUPER | viaProto, out, yes\n            { context } = out if out?\n            inherited = yes; break\n\nThe method cannot be found.\n\n          context = null\n          break # always\n\n        if method?\n\nIf `method` is a function, it is not state-bound, so `context` is unnecessary.\n\n          if typeof method is 'function'\n            context = null\n\nIff `this` is a realized `State`, inherited lookup results can be memoized in\nthe local dispatch table.\n\n          if realized and inherited\n            @__dispatch_table__?[ methodName ] = [ method, context ]\n\nUnbox a state-bound function unless directed otherwise.\n\n          if not boxed and method.type is 'state-bound-function'\n            method = method.fn\n\nExport `method` and `context` together if the `out` reference was provided.\n\n> Callers who know that `method` will be unbound need not provide an `out`.\n\n        if out?\n          out.method = method\n          out.context = context\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state. The provided `fn` may be any of:\n\n  1.  A proper function, which will be called in the context of `@owner`;\n  2.  A boxing of a *bound* function as prepared by `state.bind`, which will\n      cause the boxed function to be called in the context of either `this`\n      `State` or the *epistate* inheriting the method;\n  3.  A boxing of a *fixed* function as prepared by `state.fix`, whose boxed\n      function will be closed over hard references to `this` as `autostate`,\n      and to the *protostate* of `this`, as `protostate`.\n\n> See also: `state.bind`, `state.fix`\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` boxes a *state-fixed* function, then partially apply that function to\nextract the actual method, closed over references to the locality of `this`.\n\n        if typeof fn is 'object' and fn.type is 'state-fixed-function'\n          fn = fn.fn this, @protostate()\n\n        throw TypeError unless typeof fn is 'function' or\n          fn?.type is 'state-bound-function'\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root._?.methods?[ methodName ]\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n            root.addMethod methodName, ownerMethod\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context.\n\nIf the named method does not exist locally and cannot be inherited, then\n`noSuchMethod` events are emitted, and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n\nFirst try to resolve the method quickly from the local dispatch table.\n\n        if record = @__dispatch_table__?[ methodName ]\n          [ method, context ] = record\n          method = method.fn if method?.type is 'state-bound-function'\n\nResort to a proper lookup if the fast way turns up nothing.\n\n        unless method?\n          if method = @method methodName, VIA_ALL, out = {}\n            { context } = out\n\nBail out gracefully if the method definitively cannot be resolved.\n\n          else\n            @emit 'noSuchMethod', [ methodName, args ]\n            @emit 'noSuchMethod:' + methodName, args\n            return\n\nIf at this point a `context` is provided, this means that `method` is a\nstate-bound function, and `context` will be the appropriately bound `State`. If\nno `context` exists, this means that `method` is a typical non-state-bound\nfunction, which is meant to be invoked in the usual fashion, just as if it were\ncalled directly as a method of `this` state\u2019s `owner`.\n\n        method.apply context or @owner, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","old_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n\n        @_ or = new @Content\n        @__dispatch_table__ = {}\n\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneCategory   _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method for this state. If an optional `out` object is\nprovided, the appropriate `context` for the method is also delivered as a\nproperty of `out`; as usual, `context` is confined to the local state tree.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out ) ->\n        realized = ~@attributes & VIRTUAL\n\n        loop # once\n\nFirst seek the named method locally.\n\n          if realized\n            method = @_?.methods?[ methodName ]\n            if method is rootNoop then method = null\n            if method? then context = this\n            else if record = @__dispatch_table__?[ methodName ]\n              [ method, context ] = record\n\n            break if method?\n\nIf no method is held locally, start traversing, first up the protostate chain.\n\n          if ( viaProto = via & VIA_PROTO ) and\n          method = @protostate()?.method methodName, VIA_PROTO, out\n            context = this; inherited = yes; break\n\nIf no method is found yet, continue traversing up the superstate chain.\n\n          if via & VIA_SUPER and\n          method = @superstate?.method methodName, VIA_SUPER | viaProto, out\n            inherited = yes; break\n\nThe method cannot be found.\n\n          context = null\n          break # always\n\nIf `method` is a function, it is not state-bound, so `context` is unnecessary.\nIf instead `method` represents a state-bound function, then it will be boxed,\nso unbox it, and hang on to `context`.\n\n        if typeof method is 'function'\n          context = null\n        else if method?.type is 'state-bound-function'\n          method = method.fn\n\nExport `method` and `context` together if the `out` reference was provided.\n\n> Callers who know that `method` will be unbound need not provide an `out`.\n\n        if out?\n          out.method = method\n          out.context = context\n\nIff `this` is a realized `State`, inherited lookup results can be memoized in\nthe local dispatch table.\n\n        if realized and method? and out? and inherited\n          @__dispatch_table__?[ methodName ] = [ method, context ]\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state. The provided `fn` may be any of:\n\n  1.  A proper function, which will be called in the context of `@owner`;\n  2.  A boxing of a *bound* function as prepared by `state.bind`, which will\n      cause the boxed function to be called in the context of either `this`\n      `State` or the *epistate* inheriting the method;\n  3.  A boxing of a *fixed* function as prepared by `state.fix`, whose boxed\n      function will be closed over hard references to `this` as `autostate`,\n      and to the *protostate* of `this`, as `protostate`.\n\n> See also: `state.bind`, `state.fix`\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` boxes a *state-fixed* function, then partially apply that function to\nextract the actual method, closed over references to the locality of `this`.\n\n        if typeof fn is 'object' and fn.type is 'state-fixed-function'\n          fn = fn.fn this, @protostate()\n\n        throw TypeError unless typeof fn is 'function' or\n          fn?.type is 'state-bound-function'\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root.method methodName, VIA_NONE\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n            root.addMethod methodName, ownerMethod\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context.\n\nIf the named method does not exist locally and cannot be inherited, then\n`noSuchMethod` events are emitted, and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n\nFirst try to resolve the method quickly from the local dispatch table.\n\n        if record = @__dispatch_table__?[ methodName ]\n          [ method, context ] = record\n\nResort to a proper lookup if the fast way turns up nothing.\n\n        unless method?\n          if method = @method methodName, VIA_ALL, out = {}\n            { context } = out\n\nBail out gracefully if the method definitively cannot be resolved.\n\n          else\n            @emit 'noSuchMethod', [ methodName, args ]\n            @emit 'noSuchMethod:' + methodName, args\n            return\n\nIf at this point a `context` is provided, this means that `method` is a\nstate-bound function, and `context` will be the appropriately bound `State`. If\nno `context` exists, this means that `method` is a typical non-state-bound\nfunction, which is meant to be invoked in the usual fashion, just as if it were\ncalled directly as a method of `this` state\u2019s `owner`.\n\n        method.apply context or @owner, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6fcd6db3ee1c15e54d79ae4a5ba085c579ece8d2","subject":"Added access to 'this' for advice functions","message":"Added access to 'this' for advice functions\n","repos":"WillemDeGroef\/nodesentry","old_file":"src\/policy.litcoffee","new_file":"src\/policy.litcoffee","new_contents":"Policy\n======\n\n    _ = require \"underscore\"\n\n    class Policy\n        constructor: () ->\n            @rules = []\n            @libsToWrap = []\n\n            @policy =\n\nIndicate if a given library (name) should be wrapped in a separate membrane. If\na policy doesn't talk about a specific depending library, then it there is no\nneed for it to be wrapped. Therefor, the default return value is `false`:\n\n                wrapWithMembrane: (libName) -> false\n\n        disable: (lib) -> this\n\n        on: (name) ->\n            child = new OnRule name, this\n            # check if (lib, call) = name must be added to libsToWrap\n            # iff lib[0].toLowerCase() == lib[0]\n            @rules.push child\n            child\n\n        before: (name) ->\n            child = new BeforeRule name, this\n            @rules.push child\n            child\n\n        after: (name) ->\n            child = new AfterRule name, this\n            @rules.push child\n            child\n\nThe `build` method generates the whole structure of our semantic model of the membrane object.\n\n        build: () =>\n            @libsToWrap = []\n\n            strEqual = (fullName) -> (rule) -> fullName == rule.apiCall\n\n            areType = (t) ->\n                (rule) -> rule instanceof t\n\n            conditionsAreTrue = (dTgt, ret) ->\n                (rule) ->\n                    _.chain(rule.conditions)\n                        .map (cond) -> cond(dTgt, ret) == true\n                        .reduce ((memo, c) -> memo and c), true\n                        .value()\n\n            doGetActions = (dTgt, args...) ->\n                (rule) ->\n                    _.chain(rule.actions)\n                        .map (action) -> action.apply(this, [dTgt].concat(args))\n                    return rule\n\n            calcRetValue = (origRet, rule) -> rule.ret(origRet)\n\n            isEmpty = (l) -> l.size().value() == 0\n            isNotFunction = (v) -> typeof v != \"function\"\n\n            @policy.onGet = (wTgt, name, wRec, dTgt, ret) =>\n                name = name.toString()\n                fullName = \"#{dTgt.constructor.name.toString()}.#{name}\"\n                relevantRules = _.chain(@rules)\n                    .filter(strEqual(fullName))\n\n                onRules = relevantRules.filter(areType(OnRule))\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n\n                onGetValue = onRules.filter(conditionsAreTrue(dTgt, ret))\n                    .map(doGetActions(dTgt, ret))\n                    .reduce(calcRetValue, ret)\n                    .value()\n\n            @policy.functionCall = (dTgt, dryThis, dryArgs, calcResult, fullName) =>\n                if dryThis != undefined and fullName.indexOf(\"\/\") != -1\n                    fullName = \"#{dryThis.constructor.name}.#{dTgt.name}\"\n                relevantRules = _.chain(@rules).filter(strEqual(fullName))\n\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n                calcResult = beforeRules.filter(conditionsAreTrue(dTgt, dryArgs))\n                       .map(doGetActions(dryThis, dTgt, dryArgs, calcResult))\n                       .reduce(calcRetValue, calcResult)\n                       .value()\n\n                # return as function because the generic membrane will invoke it afterwards\n                ->\n                    ret = calcResult()\n                    afterRules.filter(conditionsAreTrue(dTgt, ret))\n                        .map(doGetActions(dryThis, dTgt, dryArgs, ret))\n                        .reduce(calcRetValue, ret)\n                        .value()\n\n            @policy\n\n\n    class Rule\n        constructor: (@apiCall, @parent) ->\n\nList of actions with side effects [0..n]:\n\n            @actions = []\n\nThe default return function [1..1]:\n\n            @ret = (v) -> v\n\nA list of conditions that evaluate to `true` or `false` [1..n]:\n\n            @conditions = [ -> true]\n\n        do: (f) =>\n            @actions.push f\n            this\n\n        return: (f) =>\n            @ret = (v) -> f.call(this, v)\n            this\n\n        if: (cond) =>\n            @conditions.push (dtgt, ret) -> cond(dtgt, ret)\n            this\n\n        on: (name) => @parent.on name\n        before: (name) => @parent.before name\n        after: (name) => @parent.after name\n        build: () -> @parent.build()\n\n\n    class OnRule extends Rule\n    class AfterRule extends Rule\n    class BeforeRule extends Rule\n\n\n\n\n\n    module.exports = Policy\n","old_contents":"Policy\n======\n\n    _ = require \"underscore\"\n\n    class Policy\n        constructor: () ->\n            @rules = []\n            @libsToWrap = []\n\n            @policy =\n\nIndicate if a given library (name) should be wrapped in a separate membrane. If\na policy doesn't talk about a specific depending library, then it there is no\nneed for it to be wrapped. Therefor, the default return value is `false`:\n\n                wrapWithMembrane: (libName) -> false\n\n        disable: (lib) -> this\n\n        on: (name) ->\n            child = new OnRule name, this\n            # check if (lib, call) = name must be added to libsToWrap\n            # iff lib[0].toLowerCase() == lib[0]\n            @rules.push child\n            child\n\n        before: (name) ->\n            child = new BeforeRule name, this\n            @rules.push child\n            child\n\n        after: (name) ->\n            child = new AfterRule name, this\n            @rules.push child\n            child\n\nThe `build` method generates the whole structure of our semantic model of the membrane object.\n\n        build: () =>\n            @libsToWrap = []\n\n            strEqual = (fullName) -> (rule) -> fullName == rule.apiCall\n\n            areType = (t) ->\n                (rule) -> rule instanceof t\n\n            conditionsAreTrue = (dTgt, ret) ->\n                (rule) ->\n                    _.chain(rule.conditions)\n                        .map (cond) -> cond(dTgt, ret) == true\n                        .reduce ((memo, c) -> memo and c), true\n                        .value()\n\n            doGetActions = (dTgt, args...) ->\n                (rule) ->\n                    _.chain(rule.actions)\n                        .map (action) -> action.apply(this, [dTgt].concat(args))\n                    return rule\n\n            calcRetValue = (origRet, rule) -> rule.ret(origRet)\n\n            isEmpty = (l) -> l.size().value() == 0\n            isNotFunction = (v) -> typeof v != \"function\"\n\n            @policy.onGet = (wTgt, name, wRec, dTgt, ret) =>\n                name = name.toString()\n                fullName = \"#{dTgt.constructor.name.toString()}.#{name}\"\n                relevantRules = _.chain(@rules)\n                    .filter(strEqual(fullName))\n\n                onRules = relevantRules.filter(areType(OnRule))\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n\n                onGetValue = onRules.filter(conditionsAreTrue(dTgt, ret))\n                    .map(doGetActions(dTgt, ret))\n                    .reduce(calcRetValue, ret)\n                    .value()\n\n            @policy.functionCall = (dTgt, dryThis, dryArgs, calcResult, fullName) =>\n                if dryThis != undefined and fullName.indexOf(\"\/\") != -1\n                    fullName = \"#{dryThis.constructor.name}.#{dTgt.name}\"\n                relevantRules = _.chain(@rules).filter(strEqual(fullName))\n\n                beforeRules = relevantRules.filter(areType(BeforeRule))\n                afterRules = relevantRules.filter(areType(AfterRule))\n\n                calcResult = beforeRules.filter(conditionsAreTrue(dTgt, dryArgs))\n                       .map(doGetActions(dTgt, dryArgs, calcResult))\n                       .reduce(calcRetValue, calcResult)\n                       .value()\n\n                # return as function because the generic membrane will invoke it afterwards\n                ->\n                    ret = calcResult()\n                    afterRules.filter(conditionsAreTrue(dTgt, ret))\n                        .map(doGetActions(dTgt, dryArgs, ret))\n                        .reduce(calcRetValue, ret)\n                        .value()\n\n            @policy\n\n\n    class Rule\n        constructor: (@apiCall, @parent) ->\n\nList of actions with side effects [0..n]:\n\n            @actions = []\n\nThe default return function [1..1]:\n\n            @ret = (v) -> v\n\nA list of conditions that evaluate to `true` or `false` [1..n]:\n\n            @conditions = [ -> true]\n\n        do: (f) =>\n            @actions.push f\n            this\n\n        return: (f) =>\n            @ret = (v) -> f.call(this, v)\n            this\n\n        if: (cond) =>\n            @conditions.push (dtgt, ret) -> cond(dtgt, ret)\n            this\n\n        on: (name) => @parent.on name\n        before: (name) => @parent.before name\n        after: (name) => @parent.after name\n        build: () -> @parent.build()\n\n\n    class OnRule extends Rule\n    class AfterRule extends Rule\n    class BeforeRule extends Rule\n\n\n\n\n\n    module.exports = Policy\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f8d89795e965fe590a3663cf72b2396a586f6bbb","subject":"Switch to .io domains for gh-pages links","message":"Switch to .io domains for gh-pages links\n","repos":"JonathanMatthey\/codeconv,osharim\/docco,Hellyna\/docco,tbremer\/docco,erikdiessel\/plidoc,gvithellyna\/docco,jrvidal\/docco,ShawnHuang\/docco-multidir,oponder\/docco,robertmackenzie\/docco,oponder\/docco,guigrpa\/docco-extended,erikdiessel\/plidoc,actano\/docco,guigrpa\/docco,lobrien\/docco,guigrpa\/docco,DoomHammer\/docco,jalleyne\/docco,lbn\/docco,lbn\/docco,whitetrefoil\/docco,osharim\/docco,jrvidal\/docco,robertmackenzie\/docco,ShawnHuang\/docco-multidir,Hellyna\/docco,jalleyne\/docco,whitetrefoil\/docco,MaxwellRebo\/docco,tbremer\/docco,DoomHammer\/docco,STRd6\/docco,lobrien\/docco,gvithellyna\/docco,mhkeller\/docco,mhkeller\/docco,guigrpa\/docco-extended,MaxwellRebo\/docco","old_file":"docco.litcoffee","new_file":"docco.litcoffee","new_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* Your all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        for line, i in lines\n          lines[i] = if \/^\\s*$\/.test line\n            ''\n          else if match = (\/^([ ]{4}|\\t)\/).exec line\n            line[match[0].length..]\n          else\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n          prev = 'text'\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n          prev = 'code'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n      for section, i in sections\n        code = highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    {highlight} = require 'highlight.js'\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    for ext, l of languages\n\nDoes the line begin with a comment?\n\n      l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n      l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, version}\n","old_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.com\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.com\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.com\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.com\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* Your all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.com\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.com\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.com\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        for line, i in lines\n          lines[i] = if \/^\\s*$\/.test line\n            ''\n          else if match = (\/^([ ]{4}|\\t)\/).exec line\n            line[match[0].length..]\n          else\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n          prev = 'text'\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n          prev = 'code'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n      for section, i in sections\n        code = highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    {highlight} = require 'highlight.js'\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    for ext, l of languages\n\nDoes the line begin with a comment?\n\n      l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n      l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, version}\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"241771d2c2a46c4dbd7f3dd0ce4b8bdc97adfe68","subject":"Update 010_Basics.litcoffee","message":"Update 010_Basics.litcoffee","repos":"delightsoft\/DSCloudState","old_file":"spec\/010_Basics.litcoffee","new_file":"spec\/010_Basics.litcoffee","new_contents":"\u0411\u0430\u0437\u043e\u0432\u044b\u0435 \u0441\u0432\u043e\u0439\u0441\u0442\u0432\u0430 CloudState\n==============================\n\n\u0418\u0434\u0435\u044f\n------------------------------\n\nCloudState - \u043f\u043e\u0437\u0432\u043e\u043b\u044f\u0435\u0442 \u043e\u0440\u0433\u0430\u043d\u0438\u0437\u043e\u0432\u0430\u0442\u044c \u0441\u0438\u043d\u0445\u0440\u043e\u043d\u0438\u0437\u0430\u0446\u0438\u044e \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u0439 \u043c\u0435\u0436\u0434\u0443 \u043d\u0435\u0441\u043a\u043e\u043b\u044c\u043a\u0438\u043c\u0438 \u0443\u0437\u043b\u0430\u043c\u0438 (\u0441\u0435\u0440\u0432\u0435\u0440\u0430, \u0431\u0440\u0430\u0443\u0437\u0435\u0440\u0430\u043c\u0438), \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u044f\n\u0432 \u043a\u0430\u0447\u0435\u0441\u0442\u0432\u0435 \u043a\u0430\u043d\u0430\u043b\u0430 \u0431\u0438\u0431\u043b\u0438\u043e\u0442\u0435\u043a\u0443 socket.io.\n\n\u0414\u043b\u044f \u043f\u0435\u0440\u0435\u0434\u0430\u0447\u0438 \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u044f, \u043d\u0430 \u043e\u0434\u043d\u043e\u043c \u0438\u0437 \u043a\u043e\u043c\u043f\u044c\u044e\u0442\u0435\u0440\u043e\u0432 \u0441\u043e\u0437\u0434\u0430\u0435\u0442\u0441\u044f \u043e\u0434\u0438\u043d \u0433\u043b\u0430\u0432\u043d\u044b\u0439 (origin) \u043e\u0431\u044a\u0435\u043a\u0442 \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u044f, \u0438 \u043a \u043d\u0435\u043c\u0443\n\u043f\u043e\u0434\u043a\u043b\u044e\u0447\u0430\u044e\u0442\u0441\u044f clone-\u043e\u0431\u044a\u0435\u043a\u0442\u044b.  \u041erigin \u044f\u0432\u043b\u044f\u0435\u0442\u0441\u044f \u0441\u0430\u043c\u043e\u0441\u0442\u043e\u044f\u0442\u0435\u043b\u044c\u043d\u044b\u043c \u043e\u0431\u044a\u0435\u043a\u0442\u043e\u043c, \u0438 \u043c\u043e\u0436\u0435\u0442 \u0440\u0430\u0431\u043e\u0442\u0430\u0442\u044c \u0431\u0435\u0437 clone.  Clone \u044f\u0432\u043b\u044f\u0435\u0442\u0441\u044f\n\u043f\u043e\u0434\u0447\u0438\u043d\u0435\u043d\u044b\u043c \u043e\u0431\u044a\u0435\u043a\u0442\u043e\u043c, \u0438 \u043d\u0435 \u043c\u043e\u0436\u0435\u0442 \u043c\u0435\u043d\u044f\u0442\u044c \u0441\u0432\u043e\u0451 \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u0435 \u0431\u0435\u0437 \u043f\u043e\u0434\u043a\u043b\u044e\u0447\u0435\u043d\u0438\u0435 \u043a origin \u043e\u0431\u044a\u0435\u043a\u0442\u0443.\n\n\u0412\u0441\u0435 \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u044f \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u044f origin \u043f\u0435\u0440\u0435\u0434\u0430\u044e\u0442\u0441\u044f \u043d\u0430 clone-\u043e\u0431\u044a\u0435\u043a\u0442\u044b, \u0447\u0435\u0440\u0435\u0437 \u0432\u044b\u0437\u043e\u0432 setter-\u043c\u0435\u0442\u043e\u0434\u043e\u0432 - \u0438\u0445 \u0438\u043c\u0435\u043d \u043d\u0430\u0447\u0438\u043d\u0430\u044e\u0442\u0441\u044f \u0441 \u043f\u043e\u0434\u0447\u0435\u0440\u043a\u0430.\n\n\u0412\u0441\u0435 \u043a\u043e\u043c\u0430\u043d\u0434\u044b \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u043d\u044b\u0435 clone-\u043e\u0431\u044a\u0435\u043a\u0442\u043e\u043c \u0438\u0437 jscript-\u043a\u043e\u0434\u0430, \u043f\u0435\u0440\u0435\u0434\u0430\u044e\u0442\u0441\u044f \u043d\u0430 origin \u0434\u043b\u044f \u0438\u0441\u043f\u043e\u043b\u043d\u0435\u043d\u0438\u044f.\n\n\u0414\u043b\u044f \u043a\u043e\u0434\u0430 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u044e\u0449\u0435\u0433\u043e CloudState \u043e\u0431\u044a\u0435\u043a\u0442\u044b, \u043f\u0440\u0430\u043a\u0442\u0438\u0447\u0435\u0441\u043a\u0438 \u043d\u0435 \u0432\u0438\u0434\u043d\u0430 \u0440\u0430\u0437\u043d\u0438\u0446\u0430 \u0440\u0430\u0431\u043e\u0442\u0430\u0435\u0442 \u043b\u0438 \u043e\u043d \u0441 Origin \u0438\u043b\u0438 Clone.\n\n    require '.\/_globals'\n    socketIO = require 'socket.io'\n    socketIOClient = require 'socket.io-client'\n    CloudState = require '..\/src\/CloudState'\n\n    serverSocket = clientSocket = null\n\n    describe '010 Basics:', ->\n\n      afterEach ->\n        @serverSocket.close() if @serverSocket\n        @clientSocket.close() if @clientSocket\n\n\u041a\u043b\u0430\u0441\u0441\u044b Origin \u0438 Clone\n------------------------------\n\n\u041f\u0440\u0438 \u043d\u0430\u0441\u043b\u0435\u0434\u043e\u0432\u0430\u043d\u0438\u0438 \u043e\u0442 \u043a\u043b\u0430\u0441\u0441\u0430 CloudState\n\n      it '010', ->\n\n        class X extends CloudState\n\n\u0432 \u0441\u0430\u043c\u043e\u043c *\u043a\u043e\u043d\u0446\u0435 \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u044f* \u043d\u043e\u0432\u043e\u0433\u043e \u043a\u043b\u0430\u0441\u0441\u0430, \u043d\u0435\u043e\u0431\u0445\u043e\u0434\u0438\u043c\u043e \u0432\u044b\u0437\u0432\u0430\u0442\u044c \u0441\u0442\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438\u0439 \u043c\u0435\u0442\u043e\u0434 makeOriginAndClone()\n\n          @makeOriginAndClone()\n\n\u044d\u0442\u043e\u0442 \u043c\u0435\u0442\u043e\u0434 \u0441\u043e\u0437\u0434\u0430\u0441\u0442 \u0434\u0432\u0430 \u043f\u0440\u043e\u0438\u0437\u0432\u043e\u0434\u043d\u044b\u0445 \u043a\u043b\u0430\u0441\u0441\u0430, \u043f\u0440\u0438\u0432\u044f\u0437\u0430\u043d\u043d\u044b\u0445 \u043a \u043d\u043e\u0432\u043e\u043c\u0443 \u043a\u043b\u0430\u0441\u0441\u0443.  \u041a\u043b\u0430\u0441\u0441 <\u0438\u043c\u044f \u043a\u043b\u0430\u0441\u0441>.Origin\n\n          expect(X.Origin).toBeDefined()\n\n\u0438 \u043a\u043b\u0430\u0441\u0441 <\u0438\u043c\u044f \u043a\u043b\u0430\u0441\u0441>.Clone.\n\n\u042d\u0442\u0438 \u043a\u043b\u0430\u0441\u0441\u044b \u0434\u043e\u043b\u0436\u043d\u044b \u0431\u044b\u0442\u044c \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u043d\u044b \u0434\u043b\u044f \u0441\u043e\u0437\u0434\u0430\u043d\u0438\u044f \u043e\u0431\u044a\u0435\u043a\u0442\u043e\u0432.\n\n          expect(X.Clone).toBeDefined()\n\n\u041c\u0435\u0442\u043e\u0434\u044b\n------------------------------\n\n\u0421\u0442\u0440\u0443\u043a\u0442\u0443\u0440\u0430 \u0434\u0430\u043d\u043d\u044b\u0445 \u0438 \u043c\u0435\u0442\u043e\u0434\u044b \u0432 \u043a\u043b\u0430\u0441\u0441\u0435 \u043d\u0430\u0441\u043b\u0435\u0434\u043d\u0438\u043a\u0435 CloudState \u043e\u043f\u0440\u0435\u0434\u0435\u043b\u044f\u044e\u0442\u0441\u044f, \u0442\u0430\u043a \u0436\u0435, \u0438 \u0434\u043b\u044f \u043b\u044e\u0431\u043e\u0433\u043e \u043a\u043b\u0430\u0441\u0441\u0430\n\n      it '020', ->\n\n        class X extends CloudState\n\n          constructor: ->\n            super()\n            @field1 = ''\n            return\n\n          method1: ->\n            @field1 = 'a value'\n            return\n\n\u0438 \u043d\u0435 \u0437\u0430\u0431\u044b\u0432\u0430\u0435\u043c \u0432\u044b\u0437\u0432\u0430\u0442\u044c makeOriginAndClone()\n\n          @makeOriginAndClone()\n        \n\u041d\u0415 \u041f\u0420\u0410\u0412\u0418\u041b\u042c\u041d\u041e! \u0421\u043e\u0437\u0434\u0430\u0432\u0430\u0442\u044c \u043e\u0431\u044a\u0435\u043a\u0442\u044b \u043d\u0430\u043f\u0440\u044f\u043c\u0443 \u0438\u0437 \u043a\u043b\u0430\u0441\u0441\u0430        \n        \n        expect(-> x = new X(); return).toThrow(new Error 'It\\'s wrong to create a new instance of remote state directly.  Use <className>.Origin or <className>.Clone.(connect | listen)')\n      \n\u0427\u0435\u0440\u0435\u0437 \u043e\u043f\u0435\u0440\u0430\u0446\u0438\u044e new \u043c\u043e\u0436\u043d\u043e \u0441\u043e\u0437\u0434\u0430\u0432\u0430\u0442\u044c \u043e\u0431\u044a\u0435\u043a\u0442\u044b \u0442\u043e\u043b\u044c\u043a\u043e \u043f\u043e\u0434\u043a\u043b\u0430\u0441\u0441\u0430 Origin\n      \n        x = new X.Origin()\n        expect(x.field1).toBe ''\n        x.method1()\n        expect(x.field1).toBe 'a value'\n\n\u0418\u043c\u0435\u043d\u043e\u0432\u0430\u043d\u0438\u0435 \u0441\u0432\u043e\u0439\u0441\u0442\u0432 \u0438 \u043c\u0435\u0442\u043e\u0434\u043e\u0432\n------------------------------\n\nCloudState \u043e\u0440\u0438\u043d\u0435\u0442\u0438\u0440\u043e\u0432\u0430\u043d \u043d\u0430 \u0440\u0430\u0431\u043e\u0442\u0443 \u0441 AngularJS.  \u041f\u043b\u044e\u0441 \u043d\u0435 \u0436\u0435\u043b\u0430\u0442\u0435\u043b\u044c\u043d\u043e \u0447\u0442\u043e\u0431 \u043c\u0435\u0442\u043e\u0434\u044b CloudState \u043f\u0443\u0442\u0430\u043b\u0438\u0441\u044c \u0441 \u043c\u0435\u0442\u043e\u0434\u0430\u043c\u0438 \u043a\u043b\u0430\u0441\u0441\u043e\u0432,\n\u043a\u043e\u0442\u043e\u0440\u044b\u0435 \u0440\u0435\u0430\u043b\u0438\u0437\u0443\u044e\u0442 remote state \u0434\u043b\u044f \u043a\u043e\u043d\u043a\u0440\u0435\u0442\u043d\u044b\u0445 \u0437\u0430\u0434\u0430\u0447. \u041f\u043e\u044d\u0442\u043e\u043c\u0443 \u0432\u044b\u043f\u043e\u043b\u043d\u044f\u0435\u0442\u0441\u044f \u0441\u043b\u0435\u0434\u0443\u044e\u0449\u0435\u0435 \u0441\u043e\u0433\u043b\u0430\u0448\u0435\u043d\u0438\u0435:\n\n      # TODO: \u041f\u043e\u043a\u0430\u0437\u0430\u0442\u044c \u043a\u0430\u043a \u0440\u0430\u0431\u043e\u0442\u0430\u0435\u0442 digest \u043f\u0440\u0438 \u043e\u0431\u043d\u043e\u0432\u043b\u0435\u043d\u0438\u044f\u0445\n\n      it '030', ->\n\n        class X extends CloudState\n          @setters\n            setV: (v) -> @v = v; return\n          action: -> return\n          @makeOriginAndClone()\n\n\u043c\u0435\u0442\u043e\u0434\u044b \u043a\u043b\u0430\u0441\u0441\u043e\u0432 (\u0441\u0442\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438\u0435) CloudState, Origin \u0438 Clone - \u043f\u0440\u043e\u0441\u0442\u043e \u043c\u0435\u0442\u043e\u0434\u044b\n\n          expect(CloudState.setters).toBeDefined()\n          expect(CloudState.makeOriginAndClone).toBeDefined()\n          expect(X.Clone.connect).toBeDefined()\n          expect(X.Clone.listen).toBeDefined()\n\n\u0432\u043d\u0443\u0442\u0440\u0435\u043d\u0438\u0435 \u043f\u0435\u0440\u0435\u043c\u0435\u043d\u043d\u044b\u0435 \u043d\u0430\u0437\u044b\u0432\u0430\u044e\u0442\u0441\u044f \u0441 \u0434\u0432\u0443\u043c\u044f $ \u0432 \u043d\u0430\u0447\u0430\u043b\u0435, \u0447\u0442\u043e\u0431 angular \u0438\u0433\u043d\u043e\u0440\u0438\u0440\u043e\u0432\u0430\u043b \u0438\u0445 \u043f\u0440\u0438 \u0432\u044b\u0432\u043e\u0434\u0435 \u043e\u0431\u044a\u0435\u043a\u0442\u0430 \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u044f \u0446\u0435\u043b\u0438\u043a\u043e\u043c\n\n          x = new X.Origin()\n          expect(x.$$blocked).toBeDefined()\n\n\u043e\u0431\u0449\u0438\u0435 \u043c\u0435\u0442\u043e\u0434\u044b CloudState, \u043d\u0430\u0447\u0438\u043d\u0430\u044e\u0442\u0441\u044f \u0441 \u0434\u0432\u0443\u0445 \u043f\u043e\u0434\u0447\u0435\u0440\u043a\u043e\u0432\n\n          expect(x.__connect).toBeDefined()\n\n\u043c\u0435\u0442\u043e\u0434\u044b \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u044f \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u0439, \u043d\u0430\u0447\u0438\u043d\u0430\u044e\u0442\u0441\u044f \u0441 \u043f\u043e\u0434\u0447\u0435\u0440\u043a\u0430\n\n          expect(x._setV).toBeDefined()\n\n\u043c\u0435\u0442\u043e\u0434\u044b \u043e\u0431\u044a\u0435\u043a\u0442\u0430 - \u0431\u0435\u0437 \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u0439\n\n          expect(x.action).toBeDefined()\n\n\u041d\u0430\u0441\u043b\u0435\u0434\u043e\u0432\u0430\u043d\u0438\u0435 \u043a\u043b\u0430\u0441\u0441\u043e\u0432 \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u044f\n------------------------------\n\n\u041c\u043e\u0436\u043d\u043e \u043d\u0430\u0441\u043b\u0435\u0434\u043e\u0432\u0430\u0442\u044c\u0441\u044f \u043e\u0442 \u043a\u043b\u0430\u0441\u0441\u0430, \u043a\u043e\u0442\u043e\u0440\u044b\u0435 \u0443\u043d\u0430\u0441\u043b\u0435\u0434\u043e\u0432\u0430\u043d \u043e\u0442 CloudState\n\n      it '040', ->\n  \n        class X extends CloudState\n\n          constructor: ->\n            @field1 = ''\n            return\n\n          method1: ->\n            @field1 = 'a value'\n            return\n\n          @makeOriginAndClone()\n\n        class Y extends X\n\n          constructor: ->\n            super()\n            @field2 = ''\n            return\n\n          method2: ->\n            @field2 = 'a value'\n            return\n\n          @makeOriginAndClone()\n\n        y = new Y.Origin()\n        expect(y.field1).toBe ''\n        expect(y.field2).toBe ''\n        y.method1()\n        y.method2()\n        expect(y.field1).toBe 'a value'\n        expect(y.field2).toBe 'a value'\n\n        # TODO: Block direct class instantiation\n\n\u041d\u0415 \u041f\u0420\u0410\u0412\u0418\u041b\u042c\u041d\u041e! \u0421\u043e\u0437\u0434\u0430\u0432\u0430\u0442\u044c \u043a\u043b\u0430\u0441\u0441\u044b Clone \u043d\u0430\u043f\u0440\u044f\u043c\u0443\u044e.  \u0418\u0445 \u043d\u0430\u0434\u043e \u0441\u043e\u0437\u0434\u0430\u0432\u0430\u0442\u044c \u0447\u0435\u0440\u0435\u0437 \u043c\u0435\u0442\u043e\u0434\u044b listen\n\n      it '050', (done) ->\n\n        class X extends CloudState\n\n          @makeOriginAndClone()\n\n        x = new X.Origin()\n\n\u0441\u043f\u0435\u0440\u0432\u0430 \u0441\u043e\u0437\u0434\u0430\u0435\u0442 X.Origin \u043e\u0431\u044a\u0435\u043a\u0442, \u043a\u043e\u0442\u043e\u0440\u044b\u0439 \u0441\u043b\u0443\u0448\u0430\u0435\u0442 \u043d\u0430 \u043f\u043e\u0440\u0442\u0443\n\n        x.__listen (@serverSocket = socketIO(3990)), '\/origin'\n\n\u043f\u043e\u0442\u043e\u043c \u043f\u043e\u0434\u043a\u043b\u044e\u0447\u0430\u0435\u043c \u043a X.Clone \u043e\u0431\u044a\u0435\u043a\u0442\n\n        X.Clone.connect (@clientSocket = socketIOClient.connect('http:\/\/localhost:3990\/origin')), (err, clone) ->\n\n          if err then done.fail(err); return\n\n          expect(clone).toBeDefined()\n          expect(clone).not.toBeNull()\n\n          done()\n          return\n\n\u0438\u043b\u0438 connect \u043a Origin \u043e\u0431\u044a\u0435\u043a\u0442\u0443\n\n      it '060', (done) ->\n\n        class X extends CloudState\n\n          @makeOriginAndClone()\n\n\u0441\u043f\u0435\u0440\u0432\u0430 \u0432\u043e\u0437\u0434\u0430\u0435\u043c X.Clone, \u043a\u043e\u0442\u043e\u0440\u044b\u0439 \u0441\u043b\u0443\u0448\u0430\u0435\u0442 \u043d\u0430 \u043f\u043e\u0440\u0442\u0443 \u043a\u043e\u0433\u0434\u0430 \u043f\u043e\u044f\u0432\u0438\u0442\u0441\u044f X.Origin\n\n        X.Clone.listen (@serverSocket = socketIO(3990)), '\/clone', (err, clone) ->\n\n          if err then done.fail(err); return\n\n          expect(clone).toBeDefined()\n          expect(clone).not.toBeNull()\n\n          done()\n          return\n\n\u043f\u043e\u0442\u043e\u043c \u0441\u043e\u0437\u0434\u0430\u0435\u043c X.Origin, \u043a\u043e\u0442\u043e\u0440\u044b\u0439 \u043f\u043e\u0434\u043a\u043b\u044e\u0447\u0430\u0435\u0442\u0441\u044f \u043a X.Clone\n\n        x = new X.Origin()\n        x.__connect (@clientSocket = socketIOClient.connect('http:\/\/localhost:3990\/clone'))\n","old_contents":"\u0411\u0430\u0437\u043e\u0432\u044b\u0435 \u0441\u0432\u043e\u0439\u0441\u0442\u0432\u0430 CloudState\n==============================\n\n\u0418\u0434\u0435\u044f\n------------------------------\n\nCloudState - \u043f\u043e\u0437\u0432\u043e\u043b\u044f\u0435\u0442 \u043e\u0440\u0430\u0433\u043d\u0438\u0437\u043e\u0432\u0430\u0442\u044c \u0441\u0438\u043d\u0445\u0440\u043e\u043d\u0438\u0437\u0430\u0446\u0438\u044e \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u0439 \u043c\u0435\u0436\u0434\u0443 \u043d\u0435\u0441\u043a\u043e\u043b\u044c\u043a\u0438\u043c\u0438 \u0443\u0437\u043b\u0430\u043c\u0438 (\u0441\u0435\u0440\u0432\u0435\u0440\u0430, \u0431\u0440\u0430\u0443\u0437\u0435\u0440\u0430\u043c\u0438), \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u044f\n\u0432 \u043a\u0430\u0447\u0435\u0441\u0442\u0432\u0435 \u043a\u0430\u043d\u0430\u043b\u0430 \u0431\u0438\u0431\u043b\u0438\u043e\u0442\u0435\u043a\u0443 socket.io.\n\n\u0414\u043b\u044f \u043f\u0435\u0440\u0435\u0434\u0430\u0447\u0438 \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u044f, \u043d\u0430 \u043e\u0434\u043d\u043e\u043c \u0438\u0437 \u043a\u043e\u043c\u043f\u044c\u044e\u0442\u0435\u0440\u043e\u0432 \u0441\u043e\u0437\u0434\u0430\u0435\u0442\u0441\u044f \u043e\u0434\u0438\u043d \u0433\u043b\u0430\u0432\u043d\u044b\u0439 (origin) \u043e\u0431\u044a\u0435\u043a\u0442 \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u044f, \u0438 \u043a \u043d\u0435\u043c\u0443\n\u043f\u043e\u0434\u043a\u043b\u044e\u0447\u0430\u044e\u0442\u0441\u044f clone-\u043e\u0431\u044a\u0435\u043a\u0442\u044b.  \u041erigin \u044f\u0432\u043b\u044f\u0435\u0442\u0441\u044f \u0441\u0430\u043c\u043e\u0441\u0442\u043e\u044f\u0442\u0435\u043b\u044c\u043d\u044b\u043c \u043e\u0431\u044a\u0435\u043a\u0442\u043e\u043c, \u0438 \u043c\u043e\u0436\u0435\u0442 \u0440\u0430\u0431\u043e\u0442\u0430\u0442\u044c \u0431\u0435\u0437 clone.  Clone \u044f\u0432\u043b\u044f\u0435\u0442\u0441\u044f\n\u043f\u043e\u0434\u0447\u0438\u043d\u0435\u043d\u044b\u043c \u043e\u0431\u044a\u0435\u043a\u0442\u043e\u043c, \u0438 \u043d\u0435 \u043c\u043e\u0436\u0435\u0442 \u043c\u0435\u043d\u044f\u0442\u044c \u0441\u0432\u043e\u0451 \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u0435 \u0431\u0435\u0437 \u043f\u043e\u0434\u043a\u043b\u044e\u0447\u0435\u043d\u0438\u0435 \u043a origin \u043e\u0431\u044a\u0435\u043a\u0442\u0443.\n\n\u0412\u0441\u0435 \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u044f \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u044f origin \u043f\u0435\u0440\u0435\u0434\u0430\u044e\u0442\u0441\u044f \u043d\u0430 clone-\u043e\u0431\u044a\u0435\u043a\u0442\u044b, \u0447\u0435\u0440\u0435\u0437 \u0432\u044b\u0437\u043e\u0432 setter-\u043c\u0435\u0442\u043e\u0434\u043e\u0432 - \u0438\u0445 \u0438\u043c\u0435\u043d \u043d\u0430\u0447\u0438\u043d\u0430\u044e\u0442\u0441\u044f \u0441 \u043f\u043e\u0434\u0447\u0435\u0440\u043a\u0430.\n\n\u0412\u0441\u0435 \u043a\u043e\u043c\u0430\u043d\u0434\u044b \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u043d\u044b\u0435 clone-\u043e\u0431\u044a\u0435\u043a\u0442\u043e\u043c \u0438\u0437 jscript-\u043a\u043e\u0434\u0430, \u043f\u0435\u0440\u0435\u0434\u0430\u044e\u0442\u0441\u044f \u043d\u0430 origin \u0434\u043b\u044f \u0438\u0441\u043f\u043e\u043b\u043d\u0435\u043d\u0438\u044f.\n\n\u0414\u043b\u044f \u043a\u043e\u0434\u0430 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u044e\u0449\u0435\u0433\u043e CloudState \u043e\u0431\u044a\u0435\u043a\u0442\u044b, \u043f\u0440\u0430\u043a\u0442\u0438\u0447\u0435\u0441\u043a\u0438 \u043d\u0435 \u0432\u0438\u0434\u043d\u0430 \u0440\u0430\u0437\u043d\u0438\u0446\u0430 \u0440\u0430\u0431\u043e\u0442\u0430\u0435\u0442 \u043b\u0438 \u043e\u043d \u0441 Origin \u0438\u043b\u0438 Clone.\n\n    require '.\/_globals'\n    socketIO = require 'socket.io'\n    socketIOClient = require 'socket.io-client'\n    CloudState = require '..\/src\/CloudState'\n\n    serverSocket = clientSocket = null\n\n    describe '010 Basics:', ->\n\n      afterEach ->\n        @serverSocket.close() if @serverSocket\n        @clientSocket.close() if @clientSocket\n\n\u041a\u043b\u0430\u0441\u0441\u044b Origin \u0438 Clone\n------------------------------\n\n\u041f\u0440\u0438 \u043d\u0430\u0441\u043b\u0435\u0434\u043e\u0432\u0430\u043d\u0438\u0438 \u043e\u0442 \u043a\u043b\u0430\u0441\u0441\u0430 CloudState\n\n      it '010', ->\n\n        class X extends CloudState\n\n\u0432 \u0441\u0430\u043c\u0430\u043c *\u043a\u043e\u043d\u0446\u0435 \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u044f* \u043d\u043e\u0432\u043e\u0433\u043e \u043a\u043b\u0430\u0441\u0441\u0430, \u043d\u0435\u043e\u0431\u0445\u043e\u0434\u0438\u043c\u043e \u0432\u044b\u0437\u0432\u0430\u0442\u044c \u0441\u0442\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438\u0439 \u043c\u0435\u0442\u043e\u0434 makeOriginAndClone()\n\n          @makeOriginAndClone()\n\n\u044d\u0442\u043e\u0442 \u043c\u0435\u0442\u043e\u0434 \u0441\u043e\u0437\u0434\u0430\u0441\u0442 \u0434\u0432\u0430 \u043f\u0440\u043e\u0438\u0437\u0432\u043e\u0434\u043d\u044b\u0445 \u043a\u043b\u0430\u0441\u0441\u0430, \u043f\u0440\u0438\u0432\u044f\u0437\u0430\u043d\u043d\u044b\u0445 \u043a \u043d\u043e\u0432\u043e\u043c\u0443 \u043a\u043b\u0430\u0441\u0441\u0443.  \u041a\u043b\u0430\u0441\u0441 <\u0438\u043c\u044f \u043a\u043b\u0430\u0441\u0441>.Origin\n\n          expect(X.Origin).toBeDefined()\n\n\u0438 \u043a\u043b\u0430\u0441\u0441 <\u0438\u043c\u044f \u043a\u043b\u0430\u0441\u0441>.Clone.\n\n\u042d\u0442\u0438 \u043a\u043b\u0430\u0441\u0441\u044b \u0434\u043e\u043b\u0436\u043d\u044b \u0431\u044b\u0442\u044c \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u043d\u044b \u0434\u043b\u044f \u0441\u043e\u0437\u0434\u0430\u043d\u0438\u044f \u043e\u0431\u044a\u0435\u043a\u0442\u043e\u0432.\n\n          expect(X.Clone).toBeDefined()\n\n\u041c\u0435\u0442\u043e\u0434\u044b\n------------------------------\n\n\u0421\u0442\u0440\u0443\u043a\u0442\u0443\u0440\u0430 \u0434\u0430\u043d\u043d\u044b\u0445 \u0438 \u043c\u0435\u0442\u043e\u0434\u044b \u0432 \u043a\u043b\u0430\u0441\u0441\u0435 \u043d\u0430\u0441\u043b\u0435\u0434\u043d\u0438\u043a\u0435 CloudState \u043e\u043f\u0440\u0435\u0434\u0435\u043b\u044f\u044e\u0442\u0441\u044f, \u0442\u0430\u043a \u0436\u0435, \u0438 \u0434\u043b\u044f \u043b\u044e\u0431\u043e\u0433\u043e \u043a\u043b\u0430\u0441\u0441\u0430\n\n      it '020', ->\n\n        class X extends CloudState\n\n          constructor: ->\n            super()\n            @field1 = ''\n            return\n\n          method1: ->\n            @field1 = 'a value'\n            return\n\n\u0438 \u043d\u0435 \u0437\u0430\u0431\u044b\u0432\u0430\u0435\u043c \u0432\u044b\u0437\u0432\u0430\u0442\u044c makeOriginAndClone()\n\n          @makeOriginAndClone()\n        \n\u041d\u0415 \u041f\u0420\u0410\u0412\u0418\u041b\u042c\u041d\u041e! \u0421\u043e\u0437\u0434\u0430\u0432\u0430\u0442\u044c \u043e\u0431\u044a\u0435\u043a\u0442\u044b \u043d\u0430\u043f\u0440\u044f\u043c\u0443 \u0438\u0437 \u043a\u043b\u0430\u0441\u0441\u0430        \n        \n        expect(-> x = new X(); return).toThrow(new Error 'It\\'s wrong to create a new instance of remote state directly.  Use <className>.Origin or <className>.Clone.(connect | listen)')\n      \n\u0427\u0435\u0440\u0435\u0437 \u043e\u043f\u0435\u0440\u0430\u0446\u0438\u044e new \u043c\u043e\u0436\u043d\u043e \u0441\u043e\u0437\u0434\u0430\u0432\u0430\u0442\u044c \u043e\u0431\u044a\u0435\u043a\u0442\u044b \u0442\u043e\u043b\u044c\u043a\u043e \u043f\u043e\u0434\u043a\u043b\u0430\u0441\u0441\u0430 Origin\n      \n        x = new X.Origin()\n        expect(x.field1).toBe ''\n        x.method1()\n        expect(x.field1).toBe 'a value'\n\n\u0418\u043c\u0435\u043d\u043e\u0432\u0430\u043d\u0438\u0435 \u0441\u0432\u043e\u0439\u0441\u0442\u0432 \u0438 \u043c\u0435\u0442\u043e\u0434\u043e\u0432\n------------------------------\n\nCloudState \u043e\u0440\u0438\u043d\u0435\u0442\u0438\u0440\u043e\u0432\u0430\u043d \u043d\u0430 \u0440\u0430\u0431\u043e\u0442\u0443 \u0441 AngularJS.  \u041f\u043b\u044e\u0441 \u043d\u0435 \u0436\u0435\u043b\u0430\u0442\u0435\u043b\u044c\u043d\u043e \u0447\u0442\u043e\u0431 \u043c\u0435\u0442\u043e\u0434\u044b CloudState \u043f\u0443\u0442\u0430\u043b\u0438\u0441\u044c \u0441 \u043c\u0435\u0442\u043e\u0434\u0430\u043c\u0438 \u043a\u043b\u0430\u0441\u0441\u043e\u0432,\n\u043a\u043e\u0442\u043e\u0440\u044b\u0435 \u0440\u0435\u0430\u043b\u0438\u0437\u0443\u044e\u0442 remote state \u0434\u043b\u044f \u043a\u043e\u043d\u043a\u0440\u0435\u0442\u043d\u044b\u0445 \u0437\u0430\u0434\u0430\u0447. \u041f\u043e\u044d\u0442\u043e\u043c\u0443 \u0432\u044b\u043f\u043e\u043b\u043d\u044f\u0435\u0442\u0441\u044f \u0441\u043b\u0435\u0434\u0443\u044e\u0449\u0435\u0435 \u0441\u043e\u0433\u043b\u0430\u0448\u0435\u043d\u0438\u0435:\n\n      # TODO: \u041f\u043e\u043a\u0430\u0437\u0430\u0442\u044c \u043a\u0430\u043a \u0440\u0430\u0431\u043e\u0442\u0430\u0435\u0442 digest \u043f\u0440\u0438 \u043e\u0431\u043d\u043e\u0432\u043b\u0435\u043d\u0438\u044f\u0445\n\n      it '030', ->\n\n        class X extends CloudState\n          @setters\n            setV: (v) -> @v = v; return\n          action: -> return\n          @makeOriginAndClone()\n\n\u043c\u0435\u0442\u043e\u0434\u044b \u043a\u043b\u0430\u0441\u0441\u043e\u0432 (\u0441\u0442\u0430\u0442\u0438\u0447\u0435\u0441\u043a\u0438\u0435) CloudState, Origin \u0438 Clone - \u043f\u0440\u043e\u0441\u0442\u043e \u043c\u0435\u0442\u043e\u0434\u044b\n\n          expect(CloudState.setters).toBeDefined()\n          expect(CloudState.makeOriginAndClone).toBeDefined()\n          expect(X.Clone.connect).toBeDefined()\n          expect(X.Clone.listen).toBeDefined()\n\n\u0432\u043d\u0443\u0442\u0440\u0435\u043d\u0438\u0435 \u043f\u0435\u0440\u0435\u043c\u0435\u043d\u043d\u044b\u0435 \u043d\u0430\u0437\u044b\u0432\u0430\u044e\u0442\u0441\u044f \u0441 \u0434\u0432\u0443\u043c\u044f $ \u0432 \u043d\u0430\u0447\u0430\u043b\u0435, \u0447\u0442\u043e\u0431 angular \u0438\u0433\u043d\u043e\u0440\u0438\u0440\u043e\u0432\u0430\u043b \u0438\u0445 \u043f\u0440\u0438 \u0432\u044b\u0432\u043e\u0434\u0435 \u043e\u0431\u044a\u0435\u043a\u0442\u0430 \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u044f \u0446\u0435\u043b\u0438\u043a\u043e\u043c\n\n          x = new X.Origin()\n          expect(x.$$blocked).toBeDefined()\n\n\u043e\u0431\u0449\u0438\u0435 \u043c\u0435\u0442\u043e\u0434\u044b CloudState, \u043d\u0430\u0447\u0438\u043d\u0430\u044e\u0442\u0441\u044f \u0441 \u0434\u0432\u0443\u0445 \u043f\u043e\u0434\u0447\u0435\u0440\u043a\u043e\u0432\n\n          expect(x.__connect).toBeDefined()\n\n\u043c\u0435\u0442\u043e\u0434\u044b \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u044f \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u0439, \u043d\u0430\u0447\u0438\u043d\u0430\u044e\u0442\u0441\u044f \u0441 \u043f\u043e\u0434\u0447\u0435\u0440\u043a\u0430\n\n          expect(x._setV).toBeDefined()\n\n\u043c\u0435\u0442\u043e\u0434\u044b \u043e\u0431\u044a\u0435\u043a\u0442\u0430 - \u0431\u0435\u0437 \u0438\u0437\u043c\u0435\u043d\u0435\u043d\u0438\u0439\n\n          expect(x.action).toBeDefined()\n\n\u041d\u0430\u0441\u043b\u0435\u0434\u043e\u0432\u0430\u043d\u0438\u0435 \u043a\u043b\u0430\u0441\u0441\u043e\u0432 \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u044f\n------------------------------\n\n\u041c\u043e\u0436\u043d\u043e \u043d\u0430\u0441\u043b\u0435\u0434\u043e\u0432\u0430\u0442\u044c\u0441\u044f \u043e\u0442 \u043a\u043b\u0430\u0441\u0441\u0430, \u043a\u043e\u0442\u043e\u0440\u044b\u0435 \u0443\u043d\u0430\u0441\u043b\u0435\u0434\u043e\u0432\u0430\u043d \u043e\u0442 CloudState\n\n      it '040', ->\n  \n        class X extends CloudState\n\n          constructor: ->\n            @field1 = ''\n            return\n\n          method1: ->\n            @field1 = 'a value'\n            return\n\n          @makeOriginAndClone()\n\n        class Y extends X\n\n          constructor: ->\n            super()\n            @field2 = ''\n            return\n\n          method2: ->\n            @field2 = 'a value'\n            return\n\n          @makeOriginAndClone()\n\n        y = new Y.Origin()\n        expect(y.field1).toBe ''\n        expect(y.field2).toBe ''\n        y.method1()\n        y.method2()\n        expect(y.field1).toBe 'a value'\n        expect(y.field2).toBe 'a value'\n\n        # TODO: Block direct class instantiation\n\n\u041d\u0415 \u041f\u0420\u0410\u0412\u0418\u041b\u042c\u041d\u041e! \u0421\u043e\u0437\u0434\u0430\u0432\u0430\u0442\u044c \u043a\u043b\u0430\u0441\u0441\u044b Clone \u043d\u0430\u043f\u0440\u044f\u043c\u0443\u044e.  \u0418\u0445 \u043d\u0430\u0434\u043e \u0441\u043e\u0437\u0434\u0430\u0432\u0430\u0442\u044c \u0447\u0435\u0440\u0435\u0437 \u043c\u0435\u0442\u043e\u0434\u044b listen\n\n      it '050', (done) ->\n\n        class X extends CloudState\n\n          @makeOriginAndClone()\n\n        x = new X.Origin()\n\n\u0441\u043f\u0435\u0440\u0432\u0430 \u0441\u043e\u0437\u0434\u0430\u0435\u0442 X.Origin \u043e\u0431\u044a\u0435\u043a\u0442, \u043a\u043e\u0442\u043e\u0440\u044b\u0439 \u0441\u043b\u0443\u0448\u0430\u0435\u0442 \u043d\u0430 \u043f\u043e\u0440\u0442\u0443\n\n        x.__listen (@serverSocket = socketIO(3990)), '\/origin'\n\n\u043f\u043e\u0442\u043e\u043c \u043f\u043e\u0434\u043a\u043b\u044e\u0447\u0430\u0435\u043c \u043a X.Clone \u043e\u0431\u044a\u0435\u043a\u0442\n\n        X.Clone.connect (@clientSocket = socketIOClient.connect('http:\/\/localhost:3990\/origin')), (err, clone) ->\n\n          if err then done.fail(err); return\n\n          expect(clone).toBeDefined()\n          expect(clone).not.toBeNull()\n\n          done()\n          return\n\n\u0438\u043b\u0438 connect \u043a Origin \u043e\u0431\u044a\u0435\u043a\u0442\u0443\n\n      it '060', (done) ->\n\n        class X extends CloudState\n\n          @makeOriginAndClone()\n\n\u0441\u043f\u0435\u0440\u0432\u0430 \u0432\u043e\u0437\u0434\u0430\u0435\u043c X.Clone, \u043a\u043e\u0442\u043e\u0440\u044b\u0439 \u0441\u043b\u0443\u0448\u0430\u0435\u0442 \u043d\u0430 \u043f\u043e\u0440\u0442\u0443 \u043a\u043e\u0433\u0434\u0430 \u043f\u043e\u044f\u0432\u0438\u0442\u0441\u044f X.Origin\n\n        X.Clone.listen (@serverSocket = socketIO(3990)), '\/clone', (err, clone) ->\n\n          if err then done.fail(err); return\n\n          expect(clone).toBeDefined()\n          expect(clone).not.toBeNull()\n\n          done()\n          return\n\n\u043f\u043e\u0442\u043e\u043c \u0441\u043e\u0437\u0434\u0430\u0435\u043c X.Origin, \u043a\u043e\u0442\u043e\u0440\u044b\u0439 \u043f\u043e\u0434\u043a\u043b\u044e\u0447\u0430\u0435\u0442\u0441\u044f \u043a X.Clone\n\n        x = new X.Origin()\n        x.__connect (@clientSocket = socketIOClient.connect('http:\/\/localhost:3990\/clone'))\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"edaac986ea1f6d5e31efa393112271e70930c930","subject":"source-map","message":"source-map\n","repos":"glebm\/gulp-webpack-react-bootstrap-sass-template,duereg\/tile-thinger,duereg\/tile-thinger,glebm\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template","old_file":"webpack.config.litcoffee","new_file":"webpack.config.litcoffee","new_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc).\nIt also manages loading via JavaScript `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    webpack = require('webpack')\n    fs      = require('fs')\n    path    = require('path')\n    _       = require('lodash')\n\n\nDefine an empty configuration:\n\n    module.exports = {}\n\nEntry bundles, i.e. package source paths. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n    entries = module.exports.entry =\n      \"main\"            : \".\/src\/scripts\/main.litcoffee\"\n      \"styles\"          : \".\/src\/styles\/styles.scss\"\n      \"vendor\/es5-shim\" : \".\/bower_components\/es5-shim\/es5-shim.js\"\n      \"vendor\/es5-sham\" : \".\/bower_components\/es5-shim\/es5-sham.js\"\n\nDefine compiled distribution output directory:\n\n    outputDir = path.join(__dirname, \"dist\", \"assets\")\n\n## Loaders\n\nDefine how files should be loaded (required) based on the extension.\n\n### Scripts\n\nProcess CoffeeScript and JSX.\n\n    jsLoaders = [\"jsx\"]\n    scriptModLoaders = [\n      { test: \/\\.coffee$\/   , loaders: jsLoaders.concat([\"coffee\"]) }\n      { test: \/\\.litcoffee$\/, loaders: jsLoaders.concat([\"coffee?literate\"]) }\n      { test: \/\\.js$\/       , loaders: jsLoaders }\n    ]\n\n### Styles\n\nProcess Sass and use Autoprefixer.\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?last 2 versions']\n    styleModLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\n          \"sass?precision=10&outputStyle=expanded&sourceMap=true&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/ , loaders: cssLoaders }\n    ]\n\n### Static assets\n\nEmbed data-URLs into CSS and JS for small images and `.woff` fonts:\n\n    staticModLoaders = [\n      { test: \/\\.gif$\/ , loader: \"url?limit=10000&mimetype=image\/gif\" }\n      { test: \/\\.jpg$\/ , loader: \"url?limit=10000&mimetype=image\/jpg\" }\n      { test: \/\\.png$\/ , loader: \"url?limit=10000&mimetype=image\/png\" }\n      { test: \/\\.woff$\/, loader: \"url?limit=10000&mimetype=application\/font-woff\" }\n      { test: \/\\.ttf$\/ , loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n      { test: \/\\.eot$\/ , loader: \"file?mimetype=application\/x-font-ttf\" }\n      { test: \/\\.svg$\/ , loader: \"file?mimetype=image\/svg+xml\" }\n    ]\n\n### Output CSS to `.css` files\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not as `.js` files with embedded CSS strings.\n\nRequire the plugin:\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n\nSet `styleModLoaders` to use the plugin:\n\n    styleModLoaders = styleModLoaders.map (e) ->\n      { test: e.test, loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!')) }\n\nCreate an instance of the extractTextPlugin:\n\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\n### Define macro variables\n\n`DefinePlugin` defines variables to be substituted in the assets (a la macro).\n\nDefine `__PRODUCTION__: false` variable (set to true on `useProductionSettings()`):\n\n    definePlugin = new webpack.DefinePlugin(\n      __PRODUCTION__: JSON.stringify(false)\n    )\n\n### Other options\n\n    _.merge module.exports,\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n      devtool: 'source-map'\n\nOutput options:\n\n      output:\n        path         : outputDir\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: ['bower_components', 'node_modules']\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleModLoaders.concat(scriptModLoaders).concat(staticModLoaders)\n        noParse: \/\\.min\\.js$\/\n\nDefine the plugins:\n\n      plugins: [\n\n`definePlugin` defines variables to be substituted in the assets (a la macro):\n\n        definePlugin\n\n`extractTextPlugin` (defined above) will compile CSS to a .css file, as opposed to inlining it as a string in a .js file.\n\n        extractTextPlugin\n      ]\n\n\n## Production overrides\n\nExport a method that applies production settings (used in gulpfile):\n\n      mergeProductionConfig: ->\n\nProduction plugins:\n\nSet `__PRODUCTION__` to true in the `DefinePlugin` instance:\n\n        definePlugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\nTell `ExtractTextPlugin` to append hashes (BROKEN, see [plugin issue #9](https:\/\/github.com\/webpack\/extract-text-webpack-plugin\/issues\/9)):\n\n        extractTextPlugin.filename = '[name]-[hash].css'\n\nMerge in production config (deep merge):\n\n        _.merge @,\n\nDisable development settings:\n\n          debug: false\n          watch: false\n          devtool: null\n\nAdd content hashes to the output filenames:\n\n          output:\n            filename: \"[name]-[hash].js\"\n\n          plugins: @plugins.concat [\n\nMinify JavaScript with UglifyJS:\n\n            new webpack.optimize.UglifyJsPlugin()\n\nGenerate asset -> asset-hash manifest:\n\n            generateManifestPlugin = (compiler) ->\n              @plugin 'done', (stats) ->\n                stats = stats.toJson()\n\nSet target path extension to `.css` for style assets, because we use `ExtractTextPlugin`:\n\n                assetStats = stats.assetsByChunkName\n                setCssExt = (p) -> p.replace(\/\\.js$\/, '.css')\n                for entryName, entryPath of assetStats when \/\\.(?:scss|sass|css)$\/.test(entries[entryName])\n                  if _.isArray(entryPath)\n                    assetStats[entryName] = entryPath.map (p) -> setCssExt(p)\n                  else\n                    assetStats[entryName] = setCssExt(entryPath)\n\nWrite asset-ref -> asset-hash manifest to outputDir\/stats.json\n\n                fs.writeFileSync(path.join(outputDir, \"asset-stats.json\"), JSON.stringify(stats.assetsByChunkName, null, 2))\n\n          ]\n","old_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc).\nIt also manages loading via JavaScript `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    webpack = require('webpack')\n    fs      = require('fs')\n    path    = require('path')\n    _       = require('lodash')\n\n\nDefine an empty configuration:\n\n    module.exports = {}\n\nEntry bundles, i.e. package source paths. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n    entries = module.exports.entry =\n      \"main\"            : \".\/src\/scripts\/main.litcoffee\"\n      \"styles\"          : \".\/src\/styles\/styles.scss\"\n      \"vendor\/es5-shim\" : \".\/bower_components\/es5-shim\/es5-shim.js\"\n      \"vendor\/es5-sham\" : \".\/bower_components\/es5-shim\/es5-sham.js\"\n\nDefine compiled distribution output directory:\n\n    outputDir = path.join(__dirname, \"dist\", \"assets\")\n\n## Loaders\n\nDefine how files should be loaded (required) based on the extension.\n\n### Scripts\n\nProcess CoffeeScript and JSX.\n\n    jsLoaders = [\"jsx\"]\n    scriptModLoaders = [\n      { test: \/\\.coffee$\/   , loaders: jsLoaders.concat([\"coffee\"]) }\n      { test: \/\\.litcoffee$\/, loaders: jsLoaders.concat([\"coffee?literate\"]) }\n      { test: \/\\.js$\/       , loaders: jsLoaders }\n    ]\n\n### Styles\n\nProcess Sass and use Autoprefixer.\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?last 2 versions']\n    styleModLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\n          \"sass?precision=10&outputStyle=expanded&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/ , loaders: cssLoaders }\n    ]\n\n### Static assets\n\nEmbed data-URLs into CSS and JS for small images and `.woff` fonts:\n\n    staticModLoaders = [\n      { test: \/\\.gif$\/ , loader: \"url?limit=10000&mimetype=image\/gif\" }\n      { test: \/\\.jpg$\/ , loader: \"url?limit=10000&mimetype=image\/jpg\" }\n      { test: \/\\.png$\/ , loader: \"url?limit=10000&mimetype=image\/png\" }\n      { test: \/\\.woff$\/, loader: \"url?limit=10000&mimetype=application\/font-woff\" }\n      { test: \/\\.ttf$\/ , loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n      { test: \/\\.eot$\/ , loader: \"file?mimetype=application\/x-font-ttf\" }\n      { test: \/\\.svg$\/ , loader: \"file?mimetype=image\/svg+xml\" }\n    ]\n\n### Output CSS to `.css` files\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not as `.js` files with embedded CSS strings.\n\nRequire the plugin:\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n\nSet `styleModLoaders` to use the plugin:\n\n    styleModLoaders = styleModLoaders.map (e) ->\n      { test: e.test, loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!')) }\n\nCreate an instance of the extractTextPlugin:\n\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\n### Define macro variables\n\n`DefinePlugin` defines variables to be substituted in the assets (a la macro).\n\nDefine `__PRODUCTION__: false` variable (set to true on `useProductionSettings()`):\n\n    definePlugin = new webpack.DefinePlugin(\n      __PRODUCTION__: JSON.stringify(false)\n    )\n\n### Other options\n\n    _.merge module.exports,\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n\nOutput options:\n\n      output:\n        path         : outputDir\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: ['bower_components', 'node_modules']\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleModLoaders.concat(scriptModLoaders).concat(staticModLoaders)\n        noParse: \/\\.min\\.js$\/\n\nDefine the plugins:\n\n      plugins: [\n\n`definePlugin` defines variables to be substituted in the assets (a la macro):\n\n        definePlugin\n\n`extractTextPlugin` (defined above) will compile CSS to a .css file, as opposed to inlining it as a string in a .js file.\n\n        extractTextPlugin\n      ]\n\n\n## Production overrides\n\nExport a method that applies production settings (used in gulpfile):\n\n      mergeProductionConfig: ->\n\nProduction plugins:\n\nSet `__PRODUCTION__` to true in the `DefinePlugin` instance:\n\n        definePlugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\nTell `ExtractTextPlugin` to append hashes (BROKEN, see [plugin issue #9](https:\/\/github.com\/webpack\/extract-text-webpack-plugin\/issues\/9)):\n\n        extractTextPlugin.filename = '[name]-[hash].css'\n\nMerge in production config (deep merge):\n\n        _.merge @,\n\nDisable development settings:\n\n          debug: false\n          watch: false\n          devtool: null\n\nAdd content hashes to the output filenames:\n\n          output:\n            filename: \"[name]-[hash].js\"\n\n          plugins: @plugins.concat [\n\nMinify JavaScript with UglifyJS:\n\n            new webpack.optimize.UglifyJsPlugin()\n\nGenerate asset -> asset-hash manifest:\n\n            generateManifestPlugin = (compiler) ->\n              @plugin 'done', (stats) ->\n                stats = stats.toJson()\n\nSet target path extension to `.css` for style assets, because we use `ExtractTextPlugin`:\n\n                assetStats = stats.assetsByChunkName\n                for entryName, entryPath of assetStats\n                  if \/\\.(?:scss|sass|css)$\/.test(entries[entryName])\n                    assetStats[entryName] = entryPath.replace(\/\\.js$\/, '.css')\n\nWrite asset-ref -> asset-hash manifest to outputDir\/stats.json\n\n                fs.writeFileSync(path.join(outputDir, \"asset-stats.json\"), JSON.stringify(stats.assetsByChunkName, null, 2))\n\n          ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"533aa0f8b9e3ba4b731294fad961db027e42b276","subject":"Add constraint to defining resources","message":"Add constraint to defining resources","repos":"smizell\/hyperdescribe-uber-json","old_file":"doc\/parser.litcoffee","new_file":"doc\/parser.litcoffee","new_contents":"# UBER and Hyperdescribe\n\nThe goal of this document is to outline how Hyperdescribe would be used to describe a UBER document according to the [current specs](https:\/\/rawgithub.com\/mamund\/media-types\/e034e9d9eae7fb4455f25c928cb84cd513f9472c\/uber-hypermedia.html). This document will look at the JSON variant of the UBER format.\n\n    _ = require 'underscore'\n\n    cleanItem = (data) ->\n      _.reduce data, (total, value, key) ->\n        total[key] = value if value? and value.length != 0\n        total\n      , {}\n\n## Types\n\nEven though UBER really only has one data element, `data`, this data element can be treated differently depending on the context. This section will look at each of these different types along with the conditions for those types and the means to describe them with Hyperdescribe.\n\n### Transitions\n\nIn Hyperdescribe, there are two types of transitions:\n\n1. Links\n2. Actions\n\nIn the UBER spec, though, links and actions are not separated in this way, so this document will specify how it is determined whether an item is a link or an action.\n\n#### Links\n\nItems in UBER that are considered links in Hyperdescribe are items with `read` as the action. If the `@action` attribute is absent and the `@url` attribute is present, the action is assumed to be `read`. Additionally, if the action specified is not listed in the spec, it should be treated as `read`. This is according to the UBER spec.\n\nFor an item to be considered a link, it MUST have a `@url` attribute, it MUST NOT have any data, and it MUST be a `read` action.\n\n    #getPropertyName = (data) ->\n    #  if data.id? then id else data.name\n\n    hasData = (data, level) ->\n      data.data? and data.data?.length != 0\n\n    isReadAction = (data) ->\n      (!data.action? or \n        data.action == 'read' or \n        data.action not in _.keys(availableActions))\n\n    isLink = (data, level) ->\n      data.url? and !hasData(data, level) and isReadAction(data)\n\n    mapLink = (data) ->\n      linkUrl = if data.model? then data.url + data.model else data.url\n\n      link =\n        id: data.id\n        name: data.name\n        rel: data.rel\n        #property: getPropertyName(data)\n        transclude: data.transclude\n        types: data.accepting\n        label: data.value\n\n      link.href = if data.model? then data.url + data.model else data.url\n      link.template = true if data.model?\n\n      link\n\n#### Actions\n\nUBER only specifies available actions and also provides a mapping of these actions to their corresponding HTTP verbs (see [section 4.1.1](https:\/\/rawgithub.com\/mamund\/media-types\/master\/uber-hypermedia.html#_mapping_uber_tt_action_tt_values_to_http_methods)).\n\n    availableActions =\n      append: 'POST'\n      partial: 'PATCH'\n      read: 'GET'\n      remove: 'DELETE'\n      replace: 'PUT'\n\nItems that are considered actions MUST have an `@action` attribute, MUST have a `@url`, MAY have a `@model`, and MUST use an avaiable action from the spec.\n\n    isAction = (data, level) ->\n      data.action? and\n        data.url? and\n        data.action in _.keys(availableActions)\n\nAccording to 4.1.1, there are only three actions that modify the body of the message sent:\n\n* append\n* partial\n* replace\n\nSince `read` actions are handled by links, `remove` is the only action that needs special treatment.\n\n    modifiesBody = [\n      'append'\n      'partial'\n      'replace'\n    ]\n\n    parseBodyModel = (model) ->\n      items = model.split('&').map (item) ->\n        [key, value] = item.split('=')\n        { name: key, type: \"text\", mapsTo: value[1..-2] }\n\n    mapAction = (data) ->\n      action = \n        name: data.name\n        rel: data.rel\n        method: availableActions[data.action]\n        sendAs: data.sending\n\nIf an action is one that does not modify the body, the model is added to the action's `@url` attribute and template is set to `true`, which conveys it is templated action.\n\n      if data.action not in modifiesBody and data.model?\n        action.url = data.url + data.model\n        action.template = true\n\nIf the action does modify the body, the model is parsed and fields are created.\n\n      if data.action in modifiesBody\n        action.url = data.url\n        action.fields = parseBodyModel(data.model)\n      cleanItem(action)\n\n### Properties\n\nAn item that is considered a property of a resource MUST have a `@value`, MUST NOT be at the root level (or in other words, MUST be a child element), MUST NOT be a transition, and MUST NOT have a `@data` attribute.\n\n    isTransition = (data, level) ->\n      isLink(data, level) or isAction(data, level)\n\n    isProperty = (data, level) ->\n      data.value? and level != 0 and !isTransition(data, level) and !hasData(data, level)\n\nCurrently, with regards to mapping to Hyperdescribe, the only relevant values will be `@name` and `@value`.\n\n    mapProperty = (data) ->\n      cleanItem\n        name: data.name\n        value: data.value\n\n### Resources\n\nAn item considered a resource MUST NOT have an `@action` attribute and MUST have a `@data` attribute. Any `@value` attribute will be ignored. Like the `data` element in UBER, Hyperdescribe can handle nested resources.\n\n    isResource = (data, level) ->\n      !data.action? and hasData(data, level)\n\nMapping a resource from UBER to Hyperdescribe requires finding all of the links, actions, and properties, along with all nested resources. Once those are all found, they can then be mapped to how \n\n    mapResource = (data, level) ->\n      links = data.data.filter (d) -> isLink(d, level)\n      actions = data.data.filter (d) -> isAction(d, level)\n      resources = data.data.filter (d) -> isResource(d, level)\n      properties = data.data.filter (d) -> isProperty(d, level)\n\n      hLinks = links.map (link) -> mapLink(link)\n      hActions = actions.map (action) -> mapAction(action)\n      hResources = resources.map (resource) -> mapResource(resource, level + 1)\n      hProperties = properties.map (property) -> mapProperty(property)\n\n      cleanItem\n        name: data.name\n        links: hLinks\n        actions: hActions\n        resources: hResources\n        properties: hProperties\n\n## UBER Document\n\nMapping an UBER document to Hyperdescribe requires treating the root `@uber` element as a resource. Since each resource can have nested resources, Hyperdescribe should map each resource recursively.\n\n    mapUberDocument = module.exports = (uber) -> mapResource(uber.uber, 0)\n\n## Issues\n\n1. There is currently no way to tell whether a nested link should be a property of the resource (e.g. the `avatarUrl` in the example in the spec) or just a normal link. \n2. Is there any way to specify schema.org information for an UBER document?\n\n","old_contents":"# UBER and Hyperdescribe\n\nThe goal of this document is to outline how Hyperdescribe would be used to describe a UBER document according to the [current specs](https:\/\/rawgithub.com\/mamund\/media-types\/e034e9d9eae7fb4455f25c928cb84cd513f9472c\/uber-hypermedia.html). This document will look at the JSON variant of the UBER format.\n\n    _ = require 'underscore'\n\n    cleanItem = (data) ->\n      _.reduce data, (total, value, key) ->\n        total[key] = value if value? and value.length != 0\n        total\n      , {}\n\n## Types\n\nEven though UBER really only has one data element, `data`, this data element can be treated differently depending on the context. This section will look at each of these different types along with the conditions for those types and the means to describe them with Hyperdescribe.\n\n### Transitions\n\nIn Hyperdescribe, there are two types of transitions:\n\n1. Links\n2. Actions\n\nIn the UBER spec, though, links and actions are not separated in this way, so this document will specify how it is determined whether an item is a link or an action.\n\n#### Links\n\nItems in UBER that are considered links in Hyperdescribe are items with `read` as the action. If the `@action` attribute is absent and the `@url` attribute is present, the action is assumed to be `read`. Additionally, if the action specified is not listed in the spec, it should be treated as `read`. This is according to the UBER spec.\n\nFor an item to be considered a link, it MUST have a `@url` attribute, it MUST NOT have any data, and it MUST be a `read` action.\n\n    #getPropertyName = (data) ->\n    #  if data.id? then id else data.name\n\n    hasData = (data, level) ->\n      data.data? and data.data?.length != 0\n\n    isReadAction = (data) ->\n      (!data.action? or \n        data.action == 'read' or \n        data.action not in _.keys(availableActions))\n\n    isLink = (data, level) ->\n      data.url? and !hasData(data, level) and isReadAction(data)\n\n    mapLink = (data) ->\n      linkUrl = if data.model? then data.url + data.model else data.url\n\n      link =\n        id: data.id\n        name: data.name\n        rel: data.rel\n        #property: getPropertyName(data)\n        transclude: data.transclude\n        types: data.accepting\n        label: data.value\n\n      link.href = if data.model? then data.url + data.model else data.url\n      link.template = true if data.model?\n\n      link\n\n#### Actions\n\nUBER only specifies available actions and also provides a mapping of these actions to their corresponding HTTP verbs (see [section 4.1.1](https:\/\/rawgithub.com\/mamund\/media-types\/master\/uber-hypermedia.html#_mapping_uber_tt_action_tt_values_to_http_methods)).\n\n    availableActions =\n      append: 'POST'\n      partial: 'PATCH'\n      read: 'GET'\n      remove: 'DELETE'\n      replace: 'PUT'\n\nItems that are considered actions MUST have an `@action` attribute, MUST have a `@url`, MAY have a `@model`, and MUST use an avaiable action from the spec.\n\n    isAction = (data, level) ->\n      data.action? and\n        data.url? and\n        data.action in _.keys(availableActions)\n\nAccording to 4.1.1, there are only three actions that modify the body of the message sent:\n\n* append\n* partial\n* replace\n\nSince `read` actions are handled by links, `remove` is the only action that needs special treatment.\n\n    modifiesBody = [\n      'append'\n      'partial'\n      'replace'\n    ]\n\n    parseBodyModel = (model) ->\n      items = model.split('&').map (item) ->\n        [key, value] = item.split('=')\n        { name: key, type: \"text\", mapsTo: value[1..-2] }\n\n    mapAction = (data) ->\n      action = \n        name: data.name\n        rel: data.rel\n        method: availableActions[data.action]\n        sendAs: data.sending\n\nIf an action is one that does not modify the body, the model is added to the action's `@url` attribute and template is set to `true`, which conveys it is templated action.\n\n      if data.action not in modifiesBody and data.model?\n        action.url = data.url + data.model\n        action.template = true\n\nIf the action does modify the body, the model is parsed and fields are created.\n\n      if data.action in modifiesBody\n        action.url = data.url\n        action.fields = parseBodyModel(data.model)\n      cleanItem(action)\n\n### Properties\n\nAn item that is considered a property of a resource MUST have a `@value`, MUST NOT be at the root level (or in other words, MUST be a child element), MUST NOT be a transition, and MUST NOT have a `@data` attribute.\n\n    isTransition = (data, level) ->\n      isLink(data, level) or isAction(data, level)\n\n    isProperty = (data, level) ->\n      data.value? and level != 0 and !isTransition(data, level) and !hasData(data, level)\n\nCurrently, with regards to mapping to Hyperdescribe, the only relevant values will be `@name` and `@value`.\n\n    mapProperty = (data) ->\n      cleanItem\n        name: data.name\n        value: data.value\n\n### Resources\n\nAn item considered a resource MUST NOT have an `@action` attribute and MUST have a `@data` attribute. Like the `data` element in UBER, Hyperdescribe can handle nested resources.\n\n    isResource = (data, level) ->\n      !data.action? and hasData(data, level)\n\nMapping a resource from UBER to Hyperdescribe requires finding all of the links, actions, and properties, along with all nested resources. Once those are all found, they can then be mapped to how \n\n    mapResource = (data, level) ->\n      links = data.data.filter (d) -> isLink(d, level)\n      actions = data.data.filter (d) -> isAction(d, level)\n      resources = data.data.filter (d) -> isResource(d, level)\n      properties = data.data.filter (d) -> isProperty(d, level)\n\n      hLinks = links.map (link) -> mapLink(link)\n      hActions = actions.map (action) -> mapAction(action)\n      hResources = resources.map (resource) -> mapResource(resource, level + 1)\n      hProperties = properties.map (property) -> mapProperty(property)\n\n      cleanItem\n        name: data.name\n        links: hLinks\n        actions: hActions\n        resources: hResources\n        properties: hProperties\n\n## UBER Document\n\nMapping an UBER document to Hyperdescribe requires treating the root `@uber` element as a resource. Since each resource can have nested resources, Hyperdescribe should map each resource recursively.\n\n    mapUberDocument = module.exports = (uber) -> mapResource(uber.uber, 0)\n\n## Issues\n\n1. There is currently no way to tell whether a nested link should be a property of the resource (e.g. the `avatarUrl` in the example in the spec) or just a normal link. \n2. Is there any way to specify schema.org information for an UBER document?\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7224f4ea63807519afbaa40c941debff47bb408c","subject":"<script> coffeescript files fixed","message":"<script> coffeescript files fixed\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/document\/file\/parse\/scripts.litcoffee","new_file":"src\/document\/file\/parse\/scripts.litcoffee","new_contents":"# script\n\n    'use strict'\n\n    fs = require 'fs-extra'\n    os = require 'os'\n    utils = require 'src\/utils'\n    pathUtils = require 'path'\n    {getFilePath} = require '.\/links'\n\n    uid = 0\n    realpath = fs.realpathSync '.\/'\n    tmpdir = os.tmpdir()\n\n    isCoffee = (path) -> \/\\.(?:coffee|litcoffee|coffee\\.md)$\/.test(path)\n    getScriptPath = (filename) ->\n        extname = (filename and pathUtils.extname(filename)) or '.js'\n        \"build\/scripts\/#{uid++}#{extname}\"\n\n    module.exports = (File) -> (file) ->\n        if file instanceof File.Iterator\n            return\n\n        scripts = []\n\n        for tag in file.node.queryAll('script')\n            omit = false\n            for attr of tag.attrs\n                if attr not in ['src', 'href', 'filename']\n                    omit = true\n                    break\n            if omit\n                continue\n\n            tag.parent = null\n\n            {src} = tag.attrs\n            src ||= tag.attrs.href\n\n            if src\n                src = getFilePath File, file, src\n                path = getScriptPath src\n                fs.copySync src, path\n                scripts.push path\n            else\n                # tag body\n                str = tag.stringifyChildren()\n                path = getScriptPath tag.attrs.filename\n                if isCoffee(path)\n                    str = \"`module.exports = function(){`\\n\\n#{str}\\n\\n`};`\"\n                else\n                    str = \"module.exports = function(){\\n\\n#{str}\\n\\n};\"\n                fs.outputFileSync path, str\n                scripts.push path\n\n        file.scripts = new File.Scripts file, scripts\n\n        return\n\n# Glossary\n\n- [script](#neftscript)\n","old_contents":"# script\n\n    'use strict'\n\n    fs = require 'fs-extra'\n    os = require 'os'\n    utils = require 'src\/utils'\n    pathUtils = require 'path'\n    {getFilePath} = require '.\/links'\n\n    uid = 0\n    realpath = fs.realpathSync '.\/'\n    tmpdir = os.tmpdir()\n\n    isCoffee = (path) -> \/\\.(?:coffee|litcoffee|coffee\\.md)$\/.test(path)\n    getScriptPath = (filename) ->\n        extname = (filename and pathUtils.extname(filename)) or '.js'\n        \"build\/scripts\/#{uid++}.js\"\n\n    module.exports = (File) -> (file) ->\n        if file instanceof File.Iterator\n            return\n\n        scripts = []\n\n        for tag in file.node.queryAll('script')\n            omit = false\n            for attr of tag.attrs\n                if attr not in ['src', 'href', 'filename']\n                    omit = true\n                    break\n            if omit\n                continue\n\n            tag.parent = null\n\n            {src} = tag.attrs\n            src ||= tag.attrs.href\n\n            if src\n                src = getFilePath File, file, src\n                path = getScriptPath src\n                fs.copySync src, path\n                scripts.push path\n            else\n                # tag body\n                str = tag.stringifyChildren()\n                path = getScriptPath tag.attrs.filename\n                if isCoffee(path)\n                    str = \"`module.exports = function(){`\\n\\n#{str}\\n\\n`};`\"\n                else\n                    str = \"module.exports = function(){\\n\\n#{str}\\n\\n};\"\n                fs.outputFileSync path, str\n                scripts.push path\n\n        file.scripts = new File.Scripts file, scripts\n\n        return\n\n# Glossary\n\n- [script](#neftscript)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"4bae4822ba2013daf966b76b146c8187c944e4fe","subject":"Use eachSeries instead of each","message":"Use eachSeries instead of each\n\nWhile processing dependencies in parallel would be awesome, it is not to be ...\n\nThe only way to ensure that a dependency is fully loaded before moving on to\nthe next one is to load the dependencies serially.\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    Array.prototype.last = -> this[this.length - 1]\n\n    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n\n    microtime = require 'microtime'\n\n    logger = require '.\/logger'\n\n    classes     = { }\n    available   = { }\n    initialized = { }\n\n    class Madul\n\n      constructor: (madul_name, class_name) ->\n        @debug = (msg, data) -> logger.debug msg, data\n        @info  = (msg, data) -> logger.info  msg, data\n        @warn  = (msg, data) -> logger.warn  msg, data\n        @error = (msg, data) -> logger.error msg, data\n\n        @clazz       = class_name || arguments.callee.caller.name\n        @madul_name  = madul_name\n\n        classes[@clazz] = madul_name\n\n        initialized[@clazz] = false unless initialized[@clazz] == true\n\n        logger.trace \"Instantiating #{@clazz}\"\n\n      do_wrap: (method) =>\n        callMe = @[method]\n\n        @[\"_#{method}\"] = @[method]\n\n        @[method] = =>\n          deferred = q.defer()\n          start    = microtime.now()\n          update   = start\n\n          respond = (state, data) =>\n            deferred[state] data\n\n            if state == 'reject'\n              logger.rejected @clazz, method, microtime.now() - start, data\n\n            if process.env.MADUL_LOG_LEVEL > 4\n              if state == 'resolve'\n                logger.resolved @clazz, method, microtime.now() - start, data\n              else if state == 'notify'\n                logger.notify @clazz, method, microtime.now() - update, data\n                update = microtime.now()\n\n          @done   = (out) => respond 'resolve', out\n          @fail   = (err) => respond 'reject',  err\n          @update = (out) => respond 'notify',  out\n\n          args = Array.prototype.slice.call arguments\n\n          logger.trace \"Invoking #{@clazz}.#{method}()\", args\n\n          @[\"_#{method}\"].apply null, args\n\n          deferred.promise\n\n      wrap_methods: => @pub?.forEach (method) => @do_wrap method\n\n      hydrate: (deps, done) =>\n        load = (name, path, loaded) =>\n          mod = require path\n\n          if typeof mod == 'function'\n            new mod name\n              .initialize @ctor_params?[name]\n              .then (mod) =>\n                available[name] = mod\n                loaded true\n          else\n            available[name] = mod\n            loaded true\n\n        check_directory = (path, dep, loaded) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              done type: 'ERROR', info: err\n            else\n              async.each files, (f, next) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.stat depth, (e, s) =>\n                  if s.isDirectory() && f[0] != '.'\n                    check_directory depth, dep, => next()\n                  else if s.isFile() && f.substring(0, f.length - 3) == dep\n                    load f.substring(0, f.length - 3), depth, => loaded true\n                  else\n                    next()\n              , => loaded true\n\n        add_dependency = (name, mod) =>\n          n = name.replace \/\\W+\/g, '_'\n          @[n] = mod\n\n        async.eachSeries deps, (d, next) =>\n          if @[d]? == false\n            if available[d]? == true\n              add_dependency d, available[d]\n              next()\n            else\n              try\n                available[d] = require d\n                add_dependency d, available[d]\n                next()\n              catch e\n                pkg = \"#{process.cwd()}\/node_modules\/#{d}\/package.json\"\n\n                fs.stat pkg, (err, stat) =>\n                  if stat?.isFile()\n                    fs.readFile pkg, 'utf8', (err, data) =>\n                      json = JSON.parse data\n                      main = json.main || json._main\n\n                      available[d] = require \"#{process.cwd()}\/node_modules\/#{d}\/#{main}\"\n\n                      add_dependency d, available[d]\n                      next()\n                  else\n                    check_directory \"#{process.cwd()}\/dist\", d, (loaded) =>\n                      if loaded\n                        add_dependency d, available[d]\n                        next()\n          else\n            next()\n        , done\n\n      finish_up: (resolve, args) =>\n        if typeof @post_initialize == 'function'\n          @do_wrap 'post_initialize'\n          @post_initialize(args)\n            .then =>\n              available[classes[@clazz]] = @\n              resolve @\n        else\n          available[classes[@clazz]] = @\n          resolve @\n\n      initialize: (args = { }, wrap = true) =>\n        deferred = q.defer()\n\n        if initialized[@clazz] == false\n          initialized[@clazz] = true\n\n          @wrap_methods() if wrap\n\n          if @deps?\n            @hydrate @deps, => @finish_up deferred.resolve, args\n          else\n            @finish_up deferred.resolve, args\n        else\n          process.nextTick => deferred.resolve available[classes[@clazz]]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    Array.prototype.last = -> this[this.length - 1]\n\n    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n\n    microtime = require 'microtime'\n\n    logger = require '.\/logger'\n\n    classes     = { }\n    available   = { }\n    initialized = { }\n\n    class Madul\n\n      constructor: (madul_name, class_name) ->\n        @debug = (msg, data) -> logger.debug msg, data\n        @info  = (msg, data) -> logger.info  msg, data\n        @warn  = (msg, data) -> logger.warn  msg, data\n        @error = (msg, data) -> logger.error msg, data\n\n        @clazz       = class_name || arguments.callee.caller.name\n        @madul_name  = madul_name\n\n        classes[@clazz] = madul_name\n\n        initialized[@clazz] = false unless initialized[@clazz] == true\n\n        logger.trace \"Instantiating #{@clazz}\"\n\n      do_wrap: (method) =>\n        callMe = @[method]\n\n        @[\"_#{method}\"] = @[method]\n\n        @[method] = =>\n          deferred = q.defer()\n          start    = microtime.now()\n          update   = start\n\n          respond = (state, data) =>\n            deferred[state] data\n\n            if state == 'reject'\n              logger.rejected @clazz, method, microtime.now() - start, data\n\n            if process.env.MADUL_LOG_LEVEL > 4\n              if state == 'resolve'\n                logger.resolved @clazz, method, microtime.now() - start, data\n              else if state == 'notify'\n                logger.notify @clazz, method, microtime.now() - update, data\n                update = microtime.now()\n\n          @done   = (out) => respond 'resolve', out\n          @fail   = (err) => respond 'reject',  err\n          @update = (out) => respond 'notify',  out\n\n          args = Array.prototype.slice.call arguments\n\n          logger.trace \"Invoking #{@clazz}.#{method}()\", args\n\n          @[\"_#{method}\"].apply null, args\n\n          deferred.promise\n\n      wrap_methods: => @pub?.forEach (method) => @do_wrap method\n\n      hydrate: (deps, done) =>\n        load = (name, path, loaded) =>\n          mod = require path\n\n          if typeof mod == 'function'\n            new mod name\n              .initialize @ctor_params?[name]\n              .then (mod) =>\n                available[name] = mod\n                loaded true\n          else\n            available[name] = mod\n            loaded true\n\n        check_directory = (path, dep, loaded) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              done type: 'ERROR', info: err\n            else\n              async.each files, (f, next) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.stat depth, (e, s) =>\n                  if s.isDirectory() && f[0] != '.'\n                    check_directory depth, dep, => next()\n                  else if s.isFile() && f.substring(0, f.length - 3) == dep\n                    load f.substring(0, f.length - 3), depth, => loaded true\n                  else\n                    next()\n              , => loaded true\n\n        add_dependency = (name, mod) =>\n          n = name.replace \/\\W+\/g, '_'\n          @[n] = mod\n\n        async.each deps, (d, next) =>\n          if @[d]? == false\n            if available[d]? == true\n              add_dependency d, available[d]\n              next()\n            else\n              try\n                available[d] = require d\n                add_dependency d, available[d]\n                next()\n              catch e\n                pkg = \"#{process.cwd()}\/node_modules\/#{d}\/package.json\"\n\n                fs.stat pkg, (err, stat) =>\n                  if stat?.isFile()\n                    fs.readFile pkg, 'utf8', (err, data) =>\n                      json = JSON.parse data\n                      main = json.main || json._main\n\n                      available[d] = require \"#{process.cwd()}\/node_modules\/#{d}\/#{main}\"\n\n                      add_dependency d, available[d]\n                      next()\n                  else\n                    check_directory \"#{process.cwd()}\/dist\", d, (loaded) =>\n                      if loaded\n                        add_dependency d, available[d]\n                        next()\n          else\n            next()\n        , done\n\n      finish_up: (resolve, args) =>\n        if typeof @post_initialize == 'function'\n          @do_wrap 'post_initialize'\n          @post_initialize(args)\n            .then =>\n              available[classes[@clazz]] = @\n              resolve @\n        else\n          available[classes[@clazz]] = @\n          resolve @\n\n      initialize: (args = { }, wrap = true) =>\n        deferred = q.defer()\n\n        if initialized[@clazz] == false\n          initialized[@clazz] = true\n\n          @wrap_methods() if wrap\n\n          if @deps?\n            @hydrate @deps, => @finish_up deferred.resolve, args\n          else\n            @finish_up deferred.resolve, args\n        else\n          process.nextTick => deferred.resolve available[classes[@clazz]]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"02114dd49896bb66fceafa1531d6d2c3f27c5874","subject":"Fix typo check for proper end case","message":"Fix typo check for proper end case\n\n**SUPER IMPORTANT** Since we're using `@grid` directly now, and `@grid`\nis an array, we need ot make sure we're checking for `@grid.length - 1`\nor else `Carver` will never think it's done.\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/carver.litcoffee","new_file":"lib\/carver.litcoffee","new_contents":"    Module = require '.\/module'\n\n    class Carver extends Module\n      pub: [ 'carve_path' ]\n\n      grid:  undefined\n      row:   0\n      col:   0\n      steps: 0\n      path:  [ ]\n\n      previous_direction: undefined\n      total_distance:     0\n      director:           undefined\n      farthest_right:\n        row: 0\n        col: 0\n\n      directions:\n        LEFT:  0\n        RIGHT: 1\n        UP:    2\n        DOWN:  3\n\n      initialize: (grid, starting_row, director) =>\n        @grid  = grid\n        @path  = [ ]\n        @row   = starting_row\n        @col   = 0\n\n        @farthest_right     = row: @row, col: 0\n        @previous_direction = undefined\n\n        @steps          = 0\n        @total_distance = 0\n\n        @director = director\n\n        @grid[@row][@col] = true\n        @path.push row: @row, col: @col\n\n        super()\n\n      update_steps: (dir) =>\n        if @previous_direction?\n          if @previous_direction == @directions[dir]\n            ++@steps\n          else\n            @steps = 0\n        else\n          @previous_direction = @directions[dir]\n          @steps = 0\n\n      neighbor: (x = 0, y = 0) => @grid[@row + x][@col + y]\n\n      carve_path: =>\n        neighbors = [ ]\n        width     = @grid[0].length\n        height    = @grid.length\n\n        neighbors.push 'UP'    if @row > 0          && @neighbor(-1,  0) == false\n        neighbors.push 'DOWN'  if @row < height - 2 && @neighbor( 1,  0) == false\n        neighbors.push 'LEFT'  if @col > 0          && @neighbor( 0, -1) == false\n        neighbors.push 'RIGHT' if @col < width      && @neighbor( 0,  1) == false\n\n        if neighbors.length == 0\n          @col = @farthest_right.col\n          @row = @farthest_right.row\n\n          @carve_path()\n        else\n          direction = @director neighbors\n\n          switch @directions[direction]\n            when @directions.RIGHT then @grid[@row][++@col] = true\n            when @directions.LEFT  then @grid[@row][--@col] = true\n            when @directions.UP    then @grid[--@row][@col] = true\n            when @directions.DOWN  then @grid[++@row][@col] = true\n            when undefined         then return @carve_path()\n\n          @update_steps direction\n\n          if @col > @farthest_right.col\n            @farthest_right.col = @col\n            @farthest_right.row = @row\n\n          if @farthest_right.col < @grid[0].length - 1\n            @path.push row: @row, col: @col, direction: direction\n\n            stats =\n              position:\n                row: @row\n                col: @col\n              steps: @steps\n              direction: direction\n              distance: ++@total_distance\n\n            @update stats\n\n            @carve_path()\n          else\n            @done @path\n\n    module.exports = Carver\n","old_contents":"    Module = require '.\/module'\n\n    class Carver extends Module\n      pub: [ 'carve_path' ]\n\n      grid:  undefined\n      row:   0\n      col:   0\n      steps: 0\n      path:  [ ]\n\n      previous_direction: undefined\n      total_distance:     0\n      director:           undefined\n      farthest_right:\n        row: 0\n        col: 0\n\n      directions:\n        LEFT:  0\n        RIGHT: 1\n        UP:    2\n        DOWN:  3\n\n      initialize: (grid, starting_row, director) =>\n        @grid  = grid\n        @path  = [ ]\n        @row   = starting_row\n        @col   = 0\n\n        @farthest_right     = row: @row, col: 0\n        @previous_direction = undefined\n\n        @steps          = 0\n        @total_distance = 0\n\n        @director = director\n\n        @grid[@row][@col] = true\n        @path.push row: @row, col: @col\n\n        super()\n\n      update_steps: (dir) =>\n        if @previous_direction?\n          if @previous_direction == @directions[dir]\n            ++@steps\n          else\n            @steps = 0\n        else\n          @previous_direction = @directions[dir]\n          @steps = 0\n\n      neighbor: (x = 0, y = 0) => @grid[@row + x][@col + y]\n\n      carve_path: =>\n        neighbors = [ ]\n        width     = @grid[0].length\n        height    = @grid.length\n\n        neighbors.push 'UP'    if @row > 0          && @neighbor(-1,  0) == false\n        neighbors.push 'DOWN'  if @row < height - 2 && @neighbor( 1,  0) == false\n        neighbors.push 'LEFT'  if @col > 0          && @neighbor( 0, -1) == false\n        neighbors.push 'RIGHT' if @col < width      && @neighbor( 0,  1) == false\n\n        if neighbors.length == 0\n          @col = @farthest_right.col\n          @row = @farthest_right.row\n\n          @carve_path()\n        else\n          direction = @director neighbors\n\n          switch @directions[direction]\n            when @directions.RIGHT then @grid[@row][++@col] = true\n            when @directions.LEFT  then @grid[@row][--@col] = true\n            when @directions.UP    then @grid[--@row][@col] = true\n            when @directions.DOWN  then @grid[++@row][@col] = true\n            when undefined         then return @carve_path()\n\n          @update_steps direction\n\n          if @col > @farthest_right.col\n            @farthest_right.col = @col\n            @farthest_right.row = @row\n\n          if @farthest_right.col < @gred[0].length\n            @path.push row: @row, col: @col, direction: direction\n\n            stats =\n              position:\n                row: @row\n                col: @col\n              steps: @steps\n              direction: direction\n              distance: ++@total_distance\n\n            @update stats\n\n            @carve_path()\n          else\n            @done @path\n\n    module.exports = Carver\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9df4d0286b44e7a8234c6627e542d43eae3e89f3","subject":"Each magic method invokation gets it's own promise","message":"Each magic method invokation gets it's own promise\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/module.litcoffee","new_file":"lib\/module.litcoffee","new_contents":"    q  = require 'q'\n    fs = require 'fs'\n\n    microtime = require 'microtime'\n\n    logger = require '.\/logger'\n\n    available = { }\n    loaded    = { }\n    processed = { }\n\n    class Module\n\n      constructor: ->\n        @debug = (msg, data) -> logger.debug msg, data\n        @info  = (msg, data) -> logger.info  msg, data\n        @warn  = (msg, data) -> logger.warn  msg, data\n        @error = (msg, data) -> logger.error msg, data\n\n        if arguments.length == 0 || arguments[0] == ''\n          @clazz = arguments.callee.caller.name\n        else\n          @clazz = arguments[0]\n\n        logger.trace \"Instantiating #{@clazz}\"\n\n      wrap_methods: =>\n        @pub?.forEach (method) =>\n          callMe   = @[method]\n\n          @[\"_#{method}\"] = @[method]\n\n          @[method] = =>\n            deferred = q.defer()\n            start    = microtime.now()\n            update   = start\n\n            respond = (state, data) =>\n              process.nextTick =>\n                deferred[state] data\n\n                if state == 'reject'\n                  logger.rejected @clazz, method, microtime.now() - start, data\n\n                if process.env.MADUL_LOG_LEVEL > 4\n                  if state == 'resolve'\n                    logger.resolved @clazz, method, microtime.now() - start, data\n                  else if state == 'notify'\n                    logger.notify @clazz, method, microtime.now() - update, data\n                    update = microtime.now()\n\n            @done   = (out) => respond 'resolve', out\n            @fail   = (err) => respond 'reject',  err\n            @update = (out) => respond 'notify',  out\n\n            args = Array.prototype.slice.call arguments\n\n            logger.trace \"Invoking #{@clazz}.#{method}()\", args\n\n            @[\"_#{method}\"].apply null, args\n\n            deferred.promise\n\n      hydrate_dependencies: =>\n        def = q.defer()\n        good_to_go = false\n\n        load = (name, path, cb) =>\n          if available[name]? == false\n            mod = require path\n\n            if typeof mod == 'function'\n              new mod()\n                .initialize @ctor_params?[name]\n                .then (mod) =>\n                  available[name] = mod\n                  cb()\n            else\n              available[name] = mod\n              cb()\n          else\n            cb()\n\n        check_directory = (path, dep, cb) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              def.reject type: 'ERROR', info: err\n            else\n              to_check = files.length\n              checked = 0\n\n              files.forEach (f) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.lstat depth, (e, s) =>\n                  if s.isDirectory()\n                    check_directory depth, dep, =>\n                      cb() if ++checked == to_check\n                  else if s.isFile()\n                    if f == 'index.js' || f.includes '.spec.'\n                      cb() if ++checked == to_check\n                    else\n                      name = f.substring 0, f.length - 3\n\n                      if name == dep\n                        load name, depth, => cb() if ++checked == to_check\n                      else\n                        cb() if ++checked == to_check\n\n        register_dependency = (name, mod) =>\n          n = name.replace \/\\W+\/g, '_'\n          @[n] = mod\n\n          def.notify type: 'NOTICE', loaded: n\n\n          unless loaded[@clazz]?\n            loaded[@clazz] = [ ]\n\n          unless processed[@clazz]?\n            processed[@clazz] = 0\n\n          unless loaded[@clazz].indexOf(name) > -1\n            loaded[@clazz].push name\n            ++processed[@clazz]\n\n          logger.trace 'Registered dependency', \"#{@clazz}\": \"#{n}(file: #{name})\"\n\n          if processed[@clazz] >= @deps.length\n            if loaded[@clazz].length >= @deps.length\n              logger.trace \"Loaded all dependencies: #{@clazz}\", loaded[@clazz]\n              def.resolve @\n            else\n              not_loaded = [ ]\n\n              @deps.forEach (d) -> not_loaded.push(d) unless loaded[@clazz].indexOf(d) > -1\n\n              logger.error \"Failed loading dependencies for: #{@clazz}\", not_loaded\n\n              def.reject type: 'ERROR', not_loaded: not_loaded\n\n        @deps?.forEach (d) =>\n          if @[d]?\n            good_to_go = true\n          else\n            if available[d]? == true\n              register_dependency d, available[d]\n            else\n              try\n                available[d] = require d\n                register_dependency d, available[d]\n              catch\n                check_directory __dirname, d, =>\n                  register_dependency d, available[d]\n\n        if good_to_go && loaded[@clazz].length >= @deps.length\n          process.nextTick => def.resolve @\n\n        def.promise\n\n      initialize: (wrap = true) =>\n        deferred = q.defer()\n\n        if @deps?\n          @hydrate_dependencies()\n            .then =>\n              @wrap_methods() if wrap\n              deferred.resolve @\n            .fail (reason) => deferred.reject reason\n        else\n          process.nextTick =>\n            @wrap_methods() if wrap\n            deferred.resolve @\n\n        deferred.promise\n\n    module.exports = Module\n","old_contents":"    q  = require 'q'\n    fs = require 'fs'\n\n    microtime = require 'microtime'\n\n    logger = require '.\/logger'\n\n    available = { }\n    loaded    = { }\n    processed = { }\n\n    class Module\n\n      constructor: ->\n        @debug = (msg, data) -> logger.debug msg, data\n        @info  = (msg, data) -> logger.info  msg, data\n        @warn  = (msg, data) -> logger.warn  msg, data\n        @error = (msg, data) -> logger.error msg, data\n\n        if arguments.length == 0 || arguments[0] == ''\n          @clazz = arguments.callee.caller.name\n        else\n          @clazz = arguments[0]\n\n        logger.trace \"Instantiating #{@clazz}\"\n\n      wrap_methods: =>\n        @pub?.forEach (method) =>\n          callMe   = @[method]\n          deferred = q.defer()\n\n          @[\"_#{method}\"] = @[method]\n\n          @[method] = =>\n            start    = microtime.now()\n            update   = start\n\n            respond = (state, data) =>\n              process.nextTick =>\n                deferred[state] data\n\n                if state == 'reject'\n                  logger.rejected @clazz, method, microtime.now() - start, data\n\n                if process.env.MADUL_LOG_LEVEL > 4\n                  if state == 'resolve'\n                    logger.resolved @clazz, method, microtime.now() - start, data\n                  else if state == 'notify'\n                    logger.notify @clazz, method, microtime.now() - update, data\n                    update = microtime.now()\n\n            @done   = (out) => respond 'resolve', out\n            @fail   = (err) => respond 'reject',  err\n            @update = (out) => respond 'notify',  out\n\n            args = Array.prototype.slice.call arguments\n\n            logger.trace \"Invoking #{@clazz}.#{method}()\", args\n\n            @[\"_#{method}\"].apply null, args\n\n            deferred.promise\n\n      hydrate_dependencies: =>\n        def = q.defer()\n        good_to_go = false\n\n        load = (name, path, cb) =>\n          if available[name]? == false\n            mod = require path\n\n            if typeof mod == 'function'\n              new mod()\n                .initialize @ctor_params?[name]\n                .then (mod) =>\n                  available[name] = mod\n                  cb()\n            else\n              available[name] = mod\n              cb()\n          else\n            cb()\n\n        check_directory = (path, dep, cb) =>\n          fs.readdir path, (err, files) =>\n            if err?\n              def.reject type: 'ERROR', info: err\n            else\n              to_check = files.length\n              checked = 0\n\n              files.forEach (f) =>\n                depth = \"#{path}\/#{f}\"\n\n                fs.lstat depth, (e, s) =>\n                  if s.isDirectory()\n                    check_directory depth, dep, =>\n                      cb() if ++checked == to_check\n                  else if s.isFile()\n                    if f == 'index.js' || f.includes '.spec.'\n                      cb() if ++checked == to_check\n                    else\n                      name = f.substring 0, f.length - 3\n\n                      if name == dep\n                        load name, depth, => cb() if ++checked == to_check\n                      else\n                        cb() if ++checked == to_check\n\n        register_dependency = (name, mod) =>\n          n = name.replace \/\\W+\/g, '_'\n          @[n] = mod\n\n          def.notify type: 'NOTICE', loaded: n\n\n          unless loaded[@clazz]?\n            loaded[@clazz] = [ ]\n\n          unless processed[@clazz]?\n            processed[@clazz] = 0\n\n          unless loaded[@clazz].indexOf(name) > -1\n            loaded[@clazz].push name\n            ++processed[@clazz]\n\n          logger.trace 'Registered dependency', \"#{@clazz}\": \"#{n}(file: #{name})\"\n\n          if processed[@clazz] >= @deps.length\n            if loaded[@clazz].length >= @deps.length\n              logger.trace \"Loaded all dependencies: #{@clazz}\", loaded[@clazz]\n              def.resolve @\n            else\n              not_loaded = [ ]\n\n              @deps.forEach (d) -> not_loaded.push(d) unless loaded[@clazz].indexOf(d) > -1\n\n              logger.error \"Failed loading dependencies for: #{@clazz}\", not_loaded\n\n              def.reject type: 'ERROR', not_loaded: not_loaded\n\n        @deps?.forEach (d) =>\n          if @[d]?\n            good_to_go = true\n          else\n            if available[d]? == true\n              register_dependency d, available[d]\n            else\n              try\n                available[d] = require d\n                register_dependency d, available[d]\n              catch\n                check_directory __dirname, d, =>\n                  register_dependency d, available[d]\n\n        if good_to_go && loaded[@clazz].length >= @deps.length\n          process.nextTick => def.resolve @\n\n        def.promise\n\n      initialize: (wrap = true) =>\n        deferred = q.defer()\n\n        if @deps?\n          @hydrate_dependencies()\n            .then =>\n              @wrap_methods() if wrap\n              deferred.resolve @\n            .fail (reason) => deferred.reject reason\n        else\n          process.nextTick =>\n            @wrap_methods() if wrap\n            deferred.resolve @\n\n        deferred.promise\n\n    module.exports = Module\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7decac021611ba0408848753416ff385969337cf","subject":"Prioritize sort by type","message":"Prioritize sort by type\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"dox.litcoffee","new_file":"dox.litcoffee","new_contents":"\n# Documentation generation\n\n*Generate the dynamic portions of Shrub's documentation.*\n\n    {exec} = require 'child_process'\n    fs = require 'fs'\n    path = require 'path'\n    {Transform} = require 'stream'\n\n    _ = require 'lodash'\n    {LineStream} = require 'byline'\n    glob = require 'grunt\/node_modules\/glob'\n    Promise = require 'bluebird'\n\nImplement a Transform stream to accumulate hook invocations from a source file.\n\n    class HookInvocations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Invoke hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream to accumulate hook implementations from a source\nfile.\n\n    class HookImplementations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Implements hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream fo accumulate TODOs from a source file. Also\ncaches lines to be able to build context around each TODO item.\n\n    class Todos extends Transform\n\n      @context = 4\n\n      constructor: ->\n        super\n\n        @lines = []\n        @todos = []\n\n      _transform: (chunk, encoding, done) ->\n        @lines.push line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\#\\#\\# TODO\/\n          @todos.push @lines.length - 1\n\n        done()\n\n      withContext: ->\n\n        for todo in @todos\n\n          start = Math.max 0, todo - Todos.context\n          end = Math.min @lines.length - 1, todo + Todos.context\n\n          index: todo\n          lines: @lines.slice start, end\n\nGather all source files.\n\n    _allSourceFiles = ->\n      new Promise (resolve, reject) ->\n        glob(\n          '{{client,custom,packages,server}\/**\/*.litcoffee,*.litcoffee}'\n          (error, files) ->\n            return reject error if error?\n            resolve files\n        )\n\nGenerate an HTML ID from a hook name.\n\n    _idFromHook = (hook) -> hook.replace(\n      \/[^0-9A-Za-z-]+\/g, '-'\n    ).toLowerCase()\n\nGet the source path from a filename. This removes the extension and any \/index\nportion from the end of the filename.\n\n    _sourcePath = (filename) ->\n\n        dirname = path.dirname filename\n        if dirname is '.' then dirname = '' else dirname += '\/'\n        extname = path.extname filename\n        filename = \"#{dirname}#{path.basename filename, extname}\"\n\n        parts = filename.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'index'\n        return parts.join '\/'\n\nCollate a list of files by type (client or server).\n\n    _collateFilesByType = (files) ->\n\n      client = []\n      server = []\n\n      for file in files\n        parts = file.split '\/'\n\n        if parts[0] is 'client'\n          client.push file\n        else if parts[0] is 'custom' and parts[2] is 'client'\n          client.push file\n        else if parts[0] is 'packages' and parts[2] is 'client'\n          client.push file\n        else\n          server.push file\n\n      client: client, server: server\n\nGather statistics for all files.\n\n    fileStatsListPromise = _allSourceFiles().then (allFiles) ->\n\n      allFilesPromises = for type, files of _collateFilesByType allFiles\n\n        typePromises = for file in files\n\n          do (type, file) -> new Promise (resolve, reject) ->\n\n            fstream = fs.createReadStream file\n            fstream.pipe lineStream = new LineStream keepEmptyLines: true\n\nPass all files through the Transform list to parse out relevant information.\n\n            lineStream.pipe hookImplementations = new HookImplementations()\n            lineStream.pipe hookInvocations = new HookInvocations()\n            lineStream.pipe todos = new Todos()\n\n            fstream.on 'error', reject\n\n            fstream.on 'end', ->\n\nInclude all information from Transform streams in the statistics.\n\n              resolve(\n                type: type\n                file: file\n                implementations: hookImplementations.list\n                invocations: hookInvocations.list\n                todos: todos.withContext()\n              )\n\n        Promise.all typePromises\n\n      Promise.all(allFilesPromises).then (fileStatsLists) ->\n        _.flatten fileStatsLists\n\nMassage the statistics to help rendering the hooks page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      hooksIndex = {}\n\n      indexes = {}\n      keys = ['implementations', 'invocations']\n\n      for fileStats in fileStatsList\n\n        for key in keys\n          indexes[key] ?= {}\n\n          for hook in fileStats[key]\n            indexes[key][hook] ?= {}\n            (indexes[key][hook][fileStats.file] ?= []).push fileStats.type\n\n            hooksIndex[hook] = true\n\n      for key in keys\n        for hook, stats of indexes[key]\n          for file of stats\n            stats[file] = _.unique stats[file] ? []\n\n      hooks = (hook for hook of hooksIndex).sort()\n\n      hookFiles = {}\n      for hook in hooks\n        hookFiles[hook] = try\n          fs.readFileSync \"docs\/hook\/#{hook}.md\", 'utf8'\n        catch error\n          ''\n\n      O =\n        hookFiles: hookFiles\n        hooks: hooks\n\n      O[key] = indexes[key] for key in keys\n\n      return O\n\nRender the hooks page.\n\n    ).then((O) ->\n\n      {hookFiles, hooks} = O\n\n      keys = ['implementations', 'invocations']\n\n      wordingFor =\n        implementations: 'implements'\n        invocations: 'invoke'\n\n      render = fs.readFileSync 'docs\/hooks.template.md', 'utf8'\n\n      for hook in hooks\n\n        render += \"## #{hook}\\n\\n\"\n        render += hookFiles[hook] + '\\n\\n' if hookFiles[hook]\n\n        for key in keys\n\n          if O[key][hook]?\n\n            count = Object.keys(O[key][hook]).length\n            render += \"### #{count} #{key}(s)\\n\\n\"\n\n            for file, types of O[key][hook]\n\n              file = _sourcePath file\n\n              types = types.map (type) -> \"[#{type}](source\/#{file}##{wordingFor[key]}-hook-#{hook.toLowerCase()})\"\n\n              render += \"* #{file} (#{types.join ','})\\n\"\n\n            render += '\\n'\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/hooks.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nRender the TODOs page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/todos.template.md', 'utf8'\n\n      for fileStats in fileStatsList\n\nKeep track of used IDs, it will be necessary to link to the correct location\nhash in the case of multiple TODO items with the same wording.\n\n        idMap = {}\n\n        for todo in fileStats.todos\n\n          render += '\\n'\n\n          id = ''\n          for line, index in todo.lines\n            render += '>'\n\nIf this is the line with the TODO, parse the ID from the TODO item text, and\nrender it as h2 (TODO are h6) to increase visibility.\n\n            if index is Todos.context\n              id = _idFromHook(line).slice 1, -1\n\n              render += line.slice 4\n            else\n              render += \" #{line}\"\n            render += '\\n'\n\n          render += '\\n'\n\n          filename = _sourcePath fileStats.file\n\nKeep track of ID usage and modify the location hash for subsequent uses.\n\n          if idMap[id]?\n            idMap[id] += 1\n            id += \"_#{idMap[id]}\"\n          else\n            idMap[id] = 0\n\n          render += \"###### the above found in [#{fileStats.file}:#{todo.index}](source\/#{filename}##{id})\\n\"\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/todos.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nAdd all the source files to a generated mkdocs.yml\n\n    _allSourceFiles().then (files) ->\n\n      yml = fs.readFileSync 'docs\/mkdocs.template.yml', 'utf8'\n\n      for file in files\n        parts = file.split '\/'\n\n        for i in [0...parts.length]\n          try\n            fs.mkdirSync \"docs\/source\/#{parts.slice(0, i).join '\/'}\"\n          catch error\n\n        fs.createReadStream(file).pipe(\n          fs.createWriteStream(\"docs\/source\/#{file}\")\n        )\n\nAdd them under the 'Source code' path.\n\n        yml += \"- [source\/#{file}, 'Source code', '#{file}']\\n\"\n\n      fs.writeFileSync 'mkdocs.yml', yml\n\n      return\n\nRender the packages page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\nSort by package name first.\n\n      newList = []\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        continue unless ~['custom', 'packages'].indexOf parts[0]\n\n        sourcePath = _sourcePath fileStats.file\n\n        parts = sourcePath.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'client'\n        pkg = parts.join '\/'\n        fileStats.pkg = pkg.split('\/').slice(1).join '\/'\n\n        newList.push fileStats\n\n      newList.sort (l, r) ->\n        return -1 if l.type is 'client' and r.type is 'server'\n        return 1 if l.type is 'server' and r.type is 'client'\n        if l.pkg < r.pkg then -1 else if l.pkg > r.pkg then 1 else 0\n\n    ).then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/packages.template.md', 'utf8'\n      render += '\\n'\n\n      type = null\n\n      for fileStats in fileStatsList\n\n        if fileStats.type isnt type\n          type = fileStats.type\n\n          render += if type is 'client'\n            '## Client-side'\n          else\n            '## Server-side'\n\n          render += '\\n\\n'\n\n        isSubpackage = fileStats.pkg.split('\/').length isnt 1\n\nLink to the package.\n\n        sourcePath = _sourcePath fileStats.file\n\n        if isSubpackage\n          render += '> '\n          parts = fileStats.pkg.split '\/'\n          parentPkg = parts.shift()\n          subPkg = parts.join '\/'\n          render += \"## [<small>#{parentPkg}\/<\/small>#{subPkg}](source\/#{sourcePath})\"\n        else\n          render += \"## [#{fileStats.pkg}](source\/#{sourcePath})\"\n\nNaively parse out the file description. It must be wrapped in asterisks, i.e.\nitalicized in markdown.\n\n###### TODO: This 'chunk' parsing should be done with a Transform like the others.\n\n        data = fs.readFileSync fileStats.file, 'utf8'\n        chunks = data.split '\\n\\n'\n\n        title = chunks[0]\n        if 35 is title.charCodeAt 0\n          render += \" &mdash; #{title.substr 2}\"\n\n        render += '\\n\\n'\n\n        description = chunks[1]\n        if 42 is description.charCodeAt 0 and 42 is description.charCodeAt description.length - 1\n          render += '> ' if isSubpackage\n          render += \"#{description}\\n\\n\"\n\n        if fileStats.implementations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Implements hooks\"\\n    '\n          render += fileStats.implementations.map((hook) ->\n            \"[#{hook}](source\/#{sourcePath}#implements-hook-#{hook.toLowerCase()})\"\n          ).join ', '\n          render += '\\n\\n'\n\n        if fileStats.invocations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Invokes hooks\"\\n    '\n          render += fileStats.invocations.map((hook) ->\n            \"[#{hook}](source\/#{sourcePath}#invoke-hook-#{hook.toLowerCase()})\"\n          ).join ', '\n          render += '\\n\\n'\n\n      fs.writeFileSync 'docs\/packages.md', render\n\n    )\n","old_contents":"\n# Documentation generation\n\n*Generate the dynamic portions of Shrub's documentation.*\n\n    {exec} = require 'child_process'\n    fs = require 'fs'\n    path = require 'path'\n    {Transform} = require 'stream'\n\n    _ = require 'lodash'\n    {LineStream} = require 'byline'\n    glob = require 'grunt\/node_modules\/glob'\n    Promise = require 'bluebird'\n\nImplement a Transform stream to accumulate hook invocations from a source file.\n\n    class HookInvocations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Invoke hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream to accumulate hook implementations from a source\nfile.\n\n    class HookImplementations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Implements hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream fo accumulate TODOs from a source file. Also\ncaches lines to be able to build context around each TODO item.\n\n    class Todos extends Transform\n\n      @context = 4\n\n      constructor: ->\n        super\n\n        @lines = []\n        @todos = []\n\n      _transform: (chunk, encoding, done) ->\n        @lines.push line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\#\\#\\# TODO\/\n          @todos.push @lines.length - 1\n\n        done()\n\n      withContext: ->\n\n        for todo in @todos\n\n          start = Math.max 0, todo - Todos.context\n          end = Math.min @lines.length - 1, todo + Todos.context\n\n          index: todo\n          lines: @lines.slice start, end\n\nGather all source files.\n\n    _allSourceFiles = ->\n      new Promise (resolve, reject) ->\n        glob(\n          '{{client,custom,packages,server}\/**\/*.litcoffee,*.litcoffee}'\n          (error, files) ->\n            return reject error if error?\n            resolve files\n        )\n\nGenerate an HTML ID from a hook name.\n\n    _idFromHook = (hook) -> hook.replace(\n      \/[^0-9A-Za-z-]+\/g, '-'\n    ).toLowerCase()\n\nGet the source path from a filename. This removes the extension and any \/index\nportion from the end of the filename.\n\n    _sourcePath = (filename) ->\n\n        dirname = path.dirname filename\n        if dirname is '.' then dirname = '' else dirname += '\/'\n        extname = path.extname filename\n        filename = \"#{dirname}#{path.basename filename, extname}\"\n\n        parts = filename.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'index'\n        return parts.join '\/'\n\nCollate a list of files by type (client or server).\n\n    _collateFilesByType = (files) ->\n\n      client = []\n      server = []\n\n      for file in files\n        parts = file.split '\/'\n\n        if parts[0] is 'client'\n          client.push file\n        else if parts[0] is 'custom' and parts[2] is 'client'\n          client.push file\n        else if parts[0] is 'packages' and parts[2] is 'client'\n          client.push file\n        else\n          server.push file\n\n      client: client, server: server\n\nGather statistics for all files.\n\n    fileStatsListPromise = _allSourceFiles().then (allFiles) ->\n\n      allFilesPromises = for type, files of _collateFilesByType allFiles\n\n        typePromises = for file in files\n\n          do (type, file) -> new Promise (resolve, reject) ->\n\n            fstream = fs.createReadStream file\n            fstream.pipe lineStream = new LineStream keepEmptyLines: true\n\nPass all files through the Transform list to parse out relevant information.\n\n            lineStream.pipe hookImplementations = new HookImplementations()\n            lineStream.pipe hookInvocations = new HookInvocations()\n            lineStream.pipe todos = new Todos()\n\n            fstream.on 'error', reject\n\n            fstream.on 'end', ->\n\nInclude all information from Transform streams in the statistics.\n\n              resolve(\n                type: type\n                file: file\n                implementations: hookImplementations.list\n                invocations: hookInvocations.list\n                todos: todos.withContext()\n              )\n\n        Promise.all typePromises\n\n      Promise.all(allFilesPromises).then (fileStatsLists) ->\n        _.flatten fileStatsLists\n\nMassage the statistics to help rendering the hooks page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      hooksIndex = {}\n\n      indexes = {}\n      keys = ['implementations', 'invocations']\n\n      for fileStats in fileStatsList\n\n        for key in keys\n          indexes[key] ?= {}\n\n          for hook in fileStats[key]\n            indexes[key][hook] ?= {}\n            (indexes[key][hook][fileStats.file] ?= []).push fileStats.type\n\n            hooksIndex[hook] = true\n\n      for key in keys\n        for hook, stats of indexes[key]\n          for file of stats\n            stats[file] = _.unique stats[file] ? []\n\n      hooks = (hook for hook of hooksIndex).sort()\n\n      hookFiles = {}\n      for hook in hooks\n        hookFiles[hook] = try\n          fs.readFileSync \"docs\/hook\/#{hook}.md\", 'utf8'\n        catch error\n          ''\n\n      O =\n        hookFiles: hookFiles\n        hooks: hooks\n\n      O[key] = indexes[key] for key in keys\n\n      return O\n\nRender the hooks page.\n\n    ).then((O) ->\n\n      {hookFiles, hooks} = O\n\n      keys = ['implementations', 'invocations']\n\n      wordingFor =\n        implementations: 'implements'\n        invocations: 'invoke'\n\n      render = fs.readFileSync 'docs\/hooks.template.md', 'utf8'\n\n      for hook in hooks\n\n        render += \"## #{hook}\\n\\n\"\n        render += hookFiles[hook] + '\\n\\n' if hookFiles[hook]\n\n        for key in keys\n\n          if O[key][hook]?\n\n            count = Object.keys(O[key][hook]).length\n            render += \"### #{count} #{key}(s)\\n\\n\"\n\n            for file, types of O[key][hook]\n\n              file = _sourcePath file\n\n              types = types.map (type) -> \"[#{type}](source\/#{file}##{wordingFor[key]}-hook-#{hook.toLowerCase()})\"\n\n              render += \"* #{file} (#{types.join ','})\\n\"\n\n            render += '\\n'\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/hooks.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nRender the TODOs page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/todos.template.md', 'utf8'\n\n      for fileStats in fileStatsList\n\nKeep track of used IDs, it will be necessary to link to the correct location\nhash in the case of multiple TODO items with the same wording.\n\n        idMap = {}\n\n        for todo in fileStats.todos\n\n          render += '\\n'\n\n          id = ''\n          for line, index in todo.lines\n            render += '>'\n\nIf this is the line with the TODO, parse the ID from the TODO item text, and\nrender it as h2 (TODO are h6) to increase visibility.\n\n            if index is Todos.context\n              id = _idFromHook(line).slice 1, -1\n\n              render += line.slice 4\n            else\n              render += \" #{line}\"\n            render += '\\n'\n\n          render += '\\n'\n\n          filename = _sourcePath fileStats.file\n\nKeep track of ID usage and modify the location hash for subsequent uses.\n\n          if idMap[id]?\n            idMap[id] += 1\n            id += \"_#{idMap[id]}\"\n          else\n            idMap[id] = 0\n\n          render += \"###### the above found in [#{fileStats.file}:#{todo.index}](source\/#{filename}##{id})\\n\"\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/todos.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nAdd all the source files to a generated mkdocs.yml\n\n    _allSourceFiles().then (files) ->\n\n      yml = fs.readFileSync 'docs\/mkdocs.template.yml', 'utf8'\n\n      for file in files\n        parts = file.split '\/'\n\n        for i in [0...parts.length]\n          try\n            fs.mkdirSync \"docs\/source\/#{parts.slice(0, i).join '\/'}\"\n          catch error\n\n        fs.createReadStream(file).pipe(\n          fs.createWriteStream(\"docs\/source\/#{file}\")\n        )\n\nAdd them under the 'Source code' path.\n\n        yml += \"- [source\/#{file}, 'Source code', '#{file}']\\n\"\n\n      fs.writeFileSync 'mkdocs.yml', yml\n\n      return\n\nRender the packages page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\nSort by package name first.\n\n      newList = []\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        continue unless ~['custom', 'packages'].indexOf parts[0]\n\n        sourcePath = _sourcePath fileStats.file\n\n        parts = sourcePath.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'client'\n        pkg = parts.join '\/'\n        fileStats.pkg = pkg.split('\/').slice(1).join '\/'\n\n        newList.push fileStats\n\n      newList.sort (l, r) ->\n        if l.pkg < r.pkg then -1 else if l.pkg > r.pkg then 1 else 0\n\n    ).then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/packages.template.md', 'utf8'\n      render += '\\n'\n\n      type = null\n\n      for fileStats in fileStatsList\n\n        if fileStats.type isnt type\n          type = fileStats.type\n\n          render += if type is 'client'\n            '## Client-side'\n          else\n            '## Server-side'\n\n          render += '\\n\\n'\n\n        isSubpackage = fileStats.pkg.split('\/').length isnt 1\n\nLink to the package.\n\n        sourcePath = _sourcePath fileStats.file\n\n        if isSubpackage\n          render += '> '\n          parts = fileStats.pkg.split '\/'\n          parentPkg = parts.shift()\n          subPkg = parts.join '\/'\n          render += \"## [<small>#{parentPkg}\/<\/small>#{subPkg}](source\/#{sourcePath})\"\n        else\n          render += \"## [#{fileStats.pkg}](source\/#{sourcePath})\"\n\nNaively parse out the file description. It must be wrapped in asterisks, i.e.\nitalicized in markdown.\n\n###### TODO: This 'chunk' parsing should be done with a Transform like the others.\n\n        data = fs.readFileSync fileStats.file, 'utf8'\n        chunks = data.split '\\n\\n'\n\n        title = chunks[0]\n        if 35 is title.charCodeAt 0\n          render += \" &mdash; #{title.substr 2}\"\n\n        render += '\\n\\n'\n\n        description = chunks[1]\n        if 42 is description.charCodeAt 0 and 42 is description.charCodeAt description.length - 1\n          render += '> ' if isSubpackage\n          render += \"#{description}\\n\\n\"\n\n        if fileStats.implementations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Implements hooks\"\\n    '\n          render += fileStats.implementations.map((hook) ->\n            \"[#{hook}](source\/#{sourcePath}#implements-hook-#{hook.toLowerCase()})\"\n          ).join ', '\n          render += '\\n\\n'\n\n        if fileStats.invocations.length > 0\n          render += '> ' if isSubpackage\n          render += '!!! note \"Invokes hooks\"\\n    '\n          render += fileStats.invocations.map((hook) ->\n            \"[#{hook}](source\/#{sourcePath}#invoke-hook-#{hook.toLowerCase()})\"\n          ).join ', '\n          render += '\\n\\n'\n\n      fs.writeFileSync 'docs\/packages.md', render\n\n    )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d3a9b5fd893b51f5a37402bf873a4db52af36f85","subject":"Two changes to PngWalls:","message":"Two changes to PngWalls:\n\n1. Update `do_render` signature to accept `ctx` param\n2. `PngWalls` no longer generates the data it uses to render walls,\n   so all that logic was pulled out. Now it simply iterates over\n   all the json data, building walls appropriatly\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_walls.litcoffee","new_file":"lib\/render-pipelines\/png\/png_walls.litcoffee","new_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngWalls extends PngRenderer\n\n      do_render: (ctx, path) =>\n        cell_width  = @config.width\n        cell_height = @config.height\n\n        wall_segments  = @config.wall.segments\n        segment_height = 1 \/ wall_segments\n        wall_height    = cell_height * segment_height\n\n        fill_segment = (side, block, segment, width, color) =>\n          top  = (cell_height * block.y) + (segment * (cell_height * segment_height))\n          left = cell_width * block.x\n\n          left += cell_width - width if side == 'RIGHT'\n\n          ctx.fillStyle = color\n\n          ctx.beginPath()\n          ctx.rect left, top, width, @config.multiplier\n          ctx.fill()\n\n        for block in path\n          for side in [ 'left', 'right' ]\n            if block[\"#{side}_wall\"]?\n              for seg, i in block[\"#{side}_wall\"]\n                fill_segment side.toUpperCase(), block, i, seg.thickness, @config.wall.color\n\n    module.exports = PngWalls\n","old_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngWalls extends PngRenderer\n\n      do_render: (path) =>\n        ctx    = PngRenderer.ctx\n        width  = @config.width\n        height = @config.height\n\n        for step, i in path\n          ctx.lineWidth   = @config.wall.width\n          ctx.strokeStyle = @config.wall.color\n\n          if i > 0\n            previous = path[i - 1]\n            top      =  height * previous.row  + 1\n            bottom   = (height * previous.row) + (height - 1)\n            left     = (width  * previous.col) + 1\n            right    = (width  * previous.col) + (width - 1)\n\n            switch step.direction\n              when 'RIGHT', 'LEFT'\n                if previous.direction != 'DOWN'\n                  ctx.beginPath()\n                  ctx.moveTo left,  top\n                  ctx.lineTo right, top\n                  ctx.stroke()\n                else if step.direction == 'RIGHT'\n                  ctx.beginPath()\n                  ctx.moveTo left, top\n                  ctx.lineTo left, bottom\n                  ctx.stroke()\n                else if step.direction == 'LEFT'\n                  ctx.beginPath()\n                  ctx.moveTo right, top\n                  ctx.lineTo right, bottom\n                  ctx.stroke()\n\n                if previous.direction != 'UP'\n                  ctx.beginPath()\n                  ctx.moveTo left,  bottom\n                  ctx.lineTo right, bottom\n                  ctx.stroke()\n                else if step.direction == 'RIGHT'\n                  ctx.beginPath()\n                  ctx.moveTo left, top\n                  ctx.lineTo left, bottom\n                  ctx.stroke()\n                else if step.direction == 'LEFT'\n                  ctx.beginPath()\n                  ctx.moveTo right, top\n                  ctx.lineTo right, bottom\n                  ctx.stroke()\n\n                if previous.direction == undefined\n                  if step.direction == 'RIGHT'\n                    ctx.beginPath()\n                    ctx.moveTo left, top\n                    ctx.lineTo left, bottom\n                    ctx.stroke()\n                  else if step.direction == 'LEFT'\n                    ctx.beginPath()\n                    ctx.moveTo right, top\n                    ctx.lineTo right, bottom\n                    ctx.stroke()\n\n              when 'UP', 'DOWN'\n                if previous.direction != 'LEFT'\n                  ctx.beginPath()\n                  ctx.moveTo right, top\n                  ctx.lineTo right, bottom\n                  ctx.stroke()\n                else if step.direction == 'DOWN'\n                  ctx.beginPath()\n                  ctx.moveTo left,  top\n                  ctx.lineTo right, top\n                  ctx.stroke()\n                else if step.direction == 'UP'\n                  ctx.beginPath()\n                  ctx.moveTo left,  bottom\n                  ctx.lineTo right, bottom\n                  ctx.stroke()\n\n                if previous.direction != 'RIGHT'\n                  ctx.beginPath()\n                  ctx.moveTo left, top\n                  ctx.lineTo left, bottom\n                  ctx.stroke()\n                else if step.direction == 'DOWN'\n                  ctx.beginPath()\n                  ctx.moveTo left,  top\n                  ctx.lineTo right, top\n                  ctx.stroke()\n                else if step.direction == 'UP'\n                  ctx.beginPath()\n                  ctx.moveTo left,  bottom\n                  ctx.lineTo right, bottom\n                  ctx.stroke()\n\n                if previous.direction == undefined\n                  if step.direction == 'DOWN'\n                    ctx.beginPath()\n                    ctx.moveTo left,  top\n                    ctx.lineTo right, top\n                    ctx.stroke()\n                  else if step.direction == 'UP'\n                    ctx.beginPath()\n                    ctx.moveTo left,  bottom\n                    ctx.lineTo right, bottom\n                    ctx.stroke()\n\n          if i == path.length - 1\n            previous = path[i - 1]\n            top      =  height * step.row  + 1\n            bottom   = (height * step.row) + (height - 1)\n            left     = (width  * step.col) + 1\n            right    = (width  * step.col) + (width - 1)\n\n            switch step.direction\n              when 'RIGHT', 'LEFT'\n                ctx.beginPath()\n                ctx.moveTo left,  top\n                ctx.lineTo right, top\n                ctx.stroke()\n\n                ctx.beginPath()\n                ctx.moveTo left,  bottom\n                ctx.lineTo right, bottom\n                ctx.stroke()\n\n                if step.direction == 'RIGHT'\n                  ctx.beginPath()\n                  ctx.moveTo right, top\n                  ctx.lineTo right, bottom\n                  ctx.stroke()\n\n                if step.direction == 'LEFT'\n                  ctx.beginPath()\n                  ctx.moveTo left, top\n                  ctx.lineTo left, bottom\n                  ctx.stroke()\n\n              when 'UP', 'DOWN'\n                ctx.beginPath()\n                ctx.moveTo right, top\n                ctx.lineTo right, bottom\n                ctx.stroke()\n\n                ctx.beginPath()\n                ctx.moveTo left, top\n                ctx.lineTo left, bottom\n                ctx.stroke()\n\n                if step.direction == 'UP'\n                  ctx.beginPath()\n                  ctx.moveTo left,  top\n                  ctx.lineTo right, top\n                  ctx.stroke()\n\n                if step.direction == 'DOWN'\n                  ctx.beginPath()\n                  ctx.moveTo left,  bottom\n                  ctx.lineTo right, bottom\n                  ctx.stroke()\n\n    module.exports = PngWalls\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7cf6ead2e6a91848c58148c8046c6f4794003624","subject":"fix connectionId update null schema error","message":"fix connectionId update null schema error\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"lib\/collections\/queue.litcoffee","new_file":"lib\/collections\/queue.litcoffee","new_contents":"# Queue Collection\n\nGetNameSchema is used to create the autoform to take a ticket.\n\n    @NameSchema = new SimpleSchema\n      name:\n        type: String\n        label: 'Name'\n        max: 100\n\nConnectionSchema has an ascending index on `ticketNumber`\n\n    ConnectionSchema = new SimpleSchema\n      ticketNumber:\n        type: Number\n        index: 1\n      connectionId:\n        type: String\n        max: 20\n      name:\n        type: String\n        max: 100\n      timeEnqueued:\n        type: Date\n\n    QueueMetaSchema = new SimpleSchema\n      theOnlyConnectionAllowedIn:\n        type: ConnectionSchema\n        optional: yes\n      hasCurrentConnectionPosted:\n        type: Boolean\n      currentlyServingTicketNumber:\n        type: Number\n      timeCurrentTicketExpires:\n        type: Date\n      averageWaitTimeSeconds:\n        type: Number\n      totalWaitTimeSeconds:\n        type: Number\n      totalVisitors:\n        type: Number\n      nextTicketNumber:\n        type: Number\n      html:\n        type: String\n        optional: yes\n\n    QueueProcessedSchema = new SimpleSchema\n      connection:\n        type: ConnectionSchema\n      waitTimeSeconds:\n        type: Number\n      postID:\n        type: String\n        max: 20\n        optional: yes\n\n    @Queue = new Meteor.Collection 'queue'\n    Queue.attachSchema ConnectionSchema\n\nThere is only ever one Queue Meta.\n\n    @QueueMeta = new Meteor.Collection 'queueMeta'\n    QueueMeta.attachSchema QueueMetaSchema\n\n    @QueueProcessed = new Meteor.Collection 'queueProcessed'\n    QueueProcessed.attachSchema QueueProcessedSchema\n\n    Meteor.methods\n      getInQueue: (doc) ->\n\n        return if this.isSimulation\n\nValidate doc\n\n        check doc, NameSchema\n\nCheck that the connection is not already in the queue.\n\n        criteria =\n          connectionId: this.connection.id\n\n        if (Queue.find criteria).count() isnt 0\n          Meteor.Error 'ditch-attempt', \"Don't try to cut in line...it's not nice.\"\n\nGet the next ticketNumber\n\n        queueMeta = QueueMeta.findOne()\n\n        if not queueMeta?\n          Meteor.Error 'no-queue-meta', \"There is no queue meta, something's wrong.\"\n\n        nextTicketNumber = queueMeta.nextTicketNumber\n\nCreate queue object\n\n        connection =\n          ticketNumber: nextTicketNumber\n          connectionId: this.connection.id\n          name: doc.name\n          timeEnqueued: moment.utc().toDate()\n\nPush onto the queue\n\n        Queue.insert connection\n\nIncrement nextTicketNumber (because we've pulled the current next ticket number)\n\n        nextTicketNumber += 1\n        criteria =\n          _id: queueMeta._id\n        update =\n          $set: nextTicketNumber: nextTicketNumber\n\n        QueueMeta.update criteria, update\n\nSend a notification email, unblock\n\n        this.unblock()\n\n        try\n          if Meteor.settings.notifyEmail? and Meteor.settings.mailgunOptions?\n            Mailguns = new Mailgun Meteor.settings.mailgunOptions\n            Mailguns.send\n              to: Meteor.settings.notifyEmail\n              from: 'notify@mostexclusivewebsite.com'\n              subject: 'Ticket Pulled!'\n              text: \"Ticket ##{connection.ticketNumber}. #{Meteor.absoluteUrl()}\"\n        catch error\n          console.log error\n\n        return connection\n\n      updateConnectionId: (oldConnectionId) ->\n        return if this.isSimulation\n        this.unblock()\n        newConnectionId = this.connection.id\n        return if not newConnectionId? or not oldConnectionId?\n        criteria =\n          connectionId: oldConnectionId\n        action =\n          $set:\n            connectionId: newConnectionId\n\n        console.log 'update queue', criteria, action\n        Queue.update criteria, action\n\nUpdate QueueMeta (TODO: way around lots of failed updates?)\n\n        criteria =\n          'theOnlyConnectionAllowedIn.connectionId': oldConnectionId\n        action =\n          $set:\n            'theOnlyConnectionAllowedIn.connectionId': newConnectionId\n\n        console.log 'update queuemeta', criteria, action\n        QueueMeta.update criteria, action\n","old_contents":"# Queue Collection\n\nGetNameSchema is used to create the autoform to take a ticket.\n\n    @NameSchema = new SimpleSchema\n      name:\n        type: String\n        label: 'Name'\n        max: 100\n\nConnectionSchema has an ascending index on `ticketNumber`\n\n    ConnectionSchema = new SimpleSchema\n      ticketNumber:\n        type: Number\n        index: 1\n      connectionId:\n        type: String\n        max: 20\n      name:\n        type: String\n        max: 100\n      timeEnqueued:\n        type: Date\n\n    QueueMetaSchema = new SimpleSchema\n      theOnlyConnectionAllowedIn:\n        type: ConnectionSchema\n        optional: yes\n      hasCurrentConnectionPosted:\n        type: Boolean\n      currentlyServingTicketNumber:\n        type: Number\n      timeCurrentTicketExpires:\n        type: Date\n      averageWaitTimeSeconds:\n        type: Number\n      totalWaitTimeSeconds:\n        type: Number\n      totalVisitors:\n        type: Number\n      nextTicketNumber:\n        type: Number\n      html:\n        type: String\n        optional: yes\n\n    QueueProcessedSchema = new SimpleSchema\n      connection:\n        type: ConnectionSchema\n      waitTimeSeconds:\n        type: Number\n      postID:\n        type: String\n        max: 20\n        optional: yes\n\n    @Queue = new Meteor.Collection 'queue'\n    Queue.attachSchema ConnectionSchema\n\nThere is only ever one Queue Meta.\n\n    @QueueMeta = new Meteor.Collection 'queueMeta'\n    QueueMeta.attachSchema QueueMetaSchema\n\n    @QueueProcessed = new Meteor.Collection 'queueProcessed'\n    QueueProcessed.attachSchema QueueProcessedSchema\n\n    Meteor.methods\n      getInQueue: (doc) ->\n\n        return if this.isSimulation\n\nValidate doc\n\n        check doc, NameSchema\n\nCheck that the connection is not already in the queue.\n\n        criteria =\n          connectionId: this.connection.id\n\n        if (Queue.find criteria).count() isnt 0\n          Meteor.Error 'ditch-attempt', \"Don't try to cut in line...it's not nice.\"\n\nGet the next ticketNumber\n\n        queueMeta = QueueMeta.findOne()\n\n        if not queueMeta?\n          Meteor.Error 'no-queue-meta', \"There is no queue meta, something's wrong.\"\n\n        nextTicketNumber = queueMeta.nextTicketNumber\n\nCreate queue object\n\n        connection =\n          ticketNumber: nextTicketNumber\n          connectionId: this.connection.id\n          name: doc.name\n          timeEnqueued: moment.utc().toDate()\n\nPush onto the queue\n\n        Queue.insert connection\n\nIncrement nextTicketNumber (because we've pulled the current next ticket number)\n\n        nextTicketNumber += 1\n        criteria =\n          _id: queueMeta._id\n        update =\n          $set: nextTicketNumber: nextTicketNumber\n\n        QueueMeta.update criteria, update\n\nSend a notification email, unblock\n\n        this.unblock()\n\n        try\n          if Meteor.settings.notifyEmail? and Meteor.settings.mailgunOptions?\n            Mailguns = new Mailgun Meteor.settings.mailgunOptions\n            Mailguns.send\n              to: Meteor.settings.notifyEmail\n              from: 'notify@mostexclusivewebsite.com'\n              subject: 'Ticket Pulled!'\n              text: \"Ticket ##{connection.ticketNumber}. #{Meteor.absoluteUrl()}\"\n        catch error\n          console.log error\n\n        return connection\n\n      updateConnectionId: (oldConnectionId) ->\n        return if this.isSimulation\n        newConnectionId = this.connection.id\n        this.unblock()\n        criteria =\n          connectionId: oldConnectionId\n        action =\n          $set:\n            connectionId: newConnectionId\n\n        Queue.update criteria, action\n\nUpdate QueueMeta (TODO: way around lots of failed updates?)\n\n        criteria =\n          'theOnlyConnectionAllowedIn.connectionId': oldConnectionId\n        action =\n          $set:\n            'theOnlyConnectionAllowedIn.connectionId': newConnectionId\n\n        QueueMeta.update criteria, action\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c02a60a19a285c21e3baeade02bc98fe2d462d5e","subject":"docs(document): annotate http endpoints","message":"docs(document): annotate http endpoints\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/document.litcoffee","new_file":"coffee\/document.litcoffee","new_contents":"    schema   = require '.\/helper\/schema'\n    sentry   = require '.\/db\/sentry'\n    Document = require '.\/model\/Document'\n\n    JSONStream = require 'JSONStream'\n\n## param()\n\n    exports.param = (req, res, next, id) ->\n      return res.status(400).json message: 'Invalid ObjectId' if not \/^[a-f0-9]{24}$\/.test id\n      return next() if req.method is 'OPTIONS'\n\n      req.doc = new Document(req.type, id).once('error', next).once 'ready', ->\n        req.isOwner = @exists() and req.user.tilbyder is @get 'tilbyder'\n\n        if not @exists() or (@get('status') isnt 'Offentlig' and not req.isOwner)\n          return res.status(404).json message: 'Not Found' if req.method isnt 'HEAD'\n          return res.status(404).end()\n\n        next()\n\n\n## all()\n\n    exports.all = (req, res, next) ->\n      res.set 'X-Cache-Hit', req.doc.wasCacheHit()\n      res.set 'ETag', \"\\\"#{req.doc.get 'checksum'}\\\"\"\n      res.set 'Last-Modified', new Date(req.doc.get 'endret').toUTCString()\n\n      if req.method not in ['GET', 'HEAD'] and not req.isOwner\n        return res.status(403).json message: 'Request Denied'\n\n      if req.get 'If-Match'\n        return res.status(412).end() if req.doc.isNoneMatch req.get 'If-Match'\n\n      else if req.get 'If-None-Match'\n        return res.status(304).end() if req.doc.isMatch req.get 'If-None-Match'\n\n      else\n        if req.doc.isNotModifiedSince req.get 'If-Modified-Since'\n          return res.status(304).end()\n\n        if req.doc.isModifiedSince req.get 'If-Unmodified-Since'\n          return res.status(412).end()\n\n      next()\n\n\n## OPTIONS\n\n```http\nOPTIONS \/{type}\/{id}\n```\n\n    exports.options = (req, res, next) ->\n      res.set 'Access-Control-Allow-Methods', [\n        'HEAD', 'GET', 'PUT', 'PATCH', 'DELETE'\n      ].join ', '\n      res.set 'Access-Control-Allow-Headers', [\n        'Content-Type'\n        'If-Match'\n        'If-Modified-Since'\n        'If-None-Match'\n        'If-Unmodified-Since'\n      ].join ', '\n      res.sendStatus 204\n\n\n## HEAD and GET\n\n```http\nHEAD \/{type}\/{id}\nGET \/{type}\/{id}\n```\n\n    exports.head = exports.get = (req, res, next) ->\n      return res.sendStatus 200 if req.method is 'HEAD'\n\n      opts =\n        query: $or: [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n        fields: {}\n\n### Fields Projection\n\n```\n&fields=field1[,field2[,..]]\n```\n\nPrivate (`privat.`) fields are hidden unless the current API user is the owner\nof the document. This is to prevent unauthorized information disclosure.\n\n      opts.fields.privat = false if not req.isOwner\n\nIf you only want some of the document properties returned you can use the\n`fields` query parameter to control the projection of document properties.\nMultiple fields must be comma separated without any additional spacing.\n\nThis projection also applies to expanded sub-documents when using the `&expand=`\nquery parameter below.\n\n      if req.query?.fields\n        opts.fields[field] = true for field in req.query.fields.split ','\n        opts.fields.privat = false if not req.isOwner\n\nThe list of default fields below will always be returned for compliance reasons.\n\n        opts.fields = Object.assign opts.fields,\n          endret: true\n          lisens: true\n          status: true\n          navn  : true\n          tilbyder  : true\n          navngiving: true\n\n### Sub-document Expansion\n\n```\n&expand=field1[,field2[..]]\n```\n\nSub-document expansion is an easy and convenient way to get connected documents\nsuch as `grupper`, `bilder`, and `omr\u00e5der` as their full objects instead of a\nlist of `ObjectIDs`. It works by setting the `expand` query parameter to the\nfields to expand.\n\n**Rate limit**\n\nSub-document expansion will decrease your remaining API rate limit with `1` per\ncollection expanded in addition to the request itself. Thus, if you request a\ndocument (1) with two collection expanded (2) your remaining API rate limit will\nbe decremented with 3. This is to encurrage resonable expansion of relevant\ncollections only.\n\n**Order and limit**\n\nSub-document expansion will return at most 10 first sub-documents for each\ncollection expanded and out of order. Only sub-documents avaiable to the current\nAPI user will be return as sub-documents my not be published or may have been\ndeleted.\n\n      if req.query?.expand\n        opts.expand = req.query.expand.split ','\n\n### Sub-document Limit\n\n```\n&limit={n}\n```\n\nIf you wisth to return less sub-documents in order to increase response time and\nbody size you may do so by using the `limit` query parameter. This will affect\nall sub-documents expanded by the `expand` query parameter.\n\n      if req.query?.limit and parseInt req.query.limit, 10\n        opts.limit = parseInt req.query.limit, 10\n\n---\n\n      req.doc.getExpanded opts, (err, doc) ->\n        return next err if err\n        res.json doc\n\n\n## PUT and PATCH\n\n```http\nPUT \/{type}\/{id}\nPATCH \/{type}\/{id}\n```\n\n    exports.patch = exports.put = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(400).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      method = (if req.method is 'PUT' then 'replace' else 'update')\n      req.doc[method] req.body, (err, warn, data) ->\n        if err\n          return next(err) if err.name isnt 'ValidationError'\n\n          sentry.captureDocumentError req, err\n\n          return res.status(422).json\n            document: req.body\n            message: 'Validation Failed'\n            errors: err.details #TODO(starefossen) document this\n\n        res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n        res.set 'Last-Modified', new Date(data.endret).toUTCString()\n\n        return res.status(200).json\n          document: data\n          message: 'Validation Warnings' if warn.length > 0\n          warnings: warn if warn.length > 0\n\n\n## DELETE\n\n```http\nDELETE \/{type}\/{id}\n```\n\n    exports.delete = (req, res, next) ->\n      req.doc.delete (err) ->\n        return next err if err\n        return res.sendStatus 204\n\n","old_contents":"    schema   = require '.\/helper\/schema'\n    sentry   = require '.\/db\/sentry'\n    Document = require '.\/model\/Document'\n\n    JSONStream = require 'JSONStream'\n\n## param()\n\n    exports.param = (req, res, next, id) ->\n      return res.status(400).json message: 'Invalid ObjectId' if not \/^[a-f0-9]{24}$\/.test id\n      return next() if req.method is 'OPTIONS'\n\n      req.doc = new Document(req.type, id).once('error', next).once 'ready', ->\n        req.isOwner = @exists() and req.user.tilbyder is @get 'tilbyder'\n\n        if not @exists() or (@get('status') isnt 'Offentlig' and not req.isOwner)\n          return res.status(404).json message: 'Not Found' if req.method isnt 'HEAD'\n          return res.status(404).end()\n\n        next()\n\n\n## all()\n\n    exports.all = (req, res, next) ->\n      res.set 'X-Cache-Hit', req.doc.wasCacheHit()\n      res.set 'ETag', \"\\\"#{req.doc.get 'checksum'}\\\"\"\n      res.set 'Last-Modified', new Date(req.doc.get 'endret').toUTCString()\n\n      if req.method not in ['GET', 'HEAD'] and not req.isOwner\n        return res.status(403).json message: 'Request Denied'\n\n      if req.get 'If-Match'\n        return res.status(412).end() if req.doc.isNoneMatch req.get 'If-Match'\n\n      else if req.get 'If-None-Match'\n        return res.status(304).end() if req.doc.isMatch req.get 'If-None-Match'\n\n      else\n        if req.doc.isNotModifiedSince req.get 'If-Modified-Since'\n          return res.status(304).end()\n\n        if req.doc.isModifiedSince req.get 'If-Unmodified-Since'\n          return res.status(412).end()\n\n      next()\n\n\n## OPTIONS\n\n    exports.options = (req, res, next) ->\n      res.set 'Access-Control-Allow-Methods', [\n        'HEAD', 'GET', 'PUT', 'PATCH', 'DELETE'\n      ].join ', '\n      res.set 'Access-Control-Allow-Headers', [\n        'Content-Type'\n        'If-Match'\n        'If-Modified-Since'\n        'If-None-Match'\n        'If-Unmodified-Since'\n      ].join ', '\n      res.sendStatus 204\n\n\n## HEAD and GET\n\n    exports.head = exports.get = (req, res, next) ->\n      return res.sendStatus 200 if req.method is 'HEAD'\n\n      opts =\n        query: $or: [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n        fields: {}\n\n### Fields Projection\n\n```\n&fields=field1[,field2[,..]]\n```\n\nPrivate (`privat.`) fields are hidden unless the current API user is the owner\nof the document. This is to prevent unauthorized information disclosure.\n\n      opts.fields.privat = false if not req.isOwner\n\nIf you only want some of the document properties returned you can use the\n`fields` query parameter to control the projection of document properties.\nMultiple fields must be comma separated without any additional spacing.\n\nThis projection also applies to expanded sub-documents when using the `&expand=`\nquery parameter below.\n\n      if req.query?.fields\n        opts.fields[field] = true for field in req.query.fields.split ','\n        opts.fields.privat = false if not req.isOwner\n\nThe list of default fields below will always be returned for compliance reasons.\n\n        opts.fields = Object.assign opts.fields,\n          endret: true\n          lisens: true\n          status: true\n          navn  : true\n          tilbyder  : true\n          navngiving: true\n\n### Sub-document Expansion\n\n```\n&expand=field1[,field2[..]]\n```\n\nSub-document expansion is an easy and convenient way to get connected documents\nsuch as `grupper`, `bilder`, and `omr\u00e5der` as their full objects instead of a\nlist of `ObjectIDs`. It works by setting the `expand` query parameter to the\nfields to expand.\n\n**Rate limit**\n\nSub-document expansion will decrease your remaining API rate limit with `1` per\ncollection expanded in addition to the request itself. Thus, if you request a\ndocument (1) with two collection expanded (2) your remaining API rate limit will\nbe decremented with 3. This is to encurrage resonable expansion of relevant\ncollections only.\n\n**Order and limit**\n\nSub-document expansion will return at most 10 first sub-documents for each\ncollection expanded and out of order. Only sub-documents avaiable to the current\nAPI user will be return as sub-documents my not be published or may have been\ndeleted.\n\n      if req.query?.expand\n        opts.expand = req.query.expand.split ','\n\n### Sub-document Limit\n\n```\n&limit={n}\n```\n\nIf you wisth to return less sub-documents in order to increase response time and\nbody size you may do so by using the `limit` query parameter. This will affect\nall sub-documents expanded by the `expand` query parameter.\n\n      if req.query?.limit and parseInt req.query.limit, 10\n        opts.limit = parseInt req.query.limit, 10\n\n---\n\n      req.doc.getExpanded opts, (err, doc) ->\n        return next err if err\n        res.json doc\n\n\n## PUT and PATCH\n\n    exports.patch = exports.put = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(400).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      method = (if req.method is 'PUT' then 'replace' else 'update')\n      req.doc[method] req.body, (err, warn, data) ->\n        if err\n          return next(err) if err.name isnt 'ValidationError'\n\n          sentry.captureDocumentError req, err\n\n          return res.status(422).json\n            document: req.body\n            message: 'Validation Failed'\n            errors: err.details #TODO(starefossen) document this\n\n        res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n        res.set 'Last-Modified', new Date(data.endret).toUTCString()\n\n        return res.status(200).json\n          document: data\n          message: 'Validation Warnings' if warn.length > 0\n          warnings: warn if warn.length > 0\n\n\n## DELETE\n\n    exports.delete = (req, res, next) ->\n      req.doc.delete (err) ->\n        return next err if err\n        return res.sendStatus 204\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"65a3f7e4926aca2683ea7d6a898c754cbc65cf8e","subject":"Set proper http status code for bad origin","message":"Set proper http status code for bad origin\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/server.litcoffee","new_file":"src\/server.litcoffee","new_contents":"    express       = require 'express'\n    logger        = require 'morgan'\n    url           = require 'url'\n\n    compression   = require 'compression'\n    responseTime  = require 'response-time'\n\n    raven         = require 'raven'\n    sentry        = require '.\/sentry'\n\n    #process.env.LIBRATO_INTERVAL ?= 1\n    #librato =\n    #  middleware: require('.\/librato').middleware.use\n    #  count     : require('.\/librato').middleware.routeCount\n\n## Configuration\n\n    process.env.PORT_WWW ?= 8080\n\n    app = module.exports = express()\n\n    app.set 'json spaces', 2\n    app.set 'x-powered-by', false\n\n    app.use compression()\n    app.use responseTime()\n\n    if app.get('env').toLowerCase() isnt 'test'\n      app.use logger 'dev'\n      #app.use librato.middleware\n      #app.use librato.count name: 'request', period: 1\n\n## CORS\n\nCross-site HTTP requests are HTTP requests for resources from a different domain\nthan the domain of the resource making the request. [Read\nMore](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Access_control_CORS).\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.use (req, res, next) ->\n      if req.get 'Origin'\n        origin = url.parse req.get('Origin') or ''\n\nCheck if the request Origin is on in the `ALLOW_ORIGINS` list. If not return a\n403 to prevent this Origin from misusing the service.\n\n        if origin.hostname not in origins\n          error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n          error.statusCode = 403\n          return next error\n\nSet the correct CORS headers.\n\n        res.set 'Access-Control-Allow-Origin', req.get('Origin')\n        res.set 'Access-Control-Allow-Methods', 'GET, POST'\n        res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n        res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n        res.set 'Access-Control-Allow-Max-Age', 0\n\nBrowsers check for CORS support by doing a \"preflight\". This means sending a\nHTTP `OPTIONS` request to the server and checking the returned CORS-headers. No\nbody is required for this request so we can safely end this request now.\n\n      if req.method is 'OPTIONS' and req.path isnt '\/CloudHealthCheck'\n        return res.status(200).end()\n\n      return next()\n\n## Routes\n\n    app.all '\/CloudHealthCheck', (req, res, next) ->\n      res.status 200\n      return res.end() if req.method is 'HEAD'\n      return res.json message: 'System OK'\n\n    app.use '\/', require '.\/routes\/api_v1'\n    app.use '\/api\/v1\/', require '.\/routes\/api_v1'\n\n    app.get '\/', (req, res, next) ->\n      res.redirect '\/api\/v1'\n\n## Not Found\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n### Error Handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      if err.code is 'LIMIT_UNEXPECTED_FILE'\n        err.message = \"Unknown form field \\\"#{err.field}\\\"\"\n        err.statusCode = 400\n\n      if not err.statusCode or err.statusCode >= 500\n        console.error err\n        console.error err.message\n        console.error err.stack\n\n      res.status err.statusCode or 500\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Unknown error'\n\n### Start Server\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server is listening on port #{process.env.PORT_WWW}\"\n","old_contents":"    express       = require 'express'\n    logger        = require 'morgan'\n    url           = require 'url'\n\n    compression   = require 'compression'\n    responseTime  = require 'response-time'\n\n    raven         = require 'raven'\n    sentry        = require '.\/sentry'\n\n    #process.env.LIBRATO_INTERVAL ?= 1\n    #librato =\n    #  middleware: require('.\/librato').middleware.use\n    #  count     : require('.\/librato').middleware.routeCount\n\n## Configuration\n\n    process.env.PORT_WWW ?= 8080\n\n    app = module.exports = express()\n\n    app.set 'json spaces', 2\n    app.set 'x-powered-by', false\n\n    app.use compression()\n    app.use responseTime()\n\n    if app.get('env').toLowerCase() isnt 'test'\n      app.use logger 'dev'\n      #app.use librato.middleware\n      #app.use librato.count name: 'request', period: 1\n\n## CORS\n\nCross-site HTTP requests are HTTP requests for resources from a different domain\nthan the domain of the resource making the request. [Read\nMore](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Access_control_CORS).\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.use (req, res, next) ->\n      if req.get 'Origin'\n        origin = url.parse req.get('Origin') or ''\n\nCheck if the request Origin is on in the `ALLOW_ORIGINS` list. If not return a\n403 to prevent this Origin from misusing the service.\n\n        if origin.hostname not in origins\n          error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n          error.status = 403\n          return next error\n\nSet the correct CORS headers.\n\n        res.set 'Access-Control-Allow-Origin', req.get('Origin')\n        res.set 'Access-Control-Allow-Methods', 'GET, POST'\n        res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n        res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n        res.set 'Access-Control-Allow-Max-Age', 0\n\nBrowsers check for CORS support by doing a \"preflight\". This means sending a\nHTTP `OPTIONS` request to the server and checking the returned CORS-headers. No\nbody is required for this request so we can safely end this request now.\n\n      if req.method is 'OPTIONS' and req.path isnt '\/CloudHealthCheck'\n        return res.status(200).end()\n\n      return next()\n\n## Routes\n\n    app.all '\/CloudHealthCheck', (req, res, next) ->\n      res.status 200\n      return res.end() if req.method is 'HEAD'\n      return res.json message: 'System OK'\n\n    app.use '\/', require '.\/routes\/api_v1'\n    app.use '\/api\/v1\/', require '.\/routes\/api_v1'\n\n    app.get '\/', (req, res, next) ->\n      res.redirect '\/api\/v1'\n\n## Not Found\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n### Error Handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      if err.code is 'LIMIT_UNEXPECTED_FILE'\n        err.message = \"Unknown form field \\\"#{err.field}\\\"\"\n        err.statusCode = 400\n\n      if not err.statusCode or err.statusCode >= 500\n        console.error err\n        console.error err.message\n        console.error err.stack\n\n      res.status err.statusCode or 500\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Unknown error'\n\n### Start Server\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server is listening on port #{process.env.PORT_WWW}\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"21514205554def4e26c6196640d46399d810b49f","subject":"Multiple type docs","message":"Multiple type docs\n","repos":"johannhof\/typed-bacon","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# typed-bacon [![](https:\/\/travis-ci.org\/johannhof\/typed-bacon.svg)](https:\/\/travis-ci.org\/johannhof\/typed-bacon)\nType checks in your Bacon stream!\n\n> This document is an executable source file that contains tests to stay up to date.\n\n    assert = require('assert')\n\n## Usage\n\nRequiring Bacon before typed-bacon ensures that the custom methods can hook into Bacon correctly.\nYou need to require `typed-bacon` to add the custom type methods to Bacon observables.\nYou will also want to get access to the Types object.\n\n    Bacon = require('baconjs')\n    {Types} = require('typed-bacon')\n\n## API\n\n### Observable.typeCheck\n\nTransforms a value to an error if the input is not of the specified type.\n\n    Bacon.fromArray([1, 2, \"three\"])\n         .typeCheck(Types.Number)\n         .onError (e) ->\n           assert(e instanceof Error)\n           assert.equal(e.message, \"Expected three to be of type number.\")\n\n### Observable.typeFilter\n\nFilters out all stream values that are not of the specified type.\n\n    Bacon.fromArray([1, \"two\", 3, true, 4])\n         .typeFilter(Types.Number)\n         .slidingWindow(3,3)\n         .onValue (arr) ->\n           assert.deepEqual(arr, [1, 3, 4])\n\n### Observable.typeWarn\n\nComing soon!\n\n### Multiple types\n\nIn some (hopefully rare) cases you might be forced to have different stream value types in your streams.\nA common use case is allowing a stream to contain `null` if it currently doesn't have a value.\nThis can be supported by passing multiple parameters to the Observable methods.\n\n    Bacon.fromArray([1, \"two\", 3, null, 4])\n         .typeFilter(Types.Number, Types.Null)\n         .slidingWindow(4,4)\n         .onValue (arr) ->\n           assert.deepEqual(arr, [1, 3, null, 4])\n\n### Types.Object\n\n### Types.Array\n\n","old_contents":"# typed-bacon [![](https:\/\/travis-ci.org\/johannhof\/typed-bacon.svg)](https:\/\/travis-ci.org\/johannhof\/typed-bacon)\nType checks in your Bacon stream!\n\n_This document is a source file that can be run and contains tests to stay up to date._\n\n    assert = require('assert')\n\n## Usage\n\nRequiring Bacon before typed-bacon ensures that the custom methods can hook into Bacon correctly.\n\n    Bacon = require('baconjs')\n\nYou need to require `typed-bacon` to add the custom type methods to Bacon observables.\nYou will also want to get access to the Types object.\n\n    {Types} = require('typed-bacon')\n\n## API\n\n### Observable.typeCheck\n\nTransforms a value to an error if the input is not of the specified type.\n\n    Bacon.fromArray([1, 2, \"3\"])\n         .typeCheck(Types.Number)\n         .onError (e) ->\n           assert(e instanceof Error)\n           assert.equal(e.message, \"Expected 3 to be of type number.\")\n\n### Observable.typeFilter\n\nFilters out all stream values that are not of the specified type.\n\n    Bacon.fromArray([1, \"2\", 3, true, 4])\n         .typeFilter(Types.Number)\n         .slidingWindow(3,3)\n         .onValue (arr) ->\n           assert.deepEqual(arr, [1, 3, 4])\n\n### Observable.typeWarn\n\n### Types.Object\n\n### Types.Array\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c742ce03eb52a9fc0f7d3f2ebe4aacb0c95ed058","subject":"onDisconnect remove from queue; close #10","message":"onDisconnect remove from queue; close #10\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"server\/queueMethods.litcoffee","new_file":"server\/queueMethods.litcoffee","new_contents":"# Super secret queue methods\n\n    @QueueMethods =\n      popAndServeNextTicket: ->\n\nMove the current connection to the processed queue\n\nTODO: get postID\n\n        queueMeta = QueueMeta.findOne()\n\nUpdate object, extended at various point for updating the QueueMeta in one swoop\n\n        update =\n          $set: {}\n\nIf `theOnlyConnectionAllowedIn` is set to something, check if the connection\nhas expired and process the connection if it has.\n\n        if queueMeta.theOnlyConnectionAllowedIn isnt undefined\n\nReturn if timeCurrentTicketExpires is in the future (hasn't expired)\n\n          hasntExpired = queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n          return if hasntExpired\n\nOkay then, the current connection has expired, time to get bumped.\nInsert the processed connection into the ProcessedQueue\n\n          try\n\nCalculate how long the connection had to wait in line.\n\n            waitTimeSeconds = moment.utc().diff (moment.utc queueMeta.theOnlyConnectionAllowedIn.timeEnqueued), 'seconds'\n\nMake the processed object.\n\n            processed =\n              connection: queueMeta.theOnlyConnectionAllowedIn\n              waitTimeSeconds: waitTimeSeconds\n\nInsert the processed connection to `QueueProcessed`\n\n            QueueProcessed.insert processed\n          catch err\n            console.log err\n\nRemove the connection from the `Queue`\n\n          criteria = connectionId: queueMeta.theOnlyConnectionAllowedIn.connectionId\n          Queue.remove criteria\n\nUpdate `QueueMeta` stats and ticket number.\n\n          try\n            averageWaitTimeSeconds = Math.round (((queueMeta.currentlyServingTicketNumber - 1) * queueMeta.averageWaitTimeSeconds) + waitTimeSeconds) \/ queueMeta.currentlyServingTicketNumber\n            totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n            currentlyServingTicketNumber = queueMeta.currentlyServingTicketNumber + 1\n            _.extend update.$set,\n              currentlyServingTicketNumber: currentlyServingTicketNumber\n              hasCurrentConnectionPosted: no\n              averageWaitTimeSeconds: averageWaitTimeSeconds\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          catch err\n            console.log err\n\nLookup the lowest ticket # waiting in the `Queue`\n\n        nextConnection = Queue.findOne {}, $sort: ticketNumber: 1\n\nSet the allowed connection and expireTime if one exists\n\nIf there is a nextConnection (i.e. someone waiting in line), then serve them.\nOtherwise clear out theOnlyConnectionAllowedIn.\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          _.extend update.$set,\n            theOnlyConnectionAllowedIn: nextConnection\n            timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n            currentlyServingTicketNumber: nextConnection.ticketNumber\n\nIf there is no nextConnection, unset theOnlyConnectionAllowedIn.\nNote, fake data is filled in to pass schema, even though we're $unset'ing\n\n        else\n          update.$unset = theOnlyConnectionAllowedIn: \"\"\n\n        criteria = _id: queueMeta._id\n\nDelete `update.$set` if it's empty\n\n        if _.isEmpty update.$set\n          delete update.$set\n\nIf `update` isn't empty, update!\n\n        if not _.isEmpty update\n          QueueMeta.update criteria, update\n\nTODO: keep it DRY; logic isn't exactly shared and want to keep update atomic to\navoid extraneous DDP messages.\n\n## Disconnect, remove from queue\n\n    Meteor.onConnection (connection) ->\n      connection.onClose ->\n\nRemove the connection from the `Queue`\n\n          criteria = connectionId: connection.id\n          Queue.remove criteria\n","old_contents":"# Super secret queue methods\n\n    @QueueMethods =\n      popAndServeNextTicket: ->\n\nMove the current connection to the processed queue\n\nTODO: get postID\n\n        queueMeta = QueueMeta.findOne()\n\nUpdate object, extended at various point for updating the QueueMeta in one swoop\n\n        update =\n          $set: {}\n\nIf `theOnlyConnectionAllowedIn` is set to something, check if the connection\nhas expired and process the connection if it has.\n\n        if queueMeta.theOnlyConnectionAllowedIn isnt undefined\n\nReturn if timeCurrentTicketExpires is in the future (hasn't expired)\n\n          hasntExpired = queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n          return if hasntExpired\n\nOkay then, the current connection has expired, time to get bumped.\nInsert the processed connection into the ProcessedQueue\n\n          try\n\nCalculate how long the connection had to wait in line.\n\n            waitTimeSeconds = moment.utc().diff (moment.utc queueMeta.theOnlyConnectionAllowedIn.timeEnqueued), 'seconds'\n\nMake the processed object.\n\n            processed =\n              connection: queueMeta.theOnlyConnectionAllowedIn\n              waitTimeSeconds: waitTimeSeconds\n\nInsert the processed connection to `QueueProcessed`\n\n            QueueProcessed.insert processed\n          catch err\n            console.log err\n\nRemove the connection from the `Queue`\n\n          criteria = connectionId: queueMeta.theOnlyConnectionAllowedIn.connectionId\n          Queue.remove criteria\n\nUpdate `QueueMeta` stats and ticket number.\n\n          try\n            averageWaitTimeSeconds = Math.round (((queueMeta.currentlyServingTicketNumber - 1) * queueMeta.averageWaitTimeSeconds) + waitTimeSeconds) \/ queueMeta.currentlyServingTicketNumber\n            totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n            currentlyServingTicketNumber = queueMeta.currentlyServingTicketNumber + 1\n            _.extend update.$set,\n              currentlyServingTicketNumber: currentlyServingTicketNumber\n              hasCurrentConnectionPosted: no\n              averageWaitTimeSeconds: averageWaitTimeSeconds\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          catch err\n            console.log err\n\nLookup the lowest ticket # waiting in the `Queue`\n\n        nextConnection = Queue.findOne {}, $sort: ticketNumber: 1\n\nSet the allowed connection and expireTime if one exists\n\nIf there is a nextConnection (i.e. someone waiting in line), then serve them.\nOtherwise clear out theOnlyConnectionAllowedIn.\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          _.extend update.$set,\n            theOnlyConnectionAllowedIn: nextConnection\n            timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n            currentlyServingTicketNumber: nextConnection.ticketNumber\n\nIf there is no nextConnection, unset theOnlyConnectionAllowedIn.\nNote, fake data is filled in to pass schema, even though we're $unset'ing\n\n        else\n          update.$unset = theOnlyConnectionAllowedIn: \"\"\n\n        criteria = _id: queueMeta._id\n\nDelete `update.$set` if it's empty\n\n        if _.isEmpty update.$set\n          delete update.$set\n\nIf `update` isn't empty, update!\n\n        if not _.isEmpty update\n          QueueMeta.update criteria, update\n\nTODO: keep it DRY; logic isn't exactly shared and want to keep update atomic to\navoid extraneous DDP messages.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7889bc4717e5ae472274aa9c11bfa18745e4bfe7","subject":"Add note about double-dash bindings with camelCased arguments to docs","message":"Add note about double-dash bindings with camelCased arguments to docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# \/api\/App Components\/Batman.View\/Batman.View Bindings\n\nSee the [guide](\/docs\/bindings.html) for an overview of view bindings. All bindings take a keypath as an attribute value unless otherwise specified.\n\nBinding | Description | Example\n-----|----|----\n`data-bind`| Binds `innerHTML` or input value. Great for all kinds of inputs. | `<input type=\"checkbox\" data-bind=\"user.isAuthorized\" \/>`\n`data-bind-#{attr}`| Binds node's `attr` to the keypath | `data-bind-id='post.id'`\n`data-source`| `innerHTML` or value will get value from the keypath, but not set it | `<p data-source=\"post.content\"><\/p>`\n`data-source-#{attr}`| Node's `attr` will get its value from the keypath | `<h1 data-source-id='post.id'><\/h1>`\n`data-target`| Changes to the node will set the keypath, but not get from the keypath |`<input data-target='user.name' \/>`\n`data-context-#{name}`| Makes keypath value accessible as `name` inside node | `data-context-lastcomment='mostRecentPost.comments.last'`\n`data-context`| Makes attributes of keypath directly accessible inside node|\n`data-showif`| Shows node if keypath returns truthy | `data-showif='user.isAuthorized'`\n`data-hideif`| Hides node if keypath returns truthy | `data-hideif='post.alreadyPublished'`\n`data-insertif`| The node will be present in the DOM if the keypath returns truthy | `data-insertif='post.isPublished'`\n`data-removeif`| The node will be removed from the DOM if the keypath returns truthy | `data-removeif='comment.isNotAppropriate'`\n`data-renderif`| Node's contents will only be rendered if the keypath returns truthy |\n`data-deferif`| Node's contents will only be rendered if the keypath returns falsey|\n`data-route`| Takes a `Batman.NamedRouteQuery`. Clicking this node will route to the keypath. | `data-route='routes.posts[post].edit'`\n`data-route-params` | Appends the keypath the route generated by a `data-route` on the node | `data-route-params='myParamString'\n`data-view`| Wraps the node in the view specified | `data-view='NavigatorView'`\n`data-view-#{optionName}`| Passes keypath value to `data-view` as `optionName` (see `View.option`) | `data-view-user='currentUser'`\n`data-partial`| Takes a __string__, renders the template with that path | `data-partial='posts\/_form'`\n`data-defineview`| Wraps HTML which should be stored by `Batman.View` | `data-defineview='posts\/index'`\n`data-yield`| Creates a named yield for the application | `data-yield='modal'`\n`data-contentfor`| Wraps content for a non-default yield | `data-contentfor='modal'`\n`data-debug`| Calls `debugger` when instantiating the binding | `data-debug=\"true\"`\n`data-event-#{eventName}`| Binds keypath value to `eventName` on this node | `data-event-click='notifyAllUsers'`\n`data-addclass-#{className}`| Adds class `className` if keypath returns truthy | `data-addclass-selected='item.selected'`\n`data-removeclass-#{className}`| Removes class `className` if keypath returns truthy | `data-removeclass-highlight='item.isPast'`\n`data-foreach-#{itemName}`| Make a copy of this node for each member in keypath; children accessible as `itemName` | `data-foreach-item='myCollection'`\n`data-formfor-#{name}`| Inputs for keypath value will observe errors; keypath value aliased as `name`| `data-formfor-comment='newComment'`\n`data-style-#{styleAttrName}`| Bind the node's style attribute `styleAttrName` to the keypath value| `data-style-float='leftOrRight'`\n`data-track-#{clickOrView}`| Track clicks or views on this node. | `data-track-view='logView'`\n\n**Note:** Since HTML is technically case insensitive, bindings using the double-dash syntax (e.g. `data-context-#{name}`) should use lowercase names as arguments. See [Issue #957](https:\/\/github.com\/batmanjs\/batman\/issues\/957) for more information.\n\n#### Keypath Filters\n\nBinding keypaths may be passed through view filters. See the [`Batman.View Filters` documentation](\/docs\/api\/batman.view_filters.html) for more information.\n\n## Custom Bindings\n\nTo add a custom binding,\n\n- Extend an existing batman.js binding class\n- Create a binding hook as a property of  `Batman.DOM.readers` or `Batman.DOM.attrReaders` (for bindings like `data-binding-#{attr}`).\n\nFor example, a `data-permission` binding:\n\n```coffeescript\n# Usage:\n# <div data-permission='administrator'>\n#   <!-- equal to `data-showif='isAdministrator'` -->\n# <\/div>\n\n# Binding class\nclass Batman.DOM.PermissionBinding extends Batman.DOM.ShowHideBinding\n  constructor: (definition) ->\n    permissionName = definition.keyPath\n    permissionKeyPath = \"is#{Batman.helpers.titleize(permissionName)}\"\n    definition.keyPath = permissionKeyPath\n    super(definition)\n\n# Binding hook:\nBatman.DOM.readers.permission = (definition) ->\n  new Batman.DOM.PermissionBinding(definition)\n\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n__Automatic Validation Display__\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `myFunction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"myFunction\">Execute myFunction!<\/button>\n```\n\nYou can use `data-event` to execute controller actions without routing:\n\n```html\n<!-- with beforeAction & afterAction filters: -->\n<a data-event-click='controllers.items.executeAction | withArguments \"new\"'>Create a new item<\/a>\n<!-- or, skipping beforeAction & afterAction filters: -->\n<a data-event-click=\"controllers.items.new\">Create a new item<\/a>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-route-params\n\nAdds the provided keypath or literal value to the route provided to `data-route`. For example:\n\n```html\n<a data-route='routes.villians.new' data-route-params='\"mastermind=true\"'>Mastermind<\/a>\n```\n\nwill route to `\/villians\/new?mastermind=true` and\n\n```\n<a data-route='routes.villians.new' data-route-params='otherRouteParams'>Other<\/a>\n```\n\nwill look up `otherRouteParams` and append it to `\/villains\/new`, adding a `?` if necessary.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n## data-track\n\n`data-track-#{viewOrClick}` fires events on an internal instance of a user-defined `MyApp.EventTracker` class. An `EventTracker` must respond to `track(viewOrClick, keypathValue, node)`, where:\n\n- `viewOrClick` is the binding attribute argument\n- `keypathValue` is the value of the keypath passed to the binding\n- `node` is the bound node.\n\nThe node is considered _viewed_ when the binding is initialized.\n\nUnder the hood, batman.js will instantiate `MyApp.EventTracker` once, storing it at `Batman.Tracking.tracker`.\n\n## data-debug\n\nCalls `debugger` when instantiating the binding. `DebuggerBinding` is removed from production builds of batman.js.\n","old_contents":"# \/api\/App Components\/Batman.View\/Batman.View Bindings\n\nSee the [guide](\/docs\/bindings.html) for an overview of view bindings. All bindings take a keypath as an attribute value unless otherwise specified.\n\nBinding | Description | Example\n-----|----|----\n`data-bind`| Binds `innerHTML` or input value. Great for all kinds of inputs. | `<input type=\"checkbox\" data-bind=\"user.isAuthorized\" \/>`\n`data-bind-#{attr}`| Binds node's `attr` to the keypath | `data-bind-id='post.id'`\n`data-source`| `innerHTML` or value will get value from the keypath, but not set it | `<p data-source=\"post.content\"><\/p>`\n`data-source-#{attr}`| Node's `attr` will get its value from the keypath | `<h1 data-source-id='post.id'><\/h1>`\n`data-target`| Changes to the node will set the keypath, but not get from the keypath |`<input data-target='user.name' \/>`\n`data-context-#{name}`| Makes keypath value accessible as `name` inside node | `data-context-lastcomment='mostRecentPost.comments.last'`\n`data-context`| Makes attributes of keypath directly accessible inside node|\n`data-showif`| Shows node if keypath returns truthy | `data-showif='user.isAuthorized'`\n`data-hideif`| Hides node if keypath returns truthy | `data-hideif='post.alreadyPublished'`\n`data-insertif`| The node will be present in the DOM if the keypath returns truthy | `data-insertif='post.isPublished'`\n`data-removeif`| The node will be removed from the DOM if the keypath returns truthy | `data-removeif='comment.isNotAppropriate'`\n`data-renderif`| Node's contents will only be rendered if the keypath returns truthy |\n`data-deferif`| Node's contents will only be rendered if the keypath returns falsey|\n`data-route`| Takes a `Batman.NamedRouteQuery`. Clicking this node will route to the keypath. | `data-route='routes.posts[post].edit'`\n`data-route-params` | Appends the keypath the route generated by a `data-route` on the node | `data-route-params='myParamString'\n`data-view`| Wraps the node in the view specified | `data-view='NavigatorView'`\n`data-view-#{optionName}`| Passes keypath value to `data-view` as `optionName` (see `View.option`) | `data-view-user='currentUser'`\n`data-partial`| Takes a __string__, renders the template with that path | `data-partial='posts\/_form'`\n`data-defineview`| Wraps HTML which should be stored by `Batman.View` | `data-defineview='posts\/index'`\n`data-yield`| Creates a named yield for the application | `data-yield='modal'`\n`data-contentfor`| Wraps content for a non-default yield | `data-contentfor='modal'`\n`data-debug`| Calls `debugger` when instantiating the binding | `data-debug=\"true\"`\n`data-event-#{eventName}`| Binds keypath value to `eventName` on this node | `data-event-click='notifyAllUsers'`\n`data-addclass-#{className}`| Adds class `className` if keypath returns truthy | `data-addclass-selected='item.selected'`\n`data-removeclass-#{className}`| Removes class `className` if keypath returns truthy | `data-removeclass-highlight='item.isPast'`\n`data-foreach-#{itemName}`| Make a copy of this node for each member in keypath; children accessible as `itemName` | `data-foreach-item='myCollection'`\n`data-formfor-#{name}`| Inputs for keypath value will observe errors; keypath value aliased as `name`| `data-formfor-comment='newComment'`\n`data-style-#{styleAttrName}`| Bind the node's style attribute `styleAttrName` to the keypath value| `data-style-float='leftOrRight'`\n`data-track-#{clickOrView}`| Track clicks or views on this node. | `data-track-view='logView'`\n\n\n#### Keypath Filters\n\nBinding keypaths may be passed through view filters. See the [`Batman.View Filters` documentation](\/docs\/api\/batman.view_filters.html) for more information.\n\n## Custom Bindings\n\nTo add a custom binding,\n\n- Extend an existing batman.js binding class\n- Create a binding hook as a property of  `Batman.DOM.readers` or `Batman.DOM.attrReaders` (for bindings like `data-binding-#{attr}`).\n\nFor example, a `data-permission` binding:\n\n```coffeescript\n# Usage:\n# <div data-permission='administrator'>\n#   <!-- equal to `data-showif='isAdministrator'` -->\n# <\/div>\n\n# Binding class\nclass Batman.DOM.PermissionBinding extends Batman.DOM.ShowHideBinding\n  constructor: (definition) ->\n    permissionName = definition.keyPath\n    permissionKeyPath = \"is#{Batman.helpers.titleize(permissionName)}\"\n    definition.keyPath = permissionKeyPath\n    super(definition)\n\n# Binding hook:\nBatman.DOM.readers.permission = (definition) ->\n  new Batman.DOM.PermissionBinding(definition)\n\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n__Automatic Validation Display__\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `myFunction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"myFunction\">Execute myFunction!<\/button>\n```\n\nYou can use `data-event` to execute controller actions without routing:\n\n```html\n<!-- with beforeAction & afterAction filters: -->\n<a data-event-click='controllers.items.executeAction | withArguments \"new\"'>Create a new item<\/a>\n<!-- or, skipping beforeAction & afterAction filters: -->\n<a data-event-click=\"controllers.items.new\">Create a new item<\/a>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-route-params\n\nAdds the provided keypath or literal value to the route provided to `data-route`. For example:\n\n```html\n<a data-route='routes.villians.new' data-route-params='\"mastermind=true\"'>Mastermind<\/a>\n```\n\nwill route to `\/villians\/new?mastermind=true` and\n\n```\n<a data-route='routes.villians.new' data-route-params='otherRouteParams'>Other<\/a>\n```\n\nwill look up `otherRouteParams` and append it to `\/villains\/new`, adding a `?` if necessary.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n## data-track\n\n`data-track-#{viewOrClick}` fires events on an internal instance of a user-defined `MyApp.EventTracker` class. An `EventTracker` must respond to `track(viewOrClick, keypathValue, node)`, where:\n\n- `viewOrClick` is the binding attribute argument\n- `keypathValue` is the value of the keypath passed to the binding\n- `node` is the bound node.\n\nThe node is considered _viewed_ when the binding is initialized.\n\nUnder the hood, batman.js will instantiate `MyApp.EventTracker` once, storing it at `Batman.Tracking.tracker`.\n\n## data-debug\n\nCalls `debugger` when instantiating the binding. `DebuggerBinding` is removed from production builds of batman.js.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c5d3cae2b9a4e0995ef85ab1a9581fcf21b66cb3","subject":"average times","message":"average times\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"server\/queueMethods.litcoffee","new_file":"server\/queueMethods.litcoffee","new_contents":"# Super secret queue methods\n\n    @QueueMethods =\n      popAndServeNextTicket: ->\n\nMove the current connection to the processed queue\n\nTODO: get postID\n\n        queueMeta = QueueMeta.findOne()\n\nSave `currentlyServingTicketNumber` for potential updating if we bump the queue\n\n        currentlyServingTicketNumber = queueMeta.currentlyServingTicketNumber\n\nUpdate object, extended at various point for updating the QueueMeta\n\n        update =\n          $set: {}\n\nIf the currentlyServingTicketNumber is 0, skip attempting to archive the conneciton to ProcessedQueue\n\n        if queueMeta.theOnlyConnectionAllowedIn isnt undefined\n\nReturn if there is no connection to pop or the timeCurrentTicketExpires hasn't expired\n\n          hasntExpired = queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n          return if hasntExpired\n\nInsert the processed connection into the ProcessedQueue\n\n          try\n            waitTimeSeconds = moment.utc().diff (moment.utc queueMeta.theOnlyConnectionAllowedIn.timeEnqueued), 'seconds'\n            processed =\n              connection: queueMeta.theOnlyConnectionAllowedIn\n              waitTimeSeconds: waitTimeSeconds\n            QueueProcessed.insert processed\n          catch err\n            console.log err\n\nRemove the connection\n\n          criteria =\n            connectionId: queueMeta.theOnlyConnectionAllowedIn.connectionId\n\n          Queue.remove criteria\n\nNow serving the next ticket number, and this ticket hasn't posted\n\n\n          try\n            averageWaitTimeSeconds = Math.round (((currentlyServingTicketNumber - 1) * queueMeta.averageWaitTimeSeconds) + waitTimeSeconds) \/ currentlyServingTicketNumber\n            totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n            currentlyServingTicketNumber += 1\n            _.extend update.$set,\n              currentlyServingTicketNumber: currentlyServingTicketNumber\n              hasCurrentConnectionPosted: no\n              averageWaitTimeSeconds: averageWaitTimeSeconds\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          catch err\n            console.log err\n\n\nTry to serve the next connection\n\n        criteria = ticketNumber: currentlyServingTicketNumber\n        nextConnection = Queue.findOne criteria\n\nSet the allowed connection and expireTime if one exists\n\nIf there is a nextConnection (i.e. someone waiting in line), then serve them.\nOtherwise clear out theOnlyConnectionAllowedIn.\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          _.extend update.$set,\n            theOnlyConnectionAllowedIn: nextConnection\n            timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n\nSet up timeout function to pop queue\n\n          delayPop = Meteor.setTimeout QueueMethods.popAndServeNextTicket, 1000\n\nIf there is no nextConnection, unset theOnlyConnectionAllowedIn.\nNote, fake data is filled in to pass schema, even though we're $unset'ing\n\n        else\n          update.$unset = theOnlyConnectionAllowedIn: \"\"\n\n        criteria = _id: queueMeta._id\n\n        QueueMeta.update criteria, update\n\nTODO: keep it DRY; logic isn't exactly shared and want to keep update atomic to\navoid extraneous DDP messages.\n\n      serveCurrentTicket: ->\n\nLookup the queue (only one for now)\n\n        queueMeta = QueueMeta.findOne()\n\nGet the next connection.\n\n        criteria =\n          ticketNumber: queueMeta.currentlyServingTicketNumber\n\n        nextConnection = Queue.findOne criteria\n\nSet the allowed connection and expireTime if one exists\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          update =\n            $set:\n              theOnlyConnectionAllowedIn: nextConnection\n              timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n          criteria = _id: queueMeta._id\n\nSet up timeout function to pop queue\n\n          delayPop = Meteor.setTimeout QueueMethods.popAndServeNextTicket, 1000\n\n          QueueMeta.update criteria, update\n","old_contents":"# Super secret queue methods\n\n    @QueueMethods =\n      popAndServeNextTicket: ->\n\nMove the current connection to the processed queue\n\nTODO: get postID\n\n        queueMeta = QueueMeta.findOne()\n\nSave `currentlyServingTicketNumber` for potential updating if we bump the queue\n\n        currentlyServingTicketNumber = queueMeta.currentlyServingTicketNumber\n\nUpdate object, extended at various point for updating the QueueMeta\n\n        update =\n          $set: {}\n\nIf the currentlyServingTicketNumber is 0, skip attempting to archive the conneciton to ProcessedQueue\n\n        if queueMeta.theOnlyConnectionAllowedIn isnt undefined\n\nReturn if there is no connection to pop or the timeCurrentTicketExpires hasn't expired\n\n          hasntExpired = queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n          return if hasntExpired\n\nInsert the processed connection into the ProcessedQueue\n\n          processed =\n            connection: queueMeta.theOnlyConnectionAllowedIn\n            waitTimeSeconds: (moment.utc()).seconds() - (moment.utc queueMeta.theOnlyConnectionAllowedIn.timeEnqueued).seconds()\n\n          QueueProcessed.insert processed\n\nRemove the connection\n\n          criteria =\n            connectionId: queueMeta.theOnlyConnectionAllowedIn.connectionId\n\n          Queue.remove criteria\n\nNow serving the next ticket number, and this ticket hasn't posted\n\n          currentlyServingTicketNumber += 1\n          _.extend update.$set,\n            currentlyServingTicketNumber: currentlyServingTicketNumber\n            hasCurrentConnectionPosted: no\n\nTry to serve the next connection\n\n        criteria = ticketNumber: currentlyServingTicketNumber\n        nextConnection = Queue.findOne criteria\n\nSet the allowed connection and expireTime if one exists\n\nIf there is a nextConnection (i.e. someone waiting in line), then serve them.\nOtherwise clear out theOnlyConnectionAllowedIn.\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          _.extend update.$set,\n            theOnlyConnectionAllowedIn: nextConnection\n            timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n\nSet up timeout function to pop queue\n\n          delayPop = Meteor.setTimeout QueueMethods.popAndServeNextTicket, 1000\n\nIf there is no nextConnection, unset theOnlyConnectionAllowedIn.\nNote, fake data is filled in to pass schema, even though we're $unset'ing\n\n        else\n          update.$unset = theOnlyConnectionAllowedIn: \"\"\n\n        criteria = _id: queueMeta._id\n\n\n        QueueMeta.update criteria, update\n\nTODO: keep it DRY; logic isn't exactly shared and want to keep update atomic to\navoid extraneous DDP messages.\n\n      serveCurrentTicket: ->\n\nLookup the queue (only one for now)\n\n        queueMeta = QueueMeta.findOne()\n\nGet the next connection.\n\n        criteria =\n          ticketNumber: queueMeta.currentlyServingTicketNumber\n\n        nextConnection = Queue.findOne criteria\n\nSet the allowed connection and expireTime if one exists\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          update =\n            $set:\n              theOnlyConnectionAllowedIn: nextConnection\n              timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n          criteria = _id: queueMeta._id\n\nSet up timeout function to pop queue\n\n          delayPop = Meteor.setTimeout QueueMethods.popAndServeNextTicket, 1000\n\n          QueueMeta.update criteria, update\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"20ca4f905212e1e1e6f2d0b05aee7f86258856fb","subject":"on call error, clear calls before calling fail","message":"on call error, clear calls before calling fail\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        @_handleResponse data, options, last\n       when 'call'\n        @_handleCall data, options, last\n       when 'poll'\n        @_handlePoll data, options, last\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        @_handleResponse data, options, last\n       when 'call'\n        @_handleCall data, options, last\n       when 'poll'\n        @_handlePoll data, options, last\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9658fe76d201c5c08177da60b4e64ad21865e092","subject":"document new filters","message":"document new filters\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14a_filters.litcoffee","new_file":"docs\/14a_filters.litcoffee","new_contents":"# \/api\/App Components\/Batman.View\/Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\nBatman.js ships with many built-in view filters:\n\nType | Filters\n---|----\n__Logical Operators__ |  `and`, `or`, `not`\n__Comparison Operators__ | `equals`, `eq`, `neq`, `lt`, `gt`, `lteq`, `gteq`\n__General Utilities__ | `get`, `[]`, `meta`, `default`\n__Number Helpers__ | `ceil`, `floor`, `round`, `precision`, `fixed`, `delimitNumber`, `ordinalize`\n__Set Helpers__ |  `join`, `sort`, `map`, `has`, `first`, `toSentence`\n__String Helpers__ | `interpolate`, `escape`, `capitalize`, `titleize`, `singularize`, `underscore`, `camelize`, `trim`, `raw`, `matches`, `truncate`, `prepend`, `append`, `replace`, `downcase`, `upcase`, `pluralize`, `humanize`\n__Event Helpers__ | `withArguments`, `toggle`, `increment`, `decrement`\n__Debuggers__ | `log`, `logStack`\n\n\n## Custom Filters\n\nYou can define custom filters by setting them on the `Batman.Filters` object. For example, a batman.js view filter that formats a date with [moment.js](http:\/\/momentjs.com):\n\n```coffeescript\n# `moment` is the moment.js object\nBatman.Filters.dateFormat = (date, format) ->\n  moment(date).format(format)\n```\n\nYou can also define custom filters when defining custom views with [`Batman.View.filter`](docs\/api\/batman.view.html#class_function_filter).\n\n## equals(left, right) or eq(left, right): Boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n<span data-showif=\"value | eq 10\"><\/span>\n<span data-showif=\"value | eq true\"><\/span>\n```\n\n__Note__: there is actually _one_ difference between `eq` and `equals`: `equals` rejects undefined values, but `eq` allows them.\n\n## lt(left, right) : Boolean\n\nChecks if left content is `less than` the right content.\n\n```html\n<span data-showif=\"posts.length | lt 10\"><\/span>\n```\n\n## gt(left, right) : Boolean\n\nChecks if left content is `greater than` the right content.\n\n```html\n<span data-showif=\"posts.length | gt 10\"><\/span>\n```\n\n## lteq(left, right) : Boolean\n\nChecks if left content is `less than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | lteq 10\"><\/span>\n```\n\n## gteq(left, right) : Boolean\n\nChecks if left content is `greater than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | gteq 10\"><\/span>\n```\n\n## neq(left, right) : Boolean\n\nChecks if left content is `is NOT equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | neq 10\"><\/span>\n```\n\n## ceil(value) : string\n\nThe `ceil` filter will run `Math.ceil` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | ceil\"><\/span>\n```\n\n## floor(value) : string\n\nThe `floor` filter will run `Math.floor` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | floor\"><\/span>\n```\n\n## round(value) : string\n\nThe `round` filter will run `Math.round` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | round\"><\/span>\n```\n\n## percision(value, toPlace) : string\n\nThe `precision` filter will run `toPrecision()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | precision\"><\/span>\n<span data-bind=\"someValue | precision 3\"><\/span>\n```\n\n## fixed(value, toPlace) : string\n\nThe `fixed` filter will run `toFixed()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | fixed\"><\/span>\n<span data-bind=\"someValue | fixed 3\"><\/span>\n```\n\n## delimitNumber(value) : string\n\nThe `delimitNumber` filter will comma delimit a 'number'. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | delimitNumber\"><\/span>\n```\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## and(inputValue, otherValue) : boolean\n\nReturns `true` if `inputValue` and `otherValue` are truthy:\n\n```html\n<p data-showif='post.published | and currentUser.loggedIn'><\/p>\n```\n\n## or(inputValue, otherValue) : boolean\n\nReturns `true` if either `inputValue` or `otherValue` are truthy:\n\n```html\n<p data-showif='post.published | or currentUser.isAdmin'><\/p>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count, includeCount[=true]) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## singularize(string) : string\n\nReturns the singular inflection of `string`.\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## titleize(value) : string\n\nHumanizes `string` and capitalizes each word. For example,\n\n```html\n<span data-bind=\"'about_us_page' | titleize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | titleize\">About Us Page<\/span>\n```\n\n## underscore(string) : string\n\nConverts `string` to underscore case.\n\n## camelize(string, firstLetterLower[=false]) : string\n\nConverts `string` to camel case. if `firstLetterLower` is true, the first letter will be lowercase.\n\n## ordinalize(numberOrString) : string\n\nTurns `numberOrString` into an ordinalized number, for example, `4 | ordinalize` becomes `4th`.\n\n## join(array, separator = '') : string\n\nJoins `array` into a single string with `separator`:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## toSentence(array) : string\n\nJoins `array` with `, ` and ` and`, as appropriate. See [helpers.toSentence](\/docs\/api\/batman.helpers.html#class_function_tosentence).\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\nLooks up `keypath` on `value.meta`. The `value` must have a `meta` property to look up against.\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n\n## toggle(keypath) : function \n\nReturns a handler for toggling `keypath`. Clicking this button will toggle `showMeMore` between `true` and `false`:\n\n```html\n<button data-event-click='showMeMore | toggle'><\/button>\n```\n\n## increment(keypath, change[=1]) : function\n\nReturns a handler that increments `keypath` by `change`. If `keypath` 's value isn't set, it will be treated as 0.\n\n```html\n<button data-event-click='totalScore | increment'>Add 1<\/button>\n```\n\n## decrement(keypath, change[=1]) : function\n\nReturns a handler that decrements `keypath` by `change`. If `keypath` 's value isn't set, it will be treated as 0.\n\n```html\n<button data-event-click='totalScore | decrement 3'>Subtract 3<\/button>\n```\n","old_contents":"# \/api\/App Components\/Batman.View\/Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\nBatman.js ships with many built-in view filters:\n\nType | Filters\n---|----\n__Logical Operators__ |  `and`, `or`, `not`\n__Comparison Operators__ | `equals`, `eq`, `neq`, `lt`, `gt`, `lteq`, `gteq`\n__General Utilities__ | `get`, `[]`, `meta`, `withArguments`, `default`\n__Number Helpers__ | `ceil`, `floor`, `round`, `precision`, `fixed`, `delimitNumber`, `ordinalize`\n__Set Helpers__ |  `join`, `sort`, `map`, `has`, `first`, `toSentence`\n__String Helpers__ | `interpolate`, `escape`, `capitalize`, `titleize`, `singularize`, `underscore`, `camelize`, `trim`, `raw`, `matches`, `truncate`, `prepend`, `append`, `replace`, `downcase`, `upcase`, `pluralize`, `humanize`\n__Debuggers__ | `log`, `logStack`\n\n\n## Custom Filters\n\nYou can define custom filters by setting them on the `Batman.Filters` object. For example, a batman.js view filter that formats a date with [moment.js](http:\/\/momentjs.com):\n\n```coffeescript\n# `moment` is the moment.js object\nBatman.Filters.dateFormat = (date, format) ->\n  moment(date).format(format)\n```\n\nYou can also define custom filters when defining custom views with [`Batman.View.filter`](docs\/api\/batman.view.html#class_function_filter).\n\n## equals(left, right) or eq(left, right): Boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n<span data-showif=\"value | eq 10\"><\/span>\n<span data-showif=\"value | eq true\"><\/span>\n```\n\n__Note__: there is actually _one_ difference between `eq` and `equals`: `equals` rejects undefined values, but `eq` allows them.\n\n## lt(left, right) : Boolean\n\nChecks if left content is `less than` the right content.\n\n```html\n<span data-showif=\"posts.length | lt 10\"><\/span>\n```\n\n## gt(left, right) : Boolean\n\nChecks if left content is `greater than` the right content.\n\n```html\n<span data-showif=\"posts.length | gt 10\"><\/span>\n```\n\n## lteq(left, right) : Boolean\n\nChecks if left content is `less than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | lteq 10\"><\/span>\n```\n\n## gteq(left, right) : Boolean\n\nChecks if left content is `greater than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | gteq 10\"><\/span>\n```\n\n## neq(left, right) : Boolean\n\nChecks if left content is `is NOT equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | neq 10\"><\/span>\n```\n\n## ceil(value) : string\n\nThe `ceil` filter will run `Math.ceil` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | ceil\"><\/span>\n```\n\n## floor(value) : string\n\nThe `floor` filter will run `Math.floor` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | floor\"><\/span>\n```\n\n## round(value) : string\n\nThe `round` filter will run `Math.round` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | round\"><\/span>\n```\n\n## percision(value, toPlace) : string\n\nThe `precision` filter will run `toPrecision()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | precision\"><\/span>\n<span data-bind=\"someValue | precision 3\"><\/span>\n```\n\n## fixed(value, toPlace) : string\n\nThe `fixed` filter will run `toFixed()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | fixed\"><\/span>\n<span data-bind=\"someValue | fixed 3\"><\/span>\n```\n\n## delimitNumber(value) : string\n\nThe `delimitNumber` filter will comma delimit a 'number'. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | delimitNumber\"><\/span>\n```\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## and(inputValue, otherValue) : boolean\n\nReturns `true` if `inputValue` and `otherValue` are truthy:\n\n```html\n<p data-showif='post.published | and currentUser.loggedIn'><\/p>\n```\n\n## or(inputValue, otherValue) : boolean\n\nReturns `true` if either `inputValue` or `otherValue` are truthy:\n\n```html\n<p data-showif='post.published | or currentUser.isAdmin'><\/p>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count, includeCount[=true]) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## singularize(string) : string\n\nReturns the singular inflection of `string`.\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## titleize(value) : string\n\nHumanizes `string` and capitalizes each word. For example,\n\n```html\n<span data-bind=\"'about_us_page' | titleize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | titleize\">About Us Page<\/span>\n```\n\n## underscore(string) : string\n\nConverts `string` to underscore case.\n\n## camelize(string, firstLetterLower[=false]) : string\n\nConverts `string` to camel case. if `firstLetterLower` is true, the first letter will be lowercase.\n\n## ordinalize(numberOrString) : string\n\nTurns `numberOrString` into an ordinalized number, for example, `4 | ordinalize` becomes `4th`.\n\n## join(array, separator = '') : string\n\nJoins `array` into a single string with `separator`:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## toSentence(array) : string\n\nJoins `array` with `, ` and ` and`, as appropriate. See [helpers.toSentence](\/docs\/api\/batman.helpers.html#class_function_tosentence).\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\nLooks up `keypath` on `value.meta`. The `value` must have a `meta` property to look up against.\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"53f9f2d23596d196a416df12b29ea72694186d5d","subject":"Close #2 - Measure image processing time","message":"Close #2 - Measure image processing time\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/server.litcoffee","new_file":"src\/server.litcoffee","new_contents":"    url          = require 'url'\n\n    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n    librato      = require '.\/librato'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketRegion: process.env.AWS_BUCKET_REGION\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      origin = url.parse req.get('Origin') or ''\n\n      if origin.hostname not in origins\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status = 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      librato.measure 'image.upload', Object.keys(req.files).length, {}\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        t1 = new Date().getTime()\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          librato.logImageProcessingTime t1, new Date().getTime()\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","old_contents":"    url          = require 'url'\n\n    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n    librato      = require '.\/librato'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketRegion: process.env.AWS_BUCKET_REGION\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      origin = url.parse req.get('Origin') or ''\n\n      if origin.hostname not in origins\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status = 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      librato.measure 'image.upload', Object.keys(req.files).length, {}\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"564403576e7cda71a1fc4e0059f4ccaa229f3be8","subject":"doc cleanup","message":"doc cleanup\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/16_dom.litcoffee","new_file":"docs\/16_dom.litcoffee","new_contents":"# Batman.DOM\n\nBatman includes some helper methods to assist in DOM manipulation.\n\nThe following are included in the platform adapters:\n - `querySelector`\n - `querySelectorAll`\n - `destroyNode`\n - `setInnerHTML`\n - `textContent`\n - `addEventListener`\n - `removeEventListener`\n\n## @scrollIntoView(elementID : string)\nScrolls the desired element into view.  If the element isn't there or\ndoesn't have a `scrollIntoView` method this will fail silently.\n\n## @setStyleProperty(node : Node,property : string,value : string, importance : string)\nSets the style property or attribute on the supplied node.  This method will prefer `setProperty` over `setAttribute`.\n\n\ttest \"setStyleProperty\", ->\n\t  node = document.createElement('div')\n\t  Batman.DOM.setStyleProperty( node, \"color\", \"white\", \"important\")\n\t  equal node.style.getPropertyValue(\"color\"), \"white\"\n\t  equal \"important\", node.style.getPropertyPriority(\"color\")\n\n## @valueForNode(node: Node [, value = '',escapeValue = true ]) : string\nGets the value of a node and optionally sets it as well.  `escapeValue` will escape the value via `Batman.escapeHTML`\n\n\ttest 'valueForNode', ->\n\t  node = document.createElement('input')\n\t  val = Batman.DOM.valueForNode(node, 'stuff' )\n\t  equal val, \"stuff\"\n\t  equal node.value, \"stuff\"\n\n## @nodeIsEditable(node) : boolean\nReturns whether a node is editable or not.\n\n\ttest 'nodeIsEditable', ->\n\t  node = document.createElement('div')\n\t  ok !Batman.DOM.nodeIsEditable(node)\n\t  node = document.createElement('input')\n\t  ok Batman.DOM.nodeIsEditable(node)\n\n## @addEventListener(node : Node, eventName : string, callback : function)\nAdds the event listener, uses the platform `addEventListener` if available otherwise use `attachEvent on{eventName}`\nBatman stores the listeners internally.\n\n\ttest 'addEventListener', 1, ->\n\t  node = document.createElement('div')\n\t  Batman.DOM.addEventListener( node, 'click', -> ok true )\n\t  node.dispatchEvent(new Event('click'))\n\n## @removeEventListener(node : Node, eventName : string, callback : function)\nRemoves the event listener from the node and removes any internal references to it.\n\n## @cleanupNode(node : Node)\nRemoves all the event listeners from the specified node and any child nodes.\n\n## .hasAddEventListener : boolean\nReturns the whether the `window` object contains addEventListener.\n\n\ttest \"does the window have an event listener\", ->\n\t  ok Batman.DOM.hasAddEventListener\n\n## @preventDefault(e : Event)\nPrevents the default event from happening.  If preventDefault isn't a `function` then it will set the `returnValue` to false\n\n\ttest \"preventDefault\", ->\n\t  e = { returnValue: true }\n\t  Batman.DOM.preventDefault(e)\n\t  ok !e.returnValue\n\n\t  e = { preventDefault: -> ok true }\n\t  Batman.DOM.preventDefault(e)\n\n## @stopPropagation(e : Event)\nStops the event from propogating.  If the stopPropgation isn't a `function` then it will set `cancelBubble` to true\n\n\ttest \"stopPropagation\", ->\n\t  e = { cancelBubble: false }\n\t  Batman.DOM.stopPropagation(e)\n\t  ok e.cancelBubble\n\n\t  e = {stopPropagation: -> ok true }\n\t  Batman.DOM.stopPropagation(e)\n\n### The following methods are only available with the jQuery platform or a polyfill\n\n## @querySelectorAll(node : Node, selector : string)\nPerforms a jQuery like selector depending on your platform\n\n## @querySelector(node : Node, selector : string)\nPerforms a jQuery like selector that returns one element\n\n## @destroyNode(node : Node)\nCalls `Batman.DOM.cleanupNode` and  removes node and anything inside from the document tree.\n\n\ttest 'destroyNode', ->\n\t  node1 = document.createElement('div')\n\t  node2 = document.createElement('div')\n\t  node3 = document.createElement('div')\n\t  node1.appendChild(node2)\n\t  node2.appendChild(node3)\n\n\t  Batman.DOM.destroyNode( node1 )\n\t  equal node1.childNodes.length, 1\n\n## @setInnerHtml(node : Node, html : string)\nSet an element's content and any content that was in that element is completely replaced by the new content.\n_note_ this can't be used on XML documents.\n\n\ttest \"innerHTML\", ->\n\t  node = document.createElement('div')\n\t  Batman.DOM.setInnerHTML(node, \"FOO\")\n\t  equal node.innerHTML, \"FOO\"\n\n## @textContent(node) : string\nReturns the string of the text contained in the node.\n\n\ttest \"textContent\", ->\n\t  node = document.createElement('div')\n\t  content = document.createTextNode(\"FOO\")\n\t  node.appendChild(content)\n\t  equal Batman.DOM.textContent(node), \"FOO\"\n","old_contents":"# Batman.DOM\n\nBatman includes some helper methods to assist in DOM manipulation.\n\nThe following are included in the platform adapters:\n - `querySelector`\n - `querySelectorAll`\n - `destroyNode`\n - `setInnerHTML`\n - `textContent`\n - `addEventListener`\n - `removeEventListener`\n\n## @scrollIntoView (elementID)\nScrolls the desired element into view.  If the element isn't there or\ndoesn't have a `scrollIntoView` method this will fail silently.\n\n## @setStyleProperty ( node : Node, property : String, value : String, importance : String )\nSets the style property or attribute on the supplied node.  This method will prefer `setProperty` over `setAttribute`.\n\n    test \"setStyleProperty\", ->\n      node = document.createElement('div')\n      Batman.DOM.setStyleProperty( node, \"color\", \"white\", \"important\")\n      equal node.style.getPropertyValue(\"color\"), \"white\"\n      equal \"important\", node.style.getPropertyPriority(\"color\")\n\n## @valueForNode ( node: Node, [ value = '', escapeValue = true ] )\nGets the value of a node and optionally sets it as well.  `escapeValue` will escape the value via `Batman.escapeHTML`\n\n    test 'valueForNode', ->\n      node = document.createElement('input')\n      val = Batman.DOM.valueForNode(node, 'stuff' )\n      equal val, \"stuff\"\n      equal node.value, \"stuff\"\n\n## @nodeIsEditable ( node )\nReturns whether a node is editable or not.\n\n    test 'nodeIsEditable', ->\n      node = document.createElement('div')\n      ok !Batman.DOM.nodeIsEditable(node)\n      node = document.createElement('input')\n      ok Batman.DOM.nodeIsEditable(node)\n\n## @addEventListener ( node, eventName, callback )\nAdds the event listener, uses the platform `addEventListener` if available otherwise use `attachEvent on{eventName}`\nBatman stores the listeners internally.\n\n    test 'addEventListener', 1, ->\n      node = document.createElement('div')\n      Batman.DOM.addEventListener( node, 'click', -> ok true )\n      node.dispatchEvent(new Event('click'))\n\n## @removeEventListener( node, eventName, callback )\nRemoves the event listener from the node and removes any internal references to it.\n\n## @cleanupNode (node)\nRemoves all the event listeners from the specified node and any child nodes.\n\n## @hasAddEventListener\nReturns the whether the `window` object contains addEventListener.\n\n    test \"does the window have an event listener\", ->\n      ok Batman.DOM.hasAddEventListener\n\n## @preventDefault ( e : Event )\nPrevents the default event from happening.  If preventDefault isn't a `function` then it will set the `returnValue` to false\n\n    test \"preventDefault\", ->\n      e = { returnValue: true }\n      Batman.DOM.preventDefault(e)\n      ok !e.returnValue\n\n      e = { preventDefault: -> ok true }\n      Batman.DOM.preventDefault(e)\n\n## @ stopPropagation ( e : Event )\nStops the event from propogating.  If the stopPropgation isn't a `function` then it will set `cancelBubble` to true\n\n    test \"stopPropagation\", ->\n      e = { cancelBubble: false }\n      Batman.DOM.stopPropagation(e)\n      ok e.cancelBubble\n\n      e = {stopPropagation: -> ok true }\n      Batman.DOM.stopPropagation(e)\n\n### The following methods are only available with the jQuery platform or a polyfill\n\n## @querySelectorAll (node, selector)\nPerforms a jQuery like selector depending on your platform\n\n## @querySelector (node, selector )\nPerforms a jQuery like selector that returns one element\n\n## @destroyNode (node)\nCalls `Batman.DOM.cleanupNode` and  removes node and anything inside from the document tree.\n\n    test 'destroyNode', ->\n      node1 = document.createElement('div')\n      node2 = document.createElement('div')\n      node3 = document.createElement('div')\n      node1.appendChild(node2)\n      node2.appendChild(node3)\n\n      Batman.DOM.destroyNode( node1 )\n      equal node1.childNodes.length, 1\n\n## @setInnerHtml (node, html)\nSet an element's content and any content that was in that element is completely replaced by the new content.\n_note_ this can't be used on XML documents.\n\n    test \"innerHTML\", ->\n      node = document.createElement('div')\n      Batman.DOM.setInnerHTML(node, \"FOO\")\n      equal node.innerHTML, \"FOO\"\n\n## @textContent ( node )\nReturns the string of the text contained in the node.\n\n    test \"textContent\", ->\n      node = document.createElement('div')\n      content = document.createTextNode(\"FOO\")\n      node.appendChild(content)\n      equal Batman.DOM.textContent(node), \"FOO\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9e98a7d2e8255ae7acca1fc2dda0282537ab7987","subject":"Fix incorrect collection cursor count","message":"Fix incorrect collection cursor count\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower.\n\n      if typeof req.query.sort is 'string' and req.query.sort\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\nOnly apply default sort if there are no geospatial queries.\n\n      else\n        sort = 'endret' if not req.db.query.geojson\n\n### Execute\n\nSet limit, skip and, sort options for documents to be returned.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\n      cursor = req.db.col.find(req.db.query, fields, options)\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower.\n\n      if typeof req.query.sort is 'string' and req.query.sort\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\nOnly apply default sort if there are no geospatial queries.\n\n      else\n        sort = 'endret' if not req.db.query.geojson\n\n### Execute\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(req.db.query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"153026469f76c308d3a3ed8550080fb6416955d6","subject":"NativeItem auto size on browser bug fixed","message":"NativeItem auto size on browser bug fixed\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/renderer\/types\/basics\/native.litcoffee","new_file":"src\/renderer\/types\/basics\/native.litcoffee","new_contents":"# Native\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    assert = require 'src\/assert'\n    colorUtils = require 'src\/renderer\/utils\/color'\n\n    IS_NATIVE = not utils.isServer and not utils.isBrowser\n\n    if IS_NATIVE\n        nativeBridge = require 'src\/native'\n\n    module.exports = (Renderer, Impl, itemUtils) ->\n\n        class Native extends Renderer.Item\n            @__name__ = 'Native'\n            @__path__ = 'Renderer.Native'\n\n## *Native* Native.New([*Component* component, *Object* options])\n\n            @New = (component, opts) ->\n                item = new @\n                itemUtils.Object.initialize item, component, opts\n                unless IS_NATIVE\n                    item.onParentChange Impl.updateNativeSize\n                @Initialize? item\n                item\n\n## Native.defineProperty(*Object* config)\n\nDefines new property with the given name.\n\nFor each property, signal `onXYZChange` is created,\nwhere `XYZ` is the given name.\n\n`config` parameter must be an object with specified keys:\n- `enabled` - whether it's supported on current platform,\n- `name` - name of the property,\n- `type` - type of predefined condifuration described below,\n- `defaultValue`,\n- `setter`,\n- `getter`,\n- `developmentSetter`\n- `implementationValue` - function returning value passed to the implementation.\n\n### Predefined types\n\n            PROPERTY_TYPES = Object.create null\n\n#### text\n\n            PROPERTY_TYPES.text = ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n\n#### number\n\n            PROPERTY_TYPES.number = ->\n                defaultValue: 0\n                developmentSetter: (val) ->\n                    assert.isFloat val\n\n#### boolean\n\n            PROPERTY_TYPES.boolean = ->\n                defaultValue: false\n                developmentSetter: (val) ->\n                    assert.isBoolean val\n\n#### color\n\n            PROPERTY_TYPES.color = (config) ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n                implementationValue: do ->\n                    RESOURCE_REQUEST =\n                        property: 'color'\n                    (val) ->\n                        val = Renderer.resources?.resolve(val, RESOURCE_REQUEST) or val\n                        if IS_NATIVE\n                            if val?\n                                colorUtils.toRGBAHex val, config.defaultValue\n                            else\n                                null\n                        else\n                            val\n\n#### item\n\n            PROPERTY_TYPES.item = (config) ->\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Renderer.Item\n                implementationValue: (val) ->\n                    if IS_NATIVE\n                        if val?\n                            val._impl.id\n                        else\n                            null\n                    else\n                        val\n\n            @defineProperty = (config) ->\n                itemName = @__name__\n                properties = @_properties ||= []\n                config = utils.clone config\n\n                assert.isString itemName, '''\n                    NativeItem.__name__ unique name must be specified\n                '''\n                assert.isObject config, '''\n                    NativeItem.defineProperty config parameter must be an object\n                '''\n                assert.isString config.name, '''\n                    NativeItem property name must be a string\n                '''\n                assert.isNotDefined properties[config.name], \"\"\"\n                    Property #{config.name} is already defined\n                \"\"\"\n                assert.isDefined PROPERTY_TYPES[config.type], \"\"\"\n                    Unknown property type #{config.type}\n                \"\"\" if config.type\n\n                # type\n                if typeConfigFunc = PROPERTY_TYPES[config.type]\n                    typeConfig = typeConfigFunc(config)\n                    for key, val of typeConfig\n                        if key not of config\n                            config[key] = val\n\n                # constructor\n                config.constructor = @\n\n                # internalName\n                config.internalName = itemUtils.getPropInternalName config.name\n\n                # implementation\n                config.implementation = do ->\n                    if config.enabled is false\n                        return utils.NOP\n\n                    ctorName = utils.capitalize itemName\n                    name = utils.capitalize config.name\n                    if IS_NATIVE\n                        funcName = \"rendererSet#{ctorName}#{name}\"\n                        (val) ->\n                            nativeBridge.callFunction funcName, @_impl.id, val\n                    else\n                        funcName = \"set#{ctorName}#{name}\"\n                        (val) ->\n                            Impl[funcName]?.call @, val\n\n                # save\n                properties.push config\n\n                # create\n                itemUtils.defineProperty config\n\n## *Native* Native::constructor() : *Item*\n\n            constructor: ->\n                super()\n\n                unless IS_NATIVE\n                    @_autoWidth = true\n                    @_autoHeight = true\n                    @_width = -1\n                    @_height = -1\n\n                # save properties with default values\n                if properties = @constructor._properties\n                    for property in properties\n                        @[property.internalName] = property.defaultValue\n\n            unless IS_NATIVE\n                _width: -1\n                getter = utils.lookupGetter @::, 'width'\n                itemWidthSetter = utils.lookupSetter @::, 'width'\n                utils.defineProperty @::, 'width', null, getter,\n                    do (_super = itemWidthSetter) -> (val) ->\n                        if @_autoWidth = val is -1\n                            Impl.updateNativeSize.call @\n                        else\n                            _super.call @, val\n                        return\n\n                _height: -1\n                getter = utils.lookupGetter @::, 'height'\n                itemHeightSetter = utils.lookupSetter @::, 'height'\n                utils.defineProperty @::, 'height', null, getter,\n                    do (_super = itemHeightSetter) -> (val) ->\n                        if @_autoHeight = val is -1\n                            Impl.updateNativeSize.call @\n                        else\n                            _super.call @, val\n                        return\n\n## Native::set(*String* propName, *Any* val)\n\n            set: (name, val) ->\n                assert.isString name, \"NativeItem.set name must be a string, but #{name} given\"\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    funcName = \"rendererSet#{ctorName}#{name}\"\n                    nativeBridge.callFunction funcName, id, val\n                else\n                    funcName = \"set#{ctorName}#{name}\"\n                    Impl[funcName]?.call @, val\n                return\n\n## Native::call(*String* funcName, *Any* args...)\n\n            call: (name, args...) ->\n                assert.isString name, \"NativeItem.call name must be a string, but #{name} given\"\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    funcName = \"rendererCall#{ctorName}#{name}\"\n                    callArgs = [funcName, id, args...]\n                    nativeBridge.callFunction.apply nativeBridge, callArgs\n                else\n                    funcName = \"call#{ctorName}#{name}\"\n                    Impl[funcName]?.apply @, args\n                return\n\n## Native::on(*String* eventName, *Function* listener)\n\n            # nativeEventName -> item id -> [item, listeners...]\n            eventListeners = Object.create null\n\n            createNativeEventListener = (listeners, eventName) -> (id) ->\n                unless itemListeners = listeners[id]\n                    log.warn \"Got a native event '#{eventName}' for an item which \" +\n                        \"didn't register a listener on this event; check if you \" +\n                        \"properly call 'on()' method with a signal listener\"\n                    return\n\n                length = arguments.length\n                args = new Array length - 1\n                for i in [0...length - 1] by 1\n                    args[i] = arguments[i + 1]\n\n                item = itemListeners[0]\n                for i in [1...itemListeners.length] by 1\n                    itemListeners[i].apply item, args\n\n                return\n\n            on: (name, func) ->\n                assert.isString name, \"NativeItem.on name must be a string, but #{name} given\"\n                assert.isFunction func, \"\"\"\n                    NativeItem.on listener must be a function, but #{func} given\n                \"\"\"\n\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    ctorName = utils.capitalize @constructor.__name__\n                    eventName = \"rendererOn#{ctorName}#{name}\"\n\n                    unless listeners = eventListeners[eventName]\n                        listeners = eventListeners[eventName] = Object.create(null)\n                        nativeBridge.on eventName, createNativeEventListener(listeners, eventName)\n\n                    itemListeners = listeners[@_impl.id] ?= [@]\n                    itemListeners.push func\n                else\n                    eventName = \"on#{name}\"\n                    @_impl[eventName]?.connect func\n                return\n\n        Native\n","old_contents":"# Native\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    assert = require 'src\/assert'\n    colorUtils = require 'src\/renderer\/utils\/color'\n\n    IS_NATIVE = not utils.isServer and not utils.isBrowser\n\n    if IS_NATIVE\n        nativeBridge = require 'src\/native'\n\n    module.exports = (Renderer, Impl, itemUtils) ->\n\n        class Native extends Renderer.Item\n            @__name__ = 'Native'\n            @__path__ = 'Renderer.Native'\n\n## *Native* Native.New([*Component* component, *Object* options])\n\n            @New = (component, opts) ->\n                item = new @\n                itemUtils.Object.initialize item, component, opts\n                unless IS_NATIVE\n                    item.onParentChange Impl.updateNativeSize\n                @Initialize? item\n                item\n\n## Native.defineProperty(*Object* config)\n\nDefines new property with the given name.\n\nFor each property, signal `onXYZChange` is created,\nwhere `XYZ` is the given name.\n\n`config` parameter must be an object with specified keys:\n- `enabled` - whether it's supported on current platform,\n- `name` - name of the property,\n- `type` - type of predefined condifuration described below,\n- `defaultValue`,\n- `setter`,\n- `getter`,\n- `developmentSetter`\n- `implementationValue` - function returning value passed to the implementation.\n\n### Predefined types\n\n            PROPERTY_TYPES = Object.create null\n\n#### text\n\n            PROPERTY_TYPES.text = ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n\n#### number\n\n            PROPERTY_TYPES.number = ->\n                defaultValue: 0\n                developmentSetter: (val) ->\n                    assert.isFloat val\n\n#### boolean\n\n            PROPERTY_TYPES.boolean = ->\n                defaultValue: false\n                developmentSetter: (val) ->\n                    assert.isBoolean val\n\n#### color\n\n            PROPERTY_TYPES.color = (config) ->\n                defaultValue: ''\n                developmentSetter: (val) ->\n                    assert.isString val\n                implementationValue: do ->\n                    RESOURCE_REQUEST =\n                        property: 'color'\n                    (val) ->\n                        val = Renderer.resources?.resolve(val, RESOURCE_REQUEST) or val\n                        if IS_NATIVE\n                            if val?\n                                colorUtils.toRGBAHex val, config.defaultValue\n                            else\n                                null\n                        else\n                            val\n\n#### item\n\n            PROPERTY_TYPES.item = (config) ->\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Renderer.Item\n                implementationValue: (val) ->\n                    if IS_NATIVE\n                        if val?\n                            val._impl.id\n                        else\n                            null\n                    else\n                        val\n\n            @defineProperty = (config) ->\n                itemName = @__name__\n                properties = @_properties ||= []\n                config = utils.clone config\n\n                assert.isString itemName, '''\n                    NativeItem.__name__ unique name must be specified\n                '''\n                assert.isObject config, '''\n                    NativeItem.defineProperty config parameter must be an object\n                '''\n                assert.isString config.name, '''\n                    NativeItem property name must be a string\n                '''\n                assert.isNotDefined properties[config.name], \"\"\"\n                    Property #{config.name} is already defined\n                \"\"\"\n                assert.isDefined PROPERTY_TYPES[config.type], \"\"\"\n                    Unknown property type #{config.type}\n                \"\"\" if config.type\n\n                # type\n                if typeConfigFunc = PROPERTY_TYPES[config.type]\n                    typeConfig = typeConfigFunc(config)\n                    for key, val of typeConfig\n                        if key not of config\n                            config[key] = val\n\n                # constructor\n                config.constructor = @\n\n                # internalName\n                config.internalName = itemUtils.getPropInternalName config.name\n\n                # implementation\n                config.implementation = do ->\n                    if config.enabled is false\n                        return utils.NOP\n\n                    ctorName = utils.capitalize itemName\n                    name = utils.capitalize config.name\n                    if IS_NATIVE\n                        funcName = \"rendererSet#{ctorName}#{name}\"\n                        (val) ->\n                            nativeBridge.callFunction funcName, @_impl.id, val\n                    else\n                        funcName = \"set#{ctorName}#{name}\"\n                        (val) ->\n                            Impl[funcName]?.call @, val\n\n                # save\n                properties.push config\n\n                # create\n                itemUtils.defineProperty config\n\n## *Native* Native::constructor() : *Item*\n\n            constructor: ->\n                super()\n\n                unless IS_NATIVE\n                    @_autoWidth = true\n                    @_autoHeight = true\n                    @_width = -1\n                    @_height = -1\n\n                # save properties with default values\n                if properties = @constructor._properties\n                    for property in properties\n                        @[property.internalName] = property.defaultValue\n\n            unless IS_NATIVE\n                _width: -1\n                getter = utils.lookupGetter @::, 'width'\n                itemWidthSetter = utils.lookupSetter @::, 'width'\n                utils.defineProperty @::, 'width', null, getter,\n                    do (_super = itemWidthSetter) -> (val) ->\n                        if @_autoWidth = val is -1\n                            _super.call @, @_contentWidth\n                            Impl.updateNativeSize.call @\n                        else\n                            _super.call @, val\n                        return\n\n                _height: -1\n                getter = utils.lookupGetter @::, 'height'\n                itemHeightSetter = utils.lookupSetter @::, 'height'\n                utils.defineProperty @::, 'height', null, getter,\n                    do (_super = itemHeightSetter) -> (val) ->\n                        if @_autoHeight = val is -1\n                            _super.call @, @_contentHeight\n                            Impl.updateNativeSize.call @\n                        else\n                            _super.call @, val\n                        return\n\n## Native::set(*String* propName, *Any* val)\n\n            set: (name, val) ->\n                assert.isString name, \"NativeItem.set name must be a string, but #{name} given\"\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    funcName = \"rendererSet#{ctorName}#{name}\"\n                    nativeBridge.callFunction funcName, id, val\n                else\n                    funcName = \"set#{ctorName}#{name}\"\n                    Impl[funcName]?.call @, val\n                return\n\n## Native::call(*String* funcName, *Any* args...)\n\n            call: (name, args...) ->\n                assert.isString name, \"NativeItem.call name must be a string, but #{name} given\"\n\n                ctorName = utils.capitalize @constructor.__name__\n                id = @_impl.id\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    funcName = \"rendererCall#{ctorName}#{name}\"\n                    callArgs = [funcName, id, args...]\n                    nativeBridge.callFunction.apply nativeBridge, callArgs\n                else\n                    funcName = \"call#{ctorName}#{name}\"\n                    Impl[funcName]?.apply @, args\n                return\n\n## Native::on(*String* eventName, *Function* listener)\n\n            # nativeEventName -> item id -> [item, listeners...]\n            eventListeners = Object.create null\n\n            createNativeEventListener = (listeners, eventName) -> (id) ->\n                unless itemListeners = listeners[id]\n                    log.warn \"Got a native event '#{eventName}' for an item which \" +\n                        \"didn't register a listener on this event; check if you \" +\n                        \"properly call 'on()' method with a signal listener\"\n                    return\n\n                length = arguments.length\n                args = new Array length - 1\n                for i in [0...length - 1] by 1\n                    args[i] = arguments[i + 1]\n\n                item = itemListeners[0]\n                for i in [1...itemListeners.length] by 1\n                    itemListeners[i].apply item, args\n\n                return\n\n            on: (name, func) ->\n                assert.isString name, \"NativeItem.on name must be a string, but #{name} given\"\n                assert.isFunction func, \"\"\"\n                    NativeItem.on listener must be a function, but #{func} given\n                \"\"\"\n\n                name = utils.capitalize name\n\n                if IS_NATIVE\n                    ctorName = utils.capitalize @constructor.__name__\n                    eventName = \"rendererOn#{ctorName}#{name}\"\n\n                    unless listeners = eventListeners[eventName]\n                        listeners = eventListeners[eventName] = Object.create(null)\n                        nativeBridge.on eventName, createNativeEventListener(listeners, eventName)\n\n                    itemListeners = listeners[@_impl.id] ?= [@]\n                    itemListeners.push func\n                else\n                    eventName = \"on#{name}\"\n                    @_impl[eventName]?.connect func\n                return\n\n        Native\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"01b38058fb28831446115533a327e3117a8c8cd1","subject":"New prefixes for method signatures","message":"New prefixes for method signatures","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_controller.litcoffee","new_file":"docs\/10_controller.litcoffee","new_contents":"# Batman.Controller\n\n`Batman.Controller` is the base class from which all an application's controllers should descend from. `Batman.Controller`s are responsible for executing _actions_ which fire off requests for model data, render views, or redirect to other actions in response to navigation state changes.\n\n## Controller Directory\n\n`Batman.Controller`s are singletons which means each controller in your application is instantiated exactly once. The instance of each controller is available on the class at the `@sharedController` property, or within a `ControllerDirectory` on the `Application` class. See `Batman.Application.controllers`.\n\n## Actions\n\nEach `Batman.Controller` should have a number of instance level functions which can fetch the data needed and often render a view (or views) to display that data. These functions can be declared in typical CoffeeScript fashion like so:\n\n    class Alfred extends Batman.App\n      @root \"todos#index\"\n\n    class Alfred.TodosController extends Batman.Controller\n      index: (params) ->\n      show: (params) ->\n\nEach action function receives the parameters from the dispatcher which are pulled out of the navigated-to URL. This includes both named route parameters (`\/:foo` style) as well as arbitrary query parameters (`?foo=bar` style).\n\n## routingKey and Minification\n\nFor functionality like contextual redirects and automatic view source and class inference, Batman needs to know the name of all your `Controller` subclasses. The usual way to do this is by using `Function::name` which Batman will use in development, but this is often mangled in minified production environments. For this reason, Batman will error out on boot if a `Controller` subclass' `routingKey` is not defined on the prototype. The `routingKey` is a `String` which remains unmangled after minification and thus allows Batman to continue using the aforementioned features. To disable this requirement (if you know your code won't ever be minified), set `Batman.config.minificationErrors` to false.\n\n## ::render([options : [Object|boolean]])\n\n`render` is used to control the rendering of the currently executed action. Passing `false` will prevent the current action from implicitly rendering the view. Passing an `options` object allows the default `view`, `source`, `viewClass` or `yield` block to be overridden, all of which are optional. If no parameters are passed to options, it will manually trigger the render function, rather than waiting for it to be implicitly called at the end of the action.\n\n_Note_: For more information on yield blocks, see Controller::.defaultRenderYield\n\n    class TestController extends Batman.Controller\n      routingKey: 'test'\n\n      nonVisibleAction: ->\n        @render(false)\n\n      customSource: ->\n        @render(source: 'errors\/404')\n\n      customYield: ->\n        @render(into: 'not-main')\n\n      delayedRender: ->\n        setTimeout (-> @render()), 1000\n        @render(false)\n\n## @beforeAction([options : [string|Object],] filter : [string|Function])\n\n`@beforeAction` allows controllers to declare that a function should be executed before the body of an action during action execution. `@beforeAction` optionally accepts some options representing which action(s) to execute the filter before, and then a string naming a function or function proper to execute.\n\nThe `options` argument can take three forms to imply different things:\n\n 1. `undefined`: implies that this filter function should be executed before all actions.\n 2. a String: implies that this filter function should be executed before the action named by the string.\n 3. an Object: implies that this filter function should be executed before the actions named by an Array at the `only` key in the options object, or before all actions excluding those named by an Array at the `except` key in the options object.\n\n  \n\n    test \"@beforeAction allows declaration of filters to execute before an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n    test \"@beforeAction allows declaration of named filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"show\", \"fetchTodo\"\n        fetchTodo: -> @set(\"todo\", {isDone: true})\n        show: ->\n          @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n\n    test \"@beforeAction allows whitelisting or blacklisting filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: [\"show\", \"edit\"], \"fetchTodo\"\n        @beforeAction except: [\"index\"], \"prepareNewTodo\"\n        fetchTodo: -> @set \"todo\", {isDone: true}\n        prepareNewTodo: -> @set \"newTodo\", {isDone: false}\n        index: -> @render false\n        show: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n      deepEqual controller.get(\"newTodo\"), {isDone: false}\n\n    test \"@beforeAction allows declaration of filters to execute before all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n## @afterAction([options : [string|Object],] filter : [string|Function])\n\n`@afterAction` allows controllers to declare that a function should be run after the action body and all operations have completed during action execution. Functions declared by `@afterAction` will thus be run after the code of the action body and also after any redirects or renders have taken place and completed. `@afterAction` optionally accepts some options representing which action(s) to execute the filter after, and then a string naming a function or function proper to execute. See `Batman.Controller.beforeAction` for documentation on the structure of the options.\n\n    test \"@afterAction allows declaration of filters to execute after an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n    test \"@afterAction allows declaration of named filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"create\", \"notify\"\n        notify: -> result = \"Todo created successfully.\"\n        create: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows whitelisting or blacklisting filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: [\"create\", \"update\"], \"notify\"\n        index: -> @render false\n        create: -> @render false\n        notify: -> result = \"Todo created successfully.\"\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal result, null\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows declaration of filters to execute after all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n## ::executeAction(action: string[, params: Object])\n\n`executeAction` will run the `action` specified, running all `@beforeAction` and `@afterAction` filters that match that endpoint. Optionally, `params` can be passed into the new action for processing. If no params are passed, it will default to the params of the current action.\n\n    test \"executeAction will run the called action\", ->\n      result = null\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        show: (params) ->\n          result = params.id \n          @render false\n        other: ->\n          @executeAction(\"show\", {id: 4})\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      equal result, 4\n\n    test \"executeAction will run all @beforeAction and @afterAction filters\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: -> \n          results.push \"action!\"\n          @render false\n        other: ->\n          @executeAction(\"index\")\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      deepEqual results, [\"before!\", \"action!\", \"after!\"]\n\n## ::redirect(url: string)\n\n`redirect` will forward the user to a new route defined by `url` without hard-refreshing the page. This modifies the current page URL using pushState if supported, otherwise falling back to hash-bang fragment identifiers. The url can be obtained dynamically using `MyApp.get('routes').myResourceName().path()` or by manually passing a string, such as `@redirect('\/test')`.\n\n## ::scrollToHash([hash: string])\n\n`scrollToHash` emulates the native scrolling behaviour of the browser by allowing the URL to link to a specific ID on the page. The code will look for an element with a matching ID to `hash` if it is provided otherwise using the `#` parameter in the URL. If an element is found, the page will scroll to the matching element.\n\n## ::.autoScrollToHash[= true] : boolean\n\n`autoScrollToHash` is a boolean property on the instance level of a controller describing whether or not the controller should automatically scroll the browser window to the element with ID equal to the `hash` parameter. This behaviour emulates the native behaviour of the same nature, but is implemented in Batman so the functionality works after each dispatch (instead of each page refresh) and when Batman is using hash bang routing. `autoScrollToHash` is true by default.\n\n## ::.defaultRenderYield[= 'main'] : string\n\n`defaultRenderYield` is a `string` representing which yield a controller should automatically render into if no yield is mentioned explicitly. `defaultRenderYield` is `'main'` normally, which means calls to `@render()` or actions which rely on the implicit rendering render their views into the `main` yield (and end up wherever `data-yield=\"main\"` is found in your HTML).","old_contents":"# Batman.Controller\n\n`Batman.Controller` is the base class from which all an application's controllers should descend from. `Batman.Controllers` are responsible for executing _actions_ which fire off requests for model data, render views, or redirect to other actions in response to navigation state changes.\n\n## Controller Directory\n\n`Batman.Controller`s are singletons which means each controller in your application is instantiated exactly once. The instance of each controller is available on the class at the `@sharedContoller` property, or within a `ControllerDirectory` on the `Application` class. See `Batman.Application.controllers`.\n\n## Actions\n\nEach `Batman.Controller` should have a number of instance level functions which can fetch the data needed and often render a view (or views) to display that data. These functions can be declared in typical CoffeeScript fashion like so:\n\n```coffeescript\nclass Alfred.TodosController\n\n  index: (params) ->\n\n  show: (params) ->\n```\n\nEach action function receives the parameters from the dispatcher which are pulled out of the navigated-to URL. This includes both named route parameters (`\/:foo` style) as well as arbitrary query paramters (`?foo=bar` style).\n\n## `routingKey` and Minification\n\nFor functionality like contextual redirects and automatic view source and class inference, Batman needs to know the name of all your `Controller` subclasses. The usual way to do this is by using `Function::name` which Batman will use in development, but this is often mangled in minified production environments. For this reason, Batman will error out on boot if a `Controller` subclass' `routingKey` is not defined on the prototype. The `routingKey` is a `String` which remains unmangled after minification and thus allows Batman to continue using the aforementioned features. To disable this requirement (if you know your code won't ever be minified), set `Batman.config.minificationErrors` to false.\n\n## @beforeAction([options : [String|Object]], filter : [String|Function])\n\n`@beforeAction` allows controllers to declare that a function should be executed before the body of an action during action execution. `@beforeAction` optionally accepts some options representing which action(s) to execute the filter before, and then a string naming a function or function proper to execute.\n\nThe `options` argument can take three forms to imply different things:\n\n 1. `undefined`: implies that this filter function should be executed before all actions.\n 2. a String: implies that this filter function should be executed before the action named by the string.\n 3. an Object: implies that this filter function should be executed before the actions named by an Array at the `only` key in the options object, or before all actions excluding those named by an Array at the `except` key in the options object.\n\n    test \"@beforeAction allows declaration of filters to execute before an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: 'test'\n        @beforeAction only: 'index', -> results.push 'before!'\n        index: ->\n          results.push 'action!'\n          @render false\n\n      controller = TestController.get('sharedController')\n      controller.dispatch 'index'\n      equal results[0], 'before!'\n      equal results[1], 'action!'\n\n    test \"@beforeAction allows declaration of named filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: 'test'\n        @beforeAction only: 'show', 'fetchTodo'\n        fetchTodo: -> @set 'todo', {isDone: true}\n        show: ->\n          @render false\n\n      controller = TodoController.get('sharedController')\n      controller.dispatch 'show'\n      deepEqual controller.get('todo'), {isDone: true}\n\n    test \"@beforeAction allows whitelisting or blacklisting filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: 'test'\n        @beforeAction only: ['show', 'edit'], 'fetchTodo'\n        @beforeAction except: ['index'], 'prepareNewTodo'\n        fetchTodo: -> @set 'todo', {isDone: true}\n        prepareNewTodo: -> @set 'newTodo', {isDone: false}\n        index: -> @render false\n        show: -> @render false\n\n      controller = TodoController.get('sharedController')\n      controller.dispatch 'show'\n      deepEqual controller.get('todo'), {isDone: true}\n      deepEqual controller.get('newTodo'), {isDone: false}\n\n    test \"@beforeAction allows declaration of filters to execute before all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: 'test'\n        @beforeAction -> results.push 'before!'\n        index: ->\n          results.push 'action!'\n          @render false\n\n      controller = TestController.get('sharedController')\n      controller.dispatch 'index'\n      equal results[0], 'before!'\n      equal results[1], 'action!'\n\n## @afterAction([options : [String|Object]], filter : [String|Function])\n\n`@afterAction` allows controllers to declare that a function should be run after the action body and all operations have completed during action execution. Functions declared by `@afterAction` will thus be run after the code of the action body and also after any redirects or renders have taken place and completed. `@beforeAction` optionally accepts some options representing which action(s) to execute the filter before, and then a string naming a function or function proper to execute. See `Batman.Controller.beforeAction` for documentation on the structure of the options.\n\n    test \"@afterAction allows declaration of filters to execute before an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: 'test'\n        @afterAction only: 'index', -> results.push 'after!'\n        index: ->\n          results.push 'action!'\n          @render false\n\n      controller = TestController.get('sharedController')\n      controller.dispatch 'index'\n      equal results[0], 'action!'\n      equal results[1], 'after!'\n\n    test \"@afterAction allows declaration of named filters to execute before an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: 'test'\n        @afterAction only: 'create', 'notify'\n        create: -> @render false\n        notify: -> result = \"Todo created successfully.\"\n\n      controller = TodoController.get('sharedController')\n      controller.dispatch 'create'\n      equal result, 'Todo created successfully.'\n\n    test \"@afterAction allows whitelisting or blacklisting filters to execute before an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: 'test'\n        @afterAction {only: ['create', 'update']}, 'notify'\n        index: -> @render false\n        create: -> @render false\n        notify: -> result = \"Todo created successfully.\"\n\n      controller = TodoController.get('sharedController')\n      controller.dispatch 'index'\n      equal result, null\n      controller.dispatch 'create'\n      equal result, 'Todo created successfully.'\n\n    test \"@afterAction allows declaration of filters to execute before all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: 'test'\n        @afterAction -> results.push 'after!'\n        index: ->\n          results.push 'action!'\n          @render false\n\n      controller = TestController.get('sharedController')\n      controller.dispatch 'index'\n      equal results[0], 'action!'\n      equal results[1], 'after!'\n\n## autoScrollToHash[= true] : boolean\n\n`autoScrollToHash` is a boolean property on the instance level of a controller describing whether or not the controller should automatically scroll the browser window to the element with ID equal to the `hash` parameter. This behaviour emulates the native behaviour of the same nature, but is implemented in Batman so the functionality works after each dispatch (instead of each page refresh) and when Batman is using hash bang routing. `autoScrollToHash` is true by default.\n\n## defaultRenderYield[= 'main'] : String\n\n`defaultRenderYield` is a `String` representing which yield a controller should automatically render into if no yield is mentioned explicitly. `defaultRenderYield` is `'main'` normally, which means calls to `@render()` or actions which rely on the implicit rendering render their views into the `main` yield (and end up wherever `data-yield=\"main\"` is found in your HTML).\n\n\n## Controller Actions\n\n## executeAction\n\n## render\n\n## redirect\n\n## scrollToHash\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ead7b65171c92682664a794ccdf8fff7048d2bc6","subject":"Refactor:  turn constants into options.","message":"Refactor:  turn constants into options.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description\n\nHere we try to implement a time axis that would be more readable and at the same time more informative than conventionally used time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\nTest cases\n----------\n\n### Visual test cases\n\nThis are draft-thoughts.\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done, this is a draft:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\n### The `TimeAxisMaker` class\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n * `options.tickTailRatio`:  relative size of a tick on the other side of a baseline, upwards (so the length of the tick upwards will be tickTailRatio * tickLength).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`: absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n\nThe code:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n### The `TimeAxisRenderer` class\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n      timeAxisRedrerer = new TimeAxisRenderer()\n      timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nNotes\n-----\n\n### Notes related to only this file\n\nWell, no notes yet.\n\n### Notes that should be moved away at some point\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description\n\nHere we try to implement a time axis that would be more readable and at the same time more informative than conventionally used time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\nTest cases\n----------\n\n### Visual test cases\n\nThis are draft-thoughts.\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done, this is a draft:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\n### The `TimeAxisMaker` class\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\nThe code:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n### The `TimeAxisRenderer` class\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n      timeAxisRedrerer = new TimeAxisRenderer()\n      timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nNotes\n-----\n\n### Notes related to only this file\n\nWell, no notes yet.\n\n### Notes that should be moved away at some point\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b89ce0f4f2838bbcbd0a69c9f8998090e4194118","subject":"Add user specified field projection logic","message":"Add user specified field projection logic\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.usr}]\n\n### Fields\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        fields = {}\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\n      else\n        fields =\n          tilbyder: true\n          endret: true\n          status: true\n          lisens: true\n          navn: true\n          tags: true\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true, tags: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.usr}]\n\n#### ToDo\n\n * Limit number of private fields?\n * Limit depth of private fields?\n\n`NB` This section is looping through all of the url query parameters and hence\nshould take the queries from above sections into concideration so we don't need\nto do double amount of work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true, tags: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"344878a520d70e624e6d22dcd1a379ba42c35f1c","subject":"Add doc for filter on Views","message":"Add doc for filter on Views\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/13_view.litcoffee","new_file":"docs\/13_view.litcoffee","new_contents":"# Batman.View\n\nFor a general explanation of `Batman.View`s and how they work, see [the\nguide](\/docs\/views.html).\n\n\n## ::constructor(options = {})\n\nA `View` is a `Batman.Object`, so any options you pass are mixed in. Use this\nto set `html`, `node`, `superview`, `parentNode` and\/or your custom data.\n\n    test 'constructor mixes in options', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'constructor automatically adds to the superview if supplied', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      equal 1, superview.subviews.length\n\n\n## ::lookupKeypath(keypath) : Object\n\nTraverses up the view tree searching for the specified keypath, and returns the\nresult. This is equivalent to performing a `Batman.get` for each view above\n`this` in the tree, until a defined result is returned. The path it takes is as\nfollows:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\nIf there is no match, `undefined` is returned. However if used in an accessor\nor binding, the entire path to the root will be registered as a potential\nsource of the keypath. Consequently, if the keypath is later set on any part of\nthe chain, the data will be correctly bound.\n\n`lookupKeypath` is the function invoked to locate data when evaluating a\nbinding.\n\n    test 'lookupKeypath returns the value if defined on the view', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.lookupKeypath('animal')\n\n    test 'lookupKeypath returns the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'cat')\n      subview = new Batman.View(superview: superview)\n      equal 'cat', subview.lookupKeypath('animal')\n\n\n## ::setKeypath(keypath, value) : Object\n\nTraverses the View tree searching for the specified keypath, and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is the function invoked to set data when using an input binding.\n\n    test 'setKeypath sets the value if defined on the view', ->\n      view = new Batman.View(animal: 'dog')\n\n      view.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'setKeypath sets the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'dog')\n      subview = new Batman.View(superview: superview)\n\n      subview.setKeypath('animal', 'cat')\n      equal 'cat', superview.get('animal')\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n\n## ::%node : Node\n\nA reference to the DOM node that this view encapsulates. The entire tree\nbeneath this node is also the responsibility of this view and\/or its subviews.\n\nAccessing `node` will load and parse the template on demand if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview.\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n    test 'setting a source loads the correct template', ->\n      Batman.View.store.set('\/animals', '<div>cat<\/div>')\n      view = new Batman.View(source: '\/animals')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n## ::.superview : Batman.View\n\nA reference to the current superview (the direct ancestor in the tree). This is\nused for traversing the tree when searching for data, as in\n`View::lookupKeypath`.\n\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of a `View`. To manipulate the view tree, you should\noperate directly on this set \u2014 batman.js will automatically keep the DOM in\nsync with the logical tree.\n\n\n## ::subviews.add(view)\n\nAdding to a view's subview set will automatically update the tree, and parse\nthe template and bindings. If the superview is already in the DOM, this will\ninsert the current view's node into the DOM.\n\n    test 'adding to a superview parses bindings', ->\n      superview = new Batman.View()\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      superview.subviews.add(view)\n      equal 'cat', view.get('node').firstChild.innerHTML\n\n\n## ::subviews.remove(view)\n\nRemoving from a view's subview set will automatically remove the subview from\nthe DOM.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View(html: '', parentNode: document.body)\n      superview.get('node')\n      view = new Batman.View(html: '', superview: superview)\n\n      ok Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n      superview.subviews.remove(view)\n      ok not Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent, without killing it.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.removeFromSuperview()\n      ok not superview.subviews.has(view)\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n    test 'die kills the view', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.die()\n      equal true, view.isDead\n      equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n    test 'destroySubviews kills all subviews', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: superview)\n\n      superview.destroySubviews()\n      ok one.isDead\n      ok two.isDead\n\n\n## ::propagateToSubviews(eventOrKey : string, value : Object)\n\nIf `value` is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n    test 'propagateToSubviews propagates events', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.on 'eventName', superSpy = createSpy()\n      one.on 'eventName', oneSpy = createSpy()\n      two.on 'eventName', twoSpy = createSpy()\n\n      superview.propagateToSubviews('eventName')\n\n      equal 1, superSpy.callCount\n      equal 1, oneSpy.callCount\n      equal 1, twoSpy.callCount\n\n    test 'propagateToSubviews propagates keys', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.propagateToSubviews('key', 'value')\n\n      equal superview.get('key'), 'value'\n      equal one.get('key'), 'value'\n      equal two.get('key'), 'value'\n\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n\n\n## ::filter(label : string, filter : function)\n\nDefines a filter on the `View` class for use within the `View` during rendering.\n","old_contents":"# Batman.View\n\nFor a general explanation of `Batman.View`s and how they work, see [the\nguide](\/docs\/views.html).\n\n\n## ::constructor(options = {})\n\nA `View` is a `Batman.Object`, so any options you pass are mixed in. Use this\nto set `html`, `node`, `superview`, `parentNode` and\/or your custom data.\n\n    test 'constructor mixes in options', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'constructor automatically adds to the superview if supplied', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      equal 1, superview.subviews.length\n\n\n## ::lookupKeypath(keypath) : Object\n\nTraverses up the view tree searching for the specified keypath, and returns the\nresult. This is equivalent to performing a `Batman.get` for each view above\n`this` in the tree, until a defined result is returned. The path it takes is as\nfollows:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\nIf there is no match, `undefined` is returned. However if used in an accessor\nor binding, the entire path to the root will be registered as a potential\nsource of the keypath. Consequently, if the keypath is later set on any part of\nthe chain, the data will be correctly bound.\n\n`lookupKeypath` is the function invoked to locate data when evaluating a\nbinding.\n\n    test 'lookupKeypath returns the value if defined on the view', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.lookupKeypath('animal')\n\n    test 'lookupKeypath returns the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'cat')\n      subview = new Batman.View(superview: superview)\n      equal 'cat', subview.lookupKeypath('animal')\n\n\n## ::setKeypath(keypath, value) : Object\n\nTraverses the View tree searching for the specified keypath, and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is the function invoked to set data when using an input binding.\n\n    test 'setKeypath sets the value if defined on the view', ->\n      view = new Batman.View(animal: 'dog')\n\n      view.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'setKeypath sets the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'dog')\n      subview = new Batman.View(superview: superview)\n\n      subview.setKeypath('animal', 'cat')\n      equal 'cat', superview.get('animal')\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n\n## ::%node : Node\n\nA reference to the DOM node that this view encapsulates. The entire tree\nbeneath this node is also the responsibility of this view and\/or its subviews.\n\nAccessing `node` will load and parse the template on demand if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview.\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n    test 'setting a source loads the correct template', ->\n      Batman.View.store.set('\/animals', '<div>cat<\/div>')\n      view = new Batman.View(source: '\/animals')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n## ::.superview : Batman.View\n\nA reference to the current superview (the direct ancestor in the tree). This is\nused for traversing the tree when searching for data, as in\n`View::lookupKeypath`.\n\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of a `View`. To manipulate the view tree, you should\noperate directly on this set \u2014 batman.js will automatically keep the DOM in\nsync with the logical tree.\n\n\n## ::subviews.add(view)\n\nAdding to a view's subview set will automatically update the tree, and parse\nthe template and bindings. If the superview is already in the DOM, this will\ninsert the current view's node into the DOM.\n\n    test 'adding to a superview parses bindings', ->\n      superview = new Batman.View()\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      superview.subviews.add(view)\n      equal 'cat', view.get('node').firstChild.innerHTML\n\n\n## ::subviews.remove(view)\n\nRemoving from a view's subview set will automatically remove the subview from\nthe DOM.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View(html: '', parentNode: document.body)\n      superview.get('node')\n      view = new Batman.View(html: '', superview: superview)\n\n      ok Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n      superview.subviews.remove(view)\n      ok not Batman.DOM.containsNode(superview.get('node'), view.get('node'))\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent, without killing it.\n\n    test 'removing from the current superview removes the node from the DOM', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.removeFromSuperview()\n      ok not superview.subviews.has(view)\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n    test 'die kills the view', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.die()\n      equal true, view.isDead\n      equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n    test 'destroySubviews kills all subviews', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: superview)\n\n      superview.destroySubviews()\n      ok one.isDead\n      ok two.isDead\n\n\n## ::propagateToSubviews(eventOrKey : string, value : Object)\n\nIf `value` is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n    test 'propagateToSubviews propagates events', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.on 'eventName', superSpy = createSpy()\n      one.on 'eventName', oneSpy = createSpy()\n      two.on 'eventName', twoSpy = createSpy()\n\n      superview.propagateToSubviews('eventName')\n\n      equal 1, superSpy.callCount\n      equal 1, oneSpy.callCount\n      equal 1, twoSpy.callCount\n\n    test 'propagateToSubviews propagates keys', ->\n      superview = new Batman.View()\n      one = new Batman.View(superview: superview)\n      two = new Batman.View(superview: one)\n\n      superview.propagateToSubviews('key', 'value')\n\n      equal superview.get('key'), 'value'\n      equal one.get('key'), 'value'\n      equal two.get('key'), 'value'\n\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"64941bc25e6699bae2d42a71b297aa143b580066","subject":"Refactoring dasherize. Adding initial support for css plugin encapsulation","message":"Refactoring dasherize. Adding initial support for css plugin encapsulation\n","repos":"ojjs\/oj","old_file":"src\/oj.litcoffee","new_file":"src\/oj.litcoffee","new_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = module.exports = ->\n      # Prevent oj method from propagating\n      oj._argumentsPush()\n      ojml = oj.emit.apply @, arguments\n      oj._argumentsPop()\n      ojml\n\nEmit arguments as if it was an oj tag function\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\nKeep a reference to ourselves for templates to see\n\n    oj.oj = oj\n\noj.begin\n-------------------------------------------------------------------------------\n\n    oj.begin = (page) ->\n\n  Defer dom manipulation until the page has loaded\n\n      _readyOrLoad ->\n\n  Compile only the body and below\n\n        bodyOnly = html:1, doctype:1, head:1, link:1, script:1\n        {dom,types} = oj.compile dom:1, html:0, css:0, ignore:bodyOnly, (require page)\n\n        if not dom?\n          console.error 'oj: dom failed to compile'\n          return\n\n  Find body element\n\n        body = document.getElementsByTagName 'body'\n        if body.length == 0\n          console.error 'oj: <body> was not found'\n          return\n        body = body[0]\n\n  Clear body and insert dom elements\n\n        body.innerHTML = ''\n        if not oj.isArray dom\n          dom = [dom]\n        for d in dom\n          body.appendChild d\n\n  Trigger inserted event for types\n\n        for t in types\n          t.inserted()\n\n  Trigger events bound through oj.ready\n\n        oj.ready()\n\n_readyOrLoad\n-------------------------------------------------------------------------------\nHelper method that loads with either ready or onload (whichever exists)\n\n    _readyOrLoad = (fn) ->\n\n  Use jquery ready if it exists\n\n      if jQuery?\n        jQuery fn\n\n  Use onload\n\n      else\n        # Add onload if it hasn't happened yet\n        if document.readyState != \"complete\"\n          prevOnLoad = window.onload\n          window.onload = ->\n            prevOnLoad?()\n            fn()\n\n  Call the function immediately if onload already happened\n\n        else\n          fn()\n      return\n\noj.ready\n-------------------------------------------------------------------------------\n\n    _readyQueue = queue:[], loaded:false\n    oj.ready = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _readyQueue.loaded = true\n        while (f = _readyQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _readyQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _readyQueue.queue.push f\n      return\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\n## oj.guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\n\nRegister require.extension for .oj files in node\n-------------------------------------------------------------------------------\n\nTODO: Consider moving this to server.litcoffee\nTODO: Compile.ojlc files as literate coffee-script\n\n    if require.extensions\n\n      coffee = require 'coffee-script'\n\n      stripBOM = (c) -> if c.charCodeAt(0) == 0xFEFF then (c.slice 1) else c\n\n      wrapJS = (code) ->\n        \"(function(){with(oj.sandbox){#{code}}}).call(this);\"\n\n      wrapCSMessage = (message, filepath) ->\n        \"#{oj.codes?.red}coffee-script error in #{filepath}: #{message}#{oj.codes?.reset}\"\n      wrapJSMessage = (message, filepath) ->\n        \"#{oj.codes?.red}javascript error in #{filepath}: #{message}#{oj.codes?.reset}\"\n\n      compileJS = (module, code, filepath) ->\n        code = wrapJS code\n        global.oj = oj\n        module._compile code, filepath\n        delete global.oj\n\n  Compile .oj files as javascript\n\n      require.extensions['.oj'] = (module, filepath) ->\n        code = stripBOM fs.readFileSync filepath, 'utf8'\n        try\n          compileJS module, code, filepath\n        catch eJS\n          eJS.message = wrapJSMessage eJS.message, filepath\n          throw eJS\n\n  Compile .ojc files as coffee-script\n\n      require.extensions['.ojc'] = (module, filepath) ->\n        code = stripBOM fs.readFileSync filepath, 'utf8'\n\n        # Compile in coffee-script\n        try\n          code = coffee.compile code, bare: true\n        catch eCoffee\n          eCoffee.message = wrapCSMessage eCoffee.message, filepath\n          throw eCoffee\n\n        # Compile javascript\n        try\n          compileJS module, code, filepath\n\n        catch eJS\n          eJS.message = wrapJSMessage eJS.message, filepath\n          throw eJS\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.0.14'\n\n  Detect if this is the client or server\n\n    oj.isClient = not process?.versions?.node\n\n  Export as a module in NodeJS\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in NodeJS\n\n    else\n      root['oj'] = oj\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility: Helpers\n------------------------------------------------------------------------------\n\n    oj.__ = _ = {}\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      # TODO: support cloning OJ instances\n      # TODO: support options, deep: true\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nUtility: Iteration\n------------------------------------------------------------------------\n\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n  _splitAndTrim\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n------------------------------------------------------------------------------\n\n    _dasherize = (str) ->\n\n      out\n\nPath Helpers\n------------------------------------------------------------------------------\nA simplified form of  github.com\/joyent\/node\/lib\/path.js\n\n    pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n\n      parts\n\n    pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    pathSplit = (filename) ->\n      result = pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n\n      # Normalize the path\n      path = pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n\n      if !path and !isAbsolute\n        path = '.'\n\n      if path and trailingSlash\n        path += '\/'\n\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = Array.prototype.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        # No dirname whatsoever\n        return '.'\n      if dir\n        # It has a dirname, strip trailing slash\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name) ->\n      obj = if oj.isClient then window[name] else global[name]\n      throw new Error(\"oj: #{name} dependency is missing\") unless oj.isDefined obj\n\nDepend on jQuery\n\n    oj.dependency 'jQuery'\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw 'oj.addProperty: string expected for second argument' unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw 'oj.isProperty: string expected for second argument' unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argumentsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argumentsStack = []\n\n  Result is top of the stack\n\n    oj._argumentsTop = ->\n      if _argumentsStack.length\n        _argumentsStack[_argumentsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argumentsPush = (args = []) ->\n      _argumentsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argumentsPop = ->\n      if _argumentsStack.length\n        return _argumentsStack.pop()\n      null\n\n  Append argument\n\n    oj._argumentsAppend = (arg) ->\n      top = oj._argumentsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, args...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from args by unioning all objects\n\n      attributes = {}\n      for arg in args\n\n  TODO: evaluate argument if necessary\n\n        if oj.isObject arg\n          _extend attributes, arg\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argumentsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n        else if oj.isFunction arg\n\n          len = oj._argumentsTop().length\n\n          # Call the argument it will auto append to oj._argumentsTop() which is ojml\n          r = arg()\n\n          # Use return value if oj._argumentsTop() weren't changed\n          if len == oj._argumentsTop().length and r?\n            oj._argumentsAppend r\n\n        else\n          oj._argumentsAppend arg\n\n  Pop to restore previous context\n\n      oj._argumentsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to\n\n      oj._argumentsAppend ojml\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n        oj[t] = -> oj.tag t, arguments...\n        # Remember the tag name\n        _setTagName oj[t], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = '<!DOCTYPE HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = '<!DOCTYPE html>'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\">'\n\n  Define possible arguments\n\n    doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\">'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\">'\n\n  Define the method\n\n    oj.doctype = (type = 5) ->\n      ojml = doctypes[type]\n\n  Emit as a tag would\n\n      oj._argumentsAppend ojml\n      ojml\n\noj.extend (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.extend = (context = root) ->\n      o = {}\n      for k,v of oj\n        if k[0] != '_'\n          o[k] = v\n      delete o.extend\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* debug - Keep all source including comments\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: true\n        css: true\n        cssMap: false\n        styles: false\n        debug: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css || options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      # Generate cssMap\n      if options.cssMap\n        cssMap = acc.css\n\n      # Generate css\n      if options.css\n        css = _cssFromObject acc.css, options.debug\n\n      # Generate HTML\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then _isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_dasherize\n-----------------------------------------------------------------------------\nConvert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n_decamelize\n-----------------------------------------------------------------------------\nConvert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n'@media query': 'rule': 'stylesMap'\n\nThis method is the heart of `_cssFromObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      _flattenCSSMap_ cssMap, flatMap, [''], ['']\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n  TODO: Refactor to use the same code as media queries\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_cssFromObject:\n-----------------------------------------------------------------------------\nConvert css selectors and rules to a string\n\nSupports nested objections, comma seperated rules, and @media queries\n\ndebug:true will output newlines\n\n    _cssFromObject = (cssMap, debug = 0) ->\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n      flatMap = _flattenCSSMap cssMap\n\n      css = ''\n      for media, selectorMap of flatMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if debug and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if debug then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += \"#{rules}#{indent}}#{newline}\"\n\n  End media query\n\n        if media != ''\n          css += \"}#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        when 'jquery'\n          # TODO: Missing unit tests for the jquery case\n          options.html?.push ojml.html()\n          options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML()\n            options.dom?.appendChild ojml.toDOM()\n            if options.css?\n              _extend options.css, ojml.toCSSMap()\n\n      return\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Compile ojml tag (an array)\n    _compileTag = (ojml, options) ->\n\n      # Empty list compiles to nothing\n      return if ojml.length == 0\n\n      # Get tag\n      tag = ojml[0]\n      tagType = typeof tag\n\n      # Allow ojml's tag parameter to be 'table' or table or Table\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n\n      # Fail if we couldn't find a string by now\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n      # Create oj object if tag is capitalized\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n      # Record tag\n      options.tags[tag] = true\n\n      # Get attributes (optional)\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n      # Remaining arguments are children of this tag\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n      # Compile to css if requested\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css[selector] ?= styles\n          _extend options.css[selector], styles\n\n      # Compile to html if requested\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n\n      # Compile your children if necessary\n      for child in children\n        # Skip intention if there is only one child\n        if options.debug && children.length > 1\n          options.html?.push \"\\n\\t#{options.indent}\"\n        _compileDeeper _compileAny, child, options\n\n      # Skip intention if there is only one child\n      if options.debug && children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n      # End html tag if you have children or your tag closes\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Allow attributes to take class as an array of strings\n    _attributeClassAllowsArrays = (attr) ->\n      if oj.isArray attr?.class\n        attr.class = attr.join ' '\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # TODO: Consider jsoning anything that isn't a string\n      # any keys that aren't strings are jsoned\n      # _attributesJSONAllKeys attributes\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if $?\n          if oj.isArray ev\n            $(el)[ek].apply @, ev\n          else\n            $(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\n    # oj.toHTML\n    # ------------------------------------------------------------------------------\n    # Make oj directly to HTML. It will ignore all event bindings\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options,\n        dom: false\n        js: false\n        html: true\n        css: false\n\n      (oj.compile options, ojml).html\n\n    # oj.toCSS\n    # ------------------------------------------------------------------------------\n    # Make oj directly to css. It will ignore all event bindings and html\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options,\n        dom: false\n        js: false\n        html: false\n        css: true\n\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.type\n------------------------------------------------------------------------------\n\n    oj.type = (name, args = {}) ->\n      throw 'oj.type: string expected for first argument' unless oj.isString name\n      throw 'oj.type: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        # TODO: Make this O(1)\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        # TODO: Make this O(1)\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # argumentsUnion:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.argumentsUnion = (argList) ->\n      obj = {}\n      list = []\n      for v in argList\n        if oj.isObject v\n          obj = _extend obj, v\n        else\n          list.push v\n      options: obj, args: list\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.type 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el, cssMap:@cssMap} = oj.compile css:0, cssMap:1, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = $ @el)\n\n        # Get all attributes (readonly)\n        attributes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get and set id of view from attribute\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # CSS generated for this instance\n        cssMap:\n          get: -> @_cssMap ? {}\n          set: (v) ->\n            @_cssMap = v\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n\n              # Wrap k in quotes if it has whitespace\n              if k == 'class'\n                @$el.addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argumentsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.debug then '\\n' else '')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (debug) -> _cssFromObject @cssMap, debug\n\n        # Convert\n        toCSSMap: -> @cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n    oj.View.css = (def) ->\n      oj.View.styles.push _setObject {}, \".oj-#{@typeName}\", def\n      return\n\n    oj.View.theme = (name, def) ->\n      def = _setObject {}, \".oj-#{@typeName}.theme-#{_dasherize name}\", def\n      @type.themes.push _setObject {}, (_dasherize name), def\n      @type.styles.push def\n      return\n\n    oj.View.styles = []\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.type 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionAdded, @\n              @_models.on 'remove', @collectionRemoved, @\n              @_models.on 'change', @collectionChanged, @\n              @_models.on 'reset', @collectionReset, @\n              @_models.on 'destroy', @collectionDestroyed, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionAdded: (model, collection) -> @make()\n        collectionRemoved: (model, collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n        collectionChanged: (model, collection, options) -> # Do nothing\n        collectionDestroyed: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.type 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.type 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.type 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.type 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.type 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.textarea\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.type 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.type 'Button',\n      base: oj.View\n\n      constructor: (args) ->\n        {options, args} = oj.argumentsUnion arguments\n\n        # Label is first argument\n        options.label ?= if args.length > 0 then args[0] else ''\n\n        @el = oj =>\n          oj.button options.label\n\n        oj.Button.base.constructor.apply @, [options]\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.type 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionAdded: Model add occurred, add the item\n\n        collectionAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionRemoved: Model remove occured, delete the item\n\n        collectionRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.type 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.type 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.type 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> console.log \"clearing body: oj.litcoffee:2930\";@$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get $(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set $(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\njquery.oj\n-----------------------------------------------------------------------------\n\n    jQuery.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types} = oj.compile {dom:1,html:0,css:0}, args...\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        for d in dom\n          $el.append d\n\n        # Call inserted event on all types\n        for t in types\n          t.inserted()\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njquery.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    jQuery.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njquery.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    jQuery.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njquery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        jQuery.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types} = oj.compile {dom:1,html:0}, args...\n\n            # Append to the dom\n            $el[jqName] dom\n\n            for t in types\n              t.inserted()\n\n            return\n\n          get:null\n\n\n\n\n\n","old_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = module.exports = ->\n      # Prevent oj method from propagating\n      oj._argumentsPush()\n      ojml = oj.emit.apply @, arguments\n      oj._argumentsPop()\n      ojml\n\nEmit arguments as if it was an oj tag function\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\nKeep a reference to ourselves for templates to see\n\n    oj.oj = oj\n\noj.begin\n-------------------------------------------------------------------------------\n\n    oj.begin = (page) ->\n\n  Defer dom manipulation until the page has loaded\n\n      _readyOrLoad ->\n\n  Compile only the body and below\n\n        bodyOnly = html:1, doctype:1, head:1, link:1, script:1\n        {dom,types} = oj.compile dom:1, html:0, css:0, ignore:bodyOnly, (require page)\n\n        if not dom?\n          console.error 'oj: dom failed to compile'\n          return\n\n  Find body element\n\n        body = document.getElementsByTagName 'body'\n        if body.length == 0\n          console.error 'oj: <body> was not found'\n          return\n        body = body[0]\n\n  Clear body and insert dom elements\n\n        body.innerHTML = ''\n        if not oj.isArray dom\n          dom = [dom]\n        for d in dom\n          body.appendChild d\n\n  Trigger inserted event for types\n\n        for t in types\n          t.inserted()\n\n  Trigger events bound through oj.ready\n\n        oj.ready()\n\n_readyOrLoad\n-------------------------------------------------------------------------------\nHelper method that loads with either ready or onload (whichever exists)\n\n    _readyOrLoad = (fn) ->\n\n  Use jquery ready if it exists\n\n      if jQuery?\n        jQuery fn\n\n  Use onload\n\n      else\n        # Add onload if it hasn't happened yet\n        if document.readyState != \"complete\"\n          prevOnLoad = window.onload\n          window.onload = ->\n            prevOnLoad?()\n            fn()\n\n  Call the function immediately if onload already happened\n\n        else\n          fn()\n      return\n\noj.ready\n-------------------------------------------------------------------------------\n\n    _readyQueue = queue:[], loaded:false\n    oj.ready = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _readyQueue.loaded = true\n        while (f = _readyQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _readyQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _readyQueue.queue.push f\n      return\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\n## oj.guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\n\nRegister require.extension for .oj files in node\n-------------------------------------------------------------------------------\n\nTODO: Consider moving this to server.litcoffee\nTODO: Compile.ojlc files as literate coffee-script\n\n    if require.extensions\n\n      coffee = require 'coffee-script'\n\n      stripBOM = (c) -> if c.charCodeAt(0) == 0xFEFF then (c.slice 1) else c\n\n      wrapJS = (code) ->\n        \"(function(){with(oj.sandbox){#{code}}}).call(this);\"\n\n      wrapCSMessage = (message, filepath) ->\n        \"#{oj.codes?.red}coffee-script error in #{filepath}: #{message}#{oj.codes?.reset}\"\n      wrapJSMessage = (message, filepath) ->\n        \"#{oj.codes?.red}javascript error in #{filepath}: #{message}#{oj.codes?.reset}\"\n\n      compileJS = (module, code, filepath) ->\n        code = wrapJS code\n        global.oj = oj\n        module._compile code, filepath\n        delete global.oj\n\n  Compile .oj files as javascript\n\n      require.extensions['.oj'] = (module, filepath) ->\n        code = stripBOM fs.readFileSync filepath, 'utf8'\n        try\n          compileJS module, code, filepath\n        catch eJS\n          eJS.message = wrapJSMessage eJS.message, filepath\n          throw eJS\n\n  Compile .ojc files as coffee-script\n\n      require.extensions['.ojc'] = (module, filepath) ->\n        code = stripBOM fs.readFileSync filepath, 'utf8'\n\n        # Compile in coffee-script\n        try\n          code = coffee.compile code, bare: true\n        catch eCoffee\n          eCoffee.message = wrapCSMessage eCoffee.message, filepath\n          throw eCoffee\n\n        # Compile javascript\n        try\n          compileJS module, code, filepath\n\n        catch eJS\n          eJS.message = wrapJSMessage eJS.message, filepath\n          throw eJS\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.0.14'\n\n  Detect if this is the client or server\n\n    oj.isClient = not process?.versions?.node\n\n  Export as a module in NodeJS\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in NodeJS\n\n    else\n      root['oj'] = oj\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility: Helpers\n------------------------------------------------------------------------------\n\n    oj.__ = _ = {}\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      # TODO: support cloning OJ instances\n      # TODO: support options, deep: true\n      return obj unless oj.isObject obj\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nUtility: Iteration\n------------------------------------------------------------------------\n\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n  _splitAndTrim\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nPath Helpers\n------------------------------------------------------------------------------\nA simplified form of  github.com\/joyent\/node\/lib\/path.js\n\n    pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n\n      parts\n\n    pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    pathSplit = (filename) ->\n      result = pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n\n      # Normalize the path\n      path = pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n\n      if !path and !isAbsolute\n        path = '.'\n\n      if path and trailingSlash\n        path += '\/'\n\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = Array.prototype.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        # No dirname whatsoever\n        return '.'\n      if dir\n        # It has a dirname, strip trailing slash\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name) ->\n      obj = if oj.isClient then window[name] else global[name]\n      throw new Error(\"oj: #{name} dependency is missing\") unless oj.isDefined obj\n\nDepend on jQuery\n\n    oj.dependency 'jQuery'\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw 'oj.addProperty: string expected for second argument' unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw 'oj.isProperty: string expected for second argument' unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      Object.defineProperty dest, propName, info\n\n_argumentsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argumentsStack = []\n\n  Result is top of the stack\n\n    oj._argumentsTop = ->\n      if _argumentsStack.length\n        _argumentsStack[_argumentsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argumentsPush = (args = []) ->\n      _argumentsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argumentsPop = ->\n      if _argumentsStack.length\n        return _argumentsStack.pop()\n      null\n\n  Append argument\n\n    oj._argumentsAppend = (arg) ->\n      top = oj._argumentsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, args...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from args by unioning all objects\n\n      attributes = {}\n      for arg in args\n\n  TODO: evaluate argument if necessary\n\n        if oj.isObject arg\n          _extend attributes, arg\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argumentsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n        else if oj.isFunction arg\n\n          len = oj._argumentsTop().length\n\n          # Call the argument it will auto append to oj._argumentsTop() which is ojml\n          r = arg()\n\n          # Use return value if oj._argumentsTop() weren't changed\n          if len == oj._argumentsTop().length and r?\n            oj._argumentsAppend r\n\n        else\n          oj._argumentsAppend arg\n\n  Pop to restore previous context\n\n      oj._argumentsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to\n\n      oj._argumentsAppend ojml\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n        oj[t] = -> oj.tag t, arguments...\n        # Remember the tag name\n        _setTagName oj[t], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = '<!DOCTYPE HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = '<!DOCTYPE html>'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\">'\n\n  Define possible arguments\n\n    doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\">'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\">'\n\n  Define the method\n\n    oj.doctype = (type = 5) ->\n      ojml = doctypes[type]\n\n  Emit as a tag would\n\n      oj._argumentsAppend ojml\n      ojml\n\noj.extend (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.extend = (context = root) ->\n      o = {}\n      for k,v of oj\n        if k[0] != '_'\n          o[k] = v\n      delete o.extend\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* debug - Keep all source including comments\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: true\n        css: true\n        cssMap: false\n        debug: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css || options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      # Generate cssMap\n      if options.cssMap\n        cssMap = acc.css\n\n      # Generate css\n      if options.css\n        css = _cssFromObject acc.css, options.debug\n\n      # Generate HTML\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then _isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_styleKeyFromCamalCase\n-----------------------------------------------------------------------------\nConvert style keys from oj camal case to css default\n\n    _styleKeyFromCamalCase = (key) ->\n      out = \"\"\n      # Loop over characters in key looking for camal case\n      for c in key\n        if _isCapitalLetter c\n          out += \"-#{c.toLowerCase()}\"\n        else\n          out += c\n      out\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _styleKeyFromCamalCase kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n'@media query': 'rule': 'stylesMap'\n\nThis method is the heart of `_cssFromObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      _flattenCSSMap_ cssMap, flatMap, [''], ['']\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n  TODO: Refactor to use the same code as media queries\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_cssFromObject:\n-----------------------------------------------------------------------------\nConvert css selectors and rules to a string\n\nSupports nested objections, comma seperated rules, and @media queries\n\ndebug:true will output newlines\n\n    _cssFromObject = (cssMap, debug = 0) ->\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n      flatMap = _flattenCSSMap cssMap\n\n      css = ''\n      for media, selectorMap of flatMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if debug and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if debug then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += \"#{rules}#{indent}}#{newline}\"\n\n  End media query\n\n        if media != ''\n          css += \"}#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        when 'jquery'\n          # TODO: Missing unit tests for the jquery case\n          options.html?.push ojml.html()\n          options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML()\n            options.dom?.appendChild ojml.toDOM()\n            if options.css?\n              _extend options.css, ojml.toCSSMap()\n\n      return\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Compile ojml tag (an array)\n    _compileTag = (ojml, options) ->\n\n      # Empty list compiles to nothing\n      return if ojml.length == 0\n\n      # Get tag\n      tag = ojml[0]\n      tagType = typeof tag\n\n      # Allow ojml's tag parameter to be 'table' or table or Table\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n\n      # Fail if we couldn't find a string by now\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n      # Create oj object if tag is capitalized\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n      # Record tag\n      options.tags[tag] = true\n\n      # Get attributes (optional)\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n      # Remaining arguments are children of this tag\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n      # Compile to css if requested\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css[selector] ?= styles\n          _extend options.css[selector], styles\n\n      # Compile to html if requested\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n\n      # Compile your children if necessary\n      for child in children\n        # Skip intention if there is only one child\n        if options.debug && children.length > 1\n          options.html?.push \"\\n\\t#{options.indent}\"\n        _compileDeeper _compileAny, child, options\n\n      # Skip intention if there is only one child\n      if options.debug && children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n      # End html tag if you have children or your tag closes\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if attr?.c? and oj.isArray(attr.c)\n        attr.c = attr.c.join ' '\n      if attr?.class? and oj.isArray(attr.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Allow attributes to take class as an array of strings\n    _attributeClassAllowsArrays = (attr) ->\n      if oj.isArray attr?.class\n        attr.class = attr.join ' '\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # TODO: Consider jsoning anything that isn't a string\n      # any keys that aren't strings are jsoned\n      # _attributesJSONAllKeys attributes\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if $?\n          if oj.isArray ev\n            $(el)[ek].apply @, ev\n          else\n            $(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\n    # oj.toHTML\n    # ------------------------------------------------------------------------------\n    # Make oj directly to HTML. It will ignore all event bindings\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options,\n        dom: false\n        js: false\n        html: true\n        css: false\n\n      (oj.compile options, ojml).html\n\n    # oj.toCSS\n    # ------------------------------------------------------------------------------\n    # Make oj directly to css. It will ignore all event bindings and html\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options,\n        dom: false\n        js: false\n        html: false\n        css: true\n\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.type\n------------------------------------------------------------------------------\n\n    oj.type = (name, args = {}) ->\n      throw 'oj.type: string expected for first argument' unless oj.isString name\n      throw 'oj.type: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        # TODO: Make this O(1)\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        # TODO: Make this O(1)\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # argumentsUnion:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.argumentsUnion = (argList) ->\n      obj = {}\n      list = []\n      for v in argList\n        if oj.isObject v\n          obj = _extend obj, v\n        else\n          list.push v\n      options: obj, args: list\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.type 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el, cssMap:@cssMap} = oj.compile css:0, cssMap:1, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = $ @el)\n\n        # Get all attributes (readonly)\n        attributes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get and set id of view from attribute\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # CSS generated for this instance\n        cssMap:\n          get: -> @_cssMap ? {}\n          set: (v) ->\n            @_cssMap = v\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n\n              # Wrap k in quotes if it has whitespace\n              if k == 'class'\n                @$el.addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argumentsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.debug then '\\n' else '')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (debug) -> _cssFromObject @cssMap, debug\n\n        # Convert\n        toCSSMap: -> @cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.type 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionAdded, @\n              @_models.on 'remove', @collectionRemoved, @\n              @_models.on 'change', @collectionChanged, @\n              @_models.on 'reset', @collectionReset, @\n              @_models.on 'destroy', @collectionDestroyed, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionAdded: (model, collection) -> @make()\n        collectionRemoved: (model, collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n        collectionChanged: (model, collection, options) -> # Do nothing\n        collectionDestroyed: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.type 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.type 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.type 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.type 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.type 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.textarea\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.type 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.type 'Button',\n      base: oj.View\n\n      constructor: (args) ->\n        {options, args} = oj.argumentsUnion arguments\n\n        # Label is first argument\n        options.label ?= if args.length > 0 then args[0] else ''\n\n        @el = oj =>\n          oj.button options.label\n\n        oj.Button.base.constructor.apply @, [options]\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.type 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionAdded: Model add occurred, add the item\n\n        collectionAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionRemoved: Model remove occured, delete the item\n\n        collectionRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.type 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.type 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.type 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> console.log \"clearing body: oj.litcoffee:2930\";@$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get $(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set $(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\njquery.oj\n-----------------------------------------------------------------------------\n\n    jQuery.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types} = oj.compile {dom:1,html:0,css:0}, args...\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        for d in dom\n          $el.append d\n\n        # Call inserted event on all types\n        for t in types\n          t.inserted()\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njquery.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    jQuery.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njquery.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    jQuery.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njquery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        jQuery.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types} = oj.compile {dom:1,html:0}, args...\n\n            # Append to the dom\n            $el[jqName] dom\n\n            for t in types\n              t.inserted()\n\n            return\n\n          get:null\n\n\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f526688459ca20476db0e1b2743bdd9d1e968f89","subject":"Literate CofeeScript underway","message":"Literate CofeeScript underway\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\n\n\n  # Non-determinism\n  # ---------------\n\n  F.succeed = (result) -> [result]\n  F.fail = _.always []\n\n  disjunction = (l, r) ->\n    (x) -> _.cat(l(x), r(x))\n  conjunction = (l, r) ->\n    (x) -> _.mapcat(l(x), r)\n\n  F.disj = () ->\n    return F.fail if _.isEmpty(arguments)\n    disjunction(_.first(arguments), F.disj.apply(this, _.rest(arguments)))\n\n  F.conj = () ->\n    clauses = _.toArray(arguments)\n    return F.succeed if _.isEmpty(clauses)\n    return _.first(clauses) if _.size(clauses) is 1\n    conjunction(_.first(clauses),\n                (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\n  # Knowledge representation\n  # ------------------------\n\n  class LVar\n    constructor: (@name) ->\n\n  F.lvar = (name) -> new LVar(name)\n  F.isLVar = (v) -> (v instanceof LVar)\n\n  find = (v, bindings) ->\n    lvar = bindings.lookup(v)\n    return lvar if F.isLVar(v)\n    if _.isArray(lvar)\n      if _.isEmpty(lvar)\n        return lvar\n      else\n        return _.cons(find(_.first(lvar), bindings), find(_.rest(lvar), bindings))\n    lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","old_contents":"((root) ->\n  root = this\n  _ = root._ || require 'underscore'\n  F = {}\n\n  # Non-determinism\n  # ---------------\n\n  F.succeed = (result) -> [result]\n  F.fail = _.always []\n\n  disjunction = (l, r) ->\n    (x) -> _.cat(l(x), r(x))\n  conjunction = (l, r) ->\n    (x) -> _.mapcat(l(x), r)\n\n  F.disj = () ->\n    return F.fail if _.isEmpty(arguments)\n    disjunction(_.first(arguments), F.disj.apply(this, _.rest(arguments)))\n\n  F.conj = () ->\n    clauses = _.toArray(arguments)\n    return F.succeed if _.isEmpty(clauses)\n    return _.first(clauses) if _.size(clauses) is 1\n    conjunction(_.first(clauses),\n                (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\n  # Knowledge representation\n  # ------------------------\n\n  class LVar\n    constructor: (@name) ->\n\n  F.lvar = (name) -> new LVar(name)\n  F.isLVar = (v) -> (v instanceof LVar)\n\n  find = (v, bindings) ->\n    lvar = bindings.lookup(v)\n    return lvar if F.isLVar(v)\n    if _.isArray(lvar)\n      if _.isEmpty(lvar)\n        return lvar\n      else\n        return _.cons(find(_.first(lvar), bindings), find(_.rest(lvar), bindings))\n    lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d4cdd0c02505226b594bfb7d3cdec1922e379944","subject":"Fix missing log in console.log","message":"Fix missing log in console.log\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.methodOverride())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n    app.use(raven.middleware.express(process.env.SENTRY_DNS)) if process.env.SENTRY_DNS\n\n### Error handling\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n### API keys\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'DNT'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone about the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        when 'PUT'  then collection.put req, res, next\n        when 'PATCH' then collection.patch req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then document.options req, res, next\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.methodOverride())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n    app.use(raven.middleware.express(process.env.SENTRY_DNS)) if process.env.SENTRY_DNS\n\n### Error handling\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n### API keys\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'DNT'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone about the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        when 'PUT'  then collection.put req, res, next\n        when 'PATCH' then collection.patch req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then document.options req, res, next\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"12e0e44399c792289cc162d07e3c20e232ed5dbb","subject":"better index","message":"better index\n","repos":"nhz-io\/cnl","old_file":"source\/lib\/index.litcoffee","new_file":"source\/lib\/index.litcoffee","new_contents":"# Namespace: lib\n\n    module.exports =\n      Base      : require '.\/base'\n      Event     : require '.\/event'\n      Node      : require '.\/node'\n      Evented   : require '.\/evented'\n      Element   : require '.\/element'\n      Shape     : require '.\/shape'\n      Component : require '.\/component'\n      Pen       : require '.\/pen'\n      Style     : require '.\/style'\n\n## Exports\n\n* [lib.Base][Base] - All classes extend this.\n\n* [lib.Event][Event] - Light Event\n\n* [lib.Node][Node] - Parent-Child Aggregation\n\n* [lib.Evented][Evented] - Event Subsytem\n\n* [lib.Element][Element] - Visual Element\n\n* [lib.Shape][Shape] - Drawable Shape\n\n* [lib.Component][Component] - Dragable Component\n\n* [lib.Style][Style] - Element Style\n\n* [lib.Pen][Pen] - Common ancestor for pens\n\n[Base]: .\/base.litcoffee\n[Event]: .\/event.litcoffee\n[Node]: .\/node.litcoffee\n[Evented]: .\/evented.litcoffee\n[Element]: .\/element.litcoffee\n[Shape]: .\/shape.litcoffee\n[Component]: .\/component.litcoffee\n[Style]: .\/style.litcoffee\n[Pen]: .\/pen.litcoffee\n","old_contents":"# Namespace: lib\n\n## Exports\n\n    module.exports =\n\n* [lib.Base][Base]\n\nAll classes extend this.\n\n      Base      : require '.\/base'\n\n* [lib.Event][Event]\n\nLight Event \n\n      Event     : require '.\/event'\n\n* [lib.Node][Node]\n\nParent-Child Aggregation\n\n      Node      : require '.\/node'\n\n* [lib.Evented][Evented]\n\nEvent Subsytem\n\n      Evented   : require '.\/evented'\n  \n* [lib.Element][Element]\n\nVisual Element\n\n      Element   : require '.\/element'\n\n* [lib.Shape][Shape]\n\nDrawable Shape\n\n      Shape     : require '.\/shape'\n\n* [lib.Component][Component]\n\nDragable Component\n\n      Component : require '.\/component'\n\n* [lib.Style][Style]\n\nElement Style\n      Style     : require '.\/style'\n\n* [lib.Pen][Pen]\n\nCommon ancestor for pens\n\n      Pen       : require '.\/pen'\n\n\n[Base]: .\/base.litcoffee\n[Event]: .\/event.litcoffee\n[Node]: .\/node.litcoffee\n[Evented]: .\/evented.litcoffee\n[Element]: .\/element.litcoffee\n[Shape]: .\/shape.litcoffee\n[Component]: .\/component.litcoffee\n[Style]: .\/style.litcoffee\n[Pen]: .\/pen.litcoffee\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"65ea469ab5f64d01b2b2471e06ceb05fbfba3d29","subject":"Enable source maps with coffee-script.","message":"Enable source maps with coffee-script.\n","repos":"monokrome\/glp","old_file":"src\/defaults.litcoffee","new_file":"src\/defaults.litcoffee","new_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How GLP configuration works\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp,watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is false by default, but can be made true if caching\nhappens to be working as expected with your project. This feature is disabled\nby default because it is still experimental.\n\n        enabled: no\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nWe'll also want source maps, so let's enabled those.\n\n        coffee:\n          sourceMap: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js` or `.coffee`. After\nthey are built, the resulting files will be placed in the directory specified\nby the **root** function as separate files. If the output file was not a\n**directory** (as denoted by the ending slash) then the files would also be\nconcatenated and the resulting file would be given the *extension* which\ncorresponds to this type of file.\n\n          '\/': [\n            'src\/**\/*.js'\n            'src\/**\/*.coffee'\n          ]\n\nHere, we are doing the same thing for *html* and *jade* files, but we are\noutputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/**\/*.html'\n            'src\/**\/*.jade'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/': [\n            'src\/**\/*.css'\n            'src\/**\/*.less'\n            'src\/**\/*.sass'\n            'src\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            coffee:\n              sourceMap: no\n\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","old_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How GLP configuration works\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp,watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is false by default, but can be made true if caching\nhappens to be working as expected with your project. This feature is disabled\nby default because it is still experimental.\n\n        enabled: no\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js` or `.coffee`. After\nthey are built, the resulting files will be placed in the directory specified\nby the **root** function as separate files. If the output file was not a\n**directory** (as denoted by the ending slash) then the files would also be\nconcatenated and the resulting file would be given the *extension* which\ncorresponds to this type of file.\n\n          '\/': [\n            'src\/**\/*.js'\n            'src\/**\/*.coffee'\n          ]\n\nHere, we are doing the same thing for *html* and *jade* files, but we are\noutputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/**\/*.html'\n            'src\/**\/*.jade'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/': [\n            'src\/**\/*.css'\n            'src\/**\/*.less'\n            'src\/**\/*.sass'\n            'src\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"eef134ffc2314cb8139bdea40b45d983530959cc","subject":"markup void fix","message":"markup void fix\n","repos":"vpj\/weya,vpj\/weya","old_file":"weya.litcoffee","new_file":"weya.litcoffee","new_contents":"Gist of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setData = (elem, data) ->\n      for k, v of data\n       elem[k] = v\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        when 'data' then setData elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       if elem.classList?\n        for c in idClass.class\n         elem.classList.add c\n       else #For older browsers; does not work with svgs\n        className = ''\n        for c in idClass.class\n         className += ' ' if className isnt ''\n         className += \"#{c}\"\n        elem.className = className\n\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setData = (buf, data) ->\n      for k, v of data\n       buf.push \" data-#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        when 'data' then setData buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, isVoid, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        cssClass = ''\n        cssClass += \"#{c} \" for c in params.idClass.class\n        buf.push \" class=\\\"#{cssClass}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      if isVoid\n       buf.push \"\/>\\n\"\n       if params.func? or params.text?\n        throw new Error 'Void tags cannot have content'\n\n      else\n       buf.push \">\\n\"\n       @_indent++\n\n       if params.func?\n        params.func.call this\n       else if params.text?\n        setIndent buf, @_indent\n        buf.push params.text\n        buf.push \"\\n\"\n\n       @_indent--\n       setIndent buf, @_indent\n       buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name, isVoid) ->\n      ->\n       append.call this, ns, name, isVoid, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name, false\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name, false\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name, true\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","old_contents":"Gist of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setData = (elem, data) ->\n      for k, v of data\n       elem[k] = v\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        when 'data' then setData elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       if elem.classList?\n        for c in idClass.class\n         elem.classList.add c\n       else #For older browsers; does not work with svgs\n        className = ''\n        for c in idClass.class\n         className += ' ' if className isnt ''\n         className += \"#{c}\"\n        elem.className = className\n\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setData = (buf, data) ->\n      for k, v of data\n       buf.push \" data-#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        when 'data' then setData buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        cssClass = ''\n        cssClass += \"#{c} \" for c in params.idClass.class\n        buf.push \" class=\\\"#{cssClass}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       setIndent buf, @_indent\n       buf.push params.text\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"492bbd4d9b6e7cb4ccf8144655da448455089f17","subject":"update docs","message":"update docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e3c726c8ca6c70dff7a81a36185a286cb7aa3333","subject":"cyclomatic complexity","message":"cyclomatic complexity\n","repos":"vpj\/weya,vpj\/weya","old_file":"weya.litcoffee","new_file":"weya.litcoffee","new_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       if params.idClass.id?\n        elem.id = params.idClass.id\n       if params.idClass.class?\n        if elem.classList?\n         for c in params.idClass.class\n          elem.classList.add c\n        else #For older browsers; does not work with svgs\n         className = ''\n         for c in params.idClass.class\n          className += ' ' if className isnt ''\n          className += \"#{c}\"\n         elem.className = className\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        buf.push \" class=\\\"#{params.idClass.class}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       setIndent buf, @_indent\n       buf.push params.text\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","old_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: []\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = [c]\n        else\n         res.class.push c\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        elem.id = idClass.id\n       if idClass.class?\n        if elem.classList?\n         for c in idClass.class\n          elem.classList.add c\n        else #For older browsers; does not work with svgs\n         className = ''\n         for c in idClass.class\n          className += ' ' if className isnt ''\n          className += \"#{c}\"\n         elem.className = className\n\n      if attrs?\n       setAttributes elem, attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if contentFunction?\n       contentFunction.call this\n      else if contentText?\n       elem.textContent = contentText\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: null\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = c\n        else\n         res.class += \" #{c}\"\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        buf.push \" id=\\\"#{idClass.id}\\\"\"\n       if idClass.class?\n        buf.push \" class=\\\"#{idClass.class}\\\"\"\n\n      if attrs?\n       setAttributes buf, attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if contentFunction?\n       contentFunction.call this\n      else if contentText?\n       setIndent buf, @_indent\n       buf.push contentText\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c065294d98c524f471f5d8a0e6a3f7f26480f243","subject":"Dissable server methodOverride","message":"Dissable server methodOverride\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n    app.use(raven.middleware.express(process.env.SENTRY_DNS)) if process.env.SENTRY_DNS\n\n### Error handling\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n### API keys\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'DNT'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone about the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        when 'PUT'  then collection.put req, res, next\n        when 'PATCH' then collection.patch req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then document.options req, res, next\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.methodOverride())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n    app.use(raven.middleware.express(process.env.SENTRY_DNS)) if process.env.SENTRY_DNS\n\n### Error handling\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n### API keys\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'DNT'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone about the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        when 'PUT'  then collection.put req, res, next\n        when 'PATCH' then collection.patch req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then document.options req, res, next\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ff0df0f6bd03ebb352bf04312c0ef7e3d4e0cf4c","subject":"Formatting","message":"Formatting\n","repos":"nswarr\/epiquery2-client","old_file":"src\/epi-client.litcoffee","new_file":"src\/epi-client.litcoffee","new_contents":"   EventEmitter      = require('events').EventEmitter\n    _                 = require 'underscore'\n    log               = require 'simplog'\n    AwesomeWebSocket  = require('awesome-websocket').AwesomeWebSocket\n\nEpiClient\n=========\nThis is the base client for communicating with epiquery2.\n\n    class EpiClient extends EventEmitter\n\nThe @url constructor argument can be either a singular string or an array of strings that represent the\nepiquery2 endpoint(s).\n\n      constructor: (@url) ->\n        @connect()\n\nUnder the hood, we're using the [AwesomeWebSocket](https:\/\/github.com\/glg\/awesome-websocket) to ensure auto-reconnect\non interruptions and endpoint hunting to find the fastest connection.\n\n      connect: =>\n        @ws = new AwesomeWebSocket(@url)\n        @queryId = 0\n        @ws.onmessage = @onMessage\n        @ws.onclose = @onClose\n        @ws.onopen = () ->\n          log.debug \"Epiclient connection opened\"\n        @ws.onerror = (err) ->\n          log.error \"EpiClient socket error: \", err\n\nThe **query** function kicks off the processing of a query.  While the function is called query, epiquery may actually be executing multiple queries against a data source.\n\n**connectionName** - The string key that maps to an epiquery2 named connection e.g. 'mysql', 'mssql', 'file'.  See more [here](https:\/\/github.com\/igroff\/epiquery2#configuration).\n**template** - The path to the template you're querying.  The path is relative to the root of the template directory defined in epiquery2.\n**data** - This is a just javascript object you can pass that contains any data you want to use in your epiquery template.\n**queryId** - A unique identifier used to refer to the query throughout it's Active period. It will be included with all messages generated during it's processing. It is the caller's responsibility to generate a unique id for each query requested.\n\n      query: (connectionName, template, data, queryId=null) =>\n        req =\n          templateName: template\n          connectionName: connectionName\n          data: data\n        req.queryId = null || queryId\n        req.closeOnEnd = data.closeOnEnd if data\n        # if someone has asked us to close on end, we want our fancy\n        # underlying reconnectint sockets to not reconnect\n        @ws.forceClose = req.closeOnEnd\n\n        log.debug \"executing query: #{template} data:#{JSON.stringify(data)}\"\n        @ws.send JSON.stringify(req)\n\n\nEchoes events returned from epiquery.\n\n      onMessage: (message) =>\n        # if the browser has wrapped this for use, we'll be interested in its\n        # 'data' element\n        message = message.data if message.type? and message.type = 'message'\n        message = JSON.parse(message) if typeof message is 'string'\n        handler = @['on' + message.message]\n        if handler\n          handler(message)\n\n      onClose: () =>\n        @emit 'close'\n\n## Events\nThey're all pretty self explanatory.  The messages provided to the events have the optional field **queryId** that corresponds to the  queryId that was provided to the **query** function.  Use that to track a particular request in the query's lifecycle.\n\nInvoked at the start of the query's lifecycle.  No query has occurred yet.\n\n      onbeginquery: (msg) => @emit 'beginquery', msg\n\nInvoked when a new row set is began.  Row sets are the result of executing a singular query.  For example, if you executed two SQL statements, each would be its own row set.\n\n      onbeginrowset: (msg) => @emit 'beginrowset', msg\n\nInvoked every time a row of data is returned from a row set.\n\n      onrow: (msg) => @emit 'row', msg\n\nInvoked at the end of a row set.\n\n      onendrowset: (msg) => @emit 'endrowset', msg\n\nInvoked at the end of the query's overall lifecycle.\n\n      onendquery: (msg) => @emit 'endquery', msg\n\nInvoked if an error is encountered while processing the query.\n\n      onerror: (msg) => @emit 'error', msg\n\n\n\n    module.exports = EpiClient","old_contents":"   EventEmitter      = require('events').EventEmitter\n    _                 = require 'underscore'\n    log               = require 'simplog'\n    AwesomeWebSocket  = require('awesome-websocket').AwesomeWebSocket\n\nEpiClient\n=========\nThis is the base client for communicating with epiquery2.\n\n    class EpiClient extends EventEmitter\n\nThe @url constructor argument can be either a singular string or an array of strings that represent the\nepiquery2 endpoint(s).\n\n      constructor: (@url) ->\n        @connect()\n\nUnder the hood, we're using the [AwesomeWebSocket](https:\/\/github.com\/glg\/awesome-websocket) to ensure auto-reconnect\non interruptions and endpoint hunting to find the fastest connection.\n\n      connect: =>\n        @ws = new AwesomeWebSocket(@url)\n        @queryId = 0\n        @ws.onmessage = @onMessage\n        @ws.onclose = @onClose\n        @ws.onopen = () ->\n          log.debug \"Epiclient connection opened\"\n        @ws.onerror = (err) ->\n          log.error \"EpiClient socket error: \", err\n\nThe **query** function kicks off the processing of a query.  While the function is called query, epiquery may actually be executing multiple queries against a data source.\n\n**connectionName** - The string key that maps to an epiquery2 named connection e.g. 'mysql', 'mssql', 'file'.  See more [here](https:\/\/github.com\/igroff\/epiquery2#configuration).\n**template** - The path to the template you're querying.  The path is relative to the root of the template directory defined in epiquery2.\n**data** - This is a just javascript object you can pass that contains any data you want to use in your epiquery template.\n**queryId** - A unique identifier used to refer to the query throughout it's Active period. It will be included with all messages generated during it's processing. It is the caller's responsibility to generate a unique id for each query requested.\n\n      query: (connectionName, template, data, queryId=null) =>\n        req =\n          templateName: template\n          connectionName: connectionName\n          data: data\n        req.queryId = null || queryId\n        req.closeOnEnd = data.closeOnEnd if data\n        # if someone has asked us to close on end, we want our fancy\n        # underlying reconnectint sockets to not reconnect\n        @ws.forceClose = req.closeOnEnd\n\n        log.debug \"executing query: #{template} data:#{JSON.stringify(data)}\"\n        @ws.send JSON.stringify(req)\n\n\nEchoes events returned from epiquery.\n\n      onMessage: (message) =>\n        # if the browser has wrapped this for use, we'll be interested in its\n        # 'data' element\n        message = message.data if message.type? and message.type = 'message'\n        message = JSON.parse(message) if typeof message is 'string'\n        handler = @['on' + message.message]\n        if handler\n          handler(message)\n\n      onClose: () =>\n        @emit 'close'\n\n## Events\nThey're all pretty self explanatory.  The messages provided to the events have the optional field **queryId** that corresponds to the  queryId that was provided to the **query** function.  Use that to track a particular request in the query's lifecycle.\n\nInvoked at the start of the query's lifecycle.  No query has occurred yet.\n      onbeginquery: (msg) => @emit 'beginquery', msg\n\nInvoked when a new row set is began.  Row sets are the result of executing a singular query.  For example, if you executed two SQL statements, each would be its own row set.\n      onbeginrowset: (msg) => @emit 'beginrowset', msg\n\nInvoked every time a row of data is returned from a row set.\n      onrow: (msg) => @emit 'row', msg\n\nInvoked at the end of a row set.\n      onendrowset: (msg) => @emit 'endrowset', msg\n\nInvoked at the end of the query's overall lifecycle.\n      onendquery: (msg) => @emit 'endquery', msg\n\nInvoked if an error is encountered while processing the query.\n      onerror: (msg) => @emit 'error', msg\n\n\n\n    module.exports = EpiClient","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ce74d05eab71e464689e6cad9d23080ec2930e56","subject":"fix(query): run query post filter on parsed query object","message":"fix(query): run query post filter on parsed query object\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      blacklist:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.status(404).json message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.status(404).json message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.sendStatus 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.db.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `endret`, `lisens`, `navn`, `status`, `tilbyder`, and `tags` in\naddition to `\\_id` ObjectID which is always returned by MongoDB.\n\n      fields =\n        endret: true\n        lisens: true\n        navn: true\n        status: true\n        tags: true\n        tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ','\n          fields[field] = true\n\nIf any private fields are to be returned we need to limit the query to documents\nowner by the API user to prevent exposing private data publicly.\n\n          req.db.query.tilbyder = req.user.tilbyder if field.substr(0,6) is 'privat'\n\n### Sort\n\nLimit sort to ascending or descending on `\\_id`, `endret`, and `navn` since they\nare indexed. Non-indexed fields will be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when '_id' then [['_id', 1]]\n          when '-_id' then [['_id', -1]]\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nMake new cursor object with the correct query, fields, and other options (limit,\nskip, and sort).\n\n      cursor = req.db.col.find req.db.query, fields,\n        limit: Math.min (parseInt(req.query.limit, 10) or 20), 50\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min cursor.cmd.limit, Math.max total - cursor.cmd.skip, 0\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.sendStatus 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(422).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.status(422).json\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.status(201).json\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      blacklist:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.status(404).json message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.status(404).json message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.sendStatus 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `endret`, `lisens`, `navn`, `status`, `tilbyder`, and `tags` in\naddition to `\\_id` ObjectID which is always returned by MongoDB.\n\n      fields =\n        endret: true\n        lisens: true\n        navn: true\n        status: true\n        tags: true\n        tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ','\n          fields[field] = true\n\nIf any private fields are to be returned we need to limit the query to documents\nowner by the API user to prevent exposing private data publicly.\n\n          req.db.query.tilbyder = req.user.tilbyder if field.substr(0,6) is 'privat'\n\n### Sort\n\nLimit sort to ascending or descending on `\\_id`, `endret`, and `navn` since they\nare indexed. Non-indexed fields will be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when '_id' then [['_id', 1]]\n          when '-_id' then [['_id', -1]]\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nMake new cursor object with the correct query, fields, and other options (limit,\nskip, and sort).\n\n      cursor = req.db.col.find req.db.query, fields,\n        limit: Math.min (parseInt(req.query.limit, 10) or 20), 50\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min cursor.cmd.limit, Math.max total - cursor.cmd.skip, 0\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.sendStatus 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(422).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.status(422).json\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.status(201).json\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"889ad1277caadfd26af44d876fb9234f4d3c4dec","subject":"consistent","message":"consistent\n","repos":"glamp\/leech,glamp\/leech","old_file":"index.litcoffee","new_file":"index.litcoffee","new_contents":"Pretty simple setup here.\n\n    handlebars = require 'handlebars'\n    aws = require 'aws-sdk'\n    shortid = require 'shortid'\n\nSetup the connection to s3\n\n    aws.config.update {\n        accessKeyId: process.env[\"AWS_ACCESS_KEY\"],\n        secretAccessKey: process.env[\"AWS_SECRET_KEY\"]\n    }\n    aws.config.region = 'us-east-1'\n    s3 = new aws.S3()\n\nSet the name for your domain.\n\n    module.exports = (url) ->\n      DOMAIN = process.env[\"DOMAIN\"] || \"shortcake.com\"\n      BUCKET = process.env[\"BUCKET\"] || DOMAIN\n      GA_ID = process.env[\"GA_ID\"]\n      shortid.characters \"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ()\"\n\nThis is our basic HTML template that we'll use for doing the redirect. It's just\ngoing to send the user to another page as soon as it's loaded. There's no server\nsince it's just a static file, but everything will be tracked by GA.\n\n      source = \"\"\"\n      <html>\n          <title>{{url}}<\/title>\n          <body>\n            <!-- Google Analytics -->\n            <script type=\"text\/javascript\">var _gaq = _gaq || [];_gaq.push(['_setAccount', '{{ga_id}}']);_gaq.push(['_setDomainName', 'yhathq.com']);_gaq.push(['_trackPageview']);(function() {var ga = document.createElement('script'); ga.type = 'text\/javascript'; ga.async = true;ga.src = ('https:' == document.location.protocol ? 'https:\/\/ssl' : 'http:\/\/www') + '.google-analytics.com\/ga.js';var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);})();<\/script>\n            <!-- redirect -->\n            <script type=\"text\/javascript\">\n              window.location.replace('{{url}}');\n            <\/script>\n          <\/body>\n      <\/html>\n      \"\"\"\n\n      template = handlebars.compile(source)\n\nData should just be the user's Google Analytics Id and the URL that they want to\nminify.\n\n      data = { url: url, ga_id: GA_ID }\n      html = template(data)\n\nWe're going to generate a shortlink for the URL. [`shortid`](https:\/\/github.com\/dylang\/shortid) does a pretty good job at balancing between being short, and also\nbeing unique!\n\n      _id = shortid.generate()\n\nWe could break up the files by the [first 3 letters in the id](http:\/\/docs.aws.amazon.com\/AmazonS3\/latest\/dev\/request-rate-perf-considerations.html).\nThis makes it much easier for S3 to distribute the bucket (and greatly improves performance).\n...but we're not going to do this yet.\n\n      params = {\n          Bucket: BUCKET,\n          Key: _id\n          ACL: \"public-read\",\n          Body: html\n      }\n      s3.putObject params, (err, data) ->\n          if err\n              console.log err\n\nWe'll keep a running record of all links we've shortened and throw it into a \nbasic HTML page just to make it easy to do lookups.\n\n      source = \"\"\"\n      <html>\n          <title>Shortened Links<\/title>\n          <body>\n              <h1>Shortened Links<\/h1>\n              <ul>\n              {{#objs}}\n                  <li><a href='{{ Key }}'>{{ Key }}<\/a><\/li>\n              {{\/objs}}\n              <\/ul>\n          <\/body>\n      <\/html>\n      \"\"\"\n      params = { Bucket: BUCKET }\n      s3.listObjects params, (err, objs) ->\n        if err\n            console.log \"[ERROR]: could not list objects: \" + err\n        objs = objs.Contents.filter (obj) ->\n          ! \/index.html$\/.test obj.Key\n        html = handlebars.compile(source)({ objects: objs })\n        params = {\n            Bucket: BUCKET,\n            Key: \"index.html\",\n            ACL: \"public-read\",\n            Body: html\n        }\n        s3.putObject params, (err, data) ->\n            if err\n                econsole.log \"[ERROR]: \" + err\n        console.error \"Visit: https:\/\/s3.amazonaws.com\/#{BUCKET}\/index.html\"\n\n","old_contents":"Pretty simple setup here.\n\n    handlebars = require 'handlebars'\n    aws = require 'aws-sdk'\n    shortid = require 'shortid'\n\nSetup the connection to s3\n\n    aws.config.update {\n        accessKeyId: process.env[\"AWS_ACCESS_KEY\"],\n        secretAccessKey: process.env[\"AWS_SECRET_KEY\"]\n    }\n    aws.config.region = 'us-east-1'\n    s3 = new aws.S3()\n\nSet the name for your domain.\n\n    module.exports = (url) ->\n      DOMAIN = process.env[\"DOMAIN\"] || \"shortcake.com\"\n      BUCKET = process.env[\"BUCKET\"] || DOMAIN\n      GA_ID = process.env[\"GA_ID\"]\n      shortid.characters \"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ()\"\n\nThis is our basic HTML template that we'll use for doing the redirect. It's just\ngoing to send the user to another page as soon as it's loaded. There's no server\nsince it's just a static file, but everything will be tracked by GA.\n\n      source = \"\"\"\n      <html>\n          <title>{{url}}<\/title>\n          <body>\n            <!-- Google Analytics -->\n            <script type=\"text\/javascript\">var _gaq = _gaq || [];_gaq.push(['_setAccount', '{{ga_id}}']);_gaq.push(['_setDomainName', 'yhathq.com']);_gaq.push(['_trackPageview']);(function() {var ga = document.createElement('script'); ga.type = 'text\/javascript'; ga.async = true;ga.src = ('https:' == document.location.protocol ? 'https:\/\/ssl' : 'http:\/\/www') + '.google-analytics.com\/ga.js';var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);})();<\/script>\n            <!-- redirect -->\n            <script type=\"text\/javascript\">\n              window.location.replace('{{url}}');\n            <\/script>\n          <\/body>\n      <\/html>\n      \"\"\"\n\n      template = handlebars.compile(source)\n\nData should just be the user's Google Analytics Id and the URL that they want to\nminify.\n\n      data = { url: url, ga_id: GA_ID }\n      html = template(data)\n\nWe're going to generate a shortlink for the URL. [`shortid`](https:\/\/github.com\/dylang\/shortid) does a pretty good job at balancing between being short, and also\nbeing unique!\n\n      _id = shortid.generate()\n\nWe could break up the files by the [first 3 letters in the id](http:\/\/docs.aws.amazon.com\/AmazonS3\/latest\/dev\/request-rate-perf-considerations.html).\nThis makes it much easier for S3 to distribute the bucket (and greatly improves performance).\n...but we're not going to do this yet.\n\n      params = {\n          Bucket: BUCKET,\n          Key: _id\n          ACL: \"public-read\",\n          Body: html\n      }\n      s3.putObject params, (err, data) ->\n          if err\n              console.log err\n\nWe'll keep a running record of all links we've shortened and throw it into a \nbasic HTML page just to make it easy to do lookups.\n\n      source = \"\"\"\n      <html>\n          <title>Shortened Links<\/title>\n          <body>\n              <h1>Shortened Links<\/h1>\n              <ul>\n              {{#objs}}\n                  <li><a href='{{ Key }}'>{{ Key }}<\/a><\/li>\n              {{\/objs}}\n              <\/ul>\n          <\/body>\n      <\/html>\n      \"\"\"\n      params = { Bucket: BUCKET }\n      s3.listObjects params, (err, objs) ->\n        if err\n            console.log \"[ERROR]: could not list objects: \" + err\n        objs = objs.Contents.filter (obj) ->\n          ! \/index.html$\/.test obj.Key\n        html = handlebars.compile(source)({ objects: objs })\n        params = {\n            Bucket: BUCKET,\n            Key: \"index.html\",\n            ACL: \"public-read\",\n            Body: html\n        }\n        s3.putObject params, (err, data) ->\n            if err\n                console.log err\n        console.error \"Visit: https:\/\/s3.amazonaws.com\/#{BUCKET}\/index.html\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f5e76a2f3fb1a29d627fb5a7a849b14821367763","subject":"Remove pluralizer from ComponentFilter","message":"Remove pluralizer from ComponentFilter\n","repos":"ygt-mikekchar\/react-maybe-matchers,ygt-mikekchar\/react-maybe-matchers","old_file":"src\/ComponentFilter.litcoffee","new_file":"src\/ComponentFilter.litcoffee","new_contents":"# ComponentFilter\n\nThis class filters collections of React components, often for\nthe purpose of finding a DOM node with a specific CSS\nclass, or ID.\n\n## Example\n\n```\ncomponentFilter.with.cssClass(\"my-class\")\n               .exactly(2).times\n               .result()\n```\n\nThis will take the list of nodes in componentFilter,\nfilter them by cssClass and return a matching result\nif there are exactly 2 of them.\n\n## Requirements\n\nThe [JasmineMonad](.\/JasmineMonad.litcoffee#a-monad-for-jasmine-tests) is a \"maybe\" monad that\nallows us to chain our matcher functions in a fluent way.\n\n    JasmineMonad = require(\".\/JasmineMonad.litcoffee\")\n\n### A monad for filtering collections of React components\n\n    class ComponentFilter extends JasmineMonad\n\n      constructor: (@value, @util, @testers, @messages) ->\n        super(@value, @util, @testers, @messages)\n\n#### English helpers\n\nBecause this monad deals with filtering lists of components\nit is nice to have a couple of dummy properties that\nallow us to use a more fluent English expression.\n`@with`, `@and` and `time` can be used for that purpose.\n\n        @with = this\n        @and = this\n        @time = this\n        @times = this\n\n#### Filtering nodes by CSS class\n\n      # TODO: Is this necessary?  Does anyone add className\n      # to a component?  What does it mean?\n      cssClass: (cssClass) ->\n        @bind (nodes) =>\n          match = (a, b) ->\n            return false if !b?\n            b.indexOf(a) != -1\n\n          if nodes?.length\n            matched = (node for node in nodes when match(cssClass, node.props.className))\n          else\n            matched = []\n\n          messages = [\n            \"Expected to find component with className #{cssClass}, but it was not there.\"\n            \"Expected not to find component with className #{cssClass}, but there #{@was(matched.length)}.\"\n          ]\n\n          if matched.length > 0\n            @return(matched, messages)\n          else\n            @return(null, messages)\n\n#### Enforcing the number of nodes\n\n      exactly: (num) ->\n        @bind (nodes) =>\n          messages = [\n            \"Expected to find exactly #{@count(num, 'node')}, but there #{@was(nodes.length)}\"\n            \"Expected not find #{@count(num, 'node')}, but there #{@was(nodes.length)}.\"\n          ]\n\n          if nodes.length == num\n            @return(nodes, messages)\n          else\n            @return(null, messages)\n\nExport our matchers from this file.\n\n    module.exports = ComponentFilter\n","old_contents":"# ComponentFilter\n\nThis class filters collections of React components, often for\nthe purpose of finding a DOM node with a specific CSS\nclass, or ID.\n\n## Example\n\n```\ncomponentFilter.with.cssClass(\"my-class\")\n               .exactly(2).times\n               .result()\n```\n\nThis will take the list of nodes in componentFilter,\nfilter them by cssClass and return a matching result\nif there are exactly 2 of them.\n\n## Requirements\n\nThe [JasmineMonad](.\/JasmineMonad.litcoffee) is a \"maybe\" monad that\nallows us to chain our matcher functions in a fluent way.\n\n    JasmineMonad = require(\".\/JasmineMonad.litcoffee\")\n\nThe matchers need to pluralize strings, so we need to load\n[a string pluralizer method](pluralize.litcoffee)\n\n    require(\".\/pluralize.litcoffee\")\n\n### A monad for filtering collections of React components\n\n    class ComponentFilter extends JasmineMonad\n\n      constructor: (@value, @util, @testers, @messages) ->\n        super(@value, @util, @testers, @messages)\n\n#### English helpers\n\nBecause this monad deals with filtering lists of components\nit is nice to have a couple of dummy properties that\nallow us to use a more fluent English expression.\n`@with`, `@and` and `time` can be used for that purpose.\n\n        @with = this\n        @and = this\n        @time = this\n        @times = this\n\n#### Filtering nodes by CSS class\n\n      # TODO: Is this necessary?  Does anyone add className\n      # to a component?  What does it mean?\n      cssClass: (cssClass) ->\n        @bind (nodes) =>\n          match = (a, b) ->\n            return false if !b?\n            b.indexOf(a) != -1\n\n          if nodes?.length\n            matched = (node for node in nodes when match(cssClass, node.props.className))\n          else\n            matched = []\n\n          messages = [\n            \"Expected to find component with className #{cssClass}, but it was not there.\"\n            \"Expected not to find component with className #{cssClass}, but there #{@was(matched.length)}.\"\n          ]\n\n          if matched.length > 0\n            @return(matched, messages)\n          else\n            @return(null, messages)\n\n#### Enforcing the number of nodes\n\n      exactly: (num) ->\n        @bind (nodes) =>\n          messages = [\n            \"Expected to find exactly #{@count(num, 'node')}, but there #{@was(nodes.length)}\"\n            \"Expected not find #{@count(num, 'node')}, but there #{@was(nodes.length)}.\"\n          ]\n\n          if nodes.length == num\n            @return(nodes, messages)\n          else\n            @return(null, messages)\n\nExport our matchers from this file.\n\n    module.exports = ComponentFilter\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6c9b310d9da3a0869896d11f7d0efe7f76f3a732","subject":"more tweaks for correctness and documentedness","message":"more tweaks for correctness and documentedness\n","repos":"bchociej\/platform-ng","old_file":"config-defaults.litcoffee","new_file":"config-defaults.litcoffee","new_contents":"*This is [Literate Coffeescript](http:\/\/coffeescript.org\/#literate): code interleaved with Markdown\ncomments. The Coffeescript compiler will strip the Markdown and compile it like any other file.*\n\n## platform-ng config defaults\n\nThis file defines the default configuration options for platform-ng and explains\nhow can modify the configuration to suit your needs.\n\nWhen you call `Platform#config()` with your configuration object, this configuration is deep-extended with\nyours to produce the working configuration.\n\n### General application configuration\n\nWhat's the app called (`name`), and what environment is it running in (`env`)? For `env`, anything other\nthan the string `'production'` is automatically considered `'development'` for debuggability.\n\n\tmodule.exports =\n\t\tapp:\n\t\t\tname: 'unnamed-app'\n\t\t\tenv: 'development'\n\n#### Sessions\n\nFor sessions, you can choose to entirely disable them by setting `enabled` to `false`. Otherwise, your\nchoices for `type` are currently `cookie` or `vanilla`.\n\nThe `cookie` type stores all session data in a garbled (not encrypted) client-side cookie, signed using\nthe `secret`.\n\nThe `vanilla` type stores the session in a server-side session store and only transmits a signed session\nID to the client.\n\n`cookie` is default for now, but `vanilla` will replace it in the next major version. The `secure` option\ndetermines whether the cookies are HTTPS-only or not.\n\n\t\t\tsession:\n\t\t\t\tenabled: true\n\t\t\t\ttype: 'cookie'\n\t\t\t\tsecret: 'change-me'\n\t\t\t\tsecure: false\n\n#### Cookie parser\n\nThe cookie parser transforms the `cookie` header into `request.cookies`, `request.signedCookies`, and\n`request.secureCookies` objects. You still have to use `response.cookie(...)` and\/or \n`response.clearCookie(...)` to actually manipulate cookies. The `secret` defined here will be used to\nverify signed cookies, and, if you set `{signed: true}` in the third argument to `response.cookie(...)`,\nthis `secret` will be used to sign the outbound cookies too.\n\n\t\t\tcookies:\n\t\t\t\tenabled: true\n\t\t\t\tsecret: 'change-me'\n\n### HTTP server configuration\n\nThe `server` sections deals with how platform-ng handles the exchange, parsing, and encoding of HTTP\nrequests and responses.\n\n\t\tserver:\n\t\t\t# Use automatic gzip compression for responses?\n\t\t\tcompress: true\n\n\t\t\t# TCP port to listen on (overriden by PORT environment variable)\n\t\t\tport: 8001\n\n\t\t\t# Is the app behind a proxy? If so, replace request.ip with X-Forwarded-For, and trust\n\t\t\t# all cookies for HTTPS-only mode.\n\t\t\tbehind_proxy: false\n\n\t\t\t# Enable\/disable various body parsers, for performance and security reasons\n\t\t\tparsers:\n\t\t\t\turlencoded: true\n\t\t\t\tjson: true\n\t\t\t\tmultipart: false # potential security problem; read http:\/\/goo.gl\/N4Bci1\n\n\t\t\t# Allow requests to change HTTP verb using 'X-HTTP-Method-Override' header?\n\t\t\tmethod_override: false\n\n### Language configuration\n\nThis section controls which protolanguages platform-ng will compile, as well as language-specific options\nfor some of the languages. (The NPM dependencies for these languages are listed in `package.json` as\n`optionalDependencies` and can be skipped entirely by calling `npm install --no-optional`.)\n\n\t\tlanguages:\n\t\t\tcoffeescript:\n\t\t\t\tenabled: true\n\n\t\t\tstylus:\n\t\t\t\tenabled: true\n\t\t\t\tinclude_css: true\t# Whether to inline @include()'d CSS files\n\t\t\t\tnib: true\t\t\t# Whether to automatically load the nib library\n\n`compile` controls generic compilation options for all language compilers. The `minify` option will\ncause the compiler to munge the output in order to produce the smallest possible code. The `expose_sources`\noption will cause the server to serve the original files (e.g. .coffee, .styl, etc) if requested, AND it\nwill ask the compiler to generate source maps, if supported.\n\n\t\tcompile:\n\t\t\tminify: true\n\t\t\texpose_sources: true \n\nplatform-ng is powered by Express. You can directly configure Express settings here. The settings are\ndocumented on [this page](http:\/\/expressjs.com\/3x\/api.html#app-settings).\n\n\t\texpress:\n\t\t\t'view engine': 'jade'","old_contents":"*This is [Literate Coffeescript](http:\/\/coffeescript.org\/#literate): code interleaved with Markdown\ncomments. The Coffeescript compiler will strip the Markdown and compile it like any other file.*\n\n\tmodule.exports =\n\n## platform-ng config defaults\n\nThis file defines the default configuration options for platform-ng and explains\nhow can modify the configuration to suit your needs.\n\nWhen you call `Platform#config()` with your configuration object, this configuration is deep-extended with\nyours to produce the working configuration.\n\n### General application configuration\n\nWhat's the app called (`name`), and what environment is it running in (`env`)? For `env`, anything other\nthan the string `'production'` is automatically considered `'development'` for debuggability.\n\n\t\tapp:\n\t\t\tname: 'unnamed-app'\n\t\t\tenv: 'development'\n\n#### Sessions\n\nFor sessions, you can choose to entirely disable them by setting `enabled` to `false`. Otherwise, your\nchoices for `type` are currently `cookie` or `vanilla`.\n\nThe `cookie` type stores all session data in a garbled (not encrypted) client-side cookie, signed using\nthe `secret`.\n\nThe `vanilla` type stores the session in a server-side session store and only transmits a signed session\nID to the client.\n\n`cookie` is default for now, but `vanilla` will replace it in the next major version. The `secure` option\ndetermines whether the cookies are HTTPS-only or not.\n\n\t\t\tsession:\n\t\t\t\tenabled: true\n\t\t\t\ttype: 'cookie'\n\t\t\t\tsecret: 'change-me'\n\t\t\t\tsecure: false\n\n#### Cookie parser\n\nThe cookie parser transforms the `cookie` header into `request.cookies`, `request.signedCookies`, and\n`request.secureCookies` objects. You still have to use `response.cookie(...)` and\/or \n`response.clearCookie(...)` to actually manipulate cookies. The `secret` defined here will be used to\nverify signed cookies, and, if you set `{signed: true}` in the third argument to `response.cookie(...)`,\nthis `secret` will be used to sign the outbound cookies too.\n\n\t\t\tcookies:\n\t\t\t\tenabled: true\n\t\t\t\tsecret: 'change-me'\n\n### HTTP server configuration\n\nThe `server` sections deals with how platform-ng handles the exchange, parsing, and encoding of HTTP\nrequests and responses.\n\n\t\tserver:\n\t\t\t# Use automatic gzip compression for responses?\n\t\t\tcompress: true\n\n\t\t\t# TCP port to listen on (overriden by PORT environment variable)\n\t\t\tport: 8001\n\n\t\t\t# Is the app behind a proxy? If so, replace request.ip with X-Forwarded-For, and trust\n\t\t\t# all cookies for HTTPS-only mode.\n\t\t\tbehind_proxy: false\n\n\t\t\t# Enable\/disable various body parsers, for performance and security reasons\n\t\t\tparsers:\n\t\t\t\turlencoded: true\n\t\t\t\tjson: true\n\t\t\t\tmultipart: false # potential security problem; read http:\/\/goo.gl\/N4Bci1\n\n\t\t\t# Allow requests to change HTTP verb using 'X-HTTP-Method-Override' header?\n\t\t\tmethod_override: false\n\n### Language configuration\n\nThis section controls which protolanguages platform-ng will compile, as well as language-specific options\nfor some of the languages. (The NPM dependencies for these languages are listed in `package.json` as\n`optionalDependencies` and can be skipped entirely by calling `npm install --no-optional`.)\n\n\t\tlanguages:\n\t\t\tcoffeescript:\n\t\t\t\tenabled: true\n\n\t\t\tstylus:\n\t\t\t\tenabled: true\n\t\t\t\tinclude_css: true\t# Whether to inline @include()'d CSS files\n\t\t\t\tnib: true\t\t\t# Whether to automatically load the nib library\n\n`compile` controls generic compilation options for all language compilers. The `minify` option will\ncause the compiler to munge the output in order to produce the smallest possible code. The `expose_sources`\noption will cause the server to serve the original files (e.g. .coffee, .styl, etc) if requested, AND it\nwill ask the compiler to generate source maps, if supported.\n\n\t\tcompile:\n\t\t\tminify: true\n\t\t\texpose_sources: true \n\nplatform-ng is powered by Express. You can directly configure Express settings here. The settings are\ndocumented on [this page](http:\/\/expressjs.com\/3x\/api.html#app-settings).\n\n\t\texpress:\n\t\t\t'view engine': 'jade'","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c631541335d02be8dd947252a7f3245e0ba50e05","subject":"Be smarter about Madul checking, add support for dep alias and initer","message":"Be smarter about Madul checking, add support for dep alias and initer\n\nInstead of just checking whether a required module is a function, search\nthe prototype chain to see if any constructors are of type `Madul`.\n\nAdd support for dependency aliasing and dependency initializers. Aliases allow\nfor nicer names of hydrated dependencies, and initilialzers provide an easy way\nto hook madul initializer methods up to dependency configuration\/initialization.\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.MADUL_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    WRAPPED = { }\n\n    _INITIALIZERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                val\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                val\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before) if proto[method].before?\n            decs = decs.concat(proto[method].after)  if proto[method].after?\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              out = undefined\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      proto[val].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      proto[val].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then => q.all me.before.map (b) => proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  out = result\n                  q.all me.after.map (b) => b.after out\n                .then          => def.resolve out\n                .catch   (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: =>\n        proto = @.__proto__\n        name  = proto.constructor.name\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          for method, body of proto\n            if method[0]                  != '_'         &&\n               (\n                typeof body.behavior       == 'function' ||\n                typeof body                == 'function'\n               ) &&\n               typeof proto[\"_#{method}\"] == 'undefined' &&\n               WRAP(name, method)         == true\n\n              proto._do_wrap proto, method\n\n              INITIALIZERS name, method if method[0] == '$'\n\n          proto = proto.__proto__\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (done) =>\n        proto  = @.__proto__\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos, (p, next) =>\n          if p.deps?\n            p._do_hydrate p, p.deps, next\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, initer, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.constructor.name == 'Madul'\n\n          proto = proto.__super__\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then (mod) =>\n              if initer?\n                mod[initer]()\n                  .then => callback mod\n              else\n                callback mod\n        else\n          callback mod\n\n      _load: (me, name, initer, path, loaded) =>\n        me._init_if_madul path, initer, (mod) =>\n          me._make_available name, mod\n          loaded()\n\n      _check: (me, path, dep, ref, initer, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, initer, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, initer, depth, => me._do_add me, dep, ref, next\n                else\n                  next()\n            , finished\n\n      _add_dependency: (me, name, mod) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", name\n\n        me[underscore name] = mod\n\n      _do_add: (me, name, ref, next) =>\n        me._add_dependency me, ref, available[strip name]\n        next()\n\n      _add: (me, name, ref, initer, path, next) =>\n        me._init_if_madul path, initer, (mod) =>\n          me._make_available name, mod\n          me._do_add me, name, ref, next\n\n      _do_hydrate: (proto, deps, callback) =>\n        async.each deps, (d, next) =>\n          name, alias, initer = undefined\n          tokens = d.split '->'\n\n          if tokens.length == 2\n            alias = tokens[0]\n            t     = tokens[1].split '::'\n\n            if t.length == 2\n              name   = t[0]\n              initer = t[1]\n            else\n              name = t[0]\n          else\n            name = alias = tokens[0]\n\n          ref = alias || name\n\n          if proto[underscore ref]? == false\n            if available[strip name]? == true\n              proto._do_add proto, name, ref, next\n            else\n              try\n                proto._add proto, name, ref, initer, d, next\n              catch e\n                cwd = process.cwd()\n                pkg = \"#{cwd}\/node_modules\/#{d}\/package.json\"\n\n                fs.stat pkg, (err, stat) =>\n                  if stat?.isFile()\n                    fs.readFile pkg, 'utf8', (err, data) =>\n                      json = JSON.parse data\n                      main = json.main || json._main || 'index.js'\n                      path = \"#{cwd}\/node_modules\/#{d}\/#{main}\"\n\n                      proto._add proto, name, ref, initer, path, next\n                  else\n                    proto._check proto, \"#{cwd}\/#{code_root}\", d, ref, initer next\n          else\n            next()\n        , callback\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        @_call_initializers_for name, =>\n          if listeners[name]?\n            async.each listeners[name], (listener, next) =>\n              listener @\n              next()\n            , => @_register_initialized name\n          else\n            @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              @[initializer.fn]()\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.MADUL_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    WRAPPED = { }\n\n    _INITIALIZERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                val\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                val\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before) if proto[method].before?\n            decs = decs.concat(proto[method].after)  if proto[method].after?\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              out = undefined\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      proto[val].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      proto[val].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then => q.all me.before.map (b) => proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  out = result\n                  q.all me.after.map (b) => b.after out\n                .then          => def.resolve out\n                .catch   (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: =>\n        proto = @.__proto__\n        name  = proto.constructor.name\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          for method, body of proto\n            if method[0]                  != '_'         &&\n               (\n                typeof body.behavior       == 'function' ||\n                typeof body                == 'function'\n               ) &&\n               typeof proto[\"_#{method}\"] == 'undefined' &&\n               WRAP(name, method)         == true\n\n              proto._do_wrap proto, method\n\n              INITIALIZERS name, method if method[0] == '$'\n\n          proto = proto.__proto__\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (done) =>\n        proto  = @.__proto__\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos, (p, next) =>\n          if p.deps?\n            p._do_hydrate p, p.deps, next\n          else\n            next()\n        , done\n\n      _load: (me, name, path, loaded) =>\n        mod = require path\n\n        if typeof mod == 'function'\n          new mod name\n            .initialize @ctor_params?[name]\n            .then (mod) =>\n              me._make_available name, mod\n              loaded()\n        else\n          me._make_available name, mod\n          loaded()\n\n      _check: (me, path, dep, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, f.substring(0, f.length - 3), depth, => me._do_add me, dep, next\n                else\n                  next()\n            , finished\n\n      _add_dependency: (me, name, mod) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", name\n\n        me[underscore name] = mod\n\n      _do_add: (me, name, next) =>\n        me._add_dependency me, name, available[strip name]\n        next()\n\n      _add: (me, name, resource, next) =>\n        me._make_available name, require resource\n        me._do_add me, name, next\n\n      _do_hydrate: (proto, deps, callback) =>\n        async.each deps, (d, next) =>\n          if proto[underscore d]? == false\n            if available[strip d]? == true\n              proto._do_add proto, d, next\n            else\n              try\n                proto._add proto, d, d, next\n              catch e\n                cwd = process.cwd()\n                pkg = \"#{cwd}\/node_modules\/#{d}\/package.json\"\n\n                fs.stat pkg, (err, stat) =>\n                  if stat?.isFile()\n                    fs.readFile pkg, 'utf8', (err, data) =>\n                      json = JSON.parse data\n                      main = json.main || json._main || 'index.js'\n\n                      proto._add proto, d, \"#{cwd}\/node_modules\/#{d}\/#{main}\", next\n                  else\n                    proto._check proto, \"#{cwd}\/#{code_root}\", d, next\n          else\n            next()\n        , callback\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        @_call_initializers_for name, =>\n          if listeners[name]?\n            async.each listeners[name], (listener, next) =>\n              listener @\n              next()\n            , => @_register_initialized name\n          else\n            @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              @[initializer.fn]()\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"156b0b30fd062085c8af7fed380670c0c8c4aee0","subject":"Clean up and document API upload route","message":"Clean up and document API upload route\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/routes\/api_v1.litcoffee","new_file":"src\/routes\/api_v1.litcoffee","new_contents":"    express = require 'express'\n    multer  = require 'multer'\n    async   = require 'async'\n    dms2dec = require 'dms2dec'\n\n    sentry  = require '..\/sentry'\n    librato = require '..\/librato'\n    s3      = require '..\/upload'\n\nMake a new Express router object for this part of the application.\n\n    api = express.Router()\n\n## Metrics\n\nAgregate metrics for all requests and wheter they succeded (`finish`) or closed\nbefore the request succeeded (`close`).\n\n    api.use (req, res, next) ->\n      librato.logRequest req.method\n\n      res.once 'close', ->\n        librato.logResponse 'closed'\n        sentry.captureResClose res\n\n      res.once 'finish', ->\n        librato.logResponse res.statusCode\n\n      next()\n\n## GET \/\n\n    api.get '\/', (req, res, next) ->\n      res.status(204).end()\n\n## POST \/upload\n\nConfigure [multer](https:\/\/github.com\/expressjs\/multer) to store files in the\nOS's temorary directory `tempdir()`. This way we should not need to clean up the\nuploaded files since that should be the job of the OS.\n\n    multer = require('multer')\n      putSingleFilesInArray: true\n      dest: require('os').tmpdir()\n\nConfigure the `\/upload` route handler.\n\n    api.post '\/upload', multer, (req, res, next) ->\n      librato.logImagesUploaded Object.keys req.files\n\n      files = []\n      for key, f of req.files\n        files.push file for file in f\n\n      async.mapSeries files, (file, cb) ->\n        if file.extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif']\n          error = new Error \"Invalid Image #{file.extension}\"\n          error.status = 422\n          return cb error\n\n        t1 = new Date().getTime()\n        s3.upload file.path, {}, (err, images, meta) ->\n          return cb err if err\n\n          librato.logImageProcessingTime t1, new Date().getTime()\n\nFormat image GeoJSON correctly if the image has GPS properties.\n\n          if meta.exif?.GPSLatitude and meta.exif?.GPSLongitude\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif.GPSLatitude, \\\n                meta.exif.GPSLatitudeRef, \\\n                meta.exif.GPSLongitude, \\\n                meta.exif.GPSLongitudeRef\n              .reverse()\n\nWe need to remove the original image (index i - 1) since it is not publicly\naccessible. It gets uploaded to AWS as backup of the original image.\n\n          images = images.splice 0, images.length - 1\n\nLoop over all the generated images and apply `width` and `height` properties\nsince that is currently not set correctly. We also remove some image information\nsuch as AWS key and local path which are not in use.\n\n          for image in images\n            # Since we\n            if not image.width\n              image.height = image.maxHeight\n              image.width = image.maxWidth\n\n              if image.aspect\n                image.height = Math.floor image.maxHeight * 2 \/ 3\n              else\n                if meta.height > meta.width\n                  image.width = Math.floor image.height * meta.width \/ meta.height\n                else\n                  image.height = Math.floor image.width * meta.height \/ meta.width\n\n            image.key       = undefined\n            image.maxHeight = undefined\n            image.maxWidth  = undefined\n            image.path      = undefined\n            image.suffix    = undefined\n\n            console.log image\n\n          return cb null, versions: images, meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    module.exports = api\n\n","old_contents":"    express = require 'express'\n    multer  = require 'multer'\n    async   = require 'async'\n    dms2dec = require 'dms2dec'\n\n    sentry  = require '..\/sentry'\n    librato = require '..\/librato'\n    s3      = require '..\/upload'\n\nMake a new Express router object for this part of the application.\n\n    api = express.Router()\n\n## Metrics\n\nAgregate metrics for all requests and wheter they succeded (`finish`) or closed\nbefore the request succeeded (`close`).\n\n    api.use (req, res, next) ->\n      librato.logRequest req.method\n\n      res.once 'close', ->\n        librato.logResponse 'closed'\n        sentry.captureResClose res\n\n      res.once 'finish', ->\n        librato.logResponse res.statusCode\n\n      next()\n\n## GET \/\n\n    api.get '\/', (req, res, next) ->\n      res.status(204).end()\n\n## POST \/upload\n\nConfigure [multer](https:\/\/github.com\/expressjs\/multer) to store files in the\nOS's temorary directory `tempdir()`. This way we should not need to clean up the\nuploaded files since that should be the job of the OS.\n\n    multer = require('multer')\n      putSingleFilesInArray: true\n      dest: require('os').tmpdir()\n\nConfigure the `\/upload` route handler.\n\n    api.post '\/upload', multer, (req, res, next) ->\n      librato.logImagesUploaded Object.keys req.files\n\n      files = []\n      for key, f of req.files\n        files.push file for file in f\n\n      async.mapSeries files, (file, cb) ->\n        if file.extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif']\n          error = new Error \"Invalid Image #{file.extension}\"\n          error.status = 422\n          return cb error\n\n        t1 = new Date().getTime()\n        s3.upload file.path, {}, (err, images, meta) ->\n          return cb err if err\n\n          librato.logImageProcessingTime t1, new Date().getTime()\n\n          if meta.exif?.GPSLatitude and meta.exif?.GPSLongitude\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif.GPSLatitude, \\\n                meta.exif.GPSLatitudeRef, \\\n                meta.exif.GPSLongitude, \\\n                meta.exif.GPSLongitudeRef\n              .reverse()\n\n          #if meta.imageSize.height > meta.imageSize.width\n          #  ratio = meta.imageSize.height \/ meta.imageSize.width\n          #  edge = 'width'\n          #else\n          #  ratio = meta.imageSize.width \/ meta.imageSize.height\n          #  edge = 'height'\n\n          images = images.splice 0, images.length - 1\n\n            image.path = undefined\n            image.src = undefined\n\n          for image in images\n            # Since we\n            if not image.width\n              image.height = image.maxHeight\n              image.width = image.maxWidth\n\n              if image.aspect\n                image.height = Math.floor image.maxHeight * 2 \/ 3\n              else\n                if meta.height > meta.width\n                  image.width = Math.floor image.height * meta.width \/ meta.height\n                else\n                  image.height = Math.floor image.width * meta.height \/ meta.width\n\n            image.key       = undefined\n            image.maxHeight = undefined\n            image.maxWidth  = undefined\n            image.path      = undefined\n            image.suffix    = undefined\n\n            console.log image\n\n          return cb null, versions: images, meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    module.exports = api\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ff081e47a432110da1efdf991b5f2026cb07133e","subject":"add aclType info to README","message":"add aclType info to README\n","repos":"CureApp\/loopback-with-admin","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\n\n# install\n\n```\nnpm install loopback-with-domain\n```\n\n\n# run\n\nbefore running, you can prepare a directory which contains custom config information.\n\n\n```text\n(config-dir) # any name is acceptable\n|-- model-definitions.coffee\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    configDir = '\/path\/to\/config-dir'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    lbWithDomain.runWithDomain(domain, configDir).then ->\n        # loopback started\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|-----------------------\n memory      | on memory datasource\n db          | datasource for domain entities\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n# model definitions\n\n    module.exports =\n        player: # model name\n            base: 'User'  # the same as loopback model settings.base\n            aclType: 'admin' # specific for this system\n\n        instrument:\n            aclType: 'owner-read'\n\n\n\nthe same format as [loopback model definition](http:\/\/docs.strongloop.com\/display\/public\/LB\/Customizing+models)\nexcept \"aclType\" value.\nname, base, relations and properties are automatically set from domain information.\n\n## aclType\nloopback-with-domain generates acls from aclType.\n\nthree types are available.\n\n aclType     | meaning\n-------------|-----------------------------------------------------\n admin       | only admin can CRUD the model\n owner       | admin and the owner of the model can CRUD\n public-read | everyone can READ the model and admin can CRUD\n\n\n# switching environment\n\nrunning script with environment variable \"NODE\\_ENV\" like\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\n\"development\" is selected by default.\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-domain selects configs in \"local\" directory.\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    lbWithDomain.runWithDomain(domain, configDir, env)\n\nenv is prior to NODE\\_ENV settings.\n\n# modified loopback-datasource-juggler\n\nusing [CureApp\/loopback-datasource-juggler](https:\/\/github.com\/CureApp\/loopback-datasource-juggler).\n\nthis repository is almost the same as original one except 'memory' connector handles id as string\n(orignally integer).\n","old_contents":"# loopback-with-domain\n\nrun loopback server with \"domain\"\n\ndomain is in this context business logic, the same as Domain-Driven Design (DDD).\n\nconnection with [base-domain](https:\/\/github.com\/CureApp\/base-domain)\n\n\n# install\n\n```\nnpm install loopback-with-domain\n```\n\n\n# run\n\nbefore running, you can prepare a directory which contains custom config information.\n\n\n```text\n(config-dir) # any name is acceptable\n|-- model-definitions.coffee\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n`-- production\n    `-- datasources.coffee\n```\n\n\n    lbWithDomain = require 'loopback-with-domain'\n\n    configDir = '\/path\/to\/config-dir'\n\n    domain = require('base-domain').createInstance(dirname: 'domain')\n\n    lbWithDomain.runWithDomain(domain, configDir).then ->\n        # loopback started\n\n\n# configs\n\nthese are the config names.\n\n- admin\n- datasources\n- middleware\n- server\n- push-credentials\n\nsee JSON files in \"default-configs\" directory.\nyou can set the same properties as these JSONs.\n\n\n## admin\n\n config key  | meaning\n-------------|-----------------------\n accessToken | accessToken for admin\n\n## datasources\n\n config key  | meaning\n-------------|-----------------------\n memory      | on memory datasource\n db          | datasource for domain entities\n\n## server\n\n config key  | meaning       | default\n-------------|---------------|----------------\n restApiRoot | REST api root | \/api\n port        | port number   | 3000\n\n\n## push-credentials\n\n config key      | meaning\n-----------------|-------------------------------------------\n gcmServerApiKey | api key for Google Cloud Messaging (GCM)\n apnsCertData    | certificate pem contents for APNs\n apnsKeyData     | key pem contents for APNs\n\n\n# switching environment\n\nrunning script with environment variable \"NODE\\_ENV\" like\n\n```bash\n$ NODE_ENV=production node app.js\n```\n\n\"development\" is selected by default.\n\nwhen your config dir is\n\n```text\n(config-dir) # any name is acceptable\n|-- common\n|   |-- server.coffee\n|   `-- admin.coffee\n|-- development\n|   `-- datasources.coffee\n|-- local\n|   `-- datasources.coffee\n|-- production\n|   `-- datasources.coffee\n```\n\nand launching script like\n\n```bash\n$ NODE_ENV=local node app.js\n```\nthen, loopback-with-domain selects configs in \"local\" directory.\n\n## passing custom environment with argument\n\n    env = 'production'\n\n    lbWithDomain.runWithDomain(domain, configDir, env)\n\nenv is prior to NODE\\_ENV settings.\n\n\n# modified loopback-datasource-juggler\n\nusing [CureApp\/loopback-datasource-juggler](https:\/\/github.com\/CureApp\/loopback-datasource-juggler).\n\nthis repository is almost the same as original one except 'memory' connector handles id as string\n(orignally integer).\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"600bec35c3bcbd40133395b469dc860e1a1c6d4b","subject":"Fix missing custom after query","message":"Fix missing custom after query\n","repos":"Turistforeningen\/node-mongo-querystring","old_file":"src\/index.litcoffee","new_file":"src\/index.litcoffee","new_contents":"    module.exports = MongoQS = (opts) ->\n      @ops = opts?.ops or ['!', '^', '$', '~', '>', '<']\n      @alias = opts?.alias or {}\n      @ignore = opts?.ignore or {}\n      @custom = opts?.custom or {}\n\n      for param, field of @custom\n        switch param\n          when 'bbox' then @custom.bbox = @customBBOX field\n          when 'near' then @custom.near = @customNear field\n          when 'after' then @custom.after = @customAfter field\n\n      return @\n\n    MongoQS.prototype.customBBOX = (field) ->\n      (res, bbox) ->\n        bbox = bbox.split ','\n\n        if bbox.length is 4\n          val = parseFloat(val) for val in bbox\n\n          res[field] = $geoWithin: $geometry:\n            type: 'Polygon'\n            coordinates: [[\n              [bbox[0], bbox[1]]\n              [bbox[2], bbox[1]]\n              [bbox[2], bbox[3]]\n              [bbox[0], bbox[3]]\n              [bbox[0], bbox[1]]\n            ]]\n\n        return\n\n    MongoQS.prototype.customNear = (field) ->\n      (query, input) ->\n        input = input.split ','\n\n        if input.length is 2\n          val = parseFloat(val) for val in input\n\n          query[field] = $near: $geometry:\n            type: 'Point'\n            coordinates: input\n\n        return\n\n    MongoQS.prototype.customAfter = (field) ->\n      (query, input) ->\n\n        if not isNaN input\n          input = input + '000' if (input + '').length is 10\n          input = parseInt input\n\n        input = new Date input\n\n        if input.toString() isnt 'Invalid Date'\n          query[field] = $gte: input.toISOString()\n\n\n    MongoQS.prototype.parse = (query) ->\n      res = {}\n\n      for key, val of query\n        continue if @ignore[key]\n        continue if typeof val isnt 'string'\n        continue if not \/^[a-z\u00e6\u00f8\u00e50-9-_.]+$\/i.test key\n\n        key = @alias[key] if @alias[key]\n\nIf the value is empty we treat the query parameter as an\n[$exists](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/exists\/)\noperator.\n\n        if not val\n          res[key] = $exists: true\n\nCheck for supported operators in `@ops`. This is configured when\ninstanciating `MongoQS` and the defaults are `!`, `^`, `$`, `~`, `>`, and `<`.\n\n        else if val.charAt(0) in @ops\n          op = val.charAt(0)\n          val = val.substr(1)\n\n          res[key] = switch op\n            when '!'\n              if val\n                $ne: if isNaN(val) then val else parseFloat(val, 10)\n              else\n                $exists: false\n            when '>' then $gt: parseFloat(val, 10)\n            when '<' then $lt: parseFloat(val, 10)\n            else\n              val = val.replace \/[^a-z\u00e6\u00f8\u00e50-9-_.* ]\/i, ''\n              switch op\n                when '^' then $regex: '^' + val, $options: 'i'\n                when '$' then $regex: val + '$', $options: 'i'\n                else $regex: val, $options: 'i'\n\n        else\n          res[key] = if isNaN(val) then val else parseFloat(val, 10)\n\n      res\n\n","old_contents":"    module.exports = MongoQS = (opts) ->\n      @ops = opts?.ops or ['!', '^', '$', '~', '>', '<']\n      @alias = opts?.alias or {}\n      @ignore = opts?.ignore or {}\n      @custom = opts?.custom or {}\n\n      for param, field of @custom\n        switch param\n          when 'bbox' then @custom.bbox = @customBBOX field\n          when 'near' then @custom.near = @customNear field\n          when 'after' then @custom.near = @customNear field\n\n      return @\n\n    MongoQS.prototype.customBBOX = (field) ->\n      (res, bbox) ->\n        bbox = bbox.split ','\n\n        if bbox.length is 4\n          val = parseFloat(val) for val in bbox\n\n          res[field] = $geoWithin: $geometry:\n            type: 'Polygon'\n            coordinates: [[\n              [bbox[0], bbox[1]]\n              [bbox[2], bbox[1]]\n              [bbox[2], bbox[3]]\n              [bbox[0], bbox[3]]\n              [bbox[0], bbox[1]]\n            ]]\n\n        return\n\n    MongoQS.prototype.customNear = (field) ->\n      (query, input) ->\n        input = input.split ','\n\n        if input.length is 2\n          val = parseFloat(val) for val in input\n\n          query[field] = $near: $geometry:\n            type: 'Point'\n            coordinates: input\n\n        return\n\n    MongoQS.prototype.customAfter = (field) ->\n      (query, input) ->\n\n        if not isNaN input\n          input = input + '000' if (input + '').length is 10\n          input = parseInt input\n\n        input = new Date input\n\n        if input.toString() isnt 'Invalid Date'\n          query[field] = $gte: input.toISOString()\n\n\n    MongoQS.prototype.parse = (query) ->\n      res = {}\n\n      for key, val of query\n        continue if @ignore[key]\n        continue if typeof val isnt 'string'\n        continue if not \/^[a-z\u00e6\u00f8\u00e50-9-_.]+$\/i.test key\n\n        key = @alias[key] if @alias[key]\n\nIf the value is empty we treat the query parameter as an\n[$exists](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/exists\/)\noperator.\n\n        if not val\n          res[key] = $exists: true\n\nCheck for supported operators in `@ops`. This is configured when\ninstanciating `MongoQS` and the defaults are `!`, `^`, `$`, `~`, `>`, and `<`.\n\n        else if val.charAt(0) in @ops\n          op = val.charAt(0)\n          val = val.substr(1)\n\n          res[key] = switch op\n            when '!'\n              if val\n                $ne: if isNaN(val) then val else parseFloat(val, 10)\n              else\n                $exists: false\n            when '>' then $gt: parseFloat(val, 10)\n            when '<' then $lt: parseFloat(val, 10)\n            else\n              val = val.replace \/[^a-z\u00e6\u00f8\u00e50-9-_.* ]\/i, ''\n              switch op\n                when '^' then $regex: '^' + val, $options: 'i'\n                when '$' then $regex: val + '$', $options: 'i'\n                else $regex: val, $options: 'i'\n\n        else\n          res[key] = if isNaN(val) then val else parseFloat(val, 10)\n\n      res\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cf7d6d34e58a097d89acdc2167e23ca94e539930","subject":"Added classes for game elements","message":"Added classes for game elements\n\nSigned-off-by: Diwank Singh <a78369447041e6bcf2913d083e4ed301785fc609@gmail.com>\n","repos":"creatorrr\/browser-bricks","old_file":"bricks.litcoffee","new_file":"bricks.litcoffee","new_contents":"Re: [Letter to a Source-Code-Reader](http:\/\/stewd.io\/pong\/lib\/pong.js)\n\nDear Stewart\n\nThanks for inspiring me and many like me with the wonders of js.\nWith all it's warts and issues, JS is still one of my favorite languages.\nI think simply by it's virtue of being the language of the web, it surpasses most others\nin it's ability to champion the spirit of openness.\n\nI have tried to keep this as simple as possible for the many awesome source code lovers\nto read, reuse and critique.\n\nThanks again for caring to write that letter in 2009. It made a kid smile.\n\nDiwank Singh\nJuly 2013\n\n*****\n\nBrowser Bricks\n==============\n\nAlright, let's get on with it.\n\nHelper Functions\n----------------\n\nFirst, let's define some helper functions for the application.\n\n    _ =   # _ namespace\n      # Extend objects\n      extend: (dest, src) ->\n        dest[k] = v for own k, v of src\n        dest\n\n      # Pick properties\n      pick: (obj, props) ->\n        result = {}\n        result[k] = obj[k] for k in props when obj[k]?\n\n        result\n\n      # UUID function (Copied shamelessly from https:\/\/gist.github.com\/bmc\/1893440)\n      uuid: ->\n        'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(\/[xy]\/g, (c) ->\n          r = Math.random() * 16 | 0\n          v = if c is 'x' then r else (r & 0x3|0x8)\n          v.toString(16)\n        )\n\n      # Simple serializer for flat objects\n      serialize: (obj, {sep, eq}, cb) ->\n        # Exec callback on all values of obj\n        obj[k] = cb v for own k, v of obj if cb?\n\n        # Return serialized obj\n        (\"#{ k }#{ eq }#{ v }\" for own k, v of obj).join sep\n\n      # Defer execution of function\n      defer: (fn, args...) -> window.setTimeout fn, 1, args...\n\n      # Clone object\n      clone: (obj) ->\n        # If object extend\n        if obj is Object obj\n          _.extend {}, obj\n\n        else  # Assume it's array otherwise\n          obj.splice 0\n\nInit Function\n-------------\n\nLet's write a global init function that can be used to register callbacks which are\nexecuted 'onload'.\n\n    # Callback register\n    init = do ->\n      # Store registered callbacks\n      callbacks = []\n\n      # Run callbacks in order registered\n      exec = -> fn?() for fn in callbacks\n\n      # Onload callback\n      onLoad = (fn) ->\n        window.removeEventListener 'load', init, false\n        fn?()\n\n      (cb) ->\n        if cb?\n          # Register callback\n          callbacks.push cb\n        else\n          # Defer execution until stack cleared\n          onLoad -> _.defer exec\n\n        false\n\n    # Attach DOM load listener\n    window.addEventListener 'load', init, false\n\nClass: Box\n----------\n\nNow, let's define a box that will be the basic building block for the game.\nAll the objects will inherit from this class.\n\n    class Box\n      # -- Private --\n\n      _settings:\n        # Default settings\n        height: 100\n        width:  200\n        top:    0\n        left:   0\n\n      _props:\n        # Fixed window props\n        toolbar:     false\n        directories: false\n        fullscreen:  false\n        location:    false\n        menubar:     false\n        resizable:   false\n        scrollbars:  false\n        status:      false\n\n      _window: null  # Empty window object\n      _url: '\/index.html' # Fixed to current page, renders based on context\n\n      _EDITABLE: -> Object.keys @constructor::_settings   # Editable settings\n\n      _update: (settings) ->\n        # Update settings\n        _.extend @_settings, (_.pick settings, @_EDITABLE())\n\n        # Adjust window props\n        @_window?.moveTo?   (@_get 'left'), (@_get 'top')\n        @_window?.resizeTo? (@_get 'width'), (@_get 'height')\n\n        # Return a copy of settings\n        @_getAll()\n\n      _get: (prop) -> @_settings[prop] if prop in @_EDITABLE()\n      _getAll: -> _.extend (_.clone @_settings), @_fixed\n\n      _getDefault: -> @constructor::_settings\n\n      # -- Public --\n\n      constructor: (namespace='', settings) ->\n        # Make a copy of default settings\n        @_settings = _.clone @_settings\n\n        # Override settings.\n        @_update settings\n\n        # Set random name with namespace\n        @id = \"#{ namespace }#{ if namespace then '-' else '' }#{ _.uuid() }\"\n        this\n\n      # Show window with settings.\n      show: ->\n        # Serialize options\n        opts = _.serialize @_getAll(), {sep: ',', eq: '='}, (v) ->\n          switch v\n            when false then 'no'\n            when true then 'yes'\n            else v+''\n\n        @_window = window.open @_url, @id, opts\n        this\n\n      # Hide the window.\n      hide: ->\n        @_window.close()\n        @_window = null\n        this\n\n      # Reset window settings.\n      reset: ->\n        @_update @_getDefault()\n        this\n\n      # Return or update window position coords.\n      position: (coords...) ->\n        # Set new coords\n        if coords.length then @_update\n          left: coords[0] ? @_getDefault().left  # x\n          top:  coords[1] ? @_getDefault().top   # y\n\n        # Return coords\n        _.pick @_getAll(), ['top', 'left']\n\n      # Return or update window dimensions.\n      size: (dimensions...) ->\n        # Set new dimensions\n        if dimensions.length then @_update\n          width:  dimensions[0] ? @_getDefault().width\n          height: dimensions[1] ? @_getDefault().height\n\n        # Return dimensions\n        _.pick @_getAll(), ['width', 'height']\n\nClass: Brick (Box)\n------------------\n\nNow let's use the class `Box` to design the `Brick` class which\nwill be used to render the bricks.\n\nIt's pretty much a useless box.\n\n    class Brick extends Box\n      constructor: (args...) -> super @type(), args...\n      type: -> 'brick'\n\nClass: Ball (Box)\n-----------------\n\nAlright, so the ball is a little tricky. It has to move two-\ndimensionally and bounce off of objects.\n\nSo, we need an instance that also stores it's velocity at any\ninstant and the methods to manipulate it.\n\n    class Ball extends Box\n      # -- Private --\n      _velocity: [0, 0]\n\n      # Override getDefault to get default velocity\n      _getDefault: -> _.extend super(), velocity: _.clone @_velocity\n\n      # -- Public --\n      constructor: (args...) ->\n        @_velocity = _.clone @_velocity\n        super @type(), args...\n\n      type: -> 'ball'\n\n      # Set or retrieve velocity\n      velocity: (vel...) ->\n        # Set new velocity\n        if vel.length then @_velocity = [\n          vel[0] ? @_getDefault().velocity[0]         # vx\n\n          # y velocity affects distance from top so inverted to preserve\n          # upward positive velocity direction.\n          (vel[1] ? @_getDefault().velocity[1]) * -1  # vy\n        ]\n\n        # Return velocity\n        _.clone @_velocity\n\nClass: Paddle (Ball)\n--------------------\n\nA paddle is basically an enlarged ball that's constrained to move in a\nstraight line.\n\n    class Paddle extends Ball\n      type: -> 'paddle'\n\n      # Override velocity to constrain 1D motion\n      velocity: (vx) ->\n        if vx?\n          super vx, @_velocity[1]\n        else\n          super()\n\nExports\n-------\n\nList of vars exported to global namespace.\n\n    _.extend window ? module.exports ? this,\n      _: _\n      init: init\n      Box: Box\n      Brick: Brick\n      Ball: Ball\n      Paddle: Paddle\n","old_contents":"Re: [Letter to a Source-Code-Reader](http:\/\/stewd.io\/pong\/lib\/pong.js)\n\nDear Stewart\n\nThanks for inspiring me and many like me with the wonders of js.\nWith all it's warts and issues, JS is still one of my favorite languages.\nI think simply by it's virtue of being the language of the web, it surpasses most others\nin it's ability to champion the spirit of openness.\n\nI have tried to keep this as simple as possible for the many awesome source code lovers\nto read, reuse and critique.\n\nThanks again for caring to write that letter in 2009. It made a kid smile.\n\nDiwank Singh\nJuly 2013\n\n*****\n\nBrowser Bricks\n==============\n\nAlright, let's get on with it.\n\nHelper Functions\n----------------\n\nFirst, let's define some helper functions for the application.\n\n    @_ = _ =   # _ namespace\n      # Extend objects\n      extend: (dest, src) ->\n        dest[k] = v for own k, v of src\n        dest\n\n      # Pick properties\n      pick: (obj, props) ->\n        result = {}\n        result[k] = obj[k] for k in props when obj[k]?\n\n        result\n\n      # UUID function (Copied shamelessly from https:\/\/gist.github.com\/bmc\/1893440)\n      uuid: ->\n        'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(\/[xy]\/g, (c) ->\n          r = Math.random() * 16 | 0\n          v = if c is 'x' then r else (r & 0x3|0x8)\n          v.toString(16)\n        )\n\n      # Simple serializer for flat objects\n      serialize: (obj, {sep, eq}, cb) ->\n        # Exec callback on all values of obj\n        obj[k] = cb v for own k, v of obj if cb?\n\n        # Return serialized obj\n        (\"#{ k }#{ eq }#{ v }\" for own k, v of obj).join sep\n\n      # Defer execution of function\n      defer: (fn, args...) -> window.setTimeout fn, 1, args...\n\n      # Clone object\n      clone: (obj) -> _.extend {}, obj\n\nInit Function\n-------------\n\nLet's write a global init function that can be used to register callbacks which are\nexecuted 'onload'.\n\n    # Callback register\n    @init = init = do ->\n      # Store registered callbacks\n      callbacks = []\n\n      # Run callbacks in order registered\n      exec = -> fn?() for fn in callbacks\n\n      # Onload callback\n      onLoad = (fn) ->\n        window.removeEventListener 'load', init, false\n        fn?()\n\n      (cb) ->\n        if cb?\n          # Register callback\n          callbacks.push cb\n        else\n          # Defer execution until stack cleared\n          onLoad -> _.defer exec\n\n        false\n\n    # Attach DOM load listener\n    window.addEventListener 'load', init, false\n\nClass: Box\n----------\n\nNow, let's define a box that will be the basic building block for the game.\nAll the objects will inherit from this class.\n\n    class Box\n      _EDITABLE: ['height', 'width', 'top', 'left']   # Editable settings\n      _settings:\n        # Default settings\n        height: 100\n        width:  200\n        top:    0\n        left:   0\n\n        # Fixed props\n        toolbar:     false\n        directories: false\n        fullscreen:  false\n        location:    false\n        menubar:     false\n        resizable:   false\n        scrollbars:  false\n        status:      false\n\n      _window: null  # Empty window object\n\n      constructor: (@url, settings) ->\n        # Override settings.\n        @_update settings\n\n        # Set random name\n        @id = _.uuid()\n        this\n\n      # -- Private --\n\n      _update: (settings) ->\n        # Update settings\n        _.extend @_settings, (_.pick settings, @_EDITABLE)\n\n        # Adjust window props\n        @_window?.moveTo (@_get 'left'), (@_get 'top')\n        @_window?.resizeTo (@_get 'width'), (@_get 'height')\n\n        # Return a copy of settings\n        @_getAll()\n\n      _get: (prop) -> @_settings[prop] if prop in @_EDITABLE\n      _getAll: -> _.clone @_settings\n\n      _getDefaults: -> Box::_settings\n\n      # -- Public --\n\n      # Show window with settings.\n      show: ->\n        # Serialize options\n        opts = _.serialize @_getAll(), {sep: ',', eq: '='}, (v) ->\n          switch v\n            when false then 'no'\n            when true then 'yes'\n            else v+''\n\n        @_window = window.open @url, @id, opts\n        this\n\n      # Hide the window.\n      hide: ->\n        @_window.close()\n        @_window = null\n        this\n\n      # Reset window settings.\n      reset: ->\n        @_update @_getDefaults()\n        this\n\n      # Return or update window position coords.\n      position: (coords...) ->\n        # Set new coords\n        if coords.length then @_update\n          left: coords[0] ? @_getDefaults().left  # x\n          top:  coords[1] ? @_getDefaults().top   # y\n\n        # Return coords\n        _.pick @_getAll(), ['top', 'left']\n\n      # Return or update window dimensions.\n      size: (dimensions...) ->\n        # Set new dimensions\n        if dimensions.length then @_update\n          width:  dimensions[0] ? @_getDefaults().width\n          height: dimensions[1] ? @_getDefaults().height\n\n        # Return dimensions\n        _.pick @_getAll(), ['width', 'height']\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"01c3b27c888f5b45284d9fb5df7ebc2c2a37d182","subject":"bugfix, cleanup","message":"bugfix, cleanup\n","repos":"nickfargo\/restate","old_file":"src\/state.litcoffee","new_file":"src\/state.litcoffee","new_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n\n        @_ or = new @Content\n        @__dispatch_table__ = {}\n\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneCategory   _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method for this state. If an optional `out` object is\nprovided, the appropriate `context` for the method is also delivered as a\nproperty of `out`; as usual, `context` is confined to the local state tree.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out ) ->\n        realized = ~@attributes & VIRTUAL\n\n        loop # once\n\nFirst seek the named method locally.\n\n          if realized\n            method = @_?.methods?[ methodName ]\n            if method is rootNoop then method = null\n            if method? then context = this\n            else if record = @__dispatch_table__?[ methodName ]\n              [ method, context ] = record\n\n            break if method?\n\nIf no method is held locally, start traversing, first up the protostate chain.\n\n          if ( viaProto = via & VIA_PROTO ) and\n          method = @protostate()?.method methodName, VIA_PROTO, out\n            context = this; inherited = yes; break\n\nIf no method is found yet, continue traversing up the superstate chain.\n\n          if via & VIA_SUPER and\n          method = @superstate?.method methodName, VIA_SUPER | viaProto, out\n            inherited = yes; break\n\nThe method cannot be found.\n\n          method = context = null\n          break # always\n\nIf `method` is a function, it is not state-bound, so `context` is unnecessary.\nIf instead `method` represents a state-bound function, then it will be boxed,\nso unbox it, and hang on to `context`.\n\n        if typeof method is 'function'\n          context = null\n        else if method?.type is 'state-bound-function'\n          method = method.fn\n\nExport `method` and `context` together if the `out` reference was provided.\n\n> Callers who know that `method` will be unbound need not provide an `out`.\n\n        if out?\n          out.method = method\n          out.context = context\n\nIff `this` is a realized `State`, inherited lookup results can be memoized in\nthe local dispatch table.\n\n        if realized and method? and out? and inherited\n          @__dispatch_table__?[ methodName ] = [ method, context ]\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state. The provided `fn` may be any of:\n\n  1.  A proper function, which will be called in the context of `@owner`;\n  2.  A boxing of a *bound* function as prepared by `state.bind`, which will\n      cause the boxed function to be called in the context of either `this`\n      `State` or the *epistate* inheriting the method;\n  3.  A boxing of a *fixed* function as prepared by `state.fix`, whose boxed\n      function will be closed over hard references to `this` as `autostate`,\n      and to the *protostate* of `this`, as `protostate`.\n\n> See also: `state.bind`, `state.fix`\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` boxes a *state-fixed* function, then partially apply that function to\nextract the actual method, closed over references to the locality of `this`.\n\n        if typeof fn is 'object' and fn.type is 'state-fixed-function'\n          fn = fn.fn this, @protostate()\n\n        throw TypeError unless typeof fn is 'function' or\n          fn?.type is 'state-bound-function'\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root.method methodName, VIA_NONE\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n            root.addMethod methodName, ownerMethod\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context.\n\nIf the named method does not exist locally and cannot be inherited, then\n`noSuchMethod` events are emitted, and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n\nFirst try to resolve the method quickly from the local dispatch table.\n\n        if record = @__dispatch_table__?[ methodName ]\n          [ method, context ] = record\n\nResort to a proper lookup if the fast way turns up nothing.\n\n        unless method?\n          if method = @method methodName, VIA_ALL, out = {}\n            { context } = out\n\nBail out gracefully if the method definitively cannot be resolved.\n\n          else\n            @emit 'noSuchMethod', [ methodName, args ]\n            @emit 'noSuchMethod:' + methodName, args\n            return\n\nIf at this point a `context` is provided, this means that `method` is a\nstate-bound function, and `context` will be the appropriately bound `State`. If\nno `context` exists, this means that `method` is a typical non-state-bound\nfunction, which is meant to be invoked in the usual fashion, just as if it were\ncalled directly as a method of `this` state\u2019s `owner`.\n\n        method.apply context or @owner, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","old_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n\n        @_ or = new @Content\n        @__dispatch_table__ = {}\n\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneCategory   _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method for this state. If an optional `out` object is\nprovided, the appropriate `context` for the method is also delivered as a\nproperty of `out`; as usual, `context` is confined to the local state tree.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out ) ->\n        realized = @attributes & VIRTUAL is 0\n\n        loop # once\n\nFirst seek the named method locally.\n\n          if realized\n            method = @_?.methods?[ methodName ]\n            if method is rootNoop then method = null\n            if method? then context = this\n            else [ method, context ] = @__dispatch_table__?[ methodName ]\n            break if method?\n\nIf no method is held locally, start traversing, first up the protostate chain.\n\n          if ( viaProto = via & VIA_PROTO ) and\n          method = @protostate()?.method methodName, VIA_PROTO, out\n            context = this; inherited = yes; break\n\nIf no method is found yet, continue traversing up the superstate chain.\n\n          if via & VIA_SUPER and\n          method = @superstate?.method methodName, VIA_SUPER | viaProto, out\n            inherited = yes; break\n\nThe method cannot be found.\n\n          method = context = null\n          break # always\n\nIf `method` is a function, it is not state-bound, so `context` is unnecessary.\nIf instead `method` represents a state-bound function, then it will be boxed,\nso unbox it, and hang on to `context`.\n\n        if typeof method is 'function'\n          context = null\n        else if method?.type is 'state-bound-function'\n          method = method.fn\n\nExport `method` and `context` together if the `out` reference was provided.\n\n> Callers who know that `method` will be unbound need not provide an `out`.\n\n        if out?\n          out.method = method\n          out.context = context\n\nIff `this` is a realized `State`, inherited lookup results can be memoized in\nthe local dispatch table.\n\n        if realized and method? and out? and inherited\n          @__dispatch_table__?[ methodName ] = [ method, context ]\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state. The provided `fn` may be any of:\n\n  1.  A proper function, which will be called in the context of `@owner`;\n  2.  A boxing of a *bound* function as prepared by `state.bind`, which will\n      cause the boxed function to be called in the context of either `this`\n      `State` or the *epistate* inheriting the method;\n  3.  A boxing of a *fixed* function as prepared by `state.fix`, whose boxed\n      function will be closed over hard references to `this` as `autostate`,\n      and to the *protostate* of `this`, as `protostate`.\n\n> See also: `state.bind`, `state.fix`\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` boxes a *state-fixed* function, then partially apply that function to\nextract the actual method, closed over references to the locality of `this`.\n\n        if typeof fn is 'object' and fn.type is 'state-fixed-function'\n          fn = fn.fn this, @protostate()\n\n        throw TypeError unless typeof fn is 'function'\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root.method methodName, VIA_NONE\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n            root.addMethod methodName, ownerMethod\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context.\n\nIf the named method does not exist locally and cannot be inherited, then\n`noSuchMethod` events are emitted, and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n\nFirst try to resolve the method quickly from the local dispatch table.\n\n        [ method, context ] = ref if ref = @__dispatch_table__?[ methodName ]\n\nResort to a proper lookup if the fast way turns up nothing.\n\n        unless method?\n          if method = @method methodName, VIA_ALL, out = {}\n            { context } = out\n\nBail out gracefully if the method definitively cannot be resolved.\n\n          else\n            @emit 'noSuchMethod', [ methodName, args ]\n            @emit 'noSuchMethod:' + methodName, args\n            return\n\nIf at this point a `context` is provided, this means that `method` is a\nstate-bound function, and `context` will be the appropriately bound `State`. If\nno `context` exists, this means that `method` is a typical non-state-bound\nfunction, which is meant to be invoked in the usual fashion, just as if it were\ncalled directly as a method of `this` state\u2019s `owner`.\n\n        method.apply context or @owner, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d4cdb8b0219cdaa363d92b8dc03a111d51523429","subject":"Minor formatting and description fix","message":"Minor formatting and description fix\n","repos":"o2platform\/fluentnode,modulexcite\/fluentnode,o2platform\/fluentnode,modulexcite\/fluentnode","old_file":"src\/js-native\/String.litcoffee","new_file":"src\/js-native\/String.litcoffee","new_contents":"Methods that extend the native Javascript String class\n\nHere is the list of 'default' String global objects:\n[Global_Objects\/String](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/String)\n\nNote that there are more String Extension Methods (they exist inside their main dependency: crypto, path, fs)\n\nmethods\n\ntwin methods: add\n\n@.**append** value\n\n    String::append = (value)->\n        @ + if value then value else ''\n\n    String::add = String::append\n\n@.**after** value\n\n    String::after = (value)->\n      if ((index = @.indexOf(    value)) == -1 )\n        ''\n      else\n        @.substr(index + value.size())\n\n@.**after_Last** value\n\n    String::after_Last = (value)->\n      if ((index = @.lastIndexOf(value)) == -1 )\n        ''\n      else\n        @.substr(index + value.size())\n\n@.**before** value\n\n    String::before = (value)->\n      @.substring(0,@.indexOf(value))\n\n@.**before_Last** value\n\n    String::before_Last = (value)->\n      @.substring(0,@.lastIndexOf(value))\n\n@.**contains** value\n\nChecks that ```value``` is inside @.\n\nIf ```value``` is an Array, then all elements are expected to be found inside @\n\nIf ```value``` is an RegExp then checks if it matches @\n\n    String::contains = (value)->\n      if value instanceof RegExp\n        regex = new RegExp(value)\n        return regex.exec(@) isnt null\n      if value instanceof Array\n        for item in value\n          if @.indexOf(item) is -1\n            return false\n        return true\n      @.indexOf(value) > -1\n\n@.**ends_With** value\n\n    String::ends_With = (value)->\n      if not value\n        false\n      else\n        @.valueOf().slice(-value.length) is value\n\n\n@.**is** value\n\nReturns true if ```@``` is equal to ```value```\n\n    String::is = (value)->\n      @.valueOf() is value\n\n@.**is_Not** value\n\nReturns true if ```@``` is NOT equal to ```value```\n\ntwin methods: isnt\n\n    String::is_Not = (value)->\n      @.valueOf() isnt value\n\n    String::isnt = String::is_Not\n\n@.**lines**\n\nreturns @ split by '\/n'\n\ntwin methods: split_Lines\n\n    String::lines = ()->\n      @.split(\/\\r\\n|[\\n\\r\\u0085\\u2028\\u2029]\/g)\n\n    String::split_Lines = String::lines\n\n@.**lower**\n\nreturns @ in lowercase\n\n    String::lower = ()->\n      @.toLowerCase()\n\n@.**not_Contains** value\n\n    String::not_Contains  = (value)->\n      @.indexOf(value) == -1\n\n@.**only_Letters**\n\nReturns a string where all chars that are not an letter (uppper or lower case) are replaced\nwith a - (dash)\n\nThe letters capitalization is not modified\n\n    String::only_Letters =\n      ()-> @.replace(\/[^a-zA-Z]\/gi, '-')\n\n@.**only_Numbers**\n\nReturns a string where all chars that are not an number are replaced\nwith a - (dash)\n\n    String::only_Numbers = ()->\n      @.replace(\/[^0-9]\/gi, '-').lower()\n\n@.**remove** value\n\nRemoves all instances of **value**\n\nNote: ```@.replace(value,'')``` doesn't work because it\nonly removes the first occurance\n\n    String::remove = (value)->\n\n      result = @\n      while result.contains(value)\n        result = result.replace(value,'')\n      result\n\n@.**repeat** value\n\nRepeats @ ```value``` times\n\nNote: the implementation uses a while loop in order to handle ok cases when\nvalue is negative or weird\n\n    String::repeat = (value)->\n      result = ''\n      if typeof(value) is 'number'\n        while value > 0\n          result += @\n          value--\n      return result\n\n@.**size**\n\n    String::size = ()->\n      @.length\n\n@.**starts_With** value\n\n    String::starts_With = (value)->\n      if not value\n        false\n      else\n        @.valueOf().slice(0,value.length) is value\n\n@.**to_Safe_String**\n\nReturns a string where all chars that are dont match the regex are replaced\nwith a - (dash)\n\nThe current regex allows\n- lowercase letters\n- uppercase letters\n- numbers\n- the chars: , - _  (comma, dash and underscore)\n\nThe letters capitalization is modified, with the returned string being converted\ninto lowercase\n\n    String::to_Safe_String = ()->\n      @.replace(\/[^a-zA-Z0-9.\\-_]\/gi, '-').lower()\n\n@.**trim**\n\n    String::trim = ()->\n      @.replace(\/^\\s+|\\s+$\/g, '')\n\n@.**twice**\n\n    String::twice = ()->\n      @ + @\n\n@.**upper**\n\n    String::upper = ()->\n      @.toUpperCase()\n\n@.**json_Parse**\n\nreturns the object representation of the the json string @\n\nNote: if there is a prob parsing the json an empty object will be returned (use **json_Valid** to check for well formed json)\n\n    String::json_Parse = ()->\n      try\n        JSON.parse(@)\n      catch\n        {}\n\n@.**json_Valid**\n\nReturns true if @ can be deserialised ok into a json object\n\n    String::json_Valid = ()->\n      try\n        JSON.parse(@)\n        true\n      catch\n        false\n\n@.**is_Local_Url**\n\nReturns a boolean indicating if the URL is local to Host or not. It helps to prevent Open redirects attacks. Backported from http:\/\/www.asp.net\/mvc\/overview\/security\/preventing-open-redirection-attacks\n\n    String::is_Local_Url = ()->\n      url = @.url_Decode()\n      if(url? && url.length >0)\n        return  (\n                  (url[0] == '\/' &&\n                  (url.length == 1 ||(url[1] != '\/' && url[1] != '\\\\'))) || # validates \"\/\" or \"\/foo\" but not \"\/\/\" or \"\/\\\"\n                  (url.length > 1 && url[0] == '~' && url[1] == '\/')        # validates  \"~\/\" or \"~\/foo\"\n                );\n      else\n        return false\n---\nback to [index](index.html)\n","old_contents":"Methods that extend the native Javascript String class\n\nHere is the list of 'default' String global objects:\n[Global_Objects\/String](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/String)\n\nNote that there are more String Extension Methods (they exist inside their main dependency: crypto, path, fs)\n\nmethods\n\ntwin methods: add\n\n@.**append** value\n\n    String::append = (value)->\n        @ + if value then value else ''\n\n    String::add = String::append\n\n@.**after** value\n\n    String::after = (value)->\n      if ((index = @.indexOf(    value)) == -1 )\n        ''\n      else\n        @.substr(index + value.size())\n\n@.**after_Last** value\n\n    String::after_Last = (value)->\n      if ((index = @.lastIndexOf(value)) == -1 )\n        ''\n      else\n        @.substr(index + value.size())\n\n@.**before** value\n\n    String::before = (value)->\n      @.substring(0,@.indexOf(value))\n\n@.**before_Last** value\n\n    String::before_Last = (value)->\n      @.substring(0,@.lastIndexOf(value))\n\n@.**contains** value\n\nChecks that ```value``` is inside @.\n\nIf ```value``` is an Array, then all elements are expected to be found inside @\n\nIf ```value``` is an RegExp then checks if it matches @\n\n    String::contains = (value)->\n      if value instanceof RegExp\n        regex = new RegExp(value)\n        return regex.exec(@) isnt null\n      if value instanceof Array\n        for item in value\n          if @.indexOf(item) is -1\n            return false\n        return true\n      @.indexOf(value) > -1\n\n@.**ends_With** value\n\n    String::ends_With = (value)->\n      if not value\n        false\n      else\n        @.valueOf().slice(-value.length) is value\n\n\n@.**is** value\n\nReturns true if ```@``` is equal to ```value```\n\n    String::is = (value)->\n      @.valueOf() is value\n\n@.**is_Not** value\n\nReturns true if ```@``` is NOT equal to ```value```\n\ntwin methods: isnt\n\n    String::is_Not = (value)->\n      @.valueOf() isnt value\n\n    String::isnt = String::is_Not\n\n@.**lines**\n\nreturns @ split by '\/n'\n\ntwin methods: split_Lines\n\n    String::lines = ()->\n      @.split(\/\\r\\n|[\\n\\r\\u0085\\u2028\\u2029]\/g)\n\n    String::split_Lines = String::lines\n\n@.**lower**\n\nreturns @ in lowercase\n\n    String::lower = ()->\n      @.toLowerCase()\n\n@.**not_Contains** value\n\n    String::not_Contains  = (value)->\n      @.indexOf(value) == -1\n\n@.**only_Letters**\n\nReturns a string where all chars that are not an letter (uppper or lower case) are replaced\nwith a - (dash)\n\nThe letters capitalization is not modified\n\n    String::only_Letters =\n      ()-> @.replace(\/[^a-zA-Z]\/gi, '-')\n\n@.**only_Numbers**\n\nReturns a string where all chars that are not an number are replaced\nwith a - (dash)\n\n    String::only_Numbers = ()->\n      @.replace(\/[^0-9]\/gi, '-').lower()\n\n@.**remove** value\n\nRemoves all instances of **value**\n\nNote: ```@.replace(value,'')``` doesn't work because it\nonly removes the first occurance\n\n    String::remove = (value)->\n\n      result = @\n      while result.contains(value)\n        result = result.replace(value,'')\n      result\n\n@.**repeat** value\n\nRepeats @ ```value``` times\n\nNote: the implementation uses a while loop in order to handle ok cases when\nvalue is negative or weird\n\n    String::repeat = (value)->\n      result = ''\n      if typeof(value) is 'number'\n        while value > 0\n          result += @\n          value--\n      return result\n\n@.**size**\n\n    String::size = ()->\n      @.length\n\n@.**starts_With** value\n\n    String::starts_With = (value)->\n      if not value\n        false\n      else\n        @.valueOf().slice(0,value.length) is value\n\n@.**to_Safe_String**\n\nReturns a string where all chars that are dont match the regex are replaced\nwith a - (dash)\n\nThe current regex allows\n- lowercase letters\n- uppercase letters\n- numbers\n- the chars: , - _  (comma, dash and underscore)\n\nThe letters capitalization is modified, with the returned string being converted\ninto lowercase\n\n    String::to_Safe_String = ()->\n      @.replace(\/[^a-zA-Z0-9.\\-_]\/gi, '-').lower()\n\n@.**trim**\n\n    String::trim = ()->\n      @.replace(\/^\\s+|\\s+$\/g, '')\n\n@.**twice**\n\n    String::twice = ()->\n      @ + @\n\n@.**upper**\n\n    String::upper = ()->\n      @.toUpperCase()\n\n@.**json_Parse**\n\nreturns the object representation of the the json string @\n\nNote: if there is a prob parsing the json an empty object will be returned (use **json_Valid** to check for well formed json)\n\n    String::json_Parse = ()->\n      try\n        JSON.parse(@)\n      catch\n        {}\n\n@.**json_Valid**\n\nReturns true if @ can be deserialised ok into a json object\n\n    String::json_Valid = ()->\n      try\n        JSON.parse(@)\n        true\n      catch\n        false\n\n@.**isLocalUrl**\n\nReturns a boolean indicating if the URL is local to Host or not. It helps to prevent Open redirects attacks. Back ported from http:\/\/www.asp.net\/mvc\/overview\/security\/preventing-open-redirection-attacks\n\n    String::is_Local_Url = ()->\n      url = @.url_Decode()\n      if(url? && url.length >0)\n        return  (\n                  (url[0] == '\/' &&\n                  (url.length == 1 ||(url[1] != '\/' && url[1] != '\\\\'))) || # validates \"\/\" or \"\/foo\" but not \"\/\/\" or \"\/\\\"\n                  (url.length > 1 && url[0] == '~' && url[1] == '\/')        # validates  \"~\/\" or \"~\/foo\"\n                );\n      else\n        return false\n---\nback to [index](index.html)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"78c482cd9f1fd18fc4a3c59eb890a9d8d1cb71fa","subject":"in. jokes","message":"in. jokes\n","repos":"nomilous\/in.","old_file":"in.jokes\/spandex.litcoffee","new_file":"in.jokes\/spandex.litcoffee","new_contents":"#! \/usr\/bin\/env coffee\n\nThe expander supports multiple asyncronous functions that `appear = syncronous()`.\n\nTo achieve that it needed to do some peculiar things.\n\n__Very peculiar!__\n\nThings that [some](https:\/\/www.google.co.za\/search?q=uptight+people&espv=2&biw=1063&bih=1058&source=lnms&tbm=isch&sa=X&ei=q6CJVYTyIpPB7Ab95YLQBA&ved=0CAYQ_AUoAQ#tbm=isch&q=uptight) may disaprove of.\n\nLike wearing [spandex in public](https:\/\/www.google.co.za\/search?q=spandex+in+public+nuts&espv=2&biw=1063&bih=1058&tbm=isch&source=lnms&sa=X&ei=5Z-JVez6KeWY7gbl_oCYAg&ved=0CAYQ_AUoAQ#tbm=isch&q=spandex+in+public).\n\nIt broke the [expan](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/expander.js)sion (to be [eval](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/compiler.js#L57)'d) [into pieces and substituted](https:\/\/www.google.co.za\/search?q=into+pieces+and+substituted+an+array&es_sm=91&source=lnms&tbm=isch&sa=X&ei=laOJVbKFOqKM7Abs4Y_ACw&ved=0CAkQ_AUoAw&biw=1063&bih=1058#tbm=isch&q=into+pieces+and+substituted) an array ($e[n]) for each function's results.\n\nThen pipelined the fuctions to produce ($e) so that the final eval\n\n`{{ i for an.i in ( an = $e[0] ) }}`\n\nWhere `$e[0]` was originally `async(fn1)`\n\n`{{ i for an.i in ( an = async(fn1) ) }}`\n\nThe results of the division are loaded into a variable called `spandex`...\n\nWhich happens to be in scope at eval.\n\n    require('..\/')\n\n    $$in (arg) ->\n\n        ### in(arg).as {{1}}###\n\n        console.log arg\n\n\n#### Return and finish later - few bits still to wire together\n","old_contents":"#! \/usr\/bin\/env coffee\n\nThe expander supports multiple asyncronous functions.\n\nTo achieve that it needed to do some peculiar things.\n\n__Very peculiar!__\n\nThings that [some](https:\/\/www.google.co.za\/search?q=uptight+people&espv=2&biw=1063&bih=1058&source=lnms&tbm=isch&sa=X&ei=q6CJVYTyIpPB7Ab95YLQBA&ved=0CAYQ_AUoAQ#tbm=isch&q=uptight) may disaprove of.\n\nLike wearing [spandex in public](https:\/\/www.google.co.za\/search?q=spandex+in+public+nuts&espv=2&biw=1063&bih=1058&tbm=isch&source=lnms&sa=X&ei=5Z-JVez6KeWY7gbl_oCYAg&ved=0CAYQ_AUoAQ#tbm=isch&q=spandex+in+public).\n\nIt broke the [expan](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/expander.js)sion (to be [eval](https:\/\/github.com\/nomilous\/in.\/blob\/master\/lib\/compiler.js#L57)'d) [into pieces and substituted](https:\/\/www.google.co.za\/search?q=into+pieces+and+substituted+an+array&es_sm=91&source=lnms&tbm=isch&sa=X&ei=laOJVbKFOqKM7Abs4Y_ACw&ved=0CAkQ_AUoAw&biw=1063&bih=1058#tbm=isch&q=into+pieces+and+substituted) an array ($e[n]) for each function's results.\n\nThen pipelined the fuctions to produce ($e) so that the final eval\n\n`{{ i for an.i in ( an = $e[0] ) }}`\n\nWhere `$e[0]` was originally `async(fn1)`\n\n`{{ i for an.i in ( an = async(fn1) ) }}`\n\nThe results of the division are loaded into a variable called `spandex`...\n\nWhich happens to be in scope at eval.\n\n    require('..\/')\n\n    $$in (arg) ->\n\n        ### in(arg).as {{1}}###\n\n        console.log arg\n\n\n#### Return and finish later - few bits still to wire together\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3a63aa12653833546f662a63c6ece24346a3d28b","subject":"Added an experimental invert function to the matrix module.","message":"Added an experimental invert function to the matrix module.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat","old_file":"src\/matrix.litcoffee","new_file":"src\/matrix.litcoffee","new_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    tempVector = []\n    tempVectorFrom = []\n    tempVectorTo = []\n    fromTemp = []\n    toTemp = []\n    tempVectorX = []\n    tempVectorY = []\n    tempVectorZ = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            module.exports.multiply output, temp3, output\n            return\n\n    vector = require \".\/vector.litcoffee\"\n            \n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\nGiven a vector specifying a translation and a matrix to translate, calling the \n\"translate\" property applies that translation to that matrix.\n            \n        translate: (vector, output) ->\n            output[3] += vector[0]\n            output[7] += vector[1]\n            output[11] += vector[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \nGiven a matrix, input vector and output vector, calling the \"applyToVector\"\nproperty writes the input vector transformed by the matrix to the output vector.\n        \n        applyToVector: (matrix, input, output) ->\n            vector.copy input, tempVector\n            output[0] = tempVector[0] * matrix[0] + tempVector[1] * matrix[1] + tempVector[2] * matrix[2] + matrix[3]\n            output[1] = tempVector[0] * matrix[4] + tempVector[1] * matrix[5] + tempVector[2] * matrix[6] + matrix[7]\n            output[2] = tempVector[0] * matrix[8] + tempVector[1] * matrix[9] + tempVector[2] * matrix[10] + matrix[11]\n            return\n            \nGiven a matrix and output vector, calling the \"getTranslation\" property writes\nthe translation applied by the matrix to the output vector.\n\n        getTranslation: (matrix, output) ->\n            output[0] = matrix[3]\n            output[1] = matrix[7]\n            output[2] = matrix[11]\n\nGiven a matrix and output vector, calling the \"getX\" property writes the vector\nof the matrix's X axis (a scaled normal) to the output vector.\n\n        getX: (matrix, output) ->\n            output[0] = matrix[0]\n            output[1] = matrix[4]\n            output[2] = matrix[8]\n\nGiven a matrix and output vector, calling the \"getY\" property writes the vector\nof the matrix's Y axis (a scaled normal) to the output vector.\n\n        getY: (matrix, output) ->\n            output[0] = matrix[1]\n            output[1] = matrix[5]\n            output[2] = matrix[9]\n            \nGiven a matrix and output vector, calling the \"getZ\" property writes the vector\nof the matrix's Z axis (a scaled normal) to the output vector.\n\n        getZ: (matrix, output) ->\n            output[0] = matrix[2]\n            output[1] = matrix[6]\n            output[2] = matrix[10]\n            \n# setTranslation\n\n- A vector specifying the translation to set.\n- A matrix to set the translation of.\n\nOverwrites the translation of the matrix with the content of the given vector.\n\n        setTranslation: (output, matrix) ->\n            matrix[3] = output[0]\n            matrix[7] = output[1]\n            matrix[11] = output[2]\n\n# setX\n\n- A vector specifying the X axis vector to set.\n- A matrix to set the X axis vector of.\n\nOverwrites the X axis of the matrix with the content of the given vector.\n\n        setX: (output, matrix) ->\n            matrix[0] = output[0]\n            matrix[4] = output[1]\n            matrix[8] = output[2]\n\n# setY\n\n- A vector specifying the Y axis vector to set.\n- A matrix to set the Y axis vector of.\n\nOverwrites the Y axis of the matrix with the content of the given vector.\n\n        setY: (output, matrix) ->\n            matrix[1] = output[0]\n            matrix[5] = output[1]\n            matrix[9] = output[2]\n\n# setZ\n\n- A vector specifying the Z axis vector to set.\n- A matrix to set the Z axis vector of.\n\nOverwrites the Z axis of the matrix with the content of the given vector.\n\n        setZ: (output, matrix) ->\n            matrix[2] = output[0]\n            matrix[6] = output[1]\n            matrix[10] = output[2]\n            \n# interpolate\n\n- An input matrix to interpolate from.\n- An input matrix to interpolate to.\n- A number specifying how far along to interpolate; \"0\" is \"from\" and \"1\" is \n  \"to\".\n- An output matrix.\n\nAttempts to perform a somewhat crude interpolation between the two matrices\nwhich is not very linear.  Good enough for smoothing over small changes.\nPrioritizes the Z and Y axes over the X axis when ensuring orthogonal.\n\n        interpolate: (from, to, alpha, output) ->       \n            module.exports.copy from, fromTemp\n            module.exports.copy to, toTemp\n            module.exports.identity output\n            module.exports.getTranslation fromTemp, tempVectorFrom\n            module.exports.getTranslation toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            module.exports.setTranslation tempVector, output\n            \n            module.exports.getX fromTemp, tempVectorFrom\n            module.exports.getX toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            vector.normalize tempVector, tempVectorX, true  \n            \n            module.exports.getY fromTemp, tempVectorFrom\n            module.exports.getY toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVectorY\n            \n            vector.cross tempVectorX, tempVectorY, tempVectorZ\n            vector.normalize tempVectorZ, tempVectorZ\n            vector.cross tempVectorZ, tempVectorX, tempVectorY\n            vector.normalize tempVectorY, tempVectorY\n            \n            module.exports.setX tempVectorX, output\n            module.exports.setY tempVectorY, output\n            module.exports.setZ tempVectorZ, output\n            return\n            \n# invert\n\n- An input matrix to invert.\n- An output matrix to write to.\n\nAttempts to calculate the inverse of a matrix by negating its translation and\ntransposing its X, Y and Z axes.  Will not work if any scaling has been applied.\n\n        invert: (input, output) ->\n            module.exports.copy input, fromTemp\n            module.exports.getX fromTemp, tempVectorX\n            module.exports.getY fromTemp, tempVectorY\n            module.exports.getZ fromTemp, tempVectorZ\n            module.exports.getTranslation fromTemp, tempVector\n            output[0] = input[0]\n            output[1] = input[4]\n            output[2] = input[8]\n            output[3] = -vector.dot tempVector, tempVectorX\n            \n            output[4] = input[1]\n            output[5] = input[5]\n            output[6] = input[9]\n            output[7] = -vector.dot tempVector, tempVectorY\n            \n            output[8] = input[2]\n            output[9] = input[6]\n            output[10] = input[10]\n            output[11] = -vector.dot tempVector, tempVectorZ\n            \n            output[12] = 0\n            output[13] = 0\n            output[14] = 0\n            output[15] = 1\n            \n            return\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","old_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    tempVector = []\n    tempVectorFrom = []\n    tempVectorTo = []\n    fromTemp = []\n    toTemp = []\n    tempVectorX = []\n    tempVectorY = []\n    tempVectorZ = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            module.exports.multiply output, temp3, output\n            return\n\n    vector = require \".\/vector.litcoffee\"\n            \n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\nGiven a vector specifying a translation and a matrix to translate, calling the \n\"translate\" property applies that translation to that matrix.\n            \n        translate: (vector, output) ->\n            output[3] += vector[0]\n            output[7] += vector[1]\n            output[11] += vector[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \nGiven a matrix, input vector and output vector, calling the \"applyToVector\"\nproperty writes the input vector transformed by the matrix to the output vector.\n        \n        applyToVector: (matrix, input, output) ->\n            vector.copy input, tempVector\n            output[0] = tempVector[0] * matrix[0] + tempVector[1] * matrix[1] + tempVector[2] * matrix[2] + matrix[3]\n            output[1] = tempVector[0] * matrix[4] + tempVector[1] * matrix[5] + tempVector[2] * matrix[6] + matrix[7]\n            output[2] = tempVector[0] * matrix[8] + tempVector[1] * matrix[9] + tempVector[2] * matrix[10] + matrix[11]\n            return\n            \nGiven a matrix and output vector, calling the \"getTranslation\" property writes\nthe translation applied by the matrix to the output vector.\n\n        getTranslation: (matrix, output) ->\n            output[0] = matrix[3]\n            output[1] = matrix[7]\n            output[2] = matrix[11]\n\nGiven a matrix and output vector, calling the \"getX\" property writes the vector\nof the matrix's X axis (a scaled normal) to the output vector.\n\n        getX: (matrix, output) ->\n            output[0] = matrix[0]\n            output[1] = matrix[4]\n            output[2] = matrix[8]\n\nGiven a matrix and output vector, calling the \"getY\" property writes the vector\nof the matrix's Y axis (a scaled normal) to the output vector.\n\n        getY: (matrix, output) ->\n            output[0] = matrix[1]\n            output[1] = matrix[5]\n            output[2] = matrix[9]\n            \nGiven a matrix and output vector, calling the \"getZ\" property writes the vector\nof the matrix's Z axis (a scaled normal) to the output vector.\n\n        getZ: (matrix, output) ->\n            output[0] = matrix[2]\n            output[1] = matrix[6]\n            output[2] = matrix[10]\n            \n# setTranslation\n\n- A vector specifying the translation to set.\n- A matrix to set the translation of.\n\nOverwrites the translation of the matrix with the content of the given vector.\n\n        setTranslation: (output, matrix) ->\n            matrix[3] = output[0]\n            matrix[7] = output[1]\n            matrix[11] = output[2]\n\n# setX\n\n- A vector specifying the X axis vector to set.\n- A matrix to set the X axis vector of.\n\nOverwrites the X axis of the matrix with the content of the given vector.\n\n        setX: (output, matrix) ->\n            matrix[0] = output[0]\n            matrix[4] = output[1]\n            matrix[8] = output[2]\n\n# setY\n\n- A vector specifying the Y axis vector to set.\n- A matrix to set the Y axis vector of.\n\nOverwrites the Y axis of the matrix with the content of the given vector.\n\n        setY: (output, matrix) ->\n            matrix[1] = output[0]\n            matrix[5] = output[1]\n            matrix[9] = output[2]\n\n# setZ\n\n- A vector specifying the Z axis vector to set.\n- A matrix to set the Z axis vector of.\n\nOverwrites the Z axis of the matrix with the content of the given vector.\n\n        setZ: (output, matrix) ->\n            matrix[2] = output[0]\n            matrix[6] = output[1]\n            matrix[10] = output[2]\n            \n# interpolate\n\n- An input matrix to interpolate from.\n- An input matrix to interpolate to.\n- A number specifying how far along to interpolate; \"0\" is \"from\" and \"1\" is \n  \"to\".\n- An output matrix.\n\nAttempts to perform a somewhat crude interpolation between the two matrices\nwhich is not very linear.  Good enough for smoothing over small changes.\nPrioritizes the Z and Y axes over the X axis when ensuring orthogonal.\n\n        interpolate: (from, to, alpha, output) ->       \n            module.exports.copy from, fromTemp\n            module.exports.copy to, toTemp\n            module.exports.identity output\n            module.exports.getTranslation fromTemp, tempVectorFrom\n            module.exports.getTranslation toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            module.exports.setTranslation tempVector, output\n            \n            module.exports.getX fromTemp, tempVectorFrom\n            module.exports.getX toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            vector.normalize tempVector, tempVectorX, true  \n            \n            module.exports.getY fromTemp, tempVectorFrom\n            module.exports.getY toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVectorY\n            \n            vector.cross tempVectorX, tempVectorY, tempVectorZ\n            vector.normalize tempVectorZ, tempVectorZ\n            vector.cross tempVectorZ, tempVectorX, tempVectorY\n            vector.normalize tempVectorY, tempVectorY\n            \n            module.exports.setX tempVectorX, output\n            module.exports.setY tempVectorY, output\n            module.exports.setZ tempVectorZ, output\n            return\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"af51750a52271a504465e7624c0e409f8f00a01b","subject":"Added a function for \"flatten\"ing vectors against surface normals.","message":"Added a function for \"flatten\"ing vectors against surface normals.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat","old_file":"src\/vector.litcoffee","new_file":"src\/vector.litcoffee","new_contents":"# vector\n\nVectors are arrays of 3 numbers; X, Y and Z.\nX runs from left to right.\nY runs from bottom to top.\nZ runs from back to front.\n\nWhen given as outputs, vectors can safely be empty arrays.\n\n    misc = require \".\/misc.litcoffee\"\n\n## sum\n\n- A vector.\n\nReturns the sum of the components.\n\n    sum = (vector) ->\n        total = 0\n        (total += component) for component in vector\n        total\n        \n    unary = (callback) -> (input, output) ->\n        (output[index] = callback value) for value, index in input\n        return\n        \n## copy\n\n- An input vector.\n- An output vector.\n\nCopies every component from the input to the output.\n        \n    copy = unary (component) -> component\n    \n## copy\n\n- An input vector.\n- An output vector.\n\nWrites the negative of every component of the input to the output.\n    \n    negate = unary (component) -> -component\n    \n    binary = (callback) ->\n        vector: (a, b, output) ->\n            (output[index] = callback valueA, b[index]) for valueA, index in a\n            return\n\n        scalarBy: (a, b, output) ->\n            (output[index] = callback a, valueB) for valueB, index in b\n            return\n            \n        byScalar: (a, b, output) ->\n            (output[index] = callback valueA, b) for valueA, index in a\n            return\n    \n## add.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nAdds each component in the input vectors and writes the results to the output \nvector.\n\n## add.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nAdds the number to each component in the vector and and writes the results to\nthe output vector.\n\n## add.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nAdds each component in the vector to the number and writes the result to\nthe output vector.\n    \n    add = binary (a, b) -> a + b\n    \n## subtract.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nSubtracts each compenent in the second input vector from the equivalent in the\nfirst input vector and writes the results to the output vector.\n\n## subtract.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nSubtracts each component in the vector from the number and writes the results to \nthe output vector.\n\n## subtract.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nSubtracts the number from each component in the vector and writes the results to \nthe output vector.\n    \n    subtract = binary (a, b) -> a - b\n    \n## multiply.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nMultiplies each compenent in the second input vector with the equivalent in the\nfirst input vector and writes the results to the output vector.\n\n## multiply.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nMultiplies the number by each component in the vector and writes the results to \nthe output vector.\n\n## multiply.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nMultiplies each component in the vector by the number and writes the results to \nthe output vector.\n    \n    multiply = binary (a, b) -> a * b\n    \n## divide.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nDivides each compenent in the first input vector by the equivalent in the second\ninput vector and writes the results to the output vector.\n\n## divide.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nDivides the number by each component in the vector and writes the results to the\noutput vector.\n\n## divide.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nDivides each component in the vector by the number and writes the results to the\noutput vector.\n    \n    divide = binary (a, b) -> a \/ b\n    \n# dot\n    \n- A vector.\n- A vector.\n\nReturns the dot product of the two vectors.\n\n    tempA = []\n    tempB = []\n    dot = (a, b) -> \n        multiply.vector a, b, tempA\n        sum tempA\n    \n# magnitudeSquared\n\n- A vector.\n\nReturns the square of the magnitude\/length of the vector.\nFaster than \"magnitude\".\n    \n    magnitudeSquared = (v) -> dot v, v\n    \n# magnitude\n\n- A vector.\n\nReturns the magnitude\/length of the vector.\nSlower than \"magnitudeSquared\".\n    \n    magnitude = (v) -> Math.sqrt magnitudeSquared v\n\n# distanceSquared\n\n- A vector.\n- A vector.\n\nReturns the square of the distance between the two vectors.\nFaster than \"distance\".\n    \n    distanceSquared = (a, b) ->\n        subtract.vector a, b, tempB\n        magnitudeSquared tempB\n\n# distance\n\n- A vector.\n- A vector.\n\nReturns the distance between the two vectors.\nSlower than \"distanceSquared\".\n\n    distance = (a, b) ->\n        subtract.vector a, b, tempB\n        magnitude tempB\n        \n# normalize\n\n- An input vector.\n- An output vector.\n\nWrites the normalized\/unit length version of the input vector to the output.\nReturns the magnitude\/length of the original vector.\n\n    normalize = (input, output) ->\n        len = magnitude input\n        divide.byScalar input, len, output\n        len\n     \n# cross\n\n- An input vector.\n- An input vector.\n- An output vector.\n\nWrites the cross product of the two input vectors to the output vector.\n     \n    cross = (a, b, output) ->\n        copy a, tempA\n        copy b, tempB\n        output[0] = tempA[1] * tempB[2] - tempB[1] * tempA[2]\n        output[1] = tempA[2] * tempB[0] - tempB[2] * tempA[0]\n        output[2] = tempA[0] * tempB[1] - tempB[0] * tempA[1]\n        return\n        \n# interpolate\n\n- An input vector to interpolate from.\n- An input vector to interpolate to.\n- A number, where \"0\" is \"from\" and \"1\" is \"to\".\n- An output vector.\n\nWrites the linear interpolation between, or linear extrapolation beyond, the\ntwo input vectors to the output.\n\n    interpolate = (from, to, alpha, output) ->\n        for fromValue, index in from\n            toValue = to[index]\n            output[index] = misc.interpolate fromValue, toValue, alpha\n        return\n        \n# reflect\n\n- An input vector.\n- An input normal vector.\n- An output vector.\n\nWrites the reflection of the input vector against the surface normal specified\nto the output vector.\n        \n    reflectTemp = []\n    reflect = (input, normal, output) ->\n        coefficient = dot input, normal\n        multiply.byScalar normal, (coefficient * 2), reflectTemp\n        subtract.vector input, reflectTemp, output\n        \n# flatten\n\n- An input vector.\n- An input normal vector.\n- An output vector.\n\nWrites the input vector to the output vector, but \"flattened\" along the surface\nnormal.  For instance, a vector pointing up and right with a normal facing right\nwould output a vector pointing only up.\n\n    flattenTemp = []\n    flatten = (input, normal, output) ->\n        matched = dot input, normal\n        multiply.byScalar normal, matched, flattenTemp\n        subtract.vector input, flattenTemp, output\n        \n    module.exports = { \n            sum, copy, negate\n            add, subtract, multiply, divide\n            dot, cross\n            magnitudeSquared, magnitude\n            distanceSquared, distance\n            normalize\n            interpolate\n            reflect, flatten\n        }","old_contents":"# vector\n\nVectors are arrays of 3 numbers; X, Y and Z.\nX runs from left to right.\nY runs from bottom to top.\nZ runs from back to front.\n\nWhen given as outputs, vectors can safely be empty arrays.\n\n    misc = require \".\/misc.litcoffee\"\n\n## sum\n\n- A vector.\n\nReturns the sum of the components.\n\n    sum = (vector) ->\n        total = 0\n        (total += component) for component in vector\n        total\n        \n    unary = (callback) -> (input, output) ->\n        (output[index] = callback value) for value, index in input\n        return\n        \n## copy\n\n- An input vector.\n- An output vector.\n\nCopies every component from the input to the output.\n        \n    copy = unary (component) -> component\n    \n## copy\n\n- An input vector.\n- An output vector.\n\nWrites the negative of every component of the input to the output.\n    \n    negate = unary (component) -> -component\n    \n    binary = (callback) ->\n        vector: (a, b, output) ->\n            (output[index] = callback valueA, b[index]) for valueA, index in a\n            return\n\n        scalarBy: (a, b, output) ->\n            (output[index] = callback a, valueB) for valueB, index in b\n            return\n            \n        byScalar: (a, b, output) ->\n            (output[index] = callback valueA, b) for valueA, index in a\n            return\n    \n## add.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nAdds each component in the input vectors and writes the results to the output \nvector.\n\n## add.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nAdds the number to each component in the vector and and writes the results to\nthe output vector.\n\n## add.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nAdds each component in the vector to the number and writes the result to\nthe output vector.\n    \n    add = binary (a, b) -> a + b\n    \n## subtract.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nSubtracts each compenent in the second input vector from the equivalent in the\nfirst input vector and writes the results to the output vector.\n\n## subtract.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nSubtracts each component in the vector from the number and writes the results to \nthe output vector.\n\n## subtract.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nSubtracts the number from each component in the vector and writes the results to \nthe output vector.\n    \n    subtract = binary (a, b) -> a - b\n    \n## multiply.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nMultiplies each compenent in the second input vector with the equivalent in the\nfirst input vector and writes the results to the output vector.\n\n## multiply.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nMultiplies the number by each component in the vector and writes the results to \nthe output vector.\n\n## multiply.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nMultiplies each component in the vector by the number and writes the results to \nthe output vector.\n    \n    multiply = binary (a, b) -> a * b\n    \n## divide.vector\n\n- An input vector.\n- An input vector.\n- An output vector.\n    \nDivides each compenent in the first input vector by the equivalent in the second\ninput vector and writes the results to the output vector.\n\n## divide.scalarBy\n\n- A number.\n- An input vector.\n- An output vector.\n\nDivides the number by each component in the vector and writes the results to the\noutput vector.\n\n## divide.byScalar\n\n- An input vector.\n- A number.\n- An output vector.\n\nDivides each component in the vector by the number and writes the results to the\noutput vector.\n    \n    divide = binary (a, b) -> a \/ b\n    \n# dot\n    \n- A vector.\n- A vector.\n\nReturns the dot product of the two vectors.\n\n    tempA = []\n    tempB = []\n    dot = (a, b) -> \n        multiply.vector a, b, tempA\n        sum tempA\n    \n# magnitudeSquared\n\n- A vector.\n\nReturns the square of the magnitude\/length of the vector.\nFaster than \"magnitude\".\n    \n    magnitudeSquared = (v) -> dot v, v\n    \n# magnitude\n\n- A vector.\n\nReturns the magnitude\/length of the vector.\nSlower than \"magnitudeSquared\".\n    \n    magnitude = (v) -> Math.sqrt magnitudeSquared v\n\n# distanceSquared\n\n- A vector.\n- A vector.\n\nReturns the square of the distance between the two vectors.\nFaster than \"distance\".\n    \n    distanceSquared = (a, b) ->\n        subtract.vector a, b, tempB\n        magnitudeSquared tempB\n\n# distance\n\n- A vector.\n- A vector.\n\nReturns the distance between the two vectors.\nSlower than \"distanceSquared\".\n\n    distance = (a, b) ->\n        subtract.vector a, b, tempB\n        magnitude tempB\n        \n# normalize\n\n- An input vector.\n- An output vector.\n\nWrites the normalized\/unit length version of the input vector to the output.\nReturns the magnitude\/length of the original vector.\n\n    normalize = (input, output) ->\n        len = magnitude input\n        divide.byScalar input, len, output\n        len\n     \n# cross\n\n- An input vector.\n- An input vector.\n- An output vector.\n\nWrites the cross product of the two input vectors to the output vector.\n     \n    cross = (a, b, output) ->\n        copy a, tempA\n        copy b, tempB\n        output[0] = tempA[1] * tempB[2] - tempB[1] * tempA[2]\n        output[1] = tempA[2] * tempB[0] - tempB[2] * tempA[0]\n        output[2] = tempA[0] * tempB[1] - tempB[0] * tempA[1]\n        return\n        \n# interpolate\n\n- An input vector to interpolate from.\n- An input vector to interpolate to.\n- A number, where \"0\" is \"from\" and \"1\" is \"to\".\n- An output vector.\n\nWrites the linear interpolation between, or linear extrapolation beyond, the\ntwo input vectors to the output.\n\n    interpolate = (from, to, alpha, output) ->\n        for fromValue, index in from\n            toValue = to[index]\n            output[index] = misc.interpolate fromValue, toValue, alpha\n        return\n        \n# reflect\n\n- An input vector.\n- An input normal vector.\n- An output vector.\n\nWrites the reflection of the input vector against the surface normal specified\nto the output vector.\n        \n    reflectTemp = []\n    reflect = (input, normal, output) ->\n        coefficient = dot input, normal\n        multiply.byScalar normal, (coefficient * 2), reflectTemp\n        subtract.vector input, reflectTemp, output\n        \n    module.exports = { \n            sum, copy, negate\n            add, subtract, multiply, divide\n            dot, cross\n            magnitudeSquared, magnitude\n            distanceSquared, distance\n            normalize\n            interpolate\n            reflect\n        }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fa64cc904cc78e54c6c34d84eb69679290f1f443","subject":"FLAGS section","message":"FLAGS section\n","repos":"nhz-io\/cnl","old_file":"source\/lib\/event.litcoffee","new_file":"source\/lib\/event.litcoffee","new_contents":"# CLASS: Event\n* Extends: [Base][Base]\n\nBase event class. The design has been influenced by [DOM Events][DOMEvents].\n  \n      module.exports = class Event extends require '.\/base'\n\nThe Event class does not have any methods that affect the state of the\nsystem somehow (Besides the constructor and state setters). It was primarily\nintended to serve as an envelope for the data.\n\n## CONSTRUCTOR\n\n### new Event(args, callback)\n### new Event(type, callback)\n\n* Returns: [Event][Event]\n\nCreate the event. All the key-value pairs from **args** will be copied\nto the event instance. If **callback** is provided in the **args**, it\nwill override the **callback** provided as the second argument.\n\nUpon instance creation, the event will log it's creation timestamp. This\ncan be disabled by passing `timestamp:null` to constructor.\n\nAny Event instance at its minimum will have **timestamp** property. This\nis the only mandatory property.\n\n      constructor: (args = {}, callback) ->\n        if typeof args is 'string' then args = type:args else\n          if (arguments.length < 2) and typeof args is 'function'\n            callback = args\n            args = {}\n\n        this[key] = value for key, value of args\n\n        @callback = callback if callback and not @callback\n\n        if (args.timestamp is true) or not args.hasOwnProperty 'timestamp'\n          date = Date.now()\n          perf = performance?.now() or 0\n          @timestamp = 1000 * date + Math.floor 1000 * (perf - Math.floor perf)\n\n### PARAMETERS\n**args**\n* Type: [Object][Object] - event data\n\n**args.type**\n* Type: [String][String] - event type\n\n**args.callback**\n* Type: [Function][Function] - event completion callback\n* Optional\n* Overrides the **callback** parameter\n\n**args.timestamp**\n* Type: [Boolean][Boolean] - set to `false` to disable the timestamp calculation\n* Type: [Number][Number] - event timestamp\n\n**type**\n* Type: [String][String] - event type\n\n**callback**\n* Type: [Function][Function] - event completion callback\n* Optional\n\n---\n\n## PROPERTIES\n\n### #type\n* Type: [String][String] - event type\n\n### #phase\n* Type: [Number][Number] - event phase (1..3)\n\n### #timestamp\n* Type: [Number][Number] - event creation timestamp\n\n### #callback\n* Type: [Function][Function] - event completion callback\n\n---\n\n## FLAGS\n\n### #started\n* Type: [Boolean][Boolean] - event **started** flag\n\n### #stopped\n* Type: [Boolean][Boolean] - event **stopped** flag\n\n### #canceled\n* Type: [Boolean][Boolean] - event **canceled** flag\n\n### #aborted\n* Type: [Boolean][Boolean] - event **aborted** flag\n\n### #done\n* Type: [Boolean][Boolean] - event **done** flag\n\n---\n\n## METHODS\n\n### #start()\n* Returns [Event][Event]\n\n**started** flag setter\n\n      start: -> (@started = yes) and this\n\n---\n\n### #stop()\n* Returns [Event][Event]\n\n**stopped** flag setter\n\n      stop: -> (@stopped = yes) and this\n\n---\n\n### #cancel()\n* Returns [Event][Event]\n\n**canceled** flag setter\n\n      cancel: -> (@canceled = yes) and this\n\n---\n\n### #abort()\n* Returns [Event][Event]\n\n**aborted** flag setter\n\n      abort: -> (@aborted = yes) and this\n\n---\n\n### finish()\n* Returns [Event][Event]\n\n**done** flag setter\n\n      finish: -> (@done = yes) and this\n\n[Base]: .\/base\n[Event]: .\/event\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[String]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/String\n[Function]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Function\n[Boolean]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Boolean\n[Number]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Number\n\n[DOMEvents]: http:\/\/www.w3.org\/TR\/DOM-Level-2-Events\/events.html\n","old_contents":"# CLASS: Event\n* Extends: [Base][Base]\n\nBase event class. The design has been influenced by [DOM Events][DOMEvents].\n  \n      module.exports = class Event extends require '.\/base'\n\nThe Event class does not have any methods that affect the state of the\nsystem somehow (Besides the constructor and state setters). It was primarily\nintended to serve as an envelope for the data.\n\n## CONSTRUCTOR\n\n### new Event(args, callback)\n### new Event(type, callback)\n\n* Returns: [Event][Event]\n\nCreate the event. All the key-value pairs from **args** will be copied\nto the event instance. If **callback** is provided in the **args**, it\nwill override the **callback** provided as the second argument.\n\nUpon instance creation, the event will log it's creation timestamp. This\ncan be disabled by passing `timestamp:null` to constructor.\n\nAny Event instance at its minimum will have **timestamp** property. This\nis the only mandatory property.\n\n      constructor: (args = {}, callback) ->\n        if typeof args is 'string' then args = type:args else\n          if (arguments.length < 2) and typeof args is 'function'\n            callback = args\n            args = {}\n\n        this[key] = value for key, value of args\n\n        @callback = callback if callback and not @callback\n\n        if (args.timestamp is true) or not args.hasOwnProperty 'timestamp'\n          date = Date.now()\n          perf = performance?.now() or 0\n          @timestamp = 1000 * date + Math.floor 1000 * (perf - Math.floor perf)\n\n### PARAMETERS\n**args**\n* Type: [Object][Object] - event data\n\n**args.type**\n* Type: [String][String] - event type\n\n**args.callback**\n* Type: [Function][Function] - event completion callback\n* Optional\n* Overrides the **callback** parameter\n\n**args.timestamp**\n* Type: [Boolean][Boolean] - set to `false` to disable the timestamp calculation\n* Type: [Number][Number] - event timestamp\n\n**type**\n* Type: [String][String] - event type\n\n**callback**\n* Type: [Function][Function] - event completion callback\n* Optional\n\n---\n\n## PROPERTIES\n\n### #type\n* Type: [String][String] - event type\n\n### #timestamp\n* Type: [Number][Number] - event creation timestamp\n\n### #callback\n* Type: [Function][Function] - event completion callback\n\n### #started\n* Type: [Boolean][Boolean] - event **started** flag\n\n### #stopped\n* Type: [Boolean][Boolean] - event **stopped** flag\n\n### #canceled\n* Type: [Boolean][Boolean] - event **canceled** flag\n\n### #aborted\n* Type: [Boolean][Boolean] - event **aborted** flag\n\n### #done\n* Type: [Boolean][Boolean] - event **done** flag\n\n---\n## METHODS\n\n### #start()\n* Returns [Event][Event]\n\n**started** flag setter\n\n      start: -> (@started = yes) and this\n\n---\n### #stop()\n* Returns [Event][Event]\n\n**stopped** flag setter\n\n      stop: -> (@stopped = yes) and this\n\n---\n### #cancel()\n* Returns [Event][Event]\n\n**canceled** flag setter\n\n      cancel: -> (@canceled = yes) and this\n\n---\n### #abort()\n* Returns [Event][Event]\n\n**aborted** flag setter\n\n      abort: -> (@aborted = yes) and this\n\n---\n### finish()\n* Returns [Event][Event]\n\n**done** flag setter\n\n      finish: -> (@done = yes) and this\n\n[Base]: .\/base\n[Event]: .\/event\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n[String]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/String\n[Function]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Function\n[Boolean]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Boolean\n[Number]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Number\n\n[DOMEvents]: http:\/\/www.w3.org\/TR\/DOM-Level-2-Events\/events.html\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"91578af65d245b66c60e9780ae9608834e0ab2a5","subject":"fix issue with binding on module schema without any data nodes","message":"fix issue with binding on module schema without any data nodes\n","repos":"corenova\/yang-js","old_file":"src\/yang.litcoffee","new_file":"src\/yang.litcoffee","new_contents":"# Yang - evaluable schema expression\n\nThis module provides support for basic set of YANG schema modeling\nlanguage by using the built-in *extension* syntax to define additional\nschema language constructs. The actual YANG language [RFC\n6020](http:\/\/tools.ietf.org\/html\/rfc6020) specifications are loaded\ninside the [main module](.\/main.coffee).\n\nThis module is the **primary interface** for consumers of this\nlibrary.\n\n## Dependencies\n \n    debug  = require('debug')('yang:schema')\n    parser = require 'yang-parser'\n    indent = require 'indent-string'\n\n    Expression = require '.\/expression'\n    Extension = require '.\/extension'\n    XPath = require '.\/xpath'\n\n## Class Yang\n\n    class Yang extends Expression\n      @scope:\n        extension: '0..n'\n        typedef:   '0..n'\n        module:    '0..n'\n        submodule: '0..n'\n\n## Class-level methods\n\n      @clear: ->\n        @module.splice(0,@module.length) if @module?\n        @submodule.splice(0,@submodule.length) if @submodule?\n\n### parse (schema)\n\nThis class-level routine performs recursive parsing of passed in\nstatement and sub-statements. It provides syntactic, semantic and\ncontextual validations on the provided schema and returns the final JS\nobject tree structure as hierarchical Yang expression instances.\n\nIf any validation errors are encountered, it will throw the\nappropriate error along with the context information regarding the\nerror.\n\n      @parse: (schema, opts={}) ->\n        return schema if schema instanceof Yang\n        opts.compile ?= true\n        try\n          schema = parser.parse schema if typeof schema is 'string'\n        catch e\n          e.offset = 50 unless e.offset > 50\n          offender = schema.slice e.offset-50, e.offset+50\n          offender = offender.replace \/\\s\\s+\/g, ' '\n          throw @error \"invalid YANG syntax detected around: '#{offender}'\", offender\n\n        unless schema instanceof Object\n          throw @error \"must pass in valid YANG schema\", schema\n\n        kind = switch\n          when !!schema.prf then \"#{schema.prf}:#{schema.kw}\"\n          else schema.kw\n        tag = schema.arg unless schema.arg is false\n\n        yang = (new this kind, tag).extends schema.substmts.map (x) => @parse x, compile: (x.kw is 'extension')\n        \n        # perform final scoped constraint validation\n        for kind, constraint of yang.scope when constraint in [ '1', '1..n' ]\n          unless yang.hasOwnProperty kind\n            throw yang.error \"constraint violation for required '#{kind}' = #{constraint}\"\n        yang.compile() if opts.compile\n        return yang\n\nFor comprehensive overview on currently supported YANG statements,\nplease refer to\n[Compliance Report](..\/test\/yang-compliance-coverage.md) for the latest\n[RFC 6020](http:\/\/tools.ietf.org\/html\/rfc6020) YANG specification\ncompliance.\n\n### compose (data [, opts={}])\n\nThis call *accepts* any arbitrary JS object and it will attempt to\nconvert it into a structural `Yang` expression instance. It will\nanalyze the passed in JS data and perform best match mapping to an\nappropriate YANG schema representation to describe the input\ndata. This method will not be able to determine conditionals or any\nmeta-data to further constrain the data, but it should provide a good\nstarting point with the resulting `Yang` expression instance.\n\n      @compose: (data, opts={}) ->\n        unless data?\n          throw @error \"must supply input 'data' to compose\"\n\n        # explict compose\n        if opts.kind?\n          ext = Yang::lookup.call this, 'extension', opts.kind\n          unless ext instanceof Expression\n            throw @error \"unable to find requested '#{opts.kind}' extension\"\n          return ext.compose? data, opts\n\n        # implicit compose (dynamic discovery)\n        for ext in @extension when ext.compose instanceof Function\n          debug \"checking data if #{ext.tag}\"\n          res = ext.compose data, opts\n          return res if res instanceof Yang\n\nThis facility is a powerful construct to dynamically generate `Yang`\nschema from ordinary JS objects. For additional usage examples, please\nrefer to [Dynamic Composition](..\/TUTORIAL.md#dynamic-composition)\nsection in the [Getting Started Guide](..\/TUTORIAL.md).\n\n## Main constructor\n\nThe constructor inherits from `Expression` which returns a `bound\nfunction` that invokes [eval](#eval-data-opts) when called.\n\n      @property 'source',\n        get: ->\n          @state.source ?= @lookup 'extension', @kind\n          @state.source or {}\n        set: (value) -> @state.source = value\n        \n      @property 'datakey',\n        get: -> switch\n          when @parent instanceof Yang and @parent.kind is 'module'\n            \"#{@parent.tag}:#{@tag}\"\n          when @parent instanceof Yang and @parent.kind is 'submodule'\n            \"#{@parent['belongs-to'].tag}:#{@tag}\"\n          when @node and @external and not @state.relative\n            \"#{@origin.root.tag}:#{@tag}\"\n          else @tag ? @kind\n\n      @property 'external',\n        get: -> @origin? and @origin.root isnt @root and @origin.root.kind is 'module'\n            \n      @property 'datapath',\n        get: ->\n          return '' if @kind is 'module'\n          label = if @node then @datakey else \"#{@kind}(#{@datakey})\"\n          return switch\n            when @parent?.datapath? then [ @parent.datapath, label ].join('\/')\n            else label\n                  \n      debug: -> debug \"[#{@uri}]\", arguments...\n      emit: (event, args...) ->\n        @emitter.emit arguments...\n        @root.emit event, this if event is 'change' and this isnt @root\n\n## Instance-level methods\n\n### compile (obj)\n\n      compile: ->\n        unless @source instanceof Expression\n          @debug @source\n          throw @error \"encountered unknown extension '#{@kind}'\"\n        super arguments...\n\n### bind (obj)\n\nEvery instance of `Yang` expression can be *bound* with control logic\nwhich will be used during [eval](#eval-data-opts) to produce schema\ninfused **adaptive data object**. This routine is *inherited* from\n[Class Expression](.\/expression.coffee).\n\nThis facility can be used to associate default behaviors for any\nelement in the configuration tree, as well as handler logic for\nvarious YANG statements such as *rpc*, *feature*, etc.\n\nThis call will return the original `Yang` expression instance with the\nnew bindings registered within the `Yang` expression hierarchy.\n\n      bind: (data) ->\n        if not @data and (@kind is 'module' or @nodes.length > 0) and typeof data is 'object'\n          for key, binding of data\n            try @locate(key).bind binding\n            catch e\n              throw e if e.name is 'ExpressionError'\n              throw @error \"failed to bind to '#{key}' (schema-path not found)\", e\n        else\n          super data\n        return this\n\nPlease refer to [Schema Binding](..\/TUTORIAL.md#schema-binding)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n### eval (data, opts={})\n\nEvery instance of `Yang` expression can be [eval](#eval-data-opts)\nwith arbitrary JS data input which will apply the schema against the\nprovided data and return a schema infused **adaptive** data object.\n\nThis is an extremely useful construct which brings out the true power\nof YANG for defining and governing arbitrary JS data structures.\n\nBasically, the input `data` will be YANG schema validated and\nconverted to a schema infused *adaptive data model* that dynamically\ndefines properties according to the schema expressions.\n\nIt currently supports the `opts.adaptive` parameter (default `false`)\nwhich establishes a persistent binding relationship with the governing\n`Yang` expression instance. This allows the generated model to\ndynamically **adapt** to any changes to the governing `Yang`\nexpression instance. Refer to below [extends](#extends-schema) section\nfor additional info on how the schema can be programmatically\nmodified.\n\n      eval: (data, ctx, opts={}) ->\n        if opts.adaptive is true\n          # TODO: this will break for 'module' which will return Model?\n          @once 'change', arguments.callee.bind(this, data, opts)\n        super arguments...\n\nPlease refer to [Working with Models](..\/TUTORIAL.md#working-with-models)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for special\nusage examples for `module` schemas.\n\n### override (callback)\n\nPerform schema source extension override to dynamically alter the\nhandling\/behavior of the current schema element.\n\n      override: (callback) ->\n        { argument, scope, resolve, transform, construct } = @source\n        @source = new Extension @kind, Object.assign {\n          argument, scope, resolve, transform, construct\n        }, callback(@source)\n         \n### validate (data, opts={})\n\nPerform schema correctness validation for the passed in `data`.  This\ndiffers from [eval](#eval-data-opts) in that the final data returned\nis not infused as dynamic data model using Property instances. It\nshould be used to perform a sanity check on the data if it will not\nbe programmatically modified.\n\nFor example, [Property](.\/property.litcoffee) instance uses `validate`\nwhen dealing with non-configurable data nodes `config false`. \n\n      validate: (data, opts={}) -> @apply data, null, Object.assign opts, force: true, preserve: true\n\n### extends (schema...)\n\nEvery instance of `Yang` expression can be `extends` with additional\nYANG schema string(s) and it will automatically perform\n[parse](#parse-schema) of the provided schema text and update itself\naccordingly.\n\nThis action also triggers an event emitter which will *retroactively*\nadapt any previously [eval](#eval-data-opts) produced adaptive data\nmodel instances to react accordingly to the newly changed underlying\nschema expression(s).\n\n      # extends() is inherited from Element\n\n      merge: (elem) ->\n        unless elem instanceof Yang\n          throw @error \"cannot merge invalid element into Yang\", elem\n\n        switch elem.kind\n          when 'type'     then super elem, append: true\n          when 'argument' then super elem, replace: true\n          else super arguments...\n\nPlease refer to [Schema Extension](..\/TUTORIAL.md#schema-extension)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n      normalizePath: (ypath) ->\n        lastPrefix = null\n        prefix2module = (root, prefix) ->\n          return unless root.kind is 'module'\n          switch\n            when root.tag is prefix then prefix\n            when root.prefix.tag is prefix then root.tag\n            else\n              for m in root.import ? [] when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              modules = root.lookup 'module'\n              for m in modules when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              return prefix # return as-is...\n              \n        normalizeEntry = (x) =>\n          return x unless x? and !!x\n          match = x.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)(?:\\[.+\\])?$\/\n          unless match?\n            throw @error \"invalid path expression '#{x}' found in #{ypath}\"\n          [ prefix, target ] = [ match[1], match[2] ]\n          return switch\n            when not prefix? then target\n            when prefix is lastPrefix then target\n            else\n              lastPrefix = prefix\n              mname = prefix2module @root, prefix\n              \"#{mname}:#{target}\"\n        ypath = ypath.replace \/\\s\/g, ''\n        res = XPath.split(ypath).map(normalizeEntry).join('\/')\n        res = '\/' + res if \/^\\\/\/.test ypath\n        return res\n\n### locate (ypath)\n\nThis is an internal helper facility used to locate a given schema node\nwithin the `Yang` schema expression tree hierarchy. It supports a\nlimited version of XPATH-like expression to locate an explicit\nelement.\n\n      locate: (ypath) ->\n        # TODO: figure out how to eliminate duplicate code-block section\n        # shared with Element\n        return unless ypath?\n        \n        @debug \"locate enter for '#{ypath}'\"\n        if typeof ypath is 'string'\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = @normalizePath(ypath).split('\/').filter (e) -> !!e\n        else\n          [ key, rest... ] = ypath\n        @debug key\n        return this unless key? and key isnt '.'\n\n        if key is '..'\n          return @parent?.locate rest\n\n        match = key.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n        [ prefix, target ] = [ match[1], match[2] ]\n        if prefix? and this is @root\n          search = [target].concat(rest)\n          if (@tag is prefix) or (@lookup 'prefix', prefix)\n            @debug \"locate (local) '\/#{prefix}:#{search.join('\/')}'\"\n            return super search\n          for m in @import ? [] when m.tag is prefix or m.prefix.tag is prefix\n            @debug \"locate (external) '\/#{prefix}:#{search.join('\/')}'\"\n            return m.module.locate search\n          m = @lookup 'module', prefix\n          return m?.locate search\n\n        @debug \"checking #{target}\"\n        switch\n          when \/^{.+}$\/.test(target)\n            kind = 'grouping'\n            tag  = target.replace \/^{(.+)}$\/, '$1'\n          when \/^\\[.+\\]$\/.test(target)\n            kind = 'feature'\n            tag  = target.replace \/^\\[(.+)\\]$\/, '$1'\n          when \/^[^(]+\\([^)]*\\)$\/.test(target)\n            target = target.match \/^([^(]+)\\((.*)\\)$\/\n            [ kind, tag ] = [ target[1], target[2] ]\n            tag = undefined unless !!tag\n          when \/^\\<.+\\>$\/.test(target)\n            target = target.replace \/^\\<(.+)\\>$\/, '$1'\n            [ kind..., tag ]  = target.split ':'\n            [ tag, selector ] = tag.split '='\n            kind = kind[0] if kind?.length\n          else return super [key].concat rest\n            \n        @debug \"matching #{kind} #{tag}\"\n        match = @match kind, tag\n        return switch\n          when rest.length is 0 then match\n          when Array.isArray match then match.map((x) -> x.locate rest).filter(Boolean)\n          else match?.locate rest\n\n### match (kind, tag)\n\nThis is an internal helper facility used by [locate](#locate-ypath) and\n[lookup](.\/element.litcoffee#lookup-kind-tag) to test whether a given\nentity exists in the local schema tree.\n\n      # Yang Expression can support 'tag' with prefix to another module\n      # (or itself).\n      match: (kind, tag) ->\n        return super arguments... unless kind? and tag? and typeof tag is 'string'\n        res = super arguments...\n        return res if res?\n        \n        [ prefix..., arg ] = tag.split ':'\n        return unless prefix.length\n\n        @debug \"[match] with #{kind} #{tag}\"\n\n        prefix = prefix[0]\n        @debug \"[match] check if current module's prefix\"\n        if @root.tag is prefix or @root.prefix?.tag is prefix\n          return @root.match kind, arg\n\n        @debug \"[match] checking if submodule's parent\"\n        ctx = @lookup 'belongs-to'\n        if ctx?.prefix.tag is prefix\n          return ctx.module?.match kind, arg\n\n        @debug \"[match] check if one of current module's imports\"\n        imports = @root?.import ? []\n        for m in imports when m.prefix.tag is prefix\n          @debug \"[match] checking #{m.tag}\"\n          return m.module?.match kind, arg\n\n        @debug \"[match] check if one of available modules\"\n        module = @lookup 'module', prefix\n        return module.match kind, arg if module?\n\n### toString (opts={})\n\nThe current `Yang` expression will covert back to the equivalent YANG\nschema text format.\n\nAt first glance, this may not seem like a useful facility since YANG\nschema text is *generally known* before [parse](#parse-schema) but it\nbecomes highly relevant when you consider a given `Yang` expression\nprogramatically changing via [extends](#extends-schema).\n\nCurrently it supports `space` parameter which can be used to specify\nnumber of spaces to use for indenting YANG statement blocks.  It\ndefaults to **2** but when set to **0**, the generated output will\nomit newlines and other spacing for a more compact YANG output.\n\n      toString: (opts={ space: 2 }) ->\n        s = @kind\n        if @argument?\n          s += ' ' + switch @argument\n            when 'value' then switch\n              when Array.isArray(@tag) then \"'#{@tag.join(' ')}'\"\n              else \"'#{@tag}'\"\n            when 'text'\n              \"\\n\" + (indent '\"'+@tag+'\"', ' ', opts.space)\n            else @tag\n        sub =\n          @children\n            .filter (x) => x.parent is this\n            .map (x) -> x.toString opts\n            .join \"\\n\"\n        if !!sub\n          s += \" {\\n\" + (indent sub, ' ', opts.space) + \"\\n}\"\n        else\n          s += ';'\n        return s\n\n### toJSON\n\nThe current `Yang` expression will convert into a simple JS object\nformat.\n\n      # toJSON() is inherited from Element\n\n### valueOf\n\nThe current 'Yang' expression will convert into a primitive form for\ncomparision purposes.\n\n      valueOf: ->\n        switch @argument\n          when 'value','text' then @tag.valueOf()\n          else this\n\nPlease refer to [Schema Conversion](..\/TUTORIAL.md#schema-conversion)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n## Export Yang Class\n\n    module.exports = Yang\n","old_contents":"# Yang - evaluable schema expression\n\nThis module provides support for basic set of YANG schema modeling\nlanguage by using the built-in *extension* syntax to define additional\nschema language constructs. The actual YANG language [RFC\n6020](http:\/\/tools.ietf.org\/html\/rfc6020) specifications are loaded\ninside the [main module](.\/main.coffee).\n\nThis module is the **primary interface** for consumers of this\nlibrary.\n\n## Dependencies\n \n    debug  = require('debug')('yang:schema')\n    parser = require 'yang-parser'\n    indent = require 'indent-string'\n\n    Expression = require '.\/expression'\n    Extension = require '.\/extension'\n    XPath = require '.\/xpath'\n\n## Class Yang\n\n    class Yang extends Expression\n      @scope:\n        extension: '0..n'\n        typedef:   '0..n'\n        module:    '0..n'\n        submodule: '0..n'\n\n## Class-level methods\n\n      @clear: ->\n        @module.splice(0,@module.length) if @module?\n        @submodule.splice(0,@submodule.length) if @submodule?\n\n### parse (schema)\n\nThis class-level routine performs recursive parsing of passed in\nstatement and sub-statements. It provides syntactic, semantic and\ncontextual validations on the provided schema and returns the final JS\nobject tree structure as hierarchical Yang expression instances.\n\nIf any validation errors are encountered, it will throw the\nappropriate error along with the context information regarding the\nerror.\n\n      @parse: (schema, opts={}) ->\n        return schema if schema instanceof Yang\n        opts.compile ?= true\n        try\n          schema = parser.parse schema if typeof schema is 'string'\n        catch e\n          e.offset = 50 unless e.offset > 50\n          offender = schema.slice e.offset-50, e.offset+50\n          offender = offender.replace \/\\s\\s+\/g, ' '\n          throw @error \"invalid YANG syntax detected around: '#{offender}'\", offender\n\n        unless schema instanceof Object\n          throw @error \"must pass in valid YANG schema\", schema\n\n        kind = switch\n          when !!schema.prf then \"#{schema.prf}:#{schema.kw}\"\n          else schema.kw\n        tag = schema.arg unless schema.arg is false\n\n        yang = (new this kind, tag).extends schema.substmts.map (x) => @parse x, compile: (x.kw is 'extension')\n        \n        # perform final scoped constraint validation\n        for kind, constraint of yang.scope when constraint in [ '1', '1..n' ]\n          unless yang.hasOwnProperty kind\n            throw yang.error \"constraint violation for required '#{kind}' = #{constraint}\"\n        yang.compile() if opts.compile\n        return yang\n\nFor comprehensive overview on currently supported YANG statements,\nplease refer to\n[Compliance Report](..\/test\/yang-compliance-coverage.md) for the latest\n[RFC 6020](http:\/\/tools.ietf.org\/html\/rfc6020) YANG specification\ncompliance.\n\n### compose (data [, opts={}])\n\nThis call *accepts* any arbitrary JS object and it will attempt to\nconvert it into a structural `Yang` expression instance. It will\nanalyze the passed in JS data and perform best match mapping to an\nappropriate YANG schema representation to describe the input\ndata. This method will not be able to determine conditionals or any\nmeta-data to further constrain the data, but it should provide a good\nstarting point with the resulting `Yang` expression instance.\n\n      @compose: (data, opts={}) ->\n        unless data?\n          throw @error \"must supply input 'data' to compose\"\n\n        # explict compose\n        if opts.kind?\n          ext = Yang::lookup.call this, 'extension', opts.kind\n          unless ext instanceof Expression\n            throw @error \"unable to find requested '#{opts.kind}' extension\"\n          return ext.compose? data, opts\n\n        # implicit compose (dynamic discovery)\n        for ext in @extension when ext.compose instanceof Function\n          debug \"checking data if #{ext.tag}\"\n          res = ext.compose data, opts\n          return res if res instanceof Yang\n\nThis facility is a powerful construct to dynamically generate `Yang`\nschema from ordinary JS objects. For additional usage examples, please\nrefer to [Dynamic Composition](..\/TUTORIAL.md#dynamic-composition)\nsection in the [Getting Started Guide](..\/TUTORIAL.md).\n\n## Main constructor\n\nThe constructor inherits from `Expression` which returns a `bound\nfunction` that invokes [eval](#eval-data-opts) when called.\n\n      @property 'source',\n        get: ->\n          @state.source ?= @lookup 'extension', @kind\n          @state.source or {}\n        set: (value) -> @state.source = value\n        \n      @property 'datakey',\n        get: -> switch\n          when @parent instanceof Yang and @parent.kind is 'module'\n            \"#{@parent.tag}:#{@tag}\"\n          when @parent instanceof Yang and @parent.kind is 'submodule'\n            \"#{@parent['belongs-to'].tag}:#{@tag}\"\n          when @node and @external and not @state.relative\n            \"#{@origin.root.tag}:#{@tag}\"\n          else @tag ? @kind\n\n      @property 'external',\n        get: -> @origin? and @origin.root isnt @root and @origin.root.kind is 'module'\n            \n      @property 'datapath',\n        get: ->\n          return '' if @kind is 'module'\n          label = if @node then @datakey else \"#{@kind}(#{@datakey})\"\n          return switch\n            when @parent?.datapath? then [ @parent.datapath, label ].join('\/')\n            else label\n                  \n      debug: -> debug \"[#{@uri}]\", arguments...\n      emit: (event, args...) ->\n        @emitter.emit arguments...\n        @root.emit event, this if event is 'change' and this isnt @root\n\n## Instance-level methods\n\n### compile (obj)\n\n      compile: ->\n        unless @source instanceof Expression\n          @debug @source\n          throw @error \"encountered unknown extension '#{@kind}'\"\n        super arguments...\n\n### bind (obj)\n\nEvery instance of `Yang` expression can be *bound* with control logic\nwhich will be used during [eval](#eval-data-opts) to produce schema\ninfused **adaptive data object**. This routine is *inherited* from\n[Class Expression](.\/expression.coffee).\n\nThis facility can be used to associate default behaviors for any\nelement in the configuration tree, as well as handler logic for\nvarious YANG statements such as *rpc*, *feature*, etc.\n\nThis call will return the original `Yang` expression instance with the\nnew bindings registered within the `Yang` expression hierarchy.\n\n      bind: (data) ->\n        if not @data and @nodes.length > 0 and typeof data is 'object'\n          for key, binding of data\n            try @locate(key).bind binding\n            catch e\n              throw e if e.name is 'ExpressionError'\n              throw @error \"failed to bind to '#{key}' (schema-path not found)\", e\n        else\n          super data\n        return this\n\nPlease refer to [Schema Binding](..\/TUTORIAL.md#schema-binding)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n### eval (data, opts={})\n\nEvery instance of `Yang` expression can be [eval](#eval-data-opts)\nwith arbitrary JS data input which will apply the schema against the\nprovided data and return a schema infused **adaptive** data object.\n\nThis is an extremely useful construct which brings out the true power\nof YANG for defining and governing arbitrary JS data structures.\n\nBasically, the input `data` will be YANG schema validated and\nconverted to a schema infused *adaptive data model* that dynamically\ndefines properties according to the schema expressions.\n\nIt currently supports the `opts.adaptive` parameter (default `false`)\nwhich establishes a persistent binding relationship with the governing\n`Yang` expression instance. This allows the generated model to\ndynamically **adapt** to any changes to the governing `Yang`\nexpression instance. Refer to below [extends](#extends-schema) section\nfor additional info on how the schema can be programmatically\nmodified.\n\n      eval: (data, ctx, opts={}) ->\n        if opts.adaptive is true\n          # TODO: this will break for 'module' which will return Model?\n          @once 'change', arguments.callee.bind(this, data, opts)\n        super arguments...\n\nPlease refer to [Working with Models](..\/TUTORIAL.md#working-with-models)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for special\nusage examples for `module` schemas.\n\n### override (callback)\n\nPerform schema source extension override to dynamically alter the\nhandling\/behavior of the current schema element.\n\n      override: (callback) ->\n        { argument, scope, resolve, transform, construct } = @source\n        @source = new Extension @kind, Object.assign {\n          argument, scope, resolve, transform, construct\n        }, callback(@source)\n         \n### validate (data, opts={})\n\nPerform schema correctness validation for the passed in `data`.  This\ndiffers from [eval](#eval-data-opts) in that the final data returned\nis not infused as dynamic data model using Property instances. It\nshould be used to perform a sanity check on the data if it will not\nbe programmatically modified.\n\nFor example, [Property](.\/property.litcoffee) instance uses `validate`\nwhen dealing with non-configurable data nodes `config false`. \n\n      validate: (data, opts={}) -> @apply data, null, Object.assign opts, force: true, preserve: true\n\n### extends (schema...)\n\nEvery instance of `Yang` expression can be `extends` with additional\nYANG schema string(s) and it will automatically perform\n[parse](#parse-schema) of the provided schema text and update itself\naccordingly.\n\nThis action also triggers an event emitter which will *retroactively*\nadapt any previously [eval](#eval-data-opts) produced adaptive data\nmodel instances to react accordingly to the newly changed underlying\nschema expression(s).\n\n      # extends() is inherited from Element\n\n      merge: (elem) ->\n        unless elem instanceof Yang\n          throw @error \"cannot merge invalid element into Yang\", elem\n\n        switch elem.kind\n          when 'type'     then super elem, append: true\n          when 'argument' then super elem, replace: true\n          else super arguments...\n\nPlease refer to [Schema Extension](..\/TUTORIAL.md#schema-extension)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n      normalizePath: (ypath) ->\n        lastPrefix = null\n        prefix2module = (root, prefix) ->\n          return unless root.kind is 'module'\n          switch\n            when root.tag is prefix then prefix\n            when root.prefix.tag is prefix then root.tag\n            else\n              for m in root.import ? [] when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              modules = root.lookup 'module'\n              for m in modules when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              return prefix # return as-is...\n              \n        normalizeEntry = (x) =>\n          return x unless x? and !!x\n          match = x.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)(?:\\[.+\\])?$\/\n          unless match?\n            throw @error \"invalid path expression '#{x}' found in #{ypath}\"\n          [ prefix, target ] = [ match[1], match[2] ]\n          return switch\n            when not prefix? then target\n            when prefix is lastPrefix then target\n            else\n              lastPrefix = prefix\n              mname = prefix2module @root, prefix\n              \"#{mname}:#{target}\"\n        ypath = ypath.replace \/\\s\/g, ''\n        res = XPath.split(ypath).map(normalizeEntry).join('\/')\n        res = '\/' + res if \/^\\\/\/.test ypath\n        return res\n\n### locate (ypath)\n\nThis is an internal helper facility used to locate a given schema node\nwithin the `Yang` schema expression tree hierarchy. It supports a\nlimited version of XPATH-like expression to locate an explicit\nelement.\n\n      locate: (ypath) ->\n        # TODO: figure out how to eliminate duplicate code-block section\n        # shared with Element\n        return unless ypath?\n        \n        @debug \"locate enter for '#{ypath}'\"\n        if typeof ypath is 'string'\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = @normalizePath(ypath).split('\/').filter (e) -> !!e\n        else\n          [ key, rest... ] = ypath\n        @debug key\n        return this unless key? and key isnt '.'\n\n        if key is '..'\n          return @parent?.locate rest\n\n        match = key.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n        [ prefix, target ] = [ match[1], match[2] ]\n        if prefix? and this is @root\n          search = [target].concat(rest)\n          if (@tag is prefix) or (@lookup 'prefix', prefix)\n            @debug \"locate (local) '\/#{prefix}:#{search.join('\/')}'\"\n            return super search\n          for m in @import ? [] when m.tag is prefix or m.prefix.tag is prefix\n            @debug \"locate (external) '\/#{prefix}:#{search.join('\/')}'\"\n            return m.module.locate search\n          m = @lookup 'module', prefix\n          return m?.locate search\n\n        @debug \"checking #{target}\"\n        switch\n          when \/^{.+}$\/.test(target)\n            kind = 'grouping'\n            tag  = target.replace \/^{(.+)}$\/, '$1'\n          when \/^\\[.+\\]$\/.test(target)\n            kind = 'feature'\n            tag  = target.replace \/^\\[(.+)\\]$\/, '$1'\n          when \/^[^(]+\\([^)]*\\)$\/.test(target)\n            target = target.match \/^([^(]+)\\((.*)\\)$\/\n            [ kind, tag ] = [ target[1], target[2] ]\n            tag = undefined unless !!tag\n          when \/^\\<.+\\>$\/.test(target)\n            target = target.replace \/^\\<(.+)\\>$\/, '$1'\n            [ kind..., tag ]  = target.split ':'\n            [ tag, selector ] = tag.split '='\n            kind = kind[0] if kind?.length\n          else return super [key].concat rest\n            \n        @debug \"matching #{kind} #{tag}\"\n        match = @match kind, tag\n        return switch\n          when rest.length is 0 then match\n          when Array.isArray match then match.map((x) -> x.locate rest).filter(Boolean)\n          else match?.locate rest\n\n### match (kind, tag)\n\nThis is an internal helper facility used by [locate](#locate-ypath) and\n[lookup](.\/element.litcoffee#lookup-kind-tag) to test whether a given\nentity exists in the local schema tree.\n\n      # Yang Expression can support 'tag' with prefix to another module\n      # (or itself).\n      match: (kind, tag) ->\n        return super arguments... unless kind? and tag? and typeof tag is 'string'\n        res = super arguments...\n        return res if res?\n        \n        [ prefix..., arg ] = tag.split ':'\n        return unless prefix.length\n\n        @debug \"[match] with #{kind} #{tag}\"\n\n        prefix = prefix[0]\n        @debug \"[match] check if current module's prefix\"\n        if @root.tag is prefix or @root.prefix?.tag is prefix\n          return @root.match kind, arg\n\n        @debug \"[match] checking if submodule's parent\"\n        ctx = @lookup 'belongs-to'\n        if ctx?.prefix.tag is prefix\n          return ctx.module?.match kind, arg\n\n        @debug \"[match] check if one of current module's imports\"\n        imports = @root?.import ? []\n        for m in imports when m.prefix.tag is prefix\n          @debug \"[match] checking #{m.tag}\"\n          return m.module?.match kind, arg\n\n        @debug \"[match] check if one of available modules\"\n        module = @lookup 'module', prefix\n        return module.match kind, arg if module?\n\n### toString (opts={})\n\nThe current `Yang` expression will covert back to the equivalent YANG\nschema text format.\n\nAt first glance, this may not seem like a useful facility since YANG\nschema text is *generally known* before [parse](#parse-schema) but it\nbecomes highly relevant when you consider a given `Yang` expression\nprogramatically changing via [extends](#extends-schema).\n\nCurrently it supports `space` parameter which can be used to specify\nnumber of spaces to use for indenting YANG statement blocks.  It\ndefaults to **2** but when set to **0**, the generated output will\nomit newlines and other spacing for a more compact YANG output.\n\n      toString: (opts={ space: 2 }) ->\n        s = @kind\n        if @argument?\n          s += ' ' + switch @argument\n            when 'value' then switch\n              when Array.isArray(@tag) then \"'#{@tag.join(' ')}'\"\n              else \"'#{@tag}'\"\n            when 'text'\n              \"\\n\" + (indent '\"'+@tag+'\"', ' ', opts.space)\n            else @tag\n        sub =\n          @children\n            .filter (x) => x.parent is this\n            .map (x) -> x.toString opts\n            .join \"\\n\"\n        if !!sub\n          s += \" {\\n\" + (indent sub, ' ', opts.space) + \"\\n}\"\n        else\n          s += ';'\n        return s\n\n### toJSON\n\nThe current `Yang` expression will convert into a simple JS object\nformat.\n\n      # toJSON() is inherited from Element\n\n### valueOf\n\nThe current 'Yang' expression will convert into a primitive form for\ncomparision purposes.\n\n      valueOf: ->\n        switch @argument\n          when 'value','text' then @tag.valueOf()\n          else this\n\nPlease refer to [Schema Conversion](..\/TUTORIAL.md#schema-conversion)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n## Export Yang Class\n\n    module.exports = Yang\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"7645d5f92aaace5cad380fc94929f4a7c45eb005","subject":"make new instance of 'opts' for dealing with include dependency during import, see #59","message":"make new instance of 'opts' for dealing with include dependency during import, see #59\n","repos":"corenova\/yang-js","old_file":"src\/yang.litcoffee","new_file":"src\/yang.litcoffee","new_contents":"# Yang - evaluable schema expression\n\nThis module provides support for basic set of YANG schema modeling\nlanguage by using the built-in *extension* syntax to define additional\nschema language constructs. The actual YANG language [RFC\n6020](http:\/\/tools.ietf.org\/html\/rfc6020) specifications are loaded\ninside the [main module](.\/main.coffee).\n\nThis module is the **primary interface** for consumers of this\nlibrary.\n\n## Dependencies\n \n    debug  = require('debug')('yang:schema') if process.env.DEBUG?\n    fs     = require 'fs'\n    path   = require 'path'\n    parser = require 'yang-parser'\n    indent = require 'indent-string'\n\n    Expression = require '.\/expression'\n\n## Class Yang\n\n    class Yang extends Expression\n      @scope:\n        extension: '0..n'\n        typedef:   '0..n'\n        module:    '0..n'\n        submodule: '0..n'\n\n## Class-level methods\n\n      @clear: ->\n        @module.splice(0,@module.length) if @module?\n        @submodule.splice(0,@submodule.length) if @submodule?\n\n### parse (schema)\n\nThis class-level routine performs recursive parsing of passed in\nstatement and sub-statements. It provides syntactic, semantic and\ncontextual validations on the provided schema and returns the final JS\nobject tree structure as hierarchical Yang expression instances.\n\nIf any validation errors are encountered, it will throw the\nappropriate error along with the context information regarding the\nerror.\n\n      @parse: (schema, opts={}) ->\n        opts.compile ?= true\n        try\n          schema = parser.parse schema if typeof schema is 'string'\n        catch e\n          e.offset = 50 unless e.offset > 50\n          offender = schema.slice e.offset-50, e.offset+50\n          offender = offender.replace \/\\s\\s+\/g, ' '\n          throw @error \"invalid YANG syntax detected around: '#{offender}'\", offender\n\n        unless schema instanceof Object\n          throw @error \"must pass in valid YANG schema\", schema\n\n        kind = switch\n          when !!schema.prf then \"#{schema.prf}:#{schema.kw}\"\n          else schema.kw\n        tag = schema.arg if !!schema.arg\n\t\t\n        schema = (new this kind, tag).extends schema.substmts.map (x) => @parse x, compile: false\n        # perform final scoped constraint validation\n        for kind, constraint of schema.scope when constraint in [ '1', '1..n' ]\n          unless schema.hasOwnProperty kind\n            throw schema.error \"constraint violation for required '#{kind}' = #{constraint}\"\n        schema.compile() if opts.compile\n        return schema\n\nFor comprehensive overview on currently supported YANG statements,\nplease refer to\n[Compliance Report](..\/test\/yang-compliance-coverage.md) for the latest\n[RFC 6020](http:\/\/tools.ietf.org\/html\/rfc6020) YANG specification\ncompliance.\n\n### compose (data [, opts={}])\n\nThis call *accepts* any arbitrary JS object and it will attempt to\nconvert it into a structural `Yang` expression instance. It will\nanalyze the passed in JS data and perform best match mapping to an\nappropriate YANG schema representation to describe the input\ndata. This method will not be able to determine conditionals or any\nmeta-data to further constrain the data, but it should provide a good\nstarting point with the resulting `Yang` expression instance.\n\n      @compose: (data, opts={}) ->\n        unless data?\n          throw @error \"must supply input 'data' to compose\"\n\n        # explict compose\n        if opts.kind?\n          ext = Yang::lookup.call this, 'extension', opts.kind\n          unless ext instanceof Expression\n            throw @error \"unable to find requested '#{opts.kind}' extension\"\n          return ext.compose? data, opts\n\n        # implicit compose (dynamic discovery)\n        for ext in @extension when ext.compose instanceof Function\n          debug? \"checking data if #{ext.tag}\"\n          res = ext.compose data, opts\n          return res if res instanceof Yang\n\nThis facility is a powerful construct to dynamically generate `Yang`\nschema from ordinary JS objects. For additional usage examples, please\nrefer to [Dynamic Composition](..\/TUTORIAL.md#dynamic-composition)\nsection in the [Getting Started Guide](..\/TUTORIAL.md).\n\n### resolve (from..., name)\n\nThis call is internally used by [import](#import-name-opts) to\nperform a search within the local filesystem to locate a given YANG\nschema module by `name`. It will first check the calling code's local\n[package.json](..\/package.json) to look for a `models: {}`\nconfiguration section to identify where the target module can be\nfound. If there is an entry defined, it will then follow that\nreference - which may be a JS file, YANG schema text file, or another\nNPM module. If it is not found within the `models: {}` configuration\nblock or it fails to load the referenced dependency, it will then\nfallback to attempt to locate a YANG schema text file in the same\nfolder that the `resolve` request was made: `#{name}.yang`.\n\n      @resolve: (from..., name) ->\n        return null unless typeof name is 'string'\n        dir = from = switch\n          when from.length then from[0]\n          else path.resolve()\n        while not found? and dir not in [ '\/', '.' ]\n          target = \"#{dir}\/package.json\"\n          debug? \"[resolve] #{name} in #{target}\"\n          try\n            pkginfo = require(target)\n            found = pkginfo.models[name]\n          if found?\n            dir = path.dirname require.resolve(target)\n            debug? \"[resolve] #{name} check #{found} in #{dir}\"\n            unless !!path.extname found\n              from = switch\n                when found of pkginfo.dependencies\n                  path.resolve dir, 'node_modules', found\n                else path.resolve dir, found\n              if fs.existsSync from\n                return @resolve from, name\n              else\n                found = @resolve found, name\n          if not found? and pkginfo?.name is name\n            found = path.dirname require.resolve(target)\n          dir = path.dirname dir unless found?\n        file = switch\n          when not found? then path.resolve from, \"#{name}.yang\"\n          else path.resolve dir, found\n        debug? \"[resolve] checking if #{file} exists\"\n        return if fs.existsSync file then file else null\n\n### import (name [, opts={}])\n\nThis call provides a convenience mechanism for dealing with YANG\nschema module dependencies. It performs parsing of the YANG schema\ncontent from the specified `name` and saves the generated `Yang`\nexpression inside the internal registry. The `name` can be a YANG\nmodule name or a *filename* to the actual schema content (JS or YANG).\n\nOnce a given YANG module has been saved inside the registry,\nsubsequent [parse](#parse-schema) of YANG schema that *import* the\nsaved module will successfully resolve.\n\nTypical usage scenario for this pattern is to internally define common\nmodules such as `ietf-yang-types` which can then be *imported* by\nother schemas.\n\nIt will also return the new `Yang` expression instance (to do with as\nyou please).\n\n      @require: ->\n        console.warn \"DEPRECATION: please use .import() instead\"\n        @import arguments...\n\n      @import: (name, opts={}) ->\n        return unless name?\n        opts.basedir ?= ''\n        extname  = path.extname name\n        filename = path.resolve opts.basedir, name\n        basedir  = path.dirname filename\n\n        unless !!extname\n          return (Yang::match.call this, 'module', name) ? @import (@resolve name), opts\n\n        unless extname is '.yang'\n          res = require filename\n          unless res instanceof Yang\n            throw @error \"unable to import '#{name}' from '#{filename}' (not Yang expression)\", res\n          return res \n\n        try return @use (@parse (fs.readFileSync filename, 'utf-8'), opts)\n        catch e\n          unless opts.compile and e.name is 'ExpressionError' and e.context.kind in [ 'include', 'import' ]\n            console.error \"unable to #{e.context.kind} '#{name}' YANG module from '#{filename}'\"\n            throw e\n          if e.context.kind is 'include'\n            opts = Object.assign {}, opts\n            opts.compile = false \n\n          # try to find the dependency module for import\n          dependency = @import (@resolve basedir, e.context.tag), opts\n          unless dependency?\n            e.message = \"unable to auto-resolve '#{e.context.tag}' dependency module\"\n            throw e\n\n          # retry the original request\n          debug? \"retrying import(#{name})\"\n          return @import arguments...\n\nPlease note that this method will look for the `name` in current\nworking directory of the script execution if the `name` is a relative\npath. It utilizes the [resolve](#resolve-from-name) method and will\nattempt to **recursively** resolve any failed `import` dependencies.\n\nWhile this is a convenient abstraction, it is **recommended** to\ndirectly use the Node.js built-in `require` mechanism (if\navailable). Using native `require` instead of `Yang.import` will\nallow package bundlers such as `browserify` to capture the\ndependencies as part of the produced bundle.  It also allows you to\ndirectly load YANG schema files from other NPM modules.\n\nBy default, loading the [yang-js](.\/main.coffee) module will attempt\nto associate `.yang` extension inside `require` facility. If\navailable, it will allow you to `require('.\/some-dependency.yang')`\nand get back a parsed `Yang expression` instance.\n\n## Main constructor\n\nThis method can be called directly without the use of `new` keyword\nand will internally parse the provided schema and return a `bound\nfunction` which will invoke [eval](#eval-data-opts) when called.\n\n      constructor: (kind, tag, extension) ->\n        unless this instanceof Yang\n          [ schema, bindings ] = arguments\n          schema = Yang.parse schema unless schema instanceof Yang\n          return schema.bind bindings\n\n        extension ?= (@lookup 'extension', kind)\n        self = super kind, tag, extension\n        unless extension instanceof Expression\n          @debug \"defer processing of custom extension #{kind}\"\n          @once 'compile:before', (->\n            @debug \"processing deferred extension #{kind}\"\n            extension = (@lookup 'extension', kind)\n            unless extension instanceof Yang\n              throw @error \"encountered unknown extension '#{kind}'\"\n            { @source, @argument } = extension\n          ).bind self\n        return self\n\n      @property 'datakey',\n        get: -> switch\n          when @parent instanceof Yang and @parent.kind is 'module' then \"#{@parent.tag}:#{@tag}\"\n          when @parent instanceof Yang and @parent.kind is 'submodule'\n            \"#{@parent['belongs-to'].tag}:#{@tag}\"\n          else @tag ? @kind\n\n      @property 'datapath',\n        get: -> switch\n          when @parent not instanceof Yang then ''\n          when @node then @parent.datapath + \"\/#{@datakey}\"\n          else @parent.datapath\n          \n      error: (msg, context) -> super \"[#{@trail}] #{msg}\", context\n      \n      emit: (event, args...) ->\n        @emitter.emit arguments...\n        @root.emit event, this if event is 'change' and this isnt @root\n\n## Instance-level methods\n\n### bind (obj)\n\nEvery instance of `Yang` expression can be *bound* with control logic\nwhich will be used during [eval](#eval-data-opts) to produce schema\ninfused **adaptive data object**. This routine is *inherited* from\n[Class Expression](.\/expression.coffee).\n\nThis facility can be used to associate default behaviors for any\nelement in the configuration tree, as well as handler logic for\nvarious YANG statements such as *rpc*, *feature*, etc.\n\nThis call will return the original `Yang` expression instance with the\nnew bindings registered within the `Yang` expression hierarchy.\n\n      # bind() is inherited from Expression\n\nPlease refer to [Schema Binding](..\/TUTORIAL.md#schema-binding)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n### eval (data, opts={})\n\nEvery instance of `Yang` expression can be [eval](#eval-data-opts)\nwith arbitrary JS data input which will apply the schema against the\nprovided data and return a schema infused **adaptive** data object.\n\nThis is an extremely useful construct which brings out the true power\nof YANG for defining and governing arbitrary JS data structures.\n\nBasically, the input `data` will be YANG schema validated and\nconverted to a schema infused *adaptive data model* that dynamically\ndefines properties according to the schema expressions.\n\nIt currently supports the `opts.adaptive` parameter (default `false`)\nwhich establishes a persistent binding relationship with the governing\n`Yang` expression instance. This allows the generated model to\ndynamically **adapt** to any changes to the governing `Yang`\nexpression instance. Refer to below [extends](#extends-schema) section\nfor additional info on how the schema can be programmatically\nmodified.\n\n      eval: (data, opts={}) ->\n        if opts.adaptive is true\n          # TODO: this will break for 'module' which will return Model?\n          @once 'change', arguments.callee.bind(this, data, opts)\n        super\n\nPlease refer to [Working with Models](..\/TUTORIAL.md#working-with-models)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for special\nusage examples for `module` schemas.\n\n### extends (schema...)\n\nEvery instance of `Yang` expression can be `extends` with additional\nYANG schema string(s) and it will automatically perform\n[parse](#parse-schema) of the provided schema text and update itself\naccordingly.\n\nThis action also triggers an event emitter which will *retroactively*\nadapt any previously [eval](#eval-data-opts) produced adaptive data\nmodel instances to react accordingly to the newly changed underlying\nschema expression(s).\n\n      # extends() is inherited from Element\n\n      merge: (elem) ->\n        unless elem instanceof Yang\n          throw @error \"cannot merge invalid element into Yang\", elem\n\n        switch elem.kind\n          when 'type'     then super elem, append: true\n          when 'argument' then super elem, replace: true\n          else super\n\nPlease refer to [Schema Extension](..\/TUTORIAL.md#schema-extension)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n      normalizePath: (ypath) ->\n        lastPrefix = null\n        prefix2module = (root, prefix) ->\n          return unless root.kind is 'module'\n          switch\n            when root.tag is prefix then prefix\n            when root.prefix.tag is prefix then root.tag\n            else\n              for m in root.import ? [] when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              modules = root.lookup 'module'\n              for m in modules when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              return prefix # return as-is...\n              \n        normalizeEntry = (x) =>\n          return x unless x? and !!x\n          match = x.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n          unless match?\n            throw @error \"invalid path expression '#{x}' found in #{ypath}\"\n          [ prefix, target ] = [ match[1], match[2] ]\n          return switch\n            when not prefix? then target\n            when prefix is lastPrefix then target\n            else\n              lastPrefix = prefix\n              mname = prefix2module @root, prefix\n              \"#{mname}:#{target}\"\n        ypath = ypath.replace \/\\s\/g, ''\n        ypath\n          .split('\/')\n          .map normalizeEntry\n          .join('\/')\n\n### locate (ypath)\n\nThis is an internal helper facility used to locate a given schema node\nwithin the `Yang` schema expression tree hierarchy. It supports a\nlimited version of XPATH-like expression to locate an explicit\nelement.\n\n      locate: (ypath) ->\n        # TODO: figure out how to eliminate duplicate code-block section\n        # shared with Element\n        return unless ypath?\n        \n        @debug \"locate enter for '#{ypath}'\"\n        if typeof ypath is 'string'\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = @normalizePath(ypath).split('\/').filter (e) -> !!e\n        else\n          [ key, rest... ] = ypath\n        return this unless key? and key isnt '.'\n\n        if key is '..'\n          return @parent?.locate rest\n\n        match = key.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n        [ prefix, target ] = [ match[1], match[2] ]\n        if prefix? and this is @root\n          search = [target].concat(rest)\n          if (@tag is prefix) or (@lookup 'prefix', prefix)\n            @debug \"locate (local) '\/#{prefix}:#{search.join('\/')}'\"\n            return super search\n          for m in @import ? [] when m.tag is prefix or m.prefix.tag is prefix\n            @debug \"locate (external) '\/#{prefix}:#{search.join('\/')}'\"\n            return m.module.locate search\n          m = @lookup 'module', prefix\n          return m?.locate search\n\n        switch\n          when \/^{.+}$\/.test(target)\n            kind = 'grouping'\n            tag  = target.replace \/^{(.+)}$\/, '$1'\n          when \/^\\[.+\\]$\/.test(target)\n            kind = 'feature'\n            tag  = target.replace \/^\\[(.+)\\]$\/, '$1'\n          when \/^[^(]+\\([^)]*\\)$\/.test(target)\n            target = target.match \/^([^(]+)\\((.*)\\)$\/\n            [ kind, tag ] = [ target[1], target[2] ]\n            tag = undefined unless !!tag\n          when \/^\\<.+\\>$\/.test(target)\n            target = target.replace \/^\\<(.+)\\>$\/, '$1'\n            [ kind..., tag ]  = target.split ':'\n            [ tag, selector ] = tag.split '='\n            kind = kind[0] if kind?.length\n          else return super [key].concat rest\n            \n        match = @match kind, tag\n        return switch\n          when rest.length is 0 then match\n          else match?.locate rest\n\n### match (kind, tag)\n\nThis is an internal helper facility used by [locate](#locate-ypath) and\n[lookup](.\/element.litcoffee#lookup-kind-tag) to test whether a given\nentity exists in the local schema tree.\n\n      # Yang Expression can support 'tag' with prefix to another module\n      # (or itself).\n      match: (kind, tag) ->\n        return super unless kind? and tag? and typeof tag is 'string'\n        res = super\n        return res if res?\n        \n        [ prefix..., arg ] = tag.split ':'\n        return unless prefix.length\n\n        debug? \"[match] with #{kind} #{tag}\"\n\n        prefix = prefix[0]\n        debug? \"[match] check if current module's prefix\"\n        if @root.tag is prefix or @root.prefix?.tag is prefix\n          return @root.match kind, arg\n\n        debug? \"[match] checking if submodule's parent\"\n        ctx = @lookup 'belongs-to'\n        if ctx?.prefix.tag is prefix\n          return ctx.module.match kind, arg \n\n        debug? \"[match] check if one of current module's imports\"\n        imports = @root?.import ? []\n        for m in imports when m.prefix.tag is prefix\n          debug? m.module\n          return m.module.match kind, arg\n\n### toString (opts={})\n\nThe current `Yang` expression will covert back to the equivalent YANG\nschema text format.\n\nAt first glance, this may not seem like a useful facility since YANG\nschema text is *generally known* before [parse](#parse-schema) but it\nbecomes highly relevant when you consider a given `Yang` expression\nprogramatically changing via [extends](#extends-schema).\n\nCurrently it supports `space` parameter which can be used to specify\nnumber of spaces to use for indenting YANG statement blocks.  It\ndefaults to **2** but when set to **0**, the generated output will\nomit newlines and other spacing for a more compact YANG output.\n\n      toString: (opts={ space: 2 }) ->\n        s = @kind\n        if @source.argument?\n          s += ' ' + switch @source.argument\n            when 'value' then \"'#{@tag}'\"\n            when 'text'\n              \"\\n\" + (indent '\"'+@tag+'\"', ' ', opts.space)\n            else @tag\n        sub =\n          @elements\n            .filter (x) => x.parent is this\n            .map (x) -> x.toString opts\n            .join \"\\n\"\n        if !!sub\n          s += \" {\\n\" + (indent sub, ' ', opts.space) + \"\\n}\"\n        else\n          s += ';'\n        return s\n\n### toJSON\n\nThe current `Yang` expression will convert into a simple JS object\nformat.\n\n      # toJSON() is inherited from Element\n\n### valueOf\n\nThe current 'Yang' expression will convert into a primitive form for\ncomparision purposes.\n\n      valueOf: ->\n        switch @source.argument\n          when 'value','text' then @tag.valueOf()\n          else this\n\nPlease refer to [Schema Conversion](..\/TUTORIAL.md#schema-conversion)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n## Export Yang Class\n\n    module.exports = Yang\n","old_contents":"# Yang - evaluable schema expression\n\nThis module provides support for basic set of YANG schema modeling\nlanguage by using the built-in *extension* syntax to define additional\nschema language constructs. The actual YANG language [RFC\n6020](http:\/\/tools.ietf.org\/html\/rfc6020) specifications are loaded\ninside the [main module](.\/main.coffee).\n\nThis module is the **primary interface** for consumers of this\nlibrary.\n\n## Dependencies\n \n    debug  = require('debug')('yang:schema') if process.env.DEBUG?\n    fs     = require 'fs'\n    path   = require 'path'\n    parser = require 'yang-parser'\n    indent = require 'indent-string'\n\n    Expression = require '.\/expression'\n\n## Class Yang\n\n    class Yang extends Expression\n      @scope:\n        extension: '0..n'\n        typedef:   '0..n'\n        module:    '0..n'\n        submodule: '0..n'\n\n## Class-level methods\n\n      @clear: ->\n        @module.splice(0,@module.length) if @module?\n        @submodule.splice(0,@submodule.length) if @submodule?\n\n### parse (schema)\n\nThis class-level routine performs recursive parsing of passed in\nstatement and sub-statements. It provides syntactic, semantic and\ncontextual validations on the provided schema and returns the final JS\nobject tree structure as hierarchical Yang expression instances.\n\nIf any validation errors are encountered, it will throw the\nappropriate error along with the context information regarding the\nerror.\n\n      @parse: (schema, opts={}) ->\n        opts.compile ?= true\n        try\n          schema = parser.parse schema if typeof schema is 'string'\n        catch e\n          e.offset = 50 unless e.offset > 50\n          offender = schema.slice e.offset-50, e.offset+50\n          offender = offender.replace \/\\s\\s+\/g, ' '\n          throw @error \"invalid YANG syntax detected around: '#{offender}'\", offender\n\n        unless schema instanceof Object\n          throw @error \"must pass in valid YANG schema\", schema\n\n        kind = switch\n          when !!schema.prf then \"#{schema.prf}:#{schema.kw}\"\n          else schema.kw\n        tag = schema.arg if !!schema.arg\n\t\t\n        schema = (new this kind, tag).extends schema.substmts.map (x) => @parse x, false\n        # perform final scoped constraint validation\n        for kind, constraint of schema.scope when constraint in [ '1', '1..n' ]\n          unless schema.hasOwnProperty kind\n            throw schema.error \"constraint violation for required '#{kind}' = #{constraint}\"\n        schema.compile() if opts.compile\n        return schema\n\nFor comprehensive overview on currently supported YANG statements,\nplease refer to\n[Compliance Report](..\/test\/yang-compliance-coverage.md) for the latest\n[RFC 6020](http:\/\/tools.ietf.org\/html\/rfc6020) YANG specification\ncompliance.\n\n### compose (data [, opts={}])\n\nThis call *accepts* any arbitrary JS object and it will attempt to\nconvert it into a structural `Yang` expression instance. It will\nanalyze the passed in JS data and perform best match mapping to an\nappropriate YANG schema representation to describe the input\ndata. This method will not be able to determine conditionals or any\nmeta-data to further constrain the data, but it should provide a good\nstarting point with the resulting `Yang` expression instance.\n\n      @compose: (data, opts={}) ->\n        unless data?\n          throw @error \"must supply input 'data' to compose\"\n\n        # explict compose\n        if opts.kind?\n          ext = Yang::lookup.call this, 'extension', opts.kind\n          unless ext instanceof Expression\n            throw @error \"unable to find requested '#{opts.kind}' extension\"\n          return ext.compose? data, opts\n\n        # implicit compose (dynamic discovery)\n        for ext in @extension when ext.compose instanceof Function\n          debug? \"checking data if #{ext.tag}\"\n          res = ext.compose data, opts\n          return res if res instanceof Yang\n\nThis facility is a powerful construct to dynamically generate `Yang`\nschema from ordinary JS objects. For additional usage examples, please\nrefer to [Dynamic Composition](..\/TUTORIAL.md#dynamic-composition)\nsection in the [Getting Started Guide](..\/TUTORIAL.md).\n\n### resolve (from..., name)\n\nThis call is internally used by [import](#import-name-opts) to\nperform a search within the local filesystem to locate a given YANG\nschema module by `name`. It will first check the calling code's local\n[package.json](..\/package.json) to look for a `models: {}`\nconfiguration section to identify where the target module can be\nfound. If there is an entry defined, it will then follow that\nreference - which may be a JS file, YANG schema text file, or another\nNPM module. If it is not found within the `models: {}` configuration\nblock or it fails to load the referenced dependency, it will then\nfallback to attempt to locate a YANG schema text file in the same\nfolder that the `resolve` request was made: `#{name}.yang`.\n\n      @resolve: (from..., name) ->\n        return null unless typeof name is 'string'\n        dir = from = switch\n          when from.length then from[0]\n          else path.resolve()\n        while not found? and dir not in [ '\/', '.' ]\n          target = \"#{dir}\/package.json\"\n          debug? \"[resolve] #{name} in #{target}\"\n          try\n            pkginfo = require(target)\n            found = pkginfo.models[name]\n          if found?\n            dir = path.dirname require.resolve(target)\n            debug? \"[resolve] #{name} check #{found} in #{dir}\"\n            unless !!path.extname found\n              from = switch\n                when found of pkginfo.dependencies\n                  path.resolve dir, 'node_modules', found\n                else path.resolve dir, found\n              if fs.existsSync from\n                return @resolve from, name\n              else\n                found = @resolve found, name\n          if not found? and pkginfo?.name is name\n            found = path.dirname require.resolve(target)\n          dir = path.dirname dir unless found?\n        file = switch\n          when not found? then path.resolve from, \"#{name}.yang\"\n          else path.resolve dir, found\n        debug? \"[resolve] checking if #{file} exists\"\n        return if fs.existsSync file then file else null\n\n### import (name [, opts={}])\n\nThis call provides a convenience mechanism for dealing with YANG\nschema module dependencies. It performs parsing of the YANG schema\ncontent from the specified `name` and saves the generated `Yang`\nexpression inside the internal registry. The `name` can be a YANG\nmodule name or a *filename* to the actual schema content (JS or YANG).\n\nOnce a given YANG module has been saved inside the registry,\nsubsequent [parse](#parse-schema) of YANG schema that *import* the\nsaved module will successfully resolve.\n\nTypical usage scenario for this pattern is to internally define common\nmodules such as `ietf-yang-types` which can then be *imported* by\nother schemas.\n\nIt will also return the new `Yang` expression instance (to do with as\nyou please).\n\n      @require: ->\n        console.warn \"DEPRECATION: please use .import() instead\"\n        @import arguments...\n\n      @import: (name, opts={}) ->\n        return unless name?\n        opts.basedir ?= ''\n        extname  = path.extname name\n        filename = path.resolve opts.basedir, name\n        basedir  = path.dirname filename\n\n        unless !!extname\n          return (Yang::match.call this, 'module', name) ? @import (@resolve name), opts\n\n        unless extname is '.yang'\n          res = require filename\n          unless res instanceof Yang\n            throw @error \"unable to import '#{name}' from '#{filename}' (not Yang expression)\", res\n          return res \n\n        try return @use (@parse (fs.readFileSync filename, 'utf-8'), opts)\n        catch e\n          unless opts.compile and e.name is 'ExpressionError' and e.context.kind in [ 'include', 'import' ]\n            console.error \"unable to import '#{name}' YANG module from '#{filename}'\"\n            throw e\n          opts.compile = false if e.context.kind is 'include'\n\n          # try to find the dependency module for import\n          dependency = @import (@resolve basedir, e.context.tag), opts\n          unless dependency?\n            e.message = \"unable to auto-resolve '#{e.context.tag}' dependency module\"\n            throw e\n\n          # retry the original request\n          debug? \"retrying import(#{name})\"\n          return @import arguments...\n\nPlease note that this method will look for the `name` in current\nworking directory of the script execution if the `name` is a relative\npath. It utilizes the [resolve](#resolve-from-name) method and will\nattempt to **recursively** resolve any failed `import` dependencies.\n\nWhile this is a convenient abstraction, it is **recommended** to\ndirectly use the Node.js built-in `require` mechanism (if\navailable). Using native `require` instead of `Yang.import` will\nallow package bundlers such as `browserify` to capture the\ndependencies as part of the produced bundle.  It also allows you to\ndirectly load YANG schema files from other NPM modules.\n\nBy default, loading the [yang-js](.\/main.coffee) module will attempt\nto associate `.yang` extension inside `require` facility. If\navailable, it will allow you to `require('.\/some-dependency.yang')`\nand get back a parsed `Yang expression` instance.\n\n## Main constructor\n\nThis method can be called directly without the use of `new` keyword\nand will internally parse the provided schema and return a `bound\nfunction` which will invoke [eval](#eval-data-opts) when called.\n\n      constructor: (kind, tag, extension) ->\n        unless this instanceof Yang\n          [ schema, bindings ] = arguments\n          schema = Yang.parse schema unless schema instanceof Yang\n          return schema.bind bindings\n\n        extension ?= (@lookup 'extension', kind)\n        self = super kind, tag, extension\n        unless extension instanceof Expression\n          @debug \"defer processing of custom extension #{kind}\"\n          @once 'compile:before', (->\n            @debug \"processing deferred extension #{kind}\"\n            extension = (@lookup 'extension', kind)\n            unless extension instanceof Yang\n              throw @error \"encountered unknown extension '#{kind}'\"\n            { @source, @argument } = extension\n          ).bind self\n        return self\n\n      @property 'datakey',\n        get: -> switch\n          when @parent instanceof Yang and @parent.kind is 'module' then \"#{@parent.tag}:#{@tag}\"\n          when @parent instanceof Yang and @parent.kind is 'submodule'\n            \"#{@parent['belongs-to'].tag}:#{@tag}\"\n          else @tag ? @kind\n\n      @property 'datapath',\n        get: -> switch\n          when @parent not instanceof Yang then ''\n          when @node then @parent.datapath + \"\/#{@datakey}\"\n          else @parent.datapath\n          \n      error: (msg, context) -> super \"[#{@trail}] #{msg}\", context\n      \n      emit: (event, args...) ->\n        @emitter.emit arguments...\n        @root.emit event, this if event is 'change' and this isnt @root\n\n## Instance-level methods\n\n### bind (obj)\n\nEvery instance of `Yang` expression can be *bound* with control logic\nwhich will be used during [eval](#eval-data-opts) to produce schema\ninfused **adaptive data object**. This routine is *inherited* from\n[Class Expression](.\/expression.coffee).\n\nThis facility can be used to associate default behaviors for any\nelement in the configuration tree, as well as handler logic for\nvarious YANG statements such as *rpc*, *feature*, etc.\n\nThis call will return the original `Yang` expression instance with the\nnew bindings registered within the `Yang` expression hierarchy.\n\n      # bind() is inherited from Expression\n\nPlease refer to [Schema Binding](..\/TUTORIAL.md#schema-binding)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n### eval (data, opts={})\n\nEvery instance of `Yang` expression can be [eval](#eval-data-opts)\nwith arbitrary JS data input which will apply the schema against the\nprovided data and return a schema infused **adaptive** data object.\n\nThis is an extremely useful construct which brings out the true power\nof YANG for defining and governing arbitrary JS data structures.\n\nBasically, the input `data` will be YANG schema validated and\nconverted to a schema infused *adaptive data model* that dynamically\ndefines properties according to the schema expressions.\n\nIt currently supports the `opts.adaptive` parameter (default `false`)\nwhich establishes a persistent binding relationship with the governing\n`Yang` expression instance. This allows the generated model to\ndynamically **adapt** to any changes to the governing `Yang`\nexpression instance. Refer to below [extends](#extends-schema) section\nfor additional info on how the schema can be programmatically\nmodified.\n\n      eval: (data, opts={}) ->\n        if opts.adaptive is true\n          # TODO: this will break for 'module' which will return Model?\n          @once 'change', arguments.callee.bind(this, data, opts)\n        super\n\nPlease refer to [Working with Models](..\/TUTORIAL.md#working-with-models)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for special\nusage examples for `module` schemas.\n\n### extends (schema...)\n\nEvery instance of `Yang` expression can be `extends` with additional\nYANG schema string(s) and it will automatically perform\n[parse](#parse-schema) of the provided schema text and update itself\naccordingly.\n\nThis action also triggers an event emitter which will *retroactively*\nadapt any previously [eval](#eval-data-opts) produced adaptive data\nmodel instances to react accordingly to the newly changed underlying\nschema expression(s).\n\n      # extends() is inherited from Element\n\n      merge: (elem) ->\n        unless elem instanceof Yang\n          throw @error \"cannot merge invalid element into Yang\", elem\n\n        switch elem.kind\n          when 'type'     then super elem, append: true\n          when 'argument' then super elem, replace: true\n          else super\n\nPlease refer to [Schema Extension](..\/TUTORIAL.md#schema-extension)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n      normalizePath: (ypath) ->\n        lastPrefix = null\n        prefix2module = (root, prefix) ->\n          return unless root.kind is 'module'\n          switch\n            when root.tag is prefix then prefix\n            when root.prefix.tag is prefix then root.tag\n            else\n              for m in root.import ? [] when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              modules = root.lookup 'module'\n              for m in modules when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              return prefix # return as-is...\n              \n        normalizeEntry = (x) =>\n          return x unless x? and !!x\n          match = x.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n          unless match?\n            throw @error \"invalid path expression '#{x}' found in #{ypath}\"\n          [ prefix, target ] = [ match[1], match[2] ]\n          return switch\n            when not prefix? then target\n            when prefix is lastPrefix then target\n            else\n              lastPrefix = prefix\n              mname = prefix2module @root, prefix\n              \"#{mname}:#{target}\"\n        ypath = ypath.replace \/\\s\/g, ''\n        ypath\n          .split('\/')\n          .map normalizeEntry\n          .join('\/')\n\n### locate (ypath)\n\nThis is an internal helper facility used to locate a given schema node\nwithin the `Yang` schema expression tree hierarchy. It supports a\nlimited version of XPATH-like expression to locate an explicit\nelement.\n\n      locate: (ypath) ->\n        # TODO: figure out how to eliminate duplicate code-block section\n        # shared with Element\n        return unless ypath?\n        \n        @debug \"locate enter for '#{ypath}'\"\n        if typeof ypath is 'string'\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = @normalizePath(ypath).split('\/').filter (e) -> !!e\n        else\n          [ key, rest... ] = ypath\n        return this unless key? and key isnt '.'\n\n        if key is '..'\n          return @parent?.locate rest\n\n        match = key.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n        [ prefix, target ] = [ match[1], match[2] ]\n        if prefix? and this is @root\n          search = [target].concat(rest)\n          if (@tag is prefix) or (@lookup 'prefix', prefix)\n            @debug \"locate (local) '\/#{prefix}:#{search.join('\/')}'\"\n            return super search\n          for m in @import ? [] when m.tag is prefix or m.prefix.tag is prefix\n            @debug \"locate (external) '\/#{prefix}:#{search.join('\/')}'\"\n            return m.module.locate search\n          m = @lookup 'module', prefix\n          return m?.locate search\n\n        switch\n          when \/^{.+}$\/.test(target)\n            kind = 'grouping'\n            tag  = target.replace \/^{(.+)}$\/, '$1'\n          when \/^\\[.+\\]$\/.test(target)\n            kind = 'feature'\n            tag  = target.replace \/^\\[(.+)\\]$\/, '$1'\n          when \/^[^(]+\\([^)]*\\)$\/.test(target)\n            target = target.match \/^([^(]+)\\((.*)\\)$\/\n            [ kind, tag ] = [ target[1], target[2] ]\n            tag = undefined unless !!tag\n          when \/^\\<.+\\>$\/.test(target)\n            target = target.replace \/^\\<(.+)\\>$\/, '$1'\n            [ kind..., tag ]  = target.split ':'\n            [ tag, selector ] = tag.split '='\n            kind = kind[0] if kind?.length\n          else return super [key].concat rest\n            \n        match = @match kind, tag\n        return switch\n          when rest.length is 0 then match\n          else match?.locate rest\n\n### match (kind, tag)\n\nThis is an internal helper facility used by [locate](#locate-ypath) and\n[lookup](.\/element.litcoffee#lookup-kind-tag) to test whether a given\nentity exists in the local schema tree.\n\n      # Yang Expression can support 'tag' with prefix to another module\n      # (or itself).\n      match: (kind, tag) ->\n        return super unless kind? and tag? and typeof tag is 'string'\n        res = super\n        return res if res?\n        \n        [ prefix..., arg ] = tag.split ':'\n        return unless prefix.length\n\n        debug? \"[match] with #{kind} #{tag}\"\n\n        prefix = prefix[0]\n        debug? \"[match] check if current module's prefix\"\n        if @root.tag is prefix or @root.prefix?.tag is prefix\n          return @root.match kind, arg\n\n        debug? \"[match] checking if submodule's parent\"\n        ctx = @lookup 'belongs-to'\n        if ctx?.prefix.tag is prefix\n          return ctx.module.match kind, arg \n\n        debug? \"[match] check if one of current module's imports\"\n        imports = @root?.import ? []\n        for m in imports when m.prefix.tag is prefix\n          debug? m.module\n          return m.module.match kind, arg\n\n### toString (opts={})\n\nThe current `Yang` expression will covert back to the equivalent YANG\nschema text format.\n\nAt first glance, this may not seem like a useful facility since YANG\nschema text is *generally known* before [parse](#parse-schema) but it\nbecomes highly relevant when you consider a given `Yang` expression\nprogramatically changing via [extends](#extends-schema).\n\nCurrently it supports `space` parameter which can be used to specify\nnumber of spaces to use for indenting YANG statement blocks.  It\ndefaults to **2** but when set to **0**, the generated output will\nomit newlines and other spacing for a more compact YANG output.\n\n      toString: (opts={ space: 2 }) ->\n        s = @kind\n        if @source.argument?\n          s += ' ' + switch @source.argument\n            when 'value' then \"'#{@tag}'\"\n            when 'text'\n              \"\\n\" + (indent '\"'+@tag+'\"', ' ', opts.space)\n            else @tag\n        sub =\n          @elements\n            .filter (x) => x.parent is this\n            .map (x) -> x.toString opts\n            .join \"\\n\"\n        if !!sub\n          s += \" {\\n\" + (indent sub, ' ', opts.space) + \"\\n}\"\n        else\n          s += ';'\n        return s\n\n### toJSON\n\nThe current `Yang` expression will convert into a simple JS object\nformat.\n\n      # toJSON() is inherited from Element\n\n### valueOf\n\nThe current 'Yang' expression will convert into a primitive form for\ncomparision purposes.\n\n      valueOf: ->\n        switch @source.argument\n          when 'value','text' then @tag.valueOf()\n          else this\n\nPlease refer to [Schema Conversion](..\/TUTORIAL.md#schema-conversion)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n## Export Yang Class\n\n    module.exports = Yang\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"69665a2f9f73146fa15b22a6dd0cfcd9cb37ec52","subject":"Remove the identity transmission from data","message":"Remove the identity transmission from data\n\nThis is going in a separate module shortly.\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/data.litcoffee","new_file":"src\/coffee\/data.litcoffee","new_contents":"Primary Data Sources\n====================\n\nThis API presents the primary data sources to the system, from which\nall other data are derived.\n\nThese primary data sources come in two categories: *local* and *global*.\n\nItems in the *local* category apply *only* to the current screen. Presently,\nthey are:\n\n* Mode,\n* Override HTML.\n\nThe former refers to a centrally-controlled option defining what the screen will\nbe showing, and the latter is a facility for *directly* sending raw HTML to be\ndisplayed.\n\nItems in the *global* category refer to state shared by all screens from compd,\nin particular:\n\n* Teams,\n* Day schedule,\n* Match schedule,\n* The *kill* state.\n\nInternal Buses\n--------------\n\nWe create a bus for each of the primary data source, into which we internally\ninject events. The public APIs are the *toProperty* equivalents of these.\n\n    mode = new Bacon.Bus\n    overrideText = new Bacon.Bus\n\n    teams = new Bacon.Bus\n    daySchedule = new Bacon.Bus\n    matchSchedule = new Bacon.Bus\n    killState = new Bacon.Bus\n\nMessage Dispatch\n----------------\n\nWe subscribe to the message stream from *WS*, handling any data updates which\nare relevant to us.\n\n    WS.message.onValue (msg) ->\n        switch msg.type\n\nThe first case we handle is that of the *mode* message, containing a new mode\nfor us to enter.\n\n            when \"mode\" then mode.push msg.mode\n\nThe *teams* message contains an updated teams information object, which we\nsimply republish verbatim.\n\n            when \"teams\" then teams.push msg.teams\n\nSimilarly for the day and match schedules.\n\n            when \"day\" then daySchedule.push msg.schedule\n            when \"matches\" then matchSchedule.push msg.schedule\n\nFor the override text, we are able to do something similar. Note, however, that\nthe override text, while normally a string, is nullable, with the null value\nindicating that this screen should not be overridden.\n\n            when \"override\" then overrideText.push msg.override\n\nFinally, we handle the *kill* state. The *kill* state is controlled via two\nmessages rather than one: the *kill* message, indicating that the kill mode has\nbeen triggered and containing the screen ID of the source as its argument, and\nthe *kill-end* message, indicating that the kill mode has been administratively\ncleared.\n\n            when \"kill\" then killState.push msg.source\n            when \"kill-end\" then killState.push null\n\nPublic API\n----------\n\nWe publish properties for each of the primary data sources, each of which has a\nsensible default value.\n\n    window.Data =\n\nThe *mode* property contains the initial startup mode, *default*, which shows\nthe Student Robotics logo as well as a clock.\n\n        mode: mode.toProperty 'default'\n\nThe *teams* property contains an empty team mapping.\n\n        teams: teams.toProperty {}\n\nThe *daySchedule* and *matchSchedule* properties similarly contain empty\nschedules as their initial values.\n\n        daySchedule: daySchedule.toProperty []\n        matchSchedule: matchSchedule.toProperty []\n\nThe *overrideText* and *killState* properties are nullable, and are both given\nnull as their initial values.\n\n        overrideText: overrideText.toProperty null\n        killState: killState.toProperty null\n\n","old_contents":"Primary Data Sources\n====================\n\nThis API presents the primary data sources to the system, from which\nall other data are derived.\n\nThese primary data sources come in two categories: *local* and *global*.\n\nItems in the *local* category apply *only* to the current screen. Presently,\nthey are:\n\n* Mode,\n* Override HTML.\n\nThe former refers to a centrally-controlled option defining what the screen will\nbe showing, and the latter is a facility for *directly* sending raw HTML to be\ndisplayed.\n\nItems in the *global* category refer to state shared by all screens from compd,\nin particular:\n\n* Teams,\n* Day schedule,\n* Match schedule,\n* The *kill* state.\n\nScreen ID Transmission\n----------------------\n\nFirst, we transmit the screen ID to the server, using the *iam* message. In\nfuture, this will be derived from user input in some fashion; for the time\nbeing, it is a constant string, for testing purposes.\n\n    WS.send 'iam', screen: 'example'\n\nInternal Buses\n--------------\n\nWe create a bus for each of the primary data source, into which we internally\ninject events. The public APIs are the *toProperty* equivalents of these.\n\n    mode = new Bacon.Bus\n    overrideText = new Bacon.Bus\n\n    teams = new Bacon.Bus\n    daySchedule = new Bacon.Bus\n    matchSchedule = new Bacon.Bus\n    killState = new Bacon.Bus\n\nMessage Dispatch\n----------------\n\nWe subscribe to the message stream from *WS*, handling any data updates which\nare relevant to us.\n\n    WS.message.onValue (msg) ->\n        switch msg.type\n\nThe first case we handle is that of the *mode* message, containing a new mode\nfor us to enter.\n\n            when \"mode\" then mode.push msg.mode\n\nThe *teams* message contains an updated teams information object, which we\nsimply republish verbatim.\n\n            when \"teams\" then teams.push msg.teams\n\nSimilarly for the day and match schedules.\n\n            when \"day\" then daySchedule.push msg.schedule\n            when \"matches\" then matchSchedule.push msg.schedule\n\nFor the override text, we are able to do something similar. Note, however, that\nthe override text, while normally a string, is nullable, with the null value\nindicating that this screen should not be overridden.\n\n            when \"override\" then overrideText.push msg.override\n\nFinally, we handle the *kill* state. The *kill* state is controlled via two\nmessages rather than one: the *kill* message, indicating that the kill mode has\nbeen triggered and containing the screen ID of the source as its argument, and\nthe *kill-end* message, indicating that the kill mode has been administratively\ncleared.\n\n            when \"kill\" then killState.push msg.source\n            when \"kill-end\" then killState.push null\n\nPublic API\n----------\n\nWe publish properties for each of the primary data sources, each of which has a\nsensible default value.\n\n    window.Data =\n\nThe *mode* property contains the initial startup mode, *default*, which shows\nthe Student Robotics logo as well as a clock.\n\n        mode: mode.toProperty 'default'\n\nThe *teams* property contains an empty team mapping.\n\n        teams: teams.toProperty {}\n\nThe *daySchedule* and *matchSchedule* properties similarly contain empty\nschedules as their initial values.\n\n        daySchedule: daySchedule.toProperty []\n        matchSchedule: matchSchedule.toProperty []\n\nThe *overrideText* and *killState* properties are nullable, and are both given\nnull as their initial values.\n\n        overrideText: overrideText.toProperty null\n        killState: killState.toProperty null\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3e4c7956ce893e4a8fb9a03f95e2632cc82247c9","subject":"Update functions.litcoffee","message":"Update functions.litcoffee","repos":"andychase\/date_machine,andychase\/date_machine,andychase\/date_machine,andychase\/date_machine","old_file":"date_machine\/javascript\/functions.litcoffee","new_file":"date_machine\/javascript\/functions.litcoffee","new_contents":"### This file\n\nThe logic in this file builds the date object.\n\nIf you compare this file to the ```python\/functions.py``` file\nyou'll notice they are very similiar. That's intentional,\nthis file was ported over and kept such that it would be somewhat\neasy to port changes back and forth.\n\n### Terminology\n\nBecause it's so confusing here is a list of the different levels to refer to:\n\n- Groups \n  -- This is the capture groups. The lowest level. ```([0-9])``` etc.\n  \"Day\", \"Month\", etc.\n- Expressions \n  -- This is an expression with multiple capture groups. They're usually named\n  after the person that wrote them. \"Greg Burns\", etc.\n  \n  In Python, Expressions functions have nice named arguments, def expr(Day, Month, Year),\n  but Javascript doesn't support this.\n- Type\n  -- This is a collection of expressions with a common goal.\n  Months (Jan, 0-12, January, etc.). \n- Patterns\n  -- This is a collection of types ```<Month>\/<Day>\/<Year>```\n\n### Warning\n\nA note about the above list. Types and Groups are commonly mixed up.\nI think groups SHOULD be the lowest \n(because they are the actual capture *groups* in regular expressions)\nbut a group of expressions also makes sense.\n\nIt's so confusing that there are at least a couple places here that I've\nalso mixed myself up and probably in the documentation for RE|PARSE as well.\n\n---\n\nI use named tuples in python, and ```_replace``` mirrors the functionality of \n```date._replace```.. that is that it returns a copy of the date with only\ncertain things changed and leaves the old well enough alone.\n\n        _replace = (_old, _new) ->\n            year:   if _new.year? then _new.year else _old.year\n            month:  if _new.month? then _new.month else _old.month\n            day:    if _new.day? then _new.day  else _old.day\n            hour:   if _new.hour? then _new.hour else _old.hour\n            minute: if _new.minute? then _new.minute else _old.minute\n            second: if _new.second? then _new.second else _old.second\n            am_pm:  if _new.am_pm? then _new.am_pm else _old.am_pm\n\nI represent lengths of dates (i.e. Thursday, 1-2pm) with a timedelta that goes right\nafter the date hash in the result array.\n\nIn Javascript, I'm just going to represent a timedelta with a hash.\nI make a pretty dumb assumption that timedelta will only cross hour\/minutes\/second boundaries.\n\n        timedelta_from_Date = (start_time, end_time) ->\n            seconds_difference = 0\n            if start_time.hour? and end_time.hour?\n              seconds_difference += 60*60*(end_time.hour - start_time.hour)\n\n              if start_time.minute? and end_time.minute?\n                seconds_difference += 60*(end_time.minute - start_time.minute)\n\n                if start_time.second? and end_time.second?\n                  seconds_difference += end_time.second - start_time.second\n\n            hours = Math.floor(seconds_difference\/60\/60)\n            minutes = Math.floor(seconds_difference\/60) - (hours * 60)\n            seconds = seconds_difference - (minutes * 60) - (hours * 60 * 60)\n\n            return {\n               timedelta: true\n               hours: hours\n               minutes: minutes\n               seconds: seconds\n            }\n\n\nThis is just a helper function\n\n        in_array = (arr, _) -> arr.indexOf(_) != -1\n\n```progressive_match``` is useful for matching abbreviations\nand full spellings. Functions like this could be useful\nto help parse fuzzy matches in the future (i.e. misspellings of months).\n\n        progressive_match = (string, possibilities) ->\n            part = \"\"\n            if not string? then return\n            for character in string.toLowerCase()\n                part += character\n                matches = []\n                for month, value of possibilities\n                    if month.indexOf(part) > -1\n                        matches.push(month)\n                if matches.length == 1\n                    return possibilities[matches[0]]\n### Types\n\n\n        month_to_number = (month_string) ->\n          months =\n              \"january\": 1\n              \"february\": 2\n              \"march\": 3\n              \"april\": 4\n              \"may\": 5\n              \"june\": 6\n              \"july\": 7\n              \"august\": 8\n              \"september\": 9\n              \"october\": 10\n              \"november\": 11\n              \"december\": 12\n           return progressive_match(month_string, months)\n\n        weekday_to_number = (WeekdayString ) ->\n            weekday_list = {\n                \"monday\": 0,\n                \"tuesday\": 1,\n                \"wednesday\": 2,\n                \"thursday\": 3,\n                \"friday\": 4,\n                \"saturday\": 5,\n                \"sunday\": 6,\n            }\n            return progressive_match(WeekdayString, weekday_list)\n\nI serialize am_pm by converting the hours to milliary\/24-hour time format.\nI also include ```am_pm: 'pm'``` in the date format to show that that transformation\nwas done. Making that clear helpful because if you get a time like 1, with no ```am_pm```\ndesignation you might want to assume pm and add 12. This is not done in the libary because\ndate_machine strives for honesty, not guesswork.\n\n        am_pm = (input) ->\n            if not input?\n              return\n            if input.toLowerCase() == \"am\" then 0\n            else if input.toLowerCase() == \"pm\" then 12\n\nI try not to repeat logic and use other functions when possible.\nI could put ```\"Steve Valaitis2\": time_expression``` to avoid this,\nbut I wrote it out to show that nothing special happens with 24-hour\/military time.\n\n        military_time = (MilHour, MilMinute, MilSecond ) ->\n            return time_expression(MilHour, MilMinute, MilSecond, undefined)\n\nHere is the am\/pm conversion. I omit returns when the expressions are simple,\nbut later on I want to use them as much as possible to make my intentions clear.\n\n        noon = (hour, AMPM) -> hour == 12 and AMPM == 12\n        midnight = (hour, AMPM) -> hour == 12 and AMPM == 0\n\nThis function gets called pretty often, I'd consider it the bulk\nof the output logic.\n\n        time_expression = (Hour, Minute, Second, AMPM, SpecialTimeText ) ->\n            if not Hour? and not Minute? and not Second? and not AMPM? and not SpecialTimeText?\n                return\n            if SpecialTimeText\n                if SpecialTimeText.toLowerCase() == \"noon\"\n                    return {hour: 12}\n                if SpecialTimeText.toLowerCase() == \"midnight\"\n                    return {hour: 0}\n            d = {}\n            if Hour\n                d.hour = Number(Hour)\n            if Minute\n                d.minute = Number(Minute)\n            if Second\n                d.second = Number(Second)\n            if AMPM?\n                if d.hour\n                    if noon(d.hour, AMPM)\n                        d.hour = 12\n                    else if midnight(d.hour, AMPM)\n                        d.hour = 0\n                    else\n                        d.hour = d.hour + AMPM\n                d.am_pm = AMPM\n            if [d.hour, d.minute, d.second] == [undefined, undefined, undefined]\n                return undefined\n            return d\n\n        time_and_time = (Hour, Minute, AMPM1, Hour2, Minute2, AMPM2) ->\n            if AMPM2?\n                AMPM2 = am_pm(AMPM2)\n            if not AMPM1? and not AMPM2?\n                return [time_expression(Hour, Minute), time_expression(Hour2, Minute2)]\n            else if not AMPM1?\n                return [time_expression(Hour, Minute, undefined, AMPM2),\n                        time_expression(Hour2, Minute2, undefined, AMPM2)]\n            else if not AMPM2?\n                return [time_expression(Hour, Minute, undefined, AMPM1),\n                        time_expression(Hour2, Minute2, undefined, AMPM1)]\n\n\n        month_type = (input...) ->\n            for value in input\n                if value?\n                    return Number(value)\n\n\n        date_number = (Day, Abbr) -> if Day? then Number(Day)\n\n        month_number = (MonthNum) -> Number(MonthNum)\n\n        month_num_type = (input) -> Number(input)\n\n        year = (Year) -> if Year? then Number(Year)\n\nSometimes the value is ```[undefined, undefined, <value>]```,\nso I need to search for it and find it. There's enough\nof these smaller expressions scattered around that moving them\nall to one place might be good.\n\n        get_first_defined = (_) ->\n          for item in _\n            if item?\n              return item\n\n### Patterns\n\nThere's a some unwrapping values out of arrays here.\nBecause there's no named-arguments, functions receive a lot more\narrays here then in Python and so they need to be unwrapped.\n\n        weekday_range_with_time = (time1, time2, [weekday1], [weekday2], MonthRange) ->\n            output = []\n\n            # Get first undefined value\n            # Since only one value in list will be defined (if any)\n            time1 = get_first_defined(time1)\n            time2 = get_first_defined(time2)\n\n            if time1?\n                for date in MonthRange\n                    output.push(_replace(date, time1))\n                    if time2?\n                        output.push(_replace(date, time2))\n            return output\n\n\n        weekday_range_with_extra = ( time, and_time, weekday_start, weekday_end, extra_time, extra_weekday, MonthRange) ->\n            output = []\n            if time?\n                for date in MonthRange\n                    if date.weekday?\n                        if date.weekday in [weekday_start .. weekday_end]\n                            output.push(_replace(date, time))\n                            if and_time?\n                                output.push(_replace(date, and_time))\n                        if date.weekday == extra_weekday\n                            output.push(_replace(date, extra_time))\n            return output\n\n\n        weekday_range_with_extra_backwards = (extra_time, extra_weekday, time, weekday_start, weekday_end, MonthRange ) ->\n            return weekday_range_with_extra(time[0], time[1], weekday_start, weekday_end, extra_time, extra_weekday, MonthRange )\n\n\n        reverse_basic_text = (time, day, month, year) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        basic_text = (time, first_second, weekday, month, day, year) ->\n            if not day?\n                day = 1\n            if (day instanceof Array) and day.length == 1\n              day = day[0]\n            if (year instanceof Array) and year.length == 1\n              year = year[0]\n            if not time?\n                return {year: year, month: month, day: day}\n            else\n                year: year\n                month: month\n                day: day\n                hour: time.hour\n                minute: time.minute\n                second: time.second\n                am_pm: time.am_pm\n\n\n        slash = (month, day, year, time) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        month_range = (month, date_a, date_b) ->\n            output = []\n            for day in [date_a .. date_b]\n                output.push(basic_text(undefined, undefined, undefined, month, day, undefined))\n            return output\n\n\n        multi_time = (time1, BasicText) ->\n            output = []\n            if time1? and BasicText?\n                output.push(_replace(BasicText, time1))\n                output.push(BasicText)\n                return output\n\n\n        large_repeat_words = ->\n            return undefined\n\n\n        weekday_range_with_time_range = (time1, weekday_range) ->\n            output = []\n            if time1? and weekday_range?\n                range = timedelta_from_Date(_replace(weekday_range[0], time1), weekday_range[0])\n                for weekday in weekday_range\n                    output.push(_replace(weekday, {hour:time1.hour, minute:time1.minute, am_pm:time1.am_pm}))\n                    output.push(range)\n                return output\n\n\n        time_range = (unstrict_time, strict_time, date, reverse) ->\n            endtime = date\n            starttime = endtime\n            if unstrict_time\n                starttime = _replace(starttime, {hour:Number(unstrict_time[0])})\n                if date.am_pm\n                    starttime = _replace(starttime, {hour: starttime.hour + date.am_pm, am_pm:date.am_pm})\n            else\n                starttime = _replace(starttime, {hour: strict_time.hour, minute: strict_time.minute})\n\n            time_range = timedelta_from_Date(starttime, endtime)\n            if reverse\n                time_range = timedelta_from_Date(endtime, starttime)\n            return [starttime, time_range]\n\n\n        alt_time_range = (first_second, weekday, month, day, year, time, unstrict_time, strict_time) ->\n            return time_range(unstrict_time, strict_time, basic_text(time, first_second, weekday, month, day, year), reverse)\n\n\n        until_range = (date1, date2) ->\n            if date1 and date2\n                return [date1, timedelta_from_Date(date1, date2)]\n\n\n        through_range = (time, weekday1, weekday2, month, date, beginning) ->\n            output = []\n            if month and date and beginning and weekday1\n                ending =\n                    month: month\n                    day: date\n                for day in [beginning.day .. ending.day]\n                    temp =\n                        month: month\n                        day: date\n                    if temp.weekday and in_array([weekday1 .. weekday2], temp.weekday)\n                        if time\n                            output.push(_replace(temp, time))\n                        else\n                            output.push(temp)\n                return output\n\n\n### The function list\n\nThis hash\/object matches all the functions with a\nstring that represents it in the parse tree.\n\n        functions =\n            # Groups\n            \"MonthString\": month_to_number,\n            \"AMPM\": am_pm,\n            # Expressions\n            \"Chase Year\": year,\n            \"Chase Date\": date_number,\n            \"Chase Month\": month_number,\n            \"Steve Valaitis\": time_expression,\n            \"Greg Burns\": (hour, am_pm) -> time_expression(hour, null, null, am_pm, null),\n            \"Greg Burns UnstrictTime:\": time_expression,\n            \"Steve Valaitis2\": military_time,\n            \"Steve Valaitis And Time\": time_and_time,\n            \"Text Parts\": time_expression,\n            \"Michael Ash10\": weekday_to_number,\n            # Types\n            \"Month\": month_type,\n            \"MonthNum\": month_num_type,\n            # Patterns\n            \"LargeRepeatWords\": large_repeat_words,\n            \"BasicText\": basic_text,\n            \"ReverseBasicText\": reverse_basic_text,\n            \"Slash\": slash,\n            \"MonthRange\": month_range,\n            \"MultiTime\": multi_time,\n            \"WeekdayRangeWithTime\": weekday_range_with_time,\n            \"WeekdayRangeWithExtra\": weekday_range_with_extra,\n            \"WeekdayRangeWithExtraBackwards\": weekday_range_with_extra_backwards,\n            \"WeekdayRangeWithTimeRange\": weekday_range_with_time_range,\n            \"UntilRange\": until_range,\n            \"ThroughRange\": through_range,\n            \"TimeRange\": time_range,\n            \"AltTimeRange\": alt_time_range,\n\nThis is default expression or pattern. ```any``` means\nif value is defined, and there is array with even a single defined value then return true.\n\n            \"_default\": (_) ->\n                if any(_) then _ else undefined\n\n```Type``` there is used to mean collection of expressions.\nI know that because only one will match, so you just have to find\nit and return it.\n\n            \"_default_type\": (_...) ->\n                if _?\n                    for item in _\n                         if item?\n                             return item\n\n            \"_default_group\": (_...) -> if _[0]? then _[0]\n","old_contents":"### This file\n\nThe logic in this file builds the date object.\n\nIf you compare this file to the ```python\/functions.py``` file\nyou'll notice they are very similiar. That's intentional,\nthis file was ported over and kept such that it would be somewhat\neasy to port changes back and forth.\n\n### Terminology\n\nBecause it's so confusing here is a list of the different levels to refer to:\n\n- Groups \n  -- This is the capture groups. The lowest level. ```([0-9])``` etc.\n  \"Day\", \"Month\", etc.\n- Expressions \n  -- This is an expression with multiple capture groups. They're usually named\n  after the person that wrote them. \"Greg Burns\", etc.\n  \n  In Python, Expressions functions have nice named arguments, def expr(Day, Month, Year),\n  but Javascript doesn't support this.\n- Type\n  -- This is a collection of expressions with a common goal.\n  Months (Jan, 0-12, January, etc.). \n- Patterns\n  -- This is a collection of types ```<Month>\/<Day>\/<Year>```\n\n### Warning\n\nA note about the above list. Types and Groups are commonly mixed up.\nI think groups SHOULD be the lowest \n(because they are the actual capture *groups* in regular expressions)\nbut a group of expressions also makes sense.\n\nIt's so confusing that there are at least a couple places here that I've\nalso mixed myself up and probably in the documentation for RE|PARSE as well.\n\n---\n\nI use named tuples in python, and ```_replace``` mirrors the functionality of \n```date._replace```.. that is that it returns a copy of the date with only\ncertain things changed and leaves the old well enough alone.\n\n        _replace = (_old, _new) ->\n            year:   if _new.year? then _new.year else _old.year\n            month:  if _new.month? then _new.month else _old.month\n            day:    if _new.day? then _new.day  else _old.day\n            hour:   if _new.hour? then _new.hour else _old.hour\n            minute: if _new.minute? then _new.minute else _old.minute\n            second: if _new.second? then _new.second else _old.second\n            am_pm:  if _new.am_pm? then _new.am_pm else _old.am_pm\n\nI represent lengths of dates (i.e. Thursday, 1-2pm) with a timedelta that goes right\nafter the date hash in the result array.\n\nIn Javascript, I'm just going to represent a timedelta with a hash.\nI make a pretty dumb assumption that timedelta will only cross hour\/minutes\/second boundaries.\n\n        timedelta_from_Date = (start_time, end_time) ->\n            seconds_difference = 0\n            if start_time.hour? and end_time.hour?\n              seconds_difference += 60*60*(end_time.hour - start_time.hour)\n\n              if start_time.minute? and end_time.minute?\n                seconds_difference += 60*(end_time.minute - start_time.minute)\n\n                if start_time.second? and end_time.second?\n                  seconds_difference += end_time.second - start_time.second\n\n            hours = Math.floor(seconds_difference\/60\/60)\n            minutes = Math.floor(seconds_difference\/60) - (hours * 60)\n            seconds = seconds_difference - (minutes * 60) - (hours * 60 * 60)\n\n            return {\n               timedelta: true\n               hours: hours\n               minutes: minutes\n               seconds: seconds\n            }\n\n\nThis is just a helper function\n\n        in_array = (arr, _) -> arr.indexOf(_) != -1\n\n```progressive_match``` is useful for matching abbreviations\nand full spellings. Functions like this could be useful\nto help parse fuzzy matches in the future (i.e. misspellings of months).\n\n        progressive_match = (string, possibilities) ->\n            part = \"\"\n            if not string? then return\n            for character in string.toLowerCase()\n                part += character\n                matches = []\n                for month, value of possibilities\n                    if month.indexOf(part) > -1\n                        matches.push(month)\n                if matches.length == 1\n                    return possibilities[matches[0]]\n### Types\n\n\n        month_to_number = (month_string) ->\n          months =\n              \"january\": 1\n              \"february\": 2\n              \"march\": 3\n              \"april\": 4\n              \"may\": 5\n              \"june\": 6\n              \"july\": 7\n              \"august\": 8\n              \"september\": 9\n              \"october\": 10\n              \"november\": 11\n              \"december\": 12\n           return progressive_match(month_string, months)\n\n        weekday_to_number = (WeekdayString ) ->\n            weekday_list = {\n                \"monday\": 0,\n                \"tuesday\": 1,\n                \"wednesday\": 2,\n                \"thursday\": 3,\n                \"friday\": 4,\n                \"saturday\": 5,\n                \"sunday\": 6,\n            }\n            return progressive_match(WeekdayString, weekday_list)\n\nI serialize am_pm by converting the hours to milliary\/24-hour time format.\nI also include ```am_pm: 'pm'``` in the date format to show that that transformation\nwas done. Making that clear helpful because if you get a time like 1, with no ```am_pm```\ndesignation you might want to assume pm and add 12. This is not done in the libary because\ndate_machine strives for honesty, not guesswork.\n\n        am_pm = (input) ->\n            if not input?\n              return\n            if input.toLowerCase() == \"am\" then 0\n            else if input.toLowerCase() == \"pm\" then 12\n\nYou can see in this function that I try not to repeat logic and use other\nfunctions. In this case I might have been able to simply put time_expression\nin the functions hash\/object, but in python it makes a difference due to named arguments.\nI'm going to leave it as-is for clarity.\n\n        military_time = (MilHour, MilMinute, MilSecond ) ->\n            return time_expression(MilHour, MilMinute, MilSecond, undefined)\n\nHere is the ampm conversion. I omit returns when the expressions are simple,\nbut later on I want to use them as much as possible to make my intentions clear.\n\n        noon = (hour, AMPM) -> hour == 12 and AMPM == 12\n        midnight = (hour, AMPM) -> hour == 12 and AMPM == 0\n\n        time_expression = (Hour, Minute, Second, AMPM, SpecialTimeText ) ->\n            if not Hour? and not Minute? and not Second? and not AMPM? and not SpecialTimeText?\n                return\n            if SpecialTimeText\n                if SpecialTimeText.toLowerCase() == \"noon\"\n                    return {hour: 12}\n                if SpecialTimeText.toLowerCase() == \"midnight\"\n                    return {hour: 0}\n            d = {}\n            if Hour\n                d.hour = Number(Hour)\n            if Minute\n                d.minute = Number(Minute)\n            if Second\n                d.second = Number(Second)\n            if AMPM?\n                if d.hour\n                    if noon(d.hour, AMPM)\n                        d.hour = 12\n                    else if midnight(d.hour, AMPM)\n                        d.hour = 0\n                    else\n                        d.hour = d.hour + AMPM\n                d.am_pm = AMPM\n            if [d.hour, d.minute, d.second] == [undefined, undefined, undefined]\n                return undefined\n            return d\n\n\n        time_and_time = (Hour, Minute, AMPM1, Hour2, Minute2, AMPM2) ->\n            if AMPM2?\n                AMPM2 = am_pm(AMPM2)\n            if not AMPM1? and not AMPM2?\n                return [time_expression(Hour, Minute), time_expression(Hour2, Minute2)]\n            else if not AMPM1?\n                return [time_expression(Hour, Minute, undefined, AMPM2),\n                        time_expression(Hour2, Minute2, undefined, AMPM2)]\n            else if not AMPM2?\n                return [time_expression(Hour, Minute, undefined, AMPM1),\n                        time_expression(Hour2, Minute2, undefined, AMPM1)]\n\n\n        month_type = (input...) ->\n            for value in input\n                if value?\n                    return Number(value)\n\n\n        date_number = (Day, Abbr) -> if Day? then Number(Day)\n\n        month_number = (MonthNum) -> Number(MonthNum)\n\n        month_num_type = (input) -> Number(input)\n\n        year = (Year) -> if Year? then Number(Year)\n\nSometimes the value is [undefined, undefined, <value>],\nso I need to search for it and find it.\n\n        get_first_defined = (_) ->\n          for item in _\n            if item?\n              return item\n\n### Patterns\n\nThere's a some unwrapping values out of arrays here.\nBecause of the namedarguments issue functions receive a lot more\narrays then in Python and so they need to be unwrapped.\n\n        weekday_range_with_time = (time1, time2, [weekday1], [weekday2], MonthRange) ->\n            output = []\n\n            # Get first undefined value\n            # Since only one value in list will be defined (if any)\n            time1 = get_first_defined(time1)\n            time2 = get_first_defined(time2)\n\n            if time1?\n                for date in MonthRange\n                    output.push(_replace(date, time1))\n                    if time2?\n                        output.push(_replace(date, time2))\n            return output\n\n\n        weekday_range_with_extra = ( time, and_time, weekday_start, weekday_end, extra_time, extra_weekday, MonthRange) ->\n            output = []\n            if time?\n                for date in MonthRange\n                    if date.weekday?\n                        if date.weekday in [weekday_start .. weekday_end]\n                            output.push(_replace(date, time))\n                            if and_time?\n                                output.push(_replace(date, and_time))\n                        if date.weekday == extra_weekday\n                            output.push(_replace(date, extra_time))\n            return output\n\n\n        weekday_range_with_extra_backwards = (extra_time, extra_weekday, time, weekday_start, weekday_end, MonthRange ) ->\n            return weekday_range_with_extra(time[0], time[1], weekday_start, weekday_end, extra_time, extra_weekday, MonthRange )\n\n\n        reverse_basic_text = (time, day, month, year) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        basic_text = (time, first_second, weekday, month, day, year) ->\n            if not day?\n                day = 1\n            if (day instanceof Array) and day.length == 1\n              day = day[0]\n            if (year instanceof Array) and year.length == 1\n              year = year[0]\n            if not time?\n                return {year: year, month: month, day: day}\n            else\n                year: year\n                month: month\n                day: day\n                hour: time.hour\n                minute: time.minute\n                second: time.second\n                am_pm: time.am_pm\n\n\n        slash = (month, day, year, time) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        month_range = (month, date_a, date_b) ->\n            output = []\n            for day in [date_a .. date_b]\n                output.push(basic_text(undefined, undefined, undefined, month, day, undefined))\n            return output\n\n\n        multi_time = (time1, BasicText) ->\n            output = []\n            if time1? and BasicText?\n                output.push(_replace(BasicText, time1))\n                output.push(BasicText)\n                return output\n\n\n        large_repeat_words = ->\n            return undefined\n\n\n        weekday_range_with_time_range = (time1, weekday_range) ->\n            output = []\n            if time1? and weekday_range?\n                range = timedelta_from_Date(_replace(weekday_range[0], time1), weekday_range[0])\n                for weekday in weekday_range\n                    output.push(_replace(weekday, {hour:time1.hour, minute:time1.minute, am_pm:time1.am_pm}))\n                    output.push(range)\n                return output\n\n\n        time_range = (unstrict_time, strict_time, date, reverse) ->\n            endtime = date\n            starttime = endtime\n            if unstrict_time\n                starttime = _replace(starttime, {hour:Number(unstrict_time[0])})\n                if date.am_pm\n                    starttime = _replace(starttime, {hour: starttime.hour + date.am_pm, am_pm:date.am_pm})\n            else\n                starttime = _replace(starttime, {hour: strict_time.hour, minute: strict_time.minute})\n\n            time_range = timedelta_from_Date(starttime, endtime)\n            if reverse\n                time_range = timedelta_from_Date(endtime, starttime)\n            return [starttime, time_range]\n\n\n        alt_time_range = (first_second, weekday, month, day, year, time, unstrict_time, strict_time) ->\n            return time_range(unstrict_time, strict_time, basic_text(time, first_second, weekday, month, day, year), reverse)\n\n\n        until_range = (date1, date2) ->\n            if date1 and date2\n                return [date1, timedelta_from_Date(date1, date2)]\n\n\n        through_range = (time, weekday1, weekday2, month, date, beginning) ->\n            output = []\n            if month and date and beginning and weekday1\n                ending =\n                    month: month\n                    day: date\n                for day in [beginning.day .. ending.day]\n                    temp =\n                        month: month\n                        day: date\n                    if temp.weekday and in_array([weekday1 .. weekday2], temp.weekday)\n                        if time\n                            output.push(_replace(temp, time))\n                        else\n                            output.push(temp)\n                return output\n\n\n### The function list\n\nThis hash\/object matches all the functions with a\nstring that represents it in the parse tree.\n\n        functions =\n            # Groups\n            \"MonthString\": month_to_number,\n            \"AMPM\": am_pm,\n            # Expressions\n            \"Chase Year\": year,\n            \"Chase Date\": date_number,\n            \"Chase Month\": month_number,\n            \"Steve Valaitis\": time_expression,\n            \"Greg Burns\": (hour, am_pm) -> time_expression(hour, null, null, am_pm, null),\n            \"Greg Burns UnstrictTime:\": time_expression,\n            \"Steve Valaitis2\": military_time,\n            \"Steve Valaitis And Time\": time_and_time,\n            \"Text Parts\": time_expression,\n            \"Michael Ash10\": weekday_to_number,\n            # Types\n            \"Month\": month_type,\n            \"MonthNum\": month_num_type,\n            # Patterns\n            \"LargeRepeatWords\": large_repeat_words,\n            \"BasicText\": basic_text,\n            \"ReverseBasicText\": reverse_basic_text,\n            \"Slash\": slash,\n            \"MonthRange\": month_range,\n            \"MultiTime\": multi_time,\n            \"WeekdayRangeWithTime\": weekday_range_with_time,\n            \"WeekdayRangeWithExtra\": weekday_range_with_extra,\n            \"WeekdayRangeWithExtraBackwards\": weekday_range_with_extra_backwards,\n            \"WeekdayRangeWithTimeRange\": weekday_range_with_time_range,\n            \"UntilRange\": until_range,\n            \"ThroughRange\": through_range,\n            \"TimeRange\": time_range,\n            \"AltTimeRange\": alt_time_range,\n\nThis is default expression or pattern. ```any``` means\nif value is defined, and there is array with even a single defined value then return true.\n\n            \"_default\": (_) ->\n                if any(_) then _ else undefined\n\n```Type``` there is used to mean collection of expressions.\nI know that because only one will match, so you just have to find\nit and return it.\n\n            \"_default_type\": (_...) ->\n                if _?\n                    for item in _\n                         if item?\n                             return item\n\n            \"_default_group\": (_...) -> if _[0]? then _[0]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"677808126c536c7573c9e5e1ea5a7b5a55dc80c0","subject":"simplify global plugin management","message":"simplify global plugin management\n","repos":"tmad4000\/celestrium","old_file":"core-coffee\/celestrium.litcoffee","new_file":"core-coffee\/celestrium.litcoffee","new_contents":"## API\n\nthis is used to populate the listed singleton plugins with their single instance\n\nother plugins may access this instance through requiring the module.\n\n### Example\n\n```coffeescript\nrequire [\"pluginPath\"], (plugin) -> plugin.getInstance().foo()`\n```\n\n### Example Usage\n\nNow in your `main` coffeescript file, you can do something like this.\n\n```coffeescript\nrequirejs [\"celestrium\"], (Celestrium) ->\n  Celestrium.init\n    \"core\/workspace\":\n      \"el\": document.querySelector \"#workspace\"\n```\n\nonly plugins which instantiate the `singleton` class should be used with `init`\n\n## Code\n\nLoad the global libraries contained within celestrium here.\nThis offloads this responsibility from the user.\n\n    globalLibs = [\n      'lib\/jquery',\n      'lib\/jquery.typeahead',\n      'lib\/underscore',\n      'lib\/backbone',\n      'lib\/d3',\n    ]\n\nThe actual module returns only an object with an init method.\n\nLoad the above libraries so they are now available globally.\n\nThis is probably bad practice and less modular, but is practical.\n\n    define globalLibs, () -> init: (singletonPlugins, callback) ->\n\nNow actually require the different plugins.\nNote that, they should all be required at once and the callback called within the require callback so as to ensure the callback is only call onced these plugin instances have been initialized.\n\n        pluginPaths = _.keys(singletonPlugins)\n        require pluginPaths, (plugins...) ->\n          i = 0\n          for plugin in plugins\n            args = singletonPlugins[pluginPaths[i]]\n            plugin.init args\n            i += 1\n          callback()\n","old_contents":"## API\n\nthis is used to populate the listed singleton plugins with their single instance\n\nother plugins may access this instance through requiring the module.\n\n### Example\n\n```coffeescript\nrequire [\"pluginPath\"], (plugin) -> plugin.getInstance().foo()`\n```\n\n### Example Usage\n\nNow in your `main` coffeescript file, you can do something like this.\n\n```coffeescript\nrequirejs [\"celestrium\"], (Celestrium) ->\n  Celestrium.init\n    \"core\/workspace\":\n      \"el\": document.querySelector \"#workspace\"\n```\n\nonly plugins which instantiate the `singleton` class should be used with `init`\n\n## Code\n\nLoad the global libraries contained within celestrium here.\nThis offloads this responsibility from the user.\n\n    globalLibs = [\n      'lib\/jquery',\n      'lib\/jquery.typeahead',\n      'lib\/underscore',\n      'lib\/backbone',\n      'lib\/d3',\n    ]\n\nThe actual module returns only an object with an init method.\n\n    define [], () -> init: (singletonPlugins, callback) ->\n\nInclude this nested require call so as to load the above libraries.\nNow, these libraries are available globally per the norm.\n\nThis is probably bad practice and less modular, but is practical.\n\n      require globalLibs, () ->\n\nNow actually require the different plugins.\nNote that, they should all be required at once and the callback called within the require callback so as to ensure the callback is only call onced these plugin instances have been initialized.\n\n        pluginPaths = _.keys(singletonPlugins)\n        require pluginPaths, (plugins...) ->\n          i = 0\n          for plugin in plugins\n            args = singletonPlugins[pluginPaths[i]]\n            plugin.init args\n            i += 1\n          callback()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a7db5db3db7b5d63ce13d9427e0cf06b278d050f","subject":"User login form uses new API","message":"User login form uses new API\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-user\/client\/login.litcoffee","new_file":"packages\/shrub-user\/client\/login.litcoffee","new_contents":"# User login\n\n    config = require 'config'\n\n    {TransmittableError} = require 'errors'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubTransmittableErrors`.\n\n      registrar.registerHook 'shrubTransmittableErrors', exports.shrubTransmittableErrors\n\n#### Implements hook `shrubAngularRoutes`.\n\n      registrar.registerHook 'shrubAngularRoutes', ->\n\n        routes = []\n\n        if 'e2e' is config.get 'packageConfig:shrub-core:testMode'\n\n          routes.push\n\n            path: 'e2e\/user\/login\/:destination'\n\n            controller: [\n              '$location', '$routeParams', 'shrub-rpc', 'shrub-socket', 'shrub-user'\n              ($location, {destination}, rpc, socket, user) ->\n\n                user.fakeLogin('cha0s').then ->\n                  $location.path \"\/user\/#{destination}\"\n\n            ]\n\n        routes.push\n\n          path: 'user\/login'\n          title: 'Sign in'\n\n          controller: [\n            '$location', '$scope', 'shrub-ui\/messages', 'shrub-user'\n            ($location, $scope, messages, user) ->\n              return $location.path '\/' if user.isLoggedIn()\n\n              $scope.form =\n\n                key: 'shrub-user-login'\n\n###### TODO: Use rpc submission with a hidden 'method' field.\n\n                submits: [\n\n                  (values) ->\n\n                    user.login(\n                      'local'\n                      values.username\n                      values.password\n                    ).then ->\n\n                      messages.add(\n                        class: 'alert-success'\n                        text: 'Logged in successfully.'\n                      )\n\n                      $location.path '\/'\n\n                ]\n\n                fields:\n\n                  username:\n                    type: 'text'\n                    label: 'Username'\n                    required: true\n\n                  password:\n                    type: 'password'\n                    label: 'Password'\n                    required: true\n\n                  submit:\n                    type: 'submit'\n                    value: 'Sign in'\n\n                  forgot:\n                    type: 'markup'\n                    value: '<a class=\"forgot\" href=\"\/user\/forgot\">Forgot your password?<\/a>'\n\n          ]\n\n          template: '''\n\n    <div\n      data-shrub-form\n      data-form=\"form\"\n    ><\/div>\n\n    '''\n\n        return routes\n\nTransmittable login error.\n\n    class LoginError extends TransmittableError\n\n      key: 'login'\n      template: 'No such username\/password.'\n\n    exports.shrubTransmittableErrors = -> [\n      LoginError\n    ]\n","old_contents":"# User login\n\n    config = require 'config'\n\n    {TransmittableError} = require 'errors'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubTransmittableErrors`.\n\n      registrar.registerHook 'shrubTransmittableErrors', exports.shrubTransmittableErrors\n\n#### Implements hook `shrubAngularRoutes`.\n\n      registrar.registerHook 'shrubAngularRoutes', ->\n\n        routes = []\n\n        if 'e2e' is config.get 'packageConfig:shrub-core:testMode'\n\n          routes.push\n\n            path: 'e2e\/user\/login\/:destination'\n\n            controller: [\n              '$location', '$routeParams', 'shrub-rpc', 'shrub-socket', 'shrub-user'\n              ($location, {destination}, rpc, socket, user) ->\n\n                user.fakeLogin('cha0s').then ->\n                  $location.path \"\/user\/#{destination}\"\n\n            ]\n\n        routes.push\n\n          path: 'user\/login'\n          title: 'Sign in'\n\n          controller: [\n            '$location', '$scope', 'shrub-ui\/messages', 'shrub-user'\n            ($location, $scope, messages, user) ->\n              return $location.path '\/' if user.isLoggedIn()\n\n              $scope.form =\n\n                key: 'shrub-user-login'\n\n###### TODO: Use rpc submission with a hidden 'method' field.\n\n                submits: [\n\n                  (values) ->\n\n                    user.login(\n                      'local'\n                      values.username\n                      values.password\n                    ).then ->\n\n                      messages.add(\n                        class: 'alert-success'\n                        text: 'Logged in successfully.'\n                      )\n\n                      $location.path '\/'\n\n                ]\n\n                fields:\n\n                  username:\n                    type: 'text'\n                    label: 'Username'\n                    required: true\n\n                  password:\n                    type: 'password'\n                    label: 'Password'\n                    required: true\n\n                  submit:\n                    type: 'submit'\n                    value: 'Sign in'\n\n          ]\n\n          template: '''\n\n    <div\n      data-shrub-form\n      data-form=\"form\"\n    ><\/div>\n\n    <a class=\"forgot\" href=\"\/user\/forgot\">Forgot your password?<\/a>\n\n    '''\n\n        return routes\n\nTransmittable login error.\n\n    class LoginError extends TransmittableError\n\n      key: 'login'\n      template: 'No such username\/password.'\n\n    exports.shrubTransmittableErrors = -> [\n      LoginError\n    ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6de01e255cc62a2ba985ab3ee7e46d2c7395a765","subject":"Add unix timestamp support to ?after","message":"Add unix timestamp support to ?after\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    ObjectID    = require('mongodb').ObjectID\n    stringify   = require('JSONStream').stringify\n    createHash  = require('crypto').createHash\n\n    Document    = require '.\/model\/Document'\n\n    mongo       = require '.\/db\/mongo'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col]\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n      query = {}\n\n### ?tag=`String`\n\n      if typeof req.query.tag is 'string' and req.query.tag isnt ''\n        if req.query.tag.charAt(0) is '!' and req.query.tag.length > 1\n          query['tags.0'] = $ne: req.query.tag.substr(1)\n        else\n          query['tags.0'] = req.query.tag\n\n### ?grupper=`String`\n\n      if typeof req.query.gruppe is 'string' and req.query.gruppe isnt ''\n        query['grupper'] = req.query.gruppe\n\n### ?after=`Mixed`\n\n      if typeof req.query.after is 'string' and req.query.after isnt ''\n        time = req.query.after\n\n        if not isNaN time\n          # Make unix timestamp into milliseconds\n          time = time + '000' if (time + '').length is 10\n          time = parseInt time\n\n        time = new Date time\n\n        if time.toString() isnt 'Invalid Date'\n          query.endret = $gte: time.toISOString()\n\n### ?bbox=`min_lng`,`min_lat`,`max_lng`,`max_lat`\n\n      if typeof req.query.bbox is 'string' and req.query.bbox.split(',').length is 4\n        bbox = req.query.bbox.split(',')\n        bbox[i] = parseFloat(val) for val, i in bbox\n\n        query.geojson =\n          '$geoWithin':\n            '$geometry':\n              type: 'Polygon'\n              coordinates: [[\n                [bbox[0], bbox[1]]\n                [bbox[2], bbox[1]]\n                [bbox[2], bbox[3]]\n                [bbox[0], bbox[3]]\n                [bbox[0], bbox[1]]\n              ]]\n\n### ?privat.`String`=`String`\n\nThis allows the user to filter documents based on private document properties.\nThis will autumaticly limit returned documents to those owned by the current\nuser.\n\n#### ToDo\n\n * Limit number of private fields?\n * Limit depth of private fields?\n\n`NB` This section is looping through all of the url query parameters and hence\nshould take the queries from above sections into concideration so we don't need\nto do double amount of work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    ObjectID    = require('mongodb').ObjectID\n    stringify   = require('JSONStream').stringify\n    createHash  = require('crypto').createHash\n\n    Document    = require '.\/model\/Document'\n\n    mongo       = require '.\/db\/mongo'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col]\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n      query = {}\n\n### ?tag=`String`\n\n      if typeof req.query.tag is 'string' and req.query.tag isnt ''\n        if req.query.tag.charAt(0) is '!' and req.query.tag.length > 1\n          query['tags.0'] = $ne: req.query.tag.substr(1)\n        else\n          query['tags.0'] = req.query.tag\n\n### ?grupper=`String`\n\n      if typeof req.query.gruppe is 'string' and req.query.gruppe isnt ''\n        query['grupper'] = req.query.gruppe\n\n### ?after=`Mixed`\n\n      if typeof req.query.after is 'string' and req.query.after isnt ''\n        if not isNaN(req.query.after)\n          req.query.after = new Date(parseInt(req.query.after, 10)).toISOString()\n        query.endret = {$gte:req.query.after}\n\n### ?bbox=`min_lng`,`min_lat`,`max_lng`,`max_lat`\n\n      if typeof req.query.bbox is 'string' and req.query.bbox.split(',').length is 4\n        bbox = req.query.bbox.split(',')\n        bbox[i] = parseFloat(val) for val, i in bbox\n\n        query.geojson =\n          '$geoWithin':\n            '$geometry':\n              type: 'Polygon'\n              coordinates: [[\n                [bbox[0], bbox[1]]\n                [bbox[2], bbox[1]]\n                [bbox[2], bbox[3]]\n                [bbox[0], bbox[3]]\n                [bbox[0], bbox[1]]\n              ]]\n\n### ?privat.`String`=`String`\n\nThis allows the user to filter documents based on private document properties.\nThis will autumaticly limit returned documents to those owned by the current\nuser.\n\n#### ToDo\n\n * Limit number of private fields?\n * Limit depth of private fields?\n\n`NB` This section is looping through all of the url query parameters and hence\nshould take the queries from above sections into concideration so we don't need\nto do double amount of work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3c97b57b213cef4040f86cd63a1a9225bc2bc097","subject":"Rework how arguments are processed when wrapping methods","message":"Rework how arguments are processed when wrapping methods\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                val\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = Madul.PARSE_SPEC val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE.call proto[ref], args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = Madul.PARSE_SPEC val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE.call proto[ref], args[key]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                if Array.isArray me.before\n                  before = me.before.map (b) => Madul.PARSE_SPEC(b).ref\n                else if typeof me.before == 'string'\n                  before = [ Madul.PARSE_SPEC(me.before).ref ]\n                else\n                  before = [ ]\n\n                if Array.isArray me.after\n                  after = me.after.map (a) => Madul.PARSE_SPEC(a).ref\n                else if typeof me.after == 'string'\n                  after = [ Madul.PARSE_SPEC(me.after).ref ]\n                else\n                  after = [ ]\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0392fb19769267720023ad1eea91ce1a25f31c28","subject":"document the rest of the filters","message":"document the rest of the filters\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14a_filters.litcoffee","new_file":"docs\/14a_filters.litcoffee","new_contents":"# \/api\/App Components\/Batman.View\/Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\nBatman.js ships with many built-in view filters:\n\nType | Filters\n---|----\n__Logical Operators__ |  `and`, `or`, `not`\n__Comparison Operators__ | `equals`, `eq`, `neq`, `lt`, `gt`, `lteq`, `gteq`\n__General Utilities__ | `get`, `[]`, `meta`, `withArguments`, `default`\n__Number Helpers__ | `ceil`, `floor`, `round`, `precision`, `fixed`, `delimitNumber`\n__Set Helpers__ |  `join`, `sort`, `map`, `has`, `first`\n__String Helpers__ | `interpolate`, `escape`, `capitalize`, `titleize`, `singularize`, `underscore`, `camelize`, `trim`, `raw`, `matches`, `truncate`, `prepend`, `append`, `replace`, `downcase`, `upcase`, `pluralize`, `humanize`\n__Debuggers__ | `log`, `logStack`\n\n\n## Custom Filters\n\nYou can define custom filters by setting them on the `Batman.Filters` object. For example, a batman.js view filter that formats a date with [moment.js](http:\/\/momentjs.com):\n\n```coffeescript\n# `moment` is the moment.js object\nBatman.Filters.dateFormat = (date, format) ->\n  moment(date).format(format)\n```\n\nYou can also define custom filters when defining custom views with [`Batman.View.filter`](docs\/api\/batman.view.html#class_function_filter).\n\n## equals(left, right) or eq(left, right): Boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n<span data-showif=\"value | eq 10\"><\/span>\n<span data-showif=\"value | eq true\"><\/span>\n```\n\n__Note__: there is actually _one_ difference between `eq` and `equals`: `equals` rejects undefined values, but `eq` allows them.\n\n## lt(left, right) : Boolean\n\nChecks if left content is `less than` the right content.\n\n```html\n<span data-showif=\"posts.length | lt 10\"><\/span>\n```\n\n## gt(left, right) : Boolean\n\nChecks if left content is `greater than` the right content.\n\n```html\n<span data-showif=\"posts.length | gt 10\"><\/span>\n```\n\n## lteq(left, right) : Boolean\n\nChecks if left content is `less than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | lteq 10\"><\/span>\n```\n\n## gteq(left, right) : Boolean\n\nChecks if left content is `greater than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | gteq 10\"><\/span>\n```\n\n## neq(left, right) : Boolean\n\nChecks if left content is `is NOT equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | neq 10\"><\/span>\n```\n\n## ceil(value) : string\n\nThe `ceil` filter will run `Math.ceil` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | ceil\"><\/span>\n```\n\n## floor(value) : string\n\nThe `floor` filter will run `Math.floor` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | floor\"><\/span>\n```\n\n## round(value) : string\n\nThe `round` filter will run `Math.round` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | round\"><\/span>\n```\n\n## percision(value, toPlace) : string\n\nThe `precision` filter will run `toPrecision()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | precision\"><\/span>\n<span data-bind=\"someValue | precision 3\"><\/span>\n```\n\n## fixed(value, toPlace) : string\n\nThe `fixed` filter will run `toFixed()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | fixed\"><\/span>\n<span data-bind=\"someValue | fixed 3\"><\/span>\n```\n\n## delimitNumber(value) : string\n\nThe `delimitNumber` filter will comma delimit a 'number'. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | delimitNumber\"><\/span>\n```\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## and(inputValue, otherValue) : boolean\n\nReturns `true` if `inputValue` and `otherValue` are truthy:\n\n```html\n<p data-showif='post.published | and currentUser.loggedIn'><\/p>\n```\n\n## or(inputValue, otherValue) : boolean\n\nReturns `true` if either `inputValue` or `otherValue` are truthy:\n\n```html\n<p data-showif='post.published | or currentUser.isAdmin'><\/p>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count, includeCount[=true]) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## singularize(string) : string\n\nReturns the singular inflection of `string`.\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## titleize(value) : string\n\nHumanizes `string` and capitalizes each word. For example,\n\n```html\n<span data-bind=\"'about_us_page' | titleize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | titleize\">About Us Page<\/span>\n```\n\n## underscore(string) : string\n\nConverts `string` to underscore case.\n\n## camelize(string, firstLetterLower[=false]) : string\n\nConverts `string` to camel case. if `firstLetterLower` is true, the first letter will be lowercase.\n\n## join(array, separator = '') : string\n\nJoins `array` into a single string with `separator`:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## toSentence(array) : string\n\nJoins `array` with `, ` and ` and`, as appropriate. See [helpers.toSentence](\/docs\/api\/batman.helpers.html#class_function_tosentence).\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\nLooks up `keypath` on `value.meta`. The `value` must have a `meta` property to look up against.\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","old_contents":"# \/api\/App Components\/Batman.View\/Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\nBatman.js ships with many built-in view filters:\n\nType | Filters\n---|----\n__Logical Operators__ |  `and`, `or`, `not`\n__Comparison Operators__ | `equals`, `eq`, `neq`, `lt`, `gt`, `lteq`, `gteq`\n__General Utilities__ | `get`, `[]`, `meta`, `withArguments`, `default`\n__Number Helpers__ | `ceil`, `floor`, `round`, `precision`, `fixed`, `delimitNumber`\n__Set Helpers__ |  `join`, `sort`, `map`, `has`, `first`\n__String Helpers__ | `interpolate`, `escape`, `capitalize`, `singularize`, `underscore`, `camelize`, `trim`, `raw`, `matches`, `truncate`, `prepend`, `append`, `replace`, `downcase`, `upcase`, `pluralize`, `humanize`\n__Debuggers__ | `log`, `logStack`\n\n\n## Custom Filters\n\nYou can define custom filters by setting them on the `Batman.Filters` object. For example, a batman.js view filter that formats a date with [moment.js](http:\/\/momentjs.com):\n\n```coffeescript\n# `moment` is the moment.js object\nBatman.Filters.dateFormat = (date, format) ->\n  moment(date).format(format)\n```\n\nYou can also define custom filters when defining custom views with [`Batman.View.filter`](docs\/api\/batman.view.html#class_function_filter).\n\n## equals(left, right) or eq(left, right): Boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n<span data-showif=\"value | eq 10\"><\/span>\n<span data-showif=\"value | eq true\"><\/span>\n```\n\n__Note__: there is actually _one_ difference between `eq` and `equals`: `equals` rejects undefined values, but `eq` allows them.\n\n## lt(left, right) : Boolean\n\nChecks if left content is `less than` the right content.\n\n```html\n<span data-showif=\"posts.length | lt 10\"><\/span>\n```\n\n## gt(left, right) : Boolean\n\nChecks if left content is `greater than` the right content.\n\n```html\n<span data-showif=\"posts.length | gt 10\"><\/span>\n```\n\n## lteq(left, right) : Boolean\n\nChecks if left content is `less than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | lteq 10\"><\/span>\n```\n\n## gteq(left, right) : Boolean\n\nChecks if left content is `greater than or equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | gteq 10\"><\/span>\n```\n\n## neq(left, right) : Boolean\n\nChecks if left content is `is NOT equal to` the right content.\n\n```html\n<span data-showif=\"posts.length | neq 10\"><\/span>\n```\n\n## ceil(value) : string\n\nThe `ceil` filter will run `Math.ceil` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | ceil\"><\/span>\n```\n\n## floor(value) : string\n\nThe `floor` filter will run `Math.floor` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | floor\"><\/span>\n```\n\n## round(value) : string\n\nThe `round` filter will run `Math.round` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | round\"><\/span>\n```\n\n## percision(value, toPlace) : string\n\nThe `precision` filter will run `toPrecision()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | precision\"><\/span>\n<span data-bind=\"someValue | precision 3\"><\/span>\n```\n\n## fixed(value, toPlace) : string\n\nThe `fixed` filter will run `toFixed()` on the input value. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | fixed\"><\/span>\n<span data-bind=\"someValue | fixed 3\"><\/span>\n```\n\n## delimitNumber(value) : string\n\nThe `delimitNumber` filter will comma delimit a 'number'. Value can be either a `string` or `integer`\n\n```html\n<span data-bind=\"someValue | delimitNumber\"><\/span>\n```\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## titleize(value) : string\n\nHumanizes `string` and capitalizes each word. For example,\n\n```html\n<span data-bind=\"'about_us_page' | titleize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | titleize\">About Us Page<\/span>\n```\n\n## underscore(string) : string\n\nConverts `string` to underscore case.\n\n## camelize(string, firstLetterLower[=false]) : string\n\nConverts `string` to camel case. if `firstLetterLower` is true, the first letter will be lowercase.\n\n## join(array, separator = '') : string\n\nJoins `array` into a single string with `separator`:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## toSentence(array) : string\n\nJoins `array` with `, ` and ` and`, as appropriate. See [helpers.toSentence](\/docs\/api\/batman.helpers.html#class_function_tosentence).\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\nLooks up `keypath` on `value.meta`. The `value` must have a `meta` property to look up against.\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"21d48ba462b5734a626e50f639be9a1c36d63909","subject":"format total minutes spent waiting","message":"format total minutes spent waiting\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"client\/views\/globalHelpers.litcoffee","new_file":"client\/views\/globalHelpers.litcoffee","new_contents":"    Template.registerHelper 'totalWaitTimeMinutes', ->\n      minutes = (QueueMeta.findOne()?.totalWaitTimeSeconds \/ 60).toFixed 0\n      minutesFormatted = minutes.toString().replace \/\\B(?=(\\d{3})+(?!\\d))\/g, ','\n      \"#{minutesFormatted} minutes\"\n\n    Template.registerHelper 'totalWaitTimeYears', ->\n      secondsInYear = 31556900\n      years = (QueueMeta.findOne()?.totalWaitTimeSeconds \/ secondsInYear ).toFixed 2\n      \"#{years} years\"\n\n    Template.registerHelper 'nameAllowedIn', ->\n      QueueMeta.findOne()?.theOnlyConnectionAllowedIn?.name\n\n    Template.registerHelper 'isBeingServed', ->\n      queueEntry = Queue.findOne()\n      queueMeta = QueueMeta.findOne()\n\nUpdate timeCurrentTicketExpires hackily here...\n\n      timeCurrentTicketExpires = Session.get 'timeCurrentTicketExpires'\n      if timeCurrentTicketExpires isnt queueMeta?.timeCurrentTicketExpires\n        Session.set 'timeCurrentTicketExpires', queueMeta?.timeCurrentTicketExpires\n\nNot being served in either queueEntry or queueMeta are non-existant\n\n      return no if not (queueEntry? and queueMeta?)\n      now = moment().utc().toDate()\n      isBeingServed = queueEntry._id is queueMeta?.currentlyServingQueueId and\n        queueMeta.timeCurrentTicketExpires > now\n      if isBeingServed\n        cachedIsBeingServed = Session.get 'isBeingServed'\n        Session.set 'isBeingServed', yes if cachedIsBeingServed is undefined or no\n      return isBeingServed\n","old_contents":"    Template.registerHelper 'totalWaitTimeMinutes', ->\n      minutes = (QueueMeta.findOne()?.totalWaitTimeSeconds \/ 60).toFixed 0\n      \"#{minutes} minutes\"\n\n    Template.registerHelper 'totalWaitTimeYears', ->\n      secondsInYear = 31556900\n      years = (QueueMeta.findOne()?.totalWaitTimeSeconds \/ secondsInYear ).toFixed 2\n      \"#{years} years\"\n\n    Template.registerHelper 'nameAllowedIn', ->\n      QueueMeta.findOne()?.theOnlyConnectionAllowedIn?.name\n\n    Template.registerHelper 'isBeingServed', ->\n      queueEntry = Queue.findOne()\n      queueMeta = QueueMeta.findOne()\n\nUpdate timeCurrentTicketExpires hackily here...\n\n      timeCurrentTicketExpires = Session.get 'timeCurrentTicketExpires'\n      if timeCurrentTicketExpires isnt queueMeta?.timeCurrentTicketExpires\n        Session.set 'timeCurrentTicketExpires', queueMeta?.timeCurrentTicketExpires\n\nNot being served in either queueEntry or queueMeta are non-existant\n\n      return no if not (queueEntry? and queueMeta?)\n      now = moment().utc().toDate()\n      isBeingServed = queueEntry._id is queueMeta?.currentlyServingQueueId and\n        queueMeta.timeCurrentTicketExpires > now\n      if isBeingServed\n        cachedIsBeingServed = Session.get 'isBeingServed'\n        Session.set 'isBeingServed', yes if cachedIsBeingServed is undefined or no\n      return isBeingServed\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d7e0ceb8af8d1e708526f63dfe681ccfbab47307","subject":"Document upload route handler","message":"Document upload route handler\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/routes\/api_v1.litcoffee","new_file":"src\/routes\/api_v1.litcoffee","new_contents":"    express = require 'express'\n    Upload  = require 's3-uploader'\n    multer  = require 'multer'\n    async   = require 'async'\n    dms2dec = require 'dms2dec'\n\n    sentry  = require '..\/sentry'\n    librato = require '..\/librato'\n\nMake a new Express router object for this part of the application.\n\n    api = express.Router()\n\n## Metrics\n\nAgregate metrics for all requests and wheter they succeded (`finish`) or closed\nbefore the request succeeded (`close`).\n\n    api.use (req, res, next) ->\n      librato.logRequest req.method\n\n      res.once 'close', ->\n        librato.logResponse 'closed'\n        sentry.captureResClose res\n\n      res.once 'finish', ->\n        librato.logResponse res.statusCode\n\n      next()\n\n## GET \/\n\n    api.get '\/', (req, res, next) ->\n      res.status(204).end()\n\n## POST \/upload\n\nConfigure [s3-uploader](https:\/\/github.com\/Turistforeningen\/node-s3-uploader) to\nstore three versions of the image `320px`, `780px`, and `1040px`. The original\nimage is also uploaded but not publicly avaiable.\n\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      aws:\n        region: process.env.AWS_BUCKET_REGION\n        path: process.env.AWS_BUCKET_PATH\n        acl: 'public-read'\n        httpOptions: timeout: 60000\n      returnExif: true\n\n      versions: [\n        original: true\n        awsImageAcl: 'private'\n      ,\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      ,\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      ,\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      ]\n\nConfigure [multer](https:\/\/github.com\/expressjs\/multer) to store files in the\nOS's temorary directory `tempdir()`. This way we should not need to clean up the\nuploaded files since that should be the job of the OS.\n\n    multer = require('multer')\n      putSingleFilesInArray: true\n      dest: require('os').tmpdir()\n\nConfigure the `\/upload` route handler.\n\n    api.post '\/upload', multer, (req, res, next) ->\n      librato.logImagesUploaded Object.keys req.files\n\n      files = []\n      for key, f of req.files\n        files.push file for file in f\n\n      async.mapSeries files, (file, cb) ->\n        if file.extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif']\n          error = new Error \"Invalid Image #{file.extension}\"\n          error.status = 422\n          return cb error\n\n        t1 = new Date().getTime()\n        s3.upload file.path, {}, (err, images, meta) ->\n          return cb err if err\n\n          librato.logImageProcessingTime t1, new Date().getTime()\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          if meta.imageSize.height > meta.imageSize.width\n            ratio = meta.imageSize.height \/ meta.imageSize.width\n            edge = 'width'\n          else\n            ratio = meta.imageSize.width \/ meta.imageSize.height\n            edge = 'height'\n\n          for image in images\n            image[edge] = Math.floor(image[edge] \/ ratio)\n\n            image.path = undefined\n            image.src = undefined\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    module.exports = api\n\n","old_contents":"    express = require 'express'\n    Upload  = require 's3-uploader'\n    multer  = require 'multer'\n    async   = require 'async'\n    dms2dec = require 'dms2dec'\n\n    sentry  = require '..\/sentry'\n    librato = require '..\/librato'\n\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketRegion: process.env.AWS_BUCKET_REGION\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [\n        original: true\n        awsImageAcl: 'private'\n      ,\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      ,\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      ,\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      ]\n\n    api = express.Router()\n\n    api.use (req, res, next) ->\n      librato.logRequest req.method\n\n      res.once 'close', ->\n        librato.logResponse 'closed'\n        sentry.captureResClose res\n\n      res.once 'finish', ->\n        librato.logResponse res.statusCode\n\n      next()\n\n    api.get '\/', (req, res, next) ->\n      res.status(204).end()\n\n    api.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      librato.logImagesUploaded Object.keys req.files\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        console.log req.files[key]\n\n        t1 = new Date().getTime()\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          librato.logImageProcessingTime t1, new Date().getTime()\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          if meta.imageSize.height > meta.imageSize.width\n            ratio = meta.imageSize.height \/ meta.imageSize.width\n            edge = 'width'\n          else\n            ratio = meta.imageSize.width \/ meta.imageSize.height\n            edge = 'height'\n\n          for image in images\n            image[edge] = Math.floor(image[edge] \/ ratio)\n\n            image.path = undefined\n            image.src = undefined\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    module.exports = api\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3f9cb49a1b97e6d3f09d2d3855bea12d2e454d38","subject":"Decode URI component part","message":"Decode URI component part\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = decodeURIComponent col\n      req.db   = col: mongo[req.type], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower.\n\n      if typeof req.query.sort is 'string' and req.query.sort\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\nOnly apply default sort if there are no geospatial queries.\n\n      else\n        sort = 'endret' if not req.db.query.geojson\n\n### Execute\n\nSet limit, skip and, sort options for documents to be returned.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\n      cursor = req.db.col.find(req.db.query, fields, options)\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.json 404, message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower.\n\n      if typeof req.query.sort is 'string' and req.query.sort\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\nOnly apply default sort if there are no geospatial queries.\n\n      else\n        sort = 'endret' if not req.db.query.geojson\n\n### Execute\n\nSet limit, skip and, sort options for documents to be returned.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\n      cursor = req.db.col.find(req.db.query, fields, options)\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8c12d58f0993af13496328e080c1c829a0ff1f92","subject":"document controller config","message":"document controller config\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/09_controller.litcoffee","new_file":"docs\/09_controller.litcoffee","new_contents":"# \/api\/App Components\/Batman.Controller\n\nAll controllers in a batman.js app extend `Batman.Controller`. `Batman.Controller`s are responsible for executing _actions_ which fire off requests for model data, render views, or redirect to other actions in response to navigation state changes. `Batman.Controller` is inspired by [ActionController](http:\/\/guides.rubyonrails.org\/action_controller_overview.html), a key component of Ruby on Rails.\n\n## Controller Directory\n\n`Batman.Controller`s are singletons and each controller's instance is available at [`@sharedController`](\/docs\/api\/batman.controller.html#class_accessor_sharedcontroller). Controller instances are also available at `MyApp.get('controllers')`( the app's [`ControllerDirectory`](\/docs\/api\/controllerdirectory.html)). You can get the controller instance by the part of its name before \"Controller\", downcased. For example:\n\n```\nAlfred.TodosController.get('sharedController') # => TodosController instance\nAlfred.get('controllers.todos')                # => TodosController instance\n```\n\n## Actions\n\nEach `Batman.Controller` declares functions which represent actions to be run on a particular page. Typically, these functions will fetch data or render views:\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n  index: (params) ->\n    @set('todos', Alfred.Todo.get('all'))\n    # will automatically render Alfred.TodosIndexView with source `todos\/index`\n\n  show: (params) ->\n    Alfred.Todo.find params.id, (err, record) ->\n      throw err if err\n      @set('todo', record)\n    # will automatically render Alfred.TodosShowView with source `todos\/show`\n```\n\nActions are passed a `params` argument, which is an object containing URL parameters. Named route parameters (eg, `todos\/:id`) and query string parameters (`?key=value`) are accessible in `params`.\n\n## routingKey and Minification\n\nEach `Batman.Controller` must have a `routingKey`, which is used by the batman.js router. It also makes the app minification-safe. You can set it inside the controller definition:\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n```\n\nAn app will fail to run if a controller's `routingKey` is not defined. To disable this requirement, set `Batman.config.minificationErrors` to false.\n\n## Error Handling\n\n`Batman.Controller` has a built-in structure for handling errors that occur during controller actions. Inside a controller definition, you can map errors to handlers using `@catchError`. Then, you can wrap a storage operation callback with `@errorHandler` to have any errors caught by the defined handlers. If you use `@errorHandler`, errors without declared handlers will be thrown (since they aren't passed to the callback).\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n  # declare a handler with `@catchError`:\n  @catchError Batman.StorageAdapter.NotFoundError, with: 'render404'\n\n  show: (params) ->\n    # wrap your storage operation in `@errorHandler`\n    App.Todo.find params.id, @errorHandler (record, env) =>\n      @set('todo', record)\n\n  # error is passed to the handler\n  render404: (error) -> @render(source: \"errors\/404\")\n```\n\nUsually, you want to declare error handlers in `MyApp.ApplicationController`, then extend `MyApp.ApplicationController` in your other controllers:\n\n```coffeescript\nclass Alfred.ApplicationController extends Batman.Controller\n  @catchError Batman.StorageAdapter.NotFoundError, with: 'render404'\n  # etc...\n\nclass Alfred.TodosController extends Alfred.ApplicationController\n  # will use ApplicationController's handlers for @errorHandler\n```\n\nFor a full list of storage errors, see [`Batman.StorageAdapter` Errors](\/docs\/api\/batman.storageadapter_errors.html).\n\n## ::render([options : [Object|Boolean]]) : View\n\n`render` is used to control the rendering of the current action. Unless specified otherwise, `Batman.Controller` actions render automatically.\n\nPassing `false` will prevent the current action from rendering the view.\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  actionWithNoRender: ->\n    @render(false) # no view will be rendered\n\n  actionWithDelayedRender: ->\n    setTimeout (-> @render()), 1000 # view rendered after 1 second\n    @render(false)\n```\n\nBy passing an `options` object, you may override the default `view`, `source`, `viewClass` or `yield` block.\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  actionWithCustomSource: ->\n    @render(source: 'errors\/404')\n\n  actionWithCustomYield: ->\n    @render(into: 'not-main')\n```\n\n`render` options include:\n\n- `view`: a view instance to render\n- `viewClass`: a class to instantiate and render\n- `source`: An HTML source path to use for the rendered view\n- `into`: The yield where the view should be rendered\n- Other options are passed to the `viewClass` constructor, if provided.\n\nFor more information on yield blocks, see [`Controller::.defaultRenderYield`](\/docs\/api\/batman.controller.html#prototype_property_defaultrenderyield).\n\n## @beforeAction([options : [string|Object],] filter : [string|Function])\n\nDeclares that a function should be executed should be executed before this controller's actions. If any `beforeAction` filter returns `false` or calls [`@redirect`](\/docs\/api\/batman.controller.html#prototype_function_redirect), the controller action won't be executed. `@beforeAction` accepts:\n\n-  `options` representing which action(s) to execute the filter before (optional)\n-  `filter`, either a string naming a function _or_ a function to execute.\n\nThe `options` argument can take three forms:\n\n1. `undefined`: this filter should be executed before all actions.\n2. `String`: this filter should be executed before the action named by the string.\n3. `Object`: this filter should be executed before the actions named by an Array at the `only` key in the options object, or before all actions excluding those named by an Array at the `except` key in the options object.\n\n<!-- tests -->\n\n    test \"@beforeAction allows declaration of filters to execute before an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n    test \"@beforeAction allows declaration of named filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"show\", \"fetchTodo\"\n        fetchTodo: -> @set(\"todo\", {isDone: true})\n        show: ->\n          @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n\n    test \"@beforeAction allows whitelisting or blacklisting filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: [\"show\", \"edit\"], \"fetchTodo\"\n        @beforeAction except: [\"index\"], \"prepareNewTodo\"\n        fetchTodo: -> @set \"todo\", {isDone: true}\n        prepareNewTodo: -> @set \"newTodo\", {isDone: false}\n        index: -> @render false\n        show: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n      deepEqual controller.get(\"newTodo\"), {isDone: false}\n\n    test \"@beforeAction allows declaration of filters to execute before all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n## @afterAction([options : [string|Object],] filter : [string|Function])\n\nDeclares that a function should be executed after this controller's actions (and after any `render` or `redirect`s). `@afterAction` accepts `options` and `filter` (see [`@beforeAction`](\/docs\/api\/batman.controller.html#class_function_beforeaction)).\n\n    test \"@afterAction allows declaration of filters to execute after an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n    test \"@afterAction allows declaration of named filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"create\", \"notify\"\n        notify: -> result = \"Todo created successfully.\"\n        create: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows whitelisting or blacklisting filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: [\"create\", \"update\"], \"notify\"\n        index: -> @render false\n        create: -> @render false\n        notify: -> result = \"Todo created successfully.\"\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal result, null\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows declaration of filters to execute after all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n## ::executeAction(action: string[, params: Object])\n\nRuns the `action` specified, including all applicable `@beforeAction`s and `@afterAction`s. Optionally, `params` can be passed into the new action for processing. If no params are passed, it will default to the params of the current action.\n\n    test \"executeAction will run the action and all @beforeAction and @afterAction filters\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n        other: ->\n          @executeAction(\"index\")\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      deepEqual results, [\"before!\", \"action!\", \"after!\"]\n\n## ::redirect(options: [string|Object])\n\nProperly handles the controller filter chain and loads a new page with [`Batman.redirect`](\/docs\/api\/batman.html#class_function_redirect). See [`Batman.redirect`](\/docs\/api\/batman.html#class_function_redirect) for allowed `options`. If `options` is an object, the current controller will be added as the object's `controller` attribute (if it isn't already present), so calling `@redirect({action: \"show\", id: itemId})` is equivalent to calling `@redirect({action: 'show', id: itemId, controller: 'items'})`.\n\n## ::scrollToHash([hash: string])\n\n`scrollToHash` emulates the native scrolling behaviour of the browser by allowing the URL to link to a specific ID on the page. The code will look for an element with a matching ID to `hash` if it is provided otherwise using the `#` parameter in the URL. If an element is found, the page will scroll to the matching element.\n\n## ::.autoScrollToHash[= true] : boolean\n\nSpecifies if the controller should automatically scroll to the element with ID equal to the `hash` parameter. This behaviour emulates the native behaviour of the same nature, but is implemented in Batman so the functionality works after each dispatch (instead of each page refresh) and when Batman is using hash bang routing.\n\n## ::.defaultRenderYield[= 'main'] : string\n\n`defaultRenderYield` specifies which yield (see [`data-yield`](\/docs\/api\/batman.view_bindings.html#data-yield)) a controller should automatically render into if no yield is declared.\n\n## ::.coerceIntegerParams[=true] : boolean\n\nIf true, strings like `\"123\"` will be coerced to integers when passed in controller params. This is good for `Batman.Model` IDs. To disable this, set it to false in your controller class definition:\n\n```coffeescript\nclass MyApp.MyController extends MyApp.ApplicationController\n  coerceIntegerParams: false\n```\n\n## @%sharedController : Controller\n\nThe singleton instance of the `Controller`.\n\n## @catchError(errorClasses..., {with : [String|Array]})\n\nDeclares that errors which are `instanceof` any of `errorClasses` should be handled by `with` when using [`@errorHandler`](\/docs\/api\/batman.controller.html#class_function_errorhandler). `with` is the name of a prototype function (or an array of names) which will be invoked with the error. See [\"Error Handling\"](\/docs\/api\/batman.controller.html#error_handling).\n\n## @errorHandler(callback)\n\nWraps a storage action, passing the first argument (`error`) to error handlers declared with [`@catchError`](\/docs\/api\/batman.controller.html#class_function_catcherror). Callback should take arguments `result, env` (`error` is not present because it was passed to error handlers). See [\"Error Handling\"](\/docs\/api\/batman.controller.html#error_handling).\n","old_contents":"# \/api\/App Components\/Batman.Controller\n\nAll controllers in a batman.js app extend `Batman.Controller`. `Batman.Controller`s are responsible for executing _actions_ which fire off requests for model data, render views, or redirect to other actions in response to navigation state changes. `Batman.Controller` is inspired by [ActionController](http:\/\/guides.rubyonrails.org\/action_controller_overview.html), a key component of Ruby on Rails.\n\n## Controller Directory\n\n`Batman.Controller`s are singletons and each controller's instance is available at [`@sharedController`](\/docs\/api\/batman.controller.html#class_accessor_sharedcontroller). Controller instances are also available at `MyApp.get('controllers')`( the app's [`ControllerDirectory`](\/docs\/api\/controllerdirectory.html)). You can get the controller instance by the part of its name before \"Controller\", downcased. For example:\n\n```\nAlfred.TodosController.get('sharedController') # => TodosController instance\nAlfred.get('controllers.todos')                # => TodosController instance\n```\n\n## Actions\n\nEach `Batman.Controller` declares functions which represent actions to be run on a particular page. Typically, these functions will fetch data or render views:\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n  index: (params) ->\n    @set('todos', Alfred.Todo.get('all'))\n    # will automatically render Alfred.TodosIndexView with source `todos\/index`\n\n  show: (params) ->\n    Alfred.Todo.find params.id, (err, record) ->\n      throw err if err\n      @set('todo', record)\n    # will automatically render Alfred.TodosShowView with source `todos\/show`\n```\n\nActions are passed a `params` argument, which is an object containing URL parameters. Named route parameters (eg, `todos\/:id`) and query string parameters (`?key=value`) are accessible in `params`.\n\n## routingKey and Minification\n\nEach `Batman.Controller` must have a `routingKey`, which is used by the batman.js router. It also makes the app minification-safe. You can set it inside the controller definition:\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n```\n\nAn app will fail to run if a controller's `routingKey` is not defined. To disable this requirement, set `Batman.config.minificationErrors` to false.\n\n## Error Handling\n\n`Batman.Controller` has a built-in structure for handling errors that occur during controller actions. Inside a controller definition, you can map errors to handlers using `@catchError`. Then, you can wrap a storage operation callback with `@errorHandler` to have any errors caught by the defined handlers. If you use `@errorHandler`, errors without declared handlers will be thrown (since they aren't passed to the callback).\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  routingKey: 'todos'\n  # declare a handler with `@catchError`:\n  @catchError Batman.StorageAdapter.NotFoundError, with: 'render404'\n\n  show: (params) ->\n    # wrap your storage operation in `@errorHandler`\n    App.Todo.find params.id, @errorHandler (record, env) =>\n      @set('todo', record)\n\n  # error is passed to the handler\n  render404: (error) -> @render(source: \"errors\/404\")\n```\n\nUsually, you want to declare error handlers in `MyApp.ApplicationController`, then extend `MyApp.ApplicationController` in your other controllers:\n\n```coffeescript\nclass Alfred.ApplicationController extends Batman.Controller\n  @catchError Batman.StorageAdapter.NotFoundError, with: 'render404'\n  # etc...\n\nclass Alfred.TodosController extends Alfred.ApplicationController\n  # will use ApplicationController's handlers for @errorHandler\n```\n\nFor a full list of storage errors, see [`Batman.StorageAdapter` Errors](\/docs\/api\/batman.storageadapter_errors.html).\n\n## ::render([options : [Object|Boolean]]) : View\n\n`render` is used to control the rendering of the current action. Unless specified otherwise, `Batman.Controller` actions render automatically.\n\nPassing `false` will prevent the current action from rendering the view.\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  actionWithNoRender: ->\n    @render(false) # no view will be rendered\n\n  actionWithDelayedRender: ->\n    setTimeout (-> @render()), 1000 # view rendered after 1 second\n    @render(false)\n```\n\nBy passing an `options` object, you may override the default `view`, `source`, `viewClass` or `yield` block.\n\n```coffeescript\nclass Alfred.TodosController extends Batman.Controller\n  actionWithCustomSource: ->\n    @render(source: 'errors\/404')\n\n  actionWithCustomYield: ->\n    @render(into: 'not-main')\n```\n\n`render` options include:\n\n- `view`: a view instance to render\n- `viewClass`: a class to instantiate and render\n- `source`: An HTML source path to use for the rendered view\n- `into`: The yield where the view should be rendered\n- Other options are passed to the `viewClass` constructor, if provided.\n\nFor more information on yield blocks, see [`Controller::.defaultRenderYield`](\/docs\/api\/batman.controller.html#prototype_property_defaultrenderyield).\n\n## @beforeAction([options : [string|Object],] filter : [string|Function])\n\nDeclares that a function should be executed should be executed before this controller's actions. If any `beforeAction` filter returns `false` or calls [`@redirect`](\/docs\/api\/batman.controller.html#prototype_function_redirect), the controller action won't be executed. `@beforeAction` accepts:\n\n-  `options` representing which action(s) to execute the filter before (optional)\n-  `filter`, either a string naming a function _or_ a function to execute.\n\nThe `options` argument can take three forms:\n\n1. `undefined`: this filter should be executed before all actions.\n2. `String`: this filter should be executed before the action named by the string.\n3. `Object`: this filter should be executed before the actions named by an Array at the `only` key in the options object, or before all actions excluding those named by an Array at the `except` key in the options object.\n\n<!-- tests -->\n\n    test \"@beforeAction allows declaration of filters to execute before an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n    test \"@beforeAction allows declaration of named filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"show\", \"fetchTodo\"\n        fetchTodo: -> @set(\"todo\", {isDone: true})\n        show: ->\n          @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n\n    test \"@beforeAction allows whitelisting or blacklisting filters to execute before an action\", ->\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: [\"show\", \"edit\"], \"fetchTodo\"\n        @beforeAction except: [\"index\"], \"prepareNewTodo\"\n        fetchTodo: -> @set \"todo\", {isDone: true}\n        prepareNewTodo: -> @set \"newTodo\", {isDone: false}\n        index: -> @render false\n        show: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"show\"\n      deepEqual controller.get(\"todo\"), {isDone: true}\n      deepEqual controller.get(\"newTodo\"), {isDone: false}\n\n    test \"@beforeAction allows declaration of filters to execute before all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction -> results.push \"before!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"before!\"\n      equal results[1], \"action!\"\n\n## @afterAction([options : [string|Object],] filter : [string|Function])\n\nDeclares that a function should be executed after this controller's actions (and after any `render` or `redirect`s). `@afterAction` accepts `options` and `filter` (see [`@beforeAction`](\/docs\/api\/batman.controller.html#class_function_beforeaction)).\n\n    test \"@afterAction allows declaration of filters to execute after an action\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n    test \"@afterAction allows declaration of named filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: \"create\", \"notify\"\n        notify: -> result = \"Todo created successfully.\"\n        create: -> @render false\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows whitelisting or blacklisting filters to execute after an action\", ->\n      result = null\n\n      class TodoController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction only: [\"create\", \"update\"], \"notify\"\n        index: -> @render false\n        create: -> @render false\n        notify: -> result = \"Todo created successfully.\"\n\n      controller = TodoController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal result, null\n      controller.dispatch \"create\"\n      equal result, \"Todo created successfully.\"\n\n    test \"@afterAction allows declaration of filters to execute after all actions\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @afterAction -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"index\"\n      equal results[0], \"action!\"\n      equal results[1], \"after!\"\n\n## ::executeAction(action: string[, params: Object])\n\nRuns the `action` specified, including all applicable `@beforeAction`s and `@afterAction`s. Optionally, `params` can be passed into the new action for processing. If no params are passed, it will default to the params of the current action.\n\n    test \"executeAction will run the action and all @beforeAction and @afterAction filters\", ->\n      results = []\n\n      class TestController extends Batman.Controller\n        routingKey: \"test\"\n        @beforeAction only: \"index\", -> results.push \"before!\"\n        @afterAction only: \"index\", -> results.push \"after!\"\n        index: ->\n          results.push \"action!\"\n          @render false\n        other: ->\n          @executeAction(\"index\")\n\n      controller = TestController.get(\"sharedController\")\n      controller.dispatch \"other\"\n      deepEqual results, [\"before!\", \"action!\", \"after!\"]\n\n## ::redirect(options: [string|Object])\n\nProperly handles the controller filter chain and loads a new page with [`Batman.redirect`](\/docs\/api\/batman.html#class_function_redirect). See [`Batman.redirect`](\/docs\/api\/batman.html#class_function_redirect) for allowed `options`. If `options` is an object, the current controller will be added as the object's `controller` attribute (if it isn't already present), so calling `@redirect({action: \"show\", id: itemId})` is equivalent to calling `@redirect({action: 'show', id: itemId, controller: 'items'})`.\n\n## ::scrollToHash([hash: string])\n\n`scrollToHash` emulates the native scrolling behaviour of the browser by allowing the URL to link to a specific ID on the page. The code will look for an element with a matching ID to `hash` if it is provided otherwise using the `#` parameter in the URL. If an element is found, the page will scroll to the matching element.\n\n## ::.autoScrollToHash[= true] : boolean\n\nSpecifies if the controller should automatically scroll to the element with ID equal to the `hash` parameter. This behaviour emulates the native behaviour of the same nature, but is implemented in Batman so the functionality works after each dispatch (instead of each page refresh) and when Batman is using hash bang routing.\n\n## ::.defaultRenderYield[= 'main'] : string\n\n`defaultRenderYield` specifies which yield (see [`data-yield`](\/docs\/api\/batman.view_bindings.html#data-yield)) a controller should automatically render into if no yield is declared.\n\n## @%sharedController : Controller\n\nThe singleton instance of the `Controller`.\n\n## @catchError(errorClasses..., {with : [String|Array]})\n\nDeclares that errors which are `instanceof` any of `errorClasses` should be handled by `with` when using [`@errorHandler`](\/docs\/api\/batman.controller.html#class_function_errorhandler). `with` is the name of a prototype function (or an array of names) which will be invoked with the error. See [\"Error Handling\"](\/docs\/api\/batman.controller.html#error_handling).\n\n## @errorHandler(callback)\n\nWraps a storage action, passing the first argument (`error`) to error handlers declared with [`@catchError`](\/docs\/api\/batman.controller.html#class_function_catcherror). Callback should take arguments `result, env` (`error` is not present because it was passed to error handlers). See [\"Error Handling\"](\/docs\/api\/batman.controller.html#error_handling).\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"be5bc1a43d7c7834b5b110882842c3cd55f117dd","subject":"Don't overrite config properites in initialize","message":"Don't overrite config properites in initialize\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/config.litcoffee","new_file":"lib\/config.litcoffee","new_contents":"    Module = require '.\/module'\n    q      = require 'q'\n    argv   = require '.\/arguments'\n    path   = require 'path'\n    fs     = require 'fs'\n\n    process.env.CGAPI_LOG_LEVEL = if argv?.verbosity? then argv.verbosity else 3\n\n    class Config extends Module\n\n      pathfinder: (neighbors) ->\n        o = [ ]\n\n        for n in [1..(neighbors.length \/ 1)]\n          c = 1 \/ neighbors.length\n\n          if neighbors[n - 1] == 'RIGHT'\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * ((2 \/ c) * 0.5)) * c\n          else\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * (0.5 \/ c)) * c\n\n        chance = Math.random()\n\n        for option in o\n          neighbor = Object.keys(option)[0]\n\n          return neighbor if option[neighbor] > chance\n\n      initialize: (params) =>\n        deferred = q.defer()\n        levels   = [ ]\n        base     = if params?.location? then params.location else path.join __dirname, '..'\n        config   = path.join base, '.skyll.conf.js'\n\n        fs.stat config, (err) =>\n          if err? || params?.cli?\n            if argv?._?.length > 0\n              levels = levels.concat argv._\n            else if argv?.l?\n              for level in [0...argv.l]\n                levels.push new Date(Date.now() - (((argv.l - 1) - level) * 1000)).toString()\n            else if argv?.levels? == false\n              levels.push new Date().toString()\n            for key, val of argv\n              if key.length > 2 && typeof val != 'undefined'\n                if key == 'levels'\n                  levels = levels.concat val\n                else\n                  @[key] = val\n          else\n            for key, val of require config\n              unless @[key]?\n                if key == 'levels'\n                  for level in [0...val]\n                    levels.push new Date(Date.now() - (((val - 1) - level) * 1000)).toString()\n                else\n                  @[key] = val\n\n          levels.push new Date().toString() if levels.length == 0\n\n          @levels = levels\n          @grid   = ((false for j in [0..@columns]) for i in [0..@rows])\n          @width  = @width  * @multiplier\n          @height = @height * @multiplier\n\n          super().then => deferred.resolve @\n\n        deferred.promise\n\n    module.exports = Config\n","old_contents":"    Module = require '.\/module'\n    q      = require 'q'\n    argv   = require '.\/arguments'\n    path   = require 'path'\n    fs     = require 'fs'\n\n    process.env.CGAPI_LOG_LEVEL = if argv?.verbosity? then argv.verbosity else 3\n\n    class Config extends Module\n\n      pathfinder: (neighbors) ->\n        o = [ ]\n\n        for n in [1..(neighbors.length \/ 1)]\n          c = 1 \/ neighbors.length\n\n          if neighbors[n - 1] == 'RIGHT'\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * ((2 \/ c) * 0.5)) * c\n          else\n            o.push \"#{neighbors[n - 1]}\": ((c * n) * (0.5 \/ c)) * c\n\n        chance = Math.random()\n\n        for option in o\n          neighbor = Object.keys(option)[0]\n\n          return neighbor if option[neighbor] > chance\n\n      initialize: (params) =>\n        deferred = q.defer()\n        levels   = [ ]\n        base     = if params?.location? then params.location else path.join __dirname, '..'\n        config   = path.join base, '.skyll.conf.js'\n\n        fs.stat config, (err) =>\n          if err? || params?.cli?\n            if argv?._?.length > 0\n              levels = levels.concat argv._\n            else if argv?.l?\n              for level in [0...argv.l]\n                levels.push new Date(Date.now() - (((argv.l - 1) - level) * 1000)).toString()\n            else if argv?.levels? == false\n              levels.push new Date().toString()\n            for key, val of argv\n              if key.length > 2 && typeof val != 'undefined'\n                if key == 'levels'\n                  levels = levels.concat val\n                else\n                  @[key] = val\n          else\n            for key, val of require config\n              if key == 'levels'\n                for level in [0...val]\n                  levels.push new Date(Date.now() - (((val - 1) - level) * 1000)).toString()\n              else\n                @[key] = val\n\n          levels.push new Date().toString() if levels.length == 0\n\n          @levels = levels\n          @grid   = ((false for j in [0..@columns]) for i in [0..@rows])\n          @width  = @width  * @multiplier\n          @height = @height * @multiplier\n\n          super().then => deferred.resolve @\n\n        deferred.promise\n\n    module.exports = Config\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"85d5bbcb39480f3ce5890caf77d463035472266a","subject":"Fix some bad advice I put in the StorageAdapter docs","message":"Fix some bad advice I put in the StorageAdapter docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/12_storage_adapters.litcoffee","new_file":"docs\/12_storage_adapters.litcoffee","new_contents":"# Batman.StorageAdapter\n\n`Batman.StorageAdapter`s handle persistence of [`Batman.Model`s](\/docs\/api\/batman.model.html). Any `Batman.Model` which will be created, read, updated or deleted must have a storage adapter, which is declared with [`Batman.Model@persist`](\/docs\/api\/batman.model.html#class_function_persist):\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @persist Batman.RestStorage # a StorageAdapter subclass\n```\n\n__Note:__ `@persist` instantiates a StorageAdapter instance during model definition, so it will use `@storageKey` and `@resourceName` from the model where it was instantiated, but it won't play well with inheritance. For example:\n\n```coffeescript\nclass App.Model extends Batman.Model\n  @storageKey: 'model'\n  @persist Batman.LocalStorage\n\nclass App.Superhero extends App.Model\n  # have to do it again here, or else it will use @storageKey of 'model'\n  @storageKey: 'superhero'\n  @persist Batman.LocalStorage\n```\n\n### Batman's Included StorageAdapters\n\nBatman ships with a few storage adapters to get you up and coding quickly:\n\n- `Batman.LocalStorage` uses [`window.localStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#localStorage) to persist records.\n- `Batman.SessionStorage` extends `Batman.LocalStorage` and uses [`window.sessionStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#sessionStorage) to persist records.\n- `Batman.RestStorage` uses [HTTP REST](http:\/\/en.wikipedia.org\/wiki\/REST) to persist records, mapping HTTP verbs to storage operations and handling HTTP response codes appropriately. _Note: Because `Batman.RestStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\n### Batman.RailsStorage\nAlso, `Batman.RailsStorage` (available in separate file: [Coffee](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.rails.coffee), JS) extends `Batman.RestStorage` and provides some helpful Rails integrations:\n\n- If the response's status code is 422 (`Unprocessable Entity`), Any `errors` defined in the JSON response will be added to the `Batman.Model`'s [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n- By default, Batman will get the Rails CSRF token from the `<head>`and send it as a request header. (This can be prevented by setting `Batman.config.protectFromCSRF = false`.)\n- If a record's URL doesn't end in `.json` and doesn't include a query string, `.json` is automatically appended to the URL.\n\n\n_Note: Like `Batman.RestStorage`, `Batman.RailsStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), so you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\nIf you're using Batman and Rails, be sure to check out the [batman-rails](https:\/\/github.com\/batmanjs\/batman-rails) gem.\n\n## Subclassing Batman.StorageAdapter\n\nYou may want to customize Batman's storage operations for your own app, for example:\n\n- Adding before- and after-operation callbacks\n- Overriding default storage operations\n\nTo do this, extend `Batman.StorageAdapter` (or one of the provided subclasses), then use your storage adapter to persist your models.\n```\nclass App.HeroicStorageAdapter extends Batman.LocalStorage\n  # filters, overrides\n\nclass App.Superhero extends Batman.Model\n  @persist App.HeroicStorageAdapter\n```\n### `env` and `next`\n\nStorage operations and callbacks each take two arguments: `env` and `next`.\n\n`env` is a vanilla JS object which is passed to each function in the chain. `Batman.StorageAdapter` sets these attributes on `env`:\n\n- `env.subject` is the `Batman.Model` record which had the storage operation called on it.\n- `env.options` contains the options passed to the operation on the subject.\n- `env.action` is the storage operation that will be executed by the storage adapter.\n- `env.error` stores any errors that occur during the chain. It becomes the first argument to the operation callback.\n- `env.result` contains the record(s) returned by the operation and should be set by the storage adapter implementation. It becomes the second argument to the operation's callback.\n\nStorage adapters may use `env` to collect any extra information needed by their operations. For example, `Batman.RestStorage` adds some attributes to `env` and `env.options`:\n\n- `env.request` is the `Batman.Request` which implements the storage operation.\n- `env.options.method` is the HTTP method used by `Batman.Request` to implement the storage operation.\n- `env.options.url` is the URL used by `Batman.Request` to implement the storage operation.\n\n`next` is a reference to the next function in the call chain for the current storage operation. `Batman.StorageAdapter` uses this to execute before-filters, storage operations and after-filters in the correct sequence.\n\n\n`next` should be called (`next()`) when the current function has completed. This indicates that the operation should proceed with the next function in its call chain. To ensure the completion of the call chain, consider wrapping your function in [`@skipIfError`](\/docs\/api\/batman.storageadapter.html#class_function_skipiferror).\n\n\n### Adding Callbacks\n\nCallbacks can be registered with [`before`](\/docs\/api\/batman.storageadapter.html#prototype_function_before) and [`after`](\/docs\/api\/batman.storageadapter.html#prototype_function_after) on any storage operation (listed below) or `'all'` (which runs the callback before or after any operation). Callbacks accept two arguments, `env` and `next`, discussed below.\n\n```coffeescript\nclass App.SpecificHeaderStorageAdapter extends Batman.RestStorage\n  # include a specific header in all requests:\n  @::before 'all', (env, next) ->\n    headers = env.options.headers ||= {}\n    headers[\"App-Specific-Header\"] = App.getSpecificHeader()\n    next()\n\n  @::after 'create', (env, next) ->\n    console.log \"A #{env.subject.constructor.name} was created!\"\n    next()\n```\n\n## Storage Operations\n\nAny `StorageAdapter` must implement these operations as instance methods, for example:\n\n\n```\nclass App.ModifiedStorageAdapter extends Batman.RestStorage\n  destroy: (env, next) ->\n    # your custom destroy operation\n    next()\n```\n\nWhen a record is saved, destroyed or loaded, `Batman.StorageAdapter` invokes these methods. Although you may reimplement them, you probably don't need to call them in your application code.\n\n## ::create(env : Object, next : Function)\nCalled to save a new record. When `save` is called on a record and `isNew` returns `true`, the storage adapter's `create` method is called.\n\n## ::read(env : Object, next : Function)\nCalled to load a record from storage.\n\n## ::update(env : Object, next : Function)\nCalled to update an existing record. When `save` is called on a record and `isNew` returns `false`, the storage adapter's `update` method is called.\n\n## ::destroy(env : Object, next : Function)\nCalled to destroy an existing record.\n\n## ::readAll(env : Object, next : Function)\nCalled to load all records of a particular type from storage.\n\n## Other Useful Methods\n\n## @skipIfError(wrappedFunction : Function )\n\nWraps a function, bypassing the function body and calling next() if an error has already occurred.\n\n    test \"StorageAdapter@skipIfError doesn't call the function if env.error?\", ->\n      insideFunction = createSpy()\n      nextFunction = createSpy()\n\n      functionWithWrapper = Batman.LocalStorage.skipIfError (env, next) ->\n        insideFunction()\n\n      dummyEnv = {error: true}\n\n      functionWithWrapper(dummyEnv, nextFunction)\n\n      equal dummyEnv.error?, true, 'an error is present'\n      equal insideFunction.called, false, 'insideFunction was skipped'\n      equal nextFunction.called, true, 'nextFunction was called'\n\nInside a storage adapter definition, this function is referenced as `@skipIfError`, for example:\n\n```\nclass App.SpecialStorageAdapter extends Batman.RestStorage\n  @::before 'create', @skipIfError (env, next) ->\n    console.log(\"This will be skipped if env.error? is true!\")\n    next()\n```\n\n## ::before (keys... : Strings, filter : Function)\nRegisters `filter` as a before-operation callback for the storage operations named by `keys...`.\n\n## ::after (keys... : Strings, filter : Function)\nRegisters `filter` as a after-operation callback for the storage operations named by `keys...`.\n","old_contents":"# Batman.StorageAdapter\n\n`Batman.StorageAdapter`s handle persistence of [`Batman.Model`s](\/docs\/api\/batman.model.html). Any `Batman.Model` which will be created, read, updated or deleted must have a storage adapter, which is declared with [`Batman.Model@persist`](\/docs\/api\/batman.model.html#class_function_persist):\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @persist Batman.RestStorage # a StorageAdapter subclass\n```\n\n__Protip:__ Consider setting the storage adapter in one `Batman.Model` subclass, then extending that subclass in the rest of your app. Then, you won't have to call `@persist` every time:\n\n```coffeescript\nclass App.Model extends Batman.Model\n  @persist Batman.LocalStorage\n\nclass App.Superhero extends App.Model\n  # no need to call @persist here!\n\nclass App.Sidekick extends App.Model\n  # or here!\n```\n\n### Batman's Included StorageAdapters\n\nBatman ships with a few storage adapters to get you up and coding quickly:\n\n- `Batman.LocalStorage` uses [`window.localStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#localStorage) to persist records.\n- `Batman.SessionStorage` extends `Batman.LocalStorage` and uses [`window.sessionStorage`](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/Guide\/API\/DOM\/Storage#sessionStorage) to persist records.\n- `Batman.RestStorage` uses [HTTP REST](http:\/\/en.wikipedia.org\/wiki\/REST) to persist records, mapping HTTP verbs to storage operations and handling HTTP response codes appropriately. _Note: Because `Batman.RestStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\n### Batman.RailsStorage\nAlso, `Batman.RailsStorage` (available in separate file: [Coffee](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.rails.coffee), JS) extends `Batman.RestStorage` and provides some helpful Rails integrations:\n\n- If the response's status code is 422 (`Unprocessable Entity`), Any `errors` defined in the JSON response will be added to the `Batman.Model`'s [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n- By default, Batman will get the Rails CSRF token from the `<head>`and send it as a request header. (This can be prevented by setting `Batman.config.protectFromCSRF = false`.)\n- If a record's URL doesn't end in `.json` and doesn't include a query string, `.json` is automatically appended to the URL.\n\n\n_Note: Like `Batman.RestStorage`, `Batman.RailsStorage` depends on [`Batman.Request`](\/docs\/api\/batman.request.html), so you'll need a [platform library](\/docs\/api\/batman.request.html#platform_request_implementation_libraries) to implement `Batman.Request`._\n\nIf you're using Batman and Rails, be sure to check out the [batman-rails](https:\/\/github.com\/batmanjs\/batman-rails) gem.\n\n## Subclassing Batman.StorageAdapter\n\nYou may want to customize Batman's storage operations for your own app, for example:\n\n- Adding before- and after-operation callbacks\n- Overriding default storage operations\n\nTo do this, extend `Batman.StorageAdapter` (or one of the provided subclasses), then use your storage adapter to persist your models.\n```\nclass App.HeroicStorageAdapter extends Batman.LocalStorage\n  # filters, overrides\n\nclass App.Superhero extends Batman.Model\n  @persist App.HeroicStorageAdapter\n```\n### `env` and `next`\n\nStorage operations and callbacks each take two arguments: `env` and `next`.\n\n`env` is a vanilla JS object which is passed to each function in the chain. `Batman.StorageAdapter` sets these attributes on `env`:\n\n- `env.subject` is the `Batman.Model` record which had the storage operation called on it.\n- `env.options` contains the options passed to the operation on the subject.\n- `env.action` is the storage operation that will be executed by the storage adapter.\n- `env.error` stores any errors that occur during the chain. It becomes the first argument to the operation callback.\n- `env.result` contains the record(s) returned by the operation and should be set by the storage adapter implementation. It becomes the second argument to the operation's callback.\n\nStorage adapters may use `env` to collect any extra information needed by their operations. For example, `Batman.RestStorage` adds some attributes to `env` and `env.options`:\n\n- `env.request` is the `Batman.Request` which implements the storage operation.\n- `env.options.method` is the HTTP method used by `Batman.Request` to implement the storage operation.\n- `env.options.url` is the URL used by `Batman.Request` to implement the storage operation.\n\n`next` is a reference to the next function in the call chain for the current storage operation. `Batman.StorageAdapter` uses this to execute before-filters, storage operations and after-filters in the correct sequence.\n\n\n`next` should be called (`next()`) when the current function has completed. This indicates that the operation should proceed with the next function in its call chain. To ensure the completion of the call chain, consider wrapping your function in [`@skipIfError`](\/docs\/api\/batman.storageadapter.html#class_function_skipiferror).\n\n\n### Adding Callbacks\n\nCallbacks can be registered with [`before`](\/docs\/api\/batman.storageadapter.html#prototype_function_before) and [`after`](\/docs\/api\/batman.storageadapter.html#prototype_function_after) on any storage operation (listed below) or `'all'` (which runs the callback before or after any operation). Callbacks accept two arguments, `env` and `next`, discussed below.\n\n```coffeescript\nclass App.SpecificHeaderStorageAdapter extends Batman.RestStorage\n  # include a specific header in all requests:\n  @::before 'all', (env, next) ->\n    headers = env.options.headers ||= {}\n    headers[\"App-Specific-Header\"] = App.getSpecificHeader()\n    next()\n\n  @::after 'create', (env, next) ->\n    console.log \"A #{env.subject.constructor.name} was created!\"\n    next()\n```\n\n## Storage Operations\n\nAny `StorageAdapter` must implement these operations as instance methods, for example:\n\n\n```\nclass App.ModifiedStorageAdapter extends Batman.RestStorage\n  destroy: (env, next) ->\n    # your custom destroy operation\n    next()\n```\n\nWhen a record is saved, destroyed or loaded, `Batman.StorageAdapter` invokes these methods. Although you may reimplement them, you probably don't need to call them in your application code.\n\n## ::create(env : Object, next : Function)\nCalled to save a new record. When `save` is called on a record and `isNew` returns `true`, the storage adapter's `create` method is called.\n\n## ::read(env : Object, next : Function)\nCalled to load a record from storage.\n\n## ::update(env : Object, next : Function)\nCalled to update an existing record. When `save` is called on a record and `isNew` returns `false`, the storage adapter's `update` method is called.\n\n## ::destroy(env : Object, next : Function)\nCalled to destroy an existing record.\n\n## ::readAll(env : Object, next : Function)\nCalled to load all records of a particular type from storage.\n\n## Other Useful Methods\n\n## @skipIfError(wrappedFunction : Function )\n\nWraps a function, bypassing the function body and calling next() if an error has already occurred.\n\n    test \"StorageAdapter@skipIfError doesn't call the function if env.error?\", ->\n      insideFunction = createSpy()\n      nextFunction = createSpy()\n\n      functionWithWrapper = Batman.LocalStorage.skipIfError (env, next) ->\n        insideFunction()\n\n      dummyEnv = {error: true}\n\n      functionWithWrapper(dummyEnv, nextFunction)\n\n      equal dummyEnv.error?, true, 'an error is present'\n      equal insideFunction.called, false, 'insideFunction was skipped'\n      equal nextFunction.called, true, 'nextFunction was called'\n\nInside a storage adapter definition, this function is referenced as `@skipIfError`, for example:\n\n```\nclass App.SpecialStorageAdapter extends Batman.RestStorage\n  @::before 'create', @skipIfError (env, next) ->\n    console.log(\"This will be skipped if env.error? is true!\")\n    next()\n```\n\n## ::before (keys... : Strings, filter : Function)\nRegisters `filter` as a before-operation callback for the storage operations named by `keys...`.\n\n## ::after (keys... : Strings, filter : Function)\nRegisters `filter` as a after-operation callback for the storage operations named by `keys...`.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6fd2fa3fa851fc2b07f714d2da2c0746b844bd08","subject":"Fix rendering pipeline execution","message":"Fix rendering pipeline execution\n\nA single rendering pipeline as well as a collection of pipelines can\nnow be rendered successfully\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/skyll.litcoffee","new_file":"lib\/skyll.litcoffee","new_contents":"    Madul = require 'madul'\n\n    class Skyll extends Madul\n      deps: [ 'config', 'carver', 'async' ]\n      pub:  [ 'craft' ]\n\n      render_pipeline: [ ]\n      renderers:       [ ]\n\n      post_initialize: =>\n        pipe = [ ]\n\n        for p in @config.pipeline\n          if Array.isArray p\n            for q in p\n              pipe.push q unless pipe.includes q\n          else\n            pipe.push p unless pipe.includes p\n\n        @hydrate pipe, =>\n          renderer_pushed = false\n          for p in @config.pipeline\n            if Array.isArray p\n              @renderers.push @[p[0]]\n\n              new_pipeline = for q in p\n                @[q]\n\n              @render_pipeline.push new_pipeline\n            else\n              unless renderer_pushed\n                @renderers.push @[p]\n                renderer_pushed = true\n\n              @render_pipeline.push @[p]\n\n          @carver.starting_row = Math.floor @config.grid.length \/ 2\n\n          @done()\n\n      do_flush: (i, level_name, next) =>\n        if @renderers[i].flush?\n          flushed = @renderers[i].flush level_name\n\n          if typeof flushed?.then == 'function'\n            flushed.then => next()\n          else\n            next()\n        else\n          next()\n\n      do_render: (step, path, level_name, next) =>\n        console.log 'rendering', step.constructor.name\n\n        status = step.render path, level_name\n\n        if typeof status?.then == 'function'\n          status.then => next()\n        else\n          next()\n\n      craft: (level_name) =>\n        @carver.clear_state()\n\n        path = @carver.carve_path()\n\n        @async.eachOfSeries @render_pipeline, (pipeline, i, next) =>\n          if Array.isArray pipeline\n            @async.eachSeries pipeline, (step, nxt) =>\n              @do_render step, path, level_name, nxt\n            , => @do_flush i, level_name, next\n          else\n            @do_render pipeline, path, level_name, =>\n              if i == @render_pipeline.length - 1\n                @do_flush 0, level_name, next\n              else\n                next()\n        , => @done()\n\n    module.exports = Skyll\n","old_contents":"    Madul = require 'madul'\n\n    class Skyll extends Madul\n      deps: [ 'config', 'carver', 'async' ]\n      pub:  [ 'craft' ]\n\n      render_pipeline: [ ]\n      renderers:       [ ]\n\n      post_initialize: =>\n\n        super().then =>\n          for p in @config.pipeline\n            if Array.isArray p\n              for q in p\n                @deps.push q unless @deps.includes q\n            else\n              @deps.push p unless @deps.includes p\n\n          @hydrate_dependencies().then =>\n            for p in @config.pipeline\n              if Array.isArray p\n                @renderers.push @[p[0]]\n\n                new_pipeline = for q in p\n                  @[q]\n\n                @render_pipeline.push new_pipeline\n              else\n                @renderers.push @[p]\n                @render_pipeline.push @[p]\n\n            @carver.starting_row = params.starting_row\n\n            deferred.resolve @\n\n        deferred.promise\n\n      craft: (level_name) =>\n        @carver.clear_state()\n\n        path = @carver.carve_path()\n\n        @async.mapSeries @render_pipeline, (step, next) =>\n          i = @render_pipeline.indexOf step\n\n          if Array.isArray step\n            @q.all step.map (pipeline) => pipeline.render path, level_name\n              .then => @renderers[i].flush level_name\n              .then => next()\n          else\n            step.render path, level_name\n              .then => @renderers[i].flush level_name\n              .then => next()\n        , => @done()\n\n    module.exports = Skyll\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7fd5d337429fad5d5eb807751b50ead6064eb32c","subject":"Added more accordion litcoffee pesudo code","message":"Added more accordion litcoffee pesudo code\n","repos":"TeaMeow\/TocasUI,TeaMeow\/TocasUI","old_file":"src\/javascript\/accordion.litcoffee","new_file":"src\/javascript\/accordion.litcoffee","new_contents":"\u624b\u98a8\u7434\n======\n\n\u624b\u98a8\u7434\u80fd\u5920\u958b\u95dc\u9589\u5408\u5176\u9762\u677f\u3002\n\n    Name = 'Accordion'\n\n\u8a2d\u5b9a\n---------------\n\n    Settings =\n        # \u6d88\u97f3\u6240\u6709\u63d0\u793a\uff0c\u751a\u81f3\u662f\u932f\u8aa4\u8a0a\u606f\u3002\n        silent        : false\n        # \u986f\u793a\u9664\u932f\u8a0a\u606f\u3002\n        debug         : true\n        # \u662f\u5426\u50c5\u5141\u8a31\u55ae\u500b\u624b\u98a8\u7434\u53ea\u6709\u4e00\u500b\u5206\u9801\u80fd\u88ab\u6253\u958b\u3002\n        exclusive     : true\n        # \u5c55\u958b\u7684\u624b\u98a8\u7434\u662f\u5426\u53ef\u4ee5\u88ab\u95dc\u9589\u3002\n        collapsible   : true\n        # \u7576\u624b\u98a8\u7434\u88ab\u95dc\u9589\u6642\uff0c\u662f\u5426\u4e00\u540c\u9589\u5408\u5b50\u624b\u98a8\u7434\u3002\n        closeNested   : true\n\n\u56de\u547c\n---------------\n\n    Callbacks =\n        # \u7576\u624b\u98a8\u7434\u6b63\u5728\u5c55\u958b\u6642\u6240\u6703\u547c\u53eb\u7684\u51fd\u5f0f\u3002\n        onOpening     : =>\n        # \u7576\u624b\u98a8\u7434\u5c55\u958b\u6642\u6240\u6703\u547c\u53eb\u7684\u51fd\u5f0f\u3002\n        onOpen        : =>\n        # \u7576\u624b\u98a8\u7434\u6b63\u5728\u95dc\u9589\u6642\u6240\u6703\u547c\u53eb\u7684\u51fd\u5f0f\u3002\n        onClosing     : =>\n        # \u7576\u624b\u98a8\u7434\u95dc\u9589\u6642\u6240\u6703\u547c\u53eb\u7684\u51fd\u5f0f\u3002\n        onClose       : =>\n        # \u7576\u624b\u98a8\u7434\u88ab\u5207\u63db\u958b\u95dc\u6642\u6240\u6703\u547c\u53eb\u7684\u51fd\u5f0f\u3002\n        onChange      : =>\n\n\u5167\u90e8\u8cc7\u6599\n---------------\n\n    Data =\n        items: []\n\n\u6a21\u677f\n---------------\n\n    Template = \"\"\"\n    <div class=\"ts accordion\">\n        <template v-for=\"(item, index) in items\">\n            <div :key=\"'title-${index}'\" class=\"title\" :class=\"{'active': item.visible}\" @click=\"toggle(index)\">\n                <i class=\"dropdown icon\"><\/i>\n                {{ item.title }}\n            <\/div>\n            <div :key=\"'content-${index}'\" class=\"content\" :class=\"{'active': item.visible}\">\n                {{ item.content }}\n            <\/div>\n        <\/template>\n    <\/div>\n    \"\"\"\n\n\u5c0d\u5916\u65b9\u6cd5\n---------------\n\n    ExportedMethods =\n        # open \u6703\u6253\u958b\u6307\u5b9a\u7684\u624b\u98a8\u7434\u3002\n        open: (index) ->\n            @open index\n\n        # close \u6703\u95dc\u9589\u6307\u5b9a\u7684\u624b\u98a8\u7434\u3002\n        close: (index) ->\n            @close index\n\n        # closeOthers \u6703\u95dc\u9589\u6307\u5b9a\u624b\u98a8\u7434\u4ee5\u5916\u7684\u5176\u4ed6\u624b\u98a8\u7434\u3002\n        closeOthers: (index) ->\n            for item, i in @$data.items\n                if index isnt i\n                    item.visible = false\n\n\u5167\u5efa\u65b9\u6cd5\n---------------\n\n    Methods =\n        # toggle \u80fd\u5920\u5207\u63db\u4e00\u500b\u624b\u98a8\u7434\uff0c\u5982\u679c\u624b\u98a8\u7434\u662f\u958b\u7684\u5247\u9589\u5408\uff0c\u53cd\u4e4b\u4ea6\u7136\u3002\n        toggle: (index) ->\n            @$data.items[index].visible = !@$data[index].visible\n\n        # open \u80fd\u5920\u6253\u958b\u4e00\u500b\u624b\u98a8\u7434\u3002\n        open : (index) ->\n            @$data.items[index].visible = yes\n\n        # close \u80fd\u5920\u95dc\u9589\u4e00\u500b\u624b\u98a8\u7434\u3002\n        close: (index) ->\n            @$data.items[index].visible = no\n\n\u521d\u59cb\u5668\n---------------\n\n    Initializer = (Data) ->\n        ts(@).find(':scope > .title').each (element) =>\n            Data.items.push\n                title  : ts(element).html()\n                content: ts(element).next().html()\n                visible: false\n\n\u8a3b\u518a\n---------------\n\n    ts.register {\n        Name,\n        Settings,\n        Data,\n        Template,\n        ExportedMethods,\n        Methods,\n        Initializer\n    }","old_contents":"\u624b\u98a8\u7434\n======\n\n\u624b\u98a8\u7434\u80fd\u5920\u958b\u95dc\u9589\u5408\u5176\u9762\u677f\u3002\n\n    Name = 'Accordion'\n\n\u8a2d\u5b9a\n---------------\n\n    Settings =\n        # \u6d88\u97f3\u6240\u6709\u63d0\u793a\uff0c\u751a\u81f3\u662f\u932f\u8aa4\u8a0a\u606f\u3002\n        silent        : false\n        # \u986f\u793a\u9664\u932f\u8a0a\u606f\u3002\n        debug         : true\n        # \u662f\u5426\u50c5\u5141\u8a31\u55ae\u500b\u624b\u98a8\u7434\u53ea\u6709\u4e00\u500b\u5206\u9801\u80fd\u88ab\u6253\u958b\u3002\n        exclusive     : true\n        # \u5c55\u958b\u7684\u624b\u98a8\u7434\u662f\u5426\u53ef\u4ee5\u88ab\u95dc\u9589\u3002\n        collapsible   : true\n        # \u7576\u624b\u98a8\u7434\u88ab\u95dc\u9589\u6642\uff0c\u662f\u5426\u4e00\u540c\u9589\u5408\u5b50\u624b\u98a8\u7434\u3002\n        closeNested   : true\n\n\u56de\u547c\n---------------\n\n    Callbacks =\n        # \u7576\u624b\u98a8\u7434\u6b63\u5728\u5c55\u958b\u6642\u6240\u6703\u547c\u53eb\u7684\u51fd\u5f0f\u3002\n        onOpening     : =>\n        # \u7576\u624b\u98a8\u7434\u5c55\u958b\u6642\u6240\u6703\u547c\u53eb\u7684\u51fd\u5f0f\u3002\n        onOpen        : =>\n        # \u7576\u624b\u98a8\u7434\u6b63\u5728\u95dc\u9589\u6642\u6240\u6703\u547c\u53eb\u7684\u51fd\u5f0f\u3002\n        onClosing     : =>\n        # \u7576\u624b\u98a8\u7434\u95dc\u9589\u6642\u6240\u6703\u547c\u53eb\u7684\u51fd\u5f0f\u3002\n        onClose       : =>\n        # \u7576\u624b\u98a8\u7434\u88ab\u5207\u63db\u958b\u95dc\u6642\u6240\u6703\u547c\u53eb\u7684\u51fd\u5f0f\u3002\n        onChange      : =>\n\n\u5167\u90e8\u8cc7\u6599\n---------------\n\n    Data = {}\n\n\u6a21\u677f\n---------------\n\n    Template = \"\"\"\n    <div class=\"ts accordion\">\n        <template v-for=\"(item, index) in items\">\n            <div :key=\"'title-${index}'\" class=\"title\" :class=\"{'active': item.visible}\" @click=\"toggle(index)\">\n                <i class=\"dropdown icon\"><\/i>\n                {{ item.title }}\n            <\/div>\n            <div :key=\"'content-${index}'\" class=\"content\" :class=\"{'active': item.visible}\">\n                {{ item.content }}\n            <\/div>\n        <\/template>\n    <\/div>\n    \"\"\"\n\n\u5c0d\u5916\u65b9\u6cd5\n---------------\n\n    ExportedMethods =\n        # open \u6703\u6253\u958b\u6307\u5b9a\u7684\u624b\u98a8\u7434\u3002\n        open: (index) =>\n\n        # close \u6703\u95dc\u9589\u6307\u5b9a\u7684\u624b\u98a8\u7434\u3002\n        close: (index) =>\n\n        # closeOthers \u6703\u95dc\u9589\u6307\u5b9a\u624b\u98a8\u7434\u4ee5\u5916\u7684\u5176\u4ed6\u624b\u98a8\u7434\u3002\n        closeOthers: (index) =>\n\n\n\u5167\u5efa\u65b9\u6cd5\n---------------\n\n    Methods =\n        # toggle \u80fd\u5920\u5207\u63db\u4e00\u500b\u624b\u98a8\u7434\uff0c\u5982\u679c\u624b\u98a8\u7434\u662f\u958b\u7684\u5247\u9589\u5408\uff0c\u53cd\u4e4b\u4ea6\u7136\u3002\n        toggle: (index) ->\n            @$data[index].visible = !@$data[index].visible\n\n        # open \u80fd\u5920\u6253\u958b\u4e00\u500b\u624b\u98a8\u7434\u3002\n        open : (index) ->\n            @$data[index].visible = yes\n\n        # close \u80fd\u5920\u95dc\u9589\u4e00\u500b\u624b\u98a8\u7434\u3002\n        close: (index) ->\n            @$data[index].visible = no\n\n\u521d\u59cb\u5668\n---------------\n\n    Initializer = ->\n        data = []\n        ts(@).find(':scope > .title').each (element) =>\n            data.push\n                title  : ts(element).html()\n                content: ts(element).next().html()\n                visible: false\n\n\u8a3b\u518a\n---------------\n\n    ts.register {\n        Name,\n        Settings,\n        Data,\n        Template,\n        ExportedMethods,\n        Methods,\n        Initializer\n    }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d56bb0d998fbeebc3584023d14fe977f24da7b8e","subject":"Added functions to the matrix module for transforming vectors and getting vectors from a matrix.","message":"Added functions to the matrix module for transforming vectors and getting\nvectors from a matrix.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator","old_file":"src\/matrix.litcoffee","new_file":"src\/matrix.litcoffee","new_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    vectorTemp = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            module.exports.multiply output, temp3, output\n            return\n\n    vector = require \".\/vector.litcoffee\"\n            \n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\nGiven a vector specifying a translation and a matrix to translate, calling the \n\"translate\" property applies that translation to that matrix.\n            \n        translate: (vector, output) ->\n            output[3] += vector[0]\n            output[7] += vector[1]\n            output[11] += vector[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \nGiven a matrix, input vector and output vector, calling the \"applyToVector\"\nproperty writes the input vector transformed by the matrix to the output vector.\n        \n        applyToVector: (matrix, input, output) ->\n            vector.copy input, vectorTemp\n            output[0] = vectorTemp[0] * matrix[0] + vectorTemp[1] * matrix[1] + vectorTemp[2] * matrix[2] + matrix[3]\n            output[1] = vectorTemp[0] * matrix[4] + vectorTemp[1] * matrix[5] + vectorTemp[2] * matrix[6] + matrix[7]\n            output[2] = vectorTemp[0] * matrix[8] + vectorTemp[1] * matrix[9] + vectorTemp[2] * matrix[10] + matrix[11]\n            return\n            \nGiven a matrix and output vector, calling the \"getTranslation\" property writes\nthe translation applied by the matrix to the output vector.\n\n        getTranslation: (matrix, output) ->\n            output[0] = matrix[12]\n            output[1] = matrix[13]\n            output[2] = matrix[14]\n\nGiven a matrix and output vector, calling the \"getX\" property writes the vector\nof the matrix's X axis (a scaled normal) to the output vector.\n\n        getX: (matrix, output) ->\n            output[0] = matrix[0]\n            output[1] = matrix[4]\n            output[2] = matrix[8]\n\nGiven a matrix and output vector, calling the \"getY\" property writes the vector\nof the matrix's Y axis (a scaled normal) to the output vector.\n\n        getY: (matrix, output) ->\n            output[0] = matrix[1]\n            output[1] = matrix[5]\n            output[2] = matrix[9]\n            \nGiven a matrix and output vector, calling the \"getZ\" property writes the vector\nof the matrix's Z axis (a scaled normal) to the output vector.\n\n        getZ: (matrix, output) ->\n            output[0] = matrix[2]\n            output[1] = matrix[6]\n            output[2] = matrix[10]\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","old_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            module.exports.multiply output, temp3, output\n            return\n\n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\nGiven a vector specifying a translation and a matrix to translate, calling the \n\"translate\" property applies that translation to that matrix.\n            \n        translate: (vector, output) ->\n            output[3] += vector[0]\n            output[7] += vector[1]\n            output[11] += vector[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b71bc30d5f91c16077935591f6316db263505245","subject":"Remove debugging from the league module","message":"Remove debugging from the league module\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/league.litcoffee","new_file":"src\/coffee\/league.litcoffee","new_contents":"League Status\n=============\n\nThe league status is a function of the completed matches. Completed\nmatches are themselves a function of a match schedule -- specifically,\na filter on those with defined outcomes (scores).\n\n    completedMatches =\n        Data.matchSchedule.map (matches) ->\n            _.filter matches, (match) ->\n                match.scores?\n\n    completedMatches = completedMatches.toProperty []\n\nIt is also useful to have a common source combining the completed\nmatches and the team roster.\n\n    dataSource =\n        Bacon.combineTemplate\n            matches: completedMatches\n            teams: Data.teams\n\nWe publicise two properties under the *League* object - the\n*leaderboard* and the *scores*.\n\nScores\n------\n\nThe scores are a map from team IDs to their current league scores\n- naturally, a map over the common data source.\n\nFirst, we define the *teamScore* function, taking the list of\ncompleted matches and a team as arguments.\n\n    teamScore = (matches, team) ->\n\nWe first match scores to the score gained by this team from each\nmatch.\n\n        scores = (for match in matches\n            if team not in match.teams\n                0\n            else\n                match.scores[_.indexOf(match.teams, team)])\n\nThe total score is then simply a summation reduction over the\nindividual match scores.\n\n        _.reduce scores, ( (a, b) -> a + b ), 0\n\nThe actual scores property makes use of the *teamScore* function,\nlooping over it for each present team.\n\n    scores = dataSource.map (data) ->\n        teams = (team for team, settings of data.teams when settings.present)\n        _.object ([team, teamScore(data.matches, team)] for team in teams)\n\nFinally the scores property is changed to avoid duplicates.\n\n    scores = scores.skipDuplicates()\n\nLeaderboard\n-----------\n\nThe *leaderboard* is a list of entries, each of which contains:\n\n* A team TLA,\n* Its position on the leaderboard,\n* Its score.\n\nIt is defined as a map over the scores.\n\n    leaderboard = scores.map (teamScores) ->\n\nWe first take the team scores as [team, score] pairs, grouped by\nscore.\n\n        _.chain(teamScores)\n         .pairs()\n         .groupBy( (x) -> x[1] )\n         .pairs()\n\nWe then sort by score high to low and run a second simple grouping\npass -- yielding a list of [score, [team]] entries.\n\n         .sortBy( (x) -> -x[0] )\n         .map( (x) -> [x[0], _.map(x[1], (x) -> x[0])] )\n\nWe then run a reduction to assign leaderboard numbers.\n\n         .reduce( ( (a, b) ->\n             a.concat([1 + a.length, x, b[0]] for x in b[1]) ), [] )\n\nFinally, a map pass converts to the desired output format.\n\n         .map( (x) ->\n            [position, team, score] = x\n            {position: position, team: team, score: score} )\n         .value()\n\nThe leaderboard is then filtered to remove duplicates.\n\n    leaderboard = leaderboard.skipDuplicates()\n\nPublic Properties\n-----------------\n\nWe publicise both the score table and the leaderboard.\n\n    window.League =\n        scores: scores\n        leaderboard: leaderboard\n\n","old_contents":"League Status\n=============\n\nThe league status is a function of the completed matches. Completed\nmatches are themselves a function of a match schedule -- specifically,\na filter on those with defined outcomes (scores).\n\n    completedMatches =\n        Data.matchSchedule.map (matches) ->\n            _.filter matches, (match) ->\n                match.scores?\n\n    completedMatches = completedMatches.toProperty []\n\nIt is also useful to have a common source combining the completed\nmatches and the team roster.\n\n    dataSource =\n        Bacon.combineTemplate\n            matches: completedMatches\n            teams: Data.teams\n\nWe publicise two properties under the *League* object - the\n*leaderboard* and the *scores*.\n\nScores\n------\n\nThe scores are a map from team IDs to their current league scores\n- naturally, a map over the common data source.\n\nFirst, we define the *teamScore* function, taking the list of\ncompleted matches and a team as arguments.\n\n    teamScore = (matches, team) ->\n\nWe first match scores to the score gained by this team from each\nmatch.\n\n        scores = (for match in matches\n            if team not in match.teams\n                0\n            else\n                match.scores[_.indexOf(match.teams, team)])\n\nThe total score is then simply a summation reduction over the\nindividual match scores.\n\n        _.reduce scores, ( (a, b) -> a + b ), 0\n\nThe actual scores property makes use of the *teamScore* function,\nlooping over it for each present team.\n\n    scores = dataSource.map (data) ->\n        teams = (team for team, settings of data.teams when settings.present)\n        _.object ([team, teamScore(data.matches, team)] for team in teams)\n\nFinally the scores property is changed to avoid duplicates.\n\n    scores = scores.skipDuplicates()\n\nLeaderboard\n-----------\n\nThe *leaderboard* is a list of entries, each of which contains:\n\n* A team TLA,\n* Its position on the leaderboard,\n* Its score.\n\nIt is defined as a map over the scores.\n\n    leaderboard = scores.map (teamScores) ->\n\nWe first take the team scores as [team, score] pairs, grouped by\nscore.\n\n        _.chain(teamScores)\n         .pairs()\n         .groupBy( (x) -> x[1] )\n         .pairs()\n\nWe then sort by score high to low and run a second simple grouping\npass -- yielding a list of [score, [team]] entries.\n\n         .sortBy( (x) -> -x[0] )\n         .map( (x) -> [x[0], _.map(x[1], (x) -> x[0])] )\n\nWe then run a reduction to assign leaderboard numbers.\n\n         .reduce( ( (a, b) ->\n             a.concat([1 + a.length, x, b[0]] for x in b[1]) ), [] )\n\nFinally, a map pass converts to the desired output format.\n\n         .map( (x) ->\n            [position, team, score] = x\n            {position: position, team: team, score: score} )\n         .value()\n\nThe leaderboard is then filtered to remove duplicates.\n\n    leaderboard = leaderboard.skipDuplicates()\n\nDebugging\n---------\n\nWe debug changes to both scores and leaderboard.\n\n    completedMatches.onValue (x) ->\n        console.log \"Matches done\", x\n    dataSource.onValue (x) ->\n        console.log \"LS source\", x\n    leaderboard.onValue (x) ->\n        console.log \"Leaderboard\", x\n    scores.onValue (x) ->\n        console.log \"Scores\", x\n\nPublic Properties\n-----------------\n\nWe publicise both the score table and the leaderboard.\n\n    window.League =\n        scores: scores\n        leaderboard: leaderboard\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"de2740ba10b3feeacb407dbec2fca72edc44fc91","subject":"Beauty","message":"Beauty\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"client\/app.litcoffee","new_file":"client\/app.litcoffee","new_contents":"\n# Application entry point.\n\nTop-level module.\n\n    angular.module 'shrub', ['shrub.core']\n\nInclude core Angular dependencies.\n\n    coreDependencies = []\n    coreDependencies.push 'ngRoute'\n    coreDependencies.push 'ngSanitize'\n\n`packageDependencies` will be automatically generated and populated by Grunt.\nPackages implement the hook `angularPackageDependencies` to specify their\n3rd-party module dependencies.\n\n###### TODO: Link this to where this happens in Grunt for illustration.\n\n    coreDependencies.push packageDependencies...\n\nInclude core shrub dependencies.\n\n    coreDependencies.push 'shrub.config'\n    coreDependencies.push 'shrub.packages'\n    coreDependencies.push 'shrub.require'\n\nDefine the core Shrub module.\n\n    angular.module('shrub.core', coreDependencies)\n\n      .config([\n        '$injector', 'shrub-pkgmanProvider'\n        ({invoke}, {invokeFlat}) ->\n\n#### Invoke hook `appConfig`.\n\nInvoked when the Angular application is in the configuration phase.\nImplementations should return an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          invoke injectable for injectable in invokeFlat 'appConfig'\n\n      ])\n\n      .run([\n\n        '$injector', 'shrub-pkgman'\n        ({invoke}, {invokeFlat}) ->\n\n#### Invoke hook `appRun`.\n\nInvoked when the Angular application is the run phase. Implementations should\nreturn an\n[annotated function](http:\/\/docs.angularjs.org\/guide\/di#dependency-annotation).\n\n          invoke injectable for injectable in invokeFlat 'appRun'\n\n      ])\n","old_contents":"\n# Application entry point.\n\nTop-level module.\n\n    angular.module 'shrub', ['shrub.core']\n\nInclude core Angular dependencies.\n\n    coreDependencies = []\n    coreDependencies.push 'ngRoute'\n    coreDependencies.push 'ngSanitize'\n\n`packageDependencies` will be automatically generated and populated by Grunt.\nPackages implement the hook `angularPackageDependencies` to specify their\n3rd-party module dependencies.\n\n###### TODO: Link this to where this happens in Grunt for illustration.\n\n    coreDependencies.push packageDependencies...\n\nInclude core shrub dependencies.\n\n    coreDependencies.push 'shrub.config'\n    coreDependencies.push 'shrub.packages'\n    coreDependencies.push 'shrub.require'\n\nDefine the core Shrub module.\n\n    angular.module('shrub.core', coreDependencies)\n\n      .config([\n        '$injector', 'shrub-pkgmanProvider'\n        ({invoke}, {invokeFlat}) ->\n\n#### Invoke hook `appConfig`.\n\nInvoked when the Angular application is in the configuration phase.\n\n          invoke injectable for injectable in invokeFlat 'appConfig'\n\n      ])\n\n      .run([\n\n        '$injector', 'shrub-pkgman'\n        ({invoke}, {invokeFlat}) ->\n\n#### Invoke hook `appRun`.\n\nInvoked when the Angular application is the run phase. This is where things\nbegin to get interesting. :)\n\n          invoke injectable for injectable in invokeFlat 'appRun'\n\n      ])\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"00799da124eeda311609b9f94734f7d5ed6a4932","subject":"improve support for local caching to local storage and subsequent delta updates","message":"improve support for local caching to local storage and subsequent delta updates\n","repos":"Custom-Elements\/glg-hummingbird","old_file":"src\/glg-hummingbird.litcoffee","new_file":"src\/glg-hummingbird.litcoffee","new_contents":"# glg-hummingbird\nPolymer element to maintain a hummingbird typeahead index that persists between browser restarts.\n\n    hummingbird = require 'hummingbird'\n    # shim for chrome file system access\n    window.requestFileSystem = window.requestFileSystem ? window.webkitRequestFileSystem\n\n    Polymer 'glg-hummingbird',\n\n## Events\n### hb-results\nThis event is emitted when there are new hummingbird results returned where the payload is the results array.\n\n### no-hb-index\nThis event is emitted when attempting to load a non-existent hummingbird index from persistence or when\nit found an index file but was unable to load it into hummingbird.\n\n### hb-fs-error\nThis event is emitted when there is an error interacting with the file system where the payload is the error object.\n\n### hb-loaded\nThis event is emitted after a persisted index is finished loading.\n\n### hb-purged\nThis event is emitted after a persisted index is successfully deleted from local storage and memory.\n\n## Methods\n### search\nMethod for retrieving results from a humminbird index\n* query (required) - a string to be tokenized and searched\n\n      search: (query) ->\n        hbOptions =\n          scoreThreshold: @scoreThreshold ? 0\n          secondarySortField: @secondarySortField\n          secondarySortOrder: @secondarySortOrder\n          howMany: @howMany ? 10\n          startPos: @startPos ? 0\n\n        #lookup by fuzzy name match\n        @idx.search query, (results) =>\n          @fire 'hb-results', results\n        , hbOptions\n\n### jump\nMethod for retrieving a single result from a hummingbird index by ID\n* id (required) - the ID of the document to be returned\n\n      jump: (id) ->\n        #lookup by ID\n        @idx.jump id, (results) =>\n          @fire 'hb-results', results\n\n### upsert\nMethod to insert new entries into the index or update existing entries\n\n      upsert: (doc) ->\n        unless doc?.name? and doc?.id?\n          console.error \"glg-hb: every hummingbird document must have a minimum of 'name' and 'id' properties\"\n        else\n          @idx.add doc\n\n### bulkLoad\nMethod to insert new entries into the index or update existing entries\n\n      bulkLoad: (docs) ->\n        (@upsert doc for doc in docs)\n\n### numItems\nMethod to insert new entries into the index or update existing entries\n\n      numItems: () ->\n        Object.keys(@idx?.metaStore?.root).length\n\n\n### persist\nMethod to persist hummingbird index to localStorage\n\n      persist: () ->\n        window.requestFileSystem window.TEMPORARY, null\n        , (fs) =>\n          # success handler\n          fs.root.getFile @indexName, {create: true}, (fileEntry) =>\n            fileEntry.createWriter (fileWriter) =>\n              fileWriter.onerror = @__fileErrorHandler(@indexName)\n              fileWriter.onabort = () => console.debug \"#{@indexName} write aborted\"\n              fileWriter.onprogress = () => console.debug \"#{@indexName} write progress\"\n              fileWriter.onwritestart = () => console.debug \"#{@indexName} write started\"\n              fileWriter.onwrite = () => console.debug \"#{@indexName} writing\"\n              fileWriter.onwriteend = (evt) =>\n                console.debug \"Successfully persisted #{@indexName}\"\n                return\n              try\n                idxJson = @idx.toJSON()\n                idxJsonStr = JSON.stringify(idxJson)\n                fileWriter.write new Blob([idxJsonStr], {type: 'text\/plain'})\n              catch err\n                console.error \"glg-hb: unable to persist #{@indexName} index: #{JSON.stringify err}\"\n            , @__fileErrorHandler(@indexName)\n          , @__fileErrorHandler(@indexName)\n        , @__fileErrorHandler(@indexName)\n\n\n### purge\nMethod to delete persisted file from disk\n\n      purge: () ->\n        window.requestFileSystem window.TEMPORARY, null\n        , (fs) =>\n          # success handler\n          fs.root.getFile @indexName, { create: false }, (fileEntry) =>\n            fileEntry.remove =>\n              console.debug \"glg-hb: purged persisted #{@indexName} index.\"\n              @idx = new hummingbird()\n              @fire 'hb-purged', @indexName\n            , @__fileErrorHandler(@indexName)\n          , @__fileErrorHandler(@indexName)\n        , @__fileErrorHandler(@indexName)\n\n### getCreateTime\nMethod that returns the timestamp for the index creation (not persist or load).\nIt has become the norm to incrementally add new documents to a hummingbird index, but not remove 'deleted' or obsolete documents.\nGiven that convention, this method enables the consuming application to determine whether the persisted index is 'old' and\nshould be purged from local storage and fully rebuilt from scratch to take into account documents that should no longer be in the index.\n\n      getCreateTime: () ->\n        @idx.createTime\n\n### getLastUpdateTime\nMethod that returns the timestamp for the last time the index was updated (including create, add, or remove, but not persist or load)\n\n      getLastUpdateTime: () ->\n        @idx.lastUpdate\n\n### __fileErrorHandler\nInternal method to handle various filesystem errors\n\n      __fileErrorHandler: (indexName) ->\n        #closure to maintain reference to Polymer object in scope\n        (err) =>\n          if err.name is \"NotFoundError\"\n            console.debug \"glg-hb: #{indexName} - #{err.name}: #{err.message}\"\n            @fire 'no-hb-index', @indexName\n          else\n            console.error \"glg-hb: #{indexName} - #{err.name}: #{err.message}\"\n            err.message = \"#{@indexName}: #{err.message}\"\n            @fire 'hb-fs-error', err\n\n## Polymer Lifecycle\nOn element creation, load the named index if it exists and make it immediately available for use.\n\n      created: ->\n        # create an empty index\n        @idx = new hummingbird()\n        window.requestFileSystem window.TEMPORARY, null\n        , (fs) =>\n          # success handler\n          fs.root.getFile @indexName, {}, (fileEntry) =>\n            fileEntry.file (file) =>\n              reader = new FileReader()\n              reader.onerror = @__fileErrorHandler(@indexName)\n              reader.onloadend = (evt) ->\n                # @result is the text of the file read\n                if @result? and @result isnt ''\n                  try\n                    # if we found a persisted index, replace our empty index with it\n                    console.debug \"glg-hb: loading index #{_this.indexName} from localStorage\"\n                    _this.idx = hummingbird.Index.load JSON.parse(@result)\n                    _this.fire 'hb-loaded', _this.indexName\n                  catch err\n                    console.error \"glg-hb: unable to load persisted #{_this.indexName} index: #{JSON.stringify err}\"\n                    _this.fire 'no-hb-index', _this.indexName\n                else\n                  console.warn \"glg-hb: found an empty file when trying to load persisted #{_this.indexName} index.\"\n                  _this.fire 'no-hb-index', _this.indexName\n              reader.readAsText file\n            , @__fileErrorHandler(@indexName)\n          , @__fileErrorHandler(@indexName)\n        , @__fileErrorHandler(@indexName)\n\n      ready: ->\n\n      attached: ->\n\n      domReady: ->\n\n      detached: ->\n","old_contents":"# glg-hummingbird\nPolymer element to maintain a hummingbird typeahead index that persists between browser restarts.\n\n    hummingbird = require 'hummingbird'\n    # shim for chrome file system access\n    window.requestFileSystem = window.requestFileSystem ? window.webkitRequestFileSystem\n\n    Polymer 'glg-hummingbird',\n\n## Events\n### HB_RESULTS\nThis event is emitted when there are new hummingbird results returned where the payload is the results array.\n\n### NO_HB_INDEX\nThis event is emitted when attempting to load a non-existent hummingbird index from persistence.\n\n### FS_ERROR\nThis event is emitted when there is an error interacting with the file system where the payload is the error object.\n\n## Methods\n### search\nMethod for retrieving results from a humminbird index\n* query (required) - a string to be tokenized and searched\n\n      search: (query) ->\n        hbOptions =\n          scoreThreshold: @scoreThreshold ? 0\n          secondarySortField: @secondarySortField\n          secondarySortOrder: @secondarySortOrder\n          howMany: @howMany ? 10\n          startPos: @startPos ? 0\n\n        #lookup by fuzzy name match\n        @idx.search query, (results) =>\n          @fire 'HB_RESULTS', results\n        , hbOptions\n\n### jump\nMethod for retrieving a single result from a hummingbird index by ID\n* id (required) - the ID of the document to be returned\n\n      jump: (id) ->\n        #lookup by ID\n        @idx.jump id, (results) =>\n          @fire 'HB_RESULTS', results\n\n### upsert\nMethod to insert new entries into the index or update existing entries\n\n      upsert: (doc) ->\n        unless doc?.name? and doc?.id?\n          console.error \"glg-hb: every hummingbird document must have a minimum of 'name' and 'id' properties\"\n        else\n          @idx.add doc\n\n### bulkLoad\nMethod to insert new entries into the index or update existing entries\n\n      bulkLoad: (docs) ->\n        (@upsert doc for doc in docs)\n\n### persist\nMethod to persist hummingbird index to localStorage\n\n      persist: () ->\n        window.requestFileSystem window.TEMPORARY, null\n        , (fs) =>\n          # success handler\n          fs.root.getFile @indexName, {create: true}, (fileEntry) =>\n            fileEntry.createWriter (fileWriter) =>\n              fileWriter.onerror = @__fileErrorHandler()\n              fileWriter.onwriteend = (evt) ->\n                # Do we care to share success?\n                return\n              try\n                fileWriter.write new Blob([JSON.stringify(@idx.toJSON())], {type: 'text\/plain'})\n              catch err\n                console.error \"glg-hb: unable to persist #{@indexName} index: #{JSON.stringify err}\"\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n\n### purge\nMethod to delete persisted file from disk\n\n      purge: () ->\n        window.requestFileSystem window.TEMPORARY, null, (fs) =>\n          fs.root.getFile @indexName, { create: false }, (fileEntry) =>\n            fileEntry.remove =>\n              console.log \"glg-hb: purged persisted #{@indexName} index.\"\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n### getCreateTime\nMethod that returns the timestamp for the index creation (not persist or load).\nIt has become the norm to incrementally add new documents to a hummingbird index, but not remove 'deleted' or obsolete documents.\nGiven that convention, this method enables the consuming application to determine whether the persisted index is 'old' and\nshould be purged from local storage and fully rebuilt from scratch to take into account documents that should no longer be in the index.\n\n      getCreateTime: () ->\n        @idx.createTime\n\n### getLastUpdateTime\nMethod that returns the timestamp for the last time the index was updated (including create, add, or remove, but not persist or load)\n\n      getLastUpdateTime: () ->\n        @idx.lastUpdate\n\n### __fileErrorHandler\nInternal method to handle various filesystem errors\n\n      __fileErrorHandler: () ->\n        #closure to maintain reference to Polymer object in scope\n        (err) =>\n          switch err.code\n            when FileError.QUOTA_EXCEEDED_ERR\n              console.error 'glg-hb: QUOTA_EXCEEDED_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.NOT_FOUND_ERR\n              console.debug \"glg-hb: no persisted index: #{JSON.stringify err}\"\n              @fire 'NO_HB_INDEX'\n            when FileError.SECURITY_ERR\n              console.error 'glg-hb: SECURITY_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.INVALID_MODIFICATION_ERR\n              console.error 'glg-hb: INVALID_MODIFICATION_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.INVALID_STATE_ERR\n              console.error 'glg-hb: INVALID_STATE_ERR'\n              @fire 'FS_ERROR', err\n            else\n              console.error 'glg-hb: unknown file system error'\n              @fire 'FS_ERROR', err\n\n## Polymer Lifecycle\nOn element creation, load the named index if it exists and make it immediately available for use.\n\n      created: ->\n        # create an empty index\n        @idx = new hummingbird()\n        window.requestFileSystem window.TEMPORARY, null\n        , (fs) =>\n          # success handler\n          fs.root.getFile @indexName, {}, (fileEntry) =>\n            fileEntry.file (file) =>\n              reader = new FileReader()\n              reader.onerror = @__fileErrorHandler()\n              reader.onloadend = (evt) ->\n                # @result is the text of the file read\n                if @result? and @result isnt ''\n                  try\n                    # if we found a persisted index, replace our empty index with it\n                    console.log \"glg-hb: loading index #{_this.indexName} from localStorage\"\n                    _this.idx = hummingbird.Index.load JSON.parse(@result)\n                  catch err\n                    console.error \"glg-hb: unable to load persisted #{_this.indexName} index: #{JSON.stringify err}\"\n                else\n                  console.warn \"glg-hb: found an empty file when trying to load persisted #{_this.indexName} index.\"\n                  _this.__fileErrorHandler() {code:FileError.NOT_FOUND_ERR}\n              reader.readAsText file\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n      ready: ->\n\n      attached: ->\n\n      domReady: ->\n\n      detached: ->\n","returncode":0,"stderr":"","license":"isc","lang":"Literate CoffeeScript"}
{"commit":"bbd55baf4fca80b715388cb4bb103d1765bf7a91","subject":"Fix a typo","message":"Fix a typo","repos":"monokrome\/glp","old_file":"src\/defaults.litcoffee","new_file":"src\/defaults.litcoffee","new_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How GLP configuration works\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp,watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is true by default, but can be made false if\ncaching isn't working as expected with your project.\n\n        enabled: yes\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js` or `.coffee`. After\nthey are built, the resulting files will be placed in the directory specified\nby the **root** function as separate files. If the output file was not a\n**directory** (as denoted by the ending slash) then the files would also be\nconcatenated and the resulting file would be given the *extension* which\ncorresponds to this type of file.\n\n          '\/': [\n            'src\/**\/*.js'\n            'src\/**\/*.coffee'\n          ]\n\nHere, we are doing the same thing for *html* and *jade* files, but we are\noutputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/**\/*.html'\n            'src\/**\/*.jade'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/': [\n            'src\/**\/*.css'\n            'src\/**\/*.less'\n            'src\/**\/*.sass'\n            'src\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","old_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How users configure prefer\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp,watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is true by default, but can be made false if\ncaching isn't working as expected with your project.\n\n        enabled: yes\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js` or `.coffee`. After\nthey are built, the resulting files will be placed in the directory specified\nby the **root** function as separate files. If the output file was not a\n**directory** (as denoted by the ending slash) then the files would also be\nconcatenated and the resulting file would be given the *extension* which\ncorresponds to this type of file.\n\n          '\/': [\n            'src\/**\/*.js'\n            'src\/**\/*.coffee'\n          ]\n\nHere, we are doing the same thing for *html* and *jade* files, but we are\noutputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/**\/*.html'\n            'src\/**\/*.jade'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/': [\n            'src\/**\/*.css'\n            'src\/**\/*.less'\n            'src\/**\/*.sass'\n            'src\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9e5f719513408525cf1a07ea26d55e66770e116d","subject":"Remove a stray semicolon","message":"Remove a stray semicolon\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/keyboard.litcoffee","new_file":"src\/coffee\/keyboard.litcoffee","new_contents":"Keyboard Input\n==============\n\nWe first collect an event stream of all keyboard events sent to the page.\n\n    keyboardEvents = $(document).asEventStream('keydown')\n                                .map('.keyCode')\n\nWe keep a map of keycodes to internal names.\n\n    keyMap =\n        48: 'view-0',\n        49: 'view-1',\n        50: 'view-2',\n        51: 'view-3',\n        52: 'view-4',\n        53: 'view-5',\n        54: 'view-6',\n        55: 'view-7',\n        56: 'view-8',\n        57: 'view-9',\n        75: 'kill', # k\n        84: 'load-debug', # t\n\nWe then have a stream of keyboard events coming in based on that\nmap, discarding those that are not present as well as bounces.\n\n    window.Keyboard = keyboardEvents.map( (k) -> keyMap[k] )\n                                    .filter( (x) -> x? )\n                                    .debounce(150)\n\nJudge Selection\n---------------\n\nThe keys 1-4 are used to select between display on the judge's desk.\n\nWe keep a property here to select between them.\n\n    displayMap =\n        'view-1': 'match-display'\n        'view-2': 'match-sched'\n        'view-3': 'league-state'\n        'view-4': 'knockout-state'\n        'view-5': 'next-match'\n        'view-6': 'day-sched'\n\n    window.JudgeSelection = window.Keyboard.map( (k) -> displayMap[k] )\n                                           .filter( (x) -> x? )\n                                           .toProperty('match-display')\n                                           .skipDuplicates()\n\n","old_contents":"Keyboard Input\n==============\n\nWe first collect an event stream of all keyboard events sent to the page.\n\n    keyboardEvents = $(document).asEventStream('keydown')\n                                .map('.keyCode')\n\nWe keep a map of keycodes to internal names.\n\n    keyMap =\n        48: 'view-0',\n        49: 'view-1',\n        50: 'view-2',\n        51: 'view-3',\n        52: 'view-4',\n        53: 'view-5',\n        54: 'view-6',\n        55: 'view-7',\n        56: 'view-8',\n        57: 'view-9',\n        75: 'kill', # k\n        84: 'load-debug', # t\n\nWe then have a stream of keyboard events coming in based on that\nmap, discarding those that are not present as well as bounces.\n\n    window.Keyboard = keyboardEvents.map( (k) -> keyMap[k] )\n                                    .filter( (x) -> x? )\n                                    .debounce(150)\n\nJudge Selection\n---------------\n\nThe keys 1-4 are used to select between display on the judge's desk.\n\nWe keep a property here to select between them.\n\n    displayMap =\n        'view-1': 'match-display'\n        'view-2': 'match-sched'\n        'view-3': 'league-state'\n        'view-4': 'knockout-state'\n        'view-5': 'next-match'\n        'view-6': 'day-sched'\n\n    window.JudgeSelection = window.Keyboard.map( (k) -> displayMap[k] )\n                                           .filter( (x) -> x? )\n                                           .toProperty('match-display')\n                                           .skipDuplicates();\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8e2bc795df1ce78992356e38d30c15abff2e5d5f","subject":"chore(server): move configuration above other routes","message":"chore(server): move configuration above other routes\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    require 'newrelic' if process.env.NODE_ENV is 'production'\n\n    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n    compression = require 'compression'\n    bodyParser  = require 'body-parser'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Configuration\n\n    app.use compression()\n    app.use bodyParser.json extended: true, limit: '10mb'\n    app.disable('x-powered-by')\n    app.disable('etag')\n    app.set 'port', process.env.APP_PORT or 8080\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/favicon\n\n    app.get '\/favicon.ico', (req, res) ->\n      res.set 'Content-Type': 'image\/x-icon'\n      res.status(200).end()\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.status(405).json message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.status(405).json message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## 404 handling\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.status(404).json message: \"Resurs ikke funnet\"\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.user.tilbyder}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n","old_contents":"    require 'newrelic' if process.env.NODE_ENV is 'production'\n\n    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n    compression = require 'compression'\n    bodyParser  = require 'body-parser'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(compression())\n    app.use bodyParser.json extended: true, limit: '10mb'\n    app.disable('x-powered-by')\n    app.disable('etag')\n    app.set 'port', process.env.APP_PORT or 8080\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/favicon\n\n    app.get '\/favicon.ico', (req, res) ->\n      res.set 'Content-Type': 'image\/x-icon'\n      res.status(200).end()\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.status(405).json message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.status(405).json message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## 404 handling\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.status(404).json message: \"Resurs ikke funnet\"\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.user.tilbyder}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"eb5303a58652e1413b4488ab4dbd3f1bbe747e41","subject":"Literate CofeeScript underway","message":"Literate CofeeScript underway\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\n  F.succeed = (result) -> [result]\n  F.fail = _.always []\n\n  disjunction = (l, r) ->\n    (x) -> _.cat(l(x), r(x))\n  conjunction = (l, r) ->\n    (x) -> _.mapcat(l(x), r)\n\n  F.disj = () ->\n    return F.fail if _.isEmpty(arguments)\n    disjunction(_.first(arguments), F.disj.apply(this, _.rest(arguments)))\n\n  F.conj = () ->\n    clauses = _.toArray(arguments)\n    return F.succeed if _.isEmpty(clauses)\n    return _.first(clauses) if _.size(clauses) is 1\n    conjunction(_.first(clauses),\n                (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\n  # Knowledge representation\n  # ------------------------\n\n  class LVar\n    constructor: (@name) ->\n\n  F.lvar = (name) -> new LVar(name)\n  F.isLVar = (v) -> (v instanceof LVar)\n\n  find = (v, bindings) ->\n    lvar = bindings.lookup(v)\n    return lvar if F.isLVar(v)\n    if _.isArray(lvar)\n      if _.isEmpty(lvar)\n        return lvar\n      else\n        return _.cons(find(_.first(lvar), bindings), find(_.rest(lvar), bindings))\n    lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\n\n\n  # Non-determinism\n  # ---------------\n\n  F.succeed = (result) -> [result]\n  F.fail = _.always []\n\n  disjunction = (l, r) ->\n    (x) -> _.cat(l(x), r(x))\n  conjunction = (l, r) ->\n    (x) -> _.mapcat(l(x), r)\n\n  F.disj = () ->\n    return F.fail if _.isEmpty(arguments)\n    disjunction(_.first(arguments), F.disj.apply(this, _.rest(arguments)))\n\n  F.conj = () ->\n    clauses = _.toArray(arguments)\n    return F.succeed if _.isEmpty(clauses)\n    return _.first(clauses) if _.size(clauses) is 1\n    conjunction(_.first(clauses),\n                (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\n  # Knowledge representation\n  # ------------------------\n\n  class LVar\n    constructor: (@name) ->\n\n  F.lvar = (name) -> new LVar(name)\n  F.isLVar = (v) -> (v instanceof LVar)\n\n  find = (v, bindings) ->\n    lvar = bindings.lookup(v)\n    return lvar if F.isLVar(v)\n    if _.isArray(lvar)\n      if _.isEmpty(lvar)\n        return lvar\n      else\n        return _.cons(find(_.first(lvar), bindings), find(_.rest(lvar), bindings))\n    lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c98e7221a9c0049794dc51687117feb66c802906","subject":"remove testing stub","message":"remove testing stub\n","repos":"andychase\/date_machine,andychase\/date_machine,andychase\/date_machine,andychase\/date_machine","old_file":"date_machine\/javascript\/tests\/tests.litcoffee","new_file":"date_machine\/javascript\/tests\/tests.litcoffee","new_contents":"        fill_result = (_) ->\n          for result_set in _\n            for result in result_set\n              for key of result\n                if not result[key]?\n                  delete result[key]\n          return _\n\n\n        date_test = (test_string, answer_object...) =>\n          deepEqual fill_result(this.date_machine(test_string)), [answer_object], test_string\n\n        date_raw_test = (test_string, answer_object) =>\n          deepEqual fill_result(this.date_machine(test_string)), answer_object, test_string\n\n        test \"sanity\", ->\n          ok 1==1, \"passed!\"\n\n        test \"date tests\", =>\n\n            date_test '01\/1\/2011',\n                day: 1\n                month: 1\n                year: 2011\n\n\n            date_test 'All day Thursday-Sunday, Sept. 20-23., Friday September 21',\n                    day: 20\n                    month: 9\n                ,\n                    day: 21\n                    month: 9\n                ,\n                    day: 22\n                    month: 9\n                ,\n                    day: 23\n                    month: 9\n\n            date_test '12\/3\/2012',\n                    day: 3\n                    month: 12\n                    year: 2012\n            date_test 'Wednesday september 12',\n                    day: 12\n                    month: 9\n            date_test '10 pm, Friday September 21',\n                    day: 21\n                    month: 9\n                    hour: 22\n                    am_pm: 12\n            date_test '9:30 pm, Friday September 2',\n                    day: 2\n                    month: 9\n                    hour: 21\n                    minute: 30\n                    am_pm: 12\n            date_test '10:30 pm., Wednesday September 12',\n                    day: 12\n                    month: 9\n                    hour: 22\n                    minute: 30\n                    am_pm: 12\n            date_raw_test 'April 7 November 17',\n                [[\n                    day: 7\n                    month: 4\n                ],[\n                    day: 17\n                    month: 11\n                ]]\n            date_test 'Sat, 09\/01\/2012 - 12:00pm',\n                    day: 1\n                    month: 9\n                    year: 2012\n                    hour: 12\n                    minute: 0\n                    am_pm: 12\n            date_test '14 January 2013',\n                    day: 14\n                    month: 1\n                    year: 2013\n            date_test 'January 11',\n                    day: 11\n                    month: 1\n            date_test '7- 9 pm Wednesday, Oct. 31',\n                    month: 10\n                    day: 31\n                    hour: 19\n                    am_pm: 12\n                ,\n                    timedelta: true\n                    hours: 2\n                    minutes: 0\n                    seconds: 0\n            date_test 'Sun, 06\/16\/2013 - 6:00pm',\n                    hour: 18\n                    month: 6\n                    year: 2013\n                    day: 16\n                    minute: 0\n                    am_pm: 12\n","old_contents":"        fill_result = (_) ->\n          for result_set in _\n            for result in result_set\n              for key of result\n                if not result[key]?\n                  delete result[key]\n          return _\n\n\n        date_test = (test_string, answer_object...) =>\n          deepEqual fill_result(this.date_machine(test_string)), [answer_object], test_string\n\n        date_raw_test = (test_string, answer_object) =>\n          deepEqual fill_result(this.date_machine(test_string)), answer_object, test_string\n\n        test \"sanity\", ->\n          ok 1==1, \"passed!\"\n\n        test \"date tests\", =>\n\n            ok functions[\"time\"]\n\n\n            date_test '01\/1\/2011',\n                day: 1\n                month: 1\n                year: 2011\n\n\n            date_test 'All day Thursday-Sunday, Sept. 20-23., Friday September 21',\n                    day: 20\n                    month: 9\n                ,\n                    day: 21\n                    month: 9\n                ,\n                    day: 22\n                    month: 9\n                ,\n                    day: 23\n                    month: 9\n\n            date_test '12\/3\/2012',\n                    day: 3\n                    month: 12\n                    year: 2012\n            date_test 'Wednesday september 12',\n                    day: 12\n                    month: 9\n            date_test '10 pm, Friday September 21',\n                    day: 21\n                    month: 9\n                    hour: 22\n                    am_pm: 12\n            date_test '9:30 pm, Friday September 2',\n                    day: 2\n                    month: 9\n                    hour: 21\n                    minute: 30\n                    am_pm: 12\n            date_test '10:30 pm., Wednesday September 12',\n                    day: 12\n                    month: 9\n                    hour: 22\n                    minute: 30\n                    am_pm: 12\n            date_raw_test 'April 7 November 17',\n                [[\n                    day: 7\n                    month: 4\n                ],[\n                    day: 17\n                    month: 11\n                ]]\n            date_test 'Sat, 09\/01\/2012 - 12:00pm',\n                    day: 1\n                    month: 9\n                    year: 2012\n                    hour: 12\n                    minute: 0\n                    am_pm: 12\n            date_test '14 January 2013',\n                    day: 14\n                    month: 1\n                    year: 2013\n            date_test 'January 11',\n                    day: 11\n                    month: 1\n            date_test '7- 9 pm Wednesday, Oct. 31',\n                    month: 10\n                    day: 31\n                    hour: 19\n                    am_pm: 12\n                ,\n                    timedelta: true\n                    hours: 2\n                    minutes: 0\n                    seconds: 0\n            date_test 'Sun, 06\/16\/2013 - 6:00pm',\n                    hour: 18\n                    month: 6\n                    year: 2013\n                    day: 16\n                    minute: 0\n                    am_pm: 12\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a97c74fd15907fc89755bdab9664cd63d8a9a38f","subject":"minor bugfix on proper revert on container\/properties dealing with unintialized states","message":"minor bugfix on proper revert on container\/properties dealing with unintialized states\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    Yang     = require '.\/yang'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (spec={}) ->\n        # NOTE: ES6\/CS2 does not support below\n        # unless this instanceof Property then return new Property arguments...\n\n        # 1. parse if spec is YANG definition (string)\n        spec = Yang.parse spec if typeof spec is 'string'\n        \n        # 2. assign if spec is an instance of Yang schema\n        schema = spec if spec instanceof Yang\n        \n        # 3. destructure spec as an object if not schema as instance\n        { name, schema } = spec unless schema?\n        \n        # 4. parse if schema is YANG definition (string)\n        schema = Yang.parse schema if typeof schema is 'string'\n        schema ?= kind: 'anydata'\n\n        # 5. initialize property instance\n        @name = name ? schema.datakey\n        @schema = schema\n        @state = \n          parent:    null\n          strict:    false\n          private:   false\n          mutable:   `schema.config != false`\n          attached:  false\n          changed:   false\n          prior:     undefined\n          value:     undefined\n\n        # 6. soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'parent'\n        .access 'strict'\n        .getter 'private'\n        .getter 'mutable'\n        .getter 'attached'\n        .getter 'changed'\n        .getter 'prior'\n        .getter 'value'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'value',\n        get: -> @state.value\n\n      @property 'data',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> switch\n          when @binding?.get? then @binding.get @context\n          else @value\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @data\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.opts = {}\n          ctx.node = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor this\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      debug: -> debug @uri, arguments...\n      \n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@data`.\n\nIt also provides special handling based on different types of\n`@data` currently held.\n\n      get: (key) -> switch\n        when key?\n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].data\n            when match.length > 1  then match.map (x) -> x.data\n            else undefined\n        else @data\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        opts.origin ?= this\n        \n        # @debug \"[set] enter...\"\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n\n        if not opts.force and @binding?.set?\n          try value = @binding.set @context.with(opts), value \n          catch e\n            throw @error \"failed executing set() binding: #{e.message}\", e\n\n        return this if value? and @equals value, @value # return if same value\n        \n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        @debug \"[set] applying schema...\"        \n        value = switch\n          when @schema.apply? and not bypass\n            subopts = Object.assign {}, opts, inner: true, suppress: true\n            @schema.apply value, this, subopts\n          else value\n        @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error\n        return this if value? and @equals value, @value # return if same value\n        @update value, opts\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@value` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if value is null\n        return @set value, opts\n\n### delete\n\n      delete: (opts={}) ->\n        opts.origin ?= this\n        return this if @state.value is null\n        if not opts.force and @binding?.delete?\n          try @binding.delete @context.with(opts), null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @update null, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n        @state.prior ?= @state.value\n        @state.changed = @state.changed or (@state.value isnt value)\n        @state.value = value\n        @parent?.update this, opts # unless opts.suppress\n        return this\n\n### commit async transaction\n\nCommits the changes to the data model. Called *once* for each node that\nis part of the change branch.\n\n      commit: (opts={}) ->\n        opts.origin ?= this\n        return true unless @changed\n        try\n          unless opts.sync\n            # 1. perform save binding\n            @debug \"[commit] execute binding...\"\n            await @binding?.commit? @context.with(opts)\n            # 2. if has parent, then wait for parent commited before updating changed state\n            promise = @parent?.commit? opts\n              .then (ok) =>\n                @state.changed = false if ok\n          unless promise?\n            @state.changed = false\n        catch err\n          @debug \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          throw @error err\n        return true\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @debug \"[revert] changing back to:\", @state.prior\n        # XXX - don't need the below?\n        # @delete opts unless @state.prior?\n        @state.value = @state.prior\n\n        @debug \"[revert] execute binding...\"\n        try await @binding?.commit? @context.with(opts) unless opts.sync\n        catch err\n          @debug \"[revert] failed due to #{err.message}\"\n          throw @error err\n          \n        @state.changed = false\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        unless @attached\n          # @debug \"[attach] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n\n          @set obj[name], Object.assign {}, opts, inner: true, suppress: true\n\n        unless opts.preserve\n          try Object.defineProperty obj, @name,\n              configurable: true\n              enumerable: @enumerable\n              get: (args...) => @get args...\n              set: (args...) => @set args...\n            \n        @state.attached = true\n        @debug \"[attach] attached into #{obj.constructor.name} container\"\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @data = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx) ->\n        err = new Error err unless err instanceof Error\n        err.uri ?= @uri\n        err.src ?= this\n        err.ctx ?= ctx\n        return err\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @data\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:    @name\n          kind:    @kind\n          path:    @path.toString()\n          active:  @active\n          private: @private\n          mutable: @mutable\n          changed: @changed\n          schema: switch\n            when @schema.uri?\n              uri:      @schema.uri\n              summary:  @schema.description?.tag\n              datakey:  @schema.datakey\n              datapath: @schema.datapath\n              external: @schema.external\n              children: @schema.children.map (x) -> x.uri\n            else false\n          value: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    Yang     = require '.\/yang'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (spec={}) ->\n        # NOTE: ES6\/CS2 does not support below\n        # unless this instanceof Property then return new Property arguments...\n\n        # 1. parse if spec is YANG definition (string)\n        spec = Yang.parse spec if typeof spec is 'string'\n        \n        # 2. assign if spec is an instance of Yang schema\n        schema = spec if spec instanceof Yang\n        \n        # 3. destructure spec as an object if not schema as instance\n        { name, schema } = spec unless schema?\n        \n        # 4. parse if schema is YANG definition (string)\n        schema = Yang.parse schema if typeof schema is 'string'\n        schema ?= kind: 'anydata'\n\n        # 5. initialize property instance\n        @name = name ? schema.datakey\n        @schema = schema\n        @state = \n          parent:    null\n          strict:    false\n          private:   false\n          mutable:   `schema.config != false`\n          attached:  false\n          changed:   false\n          prior:     undefined\n          value:     undefined\n\n        # 6. soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'parent'\n        .access 'strict'\n        .getter 'private'\n        .getter 'mutable'\n        .getter 'attached'\n        .getter 'changed'\n        .getter 'prior'\n        .getter 'value'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'value',\n        get: -> @state.value\n\n      @property 'data',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> switch\n          when @binding?.get? then @binding.get @context\n          else @value\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @data\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.opts = {}\n          ctx.node = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor this\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      debug: -> debug @uri, arguments...\n      \n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@data`.\n\nIt also provides special handling based on different types of\n`@data` currently held.\n\n      get: (key) -> switch\n        when key?\n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].data\n            when match.length > 1  then match.map (x) -> x.data\n            else undefined\n        else @data\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        opts.origin ?= this\n        \n        # @debug \"[set] enter...\"\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n\n        if not opts.force and @binding?.set?\n          try value = @binding.set @context.with(opts), value \n          catch e\n            throw @error \"failed executing set() binding: #{e.message}\", e\n\n        return this if value? and @equals value, @value # return if same value\n        \n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        @debug \"[set] applying schema...\"        \n        value = switch\n          when @schema.apply? and not bypass\n            subopts = Object.assign {}, opts, inner: true, suppress: true\n            @schema.apply value, this, subopts\n          else value\n        @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error\n        return this if value? and @equals value, @value # return if same value\n        @update value, opts\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@value` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if value is null\n        return @set value, opts\n\n### delete\n\n      delete: (opts={}) ->\n        opts.origin ?= this\n        return this if @state.value is null\n        if not opts.force and @binding?.delete?\n          try @binding.delete @context.with(opts), null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @update null, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n        @state.prior ?= @state.value\n        @state.changed = @state.changed or (@state.value isnt value)\n        @state.value = value\n        @parent?.update this, opts # unless opts.suppress\n        return this\n\n### commit async transaction\n\nCommits the changes to the data model. Called *once* for each node that\nis part of the change branch.\n\n      commit: (opts={}) ->\n        opts.origin ?= this\n        return true unless @changed\n        try\n          unless opts.sync\n            # 1. perform save binding\n            @debug \"[commit] execute binding...\"\n            await @binding?.commit? @context.with(opts)\n            # 2. if has parent, then wait for parent commited before updating changed state\n            promise = @parent?.commit? opts\n              .then (ok) =>\n                @state.changed = false if ok\n          unless promise?\n            @state.changed = false\n        catch err\n          @debug \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          throw @error err\n        return true\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @delete opts unless @state.prior?\n        @state.value = @state.prior\n\n        @debug \"[revert] execute binding...\"\n        try await @binding?.commit? @context.with(opts) unless opts.sync\n        catch err\n          @debug \"[revert] failed due to #{err.message}\"\n          throw @error err\n          \n        @state.changed = false\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        unless @attached\n          # @debug \"[attach] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n\n          @set obj[name], Object.assign {}, opts, inner: true, suppress: true\n\n        unless opts.preserve\n          try Object.defineProperty obj, @name,\n              configurable: true\n              enumerable: @enumerable\n              get: (args...) => @get args...\n              set: (args...) => @set args...\n            \n        @state.attached = true\n        @debug \"[attach] attached into #{obj.constructor.name} container\"\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @data = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx) ->\n        err = new Error err unless err instanceof Error\n        err.uri ?= @uri\n        err.src ?= this\n        err.ctx ?= ctx\n        return err\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @data\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:    @name\n          kind:    @kind\n          path:    @path.toString()\n          active:  @active\n          private: @private\n          mutable: @mutable\n          changed: @changed\n          schema: switch\n            when @schema.uri?\n              uri:      @schema.uri\n              summary:  @schema.description?.tag\n              datakey:  @schema.datakey\n              datapath: @schema.datapath\n              external: @schema.external\n              children: @schema.children.map (x) -> x.uri\n            else false\n          value: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"2d21559eeee42171eb5d63561d9493b95330ebdd","subject":"Fix server if config file is missing","message":"Fix server if config file is missing\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nInitialize sane values.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\nInstance of express.\n\n\t\tapp: null\n\nInstance of http\n\n\t\tserver: null\n\nInstance of socket.io\n\n\t\tio: null\n\nStatistics for the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting nodePush'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing outbound socket'\n\nStart HTTP service.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\tlistenCallback = =>\n\nShed root privilegies.\n\n\t\t\t\tif process.getuid() is 0 or process.getgid() is 0\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\t\t\t\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.type 'text\/plain'\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\treturn unless \/[a-zA-Z0-9-_.]+$\/.test name\n\t\t\t\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\nPass data to the browsers and close connection.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nKill connection after 5 seconds.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket unless config.inbound.useTCP\n\t\t\tfs.unlinkSync config.outbound.socket unless config.outbound.useTCP\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","old_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\tconfig = require '..\/config.js'\n\nInitialize sane values.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\nInstance of express.\n\n\t\tapp: null\n\nInstance of http\n\n\t\tserver: null\n\nInstance of socket.io\n\n\t\tio: null\n\nStatistics for the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting nodePush'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing outbound socket'\n\nStart HTTP service.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\tlistenCallback = =>\n\nShed root privilegies.\n\n\t\t\t\tif process.getuid() is 0 or process.getgid() is 0\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\t\t\t\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.type 'text\/plain'\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\treturn unless \/[a-zA-Z0-9-_.]+$\/.test name\n\t\t\t\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\nPass data to the browsers and close connection.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nKill connection after 5 seconds.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket unless config.inbound.useTCP\n\t\t\tfs.unlinkSync config.outbound.socket unless config.outbound.useTCP\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"617370eecb49afb45f08f317d9f709493da1dba1","subject":"Docs for unify done","message":"Docs for unify done\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n  \t\t              find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\nUnification is the process of improving knowledge: or, the process of measurement. That measurement may uncover a contradiction though (things are not what we thought them to be). To be precise, the unification is the statement that two terms are the same. For example, unification of `1` and `1` is successful -- `1` is indeed the same as `1`. That doesn't add however to our knowledge of the world. If the logic variable `$x` is associated with `1` in the current bindings, the unification of `$x` with `2` yields a contradiction (the new measurement is not consistent with the previous measurements \/ hypotheses). Unification of an unbound logic variable `$x` and `1` improves our knowledge: the \"measurement\" found that `$x` is actually `1`. We record that fact in the new substitution.\n\nReturn the new bindings, or `null` on contradiction:\n\n    F.unify = (l, r, bindings) ->\n\nFind out what `l` actually is given our knowledge contained in `bindings`:\n\n      t1 = bindings.lookup(l)\n\nFind out what `r` actually is given our knowledge contained in `bindings`:\n\n      t2 = bindings.lookup(r)\n\nIf `l` and `r` are the same; no new knowledge:\n\n      if _.isEqual(t1, t2)\n        return s\n\n`l` is an unbound variable:\n\n      if F.isLVar(t1)\n        return bindings.extend(t1, t2)\n\n`r` is an unbound variable:\n\n      if F.isLVar(t2)\n        return bindings.extend(t2, t1)\n\nIf t1 is a pair, so must be `r`.  This means that I can only unify arrays of nested arrays bottoming out on values or objects.  I cannot unify objects at the moment.\n\n      if _.isArray(t1) && _.isArray(t2)\n        s = F.unify(_.first(t1), _.first(t2), bindings)\n        s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2),   bindings) else s\n        return s\n      return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n\nThere are actually two ways of implementing substitutions as associative list. If the variable `$x` is associated with `$y` and `$y` is associated with `1`, we could represent this knowledge as `{$x: 1, $y 1}`. It is easy to lookup the value associated with the variable then, via a simple access. OTH, if we have the binding `{$x:  $y}` and we wish to add the bindings of `$y` to `1`, we have to make rearrangements so to produce `{$x: 1, $y 1}`, or make the traversal on lookup (which we defer to `find` below).\n\nHowever, if we use an association-list-like structure (arrays of pairs) then we can just record the associations as we learn them, without modifying the previous ones. If originally we knew `[[$x, $y]]` and later we learned that `$y` is associated with `1`, we can simply prepend the latter association, obtaining `[[$y, 1], [$x, $y]]`. So, adding new knowledge becomes fast. The lookup procedure becomes more complex though, as we have to chase the chains of variables. To obtain the value associated with `$x` in the latter substitution, we first lookup `$x`, obtain `$y` (another logic variable), then lookup `$y` finally obtaining `1`.  I prefer the object-representation since it's more idiomatic, but using an a-list provides an intuitively incremental way of representing knowledge: it is easier to backtrack if we later find out our knowledge leads to a contradiction.\n\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n\nFind the value associated with `lvar` in the `Bindings` instance.  Return `lvar` itself if it is unbound. In miniKanren, this function is called `walk`.\n\n    lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\nStarting with an empty binding is akin to saying that we start with zero knowledge.\n\n    F.ignorance = new Bindings()\n\nAs mentioned, because we overwrite bindings as we discover them the lookup logic is a little pernicious in the face of logic variables bound to other logic variables.\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n  \t\t              find(_.rest(lvar), bindings))\n      lvar\n\n\n# Unification\n# -----------\n\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8f70c7703ae1a48008d9f3f0ee96d2140ce80e77","subject":"Not deconstructing spec props anymore (there are too many now)","message":"Not deconstructing spec props anymore (there are too many now)\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                if Array.isArray val\n                  \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else\n                  \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = [ ]\n\n                for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  if Array.isArray validator\n                    for v in validator\n                      Madul.FIRE '$.Madul.validator.execute', \"#{v}\": args[arg]\n\n                      validators.push proto[v].EXECUTE.call proto[v], arg, args[arg]\n                  else\n                    Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                    validators.push proto[validator].EXECUTE.call proto[validator], arg, args[arg]\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, available[strip spec.ref], spec.ref, next\n            else\n              if spec.parent?\n                Madul.FIRE '$.Madul.search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                @_do_hydrate proto, [ spec.parent ], =>\n                  if SEARCH_ROOTS[spec.parent] == undefined\n                    SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, next\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, next\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = tokens[1].trim()\n      else if tokens.length == 1\n        alias = name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                if Array.isArray val\n                  \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else\n                  \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = [ ]\n\n                for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  if Array.isArray validator\n                    for v in validator\n                      Madul.FIRE '$.Madul.validator.execute', \"#{v}\": args[arg]\n\n                      validators.push proto[v].EXECUTE.call proto[v], arg, args[arg]\n                  else\n                    Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                    validators.push proto[validator].EXECUTE.call proto[validator], arg, args[arg]\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8974ff6a0ed965e79ebfca4acc424cdd9cb49c4d","subject":"Add basic method documentation","message":"Add basic method documentation\n","repos":"Turistforeningen\/node-mongo-querystring","old_file":"src\/index.litcoffee","new_file":"src\/index.litcoffee","new_contents":"    module.exports = MongoQS = (opts) ->\n      @ops = opts?.ops or ['!', '^', '$', '~', '>', '<']\n      @alias = opts?.alias or {}\n      @ignore = opts?.ignore or {}\n      @custom = opts?.custom or {}\n\n      for param, field of @custom\n        switch param\n          when 'bbox' then @custom.bbox = @customBBOX field\n          when 'near' then @custom.near = @customNear field\n          when 'after' then @custom.after = @customAfter field\n\n      return @\n\n## #customBBOX(`string` field)\n\n    MongoQS.prototype.customBBOX = (field) ->\n      (res, bbox) ->\n        bbox = bbox.split ','\n\n        if bbox.length is 4\n          bbox[key] = parseFloat(val) for val, key in bbox\n\n          res[field] = $geoWithin: $geometry:\n            type: 'Polygon'\n            coordinates: [[\n              [bbox[0], bbox[1]]\n              [bbox[2], bbox[1]]\n              [bbox[2], bbox[3]]\n              [bbox[0], bbox[3]]\n              [bbox[0], bbox[1]]\n            ]]\n\n        return\n\n## #customNear(`string` field)\n\n    MongoQS.prototype.customNear = (field) ->\n      (query, input) ->\n        input = input.split ','\n\n        if input.length is 2\n          input[key] = parseFloat(val) for val, key in input\n\n          query[field] = $near: $geometry:\n            type: 'Point'\n            coordinates: input\n\n        return\n\n## #customAfter(`string` field)\n\n    MongoQS.prototype.customAfter = (field) ->\n      (query, input) ->\n\n        if not isNaN input\n          input = input + '000' if (input + '').length is 10\n          input = parseInt input\n\n        input = new Date input\n\n        if input.toString() isnt 'Invalid Date'\n          query[field] = $gte: input.toISOString()\n\n        return\n\n## #parse(`object` query)\n\nMain query param parser method which follows the following order of operations.\n\n1. Ignored query param name checking\n2. Invalid query param type checking\n3. Invalid query param name checking\n4. Aliased query param conversion\n5. Custom query param parsing\n6. Allowed query param ops parsing\n\n    MongoQS.prototype.parse = (query) ->\n      res = {}\n\n      for key, val of query\n        continue if @ignore[key]\n        continue if typeof val isnt 'string'\n        continue if not \/^[a-z\u00e6\u00f8\u00e50-9-_.]+$\/i.test key\n\n        key = @alias[key] if @alias[key]\n\n        if @custom[key]\n          @custom[key] res, val\n\nIf the value is empty we treat the query parameter as an\n[$exists](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/exists\/)\noperator.\n\n        else if not val\n          res[key] = $exists: true\n\nCheck for supported operators in `@ops`. This is configured when\ninstanciating `MongoQS` and the defaults are `!`, `^`, `$`, `~`, `>`, and `<`.\n\n        else if val.charAt(0) in @ops\n          op = val.charAt(0)\n          val = val.substr(1)\n\n          res[key] = switch op\n            when '!'\n              if val\n                $ne: if isNaN(val) then val else parseFloat(val, 10)\n              else\n                $exists: false\n            when '>' then $gt: parseFloat(val, 10)\n            when '<' then $lt: parseFloat(val, 10)\n            else\n              val = val.replace \/[^a-z\u00e6\u00f8\u00e50-9-_.* ]\/i, ''\n              switch op\n                when '^' then $regex: '^' + val, $options: 'i'\n                when '$' then $regex: val + '$', $options: 'i'\n                else $regex: val, $options: 'i'\n\n        else\n          res[key] = if isNaN(val) then val else parseFloat(val, 10)\n\n      res\n\n","old_contents":"    module.exports = MongoQS = (opts) ->\n      @ops = opts?.ops or ['!', '^', '$', '~', '>', '<']\n      @alias = opts?.alias or {}\n      @ignore = opts?.ignore or {}\n      @custom = opts?.custom or {}\n\n      for param, field of @custom\n        switch param\n          when 'bbox' then @custom.bbox = @customBBOX field\n          when 'near' then @custom.near = @customNear field\n          when 'after' then @custom.after = @customAfter field\n\n      return @\n\n    MongoQS.prototype.customBBOX = (field) ->\n      (res, bbox) ->\n        bbox = bbox.split ','\n\n        if bbox.length is 4\n          bbox[key] = parseFloat(val) for val, key in bbox\n\n          res[field] = $geoWithin: $geometry:\n            type: 'Polygon'\n            coordinates: [[\n              [bbox[0], bbox[1]]\n              [bbox[2], bbox[1]]\n              [bbox[2], bbox[3]]\n              [bbox[0], bbox[3]]\n              [bbox[0], bbox[1]]\n            ]]\n\n        return\n\n    MongoQS.prototype.customNear = (field) ->\n      (query, input) ->\n        input = input.split ','\n\n        if input.length is 2\n          input[key] = parseFloat(val) for val, key in input\n\n          query[field] = $near: $geometry:\n            type: 'Point'\n            coordinates: input\n\n        return\n\n    MongoQS.prototype.customAfter = (field) ->\n      (query, input) ->\n\n        if not isNaN input\n          input = input + '000' if (input + '').length is 10\n          input = parseInt input\n\n        input = new Date input\n\n        if input.toString() isnt 'Invalid Date'\n          query[field] = $gte: input.toISOString()\n\n        return\n\n\n    MongoQS.prototype.parse = (query) ->\n      res = {}\n\n      for key, val of query\n        continue if @ignore[key]\n        continue if typeof val isnt 'string'\n        continue if not \/^[a-z\u00e6\u00f8\u00e50-9-_.]+$\/i.test key\n\n        key = @alias[key] if @alias[key]\n\n        if @custom[key]\n          @custom[key] res, val\n\nIf the value is empty we treat the query parameter as an\n[$exists](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/exists\/)\noperator.\n\n        else if not val\n          res[key] = $exists: true\n\nCheck for supported operators in `@ops`. This is configured when\ninstanciating `MongoQS` and the defaults are `!`, `^`, `$`, `~`, `>`, and `<`.\n\n        else if val.charAt(0) in @ops\n          op = val.charAt(0)\n          val = val.substr(1)\n\n          res[key] = switch op\n            when '!'\n              if val\n                $ne: if isNaN(val) then val else parseFloat(val, 10)\n              else\n                $exists: false\n            when '>' then $gt: parseFloat(val, 10)\n            when '<' then $lt: parseFloat(val, 10)\n            else\n              val = val.replace \/[^a-z\u00e6\u00f8\u00e50-9-_.* ]\/i, ''\n              switch op\n                when '^' then $regex: '^' + val, $options: 'i'\n                when '$' then $regex: val + '$', $options: 'i'\n                else $regex: val, $options: 'i'\n\n        else\n          res[key] = if isNaN(val) then val else parseFloat(val, 10)\n\n      res\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"edbb346dc2ba57daeb8ec91f673c68b16f83b78e","subject":"simplified algorithm for finding js native class objects","message":"simplified algorithm for finding js native class objects\n","repos":"arximboldi\/heterarchy","old_file":"heterarchy.litcoffee","new_file":"heterarchy.litcoffee","new_contents":"heterarchy\n==========\n\n> This file is part of [Heterarchy](http:\/\/sinusoid.es\/heterarchy).\n> - **View me [on a static web](http:\/\/sinusoid.es\/heterarchy\/heterarchy.html)**\n> - **View me [on GitHub](https:\/\/github.com\/arximboldi\/heterarchy\/blob\/master\/heterarchy.litcoffee)**\n\nAdds multiple inheritance support to CoffeeScript (and JavaScript).\nIt uses the C3 linearization algorithm as described in the [famous\nDylan paper](http:\/\/192.220.96.201\/dylan\/linearization-oopsla96.html).\n\n    {head, tail, map, find, some, without, isEmpty, every, memoize, reject,\n     partial, isEqual, reduce} = require 'underscore'\n\n    assert = (value, error) ->\n        if not value\n            throw new Error(if error? then error else \"Assertion failed\")\n\nMultiple inheritance\n--------------------\n\nThe **multi** function takes a list of classes and returns a *special*\nclass object that merges the class hierarchies, as linearized by the\nC3 algorithm. Limitations of the approach are:\n\n- `instanceof` does not always work as expected. For example:\n\n  > ```coffee\n  > class A\n  > class B extends A\n  > class C extends A\n  > class D extends multi B, C\n  > assert new D not instanceof B\n  > ```\n\n  Instead, one should use the provided `isinstance` function.\n\n- Some of the bases of a multi-inherited hierarchy are *frozen* when\n  the sub-class is defined -- i.e. later modifications to the\n  superclass are not visible to the subclass or its instances.  For\n  example, in the previous heterarchy:\n\n  > ```coffee\n  > B::newProperty = 42\n  > assert D::newProperty == undefined\n  > ```\n\nThe `multi` function memoizes its results such that identity is\nmaintained, implying `multi X, Y is multi X, Y`.\n\n    exports.multi = (bases...) ->\n        generate merge map(bases, mro).concat [bases]\n\nThis takes a list of classes representing a hierarchy (from most to\nleast derived) and generates a single-inheritance hierarchy that\nbehaves like a class that would be have such a hierarchy.\n\n    generate = memoize (linearization) ->\n        next = head linearization\n        if isEqual linearization, hierarchy next\n            next\n        else\n            class Result extends generate tail linearization\n                __mro__: linearization\n                constructor: reparent next, @, next::constructor\n                copyOwn next, @\n                copyOwn next::, @::, partial reparent, next, @\n\nThis utility lets us copy own properties of a *from* object that are\nnot own properties of a *to* object into the *to* object, optionally\ntransformed via a projection function.\n\n    copyOwn = (from, to, project = (x) -> x) ->\n        for own key, value of from\n            if not to.hasOwnProperty key\n                to[key] = project value\n        to\n\nMethods in CoffeeScript call super directly, so we have to change the\n`__super__` attribute of the original class during the scope of the\nmethod so it calls the right super of the linearization.  Also,\nprogrammers don't call super in constructor of root classes --indeed\ndoing so would rise an error-- so we have to inject such a call when\nthere are classes after these in the linearization.  The **reparent**\nfunction takes care of all these and given an original class, and the\nnew class that is replacing it a linearized heterarchy, returns a\nwrapped copy of a value of the former that is suitable for replacing\nit in the later.\n\n    reparent = (oldklass, newklass, value) ->\n        if value not instanceof Function\n            value\n        else if value is oldklass::constructor and inherited(oldklass) is Object\n            superctor = inherited(newklass)::constructor\n            ->\n                superctor.apply @, arguments\n                value.apply @, arguments\n        else\n            newsuper = inherited(newklass)::\n            oldsuper = oldklass.__super__\n            ->\n                oldklass.__super__ = newsuper\n                try\n                    value.apply @, arguments\n                finally\n                    oldklass.__super__ = oldsuper\n\nThis is the C3 linearization algorithm, as translated from the\noriginal paper.\n\n    merge = (inputs) ->\n        while not isEmpty inputs\n            next = find (map inputs, head), (candidate) ->\n                every inputs, (input) -> candidate not in tail input\n            assert next?, \"Inconsistent multiple inheritance\"\n            inputs = reject map(inputs, (lst) -> without lst, next), isEmpty\n            next\n\nIntrospection\n-------------\n\nThe **mro** function returns the method resolution order\n(linearization) of a given class:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends B\n> assert mro(C).equals [C, B, A]\n> ```\n\nIt returns the original classes that were mixed in when used with\nmult-inherited classes:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert mro(D).equals [D, B, C, A, Object]\n> ```\n\n    javaScriptClassNames = [\n        \"Array\"\n        \"Boolean\"\n        \"Date\"\n        \"Error\"\n        \"Function\"\n        \"Number\"\n        \"RegExp\"\n        \"String\"\n        \"Object\"\n        \"EvalError\"\n        \"RangeError\"\n        \"ReferenceError\"\n        \"SyntaxError\"\n        \"TypeError\"\n        \"URIError\"\n        # non-standard classes\n        \"Symbol\"\n        # typed arrays\n        \"Int8Array\"\n        \"Uint8Array\"\n        \"Uint8ClampedArray\"\n        \"Int16Array\"\n        \"Uint16Array\"\n        \"Int32Array\"\n        \"Uint32Array\"\n        \"Float32Array\"\n        \"Float64Array\"\n        # keyed Keyed collections\n        \"Map\"\n        \"Set\"\n        \"WeakMap\"\n        \"WeakSet\"\n        # Structured data\n        \"ArrayBuffer\"\n        \"DataView\"\n        # Control abstraction objects\n        \"Promise\"\n        \"Generator\"\n        \"GeneratorFunction\"\n        # Reflection\n        \"Reflect\"\n        \"Proxy\"\n    ]\n    javaScriptClasses = reduce javaScriptClassNames, (classes, name) ->\n        classes[global[name]] = global[name]\n        classes\n    , {}\n    isJavaScriptClass = (cls) ->\n        javaScriptClasses[cls] is cls\n\n    exports.mro = mro = (cls) ->\n        if not cls? or not cls::?\n            []\n        else if not cls::hasOwnProperty '__mro__'\n            result = [cls].concat mro inherited(cls)\n            cls::__mro__ = result unless isJavaScriptClass cls\n            result\n        else\n            cls::__mro__\n\nThe **inherited** function returns the CoffeeScript superclass of an\nobject, for example:\n\n> ```coffee\n> class A\n> class B extends A\n> assert inherited(B) == A\n> ```\n\nNote that for multiple inherited classes, this returns the mixed\nobject, not the next class in the MRO, as in:\n\n> ```coffee\n> class C extends multi A, B\n> assert inherited(C) == multi(A, B)\n> ```\n\n    exports.inherited = inherited = (cls) ->\n        Object.getPrototypeOf(cls.prototype)?.constructor\n\nThe **hierarchy** returns the CoffeeScript hierarchy of classes of a\ngiven class, including the class itself.  For multiple inherited\nclasses, it may return speciall classes that were generated to produce\nthe flattening, as in:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert not mro(D).equals hierarchy(D)\n> assert hierarchy(D).equals\n>     [ D, multi(B, C), inherited(multi B, C), A, Object ]\n> ```\n\n    exports.hierarchy = hierarchy = (cls) ->\n        if not cls?\n            []\n        else\n            [cls].concat hierarchy inherited cls\n\nThe **isinstance** function takes an object and a class or classes and\nreturns whether the object is an instance of any of those classes. It\nis compatible with multi-inherited classes.\n\n    exports.isinstance = (obj, classes...) ->\n        exports.issubclass obj?.constructor, classes...\n\nThe **issubclass** tells whether a class is a subtype of another type.\n\n    exports.issubclass = (klass, classes...) ->\n        linearization = mro klass\n        some classes, (cls) -> cls in linearization\n\nLicense\n-------\n\n> Copyright (c) 2013, 2015 Juan Pedro Bolivar Puente <raskolnikov@gnu.org>\n>\n> Permission is hereby granted, free of charge, to any person obtaining a copy\n> of this software and associated documentation files (the \"Software\"), to deal\n> in the Software without restriction, including without limitation the rights\n> to use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\n> copies of the Software, and to permit persons to whom the Software is\n> furnished to do so, subject to the following conditions:\n>\n> The above copyright notice and this permission notice shall be included in\n> all copies or substantial portions of the Software.\n>\n> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n> THE SOFTWARE.\n","old_contents":"heterarchy\n==========\n\n> This file is part of [Heterarchy](http:\/\/sinusoid.es\/heterarchy).\n> - **View me [on a static web](http:\/\/sinusoid.es\/heterarchy\/heterarchy.html)**\n> - **View me [on GitHub](https:\/\/github.com\/arximboldi\/heterarchy\/blob\/master\/heterarchy.litcoffee)**\n\nAdds multiple inheritance support to CoffeeScript (and JavaScript).\nIt uses the C3 linearization algorithm as described in the [famous\nDylan paper](http:\/\/192.220.96.201\/dylan\/linearization-oopsla96.html).\n\n    {head, tail, map, find, some, without, isEmpty, every, memoize, reject,\n     partial, isEqual} =\n        require 'underscore'\n\n    assert = (value, error) ->\n        if not value\n           throw new Error(if error? then error else \"Assertion failed\")\n\nMultiple inheritance\n--------------------\n\nThe **multi** function takes a list of classes and returns a *special*\nclass object that merges the class hierarchies, as linearized by the\nC3 algorithm. Limitations of the approach are:\n\n- `instanceof` does not always work as expected. For example:\n\n  > ```coffee\n  > class A\n  > class B extends A\n  > class C extends A\n  > class D extends multi B, C\n  > assert new D not instanceof B\n  > ```\n\n  Instead, one should use the provided `isinstance` function.\n\n- Some of the bases of a multi-inherited hierarchy are *frozen* when\n  the sub-class is defined -- i.e. later modifications to the\n  superclass are not visible to the subclass or its instances.  For\n  example, in the previous heterarchy:\n\n  > ```coffee\n  > B::newProperty = 42\n  > assert D::newProperty == undefined\n  > ```\n\nThe `multi` function memoizes its results such that identity is\nmaintained, implying `multi X, Y is multi X, Y`.\n\n    exports.multi = (bases...) ->\n        generate merge map(bases, mro).concat [bases]\n\nThis takes a list of classes representing a hierarchy (from most to\nleast derived) and generates a single-inheritance hierarchy that\nbehaves like a class that would be have such a hierarchy.\n\n    generate = memoize (linearization) ->\n        next = head linearization\n        if isEqual linearization, hierarchy next\n            next\n        else\n            class Result extends generate tail linearization\n                __mro__: linearization\n                constructor: reparent next, @, next::constructor\n                copyOwn next, @\n                copyOwn next::, @::, partial reparent, next, @\n\nThis utility lets us copy own properties of a *from* object that are\nnot own properties of a *to* object into the *to* object, optionally\ntransformed via a projection function.\n\n    copyOwn = (from, to, project = (x) -> x) ->\n        for own key, value of from\n            if not to.hasOwnProperty key\n                to[key] = project value\n        to\n\nMethods in CoffeeScript call super directly, so we have to change the\n`__super__` attribute of the original class during the scope of the\nmethod so it calls the right super of the linearization.  Also,\nprogrammers don't call super in constructor of root classes --indeed\ndoing so would rise an error-- so we have to inject such a call when\nthere are classes after these in the linearization.  The **reparent**\nfunction takes care of all these and given an original class, and the\nnew class that is replacing it a linearized heterarchy, returns a\nwrapped copy of a value of the former that is suitable for replacing\nit in the later.\n\n    reparent = (oldklass, newklass, value) ->\n        if value not instanceof Function\n            value\n        else if value is oldklass::constructor and inherited(oldklass) is Object\n            superctor = inherited(newklass)::constructor\n            ->\n                superctor.apply @, arguments\n                value.apply @, arguments\n        else\n            newsuper = inherited(newklass)::\n            oldsuper = oldklass.__super__\n            ->\n                oldklass.__super__ = newsuper\n                try\n                    value.apply @, arguments\n                finally\n                    oldklass.__super__ = oldsuper\n\nThis is the C3 linearization algorithm, as translated from the\noriginal paper.\n\n    merge = (inputs) ->\n        while not isEmpty inputs\n            next = find (map inputs, head), (candidate) ->\n                every inputs, (input) -> candidate not in tail input\n            assert next?, \"Inconsistent multiple inheritance\"\n            inputs = reject map(inputs, (lst) -> without lst, next), isEmpty\n            next\n\nIntrospection\n-------------\n\nThe **mro** function returns the method resolution order\n(linearization) of a given class:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends B\n> assert mro(C).equals [C, B, A]\n> ```\n\nIt returns the original classes that were mixed in when used with\nmult-inherited classes:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert mro(D).equals [D, B, C, A, Object]\n> ```\n\n    isJavaScriptClass = (cls) ->\n        if cls.hasOwnProperty(\"__isNative__\")\n            return cls.__isNative__\n\n        standardClasses = [\n            Array\n            Boolean\n            Date\n            Error\n            Function\n            Number\n            RegExp\n            String\n            Object\n            EvalError\n            RangeError\n            ReferenceError\n            SyntaxError\n            TypeError\n            URIError\n        ]\n\n        isNative = false\n        if cls in standardClasses\n            isNative = true\n        else\n            # according to https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\n            nonStandardClasses = [\n                \"Symbol\"\n                # typed arrays\n                \"Int8Array\"\n                \"Uint8Array\"\n                \"Uint8ClampedArray\"\n                \"Int16Array\"\n                \"Uint16Array\"\n                \"Int32Array\"\n                \"Uint32Array\"\n                \"Float32Array\"\n                \"Float64Array\"\n                # keyed Keyed collections\n                \"Map\"\n                \"Set\"\n                \"WeakMap\"\n                \"WeakSet\"\n                # Structured data\n                \"ArrayBuffer\"\n                \"DataView\"\n                # Control abstraction objects\n                \"Promise\"\n                \"Generator\"\n                \"GeneratorFunction\"\n                # Reflection\n                \"Reflect\"\n                \"Proxy\"\n            ]\n            for nonStandardClass in nonStandardClasses when cls is global[nonStandardClass]\n                isNative = true\n        cls.__isNative__ = isNative\n        isNative\n\n    exports.mro = mro = (cls) ->\n        if not cls? or not cls::?\n            []\n        else if not cls::hasOwnProperty '__mro__'\n            result = [cls].concat mro inherited(cls)\n            cls::__mro__ = result unless isJavaScriptClass cls\n            result\n        else\n            cls::__mro__\n\nThe **inherited** function returns the CoffeeScript superclass of an\nobject, for example:\n\n> ```coffee\n> class A\n> class B extends A\n> assert inherited(B) == A\n> ```\n\nNote that for multiple inherited classes, this returns the mixed\nobject, not the next class in the MRO, as in:\n\n> ```coffee\n> class C extends multi A, B\n> assert inherited(C) == multi(A, B)\n> ```\n\n    exports.inherited = inherited = (cls) ->\n        Object.getPrototypeOf(cls.prototype)?.constructor\n\nThe **hierarchy** returns the CoffeeScript hierarchy of classes of a\ngiven class, including the class itself.  For multiple inherited\nclasses, it may return speciall classes that were generated to produce\nthe flattening, as in:\n\n> ```coffee\n> class A\n> class B extends A\n> class C extends A\n> class D extends multi B, C\n> assert not mro(D).equals hierarchy(D)\n> assert hierarchy(D).equals\n>     [ D, multi(B, C), inherited(multi B, C), A, Object ]\n> ```\n\n    exports.hierarchy = hierarchy = (cls) ->\n        if not cls?\n            []\n        else\n            [cls].concat hierarchy inherited cls\n\nThe **isinstance** function takes an object and a class or classes and\nreturns whether the object is an instance of any of those classes. It\nis compatible with multi-inherited classes.\n\n    exports.isinstance = (obj, classes...) ->\n        exports.issubclass obj?.constructor, classes...\n\nThe **issubclass** tells whether a class is a subtype of another type.\n\n    exports.issubclass = (klass, classes...) ->\n        linearization = mro klass\n        some classes, (cls) -> cls in linearization\n\nLicense\n-------\n\n> Copyright (c) 2013, 2015 Juan Pedro Bolivar Puente <raskolnikov@gnu.org>\n>\n> Permission is hereby granted, free of charge, to any person obtaining a copy\n> of this software and associated documentation files (the \"Software\"), to deal\n> in the Software without restriction, including without limitation the rights\n> to use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\n> copies of the Software, and to permit persons to whom the Software is\n> furnished to do so, subject to the following conditions:\n>\n> The above copyright notice and this permission notice shall be included in\n> all copies or substantial portions of the Software.\n>\n> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n> THE SOFTWARE.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2c422c500824394ce92baa1e27290a2e708dcdff","subject":"add login form to routes","message":"add login form to routes\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/lib\/routes\/index.litcoffee","new_file":"src\/lib\/routes\/index.litcoffee","new_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        fs = require('fs')\n        res.render 'index', {\n          title: 'Welcome',\n          extra_head_css: fs.readFileSync('views\/extra\/nivo.css'),\n          extra_foot_js: fs.readFileSync('views\/extra\/nivo.js')\n        }\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        require('..\/page').getPage(app.models.page, req.params.name, (page) ->\n          if page\n            res.render 'page', page\n          else\n            console.error 'page '+req.params.name+' not found in db, showing static'\n            res.render 'page\/'+req.params.name\n        )\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n\n      app.post '\/page\/_post', (req, res) ->\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          body: 'Hello world, from inside the DB'\n        require('..\/page').setPage(app.models.page, sample, (page) ->\n          if page\n            res.render 'page', page\n          else\n            page =\n              name: 'error'\n              title: 'Error'\n              body: 'There was an error posting your page, please try again.'\n            res.render 'page', page\n        )\n          \n## GET \/login\n\nRender static pages at \/view\/login\/index.html\n\n      app.get '\/login', (req, res) ->\n        res.render 'login'\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        fs = require('fs')\n        res.render 'index', {\n          title: 'Welcome',\n          extra_head_css: fs.readFileSync('views\/extra\/nivo.css'),\n          extra_foot_js: fs.readFileSync('views\/extra\/nivo.js')\n        }\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        require('..\/page').getPage(app.models.page, req.params.name, (page) ->\n          if page\n            res.render 'page', page\n          else\n            console.error 'page '+req.params.name+' not found in db, showing static'\n            res.render 'page\/'+req.params.name\n        )\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n\n      app.post '\/page\/_post', (req, res) ->\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          body: 'Hello world, from inside the DB'\n        require('..\/page').setPage(app.models.page, sample, (page) ->\n          if page\n            res.render 'page', page\n          else\n            page =\n              name: 'error'\n              title: 'Error'\n              body: 'There was an error posting your page, please try again.'\n            res.render 'page', page\n        )\n          \n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"2d6f510906a22dd3017b54ecd8200e62383950f5","subject":"Update functions.litcoffee","message":"Update functions.litcoffee","repos":"andychase\/date_machine,andychase\/date_machine,andychase\/date_machine,andychase\/date_machine","old_file":"date_machine\/javascript\/functions.litcoffee","new_file":"date_machine\/javascript\/functions.litcoffee","new_contents":"### This file\n\nThe logic in this file builds the date object.\n\nIf you compare this file to the ```python\/functions.py``` file\nyou'll notice they are very similiar. That's intentional,\nthis file was ported over and kept such that it would be somewhat\neasy to port changes back and forth.\n\n### Terminology\n\nBecause it's so confusing here is a list of the different levels to refer to:\n\n- Groups \n  -- This is the capture groups. The lowest level. ```([0-9])``` etc.\n  \"Day\", \"Month\", etc.\n- Expressions \n  -- This is an expression with multiple capture groups. They're usually named\n  after the person that wrote them. \"Greg Burns\", etc.\n  \n  In Python, Expressions functions have nice named arguments, def expr(Day, Month, Year),\n  but Javascript doesn't support this.\n- Type\n  -- This is a collection of expressions with a common goal.\n  Months (Jan, 0-12, January, etc.). \n- Patterns\n  -- This is a collection of types ```<Month>\/<Day>\/<Year>```\n\n### Warning\n\nA note about the above list. Types and Groups are commonly mixed up.\nI think groups SHOULD be the lowest \n(because they are the actual capture *groups* in regular expressions)\nbut a group of expressions also makes sense.\n\nIt's so confusing that there are at least a couple places here that I've\nalso mixed myself up and probably in the documentation for RE|PARSE as well.\n\n---\n\nI use named tuples in python, and ```_replace``` mirrors the functionality of \n```date._replace```.. that is that it returns a copy of the date with only\ncertain things changed and leaves the old well enough alone.\n\n        _replace = (_old, _new) ->\n            year:   if _new.year? then _new.year else _old.year\n            month:  if _new.month? then _new.month else _old.month\n            day:    if _new.day? then _new.day  else _old.day\n            hour:   if _new.hour? then _new.hour else _old.hour\n            minute: if _new.minute? then _new.minute else _old.minute\n            second: if _new.second? then _new.second else _old.second\n            am_pm:  if _new.am_pm? then _new.am_pm else _old.am_pm\n\nI represent lengths of dates (i.e. Thursday, 1-2pm) with a timedelta that goes right\nafter the date hash in the result array.\n\nIn Javascript, I'm just going to represent a timedelta with a hash.\nI make a pretty dumb assumption that timedelta will only cross hour\/minutes\/second boundaries.\n\n        timedelta_from_Date = (start_time, end_time) ->\n            seconds_difference = 0\n            if start_time.hour? and end_time.hour?\n              seconds_difference += 60*60*(end_time.hour - start_time.hour)\n\n              if start_time.minute? and end_time.minute?\n                seconds_difference += 60*(end_time.minute - start_time.minute)\n\n                if start_time.second? and end_time.second?\n                  seconds_difference += end_time.second - start_time.second\n\n            hours = Math.floor(seconds_difference\/60\/60)\n            minutes = Math.floor(seconds_difference\/60) - (hours * 60)\n            seconds = seconds_difference - (minutes * 60) - (hours * 60 * 60)\n\n            return {\n               timedelta: true\n               hours: hours\n               minutes: minutes\n               seconds: seconds\n            }\n\n\nThis is just a helper function\n\n        in_array = (arr, _) -> arr.indexOf(_) != -1\n\n```progressive_match``` is useful for matching abbreviations\nand full spellings. Functions like this could be useful\nto help parse fuzzy matches in the future (i.e. misspellings of months).\n\n        progressive_match = (string, possibilities) ->\n            part = \"\"\n            if not string? then return\n            for character in string.toLowerCase()\n                part += character\n                matches = []\n                for month, value of possibilities\n                    if month.indexOf(part) > -1\n                        matches.push(month)\n                if matches.length == 1\n                    return possibilities[matches[0]]\n### Types\n\n\n        month_to_number = (month_string) ->\n          months =\n              \"january\": 1\n              \"february\": 2\n              \"march\": 3\n              \"april\": 4\n              \"may\": 5\n              \"june\": 6\n              \"july\": 7\n              \"august\": 8\n              \"september\": 9\n              \"october\": 10\n              \"november\": 11\n              \"december\": 12\n           return progressive_match(month_string, months)\n\n        weekday_to_number = (WeekdayString ) ->\n            weekday_list = {\n                \"monday\": 0,\n                \"tuesday\": 1,\n                \"wednesday\": 2,\n                \"thursday\": 3,\n                \"friday\": 4,\n                \"saturday\": 5,\n                \"sunday\": 6,\n            }\n            return progressive_match(WeekdayString, weekday_list)\n\nI serialize am_pm by converting the hours to milliary\/24-hour time format.\nI also include ```am_pm: 'pm'``` in the date format to show that that transformation\nwas done. Making that clear helpful because if you get a time like 1, with no ```am_pm```\ndesignation you might want to assume pm and add 12. This is not done in the libary because\ndate_machine strives for honesty, not guesswork.\n\n        am_pm = (input) ->\n            if not input?\n              return\n            if input.toLowerCase() == \"am\" then 0\n            else if input.toLowerCase() == \"pm\" then 12\n\nI try not to repeat logic and use other functions when possible.\nI could put ```\"Steve Valaitis2\": time_expression``` to avoid this,\nbut I wrote it out to show that nothing special happens with 24-hour\/military time.\n\n        military_time = (MilHour, MilMinute, MilSecond ) ->\n            return time_expression(MilHour, MilMinute, MilSecond, undefined)\n\nHere is the am\/pm conversion. I omit returns when the expressions are simple,\nbut later on I want to use them as much as possible to make my intentions clear.\n\n        noon = (hour, AMPM) -> hour == 12 and AMPM == 12\n        midnight = (hour, AMPM) -> hour == 12 and AMPM == 0\n\nThis function gets called pretty often, I'd consider it the bulk\nof the output logic.\n\n        time_expression = (Hour, Minute, Second, AMPM, SpecialTimeText ) ->\n            if not Hour? and not Minute? and not Second? and not AMPM? and not SpecialTimeText?\n                return\n            if SpecialTimeText\n                if SpecialTimeText.toLowerCase() == \"noon\"\n                    return {hour: 12}\n                if SpecialTimeText.toLowerCase() == \"midnight\"\n                    return {hour: 0}\n            d = {}\n            if Hour\n                d.hour = Number(Hour)\n            if Minute\n                d.minute = Number(Minute)\n            if Second\n                d.second = Number(Second)\n            if AMPM?\n                if d.hour\n                    if noon(d.hour, AMPM)\n                        d.hour = 12\n                    else if midnight(d.hour, AMPM)\n                        d.hour = 0\n                    else\n                        d.hour = d.hour + AMPM\n                d.am_pm = AMPM\n            if [d.hour, d.minute, d.second] == [undefined, undefined, undefined]\n                return undefined\n            return d\n\n        time_and_time = (Hour, Minute, AMPM1, Hour2, Minute2, AMPM2) ->\n            if AMPM2?\n                AMPM2 = am_pm(AMPM2)\n            if not AMPM1? and not AMPM2?\n                return [time_expression(Hour, Minute), time_expression(Hour2, Minute2)]\n            else if not AMPM1?\n                return [time_expression(Hour, Minute, undefined, AMPM2),\n                        time_expression(Hour2, Minute2, undefined, AMPM2)]\n            else if not AMPM2?\n                return [time_expression(Hour, Minute, undefined, AMPM1),\n                        time_expression(Hour2, Minute2, undefined, AMPM1)]\n\n\n        month_type = (input...) ->\n            for value in input\n                if value?\n                    return Number(value)\n\n\n        date_number = (Day, Abbr) -> if Day? then Number(Day)\n\n        month_number = (MonthNum) -> Number(MonthNum)\n\n        month_num_type = (input) -> Number(input)\n\n        year = (Year) -> if Year? then Number(Year)\n\nSometimes the value is ```[undefined, undefined, <value>]```,\nso I need to search for it and find it. There's enough\nof these smaller expressions scattered around that moving them\nall to one place might be good.\n\n        get_first_defined = (_) ->\n          for item in _\n            if item?\n              return item\n\n### Patterns\n\nThere's a some unwrapping values out of arrays here.\nBecause there's no named-arguments, functions receive a lot more\narrays here then in Python and so they need to be unwrapped.\n\n        weekday_range_with_time = (time1, time2, [weekday1], [weekday2], MonthRange) ->\n            output = []\n\n            # Get first undefined value\n            # Since only one value in list will be defined (if any)\n            time1 = get_first_defined(time1)\n            time2 = get_first_defined(time2)\n\n            if time1?\n                for date in MonthRange\n                    output.push(_replace(date, time1))\n                    if time2?\n                        output.push(_replace(date, time2))\n            return output\n\n\n        weekday_range_with_extra = ( time, and_time, weekday_start, weekday_end, extra_time, extra_weekday, MonthRange) ->\n            output = []\n            if time?\n                for date in MonthRange\n                    if date.weekday?\n                        if date.weekday in [weekday_start .. weekday_end]\n                            output.push(_replace(date, time))\n                            if and_time?\n                                output.push(_replace(date, and_time))\n                        if date.weekday == extra_weekday\n                            output.push(_replace(date, extra_time))\n            return output\n\n\n        weekday_range_with_extra_backwards = (extra_time, extra_weekday, time, weekday_start, weekday_end, MonthRange ) ->\n            return weekday_range_with_extra(time[0], time[1], weekday_start, weekday_end, extra_time, extra_weekday, MonthRange )\n\n\n        reverse_basic_text = (time, day, month, year) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        basic_text = (time, first_second, weekday, month, day, year) ->\n            if not day?\n                day = 1\n            if (day instanceof Array) and day.length == 1\n              day = day[0]\n            if (year instanceof Array) and year.length == 1\n              year = year[0]\n            if not time?\n                return {year: year, month: month, day: day}\n            else\n                year: year\n                month: month\n                day: day\n                hour: time.hour\n                minute: time.minute\n                second: time.second\n                am_pm: time.am_pm\n\n\n        slash = (month, day, year, time) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        month_range = (month, date_a, date_b) ->\n            output = []\n            for day in [date_a .. date_b]\n                output.push(basic_text(undefined, undefined, undefined, month, day, undefined))\n            return output\n\n\n        multi_time = (time1, BasicText) ->\n            output = []\n            if time1? and BasicText?\n                output.push(_replace(BasicText, time1))\n                output.push(BasicText)\n                return output\n\n\n        large_repeat_words = ->\n            return undefined\n\n\n        weekday_range_with_time_range = (time1, weekday_range) ->\n            output = []\n            if time1? and weekday_range?\n                range = timedelta_from_Date(_replace(weekday_range[0], time1), weekday_range[0])\n                for weekday in weekday_range\n                    output.push(_replace(weekday, {hour:time1.hour, minute:time1.minute, am_pm:time1.am_pm}))\n                    output.push(range)\n                return output\n\n\n        time_range = (unstrict_time, strict_time, date, reverse) ->\n            endtime = date\n            starttime = endtime\n            if unstrict_time\n                starttime = _replace(starttime, {hour:Number(unstrict_time[0])})\n                if date.am_pm\n                    starttime = _replace(starttime, {hour: starttime.hour + date.am_pm, am_pm:date.am_pm})\n            else\n                starttime = _replace(starttime, {hour: strict_time.hour, minute: strict_time.minute})\n\n            time_range = timedelta_from_Date(starttime, endtime)\n            if reverse\n                time_range = timedelta_from_Date(endtime, starttime)\n            return [starttime, time_range]\n\n\n        alt_time_range = (first_second, weekday, month, day, year, time, unstrict_time, strict_time) ->\n            return time_range(unstrict_time, strict_time, basic_text(time, first_second, weekday, month, day, year), reverse)\n\n\n        until_range = (date1, date2) ->\n            if date1 and date2\n                return [date1, timedelta_from_Date(date1, date2)]\n\n\n        through_range = (time, weekday1, weekday2, month, date, beginning) ->\n            output = []\n            if month and date and beginning and weekday1\n                ending =\n                    month: month\n                    day: date\n                for day in [beginning.day .. ending.day]\n                    temp =\n                        month: month\n                        day: date\n                    if temp.weekday and in_array([weekday1 .. weekday2], temp.weekday)\n                        if time\n                            output.push(_replace(temp, time))\n                        else\n                            output.push(temp)\n                return output\n\n\n### The function list\n\nThis hash\/object matches all the functions with a\nstring that represents it in the parse tree.\n\n        functions =\n            # Groups\n            \"MonthString\": month_to_number,\n            \"AMPM\": am_pm,\n            # Expressions\n            \"Chase Year\": year,\n            \"Chase Date\": date_number,\n            \"Chase Month\": month_number,\n            \"Steve Valaitis\": time_expression,\n            \"Greg Burns\": (hour, am_pm) -> time_expression(hour, null, null, am_pm, null),\n            \"Greg Burns UnstrictTime:\": time_expression,\n            \"Steve Valaitis2\": military_time,\n            \"Steve Valaitis And Time\": time_and_time,\n            \"Text Parts\": time_expression,\n            \"Michael Ash10\": weekday_to_number,\n            # Types\n            \"Month\": month_type,\n            \"MonthNum\": month_num_type,\n            # Patterns\n            \"LargeRepeatWords\": large_repeat_words,\n            \"BasicText\": basic_text,\n            \"ReverseBasicText\": reverse_basic_text,\n            \"Slash\": slash,\n            \"MonthRange\": month_range,\n            \"MultiTime\": multi_time,\n            \"WeekdayRangeWithTime\": weekday_range_with_time,\n            \"WeekdayRangeWithExtra\": weekday_range_with_extra,\n            \"WeekdayRangeWithExtraBackwards\": weekday_range_with_extra_backwards,\n            \"WeekdayRangeWithTimeRange\": weekday_range_with_time_range,\n            \"UntilRange\": until_range,\n            \"ThroughRange\": through_range,\n            \"TimeRange\": time_range,\n            \"AltTimeRange\": alt_time_range,\n\nThis is default expression or pattern. ```any``` means\nif value is defined, and there is array with even a single defined value then return true.\n\n            \"_default\": (_) ->\n                if any(_) then _ else undefined\n\nRecall ```Type``` here means collection of expressions.\nThere only one will matching expression due to the way regex works ```\"(a|b)```,\nso you just have to find it and return it.\n\n            \"_default_type\": (_...) ->\n                if _?\n                    for item in _\n                         if item?\n                             return item\n\n            \"_default_group\": (_...) -> if _[0]? then _[0]\n","old_contents":"### This file\n\nThe logic in this file builds the date object.\n\nIf you compare this file to the ```python\/functions.py``` file\nyou'll notice they are very similiar. That's intentional,\nthis file was ported over and kept such that it would be somewhat\neasy to port changes back and forth.\n\n### Terminology\n\nBecause it's so confusing here is a list of the different levels to refer to:\n\n- Groups \n  -- This is the capture groups. The lowest level. ```([0-9])``` etc.\n  \"Day\", \"Month\", etc.\n- Expressions \n  -- This is an expression with multiple capture groups. They're usually named\n  after the person that wrote them. \"Greg Burns\", etc.\n  \n  In Python, Expressions functions have nice named arguments, def expr(Day, Month, Year),\n  but Javascript doesn't support this.\n- Type\n  -- This is a collection of expressions with a common goal.\n  Months (Jan, 0-12, January, etc.). \n- Patterns\n  -- This is a collection of types ```<Month>\/<Day>\/<Year>```\n\n### Warning\n\nA note about the above list. Types and Groups are commonly mixed up.\nI think groups SHOULD be the lowest \n(because they are the actual capture *groups* in regular expressions)\nbut a group of expressions also makes sense.\n\nIt's so confusing that there are at least a couple places here that I've\nalso mixed myself up and probably in the documentation for RE|PARSE as well.\n\n---\n\nI use named tuples in python, and ```_replace``` mirrors the functionality of \n```date._replace```.. that is that it returns a copy of the date with only\ncertain things changed and leaves the old well enough alone.\n\n        _replace = (_old, _new) ->\n            year:   if _new.year? then _new.year else _old.year\n            month:  if _new.month? then _new.month else _old.month\n            day:    if _new.day? then _new.day  else _old.day\n            hour:   if _new.hour? then _new.hour else _old.hour\n            minute: if _new.minute? then _new.minute else _old.minute\n            second: if _new.second? then _new.second else _old.second\n            am_pm:  if _new.am_pm? then _new.am_pm else _old.am_pm\n\nI represent lengths of dates (i.e. Thursday, 1-2pm) with a timedelta that goes right\nafter the date hash in the result array.\n\nIn Javascript, I'm just going to represent a timedelta with a hash.\nI make a pretty dumb assumption that timedelta will only cross hour\/minutes\/second boundaries.\n\n        timedelta_from_Date = (start_time, end_time) ->\n            seconds_difference = 0\n            if start_time.hour? and end_time.hour?\n              seconds_difference += 60*60*(end_time.hour - start_time.hour)\n\n              if start_time.minute? and end_time.minute?\n                seconds_difference += 60*(end_time.minute - start_time.minute)\n\n                if start_time.second? and end_time.second?\n                  seconds_difference += end_time.second - start_time.second\n\n            hours = Math.floor(seconds_difference\/60\/60)\n            minutes = Math.floor(seconds_difference\/60) - (hours * 60)\n            seconds = seconds_difference - (minutes * 60) - (hours * 60 * 60)\n\n            return {\n               timedelta: true\n               hours: hours\n               minutes: minutes\n               seconds: seconds\n            }\n\n\nThis is just a helper function\n\n        in_array = (arr, _) -> arr.indexOf(_) != -1\n\n```progressive_match``` is useful for matching abbreviations\nand full spellings. Functions like this could be useful\nto help parse fuzzy matches in the future (i.e. misspellings of months).\n\n        progressive_match = (string, possibilities) ->\n            part = \"\"\n            if not string? then return\n            for character in string.toLowerCase()\n                part += character\n                matches = []\n                for month, value of possibilities\n                    if month.indexOf(part) > -1\n                        matches.push(month)\n                if matches.length == 1\n                    return possibilities[matches[0]]\n### Types\n\n\n        month_to_number = (month_string) ->\n          months =\n              \"january\": 1\n              \"february\": 2\n              \"march\": 3\n              \"april\": 4\n              \"may\": 5\n              \"june\": 6\n              \"july\": 7\n              \"august\": 8\n              \"september\": 9\n              \"october\": 10\n              \"november\": 11\n              \"december\": 12\n           return progressive_match(month_string, months)\n\n        weekday_to_number = (WeekdayString ) ->\n            weekday_list = {\n                \"monday\": 0,\n                \"tuesday\": 1,\n                \"wednesday\": 2,\n                \"thursday\": 3,\n                \"friday\": 4,\n                \"saturday\": 5,\n                \"sunday\": 6,\n            }\n            return progressive_match(WeekdayString, weekday_list)\n\nI serialize am_pm by converting the hours to milliary\/24-hour time format.\nI also include ```am_pm: 'pm'``` in the date format to show that that transformation\nwas done. Making that clear helpful because if you get a time like 1, with no ```am_pm```\ndesignation you might want to assume pm and add 12. This is not done in the libary because\ndate_machine strives for honesty, not guesswork.\n\n        am_pm = (input) ->\n            if not input?\n              return\n            if input.toLowerCase() == \"am\" then 0\n            else if input.toLowerCase() == \"pm\" then 12\n\nI try not to repeat logic and use other functions when possible.\nI could put ```\"Steve Valaitis2\": time_expression``` to avoid this,\nbut I wrote it out to show that nothing special happens with 24-hour\/military time.\n\n        military_time = (MilHour, MilMinute, MilSecond ) ->\n            return time_expression(MilHour, MilMinute, MilSecond, undefined)\n\nHere is the am\/pm conversion. I omit returns when the expressions are simple,\nbut later on I want to use them as much as possible to make my intentions clear.\n\n        noon = (hour, AMPM) -> hour == 12 and AMPM == 12\n        midnight = (hour, AMPM) -> hour == 12 and AMPM == 0\n\nThis function gets called pretty often, I'd consider it the bulk\nof the output logic.\n\n        time_expression = (Hour, Minute, Second, AMPM, SpecialTimeText ) ->\n            if not Hour? and not Minute? and not Second? and not AMPM? and not SpecialTimeText?\n                return\n            if SpecialTimeText\n                if SpecialTimeText.toLowerCase() == \"noon\"\n                    return {hour: 12}\n                if SpecialTimeText.toLowerCase() == \"midnight\"\n                    return {hour: 0}\n            d = {}\n            if Hour\n                d.hour = Number(Hour)\n            if Minute\n                d.minute = Number(Minute)\n            if Second\n                d.second = Number(Second)\n            if AMPM?\n                if d.hour\n                    if noon(d.hour, AMPM)\n                        d.hour = 12\n                    else if midnight(d.hour, AMPM)\n                        d.hour = 0\n                    else\n                        d.hour = d.hour + AMPM\n                d.am_pm = AMPM\n            if [d.hour, d.minute, d.second] == [undefined, undefined, undefined]\n                return undefined\n            return d\n\n        time_and_time = (Hour, Minute, AMPM1, Hour2, Minute2, AMPM2) ->\n            if AMPM2?\n                AMPM2 = am_pm(AMPM2)\n            if not AMPM1? and not AMPM2?\n                return [time_expression(Hour, Minute), time_expression(Hour2, Minute2)]\n            else if not AMPM1?\n                return [time_expression(Hour, Minute, undefined, AMPM2),\n                        time_expression(Hour2, Minute2, undefined, AMPM2)]\n            else if not AMPM2?\n                return [time_expression(Hour, Minute, undefined, AMPM1),\n                        time_expression(Hour2, Minute2, undefined, AMPM1)]\n\n\n        month_type = (input...) ->\n            for value in input\n                if value?\n                    return Number(value)\n\n\n        date_number = (Day, Abbr) -> if Day? then Number(Day)\n\n        month_number = (MonthNum) -> Number(MonthNum)\n\n        month_num_type = (input) -> Number(input)\n\n        year = (Year) -> if Year? then Number(Year)\n\nSometimes the value is ```[undefined, undefined, <value>]```,\nso I need to search for it and find it. There's enough\nof these smaller expressions scattered around that moving them\nall to one place might be good.\n\n        get_first_defined = (_) ->\n          for item in _\n            if item?\n              return item\n\n### Patterns\n\nThere's a some unwrapping values out of arrays here.\nBecause there's no named-arguments, functions receive a lot more\narrays here then in Python and so they need to be unwrapped.\n\n        weekday_range_with_time = (time1, time2, [weekday1], [weekday2], MonthRange) ->\n            output = []\n\n            # Get first undefined value\n            # Since only one value in list will be defined (if any)\n            time1 = get_first_defined(time1)\n            time2 = get_first_defined(time2)\n\n            if time1?\n                for date in MonthRange\n                    output.push(_replace(date, time1))\n                    if time2?\n                        output.push(_replace(date, time2))\n            return output\n\n\n        weekday_range_with_extra = ( time, and_time, weekday_start, weekday_end, extra_time, extra_weekday, MonthRange) ->\n            output = []\n            if time?\n                for date in MonthRange\n                    if date.weekday?\n                        if date.weekday in [weekday_start .. weekday_end]\n                            output.push(_replace(date, time))\n                            if and_time?\n                                output.push(_replace(date, and_time))\n                        if date.weekday == extra_weekday\n                            output.push(_replace(date, extra_time))\n            return output\n\n\n        weekday_range_with_extra_backwards = (extra_time, extra_weekday, time, weekday_start, weekday_end, MonthRange ) ->\n            return weekday_range_with_extra(time[0], time[1], weekday_start, weekday_end, extra_time, extra_weekday, MonthRange )\n\n\n        reverse_basic_text = (time, day, month, year) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        basic_text = (time, first_second, weekday, month, day, year) ->\n            if not day?\n                day = 1\n            if (day instanceof Array) and day.length == 1\n              day = day[0]\n            if (year instanceof Array) and year.length == 1\n              year = year[0]\n            if not time?\n                return {year: year, month: month, day: day}\n            else\n                year: year\n                month: month\n                day: day\n                hour: time.hour\n                minute: time.minute\n                second: time.second\n                am_pm: time.am_pm\n\n\n        slash = (month, day, year, time) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        month_range = (month, date_a, date_b) ->\n            output = []\n            for day in [date_a .. date_b]\n                output.push(basic_text(undefined, undefined, undefined, month, day, undefined))\n            return output\n\n\n        multi_time = (time1, BasicText) ->\n            output = []\n            if time1? and BasicText?\n                output.push(_replace(BasicText, time1))\n                output.push(BasicText)\n                return output\n\n\n        large_repeat_words = ->\n            return undefined\n\n\n        weekday_range_with_time_range = (time1, weekday_range) ->\n            output = []\n            if time1? and weekday_range?\n                range = timedelta_from_Date(_replace(weekday_range[0], time1), weekday_range[0])\n                for weekday in weekday_range\n                    output.push(_replace(weekday, {hour:time1.hour, minute:time1.minute, am_pm:time1.am_pm}))\n                    output.push(range)\n                return output\n\n\n        time_range = (unstrict_time, strict_time, date, reverse) ->\n            endtime = date\n            starttime = endtime\n            if unstrict_time\n                starttime = _replace(starttime, {hour:Number(unstrict_time[0])})\n                if date.am_pm\n                    starttime = _replace(starttime, {hour: starttime.hour + date.am_pm, am_pm:date.am_pm})\n            else\n                starttime = _replace(starttime, {hour: strict_time.hour, minute: strict_time.minute})\n\n            time_range = timedelta_from_Date(starttime, endtime)\n            if reverse\n                time_range = timedelta_from_Date(endtime, starttime)\n            return [starttime, time_range]\n\n\n        alt_time_range = (first_second, weekday, month, day, year, time, unstrict_time, strict_time) ->\n            return time_range(unstrict_time, strict_time, basic_text(time, first_second, weekday, month, day, year), reverse)\n\n\n        until_range = (date1, date2) ->\n            if date1 and date2\n                return [date1, timedelta_from_Date(date1, date2)]\n\n\n        through_range = (time, weekday1, weekday2, month, date, beginning) ->\n            output = []\n            if month and date and beginning and weekday1\n                ending =\n                    month: month\n                    day: date\n                for day in [beginning.day .. ending.day]\n                    temp =\n                        month: month\n                        day: date\n                    if temp.weekday and in_array([weekday1 .. weekday2], temp.weekday)\n                        if time\n                            output.push(_replace(temp, time))\n                        else\n                            output.push(temp)\n                return output\n\n\n### The function list\n\nThis hash\/object matches all the functions with a\nstring that represents it in the parse tree.\n\n        functions =\n            # Groups\n            \"MonthString\": month_to_number,\n            \"AMPM\": am_pm,\n            # Expressions\n            \"Chase Year\": year,\n            \"Chase Date\": date_number,\n            \"Chase Month\": month_number,\n            \"Steve Valaitis\": time_expression,\n            \"Greg Burns\": (hour, am_pm) -> time_expression(hour, null, null, am_pm, null),\n            \"Greg Burns UnstrictTime:\": time_expression,\n            \"Steve Valaitis2\": military_time,\n            \"Steve Valaitis And Time\": time_and_time,\n            \"Text Parts\": time_expression,\n            \"Michael Ash10\": weekday_to_number,\n            # Types\n            \"Month\": month_type,\n            \"MonthNum\": month_num_type,\n            # Patterns\n            \"LargeRepeatWords\": large_repeat_words,\n            \"BasicText\": basic_text,\n            \"ReverseBasicText\": reverse_basic_text,\n            \"Slash\": slash,\n            \"MonthRange\": month_range,\n            \"MultiTime\": multi_time,\n            \"WeekdayRangeWithTime\": weekday_range_with_time,\n            \"WeekdayRangeWithExtra\": weekday_range_with_extra,\n            \"WeekdayRangeWithExtraBackwards\": weekday_range_with_extra_backwards,\n            \"WeekdayRangeWithTimeRange\": weekday_range_with_time_range,\n            \"UntilRange\": until_range,\n            \"ThroughRange\": through_range,\n            \"TimeRange\": time_range,\n            \"AltTimeRange\": alt_time_range,\n\nThis is default expression or pattern. ```any``` means\nif value is defined, and there is array with even a single defined value then return true.\n\n            \"_default\": (_) ->\n                if any(_) then _ else undefined\n\n```Type``` there is used to mean collection of expressions.\nThere only one will matching type, so you just have to find\nit and return it.\n\n            \"_default_type\": (_...) ->\n                if _?\n                    for item in _\n                         if item?\n                             return item\n\n            \"_default_group\": (_...) -> if _[0]? then _[0]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fc92d5bdd85eff4b7bbe4e3c5d3f2f657cd162eb","subject":"Docs for conjunction \/ disjunction done as a first-pass","message":"Docs for conjunction \/ disjunction done as a first-pass\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\n  class LVar\n    constructor: (@name) ->\n\n  F.lvar = (name) -> new LVar(name)\n  F.isLVar = (v) -> (v instanceof LVar)\n\n  find = (v, bindings) ->\n    lvar = bindings.lookup(v)\n    return lvar if F.isLVar(v)\n    if _.isArray(lvar)\n      if _.isEmpty(lvar)\n        return lvar\n      else\n        return _.cons(find(_.first(lvar), bindings), find(_.rest(lvar), bindings))\n    lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\n\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\n\n\n  F.conj = () ->\n    clauses = _.toArray(arguments)\n    return F.succeed if _.isEmpty(clauses)\n    return _.first(clauses) if _.size(clauses) is 1\n    conjunction(_.first(clauses),\n                (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\n  # Knowledge representation\n  # ------------------------\n\n  class LVar\n    constructor: (@name) ->\n\n  F.lvar = (name) -> new LVar(name)\n  F.isLVar = (v) -> (v instanceof LVar)\n\n  find = (v, bindings) ->\n    lvar = bindings.lookup(v)\n    return lvar if F.isLVar(v)\n    if _.isArray(lvar)\n      if _.isEmpty(lvar)\n        return lvar\n      else\n        return _.cons(find(_.first(lvar), bindings), find(_.rest(lvar), bindings))\n    lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4106cb2e685c9043dbb4010e7d9f98cf5fe8e9bd","subject":"document Batman.Validator","message":"document Batman.Validator\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.Validator\n\nbatman.js ships with a plethora of [built-in validators](\/docs\/api\/batman.model.html#class_function_validate), but when they don't meet your needs, you can create custom validators by subclassing `Batman.Validator`, implementing `Batman.Validator::validateEach`, and adding the new validator to `Batman.Validators`. For example:\n\n```coffeescript\nclass App.LessThanPropertyValidator extends Batman.Validator\n  @triggers 'lessThanProperty'\n  @options 'allowBlank'\n\n  validateEach: (errors, record, key, callback) ->\n      value = record.get(key)\n      compareKey = @options.lessThanProperty\n      otherValue = record.get(compareKey)\n      else !@handleBlank(value) && value >= otherValue\n        errors.add(key, 'must be less than #{compareKey}')\n      callback()\n\nBatman.Validators.push App.LessThanPropertyValidator\n```\n\n## ::constructor(options : Object[, mixins...])\n\nThe first argument becomes the validator's `@options`. Subsequent arguments are mixed in to the validator with `Batman.Object::mixin`. You can override this method to alter the options object before it's assigned to `@options`. (Make sure to call `super` afterwards!)\n\n## @triggers(triggers...)\n\nWhen any of the strings in `triggers` is passed to `Model@validate`:\n\n- this validator will be instantiated and its `validateEach` will be invoked\n- the key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUse this method when one validator will handle many kinds of validations. For example, a simplified length validator:\n\n```coffeescript\nclass App.SimpleLengthValidator extends Batman.Validator\n  @triggers 'minLength', 'maxLength', 'length'\n\n  constructor: (options) ->\n    # has access to options.minLength, options.maxLength, options.length\n    super\n\n  validateEach: (errors, record, key, callback) ->\n    # has access to @options.minLength, @options.maxLength, @options.length\n```\n\nAll three of these validations will be handled by `App.SimpleLengthValidator::validateEach`:\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @validate 'name', minLength: 3\n  @validate 'bio', maxLength: 250\n  @validate 'phone_number', length: 10\n```\n\n## @options(options...)\n\nThe key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUnlike `@triggers`, the presence of a key in `options` will not cause this validator to be instantiated.\n\n## ::validateEach(errors: Batman.ErrorsSet, record: Batman.Model, key: String, callback: Function)\n\nThis method is invoked to validate `key` on `record`. If this method determins that the key is invalid, it should add a validation error to `errors`.\n\n`errors` is a `Batman.ErrorsSet`, which is a [`Batman.Set`](\/docs\/api\/batman.set.html) with `::add(key, message)` as a convenience method for adding [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s. So, to easily add a new validation error:\n\n```coffeescript\nerrors.add(\"phone_number\", \"isn't 10 characters long\")\n```\n\nWhen the validator is finished, it must call `callback` to continue the validation chain.\n\n## @handleBlank(value)\n\nReturns `true` if `options.allowBlank` is `true` _and_ `value` is `null`, `undefined` or `\"\"`\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c0c4d1d44f7dc8b5311def636392b3bb9bed936e","subject":"Added\/updated examples","message":"Added\/updated examples\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/arguments.litcoffee","new_file":"lib\/arguments.litcoffee","new_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] levelname anotherlevelname yetanotherlevelname ...'\n      .example '$0',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -vvvvvvvv',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to verbosity level 8 (max)\\n\"\n      .example '$0 -w 20 -h 20',\n        \"Creates a level with default row and column counts,\n         the cells 20 units wide, 20 units high,\n         expanded by the default multiplier,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -w 10 -h 10 -x 4',\n        \"Creates a level with default row and column counts,\n         40 x 40 unit cells,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 lvl1 lvl2',\n        \"Creates two levels; named lvl1 and lvl2 -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 --levels one two three',\n        \"Creates three levels; named one, two, and three -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 -l10',\n        \"Creates ten auto-named levels -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      8\n        height:     7\n        multiplier: 4\n        pipeline:   [ 'png_blocks', 'png_walls', 'png_step_count' ]\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .wrap 120\n      .argv\n","old_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] name1 name2 ...'\n      .example '$0',\n        'Creates a 50 x 15 level with 16 x 14 cells and an auto-generated name'\n      .example '$0 -vvvvvvvv',\n        \"Create a 50 x 15 level with 16 x 14 cells, an auto-generated name, and\n        logging set to verbosity level 8 (max)\"\n      .example '$0 -w 20 -h 20',\n        'Creates a 50 x 15 level with 40 X 40 cells & an auto-generated name'\n      .example '$0 -w 10 -h 10 -x 4',\n        'Creates a 50 x 15 level with 40 x 40 cells and an auto-generated name'\n      .example '$0 lvl1 lvl2',\n        'Creates two levels, lvl1 & lvl2, each 50 X 15 with 16 x 14 cells'\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      8\n        height:     7\n        multiplier: 4\n        pipeline:   [ 'png_blocks', 'png_walls', 'png_step_count' ]\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .wrap 120\n      .argv\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2c4c063788a942ee01cc4b82cf63d6ee00b03d7d","subject":"Clean","message":"Clean\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-grunt\/dox\/dynamic.litcoffee","new_file":"packages\/shrub-grunt\/dox\/dynamic.litcoffee","new_contents":"# Grunt build process - Dynamic documentation\n\n    {exec} = require 'child_process'\n    fs = require 'fs'\n    path = require 'path'\n    {Transform} = require 'stream'\n\n    _ = require 'lodash'\n    {LineStream} = require 'byline'\n    glob = require 'grunt\/node_modules\/glob'\n    Promise = require 'bluebird'\n\nImplement a Transform stream to accumulate hook invocations from a source file.\n\n    class HookInvocations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Invoke hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream to accumulate hook implementations from a source\nfile.\n\n    class HookImplementations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Implements hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream fo accumulate TODOs from a source file. Also\ncaches lines to be able to build context around each TODO item.\n\n    class Todos extends Transform\n\n      @context = 4\n\n      constructor: ->\n        super\n\n        @lines = []\n        @todos = []\n\n      _transform: (chunk, encoding, done) ->\n        @lines.push line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\#\\#\\# TODO\/\n          @todos.push @lines.length - 1\n\n        done()\n\n      withContext: ->\n\n        for todo in @todos\n\n          start = Math.max 0, todo - Todos.context\n          end = Math.min @lines.length - 1, todo + Todos.context\n\n          index: todo\n          lines: @lines.slice start, end\n\nGather all source files.\n\n    _allSourceFiles = ->\n      new Promise (resolve, reject) ->\n        glob(\n          '{{client,custom,packages,server}\/**\/*.litcoffee,*.litcoffee}'\n          (error, files) ->\n            return reject error if error?\n            resolve files\n        )\n\nGenerate an HTML ID from a string.\n\n    _idFromString = (string) -> string.replace(\n      \/[\/'']\/g, ''\n    ).replace(\n      \/\\[(.*)\\]\\(.*\\)\/g, '$1'\n    ).replace(\n      \/[^0-9A-Za-z-]+\/g, '-'\n    ).replace(\n      \/\\-+\/g, '-'\n    ).toLowerCase()\n\nGet the source path from a filename. This removes the extension and any \/index\nportion from the end of the filename.\n\n    _sourcePath = (filename) ->\n\n        dirname = path.dirname filename\n        if dirname is '.' then dirname = '' else dirname += '\/'\n        extname = path.extname filename\n        filename = \"#{dirname}#{path.basename filename, extname}\"\n\n        parts = filename.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'index'\n        return parts.join '\/'\n\nCollate a list of files by type (client or server).\n\n    _collateFilesByType = (files) ->\n\n      client = []\n      server = []\n\n      for file in files\n        parts = file.split '\/'\n\n        if parts[0] is 'client'\n          client.push file\n        else if parts[0] is 'custom' and parts[2] is 'client'\n          client.push file\n        else if parts[0] is 'packages' and parts[2] is 'client'\n          client.push file\n        else\n          server.push file\n\n      client: client, server: server\n\nGather statistics for all files.\n\n    fileStatsListPromise = _allSourceFiles().then (allFiles) ->\n\n      allFilesPromises = for type, files of _collateFilesByType allFiles\n\n        typePromises = for file in files\n\n          do (type, file) -> new Promise (resolve, reject) ->\n\n            fstream = fs.createReadStream file\n            fstream.pipe lineStream = new LineStream keepEmptyLines: true\n\nPass all files through the Transform list to parse out relevant information.\n\n            lineStream.pipe hookImplementations = new HookImplementations()\n            lineStream.pipe hookInvocations = new HookInvocations()\n            lineStream.pipe todos = new Todos()\n\n            fstream.on 'error', reject\n\n            fstream.on 'end', ->\n\nInclude all information from Transform streams in the statistics.\n\n              resolve(\n                type: type\n                file: file\n                implementations: hookImplementations.list\n                invocations: hookInvocations.list\n                todos: todos.withContext()\n              )\n\n        Promise.all typePromises\n\n      Promise.all(allFilesPromises).then (fileStatsLists) ->\n        _.flatten fileStatsLists\n\nMassage the statistics to help rendering the hooks page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      hooksIndex = {}\n\n      indexes = {}\n      keys = ['implementations', 'invocations']\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        for remove in ['client', 'packages']\n          if ~(index = parts.indexOf remove)\n            parts.splice index, 1\n        mergeFile = parts.join '\/'\n\n        for key in keys\n          indexes[key] ?= {}\n\n          for hook in fileStats[key]\n            indexes[key][hook] ?= {}\n\n            indexes[key][hook][mergeFile] ?= fullName: fileStats.file\n            (indexes[key][hook][mergeFile].types ?= []).push fileStats.type\n\n            hooksIndex[hook] = true\n\n      for key in keys\n        for hook, stats of indexes[key]\n          for file of stats\n            stats[file].types = _.unique stats[file].types ? []\n\n      hooks = (hook for hook of hooksIndex).sort()\n\n      hookFiles = {}\n      for hook in hooks\n        hookFiles[hook] = try\n          fs.readFileSync \"docs\/hook\/#{hook}.md\", 'utf8'\n        catch error\n          ''\n\n      O =\n        hookFiles: hookFiles\n        hooks: hooks\n\n      O[key] = indexes[key] for key in keys\n\n      return O\n\nRender the hooks page.\n\n    ).then((O) ->\n\n      {hookFiles, hooks} = O\n\n      keys = ['implementation', 'invocation']\n\n      wordingFor =\n        implementation: 'implements'\n        invocation: 'invoke'\n\n      render = fs.readFileSync 'docs\/hooks.template.md', 'utf8'\n\n      for hook in hooks\n\n        render += \"## #{hook}\\n\\n\"\n        render += hookFiles[hook] + '\\n\\n' if hookFiles[hook]\n\n        for key in keys\n          pluralKey = \"#{key}s\"\n\n          if O[pluralKey][hook]?\n\n            count = 0\n            for file, {types} of O[pluralKey][hook]\n              count += types.length\n\n            render += '<div class=\"admonition note\">'\n            render += \"<p class=\\\"admonition-title\\\">#{count} #{key}\"\n            render += 's' if count > 1\n            render += '<\/p>\\n'\n            render += '  <table>\\n'\n\n            stripe = 0\n            instances = for file, {fullName, types} of O[pluralKey][hook]\n\nRemove packages and file part.\n\n              parts = fullName.split '\/'\n              parts.shift()\n              parts.pop()\n              packageName = parts.join '\/'\n\n              types = types.map (type) ->\n                \"    <tr class=\\\"#{if stripe++ % 2 then 'odd' else 'even'}\\\"><td><a href=\\\"source\/#{_sourcePath fullName}\\\">#{_sourcePath file} (#{type})<\/a><\/td><td align=\\\"right\\\"><a href=\\\"source\/#{_sourcePath fullName}##{wordingFor[key]}-hook-#{_idFromString hook}\\\">#{key}<\/a><\/td><\/tr>\"\n              types.join ''\n\n            render += instances.join ''\n\n            render += '  <\/table>\\n'\n            render += '<\/div>'\n            render += '\\n\\n'\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/hooks.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nRender the TODOs page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/todos.template.md', 'utf8'\n\n      for fileStats in fileStatsList\n\nKeep track of used IDs, it will be necessary to link to the correct location\nhash in the case of multiple TODO items with the same wording.\n\n        idMap = {}\n\n        for todo in fileStats.todos\n\n          render += '\\n'\n\n          id = ''\n          for line, index in todo.lines\n\nIf this is the line with the TODO, parse the ID from the TODO item text, and\nrender it as h2 (TODO are h6) to increase visibility.\n\n            if index is Todos.context\n              id = _idFromString(line).slice 1, -1\n\n              render += line.slice 4\n            else\n              render += '    '\n              render += \" #{line}\"\n            render += '\\n'\n\n          render += '\\n'\n\n          filename = _sourcePath fileStats.file\n\nKeep track of ID usage and modify the location hash for subsequent uses.\n\n          if idMap[id]?\n            idMap[id] += 1\n            id += \"_#{idMap[id]}\"\n          else\n            idMap[id] = 0\n\n          render += \"[the above found in #{fileStats.file}:#{todo.index}](source\/#{filename}##{id})\\n\"\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/todos.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nAdd all the source files to a generated mkdocs.yml\n\n    _allSourceFiles().then (files) ->\n\n      yml = fs.readFileSync 'docs\/mkdocs.template.yml', 'utf8'\n\n      for file in files\n        parts = file.split '\/'\n\n        for i in [0...parts.length]\n          try\n            fs.mkdirSync \"docs\/source\/#{parts.slice(0, i).join '\/'}\"\n          catch error\n\n        fs.createReadStream(file).pipe(\n          fs.createWriteStream(\"docs\/source\/#{file}\")\n        )\n\nAdd them under the 'Source code' path.\n\n        yml += \"- [source\/#{file}, 'Source code', '#{file}']\\n\"\n\n      fs.writeFileSync 'mkdocs.yml', yml\n\n      return\n\nRender the packages page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\nSort by package name first.\n\n      newList = []\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        continue unless ~['custom', 'packages'].indexOf parts[0]\n\n        sourcePath = _sourcePath fileStats.file\n\n        parts = sourcePath.split '\/'\n        pkg = parts.join '\/'\n        fileStats.pkg = pkg.split('\/').slice(1).join '\/'\n\n        newList.push fileStats\n\n      newList.sort (l, r) ->\n        return -1 if l.type is 'client' and r.type is 'server'\n        return 1 if l.type is 'server' and r.type is 'client'\n        if l.pkg < r.pkg then -1 else if l.pkg > r.pkg then 1 else 0\n\n    ).then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/packages.template.md', 'utf8'\n      render += '\\n'\n\n      type = null\n\n      for fileStats in fileStatsList\n\n        if fileStats.type isnt type\n          type = fileStats.type\n\n          render += if type is 'client'\n            '## Client-side'\n          else\n            '## Server-side'\n\n          render += '\\n\\n'\n\n        pkgParts = fileStats.pkg.split '\/'\n        isSubpackage = pkgParts.length isnt 1 and pkgParts.pop() isnt 'client'\n\nLink to the package.\n\n        sourcePath = _sourcePath fileStats.file\n\n        if isSubpackage\n          render += '> '\n          parts = fileStats.pkg.split '\/'\n          parentPkg = parts.shift()\n          subPkg = parts.join '\/'\n          render += \"## [<small>#{parentPkg}\/<\/small>#{subPkg}](source\/#{sourcePath})\"\n        else\n          render += \"## [#{fileStats.pkg}](source\/#{sourcePath})\"\n\nNaively parse out the file description. It must be wrapped in asterisks, i.e.\nitalicized in markdown.\n\n###### TODO: This 'chunk' parsing should be done with a Transform like the others.\n\n        data = fs.readFileSync fileStats.file, 'utf8'\n        chunks = data.split '\\n\\n'\n\n        title = chunks[0]\n        if 35 is title.charCodeAt 0\n          render += '\\n\\n'\n          render += '> ' if isSubpackage\n          render += \"<span class=\\\"package-title\\\">#{title.substr 2}<\/span>\"\n\n        render += '\\n\\n'\n\n        description = chunks[1]\n        if 42 is description.charCodeAt 0 and 42 is description.charCodeAt description.length - 1\n          render += '> ' if isSubpackage\n          render += \"#{description}\\n\\n\"\n\n        if fileStats.implementations.length > 0\n          render += '> ' if isSubpackage\n          render += '<div class=\"admonition note\">'\n          render += '<p class=\"admonition-title\">Implements hooks<\/p>'\n          render += '  <table>\\n'\n          render += fileStats.implementations.map((hook, index) ->\n            \"    <tr class=\\\"#{if index % 2 then 'odd' else 'even'}\\\"><td><a href=\\\"hooks\/##{_idFromString hook}\\\">#{hook}<\/a><\/td><td align=\\\"right\\\"><a href=\\\"source\/#{sourcePath}#implements-hook-#{hook.toLowerCase()}\\\">implementation<\/a><\/td><\/tr>\\n\"\n          ).join ''\n          render += '  <\/table>\\n'\n          render += '<\/div>'\n          render += '\\n\\n'\n\n        if fileStats.invocations.length > 0\n          render += '> ' if isSubpackage\n          render += '<div class=\"admonition note\">'\n          render += '<p class=\"admonition-title\">Implements hooks<\/p>'\n          render += '  <table>\\n'\n          render += fileStats.implementations.map((hook, index) ->\n            \"    <tr class=\\\"#{if index % 2 then 'odd' else 'even'}\\\"><td><a href=\\\"hooks\/##{_idFromString hook}\\\">#{hook}<\/a><\/td><td align=\\\"right\\\"><a href=\\\"source\/#{sourcePath}#invoke-hook-#{hook.toLowerCase()}\\\">invocation<\/a><\/td><\/tr>\\n\"\n          ).join ''\n          render += '  <\/table>\\n'\n          render += '<\/div>'\n          render += '\\n\\n'\n\n###### TODO: We should do some preprocessing hre with a transform, namely linking the hook headers to their respective documentation.\n\n      fs.writeFileSync 'docs\/packages.md', render\n\n    )\n","old_contents":"# Grunt build process - Dynamic documentation\n\n    {exec} = require 'child_process'\n    fs = require 'fs'\n    path = require 'path'\n    {Transform} = require 'stream'\n\n    _ = require 'lodash'\n    {LineStream} = require 'byline'\n    glob = require 'grunt\/node_modules\/glob'\n    Promise = require 'bluebird'\n\nImplement a Transform stream to accumulate hook invocations from a source file.\n\n    class HookInvocations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Invoke hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream to accumulate hook implementations from a source\nfile.\n\n    class HookImplementations extends Transform\n\n      constructor: ->\n        super\n\n        @list = []\n\n      _transform: (chunk, encoding, done) ->\n        line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\# Implements hook `([^`]+)`\/\n          @list.push matches[1]\n\n        done()\n\nImplement a Transform stream fo accumulate TODOs from a source file. Also\ncaches lines to be able to build context around each TODO item.\n\n    class Todos extends Transform\n\n      @context = 4\n\n      constructor: ->\n        super\n\n        @lines = []\n        @todos = []\n\n      _transform: (chunk, encoding, done) ->\n        @lines.push line = chunk.toString('utf8')\n        if matches = line.match \/^\\#\\#\\#\\#\\#\\# TODO\/\n          @todos.push @lines.length - 1\n\n        done()\n\n      withContext: ->\n\n        for todo in @todos\n\n          start = Math.max 0, todo - Todos.context\n          end = Math.min @lines.length - 1, todo + Todos.context\n\n          index: todo\n          lines: @lines.slice start, end\n\nGather all source files.\n\n    _allSourceFiles = ->\n      new Promise (resolve, reject) ->\n        glob(\n          '{{client,custom,packages,server}\/**\/*.litcoffee,*.litcoffee}'\n          (error, files) ->\n            return reject error if error?\n            resolve files\n        )\n\nGenerate an HTML ID from a string.\n\n    _idFromString = (string) -> string.replace(\n      \/[\/'']\/g, ''\n    ).replace(\n      \/\\[(.*)\\]\\(.*\\)\/g, '$1'\n    ).replace(\n      \/[^0-9A-Za-z-]+\/g, '-'\n    ).replace(\n      \/\\-+\/g, '-'\n    ).toLowerCase()\n\nGet the source path from a filename. This removes the extension and any \/index\nportion from the end of the filename.\n\n    _sourcePath = (filename) ->\n\n        dirname = path.dirname filename\n        if dirname is '.' then dirname = '' else dirname += '\/'\n        extname = path.extname filename\n        filename = \"#{dirname}#{path.basename filename, extname}\"\n\n        parts = filename.split '\/'\n        parts.pop() if parts[parts.length - 1] is 'index'\n        return parts.join '\/'\n\nCollate a list of files by type (client or server).\n\n    _collateFilesByType = (files) ->\n\n      client = []\n      server = []\n\n      for file in files\n        parts = file.split '\/'\n\n        if parts[0] is 'client'\n          client.push file\n        else if parts[0] is 'custom' and parts[2] is 'client'\n          client.push file\n        else if parts[0] is 'packages' and parts[2] is 'client'\n          client.push file\n        else\n          server.push file\n\n      client: client, server: server\n\nGather statistics for all files.\n\n    fileStatsListPromise = _allSourceFiles().then (allFiles) ->\n\n      allFilesPromises = for type, files of _collateFilesByType allFiles\n\n        typePromises = for file in files\n\n          do (type, file) -> new Promise (resolve, reject) ->\n\n            fstream = fs.createReadStream file\n            fstream.pipe lineStream = new LineStream keepEmptyLines: true\n\nPass all files through the Transform list to parse out relevant information.\n\n            lineStream.pipe hookImplementations = new HookImplementations()\n            lineStream.pipe hookInvocations = new HookInvocations()\n            lineStream.pipe todos = new Todos()\n\n            fstream.on 'error', reject\n\n            fstream.on 'end', ->\n\nInclude all information from Transform streams in the statistics.\n\n              resolve(\n                type: type\n                file: file\n                implementations: hookImplementations.list\n                invocations: hookInvocations.list\n                todos: todos.withContext()\n              )\n\n        Promise.all typePromises\n\n      Promise.all(allFilesPromises).then (fileStatsLists) ->\n        _.flatten fileStatsLists\n\nMassage the statistics to help rendering the hooks page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      hooksIndex = {}\n\n      indexes = {}\n      keys = ['implementations', 'invocations']\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        for remove in ['client', 'packages']\n          if ~(index = parts.indexOf remove)\n            parts.splice index, 1\n        mergeFile = parts.join '\/'\n\n        for key in keys\n          indexes[key] ?= {}\n\n          for hook in fileStats[key]\n            indexes[key][hook] ?= {}\n\n            indexes[key][hook][mergeFile] ?= fullName: fileStats.file\n            (indexes[key][hook][mergeFile].types ?= []).push fileStats.type\n\n            hooksIndex[hook] = true\n\n      for key in keys\n        for hook, stats of indexes[key]\n          for file of stats\n            stats[file].types = _.unique stats[file].types ? []\n\n      hooks = (hook for hook of hooksIndex).sort()\n\n      hookFiles = {}\n      for hook in hooks\n        hookFiles[hook] = try\n          fs.readFileSync \"docs\/hook\/#{hook}.md\", 'utf8'\n        catch error\n          ''\n\n      O =\n        hookFiles: hookFiles\n        hooks: hooks\n\n      O[key] = indexes[key] for key in keys\n\n      return O\n\nRender the hooks page.\n\n    ).then((O) ->\n\n      {hookFiles, hooks} = O\n\n      keys = ['implementation', 'invocation']\n\n      wordingFor =\n        implementation: 'implements'\n        invocation: 'invoke'\n\n      render = fs.readFileSync 'docs\/hooks.template.md', 'utf8'\n\n      for hook in hooks\n\n        render += \"## #{hook}\\n\\n\"\n        render += hookFiles[hook] + '\\n\\n' if hookFiles[hook]\n\n        for key in keys\n          pluralKey = \"#{key}s\"\n\n          if O[pluralKey][hook]?\n\n            count = 0\n            for file, {types} of O[pluralKey][hook]\n              count += types.length\n\n            render += '<div class=\"admonition note\">'\n            render += \"<p class=\\\"admonition-title\\\">#{count} #{key}\"\n            render += 's' if count > 1\n            render += '<\/p>\\n'\n            render += '  <table>\\n'\n\n            # render += \"!!! note \\\"#{count} #{key}\"\n            # render += 's' if count > 1\n            # render += '\"\\n'\n\n            stripe = 0\n            instances = for file, {fullName, types} of O[pluralKey][hook]\n\nRemove packages and file part.\n\n              parts = fullName.split '\/'\n              parts.shift()\n              parts.pop()\n              packageName = parts.join '\/'\n\n              types = types.map (type) ->\n                \"    <tr class=\\\"#{if stripe++ % 2 then 'odd' else 'even'}\\\"><td><a href=\\\"source\/#{_sourcePath fullName}\\\">#{_sourcePath file} (#{type})<\/a><\/td><td align=\\\"right\\\"><a href=\\\"source\/#{_sourcePath fullName}##{wordingFor[key]}-hook-#{_idFromString hook}\\\">#{key}<\/a><\/td><\/tr>\"\n              types.join ''\n\n            render += instances.join ''\n\n            render += '  <\/table>\\n'\n            render += '<\/div>'\n            render += '\\n\\n'\n\n\n            render += '\\n\\n'\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/hooks.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nRender the TODOs page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/todos.template.md', 'utf8'\n\n      for fileStats in fileStatsList\n\nKeep track of used IDs, it will be necessary to link to the correct location\nhash in the case of multiple TODO items with the same wording.\n\n        idMap = {}\n\n        for todo in fileStats.todos\n\n          render += '\\n'\n\n          id = ''\n          for line, index in todo.lines\n\nIf this is the line with the TODO, parse the ID from the TODO item text, and\nrender it as h2 (TODO are h6) to increase visibility.\n\n            if index is Todos.context\n              id = _idFromString(line).slice 1, -1\n\n              render += line.slice 4\n            else\n              render += '    '\n              render += \" #{line}\"\n            render += '\\n'\n\n          render += '\\n'\n\n          filename = _sourcePath fileStats.file\n\nKeep track of ID usage and modify the location hash for subsequent uses.\n\n          if idMap[id]?\n            idMap[id] += 1\n            id += \"_#{idMap[id]}\"\n          else\n            idMap[id] = 0\n\n          render += \"[the above found in #{fileStats.file}:#{todo.index}](source\/#{filename}##{id})\\n\"\n\n      new Promise (resolve, reject) ->\n        fs.writeFile 'docs\/todos.md', render, (error) ->\n          return reject error if error?\n          resolve()\n\n    ).done()\n\nAdd all the source files to a generated mkdocs.yml\n\n    _allSourceFiles().then (files) ->\n\n      yml = fs.readFileSync 'docs\/mkdocs.template.yml', 'utf8'\n\n      for file in files\n        parts = file.split '\/'\n\n        for i in [0...parts.length]\n          try\n            fs.mkdirSync \"docs\/source\/#{parts.slice(0, i).join '\/'}\"\n          catch error\n\n        fs.createReadStream(file).pipe(\n          fs.createWriteStream(\"docs\/source\/#{file}\")\n        )\n\nAdd them under the 'Source code' path.\n\n        yml += \"- [source\/#{file}, 'Source code', '#{file}']\\n\"\n\n      fs.writeFileSync 'mkdocs.yml', yml\n\n      return\n\nRender the packages page.\n\n    fileStatsListPromise.then((fileStatsList) ->\n\nSort by package name first.\n\n      newList = []\n\n      for fileStats in fileStatsList\n\n        parts = fileStats.file.split '\/'\n        continue unless ~['custom', 'packages'].indexOf parts[0]\n\n        sourcePath = _sourcePath fileStats.file\n\n        parts = sourcePath.split '\/'\n        pkg = parts.join '\/'\n        fileStats.pkg = pkg.split('\/').slice(1).join '\/'\n\n        newList.push fileStats\n\n      newList.sort (l, r) ->\n        return -1 if l.type is 'client' and r.type is 'server'\n        return 1 if l.type is 'server' and r.type is 'client'\n        if l.pkg < r.pkg then -1 else if l.pkg > r.pkg then 1 else 0\n\n    ).then((fileStatsList) ->\n\n      render = fs.readFileSync 'docs\/packages.template.md', 'utf8'\n      render += '\\n'\n\n      type = null\n\n      for fileStats in fileStatsList\n\n        if fileStats.type isnt type\n          type = fileStats.type\n\n          render += if type is 'client'\n            '## Client-side'\n          else\n            '## Server-side'\n\n          render += '\\n\\n'\n\n        pkgParts = fileStats.pkg.split '\/'\n        isSubpackage = pkgParts.length isnt 1 and pkgParts.pop() isnt 'client'\n\nLink to the package.\n\n        sourcePath = _sourcePath fileStats.file\n\n        if isSubpackage\n          render += '> '\n          parts = fileStats.pkg.split '\/'\n          parentPkg = parts.shift()\n          subPkg = parts.join '\/'\n          render += \"## [<small>#{parentPkg}\/<\/small>#{subPkg}](source\/#{sourcePath})\"\n        else\n          render += \"## [#{fileStats.pkg}](source\/#{sourcePath})\"\n\nNaively parse out the file description. It must be wrapped in asterisks, i.e.\nitalicized in markdown.\n\n###### TODO: This 'chunk' parsing should be done with a Transform like the others.\n\n        data = fs.readFileSync fileStats.file, 'utf8'\n        chunks = data.split '\\n\\n'\n\n        title = chunks[0]\n        if 35 is title.charCodeAt 0\n          render += '\\n\\n'\n          render += '> ' if isSubpackage\n          render += \"<span class=\\\"package-title\\\">#{title.substr 2}<\/span>\"\n\n        render += '\\n\\n'\n\n        description = chunks[1]\n        if 42 is description.charCodeAt 0 and 42 is description.charCodeAt description.length - 1\n          render += '> ' if isSubpackage\n          render += \"#{description}\\n\\n\"\n\n        if fileStats.implementations.length > 0\n          render += '> ' if isSubpackage\n          render += '<div class=\"admonition note\">'\n          render += '<p class=\"admonition-title\">Implements hooks<\/p>'\n          render += '  <table>\\n'\n          render += fileStats.implementations.map((hook, index) ->\n            \"    <tr class=\\\"#{if index % 2 then 'odd' else 'even'}\\\"><td><a href=\\\"hooks\/##{_idFromString hook}\\\">#{hook}<\/a><\/td><td align=\\\"right\\\"><a href=\\\"source\/#{sourcePath}#implements-hook-#{hook.toLowerCase()}\\\">implementation<\/a><\/td><\/tr>\\n\"\n          ).join ''\n          render += '  <\/table>\\n'\n          render += '<\/div>'\n          render += '\\n\\n'\n\n        if fileStats.invocations.length > 0\n          render += '> ' if isSubpackage\n          render += '<div class=\"admonition note\">'\n          render += '<p class=\"admonition-title\">Implements hooks<\/p>'\n          render += '  <table>\\n'\n          render += fileStats.implementations.map((hook, index) ->\n            \"    <tr class=\\\"#{if index % 2 then 'odd' else 'even'}\\\"><td><a href=\\\"hooks\/##{_idFromString hook}\\\">#{hook}<\/a><\/td><td align=\\\"right\\\"><a href=\\\"source\/#{sourcePath}#invoke-hook-#{hook.toLowerCase()}\\\">invocation<\/a><\/td><\/tr>\\n\"\n          ).join ''\n          render += '  <\/table>\\n'\n          render += '<\/div>'\n          render += '\\n\\n'\n\n###### TODO: We should do some preprocessing hre with a transform, namely linking the hook headers to their respective documentation.\n\n      fs.writeFileSync 'docs\/packages.md', render\n\n    )\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fc3644b3cc9a91bed1df2878c8467917c8ef3c63","subject":"Fix name clash","message":"Fix name clash\n","repos":"Piot\/boardgamedb","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"adc06913a97c2878261d80979c171a43e70014e2","subject":"Report errors on madul hydration","message":"Report errors on madul hydration\n","repos":"bsgbryan\/jyn","old_file":"lib\/init_execution_context.litcoffee","new_file":"lib\/init_execution_context.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1aea91b4776c7e51fdf5fd5b3e5baecefcbcd103","subject":"fixes","message":"fixes\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/19_i18n.litcoffee","new_file":"docs\/19_i18n.litcoffee","new_contents":"# \/api\/Extras\/Batman.I18N\n\n`Batman.I18N` is a batman.js extra ([available in CoffeeScript](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.i18n.coffee)) for providing multi-langauge support in your application. It is modeled after [Rails i18n](http:\/\/guides.rubyonrails.org\/i18n.html).\n\nTo use `Batman.I18N`, you must:\n\n- Include the [batman.js extra](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.i18n.coffee) in your project\n- Enable `Batman.I18N` with `Batman.I18N.enable()`\n- Define locales on the client or [provide support from the server](#getting_locales_from_the_server)\n\nFor example:\n\n```coffeescript\n# after including Batman.I18N\nBatman.I18N.enable()\n\n# define locales:\nBatman.I18N.set 'locales.en',\n  messages:\n    welcome: \"Welcome\"\n  account:\n    sign_in: \"Sign In\"\n    register: \"Register\"\n\nBatman.I18N.set 'locales.zh'\n  messages:\n    welcome: '\u6b22\u8fce'\n\n# get translations:\nBatman.I18N.get(\"locale\")    # \"en\", default\nBatman.t(\"messages.welcome\") # \"Welcome\"\nBatman.I18N.set(\"locale\", \"zh\")\nBatman.t(\"messages.welcome\") # \"\u6b22\u8fce\"\n```\n\nYou can get translations for the current locale by using `t` in view bindings:\n\n```html\n<p data-source='t.messages.welcome'><\/p>\n```\n\n## Getting locales from the server\n\n`Batman.I18N.get('locales')` returns a `Batman.I18N.LocalesStorage`. This object's default accessor fetches locale objects from the server and caches them on the client. For example:\n\n```coffeescript\nBatman.I18N.get('locales.es')     # GET \/locales\/es.json\nBatman.I18N.get('locales.fr')     # GET \/locales\/fr.json\n```\n\n`Batman.I18N.translate` will fetch a locale if it isn't loaded already:\n\n```\nBatman.I18N.set('locale', 'zh')\nBatamn.I18N.translate('welcome')  # GET \/locales\/zh.json\n```\n\nThe `Batman.Request` expects a JSON response with the locale object:\n\n```coffeescript\n{\n  \"zh\" : {\n    \"welcome\" : \"\u6b22\u8fce\",\n    \"account\" : {\n      \"sign_in\" : \"\u767b\u5f55\",\n      \"register\" : \"\u6ce8\u518c\",\n    }\n  }\n}\n```\n\nWhen the new values are returned, view bindings will be automatically updated.\n\n## Error messages\n\nYou can provide error messages for a new locale by including translations in the same structure as batman.js's default messages. [See the batman.js source](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/model\/validations\/validators.coffee) for the structure of these messages.\n\n## @.defaultLocale[= \"en\"] : String\n\nThe default locale for `Batman.I18N`. Override this to make your app start in a locale other than `\"en\"`.\n\n## @%locale : String\n\nThe current locale for `Batman.I18N`, used by `Batman.translate`. Set this value to change your locale:\n\n```coffeescript\nBatman.I18N.set('locale', 'fr') # Bienvenue!\n```\n\n## @%locales : I18N.LocalesStorage\n\nReturns the current `Batman.I18N.LocalesStorage`, which stores locales and there translations. You can set keys on `locales` to define translations:\n\n```coffeescript\nBatman.I18N.set(\"locales.uz\", { ... })\n```\n\nSee [\"Getting locales from the server\"](#getting_locales_from_the_server) for information about how `Batman.I18N.LocalesStorage` handles missing keys.\n\n## @%translations : Object\n\nReturns the defined translations for the current locale.\n\n## @enable()\n\nTurns on `Batman.I18N` by:\n\n- Storing batman.js's default error messages to the `\"en\"` locale\n- Overriding `Batman.translate` to use `Batman.I18N.translate`\n\n## @disable()\n\nTurns off `Batman.I18N` by restoring previous functionality to `Batman.translate`.\n","old_contents":"# \/api\/Extras\/Batman.I18N\n\n`Batman.I18N` is a batman.js extra ([available in CoffeeScript](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.i18n.coffee)) for providing multi-langauge support in your application. It is modeled after [Rails i18n](http:\/\/guides.rubyonrails.org\/i18n.html).\n\nTo use `Batman.I18N`, you must:\n\n- Include the [batman.js extra](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.i18n.coffee) in your project\n- Enable `Batman.I18N` with `Batman.I18N.enable()`\n- Define locales on the client or [provide support from the server](\/docs\/api\/batman.i18n.html#getting_locales_from_the_server)\n\nFor example:\n\n```coffeescript\n# after inlcuding Batman.I18N\nBatman.I18N.enable()\nBatman.I18N.set 'locales.en',\n  messages:\n    welcome: \"Welcome\"\n  account:\n    sign_in: \"Sign In\"\n    register: \"Register\"\n\nBatman.I18N.get(\"locale\")    # \"en\", default\nBatman.t(\"messages.welcome\") # \"Welcome\"\nBatman.I18N.set(\"locale\", \"zh\")\nBatman.t(\"messages.welcome\") # \"\u6b22\u8fce\"\n```\n\nYou can get translations for the current locale by using `t` in view bindings:\n\n```html\n<p data-source='t.messages.welcome'><\/p>\n```\n\n## Getting locales from the server\n\n`Batman.I18N.get('locales')` returns a `Batman.I18N.LocalesStorage`. This object's default accessor fetches locale objects from the server and caches them on the client. For example:\n\n```coffeescript\nBatman.I18N.get('locales.es')     # GET \/locales\/es.json\nBatman.I18N.get('locales.fr')     # GET \/locales\/fr.json\n```\n\n`Batman.I18N.translate` will fetch a locale if it isn't loaded already:\n\n```\nBatman.I18N.set('locale', 'zh')\nBatamn.I18N.translate('welcome')  # GET \/locales\/zh.json\n```\n\nThe `Batman.Request` expects a JSON response with the locale object:\n\n```coffeescript\n{\n  \"zh\" : {\n    \"welcome\" : \"\u6b22\u8fce\",\n    \"account\" : {\n      \"sign_in\" : \"\u767b\u5f55\",\n      \"register\" : \"\u6ce8\u518c\",\n    }\n  }\n}\n```\n\nWhen the new values are returned, view bindings will be automatically updated.\n\n## Error messages\n\nYou can provide error messages for a new locale by including translations in the same structure as batman.js's default messages. [See the batman.js source](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/model\/validations\/validators.coffee) for the structure of these messages.\n\n## @.defaultLocale[= \"en\"] : String\n\nThe default locale for `Batman.I18N`. Override this to make your app start in a locale other than `\"en\"`.\n\n## @%locale : String\n\nThe current locale for `Batman.I18N`, used by `Batman.translate`. Set this value to change your locale:\n\n```coffeescript\nBatman.I18N.set('locale', 'fr') # Bienvenue!\n```\n\n## @%locales : I18N.LocalesStorage\n\nReturns the current `Batman.I18N.LocalesStorage`, which stores locales and there translations. You can set keys on `locales` to define translations:\n\n```coffeescript\nBatman.I18N.set(\"locales.uz\", { ... })\n```\n\nSee [\"Getting locales from the server\"](\/docs\/api\/batman.i18n.html#getting_locales_from_the_server) for information about how `Batman.I18N.LocalesStorage` handles missing keys.\n\n## @%translations : Object\n\nReturns the defined translations for the current locale.\n\n## @enable()\n\nTurns on `Batman.I18N` by:\n\n- Storing batman.js's default error messages to the `\"en\"` locale\n- Overriding `Batman.translate` to use `Batman.I18N.translate`\n\n## @disable()\n\nTurns off `Batman.I18N` by restoring previous functionality to `Batman.translate`.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d1186ee94070bf42baf940793494a3cd0da54a75","subject":"Animated the head.","message":"Animated the head.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/game.litcoffee","new_file":"src\/game.litcoffee","new_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    pose = require \".\/pose.litcoffee\"\n    ik = require \".\/ik.litcoffee\"\n       \n    triangle = undefined\n    \n    character = testMap = testNavmesh = undefined\n    characterData = require \".\/characters\/test\/cloud.coffee\"\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load characterData, (character_) ->\n            character = character_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n    \n    playerPoseOld = pose.create characterData\n    playerPoseNew = pose.create characterData\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n    \n    torsoAltitude = 0\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    start = []\n    leftFoot = []\n    rightFoot = []\n    walked = 0\n    shuffleTicks = 0\n    foot = \"left\"\n    offset = []\n    \n    yaw = 0\n    pitch = 0\n    headYawPreviousTick = headYaw = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->        \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            \n        matrix.translate velocity, entityTransform  \n        speed = vector.magnitude velocity\n        walked += speed\n        moving = speed > 2\n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # A \"bump\" when you land.\n            matrix.getY entityTransform, yAxis\n            impact = Math.abs (vector.dot triangle.plane.normal, velocity) * (vector.dot triangle.plane.normal, yAxis)\n            impact -= 1\n            if impact < 0 then impact = 0\n            impact *= 2\n            torsoAltitude -= impact\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        torsoAltitude = misc.interpolate torsoAltitude, (12 - Math.min 2, (speed + if inDeadzone then 0 else 1.5)), 0.4\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, torsoAltitude, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.1, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        # Calculating the head angle relative to the torso is complicated by the\n        # stick angle being wrapped to 0...2PI, so we have to shift it out of\n        # that range to clamp it.\n        headYawPreviousTick = headYaw\n        headYaw = Math.max Math.PI - 1, Math.min Math.PI + 1, misc.wrapAngle Math.PI + stickAngle - yaw\n        headYaw -= Math.PI\n        headYaw = misc.interpolateAngle headYawPreviousTick, headYaw, 0.4, headYaw\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.2\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n        \n        if walked < 5\n            shuffleTicks--\n        while walked > 5 or shuffleTicks < 0\n            shuffleTicks = 5\n            walked -= 5\n            if (not inDeadzone) or moving\n                vector.normalize velocity, offset\n                vector.multiply.byScalar offset, 5, offset\n            else\n                offset[0] = offset[1] = offset[2] = 0\n            foot = switch foot\n                when \"left\"\n                    matrix.applyToVector playerPoseNew.torso, [-2, -10, 0], leftFoot\n                    vector.add.vector offset, leftFoot, leftFoot\n                    plane.project triangle.plane, leftFoot, leftFoot\n                    \"right\"\n                when \"right\"\n                    matrix.applyToVector playerPoseNew.torso, [2, -10, 0], rightFoot\n                    vector.add.vector offset, rightFoot, rightFoot\n                    plane.project triangle.plane, rightFoot, rightFoot\n                    \"left\"\n    \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            firstTick = false\n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n    \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, playerPoseNew.torso\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, -2.5, 0], start\n        matrix.getX playerPoseNew.torso, xAxis\n        ik.computeLimb start, leftFoot, 10, xAxis, playerPoseNew.legLeftUpper, playerPoseNew.legLeftLower\n        \n        matrix.applyToVector playerPoseNew.torso, [1.5, -2.5, 0], start\n        ik.computeLimb start, rightFoot, 10, xAxis, playerPoseNew.legRightUpper, playerPoseNew.legRightLower\n        \n        matrix.copy playerPoseNew.torso, playerPoseNew.head\n        matrix.translate [0, 6, 0], playerPoseNew.head, true\n        matrix.rotateY (misc.interpolate headYawPreviousTick, headYaw, progress), playerPoseNew.head, true\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw character, playerPoseOld, playerPoseNew\n        \n        return\n        \n    module.exports = { load, tick, draw }","old_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    pose = require \".\/pose.litcoffee\"\n    ik = require \".\/ik.litcoffee\"\n       \n    triangle = undefined\n    \n    character = testMap = testNavmesh = undefined\n    characterData = require \".\/characters\/test\/cloud.coffee\"\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load characterData, (character_) ->\n            character = character_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n    \n    playerPoseOld = pose.create characterData\n    playerPoseNew = pose.create characterData\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    matrix.identity cameraTransform\n    \n    torsoAltitude = 0\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    start = []\n    leftFoot = []\n    rightFoot = []\n    walked = 0\n    shuffleTicks = 0\n    foot = \"left\"\n    offset = []\n    \n    yaw = 0\n    pitch = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->        \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            \n        matrix.translate velocity, entityTransform  \n        speed = vector.magnitude velocity\n        walked += speed\n        moving = speed > 2\n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # A \"bump\" when you land.\n            matrix.getY entityTransform, yAxis\n            impact = Math.abs (vector.dot triangle.plane.normal, velocity) * (vector.dot triangle.plane.normal, yAxis)\n            impact -= 1\n            if impact < 0 then impact = 0\n            impact *= 2\n            torsoAltitude -= impact\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        torsoAltitude = misc.interpolate torsoAltitude, (12 - Math.min 2, (speed + if inDeadzone then 0 else 1.5)), 0.4\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, torsoAltitude, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.2, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.2\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n        \n        if walked < 5\n            shuffleTicks--\n        while walked > 5 or shuffleTicks < 0\n            shuffleTicks = 5\n            walked -= 5\n            if (not inDeadzone) or moving\n                vector.normalize velocity, offset\n                vector.multiply.byScalar offset, 5, offset\n            else\n                offset[0] = offset[1] = offset[2] = 0\n            foot = switch foot\n                when \"left\"\n                    matrix.applyToVector playerPoseNew.torso, [-2, -10, 0], leftFoot\n                    vector.add.vector offset, leftFoot, leftFoot\n                    plane.project triangle.plane, leftFoot, leftFoot\n                    \"right\"\n                when \"right\"\n                    matrix.applyToVector playerPoseNew.torso, [2, -10, 0], rightFoot\n                    vector.add.vector offset, rightFoot, rightFoot\n                    plane.project triangle.plane, rightFoot, rightFoot\n                    \"left\"\n    \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            firstTick = false\n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n    \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, playerPoseNew.torso\n        \n        matrix.invert entityTransformToDraw, cameraTransform\n        matrix.translate [0,-10, 10], cameraTransform\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, -2.5, 0], start\n        matrix.getX playerPoseNew.torso, xAxis\n        ik.computeLimb start, leftFoot, 10, xAxis, playerPoseNew.legLeftUpper, playerPoseNew.legLeftLower\n        \n        matrix.applyToVector playerPoseNew.torso, [1.5, -2.5, 0], start\n        ik.computeLimb start, rightFoot, 10, xAxis, playerPoseNew.legRightUpper, playerPoseNew.legRightLower\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw character, playerPoseOld, playerPoseNew\n        \n        return\n        \n    module.exports = { load, tick, draw }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"37cb0d8497fa8cd3967dd7b96294c7a1108bdc8e","subject":"router errors","message":"router errors\n","repos":"vpj\/weya,vpj\/weya","old_file":"router.litcoffee","new_file":"router.litcoffee","new_contents":"#Weya.Router.litcoffee\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n    if exports?\n     Weya = require '.\/weya'\n     Weya.Base = require '.\/weya_base'\n\n    if not Weya.Base?\n     throw new Error 'Weya.Base not found'\n\n##Weya.Router\n\nRouting with hash tags or pushState\n\n    class Router extends Weya.Base\n     optionalParam: \/\\((.*?)\\)\/g\n     namedParam: \/(\\(\\?)?:\\w+\/g\n     splatParam: \/\\*\\w+\/g\n     escapeRegExp: \/[\\-{}\\[\\]+?.,\\\\\\^$|#\\s]\/g\n\n     @extend()\n\n     @initialize ->\n      @_bindRoutes()\n      @_event = null\n      @_history = []\n\n     _routes: {}\n\n####Register router\n\n`'analyse\/:analysis': 'onAnalyse'`\n\n`dashboard': ['auth', 'dashboard']`\n\nThis will match urls of the form `analyse\/\\*` and call method @onAnalyse\nwith the parameter. Second route will first call @auth if it returns\n`true` @dashboard will be called.\n\nThe most specific route should be at bottom. Routers can added or overridden\nin subclasses\n\n     @routes: (routes) ->\n      temp = @::_routes\n      @::_routes = {}\n      @::_routes[k] = v for k, v of temp\n      @::_routes[k] = v for k, v of routes\n\n####Starts routing\nOption silent will not trigger an event for the current url\n\n     start: (options) ->\n      Weya.history.start options\n      fragment = Weya.history.getFragment()\n\n      if options?.silent is on\n       @_history.push fragment: fragment, title: document.title\n\n####Goes to previous page if exists\n\n     back: ->\n      if @_history.length > 1\n       Weya.history.back()\n\n####Whether it is possible to go to previous page\n\n     canBack: ->\n      if @_history.length > 1 and Weya.history.canBack()\n       return true\n      else\n       return false\n\n####Registers a route\n\n     route: (route, name) ->\n      if (Object.prototype.toString.call route) isnt '[object RegExp]'\n       route = @_routeToRegExp route\n\nRegisters the route with Weya.history\n\n      Weya.history.route route, (fragment, event) =>\n       args = @_extractParameters route, fragment\n       @_event = event\n\nHandle state\n\n       if @_event?.type is \"popstate\"\n        @_history.pop()\n        if @_history.length is 0\n         @_history.push\n          fragment: fragment\n          title: document.title\n          state: @getState()\n       else\n        @_history.push\n         fragment: fragment\n         title: document.title\n         state: @getState()\n\nCalls callbacks in order\n\n       callbacks = name\n       callbacks = [callbacks] if not Array.isArray callbacks\n\n       for callback in callbacks\n        if (typeof callback) is 'string'\n         callback = @[callback]\n        break unless callback.apply this, args\n\n####Gets the current HTML5 History state\n\n     getState: ->\n      if @_event?.originalEvent?.state?\n       return @_event.originalEvent.state\n      else\n       return null\n\n####Navigate to a new URL, while setting HTML5 History state\n\n     navigate: (fragment, options) ->\n      options = {} unless options\n      if options.replace\n       @_history.pop()\n      if not options.trigger\n       @_history.push\n        fragment: fragment\n        title: options.title\n        state: options.state\n\n      Weya.history.navigate fragment, options\n\nBind routes\n\n     _bindRoutes: ->\n      for route, name of @_routes\n       @route route, name\n\nConvert a route string into a regular expression, suitable for matching\n\n     _routeToRegExp: (route) ->\n      route = route.replace @escapeRegExp, '\\\\$&'\n                   .replace @noptionalParam, '(?:$1)?'\n                   .replace @namedParam, (match, optional) ->\n                    if optional then match else '([^\\\/]+)'\n                   .replace @splatParam, '(.*?)'\n\n       return new RegExp \"^#{route}$\"\n\nExtract parameters from a route regex and URL\n\n     _extractParameters: (route, fragment) ->\n      params = route.exec(fragment).slice(1)\n      for p, i in params when p?\n       params[i] = decodeURIComponent p\n\n## History class\n\n    class History extends Weya.Base\n     @extend()\n\nStrip leading hash\/slash and trailing space\n\n     routeStripper: \/^[#\\\/]|\\s+$\/g\n\nStrip leading and trailing slashes\n\n     rootStripper: \/^\\\/+|\\\/+$\/g\n\nRemove trailing slash\n\n     trailingSlash: \/\\\/$\/\n\nStrip urls of hash and query\n\n     pathStripper: \/[?#].*$\/\n\n     @initialize ->\n      @handlers = []\n      @checkUrl = @checkUrl.bind this\n      @history = window.history\n      @location = window.location\n      @stateList = []\n\nHash check interval\n\n     interval: 50\n\nGet hash value\n\n     getHash: ->\n      match = @location.href.match \/#(.*)$\/\n      return (if match? then match[1] else '')\n\nGet emulated state\n\n     getEmulateState: ->\n      if @stateList.length > 0\n       return @stateList[@stateList.length - 1]\n      else\n       return {fragment: \"\"}\n\n     popEmulateState: -> @stateList.pop()\n\n     pushEmulateState: (state, title, fragment) ->\n      @stateList.push\n       state: state\n       title: title\n       fragment: fragment\n\nGet the URL fragment\n\n     getFragment: (fragment, forcePushState) ->\n      if not fragment?\n       if @_emulateState\n        fragment = @getEmulateState().fragment\n       else if @_hasPushState or not @_wantsHashChange or forcePushState\n        fragment = @location.pathname\n        root = @root.replace @trailingSlash, ''\n        if (fragment.indexOf root) is 0\n         fragment = fragment.slice root.length\n       else\n        fragment = @getHash()\n\n      return fragment.replace @routeStripper, ''\n\n####Goto the previous page\n\n     back: ->\n      if @_emulateState is on\n       @popEmulateState()\n       @loadUrl null, null\n      else\n       @history?.back?()\n\n####Can back?\n\n     canBack: ->\n      if @_emulateState is on\n       return @stateList.length > 1\n      else\n       return @history?.back?\n\n####Start listening to events\n\n     start: (options) ->\n      History.started = true\n\n      opt = {root: '\/'}\n      opt[k] = v for k, v of @options\n      opt[k] = v for k, v of options\n      @options = opt\n      @root = @options.root\n      @_emulateState = @options.emulateState is on\n      @_wantsHashChange = @_emulateState is off and @options.hashChange isnt off\n      @_wantsPushState = @_emulateState is off and @options.pushState is on\n      @_hasPushState = @_wantsPushState is on and @history?.pushState?\n      if @_emulateState and @options.start?\n       @pushEmulateState @options.start.state,\n        @options.start.title\n        @options.start.fragment\n\n      @fragment = @getFragment()\n\nNormalize root to always include a leading and trailing slash.\n\n      @root = \"\/#{@root}\/\".replace @rootStripper, '\/'\n\nDepending on whether we're using pushState or hashes, and whether\n'onhashchange' is supported, determine how we check the URL state.\n\n      if @_hasPushState\n       window.onpopstate = @checkUrl\n      else if @_wantsHashChange and window.onhashchange?\n       window.onhashchange = @checkUrl\n      else if @_wantsHashChange\n       @_checkUrlInterval = setInterval @checkUrl, @interval\n\n      if not @options.silent\n       @loadUrl null, null\n\n####Add a listener to a router\n\n     route: (route, callback) ->\n      @handlers.unshift route: route, callback: callback\n\nCheck current url for changes\n\n     checkUrl: (e) ->\n      fragment = @getFragment()\n      return if fragment is @fragment\n      @loadUrl fragment, e\n\nCall callbacks of matching route\n\n     loadUrl: (fragment, e) ->\n      try\n       fragment = @fragment = @getFragment fragment\n       for handler in @handlers\n        if handler.route.test fragment\n         return handler.callback fragment, e\n      catch e\n       @onerror? e\n\n      return\n\n####Navigate to a URL\nTriggers a route is option trigger is on\nReplaces the url is option replace is on\nSets state and title\n\n     navigate: (fragment, options) ->\n      return false if not History.started\n\n      fragment = @getFragment(fragment or '')\n      url = @root + fragment\n\nStrip the fragment of the query and hash for matching.\n\n      fragment = fragment.replace @pathStripper, ''\n\n      return if @fragment is fragment\n      @fragment = fragment\n\nDon't include a trailing slash on the root.\n\n      if fragment is '' and url isnt '\/'\n       url = url.slice 0, -1\n\nIf pushState is available, we use it to set the fragment as a real URL.\n\n      if @_emulateState\n       if options.replace is on\n        @popEmulateState()\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @pushEmulateState state, title, fragment\n      else if @_hasPushState\n       method = if options.replace then 'replaceState' else 'pushState'\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @history[method] state, title, url\n\nIf hash changes haven't been explicitly disabled, update the hash\nfragment to store history.\n\n      else if @_wantsHashChange\n       @_updateHash @location, fragment, options.replace\n\nIf you've told us that you explicitly don't want fallback hashchange-\nbased history, then `navigate` becomes a page refresh.\n\n      else\n       return @location.assign url\n      if options.trigger\n       return @loadUrl fragment, null\n\nUpdate the hash\n\n     _updateHash: (location, fragment, replace) ->\n      if replace\n       href = location.href.replace \/(javascript:|#).*$\/, ''\n       location.replace \"#{href}##{fragment}\"\n      else\n       location.hash = \"##{fragment}\"\n\n    Weya.Router = Router\n    Weya.history = new History\n\n    if module?\n     module.exports = Weya.Router\n\n","old_contents":"#Weya.Router.litcoffee\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n    if exports?\n     Weya = require '.\/weya'\n     Weya.Base = require '.\/weya_base'\n\n    if not Weya.Base?\n     throw new Error 'Weya.Base not found'\n\n##Weya.Router\n\nRouting with hash tags or pushState\n\n    class Router extends Weya.Base\n     optionalParam: \/\\((.*?)\\)\/g\n     namedParam: \/(\\(\\?)?:\\w+\/g\n     splatParam: \/\\*\\w+\/g\n     escapeRegExp: \/[\\-{}\\[\\]+?.,\\\\\\^$|#\\s]\/g\n\n     @extend()\n\n     @initialize ->\n      @_bindRoutes()\n      @_event = null\n      @_history = []\n\n     _routes: {}\n\n####Register router\n\n`'analyse\/:analysis': 'onAnalyse'`\n\n`dashboard': ['auth', 'dashboard']`\n\nThis will match urls of the form `analyse\/\\*` and call method @onAnalyse\nwith the parameter. Second route will first call @auth if it returns\n`true` @dashboard will be called.\n\nThe most specific route should be at bottom. Routers can added or overridden\nin subclasses\n\n     @routes: (routes) ->\n      temp = @::_routes\n      @::_routes = {}\n      @::_routes[k] = v for k, v of temp\n      @::_routes[k] = v for k, v of routes\n\n####Starts routing\nOption silent will not trigger an event for the current url\n\n     start: (options) ->\n      Weya.history.start options\n      fragment = Weya.history.getFragment()\n\n      if options?.silent is on\n       @_history.push fragment: fragment, title: document.title\n\n####Goes to previous page if exists\n\n     back: ->\n      if @_history.length > 1\n       Weya.history.back()\n\n####Whether it is possible to go to previous page\n\n     canBack: ->\n      if @_history.length > 1 and Weya.history.canBack()\n       return true\n      else\n       return false\n\n####Registers a route\n\n     route: (route, name) ->\n      if (Object.prototype.toString.call route) isnt '[object RegExp]'\n       route = @_routeToRegExp route\n\nRegisters the route with Weya.history\n\n      Weya.history.route route, (fragment, event) =>\n       args = @_extractParameters route, fragment\n       @_event = event\n\nHandle state\n\n       if @_event?.type is \"popstate\"\n        @_history.pop()\n        if @_history.length is 0\n         @_history.push\n          fragment: fragment\n          title: document.title\n          state: @getState()\n       else\n        @_history.push\n         fragment: fragment\n         title: document.title\n         state: @getState()\n\nCalls callbacks in order\n\n       callbacks = name\n       callbacks = [callbacks] if not Array.isArray callbacks\n\n       for callback in callbacks\n        if (typeof callback) is 'string'\n         callback = @[callback]\n        break unless callback.apply this, args\n\n####Gets the current HTML5 History state\n\n     getState: ->\n      if @_event?.originalEvent?.state?\n       return @_event.originalEvent.state\n      else\n       return null\n\n####Navigate to a new URL, while setting HTML5 History state\n\n     navigate: (fragment, options) ->\n      options = {} unless options\n      if options.replace\n       @_history.pop()\n      if not options.trigger\n       @_history.push\n        fragment: fragment\n        title: options.title\n        state: options.state\n\n      Weya.history.navigate fragment, options\n\nBind routes\n\n     _bindRoutes: ->\n      for route, name of @_routes\n       @route route, name\n\nConvert a route string into a regular expression, suitable for matching\n\n     _routeToRegExp: (route) ->\n      route = route.replace @escapeRegExp, '\\\\$&'\n                   .replace @noptionalParam, '(?:$1)?'\n                   .replace @namedParam, (match, optional) ->\n                    if optional then match else '([^\\\/]+)'\n                   .replace @splatParam, '(.*?)'\n\n       return new RegExp \"^#{route}$\"\n\nExtract parameters from a route regex and URL\n\n     _extractParameters: (route, fragment) ->\n      params = route.exec(fragment).slice(1)\n      for p, i in params when p?\n       params[i] = decodeURIComponent p\n\n## History class\n\n    class History extends Weya.Base\n     @extend()\n\nStrip leading hash\/slash and trailing space\n\n     routeStripper: \/^[#\\\/]|\\s+$\/g\n\nStrip leading and trailing slashes\n\n     rootStripper: \/^\\\/+|\\\/+$\/g\n\nRemove trailing slash\n\n     trailingSlash: \/\\\/$\/\n\nStrip urls of hash and query\n\n     pathStripper: \/[?#].*$\/\n\n     @initialize ->\n      @handlers = []\n      @checkUrl = @checkUrl.bind this\n      @history = window.history\n      @location = window.location\n      @stateList = []\n\nHash check interval\n\n     interval: 50\n\nGet hash value\n\n     getHash: ->\n      match = @location.href.match \/#(.*)$\/\n      return (if match? then match[1] else '')\n\nGet emulated state\n\n     getEmulateState: ->\n      if @stateList.length > 0\n       return @stateList[@stateList.length - 1]\n      else\n       return {fragment: \"\"}\n\n     popEmulateState: -> @stateList.pop()\n\n     pushEmulateState: (state, title, fragment) ->\n      @stateList.push\n       state: state\n       title: title\n       fragment: fragment\n\nGet the URL fragment\n\n     getFragment: (fragment, forcePushState) ->\n      if not fragment?\n       if @_emulateState\n        fragment = @getEmulateState().fragment\n       else if @_hasPushState or not @_wantsHashChange or forcePushState\n        fragment = @location.pathname\n        root = @root.replace @trailingSlash, ''\n        if (fragment.indexOf root) is 0\n         fragment = fragment.slice root.length\n       else\n        fragment = @getHash()\n\n      return fragment.replace @routeStripper, ''\n\n####Goto the previous page\n\n     back: ->\n      if @_emulateState is on\n       @popEmulateState()\n       @loadUrl null, null\n      else\n       @history?.back?()\n\n####Can back?\n\n     canBack: ->\n      if @_emulateState is on\n       return @stateList.length > 1\n      else\n       return @history?.back?\n\n####Start listening to events\n\n     start: (options) ->\n      History.started = true\n\n      opt = {root: '\/'}\n      opt[k] = v for k, v of @options\n      opt[k] = v for k, v of options\n      @options = opt\n      @root = @options.root\n      @_emulateState = @options.emulateState is on\n      @_wantsHashChange = @_emulateState is off and @options.hashChange isnt off\n      @_wantsPushState = @_emulateState is off and @options.pushState is on\n      @_hasPushState = @_wantsPushState is on and @history?.pushState?\n      if @_emulateState and @options.start?\n       @pushEmulateState @options.start.state,\n        @options.start.title\n        @options.start.fragment\n\n      @fragment = @getFragment()\n\nNormalize root to always include a leading and trailing slash.\n\n      @root = \"\/#{@root}\/\".replace @rootStripper, '\/'\n\nDepending on whether we're using pushState or hashes, and whether\n'onhashchange' is supported, determine how we check the URL state.\n\n      if @_hasPushState\n       window.onpopstate = @checkUrl\n      else if @_wantsHashChange and window.onhashchange?\n       window.onhashchange = @checkUrl\n      else if @_wantsHashChange\n       @_checkUrlInterval = setInterval @checkUrl, @interval\n\n      if not @options.silent\n       @loadUrl null, null\n\n####Add a listener to a router\n\n     route: (route, callback) ->\n      @handlers.unshift route: route, callback: callback\n\nCheck current url for changes\n\n     checkUrl: (e) ->\n      fragment = @getFragment()\n      return if fragment is @fragment\n      @loadUrl fragment, e\n\nCall callbacks of matching route\n\n     loadUrl: (fragment, e) ->\n      fragment = @fragment = @getFragment fragment\n      for handler in @handlers\n       if handler.route.test fragment\n        return handler.callback fragment, e\n\n      return\n\n####Navigate to a URL\nTriggers a route is option trigger is on\nReplaces the url is option replace is on\nSets state and title\n\n     navigate: (fragment, options) ->\n      return false if not History.started\n\n      fragment = @getFragment(fragment or '')\n      url = @root + fragment\n\nStrip the fragment of the query and hash for matching.\n\n      fragment = fragment.replace @pathStripper, ''\n\n      return if @fragment is fragment\n      @fragment = fragment\n\nDon't include a trailing slash on the root.\n\n      if fragment is '' and url isnt '\/'\n       url = url.slice 0, -1\n\nIf pushState is available, we use it to set the fragment as a real URL.\n\n      if @_emulateState\n       if options.replace is on\n        @popEmulateState()\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @pushEmulateState state, title, fragment\n      else if @_hasPushState\n       method = if options.replace then 'replaceState' else 'pushState'\n       state = {}\n       state = options.state if options.state?\n       title = ''\n       title = options.title if options.title?\n       @history[method] state, title, url\n\nIf hash changes haven't been explicitly disabled, update the hash\nfragment to store history.\n\n      else if @_wantsHashChange\n       @_updateHash @location, fragment, options.replace\n\nIf you've told us that you explicitly don't want fallback hashchange-\nbased history, then `navigate` becomes a page refresh.\n\n      else\n       return @location.assign url\n      if options.trigger\n       return @loadUrl fragment, null\n\nUpdate the hash\n\n     _updateHash: (location, fragment, replace) ->\n      if replace\n       href = location.href.replace \/(javascript:|#).*$\/, ''\n       location.replace \"#{href}##{fragment}\"\n      else\n       location.hash = \"##{fragment}\"\n\n    Weya.Router = Router\n    Weya.history = new History\n\n    if module?\n     module.exports = Weya.Router\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"beda1bd28fba30ed4623a3d2e5dbe3e9a0b1f5d9","subject":"Add create\/select\/delete branch","message":"Add create\/select\/delete branch\n","repos":"mnmtanish\/vosco-cli","old_file":"script.litcoffee","new_file":"script.litcoffee","new_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    fs     = require \"fs\"\n    path   = require \"path\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    script =\n\nSetup\n-----\n\n      'install': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        if isInstalled then process.exit 1\n        await @vosco.install defer(error)\n\n      'uninstall': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.uninstall defer(error)\n\nRepository\n----------\n\n      'get-status': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getStatus defer(error, status)\n        getType = (file) -> file.type\n        getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n        groups  = _.groupBy status, getType\n        for group, paths of groups\n          console.log \"\"\"\n          #{group}\n          #{paths.map(getPath).join(\"\\n\")}\n          \"\"\"\n\n      'get-history': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getHistory defer(error, history)\n        for commit in history\n          hash = commit.hash.substr(0, 7)\n          date = new Date(commit.date).toDateString()\n          msg  = commit.message\n          console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n\n      'get-content-history': (path) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        # show warning if file doesn\"t exist\n        console.log \"content history\"\n\nSnapshots\n---------\n\n      'preview-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        hash = hash or 'HEAD'\n        await @vosco.previewSnapshot hash, defer(error, diff)\n        console.log diff\n\n      'create-snapshot': (message) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        message = message or 'Untitled Snapshot'\n        await @vosco.createSnapshot message, defer(error)\n\n      'rollback-to-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.rollbackToSnapshot hash, defer(error)\n\nBranches\n--------\n\n      'get-branches': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getBranches defer(error, branches, current)\n        for branch in branches\n          branch = if branch is current then \"* #{branch}\" else\n            colors.xterm(240)(\"  #{branch}\")\n          console.log \"#{branch}\"\n\n      'create-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.createBranch branch, defer(error)\n\n      'select-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.selectBranch branch, defer(error)\n\n      'delete-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.deleteBranch branch, defer(error)\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      script.vosco = vosco\n      return script\n","old_contents":"Dependencies\n============\n\n    _      = require \"underscore\"\n    fs     = require \"fs\"\n    path   = require \"path\"\n    colors = require \"cli-color\"\n\nVOSCO\n=====\n\n    script =\n\nSetup\n-----\n\n      'install': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        if isInstalled then process.exit 1\n        await @vosco.install defer(error)\n\n      'uninstall': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.uninstall defer(error)\n\nRepository\n----------\n\n      'get-status': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getStatus defer(error, status)\n        getType = (file) -> file.type\n        getPath = (file) -> colors.xterm(240)(\"  #{file.path}\")\n        groups  = _.groupBy status, getType\n        for group, paths of groups\n          console.log \"\"\"\n          #{group}\n          #{paths.map(getPath).join(\"\\n\")}\n          \"\"\"\n\n      'get-history': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getHistory defer(error, history)\n        for commit in history\n          hash = commit.hash.substr(0, 7)\n          date = new Date(commit.date).toDateString()\n          msg  = commit.message\n          console.log colors.xterm(240)(\"  #{hash}  #{date}  #{msg}\")\n\n      'get-content-history': (path) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        # show warning if file doesn\"t exist\n        console.log \"content history\"\n\nSnapshots\n---------\n\n      'preview-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        hash = hash or 'HEAD'\n        await @vosco.previewSnapshot hash, defer(error, diff)\n        console.log diff\n\n      'create-snapshot': (message) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        message = message or 'Untitled Snapshot'\n        await @vosco.createSnapshot message, defer(error)\n\n      'rollback-to-snapshot': (hash) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.rollbackToSnapshot hash, defer(error)\n\nBranches\n--------\n\n      'get-branches': () ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        await @vosco.getBranches defer(error, branches, current)\n        for branch in branches\n          branch = if branch is current then \"* #{branch}\" else\n            colors.xterm(240)(\"  #{branch}\")\n          console.log \"#{branch}\"\n\n      'create-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"create new branch\"\n\n      'select-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"select branch\"\n\n      'delete-branch': (branch) ->\n        await @vosco.isInstalled defer(error, isInstalled)\n        unless isInstalled then process.exit 1\n        console.log \"delete branch\"\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      script.vosco = vosco\n      return script\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b88e401713d2405c4c4f94c3bb139ca1671a2fdd","subject":"Made pipeline an array, removed levels default, moved help","message":"Made pipeline an array, removed levels default, moved help\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/arguments.litcoffee","new_file":"lib\/arguments.litcoffee","new_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] name1 name2 ...'\n      .example '$0',\n        'Creates a 50 x 15 level with 16 x 14 cells and an auto-generated name'\n      .example '$0 -vvvvvvvv',\n        \"Create a 50 x 15 level with 16 x 14 cells, an auto-generated name, and\n        logging set to verbosity level 8 (max)\"\n      .example '$0 -w 20 -h 20',\n        'Creates a 50 x 15 level with 40 X 40 cells & an auto-generated name'\n      .example '$0 -w 10 -h 10 -x 4',\n        'Creates a 50 x 15 level with 40 x 40 cells and an auto-generated name'\n      .example '$0 lvl1 lvl2',\n        'Creates two levels, lvl1 & lvl2, each 50 X 15 with 16 x 14 cells'\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      8\n        height:     7\n        multiplier: 4\n        pipeline:   [ 'png_blocks', 'png_walls', 'png_step_count' ]\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .argv\n","old_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] name1 name2 ...'\n      .example '$0',\n        'Creates a 50 x 15 level with 16 x 14 cells and an auto-generated name'\n      .example '$0 -vvvvvvvv',\n        \"Create a 50 x 15 level with 16 x 14 cells, an auto-generated name, and\n        logging set to verbosity level 8 (max)\"\n      .example '$0 -w 20 -h 20',\n        'Creates a 50 x 15 level with 40 X 40 cells & an auto-generated name'\n      .example '$0 -w 10 -h 10 -x 4',\n        'Creates a 50 x 15 level with 40 x 40 cells and an auto-generated name'\n      .example '$0 lvl1 lvl2',\n        'Creates two levels, lvl1 & lvl2, each 50 X 15 with 16 x 14 cells'\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .conflicts 'levels', 'l'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      8\n        height:     7\n        multiplier: 4\n        levels:     1\n        pipeline:   'png_blocks,png_walls,png_step_count'\n      .help 'help'\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .argv\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4f37fca73d46836e83ea5b95ca49cc7738b6223a","subject":"Don't call initializer and initer methods directly","message":"Don't call initializer and initer methods directly\n\nInstead, invoke them from their prototype, passing @. This ensures scope is\ncorrect.\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (done) =>\n        proto  = @.__proto__\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (done) =>\n        proto  = @.__proto__\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            @[initer.execute]().then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              @[initializer.fn]()\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _invoke_parent_initializers: (callback) =>\n        proto = @.__proto__\n\n        if proto.__proto__?\n          parents = while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            proto = proto.__proto__\n\n          async.each parents, (parent, next) =>\n            @_call_initializers_for parent.constructor.name, next\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_wrap_methods()\n          @_hydrate_deps => @_invoke_parent_initializers => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6d4dfdf5fb468052f163526c72695afbbc3d7050","subject":"better docs for source maps","message":"better docs for source maps\n","repos":"sterpe\/coffee-fmt","old_file":"sourcemap.litcoffee","new_file":"sourcemap.litcoffee","new_contents":"Source maps allow JavaScript runtimes to match running JavaScript back to\nthe original source code that corresponds to it. This can be minified\nJavaScript, but in our case, we're concerned with mapping pretty-printed\nJavaScript back to CoffeeScript.\n\nIn order to produce maps, we must keep track of positions (line number, column number)\nthat originated every node in the syntax tree, and be able to generate a\n[map file](https:\/\/docs.google.com\/document\/d\/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k\/edit)\n\u2014 which is a compact, VLQ-encoded representation of the JSON serialization\nof this information \u2014 to write out alongside the generated JavaScript.\n\n\nLineMap\n-------\n\nA **LineMap** object keeps track of information about original line and column\npositions for a single line of output JavaScript code.\n**SourceMaps** are implemented in terms of **LineMaps**.\n\n    class LineMap\n      constructor: (@line) ->\n        @columns = []\n\n      add: (column, [sourceLine, sourceColumn], options={}) ->\n        return if @columns[column] and options.noReplace\n        @columns[column] = {line: @line, column, sourceLine, sourceColumn}\n\n      sourceLocation: (column) ->\n        column-- until (mapping = @columns[column]) or (column <= 0)\n        mapping and [mapping.sourceLine, mapping.sourceColumn]\n\n\nSourceMap\n---------\n\nMaps locations in for a single generated JavaScript file back to locations in\nthe original CoffeeScript source file.\n\nThis is intentionally agnostic towards how a source map might be represented on\ndisk. Once the compiler is ready to produce a \"v3\"-style source map, we can walk\nthrough the arrays of line and column buffer to produce it.\n\n    class SourceMap\n      constructor: ->\n        @lines = []\n\nAdds a mapping to this SourceMap. `sourceLocation` and `generatedLocation`\nare both `[line, column]` arrays. If `options.noReplace` is true, then if there\nis already a mapping for the specified `line` and `column`, this will have no\neffect.\n\n      add: (sourceLocation, generatedLocation, options = {}) ->\n        [line, column] = generatedLocation\n        lineMap = (@lines[line] or= new LineMap(line))\n        lineMap.add column, sourceLocation, options\n\nLook up the original position of a given `line` and `column` in the generated\ncode.\n\n      sourceLocation: ([line, column]) ->\n        line-- until (lineMap = @lines[line]) or (line <= 0)\n        lineMap and lineMap.sourceLocation column\n\n\nV3 SourceMap Generation\n-----------------------\n\nBuilds up a V3 source map, returning the generated JSON as a string.\n`options.sourceRoot` may be used to specify the sourceRoot written to the source\nmap.  Also, `options.sourceFiles` and `options.generatedFile` may be passed to\nset \"sources\" and \"file\", respectively.\n\n      generate: (options = {}, code = null) ->\n        writingline       = 0\n        lastColumn        = 0\n        lastSourceLine    = 0\n        lastSourceColumn  = 0\n        needComma         = no\n        buffer            = \"\"\n\n        for lineMap, lineNumber in @lines when lineMap\n          for mapping in lineMap.columns when mapping\n            while writingline < mapping.line\n              lastColumn = 0\n              needComma = no\n              buffer += \";\"\n              writingline++\n\nWrite a comma if we've already written a segment on this line.\n\n            if needComma\n              buffer += \",\"\n              needComma = no\n\nWrite the next segment. Segments can be 1, 4, or 5 values.  If just one, then it\nis a generated column which doesn't match anything in the source code.\n\nThe starting column in the generated source, relative to any previous recorded\ncolumn for the current line:\n\n            buffer += @encodeVlq mapping.column - lastColumn\n            lastColumn = mapping.column\n\nThe index into the list of sources:\n\n            buffer += @encodeVlq 0\n\nThe starting line in the original source, relative to the previous source line.\n\n            buffer += @encodeVlq mapping.sourceLine - lastSourceLine\n            if lastSourceLine isnt mapping.sourceLine\n              lastSourceLine = mapping.sourceLine\n              lastSourceColumn = 0\n\nThe starting column in the original source, relative to the previous column.\n\n            buffer += @encodeVlq mapping.sourceColumn - lastSourceColumn\n            lastSourceColumn = mapping.sourceColumn\n            needComma = yes\n\nProduce the canonical JSON object format for a \"v3\" source map.\n\n        v3 =\n          version:    3\n          file:       options.generatedFile or ''\n          sourceRoot: options.sourceRoot or ''\n          sources:    options.sourceFiles or ['']\n          names:      []\n          mappings:   buffer\n\n        v3.sourcesContent = [code] if options.inline\n\n        JSON.stringify v3, null, 2\n\n\nBase64 VLQ Encoding\n-------------------\n\nNote that SourceMap VLQ encoding is \"backwards\".  MIDI-style VLQ encoding puts\nthe most-significant-bit (MSB) from the original value into the MSB of the VLQ\nencoded value (see [Wikipedia](http:\/\/en.wikipedia.org\/wiki\/File:Uintvar_coding.svg)).\nSourceMap VLQ does things the other way around, with the least significat four\nbits of the original value encoded into the first byte of the VLQ encoded value.\n\n      VLQ_SHIFT            = 5\n      VLQ_CONTINUATION_BIT = 1 << VLQ_SHIFT             # 0010 0000\n      VLQ_VALUE_MASK       = VLQ_CONTINUATION_BIT - 1   # 0001 1111\n\n      encodeVlq: (value) ->\n        answer = ''\n\n        # Least significant bit represents the sign.\n        signBit = if value < 0 then 1 else 0\n\n        # The next bits are the actual value.\n        valueToEncode = (Math.abs(value) << 1) + signBit\n\n        # Make sure we encode at least one character, even if valueToEncode is 0.\n        while valueToEncode or not answer\n          nextChunk = valueToEncode & VLQ_VALUE_MASK\n          valueToEncode = valueToEncode >> VLQ_SHIFT\n          nextChunk |= VLQ_CONTINUATION_BIT if valueToEncode\n          answer += @encodeBase64 nextChunk\n\n        answer\n\n\nRegular Base64 Encoding\n-----------------------\n\n      BASE64_CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+\/'\n\n      encodeBase64: (value) ->\n        BASE64_CHARS[value] or throw new Error \"Cannot Base64 encode value: #{value}\"\n\n\nOur API for source maps is just the `SourceMap` class.\n\n    module.exports = SourceMap\n\n\n\n","old_contents":"Source maps allow JavaScript runtimes to match running JavaScript back to\nthe original CoffeeScript source code that corresponds to it. In order to\nproduce maps, we must keep track of positions (line number, column number)\nfor every construct in the syntax tree, and be able to generate a map file\n-- which is a compact, VLQ-encoded representation of the JSON serialization\nof this information -- to write out alongside the generated JavaScript.\n\n    {merge} = require '.\/helpers'\n\n\nLineMap\n-------\n\nKeeps track of information about column positions within a single line of\noutput JavaScript code. **SourceMap**s are implemented in terms of **LineMap**s.\n\n    class LineMap\n      constructor: (@line) ->\n        @columns = []\n\n      add: (column, [sourceLine, sourceColumn], options={}) ->\n        return if @columns[column] and options.noReplace\n        @columns[column] = {line: @line, column, sourceLine, sourceColumn}\n\n      sourceLocation: (column) ->\n        column-- until (mapping = @columns[column]) or (column <= 0)\n        mapping and [mapping.sourceLine, mapping.sourceColumn]\n\n\nSourceMap\n---------\n\nMaps locations in for a single generated JavaScript file back to locations in\nthe original CoffeeScript source file.\n\nThis is intentionally agnostic towards how a source map might be represented on\ndisk. Once the compiler is ready to produce a \"v3\"-style source map, we can walk\nthrough the arrays of line and column buffer to produce it.\n\n    class SourceMap\n      constructor: ->\n        @lines = []\n\nAdds a mapping to this SourceMap. `sourceLocation` and `generatedLocation`\nare both `[line, column]` arrays. If `options.noReplace` is true, then if there\nis already a mapping for the specified `line` and `column`, this will have no\neffect.\n\n      add: (sourceLocation, generatedLocation, options = {}) ->\n        [line, column] = generatedLocation\n        lineMap = (@lines[line] or= new LineMap(line))\n        lineMap.add column, sourceLocation, options\n\nLook up the original position of a given `line` and `column` in the generated\ncode.\n\n      sourceLocation: ([line, column]) ->\n        line-- until (lineMap = @lines[line]) or (line <= 0)\n        lineMap and lineMap.sourceLocation column\n\n\nV3 SourceMap Generation\n-----------------------\n\nBuilds up a V3 source map, returning the generated JSON as a string.\n`options.sourceRoot` may be used to specify the sourceRoot written to the source\nmap.  Also, `options.sourceFiles` and `options.generatedFile` may be passed to\nset \"sources\" and \"file\", respectively.\n\n      generate: (options = {}, code = null) ->\n        writingline       = 0\n        lastColumn        = 0\n        lastSourceLine    = 0\n        lastSourceColumn  = 0\n        needComma         = no\n        buffer            = \"\"\n\n        for lineMap, lineNumber in @lines when lineMap\n          for mapping in lineMap.columns when mapping\n            while writingline < mapping.line\n              lastColumn = 0\n              needComma = no\n              buffer += \";\"\n              writingline++\n\nWrite a comma if we've already written a segment on this line.\n\n            if needComma\n              buffer += \",\"\n              needComma = no\n\nWrite the next segment. Segments can be 1, 4, or 5 values.  If just one, then it\nis a generated column which doesn't match anything in the source code.\n\nThe starting column in the generated source, relative to any previous recorded\ncolumn for the current line:\n\n            buffer += @encodeVlq mapping.column - lastColumn\n            lastColumn = mapping.column\n\nThe index into the list of sources:\n\n            buffer += @encodeVlq 0\n\nThe starting line in the original source, relative to the previous source line.\n\n            buffer += @encodeVlq mapping.sourceLine - lastSourceLine\n            if lastSourceLine isnt mapping.sourceLine\n              lastSourceLine = mapping.sourceLine\n              lastSourceColumn = 0\n\nThe starting column in the original source, relative to the previous column.\n\n            buffer += @encodeVlq mapping.sourceColumn - lastSourceColumn\n            lastSourceColumn = mapping.sourceColumn\n            needComma = yes\n\nProduce the canonical JSON object format for a \"v3\" source map.\n\n        v3 =\n          version:    3\n          file:       options.generatedFile or ''\n          sourceRoot: options.sourceRoot or ''\n          sources:    options.sourceFiles or ['']\n          names:      []\n          mappings:   buffer\n\n        v3.sourcesContent = [code] if options.inline\n\n        JSON.stringify v3, null, 2\n\n\nBase64 VLQ Encoding\n-------------------\n\nNote that SourceMap VLQ encoding is \"backwards\".  MIDI-style VLQ encoding puts\nthe most-significant-bit (MSB) from the original value into the MSB of the VLQ\nencoded value (see [Wikipedia](http:\/\/en.wikipedia.org\/wiki\/File:Uintvar_coding.svg)).\nSourceMap VLQ does things the other way around, with the least significat four\nbits of the original value encoded into the first byte of the VLQ encoded value.\n\n      VLQ_SHIFT            = 5\n      VLQ_CONTINUATION_BIT = 1 << VLQ_SHIFT             # 0010 0000\n      VLQ_VALUE_MASK       = VLQ_CONTINUATION_BIT - 1   # 0001 1111\n\n      encodeVlq: (value) ->\n        answer = ''\n\n        # Least significant bit represents the sign.\n        signBit = if value < 0 then 1 else 0\n\n        # The next bits are the actual value.\n        valueToEncode = (Math.abs(value) << 1) + signBit\n\n        # Make sure we encode at least one character, even if valueToEncode is 0.\n        while valueToEncode or not answer\n          nextChunk = valueToEncode & VLQ_VALUE_MASK\n          valueToEncode = valueToEncode >> VLQ_SHIFT\n          nextChunk |= VLQ_CONTINUATION_BIT if valueToEncode\n          answer += @encodeBase64 nextChunk\n\n        answer\n\n\nRegular Base64 Encoding\n-----------------------\n\n      BASE64_CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+\/'\n\n      encodeBase64: (value) ->\n        BASE64_CHARS[value] or throw new Error \"Cannot Base64 encode value: #{value}\"\n\n\nOur API for source maps is just the `SourceMap` class.\n\n    module.exports = SourceMap\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"614a4c7ffa0be54419eccada5b1627b8af95abd8","subject":"Clean up documentation for collection source code","message":"Clean up documentation for collection source code\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    \"use strict\"\n\n    ObjectID    = require('mongodb').ObjectID\n    stringify   = require('JSONStream').stringify\n    createHash  = require('crypto').createHash\n\n    mongo       = require '.\/db\/mongo'\n    cache       = require '.\/cache'\n\n## PARAM collection\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col]\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST, PATCH, PUT'\n      res.send()\n\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n      query = {}\n\n### ?tag=`String`\n\n      if typeof req.query.tag is 'string' and req.query.tag isnt ''\n        if req.query.tag.charAt(0) is '!' and req.query.tag.length > 1\n          query['tags.0'] = $ne: req.query.tag.substr(1)\n        else\n          query['tags.0'] = req.query.tag\n\n### ?grupper=`String`\n\n      if typeof req.query.gruppe is 'string' and req.query.gruppe isnt ''\n        query['grupper'] = req.query.gruppe\n\n### ?after=`Mixed`\n\n      if typeof req.query.after is 'string' and req.query.after isnt ''\n        if not isNaN(req.query.after)\n          req.query.after = new Date(parseInt(req.query.after, 10)).toISOString()\n        query.endret = {$gte:req.query.after}\n\n### ?bbox=`min_lng`,`min_lat`,`max_lng`,`max_lat`\n\n      if typeof req.query.bbox is 'string' and req.query.bbox.split(',').length is 4\n        bbox = req.query.bbox.split(',')\n        bbox[i] = parseFloat(val) for val, i in bbox\n\n        query.geojson =\n          '$geoWithin':\n            '$geometry':\n              type: 'Polygon'\n              coordinates: [[\n                [bbox[0], bbox[1]]\n                [bbox[2], bbox[1]]\n                [bbox[2], bbox[3]]\n                [bbox[0], bbox[3]]\n                [bbox[0], bbox[1]]\n              ]]\n\n### ?privat.`String`=`String`\n\nThis allows the user to filter documents based on private document properties.\nThis will autumaticly limit returned documents to those owned by the current\nuser.\n\n#### ToDo\n\n * Limit number of private fields?\n * Limit depth of private fields?\n\n`NB` This section is looping through all of the url query parameters and hence\nshould take the queries from above sections into concideration so we don't need\nto do double amount of work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.end() if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + Math.min(options.limit, total) + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      #\n      # @TODO move update to :\/collection\/:document\n      # @TODO add access control\n      #\n\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      warnings = []\n      errors   = []\n      message  = ''\n\n      req.body._id = new ObjectID(req.body._id) # @TODO restrict this\n      req.body.tilbyder = req.usr\n      req.body.endret = new Date().toISOString()\n\n      if not req.body.lisens\n        req.body.lisens = 'CC BY-ND-NC 3.0 NO'\n        warnings.push\n          resource: req.type\n          field: 'lisens'\n          value: req.body.lisens\n          code: 'missing_field'\n\n      if not req.body.status\n        req.body.status = 'Kladd'\n        warnings.push\n          resource: req.type\n          field: 'status'\n          value: req.body.status\n          code: 'missing_field'\n\n      req.body.checksum = createHash('md5').update(JSON.stringify(req.body)).digest(\"hex\")\n\n      req.db.col.save req.body, {safe: true, w: 1}, (err) ->\n        return next(err) if err\n        cache.setForType req.type, req.body._id, req.body, (err, data) ->\n          return next(err) if err\n          return res.json 201,\n            document:\n              _id: req.body._id\n            count: 1\n            message: message if message\n            warnings: warnings if warnings.length > 0\n            errors: errors if errors.length > 0\n\n## PATCH \/{collection}\n\n    exports.patch = (req, res, next) ->\n      res.json 501, message: 'HTTP method not implmented'\n\n## PUT \/{collection}\n\n    exports.put = (req, res, next) ->\n      res.json 501, message: 'HTTP method not implmented'\n\n","old_contents":"    \"use strict\"\n\n    ObjectID    = require('mongodb').ObjectID\n    stringify   = require('JSONStream').stringify\n    createHash  = require('crypto').createHash\n\n    mongo       = require '.\/db\/mongo'\n    cache       = require '.\/cache'\n\n## PARAM collection\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col]\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST, PATCH, PUT'\n      res.send()\n\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n      query = {}\n\n### ?tag=`String`\n\n      if typeof req.query.tag is 'string' and req.query.tag isnt ''\n        if req.query.tag.charAt(0) is '!' and req.query.tag.length > 1\n          query['tags.0'] = $ne: req.query.tag.substr(1)\n        else\n          query['tags.0'] = req.query.tag\n\n### ?grupper=`String`\n\n      if typeof req.query.gruppe is 'string' and req.query.gruppe isnt ''\n        query['grupper'] = req.query.gruppe\n\n### ?after=`Mixed`\n\n      if typeof req.query.after is 'string' and req.query.after isnt ''\n        if not isNaN(req.query.after)\n          req.query.after = new Date(parseInt(req.query.after, 10)).toISOString()\n        query.endret = {$gte:req.query.after}\n\n### ?bbox=`min_lng`,`min_lat`,`max_lng`,`max_lat`\n\n      if typeof req.query.bbox is 'string' and req.query.bbox.split(',').length is 4\n        bbox = req.query.bbox.split(',')\n        bbox[i] = parseFloat(val) for val, i in bbox\n\n        query.geojson =\n          '$geoWithin':\n            '$geometry':\n              type: 'Polygon'\n              coordinates: [[\n                [bbox[0], bbox[1]]\n                [bbox[2], bbox[1]]\n                [bbox[2], bbox[3]]\n                [bbox[0], bbox[3]]\n                [bbox[0], bbox[1]]\n              ]]\n\n### ?privat.`String`=`String`\n\n * @TODO(starefossen) limit number of private fields\n * @TODO(starefossen) limit depth of private field\n\n`NB` This secution is itterating over all the url queries and hence should\ntake the queries above into concideration so we don't need to do double work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. status = 'Offentlig'\nif not tilbyder query is not set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.end() if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + Math.min(options.limit, total) + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      #\n      # @TODO move update to :\/collection\/:document\n      # @TODO add access control\n      #\n\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      warnings = []\n      errors   = []\n      message  = ''\n\n      req.body._id = new ObjectID(req.body._id) # @TODO restrict this\n      req.body.tilbyder = req.usr\n      req.body.endret = new Date().toISOString()\n\n      if not req.body.lisens\n        req.body.lisens = 'CC BY-ND-NC 3.0 NO'\n        warnings.push\n          resource: req.type\n          field: 'lisens'\n          value: req.body.lisens\n          code: 'missing_field'\n\n      if not req.body.status\n        req.body.status = 'Kladd'\n        warnings.push\n          resource: req.type\n          field: 'status'\n          value: req.body.status\n          code: 'missing_field'\n\n      req.body.checksum = createHash('md5').update(JSON.stringify(req.body)).digest(\"hex\")\n\n      req.db.col.save req.body, {safe: true, w: 1}, (err) ->\n        return next(err) if err\n        cache.setForType req.type, req.body._id, req.body, (err, data) ->\n          return next(err) if err\n          return res.json 201,\n            document:\n              _id: req.body._id\n            count: 1\n            message: message if message\n            warnings: warnings if warnings.length > 0\n            errors: errors if errors.length > 0\n\n## PATCH \/{collection}\n\n    exports.patch = (req, res, next) ->\n      res.json 501, message: 'HTTP method not implmented'\n\n## PUT \/{collection}\n\n    exports.put = (req, res, next) ->\n      res.json 501, message: 'HTTP method not implmented'\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4408dfee2a2fe69d11bd75a759b0634351d68052","subject":"Remove numberRegex - fixes #6.","message":"Remove numberRegex - fixes #6.\n","repos":"STRML\/node-xlsx-writestream,orgsync\/node-xlsx-writestream","old_file":"src\/index.litcoffee","new_file":"src\/index.litcoffee","new_contents":"Node-XLSX-Stream\n================\n\nNode-XLSX-Stream is written in literate coffeescript. The following is the actual source of the\nmodule.\n\n    fs = require('fs')\n    blobs = require('.\/blobs')\n    Archiver = require('archiver')\n\n    module.exports = class XlsxWriter\n\n\n\n### Simple writes\n\n##### XlsxWriter.write(out: String, data: Array, cb: Function)\n\nThe simplest way to use Node-XLSX-Stream is to use the write method.\n\nThe callback comes directly from `fs.writeFile` and has the arity `(err)`\n\n      # @param {String} out Output file path.\n      # @param {Array} data Data to write.\n      # @param {Function} cb Callback to call when done. Fed (err).\n      @write = (out, data, cb) ->\n        writer = new XlsxWriter({out: out})\n        writer.addRows(data)\n        writer.writeToFile(cb)\n\n### Advanced usage\n\nNode-XLSX-Stream has more advanced features available for better customization\nof spreadsheets.\n\nWhen constructing a writer, pass it an optional file path and customization options.\n\n##### new XlsxWriter([options]: Object) : XlsxWriter\n\n      # Build a writer object.\n      # @param {Object} [options] Preparation options.\n      # @param {String} [options.out] Output file path.\n      # @param {Array}  [options.columns] Column definition. Must be added in constructor.\n      # @example options.columns = [\n      #     {  width: 30 }, \/\/ width is in 'characters'\n      #     {  width: 10 }\n      # ]\n      constructor: (options = {}) ->\n\n        # Support just passing a string path into the constructor.\n        if (typeof options == 'string')\n          options = {out: options}\n\n        # Set options.\n        defaults = {\n          defaultWidth: 15\n          zip: {\n            forceUTC: true # this is required, zips will be unreadable without it\n          },\n          columns: []\n        }\n        @options = _extend(defaults, options)\n\n        # Start sheet.\n        @_resetSheet()\n\n        # Write column definition.\n        @defineColumns(@options.columns)\n\n        # Create Zip.\n        zipOptions = @options.zip || {}\n        zipOptions.forceUTC = true # force this on in all cases for now, otherwise we're useless\n        @zip = Archiver('zip', zipOptions)\n\n        # Archiver attaches an exit listener on the process, we don't want this,\n        # it will fire if this object is never finalized.\n        @zip.catchEarlyExitAttached = true\n\n        # Hook this passthrough into the zip stream.\n        @zip.append(@sheetStream, {name: 'xl\/worksheets\/sheet1.xml'})\n\n#### Adding rows\n\nRows are easy to add one by one or all at once. Data types within the sheet will\nbe inferred from the data types passed to addRow().\n\n##### addRow(row: Object)\n\nAdd a single row.\n\n      # @example (javascript)\n      # writer.addRow({\n      #     \"A String Column\" : \"A String Value\",\n      #     \"A Number Column\" : 12345,\n      #     \"A Date Column\" : new Date(1999,11,31)\n      # })\n      addRow: (row) ->\n\n        # Values in header are defined by the keys of the object we've passed in.\n        # They need to be written the first time they're passed in.\n        if !@haveHeader\n          @_write(blobs.sheetDataHeader)\n          @_startRow()\n          col = 1\n          for key of row\n            @_addCell(key, col)\n            @cellMap.push(key)\n            col += 1\n          @_endRow()\n\n          @haveHeader = true\n\n        @_startRow()\n        for key, col in @cellMap\n          @_addCell(row[key] || \"\", col + 1)\n        @_endRow()\n\n##### addRows(rows: Array)\n\nRows can be added in batch.\n\n      addRows: (rows) ->\n        for row in rows\n          @addRow(row)\n\n##### defineColumns(columns: Array)\n\nColumn definitions can be easily added, but it *must* be done before rows are added\nto prevent a nasty Excel bug.\n\n      # @example (javascript)\n      # writer.defineColumns([\n      #     {  width: 30 }, \/\/ width is in 'characters'\n      #     {  width: 10 }\n      # ])\n      defineColumns: (columns) ->\n        if @haveHeader\n          throw new Error \"\"\"\n            Columns cannot be added after rows! Unfortunately Excel will crash\n            if column definitions come after sheet data. Please move your `defineColumns()`\n            call before any `addRow()` calls, or define options.columns in the XlsxWriter\n            constructor.\n          \"\"\"\n        @options.columns = columns\n        # Write column metadata.\n        # Would really like to do this at the end so that we don't have to mandate\n        # it comes first, but Excel pukes if <cols> comes before <sheetData>.\n        @_write(@_generateColumnDefinition())\n\n\n#### File generation\n\nOnce you are done adding rows & defining columns, you have a few options\nfor generating the file. The `writeToFile` helper is a one-stop-shop for writing\ndirectly to a file using `fs.writeFile`; otherwise, you can pack() manually,\nwhich will return a readable stream.\n\n##### writeToFile([fileName]: String, cb: Function)\n\nWrites data to a file. Convenience method.\n\nIf no filename is specified, will attempt to use the one specified in the\nconstructor as `options.out`.\n\nThe callback is fed directly to `fs.writeFile`.\n\n      # @param {String} [fileName] File path to write.\n      # @param {Function} cb Callback.\n      writeToFile: (fileName, cb) ->\n        if fileName instanceof Function\n          cb = fileName\n          fileName = @options.out\n        if !fileName\n          throw new Error(\"Filename required. Supply one in writeToFile() or in options.out.\")\n\n        # Create zip, pipe it into a file writeStream.\n        zip = @createReadStream(fileName)\n        fileStream = fs.createWriteStream(fileName)\n        fileStream.once 'finish', cb\n        zip.pipe(fileStream)\n        @finalize()\n\n##### createReadStream() : Stream **Deprecated**\n\n      # @return {Stream} Readable stream with ZIP data.\n      createReadStream: () ->\n        @getReadStream()\n\n##### getReadStream() : Stream\n\nReturns a readable stream from this file. You can pipe this directly to a file\nor response object. Be sure to use 'binary' mode.\n\nYou are responsible for indicating that you have finished\nthe file generation by calling `finalize()`, which will end the sheet stream.\n\n      # @return {Stream} Readable stream with ZIP data.\n      getReadStream: () ->\n        @zip\n\n##### finalize()\n\nFinishes up the sheet & generate shared strings. You must call this manually if\nyou are using `createReadStream`.\n\n      finalize: () ->\n\n        if @finalized\n          throw new Error \"This XLSX was already finalized.\"\n\n        # Mark this as finished\n        @finalized = true\n\n        # If there was data, end sheetData\n        if @haveHeader\n          @_write(blobs.sheetDataFooter)\n\n        # Write relationships data.\n        @_write(blobs.worksheetRels(@relationships))\n\n        # Generate shared strings\n        @_generateStrings()\n\n        # Generate external rels\n        @_generateRelationships()\n\n        # End sheet\n        @sheetStream.end(blobs.sheetFooter)\n\n        # Add supporting files to zip and finalize it. The readStream (@zip) will soon emit\n        # an 'end' event.\n        @_finalizeZip()\n\n##### dispose()\n\nCancel use of this writer and close all streams. This is not needed if you've written to a file.\n\n      dispose: () ->\n        return if @disposed\n\n        @sheetStream.end()\n        @sheetStream.unpipe()\n        @zip.unpipe()\n        while(@zip.read()) # drain stream\n          1; # noop\n        delete @zip\n        delete @sheetStream\n        @disposed = true\n\n\n#### Internal methods\n\n\nAdds a cell to the row in progress.\n\n      # @param {String|Number|Date} value Value to write.\n      # @param {Number}             col   Column index.\n      _addCell: (value = '', col) ->\n        row = @currentRow\n        cell = @_getCellIdentifier(row, col)\n\n        # Hyperlink support\n        if Object.prototype.toString.call(value) == '[object Object]'\n          if !value.value || !value.hyperlink\n            throw new Error(\"A hyperlink cell must have both 'value' and 'hyperlink' keys.\")\n          @_addCell(value.value, col)\n          @_createRelationship(cell, value.hyperlink)\n          return\n\n        if typeof value == 'number'\n          @rowBuffer += blobs.numberCell(value, cell)\n        else if value instanceof Date\n          date = @_dateToOADate(value)\n          @rowBuffer += blobs.dateCell(date, cell)\n        else\n          index = @_lookupString(value)\n          @rowBuffer += blobs.cell(index, cell)\n\n\n\nBegins a row. Call this before starting any row. Will start a buffer\nfor all proceeding cells, until @_endRow is called.\n\n      _startRow: () ->\n        @rowBuffer = blobs.startRow(@currentRow)\n        @currentRow += 1\n\nEnds a row. Will write the row to the sheet.\n\n      _endRow: () ->\n        @_write(@rowBuffer + blobs.endRow)\n\n\nGiven row and column indices, returns a cell identifier, e.g. \"E20\"\n\n      # @param {Number} row  Row index.\n      # @param {Number} cell Cell index.\n      # @return {String}     Cell identifier.\n      _getCellIdentifier: (row, col) ->\n        colIndex = ''\n        if @cellLabelMap[col]\n          colIndex = @cellLabelMap[col]\n        else\n          if col == 0\n            # Provide a fallback for empty spreadsheets\n            row = 1\n            col = 1\n\n          input = (+col - 1).toString(26)\n          while input.length\n            a = input.charCodeAt(input.length - 1)\n            colIndex = String.fromCharCode(a + if a >= 48 and a <= 57 then 17 else -22) + colIndex\n            input = if input.length > 1 then (parseInt(input.substr(0, input.length - 1), 26) - 1).toString(26) else \"\"\n          @cellLabelMap[col] = colIndex\n\n        return colIndex + row\n\nCreates column definitions, if any definitions exist.\nThis will write column styles, widths, etc.\n\n      # @return {String} Column definition.\n      _generateColumnDefinition: () ->\n        # <cols\/> tag (empty) crashes excel, weeeeee\n        if !@options.columns || !@options.columns.length\n          return ''\n\n        columnDefinition = ''\n        columnDefinition += blobs.startColumns\n\n        idx = 1\n        for index, column of @options.columns\n          columnDefinition += blobs.column(column.width || @options.defaultWidth, idx)\n          idx += 1\n\n        columnDefinition += blobs.endColumns\n        return columnDefinition\n\nGenerates StringMap XML. Used as a finalization step - don't call this while\nbuilding the xlsx is in progress.\n\nSaves string data to this object so it can be written to the zip.\n\n      _generateStrings: () ->\n        stringTable = ''\n        for string in @strings\n          stringTable += blobs.string(@escapeXml(string))\n        @stringsData = blobs.stringsHeader(@strings.length) + stringTable + blobs.stringsFooter\n\nLooks up a string inside the internal string map. If it doesn't exist, it will be added to the map.\n\n      # @param {String} value String to look up.\n      # @return {Number}      Index within the string map where this string is located.\n      _lookupString: (value) ->\n        if !@stringMap[value]\n          @stringMap[value] = @stringIndex\n          @strings.push(value)\n          @stringIndex += 1\n        return @stringMap[value]\n\nCreate a relationship. For now, this is always a hyperlink.\nThis writes to a array that will later be used define the rels.\n\n      _createRelationship: (cell, target) ->\n        @relationships.push({cell: cell, target: target})\n\nGenerate external relationships data. This is saved into \"xl\/worksheets\/_rels\/sheet1.xml.rels\".\n\n      _generateRelationships: () ->\n        @relsData = blobs.externalWorksheetRels(@relationships)\n\nConverts a Date to an OADate.\nSee [this stackoverflow post](http:\/\/stackoverflow.com\/a\/15550284\/2644351)\n\n      # @param {Date} date Date to convert.\n      # @return {Number}   OADate.\n      _dateToOADate: (date) ->\n        epoch = new Date(1899,11,30)\n        msPerDay = 8.64e7\n\n        v = -1 * (epoch - date) \/ msPerDay\n\n        # Deal with dates prior to 1899-12-30 00:00:00\n        dec = v - Math.floor(v)\n\n        if v < 0 and dec\n          v = Math.floor(v) - dec\n\n        return v\n\nConvert an OADate to a Date.\n\n      # @param {Number} oaDate OADate.\n      # @return {Date}         Converted date.\n      _OADateToDate: (oaDate) ->\n        epoch = new Date(1899,11,30)\n        msPerDay = 8.64e7\n\n        # Deal with -ve values\n        dec = oaDate - Math.floor(oaDate)\n\n        if oaDate < 0 and dec\n          oaDate = Math.floor(oaDate) - dec\n\n        return new Date(oaDate * msPerDay + +epoch)\n\nResets sheet data. Called on initialization.\n\n      _resetSheet: () ->\n\n        # Sheet data storage.\n        @sheetData = ''\n        @strings = []\n        @stringMap = {}\n        @stringIndex = 0\n        @stringData = null\n        @currentRow = 0\n\n        # Cell data storage\n        @cellMap = []\n        @cellLabelMap = {}\n\n        # Column data storage\n        @columns = []\n\n        # Rels data storage\n        @relData = ''\n        @relationships = []\n\n        # Flags\n        @haveHeader = false\n        @finalized = false\n\n        # Create sheet stream.\n        PassThrough = require('stream').PassThrough\n        @sheetStream = new PassThrough()\n\n        # Start off the sheet.\n        @_write(blobs.sheetHeader)\n\nFinalizes this file and adds supporting docs. Should not be called directly.\n\n      _finalizeZip: () ->\n        @zip\n          .append(blobs.contentTypes, {name: '[Content_Types].xml'})\n          .append(blobs.rels, {name: '_rels\/.rels'})\n          .append(blobs.workbook, {name: 'xl\/workbook.xml'})\n          .append(blobs.styles, {name: 'xl\/styles.xml'})\n          .append(blobs.workbookRels, {name: 'xl\/_rels\/workbook.xml.rels'})\n          .append(@relsData, {name: 'xl\/worksheets\/_rels\/sheet1.xml.rels'})\n          .append(@stringsData, {name: 'xl\/sharedStrings.xml'})\n          .finalize()\n\nWrapper around writing sheet data.\n\n      # @param {String} data Data to write to the sheet.\n      _write: (data) ->\n        @sheetStream.write(data)\n\nUtility method for escaping XML - used within blobs and can be used manually.\n\n      # @param {String} str String to escape.\n      escapeXml: (str = '') ->\n        return str.replace(\/&\/g, '&amp;')\n          .replace(\/<\/g, '&lt;')\n          .replace(\/>\/g, '&gt;')\n\nSimple extend helper.\n\n    _extend = (dest, src) ->\n      for key, val of src\n        dest[key] = val\n      dest\n","old_contents":"Node-XLSX-Stream\n================\n\nNode-XLSX-Stream is written in literate coffeescript. The following is the actual source of the \nmodule.\n\n    fs = require('fs')\n    blobs = require('.\/blobs')\n    Archiver = require('archiver')\n    numberRegex = \/^[1-9\\.][\\d\\.]+$\/\n\n    module.exports = class XlsxWriter\n\n\n\n### Simple writes\n\n##### XlsxWriter.write(out: String, data: Array, cb: Function)\n\nThe simplest way to use Node-XLSX-Stream is to use the write method.\n\nThe callback comes directly from `fs.writeFile` and has the arity `(err)`\n\n      # @param {String} out Output file path.\n      # @param {Array} data Data to write.\n      # @param {Function} cb Callback to call when done. Fed (err).\n      @write = (out, data, cb) ->\n        writer = new XlsxWriter({out: out})\n        writer.addRows(data)\n        writer.writeToFile(cb)\n\n### Advanced usage\n\nNode-XLSX-Stream has more advanced features available for better customization\nof spreadsheets.\n\nWhen constructing a writer, pass it an optional file path and customization options.\n\n##### new XlsxWriter([options]: Object) : XlsxWriter\n\n      # Build a writer object.\n      # @param {Object} [options] Preparation options.\n      # @param {String} [options.out] Output file path.\n      # @param {Array}  [options.columns] Column definition. Must be added in constructor.\n      # @example options.columns = [\n      #     {  width: 30 }, \/\/ width is in 'characters'\n      #     {  width: 10 }\n      # ]\n      constructor: (options = {}) ->\n\n        # Support just passing a string path into the constructor.\n        if (typeof options == 'string')\n          options = {out: options}\n\n        # Set options.\n        defaults = {\n          defaultWidth: 15\n          zip: {\n            forceUTC: true # this is required, zips will be unreadable without it\n          },\n          columns: []\n        }\n        @options = _extend(defaults, options)\n\n        # Start sheet.\n        @_resetSheet()\n\n        # Write column definition.\n        @defineColumns(@options.columns)\n\n        # Create Zip.\n        zipOptions = @options.zip || {}\n        zipOptions.forceUTC = true # force this on in all cases for now, otherwise we're useless\n        @zip = Archiver('zip', zipOptions)\n\n        # Archiver attaches an exit listener on the process, we don't want this,\n        # it will fire if this object is never finalized.\n        @zip.catchEarlyExitAttached = true\n\n        # Hook this passthrough into the zip stream.\n        @zip.append(@sheetStream, {name: 'xl\/worksheets\/sheet1.xml'})\n\n#### Adding rows\n\nRows are easy to add one by one or all at once. Data types within the sheet will \nbe inferred from the data types passed to addRow().\n\n##### addRow(row: Object)\n\nAdd a single row.\n\n      # @example (javascript)\n      # writer.addRow({\n      #     \"A String Column\" : \"A String Value\",\n      #     \"A Number Column\" : 12345,\n      #     \"A Date Column\" : new Date(1999,11,31)\n      # })\n      addRow: (row) ->\n\n        # Values in header are defined by the keys of the object we've passed in.\n        # They need to be written the first time they're passed in.\n        if !@haveHeader\n          @_write(blobs.sheetDataHeader)\n          @_startRow()\n          col = 1\n          for key of row\n            @_addCell(key, col)\n            @cellMap.push(key)\n            col += 1\n          @_endRow()\n\n          @haveHeader = true\n\n        @_startRow()\n        for key, col in @cellMap\n          @_addCell(row[key] || \"\", col + 1)\n        @_endRow()\n\n##### addRows(rows: Array)\n\nRows can be added in batch.\n\n      addRows: (rows) ->\n        for row in rows\n          @addRow(row)\n\n##### defineColumns(columns: Array)\n\nColumn definitions can be easily added, but it *must* be done before rows are added\nto prevent a nasty Excel bug.\n\n      # @example (javascript)\n      # writer.defineColumns([\n      #     {  width: 30 }, \/\/ width is in 'characters'\n      #     {  width: 10 }\n      # ])\n      defineColumns: (columns) ->\n        if @haveHeader\n          throw new Error \"\"\"\n            Columns cannot be added after rows! Unfortunately Excel will crash\n            if column definitions come after sheet data. Please move your `defineColumns()`\n            call before any `addRow()` calls, or define options.columns in the XlsxWriter\n            constructor.\n          \"\"\"\n        @options.columns = columns\n        # Write column metadata.\n        # Would really like to do this at the end so that we don't have to mandate\n        # it comes first, but Excel pukes if <cols> comes before <sheetData>.\n        @_write(@_generateColumnDefinition())\n\n\n#### File generation\n\nOnce you are done adding rows & defining columns, you have a few options\nfor generating the file. The `writeToFile` helper is a one-stop-shop for writing\ndirectly to a file using `fs.writeFile`; otherwise, you can pack() manually,\nwhich will return a readable stream.\n\n##### writeToFile([fileName]: String, cb: Function)\n\nWrites data to a file. Convenience method.\n\nIf no filename is specified, will attempt to use the one specified in the\nconstructor as `options.out`.\n\nThe callback is fed directly to `fs.writeFile`.\n\n      # @param {String} [fileName] File path to write.\n      # @param {Function} cb Callback.\n      writeToFile: (fileName, cb) ->\n        if fileName instanceof Function\n          cb = fileName\n          fileName = @options.out\n        if !fileName\n          throw new Error(\"Filename required. Supply one in writeToFile() or in options.out.\")\n\n        # Create zip, pipe it into a file writeStream.\n        zip = @createReadStream(fileName)\n        fileStream = fs.createWriteStream(fileName)\n        fileStream.once 'finish', cb\n        zip.pipe(fileStream)\n        @finalize()\n\n##### createReadStream() : Stream **Deprecated**\n\n      # @return {Stream} Readable stream with ZIP data.\n      createReadStream: () ->\n        @getReadStream()\n\n##### getReadStream() : Stream\n\nReturns a readable stream from this file. You can pipe this directly to a file\nor response object. Be sure to use 'binary' mode.\n\nYou are responsible for indicating that you have finished\nthe file generation by calling `finalize()`, which will end the sheet stream.\n\n      # @return {Stream} Readable stream with ZIP data.\n      getReadStream: () ->\n        @zip\n\n##### finalize()\n\nFinishes up the sheet & generate shared strings. You must call this manually if\nyou are using `createReadStream`.\n\n      finalize: () ->\n\n        if @finalized\n          throw new Error \"This XLSX was already finalized.\"\n\n        # Mark this as finished\n        @finalized = true\n\n        # If there was data, end sheetData\n        if @haveHeader\n          @_write(blobs.sheetDataFooter)\n\n        # Write relationships data.\n        @_write(blobs.worksheetRels(@relationships))\n\n        # Generate shared strings\n        @_generateStrings()\n\n        # Generate external rels\n        @_generateRelationships()\n\n        # End sheet\n        @sheetStream.end(blobs.sheetFooter)\n\n        # Add supporting files to zip and finalize it. The readStream (@zip) will soon emit\n        # an 'end' event.\n        @_finalizeZip()\n\n##### dispose()\n\nCancel use of this writer and close all streams. This is not needed if you've written to a file.\n\n      dispose: () ->\n        return if @disposed\n\n        @sheetStream.end()\n        @sheetStream.unpipe()\n        @zip.unpipe()\n        while(@zip.read()) # drain stream\n          1; # noop\n        delete @zip\n        delete @sheetStream\n        @disposed = true\n\n\n#### Internal methods\n\n\nAdds a cell to the row in progress.\n\n      # @param {String|Number|Date} value Value to write.\n      # @param {Number}             col   Column index.\n      _addCell: (value = '', col) ->\n        row = @currentRow\n        cell = @_getCellIdentifier(row, col)\n\n        # Hyperlink support\n        if Object.prototype.toString.call(value) == '[object Object]'\n          if !value.value || !value.hyperlink\n            throw new Error(\"A hyperlink cell must have both 'value' and 'hyperlink' keys.\")\n          @_addCell(value.value, col)\n          @_createRelationship(cell, value.hyperlink)\n          return\n\n        if typeof value == 'number' or numberRegex.test(value)\n          @rowBuffer += blobs.numberCell(value, cell)\n        else if value instanceof Date\n          date = @_dateToOADate(value)\n          @rowBuffer += blobs.dateCell(date, cell)\n        else\n          index = @_lookupString(value)\n          @rowBuffer += blobs.cell(index, cell)\n\n\n\nBegins a row. Call this before starting any row. Will start a buffer\nfor all proceeding cells, until @_endRow is called.\n\n      _startRow: () ->\n        @rowBuffer = blobs.startRow(@currentRow)\n        @currentRow += 1\n\nEnds a row. Will write the row to the sheet.\n\n      _endRow: () ->\n        @_write(@rowBuffer + blobs.endRow)\n\n\nGiven row and column indices, returns a cell identifier, e.g. \"E20\"\n\n      # @param {Number} row  Row index.\n      # @param {Number} cell Cell index.\n      # @return {String}     Cell identifier.\n      _getCellIdentifier: (row, col) ->\n        colIndex = ''\n        if @cellLabelMap[col]\n          colIndex = @cellLabelMap[col]\n        else\n          if col == 0\n            # Provide a fallback for empty spreadsheets\n            row = 1\n            col = 1\n\n          input = (+col - 1).toString(26)\n          while input.length\n            a = input.charCodeAt(input.length - 1)\n            colIndex = String.fromCharCode(a + if a >= 48 and a <= 57 then 17 else -22) + colIndex\n            input = if input.length > 1 then (parseInt(input.substr(0, input.length - 1), 26) - 1).toString(26) else \"\"\n          @cellLabelMap[col] = colIndex\n\n        return colIndex + row\n\nCreates column definitions, if any definitions exist.\nThis will write column styles, widths, etc.\n\n      # @return {String} Column definition.\n      _generateColumnDefinition: () ->\n        # <cols\/> tag (empty) crashes excel, weeeeee\n        if !@options.columns || !@options.columns.length\n          return ''\n\n        columnDefinition = ''\n        columnDefinition += blobs.startColumns\n\n        idx = 1\n        for index, column of @options.columns\n          columnDefinition += blobs.column(column.width || @options.defaultWidth, idx)\n          idx += 1\n\n        columnDefinition += blobs.endColumns\n        return columnDefinition\n\nGenerates StringMap XML. Used as a finalization step - don't call this while\nbuilding the xlsx is in progress.\n\nSaves string data to this object so it can be written to the zip.\n\n      _generateStrings: () ->\n        stringTable = ''\n        for string in @strings\n          stringTable += blobs.string(@escapeXml(string))\n        @stringsData = blobs.stringsHeader(@strings.length) + stringTable + blobs.stringsFooter\n\nLooks up a string inside the internal string map. If it doesn't exist, it will be added to the map.\n\n      # @param {String} value String to look up.\n      # @return {Number}      Index within the string map where this string is located.\n      _lookupString: (value) ->\n        if !@stringMap[value]\n          @stringMap[value] = @stringIndex\n          @strings.push(value)\n          @stringIndex += 1\n        return @stringMap[value]\n\nCreate a relationship. For now, this is always a hyperlink. \nThis writes to a array that will later be used define the rels.\n\n      _createRelationship: (cell, target) ->\n        @relationships.push({cell: cell, target: target})\n\nGenerate external relationships data. This is saved into \"xl\/worksheets\/_rels\/sheet1.xml.rels\".\n\n      _generateRelationships: () ->\n        @relsData = blobs.externalWorksheetRels(@relationships)\n\nConverts a Date to an OADate.\nSee [this stackoverflow post](http:\/\/stackoverflow.com\/a\/15550284\/2644351)\n\n      # @param {Date} date Date to convert.\n      # @return {Number}   OADate.\n      _dateToOADate: (date) ->\n        epoch = new Date(1899,11,30)\n        msPerDay = 8.64e7\n\n        v = -1 * (epoch - date) \/ msPerDay\n\n        # Deal with dates prior to 1899-12-30 00:00:00\n        dec = v - Math.floor(v)\n\n        if v < 0 and dec\n          v = Math.floor(v) - dec\n\n        return v\n\nConvert an OADate to a Date.\n\n      # @param {Number} oaDate OADate.\n      # @return {Date}         Converted date.\n      _OADateToDate: (oaDate) ->\n        epoch = new Date(1899,11,30)\n        msPerDay = 8.64e7\n\n        # Deal with -ve values\n        dec = oaDate - Math.floor(oaDate)\n\n        if oaDate < 0 and dec\n          oaDate = Math.floor(oaDate) - dec\n\n        return new Date(oaDate * msPerDay + +epoch)\n\nResets sheet data. Called on initialization.\n\n      _resetSheet: () ->\n\n        # Sheet data storage.\n        @sheetData = ''\n        @strings = []\n        @stringMap = {}\n        @stringIndex = 0\n        @stringData = null\n        @currentRow = 0\n\n        # Cell data storage\n        @cellMap = []\n        @cellLabelMap = {}\n\n        # Column data storage\n        @columns = []\n\n        # Rels data storage\n        @relData = ''\n        @relationships = []\n\n        # Flags\n        @haveHeader = false\n        @finalized = false\n\n        # Create sheet stream.\n        PassThrough = require('stream').PassThrough\n        @sheetStream = new PassThrough()\n\n        # Start off the sheet.\n        @_write(blobs.sheetHeader)\n\nFinalizes this file and adds supporting docs. Should not be called directly.\n\n      _finalizeZip: () ->\n        @zip\n          .append(blobs.contentTypes, {name: '[Content_Types].xml'})\n          .append(blobs.rels, {name: '_rels\/.rels'})\n          .append(blobs.workbook, {name: 'xl\/workbook.xml'})\n          .append(blobs.styles, {name: 'xl\/styles.xml'})\n          .append(blobs.workbookRels, {name: 'xl\/_rels\/workbook.xml.rels'})\n          .append(@relsData, {name: 'xl\/worksheets\/_rels\/sheet1.xml.rels'})\n          .append(@stringsData, {name: 'xl\/sharedStrings.xml'})\n          .finalize()\n\nWrapper around writing sheet data.\n\n      # @param {String} data Data to write to the sheet.\n      _write: (data) ->\n        @sheetStream.write(data)\n\nUtility method for escaping XML - used within blobs and can be used manually.\n\n      # @param {String} str String to escape.\n      escapeXml: (str = '') ->\n        return str.replace(\/&\/g, '&amp;')\n          .replace(\/<\/g, '&lt;')\n          .replace(\/>\/g, '&gt;')\n\nSimple extend helper.\n\n    _extend = (dest, src) ->\n      for key, val of src\n        dest[key] = val\n      dest\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"edc6ec5164b143ec359eceb9faf5b98034462dd8","subject":"Docs for conjunction \/ disjunction","message":"Docs for conjunction \/ disjunction\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\n\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\n\n\n  F.conj = () ->\n    clauses = _.toArray(arguments)\n    return F.succeed if _.isEmpty(clauses)\n    return _.first(clauses) if _.size(clauses) is 1\n    conjunction(_.first(clauses),\n                (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\n  # Knowledge representation\n  # ------------------------\n\n  class LVar\n    constructor: (@name) ->\n\n  F.lvar = (name) -> new LVar(name)\n  F.isLVar = (v) -> (v instanceof LVar)\n\n  find = (v, bindings) ->\n    lvar = bindings.lookup(v)\n    return lvar if F.isLVar(v)\n    if _.isArray(lvar)\n      if _.isEmpty(lvar)\n        return lvar\n      else\n        return _.cons(find(_.first(lvar), bindings), find(_.rest(lvar), bindings))\n    lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\n\n\n  disjunction = (l, r) ->\n    (x) -> _.cat(l(x), r(x))\n  conjunction = (l, r) ->\n    (x) -> _.mapcat(l(x), r)\n\n  F.disj = () ->\n    return F.fail if _.isEmpty(arguments)\n    disjunction(_.first(arguments), F.disj.apply(this, _.rest(arguments)))\n\n  F.conj = () ->\n    clauses = _.toArray(arguments)\n    return F.succeed if _.isEmpty(clauses)\n    return _.first(clauses) if _.size(clauses) is 1\n    conjunction(_.first(clauses),\n                (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\n  # Knowledge representation\n  # ------------------------\n\n  class LVar\n    constructor: (@name) ->\n\n  F.lvar = (name) -> new LVar(name)\n  F.isLVar = (v) -> (v instanceof LVar)\n\n  find = (v, bindings) ->\n    lvar = bindings.lookup(v)\n    return lvar if F.isLVar(v)\n    if _.isArray(lvar)\n      if _.isEmpty(lvar)\n        return lvar\n      else\n        return _.cons(find(_.first(lvar), bindings), find(_.rest(lvar), bindings))\n    lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"050539d2db5cb0b8c3461b9d1d34e02fa98d0534","subject":"Highlight language of partner in crime","message":"Highlight language of partner in crime\n","repos":"mhkeller\/docco,osharim\/docco,guigrpa\/docco,STRd6\/docco,gvithellyna\/docco,mhkeller\/docco,lobrien\/docco,jalleyne\/docco,whitetrefoil\/docco,tbremer\/docco,lbn\/docco,Hellyna\/docco,jalleyne\/docco,lbn\/docco,erikdiessel\/plidoc,oponder\/docco,jrvidal\/docco,gvithellyna\/docco,JonathanMatthey\/codeconv,DoomHammer\/docco,erikdiessel\/plidoc,MaxwellRebo\/docco,actano\/docco,whitetrefoil\/docco,jrvidal\/docco,guigrpa\/docco-extended,ShawnHuang\/docco-multidir,DoomHammer\/docco,Hellyna\/docco,ShawnHuang\/docco-multidir,MaxwellRebo\/docco,guigrpa\/docco,robertmackenzie\/docco,oponder\/docco,guigrpa\/docco-extended,lobrien\/docco,osharim\/docco,tbremer\/docco,robertmackenzie\/docco","old_file":"docco.litcoffee","new_file":"docco.litcoffee","new_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.com\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.com\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.com\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.com\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* Your all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.com\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.com\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.com\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        for line, i in lines\n          lines[i] = if \/^\\s*$\/.test line\n            ''\n          else if match = (\/^([ ]{4}|\\t)\/).exec line\n            line[match[0].length..]\n          else\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n          prev = 'text'\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n          prev = 'code'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n      for section, i in sections\n        code = highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    {highlight} = require 'highlight.js'\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    for ext, l of languages\n\nDoes the line begin with a comment?\n\n      l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_(Unix\\)) and interpolations...\n\n      l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, version}\n","old_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If **Node.js** doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.com\/rocco\/rocco.html), the Ruby port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.com\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.com\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.com\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* Your all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.com\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.com\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.com\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        for line, i in lines\n          lines[i] = if \/^\\s*$\/.test line\n            ''\n          else if match = (\/^([ ]{4}|\\t)\/).exec line\n            line[match[0].length..]\n          else\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n          prev = 'text'\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n          prev = 'code'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n      for section, i in sections\n        code = highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    {highlight} = require 'highlight.js'\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    for ext, l of languages\n\nDoes the line begin with a comment?\n\n      l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_(Unix\\)) and interpolations...\n\n      l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, version}\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e803d6318177d3c1524d00b54524e1cf0f9092fc","subject":"added missing dog","message":"added missing dog\n","repos":"nhz-io\/cnl","old_file":"source\/component.litcoffee","new_file":"source\/component.litcoffee","new_contents":"# CLASS: Component\n* Extends: [Shape][Shape]\n* Parent: [Index][Parent]\n\nAn interactive component. A component exists in 3 states:\n**active**, **hover** and **normal**. There is an additional state,\nbut it can't really be considered a state, it is just `null`.\nThe states change depending on mouse actions and underlying shape\nregions.\n\n---\n\n    Event = require 'ecl\/dist\/event'\n    module.exports = class Component extends require '.\/shape'\n\n## CONSTRUCTOR\n### new Component()\n* Returns: [Component][Component]\n\nCreates Component instance.\n\n      constructor: ->\n        super\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['grab', 'release', 'drag']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['grab', 'release', 'drag']\n\nAdd capturing extendable listener\n          \n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n          \n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **mousemove** event passing throught this component\n\n      mousemoveCaptureListener: (event) ->\n        super\n\nProceed only for valid event\n\n        if event\n          $ = @___runtime\n\nReset component state.\n\n          @state = null\n\nIf component is grabbed then set the state to **active**.\n\n          if $.grab\n            @state = 'active'\n\nCreate **drag** Event and broadcast it to this component if drag event is enabled,\n\n            if @events?.drag\n              @broadcastEvent new Event\n                type:'drag', x:event.x, y:event.y\n\nsetting the drag offset.\n\n                offsetX: event.x - ($.dragEvent?.x or $.grabEvent?.x or 0)\n                offsetY: event.y - ($.dragEvent?.y or $.grabEvent?.y or 0)\n\nOtherwise, set the state to the name of the first matching region in order.\n\n          else if regions = event.regions\n            @state = (if regions.hover then 'hover' else if regions.normal then 'normal')\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #mousedownListener(event)\n* Returns: [Component][Component]\n\nReceive **mousedown** event.\n\n      mousedownListener: (event) ->\n        super\n\nProceed only for valid event\n\n        if event\n\nIf component is in active state and **grab** event is enabled then grab this component.\n\n          if (@state is 'active') and @events?.grab\n            ($ = @___runtime).grab = true\n\nCreate **grab** event and deliver it to this component.\n          \n            $.dragEvent = null\n            @broadcastEvent new Event\n              type:'grab', x:event.x, y:event.y\n          \n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #dragCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **drag** events passing through this component\n\n      dragCaptureListener: (event) ->\n\nProceed only for valid event\n\n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.dragEvent = event\n          @localizeEventCoordinates event, @origin\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #grabCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **grab** events passing through this component.\n\n      grabCaptureListener: (event) ->\n\nProceed only for valid event\n        \n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.grabEvent = event\n          @localizeEventCoordinates event, @origin\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n* Returns: [Component][Component]\n\nCapture **release** events passing through this component.\n\n      releaseCaptureListener: (event) ->\n\nProceed only for valid event\n        \n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.releaseEvent = event\n          @localizeEventCoordinates event, @origin\n          \n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n* Returns: [Component][Component]\n\n#### #dragListener(event)\n* Returns: [Component][Component]\n\n**drag** event receiver stub.\n\n      dragListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #grabListener(event)\n* Returns: [Component][Component]\n\n**grab** event receiver stub.\n\n      grabListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n### #releaseListener(event)\n* Returns: [Component][Component]\n\n**release** event receiver stub.\n\n      releaseListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n[Parent]: .\/index.litcoffee\n[Shape]: .\/shape.litcoffee\n[Component]: .\/component.litcoffee\n","old_contents":"# CLASS: Component\n* Extends: [Shape][Shape]\n* Parent: [Index][Parent]\n\nAn interactive component. A component exists in 3 states:\n**active**, **hover** and **normal**. There is an additional state,\nbut it can't really be considered a state, it is just `null`.\nThe states change depending on mouse actions and underlying shape\nregions.\n\n---\n\n    Event = require 'ecl\/dist\/event'\n    module.exports = class Component extends require '.\/shape'\n\n## CONSTRUCTOR\n### new Component()\n* Returns: [Component][Component]\n\nCreates Component instance.\n\n      constructor: ->\n        super\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['grab', 'release', 'drag']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['grab', 'release', 'drag']\n\nAdd capturing extendable listener\n          \n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n          \n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **mousemove** event passing throught this component\n\n      mousemoveCaptureListener: (event) ->\n        super\n\nProceed only for valid event\n\n        if event\n          $ = @___runtime\n\nReset component state.\n\n          @state = null\n\nIf component is grabbed then set the state to **active**.\n\n          if $.grab\n            @state = 'active'\n\nCreate **drag** Event and broadcast it to this component if drag event is enabled,\n\n            if @events?.drag\n              @broadcastEvent new Event\n                type:'drag', x:event.x, y:event.y\n\nsetting the drag offset.\n\n                offsetX: event.x - ($.dragEvent?.x or $.grabEvent?.x or 0)\n                offsetY: event.y - ($.dragEvent?.y or $.grabEvent?.y or 0)\n\nOtherwise, set the state to the name of the first matching region in order.\n\n          else if regions = event.regions\n            @state = (if regions.hover then 'hover' else if regions.normal then 'normal')\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #mousedownListener(event)\n* Returns: [Component][Component]\n\nReceive **mousedown** event.\n\n      mousedownListener: (event) ->\n        super\n\nProceed only for valid event\n\n        if event\n\nIf component is in active state and **grab** event is enabled then grab this component.\n\n          if (@state is 'active') and @events?.grab\n            ($ = @___runtime).grab = true\n\nCreate **grab** event and deliver it to this component.\n          \n            $.dragEvent = null\n            @broadcastEvent new Event\n              type:'grab', x:event.x, y:event.y\n          \n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #dragCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **drag** events passing through this component\n\n      dragCaptureListener: (event) ->\n\nProceed only for valid event\n\n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.dragEvent = event\n          localizeEventCoordinates event, @origin\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #grabCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **grab** events passing through this component.\n\n      grabCaptureListener: (event) ->\n\nProceed only for valid event\n        \n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.grabEvent = event\n          localizeEventCoordinates event, @origin\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n* Returns: [Component][Component]\n\nCapture **release** events passing through this component.\n\n      releaseCaptureListener: (event) ->\n\nProceed only for valid event\n        \n        if event\n\nSave the event and localize event coordinates.\n\n          @___runtime.releaseEvent = event\n          localizeEventCoordinates event, @origin\n          \n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n* Returns: [Component][Component]\n\n#### #dragListener(event)\n* Returns: [Component][Component]\n\n**drag** event receiver stub.\n\n      dragListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #grabListener(event)\n* Returns: [Component][Component]\n\n**grab** event receiver stub.\n\n      grabListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n### #releaseListener(event)\n* Returns: [Component][Component]\n\n**release** event receiver stub.\n\n      releaseListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n[Parent]: .\/index.litcoffee\n[Shape]: .\/shape.litcoffee\n[Component]: .\/component.litcoffee\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"954d4bbaf0686f7d65d26e0663a161e3f5e758e8","subject":"Remove `-thumb` image version","message":"Remove `-thumb` image version\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/upload.litcoffee","new_file":"src\/upload.litcoffee","new_contents":"    Upload = require 's3-uploader'\n\nConfigure [s3-uploader](https:\/\/github.com\/Turistforeningen\/node-s3-uploader) to\nstore the following versions:\n\n|\u00a0Suffix    | Max Height | Max Width\u00a0| Aspect Ratio |\n|-----------|------------|-----------|--------------|\n| `-full`   | `1200`     | `1200`    |              |\n| `-thumb`  | `250`      | `250`     | `1:1`        |\n| `-800`    | `800`      | `800`     | `3:2`        |\n| `-500`    | `500`      | `500`     | `3:2`        |\n| `-260`    | `260`      | `260`     | `3:2`        |\n| `-150`    | `150`      | `150`     | `3:2`        |\n\n    module.exports = new Upload process.env.AWS_BUCKET_NAME,\n      aws:\n        region: process.env.AWS_BUCKET_REGION\n        path: process.env.AWS_BUCKET_PATH\n        acl: 'public-read'\n        httpOptions: timeout: 60000\n\n      returnExif: true\n\n      cleanup:\n        original: true\n        versions: true\n\n      original:\n        awsImageAcl: 'private'\n\n      versions: [\n        suffix: '-full'\n        quality: 80\n        maxHeight: 1200\n        maxWidth: 1200\n      ,\n        suffix: '-800'\n        maxHeight: 800\n        maxWidth: 800\n        aspect: '3:2!h'\n      ,\n        suffix: '-500'\n        maxHeight: 500\n        maxWidth: 500\n        aspect: '3:2!h'\n      ,\n        suffix: '-260'\n        maxHeight: 260\n        maxWidth: 260\n        aspect: '3:2!h'\n      ,\n        suffix: '-150'\n        maxHeight: 150\n        maxWidth: 150\n        aspect: '3:2!h'\n      ]\n","old_contents":"    Upload = require 's3-uploader'\n\nConfigure [s3-uploader](https:\/\/github.com\/Turistforeningen\/node-s3-uploader) to\nstore the following versions:\n\n|\u00a0Suffix    | Max Height | Max Width\u00a0| Aspect Ratio |\n|-----------|------------|-----------|--------------|\n| `-full`   | `1200`     | `1200`    |              |\n| `-thumb`  | `250`      | `250`     | `1:1`        |\n| `-800`    | `800`      | `800`     | `3:2`        |\n| `-500`    | `500`      | `500`     | `3:2`        |\n| `-260`    | `260`      | `260`     | `3:2`        |\n| `-150`    | `150`      | `150`     | `3:2`        |\n\n    module.exports = new Upload process.env.AWS_BUCKET_NAME,\n      aws:\n        region: process.env.AWS_BUCKET_REGION\n        path: process.env.AWS_BUCKET_PATH\n        acl: 'public-read'\n        httpOptions: timeout: 60000\n\n      returnExif: true\n\n      cleanup:\n        original: true\n        versions: true\n\n      original:\n        awsImageAcl: 'private'\n\n      versions: [\n        suffix: '-full'\n        quality: 80\n        maxHeight: 1200\n        maxWidth: 1200\n      ,\n        suffix: '-thumb'\n        maxHeight: 250\n        maxWidth: 250\n        aspect: '1:1'\n      ,\n        suffix: '-800'\n        maxHeight: 800\n        maxWidth: 800\n        aspect: '3:2!h'\n      ,\n        suffix: '-500'\n        maxHeight: 500\n        maxWidth: 500\n        aspect: '3:2!h'\n      ,\n        suffix: '-260'\n        maxHeight: 260\n        maxWidth: 260\n        aspect: '3:2!h'\n      ,\n        suffix: '-150'\n        maxHeight: 150\n        maxWidth: 150\n        aspect: '3:2!h'\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"22edd799dedfd31be556cf0af95f0a3048a47dc1","subject":"Remove async dependency for system check","message":"Remove async dependency for system check\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/system.litcoffee","new_file":"coffee\/system.litcoffee","new_contents":"    redis = require '.\/db\/redis'\n    mongo = require '.\/db\/mongo'\n\n## check()\n\nThis is the system check. It retrives the current status from Redis and MongoDB\nand perfoms a simple error checking on the returned data before returning to the\nuser.\n\nSince this is publicly available endpoint, no data is returned, only a `System\nOK` message if everything is fine. Errors are logged.\n\n    exports.check = (req, res, next) ->\n      cnt = 0\n      ret = (err, info) ->\n        return if cnt > 2\n\n        if err\n          cnt = Math.Infinity\n          next err\n\n        else if ++cnt is 2\n          res.json 200, message: 'System OK'\n\n      mongo.db.command dbStats: true, ret\n      redis.info ret\n\n","old_contents":"    async = require 'async'\n\n    redis = require '.\/db\/redis'\n    mongo = require '.\/db\/mongo'\n\n## check()\n\nThis is the system check. It retrives the current status from Redis and MongoDB\nand perfoms a simple error checking on the returned data before returning to the\nuser.\n\nSince this is publicly available endpoint, no data is returned, only a `System\nOK` message if everything is fine. Errors are logged.\n\n    exports.check = (req, res, next) ->\n      async.parallel\n        Mongo: mongo.db.command.bind mongo.db, dbStats: true\n        Redis: redis.info.bind redis\n\n      , (err, result) ->\n        return next err if err\n        return res.json 200, message: 'System OK'\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7619e4a28c3a34cb74961b0d3e66bef40c8d4da6","subject":"useful debugging to console, to get deployed with next major change if ever","message":"useful debugging to console, to get deployed with next major change if ever\n","repos":"Custom-Elements\/glg-hummingbird","old_file":"src\/glg-hummingbird.litcoffee","new_file":"src\/glg-hummingbird.litcoffee","new_contents":"# glg-hummingbird\nPolymer element to maintain a hummingbird typeahead index that persists between browser restarts.\n\n    hummingbird = require 'hummingbird'\n    # shim for chrome file system access\n    window.requestFileSystem = window.requestFileSystem ? window.webkitRequestFileSystem\n\n    Polymer 'glg-hummingbird',\n\n## Events\n### HB_RESULTS\nThis event is emitted when there are new hummingbird results returned where the payload is the results array.\n\n### NO_HB_INDEX\nThis event is emitted when attempting to load a non-existent hummingbird index from persistence.\n\n### FS_ERROR\nThis event is emitted when there is an error interacting with the file system where the payload is the error object.\n\n## Methods\n### search\nMethod for retrieving results from a humminbird index\n* query (required) - a string to be tokenized and searched\n\n      search: (query) ->\n        hbOptions =\n          scoreThreshold: @scoreThreshold ? 0\n          secondarySortField: @secondarySortField\n          secondarySortOrder: @secondarySortOrder\n          howMany: @howMany ? 10\n          startPos: @startPos ? 0\n\n        #lookup by fuzzy name match\n        @idx.search query, (results) =>\n          @fire 'HB_RESULTS', results\n        , hbOptions\n\n### jump\nMethod for retrieving a single result from a hummingbird index by ID\n* id (required) - the ID of the document to be returned\n\n      jump: (id) ->\n        #lookup by ID\n        @idx.jump id, (results) =>\n          @fire 'HB_RESULTS', results\n\n### upsert\nMethod to insert new entries into the index or update existing entries\n\n      upsert: (doc) ->\n        unless doc?.name? and doc?.id?\n          console.error \"glg-hb: every hummingbird document must have a minimum of 'name' and 'id' properties\"\n        else\n          @idx.add doc\n\n### bulkLoad\nMethod to insert new entries into the index or update existing entries\n\n      bulkLoad: (docs) ->\n        (@upsert doc for doc in docs)\n\n### persist\nMethod to persist hummingbird index to localStorage\n\n      persist: () ->\n        window.requestFileSystem window.TEMPORARY, null\n        , (fs) =>\n          # success handler\n          fs.root.getFile @indexName, {create: true}, (fileEntry) =>\n            fileEntry.createWriter (fileWriter) =>\n              fileWriter.onerror = @__fileErrorHandler()\n              fileWriter.onwriteend = (evt) ->\n                # Do we care to share success?\n                return\n              try\n                fileWriter.write new Blob([JSON.stringify(@idx.toJSON())], {type: 'text\/plain'})\n              catch err\n                console.error \"glg-hb: unable to persist #{@indexName} index: #{JSON.stringify err}\"\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n\n### purge\nMethod to delete persisted file from disk\n\n      purge: () ->\n        window.requestFileSystem window.TEMPORARY, null, (fs) =>\n          fs.root.getFile @indexName, { create: false }, (fileEntry) =>\n            fileEntry.remove =>\n              console.log \"glg-hb: purged persisted #{@indexName} index.\"\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n### getCreateTime\nMethod that returns the timestamp for the index creation (not persist or load).\nIt has become the norm to incrementally add new documents to a hummingbird index, but not remove 'deleted' or obsolete documents.\nGiven that convention, this method enables the consuming application to determine whether the persisted index is 'old' and\nshould be purged from local storage and fully rebuilt from scratch to take into account documents that should no longer be in the index.\n\n      getCreateTime: () ->\n        @idx.createTime\n\n### getLastUpdateTime\nMethod that returns the timestamp for the last time the index was updated (including create, add, or remove, but not persist or load)\n\n      getLastUpdateTime: () ->\n        @idx.lastUpdate\n\n### __fileErrorHandler\nInternal method to handle various filesystem errors\n\n      __fileErrorHandler: () ->\n        #closure to maintain reference to Polymer object in scope\n        (err) =>\n          switch err.code\n            when FileError.QUOTA_EXCEEDED_ERR\n              console.error 'glg-hb: QUOTA_EXCEEDED_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.NOT_FOUND_ERR\n              console.debug \"glg-hb: no persisted index: #{JSON.stringify err}\"\n              @fire 'NO_HB_INDEX'\n            when FileError.SECURITY_ERR\n              console.error 'glg-hb: SECURITY_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.INVALID_MODIFICATION_ERR\n              console.error 'glg-hb: INVALID_MODIFICATION_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.INVALID_STATE_ERR\n              console.error 'glg-hb: INVALID_STATE_ERR'\n              @fire 'FS_ERROR', err\n            else\n              console.error 'glg-hb: unknown file system error'\n              @fire 'FS_ERROR', err\n\n## Polymer Lifecycle\nOn element creation, load the named index if it exists and make it immediately available for use.\n\n      created: ->\n        # create an empty index\n        @idx = new hummingbird()\n        window.requestFileSystem window.TEMPORARY, null\n        , (fs) =>\n          # success handler\n          fs.root.getFile @indexName, {}, (fileEntry) =>\n            fileEntry.file (file) =>\n              reader = new FileReader()\n              reader.onerror = @__fileErrorHandler()\n              reader.onloadend = (evt) ->\n                # @result is the text of the file read\n                if @result? and @result isnt ''\n                  try\n                    # if we found a persisted index, replace our empty index with it\n                    console.log \"glg-hb: loading index #{_this.indexName} from localStorage\"\n                    _this.idx = hummingbird.Index.load JSON.parse(@result)\n                  catch err\n                    console.error \"glg-hb: unable to load persisted #{_this.indexName} index: #{JSON.stringify err}\"\n                else\n                  console.warn \"glg-hb: found an empty file when trying to load persisted #{_this.indexName} index.\"\n                  _this.__fileErrorHandler() {code:FileError.NOT_FOUND_ERR}\n              reader.readAsText file\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n      ready: ->\n\n      attached: ->\n\n      domReady: ->\n\n      detached: ->\n","old_contents":"# glg-hummingbird\nPolymer element to maintain a hummingbird typeahead index that persists between browser restarts.\n\n    hummingbird = require 'hummingbird'\n    # shim for chrome file system access\n    window.requestFileSystem = window.requestFileSystem ? window.webkitRequestFileSystem\n\n    Polymer 'glg-hummingbird',\n\n## Events\n### HB_RESULTS\nThis event is emitted when there are new hummingbird results returned where the payload is the results array.\n\n### NO_HB_INDEX\nThis event is emitted when attempting to load a non-existent hummingbird index from persistence.\n\n### FS_ERROR\nThis event is emitted when there is an error interacting with the file system where the payload is the error object.\n\n## Methods\n### search\nMethod for retrieving results from a humminbird index\n* query (required) - a string to be tokenized and searched\n\n      search: (query) ->\n        hbOptions =\n          scoreThreshold: @scoreThreshold ? 0\n          secondarySortField: @secondarySortField\n          secondarySortOrder: @secondarySortOrder\n          howMany: @howMany ? 10\n          startPos: @startPos ? 0\n\n        #lookup by fuzzy name match\n        @idx.search query, (results) =>\n          @fire 'HB_RESULTS', results\n        , hbOptions\n\n### jump\nMethod for retrieving a single result from a hummingbird index by ID\n* id (required) - the ID of the document to be returned\n\n      jump: (id) ->\n        #lookup by ID\n        @idx.jump id, (results) =>\n          @fire 'HB_RESULTS', results\n\n### upsert\nMethod to insert new entries into the index or update existing entries\n\n      upsert: (doc) ->\n        unless doc?.name? and doc?.id?\n          console.error \"glg-hb: every hummingbird document must have a minimum of 'name' and 'id' properties\"\n        else\n          @idx.add doc\n\n### bulkLoad\nMethod to insert new entries into the index or update existing entries\n\n      bulkLoad: (docs) ->\n        (@upsert doc for doc in docs)\n\n### persist\nMethod to persist hummingbird index to localStorage\n\n      persist: () ->\n        window.requestFileSystem window.TEMPORARY, null\n        , (fs) =>\n          # success handler\n          fs.root.getFile @indexName, {create: true}, (fileEntry) =>\n            fileEntry.createWriter (fileWriter) =>\n              fileWriter.onerror = @__fileErrorHandler()\n              fileWriter.onwriteend = (evt) ->\n                # Do we care to share success?\n                return\n              try\n                fileWriter.write new Blob([JSON.stringify(@idx.toJSON())], {type: 'text\/plain'})\n              catch err\n                console.error \"glg-hb: unable to persist #{@indexName} index: #{JSON.stringify err}\"\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n\n### purge\nMethod to delete persisted file from disk\n\n      purge: () ->\n        window.requestFileSystem window.TEMPORARY, null, (fs) =>\n          fs.root.getFile @indexName, { create: false }, (fileEntry) =>\n            fileEntry.remove =>\n              console.log \"glg-hb: purged persisted #{@indexName} index.\"\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n### getCreateTime\nMethod that returns the timestamp for the index creation (not persist or load).\nIt has become the norm to incrementally add new documents to a hummingbird index, but not remove 'deleted' or obsolete documents.\nGiven that convention, this method enables the consuming application to determine whether the persisted index is 'old' and\nshould be purged from local storage and fully rebuilt from scratch to take into account documents that should no longer be in the index.\n\n      getCreateTime: () ->\n        @idx.createTime\n\n### getLastUpdateTime\nMethod that returns the timestamp for the last time the index was updated (including create, add, or remove, but not persist or load)\n\n      getLastUpdateTime: () ->\n        @idx.lastUpdate\n\n### __fileErrorHandler\nInternal method to handle various filesystem errors\n\n      __fileErrorHandler: () ->\n        #closure to maintain reference to Polymer object in scope\n        (err) =>\n          switch err.code\n            when FileError.QUOTA_EXCEEDED_ERR\n              console.error 'glg-hb: QUOTA_EXCEEDED_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.NOT_FOUND_ERR\n              console.debug \"glg-hb: no persisted index: #{JSON.stringify err}\"\n              @fire 'NO_HB_INDEX'\n            when FileError.SECURITY_ERR\n              console.error 'glg-hb: SECURITY_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.INVALID_MODIFICATION_ERR\n              console.error 'glg-hb: INVALID_MODIFICATION_ERR'\n              @fire 'FS_ERROR', err\n            when FileError.INVALID_STATE_ERR\n              console.error 'glg-hb: INVALID_STATE_ERR'\n              @fire 'FS_ERROR', err\n            else\n              console.error 'glg-hb: unknown file system error'\n              @fire 'FS_ERROR', err\n\n## Polymer Lifecycle\nOn element creation, load the named index if it exists and make it immediately available for use.\n\n      created: ->\n        # create an empty index\n        @idx = new hummingbird()\n        window.requestFileSystem window.TEMPORARY, null\n        , (fs) =>\n          # success handler\n          fs.root.getFile @indexName, {}, (fileEntry) =>\n            fileEntry.file (file) =>\n              reader = new FileReader()\n              reader.onerror = @__fileErrorHandler()\n              reader.onloadend = (evt) ->\n                # @result is the text of the file read\n                if @result? and @result isnt ''\n                  try\n                    # if we found a persisted index, replace our empty index with it\n                    _this.idx = hummingbird.Index.load JSON.parse(@result)\n                  catch err\n                    console.error \"glg-hb: unable to load persisted #{_this.indexName} index: #{JSON.stringify err}\"\n                else\n                  console.warn \"glg-hb: found an empty file when trying to load persisted #{_this.indexName} index.\"\n                  _this.__fileErrorHandler() {code:FileError.NOT_FOUND_ERR}\n              reader.readAsText file\n            , @__fileErrorHandler()\n          , @__fileErrorHandler()\n        , @__fileErrorHandler()\n\n      ready: ->\n\n      attached: ->\n\n      domReady: ->\n\n      detached: ->\n","returncode":0,"stderr":"","license":"isc","lang":"Literate CoffeeScript"}
{"commit":"27f98dbb2f62bc2c75768b4bb87479aff2362287","subject":"Fix undefined tilbyder query","message":"Fix undefined tilbyder query\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.usr if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.usr\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.usr\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.usr}]\n\n### Fields\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        fields = {}\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\n      else\n        fields =\n          tilbyder: true\n          endret: true\n          status: true\n          lisens: true\n          navn: true\n          tags: true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower.\n\n      if typeof req.query.sort is 'string' and req.query.sort\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\nOnly apply default sort if there are no geospatial queries.\n\n      else\n        sort = 'endret' if not req.db.query.geojson\n\n### Execute\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(req.db.query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.usr}]\n\n### Fields\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        fields = {}\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\n      else\n        fields =\n          tilbyder: true\n          endret: true\n          status: true\n          lisens: true\n          navn: true\n          tags: true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower.\n\n      if typeof req.query.sort is 'string' and req.query.sort\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\nOnly apply default sort if there are no geospatial queries.\n\n      else\n        sort = 'endret' if not req.db.query.geojson\n\n### Execute\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(req.db.query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"394476d895d7367464bb2364274da809c3909d28","subject":"Fix origin for originless URLs","message":"Fix origin for originless URLs\n","repos":"hzdg\/urllite.js","old_file":"src\/core.litcoffee","new_file":"src\/core.litcoffee","new_contents":"\n    URL_PATTERN = \/\/\/\n      ^\n      (?:\n        (?:\n          (                                       # protocol* (\"http:\")\n             [^:\/?\\#]+                            # scheme (\"http\")\n             :\n          )\/+\n          |\n          (\/\/)                                    # [Scheme-relative]\n        )\n        # (                                       # authority\n          (?:\n            # (                                   # userinfo\n              ([a-z0-9-\\._~%]+)                   # username*\n              (?:\n                :\n                ([a-z0-9-\\._~%]+)                 # password*\n              )?\n            # )\n            @\n          )?\n          (                                       # host*\n            ([a-z0-9-\\._~%!$&'()*+,;=]+)          # hostname*\n            (?:\n              :\n              ([0-9]+)                            # port*\n            )?\n          )?\n        # )\n      )?\n      ([^?\\#]*?)                                  # pathname*\n      (\\?                                         # search*\n        [^\\#]*                                    # query\n      )?\n      (\\#                                         # hash*\n        .*                                        # fragment\n      )?\n      $\n    \/\/\/\n\n    urllite = (raw) -> new urllite.URL raw\n\n    urllite.URL =\n      class URL\n        constructor: (raw) ->\n          m = raw.toString().match URL_PATTERN\n          @protocol = m[1] or ''\n          @isSchemeRelative = m[2]?\n          @username = m[3] or ''\n          @password = m[4] or ''\n          @host = m[5] or ''\n          @hostname = m[6] or ''\n          @port = m[7] or ''\n          pathname = m[8] or ''\n          @pathname = if @protocol and pathname.charAt(0) isnt '\/' then \"\/#{ pathname }\" else pathname\n          @search = m[9] or ''\n          @hash = m[10] or ''\n          @origin = if @protocol then \"#{ @protocol }\/\/#{ @host }\" else ''\n\n        toString: ->\n          prefix =\n            if @isSchemeRelative then '\/\/'\n            else if @protocol is 'file:' then \"#{ @protocol }\/\/\/\"\n            else if @protocol then \"#{ @protocol }\/\/\"\n            else ''\n          userinfo =\n            if @password then \"#{ @username }:#{ @password }\"\n            else if @username then \"#{ @username }\"\n            else ''\n          authority =\n            if userinfo then \"#{ userinfo }@#{ @host }\"\n            else if @host then \"#{ @host }\"\n            else ''\n          \"#{ prefix }#{ authority }#{ @pathname }#{ @search }#{ @hash }\"\n\n    module.exports = urllite\n","old_contents":"\n    URL_PATTERN = \/\/\/\n      ^\n      (?:\n        (?:\n          (                                       # protocol* (\"http:\")\n             [^:\/?\\#]+                            # scheme (\"http\")\n             :\n          )\/+\n          |\n          (\/\/)                                    # [Scheme-relative]\n        )\n        # (                                       # authority\n          (?:\n            # (                                   # userinfo\n              ([a-z0-9-\\._~%]+)                   # username*\n              (?:\n                :\n                ([a-z0-9-\\._~%]+)                 # password*\n              )?\n            # )\n            @\n          )?\n          (                                       # host*\n            ([a-z0-9-\\._~%!$&'()*+,;=]+)          # hostname*\n            (?:\n              :\n              ([0-9]+)                            # port*\n            )?\n          )?\n        # )\n      )?\n      ([^?\\#]*?)                                  # pathname*\n      (\\?                                         # search*\n        [^\\#]*                                    # query\n      )?\n      (\\#                                         # hash*\n        .*                                        # fragment\n      )?\n      $\n    \/\/\/\n\n    urllite = (raw) -> new urllite.URL raw\n\n    urllite.URL =\n      class URL\n        constructor: (raw) ->\n          m = raw.toString().match URL_PATTERN\n          @protocol = m[1] or ''\n          @isSchemeRelative = m[2]?\n          @username = m[3] or ''\n          @password = m[4] or ''\n          @host = m[5] or ''\n          @hostname = m[6] or ''\n          @port = m[7] or ''\n          pathname = m[8] or ''\n          @pathname = if @protocol and pathname.charAt(0) isnt '\/' then \"\/#{ pathname }\" else pathname\n          @search = m[9] or ''\n          @hash = m[10] or ''\n          @origin = \"#{ @protocol }\/\/#{ @host }\"\n\n        toString: ->\n          prefix =\n            if @isSchemeRelative then '\/\/'\n            else if @protocol is 'file:' then \"#{ @protocol }\/\/\/\"\n            else if @protocol then \"#{ @protocol }\/\/\"\n            else ''\n          userinfo =\n            if @password then \"#{ @username }:#{ @password }\"\n            else if @username then \"#{ @username }\"\n            else ''\n          authority =\n            if userinfo then \"#{ userinfo }@#{ @host }\"\n            else if @host then \"#{ @host }\"\n            else ''\n          \"#{ prefix }#{ authority }#{ @pathname }#{ @search }#{ @hash }\"\n\n    module.exports = urllite\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"26cfef36a4857cbdb4bbc17b7a7d53a8c8634450","subject":"Fire error event on rejected promise","message":"Fire error event on rejected promise\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ff8fe15a23144d08835c0cc20d395ea697c81a24","subject":"Make the API doc headings consistent","message":"Make the API doc headings consistent\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n## data-yield\n\n## data-contentfor\n\n## data-replace\n\n# Batman.View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","old_contents":"# Batman View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n## data-yield\n\n## data-contentfor\n\n## data-replace\n\n# Batman View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6ba5ca5bc22193caf6ad35d652ab7ed7529f2102","subject":"model values getter","message":"model values getter\n","repos":"vpj\/models","old_file":"js\/models\/base.litcoffee","new_file":"js\/models\/base.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#Model Base\n\n    Mod.require 'Weya',\n     'Models.Properties'\n     'Models.Util'\n     (Weya, PROPERTIES, UTIL) ->\n\n\nClass\n\n      class Model\n       _initialize: []\n       _properties: {}\n       _requiredFunctions: {}\n       on: {}\n\n       @extend: ->\n        @::_initialize = @::_initialize.slice()\n        @::_properties = UTIL.extend {}, @::_properties\n        @::_requiredFunctions = UTIL.extend {}, @::_requiredFunctions\n        @::on = UTIL.extend {}, @::on\n\n       @include: (obj) ->\n        if not obj?\n         throw new Error 'Cannot include a null object'\n        for k, v of obj\n         switch k\n          when 'initialize'\n           @::_initialize.push v\n          when 'property'\n           for name, obj of v\n            @_addProperty name, obj\n          when 'requireFunction'\n           for name, desc of v\n            @::_requiredFunctions[name] = desc\n          when 'on'\n           for event, listener of v\n            if not @::on[event]?\n             @::on[event] = listener\n          else\n           @prototype[k] = v\n\n        return null\n\n Initialize variables.\n\n       @initialize: (func) ->\n        @::_initialize.push func\n\nAdd listener\n\n       @listen: (name, func) ->\n        @::on[name] = func\n\nRegister a property\n\n       @property: (name, obj) ->\n        if (typeof name) is 'string'\n         @_addProperty name, obj\n        else\n         objs = name\n         for name, obj of objs\n          @_addProperty name, obj\n\n       @_addProperty: (name, obj) ->\n        if (typeof name) isnt 'string'\n         throw new Error \"Property name not a string: #{name}\"\n        if (typeof obj) isnt 'object'\n         throw new Error \"Property not an object: #{name}\"\n\n        @::_properties[name] = PROPERTIES.create obj, name\n\n       @requireFunction: (name, desc) ->\n        if (typeof name) is 'string'\n         @::_requiredFunctions[name] = desc\n        else\n         obj = name\n         for name, desc of obj\n          @::_requiredFunctions[name] = desc\n\n\nCheck properties\n\n       @check: ->\n        if not @::type?\n         throw new Error \"Object type not defined\"\n        type = @::type\n\n        mentioned =\n         type: true\n        for func, desc of @::_requiredFunctions\n         mentioned[func] = true\n         if not @::[func]?\n          throw new Error \"#{type}: Function not defined: #{func} - #{desc}\"\n         if (typeof @::[func]) isnt 'function'\n          throw new Error \"#{type}: Not a function: #{func} - #{desc}\"\n\n        extra = []\n        for k of this.prototype\n         continue if k in ['on', 'values']\n         if not mentioned[k]?\n          if k[0] isnt '_'\n           extra.push k\n\n        if extra.length > 0\n         console.error type, extra\n\n        @::_checked = true\n\nGet values\n\n       @::__defineGetter__ 'values', -> @_values\n\n\n       constructor: ->\n        @initialize.apply this, arguments\n\n##Override\n\n##Initialize\n\n       initialize: (options) ->\n        if @_checked isnt on\n         throw new Error \"Object #{@type} wasnt checked\"\n\n        @_bindEvents()\n\n        for init in @_initialize\n         init.call this\n\n\n       @requireFunction\n        'initialize': 'Initialize'\n        'parse': 'Parse'\n        'render': 'Render element'\n        'weya': 'Render weya template'\n        'html': 'Render html'\n        'template': 'Render template'\n        'toJSON': 'To JSON'\n        'toJSONFull': 'To JSON Full'\n        'isDefault': 'Is default value'\n        'edit': 'Render editor'\n        'valueChanged': 'A property value change event'\n\n##Public functions\n\n       parse: (data, stack = []) ->\n        stack = stack.slice 0\n        stack.push this\n        excess = 0\n        @_errors = []\n        fields = 0\n        @_score = 0\n        @_values = {}\n\n        for name of data when not @_properties[name]?\n         @_errors.push \": #{name} excess\"\n         excess++\n\n\n        for name, prop of @_properties\n         fields++\n         r = prop.parse data[name], stack\n         @_values[name] = r.value\n         if not prop.isDefault r.value, stack\n          @_score += r.score\n         for e in r.errors\n          @_errors.push \"#{name}(#{@type})\/#{e}\"\n\n        if fields is 0\n         @_score = (if excess > 0 then 0 else 1)\n        else\n         @_score = (@_score - excess) \/ fields\n        @_score = 0 if @_score < 0\n        if @_score > 1\n         throw new Error \"Score greater than 1: #{score}\"\n\n        return {\n         score: @_score,\n         value: this\n         errors: @_errors\n        }\n\n       weya: (weya, stack = []) ->\n        @template.call weya, this, stack\n\n       render: (elem, stack = []) ->\n        self = this\n        Weya elem: elem, ->\n         self.weya this, stack\n\n       html: (stack = []) ->\n        self = this\n        Weya.markup {}, ->\n         self.weya this, stack\n\n       toJSON: (stack = [])->\n        stack = stack.slice 0\n        stack.push this\n        data = {}\n        for name, prop of @_properties\n         v = prop.toJSON @_values[name], stack\n         if not prop.isDefault v, stack\n          data[name] = v\n\n\n        return data\n\n       toJSONFull: (stack = []) ->\n        stack = stack.slice 0\n        stack.push this\n        data = {}\n        for name, prop of @_properties\n         data[name] = prop.toJSONFull @_values[name], stack\n\n        return data\n\n\n       isDefault: (stack = []) ->\n        stack = stack.slice 0\n        stack.push this\n        for name, prop of @_properties\n         v = prop.toJSON @_values[name]\n         if not prop.isDefault v, stack\n          return false\n\n        return true\n\n       edit: (elem, changed, stack = []) ->\n        stack = stack.slice 0\n        stack.push this\n        @onChanged = changed\n        @_editElems = {}\n        Weya elem: elem, context: this, ->\n         for name, prop of @$._properties\n          @div \".property.property-type-#{prop.propertyType}\", ->\n           @span \".property-name\", name\n           @$._editElems[name] = @div \".property-value\", \"\"\n\n        for name, prop of @_properties\n         prop.edit @_editElems[name], @_values[name],\n          @valueChanged.bind self: this, name: name\n          stack\n\n       valueChanged: (value, changed) ->\n        @self._values[@name] = value\n        @self.onChanged @self, false\n\n\n##Private functions\n\nBind\n\n       _bindEvents: ->\n        events = @on\n        @on = {}\n        for k, v of events\n         @on[k] = v.bind this\n\n\n\n\n      Mod.set 'Models.Model.Base', Model\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#Model Base\n\n    Mod.require 'Weya',\n     'Models.Properties'\n     'Models.Util'\n     (Weya, PROPERTIES, UTIL) ->\n\n\nClass\n\n      class Model\n       _initialize: []\n       _properties: {}\n       _requiredFunctions: {}\n       on: {}\n\n       @extend: ->\n        @::_initialize = @::_initialize.slice()\n        @::_properties = UTIL.extend {}, @::_properties\n        @::_requiredFunctions = UTIL.extend {}, @::_requiredFunctions\n        @::on = UTIL.extend {}, @::on\n\n       @include: (obj) ->\n        if not obj?\n         throw new Error 'Cannot include a null object'\n        for k, v of obj\n         switch k\n          when 'initialize'\n           @::_initialize.push v\n          when 'property'\n           for name, obj of v\n            @_addProperty name, obj\n          when 'requireFunction'\n           for name, desc of v\n            @::_requiredFunctions[name] = desc\n          when 'on'\n           for event, listener of v\n            if not @::on[event]?\n             @::on[event] = listener\n          else\n           @prototype[k] = v\n\n        return null\n\n Initialize variables.\n\n       @initialize: (func) ->\n        @::_initialize.push func\n\nAdd listener\n\n       @listen: (name, func) ->\n        @::on[name] = func\n\nRegister a property\n\n       @property: (name, obj) ->\n        if (typeof name) is 'string'\n         @_addProperty name, obj\n        else\n         objs = name\n         for name, obj of objs\n          @_addProperty name, obj\n\n       @_addProperty: (name, obj) ->\n        if (typeof name) isnt 'string'\n         throw new Error \"Property name not a string: #{name}\"\n        if (typeof obj) isnt 'object'\n         throw new Error \"Property not an object: #{name}\"\n\n        @::_properties[name] = PROPERTIES.create obj, name\n\n       @requireFunction: (name, desc) ->\n        if (typeof name) is 'string'\n         @::_requiredFunctions[name] = desc\n        else\n         obj = name\n         for name, desc of obj\n          @::_requiredFunctions[name] = desc\n\n\nCheck properties\n\n       @check: ->\n        if not @::type?\n         throw new Error \"Object type not defined\"\n        type = @::type\n\n        mentioned =\n         type: true\n        for func, desc of @::_requiredFunctions\n         mentioned[func] = true\n         if not @::[func]?\n          throw new Error \"#{type}: Function not defined: #{func} - #{desc}\"\n         if (typeof @::[func]) isnt 'function'\n          throw new Error \"#{type}: Not a function: #{func} - #{desc}\"\n\n        extra = []\n        for k of this.prototype\n         continue if k is 'on'\n         if not mentioned[k]?\n          if k[0] isnt '_'\n           extra.push k\n\n        if extra.length > 0\n         console.error type, extra\n\n        @::_checked = true\n\n\n       constructor: ->\n        @initialize.apply this, arguments\n\n##Override\n\n##Initialize\n\n       initialize: (options) ->\n        if @_checked isnt on\n         throw new Error \"Object #{@type} wasnt checked\"\n\n        @_bindEvents()\n\n        for init in @_initialize\n         init.call this\n\n\n       @requireFunction\n        'initialize': 'Initialize'\n        'parse': 'Parse'\n        'render': 'Render element'\n        'weya': 'Render weya template'\n        'html': 'Render html'\n        'template': 'Render template'\n        'toJSON': 'To JSON'\n        'toJSONFull': 'To JSON Full'\n        'isDefault': 'Is default value'\n        'edit': 'Render editor'\n        'valueChanged': 'A property value change event'\n\n##Public functions\n\n       parse: (data, stack = []) ->\n        stack = stack.slice 0\n        stack.push this\n        excess = 0\n        @_errors = []\n        fields = 0\n        @_score = 0\n        @_values = {}\n\n        for name of data when not @_properties[name]?\n         @_errors.push \": #{name} excess\"\n         excess++\n\n\n        for name, prop of @_properties\n         fields++\n         r = prop.parse data[name], stack\n         @_values[name] = r.value\n         if not prop.isDefault r.value, stack\n          @_score += r.score\n         for e in r.errors\n          @_errors.push \"#{name}(#{@type})\/#{e}\"\n\n        if fields is 0\n         @_score = (if excess > 0 then 0 else 1)\n        else\n         @_score = (@_score - excess) \/ fields\n        @_score = 0 if @_score < 0\n        if @_score > 1\n         throw new Error \"Score greater than 1: #{score}\"\n\n        return {\n         score: @_score,\n         value: this\n         errors: @_errors\n        }\n\n       weya: (weya, stack = []) ->\n        @template.call weya, this, stack\n\n       render: (elem, stack = []) ->\n        self = this\n        Weya elem: elem, ->\n         self.weya this, stack\n\n       html: (stack = []) ->\n        self = this\n        Weya.markup {}, ->\n         self.weya this, stack\n\n       toJSON: (stack = [])->\n        stack = stack.slice 0\n        stack.push this\n        data = {}\n        for name, prop of @_properties\n         v = prop.toJSON @_values[name], stack\n         if not prop.isDefault v, stack\n          data[name] = v\n\n\n        return data\n\n       toJSONFull: (stack = []) ->\n        stack = stack.slice 0\n        stack.push this\n        data = {}\n        for name, prop of @_properties\n         data[name] = prop.toJSONFull @_values[name], stack\n\n        return data\n\n\n       isDefault: (stack = []) ->\n        stack = stack.slice 0\n        stack.push this\n        for name, prop of @_properties\n         v = prop.toJSON @_values[name]\n         if not prop.isDefault v, stack\n          return false\n\n        return true\n\n       edit: (elem, changed, stack = []) ->\n        stack = stack.slice 0\n        stack.push this\n        @onChanged = changed\n        @_editElems = {}\n        Weya elem: elem, context: this, ->\n         for name, prop of @$._properties\n          @div \".property.property-type-#{prop.propertyType}\", ->\n           @span \".property-name\", name\n           @$._editElems[name] = @div \".property-value\", \"\"\n\n        for name, prop of @_properties\n         prop.edit @_editElems[name], @_values[name],\n          @valueChanged.bind self: this, name: name\n          stack\n\n       valueChanged: (value, changed) ->\n        @self._values[@name] = value\n        @self.onChanged @self, false\n\n\n##Private functions\n\nBind\n\n       _bindEvents: ->\n        events = @on\n        @on = {}\n        for k, v of events\n         @on[k] = v.bind this\n\n\n\n\n      Mod.set 'Models.Model.Base', Model\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a1c77cf65a0d75ff32619a70f08ee38dbc5dfab2","subject":"Fix doc formating","message":"Fix doc formating\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/cache.litcoffee","new_file":"coffee\/cache.litcoffee","new_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### ToDo\n\n* Handle undefined values.\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      set       : set\n      get       : get\n      getDoc    : getDoc\n      setForType: setForType\n      getFilter : getFilter\n      filterData: filterData\n      getForType: getForType\n\n","old_contents":"    \"use strict\"\n\n    redis    = require '.\/db\/redis'\n    mongo    = require '.\/db\/mongo'\n    ObjectID = require('mongodb').ObjectID\n\n\n## getFilter()\n\nGet data filter for object type.\n\n### Params\n\n* `String` type - object type to get filter for.\n* `boolean` preventDefault - prevent default filter switch.\n\n### Return\n\nReturns a `String` key - `boolean` value `Object` where each key represent a\ndocument field. The value determines if they field should be included or not.\n\nReturns an empty `Object` if the `preventDefault` parameter is set to `true` and\nno filter was found for the given `type`.\n\n\n    getFilter = (type, preventDefault) ->\n\n      dataFields =\n        default:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n          bilder    : true\n          grupper   : true\n\n        bilder:\n          _id       : false\n          tilbyder  : true\n          endret    : true\n          checksum  : true\n          status    : true\n          navn      : true\n\n      return dataFields[type] if dataFields[type]\n      return {} if preventDefault\n      return dataFields.default\n\n\n## filterData()\n\nFilter data for given type.\n\n### Todo\n\n* Handle undefined values.\n\n\n### Params\n\n* `String` type - object type to filter data for.\n* `Object` data - data to filter on.\n\n### Return\n\nReturns an `Object` with a subset of the original object containing only the\naccepted object properties for the given object type.\n\n    filterData = (type, data) ->\n      res = {}\n      res[key] = data[key] for key,val of getFilter(type) when val is true and data[key]\n      return res\n\n\n## getDoc()\n\nGet a document from MongoDB for given object type and object id.\n\nThis function will automaticly filter object keys according to type in order to\nprevent fetching of uncesserary data.\n\n### Params\n\n* `String` type - object type to get document for.\n* `String` id - object id for document.\n* `function` cb - callback function (`Error` err, `Object` doc).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getDoc = (type, id, cb) ->\n      mongo[type].findOne {_id: new ObjectID(id)}, getFilter(type), cb\n\n\n## set()\n\nStore data object in Redis for a given cache key.\n\n### Params\n\n* `String` key - cache key to store data for.\n* `Object` data - data to store for cache key.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    set = (key, data, cb) ->\n      redis.hmset key, data, (err) -> cb(err, data)\n\n\n## get()\n\nRetrive data from cache for given a cache key.\n\n### Params\n\n* `String` key - cache key to get data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    get = (key, cb) ->\n      redis.hgetall key, cb\n\n\n## setForType()\n\nStore data in Redis for given object type and object id.\n\nThis function will automaticly remove object properties from input data in order\nto match the object type cache preferences as defined in [#getFilter()](#getFilter).\n\n### Params\n\n* `String` type - object type to set cache data for.\n* `String` id - object id to set cache data for.\n* `Object` data - data store in cache for type and id.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    setForType = (type, id, data, cb) ->\n      set \"#{type}:#{id}\", filterData(type, data), cb\n\n\n## getForType()\n\nGet data from Redis for object type and object id.\n\n`NB` This function will return `Arrays` if the document is retrived directly\nfrom MongoDB. `Arrays` stored in Redis will be returned as comma seperated\nstrings.\n\n### Params\n\n* `String` type - object type to get cache data for.\n* `String` id - object id to get cache data for.\n* `function` cb - callback function (`Error` err, `Object` data).\n\n### Return\n\nNo return value or `undefined`.\n\n\n    getForType = (type, id, cb) ->\n      get \"#{type}:#{id}\", (err, data) ->\n        return cb null, data, true if data\n\n        getDoc type, id, (err, data) ->\n          return cb err, null, false if err\n\n          data = status: 'Slettet' if not data\n\n          # We don't need to use setForType() here since data is already formated\n          # when using getDoc()\n\n          set \"#{type}:#{id}\", data, (err, data) ->\n            cb err, data, false\n\n\n## Export\n\nExpose the functions we want to be public by exporting them.\n\n\n    module.exports =\n      set       : set\n      get       : get\n      getDoc    : getDoc\n      setForType: setForType\n      getFilter : getFilter\n      filterData: filterData\n      getForType: getForType\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"572ad6cb503d58554ce1584a757020d64e118043","subject":"error handling","message":"error handling\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onerror: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        console.error 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n     errorCallback: (msg, options) ->\n      console.error msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       throw new Error \"Unknown method: #{data.method}\"\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      if @callsCache[data.id].handle data.data, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      throw new Error \"Poll not implemented\"\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @onerror.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onerror 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onerror 'Cannot connect to server'\n\n     _respond: (data, options) ->\n      throw new Error 'AJAX cannot respond'\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onerror 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e, data\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       throw new Error \"Poll without response: #{data.id}\"\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onerror: (msg, options) ->\n      console.log msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       throw new Error \"Unknown method: #{data.method}\"\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      @callsCache[data.id].handle data.data, data\n\n     _handlePoll: (data, options) ->\n      throw new Error \"Poll not implemented\"\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n     _onError: (e) -> console.log e\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText?) or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onerror 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onerror 'xhr error'\n\n     _respond: (data, options) ->\n      throw new Error 'AJAX cannot respond'\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e, data\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       throw new Error \"Poll without response: #{data.id}\"\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7b2aa5c706d555b457fbc06a8ecfcee3409dd081","subject":"weya markup class list fix","message":"weya markup class list fix\n","repos":"vpj\/weya,vpj\/weya","old_file":"weya.litcoffee","new_file":"weya.litcoffee","new_contents":"Gist of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setData = (elem, data) ->\n      for k, v of data\n       elem[k] = v\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        when 'data' then setData elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       if elem.classList?\n        for c in idClass.class\n         elem.classList.add c\n       else #For older browsers; does not work with svgs\n        className = ''\n        for c in idClass.class\n         className += ' ' if className isnt ''\n         className += \"#{c}\"\n        elem.className = className\n\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setData = (buf, data) ->\n      for k, v of data\n       buf.push \" data-#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        when 'data' then setData buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        cssClass = ''\n        cssClass += \"#{c} \" for c in params.idClass.class\n        buf.push \" class=\\\"#{cssClass}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       setIndent buf, @_indent\n       buf.push params.text\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","old_contents":"Gist of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setData = (elem, data) ->\n      for k, v of data\n       elem[k] = v\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        when 'data' then setData elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       if elem.classList?\n        for c in idClass.class\n         elem.classList.add c\n       else #For older browsers; does not work with svgs\n        className = ''\n        for c in idClass.class\n         className += ' ' if className isnt ''\n         className += \"#{c}\"\n        elem.className = className\n\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setData = (buf, data) ->\n      for k, v of data\n       buf.push \" data-#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        when 'data' then setData buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        buf.push \" class=\\\"#{params.idClass.class}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       setIndent buf, @_indent\n       buf.push params.text\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     helpersAdded = []\n\n     if options.helpers?\n      for name, helper of options.helpers\n       if not weya[name]?\n        helpersAdded.push name\n        weya[name] = helper.bind weya\n\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n\n     for name in helpersAdded\n      delete weya[name]\n\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c6caf8c0b9827feef6ed64d93805011d5afa06d8","subject":"Document Batman.Hash","message":"Document Batman.Hash\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/06_hash.litcoffee","new_file":"docs\/06_hash.litcoffee","new_contents":"# Batman.Hash\n\n`Batman.Hash` is an observable [`Batman.Object`](\/docs\/api\/batman.object.html) wrapper around `Batman.SimpleHash`. `Hash` also extends [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html), which provides [many useful methods](\/docs\/api\/batman.enumerable.html).\n\n`Batman.Hash` is a great choice when you need an iterable, observable key-value store.\n\n### Hash, SimpleHash, and Object\n\n`Hash` brings in methods from [`Batman.Object`](\/docs\/api\/batman.object.html) and `Batman.SimpleHash` and provides some new methods of its own.\nFrom `Object`, `Hash` gains:\n\n- observable properties and accessors (eg, [`::observe`](docs\/api\/batman.object.html#prototype_function_observe) and [`@accessor`](\/docs\/api\/batman.object.html#class_function_accessor))\n- observable mutation events (`itemsWereAdded`, `itemsWereChanged`, `itemsWereRemoved`)\n\nFrom `SimpleHash`, `Hash` gains:\n\n- all methods on [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html)\n- basic key-value storage, as described below\n- serialization via [`toObject`](\/docs\/api\/batman.hash.html#prototype_function_toobject) and [`toJSON`](\/docs\/api\/batman.hash.html#prototype_function_tojson) as described below\n\n`SimpleHash` methods take precedence over `Object` methods inside `Hash`. For example, `Hash::toJSON` is inherited from `SimpleHash`, not `Object`. By default, `get` and `set` affect key-value pairs in the `Hash`. You can override this by defining your own accessors.\n\n## ::constructor(obj: Object) : Hash\n\nCreates a new `Hash` with the key-value pairs in `obj`.\n\n## get, set, unset, and @accessor\n\nBy default, `get`, `set` and `unset` change values in the `Hash`'s storage. If you define your own accessors with `@accessor`, `get` and `set` for that key will be handled by the custom accessor.\n\n    test 'custom accessors take precedence over Hash storage', ->\n      class CustomHash extends Batman.Hash\n        @accessor 'timesTwo',\n          set: (key, value) -> @_customValue = value\n          get: -> @_customValue * 2\n\n      customHash = new CustomHash\n      customHash.set('normalKey',  'value')\n      customHash.set('timesTwo',  4)\n      equal customHash.get('normalKey'), 'value', \"The default accessor is used\"\n      equal customHash.get('timesTwo'), 8, \"The custom accessor is used\"\n      equal customHash.hasKey('timesTwo'), false, \"The custom accessor doesn't use hash storage\"\n\n## ::keys() : Array\n\nReturns an array of the keys in the `Hash`.\n\n## ::isEmpty() : Boolean\n\nReturns true if the `Hash`'s length is 0.\n\n## ::toArray() : Array\n\nReturns an array of keys in the `Hash`.\n\n## ::forEach(func : Function)\n\nCalls `func(key, value)` for each pair in the `Hash`.\n\n## ::hasKey(testKey : String ) : Boolean\n\nReturns `true` if `testKey` exists on the `Hash`.\n\n## ::clear() : Array\n\nUnsets all keys, then fires an `itemsWereRemoved` event with the removed keys and values. It returns all values that were in the `Hash`.\n\n## ::merge(hashes... : Hash) : Hash\n\nCreates a __new `Hash`__ by merging pairs from `hashes` into the `Hash` and returns the merged result.\n\n## ::update(obj: Object)\n\nFor each key-value pair in `obj`, the keys in the `Hash` are updated with the provided values.\n\n- If any of the keys in `obj` were not in the `Hash` before, an `itemsWereAdded` event is fired with the new keys and new values.\n- If any of the keys in `obj` were already present in the `Hash`, an `itemsWereChanged` event is fired with the other keys, their new values (from `obj`) and their previous values.\n\n## ::replace(obj: Object)\n\nThe key-value pairs in `Hash` are completely replaced with those in `obj`.\n\n- If there were any keys in `obj` that weren't previously in the `Hash`, an `itemsWereAdded` event is fired with the new keys and their values.\n- If any keys were present in the `Hash` but weren't present in `obj` then those keys are unset on `Hash` and an `itemsWereRemoved` event is fired with the removed keys and their values.\n- If any keys were present in the `Hash` and in `obj`, then an `itemsWereChanged` event is fired with those keys, their previous values and their new values.\n\n## ::toObject() : Object\n\nReturns a plain JavaScript Object with the contents of the `Hash`.\n\n## ::toJSON() : Object\n\nReturns a plain JavaScript Object, like `toObject`, but calls `toJSON` on the each value, if it has a `toJSON` method.\n","old_contents":"","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f29caa17f456a8cab941f799cd75245d6b89c88f","subject":"comment","message":"comment\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        console.error 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      console.error msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       #throw e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options) ->\n      @errorCallback 'AJAX cannot respond', data\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        console.error 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      console.error msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options) ->\n      @errorCallback 'AJAX cannot respond', data\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5212a2a271ffc58dbcf37e89ce6f87908dfcbc32","subject":"Fixed a bug causing matrix corruption when rotations on different axes are performed.","message":"Fixed a bug causing matrix corruption when rotations on different axes are\nperformed.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat","old_file":"src\/matrix.litcoffee","new_file":"src\/matrix.litcoffee","new_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            module.exports.multiply output, temp3, output\n            return\n\n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven the X, Y and Z scaling factors and a matrix, calling the \"scale\" property\nscales the matrix by those scaling factors.\n        \n        scale: (x, y, z, output) ->\n            output[index] *= x for index in [0...4]\n            output[index] *= y for index in [4...8]\n            output[index] *= z for index in [8...12]\n            return\n\nGiven the X, Y and Z values to translate by and a matrix to translate, calling\nthe \"translate\" property applies that translation to that matrix.\n            \n        translate: (x, y, z, output) ->\n            output[3] += x\n            output[7] += y\n            output[11] += z\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","old_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n\ttemp1 = []\n\ttemp2 = []\n\ttemp3 = []\n\t\n\tmakeRotate = (axis1, axis2, axis3, axis4) -> (radians, output) ->\n\t\tsin = Math.sin radians\n\t\tcos = Math.cos radians\n\t\ttemp3[axis1] = cos\n\t\ttemp3[axis2] = -sin\n\t\ttemp3[axis3] = sin\n\t\ttemp3[axis4] = cos\n\t\tmodule.exports.multiply output, temp3, output\n\t\treturn\n\n\tmodule.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n\t\tidentity: (output) ->\n\t\t\tfor row in [0...4]\n\t\t\t\tfor column in [0...4]\n\t\t\t\t\toutput[row * 4 + column] = if row is column then 1 else 0\n\t\t\treturn\n\t\t\nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n\t\tcopy: (input, output) ->\n\t\t\toutput[index] = value for value, index in input\n\t\t\treturn\n\t\t\t\nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n\t\tmultiply: (a, b, output) ->\n\t\t\tmodule.exports.copy a, temp1\n\t\t\tmodule.exports.copy b, temp2\n\t\t\t\t\n\t\t\tfor row in [0...4]\n\t\t\t\tfor column in [0...4]\n\t\t\t\t\ttemp = 0\n\t\t\t\t\tfor component in [0...4]\n\t\t\t\t\t\ttemp += temp1[component * 4 + column] * temp2[row * 4 + component]\n\t\t\t\t\toutput[row * 4 + column] = temp\n\t\t\treturn\n\t\t\t\nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\n\t\t\t\n\t\trotateX: makeRotate 5, 6, 9, 10\n\t\t\nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\n\t\t\n\t\trotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\n\t\t\n\t\trotateZ: makeRotate 0, 1, 4, 5\n\t\t\nGiven the X, Y and Z scaling factors and a matrix, calling the \"scale\" property\nscales the matrix by those scaling factors.\n\t\t\n\t\tscale: (x, y, z, output) ->\n\t\t\toutput[index] *= x for index in [0...4]\n\t\t\toutput[index] *= y for index in [4...8]\n\t\t\toutput[index] *= z for index in [8...12]\n\t\t\treturn\n\nGiven the X, Y and Z values to translate by and a matrix to translate, calling\nthe \"translate\" property applies that translation to that matrix.\n\t\t\t\n\t\ttranslate: (x, y, z, output) ->\n\t\t\toutput[3] += x\n\t\t\toutput[7] += y\n\t\t\toutput[11] += z\n\t\t\treturn\n\t\t\t\nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n\t\tapply: (matrix, x, y, z, w) ->\n\t\t\tif x is undefined then x = 0\n\t\t\tif y is undefined then y = 0\n\t\t\tif z is undefined then z = 0\n\t\t\tif w is undefined then w = 1\n\t\t\t\n\t\t\t[\n\t\t\t\tx * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n\t\t\t\tx * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n\t\t\t\tx * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n\t\t\t\tx * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n\t\t\t]\n\t\t\t\n\tmodule.exports.identity temp1\n\tmodule.exports.identity temp2\n\tmodule.exports.identity temp3","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2e0bf54cbe434373c4eb051f8cb63b148ef0c5c4","subject":"one more thing","message":"one more thing\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey[= \"id\"] : string\n\nDefines the `Model`'s primary key. This attribute will be used for determining:\n\n- record identity (ie, records with the same `primaryKey` are assumed to be the same record)\n- whether a record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew)\n- whether records are related (see [`Batman.Model` Associations](\/docs\/api\/batman.model_associations.html))\n- URL parameters via [`toParam`](\/docs\/api\/batman.model.html#prototype_function_toparam)\n\nChange the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n      equal Shop.get('primaryKey'), 'shop_id'\n\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n\n        @validate 'title', 'body', {presence: true} # title and body must be present (not undefined nor '')\n        @validate 'body', {minLength: 10}           # body must be 10 characters long at least\n        @validate 'title', {pattern: \/^[A-Z]\/}      # Title must start with an uppercase letter\n        @validate 'author', {email: true}           # the author field must contain a valid email address\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n + `regexp : \/regexp\/` : Assert that the value is matching the provided regular expression.\n + `email : true` : Assert that the value is an email address, per the [W3C HTML5 definition](http:\/\/www.w3.org\/TR\/html5\/forms.html#valid-e-mail-address).\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::isDirty() : Boolean\n\nReturns `true` if any keys have been changed since the record was initialized or saved.\n\n## ::%isDirty : Boolean\n\nA bindable accessor on [`isDirty`](\/docs\/api\/batman.model.html#prototype_function_isdirty).\n\n## ::%dirtyKeys : Set\n\nThe [`Batman.Set`](\/docs\/api\/batman.set.html) of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::constructor(idOrAttributes = {}) : Model\n\nReturns a new `Batman.Model`. If `idOrAttributes` is an object, the values are mixed into the new record. Otherwise, `idOrAttrubutes` is set to the new record's [`id`](\/docs\/api\/batman.model.html#prototype_accessor_id).\n\n## ::isNew() : boolean\n\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## ::%isNew : Boolean\n\nA bindable accessor on [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew).\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# \/api\/App Components\/Batman.Model\/Batman.Validator\n\nbatman.js ships with a plethora of [built-in validators](\/docs\/api\/batman.model.html#class_function_validate), but when they don't meet your needs, you can create custom validators by subclassing `Batman.Validator`, implementing `Batman.Validator::validateEach`, and adding the new validator to `Batman.Validators`. For example:\n\n```coffeescript\nclass App.LessThanPropertyValidator extends Batman.Validator\n  @triggers 'lessThanProperty'\n  @options 'allowBlank'\n\n  validateEach: (errors, record, key, callback) ->\n      value = record.get(key)\n      compareKey = @options.lessThanProperty\n      otherValue = record.get(compareKey)\n      else !@handleBlank(value) && value >= otherValue\n        errors.add(key, 'must be less than #{compareKey}')\n      callback()\n\nBatman.Validators.push App.LessThanPropertyValidator\n```\n\n## ::constructor(options : Object[, mixins...])\n\nThe first argument becomes the validator's `@options`. Subsequent arguments are mixed in to the validator with `Batman.Object::mixin`. You can override this method to alter the options object before it's assigned to `@options`. (Make sure to call `super` afterwards!)\n\n## @triggers(triggers...)\n\nWhen any of the strings in `triggers` is passed to `Model@validate`:\n\n- this validator will be instantiated and its `validateEach` will be invoked\n- the key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUse this method when one validator will handle many kinds of validations. For example, a simplified length validator:\n\n```coffeescript\nclass App.SimpleLengthValidator extends Batman.Validator\n  @triggers 'minLength', 'maxLength', 'length'\n\n  constructor: (options) ->\n    # has access to options.minLength, options.maxLength, options.length\n    super\n\n  validateEach: (errors, record, key, callback) ->\n    # has access to @options.minLength, @options.maxLength, @options.length\n```\n\nAll three of these validations will be handled by `App.SimpleLengthValidator::validateEach`:\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @validate 'name', minLength: 3\n  @validate 'bio', maxLength: 250\n  @validate 'phone_number', length: 10\n```\n\n## @options(options...)\n\nThe key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUnlike `@triggers`, the presence of a key in `options` will not cause this validator to be instantiated.\n\n## ::validateEach(errors: Batman.ErrorsSet, record: Batman.Model, key: String, callback: Function)\n\nThis method is invoked to validate `key` on `record`. If this method determins that the key is invalid, it should add a validation error to `errors`.\n\n`errors` is a `Batman.ErrorsSet`, which is a [`Batman.Set`](\/docs\/api\/batman.set.html) with `::add(key, message)` as a convenience method for adding [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s. So, to easily add a new validation error:\n\n```coffeescript\nerrors.add(\"phone_number\", \"isn't 10 characters long\")\n```\n\nWhen the validator is finished, it must call `callback` to continue the validation chain.\n\n## @handleBlank(value)\n\nReturns `true` if `options.allowBlank` is `true` _and_ `value` is `null`, `undefined` or `\"\"`\n\n# \/api\/App Components\/Batman.Model\/Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# \/api\/App Components\/Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey[= \"id\"] : string\n\nDefines the `Model`'s primary key. This attribute will be used for determining:\n\n- record identity (ie, records with the same `primaryKey` are assumed to be the same record)\n- whether a record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew)\n- records are related (see [`Batman.Model` Associations](\/docs\/api\/batman.model_associations.html))\n- generating URLs\n\nChange the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n      equal Shop.get('primaryKey'), 'shop_id'\n\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n\n        @validate 'title', 'body', {presence: true} # title and body must be present (not undefined nor '')\n        @validate 'body', {minLength: 10}           # body must be 10 characters long at least\n        @validate 'title', {pattern: \/^[A-Z]\/}      # Title must start with an uppercase letter\n        @validate 'author', {email: true}           # the author field must contain a valid email address\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n + `regexp : \/regexp\/` : Assert that the value is matching the provided regular expression.\n + `email : true` : Assert that the value is an email address, per the [W3C HTML5 definition](http:\/\/www.w3.org\/TR\/html5\/forms.html#valid-e-mail-address).\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::isDirty() : Boolean\n\nReturns `true` if any keys have been changed since the record was initialized or saved.\n\n## ::%isDirty : Boolean\n\nA bindable accessor on [`isDirty`](\/docs\/api\/batman.model.html#prototype_function_isdirty).\n\n## ::%dirtyKeys : Set\n\nThe [`Batman.Set`](\/docs\/api\/batman.set.html) of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::constructor(idOrAttributes = {}) : Model\n\nReturns a new `Batman.Model`. If `idOrAttributes` is an object, the values are mixed into the new record. Otherwise, `idOrAttrubutes` is set to the new record's [`id`](\/docs\/api\/batman.model.html#prototype_accessor_id).\n\n## ::isNew() : boolean\n\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## ::%isNew : Boolean\n\nA bindable accessor on [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew).\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\nAvailable options include:\n- `only`: A whitelist that will submit only the specified model attributes from the storage adapter.  This is useful when you want to do partial updates of a model without sending the full model content.  e.g., `options = {only: ['name', 'bio']}`\n- `except`: A blacklist that will prevent specified model attributes from being transmitted from the storage adapter.  e.g., `options = {except: ['sensitive_data']}`\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# \/api\/App Components\/Batman.Model\/Batman.Validator\n\nbatman.js ships with a plethora of [built-in validators](\/docs\/api\/batman.model.html#class_function_validate), but when they don't meet your needs, you can create custom validators by subclassing `Batman.Validator`, implementing `Batman.Validator::validateEach`, and adding the new validator to `Batman.Validators`. For example:\n\n```coffeescript\nclass App.LessThanPropertyValidator extends Batman.Validator\n  @triggers 'lessThanProperty'\n  @options 'allowBlank'\n\n  validateEach: (errors, record, key, callback) ->\n      value = record.get(key)\n      compareKey = @options.lessThanProperty\n      otherValue = record.get(compareKey)\n      else !@handleBlank(value) && value >= otherValue\n        errors.add(key, 'must be less than #{compareKey}')\n      callback()\n\nBatman.Validators.push App.LessThanPropertyValidator\n```\n\n## ::constructor(options : Object[, mixins...])\n\nThe first argument becomes the validator's `@options`. Subsequent arguments are mixed in to the validator with `Batman.Object::mixin`. You can override this method to alter the options object before it's assigned to `@options`. (Make sure to call `super` afterwards!)\n\n## @triggers(triggers...)\n\nWhen any of the strings in `triggers` is passed to `Model@validate`:\n\n- this validator will be instantiated and its `validateEach` will be invoked\n- the key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUse this method when one validator will handle many kinds of validations. For example, a simplified length validator:\n\n```coffeescript\nclass App.SimpleLengthValidator extends Batman.Validator\n  @triggers 'minLength', 'maxLength', 'length'\n\n  constructor: (options) ->\n    # has access to options.minLength, options.maxLength, options.length\n    super\n\n  validateEach: (errors, record, key, callback) ->\n    # has access to @options.minLength, @options.maxLength, @options.length\n```\n\nAll three of these validations will be handled by `App.SimpleLengthValidator::validateEach`:\n\n```coffeescript\nclass App.Superhero extends Batman.Model\n  @validate 'name', minLength: 3\n  @validate 'bio', maxLength: 250\n  @validate 'phone_number', length: 10\n```\n\n## @options(options...)\n\nThe key-value pairs passed to `Model@validate` with these keys will be available on `@options` for this validator.\n\nUnlike `@triggers`, the presence of a key in `options` will not cause this validator to be instantiated.\n\n## ::validateEach(errors: Batman.ErrorsSet, record: Batman.Model, key: String, callback: Function)\n\nThis method is invoked to validate `key` on `record`. If this method determins that the key is invalid, it should add a validation error to `errors`.\n\n`errors` is a `Batman.ErrorsSet`, which is a [`Batman.Set`](\/docs\/api\/batman.set.html) with `::add(key, message)` as a convenience method for adding [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s. So, to easily add a new validation error:\n\n```coffeescript\nerrors.add(\"phone_number\", \"isn't 10 characters long\")\n```\n\nWhen the validator is finished, it must call `callback` to continue the validation chain.\n\n## @handleBlank(value)\n\nReturns `true` if `options.allowBlank` is `true` _and_ `value` is `null`, `undefined` or `\"\"`\n\n# \/api\/App Components\/Batman.Model\/Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"69cb8c7c02fcee309011ac928d727b9949e2caa5","subject":"Fix typo.","message":"Fix typo.\n","repos":"daithiocrualaoich\/noted,daithiocrualaoich\/noted","old_file":"www\/app.litcoffee","new_file":"www\/app.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"41a5b56b0b1e9f72ecbd2844fb6cc5ea71a3ba54","subject":"stand alone @","message":"stand alone @\n","repos":"vpj\/weya,vpj\/weya","old_file":"base.litcoffee","new_file":"base.litcoffee","new_contents":"#Weya.Base.js\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n##Weya.Base\nIntroduces class level function initialize and include.\n\n    class Base\n     _initialize: []\n     on: {}\n\nExtend Events\n\n     @extend: ->\n      events = @::on\n      @::on = {}\n      @::on[k] = v for k, v of events\n\nAdd event listeners\n\n     @listen: (name, func) ->\n      @::on[name] = func\n\nGetter\n\n     @get: (name, func) ->\n      @::__defineGetter__ name, func\n\nSetter\n\n     @set: (name, func) ->\n      @::__defineSetter__ name, func\n\n     constructor: ->\n      @_init.apply this, arguments\n\n####Register initialize functions.\nAll initializer funcitons in subclasses will be called with the constructor\narguments.\n\n     @initialize: (func) ->\n      @::_initialize = @::_initialize.slice()\n      @::_initialize.push func\n\n     _init: ->\n      for init in @_initialize\n       init.apply this, arguments\n\n      return\n\n####Include objects.\nYou can include objects by registering them with @include. This tries to\nsolve the problem of single inheritence.\n\n     @include: (obj) ->\n      for k, v of obj\n       switch k\n        when 'initialize'\n         @::_initialize.push v\n        when 'on'\n         for event, listener of v\n          @::on[event] = listener\n        else\n         @prototype[k] = v\n\n     @initialize ->\n      events = @on\n      @on = {}\n      for k, v of events\n       @on[k] = v.bind this\n\n    Weya.Base = Base\n\n    if module?\n     module.exports = Weya.Base\n\n","old_contents":"#Weya.Base.js\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n##Weya.Base\nIntroduces class level function initialize and include.\n\n    class Base\n     _initialize: []\n     on: {}\n\nExtend Events\n\n     @extend: ->\n      events = @::on\n      @::on = {}\n      @::on[k] = v for k, v of events\n\nAdd event listeners\n\n     @listen: (name, func) ->\n      @::on[name] = func\n\nGetter\n\n     @get: (name, func) ->\n      @::__defineGetter__ name, func\n\nSetter\n\n     @set: (name, func) ->\n      @::__defineSetter__ name, func\n\n     constructor: ->\n      @_init.apply this, arguments\n\n####Register initialize functions.\nAll initializer funcitons in subclasses will be called with the constructor\narguments.\n\n     @initialize: (func) ->\n      @::_initialize = @::_initialize.slice()\n      @::_initialize.push func\n\n     _init: ->\n      for init in @_initialize\n       init.apply this, arguments\n\n      return\n\n####Include objects.\nYou can include objects by registering them with @include. This tries to\nsolve the problem of single inheritence.\n\n     @include: (obj) ->\n      for k, v of obj\n       switch k\n        when 'initialize'\n         @::_initialize.push v\n        when 'on'\n         for event, listener of v\n          @::on[event] = listener\n        else\n         @::[k] = v\n\n     @initialize ->\n      events = @on\n      @on = {}\n      for k, v of events\n       @on[k] = v.bind this\n\n    Weya.Base = Base\n\n    if module?\n     module.exports = Weya.Base\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e012d08c21fa5fab4b7a196d662cfbc25cdfe8f3","subject":"parkup helpers","message":"parkup helpers\n","repos":"vpj\/weya,vpj\/weya","old_file":"weya.litcoffee","new_file":"weya.litcoffee","new_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       if elem.classList?\n        for c in idClass.class\n         elem.classList.add c\n       else #For older browsers; does not work with svgs\n        className = ''\n        for c in idClass.class\n         className += ' ' if className isnt ''\n         className += \"#{c}\"\n        elem.className = className\n\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        buf.push \" class=\\\"#{params.idClass.class}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       setIndent buf, @_indent\n       buf.push params.text\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     added = []\n     if options.helpers?\n      for name, f of options.helpers\n       if not weya[name]?\n        added.push name\n        weya[name] = ->\n         f.apply weya, arguments\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n     for name in added\n      weya[name] = null\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","old_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\nParse id and class string\n\n    parseIdClass = (str) ->\n     res =\n      id: null\n      class: []\n\n     for c, i in str.split \".\"\n      if c.indexOf(\"#\") is 0\n       res.id = c.substr 1\n      else if c isnt \"\"\n       if not res.class?\n        res.class = [c]\n       else\n        res.class.push c\n\n     return res\n\n\n    getParameters = (args) ->\n     params =\n      idClass: null\n      text: null\n      attrs: null\n      func: null\n\n     for arg, i in args\n      switch typeof arg\n       when 'function' then params.func = arg\n       when 'object' then params.attrs = arg\n       when 'string'\n        if args.length is 1\n         params.text = arg\n        else\n         c = arg.charAt 0\n\n         if i is 0 and (c is '#' or c is '.')\n          params.idClass = parseIdClass arg\n         else\n          params.text = arg\n\n     return params\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\n     setIdClass = (elem, idClass) ->\n      if idClass.id?\n       elem.id = idClass.id\n\n      if idClass.class?\n       if elem.classList?\n        for c in idClass.class\n         elem.classList.add c\n       else #For older browsers; does not work with svgs\n        className = ''\n        for c in idClass.class\n         className += ' ' if className isnt ''\n         className += \"#{c}\"\n        elem.className = className\n\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if params.idClass?\n       setIdClass elem, params.idClass\n\n      if params.attrs?\n       setAttributes elem, params.attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       elem.textContent = params.text\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      params = getParameters args\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if params.idClass?\n       if params.idClass.id?\n        buf.push \" id=\\\"#{params.idClass.id}\\\"\"\n       if params.idClass.class?\n        buf.push \" class=\\\"#{params.idClass.class}\\\"\"\n\n      if params.attrs?\n       setAttributes buf, params.attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if params.func?\n       params.func.call this\n      else if params.text?\n       setIndent buf, @_indent\n       buf.push params.text\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e1c7aa524db6311a91fed1f3d081070060dd0497","subject":"Tweak model docs","message":"Tweak model docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will have the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cfed216b303ee66829da039fbb4448184e7d93fc","subject":"fix typo and style","message":"fix typo and style\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal name: \"Talia al Ghul\", notorious: true\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal name: \"Dr. Jonathan Crane\", notorious: false\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occured within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\n\nReturns whether the object is new (i.e., not saved yet) or not. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal name: \"Talia al Ghul\", notorious: true\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal name: \"Dr. Jonathan Crane\", notorious: false\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occured within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"29c8e819a78f8d45d9133e9369674427572b29dc","subject":"list stack fix","message":"list stack fix\n","repos":"vpj\/models","old_file":"js\/properties\/list.litcoffee","new_file":"js\/properties\/list.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#List\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\nClass\n\n      class List extends Base\n       @extend()\n\n       propertyType: 'list'\n\n       @default 'list', {}\n\n       @default 'default', -> []\n       @default 'isDefault', (value) ->\n        return true if not value?\n        return true if value.length is 0\n        return false\n\n       constructor: (schema) ->\n        super schema\n\n        list = @schema.list\n        @item = PROPERTIES.create list\n\n       @isValidSchema: (schema) ->\n        return false if not super schema\n        return false if not schema.list?\n        return PROPERTIES.isValidSchema schema.list\n\n       toJSON: (value, stack) ->\n        return null if not value\n        return null if value.lengtuuuuh is 0\n\n        for v, i in value\n         s = stack.slice 0\n         s.push i\n         @item.toJSON v, s\n\n       toJSONFull: (value, stack) ->\n        return null if not value\n        for v, i in value\n         s = stack.slice 0\n         s.push i\n         @item.toJSONFull v, s\n\n       parse: (data, stack) ->\n        r = super data, stack\n        return r unless r is true\n\n        if not Array.isArray data\n         return @error 'array expected'\n\n        res =\n         score: 0\n         errors: []\n         value: []\n        for d, i in data\n         s = stack.slice 0\n         s.push i\n         r = @item.parse d, s\n         res.score += r.score\n         for e in r.errors\n          res.errors.push e\n         res.value.push r.value\n\n        res.score \/= res.value.length\n\n        return res\n\n       edit: (elem, value, onChanged, stack) ->\n        new Edit this, elem, value, onChanged, stack\n\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, onChanged, stack) ->\n        @property = property\n        @elems =\n         parent: elem\n        @list = value\n        @onChanged = onChanged\n        @stack = stack\n        @render()\n\n       render: ->\n        Weya elem: @elems.parent, context: this, ->\n         @div \".list-controls\", ->\n          @$.elems.add = @i \".fa.fa-plus\", null\n         @$.elems.list = @div \".list\", null\n\n        @elems.add.addEventListener 'click', @on.addClick\n\n        @renderList()\n\n       @listen 'addClick', (e) ->\n        stack = @stack.slice 0\n        stack.push @list.length\n        @list.push (@property.item.parse null, stack).value\n        @renderList()\n        @onChanged @list\n\n       @listen 'listClick',(e) ->\n        n = e.target\n        idx = null\n        action = null\n        while n?\n         idx = n.listIdx if n.listIdx?\n         action = n.listAction if n.listAction?\n         n = n.parentNode\n\n        return if not idx?\n        return if not action?\n\n        switch action\n         when 'down'\n          return if idx >= @list.length - 1\n          temp = @list[idx]\n          @list[idx] = @list[idx + 1]\n          @list[idx + 1] = temp\n         when 'up'\n          return if idx <= 0\n          temp = @list[idx]\n          @list[idx] = @list[idx - 1]\n          @list[idx - 1] = temp\n         when 'delete'\n          for i in [idx...@list.length - 1]\n           @list[i] = @list[i + 1]\n          @list.pop()\n\n        @renderList()\n        @onChanged @list, false\n\n\n       renderList: ->\n        @elems.list.innerHTML = ''\n        @elems.items = []\n        Weya elem: @elems.list, context: this, ->\n         for v, i in @$.list\n          @div \".list-item\", ->\n           @div \".list-item-controls-hover\", ->\n            @i \".fa.fa-cog\", null\n            @div \".list-item-controls\",\n             on: {click: @$.on.listClick}\n             ->\n              icon = @i \".fa.fa-lg.fa-arrow-up\", null\n              icon.listIdx = i\n              icon.listAction = 'up'\n              icon = @i \".fa.fa-lg.fa-arrow-down\", null\n              icon.listIdx = i\n              icon.listAction = 'down'\n              icon = @i \".fa.fa-lg.fa-trash\", null\n              icon.listIdx = i\n              icon.listAction = 'delete'\n           @div \".list-item-content\", ->\n            @div \".property.property-type-#{@$.property.item.propertyType}\", ->\n             @$.elems.items.push @div \".property-value\", null\n\n        for v, i in @list\n         stack = @stack.slice 0\n         stack.push i\n         @property.item.edit @elems.items[i], v,\n          @itemChanged.bind self: this, idx: i\n          stack\n\n       itemChanged: (value, changed) ->\n        if changed\n         @self.list[@idx] = value\n        @self.onChanged @self.list, false\n\n\n\n      PROPERTIES.register 'list', List\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#List\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\nClass\n\n      class List extends Base\n       @extend()\n\n       propertyType: 'list'\n\n       @default 'list', {}\n\n       @default 'default', -> []\n       @default 'isDefault', (value) ->\n        return true if not value?\n        return true if value.length is 0\n        return false\n\n       constructor: (schema) ->\n        super schema\n\n        list = @schema.list\n        @item = PROPERTIES.create list\n\n       @isValidSchema: (schema) ->\n        return false if not super schema\n        return false if not schema.list?\n        return PROPERTIES.isValidSchema schema.list\n\n       toJSON: (value, stack) ->\n        return null if not value\n        return null if value.lengtuuuuh is 0\n        for v, i in value\n         stack = stack.slice 0\n         stack.push i\n         @item.toJSON v, stack\n\n       toJSONFull: (value, stack) ->\n        return null if not value\n        for v, i in value\n         stack = stack.slice 0\n         stack.push i\n         @item.toJSONFull v, stack\n\n       parse: (data, stack) ->\n        r = super data, stack\n        return r unless r is true\n\n        if not Array.isArray data\n         return @error 'array expected'\n\n        res =\n         score: 0\n         errors: []\n         value: []\n        for d, i in data\n         stack = stack.slice 0\n         stack.push i\n         r = @item.parse d, stack\n         res.score += r.score\n         for e in r.errors\n          res.errors.push e\n         res.value.push r.value\n\n        res.score \/= res.value.length\n\n        return res\n\n       edit: (elem, value, onChanged, stack) ->\n        new Edit this, elem, value, onChanged, stack\n\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, onChanged, stack) ->\n        @property = property\n        @elems =\n         parent: elem\n        @list = value\n        @onChanged = onChanged\n        @stack = stack\n        @render()\n\n       render: ->\n        Weya elem: @elems.parent, context: this, ->\n         @div \".list-controls\", ->\n          @$.elems.add = @i \".fa.fa-plus\", null\n         @$.elems.list = @div \".list\", null\n\n        @elems.add.addEventListener 'click', @on.addClick\n\n        @renderList()\n\n       @listen 'addClick', (e) ->\n        stack = @stack.slice 0\n        stack.push @list.length\n        @list.push (@property.item.parse null, stack).value\n        @renderList()\n        @onChanged @list\n\n       @listen 'listClick',(e) ->\n        n = e.target\n        idx = null\n        action = null\n        while n?\n         idx = n.listIdx if n.listIdx?\n         action = n.listAction if n.listAction?\n         n = n.parentNode\n\n        return if not idx?\n        return if not action?\n\n        switch action\n         when 'down'\n          return if idx >= @list.length - 1\n          temp = @list[idx]\n          @list[idx] = @list[idx + 1]\n          @list[idx + 1] = temp\n         when 'up'\n          return if idx <= 0\n          temp = @list[idx]\n          @list[idx] = @list[idx - 1]\n          @list[idx - 1] = temp\n         when 'delete'\n          for i in [idx...@list.length - 1]\n           @list[i] = @list[i + 1]\n          @list.pop()\n\n        @renderList()\n        @onChanged @list, false\n\n\n       renderList: ->\n        @elems.list.innerHTML = ''\n        @elems.items = []\n        Weya elem: @elems.list, context: this, ->\n         for v, i in @$.list\n          @div \".list-item\", ->\n           @div \".list-item-controls-hover\", ->\n            @i \".fa.fa-cog\", null\n            @div \".list-item-controls\",\n             on: {click: @$.on.listClick}\n             ->\n              icon = @i \".fa.fa-lg.fa-arrow-up\", null\n              icon.listIdx = i\n              icon.listAction = 'up'\n              icon = @i \".fa.fa-lg.fa-arrow-down\", null\n              icon.listIdx = i\n              icon.listAction = 'down'\n              icon = @i \".fa.fa-lg.fa-trash\", null\n              icon.listIdx = i\n              icon.listAction = 'delete'\n           @div \".list-item-content\", ->\n            @div \".property.property-type-#{@$.property.item.propertyType}\", ->\n             @$.elems.items.push @div \".property-value\", null\n\n        for v, i in @list\n         stack = @stack.slice 0\n         stack.push i\n         @property.item.edit @elems.items[i], v,\n          @itemChanged.bind self: this, idx: i\n          stack\n\n       itemChanged: (value, changed) ->\n        if changed\n         @self.list[@idx] = value\n        @self.onChanged @self.list, false\n\n\n\n      PROPERTIES.register 'list', List\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fe4d33c77a1c9b9e206961985a769f04527d233d","subject":"Send data as UTF-8","message":"Send data as UTF-8\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nInitialize sane values.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\nInstance of express.\n\n\t\tapp: null\n\nInstance of http\n\n\t\tserver: null\n\nInstance of socket.io\n\n\t\tio: null\n\nStatistics for the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting nodePush'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing outbound socket'\n\nStart HTTP service.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\tlistenCallback = =>\n\nShed root privilegies.\n\n\t\t\t\tif process.getuid() is 0 or process.getgid() is 0\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\t\t\t\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\t\t\t\t\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\treturn unless \/[a-zA-Z0-9-_.]+$\/.test name\n\t\t\t\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\nPass data to the browsers and close connection.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nKill connection after 5 seconds.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket unless config.inbound.useTCP\n\t\t\tfs.unlinkSync config.outbound.socket unless config.outbound.useTCP\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","old_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nInitialize sane values.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\nInstance of express.\n\n\t\tapp: null\n\nInstance of http\n\n\t\tserver: null\n\nInstance of socket.io\n\n\t\tio: null\n\nStatistics for the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting nodePush'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing outbound socket'\n\nStart HTTP service.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\tlistenCallback = =>\n\nShed root privilegies.\n\n\t\t\t\tif process.getuid() is 0 or process.getgid() is 0\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\t\t\t\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.type 'text\/plain'\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\treturn unless \/[a-zA-Z0-9-_.]+$\/.test name\n\t\t\t\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\nPass data to the browsers and close connection.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nKill connection after 5 seconds.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket unless config.inbound.useTCP\n\t\t\tfs.unlinkSync config.outbound.socket unless config.outbound.useTCP\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"266f307f23ae98eee3cb6b2f9234affd743b98c9","subject":"Docs for data-view on data-foreach.","message":"Docs for data-view on data-foreach.\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/15_bindings.litcoffee","new_file":"docs\/15_bindings.litcoffee","new_contents":"# Batman View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n## data-yield\n\n## data-contentfor\n\n## data-replace\n\n# Batman View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","old_contents":"# Batman View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n## data-yield\n\n## data-contentfor\n\n## data-replace\n\n# Batman View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"df3e207e6f91ab9c5fad7053475e32482f1588c6","subject":"Disable cache by default.","message":"Disable cache by default.\n","repos":"monokrome\/glp","old_file":"src\/defaults.litcoffee","new_file":"src\/defaults.litcoffee","new_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How GLP configuration works\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp,watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is false by default, but can be made true if caching\nhappens to be working as expected with your project. This feature is disabled\nby default because it is still experimental for now.\n\n        enabled: no\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nWe'll also want source maps, so let's enabled those.\n\n        coffee:\n          sourceMap: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nSome more default formats are provided here:\n\n          iced: {}\n\n          typescript:\n            matches: '**\/*.ts'\n\n          livescript:\n            matches: '**\/*.ls'\n\n          handlebars:\n            matches: '**\/*.hbs'\n\n          coco:\n            matches: '**\/*.co'\n\n          eco:\n            matches: '**\/*.eco'\n\n          dust:\n            matches: ['**\/*.djs', '**\/*.dust']\n\n          nunjucks:\n            matches: ['**\/*.njs', '**\/*.nunjucks']\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\nSome more default formats are provided here:\n\n          haml: {}\n          ejs: {}\n          mustache: {}\n\n          markdown:\n            matches: ['**\/*.md', '**\/*.markdown']\n\n          template:\n            matches: '**\/*.tpl'\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js`, `.coffee` and a few\nother extensions. After they are built, the resulting files will be placed in\nthe directory specified by the **root** function as separate files. If the\noutput file was not a **directory** (as denoted by the ending slash) then the\nfiles would also be concatenated and the resulting file would be given the\n*extension* which corresponds to this type of file.\n\n          '\/scripts\/': [\n            'src\/scripts\/**\/*.js'\n            'src\/scripts\/**\/*.coffee'\n            'src\/scripts\/**\/*.iced'\n            'src\/scripts\/**\/*.co'\n            'src\/scripts\/**\/*.ls'\n            'src\/scripts\/**\/*.ts'\n            'src\/scripts\/**\/*.hbs'\n            'src\/scripts\/**\/*.eco'\n            'src\/scripts\/**\/*.djs'\n            'src\/scripts\/**\/*.dust'\n            'src\/scripts\/**\/*.njs'\n            'src\/scripts\/**\/*.nunjucks'\n          ]\n\nHere, we are doing the same thing for *html*, *jade*, and some other file\nextensions. This time we are outputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/templates\/**\/*.html'\n            'src\/templates\/**\/*.jade'\n            'src\/templates\/**\/*.md'\n            'src\/templates\/**\/*.markdown'\n            'src\/templates\/**\/*.haml'\n            'src\/templates\/**\/*.ejs'\n            'src\/templates\/**\/*.mustache'\n            'src\/templates\/**\/*.tpl'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/stylesheets\/': [\n            'src\/stylesheets\/**\/*.css'\n            'src\/stylesheets\/**\/*.less'\n            'src\/stylesheets\/**\/*.sass'\n            'src\/stylesheets\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            coffee:\n              sourceMap: no\n\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","old_contents":"# Configuration\n\nGLP is configured using a specific grammar for explaining how to build a gulp\nproject. This grammar allows you to easily explain both simple and complicated\nbuild processes in a single configuration file.\n\nThe file should be named **glp.yml** and can be placed in your project's root\ndirectory, or it can be placed in an `etc` directory if preferred. You can\nalso include the configuration in your standard user-level or system-wide\nconfiguration directories.\n\nThis document aims to provide a descriptive explanation of all configuration\nand best practices for configuration options available to users of GLP.\n\nGLP configuration options can be split up into the following high level\ncategories:\n\n- **root** tells GLP where to place it's output files.\n- **files** with *named groups* and where to find them\n- **filters** for introducing new ways to transform files in *file group*\n- **plugins** options for changing the way that glp uses them for each *file group*\n- **concatenators** for defining which plugins are used for joining files in a *file group*\n- **minifiers** for changing how a *file group* is minified\n- **extensions** for defining the suffix of output files for each *file group*.\n- **liveReload** options for defining changes affect your browser after compiling.\n- **static** options for defining routing of built files to a local web server\n- **tasks** to overlay different groupings of options based on command-line arguments\n\nThe following document will walk you step-by-step through GLP's default\nconfiguration. It should help increase familiarity with all features, and how\nto get started with building your own software using GLP and your favorite\nprogramming languages.\n\n## How GLP configuration works\n\nThis is a `.litcoffee` file, so we will be using the default configuration as a\npractical example of what you can do when writing a configuration file. The\ndocumented values are exactly what is exported to the compiler in GLP.\n\n    module.exports =\n\nThese defaults are always overridden with any user-specific settings. When a\nconfiguration file is loaded, GLP will run [lodash.merge][lodashmerge] in order\nto merge the user's configuration data over the defaults. Once this is done,\nthe current *task* is merged in order to define commands which change behavior.\n\nThe one exception to this rule is the *files* option, which will be completely\noverriden if provided by a user instead of being merged into the default\nconfiguration. The *files* option will still be merged (instead of replaced) if\nmodified by *tasks*.\n\nDon't  feel discouraged if this seems confusing. It will make more sense as you\nread through this document and develop a better understanding of GLP's options.\n\n# Options\n\n## root\n\nThis should be a string that contains the name of the directory where you would\nlike GLP to put build output files.\n\n      root: 'public'\n\n## watch\n\nThis should be a boolean. When true, GLP will continue watching for changes to\nfiles after tasks finish. Otherwise, it will not watch for any changes to files.\n\n      watch: no\n\n## debug\n\nIf this is set to true, then GLP will provide you with an exhaustive amount of\ninformation describing the build process.\n\n      debug: no\n\n## globOptions\n\nThis can be an object which describes the options that should be passed to the\n`gulp,watch` and `gulp.src` functions. The keys of the object should be the\nname of the task that the options are used with. The value for each task should\nbe the options as [documented here][gulpsrcopts]. If no options are defined for\nthe currently active task, then the 'default' options will be used.\n\n      globOptions:\n        default:\n          options: {}\n\n## cache\n\nOptions for controlling how GLP caches files for faster compiling while watching\nfiles for changes.\n\n      cache:\n\nThe `cache.enabled` option is false by default, but can be made true if caching\nhappens to be working as expected with your project. This feature is disabled\nby default because it is still experimental.\n\n        enabled: no\n\n## minify\n\nOptions for controlling how GLP minifies files.\n\n      minify:\n\nThe `minify.enabled` option is false by default. You can set it to true\nif you would like to minify built files.\n\n        enabled: no\n\nThe `minify.extension` option  can be changed if you'd like to use a custom\nprefix extension. For instance, files with the extension **.js** will be\nconverted to **.min.js** when minification is turned on. If you set\n`minify.extension` to an empty string, it will then be converted into.\n\n        extension: '.min'\n\n## ordering\n\nOrdering is disabled by default, but if ordering looks wrong (this shouldn't\never happen) then you can use this in order to map specific file types to the\nordering you'd want the files to be in. This supports the globbing same format\nwhich is supported by `gulp.src` and `gulp.watch` which is more thoroughly\n[documented here][gulpsrcopts].\n\n      ordering: {}\n\n\n## plugins\n\nThe plugins option allows users to define options for gulp all plugins which\nare used in the build process. In order to do this, you provide an object\nwhere plugin names are *keys* and the options object is what will be passed\nto the related gulp plugin.\n\nWhenever referring to gulp plugins in GLP, you can optionally omit the `gulp-`\nprefix. For instance, telling GLP to use a plugin called *cached* is the same\nas telling it to use *gulp-cached*. The plugins are standard gulp plugins, so\nany standard gulp plugin should work with GLP.\n\n\nGLP has verify flexible support for easily configuring plugins to be used\nthrough gulp, and tries to be as transparent as possible without sacrificing\nusability in the process.\n\n      plugins:\n\nBy default, we ask the [gulp-cached][gulpcached] plugin to optimize memory by\nstoring the files as MD5 instead of the entire file contents.\n\n        cached:\n          optimizeMemory: yes\n\nWe also want [gulp-uglify][gulpuglify] to output source maps.\n\n        uglify:\n          outSourceMap: yes\n\nAnd while we're developing, we want our templates to be readable. So, we tell\njade to render pretty files instead of spitting them out in a single line.\n\n        jade:\n          pretty: yes\n\nWe'll also want source maps, so let's enabled those.\n\n        coffee:\n          sourceMap: yes\n\nThe options provided here can also be overridden per-file-type with the\n*filters* option as described in the next section. Every setting can be\noverriden on a per-task basis as well. This means that we can tell GLP to not\noutput source maps, pretty templates, or any other option via the *tasks*\noption as will also be defined later.\n\n## filters\n\nIt's important to remember that you can use any gulp plugin with GLP by\ninstalling it into your project with [npm][npm]. In order to let users define\narbitrary ways of transforming files, we have filters.\n\nThe *filters* option provide a way to transform file contents for different\ntypes of files. Each type of file can be given a number of filters which can\nbe passed through by defining them with this option.\n\n      filters:\n\nFor instance, scripts can be compiled as *coffee*. This example is the least\nverbose way to define a new filter. Since an empty settings object is being\nmapped to the *coffee* type, GLP will automatically transform using a plugin\ncalled [gulp-coffee][gulpcoffee] and match this plugin against a glob which\nwill automatically be generated with the filter name. In this case, the glob\npattern would be `\\*\\*\/\\*.coffee`.\n\nIt's worth noting here that you can install **any** gulp plugin into your\nproject, and GLP will support it when you just add a new filter option for it.\n\nIt is possible that the most powerful feature of GLP is it's ability to let you\nconfigure it for any type of file without needing to touch any source code in\nthe process. This configuration file is all that you will need.\n\n        scripts:\n          coffee: {}\n\nScripts can also be compiled from jade templates. Since we have grouped\nfilters with the *scripts* file group, we also know that we want the compiled\nfiles to become scripts in the end. So, we can use the `options` key to\nforward options to [gulp-jade][gulpjade] in this case.\n\n          jade:\n            options:\n              client: true\n\nSome more default formats are provided here:\n\n          iced: {}\n\n          typescript:\n            matches: '**\/*.ts'\n\n          livescript:\n            matches: '**\/*.ls'\n\n          handlebars:\n            matches: '**\/*.hbs'\n\n          coco:\n            matches: '**\/*.co'\n\n          eco:\n            matches: '**\/*.eco'\n\n          dust:\n            matches: ['**\/*.djs', '**\/*.dust']\n\n          nunjucks:\n            matches: ['**\/*.njs', '**\/*.nunjucks']\n\nFor the stylesheets group, we set up *sass* and *less* so that they will be\nbound to files with matching extensions. We have no special options in these\ncases, so we can just assign an empty object to them and let GLP assign\ndefaults as described before.\n\n        stylesheets:\n          sass: {}\n          less: {}\n\nThere are more specific cases for stylus, though. We want to use the\n[gulp-stylus][gulpstylus] module and match it against both *.styl* and\n*.stylus* file extensions. A more specific case is that we also want to use the\n'nib' module by default, but still allow users to override that choice with the\nglobal *plugins* option. That's what the *hints* option is for.\n\nBy default, the *options* in a filter override global *plugins* options. The\n*hints* option provides the opposite, where the *plugins* options act as an\noverride. This isn't an extremely useful feature, but it's helpful here for\nusers that might not want to use *nib* with their stylus files. They could just\nset `use` to an empty array in the *plugins* option to prevent it.\n\n          stylus:\n            transforms: 'stylus'\n\n            hints:\n              use: ['nib']\n\n            matches: [\n              '**\/*.styl'\n              '**\/*.stylus'\n            ]\n\nHere we redefine jade, but this time we are defining it as a template. The\nreason that we have to define this twice is because we want to give different\noptions to [gulp-jade][gulpjade] for templates instead of scripts. This allows\nus to render *templates* as *HTML* files, but jade files in *scripts* will be\nrendered as *js* files as  described previously.\n\n        templates:\n          jade:\n            options:\n              client: false\n\nSome more default formats are provided here:\n\n          haml: {}\n          ejs: {}\n          mustache: {}\n\n          markdown:\n            matches: ['**\/*.md', '**\/*.markdown']\n\n          template:\n            matches: '**\/*.tpl'\n\n## concatenators\n\nIf you need to use custom concatenation rules, you can define them here. This\ncan be set to an object which maps types of files to a plugin name. It can also\nbe set to an array if you need to use multiple concatenators. They will be\nstreamed through plugins in the order that they are provided.\n\nWhen a plugin isn't defined in the *concatenators* option for a specific type,\nGLP will set it to 'concat' as the default value. GLP will automatically prefix\nplugin names with *gulp-*, so you don't need to do that. So, the default\nconcatenator could be found in [NPM][npm] as [gulp-concat][gulpconcat]\n\nAs an example use case, some users might want to compile all of their scripts\nto [gulp-commonjs][gulpcommonjs] files and then pass the commonjs output to\n[gulp-concat][gulpconcat] afterward. That could be done simply by adding a new\nkey to *concatenators*, such as: `scripts: ['commonjs', 'concat']` followed by\ninstalling the necessary NPM plugins in your project directory.\n\n      concatenators: {}\n\n## extensions\n\n\n      extensions:\n        scripts: 'js'\n        stylesheets: 'css'\n        templates: 'html'\n\n## minifiers\n\nThe minifiers option tells GLP how to minify files with different file\nextensions. As an example, the default would use the [gulp-uglify][gulpuglify]\nplugin for *js* files, and the [gulp-minify-css][gulpminifycss] plugin for css\nfiles.\n\n      minifiers:\n        js: 'uglify'\n        css: 'minify-css'\n\n## files\n\nOptions for defining what types of files exist, where they are located, and\nwhere they are placed after they have finished being built. The default\nconfiguration will build many types of files from a directory called `src`,\nand place them into the **root** directory (the default root is *public* as\ndescribed above) after they have been built.\n\n      files:\n\nEach type of file that needs built is given a name. The names can be whatever\nyou like, and any number of named types can be created. For instance, the\nfollowing files are called *scripts*:\n\n        scripts:\n\nEach type is an object which maps a path to a list of files. If a path ends\nwith a slash, then the files will be copied into a **directory** containing\nan output file for every source file that was built. If the path does not\nend with a slash, then the  *concatenators* for this type will be used.\n\nIn this case, we are building all files ending with `.js`, `.coffee` and a few\nother extensions. After they are built, the resulting files will be placed in\nthe directory specified by the **root** function as separate files. If the\noutput file was not a **directory** (as denoted by the ending slash) then the\nfiles would also be concatenated and the resulting file would be given the\n*extension* which corresponds to this type of file.\n\n          '\/scripts\/': [\n            'src\/scripts\/**\/*.js'\n            'src\/scripts\/**\/*.coffee'\n            'src\/scripts\/**\/*.iced'\n            'src\/scripts\/**\/*.co'\n            'src\/scripts\/**\/*.ls'\n            'src\/scripts\/**\/*.ts'\n            'src\/scripts\/**\/*.hbs'\n            'src\/scripts\/**\/*.eco'\n            'src\/scripts\/**\/*.djs'\n            'src\/scripts\/**\/*.dust'\n            'src\/scripts\/**\/*.njs'\n            'src\/scripts\/**\/*.nunjucks'\n          ]\n\nHere, we are doing the same thing for *html*, *jade*, and some other file\nextensions. This time we are outputting them with the `templates` file type.\n\n        templates:\n          '\/': [\n            'src\/templates\/**\/*.html'\n            'src\/templates\/**\/*.jade'\n            'src\/templates\/**\/*.md'\n            'src\/templates\/**\/*.markdown'\n            'src\/templates\/**\/*.haml'\n            'src\/templates\/**\/*.ejs'\n            'src\/templates\/**\/*.mustache'\n            'src\/templates\/**\/*.tpl'\n          ]\n\nWe are doing the same thing here but using different files and associating\nthem to the *stylesheets* file type.\n\n        stylesheets:\n          '\/stylesheets\/': [\n            'src\/stylesheets\/**\/*.css'\n            'src\/stylesheets\/**\/*.less'\n            'src\/stylesheets\/**\/*.sass'\n            'src\/stylesheets\/**\/*.stylus'\n          ]\n\n## static\n\nGLP can optionally run a static server. If this is enabled, then the path\nspecified by the *root* option will be server on the provided static server\nport.\n\n      static:\n\nThe `static.enabled` function can be true or false. If it is true, then glp\nwill run it's static server. If false, then the server will not be run.\n\n        enabled: no\n\nThe `static.directories` option can be set to true if you want to server\ndirectory indexes, but defaults to false in order to prevent accidental\nexposure of file listenings.\n\n        directories: no\n\nThe `static.catchAll` option can be set to a string containing a filename. If\nset, then all URLs that don't have a static file ready on the server will be\nredirected to the given filename. This allows HTML5-style routing without\nneeding to define every possible route through GLP.\n\n        catchAll: null\n\nThe `static.port` option tells GLP what port to serve it's static server on. By\ndefault, the [local server][localserver] will be on port `3333`.\n\n        port: 3333\n\n**NOTE:** Remember that the *watch* option is separated from the *static*\noption, so that glp's static server isn't limited to only development\nenvironments.  If *watch* is set to false, then the server will not reflect\nyour changes until the next time you rebuild the files being served.\n\n## liveReload\n\nThe `liveReload` options allow you to change the way that your browser responds\nwhen files are changed.\n\n      liveReload:\n\nYou can enable or disable liveReload by setting the `liveReload.enabled` option\nto true, or disable it with a value of false.\n\n        enabled: no\n\nYou can set the `liveReload.port` to whichever port you want the `liveReload`\nserver to be listening on if the default value of 35729 is not sufficient.\n\n        port: 35729\n\nIf you have `liveReload.enabled` set to a truthy value, you're using the GLP\nstatic server, and you set `liveReload.inject` to a truthy value, then GLP will\nautomatically inject *livereload.js* into the app from within the static\nserver. This means that you don't need to change your templates or install any\nbrowser addons in order to get instant feedback of changes in your browser.\n\n        inject: yes\n\n## tasks\n\nEvery action in GLP is ran via a *task*. For instance, when you run `glp` you\nare actually running the *default* task. This can also be ran with the `glp\ndefault` command if you feel like typing extra. GLP allows you to define any\narbitrary task that you would like.\n\nAll tasks can optionally be set to a configuration object. When a configuration\noption is provided for a task *it will override* the previously defined\noptions. Some examples:\n\n      tasks:\n\nYou could define a task that is exactly the same as the default task by\nproviding no option overrides, for instance. This is how the default task\nis defined:\n\n        default: {}\n\nYou could also request GLP to watch all of your files by overriding the *watch*\noption and setting it to yes. This is how the `glp watch` command works:\n\n        watch:\n          watch: yes\n\nYou could extend this even further by watching files *and* running a static\nserver with liveReload enabled. Under the hood, this is how the `glp server`\ncommand works:\n\n        server:\n          watch: yes\n\n          static:\n            enabled: yes\n\n          liveReload:\n            enabled: yes\n\nMaybe you don't want to run any servers or watch any files, but you may still\nlike to make sure that a specific build process outputs it's files in a\ndifferent way. This is exactly how `glp release` works:\n\n        release:\n          minify:\n            enabled: yes\n\n          plugins:\n            coffee:\n              sourceMap: no\n\n            uglify:\n              outSourceMap: no\n\n            jade:\n              pretty: no\n\n\n[npm]: https:\/\/www.npmjs.org\/\n[gulpsrcopts]: https:\/\/github.com\/gulpjs\/gulp\/blob\/master\/docs\/API.md#gulpsrcglobs-options\n[gulpcoffee]: https:\/\/www.npmjs.org\/package\/gulp-coffee\n[gulpjade]: https:\/\/www.npmjs.org\/package\/gulp-jade\n[gulpstylus]: https:\/\/www.npmjs.org\/package\/gulp-stylus\n[gulpconcat]: https:\/\/github.com\/wearefractal\/gulp-concat\n[gulpuglify]: https:\/\/www.npmjs.org\/package\/gulp-uglify\n[gulpminifycss]: https:\/\/www.npmjs.org\/package\/gulp-minify-css\n[gulpcached]: https:\/\/www.npmjs.org\/package\/gulp-cached\n[localserver]: http:\/\/localhost:3333\/\n[lodashmerge]: http:\/\/lodash.com\/docs#merge\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f203ca37cf5444e1b664f939a5daff041a9653f8","subject":"Add missing single quotes","message":"Add missing single quotes\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_view.litcoffee","new_file":"docs\/14_view.litcoffee","new_contents":"# Batman.View\n\nFor a general explanation of `Batman.View`s and how they work, see [the\nguide](\/docs\/views.html).\n\n\n## ::constructor(options = {})\n\nA `View` is a `Batman.Object`, so any options you pass are mixed in. Use this\nto set `html`, `node`, `superview`, `parentNode` and\/or your custom data.\n\n    test 'constructor mixes in options', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.get('animal')\n\n\n## ::lookupKeypath(keypath) : Object\n\nTraverses up the view tree searching for the specified keypath, and returns the\nresult. This is equivalent to performing a `Batman.get` for each view above\n`this` in the tree, until a defined result is returned. The path it takes is as\nfollows:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\nIf there is no match, `undefined` is returned. However if used in an accessor\nor binding, the entire path to the root will be registered as a potential\nsource of the keypath. Consequently, if the keypath is later set on any part of\nthe chain, the data will be correctly bound.\n\n`lookupKeypath` is the function invoked to locate data when evaluating a\nbinding.\n\n    test 'lookupKeypath returns the value if defined on the view', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.lookupKeypath('animal')\n\n    test 'lookupKeypath returns the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'cat')\n      subview = new Batman.View(superview: superview)\n      equal 'cat', subview.lookupKeypath('animal')\n\n\n## ::setKeypath(keypath, value) : Object\n\nTraverses the View tree searching for the specified keypath, and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is the function invoked to set data when using an input binding.\n\n    test 'setKeypath sets the value if defined on the view', ->\n      view = new Batman.View(animal: 'dog')\n\n      view.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n    test 'setKeypath sets the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'dog')\n      subview = new Batman.View(superview: superview)\n\n      subview.setKeypath('animal', 'cat')\n      equal 'cat', superview.get('animal')\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', 'cat')\n      equal 'cat', view.get('animal')\n\n\n## ::%node : Node\n\nA reference to the DOM node that this view encapsulates. The entire tree\nbeneath this node is also the responsibility of this view and\/or its subviews.\n\nAccessing `node` will load and parse the template on demand if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n    test 'node parses bindings too', ->\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview.\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n\n## ::.superview : Batman.View\n\nA reference to the current superview (the direct ancestor in the tree). This is\nused for traversing the tree when searching for data, as in\n`View::lookupKeypath`.\n\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of a `View`. To manipulate the view tree, you should\noperate directly on this set \u2014 batman.js will automatically keep the DOM in\nsync with the logical tree.\n\n\n## ::subviews.add(view)\n\nAdding to a view's subview set will automatically update the tree, and parse\nthe template and bindings. If the superview is already in the DOM, this will\ninsert the current view's node into the DOM.\n\n\n## ::subviews.remove(view)\n\nRemoving from a view's subview set will automatically remove the subview from\nthe DOM.\n\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent, without killing it.\n\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n    test 'die kills the view', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.die()\n      equal true, view.isDead\n      equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n\n## ::propagateToSubviews(eventOrKey : string, value)\n\nIf value is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n\n","old_contents":"# Batman.View\n\nFor a general explanation of `Batman.View`s and how they work, see [the\nguide](\/docs\/views.html).\n\n\n## ::constructor(options = {})\n\nA `View` is a `Batman.Object`, so any options you pass are mixed in. Use this\nto set `html`, `node`, `superview`, `parentNode` and\/or your custom data.\n\n    test 'constructor mixes in options', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.get('animal')\n\n\n## ::lookupKeypath(keypath) : Object\n\nTraverses up the view tree searching for the specified keypath, and returns the\nresult. This is equivalent to performing a `Batman.get` for each view above\n`this` in the tree, until a defined result is returned. The path it takes is as\nfollows:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\nIf there is no match, `undefined` is returned. However if used in an accessor\nor binding, the entire path to the root will be registered as a potential\nsource of the keypath. Consequently, if the keypath is later set on any part of\nthe chain, the data will be correctly bound.\n\n`lookupKeypath` is the function invoked to locate data when evaluating a\nbinding.\n\n    test 'lookupKeypath returns the value if defined on the view', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.lookupKeypath('animal')\n\n    test 'lookupKeypath returns the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'cat')\n      subview = new Batman.View(superview: superview)\n      equal 'cat', subview.lookupKeypath('animal')\n\n\n## ::setKeypath(keypath, value) : Object\n\nTraverses the View tree searching for the specified keypath, and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is the function invoked to set data when using an input binding.\n\n    test 'setKeypath sets the value if defined on the view', ->\n      view = new Batman.View(animal: 'dog')\n\n      view.setKeypath('animal', cat)\n      equal 'cat', view.get('animal')\n\n    test 'setKeypath sets the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'dog')\n      subview = new Batman.View(superview: superview)\n\n      subview.setKeypath('animal', cat)\n      equal 'cat', superview.get('animal')\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', cat)\n      equal 'cat', view.get('animal')\n\n\n## ::%node : Node\n\nA reference to the DOM node that this view encapsulates. The entire tree\nbeneath this node is also the responsibility of this view and\/or its subviews.\n\nAccessing `node` will load and parse the template on demand if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n    test 'node parses bindings too', ->\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview.\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n\n## ::.superview : Batman.View\n\nA reference to the current superview (the direct ancestor in the tree). This is\nused for traversing the tree when searching for data, as in\n`View::lookupKeypath`.\n\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of a `View`. To manipulate the view tree, you should\noperate directly on this set \u2014 batman.js will automatically keep the DOM in\nsync with the logical tree.\n\n\n## ::subviews.add(view)\n\nAdding to a view's subview set will automatically update the tree, and parse\nthe template and bindings. If the superview is already in the DOM, this will\ninsert the current view's node into the DOM.\n\n\n## ::subviews.remove(view)\n\nRemoving from a view's subview set will automatically remove the subview from\nthe DOM.\n\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent, without killing it.\n\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n    test 'die kills the view', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.die()\n      equal true, view.isDead\n      equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n\n## ::propagateToSubviews(eventOrKey : string, value)\n\nIf value is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"88e2b9029d5730df516a6c0ab35567817ad09a72","subject":"sensible dialogue on not-logged-in","message":"sensible dialogue on not-logged-in\n","repos":"modweb\/pinki","old_file":"client\/router\/config.litcoffee","new_file":"client\/router\/config.litcoffee","new_contents":"# Iron-router configuration\n\n    Router.configure\n      layoutTemplate: 'layout'\n      loadingTemplate: 'loading'\n\n## Filters\n\n    filters =\n      isLoggedIn: ->\n        if not (Meteor.loggingIn() or Meteor.user())\n          Router.go 'atSignIn'\n          sweetAlert 'Whoa there!', 'You have to create an account before you can do that.', 'error'\n        this.next()\n\nLogin filter, except public routes\n\n    Router.onBeforeAction filters.isLoggedIn,\n      except: [\n        'home'\n        'about'\n        'atSignIn'\n        'atSignUp'\n        'atForgotPwd'\n        'atResetPwd'\n        'atVerifyEmail'\n        'atEnrollAccount'\n        'atChangePwd'\n      ]\n","old_contents":"# Iron-router configuration\n\n    Router.configure\n      layoutTemplate: 'layout'\n      loadingTemplate: 'loading'\n\n## Filters\n\n    filters =\n      isLoggedIn: ->\n        Router.go 'atSignIn' unless Meteor.loggingIn() or Meteor.user()\n        this.next()\n\nLogin filter, except public routes\n\n    Router.onBeforeAction filters.isLoggedIn,\n      except: [\n        'home'\n        'about'\n        'atSignIn'\n        'atSignUp'\n        'atForgotPwd'\n        'atResetPwd'\n        'atVerifyEmail'\n        'atEnrollAccount'\n        'atChangePwd'\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fc59191d512f52d31823719834494a98ff2569ee","subject":"Add a little more to the model docs","message":"Add a little more to the model docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    asyncTest \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::%dirtyKeys : Set\n\nThe set of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## @constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : Attributes is an empty object `{}` by default. This means the single-argument version accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7e63766c2ef80e7d75742b65eef0c6fb9fdbf0f1","subject":"Break into multiple lines to prevent overflow and broken highlighting","message":"Break into multiple lines to prevent overflow and broken highlighting\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a node's child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","old_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<span data-addclass-error=\"product.errors.length\">This product has <span data-bind=\"product.errors.length\"><\/span> errors.<\/button>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a node's child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\n## not(value) : boolean\n\n## matches(value, string) : boolean\n\n## truncate(value, length, end = '...') : string\n\n## default(value, defaultValue) : value\n\n## prepend(value, string) : string\n\n## append(value, string) : string\n\n## replace(value, searchString, replaceString[, flags]) : string\n\n## downcase(value) : string\n\n## upcase(value) : string\n\n## pluralize(value, count) : string\n\n## humanize(string) : string\n\n## join(value, separator = '') : string\n\n## sort(value) : value\n\n## map(iterable) : value\n\n## has(iterable, item) : boolean\n\n## first(iterable) : value\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\n## withArguments(function, curriedArguments...) : function\n\n## routeToAction(model, action) : string\n\n## escape(value) : string\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"464eabf640995a4daef3c6063767e764917a02cb","subject":"Use and parse return self","message":"Use and parse return self\n","repos":"laconalabs\/elliptical,lacona\/lacona","old_file":"src\/lacona.litcoffee","new_file":"src\/lacona.litcoffee","new_contents":"#Includes\n\n\t{EventEmitter} = require 'events'\n\tasync = require 'async'\n\tutil = require 'util'\n\t_ = require 'lodash'\n\n\tElementFactory = require '.\/element-factory'\n\tPhrase = require '.\/phrase'\n\tInputOption = require '.\/input-option'\n\n#Lacona\n\n\tclass Parser extends EventEmitter\n\t\tconstructor: (@options) ->\n\t\t\t@phrases = []\n\n\t\t\t@middleware = []\n\n\t\t\t@understand require('.\/plugins\/literal')\n\t\t\t@understand require('.\/plugins\/freetext')\n\t\t\t@understand require('.\/plugins\/integer')\n\t\t\t@understand require('.\/plugins\/date')\n\t\t\t@understand require('.\/plugins\/validator')\n\t\t\t@understand require('.\/plugins\/suggester')\n\t\t\t@understand require('.\/plugins\/list')\n\n\t\tphraseAccessor: (name) =>\n\t\t\t_.filter @phrases, (phrase) ->\n\t\t\t\tphrase.name is name or name in phrase.extends\n\n###`understand`\n\n`understand` takes a schema and scope, and defines a set of words for Lacona to understand\n\n\t\tunderstand: (options) ->\n\t\t\tscope = options.scope\n\t\t\tschema = if options.schema? then options.schema else options\n\t\t\tif not util.isArray(schema)\n\t\t\t\tschema = [schema]\n\t\t\tfor phrase in schema\n\t\t\t\telementFactory = new ElementFactory(scope, @)\n\t\t\t\t@phrases.push new Phrase(phrase, scope, elementFactory)\n\t\t\treturn @\n\n###`use`\n\n`use` defines middleware. It must be passed a function that accepts 2 arguments, an inputOption,\nand a callback that should be passed an error (or null) and a modulated inputOption. This will be passed\nto the `data` event (or the next middleware) rather than the inputOption itself.\n\n\t\tuse: (next) ->\n\t\t\t@middleware.push next\n\t\t\treturn @\n\n\t\tparse: (inputText) ->\n\t\t\tinput = new InputOption(inputText)\n\t\t\t\t\n\t\t\tasync.each _.filter(@phrases, (item) -> item.sentence), (phrase, done) =>\n\t\t\t\tphrase.parse input, null, (option) =>\n\t\t\t\t\tif option.text is ''\n\t\t\t\t\t\tasync.eachSeries @middleware, (call, done) =>\n\t\t\t\t\t\t\tcall option, done\n\t\t\t\t\t\t, (err) =>\n\t\t\t\t\t\t\treturn done(err) if err?\n\t\t\t\t\t\t\t@emit 'data', option\n\t\t\t\t, done\n\n\t\t\t, (err) =>\n\t\t\t\tif err?\n\t\t\t\t\t@emit 'error', err\n\t\t\t\telse\n\t\t\t\t\t@emit 'end'\n\t\t\treturn @\n\n\n\tconvertToHTML = (inputOption, done) ->\n\t\thtml = '<div class=\"option\">'\n\t\thtml += '<span class=\"match\">'\n\t\tfor match in inputOption.match\n\t\t\thtml += \"<span class='word #{match.partOfSpeech}'>#{match.string}<\/span>\"\n\t\thtml += '<\/span><span class=\"suggestion\">'\n\t\tfor suggestion in inputOption.suggestion.words\n\t\t\thtml += \"<span class='word #{suggestion.partOfSpeech}'>#{suggestion.string}<\/span>\"\n\t\thtml += '<\/span><span class=\"completion\">'\n\t\tfor completion in inputOption.completion\n\t\t\thtml += \"<span class='word #{completion.partOfSpeech}'>#{completion.string}<\/span>\"\n\t\thtml += '<\/span><\/div>'\n\n\t\tinputOption.html = html\n\t\tdone()\n\n\tmodule.exports =\n\t\tParser: Parser\n\t\tconvertToHTML: convertToHTML\n\n","old_contents":"#Includes\n\n\t{EventEmitter} = require 'events'\n\tasync = require 'async'\n\tutil = require 'util'\n\t_ = require 'lodash'\n\n\tElementFactory = require '.\/element-factory'\n\tPhrase = require '.\/phrase'\n\tInputOption = require '.\/input-option'\n\n#Lacona\n\n\tclass Parser extends EventEmitter\n\t\tconstructor: (@options) ->\n\t\t\t@phrases = []\n\n\t\t\t@middleware = []\n\n\t\t\t@understand require('.\/plugins\/literal')\n\t\t\t@understand require('.\/plugins\/freetext')\n\t\t\t@understand require('.\/plugins\/integer')\n\t\t\t@understand require('.\/plugins\/date')\n\t\t\t@understand require('.\/plugins\/validator')\n\t\t\t# @understand require('.\/plugins\/suggester')\n\t\t\t# @understand require('.\/plugins\/list')\n\n\t\tphraseAccessor: (name) =>\n\t\t\t_.filter @phrases, (phrase) ->\n\t\t\t\tphrase.name is name or name in phrase.extends\n\n###`understand`\n\n`understand` takes a schema and scope, and defines a set of words for Lacona to understand\n\n\t\tunderstand: (options) ->\n\t\t\tscope = options.scope\n\t\t\tschema = if options.schema? then options.schema else options\n\t\t\tif not util.isArray(schema)\n\t\t\t\tschema = [schema]\n\t\t\tfor phrase in schema\n\t\t\t\telementFactory = new ElementFactory(scope, @)\n\t\t\t\t@phrases.push new Phrase(phrase, scope, elementFactory)\n\t\t\treturn @\n\n###`use`\n\n`use` defines middleware. It must be passed a function that accepts 2 arguments, an inputOption,\nand a callback that should be passed an error (or null) and a modulated inputOption. This will be passed\nto the `data` event (or the next middleware) rather than the inputOption itself.\n\n\t\tuse: (next) ->\n\t\t\t@middleware.push next\n\n\t\tparse: (inputText) ->\n\t\t\tinput = new InputOption(inputText)\n\t\t\t\t\n\t\t\tasync.each _.filter(@phrases, (item) -> item.sentence), (phrase, done) =>\n\t\t\t\tphrase.parse input, null, (option) =>\n\t\t\t\t\tif option.text is ''\n\t\t\t\t\t\tasync.eachSeries @middleware, (call, done) =>\n\t\t\t\t\t\t\tcall option, done\n\t\t\t\t\t\t, (err) =>\n\t\t\t\t\t\t\treturn done(err) if err?\n\t\t\t\t\t\t\t@emit 'data', option\n\t\t\t\t, done\n\n\t\t\t, (err) =>\n\t\t\t\tif err?\n\t\t\t\t\t@emit 'error', err\n\t\t\t\telse\n\t\t\t\t\t@emit 'end'\n\n\n\tconvertToHTML = (inputOption, done) ->\n\t\thtml = '<div class=\"option\">'\n\t\thtml += '<span class=\"match\">'\n\t\tfor match in inputOption.match\n\t\t\thtml += \"<span class='word #{match.partOfSpeech}'>#{match.string}<\/span>\"\n\t\thtml += '<\/span><span class=\"suggestion\">'\n\t\tfor suggestion in inputOption.suggestion.words\n\t\t\thtml += \"<span class='word #{suggestion.partOfSpeech}'>#{suggestion.string}<\/span>\"\n\t\thtml += '<\/span><span class=\"completion\">'\n\t\tfor completion in inputOption.completion\n\t\t\thtml += \"<span class='word #{completion.partOfSpeech}'>#{completion.string}<\/span>\"\n\t\thtml += '<\/span><\/div>'\n\n\t\tinputOption.html = html\n\t\tdone()\n\n\tmodule.exports =\n\t\tParser: Parser\n\t\tconvertToHTML: convertToHTML\n\n","returncode":0,"stderr":"","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"5eb0121f068d70f7b97cf694357e9888c150f68a","subject":"added annotations","message":"added annotations\n","repos":"nhz-io\/cnl","old_file":"source\/lib\/component.litcoffee","new_file":"source\/lib\/component.litcoffee","new_contents":"# CLASS: Component\n* Extends: [Element][Element]\n\nAn interactive component.\n\n    Event = require '.\/event'\n    localizeEventCoordinates = require '..\/helper\/localize-event-coordinates'\n    module.exports = class Component extends require '.\/shape'\n\n## CONSTRUCTOR\n### new Component(args)\n* Returns: [Component][Component]\n\nCreate a Component instance\n\n      constructor: (args = {}) ->\n        super\n\nand register capturing and non-capturing validation listeners. Those will stop the\nevent propagation if the event **type** is not enabled.\n\n        for name in ['grab', 'release', 'drag']\n          do (name) =>\n            @addListener name, ((e) -> e.stop() unless @events?[name]), yes\n            @addListener name, ((e) -> e.stop() unless @events?[name]), no\n\nRegister capturing listeners. Those listeners can be extended in subclasses.\n\n        for name in ['grab', 'release', 'drag']\n          @addListener name, this[\"#{name}CaptureListener\"], yes\n\n---\n\n## METHODS\n### #mousemoveCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **mousemove** event passing throught this component\n\n      mousemoveCaptureListener: (event) ->\n        super\n        $ = @___runtime\n\nReset component state.\n\n        @state = null\n\nIf component is grabbed then set the state to **active**.\n\n        if $.grab\n          @state = 'active'\n\nCreate **drag** Event and broadcast it to this component if drag event is enabled,\n\n          if @events?.drag\n            @broadcastEvent $.dragEvent = new Event type:'drag',\n              x:event.x, y:event.y, target:this\n\nsetting the drag offset.\n\n              offsetX: event.x - ($.dragEvent?.x or $.grabEvent?.x or 0)\n              offsetY: event.y - ($.dragEvent?.y or $.grabEvent?.y or 0)\n\nOtherwise, set the state to the name of the first matching zone in order.\n\n        else if zones = event.zones\n          @state = (if zones.hover then 'hover' else if zones.normal then 'normal')\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **mouseup** event passing throught this component\n\n      mouseupCaptureListener: (event) ->\n        super\n        $ = @___runtime\n\nReset component state.\n\n        @state = null\n\nIf component is grabbed then release it\n\n        if $.grab\n          $.grab = false\n\nIf release event is enabled then create **release** Event, save it\nand deliver it to this component, \n\n          if @events?.release\n            @broadcastEvent $.releaseEvent = new Event type:'release',\n              x:event.x, y:event.y, target:this\n\nUpdate the **#state** to the first matching zone name in order\n\n        if zones = event.zones\n          @state = (if zones.hover then 'hover' else if zones.normal then 'normal')\n\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #mousedownListener(event)\n* Returns: [Component][Component]\n\nReceive **mousedown** event.\n\n      mousedownListener: (event) ->\n        super\n\nIf component is in active state and **grab** event is enabled then grab this component.\n\n        if (@state is 'active') and @events?.grab\n          ($ = @___runtime).grab = true\n\nCreate **grab** event and deliver it to this component.\n\n          @broadcastEvent $.grabEvent = new Event type:'grab',\n            x:event.x, y:event.y, target:this\n        return this\n\n#### PARAMETERS\n\n---\n\n### #dragCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **drag** events passing through this component\n\n      dragCaptureListener: (event) ->\n\nSave the event and localize event coordinates.\n\n        @___runtime.dragEvent = event\n        localizeEventCoordinates event, @origin\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #grabCaptureListener(event)\n* Returns: [Component][Component]\n\nCapture **grab** events passing through this component.\n\n      grabCaptureListener: (event) ->\n\nSave the event and localize event coordinates.\n\n        @___runtime.grabEvent = event\n        localizeEventCoordinates event, @origin\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n* Returns: [Component][Component]\n\nCapture **release** events passing through this component.\n\n      releaseCaptureListener: (event) ->\n\nSave the event and localize event coordinates.\n\n        @___runtime.releaseEvent = event\n        localizeEventCoordinates event, @origin\n        return this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n* Returns: [Component][Component]\n\n#### #dragListener(event)\n* Returns: [Component][Component]\n\n**drag** event receiver stub.\n\n      dragListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n\n### #grabListener(event)\n* Returns: [Component][Component]\n\n**grab** event receiver stub.\n\n      grabListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n\n---\n### #releaseListener(event)\n* Returns: [Component][Component]\n\n**release** event receiver stub.\n\n      releaseListener: -> this\n\n#### PARAMETERS\n**event**\n* Type: [Event][Event]\n","old_contents":"# CLASS: Component\n\n    Event = require '.\/event'\n    localizeEventCoordinates = require '..\/helper\/localize-event-coordinates'\n\n    module.exports = class Component extends require '.\/shape'\n      constructor: (args = {}) ->\n        super\n        for name in ['grab', 'release', 'drag']\n          do (name) =>\n            @addListener name, ((e) -> e.stop() unless @events?[name]), yes\n            @addListener name, ((e) -> e.stop() unless @events?[name]), no\n\n        for name in ['grab', 'release', 'drag']\n          @addListener name, this[\"#{name}CaptureListener\"], yes\n\n      mousemoveCaptureListener: (event) ->\n        super\n        if @___runtime.grab\n          @state =\n          if zones = event.zones\n            @state = (if zones.hover then 'hover' else if zones.normal then 'normal')\n\n      mouseupCaptureListener: (event) ->\n        super\n        ($ = @___runtime).grab = false\n\n        if $.grab\n          $.grab = false\n          @state = null\n          if @events?.release\n            @broadcastEvent $.releaseEvent = new Event type:'release',\n              x:event.x, y:event.y, target:this\n\n      mousemoveListener: (event) ->\n        super\n        $ = @___runtime\n        if $.grab\n          @state = 'active'\n          if @events?.drag\n            @broadcastEvent $.dragEvent = new Event type:'drag',\n              x:event.x, y:event.y, target:this\n              offsetX: event.x - ($.dragEvent?.x or $.grabEvent?.x or 0)\n              offsetY: event.y - ($.dragEvent?.y or $.grabEvent?.y or 0)\n        else\n          @state = null\n          if states = event.states\n            @state = (if states.hover then 'hover' else if states.normal then 'normal')\n\n        return this\n\n      mousedownListener: (event) ->\n        super\n        ($ = @___runtime).grab = true\n        if (@state is 'active') and @events?.grab\n          @broadcastEvent $.grabEvent = new Event type:'grab',\n            x:event.x, y:event.y, target:this\n        return this\n\n      mouseupListener: (event) ->\n        super\n        $ = @___runtime\n        @state = null\n        if zones = event.zones\n          @state = (if zones.hover then 'hover' else if zones.normal then 'normal')\n        if $.grab\n          $.grab = false\n          @state = null\n          if states = event.states\n            @state = (if states.hover then 'hover' else if states.normal then 'normal')\n\n          @broadcastEvent $.grabEvent = new Event type:'release',\n            x:event.x, y:event.y, target:this\n\n        return this\n\n      dragCaptureListener: (event) ->\n        @___runtime.dragEvent = event\n        localizeEventCoordinates event, @origin\n        return this\n\n      grabCaptureListener: (event) ->\n        @___runtime.grabEvent = event\n        localizeEventCoordinates event, @origin\n        return this\n\n      releaseCaptureListener: (event) ->\n        @___runtime.releaseEvent = event\n        localizeEventCoordinates event, @origin\n        return this\n\n      dragListener: -> this\n\n      grabListener: -> this\n\n      releaseListener: -> this\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"167b01de06e39717f6f4250f2106e2042a713b8f","subject":"update docs","message":"update docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/11_associations.litcoffee","new_file":"docs\/11_associations.litcoffee","new_contents":"# \/api\/App Components\/Batman.Model\/Batman.Model Associations\nbatman.js associations are modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). There are 3 types of assocations available on `Batman.Model`: [`hasMany`](\/docs\/api\/batman.model_associations.html#class_function_hasmany), [`belongsTo`](\/docs\/api\/batman.model_associations.html#class_function_belongsto), and [`hasOne`](\/docs\/api\/batman.model_associations.html#class_function_hasone). batman.js also supports polymorphic associations through the use of [polymorphic-specific options](\/docs\/api\/batman.model_associations.html#polymorphic_association_options).\n\nTo add associations to your models, declare them in your model definition. Association functions take a label (string) and options (Object). The label names the association and is used to provide smart defaults for several options. All available options are [detailed below](\/docs\/api\/batman.model_associations.html#association_options).\n\nFor example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', inverseOf: 'parentItem', encoderKey: 'children'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItem'\n```\n\nThen, associated records will be available via accessors:\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n\n  child.set('parentItem', parent)\n  child.get('parentItem') # => parent\n```\n\nor,\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n  secondChild = new App.ChildItem\n  parent.get('childItems').add(child)\n  parent.get('childItems').add(secondChild)\n  parent.get('childItems') # => Batman.AssociationSet\n  parent.get('childItems.length') # => 2\n```\n\n## @hasMany(label : string [, options : Object])\n`hasMany` expresses a one-to-many relationship on a `Batman.Model`.\n\n## @hasOne(label : string [, options : Object])\n`hasOne` expresses a one-to-one relationship on a `Batman.Model` when this model contains the primary key (eg, `id`) and does not contain the foreign key. If this model contains the foreign key, use `belongsTo` instead.\n\n## @belongsTo(label : string [, options : Object])\n`belongsTo` expresses a one-to-one relationship on a `Batman.Model` when this model contains the foreign key (eg, `parent_id`). If the other model contains the foreign key, use `hasOne` instead. It often expresses inverse of a `hasMany` or `hasOne` association. You can declare this with the `inverseOf` option (see [options](\/docs\/api\/batman.model_associations.html#association_options) below) so that both sides of the association are loaded from JSON.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.AssociationSet` or `Batman.Model`. Generally they will return a `Batman.AssocationProxy` named after the association type, such as `Batman.BelongsToAssociationProxy` or `Batman.HasOneAssociationProxy`.\n\n\n## ::load(callback : Function)\nCalled to load the associated record from storage, setting it as  [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target). If a callback is passed, it is called with two arguments: any error and the loaded record. Also, when this function finishes, it sets [`loaded`](\/docs\/api\/batman.model_associations.html#prototype_accessor_loaded) to `true` and fires `loaded` on the record.\n\n## ::toJSON() : Object\nReturns a [stringifiable JavaScript object](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/JSON\/stringify#toJSON_behavior) for the target record, if the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) is present.\n\n## ::%target\nThe associated record. Getting `target` does not implicitly call `load` on the association.\n\n## ::%loaded\n`true` or `false`, whether or not the record has been loaded from storage.\n\n## ::fetchFromLocal()\nThis method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). If this method returns a falsy value, then [`fetchFromRemote`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromremote) is called.  `Batman.AssocationProxy` subclasses must implement this method.\n\n## ::fetchFromRemote([callback : Function])\nIf [`fetchFromLocal`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromlocal) returns a falsy value, this method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). The `callback` is called with two arguments: any error and the fetched record(s). `Batman.AssocationProxy` subclasses must implement this method.\n\n## Association Options\n\n##### `primaryKey[= \"id\"] : string`\nThe primary key for the association.\n\n##### `foreignKey[= \"#{label}_id\"] : string`\nThe foreign key for the association.\n\n##### `saveInline[= false] : boolean`\nIf true, this model's attributes will be included in the associated model's JSON. This means that when an associated record is saved, this record's attributes will be included in the JSON.  (An alternative might be to include the associations' primary keys in the model's JSON with an [encoder](\/docs\/api\/batman.model.html#class_function_encode).)\n\n##### `autoload[= true] : boolean`\nIf `true`, batman.js will automatically call `load` when the associated records are accessed. This is useful in view bindings, where binding to the associated records will automatically cause them to be loaded.\n\n##### `nestUrl[= false] : boolean`\nIf `true`, this model's URL will be nested under the associated model:\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', nestUrl: true\n\n# ...\n\nchild = new ChildItem(parent_id: 1, id: 5)\nchild.url() # => 'parent_items\/1\/child_items\/5'\n```\n\n`nestUrl` only applies if the model is persisted with `Batman.RestStorage` (or a subclass).\n\n##### `name : string`\nBy default, batman.js checks for a model with the singular, camel-case name of association's `label` attached to `Batman.currentApp`. If the associated model's name is different from that, use `name` to specify it.\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem' # automatically finds App.ParentItem\n  @belongsTo 'alternativeParentItem', name: 'ParentItem' # also finds App.ParentItem\n```\n\n##### `inverseOf : string`\nThe foreign association to set on load. If the associated model has an association with the same name as the `inverseOf` value, it will be populated when data is loaded from storage. For example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true, inverseOf: 'parentItem'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItems'\n```\n\nwould allow:\n\n```coffeescript\nApp.ParentItem.find 1, (err, parent) ->\n  children = parent.get('childItems')\n  children.get('first.parentItem') == parent # => true\n\nApp.ChildItem.find 5, (err, childItem) ->\n  childItem.get('parentItem').load (err, parent) ->\n    parent.get('childItems').has(childItem) # => true\n```\n\n##### `encoderKey[= label] : string`\nKey that represents this association's records when in serialized form. For example,\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', encoderKey: 'children'\n```\n\nwill correctly decode this JSON:\n\n```javascript\n{id: 1, children: [{ id: 5, parent_id: 1 }, {id: 6, parent_id: 1}]}\n```\n\nIt will also encode the `childItems` as `children` (unless `saveInline` is set to `false`).\n\n##### `namespace[= Batman.currentApp] : string`\nbatman.js expects to find a model with the given `name` on `Batman.currentApp`. If your model is defined elsewhere, use `namespace` to specify where the model is defined.\n\n```coffeescript\nclass App.Admin.Person extends Batman.Model\n  @belongsTo 'organization', namespace: App.Admin # finds App.Admin.Organization instead of App.Organization\n```\n\n## Polymorphic Association Options\nbatman.js also supports [polymorphic associations](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations). For example:\n\n```coffeescript\nclass App.Superpower extends Batman.Model\n  @encode 'name'\n  @belongsTo 'superpowerable', polymorphic: true\n\nclass App.Hero extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n\nclass App.Villain extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n```\nBy default, attributes of the polymorphic association will be encoded according to the label. So, `hero.toJSON()` might return:\n\n```javascript\n{ id: 1,\n  name: 'Superman',\n  superpowers: [\n    {id: 15, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Super Strength'},\n    {id: 16, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Invincibility'},\n  ]\n}\n```\n\n##### `polymorphic[= false] : boolean`\nSet to `true` when the association is [polymorphic](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations).\n\n##### `as : string`\nSpecifies the name of the polymorphic interface.\n\n##### `foreignTypeKey[= \"#{label}_type\"] : string`\nSpecifies the field which contains the `type` for a polymorphic record.\n\n##### `encodeForeignTypeKey[=true] : boolean`\nSet to `true` when the `foreignTypeKey` should be included in the JSON of the record.\n","old_contents":"# \/api\/App Components\/Batman.Model\/Batman.Model Associations\nbatman.js associations are modeled after [ActiveRecord Associations](http:\/\/api.rubyonrails.org\/classes\/ActiveRecord\/Associations\/ClassMethods.html). There are 3 types of assocations available on `Batman.Model`: [`hasMany`](\/docs\/api\/batman.model_associations.html#class_function_hasmany), [`belongsTo`](\/docs\/api\/batman.model_associations.html#class_function_belongsto), and [`hasOne`](\/docs\/api\/batman.model_associations.html#class_function_hasone). batman.js also supports polymorphic associations through the use of [polymorphic-specific options](\/docs\/api\/batman.model_associations.html#polymorphic_association_options).\n\nTo add associations to your models, declare them in your model definition. Association functions take a label (string) and options (Object). The label names the association and is used to provide smart defaults for several options. All available options are [detailed below](\/docs\/api\/batman.model_associations.html#association_options).\n\nFor example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', inverseOf: 'parentItem', encoderKey: 'children'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItem'\n```\n\nThen, associated records will be available via accessors:\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n\n  child.set('parentItem', parent)\n  child.get('parentItem') # => parent\n```\n\nor,\n\n```coffeescript\n  parent = new App.ParentItem\n  child = new App.ChildItem\n  secondChild = new App.ChildItem\n  parent.get('childItems').add(child)\n  parent.get('childItems').add(secondChild)\n  parent.get('childItems') # => Batman.AssociationSet\n  parent.get('childItems.length') # => 2\n```\n\n## @hasMany(label : string [, options : Object])\n`hasMany` expresses a one-to-many relationship on a `Batman.Model`.\n\n## @hasOne(label : string [, options : Object])\n`hasOne` expresses a one-to-one relationship on a `Batman.Model` when this model contains the primary key (eg, `id`) and does not contain the foreign key. If this model contains the foreign key, use `belongsTo` instead.\n\n## @belongsTo(label : string [, options : Object])\n`belongsTo` expresses a one-to-one relationship on a `Batman.Model` when this model contains the foreign key (eg, `parent_id`). If the other model contains the foreign key, use `hasOne` instead. It often expresses inverse of a `hasMany` or `hasOne` association. You can declare this with the `inverseOf` option (see [options](\/docs\/api\/batman.model_associations.html#association_options) below) so that both sides of the association are loaded from JSON.\n\n## Batman.AssocationProxy\n\nAssociation accessors won't always return a `Batman.AssociationSet` or `Batman.Model`. Generally they will return a `Batman.AssocationProxy` named after the association type, such as `Batman.BelongsToAssociationProxy` or `Batman.HasOneAssociationProxy`.\n\n\n## ::load(callback : Function)\nCalled to load the associated record from storage, setting it as  [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target). If a callback is passed, it is called with two arguments: any error and the loaded record. Also, when this function finishes, it sets [`loaded`](\/docs\/api\/batman.model_associations.html#prototype_accessor_loaded) to `true` and fires `loaded` on the record.\n\n## ::toJSON() : Object\nReturns a [stringifiable JavaScript object](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/JSON\/stringify#toJSON_behavior) for the target record, if the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) is present.\n\n## ::%target\nThe associated record. Getting `target` does not implicitly call `load` on the association.\n\n## ::%loaded\n`true` or `false`, whether or not the record has been loaded from storage.\n\n## ::fetchFromLocal()\nThis method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). If this method returns a falsy value, then [`fetchFromRemote`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromremote) is called.  `Batman.AssocationProxy` subclasses must implement this method.\n\n## ::fetchFromRemote([callback : Function])\nIf [`fetchFromLocal`](\/docs\/api\/batman.model_associations.html#prototype_function_fetchfromlocal) returns a falsy value, this method is called by [`load`](\/docs\/api\/batman.model_associations.html#prototype_function_load) to fetch the [`target`](\/docs\/api\/batman.model_associations.html#prototype_accessor_target) record(s). The `callback` is called with two arguments: any error and the fetched record(s). `Batman.AssocationProxy` subclasses must implement this method.\n\n## Association Options\n\n##### `primaryKey[= \"id\"] : string`\nThe primary key for the association.\n\n##### `foreignKey[= \"#{label}_id\"] : string`\nThe foreign key for the association.\n\n##### `saveInline[= true] : boolean`\nIf true, this model's attributes will be included in the associated model's JSON. This means that when an associated record is saved, this record's attributes will be included in the JSON.  (An alternative might be to include the associations' primary keys in the model's JSON with an [encoder](\/docs\/api\/batman.model.html#class_function_encode).)\n\n##### `autoload[= true] : boolean`\nIf `true`, batman.js will automatically call `load` when the associated records are accessed. This is useful in view bindings, where binding to the associated records will automatically cause them to be loaded.\n\n##### `nestUrl[= false] : boolean`\nIf `true`, this model's URL will be nested under the associated model:\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', nestUrl: true\n\n# ...\n\nchild = new ChildItem(parent_id: 1, id: 5)\nchild.url() # => 'parent_items\/1\/child_items\/5'\n```\n\n`nestUrl` only applies if the model is persisted with `Batman.RestStorage` (or a subclass).\n\n##### `name : string`\nBy default, batman.js checks for a model with the singular, camel-case name of association's `label` attached to `Batman.currentApp`. If the associated model's name is different from that, use `name` to specify it.\n\n```coffeescript\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem' # automatically finds App.ParentItem\n  @belongsTo 'alternativeParentItem', name: 'ParentItem' # also finds App.ParentItem\n```\n\n##### `inverseOf : string`\nThe foreign association to set on load. If the associated model has an association with the same name as the `inverseOf` value, it will be populated when data is loaded from storage. For example:\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', saveInline: true, inverseOf: 'parentItem'\n\nclass App.ChildItem extends Batman.Model\n  @belongsTo 'parentItem', inverseOf: 'childItems'\n```\n\nwould allow:\n\n```coffeescript\nApp.ParentItem.find 1, (err, parent) ->\n  children = parent.get('childItems')\n  children.get('first.parentItem') == parent # => true\n\nApp.ChildItem.find 5, (err, childItem) ->\n  childItem.get('parentItem').load (err, parent) ->\n    parent.get('childItems').has(childItem) # => true\n```\n\n##### `encoderKey[= label] : string`\nKey that represents this association's records when in serialized form. For example,\n\n```coffeescript\nclass App.ParentItem extends Batman.Model\n  @hasMany 'childItems', encoderKey: 'children'\n```\n\nwill correctly decode this JSON:\n\n```javascript\n{id: 1, children: [{ id: 5, parent_id: 1 }, {id: 6, parent_id: 1}]}\n```\n\nIt will also encode the `childItems` as `children` (unless `saveInline` is set to `false`).\n\n##### `namespace[= Batman.currentApp] : string`\nbatman.js expects to find a model with the given `name` on `Batman.currentApp`. If your model is defined elsewhere, use `namespace` to specify where the model is defined.\n\n```coffeescript\nclass App.Admin.Person extends Batman.Model\n  @belongsTo 'organization', namespace: App.Admin # finds App.Admin.Organization instead of App.Organization\n```\n\n## Polymorphic Association Options\nbatman.js also supports [polymorphic associations](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations). For example:\n\n```coffeescript\nclass App.Superpower extends Batman.Model\n  @encode 'name'\n  @belongsTo 'superpowerable', polymorphic: true\n\nclass App.Hero extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n\nclass App.Villain extends Batman.Model\n  @hasMany 'superpowers', as: 'superpowerable', polymorphic: true\n```\nBy default, attributes of the polymorphic association will be encoded according to the label. So, `hero.toJSON()` might return:\n\n```javascript\n{ id: 1,\n  name: 'Superman',\n  superpowers: [\n    {id: 15, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Super Strength'},\n    {id: 16, superpowerable_id: 1, superpowerable_type: 'hero', name: 'Invincibility'},\n  ]\n}\n```\n\n##### `polymorphic[= false] : boolean`\nSet to `true` when the association is [polymorphic](http:\/\/guides.rubyonrails.org\/association_basics.html#polymorphic-associations).\n\n##### `as : string`\nSpecifies the name of the polymorphic interface.\n\n##### `foreignTypeKey[= \"#{label}_type\"] : string`\nSpecifies the field which contains the `type` for a polymorphic record.\n\n##### `encodeForeignTypeKey[=true] : boolean`\nSet to `true` when the `foreignTypeKey` should be included in the JSON of the record.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cfbb255f0eaa39b78dcb53902cb8d06f5884023c","subject":"Move font config into renderer","message":"Move font config into renderer\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_step_count.litcoffee","new_file":"lib\/render-pipelines\/png\/png_step_count.litcoffee","new_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngStepCount extends PngRenderer\n\n      do_render: (path) =>\n        ctx    = PngRenderer.ctx\n        width  = @config.width\n        height = @config.height\n\n        for step, i in path\n          ctx.font      = \"#{Math.floor height * 0.25}pt Arial\"\n          ctx.textAlign = @config.step_count.text_align\n          ctx.fillStyle = @config.step_count.text_color\n\n          x = (width  * 0.5) + (width  * step.col)\n          y = (height * 0.5) + (height * step.row)\n\n          ctx.beginPath()\n          ctx.fillText i, x, y\n\n    module.exports = PngStepCount\n","old_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngStepCount extends PngRenderer\n\n      do_render: (path) =>\n        ctx    = PngRenderer.ctx\n        width  = @config.width\n        height = @config.height\n\n        for step, i in path\n          ctx.font      = @config.step_count.text_font height\n          ctx.textAlign = @config.step_count.text_align\n          ctx.fillStyle = @config.step_count.text_color\n\n          x = (width  * 0.5) + (width  * step.col)\n          y = (height * 0.5) + (height * step.row)\n\n          ctx.beginPath()\n          ctx.fillText i, x, y\n\n    module.exports = PngStepCount\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"834d4cdf843342c73750b5adc50e4be8d1ac3367","subject":"added localizer to capturing listeners","message":"added localizer to capturing listeners\n","repos":"nhz-io\/cnl","old_file":"source\/element.litcoffee","new_file":"source\/element.litcoffee","new_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\nA visual element.\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element()\n\nCreates an Element instance.\n\n      constructor: ->\n        super\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nAdd capturing extendable listener\n          \n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n          \n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## METHODS\n### #localizeEventCoordinates(event) ->\n* Returns: [Element][Element]\n\nHelper method, to localize event coordinates.\n    \n      localizeEventCoordinates: (event) ->\n        if event\n\nIf event already has localized **x**, use it instead of absolute **x**\n\n          x = (if event.localX? then event.localX else event.x)                  \n          event.localX = x - (@origin?.x or 0)\n\nIf event already has localized **y**, use it instead of absolute **y**\n          \n          y = (if event.localY? then event.localY else event.y)\n          event.localY = y - (origin?.y or 0)\n\n        return this\n---\n\n### #getEventRegions(event)\n* Returns: [Object][Object] - named set of matching regions\n\nHelper method, to get element regions that match the event.\n      \n      getEventRegions: (event) ->\n\nProceed only if event coordinates are localized\n\n        if event and (x = event.localX)? and (y = event.localY)?          \n          result = {}\n\nWalk through the element regions\n\n          for name, $ of @regions\n\nand add the region to the result if event localized coordinates are within\nthe region rectangle.\n\n            if $[0] <= x <= ($[0] + $[2]) and $[1] <= y <= ($[1] + $[3])\n              result[name] = $\n\n        return result\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousemove** listener\n    \n      mousemoveCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousemoveEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousedown** listener\n\n      mousedownCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n\n        @___runtime.mousedownEvent = event\n        @localizeEventCoordinates event\n\n        return this\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mouseup** listener\n      \n      mouseupCaptureListener: (event) ->\n\nStore the event in the runtime for later and localize event coordinates\n        \n        @___runtime.mouseupEvent = event\n        @localizeEventCoordinates event\n        \n        return this\n\n---\n\n### #mousemoveListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mousemoveListener: -> this\n\n---\n\n### #mousedownListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mousedownListener: -> this\n\n---\n\n### #mouseupListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mouseupListener: -> this\n\n\n[Element]: .\/element\n\n[Parent]: .\/index.litcoffee\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n","old_contents":"# CLASS: Element\n* Extends: [Evented][Evented]\n* Parent: [Index][Parent]\n\nA visual element.\n\n---\n\n    module.exports = class Element extends require 'ecl\/dist\/evented'\n\n## CONSTRUCTOR\n\n### new Element()\n\nCreates an Element instance.\n\n      constructor: ->\n        super\n\nRegister validating listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nLocalize the **type** variable.\n\n          do (type) =>\n\nAdd capturing listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:yes, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nAdd normal listener which will cancel and stop the event\nif the event type is not enabled.\n\n            @addListener type:type, capture:no, listener: (event) ->\n              event.cancel().stop() unless @events?[type]\n\nRegister extendable listeners for each **type** from the list.\n\n        for type in ['mousemove', 'mousedown', 'mouseup']\n\nAdd capturing extendable listener\n          \n          @addListener type, this[\"#{type}CaptureListener\"], yes\n\nAdd normal extendable listener\n          \n          @addListener type, this[\"#{type}Listener\"], no\n\n#### PARAMETERS\n* **args** - named arguments\n\n---\n\n## PROPERTIES\n\n---\n\n## METHODS\n### #localizeEventCoordinates(event) ->\n* Returns: [Element][Element]\n\nHelper method, to localize event coordinates.\n    \n      localizeEventCoordinates: (event) ->\n        if event\n\nIf event already has localized **x**, use it instead of absolute **x**\n\n          x = (if event.localX? then event.localX else event.x)                  \n          event.localX = x - (@origin?.x or 0)\n\nIf event already has localized **y**, use it instead of absolute **y**\n          \n          y = (if event.localY? then event.localY else event.y)\n          event.localY = y - (origin?.y or 0)\n\n        return this\n---\n\n### #getEventRegions(event)\n* Returns: [Object][Object] - named set of matching regions\n\nHelper method, to get element regions that match the event.\n      \n      getEventRegions: (event) ->\n\nProceed only if event coordinates are localized\n\n        if event and (x = event.localX)? and (y = event.localY)?          \n          result = {}\n\nWalk through the element regions\n\n          for name, $ of @regions\n\nand add the region to the result if event localized coordinates are within\nthe region rectangle.\n\n            if $[0] <= x <= ($[0] + $[2]) and $[1] <= y <= ($[1] + $[3])\n              result[name] = $\n              \n        return result\n\n---\n\n## LISTENERS\n### #mousemoveCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousemove** listener\n    \n      mousemoveCaptureListener: (event) ->\n\nStore the event in the runtime for later\n\n        @___runtime.mousemoveEvent = event\n        return this\n\n---\n\n### #mousedownCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mousedown** listener\n\n      mousedownCaptureListener: (event) ->\n\nStore the event in the runtime for later\n\n        @___runtime.mousedownEvent = event\n        return this\n\n---\n\n### #mouseupCaptureListener(event)\n* Returns: [Element][Element]\n\nExtendable capturing **mouseup** listener\n      \n      mouseupCaptureListener: (event) ->\n\nStore the event in the runtime for later\n        \n        @___runtime.mouseupEvent = event\n        return this\n\n---\n\n### #mousemoveListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mousemoveListener: -> this\n\n---\n\n### #mousedownListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mousedownListener: -> this\n\n---\n\n### #mouseupListener(event)\n* Returns: [Element][Element]\n\nExtendable **mousemove** listener\n      \n      mouseupListener: -> this\n\n\n[Element]: .\/element\n\n[Parent]: .\/index.litcoffee\n[Evented]: https:\/\/nhzio.github.com\/ecl\/evented.html\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"003019f952b30f5a43190766817c91184e8cbec7","subject":"- Clean-up of WrappedModule","message":"- Clean-up of WrappedModule\n","repos":"WillemDeGroef\/nodesentry","old_file":"src\/module.litcoffee","new_file":"src\/module.litcoffee","new_contents":"    vm = require \"vm\"\n    path = require \"path\"\n    _ = require \"underscore\"\n    Membrane = require \".\/membrane\"\n\n    class WrappedModule\n\n        constructor: (@libName, @modulePaths, @policyObj) ->\n            @modModule = (require \"module\")\n            @fileName = @modModule._findPath @libName, @modulePaths\n            @requestLib = @fileName || @libName\n            @builtIn = @requestLib.indexOf(\".js\") == -1\n            @pathName = path.dirname @fileName\n\n        load: (requireFunc = @membranedRequire) ->\n            throw new Error \"`require` must be a function\" if typeof requireFunc != \"function\"\n            module.paths = [@pathName].concat(@modModule._nodeModulePaths(@pathName))\n\n            if @builtIn\n                r = require @requestLib\n            else\n                wrappedMod = new @modModule(@libName, this)\n                wrappedMod.require = requireFunc\n                wrappedMod.load @requestLib\n                r = wrappedMod.exports\n\n\nReturn a membraned variant of the public API interface.\n\n            return r if not @policyObj\n            return new Membrane(r, @policyObj, @requestLib) if (typeof r) == \"function\"\n            return @wrapObjectWithMembrane(@requestLib.replace(\".js\",\"\"), r)\n\n\n        membranedRequire: (libName) =>\n            mod = new WrappedModule libName, module.paths, @policyObj\n            \n            return require(libName) if mod.builtIn or not @policyObj?.wrapWithMembrane?(libName)\n\nLets load the new `Module` for the requested library.\n\n            return mod.load()\n\nThe last step is to create a wrapper function that will carefully wrap each\nexported API call within a membrane.\n\n            @wrapObjectWithMembrane(libName, libexports)\n\n        wrapObjectWithMembrane: (libName, obj) ->\n            _.object(_.map obj, @buildMembraneWrapper libName)\n\n        buildMembraneWrapper: (libName) =>\n            (propObj, propName) => [propName, new Membrane(propObj, @policyObj, \"#{libName}.#{propName}\")]\n\n    module.exports = WrappedModule\n","old_contents":"    vm = require \"vm\"\n    path = require \"path\"\n    _ = require \"underscore\"\n    Membrane = require \".\/membrane\"\n    Require = require\n\n\n    class WrappedModule\n\n        constructor: (@libName, @modulePaths, @policyObj) ->\n            @modModule = (require \"module\")\n            @module = new  @modModule(@libName, this)\n            @fileName = @modModule._findPath @libName, @modulePaths\n            @pathName = path.dirname @fileName\n\n        load: (requireFunc = @membranedRequire) ->\n            throw new Error \"`require` must be a function\" if typeof requireFunc != \"function\"\n            module.paths = [@pathName].concat(@modModule._nodeModulePaths(@pathName))\n            @module.require = requireFunc\n            @module.load @fileName\n            r = @module.exports\n\n\nReturn a membraned variant of the public API interface.\n\n            return r if not @policyObj\n            return new Membrane(r, @policyObj, r.toString()) if (typeof r) == \"function\"\n            return @wrapObjectWithMembrane(@fileName.replace(\".js\",\"\"), r) if (typeof r) == \"object\"\n            throw new Error \"unimplemented case in #{__filename}\"\n\n\n        membranedRequire: (libName) =>\n            mod = new WrappedModule libName, module.paths, @policyObj\n            if not mod.fileName or @policyObj?.skip?(libName)\n                libexports = Require libName\n            else\n\nLets load the new `Module` for the requested library.\n\n                libexports = mod.load @membranedRequire\n\nIf the library is only used within the (outer) membrane, i.e., it is not\nreferenced in the policy, we return immediately.\n\n            return libexports unless @policyObj?.mustWrap?(libName)\n\nThe last step is to create a wrapper function that will carefully wrap each\nexported API call within a membrane.\n\n            @wrapObjectWithMembrane(libName, libexports)\n\n        wrapObjectWithMembrane: (libName, obj) ->\n            _.object(_.map obj, @buildMembraneWrapper libName)\n\n        buildMembraneWrapper: (libName) =>\n            (propObj, propName) => [propName, new Membrane(propObj, @policyObj, \"#{libName}.#{propName}\")]\n\n    module.exports = WrappedModule\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d9f3e4fdf3524aad1971d1896c1dd43ddc060515","subject":"releaseCaptureListener is ready","message":"releaseCaptureListener is ready\n","repos":"nhz-io\/cnl","old_file":"source\/test\/component.litcoffee","new_file":"source\/test\/component.litcoffee","new_contents":"# TEST CLASS: Component\n* Parent: [Index][Parent]\n\n---\n\n    should = require 'should'\n    module.exports = (Component, name='Component') ->\n\n## CONSTRUCTOR\n\n      describe name, ->\n        it 'should be a class', -> Component.should.be.a.class\n\n        describe '#constructor(args)', ->\n          it 'should return an instance of Component', ->\n            (new Component).should.be.an.instanceof Component\n\n---\n\n## LISTENERS\n\nMousemove capturing listener\n\n      describe '#mousemoveCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .mousemoveCaptureListener()\n            .should.be.equal component\n\n        it 'should set the state to active if component is grabbed', ->\n          component = new Component\n          component.___runtime.grab = true\n          component.state = null\n          component.mousemoveCaptureListener({})\n          component.state.should.be.equal 'active'\n\n        it 'should broadcast drag event with drag offset', (done) ->\n          component = new Component events:drag:true\n          component.___runtime.grab = true\n          component.___runtime.grabEvent = x:10, y:10\n          component.broadcastEvent = (event) ->\n            event.offsetX.should.be.equal 10\n            event.offsetY.should.be.equal 5\n            done()\n          component.mousemoveCaptureListener x:20, y:15\n\n        it 'should broadcast drag event with drag offset using previous drag', (done) ->\n          component = new Component events:drag:true\n          component.___runtime.grab = true\n          component.___runtime.dragEvent = x:10, y:10\n          component.broadcastEvent = (event) ->\n            event.offsetX.should.be.equal 10\n            event.offsetY.should.be.equal 5\n            done()\n          component.mousemoveCaptureListener x:20, y:15\n\n        it 'should set the component state to hover', ->\n          component = new Component\n            origin  : x:0, y:0\n            regions : hover: [0,0,1,1]\n          component.mousemoveCaptureListener x:0.5, y:0.5\n          component.state.should.be.equal 'hover'\n\n        it 'should set the component state to hover', ->\n          component = new Component\n            origin  : x:0, y:0\n            regions : normal: [0,0,1,1]\n          component.mousemoveCaptureListener x:0.5, y:0.5\n          component.state.should.be.equal 'normal'\n\n        it 'should set the component state to hover preceeding normal', ->\n          component = new Component\n            origin  : x:0, y:0\n            regions : normal: [0,0,1,1], hover: [0,0,1,1]\n          component.mousemoveCaptureListener x:0.5, y:0.5\n          component.state.should.be.equal 'hover'\n\nDrag capturing listener\n\n      describe '#dragCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .mousemoveCaptureListener()\n            .should.be.equal component\n\n        it 'should save the event in #___runtime', ->\n          (component = new Component)\n            .dragCaptureListener 'test'\n            .___runtime.dragEvent.should.be.equal 'test'\n\n        it 'should localize the event coordinates', ->\n          (component = new Component origin: x:10, y:25)\n            .dragCaptureListener (event = x:20, y:30)\n\n          event.localX.should.be.equal 10\n          event.localY.should.be.equal 5\n\nGrab capturing listener\n\n      describe '#grabCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .grabCaptureListener()\n            .should.be.equal component\n\n        it 'should save the event in #___runtime', ->\n          (component = new Component)\n            .grabCaptureListener 'test'\n            .___runtime.grabEvent.should.be.equal 'test'\n\n        it 'should localize the event coordinates', ->\n          (component = new Component origin: x:10, y:25)\n            .grabCaptureListener (event = x:20, y:30)\n\n          event.localX.should.be.equal 10\n          event.localY.should.be.equal 5\n\nRelease capturing listener\n\n      describe '#releaseCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .releaseCaptureListener()\n            .should.be.equal component\n\n        it 'should save the event in #___runtime', ->\n          (component = new Component)\n            .releaseCaptureListener 'test'\n            .___runtime.releaseEvent.should.be.equal 'test'\n\n        it 'should localize the event coordinates', ->\n          (component = new Component origin: x:10, y:25)\n            .releaseCaptureListener (event = x:20, y:30)\n\n          event.localX.should.be.equal 10\n          event.localY.should.be.equal 5\n\nMousedown listener\n\n      describe '#mousedownListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .mousedownListener()\n            .should.be.equal component\n\n        it 'should set grab flag in #___runtime', ->\n          (component = new Component state:'active', events:grab:true)\n            .mousedownListener {}\n            .___runtime.grab.should.be.true\n\nDrag listener\n      \n      describe '#dragListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .dragListener()\n            .should.be.equal component\n\nGrab listener\n\n      describe '#grabListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .grabListener()\n            .should.be.equal component\n\nRelease listener\n\n      describe '#releaseListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .releaseListener()\n            .should.be.equal component\n\n[Component#constructor]: ..\/component.litcoffee#constructor\n[Parent]: .\/index.litcoffee\n","old_contents":"# TEST CLASS: Component\n* Parent: [Index][Parent]\n\n---\n\n    should = require 'should'\n    module.exports = (Component, name='Component') ->\n\n## CONSTRUCTOR\n\n      describe name, ->\n        it 'should be a class', -> Component.should.be.a.class\n\n        describe '#constructor(args)', ->\n          it 'should return an instance of Component', ->\n            (new Component).should.be.an.instanceof Component\n\n---\n\n## LISTENERS\n\nMousemove capturing listener\n\n      describe '#mousemoveCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .mousemoveCaptureListener()\n            .should.be.equal component\n\n        it 'should set the state to active if component is grabbed', ->\n          component = new Component\n          component.___runtime.grab = true\n          component.state = null\n          component.mousemoveCaptureListener({})\n          component.state.should.be.equal 'active'\n\n        it 'should broadcast drag event with drag offset', (done) ->\n          component = new Component events:drag:true\n          component.___runtime.grab = true\n          component.___runtime.grabEvent = x:10, y:10\n          component.broadcastEvent = (event) ->\n            event.offsetX.should.be.equal 10\n            event.offsetY.should.be.equal 5\n            done()\n          component.mousemoveCaptureListener x:20, y:15\n\n        it 'should broadcast drag event with drag offset using previous drag', (done) ->\n          component = new Component events:drag:true\n          component.___runtime.grab = true\n          component.___runtime.dragEvent = x:10, y:10\n          component.broadcastEvent = (event) ->\n            event.offsetX.should.be.equal 10\n            event.offsetY.should.be.equal 5\n            done()\n          component.mousemoveCaptureListener x:20, y:15\n\n        it 'should set the component state to hover', ->\n          component = new Component\n            origin  : x:0, y:0\n            regions : hover: [0,0,1,1]\n          component.mousemoveCaptureListener x:0.5, y:0.5\n          component.state.should.be.equal 'hover'\n\n        it 'should set the component state to hover', ->\n          component = new Component\n            origin  : x:0, y:0\n            regions : normal: [0,0,1,1]\n          component.mousemoveCaptureListener x:0.5, y:0.5\n          component.state.should.be.equal 'normal'\n\n        it 'should set the component state to hover preceeding normal', ->\n          component = new Component\n            origin  : x:0, y:0\n            regions : normal: [0,0,1,1], hover: [0,0,1,1]\n          component.mousemoveCaptureListener x:0.5, y:0.5\n          component.state.should.be.equal 'hover'\n\nDrag capturing listener\n\n      describe '#dragCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .mousemoveCaptureListener()\n            .should.be.equal component\n\n        it 'should save the event in #___runtime', ->\n          (component = new Component)\n            .dragCaptureListener 'test'\n            .___runtime.dragEvent.should.be.equal 'test'\n\n        it 'should localize the event coordinates', ->\n          (component = new Component origin: x:10, y:15)\n            .dragCaptureListener (event = x:20, y:30)\n\n          event.localX.should.be.equal 10\n          event.localY.should.be.equal 15\n\nGrab capturing listener\n\n      describe '#grabCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .grabCaptureListener()\n            .should.be.equal component\n\nRelease capturing listener\n\n      describe '#releaseCaptureListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .releaseCaptureListener()\n            .should.be.equal component\n\nMousedown listener\n\n      describe '#mousedownListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .mousedownListener()\n            .should.be.equal component\n\n        it 'should set grab flag in #___runtime', ->\n          (component = new Component state:'active', events:grab:true)\n            .mousedownListener {}\n            .___runtime.grab.should.be.true\n\nDrag listener\n      \n      describe '#dragListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .dragListener()\n            .should.be.equal component\n\nGrab listener\n\n      describe '#grabListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .grabListener()\n            .should.be.equal component\n\nRelease listener\n\n      describe '#releaseListener', ->\n        it 'should return the component', ->\n          (component = new Component)\n            .releaseListener()\n            .should.be.equal component\n\n[Component#constructor]: ..\/component.litcoffee#constructor\n[Parent]: .\/index.litcoffee\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c28e8cacdc8359d662514238834f12a5292d7237","subject":"Nuke the firepad logo","message":"Nuke the firepad logo\n","repos":"prophile\/happiness","old_file":"src\/init.litcoffee","new_file":"src\/init.litcoffee","new_contents":"Site Initialisation\n===================\n\nFirstly, we put up a container for bits published by the various components.\n\n    window.Happiness = {}\n\nWe defer all core initialisation until post-pageload.\n\n    $ ->\n\nEditor Setup\n------------\n\nThe first thing we do as part of init is prepare the code window for editing.\n\n      Happiness.EditWindow = ace.edit \"editor\"\n      Happiness.EditWindow.setTheme \"ace\/theme\/textmate\"\n      Happiness.EditWindow.getSession().setMode \"ace\/mode\/python\"\n\nLet's get rid of that obnoxious logo while we're at it.\n\n      $('.powered-by-firepad').remove()\n\n","old_contents":"Site Initialisation\n===================\n\nFirstly, we put up a container for bits published by the various components.\n\n    window.Happiness = {}\n\nWe defer all core initialisation until post-pageload.\n\n    $ ->\n\nEditor Setup\n------------\n\nThe first thing we do as part of init is prepare the code window for editing.\n\n      editor = ace.edit \"editor\"\n      editor.setTheme \"ace\/theme\/textmate\"\n      editor.getSession().setMode \"ace\/mode\/python\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cf352c75ab8a962342ef3b2ee40b7929838cdb6a","subject":"increase ttl for queue keepalive","message":"increase ttl for queue keepalive\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"server\/queueMethods.litcoffee","new_file":"server\/queueMethods.litcoffee","new_contents":"# Super secret queue methods\n\n    @QueueMethods =\n      popAndServeNextTicket: ->\n\nMove the current connection to the processed queue\n\nTODO: get postID\n\n        queueMeta = QueueMeta.findOne()\n\nUpdate object, extended at various point for updating the QueueMeta in one swoop\n\n        update =\n          $set: {}\n\nIf `theOnlyConnectionAllowedIn` is set to something, check if the connection\nhas expired and process the connection if it has.\n\n        if queueMeta.theOnlyConnectionAllowedIn isnt undefined\n\n          previousConnection = queueMeta.theOnlyConnectionAllowedIn\n          previousConnectionDidntPosted = not queueMeta.hasCurrentConnectionPosted\n\nReturn if timeCurrentTicketExpires is in the future (hasn't expired)\n\n          hasntExpired = queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n          return if hasntExpired\n\nOkay then, the current connection has expired, time to get bumped.\nInsert the processed connection into the ProcessedQueue\n\n          try\n\nCalculate how long the connection had to wait in line.\n\n            waitTimeSeconds = moment.utc().diff (moment.utc queueMeta.theOnlyConnectionAllowedIn.timeEnqueued), 'seconds'\n\nMake the processed object.\n\n            processed =\n              connection: queueMeta.theOnlyConnectionAllowedIn\n              waitTimeSeconds: waitTimeSeconds\n\nInsert the processed connection to `QueueProcessed`\n\n            QueueProcessed.insert processed\n          catch err\n            console.log err\n\nRemove the connection from the `Queue`\n\n          criteria = _id: queueMeta.currentlyServingQueueId\n          Queue.remove criteria\n\nUpdate `QueueMeta` stats and ticket number.\n\n          try\n            totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n            currentlyServingTicketNumber = queueMeta.currentlyServingTicketNumber + 1\n            _.extend update.$set,\n              currentlyServingTicketNumber: currentlyServingTicketNumber\n              hasCurrentConnectionPosted: no\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          catch err\n            console.log err\n\nLookup the lowest ticket # waiting in the `Queue`\n\n        nextConnection = Queue.findOne {}, { sort: { 'ticketNumber': 1 } }\n\nSet the allowed connection and expireTime if one exists\n\nIf there is a nextConnection (i.e. someone waiting in line), then serve them.\nOtherwise clear out theOnlyConnectionAllowedIn.\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          _.extend update.$set,\n            theOnlyConnectionAllowedIn: nextConnection\n            timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n            currentlyServingTicketNumber: nextConnection.ticketNumber\n            currentlyServingQueueId: nextConnection._id\n\nIf there is no nextConnection, unset theOnlyConnectionAllowedIn.\nNote, fake data is filled in to pass schema, even though we're $unset'ing\n\n        else\n          update.$unset = theOnlyConnectionAllowedIn: \"\"\n\n        criteria = _id: queueMeta._id\n\nDelete `update.$set` if it's empty\n\n        if _.isEmpty update.$set\n          delete update.$set\n\nIf `update` isn't empty, update!\n\n        if not _.isEmpty update\n          QueueMeta.update criteria, update\n\n\nTODO: keep it DRY; logic isn't exactly shared and want to keep update atomic to\navoid extraneous DDP messages.\n\n## Disconnect dead connections, remove from queue\n\n      cleanUpDeadConnections: ->\n\nA connection is dead if keepAlive > 5 minutes ago\n\n        timeFiveMinutesAgoUtc = moment.utc().subtract('5', 'minutes').toDate()\n        criteria =\n          timeKeepAlive:\n            $lt: timeFiveMinutesAgoUtc\n\n        deadQueue = Queue.find criteria\n        deadQueue.forEach (queue) ->\n          criteria =\n            _id: queue._id\n          Queue.remove criteria\n\nCalculate how long the connection had to wait in line.\n\n          waitTimeSeconds = moment.utc().diff (moment.utc queue.timeEnqueued), 'seconds'\n\nMake the processed object.\n\n          processed =\n            connection: queue\n            waitTimeSeconds: waitTimeSeconds\n            diconnect: yes\n          QueueProcessed.insert processed\n\n          queueMeta = QueueMeta.findOne()\n\n          totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n\n          criteria =\n            _id: queueMeta._id\n          action =\n            $set:\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          QueueMeta.update criteria, action\n","old_contents":"# Super secret queue methods\n\n    @QueueMethods =\n      popAndServeNextTicket: ->\n\nMove the current connection to the processed queue\n\nTODO: get postID\n\n        queueMeta = QueueMeta.findOne()\n\nUpdate object, extended at various point for updating the QueueMeta in one swoop\n\n        update =\n          $set: {}\n\nIf `theOnlyConnectionAllowedIn` is set to something, check if the connection\nhas expired and process the connection if it has.\n\n        if queueMeta.theOnlyConnectionAllowedIn isnt undefined\n\n          previousConnection = queueMeta.theOnlyConnectionAllowedIn\n          previousConnectionDidntPosted = not queueMeta.hasCurrentConnectionPosted\n\nReturn if timeCurrentTicketExpires is in the future (hasn't expired)\n\n          hasntExpired = queueMeta.timeCurrentTicketExpires > moment.utc().toDate()\n          return if hasntExpired\n\nOkay then, the current connection has expired, time to get bumped.\nInsert the processed connection into the ProcessedQueue\n\n          try\n\nCalculate how long the connection had to wait in line.\n\n            waitTimeSeconds = moment.utc().diff (moment.utc queueMeta.theOnlyConnectionAllowedIn.timeEnqueued), 'seconds'\n\nMake the processed object.\n\n            processed =\n              connection: queueMeta.theOnlyConnectionAllowedIn\n              waitTimeSeconds: waitTimeSeconds\n\nInsert the processed connection to `QueueProcessed`\n\n            QueueProcessed.insert processed\n          catch err\n            console.log err\n\nRemove the connection from the `Queue`\n\n          criteria = _id: queueMeta.currentlyServingQueueId\n          Queue.remove criteria\n\nUpdate `QueueMeta` stats and ticket number.\n\n          try\n            totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n            currentlyServingTicketNumber = queueMeta.currentlyServingTicketNumber + 1\n            _.extend update.$set,\n              currentlyServingTicketNumber: currentlyServingTicketNumber\n              hasCurrentConnectionPosted: no\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          catch err\n            console.log err\n\nLookup the lowest ticket # waiting in the `Queue`\n\n        nextConnection = Queue.findOne {}, { sort: { 'ticketNumber': 1 } }\n\nSet the allowed connection and expireTime if one exists\n\nIf there is a nextConnection (i.e. someone waiting in line), then serve them.\nOtherwise clear out theOnlyConnectionAllowedIn.\n\n        if nextConnection?\n          timeCurrentTicketExpires = moment.utc()\n          timeCurrentTicketExpires.add 1, 'minutes'\n          _.extend update.$set,\n            theOnlyConnectionAllowedIn: nextConnection\n            timeCurrentTicketExpires: timeCurrentTicketExpires.toDate()\n            currentlyServingTicketNumber: nextConnection.ticketNumber\n            currentlyServingQueueId: nextConnection._id\n\nIf there is no nextConnection, unset theOnlyConnectionAllowedIn.\nNote, fake data is filled in to pass schema, even though we're $unset'ing\n\n        else\n          update.$unset = theOnlyConnectionAllowedIn: \"\"\n\n        criteria = _id: queueMeta._id\n\nDelete `update.$set` if it's empty\n\n        if _.isEmpty update.$set\n          delete update.$set\n\nIf `update` isn't empty, update!\n\n        if not _.isEmpty update\n          QueueMeta.update criteria, update\n\n\nTODO: keep it DRY; logic isn't exactly shared and want to keep update atomic to\navoid extraneous DDP messages.\n\n## Disconnect dead connections, remove from queue\n\n      cleanUpDeadConnections: ->\n\nA connection is dead if keepAlive > 5 minutes ago\n\n        timeTwoMinutesAgoUtc = moment.utc().subtract('2', 'minutes').toDate()\n        criteria =\n          timeKeepAlive:\n            $lt: timeTwoMinutesAgoUtc\n\n        deadQueue = Queue.find criteria\n        deadQueue.forEach (queue) ->\n          criteria =\n            _id: queue._id\n          Queue.remove criteria\n\nCalculate how long the connection had to wait in line.\n\n          waitTimeSeconds = moment.utc().diff (moment.utc queue.timeEnqueued), 'seconds'\n\nMake the processed object.\n\n          processed =\n            connection: queue\n            waitTimeSeconds: waitTimeSeconds\n            diconnect: yes\n          QueueProcessed.insert processed\n\n          queueMeta = QueueMeta.findOne()\n\n          totalWaitTimeSeconds = queueMeta.totalWaitTimeSeconds + waitTimeSeconds\n\n          criteria =\n            _id: queueMeta._id\n          action =\n            $set:\n              totalWaitTimeSeconds: totalWaitTimeSeconds\n          QueueMeta.update criteria, action\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7ff55b738a7d52ed57391b717d6a1bc2b4bb85e0","subject":"Defer buildMatchers to configure call instead of in Commander parser func","message":"Defer buildMatchers to configure call instead of in Commander parser func\n\nThis means using the languages option when calling Docco programmatically will\nwork properly.\n","repos":"tbremer\/docco,guigrpa\/docco,guigrpa\/docco,Hellyna\/docco,MaxwellRebo\/docco,erikdiessel\/plidoc,gvithellyna\/docco,oponder\/docco,gvithellyna\/docco,DoomHammer\/docco,MaxwellRebo\/docco,lbn\/docco,guigrpa\/docco-extended,mhkeller\/docco,whitetrefoil\/docco,guigrpa\/docco-extended,whitetrefoil\/docco,ShawnHuang\/docco-multidir,actano\/docco,tbremer\/docco,lbn\/docco,oponder\/docco,DoomHammer\/docco,STRd6\/docco,ShawnHuang\/docco-multidir,lobrien\/docco,Hellyna\/docco,jrvidal\/docco,JonathanMatthey\/codeconv,jrvidal\/docco,jalleyne\/docco,lobrien\/docco,mhkeller\/docco,robertmackenzie\/docco,osharim\/docco,jalleyne\/docco,erikdiessel\/plidoc,robertmackenzie\/docco,osharim\/docco","old_file":"docco.litcoffee","new_file":"docco.litcoffee","new_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* Your all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        isText = maybeCode = yes\n        for line, i in lines\n          lines[i] = if maybeCode and match = \/^([ ]{4}|[ ]{0,3}\\t)\/.exec line\n            isText = no\n            line[match[0].length..]\n          else if maybeCode = \/^\\s*$\/.test line\n            if isText then lang.symbol else ''\n          else\n            isText = yes\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n      for section, i in sections\n        code = highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      config.languages = buildMatchers config.languages\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    {highlight} = require 'highlight.js'\n\nEnable nicer typography with marked.\n\n    marked.setOptions smartypants: yes\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\n\nWe accept customised language formats as a command-line argument in the form\n`ext:langname:commentsymbol,ext:langname:commentsymbol`.\n\n    parseLanguages = (langs) ->\n        return {} unless _.isString langs\n        _.object _.map langs.split(','), (s) ->\n            [ext, name, symbol, literate] = s.split(':')\n            literate ?= false\n            [ext, {name, symbol, literate}]\n\n\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [langs]','set custom language comment styles', parseLanguages)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","old_contents":"Docco\n=====\n\n**Docco** is a quick-and-dirty documentation generator, written in\n[Literate CoffeeScript](http:\/\/coffeescript.org\/#literate).\nIt produces an HTML document that displays your comments intermingled with your\ncode. All prose is passed through\n[Markdown](http:\/\/daringfireball.net\/projects\/markdown\/syntax), and code is\npassed through [Highlight.js](http:\/\/highlightjs.org\/) syntax highlighting.\nThis page is the result of running Docco against its own\n[source file](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/docco.litcoffee).\n\n1. Install Docco with **npm**: `sudo npm install -g docco`\n\n2. Run it against your code: `docco src\/*.coffee`\n\nThere is no \"Step 3\". This will generate an HTML page for each of the named\nsource files, with a menu linking to the other pages, saving the whole mess\ninto a `docs` folder (configurable).\n\nThe [Docco source](http:\/\/github.com\/jashkenas\/docco) is available on GitHub,\nand is released under the [MIT license](http:\/\/opensource.org\/licenses\/MIT).\n\nDocco can be used to process code written in any programming language. If it\ndoesn't handle your favorite yet, feel free to\n[add it to the list](https:\/\/github.com\/jashkenas\/docco\/blob\/master\/resources\/languages.json).\nFinally, the [\"literate\" style](http:\/\/coffeescript.org\/#literate) of *any*\nlanguage is also supported \u2014 just tack an `.md` extension on the end:\n`.coffee.md`, `.py.md`, and so on.\n\n\nPartners in Crime:\n------------------\n\n* If Node.js doesn't run on your platform, or you'd prefer a more\nconvenient package, get [Ryan Tomayko](http:\/\/github.com\/rtomayko)'s\n[Rocco](http:\/\/rtomayko.github.io\/rocco\/rocco.html), the **Ruby** port that's\navailable as a gem.\n\n* If you're writing shell scripts, try\n[Shocco](http:\/\/rtomayko.github.io\/shocco\/), a port for the **POSIX shell**,\nalso by Mr. Tomayko.\n\n* If **Python** is more your speed, take a look at\n[Nick Fitzgerald](http:\/\/github.com\/fitzgen)'s [Pycco](http:\/\/fitzgen.github.io\/pycco\/).\n\n* For **Clojure** fans, [Fogus](http:\/\/blog.fogus.me\/)'s\n[Marginalia](http:\/\/fogus.me\/fun\/marginalia\/) is a bit of a departure from\n\"quick-and-dirty\", but it'll get the job done.\n\n* There's a **Go** port called [Gocco](http:\/\/nikhilm.github.io\/gocco\/),\nwritten by [Nikhil Marathe](https:\/\/github.com\/nikhilm).\n\n* Your all you **PHP** buffs out there, Fredi Bach's\n[sourceMakeup](http:\/\/jquery-jkit.com\/sourcemakeup\/) (we'll let the faux pas\nwith respect to our naming scheme slide), should do the trick nicely.\n\n* **Lua** enthusiasts can get their fix with\n[Robert Gieseke](https:\/\/github.com\/rgieseke)'s [Locco](http:\/\/rgieseke.github.io\/locco\/).\n\n* And if you happen to be a **.NET**\naficionado, check out [Don Wilson](https:\/\/github.com\/dontangg)'s\n[Nocco](http:\/\/dontangg.github.io\/nocco\/).\n\n* Going further afield from the quick-and-dirty, [Groc](http:\/\/nevir.github.io\/groc\/)\nis a **CoffeeScript** fork of Docco that adds a searchable table of contents,\nand aims to gracefully handle large projects with complex hierarchies of code.\n\nNote that not all ports will support all Docco features ... yet.\n\n\nMain Documentation Generation Functions\n---------------------------------------\n\nGenerate the documentation for our configured source file by copying over static\nassets, reading all the source files in, splitting them up into prose+code\nsections, highlighting each file in the appropriate language, and printing them\nout in an HTML template.\n\n    document = (options = {}, callback) ->\n      config = configure options\n\n      fs.mkdirs config.output, ->\n\n        callback or= (error) -> throw error if error\n        copyAsset  = (file, callback) ->\n          fs.copy file, path.join(config.output, path.basename(file)), callback\n        complete   = ->\n          copyAsset config.css, (error) ->\n            if error then callback error\n            else if fs.existsSync config.public then copyAsset config.public, callback\n            else callback()\n\n        files = config.sources.slice()\n\n        nextFile = ->\n          source = files.shift()\n          fs.readFile source, (error, buffer) ->\n            return callback error if error\n\n            code = buffer.toString()\n            sections = parse source, code, config\n            format source, sections, config\n            write source, sections, config\n            if files.length then nextFile() else complete()\n\n        nextFile()\n\nGiven a string of source code, **parse** out each block of prose and the code that\nfollows it \u2014 by detecting which is which, line by line \u2014 and then create an\nindividual **section** for it. Each section is an object with `docsText` and\n`codeText` properties, and eventually `docsHtml` and `codeHtml` as well.\n\n    parse = (source, code, config = {}) ->\n      lines    = code.split '\\n'\n      sections = []\n      lang     = getLanguage source, config\n      hasCode  = docsText = codeText = ''\n\n      save = ->\n        sections.push {docsText, codeText}\n        hasCode = docsText = codeText = ''\n\nOur quick-and-dirty implementation of the literate programming style. Simply\ninvert the prose and code relationship on a per-line basis, and then continue as\nnormal below.\n\n      if lang.literate\n        isText = maybeCode = yes\n        for line, i in lines\n          lines[i] = if maybeCode and match = \/^([ ]{4}|[ ]{0,3}\\t)\/.exec line\n            isText = no\n            line[match[0].length..]\n          else if maybeCode = \/^\\s*$\/.test line\n            if isText then lang.symbol else ''\n          else\n            isText = yes\n            lang.symbol + ' ' + line\n\n      for line in lines\n        if line.match(lang.commentMatcher) and not line.match(lang.commentFilter)\n          save() if hasCode\n          docsText += (line = line.replace(lang.commentMatcher, '')) + '\\n'\n          save() if \/^(---+|===+)$\/.test line\n        else\n          hasCode = yes\n          codeText += line + '\\n'\n      save()\n\n      sections\n\nTo **format** and highlight the now-parsed sections of code, we use **Highlight.js**\nover stdio, and run the text of their corresponding comments through\n**Markdown**, using [Marked](https:\/\/github.com\/chjj\/marked).\n\n    format = (source, sections, config) ->\n      language = getLanguage source, config\n      for section, i in sections\n        code = highlight(language.name, section.codeText).value\n        code = code.replace(\/\\s+$\/, '')\n        section.codeHtml = \"<div class='highlight'><pre>#{code}<\/pre><\/div>\"\n        section.docsHtml = marked(section.docsText)\n\nOnce all of the code has finished highlighting, we can **write** the resulting\ndocumentation file by passing the completed HTML sections into the template,\nand rendering it to the specified output path.\n\n    write = (source, sections, config) ->\n\n      destination = (file) ->\n        path.join(config.output, path.basename(file, path.extname(file)) + '.html')\n\nThe **title** of the file is either the first heading in the prose, or the\nname of the source file.\n\n      first = marked.lexer(sections[0].docsText)[0]\n      hasTitle = first and first.type is 'heading' and first.depth is 1\n      title = if hasTitle then first.text else path.basename source\n\n      html = config.template {sources: config.sources, css: path.basename(config.css),\n        title, hasTitle, sections, path, destination,}\n\n      console.log \"docco: #{source} -> #{destination source}\"\n      fs.writeFileSync destination(source), html\n\n\nConfiguration\n-------------\n\nDefault configuration **options**. All of these may be extended by\nuser-specified options.\n\n    defaults =\n      layout:     'parallel'\n      output:     'docs'\n      template:   null\n      css:        null\n      extension:  null\n      languages:  {}\n\n**Configure** this particular run of Docco. We might use a passed-in external\ntemplate, or one of the built-in **layouts**. We only attempt to process\nsource files for languages for which we have definitions.\n\n    configure = (options) ->\n      config = _.extend {}, defaults, _.pick(options, _.keys(defaults)...)\n\n      if options.template\n        config.layout = null\n      else\n        dir = config.layout = path.join __dirname, 'resources', config.layout\n        config.public       = path.join dir, 'public' if fs.existsSync path.join dir, 'public'\n        config.template     = path.join dir, 'docco.jst'\n        config.css          = options.css or path.join dir, 'docco.css'\n      config.template = _.template fs.readFileSync(config.template).toString()\n\n      config.sources = options.args.filter((source) ->\n        lang = getLanguage source, config\n        console.warn \"docco: skipped unknown type (#{path.basename source})\" unless lang\n        lang\n      ).sort()\n\n      config\n\n\nHelpers & Initial Setup\n-----------------------\n\nRequire our external dependencies.\n\n    _           = require 'underscore'\n    fs          = require 'fs-extra'\n    path        = require 'path'\n    marked      = require 'marked'\n    commander   = require 'commander'\n    {highlight} = require 'highlight.js'\n\nEnable nicer typography with marked.\n\n    marked.setOptions smartypants: yes\n\nLanguages are stored in JSON in the file `resources\/languages.json`.\nEach item maps the file extension to the name of the language and the\n`symbol` that indicates a line comment. To add support for a new programming\nlanguage to Docco, just add it to the file.\n\n    languages = JSON.parse fs.readFileSync(path.join(__dirname, 'resources', 'languages.json'))\n\nBuild out the appropriate matchers and delimiters for each language.\n\n    buildMatchers = (languages) ->\n      for ext, l of languages\n\nDoes the line begin with a comment?\n\n        l.commentMatcher = \/\/\/^\\s*#{l.symbol}\\s?\/\/\/\n\nIgnore [hashbangs](http:\/\/en.wikipedia.org\/wiki\/Shebang_%28Unix%29) and interpolations...\n\n        l.commentFilter = \/(^#![\/]|^\\s*#\\{)\/\n      languages\n    languages = buildMatchers languages\n\nA function to get the current language we're documenting, based on the\nfile extension. Detect and tag \"literate\" `.ext.md` variants.\n\n    getLanguage = (source, config) ->\n      ext  = config.extension or path.extname(source) or path.basename(source)\n      lang = config.languages[ext] or languages[ext]\n      if lang and lang.name is 'markdown'\n        codeExt = path.extname(path.basename(source, ext))\n        if codeExt and codeLang = languages[codeExt]\n          lang = _.extend {}, codeLang, {literate: yes}\n      lang\n\nKeep it DRY. Extract the docco **version** from `package.json`\n\n    version = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'))).version\n\n\nCommand Line Interface\n----------------------\n\nFinally, let's define the interface to run Docco from the command line.\n\nWe accept customised language formats as a command-line argument in the form\n`ext:langname:commentsymbol,ext:langname:commentsymbol`.\n\n    parseLanguages = (langs) ->\n        return {} unless _.isString langs\n        buildMatchers _.object _.map langs.split(','), (s) ->\n            [ext, name, symbol, literate] = s.split(':')\n            literate ?= false\n            [ext, {name, symbol, literate}]\n\n\nParse options using [Commander](https:\/\/github.com\/visionmedia\/commander.js).\n\n    run = (args = process.argv) ->\n      c = defaults\n      commander.version(version)\n        .usage('[options] files')\n        .option('-L, --languages [langs]','set custom language comment styles', parseLanguages)\n        .option('-l, --layout [name]',    'choose a layout (parallel, linear or classic)', c.layout)\n        .option('-o, --output [path]',    'output to a given folder', c.output)\n        .option('-c, --css [file]',       'use a custom css file', c.css)\n        .option('-t, --template [file]',  'use a custom .jst template', c.template)\n        .option('-e, --extension [ext]',  'assume a file extension for all inputs', c.extension)\n        .parse(args)\n        .name = \"docco\"\n      if commander.args.length\n        document commander\n      else\n        console.log commander.helpInformation()\n\n\nPublic API\n----------\n\n    Docco = module.exports = {run, document, parse, format, version}\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a488933435756d5be473cd00a58898e370e2f774","subject":"Refactor code","message":"Refactor code\n","repos":"mnmtanish\/vosco-cli","old_file":"index.litcoffee","new_file":"index.litcoffee","new_contents":"Dependencies\n============\n\n    fs     = require \"fs\"\n    path   = require \"path\"\n    {exec} = require \"child_process\"\n    VOSCO  = require \"vosco\"\n\nSanity Checks\n-------------\n\nVOSCO must always be run with **root** previliges. It is expected to run with `sudo` command by logged in user. VOSCO is designed to manage system wide configurations and needs read\/write access to many restricted files. The program will stop unless the user id is zero.\n\n    await exec \"id -u\", defer(error, userId)\n    unless parseInt(userId) is 0\n      console.error \"VOSCO must be run as root user\"\n      process.exit 1\n\nInitialize VOSCO\n----------------\n\nCreate a new VOSCO instance called `vosco` which will be doing all the hard work. No need to set environment variables before running unless you're testing or doing something different using VOSCO.\n\n    vosco = do ->\n      repo_path = process.env.VOSCO_ROOT_DIR || '\/'\n      repo_opts =\n        author_name : process.env.USER\n        author_email: \"#{process.env.USER}@localhost\"\n      return new VOSCO repo_path, repo_opts\n\nShell Mode \/ Script Mode\n------------------------\n\nThe shell mode is interactive. It will guide users using helpful menus and messages. This mode is difficult and not suitable for scripting. Script mode is suitable for scripting and for non-interactive use. Output form this mode is always clean and easy to parse using other programs.\n\n    shell  = require(\".\/lib\/shell\")(vosco)\n    script = require(\".\/lib\/script\")(vosco)\n\nIf no arguments are given, we assume that user wishes to enter an interactive shell to run VOSCO commands. Otherwise assume user needs to run specific commands using script mode. Show the help text if user enters an invalid command.\n\n    command = process.argv[2]\n    args    = process.argv.slice 3\n\n    if command is undefined\n      shell.init()\n    else if typeof script[command] is 'function'\n      script[command].apply script, args\n    else do ->\n      filePath = path.resolve __dirname, \"help-text.txt\"\n      helpText = fs.readFileSync filePath\n      console.log helpText.toString()\n","old_contents":"Dependencies\n============\n\n    fs     = require \"fs\"\n    path   = require \"path\"\n    {exec} = require \"child_process\"\n    VOSCO  = require \"vosco\"\n\n    Shell  = require \".\/lib\/shell\"\n    Script = require \".\/lib\/script\"\n\nSanity Checks\n-------------\n\nVOSCO must always be run with **root** previliges. It is expected to run with `sudo` command by logged in user. VOSCO is designed to manage system wide configurations and needs read\/write access to many restricted files. The program will stop unless the user id is zero.\n\n    await exec \"id -u\", defer(error, userId)\n    unless parseInt(userId) is 0\n      console.error \"VOSCO must be run as root user\"\n      process.exit 1\n\nInitialize VOSCO\n----------------\n\n    vosco = do ->\n      repo_path = process.env.VOSCO_ROOT_DIR || '\/'\n      repo_opts =\n        author_name : process.env.USER\n        author_email: \"#{process.env.USER}@localhost\"\n      return new VOSCO repo_path, repo_opts\n\n    shell  = Shell(vosco)\n    script = Script(vosco)\n\nScript or Interactive\n---------------------\n\nIf no arguments are given, we assume that user wishes to enter an interactive shell to run VOSCO commands. Otherwise assume user needs to run specific commands.\n\n    command = process.argv[2]\n    args    = process.argv.slice 3\n\n    if command is undefined\n      shell.init()\n    else if typeof script[command] is 'function'\n      script[command].apply script, args\n    else do ->\n      filePath = path.resolve __dirname, \"help-text.txt\"\n      helpText = fs.readFileSync filePath\n      console.log helpText.toString()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"801e3a74b9db79d2b9c979d8776ae60c26bdaa28","subject":"docs(document): update heading for all class methods","message":"docs(document): update heading for all class methods\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/model\/Document.litcoffee","new_file":"coffee\/model\/Document.litcoffee","new_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n    collections = require('..\/helper\/schema').types\n\n---\n\n## Class: Doc\n\n### Params\n\n* **string** `type` - document type\n* **string** `id` - document id\n\n### Return\n\nNew `Doc`.\n\n---\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n      @db   = mongo[type]\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n      @type = type\n      @data = {}\n      @chit = false\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if Object.keys(data).length\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n## doc.exists()\n\nCheck if document exists.\n\n### Return\n\nReturns `true` if document exists; otherwise `false`.\n\n---\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n## doc.getId()\n\nGet document id (ObjectID) for current document.\n\n### Return\n\nReturns an `ObjectID` if the document has an id; otherwise `null`.\n\n---\n\n    Doc.prototype.getId = ->\n      @id\n\n\n## doc.wasCacheHit()\n\nCheck if document request was a cache hit.\n\n### Return\n\nReturns `true` if document request was a cache hit; otherwise `false`.\n\n---\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n## doc.isNotModifiedSince()\n\nCheck if document has not been modified since a given timestamp.\n\n### Params\n\n* **string** `time` - timestamp to check against.\n\n### Return\n\nReturns `true` if document has not been modified since given timestamp; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make UNIX timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n## doc.isMatch\n\nCheck if checksum, or Etag, matches current document checksum.\n\n### Params\n\n* **string** `checksum` - checksum to check against.\n\n### Return\n\nReturns `true` if checksum matches the current checksum; otherwise `false`.\n\n---\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n## doc.isNoneMatch\n\nCheck if checksum, or Etag, doesn't match current document checksum.\n\n### Params\n\n* **string** `checksum` - checksum to check against.\n\n### Return\n\nReturn `true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n## doc.get()\n\nGet cached data for current document.\n\n### Params\n\n* **string** `key` - get specific object property\n\n### Return\n\nReturns an `object` if `key` is `undefined`; otherwise `string`. Will return\n`undefined` if the given key does not exist.\n\n---\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n## doc.getFull\n\n### Params\n\n* **object** `filter` - control which object properties are returned\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n## doc.getFuller\n\n### Params\n\n* **object** `filter` - control which object properties are returned\n* **array** `expand` - sub-document property names to expand\n* **object** `query` - query for expanded sub-documents\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFuller = (filter, expand, query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      count = 0\n      mapped = {}\n\nSince `expand` might be a user supplied input parameter we need to limit it to\nproperties which are expandable (`collections`). We also remove properties which\nholds no value for this document.\n\n      expand = expand\n        .filter (v) => @data[v] and v in collections\n\nNext we map the string array into an object array on the following format:\n`{ type: String, ids: Array }` where `ids` are ObjectIDs to an document of the\ncollection `type`.\n\n        .map (v) => type: v, ids: @data[v].map (d) -> new ObjectID d\n\nSet up a `final` function which is called when expanded data is ready to be\nmapped to the original document.\n\n      final = () =>\n        @db.findOne _id: @id, filter, (err, doc) ->\n          cb err, Object.assign doc or {}, mapped\n\nIf there are no fields to expand, we just call the `final` function instantly\nand no fields will get expanded.\n\n      return final() if expand.length is 0\n\nSet up a `next` function which is called for each expanded data returned from\nthe database. Expanded data is stored in the `mapped` object which is merged\nwith the main document in `final`. When all expanded fields are mapped `final`\nis called.\n\n      next = (type, _, docs) ->\n        mapped[type] = docs or []\n        return final() if Object.keys(mapped).length == expand.length\n\nGet the expanded sub-documents from the database.\n\n      expand.forEach (x) ->\n        mongo[x.type]\n\nWe find the sub-documents using the ObjectIDs in the expanded fields, that is\nthe easy part. The tricky part is to prevent information leakage of private\ndocuments. This the second part is a `query` limiting the results to public\ndocuments or those owned by the current API user.\n\n          .find Object.assign {_id: $in: x.ids}, query\n\nWe reuse the projection filter from the original document, but since we do not\nknow in advanced who owns a given sub-document we remove the `private` property\nto prevent information leakage.\n\n          .project Object.assign filter, privat: false\n\nBundle all the sub-documents in one array and pass it to the `next` function.\n\n          .toArray next.bind null, x.type\n\n\n## doc.insert()\n\nInserts a document into database.\n\n### Params\n\n* **object** `data` - data to insert for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## doc.replace()\n\nReplaces all document data in database.\n\n### Params\n\n* **object** `data` - replacement data for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          data._id = @id\n          cb err, warn, data\n\n\n## doc.update()\n\nPartially update the document-data in database. This is some times referred to as\nPATCH in a HTTP \/ REST context.\n\n### Params\n\n* **object** `data` - replacement object for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n## doc.delete()\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n### Params\n\n* **function** `cb` - callback function (**Error** `err`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet', endret: new Date()\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n\n","old_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n    collections = require('..\/helper\/schema').types\n\n---\n\n## Class: Doc\n\n### Params\n\n* **string** `type` - document type\n* **string** `id` - document id\n\n### Return\n\nNew `Doc`.\n\n---\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n      @db   = mongo[type]\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n      @type = type\n      @data = {}\n      @chit = false\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if Object.keys(data).length\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n## Doc.exists\n\nCheck if document exists.\n\n### Return\n\nReturns `true` if document exists; otherwise `false`.\n\n---\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n## Doc.getId\n\nGet document id (ObjectID) for current document.\n\n### Return\n\nReturns an `ObjectID` if the document has an id; otherwise `null`.\n\n---\n\n    Doc.prototype.getId = ->\n      @id\n\n\n## Doc.wasCacheHit\n\nCheck if document request was a cache hit.\n\n### Return\n\nReturns `true` if document request was a cache hit; otherwise `false`.\n\n---\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n## Doc.isNotModifiedSince\n\nCheck if document has not been modified since a given timestamp.\n\n### Params\n\n* **string** `time` - timestamp to check against.\n\n### Return\n\nReturns `true` if document has not been modified since given timestamp; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make UNIX timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n## doc.isMatch\n\nCheck if checksum, or Etag, matches current document checksum.\n\n### Params\n\n* **string** `checksum` - checksum to check against.\n\n### Return\n\nReturns `true` if checksum matches the current checksum; otherwise `false`.\n\n---\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n## doc.isNoneMatch\n\nCheck if checksum, or Etag, doesn't match current document checksum.\n\n### Params\n\n* **string** `checksum` - checksum to check against.\n\n### Return\n\nReturn `true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n## Doc.get\n\nGet cached data for current document.\n\n### Params\n\n* **string** `key` - get specific object property\n\n### Return\n\nReturns an `object` if `key` is `undefined`; otherwise `string`. Will return\n`undefined` if the given key does not exist.\n\n---\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n## doc.getFull\n\n### Params\n\n* **object** `filter` - control which object properties are returned\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n## doc.getFuller\n\n### Params\n\n* **object** `filter` - control which object properties are returned\n* **array** `expand` - sub-document property names to expand\n* **object** `query` - query for expanded sub-documents\n* **function** `cb` - callback function (**Error** `err`, **object** `data`)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFuller = (filter, expand, query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      count = 0\n      mapped = {}\n\nSince `expand` might be a user supplied input parameter we need to limit it to\nproperties which are expandable (`collections`). We also remove properties which\nholds no value for this document.\n\n      expand = expand\n        .filter (v) => @data[v] and v in collections\n\nNext we map the string array into an object array on the following format:\n`{ type: String, ids: Array }` where `ids` are ObjectIDs to an document of the\ncollection `type`.\n\n        .map (v) => type: v, ids: @data[v].map (d) -> new ObjectID d\n\nSet up a `final` function which is called when expanded data is ready to be\nmapped to the original document.\n\n      final = () =>\n        @db.findOne _id: @id, filter, (err, doc) ->\n          cb err, Object.assign doc or {}, mapped\n\nIf there are no fields to expand, we just call the `final` function instantly\nand no fields will get expanded.\n\n      return final() if expand.length is 0\n\nSet up a `next` function which is called for each expanded data returned from\nthe database. Expanded data is stored in the `mapped` object which is merged\nwith the main document in `final`. When all expanded fields are mapped `final`\nis called.\n\n      next = (type, _, docs) ->\n        mapped[type] = docs or []\n        return final() if Object.keys(mapped).length == expand.length\n\nGet the expanded sub-documents from the database.\n\n      expand.forEach (x) ->\n        mongo[x.type]\n\nWe find the sub-documents using the ObjectIDs in the expanded fields, that is\nthe easy part. The tricky part is to prevent information leakage of private\ndocuments. This the second part is a `query` limiting the results to public\ndocuments or those owned by the current API user.\n\n          .find Object.assign {_id: $in: x.ids}, query\n\nWe reuse the projection filter from the original document, but since we do not\nknow in advanced who owns a given sub-document we remove the `private` property\nto prevent information leakage.\n\n          .project Object.assign filter, privat: false\n\nBundle all the sub-documents in one array and pass it to the `next` function.\n\n          .toArray next.bind null, x.type\n\n\n## Doc.insert\n\nInserts a document into database.\n\n### Params\n\n* **object** `data` - data to insert for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.replace\n\nReplaces all document data in database.\n\n### Params\n\n* **object** `data` - replacement data for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          data._id = @id\n          cb err, warn, data\n\n\n## Doc.update\n\nPartially update the document-data in database. This is some times referred to as\nPATCH in a HTTP \/ REST context.\n\n### Params\n\n* **object** `data` - replacement object for document.\n* **function** `cb` - callback function (**Error** `err`, **Array** `warn`, **object** `data`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n## Doc.delete\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n### Params\n\n* **function** `cb` - callback function (**Error** `err`).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet', endret: new Date()\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fe8bb80582ce54b4ed4e13e4ffdfd9d096c0debb","subject":"- Fixed issue while reading source code of modules","message":"- Fixed issue while reading source code of modules\n","repos":"WillemDeGroef\/nodesentry","old_file":"src\/module.litcoffee","new_file":"src\/module.litcoffee","new_contents":"Module\n======\n\nActs as a replacement for the original module. Works by loading a given library\nin a sandbox (to apply lower-bound policies) and wraps each public API also in\na membrane (to apply upper-bound policies)\n\n\n    path = require \"path\"\n    vm = require \"vm\"\n    fs = require \"fs\"\n\n    Sandbox = require \".\/sandbox\"\n    Membrane = require \".\/membrane\"\n\n    stripBOM = (content) ->\n        content.slice 1 if content.charCodeAt(0) == 0xFEFF\n        content\n\n    class Module\n\n        constructor: (@libName) ->\n            @policyObj = {}\n            @fileName = require.resolve(@libName)\n\n        setPolicy: (@policyObj) ->\n\nReturn `true` if we know for sure that the requested library is a built-in library.\n\n        isBuiltInModule: () -> @fileName.indexOf(\".js\") == -1\n\nLoad the library and return a wrapped version of the original public API:\n\n        loadLibrary: () ->\n            requireCode = \"module.exports = require('#{@libName}');\"\n            requireCode = stripBOM(fs.readFileSync(@fileName, \"utf8\")).toString() unless @isBuiltInModule()\n\n            script = vm.createScript requireCode\n\nLoad in an instrumented sandbox to enforce lower-bound policies:\n\n            ctxt = new Sandbox(@fileName, @policyObj).context()\n            script.runInContext ctxt\n\nApply a membrane on the public API of the library to enforce upper-bound policies:\n\n            new Membrane(ctxt.module.exports, @policyObj)\n\n\n    module.exports = Module\n","old_contents":"Module\n======\n\nActs as a replacement for the original module. Works by loading a given library\nin a sandbox (to apply lower-bound policies) and wraps each public API also in\na membrane (to apply upper-bound policies)\n\n\n    path = require \"path\"\n    vm = require \"vm\"\n    fs = require \"fs\"\n\n    Sandbox = require \".\/sandbox\"\n    Membrane = require \".\/membrane\"\n\n\n    class Module\n\n        constructor: (@libName) ->\n            @policyObj = {}\n            @fileName = require.resolve(@libName)\n\n        setPolicy: (@policyObj) ->\n\nReturn `true` if we know for sure that the requested library is a built-in library.\n\n        isBuiltInModule: () -> @fileName.indexOf(\".js\") == -1\n\nLoad the library and return a wrapped version of the original public API:\n\n        loadLibrary: () ->\n\n            requireCode = \"module.exports = require('#{@libName}');\"\n            requireCode = fs.readFileSync(@fileName).toString() unless @isBuiltInModule()\n\n            script = vm.createScript requireCode\n\nLoad in an instrumented sandbox to enforce lower-bound policies:\n\n            ctxt = new Sandbox(@fileName, @policyObj).context()\n            script.runInContext ctxt\n\nApply a membrane on the public API of the library to enforce upper-bound policies:\n\n            new Membrane(ctxt.module.exports, @policyObj)\n\n\n    module.exports = Module\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"63af4d7f27cd4b06540ada3adc0b444c5f90683d","subject":"accounts template flow router sign out","message":"accounts template flow router sign out\n","repos":"jfols\/liftoff,jfols\/liftoff","old_file":"lib\/config\/accountsTemplates.litcoffee","new_file":"lib\/config\/accountsTemplates.litcoffee","new_contents":"# Configure Accounts Template\n\n    AccountsTemplates.configure\n\nBehavior\n\n      confirmPassword: yes\n      enablePasswordChange: yes\n      forbidClientAccountCreation: no\n      overrideLoginErrors: yes\n      sendVerificationEmail: no\n      lowercaseUsername: yes\n\nAppearance\n\n      showAddRemoveServices: no\n      showForgotPasswordLink: yes\n      showLabels: yes\n      showPlaceholders: yes\n      showResendVerificationEmailLink: no\n\nClient-side Validation\n\n      continuousValidation: no\n      negativeFeedback: no\n      negativeValidation: yes\n      positiveValidation: yes\n      positiveFeedback: yes\n      showValidating: yes\n\n      homeRoutePath: '\/'\n      redirectTimeout: 4000\n      defaultLayout: 'mainLayout'\n      defaultLayoutRegions:\n        header: 'header'\n        footer: 'footer'\n      defaultContentRegion: 'content'\n\n      texts:\n        navSignIn: 'Sign In'\n        navSignOut: 'Logout'\n        signUpLink_link: 'Create an account'\n        pwdLink_link: 'Forgot password?'\n\n      onLogoutHook: -> FlowRouter.go '\/sign-in'\n\n    AccountsTemplates.removeField 'email'\n    password = AccountsTemplates.removeField 'password'\n    AccountsTemplates.addFields [\n      _id: 'username'\n      type: 'text'\n      displayName: 'username'\n      required: yes\n      minLength: 5\n      func: (value) ->\n        if Meteor.isClient\n          console.log 'validating username'\n          self = this\n          Meteor.call 'userExists', value, (error, userExists) ->\n            try\n              if userExists\n                self.setError 'username taken'\n              else\n                self.setSuccess()\n              self.setValidating no\n            catch e\n              console.log e\n        else\n          Meteor.call 'userExists', value\n    ,\n      _id: 'email'\n      type: 'email'\n      required: yes\n      displayName: 'email'\n      re: \/.+@(.+){2,}\\.(.+){2,}\/\n      errStr: 'Invalid email'\n    ,\n      _id: 'username_and_email'\n      type: 'text'\n      required: yes\n      displayName: 'Login'\n      placeholder: 'Email or username'\n    ,\n      password\n    ]\n\n    if Meteor.isServer\n      Meteor.methods\n        userExists: (username) ->\n          !!(Meteor.users.findOne username: username)\n\n    AccountsTemplates.configureRoute 'changePwd'\n    AccountsTemplates.configureRoute 'enrollAccount'\n    AccountsTemplates.configureRoute 'forgotPwd'\n    AccountsTemplates.configureRoute 'resetPwd'\n    AccountsTemplates.configureRoute 'signIn'\n    AccountsTemplates.configureRoute 'signUp'\n    AccountsTemplates.configureRoute 'verifyEmail'\n","old_contents":"# Configure Accounts Template\n\n    AccountsTemplates.configure\n\nBehavior\n\n      confirmPassword: yes\n      enablePasswordChange: yes\n      forbidClientAccountCreation: no\n      overrideLoginErrors: yes\n      sendVerificationEmail: no\n      lowercaseUsername: yes\n\nAppearance\n\n      showAddRemoveServices: no\n      showForgotPasswordLink: yes\n      showLabels: yes\n      showPlaceholders: yes\n      showResendVerificationEmailLink: no\n\nClient-side Validation\n\n      continuousValidation: no\n      negativeFeedback: no\n      negativeValidation: yes\n      positiveValidation: yes\n      positiveFeedback: yes\n      showValidating: yes\n\n      homeRoutePath: '\/'\n      redirectTimeout: 4000\n      defaultLayout: 'mainLayout'\n      defaultLayoutRegions:\n        header: 'header'\n        footer: 'footer'\n      defaultContentRegion: 'content'\n\n      texts:\n        navSignIn: 'Sign In'\n        navSignOut: 'Logout'\n        signUpLink_link: 'Create an account'\n        pwdLink_link: 'Forgot password?'\n\n    AccountsTemplates.removeField 'email'\n    password = AccountsTemplates.removeField 'password'\n    AccountsTemplates.addFields [\n      _id: 'username'\n      type: 'text'\n      displayName: 'username'\n      required: yes\n      minLength: 5\n      func: (value) ->\n        if Meteor.isClient\n          console.log 'validating username'\n          self = this\n          Meteor.call 'userExists', value, (error, userExists) ->\n            try\n              if userExists\n                self.setError 'username taken'\n              else\n                self.setSuccess()\n              self.setValidating no\n            catch e\n              console.log e\n        else\n          Meteor.call 'userExists', value\n    ,\n      _id: 'email'\n      type: 'email'\n      required: yes\n      displayName: 'email'\n      re: \/.+@(.+){2,}\\.(.+){2,}\/\n      errStr: 'Invalid email'\n    ,\n      _id: 'username_and_email'\n      type: 'text'\n      required: yes\n      displayName: 'Login'\n      placeholder: 'Email or username'\n    ,\n      password\n    ]\n\n    if Meteor.isServer\n      Meteor.methods\n        userExists: (username) ->\n          !!(Meteor.users.findOne username: username)\n\n    AccountsTemplates.configureRoute 'changePwd'\n    AccountsTemplates.configureRoute 'enrollAccount'\n    AccountsTemplates.configureRoute 'forgotPwd'\n    AccountsTemplates.configureRoute 'resetPwd'\n    AccountsTemplates.configureRoute 'signIn'\n    AccountsTemplates.configureRoute 'signUp'\n    AccountsTemplates.configureRoute 'verifyEmail'\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"efad1dfc024ffca54c4297d91083e40f537c9aa1","subject":"remove extraneous fs","message":"remove extraneous fs\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/lib\/routes\/index.litcoffee","new_file":"src\/lib\/routes\/index.litcoffee","new_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        res.redirect '\/page\/index'\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        app.models.page.get req.params.name, (err, page) ->\n          if err\n            console.error 'page '+req.params.name+' not found in db, showing static'\n            res.render 'page\/'+req.params.name\n          else\n            res.render 'page\/dynamic', page\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n<!-- ' -->\n\n      app.post '\/page\/_post', (req, res) ->\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          content: 'Hello world, from inside the DB'\n        app.models.page sample, (err, page) ->\n          if err\n            page = \n              name: 'error'\n              title: 'Error'\n              content: 'There was an error posting your page, please try again.'\n          res.render 'page\/dynamic', page\n          \n## GET \/login\n\nRender static pages at \/view\/login\/index.html\n\nAnd never cache the login page, it breaks csrf\n\n      app.get '\/login', (req, res) ->\n        res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0')\n        res.render 'login'\n\n          \n## POST \/login\/_post\n\nDo Login action, and redirect as appropriate.\n\n      app.post '\/login\/_post', (req, res) ->\n        require('..\/login').checkUser req.body.username, req.body.password, (user, securityLevel) ->\n          console.info 'login callback = '+user+', '+securityLevel\n          req.session.user = user\n          req.session.securityLevel = securityLevel\n          res.cookie 'nocache', '1'\n          if securityLevel\n            res.redirect '\/'\n          else\n            res.redirect '\/login'\n\n## GET \/login\/clear\n\nLogout from the website by clearing the session\n\n      app.get '\/login\/clear', (req, res) ->\n        req.session.destroy (err) ->\n          res.clearCookie 'nocache'\n          res.redirect '\/login'\n\n## GET \/directory\n \nDownload PDF to browser\n\n      app.get '\/directory', (req, res) ->\n        if req.session.securityLevel\n          request = require 'request'\n          request app.directory_url, (err, cbres, data) ->\n            if err or cbres.statusCode != 200\n              res.render 500, 'Error retrieving full directory'\n            else\n              dir = JSON.parse data\n              page = \n                name: 'Full Directory'\n                title: 'Full Directory'\n                directory: dir.data\n                helpers:\n                  month: (num) ->\n                    return [null, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'][num]\n              res.render 'directory', page\n        else\n          res.redirect '\/login'\n\n\n## GET \/directory\/directory.pdf\n \nDownload PDF to browser\n\n      app.get '\/directory\/directory.pdf', (req, res) ->\n        if req.session.securityLevel\n          res.download 'protected\/directory.pdf'\n        else\n          res.redirect '\/login'\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Routes\n\nThe purpose of a route is to connect URL resources with underlying code.  I\nalso do explicit data normalization (input -> dictionary to pass to method\/dict\nfrom method -> view) at this stage.\n\nTo configure routes, the only object we need access to is `app`.  This module\ncan be called with `require(\".\/lib\/routes\")(app)` as long as `app` is an\nalready initialized ExpressJS application.\n\nAlso note, app.models contians:\n\n- **app.models.db** - Mongoose MongoDB connection\n- **app.models.MODELNAME** - model objects\n\n    module.exports = (app) ->\n\n## GET \/\n\nRender the main index page.\n\n      app.get '\/', (req, res) ->\n        fs = require('fs')\n        res.redirect '\/page\/index'\n\n## GET \/page\/:name\n\nRender static pages at \/view\/page\/name.html\n\n      app.get '\/page\/:name', (req, res) ->\n        app.models.page.get req.params.name, (err, page) ->\n          if err\n            console.error 'page '+req.params.name+' not found in db, showing static'\n            res.render 'page\/'+req.params.name\n          else\n            res.render 'page\/dynamic', page\n\n## POST \/page\/_post\n\nPost a page into the database\n\nWARNING no security! .. then again, it doesn't read input at the moment either.\n<!-- ' -->\n\n      app.post '\/page\/_post', (req, res) ->\n        sample =\n          name: 'test'\n          title: 'Test Page'\n          content: 'Hello world, from inside the DB'\n        app.models.page sample, (err, page) ->\n          if err\n            page = \n              name: 'error'\n              title: 'Error'\n              content: 'There was an error posting your page, please try again.'\n          res.render 'page\/dynamic', page\n          \n## GET \/login\n\nRender static pages at \/view\/login\/index.html\n\nAnd never cache the login page, it breaks csrf\n\n      app.get '\/login', (req, res) ->\n        res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0')\n        res.render 'login'\n\n          \n## POST \/login\/_post\n\nDo Login action, and redirect as appropriate.\n\n      app.post '\/login\/_post', (req, res) ->\n        require('..\/login').checkUser req.body.username, req.body.password, (user, securityLevel) ->\n          console.info 'login callback = '+user+', '+securityLevel\n          req.session.user = user\n          req.session.securityLevel = securityLevel\n          res.cookie 'nocache', '1'\n          if securityLevel\n            res.redirect '\/'\n          else\n            res.redirect '\/login'\n\n## GET \/login\/clear\n\nLogout from the website by clearing the session\n\n      app.get '\/login\/clear', (req, res) ->\n        req.session.destroy (err) ->\n          res.clearCookie 'nocache'\n          res.redirect '\/login'\n\n## GET \/directory\n \nDownload PDF to browser\n\n      app.get '\/directory', (req, res) ->\n        if req.session.securityLevel\n          request = require 'request'\n          request app.directory_url, (err, cbres, data) ->\n            if err or cbres.statusCode != 200\n              res.render 500, 'Error retrieving full directory'\n            else\n              dir = JSON.parse data\n              page = \n                name: 'Full Directory'\n                title: 'Full Directory'\n                directory: dir.data\n                helpers:\n                  month: (num) ->\n                    return [null, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'][num]\n              res.render 'directory', page\n        else\n          res.redirect '\/login'\n\n\n## GET \/directory\/directory.pdf\n \nDownload PDF to browser\n\n      app.get '\/directory\/directory.pdf', (req, res) ->\n        if req.session.securityLevel\n          res.download 'protected\/directory.pdf'\n        else\n          res.redirect '\/login'\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"f4dd8ed10c9266d2a20258fe8083198d5a80e033","subject":"Transition now requires animation to be PropertyAnimation","message":"Transition now requires animation to be PropertyAnimation\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/renderer\/types\/extensions\/transition.litcoffee","new_file":"src\/renderer\/types\/extensions\/transition.litcoffee","new_contents":"# Transition\n\n```javascript\nRectangle {\n    width: 100; height: 100;\n    color: 'red'\n    pointer.onClick: function () {\n        this.x = Math.random() * 300;\n    }\n    Transition {\n        property: 'x'\n        animation: NumberAnimation {\n            duration: 1500\n        }\n    }\n}\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n    signal = require 'src\/signal'\n    log = require 'src\/log'\n\n    log = log.scope 'Renderer', 'Transition'\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Transition extends Renderer.Extension\n        @__name__ = 'Transition'\n\n## *Transition* Transition.New([*Object* options])\n\n        @New = (opts) ->\n            item = new Transition\n            itemUtils.Object.initialize item, opts\n            item\n\n## *Transition* Transition::constructor() : *Renderer.Extension*\n\n        constructor: ->\n            super()\n            @_animation = null\n            @_property = ''\n            @_to = 0\n\n        listener = (oldVal) ->\n            {animation} = @\n            to = @_target[@property]\n            if not animation or not @running or animation.updatePending or not utils.isFloat(oldVal) or not utils.isFloat(to)\n                return\n\n            @_to = to\n\n            animation.stop()\n            animation.from = oldVal\n            animation.to = @_to\n\n            animation.target ?= @target\n            animation.start()\n            return\n\n        onTargetReady = ->\n            @_running = true\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'target'\n            defaultValue: null\n            setter: (_super) -> (val) ->\n                oldVal = @target\n                if oldVal is val\n                    return\n\n                {animation, property} = @\n\n                if animation\n                    animation.target = val\n                    animation.stop()\n\n                _super.call @, val\n\n                if oldVal\n                    utils.remove oldVal._extensions, @\n\n                @_running = false\n                if val instanceof itemUtils.Object\n                    item = val\n                else if val instanceof itemUtils.MutableDeepObject\n                    item = val._ref\n                else\n                    setImmediate onTargetReady.bind(@)\n\n                if item\n                    item._extensions.push @\n                    @_running = true\n                    # else\n                    #   item.onReady onTargetReady, @\n\n                if property\n                    handlerName = itemUtils.getPropHandlerName property\n                    if oldVal\n                        oldVal[handlerName]?.disconnect listener, @\n\n                    if val\n                        if handlerName of val\n                            val[handlerName] listener, @\n                        else\n                            log.error \"'#{property}' property signal not found\"\n                return\n\n## *PropertyAnimation* Transition::animation\n\n## *Signal* Transition::onAnimationChange(*PropertyAnimation* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'animation'\n            defaultValue: null\n            developmentSetter: (val) ->\n                assert.instanceOf val, Renderer.PropertyAnimation if val?\n            setter: (_super) -> (val) ->\n                oldVal = @animation\n                if oldVal is val\n                    return\n\n                _super.call @, val\n\n                if oldVal\n                    oldVal.target = null\n                    oldVal.stop()\n\n                if val\n                    val.target = null\n                    val.property = @property\n                return\n\n## *String* Transition::property\n\n## *Signal* Transition::onPropertyChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'property'\n            defaultValue: ''\n            setter: (_super) -> (val) ->\n                oldVal = @property\n                if oldVal is val\n                    return\n\n                {animation, target} = @\n\n                if target and val.indexOf('.') isnt -1\n                    chains = val.split '.'\n                    n = chains.length\n                    for chain, i in chains when i < n - 1\n                        target = target[chain]\n                        unless target\n                            log.error \"No object found for the '#{val}' property\"\n                            break\n                    val = chains[n - 1]\n                    @target = target\n\n                if animation\n                    animation.stop()\n                    animation.property = val\n\n                _super.call @, val\n\n                if target\n                    if oldVal\n                        handlerName = \"on#{utils.capitalize(oldVal)}Change\"\n                        target[handlerName].disconnect listener, @\n\n                    if val\n                        handlerName = \"on#{utils.capitalize(val)}Change\"\n                        target[handlerName] listener, @\n                return\n","old_contents":"# Transition\n\n```javascript\nRectangle {\n    width: 100; height: 100;\n    color: 'red'\n    pointer.onClick: function () {\n        this.x = Math.random() * 300;\n    }\n    Transition {\n        property: 'x'\n        animation: NumberAnimation {\n            duration: 1500\n        }\n    }\n}\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n    signal = require 'src\/signal'\n    log = require 'src\/log'\n\n    log = log.scope 'Renderer', 'Transition'\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Transition extends Renderer.Extension\n        @__name__ = 'Transition'\n\n## *Transition* Transition.New([*Object* options])\n\n        @New = (opts) ->\n            item = new Transition\n            itemUtils.Object.initialize item, opts\n            item\n\n## *Transition* Transition::constructor() : *Renderer.Extension*\n\n        constructor: ->\n            super()\n            @_animation = null\n            @_property = ''\n            @_to = 0\n\n        listener = (oldVal) ->\n            {animation} = @\n            to = @_target[@property]\n            if not animation or not @running or animation.updatePending or not utils.isFloat(oldVal) or not utils.isFloat(to)\n                return\n\n            @_to = to\n\n            animation.stop()\n            animation.from = oldVal\n            animation.to = @_to\n\n            animation.target ?= @target\n            animation.start()\n            return\n\n        onTargetReady = ->\n            @_running = true\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'target'\n            defaultValue: null\n            setter: (_super) -> (val) ->\n                oldVal = @target\n                if oldVal is val\n                    return\n\n                {animation, property} = @\n\n                if animation\n                    animation.target = val\n                    animation.stop()\n\n                _super.call @, val\n\n                if oldVal\n                    utils.remove oldVal._extensions, @\n\n                @_running = false\n                if val instanceof itemUtils.Object\n                    item = val\n                else if val instanceof itemUtils.MutableDeepObject\n                    item = val._ref\n                else\n                    setImmediate onTargetReady.bind(@)\n\n                if item\n                    item._extensions.push @\n                    @_running = true\n                    # else\n                    #   item.onReady onTargetReady, @\n\n                if property\n                    handlerName = itemUtils.getPropHandlerName property\n                    if oldVal\n                        oldVal[handlerName]?.disconnect listener, @\n\n                    if val\n                        if handlerName of val\n                            val[handlerName] listener, @\n                        else\n                            log.error \"'#{property}' property signal not found\"\n                return\n\n## *Animation* Transition::animation\n\n## *Signal* Transition::onAnimationChange(*Animation* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'animation'\n            defaultValue: null\n            developmentSetter: (val) ->\n                assert.instanceOf val, Renderer.Animation if val?\n            setter: (_super) -> (val) ->\n                oldVal = @animation\n                if oldVal is val\n                    return\n\n                _super.call @, val\n\n                if oldVal\n                    oldVal.target = null\n                    oldVal.stop()\n\n                if val\n                    val.target = null\n                    val.property = @property\n                return\n\n## *String* Transition::property\n\n## *Signal* Transition::onPropertyChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'property'\n            defaultValue: ''\n            setter: (_super) -> (val) ->\n                oldVal = @property\n                if oldVal is val\n                    return\n\n                {animation, target} = @\n\n                if target and val.indexOf('.') isnt -1\n                    chains = val.split '.'\n                    n = chains.length\n                    for chain, i in chains when i < n - 1\n                        target = target[chain]\n                        unless target\n                            log.error \"No object found for the '#{val}' property\"\n                            break\n                    val = chains[n - 1]\n                    @target = target\n\n                if animation\n                    animation.stop()\n                    animation.property = val\n\n                _super.call @, val\n\n                if target\n                    if oldVal\n                        handlerName = \"on#{utils.capitalize(oldVal)}Change\"\n                        target[handlerName].disconnect listener, @\n\n                    if val\n                        handlerName = \"on#{utils.capitalize(val)}Change\"\n                        target[handlerName] listener, @\n                return\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"17de4ad27269c24f1c95a0f094e159f512b2d43b","subject":"Don't pass cli param since it's not used","message":"Don't pass cli param since it's not used\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/cli.litcoffee","new_file":"lib\/cli.litcoffee","new_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    Config = require '.\/config'\n\n    new Config()\n      .initialize()\n      .then (config) ->\n        Skyll = require '.\/skyll'\n        next  = 0\n\n        render = (level) ->\n          new Skyll()\n            .initialize starting_row: Math.floor config.grid.length \/ 2\n            .then (mod) -> mod.craft level\n            .then -> render config.levels[next] if ++next < config.levels.length\n\n        render config.levels[next]\n","old_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    Config = require '.\/config'\n\n    new Config()\n      .initialize cli: true\n      .then (config) ->\n        Skyll = require '.\/skyll'\n        next  = 0\n\n        render = (level) ->\n          new Skyll()\n            .initialize starting_row: Math.floor config.grid.length \/ 2\n            .then (mod) -> mod.craft level\n            .then -> render config.levels[next] if ++next < config.levels.length\n\n        render config.levels[next]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1e610a1f80092a4b9e18091af6cedf5a862df3be","subject":"Small change to link wording","message":"Small change to link wording\n","repos":"ygt-mikekchar\/react-maybe-matchers,ygt-mikekchar\/react-maybe-matchers","old_file":"src\/JasmineMonad.litcoffee","new_file":"src\/JasmineMonad.litcoffee","new_contents":"# A monad for Jasmine tests\n\n## Requirements\n\nThe matchers need to pluralize strings, so we need to load\n[a string pluralizer method](pluralize.litcoffee#stringpluralize-method)\n\n    require(\".\/pluralize.litcoffee\")\n\n## JasmineMonad\n\nThis is the base class for our matcher monads.  In general, a monad simply wraps\na value and provides a way to run arbitrary functions using those\nwrapped values.  If you are not familiar with monads you can\nread [a small tutorial on maybe monads](.\/monad.md#what-is-a-monad).\n\n    class JasmineMonad\n\n### Unit functions\n\nOur monad wraps a few things.\n\n      constructor: (@value, @util, @testers, @messages) ->\n        @messages = [] if !@messages?\n\n      return: (value, messages) ->\n        new @constructor(value, @util, @testers, messages)\n\nRemember that the `return` function is just a convenience function\nthat we can use to create new monads of the same type as the one\nwe are working with.  It is not the `return` keyword.\n\n`util` and `testers` are needed by Jasmine for creating\na result for the matchers.  We need to carry them along.\n\n`messages` is an array containing matcher error messages\nfrom the last run matcher function.  Jasmine has an odd way\nof outputting error messages.  When you write a matcher, you\nneed to supply the error message both for when the matcher does\nnot pass *and* for when the matcher does not  pass when `.not`\nwas supplied.  We store these two messages from the last run\nmatcher in `messages`.\n\nThe `value` depends on the type of monad we are constructing.\n`JasmineMonad` is the base class and what we store in `value`\ndepends on the concrete class.\n\n### Run other arbitrary functions\n\nHere is the `bind` function that runs functions working\nwith the monad.  Because it is a Maybe monad, we only\nrun the passed function if `passed` (whether or not all\nof the matchers up to this point have passed) returns\ntrue:\n\n      bind: (func) ->\n        if @passed()\n          func(@value)\n        else\n          this\n\nWe don't have any definitive way of determining if the previous\nmatchers have passed, so we will rely on the matcher functions\nto return `null`\/`undefined` when the matcher fails.\n\n      passed: () ->\n        @value?\n\n### Returning the results to Jasmine\n\nOnce we have run our chain of matchers and filters, we need some\nway of returning a result to Jasmine.  This should always be\nthe last method called in the chain.  Notice that it doesn't\nreturn a new monad, but rather the result object that Jasmine\nexpects.\n\n      result: ->\n        result = {}\n        result.pass = @util.equals(@passed(), true, @testers)\n        if @messages?\n          if result.pass\n            result.message = @messages[1]\n          else\n            result.message = @messages[0]\n        return result\n\n### English Helpers\n\nIn constructing the messages it is often the case that you want to\nuse the word \"was\/were\" depending on the number of items.  This\nis a small helper utility.\n\nFor example:\n```\n\"there #{@was(1)}\" # == \"there was 1\"\n\"There #{@was(2)}\" # == \"there were 2\"\n```\n\n      was: (num) ->\n        'was'.pluralize(num, 'were') + \" #{num}\"\n\nSimilarly we often want to count the number of objects using the\ncorrect pluralization.\n\nFor example:\n```\n\"I have #{@count(1, 'apple')}\"            # == \"I have 1 apple\"\n\"I have #{@count(2, 'apple')}\"            # == \"I have 2 apples\"\n\"I have #{@count(2, 'mommy', 'mommies')}\"  # == \"I have 2 mommies\" \n```\n\n      count: (num, singular, plural) ->\n        \"#{num} #{singular.pluralize(num, plural)}\"\n\n### Exported Classes\n\n    module.exports = JasmineMonad\n","old_contents":"# A monad for Jasmine tests\n\n## Requirements\n\nThe matchers need to pluralize strings, so we need to load\n[a string pluralizer method](pluralize.litcoffee#stringpluralize-method)\n\n    require(\".\/pluralize.litcoffee\")\n\n## JasmineMonad\n\nThis is the base class for our matcher monads.  In general, a monad simply wraps\na value and provides a way to run arbitrary functions using those\nwrapped values.  If you are not familiar with monads you can\n[read a small tutorial on maybe monads](.\/monad.md#what-is-a-monad).\n\n\n    class JasmineMonad\n\n### Unit functions\n\nOur monad wraps a few things.\n\n      constructor: (@value, @util, @testers, @messages) ->\n        @messages = [] if !@messages?\n\n      return: (value, messages) ->\n        new @constructor(value, @util, @testers, messages)\n\nRemember that the `return` function is just a convenience function\nthat we can use to create new monads of the same type as the one\nwe are working with.  It is not the `return` keyword.\n\n`util` and `testers` are needed by Jasmine for creating\na result for the matchers.  We need to carry them along.\n\n`messages` is an array containing matcher error messages\nfrom the last run matcher function.  Jasmine has an odd way\nof outputting error messages.  When you write a matcher, you\nneed to supply the error message both for when the matcher does\nnot pass *and* for when the matcher does not  pass when `.not`\nwas supplied.  We store these two messages from the last run\nmatcher in `messages`.\n\nThe `value` depends on the type of monad we are constructing.\n`JasmineMonad` is the base class and what we store in `value`\ndepends on the concrete class.\n\n### Run other arbitrary functions\n\nHere is the `bind` function that runs functions working\nwith the monad.  Because it is a Maybe monad, we only\nrun the passed function if `passed` (whether or not all\nof the matchers up to this point have passed) returns\ntrue:\n\n      bind: (func) ->\n        if @passed()\n          func(@value)\n        else\n          this\n\nWe don't have any definitive way of determining if the previous\nmatchers have passed, so we will rely on the matcher functions\nto return `null`\/`undefined` when the matcher fails.\n\n      passed: () ->\n        @value?\n\n### Returning the results to Jasmine\n\nOnce we have run our chain of matchers and filters, we need some\nway of returning a result to Jasmine.  This should always be\nthe last method called in the chain.  Notice that it doesn't\nreturn a new monad, but rather the result object that Jasmine\nexpects.\n\n      result: ->\n        result = {}\n        result.pass = @util.equals(@passed(), true, @testers)\n        if @messages?\n          if result.pass\n            result.message = @messages[1]\n          else\n            result.message = @messages[0]\n        return result\n\n### English Helpers\n\nIn constructing the messages it is often the case that you want to\nuse the word \"was\/were\" depending on the number of items.  This\nis a small helper utility.\n\nFor example:\n```\n\"there #{@was(1)}\" # == \"there was 1\"\n\"There #{@was(2)}\" # == \"there were 2\"\n```\n\n      was: (num) ->\n        'was'.pluralize(num, 'were') + \" #{num}\"\n\nSimilarly we often want to count the number of objects using the\ncorrect pluralization.\n\nFor example:\n```\n\"I have #{@count(1, 'apple')}\"            # == \"I have 1 apple\"\n\"I have #{@count(2, 'apple')}\"            # == \"I have 2 apples\"\n\"I have #{@count(2, 'mommy', 'mommies')}\"  # == \"I have 2 mommies\" \n```\n\n      count: (num, singular, plural) ->\n        \"#{num} #{singular.pluralize(num, plural)}\"\n\n### Exported Classes\n\n    module.exports = JasmineMonad\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e92a921dc3dca55fc2b14351c7c4cec88dee6963","subject":"Node HTTPS Server","message":"Node HTTPS Server\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"352d0b6adc9a1031a7ebfdd044dd21bcd8242b45","subject":"Document data-route-params binding","message":"Document data-route-params binding\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-route-params\n\nAdds the provided keypath or literal value to the route provided to `data-route`. For example:\n\n```html\n<a data-route='routes.villians.new' data-route-params='\"mastermind=true\"'>Mastermind<\/a>\n```\n\nwill route to `\/villians\/new?mastermind=true` and\n\n```\n<a data-route='routes.villians.new' data-route-params='otherRouteParams'>Other<\/a>\n```\n\nwill look up `otherRouteParams` and append it to `\/villains\/new`.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","old_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functions like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n`data-defineview` specifies that the content of the node defines the template for a particular view.\n\nThe binding value should be a regular view path, i.e. \"#{resource_name}\/#{controller_action}\". For example:\n\n```html\n<div data-defineview=\"crimes\/index\">\n  <ul class=\"crimes\">\n    <li class=\"crime\" data-foreach-crime=\"crimes\">\n      <span data-bind=\"crime.name\" data-addclass-heinous=\"crime.heinous\" \/>\n    <\/li>\n  <\/ul>\n<\/div>\n```\n\nwill be used by the `CrimesController`'s  `index` action.\n\n\n## data-renderif \/ data-deferif\n\n`data-renderif` (and `data-deferif`) defers parsing of a node's child bindings until its keypath updates to true (or false, respectively). Note that this does not prevent the node from being inserted into the DOM. These bindings should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"23840ad87a95483101467e8c63bfe2a036ce0e92","subject":"Fix the list in the identity module","message":"Fix the list in the identity module\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/identity.litcoffee","new_file":"src\/coffee\/identity.litcoffee","new_contents":"Identity\n========\n\nEach screen has an *identifier*, a short string indicating its identity.\n\nThe following identities are examples that could be used:\n\n* arena-door\n* arena-zone-0\n* arena-zone-1\n* arena-zone-2\n* arena-zone-3\n* judge-1\n* judge-2\n* overheads\n* staff-1\n* staff-2\n\nProperty\n--------\n\nThe screen's identity is published in the *Identity* property. This\nis moderated with the *identityBus* bus.\n\n    identityBus = new Bacon.Bus()\n    window.Identity = identityBus.toProperty undefined\n\nIdentity Announcement\n---------------------\n\nWhen the screen's identity is set, it must announce this over WS\nto the server.\n\n    Identity.changes()\n            .filter( (x) -> x? )\n            .onValue (identity) ->\n                WS.send 'iam', screen: identity\n\nIdentity Prompt\n---------------\n\nIf necessary, the system will prompt the user to enter a screen\nidentity. This is triggered by sending a message to the *IdentityPropmt*\nbus.\n\n    window.IdentityPrompt = new Bacon.Bus()\n\nFor simplicity, we simply use a synchronous prompt() call for the prompt.\n\n    window.IdentityPrompt.onValue ->\n        selectedIdentity = prompt \"Please enter the screen's identity.\"\n        identityBus.push selectedIdentity\n\nIdentity Storage and Recovery\n-----------------------------\n\nThe screen's identity is stored in client-local storage, and can\nbe automatically recovered upon reopening.\n\nFirst, we set up storage.\n\n    Identity.changes()\n            .filter( (x) -> x? )\n            .onValue (identity) ->\n                localStorage.screenIdentity = identity\n\nThen, after the DOM loading, we recover the identity if we can.\nOtherwise, we prompt for the identity to be entered.\n\n    $ ->\n        recoveredIdentity = localStorage.screenIdentity\n        if recoveredIdentity?\n            identityBus.push recoveredIdentity if recoveredIdentity?\n        else\n            do IdentityPrompt.push\n\n\n\n","old_contents":"Identity\n========\n\nEach screen has an *identifier*, a short string indicating its identity.\n\nThe following identities are examples that could be used:\n* arena-door\n* arena-zone-0\n* arena-zone-1\n* arena-zone-2\n* arena-zone-3\n* judge-1\n* judge-2\n* overheads\n* staff-1\n* staff-2\n\nProperty\n--------\n\nThe screen's identity is published in the *Identity* property. This\nis moderated with the *identityBus* bus.\n\n    identityBus = new Bacon.Bus()\n    window.Identity = identityBus.toProperty undefined\n\nIdentity Announcement\n---------------------\n\nWhen the screen's identity is set, it must announce this over WS\nto the server.\n\n    Identity.changes()\n            .filter( (x) -> x? )\n            .onValue (identity) ->\n                WS.send 'iam', screen: identity\n\nIdentity Prompt\n---------------\n\nIf necessary, the system will prompt the user to enter a screen\nidentity. This is triggered by sending a message to the *IdentityPropmt*\nbus.\n\n    window.IdentityPrompt = new Bacon.Bus()\n\nFor simplicity, we simply use a synchronous prompt() call for the prompt.\n\n    window.IdentityPrompt.onValue ->\n        selectedIdentity = prompt \"Please enter the screen's identity.\"\n        identityBus.push selectedIdentity\n\nIdentity Storage and Recovery\n-----------------------------\n\nThe screen's identity is stored in client-local storage, and can\nbe automatically recovered upon reopening.\n\nFirst, we set up storage.\n\n    Identity.changes()\n            .filter( (x) -> x? )\n            .onValue (identity) ->\n                localStorage.screenIdentity = identity\n\nThen, after the DOM loading, we recover the identity if we can.\nOtherwise, we prompt for the identity to be entered.\n\n    $ ->\n        recoveredIdentity = localStorage.screenIdentity\n        if recoveredIdentity?\n            identityBus.push recoveredIdentity if recoveredIdentity?\n        else\n            do IdentityPrompt.push\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8a7dcc33a357293d19dd89eaeb64af19627472fc","subject":" Removed unnecessary async reference","message":" Removed unnecessary async reference\n","repos":"laconalabs\/elliptical,lacona\/lacona","old_file":"src\/sequence.litcoffee","new_file":"src\/sequence.litcoffee","new_contents":"#Includes\n\n\t_ = require 'lodash'\n\n\tGroup = require '.\/group'\n\n#Sequence\n\n\tclass Sequence extends Group\n\n###Constructor\n\n\t\tconstructor: (options, factory) ->\n\t\t\tsuper options\nFor every child, push it and the separator (which defaults to ' ')\n\n\t\t\t{@value} = options\n\t\t\t@children = []\n\t\t\tfor child in options.children\n\t\t\t\t@children.push(factory.create(child))\n\t\t\t\t@children.push(factory.create(options.separator ? ' ')) if options.separator isnt null\n\nRemove the last separator, so that there is 1 separator between every child\n\n\t\t\t@children.pop() if options.separator isnt null\n\n###Parse\n\n\t\thandleParse: (input, context, data, done) ->\n\t\t\tparsesActive = 0\n\n\t\t\tparseChild = (childIndex, input) =>\n\t\t\t\tparsesActive++\n\t\t\t\t@children[childIndex].parse input, context, (option) =>\n\n\t\t\t\t\tif childIndex is @children.length - 1\n\t\t\t\t\t\tnewResult = option.handleValue(@id, @value)\n\t\t\t\t\t\tdata(newResult)\n\t\t\t\t\telse\n\t\t\t\t\t\tparseChild(childIndex+1, option)\n\t\t\t\t, (err) =>\n\t\t\t\t\tif err?\n\t\t\t\t\t\tdone(err)\n\t\t\t\t\telse\n\t\t\t\t\t\tparsesActive--\n\t\t\t\t\t\tif parsesActive is 0\n\t\t\t\t\t\t\tdone()\n\n\t\t\tparseChild(0, input)\n\n\n\n\tmodule.exports = Sequence","old_contents":"#Includes\n\n\t_ = require 'lodash'\n\tasync = require 'async'\n\n\tGroup = require '.\/group'\n\n#Sequence\n\n\tclass Sequence extends Group\n\n###Constructor\n\n\t\tconstructor: (options, factory) ->\n\t\t\tsuper options\nFor every child, push it and the separator (which defaults to ' ')\n\n\t\t\t{@value} = options\n\t\t\t@children = []\n\t\t\tfor child in options.children\n\t\t\t\t@children.push(factory.create(child))\n\t\t\t\t@children.push(factory.create(options.separator ? ' ')) if options.separator isnt null\n\nRemove the last separator, so that there is 1 separator between every child\n\n\t\t\t@children.pop() if options.separator isnt null\n\n###Parse\n\n\t\thandleParse: (input, context, data, done) ->\n\t\t\tparsesActive = 0\n\n\t\t\tparseChild = (childIndex, input) =>\n\t\t\t\tparsesActive++\n\t\t\t\t@children[childIndex].parse input, context, (option) =>\n\n\t\t\t\t\tif childIndex is @children.length - 1\n\t\t\t\t\t\tnewResult = option.handleValue(@id, @value)\n\t\t\t\t\t\tdata(newResult)\n\t\t\t\t\telse\n\t\t\t\t\t\tparseChild(childIndex+1, option)\n\t\t\t\t, (err) =>\n\t\t\t\t\tif err?\n\t\t\t\t\t\tdone(err)\n\t\t\t\t\telse\n\t\t\t\t\t\tparsesActive--\n\t\t\t\t\t\tif parsesActive is 0\n\t\t\t\t\t\t\tdone()\n\n\t\t\tparseChild(0, input)\n\n\n\n\tmodule.exports = Sequence","returncode":0,"stderr":"","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"661b83875fd62291c7eb0fa025e11dcec8ceac24","subject":"Add user specified sort logic","message":"Add user specified sort logic\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.usr}]\n\n### Fields\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        fields = {}\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\n      else\n        fields =\n          tilbyder: true\n          endret: true\n          status: true\n          lisens: true\n          navn: true\n          tags: true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower.\n\n      if typeof req.query.sort is 'string' and req.query.sort\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\nOnly apply default sort if there are no geospatial queries.\n\n      else\n        sort = 'endret' if not req.db.query.geojson\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.usr}]\n\n### Fields\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        fields = {}\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\n      else\n        fields =\n          tilbyder: true\n          endret: true\n          status: true\n          lisens: true\n          navn: true\n          tags: true\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true, tags: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cc6907b5448d6cc02ff88bd4de8878cc2b223578","subject":"Add automatic tick\/label interval step selection.","message":"Add automatic tick\/label interval step selection.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.  Only desired label\/tick tightness is supplied as an option.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width, tightness = '5') ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval:\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: switch @options.intervalType\n                when 'year' then timePoint.getFullYear().toString()\n                when 'month' then timePoint.getMonth().toString()\n                when 'week', 'day' then timePoint.getDate().toString()\n                when 'hour' then timePoint.getHours().toString()\n                when 'minute' then timePoint.getMinutes().toString()\n                when 'second' then timePoint.getSeconds().toString()\n                when 'millisecond' then \".#{ timePoint.getMilliseconds() }\"\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timeAxisMaker.formatAutomatic {start, end}, canvas.width\n      timeAxisRedrerer = new TimeAxisRenderer()\n      timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatAutomatic {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatAutomatic {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatTimeAxis()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatTimeAxis()` function ####\n\nA function that formats time axis.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: switch @options.intervalType\n                when 'year' then timePoint.getFullYear().toString()\n                when 'month' then timePoint.getMonth().toString()\n                when 'week', 'day' then timePoint.getDate().toString()\n                when 'hour' then timePoint.getHours().toString()\n                when 'minute' then timePoint.getMinutes().toString()\n                when 'second' then timePoint.getSeconds().toString()\n                when 'millisecond' then \".#{ timePoint.getMilliseconds() }\"\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n      timeAxisRedrerer = new TimeAxisRenderer()\n      timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\nWell, no notes yet.\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"09e690ff7f0c1e5597456ffa642376b50f6c4ae3","subject":"correct documentation, don't actually preload partials","message":"correct documentation, don't actually preload partials\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/app.litcoffee","new_file":"src\/app.litcoffee","new_contents":"\n# Application Startup\n\nThis code starts up the application.\n\n## Configure\n\nFirst, include required modules.\n\n    express = require 'express'\n    exp3hbs = require 'express3-handlebars'\n    redis_store = require('connect-redis')(express)\n    secrets = require '.\/config\/private.js'\n\nNext, initialize the application.\n\n    app = express()\n\nConfigure HBS to glue Express and Handlebars together with HTML file extensions\nfor templates.\n\n    app.set 'view engine', 'html'\n    exp3hbs_config =\n      defaultLayout: 'default',\n      extname: '.html'\n    app.engine 'html', exp3hbs(exp3hbs_config)\n\nConfigure Express to serve static files.\n\n    app.use express.static('public')\n\nInitialize a session for later use.\n\n    app.use express.cookieParser(secrets.session_key)\n    app.use express.session({\n      store: new redis_store({host: '127.0.0.1', port: 6379, prefix: 'app-sess'}),\n      secret: secrets.session_key\n    })\n\n## Routes\n\nExecute routes module.\n\n    require('.\/lib\/routes')(app)\n\n## Errors\n\nExecute error handling module.\n\n    require('.\/lib\/error')(app)\n\n    # This must be the very last middleware added to the app\n    require('.\/lib\/error\/404')(app)\n\n## Startup\n\nFinally, start the server.\n\n    app.listen 3000\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Startup\n\nThis code starts up the application.\n\n## Configure\n\nFirst, include required modules.\n\n    express = require 'express'\n    exp3hbs = require 'express3-handlebars'\n    redis_store = require('connect-redis')(express)\n    secrets = require '.\/config\/private.js'\n\nNext, initialize the application.\n\n    app = express()\n\nConfigure HBS to glue Express and Handlebars together with HTML file extensions\nfor templates.  Also, register a partials directory to pre-load.\n\n    app.set 'view engine', 'html'\n    exp3hbs_config =\n      defaultLayout: 'default',\n      extname: '.html'\n    app.engine 'html', exp3hbs(exp3hbs_config)\n\nConfigure Express to serve static files.\n\n    app.use express.static('public')\n\nInitialize a session for later use.\n\n    app.use express.cookieParser(secrets.session_key)\n    app.use express.session({\n      store: new redis_store({host: '127.0.0.1', port: 6379, prefix: 'app-sess'}),\n      secret: secrets.session_key\n    })\n\n## Routes\n\nExecute routes module.\n\n    require('.\/lib\/routes')(app)\n\n## Errors\n\nExecute error handling module.\n\n    require('.\/lib\/error')(app)\n\n    # This must be the very last middleware added to the app\n    require('.\/lib\/error\/404')(app)\n\n## Startup\n\nFinally, start the server.\n\n    app.listen 3000\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"e5b96f472077c6a4aa64f4f5266eb5da44345a46","subject":"removed schemaUtil in favor of ElementFactory","message":"removed schemaUtil in favor of ElementFactory\n","repos":"lacona\/lacona,laconalabs\/elliptical","old_file":"src\/schema-util.litcoffee","new_file":"src\/schema-util.litcoffee","new_contents":"","old_contents":"#Includes\n\n\tLiteral = require '.\/literal'\n\tChoice = require '.\/choice'\n\n#ParseTree\n\n\tmodule.exports.schemaObject = (object) ->\n\nIf it is just a string, it is interpreted as a literal with just a display property\n\n\t\tif typeof object == 'string' or object instanceof String\n\t\t\tschemaObject = new Literal\n\t\t\t\tdisplay: object\n\t\telse\n\t\t\tswitch object.type\n\t\t\t\twhen 'literal'\n\t\t\t\t\tschemaObject = new Literal(object)\n\t\t\t\twhen 'choice'\n\t\t\t\t\tschemaObject = new Choice(object)\n\t\treturn schemaObject\n","returncode":0,"stderr":"","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"db0b35a98ba5ed6d85346c0ecbef7c6e291eee9a","subject":"value search blur fix","message":"value search blur fix\n","repos":"vpj\/models","old_file":"js\/properties\/value.litcoffee","new_file":"js\/properties\/value.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#List\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       propertyType: 'value'\n\n       @default 'value', (str) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value) -> \"#{str}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value) -> (value is @schema.default())\n\n       parse: (data) ->\n        r = super data\n        return r unless r is true\n        if not @schema.valid data\n         return @error 'invalid'\n\n        res =\n         score: 1\n         errors: []\n         value: @schema.value data\n\n        return res\n\n       toJSON: (value) -> value\n       toJSONFull: (value) -> value\n\n       edit: (elem, value, changed) ->\n        new Edit this, elem, value, changed\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, changed) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = changed\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           placeholder: @$.property._name\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = @value\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n        @change()\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r, i in results\n          break if i > 10\n          e = @div r\n          e._result = r\n\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @elems.search.style.display = 'none'\n        @change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 400\n\n       @listen 'change', (e) ->\n        @search()\n        @change()\n\n       change: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#List\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       propertyType: 'value'\n\n       @default 'value', (str) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value) -> \"#{str}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value) -> (value is @schema.default())\n\n       parse: (data) ->\n        r = super data\n        return r unless r is true\n        if not @schema.valid data\n         return @error 'invalid'\n\n        res =\n         score: 1\n         errors: []\n         value: @schema.value data\n\n        return res\n\n       toJSON: (value) -> value\n       toJSONFull: (value) -> value\n\n       edit: (elem, value, changed) ->\n        new Edit this, elem, value, changed\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, changed) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = changed\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           placeholder: @$.property._name\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = @value\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n        @change()\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r, i in results\n          break if i > 10\n          e = @div r\n          e._result = r\n\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @elems.search.style.display = 'none'\n        @change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 100\n\n       @listen 'change', (e) ->\n        @search()\n        @change()\n\n       change: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"48113a022dc4d6eb1edcfd3ef95c2f8112a75d1c","subject":"protocol","message":"protocol\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      for id, call of @callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @callsCache = {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"677ad4d234b201d0c0a39cf32014eea7bc904327","subject":"throw errors","message":"throw errors\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n\n     progress: (progress, data) ->\n      @port.respond this, 'progress', data, progress: progress, @options\n\n     success: (data) ->\n      @port.respond this, 'success', data, {}, @options\n\n     fail: (data) ->\n      @port.respond this, 'fail', data, {}, @options\n\n\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     onerror: (msg, options) ->\n      console.log msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      @_send @_createCall method, data, callbacks, options\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call @callsCounter, method, data, callbacks\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       throw new Error \"Unknown method: #{data.method}\"\n      @handlers[data.method] data.data, data, new Response data, this, options\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      @callsCache[data.id].handle data.data, data\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n     _onError: (e) -> console.log e\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n\n     _send: (data) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       console.log 'error', e\n\n      req.write data\n      req.end()\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     setup: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n\n     progress: (progress, data) ->\n      @port.respond this, 'progress', data, progress: progress, @options\n\n     success: (data) ->\n      @port.respond this, 'success', data, {}, @options\n\n     fail: (data) ->\n      @port.respond this, 'fail', data, {}, @options\n\n\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     onerror: (msg, options) ->\n      console.log msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      @_send @_createCall method, data, callbacks, options\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call @callsCounter, method, data, callbacks\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      return unless @handlers[data.method]?\n      @handlers[data.method] data.data, data, new Response data, this, options\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      return unless @callsCache[data.id]?\n      @callsCache[data.id].handle data.data, data\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n     _onError: (e) -> console.log e\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n\n     _send: (data) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       console.log 'error', e\n\n      req.write data\n      req.end()\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     setup: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"acdc2e90985c813a9c1ec2c1b4243f0ac8c15ea3","subject":"New prefixes for method signatures","message":"New prefixes for method signatures","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/04_observable.litcoffee","new_file":"docs\/04_observable.litcoffee","new_contents":"# Batman.Observable\n\n`Batman.Observable` is a mixin which gives objects the ability to notify subscribers to changes on its properties. `Observable` also adds functionality for observing _keypaths_: arbitrarily deeply nested properties on objects. All `Batman.Object`s, their subclasses and instances are observable by default.\n\n## ::.isObservable[= true] : boolean\n\n`isObservable` will return `true` when the current object is able to be observed, or `false` if it is not.\n\n## ::get(keypath: string) : value\n\nRetrieves the value at a `key` on an object. Accepts keypaths.\n\n_Note_: `get` must be used for property access on any object in `Batman`'s world. This is so that Batman can implement neat things like automatic dependency calculation for computed properties, property caching where it is safe, and smart storage mechanisms. With Batman, you must use `get` instead of the regular `.` for property access.\n\n    test \"get retrieves properties on Batman objects\", ->\n      song = new Batman.Object({length: 340, bpm: 120})\n      equal song.get(\"length\"), 340\n      equal song.get(\"bpm\"), 120\n\n    test \"get retrieves properties on nested Batman objects using keypaths\", ->\n      post = new Batman.Object\n        text: \"Hello World!\"\n        author: new Batman.Object\n          name: \"Harry\"\n      equal post.get(\"author.name\"), \"Harry\"\n\n    test \"get retrieves properties on Batman objects when . property access doesn't\", ->\n      song = new Batman.Model({length: 340, bpm: 120})\n      equal typeof song.length, \"undefined\"\n      equal song.get(\"length\"), 340\n\n## ::set(keypath: string, newValue) : newValue\n\nStores the `value` at a `key` on an object. Accepts keypaths. Returns the new value of the property.\n\n_Note_: Once more, `set` must be used for property mutation on all objects in the `Batman` world. This is again so that Batman can implement useful functionality like cache busting, eager recalculation of computed properties, and smarter storage.\n\n_Note_: Custom setters can mutate the value during setting, so the value which was passed to `set` and `set`'s return value are not guaranteed to be identical.\n\n    test \"set stores properties on batman objects.\", ->\n      song = new Batman.Object({length: 340, bpm: 120})\n      equal song.get(\"length\"), 340\n      equal song.set(\"length\", 1000), 1000\n      equal song.get(\"length\"), 1000\n\n    test \"set stores properties on nested Batman objects using keypaths\", ->\n      author = new Batman.Object\n        name: \"Harry\"\n      post = new Batman.Object\n        text: \"Hello World!\"\n        author: author\n      equal post.set(\"author.name\", \"Nick\"), \"Nick\"\n      equal author.get(\"name\"), \"Nick\", \"The value was set on the nested object.\"\n\n    test \"set is incompatible with '.' property mutation\", ->\n      song = new Batman.Model({length: 340, bpm: 120})\n      equal song.get(\"length\"), 340\n      equal song.length = 1000, 1000\n      equal song.get(\"length\"), 340, \"The song length reported by Batman is unchanged because set wasn't used to change the value.\"\n\n## ::unset(keypath: string) : value\n\nRemoves the value at the given `keypath`, leaving it `undefined`. Accepts keypaths. Returns the value the property had before unsetting.\n\n`unset` is roughly equivalent to `set(keypath, undefined)`, however, custom properties can define a nonstandard `unset` function, so it is best to use `unset` instead of `set(keypath, undefined)` wherever possible.\n\n    test \"unset removes the property on Batman objects\", ->\n      song = new Batman.Object({length: 340, bpm: 120})\n      equal song.get(\"length\"), 340\n      equal song.unset(\"length\"), 340\n      equal song.get(\"length\"), undefined, \"The value is unset.\"\n\n    test \"unset removes the property at a keypath\", ->\n      author = new Batman.Object\n        name: \"Harry\"\n      post = new Batman.Object\n        text: \"Hello World!\"\n        author: author\n      equal post.unset(\"author.name\"), \"Harry\"\n      equal author.get(\"name\"), undefined, \"The value was unset on the nested object.\"\n\n## ::getOrSet(keypath: string, valueFunction: Function) : value\n\nAssigns the `keypath` to the result of calling `valueFunction` if `keypath` is currently falsey. Returns the value of the property after the operation, whether it has changed or not. Equivalent to CoffeeScript's `||=` operator.\n\n    test \"getOrSet doesn't set the property if it exists\", ->\n      song = new Batman.Object({length: 340, bpm: 120})\n      equal song.getOrSet(\"length\", -> 500), 340\n      equal song.get(\"length\"), 340\n\n    test \"getOrSet sets the property if it is falsey\", ->\n      song = new Batman.Object({length: 340, bpm: 120})\n      equal song.getOrSet(\"artist\", -> \"Elvis\"), \"Elvis\"\n      equal song.get(\"artist\"), \"Elvis\"\n\n## ::observe(key: string, observerCallback: Function) : this\n\nAdds a handler to call when the value of the property at the `key` changes upon `set`ting. Accepts keypaths.\n\n`observe` is the very core of Batman's usefulness. As long as `set` is used everywhere to do property mutation, any object can be observed for changes to its properties. This is critical to the concept of bindings, which Batman uses for its views.\n\nThe `observerCallback` gets called with the arguments `newValue, oldValue`, whenever the `key` changes.\n\nReturns the object `observe` was called upon.\n\n    test \"observe attaches handlers which get called upon change\", ->\n      result = null\n      song = new Batman.Object({length: 340, bpm: 120})\n      song.observe \"length\", (newValue, oldValue) -> result = [newValue, oldValue]\n      equal song.set(\"length\", 200), 200\n      deepEqual result, [200, 340]\n      equal song.set(\"length\", 300), 300\n      deepEqual result, [300, 200]\n\n\n_Note_: `observe` works excellently on keypaths. If you attach a handler to a \"deep\" keypath, it will fire when any segment of the keypath changes, passing in the new value at the end of the keypath.\n\n    test \"observe attaches handlers which get called upon change\", ->\n      result = null\n      author = new Batman.Object\n        name: \"Harry\"\n      post = new Batman.Object\n        text: \"Hello World!\"\n        author: author\n      post.observe \"author.name\", (newName, oldName) -> \n        result = [newName, oldName]\n      newAuthor = new Batman.Object({name: \"James\"})\n      post.set \"author\", newAuthor\n      deepEqual result, [\"James\", \"Harry\"], \"The observer fired when the 'author' segment of the keypath changed.\"\n\n## ::observeAndFire(key: string, observerCallback: Function) : this\n\nAdds the `observerCallback` as an observer to `key`, and fires it immediately. Accepts the exact same arguments and follows the same semantics as `Observable::observe`, but the observer is fired with the current value of the keypath it observes synchronously during the call to `observeAndFire`.\n\n_Note_: During the initial synchronous firing of the `callback`, the `newValue` and `oldValue` arguments will be the same value: the current value of the property. This is because the old value of the property is not cached and therefore unavailable. If your observer needs the old value of the property, you must attach it before the `set` on the property happens.\n\n    test \"observeAndFire calls the observer upon attaching it with the currentValue of the property\", ->\n      result = null\n      song = new Batman.Object({length: 340, bpm: 120})\n      song.observeAndFire \"length\", (newValue, oldValue) -> result = [newValue, oldValue]\n      deepEqual result, [340, 340]\n      equal song.set(\"length\", 300), 300\n      deepEqual result, [300, 340]\n\n## ::observeOnce(key: string, observerCallback: Function)\n\nBehaves the same way as `Observable::observe`, except that once `observerCallback` has been executed for the first time, it will remove itself as an observer to `key`.\n\n    test \"observeOnce only calls observerCallback when key is modified for the first time\", ->\n      result = null\n      song = new Batman.Object({length: 340, bpm: 120})\n      song.observeOnce \"length\", (newValue, oldValue) -> result = [newValue, oldValue]\n      equal song.set(\"length\", 200), 200\n      deepEqual result, [200, 340]\n      equal song.set(\"length\", 300), 300\n      deepEqual result, [200, 340], \"The observer was not fired for the second update\"\n\n## ::forget([key: string[, observerCallback: Function]]) : this\n\nIf `observerCallback` and `key` are given, that observer is removed from the observers on `key`. If only a `key` is given, all observers on that key are removed. If no `key` is given, all observers on all keys are removed. Accepts keypaths.\n\nReturns the object on which `forget` was called.\n\n    test \"forget removes an observer from a key if the key and the observer are given\", ->\n      result = null\n      song = new Batman.Object({length: 340, bpm: 120})\n      observer = (newValue, oldValue) -> result = [newValue, oldValue]\n      song.observe \"length\", observer\n      equal song.set(\"length\", 200), 200\n      deepEqual result, [200, 340]\n      song.forget \"length\", observer\n      equal song.set(\"length\", 300), 300\n      deepEqual result, [200, 340], \"The logged values haven't changed because the observer hasn't fired again.\"\n\n    test \"forget removes all observers from a key if only the key is given\", ->\n      results = []\n      song = new Batman.Object({length: 340, bpm: 120})\n      observerA = ((newValue, oldValue) -> results.push [newValue, oldValue])\n      observerB = ((newValue, oldValue) -> results.push [newValue, oldValue])\n      song.observe \"length\", observerA\n      song.observe \"length\", observerB\n      equal song.set(\"length\", 200), 200\n      equal results.length, 2, \"Both length observers fired.\"\n      song.forget(\"length\")\n      equal song.set(\"length\", 300), 300\n      equal results.length, 2, \"Nothing more has been added because neither observer fired.\"\n\n    test \"forget removes all observers from all keys if no key is given\", ->\n      results = []\n      song = new Batman.Object({length: 340, bpm: 120})\n      observerA = ((newValue, oldValue) -> results.push [newValue, oldValue])\n      observerB = ((newValue, oldValue) -> results.push [newValue, oldValue])\n      song.observe \"length\", observerA\n      song.observe \"bpm\", observerB\n      equal song.set(\"length\", 200), 200\n      equal results.length, 1, \"The length observer fired.\"\n      song.forget()\n      equal song.set(\"length\", 300), 300\n      equal song.set(\"bpm\", 130), 130\n      equal results.length, 1, \"Nothing more has been logged because neither observer fired.\"\n","old_contents":"# Batman.Observable\n\n`Batman.Observable` is a mixin which gives objects the ability to notify subscribers to changes on its properties. `Observable` also adds functionality for observing _keypaths_: arbitrarily deeply nested properties on objects.\n\n## get(keypath) : value\n\nRetrieves the value at a `key` on an object. Accepts keypaths.\n\n_Note_: `get` must be used for property access on any object in `Batman`'s world. This is so that Batman can implement neat things like automatic dependency calculation for computed properties, property caching where it is safe, and smart storage mechanisms. With Batman, you must use `get` instead of normal `.` property access.\n\n    test 'get retrieves properties on Batman objects', ->\n      song = Batman({length: 340, bpm: 120})\n      equal song.get('length'), 340\n      equal song.get('bpm'), 120\n\n    test 'get retrieves properties on nested Batman objects using keypaths', ->\n      post = Batman\n        text: \"Hello World!\"\n        author: Batman\n          name: \"Harry\"\n      equal post.get('author.name'), \"Harry\"\n\n    test \"get retrieves properties on Batman objects when . property access doesn't\", ->\n      song = new Batman.Model({length: 340, bpm: 120})\n      equal typeof song.length, \"undefined\"\n      equal song.get('length'), 340\n\n## set(keypath, newValue) : newValue\n\nStores the `value` at a `key` on an object. Accepts keypaths. Returns the new value of the property.\n\n_Note_: Once more, `set` must be used for property mutation on all objects in the `Batman` world. This is again so that Batman can implement useful functionality like cache busting, eager recalculation of computed properties, and smarter storage.\n\n_Note_: Custom setters can mutate the value during setting, so the value which was passed to `set` and `set`'s return value are not guaranteed to be identical.\n\n    test 'set stores properties on batman objects.', ->\n      song = Batman({length: 340, bpm: 120})\n      equal song.get('length'), 340\n      equal song.set('length', 1000), 1000\n      equal song.get('length'), 1000\n\n    test 'set stores properties on nested Batman objects using keypaths', ->\n      author = Batman\n        name: \"Harry\"\n      post = Batman\n        text: \"Hello World!\"\n        author: author\n      equal post.set('author.name', \"Nick\"), \"Nick\"\n      equal author.get('name'), \"Nick\", \"The value was set on the nested object.\"\n\n    test \"set is incompatible with '.' property mutation\", ->\n      song = new Batman.Model({length: 340, bpm: 120})\n      equal song.get('length'), 340\n      equal song.length = 1000, 1000\n      equal song.get('length'), 340, \"The song length reported by Batman is unchanged because set wasn't used to change the value.\"\n\n## unset(keypath) : value\n\nRemoves the value at the given `keypath`, leaving it `undefined`. Accepts keypaths. Returns the value the property had before unsetting.\n\n`unset` is roughly equivalent to `set(keypath, undefined)`, however, custom properties can define a nonstandard `unset` function, so it is best to use `unset` instead of `set(keypath, undefined)` wherever possible.\n\n    test \"unset removes the property on Batman objects\", ->\n      song = Batman({length: 340, bpm: 120})\n      equal song.get('length'), 340\n      equal song.unset('length'), 340\n      equal song.get('length'), undefined, \"The value is unset.\"\n\n    test \"unset removes the property at a keypath\", ->\n      author = Batman\n        name: \"Harry\"\n      post = Batman\n        text: \"Hello World!\"\n        author: author\n      equal post.unset('author.name'), \"Harry\"\n      equal author.get('name'), undefined, \"The value was unset on the nested object.\"\n\n\n## observe(key, observerCallback) : this\n\nAdds a handler to call when the value of the property at the `key` changes upon `set`ting. Accepts keypaths.\n\n`observe` is the very core of Batman's usefulness. As long as `set` is used everywhere to do property mutation, any object can be observed for changes to its properties. This is critical to the concept of bindings, which Batman uses for its views.\n\nThe `observerCallback` gets called whenever the `key` changes with the arguments `newValue, oldValue`.\n\nReturns the object `observe` was called upon.\n\n    test \"observe attaches handlers which get called upon change\", ->\n      result = null\n      song = Batman({length: 340, bpm: 120})\n      song.observe 'length', (newValue, oldValue) -> result = [newValue, oldValue]\n      equal song.set('length', 200), 200\n      deepEqual result, [200, 340]\n      equal song.set('length', 300), 300\n      deepEqual result, [300, 200]\n\n\n_Note_: `observe` works excellently on keypaths. If you attach a handler to a \"deep\" keypath, it will fire any time the value of that keypath changes, which is another way of saying the handler will fire when any segment of the keypath changes, passing in the new value at the end of the keypath.\n\n    test \"observe attaches handlers which get called upon change\", ->\n      result = null\n      author = Batman\n        name: \"Harry\"\n      post = Batman\n        text: \"Hello World!\"\n        author: author\n      post.observe('author.name', (newName, oldName) -> result = [newName, oldName])\n      post.set 'author', newAuthor = Batman({name: \"James\"})\n      deepEqual result, [\"James\", \"Harry\"], \"The observer fired when the 'author' segment of the keypath changed.\"\n\n## observeAndFire(key, observerCallback) : this\n\nAdds the `observerCallback` as an observer to `key`, and fires it immediately. Accepts the exact same arguments and follows the same semantics as `Observable::observe`, but the observer is fired with the current value of the keypath it observes synchronously during the call to `observeAndFire`.\n\nDuring the initial synchronous firing of the `callback`, the `newValue` and `oldValue` arguments will be the same value: the current value of the property. This is because the old value of the property is not cached and therefore unavailable. If your observer needs the old value of the property, you must attach it before the `set` on the property happens.\n\n    test \"observeAndFire calls the observer upon attaching it with the currentValue of the property\", ->\n      result = null\n      song = Batman({length: 340, bpm: 120})\n      song.observeAndFire 'length', (newValue, oldValue) -> result = [newValue, oldValue]\n      deepEqual result, [340, 340]\n      equal song.set('length', 300), 300\n      deepEqual result, [300, 340]\n\n## forget([key [, observerCallback]]) : this\n\nIf `observerCallback` and `key` are given, that observer is removed from the observers on `key`. If only a `key` is given, all observers on that key are removed. If no `key` is given, all observers on all keys are removed. Accepts keypaths.\n\nReturns the object on which `forget` was called.\n\n    test \"forget removes an observer from a key if the key and the observer are given\", ->\n      result = null\n      song = Batman({length: 340, bpm: 120})\n      observer = (newValue, oldValue) -> result = [newValue, oldValue]\n      song.observe 'length', observer\n      equal song.set('length', 200), 200\n      deepEqual result, [200, 340]\n      song.forget 'length', observer\n      equal song.set('length', 300), 300\n      deepEqual result, [200, 340], \"The logged values haven't changed because the observer hasn't fired again.\"\n\n    test \"forget removes all observers from a key if only the key is given\", ->\n      results = []\n      song = Batman({length: 340, bpm: 120})\n      observerA = ((newValue, oldValue) -> results.push [newValue, oldValue])\n      observerB = ((newValue, oldValue) -> results.push [newValue, oldValue])\n      song.observe 'length', observerA\n      song.observe 'length', observerB\n      equal song.set('length', 200), 200\n      equal results.length, 2, \"Both length observers fired.\"\n      song.forget('length')\n      equal song.set('length', 300), 300\n      equal results.length, 2, \"Nothing more has been added because neither observer fired.\"\n\n    test \"forget removes all observers from all keys if no key is given\", ->\n      results = []\n      song = Batman({length: 340, bpm: 120})\n      observerA = ((newValue, oldValue) -> results.push [newValue, oldValue])\n      observerB = ((newValue, oldValue) -> results.push [newValue, oldValue])\n      song.observe 'length', observerA\n      song.observe 'bpm', observerB\n      equal song.set('length', 200), 200\n      equal results.length, 1, \"The length observer fired.\"\n      song.forget()\n      equal song.set('length', 300), 300\n      equal song.set('bpm', 130), 130\n      equal results.length, 1, \"Nothing more has been logged because neither observer fired.\"\n\n## getOrSet(keypath, valueFunction) : value\n\nAssigns the `keypath` to the result of calling the `valueFunction` if the current value at the `keypath` is falsey. Returns the value of the property after the operation, be it changed or not. Equivalent to CoffeeScript's `||=` operator.\n\n    test \"getOrSet doesn't set the property if it exists\", ->\n      song = Batman({length: 340, bpm: 120})\n      equal song.getOrSet('length', -> 500), 340\n      equal song.get('length'), 340\n\n    test \"getOrSet sets the property if it is falsey\", ->\n      song = Batman({length: 340, bpm: 120})\n      equal song.getOrSet('artist', -> \"Elvis\"), \"Elvis\"\n      equal song.get('artist'), \"Elvis\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cc42c7377f93c7d0c3d33a4cadefbc65d080b547","subject":"fixed formatting","message":"fixed formatting\n","repos":"nhz-io\/cnl","old_file":"source\/lib\/base.litcoffee","new_file":"source\/lib\/base.litcoffee","new_contents":"# CLASS: Base\n\nAll classes extend this.\n\n    module.exports = class Base\n\n## CONSTRUCTOR\n\n**new Base()**\n\nCreates [Base][Base] instance. Call `super` from descendant class\nif **___runtime** is required.\n\n      constructor: -> Object.defineProperty this, '___runtime',\n        enumerable:no, writable:no, configurable:no, value:{}\n\n## PROPERTIES\n\n### #___runtime\n* Type: [Object][Object]\n\nPrivate property which serves as a heap of data that should not\nbe exposed on the instance. Created with enumerable, configurable\nand writable set **no**.\n\n[Base]: .\/base.litcoffee\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n\n","old_contents":"# CLASS: Base\n\nAll classes extend this.\n\n    module.exports = class Base\n\n## CONSTRUCTOR\n\n**new Base()**\n\nCreates **Base** instance. Call `super` from descendant class\nif **___runtime** is required.\n\n      constructor: -> Object.defineProperty this, '___runtime',\n        enumerable:no, writable:no, configurable:no, value:{}\n\n## PROPERTIES\n\n**___runtime**\n* Type: [Object][Object]\n\nPrivate property which serves as a heap of data that should not\nbe exposed on the instance. Created with enumerable, configurable\nand writable set **no**.\n\n[Object]: https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Object\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e1f26a61996ccae359653fff4934e3f48f47a469","subject":"Updated README links","message":"Updated README links\n","repos":"marrus-sh\/jelli","old_file":"source\/README.litcoffee","new_file":"source\/README.litcoffee","new_contents":"#  THE JELLI GAME ENGINE  #\nProgrammed by Margaret Russel\n\n- - -\n\n##  Introduction  ##\n\nThis folder contains all of the source code for the Jelli Game Engine.\nJelli is written in Literate CoffeeScript, which means that each source file can be read as Markdown.\nThe code blocks (indented with four spaces) in each file are the CoffeeScript code.\nThis file is the [`README`](README.litcoffee), and is, in fact, a file in the engine's source.\n\n####  Browser compatibility  ####\n\nThe anticipated (ie, untested) browser compatibility for the Jelli Game Engine and its various modules is as follows:\n\n| Chrome | Firefox | Internet Explorer | Opera | Safari |\n| :----: | :-----: | :---------------: | :---: | :----: |\n|    7   |   4.0   |         9         |   12  |   5.1  |\n\nA few specific features have higher requirements, however:\n\n#####  touch events  #####\n\nTouch events are often either not supported or hidden behind a preference on desktop browsers.\nIn addition, touch events on IE mobile is only supported after version 11 with Windows Phone 8.1.\n\n#####  mouse events  #####\n\nMouse events likewise have higher requirements, due to the engine's dependence on `MouseEvent.pageX` and `MouseEvent.pageY`.\nThis is supported in all major browsers, but may not work in more antiquated ones (for example, Chrome requires at least version 45).\n\n#####  pixelated images  #####\n\nThe Jelli Game Engine currently handles canvas upscaling using CSS to create a pixelated appearance.\nThis feature is only supported in recent browsers, so older ones may display a blurry image on larger screens.\n\n##### additional notes  #####\n\nNot all browsers will act the same way when multiple elements share the same `id` or `name`.\nNon\u2013Gecko-based browsers do not conform with the spec for `HTMLCollection.namedItem()` in these instances and will likely break the script.\nOf course, giving multiple elements the same `id` is bad practice anyway, so this is unlikely to pose an issue.\n\nSafari (including on iOS) can sometimes fail to properly clear the canvas in select instances, for reasons that escape me and are likely a bug in Safari code.\n(In one instance, one canvas would only clear if a *different* canvas was set to clear on area change, regardless of whether area change actually ever occurred.\nI really have no solution to this except mess around until you can get things to work.)\n\n###  Modules:  ###\n\nThe Jelli Game Engine depends upon, and is developed alongside, several modules, each seperately encapsulated for portability and reusability.\nThe modules at this time are:\n\n- [`Screen`](modules\/Screen.litcoffee)\n- [`Control`](modules\/Control.litcoffee)\n- [`Sheet`](modules\/Sheet.litcoffee)\n- [`Letters`](modules\/Letters.litcoffee)\n- [`Tileset`](modules\/Tileset.litcoffee)\n\n>   [Issue #51](https:\/\/github.com\/literallybenjam\/jelli\/issues\/51) :\n    Support for a `Filter` module is also planned.\n\nYou can view the source for each module by viewing the appropriately named `.litcoffee` file in the [modules](modules) directory.\n\n###  Engine:  ###\n\nThe game engine, which depends on the aformentioned modules, is itself modular, comprised of a number of interdependent components.\nAt this time, the list of these components is as follows:\n\n1. [`Jelli`](engine\/01 Jelli.litcoffee)\n2. [`Game`](engine\/02 Game.litcoffee)\n3. [`Area`](engine\/03 Area.litcoffee)\n4. [`Collection`](engine\/04 Collection.litcoffee)\n5. [`Unit`](engine\/05 Unit.litcoffee)\n6. [`PlacementImage`](engine\/06 PlacementImage.litcoffee)\n7. [`Character`](engine\/07 Character.litcoffee)\n8. [`Text`](engine\/08 Text.litcoffee)\n\nDocumentation for each engine module is available in the [engine](engine) directory.\n\n###  How to read this engine:  ###\n\nThe best starting point for most readers and developers is reading through the documentation files for the engine itself, starting with the [`Introduction`](engine\/00 Introduction.litcoffee), as these provide all of the interfaces necessary for game development.\nNevertheless, the engine relies on the other modules for many of its tasks, and will reference them from time to time.\nA policy of focusing on the engine and looking up the other modules when needed is probably the best approach to becoming familiar with the system as a whole.\n\nIt is not necessary to understand the code behind this engine in order to put it into use.\nIn fact, the extensive documentation provided for the engine exists precisely to make it accessible without forcing users to dig through code.\nWhen browsing the source, each block of code is usually explained in the paragraphs immediately preceeding or following it.\n\nThis engine is still under active development, and errors in the code are likely present.\nIssues may be submitted through [GitHub](https:\/\/github.com\/literallybenjam\/jelli\/issues) should any bugs be discovered.\n\n###  Document structure:  ###\n\nEach source file is split into two main parts.\nThe first, titled \"Introduction\", outlines and documents the features of the module and how to use them.\nThe second, titled \"Implementation\", provides and explains the source code of the module.\nReaders looking to use the engine need largely only concern themselves with the first section, but readers aiming for a deeper understanding of how the engine operates should read both.\n\n###  Formatting conventions:  ###\n\nSource files are written in GitHub-Flavored Markdown (GFM), utilizing fenced code-blocks for non-compiled source and the occasional table.\n\nThis is a paragraph.\nIt is in a section titled \u201cFormatting conventions\u201d.\nIn the Markdown source, each sentence is given its own line.\nVariable names, literals, and code excerpts are represented like `this`, whereas `this()` is a function and `<this>` is an element.\nThis is *emphasis*, and this is **important**.\nHere is a [link](http:\/\/example.com).\n\n- This is a short unordered list\n- In the source, there is minimal padding between and around lines\n\n>   **Note :**\n    This is a note.\n\n1.  This is an ordered list\n2.  Here is item #2\n3.  Short list items like these don't end in periods\n\n>   [Issue ##](https:\/\/github.com\/literallybenjam\/jelli\/issues) :\nThis is a note regarding a known issue.\n\n-   This is an unordered list with paragraph content.\n    For these kinds of lists, there is more padding in the source and each sentence ends with a period.\n\n-   Although this is an unordered list, an ordered list with paragraph content would be formatted in much the same way.\n\n>   ```coffeescript\n>   \"This is a sample block of CoffeeScript code.\n>   It will not appear in the compiled source.\"\n>   ```\n\n>   ```html\n>   <!DOCTYPE html>\n>   <p>And here is a block of HTML.<\/p>\n>   ```\n\nThis is a line break:\n\n- - -\n\nThe CoffeeScript source uses four spaces for indentation.\nThis aids in visually matching up lines when several paragraphs of text lie between them.\n\nThe following is a subsection titled \u201cCase conventions and variable names\u201d.\n\n####  Case conventions and variable names  ####\n\nVariables are named as follows:\n\n- `snake_case` is used for variable and property names.\n- `SCREAMING_SNAKE_CASE` is used for symbols and special static values.\n- `camelCase` is used for function names\n- `PascalCase` (`UpperCamelCase`) is used for object constructors.\n\nClass names are written in `RUNNINGCAPS`.\nThis is intended to mirror the style of `Element.tagName`, as well as distinguish them from user-defined classes (which presumably are lower- or mixed-case).\nNote that HTML class names are, by spec, **not** case-insensitive, and thus the all-caps representation is **required**.\n\nTag names are written lower-case and wrapped in less-than and greater-than signs.\nThis distinguishes elements specified by `<tagname>` and elements specified by `CLASS`.\nElements may also be referred to by the DOM interface they implement; for example, `<img>` may be referred to as `HTMLImageElement` when this better reflects the code.\n\nWith `data-*` attributes, `runningtext` is used for variable names, but these are *often* given hyphen-separated semantic prefixes.\nSo you will have `data-bitdepth` but also `data-sprite-width`.\nIn JavaScript, these become `dataset.bitdepth` and `dataset.spriteWidth`, respectively.\n\n##  Implementation  ##\n\n    \"use strict\";\n\n    ###\n    THE JELLI GAME ENGINE\n    Programmed by Margaret Russel\n    -----------------------------\n    Implemented through several modules in Literate CoffeeScript.\n    Source code and resources are available at https:\/\/github.com\/literallybenjam\/jelli\/.\n    Written for the CoffeeScript 1.10.0 compiler.\n    ###\n\n###  License:  ###\n\nThe Jelli Game Engine is licensed under an MIT License, provided below:\n\n    ###\n    MIT License\n\n    Copyright (c) 2016 Margaret Russel\n\n    Permission is hereby granted, free of charge, to any person obtaining a copy\n    of this software and associated documentation files (the \"Software\"), to deal\n    in the Software without restriction, including without limitation the rights\n    to use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\n    copies of the Software, and to permit persons to whom the Software is\n    furnished to do so, subject to the following conditions:\n\n    The above copyright notice and this permission notice shall be included in all\n    copies or substantial portions of the Software.\n\n    THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n    SOFTWARE.\n    ###\n\n###  Usage:  ###\n\nSimply include [`jelli.js`](..\/jelli.js) in the `<head>` of your document to load the script.\n\n    ###\n    How To Use:\n\n    The `Game` constructor creates a new game, which is automatically assigned to `document.game`.\n    You can choose a different document for game rendering by passing it in as an attribute.\n    A document can have only one game assigned to it at a time, and this game is non-configurable.\n\n    A sample loading script might look like this:\n\n        window.addEventListener(\"load\", function () {new Game(document);}, false);\n    ###\n","old_contents":"#  THE JELLI GAME ENGINE  #\nProgrammed by Margaret Russel\n\n- - -\n\n##  Introduction  ##\n\nThis folder contains all of the source code for the Jelli Game Engine.\nJelli is written in Literate CoffeeScript, which means that each source file can be read as Markdown.\nThe code blocks (indented with four spaces) in each file are the CoffeeScript code.\nThis file is the [`README`](README.litcoffee), and is, in fact, a file in the engine's source.\n\n####  Browser compatibility  ####\n\nThe anticipated (ie, untested) browser compatibility for the Jelli Game Engine and its various modules is as follows:\n\n| Chrome | Firefox | Internet Explorer | Opera | Safari |\n| :----: | :-----: | :---------------: | :---: | :----: |\n|    7   |   4.0   |         9         |   12  |   5.1  |\n\nA few specific features have higher requirements, however:\n\n#####  touch events  #####\n\nTouch events are often either not supported or hidden behind a preference on desktop browsers.\nIn addition, touch events on IE mobile is only supported after version 11 with Windows Phone 8.1.\n\n#####  mouse events  #####\n\nMouse events likewise have higher requirements, due to the engine's dependence on `MouseEvent.pageX` and `MouseEvent.pageY`.\nThis is supported in all major browsers, but may not work in more antiquated ones (for example, Chrome requires at least version 45).\n\n#####  pixelated images  #####\n\nThe Jelli Game Engine currently handles canvas upscaling using CSS to create a pixelated appearance.\nThis feature is only supported in recent browsers, so older ones may display a blurry image on larger screens.\n\n##### additional notes  #####\n\nNot all browsers will act the same way when multiple elements share the same `id` or `name`.\nNon\u2013Gecko-based browsers do not conform with the spec for `HTMLCollection.namedItem()` in these instances and will likely break the script.\nOf course, giving multiple elements the same `id` is bad practice anyway, so this is unlikely to pose an issue.\n\nSafari (including on iOS) can sometimes fail to properly clear the canvas in select instances, for reasons that escape me and are likely a bug in Safari code.\n(In one instance, one canvas would only clear if a *different* canvas was set to clear on area change, regardless of whether area change actually ever occurred.\nI really have no solution to this except mess around until you can get things to work.)\n\n###  Modules:  ###\n\nThe Jelli Game Engine depends upon, and is developed alongside, several modules, each seperately encapsulated for portability and reusability.\nThe modules at this time are:\n\n- [`Screen`](modules\/Screen.litcoffee)\n- [`Control`](modules\/Control.litcoffee)\n- [`Poke`](modules\/Poke.litcoffee)\n- [`Sheet`](modules\/Sheet.litcoffee)\n- [`Letters`](modules\/Letters.litcoffee)\n- [`Tileset`](modules\/Tileset.litcoffee)\n\n>   [Issue #51](https:\/\/github.com\/literallybenjam\/jelli\/issues\/51) :\n    Support for a `Filter` module is also planned.\n\nYou can view the source for each module by viewing the appropriately named `.litcoffee` file in the [modules](modules) directory.\n\n###  Engine:  ###\n\nThe game engine, which depends on the aformentioned modules, is itself modular, comprised of a number of interdependent components.\nAt this time, the list of these components is as follows:\n\n1. [`Jelli`](engine\/01 Jelli.litcoffee)\n2. [`Game`](engine\/02 Game.litcoffee)\n3. [`Area`](engine\/03 Area.litcoffee)\n4. [`Collection`](engine\/04 Collection.litcoffee)\n5. [`Unit`](engine\/05 Unit.litcoffee)\n6. [`PlacementImage`](engine\/06 PlacementImage.litcoffee)\n7. [`Character`](engine\/07 Character.litcoffee)\n\nDocumentation for each engine module is available in the [engine](engine) directory.\n\n###  How to read this engine:  ###\n\nThe best starting point for most readers and developers is reading through the documentation files for the engine itself, starting with the [`Introduction`](engine\/00 Introduction.litcoffee), as these provide all of the interfaces necessary for game development.\nNevertheless, the engine relies on the other modules for many of its tasks, and will reference them from time to time.\nA policy of focusing on the engine and looking up the other modules when needed is probably the best approach to becoming familiar with the system as a whole.\n\nIt is not necessary to understand the code behind this engine in order to put it into use.\nIn fact, the extensive documentation provided for the engine exists precisely to make it accessible without forcing users to dig through code.\nWhen browsing the source, each block of code is usually explained in the paragraphs immediately preceeding or following it.\n\nThis engine is still under active development, and errors in the code are likely present.\nIssues may be submitted through [GitHub](https:\/\/github.com\/literallybenjam\/jelli\/issues) should any bugs be discovered.\n\n###  Document structure:  ###\n\nEach source file is split into two main parts.\nThe first, titled \"Introduction\", outlines and documents the features of the module and how to use them.\nThe second, titled \"Implementation\", provides and explains the source code of the module.\nReaders looking to use the engine need largely only concern themselves with the first section, but readers aiming for a deeper understanding of how the engine operates should read both.\n\n###  Formatting conventions:  ###\n\nSource files are written in GitHub-Flavored Markdown (GFM), utilizing fenced code-blocks for non-compiled source and the occasional table.\n\nThis is a paragraph.\nIt is in a section titled \u201cFormatting conventions\u201d.\nIn the Markdown source, each sentence is given its own line.\nVariable names, literals, and code excerpts are represented like `this`, whereas `this()` is a function and `<this>` is an element.\nThis is *emphasis*, and this is **important**.\nHere is a [link](http:\/\/example.com).\n\n- This is a short unordered list\n- In the source, there is minimal padding between and around lines\n\n>   **Note :**\n    This is a note.\n\n1.  This is an ordered list\n2.  Here is item #2\n3.  Short list items like these don't end in periods\n\n>   [Issue ##](https:\/\/github.com\/literallybenjam\/jelli\/issues) :\nThis is a note regarding a known issue.\n\n-   This is an unordered list with paragraph content.\n    For these kinds of lists, there is more padding in the source and each sentence ends with a period.\n\n-   Although this is an unordered list, an ordered list with paragraph content would be formatted in much the same way.\n\n>   ```coffeescript\n>   \"This is a sample block of CoffeeScript code.\n>   It will not appear in the compiled source.\"\n>   ```\n\n>   ```html\n>   <!DOCTYPE html>\n>   <p>And here is a block of HTML.<\/p>\n>   ```\n\nThis is a line break:\n\n- - -\n\nThe CoffeeScript source uses four spaces for indentation.\nThis aids in visually matching up lines when several paragraphs of text lie between them.\n\nThe following is a subsection titled \u201cCase conventions and variable names\u201d.\n\n####  Case conventions and variable names  ####\n\nVariables are named as follows:\n\n- `snake_case` is used for variable and property names.\n- `SCREAMING_SNAKE_CASE` is used for symbols and special static values.\n- `camelCase` is used for function names\n- `PascalCase` (`UpperCamelCase`) is used for object constructors.\n\nClass names are written in `RUNNINGCAPS`.\nThis is intended to mirror the style of `Element.tagName`, as well as distinguish them from user-defined classes (which presumably are lower- or mixed-case).\nNote that HTML class names are, by spec, **not** case-insensitive, and thus the all-caps representation is **required**.\n\nTag names are written lower-case and wrapped in less-than and greater-than signs.\nThis distinguishes elements specified by `<tagname>` and elements specified by `CLASS`.\nElements may also be referred to by the DOM interface they implement; for example, `<img>` may be referred to as `HTMLImageElement` when this better reflects the code.\n\nWith `data-*` attributes, `runningtext` is used for variable names, but these are *often* given hyphen-separated semantic prefixes.\nSo you will have `data-bitdepth` but also `data-sprite-width`.\nIn JavaScript, these become `dataset.bitdepth` and `dataset.spriteWidth`, respectively.\n\n##  Implementation  ##\n\n    \"use strict\";\n\n    ###\n    THE JELLI GAME ENGINE\n    Programmed by Margaret Russel\n    -----------------------------\n    Implemented through several modules in Literate CoffeeScript.\n    Source code and resources are available at https:\/\/github.com\/literallybenjam\/jelli\/.\n    Written for the CoffeeScript 1.10.0 compiler.\n    ###\n\n###  License:  ###\n\nThe Jelli Game Engine is licensed under an MIT License, provided below:\n\n    ###\n    MIT License\n\n    Copyright (c) 2016 Margaret Russel\n\n    Permission is hereby granted, free of charge, to any person obtaining a copy\n    of this software and associated documentation files (the \"Software\"), to deal\n    in the Software without restriction, including without limitation the rights\n    to use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\n    copies of the Software, and to permit persons to whom the Software is\n    furnished to do so, subject to the following conditions:\n\n    The above copyright notice and this permission notice shall be included in all\n    copies or substantial portions of the Software.\n\n    THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n    SOFTWARE.\n    ###\n\n###  Usage:  ###\n\nSimply include [`jelli.js`](..\/jelli.js) in the `<head>` of your document to load the script.\n\n    ###\n    How To Use:\n\n    The `Game` constructor creates a new game, which is automatically assigned to `document.game`.\n    You can choose a different document for game rendering by passing it in as an attribute.\n    A document can have only one game assigned to it at a time, and this game is non-configurable.\n\n    A sample loading script might look like this:\n\n        window.addEventListener(\"load\", function () {new Game(document);}, false);\n    ###\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"642b5d0f734d058323138484ee8333ad47948b32","subject":"handle message errors","message":"handle message errors\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        try\n         @_handleResponse data, options, last\n        catch e\n         @onerror? e\n       when 'call'\n        try\n         @_handleCall data, options, last\n        catch e\n         @onerror? e\n       when 'poll'\n        try\n         @_handlePoll data, options, last\n        catch e\n         @onerror? e\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    if console?.log?\n     LOG = console.log.bind console\n    else\n     LOG = -> null\n\n    if console?.error?\n     ERROR_LOG = console.error.bind console\n    else\n     ERROR_LOG = -> null\n\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data, callback) ->\n      @queue.push\n       method: 'progress'\n       data: data\n       options: {progress: progress}\n       callback: callback\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _multipleResponse: ->\n      responseList = []\n      callbacks = []\n      for d in @queue\n       responseList.push\n        status: d.method\n        data: d.data\n        options: d.options\n       if d.callback?\n        callbacks.push d.callback\n\n      done = ->\n       for callback in callbacks\n        callback()\n\n      if @port.isStreaming\n       @port.respondMultiple this, responseList, @options, done\n      else if @fresh\n       @port.respondMultiple this, responseList, @options, done\n       @fresh = false\n\n      @queue = []\n\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n      return if not @queue.isStreaming and not @fresh\n\n      if @queue.length > 1\n       return @_multipleResponse()\n\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options, d.callback\n       @fresh = false\n\n      @queue = []\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       #Handled by caller\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      self = this\n      setTimeout (-> self.callbacks[options.status] data, options), 0\n\n      if POLL_TYPE[options.status]?\n       return false\n      else\n       return true\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onCallError: (msg, options) ->\n      callsCache = @callsCache\n      @callsCache = {}\n      for id, call of callsCache\n       if not call.callbacks.fail?\n        ERROR_LOG 'fail callback not registered', call.method, call.data\n       else\n        call.callbacks.fail error: 'connectionError', msg: msg, options: options, {}\n\n      @errorCallback msg, options\n\n     onHandleError: (msg, data, options) ->\n      @errorCallback msg, data\n      response = new Response data, this, options\n      response.fail msg\n\n     errorCallback: (msg, options) ->\n      ERROR_LOG msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      params = @_createCall method, data, callbacks, options\n      @_send params, callbacks\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}, callback = null) ->\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions, callback\n\n     respondMultiple: (response, list, portOptions = {}, callback = null) ->\n      for d in list\n       if not POLL_TYPE[d.status]?\n        delete @responses[response.id]\n        break\n\n      data = []\n      for d in list\n       cancel = false\n       d.options ?= {}\n       for f in @wrappers.respond\n        r = f.apply this, [response, d.status, d.data, d.options, portOptions]\n        if not r\n         cancel = true\n         break\n\n        continue if cancel\n\n       data.push @_createResponse response, d.status, d.data, d.options\n\n      return if data.length is 0\n\n      data =\n       type: 'list'\n       list: data\n\n      @_respond data, portOptions, callback\n\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options, last = true) ->\n      switch data.type\n       when 'list'\n        for d, i in data.list\n         @_handleMessage d, options, (last and i + 1 is data.list.length)\n       when 'response'\n        @_handleResponse data, options, last\n       when 'call'\n        @_handleCall data, options, last\n       when 'poll'\n        @_handlePoll data, options, last\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       @onHandleError \"Unknown method: #{data.method}\", data, options\n       return\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       #Cannot reply\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      try\n       if @callsCache[data.id].handle data.data, data\n        delete @callsCache[data.id]\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n     _handlePoll: (data, options) ->\n      @onHandleError \"Poll not implemented\", data, options\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      #@worker.onerror = @onCallError.bind this\n\n     _send: (data) ->\n      @worker.postMessage data\n\n     _respond: (data, options, callback) ->\n      @worker.postMessage data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##FramePort class\nUsed for browser and worker\n\n    class FramePort extends Port\n     constructor: (source, dest) ->\n      super()\n      @source = source\n      @dest = dest\n      @source.addEventListener 'message', @_onMessage.bind this\n\n     _send: (data) ->\n      @dest.postMessage data, '*'\n\n     _respond: (data, options, callback) ->\n      @dest.postMessage data, '*'\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data, options, callback) ->\n      @worker.emit 'message', data\n      callback?()\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @protocol = options.protocol\n      @host = options.host\n      @port = options.port\n      @path = options.path ? '\/'\n      @url = @path\n      if @protocol?\n       if @host? and not @port?\n        @url = \"#{@protocol}:\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"#{@protocol}:\/\/#{@host}:#{@port}#{@path}\"\n      else\n       if @host? and not @port?\n        @url = \"\/\/#{@host}#{@path}\"\n       else if @host? and @port?\n        @url = \"\/\/#{@host}:#{@port}#{@path}\"\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText? and xhr.responseText != '') or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onCallError 'Cannot connect to server'\n\n     _respond: (data, options, callback) ->\n      @errorCallback 'AJAX cannot respond', data\n      callback?()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', @url\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      try\n       if call.handle data.data, data\n        delete @callsCache[data.id]\n       else if last\n        params =\n         type: 'poll'\n         id: call.id\n        params[k] = v for k, v of call.options\n        @_send params\n      catch e\n       @errorCallback e.message, data\n       delete @callsCache[data.id]\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       agent: false\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #LOG 'STATUS: ' + res.statusCode\n      #LOG 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #LOG 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @onCallError 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options, callback) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', Buffer.byteLength data, 'utf8'\n      if callback?\n       res.once 'finish', ->\n        callback()\n       res.once 'close', ->\n        callback()\n\n      res.write data\n      res.end()\n\n     _send: (data, callbacks) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = Buffer.byteLength data, 'utf8'\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       callbacks.fail? e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options, last = true) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       @errorCallback \"Response without call: #{data.id}\", data\n       return\n      call = @callsCache[data.id]\n      if not call.handle data.data, data\n       return if not last\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params, call.callbacks\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http, zlib = null) ->\n      super()\n      @port = options.port\n      @http = http\n      @zlib = zlib\n      @allowOrigin = options.allowOrigin\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        @errorCallback 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res, request: req\n\n     _respond: (data, options, callback) ->\n      if @allowOrigin?\n       options.response.setHeader 'Access-Control-Allow-Origin', @allowOrigin\n\n      accept = options.request.headers['accept-encoding']\n      accept ?= ''\n      if not @zlib?\n       accept = ''\n\n      data = JSON.stringify data\n      buffer = new Buffer data, 'utf8'\n      if accept.match \/\\bdeflate\\b\/\n       options.response.setHeader 'content-encoding', 'deflate'\n       @zlib.deflate buffer, (err, result) =>\n        if err?\n         return @errorCallback 'DeflateError', e\n        @_sendBuffer result, options.response, callback\n      else if accept.match \/\\bgzip\\b\/\n       options.response.setHeader 'content-encoding', 'gzip'\n       @zlib.gzip buffer, (err, result) =>\n        if err?\n         return @errorCallback 'GZipeError', e\n        @_sendBuffer result, options.response, callback\n      else\n       @_sendBuffer buffer, options.response, callback\n\n     _sendBuffer: (buf, res, callback) ->\n       res.setHeader 'content-length', buf.length\n       if callback?\n        res.once 'finish', ->\n         callback()\n        res.once 'close', ->\n         callback()\n\n       res.write buf\n       res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       @onHandleError \"Poll without response: #{data.id}\", data, options\n       return\n      @responses[data.id].setOptions options\n\n##NodeHttpsServerPort class\n\n    class NodeHttpsServerPort extends NodeHttpServerPort\n     constructor: (options, http) ->\n      super options, http\n      @_key = options.key\n      @_cert = options.cert\n\n     listen: ->\n      options =\n       key: @_key\n       cert: @_cert\n\n      @server = @http.createServer options, @_onRequest.bind this\n      @server.listen @port\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      FramePort: FramePort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      NodeHttpsServerPort: NodeHttpsServerPort\n      ServerSocketPort: ServerSocketPort\n\n     Helpers:\n      progress: (from, to, func) ->\n       (progress, data) ->\n        func? progress * (to - from) + from, data\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c1b9a459214c7a261bcd76af6ccb62348143017b","subject":"micro-opt: test against value access, not key lookup","message":"micro-opt: test against value access, not key lookup\n\nShould only use `key of` (`in`) to differentiate against possibility of\n`key: undefined` \u2014 `obj[key]` is highly optimized (15-20x faster) in v8\n","repos":"nickfargo\/restate","old_file":"src\/state-expression.litcoffee","new_file":"src\/state-expression.litcoffee","new_contents":"## [StateExpression](#state-expression)\n\nA **state expression** is a data structure that formalizes a definition of\na state\u2019s contents.\n\nStates are declared by calling the module\u2019s exported `state()` function and\npassing it a descriptive plain object map. This input may be expressed in a\nshorthand format, in which case it is rewritten into an unambiguous long form\nthat is used internally to create `State` instances.\n\n    State::Expression = class StateExpression\n\n      { isNumber, isPlainObject, assign, edit, clone, invert } = O\n      { NORMAL } = STATE_ATTRIBUTES\n\n      attributeMap = do ->\n        for key, value of object = assign STATE_ATTRIBUTE_MODIFIERS\n          object[ key ] = key.toUpperCase()\n        object\n\n      attributeFlags = do ->\n        for key, value of object = invert STATE_ATTRIBUTES\n          object[ key ] = value.toLowerCase()\n        object\n\n      categoryMap  = assign STATE_EXPRESSION_CATEGORIES\n      eventTypes   = assign STATE_EVENT_TYPES\n      guardActions = assign GUARD_ACTIONS\n\n\n### [Constructor](#state-expression--constructor)\n\n      constructor: ( attributes, map ) ->\n        if typeof attributes is 'string' then map or = {}\n        else unless map\n          map = attributes; attributes = undefined\n\n        map = interpret map unless map instanceof StateExpression\n        edit 'deep all', this, map\n\n        if attributes?\n          attributes = encodeAttributes attributes unless isNumber attributes\n        else { attributes } = map if map\n\n        @attributes = attributes or NORMAL\n\n\n\n### [Private functions](#state-expression--private)\n\n\n#### [interpret](#state-expression--private--interpret)\n\nTransforms a plain object map into a well-formed `StateExpression`, making the\nappropriate type inferences for any shorthand notation encountered.\n\n      interpret = ( map ) ->\n\nStart with a null-valued map keyed with the category names.\n\n        result = assign STATE_EXPRESSION_CATEGORIES, null\n\n        for own key, value of map\n\nIf `value` is just a reference to the exported `state` function, interpret that\nas an empty state expression.\n\n          value = new StateExpression if value is state\n\n###### Categorization\n\n**Priority 1:** Do a nominative type match for explicit expression instances.\n\n          category =\n            if value instanceof StateExpression then 'states'\n            else if value instanceof TransitionExpression then 'transitions'\n          if category\n            item = result[ category ] or = {}\n            item[ key ] = value\n\n**Priority 2:** Recognize an explicitly named category object.\n\n          else if key of result and value\n            result[ key ] = clone result[ key ], value\n\n**Priority 3:** Use keys and value types to infer implicit categorization.\n\n          else\n            category =\n              if eventTypes[ key ]? or typeof value is 'string'\n                'events'\n              else if guardActions[ key ]?\n                'guards'\n              else if typeof value is 'function' or ( type = value?.type ) and\n                  ( type is 'state-bound-function' or\n                    type is 'state-fixed-function' )\n                'methods'\n              else if value is NIL or isPlainObject value\n                'states'\n            if category\n              item = result[ category ] or = {}\n              item[ key ] = value\n\n###### Coersion\n\nEvent values are coerced into an array.\n\n        for own key, value of object = result.events\n          if typeof value is 'function' or typeof value is 'string'\n            object[ key ] = [ value ]\n\nGuards are represented as an object keyed by selector, so non-object values are\ncoerced into a single-element object with the value keyed to the wildcard\nselector `*`.\n\n        for own key, value of object = result.guards\n          object[ key ] = '*': value unless isPlainObject value\n\nTransition values must be a `TransitionExpression`.\n\n        for own key, value of object = result.transitions\n          unless value is NIL or value instanceof TransitionExpression\n            object[ key ] = new TransitionExpression value\n\nState values must resolve to a `StateExpression`. They may be supplied as a\nplain object, or as a live `State` instance, which is automatically `express`ed\nto a formal `StateExpression`.\n\n        for own key, value of object = result.states\n          if value instanceof State\n            object[ key ] = value.express true\n          else unless value is NIL or value instanceof StateExpression\n            object[ key ] = new StateExpression value\n\n        result\n\n\n\n### [Class methods](#state-expression--class-methods)\n\n\n#### [encodeAttributes](#state-expression--class--encode-attributes)\n\nReturns the bit-field integer represented by the provided set of `attributes`.\n\n      @encodeAttributes = encodeAttributes = ( attributes ) ->\n        attributes = assign attributes if typeof attributes is 'string'\n        result = NORMAL\n        for own key, value of attributes when key of attributeMap\n          result |= STATE_ATTRIBUTES[ attributeMap[ key ] ]\n        result\n\n\n#### [decodeAttributes](#state-expression--class--decode-attributes)\n\nReturns the space-delimited set of attribute names represented by the provided\nbit-field integer `number`.\n\n      @decodeAttributes = decodeAttributes = ( number ) ->\n        ( value for key, value of attributeFlags when number & key ).join ' '\n\n\n#### [untype](#state-expression--class-methods--untype)\n\nReturns the `StateExpression` provided by `expr` as a plain-`Object`.\n\n      @untype = untype = ( expr ) ->\n        result = {}\n        result[ key ] = value for own key, value of expr\n        s[ name ] = untype subexpr for name, subexpr of s = result.states\n        result\n\n","old_contents":"## [StateExpression](#state-expression)\n\nA **state expression** is a data structure that formalizes a definition of\na state\u2019s contents.\n\nStates are declared by calling the module\u2019s exported `state()` function and\npassing it a descriptive plain object map. This input may be expressed in a\nshorthand format, in which case it is rewritten into an unambiguous long form\nthat is used internally to create `State` instances.\n\n    State::Expression = class StateExpression\n\n      { isNumber, isPlainObject, assign, edit, clone, invert } = O\n      { NORMAL } = STATE_ATTRIBUTES\n\n      attributeMap = do ->\n        for key, value of object = assign STATE_ATTRIBUTE_MODIFIERS\n          object[ key ] = key.toUpperCase()\n        object\n\n      attributeFlags = do ->\n        for key, value of object = invert STATE_ATTRIBUTES\n          object[ key ] = value.toLowerCase()\n        object\n\n      categoryMap  = assign STATE_EXPRESSION_CATEGORIES\n      eventTypes   = assign STATE_EVENT_TYPES\n      guardActions = assign GUARD_ACTIONS\n\n\n### [Constructor](#state-expression--constructor)\n\n      constructor: ( attributes, map ) ->\n        if typeof attributes is 'string' then map or = {}\n        else unless map\n          map = attributes; attributes = undefined\n\n        map = interpret map unless map instanceof StateExpression\n        edit 'deep all', this, map\n\n        if attributes?\n          attributes = encodeAttributes attributes unless isNumber attributes\n        else { attributes } = map if map\n\n        @attributes = attributes or NORMAL\n\n\n\n### [Private functions](#state-expression--private)\n\n\n#### [interpret](#state-expression--private--interpret)\n\nTransforms a plain object map into a well-formed `StateExpression`, making the\nappropriate type inferences for any shorthand notation encountered.\n\n      interpret = ( map ) ->\n\nStart with a null-valued map keyed with the category names.\n\n        result = assign STATE_EXPRESSION_CATEGORIES, null\n\n        for own key, value of map\n\nIf `value` is just a reference to the exported `state` function, interpret that\nas an empty state expression.\n\n          value = new StateExpression if value is state\n\n###### Categorization\n\n**Priority 1:** Do a nominative type match for explicit expression instances.\n\n          category =\n            if value instanceof StateExpression then 'states'\n            else if value instanceof TransitionExpression then 'transitions'\n          if category\n            item = result[ category ] or = {}\n            item[ key ] = value\n\n**Priority 2:** Recognize an explicitly named category object.\n\n          else if key of result and value\n            result[ key ] = clone result[ key ], value\n\n**Priority 3:** Use keys and value types to infer implicit categorization.\n\n          else\n            category =\n              if key of eventTypes or typeof value is 'string'\n                'events'\n              else if key of guardActions\n                'guards'\n              else if typeof value is 'function' or ( type = value?.type ) and\n                  ( type is 'state-bound-function' or\n                    type is 'state-fixed-function' )\n                'methods'\n              else if value is NIL or isPlainObject value\n                'states'\n            if category\n              item = result[ category ] or = {}\n              item[ key ] = value\n\n###### Coersion\n\nEvent values are coerced into an array.\n\n        for own key, value of object = result.events\n          if typeof value is 'function' or typeof value is 'string'\n            object[ key ] = [ value ]\n\nGuards are represented as an object keyed by selector, so non-object values are\ncoerced into a single-element object with the value keyed to the wildcard\nselector `*`.\n\n        for own key, value of object = result.guards\n          object[ key ] = '*': value unless isPlainObject value\n\nTransition values must be a `TransitionExpression`.\n\n        for own key, value of object = result.transitions\n          unless value is NIL or value instanceof TransitionExpression\n            object[ key ] = new TransitionExpression value\n\nState values must resolve to a `StateExpression`. They may be supplied as a\nplain object, or as a live `State` instance, which is automatically `express`ed\nto a formal `StateExpression`.\n\n        for own key, value of object = result.states\n          if value instanceof State\n            object[ key ] = value.express true\n          else unless value is NIL or value instanceof StateExpression\n            object[ key ] = new StateExpression value\n\n        result\n\n\n\n### [Class methods](#state-expression--class-methods)\n\n\n#### [encodeAttributes](#state-expression--class--encode-attributes)\n\nReturns the bit-field integer represented by the provided set of `attributes`.\n\n      @encodeAttributes = encodeAttributes = ( attributes ) ->\n        attributes = assign attributes if typeof attributes is 'string'\n        result = NORMAL\n        for own key, value of attributes when key of attributeMap\n          result |= STATE_ATTRIBUTES[ attributeMap[ key ] ]\n        result\n\n\n#### [decodeAttributes](#state-expression--class--decode-attributes)\n\nReturns the space-delimited set of attribute names represented by the provided\nbit-field integer `number`.\n\n      @decodeAttributes = decodeAttributes = ( number ) ->\n        ( value for key, value of attributeFlags when number & key ).join ' '\n\n\n#### [untype](#state-expression--class-methods--untype)\n\nReturns the `StateExpression` provided by `expr` as a plain-`Object`.\n\n      @untype = untype = ( expr ) ->\n        result = {}\n        result[ key ] = value for own key, value of expr\n        s[ name ] = untype subexpr for name, subexpr of s = result.states\n        result\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"146bc97b215a061d072d8941a83797052b58c6f4","subject":"form submit and error handling","message":"form submit and error handling\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-form\/client\/index.litcoffee","new_file":"packages\/shrub-form\/client\/index.litcoffee","new_contents":"# Form processing\n\n*Define a directive for Angular forms, and a service to cache and look them\nup later.*\n\n    _ = require 'lodash'\n    i8n = require 'inflection'\n\n    pkgman = require 'pkgman'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularDirective`.\n\n      registrar.registerHook 'shrubAngularDirective', -> [\n        '$compile', '$exceptionHandler', '$injector', '$log', '$q', 'shrub-form', 'shrub-require'\n        ($compile, $exceptionHandler, $injector, $log, $q, formService, require) ->\n\n          link: (scope, element, attrs) ->\n\nKeep a reference to the form scope, if the form attribute value changes, it'll\nneed to be rebuilt.\n\n###### TODO: It shouldn't be trashed as it is now, it should be moved over to a new scope non-destructively.\n\n            formScope = null\n            scope.$watch attrs.form, (form) ->\n              return unless form?\n\n              form.key ?= attrs.form\n\nGet the form's current values.\n\n              form.values = ->\n                values = {}\n\n                for name, field of form.fields\n                  widget = formService.widgets[field.type]\n                  if widget.extractValues?\n                    widget.extractValues field, values, formService\n                  else\n                    values[field.name] = field.value\n\n                return values\n\nNormalize form submits into an array.\n\n              form.submits = [form.submits] unless angular.isArray form.submits\n\nBuild a submit function which will be bound to ngSubmit.\n\n              (scope['$shrubSubmit'] ?= {})[form.key] = ($event) ->\n\nCall all the form submission handlers.\n\n                try\n\n                  values = form.values()\n\n                  promises = for submit in form.submits\n                    submit values, form, $event\n\n                  $q.all promises\n\n                catch error\n                  $exceptionHandler error\n\n#### Invoke hook `shrubFormAlter`.\n\n              pkgman.invokeFlat 'shrubFormAlter', form\n\n#### Invoke hook `shrubFormFormKeyAlter`.\n\n###### TODO: Multiline\n\n              pkgman.invokeFlat \"shrubForm#{pkgman.normalizePath form.key, true}Alter\", form\n\nCreate the form element.\n\n              $form = angular.element '<form \/>'\n              $form.addClass form.key\n\nDefault method to POST.\n\n              $form.attr 'method', attrs.method ? 'POST'\n              $form.attr 'data-ng-submit', \"$shrubSubmit['#{form.key}']($event)\"\n\nBuild the form fields.\n\n              for name, field of form.fields\n\nLook up the widget definition and warn if it doesn't exist.\n\n                unless (widget = formService.widgets[field.type])?\n\n###### TODO: Multiline\n\n                  $log.warn \"Form `#{form.key}` contains non-existent field type `#{field.type}`!\"\n                  continue\n\nDefault name to the key.\n\n                field.name ?= name\n\nHelper function to synchronize the field and model value.\n\n                do (field) -> field.syncModel = (scope) ->\n                  self = this\n\n                  return unless self.model?\n\n                  self.$modelDereg?()\n                  self.$modelDereg = null\n\n                  self.$valueDereg?()\n                  self.$valueDereg = null\n\n                  if self.model isnt 'field.value'\n\n                    self.$valueDereg = scope.$watch 'field.value', (value) ->\n                      scope.$eval \"#{self.model} = value\", value: value\n\n                    self.$modelDereg = scope.$watch self.model, (value) ->\n                      self.value = value\n\n                  return\n\n                $form.append \"\"\"\n\n    <div\n      data-#{widget.directive}\n      data-field=\"#{attrs.form}.fields['#{name}']\"\n      data-form=\"#{attrs.form}\"\n    ><\/div><span> <\/span>\n\n    \"\"\"\n\nAdd hidden form key to allow server-side interception\/processing.\n\n              $formKeyElement = angular.element '<input type=\"hidden\" \/>'\n              $formKeyElement.attr name: 'formKey', value: form.key\n              $form.append $formKeyElement\n\nRemove any old stuff.\n\n              if formScope\n                formScope.$destroy()\n                element.find('form').remove()\n\nInsert and compile the form element.\n\n              element.append $form\n              $compile($form) formScope = scope.$new()\n\nRegister the form in the system.\n\n              formService.cache form.key, formScope, $form\n\n      ]\n\n#### Implements hook `shrubAngularService`.\n\n      registrar.registerHook 'shrubAngularService', -> [\n\n        ->\n\n          service = forms: {}, widgets: {}\n\n## form.cache\n\n* (string) `key` - The form key.\n* (Scope) `scope` - The form's Angular scope.\n* (Element) `element` - The form's jqLite element.\n\n*Cache a form for later lookup.*\n\n          service.cache = (key, scope, element) ->\n            service.forms[key] = scope: scope, element: element\n\n#### Invoke hook `shrubFormWidgets`.\n\n          for formWidgets in pkgman.invokeFlat 'shrubFormWidgets'\n            formWidgets = [formWidgets] unless _.isArray formWidgets\n\n            for formWidget in formWidgets\n              continue unless formWidget.directive?\n              service.widgets[formWidget.type] = formWidget\n\n          service\n\n      ]\n\n      registrar.recur [\n        'widget\/checkbox'\n        'widget\/checkboxes'\n        'widget\/group'\n        'widget\/hidden'\n        'widget\/markup'\n        'widget\/radio'\n        'widget\/radios'\n        'widget\/submit'\n        'widget\/select'\n        'widget\/text'\n        'widget\/textarea'\n      ]\n","old_contents":"# Form processing\n\n*Define a directive for Angular forms, and a service to cache and look them\nup later.*\n\n    _ = require 'lodash'\n    i8n = require 'inflection'\n\n    pkgman = require 'pkgman'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularDirective`.\n\n      registrar.registerHook 'shrubAngularDirective', -> [\n        '$compile', '$injector', '$log', '$q', 'shrub-form', 'shrub-require'\n        ($compile, $injector, $log, $q, formService, require) ->\n\n          link: (scope, element, attrs) ->\n\nKeep a reference to the form scope, if the form attribute value changes, it'll\nneed to be rebuilt.\n\n###### TODO: It shouldn't be trashed as it is now, it should be moved over to a new scope non-destructively.\n\n            formScope = null\n            scope.$watch attrs.form, (form) ->\n              return unless form?\n\n              form.key ?= attrs.form\n\nNormalize form submits into an array.\n\n              form.submits = [form.submits] unless angular.isArray form.submits\n\nBuild a submit function which will be bound to ngSubmit.\n\n              (scope['$shrubSubmit'] ?= {})[form.key] = ($event) ->\n\nGather all the field values.\n\n                values = {}\n                for name, field of form.fields\n\n                  widget = formService.widgets[field.type]\n                  if widget.extractValues?\n                    widget.extractValues field, values, formService\n                  else\n                    values[field.name] = field.value\n\nCall all the form submission handlers.\n\n                $q.all (submit values, form, $event for submit in form.submits)\n\n#### Invoke hook `shrubFormAlter`.\n\n              pkgman.invokeFlat 'shrubFormAlter', form\n\n#### Invoke hook `shrubFormFormKeyAlter`.\n\n###### TODO: Multiline\n\n              pkgman.invokeFlat \"shrubForm#{pkgman.normalizePath form.key, true}Alter\", form\n\nCreate the form element.\n\n              $form = angular.element '<form \/>'\n              $form.addClass form.key\n\nDefault method to POST.\n\n              $form.attr 'method', attrs.method ? 'POST'\n              $form.attr 'data-ng-submit', \"$shrubSubmit['#{form.key}']($event)\"\n\nBuild the form fields.\n\n              for name, field of form.fields\n\nLook up the widget definition and warn if it doesn't exist.\n\n                unless (widget = formService.widgets[field.type])?\n\n###### TODO: Multiline\n\n                  $log.warn \"Form `#{form.key}` contains non-existent field type `#{field.type}`!\"\n                  continue\n\nDefault name to the key.\n\n                field.name ?= name\n\nHelper function to synchronize the field and model value.\n\n                do (field) -> field.syncModel = (scope) ->\n                  self = this\n\n                  return unless self.model?\n\n                  self.$modelDereg?()\n                  self.$modelDereg = null\n\n                  self.$valueDereg?()\n                  self.$valueDereg = null\n\n                  if self.model isnt 'field.value'\n\n                    self.$valueDereg = scope.$watch 'field.value', (value) ->\n                      scope.$eval \"#{self.model} = value\", value: value\n\n                    self.$modelDereg = scope.$watch self.model, (value) ->\n                      self.value = value\n\n                  return\n\n                $form.append \"\"\"\n\n    <div\n      data-#{widget.directive}\n      data-field=\"#{attrs.form}.fields['#{name}']\"\n      data-form=\"#{attrs.form}\"\n    ><\/div><span> <\/span>\n\n    \"\"\"\n\nAdd hidden form key to allow server-side interception\/processing.\n\n              $formKeyElement = angular.element '<input type=\"hidden\" \/>'\n              $formKeyElement.attr name: 'formKey', value: form.key\n              $form.append $formKeyElement\n\nRemove any old stuff.\n\n              if formScope\n                formScope.$destroy()\n                element.find('form').remove()\n\nInsert and compile the form element.\n\n              element.append $form\n              $compile($form) formScope = scope.$new()\n\nRegister the form in the system.\n\n              formService.cache form.key, formScope, $form\n\n      ]\n\n#### Implements hook `shrubAngularService`.\n\n      registrar.registerHook 'shrubAngularService', -> [\n\n        ->\n\n          service = forms: {}, widgets: {}\n\n## form.cache\n\n* (string) `key` - The form key.\n* (Scope) `scope` - The form's Angular scope.\n* (Element) `element` - The form's jqLite element.\n\n*Cache a form for later lookup.*\n\n          service.cache = (key, scope, element) ->\n            service.forms[key] = scope: scope, element: element\n\n#### Invoke hook `shrubFormWidgets`.\n\n          for formWidgets in pkgman.invokeFlat 'shrubFormWidgets'\n            formWidgets = [formWidgets] unless _.isArray formWidgets\n\n            for formWidget in formWidgets\n              continue unless formWidget.directive?\n              service.widgets[formWidget.type] = formWidget\n\n          service\n\n      ]\n\n      registrar.recur [\n        'widget\/checkbox'\n        'widget\/checkboxes'\n        'widget\/group'\n        'widget\/hidden'\n        'widget\/markup'\n        'widget\/radio'\n        'widget\/radios'\n        'widget\/submit'\n        'widget\/select'\n        'widget\/text'\n        'widget\/textarea'\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c7a47de459b9f459bc4e23808e2e09074d597ea4","subject":"ensure property.error only emits to root","message":"ensure property.error only emits to root\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object[Symbol.for('property')]` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    equal    = require('deep-equal')\n    Emitter  = require('events').EventEmitter\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n    kProp    = Symbol.for('property')\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: undefined\n          parent: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n          attached: false\n          changed: false\n          changes: new Set\n          \n        Object.setPrototypeOf @state, Emitter.prototype\n\n        @schema.kind ?= 'anydata'\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n        # expose the BoundThis for the set\/get\n        @set.bound = @get.bound = this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      debug: -> debug @uri, arguments...\n      \n      delegate @prototype, 'state'\n        .method 'once'\n        .method 'on'\n        .access 'container'\n        .access 'parent'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n        .getter 'prev'\n        .getter 'attached'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, { force: true, suppress: true }\n\n      @property 'active',\n        get: -> @enumerable or @binding?\n\n      @property 'changed',\n        get: -> @state.changed\n\n      @property 'change',\n        get: -> @content\n          \n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n      \n      @property 'children',\n        get: ->\n          return [] unless @content instanceof Object\n          children = []\n          for own k of @content\n            desc = Object.getOwnPropertyDescriptor(@content, k)\n            children.push desc.get.bound if desc?.get?.bound instanceof Property\n          return children\n      \n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> [ @parent?.uri, @name ].join '\/'\n\n## Instance-level methods\n\n      clone: ->\n        @debug \"[clone] cloning with #{@children.length} properties\"\n        copy = (new @constructor @name, @schema)\n        copy.state[k] = v for k, v of @state\n        return copy\n\n      clean: ->\n        if @changed\n          child.clean() for child in @children\n          @state.changes.clear()\n          @state.changed = false\n        \n      emit: (event) ->\n        @state.emit arguments...\n        unless this is @root\n          @debug \"[emit] '#{event}' to '#{@root.name}'\"\n          @root.emit arguments...\n\n### join (obj, ctx)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      join: (obj, ctx={}) ->\n        return obj unless obj instanceof Object\n        { property: parent, state: opts } = ctx\n        opts ?= { replace: false, suppress: false, force: false }\n\n        detached = true unless @container?\n        @container = obj\n        @parent = parent ? obj[kProp]\n\n        # if joining for the first time, apply existing data unless explicit replace\n        if detached and opts.replace isnt true\n          @debug \"[join] applying existing data for #{@name} to:\"\n          @debug obj\n          opts.suppress = true\n          @set obj[@name], opts\n\n        # TODO: should produce meaningful warning?\n        try Object.defineProperty obj, @name, this\n        @state.attached = true\n        @debug \"[join] attached into #{obj.constructor.name} container\"\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern) -> switch\n        when pattern?\n          try match = @find pattern\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].content\n            when match.length > 1  then match.map (x) -> x.content\n            else undefined\n        when @binding?\n          try return @binding.call @context\n          catch e\n            throw @error \"issue executing registered function binding during get(): #{e.message}\", e\n        else @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        { force = false, suppress = false, actor } = opts\n        @clean()\n        @debug \"[set] enter with:\"\n        @debug value\n        #@debug opts\n\n        return this if value? and equal(value, @content)\n        unless @mutable or not value? or force\n          throw @error \"cannot set data on read-only (config false) element\"\n        return @remove opts if value is null and @kind isnt 'leaf'\n\n        @debug \"[set] applying schema...\"\n        ctx = @context.with(opts).with(suppress: true)\n        value = switch\n          when not @mutable\n            @schema.validate value, ctx\n          when @schema.apply?\n            @schema.apply value, ctx\n          else value\n        return this if value instanceof Error\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        \n        if @binding?.length is 1 and not force\n          try @binding.call ctx, value \n          catch e\n            @debug e\n            throw @error \"issue executing registered function binding during set(): #{e.message}\", e\n        else\n          @state.value = value\n\n        # TODO: do we need this block?\n        if @container?.hasOwnProperty @name\n          Object.defineProperty @container, @name,\n            configurable: @state.configurable\n            enumerable: @state.enumerable\n\n        @state.changed = true\n        @emit 'update', this, actor unless suppress\n        @debug \"[set] completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={}) ->\n        opts.merge = true\n        opts.replace ?= true\n        @set value, opts\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@container` parent object.\n      \n      remove: (opts={}) ->\n        { suppress, actor } = opts\n        @state.enumerable = false\n        @state.value = null\n        return this unless @container?\n        Object.defineProperty @container, @name, enumerable: false\n        \n        @emit 'update', this, actor unless suppress\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        unless pattern instanceof XPath\n          if \/^\\.\\.\\\/\/.test(pattern) and @parent?\n            return @parent.find pattern.replace(\/^\\.\\.\\\/\/, ''), opts\n          if \/^\\\/\/.test(pattern) and this isnt @root\n            return @root.find pattern, opts\n          pattern = XPath.parse pattern, @schema\n          \n        @debug \"[find] using #{pattern}\"\n        if opts.root or not @container? or pattern.tag not in [ '\/', '..' ]\n          @debug \"[find] apply #{pattern}\"\n          pattern.apply(@content).props ? []\n        else switch\n          when pattern.tag is '\/'  and @parent? then @parent.find pattern, opts\n          when pattern.tag is '..' and @parent? then @parent.find pattern.xpath, opts\n          else []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n            \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx) ->\n        unless err instanceof Error\n          err = new Error err\n        err.name = 'PropertyError'\n        err.path = @path\n        err.prop = this\n        err.context = ctx\n        @root.emit 'error', err\n        return err\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          xpath:  @path.toString()\n          schema: @schema.toJSON? tag: false, extended: true\n          active: @active\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (tag=false) ->\n        copy = (src, ctx) ->\n          return unless src? and typeof src isnt 'function'\n          return if ctx? and ctx.kind is 'anydata'\n          if typeof src is 'object'\n            prop = src[kProp]\n            try res = new src.constructor\n            catch then res = {}\n            for own k, v of src when typeof v isnt 'function'\n              res[k] = copy v, prop?.in(k)\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        if tag\n          name = @schema.datakey ? @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nThe `Property` instances attach themselves to the `Object[Symbol.for('property')]` property\nand are rarely accessed directly - but they are the **fundamental**\nactors that *actualize* YANG schema compliance into ordinary JS\nobjects.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\nprops | array(Property) | computed | returns children Property instances\nkey   | string\/number | computed | conditionally returns unique key for Property if a list item\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    equal    = require('deep-equal')\n    Emitter  = require('events').EventEmitter\n    context  = require '.\/context'\n    XPath    = require '.\/xpath'\n    kProp    = Symbol.for('property')\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (@name, @schema={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        @state = \n          value: undefined\n          parent: null\n          container: null\n          configurable: true\n          enumerable: @binding?\n          mutable: @schema.config?.valueOf() isnt false\n          attached: false\n          changed: false\n          changes: new Set\n          \n        Object.setPrototypeOf @state, Emitter.prototype\n\n        @schema.kind ?= 'anydata'\n          \n        # Bind the get\/set functions to call with 'this' bound to this\n        # Property instance.  This is needed since native Object\n        # Getter\/Setter uses the Object itself as 'this'\n        @set = @set.bind this\n        @get = @get.bind this\n        # expose the BoundThis for the set\/get\n        @set.bound = @get.bound = this\n\n        # soft freeze this instance\n        Object.preventExtensions this\n\n      debug: -> debug @uri, arguments...\n      \n      delegate @prototype, 'state'\n        .method 'once'\n        .method 'on'\n        .access 'container'\n        .access 'parent'\n        .getter 'configurable'\n        .getter 'enumerable'\n        .getter 'mutable'\n        .getter 'prev'\n        .getter 'attached'\n\n      delegate @prototype, 'schema'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'binding'\n\n### Computed Properties\n\n      @property 'content',\n        get: -> @state.value\n        set: (value) -> @set value, { force: true, suppress: true }\n\n      @property 'active',\n        get: -> @enumerable or @binding?\n\n      @property 'changed',\n        get: -> @state.changed\n\n      @property 'change',\n        get: -> @content\n          \n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n      \n      @property 'children',\n        get: ->\n          return [] unless @content instanceof Object\n          children = []\n          for own k of @content\n            desc = Object.getOwnPropertyDescriptor(@content, k)\n            children.push desc.get.bound if desc?.get?.bound instanceof Property\n          return children\n      \n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> [ @parent?.uri, @name ].join '\/'\n\n## Instance-level methods\n\n      clone: ->\n        @debug \"[clone] cloning with #{@children.length} properties\"\n        copy = (new @constructor @name, @schema)\n        copy.state[k] = v for k, v of @state\n        return copy\n\n      clean: ->\n        if @changed\n          child.clean() for child in @children\n          @state.changes.clear()\n          @state.changed = false\n        \n      emit: (event) ->\n        @state.emit arguments...\n        unless this is @root\n          @debug \"[emit] '#{event}' to '#{@root.name}'\"\n          @root.emit arguments...\n\n### join (obj, ctx)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      join: (obj, ctx={}) ->\n        return obj unless obj instanceof Object\n        { property: parent, state: opts } = ctx\n        opts ?= { replace: false, suppress: false, force: false }\n\n        detached = true unless @container?\n        @container = obj\n        @parent = parent ? obj[kProp]\n\n        # if joining for the first time, apply existing data unless explicit replace\n        if detached and opts.replace isnt true\n          @debug \"[join] applying existing data for #{@name} to:\"\n          @debug obj\n          opts.suppress = true\n          @set obj[@name], opts\n\n        # TODO: should produce meaningful warning?\n        try Object.defineProperty obj, @name, this\n        @state.attached = true\n        @debug \"[join] attached into #{obj.constructor.name} container\"\n        return obj\n\n### get (pattern)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `pattern` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (pattern) -> switch\n        when pattern?\n          try match = @find pattern\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].content\n            when match.length > 1  then match.map (x) -> x.content\n            else undefined\n        when @binding?\n          try return @binding.call @context\n          catch e\n            throw @error \"issue executing registered function binding during get(): #{e.message}\", e\n        else @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        { force = false, suppress = false, actor } = opts\n        @clean()\n        @debug \"[set] enter with:\"\n        @debug value\n        #@debug opts\n\n        return this if value? and equal(value, @content)\n        unless @mutable or not value? or force\n          throw @error \"cannot set data on read-only (config false) element\"\n        return @remove opts if value is null and @kind isnt 'leaf'\n\n        @debug \"[set] applying schema...\"\n        ctx = @context.with(opts).with(suppress: true)\n        value = switch\n          when not @mutable\n            @schema.validate value, ctx\n          when @schema.apply?\n            @schema.apply value, ctx\n          else value\n        return this if value instanceof Error\n\n        @state.prev = @state.value\n        @state.enumerable = value? or @binding?\n        \n        if @binding?.length is 1 and not force\n          try @binding.call ctx, value \n          catch e\n            @debug e\n            throw @error \"issue executing registered function binding during set(): #{e.message}\", e\n        else\n          @state.value = value\n\n        # TODO: do we need this block?\n        if @container?.hasOwnProperty @name\n          Object.defineProperty @container, @name,\n            configurable: @state.configurable\n            enumerable: @state.enumerable\n\n        @state.changed = true\n        @emit 'update', this, actor unless suppress\n        @debug \"[set] completed\"\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={}) ->\n        opts.merge = true\n        opts.replace ?= true\n        @set value, opts\n\n### remove\n\nThe reverse of [join](#join-obj), it will detach itself from the\n`@container` parent object.\n      \n      remove: (opts={}) ->\n        { suppress, actor } = opts\n        @state.enumerable = false\n        @state.value = null\n        return this unless @container?\n        Object.defineProperty @container, @name, enumerable: false\n        \n        @emit 'update', this, actor unless suppress\n        return this\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        unless pattern instanceof XPath\n          if \/^\\.\\.\\\/\/.test(pattern) and @parent?\n            return @parent.find pattern.replace(\/^\\.\\.\\\/\/, ''), opts\n          if \/^\\\/\/.test(pattern) and this isnt @root\n            return @root.find pattern, opts\n          pattern = XPath.parse pattern, @schema\n          \n        @debug \"[find] using #{pattern}\"\n        if opts.root or not @container? or pattern.tag not in [ '\/', '..' ]\n          @debug \"[find] apply #{pattern}\"\n          pattern.apply(@content).props ? []\n        else switch\n          when pattern.tag is '\/'  and @parent? then @parent.find pattern, opts\n          when pattern.tag is '..' and @parent? then @parent.find pattern.xpath, opts\n          else []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n            \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx) ->\n        unless err instanceof Error\n          err = new Error err\n        err.name = 'PropertyError'\n        err.path = @path\n        err.prop = this\n        err.context = ctx\n        @emit 'error', err\n        return err\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @schema.tag ? @name\n          kind:   @schema.kind\n          xpath:  @path.toString()\n          schema: @schema.toJSON? tag: false, extended: true\n          active: @active\n          readonly: not @mutable\n        }\n        \n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (tag=false) ->\n        copy = (src, ctx) ->\n          return unless src? and typeof src isnt 'function'\n          return if ctx? and ctx.kind is 'anydata'\n          if typeof src is 'object'\n            prop = src[kProp]\n            try res = new src.constructor\n            catch then res = {}\n            for own k, v of src when typeof v isnt 'function'\n              res[k] = copy v, prop?.in(k)\n            return res\n          src.constructor.call src, src\n        value = copy @get()\n        if tag\n          name = @schema.datakey ? @name\n          \"#{name}\": value\n        else value\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"20959e47d5b54b945599502fccf2da03a4c47d7e","subject":"do not bypass set binding when called with opt.force = true","message":"do not bypass set binding when called with opt.force = true\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    Yang     = require '.\/yang'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (spec={}) ->\n        # NOTE: ES6\/CS2 does not support below\n        # unless this instanceof Property then return new Property arguments...\n\n        # 1. parse if spec is YANG definition (string)\n        spec = Yang.parse spec if typeof spec is 'string'\n        \n        # 2. assign if spec is an instance of Yang schema\n        schema = spec if spec instanceof Yang\n        \n        # 3. destructure spec as an object if not schema as instance\n        { name, schema } = spec unless schema?\n        \n        # 4. parse if schema is YANG definition (string)\n        schema = Yang.parse schema if typeof schema is 'string'\n        schema ?= kind: 'anydata'\n\n        # 5. initialize property instance\n        @name = name ? schema.datakey\n        @schema = schema\n        @state = \n          parent:   null\n          strict:   false\n          private:  false\n          mutable:  `schema.config != false`\n          attached: false\n          changed:  false\n          locked:   false\n          prior:    undefined\n          value:    undefined\n\n        # 6. soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'parent'\n        .access 'strict'\n        .getter 'private'\n        .getter 'mutable'\n        .getter 'attached'\n        .getter 'changed'\n        .getter 'locked'\n        .getter 'prior'\n        .getter 'value'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'value',\n        get: -> @state.value\n\n      @property 'data',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> switch\n          when @binding?.get? then @binding.get @context\n          else @value\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @data\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.opts = {}\n          ctx.node = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor this\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      debug: -> debug @uri, arguments...\n      \n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@data`.\n\nIt also provides special handling based on different types of\n`@data` currently held.\n\n      get: (key) -> switch\n        when key?\n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].data\n            when match.length > 1  then match.map (x) -> x.data\n            else undefined\n        else @data\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        opts.origin ?= this\n        \n        # @debug \"[set] enter...\"\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n\n        try value = @binding.set @context.with(opts), value if @binding?.set?\n        catch e\n          throw @error \"failed executing set() binding: #{e.message}\", e\n\n        return this if value? and @equals value, @value # return if same value\n        \n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        @debug \"[set] applying schema...\"        \n        value = switch\n          when @schema.apply? and not bypass\n            subopts = Object.assign {}, opts, inner: true, suppress: true\n            @schema.apply value, this, subopts\n          else value\n        @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error\n        return this if value? and @equals value, @value # return if same value\n        @update value, opts\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@value` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if value is null\n        return @set value, opts\n\n### delete\n\n      delete: (opts={}) ->\n        opts.origin ?= this\n        return this if @state.value is null\n        if not opts.force and @binding?.delete?\n          try @binding.delete @context.with(opts), null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @update null, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n        @state.prior ?= @state.value unless @locked\n        @state.changed = @state.changed or (@state.value isnt value)\n        @state.value = value\n        @parent?.update this, opts # unless opts.suppress\n        return this\n\n### commit async transaction\n\nCommits the changes to the data model. Called *once* for each node that\nis part of the change branch.\n\n      commit: (opts={}) ->\n        opts.origin ?= this\n        return true unless @changed\n        try\n          @state.locked = true\n          # 1. perform save binding\n          @debug \"[commit] execute commit binding (if any)...\" unless opts.sync\n          await @binding?.commit? @context.with(opts) unless opts.sync\n          # 2. if has parent, then wait for parent commited before updating changed state\n          promise = @parent?.commit? opts\n            .then (ok) =>\n              if ok\n                @state.prior = undefined\n                @state.changed = false\n          unless promise?\n            @state.prior = undefined\n            @state.changed = false\n        catch err\n          @debug \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          throw @error err\n        finally\n          @state.locked = false\n          \n        return true\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @debug \"[revert] changing back to:\", @state.prior\n        temp = @state.value\n        unless @state.prior?\n          @delete opts\n        else\n          @state.value = @state.prior\n        @state.prior = temp # preserve what we were trying to change to within commit context\n\n        @debug \"[revert] execute binding...\" unless opts.sync\n        try await @binding?.commit? @context.with(opts) unless opts.sync\n        catch err\n          @debug \"[revert] failed due to #{err.message}\"\n          throw @error err\n          \n        @state.prior = undefined\n        @state.changed = false\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        unless @attached\n          # @debug \"[attach] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n\n          @set obj[name], Object.assign {}, opts, inner: true, suppress: true\n\n        unless opts.preserve\n          try Object.defineProperty obj, @name,\n              configurable: true\n              enumerable: @enumerable\n              get: (args...) => @get args...\n              set: (args...) => @set args...\n            \n        @state.attached = true\n        @debug \"[attach] attached into #{obj.constructor.name} container\"\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @data = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx) ->\n        err = new Error err unless err instanceof Error\n        err.uri ?= @uri\n        err.src ?= this\n        err.ctx ?= ctx\n        return err\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @data\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:    @name\n          kind:    @kind\n          path:    @path.toString()\n          active:  @active\n          private: @private\n          mutable: @mutable\n          changed: @changed\n          schema: switch\n            when @schema.uri?\n              uri:      @schema.uri\n              summary:  @schema.description?.tag\n              datakey:  @schema.datakey\n              datapath: @schema.datapath\n              external: @schema.external\n              children: @schema.children.map (x) -> x.uri\n            else false\n          value: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    Yang     = require '.\/yang'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (spec={}) ->\n        # NOTE: ES6\/CS2 does not support below\n        # unless this instanceof Property then return new Property arguments...\n\n        # 1. parse if spec is YANG definition (string)\n        spec = Yang.parse spec if typeof spec is 'string'\n        \n        # 2. assign if spec is an instance of Yang schema\n        schema = spec if spec instanceof Yang\n        \n        # 3. destructure spec as an object if not schema as instance\n        { name, schema } = spec unless schema?\n        \n        # 4. parse if schema is YANG definition (string)\n        schema = Yang.parse schema if typeof schema is 'string'\n        schema ?= kind: 'anydata'\n\n        # 5. initialize property instance\n        @name = name ? schema.datakey\n        @schema = schema\n        @state = \n          parent:   null\n          strict:   false\n          private:  false\n          mutable:  `schema.config != false`\n          attached: false\n          changed:  false\n          locked:   false\n          prior:    undefined\n          value:    undefined\n\n        # 6. soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'parent'\n        .access 'strict'\n        .getter 'private'\n        .getter 'mutable'\n        .getter 'attached'\n        .getter 'changed'\n        .getter 'locked'\n        .getter 'prior'\n        .getter 'value'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'value',\n        get: -> @state.value\n\n      @property 'data',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> switch\n          when @binding?.get? then @binding.get @context\n          else @value\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @data\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.opts = {}\n          ctx.node = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor this\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      debug: -> debug @uri, arguments...\n      \n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@data`.\n\nIt also provides special handling based on different types of\n`@data` currently held.\n\n      get: (key) -> switch\n        when key?\n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].data\n            when match.length > 1  then match.map (x) -> x.data\n            else undefined\n        else @data\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        opts.origin ?= this\n        \n        # @debug \"[set] enter...\"\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n\n        if not opts.force and @binding?.set?\n          try value = @binding.set @context.with(opts), value \n          catch e\n            throw @error \"failed executing set() binding: #{e.message}\", e\n\n        return this if value? and @equals value, @value # return if same value\n        \n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        @debug \"[set] applying schema...\"        \n        value = switch\n          when @schema.apply? and not bypass\n            subopts = Object.assign {}, opts, inner: true, suppress: true\n            @schema.apply value, this, subopts\n          else value\n        @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error\n        return this if value? and @equals value, @value # return if same value\n        @update value, opts\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@value` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if value is null\n        return @set value, opts\n\n### delete\n\n      delete: (opts={}) ->\n        opts.origin ?= this\n        return this if @state.value is null\n        if not opts.force and @binding?.delete?\n          try @binding.delete @context.with(opts), null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @update null, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n        @state.prior ?= @state.value unless @locked\n        @state.changed = @state.changed or (@state.value isnt value)\n        @state.value = value\n        @parent?.update this, opts # unless opts.suppress\n        return this\n\n### commit async transaction\n\nCommits the changes to the data model. Called *once* for each node that\nis part of the change branch.\n\n      commit: (opts={}) ->\n        opts.origin ?= this\n        return true unless @changed\n        try\n          @state.locked = true\n          # 1. perform save binding\n          @debug \"[commit] execute commit binding (if any)...\" unless opts.sync\n          await @binding?.commit? @context.with(opts) unless opts.sync\n          # 2. if has parent, then wait for parent commited before updating changed state\n          promise = @parent?.commit? opts\n            .then (ok) =>\n              if ok\n                @state.prior = undefined\n                @state.changed = false\n          unless promise?\n            @state.prior = undefined\n            @state.changed = false\n        catch err\n          @debug \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          throw @error err\n        finally\n          @state.locked = false\n          \n        return true\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @debug \"[revert] changing back to:\", @state.prior\n        temp = @state.value\n        unless @state.prior?\n          @delete opts\n        else\n          @state.value = @state.prior\n        @state.prior = temp # preserve what we were trying to change to within commit context\n\n        @debug \"[revert] execute binding...\" unless opts.sync\n        try await @binding?.commit? @context.with(opts) unless opts.sync\n        catch err\n          @debug \"[revert] failed due to #{err.message}\"\n          throw @error err\n          \n        @state.prior = undefined\n        @state.changed = false\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        unless @attached\n          # @debug \"[attach] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n\n          @set obj[name], Object.assign {}, opts, inner: true, suppress: true\n\n        unless opts.preserve\n          try Object.defineProperty obj, @name,\n              configurable: true\n              enumerable: @enumerable\n              get: (args...) => @get args...\n              set: (args...) => @set args...\n            \n        @state.attached = true\n        @debug \"[attach] attached into #{obj.constructor.name} container\"\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @data = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx) ->\n        err = new Error err unless err instanceof Error\n        err.uri ?= @uri\n        err.src ?= this\n        err.ctx ?= ctx\n        return err\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @data\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:    @name\n          kind:    @kind\n          path:    @path.toString()\n          active:  @active\n          private: @private\n          mutable: @mutable\n          changed: @changed\n          schema: switch\n            when @schema.uri?\n              uri:      @schema.uri\n              summary:  @schema.description?.tag\n              datakey:  @schema.datakey\n              datapath: @schema.datapath\n              external: @schema.external\n              children: @schema.children.map (x) -> x.uri\n            else false\n          value: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"3ced087e6ad46189f90f2b070153a5e4a565c956","subject":"move cache control later in the stack","message":"move cache control later in the stack\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/app.litcoffee","new_file":"src\/app.litcoffee","new_contents":"\n# Application Startup\n\nThis code starts up the application.\n\n## Configure\n\nFirst, include required modules.\n\n    express = require 'express'\n    exp3hbs = require 'express3-handlebars'\n    redis_store = require('connect-redis')(express)\n    config = require '.\/config\/config.js'\n    secrets = require '.\/config\/private.js'\n\nNext, initialize the application.\n\n    app = express()\n\nConfigure HBS to glue Express and Handlebars together with HTML file extensions\nfor templates.\n\n    app.set 'view engine', 'html'\n    exp3hbs_config =\n      defaultLayout: 'default',\n      extname: '.html'\n    app.engine 'html', exp3hbs(exp3hbs_config)\n\nConfigure Express to serve static files.\n\n    app.use express.static('public')\n\nInitialize a session for later use.  Associate session data with\n`res.locals.session`.\n\n    app.use express.cookieParser(secrets.session_key)\n    app.use express.session({\n      store: new redis_store({host: config.redis_host, port: config.redis_port, prefix: config.redis_prefix}),\n      secret: secrets.session_key,\n      maxAge: 86400000\n    })\n    app.use (req, res, next) ->\n      res.locals.session = req.session\n      next()\n\n## Cross-Site Request Forgeries\n\nAdd the CSRF submission protection middleware.  This generates\n`req.session.\\_csrf` and maps it to `res.locals.token` so it will be available\nin all templates as {{{token}}}.\n\nAnything other than a GET, HEAD, or OPTIONS will require a valid `\\_CSRF` field\nor else it will be rejected with a 403.\n\nMust be after sessions and before routers.\n\n    app.use express.bodyParser()\n    app.use express.csrf()\n    app.use (req, res, next) ->\n      res.locals.token = req.csrfToken()\n      next()\n\n## Database\n\nConnect to MongoDB through Mongoose and initialize models.\n\n    app.models = require('.\/lib\/models')(config)\n\n## Routes\n\nExecute routes module.\n\n    app.use (req, res, next) ->\n      if req.session.securityLevel\n        res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0')\n      next()\n\n    require('.\/lib\/routes')(app)\n\n## Errors\n\nExecute error handling module.\n\n    require('.\/lib\/error')(app)\n\n    # This must be the very last middleware added to the app\n    require('.\/lib\/error\/404')(app)\n\n## Startup\n\nFinally, start the server.\n\n    app.listen config.port\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","old_contents":"\n# Application Startup\n\nThis code starts up the application.\n\n## Configure\n\nFirst, include required modules.\n\n    express = require 'express'\n    exp3hbs = require 'express3-handlebars'\n    redis_store = require('connect-redis')(express)\n    config = require '.\/config\/config.js'\n    secrets = require '.\/config\/private.js'\n\nNext, initialize the application.\n\n    app = express()\n\nConfigure HBS to glue Express and Handlebars together with HTML file extensions\nfor templates.\n\n    app.set 'view engine', 'html'\n    exp3hbs_config =\n      defaultLayout: 'default',\n      extname: '.html'\n    app.engine 'html', exp3hbs(exp3hbs_config)\n\nConfigure Express to serve static files.\n\n    app.use express.static('public')\n\nInitialize a session for later use.  Associate session data with\n`res.locals.session`.\n\n    app.use express.cookieParser(secrets.session_key)\n    app.use express.session({\n      store: new redis_store({host: config.redis_host, port: config.redis_port, prefix: config.redis_prefix}),\n      secret: secrets.session_key,\n      maxAge: 86400000\n    })\n    app.use (req, res, next) ->\n      res.locals.session = req.session\n      if req.session.securityLevel\n        res.header('Cache-Control', 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0');\n      next()\n\n## Cross-Site Request Forgeries\n\nAdd the CSRF submission protection middleware.  This generates\n`req.session.\\_csrf` and maps it to `res.locals.token` so it will be available\nin all templates as {{{token}}}.\n\nAnything other than a GET, HEAD, or OPTIONS will require a valid `\\_CSRF` field\nor else it will be rejected with a 403.\n\nMust be after sessions and before routers.\n\n    app.use express.bodyParser()\n    app.use express.csrf()\n    app.use (req, res, next) ->\n      res.locals.token = req.csrfToken()\n      next()\n\n## Database\n\nConnect to MongoDB through Mongoose and initialize models.\n\n    app.models = require('.\/lib\/models')(config)\n\n## Routes\n\nExecute routes module.\n\n    require('.\/lib\/routes')(app)\n\n## Errors\n\nExecute error handling module.\n\n    require('.\/lib\/error')(app)\n\n    # This must be the very last middleware added to the app\n    require('.\/lib\/error\/404')(app)\n\n## Startup\n\nFinally, start the server.\n\n    app.listen config.port\n\n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"af0dcbfacb848bd342c82c4285dd04d624b88b27","subject":"Pass raw expr in to select.options","message":"Pass raw expr in to select.options\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-form\/client\/widget\/select.litcoffee","new_file":"packages\/shrub-form\/client\/widget\/select.litcoffee","new_contents":"# Form - Select\n\n    _ = require 'lodash'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `directive`.\n\n      registrar.registerHook 'directive', -> [\n        ->\n\n          scope: field: '=?'\n\n          template: '''\n\n    <div class=\"form-group\">\n\n      <label\n        data-ng-bind=\"field.label\"\n      ><\/label>\n\n      <select\n        class=\"form-control\"\n        name=\"{{field.name}}\"\n\n        data-ng-model=\"field.value\"\n        data-ng-required=\"field.required\"\n        data-ng-options=\"field.options\"\n      ><\/select>\n\n    <\/div>\n\n    '''\n\n      ]\n\n      assignToElement = (element, value) ->\n\n        element.find(\"option[value=\\\"#{value}\\\"]\").prop 'selected', true\n\n#### Implements hook `formWidgets`.\n\n      registrar.registerHook 'formWidgets', ->\n\n        widgets = []\n\n        widgets.push\n\n          type: 'select'\n          assignToElement: assignToElement\n          directive: 'shrub-form-widget-select'\n\n        widgets\n","old_contents":"# Form - Select\n\n    _ = require 'lodash'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `directive`.\n\n      registrar.registerHook 'directive', -> [\n        ->\n\n          scope: field: '=?'\n\n          template: '''\n\n    <div class=\"form-group\">\n\n      <label\n        data-ng-bind=\"field.label\"\n      ><\/label>\n\n      <select\n        class=\"form-control\"\n        name=\"{{field.name}}\"\n\n        data-ng-model=\"field.value\"\n        data-ng-required=\"field.required\"\n        data-ng-options=\"{{field.options}}\"\n      ><\/select>\n\n    <\/div>\n\n    '''\n\n      ]\n\n      assignToElement = (element, value) ->\n\n        element.find(\"option[value=\\\"#{value}\\\"]\").prop 'selected', true\n\n#### Implements hook `formWidgets`.\n\n      registrar.registerHook 'formWidgets', ->\n\n        widgets = []\n\n        widgets.push\n\n          type: 'select'\n          assignToElement: assignToElement\n          directive: 'shrub-form-widget-select'\n\n        widgets\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0e5d4ab21ccbbf46715fd2adca468f8704544e86","subject":"Refactor example.","message":"Refactor example.\n\nCode deduplication, improved default formatting.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.  Only desired label\/tick tightness is supplied as an option.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width, tightness = 5) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval:\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: switch @options.intervalType\n                when 'year' then timePoint.getFullYear().toString()\n                when 'month' then timePoint.getMonth().toString()\n                when 'week', 'day' then timePoint.getDate().toString()\n                when 'hour' then timePoint.getHours().toString()\n                when 'minute' then timePoint.getMinutes().toString()\n                when 'second' then timePoint.getSeconds().toString()\n                when 'millisecond' then \".#{ timePoint.getMilliseconds() }\"\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      timeAxisRedrerer = new TimeAxisRenderer()\n\nCode that draws builds and draws axis is also moved in a function:\n\n      makeAxis = ->\n        axisData = timeAxisMaker.formatAutomatic {start, end}, canvas.width, 25\n        timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nInitial drawing:\n\n      do makeAxis\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          do makeAxis\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          do makeAxis\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Information](#information)\n    1. [Authors](#authors)\n    2. [License](#license)\n    3. [Version history](#version-history)\n 8. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives ###\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description ###\n\nHere we try to implement a time axis visualization that would be more readable and at the same time more informative than conventional and widespread time axes.  The main two ideas are:\n * Representing days, months and years as intervals, as opposed to points in time.\n * Layering labels, keeping hours, minutes and seconds on one layer, and days to years on other layers.\n\n### Thoughts ###\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals (when a user zooms and drags a corresponding plot).\n\nMain points of usability of timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Notes for a reader\n\nIf something is not clear, please try to look in the [Dictionary](#dictionary) section first, where commonly used here terms are explained.  Also, there is a [Frequently Asked Questions](#frequently-asked-questions) section.  If something is still unclear or if you think you have found a bug or a mistake, please do not hesitate to write to [Eugene](https:\/\/github.com\/nasedil\/).\n\nTesting\n-------\n\nThe implementation should be tested.  We need to decide and implement testing system.\n\n### Visual test cases ###\n\nFinal version of this time axis implementation should work correctly in the following visual test cases:\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year and longer\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond and shorter\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features (ticks and text labels)\n\n### Unit test cases ###\n\nWe should try to unit-test our code.  Here is a draft of test cases.\n\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Portability ###\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we have an intermediate object as output of axis formatting, which could be rendered after with a chosen rendeder.  We also can port only one part of code into another library if we need this.  This object consists of features with their properties, for example lines with their coordinates.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\nThe two functions that are intended to be called are `TimeAxisMaker.formatAutomatic()`, which formats time axis into a dictionary that describes the look of axis, and one of the `TimeAxisRenderer.renderTo...` functions that render that data dictionary to a desired context.\n\n### The `TimeAxisMaker` class ###\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\nAll methods that build axes produce a dictionary with the following elements:\n * A list of lines which includes the following:\n    * List of ticks.  Each tick is a vertical line, its position horisontally corresponds some _edge time point_.\n    * A horizontal axis line.\n * A list of text labels.  Each label correspond to a time point or a time interval.\n\nAny tick should correspond to an _edge time point_, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example 2015 years, 2 months, 3 days and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter `options.intervalType`.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval, because a week can start one year and finish the next year.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what we mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nThe exported methods of the class are:\n * `formatAutomatic()`:  builds ticks and labels while automatically deciding what to display.  Only desired label\/tick tightness is supplied as an option.\n * `formatFixed()`:  builds ticks and labels with manual setting of parameters.  It should not be used directly, but by other methods, that will be written later.  Is used by `formatAutomatic()`.\n\nThe class definition start:\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor ####\n\nWhen an object of the class is created, the `options` parameter is passed to it, which is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks (for example, 3 or 6; could mean 3 or 6 hours, months distance between ticks).\n * `options.tickTailRatio`:  relative size of a tick upwards (so the length of the tick upwards will be `tickTailRatio * tickLength`).\n * `options.axisLineOffset`:  absolute offset downwards of the axis line.\n * `options.labelOffset`:  absolute offset downwards of labels.  A label is drawn centered horisontally and with 'top' baseline.\n\nIf some of these options are missing, defaults are supplied:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          tickTailRatio: options.tickTailRatio ? 0.2\n          axisLineOffset: options.axisLineOffset ? 0.0\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n          labelOffset: options.labelOffset ? 12\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\n#### The `formatAutomatic()` function ####\n\nA function that formats time axis.  It is done in two steps:  deciding which _edge time points_ should be used for formatting, and actual formatting.  The second step is done in the `formatFixed()` function.  The first step is done here.\n\nIt has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n * `tightness`:  a number that guides how tightly should be positioned ticks and labels.  Larger values mean more ticks and labels in the same interval.  __Note__:  in the current implementation this number correspoinds to a maximal number of labels shown.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatAutomatic: (interval, width, tightness = '5') ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nTo decide which interval between _edge time points_ should be used, we increase that interval until we have no more points than is allowed by `tightness`.  Intervals between edge points are defined by a combination of `intervalType` and `intervalMultiplier`.  We store such combinations in the `TimeAxisMaker.intervalsProgression` structure.  We put code that calculates approximate interval between time points for such a combination into the function `TimeAxisMaker.findNominalInterval()` (this is because we can have 28 to 31 days in a month etc).\n\n        intervalTypeIndex = 0\n        intervalMultiplierIndex = 0\n        currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n        while currentStepInterval * tightness < @intervalLength\n          intervalMultiplierIndex += 1\n          if intervalMultiplierIndex >= TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers.length\n            intervalTypeIndex += 1\n            intervalMultiplierIndex = 0\n          currentStepInterval = TimeAxisMaker.findNominalInterval(TimeAxisMaker.intervalsProgression[intervalTypeIndex].type, TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex])\n\n__Note__:  after finding suitable interval we maybe need to adjust it back.  I'm not sure, needs to be investigated.\n\n__Note__:  the stuff above is really ugly.  I need to do something with that.\n\nNow, after we have found right interval, we can call the `formatFixed()` function to do formatting for that interval:\n\n        @options.intervalType = TimeAxisMaker.intervalsProgression[intervalTypeIndex].type\n        @options.intervalMultiplier = TimeAxisMaker.intervalsProgression[intervalTypeIndex].multipliers[intervalMultiplierIndex]\n        @formatFixed(interval, width)\n\n#### The `formatFixed()` function ####\n\nA function that formats time axis.  It has two arguments:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width`:  the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatFixed: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them (but the coloring is not implemented yet).  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nSo we need to build a list of time points that correspond to the given `interval`.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements.  To transform time value into a horizontal coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We set tick length from baseline downwards to `@options.tickLength`, and `@options.tickLength * @options.tickTailRatio` upwards.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength * @options.tickTailRatio\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).  It spans the whole width of the given interval.\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: @options.axisLineOffset\n          y2: @options.axisLineOffset\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.labelOffset\n            text: switch @options.intervalType\n                when 'year' then timePoint.getFullYear().toString()\n                when 'month' then timePoint.getMonth().toString()\n                when 'week', 'day' then timePoint.getDate().toString()\n                when 'hour' then timePoint.getHours().toString()\n                when 'minute' then timePoint.getMinutes().toString()\n                when 'second' then timePoint.getSeconds().toString()\n                when 'millisecond' then \".#{ timePoint.getMilliseconds() }\"\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust horizontal coordinates of other items.\n\n_Note_: one could think of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into one dictionary and return it;  we store ticks and other lines in `lines` element of the dictionary.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function ####\n\nThis function returns a list of points that are needed to be displayed for an interval.  The following arguments are necessary:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when the interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need to display labels between time points, we need to find time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge time point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()` function:\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until we reach right end of the interval, using `findNextPoint()` function.  We move to that function code that gives next _edge time point_ for a supplied _edge time point_.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n\nThen we return the list of time points:\n\n        pointList\n\n#### The `findLeftTime()` function ####\n\nThe `findLeftTime()` function calculates the rightmost _edge time point_ for current `options.intervalType` such that it is not greater than a given point of time.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n\nTo calculate such value for years and months we just truncate them, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 January 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval values like years, months, and days are kept the same, while everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar issues.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start` (for example on 02-00 before daylight-saving and 02-00 after daylight-saving on the same day both lead to the same next point if `options.intervalMultiplier` is larger than 1).\n\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while nextTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function ####\n\nThis function calculates next _edge time point_ for current options assuming `timePoint` argument is _edge time point_.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted during leap or clock change.  Also we assume that leap or clock change is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n\nThe algorithm behind the function is simple:  for current `options.intervalType` it increments it by `options.intervalMultiplier` using `Date` methods.  Except for cases when we deal with hours and seconds, where we check if after incremental `options.intervalType` is divisible by `options.intervalMultiplier` (which should be the case).  If not, we adjust to the most suitable value, movinhg back or forward by one hour or second.\n\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function ####\n\nTo get horizontal coordinate of time point we use `@intervalLength` that we stored in `formatFixed()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixel\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `findNominalInterval()` function ####\n\nThis function returns the approximate length of interval between two consecutive edge time points for a given values of `intervalType` and `intervalMultiplier`.\n\nReturn value is in milliseconds.\n\n      @findNominalInterval: (intervalType, intervalMultiplier) ->\n        switch intervalType\n          when 'year'\n            millisecondsInYear = 1000*60*60*24*365\n            intervalMultiplier * millisecondsInYear\n          when 'month'\n            millisecondsInMonth = 1000*60*60*24*30\n            intervalMultiplier * millisecondsInMonth\n          when 'week'\n            millisecondsInWeek = 1000*60*60*24*7\n            intervalMultiplier * millisecondsInWeek\n          when 'day'\n            millisecondsInDay = 1000*60*60*24\n            intervalMultiplier * millisecondsInDay\n          when 'hour'\n            millisecondsInHour = 1000*60*60\n            intervalMultiplier * millisecondsInHour\n          when 'minute'\n            millisecondsInMinute = 1000*60\n            intervalMultiplier * millisecondsInMinute\n          when 'second'\n            intervalMultiplier * 1000\n          when 'millisecond'\n            intervalMultiplier\n\n__Note__:  should we optimize it here (both precalculate numbers and deduplicate code)?\n\n#### The `@intervalsProgression` property ####\n\nThis property defines intervals that are could be used for formatting of time axis.  It is an array of objects, each of objects has two keys:  'type' with value of `intervalType` and 'multipliers' with array of values for `intervalMultiplier`.\n\n      @intervalsProgression: [\n        {type: 'millisecond', multipliers: [1, 5, 10, 50, 100, 500]}\n        {type: 'second', multipliers: [1, 5, 15, 30]}\n        {type: 'minute', multipliers: [1, 5, 15, 30]}\n        {type: 'hour', multipliers: [1, 3, 6, 12]}\n        {type: 'day', multipliers: [1]}\n        {type: 'week', multipliers: [1]}\n        {type: 'month', multipliers: [1, 3, 6]}\n        {type: 'year', multipliers: [1, 5, 10, 50, 100, 500, 1000, 5000, 10000\n          50000, 100000, 1000000, 10000000, 100000000]}\n      ]\n\n### The `TimeAxisRenderer` class ####\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor ####\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function ####\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions of the `TimeAxisMaker` class)\n * `canvas` is an html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of canvas graphical context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.  To all line drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.  We include `roundFlag` boolean option to the `translateCoord` function to make rounding of coordinates optional there.\n\n        translateCoord = (coordX, coordY, roundFlag = true) =>\n          newX = left + coordX\n          newY = top + coordY\n          if roundFlag\n            newX = @roundForCanvas newX\n            newY = @roundForCanvas newY\n          newCoord = [newX, newY]\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          [x, y] = translateCoord(textLabel.x, textLabel.y, false)\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function ####\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code ###\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timeAxisMaker.formatAutomatic {start, end}, canvas.width\n      timeAxisRedrerer = new TimeAxisRenderer()\n      timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatAutomatic {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatAutomatic {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nInformation\n-----------\n\n### Authors ###\nEugene Petkevich, https:\/\/github.com\/nasedil\/\n\n### License ###\nTODO Decide on license.\n\n### Version history ###\nStill in alpha.\n\nNotes\n-----\n\n### Dictionary ###\n\nThe following terms are routinely used in this file:\n * _edge time point_:  a point of time that is usually displayed on time axis using tick and\/or label;  usually the right part of time is all zeroed (like 0 seconds; 0 minutes and seconds; 0 hours, minutes and seconds), and the rightmost non-zero value is a round number or is a mid-point (or several thirds, fourth, fifth, etc) of a time interval (for example 5 years; 3, or 6, or 12 hours; 30 minutes), or just an integer number.  The typical progression of edge time points would be:  00:05:00, 00:10:00, 00:15:00, 00:20:00, 00:25:00, ...\n\n### Frequently Asked Questions ###\nWant to ask a question?  Write to [Eugene](https:\/\/github.com\/nasedil\/)!\n\n### References\nNo references so far.\n\n### Notes related to only this file ###\n\nSeveral ideas:\n * What if instead of calculating formatting from scratch each time, change it from current?\n\n### Notes that should be moved away at some point ###\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"559ac226f22f8549393cb6fe58c09e56c21e0df3","subject":"cache yang.source","message":"cache yang.source\n","repos":"corenova\/yang-js","old_file":"src\/yang.litcoffee","new_file":"src\/yang.litcoffee","new_contents":"# Yang - evaluable schema expression\n\nThis module provides support for basic set of YANG schema modeling\nlanguage by using the built-in *extension* syntax to define additional\nschema language constructs. The actual YANG language [RFC\n6020](http:\/\/tools.ietf.org\/html\/rfc6020) specifications are loaded\ninside the [main module](.\/main.coffee).\n\nThis module is the **primary interface** for consumers of this\nlibrary.\n\n## Dependencies\n \n    debug  = require('debug')('yang:schema')\n    fs     = require 'fs'\n    path   = require 'path'\n    parser = require 'yang-parser'\n    indent = require 'indent-string'\n\n    Expression = require '.\/expression'\n    XPath = require '.\/xpath'\n\n## Class Yang\n\n    class Yang extends Expression\n      @scope:\n        extension: '0..n'\n        typedef:   '0..n'\n        module:    '0..n'\n        submodule: '0..n'\n\n## Class-level methods\n\n      @clear: ->\n        @module.splice(0,@module.length) if @module?\n        @submodule.splice(0,@submodule.length) if @submodule?\n\n### parse (schema)\n\nThis class-level routine performs recursive parsing of passed in\nstatement and sub-statements. It provides syntactic, semantic and\ncontextual validations on the provided schema and returns the final JS\nobject tree structure as hierarchical Yang expression instances.\n\nIf any validation errors are encountered, it will throw the\nappropriate error along with the context information regarding the\nerror.\n\n      @parse: (schema, opts={}) ->\n        opts.compile ?= true\n        try\n          schema = parser.parse schema if typeof schema is 'string'\n        catch e\n          e.offset = 50 unless e.offset > 50\n          offender = schema.slice e.offset-50, e.offset+50\n          offender = offender.replace \/\\s\\s+\/g, ' '\n          throw @error \"invalid YANG syntax detected around: '#{offender}'\", offender\n\n        unless schema instanceof Object\n          throw @error \"must pass in valid YANG schema\", schema\n\n        kind = switch\n          when !!schema.prf then \"#{schema.prf}:#{schema.kw}\"\n          else schema.kw\n        tag = schema.arg unless schema.arg is false\n\t\t\n        schema = (new this kind, tag).extends schema.substmts.map (x) => @parse x, compile: false\n        # perform final scoped constraint validation\n        for kind, constraint of schema.scope when constraint in [ '1', '1..n' ]\n          unless schema.hasOwnProperty kind\n            throw schema.error \"constraint violation for required '#{kind}' = #{constraint}\"\n        schema.compile() if opts.compile\n        return schema\n\nFor comprehensive overview on currently supported YANG statements,\nplease refer to\n[Compliance Report](..\/test\/yang-compliance-coverage.md) for the latest\n[RFC 6020](http:\/\/tools.ietf.org\/html\/rfc6020) YANG specification\ncompliance.\n\n### compose (data [, opts={}])\n\nThis call *accepts* any arbitrary JS object and it will attempt to\nconvert it into a structural `Yang` expression instance. It will\nanalyze the passed in JS data and perform best match mapping to an\nappropriate YANG schema representation to describe the input\ndata. This method will not be able to determine conditionals or any\nmeta-data to further constrain the data, but it should provide a good\nstarting point with the resulting `Yang` expression instance.\n\n      @compose: (data, opts={}) ->\n        unless data?\n          throw @error \"must supply input 'data' to compose\"\n\n        # explict compose\n        if opts.kind?\n          ext = Yang::lookup.call this, 'extension', opts.kind\n          unless ext instanceof Expression\n            throw @error \"unable to find requested '#{opts.kind}' extension\"\n          return ext.compose? data, opts\n\n        # implicit compose (dynamic discovery)\n        for ext in @extension when ext.compose instanceof Function\n          debug \"checking data if #{ext.tag}\"\n          res = ext.compose data, opts\n          return res if res instanceof Yang\n\nThis facility is a powerful construct to dynamically generate `Yang`\nschema from ordinary JS objects. For additional usage examples, please\nrefer to [Dynamic Composition](..\/TUTORIAL.md#dynamic-composition)\nsection in the [Getting Started Guide](..\/TUTORIAL.md).\n\n### resolve (from..., name)\n\nThis call is used to perform a search within the local filesystem to\nlocate a given YANG schema module by `name`. It will first check the\ncalling code's local [package.json](..\/package.json) to look for a\n`yang: { resolve: {} }` configuration section to identify where the\ntarget module can be found. If there is an entry defined, it will then\nfollow that reference - which may be a JS file, YANG schema text file,\nor another NPM module. If it is not found within the `yang: { resolve:\n{} }` configuration block or it fails to load the referenced\ndependency, it will then fallback to attempt to locate a YANG schema\ntext file in the same folder that the `resolve` request was made:\n`#{name}.yang`.\n\n      @resolve: (from..., name) ->\n        return null unless typeof name is 'string'\n        dir = from = switch\n          when from.length then from[0]\n          else path.resolve()\n        while not found? and dir != path.dirname dir\n          target = path.resolve dir, \"package.json\"\n          debug \"[resolve] #{name} in #{target}\"\n          try\n            pkginfo = JSON.parse(fs.readFileSync(target))\n            found = pkginfo.yang?.resolve?[name] ? pkginfo.models[name]\n          if found?\n            dir = path.dirname target\n            debug \"[resolve] #{name} check #{found} in #{dir}\"\n            unless !!path.extname found\n              from = null\n              if (found of (pkginfo.dependencies ? {})) or (found of (pkginfo.peerDependencies ? {}))\n                # due to npm changes, the dependency may be at\n                # higher in the directory tree instead of being at\n                # subdirectory\n                debug \"[resolve] check #{found} package for #{name}\"\n                pkgdir = dir\n                while not from? and pkgdir != path.dirname pkgdir\n                  pkgloc = path.resolve(pkgdir, 'node_modules', found)\n                  debug \"[resolve] look for #{found} package in #{pkgloc}\"\n                  if fs.existsSync pkgloc\n                    from = pkgloc\n                  pkgdir = path.dirname pkgdir unless from?\n              else\n                from = path.resolve dir, found\n              if fs.existsSync from\n                return @resolve from, name\n              else\n                found = @resolve found, name\n          if not found? and pkginfo?.name is name\n            found = path.dirname target\n          dir = path.dirname dir unless found?\n        file = switch\n          when not found? then path.resolve from, \"#{name}.yang\"\n          else path.resolve dir, found\n        debug \"[resolve] checking if #{file} exists\"\n        return if fs.existsSync file then file else null\n\n## Main constructor\n\nThis method can be called directly without the use of `new` keyword\nand will internally parse the provided schema and return a `bound\nfunction` which will invoke [eval](#eval-data-opts) when called.\n\n      constructor: (kind, tag, extension) ->\n        unless this instanceof Yang\n          [ schema, bindings ] = arguments\n          schema = Yang.parse schema unless schema instanceof Yang\n          return schema.bind bindings\n        return super\n        \n      @property 'source',\n        get: ->\n          @state.source ?= @lookup 'extension', @kind\n          @state.source or {}\n        set: (value) -> @state.source = value\n        \n      @property 'datakey',\n        get: -> switch\n          when @parent instanceof Yang and @parent.kind is 'module'\n            \"#{@parent.tag}:#{@tag}\"\n          when @parent instanceof Yang and @parent.kind is 'submodule'\n            \"#{@parent['belongs-to'].tag}:#{@tag}\"\n          when @node and @external and not @state.relative\n            \"#{@origin.root.tag}:#{@tag}\"\n          else @tag ? @kind\n\n      @property 'external',\n        get: -> @origin? and @origin.root isnt @root and @origin.root.kind is 'module'\n            \n      @property 'datapath',\n        get: -> switch\n          when @parent not instanceof Yang then ''\n          when @node then @parent.datapath + \"\/#{@datakey}\"\n          else @parent.datapath + \"\/#{@kind}(#{@datakey})\"\n                  \n      debug: -> debug \"[#{@uri}]\", arguments...\n      emit: (event, args...) ->\n        @emitter.emit arguments...\n        @root.emit event, this if event is 'change' and this isnt @root\n\n## Instance-level methods\n\n### compile (obj)\n\n      compile: ->\n        unless @source instanceof Expression\n          throw @error \"encountered unknown extension '#{@kind}'\"\n        super\n\n### bind (obj)\n\nEvery instance of `Yang` expression can be *bound* with control logic\nwhich will be used during [eval](#eval-data-opts) to produce schema\ninfused **adaptive data object**. This routine is *inherited* from\n[Class Expression](.\/expression.coffee).\n\nThis facility can be used to associate default behaviors for any\nelement in the configuration tree, as well as handler logic for\nvarious YANG statements such as *rpc*, *feature*, etc.\n\nThis call will return the original `Yang` expression instance with the\nnew bindings registered within the `Yang` expression hierarchy.\n\n      # bind() is inherited from Expression\n\nPlease refer to [Schema Binding](..\/TUTORIAL.md#schema-binding)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n### eval (data, opts={})\n\nEvery instance of `Yang` expression can be [eval](#eval-data-opts)\nwith arbitrary JS data input which will apply the schema against the\nprovided data and return a schema infused **adaptive** data object.\n\nThis is an extremely useful construct which brings out the true power\nof YANG for defining and governing arbitrary JS data structures.\n\nBasically, the input `data` will be YANG schema validated and\nconverted to a schema infused *adaptive data model* that dynamically\ndefines properties according to the schema expressions.\n\nIt currently supports the `opts.adaptive` parameter (default `false`)\nwhich establishes a persistent binding relationship with the governing\n`Yang` expression instance. This allows the generated model to\ndynamically **adapt** to any changes to the governing `Yang`\nexpression instance. Refer to below [extends](#extends-schema) section\nfor additional info on how the schema can be programmatically\nmodified.\n\n      eval: (data, ctx, opts={}) ->\n        if opts.adaptive is true\n          # TODO: this will break for 'module' which will return Model?\n          @once 'change', arguments.callee.bind(this, data, opts)\n        super\n\nPlease refer to [Working with Models](..\/TUTORIAL.md#working-with-models)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for special\nusage examples for `module` schemas.\n\n### validate (data, opts={})\n\nPerform schema correctness validation for the passed in `data`.  This\ndiffers from [eval](#eval-data-opts) in that the final data returned\nis not infused as dynamic data model using Property instances. It\nshould be used to perform a sanity check on the data if it will not\nbe programmatically modified.\n\nFor example, [Property](.\/property.litcoffee) instance uses `validate`\nwhen dealing with non-configurable data nodes `config false`. \n\n      validate: (data, ctx={}) ->\n        # XXX - for now, we just do the full apply...\n        return @apply data, ctx\n        \n        @compile() unless @resolved\n        @debug \"validating data to schema\"\n\n        try @predicate?.call this, data\n        catch e\n          throw @error \"predicate validation error: #{e}\", data\n\n        if @kind is 'list' and Array.isArray data\n          data = data.map (item) =>\n            if Array.isArray item\n              throw @error \"list item cannot be another array\"\n            @validate item\n        else\n          # TODO: consider appending '..' property here?\n          data[node.datakey] = node.validate data[node.datakey] for node in @nodes when data?\n\n        unless @nodes.length\n          data = this.apply data, ctx\n        else\n          data = attr.apply data, ctx for attr in @attrs\n          \n        return data\n\n### extends (schema...)\n\nEvery instance of `Yang` expression can be `extends` with additional\nYANG schema string(s) and it will automatically perform\n[parse](#parse-schema) of the provided schema text and update itself\naccordingly.\n\nThis action also triggers an event emitter which will *retroactively*\nadapt any previously [eval](#eval-data-opts) produced adaptive data\nmodel instances to react accordingly to the newly changed underlying\nschema expression(s).\n\n      # extends() is inherited from Element\n\n      merge: (elem) ->\n        unless elem instanceof Yang\n          throw @error \"cannot merge invalid element into Yang\", elem\n\n        switch elem.kind\n          when 'type'     then super elem, append: true\n          when 'argument' then super elem, replace: true\n          else super\n\nPlease refer to [Schema Extension](..\/TUTORIAL.md#schema-extension)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n      normalizePath: (ypath) ->\n        lastPrefix = null\n        prefix2module = (root, prefix) ->\n          return unless root.kind is 'module'\n          switch\n            when root.tag is prefix then prefix\n            when root.prefix.tag is prefix then root.tag\n            else\n              for m in root.import ? [] when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              modules = root.lookup 'module'\n              for m in modules when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              return prefix # return as-is...\n              \n        normalizeEntry = (x) =>\n          return x unless x? and !!x\n          match = x.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)(?:\\[.+\\])?$\/\n          unless match?\n            throw @error \"invalid path expression '#{x}' found in #{ypath}\"\n          [ prefix, target ] = [ match[1], match[2] ]\n          return switch\n            when not prefix? then target\n            when prefix is lastPrefix then target\n            else\n              lastPrefix = prefix\n              mname = prefix2module @root, prefix\n              \"#{mname}:#{target}\"\n        ypath = ypath.replace \/\\s\/g, ''\n        res = XPath.split(ypath).map(normalizeEntry).join('\/')\n        res = '\/' + res if \/^\\\/\/.test ypath\n        return res\n\n### locate (ypath)\n\nThis is an internal helper facility used to locate a given schema node\nwithin the `Yang` schema expression tree hierarchy. It supports a\nlimited version of XPATH-like expression to locate an explicit\nelement.\n\n      locate: (ypath) ->\n        # TODO: figure out how to eliminate duplicate code-block section\n        # shared with Element\n        return unless ypath?\n        \n        @debug \"locate enter for '#{ypath}'\"\n        if typeof ypath is 'string'\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = @normalizePath(ypath).split('\/').filter (e) -> !!e\n        else\n          [ key, rest... ] = ypath\n        @debug key\n        return this unless key? and key isnt '.'\n\n        if key is '..'\n          return @parent?.locate rest\n\n        match = key.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n        [ prefix, target ] = [ match[1], match[2] ]\n        if prefix? and this is @root\n          search = [target].concat(rest)\n          if (@tag is prefix) or (@lookup 'prefix', prefix)\n            @debug \"locate (local) '\/#{prefix}:#{search.join('\/')}'\"\n            return super search\n          for m in @import ? [] when m.tag is prefix or m.prefix.tag is prefix\n            @debug \"locate (external) '\/#{prefix}:#{search.join('\/')}'\"\n            return m.module.locate search\n          m = @lookup 'module', prefix\n          return m?.locate search\n\n        @debug \"checking #{target}\"\n        switch\n          when \/^{.+}$\/.test(target)\n            kind = 'grouping'\n            tag  = target.replace \/^{(.+)}$\/, '$1'\n          when \/^\\[.+\\]$\/.test(target)\n            kind = 'feature'\n            tag  = target.replace \/^\\[(.+)\\]$\/, '$1'\n          when \/^[^(]+\\([^)]*\\)$\/.test(target)\n            target = target.match \/^([^(]+)\\((.*)\\)$\/\n            [ kind, tag ] = [ target[1], target[2] ]\n            tag = undefined unless !!tag\n          when \/^\\<.+\\>$\/.test(target)\n            target = target.replace \/^\\<(.+)\\>$\/, '$1'\n            [ kind..., tag ]  = target.split ':'\n            [ tag, selector ] = tag.split '='\n            kind = kind[0] if kind?.length\n          else return super [key].concat rest\n            \n        @debug \"matching #{kind} #{tag}\"\n        match = @match kind, tag\n        return switch\n          when rest.length is 0 then match\n          when Array.isArray match then match.map((x) -> x.locate rest).filter(Boolean)\n          else match?.locate rest\n\n### match (kind, tag)\n\nThis is an internal helper facility used by [locate](#locate-ypath) and\n[lookup](.\/element.litcoffee#lookup-kind-tag) to test whether a given\nentity exists in the local schema tree.\n\n      # Yang Expression can support 'tag' with prefix to another module\n      # (or itself).\n      match: (kind, tag) ->\n        return super unless kind? and tag? and typeof tag is 'string'\n        res = super\n        return res if res?\n        \n        [ prefix..., arg ] = tag.split ':'\n        return unless prefix.length\n\n        @debug \"[match] with #{kind} #{tag}\"\n\n        prefix = prefix[0]\n        @debug \"[match] check if current module's prefix\"\n        if @root.tag is prefix or @root.prefix?.tag is prefix\n          return @root.match kind, arg\n\n        @debug \"[match] checking if submodule's parent\"\n        ctx = @lookup 'belongs-to'\n        if ctx?.prefix.tag is prefix\n          return ctx.module?.match kind, arg\n\n        @debug \"[match] check if one of current module's imports\"\n        imports = @root?.import ? []\n        for m in imports when m.prefix.tag is prefix\n          @debug \"[match] checking #{m.tag}\"\n          return m.module?.match kind, arg\n\n        @debug \"[match] check if one of available modules\"\n        module = @lookup 'module', prefix\n        return module.match kind, arg if module?\n\n### toString (opts={})\n\nThe current `Yang` expression will covert back to the equivalent YANG\nschema text format.\n\nAt first glance, this may not seem like a useful facility since YANG\nschema text is *generally known* before [parse](#parse-schema) but it\nbecomes highly relevant when you consider a given `Yang` expression\nprogramatically changing via [extends](#extends-schema).\n\nCurrently it supports `space` parameter which can be used to specify\nnumber of spaces to use for indenting YANG statement blocks.  It\ndefaults to **2** but when set to **0**, the generated output will\nomit newlines and other spacing for a more compact YANG output.\n\n      toString: (opts={ space: 2 }) ->\n        s = @kind\n        if @argument?\n          s += ' ' + switch @argument\n            when 'value' then switch\n              when Array.isArray(@tag) then \"'#{@tag.join(' ')}'\"\n              else \"'#{@tag}'\"\n            when 'text'\n              \"\\n\" + (indent '\"'+@tag+'\"', ' ', opts.space)\n            else @tag\n        sub =\n          @children\n            .filter (x) => x.parent is this\n            .map (x) -> x.toString opts\n            .join \"\\n\"\n        if !!sub\n          s += \" {\\n\" + (indent sub, ' ', opts.space) + \"\\n}\"\n        else\n          s += ';'\n        return s\n\n### toJSON\n\nThe current `Yang` expression will convert into a simple JS object\nformat.\n\n      # toJSON() is inherited from Element\n\n### valueOf\n\nThe current 'Yang' expression will convert into a primitive form for\ncomparision purposes.\n\n      valueOf: ->\n        switch @argument\n          when 'value','text' then @tag.valueOf()\n          else this\n\nPlease refer to [Schema Conversion](..\/TUTORIAL.md#schema-conversion)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n## Export Yang Class\n\n    module.exports = Yang\n","old_contents":"# Yang - evaluable schema expression\n\nThis module provides support for basic set of YANG schema modeling\nlanguage by using the built-in *extension* syntax to define additional\nschema language constructs. The actual YANG language [RFC\n6020](http:\/\/tools.ietf.org\/html\/rfc6020) specifications are loaded\ninside the [main module](.\/main.coffee).\n\nThis module is the **primary interface** for consumers of this\nlibrary.\n\n## Dependencies\n \n    debug  = require('debug')('yang:schema')\n    fs     = require 'fs'\n    path   = require 'path'\n    parser = require 'yang-parser'\n    indent = require 'indent-string'\n\n    Expression = require '.\/expression'\n    XPath = require '.\/xpath'\n\n## Class Yang\n\n    class Yang extends Expression\n      @scope:\n        extension: '0..n'\n        typedef:   '0..n'\n        module:    '0..n'\n        submodule: '0..n'\n\n## Class-level methods\n\n      @clear: ->\n        @module.splice(0,@module.length) if @module?\n        @submodule.splice(0,@submodule.length) if @submodule?\n\n### parse (schema)\n\nThis class-level routine performs recursive parsing of passed in\nstatement and sub-statements. It provides syntactic, semantic and\ncontextual validations on the provided schema and returns the final JS\nobject tree structure as hierarchical Yang expression instances.\n\nIf any validation errors are encountered, it will throw the\nappropriate error along with the context information regarding the\nerror.\n\n      @parse: (schema, opts={}) ->\n        opts.compile ?= true\n        try\n          schema = parser.parse schema if typeof schema is 'string'\n        catch e\n          e.offset = 50 unless e.offset > 50\n          offender = schema.slice e.offset-50, e.offset+50\n          offender = offender.replace \/\\s\\s+\/g, ' '\n          throw @error \"invalid YANG syntax detected around: '#{offender}'\", offender\n\n        unless schema instanceof Object\n          throw @error \"must pass in valid YANG schema\", schema\n\n        kind = switch\n          when !!schema.prf then \"#{schema.prf}:#{schema.kw}\"\n          else schema.kw\n        tag = schema.arg unless schema.arg is false\n\t\t\n        schema = (new this kind, tag).extends schema.substmts.map (x) => @parse x, compile: false\n        # perform final scoped constraint validation\n        for kind, constraint of schema.scope when constraint in [ '1', '1..n' ]\n          unless schema.hasOwnProperty kind\n            throw schema.error \"constraint violation for required '#{kind}' = #{constraint}\"\n        schema.compile() if opts.compile\n        return schema\n\nFor comprehensive overview on currently supported YANG statements,\nplease refer to\n[Compliance Report](..\/test\/yang-compliance-coverage.md) for the latest\n[RFC 6020](http:\/\/tools.ietf.org\/html\/rfc6020) YANG specification\ncompliance.\n\n### compose (data [, opts={}])\n\nThis call *accepts* any arbitrary JS object and it will attempt to\nconvert it into a structural `Yang` expression instance. It will\nanalyze the passed in JS data and perform best match mapping to an\nappropriate YANG schema representation to describe the input\ndata. This method will not be able to determine conditionals or any\nmeta-data to further constrain the data, but it should provide a good\nstarting point with the resulting `Yang` expression instance.\n\n      @compose: (data, opts={}) ->\n        unless data?\n          throw @error \"must supply input 'data' to compose\"\n\n        # explict compose\n        if opts.kind?\n          ext = Yang::lookup.call this, 'extension', opts.kind\n          unless ext instanceof Expression\n            throw @error \"unable to find requested '#{opts.kind}' extension\"\n          return ext.compose? data, opts\n\n        # implicit compose (dynamic discovery)\n        for ext in @extension when ext.compose instanceof Function\n          debug \"checking data if #{ext.tag}\"\n          res = ext.compose data, opts\n          return res if res instanceof Yang\n\nThis facility is a powerful construct to dynamically generate `Yang`\nschema from ordinary JS objects. For additional usage examples, please\nrefer to [Dynamic Composition](..\/TUTORIAL.md#dynamic-composition)\nsection in the [Getting Started Guide](..\/TUTORIAL.md).\n\n### resolve (from..., name)\n\nThis call is used to perform a search within the local filesystem to\nlocate a given YANG schema module by `name`. It will first check the\ncalling code's local [package.json](..\/package.json) to look for a\n`yang: { resolve: {} }` configuration section to identify where the\ntarget module can be found. If there is an entry defined, it will then\nfollow that reference - which may be a JS file, YANG schema text file,\nor another NPM module. If it is not found within the `yang: { resolve:\n{} }` configuration block or it fails to load the referenced\ndependency, it will then fallback to attempt to locate a YANG schema\ntext file in the same folder that the `resolve` request was made:\n`#{name}.yang`.\n\n      @resolve: (from..., name) ->\n        return null unless typeof name is 'string'\n        dir = from = switch\n          when from.length then from[0]\n          else path.resolve()\n        while not found? and dir != path.dirname dir\n          target = path.resolve dir, \"package.json\"\n          debug \"[resolve] #{name} in #{target}\"\n          try\n            pkginfo = JSON.parse(fs.readFileSync(target))\n            found = pkginfo.yang?.resolve?[name] ? pkginfo.models[name]\n          if found?\n            dir = path.dirname target\n            debug \"[resolve] #{name} check #{found} in #{dir}\"\n            unless !!path.extname found\n              from = null\n              if (found of (pkginfo.dependencies ? {})) or (found of (pkginfo.peerDependencies ? {}))\n                # due to npm changes, the dependency may be at\n                # higher in the directory tree instead of being at\n                # subdirectory\n                debug \"[resolve] check #{found} package for #{name}\"\n                pkgdir = dir\n                while not from? and pkgdir != path.dirname pkgdir\n                  pkgloc = path.resolve(pkgdir, 'node_modules', found)\n                  debug \"[resolve] look for #{found} package in #{pkgloc}\"\n                  if fs.existsSync pkgloc\n                    from = pkgloc\n                  pkgdir = path.dirname pkgdir unless from?\n              else\n                from = path.resolve dir, found\n              if fs.existsSync from\n                return @resolve from, name\n              else\n                found = @resolve found, name\n          if not found? and pkginfo?.name is name\n            found = path.dirname target\n          dir = path.dirname dir unless found?\n        file = switch\n          when not found? then path.resolve from, \"#{name}.yang\"\n          else path.resolve dir, found\n        debug \"[resolve] checking if #{file} exists\"\n        return if fs.existsSync file then file else null\n\n## Main constructor\n\nThis method can be called directly without the use of `new` keyword\nand will internally parse the provided schema and return a `bound\nfunction` which will invoke [eval](#eval-data-opts) when called.\n\n      constructor: (kind, tag, extension) ->\n        unless this instanceof Yang\n          [ schema, bindings ] = arguments\n          schema = Yang.parse schema unless schema instanceof Yang\n          return schema.bind bindings\n        return super\n        \n      @property 'source',\n        get: -> @state.source or (@lookup 'extension', @kind) or {}\n        set: (value) -> @state.source = value\n        \n      @property 'datakey',\n        get: -> switch\n          when @parent instanceof Yang and @parent.kind is 'module'\n            \"#{@parent.tag}:#{@tag}\"\n          when @parent instanceof Yang and @parent.kind is 'submodule'\n            \"#{@parent['belongs-to'].tag}:#{@tag}\"\n          when @node and @external and not @state.relative\n            \"#{@origin.root.tag}:#{@tag}\"\n          else @tag ? @kind\n\n      @property 'external',\n        get: -> @origin? and @origin.root isnt @root and @origin.root.kind is 'module'\n            \n      @property 'datapath',\n        get: -> switch\n          when @parent not instanceof Yang then ''\n          when @node then @parent.datapath + \"\/#{@datakey}\"\n          else @parent.datapath + \"\/#{@kind}(#{@datakey})\"\n                  \n      debug: -> debug \"[#{@uri}]\", arguments...\n      emit: (event, args...) ->\n        @emitter.emit arguments...\n        @root.emit event, this if event is 'change' and this isnt @root\n\n## Instance-level methods\n\n### compile (obj)\n\n      compile: ->\n        unless @source instanceof Expression\n          throw @error \"encountered unknown extension '#{@kind}'\"\n        super\n\n### bind (obj)\n\nEvery instance of `Yang` expression can be *bound* with control logic\nwhich will be used during [eval](#eval-data-opts) to produce schema\ninfused **adaptive data object**. This routine is *inherited* from\n[Class Expression](.\/expression.coffee).\n\nThis facility can be used to associate default behaviors for any\nelement in the configuration tree, as well as handler logic for\nvarious YANG statements such as *rpc*, *feature*, etc.\n\nThis call will return the original `Yang` expression instance with the\nnew bindings registered within the `Yang` expression hierarchy.\n\n      # bind() is inherited from Expression\n\nPlease refer to [Schema Binding](..\/TUTORIAL.md#schema-binding)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n### eval (data, opts={})\n\nEvery instance of `Yang` expression can be [eval](#eval-data-opts)\nwith arbitrary JS data input which will apply the schema against the\nprovided data and return a schema infused **adaptive** data object.\n\nThis is an extremely useful construct which brings out the true power\nof YANG for defining and governing arbitrary JS data structures.\n\nBasically, the input `data` will be YANG schema validated and\nconverted to a schema infused *adaptive data model* that dynamically\ndefines properties according to the schema expressions.\n\nIt currently supports the `opts.adaptive` parameter (default `false`)\nwhich establishes a persistent binding relationship with the governing\n`Yang` expression instance. This allows the generated model to\ndynamically **adapt** to any changes to the governing `Yang`\nexpression instance. Refer to below [extends](#extends-schema) section\nfor additional info on how the schema can be programmatically\nmodified.\n\n      eval: (data, ctx, opts={}) ->\n        if opts.adaptive is true\n          # TODO: this will break for 'module' which will return Model?\n          @once 'change', arguments.callee.bind(this, data, opts)\n        super\n\nPlease refer to [Working with Models](..\/TUTORIAL.md#working-with-models)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for special\nusage examples for `module` schemas.\n\n### validate (data, opts={})\n\nPerform schema correctness validation for the passed in `data`.  This\ndiffers from [eval](#eval-data-opts) in that the final data returned\nis not infused as dynamic data model using Property instances. It\nshould be used to perform a sanity check on the data if it will not\nbe programmatically modified.\n\nFor example, [Property](.\/property.litcoffee) instance uses `validate`\nwhen dealing with non-configurable data nodes `config false`. \n\n      validate: (data, ctx={}) ->\n        # XXX - for now, we just do the full apply...\n        return @apply data, ctx\n        \n        @compile() unless @resolved\n        @debug \"validating data to schema\"\n\n        try @predicate?.call this, data\n        catch e\n          throw @error \"predicate validation error: #{e}\", data\n\n        if @kind is 'list' and Array.isArray data\n          data = data.map (item) =>\n            if Array.isArray item\n              throw @error \"list item cannot be another array\"\n            @validate item\n        else\n          # TODO: consider appending '..' property here?\n          data[node.datakey] = node.validate data[node.datakey] for node in @nodes when data?\n\n        unless @nodes.length\n          data = this.apply data, ctx\n        else\n          data = attr.apply data, ctx for attr in @attrs\n          \n        return data\n\n### extends (schema...)\n\nEvery instance of `Yang` expression can be `extends` with additional\nYANG schema string(s) and it will automatically perform\n[parse](#parse-schema) of the provided schema text and update itself\naccordingly.\n\nThis action also triggers an event emitter which will *retroactively*\nadapt any previously [eval](#eval-data-opts) produced adaptive data\nmodel instances to react accordingly to the newly changed underlying\nschema expression(s).\n\n      # extends() is inherited from Element\n\n      merge: (elem) ->\n        unless elem instanceof Yang\n          throw @error \"cannot merge invalid element into Yang\", elem\n\n        switch elem.kind\n          when 'type'     then super elem, append: true\n          when 'argument' then super elem, replace: true\n          else super\n\nPlease refer to [Schema Extension](..\/TUTORIAL.md#schema-extension)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n      normalizePath: (ypath) ->\n        lastPrefix = null\n        prefix2module = (root, prefix) ->\n          return unless root.kind is 'module'\n          switch\n            when root.tag is prefix then prefix\n            when root.prefix.tag is prefix then root.tag\n            else\n              for m in root.import ? [] when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              modules = root.lookup 'module'\n              for m in modules when m.tag is prefix or m.prefix.tag is prefix\n                return m.tag\n              return prefix # return as-is...\n              \n        normalizeEntry = (x) =>\n          return x unless x? and !!x\n          match = x.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)(?:\\[.+\\])?$\/\n          unless match?\n            throw @error \"invalid path expression '#{x}' found in #{ypath}\"\n          [ prefix, target ] = [ match[1], match[2] ]\n          return switch\n            when not prefix? then target\n            when prefix is lastPrefix then target\n            else\n              lastPrefix = prefix\n              mname = prefix2module @root, prefix\n              \"#{mname}:#{target}\"\n        ypath = ypath.replace \/\\s\/g, ''\n        res = XPath.split(ypath).map(normalizeEntry).join('\/')\n        res = '\/' + res if \/^\\\/\/.test ypath\n        return res\n\n### locate (ypath)\n\nThis is an internal helper facility used to locate a given schema node\nwithin the `Yang` schema expression tree hierarchy. It supports a\nlimited version of XPATH-like expression to locate an explicit\nelement.\n\n      locate: (ypath) ->\n        # TODO: figure out how to eliminate duplicate code-block section\n        # shared with Element\n        return unless ypath?\n        \n        @debug \"locate enter for '#{ypath}'\"\n        if typeof ypath is 'string'\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = @normalizePath(ypath).split('\/').filter (e) -> !!e\n        else\n          [ key, rest... ] = ypath\n        @debug key\n        return this unless key? and key isnt '.'\n\n        if key is '..'\n          return @parent?.locate rest\n\n        match = key.match \/^(?:([._-\\w]+):)?([.{[<\\w][.,+_\\-}():>\\]\\w]*)$\/\n        [ prefix, target ] = [ match[1], match[2] ]\n        if prefix? and this is @root\n          search = [target].concat(rest)\n          if (@tag is prefix) or (@lookup 'prefix', prefix)\n            @debug \"locate (local) '\/#{prefix}:#{search.join('\/')}'\"\n            return super search\n          for m in @import ? [] when m.tag is prefix or m.prefix.tag is prefix\n            @debug \"locate (external) '\/#{prefix}:#{search.join('\/')}'\"\n            return m.module.locate search\n          m = @lookup 'module', prefix\n          return m?.locate search\n\n        @debug \"checking #{target}\"\n        switch\n          when \/^{.+}$\/.test(target)\n            kind = 'grouping'\n            tag  = target.replace \/^{(.+)}$\/, '$1'\n          when \/^\\[.+\\]$\/.test(target)\n            kind = 'feature'\n            tag  = target.replace \/^\\[(.+)\\]$\/, '$1'\n          when \/^[^(]+\\([^)]*\\)$\/.test(target)\n            target = target.match \/^([^(]+)\\((.*)\\)$\/\n            [ kind, tag ] = [ target[1], target[2] ]\n            tag = undefined unless !!tag\n          when \/^\\<.+\\>$\/.test(target)\n            target = target.replace \/^\\<(.+)\\>$\/, '$1'\n            [ kind..., tag ]  = target.split ':'\n            [ tag, selector ] = tag.split '='\n            kind = kind[0] if kind?.length\n          else return super [key].concat rest\n            \n        @debug \"matching #{kind} #{tag}\"\n        match = @match kind, tag\n        return switch\n          when rest.length is 0 then match\n          when Array.isArray match then match.map((x) -> x.locate rest).filter(Boolean)\n          else match?.locate rest\n\n### match (kind, tag)\n\nThis is an internal helper facility used by [locate](#locate-ypath) and\n[lookup](.\/element.litcoffee#lookup-kind-tag) to test whether a given\nentity exists in the local schema tree.\n\n      # Yang Expression can support 'tag' with prefix to another module\n      # (or itself).\n      match: (kind, tag) ->\n        return super unless kind? and tag? and typeof tag is 'string'\n        res = super\n        return res if res?\n        \n        [ prefix..., arg ] = tag.split ':'\n        return unless prefix.length\n\n        @debug \"[match] with #{kind} #{tag}\"\n\n        prefix = prefix[0]\n        @debug \"[match] check if current module's prefix\"\n        if @root.tag is prefix or @root.prefix?.tag is prefix\n          return @root.match kind, arg\n\n        @debug \"[match] checking if submodule's parent\"\n        ctx = @lookup 'belongs-to'\n        if ctx?.prefix.tag is prefix\n          return ctx.module?.match kind, arg\n\n        @debug \"[match] check if one of current module's imports\"\n        imports = @root?.import ? []\n        for m in imports when m.prefix.tag is prefix\n          @debug \"[match] checking #{m.tag}\"\n          return m.module?.match kind, arg\n\n        @debug \"[match] check if one of available modules\"\n        module = @lookup 'module', prefix\n        return module.match kind, arg if module?\n\n### toString (opts={})\n\nThe current `Yang` expression will covert back to the equivalent YANG\nschema text format.\n\nAt first glance, this may not seem like a useful facility since YANG\nschema text is *generally known* before [parse](#parse-schema) but it\nbecomes highly relevant when you consider a given `Yang` expression\nprogramatically changing via [extends](#extends-schema).\n\nCurrently it supports `space` parameter which can be used to specify\nnumber of spaces to use for indenting YANG statement blocks.  It\ndefaults to **2** but when set to **0**, the generated output will\nomit newlines and other spacing for a more compact YANG output.\n\n      toString: (opts={ space: 2 }) ->\n        s = @kind\n        if @argument?\n          s += ' ' + switch @argument\n            when 'value' then switch\n              when Array.isArray(@tag) then \"'#{@tag.join(' ')}'\"\n              else \"'#{@tag}'\"\n            when 'text'\n              \"\\n\" + (indent '\"'+@tag+'\"', ' ', opts.space)\n            else @tag\n        sub =\n          @children\n            .filter (x) => x.parent is this\n            .map (x) -> x.toString opts\n            .join \"\\n\"\n        if !!sub\n          s += \" {\\n\" + (indent sub, ' ', opts.space) + \"\\n}\"\n        else\n          s += ';'\n        return s\n\n### toJSON\n\nThe current `Yang` expression will convert into a simple JS object\nformat.\n\n      # toJSON() is inherited from Element\n\n### valueOf\n\nThe current 'Yang' expression will convert into a primitive form for\ncomparision purposes.\n\n      valueOf: ->\n        switch @argument\n          when 'value','text' then @tag.valueOf()\n          else this\n\nPlease refer to [Schema Conversion](..\/TUTORIAL.md#schema-conversion)\nsection of the [Getting Started Guide](..\/TUTORIAL.md) for usage\nexamples.\n\n## Export Yang Class\n\n    module.exports = Yang\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"567d83056a0e01e213e57dab88c1ef82a9445024","subject":"make compareClockwise more flexible","message":"make compareClockwise more flexible\n","repos":"ldegen\/geometry,ldegen\/geometry","old_file":"src\/compare-clockwise.litcoffee","new_file":"src\/compare-clockwise.litcoffee","new_contents":"This function can be used as a comparator to sort a number of nodes\nadjacent to some given point ``m`` in clockwise order relative to some\nreference point ``p``.\n\nImagine you are traversing the edges of a planar graph. You arive at ``m``\n(\"mid point\") via some other point ``p`` (\"parent\"), and you now want to\nvisit the other points (\"children\") connected to ``m`` in clockwise order.\nThis HOF answers the question given ``p`` and ``m`` as above, which of two\ngiven children ``a`` and ``b`` should be visit first. In particular, you\ncan use it with something like ``Array.prototype.sort`` to sort an\narray of children.\n\nThe implementation works like this:\n\nImagine a line through the `p` and `m`. Either both children are on\nthe same side, or they are on different sides.  If they are on different\nsides, the one on the left side comes first.\n\n    ccw = require(\".\/ccw\")\n    identity = (x)->x\n\n    module.exports = (p,m,vpos=identity)->\n      p=vpos p\n      m=vpos m\n      (a,b)->\n\n        a = vpos a\n        b = vpos b\n        # positive values indicate counter clockwise movement\n        # i.e. left side of parent.\n        ca = ccw(p,m,a)\n        cb = ccw(p,m,b)\n\n        if ca*cb < 0 # different sign, ergo different sides\n          if ca > 0 or cb < 0 then -1 else 1\n\nOtherwise, i.e. if both children are on the same side, we need another\ncomparison.\n\n        else ccw(m,a,b) # negative --> clockwise --> a is left\n","old_contents":"This function can be used as a comparator to sort a number of nodes\nadjacent to some given point ``m`` in clockwise order relative to some\nreference point ``p``.\n\nImagine you are traversing the edges of a planar graph. You arive at ``m``\n(\"mid point\") via some other point ``p`` (\"parent\"), and you now want to\nvisit the other points (\"children\") connected to ``m`` in clockwise order.\nThis HOF answers the question given ``p`` and ``m`` as above, which of two\ngiven children ``a`` and ``b`` should be visit first. In particular, you\ncan use it with something like ``Array.prototype.sort`` to sort an\narray of children.\n\nThe implementation works like this:\n\nImagine a line through the `p` and `m`. Either both children are on\nthe same side, or they are on different sides.  If they are on different\nsides, the one on the left side comes first.\n\n    ccw = require(\".\/ccw\")\n\n    module.exports = (p,m)->(a,b)->\n\n      # positive values indicate counter clockwise movement\n      # i.e. left side of parent.\n      ca = ccw(p,m,a)\n      cb = ccw(p,m,b)\n\n      if ca*cb < 0 # different sign, ergo different sides\n        if ca > 0 or cb < 0 then -1 else 1\n\nOtherwise, i.e. if both children are on the same side, we need another\ncomparison.\n\n      else ccw(m,a,b) # negative --> clockwise --> a is left\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"04f5fa581be263a093e0655c46d3b345e975a2ae","subject":"oops, remove duplicated stuff","message":"oops, remove duplicated stuff\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/05_set.litcoffee","new_file":"docs\/05_set.litcoffee","new_contents":"# Batman.Set\n\n`Set` is an observable, `Batman.Object` wrapper around `SimpleSet`. `Set` also extends [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html), which provides [many useful methods](\/docs\/api\/batman.enumerable.html).\n\n### SimpleSet vs Set\n\n`SimpleSet` and `Set` are two distinct classes in Batman. `SimpleSet` implements the basic set semantics, but it is *not* a `Batman.Object`, so properties on it (like its `length` or `toArray`) cannot be bound. `Set` is a `Batman.Object`, so it can be observed, and thus plays nicely with the accessor system. Use a `SimpleSet` only when you know nothing will need to be observed on the set you are creating, which usually isn't a valid assumption. If it is in fact valid, consider using a native array as well, as iteration and membership checks will be faster.\n\n## constructor(items...)\n\nWhen creating a `Set`, items forming the initial set can be passed as separate arguments to the constructor\n\n    test 'new Set constructor can be called without arguments', ->\n      set = new Batman.Set\n      deepEqual set.toArray(), []\n\n    test 'new Set constructor can be passed items to add to the set.', ->\n      set = new Batman.Set('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n## length : number\n\nA count of the items in a `Set` can be found at its `length` property.\n\n## isEmpty : boolean\n\nObservable property for `isEmpty()`\n\n## toArray : Array\n\nObservable property for `toArray()`. Whenever items are added or removed on the set, the `toArray` property will change. This is the mechanism by which Batman's view bindings get notified of collection updates.\n\n    test 'observers on the toArray property fire when the set changes', ->\n      results = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.observe('toArray', (newArray) -> results = newArray.sort())\n      deepEqual set.add('d'), ['d']\n      deepEqual results, ['a', 'b', 'c', 'd']\n      deepEqual set.remove('b'), ['b']\n      deepEqual results, ['a', 'c', 'd']\n\n## has(item) : Boolean\n\n`has` returns a boolean describing if the given `item` is a member of the set.\n\n_Note_: Using `has(item)` in an accessor body will register the set `has` is called upon as a source of the property being calculated. This so that whenever the set changes, the property will be recalculated, because the set may now have or not have the item in question.\n\n    test 'Set::has indicates if an item is a member of the set or not.', ->\n      set = new Batman.Set('a', 'b', 'c')\n      ok set.has('a')\n      equal set.has('d'), false\n\n    test 'Set::has registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @awards = new Batman.Set()\n\n        @accessor 'bestEver?', -> @get('awards').has('Stanley Cup')\n\n      result = null\n      team = new Team\n      team.observeAndFire 'bestEver?', (status) -> result = status\n      team.get('awards').add 'Eastern Conference Champs'\n      equal result, false\n      team.get('awards').add 'Stanley Cup'\n      equal result, true\n\n## add(items...)\n\n`add` adds 0 or more new items to the set. `add` returns an array of the items which have been newly added to the set, which is to say the intersection of the argument items and the set's complement before addition.\n\n`add` fires the `itemsWereAdded` event with the list of items newly added to the set if that list has length greater than 0. This is to say the event will not be fired if the items passed to add were all already members of the set.\n\n    test 'Set::add adds an item to the set', ->\n      set = new Batman.Set()\n      equal set.has('a'), false\n      deepEqual set.add('a'), ['a']\n      equal set.has('a'), true\n\n    test 'Set::add returns only the new items that weren\\'t previously in the set', ->\n      set = new Batman.Set('a', 'b')\n      deepEqual set.add('b','c','d').sort(), ['c', 'd']\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd']\n\n    test 'Set::add fires the itemsWereAdded event with the items newly added to the set', ->\n      results = null\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereAdded', (item) -> results = item)\n      set.add('b','c','d')\n      deepEqual results.sort(), ['c','d']\n\n    test 'Set::add does not fire the itemsWereAdded event if the added items were already in the set.', ->\n      results = undefined\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereAdded', (items) -> results = items)\n      set.add('a', 'b')\n      equal typeof results, 'undefined'\n\n## remove(items...)\n\n`remove` removes 0 or more items from the set. `remove` returns an array of the items which were successfully removed from the set, which is to say the intersection of the argument items and the set itself before removal.\n\n`remove` fires the `itemsWereRemoved` event with the list of removed items if that list has length greater than 0. This is to say the event will not be fired if none of the passed items were members of the set.\n\n    test 'Set::remove removes an item from the set', ->\n      set = new Batman.Set('a')\n      equal set.has('a'), true\n      deepEqual set.remove('a'), ['a']\n      equal set.has('a'), false\n\n    test 'Set::remove returns only the new items that were previously in the set', ->\n      set = new Batman.Set('a', 'b')\n      deepEqual set.remove('b','c','d').sort(), ['b']\n      deepEqual set.toArray(), ['a']\n\n    test 'Set::remove fires the itemsWereRemoved event with the items removed to the set', ->\n      results = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('b','c')\n      deepEqual results.sort(), ['b','c']\n\n    test 'Set::remove does not fire the itemsWereRemoved event if the removed items were not already members of the set.', ->\n      results = undefined\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('c', 'd')\n      equal typeof results, 'undefined'\n\n## find(testFunction : function) : [Object]\n\n`find` returns the first item within the set for which the `testFunction` called with the item returns `true`, or `undefined` if no item passes the test.\n\n_Note_: `find` returns the first item the test passes for, but since set iteration has no specified order, no guarantee can be made about which item will be returned if more than one item in the set passes the test. However, set iteration order is stable, so `find` called on the same set twice should return the same item.\n\n\n    test 'Set::find returns the first item for which the test function passes', ->\n      set = new Batman.Set(1, 2, 3)\n      equal set.find((x) -> x % 2 == 0), 2\n\n    test 'Set::find returns undefined if no items pass the test function', ->\n      set = new Batman.Set(1, 2, 3)\n      equal typeof set.find((x) -> x > 5), 'undefined'\n\n## forEach(iteratorFunction : function[, context: Object])\n\n`forEach` calls the `iteratorFunction` with each item in the set, optionally executing the `iteratorFunction` in the passed context. Returns `undefined`.\n\n_Note_: Set iteration order is not defined, thus Set client code cannot rely on one item being iterated over before another, regardless of when the Set's items were added. If you need an ordered set, Batman provides `SetSort` for exactly this, while including the added benefit of observability. If you need a one time ordering of a set, you can get the array representation with `toArray` and then use vanilla JavaScript `sort` on that array.\n\n_Note_: Using `forEach()` in an accessor body will register the set iterated over as a source of the property being calculated. This so that whenever the set changes, the property will be recalculated. This can become an issue if you iterate over a set and modify the set's items, as when the property recalculates that modification will potentially happen on items it's happened on previously.\n\n    test 'Set::forEach iterates over each item in the set', ->\n      sum = 0\n      set = new Batman.Set(1,2,3)\n      set.forEach (x) -> sum += x\n      equal sum, 6\n\n    test 'Set::forEach iterates over each item in the set optionally in the provided context', ->\n      context = {sum: 0}\n      set = new Batman.Set(1,2,3)\n      set.forEach((x) ->\n        @sum += x\n      , context)\n      equal context.sum, 6\n\n    test 'Set::forEach registers the set as a source if called in an accessor body', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @players = new Batman.Set()\n        @accessor 'willWinTheCup?', ->\n          sedinCount = 0\n          @players.forEach (player) ->\n            sedinCount++ if player.split(' ')[1] == 'Sedin'\n          sedinCount >= 2\n\n      result = null\n      team = new Team()\n      team.observeAndFire 'willWinTheCup?', (status) -> result = status\n      equal team.get('willWinTheCup?'), false\n      team.get('players').add 'Henrik Sedin'\n      equal result, false\n      team.get('players').add 'Daniel Sedin'\n      equal result, true\n\n## isEmpty() : boolean\n\n`isEmpty` returns a boolean: `true` if the set has no items, and `false` if it has any items.\n\n_Note_: Using `isEmpty()` in an accessor body will register the set `isEmpty` is called on as a source of the property being calculated, so that whenever the set changes the property will be recalculated.\n\n    test 'Set::isEmpty returns true if the set has no items', ->\n      set = new Batman.Set()\n      ok set.isEmpty()\n      set.add('a')\n      equal set.isEmpty(), false\n\n    test 'Set::isEmpty registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @games = new Batman.Set()\n        @accessor 'seasonStarted?', -> !@games.isEmpty()\n\n      team = new Team\n      equal team.get('seasonStarted?'), false\n      team.get('games').add({win: true})\n      equal team.get('seasonStarted?'), true\n\n## clear() : Array\n\n`clear` removes all items from a set. Returns an array of all the items in the set.\n\n`clear` will fire the `itemsWereRemoved` event once with all the items in the set.\n\n_Note_: Set iteration order is not defined, so the order of the array of items returned by `clear` is undefined.\n\n    test 'Set::clear empties the set', ->\n      set = new Batman.Set('a', 'b', 'c')\n      equal set.isEmpty(), false\n      deepEqual set.clear().sort(), ['a', 'b', 'c']\n      ok set.isEmpty()\n\n    test 'Set::clear fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.clear()\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## replace(collection : Enumerable) : Array\n\n`replace` removes all the items in a set and then adds all the items found in another `collection`. The other collection must have a `toArray` function which returns an array representation of the collection. Returns the array of items added.\n\n`replace` will fire the `itemsWereRemoved` event once with all the items in the set, and then the `itemsWereAdded` event once with the items from the incoming collection.\n\n    test 'Set::replace empties the set and then adds items from a different collection', ->\n      set = new Batman.Set('a', 'b', 'c')\n      secondSet = new Batman.Set('d', 'e', 'f')\n      set.replace(secondSet)\n      deepEqual set.toArray().sort(), ['d', 'e', 'f']\n\n    test 'Set::replace fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.replace(new Batman.SimpleSet())\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n    test 'Set::replace fires the itemsWereAdded event with all the items in the incoming set', ->\n      result = null\n      set = new Batman.Set()\n      set.on('itemsWereAdded', (items) -> result = items)\n      set.replace(new Batman.SimpleSet('a', 'b', 'c'))\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## toArray() : Array\n\n`toArray` returns an array representation of the set.\n\n_Note_: Set iteration order is not defined, so the order in which the set's items appear in the array is not defined. It is however stable, so the order of the items in two successive `toArray` calls where the set was not modified in between should be the same.\n\n_Note_: `toArray` is also an observable property.\n\n_Note_: Using `toArray()` in an accessor body will register the set `toArray` is called on as a source of the property being calculated, so that whenever the set changes the property will be recalculated.\n\n    test 'Set::toArray returns an array representation of the set', ->\n      set = new Batman.Set()\n      deepEqual set.toArray(), []\n      set.add('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n## merge(collections... : Enumerable) : Set\n\n`merge` adds all the items in a set and all the items in the passed `collections` to a new set and returns it. A `collection` is an object which has a `forEach` function. `merge` is a non-destructive collection union, so the set `merge` is called on and each `collection` passed to `merge` are unaffected by the call.\n\n_Note_: Be careful about using `merge` within accessors. Calling `merge` in an accessor function body will register the set `merge` is called upon as a source of the property being calculated, which means when the set changes, that accessor will be recalculated. This means the O(n * m) merge will occur again each time, and return an entirely new `Set` instance. If the previously returned `Set` instance is retained after recalculation, this is a big memory leak. Instead of merging in accessors, try to use a `SetUnion` or a `SetIntersection`.\n\n    test 'Set::merge returns a new set with the items of the original set and the passed set', ->\n      abc = new Batman.Set('a', 'b', 'c')\n      def = new Batman.Set('d', 'e', 'f')\n      equal Batman.typeOf(set = abc.merge(def)), 'Object'\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd', 'e', 'f']\n\n## indexedBy(key : String) : SetIndex\n\n`indexedBy` returns a hash of sets which buckets all the items in the callee set by the value of a particular `key`. The value of the passed `key` is `get`ted from each object in the set, and then a hash of each value to a set of the items with that value at the `key` is built. This hash of sets is a smart object called a `SetIndex` which will continue to observe the set and the value of the `key` on each item in the set to ensure the set index remains up to date. `SetIndex` also has a friend named `UniqueSetIndex` which will give you a hash of items instead of a hash of sets with items for easy access if you know each item's value at the `key` is unique.\n\n    test 'Set::indexedBy returns a new SetIndex with the items bucketed by the value of the key', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'), Batman(colour: 'blue'))\n      index = set.indexedBy('colour')\n      ok index.get('blue') instanceof Batman.Set\n      equal index.get('blue').get('length'), 2\n      equal index.get('green').get('length'), 1\n\n    test 'Set::indexedBy returns a new SetIndex which observes the set for new additions and stays up to date', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.indexedBy('colour')\n      equal index.get('blue').get('length'), 1\n      newItem = Batman(colour: 'blue')\n      set.add(newItem)\n      equal index.get('blue').get('length'), 2\n      ok index.get('blue').has(newItem)\n      set.remove(newItem)\n      equal index.get('blue').get('length'), 1\n\n    test 'Set::indexedBy returns a new SetIndex which observes the items in the set for changes to the observed key', ->\n      itemA = Batman(colour: 'blue')\n      itemB = Batman(colour: 'green')\n      set = new Batman.Set(itemA, itemB)\n      index = set.indexedBy('colour')\n      equal index.get('blue').get('length'), 1\n      equal index.get('green').get('length'), 1\n      itemA.set('colour', 'green')\n      equal index.get('blue').get('length'), 0\n      equal index.get('green').get('length'), 2\n\n`SetIndex`es can be created by calling the `indexedBy` function on the `Set`, as well as by `get`ting a `key` on the `indexedBy` property.\n\n    test \"Set::get('indexedBy.someKey') returns a new SetIndex for 'someKey'\", ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.get('indexedBy.colour')\n      equal index.get('blue').get('length'), 1\n\n## indexedByUnique(key : String) : UniqueSetIndex\n\n`indexedByUnique` returns a hash of items keyed by the value of the given `key` on each item from the callee set. The value of the passed `key` is `get`ted from each object in the set, and then a hash of each value to an item with that value at the `key` is built. This hash of items is a smart object called a `UniqueSetIndex` which will continue to observe the set and the value of the `key` on each item in the set to ensure the index remains up to date. Note that the semantics for which item ends up in the hash if two items have the same value for the `key` are undefined, so it is wise to only use `UniqueSetIndex`es on keys who's values are going to be unique in the set. If the values are not going to be unique, you may be interested in `SetIndex` and `Set::indexedBy`.\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex with the items hashed by the value of the key', ->\n      greenItem = Batman(colour: 'green')\n      blueItem = Batman(colour: 'blue')\n      set = new Batman.Set(greenItem, blueItem)\n      index = set.indexedByUnique('colour')\n      ok blueItem == index.get('blue')\n      ok greenItem == index.get('green')\n      equal undefined, index.get('red')\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex which observes the set for new additions and stays up to date', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.indexedByUnique('colour')\n      newItem = Batman(colour: 'red')\n      set.add(newItem)\n      ok newItem == index.get('red')\n      set.remove(newItem)\n      equal undefined, index.get('red')\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex which observes the items in the set for changes to the observed key', ->\n      itemA = Batman(colour: 'blue')\n      itemB = Batman(colour: 'green')\n      set = new Batman.Set(itemA, itemB)\n      index = set.indexedByUnique('colour')\n      equal index.get('blue')?, true\n      equal index.get('green')?, true\n      equal index.get('red')?, false\n      itemA.set('colour', 'red')\n      equal index.get('blue')?, false\n      equal index.get('green')?, true\n      equal index.get('red')?, true\n\n`UniqueSetIndex`es can be created by calling the `indexedByUnique` function on the `Set`, as well as by `get`ting a `key` on the `indexedByUnique` property.\n\n    test \"Set::get('indexedByUnique.someKey') returns a new UniqueSetIndex for 'someKey'\", ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.get('indexedByUnique.colour')\n      equal 'blue', index.get('blue').get('colour')\n\n## sortedBy(key: String [, order: String]) : SetSort\n\n`sortedBy` returns a `Set` like object containing all the items of the callee set but with a defined iteration order (unlike `Set`). The iteration order is defined as the alpha numeric sorting of the values of the passed `key` gotten from each item. The direction of the sort can be controlled with the `order` argument, which defaults to `asc` (short for ascending) or can be passed as `desc` (short for descending). This `Set` like object is a `SetSort` which encapsulates the logic to get the values from each item at the passed `key` and traverse the `Set` in the values sorted order.\n\n`SetSort`s are useful for getting a transform of a `Set` which sorted, but also because the sort stays up to date as items are added or removed to the sorted set, or the value at the `key` changes on any of the items in the set.\n\n    test 'Set::sortedBy returns a new SetSort who can be iterated in the sorted order of the value of the key on each item', ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n\n    test 'Set::sortedBy returns a new SetSort which observes the callee set for additions or removals and puts new items in the sorted order', ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n      burke = Batman(place: 1.5, name: 'Burke')\n      set.add(burke)\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Burke', 'Camilo', 'Harry']\n\n    test 'Set::sortedBy returns a new SetSort which observes each item in the callee set for changes to the sort key', ->\n      harry = Batman(place: 2, name: 'Harry')\n      tom = Batman(place: 1, name: 'Tom')\n      set = new Batman.Set(harry, tom)\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Harry']\n      tom.set('place', 3)\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Harry', 'Tom']\n\n`SetSort`s can be created by calling the `sortedBy` function on the `Set`, as well as by `get`ting a `key` on the `sortedBy` property. Note that with this instantiation form you can't pass an order to the `SetSort`.\n\n    test \"Set::get('sortedBy.someKey') returns a new SetSort onn 'someKey'\", ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.get('sortedBy.place')\n      equal 'Harry', sort.get('toArray')[2].get('name')\n","old_contents":"# Batman.Set\n\n`Set` is an observable, `Batman.Object` wrapper around `SimpleSet`. `Set` also extends [`Batman.Enumerable`](\/docs\/api\/batman.enumerable.html), which provides [many useful methods](\/docs\/api\/batman.enumerable.html).\n\n### SimpleSet vs Set\n\n`SimpleSet` and `Set` are two distinct classes in Batman. `SimpleSet` implements the basic set semantics, but it is *not* a `Batman.Object`, so properties on it (like its `length` or `toArray`) cannot be bound. `Set` is a `Batman.Object`, so it can be observed, and thus plays nicely with the accessor system. Use a `SimpleSet` only when you know nothing will need to be observed on the set you are creating, which usually isn't a valid assumption. If it is in fact valid, consider using a native array as well, as iteration and membership checks will be faster.\n\n## constructor(items...)\n\nWhen creating a `Set`, items forming the initial set can be passed as separate arguments to the constructor\n\n    test 'new Set constructor can be called without arguments', ->\n      set = new Batman.Set\n      deepEqual set.toArray(), []\n\n    test 'new Set constructor can be passed items to add to the set.', ->\n      set = new Batman.Set('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n## length : number\n\nA count of the items in a `Set` can be found at its `length` property.\n\n## isEmpty : boolean\n\nObservable property for `isEmpty()`\n\n## toArray : Array\n\nObservable property for `toArray()`. Whenever items are added or removed on the set, the `toArray` property will change. This is the mechanism by which Batman's view bindings get notified of collection updates.\n\n    test 'observers on the toArray property fire when the set changes', ->\n      results = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.observe('toArray', (newArray) -> results = newArray.sort())\n      deepEqual set.add('d'), ['d']\n      deepEqual results, ['a', 'b', 'c', 'd']\n      deepEqual set.remove('b'), ['b']\n      deepEqual results, ['a', 'c', 'd']\n\n## has(item) : Boolean\n\n`has` returns a boolean describing if the given `item` is a member of the set.\n\n_Note_: Using `has(item)` in an accessor body will register the set `has` is called upon as a source of the property being calculated. This so that whenever the set changes, the property will be recalculated, because the set may now have or not have the item in question.\n\n    test 'Set::has indicates if an item is a member of the set or not.', ->\n      set = new Batman.Set('a', 'b', 'c')\n      ok set.has('a')\n      equal set.has('d'), false\n\n    test 'Set::has registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @awards = new Batman.Set()\n\n        @accessor 'bestEver?', -> @get('awards').has('Stanley Cup')\n\n      result = null\n      team = new Team\n      team.observeAndFire 'bestEver?', (status) -> result = status\n      team.get('awards').add 'Eastern Conference Champs'\n      equal result, false\n      team.get('awards').add 'Stanley Cup'\n      equal result, true\n\n## add(items...)\n\n`add` adds 0 or more new items to the set. `add` returns an array of the items which have been newly added to the set, which is to say the intersection of the argument items and the set's complement before addition.\n\n`add` fires the `itemsWereAdded` event with the list of items newly added to the set if that list has length greater than 0. This is to say the event will not be fired if the items passed to add were all already members of the set.\n\n    test 'Set::add adds an item to the set', ->\n      set = new Batman.Set()\n      equal set.has('a'), false\n      deepEqual set.add('a'), ['a']\n      equal set.has('a'), true\n\n    test 'Set::add returns only the new items that weren\\'t previously in the set', ->\n      set = new Batman.Set('a', 'b')\n      deepEqual set.add('b','c','d').sort(), ['c', 'd']\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd']\n\n    test 'Set::add fires the itemsWereAdded event with the items newly added to the set', ->\n      results = null\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereAdded', (item) -> results = item)\n      set.add('b','c','d')\n      deepEqual results.sort(), ['c','d']\n\n    test 'Set::add does not fire the itemsWereAdded event if the added items were already in the set.', ->\n      results = undefined\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereAdded', (items) -> results = items)\n      set.add('a', 'b')\n      equal typeof results, 'undefined'\n\n## remove(items...)\n\n`remove` removes 0 or more items from the set. `remove` returns an array of the items which were successfully removed from the set, which is to say the intersection of the argument items and the set itself before removal.\n\n`remove` fires the `itemsWereRemoved` event with the list of removed items if that list has length greater than 0. This is to say the event will not be fired if none of the passed items were members of the set.\n\n    test 'Set::remove removes an item from the set', ->\n      set = new Batman.Set('a')\n      equal set.has('a'), true\n      deepEqual set.remove('a'), ['a']\n      equal set.has('a'), false\n\n    test 'Set::remove returns only the new items that were previously in the set', ->\n      set = new Batman.Set('a', 'b')\n      deepEqual set.remove('b','c','d').sort(), ['b']\n      deepEqual set.toArray(), ['a']\n\n    test 'Set::remove fires the itemsWereRemoved event with the items removed to the set', ->\n      results = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('b','c')\n      deepEqual results.sort(), ['b','c']\n\n    test 'Set::remove does not fire the itemsWereRemoved event if the removed items were not already members of the set.', ->\n      results = undefined\n      set = new Batman.Set('a', 'b')\n      set.on('itemsWereRemoved', (items) -> results = items)\n      set.remove('c', 'd')\n      equal typeof results, 'undefined'\n\n## find(testFunction : function) : [Object]\n\n`find` returns the first item within the set for which the `testFunction` called with the item returns `true`, or `undefined` if no item passes the test.\n\n_Note_: `find` returns the first item the test passes for, but since set iteration has no specified order, no guarantee can be made about which item will be returned if more than one item in the set passes the test. However, set iteration order is stable, so `find` called on the same set twice should return the same item.\n\n\n    test 'Set::find returns the first item for which the test function passes', ->\n      set = new Batman.Set(1, 2, 3)\n      equal set.find((x) -> x % 2 == 0), 2\n\n    test 'Set::find returns undefined if no items pass the test function', ->\n      set = new Batman.Set(1, 2, 3)\n      equal typeof set.find((x) -> x > 5), 'undefined'\n\n## forEach(iteratorFunction : function[, context: Object])\n\n`forEach` calls the `iteratorFunction` with each item in the set, optionally executing the `iteratorFunction` in the passed context. Returns `undefined`.\n\n_Note_: Set iteration order is not defined, thus Set client code cannot rely on one item being iterated over before another, regardless of when the Set's items were added. If you need an ordered set, Batman provides `SetSort` for exactly this, while including the added benefit of observability. If you need a one time ordering of a set, you can get the array representation with `toArray` and then use vanilla JavaScript `sort` on that array.\n\n_Note_: Using `forEach()` in an accessor body will register the set iterated over as a source of the property being calculated. This so that whenever the set changes, the property will be recalculated. This can become an issue if you iterate over a set and modify the set's items, as when the property recalculates that modification will potentially happen on items it's happened on previously.\n\n    test 'Set::forEach iterates over each item in the set', ->\n      sum = 0\n      set = new Batman.Set(1,2,3)\n      set.forEach (x) -> sum += x\n      equal sum, 6\n\n    test 'Set::forEach iterates over each item in the set optionally in the provided context', ->\n      context = {sum: 0}\n      set = new Batman.Set(1,2,3)\n      set.forEach((x) ->\n        @sum += x\n      , context)\n      equal context.sum, 6\n\n    test 'Set::forEach registers the set as a source if called in an accessor body', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @players = new Batman.Set()\n        @accessor 'willWinTheCup?', ->\n          sedinCount = 0\n          @players.forEach (player) ->\n            sedinCount++ if player.split(' ')[1] == 'Sedin'\n          sedinCount >= 2\n\n      result = null\n      team = new Team()\n      team.observeAndFire 'willWinTheCup?', (status) -> result = status\n      equal team.get('willWinTheCup?'), false\n      team.get('players').add 'Henrik Sedin'\n      equal result, false\n      team.get('players').add 'Daniel Sedin'\n      equal result, true\n\n## isEmpty() : boolean\n\n`isEmpty` returns a boolean: `true` if the set has no items, and `false` if it has any items.\n\n_Note_: Using `isEmpty()` in an accessor body will register the set `isEmpty` is called on as a source of the property being calculated, so that whenever the set changes the property will be recalculated.\n\n    test 'Set::isEmpty returns true if the set has no items', ->\n      set = new Batman.Set()\n      ok set.isEmpty()\n      set.add('a')\n      equal set.isEmpty(), false\n\n    test 'Set::isEmpty registers the set as a source of an accessor', ->\n      class Team extends Batman.Object\n        constructor: ->\n          @games = new Batman.Set()\n        @accessor 'seasonStarted?', -> !@games.isEmpty()\n\n      team = new Team\n      equal team.get('seasonStarted?'), false\n      team.get('games').add({win: true})\n      equal team.get('seasonStarted?'), true\n\n## clear() : Array\n\n`clear` removes all items from a set. Returns an array of all the items in the set.\n\n`clear` will fire the `itemsWereRemoved` event once with all the items in the set.\n\n_Note_: Set iteration order is not defined, so the order of the array of items returned by `clear` is undefined.\n\n    test 'Set::clear empties the set', ->\n      set = new Batman.Set('a', 'b', 'c')\n      equal set.isEmpty(), false\n      deepEqual set.clear().sort(), ['a', 'b', 'c']\n      ok set.isEmpty()\n\n    test 'Set::clear fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.clear()\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## replace(collection : Enumerable) : Array\n\n`replace` removes all the items in a set and then adds all the items found in another `collection`. The other collection must have a `toArray` function which returns an array representation of the collection. Returns the array of items added.\n\n`replace` will fire the `itemsWereRemoved` event once with all the items in the set, and then the `itemsWereAdded` event once with the items from the incoming collection.\n\n    test 'Set::replace empties the set and then adds items from a different collection', ->\n      set = new Batman.Set('a', 'b', 'c')\n      secondSet = new Batman.Set('d', 'e', 'f')\n      set.replace(secondSet)\n      deepEqual set.toArray().sort(), ['d', 'e', 'f']\n\n    test 'Set::replace fires the itemsWereRemoved event with all the items in the set', ->\n      result = null\n      set = new Batman.Set('a', 'b', 'c')\n      set.on('itemsWereRemoved', (items) -> result = items)\n      set.replace(new Batman.SimpleSet())\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n    test 'Set::replace fires the itemsWereAdded event with all the items in the incoming set', ->\n      result = null\n      set = new Batman.Set()\n      set.on('itemsWereAdded', (items) -> result = items)\n      set.replace(new Batman.SimpleSet('a', 'b', 'c'))\n      deepEqual result.sort(), ['a', 'b', 'c']\n\n## toArray() : Array\n\n`toArray` returns an array representation of the set.\n\n_Note_: Set iteration order is not defined, so the order in which the set's items appear in the array is not defined. It is however stable, so the order of the items in two successive `toArray` calls where the set was not modified in between should be the same.\n\n_Note_: `toArray` is also an observable property.\n\n_Note_: Using `toArray()` in an accessor body will register the set `toArray` is called on as a source of the property being calculated, so that whenever the set changes the property will be recalculated.\n\n    test 'Set::toArray returns an array representation of the set', ->\n      set = new Batman.Set()\n      deepEqual set.toArray(), []\n      set.add('a', 'b', 'c')\n      deepEqual set.toArray().sort(), ['a', 'b', 'c']\n\n## merge(collections... : Enumerable) : Set\n\n`merge` adds all the items in a set and all the items in the passed `collections` to a new set and returns it. A `collection` is an object which has a `forEach` function. `merge` is a non-destructive collection union, so the set `merge` is called on and each `collection` passed to `merge` are unaffected by the call.\n\n_Note_: Be careful about using `merge` within accessors. Calling `merge` in an accessor function body will register the set `merge` is called upon as a source of the property being calculated, which means when the set changes, that accessor will be recalculated. This means the O(n * m) merge will occur again each time, and return an entirely new `Set` instance. If the previously returned `Set` instance is retained after recalculation, this is a big memory leak. Instead of merging in accessors, try to use a `SetUnion` or a `SetIntersection`.\n\n    test 'Set::merge returns a new set with the items of the original set and the passed set', ->\n      abc = new Batman.Set('a', 'b', 'c')\n      def = new Batman.Set('d', 'e', 'f')\n      equal Batman.typeOf(set = abc.merge(def)), 'Object'\n      deepEqual set.toArray().sort(), ['a', 'b', 'c', 'd', 'e', 'f']\n\n## indexedBy(key : String) : SetIndex\n\n`indexedBy` returns a hash of sets which buckets all the items in the callee set by the value of a particular `key`. The value of the passed `key` is `get`ted from each object in the set, and then a hash of each value to a set of the items with that value at the `key` is built. This hash of sets is a smart object called a `SetIndex` which will continue to observe the set and the value of the `key` on each item in the set to ensure the set index remains up to date. `SetIndex` also has a friend named `UniqueSetIndex` which will give you a hash of items instead of a hash of sets with items for easy access if you know each item's value at the `key` is unique.\n\n    test 'Set::indexedBy returns a new SetIndex with the items bucketed by the value of the key', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'), Batman(colour: 'blue'))\n      index = set.indexedBy('colour')\n      ok index.get('blue') instanceof Batman.Set\n      equal index.get('blue').get('length'), 2\n      equal index.get('green').get('length'), 1\n\n    test 'Set::indexedBy returns a new SetIndex which observes the set for new additions and stays up to date', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.indexedBy('colour')\n      equal index.get('blue').get('length'), 1\n      newItem = Batman(colour: 'blue')\n      set.add(newItem)\n      equal index.get('blue').get('length'), 2\n      ok index.get('blue').has(newItem)\n      set.remove(newItem)\n      equal index.get('blue').get('length'), 1\n\n    test 'Set::indexedBy returns a new SetIndex which observes the items in the set for changes to the observed key', ->\n      itemA = Batman(colour: 'blue')\n      itemB = Batman(colour: 'green')\n      set = new Batman.Set(itemA, itemB)\n      index = set.indexedBy('colour')\n      equal index.get('blue').get('length'), 1\n      equal index.get('green').get('length'), 1\n      itemA.set('colour', 'green')\n      equal index.get('blue').get('length'), 0\n      equal index.get('green').get('length'), 2\n\n`SetIndex`es can be created by calling the `indexedBy` function on the `Set`, as well as by `get`ting a `key` on the `indexedBy` property.\n\n    test \"Set::get('indexedBy.someKey') returns a new SetIndex for 'someKey'\", ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.get('indexedBy.colour')\n      equal index.get('blue').get('length'), 1\n\n## indexedByUnique(key : String) : UniqueSetIndex\n\n`indexedByUnique` returns a hash of items keyed by the value of the given `key` on each item from the callee set. The value of the passed `key` is `get`ted from each object in the set, and then a hash of each value to an item with that value at the `key` is built. This hash of items is a smart object called a `UniqueSetIndex` which will continue to observe the set and the value of the `key` on each item in the set to ensure the index remains up to date. Note that the semantics for which item ends up in the hash if two items have the same value for the `key` are undefined, so it is wise to only use `UniqueSetIndex`es on keys who's values are going to be unique in the set. If the values are not going to be unique, you may be interested in `SetIndex` and `Set::indexedBy`.\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex with the items hashed by the value of the key', ->\n      greenItem = Batman(colour: 'green')\n      blueItem = Batman(colour: 'blue')\n      set = new Batman.Set(greenItem, blueItem)\n      index = set.indexedByUnique('colour')\n      ok blueItem == index.get('blue')\n      ok greenItem == index.get('green')\n      equal undefined, index.get('red')\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex which observes the set for new additions and stays up to date', ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.indexedByUnique('colour')\n      newItem = Batman(colour: 'red')\n      set.add(newItem)\n      ok newItem == index.get('red')\n      set.remove(newItem)\n      equal undefined, index.get('red')\n\n    test 'Set::indexedByUnique returns a new UniqueSetIndex which observes the items in the set for changes to the observed key', ->\n      itemA = Batman(colour: 'blue')\n      itemB = Batman(colour: 'green')\n      set = new Batman.Set(itemA, itemB)\n      index = set.indexedByUnique('colour')\n      equal index.get('blue')?, true\n      equal index.get('green')?, true\n      equal index.get('red')?, false\n      itemA.set('colour', 'red')\n      equal index.get('blue')?, false\n      equal index.get('green')?, true\n      equal index.get('red')?, true\n\n`UniqueSetIndex`es can be created by calling the `indexedByUnique` function on the `Set`, as well as by `get`ting a `key` on the `indexedByUnique` property.\n\n    test \"Set::get('indexedByUnique.someKey') returns a new UniqueSetIndex for 'someKey'\", ->\n      set = new Batman.Set(Batman(colour: 'blue'), Batman(colour: 'green'))\n      index = set.get('indexedByUnique.colour')\n      equal 'blue', index.get('blue').get('colour')\n\n## sortedBy(key: String [, order: String]) : SetSort\n\n`sortedBy` returns a `Set` like object containing all the items of the callee set but with a defined iteration order (unlike `Set`). The iteration order is defined as the alpha numeric sorting of the values of the passed `key` gotten from each item. The direction of the sort can be controlled with the `order` argument, which defaults to `asc` (short for ascending) or can be passed as `desc` (short for descending). This `Set` like object is a `SetSort` which encapsulates the logic to get the values from each item at the passed `key` and traverse the `Set` in the values sorted order.\n\n`SetSort`s are useful for getting a transform of a `Set` which sorted, but also because the sort stays up to date as items are added or removed to the sorted set, or the value at the `key` changes on any of the items in the set.\n\n    test 'Set::sortedBy returns a new SetSort who can be iterated in the sorted order of the value of the key on each item', ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n\n    test 'Set::sortedBy returns a new SetSort which observes the callee set for additions or removals and puts new items in the sorted order', ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Camilo', 'Harry']\n      burke = Batman(place: 1.5, name: 'Burke')\n      set.add(burke)\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Burke', 'Camilo', 'Harry']\n\n    test 'Set::sortedBy returns a new SetSort which observes each item in the callee set for changes to the sort key', ->\n      harry = Batman(place: 2, name: 'Harry')\n      tom = Batman(place: 1, name: 'Tom')\n      set = new Batman.Set(harry, tom)\n      sort = set.sortedBy('place')\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Tom', 'Harry']\n      tom.set('place', 3)\n      deepEqual sort.toArray().map((item) -> item.get('name')), ['Harry', 'Tom']\n\n`SetSort`s can be created by calling the `sortedBy` function on the `Set`, as well as by `get`ting a `key` on the `sortedBy` property. Note that with this instantiation form you can't pass an order to the `SetSort`.\n\n    test \"Set::get('sortedBy.someKey') returns a new SetSort onn 'someKey'\", ->\n      set = new Batman.Set(Batman(place: 3, name: 'Harry'), Batman(place: 1, name: 'Tom'), Batman(place: 2, name: 'Camilo'))\n      sort = set.get('sortedBy.place')\n      equal 'Harry', sort.get('toArray')[2].get('name')\n\n# Batman.SetIndex\n\n`Batman.SetIndex` is a grouped collection of items derived from a [`Batman.Set`]() filled with [`Batman.Object`]()s. It extends `Batman.Object` and [`Batman.Enumerable`](), so it inherits methods from them, too. In short, a `SetIndex` tracks its base `Set` and contains \"buckets\" of items from that `Set`, grouped by the provided key.\n\n```coffeescript\nbatarang = new Batman.Object(name: \"Batarang\", type: \"ranged\")\ngrappleGun = new Batman.Object(name: \"Grapple Gun\", type: \"ranged\")\nfists = new Batman.Object(name: \"Fists\", type: \"melee\")\n\nweapons = new Batman.Set(batarang, grappleGun, fists)\nweaponsByType = new Batman.SetIndex(set, 'type')\n\nweaponsByType.get('ranged.length') # => 2\nweaponsByType.get('melee.length')  # => 1\nweaponsByType.get('ranged').map (weapon) -> weapon.get('name')  # => [\"Batarang\", \"GrappleGun\"]\nweaponsByType.toArray()                                         # => [\"ranged\", \"melee\"]\n```\n\n## ::constructor(base : Set, key : String ) : SetIndex\n\nA `SetIndex` is made with a `base` and a `key`. Items in the `base` set will be grouped according to their value for `key`. The resulting `SetIndex` observes its `base`, so any items added to the `base` are also added (and indexed) in the `SetIndex`\n\n## ::get(value : String) : Set\n\nReturns a `Batman.Set` of items whose indexed `key` matches `value`. It returns an empty set if no items match `value`, but if any matching items are added to the `base` set, they will also be added to this set.\n\n## ::toArray() : Array\n\nReturns an array with the distinct values of `key` provided to the constructor.\n\n## ::forEach(func)\n\nCalls `func(key, group)` for each group in the SetIndex.\n\n# Batman.UniqueSetIndex\n\n`Batman.UniqueSetIndex` extends `SetIndex` but adds a new consideration: its index contains _first matching item_ for each value of the `key` (rather than all matching items).\n\n```coffeescript\nbatarang = new Batman.Object(name: \"Batarang\", type: \"ranged\")\ngrappleGun = new Batman.Object(name: \"Grapple Gun\", type: \"ranged\")\nfists = new Batman.Object(name: \"Fists\", type: \"melee\")\n\nweapons = new Batman.Set(batarang, grappleGun, fists)\nweaponsByUniqueType = new Batman.UniqueSetIndex(set, 'type')\nweaponsByUniqueType.get('ranged.name') # => \"Batarang\"\n```\n\n## ::get(value : String) : Object\n\nReturns the first matching member whose indexed `key` is equal to `value`.\n\n# Batman.SetSort\n# Batman.SetUnion\n# Batman.SetIntersection\n# Batman.SetComplement\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ece7685237b36806e55f601a02054c331416ff6d","subject":"Added missing initial values for new turnLeft\/turnRight controller axes.","message":"Added missing initial values for new turnLeft\/turnRight controller axes.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat","old_file":"src\/input\/gamepad.litcoffee","new_file":"src\/input\/gamepad.litcoffee","new_contents":"This exports an object, where keys are control names and values are numbers from\n0 to 1 representing state.  These are not, however, clamped to this range.\n\n    module.exports = \n        left: 0\n        right: 0\n        turnLeft: 0\n        turnRight: 0\n        forward: 0\n        backward: 0\n        up: 0\n        down: 0","old_contents":"This exports an object, where keys are control names and values are numbers from\n0 to 1 representing state.  These are not, however, clamped to this range.\n\n    module.exports = \n        left: 0\n        right: 0\n        forward: 0\n        backward: 0\n        up: 0\n        down: 0","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c681e8c390af496c09f1638916eaf566467ed4d5","subject":"add some sugar","message":"add some sugar\n","repos":"krkn\/posib,krkn\/posib,leny\/posib,leny\/posib,leny\/posib,krkn\/posib","old_file":"src\/server\/models\/brick\/rich.litcoffee","new_file":"src\/server\/models\/brick\/rich.litcoffee","new_contents":"# [posib.](http:\/\/posib.krkn.be)\n\n## **\/server\/models\/brick\/rich.js** - *RichBrick class*\n\ncoded by leny @ krkn\n\nstarted at 04\/02\/14\n\n* * *\n\nRichBrick class.\n\nA *RichBrick* is an editable text block tag.\n\nThe following tags are RichBricks : `p`\n\nAn unique RichBricks can represent subsequent `p` tags.\n\n* * *\n\n    \"use strict\"\n\n    root = \"#{ __dirname }\/..\/..\"\n\n    cheerio = require \"cheerio\"\n\n    config = require \"#{ root }\/core\/config.js\"\n\n    Brick = require \"#{ root }\/models\/brick.js\"\n\n    module.exports = class RichBrick extends Brick\n\n### _create()\n\n        _create: ->\n            content: if @node.html().trim() then \"<p>#{ @node.html().trim() }<\/p>\" else \"<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.<\/p>\"\n\n### _render()\n\n        _render: ->\n            oAttributes = @node.attr()\n            ( @nodes = cheerio @get \"content\" ).each ->\n                cheerio( @ ).attr sAttribute, sValue for sAttribute, sValue of oAttributes\n            @node.replaceWith @nodes\n\n### _clean()\n\nAs the *RichBrick* class can rely multiple nodes, the default Brick._clean() method isnt adapted.\n\n        _clean: ->\n            @nodes.each ->\n                cheerio( @ ).removeAttr \"data-posib-ref\"\n","old_contents":"# [posib.](http:\/\/posib.krkn.be)\n\n## **\/server\/models\/brick\/rich.js** - *RichBrick class*\n\ncoded by leny @ krkn\n\nstarted at 04\/02\/14\n\n* * *\n\nRichBrick class.\n\nA *RichBrick* is an editable text block tag.\n\nThe following tags are RichBricks : `p`\n\nAn unique RichBricks can represent subsequent `p` tags.\n\n* * *\n\n    \"use strict\"\n\n    root = \"#{ __dirname }\/..\/..\"\n\n    cheerio = require \"cheerio\"\n\n    config = require \"#{ root }\/core\/config.js\"\n\n    Brick = require \"#{ root }\/models\/brick.js\"\n\n    module.exports = class RichBrick extends Brick\n\n### _create()\n\n        _create: ->\n            content: if @node.html().trim() then \"<p>#{ @node.html().trim() }<\/p>\" else \"<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.<\/p>\"\n\n### _render()\n\n        _render: ->\n            oAttributes = @node.attr()\n            ( @nodes = cheerio @get \"content\" ).each ->\n                for sAttribute, sValue of oAttributes\n                    cheerio( @ ).attr sAttribute, sValue\n            @node.replaceWith @nodes\n\n### _clean()\n\nAs the *RichBrick* class can rely multiple nodes, the default Brick._clean() method isnt adapted.\n\n        _clean: ->\n            @nodes.each ->\n                cheerio( @ ).removeAttr \"data-posib-ref\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9e95f93b3ff7e7c22ef46b85c0d755d2548ab6a7","subject":"Ajax with polling","message":"Ajax with polling\n","repos":"vpj\/IO","old_file":"io.litcoffee","new_file":"io.litcoffee","new_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onerror: (msg, options) ->\n      console.log msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      @_send @_createCall method, data, callbacks, options\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       throw new Error \"Unknown method: #{data.method}\"\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      @callsCache[data.id].handle data.data, data\n\n     _handlePoll: (data, options) ->\n      throw new Error \"Poll not implemented\"\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n     _onError: (e) -> console.log e\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##AJAX class\n\n    class AjaxHttpPort extends Port\n     constructor: (options) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n\n     isStreaming: false\n\n     _onRequest: (xhr) ->\n      return unless xhr.readyState is 4\n      status = xhr.status\n      if ((not status and xhr.responseText?) or\n          (status >= 200 and status < 300) or\n          (status is 304))\n       try\n        jsonData = JSON.parse xhr.responseText\n       catch e\n        @onerror 'ParseError', e\n        return\n\n       @_handleMessage jsonData, xhr: xhr\n      else\n       @onerror 'xhr error'\n\n     _respond: (data, options) ->\n      throw new Error 'AJAX cannot respond'\n\n     _send: (data) ->\n      data = JSON.stringify data\n      xhr = new XMLHttpRequest\n      xhr.open 'POST', \"http:\/\/#{@host}:#{@port}#{@path}\"\n      xhr.onreadystatechange = =>\n       @_onRequest xhr\n      xhr.setRequestHeader 'Accept', 'application\/json'\n      #xhr.setRequestHeader 'Content-Type', 'application\/json'\n      xhr.send data\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       console.log 'error', e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e, data\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       throw new Error \"Poll without response: #{data.id}\"\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      AjaxHttpPort: AjaxHttpPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","old_contents":"    _self = this\n\n    POLL_TYPE =\n     progress: true\n\n##Response class\n\n    class Response\n     constructor: (data, port, options) ->\n      @id = data.id\n      @port = port\n      @options = options\n      @queue = []\n      @fresh = true\n\n     progress: (progress, data) ->\n      @queue.push method: 'progress', data: data, options: {progress: progress}\n      @_handleQueue()\n\n     success: (data) ->\n      @queue.push method: 'success', data: data, options: {}\n      @_handleQueue()\n\n     fail: (data) ->\n      @queue.push method: 'fail', data: data, options: {}\n      @_handleQueue()\n\n     setOptions: (options) ->\n      @options = options\n      @fresh = true\n      @_handleQueue()\n\n     _handleQueue: ->\n      return unless @queue.length > 0\n\n      d = @queue[0]\n\n      if @port.isStreaming\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n      else if @fresh\n       @port.respond this, d.method, d.data, d.options, @options\n       @queue.shift()\n       @fresh = false\n\n##Call class\n\n    class Call\n     constructor: (@id, @method, @data, @callbacks, @options) -> null\n\n     handle: (data, options) ->\n      if not @callbacks[options.status]?\n       return if options.status is 'progress'\n       throw new Error \"No callback registered #{@method} #{options.status}\"\n      @callbacks[options.status] data, options\n\n##Port base class\n\n    class Port\n     constructor: ->\n      @handlers = {}\n      @callsCache = {}\n      @callsCounter = 0\n      @id = parseInt Math.random() * 1000\n      @responses = {}\n      @wrappers =\n       send: []\n       respond: []\n       handleCall: []\n       handleResponse: []\n\n     isStreaming: true\n\n     onerror: (msg, options) ->\n      console.log msg, options\n\n     wrap: (wrapper) ->\n      for key, f of wrapper\n       if @wrappers[key]?\n        @wrappers[key].push f\n       else\n        this[key] = f\n\n###Send RPC call\n\n     send: (method, data, callbacks, options = {}) ->\n      if (typeof callbacks) is 'function'\n       callbacks =\n        success: callbacks\n\n      for f in @wrappers.send\n       return unless f.apply this, [method, data, callbacks, options]\n\n      @_send @_createCall method, data, callbacks, options\n\n###Respond to a RPC call\n\n     respond: (response, status, data, options = {}, portOptions = {}) ->\n      for f in @wrappers.respond\n       return unless f.apply this, [response, status, data, options, portOptions]\n\n      @_respond (@_createResponse response, status, data, options), portOptions\n      if not POLL_TYPE[status]?\n       delete @responses[response.id]\n\n\n###Create Call object\nThis is a private function\n\n     _createCall: (method, data, callbacks, options) ->\n      call = new Call \"#{@id}-#{@callsCounter}\", method, data, callbacks, options\n      @callsCounter++\n      @callsCache[call.id] = call\n\n      params =\n       type: 'call'\n       id: call.id\n       method: call.method\n       data: call.data\n\n      params[k] = v for k, v of options\n      return params\n\n###Create Response object\n\n     _createResponse: (response, status, data, options) ->\n      params =\n       type: 'response'\n       id: response.id\n       status: status\n       data: data\n\n      params[k] = v for k, v of options\n\n      return params\n\n###Add handler\n\n     on: (method, callback) ->\n      @handlers[method] = callback\n\n###Handle incoming message\n\n     _handleMessage: (data, options) ->\n      switch data.type\n       when 'response'\n        @_handleResponse data, options\n       when 'call'\n        @_handleCall data, options\n       when 'poll'\n        @_handlePoll data, options\n\n     _handleCall: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @handlers[data.method]?\n       throw new Error \"Unknown method: #{data.method}\"\n      @responses[data.id] = new Response data, this, options\n      @handlers[data.method] data.data, data, @responses[data.id]\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      @callsCache[data.id].handle data.data, data\n\n     _handlePoll: (data, options) ->\n      throw new Error \"Poll not implemented\"\n\n##WorkerPort class\nUsed for browser and worker\n\n    class WorkerPort extends Port\n     constructor: (worker) ->\n      super()\n      @worker = worker\n      @worker.onmessage = @_onMessage.bind this\n      @worker.onerror = @_onError.bind this\n\n     _send: (data) ->  @worker.postMessage data\n     _respond: (data) -> @worker.postMessage data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n     _onError: (e) -> console.log e\n\n\n\n##SocketPort class\n\n    class SocketPort extends Port\n     constructor: (socket) ->\n      super()\n      @socket = socket\n      @socket.on 'message', @_onMessage.bind this\n\n     _send: (data) ->  @socket.emit 'message', data\n     _respond: (data) -> @worker.emit 'message', data\n\n     _onMessage: (e) ->\n      data = e.data\n      @_handleMessage data\n\n\n\n##ServerSocketPort class\n\n    class ServerSocketPort extends Port\n     constructor: (server) ->\n      super()\n      @server = server\n      @server.on 'connection', @_onConnection.bind this\n\n     _onConnection: (socket) ->\n      new SocketPort handlers: @handlers, socket\n\n\n\n##NodeHttpPort class\n\n    class NodeHttpPort extends Port\n     constructor: (options, http) ->\n      super()\n      @host = options.host ? 'localhost'\n      @port = options.port ? 80\n      @path = options.path ? '\/'\n      @http = http\n      @_createHttpOptions()\n\n     isStreaming: false\n\n     _createHttpOptions: ->\n      @httpOptions =\n       hostname: @host\n       port: @port\n       path: @path\n       method: 'POST'\n       headers:\n        accept: 'application\/json'\n       'content-type': 'application\/json'\n\n\n     _onRequest: (res) ->\n      data = ''\n      #console.log 'STATUS: ' + res.statusCode\n      #console.log 'HEADERS: ' + JSON.stringify res.headers\n      res.setEncoding 'utf8'\n      res.on 'data', (chunk) ->\n       data += chunk\n      #console.log 'result', res\n      res.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     _send: (data) ->\n      data = JSON.stringify data\n      options = @httpOptions\n      options.headers['content-length'] = data.length\n\n      req = @http.request options, @_onRequest.bind this\n      delete options.headers['content-length']\n      req.on 'error', (e) ->\n       console.log 'error', e\n\n      req.write data\n      req.end()\n\n     _handleResponse: (data, options) ->\n      for f in @wrappers.handleResponse\n       return unless f.apply this, arguments\n      if not @callsCache[data.id]?\n       throw new Error \"Response without call: #{data.id}\"\n      call = @callsCache[data.id]\n      call.handle data.data, data\n      if POLL_TYPE[data.status]?\n       params =\n        type: 'poll'\n        id: call.id\n       params[k] = v for k, v of call.options\n       @_send params\n\n\n##NodeHttpServerPort class\n\n    class NodeHttpServerPort extends Port\n     constructor: (options, http) ->\n      super()\n      @port = options.port\n      @http = http\n\n     isStreaming: false\n\n     _onRequest: (req, res) ->\n      data = ''\n      res.setHeader 'content-type', 'application\/json'\n\n      req.on 'data', (chunk) ->\n       data += chunk\n      req.on 'end', =>\n       try\n        jsonData = JSON.parse data\n       catch e\n        console.log 'ParseError', e\n        return\n\n       @_handleMessage jsonData, response: res\n\n     _respond: (data, options) ->\n      data = JSON.stringify data\n      res = options.response\n      res.setHeader 'content-length', data.length\n      res.write data\n      res.end()\n\n     listen: ->\n      @server = @http.createServer @_onRequest.bind this\n      @server.listen @port\n\n     _handlePoll: (data, options) ->\n      for f in @wrappers.handleCall\n       return unless f.apply this, arguments\n      if not @responses[data.id]?\n       throw new Error \"Poll without response: #{data.id}\"\n      @responses[data.id].setOptions options\n\n\n\n#IO Module\n\n    IO =\n     addPort: (name, port) ->\n      IO[name] = port\n\n     ports:\n      WorkerPort: WorkerPort\n      SocketPort: SocketPort\n      NodeHttpPort: NodeHttpPort\n      NodeHttpServerPort: NodeHttpServerPort\n      ServerSocketPort: ServerSocketPort\n\n     setup_____: (options) ->\n      options.workers ?= []\n      switch options.platform\n       when 'ui'\n        for worker in options.workers\n         IO.addPort worker.name, new WorkerPort worker.js\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'node'\n        for socket in options.listenSockets\n         IO.addPort socket.name, new SocketListenPort socket.port\n        for socket in options.sockets\n         IO.addPort socket.name, new SocketPort socket.url\n       when 'worker'\n        IO.addPort 'UI', new WorkerListenPort _self\n\n    if exports?\n     module.exports = IO\n    else\n     _self.IO = IO\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a0d906a07d575975a38d9fc1d01b866a7e7d3b6f","subject":"Added CodeShip badge","message":"Added CodeShip badge\n","repos":"SoftwareMarbles\/frugal-couch","old_file":"source\/frugal.litcoffee","new_file":"source\/frugal.litcoffee","new_contents":"\n[ ![Codeship Status for SoftwareMarbles\/frugal-couch](https:\/\/www.codeship.io\/projects\/42664c00-dcbd-0131-867d-7e56761d162f\/status)](https:\/\/www.codeship.io\/projects\/24565)\n\n# Frugal Couch in Node\n\n## Initialization\n\nFor logging and other tasks we use several external modules.\n\n    _       = require 'lodash'\n    debug   = (require 'debug') 'frugal-couch'\n\n## Exports\n\n### `overwriteBulk`\n\n`overwriteBulk` is a function designed to perform bulk updating of given documents even when their revision values are out of date.\n\nBulk updating documents have two significant advantages over updating them one by one:\n\n1.It's much faster as it requires only two trips to CouchDb for all the docs vs. two trips for each doc (one trip to try to update and if that fails then a new trip with corrected revision value)\n2.It's much cheaper if used on DaaS like Cloudant which charge the same for bulk requests and non-bulk requests (so if you have 10,000 docs that you need to update you'll be charged for 2 requests and not for 20,000 requests)\n\nBulk updating shouldn't be used always unless you are absolutely certain that nothing else is updating your database. It can be very useful even in multi-client databases as some types of documents may considered to be stable and depending only on external values (e.g. importing Facebook Graph data)\n\nThis function accepts three parameters:\n\n1.`database`: [`nano`](https:\/\/github.com\/dscape\/nano) database object (or an object with equivalent semantics) used to access the database\n\n2.`docs`: an array of documents that need to be bulk-updated\n\n3.`callback`: function with `(err, result)` signature. `result` is an object containing `inserted`, `updated`, `resurected` arrays and `revs` and `errors` objects. The three arrays hold the ids of inserted, updated and resurected documents (previously deleted and now re-inserted) while the two objects have properties matching document ids and their latest revisions or CouchDb generated errors respectively. `callback` is always invoked asynchronously\n\n    exports.overwriteBulk = (database, docs, callback) ->\n\n        getResultObject = (inserted, updated, resurected, revs, errors) ->\n            return {\n                inserted:   inserted or []\n                updated:    updated or []\n                resurected: resurected or []\n                revs:       revs or {}\n                errors:     errors or {}\n            }\n\nAll parameters must be valid.\n\n        if not _.isFunction(callback)\n            throw new Error('Callback parameter required')\n\n        if not database or not _.isArray(docs)\n            debug 'Bad input parameters passed to overwriteBulk function'\n            return process.nextTick ->\n                callback new Error('Bad input parameters')\n\n        if _.isEmpty(docs)\n            return process.nextTick ->\n                callback null, getResultObject()\n\nSince CouchDb doesn't support bulk updating without _rev we first retreive all the revision numbers of all given docs. That allows us to update the _rev values of the docs we are supposed to update and only then do we bulk upload the docs.\n\n        debug 'Overwritting', docs.length, 'docs in bulk'\n\nConstruct the map of doc ids with doc objects so that we can both access just the list of doc ids as well as be able to later update the revisions of docs in `O(n log n)`.\n\n        idDocsMap = {}\n        _.each docs, (doc) ->\n            idDocsMap[doc._id] = doc\n\nQuery the database for the revisions of all the docs. Once we have the revisions we will update the docs and then bulk upload them.\n\n        debug 'Fetching doc revisions'\n\n        return database.fetch_revs { keys: Object.keys idDocsMap }, (err, revisions) ->\n            return callback err if err\n            return callback new Error 'Invalid document revisions returned.' unless revisions\n\nUpdate the revisions of the documents with the revision values we got from the server. The conditions to update the revision value are:\n\n1. Row object exists and has both value and id properties.\n2. The document with the same id already exists in the db (even if it's deleted as CouchDb keeps *all* docs forever).\n\n            debug 'Updating docs with correct revisions'\n\n            inserted = []\n            updated = []\n            resurected = []\n            _.each revisions.rows, (row) ->\n\nWe update the doc if and only if everything is correct (doc id exists among our docs, rev was correctly returned from the server, doc isn't deleted on the server, etc.)\n\n                return debug 'Bad revision item received' unless row\n\nIf the row error is `not_found` then this document has a new ID in the database.\n\n                docId = row.key\n                return debug 'Bad document id received', docId unless docId\n\n                if row.error\n                    if row.error == 'not_found'\n                        # We delete the revision just in case there is one as CouchDb will otherwise reject it.\n                        delete idDocsMap[docId]._rev\n                        inserted.push docId\n                    else\n                        debug 'Error received', row.error\n                    return\n\n                return debug 'Bad revision value received' unless row.value?.rev\n                doc = idDocsMap[docId]\n                return debug 'Bad document id', docId unless doc\n\nIf the document with the same id already existed but was deleted then CouchDb will expect from us to *not* pass revision number. But if it exists right now (it hasn't been deleted) then we have to pass its current revision number (freshly retrieved from the database).\n\n                if row.value.deleted\n                    delete doc._rev\n                    resurected.push docId\n                else\n                    doc._rev = row.value.rev\n                    updated.push docId\n\nAfter the document revs have been updated, we bulk load them and pass on the results to the given `callback`\n\n            debug 'Inserting', inserted.length, 'docs'\n            debug 'Updating', updated.length, 'docs'\n            debug 'Resurecting', resurected.length, 'docs'\n\n            database.bulk { docs: docs }, (err, body) ->\n                revs = {}\n                errors = {}\n                _.each body, (row) ->\n                    if row.ok\n                        revs[row.id] = row.rev\n                    else\n                        errors[row.id] = {\n                            id:     row.id\n                            error:  row.error\n                            reason: row.reason\n                        }\n\n                callback err, getResultObject(inserted, updated, resurected, revs, errors)\n\n### `partialUpdateBulk`\n\n`partialUpdateBulk` function performs partial updates of the documents with the given IDs.\n\nCouchDb allows partial server-side modification of documents through its update handler feature. However, this feature doesn't work for arrays of documents and is thus too slow for massive document updates.\n\nThe alternative is to retrieve all the documents, apply the modification function to them and then bulk upload them. This is what `partialUpdateBulk` does.\n\nThis function accepts the following parameters:\n\n1.`database`    -   `nano` database object or an object with equivalent semantics\n\n2.`docIds`      -   the array of IDs of the documents to update\n\n3.`partialUpdater`  -   the function accepting a single parameter (`doc` representing a database document) that does the document update and which will be invoked for each retrieved document\n\n4.`callback`    -   function accepting `err` and `result` parameters:\n\n - `err`      -   error value in case of any error, falsy otherwise\n - `result`   -   object with `revs` and `errors` object properties. `revs` maps the document IDs to their post-operation revision while errors maps any CouchDb errors to document ID related to it\n\n    exports.partialUpdateBulk = (database, docIds, partialUpdater, callback) ->\n\n        getResultObject = (revs, errors) ->\n            return {\n                revs:       revs or {},\n                errors:     errors or {}\n            }\n\nAll parameters must be valid.\n\n        if not _.isFunction(callback)\n            throw new Error('Callback parameter required')\n\n        if not database or not _.isArray(docIds) or not _.isFunction(partialUpdater)\n            debug 'Bad input parameters passed to partialUpdateBulk function'\n            return process.nextTick ->\n                callback new Error('Bad input parameters')\n\n        if _.isEmpty(docIds)\n            return process.nextTick ->\n                callback null, getResultObject()\n\nTo update the docs we fetch them, update them in-place and then bulk upload them again.\n\n        debug 'Partial bulk updating', docIds.length, 'docs'\n\n        return database.fetch { keys: docIds }, (err, body) ->\n            return callback err if err\n            return callback new Error 'Invalid documents returned.' if _.isEmpty(body?.rows)\n\n            docs = []\n            _.each body.rows, (row) ->\n                doc = row.doc\n                docs.push doc\n                partialUpdater doc\n\n            database.bulk { docs: docs }, (err, body) ->\n                revs = {}\n                errors = {}\n                _.each body, (row) ->\n                    if row.ok\n                        revs[row.id] = row.rev\n                    else\n                        errors[row.id] = {\n                            id:     row.id\n                            error:  row.error\n                            reason: row.reason\n                        }\n\n                callback err, getResultObject(revs, errors)\n\n### `iterateViewBulk`\n\n`iterateViewBulk` function is used to iterate over CouchDb views.\n\nThis function accepts the following parameters:\n\n1.`database`    -   `nano` database object or an object with equivalent semantics\n\n2.`designDoc`   -   the name of the design document in which the view is to be found.\n\n3.`viewName`    -   the name of the view which will be queried.\n\n4.`options`     -   standard CouchDb options like `startkey` and `endkey`. It also holds the number of documents in each desired iteration in its `limit` property. If it doesn't then the default batch size is 1,000 documents (completely arbitrary number). One property that this function ignores is `skip` as it's needed to perform correct and optimal iterations.\n\n5.`iterator`    -   function accepting `err`, `docs` and `next` parameters:\n\n - `err`      -   error value in case of any error, falsy otherwise\n - `rows`     -   the array of view entries in the current iteration\n - `next`     -   the function to be invoked when the next iteration should be performed\n\n    exports.iterateViewBulk = (database, designDoc, viewName, options, iterator) ->\n\nIf iterator doesn't exist, options parameter is our iterator.\n\n        if not iterator\n            iterator = options\n            options = undefined\n\nCreate a clone of the given `options` so that we don't change them during iteration.\n\n        options = _.clone(options) or {}\n        options.skip = 0\n        options.limit = options.limit or 1000\n\nAll parameters must be valid.\n\n        if not _.isFunction(iterator)\n            throw new Error('Iterator parameter required')\n\n        if not database or not designDoc or not viewName or not options\n            debug 'Bad input parameters passed to iterateViewBulk function'\n            return process.nextTick ->\n                iterator new Error('Bad input parameters')\n\n`nextIteration` function performs all the work of querying the view, checking the results and invoking the `iterator` function.\n\n        nextIteration = ->\n            database.view designDoc, viewName, options, (err, body) ->\n                return iterator err if err\n                return iterator null, [] if not body or _.isEmpty(body.rows)\n\nIncrement the skip count depending on the amount of data we got in this iteration.\n\n                options.skip = options.skip + body.rows.length\n\nIndirect recursion call. This will invoke the `iterator` function which in turn will invoke `nextIteration` itself when it finishes processing the current batch.\n\n                iterator null, body.rows, nextIteration\n\nStart iteration by invoking `nextIteration` for the first time.\n\n        nextIteration()\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2014 Software Marbles SpA\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","old_contents":"\n# Frugal Couch in Node\n\n## Initialization\n\nFor logging and other tasks we use several external modules.\n\n    _       = require 'lodash'\n    debug   = (require 'debug') 'frugal-couch'\n\n## Exports\n\n### `overwriteBulk`\n\n`overwriteBulk` is a function designed to perform bulk updating of given documents even when their revision values are out of date.\n\nBulk updating documents have two significant advantages over updating them one by one:\n\n1.It's much faster as it requires only two trips to CouchDb for all the docs vs. two trips for each doc (one trip to try to update and if that fails then a new trip with corrected revision value)\n2.It's much cheaper if used on DaaS like Cloudant which charge the same for bulk requests and non-bulk requests (so if you have 10,000 docs that you need to update you'll be charged for 2 requests and not for 20,000 requests)\n\nBulk updating shouldn't be used always unless you are absolutely certain that nothing else is updating your database. It can be very useful even in multi-client databases as some types of documents may considered to be stable and depending only on external values (e.g. importing Facebook Graph data)\n\nThis function accepts three parameters:\n\n1.`database`: [`nano`](https:\/\/github.com\/dscape\/nano) database object (or an object with equivalent semantics) used to access the database\n\n2.`docs`: an array of documents that need to be bulk-updated\n\n3.`callback`: function with `(err, result)` signature. `result` is an object containing `inserted`, `updated`, `resurected` arrays and `revs` and `errors` objects. The three arrays hold the ids of inserted, updated and resurected documents (previously deleted and now re-inserted) while the two objects have properties matching document ids and their latest revisions or CouchDb generated errors respectively. `callback` is always invoked asynchronously\n\n    exports.overwriteBulk = (database, docs, callback) ->\n\n        getResultObject = (inserted, updated, resurected, revs, errors) ->\n            return {\n                inserted:   inserted or []\n                updated:    updated or []\n                resurected: resurected or []\n                revs:       revs or {}\n                errors:     errors or {}\n            }\n\nAll parameters must be valid.\n\n        if not _.isFunction(callback)\n            throw new Error('Callback parameter required')\n\n        if not database or not _.isArray(docs)\n            debug 'Bad input parameters passed to overwriteBulk function'\n            return process.nextTick ->\n                callback new Error('Bad input parameters')\n\n        if _.isEmpty(docs)\n            return process.nextTick ->\n                callback null, getResultObject()\n\nSince CouchDb doesn't support bulk updating without _rev we first retreive all the revision numbers of all given docs. That allows us to update the _rev values of the docs we are supposed to update and only then do we bulk upload the docs.\n\n        debug 'Overwritting', docs.length, 'docs in bulk'\n\nConstruct the map of doc ids with doc objects so that we can both access just the list of doc ids as well as be able to later update the revisions of docs in `O(n log n)`.\n\n        idDocsMap = {}\n        _.each docs, (doc) ->\n            idDocsMap[doc._id] = doc\n\nQuery the database for the revisions of all the docs. Once we have the revisions we will update the docs and then bulk upload them.\n\n        debug 'Fetching doc revisions'\n\n        return database.fetch_revs { keys: Object.keys idDocsMap }, (err, revisions) ->\n            return callback err if err\n            return callback new Error 'Invalid document revisions returned.' unless revisions\n\nUpdate the revisions of the documents with the revision values we got from the server. The conditions to update the revision value are:\n\n1. Row object exists and has both value and id properties.\n2. The document with the same id already exists in the db (even if it's deleted as CouchDb keeps *all* docs forever).\n\n            debug 'Updating docs with correct revisions'\n\n            inserted = []\n            updated = []\n            resurected = []\n            _.each revisions.rows, (row) ->\n\nWe update the doc if and only if everything is correct (doc id exists among our docs, rev was correctly returned from the server, doc isn't deleted on the server, etc.)\n\n                return debug 'Bad revision item received' unless row\n\nIf the row error is `not_found` then this document has a new ID in the database.\n\n                docId = row.key\n                return debug 'Bad document id received', docId unless docId\n\n                if row.error\n                    if row.error == 'not_found'\n                        # We delete the revision just in case there is one as CouchDb will otherwise reject it.\n                        delete idDocsMap[docId]._rev\n                        inserted.push docId\n                    else\n                        debug 'Error received', row.error\n                    return\n\n                return debug 'Bad revision value received' unless row.value?.rev\n                doc = idDocsMap[docId]\n                return debug 'Bad document id', docId unless doc\n\nIf the document with the same id already existed but was deleted then CouchDb will expect from us to *not* pass revision number. But if it exists right now (it hasn't been deleted) then we have to pass its current revision number (freshly retrieved from the database).\n\n                if row.value.deleted\n                    delete doc._rev\n                    resurected.push docId\n                else\n                    doc._rev = row.value.rev\n                    updated.push docId\n\nAfter the document revs have been updated, we bulk load them and pass on the results to the given `callback`\n\n            debug 'Inserting', inserted.length, 'docs'\n            debug 'Updating', updated.length, 'docs'\n            debug 'Resurecting', resurected.length, 'docs'\n\n            database.bulk { docs: docs }, (err, body) ->\n                revs = {}\n                errors = {}\n                _.each body, (row) ->\n                    if row.ok\n                        revs[row.id] = row.rev\n                    else\n                        errors[row.id] = {\n                            id:     row.id\n                            error:  row.error\n                            reason: row.reason\n                        }\n\n                callback err, getResultObject(inserted, updated, resurected, revs, errors)\n\n### `partialUpdateBulk`\n\n`partialUpdateBulk` function performs partial updates of the documents with the given IDs.\n\nCouchDb allows partial server-side modification of documents through its update handler feature. However, this feature doesn't work for arrays of documents and is thus too slow for massive document updates.\n\nThe alternative is to retrieve all the documents, apply the modification function to them and then bulk upload them. This is what `partialUpdateBulk` does.\n\nThis function accepts the following parameters:\n\n1.`database`    -   `nano` database object or an object with equivalent semantics\n\n2.`docIds`      -   the array of IDs of the documents to update\n\n3.`partialUpdater`  -   the function accepting a single parameter (`doc` representing a database document) that does the document update and which will be invoked for each retrieved document\n\n4.`callback`    -   function accepting `err` and `result` parameters:\n\n - `err`      -   error value in case of any error, falsy otherwise\n - `result`   -   object with `revs` and `errors` object properties. `revs` maps the document IDs to their post-operation revision while errors maps any CouchDb errors to document ID related to it\n\n    exports.partialUpdateBulk = (database, docIds, partialUpdater, callback) ->\n\n        getResultObject = (revs, errors) ->\n            return {\n                revs:       revs or {},\n                errors:     errors or {}\n            }\n\nAll parameters must be valid.\n\n        if not _.isFunction(callback)\n            throw new Error('Callback parameter required')\n\n        if not database or not _.isArray(docIds) or not _.isFunction(partialUpdater)\n            debug 'Bad input parameters passed to partialUpdateBulk function'\n            return process.nextTick ->\n                callback new Error('Bad input parameters')\n\n        if _.isEmpty(docIds)\n            return process.nextTick ->\n                callback null, getResultObject()\n\nTo update the docs we fetch them, update them in-place and then bulk upload them again.\n\n        debug 'Partial bulk updating', docIds.length, 'docs'\n\n        return database.fetch { keys: docIds }, (err, body) ->\n            return callback err if err\n            return callback new Error 'Invalid documents returned.' if _.isEmpty(body?.rows)\n\n            docs = []\n            _.each body.rows, (row) ->\n                doc = row.doc\n                docs.push doc\n                partialUpdater doc\n\n            database.bulk { docs: docs }, (err, body) ->\n                revs = {}\n                errors = {}\n                _.each body, (row) ->\n                    if row.ok\n                        revs[row.id] = row.rev\n                    else\n                        errors[row.id] = {\n                            id:     row.id\n                            error:  row.error\n                            reason: row.reason\n                        }\n\n                callback err, getResultObject(revs, errors)\n\n### `iterateViewBulk`\n\n`iterateViewBulk` function is used to iterate over CouchDb views.\n\nThis function accepts the following parameters:\n\n1.`database`    -   `nano` database object or an object with equivalent semantics\n\n2.`designDoc`   -   the name of the design document in which the view is to be found.\n\n3.`viewName`    -   the name of the view which will be queried.\n\n4.`options`     -   standard CouchDb options like `startkey` and `endkey`. It also holds the number of documents in each desired iteration in its `limit` property. If it doesn't then the default batch size is 1,000 documents (completely arbitrary number). One property that this function ignores is `skip` as it's needed to perform correct and optimal iterations.\n\n5.`iterator`    -   function accepting `err`, `docs` and `next` parameters:\n\n - `err`      -   error value in case of any error, falsy otherwise\n - `rows`     -   the array of view entries in the current iteration\n - `next`     -   the function to be invoked when the next iteration should be performed\n\n    exports.iterateViewBulk = (database, designDoc, viewName, options, iterator) ->\n\nIf iterator doesn't exist, options parameter is our iterator.\n\n        if not iterator\n            iterator = options\n            options = undefined\n\nCreate a clone of the given `options` so that we don't change them during iteration.\n\n        options = _.clone(options) or {}\n        options.skip = 0\n        options.limit = options.limit or 1000\n\nAll parameters must be valid.\n\n        if not _.isFunction(iterator)\n            throw new Error('Iterator parameter required')\n\n        if not database or not designDoc or not viewName or not options\n            debug 'Bad input parameters passed to iterateViewBulk function'\n            return process.nextTick ->\n                iterator new Error('Bad input parameters')\n\n`nextIteration` function performs all the work of querying the view, checking the results and invoking the `iterator` function.\n\n        nextIteration = ->\n            database.view designDoc, viewName, options, (err, body) ->\n                return iterator err if err\n                return iterator null, [] if not body or _.isEmpty(body.rows)\n\nIncrement the skip count depending on the amount of data we got in this iteration.\n\n                options.skip = options.skip + body.rows.length\n\nIndirect recursion call. This will invoke the `iterator` function which in turn will invoke `nextIteration` itself when it finishes processing the current batch.\n\n                iterator null, body.rows, nextIteration\n\nStart iteration by invoking `nextIteration` for the first time.\n\n        nextIteration()\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2014 Software Marbles SpA\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"76a79e60fcdd5b2788166548a4f98f4e20aedbc5","subject":"Added support for arrays of validators for properties when args_format is OBJECT","message":"Added support for arrays of validators for properties when args_format is OBJECT\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                if Array.isArray val\n                  \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else\n                  \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = [ ]\n\n                for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  if Array.isArray validator\n                    for v in validator\n                      Madul.FIRE '$.Madul.validator.execute', \"#{v}\": args[arg]\n\n                      validators.push proto[v].EXECUTE.call proto[v], arg, args[arg]\n                  else\n                    Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                    validators.push proto[validator].EXECUTE.call proto[validator], arg, args[arg]\n\n                before = @_process_decorators me, 'before'\n                after  = @_process_decorators me, 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                  proto[validator].EXECUTE.call proto[validator], args[arg]\n\n                before = @_process_decorators 'before'\n                after  = @_process_decorators 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9761782727a280f07e9e849991aa247bde21743c","subject":"Add usage examples","message":"Add usage examples\n","repos":"mdesantis\/jquery-textfade,mdesantis\/jquery-textfade","old_file":"src\/jquery-textfade.litcoffee","new_file":"src\/jquery-textfade.litcoffee","new_contents":"    ###!\n    jQuery.TextFade v1.0.0\n    https:\/\/github.com\/mdesantis\/jquery-textfade\n\n    Copyright 2014-2018 Maurizio De Santis\n    Released under the MIT license\n    https:\/\/github.com\/mdesantis\/jquery-textfade\/LICENSE\n    ###\n\n# jQuery.TextFade\n\n## Description\n\n**jQuery.TextFade** is a jQuery plugin which provides some nice fading effects to the contents of\nthe selected elements.\n\nThe fading effect is obtained replacing every character of the text with a blank character in the\ncase of a fade-out effect, and conversely replacing the text with blank characters and replacing\nevery blank character with the corresponding character in the text in the case of a fade-in effect.\n\nIf more elements are selected, their contents will be animated simultaneously.\n\n## API\n\n* **jQuery.textFade(action, options)**: main function\n* **jQuery.textFadeIn(options)**: alias for `jQuery.textFade('in', options)`\n* **jQuery.textFadeOut(options)**: alias for `jQuery.textFade('out', options)`\n\n### Arguments\n\n**jQuery.textFade** takes two arguments:\n- **action**: the fading action; can be `'in'`, which causes the text to appear, or `'out'`, which\n  causes the text to disappear. *Default value:* none\n- **options**: the available options, which are:\n  - **text**: if this option is specified, its value will replace the content of the selected\n    element, so as to be used for the fading effect; otherwise the fading text is the content of the\n    selected element. *Default value:* `null`\n  - **sequence**: an array of characters indexes, which determine the order of the text fading.\n    *Default value:* `'random'`. The value can be any of these types:\n    - *array*: it will be iterated in sequence using each value as the index of the character to be\n      replaced\n    - *string*: it selects one between the preset sequences (more on this [below](#sequences))\n    - *function*: it takes the fading text as argument and returns an array containing the\n      characters indexes\n  - **steps**: a step is the action of the character replacement. These are the available\n    options:\n    - **duration**: the duration of each character replacement in milliseconds. *Default value:\n      `10`*\n    - **threads**: the amount of character replacements for each step. *Default value:* `1`\n\n**jQuery.textFadeIn** and **jQuery.textFadeOut** take the **options** argument only.\n\n\n### Events\n\njQuery.textFade triggers two events, **start** and **stop**. In order to listen for them you can use\nthe following event identifiers:\n- **start.textFadeIn**: start of a fade-in\n- **stop.textFadeIn**: stop of a fade-in\n- **start.textFadeOut**: start of a fade-out\n- **stop.textFadeOut**: stop of a fade-out\n- **start.textFade**: start of a fade of any action\n- **stop.textFade**: stop of a fade of any action\n\nIn any case the action is passed as value of the `'action'` key of the first extra parameter, which\nhappens to be an object.\n\n### Examples\n\n- Fade out the text \"HEY THERE!\" one character every second:\n\n```coffeescript\n$('#text').textFadeIn({\n  'text': 'HEY THERE!',\n  'steps': { 'duration': 1000, 'threads': 1 }\n})\n```\n\n- Fade out the text \"SEE YA!\" three characters every two seconds, in a\n*left to right - top to bottom* order:\n\n```coffeescript\n$('#text').textFadeOut({\n  'text': 'SEE YA!',\n  'sequence': 'ltr_ttb',\n  'steps': { 'duration': 2000, threads: 3 }\n})\n```\n\n## Source\n\n**TextFade** is the core function: in addition to the arguments described [above](#arguments), it\ntakes the `@$element` argument, that is the jQuery element\/s whose text is going to be animated\n\n    TextFade = (@$element, @action, options) ->\n\n### Constants\n\n      $                  = jQuery\n      BLANK_TEXT_REGEXP  = \/[^\\n]\/g\n      LINES_SPLIT_REGEXP = \/.+\\n?|\\n\/g\n\n#### Sequences\n\n      SEQUENCES          =\n\n`SEQUENCES` includes some preset sequences, selectable passing the corresponding identifier to\njQuery.textFade. The available identifiers are:\n\n- **random**: the characters fading sequence is random\n\n        'random'  : (text) -> shuffle times text.length\n\n- **ltr_ttb** *(left-to-right character, top-to-bottom line)*: the text fading starts at the first\ncharacter of the first line, up to the end of line; then it moves to the next line\n\n        'ltr_ttb' : (text) -> times text.length\n\n- **ltr_btt** *(left-to-right character, bottom-to-top line)*: the text fading starts at the first\ncharacter of the last line, up to the end of line; then it moves to the previous line\n\n        'ltr_btt' : (text) -> flatten (textToSequences text).reverse()\n\n- **rtl_ttb** *(right-to-left character, top-to-bottom line)*: the text fading starts at the last\ncharacter of the first line, up to the start of line; then it moves to the next line\n\n        'rtl_ttb' : (text) -> flatten textToSequences(text).map((v) -> v.reverse())\n\n- **rtl_btt** *(right-to-left character, bottom-to-top line)*: the text fading starts at the last\ncharacter of the last line, up to the start of line; then it moves to the previous line\n\n        'rtl_btt' : (text) -> flatten textToSequences(text).map((v) -> v.reverse()).reverse()\n\n- **ttb_ltr** *(top-to-bottom character, left-to-right line)*: the text fading starts at the first\ncharacter of the first line, up to the first character of the last line; then it moves to the next\ncharacter of the first line\n\n        'ttb_ltr' : (text) -> flatten zip textToSequences text\n\n- **ttb_rtl** *(top-to-bottom character, right-to-left line)*: the text fading starts at the last\ncharacter of the first line, up to the last character of the last line; then it moves to the\nprevious character of the first line\n\n        'ttb_rtl' : (text) -> flatten (zip textToSequences(text).reverse()).reverse()\n\n- **btt_ltr** *(bottom-to-top character, left-to-right line)*: the text fading starts at the first\ncharacter of the last line, up to the first character of the first line; then it moves to the next\ncharacter of the last line\n\n        'btt_ltr' : (text) -> flatten zip textToSequences(text).reverse()\n\n- **btt_rtl** *(bottom-to-top character, right-to-left line)*: the text fading starts at the last\ncharacter of the last line, up to the first character of the last line; then it moves to the next\ncharacter of the last line\n\n        'btt_rtl' : (text) -> flatten (zip textToSequences text).reverse()\n\n### Utility functions\n\n      capitalize = (s) -> \"#{s.charAt(0).toUpperCase()}#{s.slice(1)}\"\n\n      flatten = (a) -> a.reduce (p, c) -> p.concat c\n\n      max = (a) -> a.reduce ((p, c) -> Math.max p, c), -Infinity\n\n      shuffle = (a) ->\n        i = a.length\n\n        while i\n          j = Math.floor Math.random()*i\n          x = a[--i]\n          a[i] = a[j]\n          a[j] = x\n\n        a\n\n      times = (n, fn) ->\n        i   = 0\n        fn ?= (i) -> i\n\n        fn i++ while i < n\n\n      zip = (a) ->\n        result = []\n\n        times (max a.map (v) -> v.length), (i) ->\n          for v in a\n            (result[i] ?= []).push v[i] if v[i]?\n\n        result\n\nTake a text and return an array of arrays, each containing the text index of each\ncharacter of the corresponding line\n\n      textToSequences = (text) ->\n        sequences = []\n        charIndex = 0\n        lines     = text.match LINES_SPLIT_REGEXP\n\n        for line, lineIndex in lines\n          sequences[lineIndex] = []\n          times line.length, () -> sequences[lineIndex].push charIndex++\n\n        sequences\n\n### Default options\n\n      defaultOptions = ->\n        'text'     : null\n        'sequence' : 'random'\n        'steps'    :\n          'duration' : 10\n          'threads'  : 1\n\n### Private instance methods\n\nTrigger both of the supported event namespaces\n\n      @_trigger = (eventName) ->\n        extraParameters = [{ 'action' : @action }]\n        @$element.trigger \"#{eventName}.textFade#{capitalize(@action)}\", extraParameters\n        @$element.trigger \"#{eventName}.textFade\", extraParameters\n\nReplace the character at the given index\n\n      @_replace = (index) ->\n        text     = @$element.text()\n        prevChar = @begText.charAt index\n        nextChar = @endText.charAt index\n\nThe replacement is skipped if the character is the same\n\n        return if prevChar is nextChar\n\n        @$element.text \"#{text.substr 0, index}#{nextChar}#{text.substr index+nextChar.length}\"\n\nThe function executed for each character replacement, until the sequence gets empty\n\n      @_step = (sequence) ->\n        times @options.steps.threads, () =>\n          return if sequence.length is 0\n\n          @_replace sequence.shift()\n\n        if sequence.length is 0\n          clearInterval @_interval\n          @_trigger 'stop'\n\n### Constructor\n\n      @options = $.extend true, defaultOptions(), options\n\n      text = @options.text ? @$element.text()\n\n      if $.type(@options.sequence) is 'string'\n        @options.sequence = SEQUENCES[@options.sequence] text\n      else if $.isFunction @options.sequence\n        @options.sequence = @options.sequence text\n      # else assert @options.sequence to be an array; leave it unchanged\n\nUse an `@options.sequence` clone in order to keep it unchanged\n\n      sequenceClone = @options.sequence[0..]\n\nNewlines are preserved in order to preserve the text structure\n\n      blankText = text.replace BLANK_TEXT_REGEXP, ' '\n\nThe only difference between fade-in and fade-out is that on fade-in we start with a blank text and\nfinish with the submitted text, while on fade-out we start with the submitted text and finish with\na blank text\n\n      switch @action\n        when 'in'\n          @begText = blankText\n          @endText = text\n        when 'out'\n          @begText = text\n          @endText = blankText\n\n      @$element.text @begText\n\n      @_trigger 'start'\n\n      @_interval = setInterval =>\n        @_step sequenceClone\n      , @options.steps.duration\n\n      @\n\n### jQuery bindings\n\n    $.fn.textFade = (action, options) ->\n      @.each -> new TextFade $(@), action, options\n\n    $.fn.textFadeIn = (options) ->\n      @.textFade 'in', options\n\n    $.fn.textFadeOut = (options) ->\n      @.textFade 'out', options\n","old_contents":"    ###!\n    jQuery.TextFade v1.0.0\n    https:\/\/github.com\/mdesantis\/jquery-textfade\n\n    Copyright 2014-2018 Maurizio De Santis\n    Released under the MIT license\n    https:\/\/github.com\/mdesantis\/jquery-textfade\/LICENSE\n    ###\n\n# jQuery.TextFade\n\n## Description\n\n**jQuery.TextFade** is a jQuery plugin which provides some nice fading effects to the contents of\nthe selected elements.\n\nThe fading effect is obtained replacing every character of the text with a blank character in the\ncase of a fade-out effect, and conversely replacing the text with blank characters and replacing\nevery blank character with the corresponding character in the text in the case of a fade-in effect.\n\nIf more elements are selected, their contents will be animated simultaneously.\n\n## API\n\n* **jQuery.textFade(action, options)**: main function\n* **jQuery.textFadeIn(options)**: alias for `jQuery.textFade('in', options)`\n* **jQuery.textFadeOut(options)**: alias for `jQuery.textFade('out', options)`\n\n### Arguments\n\n**jQuery.textFade** takes two arguments:\n- **action**: the fading action; can be `'in'`, which causes the text to appear, or `'out'`, which\n  causes the text to disappear. *Default value:* none\n- **options**: the available options, which are:\n  - **text**: if this option is specified, its value will replace the content of the selected\n    element, so as to be used for the fading effect; otherwise the fading text is the content of the\n    selected element. *Default value:* `null`\n  - **sequence**: an array of characters indexes, which determine the order of the text fading.\n    *Default value:* `'random'`. The value can be any of these types:\n    - *array*: it will be iterated in sequence using each value as the index of the character to be\n      replaced\n    - *string*: it selects one between the preset sequences (more on this [below](#sequences))\n    - *function*: it takes the fading text as argument and returns an array containing the\n      characters indexes\n  - **steps**: a step is the action of the character replacement. These are the available\n    options:\n    - **duration**: the duration of each character replacement in milliseconds. *Default value:\n      `10`*\n    - **threads**: the amount of character replacements for each step. *Default value:* `1`\n\n**jQuery.textFadeIn** and **jQuery.textFadeOut** take the **options** argument only.\n\n\n### Events\n\njQuery.textFade triggers two events, **start** and **stop**. In order to listen for them you can use\nthe following event identifiers:\n- **start.textFadeIn**: start of a fade-in\n- **stop.textFadeIn**: stop of a fade-in\n- **start.textFadeOut**: start of a fade-out\n- **stop.textFadeOut**: stop of a fade-out\n- **start.textFade**: start of a fade of any action\n- **stop.textFade**: stop of a fade of any action\n\nIn any case the action is passed as value of the `'action'` key of the first extra parameter, which\nhappens to be an object.\n\n### Examples\n\nTODO\n\n## Source\n\n**TextFade** is the core function: in addition to the arguments described [above](#arguments), it\ntakes the `@$element` argument, that is the jQuery element\/s whose text is going to be animated\n\n    TextFade = (@$element, @action, options) ->\n\n### Constants\n\n      $                  = jQuery\n      BLANK_TEXT_REGEXP  = \/[^\\n]\/g\n      LINES_SPLIT_REGEXP = \/.+\\n?|\\n\/g\n\n#### Sequences\n\n      SEQUENCES          =\n\n`SEQUENCES` includes some preset sequences, selectable passing the corresponding identifier to\njQuery.textFade. The available identifiers are:\n\n- **random**: the characters fading sequence is random\n\n        'random'  : (text) -> shuffle times text.length\n\n- **ltr_ttb** *(left-to-right character, top-to-bottom line)*: the text fading starts at the first\ncharacter of the first line, up to the end of line; then it moves to the next line\n\n        'ltr_ttb' : (text) -> times text.length\n\n- **ltr_btt** *(left-to-right character, bottom-to-top line)*: the text fading starts at the first\ncharacter of the last line, up to the end of line; then it moves to the previous line\n\n        'ltr_btt' : (text) -> flatten (textToSequences text).reverse()\n\n- **rtl_ttb** *(right-to-left character, top-to-bottom line)*: the text fading starts at the last\ncharacter of the first line, up to the start of line; then it moves to the next line\n\n        'rtl_ttb' : (text) -> flatten textToSequences(text).map((v) -> v.reverse())\n\n- **rtl_btt** *(right-to-left character, bottom-to-top line)*: the text fading starts at the last\ncharacter of the last line, up to the start of line; then it moves to the previous line\n\n        'rtl_btt' : (text) -> flatten textToSequences(text).map((v) -> v.reverse()).reverse()\n\n- **ttb_ltr** *(top-to-bottom character, left-to-right line)*: the text fading starts at the first\ncharacter of the first line, up to the first character of the last line; then it moves to the next\ncharacter of the first line\n\n        'ttb_ltr' : (text) -> flatten zip textToSequences text\n\n- **ttb_rtl** *(top-to-bottom character, right-to-left line)*: the text fading starts at the last\ncharacter of the first line, up to the last character of the last line; then it moves to the\nprevious character of the first line\n\n        'ttb_rtl' : (text) -> flatten (zip textToSequences(text).reverse()).reverse()\n\n- **btt_ltr** *(bottom-to-top character, left-to-right line)*: the text fading starts at the first\ncharacter of the last line, up to the first character of the first line; then it moves to the next\ncharacter of the last line\n\n        'btt_ltr' : (text) -> flatten zip textToSequences(text).reverse()\n\n- **btt_rtl** *(bottom-to-top character, right-to-left line)*: the text fading starts at the last\ncharacter of the last line, up to the first character of the last line; then it moves to the next\ncharacter of the last line\n\n        'btt_rtl' : (text) -> flatten (zip textToSequences text).reverse()\n\n### Utility functions\n\n      capitalize = (s) -> \"#{s.charAt(0).toUpperCase()}#{s.slice(1)}\"\n\n      flatten = (a) -> a.reduce (p, c) -> p.concat c\n\n      max = (a) -> a.reduce ((p, c) -> Math.max p, c), -Infinity\n\n      shuffle = (a) ->\n        i = a.length\n\n        while i\n          j = Math.floor Math.random()*i\n          x = a[--i]\n          a[i] = a[j]\n          a[j] = x\n\n        a\n\n      times = (n, fn) ->\n        i   = 0\n        fn ?= (i) -> i\n\n        fn i++ while i < n\n\n      zip = (a) ->\n        result = []\n\n        times (max a.map (v) -> v.length), (i) ->\n          for v in a\n            (result[i] ?= []).push v[i] if v[i]?\n\n        result\n\nTake a text and return an array of arrays, each containing the text index of each\ncharacter of the corresponding line\n\n      textToSequences = (text) ->\n        sequences = []\n        charIndex = 0\n        lines     = text.match LINES_SPLIT_REGEXP\n\n        for line, lineIndex in lines\n          sequences[lineIndex] = []\n          times line.length, () -> sequences[lineIndex].push charIndex++\n\n        sequences\n\nHere are the default options\n\n      defaultOptions = ->\n        'text'     : null\n        'sequence' : 'random'\n        'steps'    :\n          'duration' : 10\n          'threads'  : 1\n\n### Private instance methods\n\nTrigger both of the supported event namespaces\n\n      @_trigger = (eventName) ->\n        extraParameters = [{ 'action' : @action }]\n        @$element.trigger \"#{eventName}.textFade#{capitalize(@action)}\", extraParameters\n        @$element.trigger \"#{eventName}.textFade\", extraParameters\n\nReplace the character at the given index\n\n      @_replace = (index) ->\n        text     = @$element.text()\n        prevChar = @begText.charAt index\n        nextChar = @endText.charAt index\n\nThe replacement is skipped if the character is the same\n\n        return if prevChar is nextChar\n\n        @$element.text \"#{text.substr 0, index}#{nextChar}#{text.substr index+nextChar.length}\"\n\nThe function executed for each character replacement, until the sequence gets empty\n\n      @_step = (sequence) ->\n        times @options.steps.threads, () =>\n          return if sequence.length is 0\n\n          @_replace sequence.shift()\n\n        if sequence.length is 0\n          clearInterval @_interval\n          @_trigger 'stop'\n\n### Constructor\n\n      @options = $.extend true, defaultOptions(), options\n\n      text = @options.text ? @$element.text()\n\n      if $.type(@options.sequence) is 'string'\n        @options.sequence = SEQUENCES[@options.sequence] text\n      else if $.isFunction @options.sequence\n        @options.sequence = @options.sequence text\n      # else assert @options.sequence to be an array; leave it unchanged\n\nUse an `@options.sequence` clone in order to keep it unchanged\n\n      sequenceClone = @options.sequence[0..]\n\nNewlines are preserved in order to preserve the text structure\n\n      blankText = text.replace BLANK_TEXT_REGEXP, ' '\n\nThe only difference between fade-in and fade-out is that on fade-in we start with a blank text and\nfinish with the submitted text, while on fade-out we start with the submitted text and finish with\na blank text\n\n      switch @action\n        when 'in'\n          @begText = blankText\n          @endText = text\n        when 'out'\n          @begText = text\n          @endText = blankText\n\n      @$element.text @begText\n\n      @_trigger 'start'\n\n      @_interval = setInterval =>\n        @_step sequenceClone\n      , @options.steps.duration\n\n      @\n\n### jQuery bindings\n\n    $.fn.textFade = (action, options) ->\n      @.each -> new TextFade $(@), action, options\n\n    $.fn.textFadeIn = (options) ->\n      @.textFade 'in', options\n\n    $.fn.textFadeOut = (options) ->\n      @.textFade 'out', options\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ef8f1246a456953c9797d01e9e4bd782fb970519","subject":"Add delegatesFunctionsToTarget docs","message":"Add delegatesFunctionsToTarget docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/03d_proxy.litcoffee","new_file":"docs\/03d_proxy.litcoffee","new_contents":"# \/api\/Data Structures\/Batman.Object\/Batman.Proxy\n\n`Batman.Proxy` extends `Batman.Object` but implements the default accessor to `get`, `set`, and `unset` on its `target`.\n\nAny accessors without explicit definitions will be delegated to `target`:\n\n    test \"a Batman.Proxy delegates to its target\", ->\n      class CustomProxy extends Batman.Proxy\n        @accessor 'customValue', -> \"Custom Value!\"\n\n      targetObject = new Batman.Object({name: \"Batman\", favoriteColor: \"#000\"})\n      proxy = new CustomProxy(targetObject)\n\n      equal proxy.get('favoriteColor'), '#000', \"Default accessor delegates to target\"\n      equal proxy.get('customValue'), \"Custom Value!\", \"Custom accessors override delegated ones\"\n\n## ::constructor(target : Batman.Object) : Proxy\n\nReturns a new `Batman.Proxy` delegating to `target`.\n\n## ::.isProxy[=true] : Boolean\n\nReturns `true`. Shows that the object is a proxy.\n\n## ::%target : Object\n\nReturns the object which the `Proxy` is delegating to.\n\n## @delegatesFunctionsToTarget(names...)\n\nDefines a whitelist of functions which the `Proxy` will delegate to its target object. Unlike accessors, functions are not automatically passed to the target. For example:\n\n    class Batman.AssociationProxy\n      ...\n      @delegatesFunctionsToTarget('save', 'validate', 'destroy')\n      ...\n\npasses calls to `save`, `validate`, and `destroy` made on an `AssociationProxy` to the target `Batman.Model` where those functions are defined.\n","old_contents":"# \/api\/Data Structures\/Batman.Object\/Batman.Proxy\n\n`Batman.Proxy` extends `Batman.Object` but implements the default accessor to `get`, `set`, and `unset` on its `target`.\n\nAny accessors without explicit definitions will be delegated to `target`:\n\n    test \"a Batman.Proxy delegates to its target\", ->\n      class CustomProxy extends Batman.Proxy\n        @accessor 'customValue', -> \"Custom Value!\"\n\n      targetObject = new Batman.Object({name: \"Batman\", favoriteColor: \"#000\"})\n      proxy = new CustomProxy(targetObject)\n\n      equal proxy.get('favoriteColor'), '#000', \"Default accessor delegates to target\"\n      equal proxy.get('customValue'), \"Custom Value!\", \"Custom accessors override delegated ones\"\n\n## ::constructor(target : Batman.Object) : Proxy\n\nReturns a new `Batman.Proxy` delegating to `target`.\n\n## ::.isProxy[=true] : Boolean\n\nReturns `true`. Shows that the object is a proxy.\n\n## ::%target : Object\n\nReturns the object which the `Proxy` is delegating to.\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"27f2d25605b72f950660d1b5df2d4b2bcb50de81","subject":"additional fixes to revert state","message":"additional fixes to revert state\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    Yang     = require '.\/yang'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (spec={}) ->\n        # NOTE: ES6\/CS2 does not support below\n        # unless this instanceof Property then return new Property arguments...\n\n        # 1. parse if spec is YANG definition (string)\n        spec = Yang.parse spec if typeof spec is 'string'\n        \n        # 2. assign if spec is an instance of Yang schema\n        schema = spec if spec instanceof Yang\n        \n        # 3. destructure spec as an object if not schema as instance\n        { name, schema } = spec unless schema?\n        \n        # 4. parse if schema is YANG definition (string)\n        schema = Yang.parse schema if typeof schema is 'string'\n        schema ?= kind: 'anydata'\n\n        # 5. initialize property instance\n        @name = name ? schema.datakey\n        @schema = schema\n        @state = \n          parent:    null\n          strict:    false\n          private:   false\n          mutable:   `schema.config != false`\n          attached:  false\n          changed:   false\n          prior:     undefined\n          value:     undefined\n\n        # 6. soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'parent'\n        .access 'strict'\n        .getter 'private'\n        .getter 'mutable'\n        .getter 'attached'\n        .getter 'changed'\n        .getter 'prior'\n        .getter 'value'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'value',\n        get: -> @state.value\n\n      @property 'data',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> switch\n          when @binding?.get? then @binding.get @context\n          else @value\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @data\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.opts = {}\n          ctx.node = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor this\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      debug: -> debug @uri, arguments...\n      \n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@data`.\n\nIt also provides special handling based on different types of\n`@data` currently held.\n\n      get: (key) -> switch\n        when key?\n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].data\n            when match.length > 1  then match.map (x) -> x.data\n            else undefined\n        else @data\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        opts.origin ?= this\n        \n        # @debug \"[set] enter...\"\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n\n        if not opts.force and @binding?.set?\n          try value = @binding.set @context.with(opts), value \n          catch e\n            throw @error \"failed executing set() binding: #{e.message}\", e\n\n        return this if value? and @equals value, @value # return if same value\n        \n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        @debug \"[set] applying schema...\"        \n        value = switch\n          when @schema.apply? and not bypass\n            subopts = Object.assign {}, opts, inner: true, suppress: true\n            @schema.apply value, this, subopts\n          else value\n        @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error\n        return this if value? and @equals value, @value # return if same value\n        @update value, opts\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@value` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if value is null\n        return @set value, opts\n\n### delete\n\n      delete: (opts={}) ->\n        opts.origin ?= this\n        return this if @state.value is null\n        if not opts.force and @binding?.delete?\n          try @binding.delete @context.with(opts), null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @update null, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n        @state.prior ?= @state.value\n        @state.changed = @state.changed or (@state.value isnt value)\n        @state.value = value\n        @parent?.update this, opts # unless opts.suppress\n        return this\n\n### commit async transaction\n\nCommits the changes to the data model. Called *once* for each node that\nis part of the change branch.\n\n      commit: (opts={}) ->\n        opts.origin ?= this\n        return true unless @changed\n        try\n          unless opts.sync\n            # 1. perform save binding\n            @debug \"[commit] execute binding...\"\n            await @binding?.commit? @context.with(opts)\n            # 2. if has parent, then wait for parent commited before updating changed state\n            promise = @parent?.commit? opts\n              .then (ok) =>\n                if ok\n                  @state.prior = undefined\n                  @state.changed = false\n          unless promise?\n            @state.prior = undefined\n            @state.changed = false\n        catch err\n          @debug \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          throw @error err\n        return true\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @debug \"[revert] changing back to:\", @state.prior\n        unless @state.prior?\n          @delete opts\n        else\n          @state.value = @state.prior\n\n        @debug \"[revert] execute binding...\"\n        try await @binding?.commit? @context.with(opts) unless opts.sync\n        catch err\n          @debug \"[revert] failed due to #{err.message}\"\n          throw @error err\n          \n        @state.prior = undefined\n        @state.changed = false\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        unless @attached\n          # @debug \"[attach] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n\n          @set obj[name], Object.assign {}, opts, inner: true, suppress: true\n\n        unless opts.preserve\n          try Object.defineProperty obj, @name,\n              configurable: true\n              enumerable: @enumerable\n              get: (args...) => @get args...\n              set: (args...) => @set args...\n            \n        @state.attached = true\n        @debug \"[attach] attached into #{obj.constructor.name} container\"\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @data = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx) ->\n        err = new Error err unless err instanceof Error\n        err.uri ?= @uri\n        err.src ?= this\n        err.ctx ?= ctx\n        return err\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @data\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:    @name\n          kind:    @kind\n          path:    @path.toString()\n          active:  @active\n          private: @private\n          mutable: @mutable\n          changed: @changed\n          schema: switch\n            when @schema.uri?\n              uri:      @schema.uri\n              summary:  @schema.description?.tag\n              datakey:  @schema.datakey\n              datapath: @schema.datapath\n              external: @schema.external\n              children: @schema.children.map (x) -> x.uri\n            else false\n          value: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    Yang     = require '.\/yang'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (spec={}) ->\n        # NOTE: ES6\/CS2 does not support below\n        # unless this instanceof Property then return new Property arguments...\n\n        # 1. parse if spec is YANG definition (string)\n        spec = Yang.parse spec if typeof spec is 'string'\n        \n        # 2. assign if spec is an instance of Yang schema\n        schema = spec if spec instanceof Yang\n        \n        # 3. destructure spec as an object if not schema as instance\n        { name, schema } = spec unless schema?\n        \n        # 4. parse if schema is YANG definition (string)\n        schema = Yang.parse schema if typeof schema is 'string'\n        schema ?= kind: 'anydata'\n\n        # 5. initialize property instance\n        @name = name ? schema.datakey\n        @schema = schema\n        @state = \n          parent:    null\n          strict:    false\n          private:   false\n          mutable:   `schema.config != false`\n          attached:  false\n          changed:   false\n          prior:     undefined\n          value:     undefined\n\n        # 6. soft freeze this instance\n        Object.preventExtensions this\n\n      delegate @prototype, 'state'\n        .access 'parent'\n        .access 'strict'\n        .getter 'private'\n        .getter 'mutable'\n        .getter 'attached'\n        .getter 'changed'\n        .getter 'prior'\n        .getter 'value'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'value',\n        get: -> @state.value\n\n      @property 'data',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> switch\n          when @binding?.get? then @binding.get @context\n          else @value\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @data\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.opts = {}\n          ctx.node = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor this\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      debug: -> debug @uri, arguments...\n      \n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@data`.\n\nIt also provides special handling based on different types of\n`@data` currently held.\n\n      get: (key) -> switch\n        when key?\n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].data\n            when match.length > 1  then match.map (x) -> x.data\n            else undefined\n        else @data\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        opts.origin ?= this\n        \n        # @debug \"[set] enter...\"\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n\n        if not opts.force and @binding?.set?\n          try value = @binding.set @context.with(opts), value \n          catch e\n            throw @error \"failed executing set() binding: #{e.message}\", e\n\n        return this if value? and @equals value, @value # return if same value\n        \n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        @debug \"[set] applying schema...\"        \n        value = switch\n          when @schema.apply? and not bypass\n            subopts = Object.assign {}, opts, inner: true, suppress: true\n            @schema.apply value, this, subopts\n          else value\n        @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error\n        return this if value? and @equals value, @value # return if same value\n        @update value, opts\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@value` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if value is null\n        return @set value, opts\n\n### delete\n\n      delete: (opts={}) ->\n        opts.origin ?= this\n        return this if @state.value is null\n        if not opts.force and @binding?.delete?\n          try @binding.delete @context.with(opts), null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @update null, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n        @state.prior ?= @state.value\n        @state.changed = @state.changed or (@state.value isnt value)\n        @state.value = value\n        @parent?.update this, opts # unless opts.suppress\n        return this\n\n### commit async transaction\n\nCommits the changes to the data model. Called *once* for each node that\nis part of the change branch.\n\n      commit: (opts={}) ->\n        opts.origin ?= this\n        return true unless @changed\n        try\n          unless opts.sync\n            # 1. perform save binding\n            @debug \"[commit] execute binding...\"\n            await @binding?.commit? @context.with(opts)\n            # 2. if has parent, then wait for parent commited before updating changed state\n            promise = @parent?.commit? opts\n              .then (ok) =>\n                @state.changed = false if ok\n          unless promise?\n            @state.changed = false\n        catch err\n          @debug \"[commit] revert due to #{err.message}\"\n          await @revert opts\n          throw @error err\n        return true\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        @debug \"[revert] changing back to:\", @state.prior\n        # XXX - don't need the below?\n        # @delete opts unless @state.prior?\n        @state.value = @state.prior\n\n        @debug \"[revert] execute binding...\"\n        try await @binding?.commit? @context.with(opts) unless opts.sync\n        catch err\n          @debug \"[revert] failed due to #{err.message}\"\n          throw @error err\n          \n        @state.changed = false\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        unless @attached\n          # @debug \"[attach] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n\n          @set obj[name], Object.assign {}, opts, inner: true, suppress: true\n\n        unless opts.preserve\n          try Object.defineProperty obj, @name,\n              configurable: true\n              enumerable: @enumerable\n              get: (args...) => @get args...\n              set: (args...) => @set args...\n            \n        @state.attached = true\n        @debug \"[attach] attached into #{obj.constructor.name} container\"\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @data = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx) ->\n        err = new Error err unless err instanceof Error\n        err.uri ?= @uri\n        err.src ?= this\n        err.ctx ?= ctx\n        return err\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @data\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:    @name\n          kind:    @kind\n          path:    @path.toString()\n          active:  @active\n          private: @private\n          mutable: @mutable\n          changed: @changed\n          schema: switch\n            when @schema.uri?\n              uri:      @schema.uri\n              summary:  @schema.description?.tag\n              datakey:  @schema.datakey\n              datapath: @schema.datapath\n              external: @schema.external\n              children: @schema.children.map (x) -> x.uri\n            else false\n          value: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"8189beacc4b06055e2e21b75f40c1cb4e1233d46","subject":"Lowercase image extention before testing","message":"Lowercase image extention before testing\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/server.litcoffee","new_file":"src\/server.litcoffee","new_contents":"    url          = require 'url'\n\n    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      origin = url.parse req.get('Origin') or ''\n\n      if origin.hostname not in origins\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status = 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension.toLowerCase() not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","old_contents":"    url          = require 'url'\n\n    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      origin = url.parse req.get('Origin') or ''\n\n      if origin.hostname not in origins\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status = 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4da67b3d30dbc2f73a3d1e69132c0089fda5fe38","subject":"weya lint","message":"weya lint\n","repos":"vpj\/weya,vpj\/weya","old_file":"weya.litcoffee","new_file":"weya.litcoffee","new_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: []\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = [c]\n        else\n         res.class.push c\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        elem.id = idClass.id\n       if idClass.class?\n        if elem.classList?\n         for c in idClass.class\n          elem.classList.add c\n        else #For older browsers; does not work with svgs\n         className = ''\n         for c in idClass.class\n          className += ' ' if className isnt ''\n          className += \"#{c}\"\n         elem.className = className\n\n      if attrs?\n       setAttributes elem, attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if contentFunction?\n       contentFunction.call this\n      else if contentText?\n       elem.textContent = contentText\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: null\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = c\n        else\n         res.class += \" #{c}\"\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        buf.push \" id=\\\"#{idClass.id}\\\"\"\n       if idClass.class?\n        buf.push \" class=\\\"#{idClass.class}\\\"\"\n\n      if attrs?\n       setAttributes buf, attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if contentFunction?\n       contentFunction.call this\n      else if contentText?\n       setIndent buf, @_indent\n       buf.push contentText\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call this, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","old_contents":"List of SVG elements\n\n    Tags =\n     svg: 'a altGlyph altGlyphDef altGlyphItem animate animateColor\n      animateMotion animateTransform circle clipPath color-profile cursor\n      defs desc ellipse feBlend feColorMatrix feComponentTransfer\n      feComposite feConvolveMatrix feDiffuseLighting feDisplacementMap\n      feDistantLight feFlood feFuncA feFuncB feFuncG feFuncR feGaussianBlur\n      feImage feMerge feMergeNode feMorphology feOffset fePointLight\n      feSpecularLighting feSpotLight feTile feTurbulence\n      filter font font-face font-face-format font-face-name font-face-src\n      font-face-uri foreignObject g glyph glyphRef hkern image line\n      linearGradient marker mask metadata missing-glyph mpath path pattern\n      polygon polyline radialGradient rect script set stop style svg symbol\n      text textPath title tref tspan use view vkern switch foreignObject'\n\nList of HTML elements\n\n     html: 'a abbr address article aside audio b bdi bdo blockquote body button\n      canvas caption cite code colgroup datalist dd del details dfn div dl dt\n      em fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header\n      hgroup html i iframe ins kbd label legend li main map mark menu meter\n      nav noscript object ol optgroup option output p pre progress q rp rt\n      ruby s samp script section select small span strong style sub summary\n      sup table tbody td textarea tfoot th thead time title tr u ul video'\n\n     htmlVoid: 'area base br col command embed hr img input keygen link meta\n      param source track wbr'\n\nWrapper for browser API\n\n    Api =\n     document: @document\n\n\n#Weya DOM\n\n    weyaDomCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _elem: null\n\nManipulating dom objects\n\n     setStyles = (elem, styles) ->\n      for k, v of styles\n       if v?\n        elem.style.setProperty k, v\n       else\n        elem.style.removeProperty k\n\n     setEvents = (elem, events) ->\n      for k, v of events\n       elem.addEventListener k, v, false\n\n     setAttributes = (elem, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles elem, v\n        when 'on' then setEvents elem, v\n        else\n         if v?\n          elem.setAttribute k, v\n         else\n          elem.removeAttribute k\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: []\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = [c]\n        else\n         res.class.push c\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\nKeep a reference to parent element\n\n      pElem = @_elem\n\nKeep a reference of `elem` to return at the end of the function\n\n      if ns?\n       elem = @_elem = Api.document.createElementNS ns, name\n      else\n       elem = @_elem = Api.document.createElement name\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        elem.id = idClass.id\n       if idClass.class?\n        if elem.classList?\n         for c in idClass.class\n          elem.classList.add c\n        else #For older browsers; does not work with svgs\n         className = ''\n         for c in idClass.class\n          className += ' ' if className isnt ''\n          className += \"#{c}\"\n         elem.className = className\n\n      if attrs?\n       setAttributes elem, attrs\n\n      if pElem?\n       pElem.appendChild elem\n\n      if contentFunction?\n       contentFunction.call @\n      else if contentText?\n       elem.textContent = contentText\n\n      @_elem = pElem\n      return elem\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call @, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/1999\/xhtml\", name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya Markup\n\n    weyaMarkupCreate = ->\n\nWeya object to be passed as `this`\n\n     weya =\n      _buf: null\n      _indent: 0\n\nRender components\n\n     setStyles = (buf, styles) ->\n      buf.push \" style=\\\"\"\n      for k, v of styles\n       buf.push \"#{k}:#{v};\"\n      buf.push \"\\\"\"\n\n     setEvents = (buf, events) ->\n      for k, v of events\n       buf.push \" on#{k}=\\\"#{v}\\\"\"\n\n     setAttributes = (buf, attrs) ->\n      for k, v of attrs\n       switch k\n        when 'style' then setStyles buf, v\n        when 'on' then setEvents buf, v\n        else\n         buf.push \" #{k}=\\\"#{v}\\\"\"\n\n     setIndent = (buf, indent) ->\n      for i in [0...indent]\n       buf.push \" \"\n\nParse id and class string\n\n     parseIdClass = (str) ->\n      res =\n       id: null\n       class: null\n\n      for c, i in str.split \".\"\n       if c.indexOf(\"#\") is 0\n        res.id = c.substr 1\n       else if c isnt \"\"\n        if not res.class?\n         res.class = c\n        else\n         res.class += \" #{c}\"\n\n      return res\n\n\nAppend a child element\n\n     append = (ns, name, args) ->\n      idClass = null\n      contentText = null\n      attrs = null\n      contentFunction = null\n\n      for arg, i in args\n       switch typeof arg\n        when 'function' then contentFunction = arg\n        when 'object' then attrs = arg\n        when 'string'\n         if args.length is 1\n          contentText = arg\n         else\n          c = arg.charAt 0\n\n          if i is 0 and (c is '#' or c is '.')\n           idClass = arg\n          else\n           contentText = arg\n\n      buf = @_buf\n\n      setIndent buf, @_indent\n\n      buf.push \"<#{name}\"\n\n      if idClass?\n       idClass = parseIdClass idClass\n       if idClass.id?\n        buf.push \" id=\\\"#{idClass.id}\\\"\"\n       if idClass.class?\n        buf.push \" class=\\\"#{idClass.class}\\\"\"\n\n      if attrs?\n       setAttributes buf, attrs\n\nCan close void elements (element that self close) with a `\/>`\n\n      buf.push \">\\n\"\n      @_indent++\n\n      if contentFunction?\n       contentFunction.call @\n      else if contentText?\n       setIndent buf, @_indent\n       buf.push contentText\n       buf.push \"\\n\"\n\n      @_indent--\n      setIndent buf, @_indent\n      buf.push \"<\/#{name}>\\n\"\n\nWrap `append`\n\n     wrapAppend = (ns, name) ->\n      ->\n       append.call @, ns, name, arguments\n\n\nInitialize\n\n     for name in Tags.svg.split ' '\n      weya[name] = wrapAppend \"http:\/\/www.w3.org\/2000\/svg\", name\n\n     for name in Tags.html.split ' '\n      weya[name] = wrapAppend null, name\n\n     for name in Tags.htmlVoid.split ' '\n      weya[name] = wrapAppend null, name\n\n     return weya\n\n\n#Weya API\n\n    weyaDom = weyaDomCreate()\n    weyaMarkup = weyaMarkupCreate()\n\nCreate and append to `options.elem`. If `options.context` is provied it can be\naccessed via `@$`. If `options.elem` is `null`, the element is created but\nnot appended.\n\n    @Weya = Weya = (options, func) ->\n     weya = weyaDom\n     pContext = weya.$\n     weya.$ = options.context\n     pElem = weya._elem\n     weya._elem = options.elem\n     r = func?.call weya\n     weya._elem = pElem\n     weya.$ = pContext\n     return r\n\n    Weya.markup = (options, func) ->\n     weya = weyaMarkup\n     pContext = weya.$\n     weya.$ = options.context\n     pBuf = weya._buf\n     weya._buf = []\n     r = func?.call weya\n     buf = weya._buf\n     weya._buf = pBuf\n     weya.$ = pContext\n     return buf.join ''\n\n    Weya.setApi = (api) ->\n     for k, v of api\n      Api[k] = v\n\n    if module?\n     module.exports = Weya\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"01314dfd4f048abb15e3b5686d853358850ec5d1","subject":"Document the file.","message":"Document the file.\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/getFiles.litcoffee","new_file":"guts\/getFiles.litcoffee","new_contents":"Grab the Files\n=====================\nI found that I we reusing a lot of the same logic to get the policies, controllers, and models, when in reality it is pretty trivial to reuse and just have a parameter. \n\n## Libraries\n\n    Promise = require 'bluebird'\n    _ = require 'lodash'\n    fs = Promise.promisifyAll require 'fs'\n\nNote: The `promisifyAll` function simply takes a module, suffixes the functions with the word `Async`, and makes them promisable instead of callbackey.\n\n----------\n\nLet's start the function. Expected input is a string of the type of file you want, and the expected output is a promise'd array of objects of the imported files. \n\n    module.exports = (type) ->\n\nLet's read in the folder of the files. \n\n        fs.readdirAsync '.\/#{type}'\n\nOnce the files have been loaded, the remaining logic is pretty simple: We `map` through them and require them, and from there we can plop them into an array.\n\n        .then (files) ->\n            _.map files, (file) ->\n                if ((file.match \/.+\\.js\/g)? or (file.match \/.+\\.coffee\/g)? or (file.match \/.+\\.litcoffee\/g)?)\n                    myObject = {}\n                    name = file.replace('.js', '').replace('.coffee', '').replace('.litcoffee', '')\n                    myObject[name] = require \"..\/#{type}\/#{name}\"\n                    myObject\n\nOnce we've put all these files into an array, we'd like to merge them into one big object.  We can utilize lodash's reduce function to handle returning back one item, and we can use lodash's extend function to handle the merging. \n\n        .then (fileArray) ->\n            _.reduce fileArray, _.extend\n","old_contents":"Grab the Files\n=====================\nI found that I we reusing a lot of the same logic to get the policies, controllers, and models, when in reality it is pretty trivial to reuse and just have a parameter. \n\n    Promise = require 'bluebird'\n    _ = require 'lodash'\n    fs = Promise.promisifyAll require 'fs'\n    module.exports = (type) ->\n        fs.readdirAsync '.\/#{type}'\n        .then (files) ->\n            _.map files, (file) ->\n                if ((file.match \/.+\\.js\/g)? or (file.match \/.+\\.coffee\/g)? or (file.match \/.+\\.litcoffee\/g)?)\n                    myObject = {}\n                    name = file.replace('.js', '').replace('.coffee', '').replace('.litcoffee', '')\n                    myObject[name] = require \"..\/#{type}\/#{name}\"\n                    myObject\n        .then (fileArray) ->\n            _.reduce fileArray, _.extend\n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"d9b8695457851481cf1dd3d15bb7a76e0fa49c0a","subject":"Disabled transparency on the render context.","message":"Disabled transparency on the render context.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat","old_file":"src\/rendering\/context.litcoffee","new_file":"src\/rendering\/context.litcoffee","new_contents":"Exports an object.\nCall \"load\" early in the application to get the WebGL context.\nThe \"context\" property is the WebGL context.\nThe \"width\" and \"height\" properties are the dimensions of the viewport in pixels.\n\n    handleError = require \".\/..\/handleError.litcoffee\"\n    matrix = require \".\/..\/matrix.litcoffee\"\n\n    module.exports =\n        canvas: null\n        context: null\n        width: null\n        height: null\n        load: ->\n            module.exports.canvas = (document.getElementsByTagName \"canvas\")[0]\n            module.exports.context = module.exports.canvas.getContext \"experimental-webgl\", \n                antialias: false\n                alpha: false\n            if not module.exports.context then handleError \"Failed to open a WebGL context\"\n            \n            resize = ->\n                module.exports.width = window.innerWidth\n                module.exports.height = window.innerHeight\n                if not module.exports.canvas then return\n                module.exports.canvas.width = module.exports.width\n                module.exports.canvas.height = module.exports.height\n                return\n                \n            addEventListener \"resize\", resize\n            resize()\n            return\n            \nCall the \"begin\" property to set up the camera and viewport.  This takes the\nfollowing arguments:\n\n- The distance, in pixels, between the left border of the screen and the\n  left border of the viewport.\n- The distance, in pixels, between the bottom border of the screen and the\n  bottom border of the viewport.\n- The width, in pixels, of the viewport.\n- The height, in pixels, of the viewport.\n- A zoom factor, where 1 is 100% and 2 is 200%.\n- The matrix to apply to all geometry the previous frame.\n- The matrix to apply to all geometry this frame.\n            \n        postScale: [1, 1]\n        transforms: [[],[]]\n            \n        begin: (left, bottom, width, height, zoom, oldTransform, newTransform) ->\n            gl = module.exports.context\n            gl.viewport left, bottom, width, height\n            gl.enable gl.SCISSOR_TEST\n            gl.scissor left, bottom, width, height\n            gl.clear gl.DEPTH_BUFFER_BIT\n            gl.disable gl.SCISSOR_TEST\n            \n            matrix.copy oldTransform, module.exports.transforms[0]\n            matrix.copy newTransform, module.exports.transforms[1]\n            \n            if width > height\n                module.exports.postScale[0] = zoom * height \/ width\n                module.exports.postScale[1] = zoom\n            else\n                module.exports.postScale[0] = zoom\n                module.exports.postScale[1] = zoom * width \/ height\n            return\n            \nSpecific to this implementation are the following properties:\n- \"postScale\": An array of two numbers to multiply the X and Y of every vertex\n               by in NDC.  This is used to apply zoom and aspect correction.\n- \"transforms\": An array of two matrices; the global transform from last frame\n                and this frame.","old_contents":"Exports an object.\nCall \"load\" early in the application to get the WebGL context.\nThe \"context\" property is the WebGL context.\nThe \"width\" and \"height\" properties are the dimensions of the viewport in pixels.\n\n    handleError = require \".\/..\/handleError.litcoffee\"\n    matrix = require \".\/..\/matrix.litcoffee\"\n\n    module.exports =\n        canvas: null\n        context: null\n        width: null\n        height: null\n        load: ->\n            module.exports.canvas = (document.getElementsByTagName \"canvas\")[0]\n            module.exports.context = module.exports.canvas.getContext \"experimental-webgl\", \n                antialias: false\n            if not module.exports.context then handleError \"Failed to open a WebGL context\"\n            \n            resize = ->\n                module.exports.width = window.innerWidth\n                module.exports.height = window.innerHeight\n                if not module.exports.canvas then return\n                module.exports.canvas.width = module.exports.width\n                module.exports.canvas.height = module.exports.height\n                return\n                \n            addEventListener \"resize\", resize\n            resize()\n            return\n            \nCall the \"begin\" property to set up the camera and viewport.  This takes the\nfollowing arguments:\n\n- The distance, in pixels, between the left border of the screen and the\n  left border of the viewport.\n- The distance, in pixels, between the bottom border of the screen and the\n  bottom border of the viewport.\n- The width, in pixels, of the viewport.\n- The height, in pixels, of the viewport.\n- A zoom factor, where 1 is 100% and 2 is 200%.\n- The matrix to apply to all geometry the previous frame.\n- The matrix to apply to all geometry this frame.\n            \n        postScale: [1, 1]\n        transforms: [[],[]]\n            \n        begin: (left, bottom, width, height, zoom, oldTransform, newTransform) ->\n            gl = module.exports.context\n            gl.viewport left, bottom, width, height\n            gl.enable gl.SCISSOR_TEST\n            gl.scissor left, bottom, width, height\n            gl.clear gl.DEPTH_BUFFER_BIT\n            gl.disable gl.SCISSOR_TEST\n            \n            matrix.copy oldTransform, module.exports.transforms[0]\n            matrix.copy newTransform, module.exports.transforms[1]\n            \n            if width > height\n                module.exports.postScale[0] = zoom * height \/ width\n                module.exports.postScale[1] = zoom\n            else\n                module.exports.postScale[0] = zoom\n                module.exports.postScale[1] = zoom * width \/ height\n            return\n            \nSpecific to this implementation are the following properties:\n- \"postScale\": An array of two numbers to multiply the X and Y of every vertex\n               by in NDC.  This is used to apply zoom and aspect correction.\n- \"transforms\": An array of two matrices; the global transform from last frame\n                and this frame.","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"77783cd08b995be32bf26e0bb84a2fd30aa70251","subject":"One more try with litcoffee","message":"One more try with litcoffee\n","repos":"Tombert\/frameworkeyPromiseEdition,Tombert\/frameworkeyPromiseEdition","old_file":"guts\/policies.litcoffee","new_file":"guts\/policies.litcoffee","new_contents":"Load in the libraries\n\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n\nLoad up the user-defined policies. \n\n    policies = require '..\/config\/policies'\n\n\n    module.exports = (routeActions, req, res) ->\n        new Promise (resolve, reject) ->\n            require('.\/getPolicies')()\n            .then (actualPolicies) ->\n                policyResults = _.flatten _.map routeActions, (action) ->\n                        # What I'm doing here is looking for the policies file.\n                        # If there is a policy defined for that action, use that, else use the * catch all. \n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\n                        _.map tempPolicies, (policy) ->\n                            # This is pretty straightforward; we'll loop up the policy in the hash\n                            # table and then return back their result (which can just be a true or false\n                            #\n                            # We want to make sure this is properly wrapped in promisey stuff, so we can init\n                            # an empty promise then run our stuff in the \"then\". Since our empty promise only\n                            # resolves, it won't hit the catch. \n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n                \n                Promise.all policyResults\n            .then (results) ->\n                # Not entirely sure I like this logic, but it's pretty straightforward:\n                # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                # either allow the policy to reject if not permitted or to simply return false. \n                unless false in results\n                  resolve true\n                else\n                  reject \"Not Authorized\"\n                \n","old_contents":"Libraries\n\n    _ = require 'lodash'\n    Promise = require \"bluebird\"\n    policies = require '..\/config\/policies'\n\n    module.exports = (routeActions, req, res) ->\n        new Promise (resolve, reject) ->\n            require('.\/getPolicies')()\n            .then (actualPolicies) ->\n                policyResults = _.flatten _.map routeActions, (action) ->\n                        # What I'm doing here is looking for the policies file.\n                        # If there is a policy defined for that action, use that, else use the * catch all. \n                        tempPolicies = _.flatten [policies[action.controllerName][action.actionName] || policies[action.controllerName]['*'] ]\n\n                        _.map tempPolicies, (policy) ->\n                            # This is pretty straightforward; we'll loop up the policy in the hash\n                            # table and then return back their result (which can just be a true or false\n                            #\n                            # We want to make sure this is properly wrapped in promisey stuff, so we can init\n                            # an empty promise then run our stuff in the \"then\". Since our empty promise only\n                            # resolves, it won't hit the catch. \n                            tempPromise = new Promise (resolve, reject) -> do resolve\n                            tempPromise.then -> actualPolicies[policy] req\n                \n                Promise.all policyResults\n            .then (results) ->\n                # Not entirely sure I like this logic, but it's pretty straightforward:\n                # I want to allow synchronous or asynchronous policies.  Subsequently, we can\n                # either allow the policy to reject if not permitted or to simply return false. \n                unless false in results\n                  resolve true\n                else\n                  reject \"Not Authorized\"\n                \n","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"7f7cce587b2dc74d1774f4292f36b7ccbe5b85a5","subject":"Properly pass resolve and reject handlers when decorators are present","message":"Properly pass resolve and reject handlers when decorators are present\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = underscore tokens[1].trim()\n      else if tokens.length == 1\n        alias = underscore name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @DUMMY: (deps, cb) ->\n        class __DUMMY__ extends Madul\n          deps: deps\n\n        new __DUMMY__()\n          .initialize()\n          .then cb\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || underscore(name), alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            WRAPPED[proto.constructor.name].push method\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, (errors) =>\n              if errors?\n                wrapped errors\n              else\n                proto[\"_#{method}\"] = proto[method]\n\n                proto[method] = =>\n                  def = q.defer()\n                  me  = proto[\"_#{method}\"]\n\n                  if args_format == 'ARRAY'\n                    args = Array.prototype.slice.call arguments\n                  else if args_format == 'OBJECT'\n                    args = arguments[0]\n                  else\n                    proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                    return def.reject 'No arg format specified'\n\n                  before = @_process_decorators me, 'before'\n                  after  = @_process_decorators me, 'after'\n\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries me.validators, (v, next) =>\n                      arg       = Object.keys(v)[0]\n                      validator = v[arg]\n                      input     = arg\n                      prop      = args\n\n                      for a in arg.split '.'\n                        prop  = prop[a]\n                        input = a\n\n                      if Array.isArray validator\n                        async.eachSeries validator, (v, nxt) =>\n                          proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                          proto[v].EXECUTE.call proto[v], input, prop\n                            .then nxt\n                            .catch handle_err v, { \"#{input}\": prop }, nxt, (err) =>\n                              reject err\n                              def.reject err\n                        , next\n                      else\n                        proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                        proto[validator].EXECUTE.call proto[validator], input, prop\n                          .then next\n                          .catch handle_err v, { \"#{input}\": prop }, next, (err) =>\n                            reject err\n                            def.reject err\n                    , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      async.eachSeries before, (b, next) =>\n                        proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                        proto[b].before.call proto[b], args\n                          .then next\n                          .catch handle_err b, args, next, (err) =>\n                            reject err\n                            def.reject err\n                      , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      input = proto._prep_invocation proto, method, args, { resolve, reject }\n\n                      try\n                        me.behavior.apply proto, input\n                      catch e\n                        me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                        reject e\n                  .catch (err) => def.reject err\n                  .then (result) =>\n                    q.Promise (resolve, reject) =>\n                      if after.length > 0\n                        async.eachSeries after, (a, next) =>\n                          proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                          proto[a].after.call proto[a], result\n                            .then next\n                            .catch handle_err b, args, next, (err) =>\n                              reject err\n                              def.reject err\n                        , => resolve result\n                      else\n                        process.nextTick => resolve result\n                  .then  (out) => def.resolve out\n                  .catch (err) => def.reject  err\n\n                  def.promise\n\n                INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n                WRAPPED[proto.constructor.name].push method\n\n                wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if proto.deps?\n                filtered = proto.deps.filter (d) => Madul.PARSE_SPEC(d).name == prop.replace \/_\/g, '-'\n\n                continue if filtered.length > 0\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, (errors) =>\n              if errors?\n                stop = new Error()\n                stop.break = true\n\n                next stop\n              else\n                next()\n          , (errors) =>\n            if errors?\n              stop = new Error()\n              stop.break = true\n\n              completed stop\n            else\n              @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{strip name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, (errors) =>\n                if errors?\n                  stop = new Error()\n                  stop.break = true\n\n                  next stop\n                else\n                  HYDRATED[name] = true\n\n                  for listener in HYRDATION_LISTENERS[name]\n                    listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, done, fail) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then  (m)   => done m\n            .catch (err) => fail err\n        else\n          done mod\n\n      _load: (me, name, path, loaded, fail) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded()\n        , fail\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.eachSeries files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.' && f != 'node_modules'\n                  me._check me, depth, dep, ref, => next()\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  stop  = new Error()\n                  stop.break = true\n\n                  me._load me, ref, depth, =>\n                    me._do_add me, ref, => next stop\n                  , (err) => next stop\n                else\n                  next()\n            , => finished()\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next() if typeof next == 'function'\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n        , (err) =>\n          stop = new Error()\n          stop.break = true\n\n          next stop\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n        errors  = [ ]\n\n        async.eachSeries deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                if proto[spec.parent]?\n                  deep = SEARCH_ROOTS[spec.parent]\n\n                  proto._check proto, deep, spec.name, spec.ref, (err) =>\n                    if err == 'NOT_FOUND'\n                      proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                        if err?\n                          stop = new Error()\n                          stop.break = true\n\n                          proto.warn.call proto, 'not-found', dep: d\n\n                          next stop\n                        else\n                          next()\n                    else\n                      next()\n                else\n                  proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                  @_do_hydrate proto, [ spec.parent ], (errors) =>\n                    if errors?\n                      stop = new Error()\n                      stop.break = true\n\n                      next stop\n                    else\n                      if SEARCH_ROOTS[spec.parent] == undefined\n                        SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                      deep = SEARCH_ROOTS[spec.parent]\n\n                      proto._check proto, deep, spec.name, spec.ref, (err) =>\n                        if err == 'NOT_FOUND'\n                          proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                            if err?\n                              stop = new Error()\n                              stop.break = true\n\n                              proto.warn.call proto, 'not-found', dep: d\n\n                              next stop\n                            else\n                              next()\n                        else\n                          next()\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    nxt()\n                  , =>\n                    nxt()\n                , =>\n                  next()\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, (err) =>\n                  if err?\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next stop\n                  else\n                    next()\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , (err) =>\n          if err?.length > 0\n            proto.warn.call proto, 'hydration.halt', errors\n\n            hydration_complete errors\n          else\n            async.eachSeries initers, (initer, next) =>\n              proto[initer.execute].apply(@).then next\n            , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, next) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n        fs.stat pkg, (err, stat) =>\n          if err?\n            next()\n          else if stat.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            next()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        filtered = found.filter (f) => f?\n\n        if filtered.length > 0\n          filtered.sort((a, b) => a.length - b.length)[0]\n        else\n          [ ]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            if name == '__DUMMY__'\n              LOCALS[name] = \"#{process.cwd()}\/dist\"\n            else\n              LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, (errors) =>\n            if errors?\n              deferred.reject errors\n            else\n              @_wrap_methods proto, (err) =>\n                if err?\n                  deferred.reject err\n                else\n                  @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = underscore tokens[1].trim()\n      else if tokens.length == 1\n        alias = underscore name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @DUMMY: (deps, cb) ->\n        class __DUMMY__ extends Madul\n          deps: deps\n\n        new __DUMMY__()\n          .initialize()\n          .then cb\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || underscore(name), alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            WRAPPED[proto.constructor.name].push method\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, (errors) =>\n              if errors?\n                wrapped errors\n              else\n                proto[\"_#{method}\"] = proto[method]\n\n                proto[method] = =>\n                  def = q.defer()\n                  me  = proto[\"_#{method}\"]\n\n                  if args_format == 'ARRAY'\n                    args = Array.prototype.slice.call arguments\n                  else if args_format == 'OBJECT'\n                    args = arguments[0]\n                  else\n                    proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                    return def.reject 'No arg format specified'\n\n                  before = @_process_decorators me, 'before'\n                  after  = @_process_decorators me, 'after'\n\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries me.validators, (v, next) =>\n                      arg       = Object.keys(v)[0]\n                      validator = v[arg]\n                      input     = arg\n                      prop      = args\n\n                      for a in arg.split '.'\n                        prop  = prop[a]\n                        input = a\n\n                      if Array.isArray validator\n                        async.eachSeries validator, (v, nxt) =>\n                          proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                          proto[v].EXECUTE.call proto[v], input, prop\n                            .then nxt\n                            .catch handle_err v, { \"#{input}\": prop }, nxt, (err) =>\n                              reject err\n                              def.reject err\n                        , next\n                      else\n                        proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                        proto[validator].EXECUTE.call proto[validator], input, prop\n                          .then next\n                          .catch handle_err v, { \"#{input}\": prop }, next, (err) =>\n                            reject err\n                            def.reject err\n                    , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      async.eachSeries before, (b, next) =>\n                        proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                        proto[b].before.call proto[b], args\n                          .then next\n                          .catch handle_err b, args, next, (err) =>\n                            reject err\n                            def.reject err\n                      , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      d     = q.defer()\n                      input = proto._prep_invocation proto, method, args, d\n\n                      try\n                        me.behavior.apply proto, input\n                          .then  (out) => resolve out\n                          .catch (err) => reject  err\n                      catch e\n                        me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                        reject e\n                  .catch (err) => def.reject err\n                  .then (result) =>\n                    q.Promise (resolve, reject) =>\n                      if after.length > 0\n                        async.eachSeries after, (a, next) =>\n                          proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                          proto[a].after.call proto[a], result\n                            .then next\n                            .catch handle_err b, args, next, (err) =>\n                              reject err\n                              def.reject err\n                        , => resolve result\n                      else\n                        process.nextTick => resolve result\n                  .then  (out) => def.resolve out\n                  .catch (err) => def.reject  err\n\n                  def.promise\n\n                INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n                WRAPPED[proto.constructor.name].push method\n\n                wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if proto.deps?\n                filtered = proto.deps.filter (d) => Madul.PARSE_SPEC(d).name == prop.replace \/_\/g, '-'\n\n                continue if filtered.length > 0\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, (errors) =>\n              if errors?\n                stop = new Error()\n                stop.break = true\n\n                next stop\n              else\n                next()\n          , (errors) =>\n            if errors?\n              stop = new Error()\n              stop.break = true\n\n              completed stop\n            else\n              @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{strip name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, (errors) =>\n                if errors?\n                  stop = new Error()\n                  stop.break = true\n\n                  next stop\n                else\n                  HYDRATED[name] = true\n\n                  for listener in HYRDATION_LISTENERS[name]\n                    listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, done, fail) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then  (m)   => done m\n            .catch (err) => fail err\n        else\n          done mod\n\n      _load: (me, name, path, loaded, fail) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded()\n        , fail\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.eachSeries files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.' && f != 'node_modules'\n                  me._check me, depth, dep, ref, => next()\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  stop  = new Error()\n                  stop.break = true\n\n                  me._load me, ref, depth, =>\n                    me._do_add me, ref, => next stop\n                  , (err) => next stop\n                else\n                  next()\n            , => finished()\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next() if typeof next == 'function'\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n        , (err) =>\n          stop = new Error()\n          stop.break = true\n\n          next stop\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n        errors  = [ ]\n\n        async.eachSeries deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                if proto[spec.parent]?\n                  deep = SEARCH_ROOTS[spec.parent]\n\n                  proto._check proto, deep, spec.name, spec.ref, (err) =>\n                    if err == 'NOT_FOUND'\n                      proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                        if err?\n                          stop = new Error()\n                          stop.break = true\n\n                          proto.warn.call proto, 'not-found', dep: d\n\n                          next stop\n                        else\n                          next()\n                    else\n                      next()\n                else\n                  proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                  @_do_hydrate proto, [ spec.parent ], (errors) =>\n                    if errors?\n                      stop = new Error()\n                      stop.break = true\n\n                      next stop\n                    else\n                      if SEARCH_ROOTS[spec.parent] == undefined\n                        SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                      deep = SEARCH_ROOTS[spec.parent]\n\n                      proto._check proto, deep, spec.name, spec.ref, (err) =>\n                        if err == 'NOT_FOUND'\n                          proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                            if err?\n                              stop = new Error()\n                              stop.break = true\n\n                              proto.warn.call proto, 'not-found', dep: d\n\n                              next stop\n                            else\n                              next()\n                        else\n                          next()\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    nxt()\n                  , =>\n                    nxt()\n                , =>\n                  next()\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, (err) =>\n                  if err?\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next stop\n                  else\n                    next()\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , (err) =>\n          if err?.length > 0\n            proto.warn.call proto, 'hydration.halt', errors\n\n            hydration_complete errors\n          else\n            async.eachSeries initers, (initer, next) =>\n              proto[initer.execute].apply(@).then next\n            , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, next) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n        fs.stat pkg, (err, stat) =>\n          if err?\n            next()\n          else if stat.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            next()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        filtered = found.filter (f) => f?\n\n        if filtered.length > 0\n          filtered.sort((a, b) => a.length - b.length)[0]\n        else\n          [ ]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            if name == '__DUMMY__'\n              LOCALS[name] = \"#{process.cwd()}\/dist\"\n            else\n              LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, (errors) =>\n            if errors?\n              deferred.reject errors\n            else\n              @_wrap_methods proto, (err) =>\n                if err?\n                  deferred.reject err\n                else\n                  @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"eaa0f4b545550cf301554b40ab3ef0aff9df1d00","subject":"Clean up file path checking logic","message":"Clean up file path checking logic\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = underscore tokens[1].trim()\n      else if tokens.length == 1\n        alias = underscore name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @DUMMY: (deps, cb) ->\n        class __DUMMY__ extends Madul\n          deps: deps\n\n        new __DUMMY__()\n          .initialize()\n          .then cb\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || underscore(name), alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            WRAPPED[proto.constructor.name].push method\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, (errors) =>\n              if errors?\n                wrapped errors\n              else\n                proto[\"_#{method}\"] = proto[method]\n\n                proto[method] = =>\n                  def = q.defer()\n                  me  = proto[\"_#{method}\"]\n\n                  if args_format == 'ARRAY'\n                    args = Array.prototype.slice.call arguments\n                  else if args_format == 'OBJECT'\n                    args = arguments[0]\n                  else\n                    proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                    return def.reject 'No arg format specified'\n\n                  before = @_process_decorators me, 'before'\n                  after  = @_process_decorators me, 'after'\n\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries me.validators, (v, next) =>\n                      arg       = Object.keys(v)[0]\n                      validator = v[arg]\n                      input     = arg\n                      prop      = args\n\n                      for a in arg.split '.'\n                        prop  = prop[a]\n                        input = a\n\n                      if Array.isArray validator\n                        async.eachSeries validator, (v, nxt) =>\n                          proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                          proto[v].EXECUTE.call proto[v], input, prop\n                            .then nxt\n                            .catch handle_err v, { \"#{input}\": prop }, nxt, (err) =>\n                              reject err\n                              def.reject err\n                        , next\n                      else\n                        proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                        proto[validator].EXECUTE.call proto[validator], input, prop\n                          .then next\n                          .catch handle_err v, { \"#{input}\": prop }, next, (err) =>\n                            reject err\n                            def.reject err\n                    , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      async.eachSeries before, (b, next) =>\n                        proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                        proto[b].before.call proto[b], args\n                          .then next\n                          .catch handle_err b, args, next, (err) =>\n                            reject err\n                            def.reject err\n                      , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      d     = q.defer()\n                      input = proto._prep_invocation proto, method, args, d\n\n                      try\n                        me.behavior.apply proto, input\n                          .then  (out) => resolve out\n                          .catch (err) => reject  err\n                      catch e\n                        me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                        reject e\n                  .catch (err) => def.reject err\n                  .then (result) =>\n                    q.Promise (resolve, reject) =>\n                      if after.length > 0\n                        async.eachSeries after, (a, next) =>\n                          proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                          proto[a].after.call proto[a], result\n                            .then next\n                            .catch handle_err b, args, next, (err) =>\n                              reject err\n                              def.reject err\n                        , => resolve result\n                      else\n                        process.nextTick => resolve result\n                  .then  (out) => def.resolve out\n                  .catch (err) => def.reject  err\n\n                  def.promise\n\n                INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n                WRAPPED[proto.constructor.name].push method\n\n                wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if proto.deps?\n                filtered = proto.deps.filter (d) => Madul.PARSE_SPEC(d).name == prop.replace \/_\/g, '-'\n\n                continue if filtered.length > 0\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, (errors) =>\n              if errors?\n                stop = new Error()\n                stop.break = true\n\n                next stop\n              else\n                next()\n          , (errors) =>\n            if errors?\n              stop = new Error()\n              stop.break = true\n\n              completed stop\n            else\n              @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{strip name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, (errors) =>\n                if errors?\n                  stop = new Error()\n                  stop.break = true\n\n                  next stop\n                else\n                  HYDRATED[name] = true\n\n                  for listener in HYRDATION_LISTENERS[name]\n                    listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, done, fail) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then  (m)   => done m\n            .catch (err) => fail err\n        else\n          done mod\n\n      _load: (me, name, path, loaded, fail) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded()\n        , fail\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.eachSeries files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.' && f != 'node_modules'\n                  me._check me, depth, dep, ref, => next()\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  stop  = new Error()\n                  stop.break = true\n\n                  me._load me, ref, depth, =>\n                    me._do_add me, ref, => next stop\n                  , (err) => next stop\n                else\n                  next()\n            , => finished()\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next() if typeof next == 'function'\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n        , (err) =>\n          stop = new Error()\n          stop.break = true\n\n          next stop\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n        errors  = [ ]\n\n        async.eachSeries deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                if proto[spec.parent]?\n                  deep = SEARCH_ROOTS[spec.parent]\n\n                  proto._check proto, deep, spec.name, spec.ref, (err) =>\n                    if err == 'NOT_FOUND'\n                      proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                        if err?\n                          stop = new Error()\n                          stop.break = true\n\n                          proto.warn.call proto, 'not-found', dep: d\n\n                          next stop\n                        else\n                          next()\n                    else\n                      next()\n                else\n                  proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                  @_do_hydrate proto, [ spec.parent ], (errors) =>\n                    if errors?\n                      stop = new Error()\n                      stop.break = true\n\n                      next stop\n                    else\n                      if SEARCH_ROOTS[spec.parent] == undefined\n                        SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                      deep = SEARCH_ROOTS[spec.parent]\n\n                      proto._check proto, deep, spec.name, spec.ref, (err) =>\n                        if err == 'NOT_FOUND'\n                          proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                            if err?\n                              stop = new Error()\n                              stop.break = true\n\n                              proto.warn.call proto, 'not-found', dep: d\n\n                              next stop\n                            else\n                              next()\n                        else\n                          next()\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    nxt()\n                  , =>\n                    nxt()\n                , =>\n                  next()\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, (err) =>\n                  if err?\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next stop\n                  else\n                    next()\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , (err) =>\n          if err?.length > 0\n            proto.warn.call proto, 'hydration.halt', errors\n\n            hydration_complete errors\n          else\n            async.eachSeries initers, (initer, next) =>\n              proto[initer.execute].apply(@).then next\n            , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, next) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n        fs.stat pkg, (err, stat) =>\n          if err?\n            next()\n          else if stat.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            next()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        filtered = found.filter (f) => f?\n\n        if filtered.length > 0\n          filtered.sort((a, b) => a.length - b.length)[0]\n        else\n          [ ]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, (errors) =>\n            if errors?\n              deferred.reject errors\n            else\n              @_wrap_methods proto, (err) =>\n                if err?\n                  deferred.reject err\n                else\n                  @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    SKIP_WRAP = [\n      'constructor'\n      'initialize'\n      'details'\n      'fire'\n      'warn'\n      'listen'\n      'set'\n      'runtime_exception'\n    ]\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      WRAPPED[cls] = [ ] unless WRAPPED[cls]?\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    determine_local = (token) ->\n      project_local = false\n      node_local    = false\n      name          = token.substring 1, token.length\n\n      if token[0] == '.'\n        project_local = true\n      else if token[0] == '~'\n        node_local = true\n      else\n        name = token\n\n      [project_local, node_local, name]\n\n    parse_name_and_local = (tokens) ->\n      [project_local, node_local, name] = determine_local tokens[0].trim()\n\n      if tokens.length == 2\n        alias = underscore tokens[1].trim()\n      else if tokens.length == 1\n        alias = underscore name\n      else\n        return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n      [project_local, node_local, name, alias]\n\n    parse_alias_and_parent = (token) ->\n      t = token.split '->'\n\n      if t[0].indexOf('#') > -1\n        r      = t[0].split '#'\n        parent = r[0].trim()\n        t[0]   = r[1]\n\n      [parent, t]\n\n    extract_properties = (token) ->\n      [parent, t] = parse_alias_and_parent token\n      [project_local, node_local, name, alias] = parse_name_and_local t\n\n      [project_local, node_local, name, alias, parent]\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @DUMMY: (deps, cb) ->\n        class __DUMMY__ extends Madul\n          deps: deps\n\n        new __DUMMY__()\n          .initialize()\n          .then cb\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        [project_local, node_local, name, alias, parent] = extract_properties tokens[0]\n\n        if tokens.length == 2\n          initializer = tokens[1].trim()\n          toks        = initializer.split ':'\n          initializer = toks[0].trim()\n\n          if toks.length == 2\n            prerequisites = toks[1].split(',').map (p) => p.trim()\n          else if toks.length > 2\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length > 2\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || underscore(name), alias, name, parent, initializer, prerequisites, project_local, node_local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details, finisher) =>\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n        finisher() if typeof finisher == 'function'\n\n      runtime_exception: (exit = false) =>\n        (err) =>\n          Madul.FIRE \"!.#{@constructor.name}.runtime-exception\",\n            stack:     err.stack\n            message:   err.message\n            timestamp: microtime.now()\n\n          process.exit(1) if exit == 'DIE_ON_EXCEPTION'\n\n      set: (prop, val) =>\n        proto = @.__proto__\n        mod   = available[strip proto.constructor.name.toLowerCase()]\n\n        if mod?\n          mod.__proto__[prop] = val\n\n      _report: (method, state, id, args, breaker) =>\n        invoke = undefined\n        params =\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n        if state == 'reject'\n          if typeof breaker == 'function'\n            stop = new Error()\n            stop.break = true\n\n            breaker stop\n\n          @warn \"#{method}.#{state}\", params\n        else\n          @fire \"#{method}.#{state}\", params\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data, breaker) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report method, state, id, data, breaker\n\n      _prep_invocation: (proto, method, input, def) =>\n        out = [ ]\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n        e   = (brk) =>\n          error = (err) => res 'reject', err, brk\n\n          if typeof brk == 'function'\n            error\n          else\n            error brk\n\n        if Array.isArray input\n          out = out.concat input\n        else if typeof input == 'object'\n          out.push input\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n\n          proto.warn.call proto, 'input.invalid', msg\n\n          throw new Error msg\n\n        out.push (out) => res 'resolve', out\n        out.push e\n        out.push (out) => res 'notify',  out\n\n        proto._report method, 'invoke', id, out\n\n        out\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method, wrapped) =>\n        if SKIP_WRAP.includes method\n          wrapped()\n        else\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def   = q.defer()\n              args  = Array.prototype.slice.call arguments\n              input = proto._prep_invocation proto, method, args, def\n\n              try\n                proto[\"_#{method}\"].apply proto, input\n              catch e\n                failed = if input[0].fail? then input[0].fail else input[input.length - 2]\n\n                proto.warn.call proto, 'runtime-exception', stack: e.stack, message: e.message\n\n                failed e.message\n\n              def.promise\n\n            INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n            WRAPPED[proto.constructor.name].push method\n\n            wrapped()\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  for v in val\n                    decs.push v\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      for V in v\n                        decs.push V\n                    else\n                      decs.push v\n                else\n                  decs.push val\n\n              proto[method].validators = [ ]\n\n              for own key, val of proto[method].validate\n                if Array.isArray val\n                  proto[method].validators.push \"#{key}\": for v in val\n                    Madul.PARSE_SPEC(v).ref\n                else if typeof val == 'object'\n                  for own k, v of val\n                    if Array.isArray v\n                      proto[method].validators.push \"#{key}.#{k}\": for V in v\n                        Madul.PARSE_SPEC(V).ref\n                    else\n                      proto[method].validators.push \"#{key}.#{k}\": Madul.PARSE_SPEC(v).ref\n                else\n                  proto[method].validators.push \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            deduped = decs.filter (e, i, a) => a.indexOf(e) == i\n\n            proto.fire.call proto, 'decorators.hydrate', deduped\n\n            handle_err = (fn, args, next, reject) =>\n              (err) =>\n                proto.warn.call proto, \"#{fn}.validator.failed\", args\n                reject err\n\n                stop = new Error()\n                stop.break = true\n\n                next stop\n\n            @_do_hydrate proto, deduped, (errors) =>\n              if errors?\n                wrapped errors\n              else\n                proto[\"_#{method}\"] = proto[method]\n\n                proto[method] = =>\n                  def = q.defer()\n                  me  = proto[\"_#{method}\"]\n\n                  if args_format == 'ARRAY'\n                    args = Array.prototype.slice.call arguments\n                  else if args_format == 'OBJECT'\n                    args = arguments[0]\n                  else\n                    proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                    return def.reject 'No arg format specified'\n\n                  before = @_process_decorators me, 'before'\n                  after  = @_process_decorators me, 'after'\n\n                  q.Promise (resolve, reject) =>\n                    async.eachSeries me.validators, (v, next) =>\n                      arg       = Object.keys(v)[0]\n                      validator = v[arg]\n                      input     = arg\n                      prop      = args\n\n                      for a in arg.split '.'\n                        prop  = prop[a]\n                        input = a\n\n                      if Array.isArray validator\n                        async.eachSeries validator, (v, nxt) =>\n                          proto.fire.call proto, 'validator.execute', \"#{v}\": prop\n\n                          proto[v].EXECUTE.call proto[v], input, prop\n                            .then nxt\n                            .catch handle_err v, { \"#{input}\": prop }, nxt, (err) =>\n                              reject err\n                              def.reject err\n                        , next\n                      else\n                        proto.fire.call proto, 'validator.execute', \"#{validator}\": prop\n\n                        proto[validator].EXECUTE.call proto[validator], input, prop\n                          .then next\n                          .catch handle_err v, { \"#{input}\": prop }, next, (err) =>\n                            reject err\n                            def.reject err\n                    , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      async.eachSeries before, (b, next) =>\n                        proto.fire.call proto, 'before_filter.execute', \"#{b}\": args\n\n                        proto[b].before.call proto[b], args\n                          .then next\n                          .catch handle_err b, args, next, (err) =>\n                            reject err\n                            def.reject err\n                      , resolve\n                  .catch (err) => def.reject err\n                  .then =>\n                    q.Promise (resolve, reject) =>\n                      d     = q.defer()\n                      input = proto._prep_invocation proto, method, args, d\n\n                      try\n                        me.behavior.apply proto, input\n                          .then  (out) => resolve out\n                          .catch (err) => reject  err\n                      catch e\n                        me.warn.call me, 'runtime-exception', stack: e.stack, message: e.message\n\n                        reject e\n                  .catch (err) => def.reject err\n                  .then (result) =>\n                    q.Promise (resolve, reject) =>\n                      if after.length > 0\n                        async.eachSeries after, (a, next) =>\n                          proto.fire.call proto, 'after_filter.execute', \"#{a}\": args\n\n                          proto[a].after.call proto[a], result\n                            .then next\n                            .catch handle_err b, args, next, (err) =>\n                              reject err\n                              def.reject err\n                        , => resolve result\n                      else\n                        process.nextTick => resolve result\n                  .then  (out) => def.resolve out\n                  .catch (err) => def.reject  err\n\n                  def.promise\n\n                INITIALIZERS proto.constructor.name, method if method[0] == '$'\n\n                WRAPPED[proto.constructor.name].push method\n\n                wrapped()\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              if proto.deps?\n                filtered = proto.deps.filter (d) => Madul.PARSE_SPEC(d).name == prop.replace \/_\/g, '-'\n\n                continue if filtered.length > 0\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method, (errors) =>\n              if errors?\n                stop = new Error()\n                stop.break = true\n\n                next stop\n              else\n                next()\n          , (errors) =>\n            if errors?\n              stop = new Error()\n              stop.break = true\n\n              completed stop\n            else\n              @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{strip name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, (errors) =>\n                if errors?\n                  stop = new Error()\n                  stop.break = true\n\n                  next stop\n                else\n                  HYDRATED[name] = true\n\n                  for listener in HYRDATION_LISTENERS[name]\n                    listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, done, fail) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then  (m)   => done m\n            .catch (err) => fail err\n        else\n          done mod\n\n      _load: (me, name, path, loaded, fail) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded()\n        , fail\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            finished 'NOT_FOUND'\n          else\n            async.eachSeries files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.' && f != 'node_modules'\n                  me._check me, depth, dep, ref, => next()\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  stop  = new Error()\n                  stop.break = true\n\n                  me._load me, ref, depth, =>\n                    me._do_add me, ref, => next stop\n                  , (err) => next stop\n                else\n                  next()\n            , => finished()\n\n      _do_add: (me, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = available[strip ref]\n\n        next() if typeof next == 'function'\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, ref, next\n        , (err) =>\n          stop = new Error()\n          stop.break = true\n\n          next stop\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n        errors  = [ ]\n\n        async.eachSeries deps, (d, next) =>\n          spec = Madul.PARSE_SPEC d\n\n          if spec.prerequisites?\n            insert_at = for p in spec.prerequisites\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: spec.alias, execute: spec.initializer\n          else if spec.initializer?\n            initers.push alias: spec.alias, execute: spec.initializer\n\n          if typeof proto[underscore spec.ref] == 'undefined'\n            if available[strip spec.ref]? == true\n              proto._do_add proto, spec.ref, next\n            else\n              if spec.parent?\n                if proto[spec.parent]?\n                  proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                    if err?\n                      deep = \"#{SEARCH_ROOTS[spec.parent]}\/node_modules\/#{spec.parent}\/dist\"\n\n                      proto._check proto, deep, spec.name, spec.ref, (e) =>\n                        next()\n                    else\n                      next()\n                else\n                  proto.fire.call proto, 'search_root.load', { name: spec.name, alias: spec.alias, parent: spec.parent }\n\n                  @_do_hydrate proto, [ spec.parent ], (errors) =>\n                    if errors?\n                      stop = new Error()\n                      stop.break = true\n\n                      next stop\n                    else\n                      if SEARCH_ROOTS[spec.parent] == undefined\n                        SEARCH_ROOTS[spec.parent] = @_find_code_root spec.parent\n\n                      proto._check proto, SEARCH_ROOTS[spec.parent], spec.name, spec.ref, (err) =>\n                        if err?\n                          deep = \"#{SEARCH_ROOTS[spec.parent]}\/node_modules\/#{spec.parent}\/dist\"\n\n                          proto._check proto, deep, spec.name, spec.ref, (e) =>\n                            next()\n                        else\n                          next()\n              else if spec.node_local\n                key = @_find_require_key proto.constructor.name\n\n                async.eachSeries require.cache[key].paths, (path, nxt) =>\n                  @_load_from_package_json proto, path, spec.name, spec.ref, =>\n                    nxt()\n                  , =>\n                    nxt()\n                , =>\n                  next()\n              else if spec.project_local\n                proto._check proto, LOCALS[proto.constructor.name], spec.name, spec.ref, (err) =>\n                  if err?\n                    details = not_found: spec.name\n                    stop    = new Error()\n\n                    stop.break = true\n\n                    proto.warn.call proto, 'hydrating', details\n\n                    errors.push(details)\n\n                    next stop\n                  else\n                    next()\n              else\n                try\n                  proto._add proto, spec.ref, spec.name, next\n                catch e\n                  path = \"#{process.cwd()}\/node_modules\"\n\n                  @_load_from_package_json proto, path, spec.name, spec.ref, next, =>\n                    pth = LOCALS[proto.constructor.name]\n\n                    try\n                      proto._check proto, pth, spec.name, spec.ref, (err) =>\n                        if err?\n                          proto._check proto, \"#{process.cwd()}\/dist\", spec.name, spec.ref, next\n                        else\n                          next()\n\n          else\n            next()\n        , (err) =>\n          if err?.length > 0\n            proto.warn.call proto, 'hydration.halt', errors\n\n            hydration_complete errors\n          else\n            async.eachSeries initers, (initer, next) =>\n              proto[initer.execute].apply(@).then next\n            , hydration_complete\n\n      _load_from_package_json: (proto, path, name, ref, success, next) =>\n        pkg = \"#{path}\/#{name}\/package.json\"\n        fs.stat pkg, (err, stat) =>\n          if err?\n            next()\n          else if stat.isFile()\n            fs.readFile pkg, 'utf8', (err, data) =>\n              json = JSON.parse data\n              main = json.main || json._main || 'index.js'\n              path = \"#{path}\/#{name}\/#{main}\"\n\n              proto._add proto, ref, path, success\n          else\n            next()\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _do_find: (thing, cb) =>\n        file  = thing.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            cb key\n\n        filtered = found.filter (f) => f?\n\n        if filtered.length > 0\n          filtered.sort((a, b) => a.length - b.length)[0]\n        else\n          [ ]\n\n      _find_require_key: (resource) =>\n        @_do_find resource, (key) => key\n\n      _find_code_root: (resource) =>\n        @_do_find resource, (key) => key.substring(0, key.lastIndexOf '\/').split '\/'\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, (errors) =>\n            if errors?\n              deferred.reject errors\n            else\n              @_wrap_methods proto, (err) =>\n                if err?\n                  deferred.reject err\n                else\n                  @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"61eb2496fd76a544e7a6b5ec1dc13b292c5c19b0","subject":"change port for heroku tests","message":"change port for heroku tests\n","repos":"pirati-cz\/gapi-sparql","old_file":"src\/gapi_sparql.litcoffee","new_file":"src\/gapi_sparql.litcoffee","new_contents":"\nGapiSparql - Main class for GAPI SPARQL component\n\n    restify = require('restify')\n    self = null\n\n    class GapiSparql\n\n        constructor: (options) ->\n            console.log('GapiSparql construct...')\n            self = @\n            @options = options or {}\n            \n            @options.name = 'gapi-sparql'\n            @options.version = '0.0.1'\n            @options.accept = \n            #@options.formatters = {}\n            #@options.formatters['application\/sparql-query'] = @sparqlQuery\n            @options.listenPort ?= 8008\n            # @options.accept \n            \n            server = restify.createServer(@options)\n            #server.pre( (req, res, next) ->\n            #    req.headers.accept = 'application\/sparql-query'\n            #    return next()\n            #)\n            server.listen(@options.listenPort, () ->\n                console.log('%s listening at %s', server.name, server.url)\n            )\n            server.get('\/.*\/', (req, res, next) -> \n                # console.log(res)\n                d = \"ahoj svete\"\n                res.writeHead(200, {\n                    'Content-Length': Buffer.byteLength(d),\n                    'Content-Type': 'text\/plain'\n                })\n                res.write(d)\n                res.end()\n                next()\n            )\n            @server = server\n\n        @run: (argv, exit) ->\n            console.log('GapiSparql @run()')\n            gapisparql = new GapiSparql()\n            \n        sparqlQuery: (req, res, body) ->\n            console.log('GapiSparql @sparqlQuery()')\n            body = \"ahok\"\n            #console.log(body)\n            #console.log('----- GapiSparql @sparqlQuery() -----');\n            ###\n            if body instanceof Error\n                res.statusCode = body.statusCode || 500\n                if body.body\n                    #console.log('dada');\n                    #body = body.body.message\n                    body = \"ttt\"\n                else\n                    #body = message: body.message\n                    body = \"fifif\"\n                data = \"err\"\n            else\n                body = \"body pyco\"\n                data = \"aaa\"\n            console.log(body)\n            #console.log(req)\n            #console.log(res)\n            #console.log(body)\n            res.setHeader('Content-Length', Buffer.byteLength(body))\n            return body\n            ###\n            return body\n        \n        use: (pluginName) ->\n            \n      \n    module.exports = GapiSparql","old_contents":"\nGapiSparql - Main class for GAPI SPARQL component\n\n    restify = require('restify')\n    self = null\n\n    class GapiSparql\n\n        constructor: (options) ->\n            console.log('GapiSparql construct...')\n            self = @\n            @options = options or {}\n            \n            @options.name = 'gapi-sparql'\n            @options.version = '0.0.1'\n            @options.accept = \n            #@options.formatters = {}\n            #@options.formatters['application\/sparql-query'] = @sparqlQuery\n            @options.listenPort ?= 443\n            # @options.accept \n            \n            server = restify.createServer(@options)\n            #server.pre( (req, res, next) ->\n            #    req.headers.accept = 'application\/sparql-query'\n            #    return next()\n            #)\n            server.listen(@options.listenPort, () ->\n                console.log('%s listening at %s', server.name, server.url)\n            )\n            server.get('\/.*\/', (req, res, next) -> \n                # console.log(res)\n                d = \"ahoj svete\"\n                res.writeHead(200, {\n                    'Content-Length': Buffer.byteLength(d),\n                    'Content-Type': 'text\/plain'\n                })\n                res.write(d)\n                res.end()\n                next()\n            )\n            @server = server\n\n        @run: (argv, exit) ->\n            console.log('GapiSparql @run()')\n            gapisparql = new GapiSparql()\n            \n        sparqlQuery: (req, res, body) ->\n            console.log('GapiSparql @sparqlQuery()')\n            body = \"ahok\"\n            #console.log(body)\n            #console.log('----- GapiSparql @sparqlQuery() -----');\n            ###\n            if body instanceof Error\n                res.statusCode = body.statusCode || 500\n                if body.body\n                    #console.log('dada');\n                    #body = body.body.message\n                    body = \"ttt\"\n                else\n                    #body = message: body.message\n                    body = \"fifif\"\n                data = \"err\"\n            else\n                body = \"body pyco\"\n                data = \"aaa\"\n            console.log(body)\n            #console.log(req)\n            #console.log(res)\n            #console.log(body)\n            res.setHeader('Content-Length', Buffer.byteLength(body))\n            return body\n            ###\n            return body\n        \n        use: (pluginName) ->\n            \n      \n    module.exports = GapiSparql","returncode":0,"stderr":"","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"554b7853579af716a2e4ce6f112372152ccd477b","subject":"Pass directive definition object to skinLink hook implementations","message":"Pass directive definition object to skinLink hook implementations\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-skin\/client\/index.litcoffee","new_file":"packages\/shrub-skin\/client\/index.litcoffee","new_contents":"# Skinning\n\n*Implement the skin system, allowing clients to change the look and feel of\nthe site on-the-fly, as well as quickly load assets from the default skin on\npage load.*\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularDirectiveAlter`.\n\n      registrar.registerHook 'shrubAngularDirectiveAlter', (directive, path) -> [\n\n        '$cacheFactory', '$compile', '$http', '$injector', '$interpolate', '$q', '$rootScope'\n        ($cacheFactory, $compile, $http, $injector, $interpolate, $q, $rootScope) ->\n\nEnsure ID is a candidate.\n\n          directive.candidateKeys ?= []\n          directive.candidateKeys.unshift 'id'\n\n          currentSkinKey = null\n          defaultSkinKey = config.get 'packageConfig:shrub-skin:default'\n\nProxy link function to add our own directive retrieval and compilation step.\n\n          link = directive.link\n          directive.link = (scope, element, attr, controller, transclude) ->\n\n            candidateHooksInvoked = {}\n\nSave top-level arguments for later calls to link functions.\n\n            topLevelArgs = arguments\n\nCurrent template candidate.\n\n            candidate = undefined\n\n            recalculateCandidate = ->\n\nGet the skin assets.\n\n              skinAssets = config.get(\n                \"packageConfig:shrub-skin:assets:#{currentSkinKey}\"\n              )\n\nTrack changes to the current template candidate.\n\n              oldCandidate = candidate\n\nBuild a list of all candidates by first attempting to interpolate candidate\nkeys, and falling back to attribute values, if any. Candidate arrays are joined\nby single dashes.\n\n              candidateList = do ->\n                list = []\n\n                for keys in directive.candidateKeys\n                  keys = [keys] unless angular.isArray keys\n\n                  item = []\n                  for key in keys\n\n                    specific = scope[key]\n                    specific = attr[key] unless specific\n\n                    item.push specific if specific\n\n                  item = item.join '-'\n                  list.push item if item\n\n                list\n\nMap the candidate list to template filenames and add the base path template\ncandidate.\n\n              candidateTemplates = for candidate_ in candidateList\n                \"#{path}--#{candidate_}.html\"\n              candidateTemplates.push \"#{path}.html\"\n\nReturn the first existing template. The asset templates are already sorted by\ndescending specificity.\n\n              candidate = do ->\n                for uri in candidateTemplates\n                  return uri if skinAssets?.templates?[uri]\n\n                return null\n\nIf the candidate changed, clear the hook invocation cache and relink.\n\n              if candidate isnt oldCandidate\n                candidateHooksInvoked = {}\n\nInsert and compile the template HTML if it exists.\n\n                if skinAssets?.templates?[candidate]\n\nInsert and compile HTML.\n\n                  element.html skinAssets.templates[candidate]\n                  $compile(element.contents())(scope)\n\nCall directive link function.\n\n                link topLevelArgs... if link?\n\nInvoke the candidate link hooks.\n\n              invocations = [\n                'shrubSkinLink'\n                \"shrubSkinLink--#{directive.name}\"\n              ]\n\nAdd the candidates in reverse order, so they ascend in specificity.\n\n              invocations.push(\n                \"shrubSkinLink--#{directive.name}--#{c}\"\n              ) for c in candidateList.reverse()\n\n              for hook in invocations\n                continue if candidateHooksInvoked[hook]\n                candidateHooksInvoked[hook] = true\n\n#### Invoke hook `shrubSkinLink`.\n#### Invoke hook `shrubSkinLink--DIRECTIVE`.\n#### Invoke hook `shrubSkinLink--DIRECTIVE--ID`.\n\n                for f in pkgman.invokeFlat hook\n\n                  $injector.invoke(\n                    f, null\n                    $directive: directive\n                    $scope: scope\n                    $element: element\n                    $attr: attr\n                    $controller: controller\n                    $transclude: transclude\n                  )\n\n            applySkin = (skinKey) ->\n              currentSkinKey = skinKey\n              recalculateCandidate()\n\n            applySkin defaultSkinKey\n\nRelink again every time the skin changes.\n\n            $rootScope.$on 'shrub-skin.changed', (event, skinKey) ->\n              candidateHooksInvoked = {}\n              applySkin skinKey\n\nSet watches for all candidate-related values.\n\n            keysSeen = {}\n            watchers = []\n            for keys in directive.candidateKeys\n\n              keys = [keys] unless angular.isArray keys\n              for key in keys\n                continue if keysSeen[key]\n                keysSeen[key] = true\n\n                attr.$observe key, recalculateCandidate\n                watchers.push -> scope[attr[key]]\n\n            scope.$watchGroup watchers, recalculateCandidate\n\n      ]\n\n#### Implements hook `shrubAngularProvider`.\n\n      registrar.registerHook 'shrubAngularProvider', -> [\n\n        '$injector', '$provide'\n        ($injector, $provide) ->\n\n          provider = {}\n\n          provider.$get = [\n            '$http', '$interval', '$q', '$rootScope', '$window'\n            ($http, $interval, $q, $rootScope, $window) ->\n\n              service = {}\n\n## skin.addStylesheet\n\n(String) `href` - The href of the stylesheet to add.\n\n*Add a skin stylesheet.*\n\n              service.addStylesheet = (href) ->\n\n                deferred = $q.defer()\n\n                styleSheets = $window.document.styleSheets\n                index = styleSheets.length\n\nInsert the stylesheed as a link element in the head element, classed with\n'skin' so we can easily remove it if the skin changes.\n\n                element = $window.document.createElement 'link'\n                element.type = 'text\/css'\n                element.rel = 'stylesheet'\n                element.href = \"\/skin\/shrub-skin-strapped\/#{href}\"\n                element.className = 'skin'\n                angular.element('head').append element\n\n                resolve = -> deferred.resolve()\n\nA rare case where IE actually does the right thing! (and Opera).\n\n                if $window.opera or ~$window.navigator.userAgent.indexOf 'MSIE'\n\n                  element.onload = resolve\n                  element.onreadystatechange = ->\n                    switch @readyState\n                      when 'loaded', 'complete'\n                        resolve()\n\nEveryone else needs to resort to polling.\n\n                else\n\n                  wasParsed = ->\n\n                    try\n\n                      styleSheet = styleSheets[index]\n\n                      return true if styleSheet.cssRules\n                      return true if styleSheet.rules?.length\n\n                      return false\n\n                    catch error\n\n                      return false\n\n                  poll = $interval ->\n\n                    if wasParsed()\n\n                      $interval.cancel poll\n                      resolve()\n\n                    return\n\n                  , 10\n\n                deferred.promise\n\n## skin.addStylesheets\n\n(String Array) `hrefs` - The hrefs of the stylesheets to add.\n\n*Add a list of skin stylesheets.*\n\n              service.addStylesheets = (hrefs) ->\n                $q.all (service.addStylesheet href for href in hrefs)\n\nCLoak the body during the skin transition.\n\n              addBodyCloak = ->\n\n                $body = angular.element 'body'\n                $body.addClass 'shrub-skin-cloak'\n\nRemove the cloak after the transition is complete.\n\n              removeBodyCloak = ->\n\n                $body = angular.element 'body'\n                $body.removeClass 'shrub-skin-cloak'\n\nRemove all current skin stylesheets.\n\n              removeSkinStylesheets = ->\n\n                $head = angular.element 'head'\n                head = $head[0]\n\n                node = head.firstChild\n                while node\n\n                  nextNode = node.nextSibling\n\n                  if 'LINK' is node.tagName\n                    if angular.element(node).hasClass 'skin'\n                      head.removeChild node\n\n                  node = nextNode\n\n                return\n\nUse the correct assets for the environment.\n\n              environmentKey = if 'production' is cache.get 'environment'\n                'production'\n              else\n                'default'\n\n## skin.change\n\n(String) `skinKey` - The key of the skin to change to\n\n*Change skin.*\n\n###### TODO: Need to track current, this should be a nop in that case.\n\n              service.change = (skinKey) ->\n\nCloak the body.\n\n                addBodyCloak()\n                removeSkinStylesheets()\n\n                skinAssets = config.get(\n                  \"packageConfig:shrub-skin:assets:#{skinKey}\"\n                )\n\nUncloak and notify when finished.\n\n                service.addStylesheets(\n                  skinAssets.styleSheets[environmentKey]\n                ).finally ->\n                  removeBodyCloak()\n\n                  $rootScope.$broadcast 'shrub-skin.changed', skinKey\n\n              service\n\n          ]\n\n          provider\n\n      ]\n","old_contents":"# Skinning\n\n*Implement the skin system, allowing clients to change the look and feel of\nthe site on-the-fly, as well as quickly load assets from the default skin on\npage load.*\n\n    config = require 'config'\n    pkgman = require 'pkgman'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubAngularDirectiveAlter`.\n\n      registrar.registerHook 'shrubAngularDirectiveAlter', (directive, path) -> [\n\n        '$cacheFactory', '$compile', '$http', '$injector', '$interpolate', '$q', '$rootScope'\n        ($cacheFactory, $compile, $http, $injector, $interpolate, $q, $rootScope) ->\n\nEnsure ID is a candidate.\n\n          directive.candidateKeys ?= []\n          directive.candidateKeys.unshift 'id'\n\n          currentSkinKey = null\n          defaultSkinKey = config.get 'packageConfig:shrub-skin:default'\n\nProxy link function to add our own directive retrieval and compilation step.\n\n          link = directive.link\n          directive.link = (scope, element, attr, controller, transclude) ->\n\n            candidateHooksInvoked = {}\n\nSave top-level arguments for later calls to link functions.\n\n            topLevelArgs = arguments\n\nCurrent template candidate.\n\n            candidate = undefined\n\n            recalculateCandidate = ->\n\nGet the skin assets.\n\n              skinAssets = config.get(\n                \"packageConfig:shrub-skin:assets:#{currentSkinKey}\"\n              )\n\nTrack changes to the current template candidate.\n\n              oldCandidate = candidate\n\nBuild a list of all candidates by first attempting to interpolate candidate\nkeys, and falling back to attribute values, if any. Candidate arrays are joined\nby single dashes.\n\n              candidateList = do ->\n                list = []\n\n                for keys in directive.candidateKeys\n                  keys = [keys] unless angular.isArray keys\n\n                  item = []\n                  for key in keys\n\n                    specific = scope[key]\n                    specific = attr[key] unless specific\n\n                    item.push specific if specific\n\n                  item = item.join '-'\n                  list.push item if item\n\n                list\n\nMap the candidate list to template filenames and add the base path template\ncandidate.\n\n              candidateTemplates = for candidate_ in candidateList\n                \"#{path}--#{candidate_}.html\"\n              candidateTemplates.push \"#{path}.html\"\n\nReturn the first existing template. The asset templates are already sorted by\ndescending specificity.\n\n              candidate = do ->\n                for uri in candidateTemplates\n                  return uri if skinAssets?.templates?[uri]\n\n                return null\n\nIf the candidate changed, clear the hook invocation cache and relink.\n\n              if candidate isnt oldCandidate\n                candidateHooksInvoked = {}\n\nInsert and compile the template HTML if it exists.\n\n                if skinAssets?.templates?[candidate]\n\nInsert and compile HTML.\n\n                  element.html skinAssets.templates[candidate]\n                  $compile(element.contents())(scope)\n\nCall directive link function.\n\n                link topLevelArgs... if link?\n\nInvoke the candidate link hooks.\n\n              invocations = [\n                'shrubSkinLink'\n                \"shrubSkinLink--#{directive.name}\"\n              ]\n\nAdd the candidates in reverse order, so they ascend in specificity.\n\n              invocations.push(\n                \"shrubSkinLink--#{directive.name}--#{c}\"\n              ) for c in candidateList.reverse()\n\n              for hook in invocations\n                continue if candidateHooksInvoked[hook]\n                candidateHooksInvoked[hook] = true\n\n#### Invoke hook `shrubSkinLink`.\n#### Invoke hook `shrubSkinLink--DIRECTIVE`.\n#### Invoke hook `shrubSkinLink--DIRECTIVE--ID`.\n\n                for f in pkgman.invokeFlat hook\n\n                  $injector.invoke(\n                    f, null\n                    $scope: scope\n                    $element: element\n                    $attr: attr\n                    $controller: controller\n                    $transclude: transclude\n                  )\n\n            applySkin = (skinKey) ->\n              currentSkinKey = skinKey\n              recalculateCandidate()\n\n            applySkin defaultSkinKey\n\nRelink again every time the skin changes.\n\n            $rootScope.$on 'shrub-skin.changed', (event, skinKey) ->\n              candidateHooksInvoked = {}\n              applySkin skinKey\n\nSet watches for all candidate-related values.\n\n            keysSeen = {}\n            watchers = []\n            for keys in directive.candidateKeys\n\n              keys = [keys] unless angular.isArray keys\n              for key in keys\n                continue if keysSeen[key]\n                keysSeen[key] = true\n\n                attr.$observe key, recalculateCandidate\n                watchers.push -> scope[attr[key]]\n\n            scope.$watchGroup watchers, recalculateCandidate\n\n      ]\n\n#### Implements hook `shrubAngularProvider`.\n\n      registrar.registerHook 'shrubAngularProvider', -> [\n\n        '$injector', '$provide'\n        ($injector, $provide) ->\n\n          provider = {}\n\n          provider.$get = [\n            '$http', '$interval', '$q', '$rootScope', '$window'\n            ($http, $interval, $q, $rootScope, $window) ->\n\n              service = {}\n\n## skin.addStylesheet\n\n(String) `href` - The href of the stylesheet to add.\n\n*Add a skin stylesheet.*\n\n              service.addStylesheet = (href) ->\n\n                deferred = $q.defer()\n\n                styleSheets = $window.document.styleSheets\n                index = styleSheets.length\n\nInsert the stylesheed as a link element in the head element, classed with\n'skin' so we can easily remove it if the skin changes.\n\n                element = $window.document.createElement 'link'\n                element.type = 'text\/css'\n                element.rel = 'stylesheet'\n                element.href = \"\/skin\/shrub-skin-strapped\/#{href}\"\n                element.className = 'skin'\n                angular.element('head').append element\n\n                resolve = -> deferred.resolve()\n\nA rare case where IE actually does the right thing! (and Opera).\n\n                if $window.opera or ~$window.navigator.userAgent.indexOf 'MSIE'\n\n                  element.onload = resolve\n                  element.onreadystatechange = ->\n                    switch @readyState\n                      when 'loaded', 'complete'\n                        resolve()\n\nEveryone else needs to resort to polling.\n\n                else\n\n                  wasParsed = ->\n\n                    try\n\n                      styleSheet = styleSheets[index]\n\n                      return true if styleSheet.cssRules\n                      return true if styleSheet.rules?.length\n\n                      return false\n\n                    catch error\n\n                      return false\n\n                  poll = $interval ->\n\n                    if wasParsed()\n\n                      $interval.cancel poll\n                      resolve()\n\n                    return\n\n                  , 10\n\n                deferred.promise\n\n## skin.addStylesheets\n\n(String Array) `hrefs` - The hrefs of the stylesheets to add.\n\n*Add a list of skin stylesheets.*\n\n              service.addStylesheets = (hrefs) ->\n                $q.all (service.addStylesheet href for href in hrefs)\n\nCLoak the body during the skin transition.\n\n              addBodyCloak = ->\n\n                $body = angular.element 'body'\n                $body.addClass 'shrub-skin-cloak'\n\nRemove the cloak after the transition is complete.\n\n              removeBodyCloak = ->\n\n                $body = angular.element 'body'\n                $body.removeClass 'shrub-skin-cloak'\n\nRemove all current skin stylesheets.\n\n              removeSkinStylesheets = ->\n\n                $head = angular.element 'head'\n                head = $head[0]\n\n                node = head.firstChild\n                while node\n\n                  nextNode = node.nextSibling\n\n                  if 'LINK' is node.tagName\n                    if angular.element(node).hasClass 'skin'\n                      head.removeChild node\n\n                  node = nextNode\n\n                return\n\nUse the correct assets for the environment.\n\n              environmentKey = if 'production' is cache.get 'environment'\n                'production'\n              else\n                'default'\n\n## skin.change\n\n(String) `skinKey` - The key of the skin to change to\n\n*Change skin.*\n\n###### TODO: Need to track current, this should be a nop in that case.\n\n              service.change = (skinKey) ->\n\nCloak the body.\n\n                addBodyCloak()\n                removeSkinStylesheets()\n\n                skinAssets = config.get(\n                  \"packageConfig:shrub-skin:assets:#{skinKey}\"\n                )\n\nUncloak and notify when finished.\n\n                service.addStylesheets(\n                  skinAssets.styleSheets[environmentKey]\n                ).finally ->\n                  removeBodyCloak()\n\n                  $rootScope.$broadcast 'shrub-skin.changed', skinKey\n\n              service\n\n          ]\n\n          provider\n\n      ]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ec79db3ed48cd22dd9c8724016c968da41640c92","subject":"Array docs","message":"Array docs\n","repos":"johannhof\/typed-bacon","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"# typed-bacon [![](https:\/\/travis-ci.org\/johannhof\/typed-bacon.svg)](https:\/\/travis-ci.org\/johannhof\/typed-bacon)\nType checks in your Bacon stream!\n\n> This document is an executable source file that contains tests to stay up to date.\n\n    assert = require('assert')\n\n## Usage\n\nRequiring Bacon before typed-bacon ensures that the custom methods can hook into Bacon correctly.\nYou need to require `typed-bacon` to add the custom type methods to Bacon observables.\nYou will also want to get access to the Types object.\n\n    Bacon = require('baconjs')\n    {Types} = require('typed-bacon')\n\n## API\n\n### Observable.typeCheck\n\nTransforms a value to an error if the input is not of the specified type.\n\n    Bacon.fromArray([1, 2, \"three\"])\n         .typeCheck(Types.Number)\n         .onError (e) ->\n           assert(e instanceof Error)\n           assert.equal(e.message, \"Expected three to be of type number.\")\n\n### Observable.typeFilter\n\nFilters out all stream values that are not of the specified type.\n\n    Bacon.fromArray([1, \"two\", 3, true, 4])\n         .typeFilter(Types.Number)\n         .slidingWindow(3,3)\n         .onValue (arr) ->\n           assert.deepEqual(arr, [1, 3, 4])\n\n### Observable.typeWarn\n\nComing soon!\n\n### Types.Object\n\nTypes.Object can be passed a JS object containing child types with infinite deepness(as long as the call stack holds).\n\n    person = {\n      name: \"Johann\",\n      languages: 5\n    }\n\n    Bacon.once(person)\n         .typeCheck(Types.Object({\n           name: Types.String,\n           languages: Types.Array\n         }))\n         .onError (e) ->\n           assert(e instanceof Error)\n\n### Types.Array\n\nTypes.Array can receive an object with a length parameter, specifying the exact length of the array.\n\n    Bacon.once([1,2,3,4])\n         .typeCheck(Types.Array(length: 5))\n         .onError (e) ->\n           assert(e instanceof Error)\n\n","old_contents":"# typed-bacon [![](https:\/\/travis-ci.org\/johannhof\/typed-bacon.svg)](https:\/\/travis-ci.org\/johannhof\/typed-bacon)\nType checks in your Bacon stream!\n\n> This document is an executable source file that contains tests to stay up to date.\n\n    assert = require('assert')\n\n## Usage\n\nRequiring Bacon before typed-bacon ensures that the custom methods can hook into Bacon correctly.\nYou need to require `typed-bacon` to add the custom type methods to Bacon observables.\nYou will also want to get access to the Types object.\n\n    Bacon = require('baconjs')\n    {Types} = require('typed-bacon')\n\n## API\n\n### Observable.typeCheck\n\nTransforms a value to an error if the input is not of the specified type.\n\n    Bacon.fromArray([1, 2, \"three\"])\n         .typeCheck(Types.Number)\n         .onError (e) ->\n           assert(e instanceof Error)\n           assert.equal(e.message, \"Expected three to be of type number.\")\n\n### Observable.typeFilter\n\nFilters out all stream values that are not of the specified type.\n\n    Bacon.fromArray([1, \"two\", 3, true, 4])\n         .typeFilter(Types.Number)\n         .slidingWindow(3,3)\n         .onValue (arr) ->\n           assert.deepEqual(arr, [1, 3, 4])\n\n### Observable.typeWarn\n\nComing soon!\n\n### Types.Object\n\nTypes.Object can be passed a JS object containing child types with infinite deepness(as long as the call stack holds).\n\n    person = {\n      name: \"Johann\",\n      languages: 5\n    }\n\n    Bacon.once(person)\n         .typeCheck(Types.Object({\n           name: Types.String,\n           languages: Types.Array\n         }))\n         .onError (e) ->\n           assert(e instanceof Error)\n\n### Types.Array\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d9f1fdb2f2695d697ac997f3256c08a9e1dfc752","subject":"method should do promise.reject on error","message":"method should do promise.reject on error\n","repos":"corenova\/yang-js","old_file":"src\/method.litcoffee","new_file":"src\/method.litcoffee","new_contents":"# Method - controller of functions\n\n## Class Method\n\n    debug = require('debug')('yang:method')\n    Property = require('.\/property')\n\n    class Method extends Property\n      debug: -> debug @uri, arguments...\n\n      @property 'value',\n        get: -> @state.value ? @do.bind this\n\n      get: (pattern) -> switch\n        when pattern? then super arguments...\n        when @binding? then @do.bind this\n        else @data\n\n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      do: (input={}, opts={}) ->\n        unless (@binding instanceof Function) or (@data instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        @debug \"[do] executing method: #{@name}\"\n        @debug input\n        ctx = @parent?.context ? @context\n        ctx = ctx.with opts, path: @path\n        try\n          # calling context is the parent node of the method\n          input = @schema.input.apply input, this, force: true\n          \n          # first apply schema bound function (if availble), otherwise\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\"\n            @debug @binding.toString()\n            output = @binding? ctx, input\n          else\n            @debug \"[do] calling assigned function: #{@data.name}\"\n            @debug @value\n            @debug @data\n            output = @data.call @parent.data, input, ctx\n\n          output = await output\n          { output } = @schema.output.eval { output }, this, force: true\n          return output\n        catch e\n          @debug e\n          return Promise.reject(e)\n\n      update: (value, opts) ->\n        super value, opts unless value instanceof Property\n\n### toJSON\n\nThis call always returns undefined for the Method node.\n\n      toJSON: (key) ->\n        value = undefined\n        value = \"#{@name}\": value if key is true\n        return value\n\n    module.exports = Method\n","old_contents":"# Method - controller of functions\n\n## Class Method\n\n    debug = require('debug')('yang:method')\n    Property = require('.\/property')\n\n    class Method extends Property\n      debug: -> debug @uri, arguments...\n\n      @property 'value',\n        get: -> @state.value ? @do.bind this\n\n      get: (pattern) -> switch\n        when pattern? then super arguments...\n        when @binding? then @do.bind this\n        else @data\n\n### do ()\n\nA convenience wrap to a Property instance that holds a function to\nperform a Promise-based execution.\n\nAlways returns a Promise.\n\n      do: (input={}, opts={}) ->\n        unless (@binding instanceof Function) or (@data instanceof Function)\n          return Promise.reject @error \"cannot perform action on a property without function\"\n        @debug \"[do] executing method: #{@name}\"\n        @debug input\n        ctx = @parent?.context ? @context\n        ctx = ctx.with opts, path: @path\n        try\n          # calling context is the parent node of the method\n          input = @schema.input.apply input, this, force: true\n          \n          # first apply schema bound function (if availble), otherwise\n          # execute assigned function (if available and not 'missing')\n          if @binding?\n            @debug \"[do] calling bound function with: #{Object.keys(input)}\"\n            @debug @binding.toString()\n            output = @binding? ctx, input\n          else\n            @debug \"[do] calling assigned function: #{@data.name}\"\n            @debug @value\n            @debug @data\n            output = @data.call @parent.data, input, ctx\n\n          output = await output\n          { output } = @schema.output.eval { output }, this, force: true\n          return output\n        catch e\n          @debug e\n          return e\n\n      update: (value, opts) ->\n        super value, opts unless value instanceof Property\n\n### toJSON\n\nThis call always returns undefined for the Method node.\n\n      toJSON: (key) ->\n        value = undefined\n        value = \"#{@name}\": value if key is true\n        return value\n\n    module.exports = Method\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"156e6086bc1eaf3cfc13cb1e1ca0c554956be979","subject":"Add notes regarding code formatting.","message":"Add notes regarding code formatting.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimelineMaker` class](#the-timelinemaker-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.\n\n#### The `TimelineMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nNotes\n-----\n\n### Notes related to only this file\n\nWell, no notes yet.\n\n### Notes that should be moved away at some point\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug.\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimelineMaker` class](#the-timelinemaker-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Notes](#notes)\n\n----\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\n----\n\nLibrary implementation\n----------------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.\n\n#### The `TimelineMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n----\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n----\n\nNotes\n-----\n\nThis is just a first test note, to not forget about this section.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6be7a6b7d75908b9ddad39030c65f308a01c0cb3","subject":"Separate formatting and rendering into different classes.","message":"Separate formatting and rendering into different classes.\n\nSplit `TimeAxisMaker` class into `TimeAxisMaker` class and `TimeAxisRenderer` class.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\n### The `TimeAxisMaker` class\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n### The `TimeAxisRenderer` class\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n      timeAxisRedrerer = new TimeAxisRenderer()\n      timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nNotes\n-----\n\n### Notes related to only this file\n\nWell, no notes yet.\n\n### Notes that should be moved away at some point\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug.\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimelineMaker` class](#the-timelinemaker-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.\n\n#### The `TimelineMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n    class TimelineMaker\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nNotes\n-----\n\n### Notes related to only this file\n\nWell, no notes yet.\n\n### Notes that should be moved away at some point\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug.\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f3e42c73ab3baa9f1f23b1384f6226e732dbff0b","subject":"Docs for Bindings underway","message":"Docs for Bindings underway\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\nI implement associations of logic variables and their values (aka, *bindings*) as a class holding a simple JavaScript object.  One may say that a substitution represents our current knowledge of the world.\n\n    class Bindings\n      constructor: (seed = {}) ->\n        @binds = _.merge({}, seed)\n      extend: (lvar, value) ->\n        o = {}\n        o[lvar.name] = value\n        new Bindings(_.merge(@binds, o))\n      has: (lvar) ->\n        @binds.hasOwnProperty(lvar.name)\n      lookup: (lvar) ->\n        return lvar if !F.isLVar(lvar)\n        return this.lookup(@binds[lvar.name]) if this.has(lvar)\n        lvar\n\n  F.ignorance = new Bindings()\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n  \t\t              find(_.rest(lvar), bindings))\n      lvar\n\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","old_contents":"We always start with the JavaScript-like magic scoping mojo!\n\n    ((root) ->\n      root = this\n      _ = root._ || require 'underscore'\n      F = {}\n\nNon-determinism\n---------------\n\nNon-deterministic functions are functions that can have more (or less) than one result.  As known from logic, a binary relation xRy (where x \u2208 X, y \u2208 Y) can be represented by a *function*  `X -> PowerSet{Y}`. As usual in computer science, we interpret the set `PowerSet{Y}` as a multi-set (realized as a regular scheme list). Compare with SQL, which likewise uses multisets and sequences were sets are properly called for. Also compare with [Wadler's \"representing failure as a list of successes.\"](http:\/\/citeseer.uark.edu:8080\/citeseerx\/showciting;jsessionid=FF5F5EAA9D94B1A8618C49C37451D762?cid=377301).\n\nThus, we represent a 'relation' (aka `non-deterministic function') as a regular CoffeeScript function that returns an array of possible results.\n\nFirst, we define two primitive non-deterministic functions; one of them yields no result whatsoever for any argument; the other merely returns its argument as the sole result.\n\n    F.succeed = (result) -> [result]\n    F.fail = _.always []\n\nWe build more complex non-deterministic functions by combining the existing ones with the help of the following two combinators.\n\n`(disjunction l r)` returns all the results of `l` and all the results of `r`, or returns no results only if neither `l` nor `r` returned any.  In that sense, it is analogous to the logical disjunctionunction.\n\n    disjunction = (l, r) ->\n      (x) -> _.cat(l(x), r(x))\n\n`(conjunction l r)` looks like a functional composition of `r` and `l`.  Only `(l x)` may return several results, so we have to apply `r` to each of them.  Obviously `(conjunction fail f)` and `(conjunction f fail)` are both equivalent to `fail`: they return no results, ever. It that sense, `conjunction` is analogous to the logical conjunction.\n\n    conjunction = (l, r) ->\n      (x) -> _.mapcat(l(x), r)\n\nJavaScript allows you to pass any number of arguments to a function.  Therefore, we can make a function `disj` that takes any number of arguments and performs a logical disjunction over each.  This makes this version of Sokuza Kanren a bit more flexible in that it allows you to nest any number of relations therein.\n\n    F.disj = () ->\n      return F.fail if _.isEmpty(arguments)\n      disjunction(_.first(arguments), \n\t              F.disj.apply(this, _.rest(arguments)))\n\nLikewise, the `conj` function accepts any number of clauses, nit just two as in the original Sokuza.\n\n    F.conj = () ->\n      clauses = _.toArray(arguments)\n      return F.succeed if _.isEmpty(clauses)\n      return _.first(clauses) if _.size(clauses) is 1\n      conjunction(_.first(clauses),\n                  (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\nAnd that's all that there is for the built-in non-deterministic functions.\n\n# Knowledge representation\n# ------------------------\n\nOne may think of regular variables as \"certain knowledge\": they give  names to definite values.  A logic variable then stands for \"improvable ignorance\".  An unbound logic variable represents no  knowledge at all; in other words, it represents the result of a measurement *before* we have done the measurement. A logic variable may be associated with a definite value, like 10. That means definite knowledge.  A logic variable may be associated with a semi-definite value, like `[$X]` where `$X` is an unbound variable. We know something about the original variable: it is associated with the array of one element.  We can't say though what that element is. A logic variable can be associated with another, unbound logic variable. In that case, we still don't know what precisely the original variable stands for. However, we can say that it represents the same thing as the other variable. So, our uncertainty is reduced.\n\nI've chosen to represent logic variables with their own simple type.\n\n    class LVar\n      constructor: (@name) ->\n\nI've also created a couple of helper functions for creating new variables and checking \"variableness\" to decouple the representation a bit.\n\n    F.lvar = (name) -> new LVar(name)\n    F.isLVar = (v) -> (v instanceof LVar)\n\n\n\n    find = (v, bindings) ->\n      lvar = bindings.lookup(v)\n      return lvar if F.isLVar(v)\n      if _.isArray(lvar)\n        if _.isEmpty(lvar)\n          return lvar\n        else\n          return _.cons(find(_.first(lvar), bindings),\n  \t\t              find(_.rest(lvar), bindings))\n      lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"99a5aeacb6cf97fbd852f76f980a6460e248c32f","subject":"smarter model obsoletes page module","message":"smarter model obsoletes page module\n","repos":"ecc12\/cx5_parkrow,ecc12\/cx5_parkrow,ecc12\/cx5_parkrow","old_file":"src\/lib\/page\/index.litcoffee","new_file":"src\/lib\/page\/index.litcoffee","new_contents":"","old_contents":"\n# Page Controller\n\nTo access this module, use the following code: \n`page = require('..\/page')`.  Methods can be called as:\n`page.getPage(model, name, (page) -> { ... })`.\n\n    module.exports = {}\n\n## getPage\n\nRequires:\n\n- **model** - the Page model\n- **name** - the name of the page to fetch\n- **callback** - (page) -> {...}\n    - **page** - a dict containing:\n        - **page.name** - a string of the page name\n        - **page.title** - a string of the page title\n        - **page.body** - a string of the page body\n\nCode:\n\n    \n    getPage = (model, name, callback) ->\n      model.findOne {name: name}, (err, doc) ->\n        if err\n          console.error err.stack\n        if !doc\n          callback null\n        else\n          callback {\n            name: doc.get 'name'\n            title: doc.get 'title'\n            body: doc.get 'body'\n          }\n    module.exports.getPage = getPage\n\n## setPage\n\nRequires:\n\n- **model** - the Page model\n- **page** - a dict of the page to set containing:\n    - **page.name** - a string of the page name\n    - **page.title** - a string of the page title\n    - **page.body** - a string of the page body\n- **callback** - (page) -> {...}\n    - **page** - a dict of the page written to the db (uses getPage):\n        - **page.name** - a string of the page name\n        - **page.title** - a string of the page title\n        - **page.body** - a string of the page body\n\nCode:\n\n    setPage = (model, page, callback) ->\n      if !page || !page.name || !page.title || !page.body\n        console.error 'setPage called with invalid page'\n        callback null\n      model.create [page], (err) ->\n        if err\n          console.error err.stack\n          callback null\n        else\n          getPage model, page.name, callback\n    module.exports.setPage = setPage\n          \n## Copying\n\nThis software is released under the ISC License.\n\nCopyright (c) 2013, Cameron King <cking@ecc12.com>\n\nPermission to use, copy, modify, and\/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n\n<!-- vim: ts=2 sts=2 sw=2 expandtab\n     CoffeeScript-friendly tabstops in vim. -->\n","returncode":0,"stderr":"","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"a8bece6180f6f75cc370be95d8e58d04398e01e3","subject":"allow a string schema as part of spec constructor","message":"allow a string schema as part of spec constructor\n","repos":"corenova\/yang-js","old_file":"src\/property.litcoffee","new_file":"src\/property.litcoffee","new_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    Yang     = require '.\/yang'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (spec={}) ->\n        unless this instanceof Property then return new Property arguments...\n\n        spec = Yang.parse spec if typeof spec is 'string'\n        \n        [ @name, @schema={} ] = switch\n          when spec instanceof Yang\n            [ spec.datakey, spec ]\n          else\n            { name, schema } = spec\n            schema = Yang schema if typeof schema is 'string'\n            [ name, schema ]\n\n        @state = \n          value: undefined\n          parent: null\n          container: null\n          private: false\n          mutable: @schema.config?.valueOf() isnt false\n          attached: false\n          changed: false\n          \n        @schema.kind ?= 'anydata'\n          \n        # soft freeze this instance\n        Object.preventExtensions this\n\n      debug: -> debug @uri, arguments...\n      \n      delegate @prototype, 'state'\n        .access 'container'\n        .access 'parent'\n        .access 'strict'\n        .getter 'mutable'\n        .getter 'private'\n        .getter 'prev'\n        .getter 'value'\n        .getter 'changed'\n        .getter 'attached'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'content',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> @value\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @content\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor this\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      emit: -> @parent?.emit? arguments...\n\n      clean: -> @state.changed = false\n\n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (key) -> switch\n        when key? \n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].get()\n            when match.length > 1  then match.map (x) -> x.get()\n            else undefined\n        when @binding?\n          try @binding.call @context\n          catch e\n            throw @error e, 'getter'\n        else @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        @state.changed = false\n        # @debug \"[set] enter...\"\n\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n          \n        if @binding?.length is 1 and not opts.force\n          try value = @binding.call @context, value \n          catch e\n            throw @error e, 'setter'\n\n        return this if value? and @equals value, @value\n        \n        @state.prev = @value\n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        # @debug \"[set] applying schema...\"\n        value = switch\n          when @schema.apply? and not bypass\n            @schema.apply value, this, Object.assign {}, opts, suppress: true\n          else value\n        # @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error or @equals value, @prev\n        \n        @state.value = value\n        @state.changed = true\n        \n        # update enumerable state on every set operation\n        try Object.defineProperty @container, @name, configurable: true, enumerable: true if @attached\n\n        @commit opts\n        # @debug \"[set] completed\"\n        return this\n\n### delete\n\n      delete: (opts={}) ->\n        if @binding?.length is 1 and not opts.force\n          try @binding.call @context, null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @state.prev = @value\n        @state.value = null\n\n        @parent?.remove? this, opts # remove from parent\n        \n        # update enumerable state on every set operation\n        try Object.defineProperty @container, @name, enumerable: false if @attached\n\n        @state.changed = true\n        @commit opts\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts) ->\n        return @delete opts if value is null\n        @set value, Object.assign {}, opts, merge: true\n\n### commit (opts)\n\nCommits the changes to the data to the data model\n\n      commit: (opts={}) ->\n        return unless @changed\n        if @attached and @parent?\n          @parent.changes.add this\n          @parent.commit suppress: true\n          \n        { suppress = false, inner = false, actor } = opts\n        return if suppress\n        unless inner\n          try @emit 'update', this, actor\n          catch error\n            # console.warn('commit error, rolling back!');\n            @rollback()\n            throw error\n        @emit 'change', this, actor if @attached\n\n      rollback: ->\n        @state.value = @prev\n        @clean()\n        return this\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n\n        detached = true unless @container?\n        @container = obj\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        if detached and opts.replace isnt true\n          # @debug \"[join] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n          @set obj[name], Object.assign {}, opts, suppress: true\n\n        @parent?.add? this, opts # add to parent\n\n        try Object.defineProperty obj, @name,\n            configurable: true\n            enumerable: @enumerable\n            get: => @get arguments...\n            set: => @set arguments...\n            \n        @state.attached = true\n        # @debug \"[join] attached into #{obj.constructor.name} container\"\n        @emit 'attach', this\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @content = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx=this) ->\n        err = new Error err unless err instanceof Error\n        err.uri = @uri \n        err.src = this\n        err.ctx = ctx\n        return err\n\n### throw (msg)\n\n      throw: (err) -> throw @error(err)\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @value\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @name\n          kind:   @kind\n          path:   @path.toString()\n          schema: switch\n            when @schema.uri?\n              uri:      @schema.uri\n              summary:  @schema.description?.tag\n              datakey:  @schema.datakey\n              datapath: @schema.datapath\n              external: @schema.external\n              children: @schema.children.map (x) -> x.uri\n            else false\n          active:  @active\n          changed: @changed\n          mutable: @mutable\n          content: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","old_contents":"# Property - controller of Object properties\n\nThe `Property` class is the *secretive shadowy* element that governs\n`Object` behavior and are bound to the `Object` via\n`Object.defineProperty`. It acts like a shadow `Proxy\/Reflector` to\nthe `Object` instance and provides tight control via the\n`Getter\/Setter` interfaces.\n\nBelow are list of properties available to every instance of `Property`:\n\nproperty | type | mapping | description\n--- | --- | --- | ---\nname   | string | direct | name of the property\nschema | object | direct | a schema instance (usually [Yang](.\/src\/yang.listcoffee))\nstate  | object | direct | *private* object holding internal state\ncontainer | object | access(state) | reference to object containing this property\nconfigurable | boolean | getter(state) | defines whether this property can be redefined\nenumerable   | boolean | getter(state) | defines whether this property is enumerable\ncontent | any | computed | getter\/setter for `state.value`\ncontext | object | computed | dynamically generated using [context](.\/src\/context.coffee)\nroot  | [Property](.\/src\/property.litcoffee) | computed | dynamically returns the root Property instance\npath  | [XPath](.\/src\/xpath.coffee) | computed | dynamically generate XPath for this Property from root\n\n## Class Property\n\n    debug    = require('debug')('yang:property')\n    delegate = require 'delegates'\n    context  = require '.\/context'\n    Yang     = require '.\/yang'\n    XPath    = require '.\/xpath'\n\n    class Property\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n\n      constructor: (spec={}) ->\n        unless this instanceof Property then return new Property arguments...\n        \n        [ @name, @schema={} ] = switch\n          when typeof spec is 'string'\n            schema = Yang.parse spec\n            [ schema.tag, schema ]\n          when spec instanceof Yang\n            [ spec.datakey, spec ]\n          else\n            [ spec.name, spec.schema ]\n\n        @state = \n          value: undefined\n          parent: null\n          container: null\n          private: false\n          mutable: @schema.config?.valueOf() isnt false\n          attached: false\n          changed: false\n          \n        @schema.kind ?= 'anydata'\n          \n        # soft freeze this instance\n        Object.preventExtensions this\n\n      debug: -> debug @uri, arguments...\n      \n      delegate @prototype, 'state'\n        .access 'container'\n        .access 'parent'\n        .access 'strict'\n        .getter 'mutable'\n        .getter 'private'\n        .getter 'prev'\n        .getter 'value'\n        .getter 'changed'\n        .getter 'attached'\n\n      delegate @prototype, 'schema'\n        .getter 'tag'\n        .getter 'kind'\n        .getter 'type'\n        .getter 'default'\n        .getter 'external'\n        .getter 'binding'\n        .method 'locate'\n        .method 'lookup'\n\n### Computed Properties\n\n      @property 'enumerable',\n        get: -> not @private and (@value? or @binding?)\n\n      @property 'content',\n        set: (value) -> @set value, { force: true, suppress: true }\n        get: -> @value\n\n      @property 'active',\n        get: -> @enumerable and @value?\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed then @content\n\n      @property 'context',\n        get: ->\n          ctx = Object.create(context)\n          ctx.state = {}\n          ctx.property = this\n          Object.preventExtensions ctx\n          return ctx\n\n      @property 'root',\n        get: ->\n          return this if @kind is 'module'\n          root = switch\n            when @parent is this then this\n            when @parent instanceof Property then @parent.root\n            else this\n          @state.path = undefined unless @state.root is root\n          return @state.root = root\n\n      @property 'path',\n        get: ->\n          if this is @root\n            entity = switch\n              when @kind is 'module' then '\/'\n              else '.'\n            return XPath.parse entity, @schema\n          @state.path ?= @parent.path.clone().append @name\n          return @state.path\n\n      @property 'uri',\n        get: -> @schema.datapath ? @schema.uri\n\n## Instance-level methods\n\n      clone: (state = {}) ->\n        throw @error 'must clone with state typeof object' unless typeof state is 'object'\n        copy = new @constructor this\n        copy.state = Object.assign(Object.create(@state), state, origin: this)\n        return copy\n\n      emit: -> @parent?.emit? arguments...\n\n      clean: -> @state.changed = false\n\n      equals: (a, b) -> switch @kind\n        when 'leaf-list'\n          return false unless a and b\n          a = Array.from(new Set([].concat(a)))\n          b = Array.from(new Set([].concat(b)))\n          return false unless a.length is b.length\n          a.every (x) => b.some (y) => x is y\n        else a is b\n\n### get (key)\n\nThis is the main `Getter` for the target object's property value. When\ncalled with optional `key` it will perform an internal\n[find](#find-xpath) operation to traverse\/locate that value being\nrequested instead of returning its own `@content`.\n\nIt also provides special handling based on different types of\n`@content` currently held.\n\nWhen `@content` is a function, it will call it with the current\n`@context` instance as the bound context for the function being\ncalled.\n\n      get: (key) -> switch\n        when key? \n          try match = @find key\n          return unless match? and match.length\n          switch\n            when match.length is 1 then match[0].get()\n            when match.length > 1  then match.map (x) -> x.get()\n            else undefined\n        when @binding?\n          try @binding.call @context\n          catch e\n            throw @error e, 'getter'\n        else @content\n\n### set (value)\n\nThis is the main `Setter` for the target object's property value.  It\nutilizes internal `@schema` attribute if available to enforce schema\nvalidations.\n\n      set: (value, opts={}) ->\n        @state.changed = false\n        # @debug \"[set] enter...\"\n\n        unless @mutable or not value? or opts.force\n          throw @error \"cannot set data on read-only (config false) element\"\n          \n        if @binding?.length is 1 and not opts.force\n          try value = @binding.call @context, value \n          catch e\n            throw @error e, 'setter'\n\n        return this if value? and @equals value, @value\n        \n        @state.prev = @value\n        bypass = opts.bypass and @kind in [\"leaf\", \"leaf-list\"]\n        # @debug \"[set] applying schema...\"\n        value = switch\n          when @schema.apply? and not bypass\n            @schema.apply value, this, Object.assign {}, opts, suppress: true\n          else value\n        # @debug \"[set] done applying schema...\", value\n        return this if value instanceof Error or @equals value, @prev\n        \n        @state.value = value\n        @state.changed = true\n        \n        # update enumerable state on every set operation\n        try Object.defineProperty @container, @name, configurable: true, enumerable: true if @attached\n\n        @commit opts\n        # @debug \"[set] completed\"\n        return this\n\n### delete\n\n      delete: (opts={}) ->\n        if @binding?.length is 1 and not opts.force\n          try @binding.call @context, null\n          catch e\n            throw @error \"failed executing delete() binding: #{e.message}\", e\n        @state.prev = @value\n        @state.value = null\n\n        @parent?.remove? this, opts # remove from parent\n        \n        # update enumerable state on every set operation\n        try Object.defineProperty @container, @name, enumerable: false if @attached\n\n        @state.changed = true\n        @commit opts\n        return this\n\n### merge (value)\n\nPerforms a granular merge of `value` into existing `@content` if\navailable, otherwise performs [set](#set-value) operation.\n\n      merge: (value, opts) ->\n        return @delete opts if value is null\n        @set value, Object.assign {}, opts, merge: true\n\n### commit (opts)\n\nCommits the changes to the data to the data model\n\n      commit: (opts={}) ->\n        return unless @changed\n        if @attached and @parent?\n          @parent.changes.add this\n          @parent.commit suppress: true\n          \n        { suppress = false, inner = false, actor } = opts\n        return if suppress\n        unless inner\n          try @emit 'update', this, actor\n          catch error\n            # console.warn('commit error, rolling back!');\n            @rollback()\n            throw error\n        @emit 'change', this, actor if @attached\n\n      rollback: ->\n        @state.value = @prev\n        @clean()\n        return this\n\n### attach (obj, parent, opts)\n\nThis call is the primary mechanism via which the `Property` instance\nattaches itself to the provided target `obj`. It defines itself in the\ntarget `obj` via `Object.defineProperty`.\n\n      attach: (obj, parent, opts) ->\n        return obj unless obj instanceof Object\n        opts ?= { replace: false, suppress: false, force: false }\n\n        detached = true unless @container?\n        @container = obj\n        @parent = parent\n\n        # if joining for the first time, apply existing data unless explicit replace\n        if detached and opts.replace isnt true\n          # @debug \"[join] applying existing data for #{@name} (external: #{@external}) to:\"\n          # @debug obj\n          name = switch\n            when @parent?.external and @tag of obj then @tag\n            when @external then @name\n            when @name of obj then @name\n            else \"#{@root.name}:#{@name}\" # should we ensure root is kind = module?\n          @set obj[name], Object.assign {}, opts, suppress: true\n\n        @parent?.add? this, opts # add to parent\n\n        try Object.defineProperty obj, @name,\n            configurable: true\n            enumerable: @enumerable\n            get: => @get arguments...\n            set: => @set arguments...\n            \n        @state.attached = true\n        # @debug \"[join] attached into #{obj.constructor.name} container\"\n        @emit 'attach', this\n        return obj\n\n### find (pattern)\n\nThis helper routine can be used to allow traversal to other elements\nin the data tree from the relative location of the current `Property`\ninstance. It returns matching `Property` instances based on the\nprovided `pattern` in the form of XPATH or YPATH.\n\nIt is internally used via [get](#get) and generally used inside\ncontroller logic bound inside the [Yang expression](.\/yang.litcoffee)\nas well as event handler listening on [Model](.\/model.litcoffee)\nevents.\n\nIt *always* returns an array (empty to denote no match) unless it\nencounters an error, in which case it will throw an Error.\n\n      find: (pattern='.', opts={}) ->\n        @debug \"[find] #{pattern}\"\n        pattern = XPath.parse pattern, @schema\n        switch\n          when pattern.tag is '\/'  and this isnt @root then @root.find(pattern)\n          when pattern.tag is '..' then @parent?.find pattern.xpath\n          else pattern.apply(this) ? []\n\n### in (pattern)\n\nA convenience routine to locate one or more matching Property\ninstances based on `pattern` (XPATH or YPATH) from this Model.\n\n      in: (pattern) ->\n        try props = @find pattern\n        return unless props? and props.length\n        return switch\n          when props.length > 1 then props\n          else props[0]\n\n### defer (value)\n\nOptionally defer setting the value to the property until root has been updated.\n\n      defer: (value) ->\n        @debug \"deferring '#{@kind}(#{@name})' until update at #{@root.name}\"\n        @root.once 'update', =>\n          @debug \"applying deferred data (#{typeof value})\"\n          @content = value\n        return value\n        \n### error (msg)\n\nProvides more contextual error message pertaining to the Property instance.\n          \n      error: (err, ctx=this) ->\n        err = new Error err unless err instanceof Error\n        err.uri = @uri \n        err.src = this\n        err.ctx = ctx\n        return err\n\n### throw (msg)\n\n      throw: (err) -> throw @error(err)\n\n### toJSON\n\nThis call creates a new copy of the current `Property.content`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        value = switch\n          when @kind is 'anydata' then undefined\n          when state isnt true and not @mutable then undefined\n          else @value\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        return {\n          name:   @name\n          kind:   @kind\n          path:   @path.toString()\n          schema: switch\n            when @schema.uri?\n              uri:      @schema.uri\n              summary:  @schema.description?.tag\n              datakey:  @schema.datakey\n              datapath: @schema.datapath\n              external: @schema.external\n              children: @schema.children.map (x) -> x.uri\n            else false\n          active:  @active\n          changed: @changed\n          mutable: @mutable\n          content: @toJSON()\n        }\n\n## Export Property Class\n\n    module.exports = Property\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"2d1f5fa6a70255615bf1096463b8722ce1f6ab09","subject":"Add conversion functions to and from UNIX timestamps","message":"Add conversion functions to and from UNIX timestamps\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/clock.litcoffee","new_file":"src\/coffee\/clock.litcoffee","new_contents":"Clock Source\n============\n\nThis clock source acts as a synchronisation point for anything which depends\non the time.\n\nFirst, we create the Bacon.js bus. This event source is the destination to\nwhich we push each clock pulse.\n\n    bus = new Bacon.Bus\n\nThe *sendClockPulse* function actually injects the clock pulse into\nthe bus. It has two functions: not only does it get the current\ndate and inject it into the bus, but it also schedules itself to\nbe re-run in one second's time.\n\n    sendClockPulse = ->\n        bus.push new Date\n        setTimeout sendClockPulse, 1000\n\nWe immediately start the clock.\n\n    do sendClockPulse\n\nIn the future, it would be a wise plan to try to synchronise the\nclock pulses, as close as possible, to the actual tick of the system\nRTC. This would mean that, assuming the screens are synchronised\nover NTP, they all pulse at the same time.\n\nFinally, we create the public API to the system: a property,\ninitialised with the current date.\n\n    window.Clock = bus.toProperty new Date\n\nDay Base\n--------\n\nThe *day base* is the UNIX timestamp of midnight, today. It can be accessed via\nthe *DayBase* function.\n\nIn its implementation, we first get the current time as a JavaScript *Date*\nobject.\n\n    window.DayBase = ->\n        rightNow = new Date\n\nWe then, since the *Date* object is mutable, set its time fields to zero.\n\n        rightNow.setHours 0\n        rightNow.setMinutes 0\n        rightNow.setSeconds 0\n        rightNow.setMilliseconds 0\n\nFinally, we convert to a UNIX timestamp, and divide by 1000 since the JavaScript\nAPI is generally oriented around milliseconds rather than seconds.\n\n        rightNow.valueOf() \/ 1000\n\nAs a utility function, we also provide *FromUNIX*, which converts between UNIX\ntimestamps and JavaScript *Date* objects.\n\nIts implementation is trivial.\n\n    window.FromUNIX = (unixTimestamp) -> new Date(1000 * unixTimestamp)\n\n","old_contents":"Clock Source\n============\n\nThis clock source acts as a synchronisation point for anything which depends\non the time.\n\nFirst, we create the Bacon.js bus. This event source is the destination to\nwhich we push each clock pulse.\n\n    bus = new Bacon.Bus\n\nThe *sendClockPulse* function actually injects the clock pulse into\nthe bus. It has two functions: not only does it get the current\ndate and inject it into the bus, but it also schedules itself to\nbe re-run in one second's time.\n\n    sendClockPulse = ->\n        bus.push new Date\n        setTimeout sendClockPulse, 1000\n\nWe immediately start the clock.\n\n    do sendClockPulse\n\nIn the future, it would be a wise plan to try to synchronise the\nclock pulses, as close as possible, to the actual tick of the system\nRTC. This would mean that, assuming the screens are synchronised\nover NTP, they all pulse at the same time.\n\nFinally, we create the public API to the system: a property,\ninitialised with the current date.\n\n    window.Clock = bus.toProperty new Date\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fe91139a3a1cf670969c2c7e80956b2d2b1c8b61","subject":"Always return default fields in addition to custom ones","message":"Always return default fields in addition to custom ones\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      blacklist:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.status(404).json message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.status(404).json message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.sendStatus 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `endret`, `lisens`, `navn`, `status`, `tilbyder`, and `tags` in\naddition to `\\_id` ObjectID which is always returned by MongoDB.\n\n      fields =\n        endret: true\n        lisens: true\n        navn: true\n        status: true\n        tags: true\n        tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nMake new cursor object with the correct query, fields, and other options (limit,\nskip, and sort).\n\n      cursor = req.db.col.find req.db.query, fields,\n        limit: Math.min (parseInt(req.query.limit, 10) or 20), 50\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min cursor.cmd.limit, Math.max total - cursor.cmd.skip, 0\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.sendStatus 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(422).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.status(422).json\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.status(201).json\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      blacklist:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      col = decodeURIComponent col\n\n      if col not in collections\n        return res.status(404).json message: \"Type #{col} not found\"\n\n      req.type = col\n      req.db   = col: mongo[col], query: {}\n\n      next()\n\n    exports.paramCol2 = (req, res, next, col2) ->\n      if col not in collections\n        return res.status(404).json message: \"Type #{col2} not found\"\n\n      req.type      = col2\n      req.db.col    = mongo[col2]\n      req.db.query  = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n      next()\n\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.sendStatus 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n\n### Query\n\n      req.db.query = qs.parse req.query\n\nPrevent private documents for other API user from being returned when quering\n`tilbyder` and `status` fields.\n\n      for key, val of req.query\n        switch key\n          when 'status'\n            req.db.query.tilbyder = req.user.tilbyder if val not in ['Offentlig', 'Slettet']\n            break\n          when 'tilbyder'\n            req.db.query.status = 'Offentlig' if val isnt req.user.tilbyder\n            break\n          else\n            if key.substr(0,6) is 'privat'\n              req.db.query.tilbyder = req.user.tilbyder\n              break\n\nApply default access control unless `status` or `tilbyder` fields are already\nqueried.\n\n      if not req.db.query.tilbyder or req.db.query.status\n        req.db.query.$or = [{status: 'Offentlig'}, {tilbyder: req.user.tilbyder}]\n\n### Fields\n\nAlways return `lisens` and `tilbyder` fields for propper attribution. Document\nObjectID is always returned by MongoDB.\n\n      fields = lisens: true, tilbyder: true\n\nParse user specified fields to be returned.\n\n      if typeof req.query.fields is 'string' and req.query.fields\n        for field in req.query.fields.split ',' when field.substr(0,6) isnt 'privat'\n          fields[field] = true\n\nDefault fields if unless specified by the user.\n\n      else\n        fields.endret = true\n        fields.status = true\n        fields.navn = true\n        fields.tags = true\n\n### Sort\n\nLimit sort to ascending or descending on `endret` and `navn` since they are\nindexed, non-indexed fields could be slower. Also, don't allow ordering of\ngeospatial queries to prevent performance bottlenecks. From the [MongoDB\nrefference](http:\/\/docs.mongodb.org\/manual\/reference\/operator\/query\/near\/#behavior):\n\n> $near always returns the documents sorted by distance. Any other sort order\n> requires to sort the documents in memory, which can be inefficient.\n\n      if not req.db.query.geojson\n        sort = switch req.query.sort\n          when 'endret' then [['endret', 1]]\n          when '-endret' then [['endret', -1]]\n          when 'navn' then [['navn', 1]]\n          when '-navn' then [['navn', -1]]\n          else 'endret'\n\n### Execute\n\nMake new cursor object with the correct query, fields, and other options (limit,\nskip, and sort).\n\n      cursor = req.db.col.find req.db.query, fields,\n        limit: Math.min (parseInt(req.query.limit, 10) or 20), 50\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: sort\n\nCount number of matching documents in MongoDB database.\n\n      cursor.count false, (err, total) ->\n        return next err if err\n\nCalculate the total number of documents that will eventually be returned (not\nthe total number of matching documents) since we don't know that in advanced\n(due to the nature of streaming).\n\n        count = Math.min cursor.cmd.limit, Math.max total - cursor.cmd.skip, 0\n\nSet `Count-Return` and `Count-Total` headers so that one can use a `HEAD` query\nto look up the number of matched documents for a query without the documents\nthem selves. This may be useful for statistics purposes.\n\n        res.set 'Count-Return', count\n        res.set 'Count-Total', total\n\nReturn to the user if this is a `HEAD` query or there are no matching documents.\n\n        return res.sendStatus 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n\nStream matching documents in order to prevent loading them into memory.\n\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.status(400).json message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.status(422).json message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.user.tilbyder\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.status(422).json\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.status(201).json\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"303e2e1d7e9539d2814ba3abebb104699dece346","subject":"Fixed pitch of first person camera being inverted.","message":"Fixed pitch of first person camera being inverted.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat","old_file":"src\/cameras\/firstPerson.litcoffee","new_file":"src\/cameras\/firstPerson.litcoffee","new_contents":"# firstPerson\n\nA camera instance is an object containing:\n\n- transform: A transform matrix to apply this frame.\n- transformPreviousDraw: A transform matrix to apply the previous frame.\n\n    matrix = require \".\/..\/matrix.litcoffee\"\n    vector = require \".\/..\/vector.litcoffee\"\n    navmesh = require \".\/..\/navmesh.litcoffee\"\n    misc = require \".\/..\/misc.litcoffee\"\n    plane = require \".\/..\/plane.litcoffee\"\n\n## create\n\n- An object equivalent to the \"gamepad\" module.\n- A navmesh instance to track.\n- A vector specifying the initial location of the camera.\n- The initial yaw, in radians.\n- The initial pitch, in radians.\n- The speed, in units per tick, at which the camera may move horizontally.\n- The speed, in radians per tick, at which the camera may yaw.\n- The speed, in radians per tick, at which the camera may pitch.\n- The height above the ground at which to place the camera.\n\nReturns a new camera instance.\n\n    create = (gamepad, navmeshInstance, location, yaw, pitch, speed, yawSpeed, pitchSpeed, height) ->\n        locationCopy = []\n        vector.copy location, locationCopy\n        previousLocation = []\n        vector.copy location, previousLocation\n\n        location: locationCopy\n        previousLocation: previousLocation\n        interpolatedLocation: []\n        transform: []\n        transformPreviousDraw: []\n\n        firstTick: true\n        firstDraw: true\n\n        triangle: navmesh.findNearest navmeshInstance, location\n\n        gamepad: gamepad\n        pitch: pitch\n        yaw: yaw\n        previousPitch: pitch\n        previousYaw: yaw\n        speed: speed\n        yawSpeed: yawSpeed\n        pitchSpeed: pitchSpeed\n\n        height: height\n\n## tick\n\n- A camera instance.\n\n    tick = (cameraInstance) ->\n        if not cameraInstance.firstTick\n            vector.copy cameraInstance.location, cameraInstance.previousLocation\n            cameraInstance.previousYaw = cameraInstance.yaw\n            cameraInstance.previousPitch = cameraInstance.pitch\n\n        cameraInstance.yaw += (cameraInstance.gamepad.turnRight - cameraInstance.gamepad.turnLeft) * cameraInstance.yawSpeed\n\n        cameraInstance.pitch += (cameraInstance.gamepad.up - cameraInstance.gamepad.down) * cameraInstance.pitchSpeed\n        cameraInstance.pitch = Math.min (Math.PI \/ 2), Math.max (Math.PI \/ -2), cameraInstance.pitch\n\n        forward = (cameraInstance.gamepad.forward - cameraInstance.gamepad.backward) * cameraInstance.speed\n        cameraInstance.location[0] += (Math.sin cameraInstance.yaw) * forward\n        cameraInstance.location[2] += (Math.cos cameraInstance.yaw) * forward\n\n        side = (cameraInstance.gamepad.right - cameraInstance.gamepad.left) * cameraInstance.speed\n        cameraInstance.location[0] += (Math.cos cameraInstance.yaw) * side\n        cameraInstance.location[2] -= (Math.sin cameraInstance.yaw) * side\n\n        cameraInstance.triangle = navmesh.constrain cameraInstance.location, cameraInstance.triangle\n        plane.project cameraInstance.triangle.plane, cameraInstance.location, cameraInstance.location\n\n        if cameraInstance.firstTick\n            vector.copy cameraInstance.location, cameraInstance.previousLocation\n            cameraInstance.firstTick = false\n\n        return\n\n## preDraw\n\n- A camera instance.\n- The progress through the current tick, where \"0\" is the previous tick and \"1\"\n  is the new tick.\n\n    interpolatedLocation = []\n\n    preDraw = (cameraInstance, progress) ->\n        if not cameraInstance.firstDraw\n            matrix.copy cameraInstance.transform, cameraInstance.transformPreviousDraw\n\n        matrix.identity cameraInstance.transform\n\n        vector.interpolate cameraInstance.previousLocation, cameraInstance.location, progress, interpolatedLocation\n        interpolatedLocation[1] += cameraInstance.height\n        vector.negate interpolatedLocation, interpolatedLocation\n        matrix.translate interpolatedLocation, cameraInstance.transform\n\n        matrix.rotateY (misc.interpolate cameraInstance.previousYaw, cameraInstance.yaw, progress), cameraInstance.transform\n\n        matrix.rotateX (misc.interpolate cameraInstance.previousPitch, cameraInstance.pitch, progress), cameraInstance.transform\n\n        matrix.translate [0, 0, 0], cameraInstance.transform\n\n        if cameraInstance.firstDraw\n            matrix.copy cameraInstance.transform, cameraInstance.transformPreviousDraw\n            cameraInstance.firstDraw = false\n        return\n\n    module.exports = { create, tick, preDraw }","old_contents":"# firstPerson\n\nA camera instance is an object containing:\n\n- transform: A transform matrix to apply this frame.\n- transformPreviousDraw: A transform matrix to apply the previous frame.\n\n    matrix = require \".\/..\/matrix.litcoffee\"\n    vector = require \".\/..\/vector.litcoffee\"\n    navmesh = require \".\/..\/navmesh.litcoffee\"\n    misc = require \".\/..\/misc.litcoffee\"\n    plane = require \".\/..\/plane.litcoffee\"\n\n## create\n\n- An object equivalent to the \"gamepad\" module.\n- A navmesh instance to track.\n- A vector specifying the initial location of the camera.\n- The initial yaw, in radians.\n- The initial pitch, in radians.\n- The speed, in units per tick, at which the camera may move horizontally.\n- The speed, in radians per tick, at which the camera may yaw.\n- The speed, in radians per tick, at which the camera may pitch.\n- The height above the ground at which to place the camera.\n\nReturns a new camera instance.\n\n    create = (gamepad, navmeshInstance, location, yaw, pitch, speed, yawSpeed, pitchSpeed, height) ->\n        locationCopy = []\n        vector.copy location, locationCopy\n        previousLocation = []\n        vector.copy location, previousLocation\n\n        location: locationCopy\n        previousLocation: previousLocation\n        interpolatedLocation: []\n        transform: []\n        transformPreviousDraw: []\n\n        firstTick: true\n        firstDraw: true\n\n        triangle: navmesh.findNearest navmeshInstance, location\n\n        gamepad: gamepad\n        pitch: pitch\n        yaw: yaw\n        previousPitch: pitch\n        previousYaw: yaw\n        speed: speed\n        yawSpeed: yawSpeed\n        pitchSpeed: pitchSpeed\n\n        height: height\n\n## tick\n\n- A camera instance.\n\n    tick = (cameraInstance) ->\n        if not cameraInstance.firstTick\n            vector.copy cameraInstance.location, cameraInstance.previousLocation\n            cameraInstance.previousYaw = cameraInstance.yaw\n            cameraInstance.previousPitch = cameraInstance.pitch\n\n        cameraInstance.yaw += (cameraInstance.gamepad.turnRight - cameraInstance.gamepad.turnLeft) * cameraInstance.yawSpeed\n\n        cameraInstance.pitch += (cameraInstance.gamepad.down - cameraInstance.gamepad.up) * cameraInstance.pitchSpeed\n        cameraInstance.pitch = Math.min (Math.PI \/ 2), Math.max (Math.PI \/ -2), cameraInstance.pitch\n\n        forward = (cameraInstance.gamepad.forward - cameraInstance.gamepad.backward) * cameraInstance.speed\n        cameraInstance.location[0] += (Math.sin cameraInstance.yaw) * forward\n        cameraInstance.location[2] += (Math.cos cameraInstance.yaw) * forward\n\n        side = (cameraInstance.gamepad.right - cameraInstance.gamepad.left) * cameraInstance.speed\n        cameraInstance.location[0] += (Math.cos cameraInstance.yaw) * side\n        cameraInstance.location[2] -= (Math.sin cameraInstance.yaw) * side\n\n        cameraInstance.triangle = navmesh.constrain cameraInstance.location, cameraInstance.triangle\n        plane.project cameraInstance.triangle.plane, cameraInstance.location, cameraInstance.location\n\n        if cameraInstance.firstTick\n            vector.copy cameraInstance.location, cameraInstance.previousLocation\n            cameraInstance.firstTick = false\n\n        return\n\n## preDraw\n\n- A camera instance.\n- The progress through the current tick, where \"0\" is the previous tick and \"1\"\n  is the new tick.\n\n    interpolatedLocation = []\n\n    preDraw = (cameraInstance, progress) ->\n        if not cameraInstance.firstDraw\n            matrix.copy cameraInstance.transform, cameraInstance.transformPreviousDraw\n\n        matrix.identity cameraInstance.transform\n\n        vector.interpolate cameraInstance.previousLocation, cameraInstance.location, progress, interpolatedLocation\n        interpolatedLocation[1] += cameraInstance.height\n        vector.negate interpolatedLocation, interpolatedLocation\n        matrix.translate interpolatedLocation, cameraInstance.transform\n\n        matrix.rotateY (misc.interpolate cameraInstance.previousYaw, cameraInstance.yaw, progress), cameraInstance.transform\n\n        matrix.rotateX (misc.interpolate cameraInstance.previousPitch, cameraInstance.pitch, progress), cameraInstance.transform\n\n        matrix.translate [0, 0, 0], cameraInstance.transform\n\n        if cameraInstance.firstDraw\n            matrix.copy cameraInstance.transform, cameraInstance.transformPreviousDraw\n            cameraInstance.firstDraw = false\n        return\n\n    module.exports = { create, tick, preDraw }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a599168f5c14330a70a18eb47ec0530d90fa0bd8","subject":"doc Model.createFromJSON","message":"doc Model.createFromJSON\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## @createFromJSON(attributes = {}) : Model\n\nReturns an instance of the model based on `attributes`. If the `primaryKey` is present in `attributes`, the in-memory identity map will be searched for a match. If a match is found, it will be updated with `attributes` (without tracking) and returned. If the `primaryKey` isn't present, a new instance is added to the `loaded` set and returned.\n\nSince `createFromJSON` checks the identity map, it's a great way to load data without duplicating records in memory.\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::%dirtyKeys : Set\n\nThe set of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## @constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is essentially equivalent to\ncalling `(new App.Model).save()`:\n\n    asyncTest \"@create instantiates a new record instance and saves it\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # Using new + save:\n      record = new Post(name: 'aName')\n      record.save()\n\n      # Using create:\n      otherRecord = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), otherRecord.get('name')\n        equal record.isNew(), false\n        equal otherRecord.isNew(), false\n\n_Note_ : `attributes` is an empty object `{}` by default. This means the single-argument version of `create` accepts the callback, and not the attributes object.\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## ::%id\n\nA universally accessible accessor to the record's primary key. If the record's\nprimary key is `id` (the default), getting\/setting this accessor simply passes\nthe call through to `id`, otherwise it proxies the call to the custom primary key.\n\n    test \"id proxies the primary key\", ->\n      class Post extends Batman.Model\n        @primaryKey: 'name'\n\n      post = new Post(name: 'Witty title')\n      equal post.get('id'), 'Witty title'\n\n      post.set('id', 'Wittier title')\n      equal post.get('name'), 'Wittier title'\n\n## ::%dirtyKeys : Set\n\nThe set of keys which have been modified since the last time the record was saved.\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## @constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns true if the instance represents a record that hasn't yet been persisted to storage. The default implementation simply checks if `@get('id')` is undefined, but you can override this on your own models.\n\n`isNew` is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\nReturns a string representation suitable for debugging. By default this just contains the model's `resourceName` and `id`\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nLoads attributes from a bare object into this instance.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## ::toParam() : value\n\nReturns a representation of the model suitable for use in a URL. By default, this is the record's `id`.\n\nThis method is used by the routing system for serializing records into a URL.\n\n## ::hasStorage() : boolean\n\nTrue when the record has a storage adapter defined.\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e4184c2c2072da309370cc68c9e35895877fc5f2","subject":"Refactor so that we only create one instance of Skyll","message":"Refactor so that we only create one instance of Skyll\n\nAlso added a bit of logging to et us know when a level has completed\nrendering\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/cli.litcoffee","new_file":"lib\/cli.litcoffee","new_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    Config = require '.\/config'\n\n    new Config()\n      .initialize()\n      .then (config) ->\n        Skyll = require '.\/skyll'\n        next  = 0\n\n        new Skyll()\n          .initialize starting_row: Math.floor config.grid.length \/ 2\n          .then (mod) ->\n            render = (level) ->\n              mod.craft level\n                .then ->\n                  console.log 'finished rendering level', next\n                  render config.levels[next] if ++next < config.levels.length\n\n            render config.levels[next]\n","old_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    Config = require '.\/config'\n\n    new Config()\n      .initialize()\n      .then (config) ->\n        Skyll = require '.\/skyll'\n        next  = 0\n\n        render = (level) ->\n          new Skyll()\n            .initialize starting_row: Math.floor config.grid.length \/ 2\n            .then (mod) -> mod.craft level\n            .then -> render config.levels[next] if ++next < config.levels.length\n\n        render config.levels[next]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ba8f26f723bb2068bd5459ea0b911a248abe0028","subject":"Collection view now has collection property","message":"Collection view now has collection property\n","repos":"ojjs\/oj","old_file":"src\/oj.litcoffee","new_file":"src\/oj.litcoffee","new_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = module.exports = ->\n      # Prevent oj method from propagating\n      oj._argumentsPush()\n      ojml = oj.emit.apply @, arguments\n      oj._argumentsPop()\n      ojml\n\nEmit arguments as if it was an oj tag function\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\nKeep a reference to ourselves for templates to see\n\n    oj.oj = oj\n\noj.begin\n-------------------------------------------------------------------------------\n\n    oj.begin = (page) ->\n\n  Defer dom manipulation until the page has loaded\n\n      _readyOrLoad ->\n\n  Compile only the body and below\n\n        bodyOnly = html:1, doctype:1, head:1, link:1, script:1\n        {dom,types} = oj.compile dom:1, html:0, css:0, ignore:bodyOnly, (require page)\n\n        if not dom?\n          console.error 'oj: dom failed to compile'\n          return\n\n  Find body element\n\n        body = document.getElementsByTagName 'body'\n        if body.length == 0\n          console.error 'oj: <body> was not found'\n          return\n        body = body[0]\n\n  Clear body and insert dom elements\n\n        body.innerHTML = ''\n        if not oj.isArray dom\n          dom = [dom]\n        for d in dom\n          body.appendChild d\n\n  Trigger inserted event for types\n\n        for t in types\n          t.inserted()\n\n  Trigger events bound through oj.ready\n\n        oj.ready()\n\n_readyOrLoad\n-------------------------------------------------------------------------------\nHelper method that loads with either ready or onload (whichever exists)\n\n    _readyOrLoad = (fn) ->\n\n  Use jquery ready if it exists\n\n      if jQuery?\n        jQuery fn\n\n  Use onload\n\n      else\n        # Add onload if it hasn't happened yet\n        if document.readyState != \"complete\"\n          prevOnLoad = window.onload\n          window.onload = ->\n            prevOnLoad?()\n            fn()\n\n  Call the function immediately if onload already happened\n\n        else\n          fn()\n      return\n\noj.ready\n-------------------------------------------------------------------------------\n\n    _readyQueue = queue:[], loaded:false\n    oj.ready = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _readyQueue.loaded = true\n        while (f = _readyQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _readyQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _readyQueue.queue.push f\n      return\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\n## oj.guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\n\nRegister require.extension for .oj files in node\n-------------------------------------------------------------------------------\n\nTODO: Consider moving this to server.litcoffee\nTODO: Compile.ojlc files as literate coffee-script\n\n    if require.extensions\n\n      coffee = require 'coffee-script'\n\n      stripBOM = (c) -> if c.charCodeAt(0) == 0xFEFF then (c.slice 1) else c\n\n      wrapJS = (code) ->\n        \"(function(){with(oj.sandbox){#{code}}}).call(this);\"\n\n      wrapCSMessage = (message, filepath) ->\n        \"#{oj.codes?.red}coffee-script error in #{filepath}: #{message}#{oj.codes?.reset}\"\n      wrapJSMessage = (message, filepath) ->\n        \"#{oj.codes?.red}javascript error in #{filepath}: #{message}#{oj.codes?.reset}\"\n\n      compileJS = (module, code, filepath) ->\n        code = wrapJS code\n        global.oj = oj\n        module._compile code, filepath\n        delete global.oj\n\n  Compile .oj files as javascript\n\n      require.extensions['.oj'] = (module, filepath) ->\n        code = stripBOM fs.readFileSync filepath, 'utf8'\n        try\n          compileJS module, code, filepath\n        catch eJS\n          eJS.message = wrapJSMessage eJS.message, filepath\n          throw eJS\n\n  Compile .ojc files as coffee-script\n\n      require.extensions['.ojc'] = (module, filepath) ->\n        code = stripBOM fs.readFileSync filepath, 'utf8'\n\n        # Compile in coffee-script\n        try\n          code = coffee.compile code, bare: true\n        catch eCoffee\n          eCoffee.message = wrapCSMessage eCoffee.message, filepath\n          throw eCoffee\n\n        # Compile javascript\n        try\n          compileJS module, code, filepath\n\n        catch eJS\n          eJS.message = wrapJSMessage eJS.message, filepath\n          throw eJS\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.0.14'\n\n  Detect if this is the client or server\n\n    oj.isClient = not process?.versions?.node\n\n  Export as a module in NodeJS\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in NodeJS\n\n    else\n      root['oj'] = oj\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility: Helpers\n------------------------------------------------------------------------------\n\n    oj.__ = _ = {}\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      # TODO: support cloning OJ instances\n      # TODO: support options, deep: true\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nUtility: Iteration\n------------------------------------------------------------------------\n\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n  _splitAndTrim\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n------------------------------------------------------------------------------\n\n    _dasherize = (str) ->\n\n      out\n\nPath Helpers\n------------------------------------------------------------------------------\nA simplified form of  github.com\/joyent\/node\/lib\/path.js\n\n    pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n\n      parts\n\n    pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    pathSplit = (filename) ->\n      result = pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n\n      # Normalize the path\n      path = pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n\n      if !path and !isAbsolute\n        path = '.'\n\n      if path and trailingSlash\n        path += '\/'\n\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = Array.prototype.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        # No dirname whatsoever\n        return '.'\n      if dir\n        # It has a dirname, strip trailing slash\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name) ->\n      obj = if oj.isClient then window[name] else global[name]\n      throw new Error(\"oj: #{name} dependency is missing\") unless oj.isDefined obj\n\nDepend on jQuery\n\n    oj.dependency 'jQuery'\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw 'oj.addProperty: string expected for second argument' unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw 'oj.isProperty: string expected for second argument' unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argumentsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argumentsStack = []\n\n  Result is top of the stack\n\n    oj._argumentsTop = ->\n      if _argumentsStack.length\n        _argumentsStack[_argumentsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argumentsPush = (args = []) ->\n      _argumentsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argumentsPop = ->\n      if _argumentsStack.length\n        return _argumentsStack.pop()\n      null\n\n  Append argument\n\n    oj._argumentsAppend = (arg) ->\n      top = oj._argumentsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, args...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from args by unioning all objects\n\n      attributes = {}\n      for arg in args\n\n  TODO: evaluate argument if necessary\n\n        if oj.isObject arg\n          _extend attributes, arg\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argumentsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n        else if oj.isFunction arg\n\n          len = oj._argumentsTop().length\n\n          # Call the argument it will auto append to oj._argumentsTop() which is ojml\n          r = arg()\n\n          # Use return value if oj._argumentsTop() weren't changed\n          if len == oj._argumentsTop().length and r?\n            oj._argumentsAppend r\n\n        else\n          oj._argumentsAppend arg\n\n  Pop to restore previous context\n\n      oj._argumentsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to\n\n      oj._argumentsAppend ojml\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n        oj[t] = -> oj.tag t, arguments...\n        # Remember the tag name\n        _setTagName oj[t], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = '<!DOCTYPE HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = '<!DOCTYPE html>'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\">'\n\n  Define possible arguments\n\n    doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\">'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\">'\n\n  Define the method\n\n    oj.doctype = (type = 5) ->\n      ojml = doctypes[type]\n\n  Emit as a tag would\n\n      oj._argumentsAppend ojml\n      ojml\n\noj.extend (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.extend = (context = root) ->\n      o = {}\n      for k,v of oj\n        if k[0] != '_'\n          o[k] = v\n      delete o.extend\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* debug - Keep all source including comments\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: true\n        css: true\n        cssMap: false\n        styles: false\n        debug: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css || options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      # Generate cssMap\n      if options.cssMap\n        cssMap = acc.css\n\n      # Generate css\n      if options.css\n        css = _cssFromObject acc.css, options.debug\n\n      # Generate HTML\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then _isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_dasherize\n-----------------------------------------------------------------------------\nConvert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n_decamelize\n-----------------------------------------------------------------------------\nConvert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n'@media query': 'rule': 'stylesMap'\n\nThis method is the heart of `_cssFromObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      _flattenCSSMap_ cssMap, flatMap, [''], ['']\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n  TODO: Refactor to use the same code as media queries\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_cssFromObject:\n-----------------------------------------------------------------------------\nConvert css selectors and rules to a string\n\nSupports nested objections, comma seperated rules, and @media queries\n\ndebug:true will output newlines\n\n    _cssFromObject = (cssMap, debug = 0) ->\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n      flatMap = _flattenCSSMap cssMap\n\n      css = ''\n      for media, selectorMap of flatMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if debug and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if debug then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += \"#{rules}#{indent}}#{newline}\"\n\n  End media query\n\n        if media != ''\n          css += \"}#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        when 'jquery'\n          # TODO: Missing unit tests for the jquery case\n          options.html?.push ojml.html()\n          options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML()\n            options.dom?.appendChild ojml.toDOM()\n            if options.css?\n              _extend options.css, ojml.toCSSMap()\n\n      return\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Compile ojml tag (an array)\n    _compileTag = (ojml, options) ->\n\n      # Empty list compiles to nothing\n      return if ojml.length == 0\n\n      # Get tag\n      tag = ojml[0]\n      tagType = typeof tag\n\n      # Allow ojml's tag parameter to be 'table' or table or Table\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n\n      # Fail if we couldn't find a string by now\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n      # Create oj object if tag is capitalized\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n      # Record tag\n      options.tags[tag] = true\n\n      # Get attributes (optional)\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n      # Remaining arguments are children of this tag\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n      # Compile to css if requested\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css[selector] ?= styles\n          _extend options.css[selector], styles\n\n      # Compile to html if requested\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n\n      # Compile your children if necessary\n      for child in children\n        # Skip intention if there is only one child\n        if options.debug && children.length > 1\n          options.html?.push \"\\n\\t#{options.indent}\"\n        _compileDeeper _compileAny, child, options\n\n      # Skip intention if there is only one child\n      if options.debug && children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n      # End html tag if you have children or your tag closes\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Allow attributes to take class as an array of strings\n    _attributeClassAllowsArrays = (attr) ->\n      if oj.isArray attr?.class\n        attr.class = attr.join ' '\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # TODO: Consider jsoning anything that isn't a string\n      # any keys that aren't strings are jsoned\n      # _attributesJSONAllKeys attributes\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if $?\n          if oj.isArray ev\n            $(el)[ek].apply @, ev\n          else\n            $(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\n    # oj.toHTML\n    # ------------------------------------------------------------------------------\n    # Make oj directly to HTML. It will ignore all event bindings\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options,\n        dom: false\n        js: false\n        html: true\n        css: false\n\n      (oj.compile options, ojml).html\n\n    # oj.toCSS\n    # ------------------------------------------------------------------------------\n    # Make oj directly to css. It will ignore all event bindings and html\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options,\n        dom: false\n        js: false\n        html: false\n        css: true\n\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        # TODO: Make this O(1)\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        # TODO: Make this O(1)\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # argumentsUnion:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.argumentsUnion = (argList) ->\n      obj = {}\n      list = []\n      for v in argList\n        if oj.isObject v\n          obj = _extend obj, v\n        else\n          list.push v\n      options: obj, args: list\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el, cssMap:@cssMap} = oj.compile css:0, cssMap:1, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = $ @el)\n\n        # Get all attributes (readonly)\n        attributes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get and set id of view from attribute\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # CSS generated for this instance\n        cssMap:\n          get: -> @_cssMap ? {}\n          set: (v) ->\n            @_cssMap = v\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n\n              # Wrap k in quotes if it has whitespace\n              if k == 'class'\n                @$el.addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argumentsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.debug then '\\n' else '')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (debug) -> _cssFromObject @cssMap, debug\n\n        # Convert\n        toCSSMap: -> @cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n    oj.View.css = (def) ->\n      oj.View.styles.push _setObject {}, \".oj-#{@typeName}\", def\n      return\n\n    oj.View.theme = (name, def) ->\n      def = _setObject {}, \".oj-#{@typeName}.theme-#{_dasherize name}\", def\n      @type.themes.push _setObject {}, (_dasherize name), def\n      @type.styles.push def\n      return\n\n    oj.View.styles = []\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        collection:\n          get: -> @models\n          set: (v) -> @models = v\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionAdded, @\n              @_models.on 'remove', @collectionRemoved, @\n              @_models.on 'change', @collectionChanged, @\n              @_models.on 'reset', @collectionReset, @\n              @_models.on 'destroy', @collectionDestroyed, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionAdded: (model, collection) -> @make()\n        collectionRemoved: (model, collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n        collectionChanged: (model, collection, options) -> # Do nothing\n        collectionDestroyed: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.textarea\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: (args) ->\n        {options, args} = oj.argumentsUnion arguments\n\n        # Label is first argument\n        options.label ?= if args.length > 0 then args[0] else ''\n\n        @el = oj =>\n          oj.button options.label\n\n        oj.Button.base.constructor.apply @, [options]\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionAdded: Model add occurred, add the item\n\n        collectionAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionRemoved: Model remove occured, delete the item\n\n        collectionRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> console.log \"clearing body: oj.litcoffee:2930\";@$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get $(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set $(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\njquery.oj\n-----------------------------------------------------------------------------\n\n    jQuery.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types} = oj.compile {dom:1,html:0,css:0}, args...\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        for d in dom\n          $el.append d\n\n        # Call inserted event on all types\n        for t in types\n          t.inserted()\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njquery.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    jQuery.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njquery.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    jQuery.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njquery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        jQuery.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types} = oj.compile {dom:1,html:0}, args...\n\n            # Append to the dom\n            $el[jqName] dom\n\n            for t in types\n              t.inserted()\n\n            return\n\n          get:null\n\n\n\n\n\n","old_contents":"\noj\n==============================================================================\nA unified templating framework for the people. Thirsty people.\n\noj function\n-------------------------------------------------------------------------------\n\nConvert ojml to dom\n\n    oj = module.exports = ->\n      # Prevent oj method from propagating\n      oj._argumentsPush()\n      ojml = oj.emit.apply @, arguments\n      oj._argumentsPop()\n      ojml\n\nEmit arguments as if it was an oj tag function\n\n    oj.emit = ->\n      ojml = oj.tag 'oj', arguments...\n\nKeep a reference to ourselves for templates to see\n\n    oj.oj = oj\n\noj.begin\n-------------------------------------------------------------------------------\n\n    oj.begin = (page) ->\n\n  Defer dom manipulation until the page has loaded\n\n      _readyOrLoad ->\n\n  Compile only the body and below\n\n        bodyOnly = html:1, doctype:1, head:1, link:1, script:1\n        {dom,types} = oj.compile dom:1, html:0, css:0, ignore:bodyOnly, (require page)\n\n        if not dom?\n          console.error 'oj: dom failed to compile'\n          return\n\n  Find body element\n\n        body = document.getElementsByTagName 'body'\n        if body.length == 0\n          console.error 'oj: <body> was not found'\n          return\n        body = body[0]\n\n  Clear body and insert dom elements\n\n        body.innerHTML = ''\n        if not oj.isArray dom\n          dom = [dom]\n        for d in dom\n          body.appendChild d\n\n  Trigger inserted event for types\n\n        for t in types\n          t.inserted()\n\n  Trigger events bound through oj.ready\n\n        oj.ready()\n\n_readyOrLoad\n-------------------------------------------------------------------------------\nHelper method that loads with either ready or onload (whichever exists)\n\n    _readyOrLoad = (fn) ->\n\n  Use jquery ready if it exists\n\n      if jQuery?\n        jQuery fn\n\n  Use onload\n\n      else\n        # Add onload if it hasn't happened yet\n        if document.readyState != \"complete\"\n          prevOnLoad = window.onload\n          window.onload = ->\n            prevOnLoad?()\n            fn()\n\n  Call the function immediately if onload already happened\n\n        else\n          fn()\n      return\n\noj.ready\n-------------------------------------------------------------------------------\n\n    _readyQueue = queue:[], loaded:false\n    oj.ready = (f) ->\n\n  Call everything if no arguments\n\n      if oj.isUndefined f\n        _readyQueue.loaded = true\n        while (f = _readyQueue.queue.shift())\n          f()\n\n  Call load if already loaded\n\n      else if _readyQueue.loaded\n        f()\n\n  Queue function for later\n\n      else\n        _readyQueue.queue.push f\n      return\n\noj.id\n-----------------------------------------------------------------------------\nGenerate a unique oj id\n\n    oj.id = (len, chars) ->\n      'oj' + oj.guid len, chars\n\n## oj.guid\n\n    _randomInteger = (min, max) ->\n      return null if min == null or max == null or min > max\n      diff = max - min;\n      # random int from zero to number minus one\n      rnd = Math.floor Math.random() * (diff + 1)\n      rnd + min\n\n    _chars = \"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\".split ''\n    oj.guid = (len = 8, chars = _chars) ->\n      # Default arguments\n      base = chars.length\n\n      # Calculate how many chars can be determined by each random call\n      charsPerRand = Math.floor Math.log(Math.pow(2,31)-1) \/ Math.log(base)\n      randMin = 0\n      randMax = Math.pow(base, charsPerRand)-1\n\n      # Calculate random chars by calling random the minimum number of times\n      output = \"\"\n      for i in [0...len]\n        # Generate random number\n        if i % charsPerRand == 0\n          rand = _randomInteger randMin, randMax\n        charNext = chars[rand % base]\n        output += charNext\n        rand = Math.floor(rand \/ base)\n\n      output\n\n\nRegister require.extension for .oj files in node\n-------------------------------------------------------------------------------\n\nTODO: Consider moving this to server.litcoffee\nTODO: Compile.ojlc files as literate coffee-script\n\n    if require.extensions\n\n      coffee = require 'coffee-script'\n\n      stripBOM = (c) -> if c.charCodeAt(0) == 0xFEFF then (c.slice 1) else c\n\n      wrapJS = (code) ->\n        \"(function(){with(oj.sandbox){#{code}}}).call(this);\"\n\n      wrapCSMessage = (message, filepath) ->\n        \"#{oj.codes?.red}coffee-script error in #{filepath}: #{message}#{oj.codes?.reset}\"\n      wrapJSMessage = (message, filepath) ->\n        \"#{oj.codes?.red}javascript error in #{filepath}: #{message}#{oj.codes?.reset}\"\n\n      compileJS = (module, code, filepath) ->\n        code = wrapJS code\n        global.oj = oj\n        module._compile code, filepath\n        delete global.oj\n\n  Compile .oj files as javascript\n\n      require.extensions['.oj'] = (module, filepath) ->\n        code = stripBOM fs.readFileSync filepath, 'utf8'\n        try\n          compileJS module, code, filepath\n        catch eJS\n          eJS.message = wrapJSMessage eJS.message, filepath\n          throw eJS\n\n  Compile .ojc files as coffee-script\n\n      require.extensions['.ojc'] = (module, filepath) ->\n        code = stripBOM fs.readFileSync filepath, 'utf8'\n\n        # Compile in coffee-script\n        try\n          code = coffee.compile code, bare: true\n        catch eCoffee\n          eCoffee.message = wrapCSMessage eCoffee.message, filepath\n          throw eCoffee\n\n        # Compile javascript\n        try\n          compileJS module, code, filepath\n\n        catch eJS\n          eJS.message = wrapJSMessage eJS.message, filepath\n          throw eJS\n\nExport Model to NodeJS or globally\n-------------------------------------------------------------------------------\n\n  Remember root context\n\n    root = @\n\n  Define oj version\n\n    oj.version = '0.0.14'\n\n  Detect if this is the client or server\n\n    oj.isClient = not process?.versions?.node\n\n  Export as a module in NodeJS\n\n    if typeof module != 'undefined'\n      exports = module.exports = oj\n\n  Export globally if not in NodeJS\n\n    else\n      root['oj'] = oj\n\nType Helpers\n------------------------------------------------------------------------------\n\nShort names for common prototype and method names\n\n    ArrayP = Array.prototype\n    FuncP = Function.prototype\n    ObjP = Object.prototype\n\n    slice = ArrayP.slice\n    unshift = ArrayP.unshift\n    concat = ArrayP.concat\n\nType helper for oj types\n\n    oj.isOJ = (obj) -> !!(obj?.isOJ)\n\nType helper for event enabled objects such as Backbone models\n\n    oj.isEvent = (obj) -> !!(obj and obj.on and obj.off and obj.trigger)\n\nType helper for DOM element types\n\n    oj.isDOM = (obj) -> !!(obj and obj.nodeType?)\n    oj.isDOMElement = (obj) -> !!(obj and obj.nodeType == 1)\n    oj.isDOMAttribute = (obj) -> !!(obj and obj.nodeType == 2)\n    oj.isDOMText = (obj) -> !!(obj and obj.nodeType == 3)\n\nType helper for jQuery\n\n    oj.isjQuery = (obj) -> !!(obj and obj.jquery)\n\nType helpers for basic types. Based on [underscore.js](http:\/\/underscorejs.org\/)\n\n    oj.isUndefined = (obj) -> obj == undefined\n    oj.isBoolean = (obj) -> obj == true or obj == false or ObjP.toString.call(obj) == '[object Boolean]'\n    oj.isNumber = (obj) -> !!(obj == 0 or (obj and obj.toExponential and obj.toFixed))\n    oj.isString = (obj) -> !!(obj == '' or (obj and obj.charCodeAt and obj.substr))\n    oj.isDate = (obj) -> !!(obj and obj.getTimezoneOffset and obj.setUTCFullYear)\n    oj.isFunction = (obj) -> typeof obj == 'function'\n    oj.isArray = Array.isArray or (obj) -> ObjP.toString.call(obj) == '[object Array]'\n    oj.isRegEx = (obj) -> ObjP.toString.call(obj) == '[object RegExp]'\n    oj.isArguments = (obj) -> ObjP.toString.call(obj) == '[object Arguments]'\n\nType helper for is defined\n\n    oj.isDefined = (obj) -> not (typeof obj == 'undefined')\n\noj.typeOf\n-------------------------------------------------------------------------------\nMimic behavior of built-in typeof operator and integrate jQuery, Backbone, and OJ types\n\n    oj.typeOf = (any) ->\n\n      return 'null' if any == null\n      t = typeof any\n      if t == 'object'\n        if oj.isArray any                     then t = 'array'\n        else if oj.isOJ any                   then t = any.typeName\n        else if oj.isRegEx any                then t = 'regexp'\n        else if oj.isDate any                 then t = 'date'\n        else if oj.isDOMElement any           then t = 'dom-element'\n        else if oj.isDOMText any              then t = 'dom-text'\n        else if oj.isDOMAttribute any         then t = 'dom-attribute'\n        else if oj.isjQuery any               then t = 'jquery'\n        else                                  t = 'object'\n      t\n\noj.parse: Convert string to basic type, number, boolean, null, or undefined\n\n    oj.parse = (str) ->\n      if str == 'undefined'\n        undefined\n      else if str == 'null'\n        null\n      else if str == 'true'\n        true\n      else if str == 'false'\n        false\n      else if !(isNaN(number = parseFloat str))\n        number\n      else\n        str\n\noj.isObject: Determine if object is a vanilla object type\n\n    oj.isObject = (obj) -> (oj.typeOf obj) == 'object'\n\nUtility: Helpers\n------------------------------------------------------------------------------\n\n    oj.__ = _ = {}\n    _isCapitalLetter = (c) -> !!(c.match \/[A-Z]\/)\n    _identity = (v) -> v\n    _has = (obj, key) -> ObjP.hasOwnProperty.call(obj, key)\n    _keys = Object.keys || (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      keys = [];\n      for key of obj\n        if _has obj, key\n          keys[keys.length] = key;\n      keys\n    _values = (obj) ->\n      throw 'Invalid object' if obj != Object(obj)\n      out = []\n      _each obj, (v) -> out.push v\n      out\n\n    _flatten = (array, shallow) ->\n      _reduce array, ((memo, value) ->\n        if oj.isArray value\n          return memo.concat(if shallow then value else _flatten(value))\n        memo[memo.length] = value\n        memo\n      ), []\n\n    _reduce = (obj = [], iterator, memo, context) ->\n      initial = arguments.length > 2\n      if ArrayP.reduce and obj.reduce == ArrayP.reduce\n        if context\n          iterator = _bind iterator, context\n        return if initial then obj.reduce iterator, memo else obj.reduce iterator\n\n      _each obj, (value, index, list) ->\n        if (!initial)\n          memo = value\n          initial = true\n        else\n          memo = iterator.call context, memo, value, index, list\n\n      if !initial\n        throw new TypeError 'Reduce of empty array with no initial value'\n      memo\n\n      ctor = ->\n\n_bind: Helper to bind context to function\n\n      _bind = (func, context) ->\n        if func.bind == FuncP.bind and FuncP.bind\n          return FuncP.bind.apply func, slice.call(arguments, 1)\n\n  Safari 5.1 doesn't implement bind in some iOS versions\n  TODO: Remove when iOS 6 reaches 95% adoption\n\n        args = slice.call arguments, 2\n        return bound = ->\n          unless this instanceof bound\n            return func.apply context, args.concat(slice.call arguments)\n          ctor.prototype = func.prototype\n          self = new ctor\n          result = func.apply self, args.concat(slice.call(arguments))\n          if Object(result) == result\n            return result\n          self\n\n    _sortedIndex = (array, obj, iterator = _identity) ->\n      low = 0\n      high = array.length;\n      while low < high\n        mid = (low + high) >> 1;\n        if iterator(array[mid]) < iterator(obj) then low = mid + 1 else high = mid;\n      low\n\n\n  _indexOf\n\n    _indexOf = (array, item, isSorted) ->\n      return -1 unless array?\n      if isSorted\n        i = _sortedIndex array, item\n        return if array[i] == item then i else -1\n      if ArrayP.indexOf and array.indexOf == ArrayP.indexOf\n        return array.indexOf item\n      -1\n\n  _toArray\n\n    _toArray = (obj) ->\n      return [] if !obj\n      return slice.call obj if oj.isArray obj\n      return slice.call obj if oj.isArguments obj\n      return obj.toArray() if obj.toArray and oj.isFunction(obj.toArray)\n      _values obj\n\n  _isEmpty\n\n    # Determine if object or array is empty\n    _isEmpty = (obj) ->\n      return obj.length == 0 if oj.isArray obj\n      for k of obj\n        if _has obj, k\n          return false\n      true\n\n  _clone\n\n    _clone = (obj) ->\n      # TODO: support cloning OJ instances\n      # TODO: support options, deep: true\n      return obj unless (oj.isArray obj) or (oj.isObject obj)\n      if oj.isArray obj then obj.slice() else _extend {}, obj\n\n  _contains\n\n    _contains = (obj, target) ->\n      if not obj?\n        return false\n      if ArrayP.indexOf and obj.indexOf == ArrayP.indexOf\n        return obj.indexOf(target) != -1\n      _some obj, (value) -> value == target\n\n  _some\n\n    _some = (obj, iterator, context) ->\n        iterator ?= _identity\n        result = false\n        if not obj?\n          return result\n        if ArrayP.some and obj.some == ArrayP.some\n          return obj.some iterator, context\n        _each obj, (value, index, list) ->\n          if result or (result = iterator.call(context, value, index, list))\n            return breaker\n        return !!result\n\n_setObject: Set object deeply and ensure each part is an object\n\n    _setObject = (obj, keys..., value) ->\n\n      o = obj\n      for k,ix in keys\n\n  Initialize key to empty object if necessary\n\n        if typeof o[k] != 'object'\n\n          o[k] = {} unless (typeof o[k] == 'object')\n\n  Set final value if this is the last key\n\n        if ix == keys.length - 1\n          o[k] = value\n          break\n\n  Continue deeper\n\n        o = o[k]\n\n      obj\n\nUtility: Iteration\n------------------------------------------------------------------------\n\n  _each\n\n    _breaker = {}\n\n    _each = (col, iterator, context) ->\n\n      return if col == null\n      if ArrayP.forEach and col.forEach == ArrayP.forEach\n        col.forEach iterator, context\n      else if oj.isArray col\n        for v, i in col\n          if iterator.call(context, v, i, col) == _breaker\n            return _breaker\n      else\n        for k, v of col\n          if _has col, k\n            if iterator.call(context, v, k, col) == _breaker\n              return _breaker\n\n  _map\n\n    oj._map = (obj, iterator, options = {}) ->\n\n      context = options.context\n      recurse = options.recurse\n      evaluate = options.evaluate\n\n      # Recurse if necessary\n      iterator_ = iterator\n      if recurse\n        do (options) ->\n          iterator_ = (v,k,o) ->\n            options_ = _extend (_clone options), (key: k, object: v)\n            oj._map v, iterator, options_\n\n      # Evaluate functions if necessary\n      if oj.isFunction obj\n\n        # Functions pass through if evaluate isn't set\n        return obj unless evaluate\n\n        while evaluate and oj.isFunction obj\n          obj = obj()\n\n      out = obj\n\n      # Array case\n      if oj.isArray obj\n        out = []\n        return out unless obj\n        return (obj.map iterator_, context) if ArrayP.map and obj.map == ArrayP.map\n        _each(obj, ((v, ix, list) ->\n          out[out.length] = iterator_.call context, v, ix, list\n        ))\n\n        if obj.length == +obj.length\n          out.length = obj.length\n\n      # Object case\n      else if oj.isObject obj\n        out = {}\n        return out unless obj\n        for k,v of obj\n          # Returning undefined will omit the thing\n          if (r = iterator_.call(context, v, k, obj)) != undefined\n            out[k] = r\n      # Basis of recursive case\n      else\n        return iterator.call context, obj, options.key, options.object,\n      out\n\n  _extend\n\n    _extend = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for key, value of source\n          obj[key] = value\n      ))\n      obj\n\n  _defaults\n\n    _defaults = (obj) ->\n      _each(slice.call(arguments, 1), ((source) ->\n        for prop of source\n          if not obj[prop]?\n            obj[prop] = source[prop]\n      ))\n      obj\n\n  _omit\n\n    _omit = (obj) ->\n      copy = {}\n      keys = concat.apply ArrayP, slice.call(arguments, 1)\n      for key of obj\n        if not _contains keys, key\n          copy[key] = obj[key]\n      copy\n\n  _uniqueSort\n\n    _uniqueSort = (array, isSorted = false) ->\n      if not isSorted\n        array.sort()\n      out = []\n      for item,ix in array\n        if ix > 0 and array[ix-1] == array[ix]\n          continue\n        out.push item\n      out\n\n  _uniqueSortedUnion\n\n    _uniqueSortedUnion = (arr, arr2) ->\n      _uniqueSort (arr.concat arr2)\n\n  _splitAndTrim\n\n    _splitAndTrim = (str, seperator, limit) ->\n      r = str.split seperator, limit\n      oj._map r, (v) -> v.trim()\n\n  _boundOrThrow: Bound index to allow negatives, throw when out of range\n\n    _boundOrThrow = (ix, count, message, method) ->\n      ixNew = if ix < 0 then ix + count else ix\n      unless 0 <= ixNew and ixNew < count\n        throw new Error(\"oj.#{method}#{message} is out of bounds (#{ix} in [0,#{count-1}])\")\n      ixNew\n\nString Helpers\n------------------------------------------------------------------------------\n\n    _dasherize = (str) ->\n\n      out\n\nPath Helpers\n------------------------------------------------------------------------------\nA simplified form of  github.com\/joyent\/node\/lib\/path.js\n\n    pathNormalizeArray = (parts, allowAboveRoot) ->\n      up = 0\n      i = parts.length - 1\n      while i >= 0\n        last = parts[i]\n        if last == '.'\n          parts.splice i, 1\n        else if last == '..'\n          parts.splice i, 1\n          up++\n        else if up\n          parts.splice i, 1\n          up--\n        i--\n\n      if allowAboveRoot\n        while up--\n          parts.unshift '..'\n\n      parts\n\n    pathSplitRe = \/^(\\\/?)([\\s\\S]+\\\/(?!$)|\\\/)?((?:\\.{1,2}$|[\\s\\S]+?)?(\\.[^.\\\/]*)?)$\/\n    pathSplit = (filename) ->\n      result = pathSplitRe.exec filename\n      [result[1] or '', result[2] or '', result[3] or '', result[4] or '']\n\n    oj._pathResolve = ->\n      resolvedPath = ''\n      resolvedAbsolute = false\n      i = arguments.length-1\n      while i >= -1 and !resolvedAbsolute\n        path = if (i >= 0) then arguments[i] else process.cwd()\n        if (typeof path != 'string') or !path\n          continue\n        resolvedPath = path + '\/' + resolvedPath\n        resolvedAbsolute = path.charAt(0) == '\/'\n        i--\n      resolvedPath = pathNormalizeArray(resolvedPath.split('\/').filter((p) ->\n        return !!p\n      ), !resolvedAbsolute).join('\/')\n\n      ((if resolvedAbsolute then '\/' else '') + resolvedPath) or '.'\n\n    oj._pathNormalize = (path) ->\n      isAbsolute = path.charAt(0) == '\/'\n      trailingSlash = path.substr(-1) == '\/'\n\n      # Normalize the path\n      path = pathNormalizeArray(path.split('\/').filter((p) ->\n        !!p\n      ), !isAbsolute).join('\/')\n\n      if !path and !isAbsolute\n        path = '.'\n\n      if path and trailingSlash\n        path += '\/'\n\n      (if isAbsolute then '\/' else '') + path\n\n    oj._pathJoin = ->\n      paths = Array.prototype.slice.call arguments, 0\n      oj._pathNormalize(paths.filter((p, index) ->\n        p and typeof p == 'string'\n      ).join('\/'))\n\n    oj._pathDirname = (path) ->\n      result = pathSplit path\n      root = result[0]\n      dir = result[1]\n      if !root and !dir\n        # No dirname whatsoever\n        return '.'\n      if dir\n        # It has a dirname, strip trailing slash\n        dir = dir.substr 0, dir.length - 1\n      root + dir\n\noj.dependency\n------------------------------------------------------------------------------\nEnsure dependencies through oj plugins\n\n    oj.dependency = (name) ->\n      obj = if oj.isClient then window[name] else global[name]\n      throw new Error(\"oj: #{name} dependency is missing\") unless oj.isDefined obj\n\nDepend on jQuery\n\n    oj.dependency 'jQuery'\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd multiple methods to an object\n\n    oj.addMethods = (obj, mapNameToMethod) ->\n      for methodName, method of mapNameToMethod\n        oj.addMethod obj, methodName, method\n      return\n\noj.addMethod\n------------------------------------------------------------------------------\nAdd method to an object\n\n    oj.addMethod = (obj, methodName, method) ->\n\n  Validate input\n\n      # throw 'oj.addMethod: object expected for first argument' unless oj.isObject obj\n      throw 'oj.addMethod: string expected for second argument' unless oj.isString methodName\n      throw 'oj.addMethod: function expected for thrid argument' unless oj.isFunction method\n\n  Methods are non-enumerable, non-writable properties\n\n      Object.defineProperty obj, methodName,\n        value: method\n        enumerable: false\n        writable: false\n        configurable: true\n      return\n\noj.removeMethod\n------------------------------------------------------------------------------\nRemove a method from an object\n\n    oj.removeMethod = (obj, methodName) ->\n\n  Validate inputs\n\n      throw 'oj.removeMethod: string expected for second argument' unless oj.isString methodName\n\n  Remove the method\n      delete obj[methodName]\n      return\n\noj.addProperties\n------------------------------------------------------------------------------\nAdd multiple properties to an object\n\nProperties can be specified by get\/set methods or by a value\n\nValue Property:\n`age: 7    # defaults to {writable:true, enumerable:true}`\n\nValue Property with specified writable\/enumerable:\n`age: {value:7, writable:false, enumerable:false}`\n\nReadonly Get Property\n`age: {get:(-> 7)}`\n\n    oj.addProperties = (obj, mapNameToInfo) ->\n\n  Iterate over properties\n\n      for propName, propInfo of mapNameToInfo\n\n  Wrap the value if propInfo is not already a property definition\n\n        if not propInfo?.get? and not propInfo?.value?\n          propInfo = value: propInfo, writable:true\n\n        oj.addProperty obj, propName, propInfo\n\n      return\n\noj.addProperty\n------------------------------------------------------------------------------\n\n    oj.addProperty = (obj, propName, propInfo) ->\n\nValidate input\n\n      # throw new Error('oj.addProperty: obj expected for first argument') unless oj.isObject obj\n\n      throw new Error('oj.addProperty: string expected for second argument') unless oj.isString propName\n\n      throw new Error('oj.addProperty: object expected for third argument') unless oj.isObject propInfo\n\n\nDefault properties to enumerable and configurable\n\n      _defaults propInfo,\n        enumerable: true\n        configurable: true\n\nRemove property if it already exists\n\n      if Object.getOwnPropertyDescriptor(obj, propName)?\n        oj.removeProperty obj, propName\n\nAdd the property\n\n      Object.defineProperty obj, propName, propInfo\n      return\n\noj.removeProperty\n------------------------------------------------------------------------------\n\n    oj.removeProperty = (obj, propName) ->\n\nValidate input\n\n      throw 'oj.addProperty: string expected for second argument' unless oj.isString propName\n\nRemove property\n\n      delete obj[propName]\n\noj.isProperty\n------------------------------------------------------------------------------\n\n    # Determine if the specified key is was defined by addProperty\n\n    oj.isProperty = (obj, propName) ->\n      throw 'oj.isProperty: string expected for second argument' unless oj.isString propName\n\n      Object.getOwnPropertyDescriptor(obj, propName).get?\n\noj.copyProperty\n------------------------------------------------------------------------------\nDetermine copy source.propName to dest.propName\n\n    oj.copyProperty = (dest, source, propName) ->\n      info = Object.getOwnPropertyDescriptor source, propName\n      if info.value?\n        info.value = _clone info.value\n      Object.defineProperty dest, propName, info\n\n_argumentsStack\n------------------------------------------------------------------------------\nAbstraction to wrap global arguments stack. This makes me sad but it is necessary for div -> syntax\n\n  Stack of results\n\n    _argumentsStack = []\n\n  Result is top of the stack\n\n    oj._argumentsTop = ->\n      if _argumentsStack.length\n        _argumentsStack[_argumentsStack.length-1]\n      else\n        null\n\n  Push scope onto arguments\n\n    oj._argumentsPush = (args = []) ->\n      _argumentsStack.push args\n      return\n\n  Pop scope from arguments\n\n    oj._argumentsPop = ->\n      if _argumentsStack.length\n        return _argumentsStack.pop()\n      null\n\n  Append argument\n\n    oj._argumentsAppend = (arg) ->\n      top = oj._argumentsTop()\n      top?.push arg\n      return\n\noj.tag (name, attributes, content, content, ...)\n------------------------------------------------------------------------------\n\n    oj.tag = (name, args...) ->\n\n*name*: String of tag to serialize\n*attributes*: (Optional) Object defining attributes of tag being serialized\n\nStyles have smart mappings:\n\n`c`  will map to `class`\n`fontSize` will map to `font-size`\n`borderRadius` will map to `moz-border-radius`, etc.\n\n  Validate input\n\n      throw 'oj.tag error: argument 1 is not a string (expected tag name)' unless oj.isString name\n\n  Build ojml starting with tag\n\n      ojml = [name]\n\n  Get attributes from args by unioning all objects\n\n      attributes = {}\n      for arg in args\n\n  TODO: evaluate argument if necessary\n\n        if oj.isObject arg\n          _extend attributes, arg\n\n  Add attributes to ojml if they exist\n\n      ojml.push attributes unless _isEmpty attributes\n\n  Push arguments to build up children tags\n\n      oj._argumentsPush ojml\n\n  Loop over attributes\n\n      for arg in args\n        if oj.isObject arg\n          continue\n        else if oj.isFunction arg\n\n          len = oj._argumentsTop().length\n\n          # Call the argument it will auto append to oj._argumentsTop() which is ojml\n          r = arg()\n\n          # Use return value if oj._argumentsTop() weren't changed\n          if len == oj._argumentsTop().length and r?\n            oj._argumentsAppend r\n\n        else\n          oj._argumentsAppend arg\n\n  Pop to restore previous context\n\n      oj._argumentsPop()\n\n  Append the final result to your parent's arguments\n  if there exists an argument to append to\n\n      oj._argumentsAppend ojml\n\n      ojml\n\n  Define all elements as closed or open\n\n    oj.tag.elements =\n      closed: 'a abbr acronym address applet article aside audio b bdo big blockquote body button canvas caption center cite code colgroup command datalist dd del details dfn dir div dl dt em embed fieldset figcaption figure font footer form frameset h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins keygen kbd label legend li map mark menu meter nav noframes noscript object ol optgroup option output p pre progress q rp rt ruby s samp script section select small source span strike strong style sub summary sup table tbody td textarea tfoot th thead time title tr tt u ul var video wbr xmp'.split ' '\n      open: 'area base br col command css !DOCTYPE embed hr img input keygen link meta param source track wbr'.split ' '\n\n  Keep track of all valid elements\n\n    oj.tag.elements.all = (oj.tag.elements.closed.concat oj.tag.elements.open).sort()\n\n  Determine if an element is closed or open\n\n    oj.tag.isClosed = (tag) ->\n      (_indexOf oj.tag.elements.open, tag, true) == -1\n\n  Record tag name on a given tag function\n\n    _setTagName = (tag, name) ->\n      if tag?\n        tag.tagName = name\n      return\n\n  Get a tag name on a given tag function\n\n    _getTagName = (tag) ->\n      tag.tagName\n\n  Record an oj instance on a given element\n\n    _setInstanceOnElement = (el, inst) ->\n      el?.oj = inst\n      return\n\n  Get a oj instance on a given element\n\n    _getInstanceOnElement = (el) ->\n      if el?.oj?\n        el.oj\n      else\n        null\n\n  Create tag methods for all elements\n\n    for t in oj.tag.elements.all\n      do (t) ->\n        oj[t] = -> oj.tag t, arguments...\n        # Remember the tag name\n        _setTagName oj[t], t\n\noj.doctype\n------------------------------------------------------------------------------\nMethod to define doctypes based on short names\n\n  Define helper variables\n\n    dhp = '<!DOCTYPE HTML PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01'\n    w3 = '\"http:\/\/www.w3.org\/TR\/html4\/'\n    strict5 = '<!DOCTYPE html>'\n    strict4 = dhp+'\/\/EN\" '+w3+'strict.dtd\">'\n\n  Define possible arguments\n\n    doctypes =\n      '5': strict5\n      'HTML 5': strict5\n      '4': strict4\n      'HTML 4.01 Strict': strict4\n      'HTML 4.01 Frameset': dhp+' Frameset\/\/EN\" '+w3+'frameset.dtd\">'\n      'HTML 4.01 Transitional': dhp+' Transitional\/\/EN\" '+w3+'loose.dtd\">'\n\n  Define the method\n\n    oj.doctype = (type = 5) ->\n      ojml = doctypes[type]\n\n  Emit as a tag would\n\n      oj._argumentsAppend ojml\n      ojml\n\noj.extend (context)\n------------------------------------------------------------------------------\nExtend all OJ methods into a context. Common contexts are `global` `window`\nMethods that start with _ are not extended\n\n    oj.extend = (context = root) ->\n      o = {}\n      for k,v of oj\n        if k[0] != '_'\n          o[k] = v\n      delete o.extend\n      _extend context, o\n\noj.compile(options, ojml)\n------------------------------------------------------------------------------\nCompile ojml into meaningful parts\n\noptions:\n\n* html - Compile to html\n* dom - Compile to dom\n* css - Compile to css\n* cssMap - Record css as a javascript object\n* styles -- Output css as style tags\n* debug - Keep all source including comments\n* ignore:{html:1} - Map of tags to ignore while compiling\n\nDefine method\n\n    oj.compile = (options, ojml) ->\n\n  Options is optional\n\n      if not ojml?\n        ojml = options\n        options = {}\n\n      # Default options to compile everything\n      options = _defaults {}, options,\n        html: true\n        dom: true\n        css: true\n        cssMap: false\n        styles: false\n        debug: false\n        ignore: {}\n\n      # Always ignore oj and css tags\n      _extend options.ignore, oj:1, css:1\n\n      acc = _clone options\n      acc.html = if options.html then [] else null    # html accumulator\n      acc.dom = if options.dom and document? then (document.createElement 'OJ') else null\n      acc.css = if options.css || options.cssMap then {} else null\n      acc.indent = ''                                 # indent counter\n      acc.types = [] if options.dom                   # remember types if making dom\n      acc.tags = {}                                   # remember what tags were used\n      _compileAny ojml, acc\n\n      # Generate cssMap\n      if options.cssMap\n        cssMap = acc.css\n\n      # Generate css\n      if options.css\n        css = _cssFromObject acc.css, options.debug\n\n      # Generate HTML\n      if options.html\n        html = acc.html.join ''\n\n      # Generate dom\n      if options.dom\n\n        # Remove the <oj> wrapping from the dom element\n        dom = acc.dom.childNodes\n\n        # Cleanup inconsistencies of childNodes\n        if dom.length?\n          # Make dom a real array\n          dom = _toArray dom\n          # Filter out anything that isn't a dom element\n          dom = dom.filter (v) -> oj.isDOM(v)\n\n        # Ensure dom is null if empty\n        if dom.length == 0\n          dom = null\n\n        # Single elements are returned themselves not as a list\n        # Reasoning: The common cases don't have multiple elements <html>,<body>\n        # or the complexity doesn't matter because insertion is abstracted for you\n        # In short it is easier to check for isArray dom, then _isArray dom && dom.length > 0\n        else if dom.length == 1\n          dom = dom[0]\n\n      out = html:html, dom:dom, css:css, cssMap:cssMap, types:acc.types, tags:acc.tags\n\n      out\n\n_dasherize\n-----------------------------------------------------------------------------\nConvert from camal case or space seperated to dashes\n\n    _dasherize = (str) ->\n      _decamelize(str).replace \/[ _]\/g, '-'\n\n_decamelize\n-----------------------------------------------------------------------------\nConvert from camal case to underscore case\n\n    _decamelize = (str) ->\n      str.replace(\/([a-z])([A-Z])\/g, '$1_$2').toLowerCase()\n\n_styleFromObject:\n-----------------------------------------------------------------------------\nConvert object to string form\n\n    #\n    #     inline:false      inline:true                inline:false,indent:'\\t'\n    #     color:red;        color:red;font-size:10px   \\tcolor:red;\n    #     font-size:10px;                              \\tfont-size:10px;\n    #\n\n    _styleFromObject = (obj, options = {}) ->\n\n  Default options\n\n      _defaults options,\n        inline: true\n        indent: ''\n\n  Trailing semi should only exist on when we aren't indenting\n\n      options.semi = !options.inline\n      out = \"\"\n\n  Sort keys to create consistent output\n\n      keys = _keys(obj).sort()\n\n  Support indention and inlining\n\n      indent = options.indent ? ''\n      newline = if options.inline then '' else '\\n'\n\n      for kFancy,ix in keys\n\n  Add semi if it is not inline or it is not the last key\n\n        semi = if options.semi or ix != keys.length-1 then \";\" else ''\n\n  Allow keys to be camal case\n\n        k = _dasherize kFancy\n\n  Collect css result for this key\n\n        out += \"#{indent}#{k}:#{obj[kFancy]}#{semi}#{newline}\"\n\n      out\n\n_attributesFromObject: Convert object to attribute string\n-----------------------------------------------------------------------------\nThis object has nothing special. No renamed keys, no jquery events. It is\nprecicely what must be serialized with no adjustment.\n\n    _attributesFromObject = (obj) ->\n      # Pass through non objects\n      return obj if not oj.isObject obj\n\n      out = ''\n      # Serialize attributes in order for consistent output\n      space = ''\n      for k in _keys(obj).sort()\n        v = obj[k]\n\n        # Boolean attributes have no value\n        if (v == true)\n          out += \"#{space}#{k}\"\n\n        # Other attributes have a value\n        else\n          out += \"#{space}#{k}=\\\"#{v}\\\"\"\n\n        space = ' '\n      out\n\n_flattenCSSMap\n-----------------------------------------------------------------------------\nTake an OJ object definition of CSS and simplify it to the form:\n'@media query': 'rule': 'stylesMap'\n\nThis method is the heart of `_cssFromObject`\n\nNested definitions, media definitions and comma definitions are resolved.\n\n    _flattenCSSMap = (cssMap) ->\n      flatMap = {}\n      _flattenCSSMap_ cssMap, flatMap, [''], ['']\n      flatMap\n\n  Recursive helper with accumulators for flatMap (output)\n\n    _flattenCSSMap_ = (cssMap, flatMapAcc, selectorsAcc, mediasAcc) ->\n\n  Built in media helpers\n\n      medias =\n        'widescreen': 'only screen and (min-width: 1200px)'\n        'monitor': '' # Monitor is the default\n        'tablet': 'only screen and (min-width: 768px) and (max-width: 959px)'\n        'phone': 'only screen and (max-width: 767px)'\n\n      for selector, rules of cssMap\n\n  (1) Recursive Case: Recurse on `rules` when it is an object\n\n        if typeof rules == 'object'\n\n  (1a) Media Query found: Generate the next media queries\n\n          if selector.indexOf('@media') == 0\n\n            selectorsNext = selectorsAcc\n            selector = (selector.slice '@media'.length).trim()\n\n  Media queries can be comma seperated\n\n            mediaParts = _splitAndTrim selector, ','\n\n  Substitute convience media query methods\n\n            mediaParts = oj._map mediaParts, (v) ->\n              if medias[v]? then medias[v] else v\n\n  Calculate the next media queries\n\n            mediasNext = []\n            for mediaOuter in mediasAcc\n              for mediaInner in mediaParts\n\n                mediaCur = mediaInner\n                if (mediaInner.indexOf '&') == -1 and mediaOuter != ''\n                  mediaCur = \"& and #{mediaInner}\"\n\n                mediasNext.push mediaCur.replace(\/&\/g, mediaOuter)\n\n  (1b) Selector Found: Generate the next selectors\n\n          else\n            mediasNext = mediasAcc\n\n  Selectors can be comma seperated\n\n            selectorParts = _splitAndTrim selector, ','\n\n  Generate the next selectors and substitue `&` when present\n  TODO: Refactor to use the same code as media queries\n\n            selectorsNext = []\n            for selOuter in selectorsAcc\n              for selInner in selectorParts\n\n  When `&` is not present just insert in front with a space\n\n                selCur = selInner\n                if (selInner.indexOf '&') == -1 and selOuter != ''\n                  selCur = \"& #{selInner}\"\n\n                selectorsNext.push selCur.replace(\/&\/g, selOuter)\n\n  Recurse through objects after calculating the next selectors\n\n\n          _flattenCSSMap_ rules, flatMapAcc, selectorsNext, mediasNext\n\n  (2) Base Case: Record our selector when `rules` is a value\n\n        else\n          selectorWithCommas = selectorsAcc.sort().join ','\n\n          mediaWithAnds = mediasAcc.sort().join ','\n          mediaWithAnds = \"@media \" + mediaWithAnds unless mediaWithAnds == ''\n\n  Record the rule deeply in `flatMapAcc`\n\n          _setObject flatMapAcc, mediaWithAnds, selectorWithCommas, selector, rules\n\n      return\n\n_cssFromObject:\n-----------------------------------------------------------------------------\nConvert css selectors and rules to a string\n\nSupports nested objections, comma seperated rules, and @media queries\n\ndebug:true will output newlines\n\n    _cssFromObject = (cssMap, debug = 0) ->\n\n  Deterine what output characters are needed\n\n      newline = if debug then '\\n' else ''\n      space = if debug then ' ' else ''\n      inline = !debug\n\n      flatMap = _flattenCSSMap cssMap\n\n      css = ''\n      for media, selectorMap of flatMap\n\n  Serialize media query\n\n        if media\n          media = media.replace \/,\/g, \",#{space}\"\n          css += \"#{media}#{space}{#{newline}\"\n\n        for selector,styles of selectorMap\n          indent = if debug and media then '\\t' else ''\n\n  Serialize selector\n\n          selector = selector.replace \/,\/g, \",#{newline}\"\n          css += \"#{indent}#{selector}#{space}{#{newline}\"\n\n  Serialize style rules\n\n          indentRule = if debug then indent + '\\t' else indent\n\n          rules = _styleFromObject styles, inline:inline, indent:indentRule\n          css += \"#{rules}#{indent}}#{newline}\"\n\n  End media query\n\n        if media != ''\n          css += \"}#{newline}\"\n\n      css\n\n_compileDeeper\n-----------------------------------------------------------------------------\nRecursive helper for compiling that wraps indention\n\n    _compileDeeper = (method, ojml, options) ->\n      i = options.indent\n      options.indent += '\\t'\n      method ojml, options\n      options.indent = i\n\n    # Compile ojml or any type\n    pass = ->\n    _compileAny = (ojml, options) ->\n\n      switch oj.typeOf ojml\n\n        when 'array'\n          _compileTag ojml, options\n\n        when 'jquery'\n          # TODO: Missing unit tests for the jquery case\n          options.html?.push ojml.html()\n          options.dom?.concat ojml.get()\n\n        when 'string'\n          options.html?.push ojml\n          if ojml.length > 0 and ojml[0] == '<'\n            root = document.createElement 'div'\n            root.innerHTML = ojml\n            els = root.childNodes\n            options.dom?.appendChild root\n            # for el in els\n            #   options.dom?.appendChild el\n          else\n            options.dom?.appendChild document.createTextNode ojml\n\n        when 'boolean', 'number'\n          options.html?.push \"#{ojml}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml}\"\n\n        when 'function'\n          # Wrap function call to allow full oj generation within ojml\n          _compileAny (oj ojml), options\n\n        when 'date'\n          options.html?.push \"#{ojml.toLocaleString()}\"\n          options.dom?.appendChild document.createTextNode \"#{ojml.toLocaleString()}\"\n\n        # Do nothing for 'null', 'undefined', 'object'\n        when 'null' then break\n        when 'undefined' then break\n        when 'object' then break\n\n        else\n          # OJ type\n          if oj.isOJ ojml\n            options.types?.push ojml\n            options.html?.push ojml.toHTML()\n            options.dom?.appendChild ojml.toDOM()\n            if options.css?\n              _extend options.css, ojml.toCSSMap()\n\n      return\n\n    # Supported events from jquery\n    jqueryEvents = bind:1, on:1, off:1, live:1, blur:1, change:1, click:1, dblclick:1, focus:1, focusin:1, focusout:1, hover:1, keydown:1, keypress:1, keyup:1, mousedown:1, mouseenter:1, mousemove:1, mouseout:1, mouseup:1, ready:1, resize:1, scroll:1, select:1\n\n    # Compile ojml tag (an array)\n    _compileTag = (ojml, options) ->\n\n      # Empty list compiles to nothing\n      return if ojml.length == 0\n\n      # Get tag\n      tag = ojml[0]\n      tagType = typeof tag\n\n      # Allow ojml's tag parameter to be 'table' or table or Table\n      tag = if (tagType == 'function' or tagType == 'object') and _getTagName(tag)? then _getTagName(tag) else tag\n\n      # Fail if we couldn't find a string by now\n      throw new Error('oj.compile: tag name is missing') unless oj.isString(tag) and tag.length > 0\n\n      # Create oj object if tag is capitalized\n      if _isCapitalLetter tag[0]\n        return _compileDeeper _compileAny, (new oj[tag] ojml.slice(1)), options\n\n      # Record tag\n      options.tags[tag] = true\n\n      # Get attributes (optional)\n      attributes = null\n      if oj.isObject ojml[1]\n        attributes = ojml[1]\n\n      # Remaining arguments are children of this tag\n      children = if attributes then ojml.slice 2 else ojml.slice 1\n\n      # Compile to css if requested\n      if options.css and tag == 'css'\n\n        # Extend options.css with rules\n        for selector,styles of attributes\n          options.css[selector] ?= styles\n          _extend options.css[selector], styles\n\n      # Compile to html if requested\n      if not options.ignore[tag]\n\n        events = _attributesProcessedForOJ attributes\n\n        # Add dom element with attributes\n        if options.dom and document?\n          # Create element\n          el = document.createElement tag\n\n          # Add self to parent\n          if oj.isDOMElement options.dom\n            options.dom.appendChild el\n\n          # Push ourselves on the dom stack (to handle children)\n          options.dom = el\n\n          # Set attributes in sorted order for consistency\n          if oj.isObject attributes\n            for attrName in _keys(attributes).sort()\n              attrValue = attributes[attrName]\n              # Boolean attributes have no value\n              if attrValue == true\n                att = document.createAttribute attrName\n                el.setAttributeNode att\n              else\n                el.setAttribute attrName, attrValue\n\n          # Bind events\n          _attributesBindEventsToDOM events, el\n\n        # Add tag with attributes\n        if options.html\n          attr = (_attributesFromObject attributes) ? ''\n          space = if attr == '' then '' else ' '\n          options.html.push \"<#{tag}#{space}#{attr}>\"\n\n\n      # Compile your children if necessary\n      for child in children\n        # Skip intention if there is only one child\n        if options.debug && children.length > 1\n          options.html?.push \"\\n\\t#{options.indent}\"\n        _compileDeeper _compileAny, child, options\n\n      # Skip intention if there is only one child\n      if options.debug && children.length > 1\n        options.html?.push \"\\n#{options.indent}\"\n\n      # End html tag if you have children or your tag closes\n      if not options.ignore[tag]\n        # Close tag if html\n        if options.html and (children.length > 0 or oj.tag.isClosed(tag))\n          options.html?.push \"<\/#{tag}>\"\n        # Pop ourselves if dom\n        if options.dom\n          options.dom = options.dom.parentNode\n\n      return\n\n    # Allow attributes to take style as an object\n    _attributeStyleAllowsObject = (attr) ->\n      if oj.isObject attr?.style\n        attr.style = _styleFromObject attr.style, inline:true\n      return\n\n    # Allow attributes to alias c to class and use arrays instead of space seperated strings\n    _attributeCMeansClassAndAllowsArrays = (attr) ->\n      # Convert to c and class from arrays to strings\n      if oj.isArray(attr?.c)\n        attr.c = attr.c.join ' '\n      if oj.isArray(attr?.class)\n        attr.class = attr.class.join ' '\n\n      # Move c to class\n      if attr?.c?\n        if attr?.class?\n          attr.class += ' ' + attr.c\n        else\n          attr.class = attr.c\n        delete attr.c\n      return\n\n    # Allow attributes to take class as an array of strings\n    _attributeClassAllowsArrays = (attr) ->\n      if oj.isArray attr?.class\n        attr.class = attr.join ' '\n      return\n\n    # Omit falsy values except for zero\n    _attributeOmitFalsyValues = (attr) ->\n      if oj.isObject attr\n        # Filter out falsy except for 0\n        for k,v of attr\n          delete attr[k] if v == null or v == undefined or v == false\n\n    # Filter out jquery events\n    _attributesFilterOutEvents = (attr) ->\n      out = {}\n      if oj.isObject attr\n        # Filter out attributes that are jqueryEvents\n        for k,v of attr\n          # If this attribute (k) is an event\n          if jqueryEvents[k]?\n            out[k] = v\n            delete attr[k]\n      out\n\n    # All the OJ magic for attributes\n    _attributesProcessedForOJ = (attr) ->\n\n      # Alias c to class\n      _attributeCMeansClassAndAllowsArrays attr\n\n      # style takes objects\n      _attributeStyleAllowsObject attr\n\n      # Omit keys that false, null, or undefined\n      _attributeOmitFalsyValues attr\n\n      # TODO: Consider jsoning anything that isn't a string\n      # any keys that aren't strings are jsoned\n      # _attributesJSONAllKeys attributes\n\n      # Filter out jquery events\n      events = _attributesFilterOutEvents attr\n\n      # Returns bindable events\n      events\n\n    # Bind events to dom\n    _attributesBindEventsToDOM = (events, el) ->\n      for ek, ev of events\n        if $?\n          if oj.isArray ev\n            $(el)[ek].apply @, ev\n          else\n            $(el)[ek](ev)\n        else\n          console.error \"oj: jquery is missing when binding a '#{ek}' event\"\n\n    # oj.toHTML\n    # ------------------------------------------------------------------------------\n    # Make oj directly to HTML. It will ignore all event bindings\n\n    oj.toHTML = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options,\n        dom: false\n        js: false\n        html: true\n        css: false\n\n      (oj.compile options, ojml).html\n\n    # oj.toCSS\n    # ------------------------------------------------------------------------------\n    # Make oj directly to css. It will ignore all event bindings and html\n\n    oj.toCSS = (options, ojml) ->\n      # Options is optional\n      if not oj.isObject options\n        ojml = options\n        options = {}\n\n      # Create html only\n      _extend options,\n        dom: false\n        js: false\n        html: false\n        css: true\n\n      (oj.compile options, ojml).css\n\n    # _inherit\n    # ------------------------------------------------------------------------------\n    # Based on, but sadly incompatable with, coffeescript inheritance\n    _inherit = (child, parent) ->\n\n      # Copy class properties and methods\n      for key of parent\n        oj.copyProperty child, parent, key\n\n      ctor = ->\n      ctor:: = parent::\n      child:: = new ctor()\n\n      # Provide easy access for base class methods\n      # Example: Parent.base.methodName(arguments...)\n      child.base = parent::\n\n      return\n\n    # oj.argumentShift\n    # ------------------------------------------------------------------------------\n    # Helper to make argument handling easier\n\n    oj.argumentShift = (args, key) ->\n      if (oj.isObject args) and key? and args[key]?\n        value = args[key]\n        delete args[key]\n      value\n\noj.createType\n------------------------------------------------------------------------------\n\n    oj.createType = (name, args = {}) ->\n      throw 'oj.createType: string expected for first argument' unless oj.isString name\n      throw 'oj.createType: object expected for second argument' unless oj.isObject args\n\n      args.methods ?= {}\n      args.properties ?= {}\n\n      # When auto newing you need to delay construct the properties\n      # or they will be constructed twice.\n      delay = '__DELAYED__'\n      Out = new Function(\"\"\"return function #{name}(){\n        var _this = this;\n        if ( !(this instanceof #{name}) ) {\n          _this = new #{name}('#{delay}');\n          _this.__autonew__ = true;\n        }\n\n        if (arguments && arguments[0] != '#{delay}')\n          #{name}.prototype.constructor.apply(_this, arguments);\n\n        return _this;\n      }\n      \"\"\"\n      )();\n\n      # Default the constructor to call its base\n      if args.base? and ((not args.constructor?) or (not args.hasOwnProperty('constructor')))\n        args.constructor = ->\n          Out.base?.constructor.apply @, arguments\n\n      # Inherit if necessary\n      if args.base?\n        _inherit Out, args.base\n\n      # Add the constructor as a method\n      oj.addMethod Out::, 'constructor', args.constructor\n\n      # Mark new type and its instances with a non-enumerable type and isOJ properties\n      typeProps =\n        type: {value:Out, writable:false, enumerable:false}\n        typeName: {value:name, writable:false, enumerable:false}\n        isOJ: {value:true, writable:false, enumerable:false}\n      oj.addProperties Out, typeProps\n      oj.addProperties Out::, typeProps\n\n      # Add properties helper to instance\n      propKeys = (_keys args.properties).sort()\n      if Out::properties?\n        propKeys = _uniqueSortedUnion Out::properties, propKeys\n      properties = value:propKeys, writable:false, enumerable:false\n      # propKeys.has = _reduce propKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'properties', properties\n\n      # Add methods helper to instance\n      methodKeys = (_keys args.methods).sort()\n      if Out::methods?\n        methodKeys = _uniqueSortedUnion Out::methods, methodKeys\n      methods = value:methodKeys, writable:false, enumerable:false\n      # methodKeys.has = _reduce methodKeys, ((o,item) -> o[item.key] = true; o), {}\n      oj.addProperty Out::, 'methods', methods\n\n      # Add methods to the type\n      _extend args.methods,\n\n        # get: Get all properties, or get a single property\n        get: (k) ->\n          if oj.isString k\n            if @has k\n              return @[k]\n            else\n              return undefined\n          else\n            out = {}\n            for p in @properties\n              out[p] = @[p]\n            out\n\n        # set: Set all properties on the object at once\n        set: (k,v) ->\n          obj = k\n          # Optionally take key, value instead of object\n          if not oj.isObject k\n            obj = {}\n            obj[k] = v;\n\n          # Set all keys that are valid properties\n          for key,value of obj\n            if @has key\n              @[key] = value\n          return\n\n        # has: Determine if property exists\n        # TODO: Make this O(1)\n        has: (k) ->\n          _some @properties, (v) -> v == k\n\n        # can: Determine if method exists\n        # TODO: Make this O(1)\n        can: (k) ->\n          _some @methods, (v) -> v == k\n\n        # toJSON: Use properties to generate json\n        toJSON: ->\n          json = {}\n          for prop in @properties\n            json[prop] = @[prop]\n          json\n\n      # Add methods\n      oj.addMethods Out::, args.methods\n\n      # Add the properties\n      oj.addProperties Out::, args.properties\n\n      Out\n\n    # argumentsUnion:\n    # Take arguments and tranform them into options and args.\n    # options is a union of all items in `arguments` that are objects\n    # args is a concat of all arguments that aren't objects in the same order\n    oj.argumentsUnion = (argList) ->\n      obj = {}\n      list = []\n      for v in argList\n        if oj.isObject v\n          obj = _extend obj, v\n        else\n          list.push v\n      options: obj, args: list\n\noj.enum\n------------------------------------------------------------------------\n\n    oj.enum = (name, args) ->\n      throw 'NYI'\n\noj.View\n------------------------------------------------------------------------------\n\n    oj.View = oj.createType 'View',\n\n      # Views are special objects map properties together. This is a union of arguments\n      # With the remaining arguments becoming a list\n\n      constructor: (options = {}) ->\n        # console.log \"View.constructor: \", JSON.stringify arguments\n\n        throw new Error(\"oj.#{@typeName}: constructor failed to set this.el\") unless oj.isDOM @el\n\n        # Set instance on @el\n        _setInstanceOnElement @el, @\n\n        # Emit as a tag if new wasn't called\n        @emit() if @.__autonew__\n\n        # Generate id if missing\n        options.id ?= oj.id()\n\n        # Add class oj-typeName\n        @$el.addClass \"oj-#{@typeName}\"\n\n        # Views automatically set all options to their properties\n        # arguments directly to properties\n        @set options\n\n        # Remove options that were set\n        options = _omit options, @properties...\n\n        # Views pass through remaining options to be attributes on the root element\n        # This can include jquery events and interpreted arguments\n        @addAttributes options\n\n        # Record if view is fully constructed\n        @_isConstructed = true\n\n      properties:\n\n        # The element backing the View\n        el:\n          get: -> @_el\n          set: (v) ->\n            # Set the element directly if this is a dom element\n            if oj.isDOMElement v\n              @_el = v\n              # Clear cache of $el\n              @_$el = null\n            # Generate the element from ojml\n            else\n              {dom:@_el, cssMap:@cssMap} = oj.compile css:0, cssMap:1, dom:1, html:0, v\n            return\n\n        # Get and cache jquery-enabled element (readonly)\n        $el: get: -> @_$el ? (@_$el = $ @el)\n\n        # Get all attributes (readonly)\n        attributes: get: ->\n          out = {}\n          $.each @el.attributes, (index, attr) -> out[ attr.name ] = attr.value;\n          out\n\n        # Get and set id of view from attribute\n        id:\n          get: -> @$el.attr 'id'\n          set: (v) -> @$el.attr 'id', v\n\n        # CSS generated for this instance\n        cssMap:\n          get: -> @_cssMap ? {}\n          set: (v) ->\n            @_cssMap = v\n\n        # Determine if this view has been fully constructed (readonly)\n        isConstructed: get: -> @_isConstructed ? false\n\n        # Determine if this view has been fully inserted (readonly)\n        isInserted:\n          get: -> @_isInserted ? false\n\n      methods:\n\n        # Mirror backbone view's find by selector\n        $: -> @$el.find arguments...\n\n        # Add a single attribute\n        addAttribute: (name,value) ->\n          attr = {}\n          attr[name] = value\n          @addAttributes attr\n\n        # Add attributes and apply the oj magic with jquery binding\n        addAttributes: (attributes) ->\n          attr = _clone attributes\n\n          events = _attributesProcessedForOJ attr\n\n          # Add attributes as object\n          if oj.isObject attr\n            for k,v of attr\n\n              # Wrap k in quotes if it has whitespace\n              if k == 'class'\n                @$el.addClass v\n\n              # Boolean attributes have no value\n              else if v == true\n                att = document.createAttribute k\n                @el.setAttributeNode att\n\n              # Otherwise add it normally\n              else\n                @$el.attr k, v\n\n          # Bind events\n          if events?\n            _attributesBindEventsToDOM events, @el\n          return\n\n        # Remove a single attribute\n        removeAttribute: (name) ->\n          @$el.removeAttr name\n          return\n\n        # Remove multiple attributes\n        removeAttributes: (list) ->\n          for k in list\n            @removeAttribute k\n          return\n\n        # emit: Emit instance as a tag function would do\n        emit: -> oj._argumentsAppend @; return\n\n        # Convert View to html\n        toHTML: (options) ->\n          @el.outerHTML + (if options?.debug then '\\n' else '')\n\n        # Convert View to dom (for compiling)\n        toDOM: -> @el\n\n        # Convert\n        toCSS: (debug) -> _cssFromObject @cssMap, debug\n\n        # Convert\n        toCSSMap: -> @cssMap\n\n        # Convert View to string (for debugging)\n        toString: -> @toHTML()\n\n        # # Detach element from dom\n        # detach: -> throw 'detach nyi'\n        #   # The implementation is to set el manipulate it, and remember how to set it back\n\n        # # Attach element to dom where it use to be\n        # attach: -> throw 'attach nyi'\n        #   # The implementation is to unset el from detach\n\n        # inserted is called the instance is inserted in the dom (override)\n        inserted: ->\n          @_isInserted = true\n\n    oj.View.css = (def) ->\n      oj.View.styles.push _setObject {}, \".oj-#{@typeName}\", def\n      return\n\n    oj.View.theme = (name, def) ->\n      def = _setObject {}, \".oj-#{@typeName}.theme-#{_dasherize name}\", def\n      @type.themes.push _setObject {}, (_dasherize name), def\n      @type.styles.push def\n      return\n\n    oj.View.styles = []\n    oj.View.themes = []\n\noj.CollectionView\n------------------------------------------------------------------------------\n\n    oj.CollectionView = oj.createType 'CollectionView',\n      base: oj.View\n\n      constructor: (options) ->\n        # console.log \"CollectionView constructor: \", arguments\n\n        @each = oj.argumentShift options, 'each' if options?.each?\n        @models = oj.argumentShift options, 'models' if options?.models?\n\n        oj.CollectionView.base.constructor.apply @, arguments\n\n        # Once everything is constructed call make precisely once.\n        @make()\n\n      properties:\n\n        each:\n          get: -> @_each\n          set: (v) ->\n            @_each = v;\n            @make() if @isConstructed\n            return\n\n        models:\n          get: -> @_models\n          set: (v) ->\n            # Unbind events if collection\n            if oj.isFunction @_models?.off\n              @_models.off 'add remove change reset destroy', null, @\n\n            @_models = v\n\n            # Bind events if collection\n            if oj.isFunction @_models?.on\n              @_models.on 'add', @collectionAdded, @\n              @_models.on 'remove', @collectionRemoved, @\n              @_models.on 'change', @collectionChanged, @\n              @_models.on 'reset', @collectionReset, @\n              @_models.on 'destroy', @collectionDestroyed, @\n\n            @make() if @isConstructed\n\n            return\n\n      methods:\n        # Override make to create your view\n        make: -> throw new Error(\"oj.#{@typeName}: `make` method not implemented by custom view\")\n\n        # Override these events to minimally update on change\n        collectionAdded: (model, collection) -> @make()\n        collectionRemoved: (model, collection, options) -> @make()\n        collectionReset: (collection, options) -> @make()\n        collectionChanged: (model, collection, options) -> # Do nothing\n        collectionDestroyed: (collection, options) -> @make()\n\noj.ModelView\n------------------------------------------------------------------------------\nModel view base class\n\n    oj.ModelView = oj.createType 'ModelView',\n      base: oj.View\n\n      constructor: (options) ->\n\n        @value = oj.argumentShift options, 'value' if options?.value?\n        @model = oj.argumentShift options, 'model' if options?.model?\n\n        oj.ModelView.base.constructor.apply @, arguments\n\n      properties:\n\n        model:\n          get: -> @_model\n          set: (v) ->\n            # Unbind events on the old model\n            if oj.isEvent @_model\n              @_model.off 'change', null, @\n\n            @_model = v;\n\n            # Bind events on the new model\n            if oj.isEvent @_model\n              @_model.on 'change', @modelChanged, @\n\n            # Trigger change manually when settings new model\n            @modelChanged()\n            return\n\n      methods:\n\n        # Override modelChanged if you don't want a full remake\n        modelChanged: ->\n          @$el.oj =>\n            @make @mode\n\n        make: (model) -> throw \"oj.#{@typeName}: `make` method not implemented on custom view\"\n\noj.ModelKeyView\n------------------------------------------------------------------------------\nModel key view base class\n\n    oj.ModelKeyView = oj.createType 'ModelKeyView',\n      # Inherit ModelView to handle model and bindings\n      base: oj.ModelView\n\n      constructor: (options) ->\n        # console.log \"ModelKeyView.constructor: \", JSON.stringify arguments\n        @key = oj.argumentShift options, 'key' if options?.key?\n\n        # Call super to bind model and value\n        oj.ModelKeyView.base.constructor.apply @, arguments\n\n      properties:\n        # Key used to access model\n        key: null\n\n        # Value directly gets and sets to the dom\n        # when it changes it must trigger viewChanged\n        value:\n          get: -> throw \"#{@typeName} value getter not implemented\"\n          set: (v) -> throw \"#{@typeName} value setter not implemented\"\n\n      methods:\n        # When the model changes update the value\n        modelChanged: ->\n          if @model? and @key?\n            # Update the view if necessary\n            if not @_viewUpdatedModel\n              @value = @model.get @key\n          return\n\n        # When the view changes update the model\n        viewChanged: ->\n          # Delay view changes because many of them hook before controls update\n          setTimeout (=>\n            if @model? and @key?\n              # Ensure view changes aren't triggered twice\n              @_viewUpdatedModel = true\n              @model.set @key, @value\n              @_viewUpdatedModel = false\n            return\n            ), 10\n          return\n\noj.TextBox\n------------------------------------------------------------------------------\nTextBox control\n\n    oj.TextBox = oj.createType 'TextBox',\n\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'text',\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        # Set live if it exists\n        @live = oj.argumentShift options, 'live' if options?.live?\n\n        oj.TextBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: ->\n            v = @el.value\n            v = '' if not v? or v == 'undefined'\n            v\n          set: (v) ->\n            @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.CheckBox\n------------------------------------------------------------------------------\nCheckBox control\n\n    oj.CheckBox = oj.createType 'CheckBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.input type:'checkbox',\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.CheckBox.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.checked\n          set: (v) ->\n            v = !!v\n            @el.checked = v\n            if v\n              @$el.attr 'checked', 'checked'\n            else\n              @$el.removeAttr 'checked'\n            return\n\noj.TextArea\n------------------------------------------------------------------------------\nTextArea control\n\n    oj.TextArea = oj.createType 'TextArea',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.textarea\n            keydown: => if @live then @viewChanged(); return\n            keyup: => if @live then @viewChanged(); return\n            change: => @viewChanged(); return\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.TextArea.base.constructor.call @, options\n\n      properties:\n        value:\n          get: -> @el.value\n          set: (v) -> @el.value = v; return\n\n        # Live update model as text changes\n        live: true\n\noj.ListBox\n------------------------------------------------------------------------------\nListBox control\n\n    oj.ListBox = oj.createType 'ListBox',\n      base: oj.ModelKeyView\n\n      constructor: ->\n        {options, args} = oj.argumentsUnion arguments\n\n        @el = oj =>\n          oj.select change: => @viewChanged(); return\n\n        # @options is a list of elements\n        @options = oj.argumentShift options, 'options'\n\n        # Value can be set by argument\n        @value = args[0] if args.length > 0\n\n        oj.ListBox.base.constructor.apply @, [options]\n\n      properties:\n        value:\n          get: -> @$el.val()\n          set: (v) -> @$el.val(v); return\n\n        options:\n          get: -> @_options\n          set: (v) ->\n            throw new Error(\"oj.#{@typeName}.options array is missing\") unless oj.isArray v\n            @_options = v\n            @$el.oj ->\n              for op in v\n                oj.option op\n              return\n            return\n\noj.Button\n------------------------------------------------------------------------------\nButton control\n\n    oj.Button = oj.createType 'Button',\n      base: oj.View\n\n      constructor: (args) ->\n        {options, args} = oj.argumentsUnion arguments\n\n        # Label is first argument\n        options.label ?= if args.length > 0 then args[0] else ''\n\n        @el = oj =>\n          oj.button options.label\n\n        oj.Button.base.constructor.apply @, [options]\n\noj.Link\n------------------------------------------------------------------------------\noj.Link = class Link inherits Control\n\noj.List\n------------------------------------------------------------------------------\nList control with model bindings and live editing\n\n    oj.List = oj.createType 'List',\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"List constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # tagName is write-once\n        @_tagName = oj.argumentShift options, 'tagName'\n\n        @itemTagName = oj.argumentShift options, 'itemTagName'\n\n        # Generate el\n        @el = oj =>\n          oj[@tagName]()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model) ->\n          if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            model\n          else\n            JSON.stringify model\n\n        # Args have been handled so don't pass them on\n        oj.List.base.constructor.apply @, [options]\n\n        # Set @items to options or args if they exist\n        items = if args.length > 0 then args else null\n        @items = if options.items? then (oj.argumentShift options, 'items') else items\n\n### Properties\n\n      properties:\n\nitems: get or set all items at once (readwrite)\n\n        items:\n          get: ->\n\n  Used cached items or items as interpreted by ojValues jquery plugin\n\n            return @_items if @_items?\n            v = @$items.ojValues()\n\n          set: (v) -> @_items = v; @make(); return\n\n        count: get: -> @$items.length\n\ntagName: name of root tag (writeonce)\n\n        tagName: get: -> @_tagName ? 'div'\n\nitemTagName: name of item tags (readwrite)\n\n        itemTagName:\n          get: -> @_itemTagName ? 'div'\n          set: (v) -> @_itemTagName = v; @make(); return\n\n$items: list of `<li>` elements (readonly)\n\n        $items: get: -> @_$items ? (@_$items = @$(\"> #{@itemTagName}\"))\n\n### Methods\n\n      methods:\n\n#### Accessor Methods\n\nitem: get or set item value at item ix\n\n        item: (ix, ojml) ->\n          ix = @_bound ix, @count, \".item: index\"\n          if ojml?\n            @$item(ix).oj ojml\n            return\n          else\n            @$item(ix).ojValue()\n\n$item: `<li>` element for a given item ix. The tag name may change.\n\n        $item: (ix) ->\n          ix = @_bound ix, @count, \".$item: index\"\n          @$items.eq(ix)\n\n#### CollectionView Methods\n\nmake: Remake view from property data\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          views = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @models\n            for model in models\n              views.push @_itemFromModel model\n\n  Items are already views\n\n          else if @items?\n            views = @items\n\n  Render the views\n\n          @$el.oj =>\n            for view in views\n              @_itemElFromItem view\n\n          @itemsChanged()\n          return\n\n#### CollectionView Events\n\ncollectionAdded: Model add occurred, add the item\n\n        collectionAdded: (m, c) ->\n          ix = c.indexOf m\n          item = @_itemFromModel m\n          @add ix, item\n          return\n\ncollectionRemoved: Model remove occured, delete the item\n\n        collectionRemoved: (m, c, o) ->\n          @remove o.index\n          return\n\ncollectionRemoved: On add\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Helper Methods\n\n  _itemFromModel: Helper to map model to item\n\n        _itemFromModel: (model) ->\n          oj =>\n            @each model\n\n  _itemElFromItem: Helper to create itemTagName wrapped item\n\n        _itemElFromItem: (item) ->\n          oj[@itemTagName] item\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix,count,message,@typeName\n\n#### Events\n\nitemsChanged: Model changed occured, clear relevant cached values\n\n        itemsChanged: -> @_items = null; @_$items = null; return\n\n#### Manipulation Methods\n\n        add: (ix, ojml) ->\n\n          ix = @_bound ix, @count+1, \".add: index\"\n\n          tag = @itemTagName\n          # Empty\n          if @count == 0\n            @$el.oj -> oj[tag] ojml\n          # Last\n          else if ix == @count\n            @$item(ix-1).ojAfter -> oj[tag] ojml\n          # Not last\n          else\n            @$item(ix).ojBefore -> oj[tag] ojml\n\n          @itemsChanged()\n          return\n\n        remove: (ix) ->\n          ix = @_bound ix, @count, \".remove: index\"\n          out = @item ix\n          @$item(ix).remove()\n          @itemsChanged()\n          out\n\n        move: (ixFrom, ixTo = -1) ->\n          return if ixFrom == ixTo\n\n          ixFrom = @_bound ixFrom, @count, \".move: fromIndex\"\n          ixTo = @_bound ixTo, @count, \".move: toIndex\"\n\n          if ixTo > ixFrom\n            @$item(ixFrom).insertAfter @$item(ixTo)\n          else\n            @$item(ixFrom).insertBefore @$item(ixTo)\n\n          @itemsChanged()\n          return\n\n        swap: (ix1, ix2) ->\n          return if ix1 == ix2\n\n          ix1 = @_bound ix1, @count, \".swap: firstIndex\"\n          ix2 = @_bound ix2, @count, \".swap: secondIndex\"\n\n          if Math.abs(ix1-ix2) == 1\n            @move ix1, ix2\n          else\n            ixMin = Math.min ix1, ix2\n            ixMax = Math.max ix1, ix2\n            @move ixMax, ixMin\n            @move ixMin+1, ixMax\n          @itemsChanged()\n          return\n\n        unshift: (v) -> @add 0, v; return\n\n        shift: -> @remove 0\n\n        push: (v) -> @add(@count, v); return\n\n        pop: -> @remove -1\n\n        clear: -> @$items.remove(); @itemsChanged(); return\n\noj.NumberList\n------------------------------------------------------------------------------\nNumberList is a `List` specialized with `<ol>` and `<li>` tags\n\n    oj.NumberList = oj.createType 'NumberList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ol', itemTagName:'li'}, arguments...]\n        oj.NumberList.base.constructor.apply @, args\n\noj.BulletList\n------------------------------------------------------------------------------\nBulletList is a `List` specialized with `<ul>` and `<li>` tags\n\n    oj.BulletList = oj.createType 'BulletList',\n      base: oj.List\n      constructor: ->\n        args = [{tagName:'ul', itemTagName:'li'}, arguments...]\n        oj.BulletList.base.constructor.apply @, args\n\noj.Table\n------------------------------------------------------------------------------\nTable control\n\n    oj.Table = oj.createType 'Table',\n\nInherit and construct\n\n      base: oj.CollectionView\n\n      constructor: ->\n        # console.log \"Table constructor: \", arguments\n        {options, args} = oj.argumentsUnion arguments\n\n        # Generate el\n        @el = oj =>\n          oj.table()\n\n        # Use el if it was passed in\n        @el = oj.argumentShift(options, 'el') if options.el?\n\n        # Default @each function to pass through values\n        options.each ?= (model,cell) ->\n          values = if (oj.isString model) or (oj.isNumber model) or (oj.isBoolean model)\n            [model]\n          else if (oj.isEvent model) and typeof model.attributes == 'object'\n            _values model.attributes\n          else\n            _values model\n          cell v for v in values\n\n        # Args have been handled so don't pass them on\n        oj.Table.base.constructor.apply @, [options]\n\n        # Validate args as arrays\n        for arg in args\n          unless oj.isArray arg\n            throw new Error 'oj.Table: array expected for row arguments'\n\n        # Set @rows to options or args if they exist\n        rows = (oj.argumentShift options, 'rows') ? args\n\n        if rows.length > 0\n          @rows = rows\n\n### Properties\n\n      properties:\n\nrowCount: The number of rows (readonly)\n\n        rowCount: get: -> @$trs.length\n\ncolumnCount: The number of columns (readonly)\n\n        columnCount: get: ->\n          if (trlen = @$tr(0).find('> td').length) > 0\n            trlen\n          else if (thlen = @$theadTR.find('> th').length) > 0\n            thlen\n          else if (tflen = @$tfootTR.find('> td').length) > 0\n            tflen\n          else\n            0\n\n#### Accessor properties\n\nrows: Row values as a list of lists as interpreted by ojValue plugin (readwrite)\n\n        rows:\n          get: ->\n            return @_rows if @_rows?\n            @_rows = []\n            for rx in [0...@rowCount] by 1\n              r = oj._map (@$tdsRow rx), ($td) -> $td.ojValues()\n              @_rows.push r\n            @_rows\n\n          set: (list) ->\n            return @clearBody() unless list? and list.length > 0\n            @_rows = list; @make(); return\n\nheader: Array of header values as interpreted by ojValue plugin (readwrite)\n\n        header:\n          get: ->\n            @$theadTR.find('> th').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.header: array expected for first argument') unless oj.isArray list\n            return @clearHeader() unless list? and list.length > 0\n            @$theadTRMake.oj =>\n              for ojml in list\n                oj.th ojml\n\nfooter: Array of footer values as interpreted by ojValue plugin (readwrite)\n\n        footer:\n          get: ->\n            @$tfootTR.find('> td').ojValues()\n          set: (list) ->\n            throw new Error('oj.Table.footer: array expected for first argument') unless oj.isArray list\n            return @clearFooter() unless list? and list.length > 0\n            @$tfootTRMake.oj =>\n              for ojml in list\n                oj.td ojml\n\ncaption: The table caption (readwrite)\n\n        caption:\n          get: -> @$caption.ojValue()\n          set: (v) -> @$captionMake.oj v; return\n\nElement accessors\n\n        $table: get: -> @$el\n\n        $caption: get: -> @$ '> caption'\n\n        $colgroup: get: -> @$ '> colgroup'\n\n        $thead: get: -> @$ '> thead'\n\n        $tfoot: get: -> @$ '> tfoot'\n\n        $tbody: get: -> @$ '> tbody'\n\n        $theadTR: get: -> @$thead.find '> tr'\n\n        $tfootTR: get: -> @$tfoot.find '> tr'\n\n        $ths: get: -> @$theadTR.find '> th'\n\n        $trs: get: -> @_$trs ? (@_$trs = @$(\"> tbody > tr\"))\n\nTable tags must have an order: `<caption>` `<colgroup>` `<thead>` `<tfoot>` `<tbody>`\nThese accessors create table tags and preserve this order very carefully\n\n$colgroupMake: get or create `<colgroup>` after `<caption>` or prepended to `<table>`\n\n        $colgroupMake: get: ->\n          return @$colgroup if @$colgroup.length > 0\n          t = '<colgroup><\/colgroup>'\n          if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.append t\n          @$tbody\n\n$captionMake: get or create `<caption>` prepended to `<table>`\n\n        $captionMake: get: ->\n          return @$caption if @$caption.length > 0\n          @$table.prepend '<caption><\/caption>'\n          @$caption\n\n$tfootMake: get or create `<tfoot>` before `<tbody>` or appended to `<table>`\n\n        $tfootMake: get: ->\n          return @$tfoot if @$tfoot.length > 0\n          t = '<tfoot><\/tfoot>'\n          if @$tfoot.length > 0\n            @$tfoot.insertBefore t\n          else\n            @$table.append t\n\n          @$tfoot\n\n$theadMake: get or create `<thead>` after `<colgroup>` or after `<caption>`, or prepended to `<table>`\n\n        $theadMake: get: ->\n          return @$thead if @$thead.length > 0\n          t = '<thead><\/thead>'\n          if @$colgroup.length > 0\n            @$colgroup.insertAfter t\n          else if @$caption.length > 0\n            @$caption.insertAfter t\n          else\n            @$table.prepend t\n\n          @$thead\n\n$tbodyMake: get or create `<tbody>` appened to `<table>`\n\n        $tbodyMake: get: ->\n          return @$tbody if @$tbody.length > 0\n          @$table.append '<tbody><\/tbody>'\n          @$tbody\n\n$theadTRMake: get or create `<tr>` inside of `<thead>`\n\n        $theadTRMake: get: ->\n          return @$theadTR if @$theadTR.length > 0\n          @$theadMake.html '<tr><\/tr>'\n          @$theadTR\n\n$tfootTRMake: get or create `<tr>` inside of `<tfoot>`\n\n        $tfootTRMake: get: ->\n          return @$tfootTR if @$tfootTR.length > 0\n          @$tfootMake.html '<tr><\/tr>'\n          @$tfootTR\n\n### Methods\n\n      methods:\n\n#### CollectionView Methods\n\nmake: Remake everything\n\n        make: ->\n\n  Some properties call make before construction completes\n\n          return unless @isConstructed\n\n  Convert models to views\n\n          rowViews = []\n          if @models? and @each?\n            models = if oj.isEvent @models then @models.models else @_models\n            for model in models\n              rowViews.push @_rowFromModel model\n\n  Rows need tds to become views\n\n          else if @rows?\n            for row in @rows\n              rowViews.push oj ->\n                for c in row\n                  oj.td c\n\n  Render rows into tbody\n\n          if rowViews.length > 0\n            @$tbodyMake.oj =>\n              for r in rowViews\n                oj.tr r\n\n          @bodyChanged()\n          return\n\n#### CollectionView Events\n\n        # On add minimally create the missing model\n        collectionAdded: (m, c) ->\n          rx = c.indexOf m\n          row = @_rowFromModel m\n          @_addRowTR rx, oj -> oj.tr row\n          return\n\n        # On add minimally create the missing model\n        collectionRemoved: (m, c, o) ->\n          @removeRow o.index\n          return\n\n        collectionReset: ->\n          @make()\n          return\n\n#### Accessor Methods\n\ntable.header(r,ojml)    \/\/ value for header\ntable.cell(r,c,ojml)    \/\/ get\/set value for cell\n\n$tr: Get `<tr>` jquery element at row rx\n\n        $tr: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$trs.eq(rx)\n\n$tdsRow: Get list of `<td>`s in row rx\n\n        $tdsRow: (rx) ->\n          rx = if rx < 0 then rx + count else rx\n          @$tr(rx).find '> td'\n\n$td: Get `<td>` row rx, column cx\n\n        $td: (rx,cx) ->\n          rx = if rx < 0 then rx + @rowCount else rx\n          cx = if cx < 0 then cx + @columnCount else cx\n          @$tdsRow(rx).eq(cx)\n\nrow: Get values at a given row\n\n        row: (rx, listOJML) ->\n          rx = @_bound rx, @rowCount, \".row: rx\"\n          if listOJML?\n            throw new Error(\"oj.#{@typeName}: array expected for second argument with length length cellCount(#{rx})\") unless listOJML.length == cellCount(rx)\n            for ojml,cx in listOJML\n              @$td(rx,cx).oj ojml\n            return\n          else\n            @$tdsRow(rx).ojValues()\n\ncell: Get or set value at row rx, column cx\n\n        cell: (rx, cx, ojml) ->\n          if ojml?\n            @$td(rx, cx).oj ojml\n          else\n            @td(rx, cx).ojValue()\n\n#### Manipulation Methods\n\n\naddRow: Add row to index rx\n\n        addRow: (rx, listOJML) ->\n          throw new Error('oj.addRow: expected two arguments') unless arguments.length == 2\n\n          rx = @_bound rx, @rowCount+1, \".addRow: rx\"\n\n          tr =\n            ->\n              oj.tr ->\n                for o in listOJML\n                  oj.td o\n\n          @_addRowTR rx, tr\n          return\n\n_addRowTR: Helper to add row directly with `<tr>`\n\n        _addRowTR: (rx, tr) ->\n\n          # Empty\n          if @rowCount == 0\n            @$el.oj tr\n\n          # Last\n          else if rx == @rowCount\n            @$tr(rx-1).ojAfter tr\n\n          # Not last\n          else\n            @$tr(rx).ojBefore tr\n\n          @bodyChanged()\n          return\n\nremoveRow: Remove row at index rx (defaults to end)\n\n        removeRow: (rx) ->\n          throw new Error('oj.removeRow: expected one argument') unless arguments.length == 1\n\n          rx = @_bound rx, @rowCount, \".removeRow: index\"\n          out = @row rx\n          @$tr(rx).remove()\n          @bodyChanged()\n          out\n\nmoveRow: Move row at index rx (defaults to end)\n\n        moveRow: (rxFrom, rxTo) ->\n          return if rxFrom == rxTo\n\n          rxFrom = @_bound rxFrom, @rowCount, \".moveRow: fromIndex\"\n          rxTo = @_bound rxTo, @rowCount, \".moveRow: toIndex\"\n\n          insert = if rxTo > rxFrom then 'insertAfter' else 'insertBefore'\n          @$tr(rxFrom)[insert] @$tr(rxTo)\n\n          @bodyChanged()\n          return\n\nswapRow: Swap row rx1 and rx2\n\n        swapRow: (rx1, rx2) ->\n          return if rx1 == rx2\n\n          rx1 = @_bound rx1, @rowCount, \".swap: firstIndex\"\n          rx2 = @_bound rx2, @rowCount, \".swap: secondIndex\"\n\n          if Math.abs(rx1-rx2) == 1\n            @moveRow rx1, rx2\n          else\n            rxMin = Math.min rx1, rx2\n            rxMax = Math.max rx1, rx2\n            @moveRow rxMax, rxMin\n            @moveRow rxMin+1, rxMax\n          @bodyChanged()\n          return\n\n        unshiftRow: (v) -> @addRow(0, v); return\n        shiftRow: -> @removeRow 0\n        pushRow: (v) -> @addRow(@rowCount, v); return\n        popRow: -> @removeRow -1\n\n        clearColgroup: -> @$colgroup.remove(); return\n\n        clearBody: -> console.log \"clearing body: oj.litcoffee:2930\";@$tbody.remove(); @bodyChanged(); return\n\n        clearHeader: -> @$thead.remove(); @headerChanged(); return\n\n        clearFooter: -> @$tfoot.remove(); @footerChanged(); return\n\n        clearCaption: -> @$capation.remove(); return\n\n        clear: -> @clearBody(); @clearHeader(); @clearFooter(); @$caption.remove()\n\n#### Event Handlers\n\n        # When body changes clear relevant cached values\n        bodyChanged: -> @_rows = null; @_columns = null; @_$trs = null; return\n\n        # When header changes clear relevant cached values\n        headerChanged: -> @_header = null; return\n\n        # When footer changes clear relevant cached values\n        footerChanged: -> @_footer = null; return\n\n#### Helper Methods\n\n_rowFromModel: Helper to map model to row\n\n        _rowFromModel: (model) ->\n          oj =>\n            @each model, oj.td\n\n_rowElFromItem: Helper to create rowTagName wrapped row\n\n        _rowElFromItem: (row) ->\n          oj[@rowTagName] row\n\n  _bound: Bound index to allow negatives, throw when out of range\n\n        _bound: (ix, count, message) ->\n          _boundOrThrow ix, count, message, @typeName\n\noj.sandbox\n------------------------------------------------------------------------------\nThe sandbox is a readonly version of oj that is exposed to the user\n\n    oj.sandbox = {}\n    for key in _keys oj\n      if key.length > 0 and key[0] != '_'\n        oj.addProperty oj.sandbox, key, value:oj[key], writable:false\n\noj.use(plugin, settings)\n------------------------------------------------------------------------------\nInclude a plugin of OJ with `settings`\n\n    oj.use = (plugin, settings = {}) ->\n      throw new Error('oj.use: function expected for first argument') unless oj.isFunction plugin\n      throw new Error('oj.use: object expected for second argument') unless oj.isObject settings\n\n      # Call plugin to gather extension map\n      pluginMap = plugin oj, settings\n\n      # Extend all properties\n      for name,value of pluginMap\n        oj[name] = value\n        # Add to sandbox\n        oj.addProperty oj.sandbox, name, value:value, writable: false\n\n\n_jqueryExtend(fn)\n-----------------------------------------------------------------------------\n\noption.get is called to retrieve value per element\noption.set is called when setting elements\noption.first:true means return only the first get, otherwise it is returned as an array.\n\n    _jqueryExtend = (options = {}) ->\n      _defaults options, get:_identity, set:_identity, first: false\n      ->\n        args = _toArray arguments\n        $els = jQuery(@)\n        # Map over jquery selection if no arguments\n        if (oj.isFunction options.get) and args.length == 0\n          out = []\n          for el in $els\n            out.push options.get $(el)\n            if options.first\n              return out[0]\n          out\n\n        else if (oj.isFunction options.set)\n          # By default return this for chaining\n          out = $els\n          for el in $els\n            r = options.set $(el), args\n            # Short circuit if anything is returned\n            return r if r?\n\n          $els\n\njquery.oj\n-----------------------------------------------------------------------------\n\n    jQuery.fn.oj = _jqueryExtend\n      set:($el, args) ->\n\n        # No arguments return the first instance\n        if args.length == 0\n          return $el[0].oj\n\n        # Compile ojml\n        {dom,types} = oj.compile {dom:1,html:0,css:0}, args...\n\n        # Reset content and append to dom\n        $el.html ''\n        dom = [dom] unless oj.isArray dom\n        for d in dom\n          $el.append d\n\n        # Call inserted event on all types\n        for t in types\n          t.inserted()\n\n        return\n\n      get: ($el) ->\n        $el[0].oj\n\njquery.ojValue\n-----------------------------------------------------------------------------\nGet the first value of the selected contents\n\n    _jqGetValue = ($el, args) ->\n\n      el = $el[0]\n      child = el.firstChild\n\n      switch oj.typeOf child\n        # Parse the text to turn it into bool, number, or string\n        when 'dom-text'\n          text = oj.parse child.nodeValue\n        # Get elements as oj instances or elements\n        when 'dom-element'\n          if (inst = _getInstanceOnElement child)?\n            inst\n          else\n            child\n\n    jQuery.fn.ojValue = _jqueryExtend\n      first: true\n      set: null\n      get: _jqGetValue\n\njquery.ojValues\n-----------------------------------------------------------------------------\nGet values as an array of the selected element's contents\n\n    jQuery.fn.ojValues = _jqueryExtend\n      first: false\n      set: null\n      get: _jqGetValue\n\njquery plugins\n-----------------------------------------------------------------------------\n\n    plugins =\n      ojAfter: 'after'\n      ojBefore: 'before'\n      ojAppend: 'append'\n      ojPrepend: 'prepend'\n      ojReplaceWith: 'replaceWith'\n      ojWrap: 'wrap'\n      ojWrapInner: 'wrapInner'\n\n    for ojName,jqName of plugins\n      do (ojName, jqName) ->\n        jQuery.fn[ojName] = _jqueryExtend\n          set: ($el, args) ->\n\n            # Compile ojml for each one to separate references\n            {dom,types} = oj.compile {dom:1,html:0}, args...\n\n            # Append to the dom\n            $el[jqName] dom\n\n            for t in types\n              t.inserted()\n\n            return\n\n          get:null\n\n\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"26bd5be7401f0792943c530e34d1efbb2f9a3c5a","subject":"Add docs headings to mainb server code","message":"Add docs headings to mainb server code\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n## Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\n## Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.methodOverride())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n    app.use(raven.middleware.express(process.env.SENTRY_DNS)) if process.env.SENTRY_DNS\n\n## Error handling\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## API keys\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'DNT'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone aboyt the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        when 'PUT'  then collection.put req, res, next\n        when 'PATCH' then collection.patch req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then document.options req, res, next\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    \"use strict\"\n\n    express     = require 'express'\n    raven       = require 'raven'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n    app = express()\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\nIn future versions of the API this routine will also check the request quota and\nblocking the user if the quota is full.\n\n    app.use '\/', (req, res, next) ->\n\n      key = req.query.api_key\n\n      return res.json 403, message: 'API key missing' if not key\n      return res.json 401, message: 'API key invalid' if not apiKeys[key]\n\n      req.key = key\n      req.usr = apiKeys[key]\n\n      next()\n\nNow configure the Express server so it is ready to run.\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.methodOverride())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.enable('verbose errors')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n    app.use(raven.middleware.express(process.env.SENTRY_DNS)) if process.env.SENTRY_DNS\n\nThis is the error handler. All errors passed to `next` or exceptions ends up\nhere. We set the status code to `500` if it is not already defined in the\n`Error` object. We then print the error mesage and stack trace to the console\nfor debug purposes.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status(err.status or 500)\n\n      console.error err.message\n      console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\nThis is the dirty part. Here are all the keys to the kingdom. These will be\nmoved to the database and retrieved when the server starts. Just need to find\nthe time to do it.\n\n    apiKeys =\n      dnt: 'DNT'\n      nrk: 'DNT'\n\n      '30ad3a3a1d2c7c63102e09e6fe4bb253': 'TurApp'\n      'b523ceb5e16fb92b2a999676a87698d1': 'Pingdom'\n\n      '4c802ac2315ab24db9c992cc6eea0278': 'DNT' # ETA\n      'de2986ac75c5af9d7f92a26f37dc1b77': 'DNT' # sherpa2.api\n      '5dd5a39057cb479c3c4bce7f9eae5e6c': 'DNT' # dev.ut.no\n      '146bbe01b477e9e07e85e0ddd3f5095a': 'DNT' # beta.ut.no\n      'e6fa27292ffbcc689c49179c47bc708e': 'DNT' # prod.ut.no\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/system\n\nHsssssj!!! Don't tell anyone aboyt the secret system API endpoint!\n\n    app.get '\/system', system.info\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.get '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        when 'PUT'  then collection.put req, res, next\n        when 'PATCH' then collection.patch req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.all '\/:collection\/:objectid', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then document.options req, res, next\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: 'HTTP method not supported'\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"14f6bc83225a37d8be0215fa821b2239c2025898","subject":"Fix the next-match situation","message":"Fix the next-match situation\n","repos":"prophile\/compd-screens,prophile\/compd-screens","old_file":"src\/coffee\/managers\/next-match.litcoffee","new_file":"src\/coffee\/managers\/next-match.litcoffee","new_contents":"Next Match Manager\n==================\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe need both the next match and the list of teams as our inputs.\n\n        inputStream = Bacon.combineTemplate\n            teams: Data.teams\n            next: NextMatch\n\nList Management\n---------------\n\nWe use D3 to set the data within the list.\n\n        inputStream.onValue (state) ->\n            return unless state.next?\n\n            nodeHTML = (entry) ->\n                \"<li>#{state.teams[entry].name}<\/li>\"\n\n            DisplayInformation '.next-match-teams',\n                               state.next.teams,\n                               'li', nodeHTML\n\nTime Display\n------------\n\nWe use the next match alone for the display of its start time.\n\n    NextMatch.onValue (match) ->\n        if match?\n            $('.next-match-time').text(FormatTime(FromUNIX(match.start),\n                                                        false))\n        else\n            $('.next-match-time').text('-')\n\n","old_contents":"Next Match Manager\n==================\n\nWe first set everything in a callback, so that it is invoked only\nafter the loading of the DOM.\n\n    $ ->\n\nInput\n-----\n\nWe need both the next match and the list of teams as our inputs.\n\n        inputStream = Bacon.combineTemplate\n            teams: Data.teams\n            next: NextMatch\n\nList Management\n---------------\n\nWe use D3 to set the data within the list.\n\n        inputStream.onValue (state) ->\n            return unless state.next?\n\n            nodeHTML = (entry) ->\n                \"<li>#{state.teams[entry].name}<\/li>\"\n\n            listItems = d3.select('.next-match-teams')\n                          .selectAll('li')\n                          .data(state.next.teams)\n                          .html(nodeHTML)\n\n            listItems.enter()\n                     .append('li')\n                     .html(nodeHTML)\n\n            listItems.exit()\n                     .remove()\n\nTime Display\n------------\n\nWe use the next match alone for the display of its start time.\n\n    NextMatch.onValue (match) ->\n        if match?\n            $('.next-match-time').text(FormatTime(FromUNIX(match.start),\n                                                        false))\n        else\n            $('.next-match-time').text('-')\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"68502df469722311f6cab8e82a048e9fa7ed868b","subject":"Fixed a bug causing corruption when inverting a matrix in-place.","message":"Fixed a bug causing corruption when inverting a matrix in-place.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/matrix.litcoffee","new_file":"src\/matrix.litcoffee","new_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    tempVector = []\n    tempVectorFrom = []\n    tempVectorTo = []\n    fromTemp = []\n    toTemp = []\n    tempVectorX = []\n    tempVectorY = []\n    tempVectorZ = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output, local) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            if local\n                module.exports.multiply temp3, output, output\n            else\n                module.exports.multiply output, temp3, output\n            return\n\n    vector = require \".\/vector.litcoffee\"\n            \n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\nIf the third parameter is truthy, the rotation is applied in local rather than\nglobal space.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\nIf the third parameter is truthy, the rotation is applied in local rather than\nglobal space.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\nIf the third parameter is truthy, the rotation is applied in local rather than\nglobal space.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\n# translate\n\n- A vector to translate by.\n- A matrix to translate.\n- When truthy, the translation is applied in local space, otherwise it is \n  applied in global space.\n            \n        translate: (v, output, local) ->\n            if local\n                tempVectorX[0] = output[0]\n                tempVectorX[1] = output[1]\n                tempVectorX[2] = output[2]\n\n                tempVectorY[0] = output[4]\n                tempVectorY[1] = output[5]\n                tempVectorY[2] = output[6]\n                \n                tempVectorZ[0] = output[8]\n                tempVectorZ[1] = output[9]\n                tempVectorZ[2] = output[10]\n                \n                tempVector[0] = vector.dot tempVectorX, v\n                tempVector[1] = vector.dot tempVectorY, v\n                tempVector[2] = vector.dot tempVectorZ, v\n                module.exports.translate tempVector, output\n            else\n                output[3] += v[0]\n                output[7] += v[1]\n                output[11] += v[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \nGiven a matrix, input vector and output vector, calling the \"applyToVector\"\nproperty writes the input vector transformed by the matrix to the output vector.\n        \n        applyToVector: (matrix, input, output) ->\n            vector.copy input, tempVector\n            output[0] = tempVector[0] * matrix[0] + tempVector[1] * matrix[1] + tempVector[2] * matrix[2] + matrix[3]\n            output[1] = tempVector[0] * matrix[4] + tempVector[1] * matrix[5] + tempVector[2] * matrix[6] + matrix[7]\n            output[2] = tempVector[0] * matrix[8] + tempVector[1] * matrix[9] + tempVector[2] * matrix[10] + matrix[11]\n            return\n            \nGiven a matrix and output vector, calling the \"getTranslation\" property writes\nthe translation applied by the matrix to the output vector.\n\n        getTranslation: (matrix, output) ->\n            output[0] = matrix[3]\n            output[1] = matrix[7]\n            output[2] = matrix[11]\n\nGiven a matrix and output vector, calling the \"getX\" property writes the vector\nof the matrix's X axis (a scaled normal) to the output vector.\n\n        getX: (matrix, output) ->\n            output[0] = matrix[0]\n            output[1] = matrix[4]\n            output[2] = matrix[8]\n\nGiven a matrix and output vector, calling the \"getY\" property writes the vector\nof the matrix's Y axis (a scaled normal) to the output vector.\n\n        getY: (matrix, output) ->\n            output[0] = matrix[1]\n            output[1] = matrix[5]\n            output[2] = matrix[9]\n            \nGiven a matrix and output vector, calling the \"getZ\" property writes the vector\nof the matrix's Z axis (a scaled normal) to the output vector.\n\n        getZ: (matrix, output) ->\n            output[0] = matrix[2]\n            output[1] = matrix[6]\n            output[2] = matrix[10]\n            \n# setTranslation\n\n- A vector specifying the translation to set.\n- A matrix to set the translation of.\n\nOverwrites the translation of the matrix with the content of the given vector.\n\n        setTranslation: (output, matrix) ->\n            matrix[3] = output[0]\n            matrix[7] = output[1]\n            matrix[11] = output[2]\n\n# setX\n\n- A vector specifying the X axis vector to set.\n- A matrix to set the X axis vector of.\n\nOverwrites the X axis of the matrix with the content of the given vector.\n\n        setX: (output, matrix) ->\n            matrix[0] = output[0]\n            matrix[4] = output[1]\n            matrix[8] = output[2]\n\n# setY\n\n- A vector specifying the Y axis vector to set.\n- A matrix to set the Y axis vector of.\n\nOverwrites the Y axis of the matrix with the content of the given vector.\n\n        setY: (output, matrix) ->\n            matrix[1] = output[0]\n            matrix[5] = output[1]\n            matrix[9] = output[2]\n\n# setZ\n\n- A vector specifying the Z axis vector to set.\n- A matrix to set the Z axis vector of.\n\nOverwrites the Z axis of the matrix with the content of the given vector.\n\n        setZ: (output, matrix) ->\n            matrix[2] = output[0]\n            matrix[6] = output[1]\n            matrix[10] = output[2]\n            \n# interpolate\n\n- An input matrix to interpolate from.\n- An input matrix to interpolate to.\n- A number specifying how far along to interpolate; \"0\" is \"from\" and \"1\" is \n  \"to\".\n- An output matrix.\n\nAttempts to perform a somewhat crude interpolation between the two matrices\nwhich is not very linear.  Good enough for smoothing over small changes.\nPrioritizes the Z and Y axes over the X axis when ensuring orthogonal.\n\n        interpolate: (from, to, alpha, output) ->       \n            module.exports.copy from, fromTemp\n            module.exports.copy to, toTemp\n            module.exports.identity output\n            module.exports.getTranslation fromTemp, tempVectorFrom\n            module.exports.getTranslation toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            module.exports.setTranslation tempVector, output\n            \n            module.exports.getX fromTemp, tempVectorFrom\n            module.exports.getX toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            vector.normalize tempVector, tempVectorX, true  \n            \n            module.exports.getY fromTemp, tempVectorFrom\n            module.exports.getY toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVectorY\n            \n            vector.cross tempVectorX, tempVectorY, tempVectorZ\n            vector.normalize tempVectorZ, tempVectorZ\n            vector.cross tempVectorZ, tempVectorX, tempVectorY\n            vector.normalize tempVectorY, tempVectorY\n            \n            module.exports.setX tempVectorX, output\n            module.exports.setY tempVectorY, output\n            module.exports.setZ tempVectorZ, output\n            return\n            \n# invert\n\n- An input matrix to invert.\n- An output matrix to write to.\n\nAttempts to calculate the inverse of a matrix by negating its translation and\ntransposing its X, Y and Z axes.  Will not work if any scaling has been applied.\n\n        invert: (input, output) ->\n            module.exports.copy input, fromTemp\n            module.exports.getX fromTemp, tempVectorX\n            module.exports.getY fromTemp, tempVectorY\n            module.exports.getZ fromTemp, tempVectorZ\n            module.exports.getTranslation fromTemp, tempVector\n            output[0] = fromTemp[0]\n            output[1] = fromTemp[4]\n            output[2] = fromTemp[8]\n            output[3] = -vector.dot tempVector, tempVectorX\n            \n            output[4] = fromTemp[1]\n            output[5] = fromTemp[5]\n            output[6] = fromTemp[9]\n            output[7] = -vector.dot tempVector, tempVectorY\n            \n            output[8] = fromTemp[2]\n            output[9] = fromTemp[6]\n            output[10] = fromTemp[10]\n            output[11] = -vector.dot tempVector, tempVectorZ\n            \n            output[12] = 0\n            output[13] = 0\n            output[14] = 0\n            output[15] = 1\n            \n            return\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","old_contents":"Matrices are arrays of 16 numbers forming a 4x4 matrix.\n\n    temp1 = []\n    temp2 = []\n    rotationTemp = []\n    tempVector = []\n    tempVectorFrom = []\n    tempVectorTo = []\n    fromTemp = []\n    toTemp = []\n    tempVectorX = []\n    tempVectorY = []\n    tempVectorZ = []\n    \n    makeRotate = (axis1, axis2, axis3, axis4) ->\n        temp3 = []\n        rotationTemp.push temp3\n        (radians, output, local) ->\n            sin = Math.sin radians\n            cos = Math.cos radians\n            temp3[axis1] = cos\n            temp3[axis2] = -sin\n            temp3[axis3] = sin\n            temp3[axis4] = cos\n            if local\n                module.exports.multiply temp3, output, output\n            else\n                module.exports.multiply output, temp3, output\n            return\n\n    vector = require \".\/vector.litcoffee\"\n            \n    module.exports = \n\nGiven a matrix, calling the \"identity\" property writes the identity matrix to \nit.\n\n        identity: (output) ->\n            for row in [0...4]\n                for column in [0...4]\n                    output[row * 4 + column] = if row is column then 1 else 0\n            return\n        \nGiven two matrices, calling the \"copy\" property copies every component from the \nfirst to the second.\n\n        copy: (input, output) ->\n            output[index] = value for value, index in input\n            return\n            \nGiven three matrices, calling the \"multiply\" property multiplies the first two \ntogether and writes the result to the third.\n\n        multiply: (a, b, output) ->\n            module.exports.copy a, temp1\n            module.exports.copy b, temp2\n                \n            for row in [0...4]\n                for column in [0...4]\n                    temp = 0\n                    for component in [0...4]\n                        temp += temp1[component * 4 + column] * temp2[row * 4 + component]\n                    output[row * 4 + column] = temp\n            return\n            \nGiven a number of radians and a matrix, calling the \"rotateX\" property modifies \nthe matrix to have been rotated by that number of radians about the X axis.\nIf the third parameter is truthy, the rotation is applied in local rather than\nglobal space.\n            \n        rotateX: makeRotate 5, 6, 9, 10\n        \nGiven a number of radians and a matrix, calling the \"rotateY\" property modifies \nthe matrix to have been rotated by that number of radians about the Y axis.\nIf the third parameter is truthy, the rotation is applied in local rather than\nglobal space.\n        \n        rotateY: makeRotate 0, 2, 8, 10\n\nGiven a number of radians and a matrix, calling the \"rotateZ\" property modifies \nthe matrix to have been rotated by that number of radians about the Z axis.\nIf the third parameter is truthy, the rotation is applied in local rather than\nglobal space.\n        \n        rotateZ: makeRotate 0, 1, 4, 5\n        \nGiven a vector specifying the scaling factor on each axis and a matrix, calling\nthe \"scale\" property scales the matrix by those scaling factors.\n        \n        scale: (vector, output) ->\n            output[index] *= vector[0] for index in [0...4]\n            output[index] *= vector[1] for index in [4...8]\n            output[index] *= vector[2] for index in [8...12]\n            return\n\n# translate\n\n- A vector to translate by.\n- A matrix to translate.\n- When truthy, the translation is applied in local space, otherwise it is \n  applied in global space.\n            \n        translate: (v, output, local) ->\n            if local\n                tempVectorX[0] = output[0]\n                tempVectorX[1] = output[1]\n                tempVectorX[2] = output[2]\n\n                tempVectorY[0] = output[4]\n                tempVectorY[1] = output[5]\n                tempVectorY[2] = output[6]\n                \n                tempVectorZ[0] = output[8]\n                tempVectorZ[1] = output[9]\n                tempVectorZ[2] = output[10]\n                \n                tempVector[0] = vector.dot tempVectorX, v\n                tempVector[1] = vector.dot tempVectorY, v\n                tempVector[2] = vector.dot tempVectorZ, v\n                module.exports.translate tempVector, output\n            else\n                output[3] += v[0]\n                output[7] += v[1]\n                output[11] += v[2]\n            return\n            \nGiven a matrix, X, Y, Z and W values (defaulting to 0, 0, 0 and 1 respectively\nif not given), calling the \"apply\" property returns an array of four numbers \nrepresenting the transformed vector.\n\n        apply: (matrix, x, y, z, w) ->\n            if x is undefined then x = 0\n            if y is undefined then y = 0\n            if z is undefined then z = 0\n            if w is undefined then w = 1\n            \n            [\n                x * matrix[0] + y * matrix[1] + z * matrix[2] + w * matrix[3]\n                x * matrix[4] + y * matrix[5] + z * matrix[6] + w * matrix[7]\n                x * matrix[8] + y * matrix[9] + z * matrix[10] + w * matrix[11]\n                x * matrix[12] + y * matrix[13] + z * matrix[14] + w * matrix[15]\n            ]\n            \nGiven a matrix, input vector and output vector, calling the \"applyToVector\"\nproperty writes the input vector transformed by the matrix to the output vector.\n        \n        applyToVector: (matrix, input, output) ->\n            vector.copy input, tempVector\n            output[0] = tempVector[0] * matrix[0] + tempVector[1] * matrix[1] + tempVector[2] * matrix[2] + matrix[3]\n            output[1] = tempVector[0] * matrix[4] + tempVector[1] * matrix[5] + tempVector[2] * matrix[6] + matrix[7]\n            output[2] = tempVector[0] * matrix[8] + tempVector[1] * matrix[9] + tempVector[2] * matrix[10] + matrix[11]\n            return\n            \nGiven a matrix and output vector, calling the \"getTranslation\" property writes\nthe translation applied by the matrix to the output vector.\n\n        getTranslation: (matrix, output) ->\n            output[0] = matrix[3]\n            output[1] = matrix[7]\n            output[2] = matrix[11]\n\nGiven a matrix and output vector, calling the \"getX\" property writes the vector\nof the matrix's X axis (a scaled normal) to the output vector.\n\n        getX: (matrix, output) ->\n            output[0] = matrix[0]\n            output[1] = matrix[4]\n            output[2] = matrix[8]\n\nGiven a matrix and output vector, calling the \"getY\" property writes the vector\nof the matrix's Y axis (a scaled normal) to the output vector.\n\n        getY: (matrix, output) ->\n            output[0] = matrix[1]\n            output[1] = matrix[5]\n            output[2] = matrix[9]\n            \nGiven a matrix and output vector, calling the \"getZ\" property writes the vector\nof the matrix's Z axis (a scaled normal) to the output vector.\n\n        getZ: (matrix, output) ->\n            output[0] = matrix[2]\n            output[1] = matrix[6]\n            output[2] = matrix[10]\n            \n# setTranslation\n\n- A vector specifying the translation to set.\n- A matrix to set the translation of.\n\nOverwrites the translation of the matrix with the content of the given vector.\n\n        setTranslation: (output, matrix) ->\n            matrix[3] = output[0]\n            matrix[7] = output[1]\n            matrix[11] = output[2]\n\n# setX\n\n- A vector specifying the X axis vector to set.\n- A matrix to set the X axis vector of.\n\nOverwrites the X axis of the matrix with the content of the given vector.\n\n        setX: (output, matrix) ->\n            matrix[0] = output[0]\n            matrix[4] = output[1]\n            matrix[8] = output[2]\n\n# setY\n\n- A vector specifying the Y axis vector to set.\n- A matrix to set the Y axis vector of.\n\nOverwrites the Y axis of the matrix with the content of the given vector.\n\n        setY: (output, matrix) ->\n            matrix[1] = output[0]\n            matrix[5] = output[1]\n            matrix[9] = output[2]\n\n# setZ\n\n- A vector specifying the Z axis vector to set.\n- A matrix to set the Z axis vector of.\n\nOverwrites the Z axis of the matrix with the content of the given vector.\n\n        setZ: (output, matrix) ->\n            matrix[2] = output[0]\n            matrix[6] = output[1]\n            matrix[10] = output[2]\n            \n# interpolate\n\n- An input matrix to interpolate from.\n- An input matrix to interpolate to.\n- A number specifying how far along to interpolate; \"0\" is \"from\" and \"1\" is \n  \"to\".\n- An output matrix.\n\nAttempts to perform a somewhat crude interpolation between the two matrices\nwhich is not very linear.  Good enough for smoothing over small changes.\nPrioritizes the Z and Y axes over the X axis when ensuring orthogonal.\n\n        interpolate: (from, to, alpha, output) ->       \n            module.exports.copy from, fromTemp\n            module.exports.copy to, toTemp\n            module.exports.identity output\n            module.exports.getTranslation fromTemp, tempVectorFrom\n            module.exports.getTranslation toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            module.exports.setTranslation tempVector, output\n            \n            module.exports.getX fromTemp, tempVectorFrom\n            module.exports.getX toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVector\n            vector.normalize tempVector, tempVectorX, true  \n            \n            module.exports.getY fromTemp, tempVectorFrom\n            module.exports.getY toTemp, tempVectorTo\n            vector.interpolate tempVectorFrom, tempVectorTo, alpha, tempVectorY\n            \n            vector.cross tempVectorX, tempVectorY, tempVectorZ\n            vector.normalize tempVectorZ, tempVectorZ\n            vector.cross tempVectorZ, tempVectorX, tempVectorY\n            vector.normalize tempVectorY, tempVectorY\n            \n            module.exports.setX tempVectorX, output\n            module.exports.setY tempVectorY, output\n            module.exports.setZ tempVectorZ, output\n            return\n            \n# invert\n\n- An input matrix to invert.\n- An output matrix to write to.\n\nAttempts to calculate the inverse of a matrix by negating its translation and\ntransposing its X, Y and Z axes.  Will not work if any scaling has been applied.\n\n        invert: (input, output) ->\n            module.exports.copy input, fromTemp\n            module.exports.getX fromTemp, tempVectorX\n            module.exports.getY fromTemp, tempVectorY\n            module.exports.getZ fromTemp, tempVectorZ\n            module.exports.getTranslation fromTemp, tempVector\n            output[0] = input[0]\n            output[1] = input[4]\n            output[2] = input[8]\n            output[3] = -vector.dot tempVector, tempVectorX\n            \n            output[4] = input[1]\n            output[5] = input[5]\n            output[6] = input[9]\n            output[7] = -vector.dot tempVector, tempVectorY\n            \n            output[8] = input[2]\n            output[9] = input[6]\n            output[10] = input[10]\n            output[11] = -vector.dot tempVector, tempVectorZ\n            \n            output[12] = 0\n            output[13] = 0\n            output[14] = 0\n            output[15] = 1\n            \n            return\n            \n    module.exports.identity temp1\n    module.exports.identity temp2\n    for mat in rotationTemp\n        module.exports.identity mat","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3f7f29daa9a6b1cc4c5c853de4bf5c621b61101a","subject":"Add 404 route handling","message":"Add 404 route handling\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/server.litcoffee","new_file":"src\/server.litcoffee","new_contents":"    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      if not req.get('Origin') or not (req.get('Origin') in origins)\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use (req, res, next) ->\n      res.status(404).json message: 'Not Found'\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","old_contents":"    compression  = require 'compression'\n    express      = require 'express'\n    morgan       = require 'morgan'\n    responseTime = require 'response-time'\n\n    multer       = require 'multer'\n    async        = require 'async'\n    dms2dec      = require 'dms2dec'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n    app.use compression()\n    app.use responseTime()\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n      returnExif: true\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    origins = process.env.ALLOW_ORIGINS?.split(',') or []\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      if not req.get('Origin') or not (req.get('Origin') in origins)\n        error = new Error \"Bad Origin Header #{req.get('Origin')}\"\n        error.status 403\n        return next error\n\n      res.set 'Access-Control-Allow-Origin', req.get('Origin')\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Expose-Headers', 'X-Response-Time'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        if req.files[key].extension not in ['jpg', 'jpeg', 'png', 'gif', 'tiff']\n          error = new Error \"Invalid Image #{req.files[key].extension}\"\n          error.status = 422\n          return cb error\n\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n\n          if meta.exif['exif:GPSLatitude'] and meta.exif['exif:GPSLongitude']\n            meta.geojson =\n              type: 'Point'\n              coordinates: dms2dec \\\n                meta.exif['exif:GPSLatitude'], \\\n                meta.exif['exif:GPSLatitudeRef'], \\\n                meta.exif['exif:GPSLongitude'], \\\n                meta.exif['exif:GPSLongitudeRef']\n              .reverse()\n\n          return cb null, versions: images.splice(1), meta: meta\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use raven.middleware.express sentry\n    app.use (err, req, res, next) ->\n      if not err.status or err.status >= 500\n        sentry.captureError err\n\n        console.error err.message\n        console.error err.stack\n\n        res.status(err.status or 500).json message: 'Internal Server Error'\n      else\n        sentry.captureMessage err.message, level: 'warning', req: req\n        res.status(err.status).json message: err.message\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b2ebc37d753edd59c26c3d0fcf63c99637c09cd2","subject":"\u26a0\ufe0f fix markdown","message":"\u26a0\ufe0f fix markdown","repos":"vpj\/weya,vpj\/weya","old_file":"base_analytics.litcoffee","new_file":"base_analytics.litcoffee","new_contents":"# Weya.Base.js\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n    Weya.ANALYTICS = {}\n\n    WRAP = (className, methodName, func) ->\n     wrap = ->\n      args = (typeof arg for arg in arguments)\n      args = args.join ','\n      c = Weya.ANALYTICS[className] ?= {}\n      c = c[methodName] ?= {}\n      ret = func.apply this, arguments\n      signature = \"(#{args}) -> #{typeof ret}\"\n      c[signature] ?= 0\n      c[signature]++\n      return ret\n\n\n\n## Weya.Base\nIntroduces class level function initialize and include.\n\n    class Base\n     _initialize: []\n     on: {}\n\n     _extended: true\n\n     _debug: false\n     _analytics: true\n\n     @weyaDebug: ->\n      @::_debug = true\n\n     @weyaAnalytics: (name) ->\n      @::_analytics = true\n\n      return if not @::_debug\n\n      for k, v of this.prototype\n       continue if ((typeof v) isnt 'function')\n       this.prototype[k] = WRAP name, k, v\n\nExtend Events\n\n     @extend: ->\n      events = @::on\n      @::on = {}\n      @::on[k] = v for k, v of events\n      @::_extended = true\n      @::_analytics = false\n\nAdd event listeners\n\n     @listen: (name, func) ->\n      @::on[name] = func\n\nGetter\n\n     @get: (name, func) ->\n      @::__defineGetter__ name, func\n\nSetter\n\n     @set: (name, func) ->\n      @::__defineSetter__ name, func\n\n     constructor: ->\n      @_init.apply this, arguments\n\n#### Register initialize functions.\nAll initializer funcitons in subclasses will be called with the constructor\narguments.\n\n     @initialize: (func) ->\n      #if not @::_extended\n      # throw new Error 'Class not extended'\n\n      @::_extended = false\n\n      @::_initialize = @::_initialize.slice()\n      @::_initialize.push func\n\n     _init: ->\n      if not @_analytics\n       throw new Error 'Class analytics not called'\n\n      for init in @_initialize\n       init.apply this, arguments\n\n      return\n\n#### Include objects.\nYou can include objects by registering them with @include. This tries to\nsolve the problem of single inheritence.\n\n     @include: (obj) ->\n      for k, v of obj\n       switch k\n        when 'initialize'\n         @::_initialize.push v\n        when 'on'\n         for event, listener of v\n          @::on[event] = listener\n        else\n         @prototype[k] = v\n\n     @initialize ->\n      events = @on\n      @on = {}\n      for k, v of events\n       @on[k] = v.bind this\n\n    Weya.Base = Base\n\n    if module?\n     module.exports = Weya.Base\n\n","old_contents":"#Weya.Base.js\n\n    @Weya = {} unless @Weya?\n    Weya = @Weya\n\n    Weya.ANALYTICS = {}\n\n    WRAP = (className, methodName, func) ->\n     wrap = ->\n      args = (typeof arg for arg in arguments)\n      args = args.join ','\n      c = Weya.ANALYTICS[className] ?= {}\n      c = c[methodName] ?= {}\n      ret = func.apply this, arguments\n      signature = \"(#{args}) -> #{typeof ret}\"\n      c[signature] ?= 0\n      c[signature]++\n      return ret\n\n\n\n##Weya.Base\nIntroduces class level function initialize and include.\n\n    class Base\n     _initialize: []\n     on: {}\n\n     _extended: true\n\n     _debug: false\n     _analytics: true\n\n     @weyaDebug: ->\n      @::_debug = true\n\n     @weyaAnalytics: (name) ->\n      @::_analytics = true\n\n      return if not @::_debug\n\n      for k, v of this.prototype\n       continue if ((typeof v) isnt 'function')\n       this.prototype[k] = WRAP name, k, v\n\nExtend Events\n\n     @extend: ->\n      events = @::on\n      @::on = {}\n      @::on[k] = v for k, v of events\n      @::_extended = true\n      @::_analytics = false\n\nAdd event listeners\n\n     @listen: (name, func) ->\n      @::on[name] = func\n\nGetter\n\n     @get: (name, func) ->\n      @::__defineGetter__ name, func\n\nSetter\n\n     @set: (name, func) ->\n      @::__defineSetter__ name, func\n\n     constructor: ->\n      @_init.apply this, arguments\n\n####Register initialize functions.\nAll initializer funcitons in subclasses will be called with the constructor\narguments.\n\n     @initialize: (func) ->\n      #if not @::_extended\n      # throw new Error 'Class not extended'\n\n      @::_extended = false\n\n      @::_initialize = @::_initialize.slice()\n      @::_initialize.push func\n\n     _init: ->\n      if not @_analytics\n       throw new Error 'Class analytics not called'\n\n      for init in @_initialize\n       init.apply this, arguments\n\n      return\n\n####Include objects.\nYou can include objects by registering them with @include. This tries to\nsolve the problem of single inheritence.\n\n     @include: (obj) ->\n      for k, v of obj\n       switch k\n        when 'initialize'\n         @::_initialize.push v\n        when 'on'\n         for event, listener of v\n          @::on[event] = listener\n        else\n         @prototype[k] = v\n\n     @initialize ->\n      events = @on\n      @on = {}\n      for k, v of events\n       @on[k] = v.bind this\n\n    Weya.Base = Base\n\n    if module?\n     module.exports = Weya.Base\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"128889e5ba10d32bfa7dd856b005a9b7b2230e15","subject":"Added some rendering pipeline options","message":"Added some rendering pipeline options\n\nThe three options allow for easy debugging\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/arguments.litcoffee","new_file":"lib\/arguments.litcoffee","new_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] levelname anotherlevelname yetanotherlevelname ...'\n      .example '$0',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -vvvvvvvv',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to verbosity level 8 (max)\\n\"\n      .example '$0 -w 20 -h 20',\n        \"Creates a level with default row and column counts,\n         the cells 20 units wide, 20 units high,\n         expanded by the default multiplier,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -w 10 -h 10 -x 4',\n        \"Creates a level with default row and column counts,\n         40 x 40 unit cells,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 lvl1 lvl2',\n        \"Creates two levels; named lvl1 and lvl2 -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 --levels one two three',\n        \"Creates three levels; named one, two, and three -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 -l10',\n        \"Creates ten auto-named levels -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .string 'conf'\n      .describe 'conf', 'Absolute path to config file'\n      .string 'block.fill_color'\n      .describe 'block.fill_color', 'Path block color. Can be an html color name or hex value'\n      .string 'ground.fill_color'\n      .describe 'ground.fill_color', 'Ground block color. Can be an html color name or hex value'\n      .string 'step_count.text.align'\n      .choices 'step_count.text.align', [ 'left', 'center', 'right' ]\n      .string 'step_count.text.color'\n      .describe 'step_count.text.color', 'Can be either html color names or hex values'\n      .number 'ground.segments'\n      .number 'ground.max_height_diff'\n      .number 'wall.width'\n      .string 'wall.color'\n      .describe 'wall.color', 'Can be either html color names or hex values'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      24\n        height:     24\n        multiplier: 4\n        # pipeline:   [ 'json_blocks', 'json_ground', 'json_walls' ]\n        # pipeline:   [ 'png_blocks', 'png_walls', 'png_ground', 'png_step_count' ]\n        pipeline: [\n          [ 'json_blocks', 'json_ground', 'json_walls' ]\n          [ 'png_blocks',  'png_ground',  'png_walls', 'png_roof', 'png_step_count' ]\n        ]\n        block:\n          fill_color: 'white'\n        ground:\n          fill_color:     '#888'\n          segments:        24\n          max_height_diff: 4\n        step_count:\n          text:\n            align: 'center'\n            color: 'black'\n        wall:\n          width: 1\n          color: '#666'\n          segments: 24\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .wrap 120\n      .argv\n","old_contents":"    module.exports = require 'yargs'\n      .usage 'Usage: $0 [options] levelname anotherlevelname yetanotherlevelname ...'\n      .example '$0',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -vvvvvvvv',\n        \"Creates a level with default row and column counts,\n         the default size and multiplier for each cell,\n         an auto-generated name,\n         and logging set to verbosity level 8 (max)\\n\"\n      .example '$0 -w 20 -h 20',\n        \"Creates a level with default row and column counts,\n         the cells 20 units wide, 20 units high,\n         expanded by the default multiplier,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 -w 10 -h 10 -x 4',\n        \"Creates a level with default row and column counts,\n         40 x 40 unit cells,\n         an auto-generated name,\n         and logging set to default verbosity\\n\"\n      .example '$0 lvl1 lvl2',\n        \"Creates two levels; named lvl1 and lvl2 -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 --levels one two three',\n        \"Creates three levels; named one, two, and three -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .example '$0 -l10',\n        \"Creates ten auto-named levels -\n         each with default row and column counts,\n         the default size and multiplier for each cell,\n         and logging set to default verbosity\\n\"\n      .count 'verbosity'\n      .alias 'v', 'verbosity'\n      .describe 'v', 'Level of logging verbosity: 1 - 8'\n      .alias 'r', 'rows'\n      .describe 'r', 'Number of rows for map'\n      .alias 'c', 'columns'\n      .describe 'c', 'Number of columns for map'\n      .alias 'w', 'width'\n      .describe 'w', 'Width of a grid cell'\n      .alias 'h', 'height'\n      .describe 'h', 'Height of a grid cell'\n      .alias 'x', 'multiplier'\n      .describe 'x', 'Increase cell size by x times'\n      .number 'l'\n      .describe 'l', 'Number of auto-named levels to create'\n      .array 'levels'\n      .describe 'levels', 'Array of named levels to create'\n      .array 'pipeline'\n      .alias 'p', 'pipeline'\n      .describe 'p', 'The steps of the render pipleline'\n      .string 'conf'\n      .describe 'conf', 'Absolute path to config file'\n      .string 'block.fill_color'\n      .describe 'block.fill_color', 'Path block color. Can be an html color name or hex value'\n      .string 'ground.fill_color'\n      .describe 'ground.fill_color', 'Ground block color. Can be an html color name or hex value'\n      .string 'step_count.text.align'\n      .choices 'step_count.text.align', [ 'left', 'center', 'right' ]\n      .string 'step_count.text.color'\n      .describe 'step_count.text.color', 'Can be either html color names or hex values'\n      .number 'ground.segments'\n      .number 'ground.max_height_diff'\n      .number 'wall.width'\n      .string 'wall.color'\n      .describe 'wall.color', 'Can be either html color names or hex values'\n      .conflicts 'levels', 'l'\n      .help 'help'\n      .default\n        verbosity:  3\n        rows:       15\n        columns:    50\n        width:      24\n        height:     24\n        multiplier: 4\n        pipeline:   [ 'png_blocks', 'png_walls', 'png_grounder', 'png_step_count' ]\n        block:\n          fill_color: 'white'\n        ground:\n          fill_color:     '#888'\n          segments:        24\n          max_height_diff: 4\n        step_count:\n          text:\n            align: 'center'\n            color: 'black'\n        wall:\n          width: 1\n          color: '#666'\n          segments: 24\n      .epilogue '\u00a9 Bryan Maynard 2016'\n      .wrap 120\n      .argv\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2245a96139c9379a3d6318200f8e74598f0ba187","subject":"Improved documentation of the plane module.","message":"Improved documentation of the plane module.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat","old_file":"src\/plane.litcoffee","new_file":"src\/plane.litcoffee","new_contents":"# plane\n\nA plane is an object containing:\n\n- normal: A vector specifying the facing direction of the plane.\n- distance: A number specifying how far from 0, 0, 0 along the normal the plane \n            is.\n\n    vector = require \".\/vector.litcoffee\"\n    tempA = []\n    tempB = []\n\n## fromTriangle\n\n- A vector specifying the location of the first vertex.\n- A vector specifying the location of the second vertex.\n- A vector specifying the location of the third vertex.\n- An existing object to populate, else, falsy.\n\nThe populated object is returned.\n\n    fromTriangle = (a, b, c, output) ->\n        output = output or {}\n        output.normal = output.normal or []\n        vector.subtract.vector a, b, tempA\n        vector.subtract.vector a, c, tempB\n        vector.cross tempB, tempA, output.normal\n        vector.normalize output.normal, output.normal\n        output.distance = vector.dot output.normal, a\n        output\n            \n## distance\n\n- A plane.\n- A vector.\n\nReturns the distance between the plane and the vector.  Negative when behind the\nplane.\n\n    distance = (plane, input) -> (vector.dot plane.normal, input) - plane.distance\n    \n## project\n\n- A plane.\n- An input vector.\n- An output vector.\n\nProjects the input vector onto the surface of the plane, travelling along its\nnormal to find the closest point, and writes that point to the output vector.\n    \n    project = (plane, input, output) ->\n        dist = distance plane, input\n        vector.multiply.scalarBy dist, plane.normal, tempA\n        vector.subtract.vector input, tempA, output\n        return\n    \n    module.exports = {\n        fromTriangle\n        distance\n        project\n    }","old_contents":"A plane is an object containing:\n\n- normal: A vector specifying the facing direction of the plane.\n- distance: A number specifying how far from 0, 0, 0 along the normal the plane \n            is.\n            \nExports an object.\n\n    vector = require \".\/vector.litcoffee\"\n    tempA = []\n    tempB = []\n\nCall the \"fromTriangle\" property with three input vectors forming a clockwise \ntriangle and an output object to create a plane on which those three vectors \nlie.  If the output object is undefined, an empty one is created.  The output \nobject is returned.\n\n    fromTriangle = (a, b, c, output) ->\n        output = output or {}\n        output.normal = output.normal or []\n        vector.subtract.vector a, b, tempA\n        vector.subtract.vector a, c, tempB\n        vector.cross tempB, tempA, output.normal\n        vector.normalize output.normal, output.normal\n        output.distance = vector.dot output.normal, a\n        output\n            \nCall the \"distance\" property with a plane and a vector.  The distance between\nthe plane and vector is returned.  If the vector is behind the plane, the\ndistance is negative.\n\n    distance = (plane, input) -> (vector.dot plane.normal, input) - plane.distance\n    \nCall the \"project\" property with a plane, input vector and output vector to\nwrite the nearest point to the input vector on the plane to the output vector.\n    \n    project = (plane, input, output) ->\n        dist = distance plane, input\n        vector.multiply.scalarBy dist, plane.normal, tempA\n        vector.subtract.vector input, tempA, output\n        return\n    \n    module.exports = {\n        fromTriangle\n        distance\n        project\n    }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"318946d81fc2c0d69272f45f6c66dc042e8aab00","subject":"value to string fix","message":"value to string fix\n","repos":"vpj\/models","old_file":"js\/properties\/value.litcoffee","new_file":"js\/properties\/value.litcoffee","new_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#Value\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       propertyType: 'value'\n\n       @default 'value', (str, stack) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value, stack) -> \"#{value}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str, stack) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str, stack) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value, stack) ->\n        value is @schema.default()\n\n       parse: (data, stack) ->\n        r = super data, stack\n        return r unless r is true\n        if not @schema.valid data, stack\n         return @error 'invalid'\n\n        return {\n         score: 1\n         errors: []\n         value: @schema.value data, stack\n        }\n\n       toJSON: (value, stack) -> value\n       toJSONFull: (value, stack) -> value\n\n       edit: (elem, value, onChanged, stack) ->\n        new Edit this, elem, value, onChanged, stack\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, onChanged, stack) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = onChanged\n        @stack = stack\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           placeholder: @$.property._name\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = schema.string @value, @stack\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n        @change()\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value, @stack\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r, i in results\n          break if i > 10\n          e = @div r\n          e._result = r\n\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @elems.search.style.display = 'none'\n        @change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 400\n\n       @listen 'change', (e) ->\n        @search()\n        @change()\n\n       change: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value, @stack\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value, @stack\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","old_contents":"Copyright 2014 - 2015\nAuthor: Varuna Jayasiri http:\/\/blog.varunajayasiri.com\n\n#Value\n\n    Mod.require 'Models.Properties',\n     'Models.Property.Base'\n     'Weya.Base'\n     'Weya'\n     (PROPERTIES, Base, WeyaBase, Weya) ->\n\n\nClass\n\n      class Value extends Base\n       @extend()\n\n       propertyType: 'value'\n\n       @default 'value', (str, stack) ->\n        if (typeof str) isnt 'string'\n         throw new Error \"Exected string: #{typeof str}, #{str}\"\n        return str\n\n       @default 'string', (value, stack) -> \"#{str}\"\n\n       @default 'rows', 1\n       @default 'columns', 20\n\n       @default 'valid', (str, stack) ->\n        if (typeof str) isnt 'string'\n         return false\n        else\n         return true\n\n       @default 'search', (str, stack) -> null\n\n       @default 'default', -> ''\n\n       @default 'isDefault', (value, stack) ->\n        value is @schema.default()\n\n       parse: (data, stack) ->\n        r = super data, stack\n        return r unless r is true\n        if not @schema.valid data, stack\n         return @error 'invalid'\n\n        return {\n         score: 1\n         errors: []\n         value: @schema.value data, stack\n        }\n\n       toJSON: (value, stack) -> value\n       toJSONFull: (value, stack) -> value\n\n       edit: (elem, value, onChanged, stack) ->\n        new Edit this, elem, value, onChanged, stack\n\n\nEdit\n\n      class Edit extends WeyaBase\n       @extend()\n\n       @initialize (property, elem, value, onChanged, stack) ->\n        @property = property\n        @elems =\n         parent: elem\n        @value = value\n        @onChanged = onChanged\n        @stack = stack\n        @render()\n\n       render: ->\n        schema = @property.schema\n        width = 2 + Math.round schema.columns * 7.25\n        Weya elem: @elems.parent, context: this, ->\n         if schema.rows is 1\n          @$.elems.input = @input '.value',\n           type: 'text'\n           placeholder: @$.property._name\n           style:\n            width: \"#{width}px\"\n         else\n          @$.elems.input = @textarea '.value',\n           rows: schema.rows\n           columns: schema.columns\n           style:\n            width: \"#{width}px\"\n            height: \"#{Math.round schema.rows * 18}px\"\n\n         @$.elems.search = @div '.search',\n          style:\n           display: 'none'\n           width: \"#{width}px\"\n\n        @elems.input.value = schema.string @value, @stack\n        @elems.input.addEventListener \"input\", @on.change\n        @elems.input.addEventListener \"focus\", @on.focus\n        @elems.input.addEventListener \"blur\", @on.blur\n        @elems.search.addEventListener 'click', @on.searchClick\n        @change()\n\n       search: ->\n        value = @elems.input.value\n        results = @property.schema.search.call @property, value, @stack\n        return if not results?\n        return if not Array.isArray results\n\n        if results.length is 0\n         @elems.search.style.display = 'none'\n         return\n\n        @elems.search.style.display = 'block'\n        @elems.search.innerHTML = ''\n        Weya elem: @elems.search, ->\n         for r, i in results\n          break if i > 10\n          e = @div r\n          e._result = r\n\n\n       @listen 'searchClick', (e) ->\n        n = e.target\n        result = null\n        while n? and n isnt @elems.search\n         if n._result\n          result = n._result\n          break\n         n = n.parentNode\n\n        return if not result?\n        @elems.input.value = result\n        @elems.search.style.display = 'none'\n        @change()\n\n       @listen 'focus', (e) -> @search()\n       @listen 'blur', (e) ->\n        setTimeout =>\n         @elems.search.style.display = 'none'\n        , 400\n\n       @listen 'change', (e) ->\n        @search()\n        @change()\n\n       change: ->\n        value = @elems.input.value\n        if not @property.schema.valid.call @property, value, @stack\n         @elems.input.classList.add 'invalid'\n        else\n         @elems.input.classList.remove 'invalid'\n         value = @property.schema.value.call this, value, @stack\n         @onChanged value, true\n\n\n\n\n      PROPERTIES.register 'value', Value\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"92cf18f861608bb85a5533df879b8b3aa54cef8d","subject":"Fix undefined tilbyder name in error mmesasge","message":"Fix undefined tilbyder name in error mmesasge\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/server.litcoffee","new_file":"coffee\/server.litcoffee","new_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.user.tilbyder}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","old_contents":"    raven       = require 'raven'\n    sentry      = require '.\/db\/sentry'\n    express     = require 'express'\n\n    auth        = require '.\/helper\/auth'\n\n    system      = require '.\/system'\n    collection  = require '.\/collection'\n    document    = require '.\/document'\n\n## Init\n\n    app = express()\n\n### Authentication\n\nThis routine is called for all request to the API. It is reponsible for\nauthenticating the user by validating the `api\\_key`. It then sets some request\nsession variables so they become accessible throughout the entire system during\nthe rquest.\n\n    app.use '\/', (req, res, next) ->\n      return next() if req.originalUrl.substr(0, 17) is '\/CloudHealthCheck'\n\n      auth.check req.query.api_key, (err, user) ->\n        if user\n          res.set 'X-RateLimit-Limit', user.limit\n          res.set 'X-RateLimit-Remaining', user.remaining\n          res.set 'X-RateLimit-Reset', user.reset\n\n        req.user = user\n\n        return next err if err\n\n        next()\n\n### Configuration\n\n    app.use(express.favicon())\n    app.use(express.logger(':date :remote-addr - :method :url :status :res[content-length] - :response-time ms')) if not process.env.SILENT\n    app.set('json spaces', 0) if app.get('env') isnt 'testing'\n    app.use(express.compress())\n    app.use(express.json())\n    app.disable('x-powered-by')\n    app.set 'port', process.env.PORT_WWW or 8080\n    app.use(app.router)\n\n### Error handling\n\nBefore handling the error ours self make sure that it is propperly logged in\nSentry by using the express\/connect middleware.\n\n    app.use raven.middleware.express sentry\n\nAll errors passed to `next` or exceptions ends up here. We set the status code\nto `500` if it is not already defined in the `Error` object. We then print the\nerror mesage and stack trace to the console for debug purposes.\n\nLog 401 Unauthorized (warning) and 403 Forbidden (notice) errors to Sentry to\nenhance debugging and oversight as Nasjonal Turbase gets more used.\n\nBefore returning a response to the user the request method is check. HEAD\nrequests shall not contain any body \u2013 this applies for errors as well.\n\n    app.use (err, req, res, next) ->\n      res.status err.status or 500\n\n      if res.statusCode is 401\n        sentry.captureMessage \"Invalid API-key #{req.query.api_key}\",\n          level: 'warning'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode is 403\n        sentry.captureMessage \"Rate limit exceeded for #{req.tilbyder}\",\n          level: 'notice'\n          extra: sentry.parseRequest req, user: req.user\n\n      if res.statusCode >= 500\n        console.error err.message\n        console.error err.stack\n\n      return res.end() if req.method is 'HEAD'\n      return res.json message: err.message or 'Ukjent feil'\n\nThis the fmous 404 Not Found handler. If no route configuration for the request\nis found, it ends up here. We don't do much fancy about it \u2013 just a standard\nerror message and HTTP status code.\n\n    app.use (req, res) -> res.json 404, message: \"Resurs ikke funnet\"\n\n## GET \/\n\n    app.get '\/', (req, res) ->\n      res.json message: 'Here be dragons'\n\n## GET \/CloudHealthCheck\n\n> So...You\u2019re seeing the dotCloud active health check looking to make sure that\n> your service is up. There is no way for you to disable it, but you can prevent\n> it and you can handle it [1]!\n\n[1] [dotCloud](http:\/\/docs.dotcloud.com\/tutorials\/more\/cloud-health-check\/)\n\n    app.all '\/CloudHealthCheck', system.check\n\n## GET \/objekttyper\n\n    app.get '\/objekttyper', (req, res, next) ->\n      res.json 200, ['turer', 'steder', 'omr\u00e5der', 'grupper', 'arrangementer', 'bilder']\n\n## ALL \/{collection}\n\n    app.param 'collection', collection.param\n    app.all '\/:collection', (req, res, next) ->\n      switch req.method\n        when 'OPTIONS' then collection.options req, res, next\n        when 'HEAD', 'GET' then collection.get req, res, next\n        when 'POST' then collection.post req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## ALL \/{collection}\/{objectid}\n\n    app.param 'objectid', document.param\n    app.options '\/:collection\/:ojectid', document.options\n    app.all '\/:collection\/:objectid', document.all, (req, res, next) ->\n      switch req.method\n        when 'HEAD', 'GET' then document.get req, res, next\n        when 'PUT' then document.put req, res, next\n        when 'PATCH' then document.patch req, res, next\n        when 'DELETE' then document.delete req, res, next\n        else res.json 405, message: \"HTTP Method #{req.method.toUpperCase()} Not Allowed\"\n\n## Start\n\nOk, so if the server is running in stand-alone mode i.e. there is not\n`module.parent` then continue with starting the databse and listening to a port.\n\n    if not module.parent\n      require('.\/db\/redis')\n      require('.\/db\/mongo').once 'ready', ->\n        console.log 'Database is open...'\n\n        app.listen app.get('port'), ->\n          console.log \"Server is listening on port #{app.get('port')}\"\n\nHowever, if there is a `module.parent` don't do all the stuff above. This means\nthat there is some program that is including the server from it, e.g a test, and\nhence it should not listen to a port for incomming connections and rather just\nreturn the application instance so that we can do some testing on it.\n\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a38ef3d979890ad09bb03b61ad55b0ed73420945","subject":"lodash replaced pluck","message":"lodash replaced pluck\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-limiter\/index.litcoffee","new_file":"packages\/shrub-limiter\/index.litcoffee","new_contents":"# Rate limiter\n\n*Limits the rate at which clients can do certain operations, like call RPC\nroutes.*\n\n    pkgman = require 'pkgman'\n\n    exports.SKIP = SKIP = {}\n\nA limiter on a route is defined like:\n\n```javascript\n\nregistrar.registerHook('shrubRpcRoutes', function() {\n\n  var shrubLimiter = require 'shrub-limiter'\n  var Limiter = shrubLimiter.Limiter;\n  var LimiterMiddleware = shrubLimiter.LimiterMiddleware;\n\n  var routes = []\n\n  routes.push({\n\n.    path: 'my-package\/route',\n\n.    middleware: [\n\n.      ...\n\n.      'shrub-villiany' \/\/ Include if limit infractions lead to eventual ban\n\n.      new LimiterMiddleware(\n.        limiterDefinitionObject\n.      )\n\n.      ...\n\n.    ]\n\n  });\n\n  return routes;\n});\n\n```\n\n<small>***NOTE:*** *Ignore the leading dots, they are a result of literate coffee\nlimitations.*<\/small>\n\nWhere `limiterDefinitionObject` above is defined as an object with the\nfollowing properties:\n\n* `threshold`: The [threshold](.\/limiter#threshold) for this limiter.\n* `message`: The message returned to the client when the threshold is\n  passed.\n* `ignoreKeys`: The\n  [fingerprint keys](source\/server\/fingerprint) to ignore when\n  determining the total limit.\n* `villianyScore`: The score accumulated when this limit is crossed.\n\n### LimiterMiddleware\n\n    exports.LimiterMiddleware = class LimiterMiddleware\n\n      constructor: (@config) ->\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubOrmCollections`.\n\n      registrar.registerHook 'shrubOrmCollections', ->\n\n        _ = require 'lodash'\n\n        Limit =\n\n          autoPK: false\n\n          associations: [\n            alias: 'scores'\n          ]\n\n          attributes:\n\n## Limit#key\n\n*The limiter key.*\n\n            key:\n              type: 'string'\n              primaryKey: true\n\n## Limit#scores\n\n*Scores accrued for this limit.*\n\n            scores:\n              collection: 'shrub-limit-score'\n              via: 'limit'\n\n## Limit#accrue\n\n* (Number) `score` - The numeric score to accrue.\n\n*Accrue a score for this limit.*\n\n            accrue: (score) ->\n              @scores.add score: score\n\n              return this\n\n## Limit#passed\n\n* (Number) `threshold` - The threshold duration in seconds.\n\n*Check whether a limit has passed the time threshold.*\n\n            passed: (threshold) -> 0 >= @ttl threshold\n\n## Limit#reset\n\n*Reset scores and created time.*\n\n            reset: ->\n              @scores.remove id for id in _.map @scores, 'id'\n              @createdAt = new Date()\n\n              return this\n\n## Limit#reset\n\n*Get the sum of all scores for this limit.*\n\n            score: ->\n              _.map(@scores, 'score').reduce ((l, r) -> l + r), 0\n\n## Limit#ttl\n\n* (Number) `threshold` - The threshold duration in seconds.\n\n*Get the current time-to-live for this limit.*\n\n            ttl: (threshold) ->\n              diff = (Date.now() - @createdAt.getTime()) \/ 1000\n              Math.ceil threshold - diff\n\n        LimitScore =\n\n          attributes:\n\n            score: 'integer'\n\n            limit: model: 'shrub-limit'\n\n        'shrub-limit': Limit\n        'shrub-limit-score': LimitScore\n\n#### Implements hook `shrubRpcRoutesAlter`.\n\nAllow RPC routes definitions to specify rate limiters.\n\n      registrar.registerHook 'shrubRpcRoutesAlter', (routes) ->\n\n        Promise = require 'bluebird'\n        moment = require 'moment'\n\n        errors = require 'errors'\n\nCheck all routes' middleware for limiter definitions.\n\n        Object.keys(routes).forEach (path) ->\n          route = routes[path]\n\n          Fingerprint = require 'fingerprint'\n\n          for fn, index in route.middleware\n            continue unless fn instanceof exports.LimiterMiddleware\n\n            route.limiter = fn.config\n\nCreate a limiter based on the threshold defined.\n\n            route.limiter.instance = new Limiter(\n              \"rpc:\/\/#{path}\", route.limiter.threshold\n            )\n\nSet defaults.\n\n            route.limiter.excludedKeys ?= []\n            route.limiter.message ?= 'You are doing that too much.'\n            route.limiter.villianyScore ?= 20\n\nAdd a validator, where we'll check the threshold.\n\n            route.middleware[index] = (req, res, next) ->\n\n              {\n                excludedKeys\n                instance\n                message\n                villianyScore\n              } = route.limiter\n\nAllow packages to check and optionally skip the limiter.\n\n#### Invoke hook `shrubLimiterCheck`.\n\n              for rule in pkgman.invokeFlat 'shrubLimiterCheck', req\n                continue unless rule?\n                return next() if SKIP is rule\n\n              fingerprint = new Fingerprint req\n\n              inlineKeys = fingerprint.inlineKeys excludedKeys\n\nBuild a nice error message for the client, so they hopefully will stop doing\nthat.\n\n              sendLimiterError = ->\n                instance.ttl(inlineKeys).then (ttl) ->\n                  next errors.instantiate(\n                    'limiterThreshold'\n                    message\n                    moment().add('seconds', ttl).fromNow()\n                  )\n\nAccrue a hit and check the threshold.\n\n              instance.accrueAndCheckThreshold(inlineKeys).then((isLimited) ->\n                return next() unless isLimited\n\n#### Invoke hook `shrubVillianyReport`.\n\n                Promise.all(\n                  pkgman.invokeFlat(\n                    'shrubVillianyReport'\n                    req\n                    villianyScore\n                    \"rpc:\/\/#{path}:limiter\"\n                    excludedKeys\n                  )\n\n                ).then (reports) ->\n\nOnly send an error if the user wasn't banned for this.\n\n                  if reports.filter((isBanned) -> !!isBanned).length is 0\n                    sendLimiterError()\n\n              ).catch next\n\n#### Implements hook `shrubTransmittableErrors`.\n\nJust defer to client, where the error is defined.\n\n      registrar.registerHook 'shrubTransmittableErrors', require('.\/client').shrubTransmittableErrors\n\n    exports.Limiter = Limiter = require '.\/limiter'\n","old_contents":"# Rate limiter\n\n*Limits the rate at which clients can do certain operations, like call RPC\nroutes.*\n\n    pkgman = require 'pkgman'\n\n    exports.SKIP = SKIP = {}\n\nA limiter on a route is defined like:\n\n```javascript\n\nregistrar.registerHook('shrubRpcRoutes', function() {\n\n  var shrubLimiter = require 'shrub-limiter'\n  var Limiter = shrubLimiter.Limiter;\n  var LimiterMiddleware = shrubLimiter.LimiterMiddleware;\n\n  var routes = []\n\n  routes.push({\n\n.    path: 'my-package\/route',\n\n.    middleware: [\n\n.      ...\n\n.      'shrub-villiany' \/\/ Include if limit infractions lead to eventual ban\n\n.      new LimiterMiddleware(\n.        limiterDefinitionObject\n.      )\n\n.      ...\n\n.    ]\n\n  });\n\n  return routes;\n});\n\n```\n\n<small>***NOTE:*** *Ignore the leading dots, they are a result of literate coffee\nlimitations.*<\/small>\n\nWhere `limiterDefinitionObject` above is defined as an object with the\nfollowing properties:\n\n* `threshold`: The [threshold](.\/limiter#threshold) for this limiter.\n* `message`: The message returned to the client when the threshold is\n  passed.\n* `ignoreKeys`: The\n  [fingerprint keys](source\/server\/fingerprint) to ignore when\n  determining the total limit.\n* `villianyScore`: The score accumulated when this limit is crossed.\n\n### LimiterMiddleware\n\n    exports.LimiterMiddleware = class LimiterMiddleware\n\n      constructor: (@config) ->\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubOrmCollections`.\n\n      registrar.registerHook 'shrubOrmCollections', ->\n\n        _ = require 'lodash'\n\n        Limit =\n\n          autoPK: false\n\n          associations: [\n            alias: 'scores'\n          ]\n\n          attributes:\n\n## Limit#key\n\n*The limiter key.*\n\n            key:\n              type: 'string'\n              primaryKey: true\n\n## Limit#scores\n\n*Scores accrued for this limit.*\n\n            scores:\n              collection: 'shrub-limit-score'\n              via: 'limit'\n\n## Limit#accrue\n\n* (Number) `score` - The numeric score to accrue.\n\n*Accrue a score for this limit.*\n\n            accrue: (score) ->\n              @scores.add score: score\n\n              return this\n\n## Limit#passed\n\n* (Number) `threshold` - The threshold duration in seconds.\n\n*Check whether a limit has passed the time threshold.*\n\n            passed: (threshold) -> 0 >= @ttl threshold\n\n## Limit#reset\n\n*Reset scores and created time.*\n\n            reset: ->\n              @scores.remove id for id in _.pluck @scores, 'id'\n              @createdAt = new Date()\n\n              return this\n\n## Limit#reset\n\n*Get the sum of all scores for this limit.*\n\n            score: ->\n              _.pluck(@scores, 'score').reduce ((l, r) -> l + r), 0\n\n## Limit#ttl\n\n* (Number) `threshold` - The threshold duration in seconds.\n\n*Get the current time-to-live for this limit.*\n\n            ttl: (threshold) ->\n              diff = (Date.now() - @createdAt.getTime()) \/ 1000\n              Math.ceil threshold - diff\n\n        LimitScore =\n\n          attributes:\n\n            score: 'integer'\n\n            limit: model: 'shrub-limit'\n\n        'shrub-limit': Limit\n        'shrub-limit-score': LimitScore\n\n#### Implements hook `shrubRpcRoutesAlter`.\n\nAllow RPC routes definitions to specify rate limiters.\n\n      registrar.registerHook 'shrubRpcRoutesAlter', (routes) ->\n\n        Promise = require 'bluebird'\n        moment = require 'moment'\n\n        errors = require 'errors'\n\nCheck all routes' middleware for limiter definitions.\n\n        Object.keys(routes).forEach (path) ->\n          route = routes[path]\n\n          Fingerprint = require 'fingerprint'\n\n          for fn, index in route.middleware\n            continue unless fn instanceof exports.LimiterMiddleware\n\n            route.limiter = fn.config\n\nCreate a limiter based on the threshold defined.\n\n            route.limiter.instance = new Limiter(\n              \"rpc:\/\/#{path}\", route.limiter.threshold\n            )\n\nSet defaults.\n\n            route.limiter.excludedKeys ?= []\n            route.limiter.message ?= 'You are doing that too much.'\n            route.limiter.villianyScore ?= 20\n\nAdd a validator, where we'll check the threshold.\n\n            route.middleware[index] = (req, res, next) ->\n\n              {\n                excludedKeys\n                instance\n                message\n                villianyScore\n              } = route.limiter\n\nAllow packages to check and optionally skip the limiter.\n\n#### Invoke hook `shrubLimiterCheck`.\n\n              for rule in pkgman.invokeFlat 'shrubLimiterCheck', req\n                continue unless rule?\n                return next() if SKIP is rule\n\n              fingerprint = new Fingerprint req\n\n              inlineKeys = fingerprint.inlineKeys excludedKeys\n\nBuild a nice error message for the client, so they hopefully will stop doing\nthat.\n\n              sendLimiterError = ->\n                instance.ttl(inlineKeys).then (ttl) ->\n                  next errors.instantiate(\n                    'limiterThreshold'\n                    message\n                    moment().add('seconds', ttl).fromNow()\n                  )\n\nAccrue a hit and check the threshold.\n\n              instance.accrueAndCheckThreshold(inlineKeys).then((isLimited) ->\n                return next() unless isLimited\n\n#### Invoke hook `shrubVillianyReport`.\n\n                Promise.all(\n                  pkgman.invokeFlat(\n                    'shrubVillianyReport'\n                    req\n                    villianyScore\n                    \"rpc:\/\/#{path}:limiter\"\n                    excludedKeys\n                  )\n\n                ).then (reports) ->\n\nOnly send an error if the user wasn't banned for this.\n\n                  if reports.filter((isBanned) -> !!isBanned).length is 0\n                    sendLimiterError()\n\n              ).catch next\n\n#### Implements hook `shrubTransmittableErrors`.\n\nJust defer to client, where the error is defined.\n\n      registrar.registerHook 'shrubTransmittableErrors', require('.\/client').shrubTransmittableErrors\n\n    exports.Limiter = Limiter = require '.\/limiter'\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e6ea0e54494a32a4da58e81c58c922816e4ff798","subject":"code block after list seems to be confusing the markdown parser","message":"code block after list seems to be confusing the markdown parser\n","repos":"romanpitak\/pitak.net,romanpitak\/pitak.net","old_file":"src\/jade\/build.litcoffee","new_file":"src\/jade\/build.litcoffee","new_contents":"# The build script\n\nThis is a very simple build script that puts together the YAML + JADE page files\nand the pure JADE template files. It also builds the blog index.\n\nLoad modules\n\n    fs = require 'fs'\n    mkdirp = require('mkdirp').sync;\n    jade = require 'jade'\n    yaml = require 'js-yaml'\n    config = require '.\/config'\n\n### Markdown\n\nAdd custom markdown parser\nwith custom code parsing function\nthat highlights with Pygments\n\nFurther reading:\n\n- [Marked overriding-renderer-methods](https:\/\/www.npmjs.com\/package\/marked#overriding-renderer-methods)\n- [Node child_process.execSync](http:\/\/nodejs.org\/docs\/v0.12.0\/api\/child_process.html#child_process_child_process_execsync_command_options)\n- [Jade How to define\/install custom filter?](https:\/\/github.com\/jadejs\/jade\/issues\/1055)\n- [Pygments lexers](http:\/\/pygments.org\/docs\/lexers\/)\n\n**note**: We are overriding `renderer.code`\ninstead of `renderer.options.highlight`\nbecause it wraps the highlihter result in unnecessary `<pre><code>`.\n\n**note**: Since Jade doesn't support async filters,\nwe have to use `child_process.execSync`.\nThis requires Node >= 0.11.12\n\n    execSync = (require 'child_process').execSync\n    marked = require 'marked'\n\n    renderer = new marked.Renderer\n    renderer.code = (code, lexer = 'text') ->\n        result = execSync \"pygmentize -l #{lexer} -f html\",\n            input: code\n        return result.toString()\n\n    marked.setOptions\n        renderer: renderer\n\n    jade.filters.markdown = marked\n\n### Template loader\n\nTemplates are different from pages in that they don't have a YAML front matter.\nThey are written in clean jade and can extend and include other templates.\n\n    class Template\n        constructor: (@name = 'page', @location = config.templatesPath) ->\n        getHtml: (options) ->\n            cwd = process.cwd()\n            options.pretty = config.pretty\n            options.filename = @name\n            try\n                process.chdir @location\n                content = fs.readFileSync \"#{@name}.jade\", 'utf8'\n                @html = jade.render content, options\n            catch error\n                console.log error\n            finally\n                process.chdir cwd\n            return @html\n\n## Page loader\n\n    class Page\n\nA nice \/regexp?\/ from the\n[dworthen\/js-yaml-front-matter](https:\/\/github.com\/dworthen\/js-yaml-front-matter\/blob\/master\/lib\/js-yaml-front.js)\nrepo to separate the YAML front matter from the JADE page content.\n\n        re: \/^(-{3}(?:\\n|\\r)([\\w\\W]+?)(?:\\n|\\r)-{3})?([\\w\\W]*)*\/\n\nSet the file name and location\n\n        constructor: (@pageFile, @location = config.pagesPath) ->\n\nRender the HTML\n\n        render: ->\n\nMake sure we have content\n\n            if not @content?\n                if not @pageFile?\n                    throw new Error 'pageFile not set'\n                location = \"#{@location}\/#{@pageFile}\"\n                @content = fs.readFileSync location, 'utf8'\n\nParse the content\n\n            parts = @re.exec @content\n            if ! @frontMatter?\n                @frontMatter = if parts[2]? then yaml.safeLoad parts[2] else {}\n            this[key] = value for key, value of @frontMatter\n            if ! @containerContent?\n                @containerContent = jade.render parts[3] or '',\n                    filename: @pageFile\n                    pretty: config.pretty\n\nParse the template\n\n            template = new Template @template or null\n            @html = template.getHtml this\n\nWrite the page into the output directory. I might move this to a separate\nfunction (class) later on maybe?\n\n        write: ->\n            folder = \"#{config.htmlPath}#{@url}\"\n            mkdirp folder unless fs.existsSync folder\n            fs.writeFileSync \"#{folder}\/index.html\", @html\n\n#### Blog\n\nIt's the blog index page.\n\n    class Blog extends Page\n        posts: []\n        content: ''\n        template: 'blog'\n        title: 'Blog'\n        url: '\/blog'\n\n#### Pages\n\nIterate through a given directory and process the given pages.\n\nEach page is pushed into a list of pages that will later be used for blog building\nand sitemap.xml\n\n    class Pages\n        constructor: (@location) ->\n            @pages = []\n        render: ->\n            for pageFile in (fs.readdirSync @location).reverse()\n                page = new Page pageFile, @location\n                page.render()\n                page.write()\n                @pages.push page\n\n#### Blogs\n\nDo the Pages thing and build a blog index on top.\n\n    class Blogs extends Pages\n        render: ->\n            super()\n            blog = new Blog\n            blog.posts = @pages\n            do blog.render\n            do blog.write\n\n# Render\n\n    pages = new Pages config.pagesPath\n    pages.render()\n    blogs = new Blogs config.blogPath\n    blogs.render()\n","old_contents":"# The build script\n\nThis is a very simple build script that puts together the YAML + JADE page files\nand the pure JADE template files. It also builds the blog index.\n\nLoad modules\n\n    fs = require 'fs'\n    mkdirp = require('mkdirp').sync;\n    jade = require 'jade'\n    yaml = require 'js-yaml'\n    config = require '.\/config'\n\n### Markdown\n\nAdd custom markdown parser\nwith custom code parsing function\nthat highlights with Pygments\n\n**note**: We are overriding `renderer.code`\ninstead of `renderer.options.highlight`\nbecause it wraps the highlihter result in unnecessary `<pre><code>`.\n\n**note**: Since Jade doesn't support async filters,\nwe have to use `child_process.execSync`.\nThis requires Node >= 0.11.12\n\nFurther reading:\n\n- [Marked overriding-renderer-methods](https:\/\/www.npmjs.com\/package\/marked#overriding-renderer-methods)\n- [Node child_process.execSync](http:\/\/nodejs.org\/docs\/v0.12.0\/api\/child_process.html#child_process_child_process_execsync_command_options)\n- [Jade How to define\/install custom filter?](https:\/\/github.com\/jadejs\/jade\/issues\/1055)\n- [Pygments lexers](http:\/\/pygments.org\/docs\/lexers\/)\n\n    execSync = (require 'child_process').execSync\n    marked = require 'marked'\n\n    renderer = new marked.Renderer\n    renderer.code = (code, lexer = 'text') ->\n        result = execSync \"pygmentize -l #{lexer} -f html\",\n            input: code\n        return result.toString()\n\n    marked.setOptions\n        renderer: renderer\n\n    jade.filters.markdown = marked\n\n### Template loader\n\nTemplates are different from pages in that they don't have a YAML front matter.\nThey are written in clean jade and can extend and include other templates.\n\n    class Template\n        constructor: (@name = 'page', @location = config.templatesPath) ->\n        getHtml: (options) ->\n            cwd = process.cwd()\n            options.pretty = config.pretty\n            options.filename = @name\n            try\n                process.chdir @location\n                content = fs.readFileSync \"#{@name}.jade\", 'utf8'\n                @html = jade.render content, options\n            catch error\n                console.log error\n            finally\n                process.chdir cwd\n            return @html\n\n## Page loader\n\n    class Page\n\nA nice \/regexp?\/ from the\n[dworthen\/js-yaml-front-matter](https:\/\/github.com\/dworthen\/js-yaml-front-matter\/blob\/master\/lib\/js-yaml-front.js)\nrepo to separate the YAML front matter from the JADE page content.\n\n        re: \/^(-{3}(?:\\n|\\r)([\\w\\W]+?)(?:\\n|\\r)-{3})?([\\w\\W]*)*\/\n\nSet the file name and location\n\n        constructor: (@pageFile, @location = config.pagesPath) ->\n\nRender the HTML\n\n        render: ->\n\nMake sure we have content\n\n            if not @content?\n                if not @pageFile?\n                    throw new Error 'pageFile not set'\n                location = \"#{@location}\/#{@pageFile}\"\n                @content = fs.readFileSync location, 'utf8'\n\nParse the content\n\n            parts = @re.exec @content\n            if ! @frontMatter?\n                @frontMatter = if parts[2]? then yaml.safeLoad parts[2] else {}\n            this[key] = value for key, value of @frontMatter\n            if ! @containerContent?\n                @containerContent = jade.render parts[3] or '',\n                    filename: @pageFile\n                    pretty: config.pretty\n\nParse the template\n\n            template = new Template @template or null\n            @html = template.getHtml this\n\nWrite the page into the output directory. I might move this to a separate\nfunction (class) later on maybe?\n\n        write: ->\n            folder = \"#{config.htmlPath}#{@url}\"\n            mkdirp folder unless fs.existsSync folder\n            fs.writeFileSync \"#{folder}\/index.html\", @html\n\n#### Blog\n\nIt's the blog index page.\n\n    class Blog extends Page\n        posts: []\n        content: ''\n        template: 'blog'\n        title: 'Blog'\n        url: '\/blog'\n\n#### Pages\n\nIterate through a given directory and process the given pages.\n\nEach page is pushed into a list of pages that will later be used for blog building\nand sitemap.xml\n\n    class Pages\n        constructor: (@location) ->\n            @pages = []\n        render: ->\n            for pageFile in (fs.readdirSync @location).reverse()\n                page = new Page pageFile, @location\n                page.render()\n                page.write()\n                @pages.push page\n\n#### Blogs\n\nDo the Pages thing and build a blog index on top.\n\n    class Blogs extends Pages\n        render: ->\n            super()\n            blog = new Blog\n            blog.posts = @pages\n            do blog.render\n            do blog.write\n\n# Render\n\n    pages = new Pages config.pagesPath\n    pages.render()\n    blogs = new Blogs config.blogPath\n    blogs.render()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a0ceae14a269111610e63b0423d883589e56747d","subject":"[Sheet] Minor typos","message":"[Sheet] Minor typos\n","repos":"marrus-sh\/jelli","old_file":"coffee\/sheet.litcoffee","new_file":"coffee\/sheet.litcoffee","new_contents":"Jelli Game Engine\n\n#  Sheet  #\n\nThe `Sheet` constructor generates sprite-sheets and manages their rendering on a `CanvasRenderingContext2D`.\nIt is packaged with `Sprite`, which describes a single sprite on the sheet.\n\n##  General functions  ##\n\nThe function `drawSprite()` is called by `Sprite`s and `Sheet`s in order to draw their images.\nIt is not exposed to the window.\n\n    drawSprite = (sheet, start_index, context, x, y, frame = 1) ->\n\n\u2026That's a lot of arguments. Let's go through them:\n\n- `sheet` is the `Sheet` from which to draw the sprite\n- `start_index` gives us the index of the sprite within the sheet\n- `context` is the `CanvasRenderingContext2D` on which to draw the sprite\n- `x` is the x-coordinate of the top-left corner of the sprite\n- `y` is the y-coordinate of the top-left corner of the sprite\n- `frame` is merely there as a convenience: It increments `start_index` by its value\n\nThe first thing we do is make sure everything is typed correctly.\nThe `sheet` and `context`, clearly, need to be of a certain type in order for this to work.\nIf any of the other provided arguments aren't numbers, however, we can go ahead and reset them to zero.\n\n        unless sheet instanceof Sheet and start_index < sheet.size and context instanceof CanvasRenderingContext2D then return\n        if isNaN(start_index = Number(start_index)) then start_index = 0\n        if isNaN(x = Number(x)) then x = 0\n        if isNaN(y = Number(y)) then y = 0\n        if isNaN(frame = Number(frame)) then frame = 0\n\nNow we can increment `start_index` by `frame`'s value:\n\n        `start_index` += frame\n\nNext, we need to find the horizontal (`i`) and vertical (`j`) position of the sprite on the sheet.\nWe can get this information from `start_index` with a little math:\n\n        i = start_index % sheet.width\n        j = Math.floor start_index \/ sheet.width\n\nThese two lines just make the image a little easier to access:\n\n        source = sheet.source\n        image = sheet.image\n\nNow we have all we need to draw the sprite!\nThere is a HUGE `if`-statement that precedes the draw function, because we want to make sure that what we're drawing is actually there.\nIf it isn't, then obviously we can't draw anything.\n\n        if (source instanceof HTMLImageElement and source.complete or source instanceof SVGImageElement or source instanceof HTMLCanvasElement or createImageBitmap? and (image instanceof ImageBitmap or source instanceof ImageBitmap)) and not isNaN(i) and not isNaN(j) and Number(width = sheet.sprite_width) and Number(height = sheet.sprite_height) then context.drawImage (if createImageBitmap? and image instanceof ImageBitmap then image else source), i * width, j * height, width, height, x, y, width, height\n\nLet's go through what those did.\nFirst, we make sure that the `Sheet` actually has an image associated with it:\n\n-   `source instanceof HTMLImageElement and source.complete`\u2014\n    If the image source is an `<img>` element, then it needs to have finished loading.\n\n-   `source instanceof SVGImageElement or source instanceof HTMLCanvasElement`\u2014\n    The source doesn't have to be an `<img>` element though! It can also be an `<svg>` or a `<canvas>`.\n\n-   `createImageBitmap? and (image instanceof ImageBitmap or source instanceof ImageBitmap)`\u2014\n    Finally, the source can be an `ImageBitmap`.\n    This isn't supported in all browsers, so we check to make sure `createImageBitmap` exists first.\n    However, if `createImageBitmap` *is* supported, then `Sheet`s have a special property, `Sheet.image`, which might contain one, and this should be given preference.\n\nWe also need to make sure that the sprite exists on the sheet:\n\n-   `not isNaN(i) and not isNaN(j)`\u2014\n    This makes sure that our indices are actually, y'know, numbers.\n\n-   `Number(width = sheet.sprite_width) and Number(height = sheet.sprite_height)`\u2014\n    This makes sure that the sprites in the sheet have a non-zero width and height.\n    It also sets the variables `width` and `height` to those values, for convenient access later.\n\nFinally, we can draw the sprite.\nAgain, we preference `image` if it is defined.\n\n##  Sprite  ##\n\nThe `Sprite` constructor creates a reference to a sprite on a sheet.\nFor efficiency's sake, it does *not* actually contain any of the image data associated with that sprite.\nThe constructor takes three arguments: `sheet`, which gives the sheet; `index`, which is the index of the sprite on the sheet; and `length`, which for animated sprites gives the length of the animation.\n\n    Sprite = (sheet, index, length = 1) ->\n\nIf `index` or `length` aren't numbers, then we go ahead and set them to `0` and `1`, respectively.\n\n        if isNaN(index = Number(index)) then index = 0\n        if isNaN(length = Number(length)) then length = 1\n\nNow we can set the properties.\nNote that `draw` simply binds `drawSprite` to the given `Sheet` and `index`.\n\n        @draw = drawSprite.bind(null, sheet, index)\n        @height = if sheet instanceof Sheet then sheet.sprite_height else 0\n        @index = index\n        @frames = length\n        @sheet = if sheet instanceof Sheet then sheet else null\n        @width = if sheet instanceof Sheet then sheet.sprite_width else 0\n\nSince `Sprite`s are just static references, they should be immutable:\n\n        Object.freeze this\n\nAnd we're done!\n\n`Sprite`s are very simple, and because the `draw` function is bound above, they don't have a prototype.\nFor purposes of inheritance, however, I've thrown this minimal one together:\n\n    Sprite.prototype = {draw: ->}\n    Object.freeze Sprite.prototype\n\n##  Sheet  ##\n\n`Sheet`s associate images with data and methods to make them easily referencable as sprite-sheets.\n\n###  The constructor  ###\n\nThe `Sheet` constructor only takes three arguments: `source`, which gives the source image for the sheet, `sprite_width`, which gives the width of the sprites, and `sprite_height`, which gives their height.\nIn doing so, it makes the assumption that sprites and sprite-sheets do not have any borders or padding.\n(Because borders and padding result in larger download times for users, this restriction is considered acceptable, but it may be lifted at some time in the future.)\n\n    Sheet = (source, sprite_width, sprite_height) ->\n\nFirst, we need to handle the arguments.\nIf `source` isn't an image type that we recognize, we go ahead and set it to `null`.\nAnd if the `sprite_width` or `sprite_height` aren't recognizable as numbers, we set them to 0.\n(Note from the above that a `Sheet` with zero `sprite_width` or `sprite_height` cannot be drawn.)\n\n        unless source instanceof HTMLImageElement or source instanceof SVGImageElement or source instanceof HTMLCanvasElement or createImageBitmap? and source instanceof ImageBitmap then source = null\n        if isNaN(sprite_width = Number(sprite_width)) then sprite_width = 0\n        if isNaN(sprite_height = Number(sprite_height)) then sprite_height = 0\n\nRecall that we need to check for `createImageBitmap` before checking to see if the source is an `ImageBitmap`.\n\nWe can get the width and height of the image from one of two sources, depending on the source type.\nAll of the accepted types have `width` and `height` properties, which specify their dimensions.\nHowever, `HTMLImageElement`s also have `naturalWidth` and `naturalHeight` properties, and these should be preferred for pixel-perfect rendering.\n\nIf for some reason we can't get *either* of these properties, then the `source_width` and `source_height` are set to zero.\n\n        unless source? and not isNaN(source_width = Number(if source.naturalWidth? then source.naturalWidth else source.width)) then source_width = 0\n        unless source? and not isNaN(source_height = Number(if source.naturalHeight? then source.naturalHeight else source.height)) then source_height = 0\n\nWe now have everything we need to define the properties.\nNote that `width` and `height` are provided in sprite-units, not pixels.\nIf `sprite_width` or `sprite_height` are `0`, then the corresponding `width` and `height` are obviously `NaN`.\n\n        @height = Math.floor source_height \/ sprite_height\n        @source = source\n        @sprite_height = sprite_height\n        @sprite_width = sprite_width\n        @width = Math.floor source_width \/ sprite_width\n\nThe `size` property is just `width` times `height`.\n\n        @size = @width * @height\n\n`ImageBitmap`s are optimized for drawing to the canvas.\nIf they are supported, we can pre-render the sprite-sheet and store this in the `image` property.\n\n        if createImageBitmap? then (createImageBitmap source).then (image) => @image = image\n\nBecause `Sheet`s contain static images, it doesn't make sense for them to change after creation.\nWe freeze them:\n\n        Object.freeze this\n\nFor convenience's sake, two static methods have been defined for `Sheet` to let you draw arbitrary sprites.\nThese are largely intended for use with callbacks.\n\nThe first is called `draw`, and takes five arguments:\n\n- `context`: A `CanvasRenderingContext2D`\n- `sprite`: A `Sprite`\n- `x`: The x-coordinate at which to draw the sprite\n- `y`: The y-coordinate at which to draw the sprite\n- `frame`: The frame of the animation which to draw\n\nIt maps onto `sprite.draw`:\n\n    Sheet.draw = (context, sprite, x, y, frame = 0) -> if sprite instanceof Sprite then sprite.draw context, x, y, frame\n\nThe second is called `drawSheetAtIndex`, and also takes five arguments:\n\n- `context`: A `CanvasRenderingContext2D`\n- `sheet`: A `Sheet`\n- `index`: The index of the sprite\n- `x`: The x-coordinate at which to draw the sprite\n- `y`: The y-coordinate at which to draw the sprite\n\nIt maps onto `sheet.drawIndex`:\n\n    Sheet.drawSheetAtIndex = (context, sheet, index, x, y) -> if sheet instanceof Sheet then sheet.drawIndex context, index, x, y\n\nFinally, the `Sprite` constructor is added to `Sheet` for later access:\n\n    Sheet.Sprite = Sprite\n\nAnd now we can make `Sheet` available to the window:\n\n    window.Sheet = Sheet\n\n##  The prototype  ##\n\nThe `Sheet` prototype is fairly minimal, consisting of only two functions.\n\n    Sheet.prototype = {\n\nThe first, `drawIndex`, draws the sprite located at the given `index`.\nIt is little more than a repackaging of `drawSprite`.\n\n        drawIndex: (context, index, x, y) -> drawSprite this, index, context, x, y\n\nThe second, `getSprite`, creates a new `Sprite` pointing to the given `index`.\nIt is the most convenient way of creating `Sprite` objects.\nIt takes two arguments, the `index` of the sprite, and the `length` of the animation.\n\n        getSprite: (index, length = 1) -> new Sprite this, index, length\n\nWe can now freeze the prototype:\n\n    }\n\n    Object.freeze Sheet.prototype\n\n\u2026And that's the end!\n","old_contents":"Jelli Game Engine\n\n#  Sheet  #\n\n`Sheet()` generates sprite-sheets and manages their rendering on a `CanvasRenderingContext2D`.\nIt is packaged with `Sprite()`, which describes a single sprite on the sheet.\n\n##  General functions  ##\n\nThe function `drawSprite()` is called by `Sprite`s and `Sheet`s in order to draw their images.\nIt is not exposed to the window.\n\n    drawSprite = (sheet, start_index, context, x, y, frame = 1) ->\n\n\u2026That's a lot of arguments. Let's go through them:\n\n- `sheet` is the `Sheet` from which to draw the sprite\n- `start_index` gives us the index of the sprite within the sheet\n- `context` is the `CanvasRenderingContext2D` on which to draw the sprite\n- `x` is the x-coordinate of the top-left corner of the sprite\n- `y` is the y-coordinate of the top-left corner of the sprite\n- `frame` is merely there as a convenience: It increments `start_index` by its value\n\nThe first thing we do is make sure everything is typed correctly.\nThe `sheet` and `context`, clearly, need to be of a certain type in order for this to work.\nIf any of the other provided arguments aren't numbers, however, we can go ahead and reset them to zero.\n\n        unless sheet instanceof Sheet and start_index < sheet.size and context instanceof CanvasRenderingContext2D then return\n        if isNaN(start_index = Number(start_index)) then start_index = 0\n        if isNaN(x = Number(x)) then x = 0\n        if isNaN(y = Number(y)) then y = 0\n        if isNaN(frame = Number(frame)) then frame = 0\n\nNow we can increment `start_index` by `frame`'s value:\n\n        `start_index` += frame\n\nNext, we need to find the horizontal (`i`) and vertical (`j`) position of the sprite on the sheet.\nWe can get this information from `start_index` with a little math:\n\n        i = start_index % sheet.width\n        j = Math.floor start_index \/ sheet.width\n\nThese two lines just make the image a little easier to access:\n\n        source = sheet.source\n        image = sheet.image\n\nNow we have all we need to draw the sprite!\nThere is a HUGE `if`-statement that precedes the draw function, because we want to make sure that what we're drawing is actually there.\nIf it isn't, then obviously we can't draw anything.\n\n        if (source instanceof HTMLImageElement and source.complete or source instanceof SVGImageElement or source instanceof HTMLCanvasElement or createImageBitmap? and (image instanceof ImageBitmap or source instanceof ImageBitmap)) and not isNaN(i) and not isNaN(j) and Number(width = sheet.sprite_width) and Number(height = sheet.sprite_height) then context.drawImage (if createImageBitmap? and image instanceof ImageBitmap then image else source), i * width, j * height, width, height, x, y, width, height\n\nLet's go through what those did.\nFirst, we make sure that the `Sheet` actually has an image associated with it:\n\n-   `source instanceof HTMLImageElement and source.complete`\u2014\n    If the image source is an `<img>` element, then it needs to have finished loading.\n\n-   `source instanceof SVGImageElement or source instanceof HTMLCanvasElement`\u2014\n    The source doesn't have to be an `<img>` element though! It can also be an `<svg>` or a `<canvas>`.\n\n-   `createImageBitmap? and (image instanceof ImageBitmap or source instanceof ImageBitmap)`\u2014\n    Finally, the source can be an `ImageBitmap`.\n    This isn't supported in all browsers, so we check to make sure `createImageBitmap` exists first.\n    However, if `createImageBitmap` *is* supported, then `Sheet`s have a special property, `Sheet.image`, which might contain one, and this should be given preference.\n\nWe also need to make sure that the sprite exists on the sheet:\n\n-   `not isNaN(i) and not isNaN(j)`\u2014\n    This makes sure that our indices are actually, y'know, numbers.\n\n-   `Number(width = sheet.sprite_width) and Number(height = sheet.sprite_height)`\u2014\n    This makes sure that the `Sheet` has a non-zero width and height.\n    It also sets the variables `width` and `height` to those values, for convenient access later.\n\nFinally, we can draw the sprite.\nAgain, we preference `image` if it is defined.\n\n##  Sprite  ##\n\nThe `Sprite` constructor creates a reference to a sprite on a sheet.\nFor efficiency's sake, it does *not* actually contain any of the image data associated with that sprite.\nThe constructor takes three arguments: `sheet`, which gives the sheet; `index`, which is the index of the sprite on the sheet; and `length`, which for animated sprites gives the length of the animation.\n\n    Sprite = (sheet, index, length = 1) ->\n\nIf `index` or `length` aren't numbers, then we go ahead and set them to `0` and `1`, respectively.\n\n        if isNaN(index = Number(index)) then index = 0\n        if isNaN(length = Number(length)) then length = 0\n\nNow we can set the properties.\nNote that `draw` simply binds `drawSprite` to the given `Sheet` and `index`.\n\n        @draw = drawSprite.bind(null, sheet, index)\n        @height = if sheet instanceof Sheet then sheet.sprite_height else 0\n        @index = index\n        @frames = length\n        @sheet = if sheet instanceof Sheet then sheet else null\n        @width = if sheet instanceof Sheet then sheet.sprite_width else 0\n\nSince `Sprite`s are just static references, they should be immutable:\n\n        Object.freeze this\n\nAnd we're done!\n\n`Sprite`s are very simple, and because the `draw` function is bound above, they don't have a prototype.\nFor purposes of inheritance, however, I've thrown this minimal one together:\n\n    Sprite.prototype = {draw: ->}\n    Object.freeze Sprite.prototype\n\n##  Sheet  ##\n\n`Sheet`s associate images with data and methods to make them easily referencable as sprite-sheets.\n\n###  The constructor  ###\n\nThe `Sheet` constructor only takes three arguments: `source`, which gives the source image for the sheet, `sprite_width`, which gives the width of the sprites, and `sprite_height`, which gives their height.\nIn doing so, it makes the assumption that sprites and sprite-sheets do not have any borders or padding.\n(Because borders and padding result in larger download times for users, this restriction is considered acceptable, but it may be lifted at some time in the future.)\n\n    Sheet = (source, sprite_width, sprite_height) ->\n\nFirst, we need to handle the arguments.\nIf `source` isn't an image type that we recognize, we go ahead and set it to `null`.\nAnd if the `sprite_width` or `sprite_height` aren't recognizable as numbers, we set them to 0.\n(Note from the above that a `Sheet` with zero `sprite_width` or `sprite_height` cannot be drawn.)\n\n        unless source instanceof HTMLImageElement or source instanceof SVGImageElement or source instanceof HTMLCanvasElement or createImageBitmap? and source instanceof ImageBitmap then source = null\n        if isNaN(sprite_width = Number(sprite_width)) then sprite_width = 0\n        if isNaN(sprite_height = Number(sprite_height)) then sprite_height = 0\n\nRecall that we need to check for `createImageBitmap` before checking to see if the source is an `ImageBitmap`.\n\nWe can get the width and height of the image from one of two sources, depending on the source type.\nAll of the accepted types have `width` and `height` properties, which specify their dimensions.\nHowever, `HTMLImageElement`s also have `naturalWidth` and `naturalHeight` properties, and these should be preferred for pixel-perfect rendering.\n\nIf for some reason we can't get *either* of these properties, then the `source_width` and `source_height` are set to zero.\n\n        unless source? and not isNaN(source_width = Number(if source.naturalWidth? then source.naturalWidth else source.width)) then source_width = 0\n        unless source? and not isNaN(source_height = Number(if source.naturalHeight? then source.naturalHeight else source.height)) then source_height = 0\n\nWe now have everything we need to define the properties.\nNote that `width` and `height` are provided in sprite-units, not pixels.\nIf `sprite_width` or `sprite_height` are `0`, then the corresponding `width` and `height` are obviously `NaN`.\n\n        @height = Math.floor source_height \/ sprite_height\n        @source = source\n        @sprite_height = sprite_height\n        @sprite_width = sprite_width\n        @width = Math.floor source_width \/ sprite_width\n\nThe `size` property is just `width` times `height`.\n\n        @size = @width * @height\n\n`ImageBitmap`s are optimized for drawing to the canvas.\nIf they are supported, we can pre-render the sprite-sheet and store this in the `image` property.\n\n        if createImageBitmap? then (createImageBitmap source).then (image) => @image = image\n\nBecause `Sheet`s contain static images, it doesn't make sense for them to change after creation.\nWe freeze them:\n\n        Object.freeze this\n\nFor convenience's sake, two static method has been defined for `Sheet` to let you draw arbitrary sprites.\nThese are largely intended for use with callbacks.\n\nThe first is called `draw`, and takes five arguments:\n\n- `context`: A `CanvasRenderingContext2D`\n- `sprite`: A `Sprite`\n- `x`: The x-coordinate at which to draw the sprite\n- `y`: The y-coordinate at which to draw the sprite\n- `frame`: The frame of the animation which to draw\n\nIt maps onto `sprite.draw`:\n\n    Sheet.draw = (context, sprite, x, y, frame = 0) -> if sprite instanceof Sprite then sprite.draw context, x, y, frame\n\nThe second is called `drawSheetAtIndex`, and also takes five arguments:\n\n- `context`: A `CanvasRenderingContext2D`\n- `sheet`: A `Sheet`\n- `index`: The index of the sprite\n- `x`: The x-coordinate at which to draw the sprite\n- `y`: The y-coordinate at which to draw the sprite\n\nIt maps onto `sheet.drawIndex`:\n\n    Sheet.drawSheetAtIndex = (context, sheet, index, x, y) -> if sheet instanceof Sheet then sheet.drawIndex context, index, x, y\n\nFinally, the `Sprite` constructor is added to `Sheet` for later access:\n\n    Sheet.Sprite = Sprite\n\nAnd now we can make `Sheet` available to the window:\n\n    window.Sheet = Sheet\n\n##  The prototype  ##\n\nThe `Sheet` prototype is fairly minimal, consisting of only two functions.\n\n    Sheet.prototype = {\n\nThe first, `drawIndex`, draws the sprite located at the given `index`.\nIt is little more than a repackaging of `drawSprite`.\n\n        drawIndex: (context, index, x, y) -> drawSprite this, index, context, x, y\n\nThe second, `getSprite`, creates a new `Sprite` pointing to the given `index`.\nIt is the most convenient way of creating `Sprite` objects.\nIt takes two arguments, the `index` of the sprite, and the `length` of the animation.\n\n        getSprite: (index, length = 1) -> new Sprite this, index, length\n\nWe can now freeze the prototype:\n\n    }\n\n    Object.freeze Sheet.prototype\n\n\u2026And that's the end!\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e3f5deec57844a4d26bf8695abd8effd32941251","subject":"switched to jade.renderFile","message":"switched to jade.renderFile\n","repos":"romanpitak\/html-resume","old_file":"bin\/render-html.litcoffee","new_file":"bin\/render-html.litcoffee","new_contents":"# Builder\n\nload modules\n\n    {readFileSync, writeFileSync} = require 'fs'\n    {renderFile} = require 'jade'\n    {safeLoad} = require 'js-yaml'\n    marked = require 'marked'\n\nrender html\n\n    options = safeLoad readFileSync process.argv[3], 'utf8'\n    options.markdown = marked\n    html = renderFile process.argv[2], options\n\nwrite the output\n\n    if process.argv[4]?\n        writeFileSync process.argv[4], html\n    else\n        console.log html\n","old_contents":"# Builder\n\nload modules\n\n    {readFileSync, writeFileSync} = require 'fs'\n    {render} = require 'jade'\n    {safeLoad} = require 'js-yaml'\n    marked = require 'marked'\n\nrender html\n\n    content = readFileSync process.argv[2], 'utf8'\n    options = safeLoad readFileSync process.argv[3], 'utf8'\n    options.filename = process.argv[3]\n    options.markdown = marked\n    html = render content, options\n\nwrite the output\n\n    if process.argv[4]?\n        writeFileSync process.argv[4], html\n    else\n        console.log html\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2af9d0977dbc3a8cdfecb2a2adcac54f9431887c","subject":"Moved camera logic into the tick event rather than the draw event to improve framerate stability.","message":"Moved camera logic into the tick event rather than the draw event to\nimprove framerate stability.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat","old_file":"src\/game.litcoffee","new_file":"src\/game.litcoffee","new_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    pose = require \".\/pose.litcoffee\"\n    ik = require \".\/ik.litcoffee\"\n       \n    triangle = undefined\n    \n    character = testMap = testNavmesh = undefined\n    characterData = require \".\/characters\/test\/cloud.coffee\"\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load characterData, (character_) ->\n            character = character_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    matrix.identity entityTransform\n    \n    playerPoseOld = pose.create characterData\n    playerPoseNew = pose.create characterData\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformToDraw = []\n    cameraTransformPreviousDraw = []\n    cameraTransformPreviousTick = []\n    cameraLocation = []\n    cameraLocationPreviousTick = []\n    cameraTarget = []\n    cameraTargetPreviousTick = []\n    \n    torsoAltitude = 0\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    start = []\n    leftFoot = []\n    rightFoot = []\n    leftHand = []\n    leftHandPreviousTick = []\n    leftHandToDraw = []\n    rightHand = []\n    rightHandPreviousTick = []\n    rightHandToDraw = []\n    walked = 0\n    shuffleTicks = 0\n    foot = \"left\"\n    ticksSinceLeft = 0\n    ticksSinceRight = 0\n    offset = []\n    \n    yaw = 0\n    pitch = 0\n    headYawPreviousTick = headYaw = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->        \n        if not firstTick\n            matrix.copy cameraTransform, cameraTransformPreviousTick\n            vector.copy cameraLocation, cameraLocationPreviousTick\n            vector.copy cameraTarget, cameraTargetPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            vector.copy leftHand, leftHandPreviousTick\n            vector.copy rightHand, rightHandPreviousTick\n            \n        matrix.translate velocity, entityTransform  \n        speed = vector.magnitude velocity\n        walked += speed\n        moving = speed > 2\n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # A \"bump\" when you land.\n            matrix.getY entityTransform, yAxis\n            impact = Math.abs (vector.dot triangle.plane.normal, velocity) * (vector.dot triangle.plane.normal, yAxis)\n            impact -= 1\n            if impact < 0 then impact = 0\n            impact *= 2\n            torsoAltitude -= impact\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        torsoAltitude = misc.interpolate torsoAltitude, (12 - Math.min 2, (speed + if inDeadzone then 0 else 1.5)), 0.4\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, torsoAltitude, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.1, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        # Calculating the head angle relative to the torso is complicated by the\n        # stick angle being wrapped to 0...2PI, so we have to shift it out of\n        # that range to clamp it.\n        headYawPreviousTick = headYaw\n        headYaw = Math.max Math.PI - 1, Math.min Math.PI + 1, misc.wrapAngle Math.PI + stickAngle - yaw\n        headYaw -= Math.PI\n        headYaw = misc.interpolateAngle headYawPreviousTick, headYaw, 0.4, headYaw\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.4\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n        \n        shuffleTicks--\n        ticksSinceLeft++\n        ticksSinceRight++\n        while walked > 5 or shuffleTicks < 0\n            shuffleTicks = 5\n            walked -= 5\n            if (not inDeadzone) or moving\n                vector.normalize velocity, offset\n                vector.multiply.byScalar offset, 5, offset\n            else\n                offset[0] = offset[1] = offset[2] = 0\n            foot = switch foot\n                when \"left\"\n                    matrix.applyToVector playerPoseNew.torso, [-2, -10, 0], leftFoot\n                    vector.add.vector offset, leftFoot, leftFoot\n                    plane.project triangle.plane, leftFoot, leftFoot\n                    ticksSinceLeft = 0\n                    \"right\"\n                when \"right\"\n                    matrix.applyToVector playerPoseNew.torso, [2, -10, 0], rightFoot\n                    vector.add.vector offset, rightFoot, rightFoot\n                    plane.project triangle.plane, rightFoot, rightFoot\n                    ticksSinceRight = 0\n                    \"left\"\n        \n        if inDeadzone\n            leftHand[0] = -6\n            rightHand[0] = 6\n            leftHand[1] = rightHand[1] = -4\n            leftHand[2] = rightHand[2] = 0\n        else\n            yScale = 7 \/ (1 + speed)\n            rightHand[0] = 2 + (Math.min 4, speed)\n            leftHand[0] = -rightHand[0]\n            \n            leftHand[1] = rightHand[1] = 3\n            motion = Math.pow (Math.cos ticksSinceLeft * 0.25) * 0.5 + 0.5, 4\n            leftHand[1] += yScale * motion\n            leftHand[2] = 1.5 + 6 * stickLength * motion\n            motion = Math.pow (Math.cos ticksSinceRight * 0.25) * 0.5 + 0.5, 4\n            rightHand[1] += yScale * motion\n            rightHand[2] = 1.5 + 6 * stickLength * motion\n            \n        matrix.applyToVector torsoTransform, leftHand, leftHand                \n        matrix.applyToVector torsoTransform, rightHand, rightHand\n        \n        leftHand[1] -= 2\n        rightHand[1] -= 2\n        \n        matrix.getX entityTransform, xAxis\n        matrix.getY entityTransform, yAxis\n        matrix.getZ entityTransform, zAxis\n        matrix.getTranslation entityTransform, cameraTarget\n        vector.multiply.byScalar yAxis, 18, offset\n        vector.add.vector cameraTarget, offset, cameraTarget\n        vector.multiply.byScalar zAxis, -20, offset\n        vector.add.vector cameraTarget, offset, cameraLocation\n        \n        vector.interpolate cameraTargetPreviousTick, cameraTarget, 0.6, cameraTarget\n        vector.interpolate cameraLocationPreviousTick, cameraLocation, 0.6, cameraLocation\n        \n        cameraTriangle = triangle\n        cameraTriangle = navmesh.constrain cameraLocation, cameraTriangle\n        cameraAltitude = (plane.distance cameraTriangle.plane, cameraLocation) - 4\n        if cameraAltitude < 0\n            vector.multiply.byScalar cameraTriangle.plane.normal, -cameraAltitude, offset\n            vector.add.vector offset, cameraLocation, cameraLocation\n        \n        ik.lookAt cameraLocation, cameraTarget, xAxis, cameraTransform\n        matrix.invert cameraTransform, cameraTransform\n        \n        if firstTick\n            matrix.copy cameraTransform, cameraTransformPreviousTick\n            vector.copy cameraLocation, cameraLocationPreviousTick\n            vector.copy cameraTarget, cameraTargetPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            vector.copy leftHand, leftHandPreviousTick\n            vector.copy rightHand, rightHandPreviousTick\n            firstTick = false\n            \n        lag = 0.15 + 0.4 \/ (1 + speed \/ 3)\n        if inDeadzone then lag = 0.2\n        vector.interpolate leftHandPreviousTick, leftHand, lag, leftHand\n        vector.interpolate rightHandPreviousTick, rightHand, lag, rightHand\n                   \n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n    \n        if not firstDraw\n            matrix.copy cameraTransformToDraw, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n        \n        matrix.interpolate cameraTransformPreviousTick, cameraTransform, progress, cameraTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, playerPoseNew.torso\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, -2.5, 0], start\n        matrix.getX playerPoseNew.torso, xAxis\n        ik.computeLimb start, leftFoot, 10, xAxis, playerPoseNew.legLeftUpper, playerPoseNew.legLeftLower\n        \n        matrix.applyToVector playerPoseNew.torso, [1.5, -2.5, 0], start\n        ik.computeLimb start, rightFoot, 10, xAxis, playerPoseNew.legRightUpper, playerPoseNew.legRightLower\n\n        matrix.getY playerPoseNew.torso, yAxis\n        vector.negate xAxis, xAxis\n        vector.interpolate xAxis, yAxis, 0.05, offset\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, 4, 0], start\n        vector.interpolate leftHandPreviousTick, leftHand, progress, leftHandToDraw\n        ik.computeLimb start, leftHandToDraw, 10, offset, playerPoseNew.armLeftUpper, playerPoseNew.armLeftLower\n        \n        vector.negate yAxis, yAxis\n        vector.interpolate xAxis, yAxis, 0.05, offset\n\n        matrix.applyToVector playerPoseNew.torso, [1.5, 4, 0], start\n        vector.interpolate rightHandPreviousTick, rightHand, progress, rightHandToDraw\n        ik.computeLimb start, rightHandToDraw, 10, offset, playerPoseNew.armRightUpper, playerPoseNew.armRightLower\n        \n        matrix.copy playerPoseNew.torso, playerPoseNew.head\n        matrix.translate [0, 6, 0], playerPoseNew.head, true\n        matrix.rotateY (misc.interpolate headYawPreviousTick, headYaw, progress), playerPoseNew.head, true\n        \n        if firstDraw\n            matrix.copy cameraTransformToDraw, cameraTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransformToDraw, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw character, playerPoseOld, playerPoseNew\n        \n        return\n        \n    module.exports = { load, tick, draw }","old_contents":"# game\n\nThis module contains your game logic.  Its methods are called by the \"index\"\nmodule to update the game state.\n\n    gamepad = require \".\/input\/gamepad.litcoffee\"\n    keyboard = require \".\/input\/keyboard.litcoffee\"\n    \n    context = require \".\/rendering\/context.litcoffee\"\n    cloud = require \".\/rendering\/cloud.litcoffee\"\n    matrix = require \".\/matrix.litcoffee\"\n    plane = require \".\/plane.litcoffee\"\n    misc = require \".\/misc.litcoffee\"\n    navmesh = require \".\/navmesh.litcoffee\"\n    vector = require \".\/vector.litcoffee\"\n    pose = require \".\/pose.litcoffee\"\n    ik = require \".\/ik.litcoffee\"\n       \n    triangle = undefined\n    \n    character = testMap = testNavmesh = undefined\n    characterData = require \".\/characters\/test\/cloud.coffee\"\n\n# load\nCalled before the first \"tick\"\/\"draw\" to load any resources needed by the game.\nExecute the argument when you have finished successfully.\n\n    load = (callback) ->\n        keyboard()\n        context.load()\n        cloud.load characterData, (character_) ->\n            character = character_\n            cloud.load (require \".\/tracks\/test\/geometry.msc\"), (testMap_) ->\n                testMap = testMap_\n                navmesh.load (require \".\/tracks\/test\/navmesh.msn\"), (testNavmesh_) ->\n                    testNavmesh = testNavmesh_\n                    triangle = testNavmesh[0]\n                    callback()\n                    return\n                return\n            return\n        return\n    \n# tick\nCalled at 20Hz to update game state.  Guaranteed to be called once between \n\"load\" and \"draw\".  May be called more or than once per call to \"draw\" or not at\nall.\n\n    firstTick = true\n    firstDraw = true\n    \n    entityTransform = []\n    entityTransformToDraw = []\n    entityTransformPreviousTick = []\n    entityTransformPreviousDraw = []\n    matrix.identity entityTransform\n    \n    playerPoseOld = pose.create characterData\n    playerPoseNew = pose.create characterData\n    \n    torsoTransform = []\n    torsoTransformToDraw = []\n    torsoTransformPreviousTick = []\n    torsoTransformPreviousDraw = []\n\n    surfaceCorrectedEntityTransform = []\n    matrix.identity surfaceCorrectedEntityTransform\n\n    cameraTransform = []\n    cameraTransformPreviousDraw = []\n    cameraLocation = []\n    cameraLocationPreviousDraw = []\n    cameraTarget = []\n    cameraTargetPreviousDraw = []\n    cameraSide = []\n    cameraSidePreviousDraw = [0, 0, 1]\n    matrix.identity cameraTransform\n    \n    torsoAltitude = 0\n\n    velocity = [0, 0, 0]    \n    xAxis = []\n    yAxis = []\n    zAxis = []\n    torsoXAxis = []\n    torsoZAxis = []\n    translation = []\n    targetForwardVelocity = []\n    targetSidewardVelocity = []\n    targetVelocity = []\n    torsoTranslation = []\n    \n    start = []\n    leftFoot = []\n    rightFoot = []\n    leftHand = []\n    leftHandPreviousTick = []\n    leftHandToDraw = []\n    rightHand = []\n    rightHandPreviousTick = []\n    rightHandToDraw = []\n    walked = 0\n    shuffleTicks = 0\n    foot = \"left\"\n    ticksSinceLeft = 0\n    ticksSinceRight = 0\n    offset = []\n    \n    yaw = 0\n    pitch = 0\n    headYawPreviousTick = headYaw = 0\n    \n    stick = [0, 0, 0]\n    stickAngle = 0\n    \n    edgeCallback = (edge) -> vector.flatten velocity, edge.plane.normal, velocity\n    \n    tick = ->        \n        if not firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            vector.copy leftHand, leftHandPreviousTick\n            vector.copy rightHand, rightHandPreviousTick\n            \n        matrix.translate velocity, entityTransform  \n        speed = vector.magnitude velocity\n        walked += speed\n        moving = speed > 2\n        \n        stick[0] = gamepad.right - gamepad.left\n        stick[1] = gamepad.forward - gamepad.backward\n        stickLength = vector.magnitude stick\n        \n        inDeadzone = stickLength < 0.1\n        \n        if inDeadzone \n            stick[0] = stick[1] = 0\n        else \n            stickAngle = Math.atan2 -stick[0], stick[1]\n            if stickLength > 1                \n                vector.divide.byScalar stick, stickLength, stick\n                stickLength = 1\n        \n        # Left\/right rotation.\n        matrix.rotateY (stick[0] * -0.1), entityTransform, true\n        \n        # Apply navmesh triangle collision.\n        matrix.getTranslation entityTransform, translation\n        triangle = navmesh.constrain translation, triangle, edgeCallback\n        \n        # Gravity.\n        velocity[1] -= 0.2\n        \n        # Forwards\/backwards movement.\n        matrix.getZ entityTransform, zAxis\n        \n        # Determine if we're underground.\n        altitude = plane.distance triangle.plane, translation\n        \n        if altitude < 0\n            velocity = velocity\n            plane.project triangle.plane, translation, translation\n            \n            # A \"bump\" when you land.\n            matrix.getY entityTransform, yAxis\n            impact = Math.abs (vector.dot triangle.plane.normal, velocity) * (vector.dot triangle.plane.normal, yAxis)\n            impact -= 1\n            if impact < 0 then impact = 0\n            impact *= 2\n            torsoAltitude -= impact\n            \n            # Reflecting the velocity against the hit surface but then \n            # flattening it has the effect that hitting a ramp bounces you up it\n            # but you don't bounce when falling onto the floor.\n            vector.reflect velocity, triangle.plane.normal, velocity\n            vector.flatten velocity, triangle.plane.normal, velocity\n        \n            if not inDeadzone\n                matrix.getX entityTransform, xAxis\n                vector.multiply.byScalar zAxis, (stick[1] * 10), targetForwardVelocity                \n                vector.multiply.byScalar xAxis, (stick[0] * 10), targetSidewardVelocity                \n                vector.add.vector targetForwardVelocity, targetSidewardVelocity, targetVelocity\n            else\n                targetVelocity[0] = targetVelocity[1] = targetVelocity[2] = 0\n            vector.interpolate velocity, targetVelocity, 0.05, velocity\n            \n        # Apply air resistance.\n        vector.multiply.byScalar velocity, 0.98, velocity\n        \n        # This section attempts to align the entity with the triangle surface.\n        \n        # We take the triangle's normal as the Y\/up axis.\n        \n        # First, flatten the Z\/forward axis onto the surface.\n        vector.flatten zAxis, triangle.plane.normal, zAxis\n        vector.normalize zAxis, zAxis\n        \n        # Then, find the X\/right axis which is perpendicular to the Z\/forward \n        # and Y\/up axes.\n        vector.cross triangle.plane.normal, zAxis, xAxis\n        matrix.setX xAxis, surfaceCorrectedEntityTransform\n        matrix.setY triangle.plane.normal, surfaceCorrectedEntityTransform\n        matrix.setZ zAxis, surfaceCorrectedEntityTransform\n        \n        # Blend between our current transform and the aligned one.\n        matrix.interpolate entityTransform, surfaceCorrectedEntityTransform, 0.1, entityTransform\n        \n        matrix.setTranslation translation, entityTransform\n        \n        matrix.copy entityTransform, torsoTransform\n        \n        torsoAltitude = misc.interpolate torsoAltitude, (12 - Math.min 2, (speed + if inDeadzone then 0 else 1.5)), 0.4\n        \n        matrix.getY entityTransform, yAxis\n        vector.multiply.byScalar yAxis, torsoAltitude, torsoTranslation\n        vector.add.vector torsoTranslation, translation, torsoTranslation\n        \n        yaw = misc.interpolateAngle yaw, stickAngle, 0.1, yaw\n        matrix.rotateY yaw, torsoTransform, true\n        \n        # Calculating the head angle relative to the torso is complicated by the\n        # stick angle being wrapped to 0...2PI, so we have to shift it out of\n        # that range to clamp it.\n        headYawPreviousTick = headYaw\n        headYaw = Math.max Math.PI - 1, Math.min Math.PI + 1, misc.wrapAngle Math.PI + stickAngle - yaw\n        headYaw -= Math.PI\n        headYaw = misc.interpolateAngle headYawPreviousTick, headYaw, 0.4, headYaw\n        \n        matrix.getZ torsoTransform, torsoZAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        matrix.getX torsoTransform, torsoXAxis # TODO: If the entity transform is ever non-identity at startup we'll need to initialize torsoTransform for this to be right in the first ticks.\n        pitch = misc.interpolate pitch, (0.5 * stickLength - 0.1 * vector.dot torsoZAxis, velocity), 0.4\n        matrix.rotateX pitch, torsoTransform, true\n        matrix.rotateZ (0.1 * vector.dot torsoXAxis, velocity), torsoTransform, true\n        \n        matrix.setTranslation torsoTranslation, torsoTransform\n        \n        shuffleTicks--\n        ticksSinceLeft++\n        ticksSinceRight++\n        while walked > 5 or shuffleTicks < 0\n            shuffleTicks = 5\n            walked -= 5\n            if (not inDeadzone) or moving\n                vector.normalize velocity, offset\n                vector.multiply.byScalar offset, 5, offset\n            else\n                offset[0] = offset[1] = offset[2] = 0\n            foot = switch foot\n                when \"left\"\n                    matrix.applyToVector playerPoseNew.torso, [-2, -10, 0], leftFoot\n                    vector.add.vector offset, leftFoot, leftFoot\n                    plane.project triangle.plane, leftFoot, leftFoot\n                    ticksSinceLeft = 0\n                    \"right\"\n                when \"right\"\n                    matrix.applyToVector playerPoseNew.torso, [2, -10, 0], rightFoot\n                    vector.add.vector offset, rightFoot, rightFoot\n                    plane.project triangle.plane, rightFoot, rightFoot\n                    ticksSinceRight = 0\n                    \"left\"\n        \n        if inDeadzone\n            leftHand[0] = -6\n            rightHand[0] = 6\n            leftHand[1] = rightHand[1] = -4\n            leftHand[2] = rightHand[2] = 0\n        else\n            yScale = 7 \/ (1 + speed)\n            rightHand[0] = 2 + (Math.min 4, speed)\n            leftHand[0] = -rightHand[0]\n            \n            leftHand[1] = rightHand[1] = 3\n            motion = Math.pow (Math.cos ticksSinceLeft * 0.25) * 0.5 + 0.5, 4\n            leftHand[1] += yScale * motion\n            leftHand[2] = 1.5 + 6 * stickLength * motion\n            motion = Math.pow (Math.cos ticksSinceRight * 0.25) * 0.5 + 0.5, 4\n            rightHand[1] += yScale * motion\n            rightHand[2] = 1.5 + 6 * stickLength * motion\n            \n        matrix.applyToVector torsoTransform, leftHand, leftHand                \n        matrix.applyToVector torsoTransform, rightHand, rightHand\n        \n        leftHand[1] -= 2\n        rightHand[1] -= 2\n        \n        if firstTick\n            matrix.copy entityTransform, entityTransformPreviousTick\n            matrix.copy torsoTransform, torsoTransformPreviousTick\n            vector.copy leftHand, leftHandPreviousTick\n            vector.copy rightHand, rightHandPreviousTick\n            firstTick = false\n            \n        lag = 0.15 + 0.4 \/ (1 + speed \/ 3)\n        if inDeadzone then lag = 0.2\n        vector.interpolate leftHandPreviousTick, leftHand, lag, leftHand\n        vector.interpolate rightHandPreviousTick, rightHand, lag, rightHand\n            \n        return\n  \n# draw\nCalled with the progress through the current frame (a number between 0 and 1) to \nredraw the scene.\n  \n    draw = (progress) ->     \n    \n        if not firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            matrix.copy torsoTransformToDraw, torsoTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            vector.copy cameraTarget, cameraTargetPreviousDraw\n            vector.copy cameraLocation, cameraLocationPreviousDraw\n        \n        matrix.interpolate entityTransformPreviousTick, entityTransform, progress, entityTransformToDraw\n        matrix.interpolate torsoTransformPreviousTick, torsoTransform, progress, playerPoseNew.torso\n        \n        matrix.getY entityTransformToDraw, yAxis\n        matrix.getZ entityTransformToDraw, zAxis\n        matrix.getTranslation entityTransformToDraw, cameraTarget\n        vector.multiply.byScalar yAxis, 18, offset\n        vector.add.vector cameraTarget, offset, cameraTarget\n        vector.multiply.byScalar zAxis, -20, offset\n        vector.add.vector cameraTarget, offset, cameraLocation\n        \n        vector.interpolate cameraTargetPreviousDraw, cameraTarget, 0.1, cameraTarget\n        vector.interpolate cameraLocationPreviousDraw, cameraLocation, 0.1, cameraLocation\n        \n        matrix.getX entityTransformToDraw, cameraSide\n        vector.interpolate cameraSidePreviousDraw, cameraSide, 0.1, cameraSide\n        vector.copy cameraSide, cameraSidePreviousDraw\n        \n        cameraTriangle = triangle\n        cameraTriangle = navmesh.constrain cameraLocation, cameraTriangle\n        cameraAltitude = (plane.distance cameraTriangle.plane, cameraLocation) - 4\n        if cameraAltitude < 0\n            vector.multiply.byScalar cameraTriangle.plane.normal, -cameraAltitude, offset\n            vector.add.vector offset, cameraLocation, cameraLocation\n        \n        ik.lookAt cameraLocation, cameraTarget, cameraSide, cameraTransform\n        matrix.invert cameraTransform, cameraTransform\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, -2.5, 0], start\n        matrix.getX playerPoseNew.torso, xAxis\n        ik.computeLimb start, leftFoot, 10, xAxis, playerPoseNew.legLeftUpper, playerPoseNew.legLeftLower\n        \n        matrix.applyToVector playerPoseNew.torso, [1.5, -2.5, 0], start\n        ik.computeLimb start, rightFoot, 10, xAxis, playerPoseNew.legRightUpper, playerPoseNew.legRightLower\n\n        matrix.getY playerPoseNew.torso, yAxis\n        vector.negate xAxis, xAxis\n        vector.interpolate xAxis, yAxis, 0.05, offset\n        \n        matrix.applyToVector playerPoseNew.torso, [-1.5, 4, 0], start\n        vector.interpolate leftHandPreviousTick, leftHand, progress, leftHandToDraw\n        ik.computeLimb start, leftHandToDraw, 10, offset, playerPoseNew.armLeftUpper, playerPoseNew.armLeftLower\n        \n        vector.negate yAxis, yAxis\n        vector.interpolate xAxis, yAxis, 0.05, offset\n\n        matrix.applyToVector playerPoseNew.torso, [1.5, 4, 0], start\n        vector.interpolate rightHandPreviousTick, rightHand, progress, rightHandToDraw\n        ik.computeLimb start, rightHandToDraw, 10, offset, playerPoseNew.armRightUpper, playerPoseNew.armRightLower\n        \n        matrix.copy playerPoseNew.torso, playerPoseNew.head\n        matrix.translate [0, 6, 0], playerPoseNew.head, true\n        matrix.rotateY (misc.interpolate headYawPreviousTick, headYaw, progress), playerPoseNew.head, true\n        \n        if firstDraw\n            matrix.copy entityTransformToDraw, entityTransformPreviousDraw\n            matrix.copy cameraTransform, cameraTransformPreviousDraw\n            pose.copy playerPoseNew, playerPoseOld\n            vector.copy cameraTarget, cameraTargetPreviousDraw\n            vector.copy cameraLocation, cameraLocationPreviousDraw\n            firstDraw = false\n            \n        context.begin 0, 0, context.width, context.height, 1, cameraTransformPreviousDraw, cameraTransform, 0.1, 0.5, 0.9\n        cloud.draw testMap\n        cloud.draw character, playerPoseOld, playerPoseNew\n        \n        return\n        \n    module.exports = { load, tick, draw }","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"865192782464b5f957ed139129668cf7431d90e1","subject":"Removed convertToHTML middleware","message":"Removed convertToHTML middleware\n","repos":"laconalabs\/elliptical,lacona\/lacona","old_file":"src\/lacona.litcoffee","new_file":"src\/lacona.litcoffee","new_contents":"#Includes\n\n\t{EventEmitter} = require 'events'\n\tasync = require 'async'\n\tutil = require 'util'\n\t_ = require 'lodash'\n\n\tElementFactory = require '.\/element-factory'\n\tPhrase = require '.\/phrase'\n\tInputOption = require '.\/input-option'\n\n#Lacona\n\n\tclass Parser extends EventEmitter\n\t\tconstructor: (@options) ->\n\t\t\t@phrases = []\n\n\t\t\t@middleware = []\n\n\t\t\t@understand require('.\/plugins\/literal')\n\t\t\t@understand require('.\/plugins\/freetext')\n\t\t\t@understand require('.\/plugins\/integer')\n\t\t\t@understand require('.\/plugins\/date')\n\t\t\t@understand require('.\/plugins\/validator')\n\t\t\t@understand require('.\/plugins\/suggester')\n\t\t\t@understand require('.\/plugins\/list')\n\n\t\t_phraseAccessor: (name) =>\n\t\t\t_.filter @phrases, (phrase) ->\n\t\t\t\tphrase.name is name or name in phrase.extends\n\n###`understand`\n\n`understand` takes a schema and scope, and defines a set of words for Lacona to understand\n\n\t\tunderstand: (options) ->\n\t\t\tscope = options.scope\n\t\t\tschema = options.schema ? options\n\t\t\tif not util.isArray(schema)\n\t\t\t\tschema = [schema]\n\t\t\tfor phrase in schema\n\t\t\t\telementFactory = new ElementFactory(scope, @)\n\t\t\t\t@phrases.push new Phrase(phrase, scope, elementFactory)\n\t\t\treturn @\n\n###`use`\n\n`use` defines middleware. It must be passed a function that accepts 2 arguments, an inputOption,\nand a callback that should be passed an error (or null) and a modulated inputOption. This will be passed\nto the `data` event (or the next middleware) rather than the inputOption itself.\n\n\t\tuse: (next) ->\n\t\t\t@middleware.push next\n\t\t\treturn @\n\n\t\tparse: (inputText, lang) ->\n\t\t\tlang = lang ? window?.navigator?.language?.replace?('-', '_') ? process?.env?.LANG?.split?('.')?[0] ? 'default' #ALL THE QUESTION MARKS\n\n\t\t\tasync.each _.filter(@phrases, (item) -> item.run?), (phrase, done) =>\n\t\t\t\tinput = new InputOption(phrase, inputText)\n\t\t\t\tphrase.parse input, lang, null, (option) =>\n\t\t\t\t\tif option.text is ''\n\t\t\t\t\t\tasync.eachSeries @middleware, (call, done) =>\n\t\t\t\t\t\t\tcall option, done\n\t\t\t\t\t\t, (err) =>\n\t\t\t\t\t\t\treturn done(err) if err?\n\t\t\t\t\t\t\t@emit 'data', option\n\t\t\t\t, done\n\n\t\t\t, (err) =>\n\t\t\t\tif err?\n\t\t\t\t\t@emit 'error', err\n\t\t\t\telse\n\t\t\t\t\t@emit 'end'\n\t\t\treturn @\n\n\t\trun: (inputOption, done) ->\n\t\t\tinputOption.sentence.scope[inputOption.sentence.run](inputOption.result, done)\n\n\n\n\tmodule.exports =\n\t\tParser: Parser\n","old_contents":"#Includes\n\n\t{EventEmitter} = require 'events'\n\tasync = require 'async'\n\tutil = require 'util'\n\t_ = require 'lodash'\n\n\tElementFactory = require '.\/element-factory'\n\tPhrase = require '.\/phrase'\n\tInputOption = require '.\/input-option'\n\n#Lacona\n\n\tclass Parser extends EventEmitter\n\t\tconstructor: (@options) ->\n\t\t\t@phrases = []\n\n\t\t\t@middleware = []\n\n\t\t\t@understand require('.\/plugins\/literal')\n\t\t\t@understand require('.\/plugins\/freetext')\n\t\t\t@understand require('.\/plugins\/integer')\n\t\t\t@understand require('.\/plugins\/date')\n\t\t\t@understand require('.\/plugins\/validator')\n\t\t\t@understand require('.\/plugins\/suggester')\n\t\t\t@understand require('.\/plugins\/list')\n\n\t\t_phraseAccessor: (name) =>\n\t\t\t_.filter @phrases, (phrase) ->\n\t\t\t\tphrase.name is name or name in phrase.extends\n\n###`understand`\n\n`understand` takes a schema and scope, and defines a set of words for Lacona to understand\n\n\t\tunderstand: (options) ->\n\t\t\tscope = options.scope\n\t\t\tschema = options.schema ? options\n\t\t\tif not util.isArray(schema)\n\t\t\t\tschema = [schema]\n\t\t\tfor phrase in schema\n\t\t\t\telementFactory = new ElementFactory(scope, @)\n\t\t\t\t@phrases.push new Phrase(phrase, scope, elementFactory)\n\t\t\treturn @\n\n###`use`\n\n`use` defines middleware. It must be passed a function that accepts 2 arguments, an inputOption,\nand a callback that should be passed an error (or null) and a modulated inputOption. This will be passed\nto the `data` event (or the next middleware) rather than the inputOption itself.\n\n\t\tuse: (next) ->\n\t\t\t@middleware.push next\n\t\t\treturn @\n\n\t\tparse: (inputText, lang) ->\n\t\t\tlang = lang ? window?.navigator?.language?.replace?('-', '_') ? process?.env?.LANG?.split?('.')?[0] ? 'default' #ALL THE QUESTION MARKS\n\n\t\t\tasync.each _.filter(@phrases, (item) -> item.run?), (phrase, done) =>\n\t\t\t\tinput = new InputOption(phrase, inputText)\n\t\t\t\tphrase.parse input, lang, null, (option) =>\n\t\t\t\t\tif option.text is ''\n\t\t\t\t\t\tasync.eachSeries @middleware, (call, done) =>\n\t\t\t\t\t\t\tcall option, done\n\t\t\t\t\t\t, (err) =>\n\t\t\t\t\t\t\treturn done(err) if err?\n\t\t\t\t\t\t\t@emit 'data', option\n\t\t\t\t, done\n\n\t\t\t, (err) =>\n\t\t\t\tif err?\n\t\t\t\t\t@emit 'error', err\n\t\t\t\telse\n\t\t\t\t\t@emit 'end'\n\t\t\treturn @\n\n\t\trun: (inputOption, done) ->\n\t\t\tinputOption.sentence.scope[inputOption.sentence.run](inputOption.result, done)\n\n\n\tconvertToHTML = (inputOption, done) ->\n\t\thtml = '<div class=\"option\">'\n\t\thtml += '<span class=\"match\">'\n\t\tfor match in inputOption.match\n\t\t\thtml += \"<span class='word #{match.partOfSpeech}'>#{match.string}<\/span>\"\n\t\thtml += '<\/span><span class=\"suggestion\">'\n\t\tfor suggestion in inputOption.suggestion.words\n\t\t\thtml += \"<span class='word #{suggestion.partOfSpeech}'>#{suggestion.string}<\/span>\"\n\t\thtml += '<\/span><span class=\"completion\">'\n\t\tfor completion in inputOption.completion\n\t\t\thtml += \"<span class='word #{completion.partOfSpeech}'>#{completion.string}<\/span>\"\n\t\thtml += '<\/span><\/div>'\n\n\t\tinputOption.html = html\n\t\tdone()\n\n\tmodule.exports =\n\t\tParser: Parser\n\t\tconvertToHTML: convertToHTML\n\n","returncode":0,"stderr":"","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"86ce553b81e672fae2a619402e4c9500c0b643fd","subject":"little tweaking","message":"little tweaking\n","repos":"laktek\/litcoffee-content-handler","old_file":"lib\/punch-literate-coffee-content-handler.litcoffee","new_file":"lib\/punch-literate-coffee-content-handler.litcoffee","new_contents":"# Literate Coffee Content Handler for Punch\n\n## What is Literate Programming?\n\t\n> \"Write what disturbs you, what you fear, what you have not been willing to speak about. Be willing to be split open.\" - **Natalie Goldberg**\n\nLiterate Programming is a way to construct your programs similar to the way you write any other prose, following your train of thoughts. Instead of jumping directly to the mechanical process of coding, you structure your program as a human readable document. The implementations of the ideas are done alongside the description. \n\nConcept of Literate programming was first introduced by Donald Knuth in 1970s as an alternative to structured programming. Recently, this technique was resurfaced with the introduction of \"Literate CoffeeScript\" mode introduced in CoffeeScript 1.5.\n\n## How I do Literate Programming?\n\nAs you could see this program is done using the Literate Programming. Here's how my flow looked like.\n\n* Start with a blank canvas.\n* [Distraction-free mode in Vim](http:\/\/www.laktek.com\/2012\/09\/05\/distraction-free-writing-with-vim\/) can be helpful.\n* Type whatever comes to your mind, be it prose or code.\n* Use markdown formatting to structure the document. Code blocks needs to indent with 4-spaces.\n* Write as you would explain it to a friend sitting next to you (imaginery pair-programming)\n* CoffeeScript's syntax compliments to this type of programming. No commas, no brackets, short functions, variable scoping.\n\n## What's this project? \n\n\t\tLitCoffeeHandler = module.exports = {}\n\nThis is a custom content handler for Punch, to handle Literate CoffeeScript. It will produce human readable HTML pages from the markdown and machine executable JS from the coffeeScript code blocks.\n\nThis could be useful for:\n* Generating documentation for your library\n* To write code tutorials (automatically provide the source)\n\nThis works on top of Punch's default content handler. The content requests, that cannot be handled by this will be delegated to default content handler.\n\n\t\tDefaultContentHandler = require('punch').ContentHandler\n\n## Setup\n\nBy convention, we expect the source files (`litcoffee` files) of a project to be found in the `src` path.\n\n\t\tLitCoffeeHandler.srcPath = 'src'\n\nPunch calls the `setup` function of each configured plugin at the start, along with [project's configuration](https:\/\/github.com\/laktek\/punch\/wiki\/Configuration-Options). We can allow users to override the default path by providing a custom path in project's config.\n\n\t\tmoduleUtils = require('punch').Utils.Module\n\n\t\tLitCoffeeHandler.setup = (config) ->\n\t\t\tif user_defined_path = config.litcoffee?.path\n\t\t\t\tLitCoffeeHandler.srcPath = user_defined_path \n\nWe need to delegate certain functions to `DefaultContentHandler`, so let's setup it as well.\n\n\t\t\tDefaultContentHandler.setup config\n\nLet's setup the markdown parser, based on what has been configured.\n\n\t\t\tLitCoffeeHandler.markdownParser = moduleUtils.requireAndSetup config.plugins.parsers['.markdown'], config\n\n## Negotiating Content\n\nPunch's page renderer will call `negotiateContent` function when user requests content. We shall check if we can serve the content. \n\n\t\tfs = require 'fs'\n\t\tpath = require 'path'\n\n\t\tLitCoffeeHandler.negotiateContent = (request_path, file_extension, options, callback) -> \n\t\t\tfile_path = path.join(LitCoffeeHandler.srcPath, \"#{request_path}.litcoffee\") \n\t\t\tfs.stat file_path, (err, stats) -> \n\nIf no file found, we'll delegate the handling to the `DefaultContentHandler`. \n\n\t\t\t\tif err\n\t\t\t\t\treturn DefaultContentHandler.negotiateContent(request_path, file_extension, options, callback)\n\nGet the file's modified date from the stats.\n\t\n\t\t\t\tmodified_date = stats.mtime\n\nIf there's a matching `litcoffee` file available in path, then we have to decide what to do with it based on user's request. \n* If the user requests for a HTML page, we'll parse the markdown. \n* If she requests for JS, we'll compile it using CoffeeScript compiler. \n* If the requested type is not something we can handle, again we'll delegate it to `DefaultContentHandler`.\n\n\t\t\t\tif file_extension == '.html'\n\t\t\t\t\tparseMarkdown file_path, modified_date, callback\n\t\t\t\telse if file_extension == '.js'\n\t\t\t\t\tcompileToJs file_path, modified_date, callback\n\t\t\t\telse\n\t\t\t\t\tDefaultContentHandler.negotiateContent(request_path, file_extension, options, callback)\n\n## Parse Markdown\n\nTo parse the markdown file, we should use the configured markdown parser. Result should be presented as a JSON object. The parsed content will be assigned to a key named `content`. This is what should be used in the templates to render the parsed content.\n\n\t\tLitCoffeeHandler.markdownParser = null\n\n\t\tparseMarkdown = (file_path, modified_date, callback) ->\n\t\t\tfs.readFile file_path, (err, litcoffee) ->\n\t\t\t\tif err\n\t\t\t\t\treturn callback(err)\n\n\t\t\t\tLitCoffeeHandler.markdownParser.parse litcoffee.toString(), (err, parsed_output) ->\n\t\t\t\t\tif err\n\t\t\t\t\t\treturn callback err, {}, {}, modified_date\n\n\t\t\t\t\tcallback null, { 'content': parsed_output }, {}, modified_date\n\n## Compile to JS\n\nTo compile LiterateCoffee files, we should get the configured CoffeeScript compiler. Similar to parsed markdown content, this will also be presented in a JSON object (with output assigned to a key named `content`). To serve this as a JS file, user should create a mustache template with the tag `{{{content}}}` (named `_layout.js.mustache`).\n\n\t\tCoffeeScript = require('coffee-script')\n\t\t\n\t\tcompileToJs = (file_path, modified_date, callback) ->\n\t\t\tfs.readFile file_path, (err, litcoffee) ->\n\t\t\t\tif err\n\t\t\t\t\treturn callback(err)\n\n\t\t\t\ttry\n\t\t\t\t\tparsed_output = CoffeeScript.compile litcoffee.toString(), { filename: file_path, literate: true }, (err, parsed_output) ->\n\t\t\t\t\tcallback null, { 'content': parsed_output }, {}, modified_date\n\t\t\t\tcatch err\n\t\t\t\t\treturn callback err, {}, {}, modified_date\n\n## Get Content Paths\n\nPunch uses `getContentPaths` functions to identify all available pages for it to generate. We traverse the source directory and create an array containing the paths of the `litcoffee` files. We ignore any hidden files or directories.\n\n\t\t_ = require('underscore')\n\n\t\tLitCoffeeHandler.getContentPaths = (basepath, callback) ->\n\t\t\tcollected_paths = []\n\n\t\t\tfs.readdir path.join(process.cwd(), LitCoffeeHandler.srcPath), (err, files) ->\n\t\t\t\t_.each files, (file) ->\n\t\t\t\t\tif file.indexOf '.litcoffee' > 0\n\t\t\t\t\t\tbasename = file.split('.').shift()\n\t\t\t\t\t\tcollected_paths.push \"#{basename}.html\"\n\t\t\t\t\t\tcollected_paths.push \"#{basename}.js\"\n\t\t\t\t\n\t\t\t\tcallback null, collected_paths\n\n## Is Section?\n\nPunch calls `isSection` to check if there's an implicit index page to be rendered for the given path. We're leaving the section handling to the default content handler.\n\n\t\tLitCoffeeHandler.isSection = (basepath) ->\n\t\t\tDefaultContentHandler.isSection(basepath)\n\n## Get Sections \n\nPunch calls `getSections` to get all available sections under content. Since we don't handle sections let's delegate that also to default content handler.\n\n\t\tLitCoffeeHandler.getSections = (callback) ->\n\t\t\tDefaultContentHandler.getSections(callback)\n\n## Inspiration\n\n* [Journo & Literate CoffeeScript](http:\/\/ashkenas.com\/literate-coffeescript\/)\n* [Codd - building immutable SQL queries from relational primitives](https:\/\/gist.github.com\/grncdr\/5039898)\n* [TOML parser for JavaScript](https:\/\/github.com\/JonAbrams\/tomljs\/blob\/master\/toml.litcoffee)\n\n## Further Reading\n\n* [Literate Programming on Wikipedia](http:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n","old_contents":"# Literate Coffee Content Handler for Punch\n\n## What is Literate Programming?\n\t\n> \"Write what disturbs you, what you fear, what you have not been willing to speak about. Be willing to be split open.\" - **Natalie Goldberg**\n\nLiterate Programming is a way to construct your programs similar to the way you write any other prose, following your train of thoughts. Instead of jumping directly to the mechanical process of coding, you structure your program as a human readable document. The implementations of the ideas are done alongside the description. \n\nConcept of Literate programming was first introduced by Donald Knuth in 1970s as an alternative to structured programming. Recently, this technique was resurfaced with the introduction of \"Literate CoffeeScript\" mode introduced in CoffeeScript 1.5.\n\n## How I do Literate Programming?\n\nAs you could see this program is done using the Literate Programming. Here's how my flow looked like.\n\n* Start with a blank paper.\n* Use [Distraction-free mode in Vim](http:\/\/www.laktek.com\/2012\/09\/05\/distraction-free-writing-with-vim\/).\n* Type whatever comes to your mind, be it prose or code.\n* Use markdown formatting to structure the document. Code blocks needs to indent with 4-spaces.\n* Write as you would explain it to a friend sitting next to you (imaginery pair-programming)\n* CoffeeScript's syntax compliments to this type of programming. No commas, no brackets, short functions, variable scoping.\n\n## What's this project? \n\n\t\tLitCoffeeHandler = module.exports = {}\n\nThis is a custom content handler for Punch, to handle Literate CoffeeScript. It will produce human readable HTML pages from the markdown and machine executable JS from the coffeeScript code blocks.\n\nThis could be useful for:\n* Generating documentation for your library\n* To write code tutorials (automatically provide the source)\n\nThis works on top of Punch's default content handler. The content requests, that cannot be handled by this will be delegated to default content handler.\n\n\t\tDefaultContentHandler = require('punch').ContentHandler\n\n## Setup\n\nBy convention, we expect the source files (`litcoffee` files) of a project to be found in the `src` path.\n\n\t\tLitCoffeeHandler.srcPath = 'src'\n\nPunch calls the `setup` function of each configured plugin at the start, along with [project's configuration](https:\/\/github.com\/laktek\/punch\/wiki\/Configuration-Options). We can allow users to override the default path by providing a custom path in project's config.\n\n\t\tmoduleUtils = require('punch').Utils.Module\n\n\t\tLitCoffeeHandler.setup = (config) ->\n\t\t\tif user_defined_path = config.litcoffee?.path\n\t\t\t\tLitCoffeeHandler.srcPath = user_defined_path \n\nWe need to delegate certain functions to `DefaultContentHandler`, so let's setup it as well.\n\n\t\t\tDefaultContentHandler.setup config\n\nLet's setup the markdown parser, based on what has been configured.\n\n\t\t\tLitCoffeeHandler.markdownParser = moduleUtils.requireAndSetup config.plugins.parsers['.markdown'], config\n\n## Negotiating Content\n\nPunch's page renderer will call `negotiateContent` function when user requests content. We shall check if we can serve the content. \n\n\t\tfs = require 'fs'\n\t\tpath = require 'path'\n\n\t\tLitCoffeeHandler.negotiateContent = (request_path, file_extension, options, callback) -> \n\t\t\tfile_path = path.join(LitCoffeeHandler.srcPath, \"#{request_path}.litcoffee\") \n\t\t\tfs.stat file_path, (err, stats) -> \n\nIf no file found, we'll delegate the handling to the `DefaultContentHandler`. \n\n\t\t\t\tif err\n\t\t\t\t\treturn DefaultContentHandler.negotiateContent(request_path, file_extension, options, callback)\n\nGet the file's modified date from the stats.\n\t\n\t\t\t\tmodified_date = stats.mtime\n\nIf there's a matching `litcoffee` file available in path, then we have to decide what to do with it based on user's request. \n* If the user requests for a HTML page, we'll parse the markdown. \n* If she requests for JS, we'll compile it using CoffeeScript compiler. \n* If the requested type is not something we can handle, again we'll delegate it to `DefaultContentHandler`.\n\n\t\t\t\tif file_extension == '.html'\n\t\t\t\t\tparseMarkdown file_path, modified_date, callback\n\t\t\t\telse if file_extension == '.js'\n\t\t\t\t\tcompileToJs file_path, modified_date, callback\n\t\t\t\telse\n\t\t\t\t\tDefaultContentHandler.negotiateContent(request_path, file_extension, options, callback)\n\n## Parse Markdown\n\nTo parse the markdown file, we should use the configured markdown parser. Result should be presented as a JSON object. The parsed content will be assigned to a key named `content`. This is what should be used in the templates to render the parsed content.\n\n\t\tLitCoffeeHandler.markdownParser = null\n\n\t\tparseMarkdown = (file_path, modified_date, callback) ->\n\t\t\tfs.readFile file_path, (err, litcoffee) ->\n\t\t\t\tif err\n\t\t\t\t\treturn callback(err)\n\n\t\t\t\tLitCoffeeHandler.markdownParser.parse litcoffee.toString(), (err, parsed_output) ->\n\t\t\t\t\tif err\n\t\t\t\t\t\treturn callback err, {}, {}, modified_date\n\n\t\t\t\t\tcallback null, { 'content': parsed_output }, {}, modified_date\n\n## Compile to JS\n\nTo compile LiterateCoffee files, we should get the configured CoffeeScript compiler. Similar to parsed markdown content, this will also be presented in a JSON object (with output assigned to a key named `content`). To serve this as a JS file, user should create a mustache template with the tag `{{{content}}}` (named `_layout.js.mustache`).\n\n\t\tCoffeeScript = require('coffee-script')\n\t\t\n\t\tcompileToJs = (file_path, modified_date, callback) ->\n\t\t\tfs.readFile file_path, (err, litcoffee) ->\n\t\t\t\tif err\n\t\t\t\t\treturn callback(err)\n\n\t\t\t\ttry\n\t\t\t\t\tparsed_output = CoffeeScript.compile litcoffee.toString(), { filename: file_path, literate: true }, (err, parsed_output) ->\n\t\t\t\t\tcallback null, { 'content': parsed_output }, {}, modified_date\n\t\t\t\tcatch err\n\t\t\t\t\treturn callback err, {}, {}, modified_date\n\n## Get Content Paths\n\nPunch uses `getContentPaths` functions to identify all available pages for it to generate. We traverse the source directory and create an array containing the paths of the `litcoffee` files. We ignore any hidden files or directories.\n\n\t\t_ = require('underscore')\n\n\t\tLitCoffeeHandler.getContentPaths = (basepath, callback) ->\n\t\t\tcollected_paths = []\n\n\t\t\tfs.readdir path.join(process.cwd(), LitCoffeeHandler.srcPath), (err, files) ->\n\t\t\t\t_.each files, (file) ->\n\t\t\t\t\tif file.indexOf '.litcoffee' > 0\n\t\t\t\t\t\tbasename = file.split('.').shift()\n\t\t\t\t\t\tcollected_paths.push \"#{basename}.html\"\n\t\t\t\t\t\tcollected_paths.push \"#{basename}.js\"\n\t\t\t\t\n\t\t\t\tcallback null, collected_paths\n\n## Is Section?\n\nPunch calls `isSection` to check if there's an implicit index page to be rendered for the given path. We're leaving the section handling to the default content handler.\n\n\t\tLitCoffeeHandler.isSection = (basepath) ->\n\t\t\tDefaultContentHandler.isSection(basepath)\n\n## Get Sections \n\nPunch calls `getSections` to get all available sections under content. Since we don't handle sections let's delegate that also to default content handler.\n\n\t\tLitCoffeeHandler.getSections = (callback) ->\n\t\t\tDefaultContentHandler.getSections(callback)\n\n## Inspiration\n\n* [Journo & Literate CoffeeScript](http:\/\/ashkenas.com\/literate-coffeescript\/)\n* [Codd - building immutable SQL queries from relational primitives](https:\/\/gist.github.com\/grncdr\/5039898)\n* [TOML parser for JavaScript](https:\/\/github.com\/JonAbrams\/tomljs\/blob\/master\/toml.litcoffee)\n\n## Further Reading\n\n* [Literate Programming on Wikipedia](http:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d50426c4416c8f3ae36f2b642d1fc896c495c809","subject":"fix set observer typo","message":"fix set observer typo\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/05d_set_observer.litcoffee","new_file":"docs\/05d_set_observer.litcoffee","new_contents":"# \/api\/Data Structures\/Batman.Set\/Batman.SetObserver\n\n`Batman.SetObserver` is a utility for observing `Batman.Set`s and their contents (especially if their contents are `Batman.Object`s). It extends `Batman.Object`. In the wild, `Batman.SetProxy` uses a `Batman.SetObserver` to track its base set and `Batman.SetSort` uses item tracking to maintain its order.\n\nA few other points about `Batman.SetObserver`:\n\n- It fires `itemsWereAdded` and `itemsWereRemoved` when its base `Batman.Set` fires those events.\n- When items are added and removed to the base Set, they're automatically observed with `startObservingItems`\/`stopObservingItems` -- you don't have to set that up yourself.\n- Override `observedItemKeys` and `observerForItemAndKey` to track properties of `Batman.Object` members of the set.\n\n## ::constructor(base : Set) : SetObserver\n\nReturns a new `Batman.SetObserver` tracking `base`.\n\n## ::.base : Set\n\nThe set being tracked by the observer.\n\n## ::.observedItemKeys[=[]]: Array\n\nIf you set `observedItemKeys` to an array of strings, those keys will be observed on the members of `base`. When those keys change, the provided observer (see `observerForItemAndKey`) will be called.\n\n## ::observerForItemAndKey(item : Batman.Object, key : String) : Function\n\nWhen you instantiate a `SetObserver`, you should override this function. When the observer starts observing an item, this function will be called for each `key` in `observedItemKeys`. It should return an observer function for `key`. The observer function will be passed `newValue, oldValue`.\n\n## ::startObserving()\n\nStarts observing the `base` and all its members.\n\n## ::stopObserving()\n\nStops observing the `base` and all its members.\n\n## ::startObservingItems(items : Array)\n\nAdds observers for `observedItemKeys` on each item in `items`, calling `observerForItemAndKey` for each key in `observedItemKeys`\n\n## ::stopObservingItems(items : Array)\n\nForgets observers on `items`.\n\n","old_contents":"# \/api\/Data Structures\/Batman.Set\/Batman.SetObserver\n\n`Batman.SetObserver` is a utility for observing `Batman.Set`s and their contents (especially if their contents are `Batman.Object`s). It extends `Batman.Object`. In the wild, `Batman.SetProxy` uses a `Batman.SetObserver` to track its base set and `Batman.SetSort` uses item tracking to maintain its order.\n\nA few other points about `Batman.SetObserver`:\n\n- It fires `itemsWereAdded` and `itemsWereRemoved` when its base `Batman.Set` fires those events.\n- When items are added and removed to the base Set, they're automatically observed with `startObservingItems`\/`stopObservingItems` -- you don't have to set that up yourself.\n- Override `observedItemKeys` and `observerForItemAndKey` to track properties of `Batman.Object` members of the set.\n\n## ::constructor(base : Set) : SetObserver\n\nReturns a new `Batman.SetObserver` tracking `base`.\n\n## ::.base : Set\n\nThe set being tracked by the observer.\n\n## ::.observedItemKeys[=[]]: Array\n\nIf you set `observedItemKeys` to an array of strings, those keys will be observed on the members of `base`. When those keys change, the provided observer (see `observerForItemAndKey`) will be called.\n\n## ::.observerForItemAndKey(item : Batman.Object, key : String) : Function\n\nWhen you instantiate a `SetObserver`, you should override this function. When the observer starts observing an item, this function will be called for each `key` in `observedItemKeys`. It should return an observer function for `key`. The observer function will be passed `newValue, oldValue`.\n\n## ::startObserving()\n\nStarts observing the `base` and all its members.\n\n## ::stopObserving()\n\nStops observing the `base` and all its members.\n\n## ::startObservingItems(items : Array)\n\nAdds observers for `observedItemKeys` on each item in `items`, calling `observerForItemAndKey` for each key in `observedItemKeys`\n\n## ::stopObservingItems(items : Array)\n\nForgets observers on `items`.\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"933d57719881dd4bee83bfc6350d84a4ca91c17c","subject":"Initial commit:100:","message":"Initial commit:100:\n\nOur thoughts inspired - by Albert Einstein.","repos":"BioQL\/BioQL,BioQL\/BioQL","old_file":"src\/gql\/readme.litcoffee","new_file":"src\/gql\/readme.litcoffee","new_contents":"gQL\u00ae: An efficient Genome Query Language.\n-----------------------------------------\n[![Apache License](https:\/\/img.shields.io\/badge\/license-Apache-blue.svg)](https:\/\/github.com\/BioQL\/BioQL\/blob\/master\/LICENSE)\n\n<i>Great spirits have always encountered violent opposition from mediocre minds<\/i> - <b>Albert Einstein<\/b>.\n","old_contents":"gQL\u00ae: An efficient Genome Query Language.\n-----------------------------------------\n[![Apache License](https:\/\/img.shields.io\/badge\/license-Apache-blue.svg)](https:\/\/github.com\/BioQL\/BioQL\/blob\/master\/LICENSE)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"8f4796d5b18548936daed309928dee2addc8e184","subject":"signal.setImmediate() added","message":"signal.setImmediate() added\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/signal\/index.litcoffee","new_file":"src\/signal\/index.litcoffee","new_contents":"# Signal\n\nSignal is a function with listeners which can be emitted.\n\nAccess it with:\n```javascript\nconst { signal } = Neft;\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n\n    pendingSignals = 0\n\n## *Integer* signal.STOP_PROPAGATION\n\nSpecial constant used to stop calling further listeners.\n\nMust be returned by the listener function.\n\n```javascript\nvar obj = {};\nsignal.create(obj, 'onPress');\n\nobj.onPress(function(){\n  console.log('listener 1');\n  return signal.STOP_PROPAGATION;\n});\n\n\/\/ this listener won't be called, because first listener will capture this signal\nobj.onPress(function(){\n  console.log('listener 2');\n});\n\nobj.onPress.emit();\n\/\/ listener 1\n```\n\n    STOP_PROPAGATION = exports.STOP_PROPAGATION = 1 << 30\n\n## *Signal* signal.create([*NotPrimitive* object, *String* name])\n\nCreates a new signal in the given object under the given name property.\n\nReturns created signal.\n\n```javascript\nvar obj = {};\n\nsignal.create(obj, 'onRename');\n\nobj.onRename.connect(function(){\n  console.log(arguments);\n});\n\nobj.onRename.emit('Max', 'George');\n\/\/ {0: \"Max\", 1: \"George\"}\n```\n\n    exports.create = (obj, name) ->\n        signal = createSignalFunction obj\n        if name is undefined\n            return signal\n\n        assert.isNotPrimitive obj, 'signal object cannot be primitive'\n        assert.isString name, 'signal name must be a string'\n        assert.notLengthOf name, 0, 'signal name cannot be an empty string'\n\n        assert not obj.hasOwnProperty(name)\n        , \"signal object has already defined the '#{name}' property\"\n\n        obj[name] = signal\n\n## *Boolean* signal.isEmpty(*Signal* signal)\n\nReturns `true` if the given signal has no listeners.\n\n    exports.isEmpty = (signal) ->\n        for func in signal.listeners by 2\n            if func isnt null\n                return false\n        return true\n\n## signal.setImmediate(*Function* callback)\n\nRegister a function which will be called when all pending signal emits will be finished.\n\nIf there is no pending emits, the given function is calling immediately.\n\n    immediate = []\n    exports.setImmediate = (callback) ->\n        assert.isFunction callback\n        if pendingSignals is 0\n            callback()\n        else\n            immediate.push callback\n\n    callSignal = (obj, listeners, arg1, arg2) ->\n        pendingSignals += 1\n\n        i = 0\n        n = listeners.length\n        result = 0\n        containsGaps = false\n        while i < n\n            func = listeners[i]\n            if func is null\n                containsGaps = true\n            else\n                ctx = listeners[i + 1]\n                if result <= 0 and func.call(ctx or obj, arg1, arg2) is STOP_PROPAGATION\n                    result = STOP_PROPAGATION\n                    if containsGaps\n                        break\n            i += 2\n\n        if containsGaps\n            shift = 0\n            while i < n\n                func = listeners[i]\n                if func is null\n                    shift -= 2\n                else if shift > 0\n                    assert.isNotDefined listeners[i + shift]\n                    assert.isNotDefined listeners[i + shift + 1]\n                    listeners[i + shift] = func\n                    listeners[i + shift + 1] = listeners[i + 1]\n                    listeners[i] = null\n                    listeners[i + 1] = null\n                i += 2\n\n        pendingSignals -= 1\n\n        if pendingSignals is 0\n            while callback = immediate.shift()\n                callback()\n\n        result\n\n    createSignalFunction = (obj) ->\n        handler = (listener, ctx) ->\n            handler.connect listener, ctx\n\n        handler.obj = obj\n        handler.listeners = []\n        utils.setPrototypeOf handler, SignalPrototype\n\n        handler\n\n    SignalPrototype =\n\n## Signal::emit([*Any* argument1, *Any* argument2])\n\nCall all of the signal listeners with the given arguments (2 maximally).\n\n        emit: (arg1, arg2) ->\n            assert.isFunction @, 'emit must be called on a signal function'\n            assert.isArray @listeners, 'emit must be called on a signal function'\n            assert.operator arguments.length, '<', 3, 'signal accepts maximally two parameters; use object instead'\n\n            callSignal @obj, @listeners, arg1, arg2\n\n## Signal::connect(*Function* listener, [*Any* context])\n\nAdds the given listener function into the signal listeners.\n\nBy default, the signal function works like this method.\n\n```javascript\nvar obj = {};\nsignal.create(obj, 'onPress');\n\nobj.onPress(function(){\n  console.log('listener 1');\n});\n\nobj.onPress.connect(function(){\n  console.log('listener 2');\n});\n\nobj.onPress.emit()\n\/\/ listener 1\n\/\/ listener 2\n```\n\nThe given context will be used as a context in listener calling.\nBy default, the listener is called with the object on which the signal is created.\n\n```javascript\nvar obj = {standard: true};\nsignal.create(obj, 'onPress');\n\nvar fakeContext = {fake: true};\nobj.onPress(function(){\n  console.log(this);\n}, fakeContext);\n\nobj.onPress(function(){\n  console.log(this);\n});\n\nobj.onPress.emit();\n\/\/ {fake: true}\n\/\/ {standard: true}\n```\n\n        connect: (listener, ctx = null) ->\n            assert.isFunction @, 'connect must be called on a signal function'\n            assert.isFunction listener, 'listener is not a function'\n\n            {listeners} = @\n\n            i = n = listeners.length\n            while (i -= 2) >= 0\n                if listeners[i] isnt null\n                    break\n\n            if i + 2 is n\n                listeners.push listener, ctx\n            else\n                assert.isNotDefined listeners[i + 2]\n                assert.isNotDefined listeners[i + 3]\n                listeners[i + 2] = listener\n                listeners[i + 3] = ctx\n\n            return\n\n## Signal::disconnect(*Function* listener, [*Any* context])\n\nReturns the given listener function from the signal listeners.\n\n```javascript\nvar obj = {};\n\nsignal.create(obj, 'onPress');\n\nvar listener = function(){\n  console.log('listener called!');\n};\n\nobj.onPress.connect(listener);\nobj.onPress.disconnect(listener);\n\nobj.onPress.emit()\n\/\/ no loggs...\n```\n\n        disconnect: (listener, ctx = null) ->\n            assert.isFunction @, 'disconnect must be called on a signal function'\n            assert.isFunction listener, 'listener is not a function'\n\n            {listeners} = @\n            index = 0\n\n            loop\n                index = listeners.indexOf listener, index\n                if index is -1 or listeners[index + 1] is ctx\n                    break\n                index += 2\n            assert.isNot index, -1, \"listener doesn't exist in this signal\"\n            assert.is listeners[index], listener\n            assert.is listeners[index + 1], ctx\n\n            listeners[index] = null\n            listeners[index + 1] = null\n\n            return\n\n## Signal::disconnectAll()\n\nRemoves all the signal listeners.\n\n        disconnectAll: ->\n            assert.isFunction @, 'disconnectAll must be called on a signal function'\n\n            {listeners} = @\n            for _, i in listeners\n                listeners[i] = null\n\n            return\n\n    exports.Emitter = require('.\/emitter')\n        create: exports.create\n        createSignalFunction: createSignalFunction\n        callSignal: callSignal\n","old_contents":"# Signal\n\nSignal is a function with listeners which can be emitted.\n\nAccess it with:\n```javascript\nconst { signal } = Neft;\n```\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    assert = require 'src\/assert'\n\n## *Integer* signal.STOP_PROPAGATION\n\nSpecial constant used to stop calling further listeners.\n\nMust be returned by the listener function.\n\n```javascript\nvar obj = {};\nsignal.create(obj, 'onPress');\n\nobj.onPress(function(){\n  console.log('listener 1');\n  return signal.STOP_PROPAGATION;\n});\n\n\/\/ this listener won't be called, because first listener will capture this signal\nobj.onPress(function(){\n  console.log('listener 2');\n});\n\nobj.onPress.emit();\n\/\/ listener 1\n```\n\n    STOP_PROPAGATION = exports.STOP_PROPAGATION = 1 << 30\n\n## *Signal* signal.create([*NotPrimitive* object, *String* name])\n\nCreates a new signal in the given object under the given name property.\n\nReturns created signal.\n\n```javascript\nvar obj = {};\n\nsignal.create(obj, 'onRename');\n\nobj.onRename.connect(function(){\n  console.log(arguments);\n});\n\nobj.onRename.emit('Max', 'George');\n\/\/ {0: \"Max\", 1: \"George\"}\n```\n\n    exports.create = (obj, name) ->\n        signal = createSignalFunction obj\n        if name is undefined\n            return signal\n\n        assert.isNotPrimitive obj, 'signal object cannot be primitive'\n        assert.isString name, 'signal name must be a string'\n        assert.notLengthOf name, 0, 'signal name cannot be an empty string'\n\n        assert not obj.hasOwnProperty(name)\n        , \"signal object has already defined the '#{name}' property\"\n\n        obj[name] = signal\n\n## *Boolean* signal.isEmpty(*Signal* signal)\n\nReturns `true` if the given signal has no listeners.\n\n    exports.isEmpty = (signal) ->\n        for func in signal.listeners by 2\n            if func isnt null\n                return false\n        return true\n\n    callSignal = (obj, listeners, arg1, arg2) ->\n        i = 0\n        n = listeners.length\n        result = 0\n        containsGaps = false\n        while i < n\n            func = listeners[i]\n            if func is null\n                containsGaps = true\n            else\n                ctx = listeners[i + 1]\n                if result <= 0 and func.call(ctx or obj, arg1, arg2) is STOP_PROPAGATION\n                    result = STOP_PROPAGATION\n                    if containsGaps\n                        break\n            i += 2\n\n        if containsGaps\n            shift = 0\n            while i < n\n                func = listeners[i]\n                if func is null\n                    shift -= 2\n                else if shift > 0\n                    assert.isNotDefined listeners[i + shift]\n                    assert.isNotDefined listeners[i + shift + 1]\n                    listeners[i + shift] = func\n                    listeners[i + shift + 1] = listeners[i + 1]\n                    listeners[i] = null\n                    listeners[i + 1] = null\n                i += 2\n\n        return result\n\n    createSignalFunction = (obj) ->\n        handler = (listener, ctx) ->\n            handler.connect listener, ctx\n\n        handler.obj = obj\n        handler.listeners = []\n        utils.setPrototypeOf handler, SignalPrototype\n\n        handler\n\n    SignalPrototype =\n\n## Signal::emit([*Any* argument1, *Any* argument2])\n\nCall all of the signal listeners with the given arguments (2 maximally).\n\n        emit: (arg1, arg2) ->\n            assert.isFunction @, 'emit must be called on a signal function'\n            assert.isArray @listeners, 'emit must be called on a signal function'\n            assert.operator arguments.length, '<', 3, 'signal accepts maximally two parameters; use object instead'\n\n            callSignal @obj, @listeners, arg1, arg2\n\n## Signal::connect(*Function* listener, [*Any* context])\n\nAdds the given listener function into the signal listeners.\n\nBy default, the signal function works like this method.\n\n```javascript\nvar obj = {};\nsignal.create(obj, 'onPress');\n\nobj.onPress(function(){\n  console.log('listener 1');\n});\n\nobj.onPress.connect(function(){\n  console.log('listener 2');\n});\n\nobj.onPress.emit()\n\/\/ listener 1\n\/\/ listener 2\n```\n\nThe given context will be used as a context in listener calling.\nBy default, the listener is called with the object on which the signal is created.\n\n```javascript\nvar obj = {standard: true};\nsignal.create(obj, 'onPress');\n\nvar fakeContext = {fake: true};\nobj.onPress(function(){\n  console.log(this);\n}, fakeContext);\n\nobj.onPress(function(){\n  console.log(this);\n});\n\nobj.onPress.emit();\n\/\/ {fake: true}\n\/\/ {standard: true}\n```\n\n        connect: (listener, ctx = null) ->\n            assert.isFunction @, 'connect must be called on a signal function'\n            assert.isFunction listener, 'listener is not a function'\n\n            {listeners} = @\n\n            i = n = listeners.length\n            while (i -= 2) >= 0\n                if listeners[i] isnt null\n                    break\n\n            if i + 2 is n\n                listeners.push listener, ctx\n            else\n                assert.isNotDefined listeners[i + 2]\n                assert.isNotDefined listeners[i + 3]\n                listeners[i + 2] = listener\n                listeners[i + 3] = ctx\n\n            return\n\n## Signal::disconnect(*Function* listener, [*Any* context])\n\nReturns the given listener function from the signal listeners.\n\n```javascript\nvar obj = {};\n\nsignal.create(obj, 'onPress');\n\nvar listener = function(){\n  console.log('listener called!');\n};\n\nobj.onPress.connect(listener);\nobj.onPress.disconnect(listener);\n\nobj.onPress.emit()\n\/\/ no loggs...\n```\n\n        disconnect: (listener, ctx = null) ->\n            assert.isFunction @, 'disconnect must be called on a signal function'\n            assert.isFunction listener, 'listener is not a function'\n\n            {listeners} = @\n            index = 0\n\n            loop\n                index = listeners.indexOf listener, index\n                if index is -1 or listeners[index + 1] is ctx\n                    break\n                index += 2\n            assert.isNot index, -1, \"listener doesn't exist in this signal\"\n            assert.is listeners[index], listener\n            assert.is listeners[index + 1], ctx\n\n            listeners[index] = null\n            listeners[index + 1] = null\n\n            return\n\n## Signal::disconnectAll()\n\nRemoves all the signal listeners.\n\n        disconnectAll: ->\n            assert.isFunction @, 'disconnectAll must be called on a signal function'\n\n            {listeners} = @\n            for _, i in listeners\n                listeners[i] = null\n\n            return\n\n    exports.Emitter = require('.\/emitter')\n        create: exports.create\n        createSignalFunction: createSignalFunction\n        callSignal: callSignal\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"0c148f2162c72e6a9b86dac6f807083d58c6e5b4","subject":"example change","message":"example change\n","repos":"vpj\/weya,vpj\/weya","old_file":"example.litcoffee","new_file":"example.litcoffee","new_contents":"Create a sample div\n\n    class Student\n     constructor: (name, age) ->\n      @name = name\n      @age = age\n\n     template: ->\n      @div \"#name.col-md-6\", ->\n       @span \"Name\"\n       @span @$.name\n      @div \"#age.col-md-6\", style: {background: \"red\"}, ->\n       @span \"Age\"\n       @span \"#{@$.age}\"\n       @input \"#ageInput\", type: \"text\", null\n\n     render: ->\n      console.log Weya.markup context: @, @template\n      Weya elem: document.body, context: @, @template\n\n\n    student = new Student \"Varuna\", 26\n    student.render()\n","old_contents":"Create a sample div\n\n    class Student\n     constructor: (name, age) ->\n      @name = name\n      @age = age\n\n     template: ->\n      @div \"#name.col-md-6\", ->\n       @span \"Name\"\n       @span @$.name\n      @div \"#age.col-md-6\", ->\n       @span \"Age\"\n       @span \"#{@$.age}\"\n       @input \"#ageInput\", type: \"text\", null\n\n     render: ->\n      console.log Weya.markup context: @, @template\n      Weya elem: document.body, context: @, @template\n\n\n    student = new Student \"Varuna\", 26\n    student.render()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"af6b72e8f6e6244d2c08f6b223a37b4bd7109e0f","subject":"Replace temporary test name","message":"Replace temporary test name\n\nWhoops...\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/03_object.litcoffee","new_file":"docs\/03_object.litcoffee","new_contents":"# \/api\/Data Structures\/Batman.Object\n\n`Batman.Object` is the superclass for virtually all objects in a batman.js application. `Batman.Object` mixes in:\n\n- `Batman.Observable` for `get`, `set`, `observe` and others\n- `Batman.EventEmitter` for `on`, `off`, `fire` and others\n\nSee [`Batman.Object Accessors`](\/docs\/api\/batman.object_accessors.html) for a full description of `@accessor`, which defines properties on `Batman.Object`s.\n\n\n## @accessor([keys...], objectOrFunction)\n\nIf `keys` is empty, defines a new default accessor for instances of the object, otherwise defines a new accessor on instances of the `Object` for `keys`.\n\n`objectOrFunction` may be:\n\n- An object with `get`, `set`, and\/or `unset` keys whose values are functions which implement those operations.\n- A function which will be treated as the `get` key of the accessor object.\n\n## @classAccessor([keys...], objectOrFunction)\n\nFollows the pattern of `Bamtan.Object.accessor`, but defines the accessor on the class (constructor) instead of on instances of the object.\n\n    test '@classAccessor defines an accessor on the class', ->\n      class WayneManor extends Batman.Object\n        @classAccessor 'address', -> \"123 Wayne Dr.\"\n\n      equal WayneManor.get('address'), \"123 Wayne Dr.\"\n      # Wayne Manor burned down...\n      equal (new WayneManor(isRebuilt: true)).constructor.get('address'), \"123 Wayne Dr.\"\n\n## @mixin(objects...) : prototype\n\nMixes in `objects` to the `Object`'s prototype. Keys from `objects` are applied with `set`. If any of `objects` has an `initialize` function, it will be called with the prototype being mixed into.\n\n_Note_: `@mixin`, similar to `@accessor`, applies to all instances of a class. If you need to mix in to the class itself, look at `classMixin`. `@mixin` is intended for use during the class definition of a `Batman.Object` subclass.\n\n    test '@mixin extends the prototype of a Batman.Object subclass', ->\n      FishBehaviour =\n        canBreatheUnderwater: true\n      MammalBehaviour =\n        initialize: ->\n          @set('isMammal', true)\n        canBreatheAboveWater: true\n\n      class Platypus extends Batman.Object\n        @mixin FishBehaviour, MammalBehaviour\n\n      platypus = new Platypus\n      ok platypus.get('isMammal'), \"the initialize function is called with the target prototype\"\n      ok platypus.get('canBreatheAboveWater')\n      ok platypus.get('canBreatheUnderwater')\n\n## @classMixin(objects...) : this\n\n`@classMixin` mixes `objects` into the class (constructor) in the same way that `@mixin` mixes into the prototype.\n\n    test '@classMixin extends the Batman.Object subclass', ->\n      Singleton =\n        initialze: (subject) ->\n          subject.accessor 'instance', -> new subject\n\n      class Highlander extends Batman.Object\n        @classMixin Singleton\n\n      instance = Highlander.get('instance')\n      ok instance == Highlander.get('instance'), \"There can only be one.\"\n\n## @observeAll(key, callback : function) : prototype\n\n`@observeAll` extends the `Batman.Object` implementation of `Batman.Observable` with the ability to observe all instances of the class (and subclasses). Observers attached with `@observeAll` function exactly as if they were attached to the object directly. Returns the prototype of the class.\n\n_Note_: `@observeAll` is intended to be used during the class definition for a `Batman.Object` subclass, but it can be called after the class has been defined as a function on the class. It supports being called after instances of the class have been instantiated as well.\n\n    test \"@observeAll attaches handlers which get called upon change\", ->\n      results = []\n      class Song extends Batman.Object\n        @observeAll 'length', (newValue, oldValue) -> results.push newValue\n\n      song = new Song({length: 340, bpm: 120})\n      equal song.set('length', 200), 200\n      deepEqual results[1], 200\n\n    test \"@observeAll can attach handlers after instance instantiation\", ->\n      results = []\n      class Song extends Batman.Object\n\n      song = new Song({length: 340, bpm: 120})\n      equal song.set('length', 360), 360\n      deepEqual results[0], undefined\n      Song.observeAll 'length', (newValue, oldValue) -> results.push newValue\n      equal song.set('length', 200), 200\n      deepEqual results[0], 200\n\n## @delegate(properties..., options)\n\nDelegates `properties` to `options.to` by creating new accessors for `properties` which call `to.get(property)`. `options` must include a `to` Object.\n\n## @singleton(singletonMethodName[=\"sharedInstance\"])\n\nShorthand for [singleton classes](http:\/\/en.wikipedia.org\/wiki\/Singleton_pattern). Defines a class accessor `singletonMethodName` which returns the singleton instance.\n\n## @wrapAccessor([keys...,] wrapperFunction: Function)\n\nDefines a *wrap accessor* for the given keys. These accessors are intended to\nextend an existing accessor or property by wrapping calls to `get`\/`set`\/`unset`.\n\n`wrapperFunction` is called immediately, and should return an object with the\nsame format as an accessor definition. It is passed an object that represents\nthe original accessor being wrapped, called `core`.\n\nSome trivial examples:\n\n    test \"@wrapAccessor can be used to extend get functionality\", ->\n      class Product extends Batman.Object\n        @wrapAccessor 'title', (core) ->\n          get: (key) -> 'Product ' + core.get.call(this, key) # Call the original get function.\n\n      foo = new Product(title: 'Foo')\n      equal foo.get('title'), 'Product Foo'\n\n    test \"@wrapAccessor can be used to extend set functionality\", ->\n      class Product extends Batman.Object\n        @wrapAccessor 'title', (core) ->\n          set: (key, value) ->\n            core.set.call(this, key, value.toUpperCase()) # Call the original set function, with different arguments.\n\n      foo = new Product(title: 'Product Foo')\n      equal foo.get('title'), 'PRODUCT FOO'\n\nHere's a real-world example of a fairly common use-case.\n`Product` has a `handle`, which is the token used to identify the product in a\nURL. If the user hasn't set a custom handle, then the handle should be generated\nfrom the title. If they do set a custom handle, then changes to the title should\nnot affect the handle.\n\n    test \"@wrapAccessor implementation of generating resource handles\", ->\n      handleize = (value) -> value?.toLowerCase().replace(\/\\W+\/g, '-')\n\n      class Product extends Batman.Object\n        @wrapAccessor 'handle', (core) ->\n          get: -> core.get.apply(@, arguments) || handleize(@get('title'))\n\n        @wrapAccessor 'title', (core) ->\n          set: (key, value) ->\n            if @get('handle') == handleize(@get('title'))\n              @set('handle', handleize(value))\n\n            core.set.call(this, key, value)\n\n      foo = new Product(title: 'Product Foo!!')\n      equal foo.get('handle'), 'product-foo-' # Handle is automatically set.\n\n      foo.set('title', 'Product Bar')\n      equal foo.get('handle'), 'product-bar' # Handle is automatically set again.\n\n      foo.set('handle', 'custom-handle') # User defines a custom handle for this product...\n      foo.set('title', 'Product Foo!!')\n      equal foo.get('handle'), 'custom-handle' # so now it's not automatically set.\n\n`@wrapAccessor` may be called with no keys to wrap *all* accessors.\n\n## @wrapClassAccessor([keys...,] wrapperFunction: Function )\n\nLike `@wrapAccessor`, but to wrap a class-level accessor.\n\n## ::wrapAccessor([keys...,] wrapperFunction)\n\nLike `@wrapAccessor`, but wraps an accessor on a single instance.\n\n## ::constructor(objects...) : Object\n\nCreates a new `Batman.Object` with properties from `objects`. If items in `objects` have the same keys, later values take precendence over earlier ones. Values are applied with `set`, so custom accessors are applied. The `Batman` namespace performs the same function.\n\n    test 'Batman() function allows for handy creation of Batman.Objects', ->\n      object = Batman(foo: 'bar')\n      equal typeof object.get, 'function'\n\n    test 'Batman.Object constructor function accepts multiple mixin arguments and later mixins take precedence.', ->\n      song = Batman({length: 100, bpm: 120}, {bpm: 130})\n      equal song.get('length'), 100\n      equal song.get('bpm'), 130, \"The property from the second object passed to the constructor overwrites that from the first.\"\n\n## ::toJSON() : object\n\n`toJSON` returns a vanilla JavaScript object representing this `Batman.Object`.\n\n    test 'toJSON returns a vanilla JS object', ->\n      object = Batman(foo: 'bar')\n      deepEqual object.toJSON(), {foo: 'bar'}\n\n## ::hashKey() : string\n\nReturns a unique string identifying this `Batman.Object`.\n\n## ::batchAccessorChanges(key, wrappedFunction)\n\nPrevents accessor `key` from being recalculated while the `wrappedFunction` is called on the `Object`. After `wrappedFunction` is complete, the accessor will be recomputed. Returns the result of `wrappedFunction`.\n\n\n## ::accessor([keys...], objectOrFunction)\n\n`accessor` defines an accessor on one instance of an object instead of on all instances like the class level `@accessor`. See `@accessor` for the details surrounding accessors.\n\n    test 'accessor can be called on an instance of Batman.Object to define an accessor just on that instance', ->\n      class Post extends Batman.Object\n        @accessor 'summary', -> @get('body').slice(0, 10) + \"...\"\n\n      post = new Post(body: \"Why Batman is Useful: A lengthy post on an important subject\")\n      equal post.get('summary'), \"Why Batman...\"\n      post.accessor('longSummary', -> @get('body').slice(0, 20) + \"...\")  # \"Instance level accessor defines accessors just for that instance\"\n      equal post.get('longSummary'), \"Why Batman is Useful...\"\n\n    test 'defining an accessor on an instance does not affect the other instances', ->\n      class Post extends Batman.Object\n\n      post = new Post(body: \"Why Batman is Useful: A lengthy post on an important subject\")\n      otherPost = new Post(body: \"Why State Machines Are Useful: Another lengthy post\")\n      post.accessor 'longSummary', -> @get('body').slice(0, 20) + \"...\"\n      equal post.get('longSummary'), \"Why Batman is Useful...\"\n      equal otherPost.get('longSummary'), undefined\n\n## ::mixin(objects...) : this\n\nMixes `objects` into the `Object` instance. Keys from `objects` are applied with `set`. If any of `objects` has an `initialize` function, it will be called with the prototype being mixed into.\n\n\n    test 'mixin on an instance applies the keys from the mixed in object to the instance', ->\n      class Snake extends Batman.Object\n\n      snake = new Snake()\n      snake.mixin {canSlither: true}, {canHiss: true}\n      ok snake.get('canSlither')\n      ok snake.get('canHiss')\n","old_contents":"# \/api\/Data Structures\/Batman.Object\n\n`Batman.Object` is the superclass for virtually all objects in a batman.js application. `Batman.Object` mixes in:\n\n- `Batman.Observable` for `get`, `set`, `observe` and others\n- `Batman.EventEmitter` for `on`, `off`, `fire` and others\n\nSee [`Batman.Object Accessors`](\/docs\/api\/batman.object_accessors.html) for a full description of `@accessor`, which defines properties on `Batman.Object`s.\n\n\n## @accessor([keys...], objectOrFunction)\n\nIf `keys` is empty, defines a new default accessor for instances of the object, otherwise defines a new accessor on instances of the `Object` for `keys`.\n\n`objectOrFunction` may be:\n\n- An object with `get`, `set`, and\/or `unset` keys whose values are functions which implement those operations.\n- A function which will be treated as the `get` key of the accessor object.\n\n## @classAccessor([keys...], objectOrFunction)\n\nFollows the pattern of `Bamtan.Object.accessor`, but defines the accessor on the class (constructor) instead of on instances of the object.\n\n    test '@classAccessor defines an accessor on the class', ->\n      class WayneManor extends Batman.Object\n        @classAccessor 'address', -> \"123 Wayne Dr.\"\n\n      equal WayneManor.get('address'), \"123 Wayne Dr.\"\n      # Wayne Manor burned down...\n      equal (new WayneManor(isRebuilt: true)).constructor.get('address'), \"123 Wayne Dr.\"\n\n## @mixin(objects...) : prototype\n\nMixes in `objects` to the `Object`'s prototype. Keys from `objects` are applied with `set`. If any of `objects` has an `initialize` function, it will be called with the prototype being mixed into.\n\n_Note_: `@mixin`, similar to `@accessor`, applies to all instances of a class. If you need to mix in to the class itself, look at `classMixin`. `@mixin` is intended for use during the class definition of a `Batman.Object` subclass.\n\n    test '@mixin extends the prototype of a Batman.Object subclass', ->\n      FishBehaviour =\n        canBreatheUnderwater: true\n      MammalBehaviour =\n        initialize: ->\n          @set('isMammal', true)\n        canBreatheAboveWater: true\n\n      class Platypus extends Batman.Object\n        @mixin FishBehaviour, MammalBehaviour\n\n      platypus = new Platypus\n      ok platypus.get('isMammal'), \"the initialize function is called with the target prototype\"\n      ok platypus.get('canBreatheAboveWater')\n      ok platypus.get('canBreatheUnderwater')\n\n## @classMixin(objects...) : this\n\n`@classMixin` mixes `objects` into the class (constructor) in the same way that `@mixin` mixes into the prototype.\n\n    test '@classMixin extends the Batman.Object subclass', ->\n      Singleton =\n        initialze: (subject) ->\n          subject.accessor 'instance', -> new subject\n\n      class Highlander extends Batman.Object\n        @classMixin Singleton\n\n      instance = Highlander.get('instance')\n      ok instance == Highlander.get('instance'), \"There can only be one.\"\n\n## @observeAll(key, callback : function) : prototype\n\n`@observeAll` extends the `Batman.Object` implementation of `Batman.Observable` with the ability to observe all instances of the class (and subclasses). Observers attached with `@observeAll` function exactly as if they were attached to the object directly. Returns the prototype of the class.\n\n_Note_: `@observeAll` is intended to be used during the class definition for a `Batman.Object` subclass, but it can be called after the class has been defined as a function on the class. It supports being called after instances of the class have been instantiated as well.\n\n    test \"@observeAll attaches handlers which get called upon change\", ->\n      results = []\n      class Song extends Batman.Object\n        @observeAll 'length', (newValue, oldValue) -> results.push newValue\n\n      song = new Song({length: 340, bpm: 120})\n      equal song.set('length', 200), 200\n      deepEqual results[1], 200\n\n    test \"@observeAll can attach handlers after instance instantiation\", ->\n      results = []\n      class Song extends Batman.Object\n\n      song = new Song({length: 340, bpm: 120})\n      equal song.set('length', 360), 360\n      deepEqual results[0], undefined\n      Song.observeAll 'length', (newValue, oldValue) -> results.push newValue\n      equal song.set('length', 200), 200\n      deepEqual results[0], 200\n\n## @delegate(properties..., options)\n\nDelegates `properties` to `options.to` by creating new accessors for `properties` which call `to.get(property)`. `options` must include a `to` Object.\n\n## @singleton(singletonMethodName[=\"sharedInstance\"])\n\nShorthand for [singleton classes](http:\/\/en.wikipedia.org\/wiki\/Singleton_pattern). Defines a class accessor `singletonMethodName` which returns the singleton instance.\n\n## @wrapAccessor([keys...,] wrapperFunction: Function)\n\nDefines a *wrap accessor* for the given keys. These accessors are intended to\nextend an existing accessor or property by wrapping calls to `get`\/`set`\/`unset`.\n\n`wrapperFunction` is called immediately, and should return an object with the\nsame format as an accessor definition. It is passed an object that represents\nthe original accessor being wrapped, called `core`.\n\nSome trivial examples:\n\n    test \"@wrapAccessor can be used to extend get functionality\", ->\n      class Product extends Batman.Object\n        @wrapAccessor 'title', (core) ->\n          get: (key) -> 'Product ' + core.get.call(this, key) # Call the original get function.\n\n      foo = new Product(title: 'Foo')\n      equal foo.get('title'), 'Product Foo'\n\n    test \"@wrapAccessor can be used to extend set functionality\", ->\n      class Product extends Batman.Object\n        @wrapAccessor 'title', (core) ->\n          set: (key, value) ->\n            core.set.call(this, key, value.toUpperCase()) # Call the original set function, with different arguments.\n\n      foo = new Product(title: 'Product Foo')\n      equal foo.get('title'), 'PRODUCT FOO'\n\nHere's a real-world example of a fairly common use-case.\n`Product` has a `handle`, which is the token used to identify the product in a\nURL. If the user hasn't set a custom handle, then the handle should be generated\nfrom the title. If they do set a custom handle, then changes to the title should\nnot affect the handle.\n\n    test \"@wrapAccessor makes custom shit woohoo\", ->\n      handleize = (value) -> value?.toLowerCase().replace(\/\\W+\/g, '-')\n\n      class Product extends Batman.Object\n        @wrapAccessor 'handle', (core) ->\n          get: -> core.get.apply(@, arguments) || handleize(@get('title'))\n\n        @wrapAccessor 'title', (core) ->\n          set: (key, value) ->\n            if @get('handle') == handleize(@get('title'))\n              @set('handle', handleize(value))\n\n            core.set.call(this, key, value)\n\n      foo = new Product(title: 'Product Foo!!')\n      equal foo.get('handle'), 'product-foo-' # Handle is automatically set.\n\n      foo.set('title', 'Product Bar')\n      equal foo.get('handle'), 'product-bar' # Handle is automatically set again.\n\n      foo.set('handle', 'custom-handle') # User defines a custom handle for this product...\n      foo.set('title', 'Product Foo!!')\n      equal foo.get('handle'), 'custom-handle' # so now it's not automatically set.\n\n`@wrapAccessor` may be called with no keys to wrap *all* accessors.\n\n## @wrapClassAccessor([keys...,] wrapperFunction: Function )\n\nLike `@wrapAccessor`, but to wrap a class-level accessor.\n\n## ::wrapAccessor([keys...,] wrapperFunction)\n\nLike `@wrapAccessor`, but wraps an accessor on a single instance.\n\n## ::constructor(objects...) : Object\n\nCreates a new `Batman.Object` with properties from `objects`. If items in `objects` have the same keys, later values take precendence over earlier ones. Values are applied with `set`, so custom accessors are applied. The `Batman` namespace performs the same function.\n\n    test 'Batman() function allows for handy creation of Batman.Objects', ->\n      object = Batman(foo: 'bar')\n      equal typeof object.get, 'function'\n\n    test 'Batman.Object constructor function accepts multiple mixin arguments and later mixins take precedence.', ->\n      song = Batman({length: 100, bpm: 120}, {bpm: 130})\n      equal song.get('length'), 100\n      equal song.get('bpm'), 130, \"The property from the second object passed to the constructor overwrites that from the first.\"\n\n## ::toJSON() : object\n\n`toJSON` returns a vanilla JavaScript object representing this `Batman.Object`.\n\n    test 'toJSON returns a vanilla JS object', ->\n      object = Batman(foo: 'bar')\n      deepEqual object.toJSON(), {foo: 'bar'}\n\n## ::hashKey() : string\n\nReturns a unique string identifying this `Batman.Object`.\n\n## ::batchAccessorChanges(key, wrappedFunction)\n\nPrevents accessor `key` from being recalculated while the `wrappedFunction` is called on the `Object`. After `wrappedFunction` is complete, the accessor will be recomputed. Returns the result of `wrappedFunction`.\n\n\n## ::accessor([keys...], objectOrFunction)\n\n`accessor` defines an accessor on one instance of an object instead of on all instances like the class level `@accessor`. See `@accessor` for the details surrounding accessors.\n\n    test 'accessor can be called on an instance of Batman.Object to define an accessor just on that instance', ->\n      class Post extends Batman.Object\n        @accessor 'summary', -> @get('body').slice(0, 10) + \"...\"\n\n      post = new Post(body: \"Why Batman is Useful: A lengthy post on an important subject\")\n      equal post.get('summary'), \"Why Batman...\"\n      post.accessor('longSummary', -> @get('body').slice(0, 20) + \"...\")  # \"Instance level accessor defines accessors just for that instance\"\n      equal post.get('longSummary'), \"Why Batman is Useful...\"\n\n    test 'defining an accessor on an instance does not affect the other instances', ->\n      class Post extends Batman.Object\n\n      post = new Post(body: \"Why Batman is Useful: A lengthy post on an important subject\")\n      otherPost = new Post(body: \"Why State Machines Are Useful: Another lengthy post\")\n      post.accessor 'longSummary', -> @get('body').slice(0, 20) + \"...\"\n      equal post.get('longSummary'), \"Why Batman is Useful...\"\n      equal otherPost.get('longSummary'), undefined\n\n## ::mixin(objects...) : this\n\nMixes `objects` into the `Object` instance. Keys from `objects` are applied with `set`. If any of `objects` has an `initialize` function, it will be called with the prototype being mixed into.\n\n\n    test 'mixin on an instance applies the keys from the mixed in object to the instance', ->\n      class Snake extends Batman.Object\n\n      snake = new Snake()\n      snake.mixin {canSlither: true}, {canHiss: true}\n      ok snake.get('canSlither')\n      ok snake.get('canHiss')\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"42f98cf3a0d34224d927012521cce61804a811e7","subject":"Add docs about using custom URLs","message":"Add docs about using custom URLs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/12b_rest_storage.litcoffee","new_file":"docs\/12b_rest_storage.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c9ff27742bcb21844e4d370b2ac9e1d3b5a95e49","subject":"Refactor to use new db schema","message":"Refactor to use new db schema\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/postgres\/postgres_ground.litcoffee","new_file":"lib\/render-pipelines\/postgres\/postgres_ground.litcoffee","new_contents":"    PostgresRenderer = require '.\/postgres_renderer'\n\n    DB = undefined\n\n    class PostgresGround extends PostgresRenderer\n\n      delegates: [\n        'ground'\n        'stairs_up'\n      ]\n\n      $register_db_instance: (done) ->\n        DB = @_postgres()\n        done()\n\n      render: (path, grid_name, done, exception) ->\n        grid_save_query = @sql_bricks_postgres\n          .insert 'grid', name: grid_name\n          .returning 'id'\n          .toParams()\n\n        DB.one grid_save_query.text, grid_save_query.values\n          .then (g) =>\n            @async.each path, (p, next) =>\n              block_save_query = @sql_bricks_postgres\n                .insert 'block',\n                  grid:       g.id\n                  size:       \"(#{p.width.actual}, #{p.height.actual})\"\n                  properties: p.props\n                  direction:  p.direction\n                .returning 'id'\n                .toParams()\n\n              DB.one block_save_query.text, block_save_query.values\n                .then (b) =>\n                  @async.each p.landscape.nodes, (node, nxt) =>\n                    node_save_query = @sql_bricks_postgres\n                      .insert 'node',\n                        block:    b.id\n                        kind:     node.type\n                        size:     \"(#{node.width}, #{node.height})\"\n                        location: \"(#{node.x}, #{node.y})\"\n                      .returning 'id'\n                      .toParams()\n\n                    DB.one node_save_query.text, node_save_query.values\n                      .then (n) =>\n                        faces  = @[node.type] node\n                        params =\n                          node:        n.id\n                          left_face:   faces.left\n                          top_face:    faces.top\n                          right_face:  faces.right\n                          bottom_face: faces.bottom\n                          front_face:  faces.front\n                          back_face:   faces.back\n\n                        geom_query = @sql_bricks_postgres\n                          .insert 'geometry', params\n                          .toParams()\n\n                        DB.none geom_query.text, geom_query.values\n                          .then => nxt()\n                          .catch exception nxt\n                      .catch exception nxt\n                  , => next()\n                .catch exception next\n            , => done()\n\n    module.exports = PostgresGround\n","old_contents":"    PostgresRenderer = require '.\/postgres_renderer'\n\n    class PostgresGround extends PostgresRenderer\n\n      args: [ 'wall' ]\n\n      render: (path, _, grid_name, done, exception) ->\n        grid_query = @sql_bricks_postgres\n          .select 'id'\n          .from   'grid'\n          .where  name: grid_name\n          .limit  1\n          .toParams()\n\n        @_postgres().one grid_query.text, grid_query.values\n          .then (grid) =>\n            piece_query = @sql_bricks_postgres\n              .select 'id'\n              .from   'piece'\n              .where  mode: 'GROUND'\n              .limit  1\n              .toParams()\n\n            @_postgres().one piece_query.text, piece_query.values\n              .then (piece) =>\n                @async.each path, (item, all_inserted) =>\n                  block_query = @sql_bricks_postgres\n                    .select 'id'\n                    .from   'block'\n                    .where\n                      grid:  grid.id\n                      index: path.indexOf item\n                    .limit  1\n                    .toParams()\n\n                  @_postgres().one block_query.text, block_query.values\n                    .then (block) =>\n                      @async.each item.ground, (ground, inserted) =>\n                        properties =\n                          x:      item.ground.indexOf ground\n                          y:      @wall.segments - ground.thickness\n                          block:  block.id\n                          piece:  piece.id\n                          volume: x: 1, y: ground.thickness, z: 1\n\n                        add = @sql_bricks_postgres\n                          .insert 'point', properties\n                          .toParams()\n\n                        @_postgres().none add.text, add.values\n                          .catch exception\n                          .then  inserted\n                      , all_inserted\n                    .catch exception\n                , done\n              .catch exception\n\n    module.exports = PostgresGround\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fb82d95581ea8d70891314bcb936f00dc8de3a7e","subject":"Singularize cats","message":"Singularize cats\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_view.litcoffee","new_file":"docs\/14_view.litcoffee","new_contents":"# Batman.View\n\nFor a general explanation of `Batman.View`s and how they work, see [the\nguide](\/docs\/views.html).\n\n\n## ::constructor(options = {})\n\nA `View` is a `Batman.Object`, so any options you pass are mixed in. Use this\nto set `html`, `node`, `superview`, `parentNode` and\/or your custom data.\n\n    test 'constructor mixes in options', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.get('animal')\n\n\n## ::lookupKeypath(keypath) : Object\n\nTraverses up the view tree searching for the specified keypath, and returns the\nresult. This is equivalent to performing a `Batman.get` for each view above\n`this` in the tree, until a defined result is returned. The path it takes is as\nfollows:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\nIf there is no match, `undefined` is returned. However if used in an accessor\nor binding, the entire path to the root will be registered as a potential\nsource of the keypath. Consequently, if the keypath is later set on any part of\nthe chain, the data will be correctly bound.\n\n`lookupKeypath` is the function invoked to locate data when evaluating a\nbinding.\n\n    test 'lookupKeypath returns the value if defined on the view', ->\n      view = new Batman.View(animal: 'cat')\n      equal 'cat', view.lookupKeypath('animal')\n\n    test 'lookupKeypath returns the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'cat')\n      subview = new Batman.View(superview: superview)\n      equal 'cat', subview.lookupKeypath('animal')\n\n\n## ::setKeypath(keypath, value) : Object\n\nTraverses the View tree searching for the specified keypath, and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is the function invoked to set data when using an input binding.\n\n    test 'setKeypath sets the value if defined on the view', ->\n      view = new Batman.View(animal: 'dog')\n\n      view.setKeypath('animal', cat)\n      equal 'cat', view.get('animal')\n\n    test 'setKeypath sets the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'dog')\n      subview = new Batman.View(superview: superview)\n\n      subview.setKeypath('animal', cat)\n      equal 'cat', superview.get('animal')\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', cat)\n      equal 'cat', view.get('animal')\n\n\n## ::%node : Node\n\nA reference to the DOM node that this view encapsulates. The entire tree\nbeneath this node is also the responsibility of this view and\/or its subviews.\n\nAccessing `node` will load and parse the template on demand if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n    test 'node parses bindings too', ->\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview.\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n\n## ::.superview : Batman.View\n\nA reference to the current superview (the direct ancestor in the tree). This is\nused for traversing the tree when searching for data, as in\n`View::lookupKeypath`.\n\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of a `View`. To manipulate the view tree, you should\noperate directly on this set \u2014 batman.js will automatically keep the DOM in\nsync with the logical tree.\n\n\n## ::subviews.add(view)\n\nAdding to a view's subview set will automatically update the tree, and parse\nthe template and bindings. If the superview is already in the DOM, this will\ninsert the current view's node into the DOM.\n\n\n## ::subviews.remove(view)\n\nRemoving from a view's subview set will automatically remove the subview from\nthe DOM.\n\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent, without killing it.\n\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n    test 'die kills the view', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.die()\n      equal true, view.isDead\n      equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n\n## ::propagateToSubviews(eventOrKey : string, value)\n\nIf value is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n\n","old_contents":"# Batman.View\n\nFor a general explanation of `Batman.View`s and how they work, see [the\nguide](\/docs\/views.html).\n\n\n## ::constructor(options = {})\n\nA `View` is a `Batman.Object`, so any options you pass are mixed in. Use this\nto set `html`, `node`, `superview`, `parentNode` and\/or your custom data.\n\n    test 'constructor can be called without arguments', ->\n      set = new Batman.Set\n      deepEqual set.toArray(), []\n\n\n## ::lookupKeypath(keypath) : Object\n\nTraverses up the view tree searching for the specified keypath, and returns the\nresult. This is equivalent to performing a `Batman.get` for each view above\n`this` in the tree, until a defined result is returned. The path it takes is as\nfollows:\n\ncurrent view \u2192 chain of superviews \u2192 layout view \u2192 active controller \u2192 app \u2192\nwindow\n\nIf there is no match, `undefined` is returned. However if used in an accessor\nor binding, the entire path to the root will be registered as a potential\nsource of the keypath. Consequently, if the keypath is later set on any part of\nthe chain, the data will be correctly bound.\n\n`lookupKeypath` is the function invoked to locate data when evaluating a\nbinding.\n\n    test 'lookupKeypath returns the value if defined on the view', ->\n      view = new Batman.View(animal: 'cats')\n      equal 'cats', view.lookupKeypath('animal')\n\n    test 'lookupKeypath returns the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'cats')\n      subview = new Batman.View(superview: superview)\n      equal 'cats', subview.lookupKeypath('animal')\n\n\n## ::setKeypath(keypath, value) : Object\n\nTraverses the View tree searching for the specified keypath, and sets the value\non the nearest ancestor which defines it. If no ancestor view defines the given\nkeypath, it will be set on the nearest ancestor which is not a\nbacking view.\n\n`setKeypath` is the function invoked to set data when using an input binding.\n\n    test 'setKeypath sets the value if defined on the view', ->\n      view = new Batman.View(animal: 'dogs')\n\n      view.setKeypath('animal', cats)\n      equal 'cats', view.get('animal')\n\n    test 'setKeypath sets the value if defined on an ancestor', ->\n      superview = new Batman.View(animal: 'dogs')\n      subview = new Batman.View(superview: superview)\n\n      subview.setKeypath('animal', cats)\n      equal 'cats', superview.get('animal')\n\n    test 'setKeypath sets the value on the nearest non-backing view when not defined anywhere', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n      backingView = new Batman.BackingView(superview: view)\n\n      backingView.setKeypath('animal', cats)\n      equal 'cats', view.get('animal')\n\n\n## ::%node : Node\n\nA reference to the DOM node that this view encapsulates. The entire tree\nbeneath this node is also the responsibility of this view and\/or its subviews.\n\nAccessing `node` will load and parse the template on demand if it isn't already\nloaded.\n\n    test 'node parses the template', ->\n      view = new Batman.View(html: '<div>cat<\/div>')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n    test 'node parses bindings too', ->\n      view = new Batman.View(html: '<div data-bind=\"animal\"><\/div>', animal: 'cat')\n\n      node = view.get('node')\n      equal 'cat', node.firstChild.innerHTML\n\n\n## ::%html : String\n\nThe HTML source for the view's template. Setting this will parse the template\nand build bindings automatically, but it will not be inserted into the DOM\nuntil the view is added to a superview.\n\nIf you don't explicitly set `html` but you do set `source`, then getting `html`\nwill automatically fetch the template source from the local template store.\n\n\n## ::.superview : Batman.View\n\nA reference to the current superview (the direct ancestor in the tree). This is\nused for traversing the tree when searching for data, as in\n`View::lookupKeypath`.\n\n\n## ::.subviews : Batman.Set\n\nThe set of direct children of a `View`. To manipulate the view tree, you should\noperate directly on this set \u2014 batman.js will automatically keep the DOM in\nsync with the logical tree.\n\n\n## ::subviews.add(view)\n\nAdding to a view's subview set will automatically update the tree, and parse\nthe template and bindings. If the superview is already in the DOM, this will\ninsert the current view's node into the DOM.\n\n\n## ::subviews.remove(view)\n\nRemoving from a view's subview set will automatically remove the subview from\nthe DOM.\n\n\n## ::removeFromSuperview()\n\nRemoves this view from its parent, without killing it.\n\n\n## ::die()\n\nKills this view, which renders it to forever unusable. This has the\nfollowing implications:\n\n- The view is removed from its superview\n- The view's node is removed from the DOM\n- The view's bindings are destroyed\n- The view's current subviews are killed\n\n    test 'die kills the view', ->\n      superview = new Batman.View()\n      view = new Batman.View(superview: superview)\n\n      view.die()\n      equal true, view.isDead\n      equal 0, superview.subviews.length\n\n\n## ::.isDead : boolean\n\nTrue if the view has been killed, false otherwise.\n\n\n## ::destroySubviews()\n\nKills every subview of this view.\n\n\n## ::propagateToSubviews(eventOrKey : string, value)\n\nIf value is defined, set `eventOrKey` to `value` on the entire subtree.\nOtherwise, fire `eventOrKey` on the entire subtree.\n\n\n## @viewForNode(node, climbTree = true) : Batman.View\n\nFinds the view acting as the current context for a node \u2014 i.e. perform the\nreverse mapping of the view tree to the DOM. If you pass `false` for\n`climbTree`, it won't traverse up the DOM, and will return `undefined` unless\nthe node is the view's root.\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"adccdf334d5f3ad68c4276f9daeb4b0fd1dabf48","subject":"Use Madul.DUMMY to load render_pipeline","message":"Use Madul.DUMMY to load render_pipeline\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/cli.litcoffee","new_file":"lib\/cli.litcoffee","new_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    Madul = require 'madul'\n\n    if process.env.SKYLL_MADUL_LOGGING == 'true'\n      require 'magnus'\n\n    Skyll = require '.\/index'\n    args  = require '.\/arguments'\n    uuid  = require 'node-uuid'\n    fs    = require 'fs'\n    path  = require 'path'\n\n    EXTRACT = [\n      'rows'\n      'columns'\n      'width'\n      'height'\n      'multiplier'\n      'pipeline'\n      'block'\n      'ground'\n      'step_count'\n      'wall'\n    ]\n\n    new Skyll()\n      .initialize args\n      .then (mod) ->\n        levels = [ ]\n\n        if args._?.length > 0\n          levels = levels.concat argv._\n        else if args.l?\n          for level in [0...argv.l]\n            levels.push uuid.v4()\n        else if Array.isArray args.levels\n          for level in args.levels\n            levels.push level\n        else if args.levels? == false\n          levels.push new Date().toString()\n\n        if args.delegates?\n          location = args.delegates\n        else\n          location = path.join process.cwd(), 'skyll.delegates.js'\n\n        fs.stat location, (err) ->\n          if err?\n            mod.warn 'file-not-found', location\n          else\n            delegates = require location\n            next      = 0\n            input     = { }\n            pipe      = [ ]\n\n            for own key, val of args\n              input[key] = val if EXTRACT.includes key\n\n\n            Madul.DUMMY pipe, (dum) ->\n              dum.render_pipeline = [ ]\n\n              for p in input.pipeline\n                if Array.isArray p\n                  new_pipeline = for q in p\n                    dum[Madul.PARSE_SPEC(q).ref]\n\n                  dum.render_pipeline.push new_pipeline\n                else\n                  dum.render_pipeline.push dum[Madul.PARSE_SPEC(p).ref]\n\n              args = { }\n              name = new Date().toString()\n\n              for own key, val of input\n                args[key] = val if EXTRACT.includes key\n\n              render = (level) ->\n                mod.craft level, input, dum.render_pipeline, delegates\n                  .then -> render levels[next] if ++next < levels.length\n\n              render levels[next]\n","old_contents":"    `#! \/usr\/bin\/env node\n    `\n\n    if process.env.SKYLL_MADUL_LOGGING == 'true'\n      require 'magnus'\n\n    Skyll = require '.\/index'\n    args  = require '.\/arguments'\n    uuid  = require 'node-uuid'\n    fs    = require 'fs'\n    path  = require 'path'\n\n    EXTRACT = [\n      'rows'\n      'columns'\n      'width'\n      'height'\n      'multiplier'\n      'pipeline'\n      'block'\n      'ground'\n      'step_count'\n      'wall'\n    ]\n\n    new Skyll()\n      .initialize args\n      .then (mod) ->\n        levels = [ ]\n\n        if args._?.length > 0\n          levels = levels.concat argv._\n        else if args.l?\n          for level in [0...argv.l]\n            levels.push uuid.v4()\n        else if Array.isArray args.levels\n          for level in args.levels\n            levels.push level\n        else if args.levels? == false\n          levels.push new Date().toString()\n\n        if args.delegates?\n          location = args.delegates\n        else\n          location = path.join process.cwd(), 'skyll.delegates.js'\n\n        fs.stat location, (err) ->\n          if err?\n            mod.warn 'file-not-found', location\n          else\n            delegates = require location\n            next      = 0\n            input     = { }\n\n            for own key, val of args\n              input[key] = val if EXTRACT.includes key\n\n            mod.setup_rendering_pipeline args.pipeline\n              .then ->\n                render = (level) ->\n                  mod.craft level, input, delegates\n                    .then -> render levels[next] if ++next < levels.length\n\n                render levels[next]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"899770950354e9f606f42c2612ba2de72355590e","subject":"Replaced _parse_handle method with spec helpers","message":"Replaced _parse_handle method with spec helpers\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    code_root = process.env.SEARCH_ROOT || 'dist'\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n          uuid:      id\n          args:      args\n          timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          @warn 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = if arguments[0]? then Array.prototype.slice.call arguments else [ ]\n\n              proto[\"_#{method}\"].apply @, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = for val in proto[method].validate\n                @_parse_handle(val).ref\n\n              proto[method].validate = decs\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                { ref } = @_parse_handle val\n                proto[method].validate[key] = ref\n                ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ @_parse_handle(proto[method].validate).ref ]\n            else if typeof proto[method].validate != 'undefined'\n              @warn 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            decs = decs.concat(proto[method].before.map (b, i) =>\n              { ref } = @_parse_handle b\n              proto[method].before[i] = ref\n              ref\n            ) if proto[method].before?\n\n            decs = decs.concat(proto[method].after.map (a, i) =>\n              { ref } = @_parse_handle a\n              proto[method].after[i] = ref\n              ref\n            ) if proto[method].after?\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n\n                  if me.validate?\n                    validators = for val, i in me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[i]\n                      proto[ref].EXECUTE args[i]\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n\n                  if me.validate?\n                    validators = for own key, val of me.validate\n                      { ref } = @_parse_handle val\n                      Madul.FIRE '$.Madul.validator.execute', \"#{ref}\": args[key]\n                      proto[ref].EXECUTE args[key]\n                else\n                  @warn 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                me.before = [ ] unless me.before?\n                me.after  = [ ] unless me.after?\n\n                q.all validators\n                .then =>\n                  q.all me.before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before args\n                .then =>\n                  me.behavior.apply @, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if me.after.length > 0\n                    q.all me.after.map (b) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{b}\": result\n                      b.after result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            @warn 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _parse_handle: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return next @warn 'dependency-initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = SEARCH_ROOTS[r[0].trim()]\n            t[0] = r[1]\n\n          if t.length == 2\n            name  = t[0].trim()\n            alias = t[1].trim()\n          else if t.length == 1\n            name = alias = t[0].trim()\n          else\n            return next @warn 'alias.invalid', tokens[1]\n\n        else\n          return next @warn 'dependency.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres }\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres } = @_parse_handle d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              try\n                proto._add proto, ref, name, next\n              catch e\n                if root?\n                  Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                  proto._check proto, root, name, ref, next\n                else\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, \"#{cwd}\/#{code_root}\", name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply @\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2c39aee988cc9b92736b2b080c86d86b1b1826f2","subject":"Correctly pass proto to _process_decorators","message":"Correctly pass proto to _process_decorators\n","repos":"bsgbryan\/madul","old_file":"lib\/index.litcoffee","new_file":"lib\/index.litcoffee","new_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (proto, type) =>\n        if Array.isArray proto[type]\n          proto[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof proto[type] == 'string'\n          [ Madul.PARSE_SPEC(proto[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                  proto[validator].EXECUTE.call proto[validator], args[arg]\n\n                before = @_process_decorators 'before'\n                after  = @_process_decorators 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","old_contents":"    q     = require 'q'\n    fs    = require 'fs'\n    async = require 'async'\n    uuid  = require 'uuid-1345'\n\n    microtime = require 'microtime'\n\n    EventEmitter2 = require('eventemitter2').EventEmitter2\n    emitter       = new EventEmitter2 wildcard: true\n\n    available   = { }\n    initialized = { }\n    listeners   = { }\n\n    underscore = (value) -> value.replace \/\\W+\/g, '_'\n    strip      = (name)  -> name.toLowerCase().replace \/\\W+\/g, ''\n\n    SEARCH_ROOTS  = { }\n    WRAPPED       = { }\n    _INITIALIZERS = { }\n    HYDRATED      = { }\n    LOCALS        = { }\n\n    HYRDATION_LISTENERS = { }\n\n    INITIALIZERS = (cls, method) ->\n      _INITIALIZERS[cls] = [ ] unless _INITIALIZERS[cls]?\n\n      _INITIALIZERS[cls].push fn: method, called: false\n\n    WRAP = (cls, method) ->\n      unless WRAPPED[cls]?\n        WRAPPED[cls] = [\n          'constructor'\n          'initialize'\n          'details'\n        ]\n\n      WRAPPED[cls].indexOf(method) < 0\n\n    class Madul\n\n      details: =>\n        name  = @.__proto__.constructor.name\n        props = for own key, val of @.__proto__\n          if key != 'constructor' &&\n             key != 'details'     &&\n             key != 'initialize'  && ((\n               key[0]            == '_' &&\n               @.__proto__[key]? == false\n             ) || key[0] != '_')\n\n            if typeof val == 'function'\n              value = val.constructor.name\n            else if Array.isArray val\n              value = for v in val\n                if typeof v == 'function'\n                  v.constructor.name\n                else if typeof v == 'object'\n                  v.constructor.name\n                else\n                  v\n              value = value.join ','\n            else if typeof val == 'object'\n              value = val.constructor.name\n            else\n              value = val\n\n            \"#{key} => #{value}\"\n\n        \"\\n  #{name}\\n    #{props.filter((e) -> e?).join '\\n    '}\"\n\n      @LISTEN: (event, callback) => emitter.on event, callback\n\n      @FIRE: (event, args) => emitter.emit event, args\n\n      @SEARCH_ROOT: (mod, path) =>\n        Madul.FIRE '$.Madul.search_root.register', \"#{mod}\": path\n\n        SEARCH_ROOTS[mod] = path.substring 0, path.lastIndexOf '\/'\n\n      @PARSE_SPEC: (value) =>\n        tokens = value.split '='\n\n        if tokens.length == 2\n          initer = tokens[1].trim()\n          t      = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n          toks = initer.split ':'\n\n          if toks.length == 2\n            initer = toks[0].trim()\n            pres   = toks[1].split(',').map (p) => p.trim()\n          else if toks.length == 1\n            initer = toks[0].trim()\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.initializer.invalid', tokens[1]\n\n        else if tokens.length == 1\n          t = tokens[0].split '->'\n\n          if t[0].indexOf('#') > -1\n            r = t[0].split '#'\n\n            root = r[0].trim()\n            t[0] = r[1]\n\n          if t.length == 2\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = n.substring 1, n.length\n            else\n              local = false\n              name  = n\n\n            alias = t[1].trim()\n          else if t.length == 1\n            n = t[0].trim()\n\n            if n[0] == '.'\n              local = true\n              name  = alias = n.substring 1, n.length\n            else\n              local = false\n              name  = alias = n\n          else\n            return Madul.FIRE '!.Madul.dependency_spec.alias.invalid', tokens[1]\n\n        else\n          return Madul.FIRE '!.Madul.dependency_spec.invalid', d\n\n        { ref: alias || name, alias, name, root, initer, pres, local }\n\n      @BUILD_SPEC: ({ search_root, name, alias, initializer, prerequisites }) =>\n        unless name?\n          return Madul.FIRE '!.Madul.dependency_spec.name-required', arguments[0]\n\n        if prerequisites? && initializer? == false\n          return Madul.FIRE '!.Madul.dependency_spec.prerequisites-require-initializer', arguments[0]\n\n        \"#{if search_root?   then \"#{search_root}#\"            else ''}\\\n         #{name}\\\n         #{if alias?         then \" -> #{alias}\"               else ''}\\\n         #{if initializer?   then \" = #{initializer}\"          else ''}\\\n         #{if prerequisites? then \":#{prerequisites.join ','}\" else ''}\\\n        \"\n\n      listen: (event, callback) ->\n        Madul.LISTEN \"*.#{@constructor.name}.#{event}\", callback\n\n      fire: (event, args) ->\n        Madul.FIRE \"@.#{@constructor.name}.#{event}\", args\n\n      warn: (event, details) ->\n        Madul.FIRE \"!.#{@constructor.name}.#{event}\", details\n\n      _report: (name, method, state, id, args) =>\n        if state == 'reject'\n          Madul.FIRE \"!.#{name}.#{method}.#{state}\",\n            uuid:      id\n            message:   args\n            timestamp: microtime.now()\n        else\n          Madul.FIRE \"@.#{name}.#{method}.#{state}\",\n            uuid:      id\n            args:      args\n            timestamp: microtime.now()\n\n      _respond: (proto, method, id, deferred) =>\n        (state, data) =>\n          process.nextTick =>\n            deferred[state] data\n\n            proto._report proto.constructor.name, method, state, id, data\n\n      _prep_invocation: (proto, method, input, def) =>\n        id  = uuid.v4fast()\n        res = proto._respond proto, method, id, def\n\n        if Array.isArray input\n          input.push (out) => res 'resolve', out\n          input.push (err) => res 'reject',  err\n          input.push (out) => res 'notify',  out\n        else if typeof input == 'object'\n          input.done   = (out) => res 'resolve', out\n          input.fail   = (err) => res 'reject',  err\n          input.update = (out) => res 'notify',  out\n\n          input = [ input ]\n        else\n          msg = \"input to #{proto.constructor.name}.#{method} must be an Array of Object\"\n          proto.warn.call proto, 'input.invalid', msg\n          throw new Error msg\n\n        proto._report proto.constructor.name, method, 'invoke', id, input\n\n        input\n\n      _process_decorators: (type) =>\n        if Array.isArray me[type]\n          me[type].map (b) => Madul.PARSE_SPEC(b).ref\n        else if typeof me[type] == 'string'\n          [ Madul.PARSE_SPEC(me[type]).ref ]\n        else\n          [ ]\n\n      _do_wrap: (proto, method) =>\n        if method != 'fire' && method != 'warn' && method != 'listen'\n          Madul.FIRE \"$.#{proto.constructor.name}.#{method}.wrap\"\n\n          if typeof proto[method] == 'function'\n            proto[\"_#{method}\"] = proto[method]\n\n            proto[method] = =>\n              def  = q.defer()\n              args = Array.prototype.slice.call arguments\n\n              proto[\"_#{method}\"].apply proto, proto._prep_invocation proto, method, args, def\n\n              def.promise\n          else if typeof proto[method] == 'object'\n\n            if Array.isArray proto[method].validate\n              args_format = 'ARRAY'\n              decs        = proto[method].validate\n\n              proto[method].validators = for val, i in decs\n                \"#{i}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'object'\n              args_format = 'OBJECT'\n              decs        = for own key, val of proto[method].validate\n                val\n\n              proto[method].validators = for own key, val of proto[method].validate\n                \"#{key}\": Madul.PARSE_SPEC(val).ref\n            else if typeof proto[method].validate == 'string'\n              args_format = 'ARRAY'\n              decs        = [ proto[method].validate ]\n\n              proto[method].validators = [ { 0: Madul.PARSE_SPEC(proto[method].validate).ref }]\n            else if typeof proto[method].validate != 'undefined'\n              proto.warn.call proto, 'meta.invalid', validate: 'must be a String, Object, or Array'\n              return\n            else\n              args_format = 'ARRAY'\n              decs        = [ ]\n\n            if Array.isArray proto[method].before\n              decs = decs.concat proto[method].before\n            else if typeof proto[method].before == 'string'\n              decs = decs.concat [ proto[method].before ]\n\n            if Array.isArray proto[method].after\n              decs = decs.concat proto[method].after\n            else if typeof proto[method].after == 'string'\n              decs = decs.concat [ Madul.PARSE_SPEC proto[method].after ]\n\n            Madul.FIRE '$.Madul.decorators.hydrate', decs\n\n            @_do_hydrate proto, decs, =>\n              proto[\"_#{method}\"] = proto[method]\n\n              proto[method] = =>\n                def = q.defer()\n                me  = proto[\"_#{method}\"]\n\n                if args_format == 'ARRAY'\n                  args = Array.prototype.slice.call arguments\n                else if args_format == 'OBJECT'\n                  args = arguments[0]\n                else\n                  proto.warn.call proto, 'cannot-continue', 'No arg format specified'\n\n                  return def.reject 'No arg format specified'\n\n                validators = for v in me.validators\n                  arg       = Object.keys(v)[0]\n                  validator = v[arg]\n\n                  Madul.FIRE '$.Madul.validator.execute', \"#{validator}\": args[arg]\n\n                  proto[validator].EXECUTE.call proto[validator], args[arg]\n\n                before = @_process_decorators 'before'\n                after  = @_process_decorators 'after'\n\n                q.all validators\n                .then =>\n                  q.all before.map (b) =>\n                    Madul.FIRE '$.Madul.before_filter.execute', \"#{b}\": args\n                    proto[b].before.call proto[b], args\n                .then =>\n                  me.behavior.apply me, @_prep_invocation proto, method, args, def\n                .then (result) =>\n                  if after.length > 0\n                    q.all after.map (a) =>\n                      Madul.FIRE '$.Madul.after_filter.execute', \"#{a}\": result\n                      proto[a].after.call proto[a], result\n                  else\n                    d = q.defer()\n\n                    process.nextTick => d.resolve result\n\n                    d.promise\n                .then  (out) => def.resolve out\n                .catch (err) => def.reject  err\n\n                def.promise\n          else\n            proto.warn.call proto, 'cannot-wrap', method\n\n          WRAPPED[proto.constructor.name].push method\n\n      _wrap_methods: (proto, callback) =>\n        name    = proto.constructor.name\n        to_wrap = [ ]\n\n        while proto? && Object.keys(proto).length > 0 && WRAPPED[name]? == false\n          to_wrap.push { proto, name, methods: [ ] }\n\n          for own prop, body of proto\n            if prop[0]                  != '_'         &&\n               typeof proto[\"_#{prop}\"] == 'undefined' &&\n               WRAP(name, prop)         == true\n\n              continue if proto.deps? && proto.deps.indexOf(prop.replace(\/_\/g, '-')) > -1\n\n              if typeof body == 'function' || typeof body?.behavior == 'function'\n                to_wrap[to_wrap.length - 1].methods.push prop\n\n          proto = proto.__proto__\n          name  = proto.constructor.name\n\n        async.each to_wrap.reverse(), (wrap, completed) =>\n          async.each wrap.methods, (method, next) =>\n            wrap.proto._do_wrap wrap.proto, method\n\n            INITIALIZERS wrap.name, method if method[0] == '$'\n\n            next()\n          , => @_call_initializers_for wrap.proto, wrap.name, completed\n        , callback\n\n      _make_available: (name, mod) =>\n        Madul.FIRE \"$.#{name}.available\"\n\n        available[strip name] = mod\n\n      _hydrate_deps: (proto, done) =>\n        protos = [ proto ]\n\n        if proto.__proto__?\n          while proto.__proto__? && Object.keys(proto.__proto__).length > 0\n            protos.push proto = proto.__proto__\n\n        async.each protos.reverse(), (p, next) =>\n          name = p.constructor.name\n\n          if p.hasOwnProperty 'deps'\n            if HYDRATED[name] == undefined\n              HYDRATED[name]            = false\n              HYRDATION_LISTENERS[name] = [ next ]\n\n              p._do_hydrate p, p.deps, =>\n                HYDRATED[name] = true\n\n                for listener in HYRDATION_LISTENERS[name]\n                  listener()\n            else if HYDRATED[name] == false\n              HYRDATION_LISTENERS[name].push next\n            else if HYDRATED[name] == true\n              next()\n          else\n            next()\n        , done\n\n      _init_if_madul: (path, callback) =>\n        mod      = require path\n        proto    = mod\n        is_madul = false\n\n        while proto\n          is_madul = true if proto.name == 'Madul'\n          if is_madul                            == false      &&\n             proto.constructor.name              != 'Object'   &&\n             typeof proto                        == 'function' &&\n             typeof proto.__super__?.constructor == 'function'\n            proto = proto.__super__.constructor\n          else\n            proto = undefined\n\n        if is_madul\n          new mod()\n            .initialize()\n            .then callback\n        else\n          callback mod\n\n      _load: (me, name, path, loaded) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available name, mod\n          loaded mod\n\n      _check: (me, path, dep, ref, finished) =>\n        fs.readdir path, (err, files) =>\n          if err?\n            me.warn 'file-not-found', err\n\n            done type: 'ERROR', info: err\n          else\n            async.each files, (f, next) =>\n              depth = \"#{path}\/#{f}\"\n\n              fs.stat depth, (e, s) =>\n                if s.isDirectory() && f[0] != '.'\n                  me._check me, depth, dep, ref, next\n                else if s.isFile() && f.substring(0, f.length - 3) == dep\n                  me._load me, ref, depth, (mod) => me._do_add me, mod, ref, next\n                else\n                  next()\n            , finished\n\n      _do_add: (me, mod, ref, next) =>\n        Madul.FIRE \"$.#{me.constructor.name}.dependency.register\", ref\n\n        me[underscore ref] = mod\n\n        next()\n\n      _add: (me, ref, path, next) =>\n        me._init_if_madul path, (mod) =>\n          me._make_available ref, mod\n          me._do_add me, mod, ref, next\n\n      _do_hydrate: (proto, deps, hydration_complete) =>\n        initers = [ ]\n\n        async.each deps, (d, next) =>\n          { ref, alias, name, root, initer, pres, local } = Madul.PARSE_SPEC d\n\n          if pres?\n            insert_at = for p in pres\n              index_for = (sibling) => sibling.alias == p.alias\n\n              initers.find index_for\n\n            insert_at.sort()\n\n            insert_at = if insert_at.length == 0 then 0 else insert_at[insert_at.length - 1]\n\n            initers.splice insert_at, 0, alias: alias, execute: initer\n\n          if proto[underscore ref]? == false\n            if available[strip ref]? == true\n              proto._do_add proto, available[strip ref], ref, next\n            else\n              if root?\n                Madul.FIRE '$.Madul.search_root.load', { name, alias, root }\n\n                @_do_hydrate proto, [ root ], =>\n                  if SEARCH_ROOTS[root] == undefined\n                    SEARCH_ROOTS[root] = @_find_code_root root\n\n                  proto._check proto, SEARCH_ROOTS[root], name, ref, next\n              else if local\n                proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n              else\n                try\n                  proto._add proto, ref, name, next\n                catch e\n                  cwd = process.cwd()\n                  pkg = \"#{cwd}\/node_modules\/#{name}\/package.json\"\n\n                  fs.stat pkg, (err, stat) =>\n                    if stat?.isFile()\n                      fs.readFile pkg, 'utf8', (err, data) =>\n                        json = JSON.parse data\n                        main = json.main || json._main || 'index.js'\n                        path = \"#{cwd}\/node_modules\/#{name}\/#{main}\"\n\n                        proto._add proto, ref, path, next\n                    else\n                      proto._check proto, LOCALS[proto.constructor.name], name, ref, next\n          else\n            next()\n        , =>\n          async.eachSeries initers, (initer, next) =>\n            proto[initer.execute].apply(@).then next\n          , hydration_complete\n\n      _finish_up: (proto, args) =>\n        name = proto.constructor.name\n\n        if listeners[name]?\n          async.each listeners[name], (listener, next) =>\n            listener @\n            next()\n          , => @_register_initialized name\n        else\n          @_register_initialized name\n\n      _register_initialized: (name) =>\n        @_make_available name, @\n\n        initialized[name] = true\n\n        Madul.FIRE \"$.#{name}.initialized\"\n\n      _call_initializers_for: (proto, name, callback) =>\n        if _INITIALIZERS[name]?\n          async.each _INITIALIZERS[name], (initializer, next) =>\n            if initializer.called == false\n              proto[initializer.fn].apply proto\n                .then =>\n                  initializer.called = true\n                  next()\n            else\n              next()\n          , callback\n        else\n          callback()\n\n      _find_code_root: (resource) =>\n        file  = resource.toLowerCase()\n        found = for own key, val of require.cache\n          if key.replace(\/_\/g, '').toLowerCase().includes file\n            key.substring(0, key.lastIndexOf '\/').split '\/'\n\n        found\n          .filter (f) => f?\n          .sort((a, b) => a.length - b.length)[0]\n          .join '\/'\n\n      initialize: =>\n        deferred = q.defer()\n        proto    = @.__proto__\n        name     = proto.constructor.name\n\n        Madul.FIRE \"$.#{name}.request_instance\"\n\n        if initialized[name] == undefined\n          Madul.FIRE \"$.#{name}.initialize\"\n\n          initialized[name] = false\n          listeners[name]   = [ deferred.resolve ]\n\n          if LOCALS[name] == undefined\n            LOCALS[name] = @_find_code_root name\n\n          @_hydrate_deps proto, => @_wrap_methods proto, => @_finish_up proto\n        else if initialized[name] == false\n          listeners[name].push deferred.resolve\n        else if initialized[name] == true\n          process.nextTick => deferred.resolve available[strip name]\n\n        deferred.promise\n\n    module.exports = Madul\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"babf63867f9a0bb7fa160244919b999cd45cf4df","subject":"Fix broken github markdown.","message":"Fix broken github markdown.\n\nAdd paragraph between bullet list and code block.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\n### The `TimeAxisMaker` class\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\nThe code:\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n### The `TimeAxisRenderer` class\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\nThe code:\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n      timeAxisRedrerer = new TimeAxisRenderer()\n      timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nNotes\n-----\n\n### Notes related to only this file\n\nWell, no notes yet.\n\n### Notes that should be moved away at some point\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug. __Update__:  it seems that it doesn't work at all in github, something should be between a bullet list and a code block, otherwise github does not show code as code.  I will send a question to support@github.com\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nAbstract\n--------\n\nThis file contains an experimental implementation of time axis visualization in literate CoffeeScript.  Description is followed by source code with explanations and small demo examle.\n\nTable of Contents\n-----------------\n\n 1. [Introduction and description](#introduction-and-description)\n 2. [Test cases](#test-cases)\n 3. [Development concerns](#development-concerns)\n 4. [Library implementation](#library-implementation)\n    1. [The `TimeAxisMaker` class](#the-timeaxismaker-class)\n    2. [The `TimeAxisRenderer` class](#the-timeaxisrenderer-class)\n 5. [Library tests](#library-tests)\n 6. [Examples](#examples)\n 7. [Notes](#notes)\n\n------------------------------------------------------------\n\nIntroduction and description\n----------------------------\n\n### Our reasons and objectives\n\n * Try [CoffeeScript](http:\/\/coffeescript.org\/)\n * Try [Literate Programming](https:\/\/en.wikipedia.org\/wiki\/Literate_programming)\n * Reimplement time axis and try new visual and technical ideas\n\n### Description\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\n------------------------------------------------------------\n\nLibrary implementation\n----------------------\n\nCurrently the job of visualizing time axis is split into two steps:  building structure of graphical features (such as lines and text labels) and displaying them (for example on html canvas).  The code for these steps is separated, so that an axis may be displayed using different technologies easily (html canvas, png, webgl, ...).  The first step is done using the `TimeAxisMaker` class, and the second step is done using the `TimeAxisRenderer` class.\n\n### The `TimeAxisMaker` class\n\nSince our formatting of time axis involves a lot of calculations, it is separated in several functions, and they are combined in the `TimeAxisMaker` class.\n\n    class TimeAxisMaker\n\n#### The `TimeAxisMaker()` constructor\n\nThe `options` parameter is a dictionary with values that are needed for formatting timeline:\n * `options.tickLength`:  length (in pixels) of tick from baseline downwards.\n * `options.intervalType`:  base interval that is displayed (should be integral); can be on of 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'.\n * `options.labelPlacement`:  'point' or 'interval';  the first is for putting text labels under corresponding ticks, the second is for putting text labels between ticks (that is under intervals).\n * `options.intervalMultiplier`:  number of base intervals that should be skipped between consequent ticks.\n\n\n      constructor: (options) ->\n        @options =\n          tickLength: options.tickLength ? 10\n          intervalType: options.intervalType ? 'year'\n          labelPlacement: options.labelPlacement ? 'point'\n          intervalMultiplier: options.intervalMultiplier ? 1\n\n_Note_:  I wonder if the code above that assigns default values could be improved.\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters:\n * `interval`:  a dictionary with `start` and `end` values, each of `Date` type.\n * `width` is the corresponding to that interval width of a viewport.\n\nIt returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for an interval:\n * `start`:  when the interval starts, `Date` object.\n * `end`:  when interval ends, `Date` object.\n\nIt returns a list of `Date` objects.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not greater than a given point of time.  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\nFunction arguments:\n * `start`:  a point of time, `Date` object.\n\nIt returns a `Date` object.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() -\n              start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() -\n              start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() -\n              start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() -\n              start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n#### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\nFunction arguments:\n * `timePoint`:  current edge time point, `Date` object.\n\nIt returns a `Date` object.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() +\n              @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() +\n              @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() +\n              7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() +\n              @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() +\n              @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() +\n              @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() +\n              @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() +\n              @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\nFunction arguments:\n * `time`:  time point, `Date` object.\n\nIt returns a number between 0 and `@width`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n### The `TimeAxisRenderer` class\n\nThe `TimeAxisRenderer` class currently renders only to html canvas.\n\n    class TimeAxisRenderer\n\n#### The `TimeAxisRenderer` constructor\n\n      constructor: () ->\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nInstead of writing the same code again when we need canvas coordinates we define an additional nested function `translateCoord()` that turns logical corrdinates into canvas coordinates.\n\n        translateCoord = (coordX, coordY) =>\n          newCoord = [\n            @roundForCanvas(left + coordX)\n            @roundForCanvas(top + coordY)\n          ]\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          [x1, y1] = translateCoord(line.x1, line.y1)\n          [x2, y2] = translateCoord(line.x2, line.y2)\n          context.moveTo x1, y1\n          context.lineTo x2, y2\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\n------------------------------------------------------------\n\nExamples\n--------\n\nThe following small example is supposed to work together with an html-file that contains a canvas element with `id` equal to 'timeline'.\n\nTime axis is displayed in that canvas;  it could be dragged using mouse and zoomed using mouse wheel.\n\n### The source code\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timeAxisMaker = new TimeAxisMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n      timeAxisRedrerer = new TimeAxisRenderer()\n      timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timeAxisMaker.formatTimeAxis {start, end}, canvas.width\n          timeAxisRedrerer.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n\n------------------------------------------------------------\n\nNotes\n-----\n\n### Notes related to only this file\n\nWell, no notes yet.\n\n### Notes that should be moved away at some point\n\nThese notes are currently a draft of coding style, tricks and ideas that could be used in every CoffeeScript file.\n\nImportant notes:\n * Between a bullet list and code block there should be at lest 2 empty lines, otherwise code is not formatted correctly in Github.  However, it compiles without problem and works as it should.  This is probably a Github's bug.\n * Use 60 dashes to include a horizontal line.  That makes horizontal line easily viewable in an editor too.\n * Limit line to 79 characters, at least code (text could be soft-wrapped).  That improves readability, even though screens are large these times.  Also it makes possible to view several documents on one screen.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8d86044b8595ab8876b803e986ea2727ca6e44e2","subject":"carve_path is does nothing asynchronously, so it doesn't need madul wrapping","message":"carve_path is does nothing asynchronously, so it doesn't need madul wrapping\n\nRefactored `Carver` to work completely syncronously. Previously `carve_path`\nwas being wrapped my Madul's magic, but I found out that that was causing\nproblems. Forcing sync behavior to be treated as async behavior was causing\nweird things to happen once I implemented a more complex rendering workflow\n(which I just realized I haven't committed yet ... d'oh!)\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/carver.litcoffee","new_file":"lib\/carver.litcoffee","new_contents":"    Module = require '.\/module'\n    q      = require 'q'\n\n    class Carver extends Module\n      deps: [ 'config' ]\n\n      starting_row: 0\n\n      row:   0\n      col:   0\n      steps: 0\n\n      previous_direction: undefined\n      total_distance:     0\n      farthest_right:\n        row: 0\n        col: 0\n\n      directions:\n        LEFT:  0\n        RIGHT: 1\n        UP:    2\n        DOWN:  3\n\n      clear_state: =>\n        @row  = @starting_row\n        @col  = 0\n\n        @farthest_right     = row: @row, col: 0\n        @previous_direction = undefined\n\n        @steps          = 0\n        @total_distance = 0\n\n        for row, r in @config.grid\n          for cell, c in @config.grid[r]\n            @config.grid[r][c] = false\n\n        @config.grid[@row][@col] = true\n\n      update_steps: (dir) =>\n        if @previous_direction?\n          if @previous_direction == @directions[dir]\n            ++@steps\n          else\n            @steps = 0\n        else\n          @previous_direction = @directions[dir]\n          @steps = 0\n\n      neighbor: (x = 0, y = 0) => @config.grid[@row + x][@col + y]\n\n      carve_path: =>\n        more_to_carve = true\n        path          = [{ row: @row, col: @col }]\n\n        while more_to_carve\n          neighbors = [ ]\n          width     = @config.grid[0].length\n          height    = @config.grid.length\n\n          neighbors.push 'UP'    if @row > 0          && @neighbor(-1,  0) == false\n          neighbors.push 'DOWN'  if @row < height - 2 && @neighbor( 1,  0) == false\n          neighbors.push 'LEFT'  if @col > 0          && @neighbor( 0, -1) == false\n          neighbors.push 'RIGHT' if @col < width      && @neighbor( 0,  1) == false\n\n          if neighbors.length == 0\n            @col = @farthest_right.col\n            @row = @farthest_right.row\n\n            continue\n          else\n            direction = @config.pathfinder neighbors\n\n            switch @directions[direction]\n              when @directions.RIGHT then @config.grid[@row][++@col] = true\n              when @directions.LEFT  then @config.grid[@row][--@col] = true\n              when @directions.UP    then @config.grid[--@row][@col] = true\n              when @directions.DOWN  then @config.grid[++@row][@col] = true\n              when undefined         then continue\n\n            @update_steps direction\n\n            if @col > @farthest_right.col\n              @farthest_right.col = @col\n              @farthest_right.row = @row\n\n            if @farthest_right.col < @config.grid[0].length - 1\n              path.push row: @row, col: @col, direction: direction\n\n              continue\n            else\n              more_to_carve = false\n\n        path\n\n    module.exports = Carver\n","old_contents":"    Module = require '.\/module'\n    q      = require 'q'\n\n    class Carver extends Module\n      deps: [ 'config' ]\n      pub: [ 'carve_path' ]\n\n      row:   0\n      col:   0\n      steps: 0\n      path:  [ ]\n\n      previous_direction: undefined\n      total_distance:     0\n      farthest_right:\n        row: 0\n        col: 0\n\n      directions:\n        LEFT:  0\n        RIGHT: 1\n        UP:    2\n        DOWN:  3\n\n      initialize: (starting_row) =>\n        deferred = q.defer()\n\n        @path = [ ]\n        @row  = starting_row\n        @col  = 0\n\n        @farthest_right     = row: @row, col: 0\n        @previous_direction = undefined\n\n        @steps          = 0\n        @total_distance = 0\n\n        super().then =>\n          @config.grid[@row][@col] = true\n          @path.push row: @row, col: @col\n\n          deferred.resolve @\n\n        deferred.promise\n\n      update_steps: (dir) =>\n        if @previous_direction?\n          if @previous_direction == @directions[dir]\n            ++@steps\n          else\n            @steps = 0\n        else\n          @previous_direction = @directions[dir]\n          @steps = 0\n\n      neighbor: (x = 0, y = 0) => @config.grid[@row + x][@col + y]\n\n      carve_path: =>\n        neighbors = [ ]\n        width     = @config.grid[0].length\n        height    = @config.grid.length\n\n        neighbors.push 'UP'    if @row > 0          && @neighbor(-1,  0) == false\n        neighbors.push 'DOWN'  if @row < height - 2 && @neighbor( 1,  0) == false\n        neighbors.push 'LEFT'  if @col > 0          && @neighbor( 0, -1) == false\n        neighbors.push 'RIGHT' if @col < width      && @neighbor( 0,  1) == false\n\n        if neighbors.length == 0\n          @col = @farthest_right.col\n          @row = @farthest_right.row\n\n          @carve_path()\n        else\n          direction = @config.pathfinder neighbors\n\n          switch @directions[direction]\n            when @directions.RIGHT then @config.grid[@row][++@col] = true\n            when @directions.LEFT  then @config.grid[@row][--@col] = true\n            when @directions.UP    then @config.grid[--@row][@col] = true\n            when @directions.DOWN  then @config.grid[++@row][@col] = true\n            when undefined         then return @carve_path()\n\n          @update_steps direction\n\n          if @col > @farthest_right.col\n            @farthest_right.col = @col\n            @farthest_right.row = @row\n\n          if @farthest_right.col < @config.grid[0].length - 1\n            @path.push row: @row, col: @col, direction: direction\n\n            stats =\n              position:\n                row: @row\n                col: @col\n              steps: @steps\n              direction: direction\n              distance: ++@total_distance\n\n            @update stats\n\n            @carve_path()\n          else\n            @done @path\n\n    module.exports = Carver\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"56316fdd4208b30f1081fa5f4d59fc3ab7a8c993","subject":"Update functions.litcoffee","message":"Update functions.litcoffee","repos":"andychase\/date_machine,andychase\/date_machine,andychase\/date_machine,andychase\/date_machine","old_file":"date_machine\/javascript\/functions.litcoffee","new_file":"date_machine\/javascript\/functions.litcoffee","new_contents":"### This file\n\nThe logic in this file builds the date object.\n\nIf you compare this file to the ```python\/functions.py``` file\nyou'll notice they are very similiar. That's intentional,\nthis file was ported over and kept such that it would be somewhat\neasy to port changes back and forth.\n\n### Terminology\n\nBecause it's so confusing here is a list of the different levels to refer to:\n\n- Groups \n  -- This is the capture groups. The lowest level. ```([0-9])``` etc.\n  \"Day\", \"Month\", etc.\n- Expressions \n  -- This is an expression with multiple capture groups. They're usually named\n  after the person that wrote them. \"Greg Burns\", etc.\n  \n  In Python, Expressions functions have nice named arguments, def expr(Day, Month, Year),\n  but Javascript doesn't support this.\n- Type\n  -- This is a collection of expressions with a common goal.\n  Months (Jan, 0-12, January, etc.). \n- Patterns\n  -- This is a collection of types ```<Month>\/<Day>\/<Year>```\n\n### Warning\n\nA note about the above list. Types and Groups are commonly mixed up.\nI think groups SHOULD be the lowest \n(because they are the actual capture *groups* in regular expressions)\nbut a group of expressions also makes sense.\n\nIt's so confusing that there are at least a couple places here that I've\nalso mixed myself up and probably in the documentation for RE|PARSE as well.\n\n---\n\nI use named tuples in python, and ```_replace``` mirrors the functionality of \n```date._replace```.. that is that it returns a copy of the date with only\ncertain things changed and leaves the old well enough alone.\n\n        _replace = (_old, _new) ->\n            year:   if _new.year? then _new.year else _old.year\n            month:  if _new.month? then _new.month else _old.month\n            day:    if _new.day? then _new.day  else _old.day\n            hour:   if _new.hour? then _new.hour else _old.hour\n            minute: if _new.minute? then _new.minute else _old.minute\n            second: if _new.second? then _new.second else _old.second\n            am_pm:  if _new.am_pm? then _new.am_pm else _old.am_pm\n\nI represent lengths of dates (i.e. Thursday, 1-2pm) with a timedelta that goes right\nafter the date hash in the result array.\n\nIn Javascript, I'm just going to represent a timedelta with a hash.\nI make a pretty dumb assumption that timedelta will only cross hour\/minutes\/second boundaries.\n\n        timedelta_from_Date = (start_time, end_time) ->\n            seconds_difference = 0\n            if start_time.hour? and end_time.hour?\n              seconds_difference += 60*60*(end_time.hour - start_time.hour)\n\n              if start_time.minute? and end_time.minute?\n                seconds_difference += 60*(end_time.minute - start_time.minute)\n\n                if start_time.second? and end_time.second?\n                  seconds_difference += end_time.second - start_time.second\n\n            hours = Math.floor(seconds_difference\/60\/60)\n            minutes = Math.floor(seconds_difference\/60) - (hours * 60)\n            seconds = seconds_difference - (minutes * 60) - (hours * 60 * 60)\n\n            return {\n               timedelta: true\n               hours: hours\n               minutes: minutes\n               seconds: seconds\n            }\n\n\nThis is just a helper function\n\n        in_array = (arr, _) -> arr.indexOf(_) != -1\n\n```progressive_match``` is useful for matching abbreviations\nand full spellings. Functions like this could be useful\nto help parse fuzzy matches in the future (i.e. misspellings of months).\n\n        progressive_match = (string, possibilities) ->\n            part = \"\"\n            if not string? then return\n            for character in string.toLowerCase()\n                part += character\n                matches = []\n                for month, value of possibilities\n                    if month.indexOf(part) > -1\n                        matches.push(month)\n                if matches.length == 1\n                    return possibilities[matches[0]]\n### Types\n\n\n        month_to_number = (month_string) ->\n          months =\n              \"january\": 1\n              \"february\": 2\n              \"march\": 3\n              \"april\": 4\n              \"may\": 5\n              \"june\": 6\n              \"july\": 7\n              \"august\": 8\n              \"september\": 9\n              \"october\": 10\n              \"november\": 11\n              \"december\": 12\n           return progressive_match(month_string, months)\n\n        weekday_to_number = (WeekdayString ) ->\n            weekday_list = {\n                \"monday\": 0,\n                \"tuesday\": 1,\n                \"wednesday\": 2,\n                \"thursday\": 3,\n                \"friday\": 4,\n                \"saturday\": 5,\n                \"sunday\": 6,\n            }\n            return progressive_match(WeekdayString, weekday_list)\n\nI serialize am_pm by converting the hours to milliary\/24-hour time format.\nI also include ```am_pm: 'pm'``` in the date format to show that that transformation\nwas done. Making that clear helpful because if you get a time like 1, with no ```am_pm```\ndesignation you might want to assume pm and add 12. This is not done in the libary because\ndate_machine strives for honesty, not guesswork.\n\n        am_pm = (input) ->\n            if not input?\n              return\n            if input.toLowerCase() == \"am\" then 0\n            else if input.toLowerCase() == \"pm\" then 12\n\nI try not to repeat logic and use other functions when possible.\nI could put ```\"Steve Valaitis2\": time_expression``` to avoid this,\nbut I wrote it out to show that nothing special happens with 24-hour\/military time.\n\n        military_time = (MilHour, MilMinute, MilSecond ) ->\n            return time_expression(MilHour, MilMinute, MilSecond, undefined)\n\nHere is the am\/pm conversion. I omit returns when the expressions are simple,\nbut later on I want to use them as much as possible to make my intentions clear.\n\n        noon = (hour, AMPM) -> hour == 12 and AMPM == 12\n        midnight = (hour, AMPM) -> hour == 12 and AMPM == 0\n\nThis function gets called pretty often, I'd consider it the bulk\nof the output logic.\n\n        time_expression = (Hour, Minute, Second, AMPM, SpecialTimeText ) ->\n            if not Hour? and not Minute? and not Second? and not AMPM? and not SpecialTimeText?\n                return\n            if SpecialTimeText\n                if SpecialTimeText.toLowerCase() == \"noon\"\n                    return {hour: 12}\n                if SpecialTimeText.toLowerCase() == \"midnight\"\n                    return {hour: 0}\n            d = {}\n            if Hour\n                d.hour = Number(Hour)\n            if Minute\n                d.minute = Number(Minute)\n            if Second\n                d.second = Number(Second)\n            if AMPM?\n                if d.hour\n                    if noon(d.hour, AMPM)\n                        d.hour = 12\n                    else if midnight(d.hour, AMPM)\n                        d.hour = 0\n                    else\n                        d.hour = d.hour + AMPM\n                d.am_pm = AMPM\n            if [d.hour, d.minute, d.second] == [undefined, undefined, undefined]\n                return undefined\n            return d\n\n        time_and_time = (Hour, Minute, AMPM1, Hour2, Minute2, AMPM2) ->\n            if AMPM2?\n                AMPM2 = am_pm(AMPM2)\n            if not AMPM1? and not AMPM2?\n                return [time_expression(Hour, Minute), time_expression(Hour2, Minute2)]\n            else if not AMPM1?\n                return [time_expression(Hour, Minute, undefined, AMPM2),\n                        time_expression(Hour2, Minute2, undefined, AMPM2)]\n            else if not AMPM2?\n                return [time_expression(Hour, Minute, undefined, AMPM1),\n                        time_expression(Hour2, Minute2, undefined, AMPM1)]\n\n\n        month_type = (input...) ->\n            for value in input\n                if value?\n                    return Number(value)\n\n\n        date_number = (Day, Abbr) -> if Day? then Number(Day)\n\n        month_number = (MonthNum) -> Number(MonthNum)\n\n        month_num_type = (input) -> Number(input)\n\n        year = (Year) -> if Year? then Number(Year)\n\nSometimes the value is ```[undefined, undefined, <value>]```,\nso I need to search for it and find it. There's enough\nof these smaller expressions scattered around that moving them\nall to one place might be good.\n\n        get_first_defined = (_) ->\n          for item in _\n            if item?\n              return item\n\n### Patterns\n\nThere's a some unwrapping values out of arrays here.\nBecause there's no named-arguments, functions receive a lot more\narrays here then in Python and so they need to be unwrapped.\n\n        weekday_range_with_time = (time1, time2, [weekday1], [weekday2], MonthRange) ->\n            output = []\n\n            # Get first undefined value\n            # Since only one value in list will be defined (if any)\n            time1 = get_first_defined(time1)\n            time2 = get_first_defined(time2)\n\n            if time1?\n                for date in MonthRange\n                    output.push(_replace(date, time1))\n                    if time2?\n                        output.push(_replace(date, time2))\n            return output\n\n\n        weekday_range_with_extra = ( time, and_time, weekday_start, weekday_end, extra_time, extra_weekday, MonthRange) ->\n            output = []\n            if time?\n                for date in MonthRange\n                    if date.weekday?\n                        if date.weekday in [weekday_start .. weekday_end]\n                            output.push(_replace(date, time))\n                            if and_time?\n                                output.push(_replace(date, and_time))\n                        if date.weekday == extra_weekday\n                            output.push(_replace(date, extra_time))\n            return output\n\n\n        weekday_range_with_extra_backwards = (extra_time, extra_weekday, time, weekday_start, weekday_end, MonthRange ) ->\n            return weekday_range_with_extra(time[0], time[1], weekday_start, weekday_end, extra_time, extra_weekday, MonthRange )\n\n\n        reverse_basic_text = (time, day, month, year) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        basic_text = (time, first_second, weekday, month, day, year) ->\n            if not day?\n                day = 1\n            if (day instanceof Array) and day.length == 1\n              day = day[0]\n            if (year instanceof Array) and year.length == 1\n              year = year[0]\n            if not time?\n                return {year: year, month: month, day: day}\n            else\n                year: year\n                month: month\n                day: day\n                hour: time.hour\n                minute: time.minute\n                second: time.second\n                am_pm: time.am_pm\n\n\n        slash = (month, day, year, time) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        month_range = (month, date_a, date_b) ->\n            output = []\n            for day in [date_a .. date_b]\n                output.push(basic_text(undefined, undefined, undefined, month, day, undefined))\n            return output\n\n\n        multi_time = (time1, BasicText) ->\n            output = []\n            if time1? and BasicText?\n                output.push(_replace(BasicText, time1))\n                output.push(BasicText)\n                return output\n\n\n        large_repeat_words = ->\n            return undefined\n\n\n        weekday_range_with_time_range = (time1, weekday_range) ->\n            output = []\n            if time1? and weekday_range?\n                range = timedelta_from_Date(_replace(weekday_range[0], time1), weekday_range[0])\n                for weekday in weekday_range\n                    output.push(_replace(weekday, {hour:time1.hour, minute:time1.minute, am_pm:time1.am_pm}))\n                    output.push(range)\n                return output\n\n\n        time_range = (unstrict_time, strict_time, date, reverse) ->\n            endtime = date\n            starttime = endtime\n            if unstrict_time\n                starttime = _replace(starttime, {hour:Number(unstrict_time[0])})\n                if date.am_pm\n                    starttime = _replace(starttime, {hour: starttime.hour + date.am_pm, am_pm:date.am_pm})\n            else\n                starttime = _replace(starttime, {hour: strict_time.hour, minute: strict_time.minute})\n\n            time_range = timedelta_from_Date(starttime, endtime)\n            if reverse\n                time_range = timedelta_from_Date(endtime, starttime)\n            return [starttime, time_range]\n\n\n        alt_time_range = (first_second, weekday, month, day, year, time, unstrict_time, strict_time) ->\n            return time_range(unstrict_time, strict_time, basic_text(time, first_second, weekday, month, day, year), reverse)\n\n\n        until_range = (date1, date2) ->\n            if date1 and date2\n                return [date1, timedelta_from_Date(date1, date2)]\n\n\n        through_range = (time, weekday1, weekday2, month, date, beginning) ->\n            output = []\n            if month and date and beginning and weekday1\n                ending =\n                    month: month\n                    day: date\n                for day in [beginning.day .. ending.day]\n                    temp =\n                        month: month\n                        day: date\n                    if temp.weekday and in_array([weekday1 .. weekday2], temp.weekday)\n                        if time\n                            output.push(_replace(temp, time))\n                        else\n                            output.push(temp)\n                return output\n\n\n### The function list\n\nThis hash\/object matches all the functions with a\nstring that represents it in the parse tree.\n\n        functions =\n            # Groups\n            \"MonthString\": month_to_number,\n            \"AMPM\": am_pm,\n            # Expressions\n            \"Chase Year\": year,\n            \"Chase Date\": date_number,\n            \"Chase Month\": month_number,\n            \"Steve Valaitis\": time_expression,\n            \"Greg Burns\": (hour, am_pm) -> time_expression(hour, null, null, am_pm, null),\n            \"Greg Burns UnstrictTime:\": time_expression,\n            \"Steve Valaitis2\": military_time,\n            \"Steve Valaitis And Time\": time_and_time,\n            \"Text Parts\": time_expression,\n            \"Michael Ash10\": weekday_to_number,\n            # Types\n            \"Month\": month_type,\n            \"MonthNum\": month_num_type,\n            # Patterns\n            \"LargeRepeatWords\": large_repeat_words,\n            \"BasicText\": basic_text,\n            \"ReverseBasicText\": reverse_basic_text,\n            \"Slash\": slash,\n            \"MonthRange\": month_range,\n            \"MultiTime\": multi_time,\n            \"WeekdayRangeWithTime\": weekday_range_with_time,\n            \"WeekdayRangeWithExtra\": weekday_range_with_extra,\n            \"WeekdayRangeWithExtraBackwards\": weekday_range_with_extra_backwards,\n            \"WeekdayRangeWithTimeRange\": weekday_range_with_time_range,\n            \"UntilRange\": until_range,\n            \"ThroughRange\": through_range,\n            \"TimeRange\": time_range,\n            \"AltTimeRange\": alt_time_range,\n\nThis is default expression or pattern. ```any``` means\nif value is defined, and there is array with even a single defined value then return true.\n\n            \"_default\": (_) ->\n                if any(_) then _ else undefined\n\nRecall ```Type``` here means collection of expressions.\nThere only one will matching expression due to the way regex works ```(a)|(b)```,\nso you just have to find it and return it.\n\n            \"_default_type\": (_...) ->\n                if _?\n                    for item in _\n                         if item?\n                             return item\n\n            \"_default_group\": (_...) -> if _[0]? then _[0]\n","old_contents":"### This file\n\nThe logic in this file builds the date object.\n\nIf you compare this file to the ```python\/functions.py``` file\nyou'll notice they are very similiar. That's intentional,\nthis file was ported over and kept such that it would be somewhat\neasy to port changes back and forth.\n\n### Terminology\n\nBecause it's so confusing here is a list of the different levels to refer to:\n\n- Groups \n  -- This is the capture groups. The lowest level. ```([0-9])``` etc.\n  \"Day\", \"Month\", etc.\n- Expressions \n  -- This is an expression with multiple capture groups. They're usually named\n  after the person that wrote them. \"Greg Burns\", etc.\n  \n  In Python, Expressions functions have nice named arguments, def expr(Day, Month, Year),\n  but Javascript doesn't support this.\n- Type\n  -- This is a collection of expressions with a common goal.\n  Months (Jan, 0-12, January, etc.). \n- Patterns\n  -- This is a collection of types ```<Month>\/<Day>\/<Year>```\n\n### Warning\n\nA note about the above list. Types and Groups are commonly mixed up.\nI think groups SHOULD be the lowest \n(because they are the actual capture *groups* in regular expressions)\nbut a group of expressions also makes sense.\n\nIt's so confusing that there are at least a couple places here that I've\nalso mixed myself up and probably in the documentation for RE|PARSE as well.\n\n---\n\nI use named tuples in python, and ```_replace``` mirrors the functionality of \n```date._replace```.. that is that it returns a copy of the date with only\ncertain things changed and leaves the old well enough alone.\n\n        _replace = (_old, _new) ->\n            year:   if _new.year? then _new.year else _old.year\n            month:  if _new.month? then _new.month else _old.month\n            day:    if _new.day? then _new.day  else _old.day\n            hour:   if _new.hour? then _new.hour else _old.hour\n            minute: if _new.minute? then _new.minute else _old.minute\n            second: if _new.second? then _new.second else _old.second\n            am_pm:  if _new.am_pm? then _new.am_pm else _old.am_pm\n\nI represent lengths of dates (i.e. Thursday, 1-2pm) with a timedelta that goes right\nafter the date hash in the result array.\n\nIn Javascript, I'm just going to represent a timedelta with a hash.\nI make a pretty dumb assumption that timedelta will only cross hour\/minutes\/second boundaries.\n\n        timedelta_from_Date = (start_time, end_time) ->\n            seconds_difference = 0\n            if start_time.hour? and end_time.hour?\n              seconds_difference += 60*60*(end_time.hour - start_time.hour)\n\n              if start_time.minute? and end_time.minute?\n                seconds_difference += 60*(end_time.minute - start_time.minute)\n\n                if start_time.second? and end_time.second?\n                  seconds_difference += end_time.second - start_time.second\n\n            hours = Math.floor(seconds_difference\/60\/60)\n            minutes = Math.floor(seconds_difference\/60) - (hours * 60)\n            seconds = seconds_difference - (minutes * 60) - (hours * 60 * 60)\n\n            return {\n               timedelta: true\n               hours: hours\n               minutes: minutes\n               seconds: seconds\n            }\n\n\nThis is just a helper function\n\n        in_array = (arr, _) -> arr.indexOf(_) != -1\n\n```progressive_match``` is useful for matching abbreviations\nand full spellings. Functions like this could be useful\nto help parse fuzzy matches in the future (i.e. misspellings of months).\n\n        progressive_match = (string, possibilities) ->\n            part = \"\"\n            if not string? then return\n            for character in string.toLowerCase()\n                part += character\n                matches = []\n                for month, value of possibilities\n                    if month.indexOf(part) > -1\n                        matches.push(month)\n                if matches.length == 1\n                    return possibilities[matches[0]]\n### Types\n\n\n        month_to_number = (month_string) ->\n          months =\n              \"january\": 1\n              \"february\": 2\n              \"march\": 3\n              \"april\": 4\n              \"may\": 5\n              \"june\": 6\n              \"july\": 7\n              \"august\": 8\n              \"september\": 9\n              \"october\": 10\n              \"november\": 11\n              \"december\": 12\n           return progressive_match(month_string, months)\n\n        weekday_to_number = (WeekdayString ) ->\n            weekday_list = {\n                \"monday\": 0,\n                \"tuesday\": 1,\n                \"wednesday\": 2,\n                \"thursday\": 3,\n                \"friday\": 4,\n                \"saturday\": 5,\n                \"sunday\": 6,\n            }\n            return progressive_match(WeekdayString, weekday_list)\n\nI serialize am_pm by converting the hours to milliary\/24-hour time format.\nI also include ```am_pm: 'pm'``` in the date format to show that that transformation\nwas done. Making that clear helpful because if you get a time like 1, with no ```am_pm```\ndesignation you might want to assume pm and add 12. This is not done in the libary because\ndate_machine strives for honesty, not guesswork.\n\n        am_pm = (input) ->\n            if not input?\n              return\n            if input.toLowerCase() == \"am\" then 0\n            else if input.toLowerCase() == \"pm\" then 12\n\nI try not to repeat logic and use other functions when possible.\nI could put ```\"Steve Valaitis2\": time_expression``` to avoid this,\nbut I wrote it out to show that nothing special happens with 24-hour\/military time.\n\n        military_time = (MilHour, MilMinute, MilSecond ) ->\n            return time_expression(MilHour, MilMinute, MilSecond, undefined)\n\nHere is the am\/pm conversion. I omit returns when the expressions are simple,\nbut later on I want to use them as much as possible to make my intentions clear.\n\n        noon = (hour, AMPM) -> hour == 12 and AMPM == 12\n        midnight = (hour, AMPM) -> hour == 12 and AMPM == 0\n\nThis function gets called pretty often, I'd consider it the bulk\nof the output logic.\n\n        time_expression = (Hour, Minute, Second, AMPM, SpecialTimeText ) ->\n            if not Hour? and not Minute? and not Second? and not AMPM? and not SpecialTimeText?\n                return\n            if SpecialTimeText\n                if SpecialTimeText.toLowerCase() == \"noon\"\n                    return {hour: 12}\n                if SpecialTimeText.toLowerCase() == \"midnight\"\n                    return {hour: 0}\n            d = {}\n            if Hour\n                d.hour = Number(Hour)\n            if Minute\n                d.minute = Number(Minute)\n            if Second\n                d.second = Number(Second)\n            if AMPM?\n                if d.hour\n                    if noon(d.hour, AMPM)\n                        d.hour = 12\n                    else if midnight(d.hour, AMPM)\n                        d.hour = 0\n                    else\n                        d.hour = d.hour + AMPM\n                d.am_pm = AMPM\n            if [d.hour, d.minute, d.second] == [undefined, undefined, undefined]\n                return undefined\n            return d\n\n        time_and_time = (Hour, Minute, AMPM1, Hour2, Minute2, AMPM2) ->\n            if AMPM2?\n                AMPM2 = am_pm(AMPM2)\n            if not AMPM1? and not AMPM2?\n                return [time_expression(Hour, Minute), time_expression(Hour2, Minute2)]\n            else if not AMPM1?\n                return [time_expression(Hour, Minute, undefined, AMPM2),\n                        time_expression(Hour2, Minute2, undefined, AMPM2)]\n            else if not AMPM2?\n                return [time_expression(Hour, Minute, undefined, AMPM1),\n                        time_expression(Hour2, Minute2, undefined, AMPM1)]\n\n\n        month_type = (input...) ->\n            for value in input\n                if value?\n                    return Number(value)\n\n\n        date_number = (Day, Abbr) -> if Day? then Number(Day)\n\n        month_number = (MonthNum) -> Number(MonthNum)\n\n        month_num_type = (input) -> Number(input)\n\n        year = (Year) -> if Year? then Number(Year)\n\nSometimes the value is ```[undefined, undefined, <value>]```,\nso I need to search for it and find it. There's enough\nof these smaller expressions scattered around that moving them\nall to one place might be good.\n\n        get_first_defined = (_) ->\n          for item in _\n            if item?\n              return item\n\n### Patterns\n\nThere's a some unwrapping values out of arrays here.\nBecause there's no named-arguments, functions receive a lot more\narrays here then in Python and so they need to be unwrapped.\n\n        weekday_range_with_time = (time1, time2, [weekday1], [weekday2], MonthRange) ->\n            output = []\n\n            # Get first undefined value\n            # Since only one value in list will be defined (if any)\n            time1 = get_first_defined(time1)\n            time2 = get_first_defined(time2)\n\n            if time1?\n                for date in MonthRange\n                    output.push(_replace(date, time1))\n                    if time2?\n                        output.push(_replace(date, time2))\n            return output\n\n\n        weekday_range_with_extra = ( time, and_time, weekday_start, weekday_end, extra_time, extra_weekday, MonthRange) ->\n            output = []\n            if time?\n                for date in MonthRange\n                    if date.weekday?\n                        if date.weekday in [weekday_start .. weekday_end]\n                            output.push(_replace(date, time))\n                            if and_time?\n                                output.push(_replace(date, and_time))\n                        if date.weekday == extra_weekday\n                            output.push(_replace(date, extra_time))\n            return output\n\n\n        weekday_range_with_extra_backwards = (extra_time, extra_weekday, time, weekday_start, weekday_end, MonthRange ) ->\n            return weekday_range_with_extra(time[0], time[1], weekday_start, weekday_end, extra_time, extra_weekday, MonthRange )\n\n\n        reverse_basic_text = (time, day, month, year) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        basic_text = (time, first_second, weekday, month, day, year) ->\n            if not day?\n                day = 1\n            if (day instanceof Array) and day.length == 1\n              day = day[0]\n            if (year instanceof Array) and year.length == 1\n              year = year[0]\n            if not time?\n                return {year: year, month: month, day: day}\n            else\n                year: year\n                month: month\n                day: day\n                hour: time.hour\n                minute: time.minute\n                second: time.second\n                am_pm: time.am_pm\n\n\n        slash = (month, day, year, time) ->\n            return basic_text(time, undefined, undefined, month, day, year)\n\n\n        month_range = (month, date_a, date_b) ->\n            output = []\n            for day in [date_a .. date_b]\n                output.push(basic_text(undefined, undefined, undefined, month, day, undefined))\n            return output\n\n\n        multi_time = (time1, BasicText) ->\n            output = []\n            if time1? and BasicText?\n                output.push(_replace(BasicText, time1))\n                output.push(BasicText)\n                return output\n\n\n        large_repeat_words = ->\n            return undefined\n\n\n        weekday_range_with_time_range = (time1, weekday_range) ->\n            output = []\n            if time1? and weekday_range?\n                range = timedelta_from_Date(_replace(weekday_range[0], time1), weekday_range[0])\n                for weekday in weekday_range\n                    output.push(_replace(weekday, {hour:time1.hour, minute:time1.minute, am_pm:time1.am_pm}))\n                    output.push(range)\n                return output\n\n\n        time_range = (unstrict_time, strict_time, date, reverse) ->\n            endtime = date\n            starttime = endtime\n            if unstrict_time\n                starttime = _replace(starttime, {hour:Number(unstrict_time[0])})\n                if date.am_pm\n                    starttime = _replace(starttime, {hour: starttime.hour + date.am_pm, am_pm:date.am_pm})\n            else\n                starttime = _replace(starttime, {hour: strict_time.hour, minute: strict_time.minute})\n\n            time_range = timedelta_from_Date(starttime, endtime)\n            if reverse\n                time_range = timedelta_from_Date(endtime, starttime)\n            return [starttime, time_range]\n\n\n        alt_time_range = (first_second, weekday, month, day, year, time, unstrict_time, strict_time) ->\n            return time_range(unstrict_time, strict_time, basic_text(time, first_second, weekday, month, day, year), reverse)\n\n\n        until_range = (date1, date2) ->\n            if date1 and date2\n                return [date1, timedelta_from_Date(date1, date2)]\n\n\n        through_range = (time, weekday1, weekday2, month, date, beginning) ->\n            output = []\n            if month and date and beginning and weekday1\n                ending =\n                    month: month\n                    day: date\n                for day in [beginning.day .. ending.day]\n                    temp =\n                        month: month\n                        day: date\n                    if temp.weekday and in_array([weekday1 .. weekday2], temp.weekday)\n                        if time\n                            output.push(_replace(temp, time))\n                        else\n                            output.push(temp)\n                return output\n\n\n### The function list\n\nThis hash\/object matches all the functions with a\nstring that represents it in the parse tree.\n\n        functions =\n            # Groups\n            \"MonthString\": month_to_number,\n            \"AMPM\": am_pm,\n            # Expressions\n            \"Chase Year\": year,\n            \"Chase Date\": date_number,\n            \"Chase Month\": month_number,\n            \"Steve Valaitis\": time_expression,\n            \"Greg Burns\": (hour, am_pm) -> time_expression(hour, null, null, am_pm, null),\n            \"Greg Burns UnstrictTime:\": time_expression,\n            \"Steve Valaitis2\": military_time,\n            \"Steve Valaitis And Time\": time_and_time,\n            \"Text Parts\": time_expression,\n            \"Michael Ash10\": weekday_to_number,\n            # Types\n            \"Month\": month_type,\n            \"MonthNum\": month_num_type,\n            # Patterns\n            \"LargeRepeatWords\": large_repeat_words,\n            \"BasicText\": basic_text,\n            \"ReverseBasicText\": reverse_basic_text,\n            \"Slash\": slash,\n            \"MonthRange\": month_range,\n            \"MultiTime\": multi_time,\n            \"WeekdayRangeWithTime\": weekday_range_with_time,\n            \"WeekdayRangeWithExtra\": weekday_range_with_extra,\n            \"WeekdayRangeWithExtraBackwards\": weekday_range_with_extra_backwards,\n            \"WeekdayRangeWithTimeRange\": weekday_range_with_time_range,\n            \"UntilRange\": until_range,\n            \"ThroughRange\": through_range,\n            \"TimeRange\": time_range,\n            \"AltTimeRange\": alt_time_range,\n\nThis is default expression or pattern. ```any``` means\nif value is defined, and there is array with even a single defined value then return true.\n\n            \"_default\": (_) ->\n                if any(_) then _ else undefined\n\nRecall ```Type``` here means collection of expressions.\nThere only one will matching expression due to the way regex works ```\"(a|b)```,\nso you just have to find it and return it.\n\n            \"_default_type\": (_...) ->\n                if _?\n                    for item in _\n                         if item?\n                             return item\n\n            \"_default_group\": (_...) -> if _[0]? then _[0]\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"04d7e089b225c2dc9578cdd48b556808ef9bf631","subject":"Flesh out json_platform logic a bit more","message":"Flesh out json_platform logic a bit more\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/json\/json_platforms.litcoffee","new_file":"lib\/render-pipelines\/json\/json_platforms.litcoffee","new_contents":"    JsonRenderer = require '.\/json_renderer'\n\n    class JsonPlatforms extends JsonRenderer\n\n      init_gap: =>\n        start:     undefined\n        length:    undefined\n        bottom_y:  undefined\n        thickness: undefined\n\n      open_gap: (j, ground, next, diff) =>\n        init_thickness = Math.ceil Math.random() * diff\n\n        bottom_y = (@config.wall.segments - ground.thickness) - @config.ground.max_height_diff\n        bottom_y += init_thickness\n\n        start:          j + 2\n        length:         0\n        bottom_y:       bottom_y\n        max_thickness:  diff\n        init_thickness: init_thickness\n        thickness:      next.thickness\n\n      do_render: (ctx, path) =>\n\n        for block, i in ctx\n          gap = @init_gap()\n\n          opening_gap = false\n\n          block.platforms = [ ]\n\n          blk = ctx[i - 1]\n\n          if blk?\n            for k in blk.platforms\n              if k.length > 0 && block.y == blk.y && blk.x == block.x - 1\n                opening_gap = k.last() if k.last().x == @config.ground.segments - 2\n\n          for ground, j in block.ground\n            if blk? && opening_gap != false && j == 0\n              next = blk.ground[@config.ground.segments - 2]\n\n              gap =\n                start:          @config.ground.segments - 2\n                length:         2\n                bottom_y:       opening_gap.y\n                max_thickness:  @config.ground.max_height_diff\n                init_thickness: opening_gap.thickness\n                thickness:      next.thickness\n\n              platform = @config.platformer gap\n\n              blk.platforms.last().push.apply blk.platforms.last(), platform if platform?\n\n              gap.length = 0\n              gap.start  = 0\n            else\n              opening_gap = false\n\n            if gap.length >= 0 && ground.thickness <= @config.wall.segments - gap.bottom_y - @config.ground.max_height_diff\n              if j < block.ground.length - 1\n                gap.length += 1\n              else\n                gap.length -= 1\n\n                platform = @config.platformer gap, ground, j\n\n                block.platforms.push platform if platform?\n\n                gap = @init_gap()\n            else if gap.length > 2\n              gap.length -= 2\n\n              platform = @config.platformer gap, ground, j\n\n              block.platforms.push platform if platform?\n\n              gap = @init_gap()\n            # else if gap.length != undefined\n            #   gap = @init_gap()\n            else\n              if j < block.ground.length - 1\n                next = block.ground[j + 1]\n\n                if ground.thickness? && next.thickness?\n                  diff = ground.thickness - next.thickness\n                  max_thickness = 1\n\n                  if diff > 0\n                    if diff < @config.ground.max_height_diff\n                      max_thickness = Math.ceil Math.random() * diff\n                    else\n                      max_thickness = Math.ceil Math.random() * @config.ground.max_height_diff\n\n                  gap = @open_gap j, ground, next, max_thickness\n\n    module.exports = JsonPlatforms\n","old_contents":"    JsonRenderer = require '.\/json_renderer'\n\n    class JsonPlatforms extends JsonRenderer\n\n      do_render: (ctx, path) =>\n        ground_segments = @config.ground.segments\n\n        for step, i in path\n          ctx[i].ground = [ ]\n\n          for g in [0...ground_segments]\n            height = @config.grounder step, i, path, g, ctx[i]\n\n            if height == -1\n              ctx[i - 1].ground[g].height = null\n\n              height = @config.grounder direction: 'FAKE', i, path, g\n\n            ctx[i].ground.push height: height\n\n    module.exports = JsonPlatforms\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b9a200c4d11c2a34b90bb9bfb1a581a6b97d2e65","subject":"Fixed destroying non-html route","message":"Fixed destroying non-html route\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/app\/route.litcoffee","new_file":"src\/app\/route.litcoffee","new_contents":"# Route\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    signal = require 'src\/signal'\n    assert = require 'src\/assert'\n    log = require 'src\/log'\n    Schema = require 'src\/schema'\n    Networking = require 'src\/networking'\n    Document = require 'src\/document'\n    Renderer = require 'src\/renderer'\n    Dict = require 'src\/dict'\n\n    log = log.scope 'app', 'route'\n\n    IS_NODE = process.env.NEFT_NODE\n    IS_CLIENT = not IS_NODE\n\n    module.exports = (app) -> class Route\n\n        if IS_NODE\n            usedTemplates = []\n        else\n            templates = Object.create null\n\n        @lastClientRoute = null\n        @onLastClientRouteChange = signal.create()\n\n## *Document* Route.getTemplateComponent(*String* componentName)\n\n        @getTemplateComponent = do ->\n            if IS_NODE\n                (name) ->\n                    scope = app: app, routes: new Dict\n                    tmpl = app.components[name].render null, scope\n                    usedTemplates.push tmpl\n                    tmpl\n            else\n                (name) ->\n                    scope = app: app, routes: new Dict\n                    templates[name] ?= app.components[name].render null, scope\n\n## Route::constructor(*Object* options)\n\nAccess it with:\n```javascript\nmodule.exports = function(app) {\n    var Route = app.Route;\n};\n```\n\nAcceptable syntaxes:\n```javascript\n*Route* app.Route(*String* method, *String* uri, *Object* options)\n*Route* app.Route(*String* methodWithUri, *Function* getData)\n*Route* app.Route(*String* methodWithUri, *Object* options)\n*Route* app.Route(*String* uri, *Function* getData)\n*Route* app.Route(*String* uri, *Object* options)\n*Route* app.Route(*String* method, *String* uri)\n*Route* app.Route(*String* uri)\n*Route* app.Route(*String* methodWithUri)\n```\n\n        constructor: (method, uri, opts) ->\n            if utils.isObject(method)\n                # opts\n                opts = method\n            else if utils.isObject(uri)\n                opts = uri\n            else unless utils.isObject(opts)\n                opts = {}\n\n            if typeof method is 'string' and typeof uri isnt 'string'\n                opts.uri = method\n            else if typeof method is 'string' and typeof uri is 'string'\n                opts.method ?= method\n                opts.uri ?= uri\n            if typeof uri is 'function'\n                opts.getData ?= uri\n\n            assert.isObject opts\n            opts = utils.clone opts\n\n            if typeof opts.uri is 'string'\n                # support methodWithUri e.g. 'get \/home'\n                spaceIndex = opts.uri.indexOf ' '\n                if spaceIndex isnt -1\n                    opts.method ?= opts.uri.slice 0, spaceIndex\n                    opts.uri = opts.uri.slice spaceIndex + 1\n                opts.uri = new Networking.Uri opts.uri\n            assert.instanceOf opts.uri, Networking.Uri\n\n            opts.method ?= 'get'\n            assert.isString opts.method\n            opts.method = opts.method.toLowerCase()\n            assert.ok utils.has(Networking.Request.METHODS, opts.method)\n            , \"Networking doesn't provide a `#{opts.method}` method\"\n\n            if opts.schema?\n                if utils.isPlainObject(opts.schema)\n                    opts.schema = new Schema opts.schema\n                assert.instanceOf opts.schema, Schema\n\n            if opts.redirect?\n                if typeof opts.redirect is 'string'\n                    opts.redirect = new Networking.Uri opts.redirect\n                else\n                    assert.isFunction opts.redirect\n\n            if utils.isObject(opts.toHTML)\n                opts.toHTML = createToHTMLFromObject opts.toHTML\n\n            for key, val of opts\n                @[key] = val\n            @__id__ = utils.uid()\n            @app = app\n            @name ||= getRouteName(@)\n\n            app.networking.createHandler\n                method: @method\n                uri: @uri\n                schema: @schema\n                callback: utils.bindFunctionContext(handleRequest, @)\n\n        getRouteName = (route) ->\n            assert.instanceOf route, Route\n\n            uri = route.uri._uri\n            uri = uri.replace Networking.Uri.NAMES_RE, ''\n            uri = uri.replace \/\\*\/g, ''\n            while uri.indexOf('\/\/') isnt -1\n                uri = uri.replace \/\\\/\\\/\/g, '\/'\n            uri = uri.replace \/^\\\/\/, ''\n            uri = uri.replace \/\\\/$\/, ''\n            uri\n\n        routesCache = Object.create null\n        pendingRoutes = Object.create null\n\n        factoryRoute = do ->\n            createInstance = (route) ->\n                r = Object.create route\n                r.__hash__ = utils.uid()\n                r.factory?()\n                r\n\n            (route) ->\n                assert.instanceOf route, Route\n\n                id = route.__id__\n                routesCache[id] ?= []\n                r = routesCache[id].pop() or createInstance(route)\n                r = Object.create r\n                r.request = r.response = null\n                r.route = r\n                r._dataPrepared = false\n                r._destroyComponentOnEnd = false\n                r\n\n        destroyRoute = (route) ->\n            assert.instanceOf route, Route\n\n            route.response.onSend.disconnect onResponseSent, route\n            delete pendingRoutes[route.__hash__]\n            route.destroy?()\n            if route._dataPrepared\n                switch route.request.type\n                    when 'text'\n                        route.destroyText?()\n                    when 'json'\n                        route.destroyJSON?()\n                    when 'html'\n                        route.destroyHTML?()\n\n            if route._destroyComponentOnEnd\n                route.response.data.destroy()\n\n            routesCache[route.__id__].push Object.getPrototypeOf(route)\n\n            if Route.lastClientRoute is route\n                Route.lastClientRoute = null\n                Route.onLastClientRouteChange.emit route\n\n            return\n\n        resolveSyncGetDataFunc = (route) ->\n            assert.instanceOf route, Route\n\n            route.data = route.getData()\n\n        resolveAsyncGetDataFuncCallback = (route, err, data) ->\n            assert.instanceOf route, Route\n\n            if err?\n                if route.response.status is 200\n                    route.response.status = 500\n                if route._dataPrepared and route.error is err\n                    return false\n                route.error = err\n            else\n                if route._dataPrepared and route.data is data\n                    return false\n                route.data = data\n            true\n\n        prepareRouteData = (route) ->\n            assert.instanceOf route, Route\n            {response} = route\n\n            if route.error\n                log.error \"Error in route '#{route.uri}':\\n#{route.error}\"\n\n            respData = response.data\n            switch route.request.type\n                when 'text'\n                    data = route.toText()\n                when 'json'\n                    data = route.toJSON()\n                when 'html'\n                    data = route.toHTML()\n                    if respData instanceof Document and route._destroyComponentOnEnd\n                        respData.destroy()\n                        response.data = null\n                    if not (data instanceof Document) and response.data is respData\n                        data = renderComponentFromConfig.call route, data\n            route._dataPrepared = true\n            if data?\n                response.data = data\n            else if response.data is respData\n                response.data = ''\n\n        onResponseSent = ->\n            if IS_NODE or @request.type isnt 'html'\n                destroyRoute @\n\n                if IS_NODE and utils.has(usedTemplates, @response.data)\n                    @response.data.destroy()\n                    utils.remove usedTemplates, @response.data\n            return\n\n        finishRequest = (route) ->\n            assert.instanceOf route, Route\n            if IS_CLIENT and route.response.data instanceof Document\n                app.windowItem.node = route.response.data.node\n            if route.response.pending\n                route.response.send()\n            return\n\n        callNextIfNeeded = (route, next) ->\n            unless pendingRoutes[route.__hash__]\n                if route.response.pending\n                    next()\n                return true\n            false\n\n        handleRequest = (req, res, next) ->\n            assert.instanceOf req, Networking.Request\n            assert.instanceOf res, Networking.Response\n            assert.isFunction next\n\n            route = factoryRoute @\n            hash = route.__hash__\n            assert.notOk pendingRoutes[hash]\n\n            if IS_CLIENT and req.type is 'html'\n                if Route.lastClientRoute\n                    destroyRoute Route.lastClientRoute\n                {lastClientRoute} = Route\n                Route.lastClientRoute = route\n                Route.onLastClientRouteChange.emit lastClientRoute\n\n            route.request = req\n            route.response = res\n            pendingRoutes[hash] = true\n\n            res.onSend onResponseSent, route\n\n            # init\n            route.init?()\n\n            unless pendingRoutes[hash]\n                return next()\n\n            # redirect\n            {redirect} = route\n            if typeof redirect is 'function'\n                redirect = route.redirect()\n                unless pendingRoutes[hash]\n                    return next()\n            if typeof redirect is 'string'\n                redirect = new Networking.Uri redirect\n            if redirect instanceof Networking.Uri\n                res.redirect redirect.toString(req.params)\n                return\n\n            # getData\n            {getData} = route\n            fakeAsync = false\n            if typeof getData is 'function'\n                if getData.length is 1\n                    route.getData (err, data) ->\n                        fakeAsync = true\n                        if callNextIfNeeded(route, next)\n                            return\n                        unless resolveAsyncGetDataFuncCallback(route, err, data)\n                            return\n                        prepareRouteData route\n                        if callNextIfNeeded(route, next)\n                            return\n                        finishRequest route\n                else\n                    resolveSyncGetDataFunc route\n                    if callNextIfNeeded(route, next)\n                        return\n                    prepareRouteData route\n                    if callNextIfNeeded(route, next)\n                        return\n                    finishRequest route\n            else\n                prepareRouteData route\n                if callNextIfNeeded(route, next)\n                    return\n                finishRequest route\n\n            if not fakeAsync and callNextIfNeeded(route, next)\n                return\n\n## *String* Route::method = `'get'`\n\n## *Networking.Uri* Route::uri\n\n## *App* Route::app\n\n## *App.Route* Route::route\n\n## *String* Route::name\n\n## *Schema* Route::schema\n\n## *Any* Route::data\n\n## *Any* Route::error\n\n## *Function* Route::factory()\n\n## *Function* Route::init()\n\n## *Function* Route::getData([*Function* callback])\n\n## *Function* Route::destroy()\n\n## *Function* Route::destroyJSON()\n\n## *Function* Route::destroyText()\n\n## *Function* Route::destroyHTML()\n\n## *Networking.Uri* Route::redirect\n\nCan be also a function. May returns a *Networking.Uri*, any String or `undefined`.\n\n## *Networking.Request* Route::request\n\n## *Networking.Response* Route::response\n\n## *Function* Route::next()\n\n        next: ->\n            assert.ok pendingRoutes[@__hash__]\n            destroyRoute @\n\n## *Any* Route::toJSON()\n\n        toJSON: ->\n            if @response.status < 400\n                @data?.toJSON?() or @data\n            else\n                @error.toJSON?() or @error\n\n## *String* Route::toText()\n\n        toText: ->\n            if @response.status < 400\n                @data + ''\n            else\n                @error + ''\n\n## *Document* Route::toHTML()\n\n        routeToString = ->\n            \"#{@method} #{@uri}\"\n\n        getDefaultRouteComponentName = ->\n            path = \"components\/#{@name}.xhtml\"\n            if app.components[path]\n                return path\n\n        renderComponentFromConfig = (opts) ->\n            componentName = opts?.component or\n                getDefaultRouteComponentName.call(@) or\n                'components\/index.xhtml'\n            tmplName = opts?.template or componentName\n            useName = opts?.use or 'body'\n\n            logTime = log.timer()\n            if componentName isnt tmplName\n                if tmpl = app.components[tmplName]\n                    tmplComponent = Route.getTemplateComponent tmplName\n                    tmplComponent.use useName, null\n                else\n                    log.warn \"\"\"\n                        Template component '#{tmplName}' can't be found \\\n                        for route '#{routeToString.call(@)}'\n                    \"\"\"\n            if component = app.components[componentName]\n                r = component.render null, @\n            else\n                log.warn \"Component '#{tmplName}' can't be found for route '#{routeToString.call(@)}'\"\n            if tmplComponent\n                if r?\n                    r = tmplComponent.use(useName, r)\n                else\n                    r = tmplComponent\n                if tmplComponent.context.routes.has(useName)\n                    tmplComponent.context.routes.pop useName\n                tmplComponent.context.routes.set useName, @\n                @_destroyComponentOnEnd = false\n            else\n                @_destroyComponentOnEnd = true\n            logTime.ok \"Component `#{componentName}` rendered\"\n            r\n\n        createToHTMLFromObject = (opts) ->\n            -> renderComponentFromConfig.call @, opts\n\n        toHTML: createToHTMLFromObject\n            component: ''\n            template: ''\n            use: ''\n","old_contents":"# Route\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    signal = require 'src\/signal'\n    assert = require 'src\/assert'\n    log = require 'src\/log'\n    Schema = require 'src\/schema'\n    Networking = require 'src\/networking'\n    Document = require 'src\/document'\n    Renderer = require 'src\/renderer'\n    Dict = require 'src\/dict'\n\n    log = log.scope 'app', 'route'\n\n    IS_NODE = process.env.NEFT_NODE\n    IS_CLIENT = not IS_NODE\n\n    module.exports = (app) -> class Route\n\n        if IS_NODE\n            usedTemplates = []\n        else\n            templates = Object.create null\n\n        @lastClientRoute = null\n        @onLastClientRouteChange = signal.create()\n\n## *Document* Route.getTemplateComponent(*String* componentName)\n\n        @getTemplateComponent = do ->\n            if IS_NODE\n                (name) ->\n                    scope = app: app, routes: new Dict\n                    tmpl = app.components[name].render null, scope\n                    usedTemplates.push tmpl\n                    tmpl\n            else\n                (name) ->\n                    scope = app: app, routes: new Dict\n                    templates[name] ?= app.components[name].render null, scope\n\n## Route::constructor(*Object* options)\n\nAccess it with:\n```javascript\nmodule.exports = function(app) {\n    var Route = app.Route;\n};\n```\n\nAcceptable syntaxes:\n```javascript\n*Route* app.Route(*String* method, *String* uri, *Object* options)\n*Route* app.Route(*String* methodWithUri, *Function* getData)\n*Route* app.Route(*String* methodWithUri, *Object* options)\n*Route* app.Route(*String* uri, *Function* getData)\n*Route* app.Route(*String* uri, *Object* options)\n*Route* app.Route(*String* method, *String* uri)\n*Route* app.Route(*String* uri)\n*Route* app.Route(*String* methodWithUri)\n```\n\n        constructor: (method, uri, opts) ->\n            if utils.isObject(method)\n                # opts\n                opts = method\n            else if utils.isObject(uri)\n                opts = uri\n            else unless utils.isObject(opts)\n                opts = {}\n\n            if typeof method is 'string' and typeof uri isnt 'string'\n                opts.uri = method\n            else if typeof method is 'string' and typeof uri is 'string'\n                opts.method ?= method\n                opts.uri ?= uri\n            if typeof uri is 'function'\n                opts.getData ?= uri\n\n            assert.isObject opts\n            opts = utils.clone opts\n\n            if typeof opts.uri is 'string'\n                # support methodWithUri e.g. 'get \/home'\n                spaceIndex = opts.uri.indexOf ' '\n                if spaceIndex isnt -1\n                    opts.method ?= opts.uri.slice 0, spaceIndex\n                    opts.uri = opts.uri.slice spaceIndex + 1\n                opts.uri = new Networking.Uri opts.uri\n            assert.instanceOf opts.uri, Networking.Uri\n\n            opts.method ?= 'get'\n            assert.isString opts.method\n            opts.method = opts.method.toLowerCase()\n            assert.ok utils.has(Networking.Request.METHODS, opts.method)\n            , \"Networking doesn't provide a `#{opts.method}` method\"\n\n            if opts.schema?\n                if utils.isPlainObject(opts.schema)\n                    opts.schema = new Schema opts.schema\n                assert.instanceOf opts.schema, Schema\n\n            if opts.redirect?\n                if typeof opts.redirect is 'string'\n                    opts.redirect = new Networking.Uri opts.redirect\n                else\n                    assert.isFunction opts.redirect\n\n            if utils.isObject(opts.toHTML)\n                opts.toHTML = createToHTMLFromObject opts.toHTML\n\n            for key, val of opts\n                @[key] = val\n            @__id__ = utils.uid()\n            @app = app\n            @name ||= getRouteName(@)\n\n            app.networking.createHandler\n                method: @method\n                uri: @uri\n                schema: @schema\n                callback: utils.bindFunctionContext(handleRequest, @)\n\n        getRouteName = (route) ->\n            assert.instanceOf route, Route\n\n            uri = route.uri._uri\n            uri = uri.replace Networking.Uri.NAMES_RE, ''\n            uri = uri.replace \/\\*\/g, ''\n            while uri.indexOf('\/\/') isnt -1\n                uri = uri.replace \/\\\/\\\/\/g, '\/'\n            uri = uri.replace \/^\\\/\/, ''\n            uri = uri.replace \/\\\/$\/, ''\n            uri\n\n        routesCache = Object.create null\n        pendingRoutes = Object.create null\n\n        factoryRoute = do ->\n            createInstance = (route) ->\n                r = Object.create route\n                r.__hash__ = utils.uid()\n                r.factory?()\n                r\n\n            (route) ->\n                assert.instanceOf route, Route\n\n                id = route.__id__\n                routesCache[id] ?= []\n                r = routesCache[id].pop() or createInstance(route)\n                r = Object.create r\n                r.request = r.response = null\n                r.route = r\n                r._dataPrepared = false\n                r._destroyComponentOnEnd = false\n                r\n\n        destroyRoute = (route) ->\n            assert.instanceOf route, Route\n\n            route.response.onSend.disconnect onResponseSent, route\n            delete pendingRoutes[route.__hash__]\n            route.destroy?()\n            if route._dataPrepared\n                switch route.request.type\n                    when 'text'\n                        route.destroyText?()\n                    when 'json'\n                        route.destroyJSON?()\n                    when 'html'\n                        route.destroyHTML?()\n\n            if route._destroyComponentOnEnd\n                route.response.data.destroy()\n\n            routesCache[route.__id__].push Object.getPrototypeOf(route)\n\n            if Route.lastClientRoute is route\n                Route.lastClientRoute = null\n                Route.onLastClientRouteChange.emit route\n\n            return\n\n        resolveSyncGetDataFunc = (route) ->\n            assert.instanceOf route, Route\n\n            route.data = route.getData()\n\n        resolveAsyncGetDataFuncCallback = (route, err, data) ->\n            assert.instanceOf route, Route\n\n            if err?\n                if route.response.status is 200\n                    route.response.status = 500\n                if route._dataPrepared and route.error is err\n                    return false\n                route.error = err\n            else\n                if route._dataPrepared and route.data is data\n                    return false\n                route.data = data\n            true\n\n        prepareRouteData = (route) ->\n            assert.instanceOf route, Route\n            {response} = route\n\n            if route.error\n                log.error \"Error in route '#{route.uri}':\\n#{route.error}\"\n\n            respData = response.data\n            switch route.request.type\n                when 'text'\n                    data = route.toText()\n                when 'json'\n                    data = route.toJSON()\n                when 'html'\n                    data = route.toHTML()\n                    if respData instanceof Document and route._destroyComponentOnEnd\n                        respData.destroy()\n                        response.data = null\n                    if not (data instanceof Document) and response.data is respData\n                        data = renderComponentFromConfig.call route, data\n            route._dataPrepared = true\n            if data?\n                response.data = data\n            else if response.data is respData\n                response.data = ''\n\n        onResponseSent = ->\n            if IS_NODE or @request.type isnt 'html'\n                destroyRoute @\n\n                if IS_NODE and utils.has(usedTemplates, @response.data)\n                    @response.data.destroy()\n                    utils.remove usedTemplates, @response.data\n            return\n\n        finishRequest = (route) ->\n            assert.instanceOf route, Route\n            if IS_CLIENT and route.response.data instanceof Document\n                app.windowItem.node = route.response.data.node\n            if route.response.pending\n                route.response.send()\n            return\n\n        callNextIfNeeded = (route, next) ->\n            unless pendingRoutes[route.__hash__]\n                if route.response.pending\n                    next()\n                return true\n            false\n\n        handleRequest = (req, res, next) ->\n            assert.instanceOf req, Networking.Request\n            assert.instanceOf res, Networking.Response\n            assert.isFunction next\n\n            route = factoryRoute @\n            hash = route.__hash__\n            assert.notOk pendingRoutes[hash]\n\n            if IS_CLIENT\n                if Route.lastClientRoute\n                    destroyRoute Route.lastClientRoute\n                {lastClientRoute} = Route\n                Route.lastClientRoute = route\n                Route.onLastClientRouteChange.emit lastClientRoute\n\n            route.request = req\n            route.response = res\n            pendingRoutes[hash] = true\n\n            res.onSend onResponseSent, route\n\n            # init\n            route.init?()\n\n            unless pendingRoutes[hash]\n                return next()\n\n            # redirect\n            {redirect} = route\n            if typeof redirect is 'function'\n                redirect = route.redirect()\n                unless pendingRoutes[hash]\n                    return next()\n            if typeof redirect is 'string'\n                redirect = new Networking.Uri redirect\n            if redirect instanceof Networking.Uri\n                res.redirect redirect.toString(req.params)\n                return\n\n            # getData\n            {getData} = route\n            fakeAsync = false\n            if typeof getData is 'function'\n                if getData.length is 1\n                    route.getData (err, data) ->\n                        fakeAsync = true\n                        if callNextIfNeeded(route, next)\n                            return\n                        unless resolveAsyncGetDataFuncCallback(route, err, data)\n                            return\n                        prepareRouteData route\n                        if callNextIfNeeded(route, next)\n                            return\n                        finishRequest route\n                else\n                    resolveSyncGetDataFunc route\n                    if callNextIfNeeded(route, next)\n                        return\n                    prepareRouteData route\n                    if callNextIfNeeded(route, next)\n                        return\n                    finishRequest route\n            else\n                prepareRouteData route\n                if callNextIfNeeded(route, next)\n                    return\n                finishRequest route\n\n            if not fakeAsync and callNextIfNeeded(route, next)\n                return\n\n## *String* Route::method = `'get'`\n\n## *Networking.Uri* Route::uri\n\n## *App* Route::app\n\n## *App.Route* Route::route\n\n## *String* Route::name\n\n## *Schema* Route::schema\n\n## *Any* Route::data\n\n## *Any* Route::error\n\n## *Function* Route::factory()\n\n## *Function* Route::init()\n\n## *Function* Route::getData([*Function* callback])\n\n## *Function* Route::destroy()\n\n## *Function* Route::destroyJSON()\n\n## *Function* Route::destroyText()\n\n## *Function* Route::destroyHTML()\n\n## *Networking.Uri* Route::redirect\n\nCan be also a function. May returns a *Networking.Uri*, any String or `undefined`.\n\n## *Networking.Request* Route::request\n\n## *Networking.Response* Route::response\n\n## *Function* Route::next()\n\n        next: ->\n            assert.ok pendingRoutes[@__hash__]\n            destroyRoute @\n\n## *Any* Route::toJSON()\n\n        toJSON: ->\n            if @response.status < 400\n                @data?.toJSON?() or @data\n            else\n                @error.toJSON?() or @error\n\n## *String* Route::toText()\n\n        toText: ->\n            if @response.status < 400\n                @data + ''\n            else\n                @error + ''\n\n## *Document* Route::toHTML()\n\n        routeToString = ->\n            \"#{@method} #{@uri}\"\n\n        getDefaultRouteComponentName = ->\n            path = \"components\/#{@name}.xhtml\"\n            if app.components[path]\n                return path\n\n        renderComponentFromConfig = (opts) ->\n            componentName = opts?.component or\n                getDefaultRouteComponentName.call(@) or\n                'components\/index.xhtml'\n            tmplName = opts?.template or componentName\n            useName = opts?.use or 'body'\n\n            logTime = log.timer()\n            if componentName isnt tmplName\n                if tmpl = app.components[tmplName]\n                    tmplComponent = Route.getTemplateComponent tmplName\n                    tmplComponent.use useName, null\n                else\n                    log.warn \"\"\"\n                        Template component '#{tmplName}' can't be found \\\n                        for route '#{routeToString.call(@)}'\n                    \"\"\"\n            if component = app.components[componentName]\n                r = component.render null, @\n            else\n                log.warn \"Component '#{tmplName}' can't be found for route '#{routeToString.call(@)}'\"\n            if tmplComponent\n                if r?\n                    r = tmplComponent.use(useName, r)\n                else\n                    r = tmplComponent\n                if tmplComponent.context.routes.has(useName)\n                    tmplComponent.context.routes.pop useName\n                tmplComponent.context.routes.set useName, @\n                @_destroyComponentOnEnd = false\n            else\n                @_destroyComponentOnEnd = true\n            logTime.ok \"Component `#{componentName}` rendered\"\n            r\n\n        createToHTMLFromObject = (opts) ->\n            -> renderComponentFromConfig.call @, opts\n\n        toHTML: createToHTMLFromObject\n            component: ''\n            template: ''\n            use: ''\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"b9b2a9ff4275567fd21b94b266384e3b374f5bad","subject":"Renderer parent z-order siblings bug fixed","message":"Renderer parent z-order siblings bug fixed\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/renderer\/types\/basics\/item.litcoffee","new_file":"src\/renderer\/types\/basics\/item.litcoffee","new_contents":"# Item\n\n    'use strict'\n\n    assert = require 'src\/assert'\n    utils = require 'src\/utils'\n    signal = require 'src\/signal'\n    List = require 'src\/list'\n\n    {isArray} = Array\n    {emitSignal} = signal.Emitter\n\n    assert = assert.scope 'Renderer.Item'\n\n# **Class** Item\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Item extends itemUtils.Object\n        @__name__ = 'Item'\n        @__path__ = 'Renderer.Item'\n\n## *Item* Item.New([*Component* component, *Object* options])\n\n        @New = (component, opts) ->\n            item = new Item\n            itemUtils.Object.initialize item, component, opts\n            item\n\n## Item::constructor()\n\nThis is a base class for everything which is visible.\n\n        constructor: ->\n            assert.instanceOf @, Item, 'ctor ...'\n\n            super()\n            @_$ = null\n            @_parent = null\n            @_children = null\n            @_previousSibling = null\n            @_nextSibling = null\n            @_belowSibling = null\n            @_aboveSibling = null\n            @_width = 0\n            @_height = 0\n            @_x = 0\n            @_y = 0\n            @_z = 0\n            @_visible = true\n            @_clip = false\n            @_scale = 1\n            @_rotation = 0\n            @_opacity = 1\n            @_linkUri = ''\n            @_anchors = null\n            @_layout = null\n            @_document = null\n            @_keys = null\n            @_pointer = null\n            @_margin = null\n            @_classes = null\n            @_background = null\n            @_defaultBackground = null\n\n### Custom properties\n\n```nml\n`Item {\n`   id: main\n`   property $.currentLife: 0.8\n`\n`   Text {\n`     text: \"Life: \" + main.$.currentLife\n`   }\n`}\n```\n\n### Custom signals\n\n```nml\n`Item {\n`   signal $.onPlayerCollision\n`   $.onPlayerCollision: function(){\n`       \/\/ boom!\n`   }\n`}\n```\n\n## *Signal* Item::on$Change(*String* property, *Any* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: '$'\n            valueConstructor: itemUtils.CustomObject\n\n## *Signal* Item::ready()\n\nCalled when the Item is ready, that is, all\nproperties have been set and it's ready to use.\n\n```nml\nRectangle {\n    width: 200\n    height: 50\n    color: 'green'\n    Rectangle {\n        width: parent.width \/ 2\n        height: parent.height \/ 2\n        color: 'yellow'\n        onReady: function(){\n            console.log(this.width, this.height);\n            \/\/ 100, 25\n        }\n    }\n}\n```\n\n        signal.Emitter.createSignal @, 'onReady'\n\n## *Signal* Item::onAnimationFrame(*Integer* miliseconds)\n\n        signal.Emitter.createSignal @, 'onAnimationFrame', do ->\n            now = Date.now()\n            items = []\n\n            frame = ->\n                oldNow = now\n                now = Date.now()\n                ms = now - oldNow\n\n                for item in items\n                    emitSignal item, 'onAnimationFrame', ms\n                requestAnimationFrame frame\n\n            requestAnimationFrame? frame\n\n            (item) ->\n                items.push item\n\n## ReadOnly *String* Item::id\n\n## *Object* Item::children\n\n        utils.defineProperty @::, 'children', null, ->\n            @_children ||= new ChildrenObject(@)\n        , (val) ->\n            assert.isArray val, '::children setter ...'\n            @clear()\n            for item in val\n                val.parent = @\n            return\n\n## *Signal* Item::onChildrenChange(*Item* added, *Item* removed)\n\n        signal.Emitter.createSignal @, 'onChildrenChange'\n\n        class ChildrenObject extends itemUtils.MutableDeepObject\n            constructor: (ref) ->\n                @_layout = null\n                @_target = null\n                @_firstChild = null\n                @_lastChild = null\n                @_bottomChild = null\n                @_topChild = null\n                @_length = 0\n                super ref\n\n### ReadOnly *Item* Item::children.firstChild\n\n            utils.defineProperty @::, 'firstChild', null, ->\n                @_firstChild\n            , null\n\n### ReadOnly *Item* Item::children.lastChild\n\n            utils.defineProperty @::, 'lastChild', null, ->\n                @_lastChild\n            , null\n\n### ReadOnly *Item* Item::children.bottomChild\n\n            utils.defineProperty @::, 'bottomChild', null, ->\n                @_bottomChild\n            , null\n\n### ReadOnly *Item* Item::children.topChild\n\n            utils.defineProperty @::, 'topChild', null, ->\n                @_topChild\n            , null\n\n### ReadOnly *Integer* Item::children.length\n\n            utils.defineProperty @::, 'length', null, ->\n                @_length\n            , null\n\n### *Item* Item::children.layout\n\nItem used to position children items.\nCan be e.g. *Flow*, *Grid* etc.\n\n### *Signal* Item::children.onLayoutChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'layout'\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Item\n                setter: (_super) -> (val) ->\n                    if @_layout?.effectItem\n                        @_layout.parent = null\n                        @_layout.effectItem = @_layout\n\n                    _super.call @, val\n\n                    if '_effectItem' of @_ref\n                        @_ref.effectItem = if val then null else @_ref\n\n                    if val?\n                        ref = @_ref\n                        setFakeParent val, ref, 0\n                        if val.effectItem\n                            val.effectItem = ref\n\n                    return\n\n### *Item* Item::children.target\n\nA new child trying to be added into the item with the `children.target` defined\nwill be added into the `target` item.\n\n### *Signal* Item::children.onTargetChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'target'\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Item\n\n### *Item* Item::children.get(*Integer* index)\n\nReturns an item with the given index.\n\n            get: (val) ->\n                assert.operator val, '>=', 0\n                assert.operator val, '<', @length\n\n                if val < @length\/2\n                    sibling = @firstChild\n                    while val > 0\n                        sibling = sibling.nextSibling\n                        val--\n                else\n                    sibling = @lastChild\n                    while val > 0\n                        sibling = sibling.previousSibling\n                        val--\n\n                sibling\n\n### *Integer* Item::children.index(*Item* value)\n\nReturns an index of the given child in the children array.\n\n            index: (val) ->\n                if @has(val)\n                    val.index\n                else\n                    -1\n\n### *Boolean* Item::children.has(*Item* value)\n\nReturns `true` if the given item is an item child.\n\n            has: (val) ->\n                @_ref is val._parent\n\n### Item::children.clear()\n\nRemoves all children from the item.\n\n            clear: ->\n                while last = @last\n                    last.parent = null\n                return\n\n## *Item* Item::parent = null\n\n## *Signal* Item::onParentChange(*Item* oldParent)\n\n        setFakeParent = (child, parent, index=-1) ->\n            child.parent = null\n\n            if index >= 0 and parent.children._length < index\n                Impl.insertItemBefore.call child, parent.children[index]\n            else\n                Impl.setItemParent.call child, parent\n\n            child._parent = parent\n            emitSignal child, 'onParentChange', null\n            return\n\n        updateZSiblingsForAppendedItem = (item, z, newChildren) ->\n            child = newChildren._topChild\n            while child\n                if child._z <= z\n                    if item._aboveSibling = child._aboveSibling\n                        item._aboveSibling._belowSibling = item\n                    item._belowSibling = child\n                    child._aboveSibling = item\n                    return\n                unless nextChild = child._belowSibling\n                    item._aboveSibling = child\n                    child._belowSibling = item\n                    item._belowSibling = null\n                    return\n                child = nextChild\n            return\n\n        insertItemInImpl = (item) ->\n            if aboveSibling = item._aboveSibling\n                Impl.insertItemBefore.call item, aboveSibling\n            else\n                Impl.setItemParent.call item, item._parent\n            return\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'parent'\n            defaultValue: null\n            setter: (_super) -> (val=null) ->\n                old = @_parent\n                oldChildren = old?.children\n                valChildren = val?.children\n\n                if valChildren?._target\n                    # detect whether target is a child of this item\n                    containsItem = false\n                    tmpItem = valChildren._target\n                    while tmpItem\n                        if tmpItem is @\n                            containsItem = true\n                            break\n                        tmpItem = tmpItem._parent\n\n                    unless containsItem\n                        val = valChildren._target\n                        valChildren = val.children\n\n                if old is val\n                    return\n\n                assert.isNot @, val\n\n                if pointer = @_pointer\n                    pointer.hover = pointer.pressed = false\n\n                if val isnt null\n                    assert.instanceOf val, Item, '::parent setter ...'\n\n                # old siblings\n                oldPreviousSibling = @_previousSibling\n                oldNextSibling = @_nextSibling\n                if oldPreviousSibling isnt null\n                    oldPreviousSibling._nextSibling = oldNextSibling\n                if oldNextSibling isnt null\n                    oldNextSibling._previousSibling = oldPreviousSibling\n\n                # new siblings\n                if val isnt null\n                    if previousSibling = @_previousSibling = valChildren.lastChild\n                        previousSibling._nextSibling = @\n                else\n                    @_previousSibling = null\n                if oldNextSibling isnt null\n                    @_nextSibling = null\n\n                # children\n                if oldChildren\n                    oldChildren._length -= 1\n                    if oldChildren.firstChild is @\n                        oldChildren._firstChild = oldNextSibling\n                    if oldChildren.lastChild is @\n                        oldChildren._lastChild = oldPreviousSibling\n                if valChildren\n                    if ++valChildren._length is 1\n                        valChildren._firstChild = @\n                    valChildren._lastChild = @\n\n                # old z-index siblings\n                oldBelowSibling = @_belowSibling\n                oldAboveSibling = @_aboveSibling\n                if oldBelowSibling isnt null\n                    oldBelowSibling._aboveSibling = oldAboveSibling\n                if oldAboveSibling isnt null\n                    oldAboveSibling._belowSibling = oldBelowSibling\n\n                # new z-index siblings\n                @_belowSibling = @_aboveSibling = null\n                if valChildren\n                    updateZSiblingsForAppendedItem @, @_z, valChildren\n\n                # z-index children\n                if oldChildren\n                    unless oldAboveSibling\n                        oldChildren._topChild = oldBelowSibling\n                    unless oldBelowSibling\n                        oldChildren._bottomChild = oldAboveSibling\n                if valChildren\n                    unless @_aboveSibling\n                        valChildren._topChild = @\n                    unless @_belowSibling\n                        valChildren._bottomChild = @\n\n                # parent\n                @_parent = val\n                insertItemInImpl @\n\n                `\/\/<development>`\n                assert.is @nextSibling, null\n                if val\n                    assert.is val.children.lastChild, @\n                    assert.isDefined val.children.firstChild\n                    assert.isDefined val.children.lastChild\n                    assert.isDefined val.children.topChild\n                    assert.isDefined val.children.bottomChild\n                if old and old.children.length is 0\n                    assert.isNotDefined old.children.firstChild\n                    assert.isNotDefined old.children.lastChild\n                    assert.isNotDefined old.children.topChild\n                    assert.isNotDefined old.children.bottomChild\n                `\/\/<\/development>`\n\n                # signals\n                if old isnt null\n                    emitSignal old, 'onChildrenChange', null, @\n                if val isnt null\n                    emitSignal val, 'onChildrenChange', @, null\n\n                emitSignal @, 'onParentChange', old\n\n                if oldPreviousSibling isnt null\n                    emitSignal oldPreviousSibling, 'onNextSiblingChange', @\n                if oldNextSibling isnt null\n                    emitSignal oldNextSibling, 'onPreviousSiblingChange', @\n\n                if val isnt null or oldPreviousSibling isnt null\n                    if previousSibling\n                        emitSignal previousSibling, 'onNextSiblingChange', null\n                    emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling\n                if oldNextSibling isnt null\n                    emitSignal @, 'onNextSiblingChange', oldNextSibling\n\n                return\n\n## *Item* Item::previousSibling\n\n        utils.defineProperty @::, 'previousSibling', null, ->\n            @_previousSibling\n        , (val=null) ->\n            assert.isNot @, val\n\n            if val is @_previousSibling\n                return\n\n            if val\n                assert.instanceOf val, Item\n                nextSibling = val._nextSibling\n                if not nextSibling and val._parent isnt @_parent\n                    @parent = val._parent\n                else\n                    @nextSibling = nextSibling\n            else\n                assert.isDefined @_parent\n                @nextSibling = @_parent.children.firstChild\n\n            assert.is @_previousSibling, val\n            return\n\n## *Signal* Item::onPreviousSiblingChange(*Item* oldValue)\n\n        signal.Emitter.createSignal @, 'onPreviousSiblingChange'\n\n## *Item* Item::nextSibling\n\n        isNextSibling = (item, sibling) ->\n            while item\n                nextItem = item._nextSibling\n                if nextItem is sibling\n                    return true\n                item = nextItem\n            return false\n\n        isPreviousSibling = (item, sibling) ->\n            while item\n                prevItem = item._previousSibling\n                if prevItem is sibling\n                    return true\n                item = prevItem\n            return false\n\n        updateZSiblingsForInsertedItem = (item, nextSibling, z, newChildren) ->\n            if nextSibling._z is z\n                # simple case - the same z-index as in nextSibling\n                if item._belowSibling = nextSibling._belowSibling\n                    item._belowSibling._aboveSibling = item\n                item._aboveSibling = nextSibling\n                nextSibling._belowSibling = item\n            else\n                # hard case - different z-indexes\n                nextChild = newChildren._bottomChild\n                while child = nextChild\n                    nextChild = child._aboveSibling\n                    if child._z > z or (child._z is z and isNextSibling(item, child))\n                        item._aboveSibling = child\n                        if item._belowSibling = child._belowSibling\n                            item._belowSibling._aboveSibling = item\n                        child._belowSibling = item\n                        break\n                    unless nextChild\n                        item._aboveSibling = null\n                        item._belowSibling = child\n                        child._aboveSibling = item\n            return\n\n        utils.defineProperty @::, 'nextSibling', null, ->\n            @_nextSibling\n        , (val=null) ->\n            assert.isNot @, val\n            if val\n                assert.instanceOf val, Item\n                assert.isDefined val._parent\n            else\n                assert.isDefined @_parent\n\n            if val is @_nextSibling\n                return\n\n            oldParent = @_parent\n            oldChildren = oldParent?._children\n            oldPreviousSibling = @_previousSibling\n            oldNextSibling = @_nextSibling\n\n            if val\n                newParent = val._parent\n                newChildren = newParent._children\n            else\n                newParent = oldParent\n                newChildren = oldChildren\n\n            # new parent\n            @_parent = newParent\n\n            # current siblings\n            oldPreviousSibling?._nextSibling = oldNextSibling\n            oldNextSibling?._previousSibling = oldPreviousSibling\n\n            # new siblings\n            previousSibling = previousSiblingOldNextSibling = null\n            nextSibling = nextSiblingOldPreviousSibling = null\n            if val\n                if previousSibling = val._previousSibling\n                    previousSiblingOldNextSibling = previousSibling._nextSibling\n                    previousSibling._nextSibling = @\n\n                nextSibling = val\n                nextSiblingOldPreviousSibling = nextSibling._previousSibling\n                nextSibling._previousSibling = @\n            else\n                if previousSibling = newChildren.lastChild\n                    previousSibling._nextSibling = @\n\n            @_previousSibling = previousSibling\n            @_nextSibling = nextSibling\n\n            # children\n            if oldChildren\n                oldChildren._length -= 1\n                unless oldPreviousSibling\n                    oldChildren._firstChild = oldNextSibling\n                unless oldNextSibling\n                    oldChildren._lastChild = oldPreviousSibling\n            newChildren._length += 1\n            if newChildren.firstChild is val\n                newChildren._firstChild = @\n            unless val\n                newChildren._lastChild = @\n\n            # old z-index siblings\n            oldBelowSibling = @_belowSibling\n            oldAboveSibling = @_aboveSibling\n            if oldBelowSibling isnt null\n                oldBelowSibling._aboveSibling = oldAboveSibling\n            if oldAboveSibling isnt null\n                oldAboveSibling._belowSibling = oldBelowSibling\n\n            # new z-index siblings\n            @_belowSibling = @_aboveSibling = null\n            if nextSibling\n                updateZSiblingsForInsertedItem @, nextSibling, @_z, newChildren\n            else\n                updateZSiblingsForAppendedItem @, @_z, newChildren\n\n            # z-index children\n            if oldChildren\n                unless oldAboveSibling\n                    oldChildren._topChild = oldBelowSibling\n                unless oldBelowSibling\n                    oldChildren._bottomChild = oldAboveSibling\n            unless @_aboveSibling\n                newChildren._topChild = @\n            unless @_belowSibling\n                newChildren._bottomChild = @\n\n            # implementation\n            insertItemInImpl @\n\n            `\/\/<development>`\n            assert.is @_nextSibling, val\n            assert.is @_parent, newParent\n            if val\n                assert.is @_parent, val._parent\n            if @_previousSibling\n                assert.is @_previousSibling._nextSibling, @\n            if @_nextSibling\n                assert.is @_nextSibling._previousSibling, @\n            if oldPreviousSibling\n                assert.is oldPreviousSibling._nextSibling, oldNextSibling\n            if oldNextSibling\n                assert.is oldNextSibling._previousSibling, oldPreviousSibling\n            `\/\/<\/development>`\n\n            # children signal\n            if oldParent isnt newParent\n                if oldParent\n                    emitSignal oldParent, 'onChildrenChange', null, @\n                emitSignal newParent, 'onChildrenChange', @, null\n                emitSignal @, 'onParentChange', oldParent\n            else\n                emitSignal newParent, 'onChildrenChange', null, null\n\n            # current siblings signals\n            if oldPreviousSibling\n                emitSignal oldPreviousSibling, 'onNextSiblingChange', @\n            if oldNextSibling\n                emitSignal oldNextSibling, 'onPreviousSiblingChange', @\n\n            # new siblings signals\n            emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling\n            if previousSibling\n                emitSignal previousSibling, 'onNextSiblingChange', previousSiblingOldNextSibling\n            emitSignal @, 'onNextSiblingChange', oldNextSibling\n            if nextSibling\n                emitSignal nextSibling, 'onPreviousSiblingChange', nextSiblingOldPreviousSibling\n\n            return\n\n## *Signal* Item::onNextSiblingChange(*Item* oldValue)\n\n        signal.Emitter.createSignal @, 'onNextSiblingChange'\n\n## ReadOnly *Item* Item::belowSibling\n\n        utils.defineProperty @::, 'belowSibling', null, ->\n            @_belowSibling\n        , null\n\n## ReadOnly *Item* Item::aboveSibling\n\n        utils.defineProperty @::, 'aboveSibling', null, ->\n            @_aboveSibling\n        , null\n\n## *Integer* Item::index\n\n        utils.defineProperty @::, 'index', null, ->\n            index = 0\n            sibling = @\n            while sibling = sibling.previousSibling\n                index++\n            index\n        , (val) ->\n            assert.isInteger val\n            assert.isDefined @_parent\n            assert.operator val, '>=', 0\n            assert.operator val, '<=', @_parent._children.length\n\n            {children} = @parent\n            if val >= children.length\n                @nextSibling = null\n            else if (valItem = children.get(val)) isnt @\n                @nextSibling = valItem\n\n            return\n\n## *Boolean* Item::visible = `true`\n\nDetermines whether an item is visible or not.\n\n```nml\nItem {\n    width: 100\n    height: 100\n    pointer.onClick: function(){\n        rect.visible = !rect.visible;\n        text.text = rect.visible ? \"Click to hide\" : \"Click to show\";\n    }\n    Rectangle {\n        id: rect\n        anchors.fill: parent\n        color: 'blue'\n    }\n    Text {\n        id: text\n        text: \"Click to hide\"\n        anchors.centerIn: parent\n    }\n}\n```\n\n## *Signal* Item::onVisibleChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'visible'\n            defaultValue: true\n            implementation: Impl.setItemVisible\n            developmentSetter: (val) ->\n                assert.isBoolean val, '::visible setter ...'\n\n## *Boolean* Item::clip = `false`\n\n## *Signal* Item::onClipChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'clip'\n            defaultValue: false\n            implementation: Impl.setItemClip\n            developmentSetter: (val) ->\n                assert.isBoolean val, '::clip setter ...'\n\n## *Float* Item::width = `0`\n\n## *Signal* Item::onWidthChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'width'\n            defaultValue: 0\n            implementation: Impl.setItemWidth\n            developmentSetter: (val) ->\n                assert.isFloat val, '::width setter ...'\n\n## *Float* Item::height = `0`\n\n## *Signal* Item::onHeightChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'height'\n            defaultValue: 0\n            implementation: Impl.setItemHeight\n            developmentSetter: (val) ->\n                assert.isFloat val, '::height setter ...'\n\n## *Float* Item::x = `0`\n\n## *Signal* Item::onXChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'x'\n            defaultValue: 0\n            implementation: Impl.setItemX\n            developmentSetter: (val) ->\n                assert.isFloat val, '::x setter ...'\n\n## *Float* Item::y = `0`\n\n## *Signal* Item::onYChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'y'\n            defaultValue: 0\n            implementation: Impl.setItemY\n            developmentSetter: (val) ->\n                assert.isFloat val, '::y setter ...'\n\n## *Float* Item::z = `0`\n\n## *Signal* Item::onZChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'z'\n            defaultValue: 0\n            developmentSetter: (val) ->\n                assert.isFloat val, '::z setter ...'\n            setter: (_super) -> (val) ->\n                oldVal = @_z\n                if oldVal is val\n                    return\n\n                _super.call @, val\n\n                unless parent = @_parent\n                    return\n                children = parent._children\n                oldAboveSibling = @_aboveSibling\n                oldBelowSibling = @_belowSibling\n\n                # new siblings\n                if val > oldVal\n                    nextChild = @_aboveSibling\n                    while child = nextChild\n                        nextChild = child._aboveSibling\n                        if child._z > val or (child._z is val and isNextSibling(@, child))\n                            if oldAboveSibling is child\n                                break\n                            @_aboveSibling = child\n                            if @_belowSibling = child._belowSibling\n                                @_belowSibling._aboveSibling = @\n                            child._belowSibling = @\n                            break\n                        unless nextChild\n                            @_aboveSibling = null\n                            @_belowSibling = child\n                            child._aboveSibling = @\n\n                if val < oldVal\n                    prevChild = @_belowSibling\n                    while child = prevChild\n                        prevChild = child._belowSibling\n                        if child._z < val or (child._z is val and isPreviousSibling(@, child))\n                            if oldBelowSibling is child\n                                break\n                            @_belowSibling = child\n                            aboveSibling = child._aboveSibling\n                            if @_aboveSibling = child._aboveSibling\n                                @_aboveSibling._belowSibling = @\n                            child._aboveSibling = @\n                            break\n                        unless prevChild\n                            @_belowSibling = null\n                            @_aboveSibling = child\n                            child._belowSibling = @\n\n                # clean old siblings\n                if oldBelowSibling and oldBelowSibling isnt @_belowSibling\n                    oldBelowSibling._aboveSibling = oldAboveSibling\n                if oldAboveSibling and oldAboveSibling isnt @_aboveSibling\n                    oldAboveSibling._belowSibling = oldBelowSibling\n\n                # new children\n                if @_belowSibling\n                    if children._bottomChild is @\n                        children._bottomChild = oldAboveSibling\n                else\n                    children._bottomChild = @\n                if @_aboveSibling\n                    if children._topChild is @\n                        children._topChild = oldBelowSibling\n                else\n                    children._topChild = @\n\n                # implementation\n                if oldAboveSibling isnt @_aboveSibling\n                    insertItemInImpl @\n\n                `\/\/<development>`\n                assert.isNot @_belowSibling, @\n                assert.isNot @_belowSibling?._belowSibling, @\n                assert.isNot @_aboveSibling, @\n                assert.isNot @_aboveSibling?._aboveSibling, @\n                if @_belowSibling\n                    assert.is @_belowSibling._aboveSibling, @\n                if @_aboveSibling\n                    assert.is @_aboveSibling._belowSibling, @\n                `\/\/<\/development>`\n                return\n\n## *Float* Item::scale = `1`\n\n## *Signal* Item::onScaleChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'scale'\n            defaultValue: 1\n            implementation: Impl.setItemScale\n            developmentSetter: (val) ->\n                assert.isFloat val, '::scale setter ...'\n\n## *Float* Item::rotation = `0`\n\n```nml\nRectangle {\n    width: 100\n    height: 100\n    color: 'red'\n    rotation: Math.PI \/ 4\n}\n```\n\n## *Signal* Item::onRotationChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'rotation'\n            defaultValue: 0\n            implementation: Impl.setItemRotation\n            developmentSetter: (val) ->\n                assert.isFloat val, '::rotation setter ...'\n\n## *Float* Item::opacity = `1`\n\n## *Signal* Item::onOpacityChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'opacity'\n            defaultValue: 1\n            implementation: Impl.setItemOpacity\n            developmentSetter: (val) ->\n                assert.isFloat val, '::opacity setter ...'\n\n## *String* Item::linkUri = ''\n\nPoints to the URI which will be used when user clicks on this item.\n\n## *Signal* Item::onLinkUriChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'linkUri'\n            defaultValue: ''\n            implementation: Impl.setItemLinkUri\n            developmentSetter: (val) ->\n                assert.isString val, '::linkUri setter ...'\n\n## *Item* Item::background\n\nAn item used as a background for the item.\n\nBy default, background is filled to his parent.\n\n## *Signal* Item::onBackgroundChange(*Item* oldValue)\n\n        defaultBackgroundClass = do ->\n            ext = Renderer.Class.New new Renderer.Component\n            ext.priority = -1\n            ext.changes.setAttribute 'anchors.fill', ['parent']\n            ext\n\n        createDefaultBackground = (parent) ->\n            rect = Renderer.Rectangle.New parent._component\n            ext = defaultBackgroundClass.clone parent._component\n            ext.target = rect\n            ext.enable()\n            rect\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'background'\n            defaultValue: null\n            developmentSetter: (val) ->\n                if val?\n                    assert.instanceOf val, Item\n            getter: (_super) -> ->\n                unless @_background\n                    @_defaultBackground ||= createDefaultBackground @\n                    @background = @_defaultBackground\n                _super.call @\n            setter: (_super) -> (val) ->\n                val ||= @_defaultBackground\n                oldVal = @_background\n                if val is oldVal\n                    return\n                if oldVal and oldVal._parent is @\n                    oldVal._parent = null\n                    emitSignal oldVal, 'onParentChange', @\n                if val\n                    oldParent = val._parent\n                    if val._previousSibling or val._nextSibling\n                        val.parent = null\n                    val._parent = @\n                    emitSignal val, 'onParentChange', oldParent\n                Impl.setItemBackground.call @, val\n                _super.call @, val\n\n## Item::overlap(*Item* item)\n\nReturns `true` if two items overlaps.\n\n        overlap: (item) ->\n            assert.instanceOf item, Item\n\n            Impl.doItemOverlap.call @, item\n\n        @createSpacing = require('.\/item\/spacing') Renderer, Impl, itemUtils, Item\n        @createAlignment = require('.\/item\/alignment') Renderer, Impl, itemUtils, Item\n        @createAnchors = require('.\/item\/anchors') Renderer, Impl, itemUtils, Item\n        @createLayout = require('.\/item\/layout') Renderer, Impl, itemUtils, Item\n        @createMargin = require('.\/item\/margin') Renderer, Impl, itemUtils, Item\n        @createPointer = require('.\/item\/pointer') Renderer, Impl, itemUtils, Item\n        @createKeys = require('.\/item\/keys') Renderer, Impl, itemUtils, Item\n        @createDocument = require('.\/item\/document') Renderer, Impl, itemUtils, Item\n\n## *Item.Anchors* Item::anchors\n\n## *Signal* Item::onAnchorsChange(*String* property, *Array* oldValue)\n\n        @createAnchors @\n\n## *Item.Layout* Item::layout\n\n## *Signal* Item::onLayoutChange(*String* property, *Any* oldValue)\n\n        @createLayout @\n\n## *Item.Pointer* Item::pointer\n\n        @Pointer = @createPointer @\n\n## *Item.Margin* Item::margin\n\n## *Signal* Item::onMarginChange(*String* property, *Any* oldValue)\n\n        @createMargin @\n\n## *Item.Keys* Item::keys\n\n        @Keys = @createKeys @\n\n## *Item.Document* Item::document\n\n        @Document = @createDocument @\n\n        Item\n\n# Glossary\n\n- [Item](#class-item)\n","old_contents":"# Item\n\n    'use strict'\n\n    assert = require 'src\/assert'\n    utils = require 'src\/utils'\n    signal = require 'src\/signal'\n    List = require 'src\/list'\n\n    {isArray} = Array\n    {emitSignal} = signal.Emitter\n\n    assert = assert.scope 'Renderer.Item'\n\n# **Class** Item\n\n    module.exports = (Renderer, Impl, itemUtils) -> class Item extends itemUtils.Object\n        @__name__ = 'Item'\n        @__path__ = 'Renderer.Item'\n\n## *Item* Item.New([*Component* component, *Object* options])\n\n        @New = (component, opts) ->\n            item = new Item\n            itemUtils.Object.initialize item, component, opts\n            item\n\n## Item::constructor()\n\nThis is a base class for everything which is visible.\n\n        constructor: ->\n            assert.instanceOf @, Item, 'ctor ...'\n\n            super()\n            @_$ = null\n            @_parent = null\n            @_children = null\n            @_previousSibling = null\n            @_nextSibling = null\n            @_belowSibling = null\n            @_aboveSibling = null\n            @_width = 0\n            @_height = 0\n            @_x = 0\n            @_y = 0\n            @_z = 0\n            @_visible = true\n            @_clip = false\n            @_scale = 1\n            @_rotation = 0\n            @_opacity = 1\n            @_linkUri = ''\n            @_anchors = null\n            @_layout = null\n            @_document = null\n            @_keys = null\n            @_pointer = null\n            @_margin = null\n            @_classes = null\n            @_background = null\n            @_defaultBackground = null\n\n### Custom properties\n\n```nml\n`Item {\n`   id: main\n`   property $.currentLife: 0.8\n`\n`   Text {\n`     text: \"Life: \" + main.$.currentLife\n`   }\n`}\n```\n\n### Custom signals\n\n```nml\n`Item {\n`   signal $.onPlayerCollision\n`   $.onPlayerCollision: function(){\n`       \/\/ boom!\n`   }\n`}\n```\n\n## *Signal* Item::on$Change(*String* property, *Any* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: '$'\n            valueConstructor: itemUtils.CustomObject\n\n## *Signal* Item::ready()\n\nCalled when the Item is ready, that is, all\nproperties have been set and it's ready to use.\n\n```nml\nRectangle {\n    width: 200\n    height: 50\n    color: 'green'\n    Rectangle {\n        width: parent.width \/ 2\n        height: parent.height \/ 2\n        color: 'yellow'\n        onReady: function(){\n            console.log(this.width, this.height);\n            \/\/ 100, 25\n        }\n    }\n}\n```\n\n        signal.Emitter.createSignal @, 'onReady'\n\n## *Signal* Item::onAnimationFrame(*Integer* miliseconds)\n\n        signal.Emitter.createSignal @, 'onAnimationFrame', do ->\n            now = Date.now()\n            items = []\n\n            frame = ->\n                oldNow = now\n                now = Date.now()\n                ms = now - oldNow\n\n                for item in items\n                    emitSignal item, 'onAnimationFrame', ms\n                requestAnimationFrame frame\n\n            requestAnimationFrame? frame\n\n            (item) ->\n                items.push item\n\n## ReadOnly *String* Item::id\n\n## *Object* Item::children\n\n        utils.defineProperty @::, 'children', null, ->\n            @_children ||= new ChildrenObject(@)\n        , (val) ->\n            assert.isArray val, '::children setter ...'\n            @clear()\n            for item in val\n                val.parent = @\n            return\n\n## *Signal* Item::onChildrenChange(*Item* added, *Item* removed)\n\n        signal.Emitter.createSignal @, 'onChildrenChange'\n\n        class ChildrenObject extends itemUtils.MutableDeepObject\n            constructor: (ref) ->\n                @_layout = null\n                @_target = null\n                @_firstChild = null\n                @_lastChild = null\n                @_bottomChild = null\n                @_topChild = null\n                @_length = 0\n                super ref\n\n### ReadOnly *Item* Item::children.firstChild\n\n            utils.defineProperty @::, 'firstChild', null, ->\n                @_firstChild\n            , null\n\n### ReadOnly *Item* Item::children.lastChild\n\n            utils.defineProperty @::, 'lastChild', null, ->\n                @_lastChild\n            , null\n\n### ReadOnly *Item* Item::children.bottomChild\n\n            utils.defineProperty @::, 'bottomChild', null, ->\n                @_bottomChild\n            , null\n\n### ReadOnly *Item* Item::children.topChild\n\n            utils.defineProperty @::, 'topChild', null, ->\n                @_topChild\n            , null\n\n### ReadOnly *Integer* Item::children.length\n\n            utils.defineProperty @::, 'length', null, ->\n                @_length\n            , null\n\n### *Item* Item::children.layout\n\nItem used to position children items.\nCan be e.g. *Flow*, *Grid* etc.\n\n### *Signal* Item::children.onLayoutChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'layout'\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Item\n                setter: (_super) -> (val) ->\n                    if @_layout?.effectItem\n                        @_layout.parent = null\n                        @_layout.effectItem = @_layout\n\n                    _super.call @, val\n\n                    if '_effectItem' of @_ref\n                        @_ref.effectItem = if val then null else @_ref\n\n                    if val?\n                        ref = @_ref\n                        setFakeParent val, ref, 0\n                        if val.effectItem\n                            val.effectItem = ref\n\n                    return\n\n### *Item* Item::children.target\n\nA new child trying to be added into the item with the `children.target` defined\nwill be added into the `target` item.\n\n### *Signal* Item::children.onTargetChange(*Item* oldValue)\n\n            itemUtils.defineProperty\n                constructor: @\n                name: 'target'\n                defaultValue: null\n                developmentSetter: (val) ->\n                    if val?\n                        assert.instanceOf val, Item\n\n### *Item* Item::children.get(*Integer* index)\n\nReturns an item with the given index.\n\n            get: (val) ->\n                assert.operator val, '>=', 0\n                assert.operator val, '<', @length\n\n                if val < @length\/2\n                    sibling = @firstChild\n                    while val > 0\n                        sibling = sibling.nextSibling\n                        val--\n                else\n                    sibling = @lastChild\n                    while val > 0\n                        sibling = sibling.previousSibling\n                        val--\n\n                sibling\n\n### *Integer* Item::children.index(*Item* value)\n\nReturns an index of the given child in the children array.\n\n            index: (val) ->\n                if @has(val)\n                    val.index\n                else\n                    -1\n\n### *Boolean* Item::children.has(*Item* value)\n\nReturns `true` if the given item is an item child.\n\n            has: (val) ->\n                @_ref is val._parent\n\n### Item::children.clear()\n\nRemoves all children from the item.\n\n            clear: ->\n                while last = @last\n                    last.parent = null\n                return\n\n## *Item* Item::parent = null\n\n## *Signal* Item::onParentChange(*Item* oldParent)\n\n        setFakeParent = (child, parent, index=-1) ->\n            child.parent = null\n\n            if index >= 0 and parent.children._length < index\n                Impl.insertItemBefore.call child, parent.children[index]\n            else\n                Impl.setItemParent.call child, parent\n\n            child._parent = parent\n            emitSignal child, 'onParentChange', null\n            return\n\n        updateZSiblingsForAppendedItem = (item, z, newChildren) ->\n            child = newChildren._topChild\n            while child\n                if child._z <= z\n                    if item._aboveSibling = child._aboveSibling\n                        item._aboveSibling._belowSibling = item\n                    item._belowSibling = child\n                    child._aboveSibling = item\n                    return\n                unless nextChild = child._belowSibling\n                    item._aboveSibling = child\n                    child._belowSibling = item\n                    item._belowSibling = null\n                    return\n                child = nextChild\n            return\n\n        insertItemInImpl = (item) ->\n            if aboveSibling = item._aboveSibling\n                Impl.insertItemBefore.call item, aboveSibling\n            else\n                Impl.setItemParent.call item, item._parent\n            return\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'parent'\n            defaultValue: null\n            setter: (_super) -> (val=null) ->\n                old = @_parent\n                oldChildren = old?.children\n                valChildren = val?.children\n\n                if valChildren?._target\n                    # detect whether target is a child of this item\n                    containsItem = false\n                    tmpItem = valChildren._target\n                    while tmpItem\n                        if tmpItem is @\n                            containsItem = true\n                            break\n                        tmpItem = tmpItem._parent\n\n                    unless containsItem\n                        val = valChildren._target\n                        valChildren = val.children\n\n                if old is val\n                    return\n\n                assert.isNot @, val\n\n                if pointer = @_pointer\n                    pointer.hover = pointer.pressed = false\n\n                if val isnt null\n                    assert.instanceOf val, Item, '::parent setter ...'\n\n                # old siblings\n                oldPreviousSibling = @_previousSibling\n                oldNextSibling = @_nextSibling\n                if oldPreviousSibling isnt null\n                    oldPreviousSibling._nextSibling = oldNextSibling\n                if oldNextSibling isnt null\n                    oldNextSibling._previousSibling = oldPreviousSibling\n\n                # new siblings\n                if val isnt null\n                    if previousSibling = @_previousSibling = valChildren.lastChild\n                        previousSibling._nextSibling = @\n                else\n                    @_previousSibling = null\n                if oldNextSibling isnt null\n                    @_nextSibling = null\n\n                # children\n                if oldChildren\n                    oldChildren._length -= 1\n                    if oldChildren.firstChild is @\n                        oldChildren._firstChild = oldNextSibling\n                    if oldChildren.lastChild is @\n                        oldChildren._lastChild = oldPreviousSibling\n                if valChildren\n                    if ++valChildren._length is 1\n                        valChildren._firstChild = @\n                    valChildren._lastChild = @\n\n                # old z-index siblings\n                oldBelowSibling = @_belowSibling\n                oldAboveSibling = @_aboveSibling\n                if oldBelowSibling isnt null\n                    oldBelowSibling._aboveSibling = oldAboveSibling\n                if oldAboveSibling isnt null\n                    oldAboveSibling._belowSibling = oldBelowSibling\n\n                # new z-index siblings\n                if valChildren\n                    updateZSiblingsForAppendedItem @, @_z, valChildren\n                else\n                    @_belowSibling = @_aboveSibling = null\n\n                # z-index children\n                if oldChildren\n                    unless oldAboveSibling\n                        oldChildren._topChild = oldBelowSibling\n                    unless oldBelowSibling\n                        oldChildren._bottomChild = oldAboveSibling\n                if valChildren\n                    unless @_aboveSibling\n                        valChildren._topChild = @\n                    unless @_belowSibling\n                        valChildren._bottomChild = @\n\n                # parent\n                @_parent = val\n                insertItemInImpl @\n\n                `\/\/<development>`\n                assert.is @nextSibling, null\n                if val\n                    assert.is val.children.lastChild, @\n                `\/\/<\/development>`\n\n                # signals\n                if old isnt null\n                    emitSignal old, 'onChildrenChange', null, @\n                if val isnt null\n                    emitSignal val, 'onChildrenChange', @, null\n\n                emitSignal @, 'onParentChange', old\n\n                if oldPreviousSibling isnt null\n                    emitSignal oldPreviousSibling, 'onNextSiblingChange', @\n                if oldNextSibling isnt null\n                    emitSignal oldNextSibling, 'onPreviousSiblingChange', @\n\n                if val isnt null or oldPreviousSibling isnt null\n                    if previousSibling\n                        emitSignal previousSibling, 'onNextSiblingChange', null\n                    emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling\n                if oldNextSibling isnt null\n                    emitSignal @, 'onNextSiblingChange', oldNextSibling\n\n                return\n\n## *Item* Item::previousSibling\n\n        utils.defineProperty @::, 'previousSibling', null, ->\n            @_previousSibling\n        , (val=null) ->\n            assert.isNot @, val\n\n            if val is @_previousSibling\n                return\n\n            if val\n                assert.instanceOf val, Item\n                nextSibling = val._nextSibling\n                if not nextSibling and val._parent isnt @_parent\n                    @parent = val._parent\n                else\n                    @nextSibling = nextSibling\n            else\n                assert.isDefined @_parent\n                @nextSibling = @_parent.children.firstChild\n\n            assert.is @_previousSibling, val\n            return\n\n## *Signal* Item::onPreviousSiblingChange(*Item* oldValue)\n\n        signal.Emitter.createSignal @, 'onPreviousSiblingChange'\n\n## *Item* Item::nextSibling\n\n        isNextSibling = (item, sibling) ->\n            while item\n                nextItem = item._nextSibling\n                if nextItem is sibling\n                    return true\n                item = nextItem\n            return false\n\n        isPreviousSibling = (item, sibling) ->\n            while item\n                prevItem = item._previousSibling\n                if prevItem is sibling\n                    return true\n                item = prevItem\n            return false\n\n        updateZSiblingsForInsertedItem = (item, nextSibling, z, newChildren) ->\n            if nextSibling._z is z\n                # simple case - the same z-index as in nextSibling\n                if item._belowSibling = nextSibling._belowSibling\n                    item._belowSibling._aboveSibling = item\n                item._aboveSibling = nextSibling\n                nextSibling._belowSibling = item\n            else\n                # hard case - different z-indexes\n                nextChild = newChildren._bottomChild\n                while child = nextChild\n                    nextChild = child._aboveSibling\n                    if child._z > z or (child._z is z and isNextSibling(item, child))\n                        item._aboveSibling = child\n                        if item._belowSibling = child._belowSibling\n                            item._belowSibling._aboveSibling = item\n                        child._belowSibling = item\n                        break\n                    unless nextChild\n                        item._aboveSibling = null\n                        item._belowSibling = child\n                        child._aboveSibling = item\n            return\n\n        utils.defineProperty @::, 'nextSibling', null, ->\n            @_nextSibling\n        , (val=null) ->\n            assert.isNot @, val\n            if val\n                assert.instanceOf val, Item\n                assert.isDefined val._parent\n            else\n                assert.isDefined @_parent\n\n            if val is @_nextSibling\n                return\n\n            oldParent = @_parent\n            oldChildren = oldParent?._children\n            oldPreviousSibling = @_previousSibling\n            oldNextSibling = @_nextSibling\n\n            if val\n                newParent = val._parent\n                newChildren = newParent._children\n            else\n                newParent = oldParent\n                newChildren = oldChildren\n\n            # new parent\n            @_parent = newParent\n\n            # current siblings\n            oldPreviousSibling?._nextSibling = oldNextSibling\n            oldNextSibling?._previousSibling = oldPreviousSibling\n\n            # new siblings\n            previousSibling = previousSiblingOldNextSibling = null\n            nextSibling = nextSiblingOldPreviousSibling = null\n            if val\n                if previousSibling = val._previousSibling\n                    previousSiblingOldNextSibling = previousSibling._nextSibling\n                    previousSibling._nextSibling = @\n\n                nextSibling = val\n                nextSiblingOldPreviousSibling = nextSibling._previousSibling\n                nextSibling._previousSibling = @\n            else\n                if previousSibling = newChildren.lastChild\n                    previousSibling._nextSibling = @\n\n            @_previousSibling = previousSibling\n            @_nextSibling = nextSibling\n\n            # children\n            if oldChildren\n                oldChildren._length -= 1\n                unless oldPreviousSibling\n                    oldChildren._firstChild = oldNextSibling\n                unless oldNextSibling\n                    oldChildren._lastChild = oldPreviousSibling\n            newChildren._length += 1\n            if newChildren.firstChild is val\n                newChildren._firstChild = @\n            unless val\n                newChildren._lastChild = @\n\n            # old z-index siblings\n            oldBelowSibling = @_belowSibling\n            oldAboveSibling = @_aboveSibling\n            if oldBelowSibling isnt null\n                oldBelowSibling._aboveSibling = oldAboveSibling\n            if oldAboveSibling isnt null\n                oldAboveSibling._belowSibling = oldBelowSibling\n\n            # new z-index siblings\n            if nextSibling\n                updateZSiblingsForInsertedItem @, nextSibling, @_z, newChildren\n            else\n                updateZSiblingsForAppendedItem @, @_z, newChildren\n\n            # z-index children\n            if oldChildren\n                unless oldAboveSibling\n                    oldChildren._topChild = oldBelowSibling\n                unless oldBelowSibling\n                    oldChildren._bottomChild = oldAboveSibling\n            unless @_aboveSibling\n                newChildren._topChild = @\n            unless @_belowSibling\n                newChildren._bottomChild = @\n\n            # implementation\n            insertItemInImpl @\n\n            `\/\/<development>`\n            assert.is @_nextSibling, val\n            assert.is @_parent, newParent\n            if val\n                assert.is @_parent, val._parent\n            if @_previousSibling\n                assert.is @_previousSibling._nextSibling, @\n            if @_nextSibling\n                assert.is @_nextSibling._previousSibling, @\n            if oldPreviousSibling\n                assert.is oldPreviousSibling._nextSibling, oldNextSibling\n            if oldNextSibling\n                assert.is oldNextSibling._previousSibling, oldPreviousSibling\n            `\/\/<\/development>`\n\n            # children signal\n            if oldParent isnt newParent\n                if oldParent\n                    emitSignal oldParent, 'onChildrenChange', null, @\n                emitSignal newParent, 'onChildrenChange', @, null\n                emitSignal @, 'onParentChange', oldParent\n            else\n                emitSignal newParent, 'onChildrenChange', null, null\n\n            # current siblings signals\n            if oldPreviousSibling\n                emitSignal oldPreviousSibling, 'onNextSiblingChange', @\n            if oldNextSibling\n                emitSignal oldNextSibling, 'onPreviousSiblingChange', @\n\n            # new siblings signals\n            emitSignal @, 'onPreviousSiblingChange', oldPreviousSibling\n            if previousSibling\n                emitSignal previousSibling, 'onNextSiblingChange', previousSiblingOldNextSibling\n            emitSignal @, 'onNextSiblingChange', oldNextSibling\n            if nextSibling\n                emitSignal nextSibling, 'onPreviousSiblingChange', nextSiblingOldPreviousSibling\n\n            return\n\n## *Signal* Item::onNextSiblingChange(*Item* oldValue)\n\n        signal.Emitter.createSignal @, 'onNextSiblingChange'\n\n## ReadOnly *Item* Item::belowSibling\n\n        utils.defineProperty @::, 'belowSibling', null, ->\n            @_belowSibling\n        , null\n\n## ReadOnly *Item* Item::aboveSibling\n\n        utils.defineProperty @::, 'aboveSibling', null, ->\n            @_aboveSibling\n        , null\n\n## *Integer* Item::index\n\n        utils.defineProperty @::, 'index', null, ->\n            index = 0\n            sibling = @\n            while sibling = sibling.previousSibling\n                index++\n            index\n        , (val) ->\n            assert.isInteger val\n            assert.isDefined @_parent\n            assert.operator val, '>=', 0\n            assert.operator val, '<=', @_parent._children.length\n\n            {children} = @parent\n            if val >= children.length\n                @nextSibling = null\n            else if (valItem = children.get(val)) isnt @\n                @nextSibling = valItem\n\n            return\n\n## *Boolean* Item::visible = `true`\n\nDetermines whether an item is visible or not.\n\n```nml\nItem {\n    width: 100\n    height: 100\n    pointer.onClick: function(){\n        rect.visible = !rect.visible;\n        text.text = rect.visible ? \"Click to hide\" : \"Click to show\";\n    }\n    Rectangle {\n        id: rect\n        anchors.fill: parent\n        color: 'blue'\n    }\n    Text {\n        id: text\n        text: \"Click to hide\"\n        anchors.centerIn: parent\n    }\n}\n```\n\n## *Signal* Item::onVisibleChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'visible'\n            defaultValue: true\n            implementation: Impl.setItemVisible\n            developmentSetter: (val) ->\n                assert.isBoolean val, '::visible setter ...'\n\n## *Boolean* Item::clip = `false`\n\n## *Signal* Item::onClipChange(*Boolean* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'clip'\n            defaultValue: false\n            implementation: Impl.setItemClip\n            developmentSetter: (val) ->\n                assert.isBoolean val, '::clip setter ...'\n\n## *Float* Item::width = `0`\n\n## *Signal* Item::onWidthChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'width'\n            defaultValue: 0\n            implementation: Impl.setItemWidth\n            developmentSetter: (val) ->\n                assert.isFloat val, '::width setter ...'\n\n## *Float* Item::height = `0`\n\n## *Signal* Item::onHeightChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'height'\n            defaultValue: 0\n            implementation: Impl.setItemHeight\n            developmentSetter: (val) ->\n                assert.isFloat val, '::height setter ...'\n\n## *Float* Item::x = `0`\n\n## *Signal* Item::onXChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'x'\n            defaultValue: 0\n            implementation: Impl.setItemX\n            developmentSetter: (val) ->\n                assert.isFloat val, '::x setter ...'\n\n## *Float* Item::y = `0`\n\n## *Signal* Item::onYChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'y'\n            defaultValue: 0\n            implementation: Impl.setItemY\n            developmentSetter: (val) ->\n                assert.isFloat val, '::y setter ...'\n\n## *Float* Item::z = `0`\n\n## *Signal* Item::onZChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'z'\n            defaultValue: 0\n            developmentSetter: (val) ->\n                assert.isFloat val, '::z setter ...'\n            setter: (_super) -> (val) ->\n                oldVal = @_z\n                if oldVal is val\n                    return\n\n                _super.call @, val\n\n                unless parent = @_parent\n                    return\n                children = parent._children\n                oldAboveSibling = @_aboveSibling\n                oldBelowSibling = @_belowSibling\n\n                # new siblings\n                if val > oldVal\n                    nextChild = @_aboveSibling\n                    while child = nextChild\n                        nextChild = child._aboveSibling\n                        if child._z > val or (child._z is val and isNextSibling(@, child))\n                            if oldAboveSibling is child\n                                break\n                            @_aboveSibling = child\n                            if @_belowSibling = child._belowSibling\n                                @_belowSibling._aboveSibling = @\n                            child._belowSibling = @\n                            break\n                        unless nextChild\n                            @_aboveSibling = null\n                            @_belowSibling = child\n                            child._aboveSibling = @\n\n                if val < oldVal\n                    prevChild = @_belowSibling\n                    while child = prevChild\n                        prevChild = child._belowSibling\n                        if child._z < val or (child._z is val and isPreviousSibling(@, child))\n                            if oldBelowSibling is child\n                                break\n                            @_belowSibling = child\n                            aboveSibling = child._aboveSibling\n                            if @_aboveSibling = child._aboveSibling\n                                @_aboveSibling._belowSibling = @\n                            child._aboveSibling = @\n                            break\n                        unless prevChild\n                            @_belowSibling = null\n                            @_aboveSibling = child\n                            child._belowSibling = @\n\n                # clean old siblings\n                if oldBelowSibling and oldBelowSibling isnt @_belowSibling\n                    oldBelowSibling._aboveSibling = oldAboveSibling\n                if oldAboveSibling and oldAboveSibling isnt @_aboveSibling\n                    oldAboveSibling._belowSibling = oldBelowSibling\n\n                # new children\n                if @_belowSibling\n                    if children._bottomChild is @\n                        children._bottomChild = oldAboveSibling\n                else\n                    children._bottomChild = @\n                if @_aboveSibling\n                    if children._topChild is @\n                        children._topChild = oldBelowSibling\n                else\n                    children._topChild = @\n\n                # implementation\n                if oldAboveSibling isnt @_aboveSibling\n                    insertItemInImpl @\n\n                `\/\/<development>`\n                assert.isNot @_belowSibling, @\n                assert.isNot @_belowSibling?._belowSibling, @\n                assert.isNot @_aboveSibling, @\n                assert.isNot @_aboveSibling?._aboveSibling, @\n                if @_belowSibling\n                    assert.is @_belowSibling._aboveSibling, @\n                if @_aboveSibling\n                    assert.is @_aboveSibling._belowSibling, @\n                `\/\/<\/development>`\n                return\n\n## *Float* Item::scale = `1`\n\n## *Signal* Item::onScaleChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'scale'\n            defaultValue: 1\n            implementation: Impl.setItemScale\n            developmentSetter: (val) ->\n                assert.isFloat val, '::scale setter ...'\n\n## *Float* Item::rotation = `0`\n\n```nml\nRectangle {\n    width: 100\n    height: 100\n    color: 'red'\n    rotation: Math.PI \/ 4\n}\n```\n\n## *Signal* Item::onRotationChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'rotation'\n            defaultValue: 0\n            implementation: Impl.setItemRotation\n            developmentSetter: (val) ->\n                assert.isFloat val, '::rotation setter ...'\n\n## *Float* Item::opacity = `1`\n\n## *Signal* Item::onOpacityChange(*Float* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'opacity'\n            defaultValue: 1\n            implementation: Impl.setItemOpacity\n            developmentSetter: (val) ->\n                assert.isFloat val, '::opacity setter ...'\n\n## *String* Item::linkUri = ''\n\nPoints to the URI which will be used when user clicks on this item.\n\n## *Signal* Item::onLinkUriChange(*String* oldValue)\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'linkUri'\n            defaultValue: ''\n            implementation: Impl.setItemLinkUri\n            developmentSetter: (val) ->\n                assert.isString val, '::linkUri setter ...'\n\n## *Item* Item::background\n\nAn item used as a background for the item.\n\nBy default, background is filled to his parent.\n\n## *Signal* Item::onBackgroundChange(*Item* oldValue)\n\n        defaultBackgroundClass = do ->\n            ext = Renderer.Class.New new Renderer.Component\n            ext.priority = -1\n            ext.changes.setAttribute 'anchors.fill', ['parent']\n            ext\n\n        createDefaultBackground = (parent) ->\n            rect = Renderer.Rectangle.New parent._component\n            ext = defaultBackgroundClass.clone parent._component\n            ext.target = rect\n            ext.enable()\n            rect\n\n        itemUtils.defineProperty\n            constructor: @\n            name: 'background'\n            defaultValue: null\n            developmentSetter: (val) ->\n                if val?\n                    assert.instanceOf val, Item\n            getter: (_super) -> ->\n                unless @_background\n                    @_defaultBackground ||= createDefaultBackground @\n                    @background = @_defaultBackground\n                _super.call @\n            setter: (_super) -> (val) ->\n                val ||= @_defaultBackground\n                oldVal = @_background\n                if val is oldVal\n                    return\n                if oldVal and oldVal._parent is @\n                    oldVal._parent = null\n                    emitSignal oldVal, 'onParentChange', @\n                if val\n                    oldParent = val._parent\n                    if val._previousSibling or val._nextSibling\n                        val.parent = null\n                    val._parent = @\n                    emitSignal val, 'onParentChange', oldParent\n                Impl.setItemBackground.call @, val\n                _super.call @, val\n\n## Item::overlap(*Item* item)\n\nReturns `true` if two items overlaps.\n\n        overlap: (item) ->\n            assert.instanceOf item, Item\n\n            Impl.doItemOverlap.call @, item\n\n        @createSpacing = require('.\/item\/spacing') Renderer, Impl, itemUtils, Item\n        @createAlignment = require('.\/item\/alignment') Renderer, Impl, itemUtils, Item\n        @createAnchors = require('.\/item\/anchors') Renderer, Impl, itemUtils, Item\n        @createLayout = require('.\/item\/layout') Renderer, Impl, itemUtils, Item\n        @createMargin = require('.\/item\/margin') Renderer, Impl, itemUtils, Item\n        @createPointer = require('.\/item\/pointer') Renderer, Impl, itemUtils, Item\n        @createKeys = require('.\/item\/keys') Renderer, Impl, itemUtils, Item\n        @createDocument = require('.\/item\/document') Renderer, Impl, itemUtils, Item\n\n## *Item.Anchors* Item::anchors\n\n## *Signal* Item::onAnchorsChange(*String* property, *Array* oldValue)\n\n        @createAnchors @\n\n## *Item.Layout* Item::layout\n\n## *Signal* Item::onLayoutChange(*String* property, *Any* oldValue)\n\n        @createLayout @\n\n## *Item.Pointer* Item::pointer\n\n        @Pointer = @createPointer @\n\n## *Item.Margin* Item::margin\n\n## *Signal* Item::onMarginChange(*String* property, *Any* oldValue)\n\n        @createMargin @\n\n## *Item.Keys* Item::keys\n\n        @Keys = @createKeys @\n\n## *Item.Document* Item::document\n\n        @Document = @createDocument @\n\n        Item\n\n# Glossary\n\n- [Item](#class-item)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"286386f86c88891459bf607db3eb8722fba04fc5","subject":"webpack","message":"webpack\n","repos":"glebm\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,glebm\/gulp-webpack-react-bootstrap-sass-template,vmlinz\/gulp-webpack-react-bootstrap-sass-template,duereg\/tile-thinger,duereg\/tile-thinger,vmlinz\/gulp-webpack-react-bootstrap-sass-template","old_file":"webpack.config.litcoffee","new_file":"webpack.config.litcoffee","new_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc),\nand processes JS `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    path    = require('path')\n    webpack = require('webpack')\n    _       = require('lodash')\n\n## CSS configuration\n\nList of loader names for CSS files:\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?last 2 versions']\n\nStyle module loaders (used later):\n\n    styleLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\"sass?precision=10&outputStyle=expanded&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/, loaders: cssLoaders }\n    ]\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not `.js` files. Create plugin instance (used later):\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\nOverride style loaders to use `ExtractTextPlugin`:\n\n    styleLoaders = styleLoaders.map (e) ->\n      test: e.test\n      loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!'))\n\n## Configuration\n\n    module.exports =\n\nList of bundle entry points, i.e. packages to compile in the distribution. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n      entry:\n        main             : \".\/src\/scripts\/main.litcoffee\"\n        \"styles\"         : \".\/src\/styles\/styles.scss\"\n        \"vendor\/es5-shim\": \".\/bower_components\/es5-shim\/es5-shim.js\"\n        \"vendor\/es5-sham\": \".\/bower_components\/es5-shim\/es5-sham.js\"\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n\nOutput options:\n\n      output:\n        path         : path.join(__dirname, \"dist\", \"assets\")\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: ['bower_components', 'node_modules']\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleLoaders.concat [\n          { test: \/\\.gif$\/, loader: \"url?limit=10000&minetype=image\/gif\" }\n          { test: \/\\.jpg$\/, loader: \"url?limit=10000&minetype=image\/jpg\" }\n          { test: \/\\.png$\/, loader: \"url?limit=10000&minetype=image\/png\" }\n          { test: \/\\.js$\/, loader: \"jsx\" }\n          { test: \/\\.coffee$\/, loader: \"jsx!coffee\" }\n          { test: \/\\.litcoffee$\/, loader: \"jsx!coffee?literate\"}\n          # url-loader embeds DataUrls.\n          { test: \/\\.woff$\/, loader: \"url?limit=10000&minetype=application\/font-woff\" }\n          # file-loader emits files.\n          { test: \/\\.ttf$\/, loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n          { test: \/\\.eot$\/, loader: \"file?mimetype=application\/x-font-ttf\" }\n          { test: \/\\.svg$\/, loader: \"file?mimetype=image\/svg+xml\" }\n        ]\n        noParse: \/\\.min\\.js$\/\n\nDefine the plugins:\n\n      plugins: [\n\n`DefinePlugin` defines a variable that will be substituted in the assets (a la macro):\n\n        new webpack.DefinePlugin(__PRODUCTION__: JSON.stringify(false))\n\n`extractTextPlugin` (defined above) will compile CSS to a .css file, as opposed to inlining it as a string in a .js file.\n\n        extractTextPlugin\n      ]\n\n\n## Production\n\nExport a method that applies production settings (used in gulpfile):\n\n      useProductionSettings: ->\n\nProduction plugins:\n\n        plugins = @plugins.concat [\n\nMinify JavaScript with UglifyJS:\n\n          new webpack.optimize.UglifyJsPlugin()\n        ]\n\nSet `__PRODUCTION__` to true in the `DefinePlugin` instance:\n\n        for plugin in plugins when plugin.definitions?.__PRODUCTION__\n          plugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\nTell `ExtractTextPlugin` to append hashes (BROKEN, see [plugin issue #9](https:\/\/github.com\/webpack\/extract-text-webpack-plugin\/issues\/9)):\n\n        for plugin in plugins when plugin.filename == '[name].css'\n          plugin.filename = '[name]-[hash].css'\n\nMerge in production config (deep merge):\n\n        _.merge @,\n\nDisable development settings:\n\n          debug: false\n          watch: false\n          devtool: null\n\nAdd content hashes to the output filenames:\n\n          output:\n            filename: \"[name]-[hash].js\"\n\nProduction-only plugins:\n\n          plugins: plugins\n","old_contents":"# Webpack Configuration\n\n[Webpack](https:\/\/github.com\/webpack\/webpack) handles asset compilation (Sass, CoffeeScript, etc),\nand processes JS `require`, Sass `@import`, and CSS `url()`.\n\nFirst, require the dependencies:\n\n    path    = require('path')\n    webpack = require('webpack')\n    _       = require('lodash')\n\n## CSS configuration\n\nList of loader names for CSS files:\n\n    cssLoaders = ['style', 'css', 'autoprefixer-loader?last 2 versions']\n\nStyle module loaders (used later):\n\n    styleLoaders = [\n      { test: \/\\.scss$\/, loaders: cssLoaders.concat([\"sass?precision=10&outputStyle=expanded&includePaths[]=\" + path.resolve(__dirname, '.\/bower_components')]) }\n      { test: \/\\.css$\/, loaders: cssLoaders }\n    ]\n\n`ExtractTextPlugin` is an experimental plugin to output CSS in `.css` and not `.js` files. Create plugin instance (used later):\n\n    ExtractTextPlugin = require(\"extract-text-webpack-plugin\")\n    extractTextPlugin = new ExtractTextPlugin(\"[name].css\", allChunks: true)\n\nOverride style loaders to use `ExtractTextPlugin`:\n\n    styleLoaders = styleLoaders.map (e) ->\n      test: e.test\n      loader: ExtractTextPlugin.extract(e.loaders.slice(1).join('!'))\n\n## Configuration\n\n    module.exports =\n\nList of bundle entry points, i.e. packages to compile in the distribution. See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#entry).\n\n      entry:\n        main             : \".\/src\/scripts\/main.litcoffee\"\n        \"styles\"         : \".\/src\/styles\/styles.scss\"\n        \"vendor\/es5-shim\": \".\/bower_components\/es5-shim\/es5-shim.js\"\n        \"vendor\/es5-sham\": \".\/bower_components\/es5-shim\/es5-sham.js\"\n\nSet compilation target to \"web\". See [docs](http:\/\/webpack.github.io\/docs\/configuration.html#target).\n\n      target: \"web\"\n\nSet development options by default:\n\n      debug: true\n      # We are watching in Gulp, so tell webpack not to watch\n      watch: false\n      # watchDelay: 300\n\nOutput options:\n\n      output:\n        path         : path.join(__dirname, \"dist\", \"assets\")\n        publicPath   : \"\/assets\/\"\n        filename     : \"[name].js\"\n        chunkFilename: \"[name].[id].[chunkhash].js\"\n\nLook for required files in bower and node\n\n      resolve:\n        modulesDirectories: ['bower_components', 'node_modules']\n\nDefine how modules should be loaded based on path extension:\n\n      module:\n        loaders: styleLoaders.concat [\n          { test: \/\\.gif$\/, loader: \"url?limit=10000&minetype=image\/gif\" }\n          { test: \/\\.jpg$\/, loader: \"url?limit=10000&minetype=image\/jpg\" }\n          { test: \/\\.png$\/, loader: \"url?limit=10000&minetype=image\/png\" }\n          { test: \/\\.js$\/, loader: \"jsx\" }\n          { test: \/\\.coffee$\/, loader: \"jsx!coffee\" }\n          { test: \/\\.litcoffee$\/, loader: \"jsx!coffee?literate\"}\n          # url-loader embeds DataUrls.\n          { test: \/\\.woff$\/, loader: \"url?limit=10000&minetype=application\/font-woff\" }\n          # file-loader emits files.\n          { test: \/\\.ttf$\/, loader: \"file?mimetype=application\/vnd.ms-fontobject\" }\n          { test: \/\\.eot$\/, loader: \"file?mimetype=application\/x-font-ttf\" }\n          { test: \/\\.svg$\/, loader: \"file?mimetype=image\/svg+xml\" }\n        ]\n        noParse: \/\\.min\\.js$\/\n\nDefine the plugins:\n\n      plugins: [\n\n`DefinePlugin` defines a variable that will be substituted in the assets (a la macro):\n\n        new webpack.DefinePlugin(__PRODUCTION__: JSON.stringify(false))\n\n`extractTextPlugin` (defined above) will compile CSS to a .css file, as opposed to inlining it as a string in a .js file.\n\n        extractTextPlugin\n      ]\n\n\n## Production\n\nExport a method that applies production settings (used in gulpfile):\n\n      useProductionSettings: ->\n\nProduction plugins:\n\n        plugins = @plugins.concat [\n\nMinify JavaScript with UglifyJS:\n\n          new webpack.optimize.UglifyJsPlugin()\n        ]\n\nSet `__PRODUCTION__` to true in DefinePlugin:\n\n        for plugin in plugins when plugin.definitions?.__PRODUCTION__\n          plugin.definitions.__PRODUCTION__ = JSON.stringify(true)\n\nTell `ExtractTextPlugin` to append hashes (BROKEN, see [plugin issue #9](https:\/\/github.com\/webpack\/extract-text-webpack-plugin\/issues\/9)):\n\n        for plugin in plugins when plugin.filename == '[name].css'\n          plugin.filename = '[name]-[hash].css'\n\nMerge in production config (deep merge):\n\n        _.merge @,\n\nDisable development settings:\n\n          debug: false\n          watch: false\n          devtool: null\n\nAdd content hashes to the output filenames:\n\n          output:\n            filename: \"[name]-[hash].js\"\n\nProduction-only plugins:\n\n          plugins: plugins\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b6e28ed8d7e2c197b15609b8cf3cdb86392dc804","subject":"minor documentation update on restjson","message":"minor documentation update on restjson\n","repos":"opnfv\/yangforge,LiuJinliang\/yangforge,saintkepha\/yangforge,corenova\/yang-forge,saintkepha\/yangjs","old_file":"src\/features\/restjson.litcoffee","new_file":"src\/features\/restjson.litcoffee","new_contents":"# REST\/JSON interface feature module\n\nThis feature add-on module enables dynamic REST\/JSON interface\ngeneration based on available runtime `module` instances.\n\nIt utilizes the underlying [express](express.litcoffee) feature add-on\nto dynamically create routing middleware and associates various HTTP\nmethod facilities according to the available runtime `module`\ninstances.\n\n## Source Code\n\n    Forge = require '..\/yangforge'\n    module.exports = Forge.Interface\n      name: 'restjson'\n      description: 'REST\/JSON web services interface generator'\n      needs: [ 'express' ]\n      generator: (app) ->\n        console.log \"generating REST\/JSON interface...\"\n        router = (require 'express').Router()\n        router.all '*', (req, res, next) =>\n          req.forge = this\n          next()\n\n**Top-level REST\/JSON routing facilities**\n* Every request will be processed for authorization\n* OPTIONS - provides info on available modules and other associated metadata\n\n        router.route '\/'\n        .all (req, res, next) ->\n          # XXX - verify req.user has permissions to operate on the forgery\n          next()\n        .options (req, res, next) ->\n          res.locals.result =\n            metadata: req.forge.constructor.info()\n            modules: (for module in (req.forge.get 'modules')\n              metadata: module.constructor.info()\n              rpc: (for name, rpc of (module.meta 'rpc')\n                name: name\n                description: rpc.get 'description'\n              ).reduce ((a,b) -> a[b.name] = b.description; a), {}\n            ).reduce ((a,b) -> a[b.metadata.name] = b; a), {}\n          next()\n        .get  (req, res, next) -> res.locals.result = req.forge.serialize(); next()\n        .post (req, res, next) ->\n          # XXX - Enable creation of a new module into the target forge endpoint\n          next()\n        .copy (req, res, next) ->\n          # XXX - generate JSON serialized copy of this forge\n          next()\n\n        router.param 'module', (req,res,next,module) ->\n          self = req.forge.access module\n          unless (self?.meta 'yang') is 'module' then next 'route'\n          else req.module = self; next()\n\n        router.param 'method', (req,res,next,method) ->\n          console.assert req.module?,\n            \"cannot perform '#{method}' without containing module\"\n          req.rpc = req.module.meta \"rpc.#{method}\"\n          if req.rpc? then next() else next 'route'\n\n        router.param 'container', (req,res,next,container) ->\n          self = req.module.access container\n          unless (self?.meta 'yang') is 'container' then next 'route'\n          else req.container = self; next()\n\n**\/:module routing endpoint**\n\n        router.route '\/:module'\n        .all (req, res, next) ->\n          # XXX - verify req.user has permissions to operate on this module\n          next()\n        .options (req, res, next) ->\n          res.locals.result =\n            metadata: req.module.constructor.info()\n            rpc: (for name, rpc of (req.module.meta 'rpc')\n              name: name\n              description: rpc.get 'description'\n            ).reduce ((a,b) -> a[b.name] = b.description; a), {}\n          next()\n        .get (req, res, next) -> res.locals.result = req.module.serialize(); next()\n\n**\/:module\/:method routing endpoint**\n\n        router.route '\/:module\/:method'\n        .all (req, res, next) -> next()\n        .options (req, res, next) ->\n          res.locals.result =\n            metadata: req.rpc.extract 'name', 'description', 'status'\n            input:  req.rpc.reduce().input?.meta\n            output: req.rpc.reduce().output?.meta\n          next()\n        .post (req, res, next) ->\n          console.info \"restjson: invoking rpc method '#{req.rpc.get 'name'}'\".grey\n          action = new req.rpc input: req.body, req.module\n          action.invoke req.query\n          .then  (result) -> res.locals.result = (action.get 'output'); next()\n          .catch (err) ->\n            console.error err\n            next error\n\n**\/:module\/* configuration tree routing endpoint**\n\n        subrouter = (require 'express').Router()\n        subrouter.param 'subcontainer', (req,res,next,subcontainer) ->\n          self = req.container?.access subcontainer\n          req.container = self; next()\n\n        subrouter.route '\/'\n        .get (req, res, next) -> res.locals.result = req.container.serialize(); next()\n\n        # nested sub-routes for containers\n        subrouter.use '\/:subcontainer', subrouter\n\n        router.use '\/:module\/:container', subrouter\n\n**Default routing middleware handlers**\n\n        # always send back contents of 'result' if available\n        router.use (req, res, next) ->\n          unless res.locals.result? then return next 'route'\n          res.setHeader 'Expires','-1'\n          res.send res.locals.result\n          next()\n\n        # default log successful transaction\n        router.use (req, res, next) ->\n          console.log \"METHOD results...\"\n          #req.forge.log?.info query:req.params.id,result:res.locals.result, 'METHOD results for %s', req.record?.name\n          next()\n\n        # default 'catch-all' error handler\n        router.use (err, req, res, next) ->\n          console.error err\n          res.status(500).send error: JSON.stringify err\n\n        # TODO open up a socket.io connection stream for store updates\n\n        console.info \"restjson: binding forgery to \/restjson\".grey\n        # should attach bp.json strict: true here\n        # app.use bp.json string: true\n        app.use \"\/restjson\", router\n        return router\n","old_contents":"# REST\/JSON interface feature module\n\nThis feature add-on module enables dynamic REST\/JSON interface\ngeneration based on available runtime `module` instances.\n\nIt utilizes the underlying [express](express.litcoffee) feature add-on\nto dynamically create routing middleware and associates various HTTP\nmethod facilities according to the available runtime `module`\ninstances.\n\n## Source Code\n\n    Forge = require '..\/yangforge'\n    module.exports = Forge.Interface\n      name: 'restjson'\n      description: 'REST\/JSON web services interface generator'\n      needs: [ 'express' ]\n      generator: (app) ->\n        console.log \"generating REST\/JSON interface...\"\n        router = (require 'express').Router()\n        router.all '*', (req, res, next) =>\n          req.forge = this\n          next()\n\n### Top-level REST\/JSON routing facilities\n\n* Every request will be processed for authorization\n* OPTIONS - provides info on available modules and other associated metadata\n\n        router.route '\/'\n        .all (req, res, next) ->\n          # XXX - verify req.user has permissions to operate on the forgery\n          next()\n        .options (req, res, next) ->\n          res.locals.result =\n            metadata: req.forge.constructor.info()\n            modules: (for module in (req.forge.get 'modules')\n              metadata: module.constructor.info()\n              rpc: (for name, rpc of (module.meta 'rpc')\n                name: name\n                description: rpc.get 'description'\n              ).reduce ((a,b) -> a[b.name] = b.description; a), {}\n            ).reduce ((a,b) -> a[b.metadata.name] = b; a), {}\n          next()\n        .get  (req, res, next) -> res.locals.result = req.forge.serialize(); next()\n        .post (req, res, next) ->\n          # XXX - Enable creation of a new module into the target forge endpoint\n          next()\n        .copy (req, res, next) ->\n          # XXX - generate JSON serialized copy of this forge\n          next()\n\n        router.param 'module', (req,res,next,module) ->\n          self = req.forge.access module\n          unless (self?.meta 'yang') is 'module' then next 'route'\n          else req.module = self; next()\n\n        router.param 'method', (req,res,next,method) ->\n          console.assert req.module?,\n            \"cannot perform '#{method}' without containing module\"\n          req.rpc = req.module.meta \"rpc.#{method}\"\n          if req.rpc? then next() else next 'route'\n\n        router.param 'container', (req,res,next,container) ->\n          self = req.module.access container\n          unless (self?.meta 'yang') is 'container' then next 'route'\n          else req.container = self; next()\n\n### \/:module routing endpoint\n\n        router.route '\/:module'\n        .all (req, res, next) ->\n          # XXX - verify req.user has permissions to operate on this module\n          next()\n        .options (req, res, next) ->\n          res.locals.result =\n            metadata: req.module.constructor.info()\n            rpc: (for name, rpc of (req.module.meta 'rpc')\n              name: name\n              description: rpc.get 'description'\n            ).reduce ((a,b) -> a[b.name] = b.description; a), {}\n          next()\n        .get (req, res, next) -> res.locals.result = req.module.serialize(); next()\n\n### \/:module\/:method routing endpoint\n\n        router.route '\/:module\/:method'\n        .all (req, res, next) -> next()\n        .options (req, res, next) ->\n          res.locals.result =\n            metadata: req.rpc.extract 'name', 'description', 'status'\n            input:  req.rpc.reduce().input?.meta\n            output: req.rpc.reduce().output?.meta\n          next()\n        .post (req, res, next) ->\n          console.info \"restjson: invoking rpc method '#{req.rpc.get 'name'}'\".grey\n          action = new req.rpc input: req.body, req.module\n          action.invoke req.query\n          .then  (result) -> res.locals.result = (action.get 'output'); next()\n          .catch (err) ->\n            console.error err\n            next error\n\n### \/:module\/* configuration tree routing endpoint\n\n        subrouter = (require 'express').Router()\n        subrouter.param 'subcontainer', (req,res,next,subcontainer) ->\n          self = req.container?.access subcontainer\n          req.container = self; next()\n\n        subrouter.route '\/'\n        .get (req, res, next) -> res.locals.result = req.container.serialize(); next()\n\n        # nested sub-routes for containers\n        subrouter.use '\/:subcontainer', subrouter\n\n        router.use '\/:module\/:container', subrouter\n\n### Default routing middleware handlers \n\n        # always send back contents of 'result' if available\n        router.use (req, res, next) ->\n          unless res.locals.result? then return next 'route'\n          res.setHeader 'Expires','-1'\n          res.send res.locals.result\n          next()\n\n        # default log successful transaction\n        router.use (req, res, next) ->\n          console.log \"METHOD results...\"\n          #req.forge.log?.info query:req.params.id,result:res.locals.result, 'METHOD results for %s', req.record?.name\n          next()\n\n        # default 'catch-all' error handler\n        router.use (err, req, res, next) ->\n          console.error err\n          res.status(500).send error: JSON.stringify err\n\n        # TODO open up a socket.io connection stream for store updates\n\n        console.info \"restjson: binding forgery to \/restjson\".grey\n        # should attach bp.json strict: true here\n        # app.use bp.json string: true\n        app.use \"\/restjson\", router\n        return router\n","returncode":0,"stderr":"","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"5dc53792f5bd69fdc569a0c1d80f9520a4bf18a5","subject":"Add prebeta multi-lane axis formatting.","message":"Add prebeta multi-lane axis formatting.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"","old_contents":"","returncode":0,"stderr":"unknown","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"259184e66e3d5aac8c7c9b70906ec6feb8fbb23b","subject":"fix #94, skip 'source' property of Element from being categorized as sub-elements","message":"fix #94, skip 'source' property of Element from being categorized as sub-elements\n","repos":"corenova\/yang-js","old_file":"src\/element.litcoffee","new_file":"src\/element.litcoffee","new_contents":"# Element - cascading element tree\n\n## Class Element\n\n    debug = require('debug')('yang:element')\n    delegate = require 'delegates'\n    Emitter = require('events').EventEmitter\n    Emitter.defaultMaxListeners = 100\n    \n    class Element\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n      @use: ->\n        res = [].concat(arguments...)\n          .filter (x) -> x?\n          .map (elem) =>\n            exists = Element::match.call this, elem.kind, elem.tag\n            if exists?\n              debug \"use: using previously loaded '#{elem.kind}:#{elem.tag}'\"\n              return exists\n            try Element::merge.call this, elem\n            catch e\n              throw @error \"use: unable to merge '#{elem.kind}:#{elem.tag}'\", e\n        return switch \n          when res.length > 1  then res\n          when res.length is 1 then res[0]\n          else undefined\n      @debug: -> debug @uri, arguments...\n      @error: (err, ctx=this) ->\n        unless err instanceof Error\n          err = new Error err\n        err.uri = @uri\n        err.src = this\n        err.ctx = ctx\n        return err\n\n      constructor: (@kind, @tag, source={}) ->\n        unless @kind?\n          throw @error \"must supply 'kind' to create a new Element\"\n        unless source instanceof Object\n          throw @error \"must supply 'source' as an object\"\n        Object.defineProperties this,\n          parent: value: null, writable: true\n          origin: value: null, writable: true\n          source: value: source, writable: true\n          index:  value: 0, writable: true\n          state:  value: {}, writable: true\n          emitter: value: new Emitter\n\n      error: @error\n      debug: @debug\n\n      delegate @prototype, 'emitter'\n        .method 'emit'\n        .method 'once'\n        .method 'on'\n\n      delegate @prototype, 'source'\n        .getter 'scope'\n        .getter 'construct'\n\n      delegate @prototype, 'cache'\n        .getter 'elements'\n        .getter 'nodes'\n        .getter 'attrs'\n\n### Computed Properties\n\n      @property 'datakey',\n        get: -> @tag ? @kind\n\n      @property 'uri',\n        get: ->\n          mark = @kind\n          mark += \"(#{@tag})\" if @tag? and @source.argument not in [ 'value', 'text' ]\n          return mark unless @parent instanceof Element\n          return \"#{@parent.uri}\/#{mark}\"\n\n      @property 'root',\n        get: -> switch\n          when @parent instanceof Element then @parent.root\n          when @origin instanceof Element then @origin.root\n          else this\n\n      @property 'node',\n        get: -> @construct instanceof Function\n\n      @property 'cache',\n        get: ->\n          unless this._cache?\n            elements = (v for own k, v of this when k not in [ 'parent', 'origin', 'tag', '_cache', 'source' ])\n              .reduce ((a,b) -> switch\n                when b instanceof Element then a.concat b\n                when b instanceof Array\n                  a.concat b.filter (x) -> x instanceof Element\n                else a\n              ), []\n            elements = elements.sort (a,b) -> a.index - b.index\n            this._cache =\n              elements: elements\n              nodes: elements.filter (x) -> x.node is true\n              attrs: elements.filter (x) -> x.node is false\n          return this._cache\n\n      @property '*',     get: -> @nodes\n      @property '..',    get: -> @parent\n\n## Instance-level methods\n\n### clone\n\n      clone: (relative=false) ->\n        @debug \"cloning #{@kind}:#{@tag} with #{@elements.length} elements\"\n        copy = (new @constructor @kind, @tag, @source).extends @elements.map (x) =>\n          c = x.clone(relative)\n          c.parent = x.parent unless x.parent is this\n          return c\n        copy.state = Object.create(@state)\n        copy.state.relative = relative\n        copy.origin = @origin ? this\n        return copy\n\n### extends (elements...)\n\nThis is the primary mechanism for defining sub-elements to become part\nof the element tree\n\n      extends: ->\n        elems = ([].concat arguments...).filter (x) -> x? and !!x\n        return this unless elems.length > 0\n        elems.forEach (expr) => @merge expr\n        @emit 'change', elems...\n        return this\n\n### merge (element)\n\nThis helper method merges a specific Element into current Element\nwhile performing `@scope` validations.\n\n      merge: (elem, opts={}) ->\n        unless elem instanceof Element\n          throw @error \"cannot merge invalid element into Element\", elem\n        elem.index = @elements.length if @elements?\n        elem.parent = this\n        this._cache = null \n\n        _merge = (item) ->\n          if not item.node or opts.append or item.datakey not in (@keys ? [])\n            @push item\n            true\n          else if opts.replace is true\n            for x, i in this when x.datakey is item.datakey\n              @splice i, 1, item\n              break\n            true\n          else false\n\n        unless @scope?\n          unless @hasOwnProperty elem.kind\n            @[elem.kind] = elem\n            return elem\n\n          unless Array.isArray @[elem.kind]\n            exists = @[elem.kind]\n            @[elem.kind] = [ exists ]\n            Object.defineProperty @[elem.kind], 'keys',\n              get: (-> @map (x) -> x.datakey ).bind @[elem.kind]\n              \n          unless _merge.call @[elem.kind], elem\n            throw @error \"constraint violation for '#{elem.kind} #{elem.datakey}' - cannot define more than once\"\n\n          return elem\n\n        unless elem.kind of @scope\n          if elem.scope?\n            @debug @scope\n            throw @error \"scope violation - invalid '#{elem.kind}' extension found\"\n          else\n            @scope[elem.kind] = '*' # this is hackish...\n\n        switch @scope[elem.kind]\n          when '0..n', '1..n', '*'\n            unless @hasOwnProperty elem.kind\n              @[elem.kind] = []\n              Object.defineProperty @[elem.kind], 'keys',\n                get: (-> @map (x) -> x.datakey ).bind @[elem.kind]\n            unless _merge.call @[elem.kind], elem\n              throw @error \"constraint violation for '#{elem.kind} #{elem.datakey}' - already defined\"\n          when '0..1', '1'\n            unless @hasOwnProperty elem.kind\n              @[elem.kind] = elem\n            else if opts.replace is true\n              @debug \"replacing pre-existing #{elem.kind}\"\n              @[elem.kind] = elem\n            else\n              throw @error \"constraint violation for '#{elem.kind}' - cannot define more than once\"\n          else\n            throw @error \"unrecognized scope constraint defined for '#{elem.kind}' with #{@scope[elem.kind]}\"\n\n        return elem\n\n      removes: ->\n        elems = ([].concat arguments...).filter (x) -> x? and !!x\n        return this unless elems.length > 0\n        elems.forEach (expr) => @remove expr\n        @emit 'change', elems...\n        return this\n\n      remove: (elem) ->\n        unless elem instanceof Element\n          throw @error \"cannot remove a non-Element from an Element\", elem\n\n        exists = Element::match.call this, elem.kind, elem.datakey\n        return this unless exists?\n\n        if Array.isArray @[elem.kind]\n          @[elem.kind] = @[elem.kind].filter (x) -> x.datakey isnt elem.datakey\n          delete @[elem.kind] unless @[elem.kind].length\n        else\n          delete @[elem.kind]\n\n        this._cache = null\n        return this\n\n### update (element)\n\nThis alternative form of [merge](#merge-element) performs conditional\nmerge based on existence check. It is considered *safer* alternative\nto direct [merge](#merge-element) call.\n\n      # performs conditional merge based on existence\n      update: (elem) ->\n        unless elem instanceof Element\n          throw @error \"cannot update a non-Element into an Element\", elem\n\n        #@debug \"update with #{elem.kind}\/#{elem.tag}\"\n        exists = switch\n          when elem.tag? then Element::match.call this, elem.kind, elem.datakey\n          else Element::match.call this, elem.kind\n        return @merge elem unless exists?\n\n        #@debug \"update #{exists.kind} in-place for #{elem.elements.length} elements\"\n        exists.update target for target in elem.elements\n        return exists\n\n      # Looks for matching Elements using kind and tag\n      # Direction: up the hierarchy (towards root)\n      lookup: (kind, tag) ->\n        res = switch\n          when this not instanceof Object then undefined\n          when this instanceof Element then @match kind, tag\n          else Element::match.call this, kind, tag\n        res ?= switch\n          when @origin? then Element::lookup.apply @origin, arguments\n          when @parent? then Element::lookup.apply @parent, arguments\n          else Element::match.call @constructor, kind, tag\n        return res\n\n      # Looks for matching Elements using YPATH notation\n      # Direction: down the hierarchy (away from root)\n      at: -> @locate arguments...\n      locate: (ypath) ->\n        return unless ypath?\n        if typeof ypath is 'string'\n          @debug \"locate: #{ypath}\"\n          ypath = ypath.replace \/\\s\/g, ''\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = ypath.split('\/').filter (e) -> !!e\n        else\n          @debug \"locate: #{ypath.join('\/')}\"\n          [ key, rest... ] = ypath\n        return this unless key?\n\n        match = switch\n          when key is '..' then @match key\n          else @match '*', key\n\n        return switch\n          when rest.length is 0 then match\n          else match?.locate rest\n\n      # Looks for a matching Element(s) in immediate sub-elements\n      match: (kind, tag) ->\n        return unless kind? and @[kind]?\n        return @[kind] unless tag?\n\n        match = @[kind]\n        match = [ match ] unless match instanceof Array\n        return match if tag is '*'\n\n        for elem in match when elem instanceof Element\n          return elem if tag is elem.datakey or tag is elem.tag\n        return undefined\n\n### toJSON\n\nConverts the Element into a JS object\n\n      toJSON: (opts={ tag: true, extended: false }) ->\n        #@debug \"converting #{@kind} toJSON with #{@elements.length}\"\n        sub =\n          @elements\n            .filter (x) => opts.extended or x.parent is this\n            .reduce ((a,b) ->\n              for k, v of b.toJSON()\n                if a[k] instanceof Object\n                  a[k][kk] = vv for kk, vv of v if v instanceof Object\n                else\n                  a[k] = v\n              return a\n            ), {}\n        if opts.tag\n          \"#{@kind}\": switch\n            when Object.keys(sub).length > 0\n              if @tag? then \"#{@tag}\": sub else sub\n            when @tag instanceof Object then \"#{@tag}\"\n            else @tag\n        else sub\n\n## Export Element Class\n\n    module.exports = Element\n","old_contents":"# Element - cascading element tree\n\n## Class Element\n\n    debug = require('debug')('yang:element')\n    delegate = require 'delegates'\n    Emitter = require('events').EventEmitter\n    Emitter.defaultMaxListeners = 100\n    \n    class Element\n      @property: (prop, desc) ->\n        Object.defineProperty @prototype, prop, desc\n      @use: ->\n        res = [].concat(arguments...)\n          .filter (x) -> x?\n          .map (elem) =>\n            exists = Element::match.call this, elem.kind, elem.tag\n            if exists?\n              debug \"use: using previously loaded '#{elem.kind}:#{elem.tag}'\"\n              return exists\n            try Element::merge.call this, elem\n            catch e\n              throw @error \"use: unable to merge '#{elem.kind}:#{elem.tag}'\", e\n        return switch \n          when res.length > 1  then res\n          when res.length is 1 then res[0]\n          else undefined\n      @debug: -> debug @uri, arguments...\n      @error: (err, ctx=this) ->\n        unless err instanceof Error\n          err = new Error err\n        err.uri = @uri\n        err.src = this\n        err.ctx = ctx\n        return err\n\n      constructor: (@kind, @tag, source={}) ->\n        unless @kind?\n          throw @error \"must supply 'kind' to create a new Element\"\n        unless source instanceof Object\n          throw @error \"must supply 'source' as an object\"\n        Object.defineProperties this,\n          parent: value: null, writable: true\n          origin: value: null, writable: true\n          source: value: source, writable: true\n          index:  value: 0, writable: true\n          state:  value: {}, writable: true\n          emitter: value: new Emitter\n\n      error: @error\n      debug: @debug\n\n      delegate @prototype, 'emitter'\n        .method 'emit'\n        .method 'once'\n        .method 'on'\n\n      delegate @prototype, 'source'\n        .getter 'scope'\n        .getter 'construct'\n\n      delegate @prototype, 'cache'\n        .getter 'elements'\n        .getter 'nodes'\n        .getter 'attrs'\n\n### Computed Properties\n\n      @property 'datakey',\n        get: -> @tag ? @kind\n\n      @property 'uri',\n        get: ->\n          mark = @kind\n          mark += \"(#{@tag})\" if @tag? and @source.argument not in [ 'value', 'text' ]\n          return mark unless @parent instanceof Element\n          return \"#{@parent.uri}\/#{mark}\"\n\n      @property 'root',\n        get: -> switch\n          when @parent instanceof Element then @parent.root\n          when @origin instanceof Element then @origin.root\n          else this\n\n      @property 'node',\n        get: -> @construct instanceof Function\n\n      @property 'cache',\n        get: ->\n          unless this._cache?\n            elements = (v for own k, v of this when k not in [ 'parent', 'origin', 'tag', '_cache' ])\n              .reduce ((a,b) -> switch\n                when b instanceof Element then a.concat b\n                when b instanceof Array\n                  a.concat b.filter (x) -> x instanceof Element\n                else a\n              ), []\n            elements = elements.sort (a,b) -> a.index - b.index\n            this._cache =\n              elements: elements\n              nodes: elements.filter (x) -> x.node is true\n              attrs: elements.filter (x) -> x.node is false\n          return this._cache\n\n      @property '*',     get: -> @nodes\n      @property '..',    get: -> @parent\n\n## Instance-level methods\n\n### clone\n\n      clone: (relative=false) ->\n        @debug \"cloning #{@kind}:#{@tag} with #{@elements.length} elements\"\n        copy = (new @constructor @kind, @tag, @source).extends @elements.map (x) =>\n          c = x.clone(relative)\n          c.parent = x.parent unless x.parent is this\n          return c\n        copy.state = Object.create(@state)\n        copy.state.relative = relative\n        copy.origin = @origin ? this\n        return copy\n\n### extends (elements...)\n\nThis is the primary mechanism for defining sub-elements to become part\nof the element tree\n\n      extends: ->\n        elems = ([].concat arguments...).filter (x) -> x? and !!x\n        return this unless elems.length > 0\n        elems.forEach (expr) => @merge expr\n        @emit 'change', elems...\n        return this\n\n### merge (element)\n\nThis helper method merges a specific Element into current Element\nwhile performing `@scope` validations.\n\n      merge: (elem, opts={}) ->\n        unless elem instanceof Element\n          throw @error \"cannot merge invalid element into Element\", elem\n        elem.index = @elements.length if @elements?\n        elem.parent = this\n        this._cache = null \n\n        _merge = (item) ->\n          if not item.node or opts.append or item.datakey not in (@keys ? [])\n            @push item\n            true\n          else if opts.replace is true\n            for x, i in this when x.datakey is item.datakey\n              @splice i, 1, item\n              break\n            true\n          else false\n\n        unless @scope?\n          unless @hasOwnProperty elem.kind\n            @[elem.kind] = elem\n            return elem\n\n          unless Array.isArray @[elem.kind]\n            exists = @[elem.kind]\n            @[elem.kind] = [ exists ]\n            Object.defineProperty @[elem.kind], 'keys',\n              get: (-> @map (x) -> x.datakey ).bind @[elem.kind]\n              \n          unless _merge.call @[elem.kind], elem\n            throw @error \"constraint violation for '#{elem.kind} #{elem.datakey}' - cannot define more than once\"\n\n          return elem\n\n        unless elem.kind of @scope\n          if elem.scope?\n            @debug @scope\n            throw @error \"scope violation - invalid '#{elem.kind}' extension found\"\n          else\n            @scope[elem.kind] = '*' # this is hackish...\n\n        switch @scope[elem.kind]\n          when '0..n', '1..n', '*'\n            unless @hasOwnProperty elem.kind\n              @[elem.kind] = []\n              Object.defineProperty @[elem.kind], 'keys',\n                get: (-> @map (x) -> x.datakey ).bind @[elem.kind]\n            unless _merge.call @[elem.kind], elem\n              throw @error \"constraint violation for '#{elem.kind} #{elem.datakey}' - already defined\"\n          when '0..1', '1'\n            unless @hasOwnProperty elem.kind\n              @[elem.kind] = elem\n            else if opts.replace is true\n              @debug \"replacing pre-existing #{elem.kind}\"\n              @[elem.kind] = elem\n            else\n              throw @error \"constraint violation for '#{elem.kind}' - cannot define more than once\"\n          else\n            throw @error \"unrecognized scope constraint defined for '#{elem.kind}' with #{@scope[elem.kind]}\"\n\n        return elem\n\n      removes: ->\n        elems = ([].concat arguments...).filter (x) -> x? and !!x\n        return this unless elems.length > 0\n        elems.forEach (expr) => @remove expr\n        @emit 'change', elems...\n        return this\n\n      remove: (elem) ->\n        unless elem instanceof Element\n          throw @error \"cannot remove a non-Element from an Element\", elem\n\n        exists = Element::match.call this, elem.kind, elem.datakey\n        return this unless exists?\n\n        if Array.isArray @[elem.kind]\n          @[elem.kind] = @[elem.kind].filter (x) -> x.datakey isnt elem.datakey\n          delete @[elem.kind] unless @[elem.kind].length\n        else\n          delete @[elem.kind]\n\n        this._cache = null\n        return this\n\n### update (element)\n\nThis alternative form of [merge](#merge-element) performs conditional\nmerge based on existence check. It is considered *safer* alternative\nto direct [merge](#merge-element) call.\n\n      # performs conditional merge based on existence\n      update: (elem) ->\n        unless elem instanceof Element\n          throw @error \"cannot update a non-Element into an Element\", elem\n\n        #@debug \"update with #{elem.kind}\/#{elem.tag}\"\n        exists = switch\n          when elem.tag? then Element::match.call this, elem.kind, elem.datakey\n          else Element::match.call this, elem.kind\n        return @merge elem unless exists?\n\n        #@debug \"update #{exists.kind} in-place for #{elem.elements.length} elements\"\n        exists.update target for target in elem.elements\n        return exists\n\n      # Looks for matching Elements using kind and tag\n      # Direction: up the hierarchy (towards root)\n      lookup: (kind, tag) ->\n        res = switch\n          when this not instanceof Object then undefined\n          when this instanceof Element then @match kind, tag\n          else Element::match.call this, kind, tag\n        res ?= switch\n          when @origin? then Element::lookup.apply @origin, arguments\n          when @parent? then Element::lookup.apply @parent, arguments\n          else Element::match.call @constructor, kind, tag\n        return res\n\n      # Looks for matching Elements using YPATH notation\n      # Direction: down the hierarchy (away from root)\n      at: -> @locate arguments...\n      locate: (ypath) ->\n        return unless ypath?\n        if typeof ypath is 'string'\n          @debug \"locate: #{ypath}\"\n          ypath = ypath.replace \/\\s\/g, ''\n          if (\/^\\\/\/.test ypath) and this isnt @root\n            return @root.locate ypath\n          [ key, rest... ] = ypath.split('\/').filter (e) -> !!e\n        else\n          @debug \"locate: #{ypath.join('\/')}\"\n          [ key, rest... ] = ypath\n        return this unless key?\n\n        match = switch\n          when key is '..' then @match key\n          else @match '*', key\n\n        return switch\n          when rest.length is 0 then match\n          else match?.locate rest\n\n      # Looks for a matching Element(s) in immediate sub-elements\n      match: (kind, tag) ->\n        return unless kind? and @[kind]?\n        return @[kind] unless tag?\n\n        match = @[kind]\n        match = [ match ] unless match instanceof Array\n        return match if tag is '*'\n\n        for elem in match when elem instanceof Element\n          return elem if tag is elem.datakey or tag is elem.tag\n        return undefined\n\n### toJSON\n\nConverts the Element into a JS object\n\n      toJSON: (opts={ tag: true, extended: false }) ->\n        #@debug \"converting #{@kind} toJSON with #{@elements.length}\"\n        sub =\n          @elements\n            .filter (x) => opts.extended or x.parent is this\n            .reduce ((a,b) ->\n              for k, v of b.toJSON()\n                if a[k] instanceof Object\n                  a[k][kk] = vv for kk, vv of v if v instanceof Object\n                else\n                  a[k] = v\n              return a\n            ), {}\n        if opts.tag\n          \"#{@kind}\": switch\n            when Object.keys(sub).length > 0\n              if @tag? then \"#{@tag}\": sub else sub\n            when @tag instanceof Object then \"#{@tag}\"\n            else @tag\n        else sub\n\n## Export Element Class\n\n    module.exports = Element\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"8e326be960d2e357420c26a015114bc6d1f0b1cb","subject":"add `state.bind` and `state.fix`","message":"add `state.bind` and `state.fix`\n\nPortends deprecation of `state.method`.\n","repos":"nickfargo\/restate","old_file":"src\/state-function.litcoffee","new_file":"src\/state-function.litcoffee","new_contents":"## [state()](#state-function)\n\n> [`state()`](\/api\/#state-function)\n> [The `state` function](\/docs\/#getting-started--the-state-function)\n\nThe `state` module is exported as a function. Invoking this function is the\nprimary point of entry into the module. It is used either to:\n\n1. generate a formal `StateExpression`; or\n\n2. bestow an arbitrary `owner` object with a state implementation, based on the\n   application of the provided `expression` to a new `RootState` \u2014 and then\n   return the owner\u2019s initial `State`.\n\nAll arguments are optional. If only one `object`-typed argument is provided,\nit is assigned to the `expression` parameter. If no `owner` is present,\n`state()` returns a `StateExpression` based on the contents of `expression`\n(and `attributes`). If both an `owner` and `expression` are present, `state`\nacts in the second capacity, causing `owner` to become stateful.\n\nThe `attributes` argument may include any of the words defined in\n`STATE_ATTRIBUTE_MODIFIERS`, which are encoded into the provided `expression`.\n\n> See also:\n> [`State`][],\n> [`STATE_ATTRIBUTES`][],\n> [`StateExpression`][]\n\n    state = ( owner, attributes, expression, options ) ->\n      if arguments.length < 2\n        if typeof owner is 'string'\n        then attributes = owner\n        else expression = owner\n        owner = undefined\n      else\n        if typeof owner is 'string'\n          options = expression\n          expression = attributes\n          attributes = owner\n          owner = undefined\n        if typeof attributes isnt 'string'\n          options = expression\n          expression = attributes\n          attributes = undefined\n\nFormalize the provided `expression` (even if `expression` is already a formal\n`StateExpression`), incorporating any provided `attributes`.\n\n      expression = new StateExpression attributes, expression\n\nWith an `owner` present, the inferred intent is to *implement* `expression`\ninto `owner`; otherwise the inference is only to *formalize* the `expression`\nas a `StateExpression`.\n\n      if owner\n      then ( new RootState owner, expression, options )._current\n      else expression\n\n\n\n### Accessory properties\n\n\n#### Metadata\n\nMix the project\u2019s `meta` properties into the exported `state` function.\n\n    O.assign state, meta\n\n\n\n### Utility functions\n\n\n#### [state.bind](#state-function--bind)\n\nUsed inside a state expression, a function `fn` wrapped with `state.bind` will\nbind the context of `fn` either to any `State` created from that expression, or\nwhen invoked for an object that inherits from the `owner` of the bound `State`,\nto the corresponding **epistate** of that `State`.\n\nThusly bound methods, event listeners, etc., whose context would have normally\nbeen the `owner`, still retain a reference thereto via `this.owner`.\n\n* `fn` : ( any\u2026 ) \u2192 any\n\n    state.bind = ( fn ) -> { type: 'state-bound-function', fn }\n\n\n#### [state.fix](#state-function--fix)\n\nUsed inside a state expression, a combinator `fn` wrapped with `state.fix` will\nbe partially applied with a reference to `autostate`, the precise `State` to\nwhich the combinator\u2019s returned function will belong, and a reference to\n`protostate`, the immediate **protostate** of `autostate`.\n\nA method, event listener, etc. that is `fix`ed thusly has access to, and full\nlexical awareness of, the particular `State` environment in which it exists.\n\n* `fn` : ( autostate, protostate ) \u2192 ( any\u2026 ) \u2192 any\n\n    state.fix = ( fn ) -> { type: 'state-fixed-function', fn }\n\n\n#### [state.method](#state-function--method)\n\n> Deprecate me\n\nReturns a `factory`, nominally for internal use, which will flatten the scope\nof the provided `fn`, reclose it both over any provided `bindings` and over a\nset of `lexicals` based on `autostate`, which is provided to `factory` as the\n`State` instance that will contain the **lexical state methods** that `factory`\nproduces.\n\nWrapping method functions with `state.method` inside a state expression is\nuseful particularly for exposing to the method body a correct reference to the\n**protostate**, while also ensuring that the method is fully heritable by both\n**substates** and **epistates** (inheritors of a protostate).\n\n> [Lexical binding in state methods][]\n\n> [`state.method`](\/api\/#state-function--method)\n\n    state.method = do ->\n      lexicals = ['__State__', 'autostate', 'protostate']\n\n      pattern = \/\/\/^\n        ( function\n            \\s*\n          (?:[$_A-Za-z][$\\w]*)?\n            \\s*\n          \\((?:[\\s\\S]*?)\\)\n            \\s*\n          \\{\n        )\n        (\\s\\S]*)\n      \/\/\/\n\n      template = \"\"\"\n        return $1\n          var superstate, owner;\n          if ( this instanceof __State__ ) {\n            superstate = this.superstate;\n            owner = this.owner;\n          }\n        $2;\n      \"\"\"\n\n      createMethod = ( factory, autostate, bindings, fn ) ->\n\nGather all the identifiers that the transformed `fn` will be closed over, and\narrange them into an array of named `params`.\n\n        identifiers = if bindings? and ( typeof bindings is 'object' or\n          typeof bindings is 'function' ) then O.keys bindings else []\n        values = ( bindings[ id ] for id in identifiers )\n        params = identifiers.concat lexicals\n\nGather all the values that will be mapped to the `params`.\n\n        args = [ State, autostate, autostate.protostate() ]\n        args = values.concat args if values.length\n\nWrite the body of the function that wraps `fn`, and inject `fn` with references\nto the superstate and owner of the context `State`.\n\n        body = Function::toString.call( fn ).replace pattern, template\n\nGenerate the wrapper function defined by `params` and `body`, and immediately\napply it with all of the closed binding values to produce the `method`.\n\n        method = Function.apply( null, params.concat body ).apply( null, args )\n\nSave the `factory` from which the method was created, so that the method can be\ncloned or exported, e.g. by calling `express`, to a separate `State`, where the\nmethod will need to be re-transformed with bindings to the environment of the\nnew state.\n\n        method.factory = factory\n\n        method.isLexicalStateMethod = true\n        method\n\n\n      return ( bindings, fn ) ->\n\n        factory = ( autostate ) ->\n\nInvocation from outside the module is forbidden, as this could expose\n`bindings`, which must remain private.\n\n          throw ReferenceError unless this is __MODULE__\n\nWith proper `bindings` and `fn` arguments, forward the invocation to\n`createMethod`.\n\n          if typeof bindings is 'object' and typeof fn is 'function'\n            createMethod factory, autostate, bindings, fn\n\nIf passed `bindings` only, return a partially applied function that accepts\n`fn` later.\n\n          else if typeof bindings is 'object' and fn is undefined\n            ( fn ) -> createMethod factory, autostate, bindings, fn\n\nIf passed only `fn` as the first argument, assume no `bindings`.\n\n          else if typeof bindings is 'function' and fn is undefined\n            createMethod factory, autostate, null, bindings\n\n        factory.isLexicalStateMethodFactory = true\n        factory\n\n\n\n### Exports\n\nThe `state` module is exported via CommonJS on the server, and globally in the\nbrowser.\n\n    if O.env.server then module.exports = exports = state\n    if O.env.client then global['state'] = state\n","old_contents":"## [state()](#state-function)\n\n> [`state()`](\/api\/#state-function)\n> [The `state` function](\/docs\/#getting-started--the-state-function)\n\nThe `state` module is exported as a function. Invoking this function is the\nprimary point of entry into the module. It is used either to:\n\n1. generate a formal `StateExpression`; or\n\n2. bestow an arbitrary `owner` object with a state implementation, based on the\n   application of the provided `expression` to a new `RootState` \u2014 and then\n   return the owner\u2019s initial `State`.\n\nAll arguments are optional. If only one `object`-typed argument is provided,\nit is assigned to the `expression` parameter. If no `owner` is present,\n`state()` returns a `StateExpression` based on the contents of `expression`\n(and `attributes`). If both an `owner` and `expression` are present, `state`\nacts in the second capacity, causing `owner` to become stateful.\n\nThe `attributes` argument may include any of the words defined in\n`STATE_ATTRIBUTE_MODIFIERS`, which are encoded into the provided `expression`.\n\n> See also:\n> [`State`][],\n> [`STATE_ATTRIBUTES`][],\n> [`StateExpression`][]\n\n    state = ( owner, attributes, expression, options ) ->\n      if arguments.length < 2\n        if typeof owner is 'string'\n        then attributes = owner\n        else expression = owner\n        owner = undefined\n      else\n        if typeof owner is 'string'\n          options = expression\n          expression = attributes\n          attributes = owner\n          owner = undefined\n        if typeof attributes isnt 'string'\n          options = expression\n          expression = attributes\n          attributes = undefined\n\nFormalize the provided `expression` (even if `expression` is already a formal\n`StateExpression`), incorporating any provided `attributes`.\n\n      expression = new StateExpression attributes, expression\n\nWith an `owner` present, the inferred intent is to *implement* `expression`\ninto `owner`; otherwise the inference is only to *formalize* the `expression`\nas a `StateExpression`.\n\n      if owner\n      then ( new RootState owner, expression, options )._current\n      else expression\n\n\n\n### Accessory properties\n\n\n#### Metadata\n\nMix the project\u2019s `meta` properties into the exported `state` function.\n\n    O.assign state, meta\n\n\n#### [state.method](#state-function--method)\n\nReturns a `factory`, nominally for internal use, which will flatten the scope\nof the provided `fn`, reclose it both over any provided `bindings` and over a\nset of `lexicals` based on `autostate`, which is provided to `factory` as the\n`State` instance that will contain the **lexical state methods** that `factory`\nproduces.\n\nWrapping method functions with `state.method` inside a state expression is\nuseful particularly for exposing to the method body a correct reference to the\n**protostate**, while also ensuring that the method is fully heritable by both\n**substates** and **epistates** (inheritors of a protostate).\n\n> [Lexical binding in state methods][]\n\n> [`state.method`](\/api\/#state-function--method)\n\n    state.method = do ->\n      lexicals = ['__State__', 'autostate', 'protostate']\n\n      pattern = \/\/\/^\n        ( function\n            \\s*\n          (?:[$_A-Za-z][$\\w]*)?\n            \\s*\n          \\((?:[\\s\\S]*?)\\)\n            \\s*\n          \\{\n        )\n        (\\s\\S]*)\n      \/\/\/\n\n      template = \"\"\"\n        return $1\n          var superstate, owner;\n          if ( this instanceof __State__ ) {\n            superstate = this.superstate;\n            owner = this.owner;\n          }\n        $2;\n      \"\"\"\n\n      createMethod = ( factory, autostate, bindings, fn ) ->\n\nGather all the identifiers that the transformed `fn` will be closed over, and\narrange them into an array of named `params`.\n\n        identifiers = if bindings? and ( typeof bindings is 'object' or\n          typeof bindings is 'function' ) then O.keys bindings else []\n        values = ( bindings[ id ] for id in identifiers )\n        params = identifiers.concat lexicals\n\nGather all the values that will be mapped to the `params`.\n\n        args = [ State, autostate, autostate.protostate() ]\n        args = values.concat args if values.length\n\nWrite the body of the function that wraps `fn`, and inject `fn` with references\nto the superstate and owner of the context `State`.\n\n        body = Function::toString.call( fn ).replace pattern, template\n\nGenerate the wrapper function defined by `params` and `body`, and immediately\napply it with all of the closed binding values to produce the `method`.\n\n        method = Function.apply( null, params.concat body ).apply( null, args )\n\nSave the `factory` from which the method was created, so that the method can be\ncloned or exported, e.g. by calling `express`, to a separate `State`, where the\nmethod will need to be re-transformed with bindings to the environment of the\nnew state.\n\n        method.factory = factory\n\n        method.isLexicalStateMethod = true\n        method\n\n\n      return ( bindings, fn ) ->\n\n        factory = ( autostate ) ->\n\nInvocation from outside the module is forbidden, as this could expose\n`bindings`, which must remain private.\n\n          throw ReferenceError unless this is __MODULE__\n\nWith proper `bindings` and `fn` arguments, forward the invocation to\n`createMethod`.\n\n          if typeof bindings is 'object' and typeof fn is 'function'\n            createMethod factory, autostate, bindings, fn\n\nIf passed `bindings` only, return a partially applied function that accepts\n`fn` later.\n\n          else if typeof bindings is 'object' and fn is undefined\n            ( fn ) -> createMethod factory, autostate, bindings, fn\n\nIf passed only `fn` as the first argument, assume no `bindings`.\n\n          else if typeof bindings is 'function' and fn is undefined\n            createMethod factory, autostate, null, bindings\n\n        factory.isLexicalStateMethodFactory = true\n        factory\n\n\n\n### Exports\n\nThe `state` module is exported via CommonJS on the server, and globally in the\nbrowser.\n\n    if O.env.server then module.exports = exports = state\n    if O.env.client then global['state'] = state\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"342fc5bdd704ccf23db07dd8e3602ebd2043bba4","subject":"Clean up \/upload routes","message":"Clean up \/upload routes\n","repos":"Turistforeningen\/Jotunheimr","old_file":"src\/server.litcoffee","new_file":"src\/server.litcoffee","new_contents":"    express      = require 'express'\n    errorHandler = require 'errorhandler'\n    morgan       = require 'morgan'\n\n    multer       = require 'multer'\n    async        = require 'async'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      return next() if not req.get 'Origin'\n\n      res.set 'Access-Control-Allow-Origin', '*'\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.post '\/upload', multer(dest: require('os').tmpdir()), (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        # @TODO check if file is valid image\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n          return cb null, images.splice(1)\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use raven.middleware.express sentry\n    app.use errorHandler dumpExceptions: true, showStack: true\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","old_contents":"    express      = require 'express'\n    errorHandler = require 'errorhandler'\n    morgan       = require 'morgan'\n\n    multer       = require 'multer'\n    async        = require 'async'\n\n    raven        = require 'raven'\n    sentry       = require '.\/sentry'\n\n    app = express()\n    app.use morgan 'combined'\n\n    Upload = require 's3-uploader'\n    s3 = new Upload process.env.AWS_BUCKET_NAME,\n      awsBucketUrl: \"https:\/\/s3-eu-west-1.amazonaws.com\/#{process.env.AWS_BUCKET_NAME}\/\"\n      awsBucketPath: process.env.AWS_BUCKET_PATH\n      awsBucketAcl: 'public-read'\n      awsHttpTimeout: 60000\n\n      versions: [{\n        original: true\n        awsImageAcl: 'private'\n      },{\n        suffix: '-large'\n        quality: 80\n        maxHeight: 1040\n        maxWidth: 1040\n      },{\n        suffix: '-medium'\n        maxHeight: 780\n        maxWidth: 780\n      },{\n        suffix: '-small'\n        maxHeight: 320\n        maxWidth: 320\n      }]\n\n    app.all '\/upload', (req, res, next) ->\n      res.once 'close', -> sentry.captureResClose res\n\n      return next() if not req.get 'Origin'\n\n      res.set 'Access-Control-Allow-Origin', '*'\n      res.set 'Access-Control-Allow-Methods', 'POST'\n      res.set 'Access-Control-Allow-Headers', 'X-Requested-With, Content-Type'\n      res.set 'Access-Control-Allow-Max-Age', 0\n\n      return res.send 200 if req.method is 'OPTIONS'\n      return next()\n\n    app.use '\/upload', multer dest: require('os').tmpdir()\n\n    app.options '\/upload', (req, res, next) ->\n      res.set 'access-control-allow-methods', 'OPTIONS, POST'\n      res.set 'access-control-allow-headers', 'Content-Type'\n      res.end()\n\n    app.post '\/upload', (req, res, next) ->\n      console.log \"Recieved #{Object.keys(req.files).length} files\"\n\n      async.mapSeries Object.keys(req.files), (key, cb) ->\n        # @TODO check if file is valid image\n        s3.upload req.files[key].path, {}, (err, images, meta) ->\n          return cb err if err\n          return cb null, images.splice(1)\n      , (err, files) ->\n        return next err if err\n        sentry.captureHeaderSent req, files if res._headerSent\n        return res.status(201).json files\n\n    app.use raven.middleware.express sentry\n    app.use errorHandler dumpExceptions: true, showStack: true\n\n    if not module.parent\n      app.listen process.env.PORT_WWW\n      console.log \"Server listening on port #{process.env.PORT_WWW}\"\n    else\n      module.exports = app\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"824f9e32f54571b0d07c212d61714ba72ab84adb","subject":"Fixed the X axis of analogue touch controls being inverted.","message":"Fixed the X axis of analogue touch controls being inverted.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/input\/touch.litcoffee","new_file":"src\/input\/touch.litcoffee","new_contents":"On calling, this sets up touch bindings for any \"touchpad\" elements.\n\n    gamepad = require \".\/gamepad.litcoffee\"\n\n    touchpads = undefined\n\n    module.exports =\n        load: ->\n            touchpads = for element in document.getElementsByTagName \"touchpad\"\n                element: element\n                button: element.getAttribute \"button\"\n                type: element.getAttribute \"type\"\n                up: element.getAttribute \"up\"\n                down: element.getAttribute \"down\"\n                left: element.getAttribute \"left\"\n                right: element.getAttribute \"right\"\n                touchIdentifier: null\n\n            addEventListener \"touchstart\", (event) ->\n                for touch in event.changedTouches\n                    for touchpad in touchpads\n                        if touchpad.element isnt touch.target then continue\n                        touchpad.touchIdentifier = touch.identifier\n                        touchpad.latestX = touchpad.startedX = touchpad.lastX = touch.clientX\n                        touchpad.latestY = touchpad.startedY = touchpad.lastY = touch.clientY\n                        if touchpad.button then gamepad[touchpad.button] = 1\n                return\n\n            addEventListener \"touchmove\", (event) ->\n                scale = Math.min window.innerWidth, window.innerHeight\n                for touch in event.touches\n                    for touchpad in touchpads\n                        if touchpad.touchIdentifier isnt touch.identifier then continue\n                        touchpad.latestX = touch.clientX\n                        touchpad.latestY = touch.clientY\n                        switch touchpad.type\n                            when \"mouse\"\n                                if touchpad.left then gamepad[touchpad.left] = -15 * Math.min 0, (touchpad.latestX - touchpad.lastX) \/ scale\n                                if touchpad.right then gamepad[touchpad.right] = 15 * Math.max 0, (touchpad.latestX - touchpad.lastX) \/ scale\n                                if touchpad.up then gamepad[touchpad.up] = -15 * Math.max 0, (touchpad.latestY - touchpad.lastY) \/ scale\n                                if touchpad.down then gamepad[touchpad.down] = 15 * Math.min 0, (touchpad.latestY - touchpad.lastY) \/ scale\n                            when \"joystick\"\n                                if touchpad.left then gamepad[touchpad.left] = -3 * Math.max 0, (touchpad.latestX - touchpad.startedX) \/ scale\n                                if touchpad.right then gamepad[touchpad.right] = 3 * Math.min 0, (touchpad.latestX - touchpad.startedX) \/ scale\n                                if touchpad.up then gamepad[touchpad.up] = -3 * Math.max 0, (touchpad.latestY - touchpad.startedY) \/ scale\n                                if touchpad.down then gamepad[touchpad.down] = 3 * Math.min 0, (touchpad.latestY - touchpad.startedY) \/ scale\n                return\n\n            addEventListener \"touchend\", (event) ->\n                for touch in event.changedTouches\n                    for touchpad in touchpads\n                        if touchpad.touchIdentifier isnt touch.identifier then continue\n                        if touchpad.left then gamepad[touchpad.left] = 0\n                        if touchpad.right then gamepad[touchpad.right] = 0\n                        if touchpad.up then gamepad[touchpad.up] = 0\n                        if touchpad.down then gamepad[touchpad.down] = 0\n                        if touchpad.button then gamepad[touchpad.button] = 0\n                        touchpad.touchIdentifier = null\n                return\n            return\n\n        tick: ->\n            for touchpad in touchpads\n                touchpad.lastX = touchpad.latestX\n                touchpad.lastY = touchpad.latestY\n                if touchpad.type is \"mouse\" and touchpad.touchIdentifier isnt null\n                    if touchpad.left then gamepad[touchpad.left] = 0\n                    if touchpad.right then gamepad[touchpad.right] = 0\n                    if touchpad.up then gamepad[touchpad.up] = 0\n                    if touchpad.down then gamepad[touchpad.down] = 0\n            return","old_contents":"# touch\n\nHandles \"touch zones\".\n\nEach touch zone is a \"touchzone\" DOM element.\n\nIf a \"button\" attribute is defined, its value is set to 1 on touching the zone,\nand 0 on releasing it.\n\nIf the \"type\" attribute defines how analogue input should be handled:\n\n- \"joystick\": Continuous motion from the point of first touch.\n- \"mouse\": Motion is only generated by moving the touch point.\n\nThe following attributes, if defined, map motion in that direction to the named\ngamepad axis.\n\n- \"up\"\n- \"down\"\n- \"left\"\n- \"right\"\n\n    gamepad = require \".\/gamepad.litcoffee\"\n\n    touchpads = undefined\n\n    module.exports =\n    \n## load\n\nCalled at startup to discover elements and bind events.\n    \n        load: ->\n            touchpads = for element in document.getElementsByTagName \"touchpad\"\n                element: element\n                button: element.getAttribute \"button\"\n                type: element.getAttribute \"type\"\n                up: element.getAttribute \"up\"\n                down: element.getAttribute \"down\"\n                left: element.getAttribute \"left\"\n                right: element.getAttribute \"right\"\n                touchIdentifier: null\n\n            addEventListener \"touchstart\", (event) ->\n                for touch in event.changedTouches\n                    for touchpad in touchpads\n                        if touchpad.element isnt touch.target then continue\n                        touchpad.touchIdentifier = touch.identifier\n                        touchpad.latestX = touchpad.startedX = touchpad.lastX = touch.clientX\n                        touchpad.latestY = touchpad.startedY = touchpad.lastY = touch.clientY\n                        if touchpad.button then gamepad[touchpad.button] = 1\n                return\n\n            addEventListener \"touchmove\", (event) ->\n                scale = Math.min window.innerWidth, window.innerHeight\n                for touch in event.touches\n                    for touchpad in touchpads\n                        if touchpad.touchIdentifier isnt touch.identifier then continue\n                        touchpad.latestX = touch.clientX\n                        touchpad.latestY = touch.clientY\n                        switch touchpad.type\n                            when \"mouse\"\n                                if touchpad.left then gamepad[touchpad.left] = 15 * Math.min 0, (touchpad.latestX - touchpad.lastX) \/ scale\n                                if touchpad.right then gamepad[touchpad.right] = -15 * Math.max 0, (touchpad.latestX - touchpad.lastX) \/ scale\n                                if touchpad.up then gamepad[touchpad.up] = -15 * Math.max 0, (touchpad.latestY - touchpad.lastY) \/ scale\n                                if touchpad.down then gamepad[touchpad.down] = 15 * Math.min 0, (touchpad.latestY - touchpad.lastY) \/ scale\n                            when \"joystick\"\n                                if touchpad.left then gamepad[touchpad.left] = 3 * Math.min 0, (touchpad.latestX - touchpad.startedX) \/ scale\n                                if touchpad.right then gamepad[touchpad.right] = -3 * Math.max 0, (touchpad.latestX - touchpad.startedX) \/ scale\n                                if touchpad.up then gamepad[touchpad.up] = -3 * Math.max 0, (touchpad.latestY - touchpad.startedY) \/ scale\n                                if touchpad.down then gamepad[touchpad.down] = 3 * Math.min 0, (touchpad.latestY - touchpad.startedY) \/ scale\n                return\n\n            addEventListener \"touchend\", (event) ->\n                for touch in event.changedTouches\n                    for touchpad in touchpads\n                        if touchpad.touchIdentifier isnt touch.identifier then continue\n                        if touchpad.left then gamepad[touchpad.left] = 0\n                        if touchpad.right then gamepad[touchpad.right] = 0\n                        if touchpad.up then gamepad[touchpad.up] = 0\n                        if touchpad.down then gamepad[touchpad.down] = 0\n                        if touchpad.button then gamepad[touchpad.button] = 0\n                        touchpad.touchIdentifier = null\n                return\n            return\n            \n## tick\n\nCalled after game logic is ticked to prepare for future touch events.\n\n        tick: ->\n            for touchpad in touchpads\n                touchpad.lastX = touchpad.latestX\n                touchpad.lastY = touchpad.latestY\n                if touchpad.type is \"mouse\" and touchpad.touchIdentifier isnt null\n                    if touchpad.left then gamepad[touchpad.left] = 0\n                    if touchpad.right then gamepad[touchpad.right] = 0\n                    if touchpad.up then gamepad[touchpad.up] = 0\n                    if touchpad.down then gamepad[touchpad.down] = 0\n            return","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"02547ce974686d6c7186b6368c88b2e447836169","subject":"Take literate programming a bit more serious in server.litcoffee","message":"Take literate programming a bit more serious in server.litcoffee\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_contents":"nodePush Pushserver\n===================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nFirst we import the required packages and make them available in a global variable.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nNext we try to load the configuration file \"config.js\".\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nIn case not every configuration property is set we initialize it with a default property.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nWe continue with creating some helper functions.\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\t\n\tfs.open \"#{__dirname}\/..\/tmp\/nodePush.child.pid\", \"w\", 0o600, (err, fd) ->\n\t\tfs.writeSync fd, process.pid\n\t\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.wcf ?= {}\n\nbe.bastelstu.wcf.nodePush\n=========================\n\n\tclass be.bastelstu.wcf.nodePush\n\t\nAttributes\n----------\n\n`app` will become an instance of `express`.\n\n\t\tapp: null\n\n`server` willbecome an instance of `http`.\n\n\t\tserver: null\n\n`io` will become an instance of `socket.io`.\n\n\t\tio: null\n\n`stats` is an object with the different statistics recorded. Statistics will be shown on the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**  \nThe constructor is executed when the class is initialized. It prints some helpful information,\nsuch as the PID and the used sockets and continues with initializing everything.\n\n\t\tconstructor: ->\n\t\t\tlog \"nodePush running (pid:#{process.pid})\"\n\nFirst we display the used inbound and outbound sockets.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\nAfterwards we initialize the inbound and outbound connection.\n\n\t\t\t@initInbound()\n\t\t\t@initOutbound()\n\nIn order to do a proper cleanup on shutdown we bind the `shutdown` method to the needed events and signals.\n\n\t\t\tprocess.on 'exit', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'uncaughtException', (message) =>\n\t\t\t\t@shutdown message, 1\n\t\t\tprocess.on 'SIGINT', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGTERM', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGHUP', =>\n\t\t\t\t@shutdown null, 2\n\nAt the end we set a nice title for `ps`.\n\n\t\t\tprocess.title = 'nodePush'\n\n**initOutbound()**  \n`initOutbound` initializes the connection to the browser. That includes starting the HTTP server and preparing\nsocket.io.\n\n\t\tinitOutbound: ->\n\t\t\tlog 'Initializing outbound socket'\n\nFirst we start the express based HTTP server.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\nAfterwards we set socket.io configuration for the default environment. Files will be minified and logging reduced to a minimum.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nIn case `env` is set to development we show some more debug output.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nNext we listen on the socket.io `connection` event to record statistics.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nWe continue with creating a callback for the `listen` call.\n\n\t\t\tlistenCallback = =>\n\nIn case we are running as root we try to shed root privilegies. If this is not possible we exit, as a service\nrunning as root is dangerous.\n\n\t\t\t\tif process.getuid? and (process.getuid() is 0 or process.getgid() is 0)\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nAfter the the HTTP server is listening and we are no longer running as root we start some intervals for the builtin tick events.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\nStart listening on the configured outbound socket.\n\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\t\t\t\t\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\treturn unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test name\n\t\t\t\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initInbound()**  \n`initInbound` initializes the PHP side socket.\n\n\t\tinitBound: ->\n\t\t\tlog 'Initializing inbound socket'\n\nWe start by creating a server.\n\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\nIn case data is written to the server we pass it to the connected browsers and close the connection afterwards.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nIn case nothing happens within 5 seconds we close the connection in order to save resources.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\nAfter all callbacks are bound we start listening.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \n`shutdown` performs a clean shutdown of nodePush. It cleans up the unix socket files.\n\n\t\tshutdown: (message = null, code = 0) ->\n\t\t\tif message?\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\telse\n\t\t\t\tlog 'Shutting down'\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket if not config.inbound.useTCP and fs.existsSync config.inbound.socket\n\t\t\tfs.unlinkSync config.outbound.socket if not config.outbound.useTCP and fs.existsSync config.outbound.socket\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit code\n\nIn the end we finally initialize the class with starts all the services.\n\n\tnew be.bastelstu.wcf.nodePush()","old_contents":"nodePush Pushserver\n===================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\ttry\n\t\tconfig = require '..\/config.js'\n\tcatch e\n\t\tconfig = { }\n\nInitialize sane values.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= __dirname + \"\/..\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= __dirname + \"\/..\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\t\n\tfs.open \"#{__dirname}\/..\/tmp\/nodePush.child.pid\", \"w\", 0o600, (err, fd) ->\n\t\tfs.writeSync fd, process.pid\n\t\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.wcf ?= {}\n\nbe.bastelstu.wcf.nodePush\n=========================\n\n\tclass be.bastelstu.wcf.nodePush\n\t\nAttributes\n----------\n\nInstance of express.\n\n\t\tapp: null\n\nInstance of http\n\n\t\tserver: null\n\nInstance of socket.io\n\n\t\tio: null\n\nStatistics for the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog \"nodePush running (pid:#{process.pid})\"\n\t\t\t\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'uncaughtException', (message) =>\n\t\t\t\t@shutdown message, 1\n\t\t\tprocess.on 'SIGINT', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGTERM', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGHUP', =>\n\t\t\t\t@shutdown null, 2\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing outbound socket'\n\nStart HTTP service.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\tlistenCallback = =>\n\nShed root privilegies.\n\n\t\t\t\tif process.getuid? and (process.getuid() is 0 or process.getgid() is 0)\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\t\t\t\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\t\t\t\t\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\treturn unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test name\n\t\t\t\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\nPass data to the browsers and close connection.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nKill connection after 5 seconds.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message = null, code = 0) ->\n\t\t\tif message?\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\telse\n\t\t\t\tlog 'Shutting down'\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket if not config.inbound.useTCP and fs.existsSync config.inbound.socket\n\t\t\tfs.unlinkSync config.outbound.socket if not config.outbound.useTCP and fs.existsSync config.outbound.socket\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit code\n\nAnd finally start the service.\n\n\tnew be.bastelstu.wcf.nodePush()","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"5f7b736c24b7196e2e5fe7ebdb69df9cc4a8b08d","subject":"Add reference to thousandsSeparator function","message":"Add reference to thousandsSeparator function","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_contents":"nodePush Pushserver\n===================\n\n\t### Copyright Information\n\t# @author\tTim D\u00fcsterhus\n\t# @copyright\t2012-2013 Tim D\u00fcsterhus\n\t# @license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\n\t# @package\tbe.bastelstu.wcf.nodePush\n\t###\n\nSetup\n-----\n\nFirst we import the required packages and make them available in a global variable.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nNext we try to load the configuration file \"config.js\".\n\n\ttry\n\t\tfilename = \"#{__dirname}\/..\/config.js\"\n\t\tif process.argv[2]\n\t\t\tif process.argv[2].substring(0, 1) is '\/'\n\t\t\t\tfilename = process.argv[2]\n\t\t\telse\n\t\t\t\tfilename = \"#{__dirname}\/..\/#{process.argv[2]}\"\n\t\t\n\t\tfilename = fs.realpathSync filename\n\t\t\n\t\tconsole.log \"Using config '#{filename}'\"\n\t\tconfig = require filename\n\tcatch e\n\t\tconsole.warn e.message\n\t\tconfig = { }\n\nIn case not every configuration property is set we initialize it with a default property.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= \"#{__dirname}\/..\/tmp\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= \"#{__dirname}\/..\/tmp\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nWe continue with creating some helper functions.\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\n\t# http:\/\/stackoverflow.com\/a\/6502556\/782822\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\t\n\tfs.open \"#{__dirname}\/..\/tmp\/nodePush.child.pid\", \"w\", 0o600, (err, fd) ->\n\t\tfs.writeSync fd, process.pid\n\t\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.wcf ?= {}\n\nbe.bastelstu.wcf.nodePush\n=========================\n\n\tclass be.bastelstu.wcf.nodePush\n\t\nAttributes\n----------\n\n`app` will become an instance of `express`.\n\n\t\tapp: null\n\n`server` willbecome an instance of `http`.\n\n\t\tserver: null\n\n`io` will become an instance of `socket.io`.\n\n\t\tio: null\n\n`stats` is an object with the different statistics recorded. Statistics will be shown on the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**  \nThe constructor is executed when the class is initialized. It prints some helpful information,\nsuch as the PID and the used sockets and continues with initializing everything.\n\n\t\tconstructor: ->\n\t\t\tlog \"nodePush running (pid:#{process.pid})\"\n\nFirst we display the used inbound and outbound sockets.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\nAfterwards we initialize the inbound and outbound connection.\n\n\t\t\t@initInbound()\n\t\t\t@initOutbound()\n\nIn order to do a proper cleanup on shutdown we bind the `shutdown` method to the needed events and signals.\n\n\t\t\tprocess.on 'exit', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'uncaughtException', (message) =>\n\t\t\t\t@shutdown message, 1\n\t\t\tprocess.on 'SIGINT', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGTERM', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGHUP', =>\n\t\t\t\t@shutdown null, 2\n\nAt the end we set a nice title for `ps`.\n\n\t\t\tprocess.title = 'nodePush'\n\n**initOutbound()**  \n`initOutbound` initializes the connection to the browser. That includes starting the HTTP server and preparing\nsocket.io.\n\n\t\tinitOutbound: ->\n\t\t\tlog 'Initializing outbound socket'\n\nFirst we start the express based HTTP server.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\nAfterwards we set socket.io configuration for the default environment. Files will be minified and logging reduced to a minimum.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nIn case `env` is set to development we show some more debug output.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nNext we listen on the socket.io `connection` event to record statistics.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++ if @app.get('env') is 'development'\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'userID', (userID) =>\n\t\t\t\t\tsocket.get 'userID', (_, currentUserID) =>\n\nIn case a client misbehaves, by sending the `userID` twice, we `disconnect` it.\n\n\t\t\t\t\t\tif currentUserID?\n\t\t\t\t\t\t\tsocket.disconnect()\n\t\t\t\t\t\t\treturn\n\nMark user as *authenticated* by joining **user**. If a client does not send a `userID` it will not receive any messages.\n\n\t\t\t\t\t\tsocket.set 'userID', userID\n\t\t\t\t\t\tsocket.join 'authenticated'\n\t\t\t\t\t\tsocket.join \"user#{userID}\"\n\t\t\t\t\t\tsocket.emit 'authenticated'\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\t\t\t\t\t\t\t\nWe continue with creating a callback for the `listen` call.\n\n\t\t\tlistenCallback = =>\n\nIn case we are running as root we try to shed root privilegies. If this is not possible we exit, as a service\nrunning as root is dangerous.\n\n\t\t\t\tif process.getuid? and (process.getuid() is 0 or process.getgid() is 0)\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nAfter the the HTTP server is listening and we are no longer running as root we start some intervals for the builtin tick events.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\nStart listening on the configured outbound socket.\n\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\nShow detailed information when environment is `development`.\n\n\t\t\t\tif @app.get('env') is 'development'\n\t\t\t\t\t@stats.status++\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\t\tMessages:\n\t\t\t\t\t\"\"\"\n\t\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\telse\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now\n\t\t\t\t\t\"\"\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name, userIDs = [ ]) ->\n\t\t\treturn unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test name\n\t\t\t\n\t\t\tif name is 'be.bastelstu.wcf.nodePush._restart'\n\t\t\t\tprocess.kill process.pid, 'SIGHUP'\n\t\t\t\n\t\t\tif @app.get('env') is 'development'\n\t\t\t\t@stats.messages[name] ?= 0\n\t\t\t\t@stats.messages[name]++\n\t\t\t\n\t\t\tif userIDs.length\n\t\t\t\t@io.sockets.in(\"user#{userID}\").send name for userID in userIDs\n\t\t\telse\n\t\t\t\t@io.sockets.in('authenticated').send name\n\n**initInbound()**  \n`initInbound` initializes the PHP side socket.\n\n\t\tinitInbound: ->\n\t\t\tlog 'Initializing inbound socket'\n\nWe start by creating a server.\n\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++ if @app.get('env') is 'development'\n\nIn case data is written to the server we pass it to the connected browsers and close the connection afterwards.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\t[ message, userIDs ] = data.toString().trim().split \/:\/\n\t\t\t\t\tif userIDs? and userIDs.length\n\t\t\t\t\t\tuserIDs = userIDs.split \/,\/\n\t\t\t\t\t\tuserIDs = (parseInt userID for userID in userIDs when not isNaN parseInt userID)\n\t\t\t\t\telse\n\t\t\t\t\t\tuserIDs = [ ]\n\t\t\t\t\t\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage message, userIDs\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nIn case nothing happens within 5 seconds we close the connection in order to save resources.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\nAfter all callbacks are bound we start listening.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \n`shutdown` performs a clean shutdown of nodePush. It cleans up the unix socket files.\n\n\t\tshutdown: (message = null, code = 0) ->\n\t\t\tif message?\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\telse\n\t\t\t\tlog 'Shutting down'\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket if not config.inbound.useTCP and fs.existsSync config.inbound.socket\n\t\t\tfs.unlinkSync config.outbound.socket if not config.outbound.useTCP and fs.existsSync config.outbound.socket\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit code\n\nIn the end we finally initialize the class with starts all the services.\n\n\tnew be.bastelstu.wcf.nodePush()\n","old_contents":"nodePush Pushserver\n===================\n\n\t### Copyright Information\n\t# @author\tTim D\u00fcsterhus\n\t# @copyright\t2012-2013 Tim D\u00fcsterhus\n\t# @license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\n\t# @package\tbe.bastelstu.wcf.nodePush\n\t###\n\nSetup\n-----\n\nFirst we import the required packages and make them available in a global variable.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nNext we try to load the configuration file \"config.js\".\n\n\ttry\n\t\tfilename = \"#{__dirname}\/..\/config.js\"\n\t\tif process.argv[2]\n\t\t\tif process.argv[2].substring(0, 1) is '\/'\n\t\t\t\tfilename = process.argv[2]\n\t\t\telse\n\t\t\t\tfilename = \"#{__dirname}\/..\/#{process.argv[2]}\"\n\t\t\n\t\tfilename = fs.realpathSync filename\n\t\t\n\t\tconsole.log \"Using config '#{filename}'\"\n\t\tconfig = require filename\n\tcatch e\n\t\tconsole.warn e.message\n\t\tconfig = { }\n\nIn case not every configuration property is set we initialize it with a default property.\n\n\tconfig.outbound ?= { }\n\tconfig.outbound.useTCP ?= true\n\tconfig.outbound.port ?= 9001\n\tconfig.outbound.host ?= '0.0.0.0'\n\tconfig.outbound.socket ?= \"#{__dirname}\/..\/tmp\/outbound.sock\"\n\tconfig.inbound ?= { }\n\tconfig.inbound.useTCP ?= false\n\tconfig.inbound.port ?= 9002\n\tconfig.inbound.host ?= '127.0.0.1'\n\tconfig.inbound.socket ?= \"#{__dirname}\/..\/tmp\/inbound.sock\"\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nWe continue with creating some helper functions.\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\t\n\tfs.open \"#{__dirname}\/..\/tmp\/nodePush.child.pid\", \"w\", 0o600, (err, fd) ->\n\t\tfs.writeSync fd, process.pid\n\t\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.wcf ?= {}\n\nbe.bastelstu.wcf.nodePush\n=========================\n\n\tclass be.bastelstu.wcf.nodePush\n\t\nAttributes\n----------\n\n`app` will become an instance of `express`.\n\n\t\tapp: null\n\n`server` willbecome an instance of `http`.\n\n\t\tserver: null\n\n`io` will become an instance of `socket.io`.\n\n\t\tio: null\n\n`stats` is an object with the different statistics recorded. Statistics will be shown on the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**  \nThe constructor is executed when the class is initialized. It prints some helpful information,\nsuch as the PID and the used sockets and continues with initializing everything.\n\n\t\tconstructor: ->\n\t\t\tlog \"nodePush running (pid:#{process.pid})\"\n\nFirst we display the used inbound and outbound sockets.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tlog \"Inbound: #{config.inbound.host}:#{config.inbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Inbound: #{config.inbound.socket}\"\n\t\t\tif config.outbound.useTCP\n\t\t\t\tlog \"Outbound: #{config.outbound.host}:#{config.outbound.port}\"\n\t\t\telse\n\t\t\t\tlog \"Outbound: #{config.outbound.socket}\"\n\t\t\t\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\nAfterwards we initialize the inbound and outbound connection.\n\n\t\t\t@initInbound()\n\t\t\t@initOutbound()\n\nIn order to do a proper cleanup on shutdown we bind the `shutdown` method to the needed events and signals.\n\n\t\t\tprocess.on 'exit', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'uncaughtException', (message) =>\n\t\t\t\t@shutdown message, 1\n\t\t\tprocess.on 'SIGINT', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGTERM', =>\n\t\t\t\t@shutdown()\n\t\t\tprocess.on 'SIGHUP', =>\n\t\t\t\t@shutdown null, 2\n\nAt the end we set a nice title for `ps`.\n\n\t\t\tprocess.title = 'nodePush'\n\n**initOutbound()**  \n`initOutbound` initializes the connection to the browser. That includes starting the HTTP server and preparing\nsocket.io.\n\n\t\tinitOutbound: ->\n\t\t\tlog 'Initializing outbound socket'\n\nFirst we start the express based HTTP server.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\nAfterwards we set socket.io configuration for the default environment. Files will be minified and logging reduced to a minimum.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nIn case `env` is set to development we show some more debug output.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nNext we listen on the socket.io `connection` event to record statistics.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++ if @app.get('env') is 'development'\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'userID', (userID) =>\n\t\t\t\t\tsocket.get 'userID', (_, currentUserID) =>\n\nIn case a client misbehaves, by sending the `userID` twice, we `disconnect` it.\n\n\t\t\t\t\t\tif currentUserID?\n\t\t\t\t\t\t\tsocket.disconnect()\n\t\t\t\t\t\t\treturn\n\nMark user as *authenticated* by joining **user**. If a client does not send a `userID` it will not receive any messages.\n\n\t\t\t\t\t\tsocket.set 'userID', userID\n\t\t\t\t\t\tsocket.join 'authenticated'\n\t\t\t\t\t\tsocket.join \"user#{userID}\"\n\t\t\t\t\t\tsocket.emit 'authenticated'\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\t\t\t\t\t\t\t\nWe continue with creating a callback for the `listen` call.\n\n\t\t\tlistenCallback = =>\n\nIn case we are running as root we try to shed root privilegies. If this is not possible we exit, as a service\nrunning as root is dangerous.\n\n\t\t\t\tif process.getuid? and (process.getuid() is 0 or process.getgid() is 0)\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nAfter the the HTTP server is listening and we are no longer running as root we start some intervals for the builtin tick events.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'be.bastelstu.wcf.nodePush.tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\nStart listening on the configured outbound socket.\n\n\t\t\tif config.outbound.useTCP\n\t\t\t\t@server.listen config.outbound.port, config.outbound.host, null, listenCallback\n\t\t\telse\n\t\t\t\t@server.listen config.outbound.socket, listenCallback\n\t\t\t\tfs.chmod config.outbound.socket, '777'\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.charset = 'utf-8';\n\t\t\t\tres.type 'txt'\n\nShow detailed information when environment is `development`.\n\n\t\t\t\tif @app.get('env') is 'development'\n\t\t\t\t\t@stats.status++\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\t\tMessages:\n\t\t\t\t\t\"\"\"\n\t\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\telse\n\t\t\t\t\treply = \"\"\"\n\t\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now\n\t\t\t\t\t\"\"\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name, userIDs = [ ]) ->\n\t\t\treturn unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test name\n\t\t\t\n\t\t\tif name is 'be.bastelstu.wcf.nodePush._restart'\n\t\t\t\tprocess.kill process.pid, 'SIGHUP'\n\t\t\t\n\t\t\tif @app.get('env') is 'development'\n\t\t\t\t@stats.messages[name] ?= 0\n\t\t\t\t@stats.messages[name]++\n\t\t\t\n\t\t\tif userIDs.length\n\t\t\t\t@io.sockets.in(\"user#{userID}\").send name for userID in userIDs\n\t\t\telse\n\t\t\t\t@io.sockets.in('authenticated').send name\n\n**initInbound()**  \n`initInbound` initializes the PHP side socket.\n\n\t\tinitInbound: ->\n\t\t\tlog 'Initializing inbound socket'\n\nWe start by creating a server.\n\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++ if @app.get('env') is 'development'\n\nIn case data is written to the server we pass it to the connected browsers and close the connection afterwards.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\t[ message, userIDs ] = data.toString().trim().split \/:\/\n\t\t\t\t\tif userIDs? and userIDs.length\n\t\t\t\t\t\tuserIDs = userIDs.split \/,\/\n\t\t\t\t\t\tuserIDs = (parseInt userID for userID in userIDs when not isNaN parseInt userID)\n\t\t\t\t\telse\n\t\t\t\t\t\tuserIDs = [ ]\n\t\t\t\t\t\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage message, userIDs\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nIn case nothing happens within 5 seconds we close the connection in order to save resources.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\nAfter all callbacks are bound we start listening.\n\n\t\t\tif config.inbound.useTCP\n\t\t\t\tsocket.listen config.inbound.port, config.inbound.host\n\t\t\telse\n\t\t\t\tsocket.listen config.inbound.socket\n\t\t\t\tfs.chmod config.inbound.socket, '777'\n\n**shutdown()**  \n`shutdown` performs a clean shutdown of nodePush. It cleans up the unix socket files.\n\n\t\tshutdown: (message = null, code = 0) ->\n\t\t\tif message?\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\telse\n\t\t\t\tlog 'Shutting down'\n\t\t\t\n\t\t\tfs.unlinkSync config.inbound.socket if not config.inbound.useTCP and fs.existsSync config.inbound.socket\n\t\t\tfs.unlinkSync config.outbound.socket if not config.outbound.useTCP and fs.existsSync config.outbound.socket\n\t\t\t\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit code\n\nIn the end we finally initialize the class with starts all the services.\n\n\tnew be.bastelstu.wcf.nodePush()\n","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"5af1e57118c2d71d9097bd8aff1c72a95ba459e1","subject":"Fix naming in docs","message":"Fix naming in docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/03d_proxy.litcoffee","new_file":"docs\/03d_proxy.litcoffee","new_contents":"# \/api\/Data Structures\/Batman.Object\/Batman.Proxy\n\n`Batman.Proxy` extends `Batman.Object` but implements the default accessor to `get`, `set`, and `unset` on its `target`.\n\nAny accessors without explicit definitions will be delegated to `target`:\n\n    test \"a Batman.Proxy delegates to its target\", ->\n      class CustomProxy extends Batman.Proxy\n        @accessor 'customValue', -> \"Custom Value!\"\n\n      targetObject = new Batman.Object({name: \"Batman\", favoriteColor: \"#000\"})\n      proxy = new CustomProxy(targetObject)\n\n      equal proxy.get('favoriteColor'), '#000', \"Default accessor delegates to target\"\n      equal proxy.get('customValue'), \"Custom Value!\", \"Custom accessors override delegated ones\"\n\n## ::constructor(target : Batman.Object) : Proxy\n\nReturns a new `Batman.Proxy` delegating to `target`.\n\n## ::.isProxy[=true] : Boolean\n\nReturns `true`. Shows that the object is a proxy.\n\n## ::%target : Object\n\nReturns the object which the `Proxy` is delegating to.\n\n## @delegatesToTarget(functionNames...)\n\nDefines a whitelist of functions which the `Proxy` will delegate to its target object. Unlike accessors, functions are not automatically passed to the target. For example:\n\n    class Batman.AssociationProxy\n      ...\n      @delegatesToTarget('save', 'validate', 'destroy')\n      ...\n\npasses calls to `save`, `validate`, and `destroy` made on an `AssociationProxy` to the target `Batman.Model` where those functions are defined.\n","old_contents":"# \/api\/Data Structures\/Batman.Object\/Batman.Proxy\n\n`Batman.Proxy` extends `Batman.Object` but implements the default accessor to `get`, `set`, and `unset` on its `target`.\n\nAny accessors without explicit definitions will be delegated to `target`:\n\n    test \"a Batman.Proxy delegates to its target\", ->\n      class CustomProxy extends Batman.Proxy\n        @accessor 'customValue', -> \"Custom Value!\"\n\n      targetObject = new Batman.Object({name: \"Batman\", favoriteColor: \"#000\"})\n      proxy = new CustomProxy(targetObject)\n\n      equal proxy.get('favoriteColor'), '#000', \"Default accessor delegates to target\"\n      equal proxy.get('customValue'), \"Custom Value!\", \"Custom accessors override delegated ones\"\n\n## ::constructor(target : Batman.Object) : Proxy\n\nReturns a new `Batman.Proxy` delegating to `target`.\n\n## ::.isProxy[=true] : Boolean\n\nReturns `true`. Shows that the object is a proxy.\n\n## ::%target : Object\n\nReturns the object which the `Proxy` is delegating to.\n\n## @delegatesFunctionsToTarget(names...)\n\nDefines a whitelist of functions which the `Proxy` will delegate to its target object. Unlike accessors, functions are not automatically passed to the target. For example:\n\n    class Batman.AssociationProxy\n      ...\n      @delegatesFunctionsToTarget('save', 'validate', 'destroy')\n      ...\n\npasses calls to `save`, `validate`, and `destroy` made on an `AssociationProxy` to the target `Batman.Model` where those functions are defined.\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6fe37401b25141af300ad7de6ac4e1065d3f7350","subject":"remove View data-mixin","message":"remove View data-mixin\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/14_bindings.litcoffee","new_file":"docs\/14_bindings.litcoffee","new_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a node's child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","old_contents":"# Batman.View Bindings\n\nBatman's view bindings are how data gets shown and collected from the user. They center on the notion of \"bindings\": that the view representation and the JavaScript land value are always guaranteed to be in sync, such that when one changes, the other will reflect it.\n\n## How to use bindings\n\nBindings are declared as attributes on nodes under the `data` namespace. In practice, it looks like this:\n\n```html\n<div data-bind=\"name\"><\/div>\n```\n\nThis instantiates a binding on the `div` node which will update the node's `innerHTML` with the value found at the `name` keypath in the <a href=\"#batman-view-bindings-binding-contexts\">current context<\/a>. Whenever the `name` key changes, the div's `innerHTML` will update to the new value.\n\nNodes can have multiple bindings:\n\n```html\n<p data-bind=\"body\" data-showif=\"isPublished\"><\/p>\n```\n\nor attribute bindings:\n\n```html\n<p data-bind-id=\"currentID\"><\/p>\n```\n\nand bindings can be on inputs which the user can change:\n\n```html\n<input type=\"text\" data-bind=\"title\"><\/input>\n```\n\nWhen the `title` property changes on the JavaScript object this `input` is bound to, the `input`'s value will be updated. When the user types into the `input` (and `change` or `keyup` events are triggered), the `title` property in JavaScript land will be updated.\n\n## Binding Keypaths\n\nA `keypath` is the value of the HTML attribute a binding references. Importantly, keypaths can have multiple segments:\n\n```html\n<p data-bind=\"order.customer.name\"><\/p>\n```\n\nThe keypath in the above HTML is `order.customer.name`. When you create a binding to a keypath like this (with dots separating segments), the binding will update the HTML value when _any_ of those segments change. In the above example, this means the `p` tag's `innerHTML` will be updated when:\n\n 1. the order changes,\n 2. the order's customer changes,\n 3. or the order's customer's name changes.\n\nThis is important because it means you can rely on a binding to \"just work\" when anything it depends on changes. If say you had a `<select>` on the page which changed the `order`'s `customer` property, bindings which bind to `order.customer.name` will update each time you change that select to reflect the new customer's name.\n\n## Binding Contexts\n\nAll bindings render in a context. Binding contexts, known internally to Batman as `RenderContext`s, are objects which emulate the notion of variable scope in JavaScript code. When a controller action renders, it passes a context to the view consisting of itself, the `App`, and an object with a `window` key pointing to the host `window` object.\n\n## Keypath Filters\n\nBindings can bind to filtered keypaths:\n\n```html\n<p data-bind=\"post.body | truncate 100\"><\/p>\n```\n\nThe above `<p>` will have 100 characters worth of the post's body. Whenever the post's body changes, it will be retruncated and the `<p>`'s `innerHTML` will be updated.\n\nFilter chains can be arbitrarily long:\n\n```html\n<span data-bind=\"knight.title | prepend 'Sir' | append ', the honourable'.\"><\/span>\n```\n\nand filter chains can use other keypaths as arguments to the filters:\n\n```html\n<span data-bind=\"person.name | prepend ' ' | prepend person.title\"><\/span>\n```\n\nThe above `<span>`'s `innerHTML` will be updated whenever the person's name or title changes.\n\n#### Two Way Bindings and Filters\n\nNote that filtered keypaths cannot propagate DOM land changes because values can't always be \"unfiltered\". For example, if we bind an input to the truncated version of a string:\n\n```html\n<input data-bind=\"post.body | truncate 100\"><\/input>\n```\n\nThe `<input>`'s value can be updated when the `post.body` property changes but if a user types into this input field, they will edit the truncated body. If Batman updated the `post.body` property with the contents of the input, all characters which had been truncated will be lost to the nether. To avoid this loss of information and inconsistency, bindings to filtered keypaths will _only update from JavaScript land to HTML_, and never vice versa.\n\n## Keypath Literals\n\nKeypaths also support a select few literals within them. Numbers, strings, and booleans can be passed as arguments to filters or used as the actual value of the keypath.\n\nThe following are all valid, albeit contrived, bindings:\n\n```html\n<!-- String literal used as an argument -->\n<p data-bind=\"body | append ' ... '\"><\/p>\n\n<!-- Boolean literal used as an argument -->\n<p data-showif=\"shouldShow | default true\"><\/p>\n\n<!-- Number literal used as an argument -->\n<p data-bind=\"body | truncate 100\"><\/p>\n\n<!-- String literal used as the value -->\n<p data-bind=\"'Hardcoded'\"><\/p>\n\n<!-- Boolean literal used as the value -->\n<p data-showif=\"true\"><\/p>\n```\n\n## data-bind\n\n`data-bind` creates a two way binding between a property on a `Batman.Object` and an HTML element. Bindings created via `data-bind` will update the HTML element with the value of the JS land property as soon as they are created and each time the property changes after, and if the HTML element can be observed for changes, it will update the JS land property with the value from the HTML.\n\n`data-bind` will change its behaviour depending on what kind of tag it is attached to:\n\n + `<input type=\"checkbox\">`: the binding will edit the `checked` property of the checkbox and populate the keypath with a boolean.\n + `<input type=\"text\">` and similar, `<textarea`>: the binding will edit the `value` property of the input and populate the keypath with the string found at `value`.\n + `<input type=\"file\">`: the binding will _not_ edit the `value` property of the input, but it will update the keypath with a host `File` object or objects if the node has the `multiple` attribute.\n + `<select>`: the binding will edit the `selected` property of each `<option>` tag within the `<select>` matching the property at the keypath. If the `<select>` has the multiple attribute, the value at the keypath can be an array of selected `<option>` values. You can also use `data-bind-selected` bindings on the individual options to toggle option selectedness.\n + All other tags: the binding will edit the `innerHTML` property of the tag and will not populate the keypath.\n\n`data-bind` can also be used to bind an attribute of a node to a JavaScript property. Since attributes can't be observed for changes, this is a one way binding which will never update the JavaScript land property. Specify which attribute to bind using the \"double dash\" syntax like so: `data-bind-attribute=\"some.keypath\"`. For example, to bind the `placeholder` attribute of an input, use `data-bind-placeholder`.\n\n```html\n<input type=\"text\" data-bind-placeholder=\"'Specify a subtitle for product ' | append product.name\">\n```\n\n_Note_: `data-bind` will not update a JavaScript property if filters are used in the keypath.\n\n## data-source\n\n`data-source` creates a one way binding which propagates only changes from JavaScript land to the DOM, and never vice versa. `data-source` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will only ever update the DOM and never the JavaScript land property.\n\nFor example, the HTML below will never update the `title` property on the product, even if the user changes it. Each time the `title` attribute changes from a `set` in JavaScript land, the value of the input will be updated to the new value of `title`, erasing any potential changes that have been made to the value of the input by the user.\n\n```html\n<input type=\"text\" data-source=\"product.title\">\n```\n\n_Note_: `data-source-attribute` is equivalent to `data-bind-attribute`, since the former is defined as never making JS land changes, and the latter is unable to.\n\n## data-target\n\n`data-target` creates a one way binding which propagates only changes from the DOM to JavaScript land, and never vice versa. `data-target` has the same semantics with regards to how it operates on different tags as `data-bind`, but it will never update the DOM even if the JavaScript land value changes.\n\n_Note_: `data-target-attribute` is unavailable, because DOM changes to node attributes can't be monitored.\n\n\n## data-showif \/ data-hideif\n\n`data-showif` and `data-hideif` bind to keypaths and show or hide the node they appear on based on the truthiness of the result. `data-showif` will show a node if the given keypath evaluates to something truthy, and `data-hideif` will leave a node visible until its given keypath becomes truthy, at which point the node will be hidden. `data-showif` and `data-hideif` show and hide nodes by adding `display: none !important;` to the node's `style` attribute.\n\nFor example, if the HTML below is rendered where the keypath `product.published` evaluated to true, the `<button>` will be visible.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n```\n\nThis is the Batman equivalent of a templating language's `if` construct, where else branches are implemented using the opposite binding.\n\n```html\n<button data-showif=\"product.published\">Unpublish Product<\/button>\n<button data-hideif=\"product.published\">Publish Product<\/button>\n```\n\n## data-addclass \/ data-removeclass\n\n`data-addclass` and `data-removeclass` bindings can be used to conditionally add or remove a class from a node based on a boolean keypath. Specify the class to add using the \"double dash\" syntax; for example,`data-addclass-big=\"some.keypath\"` on a node will add the \"big\" class to that node's classes if `some.keypath` is truthy. `data-removeclass` will remove a class (usually one which is present in the HTML) if the keypath passed to it is truthy.\n\nThe outer span in the HTML below will have an \"error\" class when the `product.errors.length` keypath evaluates to anything other than 0, since 0 is falsy and other numbers are truthy.\n\n```html\n<p data-addclass-error=\"product.errors.length\">\n  This product has <span data-bind=\"product.errors.length\"><\/span> errors.\n<\/p>\n```\n\n## data-foreach\n\n`data-foreach` is used to loop over an iterable object in Batman views. `data-foreach` duplicates the node it occurs on for each item in the collection found at the keypath given to it, and renders each duplicated node with that node's object from the collection by putting it in the context under a name passed to it using the \"double dash\" syntax.\n\nThe `<option>` node below will be duplicated for each item in the `Set` at the `products` keypath.\n\n```html\n<select>\n  <option data-foreach-product=\"products\" data-bind=\"product.name\"><\/option>\n<\/select>\n```\n\nBatman will execute the `data-foreach` binding before the `data-bind` on the `<option>` node, which means that the `data-bind` will be processed for each duplicated node with each separate Product in the `products` Set in scope for each separate node. If there were say 3 Products in the `products` set, the HTML would look similar to this once rendered:\n\n```html\n<select>\n  <option data-bind=\"product.name\">Product A<\/option>\n  <option data-bind=\"product.name\">Product B<\/option>\n  <option data-bind=\"product.name\">Product C<\/option>\n  <!-- end products -->\n<\/select>\n```\n\n`data-foreach` can be used to iterate over `Batman.Set`s, and most often should be, because it observes any Sets and will update the DOM with new nodes if items are added to the set, or remove nodes from the DOM if their corresponding nodes are removed from the set. `data-foreach`, like every other binding, is keypath aware, such that if the `Set` instance at the keypath changes, or any previous segment of the keypath changes, `data-foreach` will remove all the nodes currently in the DOM, and add new nodes for each new item in the incoming `Set`.\n\nSometimes you'll need to add some custom logic to the iteration nodes. For example, a custom `viewDidAppear` handler so you can know whenever a new iteration node appears in the DOM. You can do this by specifying a custom subclass of `Batman.IterationView`.\n\n```html\n<ul>\n  <li data-foreach-product=\"products\" data-view=\"ProductIterationView\">\n    <span data-bind=\"product.name\"><\/span>\n  <\/li>\n<\/ul>\n```\n\n```coffeescript\nclass MyApp.ProductIterationView extends Batman.IterationView\n  viewDidAppear: ->\n    $(@get('node')).draggable()\n```\n\n\n_Note_: `data-foreach` expects to find an iterable object at the keypath given to it, and will emit a warning if it finds `undefined`.\n\n_Note_: `data-foreach` expects the passed enumerable to be unique. It creates a map of nodes to items, so every node needs to be able to reference exactly one object. If you simply have a set of values that you're iterating over, you should wrap your values in objects, e.g. `[{value: true}, {value: true}]`.\n\n## data-formfor\n\n`data-formfor` creates a special addition to the context stack to represent an object under edit within a form. Usually this object is a model. Using the double dash syntax, the name for the model to reside under can be specified.\n\n==== Automatic Validation Display\n\n`data-formfor` also has some handy functionality for displaying the result of validating the object under edit in the form. This will only be enabled if the object has an `errors` Set, like `Batman.Models` do.\n\nIf a tag matching the relative selector `.errors` is found, it will populate this element with a list of the errors found during validation on the object. The selector for the errors container can be changed by adding a `data-errors-list` attribute with the value of the selector to the form with the `data-formfor` binding on it, or editing `Batman.DOM.FormBinding::defaultErrorsListSelector`.\n\nIf value bindings are made using `data-bind` to attributes on the model within the form, automatic `data-addclass-error` bindings will be added to the elements on which the `data-bind` occurs to add the \"error\" class when the model has errors on the attribute which `data-bind` binds to.\n\nIn the HTML below, an automatic `data-addclass-error` will be added to the `<input>` which activates when the `product` model has validation errors on the `name` attribute.\n\n```html\n<form data-formfor-product=\"currentProduct\">\n  <input type=\"text\" data-bind=\"product.name\"><\/input>\n<\/form>\n```\n\nThe class which gets automatically added to inputs binding to invalid attributes can be customized by editing `Batman.DOM.FormBinding::errorClass`.\n\n## data-context\n\n`data-context` bindings add the object found at the key to the context stack, optionally under a key using the double dash syntax.\n\nFor example, if a `product` object exists in the current context, the `data-context` binding below will expose its attributes at the root level of the context:\n\n```html\n<div data-context=\"product\">\n  <span data-bind=\"name\"><\/span>\n  <span data-bind=\"cost\"><\/span>\n<\/div>\n```\n\nContexts added to the stack can also be scoped under a key using `data-context-`:\n\n```html\n<div data-context-currentProduct=\"product\">\n  <span data-bind=\"currentProduct\"><\/span>\n  <span data-bind=\"currentProduct\"><\/span>\n<\/div>\n```\n\nThis is a useful mechanism for passing local variables to partial views.\n\n## data-event\n\n`data-event` bindings add DOM event listeners to the nodes they exist on which call the function found at the passed keypath. `data-event` bindings use the double dash syntax to specify the name of the event to listen for.\n\nIn the HTML below, if the keypath `controller.nextAction` resolves to a function, that function will be executed each time the `<button>` element is clicked.\n\n```html\n<button data-event-click=\"controller.nextAction\"><\/button>\n```\n\nFunctions which `data-event` calls will be passed the node and the `DOMEvent` object: `(node, event) ->`.\n\n`data-event` supports the following types of events formally and should \"do the right thing\" when attached to elements which fire these events:\n\n + click\n + doubleclick\n + change\n + submit\n\nIf the event name used doesn't match the above events, the event name used will just fall through and be passed to `window.addEventListener`.\n\n## data-route\n\n`data-route` bindings are used to dispatch a new controller action upon the clicking of the node they bind to. `data-route` expects to find either a string or a `NamedRouteQuery` at the keypath passed to it. With this route, it will add an event handler to the `click` action of the element which dispatches the route and prevents the default action of the DOMEvent. `data-route` will also populate the `href` attribute if it occurs on an `<a>` tag so that other functons like \"Copy Link Address\" and Alt+Click continue to work on the link.\n\nThe first way to use `data-route` is by passing it a string, which can be built using filters or an accessor, but the preferred way is to use the `NamedRouteQuery`. These objects are generated for you by starting keypaths at the `App.routes` property. All `Batman.App`s have a `routes` property which holds a nested list of all the routes, which you descend into by passing various key segments and objects. Since the `App` object is present in the default context stack, `data-route` keypaths can just start with `routes`.\n\nFor example, assume the following routes definition in the current `Batman.App`:\n\n```coffeescript\nclass Alfred extends Batman.App\n  @resources 'todos'\n```\n\nThis means that routes like `\/todos` and `\/todos\/:id` exist. To route to the collection action, use the plural name of the resource:\n\n```html\n<a data-route=\"routes.todos\"><\/a>\n```\n\nTo route to an individual todo things get a bit more complicated. If we have a Todo model with ID# `42` in the context as `todo`, use the `get` filter shorthand on the `NamedRouteQuery` returned by `routes.todos` to generate a member route:\n\n```html\n<a data-route=\"routes.todos[todo]\"><\/a>\n```\n\nUnderneath, this is calling `Alfred.get('routes.todos').get(todo)`; the todo object is being passed as a key to the `NamedRouteQuery`, which knows how to generate a member route when given a record. The above HTML when rendered will look like this:\n\n```html\n<a data-route=\"routes.todos[todo]\" href=\"\/todos\/42\"><\/a>\n```\n\nThis syntax can be extended to nested routes. If we have nested routes, we can use chained gets to generated nested routes\n\n```coffeescript\nclass Tracker extends Batman.App\n  @resources 'villains', ->\n    @resources 'crimes'\n```\n\nRoutes for collection and member crimes should look like `\/villains\/:villain_id\/crimes` and `\/villains\/:villain_id\/crimes\/:id` respectively. Assuming the presence of a `villain` and a `crime` in the context, chained `get`s on `NamedRouteQuery`s achieve this:\n\n```html\n<!-- Collection of crimes for a particular villain -->\n<a data-route=\"routes.villains[villain].crimes\"><\/a>\n<!-- One crime of a particular villain -->\n<a data-route=\"routes.villains[villain].crimes[crime]\"><\/a>\n```\n\n_Note_: `data-route` bindings route only to internal dispatch, and not external links. Use a regular `<a>` tag to link away from the application.\n\n## data-view\n\n`data-view` bindings attach custom `Batman.View` instances or instantiate custom `View` subclasses to \/ on a node. `data-view` expects either a `Batman.View` instance or subclass at the keypath passed to it. If an instance is passed, it will `set` the `node` property of the view to the node the `data-view` occurs on. If a class is passed, that class will be instantiated with the context the `data-view` binding executed in and with the node it occurred upon. See `Batman.View` for more information on custom Views and their uses.\n\n_Note_: `data-view` bindings will bind to the passed keypath until it exists, that is to say until the value of it is not `undefined`. After the `View` has been set up, the `data-view` binding will remove itself and stop observing the keypath.\n\n## data-partial\n\n`data-partial` pulls in a partial template and renders it in the current context of the node the `data-partial` occurs in. `data-partial` expects the name of the view to render in the value of the HTML attribute. __Warning__: This value is not a keypath. The HTML attribute's value is interpreted as a string, and the template which resides at that view path will be rendered.\n\nIf we have this HTML at `views\/villains\/_stub.html` in our app:\n\n```html\n<span data-bind=\"villain.name\"><\/span>\n```\n\nand in `views\/villains\/show.html` we have this HTML:\n\n```html\n<h1>A villain!<\/h1>\n<div data-partial=\"villains\/_stub\"><\/div>\n```\n\nthe contents of the `stub` partial will be inserted and rendered in the `<div>` above.\n\n## data-mixin\n\n## data-defineview\n\n## data-renderif\n\n`data-renderif` defers parsing of a node's child bindings until its keypath updates to true. `data-renderif` should generally be combined with a `data-showif` or `data-insertif` to prevent it from being visible until it is ready.\n\nDeferring rendering can help prevent portions of the page updating many times while data is being loaded. It can also allow you to prevent features that are not yet ready from being used.\n\n## data-yield\n\n`data-yield` specifies that this node should be a render target for any view renderings that specify they should be rendered into a yield with this name. For example, `data-yield=\"myYieldNode\"` can be rendered into by using `new Batman.View(contentFor: 'myYieldNode')`. The special case of `data-yield=\"main\"` will be the render target for any view rendered by a controller action. This can mean the implicit render that happens by default at the end of a controller action or by explicitly calling `@render` inside a controller.\n\nYou can also specify a render target inside your HTML using `data-contentfor`.\n\n```html\n<div data-yield=\"main\"><\/div>\n```\n\n## data-contentfor\n\n`data-contentfor` specifies that the content of this node should be rendered into a `yield` with the corresponding name.\n\n```html\n<div data-contentfor=\"header\"><h1 data-bind=\"title\"><\/h1><\/div>\n<div data-yield=\"header\"><\/div>\n```\n\n# Batman.View Filters\n\nBatman filters are evaluated from left to right, with the output of each filter being injected into the next. This allows you to form filter chains for display purposes. Accessor caching does not apply to filter chains. If any component of the chain changes, the entire chain will be recalculated for each binding in the template.\n\n## raw(value) : string\n\nThe `raw` filter renders the unescaped value.\n\n```html\n<span data-bind=\"someHTMLyString | raw\"><\/span>\n```\n\n## get(value, key) : value\n\nCalls the get function on the input value with the specified key. Can be used with `Batman.Accessible` and `Batman.TerminalAccessible`:\n\n```html\n<span data-bind=\"accessibleFunction | get 'item'\"><\/span>\n```\n\n## value[key] : value\n\nShorthand for the `get` filter.\n\n## equals(left, right) : boolean\n\nChecks if left content is equal to right content:\n\n```html\n<span data-showif=\"title | equals 'Batman Views'\"><\/span>\n```\n\n## not(value) : boolean\n\nInverts the truthiness of the input value:\n\n```html\n<span data-hideif=\"title | equals 'Batman Views' | not | and action | equals 'show'\"><\/span>\n```\n\n## matches(value, string) : boolean\n\nTests a string against the input value:\n\n```html\n<span data-showif=\"title | matches 'Bat'\"><\/span>\n```\n\n## truncate(value, length, end = '...') : string\n\nLimits the length of output to the specified length and appends the specified text if over the limit:\n\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"page.title | truncate 5, '\u2026'\">About\u2026<\/span>\n```\n\n## default(value, defaultValue) : value\n\nProvides a default value if the keypath is falsy:\n\n```html\n<input type=\"text\" data-bind=\"page.title | default 'About Us'\"><\/input>\n```\n\n## prepend(value, string) : string\n\nPrepends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | prepend 'ico-'\" class=\"ico-about\"><\/span>\n```\n\n## append(value, string) : string\n\nAppends the string to the input value:\n\n```html\n<span data-bind-class=\"page.tag | append '-ico'\"><\/span>\n```\nIf page.tag is 'about' this would result in:\n```html\n<span data-bind-class=\"page.tag | append '-ico'\" class=\"about-ico\"><\/span>\n```\n\n## replace(value, searchString, replaceString[, flags]) : string\n\nReplaces content in the input value matching the `searchString` with the `replaceString` value:\n\n```html\n<span data-bind=\"page.title | replace 'html', 'HTML'\"><\/span>\n```\n\n## downcase(value) : string\n\nDowncases the input value:\n\n```html\n<span data-bind=\"page.title | downcase\"><\/span>\n```\n\n## upcase(value) : string\n\nUpcases the input value:\n\n```html\n<span data-bind=\"page.title | upcase\"><\/span>\n```\n\n## pluralize(value, count) : string\n\nPluralizes the input value based on the patterns specified in `Batman.helpers.inflector` and the count provided:\n\n```coffeescript\n( ->\n  @singular \/(analysis)$\/i, '$1'\n  @singular \/(analy)ses$\/i, '$1sis'\n).call(Batman.helpers.inflector)\n```\n\n```html\n<span data-bind=\"'analysis' | pluralize page.comments.count\"><\/span>\n```\n\n## humanize(string) : string\n\nTakes a string and makes it human readable, for example 'an_underscored_string' would become 'An underscored string'.\n\n```html\n<span data-bind=\"'about_us_page' | humanize\"><\/span>\n```\nWould result in:\n```html\n<span data-bind=\"'about_us_page' | humanize\">About us page<\/span>\n```\n\n## join(value, separator = '') : string\n\nJoins an `array` of values into a single string:\n\n```html\n<span data-bind=\"page.comments | map 'title' | join ', '\"><\/span>\n```\n\n## sort(value) : value\n\nSorts an `array` using the default comparison:\n\n```html\n<span data-foreach-comment=\"page.comments | sort\" data-bind=\"comment.title\"><span>\n```\n\n## map(iterable) : value\n\nMaps the specified keypath from an `array` of objects:\n\n```html\n<span data-foreach-author=\"page.comments | map 'author'\" data-bind=\"author\"><span>\n```\n\n## has(iterable, item) : boolean\n\nCalls the `iterable`'s `has` function to check for the existence of the specified `item`.\n\n```coffeescript\nclass Sample.FirstController extends Batman.Controller\n  index: ->\n    @set('things', new Batman.Set('thing1', 'thing2'))\n```\n\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\"><\/input>\n```\nIf you were to dispatch `first#index`:\n```html\n<input type=\"checkbox\" data-bind-checked=\"things | has 'thing1'\" checked=\"true\"><\/input>\n```\n\n## first(iterable) : value\n\nReturns the first value from an `array`:\n\n```html\n<span data-context-firstComment=\"page.comments | first\"><\/span>\n```\n\n## meta(value, keypath) : value\n\n## interpolate(string, valuesObject) : string\n\nAllows you to use string interpolation:\n\n```html\n<span data-bind=\"'The page title is %{title}%' | interpolate {'title': 'page.title'}\"><\/span>\n```\n\n## withArguments(function, curriedArguments...) : function\n\nEnsures that the function is called with the supplied arguments in addition to the arguments it would normally be called with. This is a form of currying. The argument order will be the curried arguments (those passed to withArguments) first, then the regular arguments. In the case of a click event, the regular arguments are node, event, view.\n\n```coffeescript\nclass Sample.CloseWindowView extends Batman.View\n  html: '<span data-event-click=\"closeWindow | withArguments true\"><\/span>'\n\n  closeWindow: (actuallyClose) ->\n    window.close() if actuallyClose\n```\n\n```html\n<div data-view=\"CloseWindowView\"><\/div>\n```\n\n## escape(value) : string\n\nEscapes HTML in the input value:\n\n```html\n<textarea data-bind=\"page.body_html | escape\"><\/textarea>\n```\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e9c5d562fa531010ab2cd904d78df7d324fb4840","subject":"Update 000_sockets.litcoffee","message":"Update 000_sockets.litcoffee","repos":"delightsoft\/DSCloudState","old_file":"spec\/000_sockets.litcoffee","new_file":"spec\/000_sockets.litcoffee","new_contents":"CloudState \u0440\u0430\u0431\u043e\u0442\u0430\u0435\u0442 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u044f \u0434\u0432\u0435 \u0431\u0438\u0431\u043b\u0438\u043e\u0442\u0435\u043a\u0438: socket.io \u0438 socket.io-client.\n\n    require '.\/_globals'\n    socketIO = require 'socket.io'\n    socketIOClient = require 'socket.io-client'\n    socketIOMock = require '.\/_socket.io-mock'\n\n\u0422\u0435\u0441\u0442\u0438\u0440\u043e\u0432\u0430\u0442\u044c \u043c\u043e\u0436\u043d\u043e \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u044f \u0440\u0435\u0430\u043b\u044c\u043d\u044b\u0435 \u0431\u0438\u0431\u043b\u0438\u043e\u0442\u0435\u043a\u0438.\n\n    describe '000 Sockets:', ->\n\n      afterEach ->\n\n        @serverSocket?.close()\n        @clientSocket?.close()\n\n\u0414\u043b\u044f \u043f\u0440\u043e\u0441\u0442\u043e\u0433\u043e \u0441\u043e\u0435\u0434\u0438\u043d\u0435\u043d\u0438\u044f \u0434\u043e\u0441\u0442\u0430\u0442\u043e\u0447\u043d\u043e \u043d\u0430\u0447\u0430\u0442\u044c \u0441\u043b\u0443\u0448\u0430\u0442\u044c \u043d\u0430 \u043f\u043e\u0440\u0442\u0443, \u0430 \u0434\u0440\u0443\u0433\u043e\u0439 \u0441\u0442\u043e\u0440\u043e\u043d\u0435 \u0432\u044b\u043f\u043e\u043b\u043d\u0438\u0442\u044c connect().\n\n      fit '010', (done) ->\n\n        (@serverSocket = socketIO(3990)).of('\/addr').on 'connection', (socket) =>\n\n\u041f\u043e\u0441\u043b\u0435 \u0441\u043e\u0437\u0434\u0430\u043d\u0438\u044f \u0441\u043e\u0435\u0434\u0438\u043d\u0435\u043d\u0438\u044f \u043c\u043e\u0436\u043d\u043e \u043e\u0442\u043f\u0440\u0430\u0432\u043b\u044f\u0442\u044c \u0441\u0432\u043e\u0438 \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u044f\n\n          socket.emit 'msg',  arg = [ { name: 'addFrame', args: [ 'frame 1' ] } ], '2nd argument'\n\n\u041f\u0440\u0438\u043c.: \u0411\u0443\u0434\u0435\u0442 \u043f\u0435\u0440\u0435\u0434\u0430\u043d\u043d\u043e \u0442\u043e \u0437\u043d\u0430\u0447\u0435\u043d\u0438\u0435, \u043a\u043e\u0442\u043e\u0440\u043e\u0435 \u0431\u044b\u043b\u043e \u0432 \u043c\u043e\u043c\u0435\u043d\u0442 \u0432\u044b\u0437\u043e\u0432\u0430\n\n          arg.length = 0\n\n          return\n\n        @clientSocket = socketIOClient('http:\/\/localhost:3990\/addr')\n\n\u0418 \u043f\u043e\u043b\u0443\u0447\u0430\u0442\u044c \u044d\u0442\u0438 \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u044f \u043d\u0430 \u0434\u0440\u0443\u0433\u043e\u0439 \u0441\u0442\u043e\u0440\u043e\u043d\u0435.\n\n        @clientSocket.on 'msg', (args, secondArg) ->\n\n          expect(args).toEqual  [ { name: 'addFrame', args: [ 'frame 1' ] } ]\n\n          expect(secondArg).toBe '2nd argument'\n\n\u0418 \u0435\u0441\u043b\u0438 \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u0435 \u043f\u0440\u0438\u0448\u043b\u043e, \u0442\u043e \u043f\u0440\u043e\u0432\u0435\u0440\u043a\u0430 \u043f\u0440\u043e\u0448\u043b\u0430 \u0443\u0441\u043f\u0435\u0448\u043d\u043e\n\n          done()\n\n          return\n\n\u041e\u0434\u043d\u0430\u043a\u043e, \u0434\u043b\u044f \u0442\u0435\u0441\u0442\u0438\u0440\u043e\u0432\u0430\u043d\u0438\u044f \u0441\u043b\u043e\u0436\u043d\u044b\u0445 \u0441\u0446\u0435\u043d\u0430\u0440\u0438\u0435\u0432 \u043d\u0443\u0436\u043d\u043e \u043a\u0430\u043a \u0442\u043e \u0438\u043c\u0438\u0442\u0438\u0440\u043e\u0432\u0430\u0442\u044c \u0432\u0440\u0435\u043c\u0435\u043d\u043d\u043e\u0435 \u043f\u0440\u043e\u043f\u0430\u0434\u0430\u043d\u0438\u0435 \u0441\u043e\u0435\u0434\u0438\u043d\u0435\u043d\u0438\u044f.  \u0410 \u044d\u0442\u043e \u0441\u0434\u0435\u043b\u0430\u0442\u044c\n\u043d\u0430 \u0440\u0435\u0430\u043b\u044c\u043d\u044b\u0445 \u0441\u043e\u043a\u0435\u0442\u0430\u0445 \u0441\u043b\u043e\u0436\u043d\u043e.  \u041f\u043e\u0442\u043e\u043c\u0443 \u0431\u0443\u0434\u0435\u043c \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c socket.io-mock\n\n    describe '000 Sockets (2):', ->\n\n      beforeEach ->\n        @socketIOMock = new socketIOMock()\n\n\u041f\u0440\u043e\u0441\u0442\u043e\u0439 \u0441\u0446\u0435\u043d\u0430\u0440\u0438\u0439 \u0434\u043b\u044f socket.io-mock - \u044d\u0442\u043e \u0441\u043e\u0437\u0434\u0430\u0442\u044c \u0441\u0435\u0440\u0432\u0435\u0440\u043d\u044b\u0439 \u0441\u043e\u043a\u0435\u0442, \u043f\u043e\u0434\u043a\u043b\u044e\u0447\u0438\u0442\u044c \u043a \u043d\u0435\u043c\u0443 \u043a\u043b\u0438\u0435\u043d\u0442\u0441\u043a\u0438\u0439 \u0441\u043e\u043a\u0435\u0442,\n\n      it '010', (done) ->\n\n\u0447\u0435\u0440\u0435\u0437 \u0443\u043a\u0430\u0437\u0430\u043d\u0438\u0435 \u0442\u043e\u0433\u043e \u0436\u0435 namespace.\n\n        @socketIOMock.of('\/testNamespace').on 'connection', (socket) ->\n\n\u041f\u043e\u0441\u043b\u0435 \u0447\u0435\u0433\u043e \u043f\u0435\u0440\u0435\u0434\u0430\u0442\u044c \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u0435 \u043e\u0442 \u043a\u043b\u0438\u0435\u043d\u0442\u0430 \u043d\u0430 \u0441\u0435\u0440\u0432\u0435\u0440,\n\n          socket.on 'request', (req1, req2) ->\n            expect(req1).toBe 'req1'\n            expect(req2).toBe 'req2'\n\n\u0430 \u0432 \u043e\u0442\u0432\u0435\u0442 \u0441\u0435\u0440\u0432\u0435\u0440 \u043e\u0442\u0432\u0435\u0442\u0438\u0442 \u043a\u043b\u0438\u0435\u043d\u0442\u0443.\n\n            socket.emit 'response', 'resp1', 'resp2'\n\n            return # on 'request'\n\n\u041f\u043e\u0441\u043b\u0435 \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u044f \u043e\u0442\u0432\u0435\u0442\u0430, \u043a\u043b\u0438\u0435\u043d\u0442 \u043e\u0442\u043a\u043b\u044e\u0447\u0438\u0442\u0441\u044f.\n\n          socket.on 'disconnect', ->\n\n\u0414\u043e\u0441\u0442\u0430\u0442\u043e\u0447\u043d\u043e \u0434\u043b\u044f \u043f\u0435\u0440\u0432\u043e\u0433\u043e \u0442\u0435\u0441\u0442\u0430\n\n            done()\n\n            return # on 'disconnect'\n\n\n        (client = new @socketIOMock.Client).connect '\/testNamespace'\n\n\u0414\u043b\u044f \u043f\u043e\u043b\u043d\u043e\u0442\u044b \u0438\u043c\u0438\u0442\u0430\u0446\u0438\u0438, \u0441\u043e\u0431\u044b\u0442\u0438\u044f \u043f\u0440\u043e\u0438\u0441\u0445\u043e\u0434\u044f\u0442 \u0442\u043e\u043b\u044c\u043a\u043e \u043d\u0430 \u0441\u043b\u0435\u0434\u0443\u044e\u0449\u0438\u0439 tick. \u0418 on 'connect' \u043c\u043e\u0436\u043d\u043e \u043e\u0431\u044a\u044f\u0432\u0438\u0442\u044c \u043f\u043e\u0441\u043b\u0435 \u0442\u043e\u0433\u043e\n\u043a\u0430\u043a \u0432\u044b\u0437\u0432\u0430\u043d\u0430 \u043e\u043f\u0435\u0440\u0430\u0446\u0438\u0438 connect.\n\n\/\/        client = new @socketIOMock.Client\n\n        client.on 'connect', ->\n\n          client.emit 'request', 'req1', 'req2'\n\n\u0418 on 'response' \u043c\u043e\u0436\u043d\u043e \u0441\u0434\u0435\u043b\u0430\u0442\u044c \u043f\u043e\u0441\u043b\u0435 \u0442\u043e\u0433\u043e \u043a\u0430\u043a \u0441\u0434\u0435\u043b\u0430\u043d emit\n\n          client.on 'response', (resp1, resp2) ->\n\n            expect(resp1).toBe 'resp1'\n            expect(resp2).toBe 'resp2'\n\n            client.close()\n\n            return # on 'response'\n\n          return # on 'connect'\n\n\/\/        client.connect '\/testNamespace'\n","old_contents":"CloudState \u0440\u0430\u0431\u043e\u0442\u0430\u0435\u0442 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u044f \u0434\u0432\u0435 \u0431\u0438\u0431\u043b\u0438\u043e\u0442\u0435\u043a\u0438: socket.io \u0438 socket.io-client.\n\n    require '.\/_globals'\n    socketIO = require 'socket.io'\n    socketIOClient = require 'socket.io-client'\n    socketIOMock = require '.\/_socket.io-mock'\n\n\u0422\u0435\u0441\u0442\u0438\u0440\u043e\u0432\u0430\u0442\u044c \u043c\u043e\u0436\u043d\u043e \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u044f \u0440\u0435\u0430\u043b\u044c\u043d\u044b\u0435 \u0431\u0438\u0431\u043b\u0438\u043e\u0442\u0435\u043a\u0438.\n\n    describe '000 Sockets:', ->\n\n      afterEach ->\n\n        @serverSocket?.close()\n        @clientSocket?.close()\n\n\u0414\u043b\u044f \u043f\u043e\u0441\u0442\u043e\u0433\u043e \u0441\u043e\u0435\u0434\u0438\u043d\u0435\u043d\u0438\u044f \u0434\u043e\u0441\u0442\u0430\u0442\u043e\u0447\u043d\u043e \u043d\u0430\u0447\u0430\u0442\u044c \u0441\u043b\u0443\u0448\u0430\u0442\u044c \u043d\u0430 \u043f\u043e\u0440\u0442\u0443, \u0430 \u0434\u0440\u0443\u0433\u043e\u0439 \u0441\u0442\u043e\u0440\u043e\u043d\u0435 \u0432\u044b\u043f\u043e\u043b\u043d\u0438\u0442\u044c connect().\n\n      fit '010', (done) ->\n\n        (@serverSocket = socketIO(3990)).of('\/addr').on 'connection', (socket) =>\n\n\u041f\u043e\u0441\u043b\u0435 \u0441\u043e\u0437\u0434\u0430\u043d\u0438\u044f \u0441\u043e\u0435\u0434\u0438\u043d\u0435\u043d\u0438\u044f \u043c\u043e\u0436\u043d\u043e \u043e\u0442\u043f\u0440\u0430\u0432\u043b\u044f\u0442\u044c \u0441\u0432\u043e\u0438 \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u044f\n\n          socket.emit 'msg',  arg = [ { name: 'addFrame', args: [ 'frame 1' ] } ], '2nd argument'\n\n\u041f\u0440\u0438\u043c.: \u0411\u0443\u0434\u0435\u0442 \u043f\u0435\u0440\u0435\u0434\u0430\u043d\u043d\u043e \u0442\u043e \u0437\u043d\u0430\u0447\u0435\u043d\u0438\u0435, \u043a\u043e\u0442\u043e\u0440\u043e\u0435 \u0431\u044b\u043b\u043e \u0432 \u043c\u043e\u043c\u0435\u043d\u0442 \u0432\u044b\u0437\u043e\u0432\u0430\n\n          arg.length = 0\n\n          return\n\n        @clientSocket = socketIOClient('http:\/\/localhost:3990\/addr')\n\n\u0418 \u043f\u043e\u043b\u0443\u0447\u0430\u0442\u044c \u044d\u0442\u0438 \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u044f \u043d\u0430 \u0434\u0440\u0443\u0433\u043e\u0439 \u0441\u0442\u043e\u0440\u043e\u043d\u0435.\n\n        @clientSocket.on 'msg', (args, secondArg) ->\n\n          expect(args).toEqual  [ { name: 'addFrame', args: [ 'frame 1' ] } ]\n\n          expect(secondArg).toBe '2nd argument'\n\n\u0418 \u0435\u0441\u043b\u0438 \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u0435 \u043f\u0440\u0438\u0448\u043b\u043e, \u0442\u043e \u043f\u0440\u043e\u0432\u0435\u0440\u043a\u0430 \u043f\u0440\u043e\u0448\u043b\u0430 \u0443\u0441\u043f\u0435\u0448\u043d\u043e\n\n          done()\n\n          return\n\n\u041e\u0434\u043d\u0430\u043a\u043e, \u0434\u043b\u044f \u0442\u0435\u0441\u0442\u0438\u0440\u043e\u0432\u0430\u043d\u0438\u044f \u0441\u043b\u043e\u0436\u043d\u044b\u0445 \u0441\u0446\u0435\u043d\u0430\u0440\u0438\u0435\u0432 \u043d\u0443\u0436\u043d\u043e \u043a\u0430\u043a \u0442\u043e \u0438\u043c\u0438\u0442\u0438\u0440\u043e\u0432\u0430\u0442\u044c \u0432\u0440\u0435\u043c\u0435\u043d\u043d\u043e\u0435 \u043f\u0440\u043e\u043f\u0430\u0434\u0430\u043d\u0438\u0435 \u0441\u043e\u0435\u0434\u0438\u043d\u0435\u043d\u0438\u044f.  \u0410 \u044d\u0442\u043e \u0441\u0434\u0435\u043b\u0430\u0442\u044c\n\u043d\u0430 \u0440\u0435\u0430\u043b\u044c\u043d\u044b\u0445 \u0441\u043e\u043a\u0435\u0442\u0430\u0445 \u0441\u043b\u043e\u0436\u043d\u043e.  \u041f\u043e\u0442\u043e\u043c\u0443 \u0431\u0443\u0434\u0435\u043c \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c socket.io-mock\n\n    describe '000 Sockets (2):', ->\n\n      beforeEach ->\n        @socketIOMock = new socketIOMock()\n\n\u041f\u0440\u043e\u0441\u0442\u043e\u0439 \u0441\u0446\u0435\u043d\u0430\u0440\u0438\u0439 \u0434\u043b\u044f socket.io-mock - \u044d\u0442\u043e \u0441\u043e\u0437\u0434\u0430\u0442\u044c \u0441\u0435\u0440\u0432\u0435\u0440\u043d\u044b\u0439 \u0441\u043e\u043a\u0435\u0442, \u043f\u043e\u0434\u043a\u043b\u044e\u0447\u0438\u0442\u044c \u043a \u043d\u0435\u043c\u0443 \u043a\u043b\u0438\u0435\u043d\u0442\u0441\u043a\u0438\u0439 \u0441\u043e\u043a\u0435\u0442,\n\n      it '010', (done) ->\n\n\u0447\u0435\u0440\u0435\u0437 \u0443\u043a\u0430\u0437\u0430\u043d\u0438\u0435 \u0442\u043e\u0433\u043e \u0436\u0435 namespace.\n\n        @socketIOMock.of('\/testNamespace').on 'connection', (socket) ->\n\n\u041f\u043e\u0441\u043b\u0435 \u0447\u0435\u0433\u043e \u043f\u0435\u0440\u0435\u0434\u0430\u0442\u044c \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u0435 \u043e\u0442 \u043a\u043b\u0438\u0435\u043d\u0442\u0430 \u043d\u0430 \u0441\u0435\u0440\u0432\u0435\u0440,\n\n          socket.on 'request', (req1, req2) ->\n            expect(req1).toBe 'req1'\n            expect(req2).toBe 'req2'\n\n\u0430 \u0432 \u043e\u0442\u0432\u0435\u0442 \u0441\u0435\u0440\u0432\u0435\u0440 \u043e\u0442\u0432\u0435\u0442\u0438\u0442 \u043a\u043b\u0438\u0435\u043d\u0442\u0443.\n\n            socket.emit 'response', 'resp1', 'resp2'\n\n            return # on 'request'\n\n\u041f\u043e\u0441\u043b\u0435 \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u044f \u043e\u0442\u0432\u0435\u0442\u0430, \u043a\u043b\u0438\u0435\u043d\u0442 \u043e\u0442\u043a\u043b\u044e\u0447\u0438\u0442\u0441\u044f.\n\n          socket.on 'disconnect', ->\n\n\u0414\u043e\u0441\u0442\u0430\u0442\u043e\u0447\u043d\u043e \u0434\u043b\u044f \u043f\u0435\u0440\u0432\u043e\u0433\u043e \u0442\u0435\u0441\u0442\u0430\n\n            done()\n\n            return # on 'disconnect'\n\n\n        (client = new @socketIOMock.Client).connect '\/testNamespace'\n\n\u0414\u043b\u044f \u043f\u043e\u043b\u043d\u043e\u0442\u044b \u0438\u043c\u0438\u0442\u0430\u0446\u0438\u0438, \u0441\u043e\u0431\u044b\u0442\u0438\u044f \u043f\u0440\u043e\u0438\u0441\u0445\u043e\u0434\u044f\u0442 \u0442\u043e\u043b\u044c\u043a\u043e \u043d\u0430 \u0441\u043b\u0435\u0434\u0443\u044e\u0449\u0438\u0439 tick. \u0418 on 'connect' \u043c\u043e\u0436\u043d\u043e \u043e\u0431\u044a\u044f\u0432\u0438\u0442\u044c \u043f\u043e\u0441\u043b\u0435 \u0442\u043e\u0433\u043e\n\u043a\u0430\u043a \u0432\u044b\u0437\u0432\u0430\u043d\u0430 \u043e\u043f\u0435\u0440\u0430\u0446\u0438\u0438 connect.\n\n\/\/        client = new @socketIOMock.Client\n\n        client.on 'connect', ->\n\n          client.emit 'request', 'req1', 'req2'\n\n\u0418 on 'response' \u043c\u043e\u0436\u043d\u043e \u0441\u0434\u0435\u043b\u0430\u0442\u044c \u043f\u043e\u0441\u043b\u0435 \u0442\u043e\u0433\u043e \u043a\u0430\u043a \u0441\u0434\u0435\u043b\u0430\u043d emit\n\n          client.on 'response', (resp1, resp2) ->\n\n            expect(resp1).toBe 'resp1'\n            expect(resp2).toBe 'resp2'\n\n            client.close()\n\n            return # on 'response'\n\n          return # on 'connect'\n\n\/\/        client.connect '\/testNamespace'\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bbffc5b4320e1383f4c26bff7e59ecf869298a67","subject":"Replace deprecated MongoDB driver methods","message":"Replace deprecated MongoDB driver methods\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/model\/Document.litcoffee","new_file":"coffee\/model\/Document.litcoffee","new_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n## Class: Doc\n\n### Params\n\n* `string` type - document type\n* `string` id - document id\n\n### Return\n\nNew `Doc`.\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n      @db   = mongo[type]\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n      @type = type\n      @data = {}\n      @chit = false\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if data\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n## Doc.exists\n\nCheck if document exists.\n\n### Return\n\nReturns `true` if document exists; otherwise `false`.\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n## Doc.getId\n\nGet document id (ObjectID) for current document.\n\n### Return\n\nReturns an `ObjectID` if the document has an id; otherwise `null`.\n\n    Doc.prototype.getId = ->\n      @id\n\n\n## Doc.wasCacheHit\n\nCheck if document request was a cache hit.\n\n### Return\n\nReturns `true` if document request was a cache hit; otherwise `false`.\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n## Doc.isNotModifiedSince\n\nCheck if document has not been modified since a given timestamp.\n\n### Params\n\n* `string` time - timestamp to check against.\n\n### Return\n\nReturns `true` if document has not been modified since given tmestamp; otherwise\n`false`.\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make unix timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n## doc.isMatch\n\nCheck if checksum, or Etag, matche current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturns `true` if checksum matches the current checksum; otherwise `false`.\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n## doc.isNoneMatch\n\nCheck if checksum, or Etag, doesnt match current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturn `true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n## Doc.get\n\nGet cached data for current document.\n\n### Params\n\n* `string` key - get specific object property\n\n### Return\n\nReturns an `object` if `key` is `undefined`; otherwise `string`. Will retur\n`undefined` if the given key does not exist.\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n## doc.getFull\n\n### Params\n\n* `object` filter - control which object properties are returned\n* `function` cb - callback function (`Error` err, `object` data)\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.getFull = (filter, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @db.findOne _id: @id, filter, cb\n\n\n## Doc.insert\n\nInserts a document into databse.\n\n### Params\n\n* `object` data - data to insert for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.replace\n\nReplaces all document data in database.\n\n### Params\n\n* `object` data - replacement data for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.update\n\nPartially update the document-data in database. This is some times refered to as\nPATCH in a HTTP \/ REST context.\n\n### Params\n\n* `object` data - replacement object for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n## Doc.delete\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n### Params\n\n* `function`  cb - callback function (`Error` err).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet'\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n\n","old_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n## Class: Doc\n\n### Params\n\n* `string` type - document type\n* `string` id - document id\n\n### Return\n\nNew `Doc`.\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n      @db   = mongo[type]\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n      @type = type\n      @data = {}\n      @chit = false\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if data\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n## Doc.exists\n\nCheck if document exists.\n\n### Return\n\nReturns `true` if document exists; otherwise `false`.\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n## Doc.getId\n\nGet document id (ObjectID) for current document.\n\n### Return\n\nReturns an `ObjectID` if the document has an id; otherwise `null`.\n\n    Doc.prototype.getId = ->\n      @id\n\n\n## Doc.wasCacheHit\n\nCheck if document request was a cache hit.\n\n### Return\n\nReturns `true` if document request was a cache hit; otherwise `false`.\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n## Doc.isNotModifiedSince\n\nCheck if document has not been modified since a given timestamp.\n\n### Params\n\n* `string` time - timestamp to check against.\n\n### Return\n\nReturns `true` if document has not been modified since given tmestamp; otherwise\n`false`.\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make unix timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n## doc.isMatch\n\nCheck if checksum, or Etag, matche current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturns `true` if checksum matches the current checksum; otherwise `false`.\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n## doc.isNoneMatch\n\nCheck if checksum, or Etag, doesnt match current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturn `true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n## Doc.get\n\nGet cached data for current document.\n\n### Params\n\n* `string` key - get specific object property\n\n### Return\n\nReturns an `object` if `key` is `undefined`; otherwise `string`. Will retur\n`undefined` if the given key does not exist.\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n## doc.getFull\n\n### Params\n\n* `object` filter - control which object properties are returned\n* `function` cb - callback function (`Error` err, `object` data)\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.getFull = (filter, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @db.findOne _id: @id, filter, cb\n\n\n## Doc.insert\n\nInserts a document into databse.\n\n### Params\n\n* `object` data - data to insert for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.save data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.replace\n\nReplaces all document data in database.\n\n### Params\n\n* `object` data - replacement data for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.update _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.update\n\nPartially update the document-data in database. This is some times refered to as\nPATCH in a HTTP \/ REST context.\n\n### Params\n\n* `object` data - replacement object for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.update _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n## Doc.delete\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n### Params\n\n* `function`  cb - callback function (`Error` err).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet'\n      @db.update _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"0148a1406bf97e0e61335af0c8294f1fac808cbc","subject":"in. jokes","message":"in. jokes\n","repos":"nomilous\/in.","old_file":"in.jokes\/spandex.litcoffee","new_file":"in.jokes\/spandex.litcoffee","new_contents":"#! \/usr\/bin\/env coffee\n\nThe expander supports multiple asyncronous functions.\n\nTo achieve that it needed to do some peculiar things.\n\n__Very peculiar!__\n\nThings that [some](https:\/\/www.google.co.za\/search?q=uptight+people&espv=2&biw=1063&bih=1058&source=lnms&tbm=isch&sa=X&ei=q6CJVYTyIpPB7Ab95YLQBA&ved=0CAYQ_AUoAQ#tbm=isch&q=uptight) may disaprove of.\n\nLike wearing [spandex in public](https:\/\/www.google.co.za\/search?q=spandex+in+public+nuts&espv=2&biw=1063&bih=1058&tbm=isch&source=lnms&sa=X&ei=5Z-JVez6KeWY7gbl_oCYAg&ved=0CAYQ_AUoAQ#tbm=isch&q=spandex+in+public).\n\nIt broke the expansion (to be eval'd) into pieces and substituted a array ($e) for each function\n\nThe results of the division are loaded into a variable called `spandex`... \n\nWhich happens to be in scope at eval.\n\n    require('..\/')\n\n    $$in (arg) ->\n\n        ### in(arg).as {{1}}###\n\n        console.log arg\n\n\n","old_contents":"#! \/usr\/bin\/env coffee\n\nThe expander supports multiple asyncronous functions.\n\nTo achieve that it needed to do some peculiar things.\n\nThings that [some](https:\/\/www.google.co.za\/search?q=uptight+people&espv=2&biw=1063&bih=1058&source=lnms&tbm=isch&sa=X&ei=q6CJVYTyIpPB7Ab95YLQBA&ved=0CAYQ_AUoAQ#tbm=isch&q=uptight) may disaprove of.\n\nLike wearing [spandex in public](https:\/\/www.google.co.za\/search?q=spandex+in+public+nuts&espv=2&biw=1063&bih=1058&tbm=isch&source=lnms&sa=X&ei=5Z-JVez6KeWY7gbl_oCYAg&ved=0CAYQ_AUoAQ#tbm=isch&q=spandex+in+public).\n\nIt broke the expansion (to be eval'd) into pieces and substituted a array ($e) for each function\n\nThe results of the division are loaded into a variable called `spandex`... \n\nWhich happens to be in scope at eval.\n\n    require('..\/')\n\n    $$in (arg) ->\n\n        ### in(arg).as {{1}}###\n\n        console.log arg\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ce5082a5377f4134b54cea10e1d4ae7003cca5e9","subject":"Damn, the documentation is also part of the unit testing. Bloody litterate coffee :)","message":"Damn, the documentation is also part of the unit testing. Bloody litterate coffee :)\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n`App.Model.create` is a convenience method that is basically equivalent to\ncalling `new App.Model` and 'record.save()' :\n\n    asyncTest \"@create is an convience method around new and #save\", ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      # New and save\n      record = new Post(name: 'aName')\n      record.save()\n\n      # @create convenience method\n      other_record = Post.create name: 'aName', ->\n\n      delay ->\n        equal record.get('name'), other_record.get('name')\n        equal record.isNew(), false\n        equal other_record.isNew(), false\n\n  _Note_ : Pay attention to the fact that attributes is an empty object `{}` by\n  default. This means `Model.create({my_attribute: 'value'})` does _not_ work like\n  in Rails and does nothing. If you want to skip the callback, use\n  `Model.create(attributes, (->))`\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key that `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object passed to and modified by each encoder, and eventually becomes the return value of the `toJSON` call.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the raw value received from the storage adapter.\n + `key` is the key that `value` is stored under on the incoming data.\n + `incomingJSON` is the object which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object built up by the decoders and mixed into the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\nTo encode a `key` under a name which differs from that in the raw data, you can specify the `as` option with the raw key name. The `as` option can be either a string or function.\n\nIf you specify the `as` option as a function it will receive the following arguments:\n\n + `key` is the name which the `value` is stored under in the raw data.\n + `value` is the `value` of the `key` which will end up on the `record`.\n + `data` is the object which is modified by each encoder or decoder.\n + `record` is the record on which `toJSON` or `fromJSON` has been called.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\n    test '@encode accepts an as option to encode a key under a name which differs from that in the raw data', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: 'country_code'\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n    test '@encode accepts the as option as a function', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'countryCode',\n          as: (key) -> Batman.helpers.underscore(key)\n          encode: @defaultEncoder.encode\n          decode: @defaultEncoder.decode\n\n      record = new Shop(countryCode: 'SE')\n      deepEqual record.toJSON(), {country_code: 'SE'}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greater than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt accepts a callback with two arguments: any error that occurred, and an array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n  `App.Model.create` is a convenience method that is basically equivalent to\n\n    model = new App.Model(attributes)\n    model.save(callback)\n\n  _Note_ : Pay attention to the fact that attributes is an empty object `{}` by\n  default. This means `Model.create({my_attribute: 'value'})` does _not_ work like\n  in Rails and does nothing. If you want to skip the callback, use\n  `Model.create(attributes, (->))`\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` is a `Batman.ErrorsSet`, which is simply a `Batman.Set` of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## ::isNew() : boolean\nReturns whether or not the instance represents a record that hasn't yet been persisted to the server. The default implementation simply checks if `@get('id')` is undefined, but you could override this on your own models.\n\nIt is used to determine whether `record.save()` will perform a `create` action or a `save` action.\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## ::toJSON() : Object\n\nReturns a JavaScript object containing the attributes of the record, using any specified encoders.\n\n    test \"toJSON returns a JavaScript object with the record's attributes\", ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Talia al Ghul\", notorious: true)\n      criminal_json = criminal.toJSON()\n      equal criminal_json.name, \"Talia al Ghul\"\n      equal criminal_json.notorious, true\n\n\n## ::fromJSON() : Model\n\nReloads attributes of a record from a JavaScript object.\n\n    test 'fromJSON overwrites existing attributes', ->\n      class Criminal extends Batman.Model\n        @encode \"name\", \"notorious\"\n\n      criminal = new Criminal(name: \"Dr. Jonathan Crane\", notorious: false)\n      new_params =\n        name: \"Scarecrow\"\n        notorious: true\n      criminal.fromJSON(new_params)\n\n      equal criminal.get(\"notorious\"), true\n      equal criminal.get(\"name\"), \"Scarecrow\"\n\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## ::load(options = {}, callback)\n`Load` tries to read the record from its storage adapter. The options object will be passed to the storage adapter when it performs the `read` operation. The callback takes three parameters: error, the loaded record, and the environment. `Load`ing a record clears all errors on that record.\n\nIf the read operation fails or if the record is in a state which doesn't permit `load`, (for example, calling `load` on a deleted record) the callback will be invoked with an error.\n\n## ::save(options = {}, callback)\n`Save` [validates](http:\/\/localhost:4000\/docs\/api\/batman.model.html#prototype_function_validate) the record, and if it passes, fires the corresponding storage operation (defined by the `Batman.StorageAdapter` passed to  [`@persist`](\/docs\/api\/batman.model.html#class_function_persist)). When the storage operation is complete, the callback is invoked with two parameters: any JavaScript error and the record.\n\nIf the record [`isNew`](\/docs\/api\/batman.model.html#prototype_function_isnew), `save` performs a `create` operation. Otherwise, it performs a `save` operation.\n\nIf the record is not valid, the [validation errors](\/docs\/api\/batman.validationerror.html) will be passed to the first parameter of the callback function and the storage operation will not be performed.\n\n## ::destroy(options = {}, callback)\n\n`Destroy` fires the corresponding storage operation. The callback takes three arguments: JavaScript Error, the record, and the environment. If the operation is successful, the record is removed from its Model's [`loaded`](\/docs\/api\/batman.model.html#class_function_loaded) set.\n\n```coffeescript\ncriminal = new Criminal name: \"The penguin\"\ncriminal.destroy (err, record, env) ->\n  if err\n    console.log \"Oh no! #{record.get('name')} is still on the loose!\"\n```\n\nIf the record's current lifecycle state doesn't allow the `destroy` action, the callback will be invoked with a `Batman.StateMachine.InvalidTransitionError`. For example, this could occur if `destroy` is called on an already-destroyed record.\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method accepts a callback with two arguments: any JS error that occurred within the validator function, and the set of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s that the input generated.\n\nFor example:\n\n    test \"validate(callback) will call the callback only after all keys have been validated\", ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure for a model's field to to pass validation.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9e479395534119b194b4e1166b144fba1227e8d8","subject":"Support for creating routes without app lambda","message":"Support for creating routes without app lambda\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/app\/index.litcoffee","new_file":"src\/app\/index.litcoffee","new_contents":"# App\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    signal = require 'src\/signal'\n    db = require 'src\/db'\n    assert = require 'src\/assert'\n    Schema = require 'src\/schema'\n    Networking = require 'src\/networking'\n    Document = require 'src\/document'\n    Renderer = require 'src\/renderer'\n    Styles = require 'src\/styles'\n    Resources = require 'src\/resources'\n    Dict = require 'src\/dict'\n\n    AppRoute = require '.\/route'\n\n    bootstrapRoute = try require '.\/bootstrap\/route.node'\n\n    `\/\/<development>`\n    pkg = require 'package.json'\n    `\/\/<\/development>`\n\n    BASE_FILE_NAME_RE = \/(.+)\\.(?:node|server|client|browser|ios|android|native)\/\n    DEFAULT_CONFIG =\n        title: 'Neft.io Application'\n        protocol: 'http'\n        port: 3000\n        host: 'localhost'\n        language: 'en'\n        type: 'app'\n\n    exports = module.exports = (opts = {}, extraOpts = {}) ->\n        null\n        `\/\/<development>`\n        log.ok \"Welcome! Neft.io v#{pkg.version}; Feedback appreciated\"\n        log.warn \"Use this bundle only in development; type --release when it's ready\"\n        `\/\/<\/development>`\n\n        config = utils.clone DEFAULT_CONFIG\n        config = utils.mergeAll config, opts.config, extraOpts\n\n        app = new Dict\n\n## *Object* app.config = `{}`\n\nConfig object from the *package.json* file.\n\nCan be overriden in the *init.js* file.\n\n### type\n\nThe `app` type (the default one) uses renderer on the client side.\n\nThe `game` type uses special renderer (if exists) focused on more performance goals.\n\nThe `text` type always return HTML document with no renderer on the client side.\nIt's used for the crawlers (e.g. GoogleBot) or browsers with no javascript support.\n\n```javascript\n\/\/ package.json\n{\n    \"name\": \"neft.io app\",\n    \"version\": \"0.1.0\",\n    \"config\": {\n        \"title\": \"My first application!\",\n        \"protocol\": \"http\",\n        \"port\": 3000,\n        \"host\": \"localhost\",\n        \"language\": \"en\",\n        \"type\": \"app\"\n    }\n}\n\/\/ init.js\nmodule.exports = function(NeftApp) {\n    var app = NeftApp({ title: \"Overridden title\" });\n    console.log(app.config);\n    \/\/ {title: \"My first application!\", protocol: \"http\", port: ....}\n};\n```\n\n        app.config = config\n\n## *Networking* app.networking\n\nStandard Networking instance used to communicate\nwith the server and to create local requests.\n\nAll routes created by the *App.Route* uses this networking.\n\nHTTP protocol is used by default with the data specified in the *package.json*.\n\n        app.networking = new Networking\n            type: Networking.HTTP\n            protocol: config.protocol\n            port: parseInt(config.port, 10)\n            host: config.host\n            url: config.url\n            language: config.language\n\n## *Object* app.styles = `{}`\n\nFiles from the *styles* folder as *Function*s\nready to create new *Item*s.\n\n        app.styles = {}\n\n## *Object* app.components = `{}`\n\nFiles from the *components* folder as the *Document* instances.\n\n        app.components = {}\n\n## *Resources* app.resources\n\n        app.resources = do ->\n            if opts.resources\n                Resources.fromJSON(opts.resources)\n            else\n                new Resources\n\n## *Signal* app.onReady()\n\nCalled when all modules, components, styled etc. have been loaded.\n\n        signal.create app, 'onReady'\n\n        # config.type\n        config.type ?= 'app'\n        assert.ok utils.has(['app', 'game', 'text'], config.type), \"Unexpected app.config.type value. Accepted app\/game\/text, but '#{config.type}' got.\"\n\n        app.Route = AppRoute app\n\n## *Dict* app.cookies\n\nOn the client side, this object refers to the last received cookies\nfrom the networking request.\n\nOn the server side, this cookies object are added into the each networking response.\n\nBy default, client has *clientId* and *sessionId* hashes.\n\n```javascript\napp.cookies.onChange(function(key){\n    console.log('cookie changed', key, this[key]);\n});\n```\n\n```xml\n<h1>Your clientId<\/h1>\n<em>${context.app.cookies.clientId}<\/em>\n```\n\n        # cookies\n        COOKIES_KEY = '__neft_cookies'\n        IS_CLIENT = not process.env.NEFT_SERVER\n        app.cookies = Dict()\n        onCookiesReady = (dict) ->\n            app.cookies = dict\n            if IS_CLIENT\n                dict.set 'sessionId', utils.uid(16)\n        db.get COOKIES_KEY, db.OBSERVABLE, (err, dict) ->\n            if dict\n                onCookiesReady dict\n            else\n                if IS_CLIENT\n                    cookies = {clientId: utils.uid(16)}\n                else\n                    cookies = {}\n                db.set COOKIES_KEY, cookies, (err) ->\n                    db.get COOKIES_KEY, db.OBSERVABLE, (err, dict) ->\n                        if dict\n                            onCookiesReady dict\n        app.networking.onRequest (req, res) ->\n            if IS_CLIENT\n                utils.merge req.cookies, app.cookies\n            else\n                utils.merge res.cookies, app.cookies\n            req.onLoadEnd.listeners.unshift ->\n                if IS_CLIENT\n                    for key, val of res.cookies\n                        unless utils.isEqual(app.cookies[key], val)\n                            app.cookies.set key, val\n                return\n            , null\n            return\n\n        # propagate data\n        Renderer.setResources app.resources\n        Renderer.setServerUrl app.networking.url\n        Renderer.onLinkUri (uri) ->\n            app.networking.createLocalRequest\n                method: Networking.Request.GET\n                type: Networking.Request.HTML_TYPE\n                uri: uri\n        app.documentScripts = utils.arrayToObject opts.scripts,\n            (index, elem) -> elem.name,\n            (index, elem) -> elem.file\n        Document.Scripts.initialize app.documentScripts\n\n        # set styles window item\n        if opts.styles?\n            for style in opts.styles\n                if style.name is '__windowItem__'\n                    style.file._init windowItem: null\n                    windowStyle = style.file._main document: null\n                    break\n\n        app.windowItem = windowStyleItem = windowStyle?.item\n        assert.ok windowStyleItem, '__windowItem__ style must be defined'\n        Renderer.setWindowItem windowStyleItem\n\n        if opts.styles?\n            stylesInitObject =\n                windowItem: windowStyleItem\n\n            # initialize styles\n            for style in opts.styles when style.name?\n                if style.name isnt '__windowItem__'\n                    style.file._init stylesInitObject\n                app.styles[style.name] = style.file\n\n        # load styles\n        Styles\n            windowStyle: windowStyle\n            styles: app.styles\n            queries: opts.styleQueries\n            resources: app.resources\n\n        # load bootstrap\n        bootstrapRoute? app\n\n        # load app extensions\n        if utils.isObject(opts.extensions)\n            for ext in opts.extensions\n                ext app\n\n        # exports app classes\n        exports.app =\n            Route: app.Route\n\n        # load components\n        for component in opts.components when component.name?\n            app.components[component.name] = Document.fromJSON component.file\n\n        # load routes\n        for route in opts.routes\n            if typeof route is 'function'\n                route = route app\n            if utils.isPlainObject(route.file)\n                for method, routeOpts of route.file\n                    if utils.isObject(routeOpts)\n                        new app.Route method, routeOpts\n\n        # provide default index route\n        if utils.isEmpty(opts.routes)\n            new app.Route 'get \/', {}\n\n        # emit ready signal\n        app.onReady.emit()\n\n        app\n","old_contents":"# App\n\n    'use strict'\n\n    utils = require 'src\/utils'\n    log = require 'src\/log'\n    signal = require 'src\/signal'\n    db = require 'src\/db'\n    assert = require 'src\/assert'\n    Schema = require 'src\/schema'\n    Networking = require 'src\/networking'\n    Document = require 'src\/document'\n    Renderer = require 'src\/renderer'\n    Styles = require 'src\/styles'\n    Resources = require 'src\/resources'\n    Dict = require 'src\/dict'\n\n    AppRoute = require '.\/route'\n\n    bootstrapRoute = try require '.\/bootstrap\/route.node'\n\n    `\/\/<development>`\n    pkg = require 'package.json'\n    `\/\/<\/development>`\n\n    BASE_FILE_NAME_RE = \/(.+)\\.(?:node|server|client|browser|ios|android|native)\/\n    DEFAULT_CONFIG =\n        title: 'Neft.io Application'\n        protocol: 'http'\n        port: 3000\n        host: 'localhost'\n        language: 'en'\n        type: 'app'\n\n    exports = module.exports = (opts = {}, extraOpts = {}) ->\n        null\n        `\/\/<development>`\n        log.ok \"Welcome! Neft.io v#{pkg.version}; Feedback appreciated\"\n        log.warn \"Use this bundle only in development; type --release when it's ready\"\n        `\/\/<\/development>`\n\n        config = utils.clone DEFAULT_CONFIG\n        config = utils.mergeAll config, opts.config, extraOpts\n\n        app = new Dict\n\n## *Object* app.config = `{}`\n\nConfig object from the *package.json* file.\n\nCan be overriden in the *init.js* file.\n\n### type\n\nThe `app` type (the default one) uses renderer on the client side.\n\nThe `game` type uses special renderer (if exists) focused on more performance goals.\n\nThe `text` type always return HTML document with no renderer on the client side.\nIt's used for the crawlers (e.g. GoogleBot) or browsers with no javascript support.\n\n```javascript\n\/\/ package.json\n{\n    \"name\": \"neft.io app\",\n    \"version\": \"0.1.0\",\n    \"config\": {\n        \"title\": \"My first application!\",\n        \"protocol\": \"http\",\n        \"port\": 3000,\n        \"host\": \"localhost\",\n        \"language\": \"en\",\n        \"type\": \"app\"\n    }\n}\n\/\/ init.js\nmodule.exports = function(NeftApp) {\n    var app = NeftApp({ title: \"Overridden title\" });\n    console.log(app.config);\n    \/\/ {title: \"My first application!\", protocol: \"http\", port: ....}\n};\n```\n\n        app.config = config\n\n## *Networking* app.networking\n\nStandard Networking instance used to communicate\nwith the server and to create local requests.\n\nAll routes created by the *App.Route* uses this networking.\n\nHTTP protocol is used by default with the data specified in the *package.json*.\n\n        app.networking = new Networking\n            type: Networking.HTTP\n            protocol: config.protocol\n            port: parseInt(config.port, 10)\n            host: config.host\n            url: config.url\n            language: config.language\n\n## *Object* app.routes = `{}`\n\nFiles from the *routes* folder with objects returned by their exported functions.\n\n        app.routes = {}\n\n## *Object* app.styles = `{}`\n\nFiles from the *styles* folder as *Function*s\nready to create new *Item*s.\n\n        app.styles = {}\n\n## *Object* app.components = `{}`\n\nFiles from the *components* folder as the *Document* instances.\n\n        app.components = {}\n\n## *Resources* app.resources\n\n        app.resources = do ->\n            if opts.resources\n                Resources.fromJSON(opts.resources)\n            else\n                new Resources\n\n## *Signal* app.onReady()\n\nCalled when all modules, components, styled etc. have been loaded.\n\n        signal.create app, 'onReady'\n\n        # config.type\n        config.type ?= 'app'\n        assert.ok utils.has(['app', 'game', 'text'], config.type), \"Unexpected app.config.type value. Accepted app\/game\/text, but '#{config.type}' got.\"\n\n        app.Route = AppRoute app\n\n## *Dict* app.cookies\n\nOn the client side, this object refers to the last received cookies\nfrom the networking request.\n\nOn the server side, this cookies object are added into the each networking response.\n\nBy default, client has *clientId* and *sessionId* hashes.\n\n```javascript\napp.cookies.onChange(function(key){\n    console.log('cookie changed', key, this[key]);\n});\n```\n\n```xml\n<h1>Your clientId<\/h1>\n<em>${context.app.cookies.clientId}<\/em>\n```\n\n        # cookies\n        COOKIES_KEY = '__neft_cookies'\n        IS_CLIENT = not process.env.NEFT_SERVER\n        app.cookies = Dict()\n        onCookiesReady = (dict) ->\n            app.cookies = dict\n            if IS_CLIENT\n                dict.set 'sessionId', utils.uid(16)\n        db.get COOKIES_KEY, db.OBSERVABLE, (err, dict) ->\n            if dict\n                onCookiesReady dict\n            else\n                if IS_CLIENT\n                    cookies = {clientId: utils.uid(16)}\n                else\n                    cookies = {}\n                db.set COOKIES_KEY, cookies, (err) ->\n                    db.get COOKIES_KEY, db.OBSERVABLE, (err, dict) ->\n                        if dict\n                            onCookiesReady dict\n        app.networking.onRequest (req, res) ->\n            if IS_CLIENT\n                utils.merge req.cookies, app.cookies\n            else\n                utils.merge res.cookies, app.cookies\n            req.onLoadEnd.listeners.unshift ->\n                if IS_CLIENT\n                    for key, val of res.cookies\n                        unless utils.isEqual(app.cookies[key], val)\n                            app.cookies.set key, val\n                return\n            , null\n            return\n\n        # propagate data\n        Renderer.setResources app.resources\n        Renderer.setServerUrl app.networking.url\n        Renderer.onLinkUri (uri) ->\n            app.networking.createLocalRequest\n                method: Networking.Request.GET\n                type: Networking.Request.HTML_TYPE\n                uri: uri\n        app.documentScripts = utils.arrayToObject opts.scripts,\n            (index, elem) -> elem.name,\n            (index, elem) -> elem.file\n        Document.Scripts.initialize app.documentScripts\n\n        # set styles window item\n        if opts.styles?\n            for style in opts.styles\n                if style.name is '__windowItem__'\n                    style.file._init windowItem: null\n                    windowStyle = style.file._main document: null\n                    break\n\n        app.windowItem = windowStyleItem = windowStyle?.item\n        assert.ok windowStyleItem, '__windowItem__ style must be defined'\n        Renderer.setWindowItem windowStyleItem\n\n        if opts.styles?\n            stylesInitObject =\n                windowItem: windowStyleItem\n\n            # initialize styles\n            for style in opts.styles when style.name?\n                if style.name isnt '__windowItem__'\n                    style.file._init stylesInitObject\n                app.styles[style.name] = style.file\n\n        # load styles\n        Styles\n            windowStyle: windowStyle\n            styles: app.styles\n            queries: opts.styleQueries\n            resources: app.resources\n\n        # load bootstrap\n        bootstrapRoute? app\n\n        # loading files helper\n        init = (files, target) ->\n            for file in files when file.name?\n                if typeof file.file isnt 'function'\n                    continue\n\n                fileObj = file.file app\n                target[file.name] = fileObj\n\n                if baseNameMatch = BASE_FILE_NAME_RE.exec(file.name)\n                    [_, baseName] = baseNameMatch\n                    if target[baseName]?\n                        if utils.isPlainObject(target[baseName]) and utils.isPlainObject(fileObj)\n                            fileObj = utils.merge Object.create(target[baseName]), fileObj\n                    target[baseName] = fileObj\n\n            return\n\n        # load app extensions\n        if utils.isObject(opts.extensions)\n            for ext in opts.extensions\n                ext app\n\n        # exports app classes\n        exports.app =\n            Route: app.Route\n\n        # load components\n        for component in opts.components when component.name?\n            app.components[component.name] = Document.fromJSON component.file\n\n        # load files\n        init opts.routes, app.routes\n\n        for path, obj of app.routes\n            r = {}\n            if utils.isObject(obj) and not (obj instanceof app.Route)\n                for method, opts of obj\n                    if utils.isObject(opts)\n                        route = new app.Route method, opts\n                        r[route.name] = route\n                    else\n                        r[method] = opts\n            app.routes[path] = r\n\n        # provide default index route\n        unless app.routes.index\n            app.routes.index = new app.Route 'get \/', {}\n\n        # emit ready signal\n        app.onReady.emit()\n\n        app\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"b9891e3825cec33a38a7beeb67760117494fd27a","subject":"forgot to remove commit exclusion","message":"forgot to remove commit exclusion\n","repos":"corenova\/yang-js","old_file":"src\/container.litcoffee","new_file":"src\/container.litcoffee","new_contents":"# Container - controller of object properties\n\n## Class Container\n\n    delegate = require 'delegates'\n    Emitter  = require('events').EventEmitter\n    Property = require('.\/property')\n    kProp = Symbol.for('property')\n\n    class Container extends Property\n      logger: require('debug')('yang:container')\n\n      constructor: ->\n        super arguments...\n        @state.children = new Map # committed props\n        @state.pending = new Map # uncommitted changed props\n        @state.delta = undefined\n        @state.locked = false\n        @state.proxy =\n          has: (obj, key) => @children.has(key) or key of obj\n          get: (obj, key) => switch\n            when key is kProp then this\n            when key is '_' then this\n            when key is 'toJSON' then @toJSON.bind(this)\n            when @has(key) then @get(key)\n            when key of obj then obj[key]\n            when key is 'inspect' then @toJSON.bind(this)\n            when key of this and typeof @[key] is 'function' then @[key].bind(this)\n            when typeof key is 'string' and key[0] is '_' then @[key.substring(1)]\n          set: (obj, key, value) => switch\n            when @has(key) then @_get(key).set(value)\n            else obj[key] = value\n          deleteProperty: (obj, key) => switch\n            when @has(key) then @_get(key).delete()\n            when key of obj then delete obj[key]\n        Object.setPrototypeOf @state, Emitter.prototype\n        \n      delegate @prototype, 'state'\n        .getter 'children'\n        .getter 'pending'\n        .getter 'locked'\n        .getter 'delta'\n        .method 'once'\n        .method 'on'\n        .method 'off'\n        .method 'emit'\n\n      @property 'props',\n        get: -> Array.from(@children.values())\n\n      @property 'changed',\n        get: -> @pending.size > 0 or @state.changed\n\n      @property 'changes',\n        get: -> Array.from(@pending.values())\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed and @pending.size\n            obj = {}\n            obj[prop.key] = prop.change for prop from @changes\n            obj\n          when @changed then @data\n\n      @property 'data',\n        set: (value) -> @set value, { force: true }\n        get: ->\n          value = switch\n            when @binding?.get? then @binding.get @context\n            else @value\n          return value unless value instanceof Object\n          new Proxy value, @state.proxy\n\n      clone: ->\n        copy = super children: new Map, pending: new Map\n        copy.add prop.clone(parent: copy) for prop in @props\n        return copy\n\n### add (child)\n\nThis call is used to add a child property to map of children.\n\n      add: (child) ->\n        @children.set child.key, child\n        if @value?\n          Object.defineProperty @value, child.key,\n            configurable: true\n            enumerable: child.active\n\n### remove (child)\n\nThis call is used to remove a child property from map of children.\n\n      remove: (child) ->\n        @children.delete child.key\n        if @value?\n          delete @value[child.key]\n\n### has (key)\n\n      has: (key) -> @children.has(key)\n\n### get (key)\n\n      _get: (key) -> @children.get(key)\n      \n      get: (key) -> switch\n        when key? and @has(key) then @_get(key).data\n        else super arguments...\n\n### set (obj, opts)\n\n      set: (obj, opts={}) ->\n        # TODO: should we preserve prior changes and restore if super fails?\n        @pending.clear()\n        # TODO: should we also clear Object.defineProperties?\n        try obj = Object.assign {}, obj if kProp of obj\n        super obj, opts\n        # remove all props not part of pending changes\n        subopts = Object.assign {}, opts\n        #prop.delete(subopts) for prop in @props when not @pending.has(prop.key)\n        @props.forEach (prop) => prop.delete(subopts) unless @pending.has(prop.key) \n        return this\n\n### merge (obj, opts)\n\nEnumerate key\/value of the passed in `obj` and merge into known child\nproperties.\n\n      merge: (obj, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if obj is null\n        return @set obj, opts if opts.replace or not @value?\n        \n        # TODO: protect this as a transaction?\n        { deep = true } = opts\n\n        subopts = Object.assign {}, opts, inner: true, replace: not deep\n        for own k, v of obj\n          @debug => \"[merge] looking for #{k} inside #{@children.size} children\"\n          prop = @children.get(k) ? @in(k)\n          continue unless prop? and not Array.isArray(prop)\n          @debug => \"[merge] applying value to child prop #{prop.key}\"\n          prop.merge(v, subopts)\n        # TODO: we should consider evaluating schema.attrs here before update\n        @update @value, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      _update: (value, opts) ->\n        @debug => \"[update] handle #{@pending.size} changed props\"\n        \n        for prop from @changes\n          @debug => \"[update] child #{prop.uri} changed? #{prop.changed}\"\n          @add prop, opts\n          @pending.delete prop.key unless prop.changed\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n\n        if value instanceof Property\n          if value.parent is this\n            @pending.set value.key, value \n            @debug => \"[update] pending.set '#{value.key}' now have #{@pending.size} pending changes\"\n          if opts.inner or opts.origin is this\n            return this\n          # higher up from change origin\n          value = @value\n\n        @_update value, opts # internal update handler\n\n        # we must clear children here if being deleted before calling super (which calls parent.update)\n        @children.clear() if value is null\n        super value, opts\n            \n        @emit 'update', this, opts\n        return this\n\n### commit (opts)\n\nCommits the changes to the data model. Async transaction.\nEvents: commit, change\n\n      lock: (opts={}) ->\n        randomize = (min, max) -> Math.floor(Math.random() * (max - min)) + min\n        opts.seq ?= randomize 1000, 9999\n        @debug \"[lock:#{opts.seq}] acquiring lock... already have it?\", (opts.lock is this)\n        return this if opts.lock is this\n        while @locked\n          await (new Promise (resolve) => @once 'ready', -> resolve true)\n          #await @parent?.lock opts unless opts.inner\n        @debug \"[lock:#{opts.seq}] acquired and has #{@pending.size} changes, changed? #{@changed}\"\n        @debug \"[lock:#{opts.seq}] acquired by #{opts.caller.uri} and locked? #{opts.caller.locked}\" if opts.caller?\n        super opts\n\n      unlock: (opts={}) ->\n        @debug \"[unlock:#{opts.seq}] freeing lock...\"\n        return this unless @locked\n        super opts\n        @emit 'ready'\n        return this\n\n      commit: (opts={}) ->\n        try\n          await @lock opts\n          if @changed\n            id = opts.seq ? 0\n            subopts = Object.assign {}, opts, caller: this, inner: true\n            delete subopts.lock\n            # 1. commit all the changed children\n            @debug \"[commit:#{id}] wait to commit all the children...\"\n            await Promise.all @changes.filter((p) -> not p.locked).map (prop) -> prop.commit subopts\n            if not opts.sync and @binding?.commit? and @changed\n              @debug \"[commit:#{id}] execute commit binding...\", @changed\n              await @binding.commit @context.with(opts)\n            # wait for the parent to commit unless called by parent\n            opts.origin ?= this\n            subopts = Object.assign {}, opts, caller: this\n            await @parent?.commit? subopts unless opts.inner\n            @emit 'change', opts.origin, opts.actor unless opts.suppress\n            @clean opts unless opts.inner\n        catch err\n          @debug \"[commit:#{id}] error: #{err.message}\"\n          failed = true\n          throw @error err, 'commit'\n        finally\n          @debug \"[commit:#{id}] finalizing...\"\n          await @revert opts if failed\n          @debug \"[commit:#{id}] #{@pending.size} changes, now have #{@children.size} props, releasing lock!\"\n          @unlock opts\n\n        return this\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        id = opts.seq ? 0\n        @debug => \"[revert:#{id}] #{@pending.size} changes\"\n        \n        # below is hackish but works to make a copy of current value\n        # to be used as ctx.prior during revert commit binding call\n        @state.value = @toJSON()\n\n        # XXX: may want to consider Promise.all here\n        for prop from @changes when (not prop.locked) or (prop is opts.caller)\n          await prop.revert opts\n          @debug \"[revert:#{id}] re-add changed prop\"\n          @add prop\n        await super opts\n        @debug \"[revert:#{id}] have #{@children.size} remaining props\"\n\n      clean: (opts={}) ->\n        return unless @changed\n        # traverse down committed nodes and clean their state\n        # console.warn(opts.caller) if opts.caller\n        id = opts.seq\n        @debug \"[clean:#{id}] #{@pending.size} changes with #{@children.size} props\"\n        for prop from @changes when (not prop.locked) or (prop is opts.caller)\n          prop.clean opts\n          @pending.delete(prop.key)\n        @debug \"[clean:#{id}] #{@pending.size} remaining changes\"\n        super opts\n        \n        \n\n### toJSON\n\nThis call creates a new copy of the current `Property.data`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        props = @props\n        value = switch\n          when props.length\n            obj = {}\n            for prop in props when prop.enumerable and (state or prop.mutable)\n              value = prop.toJSON false, state\n              obj[prop.key] = value if value?\n            obj\n          else @value\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        output = super arguments...\n        return Object.assign output, children: @children.size\n        \n    module.exports = Container\n","old_contents":"# Container - controller of object properties\n\n## Class Container\n\n    delegate = require 'delegates'\n    Emitter  = require('events').EventEmitter\n    Property = require('.\/property')\n    kProp = Symbol.for('property')\n\n    class Container extends Property\n      logger: require('debug')('yang:container')\n\n      constructor: ->\n        super arguments...\n        @state.children = new Map # committed props\n        @state.pending = new Map # uncommitted changed props\n        @state.delta = undefined\n        @state.locked = false\n        @state.proxy =\n          has: (obj, key) => @children.has(key) or key of obj\n          get: (obj, key) => switch\n            when key is kProp then this\n            when key is '_' then this\n            when key is 'toJSON' then @toJSON.bind(this)\n            when @has(key) then @get(key)\n            when key of obj then obj[key]\n            when key is 'inspect' then @toJSON.bind(this)\n            when key of this and typeof @[key] is 'function' then @[key].bind(this)\n            when typeof key is 'string' and key[0] is '_' then @[key.substring(1)]\n          set: (obj, key, value) => switch\n            when @has(key) then @_get(key).set(value)\n            else obj[key] = value\n          deleteProperty: (obj, key) => switch\n            when @has(key) then @_get(key).delete()\n            when key of obj then delete obj[key]\n        Object.setPrototypeOf @state, Emitter.prototype\n        \n      delegate @prototype, 'state'\n        .getter 'children'\n        .getter 'pending'\n        .getter 'locked'\n        .getter 'delta'\n        .method 'once'\n        .method 'on'\n        .method 'off'\n        .method 'emit'\n\n      @property 'props',\n        get: -> Array.from(@children.values())\n\n      @property 'changed',\n        get: -> @pending.size > 0 or @state.changed\n\n      @property 'changes',\n        get: -> Array.from(@pending.values())\n\n      @property 'change',\n        get: -> switch\n          when @changed and not @active then null\n          when @changed and @pending.size\n            obj = {}\n            obj[prop.key] = prop.change for prop from @changes\n            obj\n          when @changed then @data\n\n      @property 'data',\n        set: (value) -> @set value, { force: true }\n        get: ->\n          value = switch\n            when @binding?.get? then @binding.get @context\n            else @value\n          return value unless value instanceof Object\n          new Proxy value, @state.proxy\n\n      clone: ->\n        copy = super children: new Map, pending: new Map\n        copy.add prop.clone(parent: copy) for prop in @props\n        return copy\n\n### add (child)\n\nThis call is used to add a child property to map of children.\n\n      add: (child) ->\n        @children.set child.key, child\n        if @value?\n          Object.defineProperty @value, child.key,\n            configurable: true\n            enumerable: child.active\n\n### remove (child)\n\nThis call is used to remove a child property from map of children.\n\n      remove: (child) ->\n        @children.delete child.key\n        if @value?\n          delete @value[child.key]\n\n### has (key)\n\n      has: (key) -> @children.has(key)\n\n### get (key)\n\n      _get: (key) -> @children.get(key)\n      \n      get: (key) -> switch\n        when key? and @has(key) then @_get(key).data\n        else super arguments...\n\n### set (obj, opts)\n\n      set: (obj, opts={}) ->\n        # TODO: should we preserve prior changes and restore if super fails?\n        @pending.clear()\n        # TODO: should we also clear Object.defineProperties?\n        try obj = Object.assign {}, obj if kProp of obj\n        super obj, opts\n        # remove all props not part of pending changes\n        subopts = Object.assign {}, opts\n        #prop.delete(subopts) for prop in @props when not @pending.has(prop.key)\n        @props.forEach (prop) => prop.delete(subopts) unless @pending.has(prop.key) \n        return this\n\n### merge (obj, opts)\n\nEnumerate key\/value of the passed in `obj` and merge into known child\nproperties.\n\n      merge: (obj, opts={}) ->\n        opts.origin ?= this\n        return @delete opts if obj is null\n        return @set obj, opts if opts.replace or not @value?\n        \n        # TODO: protect this as a transaction?\n        { deep = true } = opts\n\n        subopts = Object.assign {}, opts, inner: true, replace: not deep\n        for own k, v of obj\n          @debug => \"[merge] looking for #{k} inside #{@children.size} children\"\n          prop = @children.get(k) ? @in(k)\n          continue unless prop? and not Array.isArray(prop)\n          @debug => \"[merge] applying value to child prop #{prop.key}\"\n          prop.merge(v, subopts)\n        # TODO: we should consider evaluating schema.attrs here before update\n        @update @value, opts\n\n### update\n\nUpdates the value to the data model. Called *once* for each node that\nis part of the change branch.\n\n      _update: (value, opts) ->\n        @debug => \"[update] handle #{@pending.size} changed props\"\n        \n        for prop from @changes\n          @debug => \"[update] child #{prop.uri} changed? #{prop.changed}\"\n          @add prop, opts\n          @pending.delete prop.key unless prop.changed\n\n      update: (value, opts={}) ->\n        opts.origin ?= this\n\n        if value instanceof Property\n          if value.parent is this\n            @pending.set value.key, value \n            @debug => \"[update] pending.set '#{value.key}' now have #{@pending.size} pending changes\"\n          if opts.inner or opts.origin is this\n            return this\n          # higher up from change origin\n          value = @value\n\n        @_update value, opts # internal update handler\n\n        # we must clear children here if being deleted before calling super (which calls parent.update)\n        @children.clear() if value is null\n        super value, opts\n            \n        @emit 'update', this, opts\n        return this\n\n### commit (opts)\n\nCommits the changes to the data model. Async transaction.\nEvents: commit, change\n\n      lock: (opts={}) ->\n        randomize = (min, max) -> Math.floor(Math.random() * (max - min)) + min\n        opts.seq ?= randomize 1000, 9999\n        @debug \"[lock:#{opts.seq}] acquiring lock... already have it?\", (opts.lock is this)\n        return this if opts.lock is this\n        while @locked\n          await (new Promise (resolve) => @once 'ready', -> resolve true)\n          #await @parent?.lock opts unless opts.inner\n        @debug \"[lock:#{opts.seq}] acquired and has #{@pending.size} changes, changed? #{@changed}\"\n        @debug \"[lock:#{opts.seq}] acquired by #{opts.caller.uri} and locked? #{opts.caller.locked}\" if opts.caller?\n        super opts\n\n      unlock: (opts={}) ->\n        @debug \"[unlock:#{opts.seq}] freeing lock...\"\n        return this unless @locked\n        super opts\n        @emit 'ready'\n        return this\n\n      commit: (opts={}) ->\n        return this unless @changed\n        try\n          await @lock opts\n          if @changed\n            id = opts.seq ? 0\n            subopts = Object.assign {}, opts, caller: this, inner: true\n            delete subopts.lock\n            # 1. commit all the changed children\n            @debug \"[commit:#{id}] wait to commit all the children...\"\n            await Promise.all @changes.filter((p) -> not p.locked).map (prop) -> prop.commit subopts\n            if not opts.sync and @binding?.commit? and @changed\n              @debug \"[commit:#{id}] execute commit binding...\", @changed\n              await @binding.commit @context.with(opts)\n            # wait for the parent to commit unless called by parent\n            opts.origin ?= this\n            subopts = Object.assign {}, opts, caller: this\n            await @parent?.commit? subopts unless opts.inner\n            @emit 'change', opts.origin, opts.actor unless opts.suppress\n            @clean opts unless opts.inner\n        catch err\n          @debug \"[commit:#{id}] error: #{err.message}\"\n          failed = true\n          throw @error err, 'commit'\n        finally\n          @debug \"[commit:#{id}] finalizing...\"\n          await @revert opts if failed\n          @debug \"[commit:#{id}] #{@pending.size} changes, now have #{@children.size} props, releasing lock!\"\n          @unlock opts\n\n        return this\n\n      revert: (opts={}) ->\n        return unless @changed\n        \n        id = opts.seq ? 0\n        @debug => \"[revert:#{id}] #{@pending.size} changes\"\n        \n        # below is hackish but works to make a copy of current value\n        # to be used as ctx.prior during revert commit binding call\n        @state.value = @toJSON()\n\n        # XXX: may want to consider Promise.all here\n        for prop from @changes when (not prop.locked) or (prop is opts.caller)\n          await prop.revert opts\n          @debug \"[revert:#{id}] re-add changed prop\"\n          @add prop\n        await super opts\n        @debug \"[revert:#{id}] have #{@children.size} remaining props\"\n\n      clean: (opts={}) ->\n        return unless @changed\n        # traverse down committed nodes and clean their state\n        # console.warn(opts.caller) if opts.caller\n        id = opts.seq\n        @debug \"[clean:#{id}] #{@pending.size} changes with #{@children.size} props\"\n        for prop from @changes when (not prop.locked) or (prop is opts.caller)\n          prop.clean opts\n          @pending.delete(prop.key)\n        @debug \"[clean:#{id}] #{@pending.size} remaining changes\"\n        super opts\n        \n        \n\n### toJSON\n\nThis call creates a new copy of the current `Property.data`\ncompletely detached\/unbound to the underlying data schema. It's main\nutility is to represent the current data state for subsequent\nserialization\/transmission. It accepts optional argument `tag` which\nwhen called with `true` will tag the produced object with the current\nproperty's `@name`.\n\n      toJSON: (key, state = true) ->\n        props = @props\n        value = switch\n          when props.length\n            obj = {}\n            for prop in props when prop.enumerable and (state or prop.mutable)\n              value = prop.toJSON false, state\n              obj[prop.key] = value if value?\n            obj\n          else @value\n        value = \"#{@name}\": value if key is true\n        return value\n\n### inspect\n\n      inspect: ->\n        output = super arguments...\n        return Object.assign output, children: @children.size\n        \n    module.exports = Container\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"2783b8f4db510915bfb88a2ddabb8975d47f1f38","subject":"Fix link to pluralize specs","message":"Fix link to pluralize specs\n","repos":"ygt-mikekchar\/react-maybe-matchers,ygt-mikekchar\/react-maybe-matchers","old_file":"src\/pluralize.litcoffee","new_file":"src\/pluralize.litcoffee","new_contents":"# String#pluralize method\n\nMany of the tests need to output plural versions of\nobjects.  This is just a handy utility to help with that.\n\n## Examples\n\n```\n\"one #{'bucket'.pluralize(1)}\"            # == \"one bucket\"\n\"five #{'bucket'.pluralize(5)}\"           # == \"five buckets\"\n\"two #{'mommy'.pluralize(2, 'mommies')}\"  # == \"two mommies\"\n\"there #{'was'.pluralize(1, 'were')} one\" # == \"there was one\"\n```\n\n[specs](.\/spec\/pluralize_spec.litcoffee)\n\n    String.prototype.pluralize = (num, plural) ->\n      return this if num == 1\n      if plural? then plural else \"#{this}s\"\n","old_contents":"# String#pluralize method\n\nMany of the tests need to output plural versions of\nobjects.  This is just a handy utility to help with that.\n\n## Examples\n\n```\n\"one #{'bucket'.pluralize(1)}\"            # == \"one bucket\"\n\"five #{'bucket'.pluralize(5)}\"           # == \"five buckets\"\n\"two #{'mommy'.pluralize(2, 'mommies')}\"  # == \"two mommies\"\n\"there #{'was'.pluralize(1, 'were')} one\" # == \"there was one\"\n```\n\n[specs](.\/spec\/pluralize_spec.litcoffee)\n    String.prototype.pluralize = (num, plural) ->\n      return this if num == 1\n      if plural? then plural else \"#{this}s\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a5fd8f91a2606495d8aa8d34a2af9f97c4872dd1","subject":"Add parameter types and return types to docs.","message":"Add parameter types and return types to docs.\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/js\/be.bastelstu.wcf.nodePush.litcoffee","new_file":"file\/js\/be.bastelstu.wcf.nodePush.litcoffee","new_contents":"Frontend JavaScript for nodePush\n================================\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\nEnsure sane values for `$` and `window`\n\n\t(($, window) ->\n\t\t# Enable strict mode\n\t\t\"use strict\";\n\t\t\n\t\t# Ensure our namespace is present\n\t\twindow.be ?= {}\n\t\tbe.bastelstu ?= {}\n\t\tbe.bastelstu.wcf ?= {}\n\nOverwrite `console` to add the origin in front of the message\n\n\t\tconsole =\n\t\t\tlog: (message) ->\n\t\t\t\twindow.console.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\twarn: (message) ->\n\t\t\t\twindow.console.warn \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\terror: (message) ->\n\t\t\t\twindow.console.error \"[be.bastelstu.wcf.nodePush] #{message}\"\n\nbe.bastelstu.wcf.nodePush\n=========================\n\nPrivate Attributes\n------------------\n\n\t\tsocket = null\n\t\tconnected = false\n\t\tinitialized = false\n\t\tevents =\n\t\t\tconnect: $.Callbacks()\n\t\t\tdisconnect: $.Callbacks()\n\t\t\tmessage: { }\n\t\t\n\t\tbe.bastelstu.wcf.nodePush = \n\nMethods\n-------\n\n**init(string host)**  \nInitialize socket.io to enable nodePush.\n\n\t\t\tinit: (host) ->\n\t\t\t\treturn if initialized\n\t\t\t\tinitialized = true\n\t\t\t\tconsole.log 'Initializing nodePush'\n\t\t\t\t\n\t\t\t\tunless window.io?\n\t\t\t\t\tconsole.error 'nodePush not available, aborting'\n\t\t\t\t\treturn\n\t\t\t\t\t\n\t\t\t\tsocket = window.io.connect host\n\t\t\t\t\n\t\t\t\tsocket.on 'connect', ->\n\t\t\t\t\tconnected = true\n\t\t\t\t\tconsole.log 'Connected to nodePush'\n\t\t\t\t\tevents.connect.fire()\n\t\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', ->\n\t\t\t\t\tconnected = false\n\t\t\t\t\tconsole.warn 'Lost connection to nodePush'\n\t\t\t\t\tevents.disconnect.fire()\n\t\t\t\t\n\t\t\t\tsocket.on 'message', (message) ->\n\t\t\t\t\treturn unless events.message[message]?\n\t\t\t\t\t\n\t\t\t\t\tevents.message[message].fire()\n\n**boolean onConnect(Function callback)**  \nAdds a new `callback` that will be called when a connection to nodePush is established. The given \n`callback` will be called once if a connection is established at time of calling. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonConnect: (callback) ->\n\t\t\t\treturn false unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.connect.add callback\n\t\t\t\t\n\t\t\t\tcallback() if connected\n\t\t\t\ttrue\n\n**boolean onDisconnect(Function callback)**  \nAdds a new `callback` that will be called when the connection to nodePush is lost. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonDisconnect: (callback) ->\n\t\t\t\treturn false unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.disconnect.add callback\n\t\t\t\ttrue\n\n**boolean onMessage(string message, Function callback)**  \nAdds a new `callback` that will be called when the specified `message` is received. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonMessage: (message, callback) ->\n\t\t\t\tfalse unless $.isFunction callback\n\t\t\t\tfalse unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test message\n\t\t\t\t\n\t\t\t\tevents.message[message] ?= $.Callbacks()\n\t\t\t\tevents.message[message].add callback\n\t\t\t\ttrue\n\t\t\t\n\t)(jQuery, @)\n","old_contents":"Frontend JavaScript for nodePush\n================================\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\nEnsure sane values for `$` and `window`\n\n\t(($, window) ->\n\t\t# Enable strict mode\n\t\t\"use strict\";\n\t\t\n\t\t# Ensure our namespace is present\n\t\twindow.be ?= {}\n\t\tbe.bastelstu ?= {}\n\t\tbe.bastelstu.wcf ?= {}\n\nOverwrite `console` to add the origin in front of the message\n\n\t\tconsole =\n\t\t\tlog: (message) ->\n\t\t\t\twindow.console.log \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\twarn: (message) ->\n\t\t\t\twindow.console.warn \"[be.bastelstu.wcf.nodePush] #{message}\"\n\t\t\terror: (message) ->\n\t\t\t\twindow.console.error \"[be.bastelstu.wcf.nodePush] #{message}\"\n\nbe.bastelstu.wcf.nodePush\n=========================\n\nPrivate Attributes\n------------------\n\n\t\tsocket = null\n\t\tconnected = false\n\t\tinitialized = false\n\t\tevents =\n\t\t\tconnect: $.Callbacks()\n\t\t\tdisconnect: $.Callbacks()\n\t\t\tmessage: { }\n\t\t\n\t\tbe.bastelstu.wcf.nodePush = \n\nMethods\n-------\n\n**init(host)**  \nInitialize socket.io to enable nodePush.\n\n\t\t\tinit: (host) ->\n\t\t\t\treturn if initialized\n\t\t\t\tinitialized = true\n\t\t\t\tconsole.log 'Initializing nodePush'\n\t\t\t\t\n\t\t\t\tunless window.io?\n\t\t\t\t\tconsole.error 'nodePush not available, aborting'\n\t\t\t\t\treturn\n\t\t\t\t\t\n\t\t\t\tsocket = window.io.connect host\n\t\t\t\t\n\t\t\t\tsocket.on 'connect', ->\n\t\t\t\t\tconnected = true\n\t\t\t\t\tconsole.log 'Connected to nodePush'\n\t\t\t\t\tevents.connect.fire()\n\t\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', ->\n\t\t\t\t\tconnected = false\n\t\t\t\t\tconsole.warn 'Lost connection to nodePush'\n\t\t\t\t\tevents.disconnect.fire()\n\t\t\t\t\n\t\t\t\tsocket.on 'message', (message) ->\n\t\t\t\t\treturn unless events.message[message]?\n\t\t\t\t\t\n\t\t\t\t\tevents.message[message].fire()\n\n**onConnect(callback)**  \nAdds a new `callback` that will be called when a connection to nodePush is established. The given \n`callback` will be called once if a connection is established at time of calling. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonConnect: (callback) ->\n\t\t\t\treturn false unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.connect.add callback\n\t\t\t\t\n\t\t\t\tcallback() if connected\n\t\t\t\ttrue\n\n**onDisconnect(callback)**  \nAdds a new `callback` that will be called when the connection to nodePush is lost. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonDisconnect: (callback) ->\n\t\t\t\treturn false unless $.isFunction callback\n\t\t\t\t\n\t\t\t\tevents.disconnect.add callback\n\t\t\t\ttrue\n\n**onMessage(message, callback)**  \nAdds a new `callback` that will be called when the specified `message` is received. Returns `true`\non success and `false` otherwise.\n\n\t\t\tonMessage: (message, callback) ->\n\t\t\t\tfalse unless $.isFunction callback\n\t\t\t\tfalse unless \/^[a-zA-Z0-9-_]+\\.[a-zA-Z0-9-_]+(\\.[a-zA-Z0-9-_]+)+$\/.test message\n\t\t\t\t\n\t\t\t\tevents.message[message] ?= $.Callbacks()\n\t\t\t\tevents.message[message].add callback\n\t\t\t\ttrue\n\t\t\t\n\t)(jQuery, @)\n","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"b953f12c07499bf943f4ca40cbdad6319fa086f4","subject":"Configure mongo-querystring instance","message":"Configure mongo-querystring instance\n","repos":"Turbasen\/Turbasen,Turistforeningen\/Turbasen","old_file":"coffee\/collection.litcoffee","new_file":"coffee\/collection.litcoffee","new_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n    collections = [\n      'turer'\n      'steder'\n      'grupper'\n      'omr\u00e5der'\n      'bilder'\n      'arrangementer'\n    ]\n\n    qs = new MongoQS\n      alias:\n        tag: 'tags.0'\n        gruppe: 'grupper'\n        endret: 'after'\n      ignore:\n        api_key     : true # other use\n        order       : true # reserved\n        sort        : true # other use\n        limit       : true # other use\n        skip        : true # other use\n        fields      : true # other use\n        _id         : true # use API endpoint\n      custom:\n        bbox: 'geojson'\n        near: 'geojson'\n        after: 'endret'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col]\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n      query = {}\n\n### ?tag=`String`\n\n      if typeof req.query.tag is 'string' and req.query.tag isnt ''\n        if req.query.tag.charAt(0) is '!' and req.query.tag.length > 1\n          query['tags.0'] = $ne: req.query.tag.substr(1)\n        else\n          query['tags.0'] = req.query.tag\n\n### ?grupper=`String`\n\n      if typeof req.query.gruppe is 'string' and req.query.gruppe isnt ''\n        query['grupper'] = req.query.gruppe\n\n### ?after=`Mixed`\n\n      if typeof req.query.after is 'string' and req.query.after isnt ''\n        time = req.query.after\n\n        if not isNaN time\n          # Make unix timestamp into milliseconds\n          time = time + '000' if (time + '').length is 10\n          time = parseInt time\n\n        time = new Date time\n\n        if time.toString() isnt 'Invalid Date'\n          query.endret = $gte: time.toISOString()\n\n### ?bbox=`min_lng`,`min_lat`,`max_lng`,`max_lat`\n\n      if typeof req.query.bbox is 'string' and req.query.bbox.split(',').length is 4\n        bbox = req.query.bbox.split(',')\n        bbox[i] = parseFloat(val) for val, i in bbox\n\n        query.geojson =\n          '$geoWithin':\n            '$geometry':\n              type: 'Polygon'\n              coordinates: [[\n                [bbox[0], bbox[1]]\n                [bbox[2], bbox[1]]\n                [bbox[2], bbox[3]]\n                [bbox[0], bbox[3]]\n                [bbox[0], bbox[1]]\n              ]]\n\n### ?privat.`String`=`String`\n\nThis allows the user to filter documents based on private document properties.\nThis will autumaticly limit returned documents to those owned by the current\nuser.\n\n#### ToDo\n\n * Limit number of private fields?\n * Limit depth of private fields?\n\n`NB` This section is looping through all of the url query parameters and hence\nshould take the queries from above sections into concideration so we don't need\nto do double amount of work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true, tags: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","old_contents":"    MongoQS     = require 'mongo-querystring'\n    Document    = require '.\/model\/Document'\n    stringify   = require('JSONStream').stringify\n\n    sentry      = require '.\/db\/sentry'\n    mongo       = require '.\/db\/mongo'\n\n## PARAM {collection}\n\n    exports.param = (req, res, next, col) ->\n      if col not in ['turer', 'steder', 'grupper', 'omr\u00e5der', 'bilder', 'arrangementer']\n        return res.json 404, message: 'Objekttype ikke funnet'\n\n      req.type = col\n      req.db   = col: mongo[col]\n\n      next()\n\n## OPTIONS \/{collection}\n\n    exports.options = (req, res, next) ->\n      res.setHeader 'Access-Control-Expose-Headers', [\n        'ETag', 'Location', 'Last-Modified', 'Count-Return', 'Count-Total'\n      ].join(', ')\n      res.setHeader 'Access-Control-Max-Age', 86400\n      res.setHeader 'Access-Control-Allow-Headers', 'Content-Type'\n      res.setHeader 'Access-Control-Allow-Methods', 'HEAD, GET, POST'\n      res.send 204\n\n## HEAD \/{collection}\n## GET \/{collection}\n\n    exports.get = (req, res, next) ->\n      query = {}\n\n### ?tag=`String`\n\n      if typeof req.query.tag is 'string' and req.query.tag isnt ''\n        if req.query.tag.charAt(0) is '!' and req.query.tag.length > 1\n          query['tags.0'] = $ne: req.query.tag.substr(1)\n        else\n          query['tags.0'] = req.query.tag\n\n### ?grupper=`String`\n\n      if typeof req.query.gruppe is 'string' and req.query.gruppe isnt ''\n        query['grupper'] = req.query.gruppe\n\n### ?after=`Mixed`\n\n      if typeof req.query.after is 'string' and req.query.after isnt ''\n        time = req.query.after\n\n        if not isNaN time\n          # Make unix timestamp into milliseconds\n          time = time + '000' if (time + '').length is 10\n          time = parseInt time\n\n        time = new Date time\n\n        if time.toString() isnt 'Invalid Date'\n          query.endret = $gte: time.toISOString()\n\n### ?bbox=`min_lng`,`min_lat`,`max_lng`,`max_lat`\n\n      if typeof req.query.bbox is 'string' and req.query.bbox.split(',').length is 4\n        bbox = req.query.bbox.split(',')\n        bbox[i] = parseFloat(val) for val, i in bbox\n\n        query.geojson =\n          '$geoWithin':\n            '$geometry':\n              type: 'Polygon'\n              coordinates: [[\n                [bbox[0], bbox[1]]\n                [bbox[2], bbox[1]]\n                [bbox[2], bbox[3]]\n                [bbox[0], bbox[3]]\n                [bbox[0], bbox[1]]\n              ]]\n\n### ?privat.`String`=`String`\n\nThis allows the user to filter documents based on private document properties.\nThis will autumaticly limit returned documents to those owned by the current\nuser.\n\n#### ToDo\n\n * Limit number of private fields?\n * Limit depth of private fields?\n\n`NB` This section is looping through all of the url query parameters and hence\nshould take the queries from above sections into concideration so we don't need\nto do double amount of work.\n\n      for key, val of req.query when key.substr(0,7) is 'privat.'\n        if \/^[a-z\u00e6\u00f8\u00e5A-Z\u00c6\u00d8\u00c50-9_.]+$\/.test key\n          val = parseFloat(val) if not isNaN val # @TODO(starefossen) is this acceptable?\n          query.tilbyder = req.usr\n          query[key] = val\n\nLimit queries to own documents or public documents i.e. where `doc.status` is\n`Offentlig` if not `query.tilbyder` is set.\n\n      query['$or'] = [{status: 'Offentlig'}, {tilbyder: req.usr}] if not query.tilbyder\n\nOnly project a few fields to since lists are mostly used intermediate before\nfetching the entire document.\n\n      fields = tilbyder: true, endret: true, status: true, navn: true, tags: true\n\nSet up MongoDB options.\n\n      options =\n        limit: Math.min((parseInt(req.query.limit, 10) or 20), 50)\n        skip: parseInt(req.query.skip, 10) or 0\n        sort: 'endret'\n\nRetrive matching documents from MongoDB.\n\n      cursor = req.db.col.find(query, fields, options)\n      cursor.count (err, total) ->\n        return next err if err\n        res.set 'Count-Return', Math.min(options.limit, total)\n        res.set 'Count-Total', total\n        return res.send 204 if req.method is 'HEAD'\n        return res.json documents: [], count: 0, total: 0 if total is 0\n        res.set 'Content-Type', 'application\/json; charset=utf-8'\n\nCalculate number of rows returned since we don't know that in advanced (due to\nthe nature of streaming).\n\n        count = Math.min(options.limit, Math.max(total - options.skip, 0))\n\nStream documents user in order to prevent loading them into memory.\n\n        op = '{\"documents\":['\n        cl = '],\"count\":' + count + ',\"total\":' + total + '}'\n\n        cursor.stream().pipe(stringify(op, ',', cl)).pipe(res)\n\n## POST \/{collection}\n\n    exports.post = (req, res, next) ->\n      return res.json 400, message: 'Body is missing' if Object.keys(req.body).length is 0\n      return res.json 422, message: 'Body should be a JSON Hash' if req.body instanceof Array\n\n      req.body.tilbyder = req.usr\n\n      new Document(req.type, null).once('error', next).once 'ready', ->\n        @insert req.body, (err, warn, data) ->\n          if err\n            return next(err) if err.name isnt 'ValidationError'\n\n            sentry.captureDocumentError req, err\n\n            return res.json 422,\n              document: req.body\n              message: 'Validation Failed'\n              errors: err.details #TODO(starefossen) document this\n\n          res.set 'ETag', \"\\\"#{data.checksum}\\\"\"\n          res.set 'Last-Modified', new Date(data.endret).toUTCString()\n          # res.set 'Location', req.get 'host'\n\n          return res.json 201,\n            document: data\n            message: 'Validation Warnings' if warn.length > 0\n            warnings: warn if warn.length > 0\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"9113568438f888268498c140a8801267d240be8f","subject":"Unnecessary (incorrect) association","message":"Unnecessary (incorrect) association\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-user\/client\/index.litcoffee","new_file":"packages\/shrub-user\/client\/index.litcoffee","new_contents":"# User\n\n*User operations, model, etc.*\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubOrmCollections`.\n\n      registrar.registerHook 'shrubOrmCollections', exports.shrubOrmCollections\n\n#### Implements hook `shrubOrmCollectionsAlter`.\n\n      registrar.registerHook 'shrubOrmCollectionsAlter', exports.shrubOrmCollectionsAlter\n\n#### Implements hook `shrubAngularDirective`.\n\n      registrar.registerHook 'shrubAngularDirective', -> [\n        'shrub-user'\n        (user) ->\n\n          directive = {}\n\n          directive.link = (scope) -> scope.user = user\n\n          directive.scope = {}\n\n          directive.template = '''\n\n    <span class=\"user\">\n      <span class=\"username\" data-ng-bind=\"user.instance().name\"><\/span>\n\n      <span\n        class=\"actions\"\n        data-ng-if=\"!user.isLoggedIn()\"\n      >\n        [<a href=\"\/user\/login\">Log in<\/a> \u00b7 <a href=\"\/user\/register\">Register<\/a>]\n      <\/span>\n\n      <span\n        class=\"actions\"\n        data-ng-if=\"user.isLoggedIn()\"\n      >\n        [<a href=\"\/user\/logout\">Log out<\/a>]\n      <\/span>\n\n    <\/span>\n\n    '''\n\n          return directive\n\n      ]\n\n#### Implements hook `shrubAngularService`.\n\n      registrar.registerHook 'shrubAngularService', -> [\n        'shrub-orm', 'shrub-rpc', 'shrub-socket'\n        (orm, rpc, socket) ->\n\n          config = require 'config'\n\n          User = orm.collection 'shrub-user'\n\n          service = {}\n\n          _instance = {}\n          _instance[k] = v for k, v of User.instantiate(\n            config.get 'packageConfig:shrub-user'\n          )\n\nLog a user out if we get a socket call.\n\n          logout = ->\n\n            blank = User.instantiate()\n            delete _instance[k] for k of _instance\n            _instance[k] = v for k, v of blank\n\n            return\n\n          socket.on 'shrub-user\/logout', logout\n\n## user.isLoggedIn\n\n*Whether the current application user is logged in.*\n\n          service.isLoggedIn = -> _instance.id?\n\n## user.login\n\n*Log in with method and args.*\n\n###### TODO: username and password are tightly coupled to local strategy. Change that.\n\n          service.login = (method, username, password) ->\n\n            rpc.call(\n              'shrub-user\/login'\n              method: method\n              username: username\n              password: password\n\n            ).then (O) ->\n              _instance[k] = v for k, v of O\n              return\n\n## user.logout\n\n*Log out.*\n\n          service.logout = ->\n\n            rpc.call(\n              'shrub-user\/logout'\n\n            ).then logout\n\n## user.instance\n\n*Retrieve the user instance.*\n\n          service.instance = -> _instance\n\n          if config.get 'packageConfig:shrub-core:testMode'\n\n## user.fakeLogin\n\n*Mock a login process.*\n\n###### TODO: This will change when login method generalization happens.\n\n            service.fakeLogin = (username, password, id) ->\n              password ?= 'password'\n              id ?= 1\n\n              socket.catchEmit 'shrub-rpc', ({path, data}, fn) ->\n                return unless 'shrub-user\/login' is path\n\n                fn result: id: id, name: username\n\n              service.login 'local', username, password\n\n          service\n\n      ]\n\n      registrar.recur [\n        'email', 'forgot', 'login', 'logout', 'register', 'reset'\n      ]\n\n    exports.shrubOrmCollections = ->\n\n      Group =\n\n        associations: [\n          alias: 'permissions'\n        ]\n\n        attributes:\n\n          name:\n            type: 'string'\n            size: 24\n            maxLength: 24\n\n          permissions:\n            collection: 'shrub-group-permission'\n            via: 'group'\n\n      GroupPermission =\n\n        attributes:\n\n          permission: 'string'\n\n          group: model: 'shrub-group'\n\n###### TODO: Finish collection docs.\n\n      User =\n\n        associations: [\n          alias: 'groups'\n        ,\n          alias: 'permissions'\n        ]\n\n        attributes:\n\nLast time this user was accessed.\n\n          lastAccessed:\n            type: 'datetime'\n            defaultsTo: -> new Date()\n\nEmail address.\n\n          email:\n            type: 'string'\n            index: true\n\nName.\n\n          name:\n            type: 'string'\n            defaultsTo: 'Anonymous'\n            size: 24\n            maxLength: 24\n\nGroups this user belongs to.\n\n          groups:\n            collection: 'shrub-user-group'\n            via: 'user'\n\nGroups this user belongs to.\n\n          permissions:\n            collection: 'shrub-user-permission'\n            via: 'user'\n\nCheck whether a user has a permission.\n\n          hasPermission: (permission) ->\n\nSuperuser?\n\n            return true if @id is 1\n\nCheck group permissions.\n\n            for {permissions} in @groups\n              return true if ~permissions.indexOf permission\n\nCheck inline permissions.\n\n            return ~@permissions.indexOf permission\n\n      UserGroup =\n\n        attributes:\n\n          group: model: 'shrub-group'\n\n          user: model: 'shrub-user'\n\n      UserPermission =\n\n        attributes:\n\n          permission: 'string'\n\n          user: model: 'shrub-user'\n\n      'shrub-group': Group\n      'shrub-group-permission': GroupPermission\n      'shrub-user': User\n      'shrub-user-group': UserGroup\n      'shrub-user-permission': UserPermission\n\n    exports.shrubOrmCollectionsAlter = (collections) ->\n\n      Promise = require 'bluebird'\n\n      {'shrub-user': User} = collections\n\nImplement all the built-in collection methods as authenticated versions, which\ntake a user.\n\n###### TODO: This is legacy from having full ORM in browser. What do?\n\n      for identity, collection of collections\n        do (identity, collection) ->\n\n          # validateUser = (user) ->\n\n          # \tnew Promise (resolve, reject) ->\n\n          # \t\t# `TODO`: See if we can do this without using the internal\n          # \t\t# _model property.\n          # \t\treturn resolve()# if user instanceof User._model\n\n          # \t\terror = new Error \"Invalid user.\"\n          # \t\terror.code = 500\n          # \t\treject error\n\n          # checkPermission = (user, perm) ->\n\n          # \treturn if user.hasPermission perm\n\n          # \terror = new Error \"Forbidden.\"\n          # \terror.code = 403\n          # \tthrow error\n\n          # # Secure by default.\n          # collection.attributes.isAccessibleBy ?= (user) -> false\n\n          # collection.authenticatedAll = (user, params) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\tcheckPermission user, \"shrub-orm:#{name}:all\"\n\n          # \t).then(->\n          # \t\torm.collection(identity).all params\n\n          # \t).then (models) ->\n          # \t\treturn models if models.length > 0\n\n          # \t\terror = new Error \"Collection not found.\"\n          # \t\terror.code = 404\n          # \t\tPromise.reject error\n\n          # collection.authenticatedCount = (user) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\tcheckPermission user, \"shrub-orm:#{name}:count\"\n\n          # \t).then -> orm.collection(identity).count()\n\n          # collection.authenticatedCreate = (user, attributes) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\tcheckPermission user, \"shrub-orm:#{name}:create\"\n\n          # \t).then -> orm.collection(identity).create attributes\n\n          # collection.authenticatedDestroy = (user, id) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\tcheckPermission user, \"shrub-orm:#{name}:create\"\n\n          # \t).then(->\n          # \t\tcollection.authenticatedFind user, id\n\n          # \t).then (model) ->\n          # \t\treturn model.destroy() if model.isDeletableBy user\n\n          # \t\tif model.isAccessibleBy user\n          # \t\t\terror = new Error \"Access denied.\"\n          # \t\t\terror.code = 403\n          # \t\telse\n          # \t\t\terror = new Error \"Resource not found.\"\n          # \t\t\terror.code = 404\n\n          # \t\tPromise.reject error\n\n          # collection.authenticatedDestroyAll = (user) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\tcheckPermission \"shrub-orm:#{name}:destroyAll\"\n\n          # \t).then -> orm.collection(identity).destroyAll()\n\n          # collection.authenticatedFind = (user, id) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\torm.collection(identity).find id\n\n          # \t).then (model) ->\n          # \t\treturn model if model? and model.isAccessibleBy user\n\n          # \t\terror = new Error \"Resource not found.\"\n          # \t\terror.code = 404\n          # \t\tPromise.reject error\n\n          # collection.authenticatedUpdate = (user, id, attributes) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\tcollection.authenticatedFind user, id\n\n          # \t).then (model) ->\n          # \t\tif model.isEditableBy user\n          # \t\t\tfor k, v of attributes\n          # \t\t\t\tmodel[k] = v\n          # \t\t\tmodel.id = id\n          # \t\t\treturn model.save()\n\n          # \t\tif model.isAccessibleBy user\n          # \t\t\terror = new Error \"Access denied.\"\n          # \t\t\terror.code = 403\n          # \t\telse\n          # \t\t\terror = new Error \"Resource not found.\"\n          # \t\t\terror.code = 404\n\n          # \t\tPromise.reject error\n\n          collection.attributes.isAccessibleBy ?= (user) -> false\n          collection.attributes.isEditableBy ?= (user) -> false\n          collection.attributes.isDeletableBy ?= (user) -> false\n\n      return\n","old_contents":"# User\n\n*User operations, model, etc.*\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubOrmCollections`.\n\n      registrar.registerHook 'shrubOrmCollections', exports.shrubOrmCollections\n\n#### Implements hook `shrubOrmCollectionsAlter`.\n\n      registrar.registerHook 'shrubOrmCollectionsAlter', exports.shrubOrmCollectionsAlter\n\n#### Implements hook `shrubAngularDirective`.\n\n      registrar.registerHook 'shrubAngularDirective', -> [\n        'shrub-user'\n        (user) ->\n\n          directive = {}\n\n          directive.link = (scope) -> scope.user = user\n\n          directive.scope = {}\n\n          directive.template = '''\n\n    <span class=\"user\">\n      <span class=\"username\" data-ng-bind=\"user.instance().name\"><\/span>\n\n      <span\n        class=\"actions\"\n        data-ng-if=\"!user.isLoggedIn()\"\n      >\n        [<a href=\"\/user\/login\">Log in<\/a> \u00b7 <a href=\"\/user\/register\">Register<\/a>]\n      <\/span>\n\n      <span\n        class=\"actions\"\n        data-ng-if=\"user.isLoggedIn()\"\n      >\n        [<a href=\"\/user\/logout\">Log out<\/a>]\n      <\/span>\n\n    <\/span>\n\n    '''\n\n          return directive\n\n      ]\n\n#### Implements hook `shrubAngularService`.\n\n      registrar.registerHook 'shrubAngularService', -> [\n        'shrub-orm', 'shrub-rpc', 'shrub-socket'\n        (orm, rpc, socket) ->\n\n          config = require 'config'\n\n          User = orm.collection 'shrub-user'\n\n          service = {}\n\n          _instance = {}\n          _instance[k] = v for k, v of User.instantiate(\n            config.get 'packageConfig:shrub-user'\n          )\n\nLog a user out if we get a socket call.\n\n          logout = ->\n\n            blank = User.instantiate()\n            delete _instance[k] for k of _instance\n            _instance[k] = v for k, v of blank\n\n            return\n\n          socket.on 'shrub-user\/logout', logout\n\n## user.isLoggedIn\n\n*Whether the current application user is logged in.*\n\n          service.isLoggedIn = -> _instance.id?\n\n## user.login\n\n*Log in with method and args.*\n\n###### TODO: username and password are tightly coupled to local strategy. Change that.\n\n          service.login = (method, username, password) ->\n\n            rpc.call(\n              'shrub-user\/login'\n              method: method\n              username: username\n              password: password\n\n            ).then (O) ->\n              _instance[k] = v for k, v of O\n              return\n\n## user.logout\n\n*Log out.*\n\n          service.logout = ->\n\n            rpc.call(\n              'shrub-user\/logout'\n\n            ).then logout\n\n## user.instance\n\n*Retrieve the user instance.*\n\n          service.instance = -> _instance\n\n          if config.get 'packageConfig:shrub-core:testMode'\n\n## user.fakeLogin\n\n*Mock a login process.*\n\n###### TODO: This will change when login method generalization happens.\n\n            service.fakeLogin = (username, password, id) ->\n              password ?= 'password'\n              id ?= 1\n\n              socket.catchEmit 'shrub-rpc', ({path, data}, fn) ->\n                return unless 'shrub-user\/login' is path\n\n                fn result: id: id, name: username\n\n              service.login 'local', username, password\n\n          service\n\n      ]\n\n      registrar.recur [\n        'email', 'forgot', 'login', 'logout', 'register', 'reset'\n      ]\n\n    exports.shrubOrmCollections = ->\n\n      Group =\n\n        associations: [\n          alias: 'permissions'\n        ]\n\n        attributes:\n\n          name:\n            type: 'string'\n            size: 24\n            maxLength: 24\n\n          permissions:\n            collection: 'shrub-group-permission'\n            via: 'group'\n\n      GroupPermission =\n\n        associations: [\n          alias: 'shrub-group'\n        ]\n\n        attributes:\n\n          permission: 'string'\n\n          group: model: 'shrub-group'\n\n###### TODO: Finish collection docs.\n\n      User =\n\n        associations: [\n          alias: 'groups'\n        ,\n          alias: 'permissions'\n        ]\n\n        attributes:\n\nLast time this user was accessed.\n\n          lastAccessed:\n            type: 'datetime'\n            defaultsTo: -> new Date()\n\nEmail address.\n\n          email:\n            type: 'string'\n            index: true\n\nName.\n\n          name:\n            type: 'string'\n            defaultsTo: 'Anonymous'\n            size: 24\n            maxLength: 24\n\nGroups this user belongs to.\n\n          groups:\n            collection: 'shrub-user-group'\n            via: 'user'\n\nGroups this user belongs to.\n\n          permissions:\n            collection: 'shrub-user-permission'\n            via: 'user'\n\nCheck whether a user has a permission.\n\n          hasPermission: (permission) ->\n\nSuperuser?\n\n            return true if @id is 1\n\nCheck group permissions.\n\n            for {permissions} in @groups\n              return true if ~permissions.indexOf permission\n\nCheck inline permissions.\n\n            return ~@permissions.indexOf permission\n\n      UserGroup =\n\n        attributes:\n\n          group: model: 'shrub-group'\n\n          user: model: 'shrub-user'\n\n      UserPermission =\n\n        attributes:\n\n          permission: 'string'\n\n          user: model: 'shrub-user'\n\n      'shrub-group': Group\n      'shrub-group-permission': GroupPermission\n      'shrub-user': User\n      'shrub-user-group': UserGroup\n      'shrub-user-permission': UserPermission\n\n    exports.shrubOrmCollectionsAlter = (collections) ->\n\n      Promise = require 'bluebird'\n\n      {'shrub-user': User} = collections\n\nImplement all the built-in collection methods as authenticated versions, which\ntake a user.\n\n###### TODO: This is legacy from having full ORM in browser. What do?\n\n      for identity, collection of collections\n        do (identity, collection) ->\n\n          # validateUser = (user) ->\n\n          # \tnew Promise (resolve, reject) ->\n\n          # \t\t# `TODO`: See if we can do this without using the internal\n          # \t\t# _model property.\n          # \t\treturn resolve()# if user instanceof User._model\n\n          # \t\terror = new Error \"Invalid user.\"\n          # \t\terror.code = 500\n          # \t\treject error\n\n          # checkPermission = (user, perm) ->\n\n          # \treturn if user.hasPermission perm\n\n          # \terror = new Error \"Forbidden.\"\n          # \terror.code = 403\n          # \tthrow error\n\n          # # Secure by default.\n          # collection.attributes.isAccessibleBy ?= (user) -> false\n\n          # collection.authenticatedAll = (user, params) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\tcheckPermission user, \"shrub-orm:#{name}:all\"\n\n          # \t).then(->\n          # \t\torm.collection(identity).all params\n\n          # \t).then (models) ->\n          # \t\treturn models if models.length > 0\n\n          # \t\terror = new Error \"Collection not found.\"\n          # \t\terror.code = 404\n          # \t\tPromise.reject error\n\n          # collection.authenticatedCount = (user) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\tcheckPermission user, \"shrub-orm:#{name}:count\"\n\n          # \t).then -> orm.collection(identity).count()\n\n          # collection.authenticatedCreate = (user, attributes) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\tcheckPermission user, \"shrub-orm:#{name}:create\"\n\n          # \t).then -> orm.collection(identity).create attributes\n\n          # collection.authenticatedDestroy = (user, id) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\tcheckPermission user, \"shrub-orm:#{name}:create\"\n\n          # \t).then(->\n          # \t\tcollection.authenticatedFind user, id\n\n          # \t).then (model) ->\n          # \t\treturn model.destroy() if model.isDeletableBy user\n\n          # \t\tif model.isAccessibleBy user\n          # \t\t\terror = new Error \"Access denied.\"\n          # \t\t\terror.code = 403\n          # \t\telse\n          # \t\t\terror = new Error \"Resource not found.\"\n          # \t\t\terror.code = 404\n\n          # \t\tPromise.reject error\n\n          # collection.authenticatedDestroyAll = (user) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\tcheckPermission \"shrub-orm:#{name}:destroyAll\"\n\n          # \t).then -> orm.collection(identity).destroyAll()\n\n          # collection.authenticatedFind = (user, id) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\torm.collection(identity).find id\n\n          # \t).then (model) ->\n          # \t\treturn model if model? and model.isAccessibleBy user\n\n          # \t\terror = new Error \"Resource not found.\"\n          # \t\terror.code = 404\n          # \t\tPromise.reject error\n\n          # collection.authenticatedUpdate = (user, id, attributes) ->\n\n          # \tvalidateUser(user).then(->\n          # \t\tcollection.authenticatedFind user, id\n\n          # \t).then (model) ->\n          # \t\tif model.isEditableBy user\n          # \t\t\tfor k, v of attributes\n          # \t\t\t\tmodel[k] = v\n          # \t\t\tmodel.id = id\n          # \t\t\treturn model.save()\n\n          # \t\tif model.isAccessibleBy user\n          # \t\t\terror = new Error \"Access denied.\"\n          # \t\t\terror.code = 403\n          # \t\telse\n          # \t\t\terror = new Error \"Resource not found.\"\n          # \t\t\terror.code = 404\n\n          # \t\tPromise.reject error\n\n          collection.attributes.isAccessibleBy ?= (user) -> false\n          collection.attributes.isEditableBy ?= (user) -> false\n          collection.attributes.isDeletableBy ?= (user) -> false\n\n      return\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"059131e3b173fe3c1698841cc635a6357d5479ae","subject":"document replacement from JSON","message":"document replacement from JSON\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/03_app_internals\/24c_plural_associations.litcoffee","new_file":"docs\/03_app_internals\/24c_plural_associations.litcoffee","new_contents":"# \/api\/App Internals\/Batman.Association\/Batman.PluralAssociation\n\n`Batman.PluralAssociation` extends `Batman.Association`. It is an abstract class extended by `Batman.HasManyAssociation` and `Batman.PolymorphicHasManyAssociation`.\n\n## ::constructor(@model, @label, options[={}]) : PluralAssociation\n\n## ::provideDefaults() : Option\n\nExtends default options from `Batman.Association` with:\n\n- `name`: camelized and singularized `@label`\n\n## ::setForRecord(record) : Set\n\nReturns a `Batman.AssociationSet` for `record`'s children.\n\n## ::setForKey(indexValue) : Set\n\nReturns a `Batman.AssociationSet` for children whose foreign key is `indexValue`.\n\n## ::proxyClassInstanceForKey(indexValue)\n\nReturns a new instance of `proxyClass` for `indexValue`.\n\n## ::getAccessor(self, model, label)\n\nReturns the appropriate `Batman.AssociationSet` as this association's value.\n\n## ::parentSetIndex() : UniqueSetIndex\n\nReturns `@model`'s loaded set, indexed by `@primaryKey`.\n\n## ::setIndex() : SetIndex\n\nReturns a `Batman.AssociationSetIndex` for this association.\n\n## ::indexValueForRecord(record)\n\nReturns `record`'s value for `@primaryKey`.\n\n## ::.proxyClass[=Batman.AssociationSet]\n## ::.isSingular[=false]\n## ::reset()\n\n# \/api\/App Internals\/Batman.Association\/Batman.HasManyAssociation\n\n`Batman.HasManyAssociation` backs associations defined with `@hasMany`. If the `as` option is passed, it will be backed with `Batman.PolymorphicHasManyAssociation` instead.\n\n## ::constructor(model, label, options)\n\nReturns a `Batman.PolymorphicHasManyAssociation` if `options.as`. Otherwise, returns a new `Batman.HasManyAssociation`.\n\n## ::provideDefaults() : Object\n\nExtends defaults from `Batman.PluralAssociation` with:\n\n- `primaryKey`: `\"id\"`\n- `foreignKey`: `\"#{Batman.helpers.underscore(@model.get('resourceName'))}_id\"`\n- `replaceFromJSON`: true\n\n## ::apply(baseSaveError, base)\n\nCalled after the `hasMany` parent is saved. It updates all foreign keys on child records and marks the `Batman.AssociationSet` as loaded.\n\n## ::encoder() : Function\n\nReturns a function for turning the association into JSON. if `@options.encodeWithIndexes` is true, it encodes into an object whose keys are indexes. Otherwise, it encodes into an array.\n\n## ::decoder() : Function\n\nReturns a function that decodes the association from an array. When it is loading records, it adds any new records to their respective `loaded` sets.\n\nIf `@options.replaceFromJSON` is true, objects which aren't represented in the incoming JSON will be removed from the `AssociationSet`. You can pass `replaceFromJSON: false` in the association declaration to prevent this.\n\n# \/api\/App Internals\/Batman.Association\/Batman.PolymorphicHasManyAssociation\n\n`Batman.PolymorphicHasManyAssociation` extends `Batman.HasManyAssociation` and backs associations defined with `@hasMany as: \"...\"`.\n\n## ::constructor(model, label, options) : PolymorphicHasManyAssociation\n\nAssigns `options.as` to `@foreignLabel`, then deletes the option and calls super.\n\n## ::provideDefaults() : Object\n\nExtends default options from `Batman.HasManyAssociation` with:\n\n- `inverseOf`: `options.as`\n- `foreignKey`: `{options.as}_id`\n\n## ::provideDefaults() :\n## ::apply(baseSaveError, base)\n\nUpdates children's `foreignTypeKey` to `@modelType()`.\n\n## ::proxyClassInstanceForKey(indexValue)\n\nReturns a new instance of `@proxyClass` for `indexValue` and `@modelType()`.\n\n## ::getRelatedModelForType(type)\n\nIf `type` is passed, it will search for a model with name `type` or camelized `type`. Otherwise, it will use `@getRelatedModel()`.\n\n## ::modelType()\n\nReturns the `resourceName` of `@model`.\n\n## ::setIndex()\n\nRreturns a `Batman.PolymorphicAssociationSetIndex` for this association.\n\n## ::encoder() : Function\n\nReturns a function that encodes the association into an array.\n\n## ::decoder() : Function\n\nReturns a function that decodes the association from an array. It also adds new records to their `loaded` sets.\n\nIf `@options.replaceFromJSON` is true, objects which aren't represented in the incoming JSON will be removed from the set. You can pass `replaceFromJSON: false` in the association declaration to prevent this.\n\n## ::.proxyClass[=Batman.PolymorphicAssociationSet]\n## ::.isPolymorphic[=true]","old_contents":"# \/api\/App Internals\/Batman.Association\/Batman.PluralAssociation\n\n`Batman.PluralAssociation` extends `Batman.Association`. It is an abstract class extended by `Batman.HasManyAssociation` and `Batman.PolymorphicHasManyAssociation`.\n\n## ::constructor(@model, @label, options[={}]) : PluralAssociation\n\n## ::provideDefaults() : Option\n\nExtends default options from `Batman.Association` with:\n\n- `name`: camelized and singularized `@label`\n\n## ::setForRecord(record) : Set\n\nReturns a `Batman.AssociationSet` for `record`'s children.\n\n## ::setForKey(indexValue) : Set\n\nReturns a `Batman.AssociationSet` for children whose foreign key is `indexValue`.\n\n## ::proxyClassInstanceForKey(indexValue)\n\nReturns a new instance of `proxyClass` for `indexValue`.\n\n## ::getAccessor(self, model, label)\n\nReturns the appropriate `Batman.AssociationSet` as this association's value.\n\n## ::parentSetIndex() : UniqueSetIndex\n\nReturns `@model`'s loaded set, indexed by `@primaryKey`.\n\n## ::setIndex() : SetIndex\n\nReturns a `Batman.AssociationSetIndex` for this association.\n\n## ::indexValueForRecord(record)\n\nReturns `record`'s value for `@primaryKey`.\n\n## ::.proxyClass[=Batman.AssociationSet]\n## ::.isSingular[=false]\n## ::reset()\n\n# \/api\/App Internals\/Batman.Association\/Batman.HasManyAssociation\n\n`Batman.HasManyAssociation` backs associations defined with `@hasMany`. If the `as` option is passed, it will be backed with `Batman.PolymorphicHasManyAssociation` instead.\n\n## ::constructor(model, label, options)\n\nReturns a `Batman.PolymorphicHasManyAssociation` if `options.as`. Otherwise, returns a new `Batman.HasManyAssociation`.\n\n## ::provideDefaults() : Object\n\nExtends defaults from `Batman.PluralAssociation` with:\n\n- `primaryKey`: `\"id\"`\n- `foreignKey`: `\"#{Batman.helpers.underscore(@model.get('resourceName'))}_id\"`\n\n## ::apply(baseSaveError, base)\n\nCalled after the `hasMany` parent is saved. It updates all foreign keys on child records and marks the `Batman.AssociationSet` as loaded.\n\n## ::encoder() : Function\n\nReturns a function for turning the association into JSON. if `@options.encodeWithIndexes` is true, it encodes into an object whose keys are indexes. Otherwise, it encodes into an array.\n\n## ::decoder() : Function\n\nReturns a function that decodes the association from an array. When it is loading records, it adds any new records to their respective `loaded` sets.\n\nEven if a record is not in the JSON, it won't be removed from the association set. You must do this yourself.\n\n# \/api\/App Internals\/Batman.Association\/Batman.PolymorphicHasManyAssociation\n\n`Batman.PolymorphicHasManyAssociation` extends `Batman.HasManyAssociation` and backs associations defined with `@hasMany as: \"...\"`.\n\n## ::constructor(model, label, options) : PolymorphicHasManyAssociation\n\nAssigns `options.as` to `@foreignLabel`, then deletes the option and calls super.\n\n## ::provideDefaults() : Object\n\nExtends default options from `Batman.HasManyAssociation` with:\n\n- `inverseOf`: `options.as`\n- `foreignKey`: `{options.as}_id`\n\n## ::provideDefaults() :\n## ::apply(baseSaveError, base)\n\nUpdates children's `foreignTypeKey` to `@modelType()`.\n\n## ::proxyClassInstanceForKey(indexValue)\n\nReturns a new instance of `@proxyClass` for `indexValue` and `@modelType()`.\n\n## ::getRelatedModelForType(type)\n\nIf `type` is passed, it will search for a model with name `type` or camelized `type`. Otherwise, it will use `@getRelatedModel()`.\n\n## ::modelType()\n\nReturns the `resourceName` of `@model`.\n\n## ::setIndex()\n\nRreturns a `Batman.PolymorphicAssociationSetIndex` for this association.\n\n## ::encoder() : Function\n\nReturns a function that encodes the association into an array.\n\n## ::decoder() : Function\n\nReturns a function that decodes the association from an array. It also adds new records to their `loaded` sets.\n\nEven if a record _is not_ present in the JSON, it won't be removed from the association set. You must remove records yourself.\n\n## ::.proxyClass[=Batman.PolymorphicAssociationSet]\n## ::.isPolymorphic[=true]","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a5036b22c603bff32ba2f2facb4cdb42eb8947d3","subject":"Improve docs of server.litcoffee","message":"Improve docs of server.litcoffee\n","repos":"wbbaddons\/nodePush,wbbaddons\/nodePush,wbbaddons\/nodePush","old_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_file":"file\/acp\/be.bastelstu.wcf.nodePush\/lib\/server.litcoffee","new_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\tconfig = require '..\/config.js'\n\nInitialize sane values.\n\n\tconfig.port ?= 9001\n\tconfig.host ?= '0.0.0.0'\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\nLocation of the unix socket.\n\n\t\tunixSocket: \"#{__dirname}\/..\/inbound.sock\"\n\nInstance of express.\n\n\t\tapp: null\n\nInstance of http\n\n\t\tserver: null\n\nInstance of socket.io\n\n\t\tio: null\n\nStatistics for the status page.\n\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting nodePush'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tlog \"Using port: #{config.port}\"\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing Frontend'\n\nStart HTTP service.\n\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\t@server.listen config.port, config.host, null, =>\n\nShed root privilegies.\n\n\t\t\t\tif process.getuid() is 0 or process.getgid() is 0\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.type 'text\/plain'\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\nPass data to the browsers and close connection.\n\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\nKill connection after 5 seconds.\n\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\tsocket.listen @unixSocket\n\t\t\tfs.chmod @unixSocket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync @unixSocket\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","old_contents":"nodePush Pushserver for Tims Chat\n=================================\n\nCopyright Information\n---------------------\n\n\t\"@author\tTim D\u00fcsterhus\"\n\t\"@copyright\t2012-2013 Tim D\u00fcsterhus\"\n\t\"@license\tBSD 3-Clause License <http:\/\/opensource.org\/licenses\/BSD-3-Clause>\"\n\t\"@package\tbe.bastelstu.wcf.nodePush\"\n\nSetup\n-----\n\nLoad required namespaces.\n\n\texpress = require 'express'\n\thttp = require 'http'\n\tio = require 'socket.io'\n\tnet = require 'net'\n\tfs = require 'fs'\n\nLoad config\n\n\tconfig = require '..\/config.js'\n\nInitialize sane values.\n\n\tconfig.port ?= 9001\n\tconfig.host ?= '0.0.0.0'\n\tconfig.user ?= 'nobody'\n\tconfig.group ?= 'nogroup'\n\nPrepare environment\n\n\tlog = (message) ->\n\t\tconsole.log \"[be.bastelstu.chat.nodePush] #{message}\"\n\t\n\tthousandsSeparator = (number) ->\n\t\tString(number).replace \/(^-?\\d{1,3}|\\d{3})(?=(?:\\d{3})+(?:$|\\.))\/g, '$1,'\n\n\t# Ensure our namespace is present\n\tbe = be ? {}\n\tbe.bastelstu ?= {}\n\tbe.bastelstu.chat ?= {}\n\nbe.bastelstu.chat.nodePush\n==========================\n\n\tclass be.bastelstu.chat.nodePush\n\t\nAttributes\n----------\n\t\tunixSocket: \"#{__dirname}\/..\/inbound.sock\"\n\t\tapp: null\n\t\tserver: null\n\t\tio: null\n\t\tstats:\n\t\t\tstatus: 0\n\t\t\toutbound: \n\t\t\t\ttotal: 0\n\t\t\t\tcurrent: 0\n\t\t\tinbound: 0\n\t\t\tmessages: { }\n\t\t\tbootTime: new Date()\n\nMethods\n-------\n**constructor()**\n\n\t\tconstructor: ->\n\t\t\tlog 'Starting nodePush'\n\t\t\tlog \"PID is #{process.pid}\"\n\t\t\tlog \"Using port: #{config.port}\"\n\t\t\t\n\t\t\t@stats.bootTime = new Date()\n\t\t\t\n\t\t\t@initUnixSocket()\n\t\t\t@initServer()\n\t\t\t\nBind shutdown function to needed events.\n\n\t\t\tprocess.on 'exit', @shutdown.bind @\n\t\t\tprocess.on 'uncaughtException', @shutdown.bind @\n\t\t\tprocess.on 'SIGINT', @shutdown.bind @\n\t\t\tprocess.on 'SIGTERM', @shutdown.bind @\n\nSet nice title for PS.\n\n\t\t\tprocess.title = 'nodePush - Tims Chat'\n\n**initServer()**  \nInitialize socket server.\n\n\t\tinitServer: ->\n\t\t\tlog 'Initializing Frontend'\n\t\t\t@app = express()\n\t\t\t@server = http.createServer @app\n\t\t\t@io = io.listen @server\n\t\t\t\n\t\t\t@server.listen config.port, config.host, null, =>\n\t\t\t\tif process.getuid() is 0 or process.getgid() is 0\n\t\t\t\t\ttry\n\t\t\t\t\t\tlog 'Trying to shed root privilegies'\n\t\t\t\t\t\tprocess.setgid config.group\n\t\t\t\t\t\tprocess.setuid config.user\n\t\t\t\t\t\tlog \"New User ID: #{process.getuid()}, New Group ID: #{process.getgid()}\"\n\t\t\t\t\tcatch e\n\t\t\t\t\t\tlog 'Cowardly refusing to keep the process alive as root.'\n\t\t\t\t\t\tprocess.exit 1\n\nInitialize intervals for tick events. The ticks are sent every 15 \/ 30 \/ 60 \/ 90 \/ 120 seconds.\n\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick15'\n\t\t\t\t, 15e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick30'\n\t\t\t\t, 30e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick60'\n\t\t\t\t, 60e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick90'\n\t\t\t\t, 90e3\n\t\t\t\tsetInterval =>\n\t\t\t\t\t@sendMessage 'tick120'\n\t\t\t\t, 120e3\n\t\t\t\t\n\t\t\t\tlog \"Done\"\n\nInitialize production environment.\n\n\t\t\t@io.set 'log level', 1\n\t\t\t@io.set 'browser client etag', true\n\t\t\t@io.set 'browser client minification', true\n\t\t\t@io.set 'browser client gzip', true\n\nDevelopment configuration.\n\n\t\t\t@io.configure 'development', =>\n\t\t\t\t@io.set 'log level', 3\n\t\t\t\t@io.set 'browser client etag', false\n\t\t\t\t@io.set 'browser client minification', false\n\nRecord statistics for Websocket connections.\n\n\t\t\t@io.sockets.on 'connection', (socket) =>\n\t\t\t\t@stats.outbound.total++\n\t\t\t\t@stats.outbound.current++\n\t\t\t\t\n\t\t\t\tsocket.on 'disconnect', =>\n\t\t\t\t\t@stats.outbound.current--\n\nShow the status page when '\/' is requested.\n\n\t\t\t@app.get '\/', (req, res) =>\n\t\t\t\tres.type 'text\/plain'\n\t\t\t\t@stats.status++\n\t\t\t\treply = \"\"\"\n\t\t\t\tUp since: #{@stats.bootTime}\n\t\t\t\tStatus page: #{thousandsSeparator @stats.status} Requests\n\t\t\t\tOutbound: #{thousandsSeparator @stats.outbound.current} now - #{thousandsSeparator @stats.outbound.total} Total\n\t\t\t\tInbound: #{thousandsSeparator @stats.inbound}\n\t\t\t\tMessages:\n\t\t\t\t\"\"\"\n\t\t\t\tfor message, amount of @stats.messages\n\t\t\t\t\treply += \"\\n\t#{message}: #{thousandsSeparator amount}\"\n\t\t\t\t\n\t\t\t\tres.send reply\n\n**sendMessage(name)**  \nSends a message with the given name.\n\n\t\tsendMessage: (name) ->\n\t\t\t@stats.messages[name] ?= 0\n\t\t\t@stats.messages[name]++\n\t\t\t@io.sockets.send name\n\n**initUnixSocket()**  \nInitialize PHP side unix socket.\n\n\t\tinitUnixSocket: ->\n\t\t\tlog 'Initializing inbound socket'\n\t\t\tsocket = net.createServer (c) =>\n\t\t\t\t@stats.inbound++\n\t\t\t\t\n\t\t\t\tc.on 'data', (data) =>\n\t\t\t\t\tsetTimeout =>\n\t\t\t\t\t\t@sendMessage data.toString().trim()\n\t\t\t\t\t, 20\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.on 'end', ->\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\t\tc.setTimeout 5e3, ->\n\t\t\t\t\tc.end()\n\t\t\t\t\n\t\t\tsocket.listen @unixSocket\n\t\t\tfs.chmod @unixSocket, '777'\n\n**shutdown()**  \nPerforms a clean shutdown of nodePush.\n\n\t\tshutdown: (message) ->\n\t\t\tif not message\n\t\t\t\tlog 'Shutting down'\n\t\t\telse\n\t\t\t\tlog \"Shutting down: #{message}\"\n\t\t\t\n\t\t\tfs.unlinkSync @unixSocket\n\t\t\t\n\t\t\tprocess.removeAllListeners()\n\t\t\tprocess.exit()\n\nAnd finally start the service.\n\n\tnew be.bastelstu.chat.nodePush()","returncode":0,"stderr":"","license":"agpl-3.0","lang":"Literate CoffeeScript"}
{"commit":"bb6ae77bdd36d8af6523f77cb8212124a1e9d18e","subject":"<style> unknown parent queries bug fixed","message":"<style> unknown parent queries bug fixed\n","repos":"Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft,Neft-io\/neft","old_file":"src\/document\/file\/parse\/styles.litcoffee","new_file":"src\/document\/file\/parse\/styles.litcoffee","new_contents":"# style\n\n    'use strict'\n\n    fs = require 'fs-extra'\n    os = require 'os'\n    utils = require 'src\/utils'\n    pathUtils = require 'path'\n    bundleStyle = null\n\n    uid = 0\n    realpath = fs.realpathSync '.\/'\n    tmpdir = os.tmpdir()\n\n    module.exports = (File) -> (file) ->\n        bundleStyle = Neft.nmlParser.bundle\n\n        queries = []\n        addedStyles = {}\n\n        if file instanceof File.Iterator\n            return\n\n        styleTags = []\n        stylePath = \"styles:#{file.path}\"\n        for tag in file.node.children\n            if tag.name isnt 'style'\n                continue\n\n            styleTags.push tag\n\n            # tag body\n            str = tag.stringifyChildren()\n            styleFile =\n                data: str\n                path: \"#{file.path}.js\"\n                filename: file.path\n            bundleStyle styleFile\n\n            if utils.isEmpty(styleFile.codes)\n                continue\n\n            File.onStyle.emit styleFile\n\n            for query, style of styleFile.queries\n                itemPath = \"#{stylePath}:#{style}\"\n                addedStyles[itemPath] = true\n                queries.push\n                    query: query\n                    style: itemPath\n\n            # detect main item with no document.query\n            unless file.node.props['n-style']\n                mainHasDoc = false\n                mainId = styleFile.codes._main.link\n                for _, id of styleFile.queries\n                    if id is mainId\n                        mainHasDoc = true\n                        break\n                unless mainHasDoc\n                    file.node.props.set 'n-style', \"#{stylePath}:#{mainId}\"\n\n        while styleTags.length > 0\n            styleTags.pop().parent = null\n\n        unless utils.isEmpty(queries)\n            File.Style.applyStyleQueriesInDocument file, queries\n\n        return\n\n# Glossary\n\n- [style](#style)\n","old_contents":"# style\n\n    'use strict'\n\n    fs = require 'fs-extra'\n    os = require 'os'\n    utils = require 'src\/utils'\n    pathUtils = require 'path'\n    bundleStyle = null\n\n    uid = 0\n    realpath = fs.realpathSync '.\/'\n    tmpdir = os.tmpdir()\n\n    module.exports = (File) -> (file) ->\n        bundleStyle = Neft.nmlParser.bundle\n\n        queries = []\n        addedStyles = {}\n\n        if file instanceof File.Iterator\n            return\n\n        styleTags = []\n        stylePath = \"styles:#{file.path}\"\n        for tag in file.node.children\n            if tag.name isnt 'style'\n                continue\n\n            styleTags.push tag\n\n            # tag body\n            str = tag.stringifyChildren()\n            styleFile =\n                data: str\n                path: \"#{file.path}.js\"\n                filename: file.path\n            bundleStyle styleFile\n\n            if utils.isEmpty(styleFile.codes)\n                continue\n\n            File.onStyle.emit styleFile\n\n            for query, style of styleFile.queries\n                itemPath = \"#{stylePath}:#{style}\"\n                addedStyles[itemPath] = true\n                queries.push\n                    query: query\n                    style: itemPath\n\n            # detect main item with no document.query\n            unless file.node.props['n-style']\n                mainHasDoc = false\n                mainId = styleFile.codes._main.link\n                for _, id of styleFile.queries\n                    if id is mainId\n                        mainHasDoc = true\n                        break\n                unless mainHasDoc\n                    file.node.props.set 'n-style', stylePath\n\n        while styleTags.length > 0\n            styleTags.pop().parent = null\n\n        unless utils.isEmpty(queries)\n            File.Style.applyStyleQueriesInDocument file, queries\n\n        return\n\n# Glossary\n\n- [style](#style)\n","returncode":0,"stderr":"","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"a65bd423c71385a558130315b3846a154d21611c","subject":"formatting","message":"formatting\n","repos":"cha0s\/shrub,cha0s\/shrub,cha0s\/shrub","old_file":"packages\/shrub-user\/login.litcoffee","new_file":"packages\/shrub-user\/login.litcoffee","new_contents":"\n    passport = null\n    Promise = null\n\n    clientModule = require '.\/client\/login'\n    userPackage = require '.\/index'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCorePreBootstrap`.\n\n      registrar.registerHook 'shrubCorePreBootstrap', ->\n\n        passport = require 'passport'\n        Promise = require 'bluebird'\n\n#### Implements hook `shrubRpcRoutes`.\n\n      registrar.registerHook 'shrubRpcRoutes', ->\n\n        {Limiter, LimiterMiddleware} = require 'shrub-limiter'\n\n        routes = []\n\n        routes.push\n\n          path: 'shrub-user\/login'\n\n          middleware: [\n\n            'shrub-http-express\/session'\n            'shrub-villiany'\n\n            'shrub-user'\n\n            new LimiterMiddleware(\n              message: 'You are logging in too much.'\n              threshold: Limiter.threshold(3).every(30).seconds()\n            )\n\n            (req, res, next) ->\n\n              errors = require 'errors'\n\n              promise = new Promise (resolve, reject) ->\n                req._passport.instance.authenticate(\n                  req.body.method\n                  (error, user, info) ->\n                    return reject error if error?\n                    resolve user, info\n\n                ) req, res\n\nLog the user in (if it exists), and redact it for the response.\n\n              promise.bind({}).then((@user, info) ->\n                throw errors.instantiate 'login' unless @user\n\n                req.logIn @user\n\n              ).then(->\n\n                new Promise (resolve, reject) =>\n\nJoin a channel for the username.\n\n                  req.socket.join @user.name, (error) ->\n                    return reject error if error?\n\n                    resolve()\n\n              ).then(->\n\n                @user.redactFor @user\n\n              ).then((user) ->\n\n                res.end user\n\n              ).catch next\n\n          ]\n\n        return routes\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        orm = require 'shrub-orm'\n\n        crypto = require 'server\/crypto'\n\n        label: 'Bootstrap user login'\n        middleware: [\n\n          (next) ->\n\nImplement a local passport strategy.\n\n###### TODO: Strategies should be dynamically defined through a hook.\n\n            LocalStrategy = require('passport-local').Strategy\n            passport.use new LocalStrategy (username, password, done) ->\n\nLoad a user and compare the hashed password.\n\n              Promise.cast(\n                userPackage.loadByName username\n              ).bind({}).then((@user) ->\n                return unless @user?\n\n                crypto.hasher(\n                  plaintext: password\n                  salt: new Buffer @user.salt, 'hex'\n                )\n\n              ).then((hashed) ->\n                return unless @user?\n                return unless @user.passwordHash is hashed.key.toString(\n                  'hex'\n                )\n\n                @user\n\n              ).nodeify done\n\n            passport.serializeUser (user, done) -> done null, user.id\n\n            passport.deserializeUser (id, done) ->\n              User = orm.collection 'shrub-user'\n              User.findOne(id: id).populateAll().then((user) ->\n                user.populateAll()\n              ).then((user) -> done null, user).catch done\n\n            next()\n\n        ]\n\n#### Implements hook `shrubTransmittableErrors`.\n\n      registrar.registerHook 'shrubTransmittableErrors', clientModule.shrubTransmittableErrors\n\nMonkey patch http.IncomingMessage.prototype.login to run our middleware, and\nreturn a promise.\n\n    exports.monkeyPatchLogin = (req, res, next) ->\n\n      middleware = require 'middleware'\n\n#### Invoke hook `shrubUserBeforeLoginMiddleware`.\n\n      beforeLoginMiddleware = middleware.fromConfig(\n        'shrub-user:beforeLoginMiddleware'\n      )\n\n#### Invoke hook `shrubUserAfterLoginMiddleware`.\n\n      afterLoginMiddleware = middleware.fromConfig(\n        'shrub-user:afterLoginMiddleware'\n      )\n\n      login = req.passportLogIn = req.login\n      req.login = req.logIn = (user, fn) ->\n\n        new Promise (resolve, reject) =>\n\n          loginReq = req: this, user: user\n\n          beforeLoginMiddleware.dispatch loginReq, null, (error) =>\n            return reject error if error?\n\n            login.call this, loginReq.user, (error) ->\n              return reject error if error?\n\n              afterLoginMiddleware.dispatch loginReq, null, (error) ->\n                return reject error if error?\n\n                resolve()\n\n      next()\n","old_contents":"\n    passport = null\n    Promise = null\n\n    clientModule = require '.\/client\/login'\n    userPackage = require '.\/index'\n\n    exports.pkgmanRegister = (registrar) ->\n\n#### Implements hook `shrubCorePreBootstrap`.\n\n      registrar.registerHook 'shrubCorePreBootstrap', ->\n\n        passport = require 'passport'\n        Promise = require 'bluebird'\n\n#### Implements hook `shrubRpcRoutes`.\n\n      registrar.registerHook 'shrubRpcRoutes', ->\n\n        {Limiter, LimiterMiddleware} = require 'shrub-limiter'\n\n        routes = []\n\n        routes.push\n\n          path: 'shrub-user\/login'\n\n          middleware: [\n\n            'shrub-http-express\/session'\n            'shrub-villiany'\n\n            'shrub-user'\n\n            new LimiterMiddleware(\n              message: 'You are logging in too much.'\n              threshold: Limiter.threshold(3).every(30).seconds()\n            )\n\n            (req, res, next) ->\n\n              errors = require 'errors'\n\n              promise = new Promise (resolve, reject) ->\n                req._passport.instance.authenticate(\n                  req.body.method\n                  (error, user, info) ->\n                    return reject error if error?\n                    resolve user, info\n\n                ) req, res\n\nLog the user in (if it exists), and redact it for the response.\n\n              promise.bind({}).then((@user, info) ->\n                throw errors.instantiate 'login' unless @user\n\n                req.logIn @user\n\n              ).then(->\n\n                new Promise (resolve, reject) =>\n\nJoin a channel for the username.\n\n                  req.socket.join @user.name, (error) ->\n                    return reject error if error?\n\n                    resolve()\n\n              ).then(->\n\n                @user.redactFor @user\n\n              ).then((user) -> res.end user).catch next\n\n          ]\n\n        return routes\n\n#### Implements hook `shrubCoreBootstrapMiddleware`.\n\n      registrar.registerHook 'shrubCoreBootstrapMiddleware', ->\n\n        orm = require 'shrub-orm'\n\n        crypto = require 'server\/crypto'\n\n        label: 'Bootstrap user login'\n        middleware: [\n\n          (next) ->\n\nImplement a local passport strategy.\n\n###### TODO: Strategies should be dynamically defined through a hook.\n\n            LocalStrategy = require('passport-local').Strategy\n            passport.use new LocalStrategy (username, password, done) ->\n\nLoad a user and compare the hashed password.\n\n              Promise.cast(\n                userPackage.loadByName username\n              ).bind({}).then((@user) ->\n                return unless @user?\n\n                crypto.hasher(\n                  plaintext: password\n                  salt: new Buffer @user.salt, 'hex'\n                )\n\n              ).then((hashed) ->\n                return unless @user?\n                return unless @user.passwordHash is hashed.key.toString(\n                  'hex'\n                )\n\n                @user\n\n              ).nodeify done\n\n            passport.serializeUser (user, done) -> done null, user.id\n\n            passport.deserializeUser (id, done) ->\n              User = orm.collection 'shrub-user'\n              User.findOne(id: id).populateAll().then((user) ->\n                user.populateAll()\n              ).then((user) -> done null, user).catch done\n\n            next()\n\n        ]\n\n#### Implements hook `shrubTransmittableErrors`.\n\n      registrar.registerHook 'shrubTransmittableErrors', clientModule.shrubTransmittableErrors\n\nMonkey patch http.IncomingMessage.prototype.login to run our middleware, and\nreturn a promise.\n\n    exports.monkeyPatchLogin = (req, res, next) ->\n\n      middleware = require 'middleware'\n\n#### Invoke hook `shrubUserBeforeLoginMiddleware`.\n\n      beforeLoginMiddleware = middleware.fromConfig(\n        'shrub-user:beforeLoginMiddleware'\n      )\n\n#### Invoke hook `shrubUserAfterLoginMiddleware`.\n\n      afterLoginMiddleware = middleware.fromConfig(\n        'shrub-user:afterLoginMiddleware'\n      )\n\n      login = req.passportLogIn = req.login\n      req.login = req.logIn = (user, fn) ->\n\n        new Promise (resolve, reject) =>\n\n          loginReq = req: this, user: user\n\n          beforeLoginMiddleware.dispatch loginReq, null, (error) =>\n            return reject error if error?\n\n            login.call this, loginReq.user, (error) ->\n              return reject error if error?\n\n              afterLoginMiddleware.dispatch loginReq, null, (error) ->\n                return reject error if error?\n\n                resolve()\n\n      next()\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f95548360fc5110881c4b0cf4c8fc3c13464cee0","subject":"docs(document): separate method annotation from implementation","message":"docs(document): separate method annotation from implementation\n","repos":"Turistforeningen\/Turbasen,Turbasen\/Turbasen","old_file":"coffee\/model\/Document.litcoffee","new_file":"coffee\/model\/Document.litcoffee","new_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n    collections = require('..\/helper\/schema').types\n\n---\n\n## Class: Doc\n\n### Params\n\n* `string` type - document type\n* `string` id - document id\n\n### Return\n\nNew `Doc`.\n\n---\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n      @db   = mongo[type]\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n      @type = type\n      @data = {}\n      @chit = false\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if Object.keys(data).length\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n## Doc.exists\n\nCheck if document exists.\n\n### Return\n\nReturns `true` if document exists; otherwise `false`.\n\n---\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n## Doc.getId\n\nGet document id (ObjectID) for current document.\n\n### Return\n\nReturns an `ObjectID` if the document has an id; otherwise `null`.\n\n---\n\n    Doc.prototype.getId = ->\n      @id\n\n\n## Doc.wasCacheHit\n\nCheck if document request was a cache hit.\n\n### Return\n\nReturns `true` if document request was a cache hit; otherwise `false`.\n\n---\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n## Doc.isNotModifiedSince\n\nCheck if document has not been modified since a given timestamp.\n\n### Params\n\n* `string` time - timestamp to check against.\n\n### Return\n\nReturns `true` if document has not been modified since given tmestamp; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make unix timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n## doc.isMatch\n\nCheck if checksum, or Etag, matche current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturns `true` if checksum matches the current checksum; otherwise `false`.\n\n---\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n## doc.isNoneMatch\n\nCheck if checksum, or Etag, doesnt match current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturn `true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n---\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n## Doc.get\n\nGet cached data for current document.\n\n### Params\n\n* `string` key - get specific object property\n\n### Return\n\nReturns an `object` if `key` is `undefined`; otherwise `string`. Will retur\n`undefined` if the given key does not exist.\n\n---\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n## doc.getFull\n\n### Params\n\n* `object` filter - control which object properties are returned\n* `function` cb - callback function (`Error` err, `object` data)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n## doc.getFuller\n\n### Params\n\n* `object` filter - control which object properties are returned\n* `array` expand -\n* `object` query -\n* `function` cb - callback function (`Error` err, `object` data)\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.getFuller = (filter, expand, query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      count = 0\n      mapped = {}\n\nSince `expand` might be a user supplied input parameter we need to limit it to\nproperties which are expandable (eg. `collections`). We also remove properties\nwhich holds no value for this document.\n\n      expand = expand\n        .filter (v) => @data[v] and v in collections\n\nNext we map the string array into an object array on the following format:\n`{ type: String, ids: Array }` where `ids` are ObjectIDs to an document of the\ncollection `type`.\n\n        .map (v) => type: v, ids: @data[v].map (d) -> new ObjectID d\n\nSet up a `final` function which is called when expanded data is ready to be\nmapped to the original document.\n\n      final = () =>\n        @db.findOne _id: @id, filter, (err, doc) ->\n          cb err, Object.assign doc or {}, mapped\n\nIf there are no fields to expand, we just call the `final` function instantly\nand no fields will get expanded.\n\n      return final() if expand.length is 0\n\nSet up a `next` function which is called for each expanded data returned from\nthe database. Expanded data is stored in the `mapped` object which is merged\nwith the main document in `final`. When all expanded fields are mapped `final`\nis called.\n\n      next = (type, _, docs) ->\n        mapped[type] = docs or []\n        return final() if Object.keys(mapped).length == expand.length\n\nGet the expanded sub-documents from the database.\n\n      expand.forEach (x) ->\n        mongo[x.type]\n\nWe find the sub-documents using the ObjectIDs in the expanded fields, that is\nthe easy part. The tricky part is to prevent information leackage of private\ndocuments. This the second part is a `query` limiting the results to public\ndocuments or those owned by the current API user.\n\n          .find Object.assign {_id: $in: x.ids}, query\n\nWe reuse the projection filter from the original document, but since we do not\nknow in advanced who owns a given sub-document we remove the `private` property\nto prevent information leakage.\n\n          .project Object.assign filter, privat: false\n\nBundle all the sub-documents in one array and pass it to the `next` function.\n\n          .toArray next.bind null, x.type\n\n\n## Doc.insert\n\nInserts a document into databse.\n\n### Params\n\n* `object` data - data to insert for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.replace\n\nReplaces all document data in database.\n\n### Params\n\n* `object` data - replacement data for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          data._id = @id\n          cb err, warn, data\n\n\n## Doc.update\n\nPartially update the document-data in database. This is some times refered to as\nPATCH in a HTTP \/ REST context.\n\n### Params\n\n* `object` data - replacement object for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n## Doc.delete\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n### Params\n\n* `function`  cb - callback function (`Error` err).\n\n### Return\n\nReturns `undefined`.\n\n---\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet', endret: new Date()\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n\n","old_contents":"    ObjectID  = require('mongodb').ObjectID\n\nImport event emitter stuff.\n\n    EventEmitter = require('events').EventEmitter\n    inherits = require('util').inherits\n\nImport data storage modules.\n\n    mongo   = require '..\/db\/mongo'\n    redis   = require '..\/db\/redis'\n\n    parse   = require '..\/helper\/parse'\n    cache   = require '..\/helper\/cache'\n\n    collections = require('..\/helper\/schema').types\n\n## Class: Doc\n\n### Params\n\n* `string` type - document type\n* `string` id - document id\n\n### Return\n\nNew `Doc`.\n\n    module.exports = Doc = (type, id) ->\n      throw new Error('Missing Doc type param') if not type\n      throw new Error('Missing or invalid ID param') if typeof id isnt 'string' and id isnt null\n\n      EventEmitter.call @\n\n      @db   = mongo[type]\n      @id   = if typeof id is 'string' then new ObjectID(id) else null\n      @type = type\n      @data = {}\n      @chit = false\n\n      if @id\n        redis.hgetall \"#{@type}:#{@id.toString()}\", (err, data) =>\n          return @emit 'error', err if err\n\n          if Object.keys(data).length\n            @data = cache.arrayify @type, data\n            @chit = true\n            return @emit 'ready'\n\n          @db.findOne _id: @id, cache.getFilter(@type), (err, data) =>\n            return @emit 'error', err if err\n\n            @data = data or status: 'Slettet'\n            redis.hmset \"#{@type}:#{@id}\", @data, (err) =>\n              return @emit 'ready'\n      else\n        process.nextTick => @emit 'ready'\n\n      return @\n\n    inherits Doc, EventEmitter\n\n## Doc.exists\n\nCheck if document exists.\n\n### Return\n\nReturns `true` if document exists; otherwise `false`.\n\n    Doc.prototype.exists = ->\n      return @data.status? and @data.status isnt 'Slettet'\n\n\n## Doc.getId\n\nGet document id (ObjectID) for current document.\n\n### Return\n\nReturns an `ObjectID` if the document has an id; otherwise `null`.\n\n    Doc.prototype.getId = ->\n      @id\n\n\n## Doc.wasCacheHit\n\nCheck if document request was a cache hit.\n\n### Return\n\nReturns `true` if document request was a cache hit; otherwise `false`.\n\n    Doc.prototype.wasCacheHit = ->\n      @chit\n\n\n## Doc.isNotModifiedSince\n\nCheck if document has not been modified since a given timestamp.\n\n### Params\n\n* `string` time - timestamp to check against.\n\n### Return\n\nReturns `true` if document has not been modified since given tmestamp; otherwise\n`false`.\n\n    Doc.prototype.isModifiedSince = (time) -> @modifiedSince time, false\n    Doc.prototype.isNotModifiedSince = (time) -> @modifiedSince time, true\n\n    Doc.prototype.modifiedSince = (time, negate) ->\n      return false if not time or not @data.endret\n\n      if not isNaN time\n        # Make unix timestamp into milliseconds\n        time = time + '000' if (time + '').length is 10\n        time = parseInt time\n\n      org = new Date(@data.endret)\n      chk = new Date(time)\n\n      # HTTP-date's don't have milliseconds\n      org.setMilliseconds(0)\n\n      return false if chk.toString() is 'Invalid Date'\n\n      return chk >= org if negate\n      return chk <  org\n\n\n## doc.isMatch\n\nCheck if checksum, or Etag, matche current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturns `true` if checksum matches the current checksum; otherwise `false`.\n\n    Doc.prototype.isMatch = (checksum) ->\n      return false if not checksum or not @data.checksum\n      return (checksum is \"\\\"#{@data.checksum}\\\"\" or checksum is '*')\n\n\n## doc.isNoneMatch\n\nCheck if checksum, or Etag, doesnt match current document checksum.\n\n### Params\n\n* `string` checksum - checksum to check against.\n\n### Return\n\nReturn `true` if checksum does not match or document has no checksum; otherwise\n`false`.\n\n    Doc.prototype.isNoneMatch = (checksum) ->\n      return false if not checksum\n      return true if not @data.checksum\n      return checksum isnt \"\\\"#{@data.checksum}\\\"\"\n\n## Doc.get\n\nGet cached data for current document.\n\n### Params\n\n* `string` key - get specific object property\n\n### Return\n\nReturns an `object` if `key` is `undefined`; otherwise `string`. Will retur\n`undefined` if the given key does not exist.\n\n    Doc.prototype.get = (key) ->\n      return @data if not key\n      return @data[key]\n\n\n## doc.getFull\n\n### Params\n\n* `object` filter - control which object properties are returned\n* `function` cb - callback function (`Error` err, `object` data)\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.getFull = (filter, cb) ->\n      if not cb\n        throw new Error('Document doesnt exists') if not @exists()\n        return @db.find _id: @id, filter, limit: 1\n      else\n        return cb new Error('Document doesnt exists') if not @exists()\n        @db.findOne _id: @id, filter, cb\n\n\n## doc.getFuller\n\n### Params\n\n* `object` filter - control which object properties are returned\n* `array` expand -\n* `object` query -\n* `function` cb - callback function (`Error` err, `object` data)\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.getFuller = (filter, expand, query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      count = 0\n      mapped = {}\n\nSince `expand` might be a user supplied input parameter we need to limit it to\nproperties which are expandable (eg. `collections`). We also remove properties\nwhich holds no value for this document.\n\n      expand = expand\n        .filter (v) => @data[v] and v in collections\n\nNext we map the string array into an object array on the following format:\n`{ type: String, ids: Array }` where `ids` are ObjectIDs to an document of the\ncollection `type`.\n\n        .map (v) => type: v, ids: @data[v].map (d) -> new ObjectID d\n\nSet up a `final` function which is called when expanded data is ready to be\nmapped to the original document.\n\n      final = () =>\n        @db.findOne _id: @id, filter, (err, doc) ->\n          cb err, Object.assign doc or {}, mapped\n\nIf there are no fields to expand, we just call the `final` function instantly\nand no fields will get expanded.\n\n      return final() if expand.length is 0\n\nSet up a `next` function which is called for each expanded data returned from\nthe database. Expanded data is stored in the `mapped` object which is merged\nwith the main document in `final`. When all expanded fields are mapped `final`\nis called.\n\n      next = (type, _, docs) ->\n        mapped[type] = docs or []\n        return final() if Object.keys(mapped).length == expand.length\n\nGet the expanded sub-documents from the database.\n\n      expand.forEach (x) ->\n        mongo[x.type]\n\nWe find the sub-documents using the ObjectIDs in the expanded fields, that is\nthe easy part. The tricky part is to prevent information leackage of private\ndocuments. This the second part is a `query` limiting the results to public\ndocuments or those owned by the current API user.\n\n          .find Object.assign {_id: $in: x.ids}, query\n\nWe reuse the projection filter from the original document, but since we do not\nknow in advanced who owns a given sub-document we remove the `private` property\nto prevent information leakage.\n\n          .project Object.assign filter, privat: false\n\nBundle all the sub-documents in one array and pass it to the `next` function.\n\n          .toArray next.bind null, x.type\n\n\n## Doc.insert\n\nInserts a document into databse.\n\n### Params\n\n* `object` data - data to insert for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.insert = (data, cb) ->\n      return cb new Error('Document already exists') if @exists()\n      return cb new Error('Document is deleted') if @data.status is 'Slettet'\n\n      parse.docInsert @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.insertOne data, w: 1, (err) =>\n          return cb err if err\n\n          @id   = new ObjectID(data._id)\n          @data = cache.filterData @type, data\n\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          cb err, warn, data\n\n\n## Doc.replace\n\nReplaces all document data in database.\n\n### Params\n\n* `object` data - replacement data for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.replace = (data, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docReplace @type, data, (err, warn, data) =>\n        return cb err if err\n\n        @db.replaceOne _id: @id, data, w: 1, (err) =>\n          return cb err if err\n\n          @data = cache.filterData @type, data\n\n          redis.del \"#{@type}:#{@id.toString()}\"\n          redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n          data._id = @id\n          cb err, warn, data\n\n\n## Doc.update\n\nPartially update the document-data in database. This is some times refered to as\nPATCH in a HTTP \/ REST context.\n\n### Params\n\n* `object` data - replacement object for document.\n* `function` cb - callback function (`Error` err, `Array` warn, `object` data).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.update = (query, cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      parse.docPatch @type, query, (err, warn, query) =>\n        return cb err if err\n\n        @db.updateOne _id: @id, query, w: 1, (err) =>\n          return cb err if err\n\n          @getFull {}, (err, doc) =>\n            @data = cache.filterData @type, doc\n\n            redis.del \"#{@type}:#{@id.toString()}\"\n            redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n            cb err, warn, doc\n\n\n## Doc.delete\n\nDelete a document from the database by removing all document properties and\nsetting the `status` property to `Slettet`.\n\n### Params\n\n* `function`  cb - callback function (`Error` err).\n\n### Return\n\nReturns `undefined`.\n\n    Doc.prototype.delete = (cb) ->\n      return cb new Error('Document doesnt exists') if not @exists()\n\n      @data = status: 'Slettet', endret: new Date()\n      @db.replaceOne _id: @id, @data, w: 1, (err) =>\n        return cb err if err\n\n        redis.del \"#{@type}:#{@id.toString()}\"\n        redis.hmset \"#{@type}:#{@id.toString()}\", @data\n\n        cb null\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8ace12e6a0a6b2200babbc5830e88a330a639078","subject":"follows style and format conventions","message":"follows style and format conventions\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/10_model.litcoffee","new_file":"docs\/10_model.litcoffee","new_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee [`Model::validate`](\/docs\/api\/batman.model.html#prototype_function_validate) for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt takes a callback with two arguments: error and the array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : Batman.ErrorsSet\n\n`errors` contains a [`Batman.ErrorsSet`](\/docs\/api\/batman.errorsset.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s present on the model instance.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## isNew() : boolean\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## toJSON() : Object\n\n## fromJSON() : Model\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## load(options = {}, callback)\n\n## save(options = {}, callback)\n\n## destroy(options = {}, callback)\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method takes a callback with two arguments: any JavaScript error that occurs and the [`Batman.ErrorsSet`](\/docs\/api\/batman.errorsset.html) resulting from the validation tests.\nFor example:\n\n    asyncTest \"validate(callback) will call the callback only after all keys have been validated\", 4, ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      newProduct = new Product\n      newProduct.validate (javascriptError, validationErrors) ->\n        throw javascriptError if javascriptError\n        equal validationErrors.length, 2\n        equal newProduct.get('errors.length'), 2\n        equal newProduct.get('errors.name.length'), 1\n        equal newProduct.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\n`Batman.ValidationError`s represent a failure to validate a particular field on a model.\nThey are usually accessed by getting a model's [errors](\/docs\/api\/batman.model.html#prototype_accessor_errors).\n\n## ::%fullMessage\n\nReturns the human-readable attribute name and the validation message:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n","old_contents":"# Batman.Model\n\nFor a general explanation of `Batman.Model` and how it works, see [the guide](\/docs\/models.html).\n\n_Note_: This documentation uses the term _model_ to refer to the class `Model`\nor a `Model` subclass, and the term _record_ to refer to one instance of a\nmodel.\n\n## @primaryKey : string\n\n`primaryKey` is a class level configuration option to change which key batman.js uses as the primary key. Change the option using `set`, like so:\n\n    test 'primary key can be set using @set', ->\n      class Shop extends Batman.Model\n        @set 'primaryKey', 'shop_id'\n\n      equal Shop.get('primaryKey'), 'shop_id'\n\nThe `primaryKey` is what batman.js uses to compare instances to see if they represent the same domain-level object: if two records have the same value at the key specified by `primaryKey`, only one will be in the identity map. The key specified by `primaryKey` is also used by the associations system when determining if a record is related to another record, and by the remote storage adapters to generate URLs for records.\n\n_Note_: The default primaryKey is 'id'.\n\n## @storageKey : string\n\n`storageKey` is a class level option which gives the storage adapters something to interpolate into their specific key generation schemes. In the case of `LocalStorage` or `SessionStorage` adapters, the `storageKey` defines what namespace to store this record under in the `localStorage` or `sessionStorage` host objects, and with the case of the `RestStorage` family of adapters, the `storageKey` assists in URL generation. See the documentation for the storage adapter of your choice for more information.\n\nThe default `storageKey` is `null`.\n\n## @persist(mechanism : StorageAdapter) : StorageAdapter\n\n`@persist` is how a `Model` subclass is told to persist itself by means of a `StorageAdapter`. `@persist` accepts either a `StorageAdapter` class or instance and will return either the instantiated class or the instance passed to it for further modification.\n\n    test 'models can be told to persist via a storage adapter', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist TestStorageAdapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n    test '@persist returns the instantiated storage adapter', ->\n      adapter = false\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        adapter = @persist TestStorageAdapter\n\n      ok adapter instanceof Batman.StorageAdapter\n\n    test '@persist accepts already instantiated storage adapters', ->\n      adapter = new Batman.StorageAdapter\n      adapter.someHandyConfigurationOption = true\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @persist adapter\n\n      record = new Shop\n      ok record.hasStorage()\n\n## @encode(keys...[, encoderObject : [Object|Function]])\n\n`@encode` specifies a list of `keys` a model should expect from and send back to a storage adapter, and any transforms to apply to those attributes as they enter and exit the world of batman.js in the optional `encoderObject`.\n\nThe `encoderObject` should have an `encode` and\/or a `decode` key which point to functions. The functions accept the \"raw\" data (the batman.js land value in the case of `encode`, and the backend land value in the case of `decode`), and should return the data suitable for the other side of the link. The functions should have the following signatures:\n\n    encoderObject = {\n      encode: (value, key, builtJSON, record) ->\n      decode: (value, key, incomingJSON, outgoingObject, record) ->\n    }\n\nBy default these functions are the identity functions. They apply no transformation. The arguments for `encode` functions are as follows:\n\n + `value` is the client side value of the `key` on the `record`\n + `key` is the key which the `value` is stored under on the `record`. This is useful when passing the same `encoderObject` which needs to pivot on what key is being encoded to different calls to `encode`.\n + `builtJSON` is the object which is modified by each encoder which will eventually be returned by `toJSON`. To send the server the encoded value under a different key than the `key`, modify this object by putting the value under the desired key, and return `undefined`.\n + `record` is the record on which `toJSON` has been called.\n\nFor `decode` functions:\n\n + `value` is the server side value of the `key` which will end up on the `record`.\n + `key` is the key which the `value` is stored under in the incoming JSON.\n + `incomingJSON` is the JSON which is being decoded into the `record`. This can be used to create compound key decoders.\n + `outgoingObject` is the object which is built up by the decoders and then `mixin`'d to the record.\n + `record` is the record on which `fromJSON` has been called.\n\nThe `encode` and `decode` keys can also be false to avoid using the default identity function encoder or decoder.\n\n_Note_: `Batman.Model` subclasses have no encoders by default, except for one which automatically decodes the `primaryKey` of the model, which is usually `id`. To get any data into or out of your model, you must white-list the keys you expect from the server or storage attribute.\n\n    test '@encode accepts a list of keys which are used during decoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      json = {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      record = new Shop()\n      record.fromJSON(json)\n      equal record.get('name'), \"Snowdevil\"\n\n    test '@encode accepts a list of keys which are used during encoding', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', 'url', 'email', 'country'\n\n      record = new Shop(name: \"Snowdevil\", url: \"snowdevil.ca\")\n      deepEqual record.toJSON(), {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n\n    test '@encode accepts custom encoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          encode: (name) -> name.toUpperCase()\n\n      record = new Shop(name: \"Snowdevil\")\n      deepEqual record.toJSON(), {name: \"SNOWDEVIL\"}\n\n    test '@encode accepts custom decoders', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name',\n          decode: (name) -> name.replace('_', ' ')\n\n      record = new Shop()\n      record.fromJSON {name: \"Snow_devil\"}\n      equal record.get('name'), \"Snow devil\"\n\n    test '@encode can be passed an encoderObject with false to prevent the default encoder or decoder', ->\n      class Shop extends Batman.Model\n        @resourceName: 'shop'\n        @encode 'name', {encode: false, decode: (x) -> x}\n        @encode 'url'\n\n      record = new Shop()\n      record.fromJSON {name: \"Snowdevil\", url: \"snowdevil.ca\"}\n      equal record.get('name'), 'Snowdevil'\n      equal record.get('url'), \"snowdevil.ca\"\n      deepEqual record.toJSON(), {url: \"snowdevil.ca\"}, 'The name key is absent because of encode: false'\n\nSome more handy examples:\n\n    test '@encode can be used to turn comma separated values into arrays', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (string) -> string.split(', ')\n          encode: (array) -> array.join(', ')\n\n      record = new Post()\n      record.fromJSON({tags: 'new, hot, cool'})\n      deepEqual record.get('tags'), ['new', 'hot', 'cool']\n      deepEqual record.toJSON(), {tags: 'new, hot, cool'}\n\n    test '@encode can be used to turn arrays into sets', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'tags',\n          decode: (array) -> new Batman.Set(array...)\n          encode: (set) -> set.toArray()\n\n      record = new Post()\n      record.fromJSON({tags: ['new', 'hot', 'cool']})\n      ok record.get('tags') instanceof Batman.Set\n      deepEqual record.toJSON(), {tags: ['new', 'hot', 'cool']}\n\n## @validate(keys...[, options : [Object|Function]])\n\nValidations allow a model to be marked as `valid` or `invalid` based on a set of programmatic rules. By validating a model's data before it gets to the server we can provide immediate feedback to the user about what they have entered and forgo waiting on a round trip to the server. `validate` allows the attachment of validations to the model on particular keys, where the validation is either a built in one (invoked by use of options to pass to them) or a custom one (invoked by use of a custom function as the second argument).\n\n_Note_: Validation in batman.js is always asynchronous, despite the fact that none of the validations may use an asynchronous operation to check for validity. This is so that the API is consistent regardless of the validations used.\n\nBuilt in validators are attached by calling `@validate` with options designating how to calculate the validity of the key:\n\n    test '@validate accepts options to check for validity', ->\n      QUnit.expect(0)\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @validate 'title', 'body', {presence: true}\n\nThe built in validation options are listed below:\n\n + `presence : boolean`: Assert that the string value is existent (not undefined or null) and has length greather than 0.\n + `numeric : true`: Assert that the value is or can be coerced into a number using `parseFloat`.\n + `greaterThan : number`: Assert that the value is greater than the given number.\n + `greaterThanOrEqualTo : number`: Assert that the value is greater than or equal to the given number.\n + `equalTo : number`: Assert that the value is equal to the given number.\n + `lessThan : number`: Assert that the value is less than the given number.\n + `lessThanOrEqualTo : number`: Assert that the value is less than or equal to the given number.\n + `minLength : number`: Assert that the value's `length` property is greater than the given number.\n + `maxLength : number`: Assert that the value's `length` property is less than the given number.\n + `length : number`: Assert that the value's `length` property is exactly the given number.\n + `lengthWithin : [number, number]` or `lengthIn : [number, number]`: Assert that the value's `length` property is within the ranger specified by the given array of two numbers, where the first number is the lower bound and the second number is the upper bound.\n + `inclusion : in : [list, of, acceptable, values]`: Assert that the value is equal to one of the values in an array.\n + `exclusion : in : [list, of, unacceptable, values]`: Assert that the value is not equal to any of the values in an array.\n\nCustom validators should have the signature `(errors, record, key, callback)`. The arguments are as follows:\n\n + `errors`: an `ErrorsSet` instance which expects to have `add` called on it to add errors to the model\n + `record`: the record being validated\n + `key`: the key to which the validation has been attached\n + `callback`: a function to call once validation has been completed. Calling this function is __mandatory__.\n\nSee `Model::validate` for information on how to get a particular record's validity.\n\n## @loaded : Set\n\nThe `loaded` set is available on every model class and holds every model instance seen by the system in order to function as an identity map. Successfully loading or saving individual records or batches of records will result in those records being added to the `loaded` set. Destroying instances will remove records from the identity set.\n\n    test 'the loaded set stores all records seen', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @persist TestStorageAdapter\n        @encode 'name'\n\n      ok Post.get('loaded') instanceof Batman.Set\n      equal Post.get('loaded.length'), 0\n      post = new Post()\n      post.save()\n      equal Post.get('loaded.length'), 1\n\n    test 'the loaded adds new records caused by loads and removes records caused by destroys', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      post = false\n      Post.find(1, (err, result) -> post = result)\n      post.destroy()\n      equal Post.get('loaded.length'), 1\n\n## @all : Set\n\nThe `all` set is an alias to the `loaded` set but with an added implicit `load` on the model. `Model.get('all')` will synchronously return the `loaded` set and asynchronously call `Model.load()` without options to load a batch of records and populate the set originally returned (the `loaded` set) with the records returned by the server.\n\n_Note_: The notion of \"all the records\" is relative only to the client. It completely depends on the storage adapter in use and any backends which they may contact to determine what comes back during a `Model.load`. This means that if for example your API paginates records, the set found in `all` may hold on the first 50 records instead of the entire backend set.\n\n`all` is useful for listing every instance of a model in a view, and since the `loaded` set will change when the `load` returns, it can be safely bound to.\n\n    asyncTest 'the all set asynchronously fetches records when gotten', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new AsyncTestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n\n      Post.persist(adapter)\n      equal Post.get('all.length'), 0, \"The synchronously returned set is empty\"\n      delay ->\n        equal Post.get('all.length'), 2, \"After the async load the set is populated\"\n\n## @clear() : Set\n\n`Model.clear()` empties that `Model`'s identity map. This is useful for tests and other unnatural situations where records new to the system are guaranteed to be as such.\n\n    test 'clearing a model removes all records from the identity map', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n\n      adapter = new TestStorageAdapter(Post)\n      adapter.storage =\n          'posts1': {name: \"One\", id:1}\n          'posts2': {name: \"Two\", id:2}\n      Post.persist(adapter)\n      Post.load()\n      equal Post.get('loaded.length'), 2\n      Post.clear()\n      equal Post.get('loaded.length'), 0, \"After clear() the loaded set is empty\"\n\n## @find(id, callback : Function) : Model\n\n`Model.find()` retrieves a record with the specified `id` from the storage adapter and calls back with an error if one occurred and the record if the operation was successful. `find` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what type of errors may return and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments: an error, and the record asked for. `find` returns an \"unloaded\" record which, following the load completion, will be populated with the data from the storage adapter.\n\n_Note_: `find` gives two results to calling code: one immediately, and one later. `find` returns a record synchronously as it is called and calls back with a record, and importantly these two records are __not__ guaranteed to be the same instance. This is because batman.js maps the identities of incoming and outgoing records such that there is only ever one canonical instance representing a record, which is useful so bindings are always bound to the same thing. In practice, this means that calling code should use the record `find` calls back with if anything is going to bind to that object, which is most of the time. The returned record however remains useful for state inspection and bookkeeping.\n\n    asyncTest '@find calls back the requested model if no error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter,\n          storage:\n            'posts2': {name: \"Two\", id:2}\n\n      post = Post.find 2, (err, result) ->\n        throw err if err\n        post = result\n      equal post.get('name'), undefined\n      delay ->\n        equal post.get('name'), \"Two\"\n\n_Note_: `find` must be passed a callback function. This is for two reasons: calling code must be aware that `find`'s return value is not necessarily the canonical instance, and calling code must be able to handle errors.\n\n    asyncTest '@find calls back with the error if an error occurs', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist AsyncTestStorageAdapter\n\n      error = false\n      post = Post.find 3, (err, result) ->\n        error = err\n      delay ->\n        ok error instanceof Error\n\n## @load(options = {}, callback : Function)\n\n`Model.load()` retrieves an array of records according to the given `options` from the storage adapter and calls back with an error if one occurred and the set of records if the operation was successful. `load` delegates to the storage adapter the `Model` has been `@persist`ed with, so it is up to the storage adapter's semantics to determine what the options do, what kind of errors may arise, and the timeline on which the callback may be called. The `callback` is a required function which should adopt the node style callback signature which accepts two arguments, an error, and the array of records. `load` returns undefined.\n\nFor the two main `StorageAdapter`s batman.js provides, the `options` do different things:\n\n- For `Batman.LocalStorage`, `options` act as a filter. The adapter will scan all the records in `localStorage` and return only those records which match all the key\/value pairs given in the options.\n- For `Batman.RestStorage`, `options` are serialized into query parameters on the `GET` request.\n\nIt takes a callback with two arguments: error and the array of loaded records.\n\n    asyncTest '@load calls back an array of records retrieved from the storage adapter', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter,\n          storage:\n            'posts1': {name: \"One\", id:1}\n            'posts2': {name: \"Two\", id:2}\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 2\n        equal posts[0].get('name'), \"One\"\n\n    asyncTest '@load calls back with an empty array if no records are found', ->\n      class Post extends Batman.Model\n        @resourceName: 'post'\n        @encode 'name'\n        @persist TestStorageAdapter, storage: []\n\n      posts = false\n      Post.load (err, result) ->\n        throw err if err\n        posts = result\n\n      delay ->\n        equal posts.length, 0\n\n## @create(attributes = {}, callback) : Model\n\n## @findOrCreate(attributes = {}, callback) : Model\n\n## id : value\n\n## dirtyKeys : Set\n\n## ::%errors : ErrorsSet\n\nA record's errors are accessible with `get('errors')`, which returns a [`Batman.Set`](\/docs\/api\/batman.set.html) of [`Batman.ValidationError`](\/docs\/api\/batman.validationerror.html)s.\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## constructor(idOrAttributes = {}) : Model\n\n## isNew() : boolean\n\n## updateAttributes(attributes) : Model\n\n## toString() : string\n\n## toJSON() : Object\n\n## fromJSON() : Model\n\n## toParam() : value\n\n## state() : string\n\n## hasStorage() : boolean\n\n## load(options = {}, callback)\n\n## save(options = {}, callback)\n\n## destroy(options = {}, callback)\n\n## ::validate(callback)\n\n`Model::validate` checks the model against the validations declared in the model definition (with [`Model@validate`](\/docs\/api\/batman.model.html#class_function_validate)). This method takes a callback with two arguments: any JavaScript error that occurs and the [`Batman.ErrorsSet`](\/docs\/api\/batman.errorsset.html) resulting from the validation tests.\nFor example:\n\n    asyncTest \"validate(callback) will call the callback only after all keys have been validated\", 4, ->\n      class Product extends Batman.Model\n        @validate 'name', 'price', presence: yes\n\n      new_product = new Product\n      new_product.validate (js_error, validation_errors) ->\n        throw js_error if js_error\n        equal validation_errors.length, 2\n        equal new_product.get('errors.length'), 2\n        equal new_product.get('errors.name.length'), 1\n        equal new_product.get('errors.price.length'), 1\n\n# Batman.ValidationError\n\nA `Batman.ValidationError` is a [`Batman.Object`](\/docs\/api\/batman.object.html). It is initialized with an `attribute` and a `message`.  It also responds to `fullMessage`:\n\n    test \"ValidationError should humanize attribute in the full message\", ->\n      error = new Batman.ValidationError(\"fooBarBaz\", \"isn't valid\")\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n\n## ::constructor(attribute_name, message)\n\nCreates a new `Batman.ValidationError`, as in:\n\n```coffeescript\nnew_error = new Batman.ValidationError(\"password\", \"must include letters and numbers\")\n```\n\n## ::%fullMessage\n\nReturns the attribute name and the validation message.\n```coffeescript\nnew_error.get('fullMessage') # \"password must include letters and numbers\"\n```\n\n\n# Batman.ErrorsSet\n\nA `Batman.ErrorsSet` is a [`Batman.Set`](\/docs\/api\/batman.set.html) populated with [`Batman.ValidationErrors`](\/docs\/api\/batman.validationerror.html).\n\n- `user.get('errors')` returns the errors on the `user` record\n- `user.get('errors.length')` returns the number of errors, total\n\nYou can also access the errors for a specific attribute of the record:\n\n- `user.get('errors.email_address')` returns the errors on the `email_address` attribute\n- `user.get('errors.email_address.length')` returns the number of errors on the `email_address` attribute\n\n## ::add(attribute_name, message)\n\n`Batman.ErrorsSet::add` is overridden for convenience. It takes an attribute_name and a message, which it uses to\ncreate a new `Batman.ValidationError` then it adds that error to the `Batman.ErrorsSet`.\n\n    test \"ErrorsSet::add passes its arguments to the ValidationError constructor\", ->\n      error_set = new Batman.ErrorsSet()\n      error_set.add(\"Foo bar baz\", \"isn't valid\")\n      error = error_set.at(0)\n      equal error.get('fullMessage'), \"Foo bar baz isn't valid\"\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"16adcce0f30dcd2983b8af7c9e0e8409b66ae221","subject":"remove extraneous debug logging","message":"remove extraneous debug logging\n","repos":"awwx\/meteor-offline-common","old_file":"agent.litcoffee","new_file":"agent.litcoffee","new_contents":"    {contains, Result} = awwx\n    {withContext} = awwx.Context\n    broadcast = Offline._broadcast\n    {defer} = awwx.Error\n    serialize = awwx.canonicalStringify\n    database = Offline._database\n\n    Offline._test or= {}\n\n\n    unless @Agent?\n      {nowAgent, thisWindowId} = Offline._windows\n\n\n    Offline._messageAgent = (topic, args...) ->\n      if Offline._usingSharedWebWorker\n        Offline._sharedWebWorker.post {msg: topic, args}\n      else if Offline._windows.currentlyTheAgent()\n        defer -> handlers[topic]?(args...)\n      else\n        broadcast topic, args...\n      return\n\n\n    if @Agent?\n\n      Agent.addMessageHandler 'update', (sourcePort, data) ->\n        for port in Agent.ports\n          unless port is sourcePort\n            port.postMessage({msg: 'update'})\n        return\n\n\n      addMessageHandler = (topic, callback) ->\n        Agent.addMessageHandler topic, (sourcePort, data) ->\n          callback()\n          return\n\n\n      broadcastUpdate = ->\n        for port in Agent.ports\n          port.postMessage({msg: 'update'})\n        return\n\n\n    else\n\n      handlers = {}\n\n      addMessageHandler = (topic, callback) ->\n        handlers[topic] = callback\n        broadcast.listen topic, callback\n        return\n\n\n      broadcastUpdate = ->\n        broadcast.includingSelf 'update'\n        return\n\n\n    updateSubscriptionsReadyInTx = (tx) ->\n      withContext \"updateSubscriptionsReadyInTx\", ->\n        Result.join([\n          database.readSubscriptions(tx)\n          database.readSubscriptionsHeldUp(tx)\n        ])\n        .then(([subscriptions, subscriptionsHeldUp]) ->\n          newlyReady = []\n          for {connection, name, args, readyFromServer, ready} in subscriptions\n            if (not ready and\n                readyFromServer and\n                not contains(subscriptionsHeldUp, {connection, name, args}))\n              newlyReady.push {connection, name, args}\n          if newlyReady.length is 0\n            return false\n          writes = []\n          for {connection, name, args} in newlyReady\n            writes.push database.setSubscriptionReady(tx, connection, name, args)\n            writes.push database.addUpdate(tx, {\n              update: 'subscriptionReady',\n              subscription: {connection, name, args}\n            })\n          Result.join(writes)\n        )\n        .then(-> return true)\n\n\n    Offline._test.updateSubscriptionsReadyInTx = updateSubscriptionsReadyInTx\n\n\nTODO what we really want here for broadcasting updates is to have an\n\"after transaction\" callback that would broadcast an update iff an\nupdate was added to the database during the transaction.\n\n    updateSubscriptionsReady = ->\n      withContext \"updateSubscriptionsReady\", ->\n        database.transaction((tx) ->\n          updateSubscriptionsReadyInTx(tx)\n        )\n        .then((someNewlyReady) ->\n          if someNewlyReady\n            broadcastUpdate()\n          return\n        )\n\n\n    addNewSubscriptionToDatabase = (tx, connection, name, args) ->\n      withContext \"addNewSubscriptionToDatabase\", ->\n        database.readMethodsWithDocsWritten(tx, connection)\n        .then((methodIds) ->\n          database.addSubscriptionWaitingOnMethods(\n            tx,\n            connection,\n            name,\n            args,\n            methodIds\n          )\n        )\n        .then(->\n          database.ensureSubscription(tx, connection, name, args)\n        )\n\n\n    justNameAndArgs = (subscription) ->\n      {name: subscription.name, args: subscription.args}\n\n\nIf we're running in the shared web worker, we're always the\nagent. Otherwise, running in a browser window, we need to check if\nwe're still the agent in the transaction.\n\n    if @Agent?\n\n      asAgentWindow = (fn) ->\n        database.transaction(fn)\n\n    else\n\n      asAgentWindow = (fn) ->\n        database.transaction((tx) =>\n          database.readAgentWindow(tx)\n          .then((agentWindowId) =>\n            if agentWindowId is thisWindowId\n              return fn(tx)\n            else\n              return Result.failed()\n          )\n        )\n\n\nMapping of connection name to ConnectionAgents.\n\n    @connectionAgents = {}\n\n\n    class ConnectionAgent\n\n      constructor: (@connectionName, @meteorConnection) ->\n        if connectionAgents[@connectionName]?\n          throw new Error(\n            \"a ConnectionAgent has already been constructed for this connection name: #{@connectionName}\"\n          )\n\n        connectionAgents[@connectionName] = this\n\n        @methodHandlers = {}\n\ncollection name -> collectionAgent\n\n        @collectionAgents = {}\n\n\nA mapping of `methodId -> true` for methods in the database list of\nqueued methods that the agent has sent.\n\n        @methodsSent = {}\n\nserialized subscription -> Meteor subscription handle\n\n        @meteorSubscriptionHandles = {}\n\n        @_nMeteorSubscriptionsReady = 0\n\n        @_deletedRemovedDocs = false\n\n      deleteRemovedDocuments: (tx) ->\n        if @_deletedRemovedDocs\n          return Result.completed()\n        else\n          @_deletedRemovedDocs = true\n          return @_eachCollectionAgent((collectionAgent) ->\n            collectionAgent.deleteDocumentsGoneFromServer(tx)\n          )\n\n      checkIfReadyToDeleteDocs: (tx) ->\n        if @allMeteorSubscriptionsReady()\n          @deleteRemovedDocuments(tx)\n\n      _alreadyHaveMeteorSubscription: (subscription) ->\n        !! @meteorSubscriptionHandles[serialize(subscription)]\n\n      allMeteorSubscriptionsReady: ->\n        @_nMeteorSubscriptionsReady is _.size(@meteorSubscriptionHandles)\n\n      _eachCollectionAgent: (fn) ->\n        results = []\n        for name, collectionAgent of @collectionAgents\n          results.push fn(collectionAgent)\n        return Result.join(results)\n\n      instantiateCollectionAgent: (collectionName) ->\n        @collectionAgents[collectionName] or=\n          new CollectionAgent(\n            this,\n            collectionName,\n            new Meteor.Collection(collectionName)\n          )\n        return\n\n      instantiateCollectionAgents: (collectionNames) ->\n        for collectionName in collectionNames\n          @instantiateCollectionAgent(collectionName)\n        return\n\n\n      meteorSubscriptionReady: (subscription) ->\n        @instantiateCollectionAgents(_.keys(\n          @meteorConnection._updatesForUnknownStores\n        ))\n        asAgentWindow (tx) =>\n          # processUpdatesInTx(tx)\n          # .then(->\n          database.setSubscriptionReadyFromServer(\n            tx,\n            @connectionName,\n            subscription.name\n            subscription.args\n          )\n          # )\n          .then(->\n            updateSubscriptionsReadyInTx(tx)\n          )\n          .then(=>\n            ++@_nMeteorSubscriptionsReady\n            @checkIfReadyToDeleteDocs(tx)\n          )\n          .then(->\n            broadcastUpdate()\n          )\n\n      currentSubscriptions: ->\n        _.map(_.keys(@meteorSubscriptionHandles), EJSON.parse)\n\n      oldSubscriptions: (subscriptions) ->\n        _.reject(\n          @currentSubscriptions(),\n          ((subscription) => contains(subscriptions, subscription))\n        )\n\n      stopOldSubscriptions: (subscriptions) ->\n        for subscription in @oldSubscriptions(subscriptions)\n          serialized = serialize(subscription)\n          @meteorSubscriptionHandles[serialized].stop()\n          delete @meteorSubscriptionHandles[serialized]\n        return\n\n      startNewSubscription: (subscription) ->\n        @_deletedRemovedDocs = false\n        {name, args} = subscription\n        handle = Meteor.subscribe name, args..., =>\n          @meteorSubscriptionReady(subscription)\n          return\n        @meteorSubscriptionHandles[serialize(subscription)] = handle\n        return\n\n      newSubscriptions: (subscriptions) ->\n        _.reject(\n          subscriptions,\n          (subscription) => @_alreadyHaveMeteorSubscription(subscription)\n        )\n\n      startNewSubscriptions: (subscriptions) ->\n        for subscription in @newSubscriptions(subscriptions)\n          @startNewSubscription(subscription)\n        return\n\n      updateSubscriptions: (subscriptions) ->\n        subscriptions = _.map(subscriptions, justNameAndArgs)\n        @stopOldSubscriptions(subscriptions)\n        @startNewSubscriptions(subscriptions)\n        return Result.completed()\n\n\n      checkIfDocumentNowFree: (tx, collectionName, docId) ->\n        @collectionAgents[collectionName].updateDocFromServerIfFree(\n          tx,\n          docId,\n        )\n\n\n      methodCompleted: (methodId) ->\n        docsWhichWereWrittenByStub = null\n        asAgentWindow((tx) =>\n          database.removeQueuedMethod(tx, @connectionName, methodId)\n          .then(->\n            database.readDocsWrittenByStub(tx, @connectionName, methodId)\n          )\n          .then((docs) =>\n            docsWhichWereWrittenByStub = docs\n\n            database.removeDocumentsWrittenByStub(\n              tx, @connectionName, methodId\n            )\n          )\n          .then(=>\n            writes = []\n            for {collectionName, docId} in docsWhichWereWrittenByStub\n              writes.push @checkIfDocumentNowFree tx, collectionName, docId\n            return Result.join(writes)\n          )\n          .then(->\n            database.removeMethodHoldingUpSubscriptions(tx, methodId)\n          )\n          .then(->\n            updateSubscriptionsReadyInTx(tx)\n          )\n        )\n        .then(->\n          broadcastUpdate()\n        )\n        return\n\n\n      sendQueuedMethod: (methodId, name, args) ->\n        return if @methodsSent[methodId]\n        @methodsSent[methodId] = true\n        Meteor.call '\/awwx\/offline-data\/apply', methodId, name, args, (error, result) =>\n          if error\n            Meteor._debug 'offline method error', name, error\n          @methodCompleted(methodId)\n          return\n        return\n\n\n    newConnectionAgent = (connectionName) ->\n      meteorConnection = if connectionName is '\/'\n        Meteor.default_connection\n      else\n        Meteor.connect(connectionName)\n      return new ConnectionAgent(connectionName, meteorConnection)\n\n\n    connectionAgentFor = (connectionName) ->\n      connectionAgents[connectionName] or= newConnectionAgent(connectionName)\n\n\n    sendQueuedMethods = ->\n      asAgentWindow (tx) ->\n        database.readQueuedMethods(tx)\n        .then((methods) ->\n          for {connection, methodId, name, args} in methods\n            connectionAgentFor(connection).sendQueuedMethod(methodId, name, args)\n          return\n        )\n\n\nTODO rename\n\n    subscribeToNewSubscriptions = (subscriptions) ->\n\n      for subscription in subscriptions\n        connectionAgentFor subscription.connection\n\n      results = []\n      for connectionName, connectionAgent of connectionAgents\n        connectionSubscriptions =\n          _.filter(\n            subscriptions,\n            (subscription) -> subscription.connection is connectionName\n          )\n        results.push connectionAgent.updateSubscriptions(connectionSubscriptions)\n      return Result.join(results)\n\n\n    class CollectionAgent\n\n      constructor: (@connectionAgent, @collectionName, @serverCollection) ->\n        @connectionName = @connectionAgent.connectionName\n        @watchServer()\n\n\n      offlineDocumentsNotInServerCollection: (tx) ->\n        database.readDocIdsOfCollection(tx, @connectionName, @collectionName)\n        .then((docIds) =>\n          _.reject(\n            docIds,\n            ((docId) => @serverCollection.findOne(docId))\n          )\n        )\n\n\nWe have a full and complete set of data from the server (our\nsubscriptions are ready).  We can now delete documents in the offline\ncollection which are no longer present on the server.\n\n      deleteDocUnlessWrittenByStub: (tx, docId) ->\n        database.isDocumentWrittenByAnyStub(\n          tx,\n          @connectionName,\n          @collectionName,\n          docId\n        )\n        .then((wasWritten) =>\n          if wasWritten\n            return\n          else\n            database.deleteDoc(tx, @connectionName, @collectionName, docId)\n            .then(=>\n              @addDocumentUpdate tx, docId, null\n            )\n        )\n\n\n      deleteDocumentsGoneFromServer: (tx) ->\n        @offlineDocumentsNotInServerCollection(tx)\n        .then((docIds) =>\n          # TODO Result.map\n          writes = []\n          for docId in docIds\n            writes.push @deleteDocUnlessWrittenByStub(tx, docId)\n          return Result.join(writes)\n        )\n\n\n      addDocumentUpdate: (tx, docId, doc) ->\n        database.addUpdate tx, {\n          update: 'documentUpdated'\n          connectionName: @connectionName\n          collectionName: @collectionName\n          docId\n          doc\n        }\n\n\n      updateDocIfFree: (tx, docId, doc) ->\n        database.isDocumentWrittenByAnyStub(\n          tx,\n          @connectionName,\n          @collectionName,\n          docId\n        )\n        .then((wasWritten) =>\n          return if wasWritten\n          (if doc?\n            database.writeDoc tx, @connectionName, @collectionName, doc\n          else\n            database.deleteDoc tx, @connectionname, @collectionName, docId\n          )\n          .then(=>\n            @addDocumentUpdate(tx, docId, doc)\n          )\n        )\n\n\n      updateDocFromServerIfFree: (tx, docId) ->\n        @updateDocIfFree(tx, docId, @serverCollection.findOne(docId))\n\n\n      serverDocUpdated: (docId, doc) ->\n        asAgentWindow((tx) =>\n          @updateDocIfFree(tx, docId, doc)\n        )\n        .then(=>\n          broadcastUpdate()\n        )\n        return\n\n\nTODO can we batch updates into one transaction?\n\n      watchServer: ->\n        @serverCollection.find().observe\n          added:   (doc) => @serverDocUpdated doc._id, doc\n          changed: (doc) => @serverDocUpdated doc._id, doc\n          removed: (doc) => @serverDocUpdated doc._id, null\n        return\n\n\n    # meteorConnectionName = (meteorConnection) ->\n    #   if @meteorConection is Meteor.default_connection\n    #     '\/'\n    #   else\n    #     meteorConnection._stream.rawUrl\n\n\n    updateSubscriptions = ->\n      updateSubscriptionsReady()\n      subscriptionsUpdated()\n\n\n    subscriptionsUpdated = ->\n      asAgentWindow((tx) ->\n        database.readMergedSubscriptions(tx)\n      )\n      .then((subscriptions) ->\n        subscribeToNewSubscriptions(subscriptions)\n      )\n      return\n\n\n    initializeAgent = ->\n      updateSubscriptions()\n      sendQueuedMethods()\n\n\n    Meteor.startup ->\n\n      return if not @Agent? and Offline._usingSharedWebWorker\n\n      addMessageHandler 'subscriptionsUpdated', ->\n        updateSubscriptions()\n        return\n\n      addMessageHandler 'newQueuedMethod', ->\n        sendQueuedMethods()\n        return\n\n      unless @Agent?\n        broadcast.listen 'deadWindows', ->\n          subscriptionsUpdated()\n          return\n\n      if @Agent?\n        initializeAgent()\n      else\n        nowAgent.listen initializeAgent\n\n      return\n","old_contents":"    {contains, Result} = awwx\n    {withContext} = awwx.Context\n    broadcast = Offline._broadcast\n    {defer} = awwx.Error\n    serialize = awwx.canonicalStringify\n    database = Offline._database\n\n    Offline._test or= {}\n\n\n    unless @Agent?\n      {nowAgent, thisWindowId} = Offline._windows\n\n\n    Offline._messageAgent = (topic, args...) ->\n      Meteor._debug 'messaging agent', topic, args\n      if Offline._usingSharedWebWorker\n        Offline._sharedWebWorker.post {msg: topic, args}\n      else if Offline._windows.currentlyTheAgent()\n        defer -> handlers[topic]?(args...)\n      else\n        broadcast topic, args...\n      return\n\n\n    if @Agent?\n\n      Meteor._debug 'agent'\n\n      Agent.addMessageHandler 'update', (sourcePort, data) ->\n        Meteor._debug 'update from client'\n        for port in Agent.ports\n          unless port is sourcePort\n            port.postMessage({msg: 'update'})\n        return\n\n\n      addMessageHandler = (topic, callback) ->\n        Agent.addMessageHandler topic, (sourcePort, data) ->\n          callback()\n          return\n\n\n      broadcastUpdate = ->\n        for port in Agent.ports\n          port.postMessage({msg: 'update'})\n        return\n\n\n    else\n\n      handlers = {}\n\n      addMessageHandler = (topic, callback) ->\n        handlers[topic] = callback\n        broadcast.listen topic, callback\n        return\n\n\n      broadcastUpdate = ->\n        broadcast.includingSelf 'update'\n        return\n\n\n    updateSubscriptionsReadyInTx = (tx) ->\n      withContext \"updateSubscriptionsReadyInTx\", ->\n        Result.join([\n          database.readSubscriptions(tx)\n          database.readSubscriptionsHeldUp(tx)\n        ])\n        .then(([subscriptions, subscriptionsHeldUp]) ->\n          newlyReady = []\n          for {connection, name, args, readyFromServer, ready} in subscriptions\n            if (not ready and\n                readyFromServer and\n                not contains(subscriptionsHeldUp, {connection, name, args}))\n              newlyReady.push {connection, name, args}\n          if newlyReady.length is 0\n            return false\n          writes = []\n          for {connection, name, args} in newlyReady\n            writes.push database.setSubscriptionReady(tx, connection, name, args)\n            writes.push database.addUpdate(tx, {\n              update: 'subscriptionReady',\n              subscription: {connection, name, args}\n            })\n          Result.join(writes)\n        )\n        .then(-> return true)\n\n\n    Offline._test.updateSubscriptionsReadyInTx = updateSubscriptionsReadyInTx\n\n\nTODO what we really want here for broadcasting updates is to have an\n\"after transaction\" callback that would broadcast an update iff an\nupdate was added to the database during the transaction.\n\n    updateSubscriptionsReady = ->\n      withContext \"updateSubscriptionsReady\", ->\n        database.transaction((tx) ->\n          updateSubscriptionsReadyInTx(tx)\n        )\n        .then((someNewlyReady) ->\n          if someNewlyReady\n            broadcastUpdate()\n          return\n        )\n\n\n    addNewSubscriptionToDatabase = (tx, connection, name, args) ->\n      withContext \"addNewSubscriptionToDatabase\", ->\n        database.readMethodsWithDocsWritten(tx, connection)\n        .then((methodIds) ->\n          database.addSubscriptionWaitingOnMethods(\n            tx,\n            connection,\n            name,\n            args,\n            methodIds\n          )\n        )\n        .then(->\n          database.ensureSubscription(tx, connection, name, args)\n        )\n\n\n    justNameAndArgs = (subscription) ->\n      {name: subscription.name, args: subscription.args}\n\n\nIf we're running in the shared web worker, we're always the\nagent. Otherwise, running in a browser window, we need to check if\nwe're still the agent in the transaction.\n\n    if @Agent?\n\n      asAgentWindow = (fn) ->\n        database.transaction(fn)\n\n    else\n\n      asAgentWindow = (fn) ->\n        database.transaction((tx) =>\n          database.readAgentWindow(tx)\n          .then((agentWindowId) =>\n            if agentWindowId is thisWindowId\n              return fn(tx)\n            else\n              return Result.failed()\n          )\n        )\n\n\nMapping of connection name to ConnectionAgents.\n\n    @connectionAgents = {}\n\n\n    class ConnectionAgent\n\n      constructor: (@connectionName, @meteorConnection) ->\n        if connectionAgents[@connectionName]?\n          throw new Error(\n            \"a ConnectionAgent has already been constructed for this connection name: #{@connectionName}\"\n          )\n\n        connectionAgents[@connectionName] = this\n\n        @methodHandlers = {}\n\ncollection name -> collectionAgent\n\n        @collectionAgents = {}\n\n\nA mapping of `methodId -> true` for methods in the database list of\nqueued methods that the agent has sent.\n\n        @methodsSent = {}\n\nserialized subscription -> Meteor subscription handle\n\n        @meteorSubscriptionHandles = {}\n\n        @_nMeteorSubscriptionsReady = 0\n\n        @_deletedRemovedDocs = false\n\n      deleteRemovedDocuments: (tx) ->\n        if @_deletedRemovedDocs\n          return Result.completed()\n        else\n          @_deletedRemovedDocs = true\n          return @_eachCollectionAgent((collectionAgent) ->\n            collectionAgent.deleteDocumentsGoneFromServer(tx)\n          )\n\n      checkIfReadyToDeleteDocs: (tx) ->\n        if @allMeteorSubscriptionsReady()\n          @deleteRemovedDocuments(tx)\n\n      _alreadyHaveMeteorSubscription: (subscription) ->\n        !! @meteorSubscriptionHandles[serialize(subscription)]\n\n      allMeteorSubscriptionsReady: ->\n        @_nMeteorSubscriptionsReady is _.size(@meteorSubscriptionHandles)\n\n      _eachCollectionAgent: (fn) ->\n        results = []\n        for name, collectionAgent of @collectionAgents\n          results.push fn(collectionAgent)\n        return Result.join(results)\n\n      instantiateCollectionAgent: (collectionName) ->\n        @collectionAgents[collectionName] or=\n          new CollectionAgent(\n            this,\n            collectionName,\n            new Meteor.Collection(collectionName)\n          )\n        return\n\n      instantiateCollectionAgents: (collectionNames) ->\n        for collectionName in collectionNames\n          @instantiateCollectionAgent(collectionName)\n        return\n\n\n      meteorSubscriptionReady: (subscription) ->\n        @instantiateCollectionAgents(_.keys(\n          @meteorConnection._updatesForUnknownStores\n        ))\n        asAgentWindow (tx) =>\n          # processUpdatesInTx(tx)\n          # .then(->\n          database.setSubscriptionReadyFromServer(\n            tx,\n            @connectionName,\n            subscription.name\n            subscription.args\n          )\n          # )\n          .then(->\n            updateSubscriptionsReadyInTx(tx)\n          )\n          .then(=>\n            ++@_nMeteorSubscriptionsReady\n            @checkIfReadyToDeleteDocs(tx)\n          )\n          .then(->\n            broadcastUpdate()\n          )\n\n      currentSubscriptions: ->\n        _.map(_.keys(@meteorSubscriptionHandles), EJSON.parse)\n\n      oldSubscriptions: (subscriptions) ->\n        _.reject(\n          @currentSubscriptions(),\n          ((subscription) => contains(subscriptions, subscription))\n        )\n\n      stopOldSubscriptions: (subscriptions) ->\n        for subscription in @oldSubscriptions(subscriptions)\n          serialized = serialize(subscription)\n          @meteorSubscriptionHandles[serialized].stop()\n          delete @meteorSubscriptionHandles[serialized]\n        return\n\n      startNewSubscription: (subscription) ->\n        @_deletedRemovedDocs = false\n        {name, args} = subscription\n        handle = Meteor.subscribe name, args..., =>\n          @meteorSubscriptionReady(subscription)\n          return\n        @meteorSubscriptionHandles[serialize(subscription)] = handle\n        return\n\n      newSubscriptions: (subscriptions) ->\n        _.reject(\n          subscriptions,\n          (subscription) => @_alreadyHaveMeteorSubscription(subscription)\n        )\n\n      startNewSubscriptions: (subscriptions) ->\n        for subscription in @newSubscriptions(subscriptions)\n          @startNewSubscription(subscription)\n        return\n\n      updateSubscriptions: (subscriptions) ->\n        subscriptions = _.map(subscriptions, justNameAndArgs)\n        @stopOldSubscriptions(subscriptions)\n        @startNewSubscriptions(subscriptions)\n        return Result.completed()\n\n\n      checkIfDocumentNowFree: (tx, collectionName, docId) ->\n        @collectionAgents[collectionName].updateDocFromServerIfFree(\n          tx,\n          docId,\n        )\n\n\n      methodCompleted: (methodId) ->\n        docsWhichWereWrittenByStub = null\n        asAgentWindow((tx) =>\n          database.removeQueuedMethod(tx, @connectionName, methodId)\n          .then(->\n            database.readDocsWrittenByStub(tx, @connectionName, methodId)\n          )\n          .then((docs) =>\n            docsWhichWereWrittenByStub = docs\n\n            database.removeDocumentsWrittenByStub(\n              tx, @connectionName, methodId\n            )\n          )\n          .then(=>\n            writes = []\n            for {collectionName, docId} in docsWhichWereWrittenByStub\n              writes.push @checkIfDocumentNowFree tx, collectionName, docId\n            return Result.join(writes)\n          )\n          .then(->\n            database.removeMethodHoldingUpSubscriptions(tx, methodId)\n          )\n          .then(->\n            updateSubscriptionsReadyInTx(tx)\n          )\n        )\n        .then(->\n          broadcastUpdate()\n        )\n        return\n\n\n      sendQueuedMethod: (methodId, name, args) ->\n        return if @methodsSent[methodId]\n        @methodsSent[methodId] = true\n        Meteor.call '\/awwx\/offline-data\/apply', methodId, name, args, (error, result) =>\n          if error\n            Meteor._debug 'offline method error', name, error\n          @methodCompleted(methodId)\n          return\n        return\n\n\n    newConnectionAgent = (connectionName) ->\n      meteorConnection = if connectionName is '\/'\n        Meteor.default_connection\n      else\n        Meteor.connect(connectionName)\n      return new ConnectionAgent(connectionName, meteorConnection)\n\n\n    connectionAgentFor = (connectionName) ->\n      connectionAgents[connectionName] or= newConnectionAgent(connectionName)\n\n\n    sendQueuedMethods = ->\n      asAgentWindow (tx) ->\n        database.readQueuedMethods(tx)\n        .then((methods) ->\n          for {connection, methodId, name, args} in methods\n            connectionAgentFor(connection).sendQueuedMethod(methodId, name, args)\n          return\n        )\n\n\nTODO rename\n\n    subscribeToNewSubscriptions = (subscriptions) ->\n\n      for subscription in subscriptions\n        connectionAgentFor subscription.connection\n\n      results = []\n      for connectionName, connectionAgent of connectionAgents\n        connectionSubscriptions =\n          _.filter(\n            subscriptions,\n            (subscription) -> subscription.connection is connectionName\n          )\n        results.push connectionAgent.updateSubscriptions(connectionSubscriptions)\n      return Result.join(results)\n\n\n    class CollectionAgent\n\n      constructor: (@connectionAgent, @collectionName, @serverCollection) ->\n        @connectionName = @connectionAgent.connectionName\n        @watchServer()\n\n\n      offlineDocumentsNotInServerCollection: (tx) ->\n        database.readDocIdsOfCollection(tx, @connectionName, @collectionName)\n        .then((docIds) =>\n          _.reject(\n            docIds,\n            ((docId) => @serverCollection.findOne(docId))\n          )\n        )\n\n\nWe have a full and complete set of data from the server (our\nsubscriptions are ready).  We can now delete documents in the offline\ncollection which are no longer present on the server.\n\n      deleteDocUnlessWrittenByStub: (tx, docId) ->\n        database.isDocumentWrittenByAnyStub(\n          tx,\n          @connectionName,\n          @collectionName,\n          docId\n        )\n        .then((wasWritten) =>\n          if wasWritten\n            return\n          else\n            database.deleteDoc(tx, @connectionName, @collectionName, docId)\n            .then(=>\n              @addDocumentUpdate tx, docId, null\n            )\n        )\n\n\n      deleteDocumentsGoneFromServer: (tx) ->\n        @offlineDocumentsNotInServerCollection(tx)\n        .then((docIds) =>\n          # TODO Result.map\n          writes = []\n          for docId in docIds\n            writes.push @deleteDocUnlessWrittenByStub(tx, docId)\n          return Result.join(writes)\n        )\n\n\n      addDocumentUpdate: (tx, docId, doc) ->\n        database.addUpdate tx, {\n          update: 'documentUpdated'\n          connectionName: @connectionName\n          collectionName: @collectionName\n          docId\n          doc\n        }\n\n\n      updateDocIfFree: (tx, docId, doc) ->\n        database.isDocumentWrittenByAnyStub(\n          tx,\n          @connectionName,\n          @collectionName,\n          docId\n        )\n        .then((wasWritten) =>\n          return if wasWritten\n          (if doc?\n            database.writeDoc tx, @connectionName, @collectionName, doc\n          else\n            database.deleteDoc tx, @connectionname, @collectionName, docId\n          )\n          .then(=>\n            @addDocumentUpdate(tx, docId, doc)\n          )\n        )\n\n\n      updateDocFromServerIfFree: (tx, docId) ->\n        @updateDocIfFree(tx, docId, @serverCollection.findOne(docId))\n\n\n      serverDocUpdated: (docId, doc) ->\n        asAgentWindow((tx) =>\n          @updateDocIfFree(tx, docId, doc)\n        )\n        .then(=>\n          broadcastUpdate()\n        )\n        return\n\n\nTODO can we batch updates into one transaction?\n\n      watchServer: ->\n        @serverCollection.find().observe\n          added:   (doc) => @serverDocUpdated doc._id, doc\n          changed: (doc) => @serverDocUpdated doc._id, doc\n          removed: (doc) => @serverDocUpdated doc._id, null\n        return\n\n\n    # meteorConnectionName = (meteorConnection) ->\n    #   if @meteorConection is Meteor.default_connection\n    #     '\/'\n    #   else\n    #     meteorConnection._stream.rawUrl\n\n\n    updateSubscriptions = ->\n      updateSubscriptionsReady()\n      subscriptionsUpdated()\n\n\n    subscriptionsUpdated = ->\n      asAgentWindow((tx) ->\n        database.readMergedSubscriptions(tx)\n      )\n      .then((subscriptions) ->\n        subscribeToNewSubscriptions(subscriptions)\n      )\n      return\n\n\n    initializeAgent = ->\n      updateSubscriptions()\n      sendQueuedMethods()\n\n\n    Meteor.startup ->\n\n      return if not @Agent? and Offline._usingSharedWebWorker\n\n      addMessageHandler 'subscriptionsUpdated', ->\n        updateSubscriptions()\n        return\n\n      addMessageHandler 'newQueuedMethod', ->\n        sendQueuedMethods()\n        return\n\n      unless @Agent?\n        broadcast.listen 'deadWindows', ->\n          subscriptionsUpdated()\n          return\n\n      if @Agent?\n        initializeAgent()\n      else\n        Meteor._debug 'nowAgent listen'\n        nowAgent.listen initializeAgent\n\n      return\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"88645e8e391ccc65ee20c70cfebcc91f3cdaab2e","subject":"remove extraneous event handler","message":"remove extraneous event handler\n","repos":"modweb\/most-exclusive-website,modweb\/most-exclusive-website","old_file":"client\/views\/pages\/home\/waiting.litcoffee","new_file":"client\/views\/pages\/home\/waiting.litcoffee","new_contents":"Autoform callback hooks\n\n    AutoForm.hooks\n      getInLine:\n        after:\n          method: (error, result) ->\n            if error?\n              console.log err\n            else\n              Session.set 'queueEntry', result\n\n    Template.waiting.helpers\n      nameSchema: -> NameSchema\n      queued: -> Queue.findOne()?\n      ticketNumber: -> Queue.findOne()?.ticketNumber\n      html: -> QueueMeta.findOne()?.html\n      isActive: -> QueueMeta.findOne()?.isActive\n      posts: ->\n        postsSort = (post) -> -post.ticketNumber\n        posts = _.sortBy(Posts.find().fetch(), postsSort)\n      isBeingServed: ->\n        return no if not Queue.findOne()?\n\nGet new gifUrl\n\n        isBeingServed = Queue.findOne()?._id is QueueMeta.findOne()?.currentlyServingQueueId\n        if not isBeingServed\n          Session.set 'gifUrl', null\n          Session.set 'queueId', null\n        return isBeingServed\n\n      Template.waiting.rendered = ->\n        $('body').css 'background-color', '#eee'\n","old_contents":"Autoform callback hooks\n\n    AutoForm.hooks\n      getInLine:\n        after:\n          method: (error, result) ->\n            if error?\n              console.log err\n            else\n              Session.set 'queueEntry', result\n\n    Template.waiting.helpers\n      nameSchema: -> NameSchema\n      queued: -> Queue.findOne()?\n      ticketNumber: -> Queue.findOne()?.ticketNumber\n      html: -> QueueMeta.findOne()?.html\n      isActive: -> QueueMeta.findOne()?.isActive\n      posts: ->\n        postsSort = (post) -> -post.ticketNumber\n        posts = _.sortBy(Posts.find().fetch(), postsSort)\n      isBeingServed: ->\n        return no if not Queue.findOne()?\n\nGet new gifUrl\n\n        isBeingServed = Queue.findOne()?._id is QueueMeta.findOne()?.currentlyServingQueueId\n        if not isBeingServed\n          Session.set 'gifUrl', null\n          Session.set 'queueId', null\n        return isBeingServed\n\n    Template.waiting.events\n      'click .queueInLine': (event) ->\n\nReturn immediatly if the user is already queued. More logic on the server, but\nthis will help.\n\n        return if (Session.get 'queueEntry')?\n\nCall the meteor method to get queued.\n\n        Meteor.call 'getInQueue', 'fakeName', (error, result) ->\n          if error?\n            console.log err\n          else\n            Session.set 'queueEntry', result\n\n      Template.waiting.rendered = ->\n        $('body').css 'background-color', '#eee'\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7394fd3607cef77d14a54c2013499139c1578308","subject":"Formatting","message":"Formatting\n","repos":"nswarr\/epiquery2-client","old_file":"src\/epi-buffering-client.litcoffee","new_file":"src\/epi-buffering-client.litcoffee","new_contents":"EpiBufferingClient\n==================\n\n    EpiClient = require '.\/epi-client'\n    guid      = require '.\/guid'\n    q         = require 'q'\n\nThis is a subclass of the [EpiClient](epi-client.litcoffee) that simplifies querying by aggregating the results of a query and providing a query callback mechanism instead of tracking queries by hand.\n\n    class EpiBufferingClient extends EpiClient\n      constructor: (@url) ->\n        super(@url)\n        @results = {}\n        @callbacks = {}\n\nWhen a row set is began, a new object is inserted into the local **results** that will be populated with that row set as the rows come in.  Each time a new row set is began, the process starts over.\n\n      onbeginrowset: (msg) =>\n        newResultSet = []\n        @results[msg.queryId] ||= resultSets: []\n        @results[msg.queryId].currentResultSet = newResultSet\n        @results[msg.queryId].resultSets.push newResultSet\n\n      onrow: (msg) =>\n        @results[msg.queryId].currentResultSet.push(msg.columns)\n\nThe **exec** function is analgous to the **query** function of the [EpiClient](epi-client.litcoffee) except it replaces the queryId argument with an optional callback.  It has two callback mechanisms, you may choose one.  If you provide a callback, that will be used.  Otherwise, exec will return a promise that will be called upon query completion.\n\nInternally, it's generating a queryId for you and uses that to track the query and aggregate results.\n\n      exec: (connectionName, template, data, callback) =>\n        queryId = guid()\n\n        deferred = q.defer()\n        if callback\n          @callbacks[queryId] = callback\n        else\n          @callbacks[queryId] = deferred\n\n        @query(connectionName, template, data, queryId)\n\n        deferred.promise\n\nWhen the query completes, we call back to either the promise or user-provided callback.\n\n      onendquery: (msg) =>\n        return unless callback = @callbacks[msg.queryId]\n\n        if callback.promise\n          callback.resolve(@results[msg.queryId])\n        else\n          callback(null, @results[msg.queryId])\n\n        delete @callbacks[msg.queryId]\n\nIf the query drops out due to error, we call back to either the promise or user-provided callback.\n\n      onerror: (msg) =>\n        return unless callback = @callbacks[msg.queryId]\n\n        if callback.promise\n          callback.reject(@results[msg.queryId])\n        else\n          callback(msg)\n\n        delete @callbacks[msg.queryId]\n\n\n    module.exports = EpiBufferingClient","old_contents":"EpiBufferingClient\n==================\n\n    EpiClient = require '.\/epi-client'\n    guid                  = require '.\/guid'\n    q                     = require 'q'\n\nThis is a subclass of the [EpiClient](epi-client.litcoffee) that simplifies querying by aggregating the results of a query and providing a query callback mechanism instead of tracking queries by hand.\n\n    class EpiBufferingClient extends EpiClient\n      constructor: (@url) ->\n        super(@url)\n        @results = {}\n        @callbacks = {}\n\nWhen a row set is began, a new object is inserted into the local **results** that will be populated with that row set as the rows come in.  Each time a new row set is began, the process starts over.\n\n      onbeginrowset: (msg) =>\n        newResultSet = []\n        @results[msg.queryId] ||= resultSets: []\n        @results[msg.queryId].currentResultSet = newResultSet\n        @results[msg.queryId].resultSets.push newResultSet\n\n      onrow: (msg) =>\n        @results[msg.queryId].currentResultSet.push(msg.columns)\n\nThe **exec** function is analgous to the **query** function of the [EpiClient](epi-client.litcoffee) except it replaces the queryId argument with an optional callback.  It has two callback mechanisms, you may choose one.  If you provide a callback, that will be used.  Otherwise, exec will return a promise that will be called upon query completion.\n\nInternally, it's generating a queryId for you and uses that to track the query and aggregate results.\n\n      exec: (connectionName, template, data, callback) =>\n        queryId = guid()\n\n        deferred = q.defer()\n        if callback\n          @callbacks[queryId] = callback\n        else\n          @callbacks[queryId] = deferred\n\n        @query(connectionName, template, data, queryId)\n\n        deferred.promise\n\nWhen the query completes, we call back to either the promise or user-provided callback.\n\n      onendquery: (msg) =>\n        return unless callback = @callbacks[msg.queryId]\n\n        if callback.promise\n          callback.resolve(@results[msg.queryId])\n        else\n          callback(null, @results[msg.queryId])\n\n        delete @callbacks[msg.queryId]\n\nIf the query drops out due to error, we call back to either the promise or user-provided callback.\n\n      onerror: (msg) =>\n        return unless callback = @callbacks[msg.queryId]\n\n        if callback.promise\n          callback.reject(@results[msg.queryId])\n        else\n          callback(msg)\n\n        delete @callbacks[msg.queryId]\n\n\n    module.exports = EpiBufferingClient","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7da0bf2bc250dcddbf5e5721641a3fc22169cb08","subject":"Add feature: interval label placement.","message":"Add feature: interval label placement.\n","repos":"nasedil\/timeline-scale,nasedil\/timeline-scale","old_file":"src\/time-axis-experiment.litcoffee","new_file":"src\/time-axis-experiment.litcoffee","new_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.  The `options` parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters, `interval` (a dictionary with `start` and `end` values, each of Date type) and corresponding to that interval `width` of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\nText labels can be basically displayed in two ways.  The first one is to put label right under the tick, so that lable corresponds to time or date at this point.  Another way is to put label between ticks so that it corresponds to time interval between these two ticks.  For me it seems quite rational to use the first way to show times, and the second way to show days, months and years;  this is in case of general timeline, that we can move and zoom, and without a need to highlight particular dates.  To clarify what I mean we can consider a typical time axis in pretty much any library these days.  When zoomed out a lot, it usually shows ticks at times like 00:00, at first day of month or a year.  This is pretty logical.  But then, usually a label is shown under such tick, for examle a label of a month that starts at this point of time.  Which doesn't make much sense, because a month is a period.  When we say 'in November', we usually mean 'some time between start and end of November' (unlike when we say 'at 3', which usually means 'at 3:00').  But if the label is under 00:00 of 1st of November, it looks for a viewer like november corresponds to some time from mid-October to mid-November.  Which is very confusing and misleading too.  On the other side, showing the 'November' label in the middle of November on an axis corrects this.  This is a motivation for making two types of label positioning in our timeline implementation:  _point_ and _interval_.  They are determined by `options.labelPlacement` ('point' or 'interval').\n\nTo do it we first make a list of text labels assuming point label placement.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nThen, if `options.labelPlacement` is equal to 'interval', we remove the last item and adjust x coordinates of other items.\n\n_Note_: one could thing of better implementation here.  I tried to make it shorter and came to the current solution.\n\n        for textLabel, i in textLabels when i isnt (textLabels.length-1)\n          textLabel.x = (textLabel.x + textLabels[i+1].x) \/ 2\n        textLabels.pop()\n\nNow we combine all elements into a one dictionary and return it.\n\n        features =\n          lines: ticks.concat axisLine\n          textLabels: textLabels\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for a (`start`, `end`) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not inside the given `interval` (excluding beginning).  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker\n        tickLength: 25\n        intervalType: 'day'\n        labelPlacement: 'interval'\n        intervalMultiplier: 1\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","old_contents":"Timeline axis in CoffeeScript\n=============================\n\nIntroduction and description\n----------------------------\n\nThis demo is aimed at exploring possibilities of visualizing time axis.  This especially applies to situations where time axis is meant to be used in interactive plotting, being able to change from very short time intervals to very long time intervals.\n\nMain points of usability of the timeline are:\n * Area that the timeline takes (ideally, as little as possible).\n * Clarity and readability (ideally text\/info should be concise and distinctive).\n * How much information is showed (ideally, as much as current zoom level and resolution can afford).\n * Should be easily navigable (should work also for visually impaired).\n * Should be interactive (ideally react according to its representation).\n\nTest cases\n----------\n\n### Visual test cases\n\n 1. All time labels and ticks should correspond to their times\n 2. Daylight-saving time should be displayed correctly\n 3. Leap seconds should be displayed properly\n 4. Every interval type should be displayed properly\n   1. year\n   2. month\n   3. week\n   4. day\n   5. hour\n   6. minute\n   7. second\n   8. millisecond\n 5. Check that lines and text are sharp\n 6. There should be no intersection of features\n\n### Unit test cases\n\nTo be done:\n * Labels should not intersect with each other\n * There should be at least one label (or no?)\n * Label should be in range if its coordinates are in viewport\n * Check for daylight-saving time\n * Check for daylight-saving time table for several historical intervals\n * Check for leap seconds\n\nDevelopment concerns\n--------------------\n\n### Readability\n\nThe following things should be thought of before making a final version:\n * DPI should be taken into account.  It should work fine on any DPI display.\n * Every element should be separated from others.\n    * Visual elements should not intersect with each other.\n    * Visual elements such as labels and ticks should be at some good distance to each other.\n * It is a good idea to alternate colors of intervals.\n    * Use two colors.\n    * They should differ for visually impaired.\n    * And should be suitable for grey-color display.\n    * Thus, they should differ in brightness at least.\n * Continuos change (opposed to discrete) between scales (that is zoom levels).\n    * Makes it possible to animate without jumps between representation levels, keeping viewer connection to details.\n    * Adds more information to viewer.  A question is how to keep this simple enough and not bloated with information and graphics.\n\n### Portability\n\nTo make it more flexible to render (to canvas, svg, vega, anything else), we should have an intermediate object as output of axis formatting, which could be rendered after withe a chosen rendeder.\n\nLibrary functions\n-----------------\n\n### The `TimelineMaker` class\n\nSince formatting and rendering of timeline involves a lot of calculations, it is divided in several functions, and they are combined in the `TimelineMaker` class.  The `options` parameter will be a dictionary with values that are needed for formatting the timeline.\n\n    class TimelineMaker\n      constructor: (@options) ->\n\nThe two functions that are intended to be called are `formatTimeAxis()`, which formats time axis into a dictionary that describes the look of axis, and one of the `renderTo...` functions that render that data dictionary to a desired context.\n\n#### The `formatTimeAxis()` function\n\nA function that formats time axis into an intermediate format.  It has two parameters, `interval` (a dictionary with `start` and `end` values, each of Date type) and corresponding to that interval `width` of a viewport.  It returns a formatted time axis object.  This object is a collection of features with their coordinates in a viewport (the top left point of the viewport is (0,0), the top-right is (0, width)).\n\n      formatTimeAxis: (interval, width) ->\n        {@start, end} = interval\n        @intervalLength = end - @start\n        @width = width\n\nWe can put on axis ticks and labels, and also colour areas between them.  They correspond to a set of time points.  Labels could correspond to time points or to time intervals between these points.\n\nTicks should correspond to _edge points_ of time, a point of time between two days (00-00), two years, months, weeks, or a sharp time point, having integer number of hours, or minutes, or seconds.  In general, while moving from bigger to smaller time interval types, every interval type has to be in integer amount, until  some point.  For example (10 years, 2 months, 3 days) from Epoch and remainder which is less than one day.  That means whe should have a parameter that corresponds to the smallest time interval that has to be integral.  We call this parameter _options.intervalType_.  We also need a number of this intervals between each tick.  This parameter will be `options.intervalMultiplier`.  There is one exception though:  in case of weeks there is no previous integral interval.  So there are two cases:  week and (year, month, day, hour, minute, second, millisecond).\n\nSo we need to build a list of time points that correspond to a given time interval.  We will put such code in a special function, `findPointList()`.\n\n        pointList = @findPointList @start, end\n\nNow, when we have found the list of time points, we need to construct a dictionary with graphical elements (features).  To transform time value into a coordinate we use the `timeToCoord()` function.  We start with ticks.  Each tick is a line.  The @options.tickLength parameter is a base length of a tick.  We assume that (y = 0) is a baseline and tick length is from baseline to `@options.tickLength` down and `@options.tickLength\/5` up.\n\nWe store ticks and other lines in `lines` element of the dictionary.\n\n        ticks = for timePoint in pointList\n          {\n            x1: @timeToCoord timePoint\n            x2: @timeToCoord timePoint\n            y1: -@options.tickLength \/ 5\n            y2: @options.tickLength\n          }\n\nWe also add axis (a horizontal line).\n\n        axisLine = {\n          x1: 0\n          x2: @width\n          y1: 0\n          y2: 0\n        }\n\nNow we construct a list of text features, each has coordinates and string.\n\n_Note_:  here we also need to improve formatting, now it's just a quick fix to display text.  Text should be formatted without problems on any display and resolution and shouldn't intersect ticks when it has reasonable font size.\n\n        textLabels = for timePoint in pointList\n          {\n            x: @timeToCoord timePoint\n            y: @options.tickLength * 1.2\n            text: switch @options.intervalType\n              when 'year' then timePoint.getFullYear().toString()\n              when 'month' then timePoint.getMonth().toString()\n              when 'week', 'day' then timePoint.getDate().toString()\n              when 'hour' then timePoint.getHours().toString()\n              when 'minute' then timePoint.getMinutes().toString()\n              when 'second' then timePoint.getSeconds().toString()\n              when 'millisecond' then timePoint.getMilliseconds().toString()\n          }\n\nNow we combine all elements into a one dictionary and return it.\n\n        {\n          lines: ticks.concat axisLine\n          textLabels\n        }\n\n#### The `findPointList()` function\n\nThis function returns a list of points that are needed to be calculated for a (`start`, `end`) interval.\n\n      findPointList: (start, end) ->\n\nSince we could need labels between time points, we need time points inside the interval (non-inclusive) and one point on left and right side.  We can build the point list by finding the leftmost _edge point_ which is strictly less than the `start` of the interval.  We move code that does that to the `findLeftTime()`.\n\n        timePoint = @findLeftTime start\n\nThen, we populate the list in by incrementing points until the we reach right end of the interval, using `findNextPoint()` function.\n\n        pointList = [timePoint]\n        until timePoint > end\n          timePoint = @findNextPoint timePoint\n          pointList.push timePoint\n        pointList\n\n#### The `findLeftTime()` function\n\nThe `findLeftTime()` function calculates the rightmost point of time for current `options.intervalType` such that it is not inside the given `interval` (excluding beginning).  The `options.intervalType` could be one of the following:\n * 'year'\n * 'month'\n * 'week'\n * 'day'\n * 'hour'\n * 'minute'\n * 'second'\n * 'millisecond'\n\nAnother option, `options.intervalMultiplier`, says how many of such intervals are between two time points.  It should be an integer value.  For years and months we truncate them to the desired value, while for days and weeks we will count from a fixed origin day near Epoch (Monday 5 january 1970), so that any day intervals are independent from underlying months and years.  That also means that in case of months the `options.intervalMultiplier` should be equal to 1, 2, 3, 4 or 6 to be displayed correctly.  To calculate number of days or weeks (reduced to 7 calculation for 7 days) from origin day we use binary subtracting, starting from huge multiplier equal to 1048576 (roughly 2800\/11200 years), going down to base multiplier equal to 1.  For interval types smaller or equal than hours we use the `findNextPoint()` function by incrementing local origin (the interval type and everything smaller is reset to 0).  This is done to avoid problems with daylight-saving and similar things.  In `findNextPoint()` we make sure that edge points are consistent while using different values of `start`.\n\n      findLeftTime: (start) ->\n        leftTime = new Date start.getTime()\n        switch @options.intervalType\n          when 'year'\n            newYear = start.getFullYear() - start.getFullYear() % @options.intervalMultiplier\n            leftTime.setFullYear newYear, 0, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'month'\n            newMonth = start.getMonth() - start.getMonth() % @options.intervalMultiplier\n            leftTime.setMonth newMonth, 1\n            leftTime.setHours 0, 0, 0, 0\n          when 'week', 'day'\n            leftTime.setFullYear 1970, 0, 5\n            leftTime.setHours 0, 0, 0, 0\n            delta = 1048576\n            intervalMultiplier = @options.intervalMultiplier\n            if @options.intervalType is 'week'\n              intervalMultiplier *= 7\n            while delta >= 1\n              nextTime = new Date leftTime.getFullYear(),\n                leftTime.getMonth()\n                leftTime.getDate() + delta*intervalMultiplier\n                leftTime.getHours()\n                leftTime.getMinutes()\n                leftTime.getSeconds()\n                leftTime.getMilliseconds()\n              delta \/= 2\n              leftTime = nextTime if nextTime <= start\n          when 'hour'\n            leftTime.setHours 0, 0, 0, 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'minute'\n            newMinutes = start.getMinutes() - start.getMinutes() % @options.intervalMultiplier\n            leftTime.setMinutes newMinutes, 0, 0\n          when 'second'\n            leftTime.setSeconds start.getSeconds(), 0\n            while leftTime < start\n              nextTime = @findNextPoint leftTime\n              leftTime = nextTime if nextTime <= start\n          when 'millisecond'\n            newMilliseconds = start.getMilliseconds() - start.getMilliseconds() % @options.intervalMultiplier\n            leftTime.setMilliseconds newMilliseconds\n        leftTime\n\nThere is a code repetition in the switch statement above.  One can think of a good way to improve this part of code.\n\n### The `findNextPoint()` function\n\nThis function calculates next edge time point for a current options assuming `timePoint` argument is an edge time point.  We take care of daylight-saving time and leap seconds here, assuming that at most one hour\/minute\/second\/millisecond is added or subtracted.  Also we assume that subtraction is not happening at time with 0 value, that is something like 00 -> 23 is not happening.\n\nIn current implementation we cope with daylight-saving time by adding hours in UTC to date and then checking how the value changes in local time and fixing by one hour if needed.  The same for leap seconds.\n\n      findNextPoint: (timePoint) ->\n        nextTime = new Date timePoint.getTime()\n        switch @options.intervalType\n          when 'year'\n            nextTime.setFullYear (timePoint.getFullYear() + @options.intervalMultiplier)\n          when 'month'\n            nextTime.setMonth (timePoint.getMonth() + @options.intervalMultiplier)\n          when 'week'\n            nextTime.setDate (timePoint.getDate() + 7*@options.intervalMultiplier)\n          when 'day'\n            nextTime.setDate (timePoint.getDate() + @options.intervalMultiplier)\n          when 'hour'\n            nextTime.setUTCHours (timePoint.getUTCHours() + @options.intervalMultiplier)\n            hours = nextTime.getHours()\n            if hours % @options.intervalMultiplier isnt 0\n              if (hours+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCHours (nextTime.getUTCHours() + 1)\n              else\n                nextTime.setUTCHours (nextTime.getUTCHours() - 1)\n          when 'minute'\n            nextTime.setMinutes (timePoint.getMinutes() + @options.intervalMultiplier)\n          when 'second'\n            nextTime.setUTCSeconds (timePoint.getUTCSeconds() + @options.intervalMultiplier)\n            seconds = nextTime.getSeconds()\n            if seconds % @options.intervalMultiplier isnt 0\n              if (seconds+1) % @options.intervalMultiplier is 0\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() + 1)\n              else\n                nextTime.setUTCSeconds (nextTime.getUTCSeconds() - 1)\n          when 'millisecond'\n            nextTime.setUTCMilliseconds (timePoint.getUTCMilliseconds() + @options.intervalMultiplier)\n        nextTime\n\n#### The `timeToCoord()` function\n\nTo get coordinate of time point we use `@intervalLength` that we stored in `formatTimeAxis()`, which is equal to the number of milliseconds between `end` and `start` of the interval.  We use it to calculate pixe\/time ratio, equal to `@width \/ @intervalLength`.\n\n      timeToCoord: (time) ->\n        timeFromStart = time - @start\n        coordinate = timeFromStart * @width \/ @intervalLength\n\n#### The `renderToCanvas()` function\n\nThis function renders formatted time axis to html canvas.\n * `axisData` is formatted data (that we get by calling any of the `format...()` functions)\n * `canvas` is a html canvas object on which axis is drawn\n * `left` and `top` are x- and y-coordinates of the canvas that correspond to the (0, 0) point of the axis viewport\n\n      renderToCanvas: (axisData, canvas, left, top) ->\n\nIn the beginning we do just regular initialization of context and its properties.  We also wrap our drawing code into `save()` and `restore()` to not alter context properties globally.\n\n        context = canvas.getContext '2d'\n        context.save()\n        context.strokeStyle = '#000000'\n        context.fillStyle = '#000000'\n        context.lineWidth = 1\n        context.font = 'normal 12px sans-serif'\n        context.textAlign = 'center'\n        context.textBaseline = 'top'\n\nTo all drawing functions we pass coordinates altered by `roundForCanvas()` function, which rounds values in such a way that lines are more sharp.\n\n        context.beginPath()\n        for line in axisData.lines\n          x1 = left + line.x1\n          x2 = left + line.x2\n          y1 = top + line.y1\n          y2 = top + line.y2\n          context.moveTo @roundForCanvas(x1), @roundForCanvas(y1)\n          context.lineTo @roundForCanvas(x2), @roundForCanvas(y2)\n        context.stroke()\n\n        for textLabel in axisData.textLabels\n          x = left + textLabel.x\n          y = top + textLabel.y\n          context.fillText textLabel.text, x, y\n\n        context.restore()\n\n#### The `roundForCanvas()` function\n\nThis function may be used to avoud aliasing of lines, especially on low-resolution displays.  It rounds coordinate to middle-pixel values, which are .5 in case of html canvas.\n\n      roundForCanvas: (coord) ->\n        0.5 + Math.round(coord-0.5)\n\nLibrary tests\n-------------\n\nExamples\n--------\n\nBefore we display anytihng, we define a function that colors background of canvas in some color, to erase before rendering axis, and to make canvas area easily visible.\n\n    recleanCanvas = ->\n      canvas = document.getElementById 'timeline'\n      context = canvas.getContext '2d'\n      context.fillStyle = '#77FFBB'\n      context.fillRect(0, 0, canvas.clientWidth, canvas.clientHeight)\n\nThe `getMousePos` function gives mouse position relative to a `canvas`.\n\n    getMousePos = (canvas, event) ->\n      rect = canvas.getBoundingClientRect()\n      {\n        x: event.clientX - rect.left\n        y: event.clientY - rect.top\n      }\n\nThis simple code displays time axis when html page is loaded, in `timeline` canvas element.\n\n    makeDemo = ->\n      canvas = document.getElementById 'timeline'\n      recleanCanvas()\n      timelineMaker = new TimelineMaker {tickLength: 25, intervalType: 'day', intervalMultiplier: 1}\n      start = new Date('2015-06-15T00:00:00')\n      end = new Date('2015-07-13T15:23:49')\n      axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n      timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWa also add mouse tracking functionality to test our timeline.  When mouse is pressed we can change time interval by dragging mouse.\n\n      dragging = false\n      oldX = 0\n      oldY = 0\n      document.getElementById('timeline').onmousedown = (event) ->\n        dragging = true\n        canvas = document.getElementById 'timeline'\n        {x: oldX, y: oldY} = getMousePos(canvas, event)\n\n      document.getElementById('timeline').onmouseup = (event) ->\n        dragging = false\n\n      document.getElementById('timeline').onmousemove = (event) ->\n        if dragging\n          canvas = document.getElementById 'timeline'\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n          deltaX = event.clientX - oldX\n          deltaY = event.clientY - oldY\n          oldX = event.clientX\n          oldY = event.clientY\n\nNow we calculate how much time we should move.\n\n          timeInterval = end - start\n          timeDelta = - deltaX * timeInterval \/ canvas.clientWidth\n          start = new Date (start.getTime() + timeDelta)\n          end = new Date (end.getTime() + timeDelta)\n\nAnd render it again.\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nThe same for mouse wheel:  we change `intervalLength` when wheel is scrolled.  We keep the same time value under mouse pointer before and after zooming.  This is done by multiplying interval before point and after point by zooming multiplier.  So if mouse point has time P and our interval is _(P - A, P + B)_ it becomes after zoom _(P - A*m, P + B*m)_, where _m_ is the multiplier.\n\n        base = 1.05\n        document.getElementById('timeline').onwheel = (event) ->\n          canvas = document.getElementById 'timeline'\n          multiplier = Math.pow(base, event.deltaY)\n          timeInterval = end-start\n          {x: clientX, y: clientY} = getMousePos(canvas, event)\n\nIn the next line we subtract `0.5` to correct mouse x offset, though it is strange that we need to subtract it.  But it works better, so we keep it as a quick fix.\n\n          leftInterval = (clientX-0.5) * timeInterval \/ canvas.clientWidth\n          rightInterval = timeInterval - leftInterval\n          mousePoint = start.getTime() + leftInterval\n          leftInterval *= multiplier\n          rightInterval *= multiplier\n          start = new Date(mousePoint - leftInterval)\n          end = new Date(mousePoint + rightInterval)\n\n          recleanCanvas()\n          axisData = timelineMaker.formatTimeAxis {start, end}, canvas.width\n          timelineMaker.renderToCanvas axisData, canvas, 0, 15\n\nWe run the `makeDemo` function when page loads.\n\n    window.onload = makeDemo\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"583e6fe2e82ec4eaa374313c644cb777e7031333","subject":"Add sample file for Literate CoffeeScript","message":"Add sample file for Literate CoffeeScript\n","repos":"CegepVictoriaville\/linguist,scttnlsn\/linguist,JJ\/linguist,blakeembrey\/linguist,manveru\/linguist,erkyrath\/linguist,maxogden\/linguist,ilyes14\/linguist,stanhu\/linguist,yyx990803\/linguist,SRI-CSL\/linguist,0a-\/linguist,mattn\/linguist,adamkaplan\/linguist,christop\/linguist,github\/linguist,cybernet14\/linguist,iblech\/linguist,christop\/linguist,kr\/linguist,georgesuperman\/linguist,R4PaSs\/linguist,jtbandes\/linguist,SRI-CSL\/linguist,phpsgi\/linguist,stanhu\/linguist,PsichiX\/linguist,Ocramius\/linguist,mcandre\/linguist,hcutler\/linguist,Mx7f\/linguist,ppaulweber\/github-linguist,JJ\/linguist,FStarLang\/linguist,cybernet14\/linguist,mcandre\/linguist,scttnlsn\/linguist,whitj00\/linguist,mwpastore\/linguist,matt40k\/linguist,igat259\/linguist,chiranjeevjain\/linguist,steventhanna\/linguist,erkyrath\/linguist,thejameskyle\/linguist,Mx7f\/linguist,alitalia\/linguist,c-lipka\/linguist,Mailaender\/linguist,davidzchen\/linguist,CoderXpert\/linguist,mwpastore\/linguist,whitj00\/linguist,R4PaSs\/linguist,meunierfrederic\/octocatlinguist,cokeboL\/linguist,ChaiScript\/linguist,github\/linguist,ammaraskar\/linguist,davidzchen\/linguist,sebgod\/linguist,jjatria\/linguist,pchaigno\/linguist,BerkeleyTrue\/linguist,pcantrell\/linguist,martynbm\/linguist,nburkley\/linguist,ilyes14\/linguist,c-lipka\/linguist,blakeembrey\/linguist,manveru\/linguist,yscho\/linguist,phpsgi\/linguist,Rockyspade\/linguist,yyx990803\/linguist,martynbm\/linguist,iblech\/linguist,yyx990803\/linguist,mattn\/linguist,yscho\/linguist,BerkeleyTrue\/linguist,ammaraskar\/linguist,Rockyspade\/linguist,nburkley\/linguist,assimovt\/ling-ist,CegepVictoriaville\/linguist,cokeboL\/linguist,stanhu\/linguist,erkyrath\/linguist,FStarLang\/linguist,a0viedo\/linguist,osorgin\/linguist,sebgod\/linguist,ppaulweber\/github-linguist,kr\/linguist,pchaigno\/linguist,hcatlin\/linguist,douglas-larocca\/linguist,chiranjeevjain\/linguist,yyx990803\/linguist,bluebear94\/linguist,sebgod\/linguist,anhongyue\/test222,JJ\/linguist,hcutler\/linguist,stanhu\/linguist,jrnold\/linguist,sagar290\/linguist,meunierfrederic\/octocatlinguist,sideci-sample\/sideci-sample-linguist,JJ\/linguist,github\/linguist,adamkaplan\/linguist,georgesuperman\/linguist,bluebear94\/linguist,tschf\/linguist,MadcapJake\/linguist,marcojonker\/test,sideci-sample\/sideci-sample-linguist,douglas-larocca\/linguist,jrnold\/linguist,anhongyue\/test222,erkyrath\/linguist,gitlabhq\/linguist,pchaigno\/linguist,0a-\/linguist,MostAwesomeDude\/linguist,wcandillon\/linguist,marcojonker\/test,CoderXpert\/linguist,meunierfrederic\/octocatlinguist,matt40k\/linguist,ya7lelkom\/linguist,thejameskyle\/linguist,steventhanna\/linguist,osorgin\/linguist,kyoungrok0517\/linguist,pcantrell\/linguist,seanders\/linguist,alvarotrigo\/linguist,sagar290\/linguist,alitalia\/linguist,pchaigno\/linguist,a0viedo\/linguist,jtbandes\/linguist,wcandillon\/linguist,PsichiX\/linguist,seanders\/linguist,alvarotrigo\/linguist,tschf\/linguist,hcatlin\/linguist,MahmoudFayed\/linguist,MahmoudFayed\/linguist,sebgod\/linguist,MostAwesomeDude\/linguist,jjatria\/linguist,MadcapJake\/linguist,assimovt\/ling-ist,ya7lelkom\/linguist,kyoungrok0517\/linguist,github\/linguist","old_file":"samples\/Literate CoffeeScript\/scope.litcoffee","new_file":"samples\/Literate CoffeeScript\/scope.litcoffee","new_contents":"","old_contents":"","returncode":1,"stderr":"error: pathspec 'samples\/Literate' did not match any file(s) known to git\nerror: pathspec 'CoffeeScript\/scope.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"a9df03d95a4eca5eded65246e574d5f60686101d","subject":"document the jquery extra","message":"document the jquery extra\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/25_jquery.litcoffee","new_file":"docs\/25_jquery.litcoffee","new_contents":"# \/api\/Extras\/Batman.jQuery\n\nThe `batman.jquery` extra is an implementation library for `Batman.DOM` and `Batman.Request` that depends on [jQuery](http:\/\/jquery.com\/). It is packaged with batman.js builds on the [downloads page](\/downloads.html).\n\nBesides implementing `Batman.DOM` and `Batman.Request`, it adds a `\"$node\"` accessor to `Batman.View`, which returns the jQuery selection for the view's `node`. For example:\n\n```coffeescript\nclass MyApp.CustomView extends Batman.View\n  viewDidAppear: ->\n    @get(\"$node\") # => returns a jQuery selection\n```\n\n## Batman.DOM Implementation\n\n`batman.jquery` implements the necessary functions of `Batman.DOM`: `querySelectorAll`, `querySelector`, `setInnerHTML`, `destroyNode`, `containsNode`, `textContent`, `addEventListener` and `removeEventListener`.\n\n## Batman.Request Implementation\n\n`batman.jquery` implements `Batman.Request::send` to use the `jquery.ajax` function.\n\nIt adds a `xhr` property to completed requests which contains the [`jqXHR` object](http:\/\/api.jquery.com\/Types\/#jqXHR).\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'docs\/25_jquery.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"cc457fb67bdf3d8cac8d11c44189a44dc94682fc","subject":"Create dice.litcoffee","message":"Create dice.litcoffee","repos":"Heark\/projectX,Heark\/projectX,Heark\/projectX,Heark\/projectX","old_file":"dice.litcoffee","new_file":"dice.litcoffee","new_contents":"# Dice Game written by Heark\n#\n#'||  ||`                       '||      \n# ||  ||                         ||      \n# ||''||  .|''|,  '''|.  '||''|  || \/\/`  \n# ||  ||  ||..|| .|''||   ||     ||<<    \n#.||  ||. `|...  `|..||. .||.   .|| \\\\.  \n#                                        \n#                                        \n#.|'''''|                                            .|'''',           \n#|| .                         ''                     ||                \n#|| |''||  '''|.  '||),,(|,   ||  `||''|,  .|''|,    ||      .|''|,    \n#||    || .|''||   || || ||   ||   ||  ||  ||  ||    ||      ||  ||    \n#`|....|' `|..||. .||    ||. .||. .||  ||. `|..||    `|....' `|..|' .. \n#                                              ||                      \n#\ndie = Math.floor(Math.random() * 6) + 1\ndie2 = Math.floor(Math.random() * 6) + 1\noppdie = Math.floor(Math.random() * 6) + 1\noppdie2 = Math.floor(Math.random() * 6) + 1\nscore = undefined\noppscore = undefined\nif die is 1\n  score = 0\nelse\n  score = @die\nif oppdie is 1\n  oppscore = 0\nelse\n  oppscore = @oppdie\nconsole.log \"You rolled a \" + die + \" for a score of \" + score + \"\"\nconsole.log \"Your opponent rolled a \" + oppdie + \" for a score of \" + oppscore + \"\"\nif score > oppscore\n  console.log \"You win!\"\nelse if score < oppscore\n  console.log \"You Lose!\"\nelse console.log \"Tie Game!\"  if score = oppscore\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'dice.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"afbf19923048f12e8af5659be92ad3a9ce23b5f6","subject":"Began refactor; camera logic is now in its own module.","message":"Began refactor; camera logic is now in its own module.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/cameras\/thirdPerson.litcoffee","new_file":"src\/cameras\/thirdPerson.litcoffee","new_contents":"# thirdPerson\n\nA camera instance is an object containing:\n\n- transform: A transform matrix to apply this frame.\n- transformPreviousDraw: A transform matrix to apply the previous frame.\n\n    matrix = require \".\/..\/matrix.litcoffee\"\n    vector = require \".\/..\/vector.litcoffee\"\n    ik = require \".\/..\/ik.litcoffee\"\n    navmesh = require \".\/..\/navmesh.litcoffee\"\n    plane = require \".\/..\/plane.litcoffee\"\n    \n## create\n\n- A transform matrix to track.\n- A number specifying how far the camera should be from the target.\n- A number specifying how high above the target the camera should look.\n- A number specifying how high above the target the camera should be.\n- A number specifying how quickly the camera should move, where \"0\" is slowest\n  and \"1\" is fastest.\n- A number specifying how quickly the camera should track, where \"0\" is slowest\n  and \"1\" is fastest.\n\nReturns a new camera instance.\n\n    create = (transform, distance, viewHeight, targetHeight, moveLag, trackLag) ->\n        track: transform\n        transform: []\n        transformPreviousDraw: []\n        location: []\n        locationPreviousTick: []\n        target: []\n        targetPreviousTick: []\n        side: []\n        sidePreviousTick: []\n        distance: distance\n        viewHeight: viewHeight\n        targetHeight: targetHeight\n        moveLag: moveLag\n        trackLag: trackLag\n        firstTick: true\n        firstDraw: true\n\n## tick\n\n- A camera instance.\n- Optionally, a navmesh triangle to track from.  Used to prevent the camera\n  passing through the floor when going up ramps.\n- A number specifying how much gap to leave between the camera and the navmesh.\n\n    offset = []\n    upAxis = []\n    forwardAxis = []\n\n    tick = (cameraInstance, triangle, gap) ->\n        if not cameraInstance.firstTick\n            vector.copy cameraInstance.location, cameraInstance.locationPreviousTick\n            vector.copy cameraInstance.side, cameraInstance.sidePreviousTick\n            vector.copy cameraInstance.target, cameraInstance.targetPreviousTick\n    \n        matrix.getTranslation cameraInstance.track, cameraInstance.location\n        matrix.getX cameraInstance.track, cameraInstance.side\n        matrix.getY cameraInstance.track, upAxis\n        vector.multiply.byScalar upAxis, cameraInstance.targetHeight, offset\n        vector.add.vector cameraInstance.location, offset, cameraInstance.target\n        \n        vector.multiply.byScalar upAxis, cameraInstance.viewHeight, offset\n        vector.add.vector cameraInstance.location, offset, cameraInstance.location\n        \n        matrix.getZ cameraInstance.track, forwardAxis\n        vector.multiply.byScalar forwardAxis, cameraInstance.distance, offset\n        vector.subtract.vector cameraInstance.location, offset, cameraInstance.location\n        \n        if triangle\n            triangle = navmesh.constrain cameraInstance.location, triangle\n            altitude = (plane.distance triangle.plane, cameraInstance.location) - gap\n            if altitude < 0\n                vector.multiply.byScalar triangle.plane.normal, altitude, offset\n                vector.subtract.vector cameraInstance.location, offset, cameraInstance.location\n        \n        if cameraInstance.firstTick\n            vector.copy cameraInstance.location, cameraInstance.locationPreviousTick\n            vector.copy cameraInstance.side, cameraInstance.sidePreviousTick\n            vector.copy cameraInstance.target, cameraInstance.targetPreviousTick\n            cameraInstance.firstTick = false\n        else\n            vector.interpolate cameraInstance.locationPreviousTick, cameraInstance.location, cameraInstance.moveLag, cameraInstance.location\n            vector.interpolate cameraInstance.sidePreviousTick, cameraInstance.side, cameraInstance.moveLag, cameraInstance.side\n            vector.interpolate cameraInstance.targetPreviousTick, cameraInstance.target, cameraInstance.trackLag, cameraInstance.target\n        \n        return\n            \n## preDraw\n\n    location = []\n    target = []\n    side = []\n\n    preDraw = (cameraInstance, progress) ->\n        if not cameraInstance.firstDraw\n            matrix.copy cameraInstance.transform, cameraInstance.transformPreviousDraw\n        \n        vector.interpolate cameraInstance.locationPreviousTick, cameraInstance.location, progress, location\n        vector.interpolate cameraInstance.targetPreviousTick, cameraInstance.target, progress, target\n        vector.interpolate cameraInstance.sidePreviousTick, cameraInstance.side, progress, side\n        \n        ik.lookAt location, target, side, cameraInstance.transform\n        matrix.invert cameraInstance.transform, cameraInstance.transform\n        \n        if cameraInstance.firstDraw\n            matrix.copy cameraInstance.transform, cameraInstance.transformPreviousDraw\n            cameraInstance.firstDraw = false\n        return\n\n    module.exports = { create, tick, preDraw }","old_contents":"","returncode":1,"stderr":"error: pathspec 'src\/cameras\/thirdPerson.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d95efc8e4df163184a288e7b3bae6350cadd6450","subject":"Initial commit","message":"Initial commit\n\nreadme.litcoffee - a Literate CoffeeScript.","repos":"BioQL\/BioQL,BioQL\/BioQL","old_file":"src\/gql\/readme.litcoffee","new_file":"src\/gql\/readme.litcoffee","new_contents":"gQL\u00ae: An efficient Genome Query Language.\n-----------------------------------------\n[![Apache License](https:\/\/img.shields.io\/badge\/license-Apache-blue.svg)](https:\/\/github.com\/BioQL\/BioQL\/blob\/master\/LICENSE)\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'src\/gql\/readme.litcoffee' did not match any file(s) known to git\n","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"3d3dd18b29366e274ac673761f037496d0615e60","subject":"Nest angular properties","message":"Nest angular properties\n","repos":"Piot\/boardgamedb","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"eb8266b04c5c80d2a14300f30a60bfec778c4988","subject":"changed text in link to example gulpfile","message":"changed text in link to example gulpfile\n","repos":"curlee\/Appnostic","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/curlee\/Appnostic.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"58dd6c94697f4c831fab8445c020420b6a1cc989","subject":"Initial commit","message":"Initial commit\n\nreadme.litcoffee - a Literate CoffeeScript.","repos":"BioQL\/BioQL,BioQL\/BioQL","old_file":"src\/pql\/readme.litcoffee","new_file":"src\/pql\/readme.litcoffee","new_contents":"pQL\u00ae: An efficient Proteome Query Language.\n-------------------------------------------\n[![Apache License](https:\/\/img.shields.io\/badge\/license-Apache-blue.svg)](https:\/\/github.com\/BioQL\/BioQL\/blob\/master\/LICENSE)\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'src\/pql\/readme.litcoffee' did not match any file(s) known to git\n","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"09d708b2a6724ae816fddedf9ba45539a653dc22","subject":"Update game.litcoffee","message":"Update game.litcoffee","repos":"hansoksendahl\/twitterpated,hansoksendahl\/twitterpated","old_file":"src\/game.litcoffee","new_file":"src\/game.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/hansoksendahl\/twitterpated.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"74f4baf060c184db5126a4886832a42cc4fdfab7","subject":"Taking things literally with lists","message":"Taking things literally with lists\n","repos":"rjgotten\/canjs,rasjani\/canjs,Psykoral\/canjs,beno\/canjs,ackl\/canjs,shiftplanning\/canjs,ackl\/canjs,Psykoral\/canjs,tracer99\/canjs,beno\/canjs,patrick-steele-idem\/canjs,rasjani\/canjs,ackl\/canjs,asavoy\/canjs,UXsree\/canjs,dispatchrabbi\/canjs,rjgotten\/canjs,whitecolor\/canjs,gsmeets\/canjs,tracer99\/canjs,bitovi\/canjs,bitovi\/canjs,whitecolor\/canjs,rjgotten\/canjs,whitecolor\/canjs,rasjani\/canjs,patrick-steele-idem\/canjs,gsmeets\/canjs,shiftplanning\/canjs,rjgotten\/canjs,Psykoral\/canjs,Psykoral\/canjs,tracer99\/canjs,bitovi\/canjs,rasjani\/canjs,bitovi\/canjs,beno\/canjs,gsmeets\/canjs,UXsree\/canjs,asavoy\/canjs,patrick-steele-idem\/canjs,dispatchrabbi\/canjs","old_file":"list\/list.litcoffee","new_file":"list\/list.litcoffee","new_contents":"# can.List\n\n\tsteal \"can\/util\", \"can\/map\", (can, Map) ->\n\ncan.List takes care of creating observable lists.\n\n### Misc utilities\n\nWe'll use these later in the implementation of `can.List#splice` to\niron out cross-browser issues, hence why this is up here.\n\n\tsplice = [].splice\n\nWe test whether the browser's native `splice` method removes properties, or\nmerely changes `.length`. Our `can.List#splice` method will be adapted\naccordingly such that it *does* remove them. IE doesn't remove properties,\nspecifically, so we test for that.\n\n\tspliceRemovesProps = ->\n\t\tobj =\n\t\t\t0: \"a\"\n\t\t\tlength: 1\n\t\tsplice.call obj, 0, 1\n\t\tnot obj[0]\n\n## Main implementation\n\nHere we subclass `can.Map` to create our `List`. We will treat the `Map` as\nan array-like.\n\n\tclass list extends Map\n\n`Map` can be changes statically for new `can.List` classes\nto any subclass of `can.Map`. This controls what constructor\nto use when turning objects into `Map`s in the various\nrelevant `can.List` methods.\n\n\t@Map: Map\n\nAnd now we set up our constructor...\n\n\tconstructor: (instances = [], options) ->\n\nBy managing `.length`, we make this object an array-like.\n\n\t\t@length = 0;\n\nThe `cid` is used to namespace event handlers.\n\n\t\tcan.cid this, \".map\"\n\n`@_init` this instance as currently initializing.\n\n\t\t@_init = 1\n\nNow we check if `instances` is a promise because we have special behavior\nin that case...\n\n\t\tif can.isDeferred instances\n\nThe array passed into `new can.List()` can be a promise, in which case we\npass it straight to `can.List#replace()`. This will let us have a working\nlist, and automatically replace its contents when the promise resolves.\n\n\t\t\t@replace instances\n\t\telse\n\nIf our instances argument isn't a promise, we assume it's an array.\n\nThe `teardownMapping` is an implementation detail of `can.Map` used for\nmemory safety. Refer to can\/map for more details on how it works.\n\n\t\t\tteardownMapping = instances.length and can.Map.helpers.addToMap instances, this\n\nThen we `push` each individual element into our new `List`.\n\n\t\t\t@push.apply @, can.makeArray instances\n\nAnd here we use `teardownMapping` if the `can.Map` helper actually returned\none.\n\n\t\tteardownMapping() if teardownMapping\n\nWhenever a change event happens, we also take note of it in the\n`_changes()` method.\n\n\t\t@bind 'change', can.proxy @_changes, @\n\t\tcan.simpleExtend @, options\n\nNo longer initializing, soooo...\n\n\t\tdelete @_init\n\n### _triggerChange\n\n\t_triggerChange: (attr, how, newVal, oldVal) ->\n\nOn top of triggering the change event, we manually trigger `add`, `length`,\nand `remove` events manually, depending on `how`.\n\n\t\tMap::_triggerChange.apply @, arguments\n\nWe definitely do not trigger any `add`\/`remove` events ourselves that\ninvolve dots, so we skip this section in those cases (all of the triggers\nfor `can.List` itself are done on indices)\n\n\t\tif not ~attr.indexOf '.'\n\nIf a new item is added...\n\n\t\t\tif how is 'add'\n\n...trigger the two events, with newVal and the ndex as the values.\n\n\t\t\t\tcan.batch.trigger @, how, [newVal, +attr]\n\t\t\t\tcan.batch.trigger @, 'length', [this.length]\n\notherwise if an item is removed...\n\n\t\t\telse if how is 'remove'\n\nThen do the same, but using the old value (the item removed) in the\n`remove` event.\n\n\t\t\t\tcan.batch.trigger @, how, [oldVal, +attr]\n\t\t\t\tcan.batch.trigger @, 'length', [this.length]\n\t\t\t\t\nAnd just trigger anything else, whatever it is, because why not? As long as\nit has no dot, of course.\n\n\t\t\telse\n\t\t\t\tcan.batch.trigger @, how, [newVal, +attr)\n\n### __get\n\nThis overrides `can.Map`'s version of this method, which is meant to be used to implement the reading version of `attr()`, **after** dotted keys (`\"foo.bar.baz\"`) have already been split up.\n\n\t__get: (attr) -> if attr then this[attr] else @\n\n### ___set\n\nThis overrides `can.Map`'s version of this method, which does the final\ndata assignment to out `List` object.\n\n\t___set: (attr, val) ->\n\t\t@[attr] = val;\n\nnd we use it this way mainly to update the length of\nour array-like.\n\n\t\t@length = (+attr + 1) if (+attr >= @.length)\n\n### _each\n\nThe regular `can.Map` method provides a `for..in`-style\nloop, but this object is supposed to act like an array -- so\nwe treat it like one.\n\n\t_each: (callback) ->\n\t\tdata = @__get();\n\nNote how this method, unlike the native `Array#forEach`,\ncalls its callback on `undefined` for undefined array\nindices, which is more in like with `jQuery`'s `$.each`\nutility.\n\n\t\tcallback datum, i for datum, i in data\n\n### _bindsetup\n\nUsed by `can\/util\/bind` to set up live-binding.\n\n\t_bindsetup: Map.helpers.makeBindSetup(\"*\"),\n\t\n### serialize\n\nReturns the serialized form of this list (meaning, a regular `Array`, not\nJSON).\n\n\tserialize: -> Map.helpers.serialize @, 'serialize', []\n\n### splice\n\nWe write our own splice implementation to make sure arguments are properly\nconverted to observable objects and events are fired as planned.\n\n\tsplice: (index, howMany = @length - index) ->\n\t\targs = can.makeArray arguments\n\nArguments after the first two (`index`, `howMany`) are converted to `Map`s\n(or whatever the static `can.List.Map` configuration is) when\nappropriate. These new observables will also bubble their own events up to\nthe List, because of `hookupBubble`.\n\n\t\tfor val, i in args\n\t\t\tif i >= 2 and Map.helpers.canMakeObserve val\n\t\t\t\targs[i] = Map.helpers.hookupBubble val, \"*\", @, @.constructor.Map, @.constructor);\n\n\nWe call the native `splice` function here with our constructed\narguments. We will use `removed` to trigger appropriate removal events.\n\n\t\tremoved = splice.apply @, args\n\nSome browsers' splice methods do not actually delete properties, so we do\n it manually here. The test for whether this is necessary is at the top of\n the file.\n\n\t\tif not spliceRemovesProps\n\t\t\tfor thing, i in removed\n\t\t\t\tdelete @[i]\n\nWe batch the process of triggering `remove` and `add` events. On removal,\nwe also stop removed items from bubbling their events up to the `List`,\nwith `Map.helpers.unhookup`. Added items have already been given the\n`hookupBubble` treatment above, so we don't need to do it in here.\n\n\t\tcan.batch.start()\n\n\t\tif howMany > 0\n\t\t\t@_triggerChange \"\" + index, \"remove\", undefined, removed\n\t\t\tMap.helpers.unhookup removed, @\n\t\tif args.length > 2\n\t\t\t@_triggerChange \"\" + index, \"add\", args.slice(2), removed\n\n\t\tcan.batch.stop();\n\nTo reflect the API of the native `splice` method, we return a plain array\nof objects that were removed.\n\n\t\tremoved;\n\n### _attrs\n\n`_attrs()` implements part of the functionality of\n`can.List#attr()`. It is invoked in two situations:\n\n1. When `attr()` is called without any arguments\n\n2. When `attr()` is called with an array or array-like of values.\n\n\t_attrs: (items, remove) ->\n\nWhen invoked like `.attr()`, with no arguments, we simply return an `Array`\nversion of the list, recursively converted to regular JS objects.\n\n\t\tif items is undefined\n\t\t\tMap.helpers.serialize(this, 'attr', []);\n\nOtherwise, `items` is expected to be either an `Array` or an\n`Array`-like. From here, we will force `items` to be a proper `Array` copy\nof the original argument and call `_updateAttrs()` inside a batch to\nprevent event spam.\n\n\t\telse\n\t\t\titems = can.makeArray items\n\t\t\tcan.batch.start()\n\t\t\t@_updateAttrs items, remove\n\t\t\tcan.batch.stop()\n\n### _updateAttrs\n\nTODO\n\n\t_updateAttrs: function (items, remove) {\n\t\tvar len = Math.min(items.length, this.length);\n\n\t\tfor (var prop = 0; prop < len; prop++) {\n\t\t\tvar curVal = this[prop],\n\t\t\t\tnewVal = items[prop];\n\n\t\t\tif (Map.helpers.canMakeObserve(curVal) && Map.helpers.canMakeObserve(newVal)) {\n\t\t\t\tcurVal.attr(newVal, remove);\n\t\t\t\t\/\/changed from a coercion to an explicit\n\t\t\t} else if (curVal !== newVal) {\n\t\t\t\tthis._set(prop, newVal);\n\t\t\t} else {\n\n\t\t\t}\n\t\t}\n\t\tif (items.length > this.length) {\n\t\t\t\/\/ Add in the remaining props.\n\t\t\tthis.push.apply(this, items.slice(this.length));\n\t\t} else if (items.length < this.length && remove) {\n\t\t\tthis.splice(items.length);\n\t\t}\n\t}\n\n### indexOf\n\n\tindexOf: (item, fromIndex) ->\n\nWe force computes and helpers to watch out for length changes on this\n`can.List` if the `indexOf` method is used.\n\n\t\t@attr('length');\n\nBut otherwise, `can.List#indefOf()` works just like native, piggybacking on\nthe `can.inArray` utility from `can.util`.\n\n\t\tcan.inArray item, @, fromIndex\n\n### join\n\n`can.List#join()` is just like the native `Array#join()`, except we\n serialize to a regular array before calling the native method.`\n\n\tjoin: -> [].join.apply @attr(), arguments\n\t\n### reverse\n\nThe native `Array#reverse` method already does in-place reversing for us,\nso we just use that. Note that this method will not fire `set` events, as\ndoing the same thing manually with `attr()` usually would.\n\n\treverse: [].reverse,\n\n### slice\n\n\tslice: ->\n\nOur `slice()` is just a call to `Array#slice`...\n\n\t\ttemp = Array.prototype.slice.apply @, arguments\n\n... that returns an `List` of the same type as `this`.\n\n\t\tnew @constructor temp\n\n### concat\n\n\tconcat: ->\n\t\targs = []\n\nWe want to turn any `can.List` arguments into plain old `Array`s,\n\n\t\tfor arg, i in can.makeArray arguments\n\t\t\targs[i] = if arg instanceof can.List then arg.serialize() else arg\n\nso we can use the native `Array#concat` method for\nconcatenation, before turning the results into a new\n`can.List` with the same prototype as `this`.\n\n\t\tnew @constructor (Array.prototype.concat.apply @serialize(), args)\n\n### forEach\n\nWe delegate `List#forEach` to the cross-browser generic implementation in\n`can.util`.\n\n\tforEach: (cb, thisarg = @) -> can.each @, cb, thisarg\n\n### replace\n\nOur reimplementation of `Array#replace()` adds support for replacing with\nthe results of promi\u00f1ses, but otherwise works just like `List#splice()`.\n\n\treplace: (newList) ->\n\nIf `newList` is a promise, we queue a replacement with the promise's\nresult. Note that this method returns the current `List`, so if you want to\ntake any other action after the promise resolves, you'll need to do\n`.then()` on the promise externally, instead of using the returned value\nfrom this.\n\n\t\tif (can.isDeferred(newList)) {\n\t\t\tnewList.then(can.proxy(this.replace, this));\n\t\telse\n\nThis regular `List#splice()` call will replace all\nelements in the `List` and run all the usual event\nhookups that that method does.\n\n\t\t\tthis.splice.apply(this, [0, this.length].concat(can.makeArray(newList || [])));\n\nWe return the current `List`, even if a promise was passed in.\n\n\t\tthis;\n\n### getArgs\n\nConverts to an `array` of arguments.\n\n\tgetArgs = (args) ->\n\t\tif args[0] and can.isArray args[0]\n\t\t\targs[0]\n\t\telse\n\t\t\tcan.makeArray arg)\n\n### push, pop, shift, and unshift\n\nCreate `push`, `pop`, `shift`, and `unshift`\n\n\tobj =\n\t\tpush: \"length\"\n\t\tunshift: 0\n\nAdds a method `name` - The method name.\t `where` - Where items in the\n`array` should be added.\n\n\tfor where, name in obj\n\t\torig = [][name];\n\t\tlist::[name] = -> \n\nGet the items being added.\n\n\t\t\targs = []\n\nWhere we are going to add items.\n\n\t\t\tlen = if where then @length else 0\n\t\t\ti = arguments.length\n\nGo through and convert anything to an `map` that needs to be converted.\n\n\t\t\twhile (i--)\n\t\t\t\tval = arguments[i]\n\t\t\t\targs[i] = if Map.helpers.canMakeObserve val\n\t\t\t\t\tMap.helpers.hookupBubble val, \"*\", @, @constructor.Map, @constructor\n\t\t\t\telse\n\t\t\t\t\tval\n\nCall the original method.\n\n\t\t\tres = orig.apply(this, args);\n\n\t\t\tif not this.comparator or args.length\n\t\t\t\t@_triggerChange \"\" + len, \"add\", args, undefined\n\nAnd then return res\n\n\t\t\tres\n\nWe do the same thing for pop\/length:\n\n\tobj =\n\t\tpop: \"length\"\n\t\tshift: 0\n\nCreates a `remove` type method\n\n\tfor where, name in obj\n\t\tlist::[name] = ->\n\t\t\targs = getArgs arguments\n\t\t\tlen = if where and this.length then this.length - 1 else 0\n\n\t\t\tres = [][name].apply @, args\n\nCreate a change where the args are\n* `len` - Where these items were removed.\n* `remove` - Items removed.\n* `undefined` - The new values (there are none).\n* `res` - The old, removed values (should these be unbound).\n\n\t\t\t@_triggerChange \"\" + len, \"remove\", undefined, [res]\n\n\t\t\tif res and res.unbind\n\t\t\t\tcan.stopListening.call @, res, \"change\"\n\t\t\t\t\nand just return `res`\n\n\t\tres\n\n## The End\n\n\tcan.List = Map.List = list;\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'list\/list.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4705a7359cfc27384bf0e164ec4c41dd909366f0","subject":"initial commit","message":"initial commit\n","repos":"stephenhutchings\/written,stephenhutchings\/written","old_file":"underscore.strings.litcoffee","new_file":"underscore.strings.litcoffee","new_contents":"Do nothing without the presence of Underscore.\n\n    return unless _?\n\nThis regular expression includes words we won't capitalize.\n\n    noncapsWords = \/^(a|an|and|as|be|of|the|to)$\/\n\n...and this helps to split \"cased\" words into their constituent parts...\n\n    caseSplitter = \/[-_\\s]|(!?[A-Z][a-z]*)\/g\n\n...so we can join them together with some glue.\n\n    cleanJoin    = (arr, glue) -> _.compact(arr).join(glue)\n\nAssuming we are using the English language, we'll declare some numbers\n\n    numbers =\n      \"EN\": [\"one\", \"two\", \"three\", \"four\", \"five\", \"six\", \"seven\",\"eight\", \"nine\", \"ten\", \"eleven\", \"twelve\"]\n      \"FR\": [{m: \"un\", f: \"une\"}, \"deux\", \"trois\", \"quatre\", \"cinq\", \"six\", \"sept\", \"huit\", \"neuf\", \"dix\", \"onze\", \"douze\"]\n      \"DE\": [\"eins\", \"zwei\", \"drei\", \"vier\", \"f\u00fcnf\", \"sechs\", \"sieben\", \"acht\", \"neun\", \"zehn\", \"elf\", \"zw\u00f6lf\"]\n      \"IT\": [{m: \"uno\", f: \"una\"}, \"due\", \"tre\", \"quattro\", \"cinque\", \"sei\", \"sette\", \"otto\", \"nove\", \"dieci\", \"undici\", \"dodic\"]\n\nDeclare the mixins we're adding...\n\n    mixins =\n\nCapitalize the first letter of a string.\n\n      capitalize: (str) ->\n        str.charAt(0).toUpperCase() + str.slice(1)\n\nCapitalize all words in a string apart from some common lower case words.\n\n```coffee\n_.capitalizeAll(\"this and that\") # \"This and That\"\n```\n\n      capitalizeAll: (str, regEx = noncapsWords) ->\n        _.map(str.split(\" \"), (s, i) ->\n          if i > 0 and regEx.test(s) then s else _.capitalize(s)\n        ).join(\" \")\n\n\nTransform strings between common code cases:\n\n```coffee\n_.camelCase(\"some-thing\")  # \"someThing\"\n_.hyphenCase(\"some_thing\") # \"some-thing\"\n_.snakeCase(\"someThing\")   # \"some_thing\"\n_.humanCase(\"fromA_to-Z\")  # \"from A to Z\"\n```\n\n      camelCase: (str) ->\n        str.replace(\/[\\s_-](\\w)\/g, (a, w) -> w.toUpperCase())\n\n      hyphenCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \"-\").toLowerCase()\n\n      snakeCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \"_\").toLowerCase()\n\n      humanCase: (str) ->\n        cleanJoin(str.split(caseSplitter), \" \")\n\n\nEnclose a string inside an HTML tag.\n\n```coffee\n_.wrapInTag(\"Hello world!\", \"strong\") # \"<strong>Hello world!<\/strong>\"\n```\n\n      wrapInTag: (str, tag = \"span\") ->\n        \"<#{tag}>#{str}<\/#{tag}>\"\n\nGroup strings into a grammatically correct list with an arbitrary limit.\n\n```coffee\n_.prettyList([\"Ben\", \"Bob\"])                    # \"Ben and Bob\"\n_.prettyList([\"Ben\", \"Bob\", \"Bill\"])            # \"Ben, Bob and Bill\"\n_.prettyList([\"Ben\", \"Bob\", \"Bill\", \"Max\"], 2)  # \"Ben, Bob and 2 more\"\n_.prettyList([\"Ben\", \"Bob\"], 1, \"other\")        # \"Ben and 1 other\"\n```\n\n      prettyList: (arr, max, opts = {}) ->\n        more   = opts.more or \"more\"\n        amp    = opts.amp or \"and\"\n\n        if opts.wrap\n          arr = _.map(arr, (s) -> _.wrapInTag(s, opts.wrap))\n\n        if max < (len = arr.length)\n          diff = len - max\n          more = _.quantify(more, diff, false) if opts.quantify\n          diff = _.writtenNumber(diff, opts.numbers) if opts.written\n          arr  = arr.slice(0, max)\n          arr  = arr.concat(\"#{diff} #{more}\")\n\n        arr\n          .slice(0, -1)\n          .join(\", \")\n          .concat((if arr.length is 1 then \"\" else \" #{amp} \"), arr.slice(-1))\n\n\nAdd soft hyphens every `n` characters so that the CSS attribute\n`hyphens: manual` will allow for nice breaks in long strings of text.\n\n```coffee\n_.hyphenate(\"antidisestablishmentarianism\") # \"antidisest%C2%ADablishment%C2%ADarianism\"\n```\n\n      hyphenate: (str = \"\", n = 10, softHyphen = \"\\u00AD\") ->\n        str.replace new RegExp(\"\\\\w{#{n}}\", \"g\"), (w) -> w + softHyphen\n\n\nAdd an \"s\" to a string when an amount is non-singular, disregarding the\norder of the arguments passsed.\n\n```coffee\n_.prettyList(\"monkey\", 1)                   # \"1 monkey\"\n_.prettyList(1, \"monkey\")                   # \"1 monkey\"\n_.prettyList(\"monkey\", 9, written: true)    # \"nine monkeys\"\n```\n\n      quantify: (str, n, {numberless, written, lang}) ->\n        { n, str } = str: n, n: str unless _.isString(str)\n\n        _n = _.writtenNumber(n, lang) if written?\n\n        (if numberless? then \"\" else _n + \" \") +\n        str +\n        (if n is 1 then \"\" else \"s\")\n\nConvert numbers between one and twelve into their written counter-parts.\n\n```coffee\n_.writtenNumber(1)                          # \"one\"\n_.writtenNumber(2, [\"ein\", \"zwei\", \"drei\"]) # \"zwei\"\n```\n\n      writtenNumber: (n, lang = \"EN\", gender ?= \"m\") ->\n        if n < 13\n          num = numbers[lang][n - 1]\n          num[gender] and num[gender] or num\n        else\n          n\n\n      setNumbers: (arr, lang) ->\n        numbers[lang] = arr\n\nAdd the mixin object to Underscore.\n\n    _.mixin(mixins)\n","old_contents":"","returncode":128,"stderr":"fatal: invalid reference: FETCH_HEAD^\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"dc7940eeec733507e2dad4f410ceab1330d85a7d","subject":"Add docs for View lifecycle events","message":"Add docs for View lifecycle events\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/13a_view_lifecycle.litcoffee","new_file":"docs\/13a_view_lifecycle.litcoffee","new_contents":"# \/api\/App Components\/Batman.View\/Batman.View Lifecycle\n\nWhen [`Batman.View`](\/docs\/api\/batman.view.html) is rendered, it goes through many steps. Lifecycle callbacks allow you to hook into those steps and control or respond to the rendering process.\n\n### Listening for Lifecycle Events\n\nTo set up handlers for a `View`'s lifecycle, You can either call [`on`](\/docs\/api\/batman.eventemitter.html#prototype_function_on) on the `View`'s  prototype:\n\n```coffeescript\nclass MyApp.FadingView extends Batman.View\n  @::on 'viewWillAppear', -> $(@get('node')).hide()\n\n  @::on 'viewDidAppear', -> $(@get('node')).fadeIn('fast')\n\n  @::on 'viewWillDisappear', -> $(@get('node')).fadeOut('fast')\n```\n\nor define functions with the same name as the events:\n\n```coffeescript\nclass MyApp.FadingView extends Batman.View\n  viewWillAppear: -> $(@get('node')).hide()\n\n  viewDidAppear: -> $(@get('node')).fadeIn('fast')\n\n  viewWillDisappear: -> $(@get('node')).fadeOut('fast')\n```\n\n### Lifecycle Events and Subviews\n\nA `View` propagates its lifecycle events to its [`subviews`](\/docs\/api\/batman.view.html#prototype_property_subviews), so it's likely that a lifecycle event will be called more than once. `ready` is an exception -- it's a one-shot event.\n\n## viewWillAppear\n\nThe view is about to be attached to the DOM. It has a [`superview`](\/docs\/api\/batman.view.html#prototype_property_superview).\n\n## viewDidAppear\n\nThe view has just been attached to the DOM. Its [`node`](\/docs\/api\/batman.view.html#prototype_accessor_node) is on the page and can be selected with `document.querySelector`.\n\n## viewDidLoad\n\nThe view's [`node`](\/docs\/api\/batman.view.html#prototype_accessor_node) has been loaded from its [`html`](\/docs\/api\/batman.view.html#prototype_accessor_html)). It may not be in the DOM yet.\n\n## ready\n\nThe view's bindings have been initialized. The view may or may not be in the DOM. `ready` is a one-shot event.\n\n## viewWillDisappear\n\nThe view is about to be detached from the DOM. It still has a [`superview`](\/docs\/api\/batman.view.html#prototype_property_superview) and its [`node`](\/docs\/api\/batman.view.html#prototype_accessor_node) is still selectable.\n\n## viewDidDisappear\n\nThe view has been detached from the DOM. It still has a [`superview`](\/docs\/api\/batman.view.html#prototype_property_superview) but its [`node`](\/docs\/api\/batman.view.html#prototype_accessor_node) is not selectable.\n\n## destroy\n\n[`die`](\/docs\/api\/batman.view.html#prototype_function_die) was called on this view. It will be removed from its superview, removed from the DOM, and have all of its properties set to `null`.\n\n## viewDidMoveToSuperview\n\nThe view has been attached to its [`superview`](\/docs\/api\/batman.view.html#prototype_property_superview), but it is not yet in the DOM.\n\n## viewWillRemoveFromSuperview\n\nThe view is about removed from its [`superview`](\/docs\/api\/batman.view.html#prototype_property_superview), then it will be detached from the DOM.\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'docs\/13a_view_lifecycle.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"92ad6b002b95db995291fbf95b3e6af75385badd","subject":"Add partials task","message":"Add partials task\n","repos":"Piot\/boardgamedb","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6f6baae90ddd9cb42a9b260f9b4c390b223a7dca","subject":"Added a new png renderer, PngRoof, to render block roof segments","message":"Added a new png renderer, PngRoof, to render block roof segments\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_roof.litcoffee","new_file":"lib\/render-pipelines\/png\/png_roof.litcoffee","new_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngRoof extends PngRenderer\n\n      do_render: (ctx, path) =>\n        cell_width  = @config.width\n        cell_height = @config.height\n\n        ground_segments = @config.ground.segments\n        segment_width   = 1 \/ ground_segments\n        ground_width    = cell_width * segment_width\n\n        fill_segment = (block, segment, height, color) =>\n          right  = segment * (cell_width * segment_width)\n          left   = (cell_width * block.x) + right\n          top    = (cell_height * block.y)\n\n          ctx.fillStyle = color\n\n          ctx.beginPath()\n          ctx.rect left, top, ground_width, height\n          ctx.fill()\n\n        for step in path\n          if step.roof?\n            for f, i in step.roof\n              fill_segment step, i, f.thickness, 'red' if f?\n\n    module.exports = PngRoof\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'lib\/render-pipelines\/png\/png_roof.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"98a2225a44af11ab465f07ca1c9dabc82b8edaa9","subject":"Published with https:\/\/stackedit.io\/","message":"Published with https:\/\/stackedit.io\/","repos":"candril\/tavola","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/candril\/tavola.git\/'\n","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"439d1c82e7915184ff41d4047611e513d67ba323","subject":"Add png_platforms renderer","message":"Add png_platforms renderer\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_platforms.litcoffee","new_file":"lib\/render-pipelines\/png\/png_platforms.litcoffee","new_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngPlatforms extends PngRenderer\n\n      do_render: (ctx, path) =>\n        cell_width  = @config.width\n        cell_height = @config.height\n\n        ground_segments = @config.ground.segments\n        wall_segments   = @config.wall.segments\n\n        segment_width  = 1 \/ ground_segments\n        segment_height = 1 \/ wall_segments\n\n        ground_width = cell_width  * segment_width\n        wall_height  = cell_height * segment_height\n\n        fill_segment = (block, platform, color) =>\n          for p in platform\n            height =  p.thickness * wall_height\n            left   = (cell_width  * block.x) + (p.x * ground_width)\n            top    = (cell_height * block.y) + (p.y * wall_height) - height\n\n            ctx.fillStyle = color\n\n            ctx.beginPath()\n            ctx.rect left, top, ground_width, height\n            ctx.fill()\n\n        for block, i in path\n          for p in block.platforms\n            fill_segment block, p, 'blue'\n\n    module.exports = PngPlatforms\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'lib\/render-pipelines\/png\/png_platforms.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"220ea3ac111a898934cd83d2ad8a279cf1bf9657","subject":"\tnew file:   client\/models\/settings.litcoffee","message":"\tnew file:   client\/models\/settings.litcoffee\n","repos":"ai10\/radioscope-lnr","old_file":"client\/models\/settings.litcoffee","new_file":"client\/models\/settings.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/ai10\/radioscope-lnr.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"77b3bb797499b746d838d2e37fdb1cd58829daec","subject":"Recompile when elements src is changed","message":"Recompile when elements src is changed\n","repos":"Piot\/boardgamedb","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b367d544cf2fc50686f66bffb1c09465ce613804","subject":"Add new delegates file","message":"Add new delegates file\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/delegates.litcoffee","new_file":"lib\/delegates.litcoffee","new_contents":"    randomIn = (r) => Math.random() * (r.max - r.min) + r.min\n\n    roundedRandomIn = (r) => Math.round randomIn r\n\n    render_cube = ({ x, y, width, height }) ->\n      left   = [ ]\n      top    = [ ]\n      right  = [ ]\n      bottom = [ ]\n      front  = [ ]\n      back   = [ ]\n\n      left.push [ x, y,          0 ]\n      left.push [ x, y + height, 0 ]\n      left.push [ x, y + height, 1 ]\n      left.push [ x, y + height, 1 ]\n      left.push [ x, y,          1 ]\n      left.push [ x, y,          0 ]\n\n      top.push [ x,         y + height, 0 ]\n      top.push [ x + width, y + height, 0 ]\n      top.push [ x + width, y + height, 1 ]\n      top.push [ x + width, y + height, 1 ]\n      top.push [ x,         y + height, 1 ]\n      top.push [ x,         y + height, 0 ]\n\n      right.push [ x + width, y + height, 0 ]\n      right.push [ x + width, y,          0 ]\n      right.push [ x + width, y,          1 ]\n      right.push [ x + width, y,          1 ]\n      right.push [ x + width, y + height, 1 ]\n      right.push [ x + width, y + height, 0 ]\n\n      bottom.push [ x + width, y, 0 ]\n      bottom.push [ x,         y, 0 ]\n      bottom.push [ x,         y, 1 ]\n      bottom.push [ x,         y, 1 ]\n      bottom.push [ x + width, y, 1 ]\n      bottom.push [ x + width, y, 0 ]\n\n      front.push [ x,         y,          1 ]\n      front.push [ x,         y + height, 1 ]\n      front.push [ x + width, y + height, 1 ]\n      front.push [ x + width, y + height, 1 ]\n      front.push [ x + width, y,          1 ]\n      front.push [ x,         y,          1 ]\n\n      back.push [ x,         y,          0 ]\n      back.push [ x + width, y,          0 ]\n      back.push [ x + width, y + height, 0 ]\n      back.push [ x + width, y + height, 0 ]\n      back.push [ x,         y + height, 0 ]\n      back.push [ x,         y,          0 ]\n\n      { left, top, right, bottom, front, back }\n\n    render_pass = (i, x, y, wdth, step, faces) ->\n      args =\n        x:      x + ((i + 1) * wdth)\n        y:      y\n        width:  wdth\n        height: step * (i + 1)\n\n      cube = render_cube args\n      keys = Object.keys faces\n\n      for k in keys\n        for f in cube[k]\n          faces[k].push f\n\n    delegates =\n      ground:    ({ x, y, width, height }) -> render_cube { x, y, width, height }\n      stairs_up: ({ x, y, width, height }) ->\n        faces =\n          left:   [ ]\n          top:    [ ]\n          right:  [ ]\n          bottom: [ ]\n          front:  [ ]\n          back:   [ ]\n\n        max = Math.ceil width \/ height\n        min = Math.ceil max   \/ 2\n\n        wdth      = Math.ceil width \/ max\n        step      = roundedRandomIn { min, max }\n        remainder = width % wdth\n\n        iterations = Math.floor width \/ wdth\n        i          = 0\n\n        while i < iterations\n          render_pass i, x, y, wdth, step, faces\n          ++i\n\n        if remainder > 0\n          render_pass i, x, y, remainder, step, faces\n\n        faces\n\n    module.exports = delegates\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'lib\/delegates.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"bc8b67e01aed277f12538cd81ddb2d89db252850","subject":"fix typo","message":"fix typo\n","repos":"Piot\/boardgamedb","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4c7c12ba0ba119a4e7cc61cbede542d83b85096d","subject":"Add literation","message":"Add literation\n","repos":"Piot\/boardgamedb","old_file":"app\/app.litcoffee","new_file":"app\/app.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"739483e896a27325472afcc17f483d1fe657206f","subject":"Remove redundant code","message":"Remove redundant code\n","repos":"Piot\/boardgamedb","old_file":"src\/app\/app.litcoffee","new_file":"src\/app\/app.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"19d2e8893d3126320cfe8aef733e30dee04d819c","subject":"Add guard","message":"Add guard\n","repos":"Piot\/boardgamedb","old_file":"elements\/game\/main\/game-main.litcoffee","new_file":"elements\/game\/main\/game-main.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"c9feb6cd6c9d82a1e510ee99530fd3f47aaf926d","subject":"Published with https:\/\/stackedit.io\/","message":"Published with https:\/\/stackedit.io\/","repos":"candril\/tavola","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/candril\/tavola.git\/'\n","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"ae095f4dfcdd99f6fe0c07c0cd70ddb279c09623","subject":"[Character; minor] Fixed a GFM table (hopefully)","message":"[Character; minor] Fixed a GFM table (hopefully)\n","repos":"marrus-sh\/jelli","old_file":"source\/engine\/07 Character.litcoffee","new_file":"source\/engine\/07 Character.litcoffee","new_contents":"","old_contents":"","returncode":1,"stderr":"error: pathspec 'source\/engine\/07' did not match any file(s) known to git\nerror: pathspec 'Character.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6ea3f7d2d0cb1ffb5c66222b0593c8081c612569","subject":"Listen for change event and delegate to controller","message":"Listen for change event and delegate to controller\n","repos":"Piot\/boardgamedb","old_file":"elements\/game\/main\/game-main.litcoffee","new_file":"elements\/game\/main\/game-main.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4f9616cc0420d76b9db475d0153441f0c34b003f","subject":"Add simple style task","message":"Add simple style task\n","repos":"Piot\/boardgamedb","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fe29b3ddbe0160c92c4d50a040d3dd0b6989e803","subject":"removed gulp minify css","message":"removed gulp minify css\n","repos":"curlee\/Appnostic","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/curlee\/Appnostic.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"462497dfd9bd96ce75a92e05782f9cf33a675703","subject":"Initial commit","message":"Initial commit\n\nreadme.litcoffee, a Literate CoffeeScript.","repos":"BioQL\/BioQL,BioQL\/BioQL","old_file":"src\/readme.litcoffee","new_file":"src\/readme.litcoffee","new_contents":"BioQL<sup>\u00ae<\/sup> [![Apache License](https:\/\/img.shields.io\/badge\/license-Apache-blue.svg)](https:\/\/github.com\/BioQL\/BioQL\/blob\/master\/LICENSE)\n------\n> An efficient Query Language for interpreting genome and proteome.\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'src\/readme.litcoffee' did not match any file(s) known to git\n","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"2e87615c4e12ea571aad8b93894b2843b967c603","subject":"See #18. Add example Literate CoffeeScript file.","message":"See #18. Add example Literate CoffeeScript file.\n","repos":"Glavin001\/atom-preview,Glavin001\/atom-preview,zuren\/atom-preview,zuren\/atom-preview,Glavin001\/atom-preview,zuren\/atom-preview,lasaro-dumer\/atom-preview,lasaro-dumer\/atom-preview,lasaro-dumer\/atom-preview","old_file":"spec\/samples\/scope.litcoffee","new_file":"spec\/samples\/scope.litcoffee","new_contents":"The **Scope** class regulates lexical scoping within CoffeeScript. As you\ngenerate code, you create a tree of scopes in the same shape as the nested\nfunction bodies. Each scope knows about the variables declared within it,\nand has a reference to its parent enclosing scope. In this way, we know which\nvariables are new and need to be declared with `var`, and which are shared\nwith external scopes.\n\nImport the helpers we plan to use.\n\n    {extend, last} = require '.\/helpers'\n\n    exports.Scope = class Scope\n\nThe `root` is the top-level **Scope** object for a given file.\n\n      @root: null\n\nInitialize a scope with its parent, for lookups up the chain,\nas well as a reference to the **Block** node it belongs to, which is\nwhere it should declare its variables, and a reference to the function that\nit belongs to.\n\n      constructor: (@parent, @expressions, @method) ->\n        @variables = [{name: 'arguments', type: 'arguments'}]\n        @positions = {}\n        Scope.root = this unless @parent\n\nAdds a new variable or overrides an existing one.\n\n      add: (name, type, immediate) ->\n        return @parent.add name, type, immediate if @shared and not immediate\n        if Object::hasOwnProperty.call @positions, name\n          @variables[@positions[name]].type = type\n        else\n          @positions[name] = @variables.push({name, type}) - 1\n\nWhen `super` is called, we need to find the name of the current method we're\nin, so that we know how to invoke the same method of the parent class. This\ncan get complicated if super is being called from an inner function.\n`namedMethod` will walk up the scope tree until it either finds the first\nfunction object that has a name filled in, or bottoms out.\n\n      namedMethod: ->\n        return @method if @method?.name or !@parent\n        @parent.namedMethod()\n\nLook up a variable name in lexical scope, and declare it if it does not\nalready exist.\n\n      find: (name) ->\n        return yes if @check name\n        @add name, 'var'\n        no\n\nReserve a variable name as originating from a function parameter for this\nscope. No `var` required for internal references.\n\n      parameter: (name) ->\n        return if @shared and @parent.check name, yes\n        @add name, 'param'\n\nJust check to see if a variable has already been declared, without reserving,\nwalks up to the root scope.\n\n      check: (name) ->\n        !!(@type(name) or @parent?.check(name))\n\nGenerate a temporary variable name at the given index.\n\n      temporary: (name, index) ->\n        if name.length > 1\n          '_' + name + if index > 1 then index - 1 else ''\n        else\n          '_' + (index + parseInt name, 36).toString(36).replace \/\\d\/g, 'a'\n\nGets the type of a variable.\n\n      type: (name) ->\n        return v.type for v in @variables when v.name is name\n        null\n\nIf we need to store an intermediate result, find an available name for a\ncompiler-generated variable. `_var`, `_var2`, and so on...\n\n      freeVariable: (name, reserve=true) ->\n        index = 0\n        index++ while @check((temp = @temporary name, index))\n        @add temp, 'var', yes if reserve\n        temp\n\nEnsure that an assignment is made at the top of this scope\n(or at the top-level scope, if requested).\n\n      assign: (name, value) ->\n        @add name, {value, assigned: yes}, yes\n        @hasAssignments = yes\n\nDoes this scope have any declared variables?\n\n      hasDeclarations: ->\n        !!@declaredVariables().length\n\nReturn the list of variables first declared in this scope.\n\n      declaredVariables: ->\n        realVars = []\n        tempVars = []\n        for v in @variables when v.type is 'var'\n          (if v.name.charAt(0) is '_' then tempVars else realVars).push v.name\n        realVars.sort().concat tempVars.sort()\n\nReturn the list of assignments that are supposed to be made at the top\nof this scope.\n\n      assignedVariables: ->\n        \"#{v.name} = #{v.type.value}\" for v in @variables when v.type.assigned\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'spec\/samples\/scope.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"832ec347e54f9b5a7c9ad1ddde2b4cdfcf7fd1f8","subject":"Watch css files","message":"Watch css files\n","repos":"Piot\/boardgamedb","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b08dcc22f885ec5962ff21328c37a4f7ac946f42","subject":"minor documentation update on restjson","message":"minor documentation update on restjson\n","repos":"corenova\/yang-forge,saintkepha\/yangjs,LiuJinliang\/yangforge,saintkepha\/yangforge,opnfv\/yangforge","old_file":"src\/features\/restjson.litcoffee","new_file":"src\/features\/restjson.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/LiuJinliang\/yangforge.git\/'\n","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"2395e244024e46e3ebdc8bdfd33c1f9be52308b3","subject":"Literate CofeeScript underway","message":"Literate CofeeScript underway\n","repos":"funjs\/friebyrd","old_file":"lib\/friebyrd.litcoffee","new_file":"lib\/friebyrd.litcoffee","new_contents":"((root) ->\n  root = this\n  _ = root._ || require 'underscore'\n  F = {}\n\n  # Non-determinism\n  # ---------------\n\n  F.succeed = (result) -> [result]\n  F.fail = _.always []\n\n  disjunction = (l, r) ->\n    (x) -> _.cat(l(x), r(x))\n  conjunction = (l, r) ->\n    (x) -> _.mapcat(l(x), r)\n\n  F.disj = () ->\n    return F.fail if _.isEmpty(arguments)\n    disjunction(_.first(arguments), F.disj.apply(this, _.rest(arguments)))\n\n  F.conj = () ->\n    clauses = _.toArray(arguments)\n    return F.succeed if _.isEmpty(clauses)\n    return _.first(clauses) if _.size(clauses) is 1\n    conjunction(_.first(clauses),\n                (s) -> F.conj.apply(null, _.rest(clauses))(s))\n\n  # Knowledge representation\n  # ------------------------\n\n  class LVar\n    constructor: (@name) ->\n\n  F.lvar = (name) -> new LVar(name)\n  F.isLVar = (v) -> (v instanceof LVar)\n\n  find = (v, bindings) ->\n    lvar = bindings.lookup(v)\n    return lvar if F.isLVar(v)\n    if _.isArray(lvar)\n      if _.isEmpty(lvar)\n        return lvar\n      else\n        return _.cons(find(_.first(lvar), bindings), find(_.rest(lvar), bindings))\n    lvar\n\n  class Bindings\n    constructor: (seed = {}) ->\n      @binds = _.merge({}, seed)\n    extend: (lvar, value) ->\n      o = {}\n      o[lvar.name] = value\n      new Bindings(_.merge(@binds, o))\n    has: (lvar) ->\n      @binds.hasOwnProperty(lvar.name)\n    lookup: (lvar) ->\n      return lvar if !F.isLVar(lvar)\n      return this.lookup(@binds[lvar.name]) if this.has(lvar)\n      lvar\n\n  F.ignorance = new Bindings()\n\n  # Unification\n  # -----------\n\n  F.unify = (l, r, bindings) ->\n    t1 = bindings.lookup(l)\n    t2 = bindings.lookup(r)\n\n    if _.isEqual(t1, t2)\n      return s\n    if F.isLVar(t1)\n      return bindings.extend(t1, t2)\n    if F.isLVar(t2)\n      return bindings.extend(t2, t1)\n    if _.isArray(t1) && _.isArray(t2)\n      s = F.unify(_.first(t1), _.first(t2), bindings)\n      s = if (s isnt null) then F.unify(_.rest(t1), _.rest(t2), bindings) else s\n      return s\n    return null\n\n  # Operational logic\n  # -----------------\n\n  F.goal = (l, r) ->\n    (bindings) ->\n      result = F.unify(l, r, bindings)\n      return F.succeed(result) if result isnt null\n      return F.fail(bindings)\n\n  F.run = (goal) ->\n    goal(F.ignorance)\n\n  # Logico\n  # ------\n\n  F.choice = ($v, list) ->\n    return F.fail if _.isEmpty(list)\n\n    F.disj(F.goal($v, _.first(list)),\n                  F.choice($v, _.rest(list)))\n\n  # Exports and sundries\n  # --------------------\n\n  if module?\n    module.exports = F\n  else\n    root.F = F\n\n)(this)\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'lib\/friebyrd.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f1c2f3997db069b7cda72e73a689d344070c510f","subject":"Update game.litcoffee","message":"Update game.litcoffee","repos":"hansoksendahl\/twitterpated,hansoksendahl\/twitterpated","old_file":"src\/game.litcoffee","new_file":"src\/game.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/hansoksendahl\/twitterpated.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fd47920c63ac98e1bd18ad212ef4fbe01bdb2570","subject":"Fixes tabbed code test in literate","message":"Fixes tabbed code test in literate\n","repos":"abbshr\/coffeescript,jamesknelson\/coffee-script,maxtaco\/coffee-script,aslihandincer\/coffeescript,Infowatch\/coffee-script,wangyue-ramy\/coffeescript,jokerhing\/coffeescript,jjoos\/coffee-script,pagreczner\/express-coffee,Geoion\/coffee-script,connec\/coffeescript,charlieflowers\/coffee-script,helixbass\/copheescript,DoriKal\/coffeescript,will-weiss\/coffeescript,jjoos\/coffee-script,youleiy\/coffee-script,FrancoCotter\/coffeescript,kyroskoh\/coffee-script,shihang0001\/coffee-script,EmielM\/blackcoffee,behind2\/coffee-script,sombr\/coffeescript,coffee-void\/coffeescript,maxtaco\/coffee-script,GabrielRatener\/coffeescript-next,maowug\/coffeescript,shimaore\/cake,mrmowgli\/coffeescript,decaffeinate\/coffeescript,protez\/coffee-script,MartyIX\/coffeescript-to-typescript,jiangmiao\/toffee-script,sombr\/coffeescript,stanly-johnson\/coffeescript,ls2uper\/coffeescript,alubbe\/coffee-script,sebmck\/coffee-script,helixbass\/copheescript,mikeyhew\/coffeescript-await-transform,Kingson4Wu\/coffee-script,coffee-js\/coffee-script,beni55\/coffee-script,davidbau\/coffee-script,youleiy\/coffee-script,alxarch\/coffeescript,helixbass\/copheescript,sidthekidder\/coffee-script,will-weiss\/coffeescript,jobedom\/coffee-script,casidiablo\/coffeescript,Infowatch\/coffee-script,lieuwex\/coffeescript-to-typescript,jjoos\/coffee-script,shihang0001\/coffee-script,alxarch\/coffeescript,kittens\/coffee-script,kidaa\/coffeescript,behind2\/coffee-script,lieuwex\/coffeescript-to-typescript,schory\/coffee-script,longjl\/coffeescript,maowug\/coffeescript,EmielM\/blackcoffee,casidiablo\/coffeescript,mekuriam\/coffeescript,Geoion\/coffee-script,yjerem\/coffee-script,lbeschastny\/coffeescript,ASnow\/coffeescript,jokerhing\/coffeescript,coffee-js\/coffee-script,abbshr\/coffeescript,princejwesley\/coffeescript,legokichi\/typecoffee,hgGeorg\/coffee-script,davidbau\/coffee-script,TobiaszCudnik\/coffeescript-to-typescript,angeliaz\/coffeescript,sidthekidder\/coffee-script,bobcassels\/pencil-coffee-script,shimaore\/cake,bobcassels\/pencil-coffee-script,TobiaszCudnik\/coffeescript-to-typescript,angeliaz\/coffeescript,SonOfLilit\/coffeescript,DylanPiercey\/coffeescript,lydell\/coffee-script,tempbottle\/coffeescript,yjerem\/coffee-script,chaosim\/coffee-script,ls2uper\/coffeescript,protez\/coffee-script,jiangmiao\/toffee-script,wangyue-ramy\/coffeescript,tvanderbruggen\/coffeescript,jashkenas\/coffeescript,PencilCode\/pencil-coffee-script,rev22\/reflective-coffeescript,chaosim\/coffee-script,jobedom\/coffee-script,connec\/coffeescript,cosmicexplorer\/coffeescript,jamesknelson\/coffee-script,lydell\/coffee-script,tvanderbruggen\/coffeescript,TobiaszCudnik\/coffeescript-to-typescript,mekuriam\/coffeescript,beni55\/coffee-script,hgGeorg\/coffee-script,GabrielRatener\/coffeescript-next,akavi\/CoffeeAF,DoriKal\/coffeescript,DylanPiercey\/coffeescript,SonOfLilit\/coffeescript,tempbottle\/coffeescript,lbeschastny\/coffeescript,shreeve\/coffeescript,sqlwwx\/coffeescript-zh,kidaa\/coffeescript,MartyIX\/coffeescript-to-typescript,pagreczner\/express-coffee,princejwesley\/coffeescript,sqlwwx\/coffeescript-zh,charlieflowers\/coffee-script,tonghuashuai\/coffee-script,kyroskoh\/coffee-script,sebmck\/coffee-script,AndersonFirmino\/coffeescript,rev22\/reflective-coffeescript,xixixao\/coffee-script,alubbe\/coffee-script,292388900\/coffee-script,tonghuashuai\/coffee-script,ASnow\/coffeescript,schory\/coffee-script,292388900\/coffee-script,aslihandincer\/coffeescript,jiangmiao\/toffee-script,paiq\/blackcoffee,mikeyhew\/coffeescript-await-transform,coffee-void\/coffeescript,helixbass\/copheescript,guzhaoyuan\/coffee-script,sjbarag\/coffeescript,Kingson4Wu\/coffee-script,kittens\/coffee-script,kannannilakantaayyar\/coffeescript,longjl\/coffeescript,stanly-johnson\/coffeescript,ardha2008\/coffeescript,kannannilakantaayyar\/coffeescript,flaing\/coffeescript,GabrielRatener\/coffeescript-next,guzhaoyuan\/coffee-script,ardha2008\/coffeescript,FrancoCotter\/coffeescript,AndersonFirmino\/coffeescript,legokichi\/typecoffee,PencilCode\/pencil-coffee-script","old_file":"test\/literate.litcoffee","new_file":"test\/literate.litcoffee","new_contents":"Literate CoffeeScript Test\n--------------------------\n\ncomment comment\n\n    test \"basic literate CoffeeScript parsing\", ->\n      ok yes\n      \nnow with a...\n  \n    test \"broken up indentation\", ->\n    \n... broken up ...\n\n      do ->\n      \n... nested block.\n\n        ok yes\n\nCode must be separated from text by a blank line.\n\n    test \"code blocks must be preceded by a blank line\", ->\n\nThe next line is part of the text and will not be executed.\n      fail()\n\n      ok yes        \n        \nCode in `backticks is not parsed` and...\n\n    test \"comments in indented blocks work\", ->\n      do ->\n        do ->\n          # Regular comment.\n          \n          ###\n            Block comment.\n          ###\n          \n          ok yes\n          \nRegular [Markdown](http:\/\/example.com\/markdown) features, like links \nand unordered lists, are fine:\n\n  * I \n  \n  * Am\n  \n  * A\n  \n  * List\n\nTabs work too:\n\n\t\t\t\ttest \"tabbed code\", ->\n\t\t\t\t\tok yes\n","old_contents":"Literate CoffeeScript Test\n--------------------------\n\ncomment comment\n\n    test \"basic literate CoffeeScript parsing\", ->\n      ok yes\n      \nnow with a...\n  \n    test \"broken up indentation\", ->\n    \n... broken up ...\n\n      do ->\n      \n... nested block.\n\n        ok yes\n\nCode must be separated from text by a blank line.\n\n    test \"code blocks must be preceded by a blank line\", ->\n\nThe next line is part of the text and will not be executed.\n      fail()\n\n      ok yes        \n        \nCode in `backticks is not parsed` and...\n\n    test \"comments in indented blocks work\", ->\n      do ->\n        do ->\n          # Regular comment.\n          \n          ###\n            Block comment.\n          ###\n          \n          ok yes\n          \nRegular [Markdown](http:\/\/example.com\/markdown) features, like links \nand unordered lists, are fine:\n\n  * I \n  \n  * Am\n  \n  * A\n  \n  * List\n\nTabs work too:\n\n\ttest \"tabbed code\", ->\n\t\tok yes\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"accb0b8968dd994b047cad58f8458c78c2684ca0","subject":"Created a new \"file\" module as part of #13.","message":"Created a new \"file\" module as part of #13.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator","old_file":"src\/file.litcoffee","new_file":"src\/file.litcoffee","new_contents":"# file\n\nThis is a module which abstracts reading files.  It should be used when they are\nimpractical to embed into the JavaScript.\n\nWhile at present this performs AJAX, this module could be replaced to access\nlocal files for non-web distribution.\n\n    handleError = require \".\/handleError.litcoffee\"\n\n## arrayBuffer\n\n- filename: The \"real\" location of the binary file to load.  (i.e. already \n            \"require\"-d)\n- callback: A callback to execute with the ArrayBuffer loaded from the file on\n            success.\n            \n    arrayBuffer = (path, callback) ->\n        request = new XMLHttpRequest()\n        request.open \"GET\", path, true\n        request.responseType = \"arraybuffer\"\n        request.onreadystatechange = ->\n            if request.readyState is 4\n                if request.status is 200                   \n                    callback request.response\n                else\n                    handleError \"Failed to load binary file \" + path\n            return\n        request.send null\n        return\n\n    module.exports = { arrayBuffer }","old_contents":"","returncode":1,"stderr":"error: pathspec 'src\/file.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"996c45761e45e6d21ff8dfd85552b690a31ed001","subject":"Dont concat for now, also remove lint","message":"Dont concat for now, also remove lint\n","repos":"Piot\/boardgamedb","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"44c2b4aa7fd47ea3822c1612d5a661c313003947","subject":"Test case for literal mode: Code blocks must be preceded by blank line.","message":"Test case for literal mode: Code blocks must be preceded by blank line.\n","repos":"aslihandincer\/coffeescript,rev22\/reflective-coffeescript,sidthekidder\/coffee-script,Kingson4Wu\/coffee-script,tvanderbruggen\/coffeescript,tvanderbruggen\/coffeescript,ardha2008\/coffeescript,shihang0001\/coffee-script,MartyIX\/coffeescript-to-typescript,connec\/coffeescript,jiangmiao\/toffee-script,casidiablo\/coffeescript,legokichi\/typecoffee,kyroskoh\/coffee-script,schory\/coffee-script,ls2uper\/coffeescript,kyroskoh\/coffee-script,sombr\/coffeescript,jokerhing\/coffeescript,guzhaoyuan\/coffee-script,beni55\/coffee-script,aslihandincer\/coffeescript,schory\/coffee-script,sjbarag\/coffeescript,maxtaco\/coffee-script,jjoos\/coffee-script,longjl\/coffeescript,coffee-void\/coffeescript,kittens\/coffee-script,sidthekidder\/coffee-script,jiangmiao\/toffee-script,maowug\/coffeescript,behind2\/coffee-script,sebmck\/coffee-script,lieuwex\/coffeescript-to-typescript,youleiy\/coffee-script,princejwesley\/coffeescript,hgGeorg\/coffee-script,ls2uper\/coffeescript,bobcassels\/pencil-coffee-script,jjoos\/coffee-script,yjerem\/coffee-script,FrancoCotter\/coffeescript,mikeyhew\/coffeescript-await-transform,akavi\/CoffeeAF,DoriKal\/coffeescript,will-weiss\/coffeescript,mekuriam\/coffeescript,shimaore\/cake,TobiaszCudnik\/coffeescript-to-typescript,292388900\/coffee-script,behind2\/coffee-script,casidiablo\/coffeescript,Infowatch\/coffee-script,helixbass\/copheescript,kannannilakantaayyar\/coffeescript,lydell\/coffee-script,Infowatch\/coffee-script,stanly-johnson\/coffeescript,alubbe\/coffee-script,helixbass\/copheescript,tempbottle\/coffeescript,tonghuashuai\/coffee-script,hgGeorg\/coffee-script,jobedom\/coffee-script,Geoion\/coffee-script,flaing\/coffeescript,charlieflowers\/coffee-script,will-weiss\/coffeescript,kidaa\/coffeescript,AndersonFirmino\/coffeescript,mrmowgli\/coffeescript,angeliaz\/coffeescript,decaffeinate\/coffeescript,alxarch\/coffeescript,jamesknelson\/coffee-script,charlieflowers\/coffee-script,lydell\/coffee-script,bobcassels\/pencil-coffee-script,coffee-void\/coffeescript,wangyue-ramy\/coffeescript,EmielM\/blackcoffee,DylanPiercey\/coffeescript,PencilCode\/pencil-coffee-script,ASnow\/coffeescript,SonOfLilit\/coffeescript,ambrusc\/coffee-script,Kingson4Wu\/coffee-script,lieuwex\/coffeescript-to-typescript,kannannilakantaayyar\/coffeescript,lbeschastny\/coffeescript,alxarch\/coffeescript,beni55\/coffee-script,angeliaz\/coffeescript,tempbottle\/coffeescript,abbshr\/coffeescript,chaosim\/coffee-script,rev22\/reflective-coffeescript,youleiy\/coffee-script,legokichi\/typecoffee,helixbass\/copheescript,ardha2008\/coffeescript,protez\/coffee-script,maowug\/coffeescript,wangyue-ramy\/coffeescript,jjoos\/coffee-script,longjl\/coffeescript,sqlwwx\/coffeescript-zh,GabrielRatener\/coffeescript-next,pagreczner\/express-coffee,alubbe\/coffee-script,292388900\/coffee-script,jamesknelson\/coffee-script,kidaa\/coffeescript,xixixao\/coffee-script,jashkenas\/coffeescript,mekuriam\/coffeescript,paiq\/blackcoffee,shimaore\/cake,Geoion\/coffee-script,EmielM\/blackcoffee,DylanPiercey\/coffeescript,lbeschastny\/coffeescript,GabrielRatener\/coffeescript-next,maxtaco\/coffee-script,AndersonFirmino\/coffeescript,davidbau\/coffee-script,shreeve\/coffeescript,coffee-js\/coffee-script,tonghuashuai\/coffee-script,princejwesley\/coffeescript,stanly-johnson\/coffeescript,GabrielRatener\/coffeescript-next,SonOfLilit\/coffeescript,TobiaszCudnik\/coffeescript-to-typescript,jiangmiao\/toffee-script,mikeyhew\/coffeescript-await-transform,chaosim\/coffee-script,davidbau\/coffee-script,sqlwwx\/coffeescript-zh,coffee-js\/coffee-script,DoriKal\/coffeescript,jokerhing\/coffeescript,connec\/coffeescript,TobiaszCudnik\/coffeescript-to-typescript,ASnow\/coffeescript,MartyIX\/coffeescript-to-typescript,cosmicexplorer\/coffeescript,PencilCode\/pencil-coffee-script,yjerem\/coffee-script,shihang0001\/coffee-script,isaacs\/coffee-script,guzhaoyuan\/coffee-script,jobedom\/coffee-script,kittens\/coffee-script,pagreczner\/express-coffee,protez\/coffee-script,FrancoCotter\/coffeescript,abbshr\/coffeescript,sebmck\/coffee-script,ambrusc\/coffee-script,sombr\/coffeescript,helixbass\/copheescript,isaacs\/coffee-script","old_file":"test\/literate.litcoffee","new_file":"test\/literate.litcoffee","new_contents":"Literate CoffeeScript Test\n--------------------------\n\ncomment comment\n\n    test \"basic literate CoffeeScript parsing\", ->\n      ok yes\n      \nnow with a...\n  \n    test \"broken up indentation\", ->\n    \n... broken up ...\n\n      do ->\n      \n... nested block.\n\n        ok yes\n\nCode must be separated from text by a blank line.\n\n    test \"code blocks must be preceded by a blank line\", ->\n\nThe next line is part of the text and will not be executed.\n      fail()\n\n      ok yes        \n        \nCode in `backticks is not parsed` and...\n\n    test \"comments in indented blocks work\", ->\n      do ->\n        do ->\n          # Regular comment.\n          \n          ###\n            Block comment.\n          ###\n          \n          ok yes\n          \nRegular [Markdown](http:\/\/example.com\/markdown) features, like links \nand unordered lists, are fine:\n\n  * I \n  \n  * Am\n  \n  * A\n  \n  * List\n\nTabs work too:\n\n\ttest \"tabbed code\", ->\n\t\tok yes\n","old_contents":"Literate CoffeeScript Test\n--------------------------\n\ncomment comment\n\n    test \"basic literate CoffeeScript parsing\", ->\n      ok yes\n      \nnow with a...\n  \n    test \"broken up indentation\", ->\n    \n... broken up ...\n\n      do ->\n      \n... nested block.\n\n        ok yes\n        \nCode in `backticks is not parsed` and...\n\n    test \"comments in indented blocks work\", ->\n      do ->\n        do ->\n          # Regular comment.\n          \n          ###\n            Block comment.\n          ###\n          \n          ok yes\n          \nRegular [Markdown](http:\/\/example.com\/markdown) features, like links \nand unordered lists, are fine:\n\n  * I \n  \n  * Am\n  \n  * A\n  \n  * List\n\nTabs work too:\n\n\ttest \"tabbed code\", ->\n\t\tok yes\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1d69322654c2264630f2fd8560f2565583506cca","subject":"Remove unused deps","message":"Remove unused deps\n","repos":"Piot\/boardgamedb","old_file":"app\/app.litcoffee","new_file":"app\/app.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b19cb5f457f400cadcaee8904608944411f3d4c4","subject":"moved tasks around and added a heading","message":"moved tasks around and added a heading\n","repos":"curlee\/Appnostic","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/curlee\/Appnostic.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f85851a09a3e872214b55ca85fb98cf70867bd76","subject":"Separation of command concerns","message":"Separation of command concerns\n","repos":"merciba\/ecrit,merciba\/ecrit","old_file":"bin\/test.litcoffee","new_file":"bin\/test.litcoffee","new_contents":"`test` command handler\n===\n\n\tfs = require 'fs-sync'\n\tpath = require 'path'\n\texec = require('child_process').exec\n\tspawn = require('child_process').spawn\n\tpkg = require(path.join(__dirname, '..\/package.json'))\n\n\tmodule.exports = (end) ->\n\n\t\tif not fs.exists path.join(__dirname, '..\/factory\/node_modules')\n\t\t\tfactory = path.join(__dirname, '..\/factory')\n\t\t\tconsole.log \"Installing NPM Modules for \/factory...\"\n\t\t\texec(\"cd #{factory} && npm install\")\n\t\t\tconsole.log \"Successfully installed NPM Modules in \/factory\/node_modules\".green\n\n\t\ttestTarget = path.join(__dirname, '..\/test\/**\/*litcoffee')\n\t\ttest = spawn(\"mocha\", [\"--compilers\", \"coffee:coffee-script\/register\", testTarget])\n\t\ttest.stdout.pipe(process.stdout)\n\t\ttest.stderr.pipe(process.stderr)\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'bin\/test.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"47148d50f24406a6d8e2ed3166caeb992f6a92da","subject":"Published with https:\/\/stackedit.io\/","message":"Published with https:\/\/stackedit.io\/","repos":"candril\/tavola","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/candril\/tavola.git\/'\n","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"8473753a443d84a3b0662ac39c94b61726e6e5cb","subject":"document singular associations","message":"document singular associations\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/03_app_internals\/24b_singular_associations.litcoffee","new_file":"docs\/03_app_internals\/24b_singular_associations.litcoffee","new_contents":"# \/api\/App Internals\/Batman.Association\/Batman.SingularAssociation\n\n`Batman.SingularAssociation` extends `Batman.Association`.\n\n## ::constructor(@model, @label, options={}) : SingularAssociation\n\nAdds default options:\n\n- `namespace`: `Batman.currentApp`\n- `name`: camelized `@label`\n\n## ::getAccessor(association, model, label)\n\nChecks for the associated record in this record's attributes. Otherwise returns a proxy. Loads the associated record if `options.autoload`.\n\n## ::setIndex() : UniqueAssociationSetIndex\n\nReturns a `Batman.UniqueAssociationSetIndex` based on `indexRelatedModelOn` which is suitable for finding the associated record in its loaded set.\n\n## ::associationProxy(association)\n\nReturns a suitable proxy object for `association`.\n\n## ::.indexRelatedModelOn\n\nImplemented by subclasses to be used in `setIndex`.\n\n## ::.isSingular[=true]\n\nIdentifies the `SingularAssociation`.\n\n# \/api\/App Internals\/Batman.Association\/Batman.BelongsToAssociation\n\n`Batman.BelongsToAssociation` extends `Batman.SingularAssociation` and provides backing to associations declared with `@belongsTo` in model definitions.\n\n\n## ::constructor(model, label, options)\n\nReturns a `Batman.PolymorphicBelongsToAssociation` if `options.polymorphic` is true.\n\n## ::encoder() : Function\n\nReturns a function that serializes a record by calling `toJSON` on it.\n\n## ::decoder() : Function\n\nReturns a function that loads a record by:\n\n- using `createFromJSON` to instantiate the record\n- if the inverse is a `Batman.HasManyAssociation`, setting the foreignKey from the parent record\n- if the inverse is something else (eg, `Batman.HasOneAssociation`), setting the parent's `inverse.label` to this record.\n- setting the record's `association.label` to the parent record\n\n## ::apply(record)\n\nUpdate's `record`'s foreignKey to the associated record's primaryKey.\n\n## ::.defaultOptions\n\n- `saveInline`: false\n- `autoload`: true\n- `encodeForeignKey`: true\n\n## ::.proxyClass[=Batman.BelongsToProxy]\n\nReturned by a `belongsTo` get accessor.\n\n## ::.associationType[='belongsTo']\n\nUsed by `Batman.AssociationCurator` to store this association.\n\n## ::.indexRelatedModelOn[='primaryKey']\n\nUsed to create a `Batman.UniqueAssociationSetIndex` to locate the associated record.\n\n# \/api\/App Internals\/Batman.Association\/Batman.HasOneAssociation\n\n`Batman.HasOneAssociation` extends `Batman.SingularAssociation` and backs associations declared with `@hasOne` in model definitions.\n\n## ::constructor(model, label, options) : HasOneAssociation\n\nProvides default options:\n\n- `primaryKey`: \"id\"\n- `foreignKey`: underscored `@model.resourceName` + `_id`\n\n## ::apply(baseSaveError, base)\n\nCalled after `base` is saved. If there's no `baseSaveError`, updates the related record's foreign key to `base`'s primary key.\n\n## ::encoder() : Function\n\nReturns a function that serializes the record if `options.saveInline` is true.\n\n## ::decoder() : Function\n\nReturns a function that creates a related record from JSON and sets its `inverseOf`.\n\n## ::.associationType[='hasOne']\n\nUsed by `Batman.AssociationCurator` to store the association.\n\n## ::.proxyClass[=Batman.HasOneProxy]\n\nSometimes returned by a `hasOne` get accessor.\n\n## ::.indexRelatedModelOn[='foreignKey']\n\nUsed to create a `Batman.UniqueAssociationSetIndex` to locate the associated record.\n\n# \/api\/App Internals\/Batman.Association\/Batman.PolymorphicBelongsToAssociation\n\n`Batman.PolymorphicBelongsToAssociation` extends `Batman.BelongsToAssociation` and backs associations declared with `@belongsTo \"...\", polymorphic: true`.\n\n## ::constructor(model, label, options) : PolymorphicBelongsToAssociation\n\nCalls `super`, then encodes the `foreignTypeKey` if option `encodeForeignTypeKey` was true.\n\n## ::apply(base)\n\nExtends `Batman.BelongsToAssociation::apply` by also updating `base`'s property for `foreignTypeKey`.\n\n## ::getAccessor(association, model, label)\n\nReturns either a record from attributes or a proxy. Loads the proxy if the autoload option was true.\n\n## ::url(recordOptions) : String\n\nReturns a suitable URL for the association.\n\n## ::getRelatedModelForType(type)\n\nTries to find a model in the association's scope with `type` or camelized `type`.\n\n## ::setIndexForType(type) : PolymorphicUniqueAssociationSetIndex\n\nReturns a set index to find the associated record for `type`.\n\n## ::.typeIndices : Object\n\nA cache of `Batman.PolymorphicUniqueAssociationSetIndex`es for this association.\n\n## ::inverseForType(type) : Association\n\nLooks up the inverse association for `type` by using `@options.inverseOf` or checking all associations on the return value of`getRelatedModelForType` for `type`.\n\n## ::decoder() : Function\n\nReturns a function that loads a record from JSON, taking into account the `foreignTypeKey`.\n\n\n## ::.isPolymorphic[=true]\n\nLabels this association as polymorphic.\n\n## ::.proxyClass[=Batman.PolymorphicBelongsToProxy]\n\nReturned when the associated record isn't found in attributes.\n\n## ::.defaultOptions\n\nExtends `Batman.BelongsToAssociation`'s  default options and adds:\n\n- `encodeForeignTypeKey`: true\n\n## ::.getRelatedModel[=false]\n## ::.setIndex[=false]\n## ::.inverse[=false]\n\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'docs\/03_app_internals\/24b_singular_associations.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"250ed093ff805d1cb44beb227208f3d7fd6776a9","subject":"released gapi-rdf module usage overview document with a request for comments","message":"released gapi-rdf module usage overview document with a request for comments\n","repos":"pirati-cz\/gapi-rdf","old_file":"docs\/rfc-gapi-rdf.litcoffee","new_file":"docs\/rfc-gapi-rdf.litcoffee","new_contents":"GAPI RDF library Request for comments\n=====================================\n\n*November 2014*\n\n*\"Tom\u00e1\u0161 `klip` Klapka\", <tomas.klapka@pirati.cz>*\n\nThis is an usage overview with examples of `gapi-rdf` JavaScript library (written in CoffeeScript) containing rdf-interfaces, universal Parser, Serializer and ORM-like wrapper for a RDF resource and it's graph.\n\nMost of it is already implemented as a prototype (alpha version) and before publishing the library I would like to request for comments on library's api, architecture, names, nonsenses, etc. I'll take all comments seriously and I'll try to refactor the code and it's tests before the initial release.\n\nWhat is GAPI?\n-------------\n\nGAPI is a short for Graph API.\n\nGAPI is a `public domain` project initiated by several pirates from Czech Pirate Party.\n\nGAPI is supposed to be a JavaScript Semantic Web Stack with a pluginnable SPARQL-endpoint proxy and a Web server with a REST API.\n\n`gapi-rdf` module is supposed to be a common part of GAPI but usable also separately. It's aiming to simplify processing of RDF data in JavaScript. We are trying to reuse other libraries and modules and provide general programmatical API with a higher level than is provided by low-level rdf-interfaces\/rdf-ext implementations.\n\n\nWhat is implemented?\n--------------------\n\n* GAPI main class\n* Parser\n* Namespace\n* almost all of the Resource class\n* simple Parser HTTP request caching of HTTP responses\n\n\nTODO and thoughts\n-----------------\n\nnot only to implement, but also to specify programmatical api\n\n* how to treat and return errors? (research best JS practices)\n* blank nodes (blank resource?)\n* lazy fetching of resources?\n* constraining domain, range, cardinality... (ORM strict mode?)\n* add Namespace without loading it's data (ie. just for aliasing it's name)\n* Namespace split into Namespace and Ontology? (separate aliasing of any namespaces and ORM required ontology data)\n* GAPI Parser - include more parsers from various modules and allow to add (replace) own parser anytime later for any MIME type programmatically\n* GAPI Serializer - serialize rdf-interfaces' graph to various formats\n* GAPI Storage (wrapper for rdf-ext stores?)\n* ResourcesList? to simplify working with set of resources\n* reasoning? (idea is that it might be very helpful for the ORM part)\n* model methods - bind a class with static methods to a RDF type and call these methods by the Resource catchall handler\n* `alias` vs. `prefix`?\n\nGAPI RDF library\n================\n\nUsage\n-----\n\nGAPI RDF uses *harmony proxies* to handle catchall getters and setters for resource ORM. To enable harmony proxies, you need to run `node` with `--harmony` command line option.\n\n```bash\nnode --harmony example\n```\n\nIf you are not going to use Namespace and Resource classes and you don't need to instantiate GAPI, ie. you are going to use only it's interfaces, Parser and Serializer classes, then harmony proxies are not required.\n\n\n    GAPI = require 'gapi-rdf'\n\n\nGet rdf-interfaces\/rdf-ext mixin, Parser and Serializer modules\n\n    rdf = GAPI.interfaces\n    Parser = GAPI.Parser\n    Serializer = GAPI.Serializer\n\n\nORM\n---\n\nInstantiate GAPI for ORM operations. Each gapi instance has it's own list of namespaces, it's aliases and resources.\nDefault namespaces are: rdf, rdfs and owl\n\n    gapi = new GAPI()\n\nYou can instantiate GAPI with additional namespaces\n\n    gapi_with_foaf_and_sioc = new GAPI {\n      namespaces:\n        'foaf': 'http:\/\/xmlns.com\/foaf\/0.1\/'\n        'sioc': 'http:\/\/rdfs.org\/sioc\/ns#'\n    }\n\nGet GAPI's Resource and Namespace classes from GAPI's instance `gapi` since they are bound together.\n\n    Resource = gapi.Resource\n    Namespace = gapi.Namespace\n\n\nLater if you need the `gapi` instance, you can simply get it from `Resource.gapi` or `Namespace.gapi` static properties.\n`gapi` instance injects itself into `gapi.Namespace` and `gapi.Resource` classes as static property to joint all pieces together.\n\n    gapi.Resource.gapi == gapi  # true\n    gapi.Namespace.gapi == gapi # true\n\nYou can get it from instantiated namespaces and resources as well.\n\n    gapi = anInstanceOfResource.gapi\n    gapi = anInstanceOfNamespace.gapi\n\nWait for GAPI to load it's default\/configured Namespaces and its Resources.\n\n`init()` initiates loading, creates a `promise` and returns `this`.\nThen `and` contains `this`, `then()` calls `promise.then()`.\n\n    gapi.init().then (gapi) ->\n    gapi.init().and.then (gapi) ->\n    gapi.init().and.promise.then (gapi) ->\n    (gapi = new GAPI()).init().then (gapi) ->\n    (gapi = new GAPI()).init().and.then (gapi) ->\n\n\nNamespace\n=========\n\nNamespace class sets the alias for a namespace and also it loads it's data.\n\nCreating and Loading\n--------------------\n\nGet Namespace class from gapi instance\n\n      Namespace = gapi.Namespace\n\nCreate FOAF namespace\n\n      foaf = new Namespace 'foaf', 'http:\/\/xmlns.com\/foaf\/0.1\/'\n\n\nNamespace instance keeps `gapi` instance so you don't have to pass it around\n\n      \n      gapi = foaf.gapi\n\n\nNamespace alias and uri are in their properties\n\n      console.log \"#{foaf.alias} for #{foaf.uri}\"\n\n\nLoading namespace data\n\n      foaf.init().then (foaf) ->\n      foaf.init().and.then (foaf) ->\n      foaf.init().and.promise.then (foaf) ->\n      (foaf = new Namespace('foaf', 'http:\/\/xmlns.com\/foaf\/0.1\/')).init().then (foaf) ->\n      (foaf = new Namespace('foaf', 'http:\/\/xmlns.com\/foaf\/0.1\/')).and.init().and.then (foaf) ->\n\n\nLater you can get your namespace instance (if needed) by calling `ns(ns_alias)` or `namespace(ns_alias)`.\nThese methods are available as instance methods at `gapi` object and class methods at `gapi.Namespace` class\n\n        foaf = gapi.ns 'foaf'\n        foaf = gapi.namespace 'foaf'\n        foaf = Namespace.ns 'foaf'\n        foaf = Namespace.namespace 'foaf'\n\n\nNamespace classes, properties and resources\n-------------------------------------------\n\nYou can list namespace classes, properties, and all its resources. Returns string array with names of the required type of data as default.\nAll of them returns short resource names as default since they are all from the namespace.\n\n        foaf.getClasses()\n        foaf.getProperties()\n        foaf.getResources()\n\n\nYou can pass options object where you can specify format of resource names returned and also type of returned data:\n\n`nameFormat` can be `GAPI.SHORT`, `GAPI.ALIAS` or `GAPI.FULL` (or just use 'short', 'alias', 'full')\n`returnType` can be `GAPI.NAMES`, `GAPI.RESOURCES` or `GAPI.ALL` (or just use 'names', 'resources', 'all')\n\nOr take it from GAPI's instance `gapi.SHORT`, `gapi.ALIAS`, `gapi.FULL`, `gapi.NAMES`, `gapi.RESOURCES`, `gapi.ALL`.\n\n        foaf.getClasses { nameFormat: GAPI.FULL, returnType: GAPI.ALL }\n\n\nShort names (default options):\n```\n[ 'LabelProperty', 'Person', 'Agent', ... ]\n```\n\n        short_names_options =\n          nameFormat: GAPI.SHORT\n          returnType: GAPI.NAMES\n\nFor aliased names with resources as values:\n```\n{ 'foaf:LabelProperty': { uri: 'http:\/\/xmlns.com\/foaf\/0.1\/LabelProperty', graph: ... }, ... }\n\n```\n\n        aliased_names_with_values_options =\n          nameFormat: GAPI.ALIAS\n          returnType: GAPI.ALL\n\nFor aliased names with resources as values:\n```\n[ { uri: 'http:\/\/xmlns.com\/foaf\/0.1\/LabelProperty', graph: ... }, ... ]\n\n```\n\n        only_resources_array_options =\n          returnType: GAPI.RESOURCES\n\nFull names:\n```\n[ 'http:\/\/xmlns.com\/foaf\/0.1\/LabelProperty', 'http:\/\/xmlns.com\/foaf\/0.1\/Person', ... ]\n```\n\n        full_names_options =\n          nameFormat: GAPI.FULL\n          returnType: GAPI.NAMES\n\n\nYou can get namespace class, property or resource by it's `name`.\nYou can use various name formats and they should be auto-detected.\nIt returns the resource instance.\n\n        foaf.getClass 'Document'\n        foaf.getProperty 'foaf:knows'\n        foaf.getResource 'http:\/\/xmlns.com\/foaf\/0.1\/mbox'\n\n\nClasses and properties are resources too, so there is `getResource()` alias `get()`\n\n        foaf.get 'http:\/\/xmlns.com\/foaf\/0.1\/age'\n\n\nYou are also safe to use short resourceNames as namespace instance properties since catchall getter passes all not existing properties to foaf.get(unknownPropertyName)\n\n        foaf.Person  # Person is not a property so it calls foaf.get \"http:\/\/xmlns.com\/foaf\/0.1\/Person\"\n        foaf.knows   # calls foaf.get \"http:\/\/xmlns.com\/foaf\/0.1\/knows\"\n\n\n\nResource\n========\n\nResource class wraps rdf-interfaces' graph and provides ORM-like access.\n\n\nCreating and Loading\n--------------------\n\nGet Resource class from gapi instance\n\n      Resource = gapi.Resource\n\nCreate a new resource and add <resource_uri> <rdf:type> <foaf:Person> triple into it's graph and logs graph to console.\n\n        john = new Resource 'http:\/\/example.com\/people\/John_Doe#me'\n        john.rdf.type = foaf.Person\n        console.log john.toString()\n\n\nShorter version when you need to specify type of a resource\n\n        jane = new Resource 'http:\/\/example.com\/people\/Jane_Doe#me', foaf.Person\n\n\nPick a single resource from url, file or graph\n\n        Resource.from('http:\/\/example.com\/people\/Jason_Doe#me').then (jason) ->\n          console.log jason.toString()\n\n        Resource.from('.\/Jason_Doe.ttl', 'http:\/\/example.com\/people\/Jason_Doe#me').then (jason) ->\n          console.log jason.toString()\n\n        Resource.from(graph, 'http:\/\/example.com\/people\/Jason_Doe#me').then (jason) ->\n          console.log jason.toString()\n\n\nLoad all resources from url, file or graph. Returns object with keys as fullNames of resources and values as resource instances\n\n        Resource.allFrom('http:\/\/example.com\/people\/Jason_Doe#').then (resources) -> \n          console.log resources.length\n\n        Resource.allFrom('.\/Jason_Doe.ttl', 'http:\/\/example.com\/people\/Jason_Doe#').then (resources) ->\n          console.log resources.length\n\n        Resource.allFrom(graph, 'http:\/\/example.com\/people\/Jason_Doe#').then (resources) ->\n          console.log resources.length\n\n\nAdding statements\n-----------------\n\n        john.foaf.name = \"John Doe\"\n        john.foaf.name = \"Johnny Doe\"\n        john.foaf.mbox = \"john.doe@example.com\"\n        john.foaf.knows = jane\n        john.foaf.knows = jason\n        john.foaf.knows = 'http:\/\/example.com\/people\/Jack_Doe#me'\n        jane.foaf.mbox = \"jane.doe@example.com\"\n        jane.foaf.mbox = \"jane.doe@other.example.com\"\n        jane.foaf.knows = jason\n        jason.foaf.knows = 'http:\/\/example.com\/people\/John_Doe#me'\n        jason.foaf.nick = ['jassa', 'baby']\n\nor you can use `add` method:\n\n        john.add foaf.homepage, \"http:\/\/jason.doe.example.com\/\"\n\n\nGetting statements\n------------------\n\n        john_name = john.foaf.name            # [ \"John Doe\", \"Johnny Doe\" ]\n        john_mbox = john.foaf.mbox            # \"john.doe@example.com\"\n        john_knows = john.foaf.knows          # [ jane, jason, jack ]\n        jane_mbox = jane.foaf.mbox            # [ \"jane.doe@example.com\", \"jane.doe@other.example.com\" ]\n        jane_knows = jane.foaf.knows          # jason\n        jane_knows = jane.all foaf.knows      # [ jason ] ie. always return array\n        jason_nick = jason.foaf.nick          # [ \"jassa\", \"baby\" ]\n\n        john_knows_first = john.first foaf.knows    # jane\n        john_knows_rest = john.rest foaf.knows      # [ jason, jack ] always array\n        john_knows_last = john.last foaf.knows      # jack\n\n        john_knows_count = john.count foaf.knows    # 2\n        john_knows_count = john.length foaf.knows   # 2\n\nor you can use `get*()` methods:\n\n        john.get foaf.knows\n        john.getFirst foaf.knows\n        john.getRest foaf.knows\n        john.getAll foaf.knows\n        john.getLast foaf.knows\n        john.getCount foaf.knows\n        john.getLength foaf.knows\n\n\nRemoving statements\n-------------------\n\n        jane.remove foaf.knows\n        jane.remove \"foaf:knows\"\n        jane.remove \"http:\/\/xmlns.com\/foaf\/0.1\/knows\"\n\n\nRemoving known statements\n-------------------------\n\n        jane.remove foaf.mbox, [ \"jane.doe@example.com\", \"jane.doe@other.example.com\" ]\n        jason.remove foaf.nick, 'baby'\n        john.remove foaf.knows, 'http:\/\/example.com\/people\/Jason_Doe#me'\n\n\nReplacing statements\n--------------------\n\n        john.remove foaf.name\n        john.foaf.name = \"John Adalbert Doe\" \n\n`replace` is a shorter version\n\n        john.replace foaf.name, \"John Adalbert Doe\"\n\n\nAccessing resource's graph\n--------------------------\n\nYou can access resource's graph (rdf-interfaces graph)\n\n        john_and_jane_graph = john.graph.merge jane.graph\n\n\nParser\n======\n\n    Parser = require('gapi-rdf').Parser\n\n    Parser.loadFile('data.ttl').then (content, mime) ->\n    Parser.download('http:\/\/example.com\/data.ttl').then (content, mime) ->\n\n    Parser.parse(content, mime, base).then (graph) ->\n\n    Parser.fetch('data.ttl', base).then (graph) ->\n    Parser.fetch('http:\/\/example.com\/data.rdf').then (graph) ->\n\n\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'docs\/rfc-gapi-rdf.litcoffee' did not match any file(s) known to git\n","license":"unlicense","lang":"Literate CoffeeScript"}
{"commit":"80dad858ab4cc6ae9425754800342176571cb744","subject":"user fixtures","message":"user fixtures\n","repos":"jfols\/liftoff,modweb\/pinki,jfols\/liftoff","old_file":"server\/fixtures.litcoffee","new_file":"server\/fixtures.litcoffee","new_contents":"# user fixtures\n\n    criteria = username: 'testuser'\n    if Meteor.users.find(criteria).count() is 0\n      users = [\n        username: 'testuser'\n        email: 'test@user.com'\n        password: 'password'\n      ,\n        username: 'testuser2'\n        email: 'test@user2.com'\n        password: 'password'\n      ]\n      console.log 'creating test users'\n      _.each users, (user) ->\n        Accounts.createUser user\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'server\/fixtures.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d68bc17f9d963b8383d65536e43754c07e5dfd38","subject":"Published with https:\/\/stackedit.io\/","message":"Published with https:\/\/stackedit.io\/","repos":"candril\/tavola","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/candril\/tavola.git\/'\n","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"041412ae064f9a6d6fe5133e7cabdf1b022e84b0","subject":"Document Batman.I18N","message":"Document Batman.I18N\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/19_i18n.litcoffee","new_file":"docs\/19_i18n.litcoffee","new_contents":"# \/api\/Extras\/Batman.I18N\n\n`Batman.I18N` is a batman.js extra ([available in CoffeeScript](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.i18n.coffee)) for providing multi-langauge support in your application. It is modeled after [Rails i18n](http:\/\/guides.rubyonrails.org\/i18n.html).\n\nTo use `Batman.I18N`, you must:\n\n- Include the [batman.js extra](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/extras\/batman.i18n.coffee) in your project\n- Enable `Batman.I18N` with `Batman.I18N.enable()`\n- Define locales on the client or [provide support from the server](\/docs\/api\/batman.i18n.html#getting_locales_from_the_server)\n\nFor example:\n\n```coffeescript\n# after inlcuding Batman.I18N\nBatman.I18N.enable()\nBatman.I18N.set 'locales.en',\n  messages:\n    welcome: \"Welcome\"\n  account:\n    sign_in: \"Sign In\"\n    register: \"Register\"\n\nBatman.I18N.get(\"locale\")    # \"en\", default\nBatman.t(\"messages.welcome\") # \"Welcome\"\nBatman.I18N.set(\"locale\", \"zh\")\nBatman.t(\"messages.welcome\") # \"\u6b22\u8fce\"\n```\n\nYou can get translations for the current locale by using `t` in view bindings:\n\n```html\n<p data-source='t.messages.welcome'><\/p>\n```\n\n## Getting locales from the server\n\n`Batman.I18N.get('locales')` returns a `Batman.I18N.LocalesStorage`. This object's default accessor fetches locale objects from the server and caches them on the client. For example:\n\n```coffeescript\nBatman.I18N.get('locales.es')     # GET \/locales\/es.json\nBatman.I18N.get('locales.fr')     # GET \/locales\/fr.json\n```\n\n`Batman.I18N.translate` will fetch a locale if it isn't loaded already:\n\n```\nBatman.I18N.set('locale', 'zh')\nBatamn.I18N.translate('welcome')  # GET \/locales\/zh.json\n```\n\nThe `Batman.Request` expects a JSON response with the locale object:\n\n```coffeescript\n{\n  \"zh\" : {\n    \"welcome\" : \"\u6b22\u8fce\",\n    \"account\" : {\n      \"sign_in\" : \"\u767b\u5f55\",\n      \"register\" : \"\u6ce8\u518c\",\n    }\n  }\n}\n```\n\nWhen the new values are returned, view bindings will be automatically updated.\n\n## Error messages\n\nYou can provide error messages for a new locale by including translations in the same structure as batman.js's default messages. [See the batman.js source](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/model\/validations\/validators.coffee) for the structure of these messages.\n\n## @.defaultLocale[= \"en\"] : String\n\nThe default locale for `Batman.I18N`. Override this to make your app start in a locale other than `\"en\"`.\n\n## @%locale : String\n\nThe current locale for `Batman.I18N`, used by `Batman.translate`. Set this value to change your locale:\n\n```coffeescript\nBatman.I18N.set('locale', 'fr') # Bienvenue!\n```\n\n## @%locales : I18N.LocalesStorage\n\nReturns the current `Batman.I18N.LocalesStorage`, which stores locales and there translations. You can set keys on `locales` to define translations:\n\n```coffeescript\nBatman.I18N.set(\"locales.uz\", { ... })\n```\n\nSee [\"Getting locales from the server\"](\/docs\/api\/batman.i18n.html#getting_locales_from_the_server) for information about how `Batman.I18N.LocalesStorage` handles missing keys.\n\n## @%translations : Object\n\nReturns the defined translations for the current locale.\n\n## @enable()\n\nTurns on `Batman.I18N` by:\n\n- Storing batman.js's default error messages to the `\"en\"` locale\n- Overriding `Batman.translate` to use `Batman.I18N.translate`\n\n## @disable()\n\nTurns off `Batman.I18N` by restoring previous functionality to `Batman.translate`.\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'docs\/19_i18n.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"2d25a9a2b539fa37c5720b96e63574dfe5280b76","subject":"Add the API docs index file","message":"Add the API docs index file\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/00_index.litcoffee","new_file":"docs\/00_index.litcoffee","new_contents":"# Using This Reference\n\nThe API Reference contains specific documentation for individual components of\nthe framework. In most sections you'll also find tests included, which serve as\nan example for correct usage as well as an assertion that the API has not\nchanged.\n\nWithin the reference, types are documented by suffixing with a colon followed\nby the type (e.g. `toString() : string`). This applies to function arguments,\nreturn types, property types and accessor types. If there is no type specified,\nit's either self-evident or the type is undefined (e.g. in the case of a\nfunction with no return value).  All function\/property\/accessor headings are\nprefixed with an `@` if they exist at the class level, otherwise they exist at\nthe prototype\/instance level.\n\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'docs\/00_index.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f7960617cba482e23ab3f17b91c686b0b787ed67","subject":"Published with https:\/\/stackedit.io\/","message":"Published with https:\/\/stackedit.io\/","repos":"candril\/tavola","old_file":"README.litcoffee","new_file":"README.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/candril\/tavola.git\/'\n","license":"bsd-2-clause","lang":"Literate CoffeeScript"}
{"commit":"269aa031315f2d71d9cae87bfcf4732f69fa6b68","subject":"fixed link","message":"fixed link\n","repos":"curlee\/Appnostic","old_file":"src\/manifests.litcoffee","new_file":"src\/manifests.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/curlee\/Appnostic.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d6fac82ec19e89dd7119092df42edf3d8702f691","subject":"Use remote server","message":"Use remote server\n","repos":"Piot\/boardgamedb","old_file":"app\/common\/api-service.litcoffee","new_file":"app\/common\/api-service.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"809a4d9bc3796bd5540420db0cd20181ccd017f0","subject":"document Batman.BinarySetOperation","message":"document Batman.BinarySetOperation\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/05c_binary_set_operations.litcoffee","new_file":"docs\/05c_binary_set_operations.litcoffee","new_contents":"# \/api\/Data Structures\/Batman.BinarySetOperation\n\n`Batman.BinarySetOperation` extends `Batman.Set` and tracks _two_ `Batman.Set`s and updates its contents whenever an item is added to or removed from either set. `Batman.BinarySetOperation` is an abstract class. It is extended by `Batman.SetUnion`, `Batman.SetIntersection`, and `Batman.SetComplement`.\n\n## ::constructor(left: Set, right: Set) : BinarySetOperation\n\nReturns a new `BinarySetOperation` between `left` and `right`.\n\n## ::merge(others... : Set) : Set\n\nReturns a new `Batman.Set` with the contents of the `BinarySetOperation` plus the contents of `others`.\n\n## ::filter(func: Function) : Set\n\nExecutes `func(item)` for each item in the `BinarySetOperation` and returns a new `Batman.Set` with items where `func(item)` returned a truthy value.\n\n## ::.left : Set\n\nReturns the first `Batman.Set` passed to the constructor.\n\n## ::.right : Set\n\nReturns the second `Batman.Set` passed to the constructor.\n\n\n# \/api\/Data Structures\/Batman.BinarySetOperation\/Batman.SetUnion\n\n`Batman.SetUnion` extends `Batman.BinarySetOperation`. It implements a [union operation](http:\/\/en.wikipedia.org\/wiki\/Union_%28set_theory%29): the `SetUnion` contains members found in _either set_ passed to the constructor, without duplicates.\n\nSince `Batman.SetUnion` is a subclass of `Batman.Set`, you can use it just like a `Batman.Set`.\n\n# \/api\/Data Structures\/Batman.BinarySetOperation\/Batman.SetIntersection\n\n`Batman.SetIntersection` extends `Batman.BinarySetOperation`. It implements an [intersection operation](http:\/\/en.wikipedia.org\/wiki\/Intersection_%28set_theory%29): it contains members of _both sets_ passed to its constructor without duplicates.\n\nSince `Batman.SetIntersection` is a subclass of `Batman.Set`, you can use it just like a `Batman.Set`.\n\n# \/api\/Data Structures\/Batman.BinarySetOperation\/Batman.SetComplement\n\n`Batman.SetComplement` extends `Batman.BinarySetOperation`. It implements a [complement operation](http:\/\/en.wikipedia.org\/wiki\/Complement_%28set_theory%29): it contains the members of _`left`_ which aren't in _`right`_.\n\nSince `Batman.SetComplement` is a subclass of `Batman.Set`, you can use it just like a `Batman.Set`.\n\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'docs\/05c_binary_set_operations.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8b698742e80a90a35cec69f9780afe621ff0efb8","subject":"Cleanup gulpfile","message":"Cleanup gulpfile\n","repos":"Piot\/boardgamedb","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"53ae054b9d25fcf0b50fe86e069c0eeb96800a3e","subject":"cleaned up gulpfile","message":"cleaned up gulpfile\n","repos":"curlee\/Appnostic","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/curlee\/Appnostic.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d7bf42e65c28cbb1cd66116f134253c7e0cbdc47","subject":"Documentation","message":"Documentation\n","repos":"Industrial\/id-server","old_file":"src\/Task.litcoffee","new_file":"src\/Task.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Industrial\/id-server.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"4486ef7125a0f1c1bc2a2274e50dae364c0855a8","subject":"Implemented basic navmesh crawling support.  Fixes #1.","message":"Implemented basic navmesh crawling support.  Fixes #1.\n","repos":"jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/WalkingSimulator","old_file":"src\/navmesh.litcoffee","new_file":"src\/navmesh.litcoffee","new_contents":"On calling with the path to a MSN file and a callback, reads the MSN file and\nexecutes the callback with an object as the argument.\n    \n    handleError = require \".\/handleError.litcoffee\"\n    \n    module.exports = (path, callback) ->\n        request = new XMLHttpRequest()\n        request.open \"GET\", path, true\n        request.responseType = \"arraybuffer\"\n        request.onreadystatechange = ->\n            if request.readyState is 4\n                if request.status is 200\n                    triangles = request.response.byteLength \/ (3 * 3 * 4 + 3 * 4 + 3 * 3 * 4 + 3 * 2)\n                \n                    vertices = for vertex in [0...3]\n                        for axis in [0...3]\n                            new Float32Array request.response, (vertex * 3 + axis) * 4 * triangles, triangles\n                    \n                    normals = for axis in [0...3]\n                        new Float32Array request.response, (3 * 3 + axis) * 4 * triangles, triangles\n                    \n                    edgeNormals = for edge in [0...3]\n                        for axis in [0...3]\n                            new Float32Array request.response, (3 * 3 + 3 + edge * 3 + axis) * 4 * triangles, triangles\n\n                    neighbors = for edge in [0...3]\n                        new Uint16Array request.response, ((3 * 3 + 3 + 3 * 3) * 4 + edge * 2) * triangles, triangles\n                            \n                    dot = (x1, y1, z1, x2, y2, z2) -> x1 * x2 + y1 * y2 + z1 * z2\n                    \n                    distanceTo = (plane, vertex, obj) -> dot obj.location[0] - vertices[vertex][0][obj.triangle], obj.location[1] - vertices[vertex][1][obj.triangle], obj.location[2] - vertices[vertex][2][obj.triangle], plane[0][obj.triangle], plane[1][obj.triangle], plane[2][obj.triangle]\n                                           \n                    callback\n                    \nCall the \"constrain\" property with an object containing:\n\n- location: An array of three numbers specifying the X, Y and Z moved to.\n- triangle: An integer specifying the triangle index which contained the entity\n            last frame.\n            \nThis will modify these properties to constrain the entity to the surface of the \nnavmesh.\n                    \n                        constrain: (obj) ->\n                            for iterations in [0...25]\n                                distanceA = distanceTo edgeNormals[0], 0, obj\n                                distanceB = distanceTo edgeNormals[1], 1, obj\n                                distanceC = distanceTo edgeNormals[2], 2, obj\n                                if distanceA >= 0 and distanceB >= 0 and distanceC >= 0 \n                                    break\n                                \n                                neighborA = neighbors[0][obj.triangle]\n                                neighborB = neighbors[1][obj.triangle]                                \n                                neighborC = neighbors[2][obj.triangle]\n\n                                if distanceA < 0 and neighborA isnt 65535\n                                    obj.triangle = neighborA\n                                    continue\n                                    \n                                if distanceB < 0 and neighborB isnt 65535\n                                    obj.triangle = neighborB\n                                    continue\n                                    \n                                if distanceC < 0 and neighborC isnt 65535\n                                    obj.triangle = neighborC\n                                    continue\n                                \n                                if distanceA < 0 and distanceB < 0\n                                    for axis in [0...3]\n                                        obj.location[axis] = vertices[1][axis][obj.triangle]\n                                    continue\n                                    \n                                if distanceB < 0 and distanceC < 0\n                                    for axis in [0...3]\n                                        obj.location[axis] = vertices[2][axis][obj.triangle]\n                                    continue\n                                    \n                                if distanceC < 0 and distanceA < 0\n                                    for axis in [0...3]\n                                        obj.location[axis] = vertices[0][axis][obj.triangle]\n                                    continue\n\n                                if distanceA < 0\n                                    for axis in [0...3]\n                                        obj.location[axis] -= edgeNormals[0][axis][obj.triangle] * distanceA\n                                    continue\n                                    \n                                if distanceB < 0\n                                    for axis in [0...3]\n                                        obj.location[axis] -= edgeNormals[1][axis][obj.triangle] * distanceB\n                                    continue\n                                        \n                                if distanceC < 0\n                                    for axis in [0...3]\n                                        obj.location[axis] -= edgeNormals[2][axis][obj.triangle] * distanceC\n                                    continue\n                                    \n                            distance = distanceTo normals, 0, obj\n                            for axis in [0...3]\n                                obj.location[axis] -= normals[axis][obj.triangle] * distance\n                            return\n                            \n                else\n                    handleError \"Failed to load navmesh file \" + path\n            return\n        request.send null\n        return","old_contents":"","returncode":1,"stderr":"error: pathspec 'src\/navmesh.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8834553d55c222e2b8e6111c066593e0e90ae931","subject":"Boilerplate for non-interactive cli","message":"Boilerplate for non-interactive cli\n","repos":"mnmtanish\/vosco-cli","old_file":"script.litcoffee","new_file":"script.litcoffee","new_contents":"Dependencies\n============\n\n    fs   = require \"fs\"\n    path = require \"path\"\n\nVOSCO\n=====\n\n    script = {}\n\nSetup\n-----\n\n    script.install = (args) ->\n      # check whether a previous installation exists\n      # show warning message and exit if it does\n      # \"-f\" flag can be used to force installation\n      console.log \"installing VOSCO\"\n\n    script.uninstall = (args) ->\n      console.log \"removing VOSCO\"\n\nRepository\n----------\n\n    script.status = (args) ->\n      console.log \"status\"\n\n    script.history = (args) ->\n      console.log \"history\"\n\n    script[\"content-history\"] = (args) ->\n      # show warning if file doesn\"t exist\n      console.log \"content history\"\n\nSnapshots\n---------\n\n    script.preview = (args) ->\n      console.log \"preview snapshot\"\n\n    script.snapshot = (args) ->\n      console.log \"creating snapshot\"\n\n    script.rollback = (args) ->\n      console.log \"rollback to snapshot\"\n\nBranches\n--------\n\n    script[\"list-branches\"] = (args) ->\n      console.log \"branches list\"\n\n    script[\"select-branch\"] = (args) ->\n      console.log \"select branch\"\n\n    script[\"create-branch\"] = (args) ->\n      console.log \"create new branch\"\n\n    script[\"delete-branch\"] = (args) ->\n      console.log \"delete branch\"\n\nExport Module\n-------------\n\n    module.exports = (vosco) ->\n      script.vosco = vosco\n      return script\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'script.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"6c10cdbffffb67ffb3033f818a4fec6659fb3f28","subject":"trying out literate coffeescript","message":"trying out literate coffeescript\n","repos":"NetsydeMiro\/nedeme,NetsydeMiro\/nedeme","old_file":"src\/Utility.litcoffee","new_file":"src\/Utility.litcoffee","new_contents":"# Utility.litcoffee\n\nCan import any external dependencies here, so that other source files don't require them.\nIn this way we can also factor them out later.\n\n  define ['jquery'], -> \n\nUtility class for shared functionality in the form of static methods. \nAlso, we should add external library dependant code here, so that it can easiy be factored out later if desired.\n\n    class Utility\n\nMethod to generate a guid.\nAdapted from broofa's answer here: http:\/\/stackoverflow.com\/questions\/105034\/create-guid-uuid-in-javascript\n\n      @guid: -> \n        'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace \/[xy]\/g, (c) ->\n          r = Math.random()*16|0\n          v = if c is 'x' then r else (r&0x3|0x8)\n          v.toString(16)\n\nAdds attributes to markup.\n\n      @addAttributes: (markup, obj) -> \n        $markup = $ markup\n        for prop, val of obj\n          $markup.attr prop, val\n        $('<div><\/div>').append($markup).html()\n\nWrapper for jQuery's ultra useful extend method.\n\n      @extend: -> \n        $.extend.apply null, arguments\n\nUtility method to be bolted onto a hierarchical object.\nHierarchical object requires a parent property, that holds a reference to its parent (if present).\nReturns a list representing an ancestor branch (from eldest to youngest, the youngest being the object itself)\n\n      @ancestorBranch: -> \n        if not @parent\n          [this]\n        else\n          result = Utility.ancestorBranch.call(@parent)\n          result.push this\n          result\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'src\/Utility.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e139dc4266bc97bd6502ec5a2b691d64ef891d4c","subject":"Added a minimal pose helpers module.  Will include interpolation, transforms, etc. later.","message":"Added a minimal pose helpers module.  Will include interpolation,\ntransforms, etc. later.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat","old_file":"src\/pose.litcoffee","new_file":"src\/pose.litcoffee","new_contents":"# pose\n\nA pose is an object where the keys are names of bones, and the values are\nmatrices positioning those bones.\n\n    matrix = require \".\/matrix.litcoffee\"\n\n## create\n\n- A skeletal .msc file's .coffee file.\n\nReturns a new pose object containing the original \"idle\" pose of the cloud.\n\n    create = (cloud) ->\n        output = {}\n        for bone in cloud.bones\n            output[bone.name] = []\n            matrix.copy bone.transform, output[bone.name]\n        output\n        \n## copy\n\n- A pose to copy from.\n- A pose to copy to.\n\nCopies all matrices from the input pose to the output pose.  Assumes all bone\nnames are the same.\n\n    copy = (input, output) ->\n        for key, value of input\n            matrix.copy value, output[key]\n        return\n        \n    module.exports = { create, copy }","old_contents":"","returncode":1,"stderr":"error: pathspec 'src\/pose.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e19681efd91bda2e7ebb772cca7579a276541087","subject":"Added new validator","message":"Added new validator\n","repos":"bsgbryan\/jyn","old_file":"lib\/file_exists.litcoffee","new_file":"lib\/file_exists.litcoffee","new_contents":"    Madul = require 'madul'\n\n    class FileExists extends Madul\n\n      deps: [ 'fs' ]\n\n      EXECUTE: (name, value, done, fail) ->\n        @fs.stat value, (_, stats) =>\n          return fail(\"#{name} file not found\") unless stats.isFile()\n\n          done()\n\n    module.exports = FileExists\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'lib\/file_exists.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8c85b291d3b863435302a4173c1bec158fb3e0f6","subject":"document Batman.StateMachine","message":"document Batman.StateMachine\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/16_state_machine.litcoffee","new_file":"docs\/16_state_machine.litcoffee","new_contents":"# \/api\/Data Structures\/Batman.StateMachine\n\n`Batman.StateMachine` implements the [finite-state machine](http:\/\/en.wikipedia.org\/wiki\/Finite-state_machine) model. In batman.js, it is used to track a record's lifecycle. To use `Batman.StateMachine`, extend it and define a transition table with `@transitions`. For example:\n\n    test 'StateMachine defines valid transitions', ->\n      class BatsuitStateMachine extends Batman.StateMachine\n        @transitions\n          removeSuit:\n            from: ['wearingPants', 'wearingShoes']\n            to: 'unsuited'\n          putOnPants:\n            from: ['unsuited']\n            to: 'wearingPants'\n          putOnShoes:\n            from: ['wearingPants']\n            to: 'wearingShoes'\n\n      ok BatsuitStateMachine::putOnShoes, \"Transition names are prototype functions\"\n\n      batsuit = new BatsuitStateMachine('unsuited')\n      equal batsuit.get('state'), 'unsuited', \"It starts with the provided state\"\n      equal batsuit.get('isUnsuited'), true, \"State names are accessors with 'is'\"\n      equal batsuit.get('isWearingShoes'), false, \"State names are accessors with 'is'\"\n\n      equal batsuit.putOnPants(), true, \"Successful transitions return true\"\n\n      batsuit = new BatsuitStateMachine('unsuited')\n      equal batsuit.putOnShoes(), false, \"Don't put on your shoes before putting on your pants!\"\n\n## ::constructor(startState : String) : StateMachine\n\nReturns a new `StateMachine` in state `startState`.\n\n## @transitions(transitionTable : object)\n\nDefines the transition table for the `StateMachine`. Each key-value pair of `transitionTable` defines an input event for the `StateMachine`. It should have the form:\n\n```coffeescript\nclass StateMachineSubclass extends Batman.StateMachine\n  @transitions\n    inputEvent:\n      from: [\"startingState\", \"otherStartingState\"] # any number of valid starting states\n      to: \"endingState\"\n```\n\nFor each input event in `transitionTable`, prototype function `inputEvent` is created. Given `StateMachine` instance `stateMachineInstance`, calling `stateMachineInstance.inputEvent()` tries to transition from `stateMachineInstance`'s current state to the `to` state defined in `transitionTable`. The transition is successful if `stateMachineInstance.state` is a member of `inputEvent`'s `from` states in `transitionTable`. It returns `true` if the transition was successful, otherwise it returns false. For example:\n\n```coffeescript\nstateMachineInstance = new StateMachineSubclass('startingState')\nstateMachineInstance.get('state') # => 'startingState'\nstateMachineInstance.inputEvent() # => true\nstateMachineInstance.get('state') # => 'endingState'\nstateMachineInstance.inputEvent() # => false, because 'endingState' not in ['startingState', 'otherStartingState']\n```\n\n `StateMachine` doesn't automatically throw [`StateMachine.InvalidTransitionError`](\/docs\/api\/batman.statemachine.invalidtransitionerror.html)s.\n\nFor each state defined in `from` and `to`, an `\"is#{capitalize(state)}\"` accessor is available on the `StateMachine` which returns `true`, `false`, or `undefined`. For example:\n\n```coffeescript\nstateMachineInstance.get('state')              # => 'endingState'\nstateMachineInstance.get('isEndingState')      # => true\nstateMachineInstance.get('isStartingState')    # => false\nstateMachineInstance.get('isUnspecifiedState') # => undefined\n```\n\n## ::.transitionTable : object\n\nReturns a representation of the `StateMachine`'s transition table. For example, an instance of `BatsuitStateMachine` above would return:\n\n```coffeescript\nremoveSuit:\n  wearingPants: \"unsuited\"\n  wearingShoes: \"unsuited\"\nputOnPants:\n  unsuited: \"wearingPants\"\nputOnShoes:\n  wearingPants: \"wearingShoes\"\n```\n\n## ::%state\n\nReturns the current state of the `StateMachine`.\n\n# \/api\/Data Structures\/Batman.StateMachine\/Batman.StateMachine.InvalidTransitionError\n\n`Batman.StateMachine.InvalidTransitionError` should be thrown when a state machine makes an invalid transition. [`Batman.StateMachine`](\/docs\/api\/batman.statemachine.html) doesn't throw these errors automatically, but applications of the `StateMachine` may throw them. For example [`Batman.Model`](\/docs\/api\/batman.model.html) throws an `InvalidTransitionError` when `save` is called on a deleted record.\n\n## ::constructor(errorMessage : String) : InvalidTransitionError\n\nReturns a new `Batman.StateMachine.InvalidTransitionError` with message `errorMessage`.\n\n# \/api\/Data Structures\/Batman.StateMachine\/Batman.DelegatingStateMachine\n\n`Batman.DelegatingStateMachine` adds a simple feature to [`Batman.StateMachine`](\/docs\/api\/batman.statemachine.html). `DelegatingStateMachine` is initalized with a `base` object and when an event is fired on `DelegatingStateMachine`, it fires the same event on the `base`. For an example of `DelegatingStateMachine`, see `Batman.Model.InstanceLifecycleStateMachine` in the [batman.js source](https:\/\/github.com\/batmanjs\/batman\/blob\/master\/src\/model\/model.coffee#L228).\n\n## ::constructor(startState : String, base : Batman.Object) : DelegatingStateMachine\n\nReturns a new `Batman.DelegatingStateMachine` in state `startState` and delegating to `base`.\n\n## ::fire(eventName : String)\n\nFires `event` on the `DelegatingStateMachine` and on the `base`.\n\n\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'docs\/16_state_machine.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"64d19ea1d7c19a7877b33ec0b9c283ea29202c8f","subject":"made headers easier to read","message":"made headers easier to read\n","repos":"curlee\/Appnostic","old_file":"src\/Manifest.litcoffee","new_file":"src\/Manifest.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/curlee\/Appnostic.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"8390198af5854f6247afbbf5597187fd8111555a","subject":"Add explanation to push method in spectre.litcoffee","message":"Add explanation to push method in spectre.litcoffee\n","repos":"Spectre\/spectre-web","old_file":"spectre.litcoffee","new_file":"spectre.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Spectre\/spectre-web.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ecd2b9c0a8b57f306336f7efbed65e69ea243d1a","subject":"fixed gulp build","message":"fixed gulp build\n","repos":"curlee\/Appnostic","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/curlee\/Appnostic.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"eea6c3d007db7a3660b31bafe7a7d9c6c53bbd8c","subject":"Fix path","message":"Fix path\n","repos":"Piot\/boardgamedb","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d546795ae421096442ed357660a51f7634f47fe9","subject":"suppress redundant error message during cli error catch block","message":"suppress redundant error message during cli error catch block\n","repos":"saintkepha\/yangjs,saintkepha\/yangforge,LiuJinliang\/yangforge,corenova\/yang-forge,opnfv\/yangforge","old_file":"src\/features\/cli.litcoffee","new_file":"src\/features\/cli.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/LiuJinliang\/yangforge.git\/'\n","license":"unknown","lang":"Literate CoffeeScript"}
{"commit":"87bc4fa6d7be432aa7fefe77e55a5831b7d06664","subject":"Move config to API docs","message":"Move config to API docs\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/02b_config.litcoffee","new_file":"docs\/02b_config.litcoffee","new_contents":"# Batman.config\n\n`Batman.config` is a namespace for global batman.js settings. The affect all apps running on the page. Set these values before defining your app. For example:\n\n```coffeescript\nBatman.config.pathToHTML = '\/templates'\nBatman.config.usePushState = false\n\nclass MyApp extends Batman.App\n  # ...\n```\n\n## @pathToApp[=\"\/\"]\n\nUse this if your batman.js app is loaded from a path other than `\/`. For example, if you load your app at `\/app`, you'd use:\n\n```coffeescript\n  Batman.config.pathToApp = '\/app'\n```\n\nAny generated routes will be then be prefixed with `\/app`.\n\n## @pathToHTML[=\"\/html\"`]\n\nIf the app hasn't already loaded the HTML to render a view, it will request the HTML with an AJAX request. `pathToHTML` is used as the prefix for these requests.\n\nThe `Batman.rails` extra sets `Batman.config.pathToHTML= '\/assets\/batman\/html'`.\n\n## @fetchRemoteHTML[=true]\n\nbatman.js automatically fetches a view's HTML if it hasn't been loaded yet. If `fetchRemoteHTML` is false, an error will be thrown instead.\n\n## @usePushState[=true]\n\nSet to `false` to use batman.js's hashbang navigator instead of the (default) `pushState` navigator. Note: the `pushState` navigator automatically degrades to the hashbang navigator if not supported by the browser.\n\n## @protectFromCSRF[=false]\n\nUsed by `Batman.rails`. If `protectFromCSRF` is true, batman.js sends CSRF token as a request header (`X-CSRF-Token`). batman.js uses `metaNameForCSRFToken` to find the correct meta tag.\n\nThe `Batman.rails` extra sets `Batman.config.protectFromCSRF = true`, but you must set it yourself if you're using Rails-style CSRF tokens _without_ the `Batman.rails` extra.\n\n## @metaNameForCSRFToken[=\"csrf-token\"]\n\nIf `protectFromCSRF` is true, the contents of the meta tag with this name will be used as the CSRF token. This default is set in the `Batman.rails` extra.\n\n## @cacheViews[=false]\n\nIf set to true, batman.js will cache `Batman.View` instances between `render` calls. View caching is opt-in [while its implementation is finalized](https:\/\/github.com\/batmanjs\/batman\/issues\/805).\n\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'docs\/02b_config.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"e0fe742de63d5dbe8e8149486a310df22d73bbde","subject":"sidebar coffee","message":"sidebar coffee\n","repos":"romanpitak\/pitak.net,romanpitak\/pitak.net","old_file":"src\/coffee\/sidebar.litcoffee","new_file":"src\/coffee\/sidebar.litcoffee","new_contents":"# Sidebar manipulation\n\n    do (document) ->\n\nFind the elements\n\n        sidebar = document.getElementById 'sidebar'\n        wrap = document.getElementById 'wrap'\n        toggle = document.getElementById 'sidebar-toggle'\n        checkbox = toggle.querySelector 'input'\n\nPreset checkbox state. Without this, the first click does not fire change state.\n\n        checkbox.checked = false\n\nWhen the sidebar is visible, any click outside of the sidebar goes to the checkbox.\n\nThis function is bound to the click event listener in showSidebar()\nand unbound in hideSidebar()\n\n        onPageClick = (e) ->\n            target = e.target\n            return if ! checkbox.checked\n            return if sidebar.contains target\n            return if target == checkbox\n            return if target == toggle\n            checkbox.click()\n\nShow the sidebar\n\n        showSidebar = ->\n            sidebar.style.left = '0px'\n            wrap.style.marginLeft = '280px'\n            toggle.style.left = '300px' # 280 + 20\n            toggle.className = 'active'\n            document.addEventListener 'click', onPageClick, false\n\nHide the sidebar\n\n        hideSidebar = ->\n            sidebar.style.left = '-280px'\n            wrap.style.marginLeft = '0px'\n            toggle.className = ''\n            toggle.style.left = '20px'\n            document.removeEventListener 'click', onPageClick, false\n\nEvent listener for checkbox\n\n        onChangeCheckbox = (event) ->\n            if event.target.checked\n                do showSidebar\n            else\n                do hideSidebar\n\nBind the checkbox event listener\n\n        checkbox.addEventListener 'change', onChangeCheckbox, false\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'src\/coffee\/sidebar.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"d4f865bffe1e9e653a55885a6b4867eb5862e3f4","subject":"Added new render step: PngGrounder","message":"Added new render step: PngGrounder\n\nPngGrounder renders ground blocks to the png image for the level.\n\nIt uses the new `grounder` config param. The `grounder` config param\ndoesn't know\/care where it's being rendered to - it just cares about\ndetermining the height of a ground segment.\n","repos":"bsgbryan\/skyll,bsgbryan\/skyll","old_file":"lib\/render-pipelines\/png\/png_grounder.litcoffee","new_file":"lib\/render-pipelines\/png\/png_grounder.litcoffee","new_contents":"    PngRenderer = require '.\/png_renderer'\n\n    class PngGrounder extends PngRenderer\n\n      do_render: (path) =>\n        ctx = PngRenderer.ctx\n\n        cell_width  = @config.width\n        cell_height = @config.height\n\n        ground_segments = @config.ground.segments\n        segment_width   = 1 \/ ground_segments\n        ground_width    = cell_width * segment_width\n\n        for step, i in path\n          ctx.fillStyle = @config.ground.fill_color\n\n          step.ground = [ ]\n\n          for g in [0...ground_segments]\n            height = @config.grounder step, i, path\n            right  = g * (cell_width * segment_width)\n            left   = (cell_width * step.col) + right\n            top    = (cell_height * (step.row + 1)) - height\n\n            ctx.beginPath()\n            ctx.rect left, top, ground_width, height\n            ctx.fill()\n\n            step.ground.push height: height\n\n    module.exports = PngGrounder\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'lib\/render-pipelines\/png\/png_grounder.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"dd6e9c8f01a258c2d7d51c40f72bc1f064e0f587","subject":"Update docs","message":"Update docs\n","repos":"Piot\/boardgamedb","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"ef21cd001ec9aff1499c0ae4f61daa6a8998ef49","subject":"document Batman.ModelPaginator","message":"document Batman.ModelPaginator\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/24_paginator.litcoffee","new_file":"docs\/24_paginator.litcoffee","new_contents":"# \/api\/Extras\/Batman.Paginator\n\n`Batman.Paginator` is an abstract class which is implemented by `Batman.ModelPaginator`. For information about paginating records, see `Batman.ModelPaginator`.\n\n\nInternally, `Batman.Paginator` prevents loading the same page twice.\n\n## ::constructor(options={}) : Paginator\n\nReturns a new paginator, mixing in `options`. `options` may include:\n\n- `limit`\n- `offset` or `page`\n- `totalCount`\n\n## ::loadItemsForOffsetAndLimit(offset, limit)\n\nImplementations of `Batman.Paginator` must implement this function. See `Batman.ModelPaginator` for an example.\n\nThis function should load items, then call `@updateCache(offset, limit, items)`.\n\nInternally, `Batman.Paginator`:\n\n- prevents reloading a page when it's still loading\n- prevents loading a page twice\n\n## ::%toArray : Array\n\nReturns an array of items in the current `page`. This property depends on `offset` and `limit`, so changing `offset`, `limit` or `page` will automatically update `toArray`.\n\n## ::nextPage()\n\nIncrements the current `page`, causing `toArray` to be updated.\n\n## ::previousPage()\n\nDecrements the current `page`, causing `toArray` to be updated.\n\n## ::%page : Number\n\nCurrent page number, determined by `offset` and `limit`. Setting `page` automatically increases `offset`.\n\nSince `toArray` depends on `offset`, setting `page` will also cause `toArray` to be updated.\n\n## ::%offset : Number\n\nNumber of items skipped for the current `page`.\n\n## ::%limit : Number\n\nItems per page.\n\n## ::%totalCount : Number\n\nTotal number of records covered by the `Paginator`.\n\n## ::%pageCount : Number\n\nTotal number of pages covered by the `Paginator`, calculated from `totalCount` and `limit`.\n\n## ::updateCache(offset, limit, items)\n\nRegisters `items` as the items from `offset` for `limit`. This should be called by `loadItemsForOffsetAndLimit` to inform the paginator of loaded records.\n\n# \/api\/Extras\/Batman.Paginator\/Batman.ModelPaginator\n\n`Batman.ModelPaginator` is a concrete implementation of `Batman.Paginator`. It may be used for paginating `Batman.Model` instances.\n\nA `Batman.ModelPaginator` provides pagination by:\n\n- Taking `model`, `limit`, `params`, and `page`\/`offset` as input\n- Exposing records by its `toArray` property (eg, `paginator.get('toArray')`)\n\n## Using Batman.ModelPaginator\n\nAdd a paginator to your controller:\n\n```coffee\nclass App.PostsController extends Batman.Controller\n  index: -> # renders posts\/index.html\n    @set 'paginator, new Batman.ModelPaginator\n      model: App.Post\n      limit: 10\n      page: 1\n      params: {order: \"created_at\"}\n```\n\nThen, bind to it in your HTML:\n\n```html\n<ul>\n  <li data-foreach-post='paginator.toArray'>\n    <span data-bind='post.name'><\/span>\n  <\/li>\n<\/ul>\n<button data-event-click='paginator.previousPage'>Prev<\/button>\n<button data-event-click='paginator.nextPage'>    Next<\/button>\n```\n\n\n## ::constructor(options) : ModelPaginator\n\nBesides the options passed to `Batman.Paginator`, you may also pass:\n\n- `model`: A `Batman.Model` class whose records are paginated\n- `params` : A plain JS object which will be used when loading items from the server\n\n## ::loadItemsForOffsetAndLimit(offset, limit)\n\nLoads records by calling `@model.load` with:\n\n- any key\/values passed as `@params`\n- `offset` and `limit`\n\n## ::.params : Object\n\nA plain JavaScript object whose key-value pairs will be passed to `@model.load` when loading records.\n\n## ::.model : Class\n\nA `Batman.Model` subclass whose records are paginated by the `ModelPaginator`.\n\n\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'docs\/24_paginator.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"85e338d0c5cda6a5581a7fb2bba03f0869ae8105","subject":"Added more test coverage","message":"Added more test coverage\n","repos":"merciba\/ecrit,merciba\/ecrit","old_file":"test\/controllers\/users.litcoffee","new_file":"test\/controllers\/users.litcoffee","new_contents":"### Users Controller Test\n\nUnit tests for the `users` controller. Any new methods added to `\/server\/controllers\/users` should have matching tests here. \n\n\tfs = require 'fs'\n\tpath = require 'path'\n\tcolors = require 'colors'\n\tmoment = require 'moment'\n\tchai = require 'chai'\n\tchai.should()\n\ttestConfig = require '..\/config.json'\n\nCreate mock server objects to pass through the tests\n\n\treq = {\n\t\tparams: {}\n\t\tbody: {}\n\t}\n\tres = {}\n\tapp = {\n\t\tdialog: (str) -> console.log str.green if testConfig.console\n\t\tlog: (str) -> console.log str.cyan if testConfig.console\n\t\terror: (str) -> throw new Error str.red if testConfig.console\n\t\twarn: (str) -> console.warn \"[Warning]\".yellow, str.yellow if testConfig.console\n\t\tmodels: {}\n\t\tdata_config: {}\n\t}\n\nAssign the controller\n\n\tcontroller = require(\"..\/..\/factory\/server\/controllers\/users\")(app)\n\nBegin tests.\n\n\tdescribe 'controllers.users', () ->\n\n#### [create_new_user](https:\/\/github.com\/merciba\/ecrit\/blob\/master\/factory\/server\/controllers\/users.litcoffee#create_new_user)\n\t\t\n\t\tit 'create_new_user', (done) ->\n\n__Scenario:__ `req.body.user` matches [User model](https:\/\/github.com\/merciba\/ecrit\/blob\/master\/factory\/server\/models\/User.litcoffee)  \n__Should:__ Display the time, method and original URL if `ecrit test` is invoked with the `--console` flag.\n\t\t\t\n\t\t\tscenario_one = () ->\n\n\t\t\t\treq.body.user = {\n\t\t\t\t\tid: 'id'\n\t\t\t\t}\n\t\t\t\tapp.models.users = {\n\t\t\t\t\tcreate: (query, next) ->\n\t\t\t\t\t\tquery.should.have.property 'id'\n\t\t\t\t\t\tnext null, query\n\t\t\t\t\tattributes: require('..\/..\/factory\/server\/models\/User').attributes\n\t\t\t\t}\n\n\t\t\t\tcontroller.create_new_user req, res, done\n\n\t\t\tscenario_one()","old_contents":"","returncode":1,"stderr":"error: pathspec 'test\/controllers\/users.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"61fcd6d60997abdc64c6a653eb6e1faa56803ec8","subject":"document association proxies","message":"document association proxies\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/03_app_internals\/24d_association_proxies.litcoffee","new_file":"docs\/03_app_internals\/24d_association_proxies.litcoffee","new_contents":"# \/api\/App Internals\/Batman.AssociationProxy\n\n`Batman.AssociationProxy` extends `Batman.Proxy`. It's an abstract class. To implement it, a class must define:\n\n- `::fetchFromLocal`\n- `::fetchFromRemote`\n\nThese functions are used by `::fetch` to find the associated record.\n\n## ::constructor(@assciation, @model) : AssocationProxy\n\nReturns a new proxy, but doesn't set `target` because that's set by `::fetch`.\n\n## ::toJSON()\n\nDelegates to `target`, if present.\n\n## ::save()\n\nDelegates to `target`, if present.\n\n## ::transaction()\n\nDelegates to `target`, if present.\n\n## ::validate()\n\nDelegates to `target`, if present.\n\n## ::destroy()\n\nDelegates to `target`, if present.\n\n## ::load(callback)\n\nFetches the record, then passes `(err, record)` to `callback`.\n\n## ::loadFromLocal()\n\nReturns `target` if it can fetch it locally.\n\n## ::fetch(callback)\n\nFetches the record by trying `fetchFromLocal` then `fetchFromRemote`. Passes `(err, record)` to `callback`.\n\n## ::%loaded : Boolean\n\nSet to `true` when batman.js determines that the `target` has been loaded.\n\n## ::%target : Model\n\nReturns the target by calling `fetchFromLocal`.\n\n# \/api\/App Internals\/Batman.BelongsToProxy\n\n`Batman.BelongsToProxy` extends `Batman.AssociationProxy`. It is the return value of `@belongsTo` associations' `get` accessors.\n\n## ::%foreignValue\n\nReturns the value for `@assocation.foreignKey` for `@model`.\n\n## ::fetchFromLocal() : Model\n\nLooks up `foreignValue` in `@association.setIndex()`.\n\n## ::fetchFromRemote(callback)\n\nLoads the record from storage using:\n\n- `foreignValue` and the primary key\n- `@association.options.recordUrl` if it was passed\n\n# \/api\/App Internals\/Batman.HasOneProxy\n\n`Batman.HasOneProxy` extends `Batman.AssociationProxy`. It is the return value of `@hasOne` associations' `get` accessors __if__ the record hasn't been loaded yet.\n\n## ::%primaryValue\n\nGets the value of `@association.primaryKey` from `@model`\n\n## ::fetchFromLocal() : Model\n\nLooks up `primaryValue` on `@association.setIndex()`\n\n## ::fetchFromRemote(callback)\n\nLoads the record from storage using:\n\n- `primaryValue` as a request parameter\n- `@assocation.options.url` as the request URL, if provided\n\nIt expects the URL to return an array of records. The first one will be treated as the related record for this association.\n\nPasses `(err, record)` to `callback`.\n\n# \/api\/App Internals\/Batman.PolymorphicBelongsToProxy\n\n`Batman.PolymorphicBelongsToProxy` extends `Batman.BelongsToProxy`. It is the return value of `@belongsTo as \"...\"` associations.\n\n## ::%foreignTypeValue\n\nGets `@association.foreignTypeKey` from `@model`.\n\n## ::fetchFromLocal() : Model\n\nLooks up a record using `foreignValue` and `foreignTypeValue`.\n\n## ::fetchFromRemote(callback)\n\nLoads the record from storage using:\n\n- `@assocations.options.url` as the URL, if provided.\n\nPasses `(err, record)` to `callback`.\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'docs\/03_app_internals\/24d_association_proxies.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"1d596953f4d30912fa3845fc8daa4b711c8f29f7","subject":"Initial commit.\ud83c\uddee\ud83c\uddf3","message":"Initial commit.\ud83c\uddee\ud83c\uddf3\n\nAXIX\u00ae - https:\/\/github.com\/AXIX and Our thoughts inspired - by Albert Einstein.","repos":"ITDB\/ITDB,ITDB\/ITDB,ITDB\/ITDB,ITDB\/ITDB,ITDB\/ITDB","old_file":"source\/core\/scss\/AXIX\/readme.litcoffee","new_file":"source\/core\/scss\/AXIX\/readme.litcoffee","new_contents":"CodeBook of AXIX<sup>\u00ae<\/sup>\n--------------------------------\nAXIX\u00ae - https:\/\/github.com\/AXIX\n\n<i>The most beautiful thing we can experience is the mysterious. It is the source of all true art and science<\/i> - <b>Albert Einstein<\/b>.\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'source\/core\/scss\/AXIX\/readme.litcoffee' did not match any file(s) known to git\n","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"533f190105c356966e8538b3e913d4bbb367296b","subject":"Implemented a module for creating and querying planes in 3D space.","message":"Implemented a module for creating and querying planes in 3D space.\n","repos":"jameswilddev\/WalkingSimulator,jameswilddev\/WalkingSimulator,jameswilddev\/MasSplat,jameswilddev\/MasSplat","old_file":"src\/plane.litcoffee","new_file":"src\/plane.litcoffee","new_contents":"A plane is an object containing:\n\n- normal: A vector specifying the facing direction of the plane.\n- distance: A number specifying how far from 0, 0, 0 along the normal the plane \n            is.\n            \nExports an object.\n\n    vector = require \".\/vector.litcoffee\"\n    tempA = []\n    tempB = []\n\nCall the \"fromTriangle\" property with three input vectors forming a clockwise \ntriangle and an output object to create a plane on which those three vectors \nlie.  If the output object is undefined, an empty one is created.  The output \nobject is returned.\n\n    fromTriangle = (a, b, c, output) ->\n        output = output or {}\n        output.normal = output.normal or []\n        vector.subtract.vector a, b, tempA\n        vector.subtract.vector a, c, tempB\n        vector.cross tempA, tempB, output.normal\n        vector.normalize output.normal, output.normal\n        output.distance = vector.dot output.normal, a\n        output\n            \nCall the \"distance\" property with a plane and a vector.  The distance between\nthe plane and vector is returned.  If the vector is behind the plane, the\ndistance is negative.\n\n    distance = (plane, input) -> (vector.dot plane.normal, input) - plane.distance\n    \nCall the \"project\" property with a plane, input vector and output vector to\nwrite the nearest point to the input vector on the plane to the output vector.\n    \n    project = (plane, input, output) ->\n        dist = distance plane, input\n        vector.multiply.scalarBy dist, plane.normal, tempA\n        vector.subtract.vector input, tempA, output\n        return\n    \n    module.exports = {\n        fromTriangle\n        distance\n        project\n    }","old_contents":"","returncode":1,"stderr":"error: pathspec 'src\/plane.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"7947aa083909b7bcc8f1a1b125333a5a7f722798","subject":"cleaned up docs for manifest","message":"cleaned up docs for manifest\n","repos":"curlee\/Appnostic","old_file":"src\/Manifest.litcoffee","new_file":"src\/Manifest.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/curlee\/Appnostic.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"457d951b74ac8f69e6289a70004caf624ffa76d1","subject":"cleanup","message":"cleanup\n","repos":"nickfargo\/restate","old_file":"src\/state.litcoffee","new_file":"src\/state.litcoffee","new_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneMethods    _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneMethods = ( methods ) ->\n          return unless methods?\n          ( out = {}; break ) for name of methods\n          if out then for name, method of methods\n            out[ name ] = if method.isLexicalStateMethod\n            then method.factory\n            else method\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: `createAccessor`\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: `set`\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method held on this state. If no method is found, move up\nthis state\u2019s protostate chain to find one. If no method is found there, move up\nthe superstate chain and repeat the search.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out ) ->\n        if ( method = @_?.methods?[ methodName ] ) and method isnt rootNoop\n          if out? then out.context = this; out.method = method\n          return method\n\n        if viaProto = via & VIA_PROTO and\n            method = @protostate()?.method methodName, VIA_PROTO, out\n          out?.context = this\n          return method\n\n        if via & VIA_SUPER and\n            method = @superstate?.method methodName, VIA_SUPER | viaProto, out\n          return method\n\n        if out? then out.context = null; out.method = method\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state, which will be callable directly from the owner,\nbut with its context bound to the state.\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn, raw ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` holds a lexical state method, then extract the wrapped method, unless\nexplicitly ordered to regard the function in its `raw` form.\n\n        fn = fn this if not raw and fn.isLexicalStateMethodFactory\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root.method methodName, VIA_NONE\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n\nThe owner method must be added to the root state in its \u201craw\u201d form, i.e., not\nlexically transformed by `state.method`.\n\n            root.addMethod methodName, ownerMethod, yes\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context. If the method\nwas originally defined in the owner, the context will be the owner. Otherwise,\nthe context will either be the state in which the method is defined, or if the\nimplementation resides in a protostate, the corresponding state belonging to\nthe inheriting owner. If the named method does not exist locally and cannot be\ninherited, a `noSuchMethod` event is emitted and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n        out = method: undefined, context: undefined\n        unless method = @method methodName, null, out\n          @emit 'noSuchMethod', [ methodName, args ]\n          @emit 'noSuchMethod:' + methodName, args\n          return\n        { context } = out\n        { owner } = this\n        ownerMethod = owner[ methodName ]\n        context = owner if ownerMethod?.original and context is @root\n        method.apply context, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic `apply`.\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n`addEvent`.\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","old_contents":"## [State](#state)\n\n> [State](\/api\/#state)\n\n    class State\n\nBit field constants will be used extensively throughout the class\u2019s constructor\nand methods, so make them available as free variables.\n\n      {\n        NORMAL\n        INCIPIENT, ATOMIC, DESTROYED\n        VIRTUAL\n        MUTABLE, FINITE, STATIC, IMMUTABLE\n        INITIAL, CONCLUSIVE, FINAL\n        ABSTRACT, CONCRETE, DEFAULT\n        REFLECTIVE\n        HISTORY, RETAINED, SHALLOW\n        CONCURRENT\n      } =\n          O.assign this, STATE_ATTRIBUTES\n\nFor methods that query related states, the default behavior is to recurse\nthrough substates, superstates, and protostates.\n\n      { VIA_NONE, VIA_SUB, VIA_SUPER, VIA_PROTO, VIA_ALL } =\n          O.assign this, TRAVERSAL_FLAGS\n\nPrecompute certain useful attribute combinations.\n\n      MUTABLE_OR_FINITE     = MUTABLE | FINITE\n      ABSTRACT_OR_CONCRETE  = ABSTRACT | CONCRETE\n      INCIPIENT_OR_VIRTUAL  = INCIPIENT | VIRTUAL\n      INCIPIENT_OR_MUTABLE  = INCIPIENT | MUTABLE\n\nA bit mask indicates the attributes that can be inherited via protostates.\n\n      PROTO_HERITABLE_ATTRIBUTES =\n        MUTABLE     |  FINITE      |  STATIC     |  IMMUTABLE  |\n        INITIAL     |  CONCLUSIVE  |  FINAL      |\n        ABSTRACT    |  CONCRETE    |  DEFAULT    |\n        REFLECTIVE  |\n        HISTORY     |  RETAINED    |  SHALLOW    |\n        CONCURRENT\n\n\n\n\n### [Supporting classes](#state--supporting-classes)\n\nThese are keyed here for shape order, and will be valued by the respective\nconstructors after they are created.\n\n      Expression: null\n      Content: null\n\n\n\n### [Constructor](#state--constructor)\n\n      constructor: ( base, @name, expression ) ->\n\nThe `base` argument can specify either a `superstate` from which to inherit,\nor an `owner` for which to act as a new `root` state.\n\n        if base instanceof State\n          @superstate = superstate = base\n          @root = root = superstate.root\n          @owner = owner = root.owner\n        else\n          @superstate = superstate = null\n          @root = root = this\n          @owner = owner = base\n\n###### Attribute inheritance masking\n\nExplicitly defined *literal* attributes for `this` state are encoded as a bit\nfield integer within `expression`, and then superimposed atop the *inherited*\nattribute values acquired from `this` state\u2019s superstate and protostate.\n\n        attributes = expression?.attributes or NORMAL\n\nThe `mutable` and `finite` attributes can be inherited from the superstate\nstraight away.\n\n        if superstate\n          superAttr = superstate.attributes\n          attributes |= superAttr & MUTABLE_OR_FINITE\n\nA subset of the attributes may be inherited from protostates.\n\n        if protostate = @protostate()\n\n          protoAttr = protostate.attributes & PROTO_HERITABLE_ATTRIBUTES\n\nLiteral `concrete` forcibly contradicts literal `abstract`; if a bad production\nincludes both attributes, negate `abstract`.\n\n          attributes &= ~ABSTRACT if attributes & CONCRETE\n\nLiteral `abstract` may override inherited `concrete`, and vice versa, so filter\nthose attributes out of the protostate before inheriting.\n\n          if attributes & ABSTRACT_OR_CONCRETE\n            protoAttr &= ~ABSTRACT_OR_CONCRETE\n          attributes |= protoAttr\n\nIf at this point the state is not `abstract`, then `concrete` must be imposed.\n\n        attributes |= CONCRETE if ~attributes & ABSTRACT\n\nLiteral or inherited `immutable` contradicts `mutable` absolutely, and implies\n`finite`.\n\n        attributes |= ( superAttr | protoAttr ) & IMMUTABLE\n        if attributes & IMMUTABLE\n          attributes &= ~MUTABLE\n          attributes |= FINITE\n\n        @attributes = attributes\n\n###### Offloaded initialization\n\n        @initialize expression unless attributes & VIRTUAL\n\n\nAdditional property assignments for easy viewing in the inspector.\n\n        if O.env.debug\n          @[' <path>']       = @path()\n          @['<attributes>']  = StateExpression.decodeAttributes attributes\n\n\n\n### [Class-private](#state--private)\n\n\n#### [createDispatcher](#state--private--create-dispatcher)\n\nFor each method defined in any of the owner\u2019s states, a **dispatcher** must be\ncreated and assigned on the owner itself at the `methodName` key. Calls to\n`owner.methodName` are then delegated by the dispatcher to the owner\u2019s current\nstate, from which the appropriate implementation for the method will be located\nand applied, and its result returned back to the original caller.\n\nWhen `addMethod` is called, if an identically named method is already present\non the owner, that function is added as a method of the owner\u2019s root state. In\nthis way the owner\u2019s original implementation remains accessible as the \u201cdefault\nbehavior\u201d should no current or active state contain an implementation for that\nmethod.\n\nStateful methods are applied in the context of the `State` to which they\nbelong, or, if a method is inherited from a protostate, the context will be the\ncorresponding virtual state in the local state tree. For methods relocated to\nthe root state as described above, however, the context appropriately remains\nbound to the owner object.\n\n> [Dispatchers](\/docs\/#concepts--methods--dispatchers)\n\n      createDispatcher = do ->\n        toString = -> \"[dispatcher]\"\n        ( accessorName, methodName, original ) ->\n          dispatcher = -> @[ accessorName ]().apply methodName, arguments\n          dispatcher.isDispatcher = yes\n          dispatcher.toString = toString if O.env.debug\n          dispatcher.original = original if original\n          dispatcher\n\n\n\n### [Ontological methods](#state--ontological-methods)\n\n\n#### [initialize](#state--prototype--initialize)\n\nBuilds out the state\u2019s members based on the expression provided.\n\n> See also:\n> `Constructor`\n\n      initialize: ( expression ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n\n        @attributes |= INCIPIENT\n        @realize expression\n        @attributes &= ~INCIPIENT\n        @emit 'construct', expression, VIA_PROTO\n        this\n\n\n#### [realize](#state--prototype--realize)\n\nTransforms an incipient or virtual `State` into a real state.\n\nMuch of the initialization for `State` is offloaded from the constructor,\nallowing for creation of lightweight virtual `State` instances that inherit all\nof their functionality from protostates, but can also be converted at some\nlater time to a real `State` if necessary.\n\n> See also:\n> `initialize`\n> `virtualize`\n\n      realize: ( expression ) ->\n        return this unless @attributes & INCIPIENT_OR_VIRTUAL\n\n        @_ or = new @Content\n        @mutate expression\n\nRealizing a root state requires that, for each of the owner\u2019s own methods, if\nthere exists at least one stateful implementation of that method located higher\nin the owner\u2019s prototype chain, then the owner\u2019s implementation of that method\nmust be copied into the root, where it defines the owner\u2019s default behavior.\n\n        if this is @root\n          for own key, method of @owner when typeof method is 'function' and\n              not method.isDispatcher and @method key, VIA_PROTO\n            @addMethod key, method\n\n        this\n\n\n#### [virtualize](#state--prototype--virtualize)\n\nCreates, if necessary, a virtualized **epistate** of `this` protostate within\nthe state tree to which `inheritor` belongs, and also creates as many virtual\nancestor superstates as necessary to reach a real `State` within that tree.\n\nReturns the state on `inheritor`\u2019s state tree for which `this` is a protostate.\nThis will be the newly created virtual state, unless virtualization was\nunnecessary, in which case it will be the extant real epistate of `this`.\n\n> [Protostates](\/docs\/#concepts--inheritance--protostates)\n\n      virtualize: ( inheritor ) ->\n\nVerify that `inheritor`\u2019s owner does indeed inherit from the owner of `this`.\n\n        return null unless inheritor instanceof State and\n          @owner.isPrototypeOf inheritor.owner\n\nGet the `derivation` list for `this`.\n\n        return null unless ( derivation = @derivation yes ).length\n\nTraverse the real states of the inheriting state tree to their furthest depth.\n\n        i = 0; s = inheritor.root\n        while name = derivation[ i++ ]\n          break unless real = s.substate name, VIA_NONE\n          s = real\n\nIf `derivation` extends beyond the inheriting state tree\u2019s real states, then\nadd virtual states to it until the whole superstate chain is represented.\n\n        expr = attributes: VIRTUAL\n        while name\n          s = new State s, name, expr\n          name = derivation[ i++ ]\n        s\n\n\n#### [destroy](#state--prototype--destroy)\n\nAttempts to cleanly destroy this state and all of its substates. A `destroy`\nevent is issued to each state after it has been destroyed.\n\n> [destroy (method)](\/api\/#state--methods--destroy)\n> [destroy (event)](\/api\/#state--events--destroy)\n\n      destroy: ->\n        { owner, root, superstate, _ } = this\n        { methods, events, substates } = _ if _\n\nIf a transition is underway that involves any state other than the root, then\nthe state cannot be destroyed.\n\n        if transition = root._transition\n          if this is root then do transition.abort\n          else return no if ( transition.origin.isIn( this ) or\n            transition.target.isIn( this ) )\n\nDescendant states are destroyed bottom-up.\n\n        if substates then do substate.destroy for own substate of substates\n\nThe final event emitted is `destroy`.\n\n        @emit 'destroy', VIA_PROTO\n        if events then for key, event of events\n          do event.destroy\n          delete events[ key ]\n\nWhen the root state is destroyed, the owner gets back its original methods, and\nthe corresponding dispatcher for each such method is destroyed, along with the\nowner\u2019s accessor method.\n\n        if this is root\n          if methods then for name, method of methods when owner[ name ]\n            if method = method.original\n            then owner[ name ] = method\n            else delete owner[ name ]\n          delete owner[ @accessorName ]\n\nA non-root state must remove itself from its superstate.\n\n        else\n          superstate.removeSubstate @name\n          @superstate = null\n\nA flag is set that can be observed later by anything retaining a reference to\nthis state (e.g. a memoization) which would be withholding it from being\ngarbage-collected.\n\n        @attributes |= DESTROYED\n\n        yes\n\n\n\n### [Expression and mutation](#state--expression-and-mutation)\n\n\n#### [express](#state--prototype--express)\n\nReturns an **expression** of `this` state \u2014 a data structure that contains an\nexported snapshot of the state\u2019s own contents.\n\nBy default the returned expression is returned as a plain object; if `typed`\nis truthy, the expression is a formally typed `StateExpression`.\n\n      do =>\n        { edit, clone } = O\n\n        @::express = ( typed ) ->\n          if _ = @_ then expression = edit {}, {  # Why `edit`???\n            @attributes\n            data        : cloneCategory   _.data\n            methods     : cloneMethods    _.methods\n            events      : cloneEvents     _.events\n            guards      : cloneCategory   _.guards\n            states      : cloneSubstates  _.substates, typed\n            transitions : cloneCategory   _.transitions\n          }\n          if typed then new @Expression expression else expression\n\n        cloneCategory = ( object ) ->\n          return unless object?\n          ( out = {}; break ) for key of object\n          if out then for key, value of object\n            out[ key ] = if value and typeof value is 'object'\n            then clone value\n            else value\n          out\n\n        cloneMethods = ( methods ) ->\n          return unless methods?\n          ( out = {}; break ) for name of methods\n          if out then for name, method of methods\n            out[ name ] = if method.isLexicalStateMethod\n            then method.factory\n            else method\n          out\n\n        cloneEvents = ( events ) ->\n          return unless events?\n          ( out = {}; break ) for type, emitter of events when emitter\n          for type, emitter of events when emitter\n            out[ type ] = clone emitter.items\n          out\n\n        cloneSubstates = ( substates, typed ) ->\n          return unless substates?\n          ( out = {}; break ) for name of substates\n          for name, substate of substates\n            out[ name ] = substate.express typed\n          out\n\n\n\n#### [mutate](#state--prototype--mutate)\n\nTransactionally mutates `this` state by adding, updating, or removing items as\nspecified by the expression provided in `expr`.\n\n      do =>\n        { NIL, isArray, isEmpty, isPlainObject, edit, diff } = O\n\n        @::mutate = ( expr ) ->\n          { attributes, Expression } = this\n\n          do @realize if attributes & VIRTUAL\n\nBooleans to determine whether mutation of particular categories is permissible;\nall content is mutable for the special case of a state being initialized.\n\n          incipient = attributes & INCIPIENT\n          mutable = incipient or attributes & MUTABLE\n          notStrongImmutable = incipient or not ( attributes & IMMUTABLE )\n\nLoad the category collections.\n\n          { data, methods, events, guards, substates, transitions } = @_\n\nValidate the provided state expression.\n\n          expr = new Expression expr unless expr instanceof Expression\n\nThe `initialize` method uses `mutate` for a real state\u2019s initial build, but\nwith the resultant `mutate` event suppressed.\n\n          before = @express() unless incipient\n\nSince `mutate` is transactional, the `ATOMIC` flag must be used to signal the\nmethods utilized here that add or remove content to temporarily suppress their\nusual emission of a `mutate` event.\n\n          @attributes |= ATOMIC\n\n###### Data\n\nData is already set up to handle differentials that contain `NIL` values.\n\n          @data expr.data if expr.data\n\n###### Methods\n\nMethods are stored as a simple key mapping, and `addMethod` can be used both to\ncreate an entry and to update an existing entry, without any additional\nside-effects, so method expressions can simply be compared against the `NIL`\nvalue.\n\n          if mutable then for own name, method of expr.methods\n            if method isnt NIL\n            then @addMethod name, method\n            else @removeMethod name\n\n###### Events\n\nEvent listeners for a given event type might be expressed as either:\n\n  * a simple `Array` of items to be added;\n  * a plain `Object` that maps items to specific event `id`s in the internal\n    emitter that should be added, updated, or deleted; or\n  * an `Array` that also includes one or more such `Object`s.\n\n          if mutable then for own type, event of expr.events\n            events or = @_.events or = {}\n            emitter = events[ type ]\n            if event is NIL then do emitter?.empty; continue\n\nIf `event` contains items to be added, and an emitter does not already exist\nfor this event type, then one must be created.\n\n            if not emitter and event and not isEmpty event\n              emitter = events[ type ] = new StateEventEmitter this, type\n\n            if isArray event\n            then for element in event when element? and element isnt NIL\n              if isPlainObject element\n              then editEvent element, emitter\n              else @addEvent type, element\n            else editEvent event, emitter if isPlainObject event\n\n            unless emitter.length\n              do emitter.destroy\n              delete events[ type ]\n\n###### Guards\n\nGuards are stored as simple objects, and altering them causes no side-effects,\nso a deep `edit` is sufficient.\n\n          if mutable and expr.guards\n            guards or = @_.guards or = {}\n            edit 'deep', guards, expr.guards\n\n###### Substates\n\nSubstates are instances of `State`, which are either created, destroyed, or\nrecursively updated in place, as specified by `expr.states`.\n\nBy default, a state is **weakly immutable**, in which case its *direct*\ncontents cannot be altered, although any of its substates may yet be mutable,\nso any submutations must therefore still be applied recursively to their\ncorresponding substates.\n\n          if notStrongImmutable then for own name, stateExpr of expr.states\n            if substates and name of substates\n              if stateExpr is NIL\n              then @removeSubstate name\n              else substates[ name ].mutate stateExpr\n            else @addSubstate name, stateExpr if stateExpr isnt NIL\n\n###### Transitions\n\nTransitions, as held by a `State`, are instances of `TransitionExpression`,\nwhich are either created, deleted, or replaced, as specified by\n`expr.transitions`.\n\n          if mutable then for own name, transitionExpr of expr.transitions\n            if transitions and name of transitions\n              if transitionExpr is NIL\n              then delete transitions[ name ]\n              else transitions[ name ] =\n                new TransitionExpression transitionExpr\n            else @addTransition name, transitionExpr if transitionExpr isnt NIL\n\nThe transaction is complete, so clear `ATOMIC` to signal the `add...` methods\nto emit individual `mutate` events as usual.\n\n          @attributes &= ~ATOMIC\n\nFinally the `before` snapshot is used to acquire the `delta` of the mutation,\nwhich is emitted as part of a `mutate` event.\n\n          unless incipient\n            after = @express()\n            delta = diff before, after\n            unless isEmpty delta\n              @emit 'mutate', [ expr, delta, before, after ], VIA_PROTO\n\n          this\n\n        editEvent = ( object, emitter ) ->\n          { items } = emitter\n          for own key, value of object\n            if value is NIL then emitter.remove key\n            else if value and value isnt items[ key ]\n              emitter.set key, value\n\n\n\n\n### [Attributes](#state--attributes)\n\nMethods that inspect a state\u2019s attributes.\n\n> [Attributes](\/docs\/#concepts--attributes)\n> [Attributes](\/api\/#state--attributes)\n\n      isVirtual:     -> !!( @attributes & VIRTUAL )\n      isMutable:     -> !!( @attributes & MUTABLE )\n      isFinite:      -> !!( @attributes & FINITE )\n      isStatic:      -> !!( @attributes & STATIC )\n      isImmutable:   -> !!( @attributes & IMMUTABLE )\n      isInitial:     -> !!( @attributes & INITIAL )\n      isConclusive:  -> !!( @attributes & CONCLUSIVE )\n      isFinal:       -> !!( @attributes & FINAL )\n      isAbstract:    -> !!( @attributes & ABSTRACT )\n      isConcrete:    -> !!( @attributes & CONCRETE )\n      isDefault:     -> !!( @attributes & DEFAULT )\n      isReflective:  -> !!( @attributes & REFLECTIVE )\n      hasHistory:    -> !!( @attributes & HISTORY )\n      isRetained:    -> !!( @attributes & RETAINED )\n      isShallow:     -> !!( @attributes & SHALLOW )\n      isConcurrent:  -> !!( @attributes & CONCURRENT )\n\n\n\n### [Object model](#state--object-model)\n\n\n#### [derivation](#state--prototype--derivation)\n\nReturns a `State` array of this state\u2019s superstate chain, starting after the\nroot state and ending at `this`. If `byName` is set to `true`, a string array\nof the states\u2019 names is returned instead.\n\n> [derivation](\/api\/#state--methods--derivation)\n\n      derivation: ( byName ) ->\n        results = []; ss = this; while ( s = ss ) and ss = s.superstate\n          results.push if byName then s.name or '' else s\n        results.reverse()\n\n\n#### [path](#state--prototype--path)\n\nReturns this state\u2019s fully qualified name.\n\n*Alias:* **toString**\n\n> [path](\/api\/#state--methods--path)\n\n      path: -> @derivation( yes ).join '.'\n      toString: @::path\n\n\n#### [depth](#state--prototype--depth)\n\nReturns the number of superstates this state has. The root state returns `0`,\nits immediate substates return `1`, etc.\n\n> [depth](\/api\/#state--methods--depth)\n\n      depth: ->\n        n = 0; s = this\n        n += 1 while s = s.superstate\n        n\n\n\n#### [common](#state--prototype--common)\n\nReturns the least common ancestor of `this` and `other`. If `this` is itself an\nancestor of `other`, or vice versa, then that ancestor is returned.\n\n> [common](\/api\/#state--methods--common)\n\n      common: ( other ) ->\n        other = @query other unless other instanceof State\n        if @depth() > other.depth() then s = other; other = this else s = this\n        while s\n          return s if s is other or s.isSuperstateOf other\n          s = s.superstate\n        null\n\n\n#### [is](#state--prototype--is)\n\nDetermines whether `this` is `other`.\n\n      is: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this\n\n\n#### [isIn](#state--prototype--isIn)\n\nDetermines whether `this` is or is a substate of `other`.\n\n      isIn: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or other.isSuperstateOf this\n\n\n#### [hasSubstate](#state--prototype--hasSubstate)\n\nDetermines whether `this` is or is a superstate of `other`.\n\n      hasSubstate: ( other ) ->\n        other = @query other unless other instanceof State\n        other is this or @isSuperstateOf other\n\n\n#### [isSuperstateOf](#state--prototype--isSuperstateOf)\n\nDetermines whether `this` is a superstate of `other`.\n\n      isSuperstateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if superstate = other.superstate\n          this is superstate or @isSuperstateOf superstate\n        else no\n\n\n#### [protostate](#state--prototype--protostate)\n\n> [protostate](\/api\/#state--methods--protostate)\n\nReturns `this` state\u2019s **[protostate][]**, the `State` that both:\n\n  1. belongs to the nearest possible prototype of `@owner`; and\n  2. is taxonomically analogous to `this`, the inheriting **epistate**.\n\nIf the owner does not share an analogous [state tree][] with its immediate\nprototype, or if that prototype\u2019s tree does not contain a `State` analogous to\n`this`, then the search is iterated up the owner\u2019s prototype chain.\n\n      protostate: ->\n        return protostate if protostate = @_protostate\n\n        { getPrototypeOf } = O\n        { owner, root } = this\n        { accessorName } = root\n        path = @path()\n\nWalk up the prototype chain, and, starting at each prototype\u2019s root state, use\n`this` state\u2019s `path` to locate the nearest analogous `protostate`. If the\nprotostate is found on the `first` prototype, then a reference to it can be\nmemoized.\n\n        first = prototype = getPrototypeOf owner\n        while prototype\n          if protostate = prototype[ accessorName ]? path, VIA_NONE\n            @_protostate = protostate if prototype is first\n            return protostate\n          prototype = getPrototypeOf prototype\n\n\n#### [isProtostateOf](#state--prototype--is-protostate-of)\n\nDetermines whether `this` is a state analogous to `state` on any object in the\nprototype chain of `state`\u2019s owner.\n\n> [isProtostateOf](\/api\/#state--methods--is-protostate-of)\n\n      isProtostateOf: ( other ) ->\n        other = @query other unless other instanceof State\n        if protostate = other.protostate()\n          this is protostate or @isProtostateOf protostate\n        else no\n\n\n#### [defaultSubstate](#state--prototype--default-substate)\n\nReturns the first substate marked `default`, or simply the first substate.\nRecursion continues into the protostate only if no local substates are marked\n`default`.\n\n> [defaultSubstate](\/api\/#state--methods--default-substate)\n\n      defaultSubstate: ( via = VIA_PROTO, first ) ->\n        for s in substates = @substates()\n          return s if s.attributes & DEFAULT\n        first or substates.length and first = substates[0]\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.defaultSubstate VIA_PROTO\n        first\n\n\n#### [initialSubstate](#state--prototype--initial-substate)\n\nPerforms a \u201cdepth-within-breadth-first\u201d recursive search to locate the most\ndeeply nested `initial` state by way of the greatest `initial` descendant\nstate. Recursion continues into the protostate only if no local descendant\nstates are marked `initial`.\n\n> [initialSubstate](\/api\/#state--methods--initial-substate)\n\n      initialSubstate: ( via = VIA_PROTO ) ->\n        i = 0; queue = [ this ]\n        while subject = queue[ i++ ]\n          for s in substates = subject.substates VIA_PROTO\n            return s.initialSubstate( VIA_NONE ) or s if s.attributes & INITIAL\n            queue.push s\n        if via & VIA_PROTO and protostate = @protostate()\n          return protostate.initialSubstate VIA_PROTO\n\n\n\n\n### [Currency](#state--currency)\n\nMethods that inspect or affect the owner\u2019s current state.\n\n\n#### [current](#state--prototype--current)\n\nGets the local state tree\u2019s current state, which is authoritatively determined\nby the root state.\n\n> [current](\/api\/#state--methods--current)\n\n      current: -> @root._current\n\n\n#### [isCurrent](#state--prototype--is-current)\n\nReturns a `Boolean` indicating whether `this` is the owner\u2019s current state.\n\n> [isCurrent](\/api\/#state--methods--is-current)\n\n      isCurrent: -> this is @current()\n\n\n#### [isActive](#state--prototype--is-active)\n\nReturns a `Boolean` indicating whether `this` or one of its substates is the\nowner\u2019s current state.\n\n> [isActive](\/api\/#state--methods--is-active)\n\n      isActive: -> this is ( current = @current() ) or @isSuperstateOf current\n\n\n#### [change](#state--prototype--change)\n\nForwards a `change` command to the root and returns its result. Calling with no\narguments directs the root to change to `this` state.\n\n*Aliases:* **go**, **be**\n\n> [change](\/api\/#state--methods--change)\n\n      change: ( target, options ) ->\n        ( root = @root ).change.apply root, arguments\n\n      go: @::change\n      be: @::change\n\n\n#### [changeTo](#state--prototype--change-to)\n\n> Not yet implemented.\n\nCalls `change` without regard to a `target`\u2019s retained internal state.\n\n*Aliases:* **goTo**, **goto**\n\n> See also: [`State::change`](#state--prototype--change)\n\n      changeTo: ( target, options ) ->\n\n      goTo: @::changeTo\n      goto: @::goTo\n\n\n\n### [Query](#state--querying)\n\n\n#### [query](#state--prototype--query)\n\nMatches a `selector` string with the state or states it represents, evaluated\nfirst in the context of `this`, then its substates, and then its superstates,\nuntil all locations in the state tree have been searched for a match of\n`selector`.\n\nReturns the matched `State`, or an `Array` containing the set of matched\nstates. If a state to be tested `against` is provided, a `Boolean` is returned,\nindicating whether `against` is the matched state or is included in the\nmatching set.\n\nIf no matching state is found relative to the context of `this` state, then the\nquery is recursed `via` the substates, superstates, and protostates of `this`,\nunless otherwise directed, such that a uniquely named state can be located by\nname alone from anywhere in the state tree.\n\n> [Selectors](\/docs\/#concepts--selectors)\n> [query](\/api\/#state--methods--query)\n\n      query: ( selector, against, via = VIA_ALL, toBeSkipped ) ->\n        if typeof against is 'number'\n          toBeSkipped = via; via = against; against = undefined\n\nA few exceptional cases may be resolved early.\n\n        unless selector?\n          return if against is undefined then null else no\n        if selector is '.'\n          return if against is undefined then this else against is this\n        if selector is ''\n          return if against is undefined then @root else against is @root\n\nAbsolute wildcard expressions compared against the root state pass immediately.\n\n        return yes if against and against is @root and \/^\\*+$\/.test selector\n\nPure `.`\/`*` expressions should not be recursed.\n\n        via &= ~( VIA_SUB | VIA_SUPER ) if \/^\\.*\\**$\/.test selector\n\nIf `selector` is an absolute path, evaluate it from the root state as a\nrelative path.\n\n        if selector.charAt(0) isnt '.'\n          return @root.query '.' + selector, against, VIA_SUB | VIA_PROTO\n\nAn all-`.` `selector` must have one `.` trimmed to parse correctly.\n\n        selector = selector.replace \/^(\\.+)\\.$\/, '$1'\n\nSplit `selector` into tokens, consume the leading empty-string straight away,\nthen parse the remaining tokens. A `cursor` reference to a matching `State` in\nthe tree is kept, beginning with the context state (`this`), and updated as\neach token is consumed.\n\n        parts = selector.split '.'\n        i = 0; l = parts.length; cursor = this\n        while cursor\n          i += 1\n\nUpon reaching the end of token stream, return the `State` currently referenced\nby `cursor`.\n\n          return ( if against then against is cursor else cursor ) if i >= l\n\nConsume a token.\n\n          name = parts[i]\n\nInterpret a **single wildcard** as any *immediate* substate of the `cursor`\nstate parsed thus far.\n\n          if name is '*'\n            return cursor.substates() unless against\n            return yes if cursor is against.superstate\n            break\n\nInterpret a **double wildcard** as any descendant state of the `cursor` state\nparsed thus far.\n\n          if name is '**'\n            return cursor.substates yes unless against\n            return yes if cursor.isSuperstateOf against\n            break\n\nEmpty string, the product of leading\/consecutive `.`s, implies `cursor`\u2019s\nsuperstate.\n\n          if name is '' then cursor = cursor.superstate\n\nInterpret any other token as an identifier that names a specific substate of\n`cursor`.\n\n          else if next = cursor.substate name then cursor = next\n\nIf no matching substate exists, the query fails for this context.\n\n          else break\n\nRecursively descend the tree, breadth-first, and retry the query with a\ndifferent context.\n\n        if via & VIA_SUB\n          i = 0; queue = [ this ]\n          while subject = queue[ i++ ]\n            for substate in subject.substates no, yes\n              continue if substate is toBeSkipped\n              result = substate.query selector, against, VIA_NONE\n              return result if result\n              queue.push substate\n\nRecursively ascend the tree and retry the query, but skip `this` subtree during\nthe subsequent descent, since it\u2019s already been searched.\n\n        if via & VIA_SUPER\n          return result if result = @superstate?.query( selector, against,\n            via & VIA_SUB | VIA_SUPER, this if via & VIA_SUB )\n\nRetry the query on the protostate.\n\n        if via & VIA_PROTO\n          return result if result = @protostate()?.query selector, against, via\n\nAll possibilities exhausted; no matches exist.\n\n        return if against then no else null\n\n\n#### [$](#state--prototype--dollarsign)\n\nConvenience method that either aliases to `change` if passed a function for the\nfirst argument, or aliases to `query` if passed a string \u2014 thereby mimicking\nthe behavior of the object\u2019s accessor method.\n\n> See also: [`createAccessor`][]\n\n      $: ( expr, args... ) ->\n        if typeof expr is 'function'\n          return @change.apply this, [ expr ].concat args if expr = expr()\n        else if typeof expr is 'string' and\n            ( match = expr.match rxTransitionArrow ) and\n              method = transitionArrowMethods[ match[1] ]\n          return if args.length\n          then @[ method ].apply this, [ match[2] ].concat args\n          else @[ method ] match[2]\n\n\n\n### [Data](#state--data)\n\n\n#### [data](#state--prototype--data)\n\nEither retrieves or edits a block of data associated with this state.\n\nIf provided no argument, or an integer bit field, then `data` returns a copy\nof the data attached to this state, including all data from inherited states,\nunless specified otherwise by the `via` query flags.\n\nIf called with an object-typed argument, `data` edits the data held on this\nstate. For keys in `mutation` whose values are set to the `NIL` directive, the\nmatching keys in the state\u2019s data are deleted. If the operation results in a\nchange to the state\u2019s data, a `mutate` event is emitted for this state.\n\n> [Data](\/docs\/#concepts--data)\n> [data](\/api\/#state--methods--data)\n\n      data: ( via = VIA_ALL ) ->\n\nIf the provided `via` argument is not a flags integer mask, and presumably an\nobject instead, then interpret this call as a *write* operation, and refer to\nthe parameter as `mutation`.\n\n        mutation = via if via isnt via << 0\n        if mutation\n          { attributes } = this\n          if attributes & INCIPIENT_OR_MUTABLE and not O.isEmpty mutation\n            return @realize().data mutation if attributes & VIRTUAL\n            delta = O.delta @_.data or = {}, mutation\n            debug delta\n            if not ( attributes & ATOMIC ) and delta and not O.isEmpty delta\n              @emit 'mutate', [ mutation, delta ], VIA_PROTO\n          this\n\nOtherwise *read* and return a copy of `this` state\u2019s `data`, including data\ninherited `via` superstates and protostates, unless directed otherwise.\n\n        else O.clone via & VIA_SUPER and @superstate?.data(),\n                     via & VIA_PROTO and @protostate()?.data VIA_PROTO,\n                     @_?.data\n\n\n#### [has](#state--prototype--has)\n\n      has: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        !!(\n          ( data = @_?.data ) and O.has( data, key ) or\n          viaProto and @protostate()?.has( key, VIA_PROTO ) or\n          viaSuper and @superstate?.has( key, VIA_SUPER | viaProto )\n        )\n\n\n#### [get](#state--prototype--get)\n\n      get: ( key, via = VIA_ALL ) ->\n        viaSuper = via & VIA_SUPER\n        viaProto = via & VIA_PROTO\n\n        ( data = @_?.data ) and O.lookup( data, key ) or\n        viaProto and @protostate()?.get( key, VIA_PROTO ) or\n        viaSuper and @superstate?.get( key, VIA_SUPER | viaProto )\n\n\n#### [let](#state--prototype--let)\n\nAssigns a `value` to a `key` within `this` state\u2019s `data` storage. If no such\nkey already exists, it is added.\n\n> See also: [`set`][]\n\n> [let](\/api\/#state--methods--let)\n\n      let: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE  # should warn\n        return @realize().let key, value if attributes & VIRTUAL\n\nAssignment proceeds only if the `value` being written is not the same as the\n`displaced` data that is being overwritten.\n\n        data = @_.data or = {}\n        if value isnt displaced = O.lookup data, key\n          { assign } = O\n          assign data, key, value\n          assign ( edit = {} ).data = {}, key, value\n          assign ( delta = {} ).data = {}, key, displaced\n          @emit 'mutate', [ edit, delta ], VIA_PROTO\n\n        value\n\n\n#### [set](#state--prototype--set)\n\nAssigns a `value` to the nearest extant `key` within the `data` storage\ninherited along the superstate chain of `this`.\n\nFor `let` versus `set`, the notion of a property\u2019s **scope** along the\nsuperstate chain is comparable to the same at the language level for variable\nbindings within functions being shadowed versus unshadowed, respectively.\n\n> [let](\/api\/#state--methods--let)\n> [set](\/api\/#state--methods--set)\n\n      set: ( key, value ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n\nFind the superstate that holds the inherited property and mutate it.\n\n        s = this; while s\n          if s.attributes & MUTABLE and ( data = s._.data ) and key of data\n            return s.let key, value\n          s = s.superstate\n\nIf no mutable property already exists along the superstate chain, then default\nto a `let`.\n\n        @let key, value\n\n\n#### [delete](#state--prototype--delete)\n\n      delete: ( key ) ->\n        return unless @attributes & MUTABLE\n        NIL is @let key, NIL\n\n\n\n### [Methods](#state--methods)\n\n\n#### [method](#state--prototype--method)\n\nRetrieves the named method held on this state. If no method is found, move up\nthis state\u2019s protostate chain to find one. If no method is found there, move up\nthe superstate chain and repeat the search.\n\n> [method](\/api\/#state--methods--method)\n\n      method: ( methodName, via = VIA_ALL, out ) ->\n        if ( method = @_?.methods?[ methodName ] ) and method isnt rootNoop\n          if out? then out.context = this; out.method = method\n          return method\n\n        if viaProto = via & VIA_PROTO and\n            method = @protostate()?.method methodName, VIA_PROTO, out\n          out?.context = this\n          return method\n\n        if via & VIA_SUPER and\n            method = @superstate?.method methodName, VIA_SUPER | viaProto, out\n          return method\n\n        if out? then out.context = null; out.method = method\n\n        method\n\n\n#### [methodNames](#state--prototype--method-names)\n\nReturns an `Array` of names of methods defined for this state.\n\n> [methodNames](\/api\/#state--methods--method-names)\n\n      methodNames: ->\n        O.keys methods if methods = @_?.methods\n\n\n#### [addMethod](#state--prototype--add-method)\n\nAdds a method to this state, which will be callable directly from the owner,\nbut with its context bound to the state.\n\n> [addMethod](\/api\/#state--methods--add-method)\n\n      addMethod: ( methodName, fn, raw ) ->\n        return unless @attributes & INCIPIENT_OR_MUTABLE\n\nIf `fn` holds a lexical state method, then extract the wrapped method, unless\nexplicitly ordered to regard the function in its `raw` form.\n\n        fn = fn this if not raw and fn.isLexicalStateMethodFactory\n\nIf a method called `methodName` does not already exist in the state tree, then\nthe owner and root state must be set up properly to accommodate calls to this\nmethod.\n\n        unless @method methodName, VIA_SUPER\n          { root, owner } = this\n          unless this is root or root.method methodName, VIA_NONE\n            ownerMethod = owner[ methodName ]\n            if ownerMethod is undefined or ownerMethod.isDispatcher\n              ownerMethod = rootNoop\n\nThe owner method must be added to the root state in its \u201craw\u201d form, i.e., not\nlexically transformed by `state.method`.\n\n            root.addMethod methodName, ownerMethod, yes\n\nA dispatcher function is instated on the owner, which will direct subsequent\ncalls to `owner[ methodName ]` to the appropriate state\u2019s implementation.\n\n          owner[ methodName ] =\n            createDispatcher root.accessorName, methodName, ownerMethod\n\n        methods = @_?.methods or = {}\n        methods[ methodName ] = fn\n\n\n#### [removeMethod](#state--prototype--remove-method)\n\nDissociates the named method from this state object and returns its function.\n\n> [removeMethod](\/api\/#state--methods--remove-method)\n\n      removeMethod: ( methodName ) ->\n        return unless @attributes & MUTABLE and ( methods = @_?.methods ) and\n          fn = methods[ methodName ]\n        delete methods[ methodName ]\n        fn\n\n\n#### [hasMethod](#state--prototype--has-method)\n\nDetermines whether `this` possesses or inherits a method named `methodName`.\n\n> [hasMethod](\/api\/#state--methods--has-method)\n\n      hasMethod: ( methodName ) ->\n        ( method = @method methodName ) and method isnt rootNoop\n\n\n#### [hasOwnMethod](#state--prototype--has-own-method)\n\nDetermines whether `this` directly possesses a method named `methodName`.\n\n> [hasOwnMethod](\/api\/#state--methods--has-own-method)\n\n      hasOwnMethod: ( methodName ) ->\n        !! @method methodName, VIA_NONE\n\n\n#### [apply](#state--prototype--apply)\n\nFinds a state method and applies it in the appropriate context. If the method\nwas originally defined in the owner, the context will be the owner. Otherwise,\nthe context will either be the state in which the method is defined, or if the\nimplementation resides in a protostate, the corresponding state belonging to\nthe inheriting owner. If the named method does not exist locally and cannot be\ninherited, a `noSuchMethod` event is emitted and the call returns `undefined`.\n\n> [apply](\/api\/#state--methods--apply)\n\n      apply: ( methodName, args ) ->\n        out = method: undefined, context: undefined\n        unless method = @method methodName, null, out\n          @emit 'noSuchMethod', [ methodName, args ]\n          @emit 'noSuchMethod:' + methodName, args\n          return\n        { context } = out\n        { owner } = this\n        ownerMethod = owner[ methodName ]\n        context = owner if ownerMethod?.original and context is @root\n        method.apply context, args\n\n\n#### [call](#state--prototype--call)\n\nVariadic [`apply`][].\n\n> [call](\/api\/#state--methods--call)\n\n      call: ( methodName, args... ) ->\n        @apply methodName, args\n\n\n\n### [Events](#state--events)\n\n\n#### [event](#state--prototype--event)\n\nReturns a registered event listener, or the number of listeners registered, for\na given event `type`.\n\nIf an `id` as returned by `addEvent` is provided, the event listener associated\nwith that `id` is returned. If no `id` is provided, the number of event\nlisteners registered to `type` is returned.\n\n> [event](\/api\/#state--methods--event)\n\n      event: ( eventType, id ) ->\n        return unless emitter = @_?.events?[ eventType ]\n        return emitter.length if id is undefined\n        id = emitter.key id if typeof id is 'function'\n        emitter.get id\n\n\n#### [addEvent](#state--prototype--add-event)\n\nBinds an event listener to the specified `eventType` and returns a unique\nidentifier for the listener.\n\n*Alias:* **on**\n\n> [addEvent](\/api\/#state--methods--add-event)\n\n      addEvent: ( eventType, fn, context ) ->\n        do @realize if @attributes & VIRTUAL\n        events = @_.events or = {}\n        unless O.hasOwn.call events, eventType\n          events[ eventType ] = new StateEventEmitter this\n        events[ eventType ].add fn, context\n\n      on: @::addEvent\n\n\n#### [removeEvent](#state--prototype--remove-event)\n\nUnbinds the event listener with the specified `id` that was supplied by\n[`addEvent`][].\n\n*Alias:* **off**\n\n> [removeEvent](\/api\/#state--methods--remove-event)\n\n      removeEvent: ( eventType, id ) ->\n        @_?.events?[ eventType ].remove id\n\n      off: @::removeEvent\n\n\n#### [emit](#state--prototype--emit)\n\nInvokes all listeners bound to the given event type.\n\nArguments for the listeners can be passed as an array to the `args` parameter.\n\nCallbacks are invoked in the context of `this`, or as specified by `context`.\n\nCallbacks bound to superstates and protostates are also invoked, unless\notherwise directed by the `via` query flags.\n\n*Alias:* **trigger**\n\n> [emit](\/api\/#state--methods--emit)\n\n      emit: ( eventType, args, context, via = VIA_ALL ) ->\n        return if typeof eventType isnt 'string'\n\n        if typeof args is 'number'\n          via = context; context = args; args = undefined\n        if typeof context is 'number'\n          via = context; context = undefined\n\n        if args then ( args = [ args ] unless O.isArray args ) else args = []\n\nEvent callbacks are applied in the context of their location along the\nsuperstate chain of `this`; i.e., events are inherited transparently via\nprotostates.\n\n        @_?.events?[ eventType ]?.emit args, context or this\n        if via & VIA_PROTO\n          @protostate()?.emit eventType, args, context or this, VIA_PROTO\n        if via & VIA_SUPER\n          ( ss = @superstate )?.emit eventType, args, context or ss\n        return\n\n      trigger: @::emit\n\n\n\n### [Guards](#state--guards)\n\n\n#### [guard](#state--prototype--guard)\n\nGets a **guard** entity for this state. A guard is a value or function that\nwill be evaluated during a transition to determine whether an owner\u2019s currency\nwill be *admitted* into or *released* from the `State` to which the guard is\napplied.\n\nGuards are inherited from protostates, but not from superstates.\n\n> See also: [`evaluateGuard`](#state--private--evaluate-guard)\n> [guard](\/api\/#state--methods--guard)\n\n      guard: ( guardType ) ->\n        if guard = @_?.guards?[ guardType ] then O.clone guard\n        else @protostate()?.guard( guardType ) or undefined\n\n\n#### [addGuard](#state--prototype--add-guard)\n\nAdds a guard to this state, or augments an existing guard with additional\nentries.\n\n> [addGuard](\/api\/#state--methods--add-guard)\n\n      addGuard: ( guardType, guard ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        guards = @_.guards or = {}\n        O.edit guards[ guardType ] or = {}, guard\n\n\n#### [removeGuard](#state--prototype--remove-guard)\n\nRemoves a guard from this state, or removes specific entries from an existing\nguard.\n\n> [removeGuard](\/api\/#state--methods--remove-guard)\n\n      removeGuard: ( guardType, args... ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and guards = @_.guards\n        return null unless guard = guards[ guardType ]\n        return ( guard if delete guards[ guardType ] ) unless args.length\n\n        for key in O.flatten args when typeof key is 'string'\n          entry = guard[ key ]\n          return entry if delete guard[ key ]\n\n\n\n### [Substates](#state--substates)\n\n\n#### [substate](#state--prototype--substate)\n\nRetrieves the named substate of `this` state. If no such substate exists in the\nlocal state, any identically named substate held on a protostate will be\nreturned.\n\n> [substate](\/api\/#state--methods--substate)\n\n      substate: ( name, via = VIA_PROTO ) ->\n\nFirst scan for any virtual active substates in the local state tree.\n\n        s = @root._current\n        while s?.attributes & VIRTUAL and ss = s.superstate\n          return s if ss is this and s.name is name\n          s = ss\n\nOtherwise retrieve a real substate, either locally or from a protostate.\n\n        @_?.substates?[ name ] or\n        via & VIA_PROTO and @protostate()?.substate name\n\n\n#### [substates](#state--prototype--substates)\n\nReturns an `Array` of this state\u2019s substates. If the boolean `deep` argument is\n`true`, returns a depth-first flattened array containing all of this state\u2019s\ndescendant states.\n\n> [substates](\/api\/#state--methods--substates)\n\n      substates: ( deep, virtual ) ->\n        result = []\n\nInclude virtual substates in the returned set, if any are present.\n\n        if virtual and ( s = @root._current ) and s.attributes & VIRTUAL and\n            @isSuperstateOf s\n          while s and s isnt this and s.attributes & VIRTUAL and\n              ss = s.superstate\n            result.unshift s if deep or ss is this\n            s = ss\n\nInclude real substates.\n\n        for own name, substate of @_?.substates\n          result.push substate\n          result = result.concat substate.substates yes if deep\n\n        result\n\n\n#### [addSubstate](#state--prototype--add-substate)\n\nCreates a state from the supplied `expression` and adds it as a substate of\nthis state. If a substate with the same `name` already exists, that state is\nfirst destroyed and then displaced.\n\n> [addSubstate](\/api\/#state--methods--add-substate)\n\n      addSubstate: ( name, expression ) ->\n        { attributes } = this\n        unless attributes & INCIPIENT\n          return if attributes & FINITE\n          return unless attributes & MUTABLE\n        do @realize if attributes & VIRTUAL\n\n        substates = @_.substates or = {}\n        do substate.destroy if substate = substates[ name ]\n\n        substate = if expression instanceof State\n        then expression.realize() if expression.superstate is this\n        else new State this, name, expression\n\n        return null unless substate\n\n        substates[ name ] = substate\n\n\n#### [removeSubstate](#state--prototype--remove-substate)\n\nRemoves the named substate from the local state, if possible.\n\n> [removeSubstate](\/api\/#state--methods--remove-substate)\n\n      removeSubstate: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and\n          ( substates = @_?.substates ) and substate = substates[ name ]\n\nIf a transition is underway involving `substate`, the removal must fail.\n\n        return no if ( transition = @root._transition ) and (\n          substate.isSuperstateOf( transition ) or\n          substate is transition.origin or substate is transition.target\n        )\n\nCurrency must be evacuated before the state can be removed.\n\n        @change this, forced: yes if @root._current.isIn substate\n\n        delete substates[ name ]\n\n        substate\n\n\n\n### [Transitions](#state--transitions)\n\nA `State` may hold **transition expressions** that describe a `Transition`\ninvolving itself or any descendant `State`.\n\n\n#### [transition](#state--prototype--transition)\n\nReturns the named transition expression held on this state.\n\n> [transition](\/api\/#state--methods--transition)\n\n      transition: ( name ) -> @_?.transitions?[ name ]\n\n\n#### [transitions](#state--prototype--transitions)\n\nReturns an object containing all of the transition expressions defined\non this state.\n\n> [transitions](\/api\/#state--methods--transitions)\n\n      transitions: -> O.clone @_?.transitions\n\n\n#### [addTransition](#state--prototype--add-transition)\n\nRegisters a transition expression to this state.\n\n> [addTransition](\/api\/#state--methods--add-transition)\n\n      addTransition: ( name, expression ) ->\n        { attributes } = this\n        return unless attributes & INCIPIENT_OR_MUTABLE\n        do @realize if attributes & VIRTUAL\n        unless expression instanceof TransitionExpression\n          expression = new TransitionExpression expression\n        transitions = @_.transitions or = {}\n        transitions[ name ] = expression\n\n\n#### [removeTransition](#state--prototype--remove-transition)\n\nRemoves a transition expression from this state.\n\n> [removeTransition](\/api\/#state--methods--remove-transition)\n\n      removeTransition: ( name ) ->\n        { attributes } = this\n        return if attributes & VIRTUAL\n        return unless attributes & MUTABLE and transitions = @_.transitions\n        transition = transitions[ name ]\n        delete transitions[ name ] if transition\n        transition\n\n\n\n\n","returncode":0,"stderr":"","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"f92fd07ead367d0ead634e74f9951080c598bb0d","subject":"fixed link to example app gulpfile","message":"fixed link to example app gulpfile\n","repos":"curlee\/Appnostic","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/curlee\/Appnostic.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"3af5338b59fb8e567c726904671db31ecf25ad45","subject":"Fix naming","message":"Fix naming\n","repos":"Piot\/boardgamedb","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"b8645956e13f1e168b217a489462b3248dada364","subject":"Initial commit","message":"Initial commit\n\nOur thoughts inspired - by Albert Einstein.","repos":"CB2L\/logotype,CB2L\/logotype,CB2L\/logotype,CB2L\/logotype","old_file":"source\/readme.litcoffee","new_file":"source\/readme.litcoffee","new_contents":"CodeBook of LogoType<sup>\u00ae<\/sup>\n--------------------------------\n<i>The most beautiful thing we can experience is the mysterious. It is the source of all true art and science<\/i> - <b>Albert Einstein<\/b>.\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'source\/readme.litcoffee' did not match any file(s) known to git\n","license":"apache-2.0","lang":"Literate CoffeeScript"}
{"commit":"cd6934d3b45798c4c8de13a6a4ada09c09036533","subject":"Update inline docs","message":"Update inline docs\n","repos":"Piot\/boardgamedb","old_file":"gulpfile.litcoffee","new_file":"gulpfile.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"5b31c56f9f3bbe9181a3d5bc73ebe4cb4efb9a83","subject":"Parse game when dom (and game) is ready","message":"Parse game when dom (and game) is ready\n","repos":"Piot\/boardgamedb","old_file":"elements\/game\/main\/game-main.litcoffee","new_file":"elements\/game\/main\/game-main.litcoffee","new_contents":"","old_contents":"","returncode":128,"stderr":"remote: Support for password authentication was removed on August 13, 2021.\nremote: Please see https:\/\/docs.github.com\/en\/get-started\/getting-started-with-git\/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.\nfatal: Authentication failed for 'https:\/\/github.com\/Piot\/boardgamedb.git\/'\n","license":"mit","lang":"Literate CoffeeScript"}
{"commit":"fdeffdcfe9f017609d06ae52cbd96935f53f9861","subject":"document association sets","message":"document association sets\n","repos":"getshuvo\/batman,getshuvo\/batman","old_file":"docs\/03_app_internals\/24e_association_sets.litcoffee","new_file":"docs\/03_app_internals\/24e_association_sets.litcoffee","new_contents":"# \/api\/App Internals\/Batman.AssociationSet\n\n`Batman.AssociationSet` is the return value of a `@hasMany` assocation. It extends `Batman.SetSort`. When constructed, it creates a new `Batman.Set`, then sorts it by `_batmanID`.\n\nSince `Batman.AssociationSet` extends `Batman.SetIndex`, you can use any of `Batman.SetIndex`'s methods, too.\n\n## ::constructor(@foreignKeyValue, @association) : AssociationSet\n\nCreates a new `Batman.Set` to be `@base` and uses `_batmanID` as `@key`.\n\n## ::%loaded[=false]\n\nSet to `true` by `markAsLoaded`.\n\n## ::load(options, callback)\n\nLoads records by:\n\n- using `@foreignKeyValue` as a request param\n- using `@association.options.url` as the request URL, if present\n- mixing in `options` as the request's data\n\nThen, calls `markAsLoaded` and fires the callback with `(err, @, env)`.\n\n## ::markAsLoaded()\n\nSets `loaded` to true and fires `loaded`.\n\n## ::%parentRecord : Model\n\nReturns the parent record for `@foreignKeyValue`.\n\n## ::build(attrs={}) : Model\n\nBuilds a child record with `attrs` (mixing in `@foreignKeyValue` and `inverseOf`, if possible) and adds it to the `AssociationSet`.\n\n# \/api\/App Internals\/Batman.AssociationSet\/Batman.AssociationSetIndex\n\n`Batman.AssocationSetIndex` extends `Batman.SetIndex` and is used internally to find records by its `@key`.\n\n## ::constructor(@assocation, key) : AssociationSetIndex\n\nIndexes `@association`'s related model's loaded set by `key`.\n\n# \/api\/App Internals\/Batman.AssociationSet\/Batman.UniqueAssociationSetIndex\n\n`Batman.UniqueAssociationSetIndex` extends `Batman.UniqueSetIndex` and is used internally to find one record by it's `@key`\n\n## ::constructor(@assocation, key) : UniqueAssociationSetIndex\n\nUnique-indexes `@association`'s related model's loaded set by `key`.\n\n# \/api\/App Internals\/Batman.AssociationSet\/Batman.PolymorphicAssociationSet\n\n`Batman.PolymorphicAssociationSet` extends `Batman.AssocationSet`. It's the return value of a `@hasMany as: '...'` assocation.\n\n## ::constructor(@foreignKeyValue, @foreignTypeKeyValue, @association) : PolymorphicAssociationSet\n\nSends `@foreignKeyValue` and `@assocation` to the superclass constuctor.\n\n## ::load(options, callback)\n\nLoads records from storage using:\n\n- `@assocation.options.url` as the request URL, if it's provided\n- `@foreignKeyValue` and `@foreignTypeKeyValue` as request params\n- Mixing `options` in the request data\n\nThen invokes `callback` with `(err, @, env)`.\n\n# \/api\/App Internals\/Batman.AssociationSet\/Batman.PolymorphicAssociationSetIndex\n\n`Batman.PolymorphicAssociationSetIndex` extends `Batman.SetIndex`. It is used internally by polymorphic associations.\n\nWhen items are added and removed from `Batman.PolymorphicAssociationSetIndex`es, they are ignored unless their  `foreignTypeKey` value is the index's `@type`.\n\n## ::constructor(@association, @type, key)\n\nIndexes `@association`'s related model's loaded set by `key`.\n\n# \/api\/App Internals\/Batman.AssociationSet\/Batman.PolymorphicUniqueAssociationSetIndex\n\n`Batman.PolymorphicUniqueAssociationSetIndex` extends `Batman.UniqueSetIndex`.\n\n## ::constructor(@association, @type, key)\n\nFinds the model for `type`, then unique-indexes that model's loaded set by `key`.\n","old_contents":"","returncode":1,"stderr":"error: pathspec 'docs\/03_app_internals\/24e_association_sets.litcoffee' did not match any file(s) known to git\n","license":"mit","lang":"Literate CoffeeScript"}